hb-zp-tools 2.0.0-0 → 2.0.0

package/lib/ZpClient.js

@@ -155,10 +155,10 @@ class ZpClientRequest extends HttpClient.HttpRequest {
   get body () {}
 
   /** The (parsed) request body (in JavaScript).
-    * @type {?*}
+    * @type {?string}
     * @readonly
     */
-  get parsedBody () {}
+  get jsonBody () {}
 }
 
 /** ZpClient response.
@@ -331,6 +331,7 @@ class ZpClient extends HttpClient {
       .intKey('timeout', 1, 60) // seconds
       .intKey('subscriptionTimeout', 1, 1440) // minutes
       .instanceKey('listener', ZpListener)
+      .instanceKey('logger')
       .parse(params)
     _params.subscriptionTimeout *= 60 // minutes -> seconds
 
@@ -340,6 +341,7 @@ class ZpClient extends HttpClient {
       keepAlive: true,
       maxSockets: 1,
       name: _params.hostname,
+      logger: _params.logger,
       timeout: _params.timeout,
       xmlParser: parser.parse.bind(parser)
     }
@@ -373,6 +375,7 @@ class ZpClient extends HttpClient {
   // _request().
   error (error) {
     if (error.request == null) {
+      this.warn(error)
       this.emit('error', error)
     }
   }
@@ -486,7 +489,7 @@ class ZpClient extends HttpClient {
           props.household = household
           props.zoneGroup = group.coordinator
           if (props.id === this._params.id) {
-            this._checkAddress(props.address)
+            this.#checkAddress(props.address)
             await this._checkBootSeq(props.bootSeq)
             if (props.bootSeq < this._props.bootSeq) {
               props.bootSeq = this._props.bootSeq
@@ -981,7 +984,7 @@ class ZpClient extends HttpClient {
     this._params.callbackUrl = await this._zpListener.addClient(this)
     this._zpListener.on(this.id, async (message) => {
       try {
-        await this._updateLastSeen()
+        await this.#updateLastSeen()
         message.name = this.name
         if (message.body != null) {
           message.rawBody = message.body
@@ -994,6 +997,16 @@ class ZpClient extends HttpClient {
           this._zoneGroupState = message.body
           await this.initTopology(this)
         }
+        const notify = message.device === 'ZonePlayer'
+          ? message.service
+          : message.device + '/' + message.service
+        this.vvdebug(
+          '%s: notify %s/Event: %j', this.name, notify, message.rawBody
+        )
+        this.vdebug(
+          '%s: notify %s/Event: %j', this.name, notify, message.body
+        )
+        this.debug('%s: notify %s/Event', this.name, notify)
         /** Emitted when a push notification has been received from the zone player.
           * @event ZpClient#message
           * @param {ZpClient.ZpClientNotification} message - The message.
@@ -1049,7 +1062,7 @@ class ZpClient extends HttpClient {
       }
     }
     try {
-      const response = await this._request('SUBSCRIBE', url, undefined, headers)
+      const response = await this.#request('SUBSCRIBE', url, undefined, headers)
       this._subscriptions[url].sid = response.headers.sid
     } catch (error) {
       if (error.statusCode === 412) {
@@ -1084,7 +1097,7 @@ class ZpClient extends HttpClient {
     delete this._subscriptions[url]
     if (sid != null) {
       try {
-        await this._request('UNSUBSCRIBE', url, undefined, { SID: sid })
+        await this.#request('UNSUBSCRIBE', url, undefined, { SID: sid })
       } catch (error) { this.error(error) }
     }
     if (Object.keys(this._subscriptions).length === 0) {
@@ -1112,6 +1125,10 @@ class ZpClient extends HttpClient {
         await this.subscribe(url)
       } catch (error) { this.error(error) }
     }
+    this.debug(
+      '%s: rebooted (%d -> %d)', this.name,
+      oldBootSeq, this.bootSeq
+    )
     /** Emitted when the zone player has rebooted.
       * @event ZpClient#rebooted
       * @param {integer} oldBootSeq - The old
@@ -1120,7 +1137,7 @@ class ZpClient extends HttpClient {
     this.emit('rebooted', oldBootSeq)
   }
 
-  _checkAddress (address) {
+  #checkAddress (address) {
     if (address === this._props.address) {
       return
     }
@@ -1128,6 +1145,11 @@ class ZpClient extends HttpClient {
     this._props.address = address
     this.host = this._props.address + ':1400'
     this._params.hostname = this._props.address
+
+    this.debug(
+      '%s: IP address changed (%s -> %s)', this.name,
+      oldAddress, this.address
+    )
     /** Emitted when the zone player has a new IP address.
       * @event ZpClient#addressChanged
       * @param {string} oldAddress - The old
@@ -1136,7 +1158,7 @@ class ZpClient extends HttpClient {
     this.emit('addressChanged', oldAddress)
   }
 
-  async _updateLastSeen () {
+  async #updateLastSeen () {
     if (this._reSubscribing) {
       return
     }
@@ -1175,9 +1197,9 @@ class ZpClient extends HttpClient {
     if (this._props.household !== message.household) {
       this._props.household = message.household
     }
-    this._checkAddress(message.address)
+    this.#checkAddress(message.address)
     await this._checkBootSeq(message.bootseq)
-    await this._updateLastSeen()
+    await this.#updateLastSeen()
   }
 
   // ***** Control *************************************************************
@@ -1207,6 +1229,9 @@ class ZpClient extends HttpClient {
       PlayMode: alarm.playMode,
       Volume: alarm.volume,
       IncludeLinkedZones: alarm.includeLinkedZones
+      // Note that when set from the Sonos iOS app, the alarm includes a
+      // <Content type="..." .../> tag.  This tag is lost when updating the
+      // alarm here, but also when updating from the Sonos macOS app.
     })
   }
 
@@ -1411,7 +1436,7 @@ class ZpClient extends HttpClient {
     let meta = '<DIDL-Lite xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:upnp="urn:schemas-upnp-org:metadata-1-0/upnp/" xmlns:r="urn:schemas-rinconnetworks-com:metadata-1-0/" xmlns="urn:schemas-upnp-org:metadata-1-0/DIDL-Lite/">'
     meta += `<item id="${metaData.id}" parentID="${metaData.parentId}" restricted="${metaData.restricted}">`
     meta += `<dc:title>${metaData.title}</dc:title>`
-    meta += `<upnp:class>${metaData.class}.sonos-favorite</upnp:class>`
+    meta += `<upnp:class>${metaData.class}</upnp:class>`
     if (albumArtUri != null) {
       for (const uri of albumArtUri) {
         meta += `<upnp:albumArtURI>${he.escape(uri)}</upnp:albumArtURI>`
@@ -1712,10 +1737,10 @@ class ZpClient extends HttpClient {
     }
     const info = {
       action,
-      parsedBody: options
+      jsonBody: JSON.stringify(options)
     }
-    const response = await this._request('POST', url, body, headers, info)
-    await this._updateLastSeen()
+    const response = await this.#request('POST', url, body, headers, info)
+    await this.#updateLastSeen()
     return response.body
   }
 
@@ -1724,12 +1749,12 @@ class ZpClient extends HttpClient {
     * @returns {?*} - The parsed response body as JavaScript object.
     */
   async get (url = '/xml/device_description.xml') {
-    const response = await this._request('GET', url)
-    await this._updateLastSeen()
+    const response = await this.#request('GET', url)
+    await this.#updateLastSeen()
     return response.body
   }
 
