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

17
source/_components/sensor.ring.markdown
View file

@ -2,7 +2,7 @@
layout: page
title: "Ring"
description: "Instructions on how to integrate your Ring.com devices within Home Assistant."
date: 2017-03-05 10:00
date: 2017-04-01 10:00
sidebar: true
comments: false
sharing: true
@ -12,20 +12,19 @@ ha_category: Sensor
ha_release: "0.40"
---
The `ring` sensor allows you to integrate your [Ring.com](https://ring.com/) devices in Home Assistant.
Currently it supports doorbells and external chimes only.
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).
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
sensor:
- platform: ring
username: USERNAME
password: PASSWORD
monitored_conditions:
- battery
- last_activity
- last_ding
- last_motion
- volume
```
@ -36,5 +35,9 @@ Configuration variables:
- **scan_interval** (*Optional*): Defines the update interval of the sensor in seconds. The default is 30 seconds.
- **monitored_conditions** array (*Required*): Conditions to display in the frontend. The following conditions can be monitored.
- **battery**: Return the battery level from device
- **last_activity**: Return the timestamp from the last event captured by the Ring doorbell camera
- **last_activity**: Return the timestamp from the last event captured (ding/motion/on_demand) by the Ring doorbell camera
- **last_ding**: Return the timestamp from the last time the Ring doorbell button was pressed
- **last_motion**: Return the timestamp from the last motion event captured by the Ring doorbell camera
- **volume**: Return the volume level from the device. Currently supported by external chimes and doorbells.
Currently it supports doorbells and external chimes only.