homebridge-deconz 0.0.17 → 0.0.21

package/homebridge-ui/public/index.old.html

@@ -0,0 +1,506 @@
+<!--
+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">
+<p align="center">
+  <a href="https://github.com/ebaauw/homebridge-deconz/wiki/Configuration" target="_blank">
+    <img src="homebridge-deconz.png" height="200px">
+  </a>
+</p>
+
+<script>
+
+async function showFormPluginConfig () {
+  homebridge.showSpinner()
+  const pluginConfig = await homebridge.getPluginConfig()
+  console.log('pluginConfig: %o', pluginConfig)
+  // const pluginConfigSchema = await homebridge.getPluginConfigSchema()
+  // console.log('pluginConfigSchema: %o', pluginConfigSchema)
+  // const cachedAccessories = await homebridge.getCachedAccessories()
+  // console.log('cachedAccessories: %o', cachedAccessories)
+  // const discoveredGateways = await homebridge.request('discover')
+  // console.log('discovered gateways: %o', discoveredGateways)
+  for (const config of pluginConfig) {
+    if (config._bridge != null) {
+      const cachedAccessories = await homebridge.request('cachedAccessories', {
+        username: config._bridge.username
+      })
+      console.log('%s: cachedAccessories: %o', config.name, cachedAccessories)
+      const cachedGateways = cachedAccessories.filter((accessory) => {
+        return accessory.plugin === 'homebridge-deconz' &&
+          accessory.context != null &&
+          accessory.context.className === 'Gateway'
+      })
+      const result = {}
+      for (const gateway of cachedGateways) {
+        if (gateway.context.uiPort == null) {
+          continue
+        }
+        const pong = await homebridge.request(
+          'get', { uiPort: gateway.context.uiPort, path: '/ping' }
+        )
+        if (pong === 'pong') {
+          result[gateway.context.host] = gateway.context
+        }
+      }
+      const gateways = Object.keys(result).sort()
+      console.log('%s: gateways: %j',config.name, gateways)
+    }
+  }
+  homebridge.hideSpinner()
+
+  const form = homebridge.createForm(
+    {
+      schema: {
+        type: 'object',
+        properties: {
+          config: {
+            title: 'Gateways',
+            description: 'Configure a child bridge per deCONZ gateway.  See <a href="https://github.com/ebaauw/homebridge-deconz/wiki/Configuration" target="_blank">wiki</a> for details.',
+            type: 'array',
+            disabled: true,
+            items: {
+              type: 'object',
+              properties: {
+                host: {
+                  description: 'Gateway hostname and port.',
+                  default: 'localhost:80',
+                  type: 'string',
+                  required: true
+                },
+                name: {
+                  description: 'Homebridge log plugin name.',
+                  default: 'deCONZ',
+                  type: 'string'
+                },
+                _bridge: {
+                  type: 'object',
+                  required: true,
+                  properties: {
+                    name: {
+                      type: 'string',
+                      required: true
+                    },
+                    username: {
+                      type: 'string',
+                      pattern: '^([A-F0-9]{2}:){5}[A-F0-9]{2}$',
+                      placeholder: 'AA:BB:CC:DD:EE:FF',
+                      required: true
+                    },
+                    port: {
+                      type: 'integer',
+                      minimum: 1025,
+                      // maximum: 65535,
+                      required: true
+                    },
+                    manufacturer: {
+                      type: 'string',
+                      enabled: false,
+                      required: true
+                    },
+                    model: {
+                      type: 'string',
+                      required: true
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+      },
+      // layout: null
+      layout: [
+        {
+          type: 'tabarray',
+          title: '{{ value.name }}',
+          items: [
+            {
+              type: 'fieldset',
+              title: 'Gateway Settings',
+              key: 'config[]',
+              items: [
+                {
+                  type: 'flex',
+                  'flex-flow': 'row',
+                  items: [
+                    'config[].host',
+                    'config[].name',
+                  ]
+                }
+              ]
+            },
+            {
+              type: 'flex',
+              'flex-flow': 'row',
+              key: 'config[]',
+              items: [
+                {
+                  type: 'button',
+                  title: 'Connect',
+                  key: 'config[].connect'
+                },
+                {
+                  type: 'button',
+                  title: 'Get API Key',
+                  key: 'config[].getApiKey'
+                },
+                {
+                  type: 'submit',
+                  title: 'Configure',
+                  key: 'config[].configure'
+                }
+              ]
+            },
+            {
+              type: 'fieldset',
+              key: 'config[]._bridge',
+              // expandable: true,
+              title: 'Child Bridge Accessory Settings',
+              items: [
+                {
+                  type: 'flex',
+                  'flex-flow': 'row',
+                  items: [
+                    'config[]._bridge.username',
+                    'config[]._bridge.port'
+                  ]
+                },
+                'config[]._bridge.name',
+                {
+                  type: 'flex',
+                  'flex-flow': 'row',
+                  items: [
+                    'config[]._bridge.manufacturer',
+                    'config[]._bridge.model'
+                  ]
+                }
+              ]
+            }
+          ]
+        }
+      ]
+    }, {
+      config: pluginConfig,
+    },
+    'Gateway Settings',
+    'Homebridge Settings'
+  )
+  form.onChange(async (form) => {
+    console.log('change: %o', form)
+  })
+  form.onSubmit(async (form) => {
+    console.log('submit: %o', form)
+  })
+  form.onCancel(async (form) => {
+    console.log('cancel: %o', form)
+  })
+
+}
+
+async function showFormGateways (gateway) {
+  homebridge.showSpinner()
+  const cachedAccessories = await homebridge.getCachedAccessories()
+  const cachedGateways = cachedAccessories.filter((accessory) => {
+    return accessory.plugin === 'homebridge-deconz' &&
+      accessory.context != null &&
+      accessory.context.className === 'Gateway'
+  })
+  const result = {}
+  for (const gateway of cachedGateways) {
+    if (gateway.context.uiPort == null) {
+      continue
+    }
+    const pong = await homebridge.request(
+      'get', { uiPort: gateway.context.uiPort, path: '/ping' }
+    )
+    if (pong === 'pong') {
+      result[gateway.context.host] = gateway.context
+    }
+  }
+  const gateways = Object.keys(result).sort()
+  homebridge.hideSpinner()
+  if (gateways.length === 0) {
+    homebridge.showSchemaForm()
+    return
+  }
+  // const form = homebridge.createForm({
+  //   schema: {
+  //     type: 'object',
+  //     properties: {
+  //       gateway: {
+  //         title: 'Connected Gateways',
+  //         type: 'string',
+  //         oneOf: gateways.map((name) => {
+  //           const config = result[name].context.config
+  //           return {
+  //             title: `${name}: dresden elektronik ${config.modelid} gateway v${config.swversion} / ${config.devicename} ${config.bridgeid}`,
+  //             enum: [name]
+  //           }
+  //         }),
+  //         required: true
+  //       }
+  //     }
+  //   },
+  //   layout: null,
+  //   form: null
+  // }, {
+  //   gateway: gateway != null ? gateway : gateways[0]
+  // }, 'Gateway Settings', 'Homebridge Settings')
+  const form = homebridge.createForm({
+    footerDisplay: 'For a detailed description, see the [wiki](https://github.com/ebaauw/homebridge-deconz/wiki/Configuration).',
+    schema: {
+      type: 'object',
+      properties: {
+        name: {
+          description: 'Plugin name as displayed in the Homebridge log.',
+          type: 'string',
+          required: true,
+          default: 'deCONZ'
+        },
+        gateways: {
+          title: 'Gateways',
+          type: 'array',
+          disabled: true,
+          items: {
+            type: 'object',
+            properties: {
+              host: {
+                description: 'Hostname and port of the deCONZ gateway.',
+                type: 'string'
+              },
+              expose: {
+                description: 'Expose gateway to HomeKit.',
+                type: 'boolean'
+              }
+            }
+          }
+
+        }
+      }
+    } //,
+    // layout: [
+    //   'name',
+    //   {
+    //     key: 'gateways',
+    //     type: 'array',
+    //     buttonText: 'Add Gateway',
+    //     items: [
+    //       {
+    //         type: 'section',
+    //         htmlClass: 'row',
+    //         items: [
+    //           {
+    //             type: 'section',
+    //             htmlClass: 'col',
+    //             items: [
+    //               'gateways[].host'
+    //             ]
+    //           },
+    //           {
+    //             type: 'section',
+    //             htmlClass: 'col',
+    //             items: [
+    //             {
+    //               key: 'gateways[].expose',
+    //               disabled: true
+    //             }
+    //             ]
+    //           }
+    //         ]
+    //       }
+    //     ]
+    //   }
+    // ]
+  }, {
+
+  }, 'Gateway Settings', 'Homebridge Settings')
+  form.onChange(async (form) => {
+    // showFormGatewaySettings(result[form.gateway])
+  })
+  form.onSubmit(async (form) => {
+    await showFormGatewaySettings(result[form.gateways])
+  })
+  form.onCancel(() => { homebridge.showSchemaForm() })
+}
+
+async function showFormGatewaySettings (gateway, device) {
+  homebridge.showSpinner()
+  const data = await homebridge.request(
+    'get', {
+      uiPort: gateway.uiPort,
+      path: '/gateways/' + gateway.id
+    }
+  )
+  const values = {}
+  for (const rtype in data.deviceByRidByRtype) {
+    values[rtype] = []
+    for (const rid in data.deviceByRidByRtype[rtype]) {
+      const device = data.deviceByRidByRtype[rtype][rid]
+      values[rtype].push({
+        title: ['', rtype, rid].join('/') + ': ' +
+          device.resourceBySubtype[device.primary].body.name,
+        enum: [device.id]
+      })
+    }
+  }
+  data.lightsDevice = values.lights[0].enum[0]
+  data.sensorsDevice = values.sensors[0].enum[0]
+  data.groupsDevice = values.groups[0].enum[0]
+  homebridge.hideSpinner()
+  const form = homebridge.createForm({
+    schema: {
+      type: 'object',
+      properties: {
+        expose: {
+          title: 'Expose',
+          type: 'boolean'
+        },
+        lights: {
+          title: 'Lights',
+          type: 'boolean',
+        },
+        sensors: {
+          title: 'Sensors',
+          type: 'boolean',
+        },
+        groups: {
+          title: 'Groups',
+          type: 'boolean',
+        },
+        schedules: {
+          title: 'Schedules',
+          type: 'boolean',
+        },
+        logLevel: {
+          title: 'Log Level',
+          type: 'string',
+          oneOf: ['0', '1', '2', '3'].map((level) => { return { title: level, enum: [level] } }),
+          required: true,
+          condition: {
+            functionBody: 'return model.expose'
+          }
+        },
+        lightsDevice: {
+          title: 'Device',
+          type: 'string',
+          oneOf: values.lights,
+          required: true
+        },
+        sensorsDevice: {
+          title: 'Device',
+          type: 'string',
+          oneOf: values.sensors,
+          required: true
+        },
+        groupsDevice: {
+          title: 'Device',
+          type: 'string',
+          oneOf: values.groups,
+          required: true
+        }
+      }
+    },
+    layout: [
+      {
+        type: 'fieldset',
+        title: `${gateway.context.host} Gateway Settings`
+      },
+      'expose',
+      'logLevel',
+      {
+        type: 'flex',
+        'flex-flow': 'row',
+        title: 'Automatically Expose New',
+        items: [
+          'lights',
+          'sensors',
+          'groups',
+          'schedules'
+        ],
+        condition: {
+          functionBody: 'return model.expose'
+        }
+      },
+      {
+        type: 'fieldset',
+        items: [
+          {
+            type: 'tabs',
+            tabs: [
+              {
+                title: 'Lights',
+                items: [
+                  'lightsDevice'
+                ]
+              },
+              {
+                title: 'Sensors',
+                items: [
+                  'sensorsDevice'
+                ]
+              },
+              {
+                title: 'Groups',
+                items: [
+                  'groupsDevice'
+                ]
+              }
+            ]
+          }
+        ],
+        condition: {
+          functionBody: 'return model.expose'
+        }
+      }
+    ]
+  }, data, 'Device Settings', 'Done')
+  form.onChange((form) => {})
+  form.onSubmit((form) => {
+    showFormDeviceSettings(gateway, form.lightsDevice)
+  })
+  form.onCancel((form) => {
+    showFormGateways(gateway.context.host)
+  })
+}
+
+async function showFormDeviceSettings (gateway, device) {
+  homebridge.showSpinner()
+  homebridge.hideSpinner()
+  const form = homebridge.createForm({
+    schema: {
+      type: 'object',
+      properties: {
+        gateway: {
+          type: 'string'
+        },
+        device: {
+          type: 'string'
+        }
+      }
+    }
+  }, {
+    gateway: gateway.context.host,
+    device: device
+  }, 'OK', 'Cancel')
+  form.onChange((form) => {})
+  form.onSubmit((form) => {
+    showFormGatewaySettings(gateway)
+  })
+  form.onCancel((form) => {
+    showFormGatewaySettings(gateway)
+  })
+}
+
+(async () => {
+  try {
+    await showFormPluginConfig()
+  } catch (error) {
+    console.error(error)
+  }
+})()
+</script>

package/lib/Deconz/Discovery.js

@@ -78,12 +78,15 @@ class Discovery extends events.EventEmitter {
     if (
       body != null && typeof body === 'object' &&
       typeof body.apiversion === 'string' &&
-      /00212E[0-9A-Fa-f]{10}/.test(body.bridgeid) &&
+      /[0-9A-Fa-f]{16}/.test(body.bridgeid) &&
       typeof body.devicename === 'string' &&
       typeof body.name === 'string' &&
       typeof body.swversion === 'string'
     ) {
-      return body
+      if (body.bridgeid.startsWith('00212E')) {
+        return body
+      }
+      throw new Error(`${body.bridgeid}: not a RaspBee/ConBee mac address`)
     }
     throw new Error('not a deCONZ gateway')
   }

package/lib/Deconz/Resource.js

@@ -339,6 +339,7 @@ class Resource {
         case 'CLIPPresence': return 'Motion'
         case 'ZHAPressure':
         case 'CLIPPressure': return 'AirPressure'
+        case 'ZHARelativeRotary': return 'Switch'
         case 'ZHASpectral': return ''
         case 'ZGPSwitch':
         case 'ZHASwitch':
@@ -882,6 +883,18 @@ class Resource {
                 break
             }
             break
+          case 'RDM002': // Hue tap dial switch
+            dots = true
+            if (this.endpoint === '01') {
+              buttons.push([1, '1', SINGLE | LONG, true])
+              buttons.push([2, '2', SINGLE | LONG, true])
+              buttons.push([3, '3', SINGLE | LONG, true])
+              buttons.push([4, '4', SINGLE | LONG, true])
+            } else if (this.endpoint === '14') {
+              buttons.push([5, 'Right Turn', SINGLE])
+              buttons.push([6, 'Left Turn', SINGLE])
+            }
+            break
           case 'ROM001': // Hue smart button
             buttons.push([1, 'Button', SINGLE | LONG, true])
             break
@@ -935,6 +948,7 @@ class Resource {
         break
       case 'Sunricher':
         switch (this.model) {
+          case 'ZG2833K4_EU06': // Sunricher 4-button remote
           case 'ZG2833K8_EU05': // Sunricher 8-button remote, see #529.
             if (this.endpoint === '01') {
               buttons.push([1, 'On 1', SINGLE | LONG])

package/lib/DeconzAccessory/Gateway.js

@@ -70,7 +70,10 @@ class Gateway extends homebridgeLib.AccessoryDelegate {
       // end migration
     }
     if (this.context.fullState != null) {
-      this.analyseFullState(this.context.fullState, { analyseOnly: true })
+      this.analyseFullState(this.context.fullState, {
+        analyseOnly: true,
+        logUnsupported: true
+      })
     }
 
     this.addPropertyDelegate({
@@ -774,7 +777,7 @@ class Gateway extends homebridgeLib.AccessoryDelegate {
     * @param {Object} fullState - The gateway full state, as returned by
     * {@link DeconzAccessory.Gateway#poll poll()}.
     * @param {Object} params - Parameters
-    * @param {boolean} [params.logUnsupportedResources=false] - Issue debug
+    * @param {boolean} [params.logUnsupported=false] - Issue debug
     * messsages for unsupported resources.
     * @param {boolean} [params.analyseOnly=false]
     */

package/lib/DeconzAccessory/index.js

@@ -144,13 +144,15 @@ class DeconzAccessory extends homebridgeLib.AccessoryDelegate {
     if (params.serviceName === 'Battery') {
       service = this.serviceByServiceName.Battery
     } else if (params.serviceName === 'Consumption') {
-      service = this.serviceByServiceName.Light ||
+      service = this.serviceByServiceName.Outlet ||
+        this.serviceByServiceName.Light ||
         this.serviceByServiceName.Power
       if (service != null) {
         service.addResource(resource)
       }
     } else if (params.serviceName === 'Power') {
-      service = this.serviceByServiceName.Light ||
+      service = this.serviceByServiceName.Outlet ||
+        this.serviceByServiceName.Light ||
         this.serviceByServiceName.Consumption
       if (service != null) {
         service.addResource(resource)
@@ -187,8 +189,8 @@ class DeconzAccessory extends homebridgeLib.AccessoryDelegate {
     }
     this.serviceBySubtype[resource.subtype] = service
     this.serviceByRpath[resource.rpath] = service
-    if (this.serviceByServiceName[resource.serviceName] == null) {
-      this.serviceByServiceName[resource.serviceName] = service
+    if (this.serviceByServiceName[params.serviceName] == null) {
+      this.serviceByServiceName[params.serviceName] = service
     }
     if (
       resource.body.config != null &&

package/lib/DeconzPlatform.js

@@ -25,6 +25,7 @@ class DeconzPlatform extends homebridgeLib.Platform {
 
   parseConfigJson (configJson) {
     this.config = {
+      brightnessAdjustment: 100,
       forceHttp: false,
       hosts: [],
       noResponse: false,
@@ -44,6 +45,7 @@ class DeconzPlatform extends homebridgeLib.Platform {
       })
       .stringKey('name')
       .stringKey('platform')
+      .intKey('brightnessAdjustment', 10, 100)
       .boolKey('forceHttp')
       .stringKey('host')
       .arrayKey('hosts')
@@ -61,6 +63,7 @@ class DeconzPlatform extends homebridgeLib.Platform {
 
     try {
       optionParser.parse(configJson)
+      this.config.brightnessAdjustment /= 100
       if (this.config.host != null) {
         this.config.hosts.push(this.config.host)
       }
@@ -170,7 +173,8 @@ class DeconzPlatform extends homebridgeLib.Platform {
       }
       for (const id in this.gatewayMap) {
         const gateway = this.gatewayMap[id]
-        dumpInfo.gatewayMap[id] = gateway.context
+        dumpInfo.gatewayMap[id] = Object.assign({}, gateway.context)
+        dumpInfo.gatewayMap[id].deviceById = gateway.deviceById
       }
       await this.createDumpFile(dumpInfo)
     } catch (error) { this.error(error) }

package/lib/DeconzService/AirPurifier.js

@@ -47,7 +47,7 @@ class FilterMaintenance extends DeconzService.SensorsResource {
       )
     }
     if (state.replacefilter != null) {
-      this.values.filterChange = state.filterChange
+      this.values.filterChange = state.replacefilter
         ? this.Characteristics.hap.FilterChangeIndication.CHANGE_FILTER
         : this.Characteristics.hap.FilterChangeIndication.FILTER_OK
     }
@@ -158,16 +158,6 @@ class AirPurifier extends DeconzService.SensorsResource {
   }
 
   updateState (state) {
-    if (this.values.filterLifeTime != null && state.filterruntime != null) {
-      this.values.filterLifeLevel = 100 - Math.round(
-        100 * state.filterruntime / this.values.filterLifeTime
-      )
-    }
-    if (state.replacefilter != null) {
-      this.values.filterChange = state.filterChange
-        ? this.Characteristics.hap.FilterChangeIndication.CHANGE_FILTER
-        : this.Characteristics.hap.FilterChangeIndication.FILTER_OK
-    }
     if (state.speed != null) {
       this.values.active = state.speed > 0
         ? this.Characteristics.hap.Active.ACTIVE

package/lib/DeconzService/Button.js

@@ -167,6 +167,10 @@ class Button extends homebridgeLib.ServiceDelegate {
       this.values.event = event
     }
   }
+
+  updateRotation () {
+    this.values.event = homeKitEvent.SINGLE_PRESS
+  }
 }
 
 module.exports = Button