Update the REAMDE for the changes by PR #7
Also bump the required Kodi version to 17.0 and replace XBMC by Kodi where applicable. Leave XBMC in the name of the script/project for now.
This commit is contained in:
parent
e1088665e3
commit
5dc187e268
73
README.md
73
README.md
|
@ -1,10 +1,10 @@
|
|||
Improved XBMC Wiimote Gateway
|
||||
=============================
|
||||
|
||||
An XBMC event client that receives input from a Wii remote via bluetooth
|
||||
and feeds them to XBMC.
|
||||
A Kodi event client that receives input from a Wii remote via bluetooth
|
||||
and feeds them to Kodi.
|
||||
|
||||
While XBMC comes with a Wii remote event client already (`xbmc-wiiremote`),
|
||||
While Kodi comes with a Wii remote event client already (`xbmc-wiiremote`),
|
||||
this project aims to improve upon it by adding some additional features
|
||||
such as automatic disconnect, by having better error handling and to be
|
||||
more hackable by using the Python bindings.
|
||||
|
@ -14,23 +14,22 @@ Features
|
|||
|
||||
* Automatic disconnect after a period of disuse
|
||||
* On connect…
|
||||
* notifications in XBMC,
|
||||
* notifications in Kodi,
|
||||
* rumble, and
|
||||
* battery status report
|
||||
* Supports key repeating when holding a button down
|
||||
* Rudimentary error handling
|
||||
* Usage of a specific Wii remote to be able to pair quickly
|
||||
* Uses the official XBMC [EventServer API](http://wiki.xbmc.org/?title=EventServer#Event_Clients_and_the_EventServer)
|
||||
* Uses the default [Wii remote keymap](https://github.com/xbmc/xbmc/blob/master/system/keymaps/joystick.WiiRemote.xml)
|
||||
shipped with XBMC
|
||||
* Uses the official Kodi [EventServer API](http://wiki.xbmc.org/?title=EventServer#Event_Clients_and_the_EventServer)
|
||||
* Uses the [custom controller keymap](https://kodi.wiki/view/Keymap) with Kodi (>= 17.0)
|
||||
|
||||
Requirements
|
||||
------------
|
||||
|
||||
XBMC Wiimote Gateway is an XBMC event client, so it needs:
|
||||
XBMC Wiimote Gateway is an Kodi event client, so it needs:
|
||||
|
||||
* XBMC Dharma (>= 10.1), with
|
||||
* XBMC Event Client Python bindings
|
||||
* Kodi (>= 17), with
|
||||
* Kodi Event Client Python bindings
|
||||
* Python (>= 2.6), with
|
||||
* Python CWIID bindings (>= 0.6)
|
||||
* Bluez (>= 4.96)
|
||||
|
@ -40,14 +39,60 @@ and of course a working bluetooth controller.
|
|||
Installation & Use
|
||||
------------------
|
||||
|
||||
The script itself, xbmc-wiimote, can be put anywhere. Preferably, put it
|
||||
somewhere that is in the system's/in your path.
|
||||
First, install a keymap file `WiiRemote.xml` in `$HOME/.kodi/userdata/keymaps`:
|
||||
|
||||
Then, run:
|
||||
```xml
|
||||
<keymap>
|
||||
<global>
|
||||
<customcontroller name="WiiRemote">
|
||||
<button id="1">Up</button>
|
||||
<button id="2">Down</button>
|
||||
<button id="3">Left</button>
|
||||
<button id="4">Right</button>
|
||||
<button id="5">Select</button>
|
||||
<button id="6">Back</button>
|
||||
<button id="7">VolumeDown</button>
|
||||
<button id="8">ActivateWindow(Home)</button>
|
||||
<button id="9">VolumeUp</button>
|
||||
<button id="10">ContextMenu</button>
|
||||
<button id="11">ActivateWindow(PlayerControls)</button>
|
||||
</customcontroller>
|
||||
</global>
|
||||
<Home>
|
||||
<customcontroller name="WiiRemote">
|
||||
<button id="8">Fullscreen</button>
|
||||
<button id="10">ActivateWindow(Favourites)</button>
|
||||
<button id="11">ActivateWindow(ShutdownMenu)</button>
|
||||
</customcontroller>
|
||||
</Home>
|
||||
<FullscreenVideo>
|
||||
<customcontroller name="WiiRemote">
|
||||
<button id="1">Pause</button>
|
||||
<button id="2">Stop</button>
|
||||
<button id="3">StepBack</button>
|
||||
<button id="4">StepForward</button>
|
||||
<button id="5">OSD</button>
|
||||
<button id="6">Info</button>
|
||||
<button id="7">VolumeDown</button>
|
||||
<button id="8">ActivateWindow(Home)</button>
|
||||
<button id="9">VolumeUp</button>
|
||||
<button id="10">CodecInfo</button>
|
||||
<button id="11">AspectRatio</button>
|
||||
</customcontroller>
|
||||
</FullscreenVideo>
|
||||
</keymap>
|
||||
```
|
||||
|
||||
(Feel free to modify it to your liking.)
|
||||
|
||||
Then install the script itself, xbmc-wiimote, can be put anywhere. Preferably,
|
||||
put it somewhere that is in the system's/in your path.
|
||||
|
||||
Run:
|
||||
|
||||
$ xbmc-wiimote -b <Wii remote bluetooth address>
|
||||
|
||||
You should see a notification pop up in XBMC that tells you that the
|
||||
You should see a notification pop up in Kodi that tells you that the
|
||||
XBMC Wiimote Gateway has connected.
|
||||
|
||||
If you don't know the bluetooth address of your Wii remote, run
|
||||
|
|
Loading…
Reference in New Issue