node-red-contrib-huemagic 4.2.2 → 5.0.1

package/huemagic/locales/tr/hue-temperature.html

@@ -0,0 +1,69 @@
+<script type="text/markdown" data-help-name="hue-temperature">
+«Hue Sıcaklık» düğümü, bridge'e bağlı uygun bir sensörden güncel ortam sıcaklığını sorgulayabilir ve bildirebilir.
+
+### Kurulum
+
+Önceden yapılandırılmış Hue Bridge'i seçin ve mevcut tüm sensörleri bulmak için arama düğmesine tıklayın. Sensörün kimliğini zaten biliyorsanız, buraya elle de girebilirsiniz. Sensöre dahili olarak yeni bir ad verebilir veya önceden tanımlı adı kullanabilirsiniz. İsteğe bağlı olarak «Düğümün mesajlarını yoksay» ayarıyla bu düğümün tüm otomatik durum mesajlarını devre dışı bırakabilirsiniz. Düğüm bundan sonra cihaz güncellemesi yayınlamaz. Alternatif olarak, Node-RED başlatılırken düğümün başlatma mesajının bastırılmamasını seçebilirsiniz. Bu ayarı etkinleştirirseniz her dağıtımdan sonra seçili sensörün durum mesajını alırsınız. Düğümün siz bir şey gönderene kadar sessiz kalmasını tercih ediyorsanız «Yalnızca bir komuttan sonra bildir» seçeneğini etkinleştirin. Bu durumda uygulamadan veya bir anahtardan gelen değişiklikleri yok sayar ve yalnızca sizin komutlarınıza yanıt verir.
+
+Hareket sensörleri genellikle odanın bir köşesine monte edilir ve kendi elektroniği yüzünden çoğu zaman biraz fazla sıcak ölçer. «Düzeltme» ayarıyla sensörü dolambaçsız biçimde kalibre edebilirsiniz: buraya girdiğiniz değer (ör. `-1.5`), düğüm değeri vermeden önce her ölçüme eklenir. Düzeltme tüm sıcaklık birimleri için aynı anda geçerlidir.
+
+Bir sensör seçmez ve düğüm yapılandırmasını bu şekilde kullanırsanız, düğüm «evrensel mod» adı verilen modda çalışır. Bu modda düğüm aynı türdeki tüm durum mesajlarını alır ve yayınlar. Evrensel modda ayarları belirli bir sensöre uygulamak için ilgili sensör kimliğini `msg.topic` içinde dize olarak ayarlarınızla birlikte gönderebilirsiniz.
+
+### Durumu sorgulama
+
+Düğüme aşağıdaki içeriğe sahip bir `msg.payload` nesnesi iletildiğinde sensörün güncel durumunu verir. Alternatif olarak, önce düğüme bir mesaj göndermeden Node-RED arayüzündeki düğmeye de basabilirsiniz.
+
+: status (boolean): Sensörün güncel durumunu döndürür
+
+### Sensörü açma / kapatma
+
+Gerekirse sensör uzaktan açılıp kapatılabilir. Sensör kapatıldığında artık sıcaklık değişikliği kaydetmez ve dolayısıyla bildirmez. Bunun için aşağıdaki içeriğe sahip bir nesne gönderin:
+
+: payload (boolean): `true` sensörü açar, `false` kapatır
+
+### Düğümün durum mesajları
+
+Sensör bir sıcaklık değişikliği kaydettiği anda düğüm aşağıdaki durum mesajını döndürür:
+
+#### `msg.payload` altındaki durum nesnesi
+
+: active (boolean): Sensörün açık mı kapalı mı olduğunu belirtir
+: reachable (boolean | string): Sensör bridge'e bağlıysa `true`, bağlantı durumu farklıysa `unknown`
+: connectionStatus (string): Bridge ile olan güncel bağlantı durumu (dize olarak). Değer olarak `connected`, `disconnected`, `connectivity_issue` veya `unidirectional_incoming` içerebilir
+: celsius (float): Güncel ortam sıcaklığını °C (santigrat derece) olarak belirtir
+: fahrenheit (float): Güncel ortam sıcaklığını °F (fahrenhayt derece) olarak belirtir
+: temperatureIs (string): Güncel sıcaklığı `very cold`, `cold`, `slightly cold`, `comfortable`, `slightly warm`, `warm`, `hot` veya `very hot` değerleriyle tanımlar
+: deviceValue (float): Sensörden gelen özgün sıcaklık değeri
+: updated (string): Kaynağın HueMagic tarafından son güncellenme zamanı (ISO 8601)
+
+#### `msg.info` altındaki sensör bilgileri
+
+: id (string): Sensörün yeni kimliğini belirtir
+: idV1 (string | boolean): Sensörün eski kimliğini belirtir
+: uniqueId (string): Sensörün benzersiz kimliği
+: deviceId (string): Cihazın benzersiz kimliği
+: name (string): Sensörün geçerli adı
+: type (string): Sensörün türü (her zaman `temperature`)
+: softwareVersion (string): Sensörün geçerli ürün yazılımı
+: battery (float): Sensörün geçerli pil düzeyi
+: batteryState (string): Pil düzeyinin geçerli durumu. Değer olarak `normal`, `low` veya `critical` içerebilir
+: model (object): Sensörün model bilgilerini `id`, `manufacturer`, `name`, `type` ve `certified` altında içerir
+
+#### `msg.updated` altındaki durum değişiklikleri
+
+Sensörün önceki durumuna kıyasla değişen parametreleri bir nesne olarak listeler. Herhangi bir değişiklik kaydedilmediyse bu nesne boştur.
+
+#### `msg.lastState` altındaki son sensör durumu
+
+Son kaydedilen değişiklikten önceki durumun eksiksiz durum nesnesini içerir (yukarıdaki çıktı değerlerine bakın). HueMagic önceki durumu henüz kaydetmediyse `false` verilir.
+
+#### `msg.command` altındaki son komut (isteğe bağlı)
+
+Düğümün durumu belirli bir komutla değiştiyse, yürütülen komutun tamamı da çıktı olarak verilir. Aksi hâlde düğüm bu nesneyi çıktı olarak vermez.
+
+### HueMagic örnekleri
+
+HueMagic bu düğüm için bazı örnek yapılandırmalar sunar. Node-RED arayüzünüze eksiksiz bir örnek aktarmak için Node-RED menü simgesine tıklayın, «Import» seçeneğini seçin ve açılan pencerenin kenar çubuğunda «Examples» bölümüne gidin. Ardından HueMagic klasörünü ve istediğiniz düğümü seçerek örnek bir akış aktarın.
+
+![examples](hue/assets/huemagic-examples.gif)
+</script>

