homebridge-flume 1.1.0 → 1.2.0

package/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 All notable changes to homebridge-flume will be documented in this file.
 
+## 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/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/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.0",
   "author": {
     "name": "Ben Potter",
     "email": "bwp91@icloud.com"