ZoneMinder Docs (#1239)

* ZoneMinder Docs

* Better verbage, changing 'url' to 'path'
This commit is contained in:
Richard Cox 2016-10-20 03:56:41 -07:00 committed by Fabian Affolter
parent a50fe02654
commit 455b96509f
4 changed files with 98 additions and 0 deletions

View File

@ -0,0 +1,27 @@
---
layout: page
title: "ZoneMinder Sensor"
description: "Instructions how to integrate ZoneMinder sensors within Home Assistant."
date: 2016-10-13 22:57
sidebar: true
comments: false
sharing: true
footer: true
logo: zoneminder.png
ha_category: Sensor
---
The `ZoneMinder` sensor platform let you monitor the current state of your zoneminder install including the number of events and the current state of the cameras.
<p class='note'>
You must have the [ZoneMinder component](/components/zoneminder/) configured to use those sensors.
</p>
To set it up, add the following information to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
sensor:
platform: zoneminder
```

View File

@ -0,0 +1,40 @@
---
layout: page
title: "ZoneMinder Switch"
description: "Instructions how to integrate ZoneMinder switches into Home Assistant."
date: 2016-10-13 22:57
sidebar: true
comments: false
sharing: true
footer: true
logo: zoneminder.png
ha_category: Switch
---
The `zoneminder` switch platform allows you to toggle the current function of cameras attached to your ZoneMinder instance.
<p class='note'>
You must have the [ZoneMinder component](/components/zoneminder/) configured to use this.
</p>
To enable this switch, add the following lines to your `configuration.yaml` file:
```yaml
# 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.
<p class='note'>
The default functions installed by ZoneMinder are: None, Monitor, Modect, Record, Mocord, Nodect.
</p>

View File

@ -0,0 +1,31 @@
---
layout: page
title: "ZoneMinder"
description: "Instructions 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: Camera
featured: false
---
The ZoneMinder component is the main component to integrate all the sensors and switches for controlling your ZoneMinder instance.
```yaml
# Example configuration.yaml entry
zoneminder:
host: ZM_HOST
path: ZM_PATH
username: USERNAME
password: PASSWORD
```
Configuration variables:
- **host** (*Required*): Your ZoneMinder server.
- **path** (*Optional*): Path to your ZoneMinder install (default: /zm/)
- **username** (*Optional*): Your ZoneMinder username.
- **password** (*Optional*): Your ZoneMinder password.

Binary file not shown.

After

Width:  |  Height:  |  Size: 7.5 KiB