node-red-contrib-huemagic 4.2.2 → 5.0.1

package/huemagic/hue-buttons.js

@@ -2,12 +2,35 @@ module.exports = function(RED)
 {
 	"use strict";
 
+	//
+	// DOES A BUTTON EVENT MATCH THE RULE OF AN ADDITIONAL OUTPUT?
+	function matchesRule(buttonState, rule)
+	{
+		// BUTTON OUTSIDE THE RANGE THE RULE WATCHES?
+		if(buttonState.button < parseInt(rule.buttonFrom) || buttonState.button > parseInt(rule.buttonTo)) { return false; }
+
+		switch (buttonState.actionType)
+		{
+			case "PRESS_START":
+				return !!rule.onStartPress;
+			case "SHORT":
+				return !!rule.onEndShortPress;
+			case "LONG_ONGOING":
+				return !!rule.onDuringLongPress;
+			case "LONG":
+				return (!!rule.onEndLongPress && buttonState.actionDuration >= (parseInt(rule.minLongPressDuration) || 0));
+			default:
+				return false;
+		}
+	}
+
 	function HueButtons(config)
 	{
 		RED.nodes.createNode(this, config);
 
 		const scope = this;
 		const bridge = RED.nodes.getNode(config.bridge);
+		const async = require('async');
 
 		// NODE UI STATUS TIMEOUT
 		this.timeout = null;
@@ -15,6 +38,17 @@ module.exports = function(RED)
 		// SAVE LAST COMMAND
 		this.lastCommand = null;
 
+		// SAVE THE LAST STATE OF EVERY DEVICE AND BUTTON
+		scope.buttonLastStates = {};
+
+		//
+		// CLOSE NODE
+		this.on('close', function()
+		{
+			if(scope.timeout !== null) { clearTimeout(scope.timeout); }
+			if(scope.unsubscribe) { scope.unsubscribe(); }
+		});
+
 		//
 		// CHECK CONFIG
 		if(bridge == null)
@@ -39,15 +73,65 @@ module.exports = function(RED)
 
 		//
 		// SUBSCRIBE TO UPDATES FROM THE BRIDGE
-		bridge.subscribe("button", config.sensorid, function(info)
+		this.unsubscribe = bridge.subscribe("button", config.sensorid, function(info)
 		{
 			let currentState = bridge.get("button", info.id);
 
 			// RESOURCE FOUND?
 			if(currentState !== false)
 			{
+				const hasEvent = (currentState.payload.button !== false || currentState.payload.rotation !== false);
+
+				// TRACK THE STATE OF THE PRESSED BUTTON, WHICH GIVES THE ADDITIONAL OUTPUTS THEIR PRESS DURATION
+				let buttonState = {};
+
+				if(currentState.payload.button !== false)
+				{
+					// EVERY DEVICE NUMBERS ITS BUTTONS FROM 1, SO THE STATE HAS TO BE KEPT PER DEVICE AND BUTTON
+					const buttonKey = info.id + ":" + currentState.payload.button;
+					buttonState = scope.buttonLastStates[buttonKey] || {};
+
+					switch (currentState.payload.action)
+					{
+						case "initial_press":
+							// START OF A SHORT OR A LONG PRESS
+							buttonState = { actionType: "PRESS_START", actionStart: Date.now() };
+							break;
+
+						case "long_press":
+						case "repeat":
+							// THE BRIDGE SENDS THIS EVENT EVERY 0.5 SECONDS WHILE THE BUTTON IS STILL HELD DOWN
+							buttonState.actionType = "LONG_ONGOING";
+							buttonState.actionEnd = Date.now();
+							break;
+
+						case "short_release":
+						case "double_short_release":
+							// PRESS SHORTER THAN 0.5 SECONDS
+							buttonState.actionType = "SHORT";
+							buttonState.actionStart = Date.now();
+							buttonState.actionEnd = Date.now();
+							break;
+
+						case "long_release":
+							// RELEASE AFTER A LONG PRESS
+							buttonState.actionType = "LONG";
+							buttonState.actionEnd = Date.now();
+							break;
+
+						default:
+							// UNKNOWN ACTION, MUST NOT INHERIT THE TYPE OF THE PREVIOUS ONE
+							buttonState.actionType = false;
+					}
+
+					buttonState.button = currentState.payload.button;
+					buttonState.actionDuration = (buttonState.actionEnd - buttonState.actionStart) || 0;
+
+					scope.buttonLastStates[buttonKey] = buttonState;
+				}
+
 				// SEND MESSAGE
-				if(!config.skipevents && currentState.payload.button !== false && (config.initevents || info.suppressMessage == false))
+				if(!config.skipevents && hasEvent && (config.initevents || info.suppressMessage == false) && (!config.onlycommands || scope.lastCommand !== null))
 				{
 					// SET LAST COMMAND
 					if(scope.lastCommand !== null)
@@ -55,8 +139,21 @@ module.exports = function(RED)
 						currentState.command = scope.lastCommand;
 					}
 
+					// COPY THE EVENT TO EVERY ADDITIONAL OUTPUT THAT ASKED FOR IT
+					let outputs = [currentState];
+
+					if(currentState.payload.button !== false)
+					{
+						const rules = Array.isArray(config.rules) ? config.rules : [];
+
+						for (let i = 0; i < rules.length; i++)
+						{
+							outputs[i+1] = matchesRule(buttonState, rules[i]) ? RED.util.cloneMessage(currentState) : null;
+						}
+					}
+
 					// SEND STATE
-					scope.send(currentState);
+					scope.send(outputs);
 
 					// RESET LAST COMMAND
 					scope.lastCommand = null;
@@ -65,35 +162,53 @@ module.exports = function(RED)
 				// NOT IN UNIVERAL MODE? -> CHANGE UI STATES
 				if(config.sensorid)
 				{
-					if(currentState.payload.button === false)
+					if(!hasEvent)
 					{
 						scope.status({fill: "grey", shape: "dot", text: "hue-buttons.node.waiting"});
 					}
 					else
 					{
-						var action = "";
-						switch (currentState.payload.action)
+						var statusText = "";
+
+						if(currentState.payload.button === false)
+						{
+							const rotation = currentState.payload.rotation;
+							statusText = RED._(rotation.clockwise ? "hue-buttons.node.dial-clockwise" : "hue-buttons.node.dial-counterclockwise", { degrees: rotation.degrees });
+						}
+						else
 						{
-						  case "initial_press":
-						    action = "(pressed)";
-						    break;
-						  case "repeat":
-						    action = "(repeated)";
-						    break;
-						  case "short_release":
-						    action = "(short press)";
-						    break;
-						  case "long_release":
-						    action = "(long press)";
-						    break;
-						  case "double_short_release":
-						  	action = "(double pressed)";
-						  	break;
-						  default:
-						    action = "(pressed)";
+							var action = "";
+							switch (currentState.payload.action)
+							{
+							  case "initial_press":
+							    action = "action-started";
+							    break;
+							  case "repeat":
+							    action = "action-repeated";
+							    break;
+							  case "short_release":
+							    action = "action-shortreleased";
+							    break;
+							  case "long_press":
+							    action = "action-holded";
+							    break;
+							  case "long_release":
+							    action = "action-longreleased";
+							    break;
+							  case "double_short_release":
+							  	action = "action-doublepressed";
+							  	break;
+							  default:
+							    action = "action-pressed";
+							}
+
+							// THE DURATION IS ONLY KNOWN WHILE AND AFTER A BUTTON WAS HELD DOWN
+							statusText = (buttonState.actionDuration > 0)
+								? RED._("hue-buttons.node.button-status-duration", { button: currentState.payload.button, action: RED._("hue-buttons.node." + action), duration: (buttonState.actionDuration / 1000).toFixed(1) })
+								: RED._("hue-buttons.node.button-status", { button: currentState.payload.button, action: RED._("hue-buttons.node." + action) });
 						}
 
-						scope.status({fill: "blue", shape: "dot", text: "Button #"+ currentState.payload.button + " " + action });
+						scope.status({fill: "blue", shape: "dot", text: statusText });
 
 						// RESET TO WAITING AFTER 3 SECONDS
 						if(scope.timeout !== null) { clearTimeout(scope.timeout); };
@@ -102,9 +217,12 @@ module.exports = function(RED)
 							scope.status({fill: "grey", shape: "dot", text: "hue-buttons.node.waiting"});
 
 							// REMOVE OLD BUTTON STATES
-							for (const [oneButtonID, oneButton] of Object.entries(bridge.resources[config.sensorid]["services"]["button"]))
+							const buttons = (bridge.resources[config.sensorid] && bridge.resources[config.sensorid]["services"]) ? bridge.resources[config.sensorid]["services"]["button"] : false;
+							if(!buttons) { return false; }
+
+							for (const [oneButtonID, oneButton] of Object.entries(buttons))
 							{
-								delete bridge.resources[config.sensorid]["services"]["button"][oneButtonID]["button"];
+								delete buttons[oneButtonID]["button"];
 							}
 						}, 3000);
 					}
@@ -127,14 +245,14 @@ module.exports = function(RED)
 			const tempSensorID = (!config.sensorid && typeof msg.topic != 'undefined' && bridge.validResourceID.test(msg.topic) === true) ? msg.topic : config.sensorid;
 			if(!tempSensorID)
 			{
-				scope.error("Please submit a valid button ID.");
+				scope.error(RED._("hue-buttons.node.error-no-id"), msg);
 				return false;
 			}
 
 			let currentState = bridge.get("button", tempSensorID);
 			if(!currentState)
 			{
-				scope.error("The button/switch in not yet available. Please wait until HueMagic has established a connection with the bridge or check whether the resource ID in the configuration is valid.");
+				scope.error(RED._("hue-buttons.node.error-not-available"), msg);
 				return false;
 			}
 
@@ -156,6 +274,43 @@ module.exports = function(RED)
 				if(done) { done(); }
 				return true;
 			}
+
+			// SWITCH BETWEEN ROCKER AND PUSHBUTTON MODE (WALL SWITCH MODULE)
+			if(typeof msg.payload != 'undefined' && typeof msg.payload.switchMode != 'undefined')
+			{
+				if(!currentState.info.switchModes)
+                {
+					scope.error(RED._("hue-buttons.node.error-no-switchmode"), msg);
+					return false;
+				}
+
+				if(currentState.info.switchModes.indexOf(msg.payload.switchMode) === -1)
+				{
+					scope.error(RED._("hue-buttons.node.error-invalid-switchmode", { modes: currentState.info.switchModes.join(", ") }), msg);
+					return false;
+				}
+
+				async.retry({
+					times: 5,
+					errorFilter: function(err) {
+						return (err.status == 503 || err.status == 429);
+					},
+					interval: function(retryCount) { return 750*retryCount; }
+				},
+				function(callback, results)
+				{
+					bridge.patch("switch_input_configuration", tempSensorID, { switch_mode: { mode: msg.payload.switchMode } })
+					.then(function() { callback(null, true); })
+					.catch(function(errors) { callback(errors, null); });
+				},
+				function(errors, success)
+				{
+					if(errors) { scope.error(errors, msg); }
+					else if(done) { done(); }
+				});
+
+				return true;
+			}
 		});
 	}
 

package/huemagic/hue-contact.html

@@ -0,0 +1,218 @@
+<script type="text/x-red" data-template-name="hue-contact">
+    <div class="form-row">
+        <label for="node-input-name"><i class="fa fa-tag"></i> <span data-i18n="hue-contact.config.name"></span></label>
+        <input type="text" id="node-input-name" data-i18n="[placeholder]hue-contact.config.input-name" style="width: calc(100% - 105px)">
+    </div>
+    <div class="form-row">
+        <label for="node-input-bridge"><i class="fa fa-server"></i> <span data-i18n="hue-contact.config.bridge"></span></label>
+        <input type="text" id="node-input-bridge" style="width: calc(100% - 105px)">
+    </div>
+    <div class="form-row">
+        <label for="node-input-sensorid"><i class="fa fa-eye"></i> <span data-i18n="hue-contact.config.sensor"></span></label>
+        <div style="display: inline-flex; width: calc(100% - 105px)">
+            <div id="input-select-toggle" style="flex-grow: 1;">
+                <input type="text" id="node-input-sensorid" placeholder="00000000-0000-0000-0000-000000000000" style="width: 100%"/>
+            </div>
+            <button id="node-config-input-scan-sensors" type="button" class="red-ui-button" style="margin-left: 10px;">
+                <i class="fa fa-search"></i>
+            </button>
+        </div>
+    </div>
+    <div class="form-row" style="margin-top: 30px">
+        <div style="display: inline-flex; align-items: center; width: calc(100% - 105px)">
+            <input type="checkbox" id="node-input-skipevents" style="flex: 0 0 auto; width: auto; margin: 0;">
+            <span data-i18n="hue-contact.config.skipevents-node" style="flex: 1; margin-left: 8px;"></span>
+        </div>
+    </div>
+    <div class="form-row">
+        <div style="display: inline-flex; align-items: center; width: calc(100% - 105px)">
+            <input type="checkbox" id="node-input-initevents" style="flex: 0 0 auto; width: auto; margin: 0;">
+            <span data-i18n="hue-contact.config.sendinitevents-node" style="flex: 1; margin-left: 8px;"></span>
+        </div>
+    </div>
+    <div class="form-row">
+        <div style="display: inline-flex; align-items: center; width: calc(100% - 105px)">
+            <input type="checkbox" id="node-input-onlycommands" style="flex: 0 0 auto; width: auto; margin: 0;">
+            <span data-i18n="hue-contact.config.onlycommands-node" style="flex: 1; margin-left: 8px;"></span>
+        </div>
+    </div>
+</script>
+
+<script type="text/javascript">
+    RED.nodes.registerType('hue-contact',{
+        category: 'HueMagic',
+        color: '#ce5cd6',
+        defaults: {
+            name: { value:"" },
+            bridge: { type: "hue-bridge", required: true },
+            sensorid: { value:"", required: false },
+            skipevents: { value: false },
+            initevents: { value: false },
+            onlycommands: { value: false }
+        },
+        align: 'left',
+        icon: "hue-contact.svg",
+        inputs: 1,
+        outputs: 1,
+        label: function() {
+            return this.name || this._("hue-contact.node.title");
+        },
+        paletteLabel: function() {
+            return this._("hue-contact.node.title");
+        },
+        inputLabels: function() {
+            return this._("hue-contact.node.input");
+        },
+        outputLabels: function() {
+            return this._("hue-contact.node.output");
+        },
+        oneditprepare: function()
+        {
+            const scope = this;
+            let options = [];
+
+            function manualInput()
+            {
+                // GET CURRENT SELECTED VALUE
+                var current = $('#node-input-sensorid').val();
+
+                // REMOVE SELECT FIELD
+                $('#input-select-toggle').empty();
+
+                // CREATE NEW INPUT FIELD
+                $('#input-select-toggle').append('<input type="text" id="node-input-sensorid" placeholder="00000000-0000-0000-0000-000000000000" style="width: 100%" value="'+current+'" />');
+
+                // CHANGE BUTTON ICON
+                var button = $("#node-config-input-scan-sensors");
+                var buttonIcon = button.find("i");
+                buttonIcon.removeClass("fa-pencil");
+                buttonIcon.addClass("fa-search");
+            }
+            
+            function sortResourcesBy(prop, resources)
+            {
+                return resources.sort((a, b) => {
+                    if ( a[prop] < b[prop] ){
+                        return -1;
+                    }
+                    if ( a[prop] > b[prop] ){
+                        return 1;
+                    }
+                    return 0;
+                });
+            }
+
+            function searchAndSelect()
+            {
+                // GET CURRENT BRIDGE CONFIGURATION
+                var bridgeConfig = RED.nodes.node($('#node-input-bridge option:selected').val());
+                if(!bridgeConfig) { return false; }
+
+                // GET CURRENT SELECTED VALUE
+                var current = $('#node-input-sensorid').val();
+
+                // TRIGGER SEARCHING NOTIFICATION
+                var notification = RED.notify(scope._("hue-contact.config.searching"), { type: "compact", modal: true, fixed: true });
+
+                // GET THE SENSORS
+                $.get('hue/resources', { bridge: bridgeConfig.bridge, key: bridgeConfig.key, type: "contact" })
+                .done( function(data) {
+                    var allResources = JSON.parse(data);
+                    allResources = sortResourcesBy('name', allResources);
+                    if(allResources.length <= 0)
+                    {
+                        notification.close();
+                        RED.notify(scope._("hue-contact.config.none-found"), { type: "error" });
+                        return false;
+                    }
+
+                    // SET OPTIONS
+                    allResources.forEach(function(resource)
+                    {
+                        if(resource.model)
+                        {
+                            options[resource.id] = { value: resource.id, label: resource.name + " ("+resource.model+")" };
+                        }
+                        else
+                        {
+                            options[resource.id] = { value: resource.id, label: resource.name };
+                        }
+                    });
+
+                    // SELECT CURRENT VALUE
+                    $("#node-input-sensorid").typedInput({
+                        types: [
+                            {
+                                value: current,
+                                options: Object.values(options)
+                            }
+                        ]
+                    });
+
+                    // CHANGE BUTTON ICON
+                    var button = $("#node-config-input-scan-sensors");
+                    var buttonIcon = button.find("i");
+                    buttonIcon.removeClass("fa-search");
+                    buttonIcon.addClass("fa-pencil");
+
+                    // CLOSE SEARCH NOTIFICATION
+                    notification.close();
+                })
+                .fail(function()
+                {
+                    notification.close();
+                    RED.notify(scope._("hue-contact.config.unknown-error"), "error");
+                });
+            }
+
+            // CHANGED SENSOR ID? -> REPLACE NAME (IF POSSIBLE)
+            $(document).on('change', '#node-input-sensorid', function(e)
+            {
+                let currentSelectedOptionID = $(e.currentTarget).val();
+                let currentSelectedOptionValue = (currentSelectedOptionID.length > 0 && options[currentSelectedOptionID]) ? options[currentSelectedOptionID].label : false;
+
+                if(currentSelectedOptionValue !== false)
+                {
+                    $('#node-input-name').val(currentSelectedOptionValue.split(" (")[0]);
+                }
+            });
+
+            // TOGGLE SELECT/INPUT FIELD
+            $('#node-config-input-scan-sensors').click(function()
+            {
+                if($('#input-select-toggle').find(".red-ui-typedInput-container").length > 0)
+                {
+                    manualInput();
+                }
+                else
+                {
+                    searchAndSelect();
+                }
+            });
+        },
+        button: {
+            enabled: function() {
+                return (this.sensorid && this.sensorid.length > 1)
+            },
+            visible: function() {
+                return (this.sensorid && this.sensorid.length > 1)
+            },
+            onclick: function()
+            {
+                const node = this;
+                if(node.bridge)
+                {
+                    $.ajax({
+                        url: "inject/" + node.id,
+                        type: "POST",
+                        data: JSON.stringify({ __user_inject_props__: "status"}),
+                        contentType: "application/json; charset=utf-8",
+                        success: function (resp) {
+                            RED.notify(node.name + ": " + node._("hue-contact.node.statusmsg"), { type: "success", id: "status", timeout: 2000 });
+                        }
+                    });
+                }
+            }
+        }
+    });
+</script>