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@31:a0bed6c1e05d, 2014-04-09 (annotated)

Committer:
mazgch
Date:
Wed Apr 09 11:48:04 2014 +0000
Revision:
31:a0bed6c1e05d
Parent:
29:53d346010624
Child:
32:8f12ac182bbb
restructure the modem APIs make them more robust

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 19:2b5d097ca15d 10 // if we detect the C027 platform we will assign the
mazgch 19:2b5d097ca15d 11 // default pinname and baudrate in the constructor
mazgch 19:2b5d097ca15d 12 // this helper macro will be used.
mazgch 19:2b5d097ca15d 13 #define _C027DEFAULT(name) = name
mazgch 19:2b5d097ca15d 14 #else
mazgch 19:2b5d097ca15d 15 #define _C027DEFAULT(name)
mazgch 19:2b5d097ca15d 16 #endif
mazgch 18:e5697801df29 17
mazgch 18:e5697801df29 18 class MDMParser
mazgch 18:e5697801df29 19 {
mazgch 18:e5697801df29 20 public:
mazgch 31:a0bed6c1e05d 21 //! Constructor
mazgch 31:a0bed6c1e05d 22 MDMParser(void);
mazgch 31:a0bed6c1e05d 23
mazgch 31:a0bed6c1e05d 24 // ----------------------------------------------------------------
mazgch 31:a0bed6c1e05d 25 // Types
mazgch 31:a0bed6c1e05d 26 // ----------------------------------------------------------------
mazgch 31:a0bed6c1e05d 27
mazgch 31:a0bed6c1e05d 28 //! MT models
mazgch 31:a0bed6c1e05d 29 typedef enum { MODEL_UNKNOWN, MODEL_SARA_G350, MODEL_LISA_U200, MODEL_LISA_C200 } Model;
mazgch 31:a0bed6c1e05d 30 //! SIM Status
mazgch 31:a0bed6c1e05d 31 typedef enum { SIM_UNKNOWN, SIM_PIN, SIM_READY } Sim;
mazgch 31:a0bed6c1e05d 32 //! Device status
mazgch 31:a0bed6c1e05d 33 typedef struct { Model model; Sim sim; char ccid[20]; char imsi[16]; char imei[16]; } DevStatus;
mazgch 31:a0bed6c1e05d 34 //! Network Registration Status
mazgch 31:a0bed6c1e05d 35 typedef enum { REG_UNKNOWN, REG_DENIED, REG_NONE, REG_HOME, REG_ROAMING } Reg;
mazgch 31:a0bed6c1e05d 36 // Access Technology
mazgch 31:a0bed6c1e05d 37 typedef enum { ACT_UNKNOWN, ACT_GSM, ACT_EDGE, ACT_UTRAN, ACT_CDMA } AcT;
mazgch 31:a0bed6c1e05d 38 // Network Status
mazgch 31:a0bed6c1e05d 39 typedef struct { Reg reg; AcT act; int rssi; char opr[17]; char num[20]; } NetStatus;
mazgch 31:a0bed6c1e05d 40 //! An IP address
mazgch 31:a0bed6c1e05d 41 typedef uint32_t IP;
mazgch 31:a0bed6c1e05d 42 //! No IP address
mazgch 31:a0bed6c1e05d 43 #define NOIP ((MDMParser::IP)0)
mazgch 31:a0bed6c1e05d 44 // ip number formating and conversion
mazgch 31:a0bed6c1e05d 45 #define IPSTR "%d.%d.%d.%d"
mazgch 31:a0bed6c1e05d 46 #define IPNUM(ip) ((ip)>>24)&0xff, \
mazgch 31:a0bed6c1e05d 47 ((ip)>>16)&0xff, \
mazgch 31:a0bed6c1e05d 48 ((ip)>> 8)&0xff, \
mazgch 31:a0bed6c1e05d 49 ((ip)>> 0)&0xff
mazgch 31:a0bed6c1e05d 50 #define IPADR(a,b,c,d) ((((IP)(a))<<24) | \
mazgch 31:a0bed6c1e05d 51 (((IP)(b))<<16) | \
mazgch 31:a0bed6c1e05d 52 (((IP)(c))<< 8) | \
mazgch 31:a0bed6c1e05d 53 (((IP)(d))<< 0))
mazgch 31:a0bed6c1e05d 54
mazgch 31:a0bed6c1e05d 55
mazgch 31:a0bed6c1e05d 56 // ----------------------------------------------------------------
mazgch 31:a0bed6c1e05d 57 // Data Connection (GPRS)
mazgch 31:a0bed6c1e05d 58 // ----------------------------------------------------------------
mazgch 31:a0bed6c1e05d 59
mazgch 31:a0bed6c1e05d 60 /** register (Attach) the MT to the GPRS service.
mazgch 31:a0bed6c1e05d 61 \param pin a optional pin of the SIM card
mazgch 31:a0bed6c1e05d 62 \param status an optional struture to with device information
mazgch 31:a0bed6c1e05d 63 \return true if successful, false otherwise
mazgch 31:a0bed6c1e05d 64 */
mazgch 31:a0bed6c1e05d 65 bool init(const char* pin = NULL, DevStatus* status = NULL);
mazgch 31:a0bed6c1e05d 66
mazgch 31:a0bed6c1e05d 67 /** check if the network is available
mazgch 31:a0bed6c1e05d 68 \param status an optional structure to with network information
mazgch 31:a0bed6c1e05d 69 \return true if successful and connected to network, false otherwise
mazgch 31:a0bed6c1e05d 70 */
mazgch 31:a0bed6c1e05d 71 bool checkNetStatus(NetStatus* status = NULL);
mazgch 31:a0bed6c1e05d 72
mazgch 31:a0bed6c1e05d 73 /** Power off the MT, This function has to be called prior to
mazgch 31:a0bed6c1e05d 74 switching off the supply.
mazgch 31:a0bed6c1e05d 75 \return true if successfully, false otherwise
mazgch 31:a0bed6c1e05d 76 */
mazgch 31:a0bed6c1e05d 77 bool powerOff(void);
mazgch 31:a0bed6c1e05d 78
mazgch 31:a0bed6c1e05d 79 // ----------------------------------------------------------------
mazgch 31:a0bed6c1e05d 80 // Data Connection (GPRS)
mazgch 31:a0bed6c1e05d 81 // ----------------------------------------------------------------
mazgch 31:a0bed6c1e05d 82
mazgch 31:a0bed6c1e05d 83 /** register (Attach) the MT to the GPRS service.
mazgch 31:a0bed6c1e05d 84 \param apn the of the network provider e.g. "internet" or "apn.provider.com"
mazgch 31:a0bed6c1e05d 85 \param user is the user name text string for the authentication phase
mazgch 31:a0bed6c1e05d 86 \param password is the password text string for the authentication phase
mazgch 31:a0bed6c1e05d 87 \return the ip that is assigned
mazgch 31:a0bed6c1e05d 88 */
mazgch 31:a0bed6c1e05d 89 MDMParser::IP join(const char* apn = NULL, const char* user = NULL, const char* password = NULL);
mazgch 31:a0bed6c1e05d 90
mazgch 31:a0bed6c1e05d 91 /** deregister (detach) the MT from the GPRS service.
mazgch 31:a0bed6c1e05d 92 \return true if successful, false otherwise
mazgch 31:a0bed6c1e05d 93 */
mazgch 31:a0bed6c1e05d 94 bool disconnect(void);
mazgch 31:a0bed6c1e05d 95
mazgch 31:a0bed6c1e05d 96 /** Translates a domain name to an IP address
mazgch 31:a0bed6c1e05d 97 \param host the domain name to translate e.g. "u-blox.com"
mazgch 31:a0bed6c1e05d 98 \return the IP if successful, 0 otherwise
mazgch 31:a0bed6c1e05d 99 */
mazgch 31:a0bed6c1e05d 100 MDMParser::IP gethostbyname(const char* host);
mazgch 31:a0bed6c1e05d 101
mazgch 31:a0bed6c1e05d 102 // ----------------------------------------------------------------
mazgch 31:a0bed6c1e05d 103 // Sockets
mazgch 31:a0bed6c1e05d 104 // ----------------------------------------------------------------
mazgch 31:a0bed6c1e05d 105
mazgch 31:a0bed6c1e05d 106 //! Type of IP protocol
mazgch 31:a0bed6c1e05d 107 typedef enum { IPPROTO_TCP, IPPROTO_UDP } IpProtocol;
mazgch 31:a0bed6c1e05d 108
mazgch 31:a0bed6c1e05d 109 //! Socket error return codes
mazgch 31:a0bed6c1e05d 110 #define SOCKET_ERROR -1
mazgch 31:a0bed6c1e05d 111
mazgch 31:a0bed6c1e05d 112 /** Create a socket for a ip protocol
mazgch 31:a0bed6c1e05d 113 \param ipproto the protocol (UDP or TCP)
mazgch 31:a0bed6c1e05d 114 \return the socket handle if successful or SOCKET_ERROR on failure
mazgch 31:a0bed6c1e05d 115 */
mazgch 31:a0bed6c1e05d 116 int socketSocket(IpProtocol ipproto);
mazgch 31:a0bed6c1e05d 117
mazgch 31:a0bed6c1e05d 118 /** make a socket connection
mazgch 31:a0bed6c1e05d 119 \param socket the socket handle
mazgch 31:a0bed6c1e05d 120 \param host the domain name to connect e.g. "u-blox.com"
mazgch 31:a0bed6c1e05d 121 \param port the port to connect
mazgch 31:a0bed6c1e05d 122 \return true if successfully, false otherwise
mazgch 31:a0bed6c1e05d 123 */
mazgch 31:a0bed6c1e05d 124 bool socketConnect(int socket, const char* host, int port);
mazgch 31:a0bed6c1e05d 125
mazgch 31:a0bed6c1e05d 126 /** Write socket data
mazgch 31:a0bed6c1e05d 127 \param socket the socket handle
mazgch 31:a0bed6c1e05d 128 \param buf the buffer to write
mazgch 31:a0bed6c1e05d 129 \param len the size of the buffer to write
mazgch 31:a0bed6c1e05d 130 \return the size written or SOCKET_ERROR on failure
mazgch 31:a0bed6c1e05d 131 */
mazgch 31:a0bed6c1e05d 132 int socketSend(int socket, const char * buf, int len);
mazgch 31:a0bed6c1e05d 133
mazgch 31:a0bed6c1e05d 134 /** Write socket data to a IP
mazgch 31:a0bed6c1e05d 135 \param socket the socket handle
mazgch 31:a0bed6c1e05d 136 \param ip the ip to send to
mazgch 31:a0bed6c1e05d 137 \param port the port to send to
mazgch 31:a0bed6c1e05d 138 \param buf the buffer to write
mazgch 31:a0bed6c1e05d 139 \param len the size of the buffer to write
mazgch 31:a0bed6c1e05d 140 \return the size written or SOCKET_ERROR on failure
mazgch 31:a0bed6c1e05d 141 */
mazgch 31:a0bed6c1e05d 142 int socketSendTo(int socket, IP ip, int port, const char * buf, int len);
mazgch 31:a0bed6c1e05d 143
mazgch 31:a0bed6c1e05d 144 /** Get the number of bytes pending for reading for this socket
mazgch 31:a0bed6c1e05d 145 \param socket the socket handle
mazgch 31:a0bed6c1e05d 146 \return the number of bytes pending or SOCKET_ERROR on failure
mazgch 31:a0bed6c1e05d 147 */
mazgch 31:a0bed6c1e05d 148 int socketReadable(int socket);
mazgch 31:a0bed6c1e05d 149
mazgch 31:a0bed6c1e05d 150 /** Read this socket
mazgch 31:a0bed6c1e05d 151 \param socket the socket handle
mazgch 31:a0bed6c1e05d 152 \param buf the buffer to read into
mazgch 31:a0bed6c1e05d 153 \param len the size of the buffer to read into
mazgch 31:a0bed6c1e05d 154 \return the number of bytes read or SOCKET_ERROR on failure
mazgch 31:a0bed6c1e05d 155 */
mazgch 31:a0bed6c1e05d 156 int socketRecv(int socket, char* buf, int len);
mazgch 31:a0bed6c1e05d 157
mazgch 31:a0bed6c1e05d 158 /** Read from this socket
mazgch 31:a0bed6c1e05d 159 \param socket the socket handle
mazgch 31:a0bed6c1e05d 160 \param buf the buffer to read into
mazgch 31:a0bed6c1e05d 161 \param len the size of the buffer to read into
mazgch 31:a0bed6c1e05d 162 \param ip the ip of host where the data originates from
mazgch 31:a0bed6c1e05d 163 \return the number of bytes read or SOCKET_ERROR on failure
mazgch 31:a0bed6c1e05d 164 */
mazgch 31:a0bed6c1e05d 165 int socketRecvFrom(int socket, char* buf, int len, IP* ip);
mazgch 31:a0bed6c1e05d 166
mazgch 31:a0bed6c1e05d 167 /** Close a connectied socket (that was connected with #socketConnect)
mazgch 31:a0bed6c1e05d 168 \param socket the socket handle
mazgch 31:a0bed6c1e05d 169 \return true if successfully, false otherwise
mazgch 31:a0bed6c1e05d 170 */
mazgch 31:a0bed6c1e05d 171 bool socketClose(int socket);
mazgch 31:a0bed6c1e05d 172
mazgch 31:a0bed6c1e05d 173 /** Free the socket (that was allocated before by #socketSocket)
mazgch 31:a0bed6c1e05d 174 \param socket the socket handle
mazgch 31:a0bed6c1e05d 175 \return true if successfully, false otherwise
mazgch 31:a0bed6c1e05d 176 */
mazgch 31:a0bed6c1e05d 177 bool socketFree(int socket);
mazgch 31:a0bed6c1e05d 178
mazgch 31:a0bed6c1e05d 179 // ----------------------------------------------------------------
mazgch 31:a0bed6c1e05d 180 // SMS Short Message Service
mazgch 31:a0bed6c1e05d 181 // ----------------------------------------------------------------
mazgch 31:a0bed6c1e05d 182
mazgch 31:a0bed6c1e05d 183 /** count the number of sms in the device and optionally return a
mazgch 31:a0bed6c1e05d 184 list with indexes from the storage locations in the device.
mazgch 31:a0bed6c1e05d 185 \param stat what type of messages you can use use
mazgch 31:a0bed6c1e05d 186 "REC UNREAD", "REC READ", "STO UNSENT", "STO SENT", "ALL"
mazgch 31:a0bed6c1e05d 187 \param ix list where to save the storage positions
mazgch 31:a0bed6c1e05d 188 \param num number of elements in the list
mazgch 31:a0bed6c1e05d 189 \return the number of messages, this can be bigger than num, -1 on failure
mazgch 31:a0bed6c1e05d 190 */
mazgch 31:a0bed6c1e05d 191 int smsList(const char* stat = "ALL", int* ix = NULL, int num = 0);
mazgch 31:a0bed6c1e05d 192
mazgch 31:a0bed6c1e05d 193 /** Read a Message from a storage position
mazgch 31:a0bed6c1e05d 194 \param ix the storage position to read
mazgch 31:a0bed6c1e05d 195 \param num the originator address (~16 chars)
mazgch 31:a0bed6c1e05d 196 \param buf a buffer where to save the sm
mazgch 31:a0bed6c1e05d 197 \param len the length of the sm
mazgch 31:a0bed6c1e05d 198 \return true if successful, false otherwise
mazgch 31:a0bed6c1e05d 199 */
mazgch 31:a0bed6c1e05d 200 bool smsRead(int ix, char* num, char* buf, int len);
mazgch 31:a0bed6c1e05d 201
mazgch 31:a0bed6c1e05d 202 /** Send a message to a recipient
mazgch 31:a0bed6c1e05d 203 \param ix the storage position to delete
mazgch 31:a0bed6c1e05d 204 \return true if successful, false otherwise
mazgch 31:a0bed6c1e05d 205 */
mazgch 31:a0bed6c1e05d 206 bool smsDelete(int ix);
mazgch 31:a0bed6c1e05d 207
mazgch 31:a0bed6c1e05d 208 /** Send a message to a recipient
mazgch 31:a0bed6c1e05d 209 \param num the phone number of the recipient
mazgch 31:a0bed6c1e05d 210 \param buf the content of the message to sent
mazgch 31:a0bed6c1e05d 211 \return true if successful, false otherwise
mazgch 31:a0bed6c1e05d 212 */
mazgch 31:a0bed6c1e05d 213 bool smsSend(const char* num, const char* buf);
mazgch 31:a0bed6c1e05d 214
mazgch 31:a0bed6c1e05d 215 // ----------------------------------------------------------------
mazgch 31:a0bed6c1e05d 216 // USSD Unstructured Supplementary Service Data
mazgch 31:a0bed6c1e05d 217 // ----------------------------------------------------------------
mazgch 31:a0bed6c1e05d 218
mazgch 31:a0bed6c1e05d 219 /** Read a Message from a storage position
mazgch 31:a0bed6c1e05d 220 \param cmd the ussd command to send e.g "*#06#"
mazgch 31:a0bed6c1e05d 221 \param buf a buffer where to save the reply
mazgch 31:a0bed6c1e05d 222 \return true if successful, false otherwise
mazgch 31:a0bed6c1e05d 223 */
mazgch 31:a0bed6c1e05d 224 bool ussdCommand(const char* cmd, char* buf);
mazgch 31:a0bed6c1e05d 225
mazgch 31:a0bed6c1e05d 226 // ----------------------------------------------------------------
mazgch 31:a0bed6c1e05d 227 // Parseing
mazgch 31:a0bed6c1e05d 228 // ----------------------------------------------------------------
mazgch 31:a0bed6c1e05d 229
mazgch 31:a0bed6c1e05d 230 // waitFinalResp Responses
mazgch 21:c4d64830bf02 231 #define NOT_FOUND 0
mazgch 21:c4d64830bf02 232 #define WAIT -1 // TIMEOUT
mazgch 21:c4d64830bf02 233 #define OK -2
mazgch 21:c4d64830bf02 234 #define ERROR -3
mazgch 21:c4d64830bf02 235 #define PROMPT -4
mazgch 31:a0bed6c1e05d 236
mazgch 21:c4d64830bf02 237 // getLine Responses
mazgch 21:c4d64830bf02 238 #define LENGTH(x) (x & 0x00FFFF)
mazgch 21:c4d64830bf02 239 #define TYPE(x) (x & 0xFF0000)
mazgch 21:c4d64830bf02 240 #define TYPE_UNKNOWN 0x000000
mazgch 21:c4d64830bf02 241 #define TYPE_OK 0x110000
mazgch 21:c4d64830bf02 242 #define TYPE_ERROR 0x120000
mazgch 21:c4d64830bf02 243 #define TYPE_RING 0x210000
mazgch 21:c4d64830bf02 244 #define TYPE_CONNECT 0x220000
mazgch 21:c4d64830bf02 245 #define TYPE_NOCARRIER 0x230000
mazgch 21:c4d64830bf02 246 #define TYPE_NODIALTONE 0x240000
mazgch 21:c4d64830bf02 247 #define TYPE_BUSY 0x250000
mazgch 21:c4d64830bf02 248 #define TYPE_NOANSWER 0x260000
mazgch 21:c4d64830bf02 249 #define TYPE_PROMPT 0x300000
mazgch 21:c4d64830bf02 250 #define TYPE_PLUS 0x400000
mazgch 31:a0bed6c1e05d 251
mazgch 31:a0bed6c1e05d 252 /** Get a line from the physical interface. This function need
mazgch 31:a0bed6c1e05d 253 to be implemented in a inherited class. Usually just calls
mazgch 31:a0bed6c1e05d 254 #_getLine on the rx buffer pipe.
mazgch 31:a0bed6c1e05d 255
mazgch 31:a0bed6c1e05d 256 \param buf the buffer to store it
mazgch 31:a0bed6c1e05d 257 \param buf size of the buffer
mazgch 31:a0bed6c1e05d 258 \return type and length if something was found,
mazgch 31:a0bed6c1e05d 259 WAIT if not enough data is available
mazgch 31:a0bed6c1e05d 260 NOT_FOUND if nothing was found
mazgch 31:a0bed6c1e05d 261 */
mazgch 31:a0bed6c1e05d 262 virtual int getLine(char* buf, int len) = 0;
mazgch 28:4d9509e3b1cf 263
mazgch 31:a0bed6c1e05d 264 /** Write data to the device
mazgch 31:a0bed6c1e05d 265 \param buf the buffer to write
mazgch 31:a0bed6c1e05d 266 \param buf size of the buffer to write
mazgch 31:a0bed6c1e05d 267 \return bytes written
mazgch 31:a0bed6c1e05d 268 */
mazgch 31:a0bed6c1e05d 269 virtual int send(const char* buf, int len);
mazgch 21:c4d64830bf02 270
mazgch 31:a0bed6c1e05d 271 /** Write formated date to the physical interface (printf style)
mazgch 31:a0bed6c1e05d 272 \param fmt the format string
mazgch 31:a0bed6c1e05d 273 \param .. variable arguments to be formated
mazgch 31:a0bed6c1e05d 274 \return bytes written
mazgch 31:a0bed6c1e05d 275 */
mazgch 21:c4d64830bf02 276 int sendFormated(const char* format, ...);
mazgch 26:07be5faf8925 277
mazgch 31:a0bed6c1e05d 278 /** callback function for #waitFinalResp with void* as argument
mazgch 31:a0bed6c1e05d 279 \param type the #getLine response
mazgch 31:a0bed6c1e05d 280 \param buf the parsed line
mazgch 31:a0bed6c1e05d 281 \param len the size of the parsed line
mazgch 31:a0bed6c1e05d 282 \param param the optional argument passed to #waitFinalResp
mazgch 31:a0bed6c1e05d 283 \return WAIT if processing should continue,
mazgch 31:a0bed6c1e05d 284 any other value aborts #waitFinalResp and this retunr value retuned
mazgch 31:a0bed6c1e05d 285 */
mazgch 26:07be5faf8925 286 typedef int (*_CALLBACKPTR)(int type, const char* buf, int len, void* param);
mazgch 31:a0bed6c1e05d 287
mazgch 31:a0bed6c1e05d 288 /** Wait for a final respons
mazgch 31:a0bed6c1e05d 289 \param cb the optional callback function
mazgch 31:a0bed6c1e05d 290 \param param the optional callback function parameter
mazgch 31:a0bed6c1e05d 291 \param timeout_ms the timeout to wait
mazgch 31:a0bed6c1e05d 292 */
mazgch 31:a0bed6c1e05d 293 int waitFinalResp(_CALLBACKPTR cb = NULL,
mazgch 26:07be5faf8925 294 void* param = NULL,
mazgch 26:07be5faf8925 295 int timeout_ms = 5000);
mazgch 31:a0bed6c1e05d 296
mazgch 31:a0bed6c1e05d 297 /** template version of #waitFinalResp when using callbacks,
mazgch 31:a0bed6c1e05d 298 This template will allow the compiler to do type cheking but
mazgch 31:a0bed6c1e05d 299 internally symply casts the arguments and call the (void*)
mazgch 31:a0bed6c1e05d 300 version of #waitFinalResp.
mazgch 31:a0bed6c1e05d 301 \sa waitFinalResp
mazgch 31:a0bed6c1e05d 302 */
mazgch 26:07be5faf8925 303 template<class T>
mazgch 26:07be5faf8925 304 int waitFinalResp(int (*cb)(int type, const char* buf, int len,
mazgch 26:07be5faf8925 305 T* param),
mazgch 26:07be5faf8925 306 T* param, int timeout_ms = 5000)
mazgch 26:07be5faf8925 307 {
mazgch 26:07be5faf8925 308 return waitFinalResp((_CALLBACKPTR)cb, (void*)param, timeout_ms);
mazgch 26:07be5faf8925 309 }
mazgch 31:a0bed6c1e05d 310
mazgch 18:e5697801df29 311 protected:
mazgch 31:a0bed6c1e05d 312 /** Write bytes to the physical interface. This function should be
mazgch 31:a0bed6c1e05d 313 implemented in a inherited class.
mazgch 31:a0bed6c1e05d 314 \param buf the buffer to write
mazgch 31:a0bed6c1e05d 315 \param buf size of the buffer to write
mazgch 31:a0bed6c1e05d 316 \return bytes written
mazgch 31:a0bed6c1e05d 317 */
mazgch 18:e5697801df29 318 virtual int _send(const void* buf, int len) = 0;
mazgch 31:a0bed6c1e05d 319
mazgch 31:a0bed6c1e05d 320 /** Helper: Parse a line from the receiving buffered pipe
mazgch 31:a0bed6c1e05d 321 \param pipe the receiving buffer pipe
mazgch 31:a0bed6c1e05d 322 \param buf the parsed line
mazgch 31:a0bed6c1e05d 323 \param len the size of the parsed line
mazgch 31:a0bed6c1e05d 324 \return type and length if something was found,
mazgch 31:a0bed6c1e05d 325 WAIT if not enough data is available
mazgch 31:a0bed6c1e05d 326 NOT_FOUND if nothing was found
mazgch 31:a0bed6c1e05d 327 */
mazgch 31:a0bed6c1e05d 328 static int _getLine(Pipe<char>* pipe, char* buffer, int length);
mazgch 31:a0bed6c1e05d 329
mazgch 31:a0bed6c1e05d 330 /** Helper: Parse a match from the pipe
mazgch 31:a0bed6c1e05d 331 \param pipe the buffered pipe
mazgch 31:a0bed6c1e05d 332 \param number of bytes to parse at maximum,
mazgch 31:a0bed6c1e05d 333 \param sta the starting string, NULL if none
mazgch 31:a0bed6c1e05d 334 \param end the terminating string, NULL if none
mazgch 31:a0bed6c1e05d 335 \return size of parsed match
mazgch 31:a0bed6c1e05d 336 */
mazgch 31:a0bed6c1e05d 337 static int _parseMatch(Pipe<char>* pipe, int len, const char* sta, const char* end);
mazgch 31:a0bed6c1e05d 338
mazgch 31:a0bed6c1e05d 339 /** Helper: Parse a match from the pipe
mazgch 31:a0bed6c1e05d 340 \param pipe the buffered pipe
mazgch 31:a0bed6c1e05d 341 \param number of bytes to parse at maximum,
mazgch 31:a0bed6c1e05d 342 \param fmt the formating string (%d any number, %c any char of last %d len)
mazgch 31:a0bed6c1e05d 343 \return size of parsed match
mazgch 31:a0bed6c1e05d 344 */
mazgch 31:a0bed6c1e05d 345 static int _parseFormated(Pipe<char>* pipe, int len, const char* fmt);
mazgch 31:a0bed6c1e05d 346
mazgch 21:c4d64830bf02 347 private:
mazgch 31:a0bed6c1e05d 348 // parsing callbacks for different AT commands and their parameter arguments
mazgch 31:a0bed6c1e05d 349 static int _cbString(int type, const char* buf, int len, char* str);
mazgch 31:a0bed6c1e05d 350 static int _cbInt(int type, const char* buf, int len, int* val);
mazgch 31:a0bed6c1e05d 351 // device
mazgch 21:c4d64830bf02 352 static int _cbATI(int type, const char* buf, int len, Model* model);
mazgch 31:a0bed6c1e05d 353 static int _cbCPIN(int type, const char* buf, int len, Sim* sim);
mazgch 31:a0bed6c1e05d 354 static int _cbCCID(int type, const char* buf, int len, char* ccid);
mazgch 31:a0bed6c1e05d 355 // network
mazgch 31:a0bed6c1e05d 356 static int _cbCSQ(int type, const char* buf, int len, int* rssi);
mazgch 31:a0bed6c1e05d 357 static int _cbCOPS(int type, const char* buf, int len, NetStatus* status);
mazgch 31:a0bed6c1e05d 358 static int _cbCNUM(int type, const char* buf, int len, char* num);
mazgch 31:a0bed6c1e05d 359 static int _cbCGATT(int type, const char* buf, int len, int* state);
mazgch 31:a0bed6c1e05d 360 // sockets
mazgch 31:a0bed6c1e05d 361 static int _cbUPSND(int type, const char* buf, int len, int* act);
mazgch 31:a0bed6c1e05d 362 static int _cbUPSND(int type, const char* buf, int len, IP* ip);
mazgch 21:c4d64830bf02 363 static int _cbUDNSRN(int type, const char* buf, int len, IP* ip);
mazgch 21:c4d64830bf02 364 static int _cbUSOCR(int type, const char* buf, int len, int* socket);
mazgch 21:c4d64830bf02 365 static int _cbUSORD(int type, const char* buf, int len, char* out);
mazgch 21:c4d64830bf02 366 typedef struct { char* buf; IP ip; int port; } USORFparam;
mazgch 21:c4d64830bf02 367 static int _cbUSORF(int type, const char* buf, int len, USORFparam* param);
mazgch 21:c4d64830bf02 368 typedef struct { char* buf; char* num; } CMGRparam;
mazgch 21:c4d64830bf02 369 static int _cbCUSD(int type, const char* buf, int len, char* buf);
mazgch 31:a0bed6c1e05d 370 // sms
mazgch 31:a0bed6c1e05d 371 typedef struct { int* ix; int num; } CMGLparam;
mazgch 31:a0bed6c1e05d 372 static int _cbCMGL(int type, const char* buf, int len, CMGLparam* param);
mazgch 21:c4d64830bf02 373 static int _cbCMGR(int type, const char* buf, int len, CMGRparam* param);
mazgch 31:a0bed6c1e05d 374 //
mazgch 31:a0bed6c1e05d 375 DevStatus _dev; //!< collected device information
mazgch 31:a0bed6c1e05d 376 NetStatus _net; //!< collected network information
mazgch 31:a0bed6c1e05d 377 IP _ip; //!< assigned ip address
mazgch 31:a0bed6c1e05d 378 // management struture for sockets
mazgch 21:c4d64830bf02 379 typedef enum { SOCK_FREE, SOCK_CREATED, SOCK_CONNECTED } SockState;
mazgch 21:c4d64830bf02 380 typedef struct { SockState state; int pending; } SockCtrl;
mazgch 21:c4d64830bf02 381 SockCtrl _sockets[16];
mazgch 18:e5697801df29 382 };
mazgch 18:e5697801df29 383
mazgch 18:e5697801df29 384 // -----------------------------------------------------------------------
mazgch 18:e5697801df29 385
mazgch 18:e5697801df29 386 class MDMSerial : public SerialPipe, public MDMParser
mazgch 17:296d94a006b4 387 {
mazgch 17:296d94a006b4 388 public:
mazgch 19:2b5d097ca15d 389 MDMSerial(PinName tx _C027DEFAULT(MDMTXD),
mazgch 19:2b5d097ca15d 390 PinName rx _C027DEFAULT(MDMRXD),
mazgch 19:2b5d097ca15d 391 int baudrate _C027DEFAULT(MDMBAUD),
mazgch 19:2b5d097ca15d 392 #if DEVICE_SERIAL_FC
mazgch 19:2b5d097ca15d 393 PinName rts _C027DEFAULT(MDMRTS),
mazgch 19:2b5d097ca15d 394 PinName cts _C027DEFAULT(MDMCTS),
mazgch 19:2b5d097ca15d 395 #endif
mazgch 19:2b5d097ca15d 396 int rxSize = 256 ,
mazgch 21:c4d64830bf02 397 int txSize = 128 );
mazgch 18:e5697801df29 398 virtual int getLine(char* buffer, int length);
mazgch 18:e5697801df29 399 protected:
mazgch 18:e5697801df29 400 virtual int _send(const void* buf, int len);
mazgch 17:296d94a006b4 401 };
mazgch 18:e5697801df29 402
mazgch 18:e5697801df29 403 // -----------------------------------------------------------------------
mazgch 18:e5697801df29 404
mazgch 18:e5697801df29 405 #define HAVE_MDMUSB
mazgch 18:e5697801df29 406 #ifdef HAVE_MDMUSB
mazgch 18:e5697801df29 407 class MDMUsb : /*public UsbSerial,*/ public MDMParser
mazgch 18:e5697801df29 408 {
mazgch 18:e5697801df29 409 public:
mazgch 18:e5697801df29 410 MDMUsb(void);
mazgch 18:e5697801df29 411 virtual int getLine(char* buffer, int length);
mazgch 18:e5697801df29 412 protected:
mazgch 18:e5697801df29 413 virtual int _send(const void* buf, int len);
mazgch 18:e5697801df29 414 };
mazgch 18:e5697801df29 415 #endif
mazgch 18:e5697801df29 416
mazgch 18:e5697801df29 417