cc
ATParser.h
- Committer:
- geky
- Date:
- 2015-07-20
- Revision:
- 8:91515b168c70
- Parent:
- 7:d1b193880af1
- Child:
- 9:9bcb87c27208
File content as of revision 8:91515b168c70:
/* Copyright (c) 2015 ARM Limited * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. * * @section DESCRIPTION * * Parser for the AT command syntax * */ #include "mbed.h" #include <cstdarg> #include "BufferedSerial.h" /** * Parser class for parsing AT commands * * Here are some examples: * @code * ATParser at = ATParser(serial, "\r\n"); * int value; * char buffer[100]; * * at.send("AT") && at.recv("OK"); * at.send("AT+CWMODE=%d", 3) && at.recv("OK"); * at.send("AT+CWMODE?") && at.recv("+CWMODE:%d\r\nOK", &value); * at.recv("+IPD,%d:", &value); * at.read(buffer, value); * at.recv("OK"); * @endcode */ class ATParser { private: // Serial information BufferedSerial *_serial; int _buffer_size; char *_buffer; int _timeout; // Parsing information const char *_delimiter; int _delim_size; public: /** * Constructor * * @param serial serial interface to use for AT commands * @param buffer_size size of internal buffer for transaction * @param timeout timeout of the connection * @param delimiter string of characters to use as line delimiters */ ATParser(BufferedSerial *serial, const char *delimiter = "\r\n", int buffer_size = 256, int timeout = 8000) : _serial(serial), _buffer_size(buffer_size) { _buffer = new char[buffer_size]; setTimeout(timeout); setDelimiter(delimiter); } /** * Destructor */ ~ATParser() { delete [] _buffer; } /** * Allows timeout to be changed between commands * * @param timeout timeout of the connection */ void setTimeout(int timeout) { _timeout = timeout; } /** * Sets string of characters to use as line delimiters * * @param delimiter string of characters to use as line delimiters */ void setDelimiter(const char *delimiter) { _delimiter = delimiter; _delim_size = strlen(delimiter); } /** * Sends an AT command * * Sends a formatted command using printf style formatting * @see printf * * @param command printf-like format string of command to send which * is appended with the specified delimiter * @param ... all printf-like arguments to insert into command * @return true only if command is successfully sent */ bool send(const char *command, ...); bool vsend(const char *command, va_list args); /** * Recieve an AT response * * Recieves a formatted response using scanf style formatting * @see scanf * * Responses are parsed line at a time using the specified delimiter. * Any recieved data that does not match the response is ignored until * a timeout occurs. * * @param response scanf-like format string of response to expect * @param ... all scanf-like arguments to extract from response * @return true only if response is successfully matched */ bool recv(const char *response, ...); bool vrecv(const char *response, va_list args); /** * Write a single byte to the underlying stream * * @param c The byte to write * @return The byte that was written or -1 during a timeout */ int putc(char c); /** * Get a single byte from the underlying stream * * @return The byte that was read or -1 during a timeout */ int getc(); /** * Write an array of bytes to the underlying stream * * @param data the array of bytes to write * @param size number of bytes to write * @return number of bytes written */ int write(const char *data, int size); /** * Read an array of bytes from the underlying stream * * @param data the destination for the read bytes * @param size number of bytes to read * @return number of bytes read */ int read(char *data, int size); /** * Flushes the underlying stream */ void flush(); };