Hikvision
The Hikvision integrationIntegrations connect and integrate Home Assistant with your devices, services, and more. [Learn more] connects your Hikvision IP Camera or NVR to Home Assistant, providing:
- Binary sensors that parse the event stream and present camera/NVR events as sensors with either an “off” or “on” state, and become unavailable while the event stream is disconnected
- Camera entities with RTSP streaming and HTTP snapshot capabilities
The platform will automatically add all sensors to Home Assistant that are configured within the camera/nvr interface to “Notify the surveillance center” as a trigger. If you would like to hide a sensor type you can do so by unchecking “Notify the surveillance center” in the camera configuration.
In order for the sensors to work the hikvision user must have the ‘Remote: Notify Surveillance Center/Trigger Alarm Output’ permission which can be enabled from the user management section of the web interface. If authentication issues persist after permissions are verified, try accessing using an admin user. Certain devices will only authenticate with an admin account despite permissions being set correctly. Also, the ‘WEB Authentication’ needs to be set to ‘digest/basic’ in the security/authentication section. Ensure this is applied on each individual camera in case of using an NVR.
For example, if you configure a camera with the name “Front Porch” that has motion detection and line crossing events enabled to notify the surveillance center the following binary sensors will be added to Home Assistant:
binary_sensor.front_porch_motion
binary_sensor.front_port_line_crossing
When used with a NVR device the sensors will be appended with the channel number they represent. For example, if you configure an NVR with the name “Home” that supports 2 cameras with motion detection and line crossing events enabled to notify the surveillance center the following binary sensors will be added to Home Assistant:
binary_sensor.home_motion_1
binary_sensor.home_motion_2
binary_sensor.home_line_crossing_1
binary_sensor.home_line_crossing_2
This platform should work with all Hikvision cameras and nvrs, and has been confirmed to work with the following models:
- DS-2CD2032-I
- DS-2CD2042WD-I
- DS-2CD2043G0-I
- DS-2CD2142FWD-I
- DS-2CD2155FWD-IS
- DS-2CD2232-I5
- DS-2CD2385G1
- DS-2CD2387G2-LU
- DS-2CD2686G2
- DS-2CD3132-I
- DS-7616NI-K2 (NVR)
- ERI-K104-PR (NVR)
- IPC-D140H(-M)
This platform has also been confirmed to work with the following Hikvision-based NVRs:
- N46PCK (Annke H800 4K NVR)
- N48PAW (Annke 4K NVR)
- Luma NVRs
Configuration
To add the Hikvision device to your Home Assistant instance, use this My button:
Manual configuration steps
If the above My button doesn’t work, you can also perform the following steps manually:
-
Browse to your Home Assistant instance.
-
In the bottom right corner, select the
Add Integration button. -
From the list, select Hikvision.
-
Follow the instructions on screen to complete the setup.
Camera
The integration creates camera entities for each video channel on your Hikvision device. These camera entities support:
- RTSP streaming: Live video streaming using the RTSP protocol
- HTTP snapshots: Still image capture via the camera’s HTTP API
NVR video channel discovery
When connecting to an NVR (Network Video Recorder) that manages multiple cameras, the integration automatically discovers all video channels. A separate camera entity is created for each channel, allowing you to view and manage each connected camera individually.
For example, if you configure an NVR named “Home” with 4 connected cameras, the following camera entities will be created:
camera.home_channel_1
camera.home_channel_2
camera.home_channel_3
camera.home_channel_4
Binary sensor
Event notification methods
The integration detects events using the camera’s event stream. For standalone cameras, events configured to “Notify the surveillance center” are automatically detected.
For NVR devices, the integration supports extended event detection with additional notification methods beyond the standard “center” and “HTTP” methods. The following notification triggers are supported:
- Center: Notify the surveillance center (standard method)
- HTTP: HTTP notification
- Record: Recording trigger
- Email: Email notification trigger
- Beep: Audible beep notification
This extended support allows detection of events that may be configured with non-standard notification methods on your NVR, which some devices use by default.
Supported event types
Supported event types are:
- Motion
- Line Crossing
- Field Detection
- Tamper Detection
- Shelter Alarm
- Disk Full
- Disk Error
- Net Interface Broken
- IP Conflict
- Illegal Access
- Video Mismatch
- Bad Video
- PIR Alarm
- Face Detection
- Scene Change Detection
- I/O
- Unattended Baggage
- Attended Baggage
- Recording Failure
- Exiting Region
- Entering Region
Availability
The binary sensors follow the connection to your device’s event stream. While the stream is down, for example because the device is powered off or unreachable on your network, the sensors show as unavailable instead of keeping their last state. They return to reporting “off” or “on” once the connection is restored.
Event
Some Hikvision devices classify what triggered a smart event, so you can tell a person from a passing car. The integration creates an event entity for each of these kinds of events on each channel:
- Motion
- Line crossing
- Field detection
Each event entity reports one of these event types when it triggers:
humanpetvehicle-
triggered, when the device does not say what caused the event
Whether your device classifies events, and which of these values it uses, depends on the model and the firmware. Devices that do not classify report triggered every time.
Use these entities when you want an automation to react only to a particular kind of trigger, for example to send a notification for a person crossing a line but not for a vehicle. Use the binary sensors instead when you want to know whether an event is currently active.
Removing the integration
This integration follows standard integration removal.
To remove an integration instance from Home Assistant
- Go to Settings > Devices & services and select the integration card.
- From the list of devices, select the integration instance you want to remove.
- Next to the entry, select the three dots
menu. Then, select Delete.