homebridge-flume 2.1.0-beta.0 → 3.0.0

package/CHANGELOG.md

@@ -2,9 +2,13 @@
 
 All notable changes to homebridge-flume will be documented in this file.
 
-⚠️ Note that Node 14 will no longer be supported after April 2023
+## 3.0.0 (2023-03-11)
 
-## BETA
+### Breaking
+
+- Remove official support for Node 14
+- Remove option to disable plugin - this is now available in the Homebridge UI
+- Remove option for debug logging - this will be enabled when using a beta version of the plugin
 
 ### Added
 
@@ -13,6 +17,7 @@ All notable changes to homebridge-flume will be documented in this file.
 ### Changed
 
 - Fix a potential login issue that might be terminating the process incorrectly
+- Bump `node` recommended versions to v16.19.1 or v18.15.0
 
 ## 2.0.9 (2023-01-07)
 

package/config.schema.json

@@ -39,16 +39,6 @@
         "required": true,
         "description": "Your Flume Client Secret, found at https://portal.flumetech.com."
       },
-      "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."
-      },
       "disableDeviceLogging": {
         "type": "boolean",
         "title": "Disable Device Logging",
@@ -66,7 +56,7 @@
     {
       "type": "fieldset",
       "title": "Required Settings",
-      "items": ["username", "password", "clientId", "clientSecret", "debug", "disablePlugin"]
+      "items": ["username", "password", "clientId", "clientSecret"]
     },
     {
       "type": "fieldset",

package/lib/connection/http.js

@@ -7,7 +7,6 @@ import platformLang from '../utils/lang-en.js';
 export default class {
   constructor(platform) {
     // Create variables usable by the class
-    this.debug = platform.config.debug;
     this.log = platform.log;
     this.username = platform.config.username;
     this.password = platform.config.password;
@@ -59,9 +58,7 @@ export default class {
       */
 
       // Log the response if in debug mode
-      if (this.debug) {
-        this.log('[HTTP obtainToken()] %s.', JSON.stringify(res.data));
-      }
+      this.log.debug('[HTTP obtainToken()] %s.', JSON.stringify(res.data));
 
       // Check to see we got a proper response
       if (!res.data.data || !res.data.data[0]) {
@@ -127,9 +124,7 @@ export default class {
       }
 
       // Log the response if in debug mode
-      if (this.debug) {
-        this.log('[HTTP renewToken()] %s.', JSON.stringify(res.data));
-      }
+      this.log.debug('[HTTP renewToken()] %s.', JSON.stringify(res.data));
 
       /*
           {
@@ -187,9 +182,7 @@ export default class {
       }
 
       // Log the response if in debug mode
-      if (this.debug) {
-        this.log('[HTTP getDevices()] %s.', JSON.stringify(res.data));
-      }
+      this.log.debug('[HTTP getDevices()] %s.', JSON.stringify(res.data));
 
       return res.data.data;
     } catch (err) {
@@ -225,9 +218,7 @@ export default class {
     }
 
     // Log the response if in debug mode
-    if (this.debug) {
-      this.log('[HTTP getDeviceInfo()] %s.', JSON.stringify(res.data));
-    }
+    this.log.debug('[HTTP getDeviceInfo()] %s.', JSON.stringify(res.data));
 
     // Parse the response
     return res.data.data[0];
@@ -296,9 +287,7 @@ export default class {
     }
 
     // Log the response if in debug mode
-    if (this.debug) {
-      this.log('[HTTP getWaterInfo()] %s.', JSON.stringify(res.data));
-    }
+    this.log.debug('[HTTP getWaterInfo()] %s.', JSON.stringify(res.data));
 
     // Parse the response
     return res.data.data[0];
@@ -326,9 +315,7 @@ export default class {
     }
 
     // Log the response if in debug mode
-    if (this.debug) {
-      this.log('[HTTP getLeakInfo()] %s.', JSON.stringify(res.data));
-    }
+    this.log('[HTTP getLeakInfo()] %s.', JSON.stringify(res.data));
 
     // Parse the response
     return res.data.data[0];

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

@@ -22,15 +22,6 @@
   <button type="button" class="btn btn-primary ml-0" id="menuSettings">Settings</button>
   <button type="button" class="btn btn-primary mr-0" id="menuHome">Support</button>
 </div>
-<div
-  id="disabledBanner"
-  class="alert alert-secondary mb-0 mt-3"
-  role="alert"
-  style="display: none;"
->
-  Plugin is currently disabled
-  <button id="disabledEnable" type="button" class="btn btn-link p-0 m-0 float-right">Enable</button>
-</div>
 <div id="pageSupport" class="mt-4" style="display: none;">
   <p class="text-center lead">Thank you for using <strong>homebridge-flume</strong></p>
   <p class="text-center">The links below will take you to our GitHub wiki</p>
@@ -143,26 +134,11 @@
         homebridge.showSchemaForm()
         homebridge.hideSpinner()
       }
-      showDisabledBanner = () => {
-        document.getElementById('disabledBanner').style.display = 'block'
-      }
-      enablePlugin = async () => {
-        homebridge.showSpinner()
-        document.getElementById('disabledBanner').style.display = 'none'
-        currentConfig[0].disablePlugin = false
-        await homebridge.updatePluginConfig(currentConfig)
-        await homebridge.savePluginConfig()
-        homebridge.hideSpinner()
-      }
       menuHome.addEventListener('click', () => showSupport())
       menuSettings.addEventListener('click', () => showSettings())
-      disabledEnable.addEventListener('click', () => enablePlugin())
       if (currentConfig.length) {
         document.getElementById('menuWrapper').style.display = 'inline-flex'
         showSettings()
-        if (currentConfig[0].disablePlugin) {
-          showDisabledBanner()
-        }
       } else {
         currentConfig.push({ name: 'Flume' })
         await homebridge.updatePluginConfig(currentConfig)

package/lib/platform.js

@@ -19,12 +19,13 @@ export default class {
     try {
       this.api = api;
       this.log = log;
+      this.isBeta = plugin.version.includes('beta');
 
       // Configuration objects for accessories
       this.devicesInHB = new Map();
 
-      // Make sure user is running Homebridge v1.4 or above
-      if (!api.versionGreaterOrEqual?.('1.4.0')) {
+      // Make sure user is running Homebridge v1.5 or above
+      if (!api.versionGreaterOrEqual?.('1.5.0')) {
         throw new Error(platformLang.hbVersionFail);
       }
 
@@ -93,9 +94,7 @@ export default class {
             this.config[key] = val;
           }
           break;
-        case 'debug':
         case 'disableDeviceLogging':
-        case 'disablePlugin':
           if (typeof val === 'string') {
             logQuotes(key);
           }
@@ -133,10 +132,21 @@ export default class {
       // Log that the plugin initialisation has been successful
       this.log('%s.', platformLang.initialised);
 
-      // If the user has disabled the plugin then remove all accessories
-      if (this.config.disablePlugin) {
-        this.devicesInHB.forEach((accessory) => this.removeAccessory(accessory));
-        throw new Error(platformLang.disabled);
+      // Sort out some logging functions
+      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(platformLang.beta.length + 1); // don't forget the full stop (+1!)
+          this.log.warn(divide);
+          this.log.warn(`${platformLang.beta}.`);
+          this.log.warn(divide);
+        }
+      } else {
+        this.log.debug = () => {};
+        this.log.debugWarn = () => {};
       }
 
       // Ensure username and password have been provided
@@ -152,7 +162,7 @@ export default class {
       // Require any libraries that the accessory instances use
       this.cusChar = new platformChars(this.api);
 
-      // Set up the HTTP client if Thermobit username and password have been provided
+      // Set up the HTTP client if Flume username and password have been provided
       this.httpClient = new httpClient(this);
       await this.httpClient.obtainToken();
       const deviceList = await this.httpClient.getDevices();
@@ -197,7 +207,6 @@ export default class {
       this.log.warn('***** %s. *****', parseError(err, [
         platformLang.noCreds,
         platformLang.noDevices,
-        platformLang.disabled,
       ]));
       this.pluginShutdown();
     }

package/lib/utils/constants.js

@@ -5,8 +5,6 @@ export default {
     password: '',
     clientId: '',
     clientSecret: '',
-    debug: false,
-    disablePlugin: false,
     disableDeviceLogging: false,
     refreshInterval: 1,
     platform: 'Flume',

package/lib/utils/lang-en.js

@@ -1,5 +1,6 @@
 export default {
   accNotFound: 'accessory not found',
+  beta: 'You are using a beta version of the plugin - you will experience more logging than normal',
   brand: 'Flume',
   cfgDef: 'is not a valid number so using default of',
   cfgDup: 'will be ignored since another entry with this ID already exists',
@@ -19,9 +20,8 @@ export default {
   devNotRemove: 'could not be removed from Homebridge as',
   devNotUpdated: 'could not be updated as',
   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.5',
+  hbVersionFail: 'Your version of Homebridge is too low - please update to v1.6',
   httpRetry: 'Unable to reach Flume, retrying in 30 seconds',
   initialised: 'Plugin initialised. Setting up accessories...',
   initialising: 'Initialising plugin',
@@ -44,5 +44,6 @@ export default {
     'Have time to give this plugin a review? https://bit.ly/hb-flume-review',
     'This plugin currently has a 4☆ rating on HOOBS! https://bit.ly/hb-flume-review',
     'Want to see this plugin in your own language? Let me know!',
+    'Want to beta test Homebridge 2.0? https://github.com/homebridge/homebridge/wiki/Homebridge-Beta-Testing',
   ],
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "homebridge-flume",
   "alias": "Flume",
-  "version": "2.1.0-beta.0",
+  "version": "3.0.0",
   "author": {
     "name": "Ben Potter",
     "email": "bwp91@icloud.com"
@@ -29,7 +29,7 @@
   },
   "engines": {
     "homebridge": "^1.6.0 || 2.0.0-beta.0",
-    "node": "^14.21.2 || ^16.19.0 || ^18.13.0"
+    "node": "^16.19.1 || ^18.15.0"
   },
   "repository": {
     "type": "git",
@@ -58,14 +58,14 @@
   ],
   "dependencies": {
     "@homebridge/plugin-ui-utils": "^0.0.19",
-    "axios": "^1.2.2",
+    "axios": "^1.3.4",
     "jwt-decode": "^3.1.2"
   },
   "devDependencies": {
     "eslint-config-airbnb-base": "^15.0.0",
-    "eslint-plugin-import": "^2.27.4",
-    "eslint-plugin-import-newlines": "^1.3.0",
+    "eslint-plugin-import": "^2.27.5",
+    "eslint-plugin-import-newlines": "^1.3.1",
     "eslint-plugin-sort-exports": "^0.8.0",
-    "eslint": "^8.32.0"
+    "eslint": "^8.36.0"
   }
 }