2013-11-28 23:52:26 +01:00
|
|
|
/**
|
|
|
|
* philips_hue.js
|
|
|
|
* Basic functionality for accessing and contolling a Philips Hue wireless Lamp
|
|
|
|
* Allows for bridge/gateway and light scanning, as well as Light ON/OFF/ALERT status update
|
|
|
|
* Requires node-hue-api https://github.com/peter-murray/node-hue-api
|
|
|
|
* Copyright 2013 Charalampos Doukas - @BuildingIoT
|
|
|
|
*
|
|
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
|
|
* you may not use this file except in compliance with the License.
|
|
|
|
* You may obtain a copy of the License at
|
|
|
|
*
|
|
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
*
|
|
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
|
|
* See the License for the specific language governing permissions and
|
|
|
|
* limitations under the License.
|
|
|
|
**/
|
|
|
|
|
2014-03-26 10:01:32 +01:00
|
|
|
|
2013-11-28 23:52:26 +01:00
|
|
|
//Require node-hue-api
|
|
|
|
var hue = require("node-hue-api");
|
|
|
|
var HueApi = require("node-hue-api").HueApi;
|
2014-03-26 10:01:32 +01:00
|
|
|
|
|
|
|
// Require main module
|
2013-11-28 23:52:26 +01:00
|
|
|
var RED = require(process.env.NODE_RED_HOME+"/red/red");
|
|
|
|
|
|
|
|
//store the IP address of the Hue Gateway
|
|
|
|
var gw_ipaddress = "";
|
2014-03-26 10:01:32 +01:00
|
|
|
|
|
|
|
|
|
|
|
var username, lamp_status, lamp_id, color, brightness;
|
2013-11-28 23:52:26 +01:00
|
|
|
|
|
|
|
function hexToRgb(hex) {
|
|
|
|
var result = /^#?([a-f\d]{2})([a-f\d]{2})([a-f\d]{2})$/i.exec(hex);
|
|
|
|
return result ? {
|
|
|
|
r: parseInt(result[1], 16),
|
|
|
|
g: parseInt(result[2], 16),
|
|
|
|
b: parseInt(result[3], 16)
|
|
|
|
} : null;
|
|
|
|
}
|
|
|
|
|
2014-03-26 10:01:32 +01:00
|
|
|
|
2013-11-28 23:52:26 +01:00
|
|
|
// The main node definition - most things happen in here
|
|
|
|
function HueNode(n) {
|
|
|
|
// Create a RED node
|
|
|
|
RED.nodes.createNode(this,n);
|
|
|
|
|
2014-03-26 10:01:32 +01:00
|
|
|
var node = this;
|
|
|
|
|
2013-11-28 23:52:26 +01:00
|
|
|
//get parameters from user
|
|
|
|
this.username = n.username;
|
|
|
|
this.lamp_status = n.lamp_status;
|
|
|
|
this.lamp_id = n.lamp_id;
|
|
|
|
this.color = n.color;
|
2014-03-26 10:01:32 +01:00
|
|
|
this.brightness = n.brightness;
|
|
|
|
|
|
|
|
|
|
|
|
// Store local copies of the node configuration (as defined in the .html)
|
|
|
|
this.topic = n.topic;
|
2013-11-28 23:52:26 +01:00
|
|
|
|
2014-03-26 10:01:32 +01:00
|
|
|
|
2013-11-28 23:52:26 +01:00
|
|
|
var msg = {};
|
2014-03-26 10:01:32 +01:00
|
|
|
|
|
|
|
msg.topic = this.topic;
|
2013-11-28 23:52:26 +01:00
|
|
|
|
|
|
|
this.on("input", function(msg){
|
2014-03-26 10:01:32 +01:00
|
|
|
var myMsg = msg;
|
|
|
|
//set the lamp status
|
|
|
|
//first locate the Hue gateway:
|
|
|
|
hue.locateBridges(function(err, result) {
|
|
|
|
|
|
|
|
var msg2 = {};
|
|
|
|
msg2.topic = this.topic;
|
|
|
|
if (err) throw err;
|
|
|
|
//check for found bridges
|
|
|
|
if(result[0]!=null) {
|
|
|
|
//save the IP address of the 1st bridge found
|
|
|
|
this.gw_ipaddress = result[0].ipaddress;
|
|
|
|
|
|
|
|
|
|
|
|
//set light status
|
|
|
|
var api = new HueApi(this.gw_ipaddress, node.username);
|
|
|
|
var lightState = hue.lightState;
|
|
|
|
var state = lightState.create();
|
|
|
|
|
|
|
|
var status;
|
|
|
|
var lamp = -1;
|
|
|
|
|
|
|
|
//check for AUTO status (lamp settings set through node input)
|
|
|
|
if(node.lamp_status=="AUTO") {
|
|
|
|
var color;
|
|
|
|
var brightness;
|
|
|
|
//check for lamp ID in the topic
|
|
|
|
if(myMsg.topic.length>1) {
|
|
|
|
var tmp_status = myMsg.topic.split(":");
|
|
|
|
myMsg.topic = tmp_status[1];
|
|
|
|
lamp = tmp_status[0];
|
|
|
|
}
|
|
|
|
|
|
|
|
//check for brightness & color:
|
|
|
|
if(myMsg.payload.length>1) {
|
|
|
|
var tmp_topic = myMsg.payload.split(":");
|
|
|
|
color = tmp_topic[0];
|
|
|
|
brightness = tmp_topic[1];
|
|
|
|
}
|
|
|
|
|
|
|
|
//case of ALERT:
|
|
|
|
if(myMsg.topic=="ALERT"){
|
|
|
|
api.setLightState(lamp, state.alert()).then(displayResult).fail(displayError).done();
|
|
|
|
}
|
|
|
|
|
|
|
|
//case of ON:
|
|
|
|
if(myMsg.topic=="ON") {
|
|
|
|
api.setLightState(lamp, state.on().rgb(hexToRgb(color).r,hexToRgb(color).g,hexToRgb(color).b).brightness(brightness)).then(displayResult).fail(displayError).done();
|
|
|
|
}
|
|
|
|
else {
|
|
|
|
api.setLightState(lamp, state.off()).then(displayResult).fail(displayError).done();
|
|
|
|
}
|
2013-11-28 23:52:26 +01:00
|
|
|
|
|
|
|
}
|
|
|
|
else {
|
2014-03-26 10:01:32 +01:00
|
|
|
//set lamp according to node settings
|
|
|
|
if(node.lamp_status=="ON")
|
|
|
|
api.setLightState(node.lamp_id, state.on().rgb(hexToRgb(node.color).r,hexToRgb(node.color).g,hexToRgb(node.color).b).brightness(node.brightness)).then(displayResult).fail(displayError).done();
|
|
|
|
else
|
|
|
|
api.setLightState(node.lamp_id, state.off()).then(displayResult).fail(displayError).done();
|
2013-11-28 23:52:26 +01:00
|
|
|
}
|
2014-03-26 10:01:32 +01:00
|
|
|
|
|
|
|
if(lamp!=-1)
|
|
|
|
msg2.payload = 'Light with ID: '+lamp+ ' was set to '+myMsg.payload;
|
|
|
|
else
|
|
|
|
msg2.payload = 'Light with ID: '+node.lamp_id+ ' was set to '+node.lamp_status;
|
|
|
|
node.send(msg2);
|
2013-11-28 23:52:26 +01:00
|
|
|
}
|
|
|
|
else {
|
2014-03-26 10:01:32 +01:00
|
|
|
//bridge not found:
|
|
|
|
var msg = {};
|
|
|
|
msg.payload = "Bridge not found!";
|
|
|
|
node.send(msg);
|
2013-11-28 23:52:26 +01:00
|
|
|
}
|
|
|
|
|
2014-03-26 10:01:32 +01:00
|
|
|
});
|
2013-11-28 23:52:26 +01:00
|
|
|
});
|
|
|
|
|
2014-03-26 10:01:32 +01:00
|
|
|
|
2013-11-28 23:52:26 +01:00
|
|
|
this.on("close", function() {
|
|
|
|
// Called when the node is shutdown - eg on redeploy.
|
|
|
|
// Allows ports to be closed, connections dropped etc.
|
|
|
|
// eg: this.client.disconnect();
|
|
|
|
});
|
|
|
|
|
|
|
|
}
|
|
|
|
|
|
|
|
//hue debugging on the output:
|
|
|
|
var displayResult = function(result) {
|
|
|
|
console.log(result);
|
|
|
|
};
|
|
|
|
|
|
|
|
var displayError = function(err) {
|
|
|
|
console.error(err);
|
|
|
|
};
|
|
|
|
|
2014-03-26 10:01:32 +01:00
|
|
|
|
|
|
|
|
|
|
|
|
2013-11-28 23:52:26 +01:00
|
|
|
// Register the node by name. This must be called before overriding any of the
|
|
|
|
// Node functions.
|
2014-01-12 13:06:13 +01:00
|
|
|
RED.nodes.registerType("HueNode",HueNode);
|