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@145:64910690c574, 2017-06-21 (annotated)

Committer:
AnnaBridge
Date:
Wed Jun 21 17:31:38 2017 +0100
Revision:
145:64910690c574
Child:
146:22da6e220af6
Release 145 of the mbed library.

Who changed what in which revision?

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