homebridge-flume 0.6.0 → 0.7.0

package/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 All notable changes to homebridge-flume will be documented in this file.
 
+## 0.7.0 (2021-11-24)
+
+### Added
+
+- `StatusFault` and `StatusLowBattery` characteristics to the `LeakSensor` service
+
 ## 0.6.0 (2021-11-24)
 
 ### Added

package/lib/connection/http.js

@@ -202,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()
@@ -239,7 +269,7 @@ module.exports = class connectionHTTP {
 
     // Log the response if in debug mode
     if (this.debug) {
-      this.log('[HTTP getDeviceInfo()] %s.', JSON.stringify(res.data))
+      this.log('[HTTP getWaterInfo()] %s.', JSON.stringify(res.data))
     }
 
     // Parse the response

package/lib/device/valve.js

@@ -23,22 +23,46 @@ module.exports = class deviceValve {
       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 ')
+      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/index.js

@@ -233,15 +233,17 @@ 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 toReturn = { fromWhen }
-          const devInfo = await this.httpClient.getDeviceInfo(accessory.context.deviceId, fromWhen)
+          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)

package/package.json

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