node-red-contrib-huemagic 4.2.2 → 5.0.0

package/huemagic/utils/sse.js

@@ -0,0 +1,51 @@
+//
+// PARSE A SINGLE SERVER-SENT EVENT FRAME
+function parseFrame(frame)
+{
+	let event = { id: null, event: null, data: null };
+	let data = [];
+
+	for(let line of frame.split(/\r\n|\n|\r/))
+	{
+		// EMPTY LINE OR COMMENT (KEEP-ALIVE)
+		if(line.length === 0 || line.charAt(0) === ":") { continue; }
+
+		const colon = line.indexOf(":");
+		const field = (colon === -1) ? line : line.slice(0, colon);
+		let value = (colon === -1) ? "" : line.slice(colon + 1);
+
+		if(value.charAt(0) === " ") { value = value.slice(1); }
+
+		if(field === "data") { data.push(value); }
+		else if(field === "id") { event.id = value; }
+		else if(field === "event") { event.event = value; }
+	}
+
+	if(data.length > 0) { event.data = data.join("\n"); }
+
+	return (event.id || event.data) ? event : false;
+}
+
+//
+// PARSE AN EVENT STREAM CHUNK / GIVE BACK THE INCOMPLETE REST
+function parseEventStream(text)
+{
+	const separator = /\r\n\r\n|\n\n|\r\r/;
+	let events = [];
+	let rest = text;
+	let match;
+
+	while((match = separator.exec(rest)) !== null)
+	{
+		const frame = rest.slice(0, match.index);
+		rest = rest.slice(match.index + match[0].length);
+
+		const event = parseFrame(frame);
+		if(event) { events.push(event); }
+	}
+
+	return { events: events, rest: rest };
+}
+
+// EXPORT
+module.exports = { parseEventStream };

package/huemagic/utils/syncbox.js

@@ -0,0 +1,84 @@
+const axios = require('axios');
+const https = require('https');
+
+// THE SYNC BOX SERVES A CERTIFICATE THAT NO OS TRUST STORE KNOWS
+const httpsAgent = new https.Agent({ rejectUnauthorized: false, keepAlive: true });
+
+//
+// THE SYNC BOX SPEAKS ITS OWN LOCAL API, IT IS NOT A RESOURCE OF THE BRIDGE
+function SyncBoxAPI()
+{
+	//
+	// MAKE A REQUEST
+	this.request = function({ config = null, method = 'GET', resource = "", data = null, token = null })
+	{
+		return new Promise(function(resolve, reject)
+		{
+			if(!config || !config.syncbox)
+			{
+				reject({ status: "ENOTCONFIGURED", errors: "The sync box is not configured." });
+				return false;
+			}
+
+			const accessToken = (token !== null) ? token : config.token;
+
+			let request = {
+				"method": method,
+				"url": "https://" + config.syncbox.trim() + "/api/v1" + resource,
+				"headers": { "Content-Type": "application/json" },
+				"httpsAgent": httpsAgent,
+				"proxy": false, // THE BOX IS ON THE LOCAL NETWORK, NEVER GO THROUGH A PROXY
+				"timeout": 10000,
+			};
+
+			if(accessToken) { request["headers"]["Authorization"] = "Bearer " + accessToken; }
+			if(data !== null) { request["data"] = data; }
+
+			axios(request)
+			.then(function(response) { resolve(response.data); })
+			.catch(function(error)
+			{
+				if(error.response)
+				{
+					const body = error.response.data;
+					reject({ status: error.response.status, code: body ? body.code : false, errors: (body && body.message) ? body.message : body });
+				}
+				else
+				{
+					reject({ status: error.code, errors: error.message });
+				}
+			});
+		});
+	}
+
+	//
+	// REGISTER WITH THE BOX / THE BUTTON HAS TO BE PRESSED WHILE THIS RUNS
+	this.register = function(config)
+	{
+		const scope = this;
+		return scope.request({
+			config: config,
+			method: "POST",
+			resource: "/registrations",
+			token: false,
+			data: { appName: "huemagic", instanceName: "node-red" }
+		});
+	}
+
+	//
+	// READ THE COMPLETE STATE (device, execution, hdmi, hue, behavior)
+	this.state = function(config)
+	{
+		return this.request({ config: config, resource: "/" });
+	}
+
+	//
+	// CHANGE WHAT THE BOX IS DOING
+	this.execute = function(config, patch)
+	{
+		return this.request({ config: config, method: "PUT", resource: "/execution", data: patch });
+	}
+}
+
+// EXPORT
+module.exports = new SyncBoxAPI;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "node-red-contrib-huemagic",
-  "version": "4.2.2",
-  "description": "Philips Hue node to control bridges, lights, groups, scenes, rules, taps, switches, buttons, motion sensors, temperature sensors and Lux sensors using Node-RED.",
+  "version": "5.0.0",
+  "description": "Philips Hue nodes to control bridges, lights, groups, scenes, rules, automations, buttons, switches, dials, doorbells, speakers, motion sensors, cameras, contact sensors, temperature sensors, light level sensors and the Hue Play HDMI Sync Box using Node-RED.",
   "author": "foddy",
   "homepage": "https://github.com/Foddy/node-red-contrib-huemagic",
   "license": "Apache-2.0",
