homebridge-flume 0.4.0 → 1.0.0

package/CHANGELOG.md

@@ -2,6 +2,38 @@
 
 All notable changes to homebridge-flume will be documented in this file.
 
+## 1.0.0 (2021-11-29)
+
+### Added
+
+- Plugin logo
+
+## 0.7.0 (2021-11-24)
+
+### Added
+
+- `StatusFault` and `StatusLowBattery` characteristics to the `LeakSensor` service
+
+## 0.6.0 (2021-11-24)
+
+### Added
+
+- Leak sensor service
+
+### Changed
+
+- Minimum refresh interval increased to two minutes
+
+## 0.5.0 (2021-11-23)
+
+### Added
+
+- Make use of the debug logging option for HTTP responses
+
+### Changed
+
+- `client_id` and `client_secret` config options changed to `clientId` and `clientSecret` for consistency
+
 ## 0.4.0 (2021-11-23)
 
 ### Added

package/README.md

@@ -1,17 +1,20 @@
+<p align="center">
+   <a href="https://github.com/bwp91/homebridge-flume"><img src="https://user-images.githubusercontent.com/43026681/143831753-ed67cad2-909a-4337-9b18-dd8e65dfdf5e.png" width="600px"></a>
+</p>
 <span align="center">
-  
-  # homebridge-flume
-  
-  Homebridge plugin to integrate Flume devices into HomeKit
-  
-  [![verified-by-homebridge](https://badgen.net/badge/homebridge/verified/purple)](https://github.com/homebridge/homebridge/wiki/Verified-Plugins)  
-  [![npm](https://img.shields.io/npm/v/homebridge-flume/latest?label=latest)](https://www.npmjs.com/package/homebridge-flume)
-  [![npm](https://img.shields.io/npm/v/homebridge-flume/beta?label=beta)](https://github.com/bwp91/homebridge-flume/wiki/Beta-Version)  
-  [![npm](https://img.shields.io/npm/dt/homebridge-flume)](https://www.npmjs.com/package/homebridge-flume)
-  [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)  
-  [![Discord](https://img.shields.io/discord/784827113378676736?color=728ED5&logo=discord&label=bwp91-discord)](https://discord.com/channels/784827113378676736/784827113378676739)
-  [![Discord](https://img.shields.io/discord/432663330281226270?color=728ED5&logo=discord&label=hb-discord)](https://discord.com/channels/432663330281226270/742733745743855627)
-  
+
+# homebridge-flume
+
+Homebridge plugin to integrate Flume devices into HomeKit
+
+[![verified-by-homebridge](https://badgen.net/badge/homebridge/verified/purple)](https://github.com/homebridge/homebridge/wiki/Verified-Plugins)  
+[![npm](https://img.shields.io/npm/v/homebridge-flume/latest?label=latest)](https://www.npmjs.com/package/homebridge-flume)
+[![npm](https://img.shields.io/npm/v/homebridge-flume/beta?label=beta)](https://github.com/bwp91/homebridge-flume/wiki/Beta-Version)  
+[![npm](https://img.shields.io/npm/dt/homebridge-flume)](https://www.npmjs.com/package/homebridge-flume)
+[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)  
+[![Discord](https://img.shields.io/discord/784827113378676736?color=728ED5&logo=discord&label=bwp91-discord)](https://discord.com/channels/784827113378676736/784827113378676739)
+[![Discord](https://img.shields.io/discord/432663330281226270?color=728ED5&logo=discord&label=hb-discord)](https://discord.com/channels/432663330281226270/742733745743855627)
+
 </span>
 
 ### Plugin Information
@@ -40,7 +43,8 @@
 
 ### Credits
 
-- This is a forked rewrite of the [homebridge-flume-water-sensor](https://www.npmjs.com/package/homebridge-flume-water-sensor) plugin by @weallknowwhoisatfaulthere
+- This is a forked rewrite of the [homebridge-flume-water-sensor](https://www.npmjs.com/package/homebridge-flume-water-sensor) plugin by @weallknowwhoisatfaulthere.
+- To the creator of the awesome plugin header logo: [Keryan Belahcene](https://www.instagram.com/keryan.me).
 - To the creators/contributors of [Homebridge](https://homebridge.io) who make this plugin possible.
 
 ### Disclaimer

package/config.schema.json

@@ -4,7 +4,7 @@
   "singular": true,
   "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>",
+  "headerDisplay": "<p align=\"center\"><img width=\"60%\" src=\"https://user-images.githubusercontent.com/43026681/143831753-ed67cad2-909a-4337-9b18-dd8e65dfdf5e.png\"></p><p align=\"center\">For help and support please visit our <a href=\"https://github.com/bwp91/homebridge-thermobit/wiki\">GitHub Wiki</a>. We hope you find this plugin useful!</p>",
   "schema": {
     "type": "object",
     "properties": {
@@ -17,39 +17,39 @@
         "title": "Username",
         "type": "string",
         "required": true,
-        "description": "Your username for accessing the Flume site at https://portal.flumetech.com"
+        "description": "Your Flume username."
       },
       "password": {
         "title": "Password",
         "type": "string",
         "required": true,
-        "description": "Your password for accessing the Flume site"
+        "description": "Your Flume password."
       },
-      "client_id": {
+      "clientId": {
         "title": "Client ID",
         "type": "string",
-        "placeholder": "12345678901234567890",
+        "placeholder": "1234567890ABCD",
         "required": true,
-        "description": "Your Client ID for API access, found in Settings on the Flume site"
+        "description": "Your Flume Client ID, found at https://portal.flumetech.com."
       },
-      "client_secret": {
+      "clientSecret": {
         "title": "Client Secret",
         "type": "string",
-        "placeholder": "1234567890",
+        "placeholder": "1234567890ABCDEFGHIJ",
         "required": true,
-        "description": "Your Client Secret for API access, found in Settings on the Flume site"
+        "description": "Your Flume Client Secret, found at https://portal.flumetech.com."
       },
       "refreshInterval": {
-        "title": "Refresh interval",
+        "title": "Refresh Interval",
         "type": "integer",
-        "placeholder": 1,
-        "description": "Number of minutes between updates. API has a cap of 120 calls per hour."
+        "placeholder": 2,
+        "description": "Number of minutes between updates. Must be 2 or more."
       },
       "threshold": {
-        "title": "Adjustment for False Positives",
+        "title": "Threshold",
         "type": "number",
         "placeholder": 0,
-        "description": "Set to ignore a steady water draw below this value (gallons)."
+        "description": "Ignore a steady water draw below this value in gallons per refresh interval. Must be 0 or more."
       },
       "disableDeviceLogging": {
         "type": "boolean",
@@ -72,7 +72,7 @@
     {
       "type": "fieldset",
       "title": "Required Settings",
-      "items": ["username", "password", "client_id", "client_secret"]
+      "items": ["username", "password", "clientId", "clientSecret"]
     },
     {
       "type": "fieldset",

package/lib/connection/http.js

@@ -15,8 +15,8 @@ module.exports = class connectionHTTP {
     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
+    this.clientId = platform.config.clientId
+    this.clientSecret = platform.config.clientSecret
   }
 
   async obtainToken () {
@@ -24,8 +24,8 @@ module.exports = class connectionHTTP {
       // Generate the JSON data to send
       const body = {
         grant_type: 'password',
-        client_id: this.client_id,
-        client_secret: this.client_secret,
+        client_id: this.clientId,
+        client_secret: this.clientSecret,
         username: this.username,
         password: this.password
       }
@@ -62,6 +62,11 @@ module.exports = class connectionHTTP {
         }
       */
 
+      // Log the response if in debug mode
+      if (this.debug) {
+        this.log('[HTTP obtainToken()] %s.', JSON.stringify(res.data))
+      }
+
       // Make the token available in other functions
       this.accessToken = res.data.data[0].access_token
       this.refreshToken = res.data.data[0].refresh_token
@@ -95,11 +100,16 @@ module.exports = class connectionHTTP {
 
   async renewToken () {
     try {
+      // Check we have a refresh token
+      if (!this.refreshToken) {
+        throw new Error(this.lang.noRefreshToken)
+      }
+
       // Generate the JSON data to send
       const body = {
         grant_type: 'refresh_token',
-        client_id: this.client_id,
-        client_secret: this.client_secret,
+        client_id: this.clientId,
+        client_secret: this.clientSecret,
         refresh_token: this.refreshToken
       }
       const now = Date.now()
@@ -114,6 +124,11 @@ module.exports = class connectionHTTP {
         throw new Error(this.lang.noDataReceived)
       }
 
+      // Log the response if in debug mode
+      if (this.debug) {
+        this.log('[HTTP renewToken()] %s.', JSON.stringify(res.data))
+      }
+
       /*
           {
             success: true,
@@ -154,7 +169,7 @@ module.exports = class connectionHTTP {
   async getDevices () {
     try {
       // Check we have a user id
-      if (!this.userId) {
+      if (!this.userId || !this.accessToken) {
         throw new Error(this.lang.noUserId)
       }
 
@@ -169,6 +184,11 @@ module.exports = class connectionHTTP {
         throw new Error(this.lang.noDataReceived)
       }
 
+      // Log the response if in debug mode
+      if (this.debug) {
+        this.log('[HTTP getDevices()] %s.', JSON.stringify(res.data))
+      }
+
       return res.data.data
     } catch (err) {
       if (err.code && this.consts.httpRetryCodes.includes(err.code)) {
@@ -182,7 +202,37 @@ module.exports = class connectionHTTP {
     }
   }
 
-  async getDeviceInfo (deviceId, fromWhen) {
+  async getDeviceInfo (deviceId) {
+    // Refresh the access token if it has expired already
+    if (Date.now() > this.expiresIn) {
+      await this.renewToken()
+    }
+
+    // Send the request
+    const res = await axios.get(
+      'https://api.flumetech.com/users/' + this.userId + '/devices/' + deviceId,
+      {
+        headers: {
+          Authorization: 'Bearer ' + this.accessToken
+        }
+      }
+    )
+
+    // Check to see we got a response
+    if (!res.data) {
+      throw new Error(this.lang.noDataReceived)
+    }
+
+    // Log the response if in debug mode
+    if (this.debug) {
+      this.log('[HTTP getDeviceInfo()] %s.', JSON.stringify(res.data))
+    }
+
+    // Parse the response
+    return res.data.data[0]
+  }
+
+  async getWaterInfo (deviceId, fromWhen) {
     // Refresh the access token if it has expired already
     if (Date.now() > this.expiresIn) {
       await this.renewToken()
@@ -217,6 +267,41 @@ module.exports = class connectionHTTP {
       throw new Error(this.lang.noDataReceived)
     }
 
+    // Log the response if in debug mode
+    if (this.debug) {
+      this.log('[HTTP getWaterInfo()] %s.', JSON.stringify(res.data))
+    }
+
+    // Parse the response
+    return res.data.data[0]
+  }
+
+  async getLeakInfo (deviceId) {
+    // Refresh the access token if it has expired already
+    if (Date.now() > this.expiresIn) {
+      await this.renewToken()
+    }
+
+    // Send the request
+    const res = await axios.get(
+      'https://api.flumetech.com/users/' + this.userId + '/devices/' + deviceId + '/leaks/active',
+      {
+        headers: {
+          Authorization: 'Bearer ' + this.accessToken
+        }
+      }
+    )
+
+    // Check to see we got a response
+    if (!res.data) {
+      throw new Error(this.lang.noDataReceived)
+    }
+
+    // Log the response if in debug mode
+    if (this.debug) {
+      this.log('[HTTP getLeakInfo()] %s.', JSON.stringify(res.data))
+    }
+
     // Parse the response
     return res.data.data[0]
   }

package/lib/device/valve.js

@@ -6,24 +6,63 @@ 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.threshold = platform.config.threshold
     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.log = platform.config.disableDeviceLogging ? () => {} : platform.log
     this.name = accessory.displayName
     this.platform = platform
     this.refreshInterval = platform.config.refreshInterval
+
+    // Add the leak sensor service if it doesn't exist already
+    this.leakService =
+      this.accessory.getService(this.hapServ.LeakSensor) ||
+      this.accessory.addService(this.hapServ.LeakSensor)
+
+    this.cacheLeak = !!this.leakService.getCharacteristic(this.hapChar.LeakDetected).value
+    this.cacheBatt = !this.leakService.getCharacteristic(this.hapChar.StatusLowBattery).value
+    this.cacheStatus = !this.leakService.getCharacteristic(this.hapChar.StatusFault).value
   }
 
   externalUpdate (params) {
-    // Here we deal with the incoming data
+    // Check the data for leak detection
+    if (
+      this.funcs.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 ')
+    }
+
+    // Check the data for battery level, cacheBatt is true for OK and false for LOW
+    if (
+      this.funcs.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')
+    }
+
+    // Check the data for connectivity, cacheStatus is true for OK and false for NOT CONNECTED
+    if (
+      this.funcs.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 ')
+    }
+
     const usage =
-      params.currentusage && params.currentusage[0] && params.currentusage[0].value
-        ? params.currentusage[0].value
+      params.waterInfo.currentusage &&
+      params.waterInfo.currentusage[0] &&
+      params.waterInfo.currentusage[0].value
+        ? params.waterInfo.currentusage[0].value
         : 0
     if (usage > this.threshold) {
       this.log(

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

@@ -1,3 +1,10 @@
+<p class="text-center">
+  <img
+    src="https://user-images.githubusercontent.com/43026681/143831753-ed67cad2-909a-4337-9b18-dd8e65dfdf5e.png"
+    alt="homebridge-flume logo"
+    style="width: 60%;"
+  />
+</p>
 <div id="pageIntro" class="text-center" style="display: none;">
   <p class="lead">Thank you for installing <strong>homebridge-flume</strong></p>
   <p>
@@ -83,6 +90,10 @@
       >
       plugin by @weallknowwhoisatfaulthere
     </li>
+    <li>
+      To the creator of the awesome plugin header logo:
+      <a href="https://www.instagram.com/keryan.me" target="_blank">Keryan Belahcene</a>.
+    </li>
     <li>
       To the creators/contributors of
       <a href="https://homebridge.io" target="_blank">Homebridge</a> who make this plugin possible.

package/lib/index.js

@@ -88,8 +88,8 @@ class FlumePlatform {
     // Begin applying the user's config
     for (const [key, val] of Object.entries(config)) {
       switch (key) {
-        case 'client_id':
-        case 'client_secret':
+        case 'clientId':
+        case 'clientSecret':
         case 'password':
         case 'username':
           if (typeof val !== 'string' || val === '') {
@@ -161,8 +161,8 @@ class FlumePlatform {
       if (
         !this.config.username ||
         !this.config.password ||
-        !this.config.client_id ||
-        !this.config.client_secret
+        !this.config.clientId ||
+        !this.config.clientSecret
       ) {
         throw new Error(this.lang.noCreds)
       }
@@ -233,15 +233,20 @@ class FlumePlatform {
 
   async flumeSync () {
     try {
-      const fromWhen = this.lastSync
+      const since = 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)
+          const toReturn = { since }
+          const devInfo = await this.httpClient.getDeviceInfo(accessory.context.deviceId)
+          toReturn.devInfo = devInfo
+          const waterInfo = await this.httpClient.getWaterInfo(accessory.context.deviceId, since)
+          toReturn.waterInfo = waterInfo
+          const leakInfo = await this.httpClient.getLeakInfo(accessory.context.deviceId)
+          toReturn.leakInfo = leakInfo
+          accessory.control.externalUpdate(toReturn)
         } catch (err) {
           const eText = this.funcs.parseError(err)
           this.log.warn('[%s] %s %s.', accessory.displayName, this.lang.devNotRef, eText)

package/lib/utils/constants.js

@@ -7,8 +7,8 @@ module.exports = {
     name: 'Flume',
     username: '',
     password: '',
-    client_id: '',
-    client_secret: '',
+    clientId: '',
+    clientSecret: '',
     refreshInterval: 1,
     threshold: 0,
     disableDeviceLogging: false,
@@ -18,12 +18,12 @@ module.exports = {
   },
 
   defaultValues: {
-    refreshInterval: 1,
+    refreshInterval: 2,
     threshold: 0
   },
 
   minValues: {
-    refreshInterval: 1,
+    refreshInterval: 2,
     threshold: 0
   },
 

package/lib/utils/lang-en.js

@@ -31,6 +31,7 @@ module.exports = {
   initialising: 'Initialising plugin',
   noCreds: 'Flume username and/or password and/or client id/secret not configured',
   noDataReceived: 'No data received from request',
+  noRefreshToken: 'No refresh token has been retrieved',
   noUserId: 'No user id has been retrieved',
   pluginNotConf: 'Plugin has not been configured',
   syncFailed: 'Sync process failed as',

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "homebridge-flume",
   "alias": "Flume",
-  "version": "0.4.0",
+  "version": "1.0.0",
   "author": {
     "name": "Ben Potter",
     "email": "bwp91@icloud.com"