Ram Gandikota / Mbed OS ABCD

A metronome using the FRDM K64F board

easy-connect/esp8266-driver/ESP8266/ATParser/ATParser.cpp@0:a7a43371b306, 2017-05-14 (annotated)

Committer:
ram54288
Date:
Sun May 14 18:40:18 2017 +0000
Revision:
0:a7a43371b306
Initial commit

Who changed what in which revision?

UserRevisionLine numberNew contents of line
ram54288 0:a7a43371b306 1 /* Copyright (c) 2015 ARM Limited
ram54288 0:a7a43371b306 2 *
ram54288 0:a7a43371b306 3 * Licensed under the Apache License, Version 2.0 (the "License");
ram54288 0:a7a43371b306 4 * you may not use this file except in compliance with the License.
ram54288 0:a7a43371b306 5 * You may obtain a copy of the License at
ram54288 0:a7a43371b306 6 *
ram54288 0:a7a43371b306 7 * http://www.apache.org/licenses/LICENSE-2.0
ram54288 0:a7a43371b306 8 *
ram54288 0:a7a43371b306 9 * Unless required by applicable law or agreed to in writing, software
ram54288 0:a7a43371b306 10 * distributed under the License is distributed on an "AS IS" BASIS,
ram54288 0:a7a43371b306 11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
ram54288 0:a7a43371b306 12 * See the License for the specific language governing permissions and
ram54288 0:a7a43371b306 13 * limitations under the License.
ram54288 0:a7a43371b306 14 *
ram54288 0:a7a43371b306 15 * @section DESCRIPTION
ram54288 0:a7a43371b306 16 *
ram54288 0:a7a43371b306 17 * Parser for the AT command syntax
ram54288 0:a7a43371b306 18 *
ram54288 0:a7a43371b306 19 */
ram54288 0:a7a43371b306 20
ram54288 0:a7a43371b306 21 #include "ATParser.h"
ram54288 0:a7a43371b306 22 #include "mbed_debug.h"
ram54288 0:a7a43371b306 23
ram54288 0:a7a43371b306 24
ram54288 0:a7a43371b306 25 // getc/putc handling with timeouts
ram54288 0:a7a43371b306 26 int ATParser::putc(char c)
ram54288 0:a7a43371b306 27 {
ram54288 0:a7a43371b306 28 Timer timer;
ram54288 0:a7a43371b306 29 timer.start();
ram54288 0:a7a43371b306 30
ram54288 0:a7a43371b306 31 while (true) {
ram54288 0:a7a43371b306 32 if (_serial->writeable()) {
ram54288 0:a7a43371b306 33 return _serial->putc(c);
ram54288 0:a7a43371b306 34 }
ram54288 0:a7a43371b306 35 if (timer.read_ms() > _timeout) {
ram54288 0:a7a43371b306 36 return -1;
ram54288 0:a7a43371b306 37 }
ram54288 0:a7a43371b306 38 }
ram54288 0:a7a43371b306 39 }
ram54288 0:a7a43371b306 40
ram54288 0:a7a43371b306 41 int ATParser::getc()
ram54288 0:a7a43371b306 42 {
ram54288 0:a7a43371b306 43 Timer timer;
ram54288 0:a7a43371b306 44 timer.start();
ram54288 0:a7a43371b306 45
ram54288 0:a7a43371b306 46 while (true) {
ram54288 0:a7a43371b306 47 if (_serial->readable()) {
ram54288 0:a7a43371b306 48 return _serial->getc();
ram54288 0:a7a43371b306 49 }
ram54288 0:a7a43371b306 50 if (timer.read_ms() > _timeout) {
ram54288 0:a7a43371b306 51 return -1;
ram54288 0:a7a43371b306 52 }
ram54288 0:a7a43371b306 53 }
ram54288 0:a7a43371b306 54 }
ram54288 0:a7a43371b306 55
ram54288 0:a7a43371b306 56 void ATParser::flush()
ram54288 0:a7a43371b306 57 {
ram54288 0:a7a43371b306 58 while (_serial->readable()) {
ram54288 0:a7a43371b306 59 _serial->getc();
ram54288 0:a7a43371b306 60 }
ram54288 0:a7a43371b306 61 }
ram54288 0:a7a43371b306 62
ram54288 0:a7a43371b306 63
ram54288 0:a7a43371b306 64 // read/write handling with timeouts
ram54288 0:a7a43371b306 65 int ATParser::write(const char *data, int size)
ram54288 0:a7a43371b306 66 {
ram54288 0:a7a43371b306 67 int i = 0;
ram54288 0:a7a43371b306 68 for ( ; i < size; i++) {
ram54288 0:a7a43371b306 69 if (putc(data[i]) < 0) {
ram54288 0:a7a43371b306 70 return -1;
ram54288 0:a7a43371b306 71 }
ram54288 0:a7a43371b306 72 }
ram54288 0:a7a43371b306 73 return i;
ram54288 0:a7a43371b306 74 }
ram54288 0:a7a43371b306 75
ram54288 0:a7a43371b306 76 int ATParser::read(char *data, int size)
ram54288 0:a7a43371b306 77 {
ram54288 0:a7a43371b306 78 int i = 0;
ram54288 0:a7a43371b306 79 for ( ; i < size; i++) {
ram54288 0:a7a43371b306 80 int c = getc();
ram54288 0:a7a43371b306 81 if (c < 0) {
ram54288 0:a7a43371b306 82 return -1;
ram54288 0:a7a43371b306 83 }
ram54288 0:a7a43371b306 84 data[i] = c;
ram54288 0:a7a43371b306 85 }
ram54288 0:a7a43371b306 86 return i;
ram54288 0:a7a43371b306 87 }
ram54288 0:a7a43371b306 88
ram54288 0:a7a43371b306 89
ram54288 0:a7a43371b306 90 // printf/scanf handling
ram54288 0:a7a43371b306 91 int ATParser::vprintf(const char *format, va_list args)
ram54288 0:a7a43371b306 92 {
ram54288 0:a7a43371b306 93 if (vsprintf(_buffer, format, args) < 0) {
ram54288 0:a7a43371b306 94 return false;
ram54288 0:a7a43371b306 95 }
ram54288 0:a7a43371b306 96 int i = 0;
ram54288 0:a7a43371b306 97 for ( ; _buffer[i]; i++) {
ram54288 0:a7a43371b306 98 if (putc(_buffer[i]) < 0) {
ram54288 0:a7a43371b306 99 return -1;
ram54288 0:a7a43371b306 100 }
ram54288 0:a7a43371b306 101 }
ram54288 0:a7a43371b306 102 return i;
ram54288 0:a7a43371b306 103 }
ram54288 0:a7a43371b306 104
ram54288 0:a7a43371b306 105 int ATParser::vscanf(const char *format, va_list args)
ram54288 0:a7a43371b306 106 {
ram54288 0:a7a43371b306 107 // Since format is const, we need to copy it into our buffer to
ram54288 0:a7a43371b306 108 // add the line's null terminator and clobber value-matches with asterisks.
ram54288 0:a7a43371b306 109 //
ram54288 0:a7a43371b306 110 // We just use the beginning of the buffer to avoid unnecessary allocations.
ram54288 0:a7a43371b306 111 int i = 0;
ram54288 0:a7a43371b306 112 int offset = 0;
ram54288 0:a7a43371b306 113
ram54288 0:a7a43371b306 114 while (format[i]) {
ram54288 0:a7a43371b306 115 if (format[i] == '%' && format[i+1] != '%' && format[i+1] != '*') {
ram54288 0:a7a43371b306 116 _buffer[offset++] = '%';
ram54288 0:a7a43371b306 117 _buffer[offset++] = '*';
ram54288 0:a7a43371b306 118 i++;
ram54288 0:a7a43371b306 119 } else {
ram54288 0:a7a43371b306 120 _buffer[offset++] = format[i++];
ram54288 0:a7a43371b306 121 }
ram54288 0:a7a43371b306 122 }
ram54288 0:a7a43371b306 123
ram54288 0:a7a43371b306 124 // Scanf has very poor support for catching errors
ram54288 0:a7a43371b306 125 // fortunately, we can abuse the %n specifier to determine
ram54288 0:a7a43371b306 126 // if the entire string was matched.
ram54288 0:a7a43371b306 127 _buffer[offset++] = '%';
ram54288 0:a7a43371b306 128 _buffer[offset++] = 'n';
ram54288 0:a7a43371b306 129 _buffer[offset++] = 0;
ram54288 0:a7a43371b306 130
ram54288 0:a7a43371b306 131 // To workaround scanf's lack of error reporting, we actually
ram54288 0:a7a43371b306 132 // make two passes. One checks the validity with the modified
ram54288 0:a7a43371b306 133 // format string that only stores the matched characters (%n).
ram54288 0:a7a43371b306 134 // The other reads in the actual matched values.
ram54288 0:a7a43371b306 135 //
ram54288 0:a7a43371b306 136 // We keep trying the match until we succeed or some other error
ram54288 0:a7a43371b306 137 // derails us.
ram54288 0:a7a43371b306 138 int j = 0;
ram54288 0:a7a43371b306 139
ram54288 0:a7a43371b306 140 while (true) {
ram54288 0:a7a43371b306 141 // Ran out of space
ram54288 0:a7a43371b306 142 if (j+1 >= _buffer_size - offset) {
ram54288 0:a7a43371b306 143 return false;
ram54288 0:a7a43371b306 144 }
ram54288 0:a7a43371b306 145 // Recieve next character
ram54288 0:a7a43371b306 146 int c = getc();
ram54288 0:a7a43371b306 147 if (c < 0) {
ram54288 0:a7a43371b306 148 return -1;
ram54288 0:a7a43371b306 149 }
ram54288 0:a7a43371b306 150 _buffer[offset + j++] = c;
ram54288 0:a7a43371b306 151 _buffer[offset + j] = 0;
ram54288 0:a7a43371b306 152
ram54288 0:a7a43371b306 153 // Check for match
ram54288 0:a7a43371b306 154 int count = -1;
ram54288 0:a7a43371b306 155 sscanf(_buffer+offset, _buffer, &count);
ram54288 0:a7a43371b306 156
ram54288 0:a7a43371b306 157 // We only succeed if all characters in the response are matched
ram54288 0:a7a43371b306 158 if (count == j) {
ram54288 0:a7a43371b306 159 // Store the found results
ram54288 0:a7a43371b306 160 vsscanf(_buffer+offset, format, args);
ram54288 0:a7a43371b306 161 return j;
ram54288 0:a7a43371b306 162 }
ram54288 0:a7a43371b306 163 }
ram54288 0:a7a43371b306 164 }
ram54288 0:a7a43371b306 165
ram54288 0:a7a43371b306 166
ram54288 0:a7a43371b306 167 // Command parsing with line handling
ram54288 0:a7a43371b306 168 bool ATParser::vsend(const char *command, va_list args)
ram54288 0:a7a43371b306 169 {
ram54288 0:a7a43371b306 170 // Create and send command
ram54288 0:a7a43371b306 171 if (vsprintf(_buffer, command, args) < 0) {
ram54288 0:a7a43371b306 172 return false;
ram54288 0:a7a43371b306 173 }
ram54288 0:a7a43371b306 174 for (int i = 0; _buffer[i]; i++) {
ram54288 0:a7a43371b306 175 if (putc(_buffer[i]) < 0) {
ram54288 0:a7a43371b306 176 return false;
ram54288 0:a7a43371b306 177 }
ram54288 0:a7a43371b306 178 }
ram54288 0:a7a43371b306 179
ram54288 0:a7a43371b306 180 // Finish with newline
ram54288 0:a7a43371b306 181 for (int i = 0; _delimiter[i]; i++) {
ram54288 0:a7a43371b306 182 if (putc(_delimiter[i]) < 0) {
ram54288 0:a7a43371b306 183 return false;
ram54288 0:a7a43371b306 184 }
ram54288 0:a7a43371b306 185 }
ram54288 0:a7a43371b306 186
ram54288 0:a7a43371b306 187 debug_if(dbg_on, "AT> %s\r\n", _buffer);
ram54288 0:a7a43371b306 188 return true;
ram54288 0:a7a43371b306 189 }
ram54288 0:a7a43371b306 190
ram54288 0:a7a43371b306 191 bool ATParser::vrecv(const char *response, va_list args)
ram54288 0:a7a43371b306 192 {
ram54288 0:a7a43371b306 193 // Iterate through each line in the expected response
ram54288 0:a7a43371b306 194 while (response[0]) {
ram54288 0:a7a43371b306 195 // Since response is const, we need to copy it into our buffer to
ram54288 0:a7a43371b306 196 // add the line's null terminator and clobber value-matches with asterisks.
ram54288 0:a7a43371b306 197 //
ram54288 0:a7a43371b306 198 // We just use the beginning of the buffer to avoid unnecessary allocations.
ram54288 0:a7a43371b306 199 int i = 0;
ram54288 0:a7a43371b306 200 int offset = 0;
ram54288 0:a7a43371b306 201
ram54288 0:a7a43371b306 202 while (response[i]) {
ram54288 0:a7a43371b306 203 if (memcmp(&response[i+1-_delim_size], _delimiter, _delim_size) == 0) {
ram54288 0:a7a43371b306 204 i++;
ram54288 0:a7a43371b306 205 break;
ram54288 0:a7a43371b306 206 } else if (response[i] == '%' && response[i+1] != '%' && response[i+1] != '*') {
ram54288 0:a7a43371b306 207 _buffer[offset++] = '%';
ram54288 0:a7a43371b306 208 _buffer[offset++] = '*';
ram54288 0:a7a43371b306 209 i++;
ram54288 0:a7a43371b306 210 } else {
ram54288 0:a7a43371b306 211 _buffer[offset++] = response[i++];
ram54288 0:a7a43371b306 212 }
ram54288 0:a7a43371b306 213 }
ram54288 0:a7a43371b306 214
ram54288 0:a7a43371b306 215 // Scanf has very poor support for catching errors
ram54288 0:a7a43371b306 216 // fortunately, we can abuse the %n specifier to determine
ram54288 0:a7a43371b306 217 // if the entire string was matched.
ram54288 0:a7a43371b306 218 _buffer[offset++] = '%';
ram54288 0:a7a43371b306 219 _buffer[offset++] = 'n';
ram54288 0:a7a43371b306 220 _buffer[offset++] = 0;
ram54288 0:a7a43371b306 221
ram54288 0:a7a43371b306 222 // To workaround scanf's lack of error reporting, we actually
ram54288 0:a7a43371b306 223 // make two passes. One checks the validity with the modified
ram54288 0:a7a43371b306 224 // format string that only stores the matched characters (%n).
ram54288 0:a7a43371b306 225 // The other reads in the actual matched values.
ram54288 0:a7a43371b306 226 //
ram54288 0:a7a43371b306 227 // We keep trying the match until we succeed or some other error
ram54288 0:a7a43371b306 228 // derails us.
ram54288 0:a7a43371b306 229 int j = 0;
ram54288 0:a7a43371b306 230
ram54288 0:a7a43371b306 231 while (true) {
ram54288 0:a7a43371b306 232 // Recieve next character
ram54288 0:a7a43371b306 233 int c = getc();
ram54288 0:a7a43371b306 234 if (c < 0) {
ram54288 0:a7a43371b306 235 return false;
ram54288 0:a7a43371b306 236 }
ram54288 0:a7a43371b306 237 _buffer[offset + j++] = c;
ram54288 0:a7a43371b306 238 _buffer[offset + j] = 0;
ram54288 0:a7a43371b306 239
ram54288 0:a7a43371b306 240 // Check for oob data
ram54288 0:a7a43371b306 241 for (int k = 0; k < _oobs.size(); k++) {
ram54288 0:a7a43371b306 242 if (j == _oobs[k].len && memcmp(
ram54288 0:a7a43371b306 243 _oobs[k].prefix, _buffer+offset, _oobs[k].len) == 0) {
ram54288 0:a7a43371b306 244 debug_if(dbg_on, "AT! %s\r\n", _oobs[k].prefix);
ram54288 0:a7a43371b306 245 _oobs[k].cb();
ram54288 0:a7a43371b306 246
ram54288 0:a7a43371b306 247 // oob may have corrupted non-reentrant buffer,
ram54288 0:a7a43371b306 248 // so we need to set it up again
ram54288 0:a7a43371b306 249 return vrecv(response, args);
ram54288 0:a7a43371b306 250 }
ram54288 0:a7a43371b306 251 }
ram54288 0:a7a43371b306 252
ram54288 0:a7a43371b306 253 // Check for match
ram54288 0:a7a43371b306 254 int count = -1;
ram54288 0:a7a43371b306 255 sscanf(_buffer+offset, _buffer, &count);
ram54288 0:a7a43371b306 256
ram54288 0:a7a43371b306 257 // We only succeed if all characters in the response are matched
ram54288 0:a7a43371b306 258 if (count == j) {
ram54288 0:a7a43371b306 259 debug_if(dbg_on, "AT= %s\r\n", _buffer+offset);
ram54288 0:a7a43371b306 260 // Reuse the front end of the buffer
ram54288 0:a7a43371b306 261 memcpy(_buffer, response, i);
ram54288 0:a7a43371b306 262 _buffer[i] = 0;
ram54288 0:a7a43371b306 263
ram54288 0:a7a43371b306 264 // Store the found results
ram54288 0:a7a43371b306 265 vsscanf(_buffer+offset, _buffer, args);
ram54288 0:a7a43371b306 266
ram54288 0:a7a43371b306 267 // Jump to next line and continue parsing
ram54288 0:a7a43371b306 268 response += i;
ram54288 0:a7a43371b306 269 break;
ram54288 0:a7a43371b306 270 }
ram54288 0:a7a43371b306 271
ram54288 0:a7a43371b306 272 // Clear the buffer when we hit a newline or ran out of space
ram54288 0:a7a43371b306 273 // running out of space usually means we ran into binary data
ram54288 0:a7a43371b306 274 if (j+1 >= _buffer_size - offset ||
ram54288 0:a7a43371b306 275 strcmp(&_buffer[offset + j-_delim_size], _delimiter) == 0) {
ram54288 0:a7a43371b306 276
ram54288 0:a7a43371b306 277 debug_if(dbg_on, "AT< %s", _buffer+offset);
ram54288 0:a7a43371b306 278 j = 0;
ram54288 0:a7a43371b306 279 }
ram54288 0:a7a43371b306 280 }
ram54288 0:a7a43371b306 281 }
ram54288 0:a7a43371b306 282
ram54288 0:a7a43371b306 283 return true;
ram54288 0:a7a43371b306 284 }
ram54288 0:a7a43371b306 285
ram54288 0:a7a43371b306 286
ram54288 0:a7a43371b306 287 // Mapping to vararg functions
ram54288 0:a7a43371b306 288 int ATParser::printf(const char *format, ...)
ram54288 0:a7a43371b306 289 {
ram54288 0:a7a43371b306 290 va_list args;
ram54288 0:a7a43371b306 291 va_start(args, format);
ram54288 0:a7a43371b306 292 int res = vprintf(format, args);
ram54288 0:a7a43371b306 293 va_end(args);
ram54288 0:a7a43371b306 294 return res;
ram54288 0:a7a43371b306 295 }
ram54288 0:a7a43371b306 296
ram54288 0:a7a43371b306 297 int ATParser::scanf(const char *format, ...)
ram54288 0:a7a43371b306 298 {
ram54288 0:a7a43371b306 299 va_list args;
ram54288 0:a7a43371b306 300 va_start(args, format);
ram54288 0:a7a43371b306 301 int res = vscanf(format, args);
ram54288 0:a7a43371b306 302 va_end(args);
ram54288 0:a7a43371b306 303 return res;
ram54288 0:a7a43371b306 304 }
ram54288 0:a7a43371b306 305
ram54288 0:a7a43371b306 306 bool ATParser::send(const char *command, ...)
ram54288 0:a7a43371b306 307 {
ram54288 0:a7a43371b306 308 va_list args;
ram54288 0:a7a43371b306 309 va_start(args, command);
ram54288 0:a7a43371b306 310 bool res = vsend(command, args);
ram54288 0:a7a43371b306 311 va_end(args);
ram54288 0:a7a43371b306 312 return res;
ram54288 0:a7a43371b306 313 }
ram54288 0:a7a43371b306 314
ram54288 0:a7a43371b306 315 bool ATParser::recv(const char *response, ...)
ram54288 0:a7a43371b306 316 {
ram54288 0:a7a43371b306 317 va_list args;
ram54288 0:a7a43371b306 318 va_start(args, response);
ram54288 0:a7a43371b306 319 bool res = vrecv(response, args);
ram54288 0:a7a43371b306 320 va_end(args);
ram54288 0:a7a43371b306 321 return res;
ram54288 0:a7a43371b306 322 }
ram54288 0:a7a43371b306 323
ram54288 0:a7a43371b306 324
ram54288 0:a7a43371b306 325 // oob registration
ram54288 0:a7a43371b306 326 void ATParser::oob(const char *prefix, Callback<void()> cb)
ram54288 0:a7a43371b306 327 {
ram54288 0:a7a43371b306 328 struct oob oob;
ram54288 0:a7a43371b306 329 oob.len = strlen(prefix);
ram54288 0:a7a43371b306 330 oob.prefix = prefix;
ram54288 0:a7a43371b306 331 oob.cb = cb;
ram54288 0:a7a43371b306 332 _oobs.push_back(oob);
ram54288 0:a7a43371b306 333 }