homebridge-flume 0.1.0

package/.gitattributes

@@ -0,0 +1,2 @@
+# Auto detect text files and perform LF normalization
+* text=auto

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Darrin Thomas & Ben Potter
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,36 @@
+# homebridge-flume
+
+# Configuration
+
+Configuration sample:
+
+```
+"accessories": [
+  {
+    "accessory": "Flume",
+    "name": "Flume Water Monitor",
+    "username": "user@domain.com",
+    "password": "password",
+    "client_id": "12345678901234567890",
+    "client_secret": "1234567890",
+    "polling_minutes": 1,
+    "handicap": 0.1,
+    "valveType": 3
+  }
+]
+```
+
+Fields:
+
+- "accessory": Must always be "Flume" (required)
+- "username": Your username for accessing the Flume site at https://portal.flumetech.com/ (required)
+- "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)
+
+# Retrieving API Login Credentials
+
+You'll need to get your API Access Client ID and Client Secret from Flume's site at https://portal.flumetech.com/
+This guide offers the steps to take: https://flumetech.readme.io/reference#accessing-the-api

package/config.schema.json

@@ -0,0 +1,58 @@
+{
+  "pluginAlias": "Flume",
+  "pluginType": "accessory",
+  "singular": true,
+  "headerDisplay": "[Flume Water Monitor](https://flumetech.com) plugin for Homebridge.",
+  "schema": {
+    "type": "object",
+    "properties": {
+      "name": {
+        "title": "Accessory Name",
+        "type": "string",
+        "required": true,
+        "default": "Flume Water Monitor",
+        "description": "The name used for the Flume water monitor in HomeKit"
+      },
+      "username": {
+        "title": "Username",
+        "type": "string",
+        "required": true,
+        "description": "Your username for acessing the Flume site at https://portal.flumetech.com/ (required)"
+      },
+      "password": {
+        "title": "Password",
+        "type": "string",
+        "required": true,
+        "description": "Your password for acessing the Flume site (required)"
+      },
+      "client_id": {
+        "title": "Client ID",
+        "type": "string",
+        "placeholder": "12345678901234567890",
+        "required": true,
+        "description": "Your Client ID for API access, found in Settings on the Flume site (required)"
+      },
+      "client_secret": {
+        "title": "Client Secret",
+        "type": "string",
+        "placeholder": "1234567890",
+        "required": true,
+        "description": "Your Client Secret for API access, found in Settings on the Flume site (required)"
+      },
+      "polling_minutes": {
+        "title": "Update Interval",
+        "type": "integer",
+        "default": "1",
+        "required": false,
+        "description": "Number of minutes between updates. Defaults to 1 minute. API has a cap of 120 calls per hour. (optional)"
+      },
+      "handicap": {
+        "title": "Adjustment for False Positives",
+        "type": "float",
+        "default": "0.0",
+        "required": false,
+        "description": "Set to ignore a steady water draw below this value. Defaults to zero (0.0) gallons. (optional)"
+      }
+    }
+  }
+}

package/lib/index.js

