Update yamaha configuration variables (#6665)

* Update yamaha configuration variables

* Remove old config list
This commit is contained in:
Luuk 2018-10-11 17:32:24 +02:00 committed by Franck Nijhof
parent 1154e982cd
commit 11c90acdb9
2 changed files with 45 additions and 14 deletions

View File

@ -30,15 +30,33 @@ To add a Yamaha Network Receiver to your installation, add the following to your
media_player:
- platform: yamaha
```
Configuration variables:
- **name** (*Optional*): Name of the device. This overrides the
default name (often model number) that is returned by 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 one to rename e.g., `HDMI1` to `ChromeCast`
- **zone_ignore** (*Optional*): List of zones to hide in the front-end
- **zone_names** (*Optional*): Mapping of zone names to custom ones, allowing one to rename e.g., `Main_Zone` to `Family Room`
{% configuration %}
name:
description: Name of the device. This overrides the default name (often model number) that is returned by the device.
required: false
type: string
host:
description: IP address or hostname of the device.
required: false
type: string
source_ignore:
description: List of sources to hide in the front-end.
required: false
type: list
source_names:
description: Mapping of internal AVR source names to custom ones, allowing one to rename e.g., `HDMI1` to `ChromeCast`.
required: false
type: list
zone_ignore:
description: List of zones to hide in the front-end.
required: false
type: list
zone_names:
description: Mapping of zone names to custom ones, allowing one to rename e.g., `Main_Zone` to `Family Room`.
required: false
type: list
{% endconfiguration %}
### {% linkable_title Discovery notes %}

View File

@ -24,15 +24,28 @@ media_player:
- platform: yamaha_musiccast
host: 192.168.xx.xx
```
Configuration variables:
- **host** (*Required*): IP address or hostname of the device
- **port** (*Optional*): UDP source port. If multiple devices are present, specify a different port per device
- **interval_seconds** (*Optional*): Polling interval (default: 480 seconds = 8 minutes)
{% configuration %}
host:
description: IP address or hostname of the device.
required: true
type: string
port:
description: UDP source port. If multiple devices are present, specify a different port per device.
required: false
type: integer
interval_seconds:
description: Polling interval in seconds.
required: false
type: integer
default: 480
{% endconfiguration %}
A few notes:
### {% linkable_title Supported operations %}
- Currently, this component supports powering on/off, mute, volume control, and source selection. Playback controls, for instance, play and stop are available for sources that support it.
Currently, this component supports powering on/off, mute, volume control, and source selection. Playback controls, for instance, play and stop are available for sources that support it.
### {% linkable_title Example configuration %}
A full configuration example will look like the sample below:
```yaml