u-blox / C027_Support_HTTP

Added HTTP API to C027_Support library.

Fork of C027_Support by u-blox

MDM.h@134:307c15ce18e8, 2015-12-10 (annotated)

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