jbwoprmqtt.h

Go to the documentation of this file.

 
#ifndef ARDUINO_WOPR_JBWOPRMQTT_H
#define ARDUINO_WOPR_JBWOPRMQTT_H
 
#include "jbwoprwifi.h"
#include <PubSubClient.h>                   // https://github.com/knolleary/pubsubclient
#include <WiFiManager.h>
#include <JBLogger.h>
#include "effects/jbwopreffects.h"
 
#define DEFAULT_MQTT_PREFIX "wopr"          
#define DEFAULT_MQTT_PORT 1883              
 
// ====================================================================
//
// W.O.P.R. device with WiFiManager and MQTT support
//
// ====================================================================
struct JBWoprMqttConfig {
    bool useMqtt;                           
    std::string mqttServerName;             
    uint16_t mqttServerPort;                
    std::string mqttUserName;               
    std::string mqttPassword;               
    std::string mqttPrefix;                 
};
 
class JBWoprMqttDevice: public JBWoprWiFiDevice {
public:
    // ====================================================================
    // General
    //
    JBWoprMqttDevice();
 
    bool begin(JBWoprBoardVariant variant) override;
 
    bool begin(JBWoprBoardVariant variant, JBWoprBoardPins pins) override;
 
    void loop() override;
 
    // ====================================================================
    // Logger
    //
    void setLogLevel(LogLevel level) override;
 
    LogLevel getLogLevel() override;
 
    // ====================================================================
    // MQTT
    //
    bool mqttPublishMessage(const std::string& topic, JsonDocument &jsonDoc, bool retain = false);
 
    bool mqttPublishMessage(const std::string& topic, const std::string& value, bool retain = false);
 
    bool mqttPublishMessage(const char* topic, const char* value, bool retain = false);
 
    // ====================================================================
    // Effects
    //
    void effectsStartCurrentEffect() override;
 
    virtual void effectsStopCurrentEffect();
 
    void effectsStartEffect(JBWoprEffectBase* effect) override;
 
    void effectsStartEffect(const std::string& effect) override;
 
    void effectsStartEffect(const char* effect) override;
 
    // ====================================================================
    // Display
    //
    void displaySetState(bool state) override;
 
    void displayClear() override;
 
    void displaySetBrightness(uint8_t val) override;
 
    void displayShowText(const char* text, JBTextAlignment alignment) override;
 
    void displayShowText(const std::string& text, JBTextAlignment alignment) override;
 
    void displayShowText(const String& text, JBTextAlignment alignment) override;
 
    void displayShowText(const char* text) override;
 
    void displayShowText(const std::string& text) override;
 
    void displayShowText(const String& text) override;
 
    void displayScrollText(const char* text, uint16_t delay_ms) override;
 
    void displayScrollText(const std::string& text, uint16_t delay_ms) override;
 
    void displayScrollText(const String& text, uint16_t delay_ms) override;
 
    virtual void displayScrollText(const char* text);
 
    virtual void displayScrollText(const std::string& text);
 
    virtual void displayScrollText(const String& text);
 
    // ====================================================================
    // Defcon
    //
    void defconLedsSetState(bool state) override;
 
    void defconLedsSetDefconLevel(JBDefconLevel level) override;
 
    void defconLedsSetColor(uint32_t color) override;
 
    void defconLedsSetBrightness(uint8_t brightness) override;
 
    void defconLedSetColor(JBDefconLevel level, uint32_t color);
 
protected:
    // ====================================================================
    // Configuration
    //
    JBWoprMqttConfig _mqttConfig;                                       
 
    const char* JSON_KEY_MQTT_USE_MQTT = "useMqtt";                     
    const char* JSON_KEY_MQTT_SERVER_NAME = "mqttServerName";           
    const char* JSON_KEY_MQTT_SERVER_PORT = "mqttServerPort";           
    const char* JSON_KEY_MQTT_USER_NAME = "mqttUserName";               
    const char* JSON_KEY_MQTT_PASSWORD = "mqttPassword";                
    const char* JSON_KEY_CONF_MQTT_PREFIX = "mqttPrefix";               
 
    void _setConfigFromJsonDocument(const JsonDocument &jsonDoc);
 
    void _setJsonDocumentFromConfig(JsonDocument &jsonDoc);
 
    void _dumpConfig() override;
 
    // ====================================================================
    // WiFi
    //
    WiFiClient _wifiClient;                                         
 
    const char* HTML_MQTT_TITLE = "<h2>MQTT settings</h2>";         
    char _mqttServerPortValue[6];                                   
 
