@hurenkam/hue-services 0.6.0

package/src/nodes/LightLevelNode.js

@@ -0,0 +1,39 @@
+ResourceNode = require("./ResourceNode");
+
+class LightLevelNode extends ResourceNode {
+    #info;
+    #trace;
+
+    constructor(config) {
+        super(config);
+        this.#info = require('debug')('info').extend('LightLevelNode').extend("["+this.logid()+"]");
+        this.#trace = require('debug')('trace').extend('LightLevelNode').extend("["+this.logid()+"]");
+        this.#info("constructor()");
+    }
+
+    onUpdate(event) {
+        this.#trace("onUpdate(",event,")");
+        this.updateStatus();
+        super.onUpdate(event);
+    }
+
+    updateStatus() {
+        this.#trace("updateStatus()");
+
+        var fill = "grey";
+        var shape = "dot";
+        var text = "";
+
+        var resource = this.resource();
+        if ((resource) && (resource.data()) && (resource.data().light)) {
+            if (resource.data().light.light_level!=null) {
+                fill = "green";
+                text = ""+resource.data().light.light_level;
+            }
+        }
+
+        this.status({fill: fill, shape: shape, text: text});
+    }
+}
+
+module.exports = LightLevelNode;

package/src/nodes/LightNode.js

@@ -0,0 +1,46 @@
+ResourceNode = require("./ResourceNode");
+
+class LightNode extends ResourceNode {
+    #info;
+    #trace;
+
+    constructor(config) {
+        super(config);
+        this.#info = require('debug')('info').extend('LightNode').extend("["+this.logid()+"]");
+        this.#trace = require('debug')('trace').extend('LightNode').extend("["+this.logid()+"]");
+        this.#info("constructor()");
+    }
+
+    onUpdate(event) {
+        this.#trace("onUpdate(",event,")");
+        this.updateStatus();
+        super.onUpdate(event);
+    }
+
+    updateStatus() {
+        this.#trace("updateStatus()");
+
+        var fill = "grey";
+        var shape = "dot";
+        var text = "";
+
+        var resource = this.resource();
+        if ((resource) && (resource.data()) && (resource.data().on)) {
+            if (resource.data().on.on==true) {
+                fill = "yellow";
+
+                if (resource.data().dimming) {
+                    text = resource.data().dimming.brightness+"%";
+                }
+
+            } else if (resource.data().on.on==false) {
+                fill = "grey";
+                text = "off";
+            }
+        }
+
+        this.status({fill: fill, shape: shape, text: text});
+     }
+}
+
+module.exports = LightNode;

package/src/nodes/MotionNode.js

@@ -0,0 +1,39 @@
+ResourceNode = require("./ResourceNode");
+
+class MotionNode extends ResourceNode {
+    #info;
+    #trace;
+
+    constructor(config) {
+        super(config);
+        this.#info = require('debug')('info').extend('MotionNode').extend("["+this.logid()+"]");
+        this.#trace = require('debug')('trace').extend('MotionNode').extend("["+this.logid()+"]");
+        this.#info("constructor()");
+    }
+
+    onUpdate(event) {
+        this.#trace("onUpdate(",event,")")
+        this.updateStatus();
+        super.onUpdate(event);
+    }
+
+    updateStatus() {
+        this.#trace("updateStatus()")
+
+        var fill = "grey";
+        var shape = "dot";
+        var text = "";
+
+        var resource = this.resource();
+        if ((resource) && (resource.data()) && (resource.data().motion)) {
+            if (resource.data().motion.motion!=null) {
+                fill = (resource.data().motion.motion==true)? "blue" : "grey";
+                text = (resource.data().motion.motion==true)? "motion" : "no motion";
+            }
+        }
+
+        this.status({fill: fill, shape: shape, text: text});
+    }
+}
+
+module.exports = MotionNode;

package/src/nodes/RelativeRotaryNode.js

