node-hue v1.0.4

Node-hue

A minimalist approch to wrap the hue clip v2 api using pure javascript. There are no model objects and helper methods. The result of the calls are provided as they are returned by the hue bridge. The API methods return promises and can be used together with await.

Getting started

A hue user key is needed to access the bridge. This key can be obtained by following the advice here. Automatic discovery using mDNS is not supported. You need to know your hue bridge IP or have a valid host dns entry.

Example: List all lights

This example lists all lights with their ID and ui name.

const hueApi = require('node-hue');
run = async () => {
    const hue = hueApi.connect();
    let lights = await hue.getLights();
    lights.forEach(light => {
        console.log(light.id+"\t"+light.metadata.name);
    });
}
run();

Executing this example may produce a result like this one:

227cf111-a326-4d27-8d9f-c3e2e464b1a9    Kitchen lamp
c81f9556-b504-417d-8aee-2275b71a761d    Bedroom lamp
17c0bd7e-d7c3-43d6-9c85-a440ffa50930    Garden lamp

Using events

The library hue-push-client is used to retrieve the hue bridge notifications (server side events).

Example: React on events

This example lists endlessly for events emitted by the hue bridge.

const hueApi = require('node-hue');
run = async () => {
    const listener = (event) => {
        console.log(JSON.stringify(event,1,1));
    }
    const hue=hueApi.connect( {
        eventListener : listener   // The eventlistener is given as option
    });
}
run();

More examples can be found in the examples folder.

API connect options

The connect method accepts these options.

Environment variables

API reference

This API reference is generated from the list of supported resources provided by the hue api. It should cover all methods that are provided by the clip V2 api. If you want to access the hue api description, you need a developer login at the meethue side.

Motivation

There are tons of hue api libraries around for the usage with node.js. But most provide just a subset of the available features or are based on the v1 api. They are often written in typescript and using data models. May be convenient in the usage, but missing flexibility. This library is handling the http request/response while keeping the original response value and without wrapping or changing the json data expected by the hue bridge. The dependency list should be short. For a home automation service I need fast access to buttons, temperature sensors, motion sensors, lights together with the possibility to get push events from the bridge. I didn't found it in the existing libraries - so this one was born.