@@ -0,0 +1,219 @@
+const fetch = require('node-fetch');
+const packageJson = require('./package.json');
+var jwtDecode = require('jwt-decode');
+var Service, Characteristic;
+
+module.exports = function (homebridge) {
+  Service = homebridge.hap.Service;
+  Characteristic = homebridge.hap.Characteristic;
+  homebridge.registerAccessory('homebridge-flume', 'Flume', Flume);
+}
+
+function Flume (log, config, api) {
+    this.log = log;
+    this.config = config;
+
+    log("Starting homebridge-flume.");
+
+    // extract name from config
+    this.name = config.name;
+
+  // pull in initial variables
+    this.username = config["username"];
+    this.password = config["password"];
+    this.client_id = config["client_id"];
+    this.client_secret = config["client_secret"];
+    if (config["handicap"] != null) {
+      this.handicap = config["handicap"];
+    } else {
+      this.handicap = 0;
+    }
+    if (config["polling_minutes"] != null) {
+      this.interval = parseInt(config["polling_minutes"]) * 60 * 1000;
+    } else {
+       this.interval = 1 * 60 * 1000;
+    }
+    this.debug = config["debug"] || true;
+
+    if (!this.username) throw new Error("You must provide a value for username.");
+    if (!this.password) throw new Error("You must provide a value for password.");
+    if (!this.client_id) throw new Error("You must provide a value for client_id.");
+    if (!this.client_secret) throw new Error("You must provide a value for client_secret.");
+
+    this.expires_in = Date.now();
+    this.device_id = "";
+    this.device_usage = 0.00;
+
+    log("User variables loaded.");
+
+    if (api) {
+      this.api = api;
+      this.api.on('didFinishLaunching', this.fetchDevices.bind(this));
+      this.timer = setInterval(this.fetchDevices.bind(this), this.interval);
+
+        log("Update interval set.");
+    }
+
+    log("Initial load of the accessory started.");
+
+    // get the Valve service if it exists, otherwise create a new Valve service
+    this.informationService = this.accessory.getService(Service.Valve) ||
+    this.accessory.addService(Service.Valve);
+
+   this.informationService
+         .setCharacteristic(Characteristic.Manufacturer, "Flume Water Monitor")
+        .setCharacteristic(Characteristic.Model, "001")
+        .setCharacteristic(Characteristic.SerialNumber, this.device_id)
+        .setCharacteristic(Characteristic.Name, accessory.context.device.name)
+        .setCharacteristic(Characteristic.Active, false)
+        .setCharacteristic(Characteristic.InUse, false)
+        .setCharacteristic(Characteristic.ValveType, "3")
+        .setCharacteristic(Characteristic.StatusFault, false);
+
+    log("Starting position is water is Off");
+    log("Load of the accessory complete.");
+}
+
+Flume.prototype.getAccessToken = function() {
+    var now = Date.now();
+
+    log("Getting the access token.");
+
+    if (!this.access_token) {
+    return fetch('https://api.flumetech.com/oauth/token', {
+                method: 'POST',
+                headers: {
+                    'content-type': 'application/json'
+                },
+                body: '{"grant_type":"password","client_id":' + this.client_id + ',"client_secret":' + this.client_secret + ',"username":' + this.username + ',"password":' + this.password + '}'
+            })
+            .then(res => {
+                if (res.ok) {
+                    return res.json();
+                    log("res was okay.");
+                } else {
+                    log("ERROR! Unable to retrieve new token: " + res.statusText);
+                }
+            })
+            .then(json => {
+                this.access_token = json.access_token;
+                this.refresh_token = json.refresh_token;
+                this.expires_in = now + json.expires_in;
+                this.log("Token received: " + this.access_token);
+                this.log("Refresh token received: " + this.refresh_token);
+                this.log("Token expires at: " + new Date(this.expires_in));
+                return this.access_token;
+            });
+  } else if (now > this.expires_in) {
+        return fetch('https://api.flumetech.com/oauth/token', {
+            method: 'POST',
+            headers: {
+              'content-type': 'application/json'
+            },
+            body: '{"grant_type":"refresh_token","client_id":' + this.client_id + ',"client_secret":' + this.client_secret + ',"refresh_token":' + this.refresh_token + '}'
+        })
+        .then(res => {
+          if (res.ok) {
+              return res.json();
+            } else {
+              log("ERROR! Unable to retrieve new token: " + res.statusText);
+            }
+        })
+        .then(json => {
+          this.access_token = json.access_token;
+            this.expires_in = now + json.expires_in;
+            this.log("Token received: " + this.access_token);
+            this.log("Refresh token received: " + this.refresh_token);
+            this.log("Token expires at: " + new Date(this.expires_in));
+            return this.access_token;
+        });
+    }
+
+    this.log("Getting User ID from JWT.")
+
+    var token = this.access_token;
+  var decoded = jwt_decode(token);
+  // or perhaps: decoded = jwt.decode(config["access_token"], verify=False)
+
+  this.log(decoded);
+  this.user_id = decoded.user_id;    // or perhaps: decoded["user_id"]
+  this.log("User ID: " + this.user_id);
+    this.log("Device ID: " + this.device_id);
+
+    return fetch('https://api.flumetech.com/users/' + this.user_id + '/devices', {
+      method: 'GET',
+        headers: {
+          'authorization': '' + this.access_token + ''
+            },
+        })
+        .then(res => {
+          if (res.ok) {
+              return res.json();
+            } else {
+              log("ERROR! Unable to retrieve devices: " + res.statusText);
+            }
+        })
+        .then(json => {
+          this.device_id = json.id;
+            this.log("User ID: " + this.user_id);
+            this.log("Device ID: " + this.device_id);
+            return this.device_id;
+        });
+  }
+
+
+Flume.prototype.fetchDevices = function() {
+    this.log("Fetching current devices and statuses.");
+
+    // alternative approach: var previousminute = (datetime.datetime.now() - datetime.timedelta(minutes=1)).strftime('%Y-%m-%d %H:%M:%S');
+  var currentminute = (datetime.datetime.now() - datetime.timedelta(minutes=1)).strftime('%Y-%m-%d %H:%M:%S');
+
+    this.log("Token: " + this.access_token);
+    this.log("User ID: " + this.user_id);
+    this.log("Device ID: " + this.device_id);
+
+    this.getAccessToken()
+      .then(token => fetch('https://api.flumetech.com/users/' + this.user_id + '/devices/' + this.device_id + '/query', {
+          method: 'POST',
+            headers: {
+              'content-type': 'application/json',
+                'authorization': 'Bearer ' + this.access_token
+            },
+      body: '{"queries":[{"request_id":"currentusage","bucket":"MIN","since_datetime": currentminute,"operation":"SUM","units":"GALLONS"}]}'
+      // alternative approach might be payload = '{"queries":[{"request_id":"perminute","bucket":"MIN","since_datetime":"' + previousminute() + '","until_datetime":"' + currentminute() + '","group_multiplier":"1","operation":"SUM","sort_direction":"ASC","units":"GALLONS"}]}'
+        // as seen at https://github.com/ScriptBlock/flumecli/blob/master/flumecli.py
+        })
+        .then(res => {
+          if (res.ok) {
+              return res.json();
+                this.device_usage = value;
+            } else {
+              log("ERROR! Unable to retrieve devices: " + res.statusText);
+            }
+        }));
+
+    log("Updating the status");
+        this.updateState(accessory);
+    log("Updated the status");
+    }
+
+
+Flume.prototype.updateState = function(accessory) {
+    var fresh = Date.now() - Date.parse(accessory.context.time + ".000Z") < 60 * 60 * 1000;
+
+    log("Device Usage & Handicap: ");
+    log(this.device_usage);
+    log(this.handicap);
+
+    if (this.device_usage > this.handicap) {
+      log("Water is On");
+      accessory.getService(Service.Valve)
+        .setCharacteristic(Characteristic.Active, true)
+        .setCharacteristic(Characteristic.InUse, true);
+  } else {
+       log("Water is Off");
+       accessory.getService(Service.Valve)
+        .setCharacteristic(Characteristic.Active, false)
+        .setCharacteristic(Characteristic.InUse, false);
+  }
+}

package/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "homebridge-flume",
+  "alias": "Flume",
+  "version": "0.1.0",
+  "author": {
+    "name": "Darrin Thomas",
+    "email": "bwp91@icloud.com"
+  },
+  "description": "Homebridge plugin to integrate Flume devices into HomeKit.",
+  "main": "lib/index.js",
+  "keywords": [
+    "homebridge",
+    "homebridge-plugin",
+    "homebridge-flume",
+    "hoobs",
+    "hoobs-plugin",
+    "homekit",
+    "siri",
+    "flume",
+    "water sensor",
+    "water monitor",
+    "leak detector",
+    "water leak detector"
+  ],
+  "engines": {
+    "homebridge": "^1.3.6",
+    "node": "^14.18.1 || ^16.13.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/bwp91/homebridge-flume.git"
+  },
+  "bugs": {
+    "url": "https://github.com/bwp91/homebridge-flume/issues"
+  },
+  "dependencies": {
+    "homebridge-http-base": "^2.1.12",
+    "jwt-decode": "^3.1.2",
+    "node-fetch": "^2.6.0"
+  },
+  "prettier": {
+    "printWidth": 100
+  },
+  "standard": {
+    "ignore": [
+      "/lib/index.js"
+    ]
+  }
+}