mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-05-25 04:16:52 +00:00
91 lines
2.5 KiB
Markdown
91 lines
2.5 KiB
Markdown
---
|
|
layout: page
|
|
title: "ZoneMinder"
|
|
description: "How to integrate ZoneMinder into Home Assistant."
|
|
date: 2016-10-13 22:57
|
|
sidebar: true
|
|
comments: false
|
|
sharing: true
|
|
footer: true
|
|
logo: zoneminder.png
|
|
ha_category: Hub
|
|
featured: false
|
|
ha_release: 0.31
|
|
ha_iot_class: "Local Polling"
|
|
---
|
|
|
|
The ZoneMinder component sets up the integration with your [ZoneMinder](https://www.zoneminder.com) instance so that [cameras](/components/camera.zoneminder/), [sensors](/components/sensor.zoneminder/), and [switches](/components/switch.zoneminder) can use it.
|
|
|
|
## {% linkable_title Configuration %}
|
|
|
|
```yaml
|
|
# 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 %}
|
|
|
|
```yaml
|
|
# 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 |
|
|
|:-----------------------|:---------|:----------------------------------|
|
|
| `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](/getting-started/automation/) that changes ZoneMinder to the "Home" run state by including the following [action](/getting-started/automation-action/):
|
|
```yaml
|
|
action:
|
|
service: zoneminder.set_run_state
|
|
data:
|
|
name: Home
|
|
```
|