Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.
Awesome Lists | Featured Topics | Projects
https://github.com/bahamas10/node-hue-sdk

Phillips Hue API library
https://github.com/bahamas10/node-hue-sdk
Last synced: 2 months ago
JSON representation
Phillips Hue API library
Host: GitHub
URL: https://github.com/bahamas10/node-hue-sdk
Owner: bahamas10
Created: 2015-11-29T01:21:16.000Z (about 9 years ago)
Default Branch: master
Last Pushed: 2019-02-20T20:28:36.000Z (almost 6 years ago)
Last Synced: 2024-10-03T13:24:48.816Z (3 months ago)
Language: JavaScript
Size: 11.7 KB
Stars: 5
Watchers: 5
Forks: 3
Open Issues: 0
Metadata Files:
- Readme: README.md
Awesome Lists containing this project

README

        Phillips Hue API

================

Phillips Hue API library

This library is intended to be a very thin wrapper around the Hue API.  It maps

1-to-1 to all endpoints listed in

http://www.developers.meethue.com/philips-hue-api

Installation

------------

    npm install hue-sdk

Usage

-----

``` js

var hue = require('hue-sdk');

hue.discover(function (err, result) {

  if (err)

    throw err;

  console.log(result);

  // => ["10.0.1.80"]

});

var client = new hue.Hue({

  host: '10.0.1.80',

  user: 'foobar'

});

client.lights(function (err, result) {

  if (err)

    throw err;

  console.log(result);

  // => array of lights, see

  // http://www.developers.meethue.com/documentation/lights-api#11_get_all_lights

});

```

API

---

### Discovery

`hue.discover([opts], function (err, result) {})`

Discover all Hue bridges on the current network - callsback with an array

of IP addresses for bridges found

- `opts.timeout` timeout in milliseconds, default is 3000

``` js

var discover = require('hue-sdk').discover;

discover(function (err, result) {

  if (err)

    throw err;

  console.log(result);

  // => ['10.0.1.80']

});

```

### Create User

`hue.createUser(host, user, function (err, result) {})`

Register a user on the bridge

``` js

var createUser = require('hue-sdk').createUser;

console.log('press link button');

createUser('hue-bridge', 'my-app#my-name', function (err, result) {

  if (err)

    throw err;

  console.log(result);

  // => [ { success: { username: '2ecf0a841659d5a22427258f3297157f' } } ]

});

```

### 1. Lights API

All methods below this must be called on a `Hue` instance... for example:

``` js

var Hue = require('hue-sdk').Hue;

var client = new Hue({

  host: '10.0.1.80',

  user: '2ecf0a841659d5a22427258f3297157f'

});

```

Where `user` is taken from the response in `hue.createUser` above

All methods that take a callback expect this signature

- `function (err, result)`

Where `err` is a possible error, and `result` is the JSON parsed

response directly from the Hue API

Some methods have aliases for easier usage, for example `client.getAllLights`

is aliased to `client.lights`

#### 1.1. Get all lights

http://www.developers.meethue.com/documentation/lights-api#11_get_all_lights

- `client.getAllLights(cb)`

- `client.lights(cb)`

#### 1.2. Get new lights

http://www.developers.meethue.com/documentation/lights-api#12_get_new_lights

- `client.newLights(cb)`

#### 1.3. Search for new lights

http://www.developers.meethue.com/documentation/lights-api#13_search_for_new_lights

- `client.searchForLights(cb)`

#### 1.4. Get light attributes and state

http://www.developers.meethue.com/documentation/lights-api#14_get_light_attributes_and_state

- `client.getLight(id, cb)`

- `client.light(id, cb)`

#### 1.5. Set light attributes (rename)

http://www.developers.meethue.com/documentation/lights-api#15_set_light_attributes_rename

- `client.setLightAttributes(id, data, cb)`

- `client.renameLight(id, data, cb)`

If `data` is given as a string, it will be used as the "name" property of the

