homebridge-flume 0.4.0 → 0.5.0

package/CHANGELOG.md

@@ -2,6 +2,16 @@
 
 All notable changes to homebridge-flume will be documented in this file.
 
+## 0.5.0 (2021-11-23)
+
+### Added
+
+- Make use of the debug logging option for HTTP responses
+
+### Changed
+
+- `client_id` and `client_secret` config options changed to `clientId` and `clientSecret` for consistency
+
 ## 0.4.0 (2021-11-23)
 
 ### Added

package/README.md

@@ -40,7 +40,7 @@
 
 ### Credits
 
-- This is a forked rewrite of the [homebridge-flume-water-sensor](https://www.npmjs.com/package/homebridge-flume-water-sensor) plugin by @weallknowwhoisatfaulthere
+- This is a forked rewrite of the [homebridge-flume-water-sensor](https://www.npmjs.com/package/homebridge-flume-water-sensor) plugin by @weallknowwhoisatfaulthere.
 - To the creators/contributors of [Homebridge](https://homebridge.io) who make this plugin possible.
 
 ### Disclaimer

package/config.schema.json

@@ -17,39 +17,39 @@
         "title": "Username",
         "type": "string",
         "required": true,
-        "description": "Your username for accessing the Flume site at https://portal.flumetech.com"
+        "description": "Your Flume username."
       },
       "password": {
         "title": "Password",
         "type": "string",
         "required": true,
-        "description": "Your password for accessing the Flume site"
+        "description": "Your Flume password."
       },
-      "client_id": {
+      "clientId": {
         "title": "Client ID",
         "type": "string",
-        "placeholder": "12345678901234567890",
+        "placeholder": "1234567890ABCD",
         "required": true,
-        "description": "Your Client ID for API access, found in Settings on the Flume site"
+        "description": "Your Flume Client ID, found at https://portal.flumetech.com."
       },
-      "client_secret": {
+      "clientSecret": {
         "title": "Client Secret",
         "type": "string",
-        "placeholder": "1234567890",
+        "placeholder": "1234567890ABCDEFGHIJ",
         "required": true,
-        "description": "Your Client Secret for API access, found in Settings on the Flume site"
+        "description": "Your Flume Client Secret, found at https://portal.flumetech.com."
       },
       "refreshInterval": {
-        "title": "Refresh interval",
+        "title": "Refresh Interval",
         "type": "integer",
         "placeholder": 1,
-        "description": "Number of minutes between updates. API has a cap of 120 calls per hour."
+        "description": "Number of minutes between updates. Must be 1 or more."
       },
       "threshold": {
-        "title": "Adjustment for False Positives",
+        "title": "Threshold",
         "type": "number",
         "placeholder": 0,
-        "description": "Set to ignore a steady water draw below this value (gallons)."
+        "description": "Ignore a steady water draw below this value in gallons per refresh interval. Must be 0 or more."
       },
       "disableDeviceLogging": {
         "type": "boolean",
@@ -72,7 +72,7 @@
     {
       "type": "fieldset",
       "title": "Required Settings",
-      "items": ["username", "password", "client_id", "client_secret"]
+      "items": ["username", "password", "clientId", "clientSecret"]
     },
     {
       "type": "fieldset",

package/lib/connection/http.js

@@ -15,8 +15,8 @@ module.exports = class connectionHTTP {
     this.log = platform.log
     this.username = platform.config.username
     this.password = platform.config.password
-    this.client_id = platform.config.client_id
-    this.client_secret = platform.config.client_secret
+    this.clientId = platform.config.clientId
+    this.clientSecret = platform.config.clientSecret
   }
 
   async obtainToken () {
@@ -24,8 +24,8 @@ module.exports = class connectionHTTP {
       // Generate the JSON data to send
       const body = {
         grant_type: 'password',
-        client_id: this.client_id,
-        client_secret: this.client_secret,
+        client_id: this.clientId,
+        client_secret: this.clientSecret,
         username: this.username,
         password: this.password
       }
@@ -62,6 +62,11 @@ module.exports = class connectionHTTP {
         }
       */
 
+      // Log the response if in debug mode
+      if (this.debug) {
+        this.log('[HTTP obtainToken()] %s.', JSON.stringify(res.data))
+      }
+
       // Make the token available in other functions
       this.accessToken = res.data.data[0].access_token
       this.refreshToken = res.data.data[0].refresh_token
@@ -95,11 +100,16 @@ module.exports = class connectionHTTP {
 
   async renewToken () {
     try {
+      // Check we have a refresh token
+      if (!this.refreshToken) {
+        throw new Error(this.lang.noRefreshToken)
+      }
+
       // Generate the JSON data to send
       const body = {
         grant_type: 'refresh_token',
-        client_id: this.client_id,
-        client_secret: this.client_secret,
+        client_id: this.clientId,
+        client_secret: this.clientSecret,
         refresh_token: this.refreshToken
       }
       const now = Date.now()
@@ -114,6 +124,11 @@ module.exports = class connectionHTTP {
         throw new Error(this.lang.noDataReceived)
       }
 
+      // Log the response if in debug mode
+      if (this.debug) {
+        this.log('[HTTP renewToken()] %s.', JSON.stringify(res.data))
+      }
+
       /*
           {
             success: true,
@@ -154,7 +169,7 @@ module.exports = class connectionHTTP {
   async getDevices () {
     try {
       // Check we have a user id
-      if (!this.userId) {
+      if (!this.userId || !this.accessToken) {
         throw new Error(this.lang.noUserId)
       }
 
@@ -169,6 +184,11 @@ module.exports = class connectionHTTP {
         throw new Error(this.lang.noDataReceived)
       }
 
+      // Log the response if in debug mode
+      if (this.debug) {
+        this.log('[HTTP getDevices()] %s.', JSON.stringify(res.data))
+      }
+
       return res.data.data
     } catch (err) {
       if (err.code && this.consts.httpRetryCodes.includes(err.code)) {
@@ -217,6 +237,11 @@ module.exports = class connectionHTTP {
       throw new Error(this.lang.noDataReceived)
     }
 
+    // Log the response if in debug mode
+    if (this.debug) {
+      this.log('[HTTP getDevice()] %s.', JSON.stringify(res.data))
+    }
+
     // Parse the response
     return res.data.data[0]
   }

package/lib/device/valve.js

@@ -6,14 +6,13 @@ module.exports = class deviceValve {
   constructor (platform, accessory) {
     // Set up variables from the platform
     this.accessory = accessory
-    this.disableDeviceLogging = platform.config.disableDeviceLogging
     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
     this.lang = platform.lang
-    this.log = platform.log
+    this.log = platform.config.disableDeviceLogging ? () => {} : platform.log
     this.name = accessory.displayName
     this.platform = platform
     this.refreshInterval = platform.config.refreshInterval

package/lib/index.js

@@ -88,8 +88,8 @@ class FlumePlatform {
     // Begin applying the user's config
     for (const [key, val] of Object.entries(config)) {
       switch (key) {
-        case 'client_id':
-        case 'client_secret':
+        case 'clientId':
+        case 'clientSecret':
         case 'password':
         case 'username':
           if (typeof val !== 'string' || val === '') {
@@ -161,8 +161,8 @@ class FlumePlatform {
       if (
         !this.config.username ||
         !this.config.password ||
-        !this.config.client_id ||
-        !this.config.client_secret
+        !this.config.clientId ||
+        !this.config.clientSecret
       ) {
         throw new Error(this.lang.noCreds)
       }

package/lib/utils/constants.js

@@ -7,8 +7,8 @@ module.exports = {
     name: 'Flume',
     username: '',
     password: '',
-    client_id: '',
-    client_secret: '',
+    clientId: '',
+    clientSecret: '',
     refreshInterval: 1,
     threshold: 0,
     disableDeviceLogging: false,

package/lib/utils/lang-en.js

@@ -31,6 +31,7 @@ module.exports = {
   initialising: 'Initialising plugin',
   noCreds: 'Flume username and/or password and/or client id/secret not configured',
   noDataReceived: 'No data received from request',
+  noRefreshToken: 'No refresh token has been retrieved',
   noUserId: 'No user id has been retrieved',
   pluginNotConf: 'Plugin has not been configured',
   syncFailed: 'Sync process failed as',

package/package.json

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