WiFiConnect.h

Go to the documentation of this file.

#ifndef WiFiConnect_h
#define WiFiConnect_h
#include <Arduino.h>
#if defined(ESP8266)
#include <ESP8266WiFi.h>
#include <ESP8266WebServer.h>
#else
#include <WiFi.h>
#include <WebServer.h>
#endif
#include <DNSServer.h>
#include <memory>

#if defined(ESP8266)
extern "C" {
#include "user_interface.h"
}
#define ESP_getChipId()   (ESP.getChipId()) 
#else
#include <esp_wifi.h>
#define ESP_getChipId()   ((uint32_t)ESP.getEfuseMac())
#endif

#include "WC_AP_HTML.h"
#include "WiFiConnectParam.h"
enum AP_Continue {
  AP_NONE, 
  AP_LOOP, 
  AP_RESTART, 
  AP_RESET 
};
/**************************************************************************/
/**************************************************************************/
class WiFiConnect {
  public:
    WiFiConnect();

    boolean startConfigurationPortal();
    boolean startConfigurationPortal(AP_Continue apcontinue);
    boolean startConfigurationPortal(AP_Continue apcontinue, const char*  apName, const char*  apPassword = NULL);

    boolean startParamsPortal();
    boolean startParamsPortal(AP_Continue apcontinue);
    boolean startParamsPortal(AP_Continue apcontinue, const char*  apName, const char*  apPassword = NULL);

    void addParameter(WiFiConnectParam *p);

    void setAPName(const char*  apName);
    const char* getAPName();

    void resetSettings();

    boolean autoConnect();
    boolean autoConnect(const char*  ssidName, const char*  ssidPassword = NULL, WiFiMode_t acWiFiMode = WIFI_STA);


    //sets a custom ip /gateway /subnet configuration
    void          setAPStaticIPConfig(IPAddress ip, IPAddress gw, IPAddress sn);
    //sets config for a static IP
    void          setSTAStaticIPConfig(IPAddress ip, IPAddress gw, IPAddress sn);

    //called when AP mode and config portal is started
    void          setAPCallback( void (*func)(WiFiConnect*) );
    //called when settings have been changed and connection was successful
    void          setSaveConfigCallback( void (*func)(void) );

    void setDebug(boolean isDebug);

    void setRetryAttempts(int attempts);
    void setConnectionTimeoutSecs(int timeout);
    void setAPModeTimeoutMins(int mins);

    boolean       captivePortal();

    //helpers
    const char* statusToString(int state);
    int           getRSSIasQuality(int RSSI);
    boolean       isIp(String str);
    String        toStringIp(IPAddress ip);
    virtual  void displayTurnOFF(int ms = 5000); 
    virtual void displayLoop(); 
    virtual void displayON(); 
  protected:
    boolean _debug = false; 
    template <typename Generic>
    void    DEBUG_WC(Generic text);
    virtual   void displayConnecting(int attempt, int totalAttempts); 
    virtual void displayConnected(); 
    virtual void displayAP(); 
    virtual void displayParams(); 
    virtual void displayManualReset(); 

  private:


    int _retryAttempts = 3; 
    int _connectionTimeoutSecs = 10; 
    int _apTimeoutMins = 3; 
    // DNS server
    const byte    DNS_PORT = 53; 

    long _lastAPPage = 0; 
    boolean _removeDuplicateAPs = true; 
    int _minimumQuality = 8; 
    int _paramsCount = 0; 
    boolean _readyToConnect = false; 
    String _ssid = ""; 
    String _password = ""; 

    WiFiConnectParam* _params[WiFiConnect_MAX_PARAMS]; 

    std::unique_ptr<DNSServer>        dnsServer; 
#ifdef ESP8266
    std::unique_ptr<ESP8266WebServer> server; 
#else
    std::unique_ptr<WebServer>        server; 
#endif

     char _apName[32] ; 
     char _apPassword[64] ; 
    
    IPAddress     _ap_static_ip; 
    IPAddress     _ap_static_gw; 
    IPAddress     _ap_static_sn; 
    IPAddress     _sta_static_ip; 
    IPAddress     _sta_static_gw; 
    IPAddress     _sta_static_sn; 

    void (*_apcallback)(WiFiConnect*) = NULL;
    void (*_savecallback)(void) = NULL;



    void handleRoot();
    void handleParamRoot();
    void handleParams();
    void handleWifi(boolean scan);
    void handleWifiSave();
    void handleInfo();
    void handleReset();
    void handle204();
    void handleNotFound();

    template <class T>
    auto optionalIPFromString(T *obj, const char *s) -> decltype(  obj->fromString(s)  ) {
      return  obj->fromString(s);
    }
    auto optionalIPFromString(...) -> bool {
      DEBUG_WC("NO fromString METHOD ON IPAddress, you need ESP8266 core 2.1.0 or newer for Custom IP configuration to work.");
      return false;
    }

};

#endif