From f6c17d254d41d89eabf4c4c4dae0636a0fa70f55 Mon Sep 17 00:00:00 2001
From: SCA075 <82227818+sca075@users.noreply.github.com>
Date: Thu, 12 Dec 2024 19:24:51 +0100
Subject: [PATCH 1/6] Readme layout update
Update README.
---
README.md | 96 ++++++++++++++++++++++++++-----------------------------
1 file changed, 46 insertions(+), 50 deletions(-)
diff --git a/README.md b/README.md
index 60aa0100..55775e02 100644
--- a/README.md
+++ b/README.md
@@ -6,12 +6,12 @@
-### Current Release: [![GitHub Latest Release][releases_shield]][latest_release]
+## Current Release: [![GitHub Latest Release][releases_shield]][latest_release]
-## Valetudo Vacuums maps in Home Assistant was never so easy.
+# Valetudo Vacuums maps in Home Assistant was never so easy.
**About:**
Extract the maps of Vacuum Cleaners connected via MQTT to Home Assistant such as Valetudo [Hypfer](https://valetudo.cloud/) or [RE(rand256)](https://github.com/rand256/valetudo) firmwares, [easy setup](./docs/install.md) thanks to [HACS](https://hacs.xyz/) and guided Home Assistant GUI configuration.
@@ -33,57 +33,22 @@ Our current focus is evolving beyond map rendering to provide full vacuum contro
Planned in the next Release
-#### 2024.12.0 - **Fully implement Coordinator**
+In the last releases we did start to implement the Actions for Rand256 and Hypfer.
+We can now see the Obstacles Images when available, and somehow we start to organize the code.
+The camera is stable and updated to all requirements of Home Assistant.
+Will be also time to take a brake and work in the background, so I do not expect unless required releases in January.
+
+#### 2025.2.0 - **Refactoring and some add**
+- **Changes**
+ - Exporting libraries to PyPi to reduce the code lines.
+ - Refactoring the code to make it more readable and easy to maintain.
+ - Fully Coordinated implementation of the cameras and sensors.
+ - Remove files operations (not for logging).
- **Features:**
- Added on 2024.11.0 the Actions for Rand256 to load and save maps fully integrate [MapLoader](https://github.com/pkoehlers/maploader).
- - Fix #263: The init process will be coordinated as we have Cameras and Sensors that need to be initialized.
- - Fix #276 "Unknown error" when some vacuum data is not reachable (refactoring).
-### Limitations and Compatibility:
-
-
- Please Read the "Limitations and Compatibility" before to install the camera.
-
-
-I kindly ask for your understanding regarding any limitations you may encounter with this custom component (please read also
-our [**notice**](./NOTICE.txt)).
-While it's been extensively tested on a PI4 8GB and now also on ProxMox VE, hardware below PI4 8GB may face issues. **Your feedback on such platforms is invaluable**;
-please report any problems you encounter.
-As a team of one, I'm diligently working to address compatibility across all environments, but this process takes time. In the interim, you can utilize [ValetudoPNG](https://github.com/erkexzcx/valetudopng) as an alternative on unsupported platforms.
-Your support in making this component compatible with all environments is greatly appreciated. If you'd like to contribute, whether through code or time, please consider joining our efforts.
-For further details on how the camera operates and how you can contribute, refer to the Wiki section of this project. Your patience and assistance are crucial as we strive toward our goal of universal compatibility.
-
-- PI3 4GB: The camera is working on PI3 4GB, anyhow no chance there to run two vacuums cameras at the same time.
-- PI4 4GB: The camera is working on PI4 4GB, anyhow run two vacuums cameras at the same time isn't advised even if possible.
-
-
-
-### Known Supported Vacuums:
-We here list, thanks to our users and tests done, the known working vacuums.
-
-- Dreame D9
-- Dreame Z10 Pro
-- Dreame L10s Ultra
-- Mi Robot Vacuum-Mop P
-- Roborock.S5 / S50 / S55 (Gen.2)
-- Roborock.S6
-- Roborock.S7
-- Roborock.S8
-- Roborock.V1 (Gen.1)
-- Xiaomi C1
-- In general, **it works with all flashed Valetudo Hypfer or RE(rand256) vacuums**.
-
- We here List what this camera offers as futures.
@@ -115,10 +80,41 @@ Our setup guide also includes **important** informations on how to setup the [lo
12) Support Actions "reload" and "reset_trims" implemented for changing the camera settings without restarting Home Assistant.
13) Rand256 sensors are pre-configured from the integration, this will allow you to have all the sensors available in Home Assistant.
14) Added the [**Actions**](./docs/actions.md) for Rand256 / Hypfer to control the vacuums without to format the MQTT messages.
+15) [Obstacles](./docs/obstacles_detection.md) are displayed on the map when available. When the vacuum support ```ObstaclesImage``` is also possible to view the obstacles images.
+
+ Please Read the "Limitations and Compatibility" before to install the camera.
+
+
+I kindly ask for your understanding regarding any limitations you may encounter with this custom component (please read also
+our [**notice**](./NOTICE.txt)).
+While it's been extensively tested on a PI4 8GB and now also on ProxMox VE, hardware below PI4 8GB may face issues. **Your feedback on such platforms is invaluable**;
+please report any problems you encounter.
+As a team of one, I'm diligently working to address compatibility across all environments, but this process takes time. In the interim, you can utilize [ValetudoPNG](https://github.com/erkexzcx/valetudopng) as an alternative on unsupported platforms.
+Your support in making this component compatible with all environments is greatly appreciated. If you'd like to contribute, whether through code or time, please consider joining our efforts.
+For further details on how the camera operates and how you can contribute, refer to the Wiki section of this project. Your patience and assistance are crucial as we strive toward our goal of universal compatibility.
+
+#### Compatibility:
+- PI3 4GB: The camera is working on PI3 4GB, anyhow no chance there to run two vacuums cameras at the same time.
+- PI4 4GB: The camera is working on PI4 4GB, anyhow run two vacuums cameras at the same time isn't advised even if possible.
+- All Vacuums with Valetudo Hypfer or Rand256 firmware are supported.
+- If you have a vacuum with a different firmware connected via MQTT, please let us know, we will try to add the support for it.
+
+
+
+### Notes:
- This integration is developed and tested using a PI4 with Home Assistant OS fully updated [to the last version](https://www.home-assistant.io/faq/release/), this allows us to confirm that the component is working properly with Home Assistant. Tested also on ProxMox and Docker Supervised "production" enviroment (fully setup home installation).
### Tanks to:
- [@PiotrMachowski](https://github.com/PiotrMachowski) inspiring this integration and his amazing work.
@@ -127,5 +123,5 @@ Our setup guide also includes **important** informations on how to setup the [lo
- [@rohankapoorcom](https://github.com/rohankapoorcom) autor of the v1.4.0 that make really easy to set up this integration.
- [@gunjambi](https://github.com/gunjambi) that found a solution to re-draw the robot and also implemented the snapshots png to be enabled or disabled from the options.
- [@T0ytoy](https://github.com/T0ytoy) for the amazing cooperation in testing our Camera that improved [using the threading](https://github.com/sca075/valetudo_vacuum_camera/discussions/71).
+- [@borgqueenx](https://github.com/borgqueenx) for the amazing cooperation in testing our Camera and helping us to improve it, [see more here](https://github.com/sca075/mqtt_vacuum_camera/discussions/296#:~:text=Edit-,borgqueenx,-2%20weeks%20ago)
- And to all of you using this integration and reporting any issues, improvements and vacuums used with it.
-
From ae4e4f8ed87859a424094955d0d87207e39838de Mon Sep 17 00:00:00 2001
From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com>
Date: Thu, 12 Dec 2024 23:13:07 +0000
Subject: [PATCH 2/6] Update mcr.microsoft.com/devcontainers/python Docker tag
to v3.13
---
.devcontainer.json | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/.devcontainer.json b/.devcontainer.json
index 491c8724..18c68edd 100644
--- a/.devcontainer.json
+++ b/.devcontainer.json
@@ -1,6 +1,6 @@
{
"name": "mqtt_vacuum_camera",
- "image": "mcr.microsoft.com/devcontainers/python:3.12",
+ "image": "mcr.microsoft.com/devcontainers/python:3.13",
"postCreateCommand": "scripts/setup",
"forwardPorts": [
8123
From d505d91a503f12a46f42c32425eeaf135170ced3 Mon Sep 17 00:00:00 2001
From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com>
Date: Fri, 13 Dec 2024 18:15:55 +0000
Subject: [PATCH 3/6] Update dependency janus to v1.2.0
---
requirements.test.txt | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/requirements.test.txt b/requirements.test.txt
index 93766272..ef1c70ab 100644
--- a/requirements.test.txt
+++ b/requirements.test.txt
@@ -3,7 +3,7 @@ pillow<=11.0.0
numpy
isal==1.7.1
psutil-home-assistant==0.0.1
-janus==1.1.0
+janus==1.2.0
# Strictly for tests
From fbb7ef5bd41dcf406dcc7cf8677e12a545e36318 Mon Sep 17 00:00:00 2001
From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com>
Date: Fri, 13 Dec 2024 18:18:33 +0000
Subject: [PATCH 4/6] Update dependency janus to v2
---
requirements.test.txt | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/requirements.test.txt b/requirements.test.txt
index ef1c70ab..494df411 100644
--- a/requirements.test.txt
+++ b/requirements.test.txt
@@ -3,7 +3,7 @@ pillow<=11.0.0
numpy
isal==1.7.1
psutil-home-assistant==0.0.1
-janus==1.2.0
+janus==2.0.0
# Strictly for tests
From 0dd06ac03095155f651868dd2fb41994637634f2 Mon Sep 17 00:00:00 2001
From: SCA075 <82227818+sca075@users.noreply.github.com>
Date: Fri, 13 Dec 2024 19:21:13 +0100
Subject: [PATCH 5/6] Update pythonpackage.yaml
---
.github/workflows/pythonpackage.yaml | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/.github/workflows/pythonpackage.yaml b/.github/workflows/pythonpackage.yaml
index 7483a3a1..442e412b 100644
--- a/.github/workflows/pythonpackage.yaml
+++ b/.github/workflows/pythonpackage.yaml
@@ -11,7 +11,7 @@ jobs:
strategy:
max-parallel: 2
matrix:
- python-version: ["3.12"]
+ python-version: ["3.13"]
steps:
- uses: actions/checkout@v4
From 215b326bd1f820c6211f725f1bd3b556aeca7af7 Mon Sep 17 00:00:00 2001
From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com>
Date: Thu, 2 Jan 2025 10:14:17 +0000
Subject: [PATCH 6/6] Update dependency pillow to <=11.1.0
---
requirements.test.txt | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/requirements.test.txt b/requirements.test.txt
index 494df411..43ed7556 100644
--- a/requirements.test.txt
+++ b/requirements.test.txt
@@ -1,5 +1,5 @@
# From our manifest.json for our custom component
-pillow<=11.0.0
+pillow<=11.1.0
numpy
isal==1.7.1
psutil-home-assistant==0.0.1