Minimizing of the configuration sample (#1033)

This commit is contained in:
Fabian Affolter 2016-10-02 17:12:48 +02:00 committed by GitHub
parent bb9533e546
commit a175486bb3
26 changed files with 117 additions and 123 deletions

View File

@ -10,6 +10,7 @@ footer: true
logo: bravia.png
ha_category: Media Player
ha_release: 0.23
ha_iot_class: "Local Polling"
---
The `braviatv` platform allows you to control a [Sony Bravia TV](http://www.sony.com).
@ -23,9 +24,8 @@ To add a TV to your installation, add the following to your `configuration.yaml`
```yaml
# Example configuration.yaml entry
media_player:
platform: braviatv
host: 192.168.0.10
name: Living Room TV
- platform: braviatv
host: 192.168.0.10
```
Configuration variables:

View File

@ -10,6 +10,8 @@ footer: true
logo: google_cast.png
ha_category: Media Player
featured: true
ha_release: pre 0.7
ha_iot_class: "Local Polling"
---
@ -20,8 +22,7 @@ Chromecast platform can also be forced to load by adding the following lines to
```yaml
# Example configuration.yaml entry
media_player:
platform: cast
host: 192.168.1.9
- platform: cast
```
Configuration variables:

View File

@ -9,35 +9,33 @@ comments: false
sharing: true
footer: true
ha_category: Media Player
ha_iot_class: "Local Polling"
---
The `cmus` platform allows you to control a [cmus](https://cmus.github.io/) music player on a remote or local machine from Home Assistant.
To add cmus to your installation, add the following to your `configuration.yaml` file if cmus is running on a remote server:
To add cmus to your installation, add the following to your `configuration.yaml` file if running locally it will look like:
```yaml
# Example configuration.yaml entry
media_player:
platform: cmus
host: IP_ADDRESS
port: 3000
password: PASSWORD
name: Desktop Computer Music Player
- platform: cmus
```
if running locally it will look like:
if cmus is running on a remote server:
```yaml
# Example configuration.yaml entry
media_player:
platform: cmus
name: Local Music Player
- platform: cmus
host: IP_ADDRESS
password: PASSWORD
```
Configuration variables:
- **host** Hostname or IP address of the machine running cmus. Note if a remote
cmus is configured that instance must be configured to listen to remote connections, which also requires a password to be set.
- **host** (*Optional*): Hostname or IP address of the machine running cmus. Note if a remote cmus is configured that instance must be configured to listen to remote connections, which also requires a password to be set.
- **password** (*Required if host is set*): Password for your cmus player.
- **port** (*Optional*): Port of the cmus socket, defaults to 3000.
- **name** (*Optional*): The name you'd like to give the cmus player in Home Assistant

View File

@ -9,6 +9,7 @@ sharing: true
footer: true
logo: denon.png
ha_category: Media Player
ha_iot_class: "Local Polling"
---
@ -26,9 +27,8 @@ To add a Denon Network Receiver to your installation, add the following to your
```yaml
# Example configuration.yaml entry
media_player:
platform: denon
host: IP_ADDRESS
name: Music station
- platform: denon
host: IP_ADDRESS
```
Configuration variables:

View File

@ -20,10 +20,7 @@ The `directv` media player platform can also be forced to load by adding the fol
```yaml
# Example configuration.yaml entry
media_player:
platform: directv
host: 192.168.1.10
port: 8080
name: DirecTV Living Room
- platform: directv
```
Configuration variables:

View File

@ -38,11 +38,7 @@ To add FireTV to your installation, add the following to your `configuration.yam
```yaml
# Example configuration.yaml entry
media_player:
platform: firetv
host: localhost
port: 5556
device: livingroom-firetv
name: My Amazon Fire TV
- platform: firetv
```
Configuration variables:

View File

@ -11,9 +11,10 @@ logo: gpmdp.png
ha_category: Media Player
ha_iot_class: "Local Polling"
ha_release: "0.20"
ha_iot_class: "Local Polling"
---
The `gpmdp` media player platform allows you to control a [GPMDP](http://www.googleplaymusicdesktopplayer.com/) instance running on a computer from Home Assistant.
You will have first have to check "Enable playback API" in GPMDP's settings and then add an inbound rule to the firewall to allow access to port 5672 on the computer running GPMDP.
@ -23,13 +24,12 @@ Then just add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
media_player:
platform: gpmdp
host: IP_ADDRESS
name: NAME
- platform: gpmdp
host: IP_ADDRESS
```
Configuration variables:
- **host** (*Required*): IP address of the computer running GPMDP
- **name** (*Optional*): Name of the player
- **host** (*Required*): IP address of the computer running GPMDP.
- **name** (*Optional*): Name of the player.

View File

@ -10,6 +10,7 @@ footer: true
logo: itunes.png
ha_category: Media Player
ha_release: 0.7.3
ha_iot_class: "Local Polling"
---
@ -22,10 +23,8 @@ To add iTunes to your installation, add the following to your `configuration.yam
```yaml
# Example configuration.yaml entry
media_player:
platform: itunes
name: iTunes
host: http://192.168.1.50
port: 8181
- platform: itunes
host: http://192.168.1.50
```
Configuration variables:

View File

@ -11,6 +11,7 @@ logo: kodi.png
ha_category: Media Player
featured: true
ha_release: pre 0.7
ha_iot_class: "Local Polling"
---
@ -21,13 +22,8 @@ To add Kodi to your installation, add the following to your `configuration.yaml`
```yaml
# Example configuration.yaml entry
media_player:
platform: kodi
host: http://192.168.0.123
port: 8080
name: Kodi
username: USERNAME
password: PASSWORD
turn_off_action: shutdown
- platform: kodi
host: http://192.168.0.123
```
Configuration variables:

View File

@ -11,6 +11,7 @@ logo: lg.png
ha_category: Media Player
ha_iot_class: "Local Poll"
ha_release: "0.20"
ha_iot_class: "Local Polling"
---
The `lg_netcast` platform allows you to control a LG Smart TV running NetCast 3.0 (LG Smart TV models released in 2012) and NetCast 4.0 (LG Smart TV models released in 2013). For the new LG WebOS TV's use the [webostv](/components/media_player.webostv) platform.
@ -20,10 +21,8 @@ To add a LG TV to your installation, add the following to your `configuration.ya
```yaml
# Example configuration.yaml entry
media_player:
platform: lg_netcast
host: 192.168.0.20
access_token: 889955
name: Living Room TV
- platform: lg_netcast
host: 192.168.0.20
```
Configuration variables:

View File

@ -11,6 +11,7 @@ logo: mpchc.png
ha_category: Media Player
featured: false
ha_release: 0.25
ha_iot_class: "Local Polling"
---
@ -33,10 +34,8 @@ To add MPC-HC to your installation, add the following to your `configuration.yam
```yaml
# Example configuration.yaml entry
media_player:
platform: mpchc
host: http://192.168.0.123
port: 13579
name: MPC-HC
- platform: mpchc
host: http://192.168.0.123
```
Configuration variables:

View File

@ -10,6 +10,7 @@ footer: true
logo: mpd.png
ha_category: Media Player
ha_release: pre 0.7
ha_iot_class: "Local Polling"
---
@ -20,11 +21,8 @@ To add MPD to your installation, add the following to your `configuration.yaml`
```yaml
# Example configuration.yaml entry
media_player:
platform: mpd
host: IP_ADDRESS
port: 6600
location: bedroom
password: PASSWORD
- platform: mpd
host: IP_ADDRESS
```
Configuration variables:

View File

@ -10,6 +10,7 @@ footer: true
logo: onkyo.png
ha_category: Media Player
ha_release: 0.17
ha_iot_class: "Local Polling"
---
@ -20,21 +21,21 @@ To add an Onkyo receiver to your installation, add the following to your `config
```yaml
# Example configuration.yaml entry
media_player:
platform: onkyo
host: 192.168.1.2
name: receiver
sources:
pc: 'HTPC'
aux1: 'Chromecast'
bd: 'Bluray'
game: 'Wii U'
- platform: onkyo
host: 192.168.1.2
name: receiver
sources:
pc: 'HTPC'
```
Configuration variables:
- **host** (*Optional*): IP address of the device. Example:`192.168.1.2` If not specified, the platform will load any discovered receivers.
- **name** (*Required if host is specified*): Name of the device
- **host** (*Optional*): IP address of the device. Example:`192.168.1.2`. If not specified, the platform will load any discovered receivers.
- **name** (*Required if host is specified*): Name of the device.
- **sources** (*Optional*): A list of mappings from source to source name. Valid sources can be found below. A default list will be used if no source mapping is specified.
List of source names:
- video1
- video2
- video3

View File

@ -11,6 +11,7 @@ logo: panasonic.png
ha_category: Media Player
featured: false
ha_release: 0.17
ha_iot_class: "Local Polling"
---
The `panasonic_viera` platform allows you to control a Panasonic Viera TV.
@ -27,14 +28,12 @@ To add a TV to your installation, add the following to your `configuration.yaml`
```yaml
# Example configuration.yaml entry
media_player:
platform: panasonic_viera
host: 192.168.0.10
port: 55000
name: Living Room TV
- platform: panasonic_viera
host: 192.168.0.10
```
Configuration variables:
- **host** (*Required*): The IP of the Panasonic Viera TV, e.g. `192.168.0.10`
- **port** (*Optional*): The port of your Panasonic Viera TV. Defaults to `55000`
- **host** (*Required*): The IP of the Panasonic Viera TV, e.g. `192.168.0.10`.
- **port** (*Optional*): The port of your Panasonic Viera TV. Defaults to `55000`.
- **name** (*Optional*): The name you would like to give to the Panasonic Viera TV.

View File

@ -11,6 +11,7 @@ logo: pandora.png
ha_category: Media Player
featured: false
ha_release: 0.22
ha_iot_class: "Local Polling"
---
If you have a Pandora account, you can control it from Home Assistant with this media player.
@ -51,7 +52,7 @@ The Pandora player can be loaded by adding the following lines to your `configur
```yaml
# Example configuration.yaml entry
media_player:
platform: pandora
- platform: pandora
```
That's it! Now you will find a media player. If you click it you will find all your stations listed as different sources. If you switch to one, the station will begin playing.

View File

@ -11,6 +11,7 @@ logo: pioneer.png
ha_category: Media Player
featured: false
ha_release: 0.19
ha_iot_class: "Local Polling"
---
The `pioneer` platform allows you to control Pioneer Network Receivers.
@ -20,9 +21,8 @@ To add a Pioneer receiver to your installation, add the following to your `confi
```yaml
# Example configuration.yaml entry
media_player:
platform: pioneer
host: 192.168.0.10
name: Living receiver
- platform: pioneer
host: 192.168.0.10
```
Configuration variables:

View File

@ -11,6 +11,7 @@ logo: plex.png
ha_category: Media Player
featured: true
ha_release: 0.7.4
ha_iot_class: "Local Polling"
---
@ -33,7 +34,7 @@ If you want to enable the plex platform directly, add the following lines to you
```yaml
# Example configuration.yaml entry
media_player:
platform: plex
- platform: plex
```
In case [discovery](/components/discovery/) does not work (GDM disabled or non-local plex server), you can create `~/.homeassistant/plex.conf` manually.

View File

@ -10,6 +10,7 @@ footer: true
logo: roku.png
ha_category: Media Player
ha_release: "0.20"
ha_iot_class: "Local Polling"
---
The [Roku](http://www.roku.com/) media players will be automatically discovered if you enable the [discovery component](/components/discovery/).
@ -19,10 +20,9 @@ The `roku` media player platform can also be forced to load by adding the follow
```yaml
# Example configuration.yaml entry
media_player:
platform: roku
host: 192.168.1.10
- platform: roku
```
Configuration variables:
- **host** *Optional*: Use only if you don't want to scan for devices.
- **host** (*Optional*): Use only if you don't want to scan for devices.

View File

@ -10,6 +10,7 @@ footer: true
logo: russound.png
ha_category: Media Player
ha_release: 0.25
ha_iot_class: "Local Polling"
---
The `russound_rnet` platform allows you to control Russound devices that make use of the RNET protocol.

View File

@ -11,6 +11,7 @@ logo: samsung.png
ha_category: Media Player
featured: false
ha_release: 0.13
ha_iot_class: "Local Polling"
---
The `samsungtv` platform allows you to control a [Samsung Smart TV](http://www.samsung.com/uk/consumer/tv-audio-video/televisions/).
@ -22,16 +23,13 @@ To add a TV to your installation, add the following to your `configuration.yaml`
```yaml
# Example configuration.yaml entry
media_player:
platform: samsungtv
host: 192.168.0.10
port: 55000
name: Living Room TV
timeout: 2
- platform: samsungtv
host: 192.168.0.10
```
Configuration variables:
- **host** (*Required*): The IP of the Samsung Smart TV, eg. 192.168.0.10
- **host** (*Required*): The IP of the Samsung Smart TV, eg. `192.168.0.10^.
- **port** (*Optional*): The port of the Samsung Smart TV. Defaults to 55000.
- **name** (*Optional*): The name you would like to give to the Samsung Smart TV.
- **timeout** (*Optional*): The time-out for the communication with the TV. Defaults to 0.

View File

@ -11,6 +11,7 @@ logo: snapcast.png
ha_category: Media Player
featured: false
ha_release: 0.13
ha_iot_class: "Local Polling"
---
The `snapcast` platform allows you to control [Snapcast](https://github.com/badaix/snapcast) from Home Assistant.
@ -20,6 +21,10 @@ To add Snapcast to your installation, add the following to your `configuration.y
```yaml
# Example configuration.yaml entry
media_player:
platform: snapcast
host: xxx.xxx.xxx.xxx
- platform: snapcast
host: xxx.xxx.xxx.xxx
```
Configuration variables:
- **host** (*Required*): The IP of the device, eg. `192.168.0.10`.

View File

@ -11,6 +11,7 @@ logo: sonos.png
ha_category: Media Player
featured: true
ha_release: 0.7.3
ha_iot_class: "Local Polling"
---
The `sonos` platform allows you to control your [Sonos](http://www.sonos.com) HiFi wireless speakers and audio components from Home Assistant. By default it supports auto-discovery provided by Home Assistant, and you don't need to add anything to your `configuration.yaml`. Alternatively, there are some manual configuration options, listed as follows:
@ -20,7 +21,7 @@ To add your Sonos components to your installation, add the following to your `co
```yaml
# Example configuration.yaml entry using Sonos discovery
media_player:
platform: sonos
- platform: sonos
```
If you have multiple network devices, you can provide the IP address of the device that should be used for Sonos auto-discovery.
@ -28,8 +29,8 @@ If you have multiple network devices, you can provide the IP address of the devi
```yaml
# Example configuration.yaml entry using Sonos discovery on a specific interface
media_player:
platform: sonos
interface_addr: 192.0.2.1
- platform: sonos
interface_addr: 192.0.2.1
```
You can also specify one or more hosts to connect to if they cannot be found with Sonos auto-discovery.
@ -37,8 +38,8 @@ You can also specify one or more hosts to connect to if they cannot be found wit
```yaml
# Example configuration.yaml entry with manually specified addresses
media_player:
platform: sonos
hosts: 192.0.2.25
- platform: sonos
hosts: 192.0.2.25
```
or, for multiple hosts:
@ -46,11 +47,11 @@ or, for multiple hosts:
```yaml
# Example configuration.yaml entry with manually specified addresses
media_player:
platform: sonos
hosts:
- 192.0.2.25
- 192.0.2.26
- 192.0.2.27
- platform: sonos
hosts:
- 192.0.2.25
- 192.0.2.26
- 192.0.2.27
```
### {% linkable_title Service `sonos_snapshot` %}

View File

@ -10,27 +10,24 @@ footer: true
logo: logitech.png
ha_category: Media Player
ha_release: pre 0.7
ha_iot_class: "Local Polling"
---
The Squeezebox platform allows you to control a [Logitech Squeezebox](https://en.wikipedia.org/wiki/Squeezebox_%28network_music_player%29) music player from Home Assistant.
This lets you control Squeezebox hardware like the Classic, Transporter, Duet, Boom, Radio and Touch and of software players like [SoftSqueeze](http://softsqueeze.sourceforge.net/), [SqueezePlayer](https://play.google.com/store/apps/details?id=de.bluegaspode.squeezeplayer) and [SqueezeSlave](http://forums.slimdevices.com/showthread.php?93607-ANNOUNCE-Squeezeslave-1-2-released).
The `squeezebox` platform allows you to control a [Logitech Squeezebox](https://en.wikipedia.org/wiki/Squeezebox_%28network_music_player%29) music player from Home Assistant. This lets you control Squeezebox hardware like the Classic, Transporter, Duet, Boom, Radio and Touch and of software players like [SoftSqueeze](http://softsqueeze.sourceforge.net/), [SqueezePlayer](https://play.google.com/store/apps/details?id=de.bluegaspode.squeezeplayer) and [SqueezeSlave](http://forums.slimdevices.com/showthread.php?93607-ANNOUNCE-Squeezeslave-1-2-released).
To add your Squeezebox player to your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
media_player:
platform: squeezebox
host: IP_ADDRESS
port: 9090
username: USERNAME
password: PASSWORD
- platform: squeezebox
host: IP_ADDRESS
```
Configuration variables:
- **host** (*Required*): The host name or address of the Logitech Media Server, eg. 192.168.1.21.
- **port** (*Optional*): Telnet port to Logitech Media Server, default 9090.
- **port** (*Optional*): Telnet port to Logitech Media Server. Defaults to 9090.
- **username** (*Optional*): The username, if password protection is enabled.
- **password** (*Optional*): The password, if password protection is enabled.

View File

@ -49,10 +49,10 @@ media_player:
Configuration variables:
- **name**: The name to assign the player
- **children**: Ordered list of child media players this entity will control
- **commands** *Optional*: Commands to be overwritten. Possible entries are *turn_on*, *turn_off*, *volume_up*, *volume_down*, and *volume_mute*.
- **attributes** *Optional*: Attributes that can be overwritten. Possible entries are *is_volume_muted* and *state*. The values should be an entity id and state attribute separated by a bar (\|). If the entity id's state should be used, then only the entity id should be provided.
- **name** (*Required*): The name to assign the player
- **children** (*Required*): Ordered list of child media players this entity will control
- **commands** (*Optional*): Commands to be overwritten. Possible entries are *turn_on*, *turn_off*, *volume_up*, *volume_down*, and *volume_mute*.
- **attributes** (*Optional*): Attributes that can be overwritten. Possible entries are *is_volume_muted* and *state*. The values should be an entity id and state attribute separated by a bar (\|). If the entity id's state should be used, then only the entity id should be provided.
The universal media player will primarily imitate one of its *children*. The first child in the list that is active (not idle/off) will be controlled the universal media player. The universal media player will also inherit its state from the first active child. Entities in the *children* list must be media players.

View File

@ -9,7 +9,7 @@ sharing: true
footer: true
logo: webos.png
ha_category: Media Player
ha_iot_class: "Local Poll"
ha_iot_class: "Local Polling"
ha_release: 0.18
---
@ -24,12 +24,6 @@ To add a TV to your installation, add the following to your `configuration.yaml`
media_player:
- platform: webostv
host: 192.168.0.10
name: Living Room TV
customize:
sources:
- livetv
- youtube
- makotv
```
Configuration variables:
@ -39,4 +33,19 @@ Configuration variables:
- **customize** array (*Optional*): List of options to customize.
- ***sources** array (*Optional*): List of hardware inputs.
If you do not provide a host name, all LG WebOS Smart TV's within your network will be auto-discovered if your TV network name is set to `[LG] webOS TV`
If you do not provide a host name, all LG WebOS Smart TV's within your network will be auto-discovered if your TV network name is set to `[LG] webOS TV`.
A full configuration example will look like the sample below:
```yaml
# Example configuration.yaml entry
media_player:
- platform: webostv
host: 192.168.0.10
name: Living Room TV
customize:
sources:
- livetv
- youtube
- makotv
```

View File

@ -28,9 +28,7 @@ To add a Yamaha Network Receiver to your installation, add the following to your
```yaml
# Example configuration.yaml entry
media_player:
platform: yamaha
host: 192.168.1.100
name: 'Basement Receiver'
- platform: yamaha
```
Configuration variables: