Allow topic registration with empty entity-id. HA discovery topic and…

… id's generation is like the following patterns: DISCOVERY-TOPIC = DISCOVERY-PREFIX/COMPONENT/NODE-ID/OBJECT-ID/config NODE-ID = DEVICE-ID with "/" and "." replaced by "_" OBJECT-ID = [ENTITY-ID/]TOPIC with "/" and "." replaced by "_" UNIQUE-ID = DEVICE-ID/[ENTITY-ID/]TOPIC
BlueAndi · Jan 6, 2025 · e643180 · e643180
1 parent 2628967
commit e643180
Show file tree

Hide file tree

Showing 45 changed files with 351 additions and 272 deletions.
diff --git a/data/js/rest.js b/data/js/rest.js
@@ -232,7 +232,7 @@ pixelix.rest.Client.prototype.setSetting = function(key, value) {
 pixelix.rest.Client.prototype.restart = function() {
     return utils.makeRequest({
         method: "POST",
-        url: "/rest/api/v1/device/restart",
+        url: "/rest/api/v1/restart",
         isJsonResponse: true
     });
 };

diff --git a/lib/CountdownPlugin/src/CountdownPlugin.cpp b/lib/CountdownPlugin/src/CountdownPlugin.cpp
@@ -59,7 +59,7 @@
  *****************************************************************************/
 
 /* Initialize plugin topic. */
-const char* CountdownPlugin::TOPIC_CONFIG   = "/countdown";
+const char* CountdownPlugin::TOPIC_CONFIG   = "countdown";
 
 /******************************************************************************
  * Public Methods

diff --git a/lib/CountdownPlugin/src/CountdownPlugin.h b/lib/CountdownPlugin/src/CountdownPlugin.h
@@ -251,7 +251,7 @@ class CountdownPlugin : public PluginWithConfig
      * <code>{.json}
      * {
      *     "topics": [
-     *         "/text"
+     *         "text"
      *     ]
      * }
      * </code>
@@ -267,7 +267,7 @@ class CountdownPlugin : public PluginWithConfig
      * <code>{.json}
      * {
      *     "topics": [{
-     *         "name": "/text",
+     *         "name": "text",
      *         "access": "r"
      *     }]
      * }
@@ -278,7 +278,7 @@ class CountdownPlugin : public PluginWithConfig
      * <code>{.json}
      * {
      *     "topics": [{
-     *         "name": "/text",
+     *         "name": "text",
      *         "extra": {
      *             "ha": {
      *                 ... everything here will be used for MQTT discovery ...
@@ -293,7 +293,7 @@ class CountdownPlugin : public PluginWithConfig
      * <code>{.json}
      * {
      *     "topics": [{
-     *         "name": "/text",
+     *         "name": "text",
      *         "extra": "extra.json"
      *    }]
      * }

diff --git a/lib/DateTimePlugin/src/DateTimePlugin.cpp b/lib/DateTimePlugin/src/DateTimePlugin.cpp
@@ -59,7 +59,7 @@
  *****************************************************************************/
 
 /* Initialize plugin topic. */
-const char DateTimePlugin::TOPIC_CONFIG[]        = "/dateTime";
+const char DateTimePlugin::TOPIC_CONFIG[]        = "dateTime";
 
 /* Initialize default time format. */
 const char DateTimePlugin::TIME_FORMAT_DEFAULT[] = "%I:%M %p";

diff --git a/lib/DateTimePlugin/src/DateTimePlugin.h b/lib/DateTimePlugin/src/DateTimePlugin.h
@@ -144,7 +144,7 @@ class DateTimePlugin : public PluginWithConfig
      * <code>{.json}
      * {
      *     "topics": [
-     *         "/text"
+     *         "text"
      *     ]
      * }
      * </code>
@@ -160,7 +160,7 @@ class DateTimePlugin : public PluginWithConfig
      * <code>{.json}
      * {
      *     "topics": [{
-     *         "name": "/text",
+     *         "name": "text",
      *         "access": "r"
      *     }]
      * }
@@ -171,7 +171,7 @@ class DateTimePlugin : public PluginWithConfig
      * <code>{.json}
      * {
      *     "topics": [{
-     *         "name": "/text",
+     *         "name": "text",
      *         "extra": {
      *             "ha": {
      *                 ... everything here will be used for MQTT discovery ...
@@ -186,7 +186,7 @@ class DateTimePlugin : public PluginWithConfig
      * <code>{.json}
      * {
      *     "topics": [{
-     *         "name": "/text",
+     *         "name": "text",
      *         "extra": "extra.json"
      *    }]
      * }

diff --git a/lib/FileMgrService/src/FileMgrService.cpp b/lib/FileMgrService/src/FileMgrService.cpp
@@ -65,8 +65,8 @@
 const char* FileMgrService::WORKING_DIRECTORY   = "/configuration";
 const char* FileMgrService::CONFIG_FILE_NAME    = "fileMgr.json";
 const char* FileMgrService::ENTITY_ID           = "files";
-const char* FileMgrService::TOPIC_UPLOAD        = "/upload";
-const char* FileMgrService::TOPIC_REMOVE        = "/remove";
+const char* FileMgrService::TOPIC_UPLOAD        = "upload";
+const char* FileMgrService::TOPIC_REMOVE        = "remove";
 const char* FileMgrService::FILE_EXTENSIONS[]   =
 {
     ".bmp",

diff --git a/lib/GrabViaMqttPlugin/src/GrabViaMqttPlugin.cpp b/lib/GrabViaMqttPlugin/src/GrabViaMqttPlugin.cpp
@@ -59,7 +59,7 @@
  *****************************************************************************/
 
 /* Initialize plugin topic. */
-const char* GrabViaMqttPlugin::TOPIC_CONFIG = "/grabConfig";
+const char* GrabViaMqttPlugin::TOPIC_CONFIG = "grabConfig";
 
 /******************************************************************************
  * Public Methods

diff --git a/lib/GrabViaMqttPlugin/src/GrabViaMqttPlugin.h b/lib/GrabViaMqttPlugin/src/GrabViaMqttPlugin.h
@@ -140,7 +140,7 @@ class GrabViaMqttPlugin : public PluginWithConfig
      * <code>{.json}
      * {
      *     "topics": [
-     *         "/text"
+     *         "text"
      *     ]
      * }
      * </code>
@@ -156,7 +156,7 @@ class GrabViaMqttPlugin : public PluginWithConfig
      * <code>{.json}
      * {
      *     "topics": [{
-     *         "name": "/text",
+     *         "name": "text",
      *         "access": "r"
      *     }]
      * }
@@ -167,7 +167,7 @@ class GrabViaMqttPlugin : public PluginWithConfig
      * <code>{.json}
      * {
      *     "topics": [{
-     *         "name": "/text",
+     *         "name": "text",
      *         "extra": {
      *             "ha": {
      *                 ... everything here will be used for MQTT discovery ...
@@ -182,7 +182,7 @@ class GrabViaMqttPlugin : public PluginWithConfig
      * <code>{.json}
      * {
      *     "topics": [{
-     *         "name": "/text",
+     *         "name": "text",
      *         "extra": "extra.json"
      *    }]
      * }

diff --git a/lib/GrabViaRestPlugin/src/GrabViaRestPlugin.cpp b/lib/GrabViaRestPlugin/src/GrabViaRestPlugin.cpp
@@ -59,7 +59,7 @@
  *****************************************************************************/
 
 /* Initialize plugin topic. */
-const char* GrabViaRestPlugin::TOPIC_CONFIG = "/grabConfig";
+const char* GrabViaRestPlugin::TOPIC_CONFIG = "grabConfig";
 
 /******************************************************************************
  * Public Methods

diff --git a/lib/GrabViaRestPlugin/src/GrabViaRestPlugin.h b/lib/GrabViaRestPlugin/src/GrabViaRestPlugin.h
@@ -158,7 +158,7 @@ class GrabViaRestPlugin : public PluginWithConfig
      * <code>{.json}
      * {
      *     "topics": [
-     *         "/text"
+     *         "text"
      *     ]
      * }
      * </code>
@@ -174,7 +174,7 @@ class GrabViaRestPlugin : public PluginWithConfig
      * <code>{.json}
      * {
      *     "topics": [{
-     *         "name": "/text",
+     *         "name": "text",
      *         "access": "r"
      *     }]
      * }
@@ -185,7 +185,7 @@ class GrabViaRestPlugin : public PluginWithConfig
      * <code>{.json}
      * {
      *     "topics": [{
-     *         "name": "/text",
+     *         "name": "text",
      *         "extra": {
      *             "ha": {
      *                 ... everything here will be used for MQTT discovery ...
@@ -200,7 +200,7 @@ class GrabViaRestPlugin : public PluginWithConfig
      * <code>{.json}
      * {
      *     "topics": [{
-     *         "name": "/text",
+     *         "name": "text",
      *         "extra": "extra.json"
      *    }]
      * }

diff --git a/lib/GruenbeckPlugin/src/GruenbeckPlugin.cpp b/lib/GruenbeckPlugin/src/GruenbeckPlugin.cpp
@@ -60,7 +60,7 @@
  *****************************************************************************/
 
 /* Initialize plugin topic. */
-const char* GruenbeckPlugin::TOPIC_CONFIG   = "/ipAddress";
+const char* GruenbeckPlugin::TOPIC_CONFIG   = "ipAddress";
 
 /******************************************************************************
  * Public Methods

diff --git a/lib/GruenbeckPlugin/src/GruenbeckPlugin.h b/lib/GruenbeckPlugin/src/GruenbeckPlugin.h
@@ -153,7 +153,7 @@ class GruenbeckPlugin : public PluginWithConfig
      * <code>{.json}
      * {
      *     "topics": [
-     *         "/text"
+     *         "text"
      *     ]
      * }
      * </code>
@@ -169,7 +169,7 @@ class GruenbeckPlugin : public PluginWithConfig
      * <code>{.json}
      * {
      *     "topics": [{
-     *         "name": "/text",
+     *         "name": "text",
      *         "access": "r"
      *     }]
      * }
@@ -180,7 +180,7 @@ class GruenbeckPlugin : public PluginWithConfig
      * <code>{.json}
      * {
      *     "topics": [{
-     *         "name": "/text",
+     *         "name": "text",
      *         "extra": {
      *             "ha": {
      *                 ... everything here will be used for MQTT discovery ...
@@ -195,7 +195,7 @@ class GruenbeckPlugin : public PluginWithConfig
      * <code>{.json}
      * {
      *     "topics": [{
-     *         "name": "/text",
+     *         "name": "text",
      *         "extra": "extra.json"
      *    }]
      * }

diff --git a/lib/IconTextLampPlugin/src/IconTextLampPlugin.cpp b/lib/IconTextLampPlugin/src/IconTextLampPlugin.cpp
@@ -59,14 +59,14 @@
  *****************************************************************************/
 
 /* Initialize plugin topic. */
-const char* IconTextLampPlugin::TOPIC_TEXT                 = "/iconText";
+const char* IconTextLampPlugin::TOPIC_TEXT                 = "iconText";
 const char* IconTextLampPlugin::TOPIC_TEXT_EXTRA_FILE_NAME = "/extra/iconTextLampPlugin.json";
 
 /* Initialize plugin topic. */
-const char* IconTextLampPlugin::TOPIC_LAMPS                = "/lamps";
+const char* IconTextLampPlugin::TOPIC_LAMPS                = "lamps";
 
 /* Initialize plugin topic. */
-const char* IconTextLampPlugin::TOPIC_LAMP                 = "/lamp";
+const char* IconTextLampPlugin::TOPIC_LAMP                 = "lamp";
 
 /******************************************************************************
  * Public Methods

diff --git a/lib/IconTextLampPlugin/src/IconTextLampPlugin.h b/lib/IconTextLampPlugin/src/IconTextLampPlugin.h
@@ -117,7 +117,7 @@ class IconTextLampPlugin : public PluginWithConfig
      * <code>{.json}
      * {
      *     "topics": [
-     *         "/text"
+     *         "text"
      *     ]
      * }
      * </code>
@@ -133,7 +133,7 @@ class IconTextLampPlugin : public PluginWithConfig
      * <code>{.json}
      * {
      *     "topics": [{
-     *         "name": "/text",
+     *         "name": "text",
      *         "access": "r"
      *     }]
      * }
@@ -144,7 +144,7 @@ class IconTextLampPlugin : public PluginWithConfig
      * <code>{.json}
      * {
      *     "topics": [{
-     *         "name": "/text",
+     *         "name": "text",
      *         "extra": {
      *             "ha": {
      *                 ... everything here will be used for MQTT discovery ...
@@ -159,7 +159,7 @@ class IconTextLampPlugin : public PluginWithConfig
      * <code>{.json}
      * {
      *     "topics": [{
-     *         "name": "/text",
+     *         "name": "text",
      *         "extra": "extra.json"
      *    }]
      * }

diff --git a/lib/IconTextPlugin/src/IconTextPlugin.cpp b/lib/IconTextPlugin/src/IconTextPlugin.cpp
@@ -59,7 +59,7 @@
  *****************************************************************************/
 
 /* Initialize plugin topic. */
-const char* IconTextPlugin::TOPIC_TEXT                 = "/iconText";
+const char* IconTextPlugin::TOPIC_TEXT                 = "iconText";
 const char* IconTextPlugin::TOPIC_TEXT_EXTRA_FILE_NAME = "/extra/iconTextPlugin.json";
 
 /******************************************************************************

diff --git a/lib/IconTextPlugin/src/IconTextPlugin.h b/lib/IconTextPlugin/src/IconTextPlugin.h
@@ -145,7 +145,7 @@ class IconTextPlugin : public PluginWithConfig
      * <code>{.json}
      * {
      *     "topics": [
-     *         "/text"
+     *         "text"
      *     ]
      * }
      * </code>
@@ -161,7 +161,7 @@ class IconTextPlugin : public PluginWithConfig
      * <code>{.json}
      * {
      *     "topics": [{
-     *         "name": "/text",
+     *         "name": "text",
      *         "access": "r"
      *     }]
      * }
@@ -172,7 +172,7 @@ class IconTextPlugin : public PluginWithConfig
      * <code>{.json}
      * {
      *     "topics": [{
-     *         "name": "/text",
+     *         "name": "text",
      *         "extra": {
      *             "ha": {
      *                 ... everything here will be used for MQTT discovery ...
@@ -187,7 +187,7 @@ class IconTextPlugin : public PluginWithConfig
      * <code>{.json}
      * {
      *     "topics": [{
-     *         "name": "/text",
+     *         "name": "text",
      *         "extra": "extra.json"
      *    }]
      * }

diff --git a/lib/JustTextPlugin/src/JustTextPlugin.cpp b/lib/JustTextPlugin/src/JustTextPlugin.cpp
@@ -58,7 +58,7 @@
  *****************************************************************************/
 
 /* Initialize plugin topic. */
-const char* JustTextPlugin::TOPIC_TEXT                 = "/text";
+const char* JustTextPlugin::TOPIC_TEXT                 = "text";
 const char* JustTextPlugin::TOPIC_TEXT_EXTRA_FILE_NAME = "/extra/justTextPlugin.json";
 
 /******************************************************************************

diff --git a/lib/JustTextPlugin/src/JustTextPlugin.h b/lib/JustTextPlugin/src/JustTextPlugin.h
@@ -142,7 +142,7 @@ class JustTextPlugin : public PluginWithConfig
      * <code>{.json}
      * {
      *     "topics": [
-     *         "/text"
+     *         "text"
      *     ]
      * }
      * </code>
@@ -158,7 +158,7 @@ class JustTextPlugin : public PluginWithConfig
      * <code>{.json}
      * {
      *     "topics": [{
-     *         "name": "/text",
+     *         "name": "text",
      *         "access": "r"
      *     }]
      * }
@@ -169,7 +169,7 @@ class JustTextPlugin : public PluginWithConfig
      * <code>{.json}
      * {
      *     "topics": [{
-     *         "name": "/text",
+     *         "name": "text",
      *         "extra": {
      *             "ha": {
      *                 ... everything here will be used for MQTT discovery ...
@@ -184,7 +184,7 @@ class JustTextPlugin : public PluginWithConfig
      * <code>{.json}
      * {
      *     "topics": [{
-     *         "name": "/text",
+     *         "name": "text",
      *         "extra": "extra.json"
      *    }]
      * }