mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-22 16:56:50 +00:00
Adds documentation for latest RainMachine PR (#5322)
* Adds documentation for latest RainMachine PR * Update version * Update version
This commit is contained in:
parent
fc5605a34a
commit
37bd9896e9
23
source/_components/binary_sensor.rainmachine.markdown
Normal file
23
source/_components/binary_sensor.rainmachine.markdown
Normal file
@ -0,0 +1,23 @@
|
||||
---
|
||||
layout: page
|
||||
title: "RainMachine Binary Sensor"
|
||||
description: "Instructions on how to use RainMachine binary sensors with Home Assistant."
|
||||
date: 2018-05-06 21:26
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: rainmachine.png
|
||||
ha_category: Binary Sensor
|
||||
ha_iot_class: "Cloud Polling"
|
||||
ha_release: 0.71
|
||||
---
|
||||
|
||||
The `rainmachine` binary sensor platform allows you to view crucial sensor data
|
||||
within a [RainMachine smart Wi-Fi sprinkler controller](http://www.rainmachine.com/).
|
||||
|
||||
<p class='note'>
|
||||
You must have the [RainMachine component](https://www.home-assistant.io/components/rainmachine/)
|
||||
configured to use this platform. After configuring that component, binary
|
||||
sensors automatically appear.
|
||||
</p>
|
@ -27,14 +27,18 @@ rainmachine:
|
||||
password: YOUR_PASSWORD
|
||||
```
|
||||
|
||||
To configure switch-related functionality, add configuration options beneath
|
||||
a `switches` key within the `rainmachine` sections of `configuration.yaml`
|
||||
as below:
|
||||
To configure additional functionality, add configuration options beneath
|
||||
a `binary_sensor`, `sensor`, and/or `switches` key within the `rainmachine`
|
||||
sections of `configuration.yaml` as below:
|
||||
|
||||
```yaml
|
||||
rainmachine:
|
||||
ip_address: 192.168.1.100
|
||||
password: YOUR_PASSWORD
|
||||
binary_sensors:
|
||||
# binary sensor configuration options...
|
||||
sensors:
|
||||
# sensor configuration options...
|
||||
switches:
|
||||
# switch configuration options...
|
||||
```
|
||||
@ -58,6 +62,26 @@ ssl:
|
||||
required: false
|
||||
type: boolean
|
||||
default: true
|
||||
binary_sensors:
|
||||
description: binary sensor-related configuration options
|
||||
required: false
|
||||
type: map
|
||||
keys:
|
||||
monitored_conditions:
|
||||
description: the conditions to create sensors from
|
||||
required: false
|
||||
type: list
|
||||
default: all (`extra_water_on_hot_days`, `freeze`, `freeze_protection`, `hourly`, `month`, `raindelay`, `rainsensor`, `weekday`)
|
||||
sensors:
|
||||
description: sensor-related configuration options
|
||||
required: false
|
||||
type: map
|
||||
keys:
|
||||
monitored_conditions:
|
||||
description: the conditions to create sensors from
|
||||
required: false
|
||||
type: list
|
||||
default: all (`freeze_protect_temp`)
|
||||
switches:
|
||||
description: switch-related configuration options
|
||||
required: false
|
||||
@ -69,3 +93,43 @@ switches:
|
||||
type: int
|
||||
default: 600
|
||||
{% endconfiguration %}
|
||||
|
||||
## {% linkable_title Services %}
|
||||
|
||||
### {% linkable_title `rainmachine.start_program` %}
|
||||
|
||||
Start a RainMachine program.
|
||||
|
||||
| Service Data Attribute | Optional | Description |
|
||||
|---------------------------|----------|----------------------|
|
||||
| `program_id` | no | The program to start |
|
||||
|
||||
### {% linkable_title `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 |
|
||||
|
||||
### {% linkable_title `rainmachine.stop_all` %}
|
||||
|
||||
Stop all watering activities.
|
||||
|
||||
### {% linkable_title `rainmachine.stop_program` %}
|
||||
|
||||
Stop a RainMachine program.
|
||||
|
||||
| Service Data Attribute | Optional | Description |
|
||||
|---------------------------|----------|----------------------|
|
||||
| `program_id` | no | The program to stop |
|
||||
|
||||
### {% linkable_title `rainmachine.stop_zone` %}
|
||||
|
||||
Stop a RainMachine zone.
|
||||
|
||||
| Service Data Attribute | Optional | Description |
|
||||
|---------------------------|----------|----------------------|
|
||||
| `zone_id` | no | The zone to stop |
|
||||
|
||||
|
23
source/_components/sensor.rainmachine.markdown
Normal file
23
source/_components/sensor.rainmachine.markdown
Normal file
@ -0,0 +1,23 @@
|
||||
---
|
||||
layout: page
|
||||
title: "RainMachine Sensor"
|
||||
description: "Instructions on how to use RainMachine sensors with Home Assistant."
|
||||
date: 2018-05-06 21:26
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: rainmachine.png
|
||||
ha_category: Sensor
|
||||
ha_iot_class: "Cloud Polling"
|
||||
ha_release: 0.71
|
||||
---
|
||||
|
||||
The `rainmachine` sensor platform allows you to view crucial sensor data within
|
||||
a [RainMachine smart Wi-Fi sprinkler controller](http://www.rainmachine.com/).
|
||||
|
||||
<p class='note'>
|
||||
You must have the [RainMachine component](https://www.home-assistant.io/components/rainmachine/)
|
||||
configured to use this platform. After configuring that component, sensors
|
||||
automatically appear.
|
||||
</p>
|
@ -1,7 +1,7 @@
|
||||
---
|
||||
layout: page
|
||||
title: "RainMachine Switch"
|
||||
description: "Instructions on how to use RainMachine units with Home Assistant."
|
||||
description: "Instructions on how to use RainMachine switches with Home Assistant."
|
||||
date: 2017-08-14 13:30
|
||||
sidebar: true
|
||||
comments: false
|
||||
@ -18,7 +18,7 @@ within a [RainMachine smart Wi-Fi sprinkler controller](http://www.rainmachine.c
|
||||
|
||||
<p class='note'>
|
||||
You must have the [RainMachine component](https://www.home-assistant.io/components/rainmachine/)
|
||||
configured to use this switch. After configuring that component, switches will
|
||||
configured to use this platform. After configuring that component, switches will
|
||||
automatically appear.
|
||||
</p>
|
||||
|
||||
|
Loading…
x
Reference in New Issue
Block a user