https://github.com/cunningdj/hue-lib

Library for easily accessing the Hue API.
https://github.com/cunningdj/hue-lib

api api-client hue hue-api hue-bridge hue-lights light nodejs philips-hue

Last synced: about 17 hours ago
JSON representation

Library for easily accessing the Hue API.

• Host: GitHub
• URL: https://github.com/cunningdj/hue-lib
• Owner: CunningDJ
• Created: 2018-02-14T00:50:14.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2018-02-18T21:17:57.000Z (over 6 years ago)
• Last Synced: 2024-10-08T15:14:20.070Z (about 1 month ago)
• Topics: api, api-client, hue, hue-api, hue-bridge, hue-lights, light, nodejs, philips-hue
• Language: JavaScript
• Size: 28.3 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

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:

1. `npm install hue-lib`

2. Respond to the command prompts for setup.  You'll need physical access to your Hue Bridge.  Follow the [Special Setup Instructions](#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()` or `hue.switchLight()` will accept a boolean for whether all lights or a designated light address should be on or off