jeena/home-assistant.github.io
1
0
Fork 0
Code Issues Pull requests Projects Packages Wiki Activity Actions

Update configuration samples (#5041)

Browse source 
* Update configuration samples

* Minor changes
This commit is contained in:
Fabian Affolter 2018-03-29 10:02:47 +02:00 • committed by GitHub
parent 41a1a06af1
commit 2851b2a606
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
50 changed files with 473 additions and 312 deletions
Download patch file Download diff file Expand all files Collapse all files

69
source/_components/switch.rainmachine.markdown
View file

@ -13,23 +13,19 @@ ha_iot_class: "Cloud Polling"
ha_release: 0.51
---
The `rainmachine` switch platform allows you to control programs and zones within
a [RainMachine smart Wi-Fi sprinkler controller](http://www.rainmachine.com/).
The `rainmachine` switch platform allows you to control programs and zones within a [RainMachine smart Wi-Fi sprinkler controller](http://www.rainmachine.com/).
## {% linkable_title Configuring the Platform %}
The platform allows for either local (i.e., directly across the LAN) or remote
(i.e., through RainMachine's cloud API) access; the route you choose will
dictate what your configuration should look like.
The platform allows for either local (i.e., directly across the LAN) or remote (i.e., through RainMachine's cloud API) access; the route you choose will dictate what your configuration should look like.
For local access, specify the IP address/hostname of your RainMachine unit
, your RainMachine password, and optionally, the device's HTTP port:
For local access, specify the IP address/hostname of your RainMachine unit, your RainMachine password, and optionally, the device's HTTP port:
```yaml
switch:
platform: rainmachine
ip_address: 192.168.1.100
password: my_password_123
password: YOUR_PASSWORD
```
For remote access, specify your RainMachine username/email and password:
@ -38,34 +34,48 @@ For remote access, specify your RainMachine username/email and password:
switch:
platform: rainmachine
email: user@host.com
password: my_password_123
password: YOUR_PASSWORD
```
Configuration Variables:
{% configuration %}
password:
description: Your RainMachine password.
required: true
type: string
email:
description: "Your RainMachine username/email. Cannot be used with the `ip_address` parameter."
required: false
type: string
ip_address:
description: "The IP address of your RainMachine unit; cannot be used with the `email` parameter."
required: optional
type: string
port:
description: The TCP port used by your unit for the REST API.
required: false
type: int
default: 8080
ssl:
description: Whether communication with the local device should occur over HTTPS.
required: false
type: boolean
default: true
zone_run_time:
description: The number of seconds that a zone should run when turned on.
required: false
type: int
default: 600
{% endconfiguration %}
- **ip_address** (*Optional*): the IP address of your RainMachine unit; cannot be
used with the `email` parameter
- **email** (*Optional*): your RainMachine username/email; cannot be used with the
`ip_address` parameter
- **password** (*Required*): your RainMachine password
- **port** (*Optional*): the TCP port used by your unit for the REST API (default: 8080)
- **ssl** (*Optional*): whether communication with the local device should occur
over HTTPS (default: true)
- **zone_run_time** (*Optional*): the number of seconds that a zone should run when
turned on (default: 600)
## {% linkable_title Controlling Your Device %}
After Home Assistant loads, you will see new switches for every enabled program
and zone. These work as expected:
After Home Assistant loads, you will see new switches for every enabled program and zone. These work as expected:
- Program On/Off: starts/stops a program
- Zone On/Off: starts/stops a zone (using the `zone_run_time` parameter to
determine how long to run for)
- Zone On/Off: starts/stops a zone (using the `zone_run_time` parameter to determine how long to run for)
Programs and zones are linked. If a program is running its final zone, you will
see both the program and zone switches turned on; turning either one off will
turn the other one off (just like in the web app).
Programs and zones are linked. If a program is running its final zone, you will see both the program and zone switches turned on; turning either one off will turn the other one off (just like in the web app).
## {% linkable_title Weblink %}
@ -83,7 +93,4 @@ You can find `<YOUR_DEVICE_ID>` by logging into [https://my.rainmachine.com](htt
## {% linkable_title For Awareness %}
The remote RainMachine API currently has two broken operations (i.e., they return
error codes): starting a program and stopping a program. Please note that
starting/stopping programs with the remote API is disabled until RainMachine
can fix the issue.
The remote RainMachine API currently has two broken operations (i.e., they return error codes): starting a program and stopping a program. Please note that starting/stopping programs with the remote API is disabled until RainMachine can fix the issue.