ZoneMinder
The zoneminder
integration sets up Home Assistant with your ZoneMinder
There is currently support for the following device types within Home Assistant:
Configuration
To add the integrationIntegrations connect and integrate Home Assistant with your devices, services, and more. [Learn more] to your installation, add it to the configuration.yaml
The configuration.yaml file is the main configuration file for Home Assistant. It lists the integrations to be loaded and their specific configurations. In some cases, the configuration needs to be edited manually directly in the configuration.yaml file. Most integrations can be configured in the UI. [Learn more] file.
After changing the configuration.yaml
The configuration.yaml file is the main configuration file for Home Assistant. It lists the integrations to be loaded and their specific configurations. In some cases, the configuration needs to be edited manually directly in the configuration.yaml file. Most integrations can be configured in the UI. [Learn more] file, restart Home Assistant to apply the changes. The integration is now shown on the integrations page under Settings > Devices & services. Its entities are listed on the integration card itself and on the Entities tab.
# Example configuration.yaml entry
zoneminder:
- host: ZM_HOST
Configuration Variables
Path to the CGI script for streaming. This should match PATH_ZMS
in ZM’s “Paths” settings.
/zm/cgi-bin/nph-zms
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
Action
Once loaded, the zoneminder
platform will expose an action (set_run_state
) that can be used to change the current run state of ZoneMinder.
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:
actions:
action: zoneminder.set_run_state
data:
id: ZM_HOST
name: Home
Binary sensor
The zoneminder
binary sensor platform lets you monitor the availability of your ZoneMinder
Each binary_sensor created will be named after the hostname used when configuring the ZoneMinder integration.
Camera
The zoneminder
camera platform lets you monitor the current stream of your ZoneMinder
Configuration
To set it up, add the following information to your configuration.yaml
The configuration.yaml file is the main configuration file for Home Assistant. It lists the integrations to be loaded and their specific configurations. In some cases, the configuration needs to be edited manually directly in the configuration.yaml file. Most integrations can be configured in the UI. [Learn more] file:
# Example configuration.yaml entry
camera:
- platform: zoneminder
Sensor
The zoneminder
sensor platform lets you monitor the current state of your ZoneMinder
To set it up, add the following information to your configuration.yaml
The configuration.yaml file is the main configuration file for Home Assistant. It lists the integrations to be loaded and their specific configurations. In some cases, the configuration needs to be edited manually directly in the configuration.yaml file. Most integrations can be configured in the UI. [Learn more] file:
# Example configuration.yaml entry
sensor:
- platform: zoneminder
include_archived: false
Switch
The zoneminder
switch platform allows you to toggle the current function of all cameras attached to your ZoneMinder
You must have the ZoneMinder integration configured to use this and if ZoneMinder authentication is enabled the account specified in the integration configuration must have “Edit” permission for “System”.
To enable this switch, add the following lines to your configuration.yaml
The configuration.yaml file is the main configuration file for Home Assistant. It lists the integrations to be loaded and their specific configurations. In some cases, the configuration needs to be edited manually directly in the configuration.yaml file. Most integrations can be configured in the UI. [Learn more] file:
# Example configuration.yaml entry
switch:
- platform: zoneminder
command_on: Modect
command_off: Monitor
The default functions installed by ZoneMinder are: None, Monitor, Modect, Record, Mocord, Nodect.