Update documentation of romedtinoSimpleWyze

PiotrMachowski · May 30, 2023 · c8e7cc7 · c8e7cc7
1 parent 2ac1116
commit c8e7cc7
Showing 1 changed file with 25 additions and 173 deletions.
diff --git a/docs/templates/romedtinoSimpleWyze.md b/docs/templates/romedtinoSimpleWyze.md
@@ -1,11 +1,19 @@
-# Xiaomi Miio
+# Simple Wyze Vacuum
 
-[Integration's documentation](https://www.home-assistant.io/integrations/xiaomi_miio/#xiaomi-mi-robot-vacuum)
+[Integration's documentation](https://github.com/romedtino/simple-wyze-vac)
 
-This platform can be used to control vacuums connected to Home Assistant using built-in Xiaomi Miio integration.
+This platform can be used to control vacuums connected to Home Assistant using custom Simple Wyze Vacuum integration created by [@romedtino](https://github.com/romedtino).
 
 To reset a value for a given consumable press and hold a matching tile.
 
+## Calibration
+
+You can calibrate the map using following config:
+```yaml
+calibration_source:
+  identity: true
+```
+
 ## Available templates
 
 * ### Room cleaning (`vacuum_clean_segment`)
@@ -16,7 +24,7 @@ To reset a value for a given consumable press and hold a matching tile.
 
   [Getting coordinates](/docs/templates/setup.md#getting-coordinates)
 
-  Used service: `xiaomi_miio.vacuum_clean_segment`
+  Used service: `vacuum.send_command`
 
   <details>
   <summary>Example configuration</summary>
@@ -25,190 +33,34 @@ To reset a value for a given consumable press and hold a matching tile.
   map_modes:
     - template: vacuum_clean_segment
       predefined_selections:
-        - id: 14
-          outline: [[ 21458, 32131 ], [ 24235, 32152 ], [ 24194, 27409 ], [ 23181, 27409 ]]
+        - id: Bedroom
+          outline: [[ 214, 321 ], [ 242, 321 ], [ 241, 274 ], [ 231, 274 ]]
           label:
             text: "Bedroom"
-            x: 22932
-            y: 30339
+            x: 229
+            y: 303
             offset_y: 35
           icon:
             name: "mdi:bed"
-            x: 22932
-            y: 30339
-        - id: 19
-          outline: [[ 21478, 27237 ], [ 23048, 27250 ], [ 23061, 25655 ], [ 21478, 25680 ]]
+            x: 229
+            y: 303
+        - id: Bathroom
+          outline: [[ 214, 272 ], [ 230, 272 ], [ 230, 256 ], [ 214, 256 ]]
           label:
             text: "Bathroom"
-            x: 22282
-            y: 26496
+            x: 222
+            y: 264
             offset_y: 35
           icon:
             name: "mdi:shower"
-            x: 22282
-            y: 26496
-  ```
-  
-  </details>
-  <details>
-  <summary>Example video</summary>
-
-    https://user-images.githubusercontent.com/6118709/141666925-34b01cde-82ff-447b-aecc-e9ced402b1ed.mp4
-
-  </details>
-
-* ### Zone cleaning (`vacuum_clean_zone`)
-
-  Uses 4 coordinates to clean rectangular zones.
-
-  Used service: `xiaomi_miio.vacuum_clean_zone`
-
-  <details>
-  <summary>Example configuration</summary>
-
-  ```yaml
-  map_modes:
-    - template: vacuum_clean_zone
-  ```
-
-  </details>
-  <details>
-  <summary>Example video</summary>
-
-    https://user-images.githubusercontent.com/6118709/141666913-d95f082d-f5bf-4ab5-a478-ba44effe6f34.mp4
-
-  </details>
-
-* ### Predefined zone cleaning (`vacuum_clean_zone_predefined`)
-
-  Uses 4 coordinates to clean rectangular zones that have been defined in the configuration. Requires `predefined_selections` to be provided.
-
-  [Getting coordinates](/docs/templates/setup.md#getting-coordinates)
-
-  Used service: `xiaomi_miio.vacuum_clean_zone`
-
-  <details>
-  <summary>Example configuration</summary>
-
-  ```yaml
-  map_modes:
-    - template: vacuum_clean_zone_predefined
-      predefined_selections:
-        - zones: [[ 21485, 28767, 24236, 32131 ], [ 23217, 27379, 24216, 28737 ]]
-          label:
-            text: "Bedroom"
-            x: 22932
-            y: 30339
-            offset_y: 35
-          icon:
-            name: "mdi:bed"
-            x: 22932
-            y: 30339
-        - zones: [[ 27782, 27563, 29678, 29369 ]]
-          label:
-            text: "Kitchen"
-            x: 28760
-            y: 28403
-            offset_y: 35
-          icon:
-            name: "mdi:pot-mix"
-            x: 28760
-            y: 28403
-  ```
-
-  </details>
-  <details>
-  <summary>Example video</summary>
-
-    https://user-images.githubusercontent.com/6118709/141666920-492a000c-9a78-4c20-b4f5-9343928140c7.mp4
-
-  </details>
-
-* ### Going to a specified point (`vacuum_goto`)
-
-  Uses a pair of coordinates for vacuum to get to a user-specified point.
-
-  Used service: `xiaomi_miio.vacuum_goto`
-
-  <details>
-  <summary>Example configuration</summary>
-
-  ```yaml
-  map_modes:
-    - template: vacuum_goto
+            x: 222
+            y: 264
   ```
-
-  </details>
-  <details>
-  <summary>Example video</summary>
-
-    https://user-images.githubusercontent.com/6118709/141666921-2f3d66da-6ffc-492a-8439-625da97651bd.mp4
-
-  </details>
-
-* ### Going to a predefined point (`vacuum_goto_predefined`)
-
-  Uses a pair of coordinates for vacuum to go to a point that has been defined in the configuration. Requires `predefined_selections` to be provided.
-
-  [Getting coordinates](/docs/templates/setup.md#getting-coordinates)
-
-  Used service: `xiaomi_miio.vacuum_goto`
 
-  <details>
-  <summary>Example configuration</summary>
-
-  ```yaml
-  map_modes:
-    - template: vacuum_goto_predefined
-      predefined_selections:
-        - position: [ 28006, 28036 ]
-          label:
-            text: "Emptying"
-            x: 28006
-            y: 28036
-            offset_y: 35
-          icon:
-            name: "mdi:broom"
-            x: 28006
-            y: 28036
-        - position: [ 32143, 26284 ]
-          label:
-            text: "Sofa"
-            x: 32143
-            y: 26284
-            offset_y: 35
-          icon:
-            name: "mdi:sofa"
-            x: 32143
-            y: 26284
-  ```
-
-  </details>
-  <details>
-  <summary>Example video</summary>
-
-    https://user-images.githubusercontent.com/6118709/141666923-965679e9-25fb-44cd-be08-fc63e5c85ce0.mp4
-
-  </details>
-
-* ### Following a specified path (`vacuum_follow_path`)
-
-  Uses a list of points to make a vacuum follow a user-defined path. Requires [`follow_path`](/docs/follow_path.yaml) script to be installed.
-
-  Used service: `script.vacuum_follow_path`
-
-  <details>
-  <summary>Example configuration</summary>
-
-  ```yaml
-  map_modes:
-    - template: vacuum_follow_path
-  ```
-
   </details>
   <details>
   <summary>Example video</summary>
 
-    https://user-images.githubusercontent.com/6118709/141666931-48d1717f-96d0-461d-84f4-788c071f3a78.mp4
+  https://user-images.githubusercontent.com/6118709/141666925-34b01cde-82ff-447b-aecc-e9ced402b1ed.mp4
 
   </details>