Kodi


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, or shutdown. Default none.
  • 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.
  • timeout (Optional): Set timeout for connections to Kodi. Defaults to 5 seconds.

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.

Service kodi_call_method

Call a Kodi JSONRPC API method with optional parameters. Results of the Kodi API call will be redirected in a Home Assistant event: kodi_call_method_result.

Service data attribute Optional Description
entity_id no Name(s) of the Kodi entities where to run the API method.
method yes Name of the Kodi JSONRPC API method to be called.
any other parameter no Optional parameters for the Kodi API call.

Event triggering

When calling the kodi_call_method service, if the Kodi JSONRPC API returns data, when received by Home Assistant it will fire a kodi_call_method_result event on the event bus with the following event_data:

entity_id: "<Kodi media_player entity_id>"
result_ok: <boolean>
input: <input parameters of the service call>
result: <data received from the Kodi API>

Kodi services samples

Simple script to turn on the TV with the Kodi JSON-CEC Addon

script:
  activate_tv:
    alias: Turn on TV
    sequence:
      - alias: TV on
        service: media_player.kodi_call_method
        data:
            entity_id: media_player.kodi
            method: Addons.ExecuteAddon
            addonid: script.json-cec
            params:
                command: activate

For a more complex usage of the kodi_call_method service, with event triggering of Kodi API results, you can have a look at this example