InputMQTT.h

Go to the documentation of this file.

#pragma once
/*
* InputMQTT.h
*
* Project: ESPixelStick - An ESP8266 / ESP32 and E1.31 based pixel driver
* Copyright (c) 2021, 2025 Shelby Merrick
* http://www.forkineye.com
*
*  This program is provided free for you to use in any way that you wish,
*  subject to the laws and regulations where you are using it.  Due diligence
*  is strongly suggested before using this code.  Please give credit where due.
*
*  The Author makes no warranty of any kind, express or implied, with regard
*  to this program or the documentation contained in this document.  The
*  Author shall not be liable in any event for incidental or consequential
*  damages in connection with, or arising out of, the furnishing, performance
*  or use of these programs.
*
*/
 
#include "InputCommon.hpp"
#include "InputEffectEngine.hpp"
#include "InputFPPRemotePlayItem.hpp"
#include <Arduino.h>
#include <AsyncMqttClient.hpp>
#include "input/InputFPPRemotePlayFile.hpp"
#include "input/InputFPPRemotePlayList.hpp"
 
class c_InputMQTT : public c_InputCommon
{
  public:
 
      c_InputMQTT (
          c_InputMgr::e_InputChannelIds NewInputChannelId,
          c_InputMgr::e_InputType       NewChannelType,
          uint32_t                      BufferSize);
 
      virtual ~c_InputMQTT ();
 
      // functions to be provided by the derived class
      void Begin ();                           
      bool SetConfig (JsonObject& jsonConfig); 
      void GetConfig (JsonObject& jsonConfig); 
      void GetStatus (JsonObject& jsonStatus);
      void ClearStatistics ();
      void Process   ();
      void GetDriverName (String& sDriverName) { sDriverName = "MQTT"; } 
      void SetBufferInfo (uint32_t BufferSize);
      void NetworkStateChanged (bool IsConnected); // used by poorly designed rx functions
 
private:
#define MQTT_PORT       1883    
 
    AsyncMqttClient            mqtt;           // MQTT object
    Ticker                     mqttTicker;     // Ticker to handle MQTT
    c_InputEffectEngine      * pEffectsEngine = nullptr;
    c_InputFPPRemotePlayItem * pPlayFileEngine = nullptr;
 
    // Keep track of last known effect configuration state
    c_InputEffectEngine::MQTTConfiguration_t effectConfig;
 
    // from original config struct
    String      ip;
    uint16_t    port = MQTT_PORT;
    String      user;
    String      password;
    String      topic;
#ifdef SUPPORT_SENSOR_DS18B20
    String      TemperatureSensorTopic;
#endif // def SUPPORT_SENSOR_DS18B20
    bool        CleanSessionRequired = false;
    String      haprefix = "homeassistant";
    bool        hadisco = true;
    String      lwtTopic;
 
    #define deletePlayFileEngine() \
    { \
        if (nullptr != pPlayFileEngine) \
        { \
            pPlayFileEngine->~c_InputFPPRemotePlayItem(); \
            memset(PlayFileEngine, 0x0, sizeof(PlayFileEngine)); \
            pPlayFileEngine = nullptr; \
        } \
    }
    // char PlayFileEngine[sizeof(c_InputFPPRemotePlayFile)];
    char PlayFileEngine[sizeof(c_InputFPPRemotePlayList)];
 
    #define deleteEffectsEngine() \
    { \
        if (nullptr != pEffectsEngine) \
        { \
            pEffectsEngine->~c_InputEffectEngine(); \
            memset(EffectsEngine, 0x0, sizeof(EffectsEngine)); \
            pEffectsEngine = nullptr; \
        } \
    }
    char EffectsEngine[sizeof(c_InputEffectEngine)];
 
    const char* ON = "ON";
    const char* OFF = "OFF";
    const char* LWT_ONLINE = "online";
    const char* LWT_OFFLINE = "offline";
 
    void validateConfiguration ();
 
    void setup ();         
    void onNetworkConnect ();     
    void onNetworkDisconnect ();  
    void validate ();      
    void NetworkStateChanged (bool IsConnected, bool RebootAllowed); // used by poorly designed rx functions
    void PlayFseq (JsonObject & JsonConfig);
    void PlayEffect (JsonObject & JsonConfig);
    void GetEngineConfig (JsonObject & JsonConfig);
    void GetEffectList (JsonObject & JsonConfig);
    void StopPlayFileEngine ();
    void UpdateEffectConfiguration (JsonObject & JsonConfig);
 
    void load ();          
    void save ();          
 
    bool stateOn = false;
 
    //
    //  MQTT Section
    //
 
    void disconnectFromMqtt ();
    void connectToMqtt (); // onMqttDisconnect, onWifiConnect
    void onMqttConnect (bool sessionPresent); // setup
    void onMqttDisconnect (AsyncMqttClientDisconnectReason reason); // setup
    void onMqttMessage (char* topic, char* payload, AsyncMqttClientMessageProperties properties, uint32_t len, uint32_t index, uint32_t total); // setup
    void publishHA (); // updateConfig
    void publishState (); // onMqttConnect, onMqttMessage, procT, updateConfig
};