From 7e0153777d64270f6a0d5a9118cfd335d338fe62 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=B6ren=20Beye?= Date: Mon, 30 Aug 2021 20:48:12 +0200 Subject: [PATCH] chore(release): 2021.08.1 --- docs/_pages/general/rooting-instructions.md | 2 +- docs/_pages/general/supported-robots.md | 80 +++++++++++++------- docs/_pages/integrations/mqtt.md | 81 ++++++++++----------- package-lock.json | 4 +- package.json | 2 +- util/generate_mqtt_docs.js | 3 +- 6 files changed, 98 insertions(+), 74 deletions(-) diff --git a/docs/_pages/general/rooting-instructions.md b/docs/_pages/general/rooting-instructions.md index 0bb0f71cedf..cf5d617769b 100644 --- a/docs/_pages/general/rooting-instructions.md +++ b/docs/_pages/general/rooting-instructions.md @@ -133,7 +133,7 @@ To select the correct Valetudo binary for your robot, refer to this list: * valetudo (1C, F9, Z500) * valetudo-lowmem (D9) -* valetudo-aarch64 (everything else, Dreame Z10 Pro requires version 2021.09.0 or later) +* valetudo-aarch64 (everything else, Dreame Z10 Pro requires version 2021.08.1 or later) Reboot, connect to the robots Wi-Fi AP again, open up a browser, point it to `http://192.168.5.1` and then set up Wi-Fi via Valetudo. Don't be confused by the UI not loading the state. The robot needs to be provisioned (connected to a Wi-Fi) for that to work. diff --git a/docs/_pages/general/supported-robots.md b/docs/_pages/general/supported-robots.md index 45919f7aa7c..0cf2303b4f7 100644 --- a/docs/_pages/general/supported-robots.md +++ b/docs/_pages/general/supported-robots.md @@ -33,6 +33,7 @@ Don't take this as "Everything listed here will be 100% available and work all t 4. [F9](#dreame_f9) 5. [L10 Pro](#dreame_l10pro) 6. [MOVA Z500](#dreame_movaz500) + 7. [Z10 Pro](#dreame_z10pro) 3. [Roborock](#roborock) 1. [S4 Max](#roborock_s4max) 2. [S4](#roborock_s4) @@ -50,32 +51,32 @@ Don't take this as "Everything listed here will be 100% available and work all t ## Overview -Capability | 1C | 1T | D9 | F9 | L10 Pro | MOVA Z500 | S4 Max | S4 | S5 Max | S5 | S6 MaxV | S6 Pure | S6 | S7 | Xiaomi Mi Robot Vacuum | Xiaomi Mi Robot Vacuum-Mop P ----- | ---- | ---- | ---- | ---- | ---- | ---- | ---- | ---- | ---- | ---- | ---- | ---- | ---- | ---- | ---- | ---- -[BasicControlCapability](https://valetudo.cloud/pages/general/capabilities-overview.html#BasicControlCapability) | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes -[CarpetModeControlCapability](https://valetudo.cloud/pages/general/capabilities-overview.html#CarpetModeControlCapability) | No | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes -[CombinedVirtualRestrictionsCapability](https://valetudo.cloud/pages/general/capabilities-overview.html#CombinedVirtualRestrictionsCapability) | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | No | Yes -[ConsumableMonitoringCapability](https://valetudo.cloud/pages/general/capabilities-overview.html#ConsumableMonitoringCapability) | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes -[DoNotDisturbCapability](https://valetudo.cloud/pages/general/capabilities-overview.html#DoNotDisturbCapability) | No | No | No | No | No | No | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes -[FanSpeedControlCapability](https://valetudo.cloud/pages/general/capabilities-overview.html#FanSpeedControlCapability) | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes -[GoToLocationCapability](https://valetudo.cloud/pages/general/capabilities-overview.html#GoToLocationCapability) | No | No | No | No | No | No | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | No -[KeyLockCapability](https://valetudo.cloud/pages/general/capabilities-overview.html#KeyLockCapability) | No | Yes | Yes | Yes | Yes | Yes | No | No | No | No | No | No | No | No | No | No -[LocateCapability](https://valetudo.cloud/pages/general/capabilities-overview.html#LocateCapability) | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes -[ManualControlCapability](https://valetudo.cloud/pages/general/capabilities-overview.html#ManualControlCapability) | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes -[MapResetCapability](https://valetudo.cloud/pages/general/capabilities-overview.html#MapResetCapability) | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | No | Yes -[MapSegmentEditCapability](https://valetudo.cloud/pages/general/capabilities-overview.html#MapSegmentEditCapability) | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | No | Yes -[MapSegmentRenameCapability](https://valetudo.cloud/pages/general/capabilities-overview.html#MapSegmentRenameCapability) | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | No | Yes -[MapSegmentationCapability](https://valetudo.cloud/pages/general/capabilities-overview.html#MapSegmentationCapability) | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | No | Yes -[MapSnapshotCapability](https://valetudo.cloud/pages/general/capabilities-overview.html#MapSnapshotCapability) | No | No | No | No | No | No | No | No | No | Yes | No | No | Yes | No | No | No -[MappingPassCapability](https://valetudo.cloud/pages/general/capabilities-overview.html#MappingPassCapability) | No | Yes | Yes | Yes | Yes | Yes | No | No | No | No | No | No | No | No | No | No -[PendingMapChangeHandlingCapability](https://valetudo.cloud/pages/general/capabilities-overview.html#PendingMapChangeHandlingCapability) | No | Yes | Yes | Yes | Yes | Yes | No | No | No | No | No | No | No | No | No | No -[PersistentMapControlCapability](https://valetudo.cloud/pages/general/capabilities-overview.html#PersistentMapControlCapability) | Yes | Yes | No | Yes | No | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | No | Yes -[SpeakerTestCapability](https://valetudo.cloud/pages/general/capabilities-overview.html#SpeakerTestCapability) | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes -[SpeakerVolumeControlCapability](https://valetudo.cloud/pages/general/capabilities-overview.html#SpeakerVolumeControlCapability) | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes -[VoicePackManagementCapability](https://valetudo.cloud/pages/general/capabilities-overview.html#VoicePackManagementCapability) | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes -[WaterUsageControlCapability](https://valetudo.cloud/pages/general/capabilities-overview.html#WaterUsageControlCapability) | Yes | Yes | Yes | Yes | Yes | Yes | No | No | Yes | No | Yes | No | No | Yes | No | Yes -[WifiConfigurationCapability](https://valetudo.cloud/pages/general/capabilities-overview.html#WifiConfigurationCapability) | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes -[ZoneCleaningCapability](https://valetudo.cloud/pages/general/capabilities-overview.html#ZoneCleaningCapability) | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes +Capability | 1C | 1T | D9 | F9 | L10 Pro | MOVA Z500 | Z10 Pro | S4 Max | S4 | S5 Max | S5 | S6 MaxV | S6 Pure | S6 | S7 | Xiaomi Mi Robot Vacuum | Xiaomi Mi Robot Vacuum-Mop P +---- | ---- | ---- | ---- | ---- | ---- | ---- | ---- | ---- | ---- | ---- | ---- | ---- | ---- | ---- | ---- | ---- | ---- +[BasicControlCapability](https://valetudo.cloud/pages/general/capabilities-overview.html#BasicControlCapability) | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes +[CarpetModeControlCapability](https://valetudo.cloud/pages/general/capabilities-overview.html#CarpetModeControlCapability) | No | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes +[CombinedVirtualRestrictionsCapability](https://valetudo.cloud/pages/general/capabilities-overview.html#CombinedVirtualRestrictionsCapability) | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | No | Yes +[ConsumableMonitoringCapability](https://valetudo.cloud/pages/general/capabilities-overview.html#ConsumableMonitoringCapability) | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes +[DoNotDisturbCapability](https://valetudo.cloud/pages/general/capabilities-overview.html#DoNotDisturbCapability) | No | No | No | No | No | No | No | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes +[FanSpeedControlCapability](https://valetudo.cloud/pages/general/capabilities-overview.html#FanSpeedControlCapability) | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes +[GoToLocationCapability](https://valetudo.cloud/pages/general/capabilities-overview.html#GoToLocationCapability) | No | No | No | No | No | No | No | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | No +[KeyLockCapability](https://valetudo.cloud/pages/general/capabilities-overview.html#KeyLockCapability) | No | Yes | Yes | Yes | Yes | Yes | Yes | No | No | No | No | No | No | No | No | No | No +[LocateCapability](https://valetudo.cloud/pages/general/capabilities-overview.html#LocateCapability) | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes +[ManualControlCapability](https://valetudo.cloud/pages/general/capabilities-overview.html#ManualControlCapability) | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes +[MapResetCapability](https://valetudo.cloud/pages/general/capabilities-overview.html#MapResetCapability) | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | No | Yes +[MapSegmentEditCapability](https://valetudo.cloud/pages/general/capabilities-overview.html#MapSegmentEditCapability) | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | No | Yes +[MapSegmentRenameCapability](https://valetudo.cloud/pages/general/capabilities-overview.html#MapSegmentRenameCapability) | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | No | Yes +[MapSegmentationCapability](https://valetudo.cloud/pages/general/capabilities-overview.html#MapSegmentationCapability) | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | No | Yes +[MapSnapshotCapability](https://valetudo.cloud/pages/general/capabilities-overview.html#MapSnapshotCapability) | No | No | No | No | No | No | No | No | No | No | Yes | No | No | Yes | No | No | No +[MappingPassCapability](https://valetudo.cloud/pages/general/capabilities-overview.html#MappingPassCapability) | No | Yes | Yes | Yes | Yes | Yes | Yes | No | No | No | No | No | No | No | No | No | No +[PendingMapChangeHandlingCapability](https://valetudo.cloud/pages/general/capabilities-overview.html#PendingMapChangeHandlingCapability) | No | Yes | Yes | Yes | Yes | Yes | Yes | No | No | No | No | No | No | No | No | No | No +[PersistentMapControlCapability](https://valetudo.cloud/pages/general/capabilities-overview.html#PersistentMapControlCapability) | Yes | Yes | No | Yes | No | Yes | No | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | No | Yes +[SpeakerTestCapability](https://valetudo.cloud/pages/general/capabilities-overview.html#SpeakerTestCapability) | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes +[SpeakerVolumeControlCapability](https://valetudo.cloud/pages/general/capabilities-overview.html#SpeakerVolumeControlCapability) | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes +[VoicePackManagementCapability](https://valetudo.cloud/pages/general/capabilities-overview.html#VoicePackManagementCapability) | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes +[WaterUsageControlCapability](https://valetudo.cloud/pages/general/capabilities-overview.html#WaterUsageControlCapability) | Yes | Yes | Yes | Yes | Yes | Yes | Yes | No | No | Yes | No | Yes | No | No | Yes | No | Yes +[WifiConfigurationCapability](https://valetudo.cloud/pages/general/capabilities-overview.html#WifiConfigurationCapability) | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes +[ZoneCleaningCapability](https://valetudo.cloud/pages/general/capabilities-overview.html#ZoneCleaningCapability) | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes
@@ -232,6 +233,31 @@ This model supports the following capabilities: - [ZoneCleaningCapability](https://valetudo.cloud/pages/general/capabilities-overview.html#ZoneCleaningCapability) +### Z10 Pro + +This model supports the following capabilities: + - [BasicControlCapability](https://valetudo.cloud/pages/general/capabilities-overview.html#BasicControlCapability) + - [CarpetModeControlCapability](https://valetudo.cloud/pages/general/capabilities-overview.html#CarpetModeControlCapability) + - [CombinedVirtualRestrictionsCapability](https://valetudo.cloud/pages/general/capabilities-overview.html#CombinedVirtualRestrictionsCapability) + - [ConsumableMonitoringCapability](https://valetudo.cloud/pages/general/capabilities-overview.html#ConsumableMonitoringCapability) + - [FanSpeedControlCapability](https://valetudo.cloud/pages/general/capabilities-overview.html#FanSpeedControlCapability) + - [KeyLockCapability](https://valetudo.cloud/pages/general/capabilities-overview.html#KeyLockCapability) + - [LocateCapability](https://valetudo.cloud/pages/general/capabilities-overview.html#LocateCapability) + - [ManualControlCapability](https://valetudo.cloud/pages/general/capabilities-overview.html#ManualControlCapability) + - [MapResetCapability](https://valetudo.cloud/pages/general/capabilities-overview.html#MapResetCapability) + - [MapSegmentEditCapability](https://valetudo.cloud/pages/general/capabilities-overview.html#MapSegmentEditCapability) + - [MapSegmentRenameCapability](https://valetudo.cloud/pages/general/capabilities-overview.html#MapSegmentRenameCapability) + - [MapSegmentationCapability](https://valetudo.cloud/pages/general/capabilities-overview.html#MapSegmentationCapability) + - [MappingPassCapability](https://valetudo.cloud/pages/general/capabilities-overview.html#MappingPassCapability) + - [PendingMapChangeHandlingCapability](https://valetudo.cloud/pages/general/capabilities-overview.html#PendingMapChangeHandlingCapability) + - [SpeakerTestCapability](https://valetudo.cloud/pages/general/capabilities-overview.html#SpeakerTestCapability) + - [SpeakerVolumeControlCapability](https://valetudo.cloud/pages/general/capabilities-overview.html#SpeakerVolumeControlCapability) + - [VoicePackManagementCapability](https://valetudo.cloud/pages/general/capabilities-overview.html#VoicePackManagementCapability) + - [WaterUsageControlCapability](https://valetudo.cloud/pages/general/capabilities-overview.html#WaterUsageControlCapability) + - [WifiConfigurationCapability](https://valetudo.cloud/pages/general/capabilities-overview.html#WifiConfigurationCapability) + - [ZoneCleaningCapability](https://valetudo.cloud/pages/general/capabilities-overview.html#ZoneCleaningCapability) + + ## Roborock ### S4 Max @@ -477,4 +503,4 @@ This model supports the following capabilities:




This page has been autogenerated.
-Autogeneration timestamp: 2021-08-13T18:49:27.810Z +Autogeneration timestamp: 2021-08-30T18:46:48.783Z diff --git a/docs/_pages/integrations/mqtt.md b/docs/_pages/integrations/mqtt.md index d939cae21e4..06d294aa699 100644 --- a/docs/_pages/integrations/mqtt.md +++ b/docs/_pages/integrations/mqtt.md @@ -41,8 +41,7 @@ You can then configure it to serve the PNG map over HTTP for openHAB and other s If you're planning to use one of the home automation platforms listed above, this is all you need to know to get started. If you're instead planning to do something more custom, in this document you will find a reference to all MQTT topics -provided by this software. Values such as `` are those configured in the MQTT -settings page. +provided by this software. Values such as `` are those configured in the MQTT settings page. {% include alert.html type="tip" content="It is recommended to leave Homie autodiscovery enabled, even if you're not planning to use it, if you want to develop custom integrations or access the MQTT topics directly: the Homie protocol is very readable and self-documenting. @@ -146,8 +145,8 @@ Home Assistant components controlled by this device: *Property, command, not retained* -- Command topic: `//BasicControlCapability/operation/set` -- Command response topic: `//BasicControlCapability/operation` +- Command topic: `valetudo//BasicControlCapability/operation/set` +- Command response topic: `valetudo//BasicControlCapability/operation` - Data type: [enum](https://homieiot.github.io/specification/#enum) (allowed payloads: `START`, `STOP`, `PAUSE`, `HOME`) @@ -179,7 +178,7 @@ Status attributes managed by this node: This handle returns the consumable remaining endurance time as an ISO8601 duration. The controlled Home Assistant component will report it as seconds instead. -- Read topic: `//ConsumableMonitoringCapability/` +- Read topic: `valetudo//ConsumableMonitoringCapability/` - Data type: [duration](https://homieiot.github.io/specification/#duration) (in [ISO8601 duration format](https://en.wikipedia.org/wiki/ISO_8601#Durations)) Sample value: @@ -200,7 +199,7 @@ Home Assistant components controlled by this property: This handle returns the consumable remaining endurance percentage. -- Read topic: `//ConsumableMonitoringCapability/` +- Read topic: `valetudo//ConsumableMonitoringCapability/` - Data type: [integer percentage](https://homieiot.github.io/specification/#percent) (range: 0 to 100, unit: %) Sample value: @@ -221,8 +220,8 @@ Home Assistant components controlled by this property: If set to `PERFORM`, it will attempt to refresh the consumables from the robot. Note that there's no need to do it manually, consumables are refreshed automatically every 30 seconds by default. -- Command topic: `//ConsumableMonitoringCapability/refresh/set` -- Command response topic: `//ConsumableMonitoringCapability/refresh` +- Command topic: `valetudo//ConsumableMonitoringCapability/refresh/set` +- Command response topic: `valetudo//ConsumableMonitoringCapability/refresh` - Data type: [enum](https://homieiot.github.io/specification/#enum) (allowed payloads: `PERFORM`) @@ -243,8 +242,8 @@ Status attributes managed by this node: This handle allows setting the fan speed. It accepts the preset payloads specified in `$format` or in the HAss json attributes. -- Read topic: `//FanSpeedControlCapability/preset` -- Set topic: `//FanSpeedControlCapability/preset/set` +- Read topic: `valetudo//FanSpeedControlCapability/preset` +- Set topic: `valetudo//FanSpeedControlCapability/preset/set` - Data type: [enum](https://homieiot.github.io/specification/#enum) (allowed payloads: `off`, `min`, `low`, `medium`, `high`, `turbo`, `max`) {% include alert.html type="warning" content="Some information contained in this document may not be exactly what is sent or expected by actual robots, since different vendors have different implementations. Refer to the table below. @@ -281,8 +280,8 @@ Home Assistant components controlled by this node: Use this handle to make the robot go to a configured preset location. It accepts one single preset UUID as a regular string. -- Command topic: `//GoToLocationCapability/go/set` -- Command response topic: `//GoToLocationCapability/go` +- Command topic: `valetudo//GoToLocationCapability/go/set` +- Command response topic: `valetudo//GoToLocationCapability/go` - Data type: [string](https://homieiot.github.io/specification/#string) @@ -293,7 +292,7 @@ Use this handle to make the robot go to a configured preset location. It accepts This handle provides a set of configured Go-to-location presets as a JSON object. -- Read topic: `//GoToLocationCapability/presets` +- Read topic: `valetudo//GoToLocationCapability/presets` - Data type: [string](https://homieiot.github.io/specification/#string) (JSON) Sample value: @@ -335,8 +334,8 @@ Sample value: *Property, command, not retained* -- Command topic: `//LocateCapability/locate/set` -- Command response topic: `//LocateCapability/locate` +- Command topic: `valetudo//LocateCapability/locate/set` +- Command response topic: `valetudo//LocateCapability/locate` - Data type: [enum](https://homieiot.github.io/specification/#enum) (allowed payloads: `PERFORM`) @@ -351,8 +350,8 @@ Sample value: *Property, command, not retained* -- Command topic: `//MapSegmentationCapability/clean/set` -- Command response topic: `//MapSegmentationCapability/clean` +- Command topic: `valetudo//MapSegmentationCapability/clean/set` +- Command response topic: `valetudo//MapSegmentationCapability/clean` - Data type: [string](https://homieiot.github.io/specification/#string) (format: `same json as the REST interface`) @@ -373,8 +372,8 @@ Status attributes managed by this node: This handle allows setting the water grade. It accepts the preset payloads specified in `$format` or in the HAss json attributes. -- Read topic: `//WaterUsageControlCapability/preset` -- Set topic: `//WaterUsageControlCapability/preset/set` +- Read topic: `valetudo//WaterUsageControlCapability/preset` +- Set topic: `valetudo//WaterUsageControlCapability/preset/set` - Data type: [enum](https://homieiot.github.io/specification/#enum) (allowed payloads: `off`, `min`, `low`, `medium`, `high`, `turbo`, `max`) {% include alert.html type="warning" content="Some information contained in this document may not be exactly what is sent or expected by actual robots, since different vendors have different implementations. Refer to the table below. @@ -413,7 +412,7 @@ Home Assistant components controlled by this node: *Property, readable, retained* -- Read topic: `//WifiConfigurationCapability/frequency` +- Read topic: `valetudo//WifiConfigurationCapability/frequency` - Data type: [string](https://homieiot.github.io/specification/#string) Sample value: @@ -428,7 +427,7 @@ Sample value: *Property, readable, retained* -- Read topic: `//WifiConfigurationCapability/ips` +- Read topic: `valetudo//WifiConfigurationCapability/ips` - Data type: [string](https://homieiot.github.io/specification/#string) Sample value: @@ -443,8 +442,8 @@ Sample value: *Property, command, not retained* -- Command topic: `//WifiConfigurationCapability/refresh/set` -- Command response topic: `//WifiConfigurationCapability/refresh` +- Command topic: `valetudo//WifiConfigurationCapability/refresh/set` +- Command response topic: `valetudo//WifiConfigurationCapability/refresh` - Data type: [enum](https://homieiot.github.io/specification/#enum) (allowed payloads: `PERFORM`) @@ -453,13 +452,13 @@ Sample value: *Property, readable, retained* -- Read topic: `//WifiConfigurationCapability/signal` +- Read topic: `valetudo//WifiConfigurationCapability/signal` - Data type: [integer](https://homieiot.github.io/specification/#integer) (unit: dBm) Sample value: ```json --59 +-52 ``` @@ -468,7 +467,7 @@ Sample value: *Property, readable, retained* -- Read topic: `//WifiConfigurationCapability/ssid` +- Read topic: `valetudo//WifiConfigurationCapability/ssid` - Data type: [string](https://homieiot.github.io/specification/#string) Sample value: @@ -495,7 +494,7 @@ Home Assistant components controlled by this node: This handles provides the list of configured zone presets as a JSON object. -- Read topic: `//ZoneCleaningCapability/presets` +- Read topic: `valetudo//ZoneCleaningCapability/presets` - Data type: [string](https://homieiot.github.io/specification/#string) (JSON) Sample value: @@ -521,8 +520,8 @@ Sample payload: ] ``` -- Command topic: `//ZoneCleaningCapability/start/set` -- Command response topic: `//ZoneCleaningCapability/start` +- Command topic: `valetudo//ZoneCleaningCapability/start/set` +- Command response topic: `valetudo//ZoneCleaningCapability/start` - Data type: [string](https://homieiot.github.io/specification/#string) (JSON) @@ -543,7 +542,7 @@ This handle is only enabled if `homie.addICBINVMapProperty` is enabled in the co ICBINV should be configured so that it publishes the map to this topic. -- Read topic: `//MapData/map` +- Read topic: `valetudo//MapData/map` - Data type: [string](https://homieiot.github.io/specification/#string) @@ -552,7 +551,7 @@ ICBINV should be configured so that it publishes the map to this topic. *Property, readable, retained* -- Read topic: `//MapData/map-data` +- Read topic: `valetudo//MapData/map-data` - Data type: [string](https://homieiot.github.io/specification/#string) @@ -563,7 +562,7 @@ ICBINV should be configured so that it publishes the map to this topic. This handle is added automatically if Home Assistant autodiscovery is enabled. It provides a map embedded in a PNG image that recommends installing the Valetudo Lovelace card. -- Read topic: `//MapData/map-data-hass-hack` +- Read topic: `valetudo//MapData/map-data-hass-hack` - Data type: [string](https://homieiot.github.io/specification/#string) Home Assistant components controlled by this property: @@ -578,7 +577,7 @@ Home Assistant components controlled by this property: This property contains a JSON mapping of segment IDs to segment names. -- Read topic: `//MapData/segments` +- Read topic: `valetudo//MapData/segments` - Data type: [string](https://homieiot.github.io/specification/#string) (JSON) Sample value: @@ -611,7 +610,7 @@ Status attributes managed by this node: This handle reports whether the dust bin is installed. Attachments not compatible with your robot may be included (but set to `false`) and you can safely ignore them. -- Read topic: `//AttachmentStateAttribute/dustbin` +- Read topic: `valetudo//AttachmentStateAttribute/dustbin` - Data type: [boolean](https://homieiot.github.io/specification/#boolean) Sample value: @@ -628,7 +627,7 @@ true This handle reports whether the mop is installed. Attachments not compatible with your robot may be included (but set to `false`) and you can safely ignore them. -- Read topic: `//AttachmentStateAttribute/mop` +- Read topic: `valetudo//AttachmentStateAttribute/mop` - Data type: [boolean](https://homieiot.github.io/specification/#boolean) Sample value: @@ -645,7 +644,7 @@ false This handle reports whether the water tank is installed. Attachments not compatible with your robot may be included (but set to `false`) and you can safely ignore them. -- Read topic: `//AttachmentStateAttribute/watertank` +- Read topic: `valetudo//AttachmentStateAttribute/watertank` - Data type: [boolean](https://homieiot.github.io/specification/#boolean) Sample value: @@ -670,7 +669,7 @@ Status attributes managed by this node: *Property, readable, retained* -- Read topic: `//BatteryStateAttribute/level` +- Read topic: `valetudo//BatteryStateAttribute/level` - Data type: [integer percentage](https://homieiot.github.io/specification/#percent) (unit: %) Sample value: @@ -685,7 +684,7 @@ Sample value: *Property, readable, retained* -- Read topic: `//BatteryStateAttribute/status` +- Read topic: `valetudo//BatteryStateAttribute/status` - Data type: [enum](https://homieiot.github.io/specification/#enum) (allowed payloads: `none`, `charging`, `discharging`, `charged`) Sample value: @@ -710,7 +709,7 @@ Status attributes managed by this node: *Property, readable, retained* -- Read topic: `//StatusStateAttribute/detail` +- Read topic: `valetudo//StatusStateAttribute/detail` - Data type: [enum](https://homieiot.github.io/specification/#enum) (allowed payloads: `none`, `zone`, `segment`, `spot`, `target`, `resumable`, `mapping`) Sample value: @@ -727,7 +726,7 @@ segment The error description will only be populated when the robot reports an error. Errors in Valetudo not reported by the robot won't be sent here. -- Read topic: `//StatusStateAttribute/error` +- Read topic: `valetudo//StatusStateAttribute/error` - Data type: [string](https://homieiot.github.io/specification/#string) Home Assistant components controlled by this property: @@ -740,7 +739,7 @@ Home Assistant components controlled by this property: *Property, readable, retained* -- Read topic: `//StatusStateAttribute/status` +- Read topic: `valetudo//StatusStateAttribute/status` - Data type: [enum](https://homieiot.github.io/specification/#enum) (allowed payloads: `error`, `docked`, `idle`, `returning`, `cleaning`, `paused`, `manual_control`, `moving`) Sample value: diff --git a/package-lock.json b/package-lock.json index 45b5cbacd45..002b35722a0 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "valetudo", - "version": "2021.08.0", + "version": "2021.08.1", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "valetudo", - "version": "2021.08.0", + "version": "2021.08.1", "license": "Apache-2.0", "workspaces": [ "backend", diff --git a/package.json b/package.json index 41803bb0c20..a7c98659052 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "valetudo", - "version": "2021.08.0", + "version": "2021.08.1", "description": "Self-contained control webinterface for vacuum robots", "license": "Apache-2.0", "engines": { diff --git a/util/generate_mqtt_docs.js b/util/generate_mqtt_docs.js index 02b622e02a6..c658a8a2b86 100644 --- a/util/generate_mqtt_docs.js +++ b/util/generate_mqtt_docs.js @@ -69,8 +69,7 @@ You can then configure it to serve the PNG map over HTTP for openHAB and other s If you're planning to use one of the home automation platforms listed above, this is all you need to know to get started. If you're instead planning to do something more custom, in this document you will find a reference to all MQTT topics -provided by this software. Values such as \`\` and \`\` are those configured in the MQTT -settings page. +provided by this software. Values such as \`\` are those configured in the MQTT settings page. ` + jekyllAlert("tip", `It is recommended to leave Homie autodiscovery enabled, even if you're not planning to use it, if you want to develop custom integrations or access the MQTT topics directly: the Homie protocol is very readable and self-documenting.