From ba3842ad05e792364a15e7c3a284d25092c8a33b Mon Sep 17 00:00:00 2001 From: vaidyasm Date: Wed, 24 Oct 2018 03:00:52 +0545 Subject: [PATCH] Update Documentation for 'Snapcast' Media Player Component Configuration (#7033) * Update Documentation for 'snapcast' Media Player Component Configuration * Adds config for 'port' key Adds config for 'port' key used at https://github.com/home-assistant/home-assistant/blob/master/homeassistant/components/media_player/snapcast.py#L44 * Adds default port value Adds default port value Used during async_setup_platform() at: https://github.com/home-assistant/home-assistant/blob/master/homeassistant/components/media_player/snapcast.py#L54 Defined from imported 'python-snapcast' package at: https://github.com/happyleavesaoc/python-snapcast/blob/master/snapcast/control/server.py#L13 * Minor change * Replace value --- .../_components/media_player.snapcast.markdown | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/source/_components/media_player.snapcast.markdown b/source/_components/media_player.snapcast.markdown index 94f7db9b94c..b889f5168ae 100644 --- a/source/_components/media_player.snapcast.markdown +++ b/source/_components/media_player.snapcast.markdown @@ -22,9 +22,17 @@ To add Snapcast to your installation, add the following to your `configuration.y # Example configuration.yaml entry media_player: - platform: snapcast - host: xxx.xxx.xxx.xxx + host: YOUR_IP_ADDRESS ``` -Configuration variables: - -- **host** (*Required*): The IP of the device, eg. `192.168.0.10`. +{% configuration %} +host: + description: The IP address of the device, e.g., `192.168.0.10`. + required: true + type: string +port: + description: The port number. + required: false + default: 1705 + type: integer +{% endconfiguration %}