Documentation updates on mpd component (long overdue), and the envislink component. (#1028)

This commit is contained in:
Dan Cinnamon 2016-10-01 05:08:35 -05:00 committed by Fabian Affolter
parent 6fe97d0304
commit ba37f710fa
2 changed files with 25 additions and 2 deletions

View File

@ -2,7 +2,7 @@
layout: page layout: page
title: "Envisalink Alarm Control Panel" title: "Envisalink Alarm Control Panel"
description: "Instructions on how to integrate a DSC/Honeywell alarm panel with Home Assistant using an envisalink evl3/evl4 board." description: "Instructions on how to integrate a DSC/Honeywell alarm panel with Home Assistant using an envisalink evl3/evl4 board."
date: 2016-06-19 22:10 date: 2016-09-30 22:45
sidebar: true sidebar: true
comments: false comments: false
sharing: true sharing: true
@ -25,6 +25,8 @@ There is currently support for the following device types within Home Assistant:
This is a fully event-based component. Any event sent by the Envisalink device will be immediately reflected within Home Assistant. This is a fully event-based component. Any event sent by the Envisalink device will be immediately reflected within Home Assistant.
As of 0.29, the alarm_trigger service is supported. It is possible to fire off an envisalink-based alarm directly from Home Assistant. For example, a newer zwave/zigbee sensor can now be integrated into a legacy alarm system using a Home Assistant automation.
An `envisalink` section must be present in the `configuration.yaml` file and contain the following options as required: An `envisalink` section must be present in the `configuration.yaml` file and contain the following options as required:
```yaml ```yaml
@ -39,6 +41,7 @@ envisalink:
evl_version: 3 evl_version: 3
keepalive_interval: 60 keepalive_interval: 60
zonedump_interval: 30 zonedump_interval: 30
panic_type: Police
zones: zones:
11: 11:
name: 'Back Door' name: 'Back Door'
@ -62,6 +65,7 @@ Configuration variables:
- **evl_version** (*Optional*): 3 for evl3, or 4 for evl4. Default: `3` - **evl_version** (*Optional*): 3 for evl3, or 4 for evl4. Default: `3`
- **keepalive_interval** (*Optional*): This is a periodic heartbeat signal (measured in seconds) sent to your Envisalink board to keep it from restarting. This is required for DSC and Honeywell systems. Defaults to `60` seconds. - **keepalive_interval** (*Optional*): This is a periodic heartbeat signal (measured in seconds) sent to your Envisalink board to keep it from restarting. This is required for DSC and Honeywell systems. Defaults to `60` seconds.
- **zonedump_interval** (*Optional*): This is an interval (measured in seconds) where the evl will dump out all zone statuses. This is required for Honeywell systems, which do not properly send zone closure events. DSC boards do not technically need this. Default: `30` - **zonedump_interval** (*Optional*): This is an interval (measured in seconds) where the evl will dump out all zone statuses. This is required for Honeywell systems, which do not properly send zone closure events. DSC boards do not technically need this. Default: `30`
- **panic_type** (*Optional*): Both DSC and Honeywell boards support a "panic" alarm. This is used when the alarm_trigger service is called in home assistant. This determines which type of panic alarm to raise. Default = Police. Valid values are: Police, Fire, Ambulance
- **zones** (*Optional*): Envisalink boards have no way to tell us which zones are actually in use, so each zone must be configured in Home Assistant. For each zone, at least a name must be given. *Note: if no zones are specified, Home Assistant will not load any binary_sensor components.* - **zones** (*Optional*): Envisalink boards have no way to tell us which zones are actually in use, so each zone must be configured in Home Assistant. For each zone, at least a name must be given. *Note: if no zones are specified, Home Assistant will not load any binary_sensor components.*
- **partitions** (*Optional*): Again, Envisalink boards do not tell us what is in use and what is not, so each partition must be configured with a partition name. If no partition parameter is specified, then no alarm_panel or sensor components are loaded. - **partitions** (*Optional*): Again, Envisalink boards do not tell us what is in use and what is not, so each partition must be configured with a partition name. If no partition parameter is specified, then no alarm_panel or sensor components are loaded.

View File

@ -2,7 +2,7 @@
layout: page layout: page
title: "Music Player Daemon (MPD)" title: "Music Player Daemon (MPD)"
description: "Instructions how to integrate Music Player Daemon into Home Assistant." description: "Instructions how to integrate Music Player Daemon into Home Assistant."
date: 2015-06-02 08:00 date: 2016-09-30 23:06
sidebar: true sidebar: true
comments: false comments: false
sharing: true sharing: true
@ -15,6 +15,8 @@ ha_release: pre 0.7
The `mpd` platform allows you to control a [Music Player Daemon](http://www.musicpd.org/) from Home Assistant. Unfortunatly you will not be able to manipulate the playlist (add or delete songs) or add transitions between the songs. The `mpd` platform allows you to control a [Music Player Daemon](http://www.musicpd.org/) from Home Assistant. Unfortunatly you will not be able to manipulate the playlist (add or delete songs) or add transitions between the songs.
Even though no playlist manipulation is possible, it is possible to use the play_media service to load an existing saved playlist as part of an automation or scene.
To add MPD to your installation, add the following to your `configuration.yaml` file: To add MPD to your installation, add the following to your `configuration.yaml` file:
```yaml ```yaml
@ -34,5 +36,22 @@ Configuration variables:
- **location** (*Optional*): Location of your Music Player Daemon. Defaults to "MPD". - **location** (*Optional*): Location of your Music Player Daemon. Defaults to "MPD".
- **password** (*Optional*): Password for your Music Player Daemon. - **password** (*Optional*): Password for your Music Player Daemon.
Example script to load a saved playlist called "DeckMusic" and set the volume:
```yaml
relaxdeck:
sequence:
- service: media_player.play_media
data:
entity_id: media_player.main
media_content_type: playlist
media_content_id: DeckMusic
- service: media_player.volume_set
data:
entity_id: media_player.main
volume_level: 0.60
```
This platform works with [Music Player Daemon](http://www.musicpd.org/) and [mopidy](https://www.mopidy.com/) with [Mopidy-MPD](https://docs.mopidy.com/en/latest/ext/mpd/) as used by [Pi MusicBox](http://www.pimusicbox.com/). This platform works with [Music Player Daemon](http://www.musicpd.org/) and [mopidy](https://www.mopidy.com/) with [Mopidy-MPD](https://docs.mopidy.com/en/latest/ext/mpd/) as used by [Pi MusicBox](http://www.pimusicbox.com/).