Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update ring docs for camera live view #36011

Open
wants to merge 3 commits into
base: next
Choose a base branch
from
Open

Update ring docs for camera live view #36011

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
db156fc
Update ring docs for camera live view
sdb9696 Nov 27, 2024
fcaa4a6
Merge branch 'next' into ring/live_view
sdb9696 Nov 27, 2024
c300645
Add realtime-event-stability to toc
sdb9696 Nov 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 24 additions & 16 deletions source/_integrations/ring.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,15 +42,13 @@ There is currently support for the following device types within Home Assistant:
- [Camera](#camera)
- [Saving the videos captured by your Ring Door Bell](#saving-the-videos-captured-by-your-ring-door-bell)
- [Event](#event)
- [Realtime event stability](#realtime-event-stability)
- [Sensor](#sensor)
- [Siren](#siren)
- [Switch](#switch)
- [Light](#light)
- [Number](#number)

{% note %}
This integration does NOT allow for live viewing of your Ring camera within Home Assistant.
{% endnote %}

{% include integrations/config_flow.md %}

Expand All @@ -66,22 +64,26 @@ Once you have enabled the [Ring integration](/integrations/ring), you can start

## Camera

Once you have enabled the [Ring integration](/integrations/ring), you can start using the camera platform.
Currently, it supports doorbells and stickup cameras.
Two camera entities are provided: `live_view` and `last_recording`.
`last_recording` is disabled by default.

{% important %}
Please note that downloading and playing Ring video will require a Ring Protect plan.
Please note that downloading and playing Ring video from the `last_recording` camera will require a Ring Protect plan.
Comment on lines +67 to +73
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Add clarification about camera entity differences

While the introduction of live_view and last_recording entities is clear, users would benefit from understanding:

  • The difference between these two entities
  • When to use each entity
  • Any limitations or requirements specific to live_view

{% endimportant %}

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

You can save locally the latest video captured by your Ring Door Bell using the [downloader](/integrations/downloader) along with either an [automation](/integrations/automation) or [python_script](/integrations/python_script). First, enable the [downloader](/integrations/downloader) integration in your configuration by adding the following to your `configuration.yaml`.
You can save locally the latest video captured by your Ring Door Bell using the [downloader](/integrations/downloader) along with either an [automation](/integrations/automation) or [python_script](/integrations/python_script).
First, enable the [downloader](/integrations/downloader) integration in your configuration by adding the following to your `configuration.yaml`.

```yaml
downloader:
download_dir: downloads
```

Then you can use the following automation, with the entities from your system, which will save the video file under `<config>/downloads/<camera_name>/<camera_name>/`:
Then you can use the following automation, with the entities from your system, which will save the video file under `<config>/downloads/<camera_name>/<camera_name>.mp4`:

{% raw %}

Expand All @@ -90,14 +92,20 @@ automation:
alias: "Save the video when the doorbell is pushed"
triggers:
- trigger: state
entity_id: binary_sensor.front_doorbell_ding
to: "on"
entity_id: event.front_doorbell_ding
from: null
actions:
- delay:
hours: 0
minutes: 5
seconds: 0
milliseconds: 0
- action: downloader.download_file
data:
url: "{{ state_attr('camera.front_door', 'video_url') }}"
subdir: "{{state_attr('camera.front_door', 'friendly_name')}}"
filename: "{{state_attr('camera.front_door', 'friendly_name')}}"
overwrite: true
url: "{{ state_attr('camera.front_door_last_recording', 'video_url') }}"
subdir: "{{state_attr('camera.front_door_last_recording', 'friendly_name')}}"
filename: "{{state_attr('camera.front_door_last_recording', 'friendly_name')}}.mp4"
```

{% endraw %}
Expand All @@ -107,8 +115,8 @@ You may consider some modifications in the subdirectory and the filename to suit
{% raw %}
```yaml
data:
url: "{{ state_attr('camera.front_door', 'video_url') }}"
subdir: "{{ state_attr('camera.front_door', 'friendly_name') }}/{{ now().strftime('%Y.%m') }}"
url: "{{ state_attr('camera.front_door_last_recording', 'video_url') }}"
subdir: "{{ state_attr('camera.front_door_last_recording', 'friendly_name') }}/{{ now().strftime('%Y.%m') }}"
filename: "{{ now().strftime('%Y-%m-%d-at-%H-%M-%S') }}.mp4"
```
{% endraw %}
Expand All @@ -126,7 +134,7 @@ You can then use the following `python_script` to save the video file:
```python
# obtain ring doorbell camera object
# replace the camera.front_door by your camera entity
ring_cam = hass.states.get("camera.front_door")
ring_cam = hass.states.get("camera.front_door_last_recording")

subdir_name = f"ring_{ring_cam.attributes.get('friendly_name')}"

Expand Down