Merge branch 'dev' of https://github.com/emsesp/EMS-ESP32 into dev

.vscode/settings.json

@@ -41,5 +41,6 @@
     "**/*.min.*",
     "**/*.map",
     "**/ArduinoJson/**"
-  ]
+  ],
+  "cSpell.enableFiletypes": ["!cpp"]
 }

interface/package.json

@@ -12,7 +12,7 @@
     "build-hosted": "vite build --mode hosted",
     "preview": "vite preview",
     "preview-standalone": "npm-run-all -p preview typesafe-i18n mock-api",
-    "mock-api": "nodemon --watch ../mock-api ../mock-api/server.js",
+    "mock-api": "node --watch ../mock-api ../mock-api/server.js",
     "standalone": "npm-run-all -p dev typesafe-i18n mock-api",
     "typesafe-i18n": "typesafe-i18n",
     "format": "prettier --write '**/*.{ts,tsx,js,css,json,md}'",
@@ -22,8 +22,8 @@
     "@alova/adapter-xhr": "^1.0.1",
     "@emotion/react": "^11.11.1",
     "@emotion/styled": "^11.11.0",
-    "@mui/icons-material": "^5.14.6",
+    "@mui/icons-material": "^5.14.7",
-    "@mui/material": "^5.14.6",
+    "@mui/material": "^5.14.7",
     "@preact/compat": "^17.1.2",
     "@prefresh/vite": "^2.4.1",
     "@table-library/react-table-library": "4.1.7",
@@ -66,11 +66,10 @@
     "eslint-plugin-prettier": "alpha",
     "eslint-plugin-react": "^7.33.2",
     "eslint-plugin-react-hooks": "^4.6.0",
-    "nodemon": "^3.0.1",
     "npm-run-all": "^4.1.5",
-    "prettier": "^3.0.2",
+    "prettier": "^3.0.3",
     "rollup-plugin-visualizer": "^5.9.2",
-    "terser": "^5.19.2",
+    "terser": "^5.19.3",
     "vite": "^4.4.9",
     "vite-plugin-svgr": "^3.2.0",
     "vite-tsconfig-paths": "^4.2.0"

interface/vite.config.ts

