Merge pull request #213 from sca075/2024.07_dev

Updating DOCs Install md

docs/install.md

@@ -1,17 +1,18 @@
 ### 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
+## 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)
 
 please copy the repository link below in ***Custom repositories*** section.
 
-```
+```link
 https://github.com/sca075/mqtt_vacuum_camera.git
 ```
 
@@ -21,18 +22,18 @@ 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)
 
 
-## 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=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 (please 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 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/mqtt_vacuum_camera/assets/82227818/5587ecc0-859e-4bd4-ba18-0f96df0c55a5)
 
@@ -41,12 +42,12 @@ The camera entity created will have the same friendly name of your **vacuum** +
 
 ![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 mqtt_vacuum_camera.zip and extract its contents to config/custom_components/mqtt_vacuum_camera directory:
 
-```
+```shell
 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
@@ -61,7 +62,7 @@ Once the files are in the right place, you will need to restart Home Assistant t
 Configuration of the [card](https://github.com/PiotrMachowski/lovelace-xiaomi-vacuum-map-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.*
-```
+```yaml
 calibration_source: 
   camera: true 
 ```
@@ -72,25 +73,24 @@ 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.***
+```yaml
 internal_variables: 
   topic: valetudo/YOUR_TOPIC_HERE  
 ```
 
-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.
+We did agree and work with the author of the card, we guess 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, 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. Also, it is not
-possible to change the Images options form the vacuum UI.
+**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.
+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.
@@ -99,5 +99,13 @@ The setup of the options of the camera include:
 - [**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.)
+- [**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 the zipped logs:***
+- Home Assistant logs of MQTT Vacuum Camera (filtered).
+- json file of the Vacuum.
+- PNG file of output the map.