[MQTT] (Auto)Discovery implementation

src/_P076_HLW8012.ino

@@ -19,6 +19,8 @@
 //
 
 /** Changelog:
+ * 2025-01-16 tonhuisman: Implement support for MQTT AutoDiscovery
+ *                        Add support for PLUGIN_GET_DEVICEVALUECOUNT that was missing.
  * 2025-01-16 tonhuisman: Fix merge conflict, (re-)apply Uncrustify formatting
  * 2025-01-12 tonhuisman: Add support for MQTT AutoDiscovery (not supported yet for HLW8012)
  * 2024-12-26 tonhuisman: Add preset for Shelly Plus PLUG-S (ESP32 device), only enabled for ESP32 builds
@@ -109,6 +111,9 @@ unsigned long p076_timer{};
 // Forward declaration helper function
 const __FlashStringHelper* p076_getQueryString(uint8_t value_nr,
                                                bool    displayString);
+# if FEATURE_MQTT_DISCOVER
+Sensor_VType               p076_getQueryVType(uint8_t value_nr);
+# endif // if FEATURE_MQTT_DISCOVER
 
 # if ESP_IDF_VERSION_MAJOR >= 5
 
@@ -242,7 +247,7 @@ boolean Plugin_076(uint8_t function, struct EventStruct *event, String& string)
       {
         if (i < P076_NR_OUTPUT_VALUES)
         {
-          uint8_t choice = PCONFIG(i + P076_QUERY1_CONFIG_POS);
+          const uint8_t choice = PCONFIG(i + P076_QUERY1_CONFIG_POS);
           ExtraTaskSettings.setTaskDeviceValueName(i, p076_getQueryString(choice, false));
         }
         else
@@ -253,11 +258,21 @@ boolean Plugin_076(uint8_t function, struct EventStruct *event, String& string)
       break;
     }
 
+    case PLUGIN_GET_DEVICEVALUECOUNT:
+    {
+      event->Par1 = P076_NR_OUTPUT_VALUES;
+      success     = true;
+      break;
+    }
+
     # if FEATURE_MQTT_DISCOVER
     case PLUGIN_GET_DISCOVERY_VTYPES:
     {
-      event->Par1 = static_cast<int>(Sensor_VType::SENSOR_TYPE_NONE); // Not yet supported
-      success     = true;
+      for (uint8_t i = 0; i < event->Par5; ++i) {
+        const uint8_t choice = PCONFIG(i + P076_QUERY1_CONFIG_POS);
+        event->ParN[i] = static_cast<int>(p076_getQueryVType(choice));
+      }
+      success = true;
       break;
     }
     # endif // if FEATURE_MQTT_DISCOVER
@@ -921,6 +936,30 @@ const __FlashStringHelper* p076_getQueryString(uint8_t value_nr, bool displayStr
   return F("");
 }
 
+# if FEATURE_MQTT_DISCOVER
+Sensor_VType p076_getQueryVType(uint8_t value_nr) {
+  switch (value_nr)
+  {
+    case P076_INDEX_VOLT:
+      return Sensor_VType::SENSOR_TYPE_VOLTAGE_ONLY;
+    case P076_INDEX_CURR:
+      return Sensor_VType::SENSOR_TYPE_CURRENT_ONLY;
+    case P076_INDEX_POWR:
+      return Sensor_VType::SENSOR_TYPE_POWER_USG_ONLY;
+    case P076_INDEX_VAR:
+      return Sensor_VType::SENSOR_TYPE_REACTIVE_POWER_ONLY;
+    case P076_INDEX_VA:
+      return Sensor_VType::SENSOR_TYPE_APPRNT_POWER_USG_ONLY;
+    case P076_INDEX_PF:
+      return Sensor_VType::SENSOR_TYPE_POWER_FACT_ONLY;
+    case P076_INDEX_ENER:
+      return Sensor_VType::SENSOR_TYPE_NONE; // FIXME Add support for Energy + Unit of Measure
+  }
+  return Sensor_VType::SENSOR_TYPE_NONE;
+}
+
+# endif // if FEATURE_MQTT_DISCOVER
+
 void p076_checkdefault_queries(struct EventStruct *event)
 {
   // Set default querys if not set

src/_P077_CSE7766.ino

@@ -8,6 +8,8 @@
 // #######################################################################################################
 
 /** Changelog:
+ * 2025-01-16 tonhuisman: Implement support for MQTT AutoDiscovery
+ *                        Add support for PLUGIN_GET_DEVICEVALUECOUNT that was missing.
  * 2025-01-12 tonhuisman: Add support for MQTT AutoDiscovery (not supported yet for CSE7766)
  * 2023-02-12 tonhuisman: Separate PLUGIN_SERIAL_IN and PLUGIN_TEN_PER_SECOND (changed from PLUGIN_FIFTY_PER_SECOND) handling
  *                        Fixed some minor code-issues
@@ -84,11 +86,21 @@ boolean Plugin_077(uint8_t function, struct EventStruct *event, String& string)
       break;
     }
 
+    case PLUGIN_GET_DEVICEVALUECOUNT:
+    {
+      event->Par1 = P077_NR_OUTPUT_VALUES;
+      success     = true;
+      break;
+    }
+
     # if FEATURE_MQTT_DISCOVER
     case PLUGIN_GET_DISCOVERY_VTYPES:
     {
-      event->Par1 = static_cast<int>(Sensor_VType::SENSOR_TYPE_NONE); // Not yet supported
-      success     = true;
+      for (uint8_t i = 0; i < event->Par5; ++i) {
+        const uint8_t choice = PCONFIG(i + P077_QUERY1_CONFIG_POS);
+        event->ParN[i] = static_cast<int>(Plugin_077_QueryVType(choice));
+      }
+      success = true;
       break;
     }
     # endif // if FEATURE_MQTT_DISCOVER

src/_P078_Eastron.ino

@@ -13,6 +13,7 @@
  */
 
 /** Changelog:
+ * 2025-01-17 tonhuisman: Implement support for MQTT AutoDiscovery (partial)
  * 2025-01-12 tonhuisman: Add support for MQTT AutoDiscovery (not supported yet for Eastron)
  */
 
