homebridge-deconz 0.0.9 → 0.0.12

package/README.md

@@ -19,8 +19,7 @@ Copyright © 2022 Erik Baauw. All rights reserved.
 ### Work in Progress
 See [Future Development of Homebridge Hue](https://github.com/ebaauw/homebridge-hue/issues/1070) for positioning Homebridge deCONZ versus Homebridge Hue.
 
-The current pre-release of Homebridge deCONZ is not yet functional.
-I'm using it to stress-test the technical framework.
+Homebridge deCONZ is still under development.
 See [Releases](https://github.com/ebaauw/homebridge-deconz/releases) for more details.
 
 If you have a question, please post a message to the **#hue** channel of the Homebridge community on [Discord](https://discord.gg/hZubhrz).
@@ -60,13 +59,13 @@ See the [Wiki](https://github.com/ebaauw/homebridge-deconz/wiki/Configuration) f
 Homebridge deCONZ exposes a [gateway accessory](https://github.com/ebaauw/homebridge-deconz/wiki/Gateway-Accessory) for each deCONZ gateway.
 In Apple's Home app, this accessory looks like a wireless switch; you'll need another HomeKit app to configure the accessory.
 
-When when it connects to a deCONZ gateway for the first time, Homebridge deCONZ will try to obtain an API key for two minutes, before exposing the gateway accessory.
+When it connects to a deCONZ gateway for the first time, Homebridge deCONZ will try to obtain an API key for two minutes, before exposing the gateway accessory.
 Unless Homebridge deCONZ runs on the same server as the deCONZ gateway, you need to unlock the gateway to allow Homebridge deCONZ to obtain an API key.
 After two minutes, Homebridge deCONZ will give up, exposing the gateway accessory anyways, but marking it inactive.
 Set _Expose_ on the _Gateway Settings_ service of the gateway accessory to retry obtaining an API key.
 Homebridge deCONZ will **not** retry to obtain an API key on Homebridge restart.
 
-After setting _Expose Lights_, _Expose Sensors_, or _Expose Groups_ on the _Gateway Settings_ service, Homebridge Deconz will expose a [device accessory](https://github.com/ebaauw/homebridge-deconz/wiki/Device-Accessory) for each of the corresponding devices.
+After setting _Expose Lights_, _Expose Sensors_, or _Expose Groups_ on the _Gateway Settings_ service, Homebridge deCONZ will expose a [device accessory](https://github.com/ebaauw/homebridge-deconz/wiki/Device-Accessory) for each of the corresponding devices.
 When clearing the characteristic, the corresponding device accessories are removed from HomeKit.  
 Each device accessory has a _Device Settings_ service, to configure the device.
 Clear _Expose_ on that service, to blacklist the device, and remove the associated accessory from HomeKit.  
@@ -77,8 +76,6 @@ Setting _Expose Lights_ will include the ZHAConsumption and ZHAPower `/sensors`
 Note that HomeKit doesn't like configuration changes.
 Allow ample time after exposing or removing accessories for HomeKit to sync the changed configuration to all Apple devices.
 
-Note that currently, each device accessory only carries a dummy _Stateless Programmable Switch_ service (to make it visible in Home).
-
 ### Command-Line Utility
 Homebridge deCONZ includes the `deconz` command-line utility, to discover,
 monitor, and interact with a deCONZ gateway.

package/cli/deconz.js

@@ -301,6 +301,18 @@ Usage: ${b('deconz')} ${usage.unlock}
 
 ${description.unlock}
 
+Parameters:
+  ${b('-h')}, ${b('--help')}
+  Print this help and exit.
+
+  ${b('-v')}, ${b('--verbose')}
+  Print full API output.`,
+  search: `${description.search}
+
+Usage: ${b('deconz')} ${usage.search}
+
+${description.search}
+
 Parameters:
   ${b('-h')}, ${b('--help')}
   Print this help and exit.

package/config.schema.json

@@ -2,6 +2,7 @@
   "pluginAlias": "deCONZ",
   "pluginType": "platform",
   "singular": true,
+  "customUi": true,
   "headerDisplay": "Homebridge plugin for deCONZ",
   "footerDisplay": "For a detailed description, see the [wiki](https://github.com/ebaauw/homebridge-deconz/wiki/Configuration).",
   "schema": {
@@ -69,7 +70,7 @@
         "maximum": 2000
       },
       "waitTimeUpdate": {
-        "description": "The time, in milliseconds, to wait for a change from HomeKit to another characteristic for the same light or group, before updating the deCONZ gateway.  Default: 20.",
+        "description": "The time, in milliseconds, to wait for a change from HomeKit to another characteristic for the same light or group, before updating the deCONZ gateway.  Default: 100.",
         "type": "integer",
         "minimum": 0,
         "maximum": 500

package/homebridge-ui/public/index.html

@@ -0,0 +1,26 @@
+<!--
+homebridge-deconz/homebridge-ui/public/index.html
+
+Homebridge plug-in for deCONZ.
+Copyright © 2022 Erik Baauw. All rights reserved.
+-->
+
+<link rel="stylesheet" href="style.css">
+
+<script>
+(async () => {
+  try {
+    homebridge.showSchemaForm()
+
+    // const pluginConfig = await homebridge.getPluginConfig()
+    // const pluginConfigSchema = await homebridge.getPluginConfigSchema()
+    const cachedAccessories = await homebridge.getCachedAccessories()
+
+    const result = await homebridge.request('/cachedAccessories', cachedAccessories)
+    const nGateways = Object.keys(result).length
+    homebridge.toast.success(`${nGateways} gateways`)
+  } catch (error) {
+    console.error(error)
+  }
+})()
+</script>

package/homebridge-ui/server.js

@@ -0,0 +1,43 @@
+// homebridge-deconz/homebridge-ui/server.js
+//
+// Homebridge plug-in for deCONZ.
+// Copyright © 2022 Erik Baauw. All rights reserved.
+
+'use strict'
+
+const {
+  HomebridgePluginUiServer, RequestError
+} = require('@homebridge/plugin-ui-utils')
+
+class UiServer extends HomebridgePluginUiServer {
+  constructor () {
+    super()
+
+    this.onRequest('/cachedAccessories', async (cachedAccessories) => {
+      try {
+        // console.log('%d accessories', cachedAccessories.length)
+        const gateways = cachedAccessories.filter((accessory) => {
+          return accessory.plugin === 'homebridge-deconz' &&
+            accessory.context != null &&
+            accessory.context.className === 'Gateway'
+        })
+        // console.log('%d gateways', gateways.length)
+        const result = {}
+        for (const gateway of gateways) {
+          const { host, apiKey } = gateway.context
+          if (apiKey != null) {
+            result[host] = apiKey
+          }
+        }
+        console.log('%d gateways: %j', Object.keys(result).length, result)
+        return result
+      } catch (error) {
+        throw new RequestError(error)
+      }
+    })
+
+    this.ready()
+  }
+}
+
+new UiServer() // eslint-disable-line no-new

package/lib/Deconz/ApiClient.js

@@ -9,7 +9,7 @@ const events = require('events')
 const homebridgeLib = require('homebridge-lib')
 const os = require('os')
 
-const Deconz = require('./index')
+const Deconz = require('../Deconz')
 
 // Estmate the number of Zigbee messages resulting from PUT body.
 function numberOfZigbeeMessages (body = {}) {
@@ -43,6 +43,29 @@ function numberOfZigbeeMessages (body = {}) {
   * @memberof Deconz
   */
 class ApiClient extends homebridgeLib.HttpClient {
+  /** Events reported through `buttonevent`.
+    * @type {Object<string, integer>}
+    */
+  static get buttonEvent () {
+    return {
+      PRESS: 0,
+      HOLD: 1,
+      SHORT_RELEASE: 2,
+      LONG_RELEASE: 3,
+      DOUBLE_PRESS: 4,
+      TRIPLE_PRESS: 5,
+      QUADRUPLE_PRESS: 6,
+      SHAKE: 7,
+      DROP: 8,
+      TILT: 9
+    }
+  }
+
+  /** Convert date as reported by deCONZ to human readable string.
+    * @param {string} date - The ISO-8601 date string.
+    * @param {boolean} [utc=true] - Treat date as UTC, even with missing `Z`.
+    * @param {string} date - The human readable date string.
+    */
   static dateToString (date, utc = true) {
     if (date == null || date === 'none') {
       return 'n/a'
@@ -53,6 +76,16 @@ class ApiClient extends homebridgeLib.HttpClient {
     return String(new Date(date)).slice(0, 24)
   }
 
+  /** Convert `lightlevel` to lux.
+    * @param {integer} lightLevel - The `lightlevel` as reported by deCONZ.
+    * @return {integer} lux - The value in lux.
+    */
+  static lightLevelToLux (v) {
+    let lux = v ? Math.pow(10, (v - 1) / 10000) : 0.0001
+    lux = Math.round(lux * 10000) / 10000
+    return Math.max(0.0001, Math.min(lux, 100000))
+  }
+
   /** Create a new instance of a Deconz.Client.
     *
     * The caller is expected to verify that the given host is a reachable

package/lib/Deconz/ApiResponse.js

@@ -7,7 +7,7 @@
 
 const homebridgeLib = require('homebridge-lib')
 
-const Deconz = require('./index')
+const Deconz = require('../Deconz')
 
 /** Deconz API response.
   * @hideconstructor

package/lib/Deconz/Device.js

@@ -92,13 +92,6 @@ class Device {
     this.resourceBySubtype[subtype] = resource
     const p = this.resourceBySubtype[this.primary]
     if (p.rtype === rtype && p.prio < prio) {
-      /** The key of the delegate for the primary resource for the device in
-        * {@link DeconzDevice#resourceBySubtype resourceBySubtype}
-        *
-        * This is the {@link DeconzDevice.Resource#subtype subtype} of the
-        * HomeKit service corresponding to the primary resource.
-        * @type {string}
-        */
       this.primary = resource.subtype
     }
   }