@hurenkam/hue-services 0.6.4 → 0.6.5

package/README.md

@@ -6,15 +6,17 @@ node-red palette to access hue bridge through clip v2 api
 
 # Status
 
-(Last update: 2022/12/16)
+(Last update: 2025/12/20)
 This is not complete, but seems to work consistent and reliable for the services I regularly use.
-(motion/temperature/light_level/light/grouped_light/button/relative_rotary/scene).
+(motion/temperature/light_level/light/grouped_light/button/relative_rotary/scene/contact/camera_motion).
 
 Unit tests are in place for the server side nodes.
 
 Editor/UI functionality is currently not being tested apart from my own use in the editor, so your mileage may vary.
 
 # Changelog
+v0.6.5: Added nodes for camera and contact sensor. Improved generic service usability.
+
 v0.6.4: Fix checkbox to work with Safari
 
 v0.6.3: Added option for nodes to generate a status event on startup (see issue #3)
@@ -30,6 +32,8 @@ This should address issue #1.
 ## Services:
 - Generic Service, in case you need some service that is not supported below, you can use this.
 - Button
+- Camera Motion
+- Contact
 - Device Power
 - Grouped Light
 - Light
@@ -50,14 +54,19 @@ This should address issue #1.
 - ~~Upload package to node-red library~~
 - ~~Unit Tests for Clip~~
 - ~~Unit Tests for Nodes~~
+- ~~Contact sensor~~
+- ~~Camera~~
+- Geofencing
+- Smart Scenes
 - Unit Tests for UI
 
+
 ## Postponed until after 0.6.x release
 - Improve 'smart' modes for Switch and Motion devices
-- Improve the generic device node (which allows using as of yet unsupported devices)
+- ~~Improve the generic device node (which allows using as of yet unsupported devices)~~
 - Support more devices
-  - smart button (should be easy to do, but i don't have one to test)
-  - tap dial switch (should be similar to a lutron aurora, but i don't have one to test)
+  - ~~smart button (should be easy to do, but i don't have one to test)~~
+  - ~~tap dial switch (should be similar to a lutron aurora, but i don't have one to test)~~
 
 # Use
 Using these nodes requires a bit of knowledge on the clip v2 api, as i designed this palette

package/attic-bridge-v2-key.txt

@@ -0,0 +1,2 @@
+2ml0TLJEUc-j-byMhxIhymRSOUPUlnzRrZUiseoq
+

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hurenkam/hue-services",
-  "version": "0.6.4",
+  "version": "0.6.5",
   "description": "Custom node-red nodes for interfacing with philips hue devices",
   "author": "Mark Hurenkamp",
   "license": "Apache 2.0",

package/src/all.html

@@ -3,6 +3,8 @@
     import { BridgeConfigUI }         from "/src/ui/BridgeConfigUI.js";
 
     import { ButtonUI }               from "/src/ui/ButtonUI.js";
+    import { CameraMotionUI }         from "/src/ui/CameraMotionUI.js";
+    import { ContactUI }              from "/src/ui/ContactUI.js";
     import { DevicePowerUI }          from "/src/ui/DevicePowerUI.js";
     import { GroupedLightUI }         from "/src/ui/GroupedLightUI.js";
     import { LightUI }                from "/src/ui/LightUI.js";
@@ -18,6 +20,8 @@
         "BridgeConfigNode": BridgeConfigUI,
 
         "ButtonNode": ButtonUI,
+        "CameraMotionNode": CameraMotionUI,
+        "ContactNode": ContactUI,
         "DevicePowerNode": DevicePowerUI,
         "GroupedLightNode": GroupedLightUI,
         "LightNode": LightUI,

package/src/all.js

@@ -7,6 +7,8 @@ module.exports = function(RED) {
     const BridgeConfigNode = require('./nodes/BridgeConfigNode');
 
     const ButtonNode = require('./nodes/ButtonNode');
+    const CameraMotionNode = require('./nodes/CameraMotionNode');
+    const ContactNode = require('./nodes/ContactNode');
     const DevicePowerNode = require('./nodes/DevicePowerNode');
     const GroupedLightNode = require('./nodes/GroupedLightNode');
     const LightNode = require('./nodes/LightNode');
@@ -23,6 +25,8 @@ module.exports = function(RED) {
         "BridgeConfigNode": BridgeConfigNode,
 
         "ButtonNode": ButtonNode,
+        "CameraMotionNode": CameraMotionNode,
+        "ContactNode": ContactNode,
         "DevicePowerNode": DevicePowerNode,
         "GroupedLightNode": GroupedLightNode,
         "LightNode": LightNode,

package/src/clip/ClipApi.js

@@ -24,33 +24,6 @@ class ClipApi extends events.EventEmitter {
     #info;
     #trace;
 
-    #factory =  {
-        "behavior_script": Resource,
-        "behavior_instance": Resource,
-        "bridge": Resource,
-        "bridge_home": Resource,
-        "button": Resource,
-        "device": Resource,
-        "device_power": Resource,
-        "entertainment": Resource,
-        "entertainment_configuration": Resource,
-        "geolocation": Resource,
-        "grouped_light": Resource,
-        "homekit": Resource,
-        "light": Resource,
-        "light_level": Resource,
-        "matter": Resource,
-        "motion": Resource,
-        "relative_rotary": Resource,
-        "room": Resource,
-        "scene": Resource,
-        "temperature": Resource,
-        "zgp_connectivity": Resource,
-        "zigbee_connectivity": Resource,
-        "zigbee_device_discovery": Resource,
-        "zone": Resource
-    };
-
     constructor(ip,key,name) {
         super();
 
@@ -145,13 +118,9 @@ class ClipApi extends events.EventEmitter {
         response.data.forEach((item) => {
             this.#trace("constructor()  found resource:", item);
 
-            if (Object.keys(this.#factory).includes(item.type)) {
-                if (!this._isResourceRegistered(item.id)) {
-                    var resource = new this.#factory[item.type](item,this);
-                    this._registerResource(resource);
-                }
-            } else {
-                this.#warn("constructor(): Missing factory for type", item.type);
+            if (!this._isResourceRegistered(item.id)) {
+                var resource = new Resource(item,this);
+                this._registerResource(resource);
             }
         });
 
@@ -364,4 +333,4 @@ class ClipApi extends events.EventEmitter {
     }
 }
 
-module.exports = ClipApi
+module.exports = ClipApi

package/src/nodes/CameraMotionNode.js

@@ -0,0 +1,39 @@
+ResourceNode = require("./ResourceNode");
+
+class CameraMotionNode extends ResourceNode {
+    #info;
+    #trace;
+
+    constructor(config) {
+        super(config);
+        this.#info = require('debug')('info').extend('CameraMotionNode').extend("["+this.logid()+"]");
+        this.#trace = require('debug')('trace').extend('CameraMotionNode').extend("["+this.logid()+"]");
+        this.#info("constructor()");
+    }
+
+    onUpdate(event) {
+        this.#trace("onUpdate(",event,")")
+        this.updateStatus();
+        super.onUpdate(event);
+    }
+
+    updateStatus() {
+        this.#trace("updateStatus()")
+
+        var fill = "grey";
+        var shape = "dot";
+        var text = "";
+
+        var resource = this.resource();
+        if ((resource) && (resource.data()) && (resource.data().motion)) {
+            if (resource.data().motion.motion!=null) {
+                fill = (resource.data().motion.motion==true)? "blue" : "grey";
+                text = (resource.data().motion.motion==true)? "motion" : "no motion";
+            }
+        }
+
+        this.status({fill: fill, shape: shape, text: text});
+    }
+}
+
+module.exports = CameraMotionNode;

package/src/nodes/ContactNode.js

@@ -0,0 +1,52 @@
+ResourceNode = require("./ResourceNode");
+
+class ContactNode extends ResourceNode {
+    #fill;
+
+    #info;
+    #trace;
+
+    constructor(config) {
+        super(config);
+
+        this.#info = require('debug')('info').extend('ContactNode').extend("["+this.logid()+"]");
+        this.#trace = require('debug')('trace').extend('ContactNode').extend("["+this.logid()+"]");
+        this.#info("constructor()");
+
+        this.#fill = "grey";
+    }
+
+    onUpdate(event) {
+        this.#trace("onUpdate(",event,")");
+        this.#fill = "blue";
+        
+        var instance = this;
+        setTimeout(()=>{
+            instance.#fill = "grey";
+            instance.updateStatus();
+        },1000);
+
+        this.updateStatus();
+        super.onUpdate(event);
+    }
+
+    updateStatus() {
+        this.#trace("updateStatus()");
+
+        var fill = this.#fill;
+        var shape = "dot";
+        var text = "";
+
+        var resource = this.resource();
+        if ((resource) && (resource.data()) && (resource.data().contact_report)) {
+            if (resource.data().contact_report.state!=null) {
+                fill = (resource.data().contact_report.state=="contact")? "grey" : "blue";
+                text = (resource.data().contact_report.state=="contact")? "closed" : "open";
+            }
+        }
+
+        this.status({fill: fill, shape: shape, text: text});
+    }
+}
+
+module.exports = ContactNode;

package/src/ui/CameraMotionUI.js

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

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