Skip to content

Latest commit

 

History

History
110 lines (75 loc) · 6.43 KB

install.md

File metadata and controls

110 lines (75 loc) · 6.43 KB

How to Install and Configure the Camera:

Via HACS

If you click this button below we can go to step #2.

Open HACS repository in Home Assistant

Step 1 Download the Component.

Using HACS add custom repositories by clicking on the three dots on the top right of the HACS page and select Integrations:

Screenshot 2023-08-12 at 17 06 17

please copy the repository link below in Custom repositories section.

https://github.com/sca075/mqtt_vacuum_camera.git

Screenshot 2024-08-24 at 10 41 16

Select Integration as Category and click the Add button.

Once the repository is added, please click on the repository and the home page will be display. From there you need to Download the integration with HACS that will install it for you. (Note: You can select here if you want to be notified for beta releases that some time are contain instant fixes).

Screenshot 2024-07-19 at 10 24 32

Step 2 Restart HA to finalize the component installation.

You will need to restart Home Assistant at this point to have the integration available. Once Home Assistant will reload, please go in (please press CTRL clicking the link this would open the link in a different tab of your browser) Settings -> Devices & Services then please confirm to add the integration. The setup will start, you just select here the vacuum and the camera will be configured.

Screenshot 2024-07-18 at 13 11 04

The configuration of the colours you would prefer for each element in the maps can be done via Options. The camera will connect automatically to the HA MQTT (whatever setup you use), for each vacuum you configured a new entity will be added to the configuration.

Screenshot 2023-08-30 at 07 23 30

The camera entity created will have the same friendly name of your vacuum + "camera" at the end. For example vacuum.robot1 = camera.robot1_camera.

Screenshot 2023-08-30 at 07 32 54

Manual Setup:

If you want to install this camera manually without HACS: Check the last release available and REPLACE_IT (at current v1.5.9) To install this integration manually you have to download mqtt_vacuum_camera.zip and extract its contents to config/custom_components/mqtt_vacuum_camera directory:

mkdir -p custom_components/mqtt_vacuum_camera
cd custom_components/mqtt_vacuum_camera
wget https://github.com/sca075/mqtt_vacuum_camera/archive/refs/tags/v.1.5.9.zip
unzip mqtt_vacuum_camera_v1.5.9.zip
rm mqtt_vacuum_camera_v1.5.9.zip

Once the files are in the right place, you will need to restart Home Assistant to have the integration available. Once Home Assistant will reload, please go in (plase press CTRL clicking the link this would open the link in a different tab of your browser) Settings -> **Devices & Services ** then please confirm to add the integration.

Card Configuration:

Configuration of the card (thanks to @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 

Warning: You need 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

Note: "YOUR_TOPIC_HERE" must be replaced with what you can find it in the camera attributes. The value is Case Sensitive.

internal_variables: 
  topic: valetudo/YOUR_TOPIC_HERE  

We did agree and work with the author of the card, we guess a new version of the card will be released. Those settings for the internal_variables will be, probably, automatically setup in the card as soon the vacuum and camera will be setup in the card.

Camera Configuration:

This integration is not configuring the Vacuums, you need to configure the vacuum in the vacuum UI. This project runs in parallel, is not a fork of the original Valetudo project you selected.

It is possible to configure the camera via the Home Assistant UI, as we aim to extract the Vacuums maps in the Home Assistant UI. The camera entity created will have the same friendly name of YOUR_VACUUM"_camera" at the end.

To configure the Camera Options use Home Assistant "Settings" -> "Devices & Services" -> "MQTT Vacuum Camera" in the "Integration" tab.

The setup of the options of the camera include:

We filter the logs of HA. Only the Camera entries on the logs are important to us, so we can help you better. The logs are stored in the .storage folder of Home Assistant. Can be export to WWW from the options of the camera. The Camera will delete this zip file from WWW if restarted.

What is in the zipped logs:

  • Home Assistant logs of MQTT Vacuum Camera (filtered).
  • json file of the Vacuum.
  • PNG file of output the map.