homebridge-winix-purifiers 1.1.2 → 1.3.0

package/README.md

@@ -1,6 +1,7 @@
 # homebridge-winix-purifiers
 
-[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/regaw-leinad/homebridge-winix-purifiers/Build%20and%20Lint)](https://github.com/regaw-leinad/homebridge-winix-purifiers/actions)
+[![verified-by-homebridge](https://badgen.net/badge/homebridge/verified/purple)](https://github.com/homebridge/homebridge/wiki/Verified-Plugins)
+[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/regaw-leinad/homebridge-winix-purifiers/build.yml)](https://github.com/regaw-leinad/homebridge-winix-purifiers/actions)
 [![npm](https://img.shields.io/npm/dt/homebridge-winix-purifiers)](https://www.npmjs.com/package/homebridge-winix-purifiers)
 
 [Homebridge](https://homebridge.io) plugin providing support for [Winix](https://www.winixamerica.com) air purifiers.
@@ -30,6 +31,15 @@ The following features are optionally supported:
 * Expose ambient light
 * Expose switch to turn Plasmawave `on` / `off`
 
+### Winix API Response Caching
+
+By default, all individual responses from the Winix API are cached for `60` seconds. This helps prevent rate limiting
+and reduces the number of requests made to the Winix API. The value can be configured with the `cacheIntervalSeconds`
+property (see [Properties](#properties) below).
+
+I personally have `cacheIntervalSeconds` set to `600` seconds (10 minutes) since I don't need to know the air quality
+every minute - this significantly reduces the number of requests made to the Winix API.
+
 ## Device Support
 
 Currently, this plugin supports the following Winix air purifiers
@@ -62,7 +72,8 @@ In your `config.json`, add and update the following under the `accessories` sect
       "serialNumber": "WNXAI40001234",
       "exposeAirQuality": true,
       "exposeAmbientLight": false,
-      "exposePlasmawave": false
+      "exposePlasmawave": false,
+      "cacheIntervalSeconds": 60
     }
   ]
 }
@@ -70,16 +81,17 @@ In your `config.json`, add and update the following under the `accessories` sect
 
 ### Properties
 
-| Parameter            | Note                                                                            |
-|----------------------|---------------------------------------------------------------------------------|
-| `accessory`          | must always be set to `WinixPurifier`                                           |
-| `name`               | a human-readable name for the air purifier                                      |
-| `model`              | the model of the [supported air purifier](#Device-Support)                      |
-| `deviceId`           | the unique identifier of the device (see below for details on how to find this) |
-| `serialNumber`       | _(optional)_ the serial number of the device                                    |
-| `exposeAirQuality`   | _(optional)_ whether to expose an air quality sensor                            |
-| `exposeAmbientLight` | _(optional)_ whether to expose an ambient light sensor                          |
-| `exposePlasmawave`   | _(optional)_ whether to expose Plasmawave control as a `Switch`                 |
+| Name                   | Default Value | Note                                                                            |
+|------------------------|---------------|---------------------------------------------------------------------------------|
+| `accessory`            | Required      | must always be set to `WinixPurifier`                                           |
+| `name`                 | Required      | a human-readable name for the air purifier                                      |
+| `model`                | Required      | the model of the [supported air purifier](#Device-Support)                      |
+| `deviceId`             | Required      | the unique identifier of the device (see below for details on how to find this) |
+| `serialNumber`         | null          | the serial number of the device                                                 |
+| `exposeAirQuality`     | `false`       | whether to expose an air quality sensor                                         |
+| `exposeAmbientLight`   | `false`       | whether to expose an ambient light sensor                                       |
+| `exposePlasmawave`     | `false`       | whether to expose Plasmawave control as a `Switch`                              |
+| `cacheIntervalSeconds` | `60`          | the amount of seconds to cache the responses from the Winix API                 |
 
 ## Device ids
 

package/config.schema.json

@@ -59,6 +59,14 @@
         "description": "Whether or not to expose the ambient light sensor to HomeKit",
         "type": "boolean",
         "default": false
+      },
+      "cacheIntervalSeconds": {
+        "title": "Winix Response Cache Interval (seconds)",
+        "description": "Time, in seconds, for how long to reuse the cached response from Winix",
+        "type": "integer",
+        "default": 60,
+        "minimum": 1,
+        "required": true
       }
     }
   }

package/dist/accessory.js

@@ -11,6 +11,8 @@ class WinixPurifierAccessory {
         const deviceName = config.name;
         this.deviceId = config.deviceId;
         this.latestStatus = {};
+        this.cacheIntervalMs = config.cacheIntervalSeconds * 1000 || 60000;
+        this.lastWinixPoll = -1;
         this.services = [];
         // Create services
         this.purifier = this.registerService(new this.hap.Service.AirPurifier(deviceName));
@@ -45,6 +47,10 @@ class WinixPurifierAccessory {
         (_c = this.ambientLight) === null || _c === void 0 ? void 0 : _c.getCharacteristic(this.hap.Characteristic.CurrentAmbientLightLevel).onGet(this.getAmbientLight.bind(this));
     }
     async getActiveState() {
+        if (this.shouldUseCachedValue(this.latestStatus.power)) {
+            this.log.debug('getActiveState() (cached)', this.latestStatus.power);
+            return this.toActiveState(this.latestStatus.power);
+        }
         let power;
         try {
             power = await winix_api_1.WinixAPI.getPower(this.deviceId);
@@ -55,8 +61,9 @@ class WinixPurifierAccessory {
             throw new this.hap.HapStatusError(-70402 /* HAPStatus.SERVICE_COMMUNICATION_FAILURE */);
         }
         this.latestStatus.power = power;
+        this.polledWinix();
         this.log.debug('getActiveState()', power);
-        return power === winix_api_1.Power.On ? this.hap.Characteristic.Active.ACTIVE : this.hap.Characteristic.Active.INACTIVE;
+        return this.toActiveState(power);
     }
     async setActiveState(state) {
         const power = state === this.hap.Characteristic.Active.ACTIVE ? winix_api_1.Power.On : winix_api_1.Power.Off;
@@ -77,6 +84,10 @@ class WinixPurifierAccessory {
         this.sendHomekitUpdate();
     }
     async getCurrentState() {
+        if (this.shouldUseCachedValue(this.latestStatus.power)) {
+            this.log.debug('getCurrentState() (cached)', this.latestStatus.power);
+            return this.toCurrentState(this.latestStatus.power);
+        }
         let power;
         try {
             power = await winix_api_1.WinixAPI.getPower(this.deviceId);
@@ -87,11 +98,15 @@ class WinixPurifierAccessory {
             throw new this.hap.HapStatusError(-70402 /* HAPStatus.SERVICE_COMMUNICATION_FAILURE */);
         }
         this.latestStatus.power = power;
+        this.polledWinix();
         this.log.debug('getCurrentState()', power);
-        return power === winix_api_1.Power.On ? this.hap.Characteristic.CurrentAirPurifierState.PURIFYING_AIR :
-            this.hap.Characteristic.CurrentAirPurifierState.INACTIVE;
+        return this.toCurrentState(power);
     }
     async getTargetState() {
+        if (this.shouldUseCachedValue(this.latestStatus.mode)) {
+            this.log.debug('getTargetState() (cached)', this.latestStatus.mode);
+            return this.toTargetState(this.latestStatus.mode);
+        }
         let mode;
         try {
             mode = await winix_api_1.WinixAPI.getMode(this.deviceId);
@@ -102,9 +117,9 @@ class WinixPurifierAccessory {
             throw new this.hap.HapStatusError(-70402 /* HAPStatus.SERVICE_COMMUNICATION_FAILURE */);
         }
         this.latestStatus.mode = mode;
+        this.polledWinix();
         this.log.debug('getTargetState()', mode);
-        return mode === winix_api_1.Mode.Auto ? this.hap.Characteristic.TargetAirPurifierState.AUTO :
-            this.hap.Characteristic.TargetAirPurifierState.MANUAL;
+        return this.toTargetState(mode);
     }
     async setTargetState(state) {
         const mode = state === this.hap.Characteristic.TargetAirPurifierState.AUTO ? winix_api_1.Mode.Auto : winix_api_1.Mode.Manual;
@@ -137,6 +152,10 @@ class WinixPurifierAccessory {
         }, 2000);
     }
     async getRotationSpeed() {
+        if (this.shouldUseCachedValue(this.latestStatus.airflow)) {
+            this.log.debug('getRotationSpeed() (cached)', this.latestStatus.airflow);
+            return this.toRotationSpeed(this.latestStatus.airflow);
+        }
         let airflow;
         try {
             airflow = await winix_api_1.WinixAPI.getAirflow(this.deviceId);
@@ -147,6 +166,7 @@ class WinixPurifierAccessory {
             throw new this.hap.HapStatusError(-70402 /* HAPStatus.SERVICE_COMMUNICATION_FAILURE */);
         }
         this.latestStatus.airflow = airflow;
+        this.polledWinix();
         this.log.debug('getRotationSpeed():', airflow);
         return this.toRotationSpeed(airflow);
     }
@@ -166,6 +186,10 @@ class WinixPurifierAccessory {
         this.sendHomekitUpdate();
     }
     async getAirQuality() {
+        if (this.shouldUseCachedValue(this.latestStatus.airQuality)) {
+            this.log.debug('getAirQuality() (cached)', this.latestStatus.airQuality);
+            return this.toAirQuality(this.latestStatus.airQuality);
+        }
         let airQuality;
         try {
             airQuality = await winix_api_1.WinixAPI.getAirQuality(this.deviceId);
@@ -176,10 +200,15 @@ class WinixPurifierAccessory {
             throw new this.hap.HapStatusError(-70402 /* HAPStatus.SERVICE_COMMUNICATION_FAILURE */);
         }
         this.latestStatus.airQuality = airQuality;
+        this.polledWinix();
         this.log.debug('getAirQuality():', airQuality);
         return this.toAirQuality(airQuality);
     }
     async getPlasmawave() {
+        if (this.shouldUseCachedValue(this.latestStatus.plasmawave)) {
+            this.log.debug('getPlasmawave() (cached)', this.latestStatus.plasmawave);
+            return this.toSwitch(this.latestStatus.plasmawave);
+        }
         let plasmawave;
         try {
             plasmawave = await winix_api_1.WinixAPI.getPlasmawave(this.deviceId);
@@ -190,6 +219,7 @@ class WinixPurifierAccessory {
             throw new this.hap.HapStatusError(-70402 /* HAPStatus.SERVICE_COMMUNICATION_FAILURE */);
         }
         this.latestStatus.plasmawave = plasmawave;
+        this.polledWinix();
         this.log.debug('getPlasmawave():', plasmawave);
         return this.toSwitch(plasmawave);
     }
@@ -208,6 +238,10 @@ class WinixPurifierAccessory {
         this.sendHomekitUpdate();
     }
     async getAmbientLight() {
+        if (this.shouldUseCachedValue(this.latestStatus.ambientLight)) {
+            this.log.debug('getAmbientLight() (cached)', this.latestStatus.ambientLight);
+            return this.latestStatus.ambientLight;
+        }
         let ambientLight;
         try {
             ambientLight = await winix_api_1.WinixAPI.getAmbientLight(this.deviceId);
@@ -220,6 +254,7 @@ class WinixPurifierAccessory {
         // Fix ambient light value under 0.0001 warning
         ambientLight = Math.max(ambientLight, MIN_AMBIENT_LIGHT);
         this.latestStatus.ambientLight = ambientLight;
+        this.polledWinix();
         this.log.debug('getAmbientLight():', ambientLight);
         return ambientLight;
     }
@@ -314,6 +349,12 @@ class WinixPurifierAccessory {
                 return this.hap.Characteristic.AirQuality.UNKNOWN;
         }
     }
+    shouldUseCachedValue(v) {
+        return v !== undefined && Date.now() - this.lastWinixPoll < this.cacheIntervalMs;
+    }
+    polledWinix() {
+        this.lastWinixPoll = Date.now();
+    }
     toSwitch(plasmawave) {
         return plasmawave === winix_api_1.Plasmawave.On;
     }

package/package.json

@@ -2,7 +2,7 @@
   "private": false,
   "displayName": "Winix Air Purifiers",
   "name": "homebridge-winix-purifiers",
-  "version": "1.1.2",
+  "version": "1.3.0",
   "description": "Homebridge plugin for Winix air purifiers",
   "license": "Apache-2.0",
   "repository": {
@@ -39,7 +39,7 @@
     "winix air purifier"
   ],
   "dependencies": {
-    "axios": "^1.1.2",
+    "axios": "1.6.0",
     "winix-api": "1.1.2"
   },
   "devDependencies": {