nodejs-poolcontroller 7.2.0 → 7.5.1

package/.github/ISSUE_TEMPLATE/bug_report.md

@@ -33,7 +33,7 @@ Follow the instructions to complete a [packet capture](https://github.com/tagyou
  - Pump(s) manufacturer and model: [e.g. IntelliFlow 2 VST 011056]
  - Chlorinator: [e.g. iChlor, IntelliChlor-40]
  - Heater(s): [e.g. gas, solar, heatpump, ultratemp]
- - Chemical controller: [e.g. IntelliChem, homegrown]
+ - Chemical controller: [e.g. IntelliChem, Relay Equipment Manager (REM)]
  - Valves: [e.g. Intellivalve]
  - Any other relevant equipment:
 

package/Changelog

@@ -1,5 +1,18 @@
 # Changelog
 
+## 7.5
+1. Backup/restore
+2. Intellitouch add expansion modules
+## 7.4
+1. Filter object, emit, monitoring
+
+## 7.3.1
+1. Influx 2.0 support
+
+## 7.3
+1. Dynamic chlorinating % based on ORP demand for Nixie
+2. Docker creation updates
+
 ## 7.2
 1. Refactor Intellichem and Chem Controllers
 

package/Dockerfile

@@ -8,6 +8,7 @@ RUN npm run build
 RUN npm ci --production
 
 FROM node:lts-alpine as prod
+RUN apk add git
 RUN mkdir /app && chown node:node /app
 WORKDIR /app
 COPY --chown=node:node --from=build /app .

package/README.md

@@ -1,4 +1,4 @@
-# nodejs-poolController - Version 7.2.0
+# nodejs-poolController - Version 7.5
 
 ## What is nodejs-poolController
 
@@ -15,13 +15,13 @@ Equipment supported
 1. Pumps: Intelliflow VS/VSF/VF, older models
 1. Chlorinators: Intellichlor, Aqua-Rite and OEM brands
 1. Heaters: Gas, solar, heatpump
-1. Intellichem and homegrown chemical controllers
+1. Intellichem and Relay Equipment Manager (REM) chemical controllers
 1. Intellivalve (coming soon)
 1. Home Automation:  SmartThings, Hubitat, ISY, Vera, Siri, Echo
 1. Chemical probes (pH, ORP, flow sensors, EC, etc.)
 
 ## Latest Changes
-See (Changelog)[https://github.com/tagyoureit/nodejs-poolController/blob/master/Changelog)
+See [Changelog](https://github.com/tagyoureit/nodejs-poolController/blob/master/Changelog)
 
 ## What's new in 7.0?
 
@@ -84,8 +84,8 @@ To do anything with this app, you need a client to connect to it.  A client can
 * Temperature sensors (10k, NTC)
 
 ## Web Clients
-1. RECOMMENDED - [nodejs-poolController-dashPanel](https://github.com/rstrouse/nodejs-poolController-dashPanel).  Full compatibility with IntelliCenter, *Touch, REM (RelayEquipmentManager).
-1. Limited functionality - [nodejs-poolController-webClient](http://github.com/tagyoureit/nodejs-poolController-webClient).  Built primarily around EasyTouch/IntelliTouch but will work with other systems.
+1. [nodejs-poolController-dashPanel](https://github.com/rstrouse/nodejs-poolController-dashPanel).  Full compatibility with IntelliCenter, *Touch, REM (RelayEquipmentManager).
+1. Deprecated - ~~[nodejs-poolController-webClient](http://github.com/tagyoureit/nodejs-poolController-webClient).  Built primarily around EasyTouch/IntelliTouch but will work with other systems.~~
 
 * This app has the default to only listen to clients from localhost (127.0.0.1).  If you need to have clients connect from other machines you will need to change the [ip](#module_nodejs-poolController--config.json) in `config.json`.
 

package/app.ts

@@ -35,6 +35,7 @@ export async function initAsync() {
         await state.init();
         await webApp.init();
         await sys.start();
+        await webApp.initAutoBackup();
     } catch (err) { console.log(`Error Initializing nodejs-PoolController ${err.message}`);  }
     //return Promise.resolve()
     //    .then(function () { config.init(); })
@@ -70,6 +71,7 @@ export async function stopAsync(): Promise<void> {
     try {
         console.log('Shutting down open processes');
         // await sys.board.virtualPumpControllers.stopAsync();
+        await webApp.stopAutoBackup();
         await sys.stopAsync();
         await state.stopAsync();
         await conn.stopAsync();
@@ -98,4 +100,13 @@ else {
         try { return await stopAsync(); } catch (err) { console.log(`Error shutting down processes ${err.message}`); }
     });
 }
+if (typeof process === 'object') {
+    process.on('unhandledRejection', (error: Error, promise) => {
+        console.group('unhandled rejection');
+        console.error("== Node detected an unhandled rejection! ==");
+        console.error(error.message);
+        console.error(error.stack);
+        console.groupEnd();
+    });
+}
 ( async () => { await initAsync() })();

package/config/Config.ts

@@ -100,6 +100,8 @@ class Config {
         c[section] = val;
         this.update();
     }
+    // RKS: 09-21-21 - We are counting on the return from this being immutable.  A copy of the data
+    // should always be returned here.
     public getSection(section?: string, opts?: any): any {
         if (typeof section === 'undefined') return this._cfg;
         let c: any = this._cfg;
@@ -118,6 +120,7 @@ class Config {
         let baseDir = process.cwd();
         this.ensurePath(baseDir + '/logs/');
         this.ensurePath(baseDir + '/data/');
+        this.ensurePath(baseDir + '/backups/');
         // this.ensurePath(baseDir + '/replay/');
         //setTimeout(() => { config.update(); }, 100);
     }

package/config/VersionCheck.ts

@@ -41,7 +41,7 @@ class VersionCheck {
     public checkGitLocal() {
         // check local git version
         try {
-            let res = execSync('git rev-parse --abbrev-ref HEAD');
+            let res = execSync('git rev-parse --abbrev-ref HEAD', { stdio: 'pipe' });
             let out = res.toString().trim();
             logger.info(`The current git branch output is ${out}`);
             switch (out) {
@@ -54,10 +54,11 @@ class VersionCheck {
             }
         }
         catch (err) {
-            logger.error(`Unable to retrieve local git branch.  ${err}`);
+            state.appVersion.gitLocalBranch = '--';
+            logger.warn(`Unable to retrieve local git branch.  ${err}`);
         }
         try {
-            let res = execSync('git rev-parse HEAD');
+            let res = execSync('git rev-parse HEAD', { stdio: 'pipe' });
             let out = res.toString().trim();
             logger.info(`The current git commit output is ${out}`);
             switch (out) {
@@ -69,7 +70,10 @@ class VersionCheck {
                     state.appVersion.gitLocalCommit = out;
             }
         }
-        catch (err) { logger.error(`Unable to retrieve local git commit.  ${err}`); }
+        catch (err) { 
+            state.appVersion.gitLocalCommit = '--';
+            logger.warn(`Unable to retrieve local git commit.  ${err}`); 
+        }
     }
     private checkAll() {
         try {

package/controller/Constants.ts

@@ -179,8 +179,9 @@ export class Heliotrope {
 export class Timestamp {
     private _dt: Date;
     public emitter: EventEmitter;
-    constructor(dt?: Date) {
-        this._dt = dt || new Date();
+    constructor(dt?: Date | string) {
+        if (typeof dt === 'string') this._dt = new Date(dt);
+        else this._dt = dt || new Date();
         this.emitter = new EventEmitter();
     }
     private _isUpdating: boolean = false;
@@ -265,7 +266,7 @@ export class Timestamp {
         let dateJan = new Date(this._dt.getFullYear(), 0, 1, 2);
         let dateJul = new Date(this._dt.getFullYear(), 6, 1, 2);
         obj.tzOffset = dateJan.getTimezoneOffset() / 60 * -1;
-        obj.adjustDST = dateJan.getTimezoneOffset() - dateJul.getTimezoneOffset() > 0; 
+        obj.adjustDST = dateJan.getTimezoneOffset() - dateJul.getTimezoneOffset() > 0;
         return obj;
     }
     public addHours(hours: number, minutes: number = 0, seconds: number = 0, milliseconds: number = 0) {
@@ -302,10 +303,10 @@ export enum ControllerType {
     Virtual = 'virtual',
     Nixie = 'nixie'
 }
-export enum VirtualDeviceType {
-    Pump = 'pump',
-    Chlorinator = 'chlorinator'
-}
+// export enum VirtualDeviceType {
+//     Pump = 'pump',
+//     Chlorinator = 'chlorinator'
+// }
 //export class Enums {
 //    public static Addresses = {
 //        2: { val: 2, name: 'chlorinator', desc: 'Chlorinator' },
@@ -367,6 +368,94 @@ export class Utils {
                 if (typeof fn !== 'undefined' && typeof fn[to.toLowerCase()] === 'function') return fn[to.toLowerCase()](val);
             }
         },
+        pressure: {
+            bar: {
+                kpa: (val) => { return val * 100; },
+                kilopascal: (val) => { return val * 100; },
+                pa: (val) => { return val * 100000; },
+                pascal: (val) => { return val * 100000; },
+                atm: (val) => { return val * 0.986923; },
+                atmosphere: (val) => { return val * 0.986923; },
+                psi: (val) => { return val * 14.5038; },
+                bar: (val) => { return val; }
+            },
+            kpa: {
+                kpa: (val) => { return val; },
+                kilopascal: (val) => { return val; },
+                pa: (val) => { return val * 1000; },
+                pascal: (val) => { return val * 1000; },
+                atm: (val) => { return val / 101.325; },
+                atmosphere: (val) => { return val / 101.325; },
+                psi: (val) => { return val * 0.145038; },
+                bar: (val) => { return val * .01; }
+            },
+            kilopascal: {
+                kpa: (val) => { return val; },
+                kilopascal: (val) => { return val; },
+                pa: (val) => { return val * 1000; },
+                pascal: (val) => { return val * 1000; },
+                atm: (val) => { return val / 101.325; },
+                atmosphere: (val) => { return val / 101.325; },
+                psi: (val) => { return val * 0.145038; },
+                bar: (val) => { return val * .01; }
+            },
+            pa: {
+                kpa: (val) => { return val / 1000; },
+                kilopascal: (val) => { return val / 1000; },
+                pa: (val) => { return val; },
+                pascal: (val) => { return val; },
+                atm: (val) => { return val / 101325; },
+                atmosphere: (val) => { return val / 101325; },
+                psi: (val) => { return val * 0.000145038; },
+                bar: (val) => { return val / 100000; }
+            },
+            pascal: {
+                kpa: (val) => { return val / 1000; },
+                kilopascal: (val) => { return val / 1000; },
+                pa: (val) => { return val; },
+                pascal: (val) => { return val; },
+                atm: (val) => { return val / 101325; },
+                atmosphere: (val) => { return val / 101325; },
+                psi: (val) => { return val * 0.000145038; },
+                bar: (val) => { return val / 100000; }
+            },
+            atm: {
+                kpa: (val) => { return val * 101.325; },
+                kilopascal: (val) => { return val * 101.325; },
+                pa: (val) => { return val * 101325; },
+                pascal: (val) => { return val * 101325; },
+                atm: (val) => { return val; },
+                atmosphere: (val) => { return val; },
+                psi: (val) => { return val * 14.6959; },
+                bar: (val) => { return val * 1.01325; }
+            },
+            atmosphere: {
+                kpa: (val) => { return val * 101.325; },
+                kilopascal: (val) => { return val * 101.325; },
+                pa: (val) => { return val * 101325; },
+                pascal: (val) => { return val * 101325; },
+                atm: (val) => { return val; },
+                atmosphere: (val) => { return val; },
+                psi: (val) => { return val * 14.6959; },
+                bar: (val) => { return val * 1.01325; }
+            },
+            psi: {
+                kpa: (val) => { return val * 6.89476; },
+                kilopascal: (val) => { return val * 6.89476; },
+                pa: (val) => { return val * 6894.76; },
+                pascal: (val) => { return val * 6894.76; },
+                atm: (val) => { return val * 0.068046; },
+                atmosphere: (val) => { return 0.068046; },
+                psi: (val) => { return val; },
+                bar: (val) => { return val * 0.0689476; }
+            },
+            convertUnits: (val: number, from: string, to: string) => {
+                if (typeof val !== 'number') return null;
+                let fn = this.convert.pressure[from.toLowerCase()];
+                if (typeof fn !== 'undefined' && typeof fn[to.toLowerCase()] === 'function') return fn[to.toLowerCase()](val);
+            }
+
+        },
         volume: {
             gal: {
                 l: (val) => { return val * 3.78541; },
@@ -444,7 +533,7 @@ export class Utils {
         var fmt = '';
         let hrs = Math.floor(seconds / 3600);
         let min = Math.floor((seconds - (hrs * 3600)) / 60);
-        let sec = seconds - ((hrs * 3600) + (min * 60));
+        let sec = Math.round(seconds) - ((hrs * 3600) + (min * 60));
         if (hrs > 1) fmt += (hrs.toString() + 'hrs');
         else if (hrs > 0) fmt += (hrs.toString() + 'hr');
 
@@ -479,7 +568,7 @@ export class Utils {
         }
         return seconds;
     }
-    public isNullOrEmpty(val: any) {  return (typeof val === 'string') ? val === null || val === '' : typeof val === 'undefined' || val === null; }
+    public isNullOrEmpty(val: any) { return (typeof val === 'string') ? val === null || val === '' : typeof val === 'undefined' || val === null; }
     public sleep = (ms: number) => new Promise(resolve => setTimeout(resolve, ms));
     // Use this method to get around the circular references for the toJSON function.
     public serialize(obj, fn?: (key, value) => any): string {
@@ -514,6 +603,73 @@ export class Utils {
         }
         return o;
     }
+    public findLineByLeastSquares(values_x: number[], values_y: number[]): number[][] {
+        var x_sum = 0;
+        var y_sum = 0;
+        var xy_sum = 0;
+        var xx_sum = 0;
+        var count = 0;
+
+        /*
+         * The above is just for quick access, makes the program faster
+         */
+        var x = 0;
+        var y = 0;
+        var values_length = values_x.length;
+
+        if (values_length != values_y.length) {
+            throw new Error('The parameters values_x and values_y need to have same size!');
+        }
+
+        /*
+         * Above and below cover edge cases
+         */
+        if (values_length === 0) {
+            return [[], []];
+        }
+
+        /*
+         * Calculate the sum for each of the parts necessary.
+         */
+        for (let i = 0; i < values_length; i++) {
+            x = values_x[i];
+            y = values_y[i];
+            x_sum += x;
+            y_sum += y;
+            xx_sum += x * x;
+            xy_sum += x * y;
+            count++;
+        }
+
+        /*
+         * Calculate m and b for the line equation:
+         * y = x * m + b
+         */
+        var m = (count * xy_sum - x_sum * y_sum) / (count * xx_sum - x_sum * x_sum);
+        var b = (y_sum / count) - (m * x_sum) / count;
+
+        /*
+         * We then return the x and y data points according to our fit
+         */
+        var result_values_x: number[] = [];
+        var result_values_y: number[] = [];
+
+        for (let i = 0; i < values_length; i++) {
+            x = values_x[i];
+            y = x * m + b;
+            result_values_x.push(x);
+            result_values_y.push(y);
+        }
+
+        return [result_values_x, result_values_y];
+    }
+    public slopeOfLeastSquares(values_x: number[], values_y: number[]): number {
+        let points = utils.findLineByLeastSquares(values_x, values_y);
+        let points_x = points[0];
+        let points_y = points[1];
+        let slope = (points_y[0] - points_y[points_y.length - 1]) / (points_x[0] - points_x[points_x.length - 1]);
+        return slope;
+    }
 }
 
 export const utils = new Utils();