From 5d48f501065720566d36b44510cae0f66ca4bc6d Mon Sep 17 00:00:00 2001 From: Aaron Bach Date: Mon, 4 Jan 2021 12:01:26 -0700 Subject: [PATCH] Add docs for RainMachine entity services (#16103) --- source/_integrations/rainmachine.markdown | 73 ++++++++++++++--------- 1 file changed, 45 insertions(+), 28 deletions(-) diff --git a/source/_integrations/rainmachine.markdown b/source/_integrations/rainmachine.markdown index 5cfba473b88..79cee5654cf 100644 --- a/source/_integrations/rainmachine.markdown +++ b/source/_integrations/rainmachine.markdown @@ -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/).