Atar Babgei
Fork of Ublox Lib
Fork of
C027_Support
by 
u-blox
Diff: MDM.h
- Revision:
- 139:5df09023c4e9
- Parent:
- 138:dafbbf31bf76
--- a/MDM.h Thu Feb 25 13:22:34 2016 +0000
+++ /dev/null Thu Jan 01 00:00:00 1970 +0000
@@ -1,867 +0,0 @@
-#pragma once
-
-#include "mbed.h"
-#include <stdarg.h>
-
-#include "Pipe.h"
-#include "SerialPipe.h"
-
-#ifdef TARGET_UBLOX_C027
- // you can change this is you like to use a shield even on the C027
- #define MDM_IF(onboard,shield) onboard
-#else
- #define MDM_IF(onboard,shield) shield
-#endif
-
-//! include debug capabilty on more powerful targets with a dedicated debug port
-#if defined(TARGET_LPC1768) || defined(TARGET_LPC4088) || defined(TARGET_K64F)
- #define MDM_DEBUG
-#endif
-
-/** basic modem parser class
-*/
-class MDMParser
-{
-public:
- //! Constructor
- MDMParser(void);
- //! get static instance
- static MDMParser* getInstance() { return inst; };
-
- // ----------------------------------------------------------------
- // Types
- // ----------------------------------------------------------------
- //! MT Device Types
- typedef enum { DEV_UNKNOWN,
- DEV_SARA_G35, DEV_LISA_U2, DEV_LISA_U2_03S, DEV_LISA_C2,
- DEV_SARA_U2, DEV_LEON_G2, DEV_TOBY_L2, DEV_MPCI_L2 } Dev;
- //! SIM Status
- typedef enum { SIM_UNKNOWN, SIM_MISSING, SIM_PIN, SIM_PUK, SIM_READY, WRONG_PIN } Sim;
- //! SIM Status
- typedef enum { LPM_DISABLED, LPM_ENABLED, LPM_ACTIVE } Lpm;
- //! COPS status
- typedef enum { COPS_UNKOWN, COPS_AUTOMATIC_REG, COPS_MANUAL_REG, COPS_DISABLED_REG} CopsMode;
- //! Device status
- typedef struct {
- Dev dev; //!< Device Type
- Lpm lpm; //!< Power Saving
- Sim sim; //!< SIM Card Status
- char ccid[20+1]; //!< Integrated Circuit Card ID
- char imsi[15+1]; //!< International Mobile Station Identity
- char imei[15+1]; //!< International Mobile Equipment Identity
- char meid[18+1]; //!< Mobile Equipment IDentifier
- char manu[16]; //!< Manufacturer (u-blox)
- char model[16]; //!< Model Name (LISA-U200, LISA-C200 or SARA-G350)
- char ver[16]; //!< Software Version
- } DevStatus;
- //! Registration Status
- typedef enum { REG_UNKNOWN, REG_DENIED, REG_NONE, REG_HOME, REG_ROAMING } Reg;
- //! Access Technology
- typedef enum { ACT_UNKNOWN, ACT_GSM, ACT_EDGE, ACT_UTRAN, ACT_CDMA, ACT_LTE } AcT;
- //! Network Status
- typedef struct {
- Reg csd; //!< CSD Registration Status (Circuit Switched Data)
- Reg psd; //!< PSD Registration status (Packet Switched Data)
- Reg eps; //!< EPS Registration status
- AcT act; //!< Access Technology
- int rssi; //!< Received Signal Strength Indication (in dBm, range -113..-51)
- int ber; //!< Bit Error Rate (BER), see 3GPP TS 45.008 [20] subclause 8.2.4
- char opr[16+1]; //!< Operator Name
- char num[32]; //!< Mobile Directory Number
- unsigned short lac; //!< location area code in hexadecimal format (2 bytes in hex)
- unsigned int ci; //!< Cell ID in hexadecimal format (2 to 4 bytes in hex)
- CopsMode regStatus; //!< Cops mode
- } NetStatus;
- typedef enum { CELL_LAST = 0, CELL_GNSS, CELL_LOCATE, CELL_HYBRID} CellSensType;
- typedef enum { CELL_DETAILED = 1, CELL_MULTIHYP = 2} CellRespType;
- #define CELL_MAX_HYP (16 + 1)
- int _locRcvPos; //!< Received positions
- int _locExpPos; //!< Expected positions
- //! Cell Locate Data
- typedef struct {
- bool validData; //!< Flag for indicating if data is valid
- struct tm time; //!< GPS Timestamp
- float longitude; //!< Estimated longitude, in degrees
- float latitude; //!< Estimated latitude, in degrees
- int altitutude; //!< Estimated altitude, in meters^2
- int uncertainty; //!< Maximum possible error, in meters
- int speed; //!< Speed over ground m/s^2
- int direction; //!< Course over ground in degrees
- int verticalAcc; //!< Vertical accuracy, in meters^2
- CellSensType sensor; //!< Sensor used for last calculation
- int svUsed; //!< number of satellite used
- }CellLocData;
- //! An IP v4 address
- typedef uint32_t IP;
- #define NOIP ((MDMParser::IP)0) //!< No IP address
- // ip number formating and conversion
- #define IPSTR "%d.%d.%d.%d"
- #define IPNUM(ip) ((ip)>>24)&0xff, \
- ((ip)>>16)&0xff, \
- ((ip)>> 8)&0xff, \
- ((ip)>> 0)&0xff
- #define IPADR(a,b,c,d) ((((IP)(a))<<24) | \
- (((IP)(b))<<16) | \
- (((IP)(c))<< 8) | \
- (((IP)(d))<< 0))
-
-
- // ----------------------------------------------------------------
- // Device
- // ----------------------------------------------------------------
-
- typedef enum { AUTH_NONE, AUTH_PAP, AUTH_CHAP, AUTH_DETECT } Auth;
-
- /** Combined Init, checkNetStatus, join suitable for simple applications
- \param simpin a optional pin of the SIM card
- \param apn the of the network provider e.g. "internet" or "apn.provider.com"
- \param username is the user name text string for the authentication phase
- \param password is the password text string for the authentication phase
- \param auth is the authentication mode (CHAP,PAP,NONE or DETECT)
- \return true if successful, false otherwise
- */
- bool connect(const char* simpin = NULL,
- const char* apn = NULL, const char* username = NULL,
- const char* password = NULL, Auth auth = AUTH_DETECT,
- PinName pn MDM_IF( = MDMPWRON, = D4));
-
- /** register (Attach) the MT to the GPRS service.
- \param simpin a optional pin of the SIM card
- \param status an optional struture to with device information
- \return true if successful, false otherwise
- */
- virtual bool init(const char* simpin = NULL, DevStatus* status = NULL,
- PinName pn MDM_IF( = MDMPWRON, = D4));
-
- /** get the current device status
- \param strocture holding the device information.
- */
- void getDevStatus(MDMParser::DevStatus* dev) { memcpy(dev, &_dev, sizeof(DevStatus)); }
-
- /** register to the network
- \param status an optional structure to with network information
- \param timeout_ms -1 blocking, else non blocking timeout in ms
- \return true if successful and connected to network, false otherwise
- */
- bool registerNet(NetStatus* status = NULL, int timeout_ms = 180000);
-
- /** check if the network is available
- \param status an optional structure to with network information
- \return true if successful and connected to network, false otherwise
- */
- bool checkNetStatus(NetStatus* status = NULL);
-
- /** Power off the MT, This function has to be called prior to
- switching off the supply.
- \return true if successfully, false otherwise
- */
- bool powerOff(void);
-
- // ----------------------------------------------------------------
- // Data Connection (GPRS)
- // ----------------------------------------------------------------
-
- /** register (Attach) the MT to the GPRS service.
- \param apn the of the network provider e.g. "internet" or "apn.provider.com"
- \param username is the user name text string for the authentication phase
- \param password is the password text string for the authentication phase
- \param auth is the authentication mode (CHAP,PAP,NONE or DETECT)
- \return the ip that is assigned
- */
- MDMParser::IP join(const char* apn = NULL, const char* username = NULL,
- const char* password = NULL, Auth auth = AUTH_DETECT);
-
- /** deregister (detach) the MT from the GPRS service.
- \return true if successful, false otherwise
- */
- bool disconnect(void);
-
- /** Translates a domain name to an IP address
- \param host the domain name to translate e.g. "u-blox.com"
- \return the IP if successful, 0 otherwise
- */
- MDMParser::IP gethostbyname(const char* host);
-
- /** get the current assigned IP address
- \return the ip that is assigned
- */
- MDMParser::IP getIpAddress(void) { return _ip; }
-
- // ----------------------------------------------------------------
- // Sockets
- // ----------------------------------------------------------------
-
- //! Type of IP protocol
- typedef enum { IPPROTO_TCP, IPPROTO_UDP } IpProtocol;
-
- //! Socket error return codes
- #define SOCKET_ERROR -1
-
- /** Create a socket for a ip protocol (and optionaly bind)
- \param ipproto the protocol (UDP or TCP)
- \param port in case of UDP, this optional port where it is bind
- \return the socket handle if successful or SOCKET_ERROR on failure
- */
- int socketSocket(IpProtocol ipproto, int port = -1);
-
- /** make a socket connection
- \param socket the socket handle
- \param host the domain name to connect e.g. "u-blox.com"
- \param port the port to connect
- \return true if successfully, false otherwise
- */
- bool socketConnect(int socket, const char* host, int port);
-
- /** make a socket connection
- \param socket the socket handle
- \return true if connected, false otherwise
- */
- bool socketIsConnected(int socket);
-
- /** Get the number of bytes pending for reading for this socket
- \param socket the socket handle
- \param timeout_ms -1 blocking, else non blocking timeout in ms
- \return 0 if successful or SOCKET_ERROR on failure
- */
- bool socketSetBlocking(int socket, int timeout_ms);
-
- /** Write socket data
- \param socket the socket handle
- \param buf the buffer to write
- \param len the size of the buffer to write
- \return the size written or SOCKET_ERROR on failure
- */
- int socketSend(int socket, const char * buf, int len);
-
- /** Write socket data to a IP
- \param socket the socket handle
- \param ip the ip to send to
- \param port the port to send to
- \param buf the buffer to write
- \param len the size of the buffer to write
- \return the size written or SOCKET_ERROR on failure
- */
- int socketSendTo(int socket, IP ip, int port, const char * buf, int len);
-
- /** Get the number of bytes pending for reading for this socket
- \param socket the socket handle
- \return the number of bytes pending or SOCKET_ERROR on failure
- */
- int socketReadable(int socket);
-
- /** Read this socket
- \param socket the socket handle
- \param buf the buffer to read into
- \param len the size of the buffer to read into
- \return the number of bytes read or SOCKET_ERROR on failure
- */
- int socketRecv(int socket, char* buf, int len);
-
- /** Read from this socket
- \param socket the socket handle
- \param ip the ip of host where the data originates from
- \param port the port where the data originates from
- \param buf the buffer to read into
- \param len the size of the buffer to read into
- \return the number of bytes read or SOCKET_ERROR on failure
- */
- int socketRecvFrom(int socket, IP* ip, int* port, char* buf, int len);
-
- /** Close a connectied socket (that was connected with #socketConnect)
- \param socket the socket handle
- \return true if successfully, false otherwise
- */
- bool socketClose(int socket);
-
- /** Free the socket (that was allocated before by #socketSocket)
- \param socket the socket handle
- \return true if successfully, false otherwise
- */
- bool socketFree(int socket);
-
- // ----------------------------------------------------------------
- // HTTP
- // ----------------------------------------------------------------
-
- //! Type of HTTP Operational Codes (reference to HTTP control +UHTTP)
- typedef enum { HTTP_IP_ADDRESS, HTTP_SERVER_NAME, HTTP_USER_NAME, HTTP_PASSWORD, \
- HTTP_AUTH_TYPE, HTTP_SERVER_PORT, HTTP_SECURE } HttpOpCode;
-
- //! Type of HTTP Commands (reference to HTTP command +UHTTPC)
- typedef enum { HTTP_HEAD, HTTP_GET, HTTP_DELETE, HTTP_PUT, \
- HTTP_POST_FILE, HTTP_POST_DATA } HttpCmd;
-
- //! HTTP Profile error return codes
- #define HTTP_PROF_ERROR -1
-
- /** find HTTP profile
- \return true if successfully, false otherwise
- */
- int httpFindProfile();
-
- /** get the number of bytes pending for reading for this HTTP profile
- \param profile the HTTP profile handle
- \param timeout_ms -1 blocking, else non blocking timeout in ms
- \return 0 if successful or SOCKET_ERROR on failure
- */
- bool httpSetBlocking(int profile, int timeout_ms);
-
- /** set the HTTP profile for commands management
- \param profile the HTTP profile handle
- \return true if successfully, false otherwise
- */
- bool httpSetProfileForCmdMng(int profile);
-
- /** free the HTTP profile
- \param profile the HTTP profile handle
- \return true if successfully, false otherwise
- */
- bool httpFreeProfile(int profile);
-
- /** reset HTTP profile
- \param httpProfile the HTTP profile to be reset
- \return true if successfully, false otherwise
- */
- bool httpResetProfile(int httpProfile);
-
- /** set HTTP parameters
- \param httpProfile the HTTP profile identifier
- \param httpOpCode the HTTP operation code
- \param httpInPar the HTTP input parameter
- \return true if successfully, false otherwise
- */
- bool httpSetPar(int httpProfile, HttpOpCode httpOpCode, const char * httpInPar);
-
- /** HTTP commands management
- \param httpProfile the HTTP profile identifier
- \param httpCmdCode the HTTP command code
- \param httpPath the path of HTTP server resource
- \param httpOut the filename where the HTTP server response will be stored
- \param httpIn the input data (filename or string) to be sent
- to the HTTP server with the command request
- \param httpContentType the HTTP Content-Type identifier
- \param httpCustomPar the parameter for an user defined HTTP Content-Type
- \param buf the buffer to read into
- \param len the size of the buffer to read into
- \return true if successfully, false otherwise
- */
- bool httpCommand(int httpProfile, HttpCmd httpCmdCode, const char* httpPath, \
- const char* httpOut, const char* httpIn, int httpContentType, \
- const char* httpCustomPar, char* buf, int len);
-
- /** get HTTP commands
- \param httpCmdCode the HTTP command code (reference also the enum format)
- \return HTTP command in string format
- */
- const char* getHTTPcmd(int httpCmdCode);
-
- // ----------------------------------------------------------------
- // SMS Short Message Service
- // ----------------------------------------------------------------
-
- /** count the number of sms in the device and optionally return a
- list with indexes from the storage locations in the device.
- \param stat what type of messages you can use use
- "REC UNREAD", "REC READ", "STO UNSENT", "STO SENT", "ALL"
- \param ix list where to save the storage positions
- \param num number of elements in the list
- \return the number of messages, this can be bigger than num, -1 on failure
- */
- int smsList(const char* stat = "ALL", int* ix = NULL, int num = 0);
-
- /** Read a Message from a storage position
- \param ix the storage position to read
- \param num the originator address (~16 chars)
- \param buf a buffer where to save the sm
- \param len the length of the sm
- \return true if successful, false otherwise
- */
- bool smsRead(int ix, char* num, char* buf, int len);
-
- /** Send a message to a recipient
- \param ix the storage position to delete
- \return true if successful, false otherwise
- */
- bool smsDelete(int ix);
-
- /** Send a message to a recipient
- \param num the phone number of the recipient
- \param buf the content of the message to sent
- \return true if successful, false otherwise
- */
- bool smsSend(const char* num, const char* buf);
-
- // ----------------------------------------------------------------
- // USSD Unstructured Supplementary Service Data
- // ----------------------------------------------------------------
-
- /** Read a Message from a storage position
- \param cmd the ussd command to send e.g "*#06#"
- \param buf a buffer where to save the reply
- \return true if successful, false otherwise
- */
- bool ussdCommand(const char* cmd, char* buf);
-
- // ----------------------------------------------------------------
- // FILE
- // ----------------------------------------------------------------
-
- /** Delete a file in the local file system
- \param filename the name of the file
- \return true if successful, false otherwise
- */
- bool delFile(const char* filename);
-
- /** Write some data to a file in the local file system
- \param filename the name of the file
- \param buf the data to write
- \param len the size of the data to write
- \return the number of bytes written
- */
- int writeFile(const char* filename, const char* buf, int len);
-
- /** Read a file from the local file system
- \param filename the name of the file
- \param buf a buffer to hold the data
- \param len the size to read
- \return the number of bytes read
- */
- int readFile(const char* filename, char* buf, int len);
-
- /** Read a file from the local file system
- (the file size is greater than MAX_SIZE bytes)
- \param filename the name of the file
- \param buf a buffer to hold the data
- \param len the size to read
- \return the number of bytes read
- */
- int readFileNew(const char* filename, char* buf, int len);
-
- /** Retrieve information about the dimension of a file from the local FFS
- \param filename the name of the file
- \return the file dimension in number of bytes
- */
- int infoFile(const char* filename);
-
- // ----------------------------------------------------------------
- // CellLocate
- // ----------------------------------------------------------------
-
- /** Configures CellLocate Tcp Aiding server
- \server_1 Host name of the primary MGA server
- \server_2 Host name of the secondary MGA server
- \token Authentication Token for MGA server access
- \days The number of days into the future the Offline data for the u-blox 7
- \period The number of weeks into the future the Offline data for u-blox M8
- \resolution Resolution of offline data for u-blox M8: 1 everyday, 0 every other day
- */
- int cellLocSrvTcp(const char* token, const char* server_1 = "cell-live1.services.u-blox.com", \
- const char* server_2 = "cell-live2.services.u-blox.com", int days = 14, int period = 4, int resolution = 1);
-
- /** Configures CellLocate Udp Aiding server
- \server_1 Host name of the primary MGA server
- \port Server port
- \latency Expected network latency in seconds from 0 to 10000ms
- \mode Assist now management, mode of operation: 0 data downloaded at GNSS power up,
- 1 automatically kept alive, manual download
- */
- int cellLocSrvUdp(const char* server_1 = "cell-live1.services.u-blox.com", int port = 46434, int latency = 1000, int mode = 0);
-
- /** Configures CellLocate URCs in the case of +ULOC operations
- \mode Urc configuration: 0 disabled, 1 enabled
- */
- int cellLocUnsol(int mode);
-
- /** Configures CellLocate location sensor
- \scanMode Network scan mode: 0 normal, 1 deep scan
- */
- int cellLocConfig(int scanMode);
-
- /** Request CellLocate
- This function is not blocking, the result has to be retrived using cellLocGet
- \sensor Sensor selection:
- \timeout Timeout period in seconds (1 - 999)
- \accuracy Target accuracy in meters (1 - 999999)
- \type
- \hypotesis Maximum desired number of responses from CellLocate® (up to 16)
- */
- int cellLocRequest(CellSensType sensor, int timeout, int accuracy, CellRespType type = CELL_DETAILED,int hypotesis = 1);
-
- /** Get a position record
- \data pointer to a CellLocData struct where the location will be copied in
- \index of the position to retrive
- \return 1 if data has been retrived and copied, 0 otherwise
- */
- int cellLocGetData(CellLocData *data, int index =0);
-
- /** Get number of position records received
- \return number of position received
- */
- int cellLocGetRes();
- /** Get expected number of position to be received
- \return number of expected position to be received
- */
- int cellLocGetExpRes();
-
- // ----------------------------------------------------------------
- // DEBUG/DUMP status to standard out (printf)
- // ----------------------------------------------------------------
-
- /*! Set the debug level
- \param level -1 = OFF, 0 = ERROR, 1 = INFO(default), 2 = TRACE, 3 = ATCMD,TEST
- \return true if successful, false not possible
- */
- bool setDebug(int level);
-
- //! helper type for DPRINT
- typedef int (*_DPRINT)(void* param, char const * format, ...);
-
- //! helper to declate templates and void versions
-#define _DUMP_TEMPLATE(func, type, arg) \
- template<class T> \
- inline void func(type arg, \
- int (*dprint)( T* param, char const * format, ...), \
- T* param) { func(arg, (_DPRINT)dprint, (void*)param); } \
- static void func(type arg, \
- _DPRINT dprint = (_DPRINT)fprintf, \
- void* param = (void*)stdout);
-
- /** dump the device status to stdout using printf
- \param status the status to convert to textual form,
- unavailable fields are ommited (not printed)
- \param dprint a function pointer
- \param param the irst argument passed to dprint
- */
- _DUMP_TEMPLATE(dumpDevStatus, MDMParser::DevStatus*, status)
-
- /** dump the network status to stdout using printf
- \param status the status to convert to textual form,
- unavailable fields are ommited (not printed)
- \param dprint a function pointer
- \param param the irst argument passed to dprint
- */
- _DUMP_TEMPLATE(dumpNetStatus, MDMParser::NetStatus*, status)
-
- /** dump the ip address to stdout using printf
- \param ip the ip to convert to textual form,
- unavailable fields are ommited (not printed)
- \param dprint a function pointer
- \param param the irst argument passed to dprint
- */
- _DUMP_TEMPLATE(dumpIp, MDMParser::IP, ip)
-
- // ----------------------------------------------------------------
- // Parseing
- // ----------------------------------------------------------------
-
- enum {
- // waitFinalResp Responses
- NOT_FOUND = 0,
- WAIT = -1, // TIMEOUT
- RESP_OK = -2,
- RESP_ERROR = -3,
- RESP_PROMPT = -4,
- RESP_ERROR_CME= -5,
-
- // getLine Responses
- #define LENGTH(x) (x & 0x00FFFF) //!< extract/mask the length
- #define TYPE(x) (x & 0xFF0000) //!< extract/mask the type
-
- TYPE_UNKNOWN = 0x000000,
- TYPE_OK = 0x110000,
- TYPE_ERROR = 0x120000,
- TYPE_ERROR_CME = 0x130000,
- TYPE_RING = 0x210000,
- TYPE_CONNECT = 0x220000,
- TYPE_NOCARRIER = 0x230000,
- TYPE_NODIALTONE = 0x240000,
- TYPE_BUSY = 0x250000,
- TYPE_NOANSWER = 0x260000,
- TYPE_PROMPT = 0x300000,
- TYPE_PLUS = 0x400000,
- TYPE_TEXT = 0x500000,
-
- // special timout constant
- TIMEOUT_BLOCKING = -1
- };
-
- /** Get a line from the physical interface. This function need
- to be implemented in a inherited class. Usually just calls
- #_getLine on the rx buffer pipe.
-
- \param buf the buffer to store it
- \param buf size of the buffer
- \return type and length if something was found,
- WAIT if not enough data is available
- NOT_FOUND if nothing was found
- */
- virtual int getLine(char* buf, int len) = 0;
-
- /* clear the pending input data
- */
- virtual void purge(void) = 0;
-
- /** Write data to the device
- \param buf the buffer to write
- \param buf size of the buffer to write
- \return bytes written
- */
- virtual int send(const char* buf, int len);
-
- /** Write formated date to the physical interface (printf style)
- \param fmt the format string
- \param .. variable arguments to be formated
- \return bytes written
- */
- int sendFormated(const char* format, ...);
-
- /** callback function for #waitFinalResp with void* as argument
- \param type the #getLine response
- \param buf the parsed line
- \param len the size of the parsed line
- \param param the optional argument passed to #waitFinalResp
- \return WAIT if processing should continue,
- any other value aborts #waitFinalResp and this retunr value retuned
- */
- typedef int (*_CALLBACKPTR)(int type, const char* buf, int len, void* param);
-
- /** Wait for a final respons
- \param cb the optional callback function
- \param param the optional callback function parameter
- \param timeout_ms the timeout to wait (See Estimated command
- response time of AT manual)
- */
- int waitFinalResp(_CALLBACKPTR cb = NULL,
- void* param = NULL,
- int timeout_ms = 10000);
-
- /** template version of #waitFinalResp when using callbacks,
- This template will allow the compiler to do type cheking but
- internally symply casts the arguments and call the (void*)
- version of #waitFinalResp.
- \sa waitFinalResp
- */
- template<class T>
- inline int waitFinalResp(int (*cb)(int type, const char* buf, int len, T* param),
- T* param,
- int timeout_ms = 10000)
- {
- return waitFinalResp((_CALLBACKPTR)cb, (void*)param, timeout_ms);
- }
-
-protected:
- /** Write bytes to the physical interface. This function should be
- implemented in a inherited class.
- \param buf the buffer to write
- \param buf size of the buffer to write
- \return bytes written
- */
- virtual int _send(const void* buf, int len) = 0;
-
- /** Helper: Parse a line from the receiving buffered pipe
- \param pipe the receiving buffer pipe
- \param buf the parsed line
- \param len the size of the parsed line
- \return type and length if something was found,
- WAIT if not enough data is available
- NOT_FOUND if nothing was found
- */
- static int _getLine(Pipe<char>* pipe, char* buffer, int length);
-
- /** Helper: Parse a match from the pipe
- \param pipe the buffered pipe
- \param number of bytes to parse at maximum,
- \param sta the starting string, NULL if none
- \param end the terminating string, NULL if none
- \return size of parsed match
- */
- static int _parseMatch(Pipe<char>* pipe, int len, const char* sta, const char* end);
-
- /** Helper: Parse a match from the pipe
- \param pipe the buffered pipe
- \param number of bytes to parse at maximum,
- \param fmt the formating string (%d any number, %c any char of last %d len)
- \return size of parsed match
- */
- static int _parseFormated(Pipe<char>* pipe, int len, const char* fmt);
-
-protected:
- // for rtos over riding by useing Rtos<MDMxx>
- /** override in a rtos system, you us the wait function of a Thread
- \param ms the number of milliseconds to wait
- */
- virtual void wait_ms(int ms) { if (ms) ::wait_ms(ms); }
- //! override the lock in a rtos system
- virtual void lock(void) { }
- //! override the unlock in a rtos system
- virtual void unlock(void) { }
-protected:
- bool _activateProfile(const char* apn, const char* username, const char* password, Auth auth);
- bool _activateProfileReuseExternal(void);
- bool _activateProfileByCid(int cid, const char* apn, const char* username, const char* password, Auth auth);
- // parsing callbacks for different AT commands and their parameter arguments
- static int _cbString(int type, const char* buf, int len, char* str);
- static int _cbInt(int type, const char* buf, int len, int* val);
- // device
- static int _cbATI(int type, const char* buf, int len, Dev* dev);
- static int _cbCPIN(int type, const char* buf, int len, Sim* sim);
- static int _cbCCID(int type, const char* buf, int len, char* ccid);
- // network
- static int _cbCSQ(int type, const char* buf, int len, NetStatus* status);
- static int _cbCOPS(int type, const char* buf, int len, NetStatus* status);
- static int _cbCNUM(int type, const char* buf, int len, char* num);
- static int _cbUACTIND(int type, const char* buf, int len, int* i);
- static int _cbCGDCONT(int type, const char* buf, int len, int* cid);
- static int _cbUDOPN(int type, const char* buf, int len, char* mccmnc);
- // sockets
- static int _cbCMIP(int type, const char* buf, int len, IP* ip);
- static int _cbUPSND(int type, const char* buf, int len, int* act);
- static int _cbUPSND(int type, const char* buf, int len, IP* ip);
- static int _cbUDNSRN(int type, const char* buf, int len, IP* ip);
- static int _cbUSOCR(int type, const char* buf, int len, int* handle);
- static int _cbUSORD(int type, const char* buf, int len, char* out);
- typedef struct { char* buf; IP ip; int port; } USORFparam;
- static int _cbUSORF(int type, const char* buf, int len, USORFparam* param);
- typedef struct { char* buf; char* num; } CMGRparam;
- static int _cbCUSD(int type, const char* buf, int len, char* resp);
- // sms
- typedef struct { int* ix; int num; } CMGLparam;
- static int _cbCMGL(int type, const char* buf, int len, CMGLparam* param);
- static int _cbCMGR(int type, const char* buf, int len, CMGRparam* param);
- // file
- typedef struct { const char* filename; char* buf; int sz; int len; } URDFILEparam;
- static int _cbUDELFILE(int type, const char* buf, int len, void*);
- static int _cbURDFILE(int type, const char* buf, int len, URDFILEparam* param);
- static int _cbURDBLOCK(int type, const char* buf, int len, char* out);
- static int _cbULSTFILE(int type, const char* buf, int len, int* infoFile);
- // variables
- DevStatus _dev; //!< collected device information
- NetStatus _net; //!< collected network information
- IP _ip; //!< assigned ip address
- CellLocData _loc[CELL_MAX_HYP]; //!< CellLocate data
- // management struture for sockets
- typedef struct { int handle; int timeout_ms; volatile bool connected; volatile int pending; } SockCtrl;
- // LISA-C has 6 TCP and 6 UDP sockets
- // LISA-U and SARA-G have 7 sockets
- SockCtrl _sockets[12];
- int _findSocket(int handle = SOCKET_ERROR/* = CREATE*/);
- // management structure for HTTP profiles
- // it's possible to have up to 4 different HTTP profiles (LISA-C200, LISA-U200 and SARA-G350) having:
- // param handle the current HTTP profile is in handling state or not (default value is HTTP_ERROR)
- // param timeout_ms the timeout for the current HTTP command
- // param pending the status for the current HTTP command (in processing state or not)
- // param cmd the code for the current HTTP command
- // param result the result for the current HTTP command once processed
- typedef struct { int handle; int timeout_ms; bool pending; int cmd; int result; } HttpProfCtrl;
- HttpProfCtrl _httpProfiles[4];
- int _findProfile(int handle = HTTP_PROF_ERROR/* = CREATE*/);
- static MDMParser* inst;
- bool _init;
-#ifdef TARGET_UBLOX_C027
- bool _onboard;
-#endif
-#ifdef MDM_DEBUG
- int _debugLevel;
- Timer _debugTime;
- void _debugPrint(int level, const char* color, const char* format, ...);
-#endif
-};
-
-// -----------------------------------------------------------------------
-
-/** modem class which uses a serial port
- as physical interface.
-*/
-class MDMSerial : public SerialPipe, public MDMParser
-{
-public:
- /** Constructor
-
- \param tx is the serial ports transmit pin (modem to CPU)
- \param rx is the serial ports receive pin (CPU to modem)
- \param baudrate the baudrate of the modem use 115200
- \param rts is the serial ports ready to send pin (CPU to modem)
- this pin is optional
- \param cts is the serial ports clear to send pin (modem to CPU)
- this pin is optional, but required for power saving to be enabled
- \param rxSize the size of the serial rx buffer
- \param txSize the size of the serial tx buffer
- */
- MDMSerial(PinName tx MDM_IF( = MDMTXD, = D1 ),
- PinName rx MDM_IF( = MDMRXD, = D0 ),
- int baudrate MDM_IF( = MDMBAUD, = 115200 ),
- #if DEVICE_SERIAL_FC
- PinName rts MDM_IF( = MDMRTS, = NC /* D2 resistor R62 on shield not mounted */ ),
- PinName cts MDM_IF( = MDMCTS, = NC /* D3 resistor R63 on shield not mounted */ ),
- #endif
- int rxSize = 256 ,
- int txSize = 128 );
- //! Destructor
- virtual ~MDMSerial(void);
-
- /** Get a line from the physical interface.
- \param buf the buffer to store it
- \param buf size of the buffer
- \return type and length if something was found,
- WAIT if not enough data is available
- NOT_FOUND if nothing was found
- */
- virtual int getLine(char* buffer, int length);
-
- /* clear the pending input data */
- virtual void purge(void)
- {
- while (readable())
- getc();
- }
-protected:
- /** Write bytes to the physical interface.
- \param buf the buffer to write
- \param buf size of the buffer to write
- \return bytes written
- */
- virtual int _send(const void* buf, int len);
-};
-
-// -----------------------------------------------------------------------
-
-//#define HAVE_MDMUSB
-#ifdef HAVE_MDMUSB
-class MDMUsb : /*public UsbSerial,*/ public MDMParser
-{
-public:
- //! Constructor
- MDMUsb(void);
- //! Destructor
- virtual ~MDMUsb(void);
- virtual int getLine(char* buffer, int length);
- virtual void purge(void) { }
-protected:
- virtual int _send(const void* buf, int len);
-};
-#endif
-
-// -----------------------------------------------------------------------
-
-#ifdef RTOS_H
-/** Use this template to override the lock and wait functions of the
- modem driver in a Rtos system. For example declare it the modem
- object as MDMRtos<MDMSerial> instead of MDMSerial.
-*/
-template <class T>
-class MDMRtos : public T
-{
-protected:
- //! we assume that the modem runs in a thread so we yield when waiting
- virtual void wait_ms(int ms) {
- if (ms) Thread::wait(ms);
- else Thread::yield();
- }
- //! lock a mutex when accessing the modem
- virtual void lock(void) { _mtx.lock(); }
- //! unlock the modem when done accessing it
- virtual void unlock(void) { _mtx.unlock(); }
- // the mutex resource
- Mutex _mtx;
-};
-#endif
\ No newline at end of file