Added new docs for port and ssl config parameters (RainMachine) (#3180)

* Added new docs for `port` and `ssl` config parameters

* Modified version number

* Fixing version
This commit is contained in:
Aaron Bach 2017-08-15 12:34:41 -06:00 committed by Martin Hjelmare
parent 9f24985108
commit 5272dca6db

View File

@ -2,7 +2,7 @@
layout: page layout: page
title: "RainMachine Switch" title: "RainMachine Switch"
description: "Instructions on how to use RainMachine units with Home Assistant." description: "Instructions on how to use RainMachine units with Home Assistant."
date: 2017-08-04 12:00 date: 2017-08-14 13:30
sidebar: true sidebar: true
comments: false comments: false
sharing: true sharing: true
@ -23,7 +23,7 @@ The platform allows for either local (i.e., directly across the LAN) or remote
dictate what your configuration should look like. dictate what your configuration should look like.
For local access, specify the IP address/hostname of your RainMachine unit For local access, specify the IP address/hostname of your RainMachine unit
and your RainMachine password: , your RainMachine password, and optionally, the device's HTTP port:
```yaml ```yaml
switch: switch:
@ -43,11 +43,16 @@ switch:
Configuration Variables: Configuration Variables:
- **ip_address** (*Optional*): The IP address of your RainMachine unit - **ip_address** (*Optional*): the IP address of your RainMachine unit; cannot be
- **email** (*Optional*): Your RainMachine username/email used with the `email` parameter
- **password** (*Required*): Your RainMachine password - **email** (*Optional*): your RainMachine username/email; cannot be used with the
- **zone_run_time** (*Optional*): The number of seconds that a zone should run when `ip_address` parameter
turned on; defaults to 600 (10 minutes) - **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 %} ## {% linkable_title Controlling Your Device %}