chore(release): 2022.05.0

Hypfer · May 1, 2022 · 9c123bd · 9c123bd
1 parent 35819f3
commit 9c123bd
Show file tree

Hide file tree

Showing 4 changed files with 69 additions and 83 deletions.
diff --git a/docs/_pages/general/supported-robots.md b/docs/_pages/general/supported-robots.md
@@ -77,7 +77,7 @@ Capability | <a href='#dreame_1c'>1C</a> | <a href='#dreame_1t'>1T</a> | <a href
 [MapSegmentationCapability](https://valetudo.cloud/pages/general/capabilities-overview.html#MapSegmentationCapability) | <span style="color:green;">Yes</span> | <span style="color:green;">Yes</span> | <span style="color:green;">Yes</span> | <span style="color:green;">Yes</span> | <span style="color:green;">Yes</span> | <span style="color:green;">Yes</span> | <span style="color:green;">Yes</span> | <span style="color:green;">Yes</span> | <span style="color:green;">Yes</span> | <span style="color:green;">Yes</span> | <span style="color:green;">Yes</span> | <span style="color:green;">Yes</span> | <span style="color:green;">Yes</span> | <span style="color:green;">Yes</span> | <span style="color:red;">No</span> | <span style="color:green;">Yes</span>
 [MapSnapshotCapability](https://valetudo.cloud/pages/general/capabilities-overview.html#MapSnapshotCapability) | <span style="color:red;">No</span> | <span style="color:red;">No</span> | <span style="color:red;">No</span> | <span style="color:red;">No</span> | <span style="color:red;">No</span> | <span style="color:red;">No</span> | <span style="color:red;">No</span> | <span style="color:red;">No</span> | <span style="color:red;">No</span> | <span style="color:red;">No</span> | <span style="color:red;">No</span> | <span style="color:green;">Yes</span> | <span style="color:red;">No</span> | <span style="color:green;">Yes</span> | <span style="color:red;">No</span> | <span style="color:red;">No</span>
 [MappingPassCapability](https://valetudo.cloud/pages/general/capabilities-overview.html#MappingPassCapability) | <span style="color:red;">No</span> | <span style="color:red;">No</span> | <span style="color:green;">Yes</span> | <span style="color:green;">Yes</span> | <span style="color:red;">No</span> | <span style="color:green;">Yes</span> | <span style="color:red;">No</span> | <span style="color:green;">Yes</span> | <span style="color:red;">No</span> | <span style="color:red;">No</span> | <span style="color:red;">No</span> | <span style="color:red;">No</span> | <span style="color:red;">No</span> | <span style="color:red;">No</span> | <span style="color:red;">No</span> | <span style="color:red;">No</span>
-[PendingMapChangeHandlingCapability](https://valetudo.cloud/pages/general/capabilities-overview.html#PendingMapChangeHandlingCapability) | <span style="color:red;">No</span> | <span style="color:green;">Yes</span> | <span style="color:green;">Yes</span> | <span style="color:green;">Yes</span> | <span style="color:green;">Yes</span> | <span style="color:green;">Yes</span> | <span style="color:green;">Yes</span> | <span style="color:green;">Yes</span> | <span style="color:red;">No</span> | <span style="color:red;">No</span> | <span style="color:red;">No</span> | <span style="color:red;">No</span> | <span style="color:red;">No</span> | <span style="color:red;">No</span> | <span style="color:red;">No</span> | <span style="color:red;">No</span>
+[PendingMapChangeHandlingCapability](https://valetudo.cloud/pages/general/capabilities-overview.html#PendingMapChangeHandlingCapability) | <span style="color:green;">Yes</span> | <span style="color:green;">Yes</span> | <span style="color:green;">Yes</span> | <span style="color:green;">Yes</span> | <span style="color:green;">Yes</span> | <span style="color:green;">Yes</span> | <span style="color:green;">Yes</span> | <span style="color:green;">Yes</span> | <span style="color:red;">No</span> | <span style="color:red;">No</span> | <span style="color:red;">No</span> | <span style="color:red;">No</span> | <span style="color:red;">No</span> | <span style="color:red;">No</span> | <span style="color:red;">No</span> | <span style="color:red;">No</span>
 [PersistentMapControlCapability](https://valetudo.cloud/pages/general/capabilities-overview.html#PersistentMapControlCapability) | <span style="color:green;">Yes</span> | <span style="color:green;">Yes</span> | <span style="color:red;">No</span> | <span style="color:red;">No</span> | <span style="color:green;">Yes</span> | <span style="color:red;">No</span> | <span style="color:green;">Yes</span> | <span style="color:red;">No</span> | <span style="color:green;">Yes</span> | <span style="color:green;">Yes</span> | <span style="color:green;">Yes</span> | <span style="color:green;">Yes</span> | <span style="color:green;">Yes</span> | <span style="color:green;">Yes</span> | <span style="color:red;">No</span> | <span style="color:green;">Yes</span>
 [QuirksCapability](https://valetudo.cloud/pages/general/capabilities-overview.html#QuirksCapability) | <span style="color:red;">No</span> | <span style="color:red;">No</span> | <span style="color:red;">No</span> | <span style="color:red;">No</span> | <span style="color:red;">No</span> | <span style="color:green;">Yes</span> | <span style="color:red;">No</span> | <span style="color:green;">Yes</span> | <span style="color:green;">Yes</span> | <span style="color:green;">Yes</span> | <span style="color:green;">Yes</span> | <span style="color:green;">Yes</span> | <span style="color:green;">Yes</span> | <span style="color:green;">Yes</span> | <span style="color:red;">No</span> | <span style="color:green;">Yes</span>
 [SpeakerTestCapability](https://valetudo.cloud/pages/general/capabilities-overview.html#SpeakerTestCapability) | <span style="color:green;">Yes</span> | <span style="color:green;">Yes</span> | <span style="color:green;">Yes</span> | <span style="color:green;">Yes</span> | <span style="color:green;">Yes</span> | <span style="color:green;">Yes</span> | <span style="color:green;">Yes</span> | <span style="color:green;">Yes</span> | <span style="color:green;">Yes</span> | <span style="color:green;">Yes</span> | <span style="color:green;">Yes</span> | <span style="color:green;">Yes</span> | <span style="color:green;">Yes</span> | <span style="color:green;">Yes</span> | <span style="color:green;">Yes</span> | <span style="color:green;">Yes</span>
@@ -143,6 +143,7 @@ vSLAM and a small battery, though there are persistent maps and everything seems
   - [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)
+  - [PendingMapChangeHandlingCapability](https://valetudo.cloud/pages/general/capabilities-overview.html#PendingMapChangeHandlingCapability)
   - [PersistentMapControlCapability](https://valetudo.cloud/pages/general/capabilities-overview.html#PersistentMapControlCapability)
   - [SpeakerTestCapability](https://valetudo.cloud/pages/general/capabilities-overview.html#SpeakerTestCapability)
   - [SpeakerVolumeControlCapability](https://valetudo.cloud/pages/general/capabilities-overview.html#SpeakerVolumeControlCapability)
@@ -1115,4 +1116,4 @@ Overall, it's just weird and annoying.
 
 <br/><br/><br/><br/><br/>
 This page has been autogenerated.<br/>
-Autogeneration timestamp: 2022-02-25T18:09:53.821Z
+Autogeneration timestamp: 2022-05-01T15:53:07.257Z
diff --git a/docs/_pages/integrations/mqtt.md b/docs/_pages/integrations/mqtt.md
@@ -71,8 +71,7 @@ Homie autodiscovery info is best viewed with something like [MQTT Explorer](http
      - [Fan speed control (`FanSpeedControlCapability`)](#fanspeedcontrolfanspeedcontrolcapability)
        - [Fan speed (`preset`)](#fanspeedpreset)
      - [Go to location (`GoToLocationCapability`)](#gotolocationgotolocationcapability)
-       - [Go to location preset (`go`)](#gotolocationpresetgo)
-       - [Presets (`presets`)](#presetspresets)
+       - [Go to location (`go`)](#gotolocationgo)
      - [Locate (`LocateCapability`)](#locatelocatecapability)
        - [Locate (`locate`)](#locatelocate)
      - [Segment cleaning (`MapSegmentationCapability`)](#segmentcleaningmapsegmentationcapability)
@@ -86,8 +85,7 @@ Homie autodiscovery info is best viewed with something like [MQTT Explorer](http
        - [Signal (`signal`)](#signalsignal)
        - [Wireless network (`ssid`)](#wirelessnetworkssid)
      - [Zone cleaning (`ZoneCleaningCapability`)](#zonecleaningzonecleaningcapability)
-       - [Presets (`presets`)](#presetspresets)
-       - [Start zone preset (`start`)](#startzonepresetstart)
+       - [Start zoned cleaning (`start`)](#startzonedcleaningstart)
    - [Map data](#mapdata)
      - [Map (`map`)](#mapmap)
      - [Map segments (`segments`)](#mapsegmentssegments)
@@ -122,14 +120,15 @@ Homie autodiscovery info is best viewed with something like [MQTT Explorer](http
 - [Consumable (percent) (`sensor.mqtt`)](#consumablepercentconsumable-percent)
 - [Current Statistics Area (`sensor.mqtt`)](#currentstatisticsareaarea)
 - [Current Statistics Time (`sensor.mqtt`)](#currentstatisticstimetime)
+- [Dust bin attachment (`binary_sensor.mqtt`)](#dustbindustbin)
 - [Error description (`sensor.mqtt`)](#errordescriptionerror)
-- [GoTo Locations (`sensor.mqtt`)](#gotolocationgotolocationcapability)
 - [Map data (`camera.mqtt`)](#rawmapdataforhomeassistantmap-data-hass)
 - [Map segments (`sensor.mqtt`)](#mapsegmentssegments)
+- [Mop attachment (`binary_sensor.mqtt`)](#mopmop)
 - [Vacuum (`vacuum.mqtt`)](#robot)
 - [Water grade (`select.mqtt`)](#watergradepreset)
+- [Water tank attachment (`binary_sensor.mqtt`)](#watertankwatertank)
 - [Wi-Fi configuration (`sensor.mqtt`)](#wi-ficonfigurationwificonfigurationcapability)
-- [Zone Presets (`sensor.mqtt`)](#zonecleaningzonecleaningcapability)
 
 
 # MQTT API reference
@@ -351,58 +350,27 @@ max
 
 *Node, capability: [GoToLocationCapability](/pages/general/capabilities-overview.html#gotolocationcapability)*
 
-Home Assistant components controlled by this node:
-
-- GoTo Locations ([`sensor.mqtt`](https://www.home-assistant.io/integrations/sensor.mqtt/))
-
-##### Go to location preset (`go`) <a id="gotolocationpresetgo" />
+##### Go to location (`go`) <a id="gotolocationgo" />
 
 *Property, command, not retained*
 
-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: `<TOPIC PREFIX>/<IDENTIFIER>/GoToLocationCapability/go/set`
-- Command response topic: `<TOPIC PREFIX>/<IDENTIFIER>/GoToLocationCapability/go`
-- Data type: [string](https://homieiot.github.io/specification/#string)
-
-
-
-##### Presets (`presets`) <a id="presetspresets" />
-
-*Property, readable, retained*
-
-This handle provides a set of configured Go-to-location presets as a JSON object.
-
-- Read topic: `<TOPIC PREFIX>/<IDENTIFIER>/GoToLocationCapability/presets`
-- Data type: [string](https://homieiot.github.io/specification/#string) (JSON)
+This handle accepts a JSON object identical to the one used by the REST API.
 
-Sample value:
+Sample payload:
 
 ```json
 {
-  "a9666386-7041-4bd4-a823-ebefa48665eb": {
-    "__class": "ValetudoGoToLocation",
-    "metaData": {},
-    "name": "SpotA",
-    "coordinates": {
-      "x": 2589,
-      "y": 2364
-    },
-    "id": "a9666386-7041-4bd4-a823-ebefa48665eb"
-  },
-  "6c74ac84-dfe9-4c4c-8bec-836ff268d630": {
-    "__class": "ValetudoGoToLocation",
-    "metaData": {},
-    "name": "SpotB",
-    "coordinates": {
-      "x": 2186,
-      "y": 2262
-    },
-    "id": "6c74ac84-dfe9-4c4c-8bec-836ff268d630"
+  "coordinates": {
+    "x": 50,
+    "y": 50
   }
 }
 ```
 
+- Command topic: `<TOPIC PREFIX>/<IDENTIFIER>/GoToLocationCapability/go/set`
+- Command response topic: `<TOPIC PREFIX>/<IDENTIFIER>/GoToLocationCapability/go`
+- Data type: [string](https://homieiot.github.io/specification/#string) (format: `same json as the REST interface`)
+
 
 
 
@@ -438,9 +406,9 @@ Sample payload:
 ```json
 {
   "segment_ids": [
-      "20",
-      "18",
-      "16"
+    "20",
+    "18",
+    "16"
   ],
   "iterations": 2,
   "customOrder": true
@@ -581,40 +549,45 @@ Valetudo Wi-Fi
 
 *Node, capability: [ZoneCleaningCapability](/pages/general/capabilities-overview.html#zonecleaningcapability)*
 
-Home Assistant components controlled by this node:
-
-- Zone Presets ([`sensor.mqtt`](https://www.home-assistant.io/integrations/sensor.mqtt/))
-
-##### Presets (`presets`) <a id="presetspresets" />
+##### Start zoned cleaning (`start`) <a id="startzonedcleaningstart" />
 
-*Property, readable, retained*
-
-This handles provides the list of configured zone presets as a JSON object.
+*Property, command, not retained*
 
-- Read topic: `<TOPIC PREFIX>/<IDENTIFIER>/ZoneCleaningCapability/presets`
-- Data type: [string](https://homieiot.github.io/specification/#string) (JSON)
+This handle accepts a JSON object identical to the one used by the REST API.
 
-Sample value:
+Sample payload:
 
 ```json
-{}
+{
+  "zones": [
+    {
+      "iterations": 1,
+      "points": {
+        "pA": {
+          "x": 50,
+          "y": 50
+        },
+        "pB": {
+          "x": 100,
+          "y": 50
+        },
+        "pC": {
+          "x": 100,
+          "y": 100
+        },
+        "pD": {
+          "x": 50,
+          "y": 100
+        }
+      }
+    }
+  ]
+}
 ```
 
-
-
-##### Start zone preset (`start`) <a id="startzonepresetstart" />
-
-*Property, command, not retained*
-
-This handle accepts a zone preset **UUID** to start. You can retrieve them from the `/presets` handle.
-
-Sample value:
-`25f6b7fe-0a28-477d-a1af-937ad91b2df4`
-
-
 - Command topic: `<TOPIC PREFIX>/<IDENTIFIER>/ZoneCleaningCapability/start/set`
 - Command response topic: `<TOPIC PREFIX>/<IDENTIFIER>/ZoneCleaningCapability/start`
-- Data type: [string](https://homieiot.github.io/specification/#string) (JSON)
+- Data type: [string](https://homieiot.github.io/specification/#string) (format: `same json as the REST interface`)
 
 
 
@@ -700,7 +673,7 @@ Status attributes managed by this node:
 
 *Property, readable, retained*
 
-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.
+This handle reports whether the dust bin attachment is installed.
 
 - Read topic: `<TOPIC PREFIX>/<IDENTIFIER>/AttachmentStateAttribute/dustbin`
 - Data type: [boolean](https://homieiot.github.io/specification/#boolean)
@@ -711,13 +684,17 @@ Sample value:
 true
 ```
 
+Home Assistant components controlled by this property:
+
+- Dust bin attachment ([`binary_sensor.mqtt`](https://www.home-assistant.io/integrations/binary_sensor.mqtt/))
+
 
 
 ##### Mop (`mop`) <a id="mopmop" />
 
 *Property, readable, retained*
 
-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.
+This handle reports whether the mop attachment is installed.
 
 - Read topic: `<TOPIC PREFIX>/<IDENTIFIER>/AttachmentStateAttribute/mop`
 - Data type: [boolean](https://homieiot.github.io/specification/#boolean)
@@ -728,13 +705,17 @@ Sample value:
 false
 ```
 
+Home Assistant components controlled by this property:
+
+- Mop attachment ([`binary_sensor.mqtt`](https://www.home-assistant.io/integrations/binary_sensor.mqtt/))
+
 
 
 ##### Water tank (`watertank`) <a id="watertankwatertank" />
 
 *Property, readable, retained*
 
-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.
+This handle reports whether the water tank attachment is installed.
 
 - Read topic: `<TOPIC PREFIX>/<IDENTIFIER>/AttachmentStateAttribute/watertank`
 - Data type: [boolean](https://homieiot.github.io/specification/#boolean)
@@ -745,6 +726,10 @@ Sample value:
 true
 ```
 
+Home Assistant components controlled by this property:
+
+- Water tank attachment ([`binary_sensor.mqtt`](https://www.home-assistant.io/integrations/binary_sensor.mqtt/))
+
 
 
 

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "valetudo",
-  "version": "2022.03.1",
+  "version": "2022.05.0",
   "description": "Self-contained control webinterface for vacuum robots",
   "license": "Apache-2.0",
   "engines": {