Georgi Huklev / C027_Support

Add a bunch of APNs

Fork of C027_Support by Xinlei Cao

MDM.h@80:34985b4d821e, 2014-05-27 (annotated)

Committer:
mazgch
Date:
Tue May 27 08:21:53 2014 +0000
Revision:
80:34985b4d821e
Parent:
79:291df065e345
Child:
81:3966a5c17037
improved psd auth handling, added file api

Who changed what in which revision?

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