ESP8266.h

Go to the documentation of this file.

#ifndef __ESP8266_H__
#define __ESP8266_H__

#include "Arduino.h"

#ifdef ESP8266_USE_SOFTWARE_SERIAL
#include "SoftwareSerial.h"
#endif

#define  VERSION_18   0X18
#define  VERSION_22   0X22

#define  USER_SEL_VERSION         VERSION_18

class ESP8266 {
 public:

#ifdef ESP8266_USE_SOFTWARE_SERIAL
    /*
     * Constuctor. 
     *
     * @param uart - an reference of SoftwareSerial object. 
     * @param baud - the buad rate to communicate with ESP8266(default:9600). 
     *
     * @warning parameter baud depends on the AT firmware. 9600 is an common value. 
     */
#if (USER_SEL_VERSION == VERSION_22)
    ESP8266(SoftwareSerial &uart, uint32_t baud = 115200);
#elif (USER_SEL_VERSION == VERSION_18)
    ESP8266(SoftwareSerial &uart, uint32_t baud = 9600);
#endif  /* #if(USER_SEL_VERSION==VERSION_22) */

#else /* HardwareSerial */
    /*
     * Constuctor. 
     *
     * @param uart - an reference of HardwareSerial object. 
     * @param baud - the buad rate to communicate with ESP8266(default:9600). 
     *
     * @warning parameter baud depends on the AT firmware. 9600 is an common value. 
     */
#if (USER_SEL_VERSION == VERSION_22)
    ESP8266(HardwareSerial &uart, uint32_t baud = 115200);
#elif (USER_SEL_VERSION == VERSION_18)
    ESP8266(HardwareSerial &uart, uint32_t baud = 9600);
#endif /* #if(USER_SEL_VERSION == VERSION_22) */


#endif /* #ifdef ESP8266_USE_SOFTWARE_SERIAL */
    
    
    bool kick(void);
    
    bool restart(void);
    
    String getVersion(void);
    
    bool deepSleep(uint32_t time);
    
    bool setEcho(uint8_t mode);
    
    bool restore(void);
    
    bool setUart(uint32_t baudrate,uint8_t pattern);
    
    bool setOprToStation(uint8_t pattern1=3,uint8_t pattern2=3);
    
    String getWifiModeList(void);
    
    bool setOprToSoftAP(uint8_t pattern1=3,uint8_t pattern2=3);
   
    bool setOprToStationSoftAP(uint8_t pattern1=3,uint8_t pattern2=3);
    
    String getAPList(void);
    
    String getNowConecAp(uint8_t pattern=3);
    
    bool joinAP(String ssid, String pwd,uint8_t pattern=3);
    
    bool leaveAP(void);
    
    bool setSoftAPParam(String ssid, String pwd, uint8_t chl = 7, uint8_t ecn = 4,uint8_t pattern=3);
    
    String getSoftAPParam(uint8_t pattern=3);
    
    String getJoinedDeviceIP(void);
    
    String getDHCP(uint8_t pattern=3);
    
     bool setDHCP(uint8_t mode, uint8_t en, uint8_t pattern=3);
     
     bool setAutoConnect(uint8_t en);
     
     String getStationMac(uint8_t pattern=3);
     
     bool setStationMac(String mac,uint8_t pattern=3);
     
     String getStationIp(uint8_t pattern=3);
     
     bool setStationIp(String ip,String gateway,String netmask,uint8_t pattern=3);
     
     String getAPIp(uint8_t pattern=3);
     
     bool setAPIp(String ip,uint8_t pattern=3);
     
     bool startSmartConfig(uint8_t type);
     
     bool stopSmartConfig(void); 
    
    String getIPStatus(void);
    
    String getLocalIP(void);
    
    bool enableMUX(void);
    
    bool disableMUX(void);
    
    bool createTCP(String addr, uint32_t port);
    
    bool releaseTCP(void);
    
    bool registerUDP(String addr, uint32_t port);
    
    bool unregisterUDP(void);
  
    bool createTCP(uint8_t mux_id, String addr, uint32_t port);
    
    bool releaseTCP(uint8_t mux_id);
    
    bool registerUDP(uint8_t mux_id, String addr, uint32_t port);
    
    bool unregisterUDP(uint8_t mux_id);

    bool setTCPServerTimeout(uint32_t timeout = 180);
    
    bool startTCPServer(uint32_t port = 333);

    bool stopTCPServer(void);
    
    bool setCIPMODE(uint8_t mode);
    
    bool startServer(uint32_t port = 333);

    bool stopServer(void);
    bool saveTransLink (uint8_t mode,String ip,uint32_t port);
    
    bool setPing(String ip);

    bool send(const uint8_t *buffer, uint32_t len);
            
    bool send(uint8_t mux_id, const uint8_t *buffer, uint32_t len);
    
    uint32_t recv(uint8_t *buffer, uint32_t buffer_size, uint32_t timeout = 1000);
    
