Skip to content

Commit f2373f8

Browse files
tchellomellofabaff
authored andcommitted
Added initial documentation to Melnor Raincloud component (home-assistant#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
1 parent fe7f811 commit f2373f8

File tree

5 files changed

+126
-0
lines changed

5 files changed

+126
-0
lines changed
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
layout: page
3+
title: "Melnor Raincloud Binary Sensor"
4+
description: "Instructions on how to integrate your Melnor Raincloud sprinkler system within Home Assistant."
5+
date: 2017-09-04 10:00
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
logo: raincloud.jpg
11+
ha_category: Binary Sensor
12+
ha_release: "0.55"
13+
ha_iot_class: "Cloud Polling"
14+
---
15+
16+
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).
17+
18+
Once you have enabled the [Raincloud component](/components/raincloud), add the following to your `configuration.yaml` file:
19+
20+
```yaml
21+
# Example configuration.yaml entry
22+
binary_sensor:
23+
- platform: raincloud
24+
```
25+
26+
Configuration variables:
27+
28+
- **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.
29+
- **is_watering**: Return if is currently watering per zone.
30+
- **status**: Return status from the Melnor RainCloud Controller and Melnor RainCloud Faucet.

source/_components/raincloud.markdown

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
layout: page
3+
title: "Melnor Raincloud"
4+
description: "Instructions on how to integrate your Melnor Raincloud sprinkler system within Home Assistant."
5+
date: 2017-09-04 10:00
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
logo: raincloud.jpg
11+
ha_category: Hub
12+
ha_release: 0.55
13+
---
14+
15+
The `raincloud` component allows you to integrate your [Melnor RainCloud](https://wifiaquatimer.com) sprinkler system in Home Assistant.
16+
17+
To enable it, add the following to your `configuration.yaml` file:
18+
19+
```yaml
20+
# Example configuration.yaml entry
21+
22+
raincloud:
23+
username: you@example.com
24+
password: secret
25+
```
26+
27+
Configuration variables:
28+
29+
- **username** (*Required*): The username for accessing your Melnor RainCloud account.
30+
- **password** (*Required*): The password for accessing your Melnor RainCloud account.
31+
- **scan_interval** (*Optional*): Defines the update interval of the sensor in seconds. Defaults to 20seconds.
32+
33+
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.
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
layout: page
3+
title: "Melnor Raincloud Sensor"
4+
description: "Instructions on how to integrate your Melnor Raincloud sprinkler system within Home Assistant."
5+
date: 2017-09-04 10:00
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
logo: raincloud.jpg
11+
ha_category: Sensor
12+
ha_release: "0.55"
13+
ha_iot_class: "Cloud Polling"
14+
---
15+
16+
To get your [Melnor RainCloud](https://wifiaquatimer.com) sensors working within Home Assistant, please follow the instructions for the general [Raincloud component](/components/raincloud).
17+
18+
Once you have enabled the [Raincloud component](/components/raincloud), add the following to your `configuration.yaml` file:
19+
20+
```yaml
21+
# Example configuration.yaml entry
22+
sensor:
23+
- platform: raincloud
24+
```
25+
26+
Configuration variables:
27+
28+
- **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.
29+
- **battery**: Return the battery level the Melnor RainCloud faucet.
30+
- **next_cycle**: Return the next schedulle watering cycle per zone.
31+
- **rain_delay**: Return the number of days the automatic watering will be delayed due to raining per zone.
32+
- **watering_time**: Return the watering remaining minutes per zone.
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
layout: page
3+
title: "Melnor Raincloud Switch"
4+
description: "Instructions on how to integrate your Melnor Raincloud sprinkler system within Home Assistant."
5+
date: 2017-09-04 10:00
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
logo: raincloud.jpg
11+
ha_category: Switch
12+
ha_release: "0.55"
13+
ha_iot_class: "Cloud Polling"
14+
---
15+
16+
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).
17+
18+
Once you have enabled the [Raincloud component](/components/raincloud), add the following to your `configuration.yaml` file:
19+
20+
```yaml
21+
# Example configuration.yaml entry
22+
switch:
23+
- platform: raincloud
24+
```
25+
26+
Configuration variables:
27+
28+
- **watering_minutes** (*Optional*): Value in minutes to watering your garden via frontend. Defaults to 15.
29+
- **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.
30+
- **auto_watering**: Toggle the watering scheduled per zone.
31+
- **manual_watering**: Toggle manually the watering per zone. It will inherent the value in minutes specified on the RainCloud hub component.
117 KB
Loading

0 commit comments

Comments
 (0)