homebridge-flume 0.1.0 → 0.2.0

package/CHANGELOG.md

@@ -0,0 +1,11 @@
+# Change Log
+
+All notable changes to homebridge-flume will be documented in this file.
+
+## 0.2.0 (2021-11-22)
+
+Converted from accessory plugin to platform plugin
+
+## 0.1.0 (2021-11-22)
+
+Initial release

package/README.md

@@ -5,24 +5,20 @@
 Configuration sample:
 
 ```
-"accessories": [
-  {
-    "accessory": "Flume",
-    "name": "Flume Water Monitor",
-    "username": "user@domain.com",
-    "password": "password",
-    "client_id": "12345678901234567890",
-    "client_secret": "1234567890",
-    "polling_minutes": 1,
-    "handicap": 0.1,
-    "valveType": 3
-  }
-]
+{
+  "name": "Flume Water Monitor",
+  "username": "user@domain.com",
+  "password": "password",
+  "client_id": "12345678901234567890",
+  "client_secret": "1234567890",
+  "polling_minutes": 1,
+  "handicap": 0.1,
+  "platform": "Flume"
+}
 ```
 
 Fields:
 
-- "accessory": Must always be "Flume" (required)
 - "username": Your username for accessing the Flume site at https://portal.flumetech.com/ (required)
 - "password": Your password for accessing the Flume site (required)
 - "client_id": Your Client ID for API access, found in Settings on the Flume site (required)

package/config.schema.json

