ATSerial.h

/*

    Copyright (c) 2019 Seeed Technology Co., Ltd.
    Website    : www.seeed.cc
    Author     : downey
    Create Time: Jan 2019
    Change Log :

    The MIT License (MIT)

    Permission is hereby granted, free of charge, to any person obtaining a copy
    of this software and associated documentation files (the "Software"), to deal
    in the Software without restriction, including without limitation the rights
    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
    copies of the Software, and to permit persons to whom the Software is
    furnished to do so, subject to the following conditions:

    The above copyright notice and this permission notice shall be included in
    all copies or substantial portions of the Software.

    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
    THE SOFTWARE.
*/

#ifndef __AT_SERIAL_H__
#define __AT_SERIAL_H__

#include <Arduino.h>
#if defined(ARDUINO_ARCH_SAMD)
#elif defined(ARDUINO_ARCH_ESP32)
    #include <HardwareSerial.h>

#else
    #include "SoftwareSerial.h"
#endif


// Architecture specific include
#if defined(ARDUINO_ARCH_AVR)
    #define UART_MAX_LEN   512
    #define debug Serial
    #define DEBUG_EN 0
#elif defined(ARDUINO_ARCH_SAM)
    #define SAMD21
    #define UART_MAX_LEN   1024
    #define debug SerialUSB
    #define DEBUG_EN 1
#elif defined(ARDUINO_ARCH_SAMD)
    #define SAMD21
    #define UART_MAX_LEN   1024
    #define debug SerialUSB
    #define DEBUG_EN 1
#elif defined(ARDUINO_ARCH_STM32F4)
    #define UART_MAX_LEN   1024
    #define debug Serial
    #define DEBUG_EN 0
#elif defined(ARDUINO_ARCH_ESP32)
    #define UART_MAX_LEN   1024
    #define debug Serial
    #define DEBUG_EN 1
#else
    #define debug Serial
    #define DEBUG_EN 0
    #define UART_MAX_LEN   512
#endif



#ifndef UART_DELAY
    #define UART_DELAY 100
#endif

#ifndef UART_TIMEOUT
    #define UART_TIMEOUT 3000
#endif

#define DEFAULT_RX 0
#define DEFAULT_TX 1

#define DEFAULT_BAUD          57600
#define DEFAULT_DEBUG_BAUD    115200

#define DEFAULT_PORT 8468

#define MAX_RESEND_CNT  2
#define TIME_OUT_MS     2000




/** class ATSerial ,provide data transfer interface.
    Template T is transparent transport serial,T1 is debug Serial.

 * */
template <class T, class T1>
class ATSerial {
  protected:
    T* _uart;

    uint32_t baud_;
    T1* debug_uart_;
    uint32_t debug_baud_;
    bool debug_enable;

  public:


    ATSerial() {
        debug_enable = true;
    }

    /** If arduino board is AVR,using softwareSerial,else if samd board,using hardwareSerial.

     * */
    void begin(T& uart, T1& debug_uart, uint32_t baud = DEFAULT_BAUD, uint32_t debug_baud = DEFAULT_DEBUG_BAUD) {
        _uart = &uart;
        debug_uart_ = &debug_uart;
        _uart->begin(DEFAULT_BAUD);
        debug_uart_->begin(DEFAULT_DEBUG_BAUD);
        baud_ = baud;
        debug_baud_ = debug_baud;
        flush();
    }

    inline void debugControl(bool flag) {
        debug_enable = flag;
    }

    inline bool checkDebugFlag() {
        return debug_enable;
    }

    void flush(void);

    int available(void);

    bool checkResponse(String& s, uint16_t match_len, uint32_t time_out);

    bool checkResponseAndGetMessage(String& s, uint16_t match_len, uint32_t time_out, String& msg);

    char* readString(void);

    bool isOkay(void);

    bool restart(void);

    int read(void);

    int ATWrite(const char*);

    int ATWrite(const uint8_t uc);

    void binWrite(uint8_t* msg, uint32_t len);
    // bool readResp(uint8_t* msg);

    bool readResp(String& rsp, uint32_t time_out);

    // bool readMsg(uint8_t* msg);

    bool sendCmdAndCheckRsp(String& cmd, String& match, uint16_t match_len, uint32_t time_out = TIME_OUT_MS,
                            uint8_t max_resend_cnt = MAX_RESEND_CNT);

    bool sendCmdAndGetMsg(String& msg, String& cmd, String& match, uint16_t match_len, uint32_t time_out = TIME_OUT_MS,
                          uint8_t max_resend_cnt = MAX_RESEND_CNT);

    bool waitForData(uint8_t* recv_msg, uint32_t& recv_len, uint32_t time_out = TIME_OUT_MS,
                     uint8_t max_resend_cnt = MAX_RESEND_CNT);

    bool getMsg(String& msg, uint32_t time_out = TIME_OUT_MS);



    bool waitForDataTillRespon(uint8_t* recv_msg, uint32_t& recv_len, uint8_t max_resend_cnt = MAX_RESEND_CNT);



    inline T1* getDebugSerial() {
        return debug_uart_;
    }

    /*Debug interface.*/
    void printHexArray(uint8_t* data, uint32_t data_len);
};



#endif