Add documentation for multiple RainMachine controllers (#7721)

* Add documentation for multiple RainMachine controllers

* Minor changes
This commit is contained in:
Aaron Bach 2018-12-13 14:34:05 -07:00 committed by Fabian Affolter
parent 2830dd77a1
commit fcd3a2e11f
No known key found for this signature in database
GPG Key ID: E23CD2DD36A4397F

View File

@ -23,7 +23,8 @@ To connect to your RainMachine device, add the following to your
```yaml ```yaml
rainmachine: rainmachine:
ip_address: 192.168.1.100 controllers:
- ip_address: 192.168.1.100
password: YOUR_PASSWORD password: YOUR_PASSWORD
``` ```
@ -33,7 +34,8 @@ sections of `configuration.yaml` as below:
```yaml ```yaml
rainmachine: rainmachine:
ip_address: 192.168.1.100 controllers:
- ip_address: 192.168.1.100
password: YOUR_PASSWORD password: YOUR_PASSWORD
binary_sensors: binary_sensors:
# binary sensor configuration options... # binary sensor configuration options...
@ -45,55 +47,55 @@ rainmachine:
{% configuration %} {% configuration %}
ip_address: ip_address:
description: the IP address or hostname of your RainMachine unit description: The IP address or hostname of your RainMachine unit.
required: optional required: optional
type: string type: string
password: password:
description: your RainMachine password. description: Your RainMachine password.
required: true required: true
type: string type: string
port: port:
description: the TCP port used by your unit for the REST API description: The TCP port used by your unit for the REST API.
required: false required: false
type: integer type: integer
default: 8080 default: 8080
ssl: ssl:
description: whether communication with the local device should occur over HTTPS description: Whether communication with the local device should occur over HTTPS.
required: false required: false
type: boolean type: boolean
default: true default: true
scan_interval: scan_interval:
description: the frequency (in seconds) between data updates description: The frequency (in seconds) between data updates.
required: false required: false
type: integer type: integer
default: 60 default: 60
binary_sensors: binary_sensors:
description: binary sensor-related configuration options description: Binary sensor-related configuration options.
required: false required: false
type: map type: map
keys: keys:
monitored_conditions: monitored_conditions:
description: the conditions to create sensors from description: The conditions to create sensors from.
required: false required: false
type: list type: list
default: all (`extra_water_on_hot_days`, `freeze`, `freeze_protection`, `hourly`, `month`, `raindelay`, `rainsensor`, `weekday`) default: all (`extra_water_on_hot_days`, `freeze`, `freeze_protection`, `hourly`, `month`, `raindelay`, `rainsensor`, `weekday`)
sensors: sensors:
description: sensor-related configuration options description: Sensor-related configuration options.
required: false required: false
type: map type: map
keys: keys:
monitored_conditions: monitored_conditions:
description: the conditions to create sensors from description: The conditions to create sensors from.
required: false required: false
type: list type: list
default: all (`freeze_protect_temp`) default: all (`freeze_protect_temp`)
switches: switches:
description: switch-related configuration options description: Switch-related configuration options.
required: false required: false
type: map type: map
keys: keys:
zone_run_time: zone_run_time:
description: the default number of seconds that a zone should run when turned on description: The default number of seconds that a zone should run when turned on.
required: false required: false
type: integer type: integer
default: 600 default: 600