Skip to content

Commit 96dc21a

Browse files
mezz64fabaff
authored andcommitted
Update hikvision docs for NVR support (home-assistant#2340)
1 parent 2459f59 commit 96dc21a

File tree

1 file changed

+33
-7
lines changed

1 file changed

+33
-7
lines changed

source/_components/binary_sensor.hikvision.markdown

Lines changed: 33 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,9 @@ ha_release: 0.35
1313
ha_iot_class: "Local Push"
1414
---
1515

16-
The Hikvision Binary Sensor is a platform that parses the event stream of a [Hikvision IP Camera](http://www.hikvision.com/) and presents the camera events to Home Assistant as binary sensors with either an "off" or "on" state.
16+
The Hikvision Binary Sensor is a platform that parses the event stream of a [Hikvision IP Camera or NVR](http://www.hikvision.com/) and presents the camera/nvr events to Home Assistant as binary sensors with either an "off" or "on" state.
1717

18-
The platform will automatically add all sensors to Home Assistant that are configured within the camera interface to "Notify the surveillance center" as a trigger. If you would like to hide a sensor type you can do so by either unchecking "Notify the surveillance center" in the camera configuration or by using the "ignored" customize option detailed below.
18+
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 either unchecking "Notify the surveillance center" in the camera configuration or by using the "ignored" customize option detailed below.
1919

2020
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:
2121

@@ -24,7 +24,16 @@ binary_sensor.front_porch_motion
2424
binary_sensor.front_port_line_crossing
2525
```
2626

27-
This platform should work with all Hikvision cameras, and has been confirmed to work with the following models:
27+
When used with a NVR device the sensors will be appeneded 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:
28+
29+
```
30+
binary_sensor.home_motion_1
31+
binary_sensor.home_motion_2
32+
binary_sensor.home_line_crossing_1
33+
binary_sensor.home_line_crossing_2
34+
```
35+
36+
This platform should work with all Hikvision cameras and nvrs, and has been confirmed to work with the following models:
2837
- DS-2CD3132-I
2938
- DS-2CD2232-I5
3039
- DS-2CD2032-I
@@ -55,7 +64,6 @@ Configuration options for a Hikvision Sensor:
5564
5665
Supported sensor/event types are:
5766
- Motion
58-
- IO Trigger
5967
- Line Crossing
6068
- Field Detection
6169
- Video Loss
@@ -70,9 +78,27 @@ Supported sensor/event types are:
7078
- Bad Video
7179
- PIR Alarm
7280
- Face Detection
81+
- Scene Change Detection
82+
7383
84+
Example of a configuration in your `configuration.yaml` that utilizes the customize options for a camera:
85+
86+
```yaml
87+
binary_sensor:
88+
platform: hikvision
89+
host: 192.168.X.X
90+
port: 80
91+
ssl: False
92+
username: user
93+
password: pass
94+
customize:
95+
motion:
96+
delay: 30
97+
line_crossing:
98+
ignored: True
99+
```
74100

75-
Example of a configuration in your `configuration.yaml` that utilizes the customize options:
101+
Example of a configuration in your `configuration.yaml` that utilizes the customize options for a nvr:
76102

77103
```yaml
78104
binary_sensor:
@@ -83,8 +109,8 @@ binary_sensor:
83109
username: user
84110
password: pass
85111
customize:
86-
sensor_name_1:
112+
motion_1:
87113
delay: 30
88-
sensor_name_2:
114+
field_detection_2:
89115
ignored: True
90116
```

0 commit comments

Comments
 (0)