nodejs-poolcontroller 7.6.1 → 7.7.0

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

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

@@ -21,13 +21,19 @@ import { sys, ControllerType, Chlorinator } from "../../../Equipment";
 export class ChlorinatorStateMessage {
     public static process(msg: Inbound) {
         if (msg.protocol === Protocol.Chlorinator) {
-            let chlor: Chlorinator;
-            let cstate: ChlorinatorState;
-            
+            // RKS: 03-29-22 A lot of water has gone under the bridge at this point and we know much more.  First there are two types of messages.  Those inbound
+            // messages that are being sent to the chlorinator as commands and responses from the chlorinator.  We have also determined that the chlorinator does
+            // not actually support a RS485 address.  So njsPC can declare as many ports as required to communicate with multiple chlorinators.
+            //
+            // So instead of matching the chlorinator up with a specific id we need to match on the port as well for the inbound message.  OCPs always operate on
+            // portId = 0.  If the portId is > 0 then it is considered an Aux port.  At this point you can only control 1 chlorinator per port so in order to
+            // control more than one chlorinator there needs to be only one chlorinator on each port.            
+            let chlor: Chlorinator = sys.chlorinators.findItemByPortId(msg.portId || 0);
+            if (typeof chlor === 'undefined' || chlor.isActive === false) return; // Bail out of here if we don't find an active chlorinator.
+            let cstate: ChlorinatorState = state.chlorinators.getItemById(chlor.id, true);
             if (msg.dest >= 1 && msg.dest <= 4) {
-                // RKS: The dest for these message are 80+ in raw terms.  The msg object translates these into 1-4 for the installed chlorinators.  This message
-                // is from the OCP to the chlorinator.
-                cstate = state.chlorinators.getItemById(msg.dest, true);
+                // RKS: This message is from the OCP to the chlorinator.  NOTE: We will not see these messages when the communication is coming from njsPC on any
+                // comms port.  The processing for no comms is done in the Nixe control when the message is sent.
                 if (typeof cstate.lastComm === 'undefined') cstate.lastComm = new Date(1970, 0, 1, 0, 0, 0, 0).getTime();
                 // RG: I was getting some time deltas of 25-30s and bumped this up
                 else if (cstate.lastComm + (30 * 1000) < new Date().getTime()) {
@@ -35,27 +41,24 @@ export class ChlorinatorStateMessage {
                     cstate.status = 128;
                 }
                 chlor = sys.chlorinators.getItemById(msg.dest, true);
-                chlor.address = msg.dest + 79;
+                chlor.address = msg.dest + 79; // Theoretically, this will always be 80.
                 if (typeof chlor.isActive === 'undefined') cstate.isActive = chlor.isActive = true;
             }
             else {
-                // Message from chlorinator
-                cstate = state.chlorinators.getItemById(msg.dest + 1, true);
-                chlor = sys.chlorinators.getItemById(msg.dest + 1, true);
+                // Response message from chlorinator.  If the chlorinator is speaking to us then we need to hear it and clear the status when
+                // the previous status was no comms.
                 cstate.lastComm = new Date().getTime();
                 if (cstate.status === 128) cstate.status = 0;
             }
             cstate.body = chlor.body;
             switch (msg.action) {
-                case 0: // request status (0): [16,2,80,0][0][98,16,3]
+                case 0: // Set control OCP->Chlorinator: [16,2,80,0][0][98,16,3]
                     break;
-                case 1: // response to request status: [16,2,0,1][0,0][19,16,3]
-                    {
-                        // let chlor = sys.chlorinators.getItemById(1, true);
-                        // chlor.isActive = true;
-                        break;
-                    }
-                case 3: {
+                case 1: // Ack control Chlorinator->OCP response: [16,2,0,1][0,0][19,16,3]
+                    // let chlor = sys.chlorinators.getItemById(1, true);
+                    // chlor.isActive = true;
+                    break;
+                case 3: // Chlorinator->OCP response for Get Model: [16,2,0,3][0,73,110,116,101,108,108,105,99,104,108,111,114,45,45,52,48][188,16,3]
                     // RKS: 07-16-20 -- It appears that this message doesn't always come.  It is very likely that the newer versions of IntelliChlor
                     // do not respond to the 20 message.  There have been multiple instances of this with recent versions of IntelliChlor. As a result,
                     // don't overwrite the name should the user set it.
@@ -65,12 +68,11 @@ export class ChlorinatorStateMessage {
                     // This is the model number of the chlorinator and the address is actually the second byte.
                     let name = msg.extractPayloadString(1, 16);
                     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()); 
+                    if (typeof chlor.model === 'undefined') chlor.model = sys.board.valueMaps.chlorinatorModel.getValue(name.toLowerCase());
                     cstate.isActive = chlor.isActive;
                     state.emitEquipmentChanges();
                     break;
-                }
-                case 17: {
+                case 17: // OCP->Chlorinator set output. [16,2,80,17][15][130,16,3]
                     // If the chlorinator is no longer talking to us then clear the current output.
                     if (cstate.status === 128) cstate.currentOutput = 0;
                     cstate.targetOutput = msg.extractPayloadByte(0);
@@ -78,13 +80,16 @@ export class ChlorinatorStateMessage {
                         // Some dumbass is trying to change our output.  We need to set it back to 0.
                         sys.board.chlorinator.setChlorAsync({ id: chlor.id, disabled: chlor.disabled, superChlor: false, superChlorHours: 0 });
                     }
-                    else if (chlor.isDosing && cstate.targetOutput !== 100){
+                    else if (chlor.isDosing && cstate.targetOutput !== 100) {
                         sys.board.chlorinator.setChlorAsync({ id: chlor.id, isDosing: chlor.isDosing });
                     }
                     state.emitEquipmentChanges();
                     break;
-                }
-                case 21: {
+                case 21: // Set output OCP->Chlorinator [16,2,80,21][0][119,16,3]
+                    // RKS: 03-29-22 There is something absolutley wrong about the understanding of this message.  It has to do with the fact that you could never set
+                    // the output percentage to anything greater than 25.6% if this were the case.  I assume this has something to do with the
+                    // way IntelliChlor works.  Values between 0 and 20% can be fractional.  In this case the OCP would send a 21 instead of a 17 with
+                    // the fractional value.  Anything above that value will be sent in a 17 message.
                     // Set Cell Output / 10
                     // This packet is coming through differently on the IntelliConnect.
                     // eg 13:42:31.304 VERBOSE Msg# 1531   Controller --> Salt cell: Set current output to 1.6 %: 16,2,80,21,0,119,16,3
@@ -95,34 +100,31 @@ export class ChlorinatorStateMessage {
                         // Some dumbass is trying to change our output.  We need to set it back to 0.
                         sys.board.chlorinator.setChlorAsync({ id: chlor.id, disabled: chlor.disabled, superChlor: false, superChlorHours: 0 });
                     }
-                    else if (chlor.isDosing && cstate.targetOutput !== 100){
+                    else if (chlor.isDosing && cstate.targetOutput !== 100) {
                         sys.board.chlorinator.setChlorAsync({ id: chlor.id, isDosing: chlor.isDosing });
                     }
                     state.emitEquipmentChanges();
                     break;
-                }
-                case 18: {
+                case 18:
                     // Response to Set Salt Output (17 & 20)
                     // The most common failure with IntelliChlor is that the salt level stops reporting.  Below should allow it to be fed from an alternate
                     // source like REM.
-                    if(!chlor.ignoreSaltReading) cstate.saltLevel = msg.extractPayloadByte(0) * 50 || cstate.saltLevel || 0;
+                    if (!chlor.ignoreSaltReading) cstate.saltLevel = msg.extractPayloadByte(0) * 50 || cstate.saltLevel || 0;
                     cstate.status = (msg.extractPayloadByte(1) & 0x007F); // Strip off the high bit.  The chlorinator does not actually report this. 
                     cstate.currentOutput = chlor.disabled ? 0 : cstate.setPointForCurrentBody;
                     state.emitEquipmentChanges();
                     break;
-                }
-                case 19: {
+                case 19:
                     // This is an iChlor message with no payload.  Perhaps simply a keep alive for the iChlor.
                     // [16, 2, 80, 19][117, 16, 3]
                     break;
-                }
-                case 20: {
-                    // Get version
-                    chlor.type = cstate.type = msg.extractPayloadByte(0);
+                case 20:
+                    // OCP->Chlorinator Get model [16,2,80,20][0][118,16,3]
+                    if (typeof chlor.type === 'undefined') chlor.type = msg.extractPayloadByte(0);
+                    cstate.type = chlor.type;
                     state.emitEquipmentChanges();
                     break;
-                }
-                case 22: {
+                case 22: // Chlorinator->OCP this is actually an iChlor message and has no bearing on IntelliConnect.
                     // temp and output as seen from IntelliConnect.  
                     // Issue #157 - https://github.com/tagyoureit/nodejs-poolController/issues/157
                     // [10 02, 10, 16], [00, 0f, 49, 00,05, 10], [85,  10,03] = hex
@@ -141,57 +143,7 @@ export class ChlorinatorStateMessage {
                     }
                     state.emitEquipmentChanges();
                     break;
-                }
             }
         }
-        // question: does IntelliCenter ever broadcast Chlorinator packet?  Answer: Never.  My guess is that this is actually 
-        // a configuration message rather than a status message.  Also, IntelliCenter has a 204 extension status that contains
-        // the current countdown timer for the superChlor in the last 2 bytes.  Perhaps this is the equivalent.
-        //else if (msg.protocol === Protocol.Broadcast) {
-        //    if (!state.isInitialized) return;
-        //    // sample packet
-        //    // [165,33,15,16,25,22],[1,10,128,29,132,0,73,110,116,101,108,108,105,99,104,108,111,114,45,45,52,48],[7,231]
-        //    let chlorId = 1;
-        //    let chlor = sys.chlorinators.getItemById(chlorId, true);
-        //    if (chlor.isVirtual) { return; } // shouldn't get here except for testing Chlor on *Touch system.
-        //    // installed = (aaaaaaa)1 so 1 = installed
-        //    chlor.isActive = (msg.extractPayloadByte(0) & 0x01) === 1;
-        //    if (chlor.isActive) {
-        //        // RSG : making the assumption here that the chlorinator will be tied to the pool in any system that is not a shared body
-        //        sys.equipment.maxBodies >= 1 || sys.equipment.shared === true ? chlor.body = 32 : chlor.body = 0;
-        //        // outputSpaPercent field is aaaaaaab (binary) where aaaaaaa = % and b===installed (0=no,1=yes)
-        //        // eg. a value of 41 is 00101001
-        //        // spa percent = 0010100(b) so 10100 = 20
-        //        if (!chlor.disabled) {
-        //            // RKS: We don't want these setpoints if our chem controller disabled the
-        //            // chlorinator.  These should be 0 anyway.
-        //            chlor.spaSetpoint = msg.extractPayloadByte(0) >> 1;
-        //            chlor.poolSetpoint = msg.extractPayloadByte(1);
-        //        }
-        //        chlor.address = chlor.id + 79;
-        //        chlor.superChlor = msg.extractPayloadByte(5) > 0;
-        //        chlor.superChlorHours = msg.extractPayloadByte(5);
-        //        chlor.name = msg.extractPayloadString(6, 16);
-        //        let schlor = state.chlorinators.getItemById(chlorId, true);
-        //        // The most common failure with IntelliChlor is that the salt level stops reporting.  Below should allow it to be fed from an alternate
-        //        // source like REM.
-        //        schlor.saltLevel = msg.extractPayloadByte(3) * 50 || schlor.saltLevel || 0;
-        //        schlor.status = msg.extractPayloadByte(4) & 0x007F; // Strip off the high bit.  The chlorinator does not actually report this.;
-        //        schlor.lastComm = new Date().getTime();  // rely solely on "true" chlor messages for this?
-        //        schlor.poolSetpoint = chlor.poolSetpoint;
-        //        schlor.spaSetpoint = chlor.spaSetpoint;
-        //        schlor.superChlor = chlor.superChlor;
-        //        schlor.superChlorHours = chlor.superChlorHours;
-        //        schlor.name = chlor.name;
-        //        schlor.body = chlor.body;
-        //        if (state.temps.bodies.getItemById(1).isOn) schlor.targetOutput = chlor.disabled ? 0 : chlor.poolSetpoint;
-        //        else if (state.temps.bodies.getItemById(2).isOn) schlor.targetOutput = chlor.disabled ? 0 : chlor.spaSetpoint;
-        //        state.emitEquipmentChanges();
-        //    }
-        //    else {
-        //        sys.chlorinators.removeItemById(chlorId);
-        //        state.chlorinators.removeItemById(chlorId);
-        //    }
-        //}
     }
 }

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

@@ -357,17 +357,41 @@ export class EquipmentStateMessage {
                             tbody.setPoint = cbody.setPoint;
                             tbody.name = cbody.name;
                             tbody.circuit = cbody.circuit = 6;
-                            tbody.heatMode = cbody.heatMode = msg.extractPayloadByte(22) & 0x03;
+
+                            //RKS: This heat mode did not include all the bits necessary for hybrid heaters
+                            //tbody.heatMode = cbody.heatMode = msg.extractPayloadByte(22) & 0x03;
+                            tbody.heatMode = cbody.heatMode = msg.extractPayloadByte(22) & 0x33;
                             let heatStatus = sys.board.valueMaps.heatStatus.getValue('off');
                             if (tbody.isOn) {
-                                //const heaterActive = (msg.extractPayloadByte(10) & 0x0C) === 12;
-                                //const solarActive = (msg.extractPayloadByte(10) & 0x30) === 48;
-                                const heaterActive = (msg.extractPayloadByte(10) & 0x04) === 0x04;
-                                const solarActive = (msg.extractPayloadByte(10) & 0x10) === 0x10;
-                                const cooling = solarActive && tbody.temp > tbody.setPoint;
-                                if (heaterActive) heatStatus = sys.board.valueMaps.heatStatus.getValue('heater');
-                                if (cooling) heatStatus = sys.board.valueMaps.heatStatus.getValue('cooling');
-                                else if (solarActive) heatStatus = sys.board.valueMaps.heatStatus.getValue('solar');
+                                if (tbody.heaterOptions.hybrid > 0) {
+                                    // ETi When heating with
+                                    // Heatpump (1) = 12    H:true S:false C:false
+                                    // Gas (2) = 48         H:false S:true C:false
+                                    // Hybrid (3) = 48      H:true S:false C:false
+                                    // Dual (16) = 60       H:true S:true C:false
+                                    // What this means is that Touch actually treats the heat status as either heating with
+                                    // the primary heater for the body or the secondary.  In the case of a hybrid heater
+                                    // the primary is a heatpump and the secondary is gas.  In the case of gas + solar or gas + heatpump
+                                    // the gas heater is the primary and solar or heatpump is the secondary.   So we need to dance a little bit
+                                    // here.  We do this by checking the heater options.
+
+                                    // This can be the only heater solar cannot be installed with this.
+                                    let byte = msg.extractPayloadByte(10);
+                                    // Either the primary, secondary, or both is engaged.
+                                    if ((byte & 0x14) === 0x14) heatStatus = sys.board.valueMaps.heatStatus.getValue('dual');
+                                    else if (byte & 0x10) heatStatus = sys.board.valueMaps.heatStatus.getValue('heater');
+                                    else if (byte & 0x04) heatStatus = sys.board.valueMaps.heatStatus.getValue('hpheat');
+                                }
+                                else {
+                                    //const heaterActive = (msg.extractPayloadByte(10) & 0x0C) === 12;
+                                    //const solarActive = (msg.extractPayloadByte(10) & 0x30) === 48;
+                                    const heaterActive = (msg.extractPayloadByte(10) & 0x04) === 0x04;
+                                    const solarActive = (msg.extractPayloadByte(10) & 0x10) === 0x10;
+                                    const cooling = solarActive && tbody.temp > tbody.setPoint;
+                                    if (heaterActive) heatStatus = sys.board.valueMaps.heatStatus.getValue('heater');
+                                    if (cooling) heatStatus = sys.board.valueMaps.heatStatus.getValue('cooling');
+                                    else if (solarActive) heatStatus = sys.board.valueMaps.heatStatus.getValue('solar');
+                                }
                             }
                             tbody.heatStatus = heatStatus;
                             sys.board.schedules.syncScheduleHeatSourceAndSetpoint(cbody, tbody);
@@ -380,21 +404,32 @@ export class EquipmentStateMessage {
                                 tbody.temp = sys.equipment.shared ? state.temps.waterSensor1 : state.temps.waterSensor2;
                                 tbody.isOn = true;
                             } else tbody.isOn = false;
-                            tbody.heatMode = cbody.heatMode = (msg.extractPayloadByte(22) & 0x0C) >> 2;
+                            //RKS: This heat mode did not include all the bits necessary for hybrid heaters
+                            //tbody.heatMode = cbody.heatMode = (msg.extractPayloadByte(22) & 0x0C) >> 2;
+                            tbody.heatMode = cbody.heatMode = (msg.extractPayloadByte(22) & 0xCC) >> 2;
                             tbody.setPoint = cbody.setPoint;
                             tbody.name = cbody.name;
                             tbody.circuit = cbody.circuit = 1;
                             let heatStatus = sys.board.valueMaps.heatStatus.getValue('off');
                             if (tbody.isOn) {
-                                //const heaterActive = (msg.extractPayloadByte(10) & 0x0C) === 12;
-                                //const solarActive = (msg.extractPayloadByte(10) & 0x30) === 48;
-                                const heaterActive = (msg.extractPayloadByte(10) & 0x08) === 0x08;
-                                const solarActive = (msg.extractPayloadByte(10) & 0x20) === 0x20;
-
-                                const cooling = solarActive && tbody.temp > tbody.setPoint;
-                                if (heaterActive) heatStatus = sys.board.valueMaps.heatStatus.getValue('heater');
-                                if (cooling) heatStatus = sys.board.valueMaps.heatStatus.getValue('cooling');
-                                else if (solarActive) heatStatus = sys.board.valueMaps.heatStatus.getValue('solar');
+                                if (tbody.heaterOptions.hybrid > 0) {
+                                    // This can be the only heater solar cannot be installed with this.
+                                    let byte = msg.extractPayloadByte(10);
+                                    // Either the primary, secondary, or both is engaged.
+                                    if ((byte & 0x28) === 0x28) heatStatus = sys.board.valueMaps.heatStatus.getValue('dual');
+                                    else if (byte & 0x20) heatStatus = sys.board.valueMaps.heatStatus.getValue('heater');
+                                    else if (byte & 0x08) heatStatus = sys.board.valueMaps.heatStatus.getValue('hpheat');
+                                }
+                                else {
+                                    //const heaterActive = (msg.extractPayloadByte(10) & 0x0C) === 12;
+                                    //const solarActive = (msg.extractPayloadByte(10) & 0x30) === 48;
+                                    const heaterActive = (msg.extractPayloadByte(10) & 0x08) === 0x08;
+                                    const solarActive = (msg.extractPayloadByte(10) & 0x20) === 0x20;
+                                    const cooling = solarActive && tbody.temp > tbody.setPoint;
+                                    if (heaterActive) heatStatus = sys.board.valueMaps.heatStatus.getValue('heater');
+                                    if (cooling) heatStatus = sys.board.valueMaps.heatStatus.getValue('cooling');
+                                    else if (solarActive) heatStatus = sys.board.valueMaps.heatStatus.getValue('solar');
+                                }
                             }
                             tbody.heatStatus = heatStatus;
                             sys.board.schedules.syncScheduleHeatSourceAndSetpoint(cbody, tbody);
@@ -482,7 +517,8 @@ export class EquipmentStateMessage {
                 // pool
                 let tbody: BodyTempState = state.temps.bodies.getItemById(1, true);
                 let cbody: Body = sys.bodies.getItemById(1);
-                tbody.heatMode = cbody.heatMode = msg.extractPayloadByte(5) & 3;
+                // RKS: 02-26-22 - See communications doc for explanation of bits.  This needs to support UltraTemp ETi heatpumps.
+                tbody.heatMode = cbody.heatMode = msg.extractPayloadByte(5) & 0x33;
                 tbody.setPoint = cbody.setPoint = msg.extractPayloadByte(3);
                 tbody.coolSetpoint = cbody.coolSetpoint = msg.extractPayloadByte(9);
                 if (tbody.isOn) tbody.temp = state.temps.waterSensor1;
@@ -490,8 +526,8 @@ export class EquipmentStateMessage {
                 if (cbody.isActive) {
                     // spa
                     tbody = state.temps.bodies.getItemById(2, true);
-                    tbody.heatMode = cbody.heatMode =
-                        (msg.extractPayloadByte(5) & 12) >> 2;
+                    tbody.heatMode = cbody.heatMode = (msg.extractPayloadByte(5) & 0xCC) >> 2;
+                    //tbody.heatMode = cbody.heatMode = (msg.extractPayloadByte(5) & 12) >> 2;
                     tbody.setPoint = cbody.setPoint = msg.extractPayloadByte(4);
                     if (tbody.isOn) tbody.temp = state.temps.waterSensor2 = msg.extractPayloadByte(1);
                 }

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

@@ -1,87 +1,117 @@
-/*  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;
-    }
-
+/*  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 or UltraTemp ETi
+                    break;
+                case 114: // This is a message from a master controlling UltraTemp
+                    msg.isProcessed = true;
+                    break;
+                case 113:
+                    HeaterStateMessage.processHybridStatus(msg);
+                    break;
+                case 116:
+                    HeaterStateMessage.processMasterTempStatus(msg);
+                    break;
+                case 115:
+                    HeaterStateMessage.processUltraTempStatus(msg);
+                    break;
+            }
+        }
+    }
+    public static processHeaterCommand(msg: Inbound) {
+        let heater: Heater = sys.heaters.getItemByAddress(msg.source);
+        // At this point there is no other configuration data for ET
+        if (sys.controllerType === ControllerType.EasyTouch) {
+            let htype = sys.board.valueMaps.heaterTypes.transform(heater.type);
+            switch (htype.name) {
+                case 'hybrid':
+                    heater.economyTime = msg.extractPayloadByte(3);
+                    heater.maxBoostTemp = msg.extractPayloadByte(4);
+                    break;
+            }
+        }
+    }
+    public static processHybridStatus(msg: Inbound) {
+        //[165, 0, 16, 112, 113, 10][1, 1, 0, 0, 0, 0, 0, 0, 0, 0][1, 162]
+        let heater: Heater = sys.heaters.getItemByAddress(msg.source);
+        let sheater = state.heaters.getItemById(heater.id);
+        sheater.isOn = msg.extractPayloadByte(0) > 0;
+
+        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 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;
+    }
+
 }