From 69c47ce6b6d6902291866fae4a51481bfe16350f Mon Sep 17 00:00:00 2001 From: Paulus Schoutsen Date: Wed, 8 Jan 2020 22:13:50 +0100 Subject: [PATCH 1/3] Migrate Ring to config entry --- source/_integrations/ring.markdown | 106 +++-------------------------- 1 file changed, 11 insertions(+), 95 deletions(-) diff --git a/source/_integrations/ring.markdown b/source/_integrations/ring.markdown index 5b15811f8357..8b9ab4d2aa20 100644 --- a/source/_integrations/ring.markdown +++ b/source/_integrations/ring.markdown @@ -22,14 +22,18 @@ There is currently support for the following device types within Home Assistant: - [Sensor](#sensor) - [Switch](#switch) -Currently only doorbells are supported by this sensor. -

This component does NOT allow for live viewing of your Ring camera within Home Assistant.

## Configuration +Go to the integrations page in your config and click on new integration -> Ring. + +## YAML configuratino + +YAML configuration is around for people that prefer YAML, but it's not prefered! The YAML method does not work with two-factor authentication and it requires you to store your username/password. The normal method only requires you to enter username/password once. + To enable device linked in your [Ring.com](https://ring.com/) account, add the following to your `configuration.yaml` file: ```yaml @@ -48,36 +52,11 @@ password: description: The password for accessing your Ring account. required: true type: string -scan_interval: - description: How frequently to query for new video, or current sensor values in seconds - required: false - type: integer - default: 10 {% endconfiguration %} ## Binary Sensor -Once you have enabled the [Ring integration](/integrations/ring), you can start using a binary sensor. Add the following to your `configuration.yaml` file: - -```yaml -# Example configuration.yaml entry -binary_sensor: - - platform: ring -``` - -{% configuration %} -monitored_conditions: - description: Conditions to display in the frontend. The following conditions can be monitored. If not specified, all conditions below will be enabled. - required: false - type: list - keys: - ding: - description: Return a boolean value when the doorbell button was pressed. - motion: - description: Return a boolean value when a movement was detected by the Ring doorbell. -{% endconfiguration %} - -Currently it supports doorbell, external chimes and stickup cameras. +Once you have enabled the [Ring integration](/integrations/ring), you can start using a binary sensor. Currently it supports doorbell, external chimes and stickup cameras. ## Camera @@ -85,24 +64,7 @@ Currently it supports doorbell, external chimes and stickup cameras. Please note that downloading and playing Ring video will require a Ring Protect plan. -Once you have enabled the [Ring integration](/integrations/ring), you can start using the camera platform. Add the following to your `configuration.yaml` file: - -```yaml -# Example configuration.yaml entry -camera: - - platform: ring -``` - -{% configuration %} -ffmpeg_arguments: - description: Extra options to pass to ffmpeg, e.g., image quality or video filter options. - required: false - type: string -{% endconfiguration %} - -**Note:** To be able to playback the last capture, it is required to install the `ffmpeg` component. Make sure to follow the steps mentioned at [FFMPEG](/integrations/ffmpeg/) documentation. - -Currently it supports doorbell and stickup cameras. +Once you have enabled the [Ring integration](/integrations/ring), you can start using the camera platform. Currently it supports doorbell and stickup cameras. ## Saving the videos captured by your Ring Door Bell @@ -154,58 +116,12 @@ hass.services.call("downloader", "download_file", data) ## Sensor -Once you have enabled the [Ring integration](/integrations/ring), you can start using the sensor platform. Add the following to your `configuration.yaml` file: - -```yaml -# Example configuration.yaml entry -sensor: - - platform: ring -``` - -{% configuration %} -monitored_conditions: - type: list - required: false - description: Conditions to display in the frontend. The following conditions can be monitored. If not specified, all conditions below will be enabled. - keys: - battery: - description: Return the battery level from device. - last_activity: - description: Return the timestamp from the last event captured (ding/motion/on demand) by the Ring doorbell camera. - last_ding: - description: Return the timestamp from the last time the Ring doorbell button was pressed. - last_motion: - description: Return the timestamp from the last motion event captured by the Ring doorbell camera. - volume: - description: Return the volume level from the device. - wifi_signal_category: - description: Return the WiFi signal level from the device. - wifi_signal_strength: - description: Return the WiFi signal strength (dBm) from the device. -{% endconfiguration %} - -Currently it supports doorbell, external chimes and stickup cameras. +Once you have enabled the [Ring integration](/integrations/ring), you can start using the sensor platform. Currently it supports doorbell, external chimes and stickup cameras. ## Switch -Once you have enabled the [Ring integration](/integrations/ring), you can start using the switch platform. Add the following to your `configuration.yaml` file: - -```yaml -# Example configuration.yaml entry -switch: - - platform: ring -``` - -This will add a switch for every camera that supports a siren. Note the siren will only turn on for 30 seconds before automatically turning off. +Once you have enabled the [Ring integration](/integrations/ring), you can start using the switch platform. This will add a switch for every camera that supports a siren. Note the siren will only turn on for 30 seconds before automatically turning off. ## Light -Once you have enabled the [Ring integration](/integrations/ring), you can start using the light platform. Add the following to your `configuration.yaml` file: - -```yaml -# Example configuration.yaml entry -light: - - platform: ring -``` - -This will add a light for every camera that supports a light (such as a flood light). +Once you have enabled the [Ring integration](/integrations/ring), you can start using the light platform. This will add a light for every camera that supports a light (such as a flood light). From 90630f724cd0fb1da1d6f69c78ab34ed99d36bbc Mon Sep 17 00:00:00 2001 From: Klaas Schoute Date: Thu, 9 Jan 2020 00:03:57 +0100 Subject: [PATCH 2/3] :pencil2: Tweak --- source/_integrations/ring.markdown | 1 + 1 file changed, 1 insertion(+) diff --git a/source/_integrations/ring.markdown b/source/_integrations/ring.markdown index 8b9ab4d2aa20..daf42d7e4d3c 100644 --- a/source/_integrations/ring.markdown +++ b/source/_integrations/ring.markdown @@ -11,6 +11,7 @@ ha_category: - Light ha_release: 0.42 ha_iot_class: Cloud Polling +ha_config_flow: true --- The `ring` implementation allows you to integrate your [Ring.com](https://ring.com/) devices in Home Assistant. From 9dcb3ba00da2bf53447cfcc8c020063a5e1992ef Mon Sep 17 00:00:00 2001 From: Franck Nijhof Date: Thu, 9 Jan 2020 10:55:40 +0100 Subject: [PATCH 3/3] :pencil2: Tweaks --- source/_integrations/ring.markdown | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/source/_integrations/ring.markdown b/source/_integrations/ring.markdown index daf42d7e4d3c..a84b2540db08 100644 --- a/source/_integrations/ring.markdown +++ b/source/_integrations/ring.markdown @@ -31,9 +31,9 @@ This component does NOT allow for live viewing of your Ring camera within Home A Go to the integrations page in your config and click on new integration -> Ring. -## YAML configuratino +## YAML configuration -YAML configuration is around for people that prefer YAML, but it's not prefered! The YAML method does not work with two-factor authentication and it requires you to store your username/password. The normal method only requires you to enter username/password once. +YAML configuration is around for people that prefer YAML, but it's not preferred! The YAML method does not work with two-factor authentication and it requires you to store your username/password. The normal method only requires you to enter username/password once. To enable device linked in your [Ring.com](https://ring.com/) account, add the following to your `configuration.yaml` file: @@ -57,7 +57,7 @@ password: ## Binary Sensor -Once you have enabled the [Ring integration](/integrations/ring), you can start using a binary sensor. Currently it supports doorbell, external chimes and stickup cameras. +Once you have enabled the [Ring integration](/integrations/ring), you can start using a binary sensor. Currently, it supports doorbell, external chimes and stickup cameras. ## Camera @@ -65,7 +65,7 @@ Once you have enabled the [Ring integration](/integrations/ring), you can start Please note that downloading and playing Ring video will require a Ring Protect plan. -Once you have enabled the [Ring integration](/integrations/ring), you can start using the camera platform. Currently it supports doorbell and stickup cameras. +Once you have enabled the [Ring integration](/integrations/ring), you can start using the camera platform. Currently, it supports doorbell and stickup cameras. ## Saving the videos captured by your Ring Door Bell @@ -117,7 +117,7 @@ hass.services.call("downloader", "download_file", data) ## Sensor -Once you have enabled the [Ring integration](/integrations/ring), you can start using the sensor platform. Currently it supports doorbell, external chimes and stickup cameras. +Once you have enabled the [Ring integration](/integrations/ring), you can start using the sensor platform. Currently, it supports doorbell, external chimes and stickup cameras. ## Switch @@ -125,4 +125,4 @@ Once you have enabled the [Ring integration](/integrations/ring), you can start ## Light -Once you have enabled the [Ring integration](/integrations/ring), you can start using the light platform. This will add a light for every camera that supports a light (such as a flood light). +Once you have enabled the [Ring integration](/integrations/ring), you can start using the light platform. This will add a light for every camera that supports a light (such as a floodlight).