jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-25 10:17:23 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update documentation for Kodi services (#10081)

Browse Source 
* Working on Kodi services documentation

* Update Kodi services documentation

* Remove description of deprecated 'kodi_set_shuffle' service

* Add accidentally deleted '|'

* 'kodi_call_method' -> 'kodi.call_method'
This commit is contained in:
Jeff Irion 2019-08-12 09:08:20 -07:00 committed by Paulus Schoutsen
parent 67a7b19e12
commit 43da41b820
1 changed files with 12 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
source/_components/kodi.markdown
View File

@ -86,7 +86,7 @@ timeout:
### Services ### Services
#### Service `kodi_add_to_playlist` #### Service `kodi.add_to_playlist`
Add music to the default playlist (i.e. playlistid=0). Add music to the default playlist (i.e. playlistid=0).
@ -98,14 +98,7 @@ Add music to the default playlist (i.e. playlistid=0).
| `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. | | `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. | | `artist_name` | no | Optional artist name for filtering media. |
#### Service `media_player/kodi_set_shuffle` #### Service `kodi.call_method`
| 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. |
#### Service `kodi_call_method`
Call a [Kodi JSONRPC API](http://kodi.wiki/?title=JSON-RPC_API) method with optional parameters. Results of the Kodi API call will be redirected in a Home Assistant event: `kodi_call_method_result`. Call a [Kodi JSONRPC API](http://kodi.wiki/?title=JSON-RPC_API) method with optional parameters. Results of the Kodi API call will be redirected in a Home Assistant event: `kodi_call_method_result`.
@ -117,7 +110,7 @@ Call a [Kodi JSONRPC API](http://kodi.wiki/?title=JSON-RPC_API) method with opti
### Event triggering ### 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`: 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`:
```yaml ```yaml
entity_id: "<Kodi media_player entity_id>" entity_id: "<Kodi media_player entity_id>"
@ -156,7 +149,7 @@ media_player:
- platform: kodi - platform: kodi
host: 192.168.0.123 host: 192.168.0.123
turn_off_action: turn_off_action:
service: media_player.kodi_call_method service: kodi.call_method
data: data:
entity_id: media_player.kodi entity_id: media_player.kodi
method: Application.Quit method: Application.Quit
@ -169,7 +162,7 @@ media_player:
- platform: kodi - platform: kodi
host: 192.168.0.123 host: 192.168.0.123
turn_off_action: turn_off_action:
service: media_player.kodi_call_method service: kodi.call_method
data: data:
entity_id: media_player.kodi entity_id: media_player.kodi
method: System.Hibernate method: System.Hibernate
@ -182,7 +175,7 @@ media_player:
- platform: kodi - platform: kodi
host: 192.168.0.123 host: 192.168.0.123
turn_off_action: turn_off_action:
service: media_player.kodi_call_method service: kodi.call_method
data: data:
entity_id: media_player.kodi entity_id: media_player.kodi
method: System.Suspend method: System.Suspend
@ -195,7 +188,7 @@ media_player:
- platform: kodi - platform: kodi
host: 192.168.0.123 host: 192.168.0.123
turn_off_action: turn_off_action:
service: media_player.kodi_call_method service: kodi.call_method
data: data:
entity_id: media_player.kodi entity_id: media_player.kodi
method: System.Reboot method: System.Reboot
@ -208,7 +201,7 @@ media_player:
- platform: kodi - platform: kodi
host: 192.168.0.123 host: 192.168.0.123
turn_off_action: turn_off_action:
service: media_player.kodi_call_method service: kodi.call_method
data: data:
entity_id: media_player.kodi entity_id: media_player.kodi
method: System.Shutdown method: System.Shutdown
@ -223,7 +216,7 @@ media_player:
- platform: kodi - platform: kodi
host: 192.168.0.123 host: 192.168.0.123
turn_on_action: turn_on_action:
service: media_player.kodi_call_method service: kodi.call_method
data: data:
entity_id: media_player.kodi entity_id: media_player.kodi
method: Addons.ExecuteAddon method: Addons.ExecuteAddon
@ -234,7 +227,7 @@ media_player:
- service: media_player.media_stop - service: media_player.media_stop
data: data:
entity_id: media_player.kodi entity_id: media_player.kodi
- service: media_player.kodi_call_method - service: kodi.call_method
data: data:
entity_id: media_player.kodi entity_id: media_player.kodi
method: Addons.ExecuteAddon method: Addons.ExecuteAddon
@ -293,7 +286,7 @@ script:
alias: Update Kodi Library alias: Update Kodi Library
sequence: sequence:
- alias: Call Kodi update - alias: Call Kodi update
service: media_player.kodi_call_method service: kodi.call_method
data: data:
entity_id: media_player.kodi entity_id: media_player.kodi
method: VideoLibrary.Scan method: VideoLibrary.Scan
@ -384,4 +377,4 @@ data:
type: integer type: integer
{% endconfiguration %} {% endconfiguration %}
To use notifications, please see the [getting started with automation page](/getting-started/automation/). To use notifications, please see the [getting started with automation page](/getting-started/automation/).