docs: Add hint regarding how to get payloads for goto, segments and z…

…one cleaning via mqtt
Hypfer · Jan 26, 2024 · e38c309 · e38c309
1 parent 3880f8b
commit e38c309
Show file tree

Hide file tree

Showing 6 changed files with 14 additions and 8 deletions.
diff --git a/backend/lib/mqtt/capabilities/GoToLocationCapabilityMqttHandle.js b/backend/lib/mqtt/capabilities/GoToLocationCapabilityMqttHandle.js
@@ -43,7 +43,8 @@ class GoToLocationCapabilityMqttHandle extends CapabilityMqttHandle {
                 }
             },
             helpText: "This handle accepts a JSON object identical to the one used by the REST API.\n\n" +
-                "Please refer to the \"General Help\" section in Valetudo for more information.\n\n" +
+                "Simply use the Map in the Valetudo UI, place the GoTo marker and then long-press the button that would start the action.<br/>\n" +
+                "This will open a modal containing the copy-pasteable payload.\n\n" +
                 "Sample payload:\n\n" +
                 "```json\n" +
                 JSON.stringify({

diff --git a/backend/lib/mqtt/capabilities/MapSegmentationCapabilityMqttHandle.js b/backend/lib/mqtt/capabilities/MapSegmentationCapabilityMqttHandle.js
@@ -56,7 +56,8 @@ class MapSegmentationCapabilityMqttHandle extends CapabilityMqttHandle {
                 }
             },
             helpText: "This handle accepts a JSON object identical to the one used by the REST API.\n\n" +
-                "Please refer to the \"General Help\" section in Valetudo for more information.\n\n" +
+                "Simply use the Map in the Valetudo UI, select the desired segments and iterations and then long-press the button that would start the action.<br/>\n" +
+                "This will open a modal containing the copy-pasteable payload.\n\n" +
                 "Sample payload:\n\n" +
                 "```json\n" +
                 JSON.stringify({

diff --git a/backend/lib/mqtt/capabilities/ZoneCleaningCapabilityMqttHandle.js b/backend/lib/mqtt/capabilities/ZoneCleaningCapabilityMqttHandle.js
@@ -62,7 +62,8 @@ class ZoneCleaningCapabilityMqttHandle extends CapabilityMqttHandle {
                 }
             },
             helpText: "This handle accepts a JSON object identical to the one used by the REST API.\n\n" +
-                "Please refer to the \"General Help\" section in Valetudo for more information.\n\n" +
+                "Simply use the Map in the Valetudo UI, create the desired zones, select the desired iterations and then long-press the button that would start the action.<br/>\n" +
+                "This will open a modal containing the copy-pasteable payload.\n\n" +
                 "Sample payload:\n\n" +
                 "```json\n" +
                 JSON.stringify({

diff --git a/docs/_pages/integrations/mqtt.md b/docs/_pages/integrations/mqtt.md
@@ -404,7 +404,8 @@ Home Assistant components controlled by this property:
 
 This handle accepts a JSON object identical to the one used by the REST API.
 
-Please refer to the "General Help" section in Valetudo for more information.
+Simply use the Map in the Valetudo UI, place the GoTo marker and then long-press the button that would start the action.<br/>
+This will open a modal containing the copy-pasteable payload.
 
 Sample payload:
 
@@ -455,7 +456,8 @@ Home Assistant components controlled by this property:
 
 This handle accepts a JSON object identical to the one used by the REST API.
 
-Please refer to the "General Help" section in Valetudo for more information.
+Simply use the Map in the Valetudo UI, select the desired segments and iterations and then long-press the button that would start the action.<br/>
+This will open a modal containing the copy-pasteable payload.
 
 Sample payload:
 
@@ -750,7 +752,8 @@ Valetudo Wi-Fi
 
 This handle accepts a JSON object identical to the one used by the REST API.
 
-Please refer to the "General Help" section in Valetudo for more information.
+Simply use the Map in the Valetudo UI, create the desired zones, select the desired iterations and then long-press the button that would start the action.<br/>
+This will open a modal containing the copy-pasteable payload.
 
 Sample payload:
 

diff --git a/docs/_pages/usage/implementation-overview.md b/docs/_pages/usage/implementation-overview.md
@@ -1083,4 +1083,4 @@ Capability | <a href='#dreame_1c'>1C</a> | <a href='#dreame_1t'>1T</a> | <a href
 
 <br/><br/><br/><br/><br/>
 This page has been autogenerated.<br/>
-Autogeneration timestamp: 2023-12-25T17:01:43.511Z
+Autogeneration timestamp: 2024-01-26T15:28:20.211Z
diff --git a/util/generate_mqtt_docs.js b/util/generate_mqtt_docs.js
@@ -38,7 +38,7 @@ order: 20
 # MQTT integration
 
 To make your robot talk to your MQTT broker and integrate with home automation software, such as but not limited to
-Home Assistant, openHAB and Node-RED, configure MQTT via Valetudo's web interface (Settings → MQTT).
+Home Assistant, openHAB and Node-RED, configure MQTT via Valetudo's web interface (Connectivity → MQTT connectivity).
 
 ## Autodiscovery