nodejs-poolcontroller 7.6.1 → 8.0.0

package/controller/comms/messages/config/SecurityMessage.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

package/controller/comms/messages/config/ValveMessage.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
@@ -56,9 +57,10 @@ export class ValveMessage {
             case ControllerType.IntelliCom:
             case ControllerType.EasyTouch:
             case ControllerType.IntelliTouch:
+            case ControllerType.SunTouch:
                 switch (msg.action) {
                     case 29:
-                        ValveMessage.process_ValveAssignment_IT(msg);
+                        sys.controllerType === ControllerType.SunTouch ? ValveMessage.process_ValveAssignment_ST(msg) : ValveMessage.process_ValveAssignment_IT(msg);
                         break;
                     case 35:
                         ValveMessage.process_ValveOptions_IT(msg);
@@ -73,19 +75,38 @@ export class ValveMessage {
         sys.general.options.pumpDelay = msg.extractPayloadByte(0) >> 7 === 1;
         msg.isProcessed = true;
     }
+    private static process_ValveAssignment_ST(msg: Inbound) {
+        // SunTouch example
+        //[165,1,15,16,29,24][2,0,0,0,20,255,255,1,2,3,4,1,72,0,0,0,3,0,0,63,4,0,0,0][3,167]
+        let vA = sys.valves.getItemById(1, true);
+        let vB = sys.valves.getItemById(2, true);
+        let vC = sys.valves.getItemById(3, true);
+        if (sys.equipment.shared && !sys.equipment.single) {
+            vA.name = 'Intake';
+            vB.circuit = vA.circuit = sys.board.valueMaps.virtualCircuits.encode('poolspa');
+            vB.name = 'Return';
+        }
+        else {
+            vA.name = 'Valve A';
+            vB.name = 'Valve B';
+            vA.circuit = msg.extractPayloadByte(1);
+            vB.circuit = msg.extractPayloadByte(2);
+        }
+        vC.circuit = msg.extractPayloadByte(4);
+        vC.name = 'Valve C'
+    }
     private static process_ValveAssignment_IT(msg: Inbound) {
         // sample packet
-        // 165,33,16,34,157,6,0,0,1,255,255,255,4,153  [set]
+        // [165,33,16,34,157,6],[0,0,1,255,255,255],[4,153]  [set]
+        // [165,33,16,34,157,6],[0,0,7,255,255,255],[4,159]] [set]
         // [165,33,15,16,29,24],[2,0,0,0,128,1,255,255,255,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],[4,154] [get]
-        // [[][255,0,255][165,33,16,34,157,6][0,0,7,255,255,255][4,159]] [set]
         // what is payload[0]?
         for (let ndx = 4, id = 1; id <= sys.equipment.maxValves; ndx++) {
-            let valve: Valve = sys.valves.getItemById(id);
             if (id === 3) {
-                if (sys.equipment.shared) {
-                    valve = sys.valves.getItemById(id, true);
+                if (sys.equipment.shared && !sys.equipment.single) {
+                    let valve: Valve = sys.valves.getItemById(id);
                     valve.circuit = 6; // pool/spa -- fix
-                    valve.name = ValveMessage.getName(id, valve.circuit);
+                    valve.name = 'Intake';
                     valve.isIntake = true;
                     valve.isReturn = false;
                     valve.isActive = true;
@@ -99,13 +120,12 @@ export class ValveMessage {
                     sys.valves.removeItemById(id);
                     state.valves.removeItemById(id);
                 }
-                id++;
             }
             else if (id === 4) {
-                if (sys.equipment.shared) {
-                    valve = sys.valves.getItemById(id, true);
+                if (sys.equipment.shared && !sys.equipment.single) {
+                    let valve: Valve = sys.valves.getItemById(id);
                     valve.circuit = 6; // pool/spa -- fix
-                    valve.name = ValveMessage.getName(id, valve.circuit);
+                    valve.name = 'Return';
                     valve.isIntake = false;
                     valve.isReturn = true;
                     valve.isActive = true;
@@ -119,40 +139,37 @@ export class ValveMessage {
                     sys.valves.removeItemById(id);
                     state.valves.removeItemById(id);
                 }
-                id++;
             }
             else {
-                valve = sys.valves.getItemById(id, true);
+                let valve: Valve = sys.valves.getItemById(id);
                 let circ = msg.extractPayloadByte(ndx);
                 valve.circuit = circ > 0 && circ < 255 ? circ : 0;
-                valve.circuit = msg.extractPayloadByte(ndx);
+                //valve.circuit = msg.extractPayloadByte(ndx);
                 //valve.isActive = valve.circuit > 0 && valve.circuit < 255;
                 // RKS: 04-14-21 -- Valves should always be active but shown with no assignment when
                 // 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;
+                valve.master = 0;
                 // Allow users to name the valve whatever they want.  *Touch apparently only allows the valve to be named the same
                 // as the circuit but this should be fine if we allow the user to edit it.
                 valve.name = (typeof valve.name === 'undefined') ? ValveMessage.getName(id, valve.circuit) : valve.name;
                 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.master = 0;
-                // valve.isVirtual = false;
-                valve.type = 0;
             }
             id++;
         }
+        // Clean up any valves that are leftovers from previous configs.
+        for (let i = sys.valves.length - 1; i >= 0; i--) {
+            let v = sys.valves.getItemByIndex(i);
+            if (v.master === 0 && v.id > sys.equipment.maxValves) {
+                sys.valves.removeItemByIndex(i);
+                state.valves.removeItemById(v.id);
+            }
+        }
         msg.isProcessed = true;
     }
     private static getName(id: number, cir: number) {

package/controller/comms/messages/status/ChlorinatorStateMessage.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
@@ -21,41 +22,44 @@ 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;
-            
-            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: 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 >= 80 && msg.dest <= 83) {
+                // 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()) {
                     // We have not talked to the chlorinator in 30 seconds so we have lost communication.
                     cstate.status = 128;
                 }
-                chlor = sys.chlorinators.getItemById(msg.dest, true);
-                chlor.address = msg.dest + 79;
+                // chlor = sys.chlorinators.getItemById(msg.dest - 79, true); chlor is retrieved above; don't get in incorrectly here.
+                chlor.address = msg.dest; // 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 +69,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 === 0) 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 +81,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 +101,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
@@ -134,64 +137,14 @@ export class ChlorinatorStateMessage {
                         // Set it back to disabled.  Some asshole is futzing with the chlorinator output.
                         sys.board.chlorinator.setChlorAsync({ id: chlor.id, disabled: true });
                     }
-                    if (sys.controllerType === ControllerType.Virtual) {
-                        // This lets the iChlor use the temp probe from the 
+                    if (sys.controllerType === ControllerType.Nixie) {
+                        // This lets the current body use the iChlor temp probe 
                         let tbody: BodyTempState = sys.pumps.length > 0 ? state.temps.bodies.getBodyIsOn() : state.temps.bodies.getItemById(1, true);
                         if (msg.extractPayloadByte(2) >= 40 && typeof tbody !== 'undefined') tbody.temp = msg.extractPayloadByte(2);
                     }
                     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);
-        //    }
-        //}
     }
 }