    // WifiManager parameters
    WiFiManagerParameter* _mqttTitleParam;                          
    WiFiManagerParameter* _useMqttParam;                            
    WiFiManagerParameter* _mqttServerNameParam;                     
    WiFiManagerParameter* _mqttServerPortParam;                     
    WiFiManagerParameter* _mqttUserNameParam;                       
    WiFiManagerParameter* _mqttPasswordParam;                       
    WiFiManagerParameter* _mqttPrefixParam;                         
    WiFiManagerParameter* _break2Param;                             
 
    void _setupWiFiManager() override;
 
    void _saveParamsCallback() override;
 
    // ====================================================================
    // MQTT
    //
    PubSubClient* _mqttClient;                                          
    bool _mqttActive = false;                                           
 
    const char* ENTITY_NAME_DEVICE = "device";                          
    const char* ENTITY_NAME_CONFIG = "config";                          
    const char* ENTITY_NAME_EFFECT = "effect";                          
    const char* ENTITY_NAME_DISPLAY = "display";                        
    const char* ENTITY_NAME_DEFCON = "defcon";                          
    const char* ENTITY_NAME_BUTTON_FRONT_LEFT = "button_front_left";    
    const char* ENTITY_NAME_BUTTON_FRONT_RIGHT = "button_front_right";  
    const char* ENTITY_NAME_BUTTON_BACK_TOP = "button_back_top";        
    const char* ENTITY_NAME_BUTTON_BACK_BOTTOM = "button_back_bottom";  
 
    const char* SUBENTITY_NAME_STATE = "state";                         
    const char* SUBENTITY_NAME_BRIGHTNESS = "brightness";               
    const char* SUBENTITY_NAME_COLOR = "color";                         
    const char* SUBENTITY_NAME_TEXT = "text";                           
    const char* SUBENTITY_NAME_SCROLLTEXT = "scrolltext";               
    const char* SUBENTITY_NAME_EVENT = "event";                         
    const char* SUBENTITY_NAME_LEVEL = "level";                         
    const char* SUBENTITY_NAME_NAME = "name";                           
    const char* SUBENTITY_NAME_EFFECTS_TIMEOUT = "effects_timeout";     
    const char* SUBENTITY_NAME_TIME_FORMAT = "time_format";             
    const char* SUBENTITY_NAME_DATE_FORMAT = "date_format";             
    const char* SUBENTITY_NAME_DEFCON_BRIGHTNESS = "defcon_brightness"; 
    const char* SUBENTITY_NAME_DISPLAY_BRIGHTNESS = "display_brightness";   
    const char* SUBENTITY_NAME_WIFI_HOST_NAME = "host_name";            
    const char* SUBENTITY_NAME_WIFI_USE_WEB_PORTAL = "use_web_portal";  
 
    const char* STATE_ON = "ON";                                        
    const char* STATE_OFF = "OFF";                                      
 
    const char* EVENT_CLICK = "click";                                  
    const char* EVENT_DOUBLE_CLICK = "double_click";                    
 
    const char* COMMAND_SET = "set";                                    
 
    bool _mqttStart();
 
    void _mqttStop();
 
    bool _mqttReconnect();
 
    virtual bool _onMqttConnect();
 
    void _mqttCallback(const char* topic, const byte* payload, unsigned int length);
 
    virtual void _handleCommand(const std::string& entity, const std::string& subEntity, const std::string& command, const std::string& payload);
 
    virtual void _handleDeviceCommand(const std::string& subEntity, const std::string& command, const std::string& payload);
 
    virtual void _handleConfigCommand(const std::string& subEntity, const std::string& command, const std::string& payload);
 
    virtual void _handleEffectCommand(const std::string& subEntity, const std::string& command, const std::string& payload);
 
    virtual void _handleDisplayCommand(const std::string& subEntity, const std::string& command, const std::string& payload);
 
    virtual void _handleDefconCommand(const std::string& subEntity, const std::string& command, const std::string& payload);
 
    virtual std::string _getTopic(const char * entityId, const char* subEntityId);
 
    virtual std::string _getTopic(const std::string& entityId, const std::string& subEntityId);
 
    virtual std::string _getSubscriptionTopic();
 
    virtual std::string _getAvailabilityTopic();
 
    // ====================================================================
    // Buttons
    //
    void _buttonFrontLeftClick() override;
 
    void _buttonFrontLeftDoubleClick() override;
 
    void _buttonFrontRightClick() override;
 
    void _buttonFrontRightDoubleClick() override;
 
    void _buttonBackTopClick() override;
 
    void _buttonBackTopDoubleClick() override;
 
    void _buttonBackBottomClick() override;
 
    void _buttonBackBottomDoubleClick() override;
 
private:
    // ====================================================================
    // Logger
    //
    JBLogger* _log;                                 
 
};
 
#endif //ARDUINO_WOPR_JBWOPRMQTT_H