nodejs-poolcontroller 7.7.0 → 8.0.0

package/controller/boards/IntelliComBoard.ts

@@ -1,5 +1,6 @@
 /*  nodejs-poolController.  An application to control pool equipment.
-Copyright (C) 2016, 2017, 2018, 2019, 2020.  Russell Goldin, tagyoureit.  russ.goldin@gmail.com
+Copyright (C) 2016, 2017, 2018, 2019, 2020, 2021, 2022.  
+Russell Goldin, tagyoureit.  russ.goldin@gmail.com
 
 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU Affero General Public License as
@@ -29,6 +30,10 @@ export class IntelliComBoard extends EasyTouchBoard {
         ]);
     }
     public initExpansionModules(byte1: number, byte2: number) {
+        switch (byte1) {
+            case 40: // This is a SunTouch
+                break;
+        }
         console.log(`Pentair IntelliCom System Detected!`);
 
         sys.equipment.model = 'Suntouch/Intellicom';
@@ -49,6 +54,7 @@ export class IntelliComBoard extends EasyTouchBoard {
         eq.maxPumps = md.maxPumps = typeof mt.pumps !== 'undefined' ? mt.pumps : 2;
         eq.shared = mt.shared;
         eq.dual = false;
+        eq.single = true;
         eq.maxChlorinators = md.chlorinators = 1;
         eq.maxChemControllers = md.chemControllers = 1;
         eq.maxCustomNames = 10;

package/controller/boards/IntelliTouchBoard.ts

@@ -1,5 +1,6 @@
 /*  nodejs-poolController.  An application to control pool equipment.
-Copyright (C) 2016, 2017, 2018, 2019, 2020.  Russell Goldin, tagyoureit.  russ.goldin@gmail.com
+Copyright (C) 2016, 2017, 2018, 2019, 2020, 2021, 2022.  
+Russell Goldin, tagyoureit.  russ.goldin@gmail.com
 
 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU Affero General Public License as
@@ -14,7 +15,7 @@ GNU Affero General Public License for more details.
 You should have received a copy of the GNU Affero General Public License
 along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
-import { byteValueMap } from './SystemBoard';
+import { byteValueMap, EquipmentIdRange, } from './SystemBoard';
 import { logger } from '../../logger/Logger';
 import { EasyTouchBoard, TouchConfigQueue, GetTouchConfigCategories, TouchCircuitCommands } from './EasyTouchBoard';
 import { state, ICircuitGroupState } from '../State';
@@ -22,24 +23,98 @@ import { PoolSystem, sys, ExpansionPanel, Equipment } from '../Equipment';
 
 import { conn } from '../comms/Comms';
 import { InvalidEquipmentDataError } from '../Errors';
+import { log } from 'winston';
 
 export class IntelliTouchBoard extends EasyTouchBoard {
     constructor(system: PoolSystem) {
         super(system);
+        // Circuits even in single body IntelliTouch always start at 1.
+        this.equipmentIds.circuits.start = 1;
         this.equipmentIds.features.start = 41;
         this.equipmentIds.features.end = 50;
+        this.equipmentIds.virtualCircuits = new EquipmentIdRange(154, 162);
         this._configQueue = new ITTouchConfigQueue();
         this.valueMaps.expansionBoards = new byteValueMap([
             [0, { name: 'IT5', part: 'i5+3', desc: 'IntelliTouch i5+3', circuits: 6, shared: true }],
             [1, { name: 'IT7', part: 'i7+3', desc: 'IntelliTouch i7+3', circuits: 8, shared: true }],
             [2, { name: 'IT9', part: 'i9+3', desc: 'IntelliTouch i9+3', circuits: 10, shared: true }],
-            [3, { name: 'IT5S', part: 'i5+3S', desc: 'IntelliTouch i5+3S', circuits: 5, shared: false, bodies: 2, intakeReturnValves: false }],
-            [4, { name: 'IT9S', part: 'i9+3S', desc: 'IntelliTouch i9+3S', circuits: 9, shared: false, bodies: 2, intakeReturnValves: false }],
-            [5, { name: 'IT10D', part: 'i10D', desc: 'IntelliTouch i10D', circuits: 10, shared: false, dual: true }],
+            [3, { name: 'IT5S', part: 'i5+3S', desc: 'IntelliTouch i5+3S', circuits: 5, single: true, shared: true, bodies: 2, intakeReturnValves: false }],
+            [4, { name: 'IT9S', part: 'i9+3S', desc: 'IntelliTouch i9+3S', circuits: 9, single: true, shared: true, bodies: 2, intakeReturnValves: false }],
+            [5, { name: 'IT10D', part: 'i10D', desc: 'IntelliTouch i10D', circuits: 10, single: true, shared: false, dual: true }],
             [32, { name: 'IT5X', part: 'i5X', desc: 'IntelliTouch i5X', circuits: 5 }],
             [33, { name: 'IT10X', part: 'i10X', desc: 'IntelliTouch i10X', circuits: 10 }],
             [64, { name: 'Valve Exp', part: '520285', desc: 'Valve Expansion Module', valves: 3 }]
         ]);
+        // I don't think these have ever been right.  
+        // So far I have seen below based on discussion #436
+        // 155 = heater
+        // 156 = poolheater
+        // 157 = spaheater
+        this.valueMaps.virtualCircuits = new byteValueMap([
+            [154, { name: 'freeze', desc: 'Freeze', assignableToPumpCircuit: true }],
+            [155, { name: 'spaHeater', desc: 'Spa Heater', assignableToPumpCircuit: true }],
+            [156, { name: 'poolHeater', desc: 'Pool Heater', assignableToPumpCircuit: true }],
+            [157, { name: 'heater', desc: 'Either Heater', assignableToPumpCircuit: true }],
+            [158, { name: 'solar', desc: 'Solar', assignableToPumpCircuit: true }],
+            [159, { name: 'heatBoost', desc: 'Heat Boost', assignableToPumpCircuit: false }],
+            [160, { name: 'heatEnable', desc: 'Heat Enable', assignableToPumpCircuit: false }],
+            [161, { name: 'pumpSpeedUp', desc: 'Pump Speed +', assignableToPumpCircuit: false }],
+            [162, { name: 'pumpSpeedDown', desc: 'Pump Speed -', assignableToPumpCircuit: false }],
+            [255, { name: 'notused', desc: 'NOT USED', assignableToPumpCircuit: true }],
+            [258, { name: 'anyHeater', desc: 'Any Heater' }]
+        ]);
+    }
+    public initVirtualCircuits() {
+        for (let i = state.virtualCircuits.length - 1; i >= 0; i--) {
+            let vc = state.virtualCircuits.getItemByIndex(i);
+            if (vc.id > this.equipmentIds.virtualCircuits.end ||
+                vc.id < this.equipmentIds.virtualCircuits.start) state.virtualCircuits.removeItemByIndex(i);
+        }
+        // Now that we removed all the virtual circuits that should not be there we need
+        // to update them based upon the data.
+    }
+    public initValves(eq) {
+        if (typeof sys.valves.find((v) => v.id === 1) === 'undefined') {
+            let valve = sys.valves.getItemById(1, true);
+            valve.isIntake = false;
+            valve.isReturn = false;
+            valve.type = 0;
+            valve.master = 0;
+            valve.isActive = true;
+            valve.name = 'Valve A';
+            logger.info(`Initializing IntelliTouch Valve A`);
+
+        }
+        if (typeof sys.valves.find((v) => v.id === 2) === 'undefined') {
+            let valve = sys.valves.getItemById(1, true);
+            valve.isIntake = false;
+            valve.isReturn = false;
+            valve.type = 0;
+            valve.master = 0;
+            valve.isActive = true;
+            valve.name = 'Valve B';
+            logger.info(`Initializing IntelliTouch Valve B`);
+        }
+        if (eq.intakeReturnValves) {
+            logger.info(`Initializing IntelliTouch Intake/Return Valves`);
+            let valve = sys.valves.getItemById(3, true);
+            valve.isIntake = true;
+            valve.isReturn = false;
+            valve.circuit = 6;
+            valve.type = 0;
+            valve.master = 0;
+            valve.isActive = true;
+            valve.name = 'Intake';
+
+            valve = sys.valves.getItemById(4, true);
+            valve.isIntake = false;
+            valve.isReturn = true;
+            valve.circuit = 6;
+            valve.type = 0;
+            valve.master = 0;
+            valve.isActive = true;
+            valve.name = 'Return';
+        }
     }
     public initExpansionModules(byte1: number, byte2: number) {
         console.log(`Pentair IntelliTouch System Detected!`);
@@ -57,30 +132,30 @@ export class IntelliTouchBoard extends EasyTouchBoard {
         let eq = sys.equipment;
         let md = mod.get();
 
-        eq.maxBodies = md.bodies = typeof mt.bodies !== 'undefined' ? mt.bodies : mt.shared || mt.dual ? 2 : 1;
+        //eq.maxBodies = md.bodies = typeof mt.bodies !== 'undefined' ? mt.bodies : mt.shared || mt.dual ? 2 : 1;
+        // There are always 2 bodies on an IntelliTouch even the single body models.
+        eq.maxBodies = 2;
         eq.maxCircuits = md.circuits = typeof mt.circuits !== 'undefined' ? mt.circuits : 6;
         eq.maxFeatures = md.features = typeof mt.features !== 'undefined' ? mt.features : 8;
         eq.maxValves = md.valves = typeof mt.valves !== 'undefined' ? mt.valves : mt.shared ? 4 : 2;
         eq.maxPumps = md.maxPumps = typeof mt.pumps !== 'undefined' ? mt.pumps : 8;
         eq.shared = mt.shared;
         eq.dual = typeof mt.dual !== 'undefined' ? mt.dual : false;
-        eq.intakeReturnValves = md.intakeReturnValves = typeof mt.intakeReturnValves !== 'undefined' ? mt.intakeReturnValves : false;
+        eq.single = typeof mt.single !== 'undefined' ? mt.single : false;
+        eq.intakeReturnValves = eq.single ? false : true;
         eq.maxChlorinators = md.chlorinators = 1;
         eq.maxChemControllers = md.chemControllers = 1;
         eq.maxCustomNames = 20;
+        eq.maxSchedules = 99;
         eq.maxCircuitGroups = 10; // Not sure why this is 10 other than to allow for those that we are in control of.
-        if (!eq.shared && !eq.dual) {
+        if (eq.single) {
             // Replace the body types with Hi-Temp and Lo-Temp
             sys.board.valueMaps.bodyTypes.merge([[0, { name: 'pool', desc: 'Lo-Temp' }],
-            [1, { name: 'spa', desc: 'Hi-Temp' }]]);
+                [1, { name: 'spa', desc: 'Hi-Temp' }]]);
         }
         // Calculate out the invalid ids.
-        // sys.board.equipmentIds.invalidIds.set([]);
         // Add in all the invalid ids from the base personality board.
         sys.board.equipmentIds.invalidIds.set([16, 17, 18]); // These appear to alway be invalid in IntelliTouch.
-        // RGS 10-7-21: Since single bodies have hi-temp/lo-temp we will always want ID 1.
-        // if (!eq.shared) sys.board.equipmentIds.invalidIds.merge([1]);
-        //if (eq.maxCircuits < 9) sys.board.equipmentIds.invalidIds.merge([9]);
         for (let i = 7; i <= 10; i++) {
             // This will add all the invalid ids between 7 and 10 that are omitted for IntelliTouch models.
             // For instance an i7+3 can have up to 8 circuits since 1 and 6 are shared but an i7+3S will only have 7.
@@ -136,7 +211,6 @@ export class IntelliTouchBoard extends EasyTouchBoard {
         if (byte1 !== 14) sys.board.equipmentIds.invalidIds.merge([10, 19]);
         state.equipment.model = sys.equipment.model = mt.desc;
         state.equipment.controllerType = 'intellitouch';
-        sys.equipment.shared ? sys.board.equipmentIds.circuits.start = 1 : sys.board.equipmentIds.circuits.start = 2;
         this.initBodyDefaults();
         this.initHeaterDefaults();
         (async () => {
@@ -152,10 +226,22 @@ export class IntelliTouchBoard extends EasyTouchBoard {
             let v = sys.valves.getItemByIndex(i);
             if (v.id < 50) v.master = 0;
         }
-        for (let i = 0; i < sys.bodies.length; i++) {
-            let b = sys.bodies.getItemByIndex(i);
-            b.master = 0;
+        // Clean up any schedules that shouldn't be there.
+        for (let i = sys.schedules.length - 1; i > 0; i--) {
+            let sched = sys.schedules.getItemByIndex(i);
+            if (sched.id < 1) {
+                sys.schedules.removeItemByIndex(i);
+                state.schedules.removeItemById(sched.id);
+            }
+            if (sched.id < eq.maxSchedules) sched.master = 0;
+            else if (sched.id > eq.maxSchedules && (sched.master === 0 || typeof sched.master === 'undefined')) {
+                sys.schedules.removeItemByIndex(i);
+                state.schedules.removeItemById(sched.id);
+            }
         }
+        eq.setEquipmentIds();
+        this.initVirtualCircuits();
+        this.initValves(eq);
         state.equipment.maxBodies = sys.equipment.maxBodies;
         state.equipment.maxCircuitGroups = sys.equipment.maxCircuitGroups;
         state.equipment.maxCircuits = sys.equipment.maxCircuits;
@@ -165,9 +251,12 @@ export class IntelliTouchBoard extends EasyTouchBoard {
         state.equipment.maxPumps = sys.equipment.maxPumps;
         state.equipment.maxSchedules = sys.equipment.maxSchedules;
         state.equipment.maxValves = sys.equipment.maxValves;
+        state.equipment.single = sys.equipment.single;
         state.equipment.shared = sys.equipment.shared;
         state.equipment.dual = sys.equipment.dual;
+        
         state.emitControllerChange();
+
     }
     public circuits: ITTouchCircuitCommands = new ITTouchCircuitCommands(this);
     public async setControllerType(obj): Promise<Equipment> {
@@ -223,35 +312,57 @@ export class IntelliTouchBoard extends EasyTouchBoard {
             logger.error(`Error setting expansion panels: ${err.message}`);
         }
     }
+    public initBodyDefaults() {
+        // Initialize the bodies.  We will need these very soon.
+        for (let i = 1; i <= sys.equipment.maxBodies; i++) {
+            // Add in the bodies for the configuration.  These need to be set.
+            let cbody = sys.bodies.getItemById(i, true);
+            let tbody = state.temps.bodies.getItemById(i, true);
+            cbody.isActive = true;
+            // If the body doesn't represent a spa then we set the type.
+            tbody.type = cbody.type = i - 1;  // This will set the first body to pool/Lo-Temp and the second body to spa/Hi-Temp.
+            if (typeof cbody.name === 'undefined') {
+                let bt = sys.board.valueMaps.bodyTypes.transform(cbody.type);
+                tbody.name = cbody.name = bt.desc;
+            }
+        }
+        sys.bodies.removeItemById(3);
+        sys.bodies.removeItemById(4);
+        state.temps.bodies.removeItemById(3);
+        state.temps.bodies.removeItemById(4);
+        for (let i = 0; i < sys.bodies.length; i++) {
+            let b = sys.bodies.getItemByIndex(i);
+            b.master = 0;
+        }
+        sys.board.heaters.initTempSensors();
+        sys.general.options.clockMode = sys.general.options.clockMode || 12;
+        sys.general.options.clockSource = sys.general.options.clockSource || 'manual';
+    }
 }
 class ITTouchConfigQueue extends TouchConfigQueue {
     public queueChanges() {
         this.reset();
-        if (conn.mockPort) {
-            logger.info(`Skipping configuration request from OCP because MockPort enabled.`);
-        } else {
-            logger.info(`Requesting ${sys.controllerType} configuration`);
-            this.queueItems(GetTouchConfigCategories.dateTime, [0]);
-            this.queueItems(GetTouchConfigCategories.heatTemperature, [0]);
-            this.queueItems(GetTouchConfigCategories.solarHeatPump, [0]);
-            this.queueRange(GetTouchConfigCategories.customNames, 0, sys.equipment.maxCustomNames - 1);
-            this.queueRange(GetTouchConfigCategories.circuits, 1, sys.equipment.maxCircuits); // circuits
-            this.queueRange(GetTouchConfigCategories.circuits, 41, 41 + sys.equipment.maxFeatures); // features
-            this.queueRange(GetTouchConfigCategories.schedules, 1, sys.equipment.maxSchedules);
-            this.queueItems(GetTouchConfigCategories.delays, [0]);
-            this.queueItems(GetTouchConfigCategories.settings, [0]);
-            this.queueItems(GetTouchConfigCategories.intellifloSpaSideRemotes, [0]);
-            this.queueItems(GetTouchConfigCategories.is4is10, [0]);
-            this.queueItems(GetTouchConfigCategories.spaSideRemote, [0]);
-            this.queueItems(GetTouchConfigCategories.valves, [0]);
-            this.queueItems(GetTouchConfigCategories.lightGroupPositions);
-            this.queueItems(GetTouchConfigCategories.highSpeedCircuits, [0]);
-            this.queueRange(GetTouchConfigCategories.pumpConfig, 1, sys.equipment.maxPumps);
-            this.queueRange(GetTouchConfigCategories.circuitGroups, 0, sys.equipment.maxFeatures - 1);
-            // items not required by ScreenLogic
-            if (sys.chlorinators.getItemById(1).isActive)
-                this.queueItems(GetTouchConfigCategories.intellichlor, [0]);
-        }
+        logger.info(`Requesting ${sys.controllerType} configuration`);
+        this.queueItems(GetTouchConfigCategories.dateTime, [0]);
+        this.queueItems(GetTouchConfigCategories.heatTemperature, [0]);
+        this.queueItems(GetTouchConfigCategories.solarHeatPump, [0]);
+        this.queueRange(GetTouchConfigCategories.customNames, 0, sys.equipment.maxCustomNames - 1);
+        this.queueRange(GetTouchConfigCategories.circuits, 1, sys.equipment.maxCircuits); // circuits
+        this.queueRange(GetTouchConfigCategories.circuits, 41, 41 + sys.equipment.maxFeatures); // features
+        this.queueRange(GetTouchConfigCategories.schedules, 1, sys.equipment.maxSchedules);
+        this.queueItems(GetTouchConfigCategories.delays, [0]);
+        this.queueItems(GetTouchConfigCategories.settings, [0]);
+        this.queueItems(GetTouchConfigCategories.intellifloSpaSideRemotes, [0]);
+        this.queueItems(GetTouchConfigCategories.is4is10, [0]);
+        this.queueItems(GetTouchConfigCategories.quickTouchRemote, [0]);
+        this.queueItems(GetTouchConfigCategories.valves, [0]);
+        this.queueItems(GetTouchConfigCategories.lightGroupPositions);
+        this.queueItems(GetTouchConfigCategories.highSpeedCircuits, [0]);
+        this.queueRange(GetTouchConfigCategories.pumpConfig, 1, sys.equipment.maxPumps);
+        this.queueRange(GetTouchConfigCategories.circuitGroups, 0, sys.equipment.maxFeatures - 1);
+        // items not required by ScreenLogic
+        if (sys.chlorinators.getItemById(1).isActive)
+            this.queueItems(GetTouchConfigCategories.intellichlor, [0]);
         if (this.remainingItems > 0) {
             var self = this;
             setTimeout(() => { self.processNext(); }, 50);