@@ -50,9 +50,9 @@ export default defineConfig(({ command, mode }) => {
       server: {
         open: true,
         port: 3000,
-        watch: {
+        // watch: {
-          usePolling: true
+        //   usePolling: true
-        },
+        // },
         proxy: {
           '/rest': 'http://localhost:3080',
           '/api': {

mock-api/package.json

@@ -5,15 +5,14 @@
   "author": "proddy",
   "main": "server.js",
   "scripts": {
-    "dev": "nodemon ./server.js localhost 3080",
+    "dev": "node --watch ./server.js localhost 3080",
     "test": "echo \"Error: no test specified\" && exit 1"
   },
   "dependencies": {
     "@msgpack/msgpack": "^2.8.0",
     "compression": "^1.7.4",
     "express": "^4.18.2",
-    "multer": "^1.4.5-lts.1",
+    "multer": "^1.4.5-lts.1"
-    "nodemon": "^3.0.1"
   },
   "packageManager": "yarn@3.4.1"
 }

scripts/api_test.http

@@ -1,17 +1,21 @@
 # testing EMS-ESP API
-# use with https://marketplace.visualstudio.com/items?itemName=humao.rest-client
+# use with "REST Client" extension in Visual Studio Code
+# https://marketplace.visualstudio.com/items?itemName=humao.rest-client
+
+@host = http://ems-esp.local
+@host_dev = http://ems-esp2.local
 
 @token = eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6ImFkbWluIiwiYWRtaW4iOnRydWV9.2bHpWya2C7Q12WjNUBD6_7N3RCD7CMl-EGhyQVzFdDg
 
-GET http://ems-esp.local/api/system/info
+GET {{host}}/api/system/info
 
 ###
 
-GET http://ems-esp.local/api/thermostat/seltemp
+GET {{host}}/api/thermostat/seltemp
 
 ###
 
-POST http://ems-esp.local/api/thermostat/seltemp
+POST {{host}}/api/thermostat/seltemp
 Content-Type: application/json
 Authorization: Bearer {{token}}
 
@@ -21,7 +25,7 @@ Authorization: Bearer {{token}}
 
 ###
 
-POST http://ems-esp.local/api/thermostat
+POST {{host}}/api/thermostat
 Content-Type: application/json
 Authorization: Bearer {{token}}
 
@@ -32,12 +36,61 @@ Authorization: Bearer {{token}}
 
 ###
 
-POST http://10.10.10.134/api
+POST {{host}}/api
 Content-Type: application/json
-Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6ImFkbWluIiwiYWRtaW4iOnRydWV9.2bHpWya2C7Q12WjNUBD6_7N3RCD7CMl-EGhyQVzFdDg
+Authorization: Bearer {{token}}
 
 {
     "device" : "boiler",
     "entity" : "wwtapactivated",
     "value" : "on"
 }
+
+###
+
+GET {{host}}/api/system/restart
+Authorization: Bearer {{token}}
+
+###
+
+GET {{host}}/api/boiler/coldshot
+Authorization: Bearer {{token}}
+
+###
+
+GET {{host}}/api/temperaturesensor/info
+
+###
+
+#
+# Test on dev
+#
+
+GET {{host_dev}}/api/system/info
+
+# Run a test. EMS-ESP must be compiled with -DEMSESP_TEST
+# Use this to load up a dummy thermostat and boiler with data
+
+###
+
+GET {{host_dev}}/api?device=system&cmd=test&data=general
+
+###
+
+GET {{host_dev}}/api/boiler/info
+
+###
+GET {{host_dev}}/api/boiler/values
+
+###
+
+GET {{host_dev}}/api/analogsensor/info
+
+###
+
+GET {{host_dev}}/api/boiler/coldshot
+Authorization: Bearer {{token}}
+
+###
+GET {{host_dev}}/api/system/commands
+

src/command.cpp

@@ -301,9 +301,14 @@ uint8_t Command::call(const uint8_t device_type, const char * cmd, const char *
     auto cf = find_command(device_type, device_id, cmd);
 
     // check if its a call to and end-point to a device
-    // except for system commands as this is a special device without any queryable entities (device values)
+    // this is used to fetch the attributes of the device entity, or call a command directly
-    if ((device_type > EMSdevice::DeviceType::SYSTEM) && (!value || !strlen(value))) {
+    bool single_command = (!value || !strlen(value));
-        if (!cf || !cf->cmdfunction_json_) {
+    if (single_command) {
+        // exception 1: anything that is from System
+        // exception 2: boiler coldshot command
+        bool get_attributes = (!cf || !cf->cmdfunction_json_) && (device_type > EMSdevice::DeviceType::SYSTEM) && (strcmp(cmd, F_(coldshot)) != 0);
+
+        if (get_attributes) {
             LOG_DEBUG("Calling %s command '%s' to retrieve attributes", dname, cmd);
             return EMSESP::get_device_value_info(output, cmd, id, device_type) ? CommandRet::OK : CommandRet::ERROR; // entity = cmd
         }
@@ -344,7 +349,7 @@ uint8_t Command::call(const uint8_t device_type, const char * cmd, const char *
 
         // check if read-only. This also checks for valid tags (e.g. heating circuits)
         if (cf->cmdfunction_) {
-            if (EMSESP::cmd_is_readonly(device_type, device_id, cmd, id)) {
+            if (!single_command && EMSESP::cmd_is_readonly(device_type, device_id, cmd, id)) {
                 return_code = CommandRet::INVALID; // readonly or invalid hc
             } else {
                 return_code = ((cf->cmdfunction_)(value, id)) ? CommandRet::OK : CommandRet::ERROR;
@@ -593,7 +598,7 @@ void Command::show_devices(uuid::console::Shell & shell) {
 // output list of all commands to console
 // calls show with verbose mode set
 void Command::show_all(uuid::console::Shell & shell) {
-    shell.println("Available commands (*=do not need authorization): ");
+    shell.println("Available commands (*=authorization not required): ");
 
     // show system first
     shell.print(COLOR_BOLD_ON);

src/console.cpp

@@ -137,6 +137,9 @@ static void setup_commands(std::shared_ptr<Commands> & commands) {
                                   Test::run_test(shell, arguments[0].c_str(), arguments[1].c_str());
                               }
                           });
+    commands->add_command(ShellContext::MAIN, CommandFlags::USER, string_vector{"t"}, [=](Shell & shell, const std::vector<std::string> & arguments) {
+        Test::run_test(shell, "default");
+    });
 #endif
 
     commands->add_command(ShellContext::MAIN, CommandFlags::USER, string_vector{F_(su)}, [=](Shell & shell, const std::vector<std::string> & arguments) {
@@ -419,7 +422,6 @@ static void setup_commands(std::shared_ptr<Commands> & commands) {
                                   to_app(shell).send_read_request(type_id, device_id, 0, EMS_MAX_TELEGRAM_LENGTH, true);
                               }
                               to_app(shell).set_read_id(type_id);
-
                           });
 
     commands->add_command(ShellContext::MAIN,

src/devices/boiler.cpp

@@ -2131,6 +2131,7 @@ bool Boiler::set_tapwarmwater_activated(const char * value, const int8_t id) {
         wwTapActivated_ = 1;
     }
 
+    // LOG_INFO("calling EMS_TYPE_UBAFunctionTest with %d", v);
     write_command(EMS_TYPE_UBAFunctionTest, 0, message_data, sizeof(message_data), 0);
 
     return true;

src/locale_common.h

@@ -80,6 +80,7 @@ MAKE_WORD(info)
 MAKE_WORD(settings)
 MAKE_WORD(value)
 MAKE_WORD(entities)
+MAKE_WORD(coldshot)
 
 // device types - lowercase, used in MQTT
 MAKE_WORD(boiler)

src/locale_translations.h

@@ -70,6 +70,7 @@ MAKE_WORD_TRANSLATION(system_info_cmd, "show system status", "Zeige System-Statu
 MAKE_WORD_TRANSLATION(schedule_cmd, "enable schedule item", "Aktiviere Zeitplan", "activeer tijdschema item", "", "aktywuj wybrany harmonogram", "", "", "program öğesini etkinleştir", "abilitare l'elemento programmato") // TODO translate
 MAKE_WORD_TRANSLATION(entity_cmd, "set custom value on ems", "Sende eigene Entitäten zu EMS", "verstuur custom waarde naar EMS", "", "wyślij własną wartość na EMS", "", "", "", "imposta valori personalizzati su EMS") // TODO translate
 MAKE_WORD_TRANSLATION(commands_response, "get response", "Hole Antwort", "Verzoek om antwoord", "", "", "", "", "") // TODO translate
+MAKE_WORD_TRANSLATION(coldshot_cmd, "send a cold shot of water", "", "", "", "", "", "", "", "") // TODO translate
 
 // tags
 MAKE_WORD_TRANSLATION(tag_boiler_data_ww, "dhw", "WW", "dhw", "VV", "CWU", "dhw", "ecs", "SKS", "dhw")

src/mqtt.cpp

@@ -278,9 +278,13 @@ void Mqtt::on_message(const char * topic, const uint8_t * payload, size_t len) c
     if (return_code != CommandRet::OK) {
         char error[100];
         if (output.size()) {
-            snprintf(error, sizeof(error), "Call failed with error: %s (%s)", (const char *)output["message"], Command::return_code_string(return_code).c_str());
+            snprintf(error,
+                     sizeof(error),
+                     "MQTT command failed with error: %s (%s)",
+                     (const char *)output["message"],
+                     Command::return_code_string(return_code).c_str());
         } else {
-            snprintf(error, sizeof(error), "Call failed with error code (%s)", Command::return_code_string(return_code).c_str());
+            snprintf(error, sizeof(error), "MQTT command failed with error code (%s)", Command::return_code_string(return_code).c_str());
         }
         LOG_ERROR(error);
         Mqtt::queue_publish("response", error);

src/shower.cpp

@@ -22,6 +22,8 @@ namespace emsesp {
 
 uuid::log::Logger Shower::logger_{F_(shower), uuid::log::Facility::CONSOLE};
 
+static bool force_coldshot = false;
+
 void Shower::start() {
     EMSESP::webSettingsService.read([&](WebSettings & settings) {
         shower_timer_          = settings.shower_timer;
@@ -30,8 +32,28 @@ void Shower::start() {
         shower_alert_coldshot_ = settings.shower_alert_coldshot * 1000; // convert from seconds
     });
 
+    Command::add(
+        EMSdevice::DeviceType::BOILER,
+        F_(coldshot),
+        [&](const char * value, const int8_t id, JsonObject & output) {
+            LOG_INFO("Forcing coldshot...");
+            if (shower_state_) {
+                output["message"] = "OK";
+                force_coldshot    = true;
+            } else {
+                output["message"] = "Coldshot failed. Shower not active";
+                LOG_WARNING("Coldshot failed. Shower not active");
+                force_coldshot = false;
+            }
+            return true;
+        },
+        FL_(coldshot_cmd),
+        CommandFlag::ADMIN_ONLY);
+
+    if (shower_timer_) {
         set_shower_state(false, true); // turns shower to off and creates HA topic if not already done
     }
+}
 
 void Shower::loop() {
     if (!shower_timer_) {
@@ -57,10 +79,10 @@ void Shower::loop() {
                 // first check to see if hot water has been on long enough to be recognized as a Shower/Bath
                 if (!shower_state_ && (time_now - timer_start_) > SHOWER_MIN_DURATION) {
                     set_shower_state(true);
-                    LOG_DEBUG("[Shower] hot water still running, starting shower timer");
+                    LOG_DEBUG("hot water still running, starting shower timer");
                 }
                 // check if the shower has been on too long
-                else if ((time_now - timer_start_) > shower_alert_trigger_) {
+                else if ((shower_alert_ && ((time_now - timer_start_) > shower_alert_trigger_)) || force_coldshot) {
                     shower_alert_start();
                 }
             }
@@ -79,11 +101,11 @@ void Shower::loop() {
                     if (duration_ > SHOWER_MIN_DURATION) {
                         StaticJsonDocument<EMSESP_JSON_SIZE_SMALL> doc;
 
-                        char s[50];
+                        // char s[50];
-                        snprintf(s, 50, "%d minutes and %d seconds", (uint8_t)(duration_ / 60000), (uint8_t)((duration_ / 1000) % 60));
+                        // snprintf(s, 50, "%02u:%02u:%02u", (uint8_t)(duration_ / 3600000UL), (uint8_t)(duration_ / 60000UL), (uint8_t)((duration_ / 1000UL) % 60));
-                        doc["duration"] = s;
+                        doc["duration"] = (uint8_t)(duration_ / 1000UL); // seconds
                         Mqtt::queue_publish("shower_data", doc.as<JsonObject>());
-                        LOG_DEBUG("[Shower] finished with duration %d", duration_);
+                        LOG_INFO("finished with duration %d", duration_);
                     }
                 }
 
@@ -106,21 +128,22 @@ void Shower::loop() {
     }
 }
 
+// turn off hot water to send a shot of cold
+void Shower::shower_alert_start() {
+    LOG_DEBUG("Shower Alert started");
+    (void)Command::call(EMSdevice::DeviceType::BOILER, "wwtapactivated", "false");
+    doing_cold_shot_   = true;
+    force_coldshot     = false;
+    alert_timer_start_ = uuid::get_uptime(); // timer starts now
+}
+
 // turn back on the hot water for the shower
 void Shower::shower_alert_stop() {
     if (doing_cold_shot_) {
         LOG_DEBUG("Shower Alert stopped");
         (void)Command::call(EMSdevice::DeviceType::BOILER, "wwtapactivated", "true");
         doing_cold_shot_ = false;
-    }
+        force_coldshot   = false;
-}
-// turn off hot water to send a shot of cold
-void Shower::shower_alert_start() {
-    if (shower_alert_) {
-        LOG_DEBUG("Shower Alert started");
-        (void)Command::call(EMSdevice::DeviceType::BOILER, "wwtapactivated", "false");
-        doing_cold_shot_   = true;
-        alert_timer_start_ = uuid::get_uptime(); // timer starts now
     }
 }
 
@@ -128,15 +151,11 @@ void Shower::shower_alert_start() {
 // and creates the HA config topic if HA enabled
 // force is used by EMSESP::publish_all_loop()
 void Shower::set_shower_state(bool state, bool force) {
-    if (!shower_timer_ && !shower_alert_) {
-        return;
-    }
-
     // sets the state
     shower_state_ = state;
 
     // only publish if that state has changed
-    static bool old_shower_state_;
+    static bool old_shower_state_ = false;
     if ((shower_state_ == old_shower_state_) && !force) {
         return;
     }
@@ -149,10 +168,15 @@ void Shower::set_shower_state(bool state, bool force) {
     // send out HA MQTT Discovery config topic
     if ((Mqtt::ha_enabled()) && (!ha_configdone_ || force)) {
         StaticJsonDocument<EMSESP_JSON_SIZE_LARGE> doc;
+        char                                       topic[Mqtt::MQTT_TOPIC_MAX_SIZE];
+        char                                       str[70];
+        char                                       stat_t[50];
 
+        //
+        // shower_active topic
+        //
         doc["name"] = "Shower Active";
 
-        char str[70];
         if (Mqtt::entity_format() == Mqtt::entityFormat::MULTI_SHORT) {
             snprintf(str, sizeof(str), "%s_shower_active", Mqtt::basename().c_str());
         } else {
@@ -161,7 +185,6 @@ void Shower::set_shower_state(bool state, bool force) {
         doc["uniq_id"]   = str;
         doc["object_id"] = str;
 
-        char stat_t[50];
         snprintf(stat_t, sizeof(stat_t), "%s/shower_active", Mqtt::basename().c_str());
         doc["stat_t"] = stat_t;
 
@@ -181,13 +204,39 @@ void Shower::set_shower_state(bool state, bool force) {
         JsonArray  ids = dev.createNestedArray("ids");
         ids.add(Mqtt::basename());
 
-        // add "availability" section
+        Mqtt::add_avty_to_doc(stat_t, doc.as<JsonObject>()); // add "availability" section
-        Mqtt::add_avty_to_doc(stat_t, doc.as<JsonObject>());
 
-        char topic[Mqtt::MQTT_TOPIC_MAX_SIZE];
         snprintf(topic, sizeof(topic), "binary_sensor/%s/shower_active/config", Mqtt::basename().c_str());
-
         ha_configdone_ = Mqtt::queue_ha(topic, doc.as<JsonObject>()); // publish the config payload with retain flag
+
+        //
+        // shower_duaration topic
+        //
+        doc.clear();
+
+        snprintf(str, sizeof(str), "%s_shower_duration", Mqtt::basename().c_str());
+
+        doc["uniq_id"]   = str;
+        doc["object_id"] = str;
+
+        snprintf(stat_t, sizeof(stat_t), "%s/shower_data", Mqtt::basename().c_str());
+        doc["stat_t"] = stat_t;
+
+        doc["name"]         = "Shower Duration";
+        doc["val_tpl"]      = "{{value_json.duration if value_json.duration is defined else 0}}";
+        doc["unit_of_meas"] = "s";
+        doc["stat_cla"]     = "measurement";
+        doc["dev_cla"]      = "duration";
+        doc["ent_cat"]      = "diagnostic";
+
+        JsonObject dev2 = doc.createNestedObject("dev");
+        JsonArray  ids2 = dev2.createNestedArray("ids");
+        ids2.add(Mqtt::basename());
+
+        Mqtt::add_avty_to_doc(stat_t, doc.as<JsonObject>(), "value_json.duration is defined"); // add "availability" section
+
+        snprintf(topic, sizeof(topic), "sensor/%s/shower_duration/config", Mqtt::basename().c_str());
+        Mqtt::queue_ha(topic, doc.as<JsonObject>()); // publish the config payload with retain flag
     }
 }
 

src/shower.h

@@ -30,6 +30,9 @@ class Shower {
 
     void set_shower_state(bool state, bool force = false);
 
+    // commands
+    static bool command_coldshot(const char * value, const int8_t id);
+
   private:
     static uuid::log::Logger logger_;
 

src/test/test.cpp

@@ -266,7 +266,7 @@ void Test::run_test(uuid::console::Shell & shell, const std::string & cmd, const
         shell.printfln("Testing adding a general boiler & thermostat...");
         run_test("general");
         // shell.invoke_command("show devices");
-        // shell.invoke_command("show values");
+        shell.invoke_command("show values");
         shell.invoke_command("call system publish");
         // shell.invoke_command("show mqtt");
         ok = true;
@@ -280,6 +280,21 @@ void Test::run_test(uuid::console::Shell & shell, const std::string & cmd, const
         ok = true;
     }
 
+    if (command == "coldshot") {
+        shell.printfln("Testing coldshot...");
+        run_test("general");
+
+#ifdef EMSESP_STANDALONE
+        AsyncWebServerRequest request;
+        request.method(HTTP_GET);
+        request.url("/api/boiler/coldshot");
+        EMSESP::webAPIService.webAPIService_get(&request);
+#else
+        shell.invoke_command("call boiler coldshot");
+#endif
+        ok = true;
+    }
+
     if (command == "string2minutes") {
         shell.printfln("Testing string2minutes()...");
         std::string time_s = "12:00";

src/test/test.h

@@ -26,11 +26,12 @@
 
 namespace emsesp {
 
+// #define EMSESP_DEBUG_DEFAULT "general"
+
 // #define EMSESP_DEBUG_DEFAULT "thermostat"
 // #define EMSESP_DEBUG_DEFAULT "solar"
 // #define EMSESP_DEBUG_DEFAULT "web"
 // #define EMSESP_DEBUG_DEFAULT "mqtt"
-#define EMSESP_DEBUG_DEFAULT "general"
 // #define EMSESP_DEBUG_DEFAULT "boiler"
 // #define EMSESP_DEBUG_DEFAULT "mqtt2"
 // #define EMSESP_DEBUG_DEFAULT "mqtt_nested"
@@ -53,6 +54,7 @@ namespace emsesp {
 // #define EMSESP_DEBUG_DEFAULT "custom"
 // #define EMSESP_DEBUG_DEFAULT "entity_dump"
 // #define EMSESP_DEBUG_DEFAULT "memory"
+#define EMSESP_DEBUG_DEFAULT "coldshot"
 
 class Test {
   public:

src/version.h

@@ -1 +1 @@
-#define EMSESP_APP_VERSION "3.7.0-dev.1c"
+#define EMSESP_APP_VERSION "3.7.0-dev.1"

src/web/WebAPIService.cpp

@@ -121,9 +121,9 @@ void WebAPIService::parse(AsyncWebServerRequest * request, JsonObject & input) {
     if (return_code != CommandRet::OK) {
         char error[100];
         if (output.size()) {
-            snprintf(error, sizeof(error), "Call failed with error: %s (%s)", (const char *)output["message"], Command::return_code_string(return_code).c_str());
+            snprintf(error, sizeof(error), "API failed with error: %s (%s)", (const char *)output["message"], Command::return_code_string(return_code).c_str());
         } else {
-            snprintf(error, sizeof(error), "Call failed with error code (%s)", Command::return_code_string(return_code).c_str());
+            snprintf(error, sizeof(error), "API failed with error code (%s)", Command::return_code_string(return_code).c_str());
         }
         emsesp::EMSESP::logger().err(error);
         api_fails_++;

src/web/WebEntityService.cpp

@@ -219,8 +219,8 @@ bool WebEntityService::get_value_info(JsonObject & output, const char * cmd) {
         return false;
     }
     if (Helpers::toLower(cmd) == "commands") {
-        output["info"]     = "lists all values";
+        output["info"]     = "list all values";
-        output["commands"] = "lists all commands";
+        output["commands"] = "list all commands";
         for (const auto & entity : *entityItems) {
             output[entity.name] = "custom entitiy";
         }