refactor: sensors type settings moved to portal, entities for HA have been deleted; logging settings moved; bump version

src/HaHelper.h

@@ -5,56 +5,6 @@ class HaHelper : public HomeAssistantHelper {
 public:
   static const byte TEMP_SOURCE_HEATING = 0;
   static const byte TEMP_SOURCE_INDOOR = 1;
-  
-  bool publishSelectOutdoorSensorType(bool enabledByDefault = true) {
-    JsonDocument doc;
-    doc[FPSTR(HA_COMMAND_TOPIC)] = this->getDeviceTopic(F("settings/set"));
-    doc[FPSTR(HA_COMMAND_TEMPLATE)] = F("{\"sensors\": {\"outdoor\": {\"type\": {% if value == 'Boiler' %}0{% elif value == 'Manual' %}1{% elif value == 'External' %}2{% endif %}}}}");
-    doc[FPSTR(HA_ENABLED_BY_DEFAULT)] = enabledByDefault;
-    doc[FPSTR(HA_UNIQUE_ID)] = this->getObjectId(F("outdoor_sensor_type"));
-    doc[FPSTR(HA_OBJECT_ID)] = this->getObjectId(F("outdoor_sensor_type"));
-    doc[FPSTR(HA_ENTITY_CATEGORY)] = F("config");
-    doc[FPSTR(HA_NAME)] = F("Outdoor temperature source");
-    doc[FPSTR(HA_STATE_TOPIC)] = this->getDeviceTopic(F("settings"));
-    doc[FPSTR(HA_VALUE_TEMPLATE)] = F("{% if value_json.sensors.outdoor.type == 0 %}Boiler{% elif value_json.sensors.outdoor.type == 1 %}Manual{% elif value_json.sensors.outdoor.type == 2 %}External{% endif %}");
-    doc[FPSTR(HA_OPTIONS)][0] = F("Boiler");
-    doc[FPSTR(HA_OPTIONS)][1] = F("Manual");
-    doc[FPSTR(HA_OPTIONS)][2] = F("External");
-    doc[FPSTR(HA_EXPIRE_AFTER)] = 120;
-    doc.shrinkToFit();
-
-    return this->publish(this->getTopic(FPSTR(HA_ENTITY_SELECT), F("outdoor_sensor_type")).c_str(), doc);
-  }
-
-  bool publishSelectIndoorSensorType(bool enabledByDefault = true) {
-    JsonDocument doc;
-    doc[FPSTR(HA_COMMAND_TOPIC)] = this->getDeviceTopic(F("settings/set"));
-#if USE_BLE
-    doc[FPSTR(HA_COMMAND_TEMPLATE)] = F("{\"sensors\": {\"indoor\": {\"type\": {% if value == 'Manual' %}1{% elif value == 'External' %}2{% elif value == 'Bluetooth' %}3{% endif %}}}}");
-#else
-    doc[FPSTR(HA_COMMAND_TEMPLATE)] = F("{\"sensors\": {\"indoor\": {\"type\": {% if value == 'Manual' %}1{% elif value == 'External' %}2{% endif %}}}}");
-#endif
-    doc[FPSTR(HA_ENABLED_BY_DEFAULT)] = enabledByDefault;
-    doc[FPSTR(HA_UNIQUE_ID)] = this->getObjectId(F("indoor_sensor_type"));
-    doc[FPSTR(HA_OBJECT_ID)] = this->getObjectId(F("indoor_sensor_type"));
-    doc[FPSTR(HA_ENTITY_CATEGORY)] = F("config");
-    doc[FPSTR(HA_NAME)] = F("Indoor temperature source");
-    doc[FPSTR(HA_STATE_TOPIC)] = this->getDeviceTopic(F("settings"));
-#if USE_BLE
-    doc[FPSTR(HA_VALUE_TEMPLATE)] = F("{% if value_json.sensors.indoor.type == 1 %}Manual{% elif value_json.sensors.indoor.type == 2 %}External{% elif value_json.sensors.indoor.type == 3 %}Bluetooth{% endif %}");
-#else
-    doc[FPSTR(HA_VALUE_TEMPLATE)] = F("{% if value_json.sensors.indoor.type == 1 %}Manual{% elif value_json.sensors.indoor.type == 2 %}External{% endif %}");
-#endif
-    doc[FPSTR(HA_OPTIONS)][0] = F("Manual");
-    doc[FPSTR(HA_OPTIONS)][1] = F("External");
-#if USE_BLE
-    doc[FPSTR(HA_OPTIONS)][2] = F("Bluetooth");
-#endif
-    doc[FPSTR(HA_EXPIRE_AFTER)] = 120;
-    doc.shrinkToFit();
-
-    return this->publish(this->getTopic(FPSTR(HA_ENTITY_SELECT), F("indoor_sensor_type")).c_str(), doc);
-  }
 
   bool publishNumberOutdoorSensorOffset(bool enabledByDefault = true) {
     JsonDocument doc;
@@ -109,28 +59,6 @@ public:
   }
 
 
-  bool publishSwitchDebug(bool enabledByDefault = true) {
-    JsonDocument doc;
-    doc[FPSTR(HA_ENABLED_BY_DEFAULT)] = enabledByDefault;
-    doc[FPSTR(HA_UNIQUE_ID)] = this->getObjectId(F("debug"));
-    doc[FPSTR(HA_OBJECT_ID)] = this->getObjectId(F("debug"));
-    doc[FPSTR(HA_ENTITY_CATEGORY)] = F("config");
-    doc[FPSTR(HA_NAME)] = F("Debug");
-    doc[FPSTR(HA_ICON)] = F("mdi:code-braces");
-    doc[FPSTR(HA_STATE_TOPIC)] = this->getDeviceTopic(F("settings"));
-    doc[FPSTR(HA_STATE_ON)] = true;
-    doc[FPSTR(HA_STATE_OFF)] = false;
-    doc[FPSTR(HA_VALUE_TEMPLATE)] = F("{{ value_json.debug }}");
-    doc[FPSTR(HA_COMMAND_TOPIC)] = this->getDeviceTopic(F("settings/set"));
-    doc[FPSTR(HA_PAYLOAD_ON)] = F("{\"debug\": true}");
-    doc[FPSTR(HA_PAYLOAD_OFF)] = F("{\"debug\": false}");
-    doc[FPSTR(HA_EXPIRE_AFTER)] = 120;
-    doc.shrinkToFit();
-
-    return this->publish(this->getTopic(FPSTR(HA_ENTITY_SWITCH), F("debug")).c_str(), doc);
-  }
-
-
   bool publishSwitchEmergency(bool enabledByDefault = true) {
     JsonDocument doc;
     doc[FPSTR(HA_ENABLED_BY_DEFAULT)] = enabledByDefault;

src/MainTask.h

@@ -4,9 +4,7 @@ extern NetworkTask* tNetwork;
 extern MqttTask* tMqtt;
 extern OpenThermTask* tOt;
 extern FileData fsSettings, fsNetworkSettings;
-#if USE_TELNET
-  extern ESPTelnetStream TelnetStream;
-#endif
+extern ESPTelnetStream* telnetStream;
 
 
 class MainTask : public Task {
@@ -36,9 +34,7 @@ protected:
   unsigned long heatingDisabledTime = 0;
   byte externalPumpStartReason;
   unsigned long externalPumpStartTime = 0;
-#if USE_TELNET
   bool telnetStarted = false;
-#endif
 
   const char* getTaskName() {
     return "Main";
@@ -76,11 +72,9 @@ protected:
       Log.sinfoln(FPSTR(L_NETWORK_SETTINGS), F("Updated"));
     }
 
-    #if USE_TELNET
     if (this->telnetStarted) {
-      TelnetStream.loop();
+      telnetStream->loop();
     }
-    #endif
 
     if (vars.actions.restart) {
       Log.sinfoln(FPSTR(L_MAIN), F("Restart signal received. Restart after 10 sec."));
@@ -95,12 +89,10 @@ protected:
     }
 
     if (tNetwork->isConnected()) {
-      #if USE_TELNET
-      if (!this->telnetStarted) {
-        TelnetStream.begin(23, false);
+      if (!this->telnetStarted && telnetStream != nullptr) {
+        telnetStream->begin(23, false);
         this->telnetStarted = true;
       }
-      #endif
 
       vars.sensors.rssi = WiFi.RSSI();
 
@@ -112,20 +104,18 @@ protected:
         this->firstFailConnect = 0;
       }
 
-      if ( Log.getLevel() != TinyLogger::Level::INFO && !settings.debug ) {
+      if ( Log.getLevel() != TinyLogger::Level::INFO && !settings.system.debug ) {
         Log.setLevel(TinyLogger::Level::INFO);
 
-      } else if ( Log.getLevel() != TinyLogger::Level::VERBOSE && settings.debug ) {
+      } else if ( Log.getLevel() != TinyLogger::Level::VERBOSE && settings.system.debug ) {
         Log.setLevel(TinyLogger::Level::VERBOSE);
       }
 
     } else {
-      #if USE_TELNET
       if (this->telnetStarted) {
-        TelnetStream.stop();
+        telnetStream->stop();
         this->telnetStarted = false;
       }
-      #endif
 
       if (tMqtt->isEnabled()) {
         tMqtt->disable();
@@ -178,7 +168,7 @@ protected:
       return;
     }
 
-    if (!settings.debug) {
+    if (!settings.system.debug) {
       return;
     }
 

src/MqttTask.h

@@ -257,7 +257,7 @@ protected:
       return;
     }
 
-    if (settings.debug) {
+    if (settings.system.debug) {
       Log.strace(FPSTR(L_MQTT_MSG), F("Topic: %s\r\n>  "), topic);
       if (Log.lock()) {
         for (size_t i = 0; i < length; i++) {
@@ -328,11 +328,8 @@ protected:
 
   void publishHaEntities() {
     // main
-    this->haHelper->publishSelectOutdoorSensorType();
-    this->haHelper->publishSelectIndoorSensorType();
     this->haHelper->publishNumberOutdoorSensorOffset(false);
     this->haHelper->publishNumberIndoorSensorOffset(false);
-    this->haHelper->publishSwitchDebug(false);
 
     // emergency
     this->haHelper->publishSwitchEmergency();

src/PortalTask.h

@@ -1,5 +1,5 @@
 #define PORTAL_CACHE_TIME "" //"max-age=86400"
-#define PORTAL_CACHE settings.debug ? nullptr : PORTAL_CACHE_TIME
+#define PORTAL_CACHE settings.system.debug ? nullptr : PORTAL_CACHE_TIME
 #ifdef ARDUINO_ARCH_ESP8266
 #include <ESP8266WebServer.h>
 #include <Updater.h>

src/Settings.h

@@ -23,7 +23,11 @@ struct NetworkSettings {
 } networkSettings;
 
 struct Settings {
-  bool debug = DEBUG_BY_DEFAULT;
+  struct {
+    bool debug = DEBUG_BY_DEFAULT;
+    bool useSerial = USE_SERIAL;
+    bool useTelnet = USE_TELNET;
+  } system;
 
   struct {
     bool useAuth = false;

src/defines.h

@@ -1,5 +1,5 @@
 #define PROJECT_NAME                "OpenTherm Gateway"
-#define PROJECT_VERSION             "1.4.0-rc.9"
+#define PROJECT_VERSION             "1.4.0-rc.10"
 #define PROJECT_REPO                "https://github.com/Laxilef/OTGateway"
 
 #define EMERGENCY_TIME_TRESHOLD     120000

src/main.cpp

@@ -4,14 +4,11 @@
 #include <ArduinoJson.h>
 #include <FileData.h>
 #include <LittleFS.h>
+#include "ESPTelnetStream.h"
 #include <TinyLogger.h>
 #include "Settings.h"
 #include <utils.h>
 
-#if USE_TELNET
-  #include "ESPTelnetStream.h"
-#endif
-
 #if defined(ARDUINO_ARCH_ESP32)
   #include <ESP32Scheduler.h>
 #elif defined(ARDUINO_ARCH_ESP8266)
@@ -33,9 +30,7 @@
 // Vars
 FileData fsNetworkSettings(&LittleFS, "/network.conf", 'n', &networkSettings, sizeof(networkSettings), 1000);
 FileData fsSettings(&LittleFS, "/settings.conf", 's', &settings, sizeof(settings), 60000);
-#if USE_TELNET
-ESPTelnetStream TelnetStream;
-#endif
+ESPTelnetStream* telnetStream = nullptr;
 
 // Tasks
 NetworkTask* tNetwork;
@@ -63,17 +58,9 @@ void setup() {
 
     return tm{sec, min, hour};
   });
-
-  #if USE_SERIAL
+  
   Serial.begin(115200);
   Log.addStream(&Serial);
-  #endif
-
-  #if USE_TELNET
-  TelnetStream.setKeepAliveInterval(500);
-  Log.addStream(&TelnetStream);
-  #endif
-
   Log.print("\n\n\r");
 
   // network settings
@@ -121,8 +108,21 @@ void setup() {
       break;
   }
 
-  Log.setLevel(settings.debug ? TinyLogger::Level::VERBOSE : TinyLogger::Level::INFO);
+  // logs
+  if (!settings.system.useSerial) {
+    Log.clearStreams();
+    Serial.end();
+  }
 
+  if (settings.system.useTelnet) {
+    telnetStream = new ESPTelnetStream;
+    telnetStream->setKeepAliveInterval(500);
+    Log.addStream(telnetStream);
+  }
+
+  Log.setLevel(settings.system.debug ? TinyLogger::Level::VERBOSE : TinyLogger::Level::INFO);
+
+  // tasks
   tNetwork = (new NetworkTask(true, 500))
     ->setHostname(networkSettings.hostname)
     ->setStaCredentials(

src/utils.h

@@ -234,9 +234,11 @@ bool jsonToNetworkSettings(const JsonVariantConst src, NetworkSettings& dst) {
 }
 
 void settingsToJson(const Settings& src, JsonVariant dst, bool safe = false) {
-  dst["debug"] = src.debug;
-
   if (!safe) {
+    dst["system"]["debug"] = src.system.debug;
+    dst["system"]["useSerial"] = src.system.useSerial;
+    dst["system"]["useTelnet"] = src.system.useTelnet;
+
     dst["portal"]["useAuth"] = src.portal.useAuth;
     dst["portal"]["login"] = src.portal.login;
     dst["portal"]["password"] = src.portal.password;
@@ -318,13 +320,24 @@ void safeSettingsToJson(const Settings& src, JsonVariant dst) {
 bool jsonToSettings(const JsonVariantConst src, Settings& dst, bool safe = false) {
   bool changed = false;
 
-  if (src["debug"].is<bool>()) {
-    dst.debug = src["debug"].as<bool>();
-    changed = true;
-  }
-
-
   if (!safe) {
+    // system
+    if (src["system"]["debug"].is<bool>()) {
+      dst.system.debug = src["system"]["debug"].as<bool>();
+      changed = true;
+    }
+
+    if (src["system"]["useSerial"].is<bool>()) {
+      dst.system.useSerial = src["system"]["useSerial"].as<bool>();
+      changed = true;
+    }
+
+    if (src["system"]["useTelnet"].is<bool>()) {
+      dst.system.useTelnet = src["system"]["useTelnet"].as<bool>();
+      changed = true;
+    }
+
+
     // portal
     if (src["portal"]["useAuth"].is<bool>()) {
       dst.portal.useAuth = src["portal"]["useAuth"].as<bool>();