@hurenkam/hue-services 0.6.0

package/.github/workflows/node.js.yml

@@ -0,0 +1,31 @@
+# This workflow will do a clean installation of node dependencies, cache/restore them, build the source code and run tests across different versions of node
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-nodejs
+
+name: Node.js CI
+
+on:
+  push:
+    branches: [ "maturing-v0.5" ]
+  pull_request:
+    branches: [ "maturing-v0.5" ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [14.x, 16.x, 18.x]
+        # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v3
+      with:
+        node-version: ${{ matrix.node-version }}
+        cache: 'npm'
+    - run: npm ci
+    - run: npm run build --if-present
+    - run: npm test

package/.nyc_output/ecb1b16f-015c-458b-96d5-32cb9569c1e8.json

@@ -0,0 +1 @@
+{}

package/.nyc_output/processinfo/ecb1b16f-015c-458b-96d5-32cb9569c1e8.json

@@ -0,0 +1 @@
+{"parent":null,"pid":1610421,"argv":["/usr/bin/node","/home/hurenkam/Workspace/node-red-contrib-mh-hue/node_modules/.bin/mocha","test/**/BaseUI_spec.js"],"execArgv":[],"cwd":"/home/hurenkam/Workspace/node-red-contrib-mh-hue","time":1670929477202,"ppid":1610410,"coverageFilename":"/home/hurenkam/Workspace/node-red-contrib-mh-hue/.nyc_output/ecb1b16f-015c-458b-96d5-32cb9569c1e8.json","externalId":"","uuid":"ecb1b16f-015c-458b-96d5-32cb9569c1e8","files":[]}

package/.nyc_output/processinfo/index.json

@@ -0,0 +1 @@
+{"processes":{"ecb1b16f-015c-458b-96d5-32cb9569c1e8":{"parent":null,"children":[]}},"files":{},"externalIds":{}}

package/.vscode/settings.json

@@ -0,0 +1,15 @@
+{
+    "mocha.files.glob": "test/**/*_spec.js",
+    "mocha.coverage": {
+        "enable": true,
+        "decoration": true,
+        "runWithInterval": false,
+        "autoUpdateInterval": 20000,
+        "activeOnStart": true,
+        "runAfterTest": false,
+        "runCoverageAfterFileSave": false,
+        "reporters": []
+    },
+    "terminal.integrated.defaultLocation": "editor",
+    "mochaExplorer.files": "test/**/*_spec.js"
+}

package/.vscode/sftp.json

@@ -0,0 +1,11 @@
+{
+    "name": "bullseye",
+    "host": "karpeer.net",
+    "protocol": "sftp",
+    "port": 8222,
+    "username": "hurenkam",
+    "remotePath": "/home/hurenkam/Workspace/node-red-contrib-mh-hue",
+    "uploadOnSave": true,
+    "useTempFile": false,
+    "openSsh": false
+}

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,340 @@
+# node-red-hue-services
+node-red palette to access hue bridge through clip v2 api
+
+![ScreenShot](screenshots/Screenshot%20from%202022-11-29%2000-31-29.png)
+
+
+# Status
+
+(Last update: 2022/12/16)
+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).
+
+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.0: Warning! This will break existing flows because the type names have been modified to use the @hurenkam/hue-services/ prefix.
+This should address issue #1.
+
+## Devices / Behaviors:
+- Removed for now, services should cover all the basics, devices & behaviors will be re-introduced in a later release
+
+## Services:
+- Generic Service, in case you need some service that is not supported below, you can use this.
+- Button
+- Device Power
+- Grouped Light
+- Light
+- Light Level
+- Motion
+- Relative Rotary
+- Scene
+- Temperature
+- Zigbee Connectivity
+
+## Todo
+- ~~Bridge discovery and automatic key generation has not yet been implemented. Currently the~~
+  ~~bridge needs to be configured manually with an ip address and known key.~~
+- ~~Provide better low level support for simple resources as 'grouped_light' or 'light'.~~
+- ~~Provide a generic sevice node (to allow using as of yet unsupported services)~~
+- ~~Use scope, this is probably required if i want to upload this as a package.~~
+- ~~Fix packaging, now I'm using a symlink to point to my *UI.js files, this needs a proper solution.~~
+- ~~Upload package to node-red library~~
+- ~~Unit Tests for Clip~~
+- ~~Unit Tests for Nodes~~
+- Unit Tests for UI
+
+## Postponed until after 0.5.x release
+- Improve 'smart' modes for Switch and Motion 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)
+
+# Use
+Using these nodes requires a bit of knowledge on the clip v2 api, as i designed this palette
+to offer an easy low level interface towards clip.
+
+The basic principle of the nodes is that you select the proper id on the bridge, then clip events
+associated with that resource id will come out as `msg.payload`, and whatever `msg.payload` is piped in
+at the input will be sent as a put request to the clip v2 interface.
+(See here: https://developers.meethue.com/develop/hue-api-v2 )
+
+The following command will for instance switch a light, room or zone on:
+
+`{ "rtypes": ["light", "grouped_light"], "payload": { "on": { "on": true } } }`
+
+And the following command wil set the brightness to 50%:
+
+`{ "rtypes": ["light", "grouped_light"], "payload": { "dimming": { "brightness": 50 } } }`
+
+Do note that to address a node, you must either provide an msg.rids array that contains the rid
+of the resource you wish to address, or an msg.rtypes array that contains the rtype of the resource
+you wish to address.
+
+# Design
+
+## Incoming Event
+```mermaid
+sequenceDiagram
+    actor Bridge
+    Bridge ->> ClipApi: message
+    ClipApi ->> Resource: onEvent
+    Resource ->> ResourceNode: update(event)
+    ResourceNode ->> Output: msg.payload = event
+```
+
+## Outgoing Message
+```mermaid
+sequenceDiagram
+    actor Bridge
+    Input ->> ResourceNode: msg.payload, msg.rtypes | msg.rids
+    ResourceNode ->> Resource: put msg.payload
+    Resource ->> ClipApi: put rid, data
+    ClipApi ->> RestApi: put /clip/v2/rid data
+    RestApi ->> Bridge: put
+```
+
+## Class Diagram
+```mermaid
+classDiagram
+
+class BaseNode {
+    +config
+    #onInput
+    #onClose
+
+    +constructor(config)
+    +logid()
+    +getStatusFill()
+    +getStatusText()
+    +getStatusShape()
+    +updateStatus()
+    +onInput(msg)
+    +destructor()
+}
+
+class ResourceNode {
+    #onUpdate
+    #resource
+    
+    +constructor(config)
+    +start(resource)
+    +resource()
+    +rid()
+    +bridge()
+    +onUpdate(event)
+    +onInput(msg)
+    +destructor()
+}
+
+class ServiceNode {
+    +constructor(config)
+}
+
+class BridgeConfigNode {
+    #onClose
+    #onClipError
+    #clip
+    
+    +constructor(config)
+    #initClip()
+    #uninitClip()
+    +onClipError(error)
+    +clip()
+    +requestStartup(resource)
+    +destructor()
+    
+    +DiscoverBridges()$
+    +AcquireApplicationKey(ip)$
+}
+
+class ClipApi {
+    #restApi
+    #resources
+    #startQ
+    #isStarted
+    #name
+    #ip
+    #key
+    
+    +constructor()
+    +requestStartup(resource)
+    +getResource(rid)
+    +get(rtype,rid)
+    +put(rtype,rid,data)
+    +post(rtype,rid,data)
+    +delete(rtype,rid)
+    #isResourceRegistered(rid)
+    #registerResource(resource)
+    #unregisterResource(resource)
+    +getSortedServicesById(rid)
+    +getSortedResourcesByTypeAndModel(type,models)
+    +getSortedResourceOptions(type,models)
+    +getSortedTypeOptions()
+    +getSortedOwnerOptions()
+    +getSortedServiceOptions()
+    +destructor()
+}
+
+class RestApi {
+    #ip
+    #headers
+    #requestQ
+    #timeout
+    #limiter
+    
+    +constructor(name,ip,throttle,headers)
+    #request(url,method,data)
+    #handleRequest()
+    +get(url)
+    +put(url,data)
+    +post(url,data)
+    +delete(url)
+    +destructor()
+}
+
+class Resource {
+    #clip
+    #item
+    
+    +constructor(item,clip)
+    +clip()
+    +item()
+    +id()
+    +rid()
+    +rtype()
+    +owner()
+    +name()
+    +typeName()
+    +services()
+    +get()
+    +put(data)
+    +onEvent(event)
+    +updateStatus(event)
+    +destructor()
+}
+
+class ButtonNode {
+    +constructor(config)
+    +onUpdate(event)
+    +updateStatus()
+}
+
+class DevicePowerNode {
+    +constructor(config)
+    +onUpdate(event)
+    +updateStatus()
+}
+
+class GroupedLightNode {
+    +constructor(config)
+    +onUpdate(event)
+    +updateStatus()
+}
+
+class LightLevelNode {
+    +constructor(config)
+    +onUpdate(event)
+    +updateStatus()
+}
+
+class LightNode {
+    +constructor(config)
+    +onUpdate(event)
+    +updateStatus()
+}
+
+class MotionNode {
+    +constructor(config)
+    +onUpdate(event)
+    +updateStatus()
+}
+
+class RelativeRotaryNode {
+    +constructor(config)
+    +onUpdate(event)
+    +updateStatus()
+}
+
+class SceneNode {
+    +constructor(config)
+}
+
+class TemperatureNode {
+    +constructor(config)
+    +onUpdate(event)
+    +updateStatus()
+}
+
+class ZigbeeConnectivityNode {
+    +constructor(config)
+    +onUpdate(event)
+    +updateStatus()
+}
+
+direction LR
+BaseNode <|-- BridgeConfigNode
+BaseNode <|-- ResourceNode
+ResourceNode ..> BridgeConfigNode
+ResourceNode --> Resource
+ResourceNode <|-- ServiceNode
+ResourceNode <|-- ButtonNode
+ResourceNode <|-- DevicePowerNode
+ResourceNode <|-- GroupedLightNode
+ResourceNode <|-- LightLevelNode
+ResourceNode <|-- LightNode
+ResourceNode <|-- MotionNode
+ResourceNode <|-- RelativeRotaryNode
+ResourceNode <|-- SceneNode
+ResourceNode <|-- TemperatureNode
+ResourceNode <|-- ZigbeeConnectivityNode
+
+BridgeConfigNode --> ClipApi
+ClipApi --> RestApi
+ClipApi *-- Resource
+
+```
+
+# Debug
+(see src/debug.js)
+The server side classes are instrumented with logging using the debug module, this can be changed
+runtime by sending appropriate GET / POST / DELETE requests to the node-red /debug endpoint
+(default: http://localhost:1880/debug):
+
+Use the following command to retrieve the current settings:
+
+`curl -i -H "Accept: application/json" 'localhost:1880/debug'`
+
+Use the following command to enable error and warning logging:
+
+`curl -i -H "Accept: application/json" 'localhost:1880/debug' -d "namespaces='error:*,warn:*"`
+
+Use the following command to disable debug logging:
+
+`curl -i -H "Accept: application/json" 'localhost:1880/debug' -X "DELETE"`
+
+Classes have 4 loglevels:
+- error
+- warn
+- info
+- debug
+
+Log messages are typically built like this: `<loglevel>:<class>:<name or id> <logmessage>`, where
+currently the following classes exist (see the code). Each level of each class can be enabled
+or disabled seperately, and even per instance.
+
+If running locally, you can set the DEBUG environment variable to enable debuggin:
+`DEBUG="error:*,warn:*,info:*,trace:*" node-red`
+
+
+# Credits
+Credit where credit is due, this was inspired by the node-red-contrib-huemagic project, which stopped working for me at some point.
+That is when i decided to go and dive into this, and create my own wrapper around the hue clip v2 api.
+
+I initially licensed this code under GPLv2, but have changed that to Apache v2 because both node-red as well asl the huemagic extension
+use that license, and i want this to be compatible so that in case it might be considered useful by either project, they can easily include it.
+Since Apache v2 is less restrictive than GPLv2, it imposes no limits w.r.t. the original license, the code can still be re-distributed under GPLv2.

package/Todo.txt

@@ -0,0 +1,18 @@
+
+* Split GenericDeviceNode from DeviceNode
+    * DeviceNode to function as basis for real devices, offering a 'smart' mode for defined devices.
+    * GenericDeviceNode to offer 'raw' mode only, allowing for more control, and a generic way to deal
+      with currently unsupported devices.
+
+* Refactor ServiceUI / ResourceUI; remove duplicate code as much as possible.
+
+* Add help info for:
+    * MotionBehaviorUI
+    * SceneCyclerUI
+
+* Extend help info for:
+    * BridgeConfigUI
+    * DimmerSwitchUI
+    * LutronAuroraUI
+    * MotionSensorUI
+    * WallSwitchModuleUi