From b12850077f3bdf255ed34d72336d5881a9f354ce Mon Sep 17 00:00:00 2001 From: Nathan Spencer Date: Mon, 29 Nov 2021 06:03:19 -0700 Subject: [PATCH] Update Litter-Robot documentation for new button entity (#20168) --- source/_integrations/litterrobot.markdown | 37 +++++------------------ 1 file changed, 8 insertions(+), 29 deletions(-) diff --git a/source/_integrations/litterrobot.markdown b/source/_integrations/litterrobot.markdown index 47e92900e20..807f580c05e 100644 --- a/source/_integrations/litterrobot.markdown +++ b/source/_integrations/litterrobot.markdown @@ -2,6 +2,10 @@ title: Litter-Robot description: Instructions on how to integrate a Litter-Robot Wi-Fi-enabled, automatic, self-cleaning litter box to Home Assistant. ha_category: + - Button + - Select + - Sensor + - Switch - Vacuum ha_iot_class: Cloud Polling ha_release: 2021.3 @@ -10,6 +14,8 @@ ha_codeowners: - '@natekspencer' ha_domain: litterrobot ha_platforms: + - button + - select - sensor - switch - vacuum @@ -35,7 +41,8 @@ The following entities are created for this component and identified by a single | Sleep Mode Start Time | `sensor` | When sleep mode is enabled, displays the current or next sleep mode start time. | | Sleep Mode End Time | `sensor` | When sleep mode is enabled, displays the current or last sleep mode end time. | | Waste Drawer | `sensor` | Displays the current waste drawer level. | -| Clean Cycle Wait Time Minutes | `select` | View and select the clean cycle wait time for the Litter-Robot unit. | +| Clean Cycle Wait Time Minutes | `select` | View and select the clean cycle wait time. | +| Reset Waste Drawer | `button` | Button to reset the waste drawer level to 0%. | ## Additional Attributes @@ -56,16 +63,6 @@ Some entities have attributes in addition to the default ones that are available Services are utilized for additional functionality that is available in the Litter-Robot companion app. The following are currently available: -### reset_waste_drawer - -Resets the waste drawer level on the Litter-Robot. This will reset the cycle count returned by the Litter-Robot API to `0` such that the waste drawer entity will report as `0.0 %`. - -```yaml -service: litterrobot.reset_waste_drawer -target: - entity_id: vacuum.litter_robot_litter_box -``` - ### set_sleep_mode Enables (with `start_time` parameter) or disables sleep mode on the Litter-Robot. @@ -86,21 +83,3 @@ data: start_time: '23:30:00' ``` - -### set_wait_time - -Sets the wait time, in minutes, between when your cat uses the Litter-Robot and when the unit cycles automatically. - -| Parameter | Type | Required | Description | -| --------- | ---- | -------- | --------------------------- | -| minutes | int | yes | Must be one of: 3, 7 or 15. | - -Example of setting the wait time to 3 minutes. - -```yaml -service: litterrobot.set_wait_time -target: - entity_id: vacuum.litter_robot_litter_box -data: - minutes: 3 -```