@@ -0,0 +1,55 @@
+ResourceNode = require("./ResourceNode");
+
+class RelativeRotaryNode extends ResourceNode {
+    #fill;
+
+    #info;
+    #trace;
+
+    constructor(config) {
+        super(config);
+        this.#info = require('debug')('info').extend('RelativeRotaryNode').extend("["+this.logid()+"]");
+        this.#trace = require('debug')('trace').extend('RelativeRotaryNode').extend("["+this.logid()+"]");
+        this.#info("constructor()");
+
+        this.#fill = "grey";
+    }
+
+    onUpdate(event) {
+        this.#trace("onUpdate(",event,")");
+        this.#fill = "blue";
+        
+        var instance = this;
+        setTimeout(()=>{
+            instance.#fill = "grey";
+            instance.updateStatus();
+        },1000);
+
+        this.updateStatus();
+        super.onUpdate(event);
+    }
+
+    updateStatus() {
+        this.#trace("updateStatus()");
+
+        var fill = this.#fill;
+        var shape = "dot";
+        var text = "";
+
+        var resource = this.resource();
+        if ((resource) && (resource.data()) && (resource.data().relative_rotary)) {
+            if (resource.data().relative_rotary.last_event!=null) {
+                var event = resource.data().relative_rotary.last_event;
+                text = event.action;
+                if (event.rotation) {
+                    text += (event.rotation.direction == "clock_wise")? " >> " : " << ";
+                    text += event.rotation.duration + " | " + event.rotation.steps;
+                }
+            }
+        }
+
+        this.status({fill: fill, shape: shape, text: text});
+    }
+}
+
+module.exports = RelativeRotaryNode;

package/src/nodes/ResourceNode.js

@@ -0,0 +1,95 @@
+BaseNode = require("./BaseNode");
+
+const _error = require('debug')('error').extend('ResourceNode');
+const _warn  = require('debug')('warn').extend('ResourceNode');
+const _info  = require('debug')('info').extend('ResourceNode');
+const _trace = require('debug')('trace').extend('ResourceNode');
+
+class ResourceNode extends BaseNode {
+    #onUpdate;
+    #resource;
+
+    #error;
+    #warn;
+    #info;
+    #trace;
+
+    constructor(config) {
+        super(config);
+
+        this.#error = _error.extend("["+this.logid()+"]");
+        this.#warn  = _warn. extend("["+this.logid()+"]");
+        this.#info  = _info. extend("["+this.logid()+"]");
+        this.#trace = _trace.extend("["+this.logid()+"]");
+
+        this.#info("constructor()");
+        if (this.bridge()) {
+            this.bridge().requestStartup(this);
+        }
+    }
+
+    start(resource) {
+        if (resource==null)
+            return;
+
+        this.#info("start()");
+        this.#resource = resource;
+
+        var instance = this;
+        this.#onUpdate = function(event) {
+            instance.onUpdate(event);
+        }
+
+        this.resource().on('update',this.#onUpdate);
+        this.updateStatus();
+    }
+
+    destructor() {
+        this.#info("destructor()");
+        this.removeAllListeners();
+        this.#resource = null;
+        super.destructor();
+    }
+
+    resource() {
+        return this.#resource;
+    }
+
+    rid() {
+        return this.config.uuid;
+    }
+
+    bridge() {
+        return BaseNode.nodeAPI.nodes.getNode(this.config.bridge);
+    }
+
+    onUpdate(event) {
+        this.#trace("onUpdate()");
+        this.send({ payload: event });
+    }
+
+    onInput(msg) {
+        var resource = this.resource();
+        if (!resource) {
+            this.#trace("onInput(): Resource not found",this.rid());
+        }
+
+        if (msg.rtypes) {
+            if ((resource) && (msg.rtypes.includes(resource.rtype()))) {
+                this.#trace("onInput(",msg.payload,")");
+                resource.put(msg.payload);
+            }
+        }
+
+        if (msg.rids) {
+            if ((resource) && (msg.rids.includes(resource.rid()))) {
+                this.#trace("onInput(",msg.payload,")");
+                resource.put(msg.payload);
+            }
+        }
+
+        super.onInput(msg);
+    }
+}
+
+module.exports = ResourceNode;

package/src/nodes/SceneNode.js

@@ -0,0 +1,13 @@
+ServiceNode = require("./ServiceNode");
+
+class SceneNode extends ServiceNode {
+    #info;
+
+    constructor(config) {
+        super(config,"scene");
+        this.#info = require('debug')('info').extend('SceneNode').extend("["+this.logid()+"]");
+        this.#info("constructor()");
+    }
+}
+
+module.exports = SceneNode;

