mirrors/Hypfer-Valetudo
2
0
Fork 0
mirror of https://github.com/Hypfer/Valetudo.git synced 2025-10-26 11:27:27 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: Add hint regarding how to get payloads for goto, segments and zone cleaning via mqtt

Browse Source
This commit is contained in:
Sören Beye 2024-01-26 16:29:57 +01:00
parent 3880f8bf3a
commit e38c309340
6 changed files with 14 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
backend/lib/mqtt/capabilities/GoToLocationCapabilityMqttHandle.js
View File

@ -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({

3
backend/lib/mqtt/capabilities/MapSegmentationCapabilityMqttHandle.js
View File

@ -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({

3
backend/lib/mqtt/capabilities/ZoneCleaningCapabilityMqttHandle.js
View File

@ -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({

9
docs/_pages/integrations/mqtt.md
View File

@ -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:

2
docs/_pages/usage/implementation-overview.md
View File

@ -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

2
util/generate_mqtt_docs.js
View File

@ -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