mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

platform/ATCmdParser.h@170:e95d10626187, 2018-09-06 (annotated)

Committer:
AnnaBridge
Date:
Thu Sep 06 13:39:34 2018 +0100
Revision:
170:e95d10626187
Parent:
165:d1b4690b3f8b
Child:
171:3a7713b1edbc
mbed library. Release version 163

Who changed what in which revision?

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