-  async _request (method, resource, body, headers, info) {
+  async #request (method, resource, body, headers, info) {
     const response = await super.request(
       method, resource, body, headers, '', info
     )

package/lib/ZpTool.js

@@ -52,7 +52,8 @@ const usage = {
   subLevel: `${b('subLevel')} [${b('-h')}] [${b('--')}] [${u('level')}]`,
   led: `${b('led')} [${b('-h')}] [${b('on')}|${b('off')}]`,
   buttonLock: `${b('buttonLock')} [${b('-h')}] [${b('on')}|${b('off')}]`,
-  listAlarms: `${b('listAlarms')} [${b('-h')}]`
+  listAlarms: `${b('listAlarms')} [${b('-hns')}]`,
+  alarm: `${b('alarm')} [${b('-h')}] ${u('id')} [${b('on')}|${b('off')}]`
 }
 
 const description = {
@@ -93,7 +94,8 @@ const description = {
   subLevel: 'Get/set Sub level.',
   led: 'Get/set/clear LED state.',
   buttonLock: 'Get/set/clear button lock state.',
-  listAlarms: 'Get alarms.'
+  listAlarms: 'Get alarms.',
+  alarm: 'Get/enable/disable alarm.'
 }
 
 const help = {
@@ -224,6 +226,9 @@ Commands:
   ${usage.listAlarms}
   ${description.listAlarms}
 
+  ${usage.alarm}
+  ${description.alarm}
+
 For more help, issue: ${b('zp')} ${u('command')} ${b('-h')}`,
   info: `${description.info}
 
@@ -661,7 +666,29 @@ Usage: ${b('zp')} ${usage.listAlarms}
 
 Parameters:
   ${b('-h')}, ${b('--help')}
-  Print this help and exit.`
+  Print this help and exit.
+
+  ${b('-n')}, ${b('--noWhiteSpace')}
+  Do not include spaces nor newlines in JSON output.
+
+  ${b('-s')}, ${b('--sortKeys')}
+  Sort JSON keys alphabetically.`,
+  alarm: `${description.alarm}
+
+Usage: ${b('zp')} ${usage.alarm}
+
+Parameters:
+  ${b('-h')}, ${b('--help')}
+  Print this help and exit.
+  
+  ${u('id')}
+  Alarm ID (from ${b('listAlarms')}).
+
+  ${b('on')}
+  Enable alarm.
+
+  ${b('off')}
+  Disable alarm.`
 }
 
 const unsupportedServices = [
@@ -679,105 +706,6 @@ class ZpTool extends CommandLineTool {
     this.clients = []
   }
 
-  createZpClient (options) {
-    const zpClient = new ZpClient(options)
-    zpClient
-      .on('error', (error) => {
-        if (error.request == null) {
-          this.warn(error)
-          return
-        }
-        if (error.request.id !== this.requestId) {
-          if (error.request.body == null) {
-            this.log(
-              '%s: request %d: %s %s', error.request.name, error.request.id,
-              error.request.method, error.request.resource
-            )
-          } else {
-            this.log(
-              '%s: request %d: %s %s', error.request.name, error.request.id,
-              error.request.method, error.request.resource, error.request.action
-            )
-          }
-          this.requestId = error.request.id
-        }
-        this.warn(
-          '%s: request %d: %s', error.request.name, error.request.id, error
-        )
-      })
-      // TODO: never called, since no UPnP listener is active
-      .on('rebooted', (oldBootSeq) => {
-        this.debug(
-          '%s: rebooted (%d -> %d)', zpClient.name,
-          oldBootSeq, zpClient.bootSeq
-        )
-      })
-      .on('addressChanged', (oldAddress) => {
-        this.debug(
-          '%s: IP address changed (%s -> %s)', zpClient.name,
-          oldAddress, zpClient.address
-        )
-      })
-      .on('request', (request) => {
-        this.debug(
-          '%s: request %s: %s %s%s', request.name,
-          request.id, request.method, request.resource,
-          request.action == null ? '' : ' ' + request.action
-        )
-        if (request.parsedBody != null) {
-          this.vdebug(
-            '%s: request %s: %s %s %j', request.name,
-            request.id, request.method, request.url, request.parsedBody
-          )
-          this.vvdebug(
-            '%s: request %s: %s %s (headers: %j) %j', request.name,
-            request.id, request.method, request.url,
-            request.headers, request.body
-          )
-        } else {
-          this.vdebug(
-            '%s: request %s: %s %s', request.name,
-            request.id, request.method, request.url
-          )
-          this.vvdebug(
-            '%s: request %s: %s %s (headers: %j)', request.name,
-            request.id, request.method, request.url, request.headers
-          )
-        }
-      })
-      .on('response', (response) => {
-        this.debug(
-          '%s: request %d: %d %s', response.request.name,
-          response.request.id, response.statusCode, response.statusMessage
-        )
-        if (response.rawBody != null) {
-          this.vvdebug(
-            '%s: request %d: response (headers: %j): %j', response.request.name,
-            response.request.id, response.headers, response.rawBody
-          )
-          this.vdebug(
-            '%s: request %d: response: %j', response.request.name,
-            response.request.id, response.body
-          )
-        }
-      })
-      .on('message', (message) => {
-        const notify = message.device === 'ZonePlayer'
-          ? message.service
-          : message.device + '/' + message.service
-        this.vvdebug(
-          '%s: notify %s/Event: %j', this._clargs.options.host,
-          notify, message.rawBody
-        )
-        this.vdebug(
-          '%s: notify %s/Event: %j', this._clargs.options.host,
-          notify, message.body
-        )
-        this.debug('%s: notify %s/Event', this._clargs.options.host, notify)
-      })
-    return zpClient
-  }
-
   async main () {
     try {
       this._clargs = this.parseArguments()
@@ -790,7 +718,8 @@ class ZpTool extends CommandLineTool {
         .on('close', (url) => { this.debug('closed %s', url) })
         .on('error', (error) => { this.warn(error) })
       this._clargs.options.listener = this.zpListener
-      this.zpClient = await this.createZpClient(this._clargs.options)
+      this._clargs.options.logger = this
+      this.zpClient = new ZpClient(this._clargs.options)
       await this.zpClient.init()
       this.debug(
         '%s: reached using local address %s', this._clargs.options.host,
@@ -801,7 +730,9 @@ class ZpTool extends CommandLineTool {
       this.help = help[this._clargs.command]
       await this[this._clargs.command](this._clargs.args)
     } catch (error) {
-      this.error(error)
+      if (error.request == null) {
+        this.error(error)
+      }
     }
   }
 
@@ -898,9 +829,10 @@ class ZpTool extends CommandLineTool {
   }
 
   async _getInfo (zonePlayer) {
-    const zpClient = this.createZpClient({
+    const zpClient = new ZpClient({
       host: zonePlayer.address,
       id: zonePlayer.id,
+      logger: this,
       timeout: this._clargs.options.timeout
     })
     await zpClient.init()
@@ -1225,9 +1157,49 @@ class ZpTool extends CommandLineTool {
 
   async listAlarms (...args) {
     const parser = new CommandLineParser(this.pkgJson)
-    parser.help('h', 'help', this.help)
-    parser.parse(...args)
-    this.print(await this.zpClient.listAlarms())
+    const clargs = {
+      options: {}
+    }
+    parser
+      .help('h', 'help', this.help)
+      .flag('n', 'noWhiteSpace', () => { clargs.options.noWhiteSpace = true })
+      .flag('s', 'sortKeys', () => { clargs.options.sortKeys = true })
+      .parse(...args)
+    const jsonFormatter = new JsonFormatter(clargs.options)
+    const result = await this.zpClient.listAlarms()
+    const json = jsonFormatter.stringify(result)
+    this.print(json)
+  }
+
+  async alarm (...args) {
+    const parser = new CommandLineParser(this.pkgJson)
+    const clargs = {}
+    parser
+      .help('h', 'help', this.help)
+      .parameter('id', (value) => {
+        clargs.id = OptionParser.toInt('id', value, 0, Infinity, true)
+      })
+      .remaining((list) => {
+        if (list.length > 1) {
+          throw new UsageError('too many arguments')
+        }
+        if (list.length === 1) {
+          clargs.enabled = OptionParser.toBool('enabled', list[0], true)
+        }
+      })
+      .parse(...args)
+    const response = await this.zpClient.listAlarms()
+    const alarm = response?.currentAlarmList?.filter(
+      (alarm) => { return alarm.id === clargs.id }
+    )?.[0]
+    if (alarm == null) {
+      throw new UsageError(`${clargs.id}: alarm not found`)
+    }
+    if (clargs.enabled != null) {
+      alarm.enabled = clargs.enabled ? 1 : 0
+      await this.zpClient.updateAlarm(alarm)
+    }
+    this.print(alarm.enabled ? 'on' : 'off')
   }
 
   async simpleCommand (command, ...args) {

package/lib/ZpXmlParser.js

@@ -109,25 +109,25 @@ class ZpXmlParser {
     const xml2jsParserOptions = {
       explicitArray: false,
       mergeAttrs: true,
-      attrNameProcessors: [this._processKey.bind(this)],
-      attrValueProcessors: [this._processValue.bind(this)],
-      tagNameProcessors: [this._processKey.bind(this)],
-      valueProcessors: [this._processValue.bind(this)]
+      attrNameProcessors: [this.#processKey.bind(this)],
+      attrValueProcessors: [this.#processValue.bind(this)],
+      tagNameProcessors: [this.#processKey.bind(this)],
+      valueProcessors: [this.#processValue.bind(this)]
     }
     this._parser = new Parser(xml2jsParserOptions)
     // this._debug = debug('ZpXmlParser')
   }
 
   async parse (xml) {
-    // this._debug('parse(%j)', xml)
+    this._debug?.('parse(%j)', xml)
     const result = await this._parser.parseStringPromise(xml)
-    return this._process(result)
+    return this.#process(result)
   }
 
   // Convert key to javascript standard key.
-  _processKey (key) {
-    // const oldKey = key
-    // this._debug('processKey(%j)', oldKey)
+  #processKey (key) {
+    const oldKey = key
+    this._debug?.('processKey(%j)', oldKey)
 
     // Get rid of schema tags.
     const a = key.split(':')
@@ -152,14 +152,14 @@ class ZpXmlParser {
       key = replacementKeys[key]
     }
 
-    // this._debug('processKey(%j) => %j', oldKey, key)
+    this._debug?.('processKey(%j) => %j', oldKey, key)
     return key
   }
 
   // Convert value to proper javascript value.
-  _processValue (value, key) {
-    // const oldValue = value
-    // this._debug('processValue(%j, %j)', oldValue, key)
+  #processValue (value, key) {
+    const oldValue = value
+    this._debug?.('processValue(%j, %j)', oldValue, key)
 
     // Convert integer string to integer
     if (/^[0-9]+$/.test(value) && !stringKeys.includes(key)) {
@@ -170,12 +170,25 @@ class ZpXmlParser {
       value = he.decode(value)
     }
 
-    // this._debug('processValue(%j, %j) => %j', oldValue, key, value)
+    this._debug?.('processValue(%j, %j) => %j', oldValue, key, value)
     return value
   }
 
   // Post-process converted XML.
-  async _process (value) {
+  async #process (value) {
+    const oldValue = value
+    this._debug?.('process(%j)', value)
+    try {
+      value = await this.#tryProcess(value)
+    } catch (error) {
+      this._debug?.('process(%j) => error: %j', oldValue, error.message)
+    }
+    this._debug?.('process(%j) => %j', oldValue, value)
+    return value
+  }
+
+  // Post-process converted XML.
+  async #tryProcess (value) {
     // Recursively parse XML strings.
     if (typeof value === 'string' && /^<.*>$/.test(value)) {
       return this.parse(value)
@@ -185,7 +198,7 @@ class ZpXmlParser {
     if (Array.isArray(value)) {
       const list = []
       for (const elt of value) {
-        list.push(await this._process(elt))
+        list.push(await this.#process(elt))
       }
       return list
     }
@@ -202,7 +215,7 @@ class ZpXmlParser {
       const keys = Object.keys(value)
       if (keys.length === 1) {
         if (rootKeys.includes(keys[0])) {
-          return this._process(value[keys[0]])
+          return this.#process(value[keys[0]])
         }
       }
       // Recursively post-process key/value pairs.
@@ -212,7 +225,7 @@ class ZpXmlParser {
         const a = key.match(/^(.+)List$/)
         if (a != null || arrayKeys[key] != null) {
           const childKey = arrayKeys[key] == null ? a[1] : arrayKeys[key]
-          let newValue = await this._process(value[key])
+          let newValue = await this.#process(value[key])
           const listKeys = Object.keys(newValue)
           if (listKeys.length === 1 && listKeys[0] === childKey) {
             newValue = newValue[childKey]
@@ -230,7 +243,7 @@ class ZpXmlParser {
         }
         // Handle e:property.
         if (key === 'e:property') {
-          const newValue = await this._process(value[key])
+          const newValue = await this.#process(value[key])
           if (Array.isArray(newValue)) {
             for (const property of newValue) {
               for (const key in property) {
@@ -248,7 +261,7 @@ class ZpXmlParser {
         if (key === 's:Envelope') {
           if (value[key] != null && value[key]['s:Body'] != null) {
             const keys = Object.keys(value[key]['s:Body'])
-            const newValue = await this._process(
+            const newValue = await this.#process(
               keys.length === 1
                 ? value[key]['s:Body'][keys[0]]
                 : value[key]['s:Body']
@@ -273,13 +286,13 @@ class ZpXmlParser {
         // Handle keys (like volume) with multiple channels.
         if (channelKeys.includes(key) && typeof value[key] === 'object') {
           obj[key] = {}
-          const newValue = [].concat(await this._process(value[key]))
+          const newValue = [].concat(await this.#process(value[key]))
           for (const elt of newValue) {
             obj[key][this._processKey(elt.channel)] = elt.val
           }
           continue
         }
-        obj[key] = await this._process(value[key])
+        obj[key] = await this.#process(value[key])
       }
       return obj
     }

package/package.json

@@ -6,7 +6,7 @@
     "ebaauw"
   ],
   "license": "Apache-2.0",
-  "version": "2.0.0-0",
+  "version": "2.0.0",
   "type": "module",
   "exports": {
     "./*": "./lib/*.js"
@@ -29,7 +29,7 @@
     "node": "^24||^22||^20"
   },
   "dependencies": {
-    "hb-lib-tools": "~3.0.0-0",
+    "hb-lib-tools": "~3.0.0",
     "he": "^1.2.0",
     "xml2js": "~0.6.2"
   },