Add entities to Roborock documentation (#28521)

* Add entities to documentation

* Be consistent with periods

* Update roborock.markdown

* Apply suggestions from code review

Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com>

---------

Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com>
This commit is contained in:
Luke 2023-08-11 08:57:30 -04:00 committed by GitHub
parent 43c4afc92b
commit 25be1e6a56
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -34,6 +34,60 @@ Once you log in with your Roborock account, the integration will automatically d
{% include integrations/config_flow.md %}
## Entities
Roborock devices have a variety of features that are supported on some devices but not on others. Only entities that your device supports will be added to your integration.
### Vacuum
The vacuum entity holds the ability to control most things the vacuum can do, such as start a clean, return to the dock, or set the fan speed.
### Select
Mop mode - Describes how to mop the floor. On some firmware, it is called 'mop route'.
Mop intensity - How hard you would like your vacuum to mop.
### Sensor
Cleaning area - How much area the vacuum has cleaned in its current run. If the vacuum is not currently cleaning, how much area it has cleaned during its last run.
Cleaning time - How long the vacuum has been cleaning for. If the vacuum is not currently cleaning, how long it cleaned for in its last run.
Main brush time left - How much time is left before Roborock recommends you replace your main brush.
Side brush time left - How much time is left before Roborock recommends you replace your side brush.
Filter time left - How much time is left before Roborock recommends you replace your vacuum's air filter.
Status - The current status of your vacuum. This typically describes the action that is currently being run. For example, 'spot_cleaning' or 'docking'.
Total cleaning time - The lifetime cleaning duration of your vacuum.
Total cleaning area - The lifetime cleaning area of your vacuum.
Vacuum error - The current error with your vacuum, if there is one.
### Time
Do not disturb begin - When _Do not disturb_ is enabled, the vacuum does not run or speak after this point.
Do not disturb end - When _Do not disturb_ is enabled, the vacuum does not run or speak before this point.
### Switch
Child lock - This disables the buttons on the vacuum. Nothing happens when the buttons are pushed.
Status indicator light - This is the LED on the top of your vacuum. The color changes depending on the status of your vacuum.
Do not disturb - This enables _Do not disturb_ during the time frame you have set in the app or on the time entity. When _Do not disturb_ is enabled, the vacuum does not run or speak.
### Number
Volume - This allows you to control the volume of the robot's voice. For example, when it states "Starting cleaning". This allows you to set the volume to 0%, while the app limits it to 20%.
## FAQ
### Can I use the Mi home app with this integration?