loupedeck-commander 1.3.0 → 1.3.2

package/config.yaml

@@ -0,0 +1,6 @@
+application: Example
+profiles:
+  - name: profile-1
+    file: profile-1.yaml
+  - name: profile-2
+    file: profile-2.yaml

package/interfaces/baseif.mjs

@@ -57,7 +57,7 @@ export class BaseIf extends EventEmitter {
 
   LogDebug(...args){
     if (this.options && this.options.verbose){
-      let str = new String(args)
+      let str = args.join(' ')
       process.stdout.write(str.toString())
     }
   }

package/interfaces/opcuaif.mjs

@@ -2,27 +2,14 @@ import {
     OPCUAClient,
     MessageSecurityMode,
     SecurityPolicy,
-    BrowseDirection,
     AttributeIds,
-    NodeClassMask,
-    makeBrowsePath,
     resolveNodeId,
     TimestampsToReturn,
-    coerceInt32,
-    coerceByteString,
     DataType
 } from "node-opcua";
 
 import { BaseIf } from './baseif.mjs'
 
-const subscriptionParameters = {
-    maxNotificationsPerPublish: 1000,
-    publishingEnabled: true,
-    requestedLifetimeCount: 100,
-    requestedMaxKeepAliveCount: 10,
-    requestedPublishingInterval: 1000
-};
-
 /**
  * Our Special-Handler just used the Default - and adds Vibration after triggers through Button-Releases
  */
@@ -34,20 +21,16 @@ export class OPCUAIf extends BaseIf {
     #connected
     #endpointurl
     #publishingInterval
+    #samplingInterval
+    // Dictionary to store monitored items : key = monitoredItemId, value = nodeID
     monitoreditems
     types
+    // Dictionary to store buttons : key = monitoredItemId, value = buttonID
     buttons
     constructor() {
         super()
     }
 
-    async stop() {
-        if (!this.#client)
-            return
-        await this.Disconnect()
-        this.LogInfo(`OPCUAIf Stopped\n`)
-    }
-
     /**
      * Initialize the OPCUA client and subscribe to monitored items.
      * @param {*} options 
@@ -63,10 +46,16 @@ export class OPCUAIf extends BaseIf {
             this.#endpointurl = this.formatString(options.endpointurl, options)
             if (options.publishingInterval)
                 this.#publishingInterval = options.publishingInterval
-            else{
+            else {
                 this.#publishingInterval = 250;
                 this.LogInfo(`OPCUAIf init using default publishingInterval: ${this.#publishingInterval}ms\n`);
             }
+            if (options.samplingInterval)
+                this.#samplingInterval = options.samplingInterval
+            else {
+                this.#samplingInterval = 100;
+                this.LogInfo(`OPCUAIf init using default samplingInterval: ${this.#samplingInterval}ms\n`);
+            }
             this.monitoreditems = {}
             this.types = {}
             this.buttons = {}
@@ -75,47 +64,65 @@ export class OPCUAIf extends BaseIf {
             await this.Connect(this.#endpointurl);
 
             let fields = [config.touch.center, config.knobs, config.buttons]
-            const fieldKeys = Object.keys(fields)
-            for (let f = 0; f < fieldKeys.length; f++) {
+            for (let f = 0; f < fields.length; f++) {
                 let field = fields[f]
-                const keys = Object.keys(field)
+                const buttonNames = Object.keys(field)
 
                 // Iterate over buttons:
-                for (let i = 0; i < keys.length; i++) {
-                    const key = keys[i]
-                    const elem = field[key]
-                    options["key"] = key        // we have to know the key of the button
+                for (let i = 0; i < buttonNames.length; i++) {
+                    const buttonID = buttonNames[i]
+                    const elem = field[buttonID]
+                    options["key"] = buttonID        // we have to know the key of the button
                     // groupnode
-                    if (elem.params && elem.params.nodeid) {
-                        let formattedNodeId = this.formatString(elem.params.nodeid, options)
-                        let monitoredItemId = await this.Subscribe(formattedNodeId)
-                        console.log("Subscribe to",monitoredItemId,formattedNodeId)
-                        this.buttons[monitoredItemId] = i
+                    if (elem.params) {
+                        let attributes = ["nodeid", "blink"]
+                        for (let j = 0; j < attributes.length; j++) {
+                            const attribute = attributes[j]
+                            if (attribute in elem.params) {
+                                if (!this.IsNodeID(elem.params[attribute])) {
+                                    continue
+                                }
+
+                                let monitoredItemId = await this.Subscribe(elem.params[attribute], options,attribute)
+                                if (monitoredItemId) {
+                                    this.buttons[monitoredItemId] = {
+                                        buttonID: i,
+                                        buttonName: buttonID,
+                                        attribute: attribute
+                                    }
+                                }
+                            }
+                        }
+                    }
+                    if (elem.states) {
+                        let attributes = ["opcua", "blink"]
+                        let states = Object.values(elem.states)
+                        // Iterate over states:
+                        for (let j = 0; j < states.length; j++) {
+                            const state = states[j]
+
+                            for (let k = 0; k < attributes.length; k++) {
+                                const attribute = attributes[k]
+                                if (attribute in state) {
+                                    if (!this.IsNodeID(state[attribute])) {
+                                        continue
+                                    }      
+                                    let monitoredItemId = await this.Subscribe(state[attribute], options,attribute)
+                                    if (monitoredItemId) {
+                                        this.buttons[monitoredItemId] = {
+                                            buttonID: i,
+                                            buttonName: buttonID,
+                                            attribute: attribute
+                                        }
+                                    }
+                                }
+                            }
+                        }
                     }
-                    await this.monitorStates(elem, options)
                 }
             }
         } catch (error) {
-            this.LogError(`OPCUAIf: Error\n`,error)
-        }
-    }
-
-    /**
-     * 
-     * @param {*} elem : Elem Object
-     * @param {*} options 
-     */
-    async monitorStates(elem, options) {
-        const stateKeys = Object.keys(elem.states)
-        for (let i = 0; i < stateKeys.length; i++) {
-            const key2 = stateKeys[i]
-            const state = elem.states[key2]
-            if (state.opcua) {
-                let formattedNodeId = this.formatString(state.opcua, options)
-                let monitoredItemId = await this.Subscribe(formattedNodeId)
-                console.log("Subscribe to",monitoredItemId,formattedNodeId)
-                this.buttons[monitoredItemId] = i
-            }
+            this.LogError(`OPCUAIf: Error\n`, error)
         }
     }
 
@@ -164,6 +171,13 @@ export class OPCUAIf extends BaseIf {
         }
     }
 
+    /**
+     * Call the OPCUA node with the given options.
+     * This method will write the value to the node and return the new state.
+     * @param {*} opcuaNode 
+     * @param {*} options 
+     * @returns 
+     */
     async call(opcuaNode, options = {}) {
         var res = this.Check(options)
         if (res < 0) {
@@ -171,7 +185,7 @@ export class OPCUAIf extends BaseIf {
             return false
         }
 
-        var nodeId = super.formatString(opcuaNode, options)
+        var nodeId = super.call(opcuaNode, options)
 
         var type = this.types[nodeId]
         var value = options.value
@@ -211,21 +225,40 @@ export class OPCUAIf extends BaseIf {
         return 0
     }
 
+    /**
+     * This method is called when the interface is stopped.
+     * It will disconnect the client and stop the subscription.
+     * @returns 
+     */
+    async stop() {
+        if (!this.#client)
+            return
+        await this.Disconnect()
+        this.LogInfo(`OPCUAIf Stopped\n`)
+    }
+
+    /**
+     * Disconnect the OPCUA client and close the session.
+     */
     async Disconnect() {
         if (this.#client) {
             if (this.#session)
-                await this.#client.closeSession(this.#session,true)
+                await this.#client.closeSession(this.#session, true)
             this.#session = undefined
             this.#client = undefined
             this.LogInfo(`OPCUAIf: Disconnected\n`);
         }
     }
+    /**
+     * Connect to the OPCUA server with the given URL.
+     * @param {string} url - The URL of the OPCUA server, typical format: opc.tcp://ip-address:4840 .
+     */
     async Connect(url) {
         let self = this
-        if (this.#client){
+        if (this.#client) {
             await this.Disconnect()
         }
-        
+
         this.#client = OPCUAClient.create({
             applicationName: "NodeOPCUA-Client",
             endpointMustExist: true,
@@ -242,7 +275,7 @@ export class OPCUAIf extends BaseIf {
             defaultSecureTokenLifetime: 20000,
             tokenRenewalInterval: 1000
         });
-    
+
 
         this.#client.on("backoff", (retry, delay) => {
             //if ((retry % 10) == 0)
@@ -267,9 +300,9 @@ export class OPCUAIf extends BaseIf {
         this.#client.on("after_reconnection", (err) => {
             self.LogInfo(`OPCUAIf: After Reconnection event => ${err}\n`);
         });
-        this.#client.on("security_token_renewed", () => {
+        /*this.#client.on("security_token_renewed", () => {
             self.LogDebug(`OPCUAIf: security_token_renewed\n`);
-        })
+        })*/
         this.#client.on("lifetime_75", (token) => { })
 
         this.LogInfo(`OPCUAIf: connecting client to ${url}\n`);//, this.#session.toString());
@@ -299,23 +332,46 @@ export class OPCUAIf extends BaseIf {
             requestedPublishingInterval: this.#publishingInterval
         });
 
-        this.LogInfo(`OPCUAIf: session created\n`);//, this.#session.toString());
-        this.LogInfo(`OPCUAIf: client\n`);
-        this.LogInfo(`OPCUAIf: subscription\n`);
+        this.LogInfo(`OPCUAIf: session created\n`);
+        //        this.LogInfo(`OPCUAIf: client\n`);
+        //        this.LogInfo(`OPCUAIf: subscription\n`);
         this.#connected = true
         this.#endpointurl = url
     }
 
-    async Subscribe(nodeID) {
-        // install monitored item
+    /**
+     * Check if the given nodeID is a valid OPCUA nodeID.
+     * A valid nodeID has the format: ns=<namespace index>;s=<identifier>
+     * where <namespace index> is a number and <identifier> is a string.
+     * @param {*} nodeID 
+     * @returns 
+     */
+    IsNodeID(nodeID) {
+        let strNodeID = nodeID.toString()
+        // regex: ns=\d;s=.*
+        if (strNodeID.match(/^ns=\d+;s=.*$/)) {
+            return true
+        }
+        return false
+    }
 
-        const keys = Object.keys(this.monitoreditems)
-        for (let i = 0; i < keys.length; i++) {
-            const key = keys[i]
-            const elem = this.monitoreditems[key]
-            if (elem == nodeID) {
+    /**
+     * Register a subscription for a nodeID.
+     * This method will create a monitored item for the given nodeID and return the monitored item ID.
+     * If the nodeID is already registered, it will return the existing monitored item ID.
+     * @param {*} nodeID 
+     * @returns 
+     */
+    async Subscribe(unformattedNodeID, options = {},attribute) {
+        // Format the nodeID using the provided options
+        let nodeID = this.formatString(unformattedNodeID, options)
+        
+        // install monitored item
+        const monitoredNodeIdList = Object.values(this.monitoreditems)
+        for (let i = 0; i < monitoredNodeIdList.length; i++) {
+            if (monitoredNodeIdList[i] == nodeID) {
                 // already registered => return itemid
-                return key
+                return this.monitoreditems[i]
             }
         }
 
@@ -324,13 +380,13 @@ export class OPCUAIf extends BaseIf {
             attributeId: AttributeIds.Value
         };
         const monitoringParameters = {
-            samplingInterval: 100,
+            samplingInterval: this.#samplingInterval,
             discardOldest: true,
             queueSize: 10
         };
 
         if (!this.#sub) {
-            this.LogError(`OPCUAIf: not register monitored items $itemToMonitor\n`);
+            this.LogError(`OPCUAIf: no subscription - don't register monitored items $itemToMonitor\n`);
             return
         }
         const monitoredItem = await this.#sub.monitor(itemToMonitor, monitoringParameters, TimestampsToReturn.Both);
@@ -338,14 +394,20 @@ export class OPCUAIf extends BaseIf {
         var self = this
         monitoredItem.on("changed", function (dataValue) {
             var nodeId = self.monitoreditems[this.monitoredItemId]
-            var buttonID = self.buttons[this.monitoredItemId]
+            var buttonInfo = self.buttons[this.monitoredItemId]
             // store the type of a nodeid in local dictionary
             self.types[nodeId] = dataValue.value.dataType
             // publish the value to subscribers:
-            self.LogInfo(`OPCUAIf: monitored item changed: ${nodeId} => ${dataValue.value.value}\n`);
-            self.emit('monitored item changed', buttonID, nodeId, dataValue.value.value)
+            self.LogInfo(`OPCUAIf: monitored item changed: ${buttonInfo.buttonID} ${buttonInfo.attribute} ${nodeId} => ${dataValue.value.value}\n`);
+            self.emit('monitored item changed', buttonInfo.buttonID, buttonInfo.attribute, nodeId, dataValue.value.value)
         });
 
+        if (monitoredItem.monitoredItemId === undefined) {
+            this.LogError(`OPCUAIf: Error subscribing to node ${nodeID} (attribute ${attribute})\n`)
+        } else {
+            this.LogDebug(`OPCUAIf: Subscribe to ${monitoredItem.monitoredItemId},${nodeID},(attribute ${attribute})\n`);
+        }
+
         return monitoredItem.monitoredItemId;
     }
 
@@ -390,12 +452,10 @@ export class OPCUAIf extends BaseIf {
                     }
                 } else {
                     self.LogError("OPCUAIf: write NOT ok", nodeID, value, "\n");
-                    self.LogError(err)
                 }
             });
         } catch (err) {
             self.LogError("OPCUAIf: write NOT ok", nodeID, value, "\n");
-            self.LogError(err)
         }
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "loupedeck-commander",
-  "version": "1.3.0",
+  "version": "1.3.2",
   "description": "A system to ease working with LoupeDeck devices using CMD-line, OPC/UA or HTTP-client interfaces",
   "main": "index.mjs",
   "scripts": {
@@ -14,7 +14,8 @@
     "loupedeck": "^7.0.0",
     "mkdirp": "^3.0.1",
     "node-opcua": "^2.153.0",
-    "string-template": "^1.0.0"
+    "string-template": "^1.0.0",
+    "yaml": "^2.8.0"
   },
   "author": "Thomas Schneider",
   "license": "Apache-2.0",

package/profile-1.yaml

@@ -0,0 +1,186 @@
+name: profile-1
+profile: example
+description: ""
+touch:
+  center:
+    "0":
+      states:
+        off:
+          color: "#000055"
+          textColor: "#FFFFFF"
+          image: icons/home.png
+          cmd: echo "{id} {state}"
+          font: 20px Arial
+          blink: true
+        on:
+          color: "#00ff00"
+          image: icons/home.png
+          cmd: echo "{id} {state}"
+          font: 10px Arial
+          blink: false
+      params:
+        text: "{key}"
+    "1":
+      states:
+        off:
+          color: "#000099"
+          image: icons/home.png
+          cmd: echo "{id} {state} {pressed}"
+        on:
+          color: "#00ff00"
+          image: icons/home.png
+          cmd: echo "{id} {state} {pressed}"
+          blink: true
+      params:
+        minPressed: 100
+        text: "{released}"
+    "2":
+      states:
+        off:
+          color: "#000099"
+          image: icons/home.png
+          cmd: echo "{id} {state}"
+        on:
+          color: "#00ff00"
+          image: icons/home.png
+          cmd: echo "{id} {state}"
+    "3":
+      states:
+        off:
+          color: "#000099"
+          image: icons/home.png
+          cmd: echo "{id} {state}"
+        on:
+          color: "#00ff00"
+          image: icons/home.png
+          cmd: echo "{id} {state}"
+    "4":
+      states:
+        off:
+          color: "#000099"
+          image: icons/home.png
+          cmd: echo "{id} {state}"
+        on:
+          color: "#00ff00"
+          image: icons/home.png
+          cmd: echo "{id} {state}"
+    "5":
+      states:
+        off:
+          color: "#000099"
+          image: icons/home.png
+          cmd: echo "{id} {state}"
+        on:
+          color: "#00ff00"
+          image: icons/home.png
+          cmd: echo "{id} {state}"
+    "6":
+      states:
+        off:
+          color: "#000099"
+          image: icons/home.png
+          cmd: echo "{id} {state}"
+        on:
+          color: "#00ff00"
+          image: icons/home.png
+          cmd: echo "{id} {state}"
+    "7":
+      states:
+        off:
+          color: "#000099"
+          image: icons/home.png
+          cmd: echo "{id} {state}"
+        on:
+          color: "#00ff00"
+          image: icons/home.png
+          cmd: echo "{id} {state}"
+    "8":
+      states:
+        off:
+          color: "#000099"
+          image: icons/home.png
+          cmd: echo "{id} {state}"
+        on:
+          color: "#00ff00"
+          image: icons/home.png
+          cmd: echo "{id} {state}"
+    "9":
+      states:
+        off:
+          color: "#000099"
+          image: icons/home.png
+          cmd: echo "{id} {state}"
+        on:
+          color: "#00ff00"
+          image: icons/home.png
+          cmd: echo "{id} {state}"
+    "10":
+      states:
+        off:
+          color: "#000099"
+          image: icons/home.png
+          cmd: echo "{id} {state}"
+        on:
+          color: "#00ff00"
+          image: icons/home.png
+          cmd: echo "{id} {state}"
+    "11":
+      states:
+        off:
+          color: "#000099"
+          image: icons/home.png
+          cmd: echo "{id} {state}"
+        on:
+          color: "#00ff00"
+          image: icons/home.png
+          cmd: echo "{id} {state}"
+  left:
+    "0":
+      states:
+        on:
+          color: "#000000"
+          cmd: echo "{id} {state}"
+  right:
+    "0":
+      states:
+        on:
+          color: "#000000"
+          cmd: echo "{id} {state}"
+knobs:
+  knobTL:
+    states:
+      on:
+        cmd: echo "{id} {state}"
+  knobCL:
+    states:
+      on:
+        cmd: echo "{id} {state}"
+  knobBL:
+    states:
+      on:
+        cmd: echo "{id} {state}"
+        opcua: ns=2;s=DRV.AAFHR.compOut.FeldTempGetriebeoel
+        blink: ns=2;s=DRV.AAFHR.compOut.Feststellbremse
+  knobTR:
+    states:
+      on:
+        cmd: echo "{id} {state}"
+  knobCR:
+    states:
+      on:
+        cmd: echo "{id} {state}"
+  knobBR:
+    states:
+      on:
+        cmd: echo "{id} {state}"
+parameters:
+  hostname: 127.0.0.1
+  simnbr: "1"
+  endpointurl: opc.tcp://{hostname}:4840
+  publishingInterval: 200
+  nodeid: ns=0;s=nodeID
+  textColor: "#abcdff"
+  textBaseLine: top
+  textAlign: left
+  font: 14px Arial
+  verbose: true