package/src/nodes/ServiceNode.js

@@ -0,0 +1,13 @@
+ResourceNode = require("./ResourceNode");
+
+class ServiceNode extends ResourceNode {
+    #info;
+
+    constructor(config) {
+        super(config);
+        this.#info = require('debug')('info').extend('ServiceNode').extend("["+this.logid()+"]");
+        this.#info("constructor()");
+    }
+}
+
+module.exports = ServiceNode;

package/src/nodes/TemperatureNode.js

@@ -0,0 +1,39 @@
+ResourceNode = require("./ResourceNode");
+
+class TemperatureNode extends ResourceNode {
+    #info;
+    #trace;
+
+    constructor(config) {
+        super(config);
+        this.#info = require('debug')('info').extend('TemperatureNode').extend("["+this.logid()+"]");
+        this.#trace = require('debug')('trace').extend('TemperatureNode').extend("["+this.logid()+"]");
+        this.#info("constructor()");
+    }
+
+    onUpdate(event) {
+        this.#trace("onUpdate(",event,")");
+        this.updateStatus();
+        super.onUpdate(event);
+    }
+
+    updateStatus() {
+        this.#trace("updateStatus()");
+
+        var fill = "grey";
+        var shape = "dot";
+        var text = "";
+
+        var resource = this.resource();
+        if ((resource) && (resource.data()) && (resource.data().temperature)) {
+            if (resource.data().temperature.temperature!=null) {
+                fill = "green";
+                text = ""+resource.data().temperature.temperature+"c";
+            }
+        }
+
+        this.status({fill: fill, shape: shape, text: text});
+    }
+}
+
+module.exports = TemperatureNode;

package/src/nodes/ZigbeeConnectivityNode.js

@@ -0,0 +1,38 @@
+ResourceNode = require("./ResourceNode");
+
+class ZigbeeConnectivityNode extends ResourceNode {
+    #info;
+    #trace;
+
+    constructor(config) {
+        super(config);
+        this.#info = require('debug')('info').extend('ZigbeeConnectivityNode').extend("["+this.logid()+"]");
+        this.#trace = require('debug')('trace').extend('ZigbeeConnectivityNode').extend("["+this.logid()+"]");
+        this.#info("constructor()");
+    }
+
+    onUpdate(event) {
+        this.#trace("onUpdate()");
+        this.updateStatus();
+        super.onUpdate(event);
+    }
+
+    updateStatus() {
+        this.#trace("updateStatus()");
+        super.updateStatus();
+
+        var fill = "grey";
+        var shape = "dot";
+        var text = "";
+
+        var resource = this.resource();
+        if ((resource) && (resource.data) && (resource.data().status!=null)) {
+            fill = (resource.data().status == "connected")? "green": "red";
+            text = resource.data().status;
+        }
+
+        this.status({fill: fill, shape: shape, text: text});
+    }
+}
+
+module.exports = ZigbeeConnectivityNode;

package/src/ui/BaseUI.js

