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