@@ -27,6 +27,7 @@
     "iot"
   ],
   "node-red": {
+    "version": ">=3.0.0",
     "nodes": {
       "hue-bridge": "huemagic/hue-bridge-config.js",
       "hue-bridge-node": "huemagic/hue-bridge.js",
@@ -36,26 +37,33 @@
       "hue-scene": "huemagic/hue-scene.js",
       "hue-buttons": "huemagic/hue-buttons.js",
       "hue-motion": "huemagic/hue-motion.js",
+      "hue-contact": "huemagic/hue-contact.js",
       "hue-temperature": "huemagic/hue-temperature.js",
       "hue-brightness": "huemagic/hue-brightness.js",
-      "hue-rules": "huemagic/hue-rules.js"
+      "hue-rules": "huemagic/hue-rules.js",
+      "hue-speaker": "huemagic/hue-speaker.js",
+      "hue-automation": "huemagic/hue-automation.js",
+      "hue-syncbox-config": "huemagic/hue-syncbox-config.js",
+      "hue-syncbox": "huemagic/hue-syncbox.js"
     }
   },
   "engines": {
-    "node": ">=12.0.0"
+    "node": ">=18.0.0"
   },
   "publishConfig": {
     "access": "public"
   },
+  "scripts": {
+    "test": "node --test \"test/**/*.test.js\""
+  },
   "dependencies": {
-    "async": "^3.2.2",
-    "axios": "^0.26.1",
+    "async": "^3.2.6",
+    "axios": "^1.19.0",
     "color-namer": "^1.4.0",
     "colornames": "^1.1.1",
-    "dayjs": "^1.10.7",
-    "deep-object-diff": "^1.1.0",
-    "eventsource": "^2.0.0",
-    "fastq": "^1.13.0",
-    "get-image-colors": "^4.0.0"
+    "dayjs": "^1.11.22",
+    "deep-object-diff": "^1.1.9",
+    "fastq": "^1.20.1",
+    "get-image-colors": "^4.0.1"
   }
 }

package/.github/FUNDING.yml

@@ -1,2 +0,0 @@
-github: Foddy
-custom: ['https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=LUQ7CWBWQ3Q4U']

package/.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,30 +0,0 @@
----
-name: Bug report
-about: Create a report to help us improve
-title: ''
-labels: bug
-assignees: ''
-
----
-
-**Describe the bug**
-A clear and concise description of what the bug is.
-
-**Flow to Reproduce**
-```
-[{"id":"8888888.eeeeee","type":"tab","label":"Example Flow"...}]
-```
-
-**Expected behavior**
-A clear and concise description of what you expected to happen.
-
-**Screenshots**
-If applicable, add screenshots to help explain your problem.
-
-**Please complete the following information:**
- - Node-RED version: [...]
- - NodeJS version: [...]
- - Device running Node-RED: [...]
-
-**Additional context**
-Add any other context about the problem here.

package/.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,20 +0,0 @@
----
-name: Feature request
-about: Suggest an idea for this project
-title: ''
-labels: enhancement
-assignees: ''
-
----
-
-**Is your feature request related to a problem? Please describe.**
-A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
-
-**Describe the solution you'd like**
-A clear and concise description of what you want to happen.
-
-**Describe alternatives you've considered**
-A clear and concise description of any alternative solutions or features you've considered.
-
-**Additional context**
-Add any other context or screenshots about the feature request here.

