Ram Gandikota / Mbed OS IOTMetronome

FRDM K64F Metronome

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

Committer:
ram54288
Date:
Sun May 14 18:37:05 2017 +0000
Revision:
0:dbad57390bd1
Initial commit

Who changed what in which revision?

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