sun peng / Mbed OS STM32F103C8T6_OneNet_IoT

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependencies:   cJSON_lib Common_lib EdpKit_lib DHT ESP8266 wifi_example

esp8266-driver/ESP8266/ATParser/ATParser.cpp@0:b887535f68bf, 2017-01-12 (annotated)

Committer:
group-ESP8266
Date:
Thu Jan 12 20:21:45 2017 +0000
Revision:
0:b887535f68bf
Initial commit

Who changed what in which revision?

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