NodeJS Bindings for the Logitech LED SDK. The Logitech LED SDK is used to control the RGB-LEDs of various logitech hardware like keyboard or mouse.
npm install logiled
$ npm install logiled
`
The module downloads prebuilt binaries from GitHUB
during the installation. Windows binaries are available for
the 32 and 64 bit versions of NodeJS, io.js and electron.
Features
* support for most functions of the Logitech LED SDK
* full TypeScript definitions for all methods, options, and key names
* fallback compatibility layer for non-Windows operating systems -
if not on Windows the module just behaves like the
Logitech Gaming Software has been exited under Windows
* works with node webkit
Usage
The module slightly changes the way data is sent to and
received from the LED SDK functions. If you need to pass
parameters you will have to use an object.
$3
`javascript
var logiled = require('logiled');
// always initialize the library first...
logiled.init();
// note: you should wait a few milliseconds after initializing
// store the current lighting for restoring it later...
logiled.saveCurrentLighting();
// set color of all keys to black (LEDs off)
logiled.setLighting({
redPercentage: 0,
greenPercentage: 0,
bluePercentage: 0
});
// ... wait a moment to see the effect
// set color of ESC key to blue
logiled.setLightingForKeyWithKeyName({
keyName: logiled.KeyName.ESC,
redPercentage: 0,
greenPercentage: 0,
bluePercentage: 100
});
// ... wait a moment to see the effect
// restore the lighting to the state it was saved earlier...
logiled.restoreLighting();
// finally free the ressources again...
logiled.shutdown();
`
Building
This project features precompiled binaries for nodeJS, and electron.
To compile the extension yourself you will need to get Microsoft Visual Studio
or the Microsoft Build Tools. To build logiled yourself, enter the module
folder and run:
`
$ npm i
$ npm run configure
$ npm run build
`
All subsequent builds only need npm run build
You can confirm everything built correctly by running the test suite.
$3
There are no prebuilt binaries for node-webkit (nw.js) but you can compile logiled
with nw-gyp.
$3
Run checks against every API function a/k/a funny blinking demo.
`
$ npm test
`
$3
Refer to the Logitech LED SDK documentation
in the _PDF_-File located at LED/Doc/LogitechGamingLEDSDK.pdf`