mbed official / mbed-dev

mbed library sources. Supersedes mbed-src.

Dependents:   Nucleo_Hello_Encoder BLE_iBeaconScan AM1805_DEMO DISCO-F429ZI_ExportTemplate1 ... more

platform/ATCmdParser.h@187:0387e8f68319, 2018-09-06 (annotated)

Committer:
AnnaBridge
Date:
Thu Sep 06 13:40:20 2018 +0100
Revision:
187:0387e8f68319
Parent:
184:08ed48f1de7f
Child:
188:bcfe06ba3d64
mbed-dev library. Release version 163

Who changed what in which revision?

UserRevisionLine numberNew contents of line
AnnaBridge 167:e84263d55307 1 /* Copyright (c) 2017 ARM Limited
AnnaBridge 167:e84263d55307 2 *
AnnaBridge 167:e84263d55307 3 * Licensed under the Apache License, Version 2.0 (the "License");
AnnaBridge 167:e84263d55307 4 * you may not use this file except in compliance with the License.
AnnaBridge 167:e84263d55307 5 * You may obtain a copy of the License at
AnnaBridge 167:e84263d55307 6 *
AnnaBridge 167:e84263d55307 7 * http://www.apache.org/licenses/LICENSE-2.0
AnnaBridge 167:e84263d55307 8 *
AnnaBridge 167:e84263d55307 9 * Unless required by applicable law or agreed to in writing, software
AnnaBridge 167:e84263d55307 10 * distributed under the License is distributed on an "AS IS" BASIS,
AnnaBridge 167:e84263d55307 11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
AnnaBridge 167:e84263d55307 12 * See the License for the specific language governing permissions and
AnnaBridge 167:e84263d55307 13 * limitations under the License.
AnnaBridge 167:e84263d55307 14 *
AnnaBridge 167:e84263d55307 15 * @section DESCRIPTION
AnnaBridge 167:e84263d55307 16 *
AnnaBridge 167:e84263d55307 17 * Parser for the AT command syntax
AnnaBridge 167:e84263d55307 18 *
AnnaBridge 167:e84263d55307 19 */
AnnaBridge 167:e84263d55307 20 #ifndef MBED_ATCMDPARSER_H
AnnaBridge 167:e84263d55307 21 #define MBED_ATCMDPARSER_H
AnnaBridge 167:e84263d55307 22
AnnaBridge 167:e84263d55307 23 #include "mbed.h"
AnnaBridge 167:e84263d55307 24 #include <cstdarg>
AnnaBridge 167:e84263d55307 25 #include "Callback.h"
AnnaBridge 167:e84263d55307 26
AnnaBridge 178:79309dc6340a 27 namespace mbed {
AnnaBridge 178:79309dc6340a 28
AnnaBridge 178:79309dc6340a 29 /** \addtogroup platform */
AnnaBridge 178:79309dc6340a 30 /** @{*/
AnnaBridge 178:79309dc6340a 31 /**
AnnaBridge 178:79309dc6340a 32 * \defgroup platform_ATCmdParser ATCmdParser class
AnnaBridge 178:79309dc6340a 33 * @{
AnnaBridge 178:79309dc6340a 34 */
AnnaBridge 178:79309dc6340a 35
AnnaBridge 167:e84263d55307 36 /**
AnnaBridge 167:e84263d55307 37 * Parser class for parsing AT commands
AnnaBridge 167:e84263d55307 38 *
AnnaBridge 167:e84263d55307 39 * Here are some examples:
AnnaBridge 167:e84263d55307 40 * @code
Kojto 170:19eb464bc2be 41 * UARTSerial serial = UARTSerial(D1, D0);
Kojto 170:19eb464bc2be 42 * ATCmdParser at = ATCmdParser(&serial, "\r\n");
AnnaBridge 167:e84263d55307 43 * int value;
AnnaBridge 167:e84263d55307 44 * char buffer[100];
AnnaBridge 167:e84263d55307 45 *
AnnaBridge 167:e84263d55307 46 * at.send("AT") && at.recv("OK");
AnnaBridge 167:e84263d55307 47 * at.send("AT+CWMODE=%d", 3) && at.recv("OK");
AnnaBridge 167:e84263d55307 48 * at.send("AT+CWMODE?") && at.recv("+CWMODE:%d\r\nOK", &value);
AnnaBridge 167:e84263d55307 49 * at.recv("+IPD,%d:", &value);
AnnaBridge 167:e84263d55307 50 * at.read(buffer, value);
AnnaBridge 167:e84263d55307 51 * at.recv("OK");
AnnaBridge 167:e84263d55307 52 * @endcode
AnnaBridge 167:e84263d55307 53 */
AnnaBridge 167:e84263d55307 54
AnnaBridge 187:0387e8f68319 55 class ATCmdParser : private NonCopyable<ATCmdParser> {
AnnaBridge 167:e84263d55307 56 private:
AnnaBridge 167:e84263d55307 57 // File handle
AnnaBridge 167:e84263d55307 58 // Not owned by ATCmdParser
AnnaBridge 167:e84263d55307 59 FileHandle *_fh;
AnnaBridge 167:e84263d55307 60
AnnaBridge 167:e84263d55307 61 int _buffer_size;
AnnaBridge 167:e84263d55307 62 char *_buffer;
AnnaBridge 167:e84263d55307 63 int _timeout;
AnnaBridge 167:e84263d55307 64
AnnaBridge 167:e84263d55307 65 // Parsing information
AnnaBridge 167:e84263d55307 66 const char *_output_delimiter;
AnnaBridge 167:e84263d55307 67 int _output_delim_size;
AnnaBridge 167:e84263d55307 68 char _in_prev;
AnnaBridge 167:e84263d55307 69 bool _dbg_on;
AnnaBridge 167:e84263d55307 70 bool _aborted;
AnnaBridge 167:e84263d55307 71
AnnaBridge 167:e84263d55307 72 struct oob {
AnnaBridge 167:e84263d55307 73 unsigned len;
AnnaBridge 167:e84263d55307 74 const char *prefix;
AnnaBridge 167:e84263d55307 75 mbed::Callback<void()> cb;
AnnaBridge 167:e84263d55307 76 oob *next;
AnnaBridge 167:e84263d55307 77 };
AnnaBridge 167:e84263d55307 78 oob *_oobs;
AnnaBridge 167:e84263d55307 79
AnnaBridge 167:e84263d55307 80 public:
AnnaBridge 167:e84263d55307 81
AnnaBridge 167:e84263d55307 82 /**
AnnaBridge 167:e84263d55307 83 * Constructor
AnnaBridge 167:e84263d55307 84 *
AnnaBridge 167:e84263d55307 85 * @param fh A FileHandle to a digital interface to use for AT commands
AnnaBridge 167:e84263d55307 86 * @param output_delimiter end of command line termination
AnnaBridge 167:e84263d55307 87 * @param buffer_size size of internal buffer for transaction
AnnaBridge 167:e84263d55307 88 * @param timeout timeout of the connection
AnnaBridge 167:e84263d55307 89 * @param debug turns on/off debug output for AT commands
AnnaBridge 167:e84263d55307 90 */
AnnaBridge 167:e84263d55307 91 ATCmdParser(FileHandle *fh, const char *output_delimiter = "\r",
AnnaBridge 187:0387e8f68319 92 int buffer_size = 256, int timeout = 8000, bool debug = false)
AnnaBridge 187:0387e8f68319 93 : _fh(fh), _buffer_size(buffer_size), _in_prev(0), _oobs(NULL)
AnnaBridge 167:e84263d55307 94 {
AnnaBridge 167:e84263d55307 95 _buffer = new char[buffer_size];
AnnaBridge 167:e84263d55307 96 set_timeout(timeout);
AnnaBridge 167:e84263d55307 97 set_delimiter(output_delimiter);
AnnaBridge 167:e84263d55307 98 debug_on(debug);
AnnaBridge 167:e84263d55307 99 }
AnnaBridge 167:e84263d55307 100
AnnaBridge 167:e84263d55307 101 /**
AnnaBridge 167:e84263d55307 102 * Destructor
AnnaBridge 167:e84263d55307 103 */
AnnaBridge 167:e84263d55307 104 ~ATCmdParser()
AnnaBridge 167:e84263d55307 105 {
AnnaBridge 167:e84263d55307 106 while (_oobs) {
AnnaBridge 167:e84263d55307 107 struct oob *oob = _oobs;
AnnaBridge 167:e84263d55307 108 _oobs = oob->next;
AnnaBridge 167:e84263d55307 109 delete oob;
AnnaBridge 167:e84263d55307 110 }
AnnaBridge 167:e84263d55307 111 delete[] _buffer;
AnnaBridge 167:e84263d55307 112 }
AnnaBridge 167:e84263d55307 113
AnnaBridge 167:e84263d55307 114 /**
AnnaBridge 167:e84263d55307 115 * Allows timeout to be changed between commands
AnnaBridge 167:e84263d55307 116 *
AnnaBridge 167:e84263d55307 117 * @param timeout timeout of the connection
AnnaBridge 167:e84263d55307 118 */
AnnaBridge 167:e84263d55307 119 void set_timeout(int timeout)
AnnaBridge 167:e84263d55307 120 {
AnnaBridge 167:e84263d55307 121 _timeout = timeout;
AnnaBridge 167:e84263d55307 122 }
AnnaBridge 167:e84263d55307 123
AnnaBridge 167:e84263d55307 124 /**
AnnaBridge 167:e84263d55307 125 * For backwards compatibility.
AnnaBridge 184:08ed48f1de7f 126 * @deprecated Do not use this function. This function has been replaced with set_timeout for consistency.
AnnaBridge 167:e84263d55307 127 *
AnnaBridge 167:e84263d55307 128 * Please use set_timeout(int) API only from now on.
AnnaBridge 167:e84263d55307 129 * Allows timeout to be changed between commands
AnnaBridge 167:e84263d55307 130 *
AnnaBridge 167:e84263d55307 131 * @param timeout timeout of the connection
AnnaBridge 167:e84263d55307 132 */
AnnaBridge 167:e84263d55307 133 MBED_DEPRECATED_SINCE("mbed-os-5.5.0", "Replaced with set_timeout for consistency")
AnnaBridge 167:e84263d55307 134 void setTimeout(int timeout)
AnnaBridge 167:e84263d55307 135 {
AnnaBridge 167:e84263d55307 136 set_timeout(timeout);
AnnaBridge 167:e84263d55307 137 }
AnnaBridge 167:e84263d55307 138
AnnaBridge 167:e84263d55307 139 /**
AnnaBridge 167:e84263d55307 140 * Sets string of characters to use as line delimiters
AnnaBridge 167:e84263d55307 141 *
AnnaBridge 167:e84263d55307 142 * @param output_delimiter string of characters to use as line delimiters
AnnaBridge 167:e84263d55307 143 */
AnnaBridge 167:e84263d55307 144 void set_delimiter(const char *output_delimiter)
AnnaBridge 167:e84263d55307 145 {
AnnaBridge 167:e84263d55307 146 _output_delimiter = output_delimiter;
AnnaBridge 167:e84263d55307 147 _output_delim_size = strlen(output_delimiter);
AnnaBridge 167:e84263d55307 148 }
AnnaBridge 167:e84263d55307 149
AnnaBridge 167:e84263d55307 150 /**
AnnaBridge 167:e84263d55307 151 * For backwards compatibility.
AnnaBridge 184:08ed48f1de7f 152 * @deprecated Do not use this function. This function has been replaced with set_delimiter for consistency.
AnnaBridge 167:e84263d55307 153 *
AnnaBridge 167:e84263d55307 154 * Please use set_delimiter(const char *) API only from now on.
AnnaBridge 167:e84263d55307 155 * Sets string of characters to use as line delimiters
AnnaBridge 167:e84263d55307 156 *
AnnaBridge 167:e84263d55307 157 * @param output_delimiter string of characters to use as line delimiters
AnnaBridge 167:e84263d55307 158 */
AnnaBridge 167:e84263d55307 159 MBED_DEPRECATED_SINCE("mbed-os-5.5.0", "Replaced with set_delimiter for consistency")
AnnaBridge 167:e84263d55307 160 void setDelimiter(const char *output_delimiter)
AnnaBridge 167:e84263d55307 161 {
AnnaBridge 167:e84263d55307 162 set_delimiter(output_delimiter);
AnnaBridge 167:e84263d55307 163 }
AnnaBridge 167:e84263d55307 164
AnnaBridge 167:e84263d55307 165 /**
AnnaBridge 167:e84263d55307 166 * Allows traces from modem to be turned on or off
AnnaBridge 167:e84263d55307 167 *
AnnaBridge 167:e84263d55307 168 * @param on set as 1 to turn on traces and vice versa.
AnnaBridge 167:e84263d55307 169 */
AnnaBridge 167:e84263d55307 170 void debug_on(uint8_t on)
AnnaBridge 167:e84263d55307 171 {
AnnaBridge 167:e84263d55307 172 _dbg_on = (on) ? 1 : 0;
AnnaBridge 167:e84263d55307 173 }
AnnaBridge 167:e84263d55307 174
AnnaBridge 167:e84263d55307 175 /**
AnnaBridge 167:e84263d55307 176 * For backwards compatibility.
AnnaBridge 184:08ed48f1de7f 177 * @deprecated Do not use this function. This function has been replaced with debug_on for consistency.
AnnaBridge 167:e84263d55307 178 *
AnnaBridge 167:e84263d55307 179 * Allows traces from modem to be turned on or off
AnnaBridge 167:e84263d55307 180 *
AnnaBridge 167:e84263d55307 181 * @param on set as 1 to turn on traces and vice versa.
AnnaBridge 167:e84263d55307 182 */
AnnaBridge 167:e84263d55307 183 MBED_DEPRECATED_SINCE("mbed-os-5.5.0", "Replaced with debug_on for consistency")
AnnaBridge 167:e84263d55307 184 void debugOn(uint8_t on)
AnnaBridge 167:e84263d55307 185 {
AnnaBridge 167:e84263d55307 186 debug_on(on);
AnnaBridge 167:e84263d55307 187 }
AnnaBridge 167:e84263d55307 188
AnnaBridge 167:e84263d55307 189 /**
AnnaBridge 167:e84263d55307 190 * Sends an AT command
AnnaBridge 167:e84263d55307 191 *
AnnaBridge 167:e84263d55307 192 * Sends a formatted command using printf style formatting
AnnaBridge 167:e84263d55307 193 * @see printf
AnnaBridge 167:e84263d55307 194 *
AnnaBridge 167:e84263d55307 195 * @param command printf-like format string of command to send which
AnnaBridge 167:e84263d55307 196 * is appended with a newline
AnnaBridge 167:e84263d55307 197 * @param ... all printf-like arguments to insert into command
AnnaBridge 167:e84263d55307 198 * @return true only if command is successfully sent
AnnaBridge 167:e84263d55307 199 */
AnnaBridge 187:0387e8f68319 200 bool send(const char *command, ...) MBED_PRINTF_METHOD(1, 2);
AnnaBridge 167:e84263d55307 201
AnnaBridge 167:e84263d55307 202 bool vsend(const char *command, va_list args);
AnnaBridge 167:e84263d55307 203
AnnaBridge 167:e84263d55307 204 /**
AnnaBridge 167:e84263d55307 205 * Receive an AT response
AnnaBridge 167:e84263d55307 206 *
AnnaBridge 167:e84263d55307 207 * Receives a formatted response using scanf style formatting
AnnaBridge 167:e84263d55307 208 * @see scanf
AnnaBridge 167:e84263d55307 209 *
AnnaBridge 167:e84263d55307 210 * Responses are parsed line at a time.
AnnaBridge 167:e84263d55307 211 * Any received data that does not match the response is ignored until
AnnaBridge 167:e84263d55307 212 * a timeout occurs.
AnnaBridge 167:e84263d55307 213 *
AnnaBridge 167:e84263d55307 214 * @param response scanf-like format string of response to expect
AnnaBridge 167:e84263d55307 215 * @param ... all scanf-like arguments to extract from response
AnnaBridge 167:e84263d55307 216 * @return true only if response is successfully matched
AnnaBridge 167:e84263d55307 217 */
AnnaBridge 187:0387e8f68319 218 bool recv(const char *response, ...) MBED_SCANF_METHOD(1, 2);
AnnaBridge 167:e84263d55307 219
AnnaBridge 167:e84263d55307 220 bool vrecv(const char *response, va_list args);
AnnaBridge 167:e84263d55307 221
AnnaBridge 167:e84263d55307 222 /**
AnnaBridge 167:e84263d55307 223 * Write a single byte to the underlying stream
AnnaBridge 167:e84263d55307 224 *
AnnaBridge 167:e84263d55307 225 * @param c The byte to write
AnnaBridge 167:e84263d55307 226 * @return The byte that was written or -1 during a timeout
AnnaBridge 167:e84263d55307 227 */
AnnaBridge 167:e84263d55307 228 int putc(char c);
AnnaBridge 167:e84263d55307 229
AnnaBridge 167:e84263d55307 230 /**
AnnaBridge 167:e84263d55307 231 * Get a single byte from the underlying stream
AnnaBridge 167:e84263d55307 232 *
AnnaBridge 167:e84263d55307 233 * @return The byte that was read or -1 during a timeout
AnnaBridge 167:e84263d55307 234 */
AnnaBridge 167:e84263d55307 235 int getc();
AnnaBridge 167:e84263d55307 236
AnnaBridge 167:e84263d55307 237 /**
AnnaBridge 167:e84263d55307 238 * Write an array of bytes to the underlying stream
AnnaBridge 167:e84263d55307 239 *
AnnaBridge 167:e84263d55307 240 * @param data the array of bytes to write
AnnaBridge 167:e84263d55307 241 * @param size number of bytes to write
AnnaBridge 167:e84263d55307 242 * @return number of bytes written or -1 on failure
AnnaBridge 167:e84263d55307 243 */
AnnaBridge 167:e84263d55307 244 int write(const char *data, int size);
AnnaBridge 167:e84263d55307 245
AnnaBridge 167:e84263d55307 246 /**
AnnaBridge 167:e84263d55307 247 * Read an array of bytes from the underlying stream
AnnaBridge 167:e84263d55307 248 *
AnnaBridge 167:e84263d55307 249 * @param data the destination for the read bytes
AnnaBridge 167:e84263d55307 250 * @param size number of bytes to read
AnnaBridge 167:e84263d55307 251 * @return number of bytes read or -1 on failure
AnnaBridge 167:e84263d55307 252 */
AnnaBridge 167:e84263d55307 253 int read(char *data, int size);
AnnaBridge 167:e84263d55307 254
AnnaBridge 167:e84263d55307 255 /**
AnnaBridge 167:e84263d55307 256 * Direct printf to underlying stream
AnnaBridge 167:e84263d55307 257 * @see printf
AnnaBridge 167:e84263d55307 258 *
AnnaBridge 167:e84263d55307 259 * @param format format string to pass to printf
AnnaBridge 167:e84263d55307 260 * @param ... arguments to printf
AnnaBridge 167:e84263d55307 261 * @return number of bytes written or -1 on failure
AnnaBridge 167:e84263d55307 262 */
AnnaBridge 187:0387e8f68319 263 int printf(const char *format, ...) MBED_PRINTF_METHOD(1, 2);
AnnaBridge 167:e84263d55307 264
AnnaBridge 167:e84263d55307 265 int vprintf(const char *format, va_list args);
AnnaBridge 167:e84263d55307 266
AnnaBridge 167:e84263d55307 267 /**
AnnaBridge 167:e84263d55307 268 * Direct scanf on underlying stream
AnnaBridge 167:e84263d55307 269 * @see scanf
AnnaBridge 167:e84263d55307 270 *
AnnaBridge 167:e84263d55307 271 * @param format format string to pass to scanf
AnnaBridge 167:e84263d55307 272 * @param ... arguments to scanf
AnnaBridge 167:e84263d55307 273 * @return number of bytes read or -1 on failure
AnnaBridge 167:e84263d55307 274 */
AnnaBridge 187:0387e8f68319 275 int scanf(const char *format, ...) MBED_SCANF_METHOD(1, 2);
AnnaBridge 167:e84263d55307 276
AnnaBridge 167:e84263d55307 277 int vscanf(const char *format, va_list args);
AnnaBridge 167:e84263d55307 278
AnnaBridge 167:e84263d55307 279 /**
AnnaBridge 167:e84263d55307 280 * Attach a callback for out-of-band data
AnnaBridge 167:e84263d55307 281 *
AnnaBridge 167:e84263d55307 282 * @param prefix string on when to initiate callback
AnnaBridge 167:e84263d55307 283 * @param func callback to call when string is read
AnnaBridge 167:e84263d55307 284 * @note out-of-band data is only processed during a scanf call
AnnaBridge 167:e84263d55307 285 */
AnnaBridge 167:e84263d55307 286 void oob(const char *prefix, mbed::Callback<void()> func);
AnnaBridge 167:e84263d55307 287
AnnaBridge 167:e84263d55307 288 /**
AnnaBridge 167:e84263d55307 289 * Flushes the underlying stream
AnnaBridge 167:e84263d55307 290 */
AnnaBridge 167:e84263d55307 291 void flush();
AnnaBridge 167:e84263d55307 292
AnnaBridge 167:e84263d55307 293 /**
AnnaBridge 167:e84263d55307 294 * Abort current recv
AnnaBridge 167:e84263d55307 295 *
AnnaBridge 167:e84263d55307 296 * Can be called from oob handler to interrupt the current
AnnaBridge 167:e84263d55307 297 * recv operation.
AnnaBridge 167:e84263d55307 298 */
AnnaBridge 167:e84263d55307 299 void abort();
AnnaBridge 187:0387e8f68319 300
AnnaBridge 176:447f873cad2f 301 /**
AnnaBridge 176:447f873cad2f 302 * Process out-of-band data
AnnaBridge 176:447f873cad2f 303 *
AnnaBridge 176:447f873cad2f 304 * Process out-of-band data in the receive buffer. This function
AnnaBridge 176:447f873cad2f 305 * returns immediately if there is no data to process.
AnnaBridge 176:447f873cad2f 306 *
AnnaBridge 176:447f873cad2f 307 * @return true if oob data processed, false otherwise
AnnaBridge 176:447f873cad2f 308 */
AnnaBridge 176:447f873cad2f 309 bool process_oob(void);
AnnaBridge 167:e84263d55307 310 };
AnnaBridge 178:79309dc6340a 311
AnnaBridge 178:79309dc6340a 312 /**@}*/
AnnaBridge 178:79309dc6340a 313
AnnaBridge 178:79309dc6340a 314 /**@}*/
AnnaBridge 178:79309dc6340a 315
AnnaBridge 167:e84263d55307 316 } //namespace mbed
AnnaBridge 167:e84263d55307 317
AnnaBridge 167:e84263d55307 318 #endif //MBED_ATCMDPARSER_H