package/huemagic/locales/tr/hue-temperature.json

@@ -0,0 +1,33 @@
+{
+	"hue-temperature": {
+		"config": {
+			"name": "Ad",
+			"skipevents-node": "Düğümün mesajlarını yoksay",
+			"sendinitevents-node": "Başlatma olayını bastırma",
+			"onlycommands-node": "Yalnızca bir komuttan sonra bildir",
+			"unknown-error": "Bir şeyler ters gitti. Lütfen tekrar deneyin.",
+			"bridge": "Bridge",
+			"universalevents": "Evrensel olaylar",
+			"universalevents-node": "Aynı türdeki diğer düğümlerin tüm mesajlarını alır (yalnızca evrensel modda)",
+			"input-name": "Sensör adı",
+			"searching": "sıcaklık sensörleri aranıyor…",
+			"none-found": "Hiç sıcaklık sensörü bulunamadı.",
+			"sensor": "Sensör",
+			"offset": "Düzeltme"
+		},
+		"node": {
+			"not-configured": "yapılandırılmadı",
+			"init": "başlatılıyor…",
+			"not-reachable": "erişilemiyor",
+			"universal": "evrensel mod",
+			"command": "komut yürütülüyor…",
+			"deactivated": "devre dışı",
+			"statusmsg": "Durum başarıyla sorgulandı…",
+			"title": "Hue Sıcaklık",
+			"input": "durum sorgusu",
+			"output": "sıcaklık (değişti)",
+			"error-no-id": "Lütfen geçerli bir sensör kimliği girin.",
+			"error-not-available": "Sensör henüz kullanılabilir değil. HueMagic bridge ile bağlantı kurana kadar bekleyin veya yapılandırmadaki kaynak kimliğinin geçerli olup olmadığını kontrol edin."
+		}
+	}
+}

