@hurenkam/hue-services 0.6.0

package/src/ui/DevicePowerUI.js

@@ -0,0 +1,27 @@
+import { ServiceUI } from "./ServiceUI.js"
+
+export class DevicePowerUI extends ServiceUI {
+    constructor() {
+        super("Device Power","hue services","device_power");
+        console.log("DevicePowerUI.constructor()");
+
+        this.config.color = "#B0E0FF";
+        this.config.icon = "font-awesome/fa-battery-three-quarters";
+    }
+
+    buildHelp() {
+        var help = super.buildHelp();
+        help["Outputs"] += "\
+The Device Power 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 device_power 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();
+    }
+}

package/src/ui/GroupedLightUI.js

@@ -0,0 +1,31 @@
+import { ServiceUI } from "./ServiceUI.js"
+
+export class GroupedLightUI extends ServiceUI {
+    constructor() {
+        super("Grouped Light","hue services","grouped_light");
+        console.log("GroupedLightUI.constructor()");
+
+        this.config.color = "#FFFFA8";
+        this.config.icon = "light.svg";
+    }
+
+    buildHelp() {
+        var help = super.buildHelp();
+        help["Inputs"] += "\
+The Grouped Light node accepts input. The `msg.payload` content (in JSON format) will be send as a put request to the associated Clip v2 resource url.\n\n\
+Please see the Hue CLIP API documentation: \n\n\
+https://developers.meethue.com/develop/hue-api-v2";
+        help["Outputs"] += "\
+The Grouped Light node only has one output. It will listen to Clip v2 events for this service \
+and forward them to the output as `msg.payload` which contains the grouped_light 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();
+    }
+}

package/src/ui/LightLevelUI.js

@@ -0,0 +1,27 @@
+import { ServiceUI } from "./ServiceUI.js"
+
+export class LightLevelUI extends ServiceUI {
+    constructor() {
+        super("Light Level","hue services","light_level");
+        console.log("LightLevelUI.constructor()");
+
+        this.config.color = "#FFFFFF";
+        this.config.icon = "font-awesome/fa-sun-o";
+    }
+
+    buildHelp() {
+        var help = super.buildHelp();
+        help["Outputs"] += "\
+The Light Level 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 light_level 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();
+    }
+}

package/src/ui/LightUI.js

@@ -0,0 +1,31 @@
+import { ServiceUI } from "./ServiceUI.js"
+
+export class LightUI extends ServiceUI {
+    constructor() {
+        super("Light","hue services","light");
+        console.log("LightUI.constructor()");
+
+        this.config.color = "#FFFFD8";
+        this.config.icon = "light.svg";
+    }
+
+    buildHelp() {
+        var help = super.buildHelp();
+        help["Inputs"] += "\
+The Light node accepts input. The `msg.payload` content (in JSON format) will be send as a put request to the associated Clip v2 resource url.\n\n\
+Please see the Hue CLIP API documentation: \n\n\
+https://developers.meethue.com/develop/hue-api-v2";
+        help["Outputs"] += "\
+The Light node only has one output. It will listen to Clip v2 events for this service \
+and forward them to the output as `msg.payload` which contains the light 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();
+    }
+}

package/src/ui/MotionUI.js

@@ -0,0 +1,27 @@
+import { ServiceUI } from "./ServiceUI.js"
+
+export class MotionUI extends ServiceUI {
+    constructor() {
+        super("Motion","hue services","motion");
+        console.log("MotionUI.constructor()");
+
+        this.config.color = "#FFC0FF";
+        this.config.icon = "font-awesome/fa-rss";
+    }
+
+    buildHelp() {
+        var help = super.buildHelp();
+        help["Outputs"] += "\
+The Motion 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 motion 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();
+    }
+}

package/src/ui/RelativeRotaryUI.js

@@ -0,0 +1,27 @@
+import { ServiceUI } from "./ServiceUI.js"
+
+export class RelativeRotaryUI extends ServiceUI {
+    constructor() {
+        super("Relative Rotary","hue services","relative_rotary");
+        console.log("RelativeRotaryUI.constructor()");
+
+        this.config.color = "#E0FFB0";
+        this.config.icon = "font-awesome/fa-circle-o-notch";
+    }
+
+    buildHelp() {
+        var help = super.buildHelp();
+        help["Outputs"] += "\
+The Relative Rotary 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 relative_rotary 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();
+    }
+}

package/src/ui/ResourceUI.js

