Merge pull request #592 from PiotrMachowski/dev

v2.2.0

.github/FUNDING.yml

@@ -1,2 +1,2 @@
 ko_fi: piotrmachowski
-custom: ["paypal.me/PiMachowski"]
+custom: ["buycoffee.to/piotrmachowski", "paypal.me/PiMachowski", "revolut.me/314ma"]

.github/ISSUE_TEMPLATE/new_platform_request.yml

@@ -29,6 +29,13 @@ body:
         - label: Going to point (using 2 coordinates)
         - label: Cleaning a point (using 2 coordinates)
         - label: Others
+  - type: checkboxes
+    id: checklist
+    attributes:
+      label: Checklist
+      options:
+        - label: I have sent info about entities to `piotr.machowski.dev [at] gmail.com` ([Retrieving entities info](https://github.com/PiotrMachowski/lovelace-xiaomi-vacuum-map-card/discussions/594); please provide your GitHub username in the email)
+          required: false
   - type: textarea
     validations:
       required: true

.github/workflows/build.yml

@@ -12,14 +12,20 @@ on:
 
 jobs:
   build:
-    name: Test build
+    name: Build
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v1
+
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 14
+
       - name: Build
         run: |
           npm install
           npm run build
+
       - name: Archive built file
         uses: actions/upload-artifact@v3
         with:

.github/workflows/hacs.yaml

@@ -0,0 +1,17 @@
+name: Validate HACS
+
+on:
+  push:
+  pull_request:
+
+jobs:
+  validate:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Validate HACS
+        uses: "hacs/action@main"
+        with:
+          category: "plugin"

.github/workflows/release.yml

@@ -10,21 +10,22 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v1
+
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 14
 
-      # Build
       - name: Build the file
         run: |
-          cd /home/runner/work/lovelace-xiaomi-vacuum-map-card/lovelace-xiaomi-vacuum-map-card
           npm install
           npm run build
 
-      # Upload build file to the release as an asset.
-      - name: Upload zip to release
+      - name: Upload build result to release
         uses: svenstaro/upload-release-action@v1-release
 
         with:
           repo_token: ${{ secrets.GITHUB_TOKEN }}
-          file: /home/runner/work/lovelace-xiaomi-vacuum-map-card/lovelace-xiaomi-vacuum-map-card/dist/xiaomi-vacuum-map-card.js
+          file: dist/xiaomi-vacuum-map-card.js
           asset_name: xiaomi-vacuum-map-card.js
           tag: ${{ github.ref }}
           overwrite: true

.vscode/tasks.json

@@ -1,5 +1,5 @@
 {
-	"version": "v2.1.2",
+	"version": "v2.1.3-beta",
 	"tasks": [
 		{
 			"type": "npm",

docs/templates/BenjaminPaapMyNeato.md

@@ -0,0 +1,54 @@
+# MyNeato
+
+[Integration's documentation](https://github.com/BenjaminPaap/home-assistant-myneato)
+
+This platform can be used to control vacuums connected to Home Assistant using MyNeato integration created by [@BenjaminPaap](https://github.com/BenjaminPaap).
+
+## Available templates
+
+* ### Room cleaning (`vacuum_clean_segment`)
+
+  Uses IDs to clean specific rooms. Requires `predefined_selections` to be provided.
+
+  [Getting coordinates](/docs/templates/setup.md#getting-coordinates)
+
+  Used service: `myneato.custom_cleaning`
+
+  <details>
+  <summary>Example configuration</summary>
+
+  ```yaml
+  map_modes:
+    - template: vacuum_clean_segment
+      predefined_selections:
+        - id: Bedroom
+          outline: [[ 21458, 32131 ], [ 24235, 32152 ], [ 24194, 27409 ], [ 23181, 27409 ]]
+          label:
+            text: "Bedroom"
+            x: 22932
+            y: 30339
+            offset_y: 35
+          icon:
+            name: "mdi:bed"
+            x: 22932
+            y: 30339
+        - id: Bathroom
+          outline: [[ 21478, 27237 ], [ 23048, 27250 ], [ 23061, 25655 ], [ 21478, 25680 ]]
+          label:
+            text: "Bathroom"
+            x: 22282
+            y: 26496
+            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>

docs/templates/DeebotUniverseDeebot4homeAssistant.md

@@ -0,0 +1,129 @@
+# Deebot 4 Home Assistant
+
+[Integration's documentation](https://deebot.readthedocs.io/)
+
+This platform can be used to control vacuums connected to Home Assistant using Deebot 4 Home Assistant integration created by [@DeebotUniverse](https://github.com/DeebotUniverse).
+
+## Available templates
+
+* ### Room cleaning (`vacuum_clean_segment`)
+
+  Uses IDs to clean specific rooms. Requires `predefined_selections` to be provided.
+
+  [Configuration generator](https://github.com/PiotrMachowski/lovelace-xiaomi-vacuum-map-card/discussions/317)
+
+  [Getting coordinates](/docs/templates/setup.md#getting-coordinates)
+
+  Used service: `xiaomi_miio.vacuum_clean_segment`
+
+  [Documentation](https://deebot.readthedocs.io/integrations/home-assistant/examples/commands/#clean-only-certain-rooms)
+
+  <details>
+  <summary>Example configuration</summary>
+
+  ```yaml
+  map_modes:
+    - template: vacuum_clean_segment
+      predefined_selections:
+        - id: 14
+          outline: [[ 214, 321 ], [ 242, 321 ], [ 241, 274 ], [ 231, 274 ]]
+          label:
+            text: "Bedroom"
+            x: 229
+            y: 303
+            offset_y: 35
+          icon:
+            name: "mdi:bed"
+            x: 229
+            y: 303
+        - id: 19
+          outline: [[ 214, 272 ], [ 230, 272 ], [ 230, 256 ], [ 214, 256 ]]
+          label:
+            text: "Bathroom"
+            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: `vacuum.send_command`
+
+  [Documentation](https://deebot.readthedocs.io/integrations/home-assistant/examples/commands/#clean-custom-area)
+
+  <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: `vacuum.send_command`
+
+  [Documentation](https://deebot.readthedocs.io/integrations/home-assistant/examples/commands/#clean-custom-area)
+
+  <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>