@@ -66,10 +67,11 @@ boolean Plugin_078(uint8_t function, struct EventStruct *event, String& string)
 
     case PLUGIN_GET_DEVICEVALUENAMES:
     {
+      const SDM_MODEL model = static_cast<SDM_MODEL>(P078_MODEL);
+
       for (uint8_t i = 0; i < VARS_PER_TASK; ++i) {
         if (i < P078_NR_OUTPUT_VALUES) {
-          const SDM_MODEL model  = static_cast<SDM_MODEL>(P078_MODEL);
-          const uint8_t   choice = PCONFIG(i + P078_QUERY1_CONFIG_POS);
+          const uint8_t choice = PCONFIG(i + P078_QUERY1_CONFIG_POS);
           ExtraTaskSettings.setTaskDeviceValueName(i, SDM_getValueNameForModel(model, choice));
         } else {
           ExtraTaskSettings.clearTaskDeviceValueName(i);
@@ -87,8 +89,13 @@ boolean Plugin_078(uint8_t function, struct EventStruct *event, String& string)
     # if FEATURE_MQTT_DISCOVER
     case PLUGIN_GET_DISCOVERY_VTYPES:
     {
-      event->Par1 = static_cast<int>(Sensor_VType::SENSOR_TYPE_NONE); // Not yet supported
-      success     = true;
+      const SDM_MODEL model = static_cast<SDM_MODEL>(P078_MODEL);
+
+      for (uint8_t i = 0; i < event->Par5; ++i) {
+        const uint8_t choice = PCONFIG(i + P078_QUERY1_CONFIG_POS);
+        event->ParN[i] = static_cast<int>(SDM_QueryVType(model, choice));
+      }
+      success = true;
       break;
     }
     # endif // if FEATURE_MQTT_DISCOVER

src/_P085_AcuDC243.ino

@@ -17,6 +17,7 @@
  */
 
 /** Changelog:
+ * 2025-01-12 tonhuisman: Implement support for MQTT AutoDiscovery (partially)
  * 2025-01-12 tonhuisman: Add support for MQTT AutoDiscovery (not supported yet for AcuDC)
  */
 
@@ -73,8 +74,11 @@ boolean Plugin_085(uint8_t function, struct EventStruct *event, String& string)
     # if FEATURE_MQTT_DISCOVER
     case PLUGIN_GET_DISCOVERY_VTYPES:
     {
-      event->Par1 = static_cast<int>(Sensor_VType::SENSOR_TYPE_NONE); // Not yet supported
-      success     = true;
+      for (uint8_t i = 0; i < event->Par5; ++i) {
+        const uint8_t choice = PCONFIG(i + P085_QUERY1_CONFIG_POS);
+        event->ParN[i] = static_cast<int>(Plugin_085_QueryVType(choice));
+      }
+      success = true;
       break;
     }
     # endif // if FEATURE_MQTT_DISCOVER

src/_P097_Esp32Touch.ino

@@ -6,6 +6,7 @@
 // #######################################################################################################
 
 /** Changelog:
+ * 2025-01-16 tonhuisman: Move technical #defines to P097_data_struct.h to avoid Arduino compiler warning
  * 2025-01-12 tonhuisman: Add support for MQTT AutoDiscovery (not supported yet for Touch)
  * 2024-12-11 chromoxdor: Added extra routine for ESP32S2 and ESP32S3.
  *                        Added "Wake Up from Sleep", Switch like behaviour + toggle and long press option.

src/_P102_PZEM004Tv3.ino

@@ -8,6 +8,7 @@
 //
 
 /** Changelog:
+ * 2025-01-17 tonhuisman: Implement support for MQTT AutoDiscovery (partially)
  * 2025-01-12 tonhuisman: Add support for MQTT AutoDiscovery (not supported yet for PZEM00x)
  */
 
@@ -96,8 +97,11 @@ boolean                    Plugin_102(uint8_t function, struct EventStruct *even
     # if FEATURE_MQTT_DISCOVER
     case PLUGIN_GET_DISCOVERY_VTYPES:
     {
-      event->Par1 = static_cast<int>(Sensor_VType::SENSOR_TYPE_NONE); // Not yet supported
-      success     = true;
+      for (uint8_t i = 0; i < event->Par5; ++i) {
+        const uint8_t choice = PCONFIG(i + P102_QUERY1_CONFIG_POS);
+        event->ParN[i] = static_cast<int>(p102_getQueryVType(choice));
+      }
+      success = true;
       break;
     }
     # endif // if FEATURE_MQTT_DISCOVER
@@ -394,4 +398,20 @@ const __FlashStringHelper* p102_getQueryString(uint8_t query) {
   return F("");
 }
 
+# if FEATURE_MQTT_DISCOVER
+Sensor_VType p102_getQueryVType(uint8_t query) {
+  switch (query)
+  {
+    case 0: return Sensor_VType::SENSOR_TYPE_VOLTAGE_ONLY;
+    case 1: return Sensor_VType::SENSOR_TYPE_CURRENT_ONLY;
+    case 2: return Sensor_VType::SENSOR_TYPE_POWER_USG_ONLY;
+    case 3: return Sensor_VType::SENSOR_TYPE_NONE; // FIXME
+    case 4: return Sensor_VType::SENSOR_TYPE_POWER_FACT_ONLY;
+    case 5: return Sensor_VType::SENSOR_TYPE_NONE;
+  }
+  return Sensor_VType::SENSOR_TYPE_NONE;
+}
+
+# endif // if FEATURE_MQTT_DISCOVER
+
 #endif // USES_P102

src/_P108_DDS238.ino

@@ -17,6 +17,7 @@
 //      with most code copied from plugin 085: _P085_AcuDC243.ino
 
 /** Changelog:
+ * 2025-01-17 tonhuisman: Implement support for MQTT AutoDiscovery (partially)
  * 2025-01-12 tonhuisman: Add support for MQTT AutoDiscovery (not supported yet for DDS238)
  */
 
@@ -81,8 +82,11 @@ boolean Plugin_108(uint8_t function, struct EventStruct *event, String& string)
     # if FEATURE_MQTT_DISCOVER
     case PLUGIN_GET_DISCOVERY_VTYPES:
     {
-      event->Par1 = static_cast<int>(Sensor_VType::SENSOR_TYPE_NONE); // Not yet supported
-      success     = true;
+      for (uint8_t i = 0; i < event->Par5; ++i) {
+        const uint8_t choice = PCONFIG(i + P108_QUERY1_CONFIG_POS);
+        event->ParN[i] = static_cast<int>(Plugin_108_getQueryVType(choice));
+      }
+      success = true;
       break;
     }
     # endif // if FEATURE_MQTT_DISCOVER

src/src/DataTypes/SensorVType.cpp

@@ -81,6 +81,7 @@ uint8_t getValueCountFromSensorType(Sensor_VType sensorType)
     case Sensor_VType::SENSOR_TYPE_COLOR_GREEN_ONLY:
     case Sensor_VType::SENSOR_TYPE_COLOR_BLUE_ONLY:
     case Sensor_VType::SENSOR_TYPE_COLOR_TEMP_ONLY:
+    case Sensor_VType::SENSOR_TYPE_REACTIVE_POWER_ONLY:
       return 1;
   }
   #ifndef BUILD_NO_DEBUG
@@ -153,6 +154,7 @@ const __FlashStringHelper* getSensorTypeLabel(Sensor_VType sensorType) {
     case Sensor_VType::SENSOR_TYPE_COLOR_GREEN_ONLY: return F("Green");
     case Sensor_VType::SENSOR_TYPE_COLOR_BLUE_ONLY:  return F("Blue");
     case Sensor_VType::SENSOR_TYPE_COLOR_TEMP_ONLY:  return F("Color temperature");
+    case Sensor_VType::SENSOR_TYPE_REACTIVE_POWER_ONLY: return F("Reactive Power");
     #else // if FEATURE_MQTT_DISCOVER
     case Sensor_VType::SENSOR_TYPE_ANALOG_ONLY:
     case Sensor_VType::SENSOR_TYPE_TEMP_ONLY:
@@ -181,6 +183,7 @@ const __FlashStringHelper* getSensorTypeLabel(Sensor_VType sensorType) {
     case Sensor_VType::SENSOR_TYPE_COLOR_GREEN_ONLY:
     case Sensor_VType::SENSOR_TYPE_COLOR_BLUE_ONLY:
     case Sensor_VType::SENSOR_TYPE_COLOR_TEMP_ONLY:
+    case Sensor_VType::SENSOR_TYPE_REACTIVE_POWER_ONLY:
       break;
     #endif // if FEATURE_MQTT_DISCOVER
   }

src/src/DataTypes/SensorVType.h

@@ -61,6 +61,7 @@ enum class Sensor_VType : uint8_t {
   SENSOR_TYPE_COLOR_GREEN_ONLY = 124,
   SENSOR_TYPE_COLOR_BLUE_ONLY =  125,
   SENSOR_TYPE_COLOR_TEMP_ONLY =  126,
+  SENSOR_TYPE_REACTIVE_POWER_ONLY = 127,
 
   SENSOR_TYPE_NOT_SET = 255
 };

src/src/Helpers/_CPlugin_Helper_mqtt.cpp

@@ -577,12 +577,14 @@ bool MQTT_HomeAssistant_SendAutoDiscovery(controllerIndex_t         ControllerIn
               }
               case Sensor_VType::SENSOR_TYPE_POWER_FACT_ONLY:
               case Sensor_VType::SENSOR_TYPE_POWER_USG_ONLY:
+              case Sensor_VType::SENSOR_TYPE_REACTIVE_POWER_ONLY:
               case Sensor_VType::SENSOR_TYPE_APPRNT_POWER_USG_ONLY:
               {
                 const __FlashStringHelper*dev = Sensor_VType::SENSOR_TYPE_POWER_FACT_ONLY == discoveryItems[s].VType ?
                                                 F("power_factor") : F("power");
                 const __FlashStringHelper*uom = Sensor_VType::SENSOR_TYPE_POWER_FACT_ONLY == discoveryItems[s].VType ? F("Cos φ") :
                                                 Sensor_VType::SENSOR_TYPE_POWER_USG_ONLY == discoveryItems[s].VType ? F("kWh") :
+                                                Sensor_VType::SENSOR_TYPE_REACTIVE_POWER_ONLY == discoveryItems[s].VType ? F("var") :
                                                 F("VA");
 
                 for (uint8_t v = discoveryItems[s].varIndex; v < varCount; ++v) {

src/src/PluginStructs/P077_data_struct.cpp

@@ -26,6 +26,28 @@ const __FlashStringHelper* Plugin_077_valuename(P077_query value_nr, bool displa
   return F("");
 }
 
+# if FEATURE_MQTT_DISCOVER
+Sensor_VType Plugin_077_QueryVType(uint8_t value_nr) {
+  const Sensor_VType vtypes[] = {
+    Sensor_VType::SENSOR_TYPE_VOLTAGE_ONLY,
+    Sensor_VType::SENSOR_TYPE_POWER_USG_ONLY,
+    Sensor_VType::SENSOR_TYPE_CURRENT_ONLY,
+    Sensor_VType::SENSOR_TYPE_NONE,
+    Sensor_VType::SENSOR_TYPE_POWER_USG_ONLY,
+    Sensor_VType::SENSOR_TYPE_APPRNT_POWER_USG_ONLY,
+    Sensor_VType::SENSOR_TYPE_POWER_FACT_ONLY,
+    Sensor_VType::SENSOR_TYPE_REACTIVE_POWER_ONLY,
+  };
+  constexpr uint8_t  valueCount = NR_ELEMENTS(vtypes);
+
+  if (value_nr < valueCount) {
+    return vtypes[value_nr];
+  }
+  return Sensor_VType::SENSOR_TYPE_NONE;
+}
+
+# endif // if FEATURE_MQTT_DISCOVER
+
 P077_query Plugin_077_from_valuename(const String& valuename)
 {
   for (uint8_t query = 0; query < static_cast<uint8_t>(P077_query::P077_QUERY_NR_OUTPUT_OPTIONS); ++query) {
@@ -321,7 +343,7 @@ bool P077_data_struct::plugin_read(struct EventStruct *event) {
       float value{};
 
       if (_cache[index].peek(value)) {
-        UserVar.setFloat(event->TaskIndex, i,  value);
+        UserVar.setFloat(event->TaskIndex, i, value);
       }
     }
   }
@@ -359,7 +381,7 @@ bool P077_data_struct::plugin_write(struct EventStruct *event,
     setOutputValue(event, P077_query::P077_QUERY_KWH,    cf_pulses);
     setOutputValue(event, P077_query::P077_QUERY_PULSES, cf_pulses);
     Scheduler.schedule_task_device_timer(event->TaskIndex, millis() + 10);
-    success   = true;
+    success = true;
   } else if (equals(cmd, F("csecalibrate"))) { // Set 1 or more calibration values, 0 will skip that value
     success = true;
     float CalibVolt  = 0.0f;
@@ -441,7 +463,7 @@ void P077_data_struct::setOutputValue(struct EventStruct *event, P077_query outp
         // Set preliminary averaged value as task value.
         // This way we can see intermediate updates.
         _cache[index].peek(value);
-        UserVar.setFloat(event->TaskIndex, i,  value);
+        UserVar.setFloat(event->TaskIndex, i, value);
       }
     }
   }

src/src/PluginStructs/P077_data_struct.h

@@ -3,7 +3,7 @@
 
 #include "../../_Plugin_Helper.h"
 #ifdef USES_P077
-#include "../Helpers/OversamplingHelper.h"
+# include "../Helpers/OversamplingHelper.h"
 
 # define CSE_NOT_CALIBRATED          0xAA
 # define CSE_PULSES_NOT_INITIALIZED  -1
@@ -47,7 +47,9 @@ enum class P077_query : uint8_t {
 
 const __FlashStringHelper* Plugin_077_valuename(P077_query value_nr,
                                                 bool       displayString);
-
+# if FEATURE_MQTT_DISCOVER
+Sensor_VType               Plugin_077_QueryVType(uint8_t value_nr);
+# endif // if FEATURE_MQTT_DISCOVER
 P077_query                 Plugin_077_from_valuename(const String& valuename);
 
 struct P077_data_struct : public PluginTaskData_base {
@@ -99,9 +101,11 @@ struct P077_data_struct : public PluginTaskData_base {
   uint32_t last_cf_pulses_moment{};
 
 private:
-  OversamplingHelper<float> _cache[static_cast<uint8_t>(P077_query::P077_QUERY_NR_OUTPUT_OPTIONS)]{};
+
+  OversamplingHelper<float>_cache[static_cast<uint8_t>(P077_query::P077_QUERY_NR_OUTPUT_OPTIONS)]{};
 
 public:
+
   // stats
   long     t_max       = 0;
   long     t_all       = 0;