mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-05-01 16:57:34 +00:00

* e.g. to e.g., and proper case for Home Assistant * Instructions how to -> Instructions on how to
3.7 KiB
3.7 KiB
layout | title | description | date | sidebar | comments | sharing | footer | logo | ha_category | ha_release |
---|---|---|---|---|---|---|---|---|---|---|
page | Kodi | Instructions on how to add Kodi notifications to Home Assistant. | 2016-09-12 16:00 | true | false | true | true | kodi.png | Notifications | 0.29 |
The Kodi
platform allows you to send messages to your Kodi multimedia system from Home Assistant.
To add Kodi to your installation, add the following to your configuration.yaml
file:
# Example configuration.yaml entry
notify:
- platform: kodi
name: NOTIFIER_NAME
host: 192.168.0.123
- name (Optional): Name displayed in the frontend. The notifier will bind to the service
notify.NOTIFIER_NAME
. - host (Required): The host name or address of the device that is running Kodi.
- port (Optional): The HTTP port number. Defaults to 8080.
- proxy_ssl (Optional): Connect to kodi with HTTPS. 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.
{% linkable_title script.yaml example %}
kodi_notification:
sequence:
- service: notify.NOTIFIER_NAME
data:
title: "Home Assistant"
message: "Message to KODI from Home Assistant!"
data:
displaytime: 20000
icon: "warning"
{% linkable_title Message variables %}
- title (Optional): Title that is displayed on the message.
- message (Required): Message to be displayed.
- data (Optional)
- icon (Optional): Kodi comes with 3 default icons:
info
,warning
anderror
, an URL to an image is also valid. Defaults toinfo
- displaytime (Optional): Length in milliseconds the message stays on screen. Defaults to
10000
ms
- icon (Optional): Kodi comes with 3 default icons:
To use notifications, please see the getting started with automation page.
{% linkable_title Services %}
{% linkable_title Media control services %}
Available services: kodi_add_to_playlist
, kodi_set_shuffle
Service data attribute | Optional | Description |
---|---|---|
entity_id |
yes | Target a specific media player. Defaults to all. |
{% linkable_title Service media_player/kodi_set_shuffle
%}
Service data attribute | Optional | Description |
---|---|---|
entity_id |
yes | Target a specific media player. It must be of type kodi. |
shuffle_on |
no | True/false for shuffle on/off |
{% linkable_title Service media_player/kodi_add_to_playlist
%}
Add a song or an entire album to the default playlist (i.e. playlist id 0).
Service data attribute | Optional | Description |
---|---|---|
entity_id |
yes | Target a specific media player. It must be of type kodi. |
media_type |
no | either SONG or ALBUM |
media_id | yes | id of the media as defined in kodi |
media_name | yes | name of the media, HA will search for the media with name closer to this. If ALL add all albums, if artist_name is provided adds all albums of that artist. |
artist_name | yes | name of the artist, HA will search for the artist with name closer to this. |