jbwoprwifi.h

Go to the documentation of this file.

 
#ifndef ARDUINO_WOPR_JBWOPRWIFI_H
#define ARDUINO_WOPR_JBWOPRWIFI_H
 
#include "jbwopr.h"
#include <WiFiManager.h>                    // https://github.com/tzapu/WiFiManager
#include <JBLogger.h>
 
// ====================================================================
//
// W.O.P.R. with WiFiManager support
//
// ====================================================================
 
#define WIFI_NTP_SERVER "pool.ntp.org"
struct JBWoprWiFiConfiguration {
    std::string hostName;                       
    std::string ntpServer;                      
    std::string timeOffsetString;               
    bool useWebPortal;                          
};
 
class JBWoprWiFiDevice: public JBWoprDevice {
public:
    // ====================================================================
    // General
    //
    JBWoprWiFiDevice();
 
    // Overrides
    bool begin(JBWoprBoardVariant variant) override;
 
    bool begin(JBWoprBoardVariant variant, JBWoprBoardPins pins) override;
 
    void loop() override;
 
    // ====================================================================
    // Logger
    //
    void setLogLevel(LogLevel level) override;
 
    LogLevel getLogLevel() override;
 
    // ====================================================================
    // Wifi
    //
    bool startWiFi();
 
    // WiFiManager
    void webPortalStart();
 
    void webPortalStop();
 
protected:
    // ====================================================================
    // Configuration
    //
    JBWoprWiFiConfiguration _wifiConfig;                
    bool _shouldSaveConfig = false;                     
 
    const char* CONFIG_FILE_NAME = "/config.json";      
 
    void _loadConfiguration();
 
    void _saveConfiguration();
 
    virtual void _setConfigFromJsonDocument(const JsonDocument &jsonDoc);
 
    virtual void _setJsonDocumentFromConfig(JsonDocument &jsonDoc);
 
    virtual void _dumpConfig();
 
    // ====================================================================
    // WiFi
    //
    WiFiManager* _wifiManager;                                      
    std::string _apName = "";                                       
 
    const char* WEB_PORTAL_PASSWORD = "wopr1234";                   
    const char* JSON_KEY_EFFECTS_TIMEOUT = "effectsTimeout";        
    const char* JSON_KEY_TIME_FORMAT = "timeFormat";                
    const char* JSON_KEY_DATE_FORMAT = "dateFormat";                
    const char* JSON_KEY_DEFCON_BRIGHTNESS = "defconBrightness";    
    const char* JSON_KEY_DISPLAY_BRIGHTNESS = "displayBrightness";  
    const char* JSON_KEY_WIFI_HOST_NAME = "hostName";               
    const char* JSON_KEY_WIFI_NTP_SERVER = "ntpServer";             
    const char* JSON_KEY_WIFI_TIME_OFFSET = "timeOffsetString";         
    const char* JSON_KEY_WIFI_USE_WEB_PORTAL = "useWebPortal";      
 
    const char* HTML_WOPR_TITLE = "<h2>W.O.P.R. settings</h2>";     
    const char* HTML_NETWORK_TITLE = "<h2>Network settings</h2>";   
    const char* HTML_CHECKBOX_TRUE = "type=\"checkbox\" checked";   
    const char* HTML_CHECKBOX_FALSE = "type=\"checkbox\"";          
 
    WiFiManagerParameter* _woprTitleParam;                          
    WiFiManagerParameter* _networkTitleParam;                       
    WiFiManagerParameter* _breakParam;                              
    WiFiManagerParameter* _effectsTimeoutParam;                     
    WiFiManagerParameter* _timeFormatParam;                         
    WiFiManagerParameter* _dateFormatParam;                         
    WiFiManagerParameter* _displayBrightnessParam;                  
    WiFiManagerParameter* _defconLedsBrightnessParam;               
 
    WiFiManagerParameter* _hostNameParam;                           
    WiFiManagerParameter* _ntpServerNameParam;                      
    WiFiManagerParameter* _timeOffsetParam;                             
    WiFiManagerParameter* _useWebPortalParam;                       
 
    char _effectsTimeoutValue[3];                                   
    char _defconLedsBrightnessValue[3];                             
    char _displayBrightnessValue[3];                                
 
    std::string _getDeviceName();
 
    virtual WiFiManager* _getWiFiManager();
 
    virtual void _setupWiFiManager();
 
    virtual void _saveParamsCallback();
 
    void _apCallback(WiFiManager* wifiManager);
 
    void _webServerCallback();
 
private:
    // ====================================================================
    // Logger
    //
    JBLogger* _log;                                 
};
 
#endif //ARDUINO_WOPR_JBWOPRWIFI_H