Reolink IP NVR/camera
The integration allows you to control Reolink
Configuration
To add the Reolink IP NVR/camera integration to your Home Assistant instance, use this My button:
Reolink IP NVR/camera 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 Reolink IP NVR/camera.
-
Follow the instructions on screen to complete the setup.
- On the Reolink device, a user account with admin privileges is needed for the proper operation of this integration.
- The password used for the Reolink device can only contain characters
a-z, A-Z, 0-9 or @$*~_-+=!?.,:;'()[]
. Other special characters will cause encoding issues in the video streams used by this integration and are, therefore, not allowed. When using an incompatible special character in the password, the integration will prompt you to change the password.
Options
Options for Reolink IP NVR/camera can be set via the user interface, by taking the following steps:
- Browse to your Home Assistant instance.
- Go to Settings > Devices & Services.
- If multiple instances of Reolink IP NVR/camera are configured, choose the instance you want to configure.
- Select the integration, then select Configure.
Asterisk (*) next to entities listed in this documentation
If an entity listed below has an asterisk (*) next to its name, it means it is disabled by default. To use such an entity, you must enable the entity first.
Camera streams
This integration creates a few camera entities, one for each stream type with different resolutions:
- Fluent (Low resolution)
- Balanced* (Mid resolution)
- Clear* (High resolution, resource intensive)
- Snapshots Fluent* (Low resolution)
- Snapshots Clear* (High resolution)
The Fluent stream camera entity is enabled by default; the other streams are disabled by default. The Snapshots 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. Dual lens cameras provide additional streams for the second lens.
Binary sensors
Depending on the supported features of the camera, binary sensors are added for:
- Motion detection+
- Visitor+ (Doorbell presses)
- AI person detection+
- AI vehicle detection+
- AI pet detection+
- AI animal detection+
- AI face detection+
- AI package detection+
- Sleep status
+ These sensors receive events using 3 methods in order: ONVIF push, ONVIF long polling or fast polling (every 5 seconds).
The latency for receiving the events is the best for ONVIF push and the worst for fast polling, the fastest available method that is detected to work will be used, and slower methods will not be used.
For redundancy, these sensors are polled every 60 seconds together with the update of all other entities.
Not all camera models generate ONVIF push events for all event types, some binary sensors might, therefore, only be polled.
For list of Reolink products that support ONVIF see the Reolink Support Site
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 (Camera)
- Alarm volume (Home Hub)
- Message volume (Home Hub)
- Chime volume
- Guard return time
- Motion sensitivity
- PIR sensitivity
- AI face sensitivity
- AI person sensitivity
- AI vehicle sensitivity
- AI package sensitivity
- AI pet sensitivity
- AI animal sensitivity
- AI face delay*
- AI person delay*
- AI vehicle delay*
- AI package delay*
- AI pet delay*
- AI animal delay*
- Auto quick reply time
- Auto track limit left
- Auto track limit right
- Auto track disappear time
- Auto track stop time
- Day night switch threshold*
- Image brightness* (default 128)
- Image contrast* (default 128)
- Image saturation* (default 128)
- Image sharpness* (default 128)
- Image hue* (default 128)
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/animal/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.
When a Reolink doorbell is pressed the quick reply message from the Auto quick reply message select entity will be played after Auto quick reply time seconds, unless the Auto quick reply message is set to off.
If the Auto tracking switch entity is enabled, and a object disappears from view OR stops moving for the Auto track disappear time/Auto track stop time, the camera goes back to its original position.
Day night switch threshold determines at which light level the camera switches from Color to Black & white. This value only applies if the Day night mode select is on Auto.
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
- PTZ zoom in*
- PTZ zoom out*
- Guard go to
- Guard set current position
- Restart*
PTZ left, right, up, down, zoom in and zoom out 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.
Action reolink.ptz_move
Some Reolink PTZ cameras can move at different speeds. For those cameras, the reolink.ptz_move
action can be used in combination with the PTZ left, right, up, down, zoom in, or zoom out entity which allows specifying the speed attribute. If the PTZ button entities for a specific camera are not shown under Choose entity under targets of the reolink.ptz_move
action, it means that this camera does not support custom PTZ speeds.
Data attribute | Optional | Description |
---|---|---|
entity_id |
no | Name of the Reolink PTZ button entity to control. For example, button.trackmix_ptz_left . |
speed |
no |
PTZ move speed. For example 10 . |
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
- Play quick reply message
- Auto quick reply message
- Auto track method (Digital, Digital first, Pan/Tilt first)
- Doorbell LED (Stay off, Auto, Auto & always on at night)
- HDR* (Off, On, Auto)
- Chime motion ringtone
- Chime person ringtone
- Chime visitor ringtone
- Hub alarm ringtone
- Hub visitor ringtone
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.
Play quick reply messages/Auto quick reply messages can be recorded in the Reolink phone app where a name is also supplied. New or updated quick reply messages will be loaded into Home Assistant at the start of the integration. When adding new quick reply messages, please restart the Reolink integration.
Action reolink.play_chime
To play a ringtone on a Reolink chime, the reolink.play_chime
action can be used.
Data attribute | Optional | Description |
---|---|---|
device_id |
no | List of device ids of the Reolink Chimes to control. For example, - 12a34b56c7d8ef9ghijklm0n1op2345q . |
ringtone |
no | The ringtone to play. For example operetta . |
Siren entities
If the camera supports a siren, a siren entity will be created. When using the siren turn-on action, the siren will continue to sound until the siren turn-off action 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 action supports setting a volume and a duration (no turn-off action call is needed in that case).
Switch entities
Depending on the supported features of the camera, switch entities are added for:
- Infrared lights in night mode
- Record audio
- Siren on event
- Auto tracking
- Auto focus
- Guard return
- PTZ patrol (start/stop)
- Doorbell button sound
- Record
- Manual record
- Push notifications
- Hub ringtone on event
- Email on event
- FTP upload
- PIR enabled*
- PIR reduce false alarm*
- Chime LED
When the Infrared lights in night mode entity is set to OFF, the infrared LEDs are always OFF. When the Infrared lights in night mode entity is set to ON, the infrared LEDs will be on when the camera is in night vision mode. For more information, see the Day night mode select entity.
For NVRs, a global switch for Record, Push, Hub ringtone on event, Email, and FTP will be available under the NVR device as well as a switch per channel of the NVR under the camera device. The respective feature will only be active for a given channel if both the global and that channel switch are enabled (as is also the case in the Reolink app/client).
Push notifications to a phone will only be provided if the following conditions are met:
- The Push notifications switch in Home Assistant is ON.
- For NVRs, both the global and channel switch are ON.
- The Push-notification in the Reolink App of that phone is ON.
The Push-notification in the Reolink app is independent of the Home Assistant setting. It is also independent of the settings on other phones connected to the same camera. Reolink does this so you have an independent way of turning off push notifications per phone.
The PTZ patrol positions first need to be configured using the Reolink app
Light entities
Depending on the supported features of the camera, light entities are added for:
- Floodlight
- 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.
Sensor entities
Depending on the supported features of the camera, the following sensor entities are added:
- PTZ pan position
- Wi-Fi signal*
- CPU usage*
- HDD/SD storage*
- Battery percentage
- Battery temperature*
- Battery state* (discharging, charging, charge complete)
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
Media browser for playback of recordings
Depending on the support of the camera, the Reolink integration will provide a media browser through which recorded videos of the camera can be accessed. In the sidebar, select “Media” > “Reolink” and select the camera of which you want to see recordings. Optionally, select if you want a high or low resolution stream and select the recording date. Here, all available video files of that day will be shown. Recordings up to 1 month old can be viewed in Home Assistant.
Tested models
The following models have been tested and confirmed to work with a direct link to Home Assistant:
- C1 Pro*
- C2 Pro*
- CX410
- CX810
- E1 Zoom
- E1 Outdoor
- E1 Outdoor PoE
- E1 Outdoor Pro
- RLC-410*
- RLC-410W
- RLC-411*
- RLC-420*
- RLC-423*
- RLC-510A
- RLC-511*
- RLC-511W*
- RLC-511WA
- RLC-520*
- RLC-520A
- RLC-522*
- RLC-810A
- RLC-810WA
- RLC-811A
- RLC-81MA
- RLC-81PA
- RLC-820A
- RLC-822A
- RLC-823A
- RLC-830A
- RLC-833A
- RLC-843A
- RLC-1212A
- RLC-1224A
- RLN8-410 NVR
- RLN16-410 NVR
- RLN36 NVR
- RLN12W NVR
-
Reolink Chime
(when connected to a doorbell) - Reolink Duo WiFi
- Reolink Duo 2 WiFi
- Reolink Duo 3 PoE
- Reolink Duo Floodlight (PoE
and Wi-Fi ) - Reolink Home Hub
- Reolink TrackMix (PoE
and Wi-Fi ) - Reolink Video Doorbell (PoE Black
, Wi-Fi Black , PoE White and Wi-Fi White )
*These models are discontinued and not sold anymore, they will continue to work with Home Assistant.
Tested battery-powered models
Battery-powered Reolink cameras can be used with Home Assistant with the help of a Reolink Home Hub
The following battery-powered models have been tested and confirmed to work through the Reolink Home Hub:
Reolink provides this larger list of battery camera models
Models only compatible using a NVR/Home Hub
The following models are lacking the HTTP web server API and can, therefore, not work directly with this integration. However, these cameras can work with this integration through an NVR or Home Hub in which the NVR/Home Hub is connected to Home Assistant.
- E1 Pro
- E1
- Reolink Lumus
Initial setup
1. Initializing and configuring camera credentials.
A brand new Reolink camera first needs to be connected to the network and initialized. During initialization, the credentials for the camera need to be set. There are several ways to achieve this:
Connecting Reolink via app/client
The recommended way is to use the Reolink mobile app, Windows, or Mac client
Connecting Reolink via a web browser
When your camera has a LAN port (most Wi-Fi cameras also have a LAN port):
- First connect the camera to your network using a LAN cable.
- Find the IP address of the camera (for example by checking in your router) and go to the IP address in a web browser.
- Follow the on-screen instructions to first setup the credentials (use the same credentials in Home Assistant).
- If it is a Wi-Fi camera:
- Go to settings (gear icon) > Network and fill in your Wi-Fi SSID and password.
- If you have both a 2.4 GHz and 5 GHz network, check your camera’s user guide to see which operating frequency is supported.
- After that you can disconnect the LAN cable and the camera will automatically switch to the Wi-Fi connection.
- Go to settings (gear icon) > Network and fill in your Wi-Fi SSID and password.
QR code
You can also connect a Wi-Fi camera using a self-made QR code. Once connected, follow the instructions under Web browser. Create a QR code using ISO-8859-1 character encoding (not UTF-8) with the following XML string:
<QR><S>ssid</S><P>password</P><C>last4</C></QR>
Use the ssid
and password
of your Wi-Fi network.
The last4
are the last 4 digits of the QR code which is printed (on the underside) of the camera itself.
Normally, the digits are printed directly under the QR code. Alternatively, you could scan the QR code and grab the last 4 digits.
Then power up the camera while pointing it at the QR code. It takes about a minute to initialize, read the QR code, and connect to your Wi-Fi.
2. Enabling HTTP/HTTPS ports
Test if you can access the camera by its IP address in your browser https://<your-camera-ip>
. If you cannot, in the Reolink mobile app, Windows, or Mac client
3. Add integration in Home Assistant
Set up the Reolink integration in Home Assistant using the credentials you set in step 1.
Showing the camera in the dashboard
- One way to show the camera in the dashboard is by using the picture glance card.
- For example, you can place arrow buttons on the card to control the camera.
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 Reolink mobile app, Windows, or Mac client
under Settings > top camera model box > Network Information > Advanced (mobile) or Settings > Network > Advanced > Port Settings (PC), see additional instructions on the Reolink site. - On some camera models, the RTMP port needs to be enabled in order for the HTTP(S) port to function properly. Make sure this port is also enabled if you get a
Cannot connect to host
error while one of the HTTP/HTTPS ports is already enabled. - Setting a static IP address for Reolink cameras/NVRs in your router is advisable to prevent (temporal) connectivity issues when the IP address changes.
- Do not set a static IP in the Reolink device itself, but leave the Connection Type on DHCP under Settings > Network > Network Information > Set Up. If you set it to static on the Reolink device itself, this is known to cause incorrect DHCP requests on the network. The incorrect DHCP request causes Home Assistant to use the wrong IP address for the camera, resulting in connection issues. The issue originates from the Reolink firmware, which keeps sending DCHP requests even when you set a static IP address in the Reolink device.
- Reolink cameras can support a limited amount of simultaneous connections. Therefore using third-party software like Frigate, Blue Iris, or Scrypted, or using the ONVIF integration at the same time can cause the camera to drop connections. This results in short unavailabilities of the Reolink entities in Home Assistant. Especially when the connections are coming from the same device (IP) where Home Assistant is running, the Reolink cameras can get confused, dropping one connection in favor of the other originating from the same host IP. If you experience disconnections/unavailabilities of the entities, please first temporarily shut down the other connections (like Frigate) to diagnose if that is the problem. If that is indeed the problem, you could try moving the third-party software to a different host (IP address) since that is known to solve the problem most of the time. You could also try switching the protocol to FLV on Home Assistant and/or the third-party software, as that is known to be less resource-intensive on the camera.
- If the Reolink entities go to unavailable for short periods, the camera may be overloaded with requests resulting in short connection drops. To resolve this, first, check if the integration is using
ONVIF push
instead ofONVIF long polling
(resource intensive) orFast polling
(very resource intensive), see the Reducing latency of motion events section. Moreover, try switching to the FLV streaming protocol which is the least resource-intensive for the camera, see the options section. - If the integration and the browser can’t connect to the camera even after you enable the HTTP/HTTPS ports, try to create a new user on the camera; that fixes the problem in some cases.
Reducing latency of motion events
ONVIF push will result in slightly faster state changes of the binary motion/AI event sensors than ONVIF long polling. Moreover, ONVIF push is less demanding for the camera than ONVIF long polling or fast polling, resulting in potentially less connection issues. However, ONVIF push has some additional network configuration requirements:
-
Reolink products can not push motion events to an HTTPS address (SSL). Therefore, make sure a (local) HTTP address at which HA is reachable is configured under Home Assistant URL in the network settings. A valid address could, for example, be
http://192.168.1.10:8123
where192.168.1.10
is the IP of the Home Assistant device. -
Since a HTTP address is needed, Reolink push is incompatible with a global SSL certificate. Therefore, ensure no Global SSL certificate is configured in the
configuration.yaml
under HTTP. An SSL certificate can still be enforced for external connections, by, for instance, using the NGINX add-onor NGINX Proxy Manager add-on instead of a globally enforced SSL certificate.
To see if a Reolink integration is currently using ONVIF push
, ONVIF long polling
or Fast polling
, download the diagnostics text file and find the "event connection": "ONVIF push"\"ONVIF long polling"\"Fast polling"
in the txt file.