@@ -1,57 +1,55 @@
 {
   "pluginAlias": "Flume",
-  "pluginType": "accessory",
+  "pluginType": "platform",
   "singular": true,
-  "headerDisplay": "[Flume Water Monitor](https://flumetech.com) plugin for Homebridge.",
+  "customUi": true,
+  "customUiPath": "./lib/homebridge-ui",
+  "headerDisplay": "<p align=\"center\">For help and support please visit our <a href=\"https://github.com/bwp91/homebridge-flume/wiki\">GitHub Wiki</a>. We hope you find this plugin useful!</p>",
   "schema": {
     "type": "object",
     "properties": {
       "name": {
-        "title": "Accessory Name",
+        "title": "Plugin Name",
         "type": "string",
-        "required": true,
-        "default": "Flume Water Monitor",
-        "description": "The name used for the Flume water monitor in HomeKit"
+        "default": "Flume"
       },
       "username": {
         "title": "Username",
         "type": "string",
         "required": true,
-        "description": "Your username for acessing the Flume site at https://portal.flumetech.com/ (required)"
+        "description": "Your username for accessing the Flume site at https://portal.flumetech.com"
       },
       "password": {
         "title": "Password",
         "type": "string",
         "required": true,
-        "description": "Your password for acessing the Flume site (required)"
+        "description": "Your password for accessing the Flume site"
       },
       "client_id": {
         "title": "Client ID",
         "type": "string",
         "placeholder": "12345678901234567890",
         "required": true,
-        "description": "Your Client ID for API access, found in Settings on the Flume site (required)"
+        "description": "Your Client ID for API access, found in Settings on the Flume site"
       },
       "client_secret": {
         "title": "Client Secret",
         "type": "string",
         "placeholder": "1234567890",
         "required": true,
-        "description": "Your Client Secret for API access, found in Settings on the Flume site (required)"
+        "description": "Your Client Secret for API access, found in Settings on the Flume site"
       },
       "polling_minutes": {
         "title": "Update Interval",
         "type": "integer",
-        "default": "1",
-        "required": false,
-        "description": "Number of minutes between updates. Defaults to 1 minute. API has a cap of 120 calls per hour. (optional)"
+        "placeholder": 1,
+        "description": "Number of minutes between updates. API has a cap of 120 calls per hour."
       },
       "handicap": {
         "title": "Adjustment for False Positives",
-        "type": "float",
-        "default": "0.0",
-        "required": false,
-        "description": "Set to ignore a steady water draw below this value. Defaults to zero (0.0) gallons. (optional)"
+        "type": "number",
+        "placeholder": 0,
+        "description": "Set to ignore a steady water draw below this value (gallons)."
       }
     }
   }

package/lib/connection/http.js

@@ -0,0 +1,218 @@
+/* jshint node: true, esversion: 10, -W014, -W033 */
+/* eslint-disable new-cap */
+'use strict'
+
+const axios = require('axios')
+const jwtDecode = require('jwt-decode')
+
+module.exports = class connectionHTTP {
+  constructor (platform) {
+    // Create variables usable by the class
+    this.consts = platform.consts
+    this.debug = platform.config.debug
+    this.funcs = platform.funcs
+    this.lang = platform.lang
+    this.log = platform.log
+    this.username = platform.config.username
+    this.password = platform.config.password
+    this.client_id = platform.config.client_id
+    this.client_secret = platform.config.client_secret
+  }
+
+  async obtainToken () {
+    try {
+      // Generate the JSON data to send
+      const body = {
+        grant_type: 'password',
+        client_id: this.client_id,
+        client_secret: this.client_secret,
+        username: this.username,
+        password: this.password
+      }
+      const now = Date.now()
+
+      // Perform the HTTP request
+      const res = await axios.post('https://api.flumetech.com/oauth/token', body, {
+        timeout: 10000
+      })
+
+      // Check to see we got a response
+      if (!res.data) {
+        throw new Error(this.lang.noToken)
+      }
+
+      /*
+        {
+          success: true,
+          code: 602,
+          message: 'Request OK',
+          http_code: 200,
+          http_message: 'OK',
+          detailed: null,
+          data: [
+            {
+              token_type: 'bearer',
+              access_token: '',
+              expires_in: 604800,
+              refresh_token: ''
+            }
+          ],
+          count: 1,
+          pagination: null
+        }
+      */
+
+      // Make the token available in other functions
+      this.accessToken = res.data.data[0].access_token
+      this.refreshToken = res.data.data[0].refresh_token
+      this.expiresIn = now + res.data.data[0].expires_in
+
+      // Obtain the user ID
+      this.userId = jwtDecode(this.accessToken).user_id
+
+      /*
+        {
+          user_id: 0000,
+          type: 'USER',
+          scope: [ 'read:personal', 'update:personal', 'query:personal' ],
+          iat: 0000000000,
+          exp: 0000000000,
+          iss: 'flume_oauth',
+          sub: ''
+        }
+      */
+    } 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)
+        await this.funcs.sleep(30000)
+        return await this.login()
+      } else {
+        throw new Error('[HTTP obtainToken()] ' + err.message)
+      }
+    }
+  }
+
+  async renewToken () {
+    try {
+      // Generate the JSON data to send
+      const body = {
+        grant_type: 'refresh_token',
+        client_id: this.client_id,
+        client_secret: this.client_secret,
+        refresh_token: this.refreshToken
+      }
+      const now = Date.now()
+
+      // Perform the HTTP request
+      const res = await axios.post('https://api.flumetech.com/oauth/token', body, {
+        timeout: 10000
+      })
+
+      // Check to see we got a response
+      if (!res.data) {
+        throw new Error(this.lang.noToken)
+      }
+
+      /*
+          {
+            success: true,
+            code: 602,
+            message: 'Request OK',
+            http_code: 200,
+            http_message: 'OK',
+            detailed: null,
+            data: [
+              {
+                token_type: 'bearer',
+                access_token: '',
+                expires_in: 604800,
+                refresh_token: ''
+              }
+            ],
+            count: 1,
+            pagination: null
+          }
+        */
+
+      // Make the token available in other functions
+      this.accessToken = res.data.data[0].access_token
+      this.refreshToken = res.data.data[0].refresh_token
+      this.expiresIn = now + res.data.data[0].expires_in
+    } 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)
+        await this.funcs.sleep(30000)
+        return await this.login()
+      } else {
+        throw new Error('[HTTP refreshToken()] ' + err.message)
+      }
+    }
+  }
+
+  async getDevices () {
+    try {
+      // Check we have a user id
+      if (!this.userId) {
+        throw new Error('No user id has been retrieved')
+      }
+
+      // Perform the HTTP request
+      const res = await axios.get('https://api.flumetech.com/users/' + this.userId + '/devices', {
+        headers: { Authorization: 'Bearer ' + this.accessToken },
+        timeout: 10000
+      })
+
+      // Check to see we got a response
+      if (!res.data) {
+        throw new Error('No data received')
+      }
+
+      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)
+        await this.funcs.sleep(30000)
+        return await this.login()
+      } else {
+        throw new Error('[HTTP getDevices()] ' + err.message)
+      }
+    }
+  }
+
+  async getDeviceInfo (deviceId, fromWhen) {
+    // Refresh the access token if it has expired already
+    if (Date.now() > this.expiresIn) {
+      await this.renewToken()
+    }
+
+    // Generate the JSON data to send
+    const body = {
+      queries: [
+        {
+          request_id: 'currentusage',
+          bucket: 'MIN',
+          since_datetime: fromWhen,
+          operation: 'SUM',
+          units: 'GALLONS'
+        }
+      ]
+    }
+
+    // Send the request
+    const res = await axios.post(
+      'https://api.flumetech.com/users/' + this.userId + '/devices/' + deviceId + '/query',
+      body,
+      {
+        headers: {
+          Authorization: 'Bearer ' + this.accessToken
+        }
+      }
+    )
+
+    // Parse the response
+    return res.data.data[0]
+  }
+}

package/lib/device/valve.js

