loupedeck-commander 1.3.0 → 1.3.1

package/common/utils.mjs

@@ -1,17 +1,29 @@
 import { readFileSync, writeFileSync } from 'node:fs'
+import YAML from 'yaml'
 
 /**
- * Read a JSON File
+ * Read a Config file in either JSON or YAML Fileformat
+ * @param {string} fileName - The name of the file to read
+ * @returns {object} - The parsed object from the file
  */
-export function readJSONFile (fileName) {
-  let data
+export function readConfigFile (fileName) {
+  let obj = undefined
   try {
-    data = readFileSync(fileName, 'utf8')
-    return JSON.parse(data)
+    //console.log("Reading File:", fileName)
+    let data = readFileSync(fileName, 'utf8')
+    // If the file is a YAML file, parse it
+    if (fileName.endsWith('.yaml') || fileName.endsWith('.yml')) {
+      obj = YAML.parse(data)
+    } else if (fileName.endsWith('.json')) {
+      // If the file is a JSON file, parse it
+      obj = JSON.parse(data)
+      // automatically convert all json to yaml
+      writeYAMLFile(fileName.replace(".json",".yaml"), obj)
+    }
   } catch (error) {
-    console.info(`Error reading File: ${fileName}`)
-    return data
+    console.info(`Error reading File: ${fileName}`, error)
   }
+  return obj
 }
 
 /**
@@ -22,6 +34,15 @@ export function writeJSONFile (fileName, jsonObj) {
   writeFileSync(fileName, data)
 }
 
+/**
+ * Write a JSON File
+ */
+export function writeYAMLFile (fileName, jsonObj) {
+  const data = YAML.stringify(jsonObj)
+  writeFileSync(fileName, data)
+}
+
+
 /**
  * Calculate the delta of a value within a range between min and max with overflow
  * @param {*} data 

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,19 +21,13 @@ export class OPCUAIf extends BaseIf {
     #connected
     #endpointurl
     #publishingInterval
+    #samplingInterval
     monitoreditems
     types
     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.
@@ -67,6 +48,12 @@ export class OPCUAIf extends BaseIf {
                 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 = {}
@@ -89,7 +76,11 @@ export class OPCUAIf extends BaseIf {
                     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)
+                        if (monitoredItemId === undefined) {
+                            this.LogError(`OPCUAIf: Error subscribing to node ${formattedNodeId}\n`)
+                            continue
+                        }
+                        console.log("OPCUAIf: Subscribe to",monitoredItemId,formattedNodeId)
                         this.buttons[monitoredItemId] = i
                     }
                     await this.monitorStates(elem, options)
@@ -101,7 +92,7 @@ export class OPCUAIf extends BaseIf {
     }
 
     /**
-     * 
+     * Monitor the state OPC/UA node of the given element 
      * @param {*} elem : Elem Object
      * @param {*} options 
      */
@@ -113,7 +104,11 @@ export class OPCUAIf extends BaseIf {
             if (state.opcua) {
                 let formattedNodeId = this.formatString(state.opcua, options)
                 let monitoredItemId = await this.Subscribe(formattedNodeId)
-                console.log("Subscribe to",monitoredItemId,formattedNodeId)
+                if (monitoredItemId === undefined) {
+                    this.LogError(`OPCUAIf: Error subscribing State to node ${formattedNodeId}\n`)
+                    continue
+                }
+                console.log("OPCUAIf: Subscribe to",monitoredItemId,formattedNodeId)
                 this.buttons[monitoredItemId] = i
             }
         }
@@ -164,6 +159,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 +173,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,6 +213,21 @@ 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)
@@ -220,6 +237,10 @@ export class OPCUAIf extends BaseIf {
             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){
@@ -267,9 +288,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,16 +320,22 @@ 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
     }
 