package/huemagic/utils/api.js

@@ -1,7 +1,10 @@
 const axios = require('axios');
 const dayjs = require('dayjs');
 const https = require('https');
-const EventSource = require('eventsource');
+const { parseEventStream } = require('./sse');
+
+// Node is somehow not able to parse the official Philips Hue PEM
+const httpsAgent = new https.Agent({ rejectUnauthorized: false, keepAlive: true });
 
 function API()
 {
@@ -28,7 +31,9 @@ function API()
 				"method": "GET",
 				"url": "https://" + config.bridge + "/api/config",
 				"headers": { "Content-Type": "application/json; charset=utf-8" },
-				"httpsAgent": new https.Agent({ rejectUnauthorized: false }),
+				"httpsAgent": httpsAgent,
+				"proxy": false, // THE BRIDGE IS ON THE LOCAL NETWORK, NEVER GO THROUGH A PROXY
+				"timeout": 10000,
 			})
 			.then(function(response)
 			{
@@ -62,7 +67,9 @@ function API()
 					"Content-Type": "application/json; charset=utf-8",
 					"hue-application-key": config.key
 				},
-				"httpsAgent": new https.Agent({ rejectUnauthorized: false }), // Node is somehow not able to parse the official Philips Hue PEM
+				"httpsAgent": httpsAgent,
+				"proxy": false, // THE BRIDGE IS ON THE LOCAL NETWORK, NEVER GO THROUGH A PROXY
+				"timeout": 15000,
 			};
 
 			// HAS RESOURCE? -> APPEND
@@ -90,6 +97,7 @@ function API()
 			{
 				if(version === 2)
 				{
+					// THE BRIDGE ALSO PUTS NON-FATAL HINTS INTO "errors", SO ONLY THE STATUS COUNTS
 					resolve(response.data.data);
 				}
 				else if(version === 1)
@@ -99,64 +107,143 @@ function API()
 			})
 			.catch(function(error)
 			{
-				reject({ status: error.response.status, errors: error.response.data.errors ? error.response.data.errors : error.response.data});
+				if (error.response)
+				{
+					let errors = error.response.data;
+
+					// AN OVERLOADED BRIDGE ANSWERS WITH A HTML ERROR PAGE
+					if(typeof errors === 'string') { errors = "The bridge is currently not able to answer (HTTP " + error.response.status + ")."; }
+					else if(errors && errors.errors) { errors = errors.errors; }
+
+					reject({ status: error.response.status, errors: errors });
+				}
+				else
+				{
+					reject({ status: error.code, errors: error.message});
+				}
 			});
 		});
 	}
 
 	//
 	// SUBSCRIBE TO BRIDGE EVENTS
