hb-lib-tools/lib/UpnpTool.js

homebridge-lib Command-Line Tools`

// hb-lib-tools/cli/upnp.js
//
// Logger for UPnP device announcements.
// Copyright © 2018-2025 Erik Baauw. All rights reserved.

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'
import { UpnpClient } from 'hb-lib-tools/UpnpClient'

const { b, u } = CommandLineTool

const usage = `${b('upnp')} [${b('-hVDadnprsz')}] [${b('-c')} ${u('class')}] [${b('-t')} ${u('timeout')}]`
const help = `UPnP tool.

Search for UPnP devices and print found devices as JSON.
When running as daemon or service, log UPnP alive broadcasts as JSON.

Usage: ${usage}

Parameters:
  ${b('-h')}, ${b('--help')}
  Print this help and exit.

  ${b('-V')}, ${b('--version')}
  Print version and exit.

  ${b('-D')}, ${b('--debug')}
  Print debug messages.

  ${b('-a')}, ${b('--all')}
  Short for ${b('-c ssdp:all')}.

  ${b('-c')} ${u('class')}, ${b('--class=')}${u('class')}
  Search for ${u('class')} instead of default ${b('ssdp:rootdevice')}.

  ${b('-d')}, ${b('--daemon')}
  Run as daemon.  Listen for UPnP alive broadcasts instead of searching.

  ${b('-n')}, ${b('--noWhiteSpace')}
  Do not include spaces nor newlines in JSON output.

  ${b('-p')}, ${b('--hue')}
  Search for Philips Hue bridges and/or deCONZ gateways.

  ${b('-r')}, ${b('--raw')}
  Do not parse messages, output raw message data instead of JSON.

  ${b('-s')}, ${b('--service')}
  Run as daemon.  Listen for UPnP alive broadcasts instead of searching.

  ${b('-t')} ${u('timeout')}, ${b('--timeout=')}${u('timeout')}
  Search for ${u('timeout')} seconds instead of default ${b('5')}.

  ${b('-z')}, ${b('--sonos')}
  Search for Sonos Zone Players.`

class UpnpTool extends CommandLineTool {
  constructor (pkgJson) {
    super()
    this.usage = usage
    this.options = {
      noWhiteSpace: false
    }
    this.pkgJson = pkgJson
    this.upnp = {}
  }

  parseArguments () {
    const parser = new CommandLineParser(this.pkgJson)
    parser
      .help('h', 'help', help)
      .version('V', 'version')
      .flag('D', 'debug', () => { this.setOptions({ debug: true }) })
      .flag('a', 'all', (key) => { this.upnp.class = 'ssdp:all' })
      .option('c', 'class', (value, key) => { this.upnp.class = value })
      .flag('d', 'daemon', (key) => { this.options.mode = 'daemon' })
      .flag('n', 'noWhiteSpace', () => { this.options.noWhiteSpace = true })
      .flag('r', 'raw', (key) => { this.options.raw = true })
      .flag('s', 'service', (key) => { this.options.mode = 'service' })
      .option('t', 'timeout', (value, key) => {
        this.upnp.timeout = OptionParser.toInt(
          'timeout', value, 1, 60, true
        )
      })
      .flag('p', 'hue', (key) => {
        this.upnp.filter = (message) => {
          return /^[0-9A-F]{16}$/.test(message['hue-bridgeid'])
        }
      })
      .flag('z', 'sonos', (key) => {
        this.upnp.class = 'urn:schemas-upnp-org:device:ZonePlayer:1'
      })
      .parse()
  }

  async destroy () {
    if (this.upnpClient == null) {
      return
    }
    return this.upnpClient.stopListen()
  }

  async main () {
    try {
      this.parseArguments()
      const jsonFormatter = new JsonFormatter({
        noWhiteSpace: this.options.noWhiteSpace
      })
      this.upnpClient = new UpnpClient(this.upnp)
      this.upnpClient
        .on('error', (error) => { this.error(error) })
        .on('listening', (host) => { this.debug('listening on %s', host) })
        .on('stopListening', (host) => { this.debug('stopped listening on %s', host) })
        .on('deviceAlive', (address, obj, message) => {
          if (!this.options.raw) {
            message = jsonFormatter.stringify(obj)
          }
          this.log('%s: %s', address, message)
        })
        .on('searching', (host) => { this.debug('listening on %s', host) })
        .on('request', (request) => {
          this.debug(
            '%s: request %d: %s %s', request.host, request.id,
            request.method, request.resource
          )
        })
        .on('searchDone', (host) => { this.debug('search done') })
        .on('deviceFound', (address, obj, message) => {
          if (!this.options.raw) {
            message = jsonFormatter.stringify(obj)
          }
          this.print('%s: %s', address, message)
        })

      if (this.options.mode) {
        this.setOptions({ mode: this.options.mode })
        this.upnpClient.listen()
      } else {
        this.upnpClient.search()
      }
    } catch (error) {
      await this.fatal(error)
    }
  }
}

export { UpnpTool }