+    /**
+     * 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(nodeID) {
         // install monitored item
-
         const keys = Object.keys(this.monitoreditems)
         for (let i = 0; i < keys.length; i++) {
             const key = keys[i]
@@ -324,7 +351,7 @@ export class OPCUAIf extends BaseIf {
             attributeId: AttributeIds.Value
         };
         const monitoringParameters = {
-            samplingInterval: 100,
+            samplingInterval: this.#samplingInterval,
             discardOldest: true,
             queueSize: 10
         };
@@ -390,12 +417,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.1",
   "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,185 @@
+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=1;s={simnbr}.Function1
+  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

package/profile-2.yaml

@@ -0,0 +1,210 @@
+name: profile-1
+profile: example
+description: ""
+touch:
+  center:
+    "0":
+      default: one
+      states:
+        off:
+          color: "#000099"
+          cmd: echo "{id} {state}"
+        one:
+          color: "#00ff00"
+          image: numbers/one_9278045.png
+          cmd: echo "{id} {state}"
+        two:
+          color: "#00ff00"
+          image: numbers/two_9278103.png
+          cmd: echo "{id} {state}"
+        three:
+          color: "#00ff00"
+          image: numbers/three_9278150.png
+          cmd: echo "{id} {state}"
+        four:
+          color: "#00ff00"
+          image: numbers/four_9278183.png
+          cmd: echo "{id} {state}"
+        five:
+          color: "#00ff00"
+          image: numbers/five_9278222.png
+          cmd: echo "{id} {state}"
+    "1":
+      default: two
+      states:
+        off:
+          color: "#000099"
+          cmd: echo "{id} {state}"
+        one:
+          color: "#00ff00"
+          image: numbers/one_9278045.png
+          cmd: echo "{id} {state}"
+        two:
+          color: "#00ff00"
+          image: numbers/two_9278103.png
+          cmd: echo "{id} {state}"
+        three:
+          color: "#00ff00"
+          image: numbers/three_9278150.png
+          cmd: echo "{id} {state}"
+        four:
+          color: "#00ff00"
+          image: numbers/four_9278183.png
+          cmd: echo "{id} {state}"
+        five:
+          color: "#00ff00"
+          image: numbers/five_9278222.png
+          cmd: echo "{id} {state}"
+    "2":
+      default: three
+      states:
+        off:
+          color: "#000099"
+          cmd: echo "{id} {state}"
+        one:
+          color: "#00ff00"
+          image: numbers/one_9278045.png
+          cmd: echo "{id} {state}"
+        two:
+          color: "#00ff00"
+          image: numbers/two_9278103.png
+          cmd: echo "{id} {state}"
+        three:
+          color: "#00ff00"
+          image: numbers/three_9278150.png
+          cmd: echo "{id} {state}"
+        four:
+          color: "#00ff00"
+          image: numbers/four_9278183.png
+          cmd: echo "{id} {state}"
+        five:
+          color: "#00ff00"
+          image: numbers/five_9278222.png
+          cmd: echo "{id} {state}"
+    "3":
+      default: four
+      states:
+        off:
+          color: "#000099"
+          cmd: echo "{id} {state}"
+        one:
+          color: "#00ff00"
+          image: numbers/one_9278045.png
+          cmd: echo "{id} {state}"
+        two:
+          color: "#00ff00"
+          image: numbers/two_9278103.png
+          cmd: echo "{id} {state}"
+        three:
+          color: "#00ff00"
+          image: numbers/three_9278150.png
+          cmd: echo "{id} {state}"
+        four:
+          color: "#00ff00"
+          image: numbers/four_9278183.png
+          cmd: echo "{id} {state}"
+        five:
+          color: "#00ff00"
+          image: numbers/five_9278222.png
+          cmd: echo "{id} {state}"
+    "4":
+      default: five
+      states:
+        off:
+          color: "#000099"
+          cmd: echo "{id} {state}"
+        one:
+          color: "#00ff00"
+          image: numbers/one_9278045.png
+          cmd: echo "{id} {state}"
+        two:
+          color: "#00ff00"
+          image: numbers/two_9278103.png
+          cmd: echo "{id} {state}"
+        three:
+          color: "#00ff00"
+          image: numbers/three_9278150.png
+          cmd: echo "{id} {state}"
+        four:
+          color: "#00ff00"
+          image: numbers/four_9278183.png
+          cmd: echo "{id} {state}"
+        five:
+          color: "#00ff00"
+          image: numbers/five_9278222.png
+          cmd: echo "{id} {state}"
+    "5":
+      states:
+        off:
+          color: "#000099"
+          cmd: echo "{id} {state}"
+        one:
+          color: "#00ff00"
+          image: numbers/one_9278045.png
+          cmd: echo "{id} {state}"
+        two:
+          color: "#00ff00"
+          image: numbers/two_9278103.png
+          cmd: echo "{id} {state}"
+        three:
+          color: "#00ff00"
+          image: numbers/three_9278150.png
+          cmd: echo "{id} {state}"
+        four:
+          color: "#00ff00"
+          image: numbers/four_9278183.png
+          cmd: echo "{id} {state}"
+        five:
+          color: "#00ff00"
+          image: numbers/five_9278222.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}"
+    group: ""
+  knobCL:
+    states:
+      on:
+        cmd: echo "{id} {state}"
+    group: ""
+  knobBL:
+    states:
+      on:
+        cmd: echo "{id} {state}"
+        opcua: ns=2;s=Is{simnbr}.Audio.in.VolumeAccustic
+    group: ""
+  knobTR:
+    states:
+      on:
+        cmd: echo "{id} {state}"
+    group: ""
+  knobCR:
+    states:
+      on:
+        cmd: echo "{id} {state}"
+    group: ""
+  knobBR:
+    states:
+      on:
+        cmd: echo "{id} {state}"
+    group: ""
+parameters:
+  hostname: 127.0.0.1
+  simnbr: "1"
+  endpointurl: opc.tcp://{hostname}:4840
+  nodeid: ns=0;s=nodeID
+  verbose: true