homebridge-flume 0.5.0 → 0.6.0

package/CHANGELOG.md

@@ -2,6 +2,16 @@
 
 All notable changes to homebridge-flume will be documented in this file.
 
+## 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/config.schema.json

@@ -42,8 +42,8 @@
       "refreshInterval": {
         "title": "Refresh Interval",
         "type": "integer",
-        "placeholder": 1,
-        "description": "Number of minutes between updates. Must be 1 or more."
+        "placeholder": 2,
+        "description": "Number of minutes between updates. Must be 2 or more."
       },
       "threshold": {
         "title": "Threshold",

package/lib/connection/http.js

@@ -239,7 +239,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 getDeviceInfo()] %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/valve.js

@@ -16,10 +16,26 @@ module.exports = class deviceValve {
     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
   }
 
   externalUpdate (params) {
     // Here we deal with the incoming data
+    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 ')
+    }
+
     const usage =
       params.currentusage && params.currentusage[0] && params.currentusage[0].value
         ? params.currentusage[0].value

package/lib/index.js

@@ -239,9 +239,12 @@ class FlumePlatform {
         .replace('T', ' ')
       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 = { fromWhen }
+          const devInfo = await this.httpClient.getDeviceInfo(accessory.context.deviceId, fromWhen)
+          toReturn.devInfo = devInfo
+          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)

package/lib/utils/constants.js

@@ -18,12 +18,12 @@ module.exports = {
   },
 
   defaultValues: {
-    refreshInterval: 1,
+    refreshInterval: 2,
     threshold: 0
   },
 
   minValues: {
-    refreshInterval: 1,
+    refreshInterval: 2,
     threshold: 0
   },
 

package/package.json

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