home-assistant.io/source/_components/zoneminder.markdown

layout	title	description	date	sidebar	comments	sharing	footer	logo	ha_category	featured	ha_release	ha_iot_class
page	ZoneMinder	How to integrate ZoneMinder into Home Assistant.	2016-10-13 22:57	true	false	true	true	zoneminder.png	Hub	false	0.31	Local Polling

The ZoneMinder component sets up the integration with your ZoneMinder instance so that cameras, sensors, and switches can use it. Configuring this component will automatically load the binary_sensor which tracks ZoneMinder availability.

{% linkable_title Configuration %}

# Example configuration.yaml entry
zoneminder:
  - host: ZM_HOST

{% configuration %} host: description: Your ZoneMinder server's host (and optional port), not including the scheme. required: true type: string path: description: Path to your ZoneMinder install. required: false type: string default: "/zm/" path_zms: description: Path to the CGI script for streaming. This should match PATH_ZMS in ZM's "Paths" settings. required: false type: string default: "/zm/cgi-bin/nph-zms" ssl: description: Set to true if your ZoneMinder installation is using SSL. required: false type: boolean default: false verify_ssl: description: Verify the certification of the endpoint. required: false type: boolean default: true username: description: Your ZoneMinder username. required: false type: string password: description: Your ZoneMinder password. Required if OPT_USE_AUTH is enabled in ZM. required: false type: string {% endconfiguration %}

{% linkable_title Full configuration %}

# Example configuration.yaml entry
zoneminder:
  - host: ZM_HOST
    path: ZM_PATH
    path_zms: ZM_PATH_ZMS
    ssl: true
    verify_ssl: true
    username: YOUR_USERNAME
    password: YOUR_PASSWORD

{% linkable_title Service %}

Once loaded, the zoneminder platform will expose a service (set_run_state) that can be used to change the current run state of ZoneMinder.

Service data attribute	Optional	Description
id	no	Host of the ZoneMinder instance.
name	no	Name of the new run state to set.

For example, if your ZoneMinder instance was configured with a run state called "Home", you could write an automation that changes ZoneMinder to the "Home" run state by including the following action:

action:
 service: zoneminder.set_run_state
 data:
   id: ZM_HOST
   name: Home