nodejs-poolcontroller 7.6.1 → 8.0.0

package/controller/comms/messages/Messages.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
@@ -42,6 +43,10 @@ import { TouchScheduleCommands } from "controller/boards/EasyTouchBoard";
 import { IntelliValveStateMessage } from "./status/IntelliValveStateMessage";
 import { IntelliChemStateMessage } from "./status/IntelliChemStateMessage";
 import { OutboundMessageError } from "../../Errors";
+import { conn } from "../Comms"
+import extend = require("extend");
+import { MessagesMock } from "../../../anslq25/MessagesMock";
+
 export enum Direction {
     In = 'in',
     Out = 'out'
@@ -54,6 +59,8 @@ export enum Protocol {
     IntelliChem = 'intellichem',
     IntelliValve = 'intellivalve',
     Heater = 'heater',
+    AquaLink = 'aqualink',
+    Hayward = 'hayward',
     Unidentified = 'unidentified'
 }
 export class Message {
@@ -66,8 +73,11 @@ export class Message {
     private _id: number = -1;
     // Fields
     private static _messageId: number = 0;
-    public static get nextMessageId(): number { return this._messageId < 80000 ? ++this._messageId : this._messageId = 0; }
-
+    public static get nextMessageId(): number { 
+        let i = this._messageId < 80000 ? ++this._messageId : this._messageId = 0;
+        logger.debug(`Assigning message id ${i}`)
+        return i; }
+    public portId = 0; // This will be the target or source port for the message.  If this is from or to an Aux RS485 port the value will be > 0.
     public timestamp: Date = new Date();
     public direction: Direction = Direction.In;
     public protocol: Protocol = Protocol.Unknown;
@@ -81,36 +91,62 @@ export class Message {
     public set id(val: number) { this._id = val; }
     public isValid: boolean = true;
     public scope: string;
+    public isClone: boolean;
     // Properties
     public get isComplete(): boolean { return this._complete; }
     public get sub(): number { return this.header.length > 1 ? this.header[1] : -1; }
     public get dest(): number {
-        if (this.protocol === Protocol.Chlorinator) {
-            return this.header[2] >= 80 ? this.header[2] - 79 : 0;
+        if (this.header.length > 2) {
+            if (this.protocol === Protocol.Chlorinator || this.protocol === Protocol.AquaLink) {
+                return this.header.length > 2 ? (this.header[2] >= 80 ? this.header[2] : 0) : -1;
+            }
+            else if (this.protocol === Protocol.Hayward) {
+                //            src   act   dest             
+                //0x10, 0x02, 0x00, 0x0C, 0x00, 0x00, 0x2D, 0x02, 0x36, 0x00, 0x83, 0x10, 0x03 -- Response from pump
+                return this.header.length > 4 ? this.header[2] : -1;
+            }
+            else return this.header.length > 2 ? this.header[2] : -1;
         }
-        if (this.header.length > 2) return this.header[2];
         else return -1;
     }
     public get source(): number {
         if (this.protocol === Protocol.Chlorinator) {
-            return this.header[2] >= 80 ? 0 : 1;
+            return this.header.length > 2 ? (this.header[2] >= 80 ? 0 : this.header[2]) : -1;
             // have to assume incoming packets with header[2] >= 80 (sent to a chlorinator)
             // are from controller (0);
             // likewise, if the destination is 0 (controller) we
             // have to assume it was sent from the 1st chlorinator (1)
             // until we learn otherwise.  
         }
+        else if (this.protocol === Protocol.AquaLink) {
+            // Once we decode the devices we will be able to tell where it came from based upon the commands.
+            return 0;
+        }
+        else if (this.protocol === Protocol.Hayward) {
+            //            src   act   dest             
+            //0x10, 0x02, 0x00, 0x0C, 0x00, 0x00, 0x2D, 0x02, 0x36, 0x00, 0x83, 0x10, 0x03 -- Response from pump
+            //0x10, 0x02, 0x0C, 0x01, 0x02, 0x2D, 0x00, 0x4E, 0x10, 0x03 -- Command to AUX2 Pump
+            return this.header.length > 4 ? this.header[4] : -1;
+        }
         if (this.header.length > 3) return this.header[3];
         else return -1;
     }
     public get action(): number {
-        if (this.protocol === Protocol.Chlorinator) return this.header[3];
-        if (this.header.length > 5) return this.header[4];
+        // The action byte is actually the 4th byte in the header the destination address is the 5th byte.
+        if (this.protocol === Protocol.Chlorinator ||
+            this.protocol === Protocol.AquaLink) return this.header.length > 3 ? this.header[3] : -1;
+        else if (this.protocol === Protocol.Hayward) {
+            //            src   act   dest             
+            //0x10, 0x02, 0x00, 0x0C, 0x00, 0x00, 0x2D, 0x02, 0x36, 0x00, 0x83, 0x10, 0x03 -- Response from pump
+            //0x10, 0x02, 0x0C, 0x01, 0x02, 0x2D, 0x00, 0x4E, 0x10, 0x03 -- Command to AUX2 Pump
+            return this.header.length > 3 ? this.header[3] || this.header[2] : -1;
+        }
+        if (this.header.length > 4) return this.header[4];
         else return -1;
     }
-    public get datalen(): number { return this.protocol === Protocol.Chlorinator ? this.payload.length : this.header.length > 5 ? this.header[5] : -1; }
-    public get chkHi(): number { return this.protocol === Protocol.Chlorinator ? 0 : this.term.length > 0 ? this.term[0] : -1; }
-    public get chkLo(): number { return this.protocol === Protocol.Chlorinator ? this.term[0] : this.term[1]; }
+    public get datalen(): number { return this.protocol === Protocol.Chlorinator || this.protocol === Protocol.AquaLink || this.protocol === Protocol.Hayward ? this.payload.length : this.header.length > 5 ? this.header[5] : -1; }
+    public get chkHi(): number { return this.protocol === Protocol.Chlorinator || this.protocol === Protocol.AquaLink ? 0 : this.term.length > 0 ? this.term[0] : -1; }
+    public get chkLo(): number { return this.protocol === Protocol.Chlorinator || this.protocol === Protocol.AquaLink ? this.term[0] : this.term[1]; }
     public get checksum(): number {
         var sum = 0;
         for (let i = 0; i < this.header.length; i++) sum += this.header[i];
@@ -136,7 +172,59 @@ export class Message {
         return pkt;
     }
     public toLog(): string {
-        return `{"id":${this.id},"valid":${this.isValid},"dir":"${this.direction}","proto":"${this.protocol}","pkt":[${JSON.stringify(this.padding)},${JSON.stringify(this.preamble)},${JSON.stringify(this.header)},${JSON.stringify(this.payload)},${JSON.stringify(this.term)}],"ts":"${Timestamp.toISOLocal(this.timestamp)}"}`;
+        return `{"port":${this.portId},"id":${this.id},"valid":${this.isValid},"dir":"${this.direction}","proto":"${this.protocol}","pkt":[${JSON.stringify(this.padding)},${JSON.stringify(this.preamble)}, ${JSON.stringify(this.header)}, ${JSON.stringify(this.payload)},${JSON.stringify(this.term)}],"ts":"${Timestamp.toISOLocal(this.timestamp)}"}`;
+    }
+    public static convertOutboundToInbound(out: Outbound): Inbound {
+        let inbound = new Inbound();
+        inbound.portId = out.portId;
+        // inbound.id = Message.nextMessageId;
+        inbound.protocol = out.protocol;
+        inbound.scope = out.scope;
+        inbound.preamble = out.preamble;
+        inbound.padding = out.padding;
+        inbound.header = out.header;
+        inbound.payload = [...out.payload];
+        inbound.term = out.term;
+        inbound.portId = out.portId;
+        return inbound;
+    }
+    public static convertInboundToOutbound(inbound: Inbound): Outbound {
+        let out = new Outbound(
+            inbound.protocol,
+            inbound.source,
+            inbound.dest,
+            inbound.action,
+            inbound.payload,
+        );
+        out.scope = inbound.scope;
+        out.preamble = inbound.preamble;
+        out.padding = inbound.padding;
+        out.header = inbound.header;
+        out.term = inbound.term;
+        out.portId = inbound.portId;
+        return out;
+    }
+    public clone(): Inbound | Outbound {
+        let msg;
+        if (this instanceof Inbound) {
+            msg = new Inbound();
+            msg.id = Message.nextMessageId;
+            msg.scope = this.scope;
+            msg.preamble = this.preamble;
+            msg.padding = this.padding;
+            msg.payload = [...this.payload];
+            msg.header = this.header;
+            msg.term = this.term;
+            msg.portId = this.portId;
+        }
+        else {
+            msg = new Outbound(
+                this.protocol, this.source, this.dest, this.action, [...this.payload], 
+            );
+            msg.portId = this.portId;
+            msg.scope = this.scope;
+        }
+        return msg;
     }
 }
 export class Inbound extends Message {
@@ -158,26 +246,93 @@ export class Inbound extends Message {
     public responseFor: number[] = [];
     public isProcessed: boolean = false;
     public collisions: number = 0;
+    public rewinds: number = 0;
     // Private methods
     private isValidChecksum(): boolean {
-        if (this.protocol === Protocol.Chlorinator) return this.checksum % 256 === this.chkLo;
+        if (this.protocol === Protocol.Chlorinator || this.protocol === Protocol.AquaLink) return this.checksum % 256 === this.chkLo;
         return (this.chkHi * 256) + this.chkLo === this.checksum;
     }
     public toLog() {
         if (this.responseFor.length > 0)
-            return `{"id":${this.id},"valid":${this.isValid},"dir":"${this.direction}","proto":"${this.protocol}","for":${JSON.stringify(this.responseFor)},"pkt":[${JSON.stringify(this.padding)},${JSON.stringify(this.preamble)},${JSON.stringify(this.header)},${JSON.stringify(this.payload)},${JSON.stringify(this.term)}],"ts": "${Timestamp.toISOLocal(this.timestamp)}"}`;
-        return `{"id":${this.id},"valid":${this.isValid},"dir":"${this.direction}","proto":"${this.protocol}","pkt":[${JSON.stringify(this.padding)},${JSON.stringify(this.preamble)},${JSON.stringify(this.header)},${JSON.stringify(this.payload)},${JSON.stringify(this.term)}],"ts": "${Timestamp.toISOLocal(this.timestamp)}"}`;
+            return `{"port":${this.portId || 0},"id":${this.id},"valid":${this.isValid},"dir":"${this.direction}","proto":"${this.protocol}","for":${JSON.stringify(this.responseFor)},"pkt":[${JSON.stringify(this.padding)},${JSON.stringify(this.preamble)},${JSON.stringify(this.header)},${JSON.stringify(this.payload)},${JSON.stringify(this.term)}],"ts": "${Timestamp.toISOLocal(this.timestamp)}"}`;
+        return `{"port":${this.portId || 0},"id":${this.id},"valid":${this.isValid},"dir":"${this.direction}","proto":"${this.protocol}","pkt":[${JSON.stringify(this.padding)},${JSON.stringify(this.preamble)},${JSON.stringify(this.header)},${JSON.stringify(this.payload)},${JSON.stringify(this.term)}],"ts": "${Timestamp.toISOLocal(this.timestamp)}"}`;
     }
     private testChlorHeader(bytes: number[], ndx: number): boolean {
         // if packets have 16,2 (eg status=16,2,29) in them and they come as partial packets, they would have
         // prev been detected as chlor packets;
         // valid chlor packets should have 16,2,0 or 16,2,[80-96];
         // this should reduce the number of false chlor packets
-        return (ndx + 2 < bytes.length && bytes[ndx] === 16 && bytes[ndx + 1] === 2 && (bytes[ndx + 2] === 0 || (bytes[ndx + 2] >= 80 && bytes[ndx + 2] <= 96)))
+        // For any of these 16,2 type headers we need at least 5 bytes to determine the routing.
+        //63,15,16,2,29,9,36,0,0,0,0,0,16,0,32,0,0,2,0,75,75,32,241,80,85,24,241,16,16,48,245,69,45,100,186,16,2,80,17,0,115,16,3
+        if (bytes.length > ndx + 4) {
+            if (bytes[ndx] === 16 && bytes[ndx + 1] === 2) {
+                let dst = bytes[ndx + 2];
+                let act = bytes[ndx + 3];
+                // For now the dst byte will always be 0 or 80.
+                if (![0, 16, 80, 81, 82, 83].includes(dst)) {
+                    //logger.info(`Sensed chlorinator header but the dst byte is ${dst}`);
+                    return false;
+                }
+                else if (dst === 0 && [1, 18, 3].includes(act))
+                    return true;
+                else if (![0, 17, 19, 20, 21, 22].includes(act)) {
+                    //logger.info(`Sensed out chlorinator header but the dst byte is ${dst} ${act} ${JSON.stringify(bytes)}`);
+                    return false;
+                }
+                return true;
+            }
+        }
+        return false;
+    }
+    private testAquaLinkHeader(bytes: number[], ndx: number): boolean {
+        if (bytes.length > ndx + 4 && sys.controllerType === 'aqualink') {
+            if (bytes[ndx] === 16 && bytes[ndx + 1] === 2) {
+                return true;
+            }
+        }
+        return false;
+    }
+    private testHaywardHeader(bytes: number[], ndx: number): boolean {
+        //0x10, 0x02, 0x0C, 0x01, 0x00, 0x2D, 0x00, 0x4C, 0x10, 0x03 -- Command to pump
+        //[16,2,12,1,0]
+        //0x10, 0x02, 0x0C, 0x01, 0x00, 0x2D, 0x00, 0x4C, 0x10, 0x03 -- Command to Filter Pump
+        //[16,2,12,1,0]
+        //0x10, 0x02, 0x0C, 0x01, 0x02, 0x2D, 0x00, 0x4E, 0x10, 0x03 -- Command to AUX2 Pump
+        //[16,2,12,1,2]
+        //            src   act   dest             
+        //0x10, 0x02, 0x00, 0x0C, 0x00, 0x00, 0x2D, 0x02, 0x36, 0x00, 0x83, 0x10, 0x03 -- Response from pump
+        //[16,2,0,12,0] --> Response
+        //[16,2,0,12,0]
+        if (bytes.length > ndx + 4) {
+            if (sys.controllerType === 'aqualink') return false;
+            if (bytes[ndx] === 16 && bytes[ndx + 1] === 2) {
+                let dst = bytes[ndx + 3];
+                let src = bytes[ndx + 2];
+                if (dst === 12 || src === 12) return true;
+            }
+        }
+        return false;
     }
-    private testBroadcastHeader(bytes: number[], ndx: number): boolean { return ndx < bytes.length - 3 && bytes[ndx] === 255 && bytes[ndx + 1] === 0 && bytes[ndx + 2] === 255 && bytes[ndx + 3] === 165; }
-    private testUnidentifiedHeader(bytes: number[], ndx: number): boolean { return ndx < bytes.length - 3 && bytes[ndx] === 255 && bytes[ndx + 1] === 0 && bytes[ndx + 2] === 255 && bytes[ndx + 3] !== 165; }
-    private testChlorTerm(bytes: number[], ndx: number): boolean { return ndx < bytes.length - 2 && bytes[ndx + 1] === 16 && bytes[ndx + 2] === 3; }
+    private testBroadcastHeader(bytes: number[], ndx: number): boolean {
+        // We are looking for [255,0,255,165]
+        if (bytes.length > ndx + 3) {
+            if (bytes[ndx] === 255 && bytes[ndx + 1] === 0 && bytes[ndx + 2] === 255 && bytes[ndx + 3] === 165) return true;
+            return false;
+        }
+        //return ndx < bytes.length - 3 && bytes[ndx] === 255 && bytes[ndx + 1] === 0 && bytes[ndx + 2] === 255 && bytes[ndx + 3] === 165;
+        return false;
+    }
+    private testUnidentifiedHeader(bytes: number[], ndx: number): boolean {
+        if (bytes.length > ndx + 3) {
+            if (bytes[ndx] === 255 && bytes[ndx + 1] === 0 && bytes[ndx + 2] === 255 && bytes[ndx + 3] !== 165) return true;
+            return false;
+        }
+        //return ndx < bytes.length - 3 && bytes[ndx] === 255 && bytes[ndx + 1] === 0 && bytes[ndx + 2] === 255 && bytes[ndx + 3] !== 165;
+        return false;
+    }
+    private testChlorTerm(bytes: number[], ndx: number): boolean { return ndx + 2 < bytes.length && bytes[ndx + 1] === 16 && bytes[ndx + 2] === 3; }
+    private testAquaLinkTerm(bytes: number[], ndx: number): boolean { return ndx + 2 < bytes.length && bytes[ndx + 1] === 16 && bytes[ndx + 2] === 3; }
+    private testHaywardTerm(bytes: number[], ndx: number): boolean { return ndx + 3 < bytes.length && bytes[ndx + 2] === 16 && bytes[ndx + 3] === 3; }
     private pushBytes(target: number[], bytes: number[], ndx: number, length: number): number {
         let end = ndx + length;
         while (ndx < bytes.length && ndx < end)
@@ -205,16 +360,18 @@ export class Inbound extends Message {
         this.isValid = true;
 
         this.collisions++;
+        this.rewinds++;
         logger.info(`rewinding message collision ${this.collisions} ${ndx} ${bytes.length} ${JSON.stringify(buff)}`);
         this.readPacket(buff);
         return ndx;
         //return this.padding.length + this.preamble.length;
     }
     public readPacket(bytes: number[]): number {
+        //logger.info(`BYTES: ${JSON.stringify(bytes)}`);
         var ndx = this.readHeader(bytes, 0);
         if (this.isValid && this.header.length > 0) ndx = this.readPayload(bytes, ndx);
         if (this.isValid && this.header.length > 0) ndx = this.readChecksum(bytes, ndx);
-        //if (this.isComplete && !this.isValid) return this.rewind(bytes, ndx);
+        if (this.isComplete && !this.isValid) return this.rewind(bytes, ndx);
         return ndx;
     }
     public mergeBytes(bytes) {
@@ -227,22 +384,40 @@ export class Inbound extends Message {
     }
     public readHeader(bytes: number[], ndx: number): number {
         // start over to include the padding bytes.
+        //if (this.protocol !== Protocol.Unknown) {
+        //    logger.warn(`${this.protocol} resulted in an empty message header ${JSON.stringify(this.header)}`);
+        //}
         let ndxStart = ndx;
-        while (ndx < bytes.length) {
-            if (this.testChlorHeader(bytes, ndx)) {
-                this.protocol = Protocol.Chlorinator;
-                break;
-            }
-            if (this.testBroadcastHeader(bytes, ndx)) {
-                this.protocol = Protocol.Broadcast;
-                break;
-            }
-            else if (this.testUnidentifiedHeader(bytes, ndx)) {
-                this.protocol = Protocol.Unidentified;
-                break;
+        // RKS: 05-30-22 -- OMG we have not been dealing with short headers.  As a result it was restarting
+        // the header process even after it had identified it.
+        if (this.protocol === Protocol.Unknown) {
+            while (ndx < bytes.length) {
+                if (this.testBroadcastHeader(bytes, ndx)) {
+                    this.protocol = Protocol.Broadcast;
+                    break;
+                }
+                if (this.testUnidentifiedHeader(bytes, ndx)) {
+                    this.protocol = Protocol.Unidentified;
+                    break;
+                }
+                if (this.testChlorHeader(bytes, ndx)) {
+                    this.protocol = Protocol.Chlorinator;
+                    break;
+                }
+                if (this.testAquaLinkHeader(bytes, ndx)) {
+                    this.protocol = Protocol.AquaLink;
+                    break;
+                }
+                if (this.testHaywardHeader(bytes, ndx)) {
+                    this.protocol = Protocol.Hayward;
+                    break;
+                }
+                this.padding.push(bytes[ndx++]);
             }
-            this.padding.push(bytes[ndx++]);
         }
+        // When the code above finds a protocol, ndx will be at the start of that
+        // header.  If it is not identified then it will rewind to the initial
+        // start position until we get more bytes.  This is the default case below.
         let ndxHeader = ndx;
         switch (this.protocol) {
             case Protocol.Pump:
@@ -257,11 +432,11 @@ export class Inbound extends Message {
                     // We actually don't have a complete header yet so just return.
                     // we will pick it up next go around.
                     // logger.debug(`We have an incoming message but the serial port hasn't given a complete header. [${this.padding}][${this.preamble}][${this.header}]`);
+                    //logger.info(`We don't have a complete header ${JSON.stringify(this.header)}`);
                     this.preamble = [];
                     this.header = [];
                     return ndxHeader;
                 }
-
                 if (this.source >= 96 && this.source <= 111) this.protocol = Protocol.Pump;
                 else if (this.dest >= 96 && this.dest <= 111) this.protocol = Protocol.Pump;
                 else if (this.source >= 112 && this.source <= 127) this.protocol = Protocol.Heater;
@@ -271,12 +446,13 @@ export class Inbound extends Message {
                 else if (this.source == 12 || this.dest == 12) this.protocol = Protocol.IntelliValve;
                 if (this.datalen > 75) {
                     //this.isValid = false;
-                    logger.debug(`Broadcast length ${this.datalen} exceeded 75bytes for ${this.protocol} message. Message rewound ${this.header}`);
+                    logger.debug(`Broadcast length ${this.datalen} exceeded 75 bytes for ${this.protocol} message. Message rewound ${this.header}`);
                     this.padding.push(...this.preamble);
                     this.padding.push(...this.header.slice(0, 1));
                     this.preamble = [];
                     this.header = [];
                     this.collisions++;
+                    this.rewinds++;
                     return ndxHeader + 1;
                 }
                 break;
@@ -298,6 +474,28 @@ export class Inbound extends Message {
                     return ndxHeader;
                 }
                 break;
+            case Protocol.Hayward:
+                ndx = this.pushBytes(this.header, bytes, ndx, 5);
+                if (this.header.length < 4) {
+                    // We actually don't have a complete header yet so just return.
+                    // we will pick it up next go around.
+                    logger.debug(`We have an incoming Hayward message but the serial port hasn't given a complete header. [${this.padding}][${this.preamble}][${this.header}]`);
+                    this.preamble = [];
+                    this.header = [];
+                    return ndxHeader;
+                }
+                break;
+            case Protocol.AquaLink:
+                ndx = this.pushBytes(this.header, bytes, ndx, 5);
+                if (this.header.length < 5) {
+                    // We actually don't have a complete header yet so just return.
+                    // we will pick it up next go around.
+                    logger.debug(`We have an incoming AquaLink message but the serial port hasn't given a complete header. [${this.padding}][${this.preamble}][${this.header}]`);
+                    this.preamble = [];
+                    this.header = [];
+                    return ndxHeader;
+                }
+                break;
             default:
                 // We didn't get a message signature. don't do anything with it.
                 ndx = ndxStart;
@@ -326,7 +524,11 @@ export class Inbound extends Message {
             case Protocol.IntelliValve:
             case Protocol.Heater:
             case Protocol.Unidentified:
-                if (this.datalen - this.payload.length <= 0) return ndx; // We don't need any more payload.
+                if (this.datalen - this.payload.length <= 0) {
+                    let buff = bytes.slice(ndx - 1);
+                    //logger.info(`We don't need any more payload ${this.datalen - this.payload.length} ${ndx} ${JSON.stringify(buff)};`);
+                    return ndx; // We don't need any more payload.
+                }
                 ndx = this.pushBytes(this.payload, bytes, ndx, this.datalen - this.payload.length);
                 break;
             case Protocol.Chlorinator:
@@ -341,6 +543,31 @@ export class Inbound extends Message {
                     }
                 }
                 break;
+            case Protocol.AquaLink:
+                // We need to deal with AquaLink packets where the terminator is actually split meaning only the first byte or
+                // two of the total payload is provided for the term.  We need at least 3 bytes to make this determination.
+                while (ndx + 3 <= bytes.length && !this.testAquaLinkTerm(bytes, ndx)) {
+                    this.payload.push(bytes[ndx++]);
+                    if (this.payload.length > 25) {
+                        this.isValid = false; // We have a runaway packet.  Some collision occurred so lets preserve future packets.
+                        logger.debug(`AquaLink message marked as invalid after not finding 16,3 in payload after ${this.payload.length} bytes`);
+                        break;
+                    }
+                }
+                break;
+            case Protocol.Hayward:
+                // We need to deal with AquaLink packets where the terminator is actually split meaning only the first byte or
+                // two of the total payload is provided for the term.  We need at least 3 bytes to make this determination.
+                while (ndx + 4 <= bytes.length && !this.testHaywardTerm(bytes, ndx)) {
+                    this.payload.push(bytes[ndx++]);
+                    if (this.payload.length > 25) {
+                        this.isValid = false; // We have a runaway packet.  Some collision occurred so lets preserve future packets.
+                        logger.debug(`Hayward message marked as invalid after not finding 16,3 in payload after ${this.payload.length} bytes`);
+                        break;
+                    }
+                }
+                break;
+
         }
         return ndx;
     }
@@ -369,6 +596,21 @@ export class Inbound extends Message {
                     this.isValid = this.isValidChecksum();
                 }
                 break;
+            case Protocol.AquaLink:
+                if (ndx + 3 <= bytes.length && this.testAquaLinkTerm(bytes, ndx)) {
+                    this._complete = true;
+                    ndx = this.pushBytes(this.term, bytes, ndx, 3);
+                    this.isValid = this.isValidChecksum();
+                }
+                break;
+            case Protocol.Hayward:
+                if (ndx + 4 <= bytes.length && this.testHaywardTerm(bytes, ndx)) {
+                    this._complete = true;
+                    ndx = this.pushBytes(this.term, bytes, ndx, 4);
+                    this.isValid = this.isValidChecksum();
+                }
+                break;
+
         }
         return ndx;
     }
@@ -471,7 +713,16 @@ export class Inbound extends Message {
                         PumpMessage.process(this);
                         break;
                     case 30:
-                        if (sys.controllerType !== ControllerType.Unknown) OptionsMessage.process(this);
+                        switch (sys.controllerType) {
+                            case ControllerType.Unknown:
+                                break;
+                            case ControllerType.SunTouch:
+                                ScheduleMessage.processSunTouch(this);
+                                break;
+                            default:
+                                OptionsMessage.process(this);
+                                break;
+                        }
                         break;
                     case 22:
                     case 32:
@@ -514,6 +765,9 @@ export class Inbound extends Message {
                     case 147:
                         IntellichemMessage.process(this);
                         break;
+                    case 136:
+                        ExternalMessage.processTouchSetHeatMode(this);
+                        break;
                     default:
                         if (this.action === 109 && this.payload[1] === 3) break;
                         if (this.source === 17 && this.payload[0] === 109) break;
@@ -524,6 +778,13 @@ export class Inbound extends Message {
         }
     }
     public process() {
+        let port = conn.findPortById(this.portId);
+        if (this.portId === sys.anslq25.portId) {
+            return MessagesMock.process(this);
+        }
+        if (port.mock && port.hasAssignedEquipment()){
+            return MessagesMock.process(this);
+        }
         switch (this.protocol) {
             case Protocol.Broadcast:
                 this.processBroadcast();
@@ -546,6 +807,9 @@ export class Inbound extends Message {
             case Protocol.Chlorinator:
                 ChlorinatorStateMessage.process(this);
                 break;
+            case Protocol.Hayward:
+                PumpStateMessage.processHayward(this);
+                break;
             default:
                 logger.debug(`Unprocessed Message ${this.toPacket()}`)
                 break;
@@ -553,15 +817,44 @@ export class Inbound extends Message {
     }
 }
 class OutboundCommon extends Message {
-    public set sub(val: number) { if (this.protocol !== Protocol.Chlorinator) this.header[1] = val; }
+    public set sub(val: number) { if (this.protocol !== Protocol.Chlorinator && this.protocol !== Protocol.AquaLink) this.header[1] = val; }
     public get sub() { return super.sub; }
-    public set dest(val: number) { this.protocol !== Protocol.Chlorinator ? this.header[2] = val : this.header[2] = val + 79; }
+    public set dest(val: number) {
+        if (this.protocol === Protocol.Chlorinator) this.header[2] = val;
+        else if (this.protocol === Protocol.Hayward) this.header[4] = val;
+        else this.header[2] = val;
+    }
     public get dest() { return super.dest; }
-    public set source(val: number) { if (this.protocol !== Protocol.Chlorinator) this.header[3] = val; }
+    public set source(val: number) {
+        switch (this.protocol) {
+            case Protocol.Chlorinator:
+                break;
+            case Protocol.Hayward:
+                this.header[3] = val;
+                break;
+            default:
+                this.header[3] = val;
+                break;
+        }
+        //if (this.protocol === Protocol.Hayward) this.header[2] = val;
+        //else if (this.protocol !== Protocol.Chlorinator) this.header[3] = val;
+    }
     public get source() { return super.source; }
-    public set action(val: number) { (this.protocol !== Protocol.Chlorinator) ? this.header[4] = val : this.header[3] = val; }
+    public set action(val: number) {
+        switch (this.protocol) {
+            case Protocol.Chlorinator:
+                this.header[3] = val;
+                break;
+            case Protocol.Hayward:
+                this.header[2] = val;
+                break;
+            default:
+                this.header[4] = val;
+                break;
+        }
+    }
     public get action() { return super.action; }
-    public set datalen(val: number) { if (this.protocol !== Protocol.Chlorinator) this.header[5] = val; }
+    public set datalen(val: number) { if (this.protocol !== Protocol.Chlorinator && this.protocol !== Protocol.Hayward) this.header[5] = val; }
     public get datalen() { return super.datalen; }
     public set chkHi(val: number) { if (this.protocol !== Protocol.Chlorinator) this.term[0] = val; }
     public get chkHi() { return super.chkHi; }
@@ -578,11 +871,13 @@ class OutboundCommon extends Message {
             case Protocol.Unidentified:
             case Protocol.IntelliChem:
             case Protocol.Heater:
+            case Protocol.Hayward:
                 this.chkHi = Math.floor(sum / 256);
                 this.chkLo = (sum - (super.chkHi * 256));
                 break;
+            case Protocol.AquaLink:
             case Protocol.Chlorinator:
-                this.term[0] = sum;
+                this.term[0] = sum % 256;
                 break;
         }
     }
@@ -598,7 +893,7 @@ export class Outbound extends OutboundCommon {
         this.header.length = 0;
         this.term.length = 0;
         this.payload.length = 0;
-        if (proto === Protocol.Chlorinator) {
+        if (proto === Protocol.Chlorinator || proto === Protocol.AquaLink) {
             this.header.push.apply(this.header, [16, 2, 0, 0]);
             this.term.push.apply(this.term, [0, 16, 3]);
         }
@@ -612,6 +907,10 @@ export class Outbound extends OutboundCommon {
             this.header.push.apply(this.header, [165, 0, 15, Message.pluginAddress, 0, 0]);
             this.term.push.apply(this.term, [0, 0]);
         }
+        else if (proto === Protocol.Hayward) {
+            this.header.push.apply(this.header, [16, 2, 0, 0, 0]);
+            this.term.push.apply(this.term, [0, 0, 16, 3]);
+        }
         this.scope = scope;
         this.source = source;
         this.dest = dest;
@@ -625,8 +924,19 @@ export class Outbound extends OutboundCommon {
     }
     // Factory
     public static create(obj?: any) {
-        let out = new Outbound(obj.protocol || Protocol.Broadcast,
-            obj.source || sys.board.commandSourceAddress || Message.pluginAddress, obj.dest || sys.board.commandDestAddress || 16, obj.action || 0, obj.payload || [], obj.retries || 0, obj.response || false, obj.scope || undefined);
+        let o = extend({
+            protocol: Protocol.Broadcast,
+            source: sys.board.commandSourceAddress || Message.pluginAddress,
+            dest: sys.board.commandDestAddress || 16,
+            action: 0,
+            payload: [],
+            retries: 0,
+            response: false,
+        }, obj, true);
+        let out = new Outbound(o.protocol, o.source, o.dest, o.action, o.payload, o.retries, o.response, o.scope);
+        //let out = new Outbound(obj.protocol || Protocol.Broadcast,
+        //    obj.source || sys.board.commandSourceAddress || Message.pluginAddress, obj.dest || sys.board.commandDestAddress || 16, obj.action || 0, obj.payload || [], obj.retries || 0, obj.response || false, obj.scope || undefined);
+        out.portId = obj.portId || 0;
         out.onComplete = obj.onComplete;
         out.onAbort = obj.onAbort;
         out.timeout = obj.timeout;
@@ -643,7 +953,9 @@ export class Outbound extends OutboundCommon {
     public static createMessage(action: number, payload: number[], retries?: number, response?: Response | boolean): Outbound {
         return new Outbound(Protocol.Broadcast, sys.board.commandSourceAddress || Message.pluginAddress, sys.board.commandDestAddress || 16, action, payload, retries, response);
     }
-
+    public async sendAsync() {
+        return conn.queueSendMessageAsync(this);
+    }
     // Fields
     public retries: number = 0;
     public tries: number = 0;
@@ -659,7 +971,6 @@ export class Outbound extends OutboundCommon {
         return false;
     }
     public get remainingTries(): number { return this.retries - this.tries + 1; } // Always allow 1 try.
-
     public setPayloadByte(ndx: number, value: number, def?: number) {
         if (typeof value === 'undefined' || isNaN(value)) value = def;
         if (ndx < this.payload.length) this.payload[ndx] = value;
@@ -737,11 +1048,11 @@ export class Outbound extends OutboundCommon {
         if (typeof s === 'undefined') s = def;
         let l = typeof len === 'undefined' ? s.length : len;
         let buf = [];
-        for (let i = 0; i < l; l++) {
-            if (i < l) buf.push(s.charCodeAt(i));
-            else buf.push(i);
+        for (let i = 0; i < l; i++) {
+            if (i < s.length) buf.push(s.charCodeAt(i));
+            else buf.push(0);
         }
-        this.payload.splice(start, 0, ...buf);
+        this.payload.splice(start, l, ...buf);
         return this;
     }
     public toPacket(): number[] {
@@ -754,6 +1065,20 @@ export class Outbound extends OutboundCommon {
         pkt.push.apply(pkt, this.term);
         return pkt;
     }
+    public processMock(){
+        // When the port is a mock port, we are no longer sending an
+        // outbound message but converting it to an inbound and
+        // skipping the actual send/receive part of the comms.
+        let inbound = Message.convertOutboundToInbound(this);
+        let port = conn.findPortById(this.portId);
+        if (port.hasAssignedEquipment() || this.portId === sys.anslq25.portId){
+            MessagesMock.process(inbound);
+        }
+        else {
+            inbound.process();
+        }
+    
+    }
 }
 export class Ack extends Outbound {
     constructor(byte: number) {
@@ -805,7 +1130,10 @@ export class Response extends OutboundCommon {
         try {
             if (typeof this.responseBool === 'boolean' && this.responseBool) bresp = this.evalResponse(msgIn, msgOut);
             else return bresp;
-            if (bresp === true && typeof msgOut !== 'undefined') msgIn.responseFor.push(msgOut.id);
+            if (bresp === true && typeof msgOut !== 'undefined') {
+                msgIn.responseFor.push(msgOut.id);
+                logger.silly(`Message in ${msgIn.id} is a response for message out ${msgOut.id}`);
+            }
             return bresp;
         }
         catch (err) { }