homebridge-flume 0.2.0 → 0.3.0

package/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 All notable changes to homebridge-flume will be documented in this file.
 
+## 0.3.0 (2021-11-22)
+
+Changed some configuration options
+
 ## 0.2.0 (2021-11-22)
 
 Converted from accessory plugin to platform plugin

package/README.md

@@ -11,8 +11,8 @@ Configuration sample:
   "password": "password",
   "client_id": "12345678901234567890",
   "client_secret": "1234567890",
-  "polling_minutes": 1,
-  "handicap": 0.1,
+  "refreshInterval": 1,
+  "threshold": 0.1,
   "platform": "Flume"
 }
 ```
@@ -23,8 +23,8 @@ Fields:
 - "password": Your password for accessing the Flume site (required)
 - "client_id": Your Client ID for API access, found in Settings on the Flume site (required)
 - "client_secret": Your Client Secret for API access, found in Settings on the Flume site (required)
-- "polling_minutes": Number of minutes between updates. Defaults to 1 minute. API has a cap of 120 calls per hour. (optional)
-- "handicap": Set to ignore a steady water draw below this value. Defaults to zero (0.0) gallons. (optional)
+- "refreshInterval": Number of minutes between updates. Defaults to 1 minute. API has a cap of 120 calls per hour. (optional)
+- "threshold": Set to ignore a steady water draw below this value. Defaults to zero (0.0) gallons. (optional)
 
 # Retrieving API Login Credentials
 

package/config.schema.json

@@ -39,18 +39,53 @@
         "required": true,
         "description": "Your Client Secret for API access, found in Settings on the Flume site"
       },
-      "polling_minutes": {
-        "title": "Update Interval",
+      "refreshInterval": {
+        "title": "Refresh interval",
         "type": "integer",
         "placeholder": 1,
         "description": "Number of minutes between updates. API has a cap of 120 calls per hour."
       },
-      "handicap": {
+      "threshold": {
         "title": "Adjustment for False Positives",
         "type": "number",
         "placeholder": 0,
         "description": "Set to ignore a steady water draw below this value (gallons)."
-      }
+      },
+      "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",
+          "description": "Global logging setting for the plugin. If true then debug information will be added to the log."
+        },
+        "disablePlugin": {
+          "title": "Disable Plugin",
+          "type": "boolean",
+          "description": "If true, the plugin will remove all accessories and not load the plugin on restart."
+        }
+    }
+  },
+  "layout": [
+    {
+      "type": "fieldset",
+      "title": "Required Settings",
+      "items": ["username", "password", "client_id", "client_secret"]
+    },
+    {
+      "type": "fieldset",
+      "title": "Optional Settings",
+      "description": "Optional settings for the plugin, including global logging settings.",
+      "expandable": true,
+      "items": [
+        "refreshInterval",
+        "threshold",
+        "disableDeviceLogging",
+        "debug",
+        "disablePlugin"
+      ]
     }
-  }
+  ]
 }

package/lib/device/valve.js

@@ -8,7 +8,7 @@ module.exports = class deviceValve {
     this.accessory = accessory
     this.disableDeviceLogging = platform.config.disableDeviceLogging
     this.funcs = platform.funcs
-    this.handicap = platform.config.handicap
+    this.threshold = platform.config.threshold
     this.hapChar = platform.api.hap.Characteristic
     this.hapErr = platform.api.hap.HapStatusError
     this.hapServ = platform.api.hap.Service
@@ -16,7 +16,7 @@ module.exports = class deviceValve {
     this.log = platform.log
     this.name = accessory.displayName
     this.platform = platform
-    this.polling_minutes = platform.config.polling_minutes
+    this.refreshInterval = platform.config.refreshInterval
   }
 
   externalUpdate (params) {
@@ -25,13 +25,13 @@ module.exports = class deviceValve {
       params.currentusage && params.currentusage[0] && params.currentusage[0].value
         ? params.currentusage[0].value
         : 0
-    if (usage > this.handicap) {
+    if (usage > this.threshold) {
       this.log(
         '[%s] %s - [%s] gallons within the last [%s] minutes.',
         this.name,
         'usage detected',
         usage,
-        this.polling_minutes
+        this.refreshInterval
       )
     }
   }

package/lib/index.js

@@ -106,7 +106,7 @@ class FlumePlatform {
           }
           this.config[key] = val === 'false' ? false : !!val
           break
-        case 'handicap': {
+        case 'threshold': {
           if (typeof v === 'string') {
             logQuotes(key)
           }
@@ -122,7 +122,7 @@ class FlumePlatform {
         case 'platform':
         case 'plugin_map':
           break
-        case 'polling_minutes': {
+        case 'refreshInterval': {
           if (typeof val === 'string') {
             logQuotes(key)
           }
@@ -185,13 +185,13 @@ class FlumePlatform {
       })
 
       // Set up an initial last sync time
-      this.lastSync = new Date(Date.now() - this.config.polling_minutes * 60000)
+      this.lastSync = new Date(Date.now() - this.config.refreshInterval * 60000)
 
       // Perform a first sync and setup the refresh interval
       this.flumeSync()
       this.refreshInterval = setInterval(
         () => this.flumeSync(),
-        this.config.polling_minutes * 60000
+        this.config.refreshInterval * 60000
       )
 
       // Log that the plugin setup has been successful with a welcome message

package/lib/utils/constants.js

@@ -9,8 +9,8 @@ module.exports = {
     password: '',
     client_id: '',
     client_secret: '',
-    polling_minutes: 1,
-    handicap: 0,
+    refreshInterval: 1,
+    threshold: 0,
     disableDeviceLogging: false,
     debug: false,
     disablePlugin: false,
@@ -18,13 +18,13 @@ module.exports = {
   },
 
   defaultValues: {
-    polling_minutes: 1,
-    handicap: 0
+    refreshInterval: 1,
+    threshold: 0
   },
 
   minValues: {
-    polling_minutes: 1,
-    handicap: 0
+    refreshInterval: 1,
+    threshold: 0
   },
 
   httpRetryCodes: ['ENOTFOUND', 'ETIMEDOUT', 'EAI_AGAIN', 'ECONNABORTED']

package/package.json

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