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@34:3b3b7807c0c3, 2014-04-09 (annotated)

Committer:
mazgch
Date:
Wed Apr 09 14:25:41 2014 +0000
Revision:
34:3b3b7807c0c3
Parent:
33:fb8fb5021b09
Child:
35:9275215a3a5b
fixing buffer sizes

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