nodejs-poolcontroller 7.6.1 → 8.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (102) hide show
  1. package/.eslintrc.json +36 -45
  2. package/.github/ISSUE_TEMPLATE/1-bug-report.yml +84 -0
  3. package/.github/ISSUE_TEMPLATE/2-docs.md +12 -0
  4. package/.github/ISSUE_TEMPLATE/3-proposal.md +28 -0
  5. package/.github/ISSUE_TEMPLATE/config.yml +8 -0
  6. package/CONTRIBUTING.md +74 -74
  7. package/Changelog +242 -215
  8. package/Dockerfile +17 -17
  9. package/Gruntfile.js +40 -40
  10. package/LICENSE +661 -661
  11. package/README.md +195 -191
  12. package/anslq25/MessagesMock.ts +218 -0
  13. package/anslq25/boards/MockBoardFactory.ts +50 -0
  14. package/anslq25/boards/MockEasyTouchBoard.ts +696 -0
  15. package/anslq25/boards/MockSystemBoard.ts +217 -0
  16. package/anslq25/chemistry/MockChlorinator.ts +75 -0
  17. package/anslq25/pumps/MockPump.ts +84 -0
  18. package/app.ts +10 -14
  19. package/config/Config.ts +26 -8
  20. package/config/VersionCheck.ts +8 -4
  21. package/controller/Constants.ts +59 -25
  22. package/controller/Equipment.ts +2667 -2459
  23. package/controller/Errors.ts +181 -180
  24. package/controller/Lockouts.ts +534 -436
  25. package/controller/State.ts +596 -77
  26. package/controller/boards/AquaLinkBoard.ts +1003 -0
  27. package/controller/boards/BoardFactory.ts +53 -45
  28. package/controller/boards/EasyTouchBoard.ts +3079 -2653
  29. package/controller/boards/IntelliCenterBoard.ts +3821 -4230
  30. package/controller/boards/IntelliComBoard.ts +69 -63
  31. package/controller/boards/IntelliTouchBoard.ts +384 -241
  32. package/controller/boards/NixieBoard.ts +1871 -1675
  33. package/controller/boards/SunTouchBoard.ts +393 -0
  34. package/controller/boards/SystemBoard.ts +5244 -4697
  35. package/controller/comms/Comms.ts +905 -541
  36. package/controller/comms/ScreenLogic.ts +1663 -0
  37. package/controller/comms/messages/Messages.ts +382 -54
  38. package/controller/comms/messages/config/ChlorinatorMessage.ts +8 -4
  39. package/controller/comms/messages/config/CircuitGroupMessage.ts +5 -2
  40. package/controller/comms/messages/config/CircuitMessage.ts +82 -13
  41. package/controller/comms/messages/config/ConfigMessage.ts +3 -1
  42. package/controller/comms/messages/config/CoverMessage.ts +2 -1
  43. package/controller/comms/messages/config/CustomNameMessage.ts +31 -30
  44. package/controller/comms/messages/config/EquipmentMessage.ts +5 -1
  45. package/controller/comms/messages/config/ExternalMessage.ts +33 -3
  46. package/controller/comms/messages/config/FeatureMessage.ts +2 -1
  47. package/controller/comms/messages/config/GeneralMessage.ts +2 -1
  48. package/controller/comms/messages/config/HeaterMessage.ts +145 -11
  49. package/controller/comms/messages/config/IntellichemMessage.ts +2 -1
  50. package/controller/comms/messages/config/OptionsMessage.ts +16 -27
  51. package/controller/comms/messages/config/PumpMessage.ts +62 -47
  52. package/controller/comms/messages/config/RemoteMessage.ts +80 -13
  53. package/controller/comms/messages/config/ScheduleMessage.ts +390 -347
  54. package/controller/comms/messages/config/SecurityMessage.ts +2 -1
  55. package/controller/comms/messages/config/ValveMessage.ts +44 -27
  56. package/controller/comms/messages/status/ChlorinatorStateMessage.ts +44 -91
  57. package/controller/comms/messages/status/EquipmentStateMessage.ts +139 -30
  58. package/controller/comms/messages/status/HeaterStateMessage.ts +135 -86
  59. package/controller/comms/messages/status/IntelliChemStateMessage.ts +448 -445
  60. package/controller/comms/messages/status/IntelliValveStateMessage.ts +36 -35
  61. package/controller/comms/messages/status/PumpStateMessage.ts +92 -2
  62. package/controller/comms/messages/status/VersionMessage.ts +2 -1
  63. package/controller/nixie/Nixie.ts +173 -162
  64. package/controller/nixie/NixieEquipment.ts +104 -103
  65. package/controller/nixie/bodies/Body.ts +120 -120
  66. package/controller/nixie/bodies/Filter.ts +135 -135
  67. package/controller/nixie/chemistry/ChemController.ts +2682 -2498
  68. package/controller/nixie/chemistry/ChemDoser.ts +806 -0
  69. package/controller/nixie/chemistry/Chlorinator.ts +367 -314
  70. package/controller/nixie/circuits/Circuit.ts +402 -248
  71. package/controller/nixie/heaters/Heater.ts +815 -649
  72. package/controller/nixie/pumps/Pump.ts +934 -661
  73. package/controller/nixie/schedules/Schedule.ts +319 -257
  74. package/controller/nixie/valves/Valve.ts +170 -170
  75. package/defaultConfig.json +346 -286
  76. package/logger/DataLogger.ts +448 -448
  77. package/logger/Logger.ts +38 -9
  78. package/package.json +60 -56
  79. package/tsconfig.json +25 -25
  80. package/web/Server.ts +275 -117
  81. package/web/bindings/aqualinkD.json +560 -0
  82. package/web/bindings/homeassistant.json +437 -0
  83. package/web/bindings/influxDB.json +1066 -1021
  84. package/web/bindings/mqtt.json +721 -654
  85. package/web/bindings/mqttAlt.json +746 -684
  86. package/web/bindings/rulesManager.json +54 -54
  87. package/web/bindings/smartThings-Hubitat.json +31 -31
  88. package/web/bindings/valveRelays.json +20 -20
  89. package/web/bindings/vera.json +25 -25
  90. package/web/interfaces/baseInterface.ts +188 -136
  91. package/web/interfaces/httpInterface.ts +148 -124
  92. package/web/interfaces/influxInterface.ts +283 -245
  93. package/web/interfaces/mqttInterface.ts +695 -475
  94. package/web/interfaces/ruleInterface.ts +87 -0
  95. package/web/services/config/Config.ts +177 -49
  96. package/web/services/config/ConfigSocket.ts +2 -1
  97. package/web/services/state/State.ts +154 -3
  98. package/web/services/state/StateSocket.ts +69 -18
  99. package/web/services/utilities/Utilities.ts +232 -42
  100. package/.github/ISSUE_TEMPLATE/bug_report.md +0 -52
  101. package/config copy.json +0 -300
  102. package/issue_template.md +0 -52
