neeo-driver-kodi

NEEO driver for KODI - Version 0.6.0

This driver adds support for KODI MediaCenter to NEEO

• NEEO - The Thinking Remote: https://neeo.com
• KODI MediaCenter: https://kodi.tv

Features

• Power on the MediaPC via Wake-on-LAN
• Optional "exit KODI", "suspend" or "shutdown" the MediaPC on power off
• Auto reconnect KODI, if connection was lost
• Start Kodi application on recipe launch implemented.
• Report "powerstate" to neeo brain
• Browsing support for Video, Music, TV Shows and PVR

Available as ready to use docker image (It's currently outdated, due to re-working the driver for neeo-cli): https://hub.docker.com/r/alxbauer/neeo-driver-kodi/

Available control functions

• Power on / off
• Navigation with control pad
• Subtitle / Audio / Guide / Info
• Page up / down
• Skip next / previous
• Step back / forward
• Fast forward / rewind
• Home / Menu / Back
• Shortcuts for Videos / Live Tv / Music / Radio / Subtitles

Note: Since version 0.5.0 the controls are also fully customizable.

Requirements

• Node.js (https://nodejs.org)

Enable JSON-RPC in KODI

In System/Settings/Network/Services activate

'Allow programs on this system to control Kodi for localhost access only'

and

'Allow programs on other systems to control Kodi for access from other computers'

How to install

Drivers for NEEO can be manged with the new neeo-cli utility. Just install the neeo-cli utility with:

npm install -g @neeo/cli

Create a directory for your NEEO drivers. You can install different drivers in one directory. The neeo-cli utility will automatically find the installed drivers and start them.

mkdir my-neeo-drivers
cd my-neeo-drivers
npm init -y

Configuration options like the IP address of the NEEO Brain will be configured in the package.json file in the created drivers directory.

{
  [...]
  "neeoSdkOptions": {
    "serverName": "neeo-server",
    "serverPort": 6336,
    "brainHost": ""
  }
}

You can find more info about the neeeo-cli utility at: https://github.com/NEEOInc/neeo-sdk-toolkit/tree/master/cli

Install this KODI driver into the new NEEO drivers directory:

npm install --save neeo-driver-kodi

Start the installed drivers using the neeo-cli utility with:

neeo-cli start

Configuration for KODI

Create a configuration directory for the configuration files. The directory must be config/neeo-driver-kodi relative to the drivers directory.

cd my-neeo-drivers
mkdir -p config/neeo-driver-kodi

The configuration files for the are in YAML format.

• Create a new file named config.yml in the configuration directory.
• Have look at the sample configuration files or just make a copy of config.complete.yml and adjust the settings for your needs.

Advanced configuration for KODI

Since version 0.5.0 the driver is fully customizable. This means you can create your own key mapping to map the Neeo buttons to any Kodi function. It is also possible to make the mapping dependent from the currently active window in KODI.

The driver come with a default keymapping and controls definition. The key mapping is defined in node_modules/neeo-driver-kodi/kodi/lib/keymap.yml and the controls are defined in node_modules/neeo-driver-kodi/kodi/lib/controls.yml.

If you want to adapt these definitions, simply create a copy of the respective file in the configuration directory. You can then adapt the definitions to your requirements. The corresponding file in the config/neeo-driver-kodi directory has priority over the file in the node_modules/neeo-driver-kodi/kodi/lib directory.

To get an idea how it works have a look at:

• https://kodi.wiki/view/Keymap
• https://kodi.wiki/view/JSON-RPC_API

History

Version 0.6.0

• Code restructured for usage with new neeo-cli utility
• Simple installation with NPM
• Browsing support for Video, Music, TV Shows and PVR

Version 0.5.0

• Support for new neeo-sdk 0.50.x
• Use YAML as new configuration file format
• Support for multiple Kodi instances
• Buttons are fully customizable and content aware through keymap.yml and controls.yml file
• Support for powerStateSensor (Report "porwerstate" to neeo brain)

Version 0.4.5

• Shortcuts for subtitles added (align, delay, delay plus, delay minus, shift up and shift down)

Version 0.4.4

• Updated to neeo-sdk version 0.49.2
• NEEO buttons "SKIP SECONDS FORWARD" and "SKIP SECONDS BACKWARD" assigned to Kodi functions "stepforward" and "stepback"

Version 0.4.3

• A small work-a-round for Kodi 18 pre-releases.

Version 0.4.2

• Button SUBTITLE ist now configurable. See: 'config.kodi.subtitle'.
• Two dedicated shortcuts for "next subtitle" and "search subtitle" added.

Version 0.4.1

• Control pad is working while the player (video or audio) is active.
• The driver is now also available as ready to use docker image.

Version 0.3.0

• "Suspend" as an option for the power off function added.
• Allow Wake-On-Lan for multiple devices. E.g. to start the Media-PC and a NAS device
• Ability to start multiple driver instances to control multiple KODI instances.

Version 0.2.0

• Almost everything re-coded. Please make a fresh installation and re-create your config.js
• Wake-On-Lan fixed.
• Using Kodi web server for control, to support control while a movie or song is played.
• Support for Kodi volume control
• Possibility to start Kodi application on recipe launch implemented.

Version 0.1.0

• Initial release