u-blox / C027_Support

support library for C027 helper functions for Buffer Pipes, Buffered Serial Port (rtos capable) and GPS parsing. It includes modem APIs for USSD, SMS and Sockets.

Dependents:   HTTPClient_Cellular_HelloWorld Cellular_HelloMQTT MbedSmartRestMain Car_Bon_car_module ... more

This library is intended to be used with u-blox products such as the C027 or a shield with u-blox cellular and GPS modules like the cellular and positioning shield from Embedded Artist.

For 2G/GSM and 3G/UMTS you need to:

  • have a SIM card and know its PIN number
  • need to know you network operators APN setting These setting should be passed to the connect or init and join functions. You can also extend the APN database in MDMAPN.h.

For CDMA products you need to make sure that you have provisioned and activated the modem with either Sprint or Verizon.

MDM.h@120:0e718a4ea25e, 2015-07-01 (annotated)

Committer:
mazgch
Date:
Wed Jul 01 13:21:31 2015 +0000
Revision:
120:0e718a4ea25e
Parent:
117:74e4e0109a9e
Child:
124:65eb7d58f2da
add API to get current device status and ip

Who changed what in which revision?

UserRevisionLine numberNew contents of line
mazgch 17:296d94a006b4 1 #pragma once
mazgch 17:296d94a006b4 2
mazgch 17:296d94a006b4 3 #include "mbed.h"
mazgch 21:c4d64830bf02 4 #include <stdarg.h>
mazgch 21:c4d64830bf02 5
mazgch 18:e5697801df29 6 #include "Pipe.h"
mazgch 18:e5697801df29 7 #include "SerialPipe.h"
mazgch 17:296d94a006b4 8
mazgch 19:2b5d097ca15d 9 #ifdef TARGET_UBLOX_C027
mazgch 75:ce6e12067d0c 10 #define MDM_IF(onboard,shield) onboard
mazgch 19:2b5d097ca15d 11 #else
mazgch 75:ce6e12067d0c 12 #define MDM_IF(onboard,shield) shield
mazgch 19:2b5d097ca15d 13 #endif
mazgch 18:e5697801df29 14
mazgch 74:208e3e32d263 15 //! include debug capabilty on more powerful targets with a dedicated debug port
mazgch 74:208e3e32d263 16 #if defined(TARGET_LPC1768) || defined(TARGET_LPC4088) || defined(TARGET_K64F)
mazgch 74:208e3e32d263 17 #define MDM_DEBUG
mazgch 74:208e3e32d263 18 #endif
mazgch 74:208e3e32d263 19
mazgch 38:e6cab4632d84 20 /** basic modem parser class
mazgch 38:e6cab4632d84 21 */
mazgch 18:e5697801df29 22 class MDMParser
mazgch 18:e5697801df29 23 {
mazgch 18:e5697801df29 24 public:
mazgch 31:a0bed6c1e05d 25 //! Constructor
mazgch 76:f7c3dd568dae 26 MDMParser(void);
mazgch 44:9d12223b78ff 27 //! get static instance
mazgch 44:9d12223b78ff 28 static MDMParser* getInstance() { return inst; };
mazgch 31:a0bed6c1e05d 29
mazgch 31:a0bed6c1e05d 30 // ----------------------------------------------------------------
mazgch 31:a0bed6c1e05d 31 // Types
mazgch 31:a0bed6c1e05d 32 // ----------------------------------------------------------------
mazgch 38:e6cab4632d84 33 //! MT Device Types
mazgch 98:c786461edd40 34 typedef enum { DEV_UNKNOWN, DEV_SARA_G350, DEV_LISA_U200, DEV_LISA_C200,
mazgch 98:c786461edd40 35 DEV_SARA_U260, DEV_SARA_U270, DEV_LEON_G200 } Dev;
mazgch 38:e6cab4632d84 36 //! SIM Status
mazgch 75:ce6e12067d0c 37 typedef enum { SIM_UNKNOWN, SIM_MISSING, SIM_PIN, SIM_READY } Sim;
mazgch 38:e6cab4632d84 38 //! SIM Status
mazgch 76:f7c3dd568dae 39 typedef enum { LPM_DISABLED, LPM_ENABLED, LPM_ACTIVE } Lpm;
mazgch 38:e6cab4632d84 40 //! Device status
mazgch 33:fb8fb5021b09 41 typedef struct {
mazgch 34:3b3b7807c0c3 42 Dev dev; //!< Device Type
mazgch 35:9275215a3a5b 43 Lpm lpm; //!< Power Saving
mazgch 34:3b3b7807c0c3 44 Sim sim; //!< SIM Card Status
mazgch 34:3b3b7807c0c3 45 char ccid[20+1]; //!< Integrated Circuit Card ID
mazgch 34:3b3b7807c0c3 46 char imsi[15+1]; //!< International Mobile Station Identity
mazgch 34:3b3b7807c0c3 47 char imei[15+1]; //!< International Mobile Equipment Identity
mazgch 34:3b3b7807c0c3 48 char meid[18+1]; //!< Mobile Equipment IDentifier
mazgch 34:3b3b7807c0c3 49 char manu[16]; //!< Manufacturer (u-blox)
mazgch 34:3b3b7807c0c3 50 char model[16]; //!< Model Name (LISA-U200, LISA-C200 or SARA-G350)
mazgch 34:3b3b7807c0c3 51 char ver[16]; //!< Software Version
mazgch 38:e6cab4632d84 52 } DevStatus;
mazgch 38:e6cab4632d84 53 //! Registration Status
mazgch 38:e6cab4632d84 54 typedef enum { REG_UNKNOWN, REG_DENIED, REG_NONE, REG_HOME, REG_ROAMING } Reg;
mazgch 38:e6cab4632d84 55 //! Access Technology
mazgch 38:e6cab4632d84 56 typedef enum { ACT_UNKNOWN, ACT_GSM, ACT_EDGE, ACT_UTRAN, ACT_CDMA } AcT;
mazgch 38:e6cab4632d84 57 //! Network Status
mazgch 33:fb8fb5021b09 58 typedef struct {
mazgch 79:291df065e345 59 Reg csd; //!< CSD Registration Status (Circuit Switched Data)
mazgch 79:291df065e345 60 Reg psd; //!< PSD Registration status (Packet Switched Data)
mazgch 34:3b3b7807c0c3 61 AcT act; //!< Access Technology
mazgch 34:3b3b7807c0c3 62 int rssi; //!< Received Signal Strength Indication (in dBm, range -113..-53)
mazgch 54:7ba8e4c218e2 63 int ber; //!< Bit Error Rate (BER), see 3GPP TS 45.008 [20] subclause 8.2.4
mazgch 34:3b3b7807c0c3 64 char opr[16+1]; //!< Operator Name
mazgch 34:3b3b7807c0c3 65 char num[32]; //!< Mobile Directory Number
mazgch 54:7ba8e4c218e2 66 unsigned short lac; //!< location area code in hexadecimal format (2 bytes in hex)
mazgch 54:7ba8e4c218e2 67 unsigned int ci; //!< Cell ID in hexadecimal format (2 to 4 bytes in hex)
mazgch 38:e6cab4632d84 68 } NetStatus;
mazgch 38:e6cab4632d84 69 //! An IP v4 address
mazgch 38:e6cab4632d84 70 typedef uint32_t IP;
mazgch 33:fb8fb5021b09 71 #define NOIP ((MDMParser::IP)0) //!< No IP address
mazgch 31:a0bed6c1e05d 72 // ip number formating and conversion
mazgch 31:a0bed6c1e05d 73 #define IPSTR "%d.%d.%d.%d"
mazgch 31:a0bed6c1e05d 74 #define IPNUM(ip) ((ip)>>24)&0xff, \
mazgch 31:a0bed6c1e05d 75 ((ip)>>16)&0xff, \
mazgch 31:a0bed6c1e05d 76 ((ip)>> 8)&0xff, \
mazgch 31:a0bed6c1e05d 77 ((ip)>> 0)&0xff
mazgch 31:a0bed6c1e05d 78 #define IPADR(a,b,c,d) ((((IP)(a))<<24) | \
mazgch 31:a0bed6c1e05d 79 (((IP)(b))<<16) | \
mazgch 31:a0bed6c1e05d 80 (((IP)(c))<< 8) | \
mazgch 31:a0bed6c1e05d 81 (((IP)(d))<< 0))
mazgch 31:a0bed6c1e05d 82
mazgch 31:a0bed6c1e05d 83
mazgch 31:a0bed6c1e05d 84 // ----------------------------------------------------------------
mazgch 57:869bd35f44cc 85 // Device
mazgch 31:a0bed6c1e05d 86 // ----------------------------------------------------------------
mazgch 31:a0bed6c1e05d 87
mazgch 80:34985b4d821e 88 typedef enum { AUTH_NONE, AUTH_PAP, AUTH_CHAP, AUTH_DETECT } Auth;
mazgch 80:34985b4d821e 89
mazgch 57:869bd35f44cc 90 /** Combined Init, checkNetStatus, join suitable for simple applications
mazgch 57:869bd35f44cc 91 \param simpin a optional pin of the SIM card
mazgch 57:869bd35f44cc 92 \param apn the of the network provider e.g. "internet" or "apn.provider.com"
mazgch 57:869bd35f44cc 93 \param username is the user name text string for the authentication phase
mazgch 57:869bd35f44cc 94 \param password is the password text string for the authentication phase
mazgch 80:34985b4d821e 95 \param auth is the authentication mode (CHAP,PAP,NONE or DETECT)
mazgch 57:869bd35f44cc 96 \return true if successful, false otherwise
mazgch 57:869bd35f44cc 97 */
mazgch 94:d697fe11f3e5 98 bool connect(const char* simpin = NULL,
mazgch 94:d697fe11f3e5 99 const char* apn = NULL, const char* username = NULL,
mazgch 94:d697fe11f3e5 100 const char* password = NULL, Auth auth = AUTH_DETECT,
mazgch 75:ce6e12067d0c 101 PinName pn MDM_IF( = MDMPWRON, = D4));
mazgch 57:869bd35f44cc 102
mazgch 31:a0bed6c1e05d 103 /** register (Attach) the MT to the GPRS service.
mazgch 57:869bd35f44cc 104 \param simpin a optional pin of the SIM card
mazgch 31:a0bed6c1e05d 105 \param status an optional struture to with device information
mazgch 31:a0bed6c1e05d 106 \return true if successful, false otherwise
mazgch 31:a0bed6c1e05d 107 */
mazgch 74:208e3e32d263 108 bool init(const char* simpin = NULL, DevStatus* status = NULL,
mazgch 75:ce6e12067d0c 109 PinName pn MDM_IF( = MDMPWRON, = D4));
mazgch 75:ce6e12067d0c 110
mazgch 120:0e718a4ea25e 111 /** get the current device status
mazgch 120:0e718a4ea25e 112 \param strocture holding the device information.
mazgch 120:0e718a4ea25e 113 */
mazgch 120:0e718a4ea25e 114 void getDevStatus(MDMParser::DevStatus* dev) { memcpy(dev, &_dev, sizeof(DevStatus)); }
mazgch 120:0e718a4ea25e 115
mazgch 75:ce6e12067d0c 116 /** register to the network
mazgch 75:ce6e12067d0c 117 \param status an optional structure to with network information
mazgch 75:ce6e12067d0c 118 \param timeout_ms -1 blocking, else non blocking timeout in ms
mazgch 75:ce6e12067d0c 119 \return true if successful and connected to network, false otherwise
mazgch 75:ce6e12067d0c 120 */
mazgch 75:ce6e12067d0c 121 bool registerNet(NetStatus* status = NULL, int timeout_ms = 180000);
mazgch 31:a0bed6c1e05d 122
mazgch 31:a0bed6c1e05d 123 /** check if the network is available
mazgch 31:a0bed6c1e05d 124 \param status an optional structure to with network information
mazgch 31:a0bed6c1e05d 125 \return true if successful and connected to network, false otherwise
mazgch 31:a0bed6c1e05d 126 */
mazgch 31:a0bed6c1e05d 127 bool checkNetStatus(NetStatus* status = NULL);
mazgch 31:a0bed6c1e05d 128
mazgch 31:a0bed6c1e05d 129 /** Power off the MT, This function has to be called prior to
mazgch 31:a0bed6c1e05d 130 switching off the supply.
mazgch 31:a0bed6c1e05d 131 \return true if successfully, false otherwise
mazgch 31:a0bed6c1e05d 132 */
mazgch 31:a0bed6c1e05d 133 bool powerOff(void);
mazgch 31:a0bed6c1e05d 134
mazgch 31:a0bed6c1e05d 135 // ----------------------------------------------------------------
mazgch 31:a0bed6c1e05d 136 // Data Connection (GPRS)
mazgch 31:a0bed6c1e05d 137 // ----------------------------------------------------------------
mazgch 31:a0bed6c1e05d 138
mazgch 31:a0bed6c1e05d 139 /** register (Attach) the MT to the GPRS service.
mazgch 31:a0bed6c1e05d 140 \param apn the of the network provider e.g. "internet" or "apn.provider.com"
mazgch 57:869bd35f44cc 141 \param username is the user name text string for the authentication phase
mazgch 31:a0bed6c1e05d 142 \param password is the password text string for the authentication phase
mazgch 80:34985b4d821e 143 \param auth is the authentication mode (CHAP,PAP,NONE or DETECT)
mazgch 31:a0bed6c1e05d 144 \return the ip that is assigned
mazgch 31:a0bed6c1e05d 145 */
mazgch 79:291df065e345 146 MDMParser::IP join(const char* apn = NULL, const char* username = NULL,
mazgch 79:291df065e345 147 const char* password = NULL, Auth auth = AUTH_DETECT);
mazgch 31:a0bed6c1e05d 148
mazgch 31:a0bed6c1e05d 149 /** deregister (detach) the MT from the GPRS service.
mazgch 31:a0bed6c1e05d 150 \return true if successful, false otherwise
mazgch 31:a0bed6c1e05d 151 */
mazgch 31:a0bed6c1e05d 152 bool disconnect(void);
mazgch 31:a0bed6c1e05d 153
mazgch 31:a0bed6c1e05d 154 /** Translates a domain name to an IP address
mazgch 31:a0bed6c1e05d 155 \param host the domain name to translate e.g. "u-blox.com"
mazgch 31:a0bed6c1e05d 156 \return the IP if successful, 0 otherwise
mazgch 31:a0bed6c1e05d 157 */
mazgch 31:a0bed6c1e05d 158 MDMParser::IP gethostbyname(const char* host);
mazgch 31:a0bed6c1e05d 159
mazgch 120:0e718a4ea25e 160 /** get the current assigned IP address
mazgch 120:0e718a4ea25e 161 \return the ip that is assigned
mazgch 120:0e718a4ea25e 162 */
mazgch 120:0e718a4ea25e 163 MDMParser::IP getIpAddress(void) { return _ip; }
mazgch 120:0e718a4ea25e 164
mazgch 31:a0bed6c1e05d 165 // ----------------------------------------------------------------
mazgch 31:a0bed6c1e05d 166 // Sockets
mazgch 31:a0bed6c1e05d 167 // ----------------------------------------------------------------
mazgch 31:a0bed6c1e05d 168
mazgch 31:a0bed6c1e05d 169 //! Type of IP protocol
mazgch 31:a0bed6c1e05d 170 typedef enum { IPPROTO_TCP, IPPROTO_UDP } IpProtocol;
mazgch 31:a0bed6c1e05d 171
mazgch 31:a0bed6c1e05d 172 //! Socket error return codes
mazgch 31:a0bed6c1e05d 173 #define SOCKET_ERROR -1
mazgch 31:a0bed6c1e05d 174
mazgch 63:42cb563a25bc 175 /** Create a socket for a ip protocol (and optionaly bind)
mazgch 31:a0bed6c1e05d 176 \param ipproto the protocol (UDP or TCP)
mazgch 63:42cb563a25bc 177 \param port in case of UDP, this optional port where it is bind
mazgch 31:a0bed6c1e05d 178 \return the socket handle if successful or SOCKET_ERROR on failure
mazgch 31:a0bed6c1e05d 179 */
mazgch 63:42cb563a25bc 180 int socketSocket(IpProtocol ipproto, int port = -1);
mazgch 31:a0bed6c1e05d 181
mazgch 31:a0bed6c1e05d 182 /** make a socket connection
mazgch 31:a0bed6c1e05d 183 \param socket the socket handle
mazgch 31:a0bed6c1e05d 184 \param host the domain name to connect e.g. "u-blox.com"
mazgch 31:a0bed6c1e05d 185 \param port the port to connect
mazgch 31:a0bed6c1e05d 186 \return true if successfully, false otherwise
mazgch 31:a0bed6c1e05d 187 */
mazgch 31:a0bed6c1e05d 188 bool socketConnect(int socket, const char* host, int port);
mazgch 31:a0bed6c1e05d 189
mazgch 44:9d12223b78ff 190 /** make a socket connection
mazgch 44:9d12223b78ff 191 \param socket the socket handle
mazgch 44:9d12223b78ff 192 \return true if connected, false otherwise
mazgch 44:9d12223b78ff 193 */
mazgch 44:9d12223b78ff 194 bool socketIsConnected(int socket);
mazgch 44:9d12223b78ff 195
mazgch 44:9d12223b78ff 196 /** Get the number of bytes pending for reading for this socket
mazgch 44:9d12223b78ff 197 \param socket the socket handle
mazgch 44:9d12223b78ff 198 \param timeout_ms -1 blocking, else non blocking timeout in ms
mazgch 44:9d12223b78ff 199 \return 0 if successful or SOCKET_ERROR on failure
mazgch 44:9d12223b78ff 200 */
mazgch 66:69072b3c5bca 201 bool socketSetBlocking(int socket, int timeout_ms);
mazgch 44:9d12223b78ff 202
mazgch 31:a0bed6c1e05d 203 /** Write socket data
mazgch 31:a0bed6c1e05d 204 \param socket the socket handle
mazgch 31:a0bed6c1e05d 205 \param buf the buffer to write
mazgch 31:a0bed6c1e05d 206 \param len the size of the buffer to write
mazgch 31:a0bed6c1e05d 207 \return the size written or SOCKET_ERROR on failure
mazgch 31:a0bed6c1e05d 208 */
mazgch 31:a0bed6c1e05d 209 int socketSend(int socket, const char * buf, int len);
mazgch 31:a0bed6c1e05d 210
mazgch 31:a0bed6c1e05d 211 /** Write socket data to a IP
mazgch 31:a0bed6c1e05d 212 \param socket the socket handle
mazgch 31:a0bed6c1e05d 213 \param ip the ip to send to
mazgch 31:a0bed6c1e05d 214 \param port the port to send to
mazgch 31:a0bed6c1e05d 215 \param buf the buffer to write
mazgch 31:a0bed6c1e05d 216 \param len the size of the buffer to write
mazgch 31:a0bed6c1e05d 217 \return the size written or SOCKET_ERROR on failure
mazgch 31:a0bed6c1e05d 218 */
mazgch 31:a0bed6c1e05d 219 int socketSendTo(int socket, IP ip, int port, const char * buf, int len);
mazgch 31:a0bed6c1e05d 220
mazgch 31:a0bed6c1e05d 221 /** Get the number of bytes pending for reading for this socket
mazgch 31:a0bed6c1e05d 222 \param socket the socket handle
mazgch 31:a0bed6c1e05d 223 \return the number of bytes pending or SOCKET_ERROR on failure
mazgch 31:a0bed6c1e05d 224 */
mazgch 31:a0bed6c1e05d 225 int socketReadable(int socket);
mazgch 31:a0bed6c1e05d 226
mazgch 31:a0bed6c1e05d 227 /** Read this socket
mazgch 31:a0bed6c1e05d 228 \param socket the socket handle
mazgch 31:a0bed6c1e05d 229 \param buf the buffer to read into
mazgch 31:a0bed6c1e05d 230 \param len the size of the buffer to read into
mazgch 31:a0bed6c1e05d 231 \return the number of bytes read or SOCKET_ERROR on failure
mazgch 31:a0bed6c1e05d 232 */
mazgch 31:a0bed6c1e05d 233 int socketRecv(int socket, char* buf, int len);
mazgch 31:a0bed6c1e05d 234
mazgch 31:a0bed6c1e05d 235 /** Read from this socket
mazgch 31:a0bed6c1e05d 236 \param socket the socket handle
mazgch 63:42cb563a25bc 237 \param ip the ip of host where the data originates from
mazgch 63:42cb563a25bc 238 \param port the port where the data originates from
mazgch 31:a0bed6c1e05d 239 \param buf the buffer to read into
mazgch 31:a0bed6c1e05d 240 \param len the size of the buffer to read into
mazgch 31:a0bed6c1e05d 241 \return the number of bytes read or SOCKET_ERROR on failure
mazgch 31:a0bed6c1e05d 242 */
mazgch 63:42cb563a25bc 243 int socketRecvFrom(int socket, IP* ip, int* port, char* buf, int len);
mazgch 31:a0bed6c1e05d 244
mazgch 31:a0bed6c1e05d 245 /** Close a connectied socket (that was connected with #socketConnect)
mazgch 31:a0bed6c1e05d 246 \param socket the socket handle
mazgch 31:a0bed6c1e05d 247 \return true if successfully, false otherwise
mazgch 31:a0bed6c1e05d 248 */
mazgch 31:a0bed6c1e05d 249 bool socketClose(int socket);
mazgch 31:a0bed6c1e05d 250
mazgch 31:a0bed6c1e05d 251 /** Free the socket (that was allocated before by #socketSocket)
mazgch 31:a0bed6c1e05d 252 \param socket the socket handle
mazgch 31:a0bed6c1e05d 253 \return true if successfully, false otherwise
mazgch 31:a0bed6c1e05d 254 */
mazgch 31:a0bed6c1e05d 255 bool socketFree(int socket);
mazgch 31:a0bed6c1e05d 256
mazgch 31:a0bed6c1e05d 257 // ----------------------------------------------------------------
mazgch 31:a0bed6c1e05d 258 // SMS Short Message Service
mazgch 31:a0bed6c1e05d 259 // ----------------------------------------------------------------
mazgch 31:a0bed6c1e05d 260
mazgch 31:a0bed6c1e05d 261 /** count the number of sms in the device and optionally return a
mazgch 31:a0bed6c1e05d 262 list with indexes from the storage locations in the device.
mazgch 31:a0bed6c1e05d 263 \param stat what type of messages you can use use
mazgch 31:a0bed6c1e05d 264 "REC UNREAD", "REC READ", "STO UNSENT", "STO SENT", "ALL"
mazgch 31:a0bed6c1e05d 265 \param ix list where to save the storage positions
mazgch 31:a0bed6c1e05d 266 \param num number of elements in the list
mazgch 31:a0bed6c1e05d 267 \return the number of messages, this can be bigger than num, -1 on failure
mazgch 31:a0bed6c1e05d 268 */
mazgch 31:a0bed6c1e05d 269 int smsList(const char* stat = "ALL", int* ix = NULL, int num = 0);
mazgch 31:a0bed6c1e05d 270
mazgch 31:a0bed6c1e05d 271 /** Read a Message from a storage position
mazgch 31:a0bed6c1e05d 272 \param ix the storage position to read
mazgch 31:a0bed6c1e05d 273 \param num the originator address (~16 chars)
mazgch 31:a0bed6c1e05d 274 \param buf a buffer where to save the sm
mazgch 31:a0bed6c1e05d 275 \param len the length of the sm
mazgch 31:a0bed6c1e05d 276 \return true if successful, false otherwise
mazgch 31:a0bed6c1e05d 277 */
mazgch 31:a0bed6c1e05d 278 bool smsRead(int ix, char* num, char* buf, int len);
mazgch 31:a0bed6c1e05d 279
mazgch 31:a0bed6c1e05d 280 /** Send a message to a recipient
mazgch 31:a0bed6c1e05d 281 \param ix the storage position to delete
mazgch 31:a0bed6c1e05d 282 \return true if successful, false otherwise
mazgch 31:a0bed6c1e05d 283 */
mazgch 31:a0bed6c1e05d 284 bool smsDelete(int ix);
mazgch 31:a0bed6c1e05d 285
mazgch 31:a0bed6c1e05d 286 /** Send a message to a recipient
mazgch 31:a0bed6c1e05d 287 \param num the phone number of the recipient
mazgch 31:a0bed6c1e05d 288 \param buf the content of the message to sent
mazgch 31:a0bed6c1e05d 289 \return true if successful, false otherwise
mazgch 31:a0bed6c1e05d 290 */
mazgch 31:a0bed6c1e05d 291 bool smsSend(const char* num, const char* buf);
mazgch 31:a0bed6c1e05d 292
mazgch 31:a0bed6c1e05d 293 // ----------------------------------------------------------------
mazgch 31:a0bed6c1e05d 294 // USSD Unstructured Supplementary Service Data
mazgch 31:a0bed6c1e05d 295 // ----------------------------------------------------------------
mazgch 31:a0bed6c1e05d 296
mazgch 31:a0bed6c1e05d 297 /** Read a Message from a storage position
mazgch 31:a0bed6c1e05d 298 \param cmd the ussd command to send e.g "*#06#"
mazgch 31:a0bed6c1e05d 299 \param buf a buffer where to save the reply
mazgch 31:a0bed6c1e05d 300 \return true if successful, false otherwise
mazgch 31:a0bed6c1e05d 301 */
mazgch 31:a0bed6c1e05d 302 bool ussdCommand(const char* cmd, char* buf);
mazgch 31:a0bed6c1e05d 303
mazgch 38:e6cab4632d84 304 // ----------------------------------------------------------------
mazgch 80:34985b4d821e 305 // FILE
mazgch 80:34985b4d821e 306 // ----------------------------------------------------------------
mazgch 80:34985b4d821e 307
mazgch 80:34985b4d821e 308 /** Delete a file in the local file system
mazgch 80:34985b4d821e 309 \param filename the name of the file
mazgch 80:34985b4d821e 310 \return true if successful, false otherwise
mazgch 80:34985b4d821e 311 */
mazgch 80:34985b4d821e 312 bool delFile(const char* filename);
mazgch 80:34985b4d821e 313
mazgch 80:34985b4d821e 314 /** Write some data to a file in the local file system
mazgch 80:34985b4d821e 315 \param filename the name of the file
mazgch 80:34985b4d821e 316 \param buf the data to write
mazgch 80:34985b4d821e 317 \param len the size of the data to write
mazgch 80:34985b4d821e 318 \return the number of bytes written
mazgch 80:34985b4d821e 319 */
mazgch 80:34985b4d821e 320 int writeFile(const char* filename, const char* buf, int len);
mazgch 80:34985b4d821e 321
mazgch 80:34985b4d821e 322 /** REad a file from the local file system
mazgch 80:34985b4d821e 323 \param filename the name of the file
mazgch 80:34985b4d821e 324 \param buf a buffer to hold the data
mazgch 80:34985b4d821e 325 \param len the size to read
mazgch 80:34985b4d821e 326 \return the number of bytes read
mazgch 80:34985b4d821e 327 */
mazgch 80:34985b4d821e 328 int readFile(const char* filename, char* buf, int len);
mazgch 80:34985b4d821e 329
mazgch 80:34985b4d821e 330 // ----------------------------------------------------------------
mazgch 74:208e3e32d263 331 // DEBUG/DUMP status to standard out (printf)
mazgch 54:7ba8e4c218e2 332 // ----------------------------------------------------------------
mazgch 54:7ba8e4c218e2 333
mazgch 74:208e3e32d263 334 /*! Set the debug level
mazgch 117:74e4e0109a9e 335 \param level -1 = OFF, 0 = ERROR, 1 = INFO(default), 2 = TRACE, 3 = ATCMD,TEST
mazgch 74:208e3e32d263 336 \return true if successful, false not possible
mazgch 74:208e3e32d263 337 */
mazgch 74:208e3e32d263 338 bool setDebug(int level);
mazgch 74:208e3e32d263 339
mazgch 73:2b32e0a21df2 340 //! helper type for DPRINT
mazgch 73:2b32e0a21df2 341 typedef int (*_DPRINT)(void* param, char const * format, ...);
mazgch 73:2b32e0a21df2 342
mazgch 73:2b32e0a21df2 343 //! helper to declate templates and void versions
mazgch 73:2b32e0a21df2 344 #define _DUMP_TEMPLATE(func, type, arg) \
mazgch 73:2b32e0a21df2 345 template<class T> \
mazgch 73:2b32e0a21df2 346 inline void func(type arg, \
mazgch 73:2b32e0a21df2 347 int (*dprint)( T* param, char const * format, ...), \
mazgch 73:2b32e0a21df2 348 T* param) { func(arg, (_DPRINT)dprint, (void*)param); } \
mazgch 73:2b32e0a21df2 349 static void func(type arg, \
mazgch 73:2b32e0a21df2 350 _DPRINT dprint = (_DPRINT)fprintf, \
mazgch 73:2b32e0a21df2 351 void* param = (void*)stdout);
mazgch 74:208e3e32d263 352
mazgch 54:7ba8e4c218e2 353 /** dump the device status to stdout using printf
mazgch 54:7ba8e4c218e2 354 \param status the status to convert to textual form,
mazgch 54:7ba8e4c218e2 355 unavailable fields are ommited (not printed)
mazgch 73:2b32e0a21df2 356 \param dprint a function pointer
mazgch 73:2b32e0a21df2 357 \param param the irst argument passed to dprint
mazgch 54:7ba8e4c218e2 358 */
mazgch 73:2b32e0a21df2 359 _DUMP_TEMPLATE(dumpDevStatus, MDMParser::DevStatus*, status)
mazgch 54:7ba8e4c218e2 360
mazgch 54:7ba8e4c218e2 361 /** dump the network status to stdout using printf
mazgch 54:7ba8e4c218e2 362 \param status the status to convert to textual form,
mazgch 54:7ba8e4c218e2 363 unavailable fields are ommited (not printed)
mazgch 73:2b32e0a21df2 364 \param dprint a function pointer
mazgch 73:2b32e0a21df2 365 \param param the irst argument passed to dprint
mazgch 54:7ba8e4c218e2 366 */
mazgch 73:2b32e0a21df2 367 _DUMP_TEMPLATE(dumpNetStatus, MDMParser::NetStatus*, status)
mazgch 73:2b32e0a21df2 368
mazgch 54:7ba8e4c218e2 369 /** dump the ip address to stdout using printf
mazgch 54:7ba8e4c218e2 370 \param ip the ip to convert to textual form,
mazgch 54:7ba8e4c218e2 371 unavailable fields are ommited (not printed)
mazgch 73:2b32e0a21df2 372 \param dprint a function pointer
mazgch 73:2b32e0a21df2 373 \param param the irst argument passed to dprint
mazgch 54:7ba8e4c218e2 374 */
mazgch 73:2b32e0a21df2 375 _DUMP_TEMPLATE(dumpIp, MDMParser::IP, ip)
mazgch 73:2b32e0a21df2 376
mazgch 54:7ba8e4c218e2 377 // ----------------------------------------------------------------
mazgch 31:a0bed6c1e05d 378 // Parseing
mazgch 31:a0bed6c1e05d 379 // ----------------------------------------------------------------
mazgch 31:a0bed6c1e05d 380
mazgch 51:e7b81c31baec 381 enum {
mazgch 51:e7b81c31baec 382 // waitFinalResp Responses
mazgch 52:8071747a7cb3 383 NOT_FOUND = 0,
mazgch 52:8071747a7cb3 384 WAIT = -1, // TIMEOUT
mazgch 52:8071747a7cb3 385 RESP_OK = -2,
mazgch 52:8071747a7cb3 386 RESP_ERROR = -3,
mazgch 52:8071747a7cb3 387 RESP_PROMPT = -4,
mazgch 31:a0bed6c1e05d 388
mazgch 51:e7b81c31baec 389 // getLine Responses
mazgch 51:e7b81c31baec 390 #define LENGTH(x) (x & 0x00FFFF) //!< extract/mask the length
mazgch 51:e7b81c31baec 391 #define TYPE(x) (x & 0xFF0000) //!< extract/mask the type
mazgch 51:e7b81c31baec 392
mazgch 51:e7b81c31baec 393 TYPE_UNKNOWN = 0x000000,
mazgch 51:e7b81c31baec 394 TYPE_OK = 0x110000,
mazgch 51:e7b81c31baec 395 TYPE_ERROR = 0x120000,
mazgch 51:e7b81c31baec 396 TYPE_RING = 0x210000,
mazgch 51:e7b81c31baec 397 TYPE_CONNECT = 0x220000,
mazgch 51:e7b81c31baec 398 TYPE_NOCARRIER = 0x230000,
mazgch 51:e7b81c31baec 399 TYPE_NODIALTONE = 0x240000,
mazgch 51:e7b81c31baec 400 TYPE_BUSY = 0x250000,
mazgch 51:e7b81c31baec 401 TYPE_NOANSWER = 0x260000,
mazgch 51:e7b81c31baec 402 TYPE_PROMPT = 0x300000,
mazgch 51:e7b81c31baec 403 TYPE_PLUS = 0x400000,
mazgch 66:69072b3c5bca 404 TYPE_TEXT = 0x500000,
mazgch 66:69072b3c5bca 405
mazgch 66:69072b3c5bca 406 // special timout constant
mazgch 66:69072b3c5bca 407 TIMEOUT_BLOCKING = -1
mazgch 51:e7b81c31baec 408 };
mazgch 31:a0bed6c1e05d 409
mazgch 31:a0bed6c1e05d 410 /** Get a line from the physical interface. This function need
mazgch 31:a0bed6c1e05d 411 to be implemented in a inherited class. Usually just calls
mazgch 31:a0bed6c1e05d 412 #_getLine on the rx buffer pipe.
mazgch 31:a0bed6c1e05d 413
mazgch 31:a0bed6c1e05d 414 \param buf the buffer to store it
mazgch 31:a0bed6c1e05d 415 \param buf size of the buffer
mazgch 31:a0bed6c1e05d 416 \return type and length if something was found,
mazgch 31:a0bed6c1e05d 417 WAIT if not enough data is available
mazgch 31:a0bed6c1e05d 418 NOT_FOUND if nothing was found
mazgch 31:a0bed6c1e05d 419 */
mazgch 31:a0bed6c1e05d 420 virtual int getLine(char* buf, int len) = 0;
mazgch 28:4d9509e3b1cf 421
mazgch 101:edfeb8af206e 422 /* clear the pending input data
mazgch 101:edfeb8af206e 423 */
mazgch 101:edfeb8af206e 424 virtual void purge(void) = 0;
mazgch 101:edfeb8af206e 425
mazgch 31:a0bed6c1e05d 426 /** Write data to the device
mazgch 31:a0bed6c1e05d 427 \param buf the buffer to write
mazgch 31:a0bed6c1e05d 428 \param buf size of the buffer to write
mazgch 31:a0bed6c1e05d 429 \return bytes written
mazgch 31:a0bed6c1e05d 430 */
mazgch 31:a0bed6c1e05d 431 virtual int send(const char* buf, int len);
mazgch 21:c4d64830bf02 432
mazgch 31:a0bed6c1e05d 433 /** Write formated date to the physical interface (printf style)
mazgch 31:a0bed6c1e05d 434 \param fmt the format string
mazgch 31:a0bed6c1e05d 435 \param .. variable arguments to be formated
mazgch 31:a0bed6c1e05d 436 \return bytes written
mazgch 31:a0bed6c1e05d 437 */
mazgch 21:c4d64830bf02 438 int sendFormated(const char* format, ...);
mazgch 26:07be5faf8925 439
mazgch 31:a0bed6c1e05d 440 /** callback function for #waitFinalResp with void* as argument
mazgch 31:a0bed6c1e05d 441 \param type the #getLine response
mazgch 31:a0bed6c1e05d 442 \param buf the parsed line
mazgch 31:a0bed6c1e05d 443 \param len the size of the parsed line
mazgch 31:a0bed6c1e05d 444 \param param the optional argument passed to #waitFinalResp
mazgch 31:a0bed6c1e05d 445 \return WAIT if processing should continue,
mazgch 31:a0bed6c1e05d 446 any other value aborts #waitFinalResp and this retunr value retuned
mazgch 31:a0bed6c1e05d 447 */
mazgch 26:07be5faf8925 448 typedef int (*_CALLBACKPTR)(int type, const char* buf, int len, void* param);
mazgch 31:a0bed6c1e05d 449
mazgch 31:a0bed6c1e05d 450 /** Wait for a final respons
mazgch 31:a0bed6c1e05d 451 \param cb the optional callback function
mazgch 31:a0bed6c1e05d 452 \param param the optional callback function parameter
mazgch 58:e38a2e942fbb 453 \param timeout_ms the timeout to wait (See Estimated command
mazgch 58:e38a2e942fbb 454 response time of AT manual)
mazgch 31:a0bed6c1e05d 455 */
mazgch 31:a0bed6c1e05d 456 int waitFinalResp(_CALLBACKPTR cb = NULL,
mazgch 26:07be5faf8925 457 void* param = NULL,
mazgch 58:e38a2e942fbb 458 int timeout_ms = 10000);
mazgch 31:a0bed6c1e05d 459
mazgch 31:a0bed6c1e05d 460 /** template version of #waitFinalResp when using callbacks,
mazgch 31:a0bed6c1e05d 461 This template will allow the compiler to do type cheking but
mazgch 31:a0bed6c1e05d 462 internally symply casts the arguments and call the (void*)
mazgch 31:a0bed6c1e05d 463 version of #waitFinalResp.
mazgch 31:a0bed6c1e05d 464 \sa waitFinalResp
mazgch 31:a0bed6c1e05d 465 */
mazgch 26:07be5faf8925 466 template<class T>
mazgch 73:2b32e0a21df2 467 inline int waitFinalResp(int (*cb)(int type, const char* buf, int len, T* param),
mazgch 73:2b32e0a21df2 468 T* param,
mazgch 73:2b32e0a21df2 469 int timeout_ms = 10000)
mazgch 26:07be5faf8925 470 {
mazgch 26:07be5faf8925 471 return waitFinalResp((_CALLBACKPTR)cb, (void*)param, timeout_ms);
mazgch 26:07be5faf8925 472 }
mazgch 31:a0bed6c1e05d 473
mazgch 18:e5697801df29 474 protected:
mazgch 31:a0bed6c1e05d 475 /** Write bytes to the physical interface. This function should be
mazgch 31:a0bed6c1e05d 476 implemented in a inherited class.
mazgch 31:a0bed6c1e05d 477 \param buf the buffer to write
mazgch 31:a0bed6c1e05d 478 \param buf size of the buffer to write
mazgch 31:a0bed6c1e05d 479 \return bytes written
mazgch 31:a0bed6c1e05d 480 */
mazgch 18:e5697801df29 481 virtual int _send(const void* buf, int len) = 0;
mazgch 31:a0bed6c1e05d 482
mazgch 31:a0bed6c1e05d 483 /** Helper: Parse a line from the receiving buffered pipe
mazgch 31:a0bed6c1e05d 484 \param pipe the receiving buffer pipe
mazgch 31:a0bed6c1e05d 485 \param buf the parsed line
mazgch 31:a0bed6c1e05d 486 \param len the size of the parsed line
mazgch 31:a0bed6c1e05d 487 \return type and length if something was found,
mazgch 31:a0bed6c1e05d 488 WAIT if not enough data is available
mazgch 31:a0bed6c1e05d 489 NOT_FOUND if nothing was found
mazgch 31:a0bed6c1e05d 490 */
mazgch 31:a0bed6c1e05d 491 static int _getLine(Pipe<char>* pipe, char* buffer, int length);
mazgch 31:a0bed6c1e05d 492
mazgch 31:a0bed6c1e05d 493 /** Helper: Parse a match from the pipe
mazgch 31:a0bed6c1e05d 494 \param pipe the buffered pipe
mazgch 31:a0bed6c1e05d 495 \param number of bytes to parse at maximum,
mazgch 31:a0bed6c1e05d 496 \param sta the starting string, NULL if none
mazgch 31:a0bed6c1e05d 497 \param end the terminating string, NULL if none
mazgch 31:a0bed6c1e05d 498 \return size of parsed match
mazgch 31:a0bed6c1e05d 499 */
mazgch 31:a0bed6c1e05d 500 static int _parseMatch(Pipe<char>* pipe, int len, const char* sta, const char* end);
mazgch 31:a0bed6c1e05d 501
mazgch 31:a0bed6c1e05d 502 /** Helper: Parse a match from the pipe
mazgch 31:a0bed6c1e05d 503 \param pipe the buffered pipe
mazgch 31:a0bed6c1e05d 504 \param number of bytes to parse at maximum,
mazgch 31:a0bed6c1e05d 505 \param fmt the formating string (%d any number, %c any char of last %d len)
mazgch 31:a0bed6c1e05d 506 \return size of parsed match
mazgch 31:a0bed6c1e05d 507 */
mazgch 31:a0bed6c1e05d 508 static int _parseFormated(Pipe<char>* pipe, int len, const char* fmt);
mazgch 31:a0bed6c1e05d 509
mazgch 35:9275215a3a5b 510 protected:
mazgch 95:8282dbbe1492 511 // for rtos over riding by useing Rtos<MDMxx>
mazgch 95:8282dbbe1492 512 /** override in a rtos system, you us the wait function of a Thread
mazgch 95:8282dbbe1492 513 \param ms the number of milliseconds to wait
mazgch 95:8282dbbe1492 514 */
mazgch 95:8282dbbe1492 515 virtual void wait_ms(int ms) { if (ms) ::wait_ms(ms); }
mazgch 95:8282dbbe1492 516 //! override the lock in a rtos system
mazgch 95:8282dbbe1492 517 virtual void lock(void) { }
mazgch 95:8282dbbe1492 518 //! override the unlock in a rtos system
mazgch 95:8282dbbe1492 519 virtual void unlock(void) { }
mazgch 95:8282dbbe1492 520 protected:
mazgch 31:a0bed6c1e05d 521 // parsing callbacks for different AT commands and their parameter arguments
mazgch 31:a0bed6c1e05d 522 static int _cbString(int type, const char* buf, int len, char* str);
mazgch 31:a0bed6c1e05d 523 static int _cbInt(int type, const char* buf, int len, int* val);
mazgch 31:a0bed6c1e05d 524 // device
mazgch 32:8f12ac182bbb 525 static int _cbATI(int type, const char* buf, int len, Dev* dev);
mazgch 31:a0bed6c1e05d 526 static int _cbCPIN(int type, const char* buf, int len, Sim* sim);
mazgch 31:a0bed6c1e05d 527 static int _cbCCID(int type, const char* buf, int len, char* ccid);
mazgch 31:a0bed6c1e05d 528 // network
mazgch 54:7ba8e4c218e2 529 static int _cbCSQ(int type, const char* buf, int len, NetStatus* status);
mazgch 31:a0bed6c1e05d 530 static int _cbCOPS(int type, const char* buf, int len, NetStatus* status);
mazgch 31:a0bed6c1e05d 531 static int _cbCNUM(int type, const char* buf, int len, char* num);
mazgch 81:3966a5c17037 532 static int _cbUACTIND(int type, const char* buf, int len, int* i);
mazgch 84:a05edb010176 533 static int _cbUDOPN(int type, const char* buf, int len, char* mccmnc);
mazgch 31:a0bed6c1e05d 534 // sockets
mazgch 32:8f12ac182bbb 535 static int _cbCMIP(int type, const char* buf, int len, IP* ip);
mazgch 31:a0bed6c1e05d 536 static int _cbUPSND(int type, const char* buf, int len, int* act);
mazgch 31:a0bed6c1e05d 537 static int _cbUPSND(int type, const char* buf, int len, IP* ip);
mazgch 21:c4d64830bf02 538 static int _cbUDNSRN(int type, const char* buf, int len, IP* ip);
mazgch 103:197fa7920ad8 539 static int _cbUSOCR(int type, const char* buf, int len, int* handle);
mazgch 21:c4d64830bf02 540 static int _cbUSORD(int type, const char* buf, int len, char* out);
mazgch 21:c4d64830bf02 541 typedef struct { char* buf; IP ip; int port; } USORFparam;
mazgch 21:c4d64830bf02 542 static int _cbUSORF(int type, const char* buf, int len, USORFparam* param);
mazgch 21:c4d64830bf02 543 typedef struct { char* buf; char* num; } CMGRparam;
mazgch 21:c4d64830bf02 544 static int _cbCUSD(int type, const char* buf, int len, char* buf);
mazgch 31:a0bed6c1e05d 545 // sms
mazgch 31:a0bed6c1e05d 546 typedef struct { int* ix; int num; } CMGLparam;
mazgch 31:a0bed6c1e05d 547 static int _cbCMGL(int type, const char* buf, int len, CMGLparam* param);
mazgch 21:c4d64830bf02 548 static int _cbCMGR(int type, const char* buf, int len, CMGRparam* param);
mazgch 80:34985b4d821e 549 // file
mazgch 80:34985b4d821e 550 typedef struct { const char* filename; char* buf; int sz; int len; } URDFILEparam;
mazgch 115:d8d94b73c725 551 static int _cbUDELFILE(int type, const char* buf, int len, void*);
mazgch 80:34985b4d821e 552 static int _cbURDFILE(int type, const char* buf, int len, URDFILEparam* param);
mazgch 38:e6cab4632d84 553 // variables
mazgch 31:a0bed6c1e05d 554 DevStatus _dev; //!< collected device information
mazgch 31:a0bed6c1e05d 555 NetStatus _net; //!< collected network information
mazgch 31:a0bed6c1e05d 556 IP _ip; //!< assigned ip address
mazgch 31:a0bed6c1e05d 557 // management struture for sockets
mazgch 103:197fa7920ad8 558 typedef struct { int handle; int timeout_ms; volatile bool connected; volatile int pending; } SockCtrl;
mazgch 103:197fa7920ad8 559 // LISA-C has 6 TCP and 6 UDP sockets
mazgch 103:197fa7920ad8 560 // LISA-U and SARA-G have 7 sockets
mazgch 103:197fa7920ad8 561 SockCtrl _sockets[12];
mazgch 103:197fa7920ad8 562 int _findSocket(int handle = SOCKET_ERROR/* = CREATE*/);
mazgch 44:9d12223b78ff 563 static MDMParser* inst;
mazgch 76:f7c3dd568dae 564 bool _init;
mazgch 74:208e3e32d263 565 #ifdef TARGET_UBLOX_C027
mazgch 74:208e3e32d263 566 bool _onboard;
mazgch 74:208e3e32d263 567 #endif
mazgch 74:208e3e32d263 568 #ifdef MDM_DEBUG
mazgch 74:208e3e32d263 569 int _debugLevel;
mazgch 74:208e3e32d263 570 Timer _debugTime;
mazgch 117:74e4e0109a9e 571 void _debugPrint(int level, const char* color, const char* format, ...);
mazgch 74:208e3e32d263 572 #endif
mazgch 18:e5697801df29 573 };
mazgch 18:e5697801df29 574
mazgch 18:e5697801df29 575 // -----------------------------------------------------------------------
mazgch 18:e5697801df29 576
mazgch 38:e6cab4632d84 577 /** modem class which uses a serial port
mazgch 38:e6cab4632d84 578 as physical interface.
mazgch 38:e6cab4632d84 579 */
mazgch 18:e5697801df29 580 class MDMSerial : public SerialPipe, public MDMParser
mazgch 17:296d94a006b4 581 {
mazgch 17:296d94a006b4 582 public:
mazgch 38:e6cab4632d84 583 /** Constructor
mazgch 38:e6cab4632d84 584
mazgch 38:e6cab4632d84 585 \param tx is the serial ports transmit pin (modem to CPU)
mazgch 38:e6cab4632d84 586 \param rx is the serial ports receive pin (CPU to modem)
mazgch 38:e6cab4632d84 587 \param baudrate the baudrate of the modem use 115200
mazgch 38:e6cab4632d84 588 \param rts is the serial ports ready to send pin (CPU to modem)
mazgch 38:e6cab4632d84 589 this pin is optional
mazgch 38:e6cab4632d84 590 \param cts is the serial ports clear to send pin (modem to CPU)
mazgch 38:e6cab4632d84 591 this pin is optional, but required for power saving to be enabled
mazgch 38:e6cab4632d84 592 \param rxSize the size of the serial rx buffer
mazgch 38:e6cab4632d84 593 \param txSize the size of the serial tx buffer
mazgch 38:e6cab4632d84 594 */
mazgch 75:ce6e12067d0c 595 MDMSerial(PinName tx MDM_IF( = MDMTXD, = D1 ),
mazgch 75:ce6e12067d0c 596 PinName rx MDM_IF( = MDMRXD, = D0 ),
mazgch 75:ce6e12067d0c 597 int baudrate MDM_IF( = MDMBAUD, = 115200 ),
mazgch 35:9275215a3a5b 598 #if DEVICE_SERIAL_FC
mazgch 75:ce6e12067d0c 599 PinName rts MDM_IF( = MDMRTS, = NC /* D2 resistor R62 on shield not mounted */ ),
mazgch 75:ce6e12067d0c 600 PinName cts MDM_IF( = MDMCTS, = NC /* D3 resistor R63 on shield not mounted */ ),
mazgch 35:9275215a3a5b 601 #endif
mazgch 19:2b5d097ca15d 602 int rxSize = 256 ,
mazgch 21:c4d64830bf02 603 int txSize = 128 );
mazgch 76:f7c3dd568dae 604 //! Destructor
mazgch 93:2b5478693c20 605 virtual ~MDMSerial(void);
mazgch 76:f7c3dd568dae 606
mazgch 38:e6cab4632d84 607 /** Get a line from the physical interface.
mazgch 38:e6cab4632d84 608 \param buf the buffer to store it
mazgch 38:e6cab4632d84 609 \param buf size of the buffer
mazgch 38:e6cab4632d84 610 \return type and length if something was found,
mazgch 38:e6cab4632d84 611 WAIT if not enough data is available
mazgch 38:e6cab4632d84 612 NOT_FOUND if nothing was found
mazgch 38:e6cab4632d84 613 */
mazgch 18:e5697801df29 614 virtual int getLine(char* buffer, int length);
mazgch 101:edfeb8af206e 615
mazgch 101:edfeb8af206e 616 /* clear the pending input data */
mazgch 101:edfeb8af206e 617 virtual void purge(void)
mazgch 101:edfeb8af206e 618 {
mazgch 101:edfeb8af206e 619 while (readable())
mazgch 101:edfeb8af206e 620 getc();
mazgch 101:edfeb8af206e 621 }
mazgch 18:e5697801df29 622 protected:
mazgch 38:e6cab4632d84 623 /** Write bytes to the physical interface.
mazgch 38:e6cab4632d84 624 \param buf the buffer to write
mazgch 38:e6cab4632d84 625 \param buf size of the buffer to write
mazgch 38:e6cab4632d84 626 \return bytes written
mazgch 38:e6cab4632d84 627 */
mazgch 18:e5697801df29 628 virtual int _send(const void* buf, int len);
mazgch 17:296d94a006b4 629 };
mazgch 18:e5697801df29 630
mazgch 18:e5697801df29 631 // -----------------------------------------------------------------------
mazgch 18:e5697801df29 632
mazgch 38:e6cab4632d84 633 //#define HAVE_MDMUSB
mazgch 18:e5697801df29 634 #ifdef HAVE_MDMUSB
mazgch 18:e5697801df29 635 class MDMUsb : /*public UsbSerial,*/ public MDMParser
mazgch 18:e5697801df29 636 {
mazgch 18:e5697801df29 637 public:
mazgch 76:f7c3dd568dae 638 //! Constructor
mazgch 18:e5697801df29 639 MDMUsb(void);
mazgch 76:f7c3dd568dae 640 //! Destructor
mazgch 93:2b5478693c20 641 virtual ~MDMUsb(void);
mazgch 18:e5697801df29 642 virtual int getLine(char* buffer, int length);
mazgch 101:edfeb8af206e 643 virtual void purge(void) { }
mazgch 18:e5697801df29 644 protected:
mazgch 18:e5697801df29 645 virtual int _send(const void* buf, int len);
mazgch 18:e5697801df29 646 };
mazgch 18:e5697801df29 647 #endif
mazgch 18:e5697801df29 648
mazgch 95:8282dbbe1492 649 // -----------------------------------------------------------------------
mazgch 18:e5697801df29 650
mazgch 95:8282dbbe1492 651 #ifdef RTOS_H
mazgch 95:8282dbbe1492 652 /** Use this template to override the lock and wait functions of the
mazgch 95:8282dbbe1492 653 modem driver in a Rtos system. For example declare it the modem
mazgch 95:8282dbbe1492 654 object as MDMRtos<MDMSerial> instead of MDMSerial.
mazgch 95:8282dbbe1492 655 */
mazgch 95:8282dbbe1492 656 template <class T>
mazgch 95:8282dbbe1492 657 class MDMRtos : public T
mazgch 95:8282dbbe1492 658 {
mazgch 95:8282dbbe1492 659 protected:
mazgch 95:8282dbbe1492 660 //! we assume that the modem runs in a thread so we yield when waiting
mazgch 95:8282dbbe1492 661 virtual void wait_ms(int ms) {
mazgch 95:8282dbbe1492 662 if (ms) Thread::wait(ms);
mazgch 95:8282dbbe1492 663 else Thread::yield();
mazgch 95:8282dbbe1492 664 }
mazgch 95:8282dbbe1492 665 //! lock a mutex when accessing the modem
mazgch 95:8282dbbe1492 666 virtual void lock(void) { _mtx.lock(); }
mazgch 95:8282dbbe1492 667 //! unlock the modem when done accessing it
mazgch 95:8282dbbe1492 668 virtual void unlock(void) { _mtx.unlock(); }
mazgch 95:8282dbbe1492 669 // the mutex resource
mazgch 95:8282dbbe1492 670 Mutex _mtx;
mazgch 95:8282dbbe1492 671 };
mazgch 95:8282dbbe1492 672 #endif