node-red-contrib-huemagic 3.0.0 → 4.0.3

package/huemagic/utils/messages.js

@@ -0,0 +1,447 @@
+const dayjs = require('dayjs');
+const colorUtils = require("./color");
+
+//
+// HUE BRIDGE
+class HueBridgeMessage
+{
+	constructor(resource, options = {})
+	{
+		this.message = {};
+		this.message.payload = {};
+		this.message.payload.id = resource.bridgeid;
+		this.message.payload.name = resource.name;
+		this.message.payload.factoryNew = resource.factorynew;
+		this.message.payload.replacesBridgeId = resource.replacesbridgeid ? resource.replacesbridgeid : false;
+		this.message.payload.dataStoreVersion = resource.datastoreversion;
+		this.message.payload.starterKitId = resource.starterkitid.length > 0 ? resource.starterkitid : false;
+		this.message.payload.softwareVersion = resource.swversion;
+		this.message.payload.apiVersion = resource.apiversion;
+		this.message.payload.zigbeeChannel = resource.zigbeechannel;
+		this.message.payload.macAddress = resource.mac;
+		this.message.payload.ipAddress = resource.ipaddress;
+		this.message.payload.dhcpEnabled = resource.dhcp;
+		this.message.payload.netmask = resource.netmask;
+		this.message.payload.gateway = resource.gateway;
+		this.message.payload.proxyAddress = resource.proxyaddress == "none" ? false : resource.proxyaddress;
+		this.message.payload.proxyPort = resource.proxyport;
+		this.message.payload.utcTime = resource.UTC;
+		this.message.payload.timeZone = resource.timezone;
+		this.message.payload.localTime = resource.localtime;
+		this.message.payload.portalServicesEnabled = resource.portalservices;
+		this.message.payload.portalConnected = resource.portalconnection;
+		this.message.payload.linkButtonEnabled = resource.linkbutton;
+		this.message.payload.touchlinkEnabled = (resource["touchlink"] && resource["touchlink"] == true) ? true : false;
+		this.message.payload.autoUpdatesEnabled = options["autoupdate"] ? options["autoupdate"] : false;
+		this.message.payload.users = []; // NEW!
+		this.message.payload.updated = resource.updated; // NEW!
+
+		this.message.payload.model = {};
+		this.message.payload.model.id = resource.modelid;
+		this.message.payload.model.manufacturer = "Philips";
+		this.message.payload.model.name = "Hue v2";
+
+		// GET USERS
+		for (const [userID, user] of Object.entries(resource["whitelist"]))
+		{
+			this.message.payload.users.push({
+				user: userID,
+				name: user["name"],
+				created: user["create date"],
+				lastAccess: user["last use date"]
+			});
+		}
+	}
+
+	get msg()
+	{
+		return this.message;
+	}
+}
+
+
+//
+// HUE BRIGHTNESS
+class HueBrightnessMessage
+{
+	constructor(resource, options = {})
+	{
+		const service = Object.values(resource["services"]["light_level"])[0];
+		const connectivity = resource.services.zigbee_connectivity ? Object.values(resource.services.zigbee_connectivity)[0] : ((resource.services.zgp_connectivity) ? Object.values(resource.services.zgp_connectivity)[0] : false);
+
+		var realLUX = service.light.light_level - 1;
+		realLUX = realLUX / 10000;
+		realLUX = Math.round(Math.pow(10, realLUX));
+
+		this.message = {};
+		this.message.payload = {};
+		this.message.payload.active = service.enabled; // NEW!
+		this.message.payload.reachable = connectivity ? (connectivity.status === "connected") : "unknown"; // NEW!
+		this.message.payload.connectionStatus = connectivity ? connectivity.status : "unknown"; // NEW!
+		this.message.payload.lux = realLUX;
+		this.message.payload.lightLevel = service.light.light_level;
+		this.message.payload.dark = (realLUX < 200);
+		this.message.payload.daylight = (realLUX > 200);
+		this.message.payload.updated = resource.updated;
+
+		this.message.info = {};
+		this.message.info.id = service.id;
+		this.message.info.idV1 = resource.id_v1 ? resource.id_v1 : false; // NEW
+		this.message.info.uniqueId = resource.id + "-" + service.id;
+		this.message.info.deviceId = resource.id; // NEW!
+		this.message.info.name = resource.metadata.name;
+		this.message.info.type = "light_level";
+		this.message.info.softwareVersion = resource.product_data.software_version;
+		this.message.info.battery = Object.values(resource.services.device_power)[0].power_state.battery_level;
+		this.message.info.batteryState = Object.values(resource.services.device_power)[0].power_state.battery_state; // NEW!
+
+		this.message.info.model = {};
+		this.message.info.model.id = resource.product_data.model_id;
+		this.message.info.model.manufacturer = resource.product_data.manufacturer_name;
+		this.message.info.model.name = resource.product_data.product_name;
+		this.message.info.model.type = resource.product_data.product_archetype;
+		this.message.info.model.certified = resource.product_data.certified; // NEW
+	}
+
+	get msg()
+	{
+		return this.message;
+	}
+}
+
+
+//
+// HUE GROUP
+class HueGroupMessage
+{
+	constructor(resource, options = {})
+	{
+		let service = Object.values(resource["services"]["grouped_light"])[0];
+		service = options.resources[service.id];
+
+		this.message = {};
+		this.message.payload = {};
+		this.message.payload.on = service.on.on;
+		this.message.payload.updated = resource.updated;
+
+		this.message.info = {};
+		this.message.info.id = resource.id;
+		this.message.info.idV1 = resource.id_v1 ? resource.id_v1 : false; // NEW
+		this.message.info.name = resource.metadata ? resource.metadata.name : "all";
+		this.message.info.type = "group";
+	}
+
+	get msg()
+	{
+		return this.message;
+	}
+}
+
+
+//
+// HUE LIGHT
+class HueLightMessage
+{
+	constructor(resource, options = {})
+	{
+		const service = Object.values(resource["services"]["light"])[0];
+		const connectivity = resource.services.zigbee_connectivity ? Object.values(resource.services.zigbee_connectivity)[0] : ((resource.services.zgp_connectivity) ? Object.values(resource.services.zgp_connectivity)[0] : false);
+
+		this.message = {};
+		this.message.payload = {};
+		this.message.payload.on = service.on.on;
+		this.message.payload.brightness = service.dimming ? service.dimming.brightness : false;
+		this.message.payload.brightnessLevel = service.dimming ? Math.round((254/100)*this.message.payload.brightness) : false;
+		this.message.payload.reachable = connectivity ? (connectivity.status === "connected") : "unknown";
+		this.message.payload.connectionStatus = connectivity ? connectivity.status : "unknown"; // NEW!
+		this.message.payload.updated = resource.updated;
+
+		this.message.info = {};
+		this.message.info.id = service.id;
+		this.message.info.idV1 = resource.id_v1 ? resource.id_v1 : false; // NEW
+		this.message.info.uniqueId = resource.id + "-" + service.id;
+		this.message.info.deviceId = resource.id; // NEW!
+		this.message.info.name = service.metadata.name;
+		this.message.info.type = "light";
+		this.message.info.softwareVersion = resource.product_data.software_version;
+
+		this.message.info.model = {};
+		this.message.info.model.id = resource.product_data.model_id;
+		this.message.info.model.manufacturer = resource.product_data.manufacturer_name;
+		this.message.info.model.name = resource.product_data.product_name;
+		this.message.info.model.type = resource.product_data.product_archetype;
+		this.message.info.model.certified = resource.product_data.certified; // NEW
+		this.message.info.model.friendsOfHue = true;
+
+		// HAS COLOR CAPABILITIES?
+		if(service["color"])
+		{
+			let RGB = colorUtils.xyBriToRgb(service.color.xy.x, service.color.xy.y, (service.dimming ? service.dimming.brightness : 100));
+			this.message.payload.rgb = [RGB.r, RGB.g, RGB.b];
+			this.message.payload.hex = colorUtils.rgbHex(RGB.r, RGB.g, RGB.b);
+			this.message.payload.xyColor = service.color.xy; // NEW!
+
+			if(options.colornames == true)
+			{
+				var cNamesArray = colorUtils.colornamer(colorUtils.rgbHex(RGB.r, RGB.g, RGB.b));
+				this.message.payload.color = cNamesArray.basic[0]["name"];
+			}
+
+			this.message.info.model.colorGamut = service.color.gamut; // NEW
+			this.message.info.model.colorGamutType = service.color.gamut_type; // NEW
+		}
+
+		// HAS COLOR TEMPERATURE CAPABILITIES?
+		if(service["color_temperature"])
+		{
+			this.message.payload.colorTemp = service.color_temperature.mirek ? service.color_temperature.mirek : false;
+
+			if(!this.message.payload.colorTemp) { this.message.payload.colorTempName = "unknown"; }
+			else if(this.message.payload.colorTemp < 200) { this.message.payload.colorTempName = "cold"; } // NEW!
+			else if(this.message.payload.colorTemp < 350) { this.message.payload.colorTempName = "normal"; }
+			else if(this.message.payload.colorTemp < 410) { this.message.payload.colorTempName = "warm"; }
+			else { this.message.payload.colorTempName = "hot"; }
+		}
+
+		// HAS GRADIENT COLOR CAPABILITIES?
+		if(service["gradient"]) // NEW!
+		{
+			this.message.payload.gradient = {};
+			this.message.payload.gradient.colors = [];
+
+			for(let gradientColor in service["gradient"]["points"])
+			{
+				let gradientColorRGB = colorUtils.xyBriToRgb(gradientColor.color.xy.x, gradientColor.color.xy.y, (gradientColor.dimming ? service.dimming.brightness : 100));
+
+				let oneColorPack = {};
+				oneColorPack.rgb = [gradientColorRGB.r, gradientColorRGB.g, gradientColorRGB.b];
+				oneColorPack.hex = colorUtils.rgbHex(gradientColorRGB.r, gradientColorRGB.g, gradientColorRGB.b);
+				oneColorPack.xyColor = gradientColor.color.xy.x;
+
+				this.message.payload.gradient.colors.push(oneColorPack);
+			}
+
+			this.message.payload.gradient.numColors = service["gradient"]["points"] ? service["gradient"]["points"].length : 0;
+			this.message.payload.gradient.totalColors = service["gradient"]["points_capable"];
+		}
+	}
+
+	get msg()
+	{
+		return this.message;
+	}
+}
+
+
+//
+// HUE MOTION
+class HueMotionMessage
+{
+	constructor(resource, options = {})
+	{
+		const service = Object.values(resource["services"]["motion"])[0];
+		const connectivity = resource.services.zigbee_connectivity ? Object.values(resource.services.zigbee_connectivity)[0] : ((resource.services.zgp_connectivity) ? Object.values(resource.services.zgp_connectivity)[0] : false);
+
+		this.message = {};
+		this.message.payload = {
+			active: service.enabled,
+			reachable: connectivity ? (connectivity.status === "connected") : "unknown",
+			connectionStatus: connectivity ? connectivity.status : "unknown", // NEW!
+			motion: (service.motion.motion && service.motion.motion_valid),
+			updated: resource.updated
+		};
+
+		this.message.info = {};
+		this.message.info.id = service.id;
+		this.message.info.idV1 = resource.id_v1 ? resource.id_v1 : false; // NEW
+		this.message.info.uniqueId = resource.id + "-" + service.id;
+		this.message.info.deviceId = resource.id; // NEW!
+		this.message.info.name = resource.metadata.name;
+		this.message.info.type = "motion";
+		this.message.info.softwareVersion = resource.product_data.software_version;
+		this.message.info.battery = Object.values(resource.services.device_power)[0].power_state.battery_level;
+		this.message.info.batteryState = Object.values(resource.services.device_power)[0].power_state.battery_state; // NEW!
+
+		this.message.info.model = {};
+		this.message.info.model.id = resource.product_data.model_id;
+		this.message.info.model.manufacturer = resource.product_data.manufacturer_name;
+		this.message.info.model.name = resource.product_data.product_name;
+		this.message.info.model.type = resource.product_data.product_archetype;
+		this.message.info.model.certified = resource.product_data.certified; // NEW
+	}
+
+	get msg()
+	{
+		return this.message;
+	}
+}
+
+
+//
+// HUE RULES
+class HueRulesMessage
+{
+	constructor(resource, options = {})
+	{
+		this.message = {};
+		this.message.payload = {};
+		this.message.payload.enabled = (resource["status"] == "enabled"); // NEW!
+		this.message.payload.triggered = (resource["lasttriggered"] != null) ? dayjs(resource["lasttriggered"]).format() : false;
+
+		this.message.info = {};
+		this.message.info.id = resource["id"];
+		this.message.info.created = dayjs(resource["created"]).format();
+		this.message.info.name = resource["name"];
+		this.message.info.timesTriggered = resource["timestriggered"];
+		this.message.info.owner = resource["_owner"];
+		this.message.info.status = resource["status"];
+
+		this.message.conditions = resource["conditions"];
+		this.message.actions = resource["actions"];
+	}
+
+	get msg()
+	{
+		return this.message;
+	}
+}
+
+
+//
+// HUE BUTTONS
+class HueButtonsMessage
+{
+	constructor(resource, options = {})
+	{
+		const connectivity = resource.services.zigbee_connectivity ? Object.values(resource.services.zigbee_connectivity)[0] : ((resource.services.zgp_connectivity) ? Object.values(resource.services.zgp_connectivity)[0] : false);
+
+		// FIND PRESSED BUTTON
+		var pressedButton = false;
+		const allButtons = Object.values(resource.services.button);
+
+		for (var i = allButtons.length - 1; i >= 0; i--)
+		{
+			if(allButtons[i]["button"])
+			{
+				pressedButton = allButtons[i];
+				break;
+			}
+		}
+
+		this.message = {};
+		this.message.payload = {
+			reachable: connectivity ? (connectivity.status === "connected") : "unknown", // NEW!
+			connectionStatus: connectivity ? connectivity.status : "unknown", // NEW!
+			button: pressedButton ? pressedButton.metadata.control_id : false, // NEW
+			action: pressedButton ? pressedButton.button.last_event : false, // NEW
+			updated: resource.updated
+		};
+
+		this.message.info = {};
+		this.message.info.id = pressedButton ? pressedButton.id : resource.id;
+		this.message.info.idV1 = resource.id_v1 ? resource.id_v1 : false; // NEW
+		this.message.info.uniqueId = resource.id + "-" + (pressedButton ? pressedButton.id : "");
+		this.message.info.deviceId = resource.id; // NEW!
+		this.message.info.name = resource.metadata.name;
+		this.message.info.type = "button";
+		this.message.info.softwareVersion = resource.product_data.software_version;
+		this.message.info.battery = resource.services.device_power ? Object.values(resource.services.device_power)[0].power_state.battery_level : false;
+		this.message.info.batteryState = resource.services.device_power ? Object.values(resource.services.device_power)[0].power_state.battery_state : false; // NEW!
+
+		this.message.info.model = {};
+		this.message.info.model.id = resource.product_data.model_id;
+		this.message.info.model.manufacturer = resource.product_data.manufacturer_name;
+		this.message.info.model.name = resource.product_data.product_name;
+		this.message.info.model.type = resource.product_data.product_archetype;
+		this.message.info.model.certified = resource.product_data.certified; // NEW
+	}
+
+	get msg()
+	{
+		return this.message;
+	}
+}
+
+
+//
+// HUE TEMPERATURE
+class HueTemperatureMessage
+{
+	constructor(resource, options = {})
+	{
+		const service = Object.values(resource["services"]["temperature"])[0];
+		const connectivity = resource.services.zigbee_connectivity ? Object.values(resource.services.zigbee_connectivity)[0] : ((resource.services.zgp_connectivity) ? Object.values(resource.services.zgp_connectivity)[0] : false);
+
+		var deviceValue = service.temperature.temperature;
+		var celsius = Math.round(deviceValue * 100) / 100;
+		var fahrenheit = Math.round(((celsius * 1.8)+32) * 100) / 100;
+
+		// TEMPERATURE MESSAGE
+		let temperatureMessage = "comfortable";
+
+		if(celsius < 0) {
+			temperatureMessage = "very cold";
+		}
+		else if(celsius < 11) {
+			temperatureMessage = "cold";
+		}
+		else if(celsius < 16) {
+			temperatureMessage = "slightly cold";
+		}
+		else if(celsius < 22) {
+			temperatureMessage = "comfortable";
+		}
+		else if(celsius < 27) {
+			temperatureMessage = "slightly warm";
+		}
+		else if(celsius < 33) {
+			temperatureMessage = "warm";
+		}
+		else if(celsius < 39) {
+			temperatureMessage = "hot";
+		}
+		else {
+			temperatureMessage = "very hot";
+		}
+
+		this.message = {};
+		this.message.payload = {
+			active: service.enabled, // NEW!
+			reachable: connectivity ? (connectivity.status === "connected") : "unknown", // NEW!
+			connectionStatus: connectivity ? connectivity.status : "unknown", // NEW!
+			celsius: celsius,
+			fahrenheit: fahrenheit,
+			temperatureIs: temperatureMessage,
+			deviceValue: deviceValue,
+			updated: resource.updated
+		};
+
+		this.message.info = {};
+		this.message.info.id = service.id;
+		this.message.info.idV1 = resource.id_v1 ? resource.id_v1 : false; // NEW
+		this.message.info.uniqueId = resource.id + "-" + service.id;
+		this.message.info.deviceId = resource.id; // NEW!
+		this.message.info.name = resource.metadata.name;
+		this.message.info.type = "temperature";
+		this.message.info.softwareVersion = resource.product_data.software_version;
+		this.message.info.battery = Object.values(resource.services.device_power)[0].power_state.battery_level;
+		this.message.info.batteryState = Object.values(resource.services.device_power)[0].power_state.battery_state; // NEW!
+
+		this.message.info.model = {};
+		this.message.info.model.id = resource.product_data.model_id;
+		this.message.info.model.manufacturer = resource.product_data.manufacturer_name;
+		this.message.info.model.name = resource.product_data.product_name;
+		this.message.info.model.type = resource.product_data.product_archetype;
+		this.message.info.model.certified = resource.product_data.certified; // NEW
+	}
+
+	get msg()
+	{
+		return this.message;
+	}
+}
+
+//
+// EXPORT
+module.exports = { HueBridgeMessage, HueBrightnessMessage, HueGroupMessage, HueLightMessage, HueMotionMessage, HueRulesMessage, HueButtonsMessage, HueTemperatureMessage }
+

