From 0552a65f6523c99d69e7eb16b0a734820144d974 Mon Sep 17 00:00:00 2001 From: Marcelo Moreira de Mello Date: Fri, 10 Mar 2017 02:07:22 -0500 Subject: [PATCH] Added documentation for Ring binary sensor --- .../_components/binary_sensor.ring.markdown | 38 +++++++++++++++++++ 1 file changed, 38 insertions(+) create mode 100644 source/_components/binary_sensor.ring.markdown diff --git a/source/_components/binary_sensor.ring.markdown b/source/_components/binary_sensor.ring.markdown new file mode 100644 index 000000000000..2b6e75db3880 --- /dev/null +++ b/source/_components/binary_sensor.ring.markdown @@ -0,0 +1,38 @@ +--- +layout: page +title: "Ring" +description: "Instructions on how to integrate your Ring.com devices within Home Assistant." +date: 2017-03-10 10:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: ring.png +ha_category: Binary Sensor +ha_release: 0.40 +--- + +The `ring` binary sensor 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 +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.