# buildlight

> node.js library for Delcom USB Visual Signal Indicator

Latest version **1.1.0** (published 2022-07-10) · 0 weekly downloads

## Install

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

## Health

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

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.0 |
| Published | 2022-07-10 |
| First published | 2013-04-16 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Node | >= 16.0.0 |
| Dependencies | 1 |
| Unpacked size | 18.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Cliffano Subagio |
| Maintainers | cliffano |
| Keywords | buildlight, delcom, usbled |

## Links

- npm: https://www.npmjs.com/package/buildlight
- Repository: https://github.com/cliffano/buildlight
- Homepage: http://github.com/cliffano/buildlight
- Issues: http://github.com/cliffano/buildlight/issues
- npm.io page: https://npm.io/package/buildlight

## Dependencies (1)

- [async](https://npm.io/package/async.md) ^3.2.4

## Recent versions

- 1.1.0 (latest) — 2022-07-10
- 1.0.0 — 2022-06-29
- 0.10.1 — 2015-06-21
- 0.10.0 — 2014-09-10
- 0.0.6 — 2014-01-13
- 0.0.5 — 2013-11-01
- 0.0.4 — 2013-08-27
- 0.0.3 — 2013-08-27
- 0.0.2 — 2013-06-28
- 0.0.1 — 2013-04-16

## README

<img align="right" src="https://raw.github.com/cliffano/buildlight/master/avatar.jpg" alt="Avatar"/>

[![Build Status](https://github.com/cliffano/buildlight/workflows/CI/badge.svg)](https://github.com/cliffano/buildlight/actions?query=workflow%3ACI)
[![Vulnerabilities Status](https://snyk.io/test/github/cliffano/buildlight/badge.svg)](https://snyk.io/test/github/cliffano/buildlight)
[![Dependencies Status](https://img.shields.io/david/cliffano/buildlight.svg)](http://david-dm.org/cliffano/buildlight)
[![Coverage Status](https://img.shields.io/coveralls/cliffano/buildlight.svg)](https://coveralls.io/r/cliffano/buildlight?branch=master)
[![Published Version](https://img.shields.io/npm/v/buildlight.svg)](http://www.npmjs.com/package/buildlight)
<br/>

BuildLight
----------

BuildLight is a node.js library for [Delcom USB Visual Indicator](http://www.delcomproducts.com/products_usblmp.asp).

This is handy when you want to control Delcom build light device from node.js . It currently only supports Linux platform with device generation 1 via usbled.

Installation
------------

    npm install buildlight

Usage
-----

    import BuildLight from '../lib/buildlight.js';
    const buildLight = new BuildLight();

    // switch on all colours
    buildLight.on();

    // switch off all colours
    buildLight.off();

    // switch on one colour
    buildLight.red();
    buildLight.green();
    buildLight.blue();

    // to use custom colour scheme
    buildLight = new BuildLight({ scheme: ['red', 'green', 'yellow'] });
    buildLight.yellow();

    // blinks with green colour then switch on blue when unblink is called 5 seconds later
    buildLight.blink('green', function (err) {
      if (err) {
        buildLight.red();
      }
    });
    setTimeout(function () {
      buildLight.unblink(function () {
        buildLight.blue();
      });
    }, 5000);

Colophon
--------

[Developer's Guide](http://cliffano.github.io/developers_guide.html#nodejs)

Build reports:

* [Code complexity report](http://cliffano.github.io/buildlight/complexity/plato/index.html)
* [Unit tests report](http://cliffano.github.io/buildlight/test/mocha.txt)
* [Test coverage report](http://cliffano.github.io/buildlight/coverage/c8/index.html)
* [Integration tests report](http://cliffano.github.io/buildlight/test-integration/mocha.txt)
* [API Documentation](http://cliffano.github.io/buildlight/doc/jsdoc/index.html)

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