nodejs-poolcontroller 8.3.0 → 8.4.1

package/controller/nixie/pumps/Pump.ts

@@ -1,1194 +1,1337 @@
-import { EquipmentNotFoundError, InvalidEquipmentDataError, InvalidEquipmentIdError, ParameterOutOfRangeError } from '../../Errors';
-import { utils, Timestamp } from '../../Constants';
-import { logger } from '../../../logger/Logger';
-
-import { NixieEquipment, NixieChildEquipment, NixieEquipmentCollection, INixieControlPanel } from "../NixieEquipment";
-import { Pump, PumpCircuit, PumpCollection, PumpRelay, sys } from "../../../controller/Equipment";
-import { CircuitState, PumpState, state, } from "../../State";
-import { setTimeout as setTimeoutSync, clearTimeout } from 'timers';
-import { NixieControlPanel } from '../Nixie';
-import { webApp, InterfaceServerResponse } from "../../../web/Server";
-import { Outbound, Protocol, Response } from '../../comms/messages/Messages';
-import { conn } from '../../comms/Comms';
-import { setTimeout } from 'timers/promises';
-
-export class NixiePumpCollection extends NixieEquipmentCollection<NixiePump> {
-    public async deletePumpAsync(id: number) {
-        try {
-            for (let i = this.length - 1; i >= 0; i--) {
-                let pump = this[i];
-                if (pump.id === id) {
-                    await pump.closeAsync();
-                    this.splice(i, 1);
-                }
-            }
-        } catch (err) { logger.error(`Nixie Control Panel deletePumpAsync ${err.message}`); }
-    }
-    public async setPumpStateAsync(pstate: PumpState) {
-        try {
-            let pump: NixiePump = this.find(elem => elem.id === pstate.id) as NixiePump;
-            if (typeof pump === 'undefined') {
-                return logger.error(`Nixie Control Panel Error setPumpState could not find pump ${pstate.id}-${pstate.name}`);
-            }
-            await pump.setPumpStateAsync(pstate);
-        } catch (err) { logger.error(`Nixie Error setting pump state ${pstate.id}-${pstate.name}: ${err.message}`); return Promise.reject(err); }
-    }
-    public async setPumpAsync(pump: Pump, data: any) {
-        // By the time we get here we know that we are in control and this is a Nixie pump.
-        try {
-            let c: NixiePump = this.find(elem => elem.id === pump.id) as NixiePump;
-            if (typeof c === 'undefined') {
-                pump.master = 1;
-                if (typeof data.type !== 'undefined') pump.type = data.type; // needed for init of correct type
-                if (typeof pump.type === 'undefined') return Promise.reject(new InvalidEquipmentIdError(`Invalid pump type for ${pump.name}`, data.id, 'Pump'));
-                c = this.pumpFactory(pump);
-                // c = new NixiePump(this.controlPanel, pump);
-                this.push(c);
-                logger.info(`A pump was not found for id #${pump.id} creating pump`);
-                return await c.setPumpAsync(data);
-            }
-            else {
-                if (typeof data.type !== 'undefined' && c.pump.type !== data.type) {
-                    // pump exists, changing type
-                    await c.closeAsync();
-                    pump.type = data.type; // needed for init of correct type
-                    if (typeof pump.type === 'undefined') return Promise.reject(new InvalidEquipmentIdError(`Invalid pump type for ${pump.name}`, data.id, 'Pump'));
-                    c = this.pumpFactory(pump);
-                }
-                return await c.setPumpAsync(data);
-            }
-        }
-        catch (err) { logger.error(`setPumpAsync: ${err.message}`); return Promise.reject(err); }
-    }
-    public async initAsync(pumps: PumpCollection) {
-        try {
-            for (let i = 0; i < pumps.length; i++) {
-                let pump = pumps.getItemByIndex(i);
-                if (pump.master === 1) {
-                    let p: NixiePump = this.find(elem => elem.id === pump.id) as NixiePump;
-                    if (typeof p === 'undefined') {
-                        let type = sys.board.valueMaps.pumpTypes.getName(pump.type);
-                        let npump = this.pumpFactory(pump);
-                        logger.info(`Initializing Nixie Pump ${npump.id}-${pump.name}`);
-                        this.push(npump);
-                        await npump.initAsync();
-                    }
-                }
-            }
-        }
-        catch (err) { logger.error(`Nixie Pump initAsync Error: ${err.message}`); return Promise.reject(err); }
-    }
-    public async closeAsync() {
-        try {
-            for (let i = this.length - 1; i >= 0; i--) {
-                try {
-                    try {
-                        await this[i].closeAsync();
-                    } catch (err) { logger.error(`Error attempting to close pump ${this[i].id}`); }
-                    this.splice(i, 1);
-                } catch (err) { logger.error(`Error stopping Nixie Pump ${err}`); }
-            }
-        } catch (err) { } // Don't bail if we have an errror.
-    }
-    public async setServiceModeAsync() {
-        try {
-            for (let i = this.length - 1; i >= 0; i--) {
-                try {
-                    let p = this[i] as NixiePump;
-                    await p.setServiceModeAsync();
-                } catch (err) { logger.error(`Error setting service mode for Nixie Pump ${err}`); }
-            }
-        } catch (err) { } // Don't bail if we have an errror.
-    }
-    public async initPumpAsync(pump: Pump): Promise<NixiePump> {
-        try {
-            let c: NixiePump = this.find(elem => elem.id === pump.id) as NixiePump;
-            if (pump.master === 1) {
-                // if pump exists, close it so we can re-init
-                // (EG if pump type changes, we need to setup a new instance of the pump)
-                if (typeof c !== 'undefined' && c.pump.type !== pump.type) {
-                    await c.closeAsync();
-                    await this.deletePumpAsync(pump.id);
-                    c = this.pumpFactory(pump);
-                    this.push(c);
-                }
-                logger.info(`Initializing Existing Nixie Pump ${c.id}-${pump.name}`);
-
-            }
-            return c;
-        } catch (err) { return Promise.reject(logger.error(`Nixie Controller: initPumpAsync Error: ${err.message}`)); }
-    }
-    private pumpFactory(pump: Pump) {
-        let type = sys.board.valueMaps.pumpTypes.getName(pump.type);
-        switch (type) {
-            case 'ss':
-                return new NixiePumpSS(this.controlPanel, pump);
-            case 'ds':
-                return new NixiePumpDS(this.controlPanel, pump);
-            case 'vsf':
-                return new NixiePumpVSF(this.controlPanel, pump);
-            case 'vf':
-                return new NixiePumpVF(this.controlPanel, pump);
-            case 'sf':
-                return new NixiePumpSF(this.controlPanel, pump);
-            case 'vs':
-                return new NixiePumpVS(this.controlPanel, pump);
-            case 'hwvs':
-                return new NixiePumpHWVS(this.controlPanel, pump);
-            case 'hwrly':
-                return new NixiePumpHWRLY(this.controlPanel, pump);
-            case 'regalmodbus':
-                return new NixiePumpRegalModbus(this.controlPanel, pump);
-            default:
-                throw new EquipmentNotFoundError(`NCP: Cannot create pump ${pump.name}.`, type);
-        }
-    }
-    public syncPumpStates() {
-        // loop through all pumps and update rates based on circuit changes
-        // this would happen in <2s anyway based on pollAsync but this is immediate.
-        for (let i = this.length - 1; i >= 0; i--) {
-            let pump = this[i] as NixiePump;
-            if (!pump.suspendPolling) setTimeoutSync(async () => { await pump.pollEquipmentAsync(); }, 100);
-            else {
-                pump.setTargetSpeed(state.pumps.getItemById(pump.id));
-            }
-            // RKS: 05-16-23 - Below backs up the processing.
-            /*
-             
-            setTimeoutSync(async () => {
-                let pump = this[i] as NixiePump;
-                try {
-                    if (!pump.closing) await pump.pollEquipmentAsync();
-                } catch (err) { }
-            }, 100);
-            */
-        }
-    }
-}
-export class NixiePump extends NixieEquipment {
-    public pollingInterval: number = 2000;
-    protected _pollTimer: NodeJS.Timeout = null;
-    public pump: Pump;
-    protected _targetSpeed: number;
-    protected _suspendPolling = 0;
-    public get suspendPolling(): boolean { return this._suspendPolling > 0; }
-    public set suspendPolling(val: boolean) {
-        this._suspendPolling = Math.max(0, this._suspendPolling + (val ? 1 : -1));
-        if (this._suspendPolling > 1) console.log(`Suspend Polling ${this._suspendPolling}`);
-    }
-    public closing = false;
-    public async setServiceModeAsync() {
-        let pstate = state.pumps.getItemById(this.pump.id);
-        await this.setPumpStateAsync(pstate);
-    }
-    /*
-    _targetSpeed will hold values as follows:
-    vs/vsf/vf: rpm/gpm;
-    ss: 0=off, 1=on;
-    ds/sf: bit shift 1-4 = values 1/2/4/8 for relays 1/2/3/4
-    */
-    constructor(ncp: INixieControlPanel, pump: Pump) {
-        super(ncp);
-        this.pump = pump;
-        this._targetSpeed = 0;
-    }
-    public async initAsync() {
-        if (this._pollTimer) {
-            clearTimeout(this._pollTimer);
-            this._pollTimer = undefined;
-        }
-        this.closing = false;
-        this._suspendPolling = 0;
-        this.pollEquipmentAsync();
-    }
-    public get id(): number { return typeof this.pump !== 'undefined' ? this.pump.id : -1; }
-    public async setPumpStateAsync(pstate: PumpState) {
-        try {
-            // Here we go we need to set the pump state.
-            return new InterfaceServerResponse(200, 'Ok');
-        } catch (err) { return Promise.reject(`Nixie Error setting pump state ${pstate.id}-${pstate.name}: ${err.message}`); }
-    }
-    public async setPumpAsync(data: any): Promise<InterfaceServerResponse> {
-        try {
-            this.pump.master = 1;
-            // if (typeof data.isVirtual !== 'undefined') this.pump.isVirtual = data.isVirtual;
-            this.pump.isActive = true;
-            // if (typeof data.type !== 'undefined' && data.type !== this.pump.type) {
-            //     sys.board.pumps.setType(this.pump, data.type);
-            //     this.pump = sys.pumps.getItemById(id, true);
-            //     spump = state.pumps.getItemById(id, true);
-            // }
-            let type = sys.board.valueMaps.pumpTypes.transform(this.pump.type);
-            this.pump.name = data.name || this.pump.name || type.desc;
-            if (typeof type.maxCircuits !== 'undefined' && type.maxCircuits > 0 && typeof data.circuits !== 'undefined') { // This pump type supports circuits
-                for (let i = 1; i <= data.circuits.length && i <= type.maxCircuits; i++) {
-                    let c = data.circuits[i - 1];
-                    c.id = i;
-                    let circuit = parseInt(c.circuit, 10);
-                    let cd = this.pump.circuits.find(elem => elem.circuit === circuit);
-                    let speed = parseInt(c.speed, 10);
-                    let relay = parseInt(c.relay, 10);
-                    let flow = parseInt(c.flow, 10);
-                    let units = typeof c.units !== 'undefined' ? sys.board.valueMaps.pumpUnits.encode(c.units) : undefined;
-                    switch (type.name) {
-                        case 'vf':
-                            units = sys.board.valueMaps.pumpUnits.getValue('gpm');
-                            break;
-                        case 'hwvs':
-                        case 'vssvrs':
-                        case 'vs':
-                        case 'regalmodbus':
-                            c.units = sys.board.valueMaps.pumpUnits.getValue('rpm');
-                            break;
-                        case 'ss':
-                        case 'ds':
-                        case 'sf':
-                        case 'hwrly':
-                            c.units = undefined;
-                            break;
-                    }
-                    if (isNaN(units)) units = typeof cd !== 'undefined' ? cd.units : sys.board.valueMaps.pumpUnits.getValue('rpm');
-                    if (isNaN(speed)) speed = type.minSpeed;
-                    if (isNaN(flow)) flow = type.minFlow;
-                    if (isNaN(relay)) relay = 1;
-                    c.units = units;
-                    //c.units = parseInt(c.units, 10) || type.name === 'vf' ? sys.board.valueMaps.pumpUnits.getValue('gpm') : sys.board.valueMaps.pumpUnits.getValue('rpm');
-                    if (typeof type.minSpeed !== 'undefined' && c.units === sys.board.valueMaps.pumpUnits.getValue('rpm')) {
-                        c.speed = speed;
-                    }
-                    else if (typeof type.minFlow !== 'undefined' && c.units === sys.board.valueMaps.pumpUnits.getValue('gpm')) {
-                        c.flow = flow;
-                    }
-                    else if (type.maxRelays > 0)
-                        c.relay = relay;
-                }
-            }
-            else data.circuits = [];
-            this.pump.set(data); // Sets all the data back to the pump.  This also sets the relays should it exist on the data.
-            let spump = state.pumps.getItemById(this.pump.id, true);
-            spump.name = this.pump.name;
-            spump.address = this.pump.address;
-            spump.type = this.pump.type;
-            sys.pumps.sortById();
-            state.pumps.sortById();
-            this.pump.hasChanged = true;
-            this.pollEquipmentAsync();
-            return Promise.resolve(new InterfaceServerResponse(200, 'Ok'));
-        }
-        catch (err) { logger.error(`Nixie setPumpAsync: ${err.message}`); return Promise.reject(err); }
-    }
-    public async pollEquipmentAsync() {
-        let self = this;
-        try {
-            // RSG 8-2022.  Refactored to add initasync.  With this.pollEquipmentAsync inside the
-            // constructor we could get here before the pump is initialized.  The added check
-            // for the 112 address prevented that previously, but now is just a final fail safe.
-            if (typeof this._pollTimer !== 'undefined' || this._pollTimer) clearTimeout(this._pollTimer);
-            this._pollTimer = null;
-            if (this.suspendPolling || this.closing || this.pump.address > 112) {
-                if (this.suspendPolling) logger.info(`Pump ${this.id} Polling Suspended`);
-                if (this.closing) logger.info(`Pump ${this.id} is closing`);
-                return;
-            }
-            let pstate = state.pumps.getItemById(this.pump.id);
-            this.setTargetSpeed(pstate);
-            await this.setPumpStateAsync(pstate);
-        }
-        catch (err) { logger.error(`Nixie Error running pump sequence - ${err}`); }
-        finally { if (!self.closing) this._pollTimer = setTimeoutSync(async () => await self.pollEquipmentAsync(), self.pollingInterval || 2000); }
-    }
-    private async checkHardwareStatusAsync(connectionId: string, deviceBinding: string) {
-        try {
-            let dev = await NixieEquipment.getDeviceService(connectionId, `/status/device/${deviceBinding}`);
-            return dev;
-        } catch (err) { logger.error(`Nixie Pump checkHardwareStatusAsync: ${err.message}`); return { hasFault: true } }
-    }
-    public async validateSetupAsync(pump: Pump, pstate: PumpState) {
-        try {
-        } catch (err) { logger.error(`Nixie Error checking Pump Hardware ${this.pump.name}: ${err.message}`); return Promise.reject(err); }
-    }
-    public async closeAsync() {
-        try {
-            logger.info(`Nixie Pump closing ${this.pump.name}.`)
-            if (typeof this._pollTimer !== 'undefined' || this._pollTimer) clearTimeout(this._pollTimer);
-            this._pollTimer = null;
-            this._targetSpeed = 0;
-            let pstate = state.pumps.getItemById(this.pump.id);
-            try {
-                await this.setPumpStateAsync(pstate);
-                // Since we are closing we need to not reject.
-            } catch (err) { logger.error(`Nixie Closing pump closeAsync: ${err.message}`); }
-            // This will make sure the timer is dead and we are completely closed.
-            this.closing = true;
-            if (typeof this._pollTimer !== 'undefined' || this._pollTimer) clearTimeout(this._pollTimer);
-            pstate.emitEquipmentChange();
-        }
-        catch (err) { logger.error(`Nixie Pump closeAsync: ${err.message}`); return Promise.reject(err); }
-    }
-    public logData(filename: string, data: any) { this.controlPanel.logData(filename, data); }
-    public setTargetSpeed(pstate: PumpState) { };
-    protected isBodyOn(bodyCode: number) {
-        let assoc = sys.board.valueMaps.pumpBodies.transform(bodyCode);
-        switch (assoc.name) {
-            case 'body1':
-            case 'pool':
-                return state.temps.bodies.getItemById(1).isOn;
-            case 'body2':
-            case 'spa':
-                return state.temps.bodies.getItemById(2).isOn;
-            case 'body3':
-                return state.temps.bodies.getItemById(3).isOn;
-            case 'body4':
-                return state.temps.bodies.getItemById(4).isOn;
-            case 'poolspa':
-                if (sys.equipment.shared && sys.equipment.maxBodies >= 2) {
-                    return state.temps.bodies.getItemById(1).isOn === true || state.temps.bodies.getItemById(2).isOn === true;
-                }
-                else
-                    return state.temps.bodies.getItemById(1).isOn;
-        }
-        return false;
-    }
-}
-export class NixiePumpSS extends NixiePump {
-    public setTargetSpeed(pState: PumpState) {
-        // Turn on ss pumps.
-        let _newSpeed = 0;
-        if (!pState.pumpOnDelay) {
-            let pt = sys.board.valueMaps.pumpTypes.get(this.pump.type);
-            if (pt.maxCircuits === 0 || pt.hasBody) {
-                _newSpeed = this.isBodyOn(this.pump.body) ? 1 : 0;
-                //console.log(`BODY: ${sys.board.bodies.isBodyOn(this.pump.body)} CODE: ${this.pump.body}`);
-            }
-            else if (!pState.pumpOnDelay) {
-                let pumpCircuits: PumpCircuit[] = this.pump.circuits.get();
-                if (!pState.pumpOnDelay) {
-                    for (let i = 0; i < pumpCircuits.length; i++) {
-                        let circ = state.circuits.getInterfaceById(pumpCircuits[i].circuit);
-                        if (circ.isOn) _newSpeed = 1;
-                    }
-                }
-            }
-        }
-        if (this._targetSpeed !== _newSpeed) logger.info(`NCP: Setting Pump ${this.pump.name} to ${_newSpeed > 0 ? 'on' : 'off'}. ${sys.board.bodies.isBodyOn(this.pump.body)}`);
-        if (isNaN(_newSpeed)) _newSpeed = 0;
-        this._targetSpeed = _newSpeed;
-    }
-    public async setServiceModeAsync() {
-        let pstate = state.pumps.getItemById(this.pump.id);
-        pstate.targetSpeed = this._targetSpeed = 0;
-        await this.setPumpStateAsync(pstate);
-    }
-    public async setPumpStateAsync(pstate: PumpState) {
-        let relays: PumpRelay[] = this.pump.relays.get();
-        let relayState = 0;
-        for (let i = 0; i < relays.length; i++) {
-            let pr = relays[i];
-            if (typeof pr.id === 'undefined') pr.id = i + 1; // remove when id is added to dP relays upon save.
-            let isOn = this._targetSpeed >> pr.id - 1 & 1;
-            if (utils.isNullOrEmpty(pr.connectionId) || utils.isNullOrEmpty(pr.deviceBinding)) {
-                // If they haven't set a program for the relay bugger out.
-                if (isOn) relayState |= (1 << pr.id - 1);
-            }
-            else {
-                try {
-                    let res = await NixieEquipment.putDeviceService(pr.connectionId, `/state/device/${pr.deviceBinding}`, { isOn, latch: isOn ? 5000 : undefined });
-                    if (res.status.code === 200) {
-                        if (isOn) relayState |= (1 << pr.id - 1);
-                    }
-                    else pstate.status = 16;
-                }
-                catch (err) {
-                    logger.error(`NCP: Error setting pump ${this.pump.name} relay ${pr.id} to ${isOn ? 'on' : 'off'}.  Error ${err.message}}`);
-                    pstate.status = 16;
-                }
-            }
-        }
-        if (pstate.targetSpeed === 0) {
-            pstate.status = 0;
-            pstate.driveState = 0; // We need to set this if it is a priming cycle but it might not matter for our relay based pumps.
-            pstate.command = 0;
-        }
-        else if (relayState === pstate.targetSpeed) {
-            pstate.status = 1;
-            pstate.driveState = 2;
-            pstate.command = 4;
-        }
-        pstate.relay = relayState;
-        return new InterfaceServerResponse(200, 'Success');
-    }
-}
-export class NixiePumpDS extends NixiePumpSS {
-    public setTargetSpeed(pState: PumpState) {
-        // Turn on sf pumps.  The new speed will be the relays associated with the pump.  I believe when this comes out in the final
-        // wash it should engage all the relays for all speeds associated with the pump.  The pump logic will determine which program is
-        // the one to engage.
-        let _newSpeed = 0;
-        if (!pState.pumpOnDelay) {
-            let pumpCircuits: PumpCircuit[] = this.pump.circuits.get();
-            if (!pState.pumpOnDelay) {
-                for (let i = 0; i < pumpCircuits.length; i++) {
-                    let circ = state.circuits.getInterfaceById(pumpCircuits[i].circuit);
-                    // relay speeds are bit-shifted 'or' based on 1,2,4,8
-                    if (circ.isOn) _newSpeed |= (1 << pumpCircuits[i].relay - 1);
-                }
-            }
-        }
-        if (isNaN(_newSpeed)) _newSpeed = 0;
-        this.logSpeed(_newSpeed);
-        this._targetSpeed = _newSpeed;
-    }
-    public logSpeed(_newSpeed: number) {
-        if (this._targetSpeed !== _newSpeed) logger.info(`NCP: Setting Pump ${this.pump.name} relays to Relay 1: ${_newSpeed & 1 ? 'on' : 'off'}, Relay 2: ${_newSpeed & 2 ? 'on' : 'off'}.`);
-    }
-}
-export class NixiePumpSF extends NixiePumpDS {
-    // effectively operates the same way as a DS pump since we removed the body association on DS.
-    // only logger msg is different
-    public logSpeed(_newSpeed: number) {
-        if (this._targetSpeed !== _newSpeed) logger.info(`NCP: Setting Pump ${this.pump.name} relays to Relay 1: ${_newSpeed & 1 ? 'on' : 'off'}, Relay 2: ${_newSpeed & 2 ? 'on' : 'off'}, Relay 3: ${_newSpeed & 4 ? 'on' : 'off'}, and Relay 4: ${_newSpeed & 8 ? 'on' : 'off'}.`);
-    }
-}
-export class NixiePumpHWRLY extends NixiePumpDS {
-    // This operates as a relay pump with up to 8 speeds.  The speeds are defined as follows.  The override
-    // relay should be defined as being normally closed.  When it opens then the pump will turn on to the speed.
-    // +-------+---------+---------+---------+---------+
-    // + Speed | Relay 1 | Relay 2 | Relay 3 |  OVRD   |
-    // +-------+---------+---------+---------+---------+
-    // |  OFF  |   OFF   |   OFF   |   OFF   |   OFF   |
-    // +-------+---------+---------+---------+---------+
-    // |   1   |   OFF   |   OFF   |   OFF   |   ON    |
-    // +-------+---------+---------+---------+---------+
-    // |   2   |   ON    |   OFF   |   OFF   |   ON    |
-    // +-------+---------+---------+---------+---------+
-    // |   3   |   OFF   |   ON    |   OFF   |   ON    |
-    // +-------+---------+---------+---------+---------+
-    // |   4   |   ON    |   ON    |   OFF   |   ON    |
-    // +-------+---------+---------+---------+---------+
-    // |   5   |   OFF   |   OFF   |   ON    |   ON    |
-    // +-------+---------+---------+---------+---------+
-    // |   6   |   ON    |   OFF   |   ON    |   ON    |
-    // +-------+---------+---------+---------+---------+
-    // |   7   |   OFF   |   ON    |   ON    |   ON    |
-    // +-------+---------+---------+---------+---------+
-    // |   8   |   ON    |   ON    |   ON    |   ON    |
-    // +-------+---------+---------+---------+---------+
-
-    public setTargetSpeed(pState: PumpState) {
-        let _newSpeed = 0;
-        if (!pState.pumpOnDelay) {
-            let pumpCircuits = this.pump.circuits.get();
-            for (let i = 0; i < pumpCircuits.length; i++) {
-                let circ = state.circuits.getInterfaceById(pumpCircuits[i].circuit);
-                let pc = pumpCircuits[i];
-                if (circ.isOn) {
-                    _newSpeed = Math.max(_newSpeed, pc.relay);
-                }
-            }
-        }
-        if (isNaN(_newSpeed)) _newSpeed = 0;
-        this._targetSpeed = _newSpeed;
-        if (this._targetSpeed !== 0) Math.min(Math.max(this.pump.minSpeed, this._targetSpeed), this.pump.maxSpeed);
-        if (this._targetSpeed !== _newSpeed) logger.info(`NCP: Setting Pump ${this.pump.name} to ${_newSpeed}.`);
-    }
-    public async setPumpStateAsync(pstate: PumpState) {
-        // Don't poll while we are seting the state.
-        this.suspendPolling = true;
-        try {
-            let relays: PumpRelay[] = this.pump.relays.get();
-            let relayState = 0;
-            let targetState = 0;
-            for (let i = 0; i < relays.length; i++) {
-                let pr = relays[i];
-                if (typeof pr.id === 'undefined') pr.id = i + 1; // remove when id is added to dP relays upon save.
-                // If we are turning on the pump relay #4 needs to be on.  NOTE: It is expected that the OVRD relay is hooked up in a normally closed
-                // configuration so that whenever the pump is off the relay terminals are closed.
-                let isOn = this._targetSpeed > 0 ? i === 3 ? true : (this._targetSpeed - 1 & (1 << i)) > 0 : false;
-                let bit = isOn ? (1 << i) : 0;
-                targetState |= bit;
-                if (utils.isNullOrEmpty(pr.connectionId) || utils.isNullOrEmpty(pr.deviceBinding)) {
-                    // Determine whether the relay should be on.
-                    relayState |= bit;
-                }
-                else {
-                    try {
-                        let res = await NixieEquipment.putDeviceService(pr.connectionId, `/state/device/${pr.deviceBinding}`, { isOn, latch: isOn ? 5000 : undefined });
-                        if (res.status.code === 200) {
-                            relayState |= bit;
-                        }
-                        else pstate.status = 16;
-                    }
-                    catch (err) {
-                        logger.error(`NCP: Error setting pump ${this.pump.name} relay ${pr.id} to ${isOn ? 'on' : 'off'}.  Error ${err.message}}`);
-                        pstate.status = 16;
-                    }
-                }
-            }
-            pstate.command = this._targetSpeed;
-            if (targetState === relayState) {
-                pstate.status = relayState > 0 ? 1 : 0;
-                pstate.driveState = relayState > 0 ? 2 : 0;
-                pstate.relay = relayState;
-            }
-            else {
-                pstate.driveState = 0;
-            }
-            return new InterfaceServerResponse(200, 'Success');
-        }
-        catch (err) {
-            logger.error(`Error running pump sequence for ${this.pump.name}: ${err.message}`);
-            return Promise.reject(err);
-        }
-        finally { this.suspendPolling = false; }
-    };
-
-}
-export class NixiePumpRS485 extends NixiePump {
-    public async setServiceModeAsync() {
-        this._targetSpeed = 0;
-        await this.setDriveStateAsync(false);
-        await this.setPumpToRemoteControlAsync(false);
-    }
-    public async setPumpStateAsync(pstate: PumpState) {
-        // Don't poll while we are seting the state.
-        this.suspendPolling = true;
-        try {
-            let pt = sys.board.valueMaps.pumpTypes.get(this.pump.type);
-            if (state.mode === 0) {
-                // Since these process are async the closing flag can be set
-                // between calls.  We need to check it in between each call.
-                if (!this.closing) await this.setDriveStateAsync();
-                if (!this.closing) {
-                    if (this._targetSpeed >= pt.minFlow && this._targetSpeed <= pt.maxFlow) await this.setPumpGPMAsync();
-                    else if (this._targetSpeed >= pt.minSpeed && this._targetSpeed <= pt.maxSpeed) await this.setPumpRPMAsync();
-                }
-                ;
-                if (!this.closing && pt.name !== 'vsf' && pt.name !== 'vs') await this.setPumpFeatureAsync(6);;
-                if (!this.closing) await setTimeout(1000);;
-                if (!this.closing) await this.requestPumpStatusAsync();;
-                if (!this.closing) await this.setPumpToRemoteControlAsync();;
-            }
-            return new InterfaceServerResponse(200, 'Success');
-        }
-        catch (err) {
-            logger.error(`Error running pump sequence for ${this.pump.name}: ${err.message}`);
-            return Promise.reject(err);
-        }
-        finally { this.suspendPolling = false; }
-    };
-    protected async setDriveStateAsync(running: boolean = true) {
-        try {
-            if (conn.isPortEnabled(this.pump.portId || 0)) {
-                let out = Outbound.create({
-                    portId: this.pump.portId || 0,
-                    protocol: Protocol.Pump,
-                    dest: this.pump.address,
-                    action: 6,
-                    payload: running && this._targetSpeed > 0 ? [10] : [4],
-                    retries: 1,
-                    response: true
-                });
-                try {
-                    await out.sendAsync();
-                }
-                catch (err) {
-                    logger.error(`Error sending setDriveState for ${this.pump.name}: ${err.message}`);
-                }
-            }
-            else {
-                let pstate = state.pumps.getItemById(this.pump.id);
-                pstate.command = pstate.rpm > 0 || pstate.flow > 0 ? 10 : 0;
-            }
-        } catch (err) { logger.error(`Error setting driveState for ${this.pump.name}: ${err.message}`); }
-    };
-    protected async requestPumpStatusAsync() {
-        if (conn.isPortEnabled(this.pump.portId || 0)) {
-            let out = Outbound.create({
-                portId: this.pump.portId || 0,
-                protocol: Protocol.Pump,
-                dest: this.pump.address,
-                action: 7,
-                payload: [],
-                retries: 2,
-                response: true,
-            });
-            try {
-                await out.sendAsync();
-            }
-            catch (err) {
-                logger.error(`Error sending requestPumpStatus for ${this.pump.name}: ${err.message}`);
-            }
-        }
-    };
-    protected async setPumpToRemoteControlAsync(running: boolean = true) {
-        try {
-            if (conn.isPortEnabled(this.pump.portId || 0)) {
-                let out = Outbound.create({
-                    portId: this.pump.portId || 0,
-                    protocol: Protocol.Pump,
-                    dest: this.pump.address,
-                    action: 4,
-                    payload: running ? [255] : [0], // when stopAsync is called, pass false to return control to pump panel
-                    retries: 1,
-                    response: true
-                });
-                try {
-                    await out.sendAsync();
-                }
-                catch (err) {
-                    logger.error(`Error sending setPumpToRemoteControl for ${this.pump.name}: ${err.message}`);
-                }
-            }
-        } catch (err) { logger.error(`Error setting pump to Remote Control for ${this.pump.name}: ${err.message}`); }
-    }
-    protected async setPumpFeatureAsync(feature?: number) {
-        // empty payload (possibly 0?, too) is no feature
-        // 6: Feature 1
-        try {
-            if (conn.isPortEnabled(this.pump.portId || 0)) {
-                let out = Outbound.create({
-                    portId: this.pump.portId || 0,
-                    protocol: Protocol.Pump,
-                    dest: this.pump.address,
-                    action: 5,
-                    payload: typeof feature === 'undefined' ? [] : [feature],
-                    retries: 2,
-                    response: true
-                });
-                try {
-                    await out.sendAsync();
-                }
-                catch (err) {
-                    logger.error(`Error sending setPumpFeature for ${this.pump.name}: ${err.message}`);
-                }
-            }
-        } catch (err) { logger.error(`Error setting pump feature for ${this.pump.name}: ${err.message}`); }
-    };
-    protected async setPumpRPMAsync() {
-        if (conn.isPortEnabled(this.pump.portId || 0)) {
-            let out = Outbound.create({
-                portId: this.pump.portId || 0,
-                protocol: Protocol.Pump,
-                dest: this.pump.address,
-                action: 1,
-                payload: [2, 196, Math.floor(this._targetSpeed / 256), this._targetSpeed % 256],
-                retries: 1,
-                // timeout: 250,
-                response: true
-            });
-            try {
-                await out.sendAsync();
-            }
-            catch (err) {
-                logger.error(`Error sending setPumpRPMAsync for ${this.pump.name}: ${err.message}`);
-            }
-        }
-    };
-    protected async setPumpGPMAsync() {
-        // packet for vf; vsf will override
-        if (conn.isPortEnabled(this.pump.portId || 0)) {
-            let out = Outbound.create({
-                portId: this.pump.portId || 0,
-                protocol: Protocol.Pump,
-                dest: this.pump.address,
-                action: 1,
-                payload: [2, 228, 0, this._targetSpeed],
-                retries: 1,
-                response: true
-            });
-            try {
-                await out.sendAsync();
-            }
-            catch (err) {
-                logger.error(`Error sending setPumpGPMAsync for ${this.pump.name}: ${err.message}`);
-            }
-        }
-    };
-    public async closeAsync() {
-        try {
-            this.suspendPolling = true;
-            logger.info(`Nixie Pump closing ${this.pump.name}.`)
-            if (typeof this._pollTimer !== 'undefined' || this._pollTimer) clearTimeout(this._pollTimer);
-            this._pollTimer = null;
-            this.closing = true;
-            let pt = sys.board.valueMaps.pumpTypes.get(this.pump.type);
-            let pstate = state.pumps.getItemById(this.pump.id);
-            this._targetSpeed = 0;
-            await this.setDriveStateAsync(false);
-            if (!this.closing && pt.name !== 'vsf' && pt.name !== 'vs') await this.setPumpFeatureAsync();
-            //await this.setPumpFeature(); 
-            //await this.setDriveStateAsync(false); 
-            await this.setPumpToRemoteControlAsync(false);
-            // Make sure the polling timer is dead after we have closed this all off.  That way we do not
-            // have another process that revives it from the dead.
-            if (typeof this._pollTimer !== 'undefined' || this._pollTimer) clearTimeout(this._pollTimer);
-            this._pollTimer = null;
-            pstate.emitEquipmentChange();
-        }
-        catch (err) { logger.error(`Nixie Pump closeAsync: ${err.message}`); return Promise.reject(err); }
-        finally { this.suspendPolling = false; }
-    }
-}
-export class NixiePumpVS extends NixiePumpRS485 {
-    public setTargetSpeed(pState: PumpState) {
-        let _newSpeed = 0;
-        if (!pState.pumpOnDelay) {
-            let pumpCircuits = this.pump.circuits.get();
-
-            for (let i = 0; i < pumpCircuits.length; i++) {
-                let circ = state.circuits.getInterfaceById(pumpCircuits[i].circuit);
-                let pc = pumpCircuits[i];
-                if (circ.isOn) _newSpeed = Math.max(_newSpeed, pc.speed);
-            }
-        }
-        if (isNaN(_newSpeed)) _newSpeed = 0;
-        this._targetSpeed = _newSpeed;
-        if (this._targetSpeed !== 0) Math.min(Math.max(this.pump.minSpeed, this._targetSpeed), this.pump.maxSpeed);
-        if (this._targetSpeed !== _newSpeed) logger.info(`NCP: Setting Pump ${this.pump.name} to ${_newSpeed} RPM.`);
-    }
-}
-export class NixiePumpVF extends NixiePumpRS485 {
-    public setTargetSpeed(pState: PumpState) {
-        let _newSpeed = 0;
-        if (!pState.pumpOnDelay) {
-            let pumpCircuits = this.pump.circuits.get();
-            for (let i = 0; i < pumpCircuits.length; i++) {
-                let circ = state.circuits.getInterfaceById(pumpCircuits[i].circuit);
-                let pc = pumpCircuits[i];
-                if (circ.isOn) _newSpeed = Math.max(_newSpeed, pc.flow);
-            }
-        }
-        if (isNaN(_newSpeed)) _newSpeed = 0;
-        this._targetSpeed = _newSpeed;
-        if (this._targetSpeed !== 0) Math.min(Math.max(this.pump.minFlow, this._targetSpeed), this.pump.maxFlow);
-        if (this._targetSpeed !== _newSpeed) logger.info(`NCP: Setting Pump ${this.pump.name} to ${_newSpeed} GPM.`);
-    }
-    public async setPumpStateAsync(pstate: PumpState) {
-        // Don't poll while we are seting the state.
-        this.suspendPolling = true;
-        try {
-            let pt = sys.board.valueMaps.pumpTypes.get(this.pump.type);
-            if (state.mode === 0) {
-                // Since these process are async the closing flag can be set
-                // between calls.  We need to check it in between each call. // 4, 6, 5,  7
-                // When we are 0 then it sends 4[255], 6[4], 5[6]
-                // When we are not 0 then it sends 4[255], 6[10], 5[6], 1[flow]
-                if (!this.closing) await this.setPumpToRemoteControlAsync(); // Action 4
-                if (!this.closing && this._targetSpeed > 0) await this.setPumpGPMAsync(); // Action 1
-                if (!this.closing && this._targetSpeed > 0) await this.setPumpFeatureAsync(6); // Action 5
-                // RKS: 07-21-24 - This used to send an empty payload when the pump should be off.  For VF pumps it
-                // appears that not setting the feature or target flow will set the pump off when it gets to
-                // the drive state.
-                //if (!this.closing) await this.setPumpFeatureAsync(this._targetSpeed > 0 ? 6 : undefined); // Action 5
-                if (!this.closing) await this.setDriveStateAsync();         // Action 6
-                if (!this.closing) await setTimeout(200);
-                if (!this.closing) await this.requestPumpStatusAsync(); // Action 7
-            }
-            return new InterfaceServerResponse(200, 'Success');
-        }
-        catch (err) {
-            logger.error(`Error running pump sequence for ${this.pump.name}: ${err.message}`);
-            return Promise.reject(err);
-        }
-        finally { this.suspendPolling = false; }
-    };
-}
-export class NixiePumpVSF extends NixiePumpRS485 {
-    public setTargetSpeed(pState: PumpState) {
-        let _newSpeed = 0;
-        let maxRPM = 0;
-        let maxGPM = 0;
-        let useFlow = false;
-        if (!pState.pumpOnDelay) {
-            let pumpCircuits = this.pump.circuits.get();
-            let pt = sys.board.valueMaps.pumpTypes.get(this.pump.type);
-            // VSF pumps present a problem.  In fact they do not currently operate properly on Touch panels.  On touch these need to either be all in RPM or GPM
-            // if there is a mix in the circuit array then they will not work.  In IntelliCenter if there is an RPM setting in the mix it will use RPM by converting
-            // the GPM to RPM but if there is none then it will use GPM.
-            let toRPM = (flowRate: number, minSpeed: number = 450, maxSpeed: number = 3450) => {
-                // eff = 114.4365
-                // gpm = 80
-                // speed = 2412
-                let eff = .03317 * maxSpeed;
-                let rpm = Math.min(Math.round((flowRate * maxSpeed) / eff), maxSpeed);
-                return rpm > 0 ? Math.max(rpm, minSpeed) : 0;
-            };
-            let toGPM = (speed: number, maxSpeed: number = 3450, minFlow: number = 15, maxFlow: number = 140) => {
-                // eff = 114.4365
-                // speed = 1100
-                // gpm = (114.4365 * 1100)/3450 = 36
-                let eff = .03317 * maxSpeed;
-                let gpm = Math.min(Math.round((eff * speed) / maxSpeed), maxFlow);
-                return gpm > 0 ? Math.max(gpm, minFlow) : 0;
-            }
-            for (let i = 0; i < pumpCircuits.length; i++) {
-                let circ = state.circuits.getInterfaceById(pumpCircuits[i].circuit);
-                let pc = pumpCircuits[i];
-                if (circ.isOn) {
-                    if (pc.units > 0) {
-                        let rpm = toRPM(pc.flow, pt.minSpeed, pt.MaxSpeed);
-                        if (rpm > maxRPM) useFlow = true;
-                        maxGPM = Math.max(maxGPM, pc.flow);
-                        rpm = Math.max(maxRPM, rpm);
-                    }
-                    else {
-                        let gpm = toGPM(pc.speed, pt.maxSpeed, pt.minFlow, pt.maxFlow);
-                        if (gpm > maxGPM) useFlow = false;
-                        maxRPM = Math.max(maxRPM, pc.speed);
-                        maxGPM = Math.max(maxGPM, gpm);
-                    }
-                }
-            }
-            _newSpeed = useFlow ? maxGPM : maxRPM;
-        }
-        if (isNaN(_newSpeed)) _newSpeed = 0;
-        // Send the flow message if it is flow and the rpm message if it is rpm.
-        if (this._targetSpeed !== _newSpeed) logger.info(`NCP: Setting Pump ${this.pump.name} to ${_newSpeed} ${useFlow ? 'GPM' : 'RPM'}.`);
-        this._targetSpeed = _newSpeed;
-    }
-    protected async setPumpRPMAsync() {
-        // vsf action is 10 for rpm
-        if (conn.isPortEnabled(this.pump.portId || 0)) {
-            let out = Outbound.create({
-                portId: this.pump.portId || 0,
-                protocol: Protocol.Pump,
-                dest: this.pump.address,
-                action: 10,
-                payload: [2, 196, Math.floor(this._targetSpeed / 256), this._targetSpeed % 256],
-                retries: 1,
-                // timeout: 250,
-                response: true
-            });
-            try {
-                await out.sendAsync();
-            }
-            catch (err) {
-                logger.error(`Error sending setPumpRPMAsync for ${this.pump.name}: ${err.message}`);
-            }
-        }
-    };
-    protected async setPumpGPMAsync() {
-        // vsf payload; different from vf payload
-        if (conn.isPortEnabled(this.pump.portId || 0)) {
-            let out = Outbound.create({
-                portId: this.pump.portId || 0,
-                protocol: Protocol.Pump,
-                dest: this.pump.address,
-                action: 9,
-                payload: [2, 196, 0, this._targetSpeed],
-                retries: 1,
-                response: true
-            });
-            try {
-                await out.sendAsync();
-            }
-            catch (err) {
-                logger.error(`Error sending setPumpGPMAsync for ${this.pump.name}: ${err.message}`);
-            }
-        }
-    };
-};
-export class NixiePumpHWVS extends NixiePumpRS485 {
-    public setTargetSpeed(pState: PumpState) {
-        let _newSpeed = 0;
-        if (!pState.pumpOnDelay) {
-            let pumpCircuits = this.pump.circuits.get();
-
-            for (let i = 0; i < pumpCircuits.length; i++) {
-                let circ = state.circuits.getInterfaceById(pumpCircuits[i].circuit);
-                let pc = pumpCircuits[i];
-                if (circ.isOn) _newSpeed = Math.max(_newSpeed, pc.speed);
-            }
-        }
-        if (isNaN(_newSpeed)) _newSpeed = 0;
-        this._targetSpeed = _newSpeed;
-        if (this._targetSpeed !== 0) Math.min(Math.max(this.pump.minSpeed, this._targetSpeed), this.pump.maxSpeed);
-        if (this._targetSpeed !== _newSpeed) logger.info(`NCP: Setting Pump ${this.pump.name} to ${_newSpeed} RPM.`);
-    }
-    public async setServiceModeAsync() {
-        this._targetSpeed = 0;
-        await this.setPumpRPMAsync();
-    }
-    public async setDriveStateAsync(running: boolean = false) { return Promise.resolve(); }
-    public async setPumpStateAsync(pstate: PumpState) {
-        // Don't poll while we are seting the state.
-        this.suspendPolling = true;
-        try {
-            // Since these process are async the closing flag can be set
-            // between calls.  We need to check it in between each call.
-            if (!this.closing) { await this.setPumpRPMAsync(); }
-            return new InterfaceServerResponse(200, 'Success');
-        }
-        catch (err) {
-            logger.error(`Error running pump sequence for ${this.pump.name}: ${err.message}`);
-            return Promise.reject(err);
-        }
-        finally { this.suspendPolling = false; }
-    };
-    protected async requestPumpStatusAsync() { return Promise.resolve(); };
-    protected setPumpFeatureAsync(feature?: number) { return Promise.resolve(); }
-    protected async setPumpToRemoteControlAsync(running: boolean = true) {
-        try {
-            // We do nothing on this pump to set it to remote control.  That is unless we are turning it off.
-            if (conn.isPortEnabled(this.pump.portId || 0)) {
-                if (!running) {
-                    let out = Outbound.create({
-                        portId: this.pump.portId || 0,
-                        protocol: Protocol.Hayward,
-                        source: 12, // Use the broadcast address
-                        dest: this.pump.address,
-                        action: 1,
-                        payload: [0], // when stopAsync is called, pass false to return control to pump panel
-                        // payload: spump.virtualControllerStatus === sys.board.valueMaps.virtualControllerStatus.getValue('running') ? [255] : [0],
-                        retries: 1,
-                        response: Response.create({ protocol: Protocol.Hayward, action: 12, source: this.pump.address - 96 })
-                    });
-                    try {
-                        await out.sendAsync();
-                    }
-                    catch (err) {
-                        logger.error(`Error sending setPumpToRemoteControl for ${this.pump.name}: ${err.message}`);
-
-                    }
-                }
-            }
-        } catch(err) { `Error sending setPumpToRemoteControl message for ${this.pump.name}: ${err.message}` };
-    }
-    protected async setPumpRPMAsync() {
-        // Address 1
-        //[][16, 2, 12, 1, 0][41][0, 72, 16, 3] out
-        //[][16, 2, 0, 12, 0][0, 41, 0, 135][0, 206, 16, 3] In
-        // Address 2
-        //[][16, 2, 12, 1, 1][100][0, 132, 16, 3] out
-        //[][16, 2, 0, 12, 1][0, 96, 21, 64][0, 212, 16, 3] in
-        // Note that action 12 is in a different position for the outbound than the inbound.  The source and destination are kind
-        // of a misnomer in that it identifies the equipment address in byte(4) of the header and flips the command address around.
-        // So in essence for equipment item 0-16 (pump addresses) the outbound is really a broadcast on 12 (broadcast) from 1 and the inbound is
-        // broadcast from the equipment item to 0 (anybody).
-        if (conn.isPortEnabled(this.pump.portId || 0)) {
-            let pt = sys.board.valueMaps.pumpTypes.get(this.pump.type);
-            let out = Outbound.create({
-                portId: this.pump.portId || 0,
-                protocol: Protocol.Hayward,
-                source: 1, // Use the broadcast address
-                dest: this.pump.address - 96,
-                action: 12,
-                payload: [Math.min(Math.round((this._targetSpeed / pt.maxSpeed) * 100), 100)], // when stopAsync is called, pass false to return control to pump panel
-                retries: 1,
-                response: Response.create({ protocol: Protocol.Hayward, action: 12, source: this.pump.address - 96 })
-            });
-            try {
-                await out.sendAsync();
-            }
-            catch (err) {
-                logger.error(`Error sending setPumpRPM for ${this.pump.name}: ${err.message}`);
-                let pstate = state.pumps.getItemById(this.pump.id);
-                pstate.command = 0;
-                pstate.rpm = 0;
-                pstate.watts = 0;
-            }
-        }
-        else {
-            let pstate = state.pumps.getItemById(this.pump.id);
-            pstate.command = 0;
-            pstate.rpm = 0;
-            pstate.watts = 0;
-        }
-
-    };
-}
-
-export class NixiePumpRegalModbus extends NixiePump {
-
-    constructor(ncp: INixieControlPanel, pump: Pump) {
-        super(ncp, pump);
-        // this.pump = pump;
-        // this._targetSpeed = 0;
-    }
-
-    public setTargetSpeed(pumpState: PumpState) {
-        let newSpeed = 0;
-        if (!pumpState.pumpOnDelay) {
-            let circuitConfigs = this.pump.circuits.get();
-            for (let i = 0; i < circuitConfigs.length; i++) {
-                let circuitConfig = circuitConfigs[i];
-                let circ = state.circuits.getInterfaceById(circuitConfig.circuit);
-                if (circ.isOn) newSpeed = Math.max(newSpeed, circuitConfig.speed);
-            }
-        }
-        if (isNaN(newSpeed)) newSpeed = 0;
-        this._targetSpeed = newSpeed;
-        if (this._targetSpeed !== 0) Math.min(Math.max(this.pump.minSpeed, this._targetSpeed), this.pump.maxSpeed);
-        if (this._targetSpeed !== newSpeed) logger.info(`NCP: Setting Pump ${this.pump.name} to ${newSpeed} RPM.`);
-    }
-    
-    public async setServiceModeAsync() {
-        this._targetSpeed = 0;
-        await this.setDriveStateAsync(false);
-        // await this.setPumpToRemoteControlAsync(false);
-    }
-
-    public async setPumpStateAsync(pstate: PumpState) {
-        // Don't poll while we are seting the state.
-        this.suspendPolling = true;
-        try {
-            let pt = sys.board.valueMaps.pumpTypes.get(this.pump.type);
-            if (state.mode === 0) {
-                // Since these process are async the closing flag can be set
-                // between calls.  We need to check it in between each call.
-                if (!this.closing) {
-                    if (this._targetSpeed >= pt.minSpeed && this._targetSpeed <= pt.maxSpeed) await this.setPumpRPMAsync();
-                }
-                if (!this.closing) await this.setDriveStateAsync();
-                ;
-                // if (!this.closing && pt.name !== 'vsf' && pt.name !== 'vs') await this.setPumpFeatureAsync(6);;
-                if (!this.closing) await setTimeout(1000);;
-                if (!this.closing) await this.requestPumpStatusAsync();;
-                // if (!this.closing) await this.setPumpToRemoteControlAsync();;
-            }
-            return new InterfaceServerResponse(200, 'Success');
-        }
-        catch (err) {
-            logger.error(`Error running pump sequence for ${this.pump.name}: ${err.message}`);
-            return Promise.reject(err);
-        }
-        finally { this.suspendPolling = false; }
-    };
-    protected async setDriveStateAsync(isRunning: boolean = true) {
-        let functionCode = this._targetSpeed > 0 ? 0x41 : 0x42;
-        logger.debug(`NixiePumpRegalModbus: setDriveStateAsync ${this.pump.name} ${functionCode == 0x41 ? 'RUN' : functionCode == 0x42 ? 'STOP' : 'UNKNOWN'}`);
-        try {
-            if (conn.isPortEnabled(this.pump.portId || 0)) {
-                let functionCode = this._targetSpeed > 0 ? 0x41 : 0x42;
-                let out = Outbound.create({
-                    portId: this.pump.portId || 0,
-                    protocol: Protocol.RegalModbus,
-                    dest: this.pump.address,
-                    action: functionCode,
-                    payload: [],
-                    retries: 1,
-                    response: true
-                });
-                try {
-                    await out.sendAsync();
-                }
-                catch (err) {
-                    logger.error(`Error sending setDriveState for ${this.pump.name}: ${err.message}`);
-                }
-            }
-            else {
-                let pumpState = state.pumps.getItemById(this.pump.id);
-                pumpState.command = pumpState.rpm > 0 || pumpState.flow > 0 ? 10 : 0;  // dashPanel needs this to be set to 10 for running.
-            }
-        } catch (err) { logger.error(`Error setting driveState for ${this.pump.name}: ${err.message}`); }
-    };
-
-    protected async requestPumpDriveStateAsync() {
-        if (conn.isPortEnabled(this.pump.portId || 0)) {
-            let out = Outbound.create({
-                portId: this.pump.portId || 0,
-                protocol: Protocol.RegalModbus,
-                dest: this.pump.address,
-                action: 0x43,
-                payload: [],
-                retries: 2,
-                response: true,
-            });
-            try {
-                await out.sendAsync();
-            }
-            catch (err) {
-                logger.error(`Error sending requestPumpDriveState for ${this.pump.name}: ${err.message}`);
-            }
-        }
-    }
-
-    protected async requestSensorAsync(page: number, sensorAddr: number, retries: number = 2) {
-        if (conn.isPortEnabled(this.pump.portId || 0)) {
-            let out = Outbound.create({
-                portId: this.pump.portId || 0,
-                protocol: Protocol.RegalModbus,
-                dest: this.pump.address,
-                action: 0x45,
-                payload: [page, sensorAddr],
-                retries: retries,
-                response: true,
-            });
-            try {
-                await out.sendAsync();
-            }
-            catch (err) {
-                logger.error(`Error sending requestSensor for ${this.pump.name} page ${page} sensor ${sensorAddr}: ${err.message}`);
-            }
-        }
-    }
-
-    protected async requestPumpStatusAsync() {
-
-        await this.requestPumpDriveStateAsync();
-        await this.requestSensorAsync(0, 0x00);  // motor speed
-        // await this.requestSensorAsync(0, 0x01);  // motor current
-        // await this.requestSensorAsync(0, 0x04);  // torque
-        // await this.requestSensorAsync(0, 0x05);  // inverter input power
-        // await this.requestSensorAsync(0, 0x06);  // DC bus voltage
-        // await this.requestSensorAsync(0, 0x07);  // ambient temperature
-        await this.requestSensorAsync(0, 0x0A);  // output power
-        // await this.requestSensorAsync(0, 0x0D);  // motor line voltage
-        // await this.requestSensorAsync(0, 0x0E);  // ramp status
-        // await this.requestSensorAsync(0, 0x0F);  // no of total fault
-        // await this.requestSensorAsync(0, 0x10);  // prime status
-        // await this.requestSensorAsync(0, 0x11);  // motor input power
-        // await this.requestSensorAsync(0, 0x12);  // IGBT temperature
-        // await this.requestSensorAsync(0, 0x13);  // PCB temperature
-    };
-
-    protected async setPumpRPMAsync() {
-        logger.debug(`NixiePumpRegalModbus: setPumpRPMAsync ${this.pump.name} ${this._targetSpeed}`);
-        if (conn.isPortEnabled(this.pump.portId || 0)) {
-            // get demand bytes from rpm
-            const mode = 0x00; // 0x00 for speed control mode
-            const demandLo = Math.round(this._targetSpeed * 4) & 0xFF;
-            const demandHi = (Math.round(this._targetSpeed * 4) >> 8) & 0xFF;
-            let out = Outbound.create({
-                portId: this.pump.portId || 0,
-                protocol: Protocol.RegalModbus,
-                dest: this.pump.address,
-                action: 0x44,
-                payload: [mode, demandLo, demandHi],
-                retries: 1,
-                // timeout: 250,
-                response: true
-            });
-            try {
-                await out.sendAsync();
-            }
-            catch (err) {
-                logger.error(`Error sending setPumpRPMAsync for ${this.pump.name}: ${err.message}`);
-            }
-        }
-    };
-    public async closeAsync() {
-        try {
-            this.suspendPolling = true;
-            logger.info(`Nixie Pump closing ${this.pump.name}.`)
-            if (typeof this._pollTimer !== 'undefined' || this._pollTimer) clearTimeout(this._pollTimer);
-            this._pollTimer = null;
-            this.closing = true;
-            let pumpType = sys.board.valueMaps.pumpTypes.get(this.pump.type);
-            let pumpState = state.pumps.getItemById(this.pump.id);
-            this._targetSpeed = 0;
-            await this.setDriveStateAsync(false);
-            // if (!this.closing && pt.name !== 'vsf' && pt.name !== 'vs') await this.setPumpFeatureAsync();
-            //await this.setPumpFeature(); 
-            //await this.setDriveStateAsync(false); 
-            // await this.setPumpToRemoteControlAsync(false);
-            // Make sure the polling timer is dead after we have closed this all off.  That way we do not
-            // have another process that revives it from the dead.
-            if (typeof this._pollTimer !== 'undefined' || this._pollTimer) clearTimeout(this._pollTimer);
-            this._pollTimer = null;
-            pumpState.emitEquipmentChange();
-        }
-        catch (err) { logger.error(`Nixie Pump closeAsync: ${err.message}`); return Promise.reject(err); }
-        finally { this.suspendPolling = false; }
-    }
+import { EquipmentNotFoundError, InvalidEquipmentDataError, InvalidEquipmentIdError, ParameterOutOfRangeError } from '../../Errors';
+import { utils, Timestamp } from '../../Constants';
+import { logger } from '../../../logger/Logger';
+
+import { NixieEquipment, NixieChildEquipment, NixieEquipmentCollection, INixieControlPanel } from "../NixieEquipment";
+import { Pump, PumpCircuit, PumpCollection, PumpRelay, sys } from "../../../controller/Equipment";
+import { CircuitState, PumpState, state, } from "../../State";
+import { setTimeout as setTimeoutSync, clearTimeout } from 'timers';
+import { NixieControlPanel } from '../Nixie';
+import { webApp, InterfaceServerResponse } from "../../../web/Server";
+import { Outbound, Protocol, Response } from '../../comms/messages/Messages';
+import { conn } from '../../comms/Comms';
+import { setTimeout } from 'timers/promises';
+import { NeptuneModbusStateMessage } from '../../comms/messages/status/NeptuneModbusStateMessage';
+
+export class NixiePumpCollection extends NixieEquipmentCollection<NixiePump> {
+    public async deletePumpAsync(id: number) {
+        try {
+            for (let i = this.length - 1; i >= 0; i--) {
+                let pump = this[i];
+                if (pump.id === id) {
+                    await pump.closeAsync();
+                    this.splice(i, 1);
+                }
+            }
+        } catch (err) { logger.error(`Nixie Control Panel deletePumpAsync ${err.message}`); }
+    }
+    public async setPumpStateAsync(pstate: PumpState) {
+        try {
+            let pump: NixiePump = this.find(elem => elem.id === pstate.id) as NixiePump;
+            if (typeof pump === 'undefined') {
+                return logger.error(`Nixie Control Panel Error setPumpState could not find pump ${pstate.id}-${pstate.name}`);
+            }
+            await pump.setPumpStateAsync(pstate);
+        } catch (err) { logger.error(`Nixie Error setting pump state ${pstate.id}-${pstate.name}: ${err.message}`); return Promise.reject(err); }
+    }
+    public async setPumpAsync(pump: Pump, data: any) {
+        // By the time we get here we know that we are in control and this is a Nixie pump.
+        try {
+            let c: NixiePump = this.find(elem => elem.id === pump.id) as NixiePump;
+            if (typeof c === 'undefined') {
+                pump.master = 1;
+                if (typeof data.type !== 'undefined') pump.type = data.type; // needed for init of correct type
+                if (typeof pump.type === 'undefined') return Promise.reject(new InvalidEquipmentIdError(`Invalid pump type for ${pump.name}`, data.id, 'Pump'));
+                c = this.pumpFactory(pump);
+                // c = new NixiePump(this.controlPanel, pump);
+                this.push(c);
+                logger.info(`A pump was not found for id #${pump.id} creating pump`);
+                return await c.setPumpAsync(data);
+            }
+            else {
+                if (typeof data.type !== 'undefined' && c.pump.type !== data.type) {
+                    // pump exists, changing type
+                    await c.closeAsync();
+                    pump.type = data.type; // needed for init of correct type
+                    if (typeof pump.type === 'undefined') return Promise.reject(new InvalidEquipmentIdError(`Invalid pump type for ${pump.name}`, data.id, 'Pump'));
+                    c = this.pumpFactory(pump);
+                }
+                return await c.setPumpAsync(data);
+            }
+        }
+        catch (err) { logger.error(`setPumpAsync: ${err.message}`); return Promise.reject(err); }
+    }
+    public async initAsync(pumps: PumpCollection) {
+        try {
+            for (let i = 0; i < pumps.length; i++) {
+                let pump = pumps.getItemByIndex(i);
+                if (pump.master === 1) {
+                    let p: NixiePump = this.find(elem => elem.id === pump.id) as NixiePump;
+                    if (typeof p === 'undefined') {
+                        let type = sys.board.valueMaps.pumpTypes.getName(pump.type);
+                        let npump = this.pumpFactory(pump);
+                        logger.info(`Initializing Nixie Pump ${npump.id}-${pump.name}`);
+                        this.push(npump);
+                        await npump.initAsync();
+                    }
+                }
+            }
+        }
+        catch (err) { logger.error(`Nixie Pump initAsync Error: ${err.message}`); return Promise.reject(err); }
+    }
+    public async closeAsync() {
+        try {
+            for (let i = this.length - 1; i >= 0; i--) {
+                try {
+                    try {
+                        await this[i].closeAsync();
+                    } catch (err) { logger.error(`Error attempting to close pump ${this[i].id}`); }
+                    this.splice(i, 1);
+                } catch (err) { logger.error(`Error stopping Nixie Pump ${err}`); }
+            }
+        } catch (err) { } // Don't bail if we have an errror.
+    }
+    public async setServiceModeAsync() {
+        try {
+            for (let i = this.length - 1; i >= 0; i--) {
+                try {
+                    let p = this[i] as NixiePump;
+                    await p.setServiceModeAsync();
+                } catch (err) { logger.error(`Error setting service mode for Nixie Pump ${err}`); }
+            }
+        } catch (err) { } // Don't bail if we have an errror.
+    }
+    public async initPumpAsync(pump: Pump): Promise<NixiePump> {
+        try {
+            let c: NixiePump = this.find(elem => elem.id === pump.id) as NixiePump;
+            if (pump.master === 1) {
+                // if pump exists, close it so we can re-init
+                // (EG if pump type changes, we need to setup a new instance of the pump)
+                if (typeof c !== 'undefined' && c.pump.type !== pump.type) {
+                    await c.closeAsync();
+                    await this.deletePumpAsync(pump.id);
+                    c = this.pumpFactory(pump);
+                    this.push(c);
+                }
+                logger.info(`Initializing Existing Nixie Pump ${c.id}-${pump.name}`);
+
+            }
+            return c;
+        } catch (err) { return Promise.reject(logger.error(`Nixie Controller: initPumpAsync Error: ${err.message}`)); }
+    }
+    private pumpFactory(pump: Pump) {
+        let type = sys.board.valueMaps.pumpTypes.getName(pump.type);
+        switch (type) {
+            case 'ss':
+                return new NixiePumpSS(this.controlPanel, pump);
+            case 'ds':
+                return new NixiePumpDS(this.controlPanel, pump);
+            case 'vsf':
+                return new NixiePumpVSF(this.controlPanel, pump);
+            case 'vf':
+                return new NixiePumpVF(this.controlPanel, pump);
+            case 'sf':
+                return new NixiePumpSF(this.controlPanel, pump);
+            case 'vs':
+                return new NixiePumpVS(this.controlPanel, pump);
+            case 'hwvs':
+                return new NixiePumpHWVS(this.controlPanel, pump);
+            case 'hwrly':
+                return new NixiePumpHWRLY(this.controlPanel, pump);
+            case 'regalmodbus':
+                return new NixiePumpRegalModbus(this.controlPanel, pump);
+            case 'neptunemodbus':
+                return new NixiePumpNeptuneModbus(this.controlPanel, pump);
+            default:
+                throw new EquipmentNotFoundError(`NCP: Cannot create pump ${pump.name}.`, type);
+        }
+    }
+    public syncPumpStates() {
+        // loop through all pumps and update rates based on circuit changes
+        // this would happen in <2s anyway based on pollAsync but this is immediate.
+        for (let i = this.length - 1; i >= 0; i--) {
+            let pump = this[i] as NixiePump;
+            if (!pump.suspendPolling) setTimeoutSync(async () => { await pump.pollEquipmentAsync(); }, 100);
+            else {
+                pump.setTargetSpeed(state.pumps.getItemById(pump.id));
+            }
+            // RKS: 05-16-23 - Below backs up the processing.
+            /*
+             
+            setTimeoutSync(async () => {
+                let pump = this[i] as NixiePump;
+                try {
+                    if (!pump.closing) await pump.pollEquipmentAsync();
+                } catch (err) { }
+            }, 100);
+            */
+        }
+    }
+}
+export class NixiePump extends NixieEquipment {
+    public pollingInterval: number = 2000;
+    protected _pollTimer: NodeJS.Timeout = null;
+    public pump: Pump;
+    protected _targetSpeed: number;
+    protected _suspendPolling = 0;
+    public get suspendPolling(): boolean { return this._suspendPolling > 0; }
+    public set suspendPolling(val: boolean) {
+        this._suspendPolling = Math.max(0, this._suspendPolling + (val ? 1 : -1));
+        if (this._suspendPolling > 1) console.log(`Suspend Polling ${this._suspendPolling}`);
+    }
+    public closing = false;
+    public async setServiceModeAsync() {
+        let pstate = state.pumps.getItemById(this.pump.id);
+        await this.setPumpStateAsync(pstate);
+    }
+    /*
+    _targetSpeed will hold values as follows:
+    vs/vsf/vf: rpm/gpm;
+    ss: 0=off, 1=on;
+    ds/sf: bit shift 1-4 = values 1/2/4/8 for relays 1/2/3/4
+    */
+    constructor(ncp: INixieControlPanel, pump: Pump) {
+        super(ncp);
+        this.pump = pump;
+        this._targetSpeed = 0;
+    }
+    public async initAsync() {
+        if (this._pollTimer) {
+            clearTimeout(this._pollTimer);
+            this._pollTimer = undefined;
+        }
+        this.closing = false;
+        this._suspendPolling = 0;
+        this.pollEquipmentAsync();
+    }
+    public get id(): number { return typeof this.pump !== 'undefined' ? this.pump.id : -1; }
+    public async setPumpStateAsync(pstate: PumpState) {
+        try {
+            // Here we go we need to set the pump state.
+            return new InterfaceServerResponse(200, 'Ok');
+        } catch (err) { return Promise.reject(`Nixie Error setting pump state ${pstate.id}-${pstate.name}: ${err.message}`); }
+    }
+    public async setPumpAsync(data: any): Promise<InterfaceServerResponse> {
+        try {
+            this.pump.master = 1;
+            // if (typeof data.isVirtual !== 'undefined') this.pump.isVirtual = data.isVirtual;
+            this.pump.isActive = true;
+            // if (typeof data.type !== 'undefined' && data.type !== this.pump.type) {
+            //     sys.board.pumps.setType(this.pump, data.type);
+            //     this.pump = sys.pumps.getItemById(id, true);
+            //     spump = state.pumps.getItemById(id, true);
+            // }
+            let type = sys.board.valueMaps.pumpTypes.transform(this.pump.type);
+            this.pump.name = data.name || this.pump.name || type.desc;
+            if (typeof type.maxCircuits !== 'undefined' && type.maxCircuits > 0 && typeof data.circuits !== 'undefined') { // This pump type supports circuits
+                for (let i = 1; i <= data.circuits.length && i <= type.maxCircuits; i++) {
+                    let c = data.circuits[i - 1];
+                    c.id = i;
+                    let circuit = parseInt(c.circuit, 10);
+                    let cd = this.pump.circuits.find(elem => elem.circuit === circuit);
+                    let speed = parseInt(c.speed, 10);
+                    let relay = parseInt(c.relay, 10);
+                    let flow = parseInt(c.flow, 10);
+                    let units = typeof c.units !== 'undefined' ? sys.board.valueMaps.pumpUnits.encode(c.units) : undefined;
+                    switch (type.name) {
+                        case 'vf':
+                            units = sys.board.valueMaps.pumpUnits.getValue('gpm');
+                            break;
+                        case 'hwvs':
+                        case 'vssvrs':
+                        case 'vs':
+                        case 'regalmodbus':
+                        case 'neptunemodbus':
+                            c.units = sys.board.valueMaps.pumpUnits.getValue('rpm');
+                            break;
+                        case 'ss':
+                        case 'ds':
+                        case 'sf':
+                        case 'hwrly':
+                            c.units = undefined;
+                            break;
+                    }
+                    if (isNaN(units)) units = typeof cd !== 'undefined' ? cd.units : sys.board.valueMaps.pumpUnits.getValue('rpm');
+                    if (isNaN(speed)) speed = type.minSpeed;
+                    if (isNaN(flow)) flow = type.minFlow;
+                    if (isNaN(relay)) relay = 1;
+                    c.units = units;
+                    //c.units = parseInt(c.units, 10) || type.name === 'vf' ? sys.board.valueMaps.pumpUnits.getValue('gpm') : sys.board.valueMaps.pumpUnits.getValue('rpm');
+                    if (typeof type.minSpeed !== 'undefined' && c.units === sys.board.valueMaps.pumpUnits.getValue('rpm')) {
+                        c.speed = speed;
+                    }
+                    else if (typeof type.minFlow !== 'undefined' && c.units === sys.board.valueMaps.pumpUnits.getValue('gpm')) {
+                        c.flow = flow;
+                    }
+                    else if (type.maxRelays > 0)
+                        c.relay = relay;
+                }
+            }
+            else data.circuits = [];
+            this.pump.set(data); // Sets all the data back to the pump.  This also sets the relays should it exist on the data.
+            let spump = state.pumps.getItemById(this.pump.id, true);
+            spump.name = this.pump.name;
+            spump.address = this.pump.address;
+            spump.type = this.pump.type;
+            sys.pumps.sortById();
+            state.pumps.sortById();
+            this.pump.hasChanged = true;
+            this.pollEquipmentAsync();
+            return Promise.resolve(new InterfaceServerResponse(200, 'Ok'));
+        }
+        catch (err) { logger.error(`Nixie setPumpAsync: ${err.message}`); return Promise.reject(err); }
+    }
+    public async pollEquipmentAsync() {
+        let self = this;
+        try {
+            // RSG 8-2022.  Refactored to add initasync.  With this.pollEquipmentAsync inside the
+            // constructor we could get here before the pump is initialized.  The added check
+            // for the 112 address prevented that previously, but now is just a final fail safe.
+            if (typeof this._pollTimer !== 'undefined' || this._pollTimer) clearTimeout(this._pollTimer);
+            this._pollTimer = null;
+            const pumpTypeName = sys.board.valueMaps.pumpTypes.getName(this.pump.type);
+            const supportsHighAddress = pumpTypeName === 'regalmodbus' || pumpTypeName === 'neptunemodbus';
+            if (this.suspendPolling || this.closing || (!supportsHighAddress && this.pump.address > 112)) {
+                if (this.suspendPolling) logger.info(`Pump ${this.id} Polling Suspended`);
+                if (this.closing) logger.info(`Pump ${this.id} is closing`);
+                return;
+            }
+            let pstate = state.pumps.getItemById(this.pump.id);
+            this.setTargetSpeed(pstate);
+            await this.setPumpStateAsync(pstate);
+        }
+        catch (err) { logger.error(`Nixie Error running pump sequence - ${err}`); }
+        finally { if (!self.closing) this._pollTimer = setTimeoutSync(async () => await self.pollEquipmentAsync(), self.pollingInterval || 2000); }
+    }
+    private async checkHardwareStatusAsync(connectionId: string, deviceBinding: string) {
+        try {
+            let dev = await NixieEquipment.getDeviceService(connectionId, `/status/device/${deviceBinding}`);
+            return dev;
+        } catch (err) { logger.error(`Nixie Pump checkHardwareStatusAsync: ${err.message}`); return { hasFault: true } }
+    }
+    public async validateSetupAsync(pump: Pump, pstate: PumpState) {
+        try {
+        } catch (err) { logger.error(`Nixie Error checking Pump Hardware ${this.pump.name}: ${err.message}`); return Promise.reject(err); }
+    }
+    public async closeAsync() {
+        try {
+            logger.info(`Nixie Pump closing ${this.pump.name}.`)
+            if (typeof this._pollTimer !== 'undefined' || this._pollTimer) clearTimeout(this._pollTimer);
+            this._pollTimer = null;
+            this._targetSpeed = 0;
+            let pstate = state.pumps.getItemById(this.pump.id);
+            try {
+                await this.setPumpStateAsync(pstate);
+                // Since we are closing we need to not reject.
+            } catch (err) { logger.error(`Nixie Closing pump closeAsync: ${err.message}`); }
+            // This will make sure the timer is dead and we are completely closed.
+            this.closing = true;
+            if (typeof this._pollTimer !== 'undefined' || this._pollTimer) clearTimeout(this._pollTimer);
+            pstate.emitEquipmentChange();
+        }
+        catch (err) { logger.error(`Nixie Pump closeAsync: ${err.message}`); return Promise.reject(err); }
+    }
+    public logData(filename: string, data: any) { this.controlPanel.logData(filename, data); }
+    public setTargetSpeed(pstate: PumpState) { };
+    protected isBodyOn(bodyCode: number) {
+        let assoc = sys.board.valueMaps.pumpBodies.transform(bodyCode);
+        switch (assoc.name) {
+            case 'body1':
+            case 'pool':
+                return state.temps.bodies.getItemById(1).isOn;
+            case 'body2':
+            case 'spa':
+                return state.temps.bodies.getItemById(2).isOn;
+            case 'body3':
+                return state.temps.bodies.getItemById(3).isOn;
+            case 'body4':
+                return state.temps.bodies.getItemById(4).isOn;
+            case 'poolspa':
+                if (sys.equipment.shared && sys.equipment.maxBodies >= 2) {
+                    return state.temps.bodies.getItemById(1).isOn === true || state.temps.bodies.getItemById(2).isOn === true;
+                }
+                else
+                    return state.temps.bodies.getItemById(1).isOn;
+        }
+        return false;
+    }
+}
+export class NixiePumpSS extends NixiePump {
+    public setTargetSpeed(pState: PumpState) {
+        // Turn on ss pumps.
+        let _newSpeed = 0;
+        if (!pState.pumpOnDelay) {
+            let pt = sys.board.valueMaps.pumpTypes.get(this.pump.type);
+            if (pt.maxCircuits === 0 || pt.hasBody) {
+                _newSpeed = this.isBodyOn(this.pump.body) ? 1 : 0;
+                //console.log(`BODY: ${sys.board.bodies.isBodyOn(this.pump.body)} CODE: ${this.pump.body}`);
+            }
+            else if (!pState.pumpOnDelay) {
+                let pumpCircuits: PumpCircuit[] = this.pump.circuits.get();
+                if (!pState.pumpOnDelay) {
+                    for (let i = 0; i < pumpCircuits.length; i++) {
+                        let circ = state.circuits.getInterfaceById(pumpCircuits[i].circuit);
+                        if (circ.isOn) _newSpeed = 1;
+                    }
+                }
+            }
+        }
+        if (this._targetSpeed !== _newSpeed) logger.info(`NCP: Setting Pump ${this.pump.name} to ${_newSpeed > 0 ? 'on' : 'off'}. ${sys.board.bodies.isBodyOn(this.pump.body)}`);
+        if (isNaN(_newSpeed)) _newSpeed = 0;
+        this._targetSpeed = _newSpeed;
+    }
+    public async setServiceModeAsync() {
+        let pstate = state.pumps.getItemById(this.pump.id);
+        pstate.targetSpeed = this._targetSpeed = 0;
+        await this.setPumpStateAsync(pstate);
+    }
+    public async setPumpStateAsync(pstate: PumpState) {
+        let relays: PumpRelay[] = this.pump.relays.get();
+        let relayState = 0;
+        for (let i = 0; i < relays.length; i++) {
+            let pr = relays[i];
+            if (typeof pr.id === 'undefined') pr.id = i + 1; // remove when id is added to dP relays upon save.
+            let isOn = this._targetSpeed >> pr.id - 1 & 1;
+            if (utils.isNullOrEmpty(pr.connectionId) || utils.isNullOrEmpty(pr.deviceBinding)) {
+                // If they haven't set a program for the relay bugger out.
+                if (isOn) relayState |= (1 << pr.id - 1);
+            }
+            else {
+                try {
+                    let res = await NixieEquipment.putDeviceService(pr.connectionId, `/state/device/${pr.deviceBinding}`, { isOn, latch: isOn ? 5000 : undefined });
+                    if (res.status.code === 200) {
+                        if (isOn) relayState |= (1 << pr.id - 1);
+                    }
+                    else pstate.status = 16;
+                }
+                catch (err) {
+                    logger.error(`NCP: Error setting pump ${this.pump.name} relay ${pr.id} to ${isOn ? 'on' : 'off'}.  Error ${err.message}}`);
+                    pstate.status = 16;
+                }
+            }
+        }
+        if (pstate.targetSpeed === 0) {
+            pstate.status = 0;
+            pstate.driveState = 0; // We need to set this if it is a priming cycle but it might not matter for our relay based pumps.
+            pstate.command = 0;
+        }
+        else if (relayState === pstate.targetSpeed) {
+            pstate.status = 1;
+            pstate.driveState = 2;
+            pstate.command = 4;
+        }
+        pstate.relay = relayState;
+        return new InterfaceServerResponse(200, 'Success');
+    }
+}
+export class NixiePumpDS extends NixiePumpSS {
+    public setTargetSpeed(pState: PumpState) {
+        // Turn on sf pumps.  The new speed will be the relays associated with the pump.  I believe when this comes out in the final
+        // wash it should engage all the relays for all speeds associated with the pump.  The pump logic will determine which program is
+        // the one to engage.
+        let _newSpeed = 0;
+        if (!pState.pumpOnDelay) {
+            let pumpCircuits: PumpCircuit[] = this.pump.circuits.get();
+            if (!pState.pumpOnDelay) {
+                for (let i = 0; i < pumpCircuits.length; i++) {
+                    let circ = state.circuits.getInterfaceById(pumpCircuits[i].circuit);
+                    // relay speeds are bit-shifted 'or' based on 1,2,4,8
+                    if (circ.isOn) _newSpeed |= (1 << pumpCircuits[i].relay - 1);
+                }
+            }
+        }
+        if (isNaN(_newSpeed)) _newSpeed = 0;
+        this.logSpeed(_newSpeed);
+        this._targetSpeed = _newSpeed;
+    }
+    public logSpeed(_newSpeed: number) {
+        if (this._targetSpeed !== _newSpeed) logger.info(`NCP: Setting Pump ${this.pump.name} relays to Relay 1: ${_newSpeed & 1 ? 'on' : 'off'}, Relay 2: ${_newSpeed & 2 ? 'on' : 'off'}.`);
+    }
+}
+export class NixiePumpSF extends NixiePumpDS {
+    // effectively operates the same way as a DS pump since we removed the body association on DS.
+    // only logger msg is different
+    public logSpeed(_newSpeed: number) {
+        if (this._targetSpeed !== _newSpeed) logger.info(`NCP: Setting Pump ${this.pump.name} relays to Relay 1: ${_newSpeed & 1 ? 'on' : 'off'}, Relay 2: ${_newSpeed & 2 ? 'on' : 'off'}, Relay 3: ${_newSpeed & 4 ? 'on' : 'off'}, and Relay 4: ${_newSpeed & 8 ? 'on' : 'off'}.`);
+    }
+}
+export class NixiePumpHWRLY extends NixiePumpDS {
+    // This operates as a relay pump with up to 8 speeds.  The speeds are defined as follows.  The override
+    // relay should be defined as being normally closed.  When it opens then the pump will turn on to the speed.
+    // +-------+---------+---------+---------+---------+
+    // + Speed | Relay 1 | Relay 2 | Relay 3 |  OVRD   |
+    // +-------+---------+---------+---------+---------+
+    // |  OFF  |   OFF   |   OFF   |   OFF   |   OFF   |
+    // +-------+---------+---------+---------+---------+
+    // |   1   |   OFF   |   OFF   |   OFF   |   ON    |
+    // +-------+---------+---------+---------+---------+
+    // |   2   |   ON    |   OFF   |   OFF   |   ON    |
+    // +-------+---------+---------+---------+---------+
+    // |   3   |   OFF   |   ON    |   OFF   |   ON    |
+    // +-------+---------+---------+---------+---------+
+    // |   4   |   ON    |   ON    |   OFF   |   ON    |
+    // +-------+---------+---------+---------+---------+
+    // |   5   |   OFF   |   OFF   |   ON    |   ON    |
+    // +-------+---------+---------+---------+---------+
+    // |   6   |   ON    |   OFF   |   ON    |   ON    |
+    // +-------+---------+---------+---------+---------+
+    // |   7   |   OFF   |   ON    |   ON    |   ON    |
+    // +-------+---------+---------+---------+---------+
+    // |   8   |   ON    |   ON    |   ON    |   ON    |
+    // +-------+---------+---------+---------+---------+
+
+    public setTargetSpeed(pState: PumpState) {
+        let _newSpeed = 0;
+        if (!pState.pumpOnDelay) {
+            let pumpCircuits = this.pump.circuits.get();
+            for (let i = 0; i < pumpCircuits.length; i++) {
+                let circ = state.circuits.getInterfaceById(pumpCircuits[i].circuit);
+                let pc = pumpCircuits[i];
+                if (circ.isOn) {
+                    _newSpeed = Math.max(_newSpeed, pc.relay);
+                }
+            }
+        }
+        if (isNaN(_newSpeed)) _newSpeed = 0;
+        this._targetSpeed = _newSpeed;
+        if (this._targetSpeed !== 0) Math.min(Math.max(this.pump.minSpeed, this._targetSpeed), this.pump.maxSpeed);
+        if (this._targetSpeed !== _newSpeed) logger.info(`NCP: Setting Pump ${this.pump.name} to ${_newSpeed}.`);
+    }
+    public async setPumpStateAsync(pstate: PumpState) {
+        // Don't poll while we are seting the state.
+        this.suspendPolling = true;
+        try {
+            let relays: PumpRelay[] = this.pump.relays.get();
+            let relayState = 0;
+            let targetState = 0;
+            for (let i = 0; i < relays.length; i++) {
+                let pr = relays[i];
+                if (typeof pr.id === 'undefined') pr.id = i + 1; // remove when id is added to dP relays upon save.
+                // If we are turning on the pump relay #4 needs to be on.  NOTE: It is expected that the OVRD relay is hooked up in a normally closed
+                // configuration so that whenever the pump is off the relay terminals are closed.
+                let isOn = this._targetSpeed > 0 ? i === 3 ? true : (this._targetSpeed - 1 & (1 << i)) > 0 : false;
+                let bit = isOn ? (1 << i) : 0;
+                targetState |= bit;
+                if (utils.isNullOrEmpty(pr.connectionId) || utils.isNullOrEmpty(pr.deviceBinding)) {
+                    // Determine whether the relay should be on.
+                    relayState |= bit;
+                }
+                else {
+                    try {
+                        let res = await NixieEquipment.putDeviceService(pr.connectionId, `/state/device/${pr.deviceBinding}`, { isOn, latch: isOn ? 5000 : undefined });
+                        if (res.status.code === 200) {
+                            relayState |= bit;
+                        }
+                        else pstate.status = 16;
+                    }
+                    catch (err) {
+                        logger.error(`NCP: Error setting pump ${this.pump.name} relay ${pr.id} to ${isOn ? 'on' : 'off'}.  Error ${err.message}}`);
+                        pstate.status = 16;
+                    }
+                }
+            }
+            pstate.command = this._targetSpeed;
+            if (targetState === relayState) {
+                pstate.status = relayState > 0 ? 1 : 0;
+                pstate.driveState = relayState > 0 ? 2 : 0;
+                pstate.relay = relayState;
+            }
+            else {
+                pstate.driveState = 0;
+            }
+            return new InterfaceServerResponse(200, 'Success');
+        }
+        catch (err) {
+            logger.error(`Error running pump sequence for ${this.pump.name}: ${err.message}`);
+            return Promise.reject(err);
+        }
+        finally { this.suspendPolling = false; }
+    };
+
+}
+export class NixiePumpRS485 extends NixiePump {
+    public async setServiceModeAsync() {
+        this._targetSpeed = 0;
+        await this.setDriveStateAsync(false);
+        await this.setPumpToRemoteControlAsync(false);
+    }
+    public async setPumpStateAsync(pstate: PumpState) {
+        // Don't poll while we are seting the state.
+        this.suspendPolling = true;
+        try {
+            let pt = sys.board.valueMaps.pumpTypes.get(this.pump.type);
+            if (state.mode === 0) {
+                // Since these process are async the closing flag can be set
+                // between calls.  We need to check it in between each call.
+                if (!this.closing) await this.setDriveStateAsync();
+                if (!this.closing) {
+                    if (this._targetSpeed >= pt.minFlow && this._targetSpeed <= pt.maxFlow) await this.setPumpGPMAsync();
+                    else if (this._targetSpeed >= pt.minSpeed && this._targetSpeed <= pt.maxSpeed) await this.setPumpRPMAsync();
+                }
+                ;
+                if (!this.closing && pt.name !== 'vsf' && pt.name !== 'vs') await this.setPumpFeatureAsync(6);;
+                if (!this.closing) await setTimeout(1000);;
+                if (!this.closing) await this.requestPumpStatusAsync();;
+                if (!this.closing) await this.setPumpToRemoteControlAsync();;
+            }
+            return new InterfaceServerResponse(200, 'Success');
+        }
+        catch (err) {
+            logger.error(`Error running pump sequence for ${this.pump.name}: ${err.message}`);
+            return Promise.reject(err);
+        }
+        finally { this.suspendPolling = false; }
+    };
+    protected async setDriveStateAsync(running: boolean = true) {
+        try {
+            if (conn.isPortEnabled(this.pump.portId || 0)) {
+                let out = Outbound.create({
+                    portId: this.pump.portId || 0,
+                    protocol: Protocol.Pump,
+                    dest: this.pump.address,
+                    action: 6,
+                    payload: running && this._targetSpeed > 0 ? [10] : [4],
+                    retries: 1,
+                    response: true
+                });
+                try {
+                    await out.sendAsync();
+                }
+                catch (err) {
+                    logger.error(`Error sending setDriveState for ${this.pump.name}: ${err.message}`);
+                }
+            }
+            else {
+                let pstate = state.pumps.getItemById(this.pump.id);
+                pstate.command = pstate.rpm > 0 || pstate.flow > 0 ? 10 : 0;
+            }
+        } catch (err) { logger.error(`Error setting driveState for ${this.pump.name}: ${err.message}`); }
+    };
+    protected async requestPumpStatusAsync() {
+        if (conn.isPortEnabled(this.pump.portId || 0)) {
+            let out = Outbound.create({
+                portId: this.pump.portId || 0,
+                protocol: Protocol.Pump,
+                dest: this.pump.address,
+                action: 7,
+                payload: [],
+                retries: 2,
+                response: true,
+            });
+            try {
+                await out.sendAsync();
+            }
+            catch (err) {
+                logger.error(`Error sending requestPumpStatus for ${this.pump.name}: ${err.message}`);
+            }
+        }
+    };
+    protected async setPumpToRemoteControlAsync(running: boolean = true) {
+        try {
+            if (conn.isPortEnabled(this.pump.portId || 0)) {
+                let out = Outbound.create({
+                    portId: this.pump.portId || 0,
+                    protocol: Protocol.Pump,
+                    dest: this.pump.address,
+                    action: 4,
+                    payload: running ? [255] : [0], // when stopAsync is called, pass false to return control to pump panel
+                    retries: 1,
+                    response: true
+                });
+                try {
+                    await out.sendAsync();
+                }
+                catch (err) {
+                    logger.error(`Error sending setPumpToRemoteControl for ${this.pump.name}: ${err.message}`);
+                }
+            }
+        } catch (err) { logger.error(`Error setting pump to Remote Control for ${this.pump.name}: ${err.message}`); }
+    }
+    protected async setPumpFeatureAsync(feature?: number) {
+        // empty payload (possibly 0?, too) is no feature
+        // 6: Feature 1
+        try {
+            if (conn.isPortEnabled(this.pump.portId || 0)) {
+                let out = Outbound.create({
+                    portId: this.pump.portId || 0,
+                    protocol: Protocol.Pump,
+                    dest: this.pump.address,
+                    action: 5,
+                    payload: typeof feature === 'undefined' ? [] : [feature],
+                    retries: 2,
+                    response: true
+                });
+                try {
+                    await out.sendAsync();
+                }
+                catch (err) {
+                    logger.error(`Error sending setPumpFeature for ${this.pump.name}: ${err.message}`);
+                }
+            }
+        } catch (err) { logger.error(`Error setting pump feature for ${this.pump.name}: ${err.message}`); }
+    };
+    protected async setPumpRPMAsync() {
+        if (conn.isPortEnabled(this.pump.portId || 0)) {
+            let out = Outbound.create({
+                portId: this.pump.portId || 0,
+                protocol: Protocol.Pump,
+                dest: this.pump.address,
+                action: 1,
+                payload: [2, 196, Math.floor(this._targetSpeed / 256), this._targetSpeed % 256],
+                retries: 1,
+                // timeout: 250,
+                response: true
+            });
+            try {
+                await out.sendAsync();
+            }
+            catch (err) {
+                logger.error(`Error sending setPumpRPMAsync for ${this.pump.name}: ${err.message}`);
+            }
+        }
+    };
+    protected async setPumpGPMAsync() {
+        // packet for vf; vsf will override
+        if (conn.isPortEnabled(this.pump.portId || 0)) {
+            let out = Outbound.create({
+                portId: this.pump.portId || 0,
+                protocol: Protocol.Pump,
+                dest: this.pump.address,
+                action: 1,
+                payload: [2, 228, 0, this._targetSpeed],
+                retries: 1,
+                response: true
+            });
+            try {
+                await out.sendAsync();
+            }
+            catch (err) {
+                logger.error(`Error sending setPumpGPMAsync for ${this.pump.name}: ${err.message}`);
+            }
+        }
+    };
+    public async closeAsync() {
+        try {
+            this.suspendPolling = true;
+            logger.info(`Nixie Pump closing ${this.pump.name}.`)
+            if (typeof this._pollTimer !== 'undefined' || this._pollTimer) clearTimeout(this._pollTimer);
+            this._pollTimer = null;
+            this.closing = true;
+            let pt = sys.board.valueMaps.pumpTypes.get(this.pump.type);
+            let pstate = state.pumps.getItemById(this.pump.id);
+            this._targetSpeed = 0;
+            await this.setDriveStateAsync(false);
+            if (!this.closing && pt.name !== 'vsf' && pt.name !== 'vs') await this.setPumpFeatureAsync();
+            //await this.setPumpFeature(); 
+            //await this.setDriveStateAsync(false); 
+            await this.setPumpToRemoteControlAsync(false);
+            // Make sure the polling timer is dead after we have closed this all off.  That way we do not
+            // have another process that revives it from the dead.
+            if (typeof this._pollTimer !== 'undefined' || this._pollTimer) clearTimeout(this._pollTimer);
+            this._pollTimer = null;
+            pstate.emitEquipmentChange();
+        }
+        catch (err) { logger.error(`Nixie Pump closeAsync: ${err.message}`); return Promise.reject(err); }
+        finally { this.suspendPolling = false; }
+    }
+}
+export class NixiePumpVS extends NixiePumpRS485 {
+    public setTargetSpeed(pState: PumpState) {
+        let _newSpeed = 0;
+        if (!pState.pumpOnDelay) {
+            let pumpCircuits = this.pump.circuits.get();
+
+            for (let i = 0; i < pumpCircuits.length; i++) {
+                let circ = state.circuits.getInterfaceById(pumpCircuits[i].circuit);
+                let pc = pumpCircuits[i];
+                if (circ.isOn) _newSpeed = Math.max(_newSpeed, pc.speed);
+            }
+        }
+        if (isNaN(_newSpeed)) _newSpeed = 0;
+        this._targetSpeed = _newSpeed;
+        if (this._targetSpeed !== 0) Math.min(Math.max(this.pump.minSpeed, this._targetSpeed), this.pump.maxSpeed);
+        if (this._targetSpeed !== _newSpeed) logger.info(`NCP: Setting Pump ${this.pump.name} to ${_newSpeed} RPM.`);
+    }
+}
+export class NixiePumpVF extends NixiePumpRS485 {
+    public setTargetSpeed(pState: PumpState) {
+        let _newSpeed = 0;
+        if (!pState.pumpOnDelay) {
+            let pumpCircuits = this.pump.circuits.get();
+            for (let i = 0; i < pumpCircuits.length; i++) {
+                let circ = state.circuits.getInterfaceById(pumpCircuits[i].circuit);
+                let pc = pumpCircuits[i];
+                if (circ.isOn) _newSpeed = Math.max(_newSpeed, pc.flow);
+            }
+        }
+        if (isNaN(_newSpeed)) _newSpeed = 0;
+        this._targetSpeed = _newSpeed;
+        if (this._targetSpeed !== 0) Math.min(Math.max(this.pump.minFlow, this._targetSpeed), this.pump.maxFlow);
+        if (this._targetSpeed !== _newSpeed) logger.info(`NCP: Setting Pump ${this.pump.name} to ${_newSpeed} GPM.`);
+    }
+    public async setPumpStateAsync(pstate: PumpState) {
+        // Don't poll while we are seting the state.
+        this.suspendPolling = true;
+        try {
+            let pt = sys.board.valueMaps.pumpTypes.get(this.pump.type);
+            if (state.mode === 0) {
+                // Since these process are async the closing flag can be set
+                // between calls.  We need to check it in between each call. // 4, 6, 5,  7
+                // When we are 0 then it sends 4[255], 6[4], 5[6]
+                // When we are not 0 then it sends 4[255], 6[10], 5[6], 1[flow]
+                if (!this.closing) await this.setPumpToRemoteControlAsync(); // Action 4
+                if (!this.closing && this._targetSpeed > 0) await this.setPumpGPMAsync(); // Action 1
+                if (!this.closing && this._targetSpeed > 0) await this.setPumpFeatureAsync(6); // Action 5
+                // RKS: 07-21-24 - This used to send an empty payload when the pump should be off.  For VF pumps it
+                // appears that not setting the feature or target flow will set the pump off when it gets to
+                // the drive state.
+                //if (!this.closing) await this.setPumpFeatureAsync(this._targetSpeed > 0 ? 6 : undefined); // Action 5
+                if (!this.closing) await this.setDriveStateAsync();         // Action 6
+                if (!this.closing) await setTimeout(200);
+                if (!this.closing) await this.requestPumpStatusAsync(); // Action 7
+            }
+            return new InterfaceServerResponse(200, 'Success');
+        }
+        catch (err) {
+            logger.error(`Error running pump sequence for ${this.pump.name}: ${err.message}`);
+            return Promise.reject(err);
+        }
+        finally { this.suspendPolling = false; }
+    };
+}
+export class NixiePumpVSF extends NixiePumpRS485 {
+    public setTargetSpeed(pState: PumpState) {
+        let _newSpeed = 0;
+        let maxRPM = 0;
+        let maxGPM = 0;
+        let useFlow = false;
+        if (!pState.pumpOnDelay) {
+            let pumpCircuits = this.pump.circuits.get();
+            let pt = sys.board.valueMaps.pumpTypes.get(this.pump.type);
+            // VSF pumps present a problem.  In fact they do not currently operate properly on Touch panels.  On touch these need to either be all in RPM or GPM
+            // if there is a mix in the circuit array then they will not work.  In IntelliCenter if there is an RPM setting in the mix it will use RPM by converting
+            // the GPM to RPM but if there is none then it will use GPM.
+            let toRPM = (flowRate: number, minSpeed: number = 450, maxSpeed: number = 3450) => {
+                // eff = 114.4365
+                // gpm = 80
+                // speed = 2412
+                let eff = .03317 * maxSpeed;
+                let rpm = Math.min(Math.round((flowRate * maxSpeed) / eff), maxSpeed);
+                return rpm > 0 ? Math.max(rpm, minSpeed) : 0;
+            };
+            let toGPM = (speed: number, maxSpeed: number = 3450, minFlow: number = 15, maxFlow: number = 140) => {
+                // eff = 114.4365
+                // speed = 1100
+                // gpm = (114.4365 * 1100)/3450 = 36
+                let eff = .03317 * maxSpeed;
+                let gpm = Math.min(Math.round((eff * speed) / maxSpeed), maxFlow);
+                return gpm > 0 ? Math.max(gpm, minFlow) : 0;
+            }
+            for (let i = 0; i < pumpCircuits.length; i++) {
+                let circ = state.circuits.getInterfaceById(pumpCircuits[i].circuit);
+                let pc = pumpCircuits[i];
+                if (circ.isOn) {
+                    if (pc.units > 0) {
+                        let rpm = toRPM(pc.flow, pt.minSpeed, pt.MaxSpeed);
+                        if (rpm > maxRPM) useFlow = true;
+                        maxGPM = Math.max(maxGPM, pc.flow);
+                        rpm = Math.max(maxRPM, rpm);
+                    }
+                    else {
+                        let gpm = toGPM(pc.speed, pt.maxSpeed, pt.minFlow, pt.maxFlow);
+                        if (gpm > maxGPM) useFlow = false;
+                        maxRPM = Math.max(maxRPM, pc.speed);
+                        maxGPM = Math.max(maxGPM, gpm);
+                    }
+                }
+            }
+            _newSpeed = useFlow ? maxGPM : maxRPM;
+        }
+        if (isNaN(_newSpeed)) _newSpeed = 0;
+        // Send the flow message if it is flow and the rpm message if it is rpm.
+        if (this._targetSpeed !== _newSpeed) logger.info(`NCP: Setting Pump ${this.pump.name} to ${_newSpeed} ${useFlow ? 'GPM' : 'RPM'}.`);
+        this._targetSpeed = _newSpeed;
+    }
+    protected async setPumpRPMAsync() {
+        // vsf action is 10 for rpm
+        if (conn.isPortEnabled(this.pump.portId || 0)) {
+            let out = Outbound.create({
+                portId: this.pump.portId || 0,
+                protocol: Protocol.Pump,
+                dest: this.pump.address,
+                action: 10,
+                payload: [2, 196, Math.floor(this._targetSpeed / 256), this._targetSpeed % 256],
+                retries: 1,
+                // timeout: 250,
+                response: true
+            });
+            try {
+                await out.sendAsync();
+            }
+            catch (err) {
+                logger.error(`Error sending setPumpRPMAsync for ${this.pump.name}: ${err.message}`);
+            }
+        }
+    };
+    protected async setPumpGPMAsync() {
+        // vsf payload; different from vf payload
+        if (conn.isPortEnabled(this.pump.portId || 0)) {
+            let out = Outbound.create({
+                portId: this.pump.portId || 0,
+                protocol: Protocol.Pump,
+                dest: this.pump.address,
+                action: 9,
+                payload: [2, 196, 0, this._targetSpeed],
+                retries: 1,
+                response: true
+            });
+            try {
+                await out.sendAsync();
+            }
+            catch (err) {
+                logger.error(`Error sending setPumpGPMAsync for ${this.pump.name}: ${err.message}`);
+            }
+        }
+    };
+};
+export class NixiePumpHWVS extends NixiePumpRS485 {
+    public setTargetSpeed(pState: PumpState) {
+        let _newSpeed = 0;
+        if (!pState.pumpOnDelay) {
+            let pumpCircuits = this.pump.circuits.get();
+
+            for (let i = 0; i < pumpCircuits.length; i++) {
+                let circ = state.circuits.getInterfaceById(pumpCircuits[i].circuit);
+                let pc = pumpCircuits[i];
+                if (circ.isOn) _newSpeed = Math.max(_newSpeed, pc.speed);
+            }
+        }
+        if (isNaN(_newSpeed)) _newSpeed = 0;
+        this._targetSpeed = _newSpeed;
+        if (this._targetSpeed !== 0) Math.min(Math.max(this.pump.minSpeed, this._targetSpeed), this.pump.maxSpeed);
+        if (this._targetSpeed !== _newSpeed) logger.info(`NCP: Setting Pump ${this.pump.name} to ${_newSpeed} RPM.`);
+    }
+    public async setServiceModeAsync() {
+        this._targetSpeed = 0;
+        await this.setPumpRPMAsync();
+    }
+    public async setDriveStateAsync(running: boolean = false) { return Promise.resolve(); }
+    public async setPumpStateAsync(pstate: PumpState) {
+        // Don't poll while we are seting the state.
+        this.suspendPolling = true;
+        try {
+            // Since these process are async the closing flag can be set
+            // between calls.  We need to check it in between each call.
+            if (!this.closing) { await this.setPumpRPMAsync(); }
+            return new InterfaceServerResponse(200, 'Success');
+        }
+        catch (err) {
+            logger.error(`Error running pump sequence for ${this.pump.name}: ${err.message}`);
+            return Promise.reject(err);
+        }
+        finally { this.suspendPolling = false; }
+    };
+    protected async requestPumpStatusAsync() { return Promise.resolve(); };
+    protected setPumpFeatureAsync(feature?: number) { return Promise.resolve(); }
+    protected async setPumpToRemoteControlAsync(running: boolean = true) {
+        try {
+            // We do nothing on this pump to set it to remote control.  That is unless we are turning it off.
+            if (conn.isPortEnabled(this.pump.portId || 0)) {
+                if (!running) {
+                    let out = Outbound.create({
+                        portId: this.pump.portId || 0,
+                        protocol: Protocol.Hayward,
+                        source: 12, // Use the broadcast address
+                        dest: this.pump.address,
+                        action: 1,
+                        payload: [0], // when stopAsync is called, pass false to return control to pump panel
+                        // payload: spump.virtualControllerStatus === sys.board.valueMaps.virtualControllerStatus.getValue('running') ? [255] : [0],
+                        retries: 1,
+                        response: Response.create({ protocol: Protocol.Hayward, action: 12, source: this.pump.address - 96 })
+                    });
+                    try {
+                        await out.sendAsync();
+                    }
+                    catch (err) {
+                        logger.error(`Error sending setPumpToRemoteControl for ${this.pump.name}: ${err.message}`);
+
+                    }
+                }
+            }
+        } catch(err) { `Error sending setPumpToRemoteControl message for ${this.pump.name}: ${err.message}` };
+    }
+    protected async setPumpRPMAsync() {
+        // Address 1
+        //[][16, 2, 12, 1, 0][41][0, 72, 16, 3] out
+        //[][16, 2, 0, 12, 0][0, 41, 0, 135][0, 206, 16, 3] In
+        // Address 2
+        //[][16, 2, 12, 1, 1][100][0, 132, 16, 3] out
+        //[][16, 2, 0, 12, 1][0, 96, 21, 64][0, 212, 16, 3] in
+        // Note that action 12 is in a different position for the outbound than the inbound.  The source and destination are kind
+        // of a misnomer in that it identifies the equipment address in byte(4) of the header and flips the command address around.
+        // So in essence for equipment item 0-16 (pump addresses) the outbound is really a broadcast on 12 (broadcast) from 1 and the inbound is
+        // broadcast from the equipment item to 0 (anybody).
+        if (conn.isPortEnabled(this.pump.portId || 0)) {
+            let pt = sys.board.valueMaps.pumpTypes.get(this.pump.type);
+            let out = Outbound.create({
+                portId: this.pump.portId || 0,
+                protocol: Protocol.Hayward,
+                source: 1, // Use the broadcast address
+                dest: this.pump.address - 96,
+                action: 12,
+                payload: [Math.min(Math.round((this._targetSpeed / pt.maxSpeed) * 100), 100)], // when stopAsync is called, pass false to return control to pump panel
+                retries: 1,
+                response: Response.create({ protocol: Protocol.Hayward, action: 12, source: this.pump.address - 96 })
+            });
+            try {
+                await out.sendAsync();
+            }
+            catch (err) {
+                logger.error(`Error sending setPumpRPM for ${this.pump.name}: ${err.message}`);
+                let pstate = state.pumps.getItemById(this.pump.id);
+                pstate.command = 0;
+                pstate.rpm = 0;
+                pstate.watts = 0;
+            }
+        }
+        else {
+            let pstate = state.pumps.getItemById(this.pump.id);
+            pstate.command = 0;
+            pstate.rpm = 0;
+            pstate.watts = 0;
+        }
+
+    };
+}
+
+export class NixiePumpRegalModbus extends NixiePump {
+
+    constructor(ncp: INixieControlPanel, pump: Pump) {
+        super(ncp, pump);
+        // this.pump = pump;
+        // this._targetSpeed = 0;
+    }
+
+    public setTargetSpeed(pumpState: PumpState) {
+        let newSpeed = 0;
+        if (!pumpState.pumpOnDelay) {
+            let circuitConfigs = this.pump.circuits.get();
+            for (let i = 0; i < circuitConfigs.length; i++) {
+                let circuitConfig = circuitConfigs[i];
+                let circ = state.circuits.getInterfaceById(circuitConfig.circuit);
+                if (circ.isOn) newSpeed = Math.max(newSpeed, circuitConfig.speed);
+            }
+        }
+        if (isNaN(newSpeed)) newSpeed = 0;
+        this._targetSpeed = newSpeed;
+        if (this._targetSpeed !== 0) Math.min(Math.max(this.pump.minSpeed, this._targetSpeed), this.pump.maxSpeed);
+        if (this._targetSpeed !== newSpeed) logger.info(`NCP: Setting Pump ${this.pump.name} to ${newSpeed} RPM.`);
+    }
+    
+    public async setServiceModeAsync() {
+        this._targetSpeed = 0;
+        await this.setDriveStateAsync(false);
+        // await this.setPumpToRemoteControlAsync(false);
+    }
+
+    public async setPumpStateAsync(pstate: PumpState) {
+        // Don't poll while we are seting the state.
+        this.suspendPolling = true;
+        try {
+            let pt = sys.board.valueMaps.pumpTypes.get(this.pump.type);
+            if (state.mode === 0) {
+                // Since these process are async the closing flag can be set
+                // between calls.  We need to check it in between each call.
+                if (!this.closing) {
+                    if (this._targetSpeed >= pt.minSpeed && this._targetSpeed <= pt.maxSpeed) await this.setPumpRPMAsync();
+                }
+                if (!this.closing) await this.setDriveStateAsync();
+                ;
+                // if (!this.closing && pt.name !== 'vsf' && pt.name !== 'vs') await this.setPumpFeatureAsync(6);;
+                if (!this.closing) await setTimeout(1000);;
+                if (!this.closing) await this.requestPumpStatusAsync();;
+                // if (!this.closing) await this.setPumpToRemoteControlAsync();;
+            }
+            return new InterfaceServerResponse(200, 'Success');
+        }
+        catch (err) {
+            logger.error(`Error running pump sequence for ${this.pump.name}: ${err.message}`);
+            return Promise.reject(err);
+        }
+        finally { this.suspendPolling = false; }
+    };
+    protected async setDriveStateAsync(isRunning: boolean = true) {
+        let functionCode = this._targetSpeed > 0 ? 0x41 : 0x42;
+        logger.debug(`NixiePumpRegalModbus: setDriveStateAsync ${this.pump.name} ${functionCode == 0x41 ? 'RUN' : functionCode == 0x42 ? 'STOP' : 'UNKNOWN'}`);
+        try {
+            if (conn.isPortEnabled(this.pump.portId || 0)) {
+                let functionCode = this._targetSpeed > 0 ? 0x41 : 0x42;
+                let out = Outbound.create({
+                    portId: this.pump.portId || 0,
+                    protocol: Protocol.RegalModbus,
+                    dest: this.pump.address,
+                    action: functionCode,
+                    payload: [],
+                    retries: 1,
+                    response: true
+                });
+                try {
+                    await out.sendAsync();
+                }
+                catch (err) {
+                    logger.error(`Error sending setDriveState for ${this.pump.name}: ${err.message}`);
+                }
+            }
+            else {
+                let pumpState = state.pumps.getItemById(this.pump.id);
+                pumpState.command = pumpState.rpm > 0 || pumpState.flow > 0 ? 10 : 0;  // dashPanel needs this to be set to 10 for running.
+            }
+        } catch (err) { logger.error(`Error setting driveState for ${this.pump.name}: ${err.message}`); }
+    };
+
+    protected async requestPumpDriveStateAsync() {
+        if (conn.isPortEnabled(this.pump.portId || 0)) {
+            let out = Outbound.create({
+                portId: this.pump.portId || 0,
+                protocol: Protocol.RegalModbus,
+                dest: this.pump.address,
+                action: 0x43,
+                payload: [],
+                retries: 2,
+                response: true,
+            });
+            try {
+                await out.sendAsync();
+            }
+            catch (err) {
+                logger.error(`Error sending requestPumpDriveState for ${this.pump.name}: ${err.message}`);
+            }
+        }
+    }
+
+    protected async requestSensorAsync(page: number, sensorAddr: number, retries: number = 2) {
+        if (conn.isPortEnabled(this.pump.portId || 0)) {
+            let out = Outbound.create({
+                portId: this.pump.portId || 0,
+                protocol: Protocol.RegalModbus,
+                dest: this.pump.address,
+                action: 0x45,
+                payload: [page, sensorAddr],
+                retries: retries,
+                response: true,
+            });
+            try {
+                await out.sendAsync();
+            }
+            catch (err) {
+                logger.error(`Error sending requestSensor for ${this.pump.name} page ${page} sensor ${sensorAddr}: ${err.message}`);
+            }
+        }
+    }
+
+    protected async requestPumpStatusAsync() {
+
+        await this.requestPumpDriveStateAsync();
+        await this.requestSensorAsync(0, 0x00);  // motor speed
+        // await this.requestSensorAsync(0, 0x01);  // motor current
+        // await this.requestSensorAsync(0, 0x04);  // torque
+        // await this.requestSensorAsync(0, 0x05);  // inverter input power
+        // await this.requestSensorAsync(0, 0x06);  // DC bus voltage
+        // await this.requestSensorAsync(0, 0x07);  // ambient temperature
+        await this.requestSensorAsync(0, 0x0A);  // output power
+        // await this.requestSensorAsync(0, 0x0D);  // motor line voltage
+        // await this.requestSensorAsync(0, 0x0E);  // ramp status
+        // await this.requestSensorAsync(0, 0x0F);  // no of total fault
+        // await this.requestSensorAsync(0, 0x10);  // prime status
+        // await this.requestSensorAsync(0, 0x11);  // motor input power
+        // await this.requestSensorAsync(0, 0x12);  // IGBT temperature
+        // await this.requestSensorAsync(0, 0x13);  // PCB temperature
+    };
+
+    protected async setPumpRPMAsync() {
+        logger.debug(`NixiePumpRegalModbus: setPumpRPMAsync ${this.pump.name} ${this._targetSpeed}`);
+        if (conn.isPortEnabled(this.pump.portId || 0)) {
+            // get demand bytes from rpm
+            const mode = 0x00; // 0x00 for speed control mode
+            const demandLo = Math.round(this._targetSpeed * 4) & 0xFF;
+            const demandHi = (Math.round(this._targetSpeed * 4) >> 8) & 0xFF;
+            let out = Outbound.create({
+                portId: this.pump.portId || 0,
+                protocol: Protocol.RegalModbus,
+                dest: this.pump.address,
+                action: 0x44,
+                payload: [mode, demandLo, demandHi],
+                retries: 1,
+                // timeout: 250,
+                response: true
+            });
+            try {
+                await out.sendAsync();
+            }
+            catch (err) {
+                logger.error(`Error sending setPumpRPMAsync for ${this.pump.name}: ${err.message}`);
+            }
+        }
+    };
+    public async closeAsync() {
+        try {
+            this.suspendPolling = true;
+            logger.info(`Nixie Pump closing ${this.pump.name}.`)
+            if (typeof this._pollTimer !== 'undefined' || this._pollTimer) clearTimeout(this._pollTimer);
+            this._pollTimer = null;
+            this.closing = true;
+            let pumpType = sys.board.valueMaps.pumpTypes.get(this.pump.type);
+            let pumpState = state.pumps.getItemById(this.pump.id);
+            this._targetSpeed = 0;
+            await this.setDriveStateAsync(false);
+            // if (!this.closing && pt.name !== 'vsf' && pt.name !== 'vs') await this.setPumpFeatureAsync();
+            //await this.setPumpFeature(); 
+            //await this.setDriveStateAsync(false); 
+            // await this.setPumpToRemoteControlAsync(false);
+            // Make sure the polling timer is dead after we have closed this all off.  That way we do not
+            // have another process that revives it from the dead.
+            if (typeof this._pollTimer !== 'undefined' || this._pollTimer) clearTimeout(this._pollTimer);
+            this._pollTimer = null;
+            pumpState.emitEquipmentChange();
+        }
+        catch (err) { logger.error(`Nixie Pump closeAsync: ${err.message}`); return Promise.reject(err); }
+        finally { this.suspendPolling = false; }
+    }
+}
+
+export class NixiePumpNeptuneModbus extends NixiePump {
+    private static readonly REG_MOTOR_ON_OFF = 0;    // 40001 address offset
+    private static readonly REG_MANUAL_SPEED = 1;    // 40002 address offset
+
+    constructor(ncp: INixieControlPanel, pump: Pump) {
+        super(ncp, pump);
+    }
+
+    public setTargetSpeed(pumpState: PumpState) {
+        let newSpeed = 0;
+        if (!pumpState.pumpOnDelay) {
+            const circuitConfigs = this.pump.circuits.get();
+            for (let i = 0; i < circuitConfigs.length; i++) {
+                const circuitConfig = circuitConfigs[i];
+                const circ = state.circuits.getInterfaceById(circuitConfig.circuit);
+                if (circ.isOn) newSpeed = Math.max(newSpeed, circuitConfig.speed);
+            }
+        }
+        if (isNaN(newSpeed)) newSpeed = 0;
+        this._targetSpeed = newSpeed;
+        if (this._targetSpeed !== 0) Math.min(Math.max(this.pump.minSpeed, this._targetSpeed), this.pump.maxSpeed);
+        if (this._targetSpeed !== newSpeed) logger.info(`NCP: Setting Pump ${this.pump.name} to ${newSpeed} RPM.`);
+    }
+
+    public async setServiceModeAsync() {
+        this._targetSpeed = 0;
+        await this.setDriveStateAsync(false);
+    }
+
+    public async setPumpStateAsync(pstate: PumpState) {
+        this.suspendPolling = true;
+        try {
+            const pt = sys.board.valueMaps.pumpTypes.get(this.pump.type);
+            if (state.mode === 0) {
+                if (!this.closing && this._targetSpeed >= pt.minSpeed && this._targetSpeed <= pt.maxSpeed) {
+                    await this.setPumpRPMAsync();
+                }
+                if (!this.closing) await this.setDriveStateAsync();
+                if (!this.closing) await setTimeout(500);
+                if (!this.closing) await this.requestPumpStatusAsync();
+            }
+            return new InterfaceServerResponse(200, 'Success');
+        }
+        catch (err) {
+            logger.error(`Error running pump sequence for ${this.pump.name}: ${err.message}`);
+            return Promise.reject(err);
+        }
+        finally { this.suspendPolling = false; }
+    };
+
+    private toWord(value: number): [number, number] {
+        return [(value >> 8) & 0xFF, value & 0xFF];
+    }
+
+    private async writeSingleRegisterAsync(registerAddr: number, value: number, retries: number = 1) {
+        if (!conn.isPortEnabled(this.pump.portId || 0)) return;
+        const [regHi, regLo] = this.toWord(registerAddr);
+        const [valHi, valLo] = this.toWord(value & 0xFFFF);
+        const out = Outbound.create({
+            portId: this.pump.portId || 0,
+            protocol: Protocol.NeptuneModbus,
+            dest: this.pump.address,
+            action: 0x06,
+            payload: [regHi, regLo, valHi, valLo],
+            retries,
+            response: true,
+        });
+        try {
+            await out.sendAsync();
+        }
+        catch (err) {
+            logger.error(`Error writing Neptune register ${registerAddr} for ${this.pump.name}: ${err.message}`);
+        }
+    }
+
+    private async readInputRegistersAsync(startAddr: number, quantity: number, retries: number = 2) {
+        if (!conn.isPortEnabled(this.pump.portId || 0)) return;
+        const [startHi, startLo] = this.toWord(startAddr);
+        const [qtyHi, qtyLo] = this.toWord(quantity);
+        const out = Outbound.create({
+            portId: this.pump.portId || 0,
+            protocol: Protocol.NeptuneModbus,
+            dest: this.pump.address,
+            action: 0x04,
+            payload: [startHi, startLo, qtyHi, qtyLo],
+            retries,
+            response: true,
+        });
+        NeptuneModbusStateMessage.enqueueReadRequest(this.pump.address, startAddr, quantity);
+        try {
+            await out.sendAsync();
+        }
+        catch (err) {
+            NeptuneModbusStateMessage.clearReadRequests(this.pump.address);
+            logger.error(`Error reading Neptune registers ${startAddr}-${startAddr + quantity - 1} for ${this.pump.name}: ${err.message}`);
+        }
+    }
+
+    protected async setDriveStateAsync(isRunning: boolean = true) {
+        const shouldRun = isRunning && this._targetSpeed > 0;
+        logger.debug(`NixiePumpNeptuneModbus: setDriveStateAsync ${this.pump.name} ${shouldRun ? 'RUN' : 'STOP'}`);
+        await this.writeSingleRegisterAsync(NixiePumpNeptuneModbus.REG_MOTOR_ON_OFF, shouldRun ? 1 : 0);
+    }
+
+    protected async requestPumpStatusAsync() {
+        // Block 30001-30007 (speed/power/fault summary).
+        await this.readInputRegistersAsync(0, 7);
+        // Block 30031-30033 (interface fault state/code).
+        await this.readInputRegistersAsync(30, 3);
+        // Block 30114-30128 (stopped state, line volts, temps, target speed, etc.).
+        await this.readInputRegistersAsync(113, 15);
+    }
+
+    protected async setPumpRPMAsync() {
+        logger.debug(`NixiePumpNeptuneModbus: setPumpRPMAsync ${this.pump.name} ${this._targetSpeed}`);
+        await this.writeSingleRegisterAsync(NixiePumpNeptuneModbus.REG_MANUAL_SPEED, Math.round(this._targetSpeed));
+    }
+
+    public async closeAsync() {
+        try {
+            this.suspendPolling = true;
+            logger.info(`Nixie Pump closing ${this.pump.name}.`)
+            if (typeof this._pollTimer !== 'undefined' || this._pollTimer) clearTimeout(this._pollTimer);
+            this._pollTimer = null;
+            this.closing = true;
+            const pumpState = state.pumps.getItemById(this.pump.id);
+            this._targetSpeed = 0;
+            await this.setDriveStateAsync(false);
+            if (typeof this._pollTimer !== 'undefined' || this._pollTimer) clearTimeout(this._pollTimer);
+            this._pollTimer = null;
+            pumpState.emitEquipmentChange();
+        }
+        catch (err) { logger.error(`Nixie Pump closeAsync: ${err.message}`); return Promise.reject(err); }
+        finally { this.suspendPolling = false; }
+    }
 }