nodejs-poolcontroller 7.3.0 → 7.6.0

package/controller/State.ts

@@ -7,7 +7,7 @@ published by the Free Software Foundation, either version 3 of the
 License, or (at your option) any later version.
 
 This program is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
+but WITHOUT ANY WARRANTY; without even the implied warranty of1
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 GNU Affero General Public License for more details.
 
@@ -26,7 +26,7 @@ import { sys, Chemical, ChemController } from './Equipment';
 import { versionCheck } from '../config/VersionCheck';
 import { EquipmentStateMessage } from './comms/messages/status/EquipmentStateMessage';
 import { DataLogger, DataLoggerEntry, IDataLoggerEntry } from '../logger/DataLogger';
-
+import { delayMgr } from './Lockouts';
 
 export class State implements IState {
     statePath: string;
@@ -36,6 +36,7 @@ export class State implements IState {
     private _isDirty: boolean;
     private _timerDirty: NodeJS.Timeout;
     protected _dt: Timestamp;
+    protected _startTime: Timestamp;
     protected _controllerType: ControllerType;
     protected onchange = (obj, fn) => {
         const handler = {
@@ -139,6 +140,7 @@ export class State implements IState {
             _state.filters = this.filters.getExtended();
             _state.schedules = this.schedules.getExtended();
             _state.chemControllers = this.chemControllers.getExtended();
+            _state.delays = delayMgr.serialize();
             return _state;
         }
         else {
@@ -152,7 +154,6 @@ export class State implements IState {
                     return extend(true, [], this.data[section] || []);
                 else
                     return extend(true, {}, this.data[section] || {});
-
         }
     }
     public async stopAsync() {
@@ -191,6 +192,8 @@ export class State implements IState {
     public get controllerState() {
         var self = this;
         return {
+            systemUnits: sys.board.valueMaps.systemUnits.transform(sys.general.options.units),
+            startTime: self.data.startTime || '',
             time: self.data.time || '',
             // body: self.data.body || {},
             valve: self.data.valve || 0,
@@ -200,7 +203,6 @@ export class State implements IState {
             batteryVoltage: self.data.batteryVoltage || 0,
             status: self.data.status || {},
             mode: self.data.mode || {},
-            // freeze: self.data.freeze || false,
             appVersion: sys.appVersion || '',
             appVersionState: self.appVersion.get(true) || {},
             clockMode: sys.board.valueMaps.clockModes.transform(sys.general.options.clockMode) || {},
@@ -209,7 +211,9 @@ export class State implements IState {
             model: sys.equipment.model,
             sunrise: self.data.sunrise || '',
             sunset: self.data.sunset || '',
-            alias: sys.general.alias
+            alias: sys.general.alias,
+            freeze: utils.makeBool(self.data.freeze),
+            valveMode: self.data.valveMode || {},
         };
     }
     public emitAllEquipmentChanges() {
@@ -284,6 +288,14 @@ export class State implements IState {
             this.hasChanged = true;
         }
     }
+    public get valveMode(): number { return typeof this.data.valveMode !== 'undefined' ? this.data.valveMode.val : 0; }
+    public set valveMode(val: number) {
+        let m = sys.board.valueMaps.valveModes.transform(val);
+        if (m.val !== this.valveMode) {
+            this.data.valveMode = m;
+            this.hasChanged = true;
+        }
+    }
     public get freeze(): boolean { return this.data.freeze === true; }
     public set freeze(val: boolean) {
         if (this.data.freeze !== val) {
@@ -305,7 +317,6 @@ export class State implements IState {
                 this.hasChanged = true;
             }
         }
-
     }
     public get valve(): number { return this.data.valve; }
     public set valve(val: number) {
@@ -330,14 +341,30 @@ export class State implements IState {
     public get isInitialized(): boolean { return typeof (this.data.status) !== 'undefined' && this.data.status.val !== 0; }
     public init() {
         console.log(`Init state for Pool Controller`);
-        var state = this.loadFile(this.statePath, {});
-        state = extend(true, { mode: { val: -1 }, temps: { units: { val: 0, name: 'F', desc: 'Fahrenheit' } } }, state);
+        var sdata = this.loadFile(this.statePath, {});
+        sdata = extend(true, { mode: { val: -1 }, temps: { units: { val: 0, name: 'F', desc: 'Fahrenheit' } } }, sdata);
+        if (typeof sdata.temps !== 'undefined' && typeof sdata.temps.bodies !== 'undefined') {
+            EqStateCollection.removeNullIds(sdata.temps.bodies);
+        }
+        EqStateCollection.removeNullIds(sdata.schedules);
+        EqStateCollection.removeNullIds(sdata.features);
+        EqStateCollection.removeNullIds(sdata.circuits);
+        EqStateCollection.removeNullIds(sdata.pumps);
+        EqStateCollection.removeNullIds(sdata.chlorinators);
+        EqStateCollection.removeNullIds(sdata.valves);
+        EqStateCollection.removeNullIds(sdata.heaters);
+        EqStateCollection.removeNullIds(sdata.covers);
+        EqStateCollection.removeNullIds(sdata.circuitGroups);
+        EqStateCollection.removeNullIds(sdata.lightGroups);
+        EqStateCollection.removeNullIds(sdata.remotes);
+        EqStateCollection.removeNullIds(sdata.chemControllers);
+        EqStateCollection.removeNullIds(sdata.filters);
         var self = this;
-        let pnlTime = typeof state.time !== 'undefined' ? new Date(state.time) : new Date();
+        let pnlTime = typeof sdata.time !== 'undefined' ? new Date(sdata.time) : new Date();
         if (isNaN(pnlTime.getTime())) pnlTime = new Date();
         this._dt = new Timestamp(pnlTime);
         this._dt.milliseconds = 0;
-        this.data = state;
+        this.data = sdata;
         //this.onchange(state, function () { self.dirty = true; });
         this._dt.emitter.on('change', function () {
             self.data.time = self._dt.format();
@@ -370,6 +397,7 @@ export class State implements IState {
         this.comms = new CommsState();
         this.heliotrope = new Heliotrope();
         this.appVersion = new AppVersionState(this.data, 'appVersion');
+        this.data.startTime = Timestamp.toISOLocal(new Date());
         versionCheck.checkGitLocal();
     }
     public resetData() {
@@ -467,11 +495,15 @@ export interface ICircuitState {
     name: string;
     nameId?: number;
     isOn: boolean;
+    startTime?: Timestamp;
     endTime: Timestamp;
     lightingTheme?: number;
     emitEquipmentChange();
     get(bCopy?: boolean);
     showInFeatures?: boolean;
+    isActive?: boolean;
+    startDelay?: boolean;
+    stopDelay?: boolean;
 }
 
 interface IEqStateCreator<T> { ctor(data: any, name: string, parent?): T; }
@@ -571,6 +603,20 @@ class EqStateCollection<T> {
         if (typeof (data[name]) === 'undefined') data[name] = [];
         this.data = data[name];
     }
+    public static removeNullIds(data: any) {
+        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') {
+                    console.log(`Removing ${data[i].id}-${data[i].name}`);
+                    data.splice(i, 1);
+                }
+                else if (typeof data[i].id === 'undefined' || isNaN(data[i].id)) {
+                    console.log(`Removing isNaN ${data[i].id}-${data[i].name}`);
+                    data.splice(i, 1);
+                }
+            }
+        }
+    }
     public getItemById(id: number, add?: boolean, data?: any): T {
         for (let i = 0; i < this.data.length; i++)
             if (typeof this.data[i].id !== 'undefined' && this.data[i].id === id) {
@@ -827,7 +873,10 @@ export class PumpStateCollection extends EqStateCollection<PumpState> {
     }
     public cleanupState() {
         for (let i = this.data.length - 1; i >= 0; i--) {
-            if (typeof sys.pumps.find(elem => elem.id === this.data[i].id) === 'undefined') this.removeItemById(this.data[i].id);
+            if (isNaN(this.data[i].id)) this.data.splice(i, 1);
+            else {
+                if (typeof sys.pumps.find(elem => elem.id === this.data[i].id) === 'undefined') this.removeItemById(this.data[i].id);
+            }
         }
         let cfg = sys.pumps.toArray();
         for (let i = 0; i < cfg.length; i++) {
@@ -842,6 +891,13 @@ export class PumpStateCollection extends EqStateCollection<PumpState> {
 }
 export class PumpState extends EqState {
     public dataName: string = 'pump';
+    public initData() {
+        if (typeof this.data.status === 'undefined') {
+            this.data.status = { name: 'ok', desc: 'Ok', val: 0 };
+        }
+        if (typeof this.data.pumpOnDelay === 'undefined') this.data.pumpOnDelay = false;
+    }
+    private _pumpOnDelayTimer: NodeJS.Timeout;
     private _threshold = 0.05;
     private exceedsThreshold(origVal: number, newVal: number) {
         return Math.abs((newVal - origVal) / origVal) > this._threshold;
@@ -875,7 +931,7 @@ export class PumpState extends EqState {
         // quick fix for #172
         if (this.status !== val) {
             if (sys.board.valueMaps.pumpTypes.getName(this.type) === 'vsf' && val === 0) {
-                this.data.status = { name: 'ok', desc: 'Ok', val };
+                this.data.status = { name: 'ok', desc: 'Ok', val: 0 };
             }
             else this.data.status = sys.board.valueMaps.pumpStatus.transform(val);
             this.hasChanged = true;
@@ -901,6 +957,23 @@ export class PumpState extends EqState {
     }
     public get time(): number { return this.data.time; }
     public set time(val: number) { this.setDataVal('time', val, false); }
+    public get pumpOnDelay() { return this.data.pumpOnDelay; }
+    public set pumpOnDelay(val: boolean) {
+        if (val === false) {
+            if (typeof this._pumpOnDelayTimer !== 'undefined') clearTimeout(this._pumpOnDelayTimer);
+            this._pumpOnDelayTimer = undefined;
+        }
+        this.setDataVal('pumpOnDelay', val);
+    }
+    public setPumpOnDelayTimeout(delay: number) {
+        this.pumpOnDelay = true;
+        logger.info(`Pump ON Delay ${this.name} for ${delay / 1000} seconds`);
+        this._pumpOnDelayTimer = setTimeout(() => {
+            logger.info(`Pump ON Delay ${this.name} expired`);
+            this.pumpOnDelay = false;
+        }, delay);
+    }
+   
     public getExtended() {
         let pump = this.get(true);
         let cpump = sys.pumps.getItemById(pump.id);
@@ -957,6 +1030,7 @@ export class ScheduleState extends EqState {
     public get startDate(): Date { return this._startDate; }
     public set startDate(val: Date) { this._startDate = val; this._saveStartDate(); }
     private _saveStartDate() {
+        if (typeof this._startDate === 'undefined') this._startDate = new Date();
         this.startDate.setHours(0, 0, 0, 0);
         this.setDataVal('startDate', Timestamp.toISOLocal(this.startDate));
     }
@@ -1061,7 +1135,10 @@ export class CircuitGroupStateCollection extends EqStateCollection<CircuitGroupS
     }
     public cleanupState() {
         for (let i = this.data.length - 1; i >= 0; i--) {
-            if (typeof sys.circuitGroups.find(elem => elem.id === this.data[i].id) === 'undefined') this.removeItemById(this.data[i].id);
+            if (isNaN(this.data[i].id)) this.data.splice(i, 1);
+            else {
+                if (typeof sys.circuitGroups.find(elem => elem.id === this.data[i].id) === 'undefined') this.removeItemById(this.data[i].id);
+            }
         }
         let cfg = sys.circuitGroups.toArray();
         for (let i = 0; i < cfg.length; i++) {
@@ -1121,12 +1198,23 @@ export class CircuitGroupState extends EqState implements ICircuitGroupState, IC
             state._dirtyList.removeEqState(this);
         }
     }
+    public get(bcopy?: boolean): any {
+        let d = super.get(bcopy);
+        let cg = sys.circuitGroups.getItemById(this.id);
+        if (!cg.isActive) d.isActive = false;
+        else d.isActive = undefined;
+        return d;
+    }
+
 }
 export class LightGroupStateCollection extends EqStateCollection<LightGroupState> {
     public createItem(data: any): LightGroupState { return new LightGroupState(data); }
     public cleanupState() {
         for (let i = this.data.length - 1; i >= 0; i--) {
-            if (typeof sys.lightGroups.find(elem => elem.id === this.data[i].id) === 'undefined') this.removeItemById(this.data[i].id);
+            if (isNaN(this.data[i].id)) this.data.splice(i, 1);
+            else {
+                if (typeof sys.lightGroups.find(elem => elem.id === this.data[i].id) === 'undefined') this.removeItemById(this.data[i].id);
+            }
         }
         let cfg = sys.lightGroups.toArray();
         for (let i = 0; i < cfg.length; i++) {
@@ -1205,10 +1293,24 @@ export class BodyTempStateCollection extends EqStateCollection<BodyTempState> {
         }
         return undefined;
     }
+    public getBodyByCircuitId(circuitId: number) {
+        let b = this.data.find(x => x.circuit === circuitId);
+        if (typeof b === 'undefined') {
+            let circ = sys.circuits.getItemById(circuitId);
+            // Find our body by circuit function.
+            let cfn = sys.board.valueMaps.circuitFunctions.get(circ.type);
+            if (typeof cfn.body !== 'undefined') b = this.data.find(x => x.id === cfn.body);
+        }
+        return typeof b !== 'undefined' ? this.createItem(b) : undefined;
+    }
     public cleanupState() {
         for (let i = this.data.length - 1; i >= 0; i--) {
-            if (typeof sys.bodies.find(elem => elem.id === this.data[i].id) === 'undefined') this.removeItemById(this.data[i].id);
+            if (isNaN(this.data[i].id)) this.data.splice(i, 1);
+            else {
+                if (typeof sys.bodies.find(elem => elem.id === this.data[i].id) === 'undefined') this.removeItemById(this.data[i].id);
+            }
         }
+        this.sortById();
     }
 
 }
@@ -1227,6 +1329,10 @@ export class BodyTempState extends EqState {
     public dataName = 'bodyTempState';
     public initData() {
         if (typeof this.data.heaterOptions === 'undefined') this.data.heaterOptions = { total: 0 };
+        if (typeof this.data.isCovered === 'undefined') this.data.isCovered = false;
+        if (typeof this.heaterCooldownDelay === 'undefined') this.data.heaterCooldownDelay = false;
+        if (typeof this.data.startDelay === 'undefined') this.data.startDelay = false;
+        if (typeof this.data.stopDelay === 'undefined') this.data.stopDelay = false;
     }
     public get id(): number { return this.data.id; }
     public set id(val: number) { this.setDataVal('id', val); }
@@ -1265,6 +1371,19 @@ export class BodyTempState extends EqState {
     public set coolSetpoint(val: number) { this.setDataVal('coolSetpoint', val); }
     public get isOn(): boolean { return this.data.isOn; }
     public set isOn(val: boolean) { this.setDataVal('isOn', val); }
+    public get startDelay(): boolean { return this.data.startDelay; }
+    public set startDelay(val: boolean) { this.setDataVal('startDelay', val); }
+    public get stopDelay(): boolean { return this.data.stopDelay; }
+    public set stopDelay(val: boolean) { this.setDataVal('stopDelay', val); }
+
+    public get isCovered(): boolean { return this.data.isCovered; }
+    public set isCovered(val: boolean) { this.setDataVal('isCovered', val); }
+    // RKS: Heater cooldown delays force the current valve and body configuration until the
+    // heater cooldown expires.  This occurs at the pool level but it is triggered by the heater attached
+    // to the body.  Unfortunately, I think we can only detect this condition in Nixie as there really isn't an
+    // indicator with Pentair OCPs.  This is triggered in NixieBoard and managed by the delayMgr.
+    public get heaterCooldownDelay(): boolean { return this.data.heaterCooldownDelay; }
+    public set heaterCooldownDelay(val: boolean) { this.setDataVal('heaterCooldownDelay', val); }
     public emitData(name: string, data: any) { webApp.emitToClients('body', this.data); }
     // RKS: This is a very interesting object because we have a varied object.  Type safety rules should not apply
     // here as the heater types are specific to the installed equipment.  The reason is because it has no meaning without the body and the calculation of it should
@@ -1331,7 +1450,13 @@ export class HeaterStateCollection extends EqStateCollection<HeaterState> {
     public createItem(data: any): HeaterState { return new HeaterState(data); }
     public cleanupState() {
         for (let i = this.data.length - 1; i >= 0; i--) {
-            if (typeof sys.heaters.find(elem => elem.id === this.data[i].id) === 'undefined') this.removeItemById(this.data[i].id);
+            if (isNaN(this.data[i].id)) {
+                logger.info(`Removed Invalid Heater ${this.data[i].id}-${this.data[i].name}`);
+                this.data.splice(i, 1);
+            }
+            else {
+                if (typeof sys.heaters.find(elem => elem.id === this.data[i].id) === 'undefined') this.removeItemById(this.data[i].id);
+            }
         }
         let cfg = sys.heaters.toArray();
         for (let i = 0; i < cfg.length; i++) {
@@ -1344,16 +1469,36 @@ export class HeaterStateCollection extends EqStateCollection<HeaterState> {
 }
 export class HeaterState extends EqState {
     public dataName: string = 'heater';
+    public initData() {
+        if (typeof this.data.startupDelay === 'undefined') this.data.startupDelay = false;
+        if (typeof this.data.shutdownDelay === 'undefined') this.data.shutdownDelay = false;
+    }
     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; }
     public set name(val: string) { this.setDataVal('name', val); }
     public get isOn(): boolean { return this.data.isOn; }
-    public set isOn(val: boolean) { this.setDataVal('isOn', val); }
+    public set isOn(val: boolean) {
+        if (val !== this.data.isOn) {
+            if (val) this.startTime = new Timestamp();
+            else this.endTime = new Timestamp();
+        }
+        this.setDataVal('isOn', val);
+    }
+    public get startTime(): Timestamp {
+        if (typeof this.data.startTime === 'undefined') return undefined;
+        return new Timestamp(this.data.startTime);
+    }
+    public set startTime(val: Timestamp) { typeof val !== 'undefined' ? this.setDataVal('startTime', Timestamp.toISOLocal(val.toDate())) : this.setDataVal('startTime', undefined); }
+
+    public get endTime(): Timestamp {
+        if (typeof this.data.endTime === 'undefined') return undefined;
+        return new Timestamp(this.data.endTime);
+    }
+    public set endTime(val: Timestamp) { typeof val !== 'undefined' ? this.setDataVal('endTime', Timestamp.toISOLocal(val.toDate())) : this.setDataVal('endTime', undefined); }
+
     public get isCooling(): boolean { return this.data.isCooling; }
     public set isCooling(val: boolean) { this.setDataVal('isCooling', val); }
-    //public get isVirtual(): boolean { return this.data.isVirtual; }
-    //public set isVirtual(val: boolean) { this.setDataVal('isVirtual', val); }
     public get type(): number | any { return typeof this.data.type !== 'undefined' ? this.data.type.val : 0; }
     public set type(val: number | any) {
         if (this.type !== val) {
@@ -1368,6 +1513,13 @@ export class HeaterState extends EqState {
             this.hasChanged = true;
         }
     }
+    public get startupDelay(): boolean { return this.data.startupDelay; }
+    public set startupDelay(val: boolean) { this.setDataVal('startupDelay', val); }
+    public get shutdownDelay(): boolean { return this.data.shutdownDelay; }
+    public set shutdownDelay(val: boolean) { this.setDataVal('shutdownDelay', val); }
+    public get bodyId(): number { return this.data.bodyId || 0 }
+    public set bodyId(val: number) { this.setDataVal('bodyId', val); }
+
 }
 export class FeatureStateCollection extends EqStateCollection<FeatureState> {
     public createItem(data: any): FeatureState { return new FeatureState(data); }
@@ -1375,7 +1527,10 @@ export class FeatureStateCollection extends EqStateCollection<FeatureState> {
     public async toggleFeatureStateAsync(id: number) { return sys.board.features.toggleFeatureStateAsync(id); }
     public cleanupState() {
         for (let i = this.data.length - 1; i >= 0; i--) {
-            if (typeof sys.features.find(elem => elem.id === this.data[i].id) === 'undefined') this.removeItemById(this.data[i].id);
+            if (isNaN(this.data[i].id)) this.data.splice(i, 1);
+            else {
+                if (typeof sys.features.find(elem => elem.id === this.data[i].id) === 'undefined') this.removeItemById(this.data[i].id);
+            }
         }
         let cfg = sys.features.toArray();
         for (let i = 0; i < cfg.length; i++) {
@@ -1391,6 +1546,9 @@ export class FeatureStateCollection extends EqStateCollection<FeatureState> {
 
 export class FeatureState extends EqState implements ICircuitState {
     public dataName: string = 'feature';
+    public initData() {
+        if (typeof this.data.freezeProtect === 'undefined') this.data.freezeProtect = false;
+    }
     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; }
@@ -1413,6 +1571,12 @@ export class FeatureState extends EqState implements ICircuitState {
         return new Timestamp(this.data.endTime);
     }
     public set endTime(val: Timestamp) { typeof val !== 'undefined' ? this.setDataVal('endTime', Timestamp.toISOLocal(val.toDate())) : this.setDataVal('endTime', undefined); }
+    // This property will be set if the system has turn this feature on for freeze protection reasons.  We have no way of knowing when Pentair does this but
+    // need to know (so we can shut it off) if we have done this.
+    public get freezeProtect(): boolean { return this.data.freezeProtect; }
+    public set freezeProtect(val: boolean) { this.setDataVal('freezeProtect', val); }
+    public get isActive(): boolean { return this.data.isActive; }
+    public set isActive(val: boolean) { this.setDataVal('isActive', val); }
 }
 export class VirtualCircuitState extends EqState implements ICircuitState {
     public dataName: string = 'virtualCircuit';
@@ -1436,6 +1600,8 @@ export class VirtualCircuitState extends EqState implements ICircuitState {
         return new Timestamp(this.data.endTime);
     }
     public set endTime(val: Timestamp) { typeof val !== 'undefined' ? this.setDataVal('endTime', Timestamp.toISOLocal(val.toDate())) : this.setDataVal('endTime', undefined); }
+    public get isActive(): boolean { return this.data.isActive; }
+    public set isActive(val: boolean) { this.setDataVal('isActive', val); }
 }
 export class VirtualCircuitStateCollection extends EqStateCollection<VirtualCircuitState> {
     public createItem(data: any): VirtualCircuitState { return new VirtualCircuitState(data); }
@@ -1460,7 +1626,10 @@ export class CircuitStateCollection extends EqStateCollection<CircuitState> {
     }
     public cleanupState() {
         for (let i = this.data.length - 1; i >= 0; i--) {
-            if (typeof sys.circuits.find(elem => elem.id === this.data[i].id) === 'undefined') this.removeItemById(this.data[i].id);
+            if (isNaN(this.data[i].id)) this.data.splice(i, 1);
+            else {
+                if (typeof sys.circuits.find(elem => elem.id === this.data[i].id) === 'undefined') this.removeItemById(this.data[i].id);
+            }
         }
         let cfg = sys.circuits.toArray();
         for (let i = 0; i < cfg.length; i++) {
@@ -1476,6 +1645,9 @@ export class CircuitStateCollection extends EqStateCollection<CircuitState> {
 }
 export class CircuitState extends EqState implements ICircuitState {
     public dataName = 'circuit';
+    public initData() {
+        if (typeof this.data.freezeProtect === 'undefined') this.data.freezeProtect = false;
+    }
     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; }
@@ -1485,7 +1657,11 @@ export class CircuitState extends EqState implements ICircuitState {
     public get showInFeatures(): boolean { return this.data.showInFeatures; }
     public set showInFeatures(val: boolean) { this.setDataVal('showInFeatures', val); }
     public get isOn(): boolean { return this.data.isOn; }
-    public set isOn(val: boolean) { this.setDataVal('isOn', val); }
+    public set isOn(val: boolean) {
+        if (val && !this.data.isOn) this.startTime = new Timestamp();
+        else if (!val) this.startTime = undefined;
+        this.setDataVal('isOn', val);
+    }
     public get type() { return typeof (this.data.type) !== 'undefined' ? this.data.type.val : -1; }
     public set type(val: number) {
         if (this.type !== val) {
@@ -1493,10 +1669,12 @@ export class CircuitState extends EqState implements ICircuitState {
             this.hasChanged = true;
         }
     }
-    public get lightingTheme(): number { return typeof (this.data.lightingTheme) !== 'undefined' ? this.data.lightingTheme.val : 255; }
+    public get lightingTheme(): number { return typeof this.data.lightingTheme !== 'undefined' ? this.data.lightingTheme.val : 255; }
     public set lightingTheme(val: number) {
         if (this.lightingTheme !== val) {
-            this.data.lightingTheme = sys.board.valueMaps.lightThemes.transform(val);
+            // Force this to undefined when we are a circuit without a theme.
+            if (typeof val === 'undefined') this.data.lightingTheme = undefined;
+            else this.data.lightingTheme = sys.board.valueMaps.lightThemes.transform(val);
             this.hasChanged = true;
         }
     }
@@ -1509,17 +1687,42 @@ export class CircuitState extends EqState implements ICircuitState {
             this.hasChanged = true;
         }
     }
+    public get startTime(): Timestamp {
+        if (typeof this.data.startTime === 'undefined') return undefined;
+        return new Timestamp(this.data.startTime);
+    }
+    public set startTime(val: Timestamp) { typeof val !== 'undefined' ? this.setDataVal('startTime', Timestamp.toISOLocal(val.toDate())) : this.setDataVal('startTime', undefined); }
+
     public get endTime(): Timestamp {
         if (typeof this.data.endTime === 'undefined') return undefined;
         return new Timestamp(this.data.endTime);
     }
     public set endTime(val: Timestamp) { typeof val !== 'undefined' ? this.setDataVal('endTime', Timestamp.toISOLocal(val.toDate())) : this.setDataVal('endTime', undefined); }
+    // This property will be set if the system has turn this circuit on for freeze protection reasons.  We have no way of knowing when Pentair does this but
+    // need to know (so we can shut it off) if we have done this.
+    public get freezeProtect(): boolean { return this.data.freezeProtect; }
+    public set freezeProtect(val: boolean) { this.setDataVal('freezeProtect', val); }
+    public get isActive(): boolean { return this.data.isActive; }
+    public set isActive(val: boolean) { this.setDataVal('isActive', val); }
+    // The properties below are for delays and lockouts.  Manual or scheduled
+    // actions cannot be performed when the flags below are set.
+    public get startDelay(): boolean { return this.data.startDelay; }
+    public set startDelay(val: boolean) { this.setDataVal('startDelay', val); }
+    public get stopDelay(): boolean { return this.data.stopDelay; }
+    public set stopDelay(val: boolean) { this.setDataVal('stopDelay', val); }
+    public get lockoutOn(): boolean { return this.data.lockoutOn; }
+    public set lockoutOn(val: boolean) { this.setDataVal('lockoutOn', val); }
+    public get lockoutOff(): boolean { return this.data.lockoutOff; }
+    public set lockoutOff(val: boolean) { this.setDataVal('lockoutOff', val); }
 }
 export class ValveStateCollection extends EqStateCollection<ValveState> {
     public createItem(data: any): ValveState { return new ValveState(data); }
     public cleanupState() {
         for (let i = this.data.length - 1; i >= 0; i--) {
-            if (typeof sys.valves.find(elem => elem.id === this.data[i].id) === 'undefined') this.removeItemById(this.data[i].id);
+            if (isNaN(this.data[i].id)) this.data.splice(i, 1);
+            else {
+                if (typeof sys.valves.find(elem => elem.id === this.data[i].id) === 'undefined') this.removeItemById(this.data[i].id);
+            }
         }
         let cfg = sys.valves.toArray();
         for (let i = 0; i < cfg.length; i++) {
@@ -1558,7 +1761,7 @@ export class ValveState extends EqState {
         if (valve.circuit !== 256) vstate.circuit = state.circuits.getInterfaceById(valve.circuit).get(true);
         vstate.isIntake = utils.makeBool(valve.isIntake);
         vstate.isReturn = utils.makeBool(valve.isReturn);
-        vstate.isVirtual = utils.makeBool(valve.isVirtual);
+        // vstate.isVirtual = utils.makeBool(valve.isVirtual);
         vstate.isActive = utils.makeBool(valve.isActive);
         vstate.pinId = valve.pinId;
         return vstate;
@@ -1576,12 +1779,15 @@ export class CoverStateCollection extends EqStateCollection<CoverState> {
 }
 export class CoverState extends EqState {
     public dataName: string = 'cover';
+    public initData() {
+        if (typeof this.data.isClosed === 'undefined') this.data.isClosed = false;
+    }
     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; }
     public set name(val: string) { this.setDataVal('name', val); }
-    public get isOpen(): boolean { return this.data.isOpen; }
-    public set isOpen(val: boolean) { this.setDataVal('isOpen', val); }
+    public get isClosed(): boolean { return this.data.isClosed; }
+    public set isClosed(val: boolean) { this.setDataVal('isClosed', val); }
 }
 export class ChlorinatorStateCollection extends EqStateCollection<ChlorinatorState> {
     public createItem(data: any): ChlorinatorState { return new ChlorinatorState(data); }
@@ -1589,7 +1795,10 @@ export class ChlorinatorStateCollection extends EqStateCollection<ChlorinatorSta
     public lastDispatchSuperChlor: number = 0;
     public cleanupState() {
         for (let i = this.data.length - 1; i >= 0; i--) {
-            if (typeof sys.chlorinators.find(elem => elem.id === this.data[i].id) === 'undefined') this.removeItemById(this.data[i].id);
+            if (isNaN(this.data[i].id)) this.data.splice(i, 1);
+            else {
+                if (typeof sys.chlorinators.find(elem => elem.id === this.data[i].id) === 'undefined') this.removeItemById(this.data[i].id);
+            }
         }
         let cfg = sys.chlorinators.toArray();
         for (let i = 0; i < cfg.length; i++) {
@@ -1642,16 +1851,6 @@ export class ChlorinatorState extends EqState {
             this.hasChanged = true;
         }
     }
-    //public get virtualControllerStatus(): number {
-    //    return typeof (this.data.virtualControllerStatus) !== 'undefined' ? this.data.virtualControllerStatus.val : -1;
-    //}
-    //public set virtualControllerStatus(val: number) {
-    //    if (this.virtualControllerStatus !== val) {
-    //        this.data.virtualControllerStatus = sys.board.valueMaps.virtualControllerStatus.transform(val);
-    //        this.hasChanged = true;
-
-    //    }
-    //}
     public get type(): number { return typeof (this.data.type) !== 'undefined' ? this.data.type.val : -1; }
     public set type(val: number) {
         if (this.type !== val) {
@@ -1738,12 +1937,21 @@ export class ChlorinatorState extends EqState {
         else
             this.setDataVal('superChlor', false);
     }
+    public getExtended(): any {
+        let schlor = this.get(true);
+        let chlor = sys.chlorinators.getItemById(this.id, false);
+        schlor.lockSetpoints = chlor.disabled || chlor.isDosing;
+        return schlor;
+    }
 }
 export class ChemControllerStateCollection extends EqStateCollection<ChemControllerState> {
     public createItem(data: any): ChemControllerState { return new ChemControllerState(data); }
     public cleanupState() {
         for (let i = this.data.length - 1; i >= 0; i--) {
-            if (typeof sys.chemControllers.find(elem => elem.id === this.data[i].id) === 'undefined') this.removeItemById(this.data[i].id);
+            if (isNaN(this.data[i].id)) this.data.splice(i, 1);
+            else {
+                if (typeof sys.chemControllers.find(elem => elem.id === this.data[i].id) === 'undefined') this.removeItemById(this.data[i].id);
+            }
         }
         // Make sure we have at least the items that exist in the config.
         let cfg = sys.chemControllers.toArray();
@@ -1783,7 +1991,7 @@ export class ChemControllerState extends EqState {
         //var chemControllerState = {
         //    lastComm: 'number',             // The unix time the chem controller sent its status.
         //    id: 'number',                   // Id of the chemController.
-        //    type: 'valueMap',               // intellichem, homegrown, rem.
+        //    type: 'valueMap',               // intellichem, rem.
         //    address: 'number',              // Assigned address if IntelliChem.
         //    name: 'string',                 // Name assigned to the controller.
         //    status: 'valueMap',             // ok, nocomms, setupError
@@ -2006,14 +2214,15 @@ export class ChemControllerState extends EqState {
 export class ChemicalState extends ChildEqState {
     public initData() {
         if (typeof this.data.probe === 'undefined') this.data.probe = {};
-        if (typeof this.data.tank == 'undefined') this.data.tank = { capacity: 0, level: 0, units: 0 };
+        if (typeof this.data.tank === 'undefined') this.data.tank = { capacity: 0, level: 0, units: 0 };
+        if (typeof this.data.pump === 'undefined') this.data.pump = { isDosing: false };
         if (typeof this.data.dosingTimeRemaining === 'undefined') this.data.dosingTimeRemaining = 0;
         if (typeof this.data.delayTimeRemaining === 'undefined') this.data.delayTimeRemaining = 0;
         if (typeof this.data.dosingVolumeRemaining === 'undefined') this.data.dosingVolumeRemaining = 0;
         if (typeof this.data.doseVolume === 'undefined') this.data.doseVolume = 0;
         if (typeof this.data.doseTime === 'undefined') this.data.doseTime = 0;
         if (typeof this.data.lockout === 'undefined') this.data.lockout = false;
-        if (typeof this.data.level == 'undefined') this.data.level = 0;
+        if (typeof this.data.level === 'undefined') this.data.level = 0;
         if (typeof this.data.mixTimeRemaining === 'undefined') this.data.mixTimeRemaining = 0;
         if (typeof this.data.dailyLimitReached === 'undefined') this.data.dailyLimitReached = false;
         if (typeof this.data.manualDosing === 'undefined') this.data.manualDosing = false;
@@ -2021,7 +2230,6 @@ export class ChemicalState extends ChildEqState {
         if (typeof this.data.flowDelay === 'undefined') this.data.flowDelay = false;
         if (typeof this.data.dosingStatus === 'undefined') this.dosingStatus = 2;
         if (typeof this.data.enabled === 'undefined') this.data.enabled = true;
-        if (typeof this.data.level === 'undefined') this.data.level = 0;
     }
     public getConfig(): Chemical { return; }
     public calcDoseHistory(): number {
@@ -2185,7 +2393,7 @@ export class ChemicalState extends ChildEqState {
 }
 export class ChemicalPhState extends ChemicalState {
     public initData() {
-        if (typeof this.data.chemType === 'undefined') this.data.chemType === 'acid';
+        // if (typeof this.data.chemType === 'undefined') this.data.chemType === 'acid';  // RSG 10-23-21 - Only a getter; don't need to set this.
         super.initData();
     }
     public getConfig() {
@@ -2390,14 +2598,16 @@ export class ChemicalDoseState extends DataLoggerEntry {
     public _isManual: boolean;
 
     constructor(entry?: string | object) {
-        super(entry);
+        super();
+        if (typeof entry === 'object') entry = JSON.stringify(entry);
+        if (typeof entry === 'string') this.parse(entry);
         // Javascript is idiotic in that the initialization of variables
         // do not happen before the assignment so some of the values can be undefined.
         if (typeof this.volumeDosed === 'undefined' || !this.volumeDosed) this.volumeDosed = 0;
         if (typeof this.volume === 'undefined' || !this.volume) this.volume = 0;
         if (typeof this._isManual === 'undefined') this._isManual = this.method === 'manual';
         if (typeof this.timeDosed === 'undefined' || !this.timeDosed) this.timeDosed = 0;
-        if (typeof this._timeDosed === 'undefined') this.timeDosed * 1000;
+        if (typeof this._timeDosed === 'undefined') this._timeDosed = this.timeDosed * 1000;
         if (typeof this.time === 'undefined' || !this.time) this.time = 0;
     }
     public id: number;
@@ -2414,10 +2624,40 @@ export class ChemicalDoseState extends DataLoggerEntry {
     public time: number;
     public timeDosed: number;
 
-    public createInstance(entry?: string): ChemicalDoseState { return new ChemicalDoseState(entry); }
+    public static createInstance(entry?: string): ChemicalDoseState { return new ChemicalDoseState(entry); }
     public save() { DataLogger.writeEnd(`chemDosage_${this.chem}.log`, this); }
     public get timeRemaining(): number { return Math.floor(Math.max(0, this.time - (this._timeDosed / 1000))); }
     public get volumeRemaining(): number { return Math.max(0, this.volume - this.volumeDosed); }
+    public parse(entry: string) {
+        // let obj = typeof entry !== 'undefined' ? JSON.parse(entry, this.dateParser) : {};
+        let obj = typeof entry !== 'undefined' ? JSON.parse(entry) : {};
+        for (const prop in obj) {obj[prop] = this.dateParser(prop, obj[prop])}
+        if (typeof obj.setpoint !== 'undefined') this.setpoint = obj.setpoint;
+        if (typeof obj.method !== 'undefined') this.method = obj.method;
+        if (typeof obj.start !== 'undefined') this.start = obj.start;
+        if (typeof obj.end !== 'undefined') this.end = obj.end;
+        if (typeof obj.chem !== 'undefined') this.chem = obj.chem;
+        if (typeof obj.demand !== 'undefined') this.demand = obj.demand;
+        if (typeof obj.id !== 'undefined') this.id = obj.id;
+        if (typeof obj.level !== 'undefined') this.level = obj.level;
+        if (typeof obj.volume !== 'undefined') this.volume = obj.volume;
+        if (typeof obj.status !== 'undefined') this.status = obj.status;
+        if (typeof obj.volumeDosed !== 'undefined') this.volumeDosed = obj.volumeDosed;
+        if (typeof obj.time !== 'undefined') this.time = obj.time;
+        if (typeof obj.timeDosed !== 'undefined') this.timeDosed = obj.timeDosed;
+        // this.setProperties(obj);
+    }
+    protected setProperties(data: any) {
+        let op = Object.getOwnPropertyNames(Object.getPrototypeOf(this));
+        for (let i in op) {
+            let prop = op[i];
+            if (typeof this[prop] === 'function') continue;
+            if (typeof data[prop] !== 'undefined') {
+                if (typeof this[prop] === null || typeof data[prop] === null) continue;
+                this[prop] = data[prop];
+            }
+        }
+    }
 }
 
 export class ChemicalDemandState extends ChildEqState {
@@ -2665,15 +2905,35 @@ export class FilterState extends EqState {
             this.hasChanged = true;
         }
     }
-    public get psi(): number { return this.data.psi; }
-    public set psi(val: number) { this.setDataVal('psi', val); }
-    public get filterPsi(): number { return this.data.filterPsi; } // do not exceed value.  
-    public set filterPsi(val: number) { this.setDataVal('filterPsi', val); }
+    public get pressureUnits(): number { return this.data.pressureUnits; }
+    public set pressureUnits(val: number) {
+        if (this.pressureUnits !== val) {
+            this.setDataVal('pressureUnits', sys.board.valueMaps.pressureUnits.transform(val));
+        }
+    }
+    public get pressure(): number { return this.data.pressure; }
+    public set pressure(val: number) { this.setDataVal('pressure', val); }
+    public get refPressure(): number { return this.data.refPressure; }
+    public set refPressure(val: number) {
+        if (val !== this.refPressure) {
+            this.setDataVal('refPressure', val);
+            this.calcCleanPercentage();
+        }
+        else { this.setDataVal('refPressure', val); }
+    }
+    public get cleanPercentage(): number { return this.data.cleanPercentage; }
+    public set cleanPercentage(val: number) { this.setDataVal('cleanPercentage', val); }
     public get lastCleanDate(): Timestamp { return this.data.lastCleanDate; }
     public set lastCleanDate(val: Timestamp) { this.setDataVal('lastCleanDate', val); }
-    public get needsCleaning(): number { return this.data.needsCleaning; }
-    public set needsCleaning(val: number) { this.setDataVal('needsCleaning', val); }
     public get isOn(): boolean { return utils.makeBool(this.data.isOn); }
     public set isOn(val: boolean) { this.setDataVal('isOn', val); }
+    public calcCleanPercentage() {
+        if (typeof this.refPressure === 'undefined') return;
+        let filter = sys.filters.find(elem => elem.id == this.id);
+        // 8 to 10
+        let cp = filter.cleanPressure || 0;
+        let dp = filter.dirtyPressure || 1;
+        this.cleanPercentage = (cp - dp != 0) ? Math.round(Math.max(0, (1 - (this.refPressure - cp) / (dp - cp)) * 100) * 100)/100 : 0;
+    }
 }
 export var state = new State();