node-red-nodes/hardware/hue/104-hue_manage.js

/**
 * 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.
 **/


//Require node-hue-api
var hue = require("node-hue-api");
var HueApi = require("node-hue-api").HueApi;

// Require main module
var RED = require(process.env.NODE_RED_HOME+"/red/red");

//store the IP address of the Hue Gateway
var gw_ipaddress = "";


var username, lamp_status, lamp_id, color, brightness;

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;
}

function setLights(node, myMsg) {

    var msg2 = {};
    msg2.topic = this.topic;

    //set light status
    var api = new HueApi(node.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;

        //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 {
        //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);
}


// The main node definition - most things happen in here
function HueNode(n) {
    // Create a RED node
    RED.nodes.createNode(this,n);

    var node = this;

    //get parameters from user
    this.username = n.username;
    this.lamp_status = n.lamp_status;
    this.lamp_id = n.lamp_id;
    this.gw_ipaddress = n.ip_address;
    this.color = n.color;
    this.brightness = n.brightness;

    // Store local copies of the node configuration (as defined in the .html)
    this.topic = n.topic;


    var msg = {};

    msg.topic = this.topic;

    this.on("input", function(msg){
        var myMsg = msg;
        //set the lamp status
        if (this.gw_ipaddress) {
            setLights(node, myMsg);
        } else {
            //first locate the Hue gateway:
            hue.locateBridges(function(err, result) {


                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;
                    setLights(node, myMsg);
                }
                else {
                    //bridge not found:
                    var msg = {};
                    msg.payload = "Bridge not found!";
                    node.send(msg);
                }

            });
        }
    });


    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);
};




// Register the node by name. This must be called before overriding any of the
// Node functions.
RED.nodes.registerType("HueNode",HueNode);