Optimization HomeAssistantHelper

lib/HomeAssistantHelper/HomeAssistantHelper.h

@@ -0,0 +1,73 @@
+#pragma once
+#include <Arduino.h>
+
+class HomeAssistantHelper {
+public:
+  HomeAssistantHelper(PubSubClient& client) :
+    client(&client)
+  {
+  }
+
+  void setPrefix(String value) {
+    _prefix = value;
+  }
+
+  void setDeviceVersion(String value) {
+    _deviceVersion = value;
+  }
+
+  void setDeviceManufacturer(String value) {
+    _deviceManufacturer = value;
+  }
+
+  void setDeviceModel(String value) {
+    _deviceModel = value;
+  }
+
+  void setDeviceName(String value) {
+    _deviceName = value;
+  }
+
+  void setDeviceConfigUrl(String value) {
+    _deviceConfigUrl = value;
+  }
+
+  bool publish(const char* topic, JsonDocument& doc) {
+    doc[FPSTR(HA_DEVICE)][FPSTR(HA_IDENTIFIERS)][0] = _prefix;
+    doc[FPSTR(HA_DEVICE)][FPSTR(HA_SW_VERSION)] = _deviceVersion;
+    doc[FPSTR(HA_DEVICE)][FPSTR(HA_MANUFACTURER)] = _deviceManufacturer;
+    doc[FPSTR(HA_DEVICE)][FPSTR(HA_MODEL)] = _deviceModel;
+    doc[FPSTR(HA_DEVICE)][FPSTR(HA_NAME)] = _deviceName;
+    if (_deviceConfigUrl) {
+      doc[FPSTR(HA_DEVICE)][FPSTR(HA_CONF_URL)] = _deviceConfigUrl;
+    }
+
+    client->beginPublish(topic, measureJson(doc), true);
+    serializeJson(doc, *client);
+    return client->endPublish();
+  }
+
+  bool publish(const char* topic) {
+    return client->publish(topic, NULL, true);
+  }
+
+  String getTopic(const char* category, const char* name, const char* nameSeparator = "/") {
+    String topic = "homeassistant/";
+    topic.concat(category);
+    topic.concat("/");
+    topic.concat(_prefix);
+    topic.concat(nameSeparator);
+    topic.concat(name);
+    topic.concat("/config");
+    return topic;
+  }
+
+protected:
+  PubSubClient* client;
+  String _prefix = "";
+  String _deviceVersion = "1.0";
+  String _deviceManufacturer = "Community";
+  String _deviceModel = "";
+  String _deviceName = "";
+  String _deviceConfigUrl = "";
+};

lib/HomeAssistantHelper/strings.h

@@ -0,0 +1,37 @@
+#pragma once
+#ifndef PROGMEM
+#define PROGMEM 
+#endif
+
+const char HA_DEVICE[]              PROGMEM = "device";
+const char HA_IDENTIFIERS[]         PROGMEM = "identifiers";
+const char HA_SW_VERSION[]          PROGMEM = "sw_version";
+const char HA_MANUFACTURER[]        PROGMEM = "manufacturer";
+const char HA_MODEL[]               PROGMEM = "model";
+const char HA_NAME[]                PROGMEM = "name";
+const char HA_CONF_URL[]            PROGMEM = "configuration_url";
+const char HA_COMMAND_TOPIC[]       PROGMEM = "command_topic";
+const char HA_COMMAND_TEMPLATE[]    PROGMEM = "command_template";
+const char HA_ENABLED_BY_DEFAULT[]  PROGMEM = "enabled_by_default";
+const char HA_UNIQUE_ID[]           PROGMEM = "unique_id";
+const char HA_OBJECT_ID[]           PROGMEM = "object_id";
+const char HA_ENTITY_CATEGORY[]     PROGMEM = "entity_category";
+const char HA_STATE_TOPIC[]         PROGMEM = "state_topic";
+const char HA_VALUE_TEMPLATE[]      PROGMEM = "value_template";
+const char HA_OPTIONS[]             PROGMEM = "options";
+const char HA_AVAILABILITY[]        PROGMEM = "availability";
+const char HA_AVAILABILITY_MODE[]   PROGMEM = "availability_mode";
+const char HA_TOPIC[]               PROGMEM = "topic";
+const char HA_DEVICE_CLASS[]        PROGMEM = "device_class";
+const char HA_UNIT_OF_MEASUREMENT[] PROGMEM = "unit_of_measurement";
+const char HA_ICON[]                PROGMEM = "icon";
+const char HA_MIN[]                 PROGMEM = "min";
+const char HA_MAX[]                 PROGMEM = "max";
+const char HA_STEP[]                PROGMEM = "step";
+const char HA_MODE[]                PROGMEM = "mode";
+const char HA_STATE_ON[]            PROGMEM = "state_on";
+const char HA_STATE_OFF[]           PROGMEM = "state_off";
+const char HA_PAYLOAD_ON[]          PROGMEM = "payload_on";
+const char HA_PAYLOAD_OFF[]         PROGMEM = "payload_off";
+const char HA_STATE_CLASS[]         PROGMEM = "state_class";
+const char HA_EXPIRE_AFTER[]        PROGMEM = "expire_after";

