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@73:2b32e0a21df2, 2014-05-15 (annotated)

Committer:
mazgch
Date:
Thu May 15 08:25:45 2014 +0000
Revision:
73:2b32e0a21df2
Parent:
72:d1e943ad6558
Child:
74:208e3e32d263
more flexible dump functions

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 38:e6cab4632d84 18 /** basic modem parser class
mazgch 38:e6cab4632d84 19 */
mazgch 18:e5697801df29 20 class MDMParser
mazgch 18:e5697801df29 21 {
mazgch 18:e5697801df29 22 public:
mazgch 31:a0bed6c1e05d 23 //! Constructor
mazgch 35:9275215a3a5b 24 MDMParser();
mazgch 44:9d12223b78ff 25 //! get static instance
mazgch 44:9d12223b78ff 26 static MDMParser* getInstance() { return inst; };
mazgch 31:a0bed6c1e05d 27
mazgch 31:a0bed6c1e05d 28 // ----------------------------------------------------------------
mazgch 31:a0bed6c1e05d 29 // Types
mazgch 31:a0bed6c1e05d 30 // ----------------------------------------------------------------
mazgch 38:e6cab4632d84 31 //! MT Device Types
mazgch 38:e6cab4632d84 32 typedef enum { DEV_UNKNOWN, DEV_SARA_G350, DEV_LISA_U200, DEV_LISA_C200 } Dev;
mazgch 38:e6cab4632d84 33 //! SIM Status
mazgch 38:e6cab4632d84 34 typedef enum { SIM_UNKNOWN, SIM_PIN, SIM_READY } Sim;
mazgch 38:e6cab4632d84 35 //! SIM Status
mazgch 38:e6cab4632d84 36 typedef enum { LPM_DISABLED, LPM_ENABLED, LPM_ACTIVE, LPM_SLEEP } Lpm;
mazgch 38:e6cab4632d84 37 //! Device status
mazgch 33:fb8fb5021b09 38 typedef struct {
mazgch 34:3b3b7807c0c3 39 Dev dev; //!< Device Type
mazgch 35:9275215a3a5b 40 Lpm lpm; //!< Power Saving
mazgch 34:3b3b7807c0c3 41 Sim sim; //!< SIM Card Status
mazgch 34:3b3b7807c0c3 42 char ccid[20+1]; //!< Integrated Circuit Card ID
mazgch 34:3b3b7807c0c3 43 char imsi[15+1]; //!< International Mobile Station Identity
mazgch 34:3b3b7807c0c3 44 char imei[15+1]; //!< International Mobile Equipment Identity
mazgch 34:3b3b7807c0c3 45 char meid[18+1]; //!< Mobile Equipment IDentifier
mazgch 34:3b3b7807c0c3 46 char manu[16]; //!< Manufacturer (u-blox)
mazgch 34:3b3b7807c0c3 47 char model[16]; //!< Model Name (LISA-U200, LISA-C200 or SARA-G350)
mazgch 34:3b3b7807c0c3 48 char ver[16]; //!< Software Version
mazgch 38:e6cab4632d84 49 } DevStatus;
mazgch 38:e6cab4632d84 50 //! Registration Status
mazgch 38:e6cab4632d84 51 typedef enum { REG_UNKNOWN, REG_DENIED, REG_NONE, REG_HOME, REG_ROAMING } Reg;
mazgch 38:e6cab4632d84 52 //! Access Technology
mazgch 38:e6cab4632d84 53 typedef enum { ACT_UNKNOWN, ACT_GSM, ACT_EDGE, ACT_UTRAN, ACT_CDMA } AcT;
mazgch 72:d1e943ad6558 54 //! Gprs Attach Status
mazgch 72:d1e943ad6558 55 typedef enum { GPRS_UNKNOWN, GPRS_DETACHED, GPRS_ATTACHED } Gprs;
mazgch 38:e6cab4632d84 56 //! Network Status
mazgch 33:fb8fb5021b09 57 typedef struct {
mazgch 34:3b3b7807c0c3 58 Reg reg; //!< Registration Status
mazgch 72:d1e943ad6558 59 Gprs gprs; //!< Gprs Attach status
mazgch 34:3b3b7807c0c3 60 AcT act; //!< Access Technology
mazgch 34:3b3b7807c0c3 61 int rssi; //!< Received Signal Strength Indication (in dBm, range -113..-53)
mazgch 54:7ba8e4c218e2 62 int ber; //!< Bit Error Rate (BER), see 3GPP TS 45.008 [20] subclause 8.2.4
mazgch 34:3b3b7807c0c3 63 char opr[16+1]; //!< Operator Name
mazgch 34:3b3b7807c0c3 64 char num[32]; //!< Mobile Directory Number
mazgch 54:7ba8e4c218e2 65 unsigned short lac; //!< location area code in hexadecimal format (2 bytes in hex)
mazgch 54:7ba8e4c218e2 66 unsigned int ci; //!< Cell ID in hexadecimal format (2 to 4 bytes in hex)
mazgch 38:e6cab4632d84 67 } NetStatus;
mazgch 38:e6cab4632d84 68 //! An IP v4 address
mazgch 38:e6cab4632d84 69 typedef uint32_t IP;
mazgch 33:fb8fb5021b09 70 #define NOIP ((MDMParser::IP)0) //!< No IP address
mazgch 31:a0bed6c1e05d 71 // ip number formating and conversion
mazgch 31:a0bed6c1e05d 72 #define IPSTR "%d.%d.%d.%d"
mazgch 31:a0bed6c1e05d 73 #define IPNUM(ip) ((ip)>>24)&0xff, \
mazgch 31:a0bed6c1e05d 74 ((ip)>>16)&0xff, \
mazgch 31:a0bed6c1e05d 75 ((ip)>> 8)&0xff, \
mazgch 31:a0bed6c1e05d 76 ((ip)>> 0)&0xff
mazgch 31:a0bed6c1e05d 77 #define IPADR(a,b,c,d) ((((IP)(a))<<24) | \
mazgch 31:a0bed6c1e05d 78 (((IP)(b))<<16) | \
mazgch 31:a0bed6c1e05d 79 (((IP)(c))<< 8) | \
mazgch 31:a0bed6c1e05d 80 (((IP)(d))<< 0))
mazgch 31:a0bed6c1e05d 81
mazgch 31:a0bed6c1e05d 82
mazgch 31:a0bed6c1e05d 83 // ----------------------------------------------------------------
mazgch 57:869bd35f44cc 84 // Device
mazgch 31:a0bed6c1e05d 85 // ----------------------------------------------------------------
mazgch 31:a0bed6c1e05d 86
mazgch 57:869bd35f44cc 87 /** Combined Init, checkNetStatus, join suitable for simple applications
mazgch 57:869bd35f44cc 88 \param simpin a optional pin of the SIM card
mazgch 57:869bd35f44cc 89 \param apn the of the network provider e.g. "internet" or "apn.provider.com"
mazgch 57:869bd35f44cc 90 \param username is the user name text string for the authentication phase
mazgch 57:869bd35f44cc 91 \param password is the password text string for the authentication phase
mazgch 57:869bd35f44cc 92 \param dump set to true if you like to dump the status if successful
mazgch 57:869bd35f44cc 93 \return true if successful, false otherwise
mazgch 57:869bd35f44cc 94 */
mazgch 57:869bd35f44cc 95 bool connect(const char* simpin,
mazgch 57:869bd35f44cc 96 const char* apn, const char* username, const char* password,
mazgch 57:869bd35f44cc 97 bool dump);
mazgch 57:869bd35f44cc 98
mazgch 31:a0bed6c1e05d 99 /** register (Attach) the MT to the GPRS service.
mazgch 57:869bd35f44cc 100 \param simpin a optional pin of the SIM card
mazgch 31:a0bed6c1e05d 101 \param status an optional struture to with device information
mazgch 31:a0bed6c1e05d 102 \return true if successful, false otherwise
mazgch 31:a0bed6c1e05d 103 */
mazgch 57:869bd35f44cc 104 bool init(const char* simpin = NULL, DevStatus* status = NULL);
mazgch 31:a0bed6c1e05d 105
mazgch 31:a0bed6c1e05d 106 /** check if the network is available
mazgch 31:a0bed6c1e05d 107 \param status an optional structure to with network information
mazgch 31:a0bed6c1e05d 108 \return true if successful and connected to network, false otherwise
mazgch 31:a0bed6c1e05d 109 */
mazgch 31:a0bed6c1e05d 110 bool checkNetStatus(NetStatus* status = NULL);
mazgch 31:a0bed6c1e05d 111
mazgch 31:a0bed6c1e05d 112 /** Power off the MT, This function has to be called prior to
mazgch 31:a0bed6c1e05d 113 switching off the supply.
mazgch 31:a0bed6c1e05d 114 \return true if successfully, false otherwise
mazgch 31:a0bed6c1e05d 115 */
mazgch 31:a0bed6c1e05d 116 bool powerOff(void);
mazgch 31:a0bed6c1e05d 117
mazgch 31:a0bed6c1e05d 118 // ----------------------------------------------------------------
mazgch 31:a0bed6c1e05d 119 // Data Connection (GPRS)
mazgch 31:a0bed6c1e05d 120 // ----------------------------------------------------------------
mazgch 31:a0bed6c1e05d 121
mazgch 31:a0bed6c1e05d 122 /** register (Attach) the MT to the GPRS service.
mazgch 31:a0bed6c1e05d 123 \param apn the of the network provider e.g. "internet" or "apn.provider.com"
mazgch 57:869bd35f44cc 124 \param username is the user name text string for the authentication phase
mazgch 31:a0bed6c1e05d 125 \param password is the password text string for the authentication phase
mazgch 57:869bd35f44cc 126 \param dump set to true if you like to dump the status if successful
mazgch 31:a0bed6c1e05d 127 \return the ip that is assigned
mazgch 31:a0bed6c1e05d 128 */
mazgch 57:869bd35f44cc 129 MDMParser::IP join(const char* apn = NULL, const char* username = NULL, const char* password = NULL);
mazgch 31:a0bed6c1e05d 130
mazgch 31:a0bed6c1e05d 131 /** deregister (detach) the MT from the GPRS service.
mazgch 31:a0bed6c1e05d 132 \return true if successful, false otherwise
mazgch 31:a0bed6c1e05d 133 */
mazgch 31:a0bed6c1e05d 134 bool disconnect(void);
mazgch 31:a0bed6c1e05d 135
mazgch 31:a0bed6c1e05d 136 /** Translates a domain name to an IP address
mazgch 31:a0bed6c1e05d 137 \param host the domain name to translate e.g. "u-blox.com"
mazgch 31:a0bed6c1e05d 138 \return the IP if successful, 0 otherwise
mazgch 31:a0bed6c1e05d 139 */
mazgch 31:a0bed6c1e05d 140 MDMParser::IP gethostbyname(const char* host);
mazgch 31:a0bed6c1e05d 141
mazgch 31:a0bed6c1e05d 142 // ----------------------------------------------------------------
mazgch 31:a0bed6c1e05d 143 // Sockets
mazgch 31:a0bed6c1e05d 144 // ----------------------------------------------------------------
mazgch 31:a0bed6c1e05d 145
mazgch 31:a0bed6c1e05d 146 //! Type of IP protocol
mazgch 31:a0bed6c1e05d 147 typedef enum { IPPROTO_TCP, IPPROTO_UDP } IpProtocol;
mazgch 31:a0bed6c1e05d 148
mazgch 31:a0bed6c1e05d 149 //! Socket error return codes
mazgch 31:a0bed6c1e05d 150 #define SOCKET_ERROR -1
mazgch 31:a0bed6c1e05d 151
mazgch 63:42cb563a25bc 152 /** Create a socket for a ip protocol (and optionaly bind)
mazgch 31:a0bed6c1e05d 153 \param ipproto the protocol (UDP or TCP)
mazgch 63:42cb563a25bc 154 \param port in case of UDP, this optional port where it is bind
mazgch 31:a0bed6c1e05d 155 \return the socket handle if successful or SOCKET_ERROR on failure
mazgch 31:a0bed6c1e05d 156 */
mazgch 63:42cb563a25bc 157 int socketSocket(IpProtocol ipproto, int port = -1);
mazgch 31:a0bed6c1e05d 158
mazgch 31:a0bed6c1e05d 159 /** make a socket connection
mazgch 31:a0bed6c1e05d 160 \param socket the socket handle
mazgch 31:a0bed6c1e05d 161 \param host the domain name to connect e.g. "u-blox.com"
mazgch 31:a0bed6c1e05d 162 \param port the port to connect
mazgch 31:a0bed6c1e05d 163 \return true if successfully, false otherwise
mazgch 31:a0bed6c1e05d 164 */
mazgch 31:a0bed6c1e05d 165 bool socketConnect(int socket, const char* host, int port);
mazgch 31:a0bed6c1e05d 166
mazgch 44:9d12223b78ff 167 /** make a socket connection
mazgch 44:9d12223b78ff 168 \param socket the socket handle
mazgch 44:9d12223b78ff 169 \return true if connected, false otherwise
mazgch 44:9d12223b78ff 170 */
mazgch 44:9d12223b78ff 171 bool socketIsConnected(int socket);
mazgch 44:9d12223b78ff 172
mazgch 44:9d12223b78ff 173 /** Get the number of bytes pending for reading for this socket
mazgch 44:9d12223b78ff 174 \param socket the socket handle
mazgch 44:9d12223b78ff 175 \param timeout_ms -1 blocking, else non blocking timeout in ms
mazgch 44:9d12223b78ff 176 \return 0 if successful or SOCKET_ERROR on failure
mazgch 44:9d12223b78ff 177 */
mazgch 66:69072b3c5bca 178 bool socketSetBlocking(int socket, int timeout_ms);
mazgch 44:9d12223b78ff 179
mazgch 31:a0bed6c1e05d 180 /** Write socket data
mazgch 31:a0bed6c1e05d 181 \param socket the socket handle
mazgch 31:a0bed6c1e05d 182 \param buf the buffer to write
mazgch 31:a0bed6c1e05d 183 \param len the size of the buffer to write
mazgch 31:a0bed6c1e05d 184 \return the size written or SOCKET_ERROR on failure
mazgch 31:a0bed6c1e05d 185 */
mazgch 31:a0bed6c1e05d 186 int socketSend(int socket, const char * buf, int len);
mazgch 31:a0bed6c1e05d 187
mazgch 31:a0bed6c1e05d 188 /** Write socket data to a IP
mazgch 31:a0bed6c1e05d 189 \param socket the socket handle
mazgch 31:a0bed6c1e05d 190 \param ip the ip to send to
mazgch 31:a0bed6c1e05d 191 \param port the port to send to
mazgch 31:a0bed6c1e05d 192 \param buf the buffer to write
mazgch 31:a0bed6c1e05d 193 \param len the size of the buffer to write
mazgch 31:a0bed6c1e05d 194 \return the size written or SOCKET_ERROR on failure
mazgch 31:a0bed6c1e05d 195 */
mazgch 31:a0bed6c1e05d 196 int socketSendTo(int socket, IP ip, int port, const char * buf, int len);
mazgch 31:a0bed6c1e05d 197
mazgch 31:a0bed6c1e05d 198 /** Get the number of bytes pending for reading for this socket
mazgch 31:a0bed6c1e05d 199 \param socket the socket handle
mazgch 31:a0bed6c1e05d 200 \return the number of bytes pending or SOCKET_ERROR on failure
mazgch 31:a0bed6c1e05d 201 */
mazgch 31:a0bed6c1e05d 202 int socketReadable(int socket);
mazgch 31:a0bed6c1e05d 203
mazgch 31:a0bed6c1e05d 204 /** Read this socket
mazgch 31:a0bed6c1e05d 205 \param socket the socket handle
mazgch 31:a0bed6c1e05d 206 \param buf the buffer to read into
mazgch 31:a0bed6c1e05d 207 \param len the size of the buffer to read into
mazgch 31:a0bed6c1e05d 208 \return the number of bytes read or SOCKET_ERROR on failure
mazgch 31:a0bed6c1e05d 209 */
mazgch 31:a0bed6c1e05d 210 int socketRecv(int socket, char* buf, int len);
mazgch 31:a0bed6c1e05d 211
mazgch 31:a0bed6c1e05d 212 /** Read from this socket
mazgch 31:a0bed6c1e05d 213 \param socket the socket handle
mazgch 63:42cb563a25bc 214 \param ip the ip of host where the data originates from
mazgch 63:42cb563a25bc 215 \param port the port where the data originates from
mazgch 31:a0bed6c1e05d 216 \param buf the buffer to read into
mazgch 31:a0bed6c1e05d 217 \param len the size of the buffer to read into
mazgch 31:a0bed6c1e05d 218 \return the number of bytes read or SOCKET_ERROR on failure
mazgch 31:a0bed6c1e05d 219 */
mazgch 63:42cb563a25bc 220 int socketRecvFrom(int socket, IP* ip, int* port, char* buf, int len);
mazgch 31:a0bed6c1e05d 221
mazgch 31:a0bed6c1e05d 222 /** Close a connectied socket (that was connected with #socketConnect)
mazgch 31:a0bed6c1e05d 223 \param socket the socket handle
mazgch 31:a0bed6c1e05d 224 \return true if successfully, false otherwise
mazgch 31:a0bed6c1e05d 225 */
mazgch 31:a0bed6c1e05d 226 bool socketClose(int socket);
mazgch 31:a0bed6c1e05d 227
mazgch 31:a0bed6c1e05d 228 /** Free the socket (that was allocated before by #socketSocket)
mazgch 31:a0bed6c1e05d 229 \param socket the socket handle
mazgch 31:a0bed6c1e05d 230 \return true if successfully, false otherwise
mazgch 31:a0bed6c1e05d 231 */
mazgch 31:a0bed6c1e05d 232 bool socketFree(int socket);
mazgch 31:a0bed6c1e05d 233
mazgch 31:a0bed6c1e05d 234 // ----------------------------------------------------------------
mazgch 31:a0bed6c1e05d 235 // SMS Short Message Service
mazgch 31:a0bed6c1e05d 236 // ----------------------------------------------------------------
mazgch 31:a0bed6c1e05d 237
mazgch 31:a0bed6c1e05d 238 /** count the number of sms in the device and optionally return a
mazgch 31:a0bed6c1e05d 239 list with indexes from the storage locations in the device.
mazgch 31:a0bed6c1e05d 240 \param stat what type of messages you can use use
mazgch 31:a0bed6c1e05d 241 "REC UNREAD", "REC READ", "STO UNSENT", "STO SENT", "ALL"
mazgch 31:a0bed6c1e05d 242 \param ix list where to save the storage positions
mazgch 31:a0bed6c1e05d 243 \param num number of elements in the list
mazgch 31:a0bed6c1e05d 244 \return the number of messages, this can be bigger than num, -1 on failure
mazgch 31:a0bed6c1e05d 245 */
mazgch 31:a0bed6c1e05d 246 int smsList(const char* stat = "ALL", int* ix = NULL, int num = 0);
mazgch 31:a0bed6c1e05d 247
mazgch 31:a0bed6c1e05d 248 /** Read a Message from a storage position
mazgch 31:a0bed6c1e05d 249 \param ix the storage position to read
mazgch 31:a0bed6c1e05d 250 \param num the originator address (~16 chars)
mazgch 31:a0bed6c1e05d 251 \param buf a buffer where to save the sm
mazgch 31:a0bed6c1e05d 252 \param len the length of the sm
mazgch 31:a0bed6c1e05d 253 \return true if successful, false otherwise
mazgch 31:a0bed6c1e05d 254 */
mazgch 31:a0bed6c1e05d 255 bool smsRead(int ix, char* num, char* buf, int len);
mazgch 31:a0bed6c1e05d 256
mazgch 31:a0bed6c1e05d 257 /** Send a message to a recipient
mazgch 31:a0bed6c1e05d 258 \param ix the storage position to delete
mazgch 31:a0bed6c1e05d 259 \return true if successful, false otherwise
mazgch 31:a0bed6c1e05d 260 */
mazgch 31:a0bed6c1e05d 261 bool smsDelete(int ix);
mazgch 31:a0bed6c1e05d 262
mazgch 31:a0bed6c1e05d 263 /** Send a message to a recipient
mazgch 31:a0bed6c1e05d 264 \param num the phone number of the recipient
mazgch 31:a0bed6c1e05d 265 \param buf the content of the message to sent
mazgch 31:a0bed6c1e05d 266 \return true if successful, false otherwise
mazgch 31:a0bed6c1e05d 267 */
mazgch 31:a0bed6c1e05d 268 bool smsSend(const char* num, const char* buf);
mazgch 31:a0bed6c1e05d 269
mazgch 31:a0bed6c1e05d 270 // ----------------------------------------------------------------
mazgch 31:a0bed6c1e05d 271 // USSD Unstructured Supplementary Service Data
mazgch 31:a0bed6c1e05d 272 // ----------------------------------------------------------------
mazgch 31:a0bed6c1e05d 273
mazgch 31:a0bed6c1e05d 274 /** Read a Message from a storage position
mazgch 31:a0bed6c1e05d 275 \param cmd the ussd command to send e.g "*#06#"
mazgch 31:a0bed6c1e05d 276 \param buf a buffer where to save the reply
mazgch 31:a0bed6c1e05d 277 \return true if successful, false otherwise
mazgch 31:a0bed6c1e05d 278 */
mazgch 31:a0bed6c1e05d 279 bool ussdCommand(const char* cmd, char* buf);
mazgch 31:a0bed6c1e05d 280
mazgch 38:e6cab4632d84 281 // ----------------------------------------------------------------
mazgch 54:7ba8e4c218e2 282 // DUMP status to standard out (printf)
mazgch 54:7ba8e4c218e2 283 // ----------------------------------------------------------------
mazgch 54:7ba8e4c218e2 284
mazgch 73:2b32e0a21df2 285 //! helper type for DPRINT
mazgch 73:2b32e0a21df2 286 typedef int (*_DPRINT)(void* param, char const * format, ...);
mazgch 73:2b32e0a21df2 287
mazgch 73:2b32e0a21df2 288 //! helper to declate templates and void versions
mazgch 73:2b32e0a21df2 289 #define _DUMP_TEMPLATE(func, type, arg) \
mazgch 73:2b32e0a21df2 290 template<class T> \
mazgch 73:2b32e0a21df2 291 inline void func(type arg, \
mazgch 73:2b32e0a21df2 292 int (*dprint)( T* param, char const * format, ...), \
mazgch 73:2b32e0a21df2 293 T* param) { func(arg, (_DPRINT)dprint, (void*)param); } \
mazgch 73:2b32e0a21df2 294 static void func(type arg, \
mazgch 73:2b32e0a21df2 295 _DPRINT dprint = (_DPRINT)fprintf, \
mazgch 73:2b32e0a21df2 296 void* param = (void*)stdout);
mazgch 73:2b32e0a21df2 297
mazgch 54:7ba8e4c218e2 298 /** dump the device status to stdout using printf
mazgch 54:7ba8e4c218e2 299 \param status the status to convert to textual form,
mazgch 54:7ba8e4c218e2 300 unavailable fields are ommited (not printed)
mazgch 73:2b32e0a21df2 301 \param dprint a function pointer
mazgch 73:2b32e0a21df2 302 \param param the irst argument passed to dprint
mazgch 54:7ba8e4c218e2 303 */
mazgch 73:2b32e0a21df2 304 _DUMP_TEMPLATE(dumpDevStatus, MDMParser::DevStatus*, status)
mazgch 54:7ba8e4c218e2 305
mazgch 54:7ba8e4c218e2 306 /** dump the network status to stdout using printf
mazgch 54:7ba8e4c218e2 307 \param status the status to convert to textual form,
mazgch 54:7ba8e4c218e2 308 unavailable fields are ommited (not printed)
mazgch 73:2b32e0a21df2 309 \param dprint a function pointer
mazgch 73:2b32e0a21df2 310 \param param the irst argument passed to dprint
mazgch 54:7ba8e4c218e2 311 */
mazgch 73:2b32e0a21df2 312 _DUMP_TEMPLATE(dumpNetStatus, MDMParser::NetStatus*, status)
mazgch 73:2b32e0a21df2 313
mazgch 54:7ba8e4c218e2 314 /** dump the ip address to stdout using printf
mazgch 54:7ba8e4c218e2 315 \param ip the ip to convert to textual form,
mazgch 54:7ba8e4c218e2 316 unavailable fields are ommited (not printed)
mazgch 73:2b32e0a21df2 317 \param dprint a function pointer
mazgch 73:2b32e0a21df2 318 \param param the irst argument passed to dprint
mazgch 54:7ba8e4c218e2 319 */
mazgch 73:2b32e0a21df2 320 _DUMP_TEMPLATE(dumpIp, MDMParser::IP, ip)
mazgch 73:2b32e0a21df2 321
mazgch 54:7ba8e4c218e2 322 // ----------------------------------------------------------------
mazgch 31:a0bed6c1e05d 323 // Parseing
mazgch 31:a0bed6c1e05d 324 // ----------------------------------------------------------------
mazgch 31:a0bed6c1e05d 325
mazgch 51:e7b81c31baec 326 enum {
mazgch 51:e7b81c31baec 327 // waitFinalResp Responses
mazgch 52:8071747a7cb3 328 NOT_FOUND = 0,
mazgch 52:8071747a7cb3 329 WAIT = -1, // TIMEOUT
mazgch 52:8071747a7cb3 330 RESP_OK = -2,
mazgch 52:8071747a7cb3 331 RESP_ERROR = -3,
mazgch 52:8071747a7cb3 332 RESP_PROMPT = -4,
mazgch 31:a0bed6c1e05d 333
mazgch 51:e7b81c31baec 334 // getLine Responses
mazgch 51:e7b81c31baec 335 #define LENGTH(x) (x & 0x00FFFF) //!< extract/mask the length
mazgch 51:e7b81c31baec 336 #define TYPE(x) (x & 0xFF0000) //!< extract/mask the type
mazgch 51:e7b81c31baec 337
mazgch 51:e7b81c31baec 338 TYPE_UNKNOWN = 0x000000,
mazgch 51:e7b81c31baec 339 TYPE_OK = 0x110000,
mazgch 51:e7b81c31baec 340 TYPE_ERROR = 0x120000,
mazgch 51:e7b81c31baec 341 TYPE_RING = 0x210000,
mazgch 51:e7b81c31baec 342 TYPE_CONNECT = 0x220000,
mazgch 51:e7b81c31baec 343 TYPE_NOCARRIER = 0x230000,
mazgch 51:e7b81c31baec 344 TYPE_NODIALTONE = 0x240000,
mazgch 51:e7b81c31baec 345 TYPE_BUSY = 0x250000,
mazgch 51:e7b81c31baec 346 TYPE_NOANSWER = 0x260000,
mazgch 51:e7b81c31baec 347 TYPE_PROMPT = 0x300000,
mazgch 51:e7b81c31baec 348 TYPE_PLUS = 0x400000,
mazgch 66:69072b3c5bca 349 TYPE_TEXT = 0x500000,
mazgch 66:69072b3c5bca 350
mazgch 66:69072b3c5bca 351 // special timout constant
mazgch 66:69072b3c5bca 352 TIMEOUT_BLOCKING = -1
mazgch 51:e7b81c31baec 353 };
mazgch 31:a0bed6c1e05d 354
mazgch 31:a0bed6c1e05d 355 /** Get a line from the physical interface. This function need
mazgch 31:a0bed6c1e05d 356 to be implemented in a inherited class. Usually just calls
mazgch 31:a0bed6c1e05d 357 #_getLine on the rx buffer pipe.
mazgch 31:a0bed6c1e05d 358
mazgch 31:a0bed6c1e05d 359 \param buf the buffer to store it
mazgch 31:a0bed6c1e05d 360 \param buf size of the buffer
mazgch 31:a0bed6c1e05d 361 \return type and length if something was found,
mazgch 31:a0bed6c1e05d 362 WAIT if not enough data is available
mazgch 31:a0bed6c1e05d 363 NOT_FOUND if nothing was found
mazgch 31:a0bed6c1e05d 364 */
mazgch 31:a0bed6c1e05d 365 virtual int getLine(char* buf, int len) = 0;
mazgch 28:4d9509e3b1cf 366
mazgch 31:a0bed6c1e05d 367 /** Write data to the device
mazgch 31:a0bed6c1e05d 368 \param buf the buffer to write
mazgch 31:a0bed6c1e05d 369 \param buf size of the buffer to write
mazgch 31:a0bed6c1e05d 370 \return bytes written
mazgch 31:a0bed6c1e05d 371 */
mazgch 31:a0bed6c1e05d 372 virtual int send(const char* buf, int len);
mazgch 21:c4d64830bf02 373
mazgch 31:a0bed6c1e05d 374 /** Write formated date to the physical interface (printf style)
mazgch 31:a0bed6c1e05d 375 \param fmt the format string
mazgch 31:a0bed6c1e05d 376 \param .. variable arguments to be formated
mazgch 31:a0bed6c1e05d 377 \return bytes written
mazgch 31:a0bed6c1e05d 378 */
mazgch 21:c4d64830bf02 379 int sendFormated(const char* format, ...);
mazgch 26:07be5faf8925 380
mazgch 31:a0bed6c1e05d 381 /** callback function for #waitFinalResp with void* as argument
mazgch 31:a0bed6c1e05d 382 \param type the #getLine response
mazgch 31:a0bed6c1e05d 383 \param buf the parsed line
mazgch 31:a0bed6c1e05d 384 \param len the size of the parsed line
mazgch 31:a0bed6c1e05d 385 \param param the optional argument passed to #waitFinalResp
mazgch 31:a0bed6c1e05d 386 \return WAIT if processing should continue,
mazgch 31:a0bed6c1e05d 387 any other value aborts #waitFinalResp and this retunr value retuned
mazgch 31:a0bed6c1e05d 388 */
mazgch 26:07be5faf8925 389 typedef int (*_CALLBACKPTR)(int type, const char* buf, int len, void* param);
mazgch 31:a0bed6c1e05d 390
mazgch 31:a0bed6c1e05d 391 /** Wait for a final respons
mazgch 31:a0bed6c1e05d 392 \param cb the optional callback function
mazgch 31:a0bed6c1e05d 393 \param param the optional callback function parameter
mazgch 58:e38a2e942fbb 394 \param timeout_ms the timeout to wait (See Estimated command
mazgch 58:e38a2e942fbb 395 response time of AT manual)
mazgch 31:a0bed6c1e05d 396 */
mazgch 31:a0bed6c1e05d 397 int waitFinalResp(_CALLBACKPTR cb = NULL,
mazgch 26:07be5faf8925 398 void* param = NULL,
mazgch 58:e38a2e942fbb 399 int timeout_ms = 10000);
mazgch 31:a0bed6c1e05d 400
mazgch 31:a0bed6c1e05d 401 /** template version of #waitFinalResp when using callbacks,
mazgch 31:a0bed6c1e05d 402 This template will allow the compiler to do type cheking but
mazgch 31:a0bed6c1e05d 403 internally symply casts the arguments and call the (void*)
mazgch 31:a0bed6c1e05d 404 version of #waitFinalResp.
mazgch 31:a0bed6c1e05d 405 \sa waitFinalResp
mazgch 31:a0bed6c1e05d 406 */
mazgch 26:07be5faf8925 407 template<class T>
mazgch 73:2b32e0a21df2 408 inline int waitFinalResp(int (*cb)(int type, const char* buf, int len, T* param),
mazgch 73:2b32e0a21df2 409 T* param,
mazgch 73:2b32e0a21df2 410 int timeout_ms = 10000)
mazgch 26:07be5faf8925 411 {
mazgch 26:07be5faf8925 412 return waitFinalResp((_CALLBACKPTR)cb, (void*)param, timeout_ms);
mazgch 26:07be5faf8925 413 }
mazgch 31:a0bed6c1e05d 414
mazgch 18:e5697801df29 415 protected:
mazgch 31:a0bed6c1e05d 416 /** Write bytes to the physical interface. This function should be
mazgch 31:a0bed6c1e05d 417 implemented in a inherited class.
mazgch 31:a0bed6c1e05d 418 \param buf the buffer to write
mazgch 31:a0bed6c1e05d 419 \param buf size of the buffer to write
mazgch 31:a0bed6c1e05d 420 \return bytes written
mazgch 31:a0bed6c1e05d 421 */
mazgch 18:e5697801df29 422 virtual int _send(const void* buf, int len) = 0;
mazgch 31:a0bed6c1e05d 423
mazgch 31:a0bed6c1e05d 424 /** Helper: Parse a line from the receiving buffered pipe
mazgch 31:a0bed6c1e05d 425 \param pipe the receiving buffer pipe
mazgch 31:a0bed6c1e05d 426 \param buf the parsed line
mazgch 31:a0bed6c1e05d 427 \param len the size of the parsed line
mazgch 31:a0bed6c1e05d 428 \return type and length if something was found,
mazgch 31:a0bed6c1e05d 429 WAIT if not enough data is available
mazgch 31:a0bed6c1e05d 430 NOT_FOUND if nothing was found
mazgch 31:a0bed6c1e05d 431 */
mazgch 31:a0bed6c1e05d 432 static int _getLine(Pipe<char>* pipe, char* buffer, int length);
mazgch 31:a0bed6c1e05d 433
mazgch 31:a0bed6c1e05d 434 /** Helper: Parse a match from the pipe
mazgch 31:a0bed6c1e05d 435 \param pipe the buffered pipe
mazgch 31:a0bed6c1e05d 436 \param number of bytes to parse at maximum,
mazgch 31:a0bed6c1e05d 437 \param sta the starting string, NULL if none
mazgch 31:a0bed6c1e05d 438 \param end the terminating string, NULL if none
mazgch 31:a0bed6c1e05d 439 \return size of parsed match
mazgch 31:a0bed6c1e05d 440 */
mazgch 31:a0bed6c1e05d 441 static int _parseMatch(Pipe<char>* pipe, int len, const char* sta, const char* end);
mazgch 31:a0bed6c1e05d 442
mazgch 31:a0bed6c1e05d 443 /** Helper: Parse a match from the pipe
mazgch 31:a0bed6c1e05d 444 \param pipe the buffered pipe
mazgch 31:a0bed6c1e05d 445 \param number of bytes to parse at maximum,
mazgch 31:a0bed6c1e05d 446 \param fmt the formating string (%d any number, %c any char of last %d len)
mazgch 31:a0bed6c1e05d 447 \return size of parsed match
mazgch 31:a0bed6c1e05d 448 */
mazgch 31:a0bed6c1e05d 449 static int _parseFormated(Pipe<char>* pipe, int len, const char* fmt);
mazgch 31:a0bed6c1e05d 450
mazgch 35:9275215a3a5b 451 protected:
mazgch 31:a0bed6c1e05d 452 // parsing callbacks for different AT commands and their parameter arguments
mazgch 31:a0bed6c1e05d 453 static int _cbString(int type, const char* buf, int len, char* str);
mazgch 31:a0bed6c1e05d 454 static int _cbInt(int type, const char* buf, int len, int* val);
mazgch 31:a0bed6c1e05d 455 // device
mazgch 32:8f12ac182bbb 456 static int _cbATI(int type, const char* buf, int len, Dev* dev);
mazgch 31:a0bed6c1e05d 457 static int _cbCPIN(int type, const char* buf, int len, Sim* sim);
mazgch 31:a0bed6c1e05d 458 static int _cbCCID(int type, const char* buf, int len, char* ccid);
mazgch 31:a0bed6c1e05d 459 // network
mazgch 54:7ba8e4c218e2 460 static int _cbCSQ(int type, const char* buf, int len, NetStatus* status);
mazgch 31:a0bed6c1e05d 461 static int _cbCOPS(int type, const char* buf, int len, NetStatus* status);
mazgch 31:a0bed6c1e05d 462 static int _cbCNUM(int type, const char* buf, int len, char* num);
mazgch 72:d1e943ad6558 463 static int _cbCGATT(int type, const char* buf, int len, Gprs* gprs);
mazgch 31:a0bed6c1e05d 464 // sockets
mazgch 32:8f12ac182bbb 465 static int _cbCMIP(int type, const char* buf, int len, IP* ip);
mazgch 31:a0bed6c1e05d 466 static int _cbUPSND(int type, const char* buf, int len, int* act);
mazgch 31:a0bed6c1e05d 467 static int _cbUPSND(int type, const char* buf, int len, IP* ip);
mazgch 21:c4d64830bf02 468 static int _cbUDNSRN(int type, const char* buf, int len, IP* ip);
mazgch 21:c4d64830bf02 469 static int _cbUSOCR(int type, const char* buf, int len, int* socket);
mazgch 21:c4d64830bf02 470 static int _cbUSORD(int type, const char* buf, int len, char* out);
mazgch 21:c4d64830bf02 471 typedef struct { char* buf; IP ip; int port; } USORFparam;
mazgch 21:c4d64830bf02 472 static int _cbUSORF(int type, const char* buf, int len, USORFparam* param);
mazgch 21:c4d64830bf02 473 typedef struct { char* buf; char* num; } CMGRparam;
mazgch 21:c4d64830bf02 474 static int _cbCUSD(int type, const char* buf, int len, char* buf);
mazgch 31:a0bed6c1e05d 475 // sms
mazgch 31:a0bed6c1e05d 476 typedef struct { int* ix; int num; } CMGLparam;
mazgch 31:a0bed6c1e05d 477 static int _cbCMGL(int type, const char* buf, int len, CMGLparam* param);
mazgch 21:c4d64830bf02 478 static int _cbCMGR(int type, const char* buf, int len, CMGRparam* param);
mazgch 38:e6cab4632d84 479 // variables
mazgch 31:a0bed6c1e05d 480 DevStatus _dev; //!< collected device information
mazgch 31:a0bed6c1e05d 481 NetStatus _net; //!< collected network information
mazgch 31:a0bed6c1e05d 482 IP _ip; //!< assigned ip address
mazgch 31:a0bed6c1e05d 483 // management struture for sockets
mazgch 21:c4d64830bf02 484 typedef enum { SOCK_FREE, SOCK_CREATED, SOCK_CONNECTED } SockState;
mazgch 66:69072b3c5bca 485 typedef struct { SockState state; int pending; int timeout_ms; } SockCtrl;
mazgch 59:382695f1ce85 486 // LISA-C has 6 TCP and 6 UDP sockets starting at index 18
mazgch 59:382695f1ce85 487 // LISA-U and SARA-G have 7 sockets starting at index 1
mazgch 59:382695f1ce85 488 SockCtrl _sockets[32];
mazgch 44:9d12223b78ff 489 static MDMParser* inst;
mazgch 18:e5697801df29 490 };
mazgch 18:e5697801df29 491
mazgch 18:e5697801df29 492 // -----------------------------------------------------------------------
mazgch 18:e5697801df29 493
mazgch 38:e6cab4632d84 494 /** modem class which uses a serial port
mazgch 38:e6cab4632d84 495 as physical interface.
mazgch 38:e6cab4632d84 496 */
mazgch 18:e5697801df29 497 class MDMSerial : public SerialPipe, public MDMParser
mazgch 17:296d94a006b4 498 {
mazgch 17:296d94a006b4 499 public:
mazgch 38:e6cab4632d84 500 /** Constructor
mazgch 38:e6cab4632d84 501
mazgch 38:e6cab4632d84 502 \param tx is the serial ports transmit pin (modem to CPU)
mazgch 38:e6cab4632d84 503 \param rx is the serial ports receive pin (CPU to modem)
mazgch 38:e6cab4632d84 504 \param baudrate the baudrate of the modem use 115200
mazgch 38:e6cab4632d84 505 \param rts is the serial ports ready to send pin (CPU to modem)
mazgch 38:e6cab4632d84 506 this pin is optional
mazgch 38:e6cab4632d84 507 \param cts is the serial ports clear to send pin (modem to CPU)
mazgch 38:e6cab4632d84 508 this pin is optional, but required for power saving to be enabled
mazgch 38:e6cab4632d84 509 \param rxSize the size of the serial rx buffer
mazgch 38:e6cab4632d84 510 \param txSize the size of the serial tx buffer
mazgch 38:e6cab4632d84 511 */
mazgch 19:2b5d097ca15d 512 MDMSerial(PinName tx _C027DEFAULT(MDMTXD),
mazgch 19:2b5d097ca15d 513 PinName rx _C027DEFAULT(MDMRXD),
mazgch 19:2b5d097ca15d 514 int baudrate _C027DEFAULT(MDMBAUD),
mazgch 35:9275215a3a5b 515 #if DEVICE_SERIAL_FC
mazgch 19:2b5d097ca15d 516 PinName rts _C027DEFAULT(MDMRTS),
mazgch 19:2b5d097ca15d 517 PinName cts _C027DEFAULT(MDMCTS),
mazgch 35:9275215a3a5b 518 #endif
mazgch 19:2b5d097ca15d 519 int rxSize = 256 ,
mazgch 21:c4d64830bf02 520 int txSize = 128 );
mazgch 38:e6cab4632d84 521 /** Get a line from the physical interface.
mazgch 38:e6cab4632d84 522 \param buf the buffer to store it
mazgch 38:e6cab4632d84 523 \param buf size of the buffer
mazgch 38:e6cab4632d84 524 \return type and length if something was found,
mazgch 38:e6cab4632d84 525 WAIT if not enough data is available
mazgch 38:e6cab4632d84 526 NOT_FOUND if nothing was found
mazgch 38:e6cab4632d84 527 */
mazgch 18:e5697801df29 528 virtual int getLine(char* buffer, int length);
mazgch 18:e5697801df29 529 protected:
mazgch 38:e6cab4632d84 530 /** Write bytes to the physical interface.
mazgch 38:e6cab4632d84 531 \param buf the buffer to write
mazgch 38:e6cab4632d84 532 \param buf size of the buffer to write
mazgch 38:e6cab4632d84 533 \return bytes written
mazgch 38:e6cab4632d84 534 */
mazgch 18:e5697801df29 535 virtual int _send(const void* buf, int len);
mazgch 17:296d94a006b4 536 };
mazgch 18:e5697801df29 537
mazgch 18:e5697801df29 538 // -----------------------------------------------------------------------
mazgch 18:e5697801df29 539
mazgch 38:e6cab4632d84 540 //#define HAVE_MDMUSB
mazgch 18:e5697801df29 541 #ifdef HAVE_MDMUSB
mazgch 18:e5697801df29 542 class MDMUsb : /*public UsbSerial,*/ public MDMParser
mazgch 18:e5697801df29 543 {
mazgch 18:e5697801df29 544 public:
mazgch 18:e5697801df29 545 MDMUsb(void);
mazgch 18:e5697801df29 546 virtual int getLine(char* buffer, int length);
mazgch 18:e5697801df29 547 protected:
mazgch 18:e5697801df29 548 virtual int _send(const void* buf, int len);
mazgch 18:e5697801df29 549 };
mazgch 18:e5697801df29 550 #endif
mazgch 18:e5697801df29 551
mazgch 18:e5697801df29 552