homebridge-deconz 0.1.16 → 0.1.18

package/lib/Deconz/Discovery.js

@@ -1,238 +0,0 @@
-// homebridge-hue/lib/Deconz/Discovery.js
-//
-// Homebridge plug-in for Philips Hue and/or deCONZ.
-// Copyright © 2018-2023 Erik Baauw. All rights reserved.
-
-'use strict'
-
-const events = require('events')
-const { HttpClient, OptionParser, UpnpClient } = require('homebridge-lib')
-const xml2js = require('xml2js')
-
-/** Class for discovery of deCONZ gateways.
-  *
-  * See the [deCONZ API](https://dresden-elektronik.github.io/deconz-rest-doc/)
-  * documentation for a better understanding of the API.
-  * @extends EventEmitter
-  * @memberof Deconz
-  */
-class Discovery extends events.EventEmitter {
-  /** Create a new instance.
-    * @param {object} params - Parameters.
-    * @param {boolean} [params.forceHttp=false] - Use plain HTTP instead of HTTPS.
-    * @param {integer} [params.timeout=5] - Timeout (in seconds) for requests.
-    */
-  constructor (params = {}) {
-    super()
-    this._options = {
-      forceHttp: false,
-      timeout: 5
-    }
-    const optionParser = new OptionParser(this._options)
-    optionParser.boolKey('forceHttp')
-    optionParser.intKey('timeout', 1, 60)
-    optionParser.parse(params)
-  }
-
-  /** Issue an unauthenticated GET request of `/api/config` to given host.
-    *
-    * @param {string} host - The IP address or hostname and port of the deCONZ
-    * gateway.
-    * @return {object|null} response - The JSON response body converted to
-    * JavaScript, or null when the response doesn't come from deCONZ.
-    * @throws {HttpError} In case of error.
-    */
-  async config (host) {
-    const client = new HttpClient({
-      host,
-      json: true,
-      path: '/api',
-      timeout: this._options.timeout
-    })
-    client
-      .on('error', (error) => {
-        /** Emitted when an error has occured.
-          *
-          * @event DeconzDiscovery#error
-          * @param {HttpError} error - The error.
-          */
-        this.emit('error', error)
-      })
-      .on('request', (request) => {
-        /** Emitted when request has been sent.
-          *
-          * @event DeconzDiscovery#request
-          * @param {HttpRequest} request - The request.
-          */
-        this.emit('request', request)
-      })
-      .on('response', (response) => {
-        /** Emitted when a valid response has been received.
-          *
-          * @event DeconzDiscovery#response
-          * @param {HttpResponse} response - The response.
-          */
-        this.emit('response', response)
-      })
-    const { body } = await client.get('/config')
-    if (
-      body != null && typeof body === 'object' &&
-      typeof body.apiversion === 'string' &&
-      /[0-9A-Fa-f]{16}/.test(body.bridgeid) &&
-      typeof body.devicename === 'string' &&
-      typeof body.name === 'string' &&
-      typeof body.swversion === 'string'
-    ) {
-      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')
-  }
-
-  /** Issue an unauthenticated GET request of `/description.xml` to given host.
-    *
-    * @param {string} host - The IP address or hostname and port of the deCONZ gateway.
-    * @return {object} response - The description, converted to JavaScript.
-    * @throws {Error} In case of error.
-    */
-  async description (host) {
-    const options = {
-      host,
-      timeout: this._options.timeout
-    }
-    const client = new HttpClient(options)
-    client
-      .on('error', (error) => { this.emit('error', error) })
-      .on('request', (request) => { this.emit('request', request) })
-      .on('response', (response) => { this.emit('response', response) })
-    const { body } = await client.get('/description.xml')
-    const xmlOptions = { explicitArray: false }
-    const result = await xml2js.parseStringPromise(body, xmlOptions)
-    return result
-  }
-
-  /** Discover deCONZ gateways.
-    *
-    * Queries the Phoscon portal for known gateways and does a local search
-    * over UPnP.
-    * Calls {@link DeconzDiscovery#config config()} for each discovered gateway
-    * for verification.
-    * @param {boolean} [stealth=false] - Don't query discovery portals.
-    * @return {object} response - Response object with a key/value pair per
-    * found gateway.  The key is the host (IP address or hostname and port),
-    * the value is the return value of {@link DeconzDiscovery#config config()}.
-    */
-  async discover (stealth = false) {
-    this.gatewayMap = {}
-    this.jobs = []
-    this.jobs.push(this._upnp())
-    if (!stealth) {
-      this.jobs.push(this._nupnp({
-        name: 'phoscon.de',
-        https: !this._options.forceHttp,
-        host: 'phoscon.de',
-        path: '/discover'
-      }))
-    }
-    for (const job of this.jobs) {
-      await job
-    }
-    return this.gatewayMap
-  }
-
-  _found (name, id, host) {
-    /** Emitted when a potential gateway has been found.
-      * @event DeconzDiscovery#found
-      * @param {string} name - The name of the search method.
-      * @param {string} bridgeid - The ID of the gateway.
-      * @param {string} host - The IP address/hostname and port of the gateway
-      * or gateway.
-      */
-    this.emit('found', name, id, host)
-    if (this.gatewayMap[host] == null) {
-      this.gatewayMap[host] = id
-      this.jobs.push(
-        this.config(host).then((config) => {
-          this.gatewayMap[host] = config
-        }).catch((error) => {
-          delete this.gatewayMap[host]
-          if (error.request == null) {
-            this.emit('error', error)
-          }
-        })
-      )
-    }
-  }
-
-  async _upnp () {
-    const upnpClient = new UpnpClient({
-      filter: (message) => {
-        return /^[0-9A-F]{16}$/.test(message['gwid.phoscon.de'])
-      },
-      timeout: this._options.timeout
-    })
-    upnpClient
-      .on('error', (error) => { this.emit('error', error) })
-      .on('searching', (host) => {
-        /** Emitted when UPnP search has started.
-          *
-          * @event DeconzDiscovery#searching
-          * @param {string} host - The IP address and port from which the
-          * search was started.
-          */
-        this.emit('searching', host)
-      })
-      .on('request', (request) => {
-        request.name = 'upnp'
-        this.emit('request', request)
-      })
-      .on('deviceFound', (address, obj, message) => {
-        let host
-        const a = obj.location.split('/')
-        if (a.length > 3 && a[2] != null) {
-          host = a[2]
-          const b = host.split(':')
-          const port = parseInt(b[1])
-          if (port === 80) {
-            host = b[0]
-          }
-          this._found('upnp', obj['gwid.phoscon.de'], host)
-        }
-      })
-    upnpClient.search()
-    await events.once(upnpClient, 'searchDone')
-    /** Emitted when UPnP search has concluded.
-      *
-      * @event DeconzDiscovery#searchDone
-      */
-    this.emit('searchDone')
-  }
-
-  async _nupnp (options) {
-    options.json = true
-    options.timeout = this._options.timeout
-    const client = new HttpClient(options)
-    client
-      .on('error', (error) => { this.emit('error', error) })
-      .on('request', (request) => { this.emit('request', request) })
-      .on('response', (response) => { this.emit('response', response) })
-    try {
-      const { body } = await client.get()
-      if (Array.isArray(body)) {
-        for (const gateway of body) {
-          let host = gateway.internalipaddress
-          if (gateway.internalport != null && gateway.internalport !== 80) {
-            host += ':' + gateway.internalport
-          }
-          this._found(options.name, gateway.id.toUpperCase(), host)
-        }
-      }
-    } catch (error) {
-      this.emit('error', error)
-    }
-  }
-}
-
-module.exports = Discovery

package/lib/Deconz/WsClient.js

@@ -1,205 +0,0 @@
-// homebridge-deconz/lib/Deconz/WsClient.js
-//
-// Homebridge plug-in for deCONZ.
-// Copyright © 2018-2023 Erik Baauw. All rights reserved.
-
-'use strict'
-
-const events = require('events')
-const { OptionParser, timeout } = require('homebridge-lib')
-const WebSocket = require('ws')
-
-/** Client for web socket notifications by a deCONZ gateway.
-  *
-  * See the
-  * [deCONZ](https://dresden-elektronik.github.io/deconz-rest-doc/endpoints/websocket/)
-  * documentation for a better understanding of the web socket notifications.
-  * @memberof Deconz
-  */
-class WsClient extends events.EventEmitter {
-  /** Instantiate a new web socket client.
-    * @param {object} params - Parameters.
-    * @param {string} [params.host='localhost:443'] - IP address or hostname
-    * and port of the web socket server.
-    * @param {integer} [params.retryTime=10] - Time (in seconds) to try and
-    * reconnect when the server connection has been closed.
-    * @param {boolean} [params.raw=false] - Issue raw events instead of parsing
-    * them.<br>
-    * When specified, {@link DeconzWsClient#event:notification notification}
-    * events are emitted, in lieu of {@link DeconzWsClient#event:changed changed},
-    * {@link DeconzWsClient#event:added added}, and
-    * {@link DeconzWsClient#event:sceneRecall sceneRecall} events.
-    */
-  constructor (params = {}) {
-    super()
-    this.config = {
-      hostname: 'localhost',
-      port: 443,
-      retryTime: 15
-    }
-    const optionParser = new OptionParser(this.config)
-    optionParser
-      .hostKey()
-      .intKey('retryTime', 0, 120)
-      .boolKey('raw')
-      .parse(params)
-  }
-
-  /** The hostname or IP address and port of the web socket server.
-    * @type {string}
-    */
-  get host () { return this.config.hostname + ':' + this.config.port }
-  set host (host) {
-    const { hostname, port } = OptionParser.toHost('host', host)
-    this.config.hostname = hostname
-    this.config.port = port
-  }
-
-  /** Connect to the web socket server, and listen notifications.
-    */
-  listen () {
-    this.reconnect = true
-    const url = 'ws://' + this.config.hostname + ':' + this.config.port
-    this.ws = new WebSocket(url, { family: 4 })
-
-    this.ws
-      .on('error', (error) => {
-        /** Emitted on error.
-          * @event DeconzWsClient#error
-          * @param {Error} error - The error.
-          */
-        this.emit('error', error)
-      })
-      .on('open', () => {
-        /** Emitted when connection to web socket server has been made.
-          * @event DeconzWsClient#listening
-          * @param {string} url - The URL of the web socket server.
-          */
-        this.emit('listening', url)
-      })
-      .on('message', (data, flags) => {
-        try {
-          const obj = JSON.parse(data.toString())
-          if (!this.config.raw) {
-            if (obj.r === 'groups' && obj.id === 0xFFF0.toString()) {
-              // Workaround for deCONZ bug: events for `/groups/0` contain
-              // the Zigbee group ID, instead of the resource ID.
-              obj.id = '0'
-            }
-            if (obj.t === 'event') {
-              switch (obj.e) {
-                case 'changed':
-                  if (obj.r !== null && obj.id !== null) {
-                    let body
-                    if (obj.attr != null) {
-                      body = obj.attr
-                    } else if (obj.capabilities != null) {
-                      body = { capabilities: obj.capabilities }
-                    } else if (obj.config != null) {
-                      body = { config: obj.config }
-                    } else if (obj.state != null) {
-                      body = { state: obj.state }
-                    }
-                    /** Emitted when a `changed` notification has been received.
-                      *
-                      * Note that the deCONZ gateway sends different
-                      * notifications for top-level, `state`, and `config`
-                      * attributes.
-                      * Consequenly, the `body` only contains one of these.
-                      * @event DeconzWsClient#changed
-                      * @param {string} rtype - The resource type of the changed
-                      * resource.
-                      * @param {integer} rid - The resource ID of the changed
-                      * resource.
-                      * @param {object} body - The body of the changed resource.
-                      */
-                    this.emit('changed', obj.r, obj.id, body)
-                    return
-                  }
-                  break
-                case 'added':
-                  if (obj.r !== null && obj.id !== null) {
-                    /** Emitted when an `added` notification has been received.
-                      * @event DeconzWsClient#added
-                      * @param {string} rtype - The resource type of the added
-                      * resource.
-                      * @param {integer} rid - The resource ID of the added
-                      * resource.
-                      * @param {object} body - The body of the added resource.
-                      */
-                    this.emit('added', obj.r, obj.id, obj[obj.r.slice(0, -1)])
-                    return
-                  }
-                  break
-                case 'deleted':
-                  if (obj.r !== null && obj.id !== null) {
-                    /** Emitted when an `deleted` notification has been received.
-                      * @event DeconzWsClient#deleted
-                      * @param {string} rtype - The resource type of the deleted
-                      * resource.
-                      * @param {integer} rid - The resource ID of the deleted
-                      * resource.
-                      */
-                    this.emit('deleted', obj.r, obj.id)
-                    return
-                  }
-                  break
-                case 'scene-called':
-                  if (obj.gid != null && obj.scid != null) {
-                    const resource = '/groups/' + obj.gid + '/scenes/' + obj.scid
-                    /** Emitted when an `sceneRecall` notification has been received.
-                      * @event DeconzWsClient#sceneRecall
-                      * @param {string} resource - The scene resource.
-                      */
-                    this.emit('sceneRecall', resource)
-                    return
-                  }
-                  break
-                default:
-                  break
-              }
-            }
-          }
-          /** Emitted when an unknown notification has been received, or when
-            * `params.raw` was specified to the
-            * {@link DeconzWsClient constructor}.
-            * @event DeconzWsClient#notification
-            * @param {object} notification - The raw notification.
-            */
-          this.emit('notification', obj)
-        } catch (error) {
-          this.emit('error', error)
-        }
-      })
-      .on('close', async () => {
-        if (this.ws != null) {
-          this.ws.removeAllListeners()
-          delete this.ws
-        }
-        const retryTime = this.reconnect ? this.config.retryTime : 0
-        /** Emitted when the connection to the web socket server has been closed.
-          * @event DeconzWsClient#closed
-          * @param {string} url - The URL of the web socket server.
-          * @param {?int} retryTime - Time in seconds after which connection
-          * will be retied automatically.
-          */
-        this.emit('closed', url, retryTime)
-        if (retryTime > 0) {
-          await timeout(retryTime * 1000)
-          return this.listen()
-        }
-      })
-  }
-
-  /** Close the web socket connection.
-    */
-  async close () {
-    if (this.ws != null) {
-      this.reconnect = false
-      this.ws.close()
-      await events.once(this.ws, 'close')
-    }
-  }
-}
-
-module.exports = WsClient