jeena/home-assistant.github.io
1
0
Fork 0
Code Issues Pull requests Projects Packages Wiki Activity Actions

Updated Ring component documentation (#2366)

Browse source 
* Updated Ring component documentation

* Add reference to sub pages
This commit is contained in:
Marcelo Moreira de Mello 2017-04-01 06:38:43 -04:00 • committed by Fabian Affolter
parent 4eb8f9a142
commit 06f2f03dcb
3 changed files with 50 additions and 18 deletions
Download patch file Download diff file Expand all files Collapse all files

18
source/_components/binary_sensor.ring.markdown
View file

@ -2,28 +2,24 @@
layout: page
title: "Ring"
description: "Instructions on how to integrate your Ring.com devices within Home Assistant."
date: 2017-03-10 10:00
date: 2017-04-01 10:00
sidebar: true
comments: false
sharing: true
footer: true
logo: ring.png
ha_category: Binary Sensor
ha_release: 0.40
ha_release: 0.42
---
The `ring` binary sensor allows you to integrate your [Ring.com](https://ring.com/) devices in Home Assistant.
To get your [Ring.com](https://ring.com/) binary sensors working within Home Assistant, please follow the instructions for the general [Ring component](/components/ring).
Currently only doorbells are supported by this sensor.
To enable device linked in your [Ring.com](https://ring.com/) account, add the following to your `configuration.yaml` file:
Once you have enabled the [Ring component](/components/ring), add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
binary_sensor:
- platform: ring
username: USERNAME
password: PASSWORD
monitored_conditions:
- ding
- motion
@ -31,8 +27,8 @@ binary_sensor:
Configuration variables:
- **username** (*Required*): The username for accessing your Ring account.
- **password** (*Required*): The password for accessing your Ring account.
- **monitored_conditions** array (*Required*): Conditions to display in the frontend. The following conditions can be monitored.
- **ding**: Return a boolean value when the doorbell button was pressed.
- **motion**: Return a boolean value when the a moviment was detected by the Ring doorbell.
- **motion**: Return a boolean value when a moviment was detected by the Ring doorbell.
Currently only doorbells are supported by this sensor.