Skip to content

Updated documentation with new sensor #4094

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 12 commits into from
Dec 24, 2017
33 changes: 33 additions & 0 deletions source/_components/rainbird.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
layout: page
title: "Rain Bird"
description: "Instructions on how to integrate your Rain Bird LNK WiFi Module within Home Assistant."
date: 2017-12-07 12:00
sidebar: true
comments: false
sharing: true
footer: true
logo: rainbird.png
ha_category: Hub
ha_release: 0.61
ha_iot_class: "Local Polling"
---

This `rainbird` component allows interacting with [LNK WiFi](http://www.rainbird.com/landscape/products/controllers/LNK-WiFi.htm) module of the Rain Bird Irrigation system in Home Assistant.

To enable it, add the following to your `configuration.yaml` file:

```yaml
rainbird:
host: '1.1.1.1'
password: 'XXXXXXX'
```

Configuration variables:

- **host** (*Required*): The IP address of your LNK WiFi Module.
- **password** (*Required*): The password for accessing the module.

Finish its configuration by visiting the [Rain Bird sensor](/components/sensor.rainbird/) and [Rain Bird switch](/components/switch.rainbird/) documentation.

Please note that due to the implementation of the API within the LNK Module, there is a concurrency issue. For example, the Rain Bird app will give connection issues (like already a connection active).
32 changes: 32 additions & 0 deletions source/_components/sensor.rainbird.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
layout: page
title: "Rain Bird Sensor"
description: "Instructions on how to integrate your Rain Bird LNK WiFi Module rain sensor within Home Assistant."
date: 2017-08-25 12:00
sidebar: true
comments: false
sharing: true
footer: true
logo: rainbird.png
ha_category: Hub
ha_release: 0.61
ha_iot_class: "Local Polling"
---

This `rainbird` sensor allows interacting with [LNK WiFi](http://www.rainbird.com/landscape/products/controllers/LNK-WiFi.htm) module of the Rain Bird Irrigation system in Home Assistant.

Once you have enabled the [Rain Bird component](/components/rainburd), add the following to your `configuration.yaml` file to enable the rain sensor:

```yaml
# Example configuration.yaml entry
sensor:
- platform: rainbird
monitored_conditions:
- rainsensor
```

Configuration variables:

- **monitored_conditions**: Currently only rainsensor is supported. Returns the sensor level.

Please note that due to the implementation of the API within the LNK Module, there is a concurrency issue. For example, the Rain Bird app will give connection issues (like already a connection active).
7 changes: 1 addition & 6 deletions source/_components/switch.rainbird.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,10 @@ ha_iot_class: "Local Polling"

This `rainbird` switch platform allows interacting with [LNK WiFi](http://www.rainbird.com/landscape/products/controllers/LNK-WiFi.htm) module of the Rain Bird Irrigation system in Home Assistant.

To enable stations as switches inside Home Assistant, add the following to your `configuration.yaml` file:
Once you have enabled the [Rain Bird component](/components/rainbird), add the following to your `configuration.yaml` file:

```yaml
switch:
platform: rainbird
host: '1.1.1.1'
password: 'secretpassword'
sprinkler_1:
zone: 1
friendly_name: "Front sprinklers"
Expand All @@ -36,8 +33,6 @@ switch:

Configuration variables:

- **stickip** (*Required*): The IP address of your LNK WiFi Module.
- **password** (*Required*): The password for accessing the module.
- **zone** (*Required*): Station zone identifier.
- **friendly_name** (*Optional*): Just a friendly name for the station.
- **trigger_time** (*Required*): The default duration to sprinkle the zone.
Expand Down