homebridge-flume 1.2.7 → 1.2.8-beta.0

package/.eslintrc.cjs

@@ -0,0 +1,23 @@
+module.exports = {
+  env: {
+    es2022: true,
+    node: true,
+  },
+  extends: ['airbnb'],
+  parserOptions: {
+    ecmaVersion: 'latest',
+    sourceType: 'module',
+  },
+  plugins: ['import', 'sort-exports'],
+  rules: {
+    camelcase: 'off',
+    'import/extensions': ['error',  { js: 'always', json: 'always' }],
+    'import/order': ['warn', { alphabetize: { order: 'asc' } }],
+    'max-len': 'off',
+    'new-cap': 0,
+    quotes: ['error', 'single'],
+    'no-multiple-empty-lines': ['error', { max: 1, maxBOF: 1, maxEOF: 0 }],
+    'no-param-reassign': 0,
+    'sort-exports/sort-exports': ['warn', { sortDir: 'asc' }],
+  },
+};

package/CHANGELOG.md

@@ -2,6 +2,17 @@
 
 All notable changes to homebridge-flume will be documented in this file.
 
+## BETA
+
+### Potentially Breaking Changes
+
+⚠️ The minimum required version of Homebridge is now v1.4.0
+⚠️ The minimum required version of Node is now v14
+
+### Changed
+
+- Changed to ESM package
+
 ## 1.2.7 (2022-04-03)
 
 ### Changed

package/README.md

@@ -24,8 +24,8 @@ Homebridge plugin to integrate Flume devices into HomeKit
 
 ### Prerequisites
 
