Fix WoAirPurifier/WoAirPurifierTable BLE parsing: serviceData fallback, mode mapping, createDevice registration (#329)

Author: Copilot

package-lock.json

@@ -2,7 +2,7 @@ import { Buffer } from 'node:buffer'
 
 import { describe, expect, it } from 'vitest'
 
-import { Advertising, ErrorUtils, LogLevel, ValidationUtils, WoAirPurifier, WoPlugMiniEU } from './device.js'
+import { Advertising, ErrorUtils, LogLevel, ValidationUtils, WoAirPurifier, WoPlugMiniEU, WoPlugMiniJP, WoPlugMiniUS } from './device.js'
 
 describe('validationUtils', () => {
   describe('validatePercentage', () => {
@@ -290,6 +290,66 @@ describe('advertising', () => {
       expect(result?.sequence_number).toBe(1)
     })
 
+    it('should parse Air Purifier service data from serviceData-only (no manufacturerData)', () => {
+      // Air Purifier advertising with state data in serviceData (9 bytes), no manufacturerData
+      const serviceData = Buffer.from([
+        0x2B, // '+' model byte
+        0x02, // sequenceNumber
+        0x80 | 0x02, // isOn=true, mode=2
+        0x04, // isAqiValid=true, childLock=false
+        0x32, // speed=50
+        0x02, // aqiLevelRaw=1 (good)
+        0x00, 0x0A, // workTime=10
+        0x00, // errCode=0
+      ])
+
+      const emitLog = () => {}
+      const result = WoAirPurifier.parseServiceData(serviceData, null, emitLog)
+
+      expect(result).not.toBeNull()
+      expect(result?.model).toBe('+')
+      expect(result?.modelName).toBe('WoAirPurifier')
+      expect(result?.isOn).toBe(true)
+      expect(result?.mode).toBe('auto')
+      expect(result?.speed).toBe(50)
+      expect(result?.aqi_level).toBe('good')
+      expect(result?.isAqiValid).toBe(true)
+      expect(result?.child_lock).toBe(false)
+      expect(result?.filter_element_working_time).toBe(10)
+      expect(result?.err_code).toBe(0)
+      expect(result?.sequence_number).toBe(2)
+    })
+
+    it('should map Air Purifier mode=2 to auto, mode=3 to sleep, mode=4 to manual', () => {
+      const makeManufData = (modeByte: number) => Buffer.from([
+        0x59, 0x00, 0x12, 0x34, 0x56, 0x78,
+        0x01, // sequenceNumber
+        modeByte,
+        0x00, // isAqiValid=false, childLock=false
+        0x50, // speed=80
+        0x00, // aqiLevelRaw=0 (excellent)
+        0x00, 0x00, // workTime=0
+        0x00, // errCode=0
+      ])
+
+      const emitLog = () => {}
+
+      const resultAuto = WoAirPurifier.parseServiceData(Buffer.from('+'), makeManufData(0x80 | 0x02), emitLog)
+      expect(resultAuto?.mode).toBe('auto')
+
+      const resultSleep = WoAirPurifier.parseServiceData(Buffer.from('+'), makeManufData(0x80 | 0x03), emitLog)
+      expect(resultSleep?.mode).toBe('sleep')
+
+      const resultManual = WoAirPurifier.parseServiceData(Buffer.from('+'), makeManufData(0x80 | 0x04), emitLog)
+      expect(resultManual?.mode).toBe('manual')
+    })
+
+    it('should return null for Air Purifier when both buffers are insufficient', () => {
+      const emitLog = () => {}
+      const result = WoAirPurifier.parseServiceData(Buffer.from('+'), null, emitLog)
+      expect(result).toBeNull()
+    })
+
     it('should parse Plug Mini EU service data correctly', async () => {
       // bytes 0-8: header/MAC/sequence (unused by parser), bytes 9-13: state/flags/rssi/power
       const manufacturerData = Buffer.from([
@@ -382,5 +442,24 @@ describe('advertising', () => {
       expect(result?.serviceData.model).toBe('l')
       expect(result?.serviceData.modelName).toBe('WoPlugMini')
     })
+
+    const plugMiniClasses = [
+      { name: 'WoPlugMiniJP', cls: WoPlugMiniJP },
+      { name: 'WoPlugMiniEU', cls: WoPlugMiniEU },
+      { name: 'WoPlugMiniUS', cls: WoPlugMiniUS },
+    ] as const
+
+    for (const { name, cls } of plugMiniClasses) {
+      it(`should return null when ${name} manufacturerData is undefined`, async () => {
+        const errors: string[] = []
+        const emitLog = (_level: string, msg: string) => { errors.push(msg) }
+
+        const result = await cls.parseServiceData(undefined, emitLog)
+
+        expect(result).toBeNull()
+        expect(errors.length).toBeGreaterThan(0)
+        expect(errors[0]).toContain('should be 14')
+      })
+    }
   })
 })

src/device.test.ts

@@ -2532,7 +2532,7 @@ export class WoPlugMiniJP extends SwitchbotDevice {
 
   /**
    * Parses the service data for WoPlugMini JP.
-   * @param {Buffer} manufacturerData - The manufacturer data buffer.
+   * @param {Buffer | undefined} manufacturerData - The manufacturer data buffer, or undefined if not present.
    * @param {Function} emitLog - The function to emit log messages.
    * @returns {Promise<plugMiniJPServiceData | null>} - Parsed service data or null if invalid.
    */
@@ -2654,7 +2654,7 @@ export class WoPlugMiniEU extends SwitchbotDevice {
 
   /**
    * Parses the service data for WoPlugMini EU.
-   * @param {Buffer} manufacturerData - The manufacturer data buffer.
+   * @param {Buffer | undefined} manufacturerData - The manufacturer data buffer, or undefined if not present.
    * @param {Function} emitLog - The function to emit log messages.
    * @returns {Promise<plugMiniEUServiceData | null>} - Parsed service data or null if invalid.
    */
@@ -2775,7 +2775,7 @@ export class WoPlugMiniUS extends SwitchbotDevice {
 
   /**
    * Parses the service data for WoPlugMini US.
-   * @param {Buffer} manufacturerData - The manufacturer data buffer.
+   * @param {Buffer | undefined} manufacturerData - The manufacturer data buffer, or undefined if not present.
    * @param {Function} emitLog - The function to emit log messages.
    * @returns {Promise<plugMiniUSServiceData | null>} - Parsed service data or null if invalid.
    */
@@ -3969,13 +3969,17 @@ export class WoAirPurifier extends SwitchbotDevice {
    * @returns {airPurifierServiceData | null} - The parsed service data or null.
    */
   static parseServiceData(serviceData: Buffer | null, manufacturerData: Buffer | null, emitLog?: (level: string, message: string) => void): airPurifierServiceData | null {
-    if (!manufacturerData || manufacturerData.length < 14) {
-      return null
-    }
+    let deviceData: Buffer | null = null
 
-    const deviceData = manufacturerData.subarray(6)
+    if (manufacturerData && manufacturerData.length >= 14) {
+      // Primary path: device state is in manufacturerData starting at byte 6
+      deviceData = manufacturerData.subarray(6)
+    } else if (serviceData && serviceData.length >= 9) {
+      // Fallback path: device state is in serviceData starting at byte 1 (after model byte)
+      deviceData = serviceData.subarray(1)
+    }
 
-    if (deviceData.length < 8) {
+    if (!deviceData || deviceData.length < 8) {
       return null
     }
 
@@ -4009,8 +4013,8 @@ export class WoAirPurifier extends SwitchbotDevice {
         modeString = AIR_PURIFIER_MODES.LEVEL_3
       }
     } else if (mode > 1 && mode <= 4) {
-      const modeMap = [null, null, 'auto', 'sleep', 'manual']
-      modeString = modeMap[mode + 2] || null
+      const modeMap = [null, null, AIR_PURIFIER_MODES.AUTO, AIR_PURIFIER_MODES.SLEEP, AIR_PURIFIER_MODES.MANUAL]
+      modeString = modeMap[mode] || null
     }
 
     if (emitLog) {
@@ -4119,13 +4123,17 @@ export class WoAirPurifierTable extends SwitchbotDevice {
    * @returns {airPurifierTableServiceData | null} - The parsed service data or null.
    */
   static parseServiceData(serviceData: Buffer | null, manufacturerData: Buffer | null, emitLog?: (level: string, message: string) => void): airPurifierTableServiceData | null {
-    if (!manufacturerData || manufacturerData.length < 14) {
-      return null
-    }
+    let deviceData: Buffer | null = null
 
-    const deviceData = manufacturerData.subarray(6)
+    if (manufacturerData && manufacturerData.length >= 14) {
+      // Primary path: device state is in manufacturerData starting at byte 6
+      deviceData = manufacturerData.subarray(6)
+    } else if (serviceData && serviceData.length >= 9) {
+      // Fallback path: device state is in serviceData starting at byte 1 (after model byte)
+      deviceData = serviceData.subarray(1)
+    }
 
-    if (deviceData.length < 8) {
+    if (!deviceData || deviceData.length < 8) {
       return null
     }
 
@@ -4159,8 +4167,8 @@ export class WoAirPurifierTable extends SwitchbotDevice {
         modeString = AIR_PURIFIER_MODES.LEVEL_3
       }
     } else if (mode > 1 && mode <= 4) {
-      const modeMap = [null, null, 'auto', 'sleep', 'manual']
-      modeString = modeMap[mode + 2] || null
+      const modeMap = [null, null, AIR_PURIFIER_MODES.AUTO, AIR_PURIFIER_MODES.SLEEP, AIR_PURIFIER_MODES.MANUAL]
+      modeString = modeMap[mode] || null
     }
 
     if (emitLog) {

src/device.ts

@@ -6,7 +6,7 @@ import type { ad, NobleTypes, onadvertisement, ondiscover, Params, Rule } from '
 
 import { EventEmitter } from 'node:events'
 
-import { Advertising, LogLevel, SwitchBotBLEModel, SwitchbotDevice, WoBlindTilt, WoBulb, WoCeilingLight, WoContact, WoCurtain, WoHand, WoHub2, WoHumi, WoHumi2, WoIOSensorTH, WoKeypad, WoLeak, WoPlugMiniEU, WoPlugMiniJP, WoPlugMiniUS, WoPresence, WoRelaySwitch1, WoRelaySwitch1PM, WoRemote, WoSensorTH, WoSensorTHPlus, WoSensorTHPro, WoSensorTHProCO2, WoSmartLock, WoSmartLockPro, WoSmartLockUltra, WoStrip } from './device.js'
+import { Advertising, LogLevel, SwitchBotBLEModel, SwitchbotDevice, WoAirPurifier, WoAirPurifierTable, WoBlindTilt, WoBulb, WoCeilingLight, WoContact, WoCurtain, WoHand, WoHub2, WoHumi, WoHumi2, WoIOSensorTH, WoKeypad, WoLeak, WoPlugMiniEU, WoPlugMiniJP, WoPlugMiniUS, WoPresence, WoRelaySwitch1, WoRelaySwitch1PM, WoRemote, WoSensorTH, WoSensorTHPlus, WoSensorTHPro, WoSensorTHProCO2, WoSmartLock, WoSmartLockPro, WoSmartLockUltra, WoStrip } from './device.js'
 import { parameterChecker } from './parameter-checker.js'
 import { DEFAULT_DISCOVERY_DURATION, PRIMARY_SERVICE_UUID_LIST } from './settings.js'
 
@@ -238,6 +238,8 @@ export class SwitchBotBLE extends EventEmitter {
         case SwitchBotBLEModel.Keypad: return new WoKeypad(peripheral, this.noble)
         case SwitchBotBLEModel.RelaySwitch1: return new WoRelaySwitch1(peripheral, this.noble)
         case SwitchBotBLEModel.RelaySwitch1PM: return new WoRelaySwitch1PM(peripheral, this.noble)
+        case SwitchBotBLEModel.AirPurifier: return new WoAirPurifier(peripheral, this.noble)
+        case SwitchBotBLEModel.AirPurifierTable: return new WoAirPurifierTable(peripheral, this.noble)
         default: return new SwitchbotDevice(peripheral, this.noble)
       }
     }