From a175486bb3f450728ef9f0aad0a6f0290bb40185 Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Sun, 2 Oct 2016 17:12:48 +0200 Subject: [PATCH] Minimizing of the configuration sample (#1033) --- .../media_player.braviatv.markdown | 6 ++--- source/_components/media_player.cast.markdown | 5 ++-- source/_components/media_player.cmus.markdown | 20 +++++++-------- .../_components/media_player.denon.markdown | 6 ++--- .../_components/media_player.directv.markdown | 5 +--- .../_components/media_player.firetv.markdown | 6 +---- .../_components/media_player.gpmdp.markdown | 12 ++++----- .../_components/media_player.itunes.markdown | 7 +++--- source/_components/media_player.kodi.markdown | 10 +++----- .../media_player.lg_netcast.markdown | 7 +++--- .../_components/media_player.mpchc.markdown | 7 +++--- source/_components/media_player.mpd.markdown | 8 +++--- .../_components/media_player.onkyo.markdown | 21 ++++++++-------- .../media_player.panasonic_viera.markdown | 11 ++++---- .../_components/media_player.pandora.markdown | 3 ++- .../_components/media_player.pioneer.markdown | 6 ++--- source/_components/media_player.plex.markdown | 3 ++- source/_components/media_player.roku.markdown | 6 ++--- .../media_player.russound_rnet.markdown | 1 + .../media_player.samsungtv.markdown | 10 +++----- .../media_player.snapcast.markdown | 9 +++++-- .../_components/media_player.sonos.markdown | 21 ++++++++-------- .../media_player.squeezebox.markdown | 13 ++++------ .../media_player.universal.markdown | 8 +++--- .../_components/media_player.webostv.markdown | 25 +++++++++++++------ .../_components/media_player.yamaha.markdown | 4 +-- 26 files changed, 117 insertions(+), 123 deletions(-) diff --git a/source/_components/media_player.braviatv.markdown b/source/_components/media_player.braviatv.markdown index affcdff7b22..11ccf5247d0 100644 --- a/source/_components/media_player.braviatv.markdown +++ b/source/_components/media_player.braviatv.markdown @@ -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: diff --git a/source/_components/media_player.cast.markdown b/source/_components/media_player.cast.markdown index 2ffa7180414..cf9c6ea4dc2 100644 --- a/source/_components/media_player.cast.markdown +++ b/source/_components/media_player.cast.markdown @@ -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: diff --git a/source/_components/media_player.cmus.markdown b/source/_components/media_player.cmus.markdown index b26289e46c4..e798889686c 100644 --- a/source/_components/media_player.cmus.markdown +++ b/source/_components/media_player.cmus.markdown @@ -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 diff --git a/source/_components/media_player.denon.markdown b/source/_components/media_player.denon.markdown index f6ab14cae35..59f65696d31 100644 --- a/source/_components/media_player.denon.markdown +++ b/source/_components/media_player.denon.markdown @@ -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: diff --git a/source/_components/media_player.directv.markdown b/source/_components/media_player.directv.markdown index 68ceaf4329a..acfb4995368 100644 --- a/source/_components/media_player.directv.markdown +++ b/source/_components/media_player.directv.markdown @@ -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: diff --git a/source/_components/media_player.firetv.markdown b/source/_components/media_player.firetv.markdown index f5b9de02247..48afd14f0fe 100644 --- a/source/_components/media_player.firetv.markdown +++ b/source/_components/media_player.firetv.markdown @@ -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: diff --git a/source/_components/media_player.gpmdp.markdown b/source/_components/media_player.gpmdp.markdown index 3f35c1d1442..7207e0e0924 100644 --- a/source/_components/media_player.gpmdp.markdown +++ b/source/_components/media_player.gpmdp.markdown @@ -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. diff --git a/source/_components/media_player.itunes.markdown b/source/_components/media_player.itunes.markdown index 3b9b590d3e8..c046755ae2a 100644 --- a/source/_components/media_player.itunes.markdown +++ b/source/_components/media_player.itunes.markdown @@ -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: diff --git a/source/_components/media_player.kodi.markdown b/source/_components/media_player.kodi.markdown index 9e129f99039..24a892aab43 100644 --- a/source/_components/media_player.kodi.markdown +++ b/source/_components/media_player.kodi.markdown @@ -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: diff --git a/source/_components/media_player.lg_netcast.markdown b/source/_components/media_player.lg_netcast.markdown index f60a6255ff9..138eaec8bde 100644 --- a/source/_components/media_player.lg_netcast.markdown +++ b/source/_components/media_player.lg_netcast.markdown @@ -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: diff --git a/source/_components/media_player.mpchc.markdown b/source/_components/media_player.mpchc.markdown index 5b761b2ac3f..4e4c187d0f4 100644 --- a/source/_components/media_player.mpchc.markdown +++ b/source/_components/media_player.mpchc.markdown @@ -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: diff --git a/source/_components/media_player.mpd.markdown b/source/_components/media_player.mpd.markdown index af2d60a87b1..929cbce572b 100644 --- a/source/_components/media_player.mpd.markdown +++ b/source/_components/media_player.mpd.markdown @@ -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: diff --git a/source/_components/media_player.onkyo.markdown b/source/_components/media_player.onkyo.markdown index 950c1031bb2..b8ba67fa4d7 100644 --- a/source/_components/media_player.onkyo.markdown +++ b/source/_components/media_player.onkyo.markdown @@ -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 diff --git a/source/_components/media_player.panasonic_viera.markdown b/source/_components/media_player.panasonic_viera.markdown index 4e1310357b3..861668192a0 100644 --- a/source/_components/media_player.panasonic_viera.markdown +++ b/source/_components/media_player.panasonic_viera.markdown @@ -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. diff --git a/source/_components/media_player.pandora.markdown b/source/_components/media_player.pandora.markdown index efa8c2bc614..bcddae6bde7 100644 --- a/source/_components/media_player.pandora.markdown +++ b/source/_components/media_player.pandora.markdown @@ -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. diff --git a/source/_components/media_player.pioneer.markdown b/source/_components/media_player.pioneer.markdown index e0a20c48c57..8a810bcaf30 100644 --- a/source/_components/media_player.pioneer.markdown +++ b/source/_components/media_player.pioneer.markdown @@ -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: diff --git a/source/_components/media_player.plex.markdown b/source/_components/media_player.plex.markdown index 0ca2d456134..f22c20ba4d4 100644 --- a/source/_components/media_player.plex.markdown +++ b/source/_components/media_player.plex.markdown @@ -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. diff --git a/source/_components/media_player.roku.markdown b/source/_components/media_player.roku.markdown index 4de5d21de9b..5c889727de3 100644 --- a/source/_components/media_player.roku.markdown +++ b/source/_components/media_player.roku.markdown @@ -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. diff --git a/source/_components/media_player.russound_rnet.markdown b/source/_components/media_player.russound_rnet.markdown index 127a30266a4..8e7600e3078 100644 --- a/source/_components/media_player.russound_rnet.markdown +++ b/source/_components/media_player.russound_rnet.markdown @@ -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. diff --git a/source/_components/media_player.samsungtv.markdown b/source/_components/media_player.samsungtv.markdown index bfcb7af4f11..92a8b21fbfc 100644 --- a/source/_components/media_player.samsungtv.markdown +++ b/source/_components/media_player.samsungtv.markdown @@ -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. diff --git a/source/_components/media_player.snapcast.markdown b/source/_components/media_player.snapcast.markdown index 576d639b04d..94f7db9b94c 100644 --- a/source/_components/media_player.snapcast.markdown +++ b/source/_components/media_player.snapcast.markdown @@ -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`. diff --git a/source/_components/media_player.sonos.markdown b/source/_components/media_player.sonos.markdown index 246e9a77ca6..1eeb796772a 100644 --- a/source/_components/media_player.sonos.markdown +++ b/source/_components/media_player.sonos.markdown @@ -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` %} diff --git a/source/_components/media_player.squeezebox.markdown b/source/_components/media_player.squeezebox.markdown index faa59f84265..0a4c1b0adc5 100644 --- a/source/_components/media_player.squeezebox.markdown +++ b/source/_components/media_player.squeezebox.markdown @@ -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. diff --git a/source/_components/media_player.universal.markdown b/source/_components/media_player.universal.markdown index 4883d487e2a..0514b86eff0 100644 --- a/source/_components/media_player.universal.markdown +++ b/source/_components/media_player.universal.markdown @@ -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. diff --git a/source/_components/media_player.webostv.markdown b/source/_components/media_player.webostv.markdown index 76be7fa7f51..12b25fbfbdc 100644 --- a/source/_components/media_player.webostv.markdown +++ b/source/_components/media_player.webostv.markdown @@ -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 +``` diff --git a/source/_components/media_player.yamaha.markdown b/source/_components/media_player.yamaha.markdown index 02d33c7c6e3..85e9cc2b508 100644 --- a/source/_components/media_player.yamaha.markdown +++ b/source/_components/media_player.yamaha.markdown @@ -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: