homebridge-flume 0.3.1 → 0.4.0

package/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 All notable changes to homebridge-flume will be documented in this file.
 
+## 0.4.0 (2021-11-23)
+
+### Added
+
+- The plugin will remove 'stale' accessories that don't appear in the obtained device list
+
 ## 0.3.1 (2021-11-23)
 
 ### Fixed
@@ -18,4 +24,4 @@ Converted from accessory plugin to platform plugin
 
 ## 0.1.0 (2021-11-22)
 
-Initial release
+Initial release

package/config.schema.json

@@ -52,20 +52,20 @@
         "description": "Set to ignore a steady water draw below this value (gallons)."
       },
       "disableDeviceLogging": {
-          "type": "boolean",
-          "title": "Disable Device Logging",
-          "description": "Global logging setting for accessory status changes. If true then accessory status changes will not be logged."
-        },
-        "debug": {
-          "title": "Debug Logging",
-          "type": "boolean",
-          "description": "Global logging setting for the plugin. If true then debug information will be added to the log."
-        },
-        "disablePlugin": {
-          "title": "Disable Plugin",
-          "type": "boolean",
-          "description": "If true, the plugin will remove all accessories and not load the plugin on restart."
-        }
+        "type": "boolean",
+        "title": "Disable Device Logging",
+        "description": "Global logging setting for accessory status changes. If true then accessory status changes will not be logged."
+      },
+      "debug": {
+        "title": "Debug Logging",
+        "type": "boolean",
+        "description": "Global logging setting for the plugin. If true then debug information will be added to the log."
+      },
+      "disablePlugin": {
+        "title": "Disable Plugin",
+        "type": "boolean",
+        "description": "If true, the plugin will remove all accessories and not load the plugin on restart."
+      }
     }
   },
   "layout": [
@@ -79,13 +79,7 @@
       "title": "Optional Settings",
       "description": "Optional settings for the plugin, including global logging settings.",
       "expandable": true,
-      "items": [
-        "refreshInterval",
-        "threshold",
-        "disableDeviceLogging",
-        "debug",
-        "disablePlugin"
-      ]
+      "items": ["refreshInterval", "threshold", "disableDeviceLogging", "debug", "disablePlugin"]
     }
   ]
 }

package/lib/connection/http.js