body sent to the server, for example

``` js

client.setLightAttributes(0, {name: 'foo'}, function (err, result) {

});

```

is the same as

``` js

client.renameLight(0, 'foo', function (err, result) {

});

```

#### 1.6. Set light state

http://www.developers.meethue.com/documentation/lights-api#16_set_light_state

- `client.setLightState(id, data, cb)`

#### 1.7. Delete lights

http://www.developers.meethue.com/documentation/lights-api#17_delete_lights

- `client.deleteLight(id, cb)`

### 2. Groups API

#### 2.1. Get all groups

http://www.developers.meethue.com/documentation/groups-api#21_get_all_groups

- `client.getAllGroups(cb)`

- `client.groups(cb)`

#### 2.2. Create group

http://www.developers.meethue.com/documentation/groups-api#22_create_group

- `client.createGroup(data, cb)`

#### 2.3. Get group attributes

http://www.developers.meethue.com/documentation/groups-api#23_get_group_attributes

- `client.getGroupAttributes(id, cb)`

- `client.group(id, cb)`

#### 2.4. Set group attributes

http://www.developers.meethue.com/documentation/groups-api#24_set_group_attributes

- `client.setGroupAttributes(id, data, cb)`

- `client.modifyGroup(id, data, cb)`

#### 2.5. Set group state

http://www.developers.meethue.com/documentation/groups-api#25_set_group_state

- `client.setGroupState(id, data, cb)`

#### 2.6. Delete group

http://www.developers.meethue.com/documentation/groups-api#26_delete_group

- `client.deleteGroup(id, cb)`

### 3. Schedules API

#### 3.1. Get all schedules

http://www.developers.meethue.com/documentation/schedules-api-0#31_get_all_schedules

- `client.getAllSchedules(cb)`

- `client.schedules(cb)`

#### 3.2. Create schedule

http://www.developers.meethue.com/documentation/schedules-api-0#32_create_schedule

- `client.createSchedule(data, cb)`

#### 3.3. Get schedule attributes

http://www.developers.meethue.com/documentation/schedules-api-0#33_get_schedule_attributes

- `client.getScheduleAttributes(id, cb)`

- `client.schedule(id, cb)`

#### 3.4. Set schedule attributes

http://www.developers.meethue.com/documentation/schedules-api-0#34_set_schedule_attributes

- `client.setScheduleAttributes(id, data, cb)`

- `client.modifySchedule(id, data, cb)`

#### 3.5. Delete schedule

http://www.developers.meethue.com/documentation/schedules-api-0#35_delete_schedule

- `client.deleteSchedule(id, cb)`

### 4. Scenes API

#### 4.1. Get all scenes

http://www.developers.meethue.com/documentation/scenes-api#41_get_all_scenes

- `client.getAllScenes(cb)`

- `client.scenes(cb)`

#### 4.2. Create Scene

http://www.developers.meethue.com/documentation/scenes-api#42_create_scene

- `client.createScene(data, cb)`

#### 4.3. Modify Scene

http://www.developers.meethue.com/documentation/scenes-api#43_modify_scene

- `client.modifyScene(id, light, data, cb)`

#### 4.4. Recall a scene

http://www.developers.meethue.com/documentation/scenes-api#44_recall_scene

> To recall an existing scene you use the Groups API. Check out the Groups API

> set group state for details.

#### 4.5. Delete scene

http://www.developers.meethue.com/documentation/scenes-api#45_delete_scene

- `client.deleteScene(id, cb)`

#### 4.6. Get Scene

https://developers.meethue.com/documentation/scenes-api#46_get_scene

- `client.getScene(id, cb)`

- `client.scene(id, cb)`

### 5. Sensors API

#### 5.1. Get all sensors

http://www.developers.meethue.com/documentation/sensors-api#51_get_all_sensors

- `client.getAllSensors(cb)`

- `client.sensors(cb)`

