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-19 15:26:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add docs for RainMachine entity services (#16103)

Browse Source
This commit is contained in:
Aaron Bach 2021-01-04 12:01:26 -07:00 committed by GitHub
parent e65ae30695
commit 5d48f50106
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 45 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

73
source/_integrations/rainmachine.markdown
View File

@ -34,84 +34,101 @@ This integration can be configured via the Home Assistant UI by navigating to
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 |
| Service Data Attribute | Optional | Description |
|---------------------------|----------|-------------------------------------------------------------|
| `program_id ` | no | The program to disable |
| `entity_id` | yes | An entity belonging to the RainMachine controller to adjust |
### `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 zone to disable |
| Service Data Attribute | Optional | Description |
|---------------------------|----------|-------------------------------------------------------------|
| `zone_id ` | no | The program to disable |
| `entity_id` | yes | An entity belonging to the RainMachine controller to adjust |
### `rainmachine.enable_program`
Enable a RainMachine program.
| Service Data Attribute | Optional | Description |
|---------------------------|----------|-------------------------|
| `program_id` | no | The program to enable |
| Service Data Attribute | Optional | Description |
|---------------------------|----------|-------------------------------------------------------------|
| `program_id ` | no | The program to enable |
| `entity_id` | yes | An entity belonging to the RainMachine controller to adjust |
### `rainmachine.enable_zone`
Enable a RainMachine zone.
| Service Data Attribute | Optional | Description |
|---------------------------|----------|-------------------------|
| `zone_id` | no | The zone to enable |
| Service Data Attribute | Optional | Description |
|---------------------------|----------|-------------------------------------------------------------|
| `zone_id ` | no | The zone to enable |
| `entity_id` | yes | An entity belonging to the RainMachine controller to adjust |
### `rainmachine.pause_watering`
Pause all watering activities for a number of seconds.
| Service Data Attribute | Optional | Description |
|---------------------------|----------|--------------------------------|
| `seconds` | no | The number of seconds to pause |
| Service Data Attribute | Optional | Description |
|---------------------------|----------|-------------------------------------------------------------|
| `seconds` | no | The number of seconds to pause |
| `entity_id` | yes | An entity belonging to the RainMachine controller to adjust |
### `rainmachine.start_program`
Start a RainMachine program.
| Service Data Attribute | Optional | Description |
|---------------------------|----------|----------------------|
| `program_id` | no | The program to start |
| Service Data Attribute | Optional | Description |
|---------------------------|----------|-------------------------------------------------------------|
| `program_id ` | no | The program to start |
| `entity_id` | yes | An entity belonging to the RainMachine controller to adjust |
### `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 |
| 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 |
| `entity_id` | yes | An entity belonging to the RainMachine controller to adjust |
### `rainmachine.stop_all`
Stop all watering activities.
| Service Data Attribute | Optional | Description |
|---------------------------|----------|-------------------------------------------------------------|
| `entity_id` | yes | An entity belonging to the RainMachine controller to adjust |
### `rainmachine.stop_program`
Stop a RainMachine program.
| Service Data Attribute | Optional | Description |
|---------------------------|----------|----------------------|
| `program_id` | no | The program to stop |
| Service Data Attribute | Optional | Description |
|---------------------------|----------|-------------------------------------------------------------|
| `program_id ` | no | The program to stop |
| `entity_id` | yes | An entity belonging to the RainMachine controller to adjust |
### `rainmachine.stop_zone`
Stop a RainMachine zone.
| Service Data Attribute | Optional | Description |
|---------------------------|----------|----------------------|
| `zone_id` | no | The zone to stop |
| Service Data Attribute | Optional | Description |
|---------------------------|----------|-------------------------------------------------------------|
| `zone_id ` | no | The zone to stop |
| `entity_id` | yes | An entity belonging to the RainMachine controller to adjust |
### `rainmachine.unpause_watering`
Unpause all watering activities.
| Service Data Attribute | Optional | Description |
|---------------------------|----------|-------------------------------------------------------------|
| `entity_id` | yes | An entity belonging to the RainMachine controller to adjust |
## Switch
The `rainmachine` switch platform allows you to control programs and zones within a [RainMachine smart Wi-Fi sprinkler controller](https://www.rainmachine.com/).