jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-24 01:37:23 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add documentation for the ZoneMinder runstate sensor and service (#6564)

Browse Source 
* Add documentation for the ZoneMinder runstate sensor and service

* Fix typo
This commit is contained in:
Rohan Kapoor 2018-10-11 12:09:46 -07:00 committed by Franck Nijhof
parent 77536f7adf
commit 87803e5169
2 changed files with 17 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
source/_components/sensor.zoneminder.markdown
View File

@ -14,7 +14,7 @@ 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 and the current state of the cameras. 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'> <p class='note'>
You must have the [ZoneMinder component](/components/zoneminder/) configured to use this sensor. You must have the [ZoneMinder component](/components/zoneminder/) configured to use this sensor.

16
source/_components/zoneminder.markdown
View File

@ -44,3 +44,19 @@ zoneminder:
username: YOUR_USERNAME username: YOUR_USERNAME
password: YOUR_PASSWORD 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
```