#### 5.2. Create sensor

http://www.developers.meethue.com/documentation/sensors-api#52_create_sensor

- `client.createSensor(data, cb)`

#### 5.3. Find new sensors

http://www.developers.meethue.com/documentation/sensors-api#53_autodiscover_sensors

- `client.findNewSensors(cb)`

#### 5.4. Get new sensors

http://www.developers.meethue.com/documentation/sensors-api#54_getnew_sensors

- `client.newSensors(cb)`

#### 5.5. Get sensor

http://www.developers.meethue.com/documentation/sensors-api#55_get_sensor

- `client.getSensor(id, cb)`

- `client.sensor(id, cb)`

#### 5.6. Update Sensor

http://www.developers.meethue.com/documentation/sensors-api#56_update_sensor

- `client.updateSensor(id, data, cb)`

- `client.renameSensor(id, data, cb)`

If `data` is given as a string, it will be used as the "name" property of the

body sent to the server, for example

``` js

client.updateSensor(0, {name: 'foo'}, function (err, result) {

});

```

is the same as

``` js

client.renameSensor(0, 'foo', function (err, result) {

});

```

#### 5.7. Delete Sensor

http://www.developers.meethue.com/documentation/sensors-api#57_delete_sensor

- `client.deleteSensor(id, cb)`

#### 5.8. Change Sensor Config

http://www.developers.meethue.com/documentation/sensors-api#58_change_sensor_config

- `client.changeSensorConfig(id, data, cb)`

#### 5.9. Change Sensor State

http://www.developers.meethue.com/documentation/sensors-api#59_change_sensor_state

- `client.changeSensorState(id, data, cb)`

### 6. Rules API

#### 6.1. Get all rules

http://www.developers.meethue.com/documentation/rules-api#61_get_all_rules

- `client.getAllRules(cb)`

- `client.rules(cb)`

#### 6.2. Get Rule

http://www.developers.meethue.com/documentation/rules-api#62_get_rule

- `client.getRule(id, cb)`

- `client.rule(id, cb)`

#### 6.3. Create Rule

http://www.developers.meethue.com/documentation/rules-api#63_create_rule

- `client.createRule(data, cb)`

#### 6.4. Update Rule

http://www.developers.meethue.com/documentation/rules-api#64_update_rule

- `client.updateRule(id, data, cb)`

- `client.modifyRule(id, data, cb)`

#### 6.5. Delete Rule

http://www.developers.meethue.com/documentation/rules-api#65_delete_rule

- `client.deleteRule(id, cb)`

### 7. Configuration API

#### 7.1. Create user

http://www.developers.meethue.com/documentation/configuration-api#71_create_user

- `client.createUser(data, cb)`

NOTE: `hue.createUser` is preferred instead

#### 7.2 Get configuration

http://www.developers.meethue.com/documentation/configuration-api#72_get_configuration

- `client.getConfig(cb)`

- `client.config(cb)`

#### 7.3. Modify configuration

http://www.developers.meethue.com/documentation/configuration-api#73_modify_configuration

- `client.modifyConfig(data, cb)`

#### 7.4. Delete user from whitelist

http://www.developers.meethue.com/documentation/configuration-api#74_delete_user_from_whitelist

- `client.deleteUser(user, cb)`

#### 7.5. Get full state (datastore)

http://www.developers.meethue.com/documentation/configuration-api#75_get_full_state_datastore

- `client.fullState(cb)`

### 8. Info API

#### 8.1 Get all Timezones

http://www.developers.meethue.com/documentation/info-api#81_get_all_timezones

- `client.getAllTimezones(cb)`

- `client.timezones(cb)`

### Generic Request

- `client.request(opts, cb)`

- `client.get(path, cb)`

``` js

client.get('/lights', function (err, result) {

  // will do a GET request to /api//lights

  // and returned the JSON parsed HTTP body

});

```

License

-------

MIT License