AtClient.h

Go to the documentation of this file.

/****
 * Sming Framework Project - Open Source framework for high efficiency native ESP8266 development.
 * Created 2017 by Slavey Karadzhov
 * http://github.com/SmingHub/Sming
 * All files of the Sming Core are provided under the LGPL v3 license.
 *
 * AtClient.h
 *
 ****/

#pragma once

#include "HardwareSerial.h"
#include "FIFO.h"
#include "Timer.h"

#define AT_REPLY_OK "OK"
#ifndef AT_TIMEOUT
#define AT_TIMEOUT 2000
#endif

class AtClient;

typedef Delegate<bool(AtClient& atClient, Stream& source)> AtReceiveCallback;
// ^ If the callback returns true then this means that we have
//     finished successfully processing the command
typedef Delegate<bool(AtClient& atClient, String& reply)> AtCompleteCallback;
// ^ If the callback returns true then this means that we have
//     finished successfully processing the command

typedef struct {
    String text;                   
    String response2;              
    unsigned timeout;              
    unsigned retries;              
    bool breakOnError = true;     
    AtReceiveCallback onReceive;   
    AtCompleteCallback onComplete; 
} AtCommand;

typedef enum { eAtOK = 0, eAtRunning, eAtError } AtState;

class AtClient
{
public:
    AtClient(HardwareSerial* stream);

    virtual ~AtClient()
    {
    }

    void send(const String& text, const String& altResponse = nullptr, uint32_t timeoutMs = AT_TIMEOUT,
              unsigned retries = 0);

    void send(const String& text, AtReceiveCallback onReceive, uint32_t timeoutMs = AT_TIMEOUT, unsigned retries = 0);

    void send(const String& text, AtCompleteCallback onComplete, uint32_t timeoutMs = AT_TIMEOUT, unsigned retries = 0);

    // Low Level Functions

    void send(AtCommand command);

    void sendDirect(AtCommand command);

    AtState getState()
    {
        return state;
    }

    /*
     * @brief Repeats the execution of the current command
     *        Useful if the current State is not eAtOK
     */
    void resend();

    /*
     * @brief Replaces the current command with the next on in the queue
     */
    void next();

    AtCommand currentCommand; 

protected:
    virtual void processor(Stream& source, char arrivedChar, uint16_t availableCharsCount);

private:
    FIFO<AtCommand, 10> queue;        
    HardwareSerial* stream = nullptr; 
    Timer commandTimer;               
    AtState state = eAtOK;

    void ticker();
};