-	this.subscribe = function(config, callback)
+	this.subscribe = function(config, callback, log = null)
 	{
 		const scope = this;
 		return new Promise(function(resolve, reject)
 		{
-			if(!scope.events[config.id])
+			// ONLY ONE STREAM PER BRIDGE
+			scope.unsubscribe(config);
+
+			const stream = { active: true, request: null, retry: null, attempt: 0, lastEventId: null, connected: false };
+			scope.events[config.id] = stream;
+
+			// (RE)CONNECT TO THE EVENT STREAM
+			const connect = function()
 			{
-				var sseURL = "https://" + config.bridge + "/eventstream/clip/v2";
+				if(stream.active === false) { return false; }
+
+				const [host, port] = config.bridge.trim().split(":");
+				const headers = {
+					"Accept": "text/event-stream",
+					"Cache-Control": "no-cache",
+					"hue-application-key": config.key
+				};
 
-				// INITIALIZE EVENT SOURCE
-				scope.events[config.id] = new EventSource(sseURL, {
-					headers: { 'hue-application-key': config.key },
-					https: { rejectUnauthorized: false },
+				// CONTINUE WHERE WE LEFT OFF
+				if(stream.lastEventId) { headers["Last-Event-ID"] = stream.lastEventId; }
+
+				stream.request = https.request({
+					host: host,
+					port: port ? parseInt(port) : 443,
+					path: "/eventstream/clip/v2",
+					method: "GET",
+					headers: headers,
+					agent: false,
+					rejectUnauthorized: false
 				});
 
-				// PIPE MESSAGE TO TARGET FUNCTION
-				scope.events[config.id].onmessage = function(event)
+				// ONLY GUARD THE HANDSHAKE, AN IDLE EVENT STREAM IS PERFECTLY NORMAL
+				stream.request.setTimeout(15000, function() { stream.request.destroy(new Error("the bridge did not answer")); });
+
+				stream.request.on('response', function(response)
 				{
-					if(event && event.type === 'message' && event.data)
+					if(response.statusCode !== 200)
 					{
-						const messages = JSON.parse(event.data);
-						for (var i = messages.length - 1; i >= 0; i--)
+						response.resume();
+						reconnect("The bridge rejected the event stream (HTTP " + response.statusCode + ")");
+						return false;
+					}
+
+					// CONNECTED -> LET THE OS DETECT DEAD PEERS
+					const isReconnect = (stream.attempt > 0);
+
+					stream.request.setTimeout(0);
+					stream.attempt = 0;
+					stream.connected = true;
+					response.setEncoding('utf8');
+					if(response.socket) { response.socket.setKeepAlive(true, 30000); }
+
+					// EVENTS MAY HAVE BEEN MISSED WHILE WE WERE AWAY
+					if(isReconnect) { callback([], "reconnect"); }
+
+					let buffer = "";
+
+					response.on('data', function(chunk)
+					{
+						const parsed = parseEventStream(buffer + chunk);
+						buffer = (parsed.rest.length > 1048576) ? "" : parsed.rest;
+
+						for(let event of parsed.events)
 						{
-							const message = messages[i];
-							if(message.type === "update")
+							if(event.id) { stream.lastEventId = event.id; }
+							if(!event.data) { continue; }
+
+							let messages = [];
+							try { messages = JSON.parse(event.data); }
+							catch(error) { continue; }
+
+							for(let message of messages)
 							{
-								callback(message.data);
+								if(message.data) { callback(message.data, message.type); }
 							}
 						}
-					}
-				};
+					});
 
-				// CONNECTED?
-				scope.events[config.id].onopen = function()
-				{
-					resolve(true);
-				}
+					response.on('end', function() { reconnect("The bridge closed the event stream"); });
+					response.on('error', function(error) { reconnect(error.message); });
 
-				// ERROR? -> RETRY?
-				scope.events[config.id].onerror = function(error)
-				{
-					console.log("HueMagic:", "Connection to bridge lost. Trying to reconnect again in 30 seconds…", error);
-					setTimeout(function(){ scope.subscribe(config, callback); }, 30000);
 					resolve(true);
-				}
+				});
+
+				stream.request.on('error', function(error) { reconnect(error.message); });
+				stream.request.end();
 			}
-			else
+
+			// RECONNECT WITH A BACKOFF, BUT NEVER MORE THAN ONCE AT A TIME
+			const reconnect = function(reason)
 			{
-				scope.unsubscribe(config);
-				scope.subscribe(config, callback);
+				if(stream.active === false || stream.retry !== null) { return false; }
+
+				stream.connected = false;
+				if(stream.request) { stream.request.destroy(); stream.request = null; }
+
+				const delay = Math.min(30000, 1000 * Math.pow(2, stream.attempt));
+				const seconds = Math.round(delay/1000);
+				stream.attempt += 1;
+
+				if(log) { log(reason, seconds); }
+				else { console.log("HueMagic:", "Connection to bridge lost (" + reason + "). Trying to reconnect in " + seconds + " seconds…"); }
+				stream.retry = setTimeout(function()
+				{
+					stream.retry = null;
+					connect();
+				}, delay);
+
+				resolve(true);
 			}
+
+			connect();
 		});
 	}
 
