mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-06-01 15:56:49 +00:00
d7fcb153de
* Adds docs for RainMachine component/hub * Removing references to remote API * Collaborator-requested changes * Adding new info (per home-assistant/home-assistant#14225) * Collaborator-requested changes * Collaborator-requested changes * Revert "Collaborator-requested changes" This reverts commit 34f75ffab911dcd9a9ae3163645c7c6e9dbf54ee. * I think I got it this time... * Collaborator-requested changes * Collaborator-requested changes * Small tweak
72 lines
1.7 KiB
Markdown
72 lines
1.7 KiB
Markdown
---
|
|
layout: page
|
|
title: "RainMachine"
|
|
description: "Instructions on how to integrate RainMachine units within Home Assistant."
|
|
date: 2018-04-25 20:32
|
|
sidebar: true
|
|
comments: false
|
|
sharing: true
|
|
footer: true
|
|
logo: rainmachine.png
|
|
ha_category: Hub
|
|
ha_release: 0.69
|
|
ha_iot_class: "Cloud Polling"
|
|
---
|
|
|
|
The `rainmachine` component is the main component to integrate all platforms
|
|
related to [RainMachine smart Wi-Fi sprinkler controllers](http://www.rainmachine.com/).
|
|
|
|
## {% linkable_title Base Configuration %}
|
|
|
|
To connect to your RainMachine device, add the following to your
|
|
`configuration.yaml` file:
|
|
|
|
```yaml
|
|
rainmachine:
|
|
ip_address: 192.168.1.100
|
|
password: YOUR_PASSWORD
|
|
```
|
|
|
|
To configure switch-related functionality, add configuration options beneath
|
|
a `switches` key within the `rainmachine` sections of `configuration.yaml`
|
|
as below:
|
|
|
|
```yaml
|
|
rainmachine:
|
|
ip_address: 192.168.1.100
|
|
password: YOUR_PASSWORD
|
|
switches:
|
|
# switch configuration options...
|
|
```
|
|
|
|
{% configuration %}
|
|
ip_address:
|
|
description: the IP address or hostname of your RainMachine unit
|
|
required: optional
|
|
type: string
|
|
password:
|
|
description: your RainMachine password.
|
|
required: true
|
|
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
|
|
switches:
|
|
description: switch-related configuration options
|
|
required: false
|
|
type: map
|
|
keys:
|
|
zone_run_time:
|
|
description: the default number of seconds that a zone should run when turned on
|
|
required: false
|
|
type: int
|
|
default: 600
|
|
{% endconfiguration %}
|