mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-19 15:26:59 +00:00
🚜 Merges/Redirect Zoneminder component pages (#8583)
This commit is contained in:
Klaas Schoute
Fabian Affolter
parent
4f9ae8a562
commit
c3247ae349
@ -1,22 +0,0 @@
|
|||||||
---
|
|
||||||
layout: page
|
|
||||||
title: "ZoneMinder Binary Sensor"
|
|
||||||
description: "Provides the connectivity from Home Assistant to ZoneMinder."
|
|
||||||
date: 2019-01-18 02:30
|
|
||||||
sidebar: true
|
|
||||||
comments: false
|
|
||||||
sharing: true
|
|
||||||
footer: true
|
|
||||||
logo: zoneminder.png
|
|
||||||
ha_category: Binary Sensor
|
|
||||||
ha_release: 0.87
|
|
||||||
ha_iot_class: "Local Polling"
|
|
||||||
---
|
|
||||||
|
|
||||||
The `zoneminder` binary sensor platform lets you monitor the availability of your [ZoneMinder](https://www.zoneminder.com) install.
|
|
||||||
|
|
||||||
<p class='note'>
|
|
||||||
This platform is automatically loaded by the [ZoneMinder component](/components/zoneminder/) during it's setup.
|
|
||||||
</p>
|
|
||||||
|
|
||||||
Each binary_sensor created will be named after the hostname used when configuring the [ZoneMinder component](/components/zoneminder/).
|
|
||||||
@ -1,30 +0,0 @@
|
|||||||
---
|
|
||||||
layout: page
|
|
||||||
title: "ZoneMinder Camera"
|
|
||||||
description: "View ZoneMinder camera streams within Home Assistant."
|
|
||||||
date: 2017-02-19 18:11
|
|
||||||
sidebar: true
|
|
||||||
comments: false
|
|
||||||
sharing: true
|
|
||||||
footer: true
|
|
||||||
logo: zoneminder.png
|
|
||||||
ha_category: Camera
|
|
||||||
ha_release: 0.39
|
|
||||||
ha_iot_class: "Local Polling"
|
|
||||||
---
|
|
||||||
|
|
||||||
The `zoneminder` camera platform lets you monitor the current stream of your [ZoneMinder](https://www.zoneminder.com) cameras.
|
|
||||||
|
|
||||||
<p class='note'>
|
|
||||||
You must have the [ZoneMinder component](/components/zoneminder/) configured to view the camera stream.
|
|
||||||
</p>
|
|
||||||
|
|
||||||
## {% linkable_title Configuration %}
|
|
||||||
|
|
||||||
To set it up, add the following information to your `configuration.yaml` file:
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
# Example configuration.yaml entry
|
|
||||||
camera:
|
|
||||||
- platform: zoneminder
|
|
||||||
```
|
|
||||||
@ -1,52 +0,0 @@
|
|||||||
---
|
|
||||||
layout: page
|
|
||||||
title: "ZoneMinder Sensor"
|
|
||||||
description: "How to view ZoneMinder monitor functions and events within Home Assistant."
|
|
||||||
date: 2016-10-13 22:57
|
|
||||||
sidebar: true
|
|
||||||
comments: false
|
|
||||||
sharing: true
|
|
||||||
footer: true
|
|
||||||
logo: zoneminder.png
|
|
||||||
ha_category: Sensor
|
|
||||||
ha_release: 0.31
|
|
||||||
ha_iot_class: "Local Polling"
|
|
||||||
---
|
|
||||||
|
|
||||||
The `zoneminder` sensor platform lets you monitor the current state of your [ZoneMinder](https://www.zoneminder.com) install including the number of events, the current state of the cameras and ZoneMinder's current run state.
|
|
||||||
|
|
||||||
<p class='note'>
|
|
||||||
You must have the [ZoneMinder component](/components/zoneminder/) configured to use this sensor.
|
|
||||||
</p>
|
|
||||||
|
|
||||||
To set it up, add the following information to your `configuration.yaml` file:
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
# Example configuration.yaml entry
|
|
||||||
sensor:
|
|
||||||
- platform: zoneminder
|
|
||||||
include_archived: false
|
|
||||||
```
|
|
||||||
|
|
||||||
{% configuration %}
|
|
||||||
include_archived:
|
|
||||||
description: Whether to include archived ZoneMinder events in event counts.
|
|
||||||
required: false
|
|
||||||
default: false
|
|
||||||
type: boolean
|
|
||||||
monitored_conditions:
|
|
||||||
description: Event count sensors to display in the frontend.
|
|
||||||
required: false
|
|
||||||
type: list
|
|
||||||
keys:
|
|
||||||
all:
|
|
||||||
description: All events.
|
|
||||||
month:
|
|
||||||
description: Events in the last month.
|
|
||||||
week:
|
|
||||||
description: Events in the last week.
|
|
||||||
day:
|
|
||||||
description: Events in the last day.
|
|
||||||
hour:
|
|
||||||
description: Events in the last hour.
|
|
||||||
{% endconfiguration %}
|
|
||||||
@ -1,45 +0,0 @@
|
|||||||
---
|
|
||||||
layout: page
|
|
||||||
title: "ZoneMinder Switch"
|
|
||||||
description: "How to toggle the function of ZoneMinder monitors in Home Assistant."
|
|
||||||
date: 2016-10-13 22:57
|
|
||||||
sidebar: true
|
|
||||||
comments: false
|
|
||||||
sharing: true
|
|
||||||
footer: true
|
|
||||||
logo: zoneminder.png
|
|
||||||
ha_category: Switch
|
|
||||||
ha_release: 0.31
|
|
||||||
ha_iot_class: "Local Polling"
|
|
||||||
---
|
|
||||||
|
|
||||||
The `zoneminder` switch platform allows you to toggle the current function of all cameras attached to your [ZoneMinder](https://www.zoneminder.com) instance.
|
|
||||||
|
|
||||||
<p class='note'>
|
|
||||||
You must have the [ZoneMinder component](/components/zoneminder/) configured to use this and if ZoneMinder authentication is enabled the account specified in the component configuration must have "Edit" permission for "System".
|
|
||||||
</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 %}
|
|
||||||
command_on:
|
|
||||||
description: The function you want the camera to run when turned on.
|
|
||||||
required: true
|
|
||||||
type: string
|
|
||||||
command_off:
|
|
||||||
description: The function you want the camera to run when turned off.
|
|
||||||
required: true
|
|
||||||
type: string
|
|
||||||
{% endconfiguration %}
|
|
||||||
|
|
||||||
<p class='note'>
|
|
||||||
The default functions installed by ZoneMinder are: None, Monitor, Modect, Record, Mocord, Nodect.
|
|
||||||
</p>
|
|
||||||
@ -8,13 +8,30 @@ comments: false
|
|||||||
sharing: true
|
sharing: true
|
||||||
footer: true
|
footer: true
|
||||||
logo: zoneminder.png
|
logo: zoneminder.png
|
||||||
ha_category: Hub
|
ha_category:
|
||||||
|
- Hub
|
||||||
|
- Binary Sensor
|
||||||
|
- Camera
|
||||||
|
- Sensor
|
||||||
|
- Switch
|
||||||
featured: false
|
featured: false
|
||||||
ha_release: 0.31
|
ha_release: 0.31
|
||||||
ha_iot_class: "Local Polling"
|
ha_iot_class: "Local Polling"
|
||||||
|
redirect_from:
|
||||||
|
- /components/binary_sensor.zoneminder/
|
||||||
|
- /components/camera.zoneminder/
|
||||||
|
- /components/sensor.zoneminder/
|
||||||
|
- /components/switch.zoneminder/
|
||||||
---
|
---
|
||||||
|
|
||||||
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. Configuring this component will automatically load the [binary_sensor](/components/binary_sensor.zoneminder) which tracks ZoneMinder availability.
|
The ZoneMinder component sets up the integration with your [ZoneMinder](https://www.zoneminder.com) instance.
|
||||||
|
|
||||||
|
There is currently support for the following device types within Home Assistant:
|
||||||
|
|
||||||
|
- [Binary Sensor](#binary-sensor)
|
||||||
|
- [Camera](#camera)
|
||||||
|
- [Sensor](#sensor)
|
||||||
|
- [Switch](#switch)
|
||||||
|
|
||||||
## {% linkable_title Configuration %}
|
## {% linkable_title Configuration %}
|
||||||
|
|
||||||
@ -91,3 +108,92 @@ action:
|
|||||||
id: ZM_HOST
|
id: ZM_HOST
|
||||||
name: Home
|
name: Home
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## {% linkable_title Binary Sensor %}
|
||||||
|
|
||||||
|
The `zoneminder` binary sensor platform lets you monitor the availability of your [ZoneMinder](https://www.zoneminder.com) install.
|
||||||
|
|
||||||
|
Each binary_sensor created will be named after the hostname used when configuring the [ZoneMinder component](/components/zoneminder/).
|
||||||
|
|
||||||
|
## {% linkable_title Camera %}
|
||||||
|
|
||||||
|
The `zoneminder` camera platform lets you monitor the current stream of your [ZoneMinder](https://www.zoneminder.com) cameras.
|
||||||
|
|
||||||
|
## {% linkable_title Configuration %}
|
||||||
|
|
||||||
|
To set it up, add the following information to your `configuration.yaml` file:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
# Example configuration.yaml entry
|
||||||
|
camera:
|
||||||
|
- platform: zoneminder
|
||||||
|
```
|
||||||
|
|
||||||
|
## {% linkable_title Sensor %}
|
||||||
|
|
||||||
|
The `zoneminder` sensor platform lets you monitor the current state of your [ZoneMinder](https://www.zoneminder.com) install including the number of events, the current state of the cameras and ZoneMinder's current run state.
|
||||||
|
|
||||||
|
To set it up, add the following information to your `configuration.yaml` file:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
# Example configuration.yaml entry
|
||||||
|
sensor:
|
||||||
|
- platform: zoneminder
|
||||||
|
include_archived: false
|
||||||
|
```
|
||||||
|
|
||||||
|
{% configuration %}
|
||||||
|
include_archived:
|
||||||
|
description: Whether to include archived ZoneMinder events in event counts.
|
||||||
|
required: false
|
||||||
|
default: false
|
||||||
|
type: boolean
|
||||||
|
monitored_conditions:
|
||||||
|
description: Event count sensors to display in the frontend.
|
||||||
|
required: false
|
||||||
|
type: list
|
||||||
|
keys:
|
||||||
|
all:
|
||||||
|
description: All events.
|
||||||
|
month:
|
||||||
|
description: Events in the last month.
|
||||||
|
week:
|
||||||
|
description: Events in the last week.
|
||||||
|
day:
|
||||||
|
description: Events in the last day.
|
||||||
|
hour:
|
||||||
|
description: Events in the last hour.
|
||||||
|
{% endconfiguration %}
|
||||||
|
|
||||||
|
## {% linkable_title Switch %}
|
||||||
|
|
||||||
|
The `zoneminder` switch platform allows you to toggle the current function of all cameras attached to your [ZoneMinder](https://www.zoneminder.com) instance.
|
||||||
|
|
||||||
|
<p class='note'>
|
||||||
|
You must have the [ZoneMinder component](/components/zoneminder/) configured to use this and if ZoneMinder authentication is enabled the account specified in the component configuration must have "Edit" permission for "System".
|
||||||
|
</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 %}
|
||||||
|
command_on:
|
||||||
|
description: The function you want the camera to run when turned on.
|
||||||
|
required: true
|
||||||
|
type: string
|
||||||
|
command_off:
|
||||||
|
description: The function you want the camera to run when turned off.
|
||||||
|
required: true
|
||||||
|
type: string
|
||||||
|
{% endconfiguration %}
|
||||||
|
|
||||||
|
<p class='note'>
|
||||||
|
The default functions installed by ZoneMinder are: None, Monitor, Modect, Record, Mocord, Nodect.
|
||||||
|
</p>
|
||||||
Loading…
x
Reference in New Issue
Block a user