@homebridge-plugins/homebridge-ewelink 12.7.1-beta.0 → 12.8.1-beta.0

package/CHANGELOG.md

@@ -2,6 +2,15 @@
 
 All notable changes to `@homebridge-plugins/homebridge-ewelink` will be documented in this file.
 
+## v12.8.1 (Unreleased)
+
+### Changes
+
+- determine debug mode from `-D` flag
+- updated dependencies
+- feat: adds support for SAWF-08P (#729) (@say4n)
+- updated dependencies + lint rules
+
 ## v12.8.0 (2025-12-05)
 
 ### Changes

package/eslint.config.js

@@ -18,19 +18,18 @@ export default antfu(
         'error',
         {
           groups: [
-            'type',
-            'internal-type',
+            ['type-builtin', 'type-external', 'type-internal'],
+            ['type-parent', 'type-sibling', 'type-index'],
             'builtin',
             'external',
             'internal',
-            ['parent-type', 'sibling-type', 'index-type'],
             ['parent', 'sibling', 'index'],
-            'object',
+            'side-effect',
             'unknown',
           ],
           order: 'asc',
           type: 'natural',
-          newlinesBetween: 'always',
+          newlinesBetween: 1,
         },
       ],
       'perfectionist/sort-named-exports': 'error',

package/lib/device/index.js

@@ -16,6 +16,7 @@ import devicePanel from './panel.js'
 import deviceRfBridge from './rf-bridge.js'
 import deviceRfButton from './rf-button.js'
 import deviceRfSensor from './rf-sensor.js'
+import deviceSensorAirQuality from './sensor-air-quality.js'
 import deviceSensorAmbient from './sensor-ambient.js'
 import deviceSensorContact from './sensor-contact.js'
 import deviceSensorTempHumi from './sensor-temp-humi.js'
@@ -49,6 +50,7 @@ export default {
   deviceRfBridge,
   deviceRfButton,
   deviceRfSensor,
+  deviceSensorAirQuality,
   deviceSensorAmbient,
   deviceSensorContact,
   deviceSensorTempHumi,

package/lib/device/sensor-air-quality.js

@@ -0,0 +1,252 @@
+import platformConsts from '../utils/constants.js'
+import { hasProperty, parseError } from '../utils/functions.js'
+
+export default class {
+  constructor(platform, accessory) {
+    // Set up variables from the platform
+    this.hapChar = platform.api.hap.Characteristic
+    this.hapServ = platform.api.hap.Service
+    this.hapErr = platform.api.hap.HapStatusError
+    this.lang = platform.lang
+    this.log = platform.log
+    this.platform = platform
+
+    // Set up variables from the accessory
+    this.name = accessory.displayName
+    this.accessory = accessory
+
+    // Initially set the online flag as true (to be then updated as false if necessary)
+    this.isOnline = true
+
+    // Set up custom variables for this device type
+    const deviceConf = platform.deviceConf[accessory.context.eweDeviceId] || {}
+    this.tempOffset = deviceConf.offset || platformConsts.defaultValues.offset
+    this.tempOffsetFactor = deviceConf.offsetFactor
+    this.humiOffset = deviceConf && deviceConf.humidityOffset
+      ? Number.parseInt(deviceConf.humidityOffset, 10)
+      : platformConsts.defaultValues.humidityOffset
+    this.humiOffsetFactor = deviceConf.humidityOffsetFactor
+
+    // Set the correct logging variables for this accessory
+    switch (deviceConf.overrideLogging) {
+      case 'standard':
+        this.enableLogging = true
+        this.enableDebugLogging = false
+        break
+      case 'debug':
+        this.enableLogging = true
+        this.enableDebugLogging = true
+        break
+      case 'disable':
+        this.enableLogging = false
+        this.enableDebugLogging = false
+        break
+      default:
+        this.enableLogging = !platform.config.disableDeviceLogging
+        this.enableDebugLogging = platform.config.debug
+        break
+    }
+
+    // Add the temperature sensor service if it doesn't already exist
+    this.tempService = this.accessory.getService(this.hapServ.TemperatureSensor)
+      || this.accessory.addService(this.hapServ.TemperatureSensor)
+
+    // Set custom properties of the current temperature characteristic
+    this.tempService.getCharacteristic(this.hapChar.CurrentTemperature).setProps({
+      minStep: 0.1,
+    })
+    this.cacheTemp = this.tempService.getCharacteristic(this.hapChar.CurrentTemperature).value
+    this.updateCache()
+
+    // Add the humidity sensor service if it doesn't already exist
+    this.humiService = this.accessory.getService(this.hapServ.HumiditySensor)
+      || this.accessory.addService(this.hapServ.HumiditySensor)
+    this.cacheHumi = this.humiService.getCharacteristic(this.hapChar.CurrentRelativeHumidity).value
+
+    // Add the air quality sensor service if it doesn't already exist
+    this.airQualityService = this.accessory.getService(this.hapServ.AirQualitySensor)
+      || this.accessory.addService(this.hapServ.AirQualitySensor)
+
+    // Add the carbon dioxide sensor service if it doesn't already exist
+    this.co2Service = this.accessory.getService(this.hapServ.CarbonDioxideSensor)
+      || this.accessory.addService(this.hapServ.CarbonDioxideSensor)
+    this.cacheCO2 = this.co2Service.getCharacteristic(this.hapChar.CarbonDioxideLevel).value
+
+    // Add the get handlers only if the user hasn't disabled the disableNoResponse setting
+    if (!platform.config.disableNoResponse) {
+      this.tempService
+        .getCharacteristic(this.hapChar.CurrentTemperature)
+        .setProps({
+          minStep: 0.1,
+        })
+        .onGet(() => {
+          if (!this.isOnline) {
+            throw new this.hapErr(-70402)
+          }
+          return this.tempService.getCharacteristic(this.hapChar.CurrentTemperature).value
+        })
+      this.humiService.getCharacteristic(this.hapChar.CurrentRelativeHumidity).onGet(() => {
+        if (!this.isOnline) {
+          throw new this.hapErr(-70402)
+        }
+        return this.humiService.getCharacteristic(this.hapChar.CurrentRelativeHumidity).value
+      })
+      this.airQualityService.getCharacteristic(this.hapChar.AirQuality).onGet(() => {
+        if (!this.isOnline) {
+          throw new this.hapErr(-70402)
+        }
+        return this.airQualityService.getCharacteristic(this.hapChar.AirQuality).value
+      })
+      this.co2Service.getCharacteristic(this.hapChar.CarbonDioxideDetected).onGet(() => {
+        if (!this.isOnline) {
+          throw new this.hapErr(-70402)
+        }
+        return this.co2Service.getCharacteristic(this.hapChar.CarbonDioxideDetected).value
+      })
+    }
+
+    // Pass the accessory to Fakegato to set up with Eve
+    this.accessory.eveService = new platform.eveService('custom', this.accessory, {
+      log: () => {},
+    })
+
+    // Output the customised options to the log
+    const normalLogging = this.enableLogging ? 'standard' : 'disable'
+    const opts = JSON.stringify({
+      humidityOffset: this.humiOffset,
+      humidityOffsetFactor: this.humiOffsetFactor,
+      logging: this.enableDebugLogging ? 'debug' : normalLogging,
+      offset: this.tempOffset,
+      offsetFactor: this.tempOffsetFactor,
+    })
+    this.log('[%s] %s %s.', this.name, this.lang.devInitOpts, opts)
+  }
+
+  // Convert CO2 ppm to HomeKit AirQuality enum
+  // 0: Unknown, 1: Excellent, 2: Good, 3: Fair, 4: Inferior, 5: Poor
+  co2ToAirQuality(co2) {
+    if (co2 <= 400) {
+      return 1 // Excellent
+    }
+    if (co2 <= 700) {
+      return 2 // Good
+    }
+    if (co2 <= 1000) {
+      return 3 // Fair
+    }
+    if (co2 <= 2000) {
+      return 4 // Inferior
+    }
+    return 5 // Poor
+  }
+
+  async externalUpdate(params) {
+    try {
+      if (hasProperty(params, 'temperature')) {
+        let newTemp = Number(params.temperature)
+        if (this.tempOffsetFactor) {
+          newTemp *= this.tempOffset
+        } else {
+          newTemp += this.tempOffset
+        }
+        if (newTemp !== this.cacheTemp) {
+          this.cacheTemp = newTemp
+          this.tempService.updateCharacteristic(this.hapChar.CurrentTemperature, this.cacheTemp)
+          this.accessory.eveService.addEntry({ temp: this.cacheTemp })
+          if (params.updateSource && this.enableLogging) {
+            this.log('[%s] %s [%s°C].', this.name, this.lang.curTemp, this.cacheTemp)
+          }
+
+          // Update the cache file with the new temperature
+          this.updateCache()
+        }
+      }
+      if (hasProperty(params, 'humidity')) {
+        let newHumi = Number.parseFloat(params.humidity)
+        if (this.humiOffsetFactor) {
+          newHumi *= this.humiOffset
+        } else {
+          newHumi += this.humiOffset
+        }
+        newHumi = Math.max(Math.min(newHumi, 100), 0)
+        if (newHumi !== this.cacheHumi) {
+          this.cacheHumi = newHumi
+          this.humiService.updateCharacteristic(
+            this.hapChar.CurrentRelativeHumidity,
+            this.cacheHumi,
+          )
+          this.accessory.eveService.addEntry({ humidity: this.cacheHumi })
+          if (params.updateSource && this.enableLogging) {
+            this.log('[%s] %s [%s%].', this.name, this.lang.curHumi, this.cacheHumi)
+          }
+        }
+      }
+      if (hasProperty(params, 'co2')) {
+        const newCO2 = Number.parseInt(params.co2, 10)
+        if (newCO2 !== this.cacheCO2) {
+          this.cacheCO2 = newCO2
+
+          // Update CO2 level on the carbon dioxide sensor
+          this.co2Service.updateCharacteristic(this.hapChar.CarbonDioxideLevel, this.cacheCO2)
+
+          // CO2 detected if above 1000 ppm (typical threshold)
+          const co2Detected = this.cacheCO2 > 1000 ? 1 : 0
+          this.co2Service.updateCharacteristic(this.hapChar.CarbonDioxideDetected, co2Detected)
+
+          // Update air quality based on CO2 levels
+          const airQuality = this.co2ToAirQuality(this.cacheCO2)
+          this.airQualityService.updateCharacteristic(this.hapChar.AirQuality, airQuality)
+          this.airQualityService.updateCharacteristic(this.hapChar.CarbonDioxideLevel, this.cacheCO2)
+
+          if (params.updateSource && this.enableLogging) {
+            this.log('[%s] %s [%s ppm].', this.name, this.lang.curCO2, this.cacheCO2)
+          }
+        }
+      }
+    } catch (err) {
+      this.platform.deviceUpdateError(this.accessory, err, false)
+    }
+  }
+
+  async updateCache() {
+    // Don't continue if the storage client hasn't initialised properly
+    if (!this.platform.storageClientData) {
+      return
+    }
+
+    // Attempt to save the new temperature to the cache
+    try {
+      await this.platform.storageData.setItem(
+        `${this.accessory.context.eweDeviceId}_temp`,
+        this.cacheTemp,
+      )
+    } catch (err) {
+      if (this.enableLogging) {
+        this.log.warn('[%s] %s %s.', this.name, this.lang.storageWriteErr, parseError(err))
+      }
+    }
+  }
+
+  currentState() {
+    const toReturn = {}
+    toReturn.services = ['temperature', 'humidity', 'airQuality', 'carbonDioxide']
+    toReturn.temperature = {
+      current: this.tempService.getCharacteristic(this.hapChar.CurrentTemperature).value,
+    }
+    toReturn.humidity = {
+      current: this.humiService.getCharacteristic(this.hapChar.CurrentRelativeHumidity).value,
+    }
+    toReturn.airQuality = {
+      current: this.airQualityService.getCharacteristic(this.hapChar.AirQuality).value,
+    }
+    toReturn.carbonDioxide = {
+      level: this.co2Service.getCharacteristic(this.hapChar.CarbonDioxideLevel).value,
+      detected: this.co2Service.getCharacteristic(this.hapChar.CarbonDioxideDetected).value,
+    }
+    return toReturn
+  }
+
+  markStatus(isOnline) {
+    this.isOnline = isOnline
+  }
+}

package/lib/platform.js

@@ -38,7 +38,7 @@ export default class {
     try {
       this.api = api
       this.log = log
-      this.isBeta = plugin.version.includes('beta')
+      this.isBeta = process.argv.includes('-D')
       this.apiClient = false
       this.apiServer = false
       this.httpClient = false
@@ -449,14 +449,6 @@ export default class {
       if (this.isBeta) {
         this.log.debug = this.log
         this.log.debugWarn = this.log.warn
-
-        // Log that using a beta will generate a lot of debug logs
-        if (this.isBeta) {
-          const divide = '*'.repeat(this.lang.beta.length + 1) // don't forget the full stop (+1!)
-          this.log.warn(divide)
-          this.log.warn(`${this.lang.beta}.`)
-          this.log.warn(divide)
-        }
       } else {
         this.log.debug = () => {}
         this.log.debugWarn = () => {}
@@ -1222,6 +1214,16 @@ export default class {
         this.applyAccessoryLogging(accessory)
         accessory.control = new deviceTypes.deviceSensorTempHumi(this, accessory)
         /** */
+      } else if (platformConsts.devices.sensorAirQuality.includes(uiid)) {
+        /**
+         *************************
+         SENSOR [AIR QUALITY-SAWF-08P]
+         **************************
+         */
+        accessory = devicesInHB.get(uuid) || this.addAccessory(device, `${device.deviceid}SWX`)
+        this.applyAccessoryLogging(accessory)
+        accessory.control = new deviceTypes.deviceSensorAirQuality(this, accessory)
+        /** */
       } else if (device.showAs === 'heater') {
         /**
          *****************

package/lib/utils/constants.js

@@ -328,6 +328,7 @@ export default {
     sensorContact: [102, 154],
     sensorAmbient: [15, 181],
     sensorTempHumi: [18],
+    sensorAirQuality: [266],
     thermostat: [127],
     airConditioner: [151],
     panel: [133, 195],
@@ -367,6 +368,7 @@ export default {
     'cctBrightness',
     'channel',
     'cmd',
+    'co2',
     'color',
     'colorB',
     'colorG',
@@ -515,6 +517,7 @@ export default {
     243: 1, // Zigbee Bridge Ultra
     258: 1, // Additional Cover device
     262: 4, // CK-BL602-SWP1-02 (4-channel switch with power monitoring)
+    266: 1, // SAWF-08P Air Quality Sensor (CO2, Temperature, Humidity)
     1000: 1, // "zigbee_ON_OFF_SWITCH_1000" (button device)
     1009: 1, // "" (Some sort of single switch device)
     1256: 1, // "ZIGBEE_SINGLE_SWITCH"

package/lib/utils/lang-en.js

@@ -2,7 +2,6 @@ export default {
   apiListenErr: 'Internal API server error',
   apiListening: 'Internal API listening on port',
   apiShutdown: 'Internal API gracefully shutdown',
-  beta: 'You are using a beta version of the plugin - you will experience more logging than normal',
   buttonDouble: 'double press',
   buttonLong: 'long press',
   buttonNotFound: 'rf button not found (restart Homebridge)',
@@ -23,6 +22,7 @@ export default {
   contactYes: 'contact detected',
   curBatt: 'current battery',
   curBright: 'current brightness',
+  curCO2: 'current CO2',
   curColour: 'current colour',
   curCool: 'current cooling',
   curCurr: 'current current',

package/lib/utils/lang-fr.js

@@ -2,7 +2,6 @@ export default {
   apiListenErr: 'Erreur de serveur d\'API interne',
   apiListening: 'API interne à l\'écoute sur le port',
   apiShutdown: 'L\'API interne s\'arrête normalement',
-  beta: 'You are using a beta version of the plugin - you will experience more logging than normal',
   buttonDouble: 'appui double',
   buttonLong: 'appui long',
   buttonNotFound: 'rf button non trouvé (veuillez redémarrer Homebridge)',
@@ -23,6 +22,7 @@ export default {
   contactYes: 'contact detecté',
   curBatt: 'batterie actuelle',
   curBright: 'luminosité actuelle',
+  curCO2: 'CO2 actuel',
   curColour: 'couleur actuelle',
   curCool: 'refroidissement actuel',
   curCurr: 'actuel actuel',

package/lib/utils/lang-th.js

@@ -2,7 +2,6 @@ export default {
   apiListenErr: 'ข้อผิดพลาดเซิร์ฟเวอร์ API ภายใน',
   apiListening: 'การฟัง API ภายในบนพอร์ต',
   apiShutdown: 'API ภายในปิดได้อย่างสมบูรณ์',
-  beta: 'You are using a beta version of the plugin - you will experience more logging than normal',
   buttonDouble: 'กดสองครั้ง',
   buttonLong: 'กดค้าง',
   buttonNotFound: 'ไม่พบปุ่ม rf (รีสตาร์ท Homebridge)',
@@ -23,6 +22,7 @@ export default {
   contactYes: 'ตรวจพบการติดต่อแล้ว',
   curBatt: 'สถานะแบตเตอรี่',
   curBright: 'ความสว่างในตอนนี้',
+  curCO2: 'CO2 ตอนนี้',
   curColour: 'สีตอนนี้',
   curCool: 'ความเย็นในตอนนี้',
   curCurr: 'กระแสในตอนนี้',

package/package.json

@@ -3,7 +3,7 @@
   "displayName": "Homebridge eWeLink",
   "alias": "eWeLink",
   "type": "module",
-  "version": "12.7.1-beta.0",
+  "version": "12.8.1-beta.0",
   "description": "Homebridge plugin to integrate eWeLink devices into HomeKit.",
   "author": {
     "name": "bwp91",
@@ -64,11 +64,11 @@
     "@homebridge/plugin-ui-utils": "^2.1.2",
     "axios": "^1.13.2",
     "node-persist": "^4.0.4",
-    "p-queue": "^9.0.1",
+    "p-queue": "^9.1.0",
     "websocket-as-promised": "^3.0.1",
-    "ws": "^8.18.3"
+    "ws": "^8.19.0"
   },
   "devDependencies": {
-    "@antfu/eslint-config": "^6.4.2"
+    "@antfu/eslint-config": "^7.2.0"
   }
 }