hue-lib
v1.1.4
Published
A library for conveniently accessing and working with the Hue API.
Downloads
17
Readme
Hue Library
This tool was made to simplify the process of connecting to your Hue API, providing convenience functions for interacting with it.
Setup Instructions:
npm install hue-lib
- Respond to the command prompts for setup. You'll need physical access to your Hue Bridge. Follow the Special Setup Instructions if you don't have physical access to the Hue bridge during
npm install
.
Import Instructions
let hue = require('hue-lib');
Test Instructions
After a successful setup, run node node_modules/hue-lib/app.js on
or node node_modules/hue-lib/app.js off
to test. These will turn all your lights on or off, respectively.
Special Setup Instructions
If you don't follow the prompt or can't access your hue bridge when you first run the npm install, then you can manually access the setup functionality by running node node_modules/hue-lib/app.js setup
Overview
- All
hue.*Data()
functions follow the (err, data) callback structure, each aligning with the different core API endpoints (see https://www.developers.meethue.com/documentation/core-concepts):/lights
resource which contains all the light resources/groups
resource which contains all the groups/config
resource which contains all the configuration items/schedules
which contains all the schedules/scenes
which contains all the scenes/sensors
which contains all the sensors/rules
which contains all the rules
hue.switchLights()
orhue.switchLight()
will accept a boolean for whether all lights or a designated light address should be on or off