mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-05-11 05:28:57 +00:00
7fa6db53c6
* Create notify.kodi.markdown Initial documentation for kodi notification * Update notify.kodi.markdown cosmetic changes * Update notify.kodi.markdown
61 lines
2.0 KiB
Markdown
61 lines
2.0 KiB
Markdown
---
|
|
layout: page
|
|
title: "Kodi"
|
|
description: "Instructions how to add Kodi notifications to Home Assistant."
|
|
date: 2016-09-12 16:00
|
|
sidebar: true
|
|
comments: false
|
|
sharing: true
|
|
footer: true
|
|
logo: kodi.png
|
|
ha_category: Notifications
|
|
ha_release: 0.29
|
|
---
|
|
|
|
|
|
The `Kodi` platform allows you so send messages to your [Kodi](https://kodi.tv/) multimedia system from Home Assistant.
|
|
|
|
To add Kodi to your installation, add the following to your configuration.yaml file:
|
|
|
|
### {% linkable_title Configuration %}
|
|
```yaml
|
|
# Example configuration.yaml entry
|
|
notify:
|
|
platform: kodi
|
|
name: NOTIFIER_NAME
|
|
host: http://192.168.0.123
|
|
port: 8080
|
|
username: USERNAME
|
|
password: PASSWORD
|
|
```
|
|
|
|
- **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 port number, the default value is `8080`.
|
|
- **username** (*Optional*): The XBMC/Kodi HTTP username.
|
|
- **password** (*Optional*): The XBMC/Kodi HTTP password.
|
|
|
|
### {% linkable_title script.yaml example %}
|
|
```yaml
|
|
################################################################
|
|
## Script / Notify KODI
|
|
################################################################
|
|
kodi_notification:
|
|
sequence:
|
|
- service: notify.NOTIFIER_NAME
|
|
data:
|
|
title: "Home Assistant"
|
|
message: "Message to KODI from Home Assistant!"
|
|
data:
|
|
displaytime: 20000
|
|
icon: "warning"
|
|
```
|
|
#### 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` and `error`, an URL to an image is also valid. *Defaults to `info`*
|
|
- **displaytime** (*Optional*): Length in milliseconds the message stays on screen. *Defaults to `10000` ms*
|
|
|
|
To use notifications, please see the [getting started with automation page](/getting-started/automation/).
|