From 8d9cf01bd3a023e7dc66159b7656b86e8f3d37e3 Mon Sep 17 00:00:00 2001 From: Timo S Date: Mon, 25 Sep 2017 22:28:10 +0200 Subject: [PATCH] Adding attribute documentation (#3439) In addition of my PR #9433 (https://github.com/home-assistant/home-assistant/pull/9433) I have to update the documentation. --- .../_components/vacuum.xiaomi_miio.markdown | 20 +++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/source/_components/vacuum.xiaomi_miio.markdown b/source/_components/vacuum.xiaomi_miio.markdown index 8322eb7c41a..0b4f7b5c90c 100644 --- a/source/_components/vacuum.xiaomi_miio.markdown +++ b/source/_components/vacuum.xiaomi_miio.markdown @@ -80,6 +80,26 @@ Use this call to enter the remote control mode, make one move, and stop and exit | `rotation` | no | Rotation, between -179 degrees and 179 degrees. | | `duration` | no | Parameter affecting the duration of the movement. | +### {% linkable_title Attributes %} + +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. + +These are: `cleaning_time`, `do_not_disturb`, `main_brush_left`, `side_brush_left`, `filter_left`, `cleaning_count`, `total_cleaned_area` and `total_cleaning_time`. + +The following table shows the units of measurement for the single attributes. + +| Attribute | Unit of measurement | Description | +|---------------------------|---------------------|-------------------------------------------------------| +| `do_not_disturb` | | DND mode on / off | +| `cleaning_time` | minutes | Last / actual cleaning time in minutes | +| `cleaned_area` | square meter | Last / actual cleaned area in square meter | +| `main_brush_left` | hours | Hours left until a change of the main brush is needed | +| `side_brush_left` | hours | Hours left until a change of the side brush is needed | +| `filter_left` | hours | Hours left until a change of the filter is needed | +| `cleaning_count` | | Number of total cleaning passage | +| `total_cleaned_area` | square meter | Total cleaned area in square meter | +| `total_cleaning_time` | minutes | Total cleaning time in minutes | + ### {% linkable_title Retrieving the Access Token %}