Skip to content

Commit 8d9cf01

Browse files
sti0fabaff
authored andcommitted
Adding attribute documentation (home-assistant#3439)
In addition of my PR home-assistant#9433 (home-assistant/core#9433) I have to update the documentation.
1 parent 3912824 commit 8d9cf01

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

source/_components/vacuum.xiaomi_miio.markdown

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,26 @@ Use this call to enter the remote control mode, make one move, and stop and exit
8080
| `rotation` | no | Rotation, between -179 degrees and 179 degrees. |
8181
| `duration` | no | Parameter affecting the duration of the movement. |
8282

83+
### {% linkable_title Attributes %}
84+
85+
In addition to all [`vacuum` component attributes] (`battery_icon`, `cleaned_area`, `fan_speed`, `fan_speed_list`, `status`, `params`), the `xiaomi` platform introduces specific attributes to get information of the botvac.
86+
87+
These are: `cleaning_time`, `do_not_disturb`, `main_brush_left`, `side_brush_left`, `filter_left`, `cleaning_count`, `total_cleaned_area` and `total_cleaning_time`.
88+
89+
The following table shows the units of measurement for the single attributes.
90+
91+
| Attribute | Unit of measurement | Description |
92+
|---------------------------|---------------------|-------------------------------------------------------|
93+
| `do_not_disturb` | | DND mode on / off |
94+
| `cleaning_time` | minutes | Last / actual cleaning time in minutes |
95+
| `cleaned_area` | square meter | Last / actual cleaned area in square meter |
96+
| `main_brush_left` | hours | Hours left until a change of the main brush is needed |
97+
| `side_brush_left` | hours | Hours left until a change of the side brush is needed |
98+
| `filter_left` | hours | Hours left until a change of the filter is needed |
99+
| `cleaning_count` | | Number of total cleaning passage |
100+
| `total_cleaned_area` | square meter | Total cleaned area in square meter |
101+
| `total_cleaning_time` | minutes | Total cleaning time in minutes |
102+
83103
### {% linkable_title Retrieving the Access Token %}
84104

85105
<p class='note'>

0 commit comments

Comments
 (0)