home-assistant.github.io/source/_components/switch.zoneminder.markdown
Andrey Petrov 8c8b44b644 Added documentation changes for ZM external trigger (#2350)
Signed-off-by: Andrey Petrov <andrey.petrov@gmail.com>
2017-03-30 09:51:22 +02:00

2.2 KiB

layout title description date sidebar comments sharing footer logo ha_category ha_release
page ZoneMinder Switch How to toggle the function of ZoneMinder monitors in Home Assistant. 2016-10-13 22:57 true false true true zoneminder.png Switch 0.31

The zoneminder switch platform allows you to toggle the current function of all cameras attached to your ZoneMinder instance.

You must have the [ZoneMinder component](/components/zoneminder/) configured to use this.

To enable this switch, add the following lines to your configuration.yaml file:

# Example configuration.yaml entry
switch:
  - platform: zoneminder
    command_on: Modect
    command_off: Monitor

Configuration variables:

  • command_on (Required): The function you want the camera to run when turned on.
  • command_off (Required): The function you want the camera to run when turned off.

External trigger mode:

Zoneminder supports "External Trigger", where recording is triggered out-of-band (not with ZM's built-in motion detector). This is useful if your camera takes a while to 'warmup' and you use some external sensor like PIR motion detector. 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. 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.

Configuration variables:

  • ext_trigger_enable (Optional): Enable external trigger switch. This will create 'trigger' switch for each of your monitors.
  • ext_trigger_time (Optional): How long ZM is to record once switch is triggered.
  • ext_trigger_cause (Optional): Text that will appear as 'cause' in ZM event log.

Please note:

  • If you use trigger mode, it is recommended to keep camera in 'Nodect' state, so set both command_on and command_off to Nodect.
  • Make sure OPT_TRIGGER is enabled in ZM
  • If your trigger source can generate "no motion" event, you may want to set ext_trigger_time to some large value.

The default functions installed by ZoneMinder are: None, Monitor, Modect, Record, Mocord, Nodect.