From 4f185e01440cd34a7c637614966fe1dbf84a6c78 Mon Sep 17 00:00:00 2001 From: SCA075 <82227818+sca075@users.noreply.github.com> Date: Sat, 20 Jul 2024 09:49:33 +0200 Subject: [PATCH 1/2] Updating install.md MQTT Vacuum Camera Signed-off-by: 82227818+sca075@users.noreply.github.com <82227818+sca075@users.noreply.github.com> --- docs/install.md | 46 +++++++++++++++++++++++++++------------------- 1 file changed, 27 insertions(+), 19 deletions(-) diff --git a/docs/install.md b/docs/install.md index 2e179c9e..b4fe0a33 100644 --- a/docs/install.md +++ b/docs/install.md @@ -1,6 +1,12 @@ ### How to Install and Configure the Camera: Using [HACS](https://hacs.xyz/) (current HACS version 1.34.0) add custom repositories by clicking on the three dots on the top right of the HACS page and select **Integrations**: +## Via HACS + +## If you click this button below we can go to step #2 +[![Open HACS repository in Home Assistant](https://my.home-assistant.io/badges/hacs_repository.svg)](https://my.home-assistant.io/redirect/hacs_repository/?owner=sca075&repository=mqtt_vacuum_camera&category=integration) + +## Step 1 Download the Component. ![Screenshot 2023-08-12 at 17 06 17](https://github.com/sca075/valetudo_vacuum_camera/assets/82227818/4abdf05a-eb50-4317-a0e9-8c6984bdba05) please copy the repository link below in ***Custom repositories*** section. @@ -9,40 +15,43 @@ please copy the repository link below in ***Custom repositories*** section. https://github.com/sca075/mqtt_vacuum_camera.git ``` -![Screenshot 2023-08-12 at 17 25 12](https://github.com/sca075/valetudo_vacuum_camera/assets/82227818/5e0874e6-4599-4853-b69b-940609555491) +![Screenshot 2023-08-12 at 17 25 12](https://github.com/sca075/mqtt_vacuum_camera/assets/82227818/5e0874e6-4599-4853-b69b-940609555491) 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, [HACS](https://hacs.xyz/) will setup the integration for you. (Note: You can selct here if you want to be notify for beta releases that some time are containg instant fixes). -![Screenshot 2023-08-12 at 17 31 34](https://github.com/sca075/valetudo_vacuum_camera/assets/82227818/8ab843a7-be55-4203-b107-c62b64d17032) +![Screenshot 2024-07-19 at 10 24 32](https://github.com/user-attachments/assets/57a22bb7-f9d5-40fc-abda-1a2bd34265da) + -You will need to restart Home Assistant at this point 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**](https://my.home-assistant.io/redirect/config_flow_start/?domain=valetudo_vacuum_camera) then please confirm to add the integration. +## Step 2 Restart HA and Setup the component. +**You will need to restart Home Assistant at this point** 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**](https://my.home-assistant.io/redirect/config_flow_start/?domain=mqtt_vacuum_camera) then please confirm to add the integration. The setup will start, you just select here the vacuum and the camera will be configured. -![Screenshot 2023-08-12 at 18 09 11](https://github.com/sca075/valetudo_vacuum_camera/assets/82227818/59f0022e-e233-4311-a6aa-37f17996d6f3) +![Screenshot 2024-07-18 at 13 11 04](https://github.com/user-attachments/assets/871bb739-ce32-4ee4-bccf-05d597afd399) The configuration of the colours you would prefer for each element in the maps can be done via Options. The camera will is 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](https://github.com/sca075/valetudo_vacuum_camera/assets/82227818/5587ecc0-859e-4bd4-ba18-0f96df0c55a5) +![Screenshot 2023-08-30 at 07 23 30](https://github.com/sca075/mqtt_vacuum_camera/assets/82227818/5587ecc0-859e-4bd4-ba18-0f96df0c55a5) -The camera entity created will have the same friendly name of your vacuum + "camera" at the end. For example vacuum.robot1 = camera.robot1_camera. +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](https://github.com/sca075/valetudo_vacuum_camera/assets/82227818/c4c054a5-e021-4c68-804b-9484d35a42ae) ### 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 valetudo_vacuum_camera.zip and extract its contents to config/custom_components/valetudo_vacuum_camera directory: +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/valetudo_vacuum_camera -cd custom_components/valetudo_vacuum_camera -wget https://github.com/sca075/valetudo_vacuum_camera/archive/refs/tags/v.1.5.9.zip -unzip valetudo_vacuum_camera_v1.5.9.zip -rm valetudo_vacuum_camera_v1.5.9.zip +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 **](https://my.home-assistant.io/redirect/config_flow_start/?domain=valetudo_vacuum_camera) then please confirm to add the integration. @@ -83,13 +92,12 @@ It is possible to **configure the camera via the Home Assistant UI**, as we aim 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" -> "Valetudo Vacuum Camera" in +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: -https://github.com/sca075/valetudo_vacuum_camera/blob/main/docs/images_options.md -- [**Image Options**](https://github.com/sca075/valetudo_vacuum_camera/blob/main/docs/images_options.md) -- [**Configure Status Text**](https://github.com/sca075/valetudo_vacuum_camera/blob/main/docs/status_text.md) -- [**Configure the Colours**](https://github.com/sca075/valetudo_vacuum_camera/blob/main/docs/colours.md) -- [**Export the logs of this integration**](https://github.com/sca075/valetudo_vacuum_camera/blob/main/docs/snapshots.md) (we filter the logs of the camera only as we don't want - to know what you run on your instance of Home Assistant) +- [**Image Options**](https://github.com/sca075/mqtt_vacuum_camera/blob/main/docs/images_options.md) +- [**Configure Status Text**](https://github.com/sca075/mqtt_vacuum_camera/blob/main/docs/status_text.md) +- [**Configure the Colours**](https://github.com/sca075/mqtt_vacuum_camera/blob/main/docs/colours.md) +- [**Export the logs of this integration**](https://github.com/sca075/mqtt_vacuum_camera/blob/main/docs/snapshots.md) (we filter the logs of the camera only as we don't want + to know what you run on your instance of Home Assistant only this custom component entries on the logs are important to us.) From 743b9f1ba82fef40aa0d5a6d6c192e73022ec5ef Mon Sep 17 00:00:00 2001 From: SCA075 <82227818+sca075@users.noreply.github.com> Date: Sat, 20 Jul 2024 09:49:33 +0200 Subject: [PATCH 2/2] Updating install.md MQTT Vacuum Camera Signed-off-by: 82227818+sca075@users.noreply.github.com <82227818+sca075@users.noreply.github.com> --- docs/install.md | 66 ++++++++++++++++++++++++++++++------------------- 1 file changed, 41 insertions(+), 25 deletions(-) diff --git a/docs/install.md b/docs/install.md index 2e179c9e..e309961f 100644 --- a/docs/install.md +++ b/docs/install.md @@ -1,5 +1,12 @@ ### How to Install and Configure the Camera: -Using [HACS](https://hacs.xyz/) (current HACS version 1.34.0) add custom repositories by clicking on the three dots on the top right of the HACS page and select **Integrations**: + +## Via HACS + +## If you click this button below we can go to step #2 +[![Open HACS repository in Home Assistant](https://my.home-assistant.io/badges/hacs_repository.svg)](https://my.home-assistant.io/redirect/hacs_repository/?owner=sca075&repository=mqtt_vacuum_camera&category=integration) + +## Step 1 Download the Component. +Using [HACS](https://hacs.xyz/) 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](https://github.com/sca075/valetudo_vacuum_camera/assets/82227818/4abdf05a-eb50-4317-a0e9-8c6984bdba05) @@ -9,40 +16,43 @@ please copy the repository link below in ***Custom repositories*** section. https://github.com/sca075/mqtt_vacuum_camera.git ``` -![Screenshot 2023-08-12 at 17 25 12](https://github.com/sca075/valetudo_vacuum_camera/assets/82227818/5e0874e6-4599-4853-b69b-940609555491) +![Screenshot 2023-08-12 at 17 25 12](https://github.com/sca075/mqtt_vacuum_camera/assets/82227818/5e0874e6-4599-4853-b69b-940609555491) 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, [HACS](https://hacs.xyz/) will setup the integration for you. (Note: You can selct here if you want to be notify for beta releases that some time are containg instant fixes). +**Download** the integration with [HACS](https://hacs.xyz/) 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](https://github.com/user-attachments/assets/57a22bb7-f9d5-40fc-abda-1a2bd34265da) -![Screenshot 2023-08-12 at 17 31 34](https://github.com/sca075/valetudo_vacuum_camera/assets/82227818/8ab843a7-be55-4203-b107-c62b64d17032) -You will need to restart Home Assistant at this point 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**](https://my.home-assistant.io/redirect/config_flow_start/?domain=valetudo_vacuum_camera) then please confirm to add the integration. +## 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 (plase press CTRL clicking the link this would open the link in a different tab of your browser) [**Settings** -> **Devices & Services**](https://my.home-assistant.io/redirect/config_flow_start/?domain=mqtt_vacuum_camera) then please confirm to add the integration. The setup will start, you just select here the vacuum and the camera will be configured. -![Screenshot 2023-08-12 at 18 09 11](https://github.com/sca075/valetudo_vacuum_camera/assets/82227818/59f0022e-e233-4311-a6aa-37f17996d6f3) +![Screenshot 2024-07-18 at 13 11 04](https://github.com/user-attachments/assets/871bb739-ce32-4ee4-bccf-05d597afd399) -The configuration of the colours you would prefer for each element in the maps can be done via Options. The camera will is connect automatically to the HA MQTT (whatever setup you use), for each vacuum you configured a new entity will be added to the configuration. +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](https://github.com/sca075/valetudo_vacuum_camera/assets/82227818/5587ecc0-859e-4bd4-ba18-0f96df0c55a5) +![Screenshot 2023-08-30 at 07 23 30](https://github.com/sca075/mqtt_vacuum_camera/assets/82227818/5587ecc0-859e-4bd4-ba18-0f96df0c55a5) -The camera entity created will have the same friendly name of your vacuum + "camera" at the end. For example vacuum.robot1 = camera.robot1_camera. +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](https://github.com/sca075/valetudo_vacuum_camera/assets/82227818/c4c054a5-e021-4c68-804b-9484d35a42ae) -### Manual Setup. +### 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 valetudo_vacuum_camera.zip and extract its contents to config/custom_components/valetudo_vacuum_camera directory: +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/valetudo_vacuum_camera -cd custom_components/valetudo_vacuum_camera -wget https://github.com/sca075/valetudo_vacuum_camera/archive/refs/tags/v.1.5.9.zip -unzip valetudo_vacuum_camera_v1.5.9.zip -rm valetudo_vacuum_camera_v1.5.9.zip +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 **](https://my.home-assistant.io/redirect/config_flow_start/?domain=valetudo_vacuum_camera) then please confirm to add the integration. @@ -63,8 +73,8 @@ topic. ![Screenshot 2023-10-24 at 18 25 59](https://github.com/sca075/valetudo_vacuum_camera/assets/82227818/080b7bcb-19f1-4415-870f-2285329e7ce9) -***Note: "YOUR_TOPIC_HERE" must be replaced with what you can find it in the camera attributes. The vaulue is Case -Sensitve.*** +***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 @@ -83,13 +93,19 @@ It is possible to **configure the camera via the Home Assistant UI**, as we aim 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" -> "Valetudo Vacuum Camera" in +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: -https://github.com/sca075/valetudo_vacuum_camera/blob/main/docs/images_options.md -- [**Image Options**](https://github.com/sca075/valetudo_vacuum_camera/blob/main/docs/images_options.md) -- [**Configure Status Text**](https://github.com/sca075/valetudo_vacuum_camera/blob/main/docs/status_text.md) -- [**Configure the Colours**](https://github.com/sca075/valetudo_vacuum_camera/blob/main/docs/colours.md) -- [**Export the logs of this integration**](https://github.com/sca075/valetudo_vacuum_camera/blob/main/docs/snapshots.md) (we filter the logs of the camera only as we don't want - to know what you run on your instance of Home Assistant) +- [**Image Options**](https://github.com/sca075/mqtt_vacuum_camera/blob/main/docs/images_options.md) +- [**Configure Status Text**](https://github.com/sca075/mqtt_vacuum_camera/blob/main/docs/status_text.md) +- [**Configure the Colours**](https://github.com/sca075/mqtt_vacuum_camera/blob/main/docs/colours.md) +- [**Export the logs of this integration**](https://github.com/sca075/mqtt_vacuum_camera/blob/main/docs/snapshots.md) + +We filter the logs of HA. Only the Camera only 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 zip logs: +- Home Assistant logs of MQTT Vacuum Camera (filtered). +- json file of the Vacuum. +- PNG file of output the map.