Skip to content

Commit f76f45f

Browse files
guillaume1410fabaff
authored andcommitted
Initial documentation for Ryobi cover (home-assistant#5424)
* Initial documentation for Ryobi cover * Update 'ha_release', configuration style and setup
1 parent 59a2ec0 commit f76f45f

File tree

2 files changed

+59
-0
lines changed

2 files changed

+59
-0
lines changed
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
---
2+
layout: page
3+
title: "Ryobi GDO Cover"
4+
description: "Instructions on how to integrate Ryobi Garage Door Opener (RyobiGDO) within Home Assistant."
5+
date: 2018-04-22 09:00
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
logo: ryobi.png
11+
ha_category: Cover
12+
ha_release: 0.71
13+
ha_iot_class: "Cloud Polling"
14+
---
15+
16+
17+
The `ryobi_gdo` cover platform lets you control [Ryobi](https://www.ryobitools.com/gdo/) garage door opener through Home Assistant.
18+
19+
## {% linkable_title Setup %}
20+
21+
In order to be able to use your Ryobi garage door opener, you will have to get the DEVICE_ID_OF_YOUR_COVER (one for each garage door).
22+
23+
The DEVICE_ID_OF_YOUR_COVER can be retrieved using `curl`, simply use your username and password using the following example. Your `DEVICE_ID_OF_YOUR_COVER` will be `varName`:
24+
25+
```bash
26+
$ curl -H "Content-Type: application/json" -X GET \
27+
-d '{"username":"RYOBIGDO_USERNAME","password":"RYOBIGDO_PASSWORD"}' \
28+
https://tti.tiwiconnect.com/api/devices
29+
```
30+
31+
## {% linkable_title Configuration %}
32+
33+
To enable Ryobi covers in your installation, add the following to your `configuration.yaml` file:
34+
35+
```yaml
36+
# Example configuration.yaml entry
37+
cover:
38+
- platform: ryobi_gdo
39+
username: RYOBIGDO_USERNAME
40+
password: RYOBIGDO_PASSWORD
41+
device_id:
42+
- DEVICE_ID_OF_YOUR_COVER#1
43+
- DEVICE_ID_OF_YOUR_COVER#2
44+
```
45+
46+
{% configuration %}
47+
username:
48+
description: Your RyobiGDO account username.
49+
required: true
50+
type: string
51+
password:
52+
description: Your RyobiGDO account password.
53+
required: true
54+
type: string
55+
device_id:
56+
description: List of your doors.
57+
required: true
58+
type: list
59+
{% endconfiguration %}
13.1 KB
Loading

0 commit comments

Comments
 (0)