@@ -0,0 +1,133 @@
+export class BaseUI {
+    #category;
+
+    constructor(label="Base", category="base") {
+        console.log("BaseUI.constructor()");
+        this.#category = category;
+
+        var instance = this;
+        this.config = {
+            category: category,
+            defaults: {
+                name:      { value: "" },
+                inputs:    { value: 1 },
+                outputs:   { value: 1 }
+            },
+            label: function() {
+                return this.name||label;
+            },
+            paletteLabel: label,
+            oneditprepare: function() { instance.onEditPrepare(this) },
+            oneditsave:    function() { instance.onEditSave(this) },
+            oneditcancel:  function() { instance.onEditCancel(this) },
+        }
+    }
+
+    buildHelp() {
+        return {
+            "intro": "",
+            "Settings": "",
+            "Input": "",
+            "Outputs": "",
+            "Details": ""
+        }
+    }
+
+    ui() {
+        console.log("BaseUI.ui()");
+        var text = "";
+        text += this.uiTextInput("name","Name");
+        return text;
+    }
+
+    uiTextInput(id,label) {
+        console.log("BaseUI.uiTextInput("+id+")");
+        var prefix = (this.#category=="config")? "node-config-input-" : "node-input-";
+
+        var item = document.createElement("div");
+        item.setAttribute("class","form-row");
+        item.setAttribute("id","node-container-" + id);
+        item.innerHTML = '\
+            <label for="' + prefix + id +'"><i class="fa fa-tag"></i> '+ label +'</label>\
+            <input type="text" id="' + prefix + id + '">';
+        return item.outerHTML;
+    }
+
+    uiNumberInput(id,label) {
+        console.log("BaseUI.uiNumberInput("+id+")");
+        var prefix = (this.#category=="config")? "node-config-input-" : "node-input-";
+
+        var item = document.createElement("div");
+        item.setAttribute("class","form-row");
+        item.setAttribute("id","node-container-" + id);
+        item.innerHTML = '\
+            <label for="' + prefix + id +'"><i class="fa fa-tag"></i> '+ label +'</label>\
+            <input type="number" id="' + prefix + id + '">';
+        return item.outerHTML;
+    }
+
+    uiCheckboxInput(id,label) {
+        console.log("BaseUI.checkboxInput("+id+")");
+        var prefix = (this.#category=="config")? "node-config-input-" : "node-input-";
+
+        var item = document.createElement("div");
+        item.setAttribute("class","form-row");
+        item.setAttribute("id","node-container-" + id);
+        item.innerHTML = '\
+            <div style="display: inline-flex; width: calc(100% - 105px)">\
+                <div id="input-select-'+ id +'" style="flex-grow: 1;">\
+                    <input type="checkbox" id="' + prefix + id +'" style="flex: 15px;">\
+                </div>\
+                <span style="width: 100%; margin-left: 10px;">\
+                    '+ label +'\
+                </span>\
+            </div>';
+        return item.outerHTML;
+    }
+
+    uiSelectInput(id,label) {
+        console.log("BaseUI.uiSelectInput("+id+")");
+        var prefix = (this.#category=="config")? "node-config-input-" : "node-input-";
+
+        var item = document.createElement("div");
+        item.setAttribute("class","form-row");
+        item.setAttribute("id","node-container-" + id);
+        item.innerHTML = '\
+            <label for="' + prefix + id +'"><i class="fa fa-tag"></i> '+ label +'</label>\
+            <div style="display: inline-flex; width: calc(100% - 105px)">\
+                <div id="input-select-'+ id +'" style="flex-grow: 1;">\
+                    <input type="text" id="' + prefix + id +'" style="width: 100%">\
+                </div>\
+                <button id="input-select-'+ id +'-search" type="button" class="red-ui-button" style="margin-left: 10px;">\
+                    <i class="fa fa-search"></i>\
+                </button>\
+            </div>';
+        return item.outerHTML;
+    }
+    
+    manual() {
+        var text = "";
+        var help = this.buildHelp();
+        Object.keys(help).forEach((key)=>{
+            if ((help[key]) && (help[key]!="")) {
+                if (key != "intro") {
+                    text += "\n### " + key + "\n";
+                }
+                text += help[key];
+            }
+        });
+        return text;
+    }
+
+    onEditPrepare(config) {
+        console.log("BaseUI.onEditPrepare()");
+    }
+
+    onEditSave(config) {
+        console.log("BaseUI.onEditSave()");
+    }
+
+    onEditCancel(config) {
+        console.log("BaseUI.onEditCancel()");
+    }
+}

package/src/ui/BridgeConfigUI.js

@@ -0,0 +1,130 @@
+import { BaseUI } from "./BaseUI.js"
+
+export class BridgeConfigUI extends BaseUI {
+    constructor() {
+        super("BridgeConfig","config");
+        console.log("BridgeConfigUI.constructor()");
+
+        this.config.defaults.ip =  { value:"", required: true }
+        this.config.defaults.key = { value:"", required: true }
+    }
+
+    ui() {
+        var text = super.ui();
+        text += this.uiSelectInput("ip","IP");
+        text += this.uiSelectInput("key","Key");
+        return text;
+    }
+
+    selectText(id) {
+        //console.log("BridgeConfigUI.selectText()");
+
+        var current = $('#node-config-input-'+id).val();
+        $('#input-select-'+id).empty();
+        $('#input-select-'+id).append('<input type="text" id="node-config-input-'+id+'" style="width: 100%" value="'+current+'" />');
+
+        var button = $("#input-select-"+id+"-search");
+        var icon = button.find("i");
+        icon.removeClass("fa-pencil");
+        icon.addClass("fa-search");
+    }
+
+    selectIp() {
+        //console.log("BridgeConfigUI.selectIp()");
+        var current = $('#node-config-input-ip').val();
+        var notification = RED.notify("Searching for bridges...", {
+            type: "compact", modal: true, fixed: true
+        });
+
+        $.get("/BridgeConfigNode/DiscoverBridges",{})
+        .done( function(data) {
+            var options = JSON.parse(data);
+
+            if(options.length <= 0)
+            {
+                notification.close();
+                RED.notify("No options found.", { type: "error" });
+                return false;
+            }
+
+            $("#node-config-input-ip").typedInput({
+                types: [
+                    {
+                        value: current,
+                        options: options
+                    }
+                ]
+            });
+
+            var button = $("#input-select-ip-search");
+            var icon = button.find("i");
+            icon.removeClass("fa-search");
+            icon.addClass("fa-pencil");
+
+            // Remove the notification
+            notification.close();
+        })
+        .fail(function()
+        {
+            console.log("ResourceUI.selectOption(): failed");
+
+            // Remove the notification
+            notification.close();
+            RED.notify("unknown error", "error");
+        });
+    }
+
+    acquireKey() {
+        //console.log("BridgeConfigUI.aquireKey()");
+        var ip = $('#node-config-input-ip').val();
+        var key = $('#node-config-input-key').val();
+        if (!ip) {
+            console.log("BridgeConfigUI.acquireKey(): no ip address selected");
+            return;
+        }
+
+        var notification = RED.notify("Press the button on the bridge...", {
+            type: "compact", modal: true, fixed: true
+        });
+
+        $.get("/BridgeConfigNode/AcquireApplicationKey",{ ip: ip })
+        .done( function(response) {
+            var data = JSON.parse(response);
+            //console.log("BridgeConfigUI.acquireKey()",data);
+            notification.close();
+            if (Object.keys(data).includes("key")) {
+                $('#node-config-input-key').val(data.key);
+            } else {
+                RED.notify(data.error.description, "error");
+            }
+        })
+        .fail(function()
+        {
+            notification.close();
+            RED.notify("unknown error", "error");
+        });
+    }
+
+    onEditPrepare(config) {
+        //console.log("BridgeConfigUI.onEditPrepare()");
+        var instance = this;
+
+        $('#input-select-ip-search').click(function()
+        {
+            if($('#input-select-ip').find(".red-ui-typedInput-container").length > 0) {
+                instance.selectText("ip");
+            } else {
+                instance.selectIp();
+            }
+        });
+
+        $('#input-select-key-search').click(function()
+        {
+            if($('#input-select-key').find(".red-ui-typedInput-container").length > 0) {
+                instance.selectText("key");
+            } else {
+                instance.acquireKey();
+            }
+        });
+    }
+}

package/src/ui/ButtonUI.js

@@ -0,0 +1,27 @@
+import { ServiceUI } from "./ServiceUI.js"
+
+export class ButtonUI extends ServiceUI {
+    constructor() {
+        super("Button","hue services","button");
+        console.log("ButtonUI.constructor()");
+
+        this.config.color = "#B0FFE0";
+        this.config.icon = "font-awesome/fa-circle";
+    }
+
+    buildHelp() {
+        var help = super.buildHelp();
+        help["Outputs"] += "\
+The Button node only has one output. It will listen to events for the specified service \
+and forward them to the output as `msg.payload` which contains the button events in a \
+JSON format conform the clip v2 specification.\n\n\
+Please see the Hue CLIP API documentation: \n\n\
+https://developers.meethue.com/develop/hue-api-v2";
+        return help;
+    }
+
+    onEditPrepare(config) {
+        super.onEditPrepare(config);
+        $('#node-container-rtype').hide();
+    }
+}