= XBMC Wiimote Gateway

An XBMC event client that receives input from a Wii remote via bluetooth
and feeds them to XBMC.

== Features

* Automatic disconnect after a period of disuse
* On connect…
  - notifications in XBMC,
  - 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 (see also [1])
* Uses the default Wii remote keymap shipped with XBMC (see also [2])

1: http://wiki.xbmc.org/?title=EventServer#Event_Clients_and_the_EventServer
2: https://github.com/xbmc/xbmc/blob/master/system/keymaps/joystick.WiiRemote.xml

== Requirements

XBMC Wiimote Gateway is an XBMC event client, so it needs:

* XBMC Dharma (>= 10.1), with
  - XBMC Event Client Python bindings
* Python (>= 2.6), with
  - Python CWIID bindings (>= 0.6)
* Bluez (>= 4.96)

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.

Then, run:

  $ xbmc-wiimote <Wii remote bluetooth address>

You should see a notification pop up in XBMC that tells you that the
XBMC Wiimote Gateway has connected.

If you don't know the bluetooth address of your Wii remote, run

  $ hcitool scan

and quickly press 1+2 on the Wii remote to find the address

== License

XBMC Wiimote Gateway free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by the
Free Software Foundation, either version 3 of the License, or (at your
option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
more details.

You should have received a copy of the GNU General Public License along
with this program.  If not, see <http://www.gnu.org/licenses/>.

N.B.  The source code of this program includes code from
http://code.activestate.com/recipes/577407/ which is licensed under the
Apache License 2.0, see also: http://www.apache.org/licenses/LICENSE-2.0.html