homebridge-velux 0.0.1 → 0.0.2

package/README.md

@@ -7,7 +7,7 @@
 [![Downloads](https://img.shields.io/npm/dt/homebridge-velux)](https://www.npmjs.com/package/homebridge-velux)
 [![Version](https://img.shields.io/npm/v/homebridge-velux)](https://www.npmjs.com/package/homebridge-velux)
 [![Homebridge Discord](https://img.shields.io/discord/432663330281226270?color=728ED5&logo=discord&label=discord)](https://discord.gg/bXmnUwXQR9)
-<!-- [![verified-by-homebridge](https://badgen.net/badge/homebridge/verified/purple)](https://github.com/homebridge/homebridge/wiki/Verified-Plugins) -->
+[![verified-by-homebridge](https://badgen.net/badge/homebridge/verified/purple)](https://github.com/homebridge/homebridge/wiki/Verified-Plugins)
 
 [![GitHub issues](https://img.shields.io/github/issues/ebaauw/homebridge-velux)](https://github.com/ebaauw/homebridge-velux/issues)
 [![GitHub pull requests](https://img.shields.io/github/issues-pr/ebaauw/homebridge-velux)](https://github.com/ebaauw/homebridge-velux/pulls)
@@ -30,7 +30,8 @@ It provides the following features:
 - Support for multiple KLF 200 gateways;
 - Includes `velux` command-line utility for troubleshooting.
 
-Homebridge Velux exposes an accessory for each connected device.
+Homebridge Velux exposes an accessory for each gateway and one for each connected device.
+The gateway accessory is used to control the polling rate and the log level.
 <!-- See the [Wiki](https://github.com/ebaauw/homebridge-velux/wiki/Velux-Accessory) for details. -->
 
 ### Prerequisites

package/config.schema.json

@@ -26,6 +26,18 @@
               "type": "string",
               "required": true
             },
+            "id": {
+              "title": "ID",
+              "description": "A unique ID for the gateway, preferably its MAC address.  Default: the hostname.",
+              "type": "string",
+              "required": true
+            },
+            "name": {
+              "title": "Name",
+              "description": "The name for the gateway.  Default: the hostname.",
+              "type": "string",
+              "required": false
+            },
             "password": {
               "title": "Password",
               "description": "The WiFi assword of the FLF 200 gateway.",

package/lib/{VeluxGateway.js → VeluxAccessory/Gateway.js}

@@ -1,30 +1,55 @@
-// homebridge-velux/lib/VeluxGateway.js
+// homebridge-velux/lib/VeluxAccessory/Gateway.js
 // Copyright © 2025 Erik Baauw. All rights reserved.
 //
 // Homebridge plugin for Velux Integra KLF 200 gateway.
 
 import { timeout, toHexString } from 'homebridge-lib'
-import { Delegate } from 'homebridge-lib/Delegate'
+import { AccessoryDelegate } from 'homebridge-lib/AccessoryDelegate'
 
 import { VeluxClient } from 'hb-velux-tools/VeluxClient'
 
-import { VeluxAccessory } from './VeluxAccessory.js'
+import { VeluxAccessory } from './index.js'
+import { VeluxService } from '../VeluxService/index.js'
+import '../VeluxService/Gateway.js'
 
-class VeluxGateway extends Delegate {
+class Gateway extends AccessoryDelegate {
   constructor (platform, params = {}) {
-    super(platform, params.name)
+    super(platform, params)
     this.nodeIdList = []
     this.accessories = {}
 
+    this.service = new VeluxService.Gateway(this, {
+      name: params.name
+    })
+    this.manageLogLevel(this.service.characteristicDelegate('logLevel'))
+
+    this.on('heartbeat', this.heartbeat)
+
     this.client = new VeluxClient({
       host: params.host,
       password: params.password,
       timeout: platform.config.timeout
     })
     this.client
-      .on('connect', (host) => { this.debug('connected to %s', host) })
-      .on('disconnect', (host) => { this.debug('disconnected from %s', host) })
+      .on('connecting', (host) => { this.log('connecting to %s...', host) })
+      .on('connect', (host) => { this.log('connected to %s', host) })
+      .on('disconnect', (host) => { this.log('disconnected from %s', host) })
       .on('error', (error) => {
+        if (error.request == null) {
+          this.error('error: %s', error)
+          return
+        }
+        if (error.request.params == null) {
+          this.log('request %d: %s', error.request.id, error.request.cmdName)
+        } else {
+          this.log(
+            'request %d: %s %j', error.request.id, error.request.cmdName,
+            error.request.params
+          )
+        }
+        this.warn('request %d: error: %s', error.request.id, error)
+      })
+      .on('warning', (error) => {
         if (error.request == null) {
           this.warn('error: %s', error)
           return
@@ -103,6 +128,7 @@ class VeluxGateway extends Delegate {
       this.log('connecting...')
       await this.client.connect()
       const { softwareVersion } = await this.client.request(VeluxClient.commands.GW_GET_VERSION_REQ)
+      this.values.firmware = softwareVersion
       const { api } = await this.client.request(VeluxClient.commands.GW_GET_PROTOCOL_VERSION_REQ)
       const nodes = {}
       let nodeList = await this.client.request(VeluxClient.commands.GW_CS_GET_SYSTEMTABLE_DATA_REQ)
@@ -127,6 +153,9 @@ class VeluxGateway extends Delegate {
         }
         switch (node.actuatorType) {
           case 0x0280:
+            if (VeluxAccessory.WindowCovering == null) {
+              await import('./WindowCovering.js')
+            }
             this.accessories[id] = new VeluxAccessory.WindowCovering(this, params)
             break
           default:
@@ -137,7 +166,7 @@ class VeluxGateway extends Delegate {
             continue
         }
       }
-      this.updateLogLevel()
+      this.heartbeatEnabled = true
       this.initialised = true
       this.debug('initialised')
       this.emit('initialised')
@@ -151,33 +180,24 @@ class VeluxGateway extends Delegate {
     }
   }
 
-  get logLevel () { return this._logLevel }
-
-  updateLogLevel () {
-    let logLevel = 0
-    for (const id in this.accessories) {
-      logLevel = Math.max(logLevel, this.accessories[id].logLevel)
-    }
-    this._logLevel = logLevel
-  }
-
   async heartbeat (beat) {
-    if (!this.initialised) {
-      return
-    }
-    if (!this.client.connected) {
-      if (beat % 60 !== 0) {
-        return
+    try {
+      if (!this.client.connected) {
+        if (beat % 60 !== 0) {
+          return
+        }
+        await this.client.connect()
       }
-      await this.client.connect()
-    }
-    if (beat % 600 === 0) {
-      await this.client.request(VeluxClient.commands.GW_HOUSE_STATUS_MONITOR_ENABLE_REQ)
-    }
-    if (beat % 10 === 0 && this.nodeIdList.length > 0) {
-      await this.client.request(VeluxClient.commands.GW_STATUS_REQUEST_REQ, {
-        nodeIds: this.nodeIdList
-      })
+      if (beat % 600 === 0) {
+        await this.client.request(VeluxClient.commands.GW_HOUSE_STATUS_MONITOR_ENABLE_REQ)
+      }
+      if (beat % this.service.values.heartrate === 0 && this.nodeIdList.length > 0) {
+        await this.client.request(VeluxClient.commands.GW_STATUS_REQUEST_REQ, {
+          nodeIds: this.nodeIdList
+        })
+      }
+    } catch (error) {
+      this.warn('heartbeat error %s', error)
     }
   }
 
@@ -186,4 +206,4 @@ class VeluxGateway extends Delegate {
   }
 }
 
-export { VeluxGateway }
+VeluxAccessory.Gateway = Gateway

package/lib/VeluxAccessory/WindowCovering.js

@@ -0,0 +1,20 @@
+// homebridge-velux/lib/VeluxAccessory/WindowCovering.js
+// Copyright © 2025 Erik Baauw. All rights reserved.
+//
+// Homebridge plugin for Velux Integra KLF 200 gateway.
+
+import { VeluxAccessory } from './index.js'
+import '../VeluxService/WindowCovering.js'
+
+class WindowCovering extends VeluxAccessory {
+  constructor (gateway, params = {}) {
+    params.ServiceName = 'WindowCovering'
+    super(gateway, params)
+
+    setImmediate(() => {
+      this.emit('initialised')
+    })
+  }
+}
+
+VeluxAccessory.WindowCovering = WindowCovering

package/lib/{VeluxAccessory.js → VeluxAccessory/index.js}

@@ -1,37 +1,29 @@
-// homebridge-velux/lib/VeluxAccessory.js
+// homebridge-velux/lib/VeluxAccessory/index.js
 // Copyright © 2025 Erik Baauw. All rights reserved.
 //
 // Homebridge plugin for Velux Integra KLF 200 gateway.
 
 import { AccessoryDelegate } from 'homebridge-lib/AccessoryDelegate'
+import { VeluxService } from '../VeluxService/index.js'
 
-import { VeluxService } from './VeluxService.js'
-
-class WindowCovering extends AccessoryDelegate {
-  constructor (gateway, params = {}) {
+class VeluxAccessory extends AccessoryDelegate {
+  constructor (gateway, params) {
     super(gateway.platform, params)
     this.gateway = gateway
     this.client = gateway.client
     this.log(
       '%s [%d]: %s %s [%s] at %d%%', params.name, params.payload.nodeId,
       params.manufacturer, params.model, params.payload.actuatorType,
-      params.payload.currentPosition
+      100 - params.payload.currentPosition
     )
-    this.service = new VeluxService.WindowCovering(this, params)
-    this.manageLogLevel(this.service.characteristicDelegate('logLevel'))
-
-    setImmediate(() => {
-      this.emit('initialised')
-    })
+    this.service = new VeluxService[params.ServiceName](this, params)
   }
 
+  get logLevel () { return this.gateway?.logLevel ?? 2 }
+
   update (payload) {
     this.service.update(payload)
   }
 }
 
-class VeluxAccessory {
-  static get WindowCovering () { return WindowCovering }
-}
-
 export { VeluxAccessory }

package/lib/VeluxPlatform.js

@@ -8,7 +8,8 @@
 import { OptionParser } from 'homebridge-lib/OptionParser'
 import { Platform } from 'homebridge-lib/Platform'
 
-import { VeluxGateway } from './VeluxGateway.js'
+import { VeluxAccessory } from './VeluxAccessory/index.js'
+import './VeluxAccessory/Gateway.js'
 
 class VeluxPlatform extends Platform {
   constructor (log, configJson, homebridge) {
@@ -19,7 +20,6 @@ class VeluxPlatform extends Platform {
 
     this
       .once('heartbeat', this.init)
-      .on('heartbeat', this.heartbeat)
       .on('shutdown', this.shutdown)
   }
 
@@ -49,7 +49,8 @@ class VeluxPlatform extends Platform {
         const optionParser = new OptionParser(config, true)
         optionParser
           .hostKey()
-          .stringKey('name')
+          .stringKey('id', true)
+          .stringKey('name', true)
           .stringKey('password')
           .on('userInputError', (error) => {
             this.warn('config.json: hosts[%d]: %s', i, error)
@@ -62,6 +63,7 @@ class VeluxPlatform extends Platform {
           validHosts.push({
             host: config.hostname + ':' + config.port,
             name: config.name ?? config.hostname,
+            id: config.id ?? config.hostname,
             password: config.password
           })
         } catch (error) {
@@ -80,7 +82,14 @@ class VeluxPlatform extends Platform {
 
     for (const host of this.config.hosts) {
       try {
-        const gateway = new VeluxGateway(this, host)
+        const gateway = new VeluxAccessory.Gateway(this, {
+          name: host.name,
+          id: host.id,
+          manufacturer: 'VELUX',
+          model: 'KLF 200',
+          host: host.host,
+          password: host.password
+        })
         jobs.push(gateway.init())
         this.gateways[host] = gateway
       } catch (error) {
@@ -94,14 +103,6 @@ class VeluxPlatform extends Platform {
     this.emit('initialised')
   }
 
-  async heartbeat (beat) {
-    try {
-      for (const id in this.gateways) {
-        this.gateways[id].heartbeat(beat)
-      }
-    } catch (error) { this.warn('heartbeat error %s', error) }
-  }
-
   async shutdown () {
     for (const id in this.gateways) {
       await this.gateways[id].shutdown()

package/lib/VeluxService/Gateway.js

@@ -0,0 +1,30 @@
+// homebridge-deconz/lib/VeluxService/Gateway.js
+// Copyright © 2025 Erik Baauw. All rights reserved.
+//
+// Homebridge plugin for Velux Integra KLF 200 gateway.
+
+import { VeluxService } from './index.js'
+
+class Gateway extends VeluxService {
+  constructor (accessory, params) {
+    params.Service = accessory.Services.my.DeconzGateway
+    super(accessory, params)
+    this.client = accessory.client
+
+    this.addCharacteristicDelegate({
+      key: 'heartrate',
+      Characteristic: this.Characteristics.my.Heartrate,
+      value: 30,
+      unit: 's',
+      props: { minValue: 0, maxValue: 120, minStep: 1 }
+    })
+
+    this.addCharacteristicDelegate({
+      key: 'logLevel',
+      Characteristic: this.Characteristics.my.LogLevel,
+      value: 2
+    })
+  }
+}
+
+VeluxService.Gateway = Gateway

package/lib/{VeluxService.js → VeluxService/WindowCovering.js}

@@ -1,15 +1,15 @@
-// homebridge-deconz/lib/VeluxService.js
+// homebridge-deconz/lib/VeluxService/WindowCovering.js
 // Copyright © 2025 Erik Baauw. All rights reserved.
 //
 // Homebridge plugin for Velux Integra KLF 200 gateway.
 
 import { timeout } from 'hb-lib-tools'
 
-import { ServiceDelegate } from 'homebridge-lib/ServiceDelegate'
-
 import { VeluxClient } from 'hb-velux-tools/VeluxClient'
 
-class WindowCovering extends ServiceDelegate {
+import { VeluxService } from '../VeluxService/index.js'
+
+class WindowCovering extends VeluxService {
   constructor (accessory, params) {
     params.Service = accessory.Services.hap.WindowCovering
     super(accessory, params)
@@ -86,16 +86,6 @@ class WindowCovering extends ServiceDelegate {
     })
     this.values.positionChange = 0
 
-    this.addCharacteristicDelegate({
-      key: 'logLevel',
-      Characteristic: this.Characteristics.my.LogLevel,
-      value: accessory.logLevel
-    }).on('didSet', (value, fromHomeKit) => {
-      if (fromHomeKit) {
-        accessory.gateway.updateLogLevel()
-      }
-    })
-
     this.update(params.payload)
   }
 
@@ -120,8 +110,4 @@ class WindowCovering extends ServiceDelegate {
   }
 }
 
-class VeluxService {
-  static get WindowCovering () { return WindowCovering }
-}
-
-export { VeluxService }
+VeluxService.WindowCovering = WindowCovering

package/lib/VeluxService/index.js

@@ -0,0 +1,10 @@
+// homebridge-velux/lib/VeluxService/index.js
+// Copyright © 2025 Erik Baauw. All rights reserved.
+//
+// Homebridge plugin for Velux Integra KLF 200 gateway.
+
+import { ServiceDelegate } from 'homebridge-lib/ServiceDelegate'
+
+class VeluxService extends ServiceDelegate {}
+
+export { VeluxService }

package/package.json

@@ -7,7 +7,7 @@
     "ebaauw"
   ],
   "license": "Apache-2.0",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "keywords": [
     "homebridge-plugin",
     "homekit",
@@ -27,8 +27,8 @@
     "klf200": "3.14"
   },
   "dependencies": {
-    "hb-velux-tools": "~0.0.2",
-    "homebridge-lib": "~7.1.2"
+    "hb-velux-tools": "~0.0.4",
+    "homebridge-lib": "~7.1.3"
   },
   "scripts": {
     "prepare": "standard",