nodejs-poolcontroller 7.4.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,8 @@
 # Changelog
 
+## 7.5
+1. Backup/restore
+2. Intellitouch add expansion modules
 ## 7.4
 1. Filter object, emit, monitoring
 

package/README.md

@@ -1,4 +1,4 @@
-# nodejs-poolController - Version 7.4
+# nodejs-poolController - Version 7.5
 
 ## What is nodejs-poolController
 
@@ -15,7 +15,7 @@ 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.)

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();

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/Equipment.ts

@@ -31,6 +31,7 @@ import { conn } from './comms/Comms';
 import { versionCheck } from "../config/VersionCheck";
 import { NixieControlPanel } from "./nixie/Nixie";
 import { NixieBoard } from 'controller/boards/NixieBoard';
+import { child } from "winston";
 
 interface IPoolSystem {
     cfgPath: string;
@@ -68,7 +69,7 @@ interface IPoolSystem {
 }
 
 export class PoolSystem implements IPoolSystem {
-    public _hasChanged: boolean=false;
+    public _hasChanged: boolean = false;
     constructor() {
         this.cfgPath = path.posix.join(process.cwd(), '/data/poolConfig.json');
     }
@@ -99,7 +100,12 @@ export class PoolSystem implements IPoolSystem {
                 { val: 3, name: 'IT5S', part: 'i5+3S', desc: 'IntelliTouch i5+3S', bodies: 1, circuits: 6, shared: false },
                 { val: 4, name: 'IT9S', part: 'i9+3S', desc: 'IntelliTouch i9+3S', bodies: 1, circuits: 9, shared: false },
                 { val: 5, name: 'IT10D', part: 'i10D', desc: 'IntelliTouch i10D', bodies: 1, circuits: 10, shared: false, dual: true }
+            ],
+            expansionModules: [
+                { val: 32, name: 'IT5X', part: 'i5X', desc: 'IntelliTouch i5X', circuits: 5, shared: false },
+                { val: 33, name: 'IT10X', part: 'i10X', desc: 'IntelliTouch i10X', circuits: 10, shared: false }
             ]
+
         });
         arr.push({
             type: 'intellicenter', name: 'IntelliCenter',
@@ -109,7 +115,8 @@ export class PoolSystem implements IPoolSystem {
                 { val: 2, name: 'i8P', part: '521977Z', desc: 'IntelliCenter i8P', bodies: 1, valves: 2, circuits: 8, shared: false, dual: false, chlorinators: 1, chemControllers: 1 },
                 { val: 3, name: 'i8PS', part: '521968Z', desc: 'IntelliCenter i8PS', bodies: 2, valves: 4, circuits: 9, shared: true, dual: false, chlorinators: 1, chemControllers: 1 },
                 { val: 4, name: 'i10P', part: '521993Z', desc: 'IntelliCenter i10P', bodies: 1, valves: 2, circuits: 10, shared: false, dual: false, chlorinators: 1, chemControllers: 1 }, // This is a guess
-                { val: 5, name: 'i10PS', part: '521873Z', desc: 'IntelliCenter i10PS', bodies: 2, valves: 4, circuits: 11, shared: true, dual: false, chlorinators: 1, chemControllers: 1 }
+                { val: 5, name: 'i10PS', part: '521873Z', desc: 'IntelliCenter i10PS', bodies: 2, valves: 4, circuits: 11, shared: true, dual: false, chlorinators: 1, chemControllers: 1 },
+                { val: 7, name: 'i10D', part: '523029Z', desc: 'IntelliCenter i10D', bodies: 2, valves: 2, circuits: 11, shared: false, dual: true, chlorinators: 2, chemControllers: 2 },
             ]
         });
         arr.push({
@@ -155,7 +162,7 @@ export class PoolSystem implements IPoolSystem {
         EqItemCollection.removeNullIds(cfg.remotes);
         EqItemCollection.removeNullIds(cfg.chemControllers);
         EqItemCollection.removeNullIds(cfg.filters);
-        this.data = this.onchange(cfg, function() { sys.dirty = true; });
+        this.data = this.onchange(cfg, function () { sys.dirty = true; });
         this.general = new General(this.data, 'pool');
         this.equipment = new Equipment(this.data, 'equipment');
         this.configVersion = new ConfigVersion(this.data, 'configVersion');
@@ -516,7 +523,7 @@ class EqItemCollection<T> implements IEqItemCollection {
         }
     }
     public static removeNullIds(data: any) {
-        if (typeof data !== 'undefined' && Array.isArray(data) && typeof data.length === 'number')  {
+        if (typeof data !== 'undefined' && Array.isArray(data) && typeof data.length === 'number') {
             for (let i = data.length - 1; i >= 0; i--) {
                 if (typeof data[i].id !== 'number') data.splice(i, 1);
                 else if (typeof data[i].id === 'undefined' || isNaN(data[i].id)) data.splice(i, 1);
@@ -606,7 +613,7 @@ class EqItemCollection<T> implements IEqItemCollection {
     }
     public sort(fn: (a, b) => number) { this.data.sort(fn); }
     public count(fn: () => boolean): number { return this.data.filter(fn).length; }
-    public getNextEquipmentId(range: EquipmentIdRange, exclude?:number[]): number {
+    public getNextEquipmentId(range: EquipmentIdRange, exclude?: number[]): number {
         for (let i = range.start; i <= range.end; i++) {
             let eq = this.data.find(elem => elem.id === i);
             if (typeof eq === 'undefined') {
@@ -647,7 +654,7 @@ export class General extends EqItem {
         if (master === -1)
             super.clear();
     }
-   
+
 }
 // Custom Names are IntelliTouch Only
 export class CustomNameCollection extends EqItemCollection<CustomName> {
@@ -721,15 +728,14 @@ export class Options extends EqItem {
     public get clockMode(): number | any { return this.data.clockMode; }
     public set clockMode(val: number | any) { this.setDataVal('clockMode', sys.board.valueMaps.clockModes.encode(val)); }
     public get units(): number | any { return this.data.units; }
-    public set units(val: number | any) { this.setDataVal('units', sys.board.valueMaps.tempUnits.encode(val)); }
+    public set units(val: number | any) { this.setDataVal('units', sys.board.valueMaps.systemUnits.encode(val)); }
     public get clockSource(): string { return this.data.clockSource; }
     public set clockSource(val: string) { this.setDataVal('clockSource', val); }
     public get adjustDST(): boolean { return this.data.adjustDST; }
     public set adjustDST(val: boolean) { this.setDataVal('adjustDST', val); }
     public get manualPriority(): boolean { return this.data.manualPriority; }
     public set manualPriority(val: boolean) { this.setDataVal('manualPriority', val); }
-    public get vacationMode(): boolean { return this.data.vacationMode; }
-    public set vacationMode(val: boolean) { this.setDataVal('vacationMode', val); }
+    public get vacation(): VacationOptions { return new VacationOptions(this.data, 'vacation', this); }
     public get manualHeat(): boolean { return this.data.manualHeat; }
     public set manualHeat(val: boolean) { this.setDataVal('manualHeat', val); }
     public get pumpDelay(): boolean { return this.data.pumpDelay; }
@@ -750,6 +756,42 @@ export class Options extends EqItem {
     //public get solarTempAdj2(): number { return typeof this.data.solarTempAdj2 === 'undefined' ? 0 : this.data.solarTempAdj2; }
     //public set solarTempAdj2(val: number) { this.setDataVal('solarTempAd2', val); }
 }
+export class VacationOptions extends ChildEqItem {
+    public initData() {
+        if (typeof this.data.enabled === 'undefined') this.data.enabled = false;
+        if (typeof this.data.useTimeframe === 'undefined') this.data.useTimeframe = false;
+    }
+    private _startDate: Date;
+    private _endDate: Date;
+    public get enabled(): boolean { return this.data.enabled; }
+    public set enabled(val: boolean) { this.setDataVal('enabled', val); }
+    public get useTimeframe(): boolean { return this.data.useTimeframe; }
+    public set useTimeframe(val: boolean) { this.setDataVal('useTimeframe', val); }
+    public get startDate() {
+        if (typeof this._startDate === 'undefined') this._startDate = typeof this.data.startDate === 'string' ? new Date(this.data.startDate) : undefined;
+        return this._startDate;
+    }
+    public set startDate(val: Date | string | number) {
+        this._startDate = new Date(val);
+        this._saveDate('startDate', this._startDate);
+    }
+    public get endDate() {
+        if (typeof this._endDate === 'undefined') this._endDate = typeof this.data.endDate === 'string' ? new Date(this.data.endDate) : undefined;
+        return this._endDate;
+    }
+    public set endDate(val: Date | string | number) {
+        this._endDate = new Date(val);
+        this._saveDate('endDate', this._endDate);
+    }
+
+    private _saveDate(prop: string, dt: Date) {
+        if (typeof dt !== 'undefined' && !isNaN(dt.getTime())) {
+            dt.setHours(0, 0, 0, 0);
+            this.setDataVal(prop, Timestamp.toISOLocal(dt));
+        }
+        else this.setDataVal(prop, undefined);
+    }
+}
 export class Location extends EqItem {
     public dataName = 'locationConfig';
     public get address(): string { return this.data.address; }
@@ -814,6 +856,8 @@ export class Equipment extends EqItem {
     public set shared(val: boolean) { this.setDataVal('shared', val); }
     public get dual(): boolean { return this.data.dual; }
     public set dual(val: boolean) { this.setDataVal('dual', val); }
+    public get intakeReturnValves(): boolean { return this.data.intakeReturnValves; }
+    public set intakeReturnValves(val: boolean) { this.setDataVal('intakeReturnValves', val); }
     public get maxBodies(): number { return this.data.maxBodies || 4; }
     public set maxBodies(val: number) { this.setDataVal('maxBodies', val); }
     public get maxValves(): number { return this.data.maxValves || 26; }
@@ -935,7 +979,6 @@ export class ConfigVersion extends EqItem {
             if (prop === 'lastUpdated') continue;
             this.data[prop] = 0;
         }
-
     }
 }
 
@@ -959,6 +1002,9 @@ export class BodyCollection extends EqItemCollection<Body> {
 }
 export class Body extends EqItem {
     public dataName = 'bodyConfig';
+    public initData() {
+        if (typeof this.data.capacityUnits === 'undefined') this.data.capacityUnits = 1;
+    }
     public get id(): number { return this.data.id; }
     public set id(val: number) { this.data.id = val; }
     public get name(): string { return this.data.name; }
@@ -983,7 +1029,14 @@ export class Body extends EqItem {
     public set heatSetpoint(val: number) { this.setDataVal('setPoint', val); }
     public get coolSetpoint(): number { return this.data.coolSetpoint; }
     public set coolSetpoint(val: number) { this.setDataVal('coolSetpoint', val); }
+    public get capacityUnits(): number | any { return this.data.capacityUnits; }
+    public set capacityUnits(val: number | any) { this.setDataVal('capacityUnits', sys.board.valueMaps.volumeUnits.encode(val)); }
     public getHeatModes() { return sys.board.bodies.getHeatModes(this.id); }
+    public getExtended() {
+        let body = this.get(true);
+        body.capacityUnits = sys.board.valueMaps.volumeUnits.transform(this.capacityUnits || 1);
+        return body;
+    }
 }
 export class ScheduleCollection extends EqItemCollection<Schedule> {
     constructor(data: any, name?: string) { super(data, name || "schedules"); }
@@ -1031,12 +1084,12 @@ export class Schedule extends EqItem {
     public get isActive(): boolean { return this.data.isActive; }
     public set isActive(val: boolean) { this.setDataVal('isActive', val); }
     public get startMonth(): number { return this._startDate.getMonth() + 1; }
-    public set startMonth(val: number) { this._startDate.setMonth(val - 1); this._saveStartDate(); }
-    public get startDay(): number { return this._startDate.getDate(); }
-    public set startDay(val: number) { this._startDate.setDate(val); this._saveStartDate(); }
-    public get startYear(): number { return this._startDate.getFullYear(); }
-    public set startYear(val: number) { this._startDate.setFullYear(val < 100 ? val + 2000 : val); this._saveStartDate(); }
-    public get startDate(): Date { return this._startDate; }
+    public set startMonth(val: number) { if (typeof this._startDate === 'undefined') this._startDate = new Date(); this._startDate.setMonth(val - 1); this._saveStartDate(); }
+    public get startDay(): number { if (typeof this._startDate === 'undefined') this._startDate = new Date(); return this._startDate.getDate(); }
+    public set startDay(val: number) { if (typeof this._startDate === 'undefined') this._startDate = new Date(); this._startDate.setDate(val); this._saveStartDate(); }
+    public get startYear(): number { if (typeof this._startDate === 'undefined') this._startDate = new Date(); return this._startDate.getFullYear(); }
+    public set startYear(val: number) { if (typeof this._startDate === 'undefined') this._startDate = new Date(); this._startDate.setFullYear(val < 100 ? val + 2000 : val); this._saveStartDate(); }
+    public get startDate(): Date { return typeof this._startDate === 'undefined' ? this._startDate = new Date() : this._startDate; }
     public set startDate(val: Date) { this._startDate = val; }
     public get scheduleType(): number | any { return this.data.scheduleType; }
     public set scheduleType(val: number | any) { this.setDataVal('scheduleType', sys.board.valueMaps.scheduleTypes.encode(val)); }
@@ -1192,7 +1245,7 @@ export interface ICircuit {
     //showInCircuits?: boolean;
     showInFeatures?: boolean;
     macro?: boolean;
-    getLightThemes?: (type?:number) => {};
+    getLightThemes?: (type?: number) => {};
     get(copy?: boolean);
     master: number;
 }
@@ -1211,6 +1264,9 @@ export class PumpCollection extends EqItemCollection<Pump> {
 }
 export class Pump extends EqItem {
     public dataName = 'pumpConfig';
+    public initData() {
+        if (typeof this.data.isVirtual !== 'undefined') delete this.data.isVirtual;
+    }
     public get id(): number { return this.data.id; }
     public set id(val: number) { this.setDataVal('id', val); }
     public get address(): number { return this.data.address || this.data.id + 95; }
@@ -1257,8 +1313,10 @@ export class Pump extends EqItem {
     public set vacuumTime(val: number) { this.setDataVal('vacuumTime', val); }
     public get backgroundCircuit() { return this.data.backgroundCircuit; }
     public set backgroundCircuit(val: number) { this.setDataVal('backgroundCircuit', val); }
-    public get isVirtual() { return this.data.isVirtual; }
-    public set isVirtual(val: boolean) { this.setDataVal('isVirtual', val); }
+    public get filterSize() { return this.data.filterSize; }
+    public set filterSize(val: number) { this.setDataVal('filterSize', val); }
+    // public get isVirtual() { return this.data.isVirtual; }
+    // public set isVirtual(val: boolean) { this.setDataVal('isVirtual', val); }
     public get connectionId(): string { return this.data.connectionId; }
     public set connectionId(val: string) { this.setDataVal('connectionId', val); }
     public get deviceBinding(): string { return this.data.deviceBinding; }
@@ -1414,8 +1472,8 @@ export class Valve extends EqItem {
     public set isIntake(val: boolean) { this.setDataVal('isIntake', val); }
     public get isReturn(): boolean { return utils.makeBool(this.data.isReturn); }
     public set isReturn(val: boolean) { this.setDataVal('isReturn', val); }
-    public get isVirtual(): boolean { return utils.makeBool(this.data.isVirtual); }
-    public set isVirtual(val: boolean) { this.setDataVal('isVirtual', val); }
+    // public get isVirtual(): boolean { return utils.makeBool(this.data.isVirtual); }
+    // public set isVirtual(val: boolean) { this.setDataVal('isVirtual', val); }
     public get pinId(): number { return this.data.pinId || 0; }
     public set pinId(val: number) { this.setDataVal('pinId', val); }
     public get isActive(): boolean { return this.data.isActive; }
@@ -1462,8 +1520,6 @@ export class Heater extends EqItem {
     public set efficiencyMode(val: number) { this.setDataVal('efficiencyMode', val); }
     public get isActive(): boolean { return this.data.isActive; }
     public set isActive(val: boolean) { this.setDataVal('isActive', val); }
-    public get isVirtual(): boolean { return this.data.isVirtual; }
-    public set isVirtual(val: boolean) { this.setDataVal('isVirtual', val); }
     public get coolingEnabled(): boolean { return this.data.coolingEnabled; }
     public set coolingEnabled(val: boolean) { this.setDataVal('coolingEnabled', val); }
     public get heatingEnabled(): boolean { return this.data.heatingEnabled; }
@@ -1500,6 +1556,10 @@ export class Cover extends EqItem {
     public set normallyOn(val: boolean) { this.setDataVal('normallyOn', val); }
     public get circuits(): number[] { return this.data.circuits; }
     public set circuits(val: number[]) { this.setDataVal('circuits', val); }
+    public get chlorActive(): boolean { return this.data.chlorActive; }
+    public set chlorActive(val: boolean) { this.setDataVal('chlorActive', val); }
+    public get chlorOutput(): boolean { return this.data.chlorOutput; }
+    public set chlorOutput(val: boolean) { this.setDataVal('chlorOutput', val); }
 }
 export interface ICircuitGroup {
     id: number;
@@ -1821,7 +1881,7 @@ export class ChemController extends EqItem {
         //var chemController = {
         //    id: 'number',               // Id of the controller
         //    name: 'string',             // Name assigned to the controller
-        //    type: 'valueMap',           // intellichem, homegrown, rem -- There is an unknown but that should probably go away.
+        //    type: 'valueMap',           // intellichem, rem -- There is an unknown but that should probably go away.
         //    body: 'valueMap',           // Body assigned to the chem controller.
         //    address: 'number',          // Address for IntelliChem controller only.
         //    isActive: 'booean',
@@ -1910,8 +1970,8 @@ export class ChemController extends EqItem {
     public set address(val: number) { this.setDataVal('address', val); }
     public get isActive(): boolean { return this.data.isActive; }
     public set isActive(val: boolean) { this.setDataVal('isActive', val); }
-    public get isVirtual(): boolean { return this.data.isVirtual; }
-    public set isVirtual(val: boolean) { this.setDataVal('isVirtual', val); }
+    // public get isVirtual(): boolean { return this.data.isVirtual; }
+    // public set isVirtual(val: boolean) { this.setDataVal('isVirtual', val); }
     public get calciumHardness(): number { return this.data.calciumHardness; }
     public set calciumHardness(val: number) { this.setDataVal('calciumHardness', val); }
     public get cyanuricAcid(): number { return this.data.cyanuricAcid; }
@@ -2198,7 +2258,7 @@ export class ChemicalChlor extends ChildEqItem {
     public initData() {
         super.initData();
     }
-    public get enabled(): boolean { 
+    public get enabled(): boolean {
         let chlor = sys.chlorinators.getItemById(1);
         return chlor.isActive;
     }
@@ -2215,10 +2275,10 @@ export class ChemicalChlor extends ChildEqItem {
         return typeof model.chlorinePerSec !== 'undefined' ? model.chlorinePerSec : 0;
     }
     public set ratedLbs(val: number) { this.setDataVal('ratedLbs', val); }
-    public get superChlor() { 
+    public get superChlor() {
         let chlor = sys.chlorinators.getItemById(1);
         return typeof chlor.superChlor !== 'undefined' ? chlor.superChlor : false;
-     }
+    }
     public getExtended() {
         let chlor = this.get(true);
         chlor.model = sys.board.valueMaps.chlorinatorModel.transform(this.model);

package/controller/Errors.ts

@@ -96,15 +96,28 @@ export class InvalidEquipmentDataError extends EquipmentError {
     }
     public eqData;
 }
+export class ServiceProcessError extends ApiError {
+    constructor(message: string, serviceName: string, process?: string) {
+        super(message, 290, 400);
+        this.name = 'ServiceProcessError';
+        this.service = serviceName;
+        this.process = process;
+    }
+    public process: string;
+    public service: string;
+}
 export class ServiceParameterError extends ApiError {
     constructor(message: string, serviceName: string, paramName: string, value) {
         super(message, 280, 400);
         this.name = 'InvalidServiceParameter';
+        
         this.value = value;
-        this.parameter = value;
+        this.parameter = paramName;
+        this.service = serviceName;
     }
     public value;
     public parameter: string;
+    public service: string;
 }
 export class InvalidOperationError extends ApiError {
     constructor(message: string, operation: string) {