From 88a0c90ab02da068e2faf83eedb66c0c94478a5b Mon Sep 17 00:00:00 2001 From: Marc Plano-Lesay Date: Thu, 13 Oct 2016 15:39:30 +0200 Subject: [PATCH] Update media_player.yamaha documentation (#1229) * Update media_player.yamaha documentation The documentation wasn't up to date: - `source_ignore` and `source_names` were not documented - source selection has been around for a while. * Rework media_player.yamaha documentation Remove optional attributes from the main sample, add a second, more complete sample. --- source/_components/media_player.yamaha.markdown | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/source/_components/media_player.yamaha.markdown b/source/_components/media_player.yamaha.markdown index 85e9cc2b508..d9eb6138fa1 100644 --- a/source/_components/media_player.yamaha.markdown +++ b/source/_components/media_player.yamaha.markdown @@ -34,11 +34,26 @@ Configuration variables: - **name** (*Optional*): Name of the device - **host** (*Optional*): IP address or hostname of the device +- **source_ignore** (*Optional*): List of sources to hide in the front-end +- **source_names** (*Optional*): Mapping of internal AVR source names to custom ones, allowing to rename e.g. `HDMI1` to `ChromeCast` A few notes: - Not specifying the host variable will result in automatically searching your network for Yamaha Receivers. It will add a media player device for each one. - In some cases, autodiscovery fails due to a known bug in the receiver's firmware. It is possible to manually specify the reveiver's IP address or via it's hostname (if it is discoverably by your DNS) then. - Please note: If adding the IP address or hostname manually, you **must** enable network standby on your receiver, or else startup of Home Assistant will hang if you have your receiver switched off. -- Currently the only controls that are available is Power On/Off, Mute, and Volume control. Other functions such as source select are in progress of being developed. +- Currently, this component supports powering on/off, mute, volume control and source selection. +A full configuration example will look like the sample below: +```yaml +# Example configuration.yaml entry +media_player: + - platform: yamaha + host: 192.168.0.10 + source_ignore: + - "AUX" + - "HDMI6" + source_names: + - HDMI1: "ChromeCast" + - AV4: "Vinyl" +```