package/package.json

@@ -1,13 +1,10 @@
 {
   "name": "node-red-contrib-huemagic",
-  "version": "3.0.0",
+  "version": "4.0.3",
   "description": "Philips Hue node to control bridges, lights, groups, scenes, rules, taps, switches, buttons, motion sensors, temperature sensors and Lux sensors using Node-RED.",
   "author": "foddy",
   "homepage": "https://github.com/Foddy/node-red-contrib-huemagic",
   "license": "Apache-2.0",
-  "scripts": {
-    "generate:previews": "node ./helper/huemagic-gifmaker/index.js && node ./helper/huemagic-gifmaker/optimize.js"
-  },
   "maintainers": [
     "Foddy Botosakis <github@foddys.com>"
   ],
@@ -37,9 +34,7 @@
       "hue-light": "huemagic/hue-light.js",
       "hue-group": "huemagic/hue-group.js",
       "hue-scene": "huemagic/hue-scene.js",
-      "hue-tap": "huemagic/hue-tap.js",
-      "hue-switch": "huemagic/hue-switch.js",
-      "hue-button": "huemagic/hue-button.js",
+      "hue-buttons": "huemagic/hue-buttons.js",
       "hue-motion": "huemagic/hue-motion.js",
       "hue-temperature": "huemagic/hue-temperature.js",
       "hue-brightness": "huemagic/hue-brightness.js",
@@ -50,14 +45,13 @@
     "access": "public"
   },
   "dependencies": {
-    "async": "^3.2.0",
-    "hex-rgb": "^4.2.0",
-    "huejay": "^1.9.0",
-    "moment": "^2.29.1",
-    "rgb-hex": "^3.0.0",
-    "request": "^2.88.2",
-    "colornames": "^1.1.1",
+    "async": "^3.2.2",
+    "axios": "^0.24.0",
     "color-namer": "^1.4.0",
+    "colornames": "^1.1.1",
+    "dayjs": "^1.10.7",
+    "deep-object-diff": "^1.1.0",
+    "eventsource": "^1.1.0",
     "get-image-colors": "^4.0.0"
   }
