homebridge-yoto 0.0.16 → 0.0.17

package/lib/playerAccessory.js

@@ -511,13 +511,17 @@ export class YotoPlayerAccessory {
 
   /**
    * Handle status update from MQTT
-   * @param {YotoDeviceStatus} status - Status data
+   * @param {YotoDeviceStatus | {status: YotoDeviceStatus}} statusMessage - Status data or wrapped status
    */
-  handleStatusUpdate (status) {
-    this.log.info(LOG_PREFIX.ACCESSORY, `[${this.device.name}] Received status update:`, JSON.stringify(status, null, 2))
-    this.log.info(LOG_PREFIX.ACCESSORY, `[${this.device.name}] Status - batteryLevel:`, status.batteryLevel)
-    this.log.info(LOG_PREFIX.ACCESSORY, `[${this.device.name}] Status - userVolume:`, status.userVolume)
-    this.log.info(LOG_PREFIX.ACCESSORY, `[${this.device.name}] Status - volume:`, status.volume)
+  handleStatusUpdate (statusMessage) {
+    this.log.info(LOG_PREFIX.ACCESSORY, `[${this.device.name}] Raw MQTT status message:`, JSON.stringify(statusMessage, null, 2))
+
+    // Unwrap status if it's nested under a 'status' property
+    const status = /** @type {YotoDeviceStatus} */ ('status' in statusMessage ? statusMessage.status : statusMessage)
+
+    this.log.info(LOG_PREFIX.ACCESSORY, `[${this.device.name}] Unwrapped status - batteryLevel:`, status.batteryLevel)
+    this.log.info(LOG_PREFIX.ACCESSORY, `[${this.device.name}] Unwrapped status - userVolume:`, status.userVolume)
+    this.log.info(LOG_PREFIX.ACCESSORY, `[${this.device.name}] Unwrapped status - volume:`, status.volume)
 
     this.currentStatus = status
     this.lastUpdateTime = Date.now()
@@ -529,10 +533,15 @@ export class YotoPlayerAccessory {
 
   /**
    * Handle playback events update from MQTT
-   * @param {YotoPlaybackEvents} events - Playback events
+   * @param {YotoPlaybackEvents | {events: YotoPlaybackEvents}} eventsMessage - Playback events or wrapped events
    */
-  handleEventsUpdate (events) {
-    this.log.debug(LOG_PREFIX.ACCESSORY, `[${this.device.name}] Events update received`)
+  handleEventsUpdate (eventsMessage) {
+    this.log.info(LOG_PREFIX.ACCESSORY, `[${this.device.name}] Raw MQTT events message:`, JSON.stringify(eventsMessage, null, 2))
+
+    // Unwrap events if it's nested under an 'events' property
+    const events = /** @type {YotoPlaybackEvents} */ ('events' in eventsMessage ? eventsMessage.events : eventsMessage)
+
+    this.log.info(LOG_PREFIX.ACCESSORY, `[${this.device.name}] Unwrapped events - cardId:`, events.cardId)
     this.currentEvents = events
     this.lastUpdateTime = Date.now()
     this.accessory.context.lastEvents = events
@@ -551,7 +560,7 @@ export class YotoPlayerAccessory {
    * @param {import('./types.js').MqttCommandResponse} response - Command response
    */
   handleCommandResponse (response) {
-    this.log.debug(LOG_PREFIX.ACCESSORY, `[${this.device.name}] Command response:`, response)
+    this.log.info(LOG_PREFIX.ACCESSORY, `[${this.device.name}] Command response:`, response)
   }
 
   /**
@@ -562,16 +571,17 @@ export class YotoPlayerAccessory {
       return
     }
 
-    // Update volume
-    if (this.speakerService) {
+    // Update volume from events, not status
+    if (this.speakerService && this.currentEvents?.volume !== undefined) {
+      const volume = Number(this.currentEvents.volume) || 0
       this.speakerService.updateCharacteristic(
         this.platform.Characteristic.Volume,
-        this.currentStatus.userVolume
+        volume
       )
     }
 
     // Update battery
-    if (this.batteryService) {
+    if (this.batteryService && this.currentStatus.batteryLevel !== undefined) {
       this.batteryService.updateCharacteristic(
         this.platform.Characteristic.BatteryLevel,
         this.currentStatus.batteryLevel
@@ -603,7 +613,7 @@ export class YotoPlayerAccessory {
       }
 
       // Update display brightness
-      if (this.displayService) {
+      if (this.displayService && this.currentStatus.dnowBrightness !== undefined) {
         const isOn = this.currentStatus.dnowBrightness > 0
         this.displayService.updateCharacteristic(
           this.platform.Characteristic.On,
@@ -619,7 +629,7 @@ export class YotoPlayerAccessory {
       }
 
       // Update advanced control switches
-      if (this.bluetoothSwitch) {
+      if (this.bluetoothSwitch && this.currentStatus.bluetoothHp !== undefined) {
         const bluetoothEnabled = this.currentStatus.bluetoothHp
         this.bluetoothSwitch.updateCharacteristic(
           this.platform.Characteristic.On,
@@ -627,7 +637,7 @@ export class YotoPlayerAccessory {
         )
       }
 
-      if (this.btHeadphonesSwitch) {
+      if (this.btHeadphonesSwitch && this.currentStatus.bluetoothHp !== undefined) {
         const btHeadphonesEnabled = this.currentStatus.bluetoothHp
         this.btHeadphonesSwitch.updateCharacteristic(
           this.platform.Characteristic.On,
@@ -789,15 +799,16 @@ export class YotoPlayerAccessory {
    * @returns {Promise<CharacteristicValue>}
    */
   async getVolume () {
-    this.log.info(LOG_PREFIX.ACCESSORY, `[${this.device.name}] getVolume - currentStatus:`, this.currentStatus)
-    this.log.info(LOG_PREFIX.ACCESSORY, `[${this.device.name}] getVolume - userVolume:`, this.currentStatus?.userVolume)
+    this.log.info(LOG_PREFIX.ACCESSORY, `[${this.device.name}] getVolume - currentEvents:`, this.currentEvents)
+    this.log.info(LOG_PREFIX.ACCESSORY, `[${this.device.name}] getVolume - events.volume:`, this.currentEvents?.volume)
 
-    if (!this.currentStatus || this.currentStatus.userVolume === undefined) {
-      this.log.info(LOG_PREFIX.ACCESSORY, `[${this.device.name}] getVolume - returning default: 50`)
+    // Volume comes from events, not status
+    if (!this.currentEvents || this.currentEvents.volume === undefined) {
+      this.log.info(LOG_PREFIX.ACCESSORY, `[${this.device.name}] getVolume - no volume in events, returning default: 50`)
       return 50
     }
-    const volume = Number(this.currentStatus.userVolume) || 50
-    this.log.info(LOG_PREFIX.ACCESSORY, `[${this.device.name}] getVolume - returning:`, volume)
+    const volume = Number(this.currentEvents.volume) || 50
+    this.log.info(LOG_PREFIX.ACCESSORY, `[${this.device.name}] getVolume - returning volume:`, volume)
     return volume
   }
 
@@ -823,10 +834,11 @@ export class YotoPlayerAccessory {
    * @returns {Promise<CharacteristicValue>}
    */
   async getMute () {
-    if (!this.currentStatus || this.currentStatus.userVolume === undefined) {
+    // Volume comes from events, not status
+    if (!this.currentEvents || this.currentEvents.volume === undefined) {
       return false
     }
-    return Number(this.currentStatus.userVolume) === 0
+    return Number(this.currentEvents.volume) === 0
   }
 
   /**
@@ -842,7 +854,7 @@ export class YotoPlayerAccessory {
         await this.mqtt.setVolume(this.device.deviceId, 0)
       } else {
         // Unmute - restore to a reasonable volume if currently 0
-        const currentVolume = this.currentStatus?.userVolume || 0
+        const currentVolume = this.currentEvents?.volume ? Number(this.currentEvents.volume) : 0
         const targetVolume = currentVolume === 0 ? 50 : currentVolume
         await this.mqtt.setVolume(this.device.deviceId, targetVolume)
       }
@@ -951,7 +963,7 @@ export class YotoPlayerAccessory {
    * @returns {Promise<CharacteristicValue>}
    */
   async getDisplayOn () {
-    if (!this.currentStatus) {
+    if (!this.currentStatus || this.currentStatus.dnowBrightness === undefined) {
       return true
     }
     return this.currentStatus.dnowBrightness > 0
@@ -1035,7 +1047,7 @@ export class YotoPlayerAccessory {
    * @returns {Promise<CharacteristicValue>}
    */
   async getBluetoothEnabled () {
-    if (!this.currentStatus) {
+    if (!this.currentStatus || this.currentStatus.bluetoothHp === undefined) {
       return false
     }
     return this.currentStatus.bluetoothHp
@@ -1095,7 +1107,7 @@ export class YotoPlayerAccessory {
    * @returns {Promise<CharacteristicValue>}
    */
   async getBtHeadphonesEnabled () {
-    if (!this.currentStatus) {
+    if (!this.currentStatus || this.currentStatus.bluetoothHp === undefined) {
       return false
     }
     return this.currentStatus.bluetoothHp

package/lib/types.js

@@ -15,43 +15,63 @@
  */
 
 /**
+ * YotoDeviceStatus - ACTUAL structure from MQTT /device/{id}/data/status
+ * Note: This differs from the documented API schema
  * @typedef {Object} YotoDeviceStatus
- * @property {number} statusVersion - Status data version
- * @property {string} fwVersion - Firmware version
- * @property {string} productType - Product type identifier
- * @property {number} batteryLevel - Battery level (0-100)
- * @property {number} als - Ambient light sensor reading
- * @property {number} freeDisk - Free disk space in bytes
- * @property {number} shutdownTimeout - Auto-shutdown timeout in seconds
- * @property {number} dbatTimeout - Display battery timeout
- * @property {number} charging - Charging state (0=not charging, 1=charging)
- * @property {string | null} activeCard - Currently active card ID or null
- * @property {number} cardInserted - Card insertion state (0=none, 1=physical, 2=remote)
- * @property {number} playingStatus - Playing status code
- * @property {boolean} headphones - Whether headphones are connected
- * @property {number} dnowBrightness - Current display brightness
- * @property {number} dayBright - Day mode brightness setting
- * @property {number} nightBright - Night mode brightness setting
- * @property {boolean} bluetoothHp - Bluetooth headphones enabled
- * @property {number} volume - System volume level
- * @property {number} userVolume - User volume level (0-100)
- * @property {'12' | '24'} timeFormat - Time format preference
- * @property {string} nightlightMode - Nightlight mode setting
- * @property {string} temp - Temperature reading
- * @property {number} day - Day mode (0=night, 1=day, -1=unknown)
- */
-
-/**
+ * @property {number} battery - Raw battery voltage (e.g., 3693)
+ * @property {string} [powerCaps] - Power capability flags (e.g., '0x02')
+ * @property {number} batteryLevel - Battery level percentage (0-100)
+ * @property {number} batteryTemp - Battery temperature
+ * @property {string} batteryData - Battery data string (e.g., '0:0:0')
+ * @property {number} batteryLevelRaw - Raw battery level value
+ * @property {number} free - Free memory
+ * @property {number} freeDMA - Free DMA memory
+ * @property {number} free32 - Free 32-bit memory
+ * @property {number} upTime - Device uptime in seconds
+ * @property {number} utcTime - Current UTC time (Unix timestamp)
+ * @property {number} aliveTime - Time device has been alive
+ * @property {number} accelTemp - Accelerometer temperature in Celsius
+ * @property {number} [qiOtp] - Qi charging related field
+ * @property {number} [errorsLogged] - Number of errors logged
+ * @property {string} nightlightMode - Nightlight mode (e.g., 'off')
+ * @property {string} temp - Temperature data string (e.g., '1014:23:318')
+ *
+ * Note: Volume information comes from events, not status!
+ * The following documented fields may exist but haven't been observed in v3 players:
+ * @property {number} [statusVersion] - Status data version
+ * @property {string} [fwVersion] - Firmware version
+ * @property {string} [productType] - Product type identifier
+ * @property {number} [als] - Ambient light sensor reading
+ * @property {number} [freeDisk] - Free disk space in bytes
+ * @property {number} [shutdownTimeout] - Auto-shutdown timeout in seconds
+ * @property {number} [dbatTimeout] - Display battery timeout
+ * @property {number} [charging] - Charging state (0=not charging, 1=charging)
+ * @property {string | null} [activeCard] - Currently active card ID or null
+ * @property {number} [cardInserted] - Card insertion state (0=none, 1=physical, 2=remote)
+ * @property {number} [playingStatus] - Playing status code
+ * @property {boolean} [headphones] - Whether headphones are connected
+ * @property {number} [dnowBrightness] - Current display brightness
+ * @property {number} [dayBright] - Day mode brightness setting
+ * @property {number} [nightBright] - Night mode brightness setting
+ * @property {boolean} [bluetoothHp] - Bluetooth headphones enabled
+ * @property {number} [volume] - System volume level (may be in events instead)
+ * @property {number} [userVolume] - User volume level 0-100 (may be in events instead)
+ * @property {'12' | '24'} [timeFormat] - Time format preference
+ * @property {number} [day] - Day mode (0=night, 1=day, -1=unknown)
+ */
+
+/**
+ * YotoPlaybackEvents - From MQTT /device/{id}/data/events
  * @typedef {Object} YotoPlaybackEvents
  * @property {string} repeatAll - Repeat all setting ("true" or "false")
  * @property {string} streaming - Streaming active ("true" or "false")
- * @property {string} volume - Current volume level
- * @property {string} volumeMax - Maximum volume level
+ * @property {string} volume - Current volume level (0-100 as string)
+ * @property {string} volumeMax - Maximum volume level (0-100 as string)
  * @property {string} playbackWait - Playback wait state ("true" or "false")
  * @property {string} sleepTimerActive - Sleep timer active ("true" or "false")
- * @property {string} eventUtc - Event timestamp (Unix timestamp)
- * @property {string} trackLength - Track duration in seconds
- * @property {string} position - Current playback position in seconds
+ * @property {string} eventUtc - Event timestamp (Unix timestamp as string)
+ * @property {string} trackLength - Track duration in seconds (as string)
+ * @property {string} position - Current playback position in seconds (as string)
  * @property {string} cardId - Active card ID
  * @property {string} source - Playback source (e.g., "card", "remote", "MQTT")
  * @property {string} cardUpdatedAt - Card last updated timestamp (ISO8601)
@@ -59,8 +79,8 @@
  * @property {string} chapterKey - Current chapter key
  * @property {string} trackTitle - Current track title
  * @property {string} trackKey - Current track key
- * @property {string} playbackStatus - Playback status ("playing", "paused", "stopped")
- * @property {string} sleepTimerSeconds - Sleep timer remaining seconds
+ * @property {string} playbackStatus - Playback status (e.g., "playing", "paused", "stopped")
+ * @property {string} sleepTimerSeconds - Remaining sleep timer seconds (as string)
  */
 
 /**

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "homebridge-yoto",
   "description": "Control your Yoto players through Apple HomeKit with real-time MQTT updates",
-  "version": "0.0.16",
+  "version": "0.0.17",
   "author": "Bret Comnes <bcomnes@gmail.com> (https://bret.io)",
   "bugs": {
     "url": "https://github.com/bcomnes/homebridge-yoto/issues"