jonisb / jsbc.kodilib

Kodi support library in Python.

Kodi support library in Python

Support modules needed

• SSDPLib.py from https://github.com/jonisb/SSDPLib
• xbmcclient.py from Kodi source
• regex.py and _regex_core.py from https://pypi.python.org/pypi/regex
• If using Python 2.6.x not needed on Python 2.7.x: ordereddict.py from https://pypi.python.org/pypi/ordereddict

jsbc.kodilib's Issues

CLI command to run Kodi commands

Features to implement:

• Support CLI parameters
• Show connected Kodi info
• Specify Kodi IP address
• List available Kodi instances
• Return error codes
• Support different levels of verbosity
• Handle missing Kodi instance

json-rpc:

• Send json-rpc raw command
• Send json-rpc method and parameters
• Start receiving json-rpc notifications
• run a command when receiving a notification
• Add GUI to create json-rpc command visually
• List methods with filter

Eventserver

• Send Eventserver action
• Send Eventserver function
• Start receiving Eventserver notifications
• List actions/functions supported with filter

Handle Kodi connection after having computer sleep

Move testing UUIDs from code to a settings file

Add HTTP "User-Agent" to the lib and make it configurable.

https://tools.ietf.org/html/rfc7231#section-5.5.3
https://en.wikipedia.org/wiki/User_agent

Download Joystick info

• https://github.com/xbmc/xbmc/blob/master/xbmc/input/ButtonTranslator.cpp

Add support to read and create modified Keymap.xml files

• Need a way to read keymap files from Kodi: special://xbmc and special://userdata should work.
• Need a way to update/create user specific keymap.xml: Looks like it needs to be done outside of Kodi or with Kodi directly.

"regex" fails to import on Python 2.7 in actions

Needs older version for Python 2.7 support
regex==2020.10.28

Download Kodi/XBMC version specific commands

Download Gamepad info

• https://github.com/xbmc/xbmc/blob/master/xbmc/input/ButtonTranslator.cpp

Find a way to run Kodi in github actions

Kodi can't run in github actions VM probably due to missing GPU support.

EventServer notification icon don't show up

The problem is in "xbmcclient.py" the icon file is opened in text-mode on at least Windows, so the .png file gets truncated.

Simply fixed by the binary option to the file open commands and should be compatible other systems too.

Need to report to Kodi developers.

Download Window info from Kodi

• http://kodi.wiki/view/JSON-RPC_API/v8#GUI.Window
• https://github.com/xbmc/xbmc/blob/master/xbmc/input/WindowTranslator.cpp
• http://kodi.wiki/view/Window_IDs

Windows sub-section http://kodi.wiki/view/Opening_Windows_and_Dialogs
https://github.com/xbmc/xbmc/blob/master/xbmc/video/windows/GUIWindowVideoNav.cpp

Download info for BuiltInFunctions

• https://github.com/xbmc/xbmc/tree/master/xbmc/interfaces/builtins
• http://kodi.wiki/view/List_of_built-in_functions
• https://codedocs.xyz/xbmc/xbmc/page__list_of_built_in_functions.html
• https://xbmc.github.io/docs.kodi.tv/master/kodi-dev-kit/page__list_of_built_in_functions.html

Report documentation issues to Kodi

• PlaysDisc(parm) should be PlayDisc(parm): Player built-in's
• Skin.SetFile(string,mask,folderpath) description incomplete: Skin.SetFile(string,mask,folderpath)
• Container.SortDirection should be container.setsortdirection: GUI container built-in's
• skin.selectbool is missing: Skin built-in's
• ToggleDebug is missing: Application built-in's
• playdisc and restart are missing: List of built-in functions
• CreatEpisodeBookmark should be createepisodebookmark: http://kodi.wiki/view/Action_IDs
• SetRatring should be setrating : http://kodi.wiki/view/Action_IDs
• Conflicting syntax for UpdateLibrary: http://kodi.wiki/view/List_of_built-in_functions and https://codedocs.xyz/xbmc/xbmc/page__list_of_built_in_functions.html#built_in_functions_8

updatelibrary([type, suppressDialogs]) type not optional?
Skin.SetFile(string,mask,folderpath) mask,folderpath optional?
RecursiveSlideShow(dir) syntax missing parameters?

xbmcplugin.SORT_SORT_METHOD_VIDEO_YEAR should be xbmcplugin.SORT_METHOD_VIDEO_YEAR in codedocs

Support sending many JSON-RPC requests in a batch request.

Support JSON-RPC commands without id

Commands without id don't return a response.

