Ring
The Ring integration allows you to integrate your Ring.com
There is currently support for the following device types within Home Assistant:
This integration does NOT allow for live viewing of your Ring camera within Home Assistant.
Configuration
To add the Ring integration to your Home Assistant instance, use this My button:
Ring can be auto-discovered by Home Assistant. If an instance was found, it will be shown as Discovered. You can then set it up right away.
Manual configuration steps
If it wasn’t discovered automatically, don’t worry! You can set up a manual integration entry:
-
Browse to your Home Assistant instance.
-
In the bottom right corner, select the
Add Integration button. -
From the list, select Ring.
-
Follow the instructions on screen to complete the setup.
Binary sensor
Once you have enabled the Ring integration, you can start using a binary sensor. Currently, it supports doorbell, external chimes and stickup cameras.
Button
Once you have enabled the Ring integration, you can start using the button platform. Currently, it supports intercom to open the door.
Camera
Please note that downloading and playing Ring video will require a Ring Protect plan.
Once you have enabled the Ring integration, 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 along with either an automation or python_script. First, enable the downloader integration in your configuration by adding the following to your configuration.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>/
:
automation:
alias: "Save the video when the doorbell is pushed"
trigger:
- platform: state
entity_id: binary_sensor.front_doorbell_ding
to: "on"
action:
- 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')}}"
You may consider some modifications in the subdirectory and the filename to suit your needs. For example, you can add the date and the time and extension to the downloaded file:
data:
url: "{{ state_attr('camera.front_door', 'video_url') }}"
subdir: "{{ state_attr('camera.front_door', 'friendly_name') }}/{{ now().strftime('%Y.%m') }}"
filename: "{{ now().strftime('%Y-%m-%d-at-%H-%M-%S') }}.mp4"
the above modification will save the video file under <config>/downloads/<camera_name>/YYYY-MM/YYYY-MM-DD-at-HH-MM-SS.mp4
. You can change the date according to your localization format.
If you want to use python_script
, enable it your configuration.yaml
The configuration.yaml file is the main configuration file for Home Assistant. It lists the integrations to be loaded and their specific configurations. In some cases, the configuration needs to be edited manually directly in the configuration.yaml file. Most integrations can be configured in the UI. [Learn more] file first:
python_script:
You can then use the following python_script
to save the video file:
# obtain ring doorbell camera object
# replace the camera.front_door by your camera entity
ring_cam = hass.states.get("camera.front_door")
subdir_name = f"ring_{ring_cam.attributes.get('friendly_name')}"
# get video URL
data = {
"url": ring_cam.attributes.get("video_url"),
"subdir": subdir_name,
"filename": ring_cam.attributes.get("friendly_name"),
}
# call downloader integration to save the video
hass.services.call("downloader", "download_file", data)
Sensor
Once you have enabled the Ring integration, you can start using the sensor platform. Currently, it supports doorbell, external chimes and stickup cameras.
Switch
Once you have enabled the Ring integration, 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, you can start using the light platform. This will add a light for every camera that supports a light (such as a floodlight).