Skip to content

Update documentation for Kodi services #10081

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
balloob merged 5 commits into from
Aug 12, 2019
Merged

Update documentation for Kodi services #10081

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
ba20468
Working on Kodi services documentation
JeffLIrion Aug 8, 2019
6ac62d8
Update Kodi services documentation
JeffLIrion Aug 8, 2019
97abaa0
Remove description of deprecated 'kodi_set_shuffle' service
JeffLIrion Aug 8, 2019
e25eaf3
Add accidentally deleted '|'
JeffLIrion Aug 8, 2019
51e6907
'kodi_call_method' -> 'kodi.call_method'
JeffLIrion Aug 10, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 12 additions & 19 deletions source/_components/kodi.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ timeout:

### Services

#### Service `kodi_add_to_playlist`
#### Service `kodi.add_to_playlist`

Add music to the default playlist (i.e. playlistid=0).

Expand All @@ -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. |
| `artist_name` | no | Optional artist name for filtering media. |

#### 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. |

#### Service `kodi_call_method`
#### 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`.

Expand All @@ -117,7 +110,7 @@ Call a [Kodi JSONRPC API](http://kodi.wiki/?title=JSON-RPC_API) method with opti

### 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
entity_id: "<Kodi media_player entity_id>"
Expand Down Expand Up @@ -156,7 +149,7 @@ media_player:
- platform: kodi
host: 192.168.0.123
turn_off_action:
service: media_player.kodi_call_method
service: kodi.call_method
data:
entity_id: media_player.kodi
method: Application.Quit
Expand All @@ -169,7 +162,7 @@ media_player:
- platform: kodi
host: 192.168.0.123
turn_off_action:
service: media_player.kodi_call_method
service: kodi.call_method
data:
entity_id: media_player.kodi
method: System.Hibernate
Expand All @@ -182,7 +175,7 @@ media_player:
- platform: kodi
host: 192.168.0.123
turn_off_action:
service: media_player.kodi_call_method
service: kodi.call_method
data:
entity_id: media_player.kodi
method: System.Suspend
Expand All @@ -195,7 +188,7 @@ media_player:
- platform: kodi
host: 192.168.0.123
turn_off_action:
service: media_player.kodi_call_method
service: kodi.call_method
data:
entity_id: media_player.kodi
method: System.Reboot
Expand All @@ -208,7 +201,7 @@ media_player:
- platform: kodi
host: 192.168.0.123
turn_off_action:
service: media_player.kodi_call_method
service: kodi.call_method
data:
entity_id: media_player.kodi
method: System.Shutdown
Expand All @@ -223,7 +216,7 @@ media_player:
- platform: kodi
host: 192.168.0.123
turn_on_action:
service: media_player.kodi_call_method
service: kodi.call_method
data:
entity_id: media_player.kodi
method: Addons.ExecuteAddon
Expand All @@ -234,7 +227,7 @@ media_player:
- service: media_player.media_stop
data:
entity_id: media_player.kodi
- service: media_player.kodi_call_method
- service: kodi.call_method
data:
entity_id: media_player.kodi
method: Addons.ExecuteAddon
Expand Down Expand Up @@ -293,7 +286,7 @@ script:
alias: Update Kodi Library
sequence:
- alias: Call Kodi update
service: media_player.kodi_call_method
service: kodi.call_method
data:
entity_id: media_player.kodi
method: VideoLibrary.Scan
Expand Down Expand Up @@ -384,4 +377,4 @@ data:
type: integer
{% 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/).