homebridge-flume 0.5.0 → 1.1.0

package/CHANGELOG.md

@@ -2,6 +2,38 @@
 
 All notable changes to homebridge-flume will be documented in this file.
 
+## 1.1.0 (2021-11-30)
+
+### Added
+
+- Daily and monthly usage custom characteristics (viewable in HomeKit apps like Eve)
+
+### Removed
+
+- `threshold` configuration option as unused
+
+## 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

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
@@ -41,6 +44,7 @@
 ### Credits
 
 - 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": {
@@ -42,14 +42,8 @@
       "refreshInterval": {
         "title": "Refresh Interval",
         "type": "integer",
-        "placeholder": 1,
-        "description": "Number of minutes between updates. Must be 1 or more."
-      },
-      "threshold": {
-        "title": "Threshold",
-        "type": "number",
-        "placeholder": 0,
-        "description": "Ignore a steady water draw below this value in gallons per refresh interval. Must be 0 or more."
+        "placeholder": 2,
+        "description": "Number of minutes between updates. Must be 2 or more."
       },
       "disableDeviceLogging": {
         "type": "boolean",
@@ -79,7 +73,7 @@
       "title": "Optional Settings",
       "description": "Optional settings for the plugin, including global logging settings.",
       "expandable": true,
-      "items": ["refreshInterval", "threshold", "disableDeviceLogging", "debug", "disablePlugin"]
+      "items": ["refreshInterval", "disableDeviceLogging", "debug", "disablePlugin"]
     }
   ]
 }

package/lib/connection/http.js