src/MqttTask.h

@@ -1,11 +1,11 @@
 #include <WiFiClient.h>
 #include <PubSubClient.h>
 #include <netif/etharp.h>
-#include "HomeAssistantHelper.h"
+#include "HaHelper.h"
 
 WiFiClient espClient;
 PubSubClient client(espClient);
-HomeAssistantHelper haHelper;
+HaHelper haHelper(client);
 
 
 class MqttTask : public Task {
@@ -22,6 +22,8 @@ protected:
     client.setCallback(__callback);
     haHelper.setPrefix(settings.mqtt.prefix);
     haHelper.setDeviceVersion(OT_GATEWAY_VERSION);
+    haHelper.setDeviceModel("Opentherm Gateway");
+    haHelper.setDeviceName("Opentherm Gateway");
 
     sprintf(buffer, CONFIG_URL, WiFi.localIP().toString().c_str());
     haHelper.setDeviceConfigUrl(buffer);
@@ -192,21 +194,21 @@ protected:
     }
 
     if (!doc["pid"]["p_factor"].isNull() && doc["pid"]["p_factor"].is<float>()) {
-      if (doc["pid"]["p_factor"].as<float>() >= 0 && doc["pid"]["p_factor"].as<float>() <= 20) {
+      if (doc["pid"]["p_factor"].as<float>() > 0 && doc["pid"]["p_factor"].as<float>() <= 10) {
         settings.pid.p_factor = round(doc["pid"]["p_factor"].as<float>() * 1000) / 1000;
         flag = true;
       }
     }
 
     if (!doc["pid"]["i_factor"].isNull() && doc["pid"]["i_factor"].is<float>()) {
-      if (doc["pid"]["i_factor"].as<float>() >= 0 && doc["pid"]["i_factor"].as<float>() <= 20) {
+      if (doc["pid"]["i_factor"].as<float>() >= 0 && doc["pid"]["i_factor"].as<float>() <= 10) {
         settings.pid.i_factor = round(doc["pid"]["i_factor"].as<float>() * 1000) / 1000;
         flag = true;
       }
     }
 
     if (!doc["pid"]["d_factor"].isNull() && doc["pid"]["d_factor"].is<float>()) {
-      if (doc["pid"]["d_factor"].as<float>() >= 0 && doc["pid"]["d_factor"].as<float>() <= 20) {
+      if (doc["pid"]["d_factor"].as<float>() >= 0 && doc["pid"]["d_factor"].as<float>() <= 10) {
         settings.pid.d_factor = round(doc["pid"]["d_factor"].as<float>() * 1000) / 1000;
         flag = true;
       }
@@ -233,21 +235,21 @@ protected:
     }
 
     if (!doc["equitherm"]["n_factor"].isNull() && doc["equitherm"]["n_factor"].is<float>()) {
-      if (doc["equitherm"]["n_factor"].as<float>() >= 0 && doc["equitherm"]["n_factor"].as<float>() <= 20) {
+      if (doc["equitherm"]["n_factor"].as<float>() > 0 && doc["equitherm"]["n_factor"].as<float>() <= 10) {
         settings.equitherm.n_factor = round(doc["equitherm"]["n_factor"].as<float>() * 1000) / 1000;
         flag = true;
       }
     }
 
     if (!doc["equitherm"]["k_factor"].isNull() && doc["equitherm"]["k_factor"].is<float>()) {
-      if (doc["equitherm"]["k_factor"].as<float>() >= 0 && doc["equitherm"]["k_factor"].as<float>() <= 20) {
+      if (doc["equitherm"]["k_factor"].as<float>() >= 0 && doc["equitherm"]["k_factor"].as<float>() <= 10) {
         settings.equitherm.k_factor = round(doc["equitherm"]["k_factor"].as<float>() * 1000) / 1000;
         flag = true;
       }
     }
 
     if (!doc["equitherm"]["t_factor"].isNull() && doc["equitherm"]["t_factor"].is<float>()) {
-      if (doc["equitherm"]["t_factor"].as<float>() >= 0 && doc["equitherm"]["t_factor"].as<float>() <= 20) {
+      if (doc["equitherm"]["t_factor"].as<float>() >= 0 && doc["equitherm"]["t_factor"].as<float>() <= 10) {
         settings.equitherm.t_factor = round(doc["equitherm"]["t_factor"].as<float>() * 1000) / 1000;
         flag = true;
       }
@@ -330,7 +332,6 @@ protected:
     if (!doc["restart"].isNull() && doc["restart"].is<bool>() && doc["restart"].as<bool>()) {
       DEBUG("Received restart message...");
       eeSettings.updateNow();
-      Scheduler.delay(10000);
       DEBUG("Restart...");
 
       ESP.restart();