pcwii / cpkodi-skill

updated Mycroft.AI Kodi Skill using the Common Play Framework

CP Kodi Control

Control KODI open source media center with Mycroft.ai using the Common Play architecture

About

Utilize the kodi API and Python library for controlling the KODI open source media center with Mycroft.ai. The Kodi Skill uses conversational dialog to help you to control your KODI instance more naturally.

Examples -Movies-

• "play the movie guardians of the galaxy"
• "play the film planet of the apes"
• "play a random movie"
• "turn kodi subtitles on"
• "turn kodi subtitles off"
• "skip kodi forward"
• "skip kodi backward"
• "pause the film"
• "re-start the film"
• "stop the movie"
• "show kodi movie information"
• "hide kodi movie information"
• "list recently added movies"
• "list the movies by genre"
• "list the movies by studio"
• "list movie sets"
• "list movies by title"
• "list movies by actor"
• "list all movies"
• "clear the movie playlist"

• Movie titles containing Roman Numerals will automatically be searched eg.

• "play the movie star wars 3" - will locate star wars III

Examples -Music-

• "play the artist elvis presley”
• "play the song blue suede shoes"
• "play the album appeal to reason”
• "the song Cinematic by Owl City"
• "the album Cinematic by Owl City"
• "play some music" --will play a random selection
• "clear the music playlist"
• "pause the music"
• "resume the music"

Examples -Youtube-

• Requires Youtube Kodi Plugin
• Requires Youtube Kodi API
• "play the captain marvel official trailer from youtube”
• "play helix with youtube”
• "play some Elton John using youtube"

Examples -TV Shows-

• "play the outer limits season 1 episode 2”

Examples -Favourites-

• "play starred item german news"
• "Open Kirby Super Star from my favorites"

Examples -PVR-

• "play channel 2"
• "watch channel Heart TV"
  • Note that if your channel name is in a different language from your Mycroft interface, this won't work.

Examples -Miscellaneous-

• "pause kodi"
• "re-start kodi"
• "stop kodi"
• "clear the kodi playlist"
• "set kodi volume to 100"
• "set kodi volume to 25"
• "turn kodi notifications on"
• "turn kodi notifications off"
• "move the kodi cursor up / down / left / right / back / select / cancel"
  • After the first cursor command just say the direction "up / down / left / right / back / select / cancel"
• "move the kodi cursor right 3 times"
• "move the kodi cursor down twice"
• "update the kodi library"
• "clean the kodi library"
• "load kodi settings / configuration"

Conversational Context

• If mycroft.ai locates more than one movie that matches your request it will permit you to itterate through your requests using conversational context.

• eg. "hey mycroft:"
• Request: "play the move Iron Man"
• Response: "I have located 3 movies with the name Iron Man,
• Response: "Would you like me to list them?"
• Request: "yes"
• Response: "Iron Man, To Add this selection to the playlist say, Add, To Skip, say Next, Say start, to play, or Stop, to stop"
• Request: "next"
• Response: "Iron Man 2"
• Request: "start" / "select"
• Response: "o-k, attempting to play, Iron Man 2"

Cinemavision Addon

This kodi addon is not expected to work in the next kodi release

Support for this addon will likely be removed

• If mycroft.ai locates the addon CinemaVision it will prompt the user if this addon should be used during the playback of the movie that was selected.

• Response: "Would you like to play the movie using cinemavision?"
• Request: "yes / no"

Chromecast Support

CP Kodi skill is capable of "casting" any of your personal library files to a chromecast enabled device

• "cast the movie guardians of the galaxy"

Credits

• PCWii

Category

Media

Tags

'#kodi, #Krypton #Leia, #mycroft.ai, #python, #skills #youtube #common play #cps'

Require

Tested on platform_picroft (others untested)

Other Requirements

• Mycroft

Dependancies Automatically Installed

• python:
  • requests
  • bs4
  • requests_cache
  • PyChromecast>=7.0.1
  • pyenchant
  • compound-word-splitter
• system:
  • apt-get: libenchant1c2a

Further Reading

• KODI API
• CinemaVision

Installation Notes

• SSH to your device and run: msm install https://github.com/pcwii/cpkodi-skill.git
• Configure Kodi to “allow remote control via HTTP”, under the Kodi settings:services
• Configure Kodi to “allow remote control from applications on other systems”, under the Kodi settings:services
• Under Kodi settings:services note the port number (8080)
• Configure home.mycroft.ai to set your kodi instance ip address and port number

Todo

• Added movies search with roman numerals based on numbers in the utterance (Completed 20201214)
• Make repeat words language agnostic "MultiplicativeList.json" (Completed 2021214)
• Add the ability to search music by album and artist (Completed 20210110)
• Correct the random music request "play some music" (Completed 20201228)
• Confirm TV Show request by season and episode "play the outer limits season 1 episode 2" (Completed 20201229)
• Confirm music request by artist "play the artist Elvis" (Completed 20210110)
• Confirm TV Show request by Title with dialog "play the tv show stargirl" (Todo 20201214)
• Correct index out of range when iterating through a list of found movies (Complete 20201223)
• Todo Add new dialog response when we reach the end of the list (Completed 20201224)
• Add Option to toggle debug log entries in websettings (Completed 20201229)
• Confirm Chromecast support for local library (20201229)