@@ -164,22 +251,40 @@ function API()
 	// UNSUBSCRIBE
 	this.unsubscribe = function(config)
 	{
-		if(this.events[config.id] !== null) { this.events[config.id].close(); }
-		this.events[config.id] = null;
+		const stream = this.events[config.id];
+		if(!stream) { return false; }
+
+		stream.active = false;
+		if(stream.retry !== null) { clearTimeout(stream.retry); }
+		if(stream.request) { stream.request.destroy(); }
+
+		delete this.events[config.id];
+	}
+
+	//
+	// IS THE EVENT STREAM ALIVE?
+	this.connected = function(config)
+	{
+		const stream = this.events[config.id];
+		return !!stream && stream.connected === true;
 	}
 
 	//
 	// GET FULL/ROOT RESOURCE
-	this.fullResource = function(resource, allResources = {})
+	this.fullResource = function(resource, allResources = {}, seen = {})
 	{
 		const scope = this;
 		var fullResource = Object.assign({}, resource);
 
-		if(resource["owner"])
+		// PROTECT AGAINST BROKEN OWNER CHAINS
+		if(seen[resource["id"]]) { return fullResource; }
+		seen[resource["id"]] = true;
+
+		if(resource["owner"] && typeof allResources[fullResource["owner"]["rid"]] !== 'undefined')
 		{
-			fullResource = scope.fullResource(allResources[fullResource["owner"]["rid"]], allResources);
+			fullResource = scope.fullResource(allResources[fullResource["owner"]["rid"]], allResources, seen);
 		}
-		else if(resource["type"] === "device" || resource["type"] === "room" || resource["type"] === "zone" || resource["type"] === "bridge_home")
+		else if(Array.isArray(resource["services"]))
 		{
 			// RESOLVE SERVICES
 			var allServices = {};
@@ -190,6 +295,7 @@ function API()
 				const targetType = targetService["rtype"];
 				const targetID = targetService["rid"];
 
+				if(!allResources[targetID]) { continue; }
 				if(!allServices[targetType]) { allServices[targetType] = {}; }
 				allServices[targetType][targetID] = Object.assign({}, allResources[targetID]);
 			}
@@ -221,11 +327,9 @@ function API()
 			// CREATE ID BASED OBJECT OF ALL RESOURCES
 			resources.forEach(function(resource, index)
 			{
-				// IS BUTTON? -> REMOVE PREVIOUS STATE
-				if(resource.type === "button")
-				{
-					delete resource["button"];
-				}
+				// IS BUTTON OR DIAL? -> REMOVE PREVIOUS STATE
+				if(resource.type === "button") { delete resource["button"]; }
+				else if(resource.type === "relative_rotary") { delete resource["relative_rotary"]; }
 
 				resourceList[resource.id] = resource;
 			});
@@ -236,6 +340,9 @@ function API()
 				// GET FULL RESOURCE
 				let fullResource = scope.fullResource(resource, resourceList);
 
+				// A RESOURCE AND EACH OF ITS SERVICES RESOLVE TO THE SAME ROOT
+				if(processedResources[fullResource.id]) { return; }
+
 				// ADD CURRENT DATE/TIME
 				fullResource["updated"] = currentDateTime;
 
@@ -249,15 +356,12 @@ function API()
 
 					// SET ADDITIONAL TYPES BEHIND RECCOURCE
 					fullResource["types"] = fullResource["types"].concat(additionalServiceTypes);
-				}
 
