hb-lib-tools/lib/HapTool.js

homebridge-lib Command-Line Tools`

// hb-lib-tools/lib/HapTool.js
//
// Library for Homebridge plugins.
// Copyright © 2018-2025 Erik Baauw. All rights reserved.
//
// Logger for HomeKit accessory announcements.

import { Bonjour } from 'hb-lib-tools/Bonjour'
import { CommandLineParser } from 'hb-lib-tools/CommandLineParser'
import { CommandLineTool } from 'hb-lib-tools/CommandLineTool'
import { JsonFormatter } from 'hb-lib-tools/JsonFormatter'
import { OptionParser } from 'hb-lib-tools/OptionParser'

const { b, u } = CommandLineTool

const usage = `${b('hap')} [${b('-hVlrs')}] [${b('-t')} ${u('timeout')}]`
const help = `Logger for HomeKit accessory announcements.

Usage: ${usage}

Search for HomeKit accessory announcements
Parameters:
  ${b('-h')}          Print this help and exit.
  ${b('-V')}          Print version and exit.
  ${b('-d')}          Listen for Bonjour alive broadcasts instead of searching.
  ${b('-s')}          Do not output timestamps (useful when running as service).
  ${b('-t')} ${u('timeout')}  Search for ${u('timeout')} seconds instead of default ${b('5')}.`

class HapTool extends CommandLineTool {
  constructor (pkgJson) {
    super()
    this.pkgJson = pkgJson
    this.usage = usage
    this.options = { timeout: 15 }
  }

  parseArguments () {
    const parser = new CommandLineParser(this.pkgJson)
    parser
      .help('h', 'help', help)
      .version('V', 'version')
      .flag('l', 'listen', (key) => { this.options.mode = 'daemon' })
      .flag('s', 'service', (key) => { this.options.mode = 'service' })
      .option('t', 'timeout', (value, key) => {
        this.options.timeout = OptionParser.toInt(
          'timeout', value, 1, 60, true
        )
      })
      .parse()
  }

  onUp (obj) {
    delete obj.rawTxt
    this.log('found accessory: %s', obj.name, this.jsonFormatter.stringify(obj))
  }

  async main () {
    try {
      this.parseArguments()
      this.jsonFormatter = new JsonFormatter(
        this.options.mode === 'service'
          ? { noWhiteSpace: true, sortKeys: true }
          : { sortKeys: true }
      )
      if (this.options.mode) {
        this.setOptions({ mode: this.options.mode })
      } else {
        setTimeout(() => {
          this.log('search done')
          bonjour4.destroy()
          // bonjour6.destroy()
        }, this.options.timeout * 1000)
      }
      this.log('searching for HomeKit accessories')
      const bonjour4 = new Bonjour()
      const browser4 = bonjour4.find({ type: 'hap' })
      browser4.on('up', this.onUp.bind(this))
      // const bonjour6 = new Bonjour({
      //   type: 'udp6',
      //   interface: '::%en0', // TODO: how to determine the interface?!
      //   ip: 'ff02::fb'
      // })
      // const browser6 = bonjour6.find({ type: 'hap' })
      // browser6.on('up', this.onUp.bind(this))
    } catch (error) {
      await this.fatal(error)
    }
  }
}

export { HapTool }