MSI Keyboard LED Controller

OS independent* LED Controller for MSI Steelseries laptop keyboards Using Node.js

Information

Package	msi-keyboard
Description	MSI Keyboard LED Controller
Hardware	MSI GE, GT Steelseries Keyboard
Node Version	>= 0.4

Usage

Make sure you have the needed usb lib requirements for your OS.

Generic Linux: libusb-dev

if using as a stand alone module:

npm install

###Note: Linux and *nix systems may require sudo to access the hid device interface.

*Not tested on all platforms. Platform tests appreciated

// require the LED module
var keyboard = require('msi-keyboard');

// Set left region to high intensity, color red
keyboard.color('left', {
    color: 'red',
	intensity: 'high'
});

// Set middle region to green default high intensity
keyboard.color('middle', 'green');


// Set right region to blue with light intensity
keyboard.color('right', {
	color: 'blue',
	intensity: 'light',
});


// Hardware modes
// Setting .color() will Not affect the hardware defined colors for modes

// Set Hardware mode to breath
keyboard.mode('breathe');


// Blinking
// Set the keyboard.color() Before calling .blink()
// Refer to examples/blinkMulti.js

// Blink all the keyboard LEDs to 750ms
keyboard.blink(750);


// Blink Only left and right regions at 750ms
keyboard.blink(['left','right'], 750);


// Use the default blink, time: 1000ms
keyboard.blink();


// Stop the blink after 5000ms
setTimeout(keyboard.stopBlink, 5000);

Colors

keyboard.colors(String region, String Color);

Colors must be set before using keyboard.blink();

They will not affect hardware-default modes such as Wave and Breathing.

The following colors are defined:

off
red
orange
yellow
green
sky
blue
purple
white

To set a color use keyboard.colors() There are two ways to set the color to a region:

keyboard.color('middle', 'green');
keyboard.color('middle', {color:'green', intensity:'high'});

Intensity

keyboard.colors(String region, {String color, String intensity});

The color intensity to white can be set via keyboard.colors();

The following intensities are used:

light
low
med
high

To set it:

keyboard.color('right', {
    color: 'blue',
	intensity: 'med',  // light, low, med, high
});

##Modes keyboard.mode(String mode);

MSI Steelseries keyboards have built in modes, with pre-defined colors.

The colors can not be altered via keyboard.colors();

The modes defined by the hardware are:

Normal
Gaming
Breathe
Demo
Wave

Usage:

keyboard.mode('wave');

##Regions keyboard.colors(String region, String color);

There are three regions on the Steelseries keyboard:

Left
Middle
Right

Each can have a color and intensity set.

##Blink keyboard.blink(Time milliseconds);

The time is the speed in which the keyboard is to blink.

keyboard.colors(); Must be set before using keyboard.blink();

Usage:

// keyboard.color(...);


keyboard.blink(750);

To blink one, or two regions only:

// keyboard.color(...);


keyboard.blink(['left','right'], 750);

Examples

You can view more examples in the example folder.

LICENSE

(MIT License)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

jblamotte/msi-keyboard