@@ -38,7 +38,7 @@ module.exports = class connectionHTTP {
 
       // Check to see we got a response
       if (!res.data) {
-        throw new Error(this.lang.noToken)
+        throw new Error(this.lang.noDataReceived)
       }
 
       /*
@@ -84,7 +84,7 @@ module.exports = class connectionHTTP {
     } catch (err) {
       if (err.code && this.consts.httpRetryCodes.includes(err.code)) {
         // Retry if another attempt could be successful
-        this.log.warn('[HTTP login()] %s [%s].', this.lang.httpRetry, err.code)
+        this.log.warn('[HTTP obtainToken()] %s [%s].', this.lang.httpRetry, err.code)
         await this.funcs.sleep(30000)
         return await this.login()
       } else {
@@ -111,7 +111,7 @@ module.exports = class connectionHTTP {
 
       // Check to see we got a response
       if (!res.data) {
-        throw new Error(this.lang.noToken)
+        throw new Error(this.lang.noDataReceived)
       }
 
       /*
@@ -142,11 +142,11 @@ module.exports = class connectionHTTP {
     } catch (err) {
       if (err.code && this.consts.httpRetryCodes.includes(err.code)) {
         // Retry if another attempt could be successful
-        this.log.warn('[HTTP login()] %s [%s].', this.lang.httpRetry, err.code)
+        this.log.warn('[HTTP renewToken()] %s [%s].', this.lang.httpRetry, err.code)
         await this.funcs.sleep(30000)
         return await this.login()
       } else {
-        throw new Error('[HTTP refreshToken()] ' + err.message)
+        throw new Error('[HTTP renewToken()] ' + err.message)
       }
     }
   }
@@ -155,7 +155,7 @@ module.exports = class connectionHTTP {
     try {
       // Check we have a user id
       if (!this.userId) {
-        throw new Error('No user id has been retrieved')
+        throw new Error(this.lang.noUserId)
       }
 
       // Perform the HTTP request
@@ -166,14 +166,14 @@ module.exports = class connectionHTTP {
 
       // Check to see we got a response
       if (!res.data) {
-        throw new Error('No data received')
+        throw new Error(this.lang.noDataReceived)
       }
 
       return res.data.data
     } catch (err) {
       if (err.code && this.consts.httpRetryCodes.includes(err.code)) {
         // Retry if another attempt could be successful
-        this.log.warn('[HTTP login()] %s [%s].', this.lang.httpRetry, err.code)
+        this.log.warn('[HTTP getDevices()] %s [%s].', this.lang.httpRetry, err.code)
         await this.funcs.sleep(30000)
         return await this.login()
       } else {
@@ -212,6 +212,11 @@ module.exports = class connectionHTTP {
       }
     )
 
+    // Check to see we got a response
+    if (!res.data) {
+      throw new Error(this.lang.noDataReceived)
+    }
+
     // Parse the response
     return res.data.data[0]
   }

package/lib/device/valve.js

@@ -27,9 +27,8 @@ module.exports = class deviceValve {
         : 0
     if (usage > this.threshold) {
       this.log(
-        '[%s] %s - [%s] gallons within the last [%s] minutes.',
+        '[%s] usage detected - [%s] gallons within the last [%s] minutes.',
         this.name,
-        'usage detected',
         usage,
         this.refreshInterval
       )

package/lib/homebridge-ui/public/index.html

@@ -77,7 +77,11 @@
   <h4>Credits</h4>
   <ul>
     <li>
-      This is a forked rewrite of the <a href="https://www.npmjs.com/package/homebridge-flume-water-sensor" target="_blank">homebridge-flume-water-sensor</a> plugin by @weallknowwhoisatfaulthere
+      This is a forked rewrite of the
+      <a href="https://www.npmjs.com/package/homebridge-flume-water-sensor" target="_blank"
+        >homebridge-flume-water-sensor</a
+      >
+      plugin by @weallknowwhoisatfaulthere
     </li>
     <li>
       To the creators/contributors of

package/lib/index.js

@@ -174,9 +174,11 @@ class FlumePlatform {
 
       // Check we have devices we can work with
       if (!Array.isArray(deviceList) || deviceList.length === 0) {
+        this.devicesInHB.forEach(accessory => this.removeAccessory(accessory))
         throw new Error(this.lang.noDevices)
       }
 
+      // Initialise each device into Homebridge
       deviceList.forEach(device => {
         if (!device.bridge_id) {
           return
@@ -184,6 +186,13 @@ class FlumePlatform {
         this.initialiseDevice(device)
       })
 
+      // Remove any stale accessories that don't appear in the device list
+      this.devicesInHB.forEach(accessory => {
+        if (!deviceList.find(el => accessory.context.deviceId === el.id)) {
+          this.removeAccessory(accessory)
+        }
+      })
+
       // Set up an initial last sync time
       this.lastSync = new Date(Date.now() - this.config.refreshInterval * 60000)
 
@@ -235,7 +244,7 @@ class FlumePlatform {
           accessory.control.externalUpdate(res)
         } catch (err) {
           const eText = this.funcs.parseError(err)
-          this.log.warn(eText)
+          this.log.warn('[%s] %s %s.', accessory.displayName, this.lang.devNotRef, eText)
         }
       })
 

package/lib/utils/lang-en.js

@@ -4,7 +4,6 @@
 
 module.exports = {
   accNotFound: 'accessory not found',
-  accNotReady: 'cannot currently be controlled, see plugin startup logs for any error',
   brand: 'Flume',
   cfgDef: 'is not a valid number so using default of',
   cfgDup: 'will be ignored since another entry with this ID already exists',
@@ -15,10 +14,6 @@ module.exports = {
   cfgRmv: 'is unused and can be removed',
   cfgQts: 'should not have quotes around its entry',
   complete: '✓ Setup complete',
-  curHeat: 'current heating',
-  curState: 'current state',
-  curTarg: 'current target',
-  curTemp: 'current temperature',
   devAdd: 'has been added to Homebridge',
   devInit: 'initialised with id',
   devNotAdd: 'could not be added to Homebridge as',
@@ -29,36 +24,27 @@ module.exports = {
   devNotUpdated: 'could not be updated as',
   devRemove: 'has been removed from Homebridge',
   disabled: 'To change this, set disablePlugin to false',
-  disableHTTP: 'Disabling HTTP client as',
   disabling: 'Disabling plugin',
   hbVersionFail: 'Your version of Homebridge is too low - please update to v1.3',
   httpRetry: 'Unable to reach Flume, retrying in 30 seconds',
   initialised: 'Plugin initialised. Setting up accessories...',
   initialising: 'Initialising plugin',
-  labelHeating: 'heating',
-  labelIdle: 'idle',
-  labelMan: 'manual',
-  labelSch: 'schedule',
-  noCreds: 'Flume username and/or password not configured',
-  noDevices: 'no data received from Flume server whilst obtaining device list',
-  noTokenExists: 'no Flume account token exists',
+  noCreds: 'Flume username and/or password and/or client id/secret not configured',
+  noDataReceived: 'No data received from request',
+  noUserId: 'No user id has been retrieved',
   pluginNotConf: 'Plugin has not been configured',
-  receivingUpdate: 'receiving update',
-  scheduleFailed: 'Program schedule could not be updated as',
-  scheduleInvalid: 'Not updating program schedule as configuration is invalid or incomplete',
-  scheduleUpdated: 'Program schedule successfully updated',
   syncFailed: 'Sync process failed as',
   updateFail: 'could not be updated as',
   zWelcome: [
     "Don't forget to ☆ this plugin on GitHub if you're finding it useful!",
-    // 'Have a feature request? Visit https://bit.ly/hb-thermobit-issues to ask!',
+    'Have a feature request? Visit https://bit.ly/hb-flume-issues to ask!',
     'Interested in sponsoring this plugin? https://github.com/sponsors/bwp91',
     "Join the plugin's Discord community! https://discord.gg/cMGhNtZ3tW",
     'Thanks for using this plugin, I hope you find it helpful!',
     'This plugin has been made with ♥ by bwp91 from the UK!',
     'Check out my other Homebridge plugins! https://github.com/bwp91',
-    // 'Have time to give this plugin a review? https://bit.ly/hb-thermobit-review',
-    // "This plugin needs it's first ☆ rating on HOOBS! https://bit.ly/hb-thermobit-review",
+    'Have time to give this plugin a review? https://bit.ly/hb-flume-review',
+    "This plugin needs it's first ☆ rating on HOOBS! https://bit.ly/hb-flume-review",
     'Want to see this plugin in your own language? Let me know!'
   ]
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "homebridge-flume",
   "alias": "Flume",
-  "version": "0.3.1",
+  "version": "0.4.0",
   "author": {
     "name": "Ben Potter",
     "email": "bwp91@icloud.com"
@@ -33,6 +33,24 @@
   "bugs": {
     "url": "https://github.com/bwp91/homebridge-flume/issues"
   },
+  "funding": [
+    {
+      "type": "github",
+      "url": "https://github.com/sponsors/bwp91"
+    },
+    {
+      "type": "kofi",
+      "url": "https://ko-fi.com/bwp91"
+    },
+    {
+      "type": "patreon",
+      "url": "https://www.patreon.com/bwp91"
+    },
+    {
+      "type": "paypal",
+      "url": "https://www.paypal.me/BenPotter"
+    }
+  ],
   "dependencies": {
     "@homebridge/plugin-ui-utils": "^0.0.19",
     "axios": "^0.24.0",