homebridge-flume 2.0.7 → 2.0.8

package/CHANGELOG.md

@@ -2,6 +2,15 @@
 
 All notable changes to homebridge-flume will be documented in this file.
 
+## 2.0.8 (2022-10-16)
+
+### Changed
+
+- Requests for device info will occur less often, meaning requests for leak info can occur more frequently
+  - Minimum refresh interval reduced to 1 minute
+- Bump `node` recommended versions to v14.20.1 or v16.18.0 or v18.11.0
+- Updated `axios` to v1.1.3
+
 ## 2.0.7 (2022-09-25)
 
 ### Changed

package/config.schema.json

@@ -58,7 +58,7 @@
         "title": "Refresh Interval",
         "type": "integer",
         "placeholder": 2,
-        "description": "Number of minutes between updates. Must be 2 or more."
+        "description": "Number of minutes between requests to Flume for device leak information. Must be 1 or more."
       }
     }
   },

package/lib/device/leak-sensor.js

@@ -7,8 +7,6 @@ export default class {
     this.cusChar = platform.cusChar;
     this.hapChar = platform.api.hap.Characteristic;
     this.hapServ = platform.api.hap.Service;
-    this.log = platform.config.disableDeviceLogging ? () => {} : platform.log;
-    this.name = accessory.displayName;
     this.refreshInterval = platform.config.refreshInterval;
 
     // Add the leak sensor service if it doesn't exist already
@@ -33,66 +31,36 @@ export default class {
 
   externalUpdate(params) {
     // Check the data for leak detection
-    if (
-      hasProperty(params.leakInfo, 'active')
-      && params.leakInfo.active !== this.cacheLeak
-    ) {
+    if (hasProperty(params.leakInfo, 'active') && params.leakInfo.active !== this.cacheLeak) {
       this.cacheLeak = params.leakInfo.active;
       this.leakService.updateCharacteristic(this.hapChar.LeakDetected, this.cacheLeak ? 1 : 0);
-      this.log('[%s] current leak status [%sdetected].', this.name, this.cacheLeak ? '' : 'not ');
+      this.accessory.log(`current leak status [${this.cacheLeak ? '' : 'not '}detected]`);
     }
 
     // Check the data for battery level, cacheBatt is true for OK and false for LOW
-    if (
-      hasProperty(params.devInfo, 'battery_level')
-      && (params.devInfo.battery_level !== 'low') !== this.cacheBatt
-    ) {
+    if (hasProperty(params.devInfo, 'battery_level') && (params.devInfo.battery_level !== 'low') !== this.cacheBatt) {
       this.cacheBatt = params.devInfo.battery_level !== 'low';
       this.leakService.updateCharacteristic(this.hapChar.StatusLowBattery, this.cacheBatt ? 0 : 1);
-      this.log('[%s] current battery [%s].', this.name, this.cacheBatt ? 'ok' : 'low');
+      this.accessory.log(`current battery [${this.cacheBatt ? 'okay' : 'low'}]`);
     }
 
     // Check the data for connectivity, cacheStatus is true for OK and false for NOT CONNECTED
-    if (
-      hasProperty(params.devInfo, 'connected')
-      && params.devInfo.connected !== this.cacheStatus
-    ) {
+    if (hasProperty(params.devInfo, 'connected') && params.devInfo.connected !== this.cacheStatus) {
       this.cacheStatus = params.devInfo.connected;
       this.leakService.updateCharacteristic(this.hapChar.StatusFault, this.cacheStatus ? 0 : 1);
-      this.log('[%s] current status [%sconnected].', this.name, this.cacheStatus ? '' : 'not ');
+      this.accessory.log(`current status [${this.cacheStatus ? '' : 'not '}connected]`);
     }
 
     // Water info
     if (params.waterInfo) {
-      if (
-        params.waterInfo.today
-        && params.waterInfo.today[0]
-        && hasProperty(params.waterInfo.today[0], 'value')
-      ) {
-        this.leakService.updateCharacteristic(
-          this.cusChar.TodayUsage,
-          params.waterInfo.today[0].value,
-        );
+      if (params.waterInfo.today && params.waterInfo.today[0] && hasProperty(params.waterInfo.today[0], 'value')) {
+        this.leakService.updateCharacteristic(this.cusChar.TodayUsage, params.waterInfo.today[0].value);
       }
-      if (
-        params.waterInfo.month
-        && params.waterInfo.month[0]
-        && hasProperty(params.waterInfo.month[0], 'value')
-      ) {
-        this.leakService.updateCharacteristic(
-          this.cusChar.MonthUsage,
-          params.waterInfo.month[0].value,
-        );
+      if (params.waterInfo.month && params.waterInfo.month[0] && hasProperty(params.waterInfo.month[0], 'value')) {
+        this.leakService.updateCharacteristic(this.cusChar.MonthUsage, params.waterInfo.month[0].value);
       }
-      if (
-        params.waterInfo.prevMonth
-        && params.waterInfo.prevMonth[0]
-        && hasProperty(params.waterInfo.prevMonth[0], 'value')
-      ) {
-        this.leakService.updateCharacteristic(
-          this.cusChar.PrevMonthUsage,
-          params.waterInfo.prevMonth[0].value,
-        );
+      if (params.waterInfo.prevMonth && params.waterInfo.prevMonth[0] && hasProperty(params.waterInfo.prevMonth[0], 'value')) {
+        this.leakService.updateCharacteristic(this.cusChar.PrevMonthUsage, params.waterInfo.prevMonth[0].value);
       }
     }
   }

package/lib/platform.js

@@ -24,7 +24,7 @@ export default class {
       this.devicesInHB = new Map();
 
       // Make sure user is running Homebridge v1.4 or above
-      if (!api?.versionGreaterOrEqual('1.4.0')) {
+      if (!api.versionGreaterOrEqual?.('1.4.0')) {
         throw new Error(platformLang.hbVersionFail);
       }
 
@@ -53,9 +53,11 @@ export default class {
       this.api.on('shutdown', () => this.pluginShutdown());
     } catch (err) {
       // Catch any errors during initialisation
-      const eText = parseError(err, [platformLang.hbVersionFail, platformLang.pluginNotConf]);
       log.warn('***** %s. *****', platformLang.disabling);
-      log.warn('***** %s. *****', eText);
+      log.warn('***** %s. *****', parseError(err, [
+        platformLang.hbVersionFail,
+        platformLang.pluginNotConf,
+      ]));
     }
   }
 
@@ -179,6 +181,8 @@ export default class {
       // Perform a first sync and set up the refresh interval
       this.counter = 0;
       this.flumeSync();
+
+      // Note the Flume API has a limit of 120 requests per hour
       this.refreshInterval = setInterval(
         () => this.flumeSync(),
         this.config.refreshInterval * 60000,
@@ -189,13 +193,12 @@ export default class {
       this.log('%s. %s', platformLang.complete, platformLang.zWelcome[randIndex]);
     } catch (err) {
       // Catch any errors during setup
-      const eText = parseError(err, [
+      this.log.warn('***** %s. *****', platformLang.disabling);
+      this.log.warn('***** %s. *****', parseError(err, [
         platformLang.noCreds,
         platformLang.noDevices,
         platformLang.disabled,
-      ]);
-      this.log.warn('***** %s. *****', platformLang.disabling);
-      this.log.warn('***** %s. *****', eText);
+      ]));
       this.pluginShutdown();
     }
   }
@@ -220,23 +223,20 @@ export default class {
       }
       this.devicesInHB.forEach(async (accessory) => {
         try {
-          const toReturn = {};
-          toReturn.devInfo = await this.httpClient.getDeviceInfo(accessory.context.deviceId);
-          if (this.counter === 0) {
-            toReturn.waterInfo = await this.httpClient.getWaterInfo(accessory.context.deviceId);
-          }
-          toReturn.leakInfo = await this.httpClient.getLeakInfo(accessory.context.deviceId);
+          const toReturn = {
+            devInfo: this.counter === 0 ? await this.httpClient.getDeviceInfo(accessory.context.deviceId) : {},
+            waterInfo: this.counter === 0 ? await this.httpClient.getWaterInfo(accessory.context.deviceId) : {},
+            leakInfo: await this.httpClient.getLeakInfo(accessory.context.deviceId),
+          };
           accessory.control.externalUpdate(toReturn);
         } catch (err) {
-          const eText = parseError(err);
-          this.log.warn('[%s] %s %s.', accessory.displayName, platformLang.devNotRef, eText);
+          this.log.warn('[%s] %s %s.', accessory.displayName, platformLang.devNotRef, parseError(err));
         }
         this.counter += 1;
       });
     } catch (err) {
       // Catch any errors performing the sync
-      const eText = parseError(err, []);
-      this.log.warn('%s %s.', platformLang.syncFailed, eText);
+      this.log.warn('%s %s.', platformLang.syncFailed, parseError(err));
     }
   }
 
@@ -269,13 +269,15 @@ export default class {
 
       // Create the instance for this device type
       accessory.control = new deviceLeakSensor(this, accessory);
+      accessory.log = (msg) => this.log('[%s] %s.', accessory.displayName, msg);
 
       // Log the device initialisation
       this.log('[%s] %s [%s].', accessory.displayName, platformLang.devInit, device.id);
     } catch (err) {
       // Catch any errors during device initialisation
-      const eText = parseError(err, [platformLang.accNotFound]);
-      this.log.warn('[%s] %s %s.', device.id, platformLang.devNotInit, eText);
+      this.log.warn('[%s] %s %s.', device.id, platformLang.devNotInit, parseError(err, [
+        platformLang.accNotFound,
+      ]));
     }
   }
 
@@ -299,8 +301,7 @@ export default class {
       return accessory;
     } catch (err) {
       // Catch any errors during add
-      const eText = parseError(err);
-      this.log.warn('[%s] %s %s.', platformLang.brand, platformLang.devNotAdd, eText);
+      this.log.warn('[%s] %s %s.', platformLang.brand, platformLang.devNotAdd, parseError(err));
       return false;
     }
   }
@@ -318,9 +319,7 @@ export default class {
       this.log('[%s] %s.', accessory.displayName, platformLang.devRemove);
     } catch (err) {
       // Catch any errors during remove
-      const eText = parseError(err);
-      const name = accessory.displayName;
-      this.log.warn('[%s] %s %s.', name, platformLang.devNotRemove, eText);
+      this.log.warn('[%s] %s %s.', accessory.displayName, platformLang.devNotRemove, parseError(err));
     }
   }
 }

package/lib/utils/constants.js

@@ -17,7 +17,7 @@ export default {
   },
 
   minValues: {
-    refreshInterval: 2,
+    refreshInterval: 1,
   },
 
   httpRetryCodes: ['ENOTFOUND', 'ETIMEDOUT', 'EAI_AGAIN', 'ECONNABORTED'],

package/lib/utils/lang-en.js

@@ -21,7 +21,7 @@ export default {
   devRemove: 'has been removed from Homebridge',
   disabled: 'To change this, set disablePlugin to false',
   disabling: 'Disabling plugin',
-  hbVersionFail: 'Your version of Homebridge is too low - please update to v1.3',
+  hbVersionFail: 'Your version of Homebridge is too low - please update to v1.5',
   httpRetry: 'Unable to reach Flume, retrying in 30 seconds',
   initialised: 'Plugin initialised. Setting up accessories...',
   initialising: 'Initialising plugin',

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "homebridge-flume",
   "alias": "Flume",
-  "version": "2.0.7",
+  "version": "2.0.8",
   "author": {
     "name": "Ben Potter",
     "email": "bwp91@icloud.com"
@@ -29,7 +29,7 @@
   },
   "engines": {
     "homebridge": "^1.5.0",
-    "node": "^14.20.1 || ^16.17.1"
+    "node": "^14.20.1 || ^16.18.0 || ^18.11.0"
   },
   "repository": {
     "type": "git",
@@ -58,7 +58,7 @@
   ],
   "dependencies": {
     "@homebridge/plugin-ui-utils": "^0.0.19",
-    "axios": "^0.27.2",
+    "axios": "^1.1.3",
     "jwt-decode": "^3.1.2"
   },
   "devDependencies": {
@@ -66,6 +66,6 @@
     "eslint-plugin-import": "^2.26.0",
     "eslint-plugin-import-newlines": "^1.2.3",
     "eslint-plugin-sort-exports": "^0.7.0",
-    "eslint": "^8.24.0"
+    "eslint": "^8.25.0"
   }
 }