homebridge-winix-purifiers 2.2.0 → 2.2.2

package/README.md

@@ -31,7 +31,7 @@
   HomeKit.
 - **Filter Management**: Exposes the remaining filter life and provides an alert when it's time to change the filter,
   configurable to trigger at a specified percentage of remaining filter life.
-- **Efficiency**: Features Winix API response caching to minimize requests and avoid rate limiting.
+- **Efficiency**: Polls the Winix API in the background on a configurable interval to minimize requests and keep state fresh.
 - **Reliability**: Automatically refreshes device list on a configurable interval to ensure devices are always
   up-to-date.
 - **Seamless Authentication**: Automatically refreshes your Winix authentication token in the background, so you no
@@ -78,7 +78,8 @@ Simply provide your Winix account credentials for automatic device discovery and
 
 <img src="./assets/link-account.gif" alt="Link Account" />
 
-### Manual Configuration
+<details>
+<summary><h3>Manual Configuration</h3></summary>
 
 While not recommended, if manual setup is required, add the following to the `platforms` section of your `config.json`:
 
@@ -144,7 +145,10 @@ While not recommended, if manual setup is required, add the following to the `pl
 | `deviceOverrides[].nameSleepSwitch`        | `"Sleep"`          | The display name of the Sleep switch. Optional.                                                                          |
 | `platform`                                 | `"WinixPurifiers"` | Must always be `"WinixPurifiers"` in order for the plugin to load this config.                                           |
 
-### Encrypting Your Password (For Manual Setup and HOOBS Users)
+</details>
+
+<details>
+<summary><h3>Encrypting Your Password (For Manual Setup and HOOBS Users)</h3></summary>
 
 If you're configuring the plugin manually or using HOOBS, you need to store your Winix password securely in the
 configuration file. To do this, you must first encrypt your password using the provided `encrypt-password` script.
@@ -189,9 +193,12 @@ The script will output your encrypted password. Copy the result and paste it int
 
 This ensures that your password is securely stored within the configuration file.
 
+</details>
+
 ## FAQ
 
-### Using HOOBS?
+<details>
+<summary><h3>Using HOOBS?</h3></summary>
 
 If you're using [HOOBS](https://hoobs.org), you can install the plugin directly from the HOOBS interface. You will not
 be able to use the custom configuration UI, since it is not supported in HOOBS. You will need to use the manual
@@ -201,6 +208,8 @@ details on obtaining the required `auth` values. See
 [Encrypting Your Password](#encrypting-your-password-for-manual-setup-and-hoobs-users) for instructions on encrypting
 your Winix password.
 
+</details>
+
 ### Missing “Auto/Manual” switch in Home app?
 
 Please see [this issue](https://github.com/regaw-leinad/homebridge-winix-purifiers/issues/1) for more details.

package/dist/accessory.js

@@ -14,7 +14,7 @@ const DEFAULT_POLL_INTERVAL_SECONDS = 30;
 const MIN_POLL_INTERVAL_SECONDS = 15;
 const MIN_AMBIENT_LIGHT = 0.0001;
 class WinixPurifierAccessory {
-    constructor(platform, config, accessory, override, log) {
+    constructor(platform, config, accessory, override, log, deviceCount) {
         this.platform = platform;
         this.config = config;
         this.accessory = accessory;
@@ -24,8 +24,13 @@ class WinixPurifierAccessory {
         this.Characteristic = this.platform.Characteristic;
         const { deviceId, deviceAlias } = accessory.context.device;
         const configuredSeconds = config.pollIntervalSeconds ?? DEFAULT_POLL_INTERVAL_SECONDS;
-        const pollIntervalMs = Math.max(configuredSeconds, MIN_POLL_INTERVAL_SECONDS) * 1000;
-        this.device = new device_1.Device(deviceId, pollIntervalMs, this.log);
+        const minForDeviceCount = deviceCount * 10;
+        const effectiveSeconds = Math.max(configuredSeconds, MIN_POLL_INTERVAL_SECONDS, minForDeviceCount);
+        if (effectiveSeconds > configuredSeconds) {
+            this.log.info(`Poll interval adjusted from ${configuredSeconds}s to ${effectiveSeconds}s to avoid Winix API rate limiting with ${deviceCount} device(s)`);
+        }
+        const pollIntervalMs = effectiveSeconds * 1000;
+        this.device = new device_1.Device(deviceId, pollIntervalMs, this.log, this.platform.client);
         this.servicesInUse = new Set();
         const deviceSerial = override?.serialNumber ?? 'WNXAI00000000';
         const deviceName = override?.nameDevice ?? deviceAlias;

package/dist/device.js

@@ -6,10 +6,11 @@ const MAX_BACKOFF_MS = 5 * 60 * 1000;
 const COMMAND_DELAY_MS = 1500;
 const UNREACHABLE_THRESHOLD = 3;
 class Device {
-    constructor(deviceId, pollIntervalMs, log) {
+    constructor(deviceId, pollIntervalMs, log, client) {
         this.deviceId = deviceId;
         this.pollIntervalMs = pollIntervalMs;
         this.log = log;
+        this.client = client;
         this.hasReceivedData = false;
         this.pollTimer = null;
         this.consecutiveFailures = 0;
@@ -33,13 +34,17 @@ class Device {
     async initialFetch() {
         try {
             this.log.debug('device:initialFetch()');
-            const newState = await winix_api_1.WinixAPI.getDeviceStatus(this.deviceId);
+            const newState = await this.client.getDeviceStatus(this.deviceId);
             Object.assign(this.state, newState);
             this.hasReceivedData = true;
             this.consecutiveFailures = 0;
             this.log.debug('device:initialFetch()', JSON.stringify(this.state));
         }
         catch (e) {
+            if (e instanceof winix_api_1.RateLimitError) {
+                this.log.warn('device:initialFetch() rate limited, using defaults');
+                return;
+            }
             this.log.warn('device:initialFetch() failed, using defaults:', e.message);
         }
     }
@@ -92,7 +97,7 @@ class Device {
             return;
         }
         this.log.debug('device:setPower()', initialPower, value);
-        await winix_api_1.WinixAPI.setPower(this.deviceId, value);
+        await this.client.setPower(this.deviceId, value);
         this.state.power = value;
         // Side effects observed from device testing
         if (value === winix_api_1.Power.Off) {
@@ -110,7 +115,7 @@ class Device {
             return;
         }
         this.log.debug('device:setMode(%s)', value);
-        await winix_api_1.WinixAPI.setMode(this.deviceId, value);
+        await this.client.setMode(this.deviceId, value);
         this.state.mode = value;
         // Side effects observed from device testing
         if (value === winix_api_1.Mode.Auto) {
@@ -127,7 +132,7 @@ class Device {
             await this.setMode(winix_api_1.Mode.Manual);
             await new Promise(r => setTimeout(r, COMMAND_DELAY_MS));
         }
-        await winix_api_1.WinixAPI.setAirflow(this.deviceId, value);
+        await this.client.setAirflow(this.deviceId, value);
         this.state.airflow = value;
         // Side effects observed from device testing
         if (value === winix_api_1.Airflow.Sleep) {
@@ -137,7 +142,7 @@ class Device {
     async setPlasmawave(value) {
         this.log.debug('device:setPlasmawave()', value);
         await this.ensureOn();
-        await winix_api_1.WinixAPI.setPlasmawave(this.deviceId, value);
+        await this.client.setPlasmawave(this.deviceId, value);
         this.state.plasmawave = value;
     }
     // Private methods
@@ -150,7 +155,7 @@ class Device {
     async poll() {
         try {
             this.log.debug('device:poll()');
-            const newState = await winix_api_1.WinixAPI.getDeviceStatus(this.deviceId);
+            const newState = await this.client.getDeviceStatus(this.deviceId);
             Object.assign(this.state, newState);
             this.hasReceivedData = true;
             this.consecutiveFailures = 0;
@@ -158,6 +163,11 @@ class Device {
             this.onUpdate?.();
         }
         catch (e) {
+            if (e instanceof winix_api_1.RateLimitError) {
+                this.log.warn('device:poll() rate limited, retrying on next interval');
+                this.schedulePoll(this.pollIntervalMs);
+                return;
+            }
             this.consecutiveFailures++;
             const backoffMs = Math.min(this.pollIntervalMs * Math.pow(2, this.consecutiveFailures), MAX_BACKOFF_MS);
             this.log.error(`device:poll() error: ${e.message} (retry in ${Math.round(backoffMs / 1000)}s)`);

package/dist/platform.js

@@ -4,6 +4,7 @@ exports.WinixPurifierPlatform = void 0;
 const winix_1 = require("./winix");
 const settings_1 = require("./settings");
 const accessory_1 = require("./accessory");
+const winix_api_1 = require("winix-api");
 const logger_1 = require("./logger");
 const errors_1 = require("./errors");
 const encryption_1 = require("./encryption");
@@ -21,6 +22,7 @@ class WinixPurifierPlatform {
         this.handlers = new Map();
         this.deviceOverrides = (this.config.deviceOverrides ?? [])
             .reduce((m, o) => m.set(o.deviceId, o), new Map());
+        this.client = new winix_api_1.WinixClient();
         this.winix = new winix_1.WinixHandler(api.user.storagePath(), settings_1.ENCRYPTION_KEY);
         this.api.on("didFinishLaunching" /* APIEvent.DID_FINISH_LAUNCHING */, this.onFinishLaunching.bind(this));
     }
@@ -81,14 +83,14 @@ class WinixPurifierPlatform {
             this.log.debug('Found', accessory ? 'existing' : 'new', 'accessory:', this.logName(device));
             if (accessory) {
                 accessory.context.device = device;
-                const handler = await this.createNewAccessoryHandler(accessory);
+                const handler = await this.createNewAccessoryHandler(accessory, devices.length);
                 this.handlers.set(uuid, handler);
                 this.api.updatePlatformAccessories([accessory]);
             }
             else {
                 accessory = new this.api.platformAccessory(device.deviceAlias, uuid, 19 /* Categories.AIR_PURIFIER */);
                 accessory.context.device = device;
-                const handler = await this.createNewAccessoryHandler(accessory);
+                const handler = await this.createNewAccessoryHandler(accessory, devices.length);
                 this.accessories.set(uuid, accessory);
                 this.handlers.set(uuid, handler);
                 accessoriesToAdd.push(accessory);
@@ -100,12 +102,12 @@ class WinixPurifierPlatform {
         }
         this.removeOldDevices(discoveredUUIDs);
     }
-    async createNewAccessoryHandler(accessory) {
+    async createNewAccessoryHandler(accessory, deviceCount) {
         // 🫣 suppress warning message about adding characteristics which aren't required / optional, since it isn't accurate
         this.suppressCharacteristicWarnings(accessory);
         const deviceOverride = this.deviceOverrides.get(accessory.context.device.deviceId);
         const log = new logger_1.DeviceLogger(this.log, accessory.context.device);
-        const handler = new accessory_1.WinixPurifierAccessory(this, this.config, accessory, deviceOverride, log);
+        const handler = new accessory_1.WinixPurifierAccessory(this, this.config, accessory, deviceOverride, log, deviceCount);
         this.unsuppressCharacteristicWarnings(accessory);
         await handler.initialize();
         return handler;

package/package.json

@@ -1,7 +1,7 @@
 {
   "displayName": "Winix Air Purifiers",
   "name": "homebridge-winix-purifiers",
-  "version": "2.2.0",
+  "version": "2.2.2",
   "description": "Homebridge plugin for Winix air purifiers",
   "license": "Apache-2.0",
   "repository": {
@@ -63,7 +63,7 @@
   ],
   "dependencies": {
     "@homebridge/plugin-ui-utils": "1.0.3",
-    "winix-api": "1.7.0"
+    "winix-api": "1.9.0"
   },
   "devDependencies": {
     "@types/node": "20.11.0",