1
0
mirror of https://github.com/node-red/node-red-nodes.git synced 2023-10-10 13:36:58 +02:00

Update branch

This commit is contained in:
Nick O'Leary 2014-04-13 21:51:47 +01:00
commit 03f0d77526
2 changed files with 113 additions and 51 deletions

View File

@ -13,6 +13,7 @@
See the License for the specific language governing permissions and See the License for the specific language governing permissions and
limitations under the License. limitations under the License.
--> -->
<script type="text/x-red" data-template-name="HueNode"> <script type="text/x-red" data-template-name="HueNode">
@ -35,6 +36,11 @@
</select> </select>
</div> </div>
<div class="form-row">
<label for="node-input-brightness"><i class="icon-tag"></i>Change Brightness (0->100):</label>
<input type="text" id="node-input-brightness" placeholder="brightness">
</div>
<div class="form-row"> <div class="form-row">
<label for="node-input-color"><i class="icon-tag"></i>Select color:</label> <label for="node-input-color"><i class="icon-tag"></i>Select color:</label>
<input type="text" id="node-input-color" placeholder="color"> <input type="text" id="node-input-color" placeholder="color">
@ -50,29 +56,38 @@
<script type="text/x-red" data-help-name="HueNode"> <script type="text/x-red" data-help-name="HueNode">
<p>This node implements some basic functionality for managing a Philips Hue wireless Lamp system.</p> <p>This node implements some basic functionality for managing a Philips Hue wireless Lamp system.</p>
<p>To use it you need to have obtained a valid auth token (or username) from your Philips Hue Bridge. Read <a href="http://developers.meethue.com/gettingstarted.html" target="_blank">here</a> on how to do this.</p> <p>To use it you need to have obtained a valid auth token (or username) from your Philips Hue Bridge. Read <a href="http://developers.meethue.com/gettingstarted.html" target="_blank">here</a> on how to do this.</p>
<p>You can enter the ID (1, 2, ...) of a Lamp and turn it ON or OFF and also set its color. </p><p>By setting the status to AUTO, you can set the ON/OFF status as a message payload (e.g., msg.payload="ON") and the color through the message topic (e.g., msg.topic="EBF5FF") on the node input. Please note, in case you use both, the status selection overides the msg.payload!</p><p>Also, if you pass something like msg.payload="ALERT" the Lamp will flash once.</p> <p>You can enter the ID (1, 2, ...) of a Lamp and turn it ON or OFF, set the color and the brightness (0->100). </p><p>By setting the status to AUTO, you can set the lamp parameters using the message on the input node as follows:</p>
<ul>
<li>msg.lamp sets the lamp ID</li>
<li>msg.color sets the lamp color (e.g., msg.color="DF0101" will set the color to red)</li>
<li>msg.brightness sets the lamp brightness (e.g., msg.brightness=50)</li>
<li>msg.payload is used to se the lamp status (on/off/alert) (e.g., msg.payload="alert" will flash the Lamp once</li>
</ul>
<p>Please note, by setting the status to AUTO on the node configuration, the rest of the node parameters are ignored, you need to set all parameters through the message input.</p>
</script> </script>
<!-- Finally, the node type is registered along with all of its properties --> <!-- Finally, the node type is registered along with all of its properties -->
<script type="text/javascript"> <script type="text/javascript">
RED.nodes.registerType('HueNode',{ RED.nodes.registerType('HueNode',{
category: 'advanced-input', category: 'advanced-input', // the palette category
color:"#EFEFEF", color:"#EFEFEF",
defaults: { defaults: { // defines the editable properties of the node
name: {value:""}, name: {value:""}, // along with default values.
username: {value:"", required:true}, username: {value:"", required:true},
discovery_mode: {value: "", required:false}, discovery_mode: {value: "", required:false},
lamp_id: {value:"", required:false}, lamp_id: {value:"", required:false},
color: {value:"EBF5FF"}, color: {value:"EBF5FF"},
brightness: {value:"100"},
lamp_status:{} lamp_status:{}
}, },
inputs:1, inputs:1, // set the number of inputs - only 0 or 1
outputs:1, outputs:1, // set the number of outputs - 0 to n
icon: "hue.png", icon: "huemanage.png", // set the icon (held in public/icons)
label: function() { label: function() { // sets the default label contents
return this.name||"HueNode"; return this.name||this.topic||"HueNode";
}, },
labelStyle: function() { labelStyle: function() { // sets the class to apply to the label
return this.name?"node_label_italic":""; return this.name?"node_label_italic":"";
} }
}); });

View File

@ -18,14 +18,19 @@
* limitations under the License. * limitations under the License.
**/ **/
//Require node-hue-api //Require node-hue-api
var hue = require("node-hue-api"); var hue = require("node-hue-api");
var HueApi = require("node-hue-api").HueApi; var HueApi = require("node-hue-api").HueApi;
// Require main module
var RED = require(process.env.NODE_RED_HOME+"/red/red"); var RED = require(process.env.NODE_RED_HOME+"/red/red");
//store the IP address of the Hue Gateway //store the IP address of the Hue Gateway
var gw_ipaddress = ""; var gw_ipaddress = "";
var username, lamp_status, lamp_id, color;
var username, lamp_status, lamp_id, color, brightness;
function hexToRgb(hex) { function hexToRgb(hex) {
var result = /^#?([a-f\d]{2})([a-f\d]{2})([a-f\d]{2})$/i.exec(hex); var result = /^#?([a-f\d]{2})([a-f\d]{2})([a-f\d]{2})$/i.exec(hex);
@ -36,74 +41,113 @@ function hexToRgb(hex) {
} : null; } : null;
} }
// The main node definition - most things happen in here // The main node definition - most things happen in here
function HueNode(n) { function HueNode(n) {
// Create a RED node // Create a RED node
RED.nodes.createNode(this,n); RED.nodes.createNode(this,n);
var node = this;
//get parameters from user //get parameters from user
this.username = n.username; this.username = n.username;
this.lamp_status = n.lamp_status; this.lamp_status = n.lamp_status;
this.lamp_id = n.lamp_id; this.lamp_id = n.lamp_id;
this.color = n.color; this.color = n.color;
var node = this; this.brightness = n.brightness;
// Store local copies of the node configuration (as defined in the .html)
this.topic = n.topic;
var msg = {}; var msg = {};
msg.topic = this.topic;
this.on("input", function(msg){ this.on("input", function(msg){
//set the lamp status var myMsg = msg;
//first locate the Hue gateway: //set the lamp status
hue.locateBridges(function(err, result) { //first locate the Hue gateway:
hue.locateBridges(function(err, result) {
var msg2 = {}; var msg2 = {};
msg2.topic = this.topic; msg2.topic = this.topic;
if (err) throw err; if (err) throw err;
//check for found bridges //check for found bridges
if(result[0]!=null) { if(result[0]!=null) {
//save the IP address of the 1st bridge found //save the IP address of the 1st bridge found
this.gw_ipaddress = result[0].ipaddress; 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;
if(msg.payload=="ALERT"){
status = "ALERT";
}
else if(node.lamp_status=="ON" || msg.payload=="ON") status = "ON";
else if(node.lamp_status=="OFF" || msg.payload=="OFF") status = "OFF";
if(status=="ALERT") { //set light status
api.setLightState(node.lamp_id, state.alert()).then(displayResult).fail(displayError).done(); var api = new HueApi(this.gw_ipaddress, node.username);
} var lightState = hue.lightState;
else if(status=="ON") { var state = lightState.create();
if(node.color==null) {
api.setLightState(node.lamp_id, state.on().rgb(hexToRgb(msg.topic).r,hexToRgb(msg.topic).g,hexToRgb(msg.topic).b)).then(displayResult).fail(displayError).done(); var status;
var lamp = -1;
//check for AUTO status (lamp settings set through node input)
if(node.lamp_status=="AUTO") {
var color;
var brightness;
//get lamp id from msg.lamp:
lamp = myMsg.lamp;
//get brightness:
brightness = myMsg.brightness;
//get colour either from msg.color or msg.topic
if(myMsg.color!=null && myMsg.color.length>0) {
color = myMsg.color;
}
else if(myMsg.topic!=null && myMsg.topic.length>0) {
color = myMsg.topic;
}
//check the payload for on/off/alert:
//case of ALERT:
if(myMsg.payload=="ALERT" || myMsg.payload=="alert"){
api.setLightState(lamp, state.alert()).then(displayResult).fail(displayError).done();
}
//case of ON:
if(myMsg.payload=="ON" || myMsg.payload=="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();
}
} }
else { else {
api.setLightState(node.lamp_id, state.on().rgb(hexToRgb(node.color).r,hexToRgb(node.color).g,hexToRgb(node.color).b)).then(displayResult).fail(displayError).done(); //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();
} }
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);
} }
else { else {
api.setLightState(node.lamp_id, state.off()).then(displayResult).fail(displayError).done(); //bridge not found:
var msg = {};
msg.payload = "Bridge not found!";
node.send(msg);
} }
msg2.payload = 'Light with ID: '+node.lamp_id+ ' was set to '+status; });
node.send(msg2);
}
else {
//bridge not found:
var msg = {};
msg.payload = "Bridge not found!";
node.send(msg);
}
});
}); });
this.on("close", function() { this.on("close", function() {
// Called when the node is shutdown - eg on redeploy. // Called when the node is shutdown - eg on redeploy.
// Allows ports to be closed, connections dropped etc. // Allows ports to be closed, connections dropped etc.
@ -121,6 +165,9 @@ var displayError = function(err) {
console.error(err); console.error(err);
}; };
// Register the node by name. This must be called before overriding any of the // Register the node by name. This must be called before overriding any of the
// Node functions. // Node functions.
RED.nodes.registerType("HueNode",HueNode); RED.nodes.registerType("HueNode",HueNode);