Skip to content

Commit 8c8b44b

Browse files
anpetrovfabaff
authored andcommitted
Added documentation changes for ZM external trigger (home-assistant#2350)
Signed-off-by: Andrey Petrov <andrey.petrov@gmail.com>
1 parent 51ca0c4 commit 8c8b44b

File tree

2 files changed

+18
-0
lines changed

2 files changed

+18
-0
lines changed

source/_components/switch.zoneminder.markdown

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,23 @@ Configuration variables:
3434
- **command_on** (*Required*): The function you want the camera to run when turned on.
3535
- **command_off** (*Required*): The function you want the camera to run when turned off.
3636
37+
External trigger mode:
38+
39+
Zoneminder supports "External Trigger", where recording is triggered out-of-band (not with ZM's built-in motion detector).
40+
This is useful if your camera takes a while to 'warmup' and you use some external sensor like PIR motion detector.
41+
In this case camera can be kept in 'Nodect' state so it is warm and ready to capture. Once external trigger is activated camera starts recording immediately.
42+
This way you will not lose any frames and actually see how your S.W.A.T team deals with the intruder stepped into your nuclear facility.
43+
44+
Configuration variables:
45+
46+
- **ext_trigger_enable** (*Optional*): Enable external trigger switch. This will create 'trigger' switch for each of your monitors.
47+
- **ext_trigger_time** (*Optional*): How long ZM is to record once switch is triggered.
48+
- **ext_trigger_cause** (*Optional*): Text that will appear as 'cause' in ZM event log.
49+
50+
Please note:
51+
* If you use trigger mode, it is recommended to keep camera in 'Nodect' state, so set both **command_on** and **command_off** to Nodect.
52+
* Make sure OPT_TRIGGER is enabled in ZM
53+
* If your trigger source can generate "no motion" event, you may want to set **ext_trigger_time** to some large value.
3754
3855
<p class='note'>
3956
The default functions installed by ZoneMinder are: None, Monitor, Modect, Record, Mocord, Nodect.

source/_components/zoneminder.markdown

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ Configuration variables:
2828
- **ssl** (*Optional*): Set to `True` if your ZoneMinder installation is using SSL. Default to `False`.
2929
- **username** (*Optional*): Your ZoneMinder username.
3030
- **password** (*Optional*): Your ZoneMinder password. Required if `OPT_USE_AUTH` is enabled in ZM.
31+
- **trigger_port** (*Optional*): ZM's external trigger port. Default is 6802
3132

3233
### {% linkable_title Full configuration %}
3334

0 commit comments

Comments
 (0)