
* Added Kodi-specific services doc * Removed `kodi_set_shuffle` service (is the same as `media_player.shuffle_set`)
2.4 KiB
2.4 KiB
layout | title | description | date | sidebar | comments | sharing | footer | logo | ha_category | featured | ha_release | ha_iot_class |
---|---|---|---|---|---|---|---|---|---|---|---|---|
page | Kodi | Instructions how to integrate Kodi into Home Assistant. | 2015-06-22 11:00 | true | false | true | true | kodi.png | Media Player | true | pre 0.7 | Local Push |
The kodi
platform allows you to control a Kodi multimedia system from Home Assistant.
To add Kodi to your installation, add the following to your configuration.yaml
file:
# Example configuration.yaml entry
media_player:
- platform: kodi
host: 192.168.0.123
Configuration variables:
- host (Required): The host name or address of the device that is running XBMC/Kodi.
- port (Optional): The HTTP port number. Defaults to 8080.
- tcp_port (Optional): The TCP port number. Defaults to 9090. Used for websocket connections to Kodi.
- name (Optional): The name of the device used in the frontend.
- proxy_ssl (Optional): Connect to kodi with HTTPS and WSS. Defaults to
false
. Useful if Kodi is behind an SSL proxy. - username (Optional): The XBMC/Kodi HTTP username.
- password (Optional): The XBMC/Kodi HTTP password.
- turn_off_action (Optional): The desired turn off action. Options are
none
,quit
,hibernate
,suspend
,reboot
, orshutdown
. Defaultnone
. - 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 tofalse
.
{% linkable_title Service kodi_add_to_playlist
%}
Add music to the default playlist (i.e. playlistid=0).
Service data attribute | Optional | Description |
---|---|---|
entity_id |
no | Name(s) of the Kodi entities where to add the media. |
media_type |
yes | Media type identifier. It must be one of SONG or ALBUM. |
media_id |
no | Unique Id of the media entry to add (songid or albumid ). If not defined, media_name and artist_name are needed to search the Kodi music library. |
media_name |
no | Optional media name for filtering media. Can be 'ALL' when media_type is 'ALBUM' and artist_name is specified, to add all songs from one artist. |
artist_name |
no | Optional artist name for filtering media. |