@@ -1,661 +1,934 @@
1
- import { EquipmentNotFoundError, InvalidEquipmentDataError, InvalidEquipmentIdError, ParameterOutOfRangeError } from '../../Errors';
2
- import { utils, Timestamp } from '../../Constants';
3
- import { logger } from '../../../logger/Logger';
4
-
5
- import { NixieEquipment, NixieChildEquipment, NixieEquipmentCollection, INixieControlPanel } from "../NixieEquipment";
6
- import { Pump, PumpCircuit, PumpCollection, PumpRelay, sys } from "../../../controller/Equipment";
7
- import { CircuitState, PumpState, state, } from "../../State";
8
- import { setTimeout, clearTimeout } from 'timers';
9
- import { NixieControlPanel } from '../Nixie';
10
- import { webApp, InterfaceServerResponse } from "../../../web/Server";
11
- import { Outbound, Protocol } from '../../comms/messages/Messages';
12
- import { conn } from '../../comms/Comms';
13
-
14
- export class NixiePumpCollection extends NixieEquipmentCollection<NixiePump> {
15
- public async deletePumpAsync(id: number) {
16
- try {
17
- for (let i = this.length - 1; i >= 0; i--) {
18
- let pump = this[i];
19
- if (pump.id === id) {
20
- await pump.closeAsync();
21
- this.splice(i, 1);
22
- }
23
- }
24
- } catch (err) { logger.error(`Nixie Control Panel deletePumpAsync ${err.message}`); }
25
- }
26
- public async setPumpStateAsync(pstate: PumpState) {
27
- try {
28
- let pump: NixiePump = this.find(elem => elem.id === pstate.id) as NixiePump;
29
- if (typeof pump === 'undefined') {
30
- return logger.error(`Nixie Control Panel Error setPumpState could not find pump ${pstate.id}-${pstate.name}`);
31
- }
32
- await pump.setPumpStateAsync(pstate);
33
- } catch (err) { logger.error(`Nixie Error setting pump state ${pstate.id}-${pstate.name}: ${err.message}`); return Promise.reject(err); }
34
- }
35
- public async setPumpAsync(pump: Pump, data: any) {
36
- // By the time we get here we know that we are in control and this is a Nixie pump.
37
- try {
38
- let c: NixiePump = this.find(elem => elem.id === pump.id) as NixiePump;
39
- if (typeof c === 'undefined') {
40
- pump.master = 1;
41
- if (typeof data.type !== 'undefined') pump.type = data.type; // needed for init of correct type
42
- if (typeof pump.type === 'undefined') return Promise.reject(new InvalidEquipmentIdError(`Invalid pump type for ${pump.name}`, data.id, 'Pump'));
43
- c = this.pumpFactory(pump);
44
- // c = new NixiePump(this.controlPanel, pump);
45
- this.push(c);
46
- logger.info(`A pump was not found for id #${pump.id} creating pump`);
47
- return await c.setPumpAsync(data);
48
- }
49
- else {
50
- if (typeof data.type !== 'undefined' && c.pump.type !== data.type) {
51
- // pump exists, changing type
52
- await c.closeAsync();
53
- pump.type = data.type; // needed for init of correct type
54
- if (typeof pump.type === 'undefined') return Promise.reject(new InvalidEquipmentIdError(`Invalid pump type for ${pump.name}`, data.id, 'Pump'));
55
- c = this.pumpFactory(pump);
56
- }
57
- return await c.setPumpAsync(data);
58
- }
59
- }
60
- catch (err) { logger.error(`setPumpAsync: ${err.message}`); return Promise.reject(err); }
61
- }
62
- public async initAsync(pumps: PumpCollection) {
63
- try {
64
- for (let i = 0; i < pumps.length; i++) {
65
- let pump = pumps.getItemByIndex(i);
66
- if (pump.master === 1) {
67
- if (typeof this.find(elem => elem.id === pump.id) === 'undefined') {
68
- let type = sys.board.valueMaps.pumpTypes.getName(pump.type);
69
- let npump = this.pumpFactory(pump);
70
- logger.info(`Initializing Nixie Pump ${npump.id}-${pump.name}`);
71
- this.push(npump);
72
- }
73
- }
74
- }
75
- }
76
- catch (err) { logger.error(`Nixie Pump initAsync Error: ${err.message}`); return Promise.reject(err); }
77
- }
78
- public async closeAsync() {
79
- try {
80
- for (let i = this.length - 1; i >= 0; i--) {
81
- try {
82
- await this[i].closeAsync();
83
- this.splice(i, 1);
84
- } catch (err) { logger.error(`Error stopping Nixie Pump ${err}`); }
85
- }
86
- } catch (err) { } // Don't bail if we have an errror.
87
- }
88
-
89
- public async initPumpAsync(pump: Pump): Promise<NixiePump> {
90
- try {
91
- let c: NixiePump = this.find(elem => elem.id === pump.id) as NixiePump;
92
- if (pump.master === 1) {
93
- // if pump exists, close it so we can re-init
94
- // (EG if pump type changes, we need to setup a new instance of the pump)
95
- if (typeof c !== 'undefined' && c.pump.type !== pump.type) {
96
- await c.closeAsync();
97
- c = this.pumpFactory(pump);
98
- }
99
- logger.info(`Initializing Nixie Pump ${c.id}-${pump.name}`);
100
- this.push(c);
101
- }
102
- return c;
103
- } catch (err) { return Promise.reject(logger.error(`Nixie Controller: initPumpAsync Error: ${err.message}`)); }
104
- }
105
- private pumpFactory(pump: Pump) {
106
- let type = sys.board.valueMaps.pumpTypes.getName(pump.type);
107
- switch (type) {
108
- case 'ss':
109
- return new NixiePumpSS(this.controlPanel, pump);
110
- case 'ds':
111
- return new NixiePumpDS(this.controlPanel, pump);
112
- case 'vsf':
113
- return new NixiePumpVSF(this.controlPanel, pump);
114
- case 'vf':
115
- return new NixiePumpVF(this.controlPanel, pump);
116
- case 'sf':
117
- return new NixiePumpSF(this.controlPanel, pump);
118
- case 'vs':
119
- return new NixiePumpVS(this.controlPanel, pump);
120
- default:
121
- throw new EquipmentNotFoundError(`NCP: Cannot create pump ${pump.name}.`, type);
122
- }
123
- }
124
- public syncPumpStates() {
125
- // loop through all pumps and update rates based on circuit changes
126
- // this would happen in <2s anyway based on pollAsync but this is immediate.
127
- for (let i = this.length - 1; i >= 0; i--) {
128
- setTimeout(async () => {
129
- let pump = this[i] as NixiePump;
130
- try {
131
- if (!pump.closing) await pump.pollEquipmentAsync();
132
- } catch (err) { }
133
- }, 100);
134
-
135
- }
136
- }
137
- }
138
- export class NixiePump extends NixieEquipment {
139
- public pollingInterval: number = 2000;
140
- protected _pollTimer: NodeJS.Timeout = null;
141
- public pump: Pump;
142
- protected _targetSpeed: number;
143
- protected _suspendPolling = 0;
144
- public get suspendPolling(): boolean { return this._suspendPolling > 0; }
145
- public set suspendPolling(val: boolean) { this._suspendPolling = Math.max(0, this._suspendPolling + (val ? 1 : -1)); }
146
- public closing = false;
147
-
148
- /*
149
- _targetSpeed will hold values as follows:
150
- vs/vsf/vf: rpm/gpm;
151
- ss: 0=off, 1=on;
152
- ds/sf: bit shift 1-4 = values 1/2/4/8 for relays 1/2/3/4
153
- */
154
- constructor(ncp: INixieControlPanel, pump: Pump) {
155
- super(ncp);
156
- this.pump = pump;
157
- this._targetSpeed = 0;
158
- this.pollEquipmentAsync();
159
- }
160
- public get id(): number { return typeof this.pump !== 'undefined' ? this.pump.id : -1; }
161
- public async setPumpStateAsync(pstate: PumpState) {
162
- try {
163
- // Here we go we need to set the pump state.
164
- return new InterfaceServerResponse(200, 'Ok');
165
- } catch (err) { return Promise.reject(`Nixie Error setting pump state ${pstate.id}-${pstate.name}: ${err.message}`); }
166
- }
167
- public async setPumpAsync(data: any): Promise<InterfaceServerResponse> {
168
- try {
169
-
170
- this.pump.master = 1;
171
- // if (typeof data.isVirtual !== 'undefined') this.pump.isVirtual = data.isVirtual;
172
- this.pump.isActive = true;
173
- // if (typeof data.type !== 'undefined' && data.type !== this.pump.type) {
174
- // sys.board.pumps.setType(this.pump, data.type);
175
- // this.pump = sys.pumps.getItemById(id, true);
176
- // spump = state.pumps.getItemById(id, true);
177
- // }
178
- let type = sys.board.valueMaps.pumpTypes.transform(this.pump.type);
179
- this.pump.name = data.name || this.pump.name || type.desc;
180
- if (typeof type.maxCircuits !== 'undefined' && type.maxCircuits > 0 && typeof data.circuits !== 'undefined') { // This pump type supports circuits
181
- for (let i = 1; i <= data.circuits.length && i <= type.maxCircuits; i++) {
182
- let c = data.circuits[i - 1];
183
- let speed = parseInt(c.speed, 10);
184
- let relay = parseInt(c.relay, 10);
185
- let flow = parseInt(c.flow, 10);
186
- if (isNaN(speed)) speed = type.minSpeed;
187
- if (isNaN(flow)) flow = type.minFlow;
188
- if (isNaN(relay)) relay = 1;
189
- c.units = parseInt(c.units, 10) || type.name === 'vf' ? sys.board.valueMaps.pumpUnits.getValue('gpm') : sys.board.valueMaps.pumpUnits.getValue('rpm');
190
- if (typeof type.minSpeed !== 'undefined' && c.units === sys.board.valueMaps.pumpUnits.getValue('rpm')) {
191
- c.speed = speed;
192
- }
193
- else if (typeof type.minFlow !== 'undefined' && c.units === sys.board.valueMaps.pumpUnits.getValue('gpm')) {
194
- c.flow = flow;
195
- }
196
- else if (type.maxRelays > 0)
197
- c.relay = relay;
198
- }
199
- }
200
- this.pump.set(data); // Sets all the data back to the pump. This also sets the relays should it exist on the data.
201
- let spump = state.pumps.getItemById(this.pump.id, true);
202
- spump.name = this.pump.name;
203
- spump.address = this.pump.address;
204
- spump.type = this.pump.type;
205
- sys.pumps.sortById();
206
- state.pumps.sortById();
207
- return Promise.resolve(new InterfaceServerResponse(200, 'Ok'));
208
- }
209
- catch (err) { logger.error(`Nixie setPumpAsync: ${err.message}`); return Promise.reject(err); }
210
- }
211
- public async pollEquipmentAsync() {
212
- let self = this;
213
- try {
214
- if (this.suspendPolling || this.closing) return;
215
- if (typeof this._pollTimer !== 'undefined' || this._pollTimer) clearTimeout(this._pollTimer);
216
- this._pollTimer = null;
217
- // let success = false;
218
- let pstate = state.pumps.getItemById(this.pump.id);
219
- this.setTargetSpeed(pstate);
220
- await this.setPumpStateAsync(pstate);
221
- }
222
- catch (err) { logger.error(`Nixie Error running pump sequence - ${err}`); }
223
- finally { if (!this.closing) this._pollTimer = setTimeout(async () => await self.pollEquipmentAsync(), this.pollingInterval || 2000); }
224
- }
225
- private async checkHardwareStatusAsync(connectionId: string, deviceBinding: string) {
226
- try {
227
- let dev = await NixieEquipment.getDeviceService(connectionId, `/status/device/${deviceBinding}`);
228
- return dev;
229
- } catch (err) { logger.error(`Nixie Pump checkHardwareStatusAsync: ${err.message}`); return { hasFault: true } }
230
- }
231
- public async validateSetupAsync(pump: Pump, pstate: PumpState) {
232
- try {
233
- } catch (err) { logger.error(`Nixie Error checking Pump Hardware ${this.pump.name}: ${err.message}`); return Promise.reject(err); }
234
- }
235
- public async closeAsync() {
236
- try {
237
- logger.info(`Nixie Pump closing ${this.pump.name}.`)
238
- if (typeof this._pollTimer !== 'undefined' || this._pollTimer) clearTimeout(this._pollTimer);
239
- this._pollTimer = null;
240
- this._targetSpeed = 0;
241
- let pstate = state.pumps.getItemById(this.pump.id);
242
- try {
243
- await this.setPumpStateAsync(pstate);
244
- // Since we are closing we need to not reject.
245
- } catch (err) { logger.error(`Nixie Closing pump closeAsync: ${err.message}`); }
246
- // This will make sure the timer is dead and we are completely closed.
247
- this.closing = true;
248
- if (typeof this._pollTimer !== 'undefined' || this._pollTimer) clearTimeout(this._pollTimer);
249
- pstate.emitEquipmentChange();
250
- }
251
- catch (err) { logger.error(`Nixie Pump closeAsync: ${err.message}`); return Promise.reject(err); }
252
- }
253
- public logData(filename: string, data: any) { this.controlPanel.logData(filename, data); }
254
- protected setTargetSpeed(pstate: PumpState) { };
255
- protected isBodyOn(bodyCode: number) {
256
- let assoc = sys.board.valueMaps.pumpBodies.transform(bodyCode);
257
- switch (assoc.name) {
258
- case 'body1':
259
- case 'pool':
260
- return state.temps.bodies.getItemById(1).isOn;
261
- case 'body2':
262
- case 'spa':
263
- return state.temps.bodies.getItemById(2).isOn;
264
- case 'body3':
265
- return state.temps.bodies.getItemById(3).isOn;
266
- case 'body4':
267
- return state.temps.bodies.getItemById(4).isOn;
268
- case 'poolspa':
269
- if (sys.equipment.shared && sys.equipment.maxBodies >= 2) {
270
- return state.temps.bodies.getItemById(1).isOn === true || state.temps.bodies.getItemById(2).isOn === true;
271
- }
272
- else
273
- return state.temps.bodies.getItemById(1).isOn;
274
- }
275
- return false;
276
- }
277
- }
278
- export class NixiePumpSS extends NixiePump {
279
- public setTargetSpeed(pState: PumpState) {
280
- // Turn on ss pumps.
281
- let _newSpeed = 0;
282
- if (!pState.pumpOnDelay) {
283
- let pt = sys.board.valueMaps.pumpTypes.get(this.pump.type);
284
- if (pt.hasBody) _newSpeed = this.isBodyOn(this.pump.body) ? 1 : 0;
285
- //console.log(`BODY: ${sys.board.bodies.isBodyOn(this.pump.body)} CODE: ${this.pump.body}`);
286
- }
287
- if (this._targetSpeed !== _newSpeed) logger.info(`NCP: Setting Pump ${this.pump.name} to ${_newSpeed > 0 ? 'on' : 'off'}. ${sys.board.bodies.isBodyOn(this.pump.body)}`);
288
- if (isNaN(_newSpeed)) _newSpeed = 0;
289
- this._targetSpeed = _newSpeed;
290
- }
291
- public async setPumpStateAsync(pstate: PumpState) {
292
- let relays: PumpRelay[] = this.pump.relays.get();
293
- let relayState = 0;
294
- for (let i = 0; i < relays.length; i++) {
295
- let pr = relays[i];
296
- if (typeof pr.id === 'undefined') pr.id = i + 1; // remove when id is added to dP relays upon save.
297
- let isOn = this._targetSpeed >> pr.id - 1 & 1;
298
- if (utils.isNullOrEmpty(pr.connectionId) || utils.isNullOrEmpty(pr.deviceBinding)) {
299
- // If they haven't set a program for the relay bugger out.
300
- if (isOn) relayState |= (1 << pr.id - 1);
301
- }
302
- else {
303
- try {
304
- let res = await NixieEquipment.putDeviceService(pr.connectionId, `/state/device/${pr.deviceBinding}`, { isOn, latch: isOn ? 5000 : undefined });
305
- if (res.status.code === 200) {
306
- if (isOn) relayState |= (1 << pr.id - 1);
307
- }
308
- else pstate.status = 16;
309
- }
310
- catch (err) {
311
- logger.error(`NCP: Error setting pump ${this.pump.name} relay ${pr.id} to ${isOn ? 'on' : 'off'}. Error ${err.message}}`);
312
- pstate.status = 16;
313
- }
314
- }
315
- }
316
- if (pstate.targetSpeed === 0) {
317
- pstate.status = 0;
318
- pstate.driveState = 0; // We need to set this if it is a priming cycle but it might not matter for our relay based pumps.
319
- pstate.command = 0;
320
- }
321
- else if (relayState === pstate.targetSpeed) {
322
- pstate.status = 1;
323
- pstate.driveState = 2;
324
- pstate.command = 4;
325
- }
326
- pstate.relay = relayState;
327
- return new InterfaceServerResponse(200, 'Success');
328
- }
329
- }
330
- export class NixiePumpDS extends NixiePumpSS {
331
- public setTargetSpeed(pState: PumpState) {
332
- // Turn on sf pumps. The new speed will be the relays associated with the pump. I believe when this comes out in the final
333
- // wash it should engage all the relays for all speeds associated with the pump. The pump logic will determine which program is
334
- // the one to engage.
335
- let _newSpeed = 0;
336
- if (!pState.pumpOnDelay) {
337
- let pumpCircuits: PumpCircuit[] = this.pump.circuits.get();
338
- if (!pState.pumpOnDelay) {
339
- for (let i = 0; i < pumpCircuits.length; i++) {
340
- let circ = state.circuits.getInterfaceById(pumpCircuits[i].circuit);
341
- // relay speeds are bit-shifted 'or' based on 1,2,4,8
342
- if (circ.isOn) _newSpeed |= (1 << pumpCircuits[i].relay - 1);
343
- }
344
- }
345
- }
346
- if (isNaN(_newSpeed)) _newSpeed = 0;
347
- this.logSpeed(_newSpeed);
348
- this._targetSpeed = _newSpeed;
349
- }
350
- public logSpeed(_newSpeed: number) {
351
- 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'}.`);
352
- }
353
- }
354
- export class NixiePumpSF extends NixiePumpDS {
355
- // effectively operates the same way as a DS pump since we removed the body association on DS.
356
- // only logger msg is different
357
- public logSpeed(_newSpeed: number) {
358
- 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'}.`);
359
- }
360
- }
361
- export class NixiePumpRS485 extends NixiePump {
362
- public async setPumpStateAsync(pstate: PumpState) {
363
- // Don't poll while we are seting the state.
364
- this.suspendPolling = true;
365
- try {
366
- let pt = sys.board.valueMaps.pumpTypes.get(this.pump.type);
367
- // Since these process are async the closing flag can be set
368
- // between calls. We need to check it in between each call.
369
- try { if (!this.closing) await this.setDriveStateAsync(); } catch (err) {}
370
- try { if (!this.closing) {
371
- if (this._targetSpeed >= pt.minFlow && this._targetSpeed <= pt.maxFlow) await this.setPumpGPMAsync();
372
- else if (this._targetSpeed >= pt.minSpeed && this._targetSpeed <= pt.maxSpeed) await this.setPumpRPMAsync();
373
- } } catch (err) {}
374
-
375
- try { if(!this.closing) await this.setPumpFeature(6); } catch (err) {};
376
- try { if(!this.closing) await utils.sleep(1000); } catch (err) {};
377
- try { if(!this.closing) await this.requestPumpStatus(); } catch (err) {};
378
- try { if(!this.closing) await this.setPumpToRemoteControl(); } catch (err) {};
379
- return new InterfaceServerResponse(200, 'Success');
380
- }
381
- catch (err) {
382
- logger.error(`Error running pump sequence for ${this.pump.name}: ${err.message}`);
383
- return Promise.reject(err);
384
- }
385
- finally { this.suspendPolling = false; }
386
- };
387
- protected async setDriveStateAsync(running: boolean = true) {
388
- return new Promise<void>((resolve, reject) => {
389
- let out = Outbound.create({
390
- protocol: Protocol.Pump,
391
- dest: this.pump.address,
392
- action: 6,
393
- payload: running && this._targetSpeed > 0 ? [10] : [4],
394
- retries: 1,
395
- response: true,
396
- onComplete: (err, msg: Outbound) => {
397
- if (err) {
398
- logger.error(`Error sending setDriveState for ${this.pump.name} : ${err.message}`);
399
- reject(err);
400
- }
401
- else resolve();
402
- }
403
- });
404
- conn.queueSendMessage(out);
405
- });
406
- };
407
- protected async requestPumpStatus() {
408
- return new Promise<void>((resolve, reject) => {
409
- let out = Outbound.create({
410
- protocol: Protocol.Pump,
411
- dest: this.pump.address,
412
- action: 7,
413
- payload: [],
414
- retries: 2,
415
- response: true,
416
- onComplete: (err, msg) => {
417
- if (err) {
418
- logger.error(`Error sending requestPumpStatus for ${this.pump.name}: ${err.message}`);
419
- reject(err);
420
- }
421
- else resolve();
422
- }
423
- });
424
- conn.queueSendMessage(out);
425
- })
426
- };
427
- protected setPumpToRemoteControl(running: boolean = true) {
428
- return new Promise<void>((resolve, reject) => {
429
- let out = Outbound.create({
430
- protocol: Protocol.Pump,
431
- dest: this.pump.address,
432
- action: 4,
433
- payload: running ? [255] : [0], // when stopAsync is called, pass false to return control to pump panel
434
- // payload: spump.virtualControllerStatus === sys.board.valueMaps.virtualControllerStatus.getValue('running') ? [255] : [0],
435
- retries: 1,
436
- response: true,
437
- onComplete: (err) => {
438
- if (err) {
439
- logger.error(`Error sending setPumpToRemoteControl for ${this.pump.name}: ${err.message}`);
440
- reject(err);
441
- }
442
- else resolve();
443
- }
444
- });
445
- conn.queueSendMessage(out);
446
- });
447
- }
448
- protected setPumpFeature(feature?: number) {
449
- // empty payload (possibly 0?, too) is no feature
450
- // 6: Feature 1
451
- return new Promise<void>((resolve, reject) => {
452
- let out = Outbound.create({
453
- protocol: Protocol.Pump,
454
- dest: this.pump.address,
455
- action: 5,
456
- payload: typeof feature === 'undefined' ? [] : [ feature ],
457
- retries: 2,
458
- repsonse: true,
459
- onComplete: (err, msg: Outbound) => {
460
- if (err) {
461
- logger.error(`Error sending setPumpManual for ${this.pump.name}: ${err.message}`);
462
- reject(err);
463
- }
464
- else resolve();
465
- }
466
- });
467
- conn.queueSendMessage(out);
468
- });
469
- };
470
- protected async setPumpRPMAsync() {
471
- return new Promise<void>((resolve, reject) => {
472
- let out = Outbound.create({
473
- protocol: Protocol.Pump,
474
- dest: this.pump.address,
475
- action: 1,
476
- payload: [2, 196, Math.floor(this._targetSpeed / 256), this._targetSpeed % 256],
477
- retries: 1,
478
- // timeout: 250,
479
- response: true,
480
- onComplete: (err, msg) => {
481
- if (err) {
482
- logger.error(`Error sending setPumpRPMAsync for ${this.pump.name}: ${err.message}`);
483
- reject(err);
484
- }
485
- else resolve();
486
- }
487
- });
488
- conn.queueSendMessage(out);
489
- });
490
- };
491
- protected async setPumpGPMAsync() {
492
- // packet for vf; vsf will override
493
- return new Promise<void>((resolve, reject) => {
494
- let out = Outbound.create({
495
- protocol: Protocol.Pump,
496
- dest: this.pump.address,
497
- action: 1,
498
- payload: [2, 228, 0, this._targetSpeed],
499
- retries: 1,
500
- response: true,
501
- onComplete: (err, msg) => {
502
- if (err) {
503
- logger.error(`Error sending setPumpGPMAsync for ${this.pump.name}: ${err.message}`);
504
- reject(err);
505
- }
506
- else resolve();
507
- }
508
- });
509
- conn.queueSendMessage(out);
510
- });
511
- };
512
- public async closeAsync() {
513
- try {
514
- this.suspendPolling = true;
515
- logger.info(`Nixie Pump closing ${this.pump.name}.`)
516
- if (typeof this._pollTimer !== 'undefined' || this._pollTimer) clearTimeout(this._pollTimer);
517
- this._pollTimer = null;
518
- let pstate = state.pumps.getItemById(this.pump.id);
519
- this._targetSpeed = 0;
520
- try { await this.setDriveStateAsync(false); } catch (err) { logger.error(`Error closing pump ${this.pump.name}: ${err.message}`) }
521
- try { await this.setPumpFeature(); } catch (err) { logger.error(`Error closing pump ${this.pump.name}: ${err.message}`) }
522
- try { await this.setDriveStateAsync(false); } catch (err) { logger.error(`Error closing pump ${this.pump.name}: ${err.message}`) }
523
- try { await this.setPumpToRemoteControl(false); } catch (err) { logger.error(`Error closing pump ${this.pump.name}: ${err.message}`) }
524
- this.closing = true;
525
- // Make sure the polling timer is dead after we have closted this all off. That way we do not
526
- // have another process that revives it from the dead.
527
- if (typeof this._pollTimer !== 'undefined' || this._pollTimer) clearTimeout(this._pollTimer);
528
- this._pollTimer = null;
529
- pstate.emitEquipmentChange();
530
- }
531
- catch (err) { logger.error(`Nixie Pump closeAsync: ${err.message}`); return Promise.reject(err); }
532
- finally { this.suspendPolling = false; }
533
- }
534
- }
535
- export class NixiePumpVS extends NixiePumpRS485 {
536
- public setTargetSpeed(pState: PumpState) {
537
- let _newSpeed = 0;
538
- if (!pState.pumpOnDelay) {
539
- let pumpCircuits = this.pump.circuits.get();
540
-
541
- for (let i = 0; i < pumpCircuits.length; i++) {
542
- let circ = state.circuits.getInterfaceById(pumpCircuits[i].circuit);
543
- let pc = pumpCircuits[i];
544
- if (circ.isOn) _newSpeed = Math.max(_newSpeed, pc.speed);
545
- }
546
- }
547
- if (isNaN(_newSpeed)) _newSpeed = 0;
548
- this._targetSpeed = _newSpeed;
549
- if (this._targetSpeed !== 0) Math.min(Math.max(this.pump.minSpeed, this._targetSpeed), this.pump.maxSpeed);
550
- if (this._targetSpeed !== _newSpeed) logger.info(`NCP: Setting Pump ${this.pump.name} to ${_newSpeed} RPM.`);
551
- }
552
- }
553
- export class NixiePumpVF extends NixiePumpRS485 {
554
- public setTargetSpeed(pState: PumpState) {
555
- let _newSpeed = 0;
556
- if (!pState.pumpOnDelay) {
557
- let pumpCircuits = this.pump.circuits.get();
558
- for (let i = 0; i < pumpCircuits.length; i++) {
559
- let circ = state.circuits.getInterfaceById(pumpCircuits[i].circuit);
560
- let pc = pumpCircuits[i];
561
- if (circ.isOn) _newSpeed = Math.max(_newSpeed, pc.flow);
562
- }
563
- }
564
- if (isNaN(_newSpeed)) _newSpeed = 0;
565
- this._targetSpeed = _newSpeed;
566
- if (this._targetSpeed !== 0) Math.min(Math.max(this.pump.minFlow, this._targetSpeed), this.pump.maxFlow);
567
- if (this._targetSpeed !== _newSpeed) logger.info(`NCP: Setting Pump ${this.pump.name} to ${_newSpeed} GPM.`);
568
- }
569
- }
570
- export class NixiePumpVSF extends NixiePumpRS485 {
571
- public setTargetSpeed(pState: PumpState) {
572
- let _newSpeed = 0;
573
- let maxRPM = 0;
574
- let maxGPM = 0;
575
- let flows = 0;
576
- let speeds = 0;
577
- if (!pState.pumpOnDelay) {
578
- let pumpCircuits = this.pump.circuits.get();
579
- let pt = sys.board.valueMaps.pumpTypes.get(this.pump.type);
580
- // 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
581
- // 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
582
- // the GPM to RPM but if there is none then it will use GPM.
583
- let toRPM = (flowRate: number, minSpeed: number = 450, maxSpeed: number = 3450) => {
584
- let eff = .03317 * maxSpeed;
585
- let rpm = Math.min((flowRate * maxSpeed) / eff, maxSpeed);
586
- return rpm > 0 ? Math.max(rpm, minSpeed) : 0;
587
- };
588
- let toGPM = (speed: number, maxSpeed: number = 3450, minFlow: number = 15, maxFlow: number = 140) => {
589
- let eff = .03317 * maxSpeed;
590
- let gpm = Math.min((eff * speed) / maxSpeed, maxFlow);
591
- return gpm > 0 ? Math.max(gpm, minFlow) : 0;
592
- }
593
- for (let i = 0; i < pumpCircuits.length; i++) {
594
- let circ = state.circuits.getInterfaceById(pumpCircuits[i].circuit);
595
- let pc = pumpCircuits[i];
596
- if (circ.isOn) {
597
- if (pc.units > 0) {
598
- maxGPM = Math.max(maxGPM, pc.flow);
599
- // Calculate an RPM from this flow.
600
- maxRPM = Math.max(maxGPM, toRPM(pc.flow, pt.minSpeed, pt.maxSpeed));
601
- flows++;
602
- }
603
- else {
604
- maxRPM = Math.max(maxRPM, pc.speed);
605
- maxGPM = Math.max(maxGPM, toGPM(pc.speed, pt.maxSpeed, pt.minFlow, pt.maxFlow));
606
- speeds++;
607
- }
608
- }
609
- }
610
- _newSpeed = speeds > 0 || flows === 0 ? maxRPM : maxGPM;
611
- }
612
- if (isNaN(_newSpeed)) _newSpeed = 0;
613
- // Send the flow message if it is flow and the rpm message if it is rpm.
614
- if (this._targetSpeed !== _newSpeed) logger.info(`NCP: Setting Pump ${this.pump.name} to ${_newSpeed} ${flows > 0 ? 'GPM' : 'RPM'}.`);
615
- this._targetSpeed = _newSpeed;
616
- }
617
- protected async setPumpRPMAsync() {
618
- // vsf action is 10 for rpm
619
- return new Promise<void>((resolve, reject) => {
620
- let out = Outbound.create({
621
- protocol: Protocol.Pump,
622
- dest: this.pump.address,
623
- action: 10,
624
- payload: [2, 196, Math.floor(this._targetSpeed / 256), this._targetSpeed % 256],
625
- retries: 1,
626
- // timeout: 250,
627
- response: true,
628
- onComplete: (err, msg) => {
629
- if (err) {
630
- logger.error(`Error sending setPumpRPMAsync for ${this.pump.name}: ${err.message}`);
631
- reject(err);
632
- }
633
- else resolve();
634
- }
635
- });
636
- conn.queueSendMessage(out);
637
- });
638
- };
639
- protected async setPumpGPMAsync() {
640
- // vsf payload; different from vf payload
641
- return new Promise<void>((resolve, reject) => {
642
- let out = Outbound.create({
643
- protocol: Protocol.Pump,
644
- dest: this.pump.address,
645
- action: 9,
646
- payload: [2, 196, 0, this._targetSpeed],
647
- retries: 1,
648
- response: true,
649
- onComplete: (err, msg) => {
650
- if (err) {
651
- logger.error(`Error sending setPumpGPMAsync for ${this.pump.name}: ${err.message}`);
652
- reject(err);
653
- }
654
- else resolve();
655
- return
656
- }
657
- });
658
- conn.queueSendMessage(out);
659
- });
660
- };
661
- };
1
+ import { EquipmentNotFoundError, InvalidEquipmentDataError, InvalidEquipmentIdError, ParameterOutOfRangeError } from '../../Errors';
2
+ import { utils, Timestamp } from '../../Constants';
3
+ import { logger } from '../../../logger/Logger';
4
+
5
+ import { NixieEquipment, NixieChildEquipment, NixieEquipmentCollection, INixieControlPanel } from "../NixieEquipment";
6
+ import { Pump, PumpCircuit, PumpCollection, PumpRelay, sys } from "../../../controller/Equipment";
7
+ import { CircuitState, PumpState, state, } from "../../State";
8
+ import { setTimeout as setTimeoutSync, clearTimeout } from 'timers';
9
+ import { NixieControlPanel } from '../Nixie';
10
+ import { webApp, InterfaceServerResponse } from "../../../web/Server";
11
+ import { Outbound, Protocol, Response } from '../../comms/messages/Messages';
12
+ import { conn } from '../../comms/Comms';
13
+ import { setTimeout } from 'timers/promises';
14
+
15
+ export class NixiePumpCollection extends NixieEquipmentCollection<NixiePump> {
16
+ public async deletePumpAsync(id: number) {
17
+ try {
18
+ for (let i = this.length - 1; i >= 0; i--) {
19
+ let pump = this[i];
20
+ if (pump.id === id) {
21
+ await pump.closeAsync();
22
+ this.splice(i, 1);
23
+ }
24
+ }
25
+ } catch (err) { logger.error(`Nixie Control Panel deletePumpAsync ${err.message}`); }
26
+ }
27
+ public async setPumpStateAsync(pstate: PumpState) {
28
+ try {
29
+ let pump: NixiePump = this.find(elem => elem.id === pstate.id) as NixiePump;
30
+ if (typeof pump === 'undefined') {
31
+ return logger.error(`Nixie Control Panel Error setPumpState could not find pump ${pstate.id}-${pstate.name}`);
32
+ }
33
+ await pump.setPumpStateAsync(pstate);
34
+ } catch (err) { logger.error(`Nixie Error setting pump state ${pstate.id}-${pstate.name}: ${err.message}`); return Promise.reject(err); }
35
+ }
36
+ public async setPumpAsync(pump: Pump, data: any) {
37
+ // By the time we get here we know that we are in control and this is a Nixie pump.
38
+ try {
39
+ let c: NixiePump = this.find(elem => elem.id === pump.id) as NixiePump;
40
+ if (typeof c === 'undefined') {
41
+ pump.master = 1;
42
+ if (typeof data.type !== 'undefined') pump.type = data.type; // needed for init of correct type
43
+ if (typeof pump.type === 'undefined') return Promise.reject(new InvalidEquipmentIdError(`Invalid pump type for ${pump.name}`, data.id, 'Pump'));
44
+ c = this.pumpFactory(pump);
45
+ // c = new NixiePump(this.controlPanel, pump);
46
+ this.push(c);
47
+ logger.info(`A pump was not found for id #${pump.id} creating pump`);
48
+ return await c.setPumpAsync(data);
49
+ }
50
+ else {
51
+ if (typeof data.type !== 'undefined' && c.pump.type !== data.type) {
52
+ // pump exists, changing type
53
+ await c.closeAsync();
54
+ pump.type = data.type; // needed for init of correct type
55
+ if (typeof pump.type === 'undefined') return Promise.reject(new InvalidEquipmentIdError(`Invalid pump type for ${pump.name}`, data.id, 'Pump'));
56
+ c = this.pumpFactory(pump);
57
+ }
58
+ return await c.setPumpAsync(data);
59
+ }
60
+ }
61
+ catch (err) { logger.error(`setPumpAsync: ${err.message}`); return Promise.reject(err); }
62
+ }
63
+ public async initAsync(pumps: PumpCollection) {
64
+ try {
65
+ for (let i = 0; i < pumps.length; i++) {
66
+ let pump = pumps.getItemByIndex(i);
67
+ if (pump.master === 1) {
68
+ if (typeof this.find(elem => elem.id === pump.id) === 'undefined') {
69
+ let type = sys.board.valueMaps.pumpTypes.getName(pump.type);
70
+ let npump = this.pumpFactory(pump);
71
+ logger.info(`Initializing Nixie Pump ${npump.id}-${pump.name}`);
72
+ this.push(npump);
73
+ await npump.initAsync();
74
+ }
75
+ }
76
+ }
77
+ }
78
+ catch (err) { logger.error(`Nixie Pump initAsync Error: ${err.message}`); return Promise.reject(err); }
79
+ }
80
+ public async closeAsync() {
81
+ try {
82
+ for (let i = this.length - 1; i >= 0; i--) {
83
+ try {
84
+ await this[i].closeAsync();
85
+ this.splice(i, 1);
86
+ } catch (err) { logger.error(`Error stopping Nixie Pump ${err}`); }
87
+ }
88
+ } catch (err) { } // Don't bail if we have an errror.
89
+ }
90
+ public async setServiceModeAsync() {
91
+ try {
92
+ for (let i = this.length - 1; i >= 0; i--) {
93
+ try {
94
+ let p = this[i] as NixiePump;
95
+ await p.setServiceModeAsync();
96
+ } catch (err) { logger.error(`Error setting service mode for Nixie Pump ${err}`); }
97
+ }
98
+ } catch (err) { } // Don't bail if we have an errror.
99
+ }
100
+ public async initPumpAsync(pump: Pump): Promise<NixiePump> {
101
+ try {
102
+ let c: NixiePump = this.find(elem => elem.id === pump.id) as NixiePump;
103
+ if (pump.master === 1) {
104
+ // if pump exists, close it so we can re-init
105
+ // (EG if pump type changes, we need to setup a new instance of the pump)
106
+ if (typeof c !== 'undefined' && c.pump.type !== pump.type) {
107
+ await c.closeAsync();
108
+ c = this.pumpFactory(pump);
109
+ }
110
+ logger.info(`Initializing Nixie Pump ${c.id}-${pump.name}`);
111
+ this.push(c);
112
+ }
113
+ return c;
114
+ } catch (err) { return Promise.reject(logger.error(`Nixie Controller: initPumpAsync Error: ${err.message}`)); }
115
+ }
116
+ private pumpFactory(pump: Pump) {
117
+ let type = sys.board.valueMaps.pumpTypes.getName(pump.type);
118
+ switch (type) {
119
+ case 'ss':
120
+ return new NixiePumpSS(this.controlPanel, pump);
121
+ case 'ds':
122
+ return new NixiePumpDS(this.controlPanel, pump);
123
+ case 'vsf':
124
+ return new NixiePumpVSF(this.controlPanel, pump);
125
+ case 'vf':
126
+ return new NixiePumpVF(this.controlPanel, pump);
127
+ case 'sf':
128
+ return new NixiePumpSF(this.controlPanel, pump);
129
+ case 'vs':
130
+ return new NixiePumpVS(this.controlPanel, pump);
131
+ case 'hwvs':
132
+ return new NixiePumpHWVS(this.controlPanel, pump);
133
+ case 'hwrly':
134
+ return new NixiePumpHWRLY(this.controlPanel, pump);
135
+ default:
136
+ throw new EquipmentNotFoundError(`NCP: Cannot create pump ${pump.name}.`, type);
137
+ }
138
+ }
139
+ public syncPumpStates() {
140
+ // loop through all pumps and update rates based on circuit changes
141
+ // this would happen in <2s anyway based on pollAsync but this is immediate.
142
+ for (let i = this.length - 1; i >= 0; i--) {
143
+ setTimeoutSync(async () => {
144
+ let pump = this[i] as NixiePump;
145
+ try {
146
+ if (!pump.closing) await pump.pollEquipmentAsync();
147
+ } catch (err) { }
148
+ }, 100);
149
+
150
+ }
151
+ }
152
+ }
153
+ export class NixiePump extends NixieEquipment {
154
+ public pollingInterval: number = 2000;
155
+ protected _pollTimer: NodeJS.Timeout = null;
156
+ public pump: Pump;
157
+ protected _targetSpeed: number;
158
+ protected _suspendPolling = 0;
159
+ public get suspendPolling(): boolean { return this._suspendPolling > 0; }
160
+ public set suspendPolling(val: boolean) { this._suspendPolling = Math.max(0, this._suspendPolling + (val ? 1 : -1)); }
161
+ public closing = false;
162
+ public async setServiceModeAsync() {
163
+ let pstate = state.pumps.getItemById(this.pump.id);
164
+ await this.setPumpStateAsync(pstate);
165
+ }
166
+ /*
167
+ _targetSpeed will hold values as follows:
168
+ vs/vsf/vf: rpm/gpm;
169
+ ss: 0=off, 1=on;
170
+ ds/sf: bit shift 1-4 = values 1/2/4/8 for relays 1/2/3/4
171
+ */
172
+ constructor(ncp: INixieControlPanel, pump: Pump) {
173
+ super(ncp);
174
+ this.pump = pump;
175
+ this._targetSpeed = 0;
176
+ }
177
+ public async initAsync() {
178
+ if (this._pollTimer) {
179
+ clearTimeout(this._pollTimer);
180
+ this._pollTimer = undefined;
181
+ }
182
+ this.closing = false;
183
+ this._suspendPolling = 0;
184
+ this.pollEquipmentAsync();
185
+ }
186
+ public get id(): number { return typeof this.pump !== 'undefined' ? this.pump.id : -1; }
187
+ public async setPumpStateAsync(pstate: PumpState) {
188
+ try {
189
+ // Here we go we need to set the pump state.
190
+ return new InterfaceServerResponse(200, 'Ok');
191
+ } catch (err) { return Promise.reject(`Nixie Error setting pump state ${pstate.id}-${pstate.name}: ${err.message}`); }
192
+ }
193
+ public async setPumpAsync(data: any): Promise<InterfaceServerResponse> {
194
+ try {
195
+
196
+ this.pump.master = 1;
197
+ // if (typeof data.isVirtual !== 'undefined') this.pump.isVirtual = data.isVirtual;
198
+ this.pump.isActive = true;
199
+ // if (typeof data.type !== 'undefined' && data.type !== this.pump.type) {
200
+ // sys.board.pumps.setType(this.pump, data.type);
201
+ // this.pump = sys.pumps.getItemById(id, true);
202
+ // spump = state.pumps.getItemById(id, true);
203
+ // }
204
+ let type = sys.board.valueMaps.pumpTypes.transform(this.pump.type);
205
+ this.pump.name = data.name || this.pump.name || type.desc;
206
+ if (typeof type.maxCircuits !== 'undefined' && type.maxCircuits > 0 && typeof data.circuits !== 'undefined') { // This pump type supports circuits
207
+ for (let i = 1; i <= data.circuits.length && i <= type.maxCircuits; i++) {
208
+ let c = data.circuits[i - 1];
209
+ c.id = i;
210
+ let circuit = parseInt(c.circuit, 10);
211
+ let cd = this.pump.circuits.find(elem => elem.circuit === circuit);
212
+ let speed = parseInt(c.speed, 10);
213
+ let relay = parseInt(c.relay, 10);
214
+ let flow = parseInt(c.flow, 10);
215
+ let units = typeof c.units !== 'undefined' ? sys.board.valueMaps.pumpUnits.encode(c.units) : undefined;
216
+ switch (type.name) {
217
+ case 'vf':
218
+ units = sys.board.valueMaps.pumpUnits.getValue('gpm');
219
+ break;
220
+ case 'hwvs':
221
+ case 'vssvrs':
222
+ case 'vs':
223
+ c.units = sys.board.valueMaps.pumpUnits.getValue('rpm');
224
+ break;
225
+ case 'ss':
226
+ case 'ds':
227
+ case 'sf':
228
+ case 'hwrly':
229
+ c.units = 'undefined';
230
+ break;
231
+ }
232
+ if (isNaN(units)) units = typeof cd !== 'undefined' ? cd.units : sys.board.valueMaps.pumpUnits.getValue('rpm');
233
+ if (isNaN(speed)) speed = type.minSpeed;
234
+ if (isNaN(flow)) flow = type.minFlow;
235
+ if (isNaN(relay)) relay = 1;
236
+ c.units = units;
237
+ //c.units = parseInt(c.units, 10) || type.name === 'vf' ? sys.board.valueMaps.pumpUnits.getValue('gpm') : sys.board.valueMaps.pumpUnits.getValue('rpm');
238
+ if (typeof type.minSpeed !== 'undefined' && c.units === sys.board.valueMaps.pumpUnits.getValue('rpm')) {
239
+ c.speed = speed;
240
+ }
241
+ else if (typeof type.minFlow !== 'undefined' && c.units === sys.board.valueMaps.pumpUnits.getValue('gpm')) {
242
+ c.flow = flow;
243
+ }
244
+ else if (type.maxRelays > 0)
245
+ c.relay = relay;
246
+ }
247
+ }
248
+ this.pump.set(data); // Sets all the data back to the pump. This also sets the relays should it exist on the data.
249
+ let spump = state.pumps.getItemById(this.pump.id, true);
250
+ spump.name = this.pump.name;
251
+ spump.address = this.pump.address;
252
+ spump.type = this.pump.type;
253
+ sys.pumps.sortById();
254
+ state.pumps.sortById();
255
+ this.pump.hasChanged = true;
256
+ this.pollEquipmentAsync();
257
+ return Promise.resolve(new InterfaceServerResponse(200, 'Ok'));
258
+ }
259
+ catch (err) { logger.error(`Nixie setPumpAsync: ${err.message}`); return Promise.reject(err); }
260
+ }
261
+ public async pollEquipmentAsync() {
262
+ let self = this;
263
+ try {
264
+ // RSG 8-2022. Refactored to add initasync. With this.pollEquipmentAsync inside the
265
+ // constructor we could get here before the pump is initialized. The added check
266
+ // for the 112 address prevented that previously, but now is just a final fail safe.
267
+ if (this.suspendPolling || this.closing || this.pump.address > 112) return;
268
+ if (typeof this._pollTimer !== 'undefined' || this._pollTimer) clearTimeout(this._pollTimer);
269
+ this._pollTimer = null;
270
+ // let success = false;
271
+ let pstate = state.pumps.getItemById(this.pump.id);
272
+ this.setTargetSpeed(pstate);
273
+ await this.setPumpStateAsync(pstate);
274
+ }
275
+ catch (err) { logger.error(`Nixie Error running pump sequence - ${err}`); }
276
+ finally { if (!this.closing) this._pollTimer = setTimeoutSync(async () => await self.pollEquipmentAsync(), this.pollingInterval || 2000); }
277
+ }
278
+ private async checkHardwareStatusAsync(connectionId: string, deviceBinding: string) {
279
+ try {
280
+ let dev = await NixieEquipment.getDeviceService(connectionId, `/status/device/${deviceBinding}`);
281
+ return dev;
282
+ } catch (err) { logger.error(`Nixie Pump checkHardwareStatusAsync: ${err.message}`); return { hasFault: true } }
283
+ }
284
+ public async validateSetupAsync(pump: Pump, pstate: PumpState) {
285
+ try {
286
+ } catch (err) { logger.error(`Nixie Error checking Pump Hardware ${this.pump.name}: ${err.message}`); return Promise.reject(err); }
287
+ }
288
+ public async closeAsync() {
289
+ try {
290
+ logger.info(`Nixie Pump closing ${this.pump.name}.`)
291
+ if (typeof this._pollTimer !== 'undefined' || this._pollTimer) clearTimeout(this._pollTimer);
292
+ this._pollTimer = null;
293
+ this._targetSpeed = 0;
294
+ let pstate = state.pumps.getItemById(this.pump.id);
295
+ try {
296
+ await this.setPumpStateAsync(pstate);
297
+ // Since we are closing we need to not reject.
298
+ } catch (err) { logger.error(`Nixie Closing pump closeAsync: ${err.message}`); }
299
+ // This will make sure the timer is dead and we are completely closed.
300
+ this.closing = true;
301
+ if (typeof this._pollTimer !== 'undefined' || this._pollTimer) clearTimeout(this._pollTimer);
302
+ pstate.emitEquipmentChange();
303
+ }
304
+ catch (err) { logger.error(`Nixie Pump closeAsync: ${err.message}`); return Promise.reject(err); }
305
+ }
306
+ public logData(filename: string, data: any) { this.controlPanel.logData(filename, data); }
307
+ protected setTargetSpeed(pstate: PumpState) { };
308
+ protected isBodyOn(bodyCode: number) {
309
+ let assoc = sys.board.valueMaps.pumpBodies.transform(bodyCode);
310
+ switch (assoc.name) {
311
+ case 'body1':
312
+ case 'pool':
313
+ return state.temps.bodies.getItemById(1).isOn;
314
+ case 'body2':
315
+ case 'spa':
316
+ return state.temps.bodies.getItemById(2).isOn;
317
+ case 'body3':
318
+ return state.temps.bodies.getItemById(3).isOn;
319
+ case 'body4':
320
+ return state.temps.bodies.getItemById(4).isOn;
321
+ case 'poolspa':
322
+ if (sys.equipment.shared && sys.equipment.maxBodies >= 2) {
323
+ return state.temps.bodies.getItemById(1).isOn === true || state.temps.bodies.getItemById(2).isOn === true;
324
+ }
325
+ else
326
+ return state.temps.bodies.getItemById(1).isOn;
327
+ }
328
+ return false;
329
+ }
330
+ }
331
+ export class NixiePumpSS extends NixiePump {
332
+ public setTargetSpeed(pState: PumpState) {
333
+ // Turn on ss pumps.
334
+ let _newSpeed = 0;
335
+ if (!pState.pumpOnDelay) {
336
+ let pt = sys.board.valueMaps.pumpTypes.get(this.pump.type);
337
+ if (pt.maxCircuits === 0 || pt.hasBody) {
338
+ _newSpeed = this.isBodyOn(this.pump.body) ? 1 : 0;
339
+ //console.log(`BODY: ${sys.board.bodies.isBodyOn(this.pump.body)} CODE: ${this.pump.body}`);
340
+ }
341
+ else if (!pState.pumpOnDelay) {
342
+ let pumpCircuits: PumpCircuit[] = this.pump.circuits.get();
343
+ if (!pState.pumpOnDelay) {
344
+ for (let i = 0; i < pumpCircuits.length; i++) {
345
+ let circ = state.circuits.getInterfaceById(pumpCircuits[i].circuit);
346
+ if (circ.isOn) _newSpeed = 1;
347
+ }
348
+ }
349
+ }
350
+ }
351
+ if (this._targetSpeed !== _newSpeed) logger.info(`NCP: Setting Pump ${this.pump.name} to ${_newSpeed > 0 ? 'on' : 'off'}. ${sys.board.bodies.isBodyOn(this.pump.body)}`);
352
+ if (isNaN(_newSpeed)) _newSpeed = 0;
353
+ this._targetSpeed = _newSpeed;
354
+ }
355
+ public async setServiceModeAsync() {
356
+ let pstate = state.pumps.getItemById(this.pump.id);
357
+ pstate.targetSpeed = this._targetSpeed = 0;
358
+ await this.setPumpStateAsync(pstate);
359
+ }
360
+ public async setPumpStateAsync(pstate: PumpState) {
361
+ let relays: PumpRelay[] = this.pump.relays.get();
362
+ let relayState = 0;
363
+ for (let i = 0; i < relays.length; i++) {
364
+ let pr = relays[i];
365
+ if (typeof pr.id === 'undefined') pr.id = i + 1; // remove when id is added to dP relays upon save.
366
+ let isOn = this._targetSpeed >> pr.id - 1 & 1;
367
+ if (utils.isNullOrEmpty(pr.connectionId) || utils.isNullOrEmpty(pr.deviceBinding)) {
368
+ // If they haven't set a program for the relay bugger out.
369
+ if (isOn) relayState |= (1 << pr.id - 1);
370
+ }
371
+ else {
372
+ try {
373
+ let res = await NixieEquipment.putDeviceService(pr.connectionId, `/state/device/${pr.deviceBinding}`, { isOn, latch: isOn ? 5000 : undefined });
374
+ if (res.status.code === 200) {
375
+ if (isOn) relayState |= (1 << pr.id - 1);
376
+ }
377
+ else pstate.status = 16;
378
+ }
379
+ catch (err) {
380
+ logger.error(`NCP: Error setting pump ${this.pump.name} relay ${pr.id} to ${isOn ? 'on' : 'off'}. Error ${err.message}}`);
381
+ pstate.status = 16;
382
+ }
383
+ }
384
+ }
385
+ if (pstate.targetSpeed === 0) {
386
+ pstate.status = 0;
387
+ pstate.driveState = 0; // We need to set this if it is a priming cycle but it might not matter for our relay based pumps.
388
+ pstate.command = 0;
389
+ }
390
+ else if (relayState === pstate.targetSpeed) {
391
+ pstate.status = 1;
392
+ pstate.driveState = 2;
393
+ pstate.command = 4;
394
+ }
395
+ pstate.relay = relayState;
396
+ return new InterfaceServerResponse(200, 'Success');
397
+ }
398
+ }
399
+ export class NixiePumpDS extends NixiePumpSS {
400
+ public setTargetSpeed(pState: PumpState) {
401
+ // Turn on sf pumps. The new speed will be the relays associated with the pump. I believe when this comes out in the final
402
+ // wash it should engage all the relays for all speeds associated with the pump. The pump logic will determine which program is
403
+ // the one to engage.
404
+ let _newSpeed = 0;
405
+ if (!pState.pumpOnDelay) {
406
+ let pumpCircuits: PumpCircuit[] = this.pump.circuits.get();
407
+ if (!pState.pumpOnDelay) {
408
+ for (let i = 0; i < pumpCircuits.length; i++) {
409
+ let circ = state.circuits.getInterfaceById(pumpCircuits[i].circuit);
410
+ // relay speeds are bit-shifted 'or' based on 1,2,4,8
411
+ if (circ.isOn) _newSpeed |= (1 << pumpCircuits[i].relay - 1);
412
+ }
413
+ }
414
+ }
415
+ if (isNaN(_newSpeed)) _newSpeed = 0;
416
+ this.logSpeed(_newSpeed);
417
+ this._targetSpeed = _newSpeed;
418
+ }
419
+ public logSpeed(_newSpeed: number) {
420
+ 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'}.`);
421
+ }
422
+ }
423
+ export class NixiePumpSF extends NixiePumpDS {
424
+ // effectively operates the same way as a DS pump since we removed the body association on DS.
425
+ // only logger msg is different
426
+ public logSpeed(_newSpeed: number) {
427
+ 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'}.`);
428
+ }
429
+ }
430
+ export class NixiePumpHWRLY extends NixiePumpDS {
431
+ // This operates as a relay pump with up to 8 speeds. The speeds are defined as follows. The override
432
+ // relay should be defined as being normally closed. When it opens then the pump will turn on to the speed.
433
+ // +-------+---------+---------+---------+---------+
434
+ // + Speed | Relay 1 | Relay 2 | Relay 3 | OVRD |
435
+ // +-------+---------+---------+---------+---------+
436
+ // | OFF | OFF | OFF | OFF | OFF |
437
+ // +-------+---------+---------+---------+---------+
438
+ // | 1 | OFF | OFF | OFF | ON |
439
+ // +-------+---------+---------+---------+---------+
440
+ // | 2 | ON | OFF | OFF | ON |
441
+ // +-------+---------+---------+---------+---------+
442
+ // | 3 | OFF | ON | OFF | ON |
443
+ // +-------+---------+---------+---------+---------+
444
+ // | 4 | ON | ON | OFF | ON |
445
+ // +-------+---------+---------+---------+---------+
446
+ // | 5 | OFF | OFF | ON | ON |
447
+ // +-------+---------+---------+---------+---------+
448
+ // | 6 | ON | OFF | ON | ON |
449
+ // +-------+---------+---------+---------+---------+
450
+ // | 7 | OFF | ON | ON | ON |
451
+ // +-------+---------+---------+---------+---------+
452
+ // | 8 | ON | ON | ON | ON |
453
+ // +-------+---------+---------+---------+---------+
454
+
455
+ public setTargetSpeed(pState: PumpState) {
456
+ let _newSpeed = 0;
457
+ if (!pState.pumpOnDelay) {
458
+ let pumpCircuits = this.pump.circuits.get();
459
+ for (let i = 0; i < pumpCircuits.length; i++) {
460
+ let circ = state.circuits.getInterfaceById(pumpCircuits[i].circuit);
461
+ let pc = pumpCircuits[i];
462
+ if (circ.isOn) {
463
+ _newSpeed = Math.max(_newSpeed, pc.relay);
464
+ }
465
+ }
466
+ }
467
+ if (isNaN(_newSpeed)) _newSpeed = 0;
468
+ this._targetSpeed = _newSpeed;
469
+ if (this._targetSpeed !== 0) Math.min(Math.max(this.pump.minSpeed, this._targetSpeed), this.pump.maxSpeed);
470
+ if (this._targetSpeed !== _newSpeed) logger.info(`NCP: Setting Pump ${this.pump.name} to ${_newSpeed}.`);
471
+ }
472
+ public async setPumpStateAsync(pstate: PumpState) {
473
+ // Don't poll while we are seting the state.
474
+ this.suspendPolling = true;
475
+ try {
476
+ let relays: PumpRelay[] = this.pump.relays.get();
477
+ let relayState = 0;
478
+ let targetState = 0;
479
+ for (let i = 0; i < relays.length; i++) {
480
+ let pr = relays[i];
481
+ if (typeof pr.id === 'undefined') pr.id = i + 1; // remove when id is added to dP relays upon save.
482
+ // 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
483
+ // configuration so that whenever the pump is off the relay terminals are closed.
484
+ let isOn = this._targetSpeed > 0 ? i === 3 ? true : (this._targetSpeed - 1 & (1 << i)) > 0 : false;
485
+ let bit = isOn ? (1 << i) : 0;
486
+ targetState |= bit;
487
+ if (utils.isNullOrEmpty(pr.connectionId) || utils.isNullOrEmpty(pr.deviceBinding)) {
488
+ // Determine whether the relay should be on.
489
+ relayState |= bit;
490
+ }
491
+ else {
492
+ try {
493
+ let res = await NixieEquipment.putDeviceService(pr.connectionId, `/state/device/${pr.deviceBinding}`, { isOn, latch: isOn ? 5000 : undefined });
494
+ if (res.status.code === 200) {
495
+ relayState |= bit;
496
+ }
497
+ else pstate.status = 16;
498
+ }
499
+ catch (err) {
500
+ logger.error(`NCP: Error setting pump ${this.pump.name} relay ${pr.id} to ${isOn ? 'on' : 'off'}. Error ${err.message}}`);
501
+ pstate.status = 16;
502
+ }
503
+ }
504
+ }
505
+ pstate.command = this._targetSpeed;
506
+ if (targetState === relayState) {
507
+ pstate.status = relayState > 0 ? 1 : 0;
508
+ pstate.driveState = relayState > 0 ? 2 : 0;
509
+ pstate.relay = relayState;
510
+ }
511
+ else {
512
+ pstate.driveState = 0;
513
+ }
514
+ return new InterfaceServerResponse(200, 'Success');
515
+ }
516
+ catch (err) {
517
+ logger.error(`Error running pump sequence for ${this.pump.name}: ${err.message}`);
518
+ return Promise.reject(err);
519
+ }
520
+ finally { this.suspendPolling = false; }
521
+ };
522
+
523
+ }
524
+ export class NixiePumpRS485 extends NixiePump {
525
+ public async setServiceModeAsync() {
526
+ this._targetSpeed = 0;
527
+ await this.setDriveStateAsync(false);
528
+ await this.setPumpToRemoteControlAsync(false);
529
+ }
530
+ public async setPumpStateAsync(pstate: PumpState) {
531
+ // Don't poll while we are seting the state.
532
+ this.suspendPolling = true;
533
+ try {
534
+ let pt = sys.board.valueMaps.pumpTypes.get(this.pump.type);
535
+ if (state.mode === 0) {
536
+ // Since these process are async the closing flag can be set
537
+ // between calls. We need to check it in between each call.
538
+ if (!this.closing) await this.setDriveStateAsync();
539
+ if (!this.closing) {
540
+ if (this._targetSpeed >= pt.minFlow && this._targetSpeed <= pt.maxFlow) await this.setPumpGPMAsync();
541
+ else if (this._targetSpeed >= pt.minSpeed && this._targetSpeed <= pt.maxSpeed) await this.setPumpRPMAsync();
542
+ }
543
+ ;
544
+ if (!this.closing && pt.name !== 'vsf' && pt.name !== 'vs') await this.setPumpFeatureAsync(6);;
545
+ if (!this.closing) await setTimeout(1000);;
546
+ if (!this.closing) await this.requestPumpStatusAsync();;
547
+ if (!this.closing) await this.setPumpToRemoteControlAsync();;
548
+ }
549
+ return new InterfaceServerResponse(200, 'Success');
550
+ }
551
+ catch (err) {
552
+ logger.error(`Error running pump sequence for ${this.pump.name}: ${err.message}`);
553
+ return Promise.reject(err);
554
+ }
555
+ finally { this.suspendPolling = false; }
556
+ };
557
+ protected async setDriveStateAsync(running: boolean = true) {
558
+ if (conn.isPortEnabled(this.pump.portId || 0)) {
559
+ let out = Outbound.create({
560
+ portId: this.pump.portId || 0,
561
+ protocol: Protocol.Pump,
562
+ dest: this.pump.address,
563
+ action: 6,
564
+ payload: running && this._targetSpeed > 0 ? [10] : [4],
565
+ retries: 1,
566
+ response: true
567
+ });
568
+ try {
569
+ await out.sendAsync();
570
+ }
571
+ catch (err) {
572
+ logger.error(`Error sending setDriveState for ${this.pump.name}: ${err.message}`);
573
+ }
574
+ }
575
+ else {
576
+ let pstate = state.pumps.getItemById(this.pump.id);
577
+ pstate.command = pstate.rpm > 0 || pstate.flow > 0 ? 10 : 0;
578
+ }
579
+ };
580
+ protected async requestPumpStatusAsync() {
581
+ if (conn.isPortEnabled(this.pump.portId || 0)) {
582
+ let out = Outbound.create({
583
+ portId: this.pump.portId || 0,
584
+ protocol: Protocol.Pump,
585
+ dest: this.pump.address,
586
+ action: 7,
587
+ payload: [],
588
+ retries: 2,
589
+ response: true,
590
+ });
591
+ try {
592
+ await out.sendAsync();
593
+ }
594
+ catch (err) {
595
+ logger.error(`Error sending requestPumpStatus for ${this.pump.name}: ${err.message}`);
596
+ }
597
+ }
598
+ };
599
+ protected async setPumpToRemoteControlAsync(running: boolean = true) {
600
+ if (conn.isPortEnabled(this.pump.portId || 0)) {
601
+ let out = Outbound.create({
602
+ portId: this.pump.portId || 0,
603
+ protocol: Protocol.Pump,
604
+ dest: this.pump.address,
605
+ action: 4,
606
+ payload: running ? [255] : [0], // when stopAsync is called, pass false to return control to pump panel
607
+ retries: 1,
608
+ response: true
609
+ });
610
+ try {
611
+ await out.sendAsync();
612
+ }
613
+ catch (err) {
614
+ logger.error(`Error sending setPumpToRemoteControl for ${this.pump.name}: ${err.message}`);
615
+ }
616
+ }
617
+ }
618
+ protected async setPumpFeatureAsync(feature?: number) {
619
+ // empty payload (possibly 0?, too) is no feature
620
+ // 6: Feature 1
621
+ if (conn.isPortEnabled(this.pump.portId || 0)) {
622
+ let out = Outbound.create({
623
+ portId: this.pump.portId || 0,
624
+ protocol: Protocol.Pump,
625
+ dest: this.pump.address,
626
+ action: 5,
627
+ payload: typeof feature === 'undefined' ? [] : [feature],
628
+ retries: 2,
629
+ response: true
630
+ });
631
+ try {
632
+ await out.sendAsync();
633
+ }
634
+ catch (err) {
635
+ logger.error(`Error sending setPumpFeature for ${this.pump.name}: ${err.message}`);
636
+ }
637
+ }
638
+ };
639
+ protected async setPumpRPMAsync() {
640
+ if (conn.isPortEnabled(this.pump.portId || 0)) {
641
+ let out = Outbound.create({
642
+ portId: this.pump.portId || 0,
643
+ protocol: Protocol.Pump,
644
+ dest: this.pump.address,
645
+ action: 1,
646
+ payload: [2, 196, Math.floor(this._targetSpeed / 256), this._targetSpeed % 256],
647
+ retries: 1,
648
+ // timeout: 250,
649
+ response: true
650
+ });
651
+ try {
652
+ await out.sendAsync();
653
+ }
654
+ catch (err) {
655
+ logger.error(`Error sending setPumpRPMAsync for ${this.pump.name}: ${err.message}`);
656
+ }
657
+ }
658
+ };
659
+ protected async setPumpGPMAsync() {
660
+ // packet for vf; vsf will override
661
+ if (conn.isPortEnabled(this.pump.portId || 0)) {
662
+ let out = Outbound.create({
663
+ portId: this.pump.portId || 0,
664
+ protocol: Protocol.Pump,
665
+ dest: this.pump.address,
666
+ action: 1,
667
+ payload: [2, 228, 0, this._targetSpeed],
668
+ retries: 1,
669
+ response: true
670
+ });
671
+ try {
672
+ await out.sendAsync();
673
+ }
674
+ catch (err) {
675
+ logger.error(`Error sending setPumpGPMAsync for ${this.pump.name}: ${err.message}`);
676
+ }
677
+ }
678
+ };
679
+ public async closeAsync() {
680
+ try {
681
+ this.suspendPolling = true;
682
+ logger.info(`Nixie Pump closing ${this.pump.name}.`)
683
+ if (typeof this._pollTimer !== 'undefined' || this._pollTimer) clearTimeout(this._pollTimer);
684
+ this._pollTimer = null;
685
+ this.closing = true;
686
+ let pt = sys.board.valueMaps.pumpTypes.get(this.pump.type);
687
+ let pstate = state.pumps.getItemById(this.pump.id);
688
+ this._targetSpeed = 0;
689
+ await this.setDriveStateAsync(false);
690
+ if (!this.closing && pt.name !== 'vsf' && pt.name !== 'vs') await this.setPumpFeatureAsync();
691
+ //await this.setPumpFeature();
692
+ //await this.setDriveStateAsync(false);
693
+ await this.setPumpToRemoteControlAsync(false);
694
+ // Make sure the polling timer is dead after we have closted this all off. That way we do not
695
+ // have another process that revives it from the dead.
696
+ if (typeof this._pollTimer !== 'undefined' || this._pollTimer) clearTimeout(this._pollTimer);
697
+ this._pollTimer = null;
698
+ pstate.emitEquipmentChange();
699
+ }
700
+ catch (err) { logger.error(`Nixie Pump closeAsync: ${err.message}`); return Promise.reject(err); }
701
+ finally { this.suspendPolling = false; }
702
+ }
703
+ }
704
+ export class NixiePumpVS extends NixiePumpRS485 {
705
+ public setTargetSpeed(pState: PumpState) {
706
+ let _newSpeed = 0;
707
+ if (!pState.pumpOnDelay) {
708
+ let pumpCircuits = this.pump.circuits.get();
709
+
710
+ for (let i = 0; i < pumpCircuits.length; i++) {
711
+ let circ = state.circuits.getInterfaceById(pumpCircuits[i].circuit);
712
+ let pc = pumpCircuits[i];
713
+ if (circ.isOn) _newSpeed = Math.max(_newSpeed, pc.speed);
714
+ }
715
+ }
716
+ if (isNaN(_newSpeed)) _newSpeed = 0;
717
+ this._targetSpeed = _newSpeed;
718
+ if (this._targetSpeed !== 0) Math.min(Math.max(this.pump.minSpeed, this._targetSpeed), this.pump.maxSpeed);
719
+ if (this._targetSpeed !== _newSpeed) logger.info(`NCP: Setting Pump ${this.pump.name} to ${_newSpeed} RPM.`);
720
+ }
721
+ }
722
+ export class NixiePumpVF extends NixiePumpRS485 {
723
+ public setTargetSpeed(pState: PumpState) {
724
+ let _newSpeed = 0;
725
+ if (!pState.pumpOnDelay) {
726
+ let pumpCircuits = this.pump.circuits.get();
727
+ for (let i = 0; i < pumpCircuits.length; i++) {
728
+ let circ = state.circuits.getInterfaceById(pumpCircuits[i].circuit);
729
+ let pc = pumpCircuits[i];
730
+ if (circ.isOn) _newSpeed = Math.max(_newSpeed, pc.flow);
731
+ }
732
+ }
733
+ if (isNaN(_newSpeed)) _newSpeed = 0;
734
+ this._targetSpeed = _newSpeed;
735
+ if (this._targetSpeed !== 0) Math.min(Math.max(this.pump.minFlow, this._targetSpeed), this.pump.maxFlow);
736
+ if (this._targetSpeed !== _newSpeed) logger.info(`NCP: Setting Pump ${this.pump.name} to ${_newSpeed} GPM.`);
737
+ }
738
+ }
739
+ export class NixiePumpVSF extends NixiePumpRS485 {
740
+ public setTargetSpeed(pState: PumpState) {
741
+ let _newSpeed = 0;
742
+ let maxRPM = 0;
743
+ let maxGPM = 0;
744
+ let flows = 0;
745
+ let speeds = 0;
746
+ if (!pState.pumpOnDelay) {
747
+ let pumpCircuits = this.pump.circuits.get();
748
+ let pt = sys.board.valueMaps.pumpTypes.get(this.pump.type);
749
+ // 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
750
+ // 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
751
+ // the GPM to RPM but if there is none then it will use GPM.
752
+ let toRPM = (flowRate: number, minSpeed: number = 450, maxSpeed: number = 3450) => {
753
+ let eff = .03317 * maxSpeed;
754
+ let rpm = Math.min((flowRate * maxSpeed) / eff, maxSpeed);
755
+ return rpm > 0 ? Math.max(rpm, minSpeed) : 0;
756
+ };
757
+ let toGPM = (speed: number, maxSpeed: number = 3450, minFlow: number = 15, maxFlow: number = 140) => {
758
+ let eff = .03317 * maxSpeed;
759
+ let gpm = Math.min((eff * speed) / maxSpeed, maxFlow);
760
+ return gpm > 0 ? Math.max(gpm, minFlow) : 0;
761
+ }
762
+ for (let i = 0; i < pumpCircuits.length; i++) {
763
+ let circ = state.circuits.getInterfaceById(pumpCircuits[i].circuit);
764
+ let pc = pumpCircuits[i];
765
+ if (circ.isOn) {
766
+ if (pc.units > 0) {
767
+ maxGPM = Math.max(maxGPM, pc.flow);
768
+ // Calculate an RPM from this flow.
769
+ maxRPM = Math.max(maxGPM, toRPM(pc.flow, pt.minSpeed, pt.maxSpeed));
770
+ flows++;
771
+ }
772
+ else {
773
+ maxRPM = Math.max(maxRPM, pc.speed);
774
+ maxGPM = Math.max(maxGPM, toGPM(pc.speed, pt.maxSpeed, pt.minFlow, pt.maxFlow));
775
+ speeds++;
776
+ }
777
+ }
778
+ }
779
+ _newSpeed = speeds > 0 || flows === 0 ? maxRPM : maxGPM;
780
+ }
781
+ if (isNaN(_newSpeed)) _newSpeed = 0;
782
+ // Send the flow message if it is flow and the rpm message if it is rpm.
783
+ if (this._targetSpeed !== _newSpeed) logger.info(`NCP: Setting Pump ${this.pump.name} to ${_newSpeed} ${flows > 0 ? 'GPM' : 'RPM'}.`);
784
+ this._targetSpeed = _newSpeed;
785
+ }
786
+ protected async setPumpRPMAsync() {
787
+ // vsf action is 10 for rpm
788
+ if (conn.isPortEnabled(this.pump.portId || 0)) {
789
+ let out = Outbound.create({
790
+ portId: this.pump.portId || 0,
791
+ protocol: Protocol.Pump,
792
+ dest: this.pump.address,
793
+ action: 10,
794
+ payload: [2, 196, Math.floor(this._targetSpeed / 256), this._targetSpeed % 256],
795
+ retries: 1,
796
+ // timeout: 250,
797
+ response: true
798
+ });
799
+ try {
800
+ await out.sendAsync();
801
+ }
802
+ catch (err) {
803
+ logger.error(`Error sending setPumpRPMAsync for ${this.pump.name}: ${err.message}`);
804
+ }
805
+ }
806
+ };
807
+ protected async setPumpGPMAsync() {
808
+ // vsf payload; different from vf payload
809
+ if (conn.isPortEnabled(this.pump.portId || 0)) {
810
+ let out = Outbound.create({
811
+ portId: this.pump.portId || 0,
812
+ protocol: Protocol.Pump,
813
+ dest: this.pump.address,
814
+ action: 9,
815
+ payload: [2, 196, 0, this._targetSpeed],
816
+ retries: 1,
817
+ response: true
818
+ });
819
+ try {
820
+ await out.sendAsync();
821
+ }
822
+ catch (err) {
823
+ logger.error(`Error sending setPumpGPMAsync for ${this.pump.name}: ${err.message}`);
824
+ }
825
+ }
826
+ };
827
+ };
828
+ export class NixiePumpHWVS extends NixiePumpRS485 {
829
+ public setTargetSpeed(pState: PumpState) {
830
+ let _newSpeed = 0;
831
+ if (!pState.pumpOnDelay) {
832
+ let pumpCircuits = this.pump.circuits.get();
833
+
834
+ for (let i = 0; i < pumpCircuits.length; i++) {
835
+ let circ = state.circuits.getInterfaceById(pumpCircuits[i].circuit);
836
+ let pc = pumpCircuits[i];
837
+ if (circ.isOn) _newSpeed = Math.max(_newSpeed, pc.speed);
838
+ }
839
+ }
840
+ if (isNaN(_newSpeed)) _newSpeed = 0;
841
+ this._targetSpeed = _newSpeed;
842
+ if (this._targetSpeed !== 0) Math.min(Math.max(this.pump.minSpeed, this._targetSpeed), this.pump.maxSpeed);
843
+ if (this._targetSpeed !== _newSpeed) logger.info(`NCP: Setting Pump ${this.pump.name} to ${_newSpeed} RPM.`);
844
+ }
845
+ public async setServiceModeAsync() {
846
+ this._targetSpeed = 0;
847
+ await this.setPumpRPMAsync();
848
+ }
849
+ public async setDriveStateAsync(running: boolean = false) { }
850
+ public async setPumpStateAsync(pstate: PumpState) {
851
+ // Don't poll while we are seting the state.
852
+ this.suspendPolling = true;
853
+ try {
854
+ // Since these process are async the closing flag can be set
855
+ // between calls. We need to check it in between each call.
856
+ if (!this.closing) { await this.setPumpRPMAsync(); }
857
+ return new InterfaceServerResponse(200, 'Success');
858
+ }
859
+ catch (err) {
860
+ logger.error(`Error running pump sequence for ${this.pump.name}: ${err.message}`);
861
+ return Promise.reject(err);
862
+ }
863
+ finally { this.suspendPolling = false; }
864
+ };
865
+ protected async requestPumpStatusAsync() { return Promise.resolve(); };
866
+ protected setPumpFeatureAsync(feature?: number) { return Promise.resolve(); }
867
+ protected async setPumpToRemoteControlAsync(running: boolean = true) {
868
+ // We do nothing on this pump to set it to remote control. That is unless we are turning it off.
869
+ if (conn.isPortEnabled(this.pump.portId || 0)) {
870
+ if (!running) {
871
+ let out = Outbound.create({
872
+ portId: this.pump.portId || 0,
873
+ protocol: Protocol.Hayward,
874
+ source: 12, // Use the broadcast address
875
+ dest: this.pump.address,
876
+ action: 1,
877
+ payload: [0], // when stopAsync is called, pass false to return control to pump panel
878
+ // payload: spump.virtualControllerStatus === sys.board.valueMaps.virtualControllerStatus.getValue('running') ? [255] : [0],
879
+ retries: 1,
880
+ response: Response.create({ protocol: Protocol.Hayward, action: 12, source: this.pump.address - 96 })
881
+ });
882
+ try {
883
+ await out.sendAsync();
884
+ }
885
+ catch (err) {
886
+ logger.error(`Error sending setPumpToRemoteControl for ${this.pump.name}: ${err.message}`);
887
+
888
+ }
889
+ }
890
+ }
891
+ }
892
+ protected async setPumpRPMAsync() {
893
+ // Address 1
894
+ //[][16, 2, 12, 1, 0][41][0, 72, 16, 3] out
895
+ //[][16, 2, 0, 12, 0][0, 41, 0, 135][0, 206, 16, 3] In
896
+ // Address 2
897
+ //[][16, 2, 12, 1, 1][100][0, 132, 16, 3] out
898
+ //[][16, 2, 0, 12, 1][0, 96, 21, 64][0, 212, 16, 3] in
899
+ // Note that action 12 is in a different position for the outbound than the inbound. The source and destination are kind
900
+ // of a misnomer in that it identifies the equipment address in byte(4) of the header and flips the command address around.
901
+ // 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
902
+ // broadcast from the equipment item to 0 (anybody).
903
+ if (conn.isPortEnabled(this.pump.portId || 0)) {
904
+ let pt = sys.board.valueMaps.pumpTypes.get(this.pump.type);
905
+ let out = Outbound.create({
906
+ portId: this.pump.portId || 0,
907
+ protocol: Protocol.Hayward,
908
+ source: 1, // Use the broadcast address
909
+ dest: this.pump.address - 96,
910
+ action: 12,
911
+ payload: [Math.min(Math.round((this._targetSpeed / pt.maxSpeed) * 100), 100)], // when stopAsync is called, pass false to return control to pump panel
912
+ retries: 1,
913
+ response: Response.create({ protocol: Protocol.Hayward, action: 12, source: this.pump.address - 96 })
914
+ });
915
+ try {
916
+ await out.sendAsync();
917
+ }
918
+ catch (err) {
919
+ logger.error(`Error sending setPumpRPM for ${this.pump.name}: ${err.message}`);
920
+ let pstate = state.pumps.getItemById(this.pump.id);
921
+ pstate.command = 0;
922
+ pstate.rpm = 0;
923
+ pstate.watts = 0;
924
+ }
925
+ }
926
+ else {
927
+ let pstate = state.pumps.getItemById(this.pump.id);
928
+ pstate.command = 0;
929
+ pstate.rpm = 0;
930
+ pstate.watts = 0;
931
+ }
932
+
933
+ };
934
+ }