starkillerOG 69c01f58d7
Add clarification for reolink entities (#26469)
Co-authored-by: Franck Nijhof <frenck@frenck.nl>
2023-03-06 18:52:23 +01:00

7.2 KiB

title, description, ha_category, ha_iot_class, ha_release, ha_domain, ha_codeowners, ha_config_flow, ha_platforms, ha_integration_type, ha_dhcp
title description ha_category ha_iot_class ha_release ha_domain ha_codeowners ha_config_flow ha_platforms ha_integration_type ha_dhcp
Reolink IP NVR/camera Instructions on how to integrate Reolink devices (NVR/cameras) into Home Assistant.
Camera
Local Push 2023.1 reolink
@starkillerOG
true
binary_sensor
camera
integration true

The integration allows you to control Reolink NVRs or cameras.

{% include integrations/config_flow.md %}

A Reolink user account with admin privileges is needed for the proper operation of this integration.

{% include integrations/option_flow.md %} {% configuration_basic %} Protocol: description: Switch between RTSP, RTMP or FLV streaming protocol. {% endconfiguration_basic %}

Camera streams

This integration creates a few camera entities, one for each stream type with different resolutions: Main, Sub, Ext, and Snapshots. The Sub stream camera entity is enabled by default; the other streams are disabled by default. The Images stream provides a sequence of image snapshots giving very low latency at the cost of a very low frame rate; this can be used when the RTMP/RTSP/FLV video stream has too much lag.

Binary sensors

Depending on the supported features of the camera binary sensors are added for:

  • Motion detection
  • Doorbell presses
  • AI person detection
  • AI vehicle detection
  • AI pet detection
  • AI face detection

These sensors are polled every 60 seconds and receive ONVIF push events for immediate updates. Not all camera models generate ONVIF push events for all event types, some binary sensors might, therefore, only be polled.

Number entities

Depending on the supported features of the camera number entities are added for:

  • Optical zoom control
  • Focus control
  • Floodlight turn on brightness
  • Volume
  • Guard return time
  • Motion sensitivity
  • AI face sensitivity
  • AI people sensitivity
  • AI vehicle sensitivity
  • AI pet sensitivity

"Floodlight turn on brightness" controls the brightness of the floodlight when it is turned on internally by the camera (see "Floodlight mode" select entity) or when using the "Floodlight" light entity.

When the camera is not moved and no person/pet/vehicle is detected for the "Guard return time" in seconds, and the "Guard return" switch is ON, the camera will move back to the guard position.

Button entities

Depending on the supported features of the camera button entities are added for:

  • PTZ stop
  • PTZ left
  • PTZ right
  • PTZ up
  • PTZ down
  • PTZ calibrate
  • Guard go to
  • Guard set current position

PTZ left, right, up and down will continually move the camera in the respective position until the PTZ stop is called or the hardware limit is reached.

"Guard set current position" will set the current position as the new guard position.

Select entities

Depending on the supported features of the camera select entities are added for:

  • Floodlight mode (Off, Auto, Schedule)
  • Day night mode (Auto, Color, Black&White)
  • PTZ preset

PTZ preset positions can be set in the Reolink app/windows/web client, the names of the presets will be loaded into Home Assistant at the start of the integration. When adding new preset positions, please restart the Reolink integration.

Siren entities

If the camera supports a siren, a siren entity will be created. When using the siren turn-on service, the siren will continue to sound until the siren turn-off service is called.

In some camera models, there is a delay of up to 5 seconds between the turn-off command and the sound stopping. The siren turn-on service supports setting a volume and a duration (no turn-off service call is needed in that case).

Switch entities

Depending on the supported features of the camera switch entities are added for:

  • Record audio
  • Siren on event
  • Auto tracking
  • Auto focus
  • Guard return

Depending on the supported features of the NVR/host, global switch entities are added for:

  • Record
  • Push notifications
  • Buzzer on event
  • Email on event
  • FTP upload

Light entities

Depending on the supported features of the camera light entities are added for:

  • Floodlight
  • Infra red lights in night mode
  • Status LED

When the floodlight entity is ON always ON, when OFF controlled based on the internal camera floodlight mode (Off, Auto, Schedule), see the "Floodlight mode" select entity.

When IR light entity is OFF always OFF, when ON IR LEDs will be on when the camera is in night vision mode, see the "Day night mode" select entity.

Update entity

An update entity is available that checks for firmware updates every 12 hours. This does the same as pressing the "Check for latest version" in the Reolink applications. Unfortunately this does not always shows the latest available firmware (also not in the Reolink applications). The latest firmware can be downloaded from the Reolink download center and uploaded to the camera/NVR manually.

Tested models

The following models have been tested and confirmed to work:

  • C1 Pro
  • C2 Pro
  • E1 Zoom
  • E1 Outdoor
  • RLC-410W
  • RLC-411
  • RLC-420
  • RLC-510A
  • RLC-511
  • RLC-511W
  • RLC-520
  • RLC-520A
  • RLC-522
  • RLC-810A
  • RLC-811A
  • RLC-820A
  • RLC-823A
  • RLN8-410 NVR
  • RLN16-410 NVR
  • Reolink Duo Floodlight PoE
  • Reolink TrackMix PoE
  • Reolink Video Doorbell (PoE and Wi-Fi)

Battery-powered cameras are not yet supported.

The following models are lacking the HTTP webserver API and can therfore not work with this integration:

  • E1 Pro

Troubleshooting

  • Older firmware versions do not expose the necessary information the integration needs to function. Ensure the camera is updated to the latest firmware prior to setting up the integration. Note that Reolink auto update and check for update functions in the app/windows/web client often do not show the latest available firmware version. Therefore check the version in the Reolink download center online.
  • Ensure at least one of the HTTP/HTTPS ports is enabled in the windows/web client under Settings->Network->Advanced->Port Settings, see additional instructions on the Reolink site.
  • The Reolink NVR only sends event-notifications if motion happens on the camera connected to the first (index "0") channel, therefore the binary sensors of all channels will only be updated when the first channel sees motion. Beta NVR firmware v3.0.0.211_23011204 fixes this issue, you can request beta firmware from reolink support, release firmware is expected in a few weeks.
  • Reolink doorbell presses only generate ONVIF event notifications when the doorbell is directly connected to your network. The doorbell visitor binary sensor will not work when connecting the Reolink doorbell to an NVR. Beta NVR firmware v3.0.0.211_23011204 fixes this issue, you can request beta firmware from reolink support, release firmware is expected in a few weeks.
  • The siren turn-off service does not work on the Reolink NVR, you need to power cycle the NVR/camera to stop the siren. Reolink is aware of this firmware bug and is working on a solution.