    uint32_t recv(uint8_t mux_id, uint8_t *buffer, uint32_t buffer_size, uint32_t timeout = 1000);
    
    uint32_t recv(uint8_t *coming_mux_id, uint8_t *buffer, uint32_t buffer_size, uint32_t timeout = 1000);

 private:

    /* 
     * Empty the buffer or UART RX.
     */
    void rx_empty(void);
 
    /* 
     * Recvive data from uart. Return all received data if target found or timeout. 
     */
    String recvString(String target, uint32_t timeout = 1000);
    
    /* 
     * Recvive data from uart. Return all received data if one of target1 and target2 found or timeout. 
     */
    String recvString(String target1, String target2, uint32_t timeout = 1000);
    
    /* 
     * Recvive data from uart. Return all received data if one of target1, target2 and target3 found or timeout. 
     */
    String recvString(String target1, String target2, String target3, uint32_t timeout = 1000);
    
    /* 
     * Recvive data from uart and search first target. Return true if target found, false for timeout.
     */
    bool recvFind(String target, uint32_t timeout = 1000);
    
    /* 
     * Recvive data from uart and search first target and cut out the substring between begin and end(excluding begin and end self). 
     * Return true if target found, false for timeout.
     */
    bool recvFindAndFilter(String target, String begin, String end, String &data, uint32_t timeout = 1000);
    
    /*
     * Receive a package from uart. 
     *
     * @param buffer - the buffer storing data. 
     * @param buffer_size - guess what!
     * @param data_len - the length of data actually received(maybe more than buffer_size, the remained data will be abandoned).
     * @param timeout - the duration waitting data comming.
     * @param coming_mux_id - in single connection mode, should be NULL and not NULL in multiple. 
     */
    uint32_t recvPkg(uint8_t *buffer, uint32_t buffer_size, uint32_t *data_len, uint32_t timeout, uint8_t *coming_mux_id);
    
    
    bool eAT(void);
    bool eATRST(void);
    bool eATGMR(String &version);
    bool eATGSLP(uint32_t time); 
    bool eATE(uint8_t mode);
    bool eATRESTORE(void);
    bool eATSETUART(uint32_t baudrate,uint8_t pattern);
    
    bool qATCWMODE(uint8_t *mode,uint8_t pattern=3);
    bool eATCWMODE(String &list) ;
    bool sATCWMODE(uint8_t mode,uint8_t pattern=3);
    bool qATCWJAP(String &ssid,uint8_t pattern=3) ;
    bool sATCWJAP(String ssid, String pwd,uint8_t pattern=3);
    bool eATCWLAP(String &list);
    bool eATCWQAP(void);
    bool qATCWSAP(String &List,uint8_t pattern=3); 
    bool sATCWSAP(String ssid, String pwd, uint8_t chl, uint8_t ecn,uint8_t pattern=3);
    bool eATCWLIF(String &list);
    bool qATCWDHCP(String &List,uint8_t pattern=3); 
    bool sATCWDHCP(uint8_t mode, uint8_t en, uint8_t pattern=3);
    bool eATCWAUTOCONN(uint8_t en);
    bool qATCIPSTAMAC(String &mac,uint8_t pattern=3);
    bool eATCIPSTAMAC(String mac,uint8_t pattern=3);
    bool qATCIPSTAIP(String &ip,uint8_t pattern=3);
    bool eATCIPSTAIP(String ip,String gateway,String netmask,uint8_t pattern=3);
    bool qATCIPAP(String &ip,uint8_t pattern=3);
    bool eATCIPAP(String ip,uint8_t pattern=3);
    bool eCWSTARTSMART(uint8_t type);
    bool eCWSTOPSMART(void);

   
    bool eATCIPSTATUS(String &list);
    bool sATCIPSTARTSingle(String type, String addr, uint32_t port);
    bool sATCIPSTARTMultiple(uint8_t mux_id, String type, String addr, uint32_t port);
    bool sATCIPSENDSingle(const uint8_t *buffer, uint32_t len);
    bool sATCIPSENDMultiple(uint8_t mux_id, const uint8_t *buffer, uint32_t len);
    bool sATCIPCLOSEMulitple(uint8_t mux_id);
    bool eATCIPCLOSESingle(void);
    bool eATCIFSR(String &list);
    bool sATCIPMUX(uint8_t mode);
    bool sATCIPSERVER(uint8_t mode, uint32_t port = 333);
    bool sATCIPMODE(uint8_t mode);
    bool eATSAVETRANSLINK(uint8_t mode,String ip,uint32_t port);
    bool eATPING(String ip);
    bool sATCIPSTO(uint32_t timeout);
    
    /*
     * +IPD,len:data
     * +IPD,id,len:data
     */
    
#ifdef ESP8266_USE_SOFTWARE_SERIAL
    SoftwareSerial *m_puart; /* The UART to communicate with ESP8266 */
#else
    HardwareSerial *m_puart; /* The UART to communicate with ESP8266 */
#endif
};

#endif /* #ifndef __ESP8266_H__ */