Rob Meades / C027_Support_N

Support for LISA-N101

Fork of C027_Support by u-blox

This is a variant of the C027 driver code for the C027N version, i.e. the one with the Neul/Huawei/u-blox Cellular Internet of Things module on board. The AT command interface for this module is entirely different to the AT interface for the other u-blox modules, hence this fork of the driver. Work is underway to rearchitect the original C027 driver so that a merge can be done.

MDM.h@124:a58c1a7c5e18, 2015-03-16 (annotated)

Committer:
RobMeades
Date:
Mon Mar 16 16:28:57 2015 +0000
Revision:
124:a58c1a7c5e18
Parent:
123:628e65137b3e
Child:
126:76b578ec2912
The interface to datagramSend() now receives bytes rather than a hex-encoded string and the AT command hex encoding happens inside the function.  This makes it symmetrical with datagramRecv().

Who changed what in which revision?

UserRevisionLine numberNew contents of line
mazgch 17:296d94a006b4 1 #pragma once
mazgch 17:296d94a006b4 2
mazgch 17:296d94a006b4 3 #include "mbed.h"
mazgch 21:c4d64830bf02 4 #include <stdarg.h>
mazgch 21:c4d64830bf02 5
mazgch 18:e5697801df29 6 #include "Pipe.h"
mazgch 18:e5697801df29 7 #include "SerialPipe.h"
mazgch 17:296d94a006b4 8
mazgch 19:2b5d097ca15d 9 #ifdef TARGET_UBLOX_C027
mazgch 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,
RobMeades 122:c6b2fa1928f2 35 DEV_SARA_U260, DEV_SARA_U270, DEV_LEON_G200, DEV_LISA_N100 } 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 // ----------------------------------------------------------------
RobMeades 118:f3fd6c30dc19 295 // DATAGRAMS (via C027N Neul module)
RobMeades 118:f3fd6c30dc19 296 // ----------------------------------------------------------------
RobMeades 118:f3fd6c30dc19 297
RobMeades 118:f3fd6c30dc19 298 /** Send a datagram
RobMeades 124:a58c1a7c5e18 299 \param size the number of bytes in buf
RobMeades 124:a58c1a7c5e18 300 \param buf the bytes to be sent
RobMeades 118:f3fd6c30dc19 301 \return true if successful, false otherwise
RobMeades 118:f3fd6c30dc19 302 */
RobMeades 118:f3fd6c30dc19 303 bool datagramSend(int size, const char* buf);
RobMeades 118:f3fd6c30dc19 304
RobMeades 118:f3fd6c30dc19 305 /** Receive a datagram.
RobMeades 124:a58c1a7c5e18 306 \param size when called, the size of buf and, on exit,
RobMeades 124:a58c1a7c5e18 307 the number of bytes received into buf.
RobMeades 124:a58c1a7c5e18 308 \param buf the bytes received
RobMeades 118:f3fd6c30dc19 309 \param timeoutMs optional time to wait in milliseconds
RobMeades 118:f3fd6c30dc19 310 \return true if something was received, false otherwise
RobMeades 118:f3fd6c30dc19 311 */
RobMeades 118:f3fd6c30dc19 312 bool datagramRecv(int* size, char* buf, int timeoutMs = 10000);
RobMeades 118:f3fd6c30dc19 313
RobMeades 118:f3fd6c30dc19 314 /** Get the RSSI of the Neul modem
RobMeades 118:f3fd6c30dc19 315 \param rssi a number in the range 0 to 255
RobMeades 118:f3fd6c30dc19 316 \return true if successful, false otherwise
RobMeades 118:f3fd6c30dc19 317 */
RobMeades 118:f3fd6c30dc19 318 bool getRssi(int *rssi);
RobMeades 118:f3fd6c30dc19 319
RobMeades 118:f3fd6c30dc19 320 /** Reboot a Neul module
RobMeades 118:f3fd6c30dc19 321 \return true if successful, false otherwise
RobMeades 118:f3fd6c30dc19 322 */
RobMeades 118:f3fd6c30dc19 323 bool neulReboot(void);
RobMeades 118:f3fd6c30dc19 324
RobMeades 118:f3fd6c30dc19 325 // ----------------------------------------------------------------
mazgch 80:34985b4d821e 326 // FILE
mazgch 80:34985b4d821e 327 // ----------------------------------------------------------------
mazgch 80:34985b4d821e 328
mazgch 80:34985b4d821e 329 /** Delete a file in the local file system
mazgch 80:34985b4d821e 330 \param filename the name of the file
mazgch 80:34985b4d821e 331 \return true if successful, false otherwise
mazgch 80:34985b4d821e 332 */
mazgch 80:34985b4d821e 333 bool delFile(const char* filename);
mazgch 80:34985b4d821e 334
mazgch 80:34985b4d821e 335 /** Write some data to a file in the local file system
mazgch 80:34985b4d821e 336 \param filename the name of the file
mazgch 80:34985b4d821e 337 \param buf the data to write
mazgch 80:34985b4d821e 338 \param len the size of the data to write
mazgch 80:34985b4d821e 339 \return the number of bytes written
mazgch 80:34985b4d821e 340 */
mazgch 80:34985b4d821e 341 int writeFile(const char* filename, const char* buf, int len);
mazgch 80:34985b4d821e 342
mazgch 80:34985b4d821e 343 /** REad a file from the local file system
mazgch 80:34985b4d821e 344 \param filename the name of the file
mazgch 80:34985b4d821e 345 \param buf a buffer to hold the data
mazgch 80:34985b4d821e 346 \param len the size to read
mazgch 80:34985b4d821e 347 \return the number of bytes read
mazgch 80:34985b4d821e 348 */
mazgch 80:34985b4d821e 349 int readFile(const char* filename, char* buf, int len);
mazgch 80:34985b4d821e 350
mazgch 80:34985b4d821e 351 // ----------------------------------------------------------------
mazgch 74:208e3e32d263 352 // DEBUG/DUMP status to standard out (printf)
mazgch 54:7ba8e4c218e2 353 // ----------------------------------------------------------------
mazgch 54:7ba8e4c218e2 354
mazgch 74:208e3e32d263 355 /*! Set the debug level
mazgch 117:74e4e0109a9e 356 \param level -1 = OFF, 0 = ERROR, 1 = INFO(default), 2 = TRACE, 3 = ATCMD,TEST
mazgch 74:208e3e32d263 357 \return true if successful, false not possible
mazgch 74:208e3e32d263 358 */
mazgch 74:208e3e32d263 359 bool setDebug(int level);
mazgch 74:208e3e32d263 360
mazgch 73:2b32e0a21df2 361 //! helper type for DPRINT
mazgch 73:2b32e0a21df2 362 typedef int (*_DPRINT)(void* param, char const * format, ...);
mazgch 73:2b32e0a21df2 363
mazgch 73:2b32e0a21df2 364 //! helper to declate templates and void versions
mazgch 73:2b32e0a21df2 365 #define _DUMP_TEMPLATE(func, type, arg) \
mazgch 73:2b32e0a21df2 366 template<class T> \
mazgch 73:2b32e0a21df2 367 inline void func(type arg, \
mazgch 73:2b32e0a21df2 368 int (*dprint)( T* param, char const * format, ...), \
mazgch 73:2b32e0a21df2 369 T* param) { func(arg, (_DPRINT)dprint, (void*)param); } \
mazgch 73:2b32e0a21df2 370 static void func(type arg, \
mazgch 73:2b32e0a21df2 371 _DPRINT dprint = (_DPRINT)fprintf, \
mazgch 73:2b32e0a21df2 372 void* param = (void*)stdout);
mazgch 74:208e3e32d263 373
mazgch 54:7ba8e4c218e2 374 /** dump the device status to stdout using printf
mazgch 54:7ba8e4c218e2 375 \param status the status to convert to textual form,
mazgch 54:7ba8e4c218e2 376 unavailable fields are ommited (not printed)
mazgch 73:2b32e0a21df2 377 \param dprint a function pointer
mazgch 73:2b32e0a21df2 378 \param param the irst argument passed to dprint
mazgch 54:7ba8e4c218e2 379 */
mazgch 73:2b32e0a21df2 380 _DUMP_TEMPLATE(dumpDevStatus, MDMParser::DevStatus*, status)
mazgch 54:7ba8e4c218e2 381
mazgch 54:7ba8e4c218e2 382 /** dump the network status to stdout using printf
mazgch 54:7ba8e4c218e2 383 \param status the status to convert to textual form,
mazgch 54:7ba8e4c218e2 384 unavailable fields are ommited (not printed)
mazgch 73:2b32e0a21df2 385 \param dprint a function pointer
mazgch 73:2b32e0a21df2 386 \param param the irst argument passed to dprint
mazgch 54:7ba8e4c218e2 387 */
mazgch 73:2b32e0a21df2 388 _DUMP_TEMPLATE(dumpNetStatus, MDMParser::NetStatus*, status)
mazgch 73:2b32e0a21df2 389
mazgch 54:7ba8e4c218e2 390 /** dump the ip address to stdout using printf
mazgch 54:7ba8e4c218e2 391 \param ip the ip to convert to textual form,
mazgch 54:7ba8e4c218e2 392 unavailable fields are ommited (not printed)
mazgch 73:2b32e0a21df2 393 \param dprint a function pointer
mazgch 73:2b32e0a21df2 394 \param param the irst argument passed to dprint
mazgch 54:7ba8e4c218e2 395 */
mazgch 73:2b32e0a21df2 396 _DUMP_TEMPLATE(dumpIp, MDMParser::IP, ip)
mazgch 73:2b32e0a21df2 397
mazgch 54:7ba8e4c218e2 398 // ----------------------------------------------------------------
mazgch 31:a0bed6c1e05d 399 // Parseing
mazgch 31:a0bed6c1e05d 400 // ----------------------------------------------------------------
mazgch 31:a0bed6c1e05d 401
mazgch 51:e7b81c31baec 402 enum {
mazgch 51:e7b81c31baec 403 // waitFinalResp Responses
mazgch 52:8071747a7cb3 404 NOT_FOUND = 0,
mazgch 52:8071747a7cb3 405 WAIT = -1, // TIMEOUT
mazgch 52:8071747a7cb3 406 RESP_OK = -2,
mazgch 52:8071747a7cb3 407 RESP_ERROR = -3,
mazgch 52:8071747a7cb3 408 RESP_PROMPT = -4,
mazgch 31:a0bed6c1e05d 409
mazgch 51:e7b81c31baec 410 // getLine Responses
mazgch 51:e7b81c31baec 411 #define LENGTH(x) (x & 0x00FFFF) //!< extract/mask the length
mazgch 51:e7b81c31baec 412 #define TYPE(x) (x & 0xFF0000) //!< extract/mask the type
mazgch 51:e7b81c31baec 413
mazgch 51:e7b81c31baec 414 TYPE_UNKNOWN = 0x000000,
mazgch 51:e7b81c31baec 415 TYPE_OK = 0x110000,
mazgch 51:e7b81c31baec 416 TYPE_ERROR = 0x120000,
mazgch 51:e7b81c31baec 417 TYPE_RING = 0x210000,
mazgch 51:e7b81c31baec 418 TYPE_CONNECT = 0x220000,
mazgch 51:e7b81c31baec 419 TYPE_NOCARRIER = 0x230000,
mazgch 51:e7b81c31baec 420 TYPE_NODIALTONE = 0x240000,
mazgch 51:e7b81c31baec 421 TYPE_BUSY = 0x250000,
mazgch 51:e7b81c31baec 422 TYPE_NOANSWER = 0x260000,
mazgch 51:e7b81c31baec 423 TYPE_PROMPT = 0x300000,
mazgch 51:e7b81c31baec 424 TYPE_PLUS = 0x400000,
mazgch 66:69072b3c5bca 425 TYPE_TEXT = 0x500000,
mazgch 66:69072b3c5bca 426
mazgch 66:69072b3c5bca 427 // special timout constant
mazgch 66:69072b3c5bca 428 TIMEOUT_BLOCKING = -1
mazgch 51:e7b81c31baec 429 };
mazgch 31:a0bed6c1e05d 430
mazgch 31:a0bed6c1e05d 431 /** Get a line from the physical interface. This function need
mazgch 31:a0bed6c1e05d 432 to be implemented in a inherited class. Usually just calls
mazgch 31:a0bed6c1e05d 433 #_getLine on the rx buffer pipe.
mazgch 31:a0bed6c1e05d 434
mazgch 31:a0bed6c1e05d 435 \param buf the buffer to store it
mazgch 31:a0bed6c1e05d 436 \param buf size of the buffer
mazgch 31:a0bed6c1e05d 437 \return type and length if something was found,
mazgch 31:a0bed6c1e05d 438 WAIT if not enough data is available
mazgch 31:a0bed6c1e05d 439 NOT_FOUND if nothing was found
mazgch 31:a0bed6c1e05d 440 */
mazgch 31:a0bed6c1e05d 441 virtual int getLine(char* buf, int len) = 0;
mazgch 28:4d9509e3b1cf 442
mazgch 101:edfeb8af206e 443 /* clear the pending input data
mazgch 101:edfeb8af206e 444 */
mazgch 101:edfeb8af206e 445 virtual void purge(void) = 0;
mazgch 101:edfeb8af206e 446
mazgch 31:a0bed6c1e05d 447 /** Write data to the device
mazgch 31:a0bed6c1e05d 448 \param buf the buffer to write
mazgch 31:a0bed6c1e05d 449 \param buf size of the buffer to write
mazgch 31:a0bed6c1e05d 450 \return bytes written
mazgch 31:a0bed6c1e05d 451 */
mazgch 31:a0bed6c1e05d 452 virtual int send(const char* buf, int len);
mazgch 21:c4d64830bf02 453
mazgch 31:a0bed6c1e05d 454 /** Write formated date to the physical interface (printf style)
mazgch 31:a0bed6c1e05d 455 \param fmt the format string
mazgch 31:a0bed6c1e05d 456 \param .. variable arguments to be formated
mazgch 31:a0bed6c1e05d 457 \return bytes written
mazgch 31:a0bed6c1e05d 458 */
mazgch 21:c4d64830bf02 459 int sendFormated(const char* format, ...);
mazgch 26:07be5faf8925 460
mazgch 31:a0bed6c1e05d 461 /** callback function for #waitFinalResp with void* as argument
mazgch 31:a0bed6c1e05d 462 \param type the #getLine response
mazgch 31:a0bed6c1e05d 463 \param buf the parsed line
mazgch 31:a0bed6c1e05d 464 \param len the size of the parsed line
mazgch 31:a0bed6c1e05d 465 \param param the optional argument passed to #waitFinalResp
mazgch 31:a0bed6c1e05d 466 \return WAIT if processing should continue,
mazgch 31:a0bed6c1e05d 467 any other value aborts #waitFinalResp and this retunr value retuned
mazgch 31:a0bed6c1e05d 468 */
mazgch 26:07be5faf8925 469 typedef int (*_CALLBACKPTR)(int type, const char* buf, int len, void* param);
mazgch 31:a0bed6c1e05d 470
mazgch 31:a0bed6c1e05d 471 /** Wait for a final respons
mazgch 31:a0bed6c1e05d 472 \param cb the optional callback function
mazgch 31:a0bed6c1e05d 473 \param param the optional callback function parameter
mazgch 58:e38a2e942fbb 474 \param timeout_ms the timeout to wait (See Estimated command
mazgch 58:e38a2e942fbb 475 response time of AT manual)
mazgch 31:a0bed6c1e05d 476 */
mazgch 31:a0bed6c1e05d 477 int waitFinalResp(_CALLBACKPTR cb = NULL,
mazgch 26:07be5faf8925 478 void* param = NULL,
mazgch 58:e38a2e942fbb 479 int timeout_ms = 10000);
mazgch 31:a0bed6c1e05d 480
mazgch 31:a0bed6c1e05d 481 /** template version of #waitFinalResp when using callbacks,
mazgch 31:a0bed6c1e05d 482 This template will allow the compiler to do type cheking but
mazgch 31:a0bed6c1e05d 483 internally symply casts the arguments and call the (void*)
mazgch 31:a0bed6c1e05d 484 version of #waitFinalResp.
mazgch 31:a0bed6c1e05d 485 \sa waitFinalResp
mazgch 31:a0bed6c1e05d 486 */
mazgch 26:07be5faf8925 487 template<class T>
mazgch 73:2b32e0a21df2 488 inline int waitFinalResp(int (*cb)(int type, const char* buf, int len, T* param),
mazgch 73:2b32e0a21df2 489 T* param,
mazgch 73:2b32e0a21df2 490 int timeout_ms = 10000)
mazgch 26:07be5faf8925 491 {
mazgch 26:07be5faf8925 492 return waitFinalResp((_CALLBACKPTR)cb, (void*)param, timeout_ms);
mazgch 26:07be5faf8925 493 }
mazgch 31:a0bed6c1e05d 494
mazgch 18:e5697801df29 495 protected:
mazgch 31:a0bed6c1e05d 496 /** Write bytes to the physical interface. This function should be
mazgch 31:a0bed6c1e05d 497 implemented in a inherited class.
mazgch 31:a0bed6c1e05d 498 \param buf the buffer to write
mazgch 31:a0bed6c1e05d 499 \param buf size of the buffer to write
mazgch 31:a0bed6c1e05d 500 \return bytes written
mazgch 31:a0bed6c1e05d 501 */
mazgch 18:e5697801df29 502 virtual int _send(const void* buf, int len) = 0;
mazgch 31:a0bed6c1e05d 503
mazgch 31:a0bed6c1e05d 504 /** Helper: Parse a line from the receiving buffered pipe
mazgch 31:a0bed6c1e05d 505 \param pipe the receiving buffer pipe
mazgch 31:a0bed6c1e05d 506 \param buf the parsed line
mazgch 31:a0bed6c1e05d 507 \param len the size of the parsed line
mazgch 31:a0bed6c1e05d 508 \return type and length if something was found,
mazgch 31:a0bed6c1e05d 509 WAIT if not enough data is available
mazgch 31:a0bed6c1e05d 510 NOT_FOUND if nothing was found
mazgch 31:a0bed6c1e05d 511 */
mazgch 31:a0bed6c1e05d 512 static int _getLine(Pipe<char>* pipe, char* buffer, int length);
mazgch 31:a0bed6c1e05d 513
mazgch 31:a0bed6c1e05d 514 /** Helper: Parse a match from the pipe
mazgch 31:a0bed6c1e05d 515 \param pipe the buffered pipe
mazgch 31:a0bed6c1e05d 516 \param number of bytes to parse at maximum,
mazgch 31:a0bed6c1e05d 517 \param sta the starting string, NULL if none
mazgch 31:a0bed6c1e05d 518 \param end the terminating string, NULL if none
mazgch 31:a0bed6c1e05d 519 \return size of parsed match
mazgch 31:a0bed6c1e05d 520 */
mazgch 31:a0bed6c1e05d 521 static int _parseMatch(Pipe<char>* pipe, int len, const char* sta, const char* end);
mazgch 31:a0bed6c1e05d 522
mazgch 31:a0bed6c1e05d 523 /** Helper: Parse a match from the pipe
mazgch 31:a0bed6c1e05d 524 \param pipe the buffered pipe
mazgch 31:a0bed6c1e05d 525 \param number of bytes to parse at maximum,
mazgch 31:a0bed6c1e05d 526 \param fmt the formating string (%d any number, %c any char of last %d len)
mazgch 31:a0bed6c1e05d 527 \return size of parsed match
mazgch 31:a0bed6c1e05d 528 */
mazgch 31:a0bed6c1e05d 529 static int _parseFormated(Pipe<char>* pipe, int len, const char* fmt);
mazgch 31:a0bed6c1e05d 530
mazgch 35:9275215a3a5b 531 protected:
mazgch 95:8282dbbe1492 532 // for rtos over riding by useing Rtos<MDMxx>
mazgch 95:8282dbbe1492 533 /** override in a rtos system, you us the wait function of a Thread
mazgch 95:8282dbbe1492 534 \param ms the number of milliseconds to wait
mazgch 95:8282dbbe1492 535 */
mazgch 95:8282dbbe1492 536 virtual void wait_ms(int ms) { if (ms) ::wait_ms(ms); }
mazgch 95:8282dbbe1492 537 //! override the lock in a rtos system
mazgch 95:8282dbbe1492 538 virtual void lock(void) { }
mazgch 95:8282dbbe1492 539 //! override the unlock in a rtos system
mazgch 95:8282dbbe1492 540 virtual void unlock(void) { }
mazgch 95:8282dbbe1492 541 protected:
mazgch 31:a0bed6c1e05d 542 // parsing callbacks for different AT commands and their parameter arguments
mazgch 31:a0bed6c1e05d 543 static int _cbString(int type, const char* buf, int len, char* str);
mazgch 31:a0bed6c1e05d 544 static int _cbInt(int type, const char* buf, int len, int* val);
RobMeades 118:f3fd6c30dc19 545 static int _cbGmiString(int type, const char* buf, int len, char* str);
RobMeades 118:f3fd6c30dc19 546 static int _cbGmmString(int type, const char* buf, int len, char* str);
RobMeades 118:f3fd6c30dc19 547 static int _cbGmrString(int type, const char* buf, int len, char* str);
mazgch 31:a0bed6c1e05d 548 // device
mazgch 32:8f12ac182bbb 549 static int _cbATI(int type, const char* buf, int len, Dev* dev);
mazgch 31:a0bed6c1e05d 550 static int _cbCPIN(int type, const char* buf, int len, Sim* sim);
mazgch 31:a0bed6c1e05d 551 static int _cbCCID(int type, const char* buf, int len, char* ccid);
mazgch 31:a0bed6c1e05d 552 // network
mazgch 54:7ba8e4c218e2 553 static int _cbCSQ(int type, const char* buf, int len, NetStatus* status);
RobMeades 118:f3fd6c30dc19 554 static int _cbCSQN(int type, const char* buf, int len, int* rssi);
mazgch 31:a0bed6c1e05d 555 static int _cbCOPS(int type, const char* buf, int len, NetStatus* status);
mazgch 31:a0bed6c1e05d 556 static int _cbCNUM(int type, const char* buf, int len, char* num);
mazgch 81:3966a5c17037 557 static int _cbUACTIND(int type, const char* buf, int len, int* i);
RobMeades 118:f3fd6c30dc19 558 static int _cbRAS(int type, const char* buf, int len, bool* connected);
mazgch 84:a05edb010176 559 static int _cbUDOPN(int type, const char* buf, int len, char* mccmnc);
mazgch 31:a0bed6c1e05d 560 // sockets
mazgch 32:8f12ac182bbb 561 static int _cbCMIP(int type, const char* buf, int len, IP* ip);
mazgch 31:a0bed6c1e05d 562 static int _cbUPSND(int type, const char* buf, int len, int* act);
mazgch 31:a0bed6c1e05d 563 static int _cbUPSND(int type, const char* buf, int len, IP* ip);
mazgch 21:c4d64830bf02 564 static int _cbUDNSRN(int type, const char* buf, int len, IP* ip);
mazgch 103:197fa7920ad8 565 static int _cbUSOCR(int type, const char* buf, int len, int* handle);
mazgch 21:c4d64830bf02 566 static int _cbUSORD(int type, const char* buf, int len, char* out);
mazgch 21:c4d64830bf02 567 typedef struct { char* buf; IP ip; int port; } USORFparam;
mazgch 21:c4d64830bf02 568 static int _cbUSORF(int type, const char* buf, int len, USORFparam* param);
mazgch 21:c4d64830bf02 569 typedef struct { char* buf; char* num; } CMGRparam;
RobMeades 118:f3fd6c30dc19 570 static int _cbCUSD(int type, const char* buf, int len, char* resp);
mazgch 31:a0bed6c1e05d 571 // sms
mazgch 31:a0bed6c1e05d 572 typedef struct { int* ix; int num; } CMGLparam;
mazgch 31:a0bed6c1e05d 573 static int _cbCMGL(int type, const char* buf, int len, CMGLparam* param);
mazgch 21:c4d64830bf02 574 static int _cbCMGR(int type, const char* buf, int len, CMGRparam* param);
RobMeades 118:f3fd6c30dc19 575 // Neul
RobMeades 118:f3fd6c30dc19 576 static int _cbMGS (int type, const char* buf, int len, bool* ok);
RobMeades 118:f3fd6c30dc19 577 static int _cbSMI (int type, const char* buf, int len, bool* sent);
RobMeades 118:f3fd6c30dc19 578 typedef struct { char* buf; int maxlen; int outlen; } MGRparam;
RobMeades 118:f3fd6c30dc19 579 bool doMGR (int* size, char* buf, MGRparam* param);
RobMeades 118:f3fd6c30dc19 580 static int _cbMGR (int type, const char* buf, int len, MGRparam* param);
RobMeades 118:f3fd6c30dc19 581 static int _cbRB (int type, const char* buf, int len, bool* ok);
mazgch 80:34985b4d821e 582 // file
mazgch 80:34985b4d821e 583 typedef struct { const char* filename; char* buf; int sz; int len; } URDFILEparam;
mazgch 115:d8d94b73c725 584 static int _cbUDELFILE(int type, const char* buf, int len, void*);
mazgch 80:34985b4d821e 585 static int _cbURDFILE(int type, const char* buf, int len, URDFILEparam* param);
mazgch 38:e6cab4632d84 586 // variables
mazgch 31:a0bed6c1e05d 587 DevStatus _dev; //!< collected device information
mazgch 31:a0bed6c1e05d 588 NetStatus _net; //!< collected network information
mazgch 31:a0bed6c1e05d 589 IP _ip; //!< assigned ip address
mazgch 31:a0bed6c1e05d 590 // management struture for sockets
mazgch 103:197fa7920ad8 591 typedef struct { int handle; int timeout_ms; volatile bool connected; volatile int pending; } SockCtrl;
mazgch 103:197fa7920ad8 592 // LISA-C has 6 TCP and 6 UDP sockets
mazgch 103:197fa7920ad8 593 // LISA-U and SARA-G have 7 sockets
mazgch 103:197fa7920ad8 594 SockCtrl _sockets[12];
mazgch 103:197fa7920ad8 595 int _findSocket(int handle = SOCKET_ERROR/* = CREATE*/);
RobMeades 124:a58c1a7c5e18 596 // Utilities to convert a hex string into bytes and vice-versa
RobMeades 118:f3fd6c30dc19 597 static void hexStringToBytes (const char *inBuf, int lenInBuf, char * outBuf, int* lenOutBuf);
RobMeades 124:a58c1a7c5e18 598 static int bytesToHexString (const char * inBuf, int size, char *outBuf, int lenOutBuf);
mazgch 44:9d12223b78ff 599 static MDMParser* inst;
mazgch 76:f7c3dd568dae 600 bool _init;
RobMeades 118:f3fd6c30dc19 601 bool _ubloxat;
RobMeades 118:f3fd6c30dc19 602 int _outstandingNMI;
mazgch 74:208e3e32d263 603 #ifdef TARGET_UBLOX_C027
mazgch 74:208e3e32d263 604 bool _onboard;
mazgch 74:208e3e32d263 605 #endif
mazgch 74:208e3e32d263 606 #ifdef MDM_DEBUG
mazgch 74:208e3e32d263 607 int _debugLevel;
mazgch 74:208e3e32d263 608 Timer _debugTime;
mazgch 117:74e4e0109a9e 609 void _debugPrint(int level, const char* color, const char* format, ...);
mazgch 74:208e3e32d263 610 #endif
mazgch 18:e5697801df29 611 };
mazgch 18:e5697801df29 612
mazgch 18:e5697801df29 613 // -----------------------------------------------------------------------
mazgch 18:e5697801df29 614
mazgch 38:e6cab4632d84 615 /** modem class which uses a serial port
mazgch 38:e6cab4632d84 616 as physical interface.
mazgch 38:e6cab4632d84 617 */
mazgch 18:e5697801df29 618 class MDMSerial : public SerialPipe, public MDMParser
mazgch 17:296d94a006b4 619 {
mazgch 17:296d94a006b4 620 public:
mazgch 38:e6cab4632d84 621 /** Constructor
mazgch 38:e6cab4632d84 622
mazgch 38:e6cab4632d84 623 \param tx is the serial ports transmit pin (modem to CPU)
mazgch 38:e6cab4632d84 624 \param rx is the serial ports receive pin (CPU to modem)
mazgch 38:e6cab4632d84 625 \param baudrate the baudrate of the modem use 115200
mazgch 38:e6cab4632d84 626 \param rts is the serial ports ready to send pin (CPU to modem)
mazgch 38:e6cab4632d84 627 this pin is optional
mazgch 38:e6cab4632d84 628 \param cts is the serial ports clear to send pin (modem to CPU)
mazgch 38:e6cab4632d84 629 this pin is optional, but required for power saving to be enabled
mazgch 38:e6cab4632d84 630 \param rxSize the size of the serial rx buffer
mazgch 38:e6cab4632d84 631 \param txSize the size of the serial tx buffer
mazgch 38:e6cab4632d84 632 */
mazgch 75:ce6e12067d0c 633 MDMSerial(PinName tx MDM_IF( = MDMTXD, = D1 ),
mazgch 75:ce6e12067d0c 634 PinName rx MDM_IF( = MDMRXD, = D0 ),
mazgch 75:ce6e12067d0c 635 int baudrate MDM_IF( = MDMBAUD, = 115200 ),
mazgch 35:9275215a3a5b 636 #if DEVICE_SERIAL_FC
mazgch 75:ce6e12067d0c 637 PinName rts MDM_IF( = MDMRTS, = NC /* D2 resistor R62 on shield not mounted */ ),
mazgch 75:ce6e12067d0c 638 PinName cts MDM_IF( = MDMCTS, = NC /* D3 resistor R63 on shield not mounted */ ),
mazgch 35:9275215a3a5b 639 #endif
mazgch 19:2b5d097ca15d 640 int rxSize = 256 ,
mazgch 21:c4d64830bf02 641 int txSize = 128 );
mazgch 76:f7c3dd568dae 642 //! Destructor
mazgch 93:2b5478693c20 643 virtual ~MDMSerial(void);
mazgch 76:f7c3dd568dae 644
mazgch 38:e6cab4632d84 645 /** Get a line from the physical interface.
mazgch 38:e6cab4632d84 646 \param buf the buffer to store it
mazgch 38:e6cab4632d84 647 \param buf size of the buffer
mazgch 38:e6cab4632d84 648 \return type and length if something was found,
mazgch 38:e6cab4632d84 649 WAIT if not enough data is available
mazgch 38:e6cab4632d84 650 NOT_FOUND if nothing was found
mazgch 38:e6cab4632d84 651 */
mazgch 18:e5697801df29 652 virtual int getLine(char* buffer, int length);
mazgch 101:edfeb8af206e 653
mazgch 101:edfeb8af206e 654 /* clear the pending input data */
mazgch 101:edfeb8af206e 655 virtual void purge(void)
mazgch 101:edfeb8af206e 656 {
mazgch 101:edfeb8af206e 657 while (readable())
mazgch 101:edfeb8af206e 658 getc();
mazgch 101:edfeb8af206e 659 }
mazgch 18:e5697801df29 660 protected:
mazgch 38:e6cab4632d84 661 /** Write bytes to the physical interface.
mazgch 38:e6cab4632d84 662 \param buf the buffer to write
mazgch 38:e6cab4632d84 663 \param buf size of the buffer to write
mazgch 38:e6cab4632d84 664 \return bytes written
mazgch 38:e6cab4632d84 665 */
mazgch 18:e5697801df29 666 virtual int _send(const void* buf, int len);
mazgch 17:296d94a006b4 667 };
mazgch 18:e5697801df29 668
mazgch 18:e5697801df29 669 // -----------------------------------------------------------------------
mazgch 18:e5697801df29 670
mazgch 38:e6cab4632d84 671 //#define HAVE_MDMUSB
mazgch 18:e5697801df29 672 #ifdef HAVE_MDMUSB
mazgch 18:e5697801df29 673 class MDMUsb : /*public UsbSerial,*/ public MDMParser
mazgch 18:e5697801df29 674 {
mazgch 18:e5697801df29 675 public:
mazgch 76:f7c3dd568dae 676 //! Constructor
mazgch 18:e5697801df29 677 MDMUsb(void);
mazgch 76:f7c3dd568dae 678 //! Destructor
mazgch 93:2b5478693c20 679 virtual ~MDMUsb(void);
mazgch 18:e5697801df29 680 virtual int getLine(char* buffer, int length);
mazgch 101:edfeb8af206e 681 virtual void purge(void) { }
mazgch 18:e5697801df29 682 protected:
mazgch 18:e5697801df29 683 virtual int _send(const void* buf, int len);
mazgch 18:e5697801df29 684 };
mazgch 18:e5697801df29 685 #endif
mazgch 18:e5697801df29 686
mazgch 95:8282dbbe1492 687 // -----------------------------------------------------------------------
mazgch 18:e5697801df29 688
mazgch 95:8282dbbe1492 689 #ifdef RTOS_H
mazgch 95:8282dbbe1492 690 /** Use this template to override the lock and wait functions of the
mazgch 95:8282dbbe1492 691 modem driver in a Rtos system. For example declare it the modem
mazgch 95:8282dbbe1492 692 object as MDMRtos<MDMSerial> instead of MDMSerial.
mazgch 95:8282dbbe1492 693 */
mazgch 95:8282dbbe1492 694 template <class T>
mazgch 95:8282dbbe1492 695 class MDMRtos : public T
mazgch 95:8282dbbe1492 696 {
mazgch 95:8282dbbe1492 697 protected:
mazgch 95:8282dbbe1492 698 //! we assume that the modem runs in a thread so we yield when waiting
mazgch 95:8282dbbe1492 699 virtual void wait_ms(int ms) {
mazgch 95:8282dbbe1492 700 if (ms) Thread::wait(ms);
mazgch 95:8282dbbe1492 701 else Thread::yield();
mazgch 95:8282dbbe1492 702 }
mazgch 95:8282dbbe1492 703 //! lock a mutex when accessing the modem
mazgch 95:8282dbbe1492 704 virtual void lock(void) { _mtx.lock(); }
mazgch 95:8282dbbe1492 705 //! unlock the modem when done accessing it
mazgch 95:8282dbbe1492 706 virtual void unlock(void) { _mtx.unlock(); }
mazgch 95:8282dbbe1492 707 // the mutex resource
mazgch 95:8282dbbe1492 708 Mutex _mtx;
mazgch 95:8282dbbe1492 709 };
RobMeades 124:a58c1a7c5e18 710 #endif