homebridge-flume 1.0.0 → 1.2.2

package/CHANGELOG.md

@@ -2,6 +2,35 @@
 
 All notable changes to homebridge-flume will be documented in this file.
 
+## 1.2.2 (2021-12-21)
+
+### Changed
+
+- Some config options rearranged for easier access
+
+## 1.2.1 (2021-12-08)
+
+### Changed
+
+- Bump `homebridge` recommended version to v1.3.8
+- Bump `node` recommended versions to v14.18.2 or v16.13.1
+
+## 1.2.0 (2021-12-01)
+
+### Added
+
+- Previous month usage custom characteristic (viewable in HomeKit apps like Eve)
+
+## 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

package/config.schema.json

@@ -39,23 +39,6 @@
         "required": true,
         "description": "Your Flume Client Secret, found at https://portal.flumetech.com."
       },
-      "refreshInterval": {
-        "title": "Refresh Interval",
-        "type": "integer",
-        "placeholder": 2,
-        "description": "Number of minutes between updates. Must be 2 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."
-      },
-      "disableDeviceLogging": {
-        "type": "boolean",
-        "title": "Disable Device Logging",
-        "description": "Global logging setting for accessory status changes. If true then accessory status changes will not be logged."
-      },
       "debug": {
         "title": "Debug Logging",
         "type": "boolean",
@@ -65,6 +48,17 @@
         "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",
+        "description": "Global logging setting for accessory status changes. If true then accessory status changes will not be logged."
+      },
+      "refreshInterval": {
+        "title": "Refresh Interval",
+        "type": "integer",
+        "placeholder": 2,
+        "description": "Number of minutes between updates. Must be 2 or more."
       }
     }
   },
@@ -72,14 +66,14 @@
     {
       "type": "fieldset",
       "title": "Required Settings",
-      "items": ["username", "password", "clientId", "clientSecret"]
+      "items": ["username", "password", "clientId", "clientSecret", "debug", "disablePlugin"]
     },
     {
       "type": "fieldset",
-      "title": "Optional Settings",
-      "description": "Optional settings for the plugin, including global logging settings.",
+      "title": "Advanced Settings",
+      "description": "Advanced settings for the plugin, including refresh options.",
       "expandable": true,
-      "items": ["refreshInterval", "threshold", "disableDeviceLogging", "debug", "disablePlugin"]
+      "items": ["disableDeviceLogging", "refreshInterval"]
     }
   ]
 }

package/lib/connection/http.js

@@ -238,13 +238,40 @@ module.exports = class connectionHTTP {
       await this.renewToken()
     }
 
+    // Generate dates for the query data
+    const date = new Date()
+    const startOfToday = date.toISOString().substring(0, 10) + ' 00:00:00'
+
+    // Set the date to the first of the current month
+    date.setDate(1)
+    const startOfCurrMonth = date.toISOString().substring(0, 10) + ' 00:00:00'
+
+    // Set the month to the previous month
+    date.setMonth(date.getMonth() - 1)
+    const startOfPrevMonth = date.toISOString().substring(0, 10) + ' 00:00:00'
+
     // Generate the JSON data to send
     const body = {
       queries: [
         {
-          request_id: 'currentusage',
-          bucket: 'MIN',
-          since_datetime: fromWhen,
+          request_id: 'today',
+          bucket: 'DAY',
+          since_datetime: startOfToday,
+          operation: 'SUM',
+          units: 'GALLONS'
+        },
+        {
+          request_id: 'month',
+          bucket: 'MON',
+          since_datetime: startOfCurrMonth,
+          operation: 'SUM',
+          units: 'GALLONS'
+        },
+        {
+          request_id: 'prevMonth',
+          bucket: 'MON',
+          since_datetime: startOfPrevMonth,
+          until_datetime: startOfCurrMonth,
           operation: 'SUM',
           units: 'GALLONS'
         }

package/lib/device/{valve.js → leak-sensor.js}

@@ -2,12 +2,12 @@
 /* eslint-disable new-cap */
 'use strict'
 
-module.exports = class deviceValve {
+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.threshold = platform.config.threshold
     this.hapChar = platform.api.hap.Characteristic
     this.hapErr = platform.api.hap.HapStatusError
     this.hapServ = platform.api.hap.Service
@@ -25,6 +25,17 @@ module.exports = class deviceValve {
     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)
+    }
+    if (!this.leakService.testCharacteristic(this.cusChar.PrevMonthUsage)) {
+      this.leakService.addCharacteristic(this.cusChar.PrevMonthUsage)
+    }
   }
 
   externalUpdate (params) {
@@ -58,19 +69,38 @@ module.exports = class deviceValve {
       this.log('[%s] current status [%sconnected].', this.name, this.cacheStatus ? '' : 'not ')
     }
 
-    const usage =
-      params.waterInfo.currentusage &&
-      params.waterInfo.currentusage[0] &&
-      params.waterInfo.currentusage[0].value
-        ? params.waterInfo.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
-      )
+    // 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
+        )
+      }
+      if (
+        params.waterInfo.prevMonth &&
+        params.waterInfo.prevMonth[0] &&
+        this.funcs.hasProperty(params.waterInfo.prevMonth[0], 'value')
+      ) {
+        this.leakService.updateCharacteristic(
+          this.cusChar.PrevMonthUsage,
+          params.waterInfo.prevMonth[0].value
+        )
+      }
     }
   }
 }

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,17 +222,19 @@ class FlumePlatform {
 
   async flumeSync () {
     try {
-      const since = 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 toReturn = { since }
+          const toReturn = {}
           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
+          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)
@@ -251,9 +242,8 @@ class FlumePlatform {
           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, [])
@@ -289,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

@@ -9,22 +9,19 @@ module.exports = {
     password: '',
     clientId: '',
     clientSecret: '',
-    refreshInterval: 1,
-    threshold: 0,
-    disableDeviceLogging: false,
     debug: false,
     disablePlugin: false,
+    disableDeviceLogging: false,
+    refreshInterval: 1,
     platform: 'Flume'
   },
 
   defaultValues: {
-    refreshInterval: 2,
-    threshold: 0
+    refreshInterval: 2
   },
 
   minValues: {
-    refreshInterval: 2,
-    threshold: 0
+    refreshInterval: 2
   },
 
   httpRetryCodes: ['ENOTFOUND', 'ETIMEDOUT', 'EAI_AGAIN', 'ECONNABORTED']

package/lib/utils/custom-chars.js

@@ -0,0 +1,50 @@
+/* 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',
+      prevMonthUsage: 'E966F003-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()
+    }
+    this.PrevMonthUsage = function () {
+      self.hapChar.call(this, 'Previous Month', self.uuids.prevMonthUsage)
+      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)
+    inherits(this.PrevMonthUsage, this.hapChar)
+    this.TodayUsage.UUID = this.uuids.todayUsage
+    this.MonthUsage.UUID = this.uuids.monthUsage
+    this.PrevMonthUsage.UUID = this.uuids.prevMonthUsage
+  }
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "homebridge-flume",
   "alias": "Flume",
-  "version": "1.0.0",
+  "version": "1.2.2",
   "author": {
     "name": "Ben Potter",
     "email": "bwp91@icloud.com"
@@ -24,7 +24,7 @@
   ],
   "engines": {
     "homebridge": "^1.3.8",
-    "node": "^14.18.1 || ^16.13.0"
+    "node": "^14.18.2 || ^16.13.1"
   },
   "repository": {
     "type": "git",