@@ -0,0 +1,38 @@
+/* jshint node: true, esversion: 10, -W014, -W033 */
+/* eslint-disable new-cap */
+'use strict'
+
+module.exports = class deviceValve {
+  constructor (platform, accessory) {
+    // Set up variables from the platform
+    this.accessory = accessory
+    this.disableDeviceLogging = platform.config.disableDeviceLogging
+    this.funcs = platform.funcs
+    this.handicap = platform.config.handicap
+    this.hapChar = platform.api.hap.Characteristic
+    this.hapErr = platform.api.hap.HapStatusError
+    this.hapServ = platform.api.hap.Service
+    this.lang = platform.lang
+    this.log = platform.log
+    this.name = accessory.displayName
+    this.platform = platform
+    this.polling_minutes = platform.config.polling_minutes
+  }
+
+  externalUpdate (params) {
+    // Here we deal with the incoming data
+    const usage =
+      params.currentusage && params.currentusage[0] && params.currentusage[0].value
+        ? params.currentusage[0].value
+        : 0
+    if (usage > this.handicap) {
+      this.log(
+        '[%s] %s - [%s] gallons within the last [%s] minutes.',
+        this.name,
+        'usage detected',
+        usage,
+        this.polling_minutes
+      )
+    }
+  }
+}

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

@@ -0,0 +1,159 @@
+<div id="pageIntro" class="text-center" style="display: none;">
+  <p class="lead">Thank you for installing <strong>homebridge-flume</strong></p>
+  <p>
+    You will need your Flume username, password, client ID and secret to continue
+  </p>
+  <button type="button" class="btn btn-primary" id="introContinue">Continue &rarr;</button>
+</div>
+<div
+  id="menuWrapper"
+  class="btn-group w-100 mb-0"
+  role="group"
+  aria-label="UI Menu"
+  style="display: none;"
+>
+  <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>
+  <h4>Setup</h4>
+  <ul>
+    <li>
+      <a href="https://github.com/bwp91/homebridge-flume/wiki/Installation" target="_blank"
+        >Installation</a
+      >
+    </li>
+    <li>
+      <a href="https://github.com/bwp91/homebridge-flume/wiki/Configuration" target="_blank"
+        >Configuration</a
+      >
+    </li>
+    <li>
+      <a href="https://github.com/bwp91/homebridge-flume/wiki/Beta-Version" target="_blank"
+        >Beta Version</a
+      >
+    </li>
+    <li>
+      <a href="https://github.com/bwp91/homebridge-flume/wiki/Node-Version" target="_blank"
+        >Node Version</a
+      >
+    </li>
+    <li>
+      <a href="https://github.com/bwp91/homebridge-flume/wiki/Uninstallation" target="_blank"
+        >Uninstallation</a
+      >
+    </li>
+  </ul>
+  <h4>Help/About</h4>
+  <ul>
+    <li>
+      <a href="https://github.com/bwp91/homebridge-flume/wiki/Common-Errors" target="_blank"
+        >Common Errors</a
+      >
+    </li>
+    <li>
+      <a href="https://github.com/bwp91/homebridge-flume/issues/new/choose" target="_blank"
+        >Support Request</a
+      >
+    </li>
+    <li>
+      <a href="https://github.com/bwp91/homebridge-flume/blob/latest/CHANGELOG.md" target="_blank"
+        >Changelog</a
+      >
+    </li>
+    <li><a href="https://github.com/sponsors/bwp91" target="_blank">About Me</a></li>
+  </ul>
+  <h4>Credits</h4>
+  <ul>
+    <li>
+      To the creators/contributors of
+      <a href="https://homebridge.io" target="_blank">Homebridge</a> who make this plugin possible.
+    </li>
+  </ul>
+  <h4>Disclaimer</h4>
+  <ul>
+    <li>
+      I am in no way affiliated with Flume and this plugin is a personal project that I maintain in
+      my free time.
+    </li>
+    <li>Use this plugin entirely at your own risk - please see licence for more information.</li>
+  </ul>
+</div>
+<script>
+  ;(async () => {
+    try {
+      const currentConfig = await homebridge.getPluginConfig()
+      showIntro = () => {
+        const introContinue = document.getElementById('introContinue')
+        introContinue.addEventListener('click', () => {
+          homebridge.showSpinner()
+          document.getElementById('pageIntro').style.display = 'none'
+          document.getElementById('menuWrapper').style.display = 'inline-flex'
+          showSettings()
+          homebridge.hideSpinner()
+        })
+        document.getElementById('pageIntro').style.display = 'block'
+      }
+      showSupport = () => {
+        homebridge.showSpinner()
+        homebridge.hideSchemaForm()
+        document.getElementById('menuHome').classList.add('btn-elegant')
+        document.getElementById('menuHome').classList.remove('btn-primary')
+        document.getElementById('menuSettings').classList.remove('btn-elegant')
+        document.getElementById('menuSettings').classList.add('btn-primary')
+        document.getElementById('pageSupport').style.display = 'block'
+        homebridge.hideSpinner()
+      }
+      showSettings = () => {
+        homebridge.showSpinner()
+        document.getElementById('menuHome').classList.remove('btn-elegant')
+        document.getElementById('menuHome').classList.add('btn-primary')
+        document.getElementById('menuSettings').classList.add('btn-elegant')
+        document.getElementById('menuSettings').classList.remove('btn-primary')
+        document.getElementById('pageSupport').style.display = 'none'
+        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)
+        showIntro()
+      }
+    } catch (err) {
+      homebridge.toast.error(err.message, 'Error')
+    } finally {
+      homebridge.hideSpinner()
+    }
+  })()
+</script>

