From e974f3fac2136aec2f60d596f1bee51bf8e3ce17 Mon Sep 17 00:00:00 2001 From: Matt Zimmerman Date: Tue, 25 May 2021 04:05:03 -0700 Subject: [PATCH] Add documentation for SmartTub services (#16721) * add documentation for smarttub services * Apply suggestions from code review Co-authored-by: Franck Nijhof --- source/_integrations/smarttub.markdown | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/source/_integrations/smarttub.markdown b/source/_integrations/smarttub.markdown index 0d2eae3e57e..e13198f38ff 100644 --- a/source/_integrations/smarttub.markdown +++ b/source/_integrations/smarttub.markdown @@ -30,3 +30,27 @@ The `smarttub` integration allows you to view and control hot tubs which use the - A SmartTub account (registration is not supported, you can use the SmartTub mobile app) {% include integrations/config_flow.md %} + +## Services + +### Service `smarttub.set_primary_filtration` + +This service allows you to update the settings for the primary filtration cycle +on a hot tub. + +| Service data attribute | Optional | Description | Example | +| ---------------------- | -------- | ----------- | ------- | +| `entity_id` | yes | The entity to update. | sensor.jacuzzi_j_335_primary_filtration_cycle +| `duration` | no | The desired duration of the primary filtration cycle, in hours. | 4 +| `start_hour` | no | The desired starting hour of the day for the primary filtration cycle. | 2 (i.e. 02:00 or 2:00am) + + +### Service `smarttub.set_secondary_filtration` + +This service allows you to update the settings for the secondary filtration +cycle on a hot tub. + +| Service data attribute | Optional | Description | Example | +| ---------------------- | -------- | ----------- | ------- | +| `entity_id` | yes | The entity to update. | sensor.jacuzzi_j_335_secondary_filtration_cycle +| `mode` | no | The desired secondary filtration mode. Can be frequent, infrequent or away. | away