Get/download command info for Kodi

EventServer API (UDP)

• Actions #8
• BuiltInFunctions #9
• Keyboard #19
• Remote #14
• Universal remote
• Gamepad #13
• Joystick #15
• Mouse keys #16
• Touch commands #18
• App commands #17

JSON-RPC (TCP/HTTP)

• JSON-RPC #11

Misc

• InfoLabels/Booleans #10
• Windows #12

Download remote info

• https://github.com/xbmc/xbmc/blob/master/xbmc/input/IRTranslator.cpp

Automatically generate and cache new UUID for new Kodi version for testing

Kodi 19 logging changes

https://forum.kodi.tv/showthread.php?tid=344263&pid=2943703#pid2943703

Use JSON-RPC JSONRPC.Version to get information

Get JSON-RPC version
http://kodi.wiki/view/JSON-RPC_API/v6#JSONRPC.Version

Investigate starting Kodi installed via Windows store

Command to start Kodi installed via Windows 10 store:
shell:AppsFolder\XBMCFoundation.Kodi_4n2hpmxwrvr6p!Kodi

Links with more info:
https://www.eightforums.com/tutorials/49207-app-shortcuts-create-windows-8-a.html
https://msdn.microsoft.com/en-us/library/windows/desktop/dd378459%28v=vs.85%29.aspx

Check legal stuff connected to included modules and code.

Download Touch commands info

• https://github.com/xbmc/xbmc/blob/master/xbmc/input/ButtonTranslator.cpp

Add web interface support?

http://kodi.wiki/view/web_interface

Download info for InfoLabels/Booleans

• https://github.com/xbmc/xbmc/blob/master/xbmc/GUIInfoManager.cpp
• https://codedocs.xyz/xbmc/xbmc/modules__General__List_of_gui_access.html#modules__General__List_of_gui_access_System
• http://kodi.wiki/index.php?title=InfoLabels
• http://kodi.wiki/view/JSON-RPC_API/v6#XBMC.GetInfoLabels
• http://kodi.wiki/view/JSON-RPC_API/v6#XBMC.GetInfoBooleans

Make CommandInfo separate module

Download info for actions.

Version specific

• http://kodi.wiki/view/JSON-RPC_API/v8#Input.Action
• https://github.com/xbmc/xbmc/blob/master/xbmc/input/actions/ActionTranslator.cpp
• https://github.com/xbmc/xbmc/blob/master/xbmc/input/ButtonTranslator.cpp (Old Kodi)

Not version specific

• http://kodi.wiki/view/Action_IDs

Use JSON-RPC Application.GetProperties to get information

"name", "version"
http://kodi.wiki/view/JSON-RPC_API/v6#Application.GetProperties

Add UPnP/DLNA support.

https://openconnectivity.org/resources/specifications/upnp/specifications
https://github.com/masmu/pulseaudio-dlna

JSON-RPC "Player.GetItem" parameter "1" locks EventGhost

"Player.GetItem" parameter "[1]" does not lock up

Check significance of CButtonTranslator::IsAnalog(int actionID)

https://github.com/xbmc/xbmc/blob/master/xbmc/input/ButtonTranslator.cpp

Download Keyboard key info

• http://kodi.wiki/view/List_of_Kodi_keynames

Separate JSON-RPC code to its own module/repository

Get JSON-RPC methods from Kodi

• Directly from Kodi JSON-RPC API (https://kodi.wiki/view/JSON-RPC_API/v12)

Download App command info

• https://github.com/xbmc/xbmc/blob/master/xbmc/input/ButtonTranslator.cpp

Github actions auto testing

Kodi can't be run in the action VM

Support JSON-RPC commands and notifications via the same socket

Support sending JSON-RPC via different transports .

Transports:

• HTTP

• TCP

• WebSocket
  Functionality seems same as TCP so should not need to be supported.

Get sender name from JSON-RPC notification

Add WOL support

Add optional WakeOnLan support to wake up a device if not available when sending commands.

Tool to test WOL: https://wol.aquilatech.com/index.html

Add option to send an initial Kodi/XBMC version, that can be compared to the connected version

If different version (of Kodi/XBMC) get updated commands

Kodi 19 New settings format for addons

https://forum.kodi.tv/showthread.php?tid=350135&pid=2908404#pid2908404

Download Mouse keys info

• https://github.com/xbmc/xbmc/blob/master/xbmc/input/MouseTranslator.cpp
• https://github.com/xbmc/xbmc/blob/master/xbmc/network/EventPacket.h

Handle "XBMC.System.OnSleep" notification from Kodi