-}
+}

package/examples/Hue Button.json

@@ -1,40 +0,0 @@
-[
-    {
-        "id": "d5d4a606.0f05",
-        "type": "tab",
-        "label": "Hue Button (example)",
-        "disabled": false,
-        "info": "Example use of the Hue Button node"
-    },
-    {
-        "id": "897758f5.e19ee8",
-        "type": "debug",
-        "z": "d5d4a606.0f05",
-        "name": "Information",
-        "active": true,
-        "tosidebar": true,
-        "console": false,
-        "tostatus": false,
-        "complete": "payload",
-        "targetType": "msg",
-        "x": 330,
-        "y": 60,
-        "wires": [],
-        "icon": "font-awesome/fa-info-circle"
-    },
-    {
-        "id": "b190f9f5.2d8f",
-        "type": "hue-button",
-        "z": "d5d4a606.0f05",
-        "name": "",
-        "sensorid": "",
-        "skipevents": false,
-        "x": 130,
-        "y": 60,
-        "wires": [
-            [
-                "897758f5.e19ee8"
-            ]
-        ]
-    }
-]

package/examples/Hue Switch.json

@@ -1,40 +0,0 @@
-[
-    {
-        "id": "e3a959fd.39da6",
-        "type": "tab",
-        "label": "Hue Switch (example)",
-        "disabled": false,
-        "info": "Example use of the Hue Switch node"
-    },
-    {
-        "id": "d481c97b.56f63",
-        "type": "debug",
-        "z": "e3a959fd.39da6",
-        "name": "Information",
-        "active": true,
-        "tosidebar": true,
-        "console": false,
-        "tostatus": false,
-        "complete": "payload",
-        "targetType": "msg",
-        "x": 330,
-        "y": 60,
-        "wires": [],
-        "icon": "font-awesome/fa-info-circle"
-    },
-    {
-        "id": "de4dca53.31075",
-        "type": "hue-switch",
-        "z": "e3a959fd.39da6",
-        "name": "",
-        "sensorid": "",
-        "skipevents": false,
-        "x": 130,
-        "y": 60,
-        "wires": [
-            [
-                "d481c97b.56f63"
-            ]
-        ]
-    }
-]

package/examples/Hue Tap.json

@@ -1,40 +0,0 @@
-[
-    {
-        "id": "e3a959fd.39da6",
-        "type": "tab",
-        "label": "Hue Tap (example)",
-        "disabled": false,
-        "info": "Example use of the Hue Tap node"
-    },
-    {
-        "id": "d481c97b.56f63",
-        "type": "debug",
-        "z": "e3a959fd.39da6",
-        "name": "Information",
-        "active": true,
-        "tosidebar": true,
-        "console": false,
-        "tostatus": false,
-        "complete": "payload",
-        "targetType": "msg",
-        "x": 310,
-        "y": 60,
-        "wires": [],
-        "icon": "font-awesome/fa-info-circle"
-    },
-    {
-        "id": "7553e1a.fc48c2",
-        "type": "hue-tap",
-        "z": "e3a959fd.39da6",
-        "name": "",
-        "sensorid": "",
-        "skipevents": false,
-        "x": 120,
-        "y": 60,
-        "wires": [
-            [
-                "d481c97b.56f63"
-            ]
-        ]
-    }
-]