Diff: mbed/platform/ATCmdParser.h

Revision:

12:406f75196a12

Parent:

11:32eeb052cda5

Child:

13:0c732e06d675

diff -r 32eeb052cda5 -r 406f75196a12 mbed/platform/ATCmdParser.h
--- a/mbed/platform/ATCmdParser.h	Wed Aug 26 14:26:27 2020 +0530
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,324 +0,0 @@
-/* Copyright (c) 2017 ARM Limited
- * SPDX-License-Identifier: Apache-2.0
- *
- * 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 MBED_ATCMDPARSER_H
-#define MBED_ATCMDPARSER_H
-
-#include <cstdarg>
-#include "Callback.h"
-#include "NonCopyable.h"
-#include "FileHandle.h"
-
-namespace mbed {
-
-/** \addtogroup platform */
-/** @{*/
-/**
- * \defgroup platform_ATCmdParser ATCmdParser class
- * @{
- */
-
-/**
- * Parser class for parsing AT commands
- *
- * Here are some examples:
- * @code
- * UARTSerial serial = UARTSerial(D1, D0);
- * ATCmdParser at = ATCmdParser(&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 ATCmdParser : private NonCopyable<ATCmdParser> {
-private:
-    // File handle
-    // Not owned by ATCmdParser
-    FileHandle *_fh;
-
-    int _buffer_size;
-    char *_buffer;
-    int _timeout;
-
-    // Parsing information
-    const char *_output_delimiter;
-    int _output_delim_size;
-    int _oob_cb_count;
-    char _in_prev;
-    bool _dbg_on;
-    bool _aborted;
-
-    struct oob {
-        unsigned len;
-        const char *prefix;
-        mbed::Callback<void()> cb;
-        oob *next;
-    };
-    oob *_oobs;
-
-public:
-
-    /**
-     * Constructor
-     *
-     * @param fh A FileHandle to the digital interface, used for AT commands
-     * @param output_delimiter End of command-line termination
-     * @param buffer_size Size of internal buffer for transaction
-     * @param timeout Timeout of the connection
-     * @param debug Turns on/off debug output for AT commands
-     */
-    ATCmdParser(FileHandle *fh, const char *output_delimiter = "\r",
-                int buffer_size = 256, int timeout = 8000, bool debug = false)
-        : _fh(fh), _buffer_size(buffer_size), _oob_cb_count(0), _in_prev(0), _oobs(NULL)
-    {
-        _buffer = new char[buffer_size];
-        set_timeout(timeout);
-        set_delimiter(output_delimiter);
-        debug_on(debug);
-    }
-
-    /**
-     * Destructor
-     */
-    ~ATCmdParser()
-    {
-        while (_oobs) {
-            struct oob *oob = _oobs;
-            _oobs = oob->next;
-            delete oob;
-        }
-        delete[] _buffer;
-    }
-
-    /**
-     * Allows timeout to be changed between commands
-     *
-     * @param timeout ATCmdParser APIs (read/write/send/recv ..etc) throw an
-     *                error if no response is received in `timeout` duration
-     */
-    void set_timeout(int timeout)
-    {
-        _timeout = timeout;
-    }
-
-    /**
-     * For backward compatibility.
-     * @deprecated Do not use this function. This function has been replaced with set_timeout for consistency.
-     *
-     * Please use set_timeout(int) API only from now on.
-     * Allows timeout to be changed between commands
-     *
-     * @param timeout ATCmdParser APIs (read/write/send/recv ..etc) throw an
-     *                error if no response is received in `timeout` duration
-     *
-     */
-    MBED_DEPRECATED_SINCE("mbed-os-5.5.0", "Replaced with set_timeout for consistency")
-    void setTimeout(int timeout)
-    {
-        set_timeout(timeout);
-    }
-
-    /**
-     * Sets string of characters to use as line delimiters
-     *
-     * @param output_delimiter String of characters to use as line delimiters
-     */
-    void set_delimiter(const char *output_delimiter)
-    {
-        _output_delimiter = output_delimiter;
-        _output_delim_size = strlen(output_delimiter);
-    }
-
-    /**
-     * For backwards compatibility.
-     * @deprecated Do not use this function. This function has been replaced with set_delimiter for consistency.
-     *
-     * Please use set_delimiter(const char *) API only from now on.
-     * Sets string of characters to use as line delimiters
-     *
-     * @param output_delimiter string of characters to use as line delimiters
-     */
-    MBED_DEPRECATED_SINCE("mbed-os-5.5.0", "Replaced with set_delimiter for consistency")
-    void setDelimiter(const char *output_delimiter)
-    {
-        set_delimiter(output_delimiter);
-    }
-
-    /**
-     * Allows traces from modem to be turned on or off
-     *
-     * @param on Set as 1 to turn on traces and 0 to disable traces.
-     */
-    void debug_on(uint8_t on)
-    {
-        _dbg_on = (on) ? 1 : 0;
-    }
-
-    /**
-     * For backward compatibility.
-     * @deprecated Do not use this function. This function has been replaced with debug_on for consistency.
-     *
-     * Allows traces from modem to be turned on or off
-     *
-     * @param on Set as 1 to turn on traces and 0 to disable traces.
-     */
-    MBED_DEPRECATED_SINCE("mbed-os-5.5.0", "Replaced with debug_on for consistency")
-    void debugOn(uint8_t on)
-    {
-        debug_on(on);
-    }
-
-    /**
-     * 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, ...) MBED_PRINTF_METHOD(1, 2);
-
-    bool vsend(const char *command, std::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, ...) MBED_SCANF_METHOD(1, 2);
-
-    bool vrecv(const char *response, std::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 or -1 on failure
-     */
-    int write(const char *data, int size);
-
-    /**
-     * Read an array of bytes from the underlying stream
-     *
-     * @param data The buffer for filling the read bytes
-     * @param size Number of bytes to read
-     * @return number of bytes read or -1 on failure
-     */
-    int read(char *data, int size);
-
-    /**
-     * Direct printf to underlying stream
-     * @see printf
-     *
-     * @param format Format string to pass to printf
-     * @param ... Variable arguments to printf
-     * @return number of bytes written or -1 on failure
-     */
-    int printf(const char *format, ...) MBED_PRINTF_METHOD(1, 2);
-
-    int vprintf(const char *format, std::va_list args);
-
-    /**
-     * Direct scanf on underlying stream
-     * @see scanf
-     *
-     * @param format Format string to pass to scanf
-     * @param ... Variable arguments to scanf
-     * @return number of bytes read or -1 on failure
-     */
-    int scanf(const char *format, ...) MBED_SCANF_METHOD(1, 2);
-
-    int vscanf(const char *format, std::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 out-of-band 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 out-of-band data processed, false otherwise
-    */
-    bool process_oob(void);
-};
-
-/**@}*/
-
-/**@}*/
-
-} //namespace mbed
-
-#endif //MBED_ATCMDPARSER_H