package/.github/workflows/npm.yml

@@ -1,18 +0,0 @@
-name: npm-publish
-on: [push]
-jobs:
-  npm-publish:
-    name: npm-publish
-    runs-on: ubuntu-latest
-    steps:
-    - name: Checkout repository
-      uses: actions/checkout@master
-    - name: Set up Node.js
-      uses: actions/setup-node@master
-      with:
-        node-version: 10.0.0
-    - name: Publish if version has been updated
-      uses: pascalgn/npm-publish-action@master
-      env:
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        NPM_AUTH_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }}

package/huemagic/locales/en-US/hue-bridge-config.json

@@ -1,29 +0,0 @@
-{
-	"hue-bridge-config":
-	{
-		"config":
-		{
-			"name": "Name",
-			"apikey": "API Key",
-			"missing-ip": "Missing Hue Bridge IP…",
-			"disable-events": "Disable events",
-			"disable-events-info": "Disable events on all nodes",
-			"searching": "Searching for Hue Bridges…",
-			"none-found": "No Hue Bridges found!",
-			"unknown-error": "Something went wrong. Please retry.",
-			"invalid": "Sorry. Your selected Hue Bridge is invalid: ",
-			"error-select-first": "Please select your Hue Bridge before trying to create a new user!",
-			"waiting": "waiting 20 seconds…",
-			"new-user-press": "Please press your Hue Bridge button within the next 20 seconds to create a new user!",
-			"retry": "Please retry within 20 seconds…",
-			"success": "User created successfully!",
-			"connecting": "Connecting with the bridge…",
-			"autoupdates": "Activate automatic firmware updates"
-		},
-		"node":
-		{
-			"title": "Hue Bridge",
-			"statusmsg": "Status queried successfully…"
-		}
-	}
-}

package/huemagic/locales/en-US/hue-buttons.json

@@ -1,34 +0,0 @@
-{
-	"hue-buttons":
-	{
-		"config":
-		{
-			"name": "Name",
-			"input-name": "Button name",
-			"skipevents-node": "Skip events from node",
-			"sendinitevents-node": "Do not suppress initialization event",
-			"searching": "Searching Hue Buttons…",
-			"none-found": "No Hue Button found!",
-			"unknown-error": "Something went wrong. Please retry.",
-			"button": "Button",
-			"universalevents": "Universal Events",
-			"universalevents-node": "Receives all messages from other nodes of the same type (only in universal mode)"
-		},
-		"node":
-		{
-			"title": "Hue Buttons",
-			"not-configured": "not configured",
-			"waiting": "waiting…",
-			"button-on": "On",
-			"action-pressed": "pressed",
-			"action-holded": "held",
-			"action-shortreleased": "short released",
-			"action-longreleased": "long released",
-			"input": "status query",
-			"output": "pressed button",
-			"universal": "universal mode",
-			"command": "executing command…",
-			"statusmsg": "Status queried successfully…"
-		}
-	}
-}

package/huemagic/locales/en-US/hue-light.json

@@ -1,38 +0,0 @@
-{
-	"hue-light":
-	{
-		"config":
-		{
-			"name": "Name",
-			"input-name": "Light name",
-			"skipevents-node": "Skip events from node",
-			"sendinitevents-node": "Do not suppress initialization event",
-			"searching": "Searching lights…",
-			"none-found": "No lights found!",
-			"unknown-error": "Something went wrong. Please retry.",
-			"light": "Light",
-			"colornamer": "Colornamer",
-			"colornamer-info": "Activate color naming",
-			"universalevents": "Universal Events",
-			"universalevents-node": "Receives all messages from other nodes of the same type (only in universal mode)"
-		},
-		"node":
-		{
-			"title": "Hue Light",
-			"not-configured": "not configured",
-			"init": "initializing…",
-			"not-reachable": "not reachable",
-			"universal": "universal mode",
-			"turned-on": "turned on",
-			"turned-on-percent": "turned on (__percent__%)",
-			"turned-off": "turned off",
-			"error-no-id": "No light Id defined. Please check the docs.",
-			"error-input": "input error",
-			"error-invalid-temp": "Invalid color temprature. Only 153 - 500 allowed.",
-			"input": "turn on / off",
-			"output": "status",
-			"command": "executing command…",
-			"statusmsg": "Status queried successfully…"
-		}
-	}
-}