Sean McBeath / C027_Support

C027 support

Fork of C027_Support by u-blox

MDM.h@66:69072b3c5bca, 2014-05-13 (annotated)

Committer:
mazgch
Date:
Tue May 13 15:56:28 2014 +0000
Revision:
66:69072b3c5bca
Parent:
63:42cb563a25bc
Child:
72:d1e943ad6558
use a named constant for blocking timeout

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