# nodewii

**Repository Path**: mirrors_bramp/nodewii

## Basic Information

- **Project Name**: nodewii
- **Description**: Node.js cwiid asynchronous native bindings
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-08
- **Last Updated**: 2026-05-16

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

Node.js libcwiid bindings
=======================

Created by Tim Branyen [@tbranyen](http://twitter.com/tbranyen)  
Modified by [Andrew Brampton](http://bramp.net) [@TheBramp](http://twitter.com/TheBramp)

nodewii provides asynchronous native bindings to the libcwiid C API.

Building and installing
-----------------------

### Dependencies ###
To run nodewii you need Node.js (>=v0.10.0), bluez, and libcwiid installed. To 
run unit tests you will need to have git installed and accessible from your
PATH to fetch any vendor/ addons. 

It is sufficient enough to rely on the system package manager to install
libcwiid and bluez.  Refer to your distros repository search to find the
correct module names and installation procedure.

### In action ###
nodewii was implemented at JSconf 2011 for Mary Rose Cook's game Pistol Slut.
You can see the pull request here for how it was implemented:

[https://github.com/maryrosecook/pistolslut/pull/1](https://github.com/maryrosecook/pistolslut/pull/1)

Video demo: [http://vimeo.com/23224874](http://vimeo.com/23224874)

### Linux (Ubuntu/Debian) ###

Ensure you have the dependancies installed

``` bash
$ sudo apt-get install libbluetooth-dev libcwiid-dev
$ sudo npm install -g node-gyp
```

Install nodewii by cloning source from __GitHub__ and use npm
to build and install:
    
``` bash
$ git clone git://github.com/bramp/nodewii.git
$ cd nodewii

$ npm -d install
```

A demo applicaton can be run like so:

``` bash
$ node example/simple/server.js
```

### Apple OS X/Windows via Cygwin ###
nodewii currently does not run on either Mac OS X or Windows machines.  This
is a problem with `libcwiid`.  A future plan is to fork `libcwiid` and write
support for at least Apple OS X.


API Example Usage
-----------------

### Connecting and enabling features ###

#### Raw API ####

``` javascript
var wii = require("nodewii");
var wiimote = new wii.WiiMote();

// You may specify a mac address to your wiimote, or use 00:00:00:00:00
wiimote.connect("00:00:00:00:00", function(err) {
  if( err ) {
    console.log( 'Could not establish connection' );
    return;
  }

  // Enable rumble
  wiimote.rumble(true);

  // Turn on led"s 1 and 3
  wiimote.led(1, true);
  wiimote.led(3, true);

  // Turn off led 3
  wiimote.led(3, false);

  // Get IR Data
  wiimote.ir(true);
  wiimote.on("ir", function(points) {
    for (var p in points)
      console.log("Point", p['x'], p['y'], p['size']);
  });
});
```

### Events ###

* connect
* disconnect
* accelerometer
* button
* ir
* status

Release information
-------------------

### v0.0.3 (by bramp): ###
* Upgraded to support node 0.10.0
* Change build system to node-gyp
* Change event framework from EIO to UV

### v0.0.2 (by bramp): ###
* Added a new example using socket.io
* Changed the use of cwiid to be truely async

### v0.0.1: ###
* Some useful methods implemented
* Partial examples in example directory

Getting involved
----------------

If you find this project of interest, please document all issues and fork if
you feel you can provide a patch.