-- To use this plugin, you will need to already have [Homebridge](https://homebridge.io) (at least v1.3) or [HOOBS](https://hoobs.org) (at least v4.1) installed. Refer to the links for more information and installation instructions.
-- Whilst it is recommended to use [Node](https://nodejs.org/en/) v16, the plugin supports v12 and v14 as per the [Homebridge guidelines](https://github.com/homebridge/homebridge/wiki/How-To-Update-Node.js).
+- To use this plugin, you will need to already have [Homebridge](https://homebridge.io) (at least v1.4) or [HOOBS](https://hoobs.org) (at least v4.2) installed. Refer to the links for more information and installation instructions.
+- Whilst it is recommended to use [Node](https://nodejs.org/en/) v16, the plugin supports v14 as per the [Homebridge guidelines](https://github.com/homebridge/homebridge/wiki/How-To-Update-Node.js).
 
 ### Setup
 

package/lib/connection/http.js

@@ -1,25 +1,21 @@
-/* jshint node: true, esversion: 10, -W014, -W033 */
-/* eslint-disable new-cap */
-'use strict'
-
-const axios = require('axios')
-const jwtDecode = require('jwt-decode')
-
-module.exports = class connectionHTTP {
-  constructor (platform) {
+import axios from 'axios';
+import jwtDecode from 'jwt-decode';
+import platformConsts from '../utils/constants.js';
+import platformFuncs from '../utils/functions.js';
+import platformLang from '../utils/lang-en.js';
+
+export default class {
+  constructor(platform) {
     // Create variables usable by the class
-    this.consts = platform.consts
-    this.debug = platform.config.debug
-    this.funcs = platform.funcs
-    this.lang = platform.lang
-    this.log = platform.log
-    this.username = platform.config.username
-    this.password = platform.config.password
-    this.clientId = platform.config.clientId
-    this.clientSecret = platform.config.clientSecret
+    this.debug = platform.config.debug;
+    this.log = platform.log;
+    this.username = platform.config.username;
+    this.password = platform.config.password;
+    this.clientId = platform.config.clientId;
+    this.clientSecret = platform.config.clientSecret;
   }
 
-  async obtainToken () {
+  async obtainToken() {
     try {
       // Generate the JSON data to send
       const body = {
@@ -27,18 +23,18 @@ module.exports = class connectionHTTP {
         client_id: this.clientId,
         client_secret: this.clientSecret,
         username: this.username,
-        password: this.password
-      }
-      const now = Date.now()
+        password: this.password,
+      };
+      const now = Date.now();
 
       // Perform the HTTP request
       const res = await axios.post('https://api.flumetech.com/oauth/token', body, {
-        timeout: 10000
-      })
+        timeout: 10000,
+      });
 
       // Check to see we got a response
       if (!res.data) {
-        throw new Error(this.lang.noDataReceived)
+        throw new Error(platformLang.noDataReceived);
       }
 
       /*
@@ -64,16 +60,16 @@ module.exports = class connectionHTTP {
 
       // Log the response if in debug mode
       if (this.debug) {
-        this.log('[HTTP obtainToken()] %s.', JSON.stringify(res.data))
+        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
-      this.expiresIn = now + res.data.data[0].expires_in
+      this.accessToken = res.data.data[0].access_token;
+      this.refreshToken = res.data.data[0].refresh_token;
+      this.expiresIn = now + res.data.data[0].expires_in;
 
       // Obtain the user ID
-      this.userId = jwtDecode(this.accessToken).user_id
+      this.userId = jwtDecode(this.accessToken).user_id;
 
       /*
         {
@@ -86,23 +82,23 @@ module.exports = class connectionHTTP {
           sub: ''
         }
       */
+      return true;
     } catch (err) {
-      if (err.code && this.consts.httpRetryCodes.includes(err.code)) {
+      if (err.code && platformConsts.httpRetryCodes.includes(err.code)) {
         // Retry if another attempt could be successful
-        this.log.warn('[HTTP obtainToken()] %s [%s].', this.lang.httpRetry, err.code)
-        await this.funcs.sleep(30000)
-        return await this.login()
-      } else {
-        throw new Error('[HTTP obtainToken()] ' + err.message)
+        this.log.warn('[HTTP obtainToken()] %s [%s].', platformLang.httpRetry, err.code);
+        await platformFuncs.sleep(30000);
+        return this.obtainToken();
       }
+      throw new Error(`[HTTP obtainToken()] ${err.message}`);
     }
   }
 
-  async renewToken () {
+  async renewToken() {
     try {
       // Check we have a refresh token
       if (!this.refreshToken) {
-        throw new Error(this.lang.noRefreshToken)
+        throw new Error(platformLang.noRefreshToken);
       }
 
       // Generate the JSON data to send
@@ -110,23 +106,23 @@ module.exports = class connectionHTTP {
         grant_type: 'refresh_token',
         client_id: this.clientId,
         client_secret: this.clientSecret,
-        refresh_token: this.refreshToken
-      }
-      const now = Date.now()
+        refresh_token: this.refreshToken,
+      };
+      const now = Date.now();
 
       // Perform the HTTP request
       const res = await axios.post('https://api.flumetech.com/oauth/token', body, {
-        timeout: 10000
-      })
+        timeout: 10000,
+      });
 
       // Check to see we got a response
       if (!res.data) {
-        throw new Error(this.lang.noDataReceived)
+        throw new Error(platformLang.noDataReceived);
       }
 
       // Log the response if in debug mode
       if (this.debug) {
-        this.log('[HTTP renewToken()] %s.', JSON.stringify(res.data))
+        this.log('[HTTP renewToken()] %s.', JSON.stringify(res.data));
       }
 
       /*
@@ -151,104 +147,103 @@ module.exports = class connectionHTTP {
         */
 
       // Make the token available in other functions
-      this.accessToken = res.data.data[0].access_token
-      this.refreshToken = res.data.data[0].refresh_token
-      this.expiresIn = now + res.data.data[0].expires_in
+      this.accessToken = res.data.data[0].access_token;
+      this.refreshToken = res.data.data[0].refresh_token;
+      this.expiresIn = now + res.data.data[0].expires_in;
+      return true;
     } catch (err) {
-      if (err.code && this.consts.httpRetryCodes.includes(err.code)) {
+      if (err.code && platformConsts.httpRetryCodes.includes(err.code)) {
         // Retry if another attempt could be successful
-        this.log.warn('[HTTP renewToken()] %s [%s].', this.lang.httpRetry, err.code)
-        await this.funcs.sleep(30000)
-        return await this.login()
-      } else {
-        throw new Error('[HTTP renewToken()] ' + err.message)
+        this.log.warn('[HTTP renewToken()] %s [%s].', platformLang.httpRetry, err.code);
+        await platformFuncs.sleep(30000);
+        return this.renewToken();
       }
+      throw new Error(`[HTTP renewToken()] ${err.message}`);
     }
   }
 
-  async getDevices () {
+  async getDevices() {
     try {
       // Check we have a user id
       if (!this.userId || !this.accessToken) {
-        throw new Error(this.lang.noUserId)
+        throw new Error(platformLang.noUserId);
       }
 
       // Perform the HTTP request
-      const res = await axios.get('https://api.flumetech.com/users/' + this.userId + '/devices', {
-        headers: { Authorization: 'Bearer ' + this.accessToken },
-        timeout: 10000
-      })
+      const res = await axios.get(`https://api.flumetech.com/users/${this.userId}/devices`, {
+        headers: { Authorization: `Bearer ${this.accessToken}` },
+        timeout: 10000,
+      });
 
       // Check to see we got a response
       if (!res.data) {
-        throw new Error(this.lang.noDataReceived)
+        throw new Error(platformLang.noDataReceived);
       }
 
       // Log the response if in debug mode
       if (this.debug) {
-        this.log('[HTTP getDevices()] %s.', JSON.stringify(res.data))
+        this.log('[HTTP getDevices()] %s.', JSON.stringify(res.data));
       }
 
-      return res.data.data
+      return res.data.data;
     } catch (err) {
-      if (err.code && this.consts.httpRetryCodes.includes(err.code)) {
+      if (err.code && platformConsts.httpRetryCodes.includes(err.code)) {
         // Retry if another attempt could be successful
-        this.log.warn('[HTTP getDevices()] %s [%s].', this.lang.httpRetry, err.code)
-        await this.funcs.sleep(30000)
-        return await this.login()
-      } else {
-        throw new Error('[HTTP getDevices()] ' + err.message)
+        this.log.warn('[HTTP getDevices()] %s [%s].', platformLang.httpRetry, err.code);
+        await platformFuncs.sleep(30000);
+        return this.getDevices();
       }
+      throw new Error(`[HTTP getDevices()] ${err.message}`);
     }
   }
 
-  async getDeviceInfo (deviceId) {
+  async getDeviceInfo(deviceId) {
     // Refresh the access token if it has expired already
     if (Date.now() > this.expiresIn) {
-      await this.renewToken()
+      await this.renewToken();
     }
 
     // Send the request
     const res = await axios.get(
-      'https://api.flumetech.com/users/' + this.userId + '/devices/' + deviceId,
+      `https://api.flumetech.com/users/${this.userId}/devices/${deviceId}`,
       {
         headers: {
-          Authorization: 'Bearer ' + this.accessToken
-        }
-      }
-    )
+          Authorization: `Bearer ${this.accessToken}`,
+        },
+      },
+    );
 
     // Check to see we got a response
     if (!res.data) {
-      throw new Error(this.lang.noDataReceived)
+      throw new Error(platformLang.noDataReceived);
     }
 
     // Log the response if in debug mode
     if (this.debug) {
-      this.log('[HTTP getDeviceInfo()] %s.', JSON.stringify(res.data))
+      this.log('[HTTP getDeviceInfo()] %s.', JSON.stringify(res.data));
     }
 
     // Parse the response
-    return res.data.data[0]
+    return res.data.data[0];
   }
 
-  async getWaterInfo (deviceId, fromWhen) {
+  async getWaterInfo(deviceId) {
     // Refresh the access token if it has expired already
     if (Date.now() > this.expiresIn) {
-      await this.renewToken()
+      await this.renewToken();
     }
 
     // Generate dates for the query data
-    const date = new Date()
-    const startOfToday = date.toISOString().substring(0, 10) + ' 00:00:00'
+    const date = new Date();
+    const startOfToday = `${date.toISOString().substring(0, 10)} 00:00:00`;
 
     // Set the date to the first of the current month
-    date.setDate(1)
-    const startOfCurrMonth = date.toISOString().substring(0, 10) + ' 00:00:00'
+    date.setDate(1);
+    const startOfCurrMonth = `${date.toISOString().substring(0, 10)} 00:00:00`;
 
     // Set the month to the previous month
-    date.setMonth(date.getMonth() - 1)
-    const startOfPrevMonth = date.toISOString().substring(0, 10) + ' 00:00:00'
+    date.setMonth(date.getMonth() - 1);
+    const startOfPrevMonth = `${date.toISOString().substring(0, 10)} 00:00:00`;
 
     // Generate the JSON data to send
     const body = {
@@ -258,14 +253,14 @@ module.exports = class connectionHTTP {
           bucket: 'DAY',
           since_datetime: startOfToday,
           operation: 'SUM',
-          units: 'GALLONS'
+          units: 'GALLONS',
         },
         {
           request_id: 'month',
           bucket: 'MON',
           since_datetime: startOfCurrMonth,
           operation: 'SUM',
-          units: 'GALLONS'
+          units: 'GALLONS',
         },
         {
           request_id: 'prevMonth',
@@ -273,63 +268,63 @@ module.exports = class connectionHTTP {
           since_datetime: startOfPrevMonth,
           until_datetime: startOfCurrMonth,
           operation: 'SUM',
-          units: 'GALLONS'
-        }
-      ]
-    }
+          units: 'GALLONS',
+        },
+      ],
+    };
 
     // Send the request
     const res = await axios.post(
-      'https://api.flumetech.com/users/' + this.userId + '/devices/' + deviceId + '/query',
+      `https://api.flumetech.com/users/${this.userId}/devices/${deviceId}/query`,
       body,
       {
         headers: {
-          Authorization: 'Bearer ' + this.accessToken
-        }
-      }
-    )
+          Authorization: `Bearer ${this.accessToken}`,
+        },
+      },
+    );
 
     // Check to see we got a response
     if (!res.data) {
-      throw new Error(this.lang.noDataReceived)
+      throw new Error(platformLang.noDataReceived);
     }
 
     // Log the response if in debug mode
     if (this.debug) {
-      this.log('[HTTP getWaterInfo()] %s.', JSON.stringify(res.data))
+      this.log('[HTTP getWaterInfo()] %s.', JSON.stringify(res.data));
     }
 
     // Parse the response
-    return res.data.data[0]
+    return res.data.data[0];
   }
 
-  async getLeakInfo (deviceId) {
+  async getLeakInfo(deviceId) {
     // Refresh the access token if it has expired already
     if (Date.now() > this.expiresIn) {
-      await this.renewToken()
+      await this.renewToken();
     }
 
     // Send the request
     const res = await axios.get(
-      'https://api.flumetech.com/users/' + this.userId + '/devices/' + deviceId + '/leaks/active',
+      `https://api.flumetech.com/users/${this.userId}/devices/${deviceId}/leaks/active`,
       {
         headers: {
-          Authorization: 'Bearer ' + this.accessToken
-        }
-      }
-    )
+          Authorization: `Bearer ${this.accessToken}`,
+        },
+      },
+    );
 
     // Check to see we got a response
     if (!res.data) {
-      throw new Error(this.lang.noDataReceived)
+      throw new Error(platformLang.noDataReceived);
     }
 
     // Log the response if in debug mode
     if (this.debug) {
-      this.log('[HTTP getLeakInfo()] %s.', JSON.stringify(res.data))
+      this.log('[HTTP getLeakInfo()] %s.', JSON.stringify(res.data));
     }
 
     // Parse the response
