homebridge-deconz 0.0.15 → 0.0.18

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/ApiClient.js

@@ -81,9 +81,8 @@ class ApiClient extends homebridgeLib.HttpClient {
     * @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))
+    v = Math.max(0, Math.min(v, 60001))
+    return v ? Math.round(Math.pow(10, (v - 1) / 10000) * 10) / 10 : 0.0001
   }
 
   /** Create a new instance of a Deconz.Client.
@@ -149,7 +148,7 @@ class ApiClient extends homebridgeLib.HttpClient {
       maxSockets: _options.maxSockets,
       path: '/api',
       timeout: _options.timeout,
-      validStatusCodes: [200, 400, 403, 404]
+      validStatusCodes: [200, 400, 403] //, 404]
     }
     if (_options.phoscon) {
       // options.headers = { Accept: 'application/vnd.ddel.v1' }

package/lib/Deconz/Discovery.js

@@ -44,7 +44,7 @@ class Discovery extends events.EventEmitter {
     */
   async config (host) {
     const client = new homebridgeLib.HttpClient({
-      host: host,
+      host,
       json: true,
       path: '/api',
       timeout: this._options.timeout
@@ -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')
   }
@@ -96,7 +99,7 @@ class Discovery extends events.EventEmitter {
     */
   async description (host) {
     const options = {
-      host: host,
+      host,
       timeout: this._options.timeout
     }
     const client = new homebridgeLib.HttpClient(options)

package/lib/Deconz/Resource.js

@@ -21,8 +21,9 @@ const sensorsPrios = [
   'Power',
   'Consumption',
   'Temperature',
-  'Presence',
+  'Motion',
   'OpenClose',
+  'AirPurifier',
   'Thermostat'
 ]
 
@@ -256,7 +257,7 @@ class Resource {
   get prio () {
     if (this.rtype === 'groups') return -1
     if (this.rtype === 'lights') return this.endpoint
-    return sensorsPrios.indexOf(this.type)
+    return sensorsPrios.indexOf(this.serviceName)
   }
 
   /** The resource path of the resource, e.g. `/lights/1`.
@@ -270,7 +271,7 @@ class Resource {
     * corresponding HomeKit service, or `null` for unsupported and unknown
     * resources.
     *
-    * This is derived from the resource type and`type` in the resource body.
+    * This is derived from the resource type and `type` in the resource body.
     * @type {string}
     */
   get serviceName () {
@@ -305,6 +306,8 @@ class Resource {
       }
     } else { // (this.rtype === 'sensors')
       switch (this.body.type) {
+        case 'CLIPAirPurifier':
+        case 'ZHAAirPurifier': return 'AirPurifier'
         case 'ZHAAirQuality':
         case 'CLIPAirQuality': return 'AirQuality'
         case 'ZHAAlarm':
@@ -336,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':
@@ -879,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
@@ -932,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/AirPurifier.js

@@ -0,0 +1,38 @@
+// homebridge-deconz/lib/DeconzAccessory/Thermostat.js
+// Copyright © 2022 Erik Baauw. All rights reserved.
+//
+// Homebridge plugin for deCONZ.
+
+'use strict'
+
+const DeconzAccessory = require('../DeconzAccessory')
+
+class AirPurifier extends DeconzAccessory {
+  /** Instantiate a delegate for an accessory corresponding to a device.
+    * @param {DeconzAccessory.Gateway} gateway - The gateway.
+    * @param {Deconz.Device} device - The device.
+    */
+  constructor (gateway, device, settings = {}) {
+    super(gateway, device, gateway.Accessory.Categories.AIR_PURIFIER)
+    this.identify()
+
+    this.service = this.createService(device.resource, { primaryService: true })
+
+    for (const subtype in device.resourceBySubtype) {
+      const resource = device.resourceBySubtype[subtype]
+      if (subtype === device.primary) {
+        continue
+      }
+      this.createService(resource)
+    }
+
+    this.createSettingsService()
+
+    setImmediate(() => {
+      this.debug('initialised')
+      this.emit('initialised')
+    })
+  }
+}
+
+module.exports = AirPurifier