nodejs-poolcontroller 7.3.1 → 7.6.1

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

@@ -34,5 +34,6 @@ export class SecurityMessage {
             role.flag2 = msg.extractPayloadByte(3);
             role.pin = msg.extractPayloadByte(21).toString() + msg.extractPayloadByte(22).toString() + msg.extractPayloadByte(23).toString() + msg.extractPayloadByte(24).toString();
         }
+        msg.isProcessed = true;
     }
 }

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

@@ -32,6 +32,7 @@ export class ValveMessage {
                         ValveMessage.processValveNames(msg);
                         break;
                     case 3: // Skip the secondary intake/return
+                        msg.isProcessed = true;
                         break;
                     case 4:
                     case 5:
@@ -70,6 +71,7 @@ export class ValveMessage {
         // [165,33,15,16,35,2],[132,0],[1,142]
         //                      ^^^ 128 = Pump off during valve operation
         sys.general.options.pumpDelay = msg.extractPayloadByte(0) >> 7 === 1;
+        msg.isProcessed = true;
     }
     private static process_ValveAssignment_IT(msg: Inbound) {
         // sample packet
@@ -91,6 +93,7 @@ export class ValveMessage {
                     let svalve = state.valves.getItemById(id, true);
                     svalve.name = valve.name;
                     svalve.type = valve.type;
+                    valve.master = 0;
                 }
                 else {
                     sys.valves.removeItemById(id);
@@ -110,6 +113,7 @@ export class ValveMessage {
                     let svalve = state.valves.getItemById(id, true);
                     svalve.name = valve.name;
                     svalve.type = valve.type;
+                    valve.master = 0;
                 }
                 else {
                     sys.valves.removeItemById(id);
@@ -136,17 +140,20 @@ export class ValveMessage {
                 let svalve = state.valves.getItemById(id, true);
                 svalve.name = valve.name;
                 svalve.type = valve.type;
+                valve.master = 0;
             }
             if (!valve.isActive) {
                 sys.valves.removeItemById(id);
                 state.valves.removeItemById(id);
             }
             else {
-                valve.isVirtual = false;
+                valve.master = 0;
+                // valve.isVirtual = false;
                 valve.type = 0;
             }
             id++;
         }
+        msg.isProcessed = true;
     }
     private static getName(id: number, cir: number) {
         if (cir <= 0 || cir >= 255 || cir === 6) {
@@ -167,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);
@@ -187,7 +194,8 @@ export class ValveMessage {
                 ndx += 2;
             }
             let valve: Valve = sys.valves.getItemById(id, true);
-            valve.isVirtual = false;
+            valve.master = 0;
+            // valve.isVirtual = false;
             if (id === 3 || id === 5) {
                 valve.circuit = 247; // Hardcode the intake/return to pool/spa;
                 valve.isIntake = true;
@@ -214,6 +222,7 @@ export class ValveMessage {
         }
         // Sort them so they are in valve id order.  This will ensure any OCP valves come first in the list.  Valves ids > 50 are virtual valves.
         sys.valves.sortById();
+        msg.isProcessed = true;
     }
     private static processValveNames(msg: Inbound) {
         let byte = msg.extractPayloadByte(1);
@@ -228,5 +237,6 @@ export class ValveMessage {
         if (typeof sys.valves.find(elem => elem.id === valveId) !== 'undefined') {
             state.valves.getItemById(valveId).name = sys.valves.getItemById(valveId++).name = msg.extractPayloadString(18, 16);
         }
+        msg.isProcessed = true;
     }
 }

package/controller/comms/messages/status/ChlorinatorStateMessage.ts

@@ -64,9 +64,8 @@ export class ChlorinatorStateMessage {
                     //[16, 2, 0, 3][0, 73, 110, 116, 101, 108, 108, 105, 99, 104, 108, 111, 114, 45, 45, 52, 48][188, 16, 3]
                     // This is the model number of the chlorinator and the address is actually the second byte.
                     let name = msg.extractPayloadString(1, 16);
-                    chlor.model = name;
-                    if (typeof chlor.name === 'undefined' || chlor.name === '') chlor.name = name;
-                    cstate.name = chlor.name;
+                    if (typeof chlor.name === 'undefined' || chlor.name === '') chlor.name = cstate.name = name;
+                    if (typeof chlor.model === 'undefined') chlor.model = sys.board.valueMaps.chlorinatorModel.getValue(name.toLowerCase()); 
                     cstate.isActive = chlor.isActive;
                     state.emitEquipmentChanges();
                     break;

package/controller/comms/messages/status/EquipmentStateMessage.ts

@@ -101,7 +101,9 @@ export class EquipmentStateMessage {
         Message.headerSubByte = msg.header[1];
         //console.log(process.memoryUsage());
         if (msg.action === 2 && state.isInitialized && sys.controllerType === ControllerType.Nixie) {
-            // Start over because we didn't have communication before but we now do.
+            // Start over because we didn't have communication before but we now do.  This will fall into the if
+            // below so that it goes through the intialization process.  In this case we didn't see an OCP when we started
+            // but there clearly is one now.
             sys.controllerType = ControllerType.Unknown;
             state.status = 0;
         }
@@ -139,19 +141,24 @@ export class EquipmentStateMessage {
 
                     // Shared
                     let dt = new Date();
-                    if (state.chemControllers.length > 0) {
-                        // TODO: move this to chemController when we understand the packets better
-                        for (let i = 0; i < state.chemControllers.length; i++) {
-                            let ccontroller = state.chemControllers.getItemByIndex(i);
-                            if (sys.board.valueMaps.chemControllerTypes.getName(ccontroller.type) === 'intellichem') {
-                                if (dt.getTime() - ccontroller.lastComm > 60000) ccontroller.status = 1;
-                            }
-                        }
-                    }
+                    // RKS: This was moved to the ChemControllerState message.  This is flawed in that it incorrectly sets IntelliChem to no comms.
+                    //if (state.chemControllers.length > 0) {
+                    //    // TODO: move this to chemController when we understand the packets better
+                    //    for (let i = 0; i < state.chemControllers.length; i++) {
+                    //        let ccontroller = state.chemControllers.getItemByIndex(i);
+                    //        if (sys.board.valueMaps.chemControllerTypes.getName(ccontroller.type) === 'intellichem') {
+                    //            if (dt.getTime() - ccontroller.lastComm > 60000) ccontroller.status = 1;
+                    //        }
+                    //    }
+                    //}
                     state.time.hours = msg.extractPayloadByte(0);
                     state.time.minutes = msg.extractPayloadByte(1);
                     state.time.seconds = dt.getSeconds();
-                    state.mode = msg.extractPayloadByte(9) & 0x81;
+                    state.mode = sys.controllerType !== ControllerType.IntelliCenter ? (msg.extractPayloadByte(9) & 0x81) : (msg.extractPayloadByte(9) & 0x01);
+
+                    // RKS: The units have been normalized for English and Metric for the overall panel.  It is important that the val numbers match for at least the temp units since
+                    // the only unit of measure native to the Touch controllers is temperature they chose to name these C or F.  However, with the njsPC extensions this is non-semantic
+                    // since pressure, volume, and length have been introduced.
                     sys.general.options.units = state.temps.units = msg.extractPayloadByte(9) & 0x04;
                     state.valve = msg.extractPayloadByte(10);
 
@@ -163,8 +170,8 @@ export class EquipmentStateMessage {
                     // 1. IntelliCenter has "manual" time set (Internet will automatically adjust) and autoAdjustDST is enabled
                     // 2. *Touch is "manual" (only option) and autoAdjustDST is enabled - (same as #1)
                     // 3. clock source is "server" isn't an OCP option but can be enabled on the clients 
-                    if (dt.getMinutes() % 5 === 0 && sys.general.options.clockSource === 'server') {
-                        if ((Math.abs(dt.getTime() - state.time.getTime()) > 60 * 5 * 1000) && !state.time.isUpdating) {
+                    if (dt.getMinutes() % 5 === 0 && dt.getSeconds() <= 10 && sys.general.options.clockSource === 'server') {
+                        if ((Math.abs(dt.getTime() - state.time.getTime()) > 60 * 2 * 1000) && !state.time.isUpdating) {
                             state.time.isUpdating = true;
                             sys.board.system.setDateTimeAsync({ dt, dst: sys.general.options.adjustDST || 0, })
                                 .then(() => {
@@ -197,10 +204,19 @@ export class EquipmentStateMessage {
                             tbody.name = cbody.name;
                             tbody.circuit = cbody.circuit = 6;
                             tbody.heatStatus = msg.extractPayloadByte(11) & 0x0F;
-                            if ((msg.extractPayloadByte(2) & 0x20) === 32) {
+                            // With the IntelliCenter i10D, bit 6 is not reliable.  It is not set properly and requires the 204 message
+                            // to process the data.
+                            if (!sys.equipment.dual) {
+                                if ((msg.extractPayloadByte(2) & 0x20) === 32) {
+                                    tbody.temp = state.temps.waterSensor1;
+                                    tbody.isOn = true;
+                                } else tbody.isOn = false;
+                            }
+                            else if (state.circuits.getItemById(6).isOn === true) {
                                 tbody.temp = state.temps.waterSensor1;
                                 tbody.isOn = true;
-                            } else tbody.isOn = false;
+                            }
+                            else tbody.isOn = false;
                         }
                         if (sys.bodies.length > 1) {
                             const tbody: BodyTempState = state.temps.bodies.getItemById(2, true);
@@ -210,10 +226,16 @@ export class EquipmentStateMessage {
                             tbody.name = cbody.name;
                             tbody.circuit = cbody.circuit = 1;
                             tbody.heatStatus = (msg.extractPayloadByte(11) & 0xF0) >> 4;
-                            if ((msg.extractPayloadByte(2) & 0x01) === 1) {
+                            if (!sys.equipment.dual) {
+                                if ((msg.extractPayloadByte(2) & 0x01) === 1) {
+                                    tbody.temp = sys.equipment.shared ? state.temps.waterSensor1 : state.temps.waterSensor2;
+                                    tbody.isOn = true;
+                                } else tbody.isOn = false;
+                            } else if (state.circuits.getItemById(1).isOn === true) {
                                 tbody.temp = sys.equipment.shared ? state.temps.waterSensor1 : state.temps.waterSensor2;
                                 tbody.isOn = true;
-                            } else tbody.isOn = false;
+                            }
+                            else tbody.isOn = false;
                         }
                         if (sys.bodies.length > 2) {
                             state.temps.waterSensor3 = fnTempFromByte(msg.extractPayloadByte(20));
@@ -390,13 +412,14 @@ export class EquipmentStateMessage {
                                 sys.board.circuits.syncCircuitRelayStates();
                                 sys.board.circuits.syncVirtualCircuitStates();
                                 sys.board.valves.syncValveStates();
+                                sys.board.filters.syncFilterStates();
                                 state.emitControllerChange();
                                 state.emitEquipmentChanges();
                                 sys.board.heaters.syncHeaterStates();
                                 break;
                             }
-                        case ControllerType.IntelliCom:
                         case ControllerType.EasyTouch:
+                        case ControllerType.IntelliCom:
                         case ControllerType.IntelliTouch:
                             {
                                 EquipmentStateMessage.processTouchCircuits(msg);
@@ -405,6 +428,7 @@ export class EquipmentStateMessage {
                                 sys.board.features.syncGroupStates();
                                 sys.board.circuits.syncVirtualCircuitStates();
                                 sys.board.valves.syncValveStates();
+                                sys.board.filters.syncFilterStates();
                                 state.emitControllerChange();
                                 state.emitEquipmentChanges();
                                 sys.board.heaters.syncHeaterStates();
@@ -495,8 +519,7 @@ export class EquipmentStateMessage {
                 state.time.date = msg.extractPayloadByte(6);
                 state.time.month = msg.extractPayloadByte(7);
                 state.time.year = msg.extractPayloadByte(8);
-                sys.equipment.controllerFirmware = (msg.extractPayloadByte(42)
-                    + (msg.extractPayloadByte(43) / 1000)).toString();
+                sys.equipment.controllerFirmware = (msg.extractPayloadByte(42) + (msg.extractPayloadByte(43) / 1000)).toString();
                 if (sys.chlorinators.length > 0) {
                     if (msg.extractPayloadByte(37, 255) !== 255) {
                         const chlor = state.chlorinators.getItemById(1);
@@ -508,9 +531,38 @@ export class EquipmentStateMessage {
                     }
                 }
                 ExternalMessage.processFeatureState(9, msg);
+                //if (sys.equipment.dual === true) {
+                //    // For IntelliCenter i10D the body state is on byte 26 of the 204.  This impacts circuit 6.
+                //    let byte = msg.extractPayloadByte(26);
+                //    let pstate = state.circuits.getItemById(6, true);
+                //    let oldstate = pstate.isOn;
+                //    pstate.isOn = ((byte & 0x0010) === 0x0010);
+                //    logger.info(`Checking i10D pool state ${byte} old:${oldstate} new: ${pstate.isOn}`);
+                //    //if (oldstate !== pstate.isOn) {
+                //        state.temps.bodies.getItemById(1, true).isOn = pstate.isOn;
+                //        sys.board.circuits.syncCircuitRelayStates();
+                //        sys.board.circuits.syncVirtualCircuitStates();
+                //        sys.board.valves.syncValveStates();
+                //        sys.board.filters.syncFilterStates();
+                //        sys.board.heaters.syncHeaterStates();
+                //    //}
+                //    if (oldstate !== pstate.isOn) pstate.emitEquipmentChange();
+                //}
+                // At this point normally on is ignored.  Not sure what this does.
+                let cover1 = sys.covers.getItemById(1);
+                let cover2 = sys.covers.getItemById(2);
+                if (cover1.isActive) {
+                    let scover1 = state.covers.getItemById(1, true);
+                    scover1.name = cover1.name;
+                    state.temps.bodies.getItemById(cover1.body + 1).isCovered = scover1.isClosed = (msg.extractPayloadByte(30) & 0x0001) > 0;
+                }
+                if (cover2.isActive) {
+                    let scover2 = state.covers.getItemById(2, true);
+                    scover2.name = cover2.name;
+                    state.temps.bodies.getItemById(cover2.body + 1).isCovered = scover2.isClosed = (msg.extractPayloadByte(30) & 0x0002) > 0;
+                }
                 msg.isProcessed = true;
-                // state.emitControllerChange();
-                // state.emitEquipmentChanges();
+                state.emitEquipmentChanges();
                 break;
         }
     }
@@ -528,13 +580,15 @@ export class EquipmentStateMessage {
                 let circuit = sys.circuits.getItemById(circuitId, false, { isActive: false });
                 if (circuit.isActive !== false) {
                     let cstate = state.circuits.getItemById(circuitId, circuit.isActive);
-                    let isOn = (byte & (1 << j)) > 0;
-                    sys.board.circuits.setEndTime(circuit, cstate, isOn);
+                    // For IntelliCenter i10D body circuits are not reported here.
+                    let isOn = ((circuitId === 6 || circuitId === 1) && sys.equipment.dual === true) ? cstate.isOn : (byte & (1 << j)) > 0;
+                    //let isOn = (byte & (1 << j)) > 0;
                     cstate.isOn = isOn;
                     cstate.name = circuit.name;
                     cstate.nameId = circuit.nameId;
                     cstate.showInFeatures = circuit.showInFeatures;
                     cstate.type = circuit.type;
+                    sys.board.circuits.setEndTime(circuit, cstate, isOn);
                     if (sys.controllerType === ControllerType.IntelliCenter) {
                         // intellitouch sends a separate msg with themes
                         switch (circuit.type) {
@@ -635,7 +689,7 @@ export class EquipmentStateMessage {
                         case 144: // swim
                             sys.board.circuits.sequenceLightGroupAsync(grp.id, 'swim');
                             break;
-                        case 160: // swim
+                        case 160: // set
                             sys.board.circuits.sequenceLightGroupAsync(grp.id, 'set');
                             break;
                         case 190: // save

package/controller/comms/messages/status/HeaterStateMessage.ts

@@ -1,54 +1,87 @@
-/*  nodejs-poolController.  An application to control pool equipment.
-Copyright (C) 2016, 2017, 2018, 2019, 2020.  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
-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
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-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 { Inbound, Protocol } from "../Messages";
-import { state, BodyTempState, HeaterState } from "../../../State";
-import { sys, ControllerType, Heater } from "../../../Equipment";
-
-export class HeaterStateMessage {
-    public static process(msg: Inbound) {
-        if (msg.protocol === Protocol.Heater) {
-            switch (msg.action) {
-                case 114: // This is a message from a master controlling the heater
-                    break;
-                case 115:
-                    HeaterStateMessage.processHeaterStatus(msg);
-                    break;
-            }
-        }
-    }
-    public static processHeaterStatus(msg: Inbound) {
-        // RKS: 07-03-21 - We only know byte 2 at this point for Ultratemp for the 115 message we are processing here.  The 
-        // byte  description
-        // ------------------------------------------------
-        // 0    Unknown
-        // 1    Unknown
-        // 2    Current heater status 0=off, 1=heat, 2=cool
-        // 3-9  Unknown
-        let heater: Heater = sys.heaters.getItemByAddress(msg.source);
-        let sheater = state.heaters.getItemById(heater.id);
-        // We need to decode the message.  For a 2 of
-        //[165, 1, 15, 16, 2, 29][16, 42, 3, 0, 0, 0, 0, 0, 0, 32, 0, 0, 2, 0, 88, 88, 0, 241, 95, 100, 24, 246, 0, 0, 0, 0, 0, 40, 0][4, 221]
-        //[165, 0, 112, 16, 114, 10][144, 0, 0, 0, 0, 0, 0, 0, 0, 0][2, 49] // OCP to Heater
-        //[165, 0, 16, 112, 115, 10][160, 1, 0, 3, 0, 0, 0, 0, 0, 0][2, 70] // Heater Reply
-        let byte = msg.extractPayloadByte(2);
-        sheater.isOn = byte >= 1;
-        sheater.isCooling = byte === 2;
-        sheater.commStatus = 0;
-        state.equipment.messages.removeItemByCode(`heater:${heater.id}:comms`);
-        msg.isProcessed = true;
-    }
+/*  nodejs-poolController.  An application to control pool equipment.
+Copyright (C) 2016, 2017, 2018, 2019, 2020.  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
+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
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+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 { Inbound, Protocol } from "../Messages";
+import { state, BodyTempState, HeaterState } from "../../../State";
+import { sys, ControllerType, Heater } from "../../../Equipment";
+
+export class HeaterStateMessage {
+    public static process(msg: Inbound) {
+        if (msg.protocol === Protocol.Heater) {
+            switch (msg.action) {
+                case 112: // This is a message from a master controlling MasterTemp
+                case 114: // This is a message from a master controlling UltraTemp
+                    msg.isProcessed = true;
+                    break;
+                case 116:
+                    HeaterStateMessage.processMasterTempStatus(msg);
+                    break;
+                case 115:
+                    HeaterStateMessage.processUltraTempStatus(msg);
+                    break;
+            }
+        }
+    }
+    public static processUltraTempStatus(msg: Inbound) {
+        // RKS: 07-03-21 - We only know byte 2 at this point for Ultratemp for the 115 message we are processing here.  The 
+        // byte  description
+        // ------------------------------------------------
+        // 0    Unknown (always seems to be 160 for response)
+        // 1    Unknown (always 1)
+        // 2    Current heater status 0=off, 1=heat, 2=cool
+        // 3-9  Unknown
+        
+        // 114 message - outbound response
+        //[165, 0, 112, 16, 114, 10][144, 0, 0, 0, 0, 0, 0, 0, 0, 0][2, 49] // OCP to Heater
+        // byte  description
+        // ------------------------------------------------
+        // 0    Unknown (always seems to be 144 for request)
+        // 1    Current heater status 0=off, 1=heat, 2=cool
+        // 3    Believed to be ofset temp
+        // 4-9  Unknown
+        
+        //   byto 0: always seems to be 144 for outbound
+        //   byte 1: Sets heater mode to 0 = Off 1 = Heat 2 = Cool
+        //[165, 0, 16, 112, 115, 10][160, 1, 0, 3, 0, 0, 0, 0, 0, 0][2, 70] // Heater Reply
+        let heater: Heater = sys.heaters.getItemByAddress(msg.source);
+        let sheater = state.heaters.getItemById(heater.id);
+        let byte = msg.extractPayloadByte(2);
+        sheater.isOn = byte >= 1;
+        sheater.isCooling = byte === 2;
+        sheater.commStatus = 0;
+        state.equipment.messages.removeItemByCode(`heater:${heater.id}:comms`);
+        msg.isProcessed = true;
+    }
+    public static processMasterTempStatus(msg: Inbound) {
+        //[255, 0, 255][165, 0, 16, 112, 116, 23][67, 0, 0, 0, 0, 0, 0, 0, 68, 0, 0, 0, 10, 0, 1, 0, 0, 0, 0, 0, 0, 0, 0][2, 66]
+        // Byte 1 is the indicator to which setpoint it is heating to.
+        // Byte 8 increments over time when the heater is on.
+        // Byte 13 looks like the mode the heater is in for instance it is in cooldown mode.
+        //  0 = Normal
+        //  2 = ??????
+        //  6 = Cooldown
+        // Byte 14 looks like the cooldown delay in minutes.
+        let heater: Heater = sys.heaters.getItemByAddress(msg.source);
+        let sheater = state.heaters.getItemById(heater.id);
+        let byte = msg.extractPayloadByte(1);
+        sheater.isOn = byte >= 1;
+        sheater.isCooling = false;
+        sheater.commStatus = 0;
+        state.equipment.messages.removeItemByCode(`heater:${heater.id}:comms`);
+        msg.isProcessed = true;
+    }
+
 }