Skip to content

Add documentation for SmartTub services #16721

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
frenck merged 2 commits into from
May 25, 2021
Merged

Add documentation for SmartTub services #16721

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
14249db
add documentation for smarttub services
mdz Feb 24, 2021
2fbc352
Apply suggestions from code review
frenck May 25, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions source/_integrations/smarttub.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,3 +24,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