mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-20 07:46:52 +00:00
Add docs for RainMachine entity services (#16103)
This commit is contained in:
parent
e65ae30695
commit
5d48f50106
@ -35,8 +35,9 @@ Disable a RainMachine program. This will mark the program switch as
|
|||||||
`Unavailable` in the UI.
|
`Unavailable` in the UI.
|
||||||
|
|
||||||
| Service Data Attribute | Optional | Description |
|
| Service Data Attribute | Optional | Description |
|
||||||
|---------------------------|----------|-------------------------|
|
|---------------------------|----------|-------------------------------------------------------------|
|
||||||
| `program_id ` | no | The program to disable |
|
| `program_id ` | no | The program to disable |
|
||||||
|
| `entity_id` | yes | An entity belonging to the RainMachine controller to adjust |
|
||||||
|
|
||||||
### `rainmachine.disable_zone`
|
### `rainmachine.disable_zone`
|
||||||
|
|
||||||
@ -44,74 +45,90 @@ Disable a RainMachine zone. This will mark the zone switch as
|
|||||||
`Unavailable` in the UI.
|
`Unavailable` in the UI.
|
||||||
|
|
||||||
| Service Data Attribute | Optional | Description |
|
| Service Data Attribute | Optional | Description |
|
||||||
|---------------------------|----------|-------------------------|
|
|---------------------------|----------|-------------------------------------------------------------|
|
||||||
| `zone_id` | no | The zone to disable |
|
| `zone_id ` | no | The program to disable |
|
||||||
|
| `entity_id` | yes | An entity belonging to the RainMachine controller to adjust |
|
||||||
|
|
||||||
### `rainmachine.enable_program`
|
### `rainmachine.enable_program`
|
||||||
|
|
||||||
Enable a RainMachine program.
|
Enable a RainMachine program.
|
||||||
|
|
||||||
| Service Data Attribute | Optional | Description |
|
| Service Data Attribute | Optional | Description |
|
||||||
|---------------------------|----------|-------------------------|
|
|---------------------------|----------|-------------------------------------------------------------|
|
||||||
| `program_id ` | no | The program to enable |
|
| `program_id ` | no | The program to enable |
|
||||||
|
| `entity_id` | yes | An entity belonging to the RainMachine controller to adjust |
|
||||||
|
|
||||||
### `rainmachine.enable_zone`
|
### `rainmachine.enable_zone`
|
||||||
|
|
||||||
Enable a RainMachine zone.
|
Enable a RainMachine zone.
|
||||||
|
|
||||||
| Service Data Attribute | Optional | Description |
|
| Service Data Attribute | Optional | Description |
|
||||||
|---------------------------|----------|-------------------------|
|
|---------------------------|----------|-------------------------------------------------------------|
|
||||||
| `zone_id ` | no | The zone to enable |
|
| `zone_id ` | no | The zone to enable |
|
||||||
|
| `entity_id` | yes | An entity belonging to the RainMachine controller to adjust |
|
||||||
|
|
||||||
### `rainmachine.pause_watering`
|
### `rainmachine.pause_watering`
|
||||||
|
|
||||||
Pause all watering activities for a number of seconds.
|
Pause all watering activities for a number of seconds.
|
||||||
|
|
||||||
| Service Data Attribute | Optional | Description |
|
| Service Data Attribute | Optional | Description |
|
||||||
|---------------------------|----------|--------------------------------|
|
|---------------------------|----------|-------------------------------------------------------------|
|
||||||
| `seconds` | no | The number of seconds to pause |
|
| `seconds` | no | The number of seconds to pause |
|
||||||
|
| `entity_id` | yes | An entity belonging to the RainMachine controller to adjust |
|
||||||
|
|
||||||
### `rainmachine.start_program`
|
### `rainmachine.start_program`
|
||||||
|
|
||||||
Start a RainMachine program.
|
Start a RainMachine program.
|
||||||
|
|
||||||
| Service Data Attribute | Optional | Description |
|
| Service Data Attribute | Optional | Description |
|
||||||
|---------------------------|----------|----------------------|
|
|---------------------------|----------|-------------------------------------------------------------|
|
||||||
| `program_id ` | no | The program to start |
|
| `program_id ` | no | The program to start |
|
||||||
|
| `entity_id` | yes | An entity belonging to the RainMachine controller to adjust |
|
||||||
|
|
||||||
### `rainmachine.start_zone`
|
### `rainmachine.start_zone`
|
||||||
|
|
||||||
Start a RainMachine zone for a set number of seconds.
|
Start a RainMachine zone for a set number of seconds.
|
||||||
|
|
||||||
| Service Data Attribute | Optional | Description |
|
| Service Data Attribute | Optional | Description |
|
||||||
|---------------------------|----------|------------------------------------------------------|
|
|---------------------------|----------|-------------------------------------------------------------|
|
||||||
| `zone_id` | no | The zone to start |
|
| `zone_id` | no | The zone to start |
|
||||||
| `zone_run_time` | yes | The number of seconds to run; defaults to 60 seconds |
|
| `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`
|
### `rainmachine.stop_all`
|
||||||
|
|
||||||
Stop all watering activities.
|
Stop all watering activities.
|
||||||
|
|
||||||
|
| Service Data Attribute | Optional | Description |
|
||||||
|
|---------------------------|----------|-------------------------------------------------------------|
|
||||||
|
| `entity_id` | yes | An entity belonging to the RainMachine controller to adjust |
|
||||||
|
|
||||||
### `rainmachine.stop_program`
|
### `rainmachine.stop_program`
|
||||||
|
|
||||||
Stop a RainMachine program.
|
Stop a RainMachine program.
|
||||||
|
|
||||||
| Service Data Attribute | Optional | Description |
|
| Service Data Attribute | Optional | Description |
|
||||||
|---------------------------|----------|----------------------|
|
|---------------------------|----------|-------------------------------------------------------------|
|
||||||
| `program_id ` | no | The program to stop |
|
| `program_id ` | no | The program to stop |
|
||||||
|
| `entity_id` | yes | An entity belonging to the RainMachine controller to adjust |
|
||||||
|
|
||||||
### `rainmachine.stop_zone`
|
### `rainmachine.stop_zone`
|
||||||
|
|
||||||
Stop a RainMachine zone.
|
Stop a RainMachine zone.
|
||||||
|
|
||||||
| Service Data Attribute | Optional | Description |
|
| Service Data Attribute | Optional | Description |
|
||||||
|---------------------------|----------|----------------------|
|
|---------------------------|----------|-------------------------------------------------------------|
|
||||||
| `zone_id ` | no | The zone to stop |
|
| `zone_id ` | no | The zone to stop |
|
||||||
|
| `entity_id` | yes | An entity belonging to the RainMachine controller to adjust |
|
||||||
|
|
||||||
### `rainmachine.unpause_watering`
|
### `rainmachine.unpause_watering`
|
||||||
|
|
||||||
Unpause all watering activities.
|
Unpause all watering activities.
|
||||||
|
|
||||||
|
| Service Data Attribute | Optional | Description |
|
||||||
|
|---------------------------|----------|-------------------------------------------------------------|
|
||||||
|
| `entity_id` | yes | An entity belonging to the RainMachine controller to adjust |
|
||||||
|
|
||||||
## Switch
|
## Switch
|
||||||
|
|
||||||
The `rainmachine` switch platform allows you to control programs and zones within a [RainMachine smart Wi-Fi sprinkler controller](https://www.rainmachine.com/).
|
The `rainmachine` switch platform allows you to control programs and zones within a [RainMachine smart Wi-Fi sprinkler controller](https://www.rainmachine.com/).
|
||||||
|
Loading…
x
Reference in New Issue
Block a user