ExpressLink.h

Go to the documentation of this file.

#pragma once
 
#include "Arduino.h"
#include "Stream.h"
 
class ExpressLink;
 
class ExpressLinkConfig
{
public:
    ExpressLinkConfig(ExpressLink &el);
 
    bool get(String key);
    bool set(String key, String value);
 
    String getAbout();
    String getVersion();
    String getTechSpec();
    String getThingName();
    String getCertificate();
 
    String getCustomName();
    bool setCustomName(const String &value);
 
    String getEndpoint();
    bool setEndpoint(const String &value);
 
    String getRootCA();
    bool setRootCA(const String &value);
 
    String getShadowToken();
    bool setShadowToken(const String &value);
 
    uint32_t getDefenderPeriod();
    bool setDefenderPeriod(const uint32_t value);
 
    String getHOTAcertificate();
    bool setHOTAcertificate(const String &value);
 
    String getOTAcertificate();
    bool setOTAcertificate(const String &value);
 
    String getSSID();
    bool setSSID(const String &value);
 
    bool setPassphrase(const String &value);
 
    String getAPN();
    bool setAPN(const String &value);
 
    String getTopic(uint8_t index);
    bool setTopic(uint8_t index, String topic);
 
    String getShadow(uint8_t index);
    bool setShadow(uint8_t index, String topic);
 
private:
    ExpressLink &expresslink;
};
 
class ExpressLink
{
    friend class ExpressLinkConfig;
 
public:
    enum EventCode : int16_t
    {
        UNKNOWN = -2, 
        NONE = -1,    
        FIRST_EVENT_CODE = 1,
        MSG = 1,      
        STARTUP = 2,  
        CONLOST = 3,  
        OVERRUN = 4,  
        OTA = 5,      
        CONNECT = 6,  
        CONFMODE = 7, 
        SUBACK = 8,   
        SUBNACK = 9,  
        // 10..19 RESERVED
        SHADOW_INIT = 20,        
        SHADOW_INIT_FAILED = 21, 
        SHADOW_DOC = 22,         
        SHADOW_UPDATE = 23,      
        SHADOW_DELTA = 24,       
        SHADOW_DELETE = 25,      
        SHADOW_SUBACK = 26,      
        SHADOW_SUBNACK = 27,     
        LAST_EVENT_CODE,
        // <= 999 reserved
        // >= 1000 available for custom implementation
    };
 
    enum OTACode : int16_t
    {
        NoOTAInProgress = 0,          
        UpdateProposed = 1,           
        HostUpdateProposed = 2,       
        OTAInProgress = 3,            
        NewExpressLinkImageReady = 4, 
        NewHostImageReady = 5,        
    };
 
    struct Event
    {
        EventCode code;
        int parameter;
    };
 
    struct OTAState
    {
        OTACode code;
        String detail;
    };
 
    ExpressLink(void);
    bool begin(Stream &s, int event = -1, int wake = -1, int reset = -1, bool debug = false);
 
    bool cmd(String command);
 
    bool selfTest();
 
    bool connect(bool async = false);
    bool isConnected();
    bool isOnboarded();
    bool disconnect();
 
    bool reset();
    bool factoryReset();
    bool sleep(uint32_t duration, uint8_t sleep_mode = 0);
 
    Event getEvent(bool checkPin = true);
 
    bool subscribe(uint8_t topic_index, String topic_name);
    bool unsubscribe(uint8_t topic_index);
    bool get(uint8_t topic_index = -1); // -1 = GET, 0...X = GETX
    bool send(uint8_t topic_index, String message);
    bool publish(uint8_t topic_index, String message);
 
    OTAState otaGetState();
    bool otaAccept();
    bool otaRead(uint32_t count);
    bool otaSeek(uint32_t address = -1);
    bool otaApply();
    bool otaClose();
    bool otaFlush();
 
    bool shadowInit(uint8_t index = -1);
    bool shadowDoc(uint8_t index = -1);
    bool shadowGetDoc(uint8_t index = -1);
    bool shadowUpdate(String new_state, uint8_t index = -1);
    bool shadowGetUpdate(uint8_t index = -1);
    bool shadowSubscribe(uint8_t index = -1);
    bool shadowUnsubscribe(uint8_t index = -1);
    bool shadowGetDelta(uint8_t index = -1);
    bool shadowDelete(uint8_t index = -1);
    bool shadowGetDelete(uint8_t index = -1);
 
    void passthrough(Stream* destination);
 
    ExpressLinkConfig config;
 
    String readLine(uint32_t count = 1);
    String response;
    String error;
    uint32_t additionalLines;
 
    static const uint32_t BAUDRATE = 115200;
 
    static const uint32_t TIMEOUT = 120000; // milliseconds
 
protected:
    void escape(String &value);
    void unescape(String &value);
 
private:
    bool debug;
    Stream *uart;
    int resetPin = -1;
    int eventPin = -1;
    int wakePin = -1;
};