@@ -0,0 +1,142 @@
+import { BaseUI } from "./BaseUI.js";
+
+export class ResourceUI extends BaseUI {
+    #rtype;
+    #models;
+
+    constructor(label="Resource",category="hue services",rtype=null,models=null) {
+        super(label,category);
+        console.log("ResourceUI.constructor()");
+
+        this.config.defaults.name =     { value:"" };
+        this.config.defaults.bridge =   { type: "BridgeConfigNode", required: true };
+        this.config.defaults.uuid =     { value:"", required: true };
+
+        this.config.inputs = 1;
+        this.config.color = "#EEEEEE";
+        this.config.icon = "font-awesome/fa-gears";
+
+        this.#rtype = rtype;
+        this.#models = models;
+    }
+
+    buildHelp() {
+        var help = super.buildHelp();
+        help["Settings"] += "\
+#### Bridge\n\
+Select the hue bridge for your device or resource.\n\n\
+#### UUID\n\
+Select the device or service by UUID, you can toggle between search \
+and manual input. The search will query the bridge for suitable devices \
+and present them as a selection list.\n\n\
+";
+        return help;
+    }
+
+    ui(){
+        var text = super.ui();
+        console.log("ResourceUI.ui()");
+        text += this.uiTextInput("bridge","Bridge");
+        text += this.uiSelectInput("uuid","UUID");
+        return text;
+    }
+
+    selectText(id) {
+        console.log("ResourceUI.selectText()");
+
+        var current = $('#node-input-'+id).val();
+        $('#input-select-'+id).empty();
+        $('#input-select-'+id).append('<input type="text" id="node-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");
+    }
+
+    selectOption(id,url,data) {
+        console.log("ResourceUI.selectOption()");
+        var current = $('#node-input-'+id).val();
+        var notification = RED.notify("Searching for options...", {
+            type: "compact", modal: true, fixed: true
+        });
+
+        $.get(url, data)
+        .done( function(data) {
+            var options = JSON.parse(data);
+
+            if(options.length <= 0)
+            {
+                notification.close();
+                RED.notify("No options found.", { type: "error" });
+                return false;
+            }
+
+            $("#node-input-"+id).typedInput({
+                types: [
+                    {
+                        value: current,
+                        options: options
+                    }
+                ]
+            });
+
+            var button = $("#input-select-"+id+"-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");
+        });
+    }
+
+    selectResource() {
+        console.log("ResourceUI.selectResource()");
+        var bridge_id = $('#node-input-bridge').val();
+        if(!bridge_id) {
+            console.log("ResourceUI.selectResource() invalid bridge_id:", bridge_id);
+            return;
+        }
+
+        var bridge = RED.nodes.node(bridge_id);
+        if(!bridge) {
+            console.log("ResourceUI.selectResource(): invalid bridge:", bridge);
+            return;
+        }
+
+        this.selectOption(
+            "uuid",
+            "BridgeConfigNode/GetSortedResourceOptions",
+            {
+                type: this.#rtype,
+                bridge_id: bridge.id,
+                models: this.#models
+            }
+        );
+    }
+
+    onEditPrepare(config) {
+        super.onEditPrepare(config);
+        console.log("ResourceUI.onEditPrepare()");
+        var instance = this;
+
+        $('#input-select-uuid-search').click(function()
+        {
+            if($('#input-select-uuid').find(".red-ui-typedInput-container").length > 0) {
+                instance.selectText("uuid");
+            } else {
+                instance.selectResource();
+            }
+        });
+        instance.selectResource();
+    }
+}

package/src/ui/SceneUI.js

@@ -0,0 +1,25 @@
+import { ResourceUI } from "./ResourceUI.js"
+
+export class SceneUI extends ResourceUI {
+    constructor() {
+        super("Scene","hue services","scene");
+        console.log("SceneUI.constructor()");
+
+        this.config.color = "#FFCCCC";
+        this.config.inputs = 1;
+        this.config.outputs = 1;
+        this.config.icon = "font-awesome/fa-tachometer";
+    }
+
+    buildHelp() {
+        var help = super.buildHelp();
+        help["Input"] = "\
+If you wish to send input to the scene, you need to address the scene specifically either by \
+adding its resource id to the `msg.rids` list (formatted as JSON), or adding the 'scene' type \
+to the `msg.rtypes` list (formatted as JSON).\n\
+The content of `msg.payload` will then be forwarded as a 'put' request to the clip v2 url \
+for the scene.\n\n\
+";
+        return help;
+    }
+}

package/src/ui/ServiceUI.js

@@ -0,0 +1,261 @@
+import { BaseUI } from "./BaseUI.js";
+
+export class ServiceUI extends BaseUI {
+    constructor(label="Service",category="hue services",rtype="") {
+        super(label,category);
+        console.log("ServiceUI.constructor(",label,category,rtype,")");
+
+        this.config.defaults.name =     { value:"" };
+        this.config.defaults.bridge =   { type: "BridgeConfigNode", required: true };
+        this.config.defaults.rtype =    { value:rtype, required: true };
+        this.config.defaults.owner =    { value:"", required: true };
+        this.config.defaults.uuid =     { value:"", required: true };
+
+        this.config.inputs = 1;
+        this.config.color = "#EEEEEE";
+        this.config.icon = "font-awesome/fa-gears";
+    }
+
+    buildHelp() {
+        var help = super.buildHelp();
+        help["Settings"] += "\
+#### Bridge\n\
+Select the hue bridge for your device or resource.\n\n\
+#### Type\n\
+If the node works for multiple types, then you can select a type here. Otherwise \
+the field is hidden. \
+\n\n\
+#### Owner\n\
+Here you can either fill in the UUID of the device that offers the service \
+or alternately you can select the owner from the available list of devices.\
+\n\n\
+#### UUID\n\
+If the selected owner offers only one service of the (pre)selected type, then \
+this field is hidden, and the one choice is automatically selected. \n\n\
+If not, then it offers you a choice of either filling in the UUID of the service \
+to be selected, or you can select one from the list which is offered. \
+\n\n\
+";
+        return help;
+    }
+
+    ui() {
+        var text = super.ui();
+        console.log("ServiceUI.ui()");
+
+        text += this.uiTextInput("bridge","Bridge");
+        text += this.uiSelectInput("rtype","Type");
+        text += this.uiSelectInput("owner","Owner");
+        text += this.uiSelectInput("uuid","UUID");
+        return text;
+    }
+
+    selectText(id) {
+        console.log("ServiceUI.selectText()");
+
+        var current = $('#node-input-'+id).val();
+        $('#input-select-'+id).empty();
+        $('#input-select-'+id).append('<input type="text" id="node-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");
+    }
+
+    selectOption(id,url,data) {
+        console.log("ServiceUI.selectOption()");
+        var current = $('#node-input-'+id).val();
+        var notification = RED.notify("Searching for options...", {
+            type: "compact", modal: true, fixed: true
+        });
+
+        $.get(url, data)
+        .done( function(data) {
+            var options = JSON.parse(data);
+
+            if(options.length <= 0)
+            {
+                notification.close();
+                RED.notify("No options found.", { type: "error" });
+                return false;
+            }
+
+            $("#node-input-"+id).typedInput({
+                types: [
+                    {
+                        value: current,
+                        options: options
+                    }
+                ]
+            });
+
+            var button = $("#input-select-"+id+"-search");
+            var icon = button.find("i");
+            icon.removeClass("fa-search");
+            icon.addClass("fa-pencil");
+
+            // Remove the notification
+            notification.close();
+        })
+        .fail(function()
+        {
+            console.log("ServiceUI.selectOption(): failed");
+
+            // Remove the notification
+            notification.close();
+            RED.notify("unknown error", "error");
+        });
+    }
+
+    selectType() {
+        console.log("ServiceUI.selectType()");
+        var bridge_id = $('#node-input-bridge').val();
+        var bridge = (bridge_id)? RED.nodes.node(bridge_id): null;
+
+        if ((!bridge_id) || (!bridge)) {
+            console.log("ResourceUI.selectResource(): invalid bridge:", bridge_id);
+            return;
+        }
+
+        this.selectOption(
+            "rtype",
+            "BridgeConfigNode/GetSortedTypeOptions",
+            {
+                bridge_id: bridge.id,
+            }
+        );
+    }
+
+    selectOwner() {
+        console.log("ServiceUI.selectOwner()");
+        var bridge_id = $('#node-input-bridge').val();
+        var bridge = (bridge_id)? RED.nodes.node(bridge_id): null;
+
+        if ((!bridge_id) || (!bridge)) {
+            console.log("ServiceUI.selectOwner(): invalid bridge:", bridge_id);
+            return;
+        }
+
+        var rtype = $('#node-input-rtype').val();
+        if (!rtype) {
+            console.log("ServiceUI.selectOwner(): invalid rtype:", rtype);
+            return;
+        }
+
+        console.log("ServiceUI.selectOwner()",bridge.id,rtype);
+        this.selectOption(
+            "owner",
+            "BridgeConfigNode/GetSortedOwnerOptions",
+            {
+                bridge_id: bridge.id,
+                rtype: rtype
+            }
+        );
+    }
+
+    selectService() {
+        console.log("ServiceUI.selectService()");
+
+        console.log("ServiceUI.selectService()");
+        var bridge_id = $('#node-input-bridge').val();
+        var bridge = (bridge_id)? RED.nodes.node(bridge_id): null;
+
+        if ((!bridge_id) || (!bridge)) {
+            console.log("ServiceUI.selectService(): invalid bridge:", bridge_id);
+            return;
+        }
+
+        var rtype = $('#node-input-rtype').val();
+        if (!rtype) {
+            console.log("ServiceUI.selectService(): invalid rtype:", rtype);
+            return;
+        }
+
+        var owner = $('#node-input-owner').val();
+        if (!owner) {
+            console.log("ServiceUI.selectService(): invalid owner:", owner);
+            return;
+        }
+
+        this.selectOption(
+            "uuid",
+            "BridgeConfigNode/GetSortedServiceOptions",
+            {
+                bridge_id: bridge.id,
+                rtype: rtype,
+                owner: owner
+            }
+        );
+    }
+
+    showServiceSelectionIfThereIsChoice() {
+        console.log("TemperatureUI[].showServiceSelectionIfThereIsChoice()");
+
+        var bridge = $('#node-input-bridge').val();
+        var owner = $('#node-input-owner').val();
+        var rtype = $('#node-input-rtype').val();
+        
+        if ((!bridge) || (!owner) || (owner=="") || (!rtype) || (rtype=="")) return;
+
+        $.get("BridgeConfigNode/GetSortedServiceOptions", {
+            bridge_id: bridge,
+            rtype: rtype,
+            owner: owner
+        })
+        .done(function(data) {
+            var options = JSON.parse(data);
+            console.log("Options:",options);
+            if (options.length == 1) {
+                $('#node-input-uuid').val(options[0].value);
+                $('#node-container-uuid').hide();
+            } else if (options.length > 1) {
+                $('#node-container-uuid').show();
+            }
+        })
+    };
+
+    onEditPrepare(config) {
+        super.onEditPrepare(config);
+        console.log("ServiceUI.onEditPrepare()",config);
+        var instance = this;
+
+        $('#input-select-rtype-search').click(function()
+        {
+            if($('#input-select-rtype').find(".red-ui-typedInput-container").length > 0) {
+                instance.selectText("rtype");
+            } else {
+                instance.selectType();
+            }
+        });
+
+        $('#input-select-owner-search').click(function()
+        {
+            if($('#input-select-owner').find(".red-ui-typedInput-container").length > 0) {
+                instance.selectText("owner");
+            } else {
+                instance.selectOwner();
+            }
+        });
+
+        $('#input-select-uuid-search').click(function()
+        {
+            if($('#input-select-uuid').find(".red-ui-typedInput-container").length > 0) {
+                instance.selectText("uuid");
+            } else {
+                instance.selectService();
+            }
+        });
+
+        $('#node-input-owner').change(function() {
+            console.log("TemperatureUI[].onEditPrepare().on('change')");
+            instance.showServiceSelectionIfThereIsChoice();
+            instance.selectText("uuid");
+            instance.selectService();
+        });
+
+        $('#node-container-uuid').hide();
+
+        this.showServiceSelectionIfThereIsChoice();
+    }
+}

package/src/ui/TemperatureUI.js

@@ -0,0 +1,27 @@
+import { ServiceUI } from "./ServiceUI.js"
+
+export class TemperatureUI extends ServiceUI {
+    constructor() {
+        super("Temperature","hue services","temperature");
+        console.log("TemperatureUI.constructor()");
+
+        this.config.color = "#A8FFFF";
+        this.config.icon = "font-awesome/fa-thermometer-half";
+    }
+
+    buildHelp() {
+        var help = super.buildHelp();
+        help["Outputs"] += "\
+The Temperature 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 temperature 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();
+    }
+}

package/src/ui/ZigbeeConnectivityUI.js

@@ -0,0 +1,27 @@
+import { ServiceUI } from "./ServiceUI.js"
+
+export class ZigbeeConnectivityUI extends ServiceUI {
+    constructor() {
+        super("Zigbee Connectivity","hue services","zigbee_connectivity");
+        console.log("ZigbeeConnectivityUI.constructor()");
+
+        this.config.color = "#E0B0FF";
+        this.config.icon = "font-awesome/fa-sitemap";
+    }
+
+    buildHelp() {
+        var help = super.buildHelp();
+        help["Outputs"] += "\
+The Zigbee Connectivity 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 zigbee_connectivity 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();
+    }
+}