Added initial documentation to Melnor Raincloud component (#3304)

* Added initial documentation to Melnor Raincloud component

* Added scan interval option on the docs

* Upgraded Raincloud docs to release 0.54

* Upgraded Raincloud docs to release 0.55

* Moved watering_minutes to switch componenet
This commit is contained in:
Marcelo Moreira de Mello 2017-09-29 08:56:06 -04:00 committed by Fabian Affolter
parent fe7f811af9
commit f2373f8eae
5 changed files with 126 additions and 0 deletions

View File

@ -0,0 +1,30 @@
---
layout: page
title: "Melnor Raincloud Binary Sensor"
description: "Instructions on how to integrate your Melnor Raincloud sprinkler system within Home Assistant."
date: 2017-09-04 10:00
sidebar: true
comments: false
sharing: true
footer: true
logo: raincloud.jpg
ha_category: Binary Sensor
ha_release: "0.55"
ha_iot_class: "Cloud Polling"
---
To get your [Melnor RainCloud](https://wifiaquatimer.com) binary sensors working within Home Assistant, please follow the instructions for the general [Raincloud component](/components/raincloud).
Once you have enabled the [Raincloud component](/components/raincloud), add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
binary_sensor:
- platform: raincloud
```
Configuration variables:
- **monitored_conditions** array (*Optional*): Conditions to display in the frontend. If not specified, all conditions below will be enabled by default. The following conditions can be monitored.
- **is_watering**: Return if is currently watering per zone.
- **status**: Return status from the Melnor RainCloud Controller and Melnor RainCloud Faucet.

View File

@ -0,0 +1,33 @@
---
layout: page
title: "Melnor Raincloud"
description: "Instructions on how to integrate your Melnor Raincloud sprinkler system within Home Assistant."
date: 2017-09-04 10:00
sidebar: true
comments: false
sharing: true
footer: true
logo: raincloud.jpg
ha_category: Hub
ha_release: 0.55
---
The `raincloud` component allows you to integrate your [Melnor RainCloud](https://wifiaquatimer.com) sprinkler system in Home Assistant.
To enable it, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
raincloud:
username: you@example.com
password: secret
```
Configuration variables:
- **username** (*Required*): The username for accessing your Melnor RainCloud account.
- **password** (*Required*): The password for accessing your Melnor RainCloud account.
- **scan_interval** (*Optional*): Defines the update interval of the sensor in seconds. Defaults to 20seconds.
Finish its configuration by visiting the [Raincloud binary sensor](/components/binary_sensor.raincloud/), [Raincloud sensor](/components/sensor.raincloud/) and [Raincloud switch](/components/switch.raincloud/) documentation.

View File

@ -0,0 +1,32 @@
---
layout: page
title: "Melnor Raincloud Sensor"
description: "Instructions on how to integrate your Melnor Raincloud sprinkler system within Home Assistant."
date: 2017-09-04 10:00
sidebar: true
comments: false
sharing: true
footer: true
logo: raincloud.jpg
ha_category: Sensor
ha_release: "0.55"
ha_iot_class: "Cloud Polling"
---
To get your [Melnor RainCloud](https://wifiaquatimer.com) sensors working within Home Assistant, please follow the instructions for the general [Raincloud component](/components/raincloud).
Once you have enabled the [Raincloud component](/components/raincloud), add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
sensor:
- platform: raincloud
```
Configuration variables:
- **monitored_conditions** array (*Optional*): Conditions to display in the frontend. If not specified, all conditions below will be enabled by default. The following conditions can be monitored.
- **battery**: Return the battery level the Melnor RainCloud faucet.
- **next_cycle**: Return the next schedulle watering cycle per zone.
- **rain_delay**: Return the number of days the automatic watering will be delayed due to raining per zone.
- **watering_time**: Return the watering remaining minutes per zone.

View File

@ -0,0 +1,31 @@
---
layout: page
title: "Melnor Raincloud Switch"
description: "Instructions on how to integrate your Melnor Raincloud sprinkler system within Home Assistant."
date: 2017-09-04 10:00
sidebar: true
comments: false
sharing: true
footer: true
logo: raincloud.jpg
ha_category: Switch
ha_release: "0.55"
ha_iot_class: "Cloud Polling"
---
To get your [Melnor RainCloud](https://wifiaquatimer.com) binary sensors working within Home Assistant, please follow the instructions for the general [Raincloud component](/components/raincloud).
Once you have enabled the [Raincloud component](/components/raincloud), add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
switch:
- platform: raincloud
```
Configuration variables:
- **watering_minutes** (*Optional*): Value in minutes to watering your garden via frontend. Defaults to 15.
- **monitored_conditions** array (*Optional*): Conditions to display in the frontend. If not specified, all conditions below will be enabled by default. The following conditions can be monitored.
- **auto_watering**: Toggle the watering scheduled per zone.
- **manual_watering**: Toggle manually the watering per zone. It will inherent the value in minutes specified on the RainCloud hub component.

Binary file not shown.

After

Width:  |  Height:  |  Size: 117 KiB