URL updates

src/locale_translations.h

@@ -75,7 +75,7 @@ MAKE_WORD_TRANSLATION(schedule_cmd, "enable schedule item", "Aktiviere Zeitplane
 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", "", "", "emp üzerinde özel değer ayarla", "imposta valori personalizzati su EMS", "nastaviť vlastnú hodnotu na ems") // TODO translate
 MAKE_WORD_TRANSLATION(commands_response, "get response", "Hole Antwort", "Verzoek om antwoord", "", "uzyskaj odpowiedź", "", "", "gelen cevap", "", "získať odpoveď") // TODO translate
 MAKE_WORD_TRANSLATION(coldshot_cmd, "send a cold shot of water", "Zugabe einer Menge kalten Wassers", "", "", "uruchom tryśnięcie zimnej wody", "", "", "soğuk su gönder", "", "pošlite studenú dávku vody") // TODO translate
-MAKE_WORD_TRANSLATION(allvalues_cmd, "output all values in system", "Alle Werte im System ausgeben", "", "", "wyświetl wszystkie wartości", "", "", "", "", "vypísať všetky hodnoty") // TODO translate
+MAKE_WORD_TRANSLATION(allvalues_cmd, "output all values in system", "Alle Werte im System ausgeben", "", "", "wyświetl wszystkie wartości", "", "", "", "", "vypísať všetky hodnoty") // TODO remove
 MAKE_WORD_TRANSLATION(message_cmd, "send a message", "Eine Nachricht senden", "", "", "", "", "", "", "", "poslať správu") // TODO translate
 MAKE_WORD_TRANSLATION(values_cmd, "list all values", "Liste alle Werte auf", "", "", "", "", "", "", "", "vypísať všetky hodnoty") // TODO translate
 

src/system.cpp

@@ -113,6 +113,7 @@ bool System::command_response(const char * value, const int8_t id, JsonObject ou
 
 // output all the devices and the values
 // not system info
+// TODO remove?
 bool System::command_allvalues(const char * value, const int8_t id, JsonObject output) {
     JsonDocument doc;
     JsonObject   device_output;
@@ -874,7 +875,7 @@ void System::commands_init() {
 
     // these commands will return data in JSON format
     Command::add(EMSdevice::DeviceType::SYSTEM, F("response"), System::command_response, FL_(commands_response));
-    Command::add(EMSdevice::DeviceType::SYSTEM, F("allvalues"), System::command_allvalues, FL_(allvalues_cmd));
+    Command::add(EMSdevice::DeviceType::SYSTEM, F("allvalues"), System::command_allvalues, FL_(allvalues_cmd)); // TODO remove
 
     // MQTT subscribe "ems-esp/system/#"
     Mqtt::subscribe(EMSdevice::DeviceType::SYSTEM, "system/#", nullptr); // use empty function callback
@@ -1139,7 +1140,7 @@ void System::show_system(uuid::console::Shell & shell) {
 
 // see if there is a restore of an older settings file that needs to be applied
 bool System::check_restore() {
-    bool reboot_required = false;
+    bool reboot_required = false; // true if we need to reboot
 
 #ifndef EMSESP_STANDALONE
     File new_file = LittleFS.open(TEMP_FILENAME_PATH);
@@ -1167,11 +1168,20 @@ bool System::check_restore() {
             } else if (settings_type == "entities") {
                 // it's a entity file, just replace it and there's no need to reboot
                 saveSettings(EMSESP_CUSTOMENTITY_FILE, "Entities", input);
+            } else if (settings_type == "custom_support") {
+                // it's a custom support file - save it to /config
+                new_file.close();
+                if (LittleFS.rename(TEMP_FILENAME_PATH, EMSESP_CUSTOMSUPPORT_FILE)) {
+                    LOG_INFO("Custom support information loaded");
+                    return false; // no need to reboot
+                } else {
+                    LOG_ERROR("Failed to save custom support file");
+                }
             } else {
                 LOG_ERROR("Unrecognized file uploaded");
             }
         } else {
-            LOG_ERROR("Unrecognized file uploaded, not json. Will be removed.");
+            LOG_ERROR("Unrecognized file uploaded, not json.");
         }
 
         // close (just in case) and remove the temp file

src/system.h

@@ -43,6 +43,8 @@ using uuid::console::Shell;
 
 #define EMSESP_FS_CONFIG_DIRECTORY "/config"
 
+#define EMSESP_CUSTOMSUPPORT_FILE "/config/customSupport.json"
+
 namespace emsesp {
 
 enum PHY_type : uint8_t { PHY_TYPE_NONE = 0, PHY_TYPE_LAN8720, PHY_TYPE_TLK110 };
@@ -63,7 +65,7 @@ class System {
     static bool command_message(const char * value, const int8_t id);
     static bool command_info(const char * value, const int8_t id, JsonObject output);
     static bool command_response(const char * value, const int8_t id, JsonObject output);
-    static bool command_allvalues(const char * value, const int8_t id, JsonObject output);
+    static bool command_allvalues(const char * value, const int8_t id, JsonObject output); // TODO fix
 
     static bool get_value_info(JsonObject root, const char * cmd);
     static void get_value_json(JsonObject output, const std::string & circuit, const std::string & name, JsonVariant val);

src/test/test.cpp

@@ -327,7 +327,6 @@ void Test::run_test(uuid::console::Shell & shell, const std::string & cmd, const
 
         // shell.invoke_command("show devices");
         // shell.invoke_command("show values");
-        // shell.invoke_command("call system allvalues");
         // shell.invoke_command("call system publish");
         // shell.invoke_command("show mqtt");
         ok = true;
@@ -792,7 +791,6 @@ void Test::run_test(uuid::console::Shell & shell, const std::string & cmd, const
 
         shell.invoke_command("call temperaturesensor");
         shell.invoke_command("show values");
-        shell.invoke_command("call system allvalues");
         shell.invoke_command("call temperaturesensor info");
         shell.invoke_command("call temperaturesensor values");
 
@@ -842,7 +840,6 @@ void Test::run_test(uuid::console::Shell & shell, const std::string & cmd, const
 
         shell.invoke_command("call analogsensor");
         shell.invoke_command("show values");
-        shell.invoke_command("call system allvalues");
         shell.invoke_command("call analogsensor info");
         shell.invoke_command("call analogsensor values");
 

src/web/WebCustomEntityService.cpp

@@ -463,7 +463,6 @@ uint8_t WebCustomEntityService::count_entities() {
     uint8_t      count  = 0;
     for (const CustomEntityItem & entity : *customEntityItems_) {
         render_value(output, entity);
-        // TODO check JsonVariant
         if (output[entity.name].is<JsonVariantConst>() || entity.writeable) {
             count++;
         }

src/web/WebStatusService.cpp

@@ -27,10 +27,9 @@ namespace emsesp {
 WebStatusService::WebStatusService(AsyncWebServer * server, SecurityManager * securityManager) {
     // GET
     server->on(EMSESP_SYSTEM_STATUS_SERVICE_PATH, HTTP_GET, [this](AsyncWebServerRequest * request) { systemStatus(request); });
-    server->on(EMSESP_EXPORT_DATA_SERVICE_PATH, HTTP_GET, [this](AsyncWebServerRequest * request) { exportData(request); });
 
-    // POST
-    server->on(EMSESP_CHECK_UPGRADE_PATH, [this](AsyncWebServerRequest * request, JsonVariant json) { checkUpgrade(request, json); });
+    // generic action - POST
+    server->on(EMSESP_ACTION_SERVICE_PATH, [this](AsyncWebServerRequest * request, JsonVariant json) { action(request, json); });
 }
 
 // /rest/systemStatus
@@ -146,13 +145,42 @@ void WebStatusService::systemStatus(AsyncWebServerRequest * request) {
     request->send(response);
 }
 
-// returns trues if there is an upgrade available
-void WebStatusService::checkUpgrade(AsyncWebServerRequest * request, JsonVariant json) {
+// generic action handler - as a POST
+void WebStatusService::action(AsyncWebServerRequest * request, JsonVariant json) {
     auto *     response = new AsyncJsonResponse();
     JsonObject root     = response->getRoot();
 
+    // get action and optional param
+    std::string action = json["action"];
+    std::string param  = json["param"]; // is optional
+
+    // TODO remove
+    Serial.printf("Action: %s\n", action.c_str());
+    Serial.printf("Param: %s\n", param.c_str());
+
+    bool ok = true;
+    if (action == "checkUpgrade") {
+        ok = checkUpgrade(root, param);
+    } else if (action == "export") {
+        ok = exportData(root, param);
+    } else if (action == "customSupport") {
+        ok = customSupport(root);
+    }
+
+    // send response
+    if (!ok) {
+        request->send(400);
+        return;
+    }
+
+    response->setLength();
+    request->send(response);
+}
+
+
+// returns true if there is an upgrade available
+bool WebStatusService::checkUpgrade(JsonObject root, std::string & latest_version) {
     version::Semver200_version settings_version(EMSESP_APP_VERSION);
-    const std::string          latest_version = json["version"] | EMSESP_APP_VERSION;
     version::Semver200_version this_version(latest_version);
 
 #if defined(EMSESP_DEBUG)
@@ -161,16 +189,11 @@ void WebStatusService::checkUpgrade(AsyncWebServerRequest * request, JsonVariant
 
     root["upgradeable"] = (this_version > settings_version);
 
-    response->setLength();
-    request->send(response);
+    return true;
 }
 
 // returns data for a specific feature/settings as a json object
-void WebStatusService::exportData(AsyncWebServerRequest * request) {
-    auto *     response = new AsyncJsonResponse();
-    JsonObject root     = response->getRoot();
-
-    String type  = request->getParam("type")->value();
+bool WebStatusService::exportData(JsonObject root, std::string & type) {
     root["type"] = type;
 
     if (type == "settings") {
@@ -189,12 +212,15 @@ void WebStatusService::exportData(AsyncWebServerRequest * request) {
     } else if (type == "entities") {
         System::extractSettings(EMSESP_CUSTOMENTITY_FILE, "Entities", root);
     } else {
-        request->send(400);
-        return;
+        return false;
     }
+    return true;
+}
 
-    response->setLength();
-    request->send(response);
+// custom support
+bool WebStatusService::customSupport(JsonObject root) {
+    root["custom_support"] = true;
+    return true;
 }
 
 } // namespace emsesp

src/web/WebStatusService.h

@@ -2,8 +2,8 @@
 #define WebStatusService_h
 
 #define EMSESP_SYSTEM_STATUS_SERVICE_PATH "/rest/systemStatus"
-#define EMSESP_CHECK_UPGRADE_PATH "/rest/checkUpgrade"
-#define EMSESP_EXPORT_DATA_SERVICE_PATH "/rest/exportData"
+
+#define EMSESP_ACTION_SERVICE_PATH "/rest/action"
 
 #include <semver200.h> // for version checking
 
@@ -13,10 +13,14 @@ class WebStatusService {
   public:
     WebStatusService(AsyncWebServer * server, SecurityManager * securityManager);
 
-  private:
+  protected:
     void systemStatus(AsyncWebServerRequest * request);
-    void checkUpgrade(AsyncWebServerRequest * request, JsonVariant json);
-    void exportData(AsyncWebServerRequest * request);
+    void action(AsyncWebServerRequest * request, JsonVariant json);
+
+  private:
+    bool checkUpgrade(JsonObject root, std::string & latest_version);
+    bool exportData(JsonObject root, std::string & type);
+    bool customSupport(JsonObject root);
 };
 
 } // namespace emsesp