node-wiimote v0.2.0

node-wiimote

Basic easy to use Wiimote library for node.js.

Detection and initialization based on wii-controller

Thanks to Wiibrew for information on the communication standard.

Latest Version

UPDATE HIGHLY RECOMMENDED - REQUIRES MANUAL EDITING OF PACKAGE.JSON OR REINSTALL @LATEST
UPDATE IS MOSTLY BACKWARDS COMPATIBLE.

Changes to 0.2.0: 'The Events and Errors Update'

Errors are now programatic and may not print to console. Critical errors now throw catchable errors. Non critical errors return error objects (and may catch exceptions themselves). Warnings print to console.

Overhaul of the way events are stored and triggered, ready for 0.3 and 0.4

Callbacks now get event objects, for dealing with multiple buttons on a single callback (but might still need to tell them apart) Support removing event listeners with the names of events or actions

Add getting list of all events (hopefully not needed but could be passed through to users through GUI)

Fixed bug where errors were thrown when wiimote disconnects. Aka I was using it to control a lighting rig then everything crashed and burned so I fixed it.

Updated docs, changelong, todo, readme Updated node-hid and removed (now) unused colors

Compatibility

Requires Wiimote, connected with bluetooth.
Tested and works on Windows 10, other OSes unknown.
wii-controller recommended use of this driver for Mac OS: https://code.google.com/p/wjoy/

Installation

npm install node-wiimote --save

Usage

var Wiimote = require("node-wiimote"); // Require in library
var wii = new Wiimote(); // Initialize wiimote library 
  
if (wii.exists) {  
	var pressAToken = wii.on("button_a", "pressed", handlePressA); // Returns listener token used to remove listeners.  
    
	wii.off(pressAToken); // Takes listener token and removes listener
}  

Listeners:

Supports all buttons (button_a, _b, etc)
FUTURE - To support more types

Action types:

pressed

Triggered when a button is pressed down.

released

Triggered when a button is released.

Feedback

wii.setLights(1, 2, 3, 4);

Takes 4 boolean values, and sets the lights (left to right)

wii.vibrate(<(true/false)|duration>);

Expects true or false, and enables or disables vibrate (rumble)
Also allows a duration in milliseconds to be passed in.
Please use either one within your project unless neccesary. May have unexpected behaviour if two timeouts overlap.

Contributing

Pull requests are welcome. Actually, please do make improvements. Also can someone make this README actually good thanks.

Licensing

Just use it. Give credit if you want.