u-blox / C027_Support

support library for C027 helper functions for Buffer Pipes, Buffered Serial Port (rtos capable) and GPS parsing. It includes modem APIs for USSD, SMS and Sockets.

Dependents:   HTTPClient_Cellular_HelloWorld Cellular_HelloMQTT MbedSmartRestMain Car_Bon_car_module ... more

This library is intended to be used with u-blox products such as the C027 or a shield with u-blox cellular and GPS modules like the cellular and positioning shield from Embedded Artist.

For 2G/GSM and 3G/UMTS you need to:

  • have a SIM card and know its PIN number
  • need to know you network operators APN setting These setting should be passed to the connect or init and join functions. You can also extend the APN database in MDMAPN.h.

For CDMA products you need to make sure that you have provisioned and activated the modem with either Sprint or Verizon.

MDM.h@135:cbccf4052d45, 2016-01-21 (annotated)

Committer:
fdilenarda
Date:
Thu Jan 21 15:59:42 2016 +0000
Revision:
135:cbccf4052d45
Parent:
134:2fbd5723e063
Child:
136:8dc8f48275fc
added HTTP 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 130:3189949981ec 9 #ifdef TARGET_UBLOX_C027
mazgch 130:3189949981ec 10 // you can change this is you like to use a shield even on the C027
mazgch 75:ce6e12067d0c 11 #define MDM_IF(onboard,shield) onboard
mazgch 19:2b5d097ca15d 12 #else
mazgch 75:ce6e12067d0c 13 #define MDM_IF(onboard,shield) shield
mazgch 19:2b5d097ca15d 14 #endif
mazgch 18:e5697801df29 15
mazgch 74:208e3e32d263 16 //! include debug capabilty on more powerful targets with a dedicated debug port
mazgch 74:208e3e32d263 17 #if defined(TARGET_LPC1768) || defined(TARGET_LPC4088) || defined(TARGET_K64F)
mazgch 74:208e3e32d263 18 #define MDM_DEBUG
mazgch 74:208e3e32d263 19 #endif
mazgch 74:208e3e32d263 20
mazgch 38:e6cab4632d84 21 /** basic modem parser class
mazgch 38:e6cab4632d84 22 */
mazgch 18:e5697801df29 23 class MDMParser
mazgch 18:e5697801df29 24 {
mazgch 18:e5697801df29 25 public:
mazgch 31:a0bed6c1e05d 26 //! Constructor
mazgch 76:f7c3dd568dae 27 MDMParser(void);
mazgch 44:9d12223b78ff 28 //! get static instance
mazgch 44:9d12223b78ff 29 static MDMParser* getInstance() { return inst; };
mazgch 31:a0bed6c1e05d 30
mazgch 31:a0bed6c1e05d 31 // ----------------------------------------------------------------
mazgch 31:a0bed6c1e05d 32 // Types
mazgch 31:a0bed6c1e05d 33 // ----------------------------------------------------------------
mazgch 38:e6cab4632d84 34 //! MT Device Types
mazgch 123:66cef6353b13 35 typedef enum { DEV_UNKNOWN,
msinig 133:57b208dd96fb 36 DEV_SARA_G35, DEV_LISA_U2, DEV_LISA_U2_03S, DEV_LISA_C2,
mazgch 125:25a292afbac6 37 DEV_SARA_U2, DEV_LEON_G2, DEV_TOBY_L2, DEV_MPCI_L2 } Dev;
mazgch 38:e6cab4632d84 38 //! SIM Status
msinig 134:2fbd5723e063 39 typedef enum { SIM_UNKNOWN, SIM_MISSING, SIM_PIN, SIM_PUK, SIM_READY, WRONG_PIN } Sim;
mazgch 38:e6cab4632d84 40 //! SIM Status
mazgch 76:f7c3dd568dae 41 typedef enum { LPM_DISABLED, LPM_ENABLED, LPM_ACTIVE } Lpm;
msinig 134:2fbd5723e063 42 //! COPS status
msinig 134:2fbd5723e063 43 typedef enum { COPS_UNKOWN, COPS_AUTOMATIC_REG, COPS_MANUAL_REG, COPS_DISABLED_REG} CopsMode;
mazgch 38:e6cab4632d84 44 //! Device status
mazgch 33:fb8fb5021b09 45 typedef struct {
mazgch 34:3b3b7807c0c3 46 Dev dev; //!< Device Type
mazgch 35:9275215a3a5b 47 Lpm lpm; //!< Power Saving
mazgch 34:3b3b7807c0c3 48 Sim sim; //!< SIM Card Status
mazgch 34:3b3b7807c0c3 49 char ccid[20+1]; //!< Integrated Circuit Card ID
mazgch 34:3b3b7807c0c3 50 char imsi[15+1]; //!< International Mobile Station Identity
mazgch 34:3b3b7807c0c3 51 char imei[15+1]; //!< International Mobile Equipment Identity
mazgch 34:3b3b7807c0c3 52 char meid[18+1]; //!< Mobile Equipment IDentifier
mazgch 34:3b3b7807c0c3 53 char manu[16]; //!< Manufacturer (u-blox)
mazgch 34:3b3b7807c0c3 54 char model[16]; //!< Model Name (LISA-U200, LISA-C200 or SARA-G350)
mazgch 34:3b3b7807c0c3 55 char ver[16]; //!< Software Version
mazgch 38:e6cab4632d84 56 } DevStatus;
mazgch 38:e6cab4632d84 57 //! Registration Status
mazgch 38:e6cab4632d84 58 typedef enum { REG_UNKNOWN, REG_DENIED, REG_NONE, REG_HOME, REG_ROAMING } Reg;
mazgch 38:e6cab4632d84 59 //! Access Technology
mazgch 123:66cef6353b13 60 typedef enum { ACT_UNKNOWN, ACT_GSM, ACT_EDGE, ACT_UTRAN, ACT_CDMA, ACT_LTE } AcT;
mazgch 38:e6cab4632d84 61 //! Network Status
mazgch 33:fb8fb5021b09 62 typedef struct {
mazgch 79:291df065e345 63 Reg csd; //!< CSD Registration Status (Circuit Switched Data)
mazgch 79:291df065e345 64 Reg psd; //!< PSD Registration status (Packet Switched Data)
mazgch 123:66cef6353b13 65 Reg eps; //!< EPS Registration status
mazgch 34:3b3b7807c0c3 66 AcT act; //!< Access Technology
mazgch 121:8da935c2c08c 67 int rssi; //!< Received Signal Strength Indication (in dBm, range -113..-51)
mazgch 54:7ba8e4c218e2 68 int ber; //!< Bit Error Rate (BER), see 3GPP TS 45.008 [20] subclause 8.2.4
mazgch 34:3b3b7807c0c3 69 char opr[16+1]; //!< Operator Name
mazgch 34:3b3b7807c0c3 70 char num[32]; //!< Mobile Directory Number
mazgch 54:7ba8e4c218e2 71 unsigned short lac; //!< location area code in hexadecimal format (2 bytes in hex)
mazgch 54:7ba8e4c218e2 72 unsigned int ci; //!< Cell ID in hexadecimal format (2 to 4 bytes in hex)
msinig 134:2fbd5723e063 73 CopsMode regStatus; //!< Cops mode
mazgch 38:e6cab4632d84 74 } NetStatus;
msinig 133:57b208dd96fb 75 //! Cell Locate Data
msinig 133:57b208dd96fb 76 typedef struct {
msinig 133:57b208dd96fb 77 bool validData; //!< Flag for indicating if data is valid
msinig 133:57b208dd96fb 78 struct tm time; //!< GPS Timestamp
msinig 133:57b208dd96fb 79 float longitude; //!< Estimated longitude, in degrees
msinig 133:57b208dd96fb 80 float latitue; //!< Estimated latitude, in degrees
msinig 133:57b208dd96fb 81 int altitutude; //!< Estimated altitude, in meters^2
msinig 133:57b208dd96fb 82 int uncertainty; //!< Maximum possible error, in meters
msinig 133:57b208dd96fb 83 int speed; //!< Speed over ground m/s^2
msinig 133:57b208dd96fb 84 int direction; //!< Course over ground in degrees
msinig 133:57b208dd96fb 85 int verticalAcc; //!< Vertical accuracy, in meters^2
msinig 133:57b208dd96fb 86 int sensorUsed; //!< Sensor used for last calculation
msinig 133:57b208dd96fb 87 int svUsed; //!< number of satellite used
msinig 133:57b208dd96fb 88 }CellLocData;
msinig 133:57b208dd96fb 89
mazgch 38:e6cab4632d84 90 //! An IP v4 address
mazgch 38:e6cab4632d84 91 typedef uint32_t IP;
mazgch 33:fb8fb5021b09 92 #define NOIP ((MDMParser::IP)0) //!< No IP address
mazgch 31:a0bed6c1e05d 93 // ip number formating and conversion
mazgch 31:a0bed6c1e05d 94 #define IPSTR "%d.%d.%d.%d"
mazgch 31:a0bed6c1e05d 95 #define IPNUM(ip) ((ip)>>24)&0xff, \
mazgch 31:a0bed6c1e05d 96 ((ip)>>16)&0xff, \
mazgch 31:a0bed6c1e05d 97 ((ip)>> 8)&0xff, \
mazgch 31:a0bed6c1e05d 98 ((ip)>> 0)&0xff
mazgch 31:a0bed6c1e05d 99 #define IPADR(a,b,c,d) ((((IP)(a))<<24) | \
mazgch 31:a0bed6c1e05d 100 (((IP)(b))<<16) | \
mazgch 31:a0bed6c1e05d 101 (((IP)(c))<< 8) | \
mazgch 31:a0bed6c1e05d 102 (((IP)(d))<< 0))
mazgch 31:a0bed6c1e05d 103
mazgch 31:a0bed6c1e05d 104
mazgch 31:a0bed6c1e05d 105 // ----------------------------------------------------------------
mazgch 57:869bd35f44cc 106 // Device
mazgch 31:a0bed6c1e05d 107 // ----------------------------------------------------------------
mazgch 31:a0bed6c1e05d 108
mazgch 80:34985b4d821e 109 typedef enum { AUTH_NONE, AUTH_PAP, AUTH_CHAP, AUTH_DETECT } Auth;
mazgch 80:34985b4d821e 110
mazgch 57:869bd35f44cc 111 /** Combined Init, checkNetStatus, join suitable for simple applications
mazgch 57:869bd35f44cc 112 \param simpin a optional pin of the SIM card
mazgch 57:869bd35f44cc 113 \param apn the of the network provider e.g. "internet" or "apn.provider.com"
mazgch 57:869bd35f44cc 114 \param username is the user name text string for the authentication phase
mazgch 57:869bd35f44cc 115 \param password is the password text string for the authentication phase
mazgch 80:34985b4d821e 116 \param auth is the authentication mode (CHAP,PAP,NONE or DETECT)
mazgch 57:869bd35f44cc 117 \return true if successful, false otherwise
mazgch 57:869bd35f44cc 118 */
mazgch 94:d697fe11f3e5 119 bool connect(const char* simpin = NULL,
mazgch 94:d697fe11f3e5 120 const char* apn = NULL, const char* username = NULL,
mazgch 94:d697fe11f3e5 121 const char* password = NULL, Auth auth = AUTH_DETECT,
mazgch 75:ce6e12067d0c 122 PinName pn MDM_IF( = MDMPWRON, = D4));
mazgch 57:869bd35f44cc 123
mazgch 31:a0bed6c1e05d 124 /** register (Attach) the MT to the GPRS service.
mazgch 57:869bd35f44cc 125 \param simpin a optional pin of the SIM card
mazgch 31:a0bed6c1e05d 126 \param status an optional struture to with device information
mazgch 31:a0bed6c1e05d 127 \return true if successful, false otherwise
mazgch 31:a0bed6c1e05d 128 */
mazgch 123:66cef6353b13 129 virtual bool init(const char* simpin = NULL, DevStatus* status = NULL,
mazgch 75:ce6e12067d0c 130 PinName pn MDM_IF( = MDMPWRON, = D4));
mazgch 123:66cef6353b13 131
mazgch 120:0e718a4ea25e 132 /** get the current device status
mazgch 120:0e718a4ea25e 133 \param strocture holding the device information.
mazgch 120:0e718a4ea25e 134 */
mazgch 123:66cef6353b13 135 void getDevStatus(MDMParser::DevStatus* dev) { memcpy(dev, &_dev, sizeof(DevStatus)); }
mazgch 75:ce6e12067d0c 136
mazgch 75:ce6e12067d0c 137 /** register to the network
mazgch 75:ce6e12067d0c 138 \param status an optional structure to with network information
mazgch 75:ce6e12067d0c 139 \param timeout_ms -1 blocking, else non blocking timeout in ms
mazgch 75:ce6e12067d0c 140 \return true if successful and connected to network, false otherwise
mazgch 75:ce6e12067d0c 141 */
mazgch 75:ce6e12067d0c 142 bool registerNet(NetStatus* status = NULL, int timeout_ms = 180000);
mazgch 31:a0bed6c1e05d 143
mazgch 31:a0bed6c1e05d 144 /** check if the network is available
mazgch 31:a0bed6c1e05d 145 \param status an optional structure to with network information
mazgch 31:a0bed6c1e05d 146 \return true if successful and connected to network, false otherwise
mazgch 31:a0bed6c1e05d 147 */
mazgch 31:a0bed6c1e05d 148 bool checkNetStatus(NetStatus* status = NULL);
mazgch 31:a0bed6c1e05d 149
mazgch 31:a0bed6c1e05d 150 /** Power off the MT, This function has to be called prior to
mazgch 31:a0bed6c1e05d 151 switching off the supply.
mazgch 31:a0bed6c1e05d 152 \return true if successfully, false otherwise
mazgch 31:a0bed6c1e05d 153 */
mazgch 31:a0bed6c1e05d 154 bool powerOff(void);
mazgch 31:a0bed6c1e05d 155
mazgch 31:a0bed6c1e05d 156 // ----------------------------------------------------------------
mazgch 31:a0bed6c1e05d 157 // Data Connection (GPRS)
mazgch 31:a0bed6c1e05d 158 // ----------------------------------------------------------------
mazgch 31:a0bed6c1e05d 159
mazgch 31:a0bed6c1e05d 160 /** register (Attach) the MT to the GPRS service.
mazgch 31:a0bed6c1e05d 161 \param apn the of the network provider e.g. "internet" or "apn.provider.com"
mazgch 57:869bd35f44cc 162 \param username is the user name text string for the authentication phase
mazgch 31:a0bed6c1e05d 163 \param password is the password text string for the authentication phase
mazgch 80:34985b4d821e 164 \param auth is the authentication mode (CHAP,PAP,NONE or DETECT)
mazgch 31:a0bed6c1e05d 165 \return the ip that is assigned
mazgch 31:a0bed6c1e05d 166 */
mazgch 79:291df065e345 167 MDMParser::IP join(const char* apn = NULL, const char* username = NULL,
mazgch 79:291df065e345 168 const char* password = NULL, Auth auth = AUTH_DETECT);
mazgch 31:a0bed6c1e05d 169
mazgch 31:a0bed6c1e05d 170 /** deregister (detach) the MT from the GPRS service.
mazgch 31:a0bed6c1e05d 171 \return true if successful, false otherwise
mazgch 31:a0bed6c1e05d 172 */
mazgch 31:a0bed6c1e05d 173 bool disconnect(void);
mazgch 31:a0bed6c1e05d 174
mazgch 31:a0bed6c1e05d 175 /** Translates a domain name to an IP address
mazgch 31:a0bed6c1e05d 176 \param host the domain name to translate e.g. "u-blox.com"
mazgch 31:a0bed6c1e05d 177 \return the IP if successful, 0 otherwise
mazgch 31:a0bed6c1e05d 178 */
mazgch 31:a0bed6c1e05d 179 MDMParser::IP gethostbyname(const char* host);
mazgch 31:a0bed6c1e05d 180
mazgch 120:0e718a4ea25e 181 /** get the current assigned IP address
mazgch 120:0e718a4ea25e 182 \return the ip that is assigned
mazgch 120:0e718a4ea25e 183 */
mazgch 123:66cef6353b13 184 MDMParser::IP getIpAddress(void) { return _ip; }
mazgch 123:66cef6353b13 185
mazgch 31:a0bed6c1e05d 186 // ----------------------------------------------------------------
mazgch 31:a0bed6c1e05d 187 // Sockets
mazgch 31:a0bed6c1e05d 188 // ----------------------------------------------------------------
mazgch 31:a0bed6c1e05d 189
mazgch 31:a0bed6c1e05d 190 //! Type of IP protocol
mazgch 31:a0bed6c1e05d 191 typedef enum { IPPROTO_TCP, IPPROTO_UDP } IpProtocol;
mazgch 31:a0bed6c1e05d 192
mazgch 31:a0bed6c1e05d 193 //! Socket error return codes
mazgch 31:a0bed6c1e05d 194 #define SOCKET_ERROR -1
mazgch 31:a0bed6c1e05d 195
mazgch 63:42cb563a25bc 196 /** Create a socket for a ip protocol (and optionaly bind)
mazgch 31:a0bed6c1e05d 197 \param ipproto the protocol (UDP or TCP)
mazgch 63:42cb563a25bc 198 \param port in case of UDP, this optional port where it is bind
mazgch 31:a0bed6c1e05d 199 \return the socket handle if successful or SOCKET_ERROR on failure
mazgch 31:a0bed6c1e05d 200 */
mazgch 63:42cb563a25bc 201 int socketSocket(IpProtocol ipproto, int port = -1);
mazgch 31:a0bed6c1e05d 202
mazgch 31:a0bed6c1e05d 203 /** make a socket connection
mazgch 31:a0bed6c1e05d 204 \param socket the socket handle
mazgch 31:a0bed6c1e05d 205 \param host the domain name to connect e.g. "u-blox.com"
mazgch 31:a0bed6c1e05d 206 \param port the port to connect
mazgch 31:a0bed6c1e05d 207 \return true if successfully, false otherwise
mazgch 31:a0bed6c1e05d 208 */
mazgch 31:a0bed6c1e05d 209 bool socketConnect(int socket, const char* host, int port);
mazgch 31:a0bed6c1e05d 210
mazgch 44:9d12223b78ff 211 /** make a socket connection
mazgch 44:9d12223b78ff 212 \param socket the socket handle
mazgch 44:9d12223b78ff 213 \return true if connected, false otherwise
mazgch 44:9d12223b78ff 214 */
mazgch 44:9d12223b78ff 215 bool socketIsConnected(int socket);
mazgch 44:9d12223b78ff 216
mazgch 44:9d12223b78ff 217 /** Get the number of bytes pending for reading for this socket
mazgch 44:9d12223b78ff 218 \param socket the socket handle
mazgch 44:9d12223b78ff 219 \param timeout_ms -1 blocking, else non blocking timeout in ms
mazgch 44:9d12223b78ff 220 \return 0 if successful or SOCKET_ERROR on failure
mazgch 44:9d12223b78ff 221 */
mazgch 66:69072b3c5bca 222 bool socketSetBlocking(int socket, int timeout_ms);
mazgch 44:9d12223b78ff 223
mazgch 31:a0bed6c1e05d 224 /** Write socket data
mazgch 31:a0bed6c1e05d 225 \param socket the socket handle
mazgch 31:a0bed6c1e05d 226 \param buf the buffer to write
mazgch 31:a0bed6c1e05d 227 \param len the size of the buffer to write
mazgch 31:a0bed6c1e05d 228 \return the size written or SOCKET_ERROR on failure
mazgch 31:a0bed6c1e05d 229 */
mazgch 31:a0bed6c1e05d 230 int socketSend(int socket, const char * buf, int len);
mazgch 31:a0bed6c1e05d 231
mazgch 31:a0bed6c1e05d 232 /** Write socket data to a IP
mazgch 31:a0bed6c1e05d 233 \param socket the socket handle
mazgch 31:a0bed6c1e05d 234 \param ip the ip to send to
mazgch 31:a0bed6c1e05d 235 \param port the port to send to
mazgch 31:a0bed6c1e05d 236 \param buf the buffer to write
mazgch 31:a0bed6c1e05d 237 \param len the size of the buffer to write
mazgch 31:a0bed6c1e05d 238 \return the size written or SOCKET_ERROR on failure
mazgch 31:a0bed6c1e05d 239 */
mazgch 31:a0bed6c1e05d 240 int socketSendTo(int socket, IP ip, int port, const char * buf, int len);
mazgch 31:a0bed6c1e05d 241
mazgch 31:a0bed6c1e05d 242 /** Get the number of bytes pending for reading for this socket
mazgch 31:a0bed6c1e05d 243 \param socket the socket handle
mazgch 31:a0bed6c1e05d 244 \return the number of bytes pending or SOCKET_ERROR on failure
mazgch 31:a0bed6c1e05d 245 */
mazgch 31:a0bed6c1e05d 246 int socketReadable(int socket);
mazgch 31:a0bed6c1e05d 247
mazgch 31:a0bed6c1e05d 248 /** Read this socket
mazgch 31:a0bed6c1e05d 249 \param socket the socket handle
mazgch 31:a0bed6c1e05d 250 \param buf the buffer to read into
mazgch 31:a0bed6c1e05d 251 \param len the size of the buffer to read into
mazgch 31:a0bed6c1e05d 252 \return the number of bytes read or SOCKET_ERROR on failure
mazgch 31:a0bed6c1e05d 253 */
mazgch 31:a0bed6c1e05d 254 int socketRecv(int socket, char* buf, int len);
mazgch 31:a0bed6c1e05d 255
mazgch 31:a0bed6c1e05d 256 /** Read from this socket
mazgch 31:a0bed6c1e05d 257 \param socket the socket handle
mazgch 63:42cb563a25bc 258 \param ip the ip of host where the data originates from
mazgch 63:42cb563a25bc 259 \param port the port where the data originates from
mazgch 31:a0bed6c1e05d 260 \param buf the buffer to read into
mazgch 31:a0bed6c1e05d 261 \param len the size of the buffer to read into
mazgch 31:a0bed6c1e05d 262 \return the number of bytes read or SOCKET_ERROR on failure
mazgch 31:a0bed6c1e05d 263 */
mazgch 63:42cb563a25bc 264 int socketRecvFrom(int socket, IP* ip, int* port, char* buf, int len);
mazgch 31:a0bed6c1e05d 265
mazgch 31:a0bed6c1e05d 266 /** Close a connectied socket (that was connected with #socketConnect)
mazgch 31:a0bed6c1e05d 267 \param socket the socket handle
mazgch 31:a0bed6c1e05d 268 \return true if successfully, false otherwise
mazgch 31:a0bed6c1e05d 269 */
mazgch 31:a0bed6c1e05d 270 bool socketClose(int socket);
mazgch 31:a0bed6c1e05d 271
mazgch 31:a0bed6c1e05d 272 /** Free the socket (that was allocated before by #socketSocket)
mazgch 31:a0bed6c1e05d 273 \param socket the socket handle
mazgch 31:a0bed6c1e05d 274 \return true if successfully, false otherwise
mazgch 31:a0bed6c1e05d 275 */
mazgch 31:a0bed6c1e05d 276 bool socketFree(int socket);
fdilenarda 135:cbccf4052d45 277
fdilenarda 135:cbccf4052d45 278 // ----------------------------------------------------------------
fdilenarda 135:cbccf4052d45 279 // HTTP
fdilenarda 135:cbccf4052d45 280 // ----------------------------------------------------------------
fdilenarda 135:cbccf4052d45 281
fdilenarda 135:cbccf4052d45 282 //! Type of HTTP Operational Codes (reference to HTTP control +UHTTP)
fdilenarda 135:cbccf4052d45 283 typedef enum { HTTP_IP_ADDRESS, HTTP_SERVER_NAME, HTTP_USER_NAME, HTTP_PASSWORD, \
fdilenarda 135:cbccf4052d45 284 HTTP_AUTH_TYPE, HTTP_PORT, HTTP_SECURE } HttpOpCode;
fdilenarda 135:cbccf4052d45 285
fdilenarda 135:cbccf4052d45 286 //! Type of HTTP Commands (reference to HTTP command +UHTTPC)
fdilenarda 135:cbccf4052d45 287 typedef enum { HTTP_HEAD, HTTP_GET, HTTP_DELETE, HTTP_PUT, \
fdilenarda 135:cbccf4052d45 288 HTTP_POST_FILE, HTTP_POST_DATA } HttpCmd;
fdilenarda 135:cbccf4052d45 289
fdilenarda 135:cbccf4052d45 290 //! HTTP Profile error return codes
fdilenarda 135:cbccf4052d45 291 #define HTTP_PROF_ERROR -1
fdilenarda 135:cbccf4052d45 292
fdilenarda 135:cbccf4052d45 293 /** find HTTP profile
fdilenarda 135:cbccf4052d45 294 \return true if successfully, false otherwise
fdilenarda 135:cbccf4052d45 295 */
fdilenarda 135:cbccf4052d45 296 int httpFindProfile();
fdilenarda 135:cbccf4052d45 297
fdilenarda 135:cbccf4052d45 298 /** get the number of bytes pending for reading for this HTTP profile
fdilenarda 135:cbccf4052d45 299 \param profile the HTTP profile handle
fdilenarda 135:cbccf4052d45 300 \param timeout_ms -1 blocking, else non blocking timeout in ms
fdilenarda 135:cbccf4052d45 301 \return 0 if successful or SOCKET_ERROR on failure
fdilenarda 135:cbccf4052d45 302 */
fdilenarda 135:cbccf4052d45 303 bool httpSetBlocking(int profile, int timeout_ms);
fdilenarda 135:cbccf4052d45 304
fdilenarda 135:cbccf4052d45 305 /** set the HTTP profile for commands management
fdilenarda 135:cbccf4052d45 306 \param profile the HTTP profile handle
fdilenarda 135:cbccf4052d45 307 \return true if successfully, false otherwise
fdilenarda 135:cbccf4052d45 308 */
fdilenarda 135:cbccf4052d45 309 bool httpSetProfileForCmdMng(int profile);
fdilenarda 135:cbccf4052d45 310
fdilenarda 135:cbccf4052d45 311 /** free the HTTP profile
fdilenarda 135:cbccf4052d45 312 \param profile the HTTP profile handle
fdilenarda 135:cbccf4052d45 313 \return true if successfully, false otherwise
fdilenarda 135:cbccf4052d45 314 */
fdilenarda 135:cbccf4052d45 315 bool httpFreeProfile(int profile);
fdilenarda 135:cbccf4052d45 316
fdilenarda 135:cbccf4052d45 317 /** reset HTTP profile
fdilenarda 135:cbccf4052d45 318 \param httpProfile the HTTP profile to be reset
fdilenarda 135:cbccf4052d45 319 \return true if successfully, false otherwise
fdilenarda 135:cbccf4052d45 320 */
fdilenarda 135:cbccf4052d45 321 bool httpResetProfile(int httpProfile);
fdilenarda 135:cbccf4052d45 322
fdilenarda 135:cbccf4052d45 323 /** set HTTP parameters
fdilenarda 135:cbccf4052d45 324 \param httpProfile the HTTP profile identifier
fdilenarda 135:cbccf4052d45 325 \param httpOpCode the HTTP operation code
fdilenarda 135:cbccf4052d45 326 \param httpInPar the HTTP input parameter
fdilenarda 135:cbccf4052d45 327 \return true if successfully, false otherwise
fdilenarda 135:cbccf4052d45 328 */
fdilenarda 135:cbccf4052d45 329 bool httpSetPar(int httpProfile, HttpOpCode httpOpCode, const char * httpInPar);
fdilenarda 135:cbccf4052d45 330
fdilenarda 135:cbccf4052d45 331 /** HTTP commands management
fdilenarda 135:cbccf4052d45 332 \param httpProfile the HTTP profile identifier
fdilenarda 135:cbccf4052d45 333 \param httpCmdCode the HTTP command code
fdilenarda 135:cbccf4052d45 334 \param httpPath the path of HTTP server resource
fdilenarda 135:cbccf4052d45 335 \param httpOut the filename where the HTTP server response will be stored
fdilenarda 135:cbccf4052d45 336 \param httpIn the input data (filename or string) to be sent
fdilenarda 135:cbccf4052d45 337 to the HTTP server with the command request
fdilenarda 135:cbccf4052d45 338 \param httpContentType the HTTP Content-Type identifier
fdilenarda 135:cbccf4052d45 339 \param httpCustomPar the parameter for an user defined HTTP Content-Type
fdilenarda 135:cbccf4052d45 340 \param buf the buffer to read into
fdilenarda 135:cbccf4052d45 341 \param len the size of the buffer to read into
fdilenarda 135:cbccf4052d45 342 \return true if successfully, false otherwise
fdilenarda 135:cbccf4052d45 343 */
fdilenarda 135:cbccf4052d45 344 bool httpCommand(int httpProfile, HttpCmd httpCmdCode, const char* httpPath, \
fdilenarda 135:cbccf4052d45 345 const char* httpOut, const char* httpIn, int httpContentType, \
fdilenarda 135:cbccf4052d45 346 const char* httpCustomPar, char* buf, int len);
fdilenarda 135:cbccf4052d45 347
fdilenarda 135:cbccf4052d45 348 /** get HTTP commands
fdilenarda 135:cbccf4052d45 349 \param httpCmdCode the HTTP command code (reference also the enum format)
fdilenarda 135:cbccf4052d45 350 \return HTTP command in string format
fdilenarda 135:cbccf4052d45 351 */
fdilenarda 135:cbccf4052d45 352 const char* getHTTPcmd(int httpCmdCode);
fdilenarda 135:cbccf4052d45 353
mazgch 31:a0bed6c1e05d 354 // ----------------------------------------------------------------
mazgch 31:a0bed6c1e05d 355 // SMS Short Message Service
mazgch 31:a0bed6c1e05d 356 // ----------------------------------------------------------------
mazgch 31:a0bed6c1e05d 357
mazgch 31:a0bed6c1e05d 358 /** count the number of sms in the device and optionally return a
mazgch 31:a0bed6c1e05d 359 list with indexes from the storage locations in the device.
mazgch 31:a0bed6c1e05d 360 \param stat what type of messages you can use use
mazgch 31:a0bed6c1e05d 361 "REC UNREAD", "REC READ", "STO UNSENT", "STO SENT", "ALL"
mazgch 31:a0bed6c1e05d 362 \param ix list where to save the storage positions
mazgch 31:a0bed6c1e05d 363 \param num number of elements in the list
mazgch 31:a0bed6c1e05d 364 \return the number of messages, this can be bigger than num, -1 on failure
mazgch 31:a0bed6c1e05d 365 */
mazgch 31:a0bed6c1e05d 366 int smsList(const char* stat = "ALL", int* ix = NULL, int num = 0);
mazgch 31:a0bed6c1e05d 367
mazgch 31:a0bed6c1e05d 368 /** Read a Message from a storage position
mazgch 31:a0bed6c1e05d 369 \param ix the storage position to read
mazgch 31:a0bed6c1e05d 370 \param num the originator address (~16 chars)
mazgch 31:a0bed6c1e05d 371 \param buf a buffer where to save the sm
mazgch 31:a0bed6c1e05d 372 \param len the length of the sm
mazgch 31:a0bed6c1e05d 373 \return true if successful, false otherwise
mazgch 31:a0bed6c1e05d 374 */
mazgch 31:a0bed6c1e05d 375 bool smsRead(int ix, char* num, char* buf, int len);
mazgch 31:a0bed6c1e05d 376
mazgch 31:a0bed6c1e05d 377 /** Send a message to a recipient
mazgch 31:a0bed6c1e05d 378 \param ix the storage position to delete
mazgch 31:a0bed6c1e05d 379 \return true if successful, false otherwise
mazgch 31:a0bed6c1e05d 380 */
mazgch 31:a0bed6c1e05d 381 bool smsDelete(int ix);
mazgch 31:a0bed6c1e05d 382
mazgch 31:a0bed6c1e05d 383 /** Send a message to a recipient
mazgch 31:a0bed6c1e05d 384 \param num the phone number of the recipient
mazgch 31:a0bed6c1e05d 385 \param buf the content of the message to sent
mazgch 31:a0bed6c1e05d 386 \return true if successful, false otherwise
mazgch 31:a0bed6c1e05d 387 */
mazgch 31:a0bed6c1e05d 388 bool smsSend(const char* num, const char* buf);
mazgch 31:a0bed6c1e05d 389
mazgch 31:a0bed6c1e05d 390 // ----------------------------------------------------------------
mazgch 31:a0bed6c1e05d 391 // USSD Unstructured Supplementary Service Data
mazgch 31:a0bed6c1e05d 392 // ----------------------------------------------------------------
mazgch 31:a0bed6c1e05d 393
mazgch 31:a0bed6c1e05d 394 /** Read a Message from a storage position
mazgch 31:a0bed6c1e05d 395 \param cmd the ussd command to send e.g "*#06#"
mazgch 31:a0bed6c1e05d 396 \param buf a buffer where to save the reply
mazgch 31:a0bed6c1e05d 397 \return true if successful, false otherwise
mazgch 31:a0bed6c1e05d 398 */
mazgch 31:a0bed6c1e05d 399 bool ussdCommand(const char* cmd, char* buf);
mazgch 31:a0bed6c1e05d 400
mazgch 38:e6cab4632d84 401 // ----------------------------------------------------------------
mazgch 80:34985b4d821e 402 // FILE
mazgch 80:34985b4d821e 403 // ----------------------------------------------------------------
mazgch 80:34985b4d821e 404
mazgch 80:34985b4d821e 405 /** Delete a file in the local file system
mazgch 80:34985b4d821e 406 \param filename the name of the file
mazgch 80:34985b4d821e 407 \return true if successful, false otherwise
mazgch 80:34985b4d821e 408 */
mazgch 80:34985b4d821e 409 bool delFile(const char* filename);
mazgch 80:34985b4d821e 410
mazgch 80:34985b4d821e 411 /** Write some data to a file in the local file system
mazgch 80:34985b4d821e 412 \param filename the name of the file
mazgch 80:34985b4d821e 413 \param buf the data to write
mazgch 80:34985b4d821e 414 \param len the size of the data to write
mazgch 80:34985b4d821e 415 \return the number of bytes written
mazgch 80:34985b4d821e 416 */
mazgch 80:34985b4d821e 417 int writeFile(const char* filename, const char* buf, int len);
mazgch 80:34985b4d821e 418
fdilenarda 135:cbccf4052d45 419 /** Read a file from the local file system
mazgch 80:34985b4d821e 420 \param filename the name of the file
mazgch 80:34985b4d821e 421 \param buf a buffer to hold the data
mazgch 80:34985b4d821e 422 \param len the size to read
mazgch 80:34985b4d821e 423 \return the number of bytes read
mazgch 80:34985b4d821e 424 */
mazgch 80:34985b4d821e 425 int readFile(const char* filename, char* buf, int len);
fdilenarda 135:cbccf4052d45 426
fdilenarda 135:cbccf4052d45 427 /** Read a file from the local file system
fdilenarda 135:cbccf4052d45 428 (the file size is greater than MAX_SIZE bytes)
fdilenarda 135:cbccf4052d45 429 \param filename the name of the file
fdilenarda 135:cbccf4052d45 430 \param buf a buffer to hold the data
fdilenarda 135:cbccf4052d45 431 \param len the size to read
fdilenarda 135:cbccf4052d45 432 \return the number of bytes read
fdilenarda 135:cbccf4052d45 433 */
fdilenarda 135:cbccf4052d45 434 int readFileNew(const char* filename, char* buf, int len);
fdilenarda 135:cbccf4052d45 435
fdilenarda 135:cbccf4052d45 436 /** Retrieve information about the dimension of a file from the local FFS
fdilenarda 135:cbccf4052d45 437 \param filename the name of the file
fdilenarda 135:cbccf4052d45 438 \return the file dimension in number of bytes
fdilenarda 135:cbccf4052d45 439 */
fdilenarda 135:cbccf4052d45 440 int infoFile(const char* filename);
fdilenarda 135:cbccf4052d45 441
msinig 133:57b208dd96fb 442 // ----------------------------------------------------------------
msinig 133:57b208dd96fb 443 // Cell Locate
msinig 133:57b208dd96fb 444 // ----------------------------------------------------------------
msinig 133:57b208dd96fb 445
msinig 133:57b208dd96fb 446 /** Configures CellLocate Http Aiding server
msinig 133:57b208dd96fb 447 \server_1 Host name of the primary MGA server
msinig 133:57b208dd96fb 448 \server_2 Host name of the secondary MGA server
msinig 133:57b208dd96fb 449 \token Authentication Token for MGA server access
msinig 133:57b208dd96fb 450 \days The number of days into the future the Offline data for the u-blox 7
msinig 133:57b208dd96fb 451 \period The number of weeks into the future the Offline data for u-blox M8
msinig 133:57b208dd96fb 452 \resolution Resolution of offline data for u-blox M8: 1 everyday, 0 every other day
msinig 133:57b208dd96fb 453 */
msinig 133:57b208dd96fb 454 int cellLocSrvHttp(const char* token, const char* server_1 = "cell-live1.services.u-blox.com", \
msinig 133:57b208dd96fb 455 const char* server_2 = "cell-live2.services.u-blox.com", int days = 14, int period = 4, int resolution = 1);
msinig 133:57b208dd96fb 456
msinig 133:57b208dd96fb 457 /** Configures CellLocate Udp Aiding server
msinig 133:57b208dd96fb 458 \server_1 Host name of the primary MGA server
msinig 133:57b208dd96fb 459 \port Server port
msinig 133:57b208dd96fb 460 \latency Expected network latency in seconds from 0 to 10000ms
msinig 133:57b208dd96fb 461 \mode Assist now management, mode of operation: 0 data downloaded at GNSS power up,
msinig 133:57b208dd96fb 462 1 automatically kept alive, manual download
msinig 133:57b208dd96fb 463 */
msinig 133:57b208dd96fb 464 int cellLocSrvUdp(const char* server_1 = "cell-live1.services.u-blox.com", int port = 46434, int latency = 1000, int mode = 0);
msinig 133:57b208dd96fb 465
msinig 133:57b208dd96fb 466 /** Configures CellLocate URCs in the case of +ULOC operations
msinig 133:57b208dd96fb 467 \mode Urc configuration: 0 disabled, 1 enabled
msinig 133:57b208dd96fb 468 */
msinig 133:57b208dd96fb 469 int cellLocUnsolIndication(int mode);
msinig 133:57b208dd96fb 470
msinig 133:57b208dd96fb 471 /** Configures CellLocate location sensor
msinig 133:57b208dd96fb 472 \scanMode Network scan mode: 0 normal, 1 deep scan
msinig 133:57b208dd96fb 473 */
msinig 133:57b208dd96fb 474 int cellLocConfigSensor(int scanMode);
msinig 133:57b208dd96fb 475
msinig 133:57b208dd96fb 476 /** Request CellLocate
msinig 133:57b208dd96fb 477 This function is not blocking, the result has to be retrived using cellLocGet
msinig 133:57b208dd96fb 478 \cb Call back function called when position is available
msinig 133:57b208dd96fb 479 \sensor Sensor selection: 0: use last fix and stop GNSS receiver, 1: use GNSS, 2: CellLocate, 3: Hybrid
msinig 133:57b208dd96fb 480 \timeout Timeout period in seconds (1 - 999)
msinig 133:57b208dd96fb 481 \accuracy Target accuracy in meters (1 - 999999)
msinig 133:57b208dd96fb 482 \numHypotesis Maximum desired number of responses from CellLocate® (up to 16)
msinig 133:57b208dd96fb 483 */
msinig 133:57b208dd96fb 484 int cellLocRequest(int sensor, int timeout, int accuracy, int numHypotesis =1);
msinig 133:57b208dd96fb 485
msinig 133:57b208dd96fb 486 /** Check if a position is available
msinig 133:57b208dd96fb 487 \data pointer to a CellLocData struct where the location will be copied in
msinig 133:57b208dd96fb 488 \return 1 if data is available, 0 otherwise
msinig 133:57b208dd96fb 489 */
msinig 133:57b208dd96fb 490 int cellLocGet(CellLocData *data);
mazgch 80:34985b4d821e 491
mazgch 80:34985b4d821e 492 // ----------------------------------------------------------------
mazgch 74:208e3e32d263 493 // DEBUG/DUMP status to standard out (printf)
mazgch 54:7ba8e4c218e2 494 // ----------------------------------------------------------------
mazgch 54:7ba8e4c218e2 495
mazgch 74:208e3e32d263 496 /*! Set the debug level
mazgch 117:74e4e0109a9e 497 \param level -1 = OFF, 0 = ERROR, 1 = INFO(default), 2 = TRACE, 3 = ATCMD,TEST
mazgch 74:208e3e32d263 498 \return true if successful, false not possible
mazgch 74:208e3e32d263 499 */
mazgch 74:208e3e32d263 500 bool setDebug(int level);
mazgch 74:208e3e32d263 501
mazgch 73:2b32e0a21df2 502 //! helper type for DPRINT
mazgch 73:2b32e0a21df2 503 typedef int (*_DPRINT)(void* param, char const * format, ...);
mazgch 73:2b32e0a21df2 504
mazgch 73:2b32e0a21df2 505 //! helper to declate templates and void versions
mazgch 73:2b32e0a21df2 506 #define _DUMP_TEMPLATE(func, type, arg) \
mazgch 73:2b32e0a21df2 507 template<class T> \
mazgch 73:2b32e0a21df2 508 inline void func(type arg, \
mazgch 73:2b32e0a21df2 509 int (*dprint)( T* param, char const * format, ...), \
mazgch 73:2b32e0a21df2 510 T* param) { func(arg, (_DPRINT)dprint, (void*)param); } \
mazgch 73:2b32e0a21df2 511 static void func(type arg, \
mazgch 73:2b32e0a21df2 512 _DPRINT dprint = (_DPRINT)fprintf, \
mazgch 73:2b32e0a21df2 513 void* param = (void*)stdout);
mazgch 74:208e3e32d263 514
mazgch 54:7ba8e4c218e2 515 /** dump the device status to stdout using printf
mazgch 54:7ba8e4c218e2 516 \param status the status to convert to textual form,
mazgch 54:7ba8e4c218e2 517 unavailable fields are ommited (not printed)
mazgch 73:2b32e0a21df2 518 \param dprint a function pointer
mazgch 73:2b32e0a21df2 519 \param param the irst argument passed to dprint
mazgch 54:7ba8e4c218e2 520 */
mazgch 73:2b32e0a21df2 521 _DUMP_TEMPLATE(dumpDevStatus, MDMParser::DevStatus*, status)
mazgch 54:7ba8e4c218e2 522
mazgch 54:7ba8e4c218e2 523 /** dump the network status to stdout using printf
mazgch 54:7ba8e4c218e2 524 \param status the status to convert to textual form,
mazgch 54:7ba8e4c218e2 525 unavailable fields are ommited (not printed)
mazgch 73:2b32e0a21df2 526 \param dprint a function pointer
mazgch 73:2b32e0a21df2 527 \param param the irst argument passed to dprint
mazgch 54:7ba8e4c218e2 528 */
mazgch 73:2b32e0a21df2 529 _DUMP_TEMPLATE(dumpNetStatus, MDMParser::NetStatus*, status)
mazgch 73:2b32e0a21df2 530
mazgch 54:7ba8e4c218e2 531 /** dump the ip address to stdout using printf
mazgch 54:7ba8e4c218e2 532 \param ip the ip to convert to textual form,
mazgch 54:7ba8e4c218e2 533 unavailable fields are ommited (not printed)
mazgch 73:2b32e0a21df2 534 \param dprint a function pointer
mazgch 73:2b32e0a21df2 535 \param param the irst argument passed to dprint
mazgch 54:7ba8e4c218e2 536 */
mazgch 73:2b32e0a21df2 537 _DUMP_TEMPLATE(dumpIp, MDMParser::IP, ip)
mazgch 73:2b32e0a21df2 538
mazgch 54:7ba8e4c218e2 539 // ----------------------------------------------------------------
mazgch 31:a0bed6c1e05d 540 // Parseing
mazgch 31:a0bed6c1e05d 541 // ----------------------------------------------------------------
mazgch 31:a0bed6c1e05d 542
mazgch 51:e7b81c31baec 543 enum {
mazgch 51:e7b81c31baec 544 // waitFinalResp Responses
mazgch 52:8071747a7cb3 545 NOT_FOUND = 0,
mazgch 52:8071747a7cb3 546 WAIT = -1, // TIMEOUT
mazgch 52:8071747a7cb3 547 RESP_OK = -2,
mazgch 52:8071747a7cb3 548 RESP_ERROR = -3,
mazgch 52:8071747a7cb3 549 RESP_PROMPT = -4,
msinig 134:2fbd5723e063 550 RESP_ERROR_CME= -5,
mazgch 31:a0bed6c1e05d 551
mazgch 51:e7b81c31baec 552 // getLine Responses
mazgch 51:e7b81c31baec 553 #define LENGTH(x) (x & 0x00FFFF) //!< extract/mask the length
mazgch 51:e7b81c31baec 554 #define TYPE(x) (x & 0xFF0000) //!< extract/mask the type
mazgch 51:e7b81c31baec 555
mazgch 51:e7b81c31baec 556 TYPE_UNKNOWN = 0x000000,
mazgch 51:e7b81c31baec 557 TYPE_OK = 0x110000,
mazgch 51:e7b81c31baec 558 TYPE_ERROR = 0x120000,
msinig 134:2fbd5723e063 559 TYPE_ERROR_CME = 0x130000,
mazgch 51:e7b81c31baec 560 TYPE_RING = 0x210000,
mazgch 51:e7b81c31baec 561 TYPE_CONNECT = 0x220000,
mazgch 51:e7b81c31baec 562 TYPE_NOCARRIER = 0x230000,
mazgch 51:e7b81c31baec 563 TYPE_NODIALTONE = 0x240000,
mazgch 51:e7b81c31baec 564 TYPE_BUSY = 0x250000,
mazgch 51:e7b81c31baec 565 TYPE_NOANSWER = 0x260000,
mazgch 51:e7b81c31baec 566 TYPE_PROMPT = 0x300000,
mazgch 51:e7b81c31baec 567 TYPE_PLUS = 0x400000,
mazgch 66:69072b3c5bca 568 TYPE_TEXT = 0x500000,
mazgch 66:69072b3c5bca 569
mazgch 66:69072b3c5bca 570 // special timout constant
mazgch 66:69072b3c5bca 571 TIMEOUT_BLOCKING = -1
mazgch 51:e7b81c31baec 572 };
mazgch 31:a0bed6c1e05d 573
mazgch 31:a0bed6c1e05d 574 /** Get a line from the physical interface. This function need
mazgch 31:a0bed6c1e05d 575 to be implemented in a inherited class. Usually just calls
mazgch 31:a0bed6c1e05d 576 #_getLine on the rx buffer pipe.
mazgch 31:a0bed6c1e05d 577
mazgch 31:a0bed6c1e05d 578 \param buf the buffer to store it
mazgch 31:a0bed6c1e05d 579 \param buf size of the buffer
mazgch 31:a0bed6c1e05d 580 \return type and length if something was found,
mazgch 31:a0bed6c1e05d 581 WAIT if not enough data is available
mazgch 31:a0bed6c1e05d 582 NOT_FOUND if nothing was found
mazgch 31:a0bed6c1e05d 583 */
mazgch 31:a0bed6c1e05d 584 virtual int getLine(char* buf, int len) = 0;
mazgch 28:4d9509e3b1cf 585
mazgch 101:edfeb8af206e 586 /* clear the pending input data
mazgch 101:edfeb8af206e 587 */
mazgch 101:edfeb8af206e 588 virtual void purge(void) = 0;
mazgch 101:edfeb8af206e 589
mazgch 31:a0bed6c1e05d 590 /** Write data to the device
mazgch 31:a0bed6c1e05d 591 \param buf the buffer to write
mazgch 31:a0bed6c1e05d 592 \param buf size of the buffer to write
mazgch 31:a0bed6c1e05d 593 \return bytes written
mazgch 31:a0bed6c1e05d 594 */
mazgch 31:a0bed6c1e05d 595 virtual int send(const char* buf, int len);
mazgch 21:c4d64830bf02 596
mazgch 31:a0bed6c1e05d 597 /** Write formated date to the physical interface (printf style)
mazgch 31:a0bed6c1e05d 598 \param fmt the format string
mazgch 31:a0bed6c1e05d 599 \param .. variable arguments to be formated
mazgch 31:a0bed6c1e05d 600 \return bytes written
mazgch 31:a0bed6c1e05d 601 */
mazgch 21:c4d64830bf02 602 int sendFormated(const char* format, ...);
mazgch 26:07be5faf8925 603
mazgch 31:a0bed6c1e05d 604 /** callback function for #waitFinalResp with void* as argument
mazgch 31:a0bed6c1e05d 605 \param type the #getLine response
mazgch 31:a0bed6c1e05d 606 \param buf the parsed line
mazgch 31:a0bed6c1e05d 607 \param len the size of the parsed line
mazgch 31:a0bed6c1e05d 608 \param param the optional argument passed to #waitFinalResp
mazgch 31:a0bed6c1e05d 609 \return WAIT if processing should continue,
mazgch 31:a0bed6c1e05d 610 any other value aborts #waitFinalResp and this retunr value retuned
mazgch 31:a0bed6c1e05d 611 */
mazgch 26:07be5faf8925 612 typedef int (*_CALLBACKPTR)(int type, const char* buf, int len, void* param);
mazgch 31:a0bed6c1e05d 613
mazgch 31:a0bed6c1e05d 614 /** Wait for a final respons
mazgch 31:a0bed6c1e05d 615 \param cb the optional callback function
mazgch 31:a0bed6c1e05d 616 \param param the optional callback function parameter
mazgch 58:e38a2e942fbb 617 \param timeout_ms the timeout to wait (See Estimated command
mazgch 58:e38a2e942fbb 618 response time of AT manual)
mazgch 31:a0bed6c1e05d 619 */
mazgch 31:a0bed6c1e05d 620 int waitFinalResp(_CALLBACKPTR cb = NULL,
mazgch 26:07be5faf8925 621 void* param = NULL,
mazgch 58:e38a2e942fbb 622 int timeout_ms = 10000);
mazgch 31:a0bed6c1e05d 623
mazgch 31:a0bed6c1e05d 624 /** template version of #waitFinalResp when using callbacks,
mazgch 31:a0bed6c1e05d 625 This template will allow the compiler to do type cheking but
mazgch 31:a0bed6c1e05d 626 internally symply casts the arguments and call the (void*)
mazgch 31:a0bed6c1e05d 627 version of #waitFinalResp.
mazgch 31:a0bed6c1e05d 628 \sa waitFinalResp
mazgch 31:a0bed6c1e05d 629 */
mazgch 26:07be5faf8925 630 template<class T>
mazgch 73:2b32e0a21df2 631 inline int waitFinalResp(int (*cb)(int type, const char* buf, int len, T* param),
mazgch 73:2b32e0a21df2 632 T* param,
mazgch 73:2b32e0a21df2 633 int timeout_ms = 10000)
mazgch 26:07be5faf8925 634 {
mazgch 26:07be5faf8925 635 return waitFinalResp((_CALLBACKPTR)cb, (void*)param, timeout_ms);
mazgch 26:07be5faf8925 636 }
mazgch 31:a0bed6c1e05d 637
mazgch 18:e5697801df29 638 protected:
mazgch 31:a0bed6c1e05d 639 /** Write bytes to the physical interface. This function should be
mazgch 31:a0bed6c1e05d 640 implemented in a inherited class.
mazgch 31:a0bed6c1e05d 641 \param buf the buffer to write
mazgch 31:a0bed6c1e05d 642 \param buf size of the buffer to write
mazgch 31:a0bed6c1e05d 643 \return bytes written
mazgch 31:a0bed6c1e05d 644 */
mazgch 18:e5697801df29 645 virtual int _send(const void* buf, int len) = 0;
mazgch 31:a0bed6c1e05d 646
mazgch 31:a0bed6c1e05d 647 /** Helper: Parse a line from the receiving buffered pipe
mazgch 31:a0bed6c1e05d 648 \param pipe the receiving buffer pipe
mazgch 31:a0bed6c1e05d 649 \param buf the parsed line
mazgch 31:a0bed6c1e05d 650 \param len the size of the parsed line
mazgch 31:a0bed6c1e05d 651 \return type and length if something was found,
mazgch 31:a0bed6c1e05d 652 WAIT if not enough data is available
mazgch 31:a0bed6c1e05d 653 NOT_FOUND if nothing was found
mazgch 31:a0bed6c1e05d 654 */
mazgch 31:a0bed6c1e05d 655 static int _getLine(Pipe<char>* pipe, char* buffer, int length);
mazgch 31:a0bed6c1e05d 656
mazgch 31:a0bed6c1e05d 657 /** Helper: Parse a match from the pipe
mazgch 31:a0bed6c1e05d 658 \param pipe the buffered pipe
mazgch 31:a0bed6c1e05d 659 \param number of bytes to parse at maximum,
mazgch 31:a0bed6c1e05d 660 \param sta the starting string, NULL if none
mazgch 31:a0bed6c1e05d 661 \param end the terminating string, NULL if none
mazgch 31:a0bed6c1e05d 662 \return size of parsed match
mazgch 31:a0bed6c1e05d 663 */
mazgch 31:a0bed6c1e05d 664 static int _parseMatch(Pipe<char>* pipe, int len, const char* sta, const char* end);
mazgch 31:a0bed6c1e05d 665
mazgch 31:a0bed6c1e05d 666 /** Helper: Parse a match from the pipe
mazgch 31:a0bed6c1e05d 667 \param pipe the buffered pipe
mazgch 31:a0bed6c1e05d 668 \param number of bytes to parse at maximum,
mazgch 31:a0bed6c1e05d 669 \param fmt the formating string (%d any number, %c any char of last %d len)
mazgch 31:a0bed6c1e05d 670 \return size of parsed match
mazgch 31:a0bed6c1e05d 671 */
mazgch 31:a0bed6c1e05d 672 static int _parseFormated(Pipe<char>* pipe, int len, const char* fmt);
mazgch 31:a0bed6c1e05d 673
mazgch 35:9275215a3a5b 674 protected:
mazgch 95:8282dbbe1492 675 // for rtos over riding by useing Rtos<MDMxx>
mazgch 95:8282dbbe1492 676 /** override in a rtos system, you us the wait function of a Thread
mazgch 95:8282dbbe1492 677 \param ms the number of milliseconds to wait
mazgch 95:8282dbbe1492 678 */
mazgch 95:8282dbbe1492 679 virtual void wait_ms(int ms) { if (ms) ::wait_ms(ms); }
mazgch 95:8282dbbe1492 680 //! override the lock in a rtos system
mazgch 95:8282dbbe1492 681 virtual void lock(void) { }
mazgch 95:8282dbbe1492 682 //! override the unlock in a rtos system
mazgch 95:8282dbbe1492 683 virtual void unlock(void) { }
mazgch 95:8282dbbe1492 684 protected:
mazgch 128:0415646a9934 685 bool _activateProfile(const char* apn, const char* username, const char* password, Auth auth);
mazgch 131:965a7cbc1e58 686 bool _activateProfileReuseExternal(void);
mazgch 128:0415646a9934 687 bool _activateProfileByCid(int cid, const char* apn, const char* username, const char* password, Auth auth);
mazgch 31:a0bed6c1e05d 688 // parsing callbacks for different AT commands and their parameter arguments
mazgch 31:a0bed6c1e05d 689 static int _cbString(int type, const char* buf, int len, char* str);
mazgch 31:a0bed6c1e05d 690 static int _cbInt(int type, const char* buf, int len, int* val);
mazgch 31:a0bed6c1e05d 691 // device
mazgch 32:8f12ac182bbb 692 static int _cbATI(int type, const char* buf, int len, Dev* dev);
mazgch 31:a0bed6c1e05d 693 static int _cbCPIN(int type, const char* buf, int len, Sim* sim);
mazgch 31:a0bed6c1e05d 694 static int _cbCCID(int type, const char* buf, int len, char* ccid);
mazgch 31:a0bed6c1e05d 695 // network
mazgch 54:7ba8e4c218e2 696 static int _cbCSQ(int type, const char* buf, int len, NetStatus* status);
mazgch 31:a0bed6c1e05d 697 static int _cbCOPS(int type, const char* buf, int len, NetStatus* status);
mazgch 31:a0bed6c1e05d 698 static int _cbCNUM(int type, const char* buf, int len, char* num);
mazgch 81:3966a5c17037 699 static int _cbUACTIND(int type, const char* buf, int len, int* i);
mazgch 131:965a7cbc1e58 700 static int _cbCGDCONT(int type, const char* buf, int len, int* cid);
mazgch 84:a05edb010176 701 static int _cbUDOPN(int type, const char* buf, int len, char* mccmnc);
mazgch 31:a0bed6c1e05d 702 // sockets
mazgch 32:8f12ac182bbb 703 static int _cbCMIP(int type, const char* buf, int len, IP* ip);
mazgch 31:a0bed6c1e05d 704 static int _cbUPSND(int type, const char* buf, int len, int* act);
mazgch 31:a0bed6c1e05d 705 static int _cbUPSND(int type, const char* buf, int len, IP* ip);
mazgch 21:c4d64830bf02 706 static int _cbUDNSRN(int type, const char* buf, int len, IP* ip);
mazgch 103:197fa7920ad8 707 static int _cbUSOCR(int type, const char* buf, int len, int* handle);
mazgch 21:c4d64830bf02 708 static int _cbUSORD(int type, const char* buf, int len, char* out);
mazgch 21:c4d64830bf02 709 typedef struct { char* buf; IP ip; int port; } USORFparam;
mazgch 21:c4d64830bf02 710 static int _cbUSORF(int type, const char* buf, int len, USORFparam* param);
mazgch 21:c4d64830bf02 711 typedef struct { char* buf; char* num; } CMGRparam;
mazgch 132:de505da3aadf 712 static int _cbCUSD(int type, const char* buf, int len, char* resp);
mazgch 31:a0bed6c1e05d 713 // sms
mazgch 31:a0bed6c1e05d 714 typedef struct { int* ix; int num; } CMGLparam;
mazgch 31:a0bed6c1e05d 715 static int _cbCMGL(int type, const char* buf, int len, CMGLparam* param);
mazgch 21:c4d64830bf02 716 static int _cbCMGR(int type, const char* buf, int len, CMGRparam* param);
mazgch 80:34985b4d821e 717 // file
mazgch 80:34985b4d821e 718 typedef struct { const char* filename; char* buf; int sz; int len; } URDFILEparam;
mazgch 115:d8d94b73c725 719 static int _cbUDELFILE(int type, const char* buf, int len, void*);
mazgch 80:34985b4d821e 720 static int _cbURDFILE(int type, const char* buf, int len, URDFILEparam* param);
fdilenarda 135:cbccf4052d45 721 static int _cbURDBLOCK(int type, const char* buf, int len, char* out);
fdilenarda 135:cbccf4052d45 722 static int _cbULSTFILE(int type, const char* buf, int len, int* infoFile);
mazgch 38:e6cab4632d84 723 // variables
mazgch 31:a0bed6c1e05d 724 DevStatus _dev; //!< collected device information
mazgch 31:a0bed6c1e05d 725 NetStatus _net; //!< collected network information
mazgch 31:a0bed6c1e05d 726 IP _ip; //!< assigned ip address
msinig 133:57b208dd96fb 727 CellLocData _loc; //!< CellLocate data
mazgch 31:a0bed6c1e05d 728 // management struture for sockets
mazgch 103:197fa7920ad8 729 typedef struct { int handle; int timeout_ms; volatile bool connected; volatile int pending; } SockCtrl;
mazgch 103:197fa7920ad8 730 // LISA-C has 6 TCP and 6 UDP sockets
mazgch 103:197fa7920ad8 731 // LISA-U and SARA-G have 7 sockets
mazgch 103:197fa7920ad8 732 SockCtrl _sockets[12];
mazgch 103:197fa7920ad8 733 int _findSocket(int handle = SOCKET_ERROR/* = CREATE*/);
fdilenarda 135:cbccf4052d45 734 // management structure for HTTP profiles
fdilenarda 135:cbccf4052d45 735 // it's possible to have up to 4 different HTTP profiles (LISA-C200, LISA-U200 and SARA-G350) having:
fdilenarda 135:cbccf4052d45 736 // param handle the current HTTP profile is in handling state or not (default value is HTTP_ERROR)
fdilenarda 135:cbccf4052d45 737 // param timeout_ms the timeout for the current HTTP command
fdilenarda 135:cbccf4052d45 738 // param pending the status for the current HTTP command (in processing state or not)
fdilenarda 135:cbccf4052d45 739 // param cmd the code for the current HTTP command
fdilenarda 135:cbccf4052d45 740 // param result the result for the current HTTP command once processed
fdilenarda 135:cbccf4052d45 741 typedef struct { int handle; int timeout_ms; bool pending; int cmd; int result; } HttpProfCtrl;
fdilenarda 135:cbccf4052d45 742 HttpProfCtrl _httpProfiles[4];
fdilenarda 135:cbccf4052d45 743 int _findProfile(int handle = HTTP_PROF_ERROR/* = CREATE*/);
mazgch 44:9d12223b78ff 744 static MDMParser* inst;
mazgch 76:f7c3dd568dae 745 bool _init;
mazgch 74:208e3e32d263 746 #ifdef TARGET_UBLOX_C027
mazgch 74:208e3e32d263 747 bool _onboard;
mazgch 74:208e3e32d263 748 #endif
mazgch 74:208e3e32d263 749 #ifdef MDM_DEBUG
mazgch 74:208e3e32d263 750 int _debugLevel;
mazgch 74:208e3e32d263 751 Timer _debugTime;
mazgch 117:74e4e0109a9e 752 void _debugPrint(int level, const char* color, const char* format, ...);
mazgch 74:208e3e32d263 753 #endif
mazgch 18:e5697801df29 754 };
mazgch 18:e5697801df29 755
mazgch 18:e5697801df29 756 // -----------------------------------------------------------------------
mazgch 18:e5697801df29 757
mazgch 38:e6cab4632d84 758 /** modem class which uses a serial port
mazgch 38:e6cab4632d84 759 as physical interface.
mazgch 38:e6cab4632d84 760 */
mazgch 18:e5697801df29 761 class MDMSerial : public SerialPipe, public MDMParser
mazgch 17:296d94a006b4 762 {
mazgch 17:296d94a006b4 763 public:
mazgch 38:e6cab4632d84 764 /** Constructor
mazgch 38:e6cab4632d84 765
mazgch 38:e6cab4632d84 766 \param tx is the serial ports transmit pin (modem to CPU)
mazgch 38:e6cab4632d84 767 \param rx is the serial ports receive pin (CPU to modem)
mazgch 38:e6cab4632d84 768 \param baudrate the baudrate of the modem use 115200
mazgch 38:e6cab4632d84 769 \param rts is the serial ports ready to send pin (CPU to modem)
mazgch 38:e6cab4632d84 770 this pin is optional
mazgch 38:e6cab4632d84 771 \param cts is the serial ports clear to send pin (modem to CPU)
mazgch 38:e6cab4632d84 772 this pin is optional, but required for power saving to be enabled
mazgch 38:e6cab4632d84 773 \param rxSize the size of the serial rx buffer
mazgch 38:e6cab4632d84 774 \param txSize the size of the serial tx buffer
mazgch 38:e6cab4632d84 775 */
mazgch 75:ce6e12067d0c 776 MDMSerial(PinName tx MDM_IF( = MDMTXD, = D1 ),
mazgch 75:ce6e12067d0c 777 PinName rx MDM_IF( = MDMRXD, = D0 ),
mazgch 75:ce6e12067d0c 778 int baudrate MDM_IF( = MDMBAUD, = 115200 ),
mazgch 35:9275215a3a5b 779 #if DEVICE_SERIAL_FC
mazgch 75:ce6e12067d0c 780 PinName rts MDM_IF( = MDMRTS, = NC /* D2 resistor R62 on shield not mounted */ ),
mazgch 75:ce6e12067d0c 781 PinName cts MDM_IF( = MDMCTS, = NC /* D3 resistor R63 on shield not mounted */ ),
mazgch 35:9275215a3a5b 782 #endif
mazgch 19:2b5d097ca15d 783 int rxSize = 256 ,
mazgch 21:c4d64830bf02 784 int txSize = 128 );
mazgch 76:f7c3dd568dae 785 //! Destructor
mazgch 93:2b5478693c20 786 virtual ~MDMSerial(void);
mazgch 123:66cef6353b13 787
mazgch 38:e6cab4632d84 788 /** Get a line from the physical interface.
mazgch 38:e6cab4632d84 789 \param buf the buffer to store it
mazgch 38:e6cab4632d84 790 \param buf size of the buffer
mazgch 38:e6cab4632d84 791 \return type and length if something was found,
mazgch 38:e6cab4632d84 792 WAIT if not enough data is available
mazgch 38:e6cab4632d84 793 NOT_FOUND if nothing was found
mazgch 38:e6cab4632d84 794 */
mazgch 18:e5697801df29 795 virtual int getLine(char* buffer, int length);
mazgch 101:edfeb8af206e 796
mazgch 101:edfeb8af206e 797 /* clear the pending input data */
mazgch 101:edfeb8af206e 798 virtual void purge(void)
mazgch 101:edfeb8af206e 799 {
mazgch 101:edfeb8af206e 800 while (readable())
mazgch 101:edfeb8af206e 801 getc();
mazgch 101:edfeb8af206e 802 }
mazgch 18:e5697801df29 803 protected:
mazgch 38:e6cab4632d84 804 /** Write bytes to the physical interface.
mazgch 38:e6cab4632d84 805 \param buf the buffer to write
mazgch 38:e6cab4632d84 806 \param buf size of the buffer to write
mazgch 38:e6cab4632d84 807 \return bytes written
mazgch 38:e6cab4632d84 808 */
mazgch 18:e5697801df29 809 virtual int _send(const void* buf, int len);
mazgch 17:296d94a006b4 810 };
mazgch 18:e5697801df29 811
mazgch 18:e5697801df29 812 // -----------------------------------------------------------------------
mazgch 18:e5697801df29 813
mazgch 38:e6cab4632d84 814 //#define HAVE_MDMUSB
mazgch 18:e5697801df29 815 #ifdef HAVE_MDMUSB
mazgch 18:e5697801df29 816 class MDMUsb : /*public UsbSerial,*/ public MDMParser
mazgch 18:e5697801df29 817 {
mazgch 18:e5697801df29 818 public:
mazgch 76:f7c3dd568dae 819 //! Constructor
mazgch 18:e5697801df29 820 MDMUsb(void);
mazgch 76:f7c3dd568dae 821 //! Destructor
mazgch 93:2b5478693c20 822 virtual ~MDMUsb(void);
mazgch 18:e5697801df29 823 virtual int getLine(char* buffer, int length);
mazgch 101:edfeb8af206e 824 virtual void purge(void) { }
mazgch 18:e5697801df29 825 protected:
mazgch 18:e5697801df29 826 virtual int _send(const void* buf, int len);
mazgch 18:e5697801df29 827 };
mazgch 18:e5697801df29 828 #endif
mazgch 18:e5697801df29 829
mazgch 95:8282dbbe1492 830 // -----------------------------------------------------------------------
mazgch 18:e5697801df29 831
mazgch 95:8282dbbe1492 832 #ifdef RTOS_H
mazgch 95:8282dbbe1492 833 /** Use this template to override the lock and wait functions of the
mazgch 95:8282dbbe1492 834 modem driver in a Rtos system. For example declare it the modem
mazgch 95:8282dbbe1492 835 object as MDMRtos<MDMSerial> instead of MDMSerial.
mazgch 95:8282dbbe1492 836 */
mazgch 95:8282dbbe1492 837 template <class T>
mazgch 95:8282dbbe1492 838 class MDMRtos : public T
mazgch 95:8282dbbe1492 839 {
mazgch 95:8282dbbe1492 840 protected:
mazgch 95:8282dbbe1492 841 //! we assume that the modem runs in a thread so we yield when waiting
mazgch 95:8282dbbe1492 842 virtual void wait_ms(int ms) {
mazgch 95:8282dbbe1492 843 if (ms) Thread::wait(ms);
mazgch 95:8282dbbe1492 844 else Thread::yield();
mazgch 95:8282dbbe1492 845 }
mazgch 95:8282dbbe1492 846 //! lock a mutex when accessing the modem
mazgch 95:8282dbbe1492 847 virtual void lock(void) { _mtx.lock(); }
mazgch 95:8282dbbe1492 848 //! unlock the modem when done accessing it
mazgch 95:8282dbbe1492 849 virtual void unlock(void) { _mtx.unlock(); }
mazgch 95:8282dbbe1492 850 // the mutex resource
mazgch 95:8282dbbe1492 851 Mutex _mtx;
mazgch 95:8282dbbe1492 852 };
mazgch 95:8282dbbe1492 853 #endif