jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-26 18:57:17 +00:00
Code Issues Packages Projects Releases Wiki Activity

Reorganize RainMachine service docs (#19622)

Browse Source
This commit is contained in:
Aaron Bach 2021-10-11 06:46:29 -06:00 committed by GitHub
parent 8fad90edea
commit ba4b79cf19
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 16 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
source/_integrations/rainmachine.markdown
View File

@ -32,40 +32,40 @@ There is currently support for the following device types within Home Assistant:
## Services
Services accept either device IDs or entity IDs, depending on the nature of the service:
* Services that require a device ID as a target:
* `rainmachine.pause_watering`
* `rainmachine.stop_all`
* `rainmachine.unpause_watering`
* Services that require an entity ID as a target (note that the correct entity ID type must be provided, such as a program for a program-related service)
* `rainmachine.disable_program`
* `rainmachine.disable_zone`
* `rainmachine.enable_program`
* `rainmachine.enable_zone`
* `rainmachine.start_program`
* `rainmachine.start_zone`
* `rainmachine.stop_program`
* `rainmachine.stop_zone`
### `rainmachine.disable_program`
Disable a RainMachine program. This will mark the program switch as
`Unavailable` in the UI.
| Service Data Attribute | Optional | Description |
|---------------------------|----------|-------------------------------------------------------------|
| `program_id ` | no | The program to disable |
### `rainmachine.disable_zone`
Disable a RainMachine zone. This will mark the zone switch as
`Unavailable` in the UI.
| Service Data Attribute | Optional | Description |
|---------------------------|----------|-------------------------------------------------------------|
| `zone_id ` | no | The program to disable |
### `rainmachine.enable_program`
Enable a RainMachine program.
| Service Data Attribute | Optional | Description |
|---------------------------|----------|-------------------------------------------------------------|
| `program_id ` | no | The program to enable |
### `rainmachine.enable_zone`
Enable a RainMachine zone.
| Service Data Attribute | Optional | Description |
|---------------------------|----------|-------------------------------------------------------------|
| `zone_id ` | no | The zone to enable |
### `rainmachine.pause_watering`
Pause all watering activities for a number of seconds.
@ -76,19 +76,12 @@ Pause all watering activities for a number of seconds.
### `rainmachine.start_program`
Start a RainMachine program.
| Service Data Attribute | Optional | Description |
|---------------------------|----------|-------------------------------------------------------------|
| `program_id ` | no | The program to start |
### `rainmachine.start_zone`
Start a RainMachine zone for a set number of seconds.
| Service Data Attribute | Optional | Description |
|---------------------------|----------|-------------------------------------------------------------|
| `zone_id` | no | The zone to start |
| `zone_run_time` | yes | The number of seconds to run; defaults to 60 seconds |
### `rainmachine.stop_all`
@ -99,18 +92,10 @@ Stop all watering activities.
Stop a RainMachine program.
| Service Data Attribute | Optional | Description |
|---------------------------|----------|-------------------------------------------------------------|
| `program_id ` | no | The program to stop |
### `rainmachine.stop_zone`
Stop a RainMachine zone.
| Service Data Attribute | Optional | Description |
|---------------------------|----------|-------------------------------------------------------------|
| `zone_id ` | no | The zone to stop |
### `rainmachine.unpause_watering`
Unpause all watering activities.