open-index/open-npm huggingface dataset:
npm package: @lumiastream/logitech-sdk
Description: 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.
Latest version: 0.0.5

# logisdk

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.

To use the full potential of the module, you need
supported hardware like the G910 keyboard and the
Logitech Gaming Software must be running.

## Installing

```
$ npm install @lumiastream/logitech-sdk
```

The module downloads prebuilt binaries from GitHUB
during the installation. Windows binaries are available for
the 32 and 64 bit versions of NodeJS and electron.

## Features

 * full support for all 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

## 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.

### Example

```javascript

var logisdk = require('@lumiastream/logitech-cove');

// always initialize the library first...
logisdk.init();

// note: you should wait a few milliseconds after initializing

// store the current lighting for restoring it later...
logisdk.saveCurrentLighting();

// set color of all keys to black (LEDs off)
logisdk.setLighting({
    redPercentage:   0,
    greenPercentage: 0,
    bluePercentage:  0
});

// ... wait a moment to see the effect

// set color of ESC key to blue
logisdk.setLightingForKeyWithKeyName({
    keyName: logisdk.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...
logisdk.restoreLighting();

// finally free the ressources again...
logisdk.shutdown();

```

## Building

This project features precompiled binaries for nodeJS, io.js and electron.

To compile the extension yourself you will need to get Microsoft Visual Studio
or the Microsoft Build Tools. To build logitech-sdk yourself, enter the module
folder and run:

```
$ npm i
$ npm run build
```

All subsequent builds only need `npm run build`

You can confirm everything built correctly by [running the test suite](#to-run-tests).

### To run tests:

Run checks against every API function.

```
$ npm test
```

### Furter Information

Visit the [LOGITECH G DEVELOPER LAB](http://gaming.logitech.com/en-us/developers).