-				// RESOURCE HAS GROUPED SERVICES?
-				if (fullResource["services"])
-				{
-					for (serviceType in fullResource["services"])
+					// RESOURCE HAS GROUPED SERVICES?
+					for (const serviceType in fullResource["services"])
 					{
-						const grouped_services = fullResource['services'][serviceType];
-						for (groupedServiceID in grouped_services)
+						const groupedServices = fullResource['services'][serviceType];
+						for (const groupedServiceID in groupedServices)
 						{
 							if (!processedResources["_groupsOf"][groupedServiceID]) { processedResources["_groupsOf"][groupedServiceID] = []; }
 							processedResources["_groupsOf"][groupedServiceID].push(fullResource.id);
@@ -275,4 +379,4 @@ function API()
 }
 
 // EXPORT
-module.exports = new API;
+module.exports = new API;

package/huemagic/utils/color.js

@@ -1,13 +1,18 @@
 // EXTERNAL HELPERS
 const colornames = require("colornames");
 const colornamer = require('color-namer');
-const getColors = require('get-image-colors');
+
+// LOADED ON DEMAND, IT PULLS IN A LARGE DEPENDENCY TREE
+function getColors(...args)
+{
+	return require('get-image-colors')(...args);
+}
 
 // RGB -> XY
 function rgbToXy(red, green, blue, gamut = null)
 {
 	var colorGamut = { red: [1.0, 0], green: [0.0, 1.0], blue: [0.0, 0.0] };
-	if(!!gamut)
+	if(!!gamut && !!gamut.red && !!gamut.green && !!gamut.blue)
 	{
 		colorGamut = { red: [gamut.red.x, gamut.red.y], green: [gamut.green.x, gamut.green.y], blue: [gamut.blue.x, gamut.blue.y] };
 	}
@@ -34,9 +39,19 @@ function rgbToXy(red, green, blue, gamut = null)
 		xy = _getClosestColor(xy, colorGamut);
 	}
 
+	// THE BRIDGE REJECTS ANYTHING OUTSIDE 0…1 WITH A 400
+	xy.x = _clampToColorSpace(xy.x);
+	xy.y = _clampToColorSpace(xy.y);
+
 	return xy;
 }
 
+function _clampToColorSpace(value)
+{
+	if(isNaN(value)) { return 0; }
+	return (value < 0) ? 0 : ((value > 1) ? 1 : value);
+}
+
 function _getGammaCorrectedValue(value)
 {
 	return (value > 0.04045) ? Math.pow((value + 0.055) / (1.0 + 0.055), 2.4) : (value / 12.92)
@@ -153,6 +168,9 @@ function _getClosestPoint(xy, pointA, pointB)
 	let xy2a_dot_a2b = xy2a[0] * a2b[0] + xy2a[1] * a2b[1];
 	let t = xy2a_dot_a2b /a2bSqr;
 
+	// STAY ON THE EDGE OF THE GAMUT, NOT ON THE INFINITE LINE BEHIND IT
+	t = (t < 0) ? 0 : ((t > 1) ? 1 : t);
+
 	return {
 		x: pointA.x + a2b[0] * t,
 		y: pointA.y + a2b[1] * t

package/huemagic/utils/merge.js

@@ -13,9 +13,10 @@ function mergeDeep(...objects)
             const pVal = prev[key];
             const oVal = obj[key];
 
-            if(Array.isArray(pVal) && Array.isArray(oVal))
+            // AN UPDATE REPLACES A LIST, IT NEVER APPENDS TO IT
+            if(Array.isArray(oVal))
             {
-                prev[key] = pVal.concat(...oVal);
+                prev[key] = oVal;
             }
             else if (isObject(pVal) && isObject(oVal))
             {