Skip to content

Commit

Permalink
Updated Ring component documentation (#2366)
Browse files Browse the repository at this point in the history
* Updated Ring component documentation

* Add reference to sub pages
  • Loading branch information
tchellomello authored and fabaff committed Apr 1, 2017
1 parent 4eb8f9a commit 06f2f03
Show file tree
Hide file tree
Showing 3 changed files with 50 additions and 18 deletions.
18 changes: 7 additions & 11 deletions source/_components/binary_sensor.ring.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -2,37 +2,33 @@
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
```
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.
33 changes: 33 additions & 0 deletions source/_components/ring.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
layout: page
title: "Ring"
description: "Instructions on how to integrate your Ring.com devices within Home Assistant."
date: 2017-04-01 10:00
sidebar: true
comments: false
sharing: true
footer: true
logo: ring.png
ha_category: Hub
ha_release: 0.42
---

The `ring` implementation allows you to integrate your [Ring.com](https://ring.com/) devices in Home Assistant.

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:

```yaml
# Example configuration.yaml entry
ring:
username: you@example.com
password: secret
```
Configuration variables:
- **username** (*Required*): The username for accessing your Ring account.
- **password** (*Required*): The password for accessing your Ring account.
Finish its configuration by visiting the [Ring binary_sensor page](/components/binary_sensor.ring/) or [Ring sensor page](/components/sensor.ring/).
17 changes: 10 additions & 7 deletions source/_components/sensor.ring.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
```
Expand All @@ -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.

0 comments on commit 06f2f03

Please sign in to comment.