Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
@sca075
sca075 authored Mar 3, 2024
1 parent 190153e commit 002a1bf
Showing 1 changed file with 12 additions and 31 deletions.
43 changes: 12 additions & 31 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,35 +20,14 @@ This custom component anyhow is simple to install and setup, decode and render t
When you want also to control your vacuum you will need to also install the:
[lovelace-xiaomi-vacuum-map-card (recommended)](https://github.com/PiotrMachowski/lovelace-xiaomi-vacuum-map-card) from HACS as well.

Configuration of the card (thanks to [@PiotrMachowski](https://github.com/PiotrMachowski)) once the camera is installed requires:

*calibration source will be set to camera **not to identity** as the camera is providing the calibration points to the card.*
```
calibration_source:
camera: true
```

**Do not forget to use the internal_variables** as Valetudo is using MQTT is necessary to set in the card the topic.
*Your topic can be obtained also from the camera attributes vacuum_topic.*

![Screenshot 2023-10-24 at 18 25 59](https://github.com/sca075/valetudo_vacuum_camera/assets/82227818/080b7bcb-19f1-4415-870f-2285329e7ce9)

```
internal_variables:
topic: valetudo/your_topic
```

We did agree and work with the author of the card, we guess soon a [new version of the card](https://github.com/PiotrMachowski/lovelace-xiaomi-vacuum-map-card/actions/runs/7005593157) will be released.
Those settings for the internal_variables will be automatically setup in the card as soon the vacuum and camera will be setup in the card.

### Limitations and Compatibility:
<details>
<summary>
Please read the limitations and compatibility before to install the camera.
</summary>

I kindly ask for your understanding regarding any limitations you may encounter with this custom component.
While it's been extensively tested on a PI4 8GB, hardware below PI4 8GB may face issues. **Your feedback on such platforms is invaluable**;
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.
Expand Down Expand Up @@ -85,27 +64,29 @@ Via [HACS](https://hacs.xyz//setup/download) please follow. The instructions in
### Features:
<details><summary> We here List what this camera offers as futures.</summary>

1) **Automatically Generate the calibration points for the lovelace-xiaomi-vacuum-map-card** to ensure full compatibility to this user-friendly card.
2) **Automatically Generate rooms based configuration when vacuum support this functionality**, this will allow you to configure the rooms quickly on the [lovelace-xiaomi-vacuum-map-card](https://github.com/PiotrMachowski/lovelace-xiaomi-vacuum-map-card). Both firmwares are now supported.
3) **The camera take automatically [snapshots](./docs/snapshots.md) (when the vacuum idle/ error / docked)**. It is also possible to save a snapshot using a service call from Home Assistant with the file name and location you want to use.
1) All Valetudo vacuums are supported.
2) **Automatically Generate the calibration points for the lovelace-xiaomi-vacuum-map-card** to ensure full compatibility to this user-friendly card.
3) **Automatically Generate rooms based configuration when vacuum support this functionality**, this will allow you to configure the rooms quickly on the [lovelace-xiaomi-vacuum-map-card](https://github.com/PiotrMachowski/lovelace-xiaomi-vacuum-map-card).
4) **The camera take automatically [snapshots](./docs/snapshots.md) (when the vacuum idle/ error / docked)**. It is also possible to save a snapshot using a service call from Home Assistant with the file name and location you want to use. By the default the snapshot is saved in the www folder of Home Assistant. If the snapshot is disabled from Image Options the png will be deleted automatically.
```
service: camera.snapshot
target:
entity_id: camera.valetudo_your_vacuum_camera
data:
filename: /config/www/vacuum.png
```
4) **Change the image options** directly form the Home Assistant integration UI with a simple click on the integration configuration.
5) **Change the image options** directly form the Home Assistant integration UI with a simple click on the integration configuration.
- **Image Rotation**: 0, 90, 180, 270 (default is 0).
- [**Trim automatically the images**](./docs/croping_trimming.md). The standard Valetudo images size 5210x5210 or more, are resized automatically (At boot the camera trims and reduces the images sizes).
- [**Trim automatically the images**](./docs/croping_trimming.md). The standard Valetudo images size 5210x5210 or more, are resized automatically (At boot the camera trims and reduces the images sizes). Default margins are 150 pixels, you can customize this value from the image options.
- Base colors are the **colors for robot, charger, walls, background, zones etc**.
- **Rooms colors**, Room 1 is actually also the Floor color (for vacuum that do not support rooms).
- **[Transparency level](./docs/transparency.md) for all elements and rooms** colours can be also customize.
- It is possible to **display on the image the vacuum status**, this option add a vacuum status text at the top left of the image. Status and room where the vacuum is will be display on the text filed.
5) This integration make possible to **render multiple vacuums** as per each camera will be named with the vacuum name (example: vacuum.robot1 = camera.robot1_camera.. vacuum.robotx = camera.robotx_camera)
6) The camera as all cameras in HA **supports the ON/OFF service**, it is possible to *suspend and resume the camera streem as desired*.
7) In the attributes is possible to get on what room the vacuum is.
8) No Go, Virtual Walls, Zone Clean, Active Segments and Obstacles are draw on the map when available.
6) This integration make possible to **render multiple vacuums** as per each camera will be named with the vacuum name (example: vacuum.robot1 = camera.robot1_camera.. vacuum.robotx = camera.robotx_camera)
7) The camera as all cameras in HA **supports the ON/OFF service**, it is possible to *suspend and resume the camera streem as desired*.
8) In the attributes is possible to get on what room the vacuum is.
9) No Go, Virtual Walls, Zone Clean, Active Segments and Obstacles are draw on the map when available.
10) Auto Zooming the room (segment) when the vacuum is cleaning it.
</details>


Expand Down

0 comments on commit 002a1bf

Please sign in to comment.