MqttPublisher.h

/*
 * Copyright (c) 2021, 2022 G. R. McDorman
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
 
#pragma once
 
#include <memory>
#include <PubSubClient.h>
#include <Ticker.h>
 
#include "grmcdorman/device/Device.h"
#include "grmcdorman/Setting.h"
 
class Client;
 
namespace grmcdorman::device
{
    class MqttPublisher: public Device
    {
        public:
            static constexpr uint16_t CONNECTION_TRIES = 5;             
            static constexpr uint32_t CONNECTION_RETRY_INTERVAL = 5;    
            MqttPublisher(const __FlashStringHelper *manufacturer, const __FlashStringHelper *model, const __FlashStringHelper *software_version, Client *client = nullptr);
 
            void set_defaults() override;
 
            void setup() override;
            void loop() override;
 
            DynamicJsonDocument as_json() const override;
 
            virtual void set_devices(const std::vector<Device *> &list) override
            {
                devices = &list;
            }
 
            virtual String get_status() const;
 
        private:
            void reconnect();
            void publish_auto_config();
            void publish();
 
            String get_error_state_message(int state) const;
 
            void set_timer();
 
            const __FlashStringHelper *publish_manufacturer;    
            const __FlashStringHelper *publish_model;           
            const __FlashStringHelper *publish_software_version;
 
            const std::vector<Device *> *devices = nullptr; 
 
            std::unique_ptr<Client> default_client;         
            Client                 *client;                 
            std::unique_ptr<PubSubClient> mqttClient;       
            uint16_t retry_count = 0;                       
            uint32_t previous_connection_attempt_ms = 0;    
            uint32_t previous_publish_ms = 0;               
            bool tried_publish = false;                     
            bool last_publish_failed = false;               
            int last_state = -1;                            
            uint32_t current_publish_seconds = 0;           
 
            String topicAvailability;                       
            String topicState;                              
            String topicCommand;                            
 
            Ticker connect_ticker;                          
            Ticker publish_ticker;                          
            NoteSetting notes;                              
            StringSetting server_address;                   
            UnsignedIntegerSetting server_port;             
            UnsignedIntegerSetting update_interval;         
            UnsignedIntegerSetting reconnect_interval;      
            UnsignedIntegerSetting keepalive_interval;      
            UnsignedIntegerSetting buffer_size;             
            StringSetting username;                         
            PasswordSetting password;                       
            StringSetting prefix;                           
            StringSetting identifier;                       
            InfoSettingHtml device_status;                    
    };
}