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@171:3a7713b1edbc, 2018-11-08 (annotated)

Committer:
AnnaBridge
Date:
Thu Nov 08 11:45:42 2018 +0000
Revision:
171:3a7713b1edbc
Parent:
170:e95d10626187
Child:
172:65be27845400
mbed library. Release version 164

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 171:3a7713b1edbc 68 int _oob_cb_count;
AnnaBridge 156:ff21514d8981 69 char _in_prev;
AnnaBridge 156:ff21514d8981 70 bool _dbg_on;
AnnaBridge 156:ff21514d8981 71 bool _aborted;
AnnaBridge 156:ff21514d8981 72
AnnaBridge 156:ff21514d8981 73 struct oob {
AnnaBridge 156:ff21514d8981 74 unsigned len;
AnnaBridge 156:ff21514d8981 75 const char *prefix;
AnnaBridge 156:ff21514d8981 76 mbed::Callback<void()> cb;
AnnaBridge 156:ff21514d8981 77 oob *next;
AnnaBridge 156:ff21514d8981 78 };
AnnaBridge 156:ff21514d8981 79 oob *_oobs;
AnnaBridge 156:ff21514d8981 80
AnnaBridge 156:ff21514d8981 81 public:
AnnaBridge 156:ff21514d8981 82
AnnaBridge 156:ff21514d8981 83 /**
AnnaBridge 156:ff21514d8981 84 * Constructor
AnnaBridge 156:ff21514d8981 85 *
AnnaBridge 171:3a7713b1edbc 86 * @param fh A FileHandle to the digital interface, used for AT commands
AnnaBridge 171:3a7713b1edbc 87 * @param output_delimiter End of command-line termination
AnnaBridge 171:3a7713b1edbc 88 * @param buffer_size Size of internal buffer for transaction
AnnaBridge 171:3a7713b1edbc 89 * @param timeout Timeout of the connection
AnnaBridge 171:3a7713b1edbc 90 * @param debug Turns on/off debug output for AT commands
AnnaBridge 156:ff21514d8981 91 */
AnnaBridge 156:ff21514d8981 92 ATCmdParser(FileHandle *fh, const char *output_delimiter = "\r",
AnnaBridge 170:e95d10626187 93 int buffer_size = 256, int timeout = 8000, bool debug = false)
AnnaBridge 171:3a7713b1edbc 94 : _fh(fh), _buffer_size(buffer_size), _oob_cb_count(0), _in_prev(0), _oobs(NULL)
AnnaBridge 156:ff21514d8981 95 {
AnnaBridge 156:ff21514d8981 96 _buffer = new char[buffer_size];
AnnaBridge 156:ff21514d8981 97 set_timeout(timeout);
AnnaBridge 156:ff21514d8981 98 set_delimiter(output_delimiter);
AnnaBridge 156:ff21514d8981 99 debug_on(debug);
AnnaBridge 156:ff21514d8981 100 }
AnnaBridge 156:ff21514d8981 101
AnnaBridge 156:ff21514d8981 102 /**
AnnaBridge 156:ff21514d8981 103 * Destructor
AnnaBridge 156:ff21514d8981 104 */
AnnaBridge 156:ff21514d8981 105 ~ATCmdParser()
AnnaBridge 156:ff21514d8981 106 {
AnnaBridge 156:ff21514d8981 107 while (_oobs) {
AnnaBridge 156:ff21514d8981 108 struct oob *oob = _oobs;
AnnaBridge 156:ff21514d8981 109 _oobs = oob->next;
AnnaBridge 156:ff21514d8981 110 delete oob;
AnnaBridge 156:ff21514d8981 111 }
AnnaBridge 156:ff21514d8981 112 delete[] _buffer;
AnnaBridge 156:ff21514d8981 113 }
AnnaBridge 156:ff21514d8981 114
AnnaBridge 156:ff21514d8981 115 /**
AnnaBridge 156:ff21514d8981 116 * Allows timeout to be changed between commands
AnnaBridge 156:ff21514d8981 117 *
AnnaBridge 171:3a7713b1edbc 118 * @param timeout ATCmdParser APIs (read/write/send/recv ..etc) throw an
AnnaBridge 171:3a7713b1edbc 119 * error if no response is received in `timeout` duration
AnnaBridge 156:ff21514d8981 120 */
AnnaBridge 156:ff21514d8981 121 void set_timeout(int timeout)
AnnaBridge 156:ff21514d8981 122 {
AnnaBridge 156:ff21514d8981 123 _timeout = timeout;
AnnaBridge 156:ff21514d8981 124 }
AnnaBridge 156:ff21514d8981 125
AnnaBridge 156:ff21514d8981 126 /**
AnnaBridge 171:3a7713b1edbc 127 * For backward compatibility.
AnnaBridge 165:d1b4690b3f8b 128 * @deprecated Do not use this function. This function has been replaced with set_timeout for consistency.
AnnaBridge 156:ff21514d8981 129 *
AnnaBridge 156:ff21514d8981 130 * Please use set_timeout(int) API only from now on.
AnnaBridge 156:ff21514d8981 131 * Allows timeout to be changed between commands
AnnaBridge 156:ff21514d8981 132 *
AnnaBridge 171:3a7713b1edbc 133 * @param timeout ATCmdParser APIs (read/write/send/recv ..etc) throw an
AnnaBridge 171:3a7713b1edbc 134 * error if no response is received in `timeout` duration
AnnaBridge 171:3a7713b1edbc 135 *
AnnaBridge 156:ff21514d8981 136 */
AnnaBridge 156:ff21514d8981 137 MBED_DEPRECATED_SINCE("mbed-os-5.5.0", "Replaced with set_timeout for consistency")
AnnaBridge 156:ff21514d8981 138 void setTimeout(int timeout)
AnnaBridge 156:ff21514d8981 139 {
AnnaBridge 156:ff21514d8981 140 set_timeout(timeout);
AnnaBridge 156:ff21514d8981 141 }
AnnaBridge 156:ff21514d8981 142
AnnaBridge 156:ff21514d8981 143 /**
AnnaBridge 156:ff21514d8981 144 * Sets string of characters to use as line delimiters
AnnaBridge 156:ff21514d8981 145 *
AnnaBridge 171:3a7713b1edbc 146 * @param output_delimiter String of characters to use as line delimiters
AnnaBridge 156:ff21514d8981 147 */
AnnaBridge 156:ff21514d8981 148 void set_delimiter(const char *output_delimiter)
AnnaBridge 156:ff21514d8981 149 {
AnnaBridge 156:ff21514d8981 150 _output_delimiter = output_delimiter;
AnnaBridge 156:ff21514d8981 151 _output_delim_size = strlen(output_delimiter);
AnnaBridge 156:ff21514d8981 152 }
AnnaBridge 156:ff21514d8981 153
AnnaBridge 156:ff21514d8981 154 /**
AnnaBridge 156:ff21514d8981 155 * For backwards compatibility.
AnnaBridge 165:d1b4690b3f8b 156 * @deprecated Do not use this function. This function has been replaced with set_delimiter for consistency.
AnnaBridge 156:ff21514d8981 157 *
AnnaBridge 156:ff21514d8981 158 * Please use set_delimiter(const char *) API only from now on.
AnnaBridge 156:ff21514d8981 159 * Sets string of characters to use as line delimiters
AnnaBridge 156:ff21514d8981 160 *
AnnaBridge 156:ff21514d8981 161 * @param output_delimiter string of characters to use as line delimiters
AnnaBridge 156:ff21514d8981 162 */
AnnaBridge 156:ff21514d8981 163 MBED_DEPRECATED_SINCE("mbed-os-5.5.0", "Replaced with set_delimiter for consistency")
AnnaBridge 156:ff21514d8981 164 void setDelimiter(const char *output_delimiter)
AnnaBridge 156:ff21514d8981 165 {
AnnaBridge 156:ff21514d8981 166 set_delimiter(output_delimiter);
AnnaBridge 156:ff21514d8981 167 }
AnnaBridge 156:ff21514d8981 168
AnnaBridge 156:ff21514d8981 169 /**
AnnaBridge 156:ff21514d8981 170 * Allows traces from modem to be turned on or off
AnnaBridge 156:ff21514d8981 171 *
AnnaBridge 171:3a7713b1edbc 172 * @param on Set as 1 to turn on traces and vice versa.
AnnaBridge 156:ff21514d8981 173 */
AnnaBridge 156:ff21514d8981 174 void debug_on(uint8_t on)
AnnaBridge 156:ff21514d8981 175 {
AnnaBridge 156:ff21514d8981 176 _dbg_on = (on) ? 1 : 0;
AnnaBridge 156:ff21514d8981 177 }
AnnaBridge 156:ff21514d8981 178
AnnaBridge 156:ff21514d8981 179 /**
AnnaBridge 171:3a7713b1edbc 180 * For backward compatibility.
AnnaBridge 165:d1b4690b3f8b 181 * @deprecated Do not use this function. This function has been replaced with debug_on for consistency.
AnnaBridge 156:ff21514d8981 182 *
AnnaBridge 156:ff21514d8981 183 * Allows traces from modem to be turned on or off
AnnaBridge 156:ff21514d8981 184 *
AnnaBridge 171:3a7713b1edbc 185 * @param on Set as 1 to turn on traces and vice versa.
AnnaBridge 156:ff21514d8981 186 */
AnnaBridge 156:ff21514d8981 187 MBED_DEPRECATED_SINCE("mbed-os-5.5.0", "Replaced with debug_on for consistency")
AnnaBridge 156:ff21514d8981 188 void debugOn(uint8_t on)
AnnaBridge 156:ff21514d8981 189 {
AnnaBridge 156:ff21514d8981 190 debug_on(on);
AnnaBridge 156:ff21514d8981 191 }
AnnaBridge 156:ff21514d8981 192
AnnaBridge 156:ff21514d8981 193 /**
AnnaBridge 156:ff21514d8981 194 * Sends an AT command
AnnaBridge 156:ff21514d8981 195 *
AnnaBridge 156:ff21514d8981 196 * Sends a formatted command using printf style formatting
AnnaBridge 156:ff21514d8981 197 * @see printf
AnnaBridge 156:ff21514d8981 198 *
AnnaBridge 156:ff21514d8981 199 * @param command printf-like format string of command to send which
AnnaBridge 156:ff21514d8981 200 * is appended with a newline
AnnaBridge 156:ff21514d8981 201 * @param ... all printf-like arguments to insert into command
AnnaBridge 156:ff21514d8981 202 * @return true only if command is successfully sent
AnnaBridge 156:ff21514d8981 203 */
AnnaBridge 170:e95d10626187 204 bool send(const char *command, ...) MBED_PRINTF_METHOD(1, 2);
AnnaBridge 156:ff21514d8981 205
AnnaBridge 156:ff21514d8981 206 bool vsend(const char *command, va_list args);
AnnaBridge 156:ff21514d8981 207
AnnaBridge 156:ff21514d8981 208 /**
AnnaBridge 156:ff21514d8981 209 * Receive an AT response
AnnaBridge 156:ff21514d8981 210 *
AnnaBridge 156:ff21514d8981 211 * Receives a formatted response using scanf style formatting
AnnaBridge 156:ff21514d8981 212 * @see scanf
AnnaBridge 156:ff21514d8981 213 *
AnnaBridge 156:ff21514d8981 214 * Responses are parsed line at a time.
AnnaBridge 156:ff21514d8981 215 * Any received data that does not match the response is ignored until
AnnaBridge 156:ff21514d8981 216 * a timeout occurs.
AnnaBridge 156:ff21514d8981 217 *
AnnaBridge 156:ff21514d8981 218 * @param response scanf-like format string of response to expect
AnnaBridge 156:ff21514d8981 219 * @param ... all scanf-like arguments to extract from response
AnnaBridge 156:ff21514d8981 220 * @return true only if response is successfully matched
AnnaBridge 156:ff21514d8981 221 */
AnnaBridge 170:e95d10626187 222 bool recv(const char *response, ...) MBED_SCANF_METHOD(1, 2);
AnnaBridge 156:ff21514d8981 223
AnnaBridge 156:ff21514d8981 224 bool vrecv(const char *response, va_list args);
AnnaBridge 156:ff21514d8981 225
AnnaBridge 156:ff21514d8981 226 /**
AnnaBridge 156:ff21514d8981 227 * Write a single byte to the underlying stream
AnnaBridge 156:ff21514d8981 228 *
AnnaBridge 156:ff21514d8981 229 * @param c The byte to write
AnnaBridge 156:ff21514d8981 230 * @return The byte that was written or -1 during a timeout
AnnaBridge 156:ff21514d8981 231 */
AnnaBridge 156:ff21514d8981 232 int putc(char c);
AnnaBridge 156:ff21514d8981 233
AnnaBridge 156:ff21514d8981 234 /**
AnnaBridge 156:ff21514d8981 235 * Get a single byte from the underlying stream
AnnaBridge 156:ff21514d8981 236 *
AnnaBridge 156:ff21514d8981 237 * @return The byte that was read or -1 during a timeout
AnnaBridge 156:ff21514d8981 238 */
AnnaBridge 156:ff21514d8981 239 int getc();
AnnaBridge 156:ff21514d8981 240
AnnaBridge 156:ff21514d8981 241 /**
AnnaBridge 156:ff21514d8981 242 * Write an array of bytes to the underlying stream
AnnaBridge 156:ff21514d8981 243 *
AnnaBridge 171:3a7713b1edbc 244 * @param data The array of bytes to write
AnnaBridge 171:3a7713b1edbc 245 * @param size Number of bytes to write
AnnaBridge 156:ff21514d8981 246 * @return number of bytes written or -1 on failure
AnnaBridge 156:ff21514d8981 247 */
AnnaBridge 156:ff21514d8981 248 int write(const char *data, int size);
AnnaBridge 156:ff21514d8981 249
AnnaBridge 156:ff21514d8981 250 /**
AnnaBridge 156:ff21514d8981 251 * Read an array of bytes from the underlying stream
AnnaBridge 156:ff21514d8981 252 *
AnnaBridge 171:3a7713b1edbc 253 * @param data The buffer for filling the read bytes
AnnaBridge 171:3a7713b1edbc 254 * @param size Number of bytes to read
AnnaBridge 156:ff21514d8981 255 * @return number of bytes read or -1 on failure
AnnaBridge 156:ff21514d8981 256 */
AnnaBridge 156:ff21514d8981 257 int read(char *data, int size);
AnnaBridge 156:ff21514d8981 258
AnnaBridge 156:ff21514d8981 259 /**
AnnaBridge 156:ff21514d8981 260 * Direct printf to underlying stream
AnnaBridge 156:ff21514d8981 261 * @see printf
AnnaBridge 156:ff21514d8981 262 *
AnnaBridge 171:3a7713b1edbc 263 * @param format Format string to pass to printf
AnnaBridge 171:3a7713b1edbc 264 * @param ... Variable arguments to printf
AnnaBridge 156:ff21514d8981 265 * @return number of bytes written or -1 on failure
AnnaBridge 156:ff21514d8981 266 */
AnnaBridge 170:e95d10626187 267 int printf(const char *format, ...) MBED_PRINTF_METHOD(1, 2);
AnnaBridge 156:ff21514d8981 268
AnnaBridge 156:ff21514d8981 269 int vprintf(const char *format, va_list args);
AnnaBridge 156:ff21514d8981 270
AnnaBridge 156:ff21514d8981 271 /**
AnnaBridge 156:ff21514d8981 272 * Direct scanf on underlying stream
AnnaBridge 156:ff21514d8981 273 * @see scanf
AnnaBridge 156:ff21514d8981 274 *
AnnaBridge 171:3a7713b1edbc 275 * @param format Format string to pass to scanf
AnnaBridge 171:3a7713b1edbc 276 * @param ... Variable arguments to scanf
AnnaBridge 156:ff21514d8981 277 * @return number of bytes read or -1 on failure
AnnaBridge 156:ff21514d8981 278 */
AnnaBridge 170:e95d10626187 279 int scanf(const char *format, ...) MBED_SCANF_METHOD(1, 2);
AnnaBridge 156:ff21514d8981 280
AnnaBridge 156:ff21514d8981 281 int vscanf(const char *format, va_list args);
AnnaBridge 156:ff21514d8981 282
AnnaBridge 156:ff21514d8981 283 /**
AnnaBridge 156:ff21514d8981 284 * Attach a callback for out-of-band data
AnnaBridge 156:ff21514d8981 285 *
AnnaBridge 171:3a7713b1edbc 286 * @param prefix String on when to initiate callback
AnnaBridge 171:3a7713b1edbc 287 * @param func Callback to call when string is read
AnnaBridge 156:ff21514d8981 288 * @note out-of-band data is only processed during a scanf call
AnnaBridge 156:ff21514d8981 289 */
AnnaBridge 156:ff21514d8981 290 void oob(const char *prefix, mbed::Callback<void()> func);
AnnaBridge 156:ff21514d8981 291
AnnaBridge 156:ff21514d8981 292 /**
AnnaBridge 156:ff21514d8981 293 * Flushes the underlying stream
AnnaBridge 156:ff21514d8981 294 */
AnnaBridge 156:ff21514d8981 295 void flush();
AnnaBridge 156:ff21514d8981 296
AnnaBridge 156:ff21514d8981 297 /**
AnnaBridge 156:ff21514d8981 298 * Abort current recv
AnnaBridge 156:ff21514d8981 299 *
AnnaBridge 171:3a7713b1edbc 300 * Can be called from out-of-band handler to interrupt the current
AnnaBridge 156:ff21514d8981 301 * recv operation.
AnnaBridge 156:ff21514d8981 302 */
AnnaBridge 156:ff21514d8981 303 void abort();
AnnaBridge 170:e95d10626187 304
AnnaBridge 156:ff21514d8981 305 /**
AnnaBridge 156:ff21514d8981 306 * Process out-of-band data
AnnaBridge 156:ff21514d8981 307 *
AnnaBridge 156:ff21514d8981 308 * Process out-of-band data in the receive buffer. This function
AnnaBridge 156:ff21514d8981 309 * returns immediately if there is no data to process.
AnnaBridge 156:ff21514d8981 310 *
AnnaBridge 171:3a7713b1edbc 311 * @return true if out-of-band data processed, false otherwise
AnnaBridge 156:ff21514d8981 312 */
AnnaBridge 156:ff21514d8981 313 bool process_oob(void);
AnnaBridge 156:ff21514d8981 314 };
AnnaBridge 158:1c57384330a6 315
AnnaBridge 158:1c57384330a6 316 /**@}*/
AnnaBridge 158:1c57384330a6 317
AnnaBridge 158:1c57384330a6 318 /**@}*/
AnnaBridge 158:1c57384330a6 319
AnnaBridge 156:ff21514d8981 320 } //namespace mbed
AnnaBridge 156:ff21514d8981 321
AnnaBridge 156:ff21514d8981 322 #endif //MBED_ATCMDPARSER_H