Update kodi configuration variable style. (#6430)

This commit is contained in:
Fredrik Baberg 2018-10-02 11:21:57 +02:00 committed by Fabian Affolter
parent 5e45c07b53
commit 4014aa9e76

View File

@ -28,20 +28,57 @@ media_player:
host: 192.168.0.123 host: 192.168.0.123
``` ```
Configuration variables: {% configuration %}
host:
- **host** (*Required*): The host name or address of the device that is running XBMC/Kodi. description: The host name or address of the device that is running XBMC/Kodi.
- **port** (*Optional*): The HTTP port number. Defaults to 8080. required: true
- **tcp_port** (*Optional*): The TCP port number. Defaults to 9090. Used for websocket connections to Kodi. type: string
- **name** (*Optional*): The name of the device used in the frontend. port:
- **proxy_ssl** (*Optional*): Connect to kodi with HTTPS and WSS. Defaults to `false`. Useful if Kodi is behind an SSL proxy. description: The HTTP port number.
- **username** (*Optional*): The XBMC/Kodi HTTP username. required: false
- **password** (*Optional*): The XBMC/Kodi HTTP password. type: integer
- **turn_on_action** (*Optional*): Home Assistant script sequence to call when turning on. default: 8080
- **turn_off_action** (*Optional*): Home Assistant script sequence to call when turning off. tcp_port:
- **enable_websocket** (*Optional*): Enable websocket connections to Kodi via the TCP port. Defaults to `true`. The websocket connection allows Kodi to push updates to Home Assistant and removes the need for Home Assistant to poll. If websockets don't work on your installation this can be set to `false`. description: The TCP port number. Used for websocket connections to Kodi.
- **timeout** (*Optional*): Set timeout for connections to Kodi. Defaults to 5 seconds. required: false
type: integer
default: 9090
name:
description: The name of the device used in the frontend.
required: false
type: string
proxy_ssl:
description: Connect to kodi with HTTPS and WSS. Useful if Kodi is behind an SSL proxy.
required: false
type: boolean
default: false
username:
description: The XBMC/Kodi HTTP username.
required: false
type: string
password:
description: The XBMC/Kodi HTTP password.
required: false
type: string
turn_on_action:
description: Home Assistant script sequence to call when turning on.
required: false
type: list
turn_off_action:
description: Home Assistant script sequence to call when turning off.
required: false
type: list
enable_websocket:
description: Enable websocket connections to Kodi via the TCP port. The websocket connection allows Kodi to push updates to Home Assistant and removes the need for Home Assistant to poll. If websockets don't work on your installation this can be set to `false`.
required: false
type: boolean
default: true
timeout:
description: Set timeout for connections to Kodi. Defaults to 5 seconds.
required: false
type: integer
default: 5
{% endconfiguration %}
### {% linkable_title Service `kodi_add_to_playlist` %} ### {% linkable_title Service `kodi_add_to_playlist` %}