-    return res.data.data[0]
+    return res.data.data[0];
   }
 }

package/lib/device/leak-sensor.js

@@ -1,105 +1,100 @@
-/* jshint node: true, esversion: 10, -W014, -W033 */
-/* eslint-disable new-cap */
-'use strict'
+import platformFuncs from '../utils/functions.js';
 
-module.exports = class deviceLeakSensor {
-  constructor (platform, accessory) {
+export default class {
+  constructor(platform, accessory) {
     // Set up variables from the platform
-    this.accessory = accessory
-    this.cusChar = platform.cusChar
-    this.funcs = platform.funcs
-    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.config.disableDeviceLogging ? () => {} : platform.log
-    this.name = accessory.displayName
-    this.platform = platform
-    this.refreshInterval = platform.config.refreshInterval
+    this.accessory = accessory;
+    this.cusChar = platform.cusChar;
+    this.hapChar = platform.api.hap.Characteristic;
+    this.hapErr = platform.api.hap.HapStatusError;
+    this.hapServ = platform.api.hap.Service;
+    this.log = platform.config.disableDeviceLogging ? () => {} : platform.log;
+    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.leakService = this.accessory.getService(this.hapServ.LeakSensor)
+      || 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
+    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;
 
     // Add the custom characteristics if they haven't been already
     if (!this.leakService.testCharacteristic(this.cusChar.TodayUsage)) {
-      this.leakService.addCharacteristic(this.cusChar.TodayUsage)
+      this.leakService.addCharacteristic(this.cusChar.TodayUsage);
     }
     if (!this.leakService.testCharacteristic(this.cusChar.MonthUsage)) {
-      this.leakService.addCharacteristic(this.cusChar.MonthUsage)
+      this.leakService.addCharacteristic(this.cusChar.MonthUsage);
     }
     if (!this.leakService.testCharacteristic(this.cusChar.PrevMonthUsage)) {
-      this.leakService.addCharacteristic(this.cusChar.PrevMonthUsage)
+      this.leakService.addCharacteristic(this.cusChar.PrevMonthUsage);
     }
   }
 
-  externalUpdate (params) {
+  externalUpdate(params) {
     // Check the data for leak detection
     if (
-      this.funcs.hasProperty(params.leakInfo, 'active') &&
-      params.leakInfo.active !== this.cacheLeak
+      platformFuncs.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.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 ');
     }
 
     // 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
+      platformFuncs.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')
+      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
+      platformFuncs.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 ')
+      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 ');
     }
 
     // Water info
     if (params.waterInfo) {
       if (
-        params.waterInfo.today &&
-        params.waterInfo.today[0] &&
-        this.funcs.hasProperty(params.waterInfo.today[0], 'value')
+        params.waterInfo.today
+        && params.waterInfo.today[0]
+        && platformFuncs.hasProperty(params.waterInfo.today[0], 'value')
       ) {
         this.leakService.updateCharacteristic(
           this.cusChar.TodayUsage,
-          params.waterInfo.today[0].value
-        )
+          params.waterInfo.today[0].value,
+        );
       }
       if (
-        params.waterInfo.month &&
-        params.waterInfo.month[0] &&
-        this.funcs.hasProperty(params.waterInfo.month[0], 'value')
+        params.waterInfo.month
+        && params.waterInfo.month[0]
+        && platformFuncs.hasProperty(params.waterInfo.month[0], 'value')
       ) {
         this.leakService.updateCharacteristic(
           this.cusChar.MonthUsage,
-          params.waterInfo.month[0].value
-        )
+          params.waterInfo.month[0].value,
+        );
       }
       if (
-        params.waterInfo.prevMonth &&
-        params.waterInfo.prevMonth[0] &&
-        this.funcs.hasProperty(params.waterInfo.prevMonth[0], 'value')
+        params.waterInfo.prevMonth
+        && params.waterInfo.prevMonth[0]
+        && platformFuncs.hasProperty(params.waterInfo.prevMonth[0], 'value')
       ) {
         this.leakService.updateCharacteristic(
           this.cusChar.PrevMonthUsage,
-          params.waterInfo.prevMonth[0].value
-        )
+          params.waterInfo.prevMonth[0].value,
+        );
       }
     }
   }

package/lib/homebridge-ui/server.js

@@ -1,14 +1,10 @@
-/* jshint node: true, esversion: 10, -W014, -W033 */
-/* eslint-disable new-cap */
-'use strict'
-
-const { HomebridgePluginUiServer } = require('@homebridge/plugin-ui-utils')
+import { HomebridgePluginUiServer } from '@homebridge/plugin-ui-utils';
 
 class PluginUiServer extends HomebridgePluginUiServer {
-  constructor () {
-    super()
-    this.ready()
+  constructor() {
+    super();
+    this.ready();
   }
 }
 
-;(() => new PluginUiServer())()
+(() => new PluginUiServer())();