Avnet / WncControllerLibrary

This library controls the WNC. There is a derived class for usage from the K64F board.

Fork of WncControllerLibrary by Fred Kellerman

WncController.h@19:83a52353b97e, 2016-09-14 (annotated)

Committer:
fkellermavnet
Date:
Wed Sep 14 02:31:35 2016 +0000
Revision:
19:83a52353b97e
Parent:
18:ca2899c353c2
Child:
20:ca2db38d6802
SMS seems work pretty good now.; main() has some debug in it that needs to be removed next time.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
fkellermavnet 0:affdbb35faa4 1 /*
fkellermavnet 0:affdbb35faa4 2 Copyright (c) 2016 Fred Kellerman
fkellermavnet 0:affdbb35faa4 3
fkellermavnet 0:affdbb35faa4 4 Permission is hereby granted, free of charge, to any person obtaining a copy
fkellermavnet 0:affdbb35faa4 5 of this software and associated documentation files (the "Software"), to deal
fkellermavnet 0:affdbb35faa4 6 in the Software without restriction, including without limitation the rights
fkellermavnet 0:affdbb35faa4 7 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
fkellermavnet 0:affdbb35faa4 8 copies of the Software, and to permit persons to whom the Software is
fkellermavnet 0:affdbb35faa4 9 furnished to do so, subject to the following conditions:
fkellermavnet 0:affdbb35faa4 10
fkellermavnet 0:affdbb35faa4 11 The above copyright notice and this permission notice shall be included in
fkellermavnet 0:affdbb35faa4 12 all copies or substantial portions of the Software.
fkellermavnet 0:affdbb35faa4 13
fkellermavnet 0:affdbb35faa4 14 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
fkellermavnet 0:affdbb35faa4 15 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
fkellermavnet 0:affdbb35faa4 16 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
fkellermavnet 0:affdbb35faa4 17 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
fkellermavnet 0:affdbb35faa4 18 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
fkellermavnet 0:affdbb35faa4 19 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
fkellermavnet 0:affdbb35faa4 20 THE SOFTWARE.
fkellermavnet 0:affdbb35faa4 21
fkellermavnet 0:affdbb35faa4 22 @file WncController.h
fkellermavnet 0:affdbb35faa4 23 @purpose Controls WNC Cellular Modem
fkellermavnet 0:affdbb35faa4 24 @version 1.0
fkellermavnet 0:affdbb35faa4 25 @date July 2016
fkellermavnet 0:affdbb35faa4 26 @author Fred Kellerman
fkellermavnet 0:affdbb35faa4 27 */
fkellermavnet 0:affdbb35faa4 28
fkellermavnet 0:affdbb35faa4 29 #ifndef __WNCCONTROLLER_H_
fkellermavnet 0:affdbb35faa4 30 #define __WNCCONTROLLER_H_
fkellermavnet 0:affdbb35faa4 31
fkellermavnet 0:affdbb35faa4 32 #include <string>
fkellermavnet 0:affdbb35faa4 33 #include <stdint.h>
fkellermavnet 0:affdbb35faa4 34
fkellermavnet 0:affdbb35faa4 35 namespace WncController_fk {
fkellermavnet 0:affdbb35faa4 36
fkellermavnet 0:affdbb35faa4 37 using namespace std;
fkellermavnet 0:affdbb35faa4 38
fkellermavnet 0:affdbb35faa4 39 /**
fkellermavnet 0:affdbb35faa4 40 * \file WncController.h
fkellermavnet 0:affdbb35faa4 41 * \brief This mbed C++ class is for controlling the WNC
fkellermavnet 0:affdbb35faa4 42 * Cellular modem via the AT command interface. This was
fkellermavnet 0:affdbb35faa4 43 * developed with respect to version 1.3 of the WNC authored
fkellermavnet 0:affdbb35faa4 44 * spec. This class is only designed to have 1 instantiation
fkellermavnet 0:affdbb35faa4 45 * it is also not multi-thread safe.
fkellermavnet 0:affdbb35faa4 46 */
fkellermavnet 0:affdbb35faa4 47
fkellermavnet 0:affdbb35faa4 48
fkellermavnet 18:ca2899c353c2 49 static const uint8_t MAX_LEN_IP_STR = 16; // Length includes room for the extra NULL
fkellermavnet 0:affdbb35faa4 50
fkellermavnet 0:affdbb35faa4 51 /**
fkellermavnet 0:affdbb35faa4 52 * \brief Contains info fields for the WNC Internet Attributes
fkellermavnet 0:affdbb35faa4 53 */
fkellermavnet 0:affdbb35faa4 54 struct WncIpStats
fkellermavnet 0:affdbb35faa4 55 {
fkellermavnet 18:ca2899c353c2 56 string wncMAC;
fkellermavnet 0:affdbb35faa4 57 char ip[MAX_LEN_IP_STR];
fkellermavnet 0:affdbb35faa4 58 char mask[MAX_LEN_IP_STR];
fkellermavnet 0:affdbb35faa4 59 char gateway[MAX_LEN_IP_STR];
fkellermavnet 0:affdbb35faa4 60 char dnsPrimary[MAX_LEN_IP_STR];
fkellermavnet 0:affdbb35faa4 61 char dnsSecondary[MAX_LEN_IP_STR];
fkellermavnet 0:affdbb35faa4 62 };
fkellermavnet 0:affdbb35faa4 63
fkellermavnet 0:affdbb35faa4 64 class WncController
fkellermavnet 0:affdbb35faa4 65 {
fkellermavnet 0:affdbb35faa4 66 public:
fkellermavnet 18:ca2899c353c2 67 static const unsigned MAX_NUM_WNC_SOCKETS = 5; // Max number of simultaneous sockets that the WNC supports
fkellermavnet 0:affdbb35faa4 68 static const unsigned MAX_POWERUP_TIMEOUT = 60; // How long the powerUp method will try to turn on the WNC Shield
fkellermavnet 0:affdbb35faa4 69 // (this is the default if the user does not over-ride on power-up
fkellermavnet 0:affdbb35faa4 70
fkellermavnet 0:affdbb35faa4 71 // Tracks mode of the WNC Shield hardware
fkellermavnet 0:affdbb35faa4 72 enum WncState_e {
fkellermavnet 0:affdbb35faa4 73 WNC_OFF = 0,
fkellermavnet 0:affdbb35faa4 74 WNC_ON, // This is intended to mean all systems go, including cell link up but socket may not be open
fkellermavnet 0:affdbb35faa4 75 WNC_ON_NO_CELL_LINK
fkellermavnet 0:affdbb35faa4 76 };
fkellermavnet 0:affdbb35faa4 77
fkellermavnet 0:affdbb35faa4 78 /**
fkellermavnet 0:affdbb35faa4 79 * \brief Constructor for UART controlled WNC
fkellermavnet 0:affdbb35faa4 80 *
fkellermavnet 0:affdbb35faa4 81 * \param [in] wnc_uart - Reference to a SerialBuffered object which will
fkellermavnet 0:affdbb35faa4 82 * be used as the bus to control the WNC. apnStr = a text string for
fkellermavnet 0:affdbb35faa4 83 * the cellular APN name.
fkellermavnet 0:affdbb35faa4 84 *
fkellermavnet 0:affdbb35faa4 85 * \return None.
fkellermavnet 0:affdbb35faa4 86 *
fkellermavnet 0:affdbb35faa4 87 * \details Adding another way to talk to the WNC, like I2C or USB,
fkellermavnet 0:affdbb35faa4 88 * a constructor should be added for each type just like the SerialBuffered
fkellermavnet 0:affdbb35faa4 89 * constructor below. Assumes UART is enabled, setup and ready to go. This
fkellermavnet 0:affdbb35faa4 90 * class will read and write to this UART.
fkellermavnet 0:affdbb35faa4 91 */
fkellermavnet 1:ac2de545b981 92 WncController(void);
fkellermavnet 0:affdbb35faa4 93
fkellermavnet 0:affdbb35faa4 94 // WncController( const char * const apnStr, MODSERIAL * wnc_uart, MODSERIAL * debug_uart = NULL);
fkellermavnet 0:affdbb35faa4 95
fkellermavnet 0:affdbb35faa4 96 /**
fkellermavnet 0:affdbb35faa4 97 * \brief Used internally but also make public for a user of the Class to interrogate state as well.
fkellermavnet 0:affdbb35faa4 98 *
fkellermavnet 0:affdbb35faa4 99 * \param [in] None.
fkellermavnet 0:affdbb35faa4 100 *
fkellermavnet 0:affdbb35faa4 101 * \return The state of the WNC Modem.
fkellermavnet 0:affdbb35faa4 102 *
fkellermavnet 0:affdbb35faa4 103 * \details None.
fkellermavnet 0:affdbb35faa4 104 */
fkellermavnet 0:affdbb35faa4 105 WncState_e getWncStatus(void);
fkellermavnet 0:affdbb35faa4 106
fkellermavnet 0:affdbb35faa4 107 bool setApnName(const char * const apnStr);
fkellermavnet 0:affdbb35faa4 108
fkellermavnet 0:affdbb35faa4 109 /**
fkellermavnet 0:affdbb35faa4 110 * \brief Return signal quality dBm level
fkellermavnet 0:affdbb35faa4 111 *
fkellermavnet 0:affdbb35faa4 112 * \param [in] None.
fkellermavnet 0:affdbb35faa4 113 *
fkellermavnet 0:affdbb35faa4 114 * \return The dBm signal level at the time of the request.
fkellermavnet 0:affdbb35faa4 115 *
fkellermavnet 0:affdbb35faa4 116 * \details This polls (at the time of the call) the cell signal.
fkellermavnet 0:affdbb35faa4 117 */
fkellermavnet 0:affdbb35faa4 118 int16_t getDbmRssi(void);
fkellermavnet 0:affdbb35faa4 119 int16_t get3gBer(void);
fkellermavnet 0:affdbb35faa4 120
fkellermavnet 0:affdbb35faa4 121 /**
fkellermavnet 0:affdbb35faa4 122 * \brief Power up and down (down not implemented yet)
fkellermavnet 0:affdbb35faa4 123 *
fkellermavnet 0:affdbb35faa4 124 * \param [in] NXP Pins that are critical for the initialization of the WNC Shield.
fkellermavnet 0:affdbb35faa4 125 *
fkellermavnet 0:affdbb35faa4 126 * \return true if request successful else false.
fkellermavnet 0:affdbb35faa4 127 *
fkellermavnet 0:affdbb35faa4 128 * \details Power-on works but not power-down. This will manipulate WNC Shield hardware
fkellermavnet 0:affdbb35faa4 129 * and bring it to life. It will also initialize the WNC enough to get it to be able to open sockets
fkellermavnet 0:affdbb35faa4 130 * (with AT commands)
fkellermavnet 0:affdbb35faa4 131 */
fkellermavnet 1:ac2de545b981 132 bool powerWncOn(const char * const apn, uint8_t powerUpTimeoutSecs = MAX_POWERUP_TIMEOUT);
fkellermavnet 0:affdbb35faa4 133
fkellermavnet 0:affdbb35faa4 134 /**
fkellermavnet 0:affdbb35faa4 135 * \brief Query the WNC modem for its Internet attributes
fkellermavnet 0:affdbb35faa4 136 *
fkellermavnet 0:affdbb35faa4 137 * \param [in] Pointer to a struct where to put the info.
fkellermavnet 0:affdbb35faa4 138 *
fkellermavnet 0:affdbb35faa4 139 * \return true if request successful else false.
fkellermavnet 0:affdbb35faa4 140 *
fkellermavnet 0:affdbb35faa4 141 * \details This method will do a few sanity checks and then gather the
fkellermavnet 0:affdbb35faa4 142 * fields of the struct.
fkellermavnet 0:affdbb35faa4 143 */
fkellermavnet 0:affdbb35faa4 144 bool getWncNetworkingStats(WncIpStats * s);
fkellermavnet 0:affdbb35faa4 145
fkellermavnet 0:affdbb35faa4 146 /**
fkellermavnet 0:affdbb35faa4 147 * \brief Look-up a URL text string and convert into an IP Address string.
fkellermavnet 0:affdbb35faa4 148 *
fkellermavnet 0:affdbb35faa4 149 * \param [in] url - the URL to lookup. numSock - the socket reference.
fkellermavnet 0:affdbb35faa4 150 *
fkellermavnet 0:affdbb35faa4 151 * \return true - if the IP address has been resolved. false - if the URL could not be resolved.
fkellermavnet 0:affdbb35faa4 152 *
fkellermavnet 0:affdbb35faa4 153 * \details None.
fkellermavnet 0:affdbb35faa4 154 */
fkellermavnet 0:affdbb35faa4 155 bool resolveUrl(uint16_t numSock, const char * url);
fkellermavnet 0:affdbb35faa4 156
fkellermavnet 0:affdbb35faa4 157 /**
fkellermavnet 0:affdbb35faa4 158 * \brief Set IP Address string
fkellermavnet 0:affdbb35faa4 159 *
fkellermavnet 0:affdbb35faa4 160 * \param [in] numSock - socket reference to set the string for. ipStr - text string of the IP
fkellermavnet 0:affdbb35faa4 161 * address you want to talk to. There is no sanity check - beware!!!
fkellermavnet 0:affdbb35faa4 162 *
fkellermavnet 0:affdbb35faa4 163 * \return true - if the IP address has been set. false - if the IP could not be set.
fkellermavnet 0:affdbb35faa4 164 *
fkellermavnet 0:affdbb35faa4 165 * \details None.
fkellermavnet 0:affdbb35faa4 166 */
fkellermavnet 0:affdbb35faa4 167 bool setIpAddr(uint16_t numSock, const char * ipStr);
fkellermavnet 0:affdbb35faa4 168
fkellermavnet 0:affdbb35faa4 169 /**
fkellermavnet 0:affdbb35faa4 170 * \brief Opens a WNC socket.
fkellermavnet 0:affdbb35faa4 171 *
fkellermavnet 0:affdbb35faa4 172 * \param [in] sockNum - the number of the socket to open. ipAddr - a string containing
fkellermavnet 0:affdbb35faa4 173 * the IP address. port - the IP port number to open the socket connection.
fkellermavnet 0:affdbb35faa4 174 *
fkellermavnet 0:affdbb35faa4 175 * \return true - if the socket is/was opened. false otherwise.
fkellermavnet 0:affdbb35faa4 176 *
fkellermavnet 0:affdbb35faa4 177 * \details None.
fkellermavnet 0:affdbb35faa4 178 */
fkellermavnet 0:affdbb35faa4 179 bool openSocket(uint16_t numSock, uint16_t port, bool tcp, uint16_t timeOutSec = 30);
fkellermavnet 15:2c8211ef69e1 180
fkellermavnet 15:2c8211ef69e1 181 bool openSocketUrl(uint16_t numSock, const char * url, uint16_t port, bool tcp, uint16_t timeOutSec = 30);
fkellermavnet 15:2c8211ef69e1 182
fkellermavnet 15:2c8211ef69e1 183 bool openSocketIpAddr(uint16_t numSock, const char * ipAddr, uint16_t port, bool tcp, uint16_t timeOutSec = 30);
fkellermavnet 15:2c8211ef69e1 184
fkellermavnet 0:affdbb35faa4 185
fkellermavnet 0:affdbb35faa4 186 /**
fkellermavnet 0:affdbb35faa4 187 * \brief Write bytes of data to an open socket
fkellermavnet 0:affdbb35faa4 188 *
fkellermavnet 0:affdbb35faa4 189 * \param [in] sockNum - the number of the socket to write. s - a string containing
fkellermavnet 0:affdbb35faa4 190 * the byte data to send.
fkellermavnet 0:affdbb35faa4 191 *
fkellermavnet 0:affdbb35faa4 192 * \return true - if the write was successful. false otherwise.
fkellermavnet 0:affdbb35faa4 193 *
fkellermavnet 0:affdbb35faa4 194 * \details The results of the write do not have anything to do with the data
fkellermavnet 0:affdbb35faa4 195 * arriving at the endpoint.
fkellermavnet 0:affdbb35faa4 196 */
fkellermavnet 0:affdbb35faa4 197 bool write(uint16_t numSock, const char * s, uint32_t n);
fkellermavnet 0:affdbb35faa4 198
fkellermavnet 0:affdbb35faa4 199 /**
fkellermavnet 0:affdbb35faa4 200 * \brief Poll and read back data from the WNC (if it has any)
fkellermavnet 0:affdbb35faa4 201 * If auto poll is enabled this read might fail (return with no data).
fkellermavnet 0:affdbb35faa4 202 *
fkellermavnet 0:affdbb35faa4 203 * \param [in] sockNum - the number of the socket to read. result - a string pointer containing
fkellermavnet 0:affdbb35faa4 204 * the byte data readback from the WNC.
fkellermavnet 0:affdbb35faa4 205 *
fkellermavnet 0:affdbb35faa4 206 * \return The number of bytes/chars that are read from the socket.
fkellermavnet 0:affdbb35faa4 207 *
fkellermavnet 0:affdbb35faa4 208 * \details DO NOT use the same string as is passed to the auto poll setup method!
fkellermavnet 0:affdbb35faa4 209 */
fkellermavnet 0:affdbb35faa4 210 size_t read(uint16_t numSock, uint8_t * readBuf, uint32_t maxReadBufLen);
fkellermavnet 4:c5720f4d13ff 211
fkellermavnet 4:c5720f4d13ff 212 size_t read(uint16_t numSock, const uint8_t ** readBuf);
fkellermavnet 0:affdbb35faa4 213
fkellermavnet 0:affdbb35faa4 214 /**
fkellermavnet 0:affdbb35faa4 215 * \brief Set how many times the above read method will retry if data is not returned.
fkellermavnet 0:affdbb35faa4 216 *
fkellermavnet 0:affdbb35faa4 217 * \param [in] sockNum - the number of the socket to set. retries - how many times to
fkellermavnet 0:affdbb35faa4 218 * poll until data is found.
fkellermavnet 0:affdbb35faa4 219 *
fkellermavnet 0:affdbb35faa4 220 * \return None.
fkellermavnet 0:affdbb35faa4 221 *
fkellermavnet 0:affdbb35faa4 222 * \details None.
fkellermavnet 0:affdbb35faa4 223 */
fkellermavnet 0:affdbb35faa4 224 void setReadRetries(uint16_t numSock, uint16_t retries);
fkellermavnet 0:affdbb35faa4 225
fkellermavnet 0:affdbb35faa4 226 /**
fkellermavnet 0:affdbb35faa4 227 * \brief Set how long between retries to wait.
fkellermavnet 0:affdbb35faa4 228 *
fkellermavnet 0:affdbb35faa4 229 * \param [in] sockNum - the number of the socket to set. waitMs - how long to wait
fkellermavnet 0:affdbb35faa4 230 * before doing the read poll (calling read(...)).
fkellermavnet 0:affdbb35faa4 231 *
fkellermavnet 0:affdbb35faa4 232 * \return None.
fkellermavnet 0:affdbb35faa4 233 *
fkellermavnet 0:affdbb35faa4 234 * \details None.
fkellermavnet 0:affdbb35faa4 235 */
fkellermavnet 0:affdbb35faa4 236 void setReadRetryWait(uint16_t numSock, uint16_t waitMs);
fkellermavnet 0:affdbb35faa4 237
fkellermavnet 0:affdbb35faa4 238 /**
fkellermavnet 0:affdbb35faa4 239 * \brief Close the socket.
fkellermavnet 0:affdbb35faa4 240 *
fkellermavnet 0:affdbb35faa4 241 * \param [in] sockNum - the number of the socket to close.
fkellermavnet 0:affdbb35faa4 242 *
fkellermavnet 0:affdbb35faa4 243 * \return None.
fkellermavnet 0:affdbb35faa4 244 *
fkellermavnet 0:affdbb35faa4 245 * \details None.
fkellermavnet 0:affdbb35faa4 246 */
fkellermavnet 0:affdbb35faa4 247 bool closeSocket(uint16_t numSock);
fkellermavnet 0:affdbb35faa4 248
fkellermavnet 6:a656e820d7ff 249 void setWncCmdTimeout(uint16_t toMs);
fkellermavnet 6:a656e820d7ff 250
fkellermavnet 0:affdbb35faa4 251 bool getIpAddr(uint16_t numSock, char myIpAddr[MAX_LEN_IP_STR]);
fkellermavnet 0:affdbb35faa4 252
fkellermavnet 0:affdbb35faa4 253 void enableDebug(bool on, bool moreDebugOn);
fkellermavnet 0:affdbb35faa4 254
fkellermavnet 0:affdbb35faa4 255 ///////////////////////////////////////////
fkellermavnet 0:affdbb35faa4 256 // SMS messaging
fkellermavnet 0:affdbb35faa4 257 ///////////////////////////////////////////
fkellermavnet 0:affdbb35faa4 258
fkellermavnet 18:ca2899c353c2 259 static const uint16_t MAX_WNC_SMS_MSG_SLOTS = 3; // How many SMS messages the WNC can store and receive at a time.
fkellermavnet 18:ca2899c353c2 260 static const uint16_t MAX_WNC_SMS_LENGTH = 160; // The maximum length of an SMS message the WNC can send and receive.
fkellermavnet 18:ca2899c353c2 261
fkellermavnet 18:ca2899c353c2 262 struct WncSmsInfo
fkellermavnet 18:ca2899c353c2 263 {
fkellermavnet 18:ca2899c353c2 264 // Content
fkellermavnet 19:83a52353b97e 265 char idx;
fkellermavnet 18:ca2899c353c2 266 string number;
fkellermavnet 19:83a52353b97e 267 string date;
fkellermavnet 19:83a52353b97e 268 string time;
fkellermavnet 18:ca2899c353c2 269 string msg;
fkellermavnet 18:ca2899c353c2 270
fkellermavnet 18:ca2899c353c2 271 // Attributes
fkellermavnet 18:ca2899c353c2 272 bool incoming;
fkellermavnet 18:ca2899c353c2 273 bool unsent;
fkellermavnet 18:ca2899c353c2 274 bool unread;
fkellermavnet 18:ca2899c353c2 275 };
fkellermavnet 18:ca2899c353c2 276
fkellermavnet 18:ca2899c353c2 277 struct WncSmsList
fkellermavnet 18:ca2899c353c2 278 {
fkellermavnet 18:ca2899c353c2 279 uint8_t msgCount;
fkellermavnet 18:ca2899c353c2 280 WncSmsInfo e[MAX_WNC_SMS_MSG_SLOTS];
fkellermavnet 18:ca2899c353c2 281 };
fkellermavnet 18:ca2899c353c2 282
fkellermavnet 0:affdbb35faa4 283 bool sendSMSText(const char * const phoneNum, const char * const text);
fkellermavnet 0:affdbb35faa4 284
fkellermavnet 18:ca2899c353c2 285 bool readSMSLog(struct WncSmsList * log);
fkellermavnet 18:ca2899c353c2 286
fkellermavnet 19:83a52353b97e 287 bool readUnreadSMSText(struct WncSmsList * w, bool deleteRead = true);
fkellermavnet 0:affdbb35faa4 288
fkellermavnet 0:affdbb35faa4 289 bool saveSMSText(const char * const phoneNum, const char * const text, char * msgIdx);
fkellermavnet 0:affdbb35faa4 290
fkellermavnet 0:affdbb35faa4 291 bool sendSMSTextFromMem(char msgIdx);
fkellermavnet 0:affdbb35faa4 292
fkellermavnet 0:affdbb35faa4 293 bool deleteSMSTextFromMem(char msgIdx);
fkellermavnet 0:affdbb35faa4 294
fkellermavnet 18:ca2899c353c2 295 bool getICCID(string * iccid);
fkellermavnet 18:ca2899c353c2 296
fkellermavnet 18:ca2899c353c2 297 bool convertICCIDtoMSISDN(const string & iccid, string * msisdn);
fkellermavnet 0:affdbb35faa4 298
fkellermavnet 0:affdbb35faa4 299 ///////////////////////////////////////////
fkellermavnet 0:affdbb35faa4 300 // Neighborhood Cell Info
fkellermavnet 0:affdbb35faa4 301 ///////////////////////////////////////////
fkellermavnet 0:affdbb35faa4 302 size_t getSignalQuality(const char ** log);
fkellermavnet 0:affdbb35faa4 303
fkellermavnet 0:affdbb35faa4 304 // Date Time
fkellermavnet 18:ca2899c353c2 305 struct WncDateTime
fkellermavnet 18:ca2899c353c2 306 {
fkellermavnet 18:ca2899c353c2 307 uint8_t year;
fkellermavnet 18:ca2899c353c2 308 uint8_t month;
fkellermavnet 18:ca2899c353c2 309 uint8_t day;
fkellermavnet 18:ca2899c353c2 310 uint8_t hour;
fkellermavnet 18:ca2899c353c2 311 uint8_t min;
fkellermavnet 18:ca2899c353c2 312 uint8_t sec;
fkellermavnet 18:ca2899c353c2 313 };
fkellermavnet 18:ca2899c353c2 314
fkellermavnet 0:affdbb35faa4 315 bool getTimeDate(struct WncDateTime * tod);
fkellermavnet 0:affdbb35faa4 316
fkellermavnet 0:affdbb35faa4 317 // Ping
fkellermavnet 0:affdbb35faa4 318 bool pingUrl(const char * url);
fkellermavnet 0:affdbb35faa4 319 bool pingIp(const char * ip);
fkellermavnet 0:affdbb35faa4 320
fkellermavnet 0:affdbb35faa4 321 // User command:
fkellermavnet 0:affdbb35faa4 322 size_t sendCustomCmd(const char * cmd, char * resp, size_t sizeRespBuf, int ms_timeout);
fkellermavnet 0:affdbb35faa4 323
fkellermavnet 0:affdbb35faa4 324 protected:
fkellermavnet 0:affdbb35faa4 325
fkellermavnet 0:affdbb35faa4 326 // Debug output methods
fkellermavnet 0:affdbb35faa4 327 int dbgPutsNoTime(const char * s, bool crlf = true);
fkellermavnet 0:affdbb35faa4 328 int dbgPuts(const char * s, bool crlf = true);
fkellermavnet 0:affdbb35faa4 329 const char * _to_string(int64_t value);
fkellermavnet 1:ac2de545b981 330 const char * _to_hex_string(uint8_t value);
fkellermavnet 0:affdbb35faa4 331
fkellermavnet 0:affdbb35faa4 332 // Sends commands to WNC via
fkellermavnet 0:affdbb35faa4 333 enum AtCmdErr_e {
fkellermavnet 0:affdbb35faa4 334 WNC_AT_CMD_OK,
fkellermavnet 0:affdbb35faa4 335 WNC_AT_CMD_ERR,
fkellermavnet 0:affdbb35faa4 336 WNC_AT_CMD_ERREXT,
fkellermavnet 0:affdbb35faa4 337 WNC_AT_CMD_ERRCME,
fkellermavnet 0:affdbb35faa4 338 WNC_AT_CMD_INVALID_RESPONSE,
fkellermavnet 0:affdbb35faa4 339 WNC_AT_CMD_TIMEOUT,
fkellermavnet 0:affdbb35faa4 340 WNC_AT_CMD_NO_CELL_LINK,
fkellermavnet 0:affdbb35faa4 341 WNC_AT_CMD_WNC_NOT_ON
fkellermavnet 0:affdbb35faa4 342 };
fkellermavnet 0:affdbb35faa4 343
fkellermavnet 0:affdbb35faa4 344 // Users must define these functionalities:
fkellermavnet 0:affdbb35faa4 345 virtual int putc(char c) = 0;
fkellermavnet 0:affdbb35faa4 346 virtual int puts(const char * s) = 0;
fkellermavnet 0:affdbb35faa4 347 virtual char getc(void) = 0;
fkellermavnet 1:ac2de545b981 348 virtual int charReady(void) = 0;
fkellermavnet 1:ac2de545b981 349 virtual int dbgWriteChar(char b) = 0;
fkellermavnet 1:ac2de545b981 350 virtual int dbgWriteChars(const char *b) = 0;
fkellermavnet 0:affdbb35faa4 351 virtual void waitMs(int t) = 0;
fkellermavnet 0:affdbb35faa4 352 virtual void waitUs(int t) = 0;
fkellermavnet 0:affdbb35faa4 353 virtual bool initWncModem(uint8_t powerUpTimeoutSecs) = 0;
fkellermavnet 0:affdbb35faa4 354
fkellermavnet 0:affdbb35faa4 355 // Isolate OS timers
fkellermavnet 1:ac2de545b981 356 virtual int getLogTimerTicks(void) = 0;
fkellermavnet 1:ac2de545b981 357 virtual void startTimerA(void) = 0;
fkellermavnet 1:ac2de545b981 358 virtual void stopTimerA(void) = 0;
fkellermavnet 1:ac2de545b981 359 virtual int getTimerTicksA_mS(void) = 0;
fkellermavnet 1:ac2de545b981 360 virtual void startTimerB(void) = 0;
fkellermavnet 1:ac2de545b981 361 virtual void stopTimerB(void) = 0;
fkellermavnet 1:ac2de545b981 362 virtual int getTimerTicksB_mS(void) = 0;
fkellermavnet 0:affdbb35faa4 363
fkellermavnet 0:affdbb35faa4 364 bool waitForPowerOnModemToRespond(uint8_t powerUpTimeoutSecs);
fkellermavnet 2:30d78cda6779 365 AtCmdErr_e sendWncCmd(const char * const s, string ** r, int ms_timeout);
fkellermavnet 2:30d78cda6779 366
fkellermavnet 0:affdbb35faa4 367 private:
fkellermavnet 0:affdbb35faa4 368
fkellermavnet 0:affdbb35faa4 369 bool softwareInitMdm(void);
fkellermavnet 0:affdbb35faa4 370 bool checkCellLink(void);
fkellermavnet 0:affdbb35faa4 371 AtCmdErr_e mdmSendAtCmdRsp(const char * cmd, int timeout_ms, string * rsp, bool crLf = true);
fkellermavnet 1:ac2de545b981 372 size_t mdmGetline(string * buff, int timeout_ms);
fkellermavnet 0:affdbb35faa4 373 bool at_at_wnc(void);
fkellermavnet 0:affdbb35faa4 374 bool at_init_wnc(bool hardReset = false);
fkellermavnet 10:2ec59906a24e 375 int16_t at_sockopen_wnc(const char * const ip, uint16_t port, uint16_t numSock, bool tcp, uint16_t timeOutSec);
fkellermavnet 0:affdbb35faa4 376 bool at_sockclose_wnc(uint16_t numSock);
fkellermavnet 0:affdbb35faa4 377 bool at_dnsresolve_wnc(const char * s, string * ipStr);
fkellermavnet 13:73629a6e9122 378 AtCmdErr_e at_sockwrite_wnc(const char * s, uint16_t n, uint16_t numSock, bool isTcp);
fkellermavnet 12:33290e9e6e5f 379 AtCmdErr_e at_sockread_wnc(uint8_t * pS, uint16_t * numRead, uint16_t n, uint16_t numSock, bool isTcp);
fkellermavnet 4:c5720f4d13ff 380 AtCmdErr_e at_sockread_wnc(string * pS, uint16_t numSock, bool isTcp);
fkellermavnet 0:affdbb35faa4 381 bool at_reinitialize_mdm(void);
fkellermavnet 0:affdbb35faa4 382 AtCmdErr_e at_send_wnc_cmd(const char * s, string ** r, int ms_timeout);
fkellermavnet 0:affdbb35faa4 383 bool at_setapn_wnc(const char * const apnStr);
fkellermavnet 0:affdbb35faa4 384 bool at_sendSMStext_wnc(const char * const phoneNum, const char * const text);
fkellermavnet 0:affdbb35faa4 385 bool at_get_wnc_net_stats(WncIpStats * s);
fkellermavnet 18:ca2899c353c2 386 bool at_readSMSlog_wnc(string ** log);
fkellermavnet 0:affdbb35faa4 387 size_t at_readSMStext_wnc(const char ** log);
fkellermavnet 6:a656e820d7ff 388 size_t at_readSMStext_wnc(const char n, const char ** log);
fkellermavnet 0:affdbb35faa4 389 bool at_getrssiber_wnc(int16_t * dBm, int16_t * ber3g);
fkellermavnet 0:affdbb35faa4 390 void closeOpenSocket(uint16_t numSock);
fkellermavnet 13:73629a6e9122 391 bool sockWrite(const char * const s, uint16_t n, uint16_t numSock, bool isTcp);
fkellermavnet 0:affdbb35faa4 392 bool at_sendSMStextMem_wnc(char n);
fkellermavnet 0:affdbb35faa4 393 bool at_deleteSMSTextFromMem_wnc(char n);
fkellermavnet 0:affdbb35faa4 394 bool at_saveSMStext_wnc(const char * const phoneNum, const char * const text, char * msgIdx);
fkellermavnet 0:affdbb35faa4 395 size_t at_getSignalQuality_wnc(const char ** log);
fkellermavnet 0:affdbb35faa4 396 bool at_gettimedate_wnc(struct WncDateTime * tod);
fkellermavnet 0:affdbb35faa4 397 bool at_ping_wnc(const char * ip);
fkellermavnet 19:83a52353b97e 398 bool at_geticcid_wnc(string * iccid);
fkellermavnet 0:affdbb35faa4 399
fkellermavnet 0:affdbb35faa4 400 // Utility methods
fkellermavnet 0:affdbb35faa4 401 void sendCmd(const char * cmd, bool crLf);
fkellermavnet 0:affdbb35faa4 402 void sendCmd(const char * cmd, unsigned n, unsigned wait_uS, bool crLf);
fkellermavnet 0:affdbb35faa4 403 inline void rx_char_wait(void) {
fkellermavnet 0:affdbb35faa4 404 // waitUs(1000);
fkellermavnet 0:affdbb35faa4 405 }
fkellermavnet 0:affdbb35faa4 406
fkellermavnet 0:affdbb35faa4 407 // Important constants
fkellermavnet 6:a656e820d7ff 408 static const uint16_t MAX_WNC_READ_BYTES = 1500; // This bounds the largest amount of data that the WNC read from a socket will return
fkellermavnet 6:a656e820d7ff 409 static const uint16_t MAX_WNC_WRITE_BYTES = MAX_WNC_READ_BYTES; // This is the largest amount of data that the WNC can write per sockwrite.
fkellermavnet 6:a656e820d7ff 410 static const uint16_t MAX_LEN_WNC_CMD_RESPONSE = (MAX_WNC_READ_BYTES * 2 + 100); // Max number of text characters in a WNC AT response *2 because bytes are converted into 2 hex-digits +100 for other AT@ chars.
fkellermavnet 6:a656e820d7ff 411 static const uint16_t WNC_AUTO_POLL_MS = 250; // Sets default (may be overriden with method) poll interval (currently not used, future possible feature.
fkellermavnet 6:a656e820d7ff 412 static const uint16_t WNC_CMD_TIMEOUT_MS = 40000; // Sets default (may be overriden) time that the software waits for an AT response from the WNC.
fkellermavnet 6:a656e820d7ff 413 static const uint16_t WNC_QUICK_CMD_TIMEOUT_MS = 2000; // Used for simple commands that should immediately respond such as "AT", cmds that are quicker than WNC_CMD_TIMEOUT_MS.
fkellermavnet 6:a656e820d7ff 414 static const uint16_t WNC_WAIT_FOR_AT_CMD_MS = 0; // Wait this much between multiple in a row AT commands to the WNC.
fkellermavnet 6:a656e820d7ff 415 static const uint16_t WNC_SOFT_INIT_RETRY_COUNT = 10; // How many times the WNC will be tried to revive if it stops responding.
fkellermavnet 6:a656e820d7ff 416 static const uint16_t WNC_DNS_RESOLVE_WAIT_MS = 60000; // How much time to wait for the WNC to respond to a DNS resolve/lookup.
fkellermavnet 6:a656e820d7ff 417 static const uint16_t WNC_TRUNC_DEBUG_LENGTH = 80; // Always make this an even number, how many chars for the debug output before shortening the debug ouput, this is used when moreDebug = false.
fkellermavnet 6:a656e820d7ff 418 static const uint16_t WNC_APNSET_TIMEOUT_MS = 60000; // How long to wait for the WNC to respond to setting the APN string.
fkellermavnet 6:a656e820d7ff 419 static const uint16_t WNC_PING_CMD_TIMEOUT_MS = 60000; // Amount of time to wait for the WNC to respond to AT@PINGREQ (with cmd default params for timeout, does not change WNC cmd's timeout)
fkellermavnet 6:a656e820d7ff 420 static const int WNC_REINIT_MAX_TIME_MS = 60000; // How long to wait for the WNC to reset after it was already up and running after power-up.
fkellermavnet 6:a656e820d7ff 421 static const char * const INVALID_IP_STR; // Just a string set to an IP address when DNS resolve fails.
fkellermavnet 0:affdbb35faa4 422
fkellermavnet 0:affdbb35faa4 423 struct WncSocketInfo_s {
fkellermavnet 10:2ec59906a24e 424 int16_t numWncSock;
fkellermavnet 0:affdbb35faa4 425 bool open;
fkellermavnet 0:affdbb35faa4 426 string myIpAddressStr;
fkellermavnet 0:affdbb35faa4 427 uint16_t myPort;
fkellermavnet 0:affdbb35faa4 428 uint8_t readRetries;
fkellermavnet 0:affdbb35faa4 429 uint16_t readRetryWaitMs;
fkellermavnet 0:affdbb35faa4 430 bool isTcp;
fkellermavnet 0:affdbb35faa4 431 uint16_t timeOutSec;
fkellermavnet 0:affdbb35faa4 432 };
fkellermavnet 0:affdbb35faa4 433
fkellermavnet 0:affdbb35faa4 434 static WncSocketInfo_s m_sSock[MAX_NUM_WNC_SOCKETS];
fkellermavnet 10:2ec59906a24e 435 static const WncSocketInfo_s defaultSockStruct;
fkellermavnet 0:affdbb35faa4 436 static WncState_e m_sState;
fkellermavnet 0:affdbb35faa4 437 static uint16_t m_sCmdTimeoutMs;
fkellermavnet 0:affdbb35faa4 438 static string m_sApnStr;
fkellermavnet 0:affdbb35faa4 439 static string m_sWncStr;
fkellermavnet 0:affdbb35faa4 440 static uint8_t m_sPowerUpTimeoutSecs;
fkellermavnet 0:affdbb35faa4 441 static bool m_sDebugEnabled;
fkellermavnet 0:affdbb35faa4 442 static bool m_sMoreDebugEnabled;
fkellermavnet 0:affdbb35faa4 443 static bool m_sCheckNetStatus;
fkellermavnet 0:affdbb35faa4 444 static bool m_sReadyForSMS;
fkellermavnet 0:affdbb35faa4 445 };
fkellermavnet 0:affdbb35faa4 446
fkellermavnet 0:affdbb35faa4 447 }; // End namespace WncController_fk
fkellermavnet 0:affdbb35faa4 448
fkellermavnet 0:affdbb35faa4 449 #endif