Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updating DOCs Install md #213

Merged
merged 4 commits into from
Jul 20, 2024
+28 −20
Merged

Updating DOCs Install md #213

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4f185e0
Updating install.md MQTT Vacuum Camera
sca075 Jul 20, 2024
ebecc7f
Merge branch 'main' into 2024.07_dev
sca075 Jul 20, 2024
743b9f1
Updating install.md MQTT Vacuum Camera
sca075 Jul 20, 2024
806fac5
Updating install.md MQTT Vacuum Camera
sca075 Jul 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 27 additions & 19 deletions docs/install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove trailing punctuation in heading.

The heading "Step 1 Download the Component." should not have trailing punctuation.

- ## Step 1 Download the Component.
+ ## Step 1 Download the Component
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
## Step 1 Download the Component.
## Step 1 Download the Component
Tools
Markdownlint

9-9: Punctuation: '.'
Trailing punctuation in heading

(MD026, no-trailing-punctuation)

![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.
Expand All @@ -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).
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Correct grammatical issues and typo.

There are grammatical issues and a typo in the instructions.

- 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).
+ Once the repository is added, please click on the repository and the home page will be displayed. From there you need to
+ **Download** the integration, [HACS](https://hacs.xyz/) will set up the integration for you. (Note: You can select here if you want to be notified for beta releases that sometimes contain instant fixes).
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
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).
Once the repository is added, please click on the repository and the home page will be displayed. From there you need to
**Download** the integration, [HACS](https://hacs.xyz/) will set up the integration for you. (Note: You can select here if you want to be notified for beta releases that sometimes contain instant fixes).
Tools
LanguageTool

[grammar] ~24-~24: The word “setup” is a noun. The verb is spelled with a space.
Context: ...gration, HACS will setup the integration for you. (Note: You can...

(NOUN_VERB_CONFUSION)

[grammar] ~24-~24: The past participle is required after “to be”.
Context: ...e: You can selct here if you want to be notify for beta releases that some time are co...

(BE_VBP_IN)

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Correct grammatical issues and typo.

There are grammatical issues and a typo in the instructions.

- 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).
+ Once the repository is added, please click on the repository and the home page will be displayed. From there you need to
+ **Download** the integration, [HACS](https://hacs.xyz/) will set up the integration for you. (Note: You can select here if you want to be notified for beta releases that sometimes contain instant fixes).
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
**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, [HACS](https://hacs.xyz/) will set up the integration for you. (Note: You can select here if you want to be notified for beta releases that sometimes contain instant fixes).
Tools
LanguageTool

[grammar] ~24-~24: The word “setup” is a noun. The verb is spelled with a space.
Context: ...gration, HACS will setup the integration for you. (Note: You can...

(NOUN_VERB_CONFUSION)

[grammar] ~24-~24: The past participle is required after “to be”.
Context: ...e: You can selct here if you want to be notify for beta releases that some time are co...

(BE_VBP_IN)


![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.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove trailing punctuation in heading.

The heading "Step 2 Restart HA and Setup the component." should not have trailing punctuation.

- ## Step 2 Restart HA and Setup the component.
+ ## Step 2 Restart HA and Setup the component
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
## 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.
## 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.
Tools
Markdownlint

29-29: Punctuation: '.'
Trailing punctuation in heading

(MD026, no-trailing-punctuation)

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.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Correct grammatical issue.

There is a grammatical issue with the phrase "will is connect".

- 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.
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
**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.
**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 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 connect automatically to the HA MQTT (whatever setup you use), for each vacuum you configured a new entity will be added to the configuration.
Tools
LanguageTool

[grammar] ~35-~35: Consider using either the past participle “connected” or the present participle “connecting” here.
Context: ...be done via Options. The camera will is connect automatically to the HA MQTT (whatever ...

(BEEN_PART_AGREEMENT)


![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.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add comma after "For example".

The phrase "For example vacuum.robot1" should have a comma after "For example".

- For example vacuum.robot1 = camera.robot1_camera.
+ For example, vacuum.robot1 = camera.robot1_camera.
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
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.
Tools
LanguageTool

[typographical] ~40-~40: After the expression ‘for example’ a comma is usually used.
Context: ...r vacuum + "camera" at the end. For example vacuum.robot1 = camera.robot1_camera. ...

(COMMA_FOR_EXAMPLE)


![Screenshot 2023-08-30 at 07 32 54](https://github.com/sca075/valetudo_vacuum_camera/assets/82227818/c4c054a5-e021-4c68-804b-9484d35a42ae)

### Manual Setup.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove trailing punctuation in heading.

The heading "Manual Setup." should not have trailing punctuation.

- ## Manual Setup.
+ ## Manual Setup
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
### Manual Setup.
### Manual Setup
Tools
Markdownlint

44-44: Punctuation: '.'
Trailing punctuation in heading

(MD026, no-trailing-punctuation)

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
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Specify language for the code block.

The code block should specify the language for better readability.

- ```
+ ```shell
Tools
Markdownlint

49-49: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

```

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.
Expand Down Expand Up @@ -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
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add comma for better readability.

There is a possible missing comma in the instructions.

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

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

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

[uncategorized] ~95-~95: Possible missing comma found.
Context: ...ra at the end. To configure the Camera Options use Home Assistant "Settings" -> "Devic...

(AI_HYDRA_LEO_MISSING_COMMA)

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.)
Loading