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