mqtt_telemetry.h

Go to the documentation of this file.

#pragma once
 
#include <Arduino.h>
#include <PubSubClient.h>
#include <WiFi.h>
 
#include "control_engine.h"
#include "fault_monitor.h"
#include "fault_policy.h"
 
struct OtaTelemetrySnapshot {
  bool active;              
  const char* stateLabel;   
  const char* lastMessage;  
  const char* firmwareVersion;  
  const char* networkIp;    
  const char* uploadUrl;    
};
 
struct RemoteConfigStatus {
  bool lastCommandSeen;         
  bool lastCommandAccepted;     
  uint32_t acceptedCount;       
  uint32_t rejectedCount;       
  char lastKey[32];             
  char lastDetail[96];          
};
 
class MqttTelemetry {
  public:
  using RemoteConfigCallback = void (*)(const char* suffix,
                                        const uint8_t* payload,
                                        size_t length,
                                        void* context);
 
  MqttTelemetry();
 
  void begin(uint32_t nowMs);
 
  void update(uint32_t nowMs);
 
  bool publishTelemetry(uint32_t nowMs,
                        const ControlSnapshot& controlSnapshot,
                        const ControlConfig& controlConfig,
                        const OtaTelemetrySnapshot& otaSnapshot,
                        const FaultMonitorSnapshot& faultSnapshot,
                        const FaultPolicySnapshot& policySnapshot,
                        const RemoteConfigStatus& remoteConfigStatus,
                        bool force);
 
  void setRemoteConfigCallback(RemoteConfigCallback callback, void* context);
 
  void printStatus(Stream& out);
 
  bool enabled() const;
 
  bool wifiConnected() const;
 
  bool mqttConnected();
 
 private:
  bool configComplete() const;
  void maintainWifi(uint32_t nowMs);
  void maintainMqtt(uint32_t nowMs);
  bool connectMqtt();
  bool subscribeRemoteConfigTopics();
  bool publishText(const char* suffix, const char* payload, bool retained);
  bool publishBool(const char* suffix, bool value, bool retained = false);
  bool publishUInt(const char* suffix, uint32_t value, bool retained = false);
  bool publishInt(const char* suffix, int32_t value, bool retained = false);
  bool publishFloatOrUnavailable(const char* suffix,
                                 bool valid,
                                 float value,
                                 bool retained = false);
  bool buildTopic(const char* suffix, char* topic, size_t topicSize) const;
  void handleMqttMessage(char* topic, const uint8_t* payload, unsigned int length);
  static void mqttMessageThunk(char* topic, uint8_t* payload, unsigned int length);
 
  WiFiClient wifiClient_;
  PubSubClient mqttClient_;
  RemoteConfigCallback remoteConfigCallback_;
  void* remoteConfigContext_;
  bool initialized_;
  bool wifiBeginIssued_;
  uint32_t lastWifiAttemptMs_;
  uint32_t lastMqttAttemptMs_;
  uint32_t lastPublishMs_;
};