Diff: ATParser/ATParser.h

Revision:

1:32ac89dcd434

Parent:

0:62e55edab701

--- a/ATParser/ATParser.h	Wed Oct 03 14:03:01 2018 +0000
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,246 +0,0 @@
-/* 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
- *
- */
-#ifndef AT_PARSER_H
-#define AT_PARSER_H
-
-#include "mbed.h"
-#include <cstdarg>
-#include <vector>
-#include "BufferedSpi.h"
-#include "Callback.h"
-
-#define DEFAULT_SPI_TIMEOUT 60000 /* 1 minute */
-
-/**
-* 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
-    BufferedSpi *_serial_spi;
-    int _buffer_size;
-    char *_buffer;
-    Mutex _bufferMutex;
-
-    // Parsing information
-    const char *_delimiter;
-    int _delim_size;
-    char _in_prev;
-    volatile bool _aborted;
-
-    struct oob {
-        unsigned len;
-        const char *prefix;
-        mbed::Callback<void()> cb;
-        oob *next;
-    };
-    oob *_oobs;
-
-public:
-    /**
-    * Constructor
-    *
-    * @param serial spi 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(BufferedSpi &serial_spi, const char *delimiter = "\r\n", int buffer_size = 1440, int timeout = DEFAULT_SPI_TIMEOUT);
-
-    /**
-    * Destructor
-    */
-    ~ATParser()
-    {
-        while (_oobs) {
-            struct oob *oob = _oobs;
-            _oobs = oob->next;
-            delete oob;
-        }
-        delete[] _buffer;
-    }
-
-    /**
-    * Allows timeout to be changed between commands
-    *
-    * @param timeout timeout of the connection
-    */
-    void setTimeout(int timeout)
-    {
-        _serial_spi->setTimeout(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 a newline
-     * @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);
-
-    /**
-     * Receive an AT response
-     *
-     * Receives a formatted response using scanf style formatting
-     * @see scanf
-     *
-     * Responses are parsed line at a time.
-     * Any received 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
-     * assuming the header of the command is already in _txbuffer
-     *
-     * @param data the array of bytes to write
-     * @param size_of_data number of bytes in data array
-     * @param size_in_buff number of bytes already in the internal buff
-     * @return number of bytes written or -1 on failure
-     */
-    int write(const char *data, int size_of_data, int size_in_buff);
-
-    /**
-     * 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 or -1 on failure
-     */
-    int read(char *data);
-
-    /**
-     * Direct printf to underlying stream
-     * @see printf
-     *
-     * @param format format string to pass to printf
-     * @param ... arguments to printf
-     * @return number of bytes written or -1 on failure
-     */
-    int printf(const char *format, ...);
-    int vprintf(const char *format, va_list args);
-
-    /**
-    * Direct scanf on underlying stream
-    * @see ::scanf
-    *
-    * @param format format string to pass to scanf
-    * @param ... arguments to scanf
-    * @return number of bytes read or -1 on failure
-    */
-    int scanf(const char *format, ...);
-
-    int vscanf(const char *format, va_list args);
-
-    /**
-     * Attach a callback for out-of-band data
-     *
-     * @param prefix string on when to initiate callback
-     * @param func callback to call when string is read
-     * @note out-of-band data is only processed during a scanf call
-     */
-    void oob(const char *prefix, mbed::Callback<void()> func);
-
-    /**
-     * Flushes the underlying stream
-     */
-    void flush();
-
-    /**
-     * Abort current recv
-     *
-     * Can be called from oob handler to interrupt the current
-     * recv operation.
-     */
-    void abort();
-
-    /**
-    * Process out-of-band data
-    *
-    * Process out-of-band data in the receive buffer. This function
-    * returns immediately if there is no data to process.
-    *
-    * @return true if oob data processed, false otherwise
-    */
-    bool process_oob(void);
-    /**
-    * Get buffer_size
-    */
-    int get_size(void)
-    {
-        return _buffer_size;
-    }
-
-};
-#endif