loupedeck-commander 1.4.1 → 1.4.2

package/common/BaseLoupeDeckHandler.mjs

@@ -1,381 +1,393 @@
-import {discover, HAPTIC,LoupedeckDevice } from 'loupedeck'
-import { ApplicationConfig } from './ApplicationConfig.mjs'
-import { ButtonField } from './ButtonField.mjs'
-
-import { InitializeInterfaces, StopInterfaces, opcuainterface, profileEmitter } from '../interfaces/interfaces.mjs'
-
-export class BaseLoupeDeckHandler {
-  device = undefined
-  appConfig = undefined
-  profileConfigs = []
-  currentProfile = 0
-  brightness = 1
-  screens = {}
-  buttons = {}
-  knobs = {}
-  screenUpdate = {}
-  stopping = false
-  IntervalID = undefined
-
-  constructor (config) {
-    console.log(`INIT with config ${config}`)
-    let result = this.loadConfig(config)
-    if (!result){
-      process.exit(-1)
-    }
-  }
-
-  /**
-   * event handler - start
-   */
-  async start () {
-    console.info('Start')
-    while (!this.device && !this.stopping) {
-      try {
-        var list = await LoupedeckDevice.list()
-        if (list.length>0){
-          var element = list[0]
-          console.log("Connecting to device")
-          console.log("Path:         ", element.path)
-          console.log("vendorId:     ", element.vendorId, element.productId)
-          console.log("serialNumber: ", element.serialNumber)
-        }
-
-        this.device = await discover()
-        
-        
-        
-      } catch (e) {
-        console.error(`${e}. Reattempting in 3 seconds...`)
-        await new Promise(resolve => setTimeout(resolve, 3000))
-      }
-
-      if (this.stopping){
-        return
-      }
-    }
-    console.info(`✅ Discovered Device ${this.device.type}`)
-
-    const self = this
-
-    this.device.on('connect', (address) => { self.onConnected(address) })
-    this.device.on('down', (event) => { self.onButtonDown(event) })
-    this.device.on('up', (event) => { self.onButtonUp(event) })
-    this.device.on('rotate', (event) => { self.onRotate(event) })
-    this.device.on('touchstart', (event) => { self.onTouchStart(event) })
-    this.device.on('touchmove', (event) => { self.onTouchMove(event) })
-    this.device.on('touchend', (event) => { self.onTouchEnd(event) })
-    this.device.on('disconnect', (event) => { self.disconnectDevice(event) })
-
-    console.info(`✅ Registered callbacks`)
-  }
-
-  /**
-   * event handler - loupedeck device disconnected
-   */
-  async disconnectDevice (event) {
-    console.info("Device Disconnected")
-    this.device=undefined
-  }
-
-  /**
-   * stop handler - close the dipslay-connection and also stop all interface handlers
-   */
-  async stop () {
-    console.info('Stopping Handler')
-
-    try {
-      console.info(`Closing Device`)
-      this.stopping = true
-
-      clearInterval(this.IntervalID)
-
-/*      if (this.device){
-        this.device.vibrate(HAPTIC.DESCEND_MED)
-        await new Promise(resolve => setTimeout(resolve, 250))
-      }
-*/
-        this.changeBrightness(0)
-        await new Promise(resolve => setTimeout(resolve, 250))
-      if (this.device){
-        this.device.reconnectInterval = 0
-        await this.device.close()
-        await new Promise(resolve => setTimeout(resolve, 2000))
-        console.info(`Device Closed`)      
-      }
-      console.info(`Stopping interfaces`)
-      await StopInterfaces()
-      await new Promise(resolve => setTimeout(resolve, 1000))
-
-    } catch (e) {
-      console.info(`e`,e)      
-
-    }
-
-    process.exit()
-
-  }
-
-  /**
-   * load Application config file from JSON
-   * @param filename
-   */
-  loadConfig (fileName) {
-    console.info(`Loading Config File ${fileName}`)
-    this.appConfig = new ApplicationConfig()
-    return this.appConfig.loadFromFile(fileName)
-  }
-
-  vibrate (pattern) {
-    console.info(`Vibrate with pattern ${pattern}`)
-    if (this.device) {
-      this.device.vibrate(pattern)
-    } else {
-      console.warn("No Device connected, cannot vibrate")
-    }
-  }
-
-  changeBrightness (brightness) {
-    console.info(`Change Brightness to ${brightness}`)
-    this.brightness = brightness
-    if (this.device) {
-      this.device.setBrightness(brightness)
-    } else {
-      console.warn("No Device connected, cannot change brightness")
-    }
-  }
-
-  /**
-   * activate the profile with the givven ID
-   */
-  async activateProfile (id) {
-    // todo Profile-change implementation
-    id = Number(id)
-    var oldProfile = this.currentProfile
-    if (this.appConfig.profiles.length > id) {
-      this.currentProfile = id
-    }else{
-      return
-    }
-    const profile = this.getCurrentProfile()
-    console.info("ACTIVATE PROFILE",id,profile.name)
-    const dLeft = this.device.displays.left
-    const dRight = this.device.displays.right
-    const dCenter = this.device.displays.center
-
-    this.screens.center = undefined
-    this.screens.left = undefined
-    this.screens.right = undefined
-    this.buttons = undefined
-    this.knobs = undefined
-
-    
-    this.screens.center = new ButtonField('center', this.device.rows, this.device.columns, dCenter.width, dCenter.height, profile.touch.center,profile)
-    this.screens.left = new ButtonField('left', 1, 1, dLeft.width, dLeft.height, profile.touch.left,profile)
-    this.screens.right = new ButtonField('right', 1, 1, dRight.width, dRight.height, profile.touch.right,profile)
-
-    // knobs are only available in the CT-version:
-    if (this.device.knobs) {
-      this.knobs = new ButtonField('knob', 1, 1, 0, 0, profile.knobs,profile)
-    }
-    if (this.device.buttons) {
-      this.buttons = new ButtonField('buttons', 1, 1, 0, 0, profile.buttons,profile)
-    }
-    await this.screens.center.load()
-    await this.screens.right.load()
-    await this.screens.left.load()
-    await this.buttons.load()
-    await this.knobs.load()
-
-    // Force a screen Update on all screens:
-    this.screenUpdate["center"] = true
-    this.screenUpdate["left"] = true
-    this.screenUpdate["right"] = true
-    //await this.updateScreens()
-        
-    await this.buttons.draw(this.device)
-    // Initialize the Interfaces
-    await InitializeInterfaces(profile)
-    
-  }
-
-  /**
-   * get the dictionary iwth the current profile settings
-   */
-  getCurrentProfile () {
-    return this.appConfig.profiles[this.currentProfile]
-  }
-
-  /**
-   * Triggered, when LoupeDeck Device is connected
-   * - Initialize the profile from config-file and 
-   * - start the interface handlers accordingly
-   */
-  async onConnected (address) {
-    console.info(`✅ Connected to ${this.device.type}, ${address}`)
-    
-    await this.activateProfile(0)
-
-    const self = this
-
-    // Register callback on monitored item change:
-    opcuainterface.on("monitored item changed",(buttonID,attribute,nodeid,val) => { self.buttonStateChanged(buttonID,attribute,nodeid,val) })
-    profileEmitter.on("profileChanged",(profileID) => { self.activateProfile(profileID) })
-    profileEmitter.on("brightnessChanged",(brightness) => { self.changeBrightness(brightness) })
-    profileEmitter.on("vibrate",(pattern) => { self.vibrate(pattern) })
-    
-    
-
-    this.changeBrightness(1)
-    this.vibrate(HAPTIC.ASCEND_MED)
-    
-    // Fore update of all screens
-    console.info('✅ Force Screen update')
-    this.screenUpdate["center"] = true
-    this.screenUpdate["left"] = true
-    this.screenUpdate["right"] = true
-    //await this.updateScreens()
-
-    this.IntervalID = setInterval(() => {
-      // runs every 500ms seconds
-      this.screenUpdate["center"] = true
-      self.updateScreens()
-    }, 500);
-    
-
-    console.info('✅ Done initializing')
-  }
-
-  /**
-   * Fore an update of all screens
-   */
-  async updateScreens () {
-    const keys = Object.keys(this.screenUpdate)
-    for (let i = 0; i < keys.length; i++) {
-      const screen = keys[i]
-      //ok = await this.screens.center.updateAllButtons()
-      await this.screens[screen].draw(this.device)
-    }
-    this.screenUpdate = {}
-  }
-
-  /**
-   * Button Down Handler - triggered through Event Button Down - connected to LoupeDeck Event
-   */
-  async onButtonDown (event) {
-    let ok = false
-    const id = event.id
-    if (Number.isInteger(id)){
-      ok = await this.buttons.pressed(id)
-      //await this.buttons.draw(this.device)
-    }else{
-      ok = await this.knobs.pressed(id)
-    }
-    return ok
-  }
-
-  /**
-   * Button Up Handler - triggered through Event Button Up - connected to LoupeDeck Event
-   */
-  async onButtonUp (event) {
-    let ok = false
-    const id = event.id
-    if (Number.isInteger(id) && this.buttons){
-      ok = await this.buttons.released(id)
-      //await this.buttons.draw(this.device)  
-    }else{
-      if(this.knobs)
-        ok = await this.knobs.released(id)
-    }
-    return ok
-  }
-
-  /**
-   * Button Rotate Handler - triggered through Event Rotate available with knob-Buttons - connected to LoupeDeck Event
-   */
-  async onRotate (event) {
-    const id = event.id
-    const delta = event.delta
-    if (this.knobs)
-      return await this.knobs.rotated(id, delta)
-  }
-
-  /**
-   * TouchStart Handler - triggered through Event touch available on all touchbuttons on the loupedeck display - connected to LoupeDeck Event
-   */
-  async onTouchStart (event) {
-    let ok = false
-    const changedTouches = event.changedTouches
-    for (let i = 0; i < changedTouches.length; i++) {
-      const screen = changedTouches[i].target.screen
-      let id = changedTouches[i].target.key
-      this.screenUpdate[screen] = true
-      if (id === undefined) {
-        id = 0
-      }
-      if (this.screens[screen])
-        ok = await this.screens[screen].pressed(id)
-    }
-    //await this.updateScreens()
-    return ok
-  }
-
-  /**
-   * TouchMove Handler - triggered through Event touch available on all touchbuttons on the loupedeck display - connected to LoupeDeck Event
-   */
-  async onTouchMove (event) {
-    let ok = false
-    const changedTouches = event.changedTouches
-    for (let i = 0; i < changedTouches.length; i++) {
-      const x = changedTouches[i].x
-      const y = changedTouches[i].y
-      const screen = changedTouches[i].target.screen
-      let id = changedTouches[i].target.key
-      if (id === undefined) {
-        id = 0 // for left/right
-      }
-      if (this.screens[screen])
-        ok = await this.screens[screen].touchmove(id, x, y)
-    }
-    return ok
-  }
-
-  /**
-   * TouchEnd Handler - triggered through Event touch available on all touchbuttons on the loupedeck display - connected to LoupeDeck Event
-   */
-  async onTouchEnd (event) {
-    let ok = false
-    const changedTouches = event.changedTouches
-    for (let i = 0; i < changedTouches.length; i++) {
-      const elem = changedTouches[i].target
-      let id = changedTouches[i].target.key
-      if (id === undefined) {
-        id = 0
-      }
-      this.screenUpdate[elem.screen] = true
-
-      if (this.screens[elem.screen])
-        ok = await this.screens[elem.screen].released(id)
-    }
-    //await this.updateScreens()
-    return ok
-  }
-
-  /**
-   * Handler for StateChanged through OPC/UA Interface - only connected with touch-buttons on center field (yet)
-   */
-  async buttonStateChanged(buttonID,attribute,nodeid,val) {
-    let ok = false
-    this.screenUpdate["center"] = true
-    this.screenUpdate["left"] = true
-    this.screenUpdate["right"] = true
-
-    ok = await this.screens.center.buttonStateChanged(buttonID,attribute,nodeid,val)
-    ok = await this.knobs.buttonStateChanged(buttonID,attribute,nodeid,val)
-    
-    //await this.updateScreens()
-    return ok
-  }
-
-  
-}
+import {discover, HAPTIC,LoupedeckDevice } from 'loupedeck'
+import { ApplicationConfig } from './ApplicationConfig.mjs'
+import { ButtonField } from './ButtonField.mjs'
+
+import { InitializeInterfaces, StopInterfaces, opcuainterface, profileEmitter } from '../interfaces/interfaces.mjs'
+
+export class BaseLoupeDeckHandler {
+  device = undefined
+  appConfig = undefined
+  profileConfigs = []
+  currentProfile = 0
+  brightness = 1
+  screens = {}
+  buttons = {}
+  knobs = {}
+  screenUpdate = {}
+  stopping = false
+  IntervalID = undefined
+
+  constructor (config) {
+    console.log(`INIT with config ${config}`)
+    let result = this.loadConfig(config)
+    if (!result){
+      process.exit(-1)
+    }
+  }
+
+  /**
+   * event handler - start
+   */
+  async start () {
+    console.info('Start')
+    while (!this.device && !this.stopping) {
+      try {
+        var list = await LoupedeckDevice.list()
+        if (list.length>0){
+          var element = list[0]
+          console.log("Connecting to device")
+          console.log("Path:         ", element.path)
+          console.log("vendorId:     ", element.vendorId, element.productId)
+          console.log("serialNumber: ", element.serialNumber)
+        }
+
+        this.device = await discover()
+        
+        
+        
+      } catch (e) {
+        console.error(`${e}. Reattempting in 3 seconds...`)
+        await new Promise(resolve => setTimeout(resolve, 3000))
+      }
+
+      if (this.stopping){
+        return
+      }
+    }
+    console.info(`✅ Discovered Device ${this.device.type}`)
+
+    const self = this
+
+    this.device.on('connect', (address) => { self.onConnected(address) })
+    this.device.on('down', (event) => { self.onButtonDown(event) })
+    this.device.on('up', (event) => { self.onButtonUp(event) })
+    this.device.on('rotate', (event) => { self.onRotate(event) })
+    this.device.on('touchstart', (event) => { self.onTouchStart(event) })
+    this.device.on('touchmove', (event) => { self.onTouchMove(event) })
+    this.device.on('touchend', (event) => { self.onTouchEnd(event) })
+    this.device.on('disconnect', (event) => { self.disconnectDevice(event) })
+
+    console.info(`✅ Registered callbacks`)
+  }
+
+  /**
+   * event handler - loupedeck device disconnected
+   */
+  async disconnectDevice (event) {
+    console.info("Device Disconnected")
+    this.device=undefined
+  }
+
+  /**
+   * stop handler - close the dipslay-connection and also stop all interface handlers
+   */
+  async stop () {
+    console.info('Stopping Handler')
+
+    try {
+      console.info(`Closing Device`)
+      this.stopping = true
+
+      clearInterval(this.IntervalID)
+
+/*      if (this.device){
+        this.device.vibrate(HAPTIC.DESCEND_MED)
+        await new Promise(resolve => setTimeout(resolve, 250))
+      }
+*/
+        this.changeBrightness(0)
+        await new Promise(resolve => setTimeout(resolve, 250))
+      if (this.device){
+        this.device.reconnectInterval = 0
+        await this.device.close()
+        await new Promise(resolve => setTimeout(resolve, 2000))
+        console.info(`Device Closed`)      
+      }
+      console.info(`Stopping interfaces`)
+      await StopInterfaces()
+      await new Promise(resolve => setTimeout(resolve, 1000))
+
+    } catch (e) {
+      console.info(`e`,e)      
+
+    }
+
+    process.exit()
+
+  }
+
+  /**
+   * load Application config file from JSON
+   * @param filename
+   */
+  loadConfig (fileName) {
+    console.info(`Loading Config File ${fileName}`)
+    this.appConfig = new ApplicationConfig()
+    return this.appConfig.loadFromFile(fileName)
+  }
+
+  vibrate (pattern) {
+    console.info(`Vibrate with pattern ${pattern}`)
+    if (this.device) {
+      this.device.vibrate(pattern)
+    } else {
+      console.warn("No Device connected, cannot vibrate")
+    }
+  }
+
+  changeBrightness (brightness) {
+    console.info(`Change Brightness to ${brightness}`)
+    this.brightness = brightness
+    if (this.device) {
+      this.device.setBrightness(brightness)
+    } else {
+      console.warn("No Device connected, cannot change brightness")
+    }
+  }
+
+  /**
+   * activate the profile with the givven ID
+   */
+  async activateProfile (id) {
+    // todo Profile-change implementation
+    id = Number(id)
+    var oldProfile = this.currentProfile
+    if (this.appConfig.profiles.length > id) {
+      this.currentProfile = id
+    }else{
+      return
+    }
+    const profile = this.getCurrentProfile()
+    console.info("ACTIVATE PROFILE",id,profile.name)
+    const dLeft = this.device.displays.left
+    const dRight = this.device.displays.right
+    const dCenter = this.device.displays.center
+
+    this.screens.center = undefined
+    this.screens.left = undefined
+    this.screens.right = undefined
+    this.buttons = undefined
+    this.knobs = undefined
+
+    if (dCenter){
+      this.screens.center = new ButtonField('center', this.device.rows, this.device.columns, dCenter.width, dCenter.height, profile.touch.center,profile)
+      await this.screens.center.load()
+      this.screenUpdate["center"] = true
+    }
+    
+    if (dLeft){
+      this.screens.left = new ButtonField('left', 1, 1, dLeft.width, dLeft.height, profile.touch.left,profile)
+      await this.screens.left.load()
+      this.screenUpdate["left"] = true
+    }
+
+    if (dRight){
+      this.screens.right = new ButtonField('right', 1, 1, dRight.width, dRight.height, profile.touch.right,profile)
+      await this.screens.right.load()
+      this.screenUpdate["right"] = true
+    }
+
+    // knobs are only available in the CT-version:
+    if (this.device.knobs) {
+      this.knobs = new ButtonField('knob', 1, 1, 0, 0, profile.knobs,profile)
+      await this.knobs.load()
+    }
+    if (this.device.buttons) {
+      this.buttons = new ButtonField('buttons', 1, 1, 0, 0, profile.buttons,profile)
+      await this.buttons.load()
+    }
+
+    //await this.updateScreens()
+        
+    await this.buttons.draw(this.device)
+    // Initialize the Interfaces
+    await InitializeInterfaces(profile)
+    
+  }
+
+  /**
+   * get the dictionary iwth the current profile settings
+   */
+  getCurrentProfile () {
+    return this.appConfig.profiles[this.currentProfile]
+  }
+
+  /**
+   * Triggered, when LoupeDeck Device is connected
+   * - Initialize the profile from config-file and 
+   * - start the interface handlers accordingly
+   */
+  async onConnected (address) {
+    console.info(`✅ Connected to ${this.device.type}, ${address}`)
+    
+    await this.activateProfile(0)
+
+    const self = this
+
+    // Register callback on monitored item change:
+    opcuainterface.on("monitored item changed",(buttonID,attribute,nodeid,val) => { self.buttonStateChanged(buttonID,attribute,nodeid,val) })
+    profileEmitter.on("profileChanged",(profileID) => { self.activateProfile(profileID) })
+    profileEmitter.on("brightnessChanged",(brightness) => { self.changeBrightness(brightness) })
+    profileEmitter.on("vibrate",(pattern) => { self.vibrate(pattern) })
+    
+    
+
+    this.changeBrightness(1)
+    this.vibrate(HAPTIC.ASCEND_MED)
+    
+    // Fore update of all screens
+    console.info('✅ Force Screen update')
+
+    if (this.device.displays.center)
+      this.screenUpdate["center"] = true
+    if (this.device.displays.left)
+      this.screenUpdate["left"] = true
+    if (this.device.displays.right)
+      this.screenUpdate["right"] = true
+    //await this.updateScreens()
+
+    this.IntervalID = setInterval(() => {
+      // runs every 500ms seconds
+      if (this.device.displays.center)
+        this.screenUpdate["center"] = true
+      self.updateScreens()
+    }, 500);
+    
+
+    console.info('✅ Done initializing')
+  }
+
+  /**
+   * Fore an update of all screens
+   */
+  async updateScreens () {
+    const keys = Object.keys(this.screenUpdate)
+    for (let i = 0; i < keys.length; i++) {
+      const screen = keys[i]
+      //ok = await this.screens.center.updateAllButtons()
+      if (this.screens[screen])
+        await this.screens[screen].draw(this.device)
+    }
+    this.screenUpdate = {}
+  }
+
+  /**
+   * Button Down Handler - triggered through Event Button Down - connected to LoupeDeck Event
+   */
+  async onButtonDown (event) {
+    let ok = false
+    const id = event.id
+    if (Number.isInteger(id)){
+      ok = await this.buttons.pressed(id)
+      //await this.buttons.draw(this.device)
+    }else{
+      ok = await this.knobs.pressed(id)
+    }
+    return ok
+  }
+
+  /**
+   * Button Up Handler - triggered through Event Button Up - connected to LoupeDeck Event
+   */
+  async onButtonUp (event) {
+    let ok = false
+    const id = event.id
+    if (Number.isInteger(id) && this.buttons){
+      ok = await this.buttons.released(id)
+      //await this.buttons.draw(this.device)  
+    }else{
+      if(this.knobs)
+        ok = await this.knobs.released(id)
+    }
+    return ok
+  }
+
+  /**
+   * Button Rotate Handler - triggered through Event Rotate available with knob-Buttons - connected to LoupeDeck Event
+   */
+  async onRotate (event) {
+    const id = event.id
+    const delta = event.delta
+    if (this.knobs)
+      return await this.knobs.rotated(id, delta)
+  }
+
+  /**
+   * TouchStart Handler - triggered through Event touch available on all touchbuttons on the loupedeck display - connected to LoupeDeck Event
+   */
+  async onTouchStart (event) {
+    let ok = false
+    const changedTouches = event.changedTouches
+    for (let i = 0; i < changedTouches.length; i++) {
+      const screen = changedTouches[i].target.screen
+      let id = changedTouches[i].target.key
+      this.screenUpdate[screen] = true
+      if (id === undefined) {
+        id = 0
+      }
+      if (this.screens[screen])
+        ok = await this.screens[screen].pressed(id)
+    }
+    //await this.updateScreens()
+    return ok
+  }
+
+  /**
+   * TouchMove Handler - triggered through Event touch available on all touchbuttons on the loupedeck display - connected to LoupeDeck Event
+   */
+  async onTouchMove (event) {
+    let ok = false
+    const changedTouches = event.changedTouches
+    for (let i = 0; i < changedTouches.length; i++) {
+      const x = changedTouches[i].x
+      const y = changedTouches[i].y
+      const screen = changedTouches[i].target.screen
+      let id = changedTouches[i].target.key
+      if (id === undefined) {
+        id = 0 // for left/right
+      }
+      if (this.screens[screen])
+        ok = await this.screens[screen].touchmove(id, x, y)
+    }
+    return ok
+  }
+
+  /**
+   * TouchEnd Handler - triggered through Event touch available on all touchbuttons on the loupedeck display - connected to LoupeDeck Event
+   */
+  async onTouchEnd (event) {
+    let ok = false
+    const changedTouches = event.changedTouches
+    for (let i = 0; i < changedTouches.length; i++) {
+      const elem = changedTouches[i].target
+      let id = changedTouches[i].target.key
+      if (id === undefined) {
+        id = 0
+      }
+      this.screenUpdate[elem.screen] = true
+
+      if (this.screens[elem.screen])
+        ok = await this.screens[elem.screen].released(id)
+    }
+    //await this.updateScreens()
+    return ok
+  }
+
+  /**
+   * Handler for StateChanged through OPC/UA Interface - only connected with touch-buttons on center field (yet)
+   */
+  async buttonStateChanged(buttonID,attribute,nodeid,val) {
+    let ok = false
+    this.screenUpdate["center"] = true
+    this.screenUpdate["left"] = true
+    this.screenUpdate["right"] = true
+
+    ok = await this.screens.center.buttonStateChanged(buttonID,attribute,nodeid,val)
+    ok = await this.knobs.buttonStateChanged(buttonID,attribute,nodeid,val)
+    
+    //await this.updateScreens()
+    return ok
+  }
+
+  
+}