jbwoprha.h

Go to the documentation of this file.

 
#ifndef ARDUINO_WOPR_JBWOPRHA_H
#define ARDUINO_WOPR_JBWOPRHA_H
 
#include "jbwoprmqtt.h"
#include "WiFiManager.h"
#include <jblogger.h>
 
// ====================================================================
//
// W.O.P.R. with WiFiManager, MQTT and Home Assistant support
//
// ====================================================================
struct JBWoprHAConfig {
    bool useHomeAssistant;
    std::string homeAssistantDiscoveryPrefix;
};
 
class JBWoprHADevice: public JBWoprMqttDevice {
public:
    // ====================================================================
    // General
    //
    JBWoprHADevice();
 
    bool begin(JBWoprBoardVariant variant) override;
 
    bool begin(JBWoprBoardVariant variant, JBWoprBoardPins pins) override;
 
    void loop() override;
 
    // ====================================================================
    // Logger
    //
    void setLogLevel(LogLevel level) override;
 
    LogLevel getLogLevel() override;
 
protected:
    // ====================================================================
    // Configuration
    //
    JBWoprHAConfig _haConfig;                   
 
    const char* JSON_KEY_HA_USE_HOME_ASSISTANT = "useHomeAssistant";    
    const char* JSON_KEY_HA_DISCOVERY_PREFIX = "discoveryPrefix";       
 
    void _setConfigFromJsonDocument(const JsonDocument &jsonDoc) override;
 
    void _setJsonDocumentFromConfig(JsonDocument &jsonDoc) override;
 
    void _dumpConfig() override;
 
    // ====================================================================
    // Wifi
    //
    const char* HTML_HOME_ASSISTANT_TITLE = "<h2>Home Assistant settings</h2>"; 
    const char* HTML_CHECKBOX_TRUE = "type=\"checkbox\" checked";           
    const char* HTML_CHECKBOX_FALSE = "type=\"checkbox\"";                  
 
    WiFiManagerParameter* _homeAssistantTitleParam;                         
    WiFiManagerParameter* _useHomeAssistantParam;                           
    WiFiManagerParameter* _homeAssistantDiscoveryPrefixParam;               
    WiFiManagerParameter* _break3Param;                                     
 
    void _setupWiFiManager() override;
    void _saveParamsCallback() override;
 
    // ====================================================================
    // MQTT
    //
    const char* ENTITY_NAME_DIAGNOSTIC = "diagnostic";                      
    const char* ENTITY_NAME_CONFIG = "config";                              
 
    bool _onMqttConnect() override;
 
    // ====================================================================
    // Home Assistant
    //
    const char* HA_DIAG_PREFIX = "diagnostic";                                  
    const char* HA_CONFIG_PREFIX = "config";                                    
 
    const char* HA_COMPONENT_LIGHT = "light";                                   
    const char* HA_COMPONENT_NUMBER = "number";                                 
    const char* HA_COMPONENT_SELECT = "select";                                 
    const char* HA_COMPONENT_SENSOR = "sensor";                                 
    const char* HA_COMPONENT_SWITCH = "switch";                                 
    const char* HA_COMPONENT_BUTTON = "button";                                 
 
    const char* HA_DIAG_ENTITY_IP = "ip";                                       
    const char* HA_DIAG_ENTITY_RSSI = "rssi";                                   
    const char* HA_DIAG_ENTITY_RAM = "ram";                                     
    const char* HA_CONF_ENTITY_DATE_FORMAT = "date_format";                     
    const char* HA_CONF_ENTITY_TIME_FORMAT = "time_format";                     
    const char* HA_CONF_ENTITY_DISPLAY_BRIGHTNESS = "display_brightness";       
    const char* HA_CONF_ENTITY_DEFCON_BRIGHTNESS = "defcon_brightness";         
    const char* HA_CONF_ENTITY_EFFECTS_TIMEOUT = "effects_timeout";             
    const char* HA_CONF_ENTITY_WIFI_USE_WEB_PORTAL = "use_web_portal";          
    const char* HA_CONF_ENTITY_RESTART = "restart";                             
 
    const char* JSON_KEY_HA_DIAG_ENTITY_IP = "ipAddress";                       
    const char* JSON_KEY_HA_DIAG_ENTITY_RSSI = "rssi";                          
    const char* JSON_KEY_HA_DIAG_ENTITY_RAM = "ram";                            
    const char* JSON_KEY_HA_DIAG_ENTITY_VERSION = "version";                    
 
    const std::vector<std::string> _defconNames { "None", "DEFCON 5", "DEFCON 4", "DEFCON 3", "DEFCON 2", "DEFCON 1" }; 
 
    bool _homeAssistantSendDiscovery();
 
    bool _homeAssistantPublishDiagnostics();
 
    bool _homeAssistantPublishConfig();
 
    bool _homeAssistantPublishState();
 
    std::string _getDiscoveryTopic(const std::string& component,
                                   const std::string& prefix,
                                   const std::string& entity);
 
    void _addDiscoveryPayload(JsonDocument &jsonDoc,
                              const std::string& name,
                              const std::string& prefix,
                              const std::string& entity,
                              const std::string& templateValue,
                              const std::string& icon,
                              const std::string& unitOfMeasurement = "");
 
    void _addDeviceData(JsonDocument &jsonDoc);
 
    void _addAvailabilityData(JsonDocument &jsonDoc);
 
private:
    // ====================================================================
    // Logger
    //
    JBLogger* _log;                                 
};
 
 
#endif //ARDUINO_WOPR_JBWOPRHA_H