nodejs-poolcontroller 7.5.1 → 7.7.0

package/controller/comms/messages/config/HeaterMessage.ts

@@ -64,6 +64,7 @@ export class HeaterMessage {
             case ControllerType.IntelliTouch:
             case ControllerType.EasyTouch:
                 HeaterMessage.processIntelliTouch(msg);
+                break;
         }
     }
     private static processIntelliTouch(msg: Inbound) {
@@ -71,8 +72,22 @@ export class HeaterMessage {
         // Gas heater setup in EquipmentStateMessage upon *Touch discovery
         switch (msg.action) {
             // 1 = gas heater, 2 = solar, 3 = heat pump
-            case 34:
-            case 162:
+            case 34:   // Somebody requested the configuration
+            case 162:  // Somebody set the configuration
+                // Release any heaters that are tied to Nixie that should not be.
+                for (let i = sys.heaters.length - 1; i >= 0; i--) {
+                    let heater = sys.heaters.getItemByIndex(i);
+                    if (heater.id <= 4 && heater.master === 1) {
+                        // Return the heater control back to Touch
+                        (async function () {
+                            try {
+                                await ncp.heaters.deleteHeaterAsync(heater.id);
+                                logger.debug(`${heater.name} control returned to OCP.`);
+                            }
+                            catch (err) { logger.error(`Error with OCP reclaiming control over gas ${heater.name}: ${err}`) }
+                        })();
+                    }
+                }
                 // byte 0
                 // 21 = solar or heat pump disabled
                 // 23 = solar or heat pump enabled
@@ -94,6 +109,121 @@ export class HeaterMessage {
                 //             on/off (16) = solar as a heat pump
                 // bits 7,8 = stop temp delta
 
+
+
+                // Determine what type of heater should be in id number 1.  If this is a hybrid heater
+                // we will be installing it in id 1 although it will perform dual purpose.
+                let hasHeater = (msg.extractPayloadByte(0) & 0x01) === 0x01 || true;
+                let hasSolar = (msg.extractPayloadByte(0) & 0x02) === 0x02;
+                let hasHeatpump = (msg.extractPayloadByte(1) & 0x20) === 0x20;
+                let hasHybrid = !hasHeatpump && (msg.extractPayloadByte(1) & 0x10) === 0x10;
+
+                // Ok so it appears that the heater ids are as follows.
+                // 1 = Gas Heater
+                // 2 = Solar
+                // 3 = UltraTemp (HEATPUMPCOM)
+                // 4 = UltraTemp ETi (Hybrid)
+                // If an UltraTemp ETi is installed, no other heaters can be installed so they should be removed.  This is not
+                // an available option for IntelliTouch i10D so it does not apply to it.
+                if (!hasHeater) {
+                    sys.heaters.removeItemById(1);
+                    state.heaters.removeItemById(1);
+                    sys.heaters.removeItemById(2);
+                    state.heaters.removeItemById(2);
+                    sys.heaters.removeItemById(3);
+                    state.heaters.removeItemById(3);
+                    sys.heaters.removeItemById(4);
+                    state.heaters.removeItemById(4);
+                }
+                else {
+                    if (hasHybrid) {
+                        sys.heaters.removeItemById(1);
+                        state.heaters.removeItemById(1);
+                        sys.heaters.removeItemById(2);
+                        state.heaters.removeItemById(2);
+                        sys.heaters.removeItemById(3);
+                        state.heaters.removeItemById(3);
+                        let hybrid = sys.heaters.getItemById(4, true);
+                        let shybrid = state.heaters.getItemById(4, true);
+                        // [5, { name: 'hybrid', desc: 'Hybrid', hasAddress: true }],
+                        shybrid.type = hybrid.type = 5;
+                        hybrid.address = 112; // Touch only supports address 1.
+                        hybrid.isActive = true;
+                        hybrid.master = 0;
+                        hybrid.body = sys.equipment.shared ? 32 : 0;
+                        if (typeof hybrid.name === 'undefined') shybrid.name = hybrid.name = 'UltraTemp ETi';
+                        // The following 2 values need to come from somewhere.
+                        if (typeof hybrid.economyTime === 'undefined') hybrid.economyTime = 1;
+                        if (typeof hybrid.maxBoostTemp === 'undefined') hybrid.maxBoostTemp = 5;
+                        hasHeatpump = false; // You cannot have a heatpump and a hybrid heater.
+                    }
+                    else {
+                        // Hybrid heaters and gas heaters cannot co-exist but it appears you cannot disable the gas
+                        // heater on the touch panels.
+                        sys.heaters.removeItemById(4);
+                        state.heaters.removeItemById(4);
+                        let heater = sys.heaters.getItemById(1, true);
+                        let hstate = state.heaters.getItemById(1, true);
+                        heater.body = sys.equipment.shared ? 32 : 0;
+                        // [1, { name: 'gas', desc: 'Gas Heater', hasAddress: false }],
+                        heater.type = hstate.type = 1;
+                        heater.isActive = true;
+                        heater.master = 0;
+                        if (typeof heater.name === 'undefined') heater.name = hstate.name = 'Gas Heater';
+                        if (typeof heater.cooldownDelay === 'undefined') heater.cooldownDelay = 5;
+                    }
+                    // Check to see if a heatpump is installed.  This will replace the solar heater so they cannot coexist.
+                    if (hasHeatpump) {
+                        // Remove the solar heater.  This will be replaced with the heatpump.
+                        sys.heaters.removeItemById(2);
+                        state.heaters.removeItemById(2);
+                        let heatpump = sys.heaters.getItemById(3, true);
+                        let sheatpump = state.heaters.getItemById(3, true);
+                        // [3, { name: 'heatpump', desc: 'Heat Pump', hasAddress: true, hasPreference: true }],
+                        heatpump.type = sheatpump.type = 3;
+                        heatpump.body = sys.equipment.shared ? 32 : 0;
+                        heatpump.isActive = true;
+                        heatpump.master = 0;
+
+                        if (typeof heatpump.name === 'undefined') sheatpump.name = heatpump.name = 'UltraTemp';
+                        heatpump.heatingEnabled = (msg.extractPayloadByte(1) & 0x01) === 1;
+                        heatpump.coolingEnabled = (msg.extractPayloadByte(1) & 0x02) === 2;
+                        sys.board.equipmentIds.invalidIds.add(20); // exclude Aux Extra
+                    }
+                    else if (hasSolar) {
+                        sys.heaters.removeItemById(3);
+                        state.heaters.removeItemById(3);
+                        let solar = sys.heaters.getItemById(2, true);
+                        let ssolar = sys.heaters.getItemById(2, true);
+                        // [2, { name: 'solar', desc: 'Solar Heater', hasAddress: false, hasPreference: true }],
+                        solar.type = ssolar.type = 2;
+                        solar.body = sys.equipment.shared ? 32 : 0;
+                        solar.isActive = true;
+                        solar.master = 0;
+                        if (typeof solar.name === 'undefined') solar.name = ssolar.name = 'Solar Heater';
+                        solar.freeze = (msg.extractPayloadByte(1) & 0x80) >> 7 === 1;
+                        solar.coolingEnabled = (msg.extractPayloadByte(1) & 0x20) >> 5 === 1;
+                        solar.startTempDelta = ((msg.extractPayloadByte(2) & 0xE) >> 1) + 3;
+                        solar.stopTempDelta = ((msg.extractPayloadByte(2) & 0xC0) >> 6) + 2;
+                        sys.board.equipmentIds.invalidIds.add(20); // exclude Aux Extra
+                    }
+                    else {
+                        sys.board.equipmentIds.invalidIds.remove(20); // Allow access to Aux Extra
+                    }
+                }
+                sys.board.heaters.updateHeaterServices();
+                for (let i = 0; i < sys.bodies.length; i++) {
+                    let body = sys.bodies.getItemByIndex(i);
+                    let btemp = state.temps.bodies.getItemById(body.id, body.isActive !== false);
+                    let opts = sys.board.heaters.getInstalledHeaterTypes(body.id);
+                    btemp.heaterOptions = opts;
+                }
+                sys.board.heaters.syncHeaterStates();
+                sys.equipment.setEquipmentIds();
+                msg.isProcessed = true;
+
+
+                /*
                 // gas heater only; solar/heatpump/ultratemp disabled
                 if ((msg.extractPayloadByte(0) & 0x2) === 0) {
                     let heater = sys.heaters.getItemById(1);
@@ -112,14 +242,14 @@ export class HeaterMessage {
                     sys.heaters.getItemById(3).isActive = false;
                     sys.heaters.getItemById(4).isActive = false;
                     sys.board.equipmentIds.invalidIds.remove(20); // include Aux Extra
-/*                     sys.equipment.setEquipmentIds();
-                    for (let i = 0; i < sys.bodies.length; i++) {
-                        let body = sys.bodies.getItemByIndex(i);
-                        let btemp = state.temps.bodies.getItemById(body.id, body.isActive !== false);
-                        let opts = sys.board.heaters.getInstalledHeaterTypes(body.id);
-                        btemp.heaterOptions = opts;
-                    }
-                    return; */
+                    //sys.equipment.setEquipmentIds();
+                    //for (let i = 0; i < sys.bodies.length; i++) {
+                    //    let body = sys.bodies.getItemByIndex(i);
+                    //    let btemp = state.temps.bodies.getItemById(body.id, body.isActive !== false);
+                    //    let opts = sys.board.heaters.getInstalledHeaterTypes(body.id);
+                    //    btemp.heaterOptions = opts;
+                    //}
+                    return;
                 }
                 // Ultratemp (+ cooling?); 
                 else if ((msg.extractPayloadByte(2) & 0x30) === 0x30) {
@@ -220,27 +350,9 @@ export class HeaterMessage {
                 sys.board.heaters.syncHeaterStates();
                 sys.equipment.setEquipmentIds();
                 msg.isProcessed = true;
+                */
                 break;
-            case 168:
-                {
-                    // IntelliChem Installed
-                    if ((msg.extractPayloadByte(3) & 0x01) === 1) {
-                        // only support for 1 ic with EasyTouch
-                        let chem = sys.chemControllers.getItemByAddress(144, true);
-                        let schem = state.chemControllers.getItemById(chem.id, true);
-                        chem.ph.tank.capacity = chem.orp.tank.capacity = 6;
-                        chem.ph.tank.units = chem.orp.tank.units = '';
 
-                    }
-                    else {
-                        let chem = sys.chemControllers.getItemByAddress(144);
-                        state.chemControllers.removeItemById(chem.id);
-                        sys.chemControllers.removeItemById(chem.id);
-                    }
-                    // Spa Manual Heat on/off
-                    sys.general.options.manualHeat = msg.extractPayloadByte(4) === 1 ? true : false;
-                    msg.isProcessed = true;
-                }
         }
     }
     private static processCooldownDelay(msg: Inbound) {

package/controller/comms/messages/config/OptionsMessage.ts

@@ -139,16 +139,22 @@ export class OptionsMessage {
                 break;
             }
             case 40:
+            case 168:    
+            {
+
                 // [165,33,16,34,168,10],[0,0,0,254,0,0,0,0,0,0],[2,168 = manual heat mode off
                 // [165,33,16,34,168,10],[0,0,0,254,1,0,0,0,0,0],[2,169] = manual heat mode on
                 sys.general.options.manualHeat = msg.extractPayloadByte(4) === 1;
+                // From https://github.com/tagyoureit/nodejs-poolController/issues/362 = Intellitouch
+                // [0,0,0,0,1,x,0,0,0,0]  x=0 Manual OP heat Off; x=1 Manual OP heat On 
+                sys.general.options.manualPriority = msg.extractPayloadByte(5) === 1;
                 if ((msg.extractPayloadByte(3) & 0x01) === 1) {
                     // only support for 1 ic with EasyTouch
                     let chem = sys.chemControllers.getItemByAddress(144, true);
-                    let schem = state.chemControllers.getItemById(chem.id, true);
+                    //let schem = state.chemControllers.getItemById(chem.id, true);
                     chem.ph.tank.capacity = chem.orp.tank.capacity = 6;
                     chem.ph.tank.units = chem.orp.tank.units = '';
-
+                    
                 }
                 else {
                     let chem = sys.chemControllers.getItemByAddress(144);
@@ -157,6 +163,7 @@ export class OptionsMessage {
                 }
                 msg.isProcessed = true;
                 break;
+            }
         }
     }
 }

package/controller/comms/messages/config/PumpMessage.ts

@@ -36,43 +36,60 @@ export class PumpMessage {
         // packet 24/27/152/155 - Pump Config: IntelliTouch
         const pumpId = msg.extractPayloadByte(0);
         let type = msg.extractPayloadByte(1);  // Avoid setting this then setting it back if we are mapping to a different value.
+        let isActive = type !== 0 && pumpId <= sys.equipment.maxPumps;
         // RKS: 04-14-21 - Only create the pump if it is available.  If the pump was previously defined as another type
         // then it will be removed and recreated.
-        let pump: Pump = sys.pumps.getItemById(pumpId, pumpId <= sys.equipment.maxPumps && type !== 0);
-        if (pump.type !== type && type !== 0) {
-            sys.pumps.removeItemById(pumpId);
-            pump = sys.pumps.getItemById(pumpId, true);
-        }
-        pump.address = pumpId + 95;
-        switch (type) {
-            case 0: // none
-                pump.type = 0;
-                pump.isActive = false;
-                break;
-            case 64: // vsf
-                pump.type = type;
-                pump.isActive = true;
-                PumpMessage.processVSF_IT(msg);
-                break;
-            case 255: // vs 3050 on old panels.
-            case 128: // vs
-            case 134: // vs Ultra Efficiency
-                pump.type = 128;
-                pump.isActive = true;
-                PumpMessage.processVS_IT(msg);
-                break;
-            case 169: // vs+svrs
-                pump.type = 169;
-                pump.isActive = true;
-                PumpMessage.processVS_IT(msg);
-                break;
-            default: // vf - type is the background circuit
-                pump.type = 1; // force to type 1?
-                pump.isActive = true;
-                PumpMessage.processVF_IT(msg);
-                break;
-        }
-        if (pump.isActive) {
+        let pump: Pump = sys.pumps.getItemById(pumpId, isActive);
+        if(isActive) {
+            // Remap the combination pump types.
+            switch (type) {
+                case 0:
+                case 64:
+                case 169:
+                    break;
+                case 255:
+                case 128:
+                case 134:
+                    type = 128;
+                    break;
+                default:
+                    type = 1;
+                    break;
+            }
+            if (pump.type !== type) {
+                sys.pumps.removeItemById(pumpId);
+                pump = sys.pumps.getItemById(pumpId, isActive);
+            }
+            pump.address = pumpId + 95;
+            pump.master = 0;
+            switch (type) {
+                case 0: // none
+                    pump.type = 0;
+                    pump.isActive = false;
+                    break;
+                case 64: // vsf
+                    pump.type = type;
+                    pump.isActive = true;
+                    PumpMessage.processVSF_IT(msg);
+                    break;
+                case 255: // vs 3050 on old panels.
+                case 128: // vs
+                case 134: // vs Ultra Efficiency
+                    pump.type = 128;
+                    pump.isActive = true;
+                    PumpMessage.processVS_IT(msg);
+                    break;
+                case 169: // vs+svrs
+                    pump.type = 169;
+                    pump.isActive = true;
+                    PumpMessage.processVS_IT(msg);
+                    break;
+                default: // vf - type is the background circuit
+                    pump.type = 1; // force to type 1?
+                    pump.isActive = true;
+                    PumpMessage.processVF_IT(msg);
+                    break;
+            }
             if (typeof pump.name === 'undefined') pump.name = sys.board.valueMaps.pumpTypes.get(pump.type).desc;
             const spump = state.pumps.getItemById(pump.id, true);
             spump.name = pump.name;
@@ -224,6 +241,7 @@ export class PumpMessage {
                 }
                 if (typeof pump.model === 'undefined') pump.model = 0;
                 pump.type = type;
+                pump.master = 0;
                 let spump = state.pumps.getItemById(pump.id, true);
                 spump.type = pump.type;
                 spump.isActive = pump.isActive = true;

package/controller/comms/messages/config/ScheduleMessage.ts

@@ -48,10 +48,10 @@ export class ScheduleMessage {
                 case 6:
                     ScheduleMessage.processCircuit(msg);
                     break;
-                case 8: // Run Once Flags
+                case 8: // Schedule Type
                 case 9:
                 case 10:
-                    ScheduleMessage.processRunOnce(msg);
+                    ScheduleMessage.processScheduleType(msg);
                     break;
                 case 11:
                 case 12:
@@ -127,6 +127,7 @@ export class ScheduleMessage {
                 const schedule: Schedule = sys.schedules.getItemByIndex(i);
                 if (schedule.scheduleType === sys.board.valueMaps.scheduleTypes.getValue('runonce') && schedule.circuit === eggTimer.circuit){
                     const sstate = state.schedules.getItemById(schedule.id);
+                    schedule.master = 0;
                     sstate.endTime = schedule.endTime = (schedule.startTime + eggTimer.runTime) % 1440; // remove days if we go past midnight                   
                 }
             }
@@ -150,6 +151,7 @@ export class ScheduleMessage {
             if (sys.circuits.getItemById(schedule.circuit).hasHeatSource && typeof schedule.heatSource === 'undefined') schedule.heatSource = sys.board.valueMaps.heatSources.getValue('nochange');
             // todo: add to base sched item
             //  (msg.extractPayloadByte(1) & 128) === 1 ? schedule.smartStart = 1 : schedule.smartStart = 0;
+            schedule.master = 0;
             if (schedule.isActive) {
                 const sstate = state.schedules.getItemById(schedule.id, true);
                 sstate.circuit = schedule.circuit;
@@ -191,7 +193,7 @@ export class ScheduleMessage {
     }
     private static processStartDay(msg: Inbound) {
         let schedId = (msg.extractPayloadByte(1) - 17) * 40 + 1;
-        for (let i = 1; i < msg.payload.length; i++) {
+        for (let i = 1; i < msg.payload.length && schedId <= ScheduleMessage._maxSchedId; i++) {
             const schedule: Schedule = sys.schedules.getItemById(schedId++, false, { isActive: false });
             if (schedule.isActive !== false) {
                 schedule.startDay = msg.extractPayloadByte(i + 1);
@@ -203,7 +205,7 @@ export class ScheduleMessage {
     }
     private static processStartYear(msg: Inbound) {
         let schedId = (msg.extractPayloadByte(1) - 20) * 40 + 1;
-        for (let i = 1; i < msg.payload.length; i++) {
+        for (let i = 1; i < msg.payload.length && schedId <= ScheduleMessage._maxSchedId; i++) {
             const schedule: Schedule = sys.schedules.getItemById(schedId++, false, { isActive: false });
             if (schedule.isActive !== false) {
                 schedule.startYear = msg.extractPayloadByte(i + 1);
@@ -213,22 +215,15 @@ export class ScheduleMessage {
     }
     private static processStartTimes(msg: Inbound) {
         let schedId = msg.extractPayloadByte(1) * 20 + 1;
-        for (let i = 1; i < msg.payload.length - 1;) {
-            let time = msg.extractPayloadInt(i + 1);
-            let schedule: Schedule = sys.schedules.getItemById(schedId++, time !== 0);
-            if (time !== 0) {
-                schedule.startTime = time;
-                schedule.isActive = schedule.startTime !== 0;
+        for (let i = 1; i < msg.payload.length - 1 && schedId <= ScheduleMessage._maxSchedId;) {
+            let schedule: Schedule = sys.schedules.getItemById(schedId++, false, { isActive: false });
+            if (schedule.isActive) {
+                schedule.startTime = msg.extractPayloadInt(i + 1);
                 let csched = state.schedules.getItemById(schedule.id, true);
                 csched.startTime = schedule.startTime;
             }
-            else {
-                state.schedules.removeItemById(schedule.id);
-                sys.schedules.removeItemById(schedule.id);
-            }
             i += 2;
         }
-        ScheduleMessage._maxSchedId = sys.schedules.getMaxId(true, 0);
         msg.isProcessed = true;
     }
     private static processEndTimes(msg: Inbound) {
@@ -238,7 +233,7 @@ export class ScheduleMessage {
             const schedule: Schedule = sys.schedules.getItemById(schedId++, false, { isActive: false });
             if (schedule.isActive !== false) {
                 schedule.endTime = time;
-                let csched = state.schedules.getItemById(schedule.id);
+                let csched = state.schedules.getItemById(schedule.id, true);
                 csched.endTime = schedule.endTime;
             }
             i += 2;
@@ -250,11 +245,10 @@ export class ScheduleMessage {
         for (let i = 1; i < msg.payload.length && schedId <= ScheduleMessage._maxSchedId; i++) {
             let schedule: Schedule = sys.schedules.getItemById(schedId++, false, { isActive: false });
             if (schedule.isActive) {
-                let csched = state.schedules.getItemById(schedule.id);
+                let csched = state.schedules.getItemById(schedule.id, true);
                 schedule.circuit = msg.extractPayloadByte(i + 1) + 1;
                 if (schedule.circuit === 256 || schedule.circuit === 0) {
-                    // This is some of the IntelliCenter craziness where the schedule has a start time but
-                    // the circuit is undefined.
+                    // This is some of the IntelliCenter craziness where the schedule is marked as active but the circuit is not defined.
                     csched.isActive = false;
                     state.schedules.removeItemById(schedule.id);
                     sys.schedules.removeItemById(schedule.id);
@@ -265,13 +259,16 @@ export class ScheduleMessage {
         }
         msg.isProcessed = true;
     }
-    private static processRunOnce(msg: Inbound) {
+    private static processScheduleType(msg: Inbound) {
         let schedId = (msg.extractPayloadByte(1) - 8) * 40 + 1;
-        for (let i = 1; i < msg.payload.length && schedId <= ScheduleMessage._maxSchedId; i++) {
-            let schedule: Schedule = sys.schedules.getItemById(schedId++, false, { isActive: false });
-            if (schedule.isActive !== false) {
-                let byte = msg.extractPayloadByte(i + 1);
-                // schedule.runOnce = byte;
+        for (let i = 1; i < msg.payload.length; i++) {
+            let byte = msg.extractPayloadByte(i + 1);
+            let schedule: Schedule = sys.schedules.getItemById(schedId++, (byte & 128) === 128);
+            if ((byte & 128) === 128) {
+                // If bit 8 is set on the time type then this indicates whether the schedule is active.  If it is not
+                // active then we will be removing it.
+                schedule.isActive = true;
+                schedule.master = 0;
                 schedule.scheduleType = (byte & 1 & 0xFF) === 1 ? 0 : 128;
                 if ((byte & 4 & 0xFF) === 4) schedule.startTimeType = 1;
                 else if ((byte & 8 & 0xFF) === 8) schedule.startTimeType = 2;
@@ -281,11 +278,22 @@ export class ScheduleMessage {
                 else if ((byte & 32 & 0xFF) === 32) schedule.endTimeType = 2;
                 else schedule.endTimeType = 0;
                 let csched = state.schedules.getItemById(schedule.id);
+                csched.isActive = true;
                 csched.startTimeType = schedule.startTimeType;
                 csched.endTimeType = schedule.endTimeType;
                 csched.scheduleType = schedule.scheduleType;
             }
+            else {
+                // Now we need to remove this pig because this is not an active schedule.
+                sys.schedules.removeItemById(schedule.id);
+                if (schedule.isActive) {
+                    let csched = state.schedules.getItemById(schedule.id);
+                    schedule.isActive = csched.isActive = false;
+                }
+                state.schedules.removeItemById(schedule.id);
+            }
         }
+        ScheduleMessage._maxSchedId = sys.schedules.getMaxId(true, 0);
         msg.isProcessed = true;
     }
     private static processDays(msg: Inbound) {

package/controller/comms/messages/config/ValveMessage.ts

@@ -131,7 +131,7 @@ export class ValveMessage {
                 // there is no circuit.  The circuitry for the valve always exists although I am not sure
                 // how the valve expansion is represented.
                 valve.isActive = true;
-                valve.isReturn = false; 
+                valve.isReturn = false;
                 valve.isIntake = false;
                 valve.type = 0;
                 // Allow users to name the valve whatever they want.  *Touch apparently only allows the valve to be named the same
@@ -174,7 +174,7 @@ export class ValveMessage {
         // for i10d.
         let ndx: number = 2;
         let id = 1;
-        for (let i = 0; i < sys.equipment.maxValves - 1; i++) {
+        for (let i = 0; i < sys.equipment.maxValves; i++) {
             if (id === 3 && !sys.equipment.shared) {
                 // The intake/return valves are skipped for non-shared systems.
                 sys.valves.removeItemById(3);