home-assistant.io/source/_integrations/ring.markdown

title	description	ha_category	ha_release	ha_iot_class	ha_config_flow	ha_codeowners	ha_domain
Ring	Instructions on how to integrate your Ring.com devices within Home Assistant.	Doorbell Binary Sensor Camera Sensor Switch Light	0.42	Cloud Polling	true	@balloob	ring

The ring implementation allows you to integrate your Ring.com devices in Home Assistant. Due to recent authentication changes of Ring, you will need to run at least Home Assistant 0.104.

There is currently support for the following device types within Home Assistant:

• Binary Sensor
• Camera
• Sensor
• Switch

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

Configuration

Go to the integrations page in your configuration and click on new integration -> Ring.

YAML configuration is no longer available because it cannot handle two-factor authentication.

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.

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/ring_<camera_name>/:

{% raw %}

automation:
  alias: 'Save the video when the doorbell is pushed'
  trigger:
  - platform: state
    entity_id: binary_sensor.front_doorbell_ding
    to: 'on'
  action:
  - service: 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')}}"

{% endraw %}

If you want to use python_script, enable it your configuration.yaml 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).