homebridge-flume 1.1.0 → 1.2.3

package/CHANGELOG.md

@@ -2,6 +2,33 @@
 
 All notable changes to homebridge-flume will be documented in this file.
 
+## 1.2.3 (2022-01-03)
+
+### Changed
+
+- HOOBS certified badge on README
+- Plugin will log HAPNodeJS version on startup
+- Bump `homebridge` recommended version to v1.3.9
+
+## 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

package/README.md

@@ -7,7 +7,8 @@
 
 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)  
+[![verified-by-homebridge](https://badgen.net/badge/homebridge/verified/purple)](https://github.com/homebridge/homebridge/wiki/Verified-Plugins)
+[![hoobs-certified](https://badgen.net/badge/HOOBS/certified/yellow)](https://plugins.hoobs.org/plugin/homebridge-thermobit)   
 [![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)

package/config.schema.json

@@ -39,17 +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."
-      },
-      "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",
@@ -59,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."
       }
     }
   },
@@ -66,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", "disableDeviceLogging", "debug", "disablePlugin"]
+      "items": ["disableDeviceLogging", "refreshInterval"]
     }
   ]
 }

package/lib/connection/http.js

@@ -237,8 +237,18 @@ module.exports = class connectionHTTP {
     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 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 = {
@@ -246,14 +256,22 @@ module.exports = class connectionHTTP {
         {
           request_id: 'today',
           bucket: 'DAY',
-          since_datetime: today,
+          since_datetime: startOfToday,
           operation: 'SUM',
           units: 'GALLONS'
         },
         {
           request_id: 'month',
           bucket: 'MON',
-          since_datetime: month,
+          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/leak-sensor.js

@@ -33,6 +33,9 @@ module.exports = class deviceLeakSensor {
     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) {
@@ -88,6 +91,16 @@ module.exports = class deviceLeakSensor {
           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

@@ -38,11 +38,12 @@ class FlumePlatform {
 
       // Log some environment info for debugging
       this.log(
-        '%s v%s | Node %s | HB v%s%s...',
+        '%s v%s | Node %s | HB v%s | HAPNodeJS v%s%s...',
         this.lang.initialising,
         plugin.version,
         process.version,
         api.serverVersion,
+        api.hap.HAPLibraryVersion(),
         config.plugin_map
           ? ' | HOOBS v3'
           : require('os')

package/lib/utils/constants.js

@@ -9,10 +9,10 @@ module.exports = {
     password: '',
     clientId: '',
     clientSecret: '',
-    refreshInterval: 1,
-    disableDeviceLogging: false,
     debug: false,
     disablePlugin: false,
+    disableDeviceLogging: false,
+    refreshInterval: 1,
     platform: 'Flume'
   },
 

package/lib/utils/custom-chars.js

@@ -8,7 +8,8 @@ module.exports = class customCharacteristics {
     this.hapChar = api.hap.Characteristic
     this.uuids = {
       todayUsage: 'E966F001-079E-48FF-8F27-9C2605A29F52',
-      monthUsage: 'E966F002-079E-48FF-8F27-9C2605A29F52'
+      monthUsage: 'E966F002-079E-48FF-8F27-9C2605A29F52',
+      prevMonthUsage: 'E966F003-079E-48FF-8F27-9C2605A29F52'
     }
     const self = this
     this.TodayUsage = function () {
@@ -29,10 +30,21 @@ module.exports = class customCharacteristics {
       })
       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.1.0",
+  "version": "1.2.3",
   "author": {
     "name": "Ben Potter",
     "email": "bwp91@icloud.com"
@@ -23,8 +23,8 @@
     "water leak detector"
   ],
   "engines": {
-    "homebridge": "^1.3.8",
-    "node": "^14.18.1 || ^16.13.0"
+    "homebridge": "^1.3.9",
+    "node": "^14.18.2 || ^16.13.1"
   },
   "repository": {
     "type": "git",