Marc BUSSON / 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.

Fork of C027_Support by u-blox

MDM.h@72:d1e943ad6558, 2014-05-15 (annotated)

Committer:
mazgch
Date:
Thu May 15 07:06:07 2014 +0000
Revision:
72:d1e943ad6558
Parent:
66:69072b3c5bca
Child:
73:2b32e0a21df2
save gprs attach status

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 54:7ba8e4c218e2 285 /** dump the device status to stdout using printf
mazgch 54:7ba8e4c218e2 286 \param status the status to convert to textual form,
mazgch 54:7ba8e4c218e2 287 unavailable fields are ommited (not printed)
mazgch 54:7ba8e4c218e2 288 */
mazgch 54:7ba8e4c218e2 289 static void dumpDevStatus(MDMParser::DevStatus *status);
mazgch 54:7ba8e4c218e2 290
mazgch 54:7ba8e4c218e2 291 /** dump the network status to stdout using printf
mazgch 54:7ba8e4c218e2 292 \param status the status to convert to textual form,
mazgch 54:7ba8e4c218e2 293 unavailable fields are ommited (not printed)
mazgch 54:7ba8e4c218e2 294 */
mazgch 54:7ba8e4c218e2 295 static void dumpNetStatus(MDMParser::NetStatus *status);
mazgch 54:7ba8e4c218e2 296
mazgch 54:7ba8e4c218e2 297 /** dump the ip address to stdout using printf
mazgch 54:7ba8e4c218e2 298 \param ip the ip to convert to textual form,
mazgch 54:7ba8e4c218e2 299 unavailable fields are ommited (not printed)
mazgch 54:7ba8e4c218e2 300 */
mazgch 54:7ba8e4c218e2 301 static void dumpIp(MDMParser::IP ip);
mazgch 54:7ba8e4c218e2 302
mazgch 54:7ba8e4c218e2 303 // ----------------------------------------------------------------
mazgch 31:a0bed6c1e05d 304 // Parseing
mazgch 31:a0bed6c1e05d 305 // ----------------------------------------------------------------
mazgch 31:a0bed6c1e05d 306
mazgch 51:e7b81c31baec 307 enum {
mazgch 51:e7b81c31baec 308 // waitFinalResp Responses
mazgch 52:8071747a7cb3 309 NOT_FOUND = 0,
mazgch 52:8071747a7cb3 310 WAIT = -1, // TIMEOUT
mazgch 52:8071747a7cb3 311 RESP_OK = -2,
mazgch 52:8071747a7cb3 312 RESP_ERROR = -3,
mazgch 52:8071747a7cb3 313 RESP_PROMPT = -4,
mazgch 31:a0bed6c1e05d 314
mazgch 51:e7b81c31baec 315 // getLine Responses
mazgch 51:e7b81c31baec 316 #define LENGTH(x) (x & 0x00FFFF) //!< extract/mask the length
mazgch 51:e7b81c31baec 317 #define TYPE(x) (x & 0xFF0000) //!< extract/mask the type
mazgch 51:e7b81c31baec 318
mazgch 51:e7b81c31baec 319 TYPE_UNKNOWN = 0x000000,
mazgch 51:e7b81c31baec 320 TYPE_OK = 0x110000,
mazgch 51:e7b81c31baec 321 TYPE_ERROR = 0x120000,
mazgch 51:e7b81c31baec 322 TYPE_RING = 0x210000,
mazgch 51:e7b81c31baec 323 TYPE_CONNECT = 0x220000,
mazgch 51:e7b81c31baec 324 TYPE_NOCARRIER = 0x230000,
mazgch 51:e7b81c31baec 325 TYPE_NODIALTONE = 0x240000,
mazgch 51:e7b81c31baec 326 TYPE_BUSY = 0x250000,
mazgch 51:e7b81c31baec 327 TYPE_NOANSWER = 0x260000,
mazgch 51:e7b81c31baec 328 TYPE_PROMPT = 0x300000,
mazgch 51:e7b81c31baec 329 TYPE_PLUS = 0x400000,
mazgch 66:69072b3c5bca 330 TYPE_TEXT = 0x500000,
mazgch 66:69072b3c5bca 331
mazgch 66:69072b3c5bca 332 // special timout constant
mazgch 66:69072b3c5bca 333 TIMEOUT_BLOCKING = -1
mazgch 51:e7b81c31baec 334 };
mazgch 31:a0bed6c1e05d 335
mazgch 31:a0bed6c1e05d 336 /** Get a line from the physical interface. This function need
mazgch 31:a0bed6c1e05d 337 to be implemented in a inherited class. Usually just calls
mazgch 31:a0bed6c1e05d 338 #_getLine on the rx buffer pipe.
mazgch 31:a0bed6c1e05d 339
mazgch 31:a0bed6c1e05d 340 \param buf the buffer to store it
mazgch 31:a0bed6c1e05d 341 \param buf size of the buffer
mazgch 31:a0bed6c1e05d 342 \return type and length if something was found,
mazgch 31:a0bed6c1e05d 343 WAIT if not enough data is available
mazgch 31:a0bed6c1e05d 344 NOT_FOUND if nothing was found
mazgch 31:a0bed6c1e05d 345 */
mazgch 31:a0bed6c1e05d 346 virtual int getLine(char* buf, int len) = 0;
mazgch 28:4d9509e3b1cf 347
mazgch 31:a0bed6c1e05d 348 /** Write data to the device
mazgch 31:a0bed6c1e05d 349 \param buf the buffer to write
mazgch 31:a0bed6c1e05d 350 \param buf size of the buffer to write
mazgch 31:a0bed6c1e05d 351 \return bytes written
mazgch 31:a0bed6c1e05d 352 */
mazgch 31:a0bed6c1e05d 353 virtual int send(const char* buf, int len);
mazgch 21:c4d64830bf02 354
mazgch 31:a0bed6c1e05d 355 /** Write formated date to the physical interface (printf style)
mazgch 31:a0bed6c1e05d 356 \param fmt the format string
mazgch 31:a0bed6c1e05d 357 \param .. variable arguments to be formated
mazgch 31:a0bed6c1e05d 358 \return bytes written
mazgch 31:a0bed6c1e05d 359 */
mazgch 21:c4d64830bf02 360 int sendFormated(const char* format, ...);
mazgch 26:07be5faf8925 361
mazgch 31:a0bed6c1e05d 362 /** callback function for #waitFinalResp with void* as argument
mazgch 31:a0bed6c1e05d 363 \param type the #getLine response
mazgch 31:a0bed6c1e05d 364 \param buf the parsed line
mazgch 31:a0bed6c1e05d 365 \param len the size of the parsed line
mazgch 31:a0bed6c1e05d 366 \param param the optional argument passed to #waitFinalResp
mazgch 31:a0bed6c1e05d 367 \return WAIT if processing should continue,
mazgch 31:a0bed6c1e05d 368 any other value aborts #waitFinalResp and this retunr value retuned
mazgch 31:a0bed6c1e05d 369 */
mazgch 26:07be5faf8925 370 typedef int (*_CALLBACKPTR)(int type, const char* buf, int len, void* param);
mazgch 31:a0bed6c1e05d 371
mazgch 31:a0bed6c1e05d 372 /** Wait for a final respons
mazgch 31:a0bed6c1e05d 373 \param cb the optional callback function
mazgch 31:a0bed6c1e05d 374 \param param the optional callback function parameter
mazgch 58:e38a2e942fbb 375 \param timeout_ms the timeout to wait (See Estimated command
mazgch 58:e38a2e942fbb 376 response time of AT manual)
mazgch 31:a0bed6c1e05d 377 */
mazgch 31:a0bed6c1e05d 378 int waitFinalResp(_CALLBACKPTR cb = NULL,
mazgch 26:07be5faf8925 379 void* param = NULL,
mazgch 58:e38a2e942fbb 380 int timeout_ms = 10000);
mazgch 31:a0bed6c1e05d 381
mazgch 31:a0bed6c1e05d 382 /** template version of #waitFinalResp when using callbacks,
mazgch 31:a0bed6c1e05d 383 This template will allow the compiler to do type cheking but
mazgch 31:a0bed6c1e05d 384 internally symply casts the arguments and call the (void*)
mazgch 31:a0bed6c1e05d 385 version of #waitFinalResp.
mazgch 31:a0bed6c1e05d 386 \sa waitFinalResp
mazgch 31:a0bed6c1e05d 387 */
mazgch 26:07be5faf8925 388 template<class T>
mazgch 26:07be5faf8925 389 int waitFinalResp(int (*cb)(int type, const char* buf, int len,
mazgch 26:07be5faf8925 390 T* param),
mazgch 58:e38a2e942fbb 391 T* param, int timeout_ms = 10000)
mazgch 26:07be5faf8925 392 {
mazgch 26:07be5faf8925 393 return waitFinalResp((_CALLBACKPTR)cb, (void*)param, timeout_ms);
mazgch 26:07be5faf8925 394 }
mazgch 31:a0bed6c1e05d 395
mazgch 18:e5697801df29 396 protected:
mazgch 31:a0bed6c1e05d 397 /** Write bytes to the physical interface. This function should be
mazgch 31:a0bed6c1e05d 398 implemented in a inherited class.
mazgch 31:a0bed6c1e05d 399 \param buf the buffer to write
mazgch 31:a0bed6c1e05d 400 \param buf size of the buffer to write
mazgch 31:a0bed6c1e05d 401 \return bytes written
mazgch 31:a0bed6c1e05d 402 */
mazgch 18:e5697801df29 403 virtual int _send(const void* buf, int len) = 0;
mazgch 31:a0bed6c1e05d 404
mazgch 31:a0bed6c1e05d 405 /** Helper: Parse a line from the receiving buffered pipe
mazgch 31:a0bed6c1e05d 406 \param pipe the receiving buffer pipe
mazgch 31:a0bed6c1e05d 407 \param buf the parsed line
mazgch 31:a0bed6c1e05d 408 \param len the size of the parsed line
mazgch 31:a0bed6c1e05d 409 \return type and length if something was found,
mazgch 31:a0bed6c1e05d 410 WAIT if not enough data is available
mazgch 31:a0bed6c1e05d 411 NOT_FOUND if nothing was found
mazgch 31:a0bed6c1e05d 412 */
mazgch 31:a0bed6c1e05d 413 static int _getLine(Pipe<char>* pipe, char* buffer, int length);
mazgch 31:a0bed6c1e05d 414
mazgch 31:a0bed6c1e05d 415 /** Helper: Parse a match from the pipe
mazgch 31:a0bed6c1e05d 416 \param pipe the buffered pipe
mazgch 31:a0bed6c1e05d 417 \param number of bytes to parse at maximum,
mazgch 31:a0bed6c1e05d 418 \param sta the starting string, NULL if none
mazgch 31:a0bed6c1e05d 419 \param end the terminating string, NULL if none
mazgch 31:a0bed6c1e05d 420 \return size of parsed match
mazgch 31:a0bed6c1e05d 421 */
mazgch 31:a0bed6c1e05d 422 static int _parseMatch(Pipe<char>* pipe, int len, const char* sta, const char* end);
mazgch 31:a0bed6c1e05d 423
mazgch 31:a0bed6c1e05d 424 /** Helper: Parse a match from the pipe
mazgch 31:a0bed6c1e05d 425 \param pipe the buffered pipe
mazgch 31:a0bed6c1e05d 426 \param number of bytes to parse at maximum,
mazgch 31:a0bed6c1e05d 427 \param fmt the formating string (%d any number, %c any char of last %d len)
mazgch 31:a0bed6c1e05d 428 \return size of parsed match
mazgch 31:a0bed6c1e05d 429 */
mazgch 31:a0bed6c1e05d 430 static int _parseFormated(Pipe<char>* pipe, int len, const char* fmt);
mazgch 31:a0bed6c1e05d 431
mazgch 35:9275215a3a5b 432 protected:
mazgch 31:a0bed6c1e05d 433 // parsing callbacks for different AT commands and their parameter arguments
mazgch 31:a0bed6c1e05d 434 static int _cbString(int type, const char* buf, int len, char* str);
mazgch 31:a0bed6c1e05d 435 static int _cbInt(int type, const char* buf, int len, int* val);
mazgch 31:a0bed6c1e05d 436 // device
mazgch 32:8f12ac182bbb 437 static int _cbATI(int type, const char* buf, int len, Dev* dev);
mazgch 31:a0bed6c1e05d 438 static int _cbCPIN(int type, const char* buf, int len, Sim* sim);
mazgch 31:a0bed6c1e05d 439 static int _cbCCID(int type, const char* buf, int len, char* ccid);
mazgch 31:a0bed6c1e05d 440 // network
mazgch 54:7ba8e4c218e2 441 static int _cbCSQ(int type, const char* buf, int len, NetStatus* status);
mazgch 31:a0bed6c1e05d 442 static int _cbCOPS(int type, const char* buf, int len, NetStatus* status);
mazgch 31:a0bed6c1e05d 443 static int _cbCNUM(int type, const char* buf, int len, char* num);
mazgch 72:d1e943ad6558 444 static int _cbCGATT(int type, const char* buf, int len, Gprs* gprs);
mazgch 31:a0bed6c1e05d 445 // sockets
mazgch 32:8f12ac182bbb 446 static int _cbCMIP(int type, const char* buf, int len, IP* ip);
mazgch 31:a0bed6c1e05d 447 static int _cbUPSND(int type, const char* buf, int len, int* act);
mazgch 31:a0bed6c1e05d 448 static int _cbUPSND(int type, const char* buf, int len, IP* ip);
mazgch 21:c4d64830bf02 449 static int _cbUDNSRN(int type, const char* buf, int len, IP* ip);
mazgch 21:c4d64830bf02 450 static int _cbUSOCR(int type, const char* buf, int len, int* socket);
mazgch 21:c4d64830bf02 451 static int _cbUSORD(int type, const char* buf, int len, char* out);
mazgch 21:c4d64830bf02 452 typedef struct { char* buf; IP ip; int port; } USORFparam;
mazgch 21:c4d64830bf02 453 static int _cbUSORF(int type, const char* buf, int len, USORFparam* param);
mazgch 21:c4d64830bf02 454 typedef struct { char* buf; char* num; } CMGRparam;
mazgch 21:c4d64830bf02 455 static int _cbCUSD(int type, const char* buf, int len, char* buf);
mazgch 31:a0bed6c1e05d 456 // sms
mazgch 31:a0bed6c1e05d 457 typedef struct { int* ix; int num; } CMGLparam;
mazgch 31:a0bed6c1e05d 458 static int _cbCMGL(int type, const char* buf, int len, CMGLparam* param);
mazgch 21:c4d64830bf02 459 static int _cbCMGR(int type, const char* buf, int len, CMGRparam* param);
mazgch 38:e6cab4632d84 460 // variables
mazgch 31:a0bed6c1e05d 461 DevStatus _dev; //!< collected device information
mazgch 31:a0bed6c1e05d 462 NetStatus _net; //!< collected network information
mazgch 31:a0bed6c1e05d 463 IP _ip; //!< assigned ip address
mazgch 31:a0bed6c1e05d 464 // management struture for sockets
mazgch 21:c4d64830bf02 465 typedef enum { SOCK_FREE, SOCK_CREATED, SOCK_CONNECTED } SockState;
mazgch 66:69072b3c5bca 466 typedef struct { SockState state; int pending; int timeout_ms; } SockCtrl;
mazgch 59:382695f1ce85 467 // LISA-C has 6 TCP and 6 UDP sockets starting at index 18
mazgch 59:382695f1ce85 468 // LISA-U and SARA-G have 7 sockets starting at index 1
mazgch 59:382695f1ce85 469 SockCtrl _sockets[32];
mazgch 44:9d12223b78ff 470 static MDMParser* inst;
mazgch 18:e5697801df29 471 };
mazgch 18:e5697801df29 472
mazgch 18:e5697801df29 473 // -----------------------------------------------------------------------
mazgch 18:e5697801df29 474
mazgch 38:e6cab4632d84 475 /** modem class which uses a serial port
mazgch 38:e6cab4632d84 476 as physical interface.
mazgch 38:e6cab4632d84 477 */
mazgch 18:e5697801df29 478 class MDMSerial : public SerialPipe, public MDMParser
mazgch 17:296d94a006b4 479 {
mazgch 17:296d94a006b4 480 public:
mazgch 38:e6cab4632d84 481 /** Constructor
mazgch 38:e6cab4632d84 482
mazgch 38:e6cab4632d84 483 \param tx is the serial ports transmit pin (modem to CPU)
mazgch 38:e6cab4632d84 484 \param rx is the serial ports receive pin (CPU to modem)
mazgch 38:e6cab4632d84 485 \param baudrate the baudrate of the modem use 115200
mazgch 38:e6cab4632d84 486 \param rts is the serial ports ready to send pin (CPU to modem)
mazgch 38:e6cab4632d84 487 this pin is optional
mazgch 38:e6cab4632d84 488 \param cts is the serial ports clear to send pin (modem to CPU)
mazgch 38:e6cab4632d84 489 this pin is optional, but required for power saving to be enabled
mazgch 38:e6cab4632d84 490 \param rxSize the size of the serial rx buffer
mazgch 38:e6cab4632d84 491 \param txSize the size of the serial tx buffer
mazgch 38:e6cab4632d84 492 */
mazgch 19:2b5d097ca15d 493 MDMSerial(PinName tx _C027DEFAULT(MDMTXD),
mazgch 19:2b5d097ca15d 494 PinName rx _C027DEFAULT(MDMRXD),
mazgch 19:2b5d097ca15d 495 int baudrate _C027DEFAULT(MDMBAUD),
mazgch 35:9275215a3a5b 496 #if DEVICE_SERIAL_FC
mazgch 19:2b5d097ca15d 497 PinName rts _C027DEFAULT(MDMRTS),
mazgch 19:2b5d097ca15d 498 PinName cts _C027DEFAULT(MDMCTS),
mazgch 35:9275215a3a5b 499 #endif
mazgch 19:2b5d097ca15d 500 int rxSize = 256 ,
mazgch 21:c4d64830bf02 501 int txSize = 128 );
mazgch 38:e6cab4632d84 502 /** Get a line from the physical interface.
mazgch 38:e6cab4632d84 503 \param buf the buffer to store it
mazgch 38:e6cab4632d84 504 \param buf size of the buffer
mazgch 38:e6cab4632d84 505 \return type and length if something was found,
mazgch 38:e6cab4632d84 506 WAIT if not enough data is available
mazgch 38:e6cab4632d84 507 NOT_FOUND if nothing was found
mazgch 38:e6cab4632d84 508 */
mazgch 18:e5697801df29 509 virtual int getLine(char* buffer, int length);
mazgch 18:e5697801df29 510 protected:
mazgch 38:e6cab4632d84 511 /** Write bytes to the physical interface.
mazgch 38:e6cab4632d84 512 \param buf the buffer to write
mazgch 38:e6cab4632d84 513 \param buf size of the buffer to write
mazgch 38:e6cab4632d84 514 \return bytes written
mazgch 38:e6cab4632d84 515 */
mazgch 18:e5697801df29 516 virtual int _send(const void* buf, int len);
mazgch 17:296d94a006b4 517 };
mazgch 18:e5697801df29 518
mazgch 18:e5697801df29 519 // -----------------------------------------------------------------------
mazgch 18:e5697801df29 520
mazgch 38:e6cab4632d84 521 //#define HAVE_MDMUSB
mazgch 18:e5697801df29 522 #ifdef HAVE_MDMUSB
mazgch 18:e5697801df29 523 class MDMUsb : /*public UsbSerial,*/ public MDMParser
mazgch 18:e5697801df29 524 {
mazgch 18:e5697801df29 525 public:
mazgch 18:e5697801df29 526 MDMUsb(void);
mazgch 18:e5697801df29 527 virtual int getLine(char* buffer, int length);
mazgch 18:e5697801df29 528 protected:
mazgch 18:e5697801df29 529 virtual int _send(const void* buf, int len);
mazgch 18:e5697801df29 530 };
mazgch 18:e5697801df29 531 #endif
mazgch 18:e5697801df29 532
mazgch 18:e5697801df29 533