@@ -202,19 +202,58 @@ 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()
+    }
+    const today = new Date().toISOString().substring(0, 10) + ' 00:00:00'
+    const month = today.substring(0, 8) + '01' + today.substring(10)
+
     // Generate the JSON data to send
     const body = {
       queries: [
         {
-          request_id: 'currentusage',
-          bucket: 'MIN',
-          since_datetime: fromWhen,
+          request_id: 'today',
+          bucket: 'DAY',
+          since_datetime: today,
+          operation: 'SUM',
+          units: 'GALLONS'
+        },
+        {
+          request_id: 'month',
+          bucket: 'MON',
+          since_datetime: month,
           operation: 'SUM',
           units: 'GALLONS'
         }
@@ -239,7 +278,37 @@ module.exports = class connectionHTTP {
 
     // Log the response if in debug mode
     if (this.debug) {
-      this.log('[HTTP getDevice()] %s.', JSON.stringify(res.data))
+      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

package/lib/device/leak-sensor.js

@@ -0,0 +1,93 @@
+/* jshint node: true, esversion: 10, -W014, -W033 */
+/* eslint-disable new-cap */
+'use strict'
+
+module.exports = class deviceLeakSensor {
+  constructor (platform, accessory) {
+    // Set up variables from the platform
+    this.accessory = accessory
+    this.cusChar = platform.cusChar
+    this.funcs = platform.funcs
+    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.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
+
+    // Add the custom characteristics if they haven't been already
+    if (!this.leakService.testCharacteristic(this.cusChar.TodayUsage)) {
+      this.leakService.addCharacteristic(this.cusChar.TodayUsage)
+    }
+    if (!this.leakService.testCharacteristic(this.cusChar.MonthUsage)) {
+      this.leakService.addCharacteristic(this.cusChar.MonthUsage)
+    }
+  }
+
+  externalUpdate (params) {
+    // 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 ')
+    }
+
+    // Water info
+    if (params.waterInfo) {
+      if (
+        params.waterInfo.today &&
+        params.waterInfo.today[0] &&
+        this.funcs.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] &&
+        this.funcs.hasProperty(params.waterInfo.month[0], 'value')
+      ) {
+        this.leakService.updateCharacteristic(
+          this.cusChar.MonthUsage,
+          params.waterInfo.month[0].value
+        )
+      }
+    }
+  }
+}

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

@@ -106,18 +106,6 @@ class FlumePlatform {
           }
           this.config[key] = val === 'false' ? false : !!val
           break
-        case 'threshold': {
-          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':
@@ -167,6 +155,9 @@ class FlumePlatform {
         throw new Error(this.lang.noCreds)
       }
 
+      // Require any libraries that the accessory instances use
+      this.cusChar = new (require('./utils/custom-chars'))(this.api)
+
       // Setup the HTTP client if Thermobit username and password have been provided
       this.httpClient = new (require('./connection/http'))(this)
       await this.httpClient.obtainToken()
@@ -193,10 +184,8 @@ class FlumePlatform {
         }
       })
 
-      // Set up an initial last sync time
-      this.lastSync = new Date(Date.now() - this.config.refreshInterval * 60000)
-
       // Perform a first sync and setup the refresh interval
+      this.counter = 0
       this.flumeSync()
       this.refreshInterval = setInterval(
         () => this.flumeSync(),
@@ -233,22 +222,28 @@ class FlumePlatform {
 
   async flumeSync () {
     try {
-      const fromWhen = this.lastSync
-        .toISOString()
-        .substring(0, 19)
-        .replace('T', ' ')
+      // Reset the counter for water info once we reach 10
+      if (this.counter === 10) {
+        this.counter = 0
+      }
       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 = {}
+          const devInfo = await this.httpClient.getDeviceInfo(accessory.context.deviceId)
+          toReturn.devInfo = devInfo
+          if (this.counter === 0) {
+            const waterInfo = await this.httpClient.getWaterInfo(accessory.context.deviceId)
+            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)
         }
+        this.counter++
       })
-
-      this.lastSync = new Date()
     } catch (err) {
       // Catch any errors performing the sync
       const eText = this.funcs.parseError(err, [])
@@ -284,7 +279,7 @@ class FlumePlatform {
       }
 
       // Create the instance for this device type
-      accessory.control = new (require('./device/valve'))(this, accessory)
+      accessory.control = new (require('./device/leak-sensor'))(this, accessory)
 
       // Log the device initialisation
       this.log('[%s] %s [%s].', accessory.displayName, this.lang.devInit, device.id)

package/lib/utils/constants.js

@@ -10,7 +10,6 @@ module.exports = {
     clientId: '',
     clientSecret: '',
     refreshInterval: 1,
-    threshold: 0,
     disableDeviceLogging: false,
     debug: false,
     disablePlugin: false,
@@ -18,13 +17,11 @@ module.exports = {
   },
 
   defaultValues: {
-    refreshInterval: 1,
-    threshold: 0
+    refreshInterval: 2
   },
 
   minValues: {
-    refreshInterval: 1,
-    threshold: 0
+    refreshInterval: 2
   },
 
   httpRetryCodes: ['ENOTFOUND', 'ETIMEDOUT', 'EAI_AGAIN', 'ECONNABORTED']

package/lib/utils/custom-chars.js

@@ -0,0 +1,38 @@
+/* jshint node: true, esversion: 10, -W014, -W033 */
+/* eslint-disable new-cap */
+'use strict'
+
+module.exports = class customCharacteristics {
+  constructor (api) {
+    this.hapServ = api.hap.Service
+    this.hapChar = api.hap.Characteristic
+    this.uuids = {
+      todayUsage: 'E966F001-079E-48FF-8F27-9C2605A29F52',
+      monthUsage: 'E966F002-079E-48FF-8F27-9C2605A29F52'
+    }
+    const self = this
+    this.TodayUsage = function () {
+      self.hapChar.call(this, 'Today Usage', self.uuids.todayUsage)
+      this.setProps({
+        format: self.hapChar.Formats.UINT32,
+        perms: [self.hapChar.Perms.READ, self.hapChar.Perms.NOTIFY],
+        unit: 'Gallons'
+      })
+      this.value = this.getDefaultValue()
+    }
+    this.MonthUsage = function () {
+      self.hapChar.call(this, 'Month Usage', self.uuids.monthUsage)
+      this.setProps({
+        format: self.hapChar.Formats.UINT32,
+        perms: [self.hapChar.Perms.READ, self.hapChar.Perms.NOTIFY],
+        unit: 'Gallons'
+      })
+      this.value = this.getDefaultValue()
+    }
+    const inherits = require('util').inherits
+    inherits(this.TodayUsage, this.hapChar)
+    inherits(this.MonthUsage, this.hapChar)
+    this.TodayUsage.UUID = this.uuids.todayUsage
+    this.MonthUsage.UUID = this.uuids.monthUsage
+  }
+}

package/package.json

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

package/lib/device/valve.js

@@ -1,36 +0,0 @@
-/* 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.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.config.disableDeviceLogging ? () => {} : platform.log
-    this.name = accessory.displayName
-    this.platform = platform
-    this.refreshInterval = platform.config.refreshInterval
-  }
-
-  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.threshold) {
-      this.log(
-        '[%s] usage detected - [%s] gallons within the last [%s] minutes.',
-        this.name,
-        usage,
-        this.refreshInterval
-      )
-    }
-  }
-}