Added Ring Camera component documentation and added new sensors (home-assistant#3682)

tchellomello · fabaff · commit 75c5aaae4020 · 2017-10-21T17:37:40.000+02:00
* Added Ring Camera component documentation and added new sensors

* Kept only the basic as example for the component

* Added scan_interval option to camera ring documentation

* Rephrased statement
diff --git a/source/_components/binary_sensor.ring.markdown b/source/_components/binary_sensor.ring.markdown
@@ -10,6 +10,7 @@ footer: true
 logo: ring.png
 ha_category: Binary Sensor
 ha_release: 0.42
+ha_iot_class: "Cloud Polling"
 ---
 
 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).
@@ -20,15 +21,12 @@ Once you have enabled the [Ring component](/components/ring), add the following
 # Example configuration.yaml entry
 binary_sensor:
   - platform: ring
-    monitored_conditions:
-      - ding
-      - motion
 ```
 
 Configuration variables:
 
-- **monitored_conditions** array (*Required*): Conditions to display in the frontend. The following conditions can be monitored.
+- **monitored_conditions** array (*Optional*): Conditions to display in the frontend. The following conditions can be monitored. If not specified, all conditions below will be enabled.
   - **ding**: Return a boolean value when the doorbell button was pressed.
   - **motion**: Return a boolean value when a movement was detected by the Ring doorbell.
 
-Currently only doorbells are supported by this sensor.
+Currently it supports doorbell, external chimes and stickup cameras.
diff --git a/source/_components/camera.ring.markdown b/source/_components/camera.ring.markdown
@@ -0,0 +1,33 @@
+---
+layout: page
+title: "Ring Binary Camera"
+description: "Instructions on how to integrate your Ring.com devices within Home Assistant."
+date: 2017-10-20 10:00
+sidebar: true
+comments: false
+sharing: true
+footer: true
+logo: ring.png
+ha_category: Camera
+ha_release: 0.57
+ha_iot_class: "Cloud Polling"
+---
+
+To get your [Ring.com](https://ring.com/) cameras working within Home Assistant, please follow the instructions for the general [Ring component](/components/ring).
+
+Once you have enabled the [Ring component](/components/ring), add the following to your `configuration.yaml` file:
+
+```yaml
+# Example configuration.yaml entry
+camera:
+  - platform: ring
+```
+
+Configuration variables:
+
+- **ffmpeg_arguments**: (*Optional*): Extra options to pass to ffmpeg, e.g., image quality or video filter options.
+- **scan_interval**: (*Optional*): How frequently to query for new video. Defaults to 90 seconds.
+
+**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](https://home-assistant.io/components/ffmpeg/) documentation.
+
+Currently it supports doorbell and stickup cameras.
diff --git a/source/_components/sensor.ring.markdown b/source/_components/sensor.ring.markdown
@@ -21,21 +21,17 @@ Once you have enabled the [Ring component](/components/ring), add the following
 # Example configuration.yaml entry
 sensor:
   - platform: ring
-    monitored_conditions:
-      - battery
-      - last_activity
-      - last_ding
-      - last_motion
-      - volume
 ```
 
 Configuration variables:
 
-- **monitored_conditions** array (*Required*): Conditions to display in the frontend. The following conditions can be monitored.
+- **monitored_conditions** array (*Optional*): Conditions to display in the frontend. The following conditions can be monitored. If not specified, all conditions below will be enabled.
   - **battery**: Return the battery level from device
-  - **last_activity**: Return the timestamp from the last event captured (ding/motion/on_demand) 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.
+  - **volume**: Return the volume level from the device.
+  - **wifi_signal_category**: Return the WiFi signal level from the device.
+  - **wifi_signal_strength**: Return the WiFi signal strength (dBm) from the device.
 
-Currently it supports doorbells and external chimes only.
+Currently it supports doorbell, external chimes and stickup cameras.