package/lib/homebridge-ui/server.js

@@ -0,0 +1,14 @@
+/* jshint node: true, esversion: 10, -W014, -W033 */
+/* eslint-disable new-cap */
+'use strict'
+
+const { HomebridgePluginUiServer } = require('@homebridge/plugin-ui-utils')
+
+class PluginUiServer extends HomebridgePluginUiServer {
+  constructor () {
+    super()
+    this.ready()
+  }
+}
+
+;(() => new PluginUiServer())()

package/lib/index.js

@@ -1,219 +1,335 @@
-const fetch = require('node-fetch');
-const packageJson = require('./package.json');
-var jwtDecode = require('jwt-decode');
-var Service, Characteristic;
-
-module.exports = function (homebridge) {
-  Service = homebridge.hap.Service;
-  Characteristic = homebridge.hap.Characteristic;
-  homebridge.registerAccessory('homebridge-flume', 'Flume', Flume);
-}
+/* jshint node: true, esversion: 10, -W014, -W033 */
+/* eslint-disable new-cap */
+'use strict'
+
+// Packages and constant variables for this class
+const plugin = require('./../package.json')
+
+// Create the platform class
+class FlumePlatform {
+  constructor (log, config, api) {
+    // Don't load the plugin if these aren't accessible for any reason
+    if (!log || !api) {
+      return
+    }
+
+    // Begin plugin initialisation
+    try {
+      this.api = api
+      this.consts = require('./utils/constants')
+      this.funcs = require('./utils/functions')
+      this.log = log
 
-function Flume (log, config, api) {
-    this.log = log;
-    this.config = config;
+      // Configuration objects for accessories
+      this.devicesInHB = new Map()
 
-    log("Starting homebridge-flume.");
+      // Retrieve the user's chosen language file
+      this.lang = require('./utils/lang-en')
 
-    // extract name from config
-    this.name = config.name;
+      // Make sure user is running Homebridge v1.3 or above
+      if (!api.versionGreaterOrEqual || !api.versionGreaterOrEqual('1.3.0')) {
+        throw new Error(this.lang.hbVersionFail)
+      }
 
-  // pull in initial variables
-    this.username = config["username"];
-    this.password = config["password"];
-    this.client_id = config["client_id"];
-    this.client_secret = config["client_secret"];
-    if (config["handicap"] != null) {
-      this.handicap = config["handicap"];
-    } else {
-      this.handicap = 0;
+      // Check the user has configured the plugin
+      if (!config) {
+        throw new Error(this.lang.pluginNotConf)
+      }
+
+      // Log some environment info for debugging
+      this.log(
+        '%s v%s | Node %s | HB v%s%s...',
+        this.lang.initialising,
+        plugin.version,
+        process.version,
+        api.serverVersion,
+        config.plugin_map
+          ? ' | HOOBS v3'
+          : require('os')
+              .hostname()
+              .includes('hoobs')
+          ? ' | HOOBS v4'
+          : ''
+      )
+
+      // Apply the user's configuration
+      this.config = this.consts.defaultConfig
+      this.applyUserConfig(config)
+
+      // Set up the Homebridge events
+      this.api.on('didFinishLaunching', () => this.pluginSetup())
+      this.api.on('shutdown', () => this.pluginShutdown())
+    } catch (err) {
+      // Catch any errors during initialisation
+      const eText = this.funcs.parseError(err, [this.lang.hbVersionFail, this.lang.pluginNotConf])
+      log.warn('***** %s. *****', this.lang.disabling)
+      log.warn('***** %s. *****', eText)
     }
-    if (config["polling_minutes"] != null) {
-      this.interval = parseInt(config["polling_minutes"]) * 60 * 1000;
-    } else {
-       this.interval = 1 * 60 * 1000;
+  }
+
+  applyUserConfig (config) {
+    // These shorthand functions save line space during config parsing
+    const logDefault = (k, def) => {
+      this.log.warn('%s [%s] %s %s.', this.lang.cfgItem, k, this.lang.cfgDef, def)
+    }
+    const logIgnore = k => {
+      this.log.warn('%s [%s] %s.', this.lang.cfgItem, k, this.lang.cfgIgn)
+    }
+    const logIncrease = (k, min) => {
+      this.log.warn('%s [%s] %s %s.', this.lang.cfgItem, k, this.lang.cfgLow, min)
+    }
+    const logQuotes = k => {
+      this.log.warn('%s [%s] %s.', this.lang.cfgItem, k, this.lang.cfgQts)
+    }
+    const logRemove = k => {
+      this.log.warn('%s [%s] %s.', this.lang.cfgItem, k, this.lang.cfgRmv)
     }
-    this.debug = config["debug"] || true;
 
-    if (!this.username) throw new Error("You must provide a value for username.");
-    if (!this.password) throw new Error("You must provide a value for password.");
-    if (!this.client_id) throw new Error("You must provide a value for client_id.");
-    if (!this.client_secret) throw new Error("You must provide a value for client_secret.");
+    // Begin applying the user's config
+    for (const [key, val] of Object.entries(config)) {
+      switch (key) {
+        case 'client_id':
+        case 'client_secret':
+        case 'password':
+        case 'username':
+          if (typeof val !== 'string' || val === '') {
+            logIgnore(key)
+          } else {
+            this.config[key] = val
+          }
+          break
+        case 'debug':
+        case 'disableDeviceLogging':
+        case 'disablePlugin':
+          if (typeof val === 'string') {
+            logQuotes(key)
+          }
+          this.config[key] = val === 'false' ? false : !!val
+          break
+        case 'handicap': {
+          if (typeof v === 'string') {
+            logQuotes(key)
+          }
+          const numVal = Number(val)
+          if (isNaN(numVal)) {
+            logIgnore(key)
+          } else {
+            this.config[key] = numVal
+          }
+          break
+        }
+        case 'name':
+        case 'platform':
+        case 'plugin_map':
+          break
+        case 'polling_minutes': {
+          if (typeof val === 'string') {
+            logQuotes(key)
+          }
+          const intVal = parseInt(val)
+          if (isNaN(intVal)) {
+            logDefault(key, this.consts.defaultValues[key])
+            this.config[key] = this.consts.defaultValues[key]
+          } else if (intVal < this.consts.minValues[key]) {
+            logIncrease(key, this.consts.minValues[key])
+            this.config[key] = this.consts.minValues[key]
+          } else {
+            this.config[key] = intVal
+          }
+          break
+        }
+        default:
+          logRemove(key)
+          break
+      }
+    }
+  }
 
-    this.expires_in = Date.now();
-    this.device_id = "";
-    this.device_usage = 0.00;
+  async pluginSetup () {
+    // Plugin has finished initialising so now onto setup
+    try {
+      // 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(this.lang.disabled)
+      }
 
-    log("User variables loaded.");
+      // Log that the plugin initialisation has been successful
+      this.log('%s.', this.lang.initialised)
 
-    if (api) {
-      this.api = api;
-      this.api.on('didFinishLaunching', this.fetchDevices.bind(this));
-      this.timer = setInterval(this.fetchDevices.bind(this), this.interval);
+      // Ensure username and password have been provided
+      if (
+        !this.config.username ||
+        !this.config.password ||
+        !this.config.client_id ||
+        !this.config.client_secret
+      ) {
+        throw new Error(this.lang.noCreds)
+      }
 
-        log("Update interval set.");
-    }
+      // Setup the HTTP client if Thermobit username and password have been provided
+      this.httpClient = new (require('./connection/http'))(this)
+      await this.httpClient.obtainToken()
+      const deviceList = await this.httpClient.getDevices()
 
-    log("Initial load of the accessory started.");
+      // Check we have devices we can work with
+      if (!Array.isArray(deviceList) || deviceList.length === 0) {
+        throw new Error(this.lang.noDevices)
+      }
 
-    // get the Valve service if it exists, otherwise create a new Valve service
-    this.informationService = this.accessory.getService(Service.Valve) ||
-    this.accessory.addService(Service.Valve);
+      deviceList.forEach(device => {
+        if (!device.bridge_id) {
+          return
+        }
+        this.initialiseDevice(device)
+      })
 
-   this.informationService
-         .setCharacteristic(Characteristic.Manufacturer, "Flume Water Monitor")
-        .setCharacteristic(Characteristic.Model, "001")
-        .setCharacteristic(Characteristic.SerialNumber, this.device_id)
-        .setCharacteristic(Characteristic.Name, accessory.context.device.name)
-        .setCharacteristic(Characteristic.Active, false)
-        .setCharacteristic(Characteristic.InUse, false)
-        .setCharacteristic(Characteristic.ValveType, "3")
-        .setCharacteristic(Characteristic.StatusFault, false);
+      // Set up an initial last sync time
+      this.lastSync = new Date(Date.now() - this.config.polling_minutes * 60000)
 
-    log("Starting position is water is Off");
-    log("Load of the accessory complete.");
-}
+      // Perform a first sync and setup the refresh interval
+      this.flumeSync()
+      this.refreshInterval = setInterval(
+        () => this.flumeSync(),
+        this.config.polling_minutes * 60000
+      )
 
-Flume.prototype.getAccessToken = function() {
-    var now = Date.now();
-
-    log("Getting the access token.");
-
-    if (!this.access_token) {
-    return fetch('https://api.flumetech.com/oauth/token', {
-                method: 'POST',
-                headers: {
-                    'content-type': 'application/json'
-                },
-                body: '{"grant_type":"password","client_id":' + this.client_id + ',"client_secret":' + this.client_secret + ',"username":' + this.username + ',"password":' + this.password + '}'
-            })
-            .then(res => {
-                if (res.ok) {
-                    return res.json();
-                    log("res was okay.");
-                } else {
-                    log("ERROR! Unable to retrieve new token: " + res.statusText);
-                }
-            })
-            .then(json => {
-                this.access_token = json.access_token;
-                this.refresh_token = json.refresh_token;
-                this.expires_in = now + json.expires_in;
-                this.log("Token received: " + this.access_token);
-                this.log("Refresh token received: " + this.refresh_token);
-                this.log("Token expires at: " + new Date(this.expires_in));
-                return this.access_token;
-            });
-  } else if (now > this.expires_in) {
-        return fetch('https://api.flumetech.com/oauth/token', {
-            method: 'POST',
-            headers: {
-              'content-type': 'application/json'
-            },
-            body: '{"grant_type":"refresh_token","client_id":' + this.client_id + ',"client_secret":' + this.client_secret + ',"refresh_token":' + this.refresh_token + '}'
-        })
-        .then(res => {
-          if (res.ok) {
-              return res.json();
-            } else {
-              log("ERROR! Unable to retrieve new token: " + res.statusText);
-            }
-        })
-        .then(json => {
-          this.access_token = json.access_token;
-            this.expires_in = now + json.expires_in;
-            this.log("Token received: " + this.access_token);
-            this.log("Refresh token received: " + this.refresh_token);
-            this.log("Token expires at: " + new Date(this.expires_in));
-            return this.access_token;
-        });
+      // Log that the plugin setup has been successful with a welcome message
+      const randIndex = Math.floor(Math.random() * this.lang.zWelcome.length)
+      this.log('%s. %s', this.lang.complete, this.lang.zWelcome[randIndex])
+    } catch (err) {
+      // Catch any errors during setup
+      const eText = this.funcs.parseError(err, [
+        this.lang.noCreds,
+        this.lang.noDevices,
+        this.lang.disabled
+      ])
+      this.log.warn('***** %s. *****', this.lang.disabling)
+      this.log.warn('***** %s. *****', eText)
+      this.pluginShutdown()
     }
+  }
 
-    this.log("Getting User ID from JWT.")
-
-    var token = this.access_token;
-  var decoded = jwt_decode(token);
-  // or perhaps: decoded = jwt.decode(config["access_token"], verify=False)
-
-  this.log(decoded);
-  this.user_id = decoded.user_id;    // or perhaps: decoded["user_id"]
-  this.log("User ID: " + this.user_id);
-    this.log("Device ID: " + this.device_id);
-
-    return fetch('https://api.flumetech.com/users/' + this.user_id + '/devices', {
-      method: 'GET',
-        headers: {
-          'authorization': '' + this.access_token + ''
-            },
-        })
-        .then(res => {
-          if (res.ok) {
-              return res.json();
-            } else {
-              log("ERROR! Unable to retrieve devices: " + res.statusText);
-            }
-        })
-        .then(json => {
-          this.device_id = json.id;
-            this.log("User ID: " + this.user_id);
-            this.log("Device ID: " + this.device_id);
-            return this.device_id;
-        });
+  pluginShutdown () {
+    // A function that is called when the plugin fails to load or Homebridge restarts
+    try {
+      // Stop the refresh interval
+      if (this.refreshInterval) {
+        clearInterval(this.refreshInterval)
+      }
+    } catch (err) {
+      // No need to show errors at this point
+    }
   }
 
+  async flumeSync () {
+    try {
+      const fromWhen = this.lastSync
+        .toISOString()
+        .substring(0, 19)
+        .replace('T', ' ')
+      this.devicesInHB.forEach(async accessory => {
+        try {
+          const res = await this.httpClient.getDeviceInfo(accessory.context.deviceId, fromWhen)
+          res.fromWhen = fromWhen
+          accessory.control.externalUpdate(res)
+        } catch (err) {
+          const eText = this.funcs.parseError(err)
+          this.log.warn(eText)
+        }
+      })
 
-Flume.prototype.fetchDevices = function() {
-    this.log("Fetching current devices and statuses.");
-
-    // alternative approach: var previousminute = (datetime.datetime.now() - datetime.timedelta(minutes=1)).strftime('%Y-%m-%d %H:%M:%S');
-  var currentminute = (datetime.datetime.now() - datetime.timedelta(minutes=1)).strftime('%Y-%m-%d %H:%M:%S');
-
-    this.log("Token: " + this.access_token);
-    this.log("User ID: " + this.user_id);
-    this.log("Device ID: " + this.device_id);
-
-    this.getAccessToken()
-      .then(token => fetch('https://api.flumetech.com/users/' + this.user_id + '/devices/' + this.device_id + '/query', {
-          method: 'POST',
-            headers: {
-              'content-type': 'application/json',
-                'authorization': 'Bearer ' + this.access_token
-            },
-      body: '{"queries":[{"request_id":"currentusage","bucket":"MIN","since_datetime": currentminute,"operation":"SUM","units":"GALLONS"}]}'
-      // alternative approach might be payload = '{"queries":[{"request_id":"perminute","bucket":"MIN","since_datetime":"' + previousminute() + '","until_datetime":"' + currentminute() + '","group_multiplier":"1","operation":"SUM","sort_direction":"ASC","units":"GALLONS"}]}'
-        // as seen at https://github.com/ScriptBlock/flumecli/blob/master/flumecli.py
-        })
-        .then(res => {
-          if (res.ok) {
-              return res.json();
-                this.device_usage = value;
-            } else {
-              log("ERROR! Unable to retrieve devices: " + res.statusText);
-            }
-        }));
-
-    log("Updating the status");
-        this.updateState(accessory);
-    log("Updated the status");
+      this.lastSync = new Date()
+    } catch (err) {
+      // Catch any errors performing the sync
+      const eText = this.funcs.parseError(err, [])
+      this.log.warn('%s %s.', this.lang.syncFailed, eText)
     }
+  }
+
+  initialiseDevice (device) {
+    try {
+      /*
+        {
+          id: '',
+          type: 2,
+          location_id: 0000,
+          user_id: 0000,
+          bridge_id: '',
+          oriented: true,
+          last_seen: '',
+          connected: true,
+          battery_level: 'high',
+          product: 'flume1'
+        }
+      */
+
+      const uuid = this.api.hap.uuid.generate(device.id)
+
+      // Get the cached accessory or add to Homebridge if doesn't exist
+      const accessory = this.devicesInHB.get(uuid) || this.addAccessory(device)
+
+      // Final check the accessory now exists in Homebridge
+      if (!accessory) {
+        throw new Error(this.lang.accNotFound)
+      }
 
+      // Create the instance for this device type
+      accessory.control = new (require('./device/valve'))(this, accessory)
 
-Flume.prototype.updateState = function(accessory) {
-    var fresh = Date.now() - Date.parse(accessory.context.time + ".000Z") < 60 * 60 * 1000;
+      // Log the device initialisation
+      this.log('[%s] %s [%s].', accessory.displayName, this.lang.devInit, device.id)
+    } catch (err) {
+      // Catch any errors during device initialisation
+      const eText = this.funcs.parseError(err, [this.lang.accNotFound])
+      this.log.warn('[%s] %s %s.', device.id, this.lang.devNotInit, eText)
+    }
+  }
+
+  addAccessory (device) {
+    // Add an accessory to Homebridge
+    try {
+      const uuid = this.api.hap.uuid.generate(device.id)
+      const accessory = new this.api.platformAccessory(this.lang.brand, uuid)
+      accessory
+        .getService(this.api.hap.Service.AccessoryInformation)
+        .setCharacteristic(this.api.hap.Characteristic.Name, this.lang.brand)
+        .setCharacteristic(this.api.hap.Characteristic.ConfiguredName, this.lang.brand)
+        .setCharacteristic(this.api.hap.Characteristic.Manufacturer, this.lang.brand)
+        .setCharacteristic(this.api.hap.Characteristic.SerialNumber, device.id)
+        .setCharacteristic(this.api.hap.Characteristic.Model, device.product)
+        .setCharacteristic(this.api.hap.Characteristic.Identify, true)
+      accessory.context.deviceId = device.id
+      this.api.registerPlatformAccessories(plugin.name, plugin.alias, [accessory])
+      this.devicesInHB.set(accessory.UUID, accessory)
+      this.log('[%s] %s.', accessory.displayName, this.lang.devAdd)
+      return accessory
+    } catch (err) {
+      // Catch any errors during add
+      const eText = this.funcs.parseError(err)
+      this.log.warn('[%s] %s %s.', this.lang.brand, this.lang.devNotAdd, eText)
+    }
+  }
 
-    log("Device Usage & Handicap: ");
-    log(this.device_usage);
-    log(this.handicap);
+  configureAccessory (accessory) {
+    // Add the configured accessory to our global map
+    this.devicesInHB.set(accessory.UUID, accessory)
+  }
 
-    if (this.device_usage > this.handicap) {
-      log("Water is On");
-      accessory.getService(Service.Valve)
-        .setCharacteristic(Characteristic.Active, true)
-        .setCharacteristic(Characteristic.InUse, true);
-  } else {
-       log("Water is Off");
-       accessory.getService(Service.Valve)
-        .setCharacteristic(Characteristic.Active, false)
-        .setCharacteristic(Characteristic.InUse, false);
+  removeAccessory (accessory) {
+    // Remove an accessory from Homebridge
+    try {
+      this.api.unregisterPlatformAccessories(plugin.name, plugin.alias, [accessory])
+      this.devicesInHB.delete(accessory.UUID)
+      this.log('[%s] %s.', accessory.displayName, this.lang.devRemove)
+    } catch (err) {
+      // Catch any errors during remove
+      const eText = this.funcs.parseError(err)
+      const name = accessory.displayName
+      this.log.warn('[%s] %s %s.', name, this.lang.devNotRemove, eText)
+    }
   }
 }
+
+// Export the plugin to Homebridge
+module.exports = hb => hb.registerPlatform(plugin.alias, FlumePlatform)

package/lib/utils/constants.js

@@ -0,0 +1,31 @@
+/* jshint node: true, esversion: 10, -W014, -W033 */
+/* eslint-disable new-cap */
+'use strict'
+
+module.exports = {
+  defaultConfig: {
+    name: 'Flume',
+    username: '',
+    password: '',
+    client_id: '',
+    client_secret: '',
+    polling_minutes: 1,
+    handicap: 0,
+    disableDeviceLogging: false,
+    debug: false,
+    disablePlugin: false,
+    platform: 'Flume'
+  },
+
+  defaultValues: {
+    polling_minutes: 1,
+    handicap: 0
+  },
+
+  minValues: {
+    polling_minutes: 1,
+    handicap: 0
+  },
+
+  httpRetryCodes: ['ENOTFOUND', 'ETIMEDOUT', 'EAI_AGAIN', 'ECONNABORTED']
+}

package/lib/utils/functions.js

@@ -0,0 +1,33 @@
+/* jshint node: true, esversion: 10, -W014, -W033 */
+/* eslint-disable new-cap */
+'use strict'
+
+module.exports = {
+  hasProperty: (obj, prop) => {
+    return Object.prototype.hasOwnProperty.call(obj, prop)
+  },
+
+  sleep: ms => {
+    return new Promise(resolve => setTimeout(resolve, ms))
+  },
+
+  parseError: (err, hideStack = []) => {
+    let toReturn = err.message
+    if (err.stack && err.stack.length > 0 && !hideStack.includes(err.message)) {
+      const stack = err.stack.split('\n')
+      if (stack[1]) {
+        toReturn += stack[1].replace('   ', '')
+      }
+    }
+    return toReturn
+  },
+
+  generateRandomString: length => {
+    const chars = 'abcdefghijklmnopqrstuvwxyz0123456789'
+    let nonce = ''
+    while (nonce.length < length) {
+      nonce += chars.charAt(Math.floor(Math.random() * chars.length))
+    }
+    return nonce
+  }
+}

package/lib/utils/lang-en.js

@@ -0,0 +1,64 @@
+/* jshint node: true, esversion: 10, -W014, -W033 */
+/* eslint-disable new-cap */
+'use strict'
+
+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',
+  cfgIgn: 'is not configured correctly so ignoring',
+  cfgIgnItem: 'has an invalid entry which will be ignored',
+  cfgItem: 'Config entry',
+  cfgLow: 'is set too low so increasing to',
+  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',
+  devNotConf: 'could not be configured as',
+  devNotInit: 'could not be initialised as',
+  devNotRef: 'could not be refreshed as',
+  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',
+  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 Thermobit, retrying in 30 seconds',
+  initialised: 'Plugin initialised. Setting up accessories...',
+  initialising: 'Initialising plugin',
+  labelHeating: 'heating',
+  labelIdle: 'idle',
+  labelMan: 'manual',
+  labelSch: 'schedule',
+  noCreds: 'Thermobit username and/or password not configured',
+  noDevices: 'no data received from Thermobit server whilst obtaining device list',
+  noTokenExists: 'no Thermobit account token exists',
+  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!',
+    '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",
+    'Want to see this plugin in your own language? Let me know!'
+  ]
+}

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "homebridge-flume",
   "alias": "Flume",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "author": {
-    "name": "Darrin Thomas",
+    "name": "Ben Potter",
     "email": "bwp91@icloud.com"
   },
   "description": "Homebridge plugin to integrate Flume devices into HomeKit.",
@@ -23,7 +23,7 @@
     "water leak detector"
   ],
   "engines": {
-    "homebridge": "^1.3.6",
+    "homebridge": "^1.3.8",
     "node": "^14.18.1 || ^16.13.0"
   },
   "repository": {
@@ -34,16 +34,11 @@
     "url": "https://github.com/bwp91/homebridge-flume/issues"
   },
   "dependencies": {
-    "homebridge-http-base": "^2.1.12",
-    "jwt-decode": "^3.1.2",
-    "node-fetch": "^2.6.0"
+    "@homebridge/plugin-ui-utils": "^0.0.19",
+    "axios": "^0.24.0",
+    "jwt-decode": "^3.1.2"
   },
   "prettier": {
     "printWidth": 100
-  },
-  "standard": {
-    "ignore": [
-      "/lib/index.js"
-    ]
   }
 }