# lumen

> Node.js lib for the Tabu Lumen

Latest version **2.0.0** (published 2015-11-01) · MIT license · 0 weekly downloads

## Install

```sh
npm install lumen
pnpm add lumen
yarn add lumen
bun add lumen
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.0 |
| Published | 2015-11-01 |
| First published | 2013-12-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 11 |
| Author | Sandeep Mistry |
| Maintainers | sandeepmistry |
| Keywords | tabu, lumen, bulb, smart bulb |

## Links

- npm: https://www.npmjs.com/package/lumen
- Repository: https://github.com/sandeepmistry/node-lumen
- Issues: https://github.com/sandeepmistry/node-lumen/issues
- npm.io page: https://npm.io/package/lumen

## Dependencies (1)

- [noble-device](https://npm.io/package/noble-device.md) ^1.1.0

## Recent versions

- 2.0.0 (latest) — 2015-11-01
- 1.0.0 — 2015-10-10
- 0.0.2 — 2013-12-26
- 0.0.1 — 2013-12-15

## README

# node-lumen

[![Analytics](https://ga-beacon.appspot.com/UA-56089547-1/sandeepmistry/node-lumen?pixel)](https://github.com/igrigorik/ga-beacon)

Node.js lib for the [Tabu Lumen](http://tabuproducts.com/shop/lumen-bulb/)

## Install

```sh
npm install lumen
```

## Usage

```javascript
var Lumen = require('lumen');
```

### Discover

```javascript
Lumen.discover(callback(lumen));
```

### Connect and setup

```javascript
lumen.connectAndSetUp(callback(error));
```

### Disconnect

```javascript
lumen.disconnect(callback);
```

### Device Info

```javascript
lumen.readDeviceName(callback(error, deviceName));

lumen.readSystemId(callback(error, systemId));

lumen.readSerialNumber(callback(error, serialNumber));

lumen.readModelNumber(callback(error, modelNumber));

lumen.readFirmwareRevision(callback(error, firmwareRevision));

lumen.readHardwareRevision(callback(error, hardwareRevision));

lumen.readSoftwareRevision(callback(error, softwareRevision));

lumen.readManufacturerName(callback(error, manufacturerName));
```

### Turn off

```javascript
lumen.turnOff(callback(error));
```

### Set modes

```javascript
lumen.coolMode(callback(error)); // cycles cool colors

lumen.warmMode(callback(error)); // cycles warm colors

lumen.disco2Mode(callback(error)); // cycles RGB quickly

lumen.disco1Mode(callback(error)); // cycles RGB slowly
```

### White

```javascript
// 0 - 100
var percentage = 100;

lumen.white(percentage, callback(error));
```

### Color

```javascript
// 0 - 99
var r = 99;
var g = 0;
var b = 0;

lumen.color(r, g, b, callback(error));
```

## Events

### Disconnect

```javascript
lumen.on('disconnect', callback);
```

---
_Source: https://npm.io/package/lumen · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._