From afba57e510a1a4cbb869aee5f160b4a6076a7077 Mon Sep 17 00:00:00 2001 From: Marcelo Moreira de Mello Date: Sat, 1 Apr 2017 04:55:42 -0400 Subject: [PATCH 1/2] Updated Ring component documentation --- .../_components/binary_sensor.ring.markdown | 18 +++++------ source/_components/ring.markdown | 31 +++++++++++++++++++ source/_components/sensor.ring.markdown | 17 +++++----- 3 files changed, 48 insertions(+), 18 deletions(-) create mode 100644 source/_components/ring.markdown diff --git a/source/_components/binary_sensor.ring.markdown b/source/_components/binary_sensor.ring.markdown index 2b6e75db3880..fdf0010de8ec 100644 --- a/source/_components/binary_sensor.ring.markdown +++ b/source/_components/binary_sensor.ring.markdown @@ -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. diff --git a/source/_components/ring.markdown b/source/_components/ring.markdown new file mode 100644 index 000000000000..76b8a7896392 --- /dev/null +++ b/source/_components/ring.markdown @@ -0,0 +1,31 @@ +--- +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. diff --git a/source/_components/sensor.ring.markdown b/source/_components/sensor.ring.markdown index 9ee8ca5b124f..311374cfe0fc 100644 --- a/source/_components/sensor.ring.markdown +++ b/source/_components/sensor.ring.markdown @@ -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. From 52b972aa447e058d0a9a7fe62e78e406f0efb9dd Mon Sep 17 00:00:00 2001 From: Marcelo Moreira de Mello Date: Sat, 1 Apr 2017 05:01:48 -0400 Subject: [PATCH 2/2] Add reference to sub pages --- source/_components/ring.markdown | 2 ++ 1 file changed, 2 insertions(+) diff --git a/source/_components/ring.markdown b/source/_components/ring.markdown index 76b8a7896392..a4afe719a03e 100644 --- a/source/_components/ring.markdown +++ b/source/_components/ring.markdown @@ -29,3 +29,5 @@ 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/).