nodejs-poolcontroller 8.1.2 → 8.4.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 (106) hide show
  1. package/.eslintrc.json +36 -36
  2. package/.github/ISSUE_TEMPLATE/1-bug-report.yml +84 -84
  3. package/.github/ISSUE_TEMPLATE/2-docs.md +12 -12
  4. package/.github/ISSUE_TEMPLATE/3-proposal.md +28 -28
  5. package/.github/ISSUE_TEMPLATE/config.yml +8 -8
  6. package/.github/copilot-instructions.md +63 -0
  7. package/.github/workflows/ghcr-publish.yml +67 -0
  8. package/AGENTS.md +597 -0
  9. package/CONTRIBUTING.md +74 -74
  10. package/Changelog +292 -257
  11. package/Dockerfile +62 -19
  12. package/Gruntfile.js +40 -40
  13. package/LICENSE +661 -661
  14. package/README.md +318 -191
  15. package/anslq25/MessagesMock.ts +221 -221
  16. package/anslq25/boards/MockBoardFactory.ts +49 -49
  17. package/anslq25/boards/MockEasyTouchBoard.ts +696 -696
  18. package/anslq25/boards/MockSystemBoard.ts +216 -216
  19. package/anslq25/chemistry/MockChlorinator.ts +98 -98
  20. package/anslq25/pumps/MockPump.ts +83 -83
  21. package/app.ts +115 -115
  22. package/config/Config.ts +57 -7
  23. package/config/VersionCheck.ts +63 -35
  24. package/controller/Constants.ts +809 -805
  25. package/controller/Equipment.ts +2688 -2664
  26. package/controller/Errors.ts +181 -181
  27. package/controller/Lockouts.ts +549 -549
  28. package/controller/State.ts +3738 -3690
  29. package/controller/boards/AquaLinkBoard.ts +1003 -1003
  30. package/controller/boards/BoardFactory.ts +53 -53
  31. package/controller/boards/EasyTouchBoard.ts +3202 -3202
  32. package/controller/boards/IntelliCenterBoard.ts +4393 -3899
  33. package/controller/boards/IntelliComBoard.ts +69 -69
  34. package/controller/boards/IntelliTouchBoard.ts +382 -382
  35. package/controller/boards/NixieBoard.ts +1944 -1929
  36. package/controller/boards/SunTouchBoard.ts +400 -400
  37. package/controller/boards/SystemBoard.ts +5268 -5268
  38. package/controller/comms/Comms.ts +1272 -1214
  39. package/controller/comms/ScreenLogic.ts +1665 -1665
  40. package/controller/comms/messages/Messages.ts +1433 -1243
  41. package/controller/comms/messages/config/ChlorinatorMessage.ts +5 -0
  42. package/controller/comms/messages/config/CircuitGroupMessage.ts +0 -0
  43. package/controller/comms/messages/config/CircuitMessage.ts +0 -0
  44. package/controller/comms/messages/config/ConfigMessage.ts +6 -0
  45. package/controller/comms/messages/config/CoverMessage.ts +0 -0
  46. package/controller/comms/messages/config/CustomNameMessage.ts +31 -31
  47. package/controller/comms/messages/config/EquipmentMessage.ts +216 -210
  48. package/controller/comms/messages/config/ExternalMessage.ts +96 -10
  49. package/controller/comms/messages/config/FeatureMessage.ts +0 -0
  50. package/controller/comms/messages/config/GeneralMessage.ts +0 -0
  51. package/controller/comms/messages/config/HeaterMessage.ts +0 -0
  52. package/controller/comms/messages/config/IntellichemMessage.ts +0 -0
  53. package/controller/comms/messages/config/OptionsMessage.ts +194 -174
  54. package/controller/comms/messages/config/PumpMessage.ts +0 -0
  55. package/controller/comms/messages/config/RemoteMessage.ts +0 -0
  56. package/controller/comms/messages/config/ScheduleMessage.ts +401 -390
  57. package/controller/comms/messages/config/SecurityMessage.ts +0 -0
  58. package/controller/comms/messages/config/ValveMessage.ts +0 -0
  59. package/controller/comms/messages/status/ChlorinatorStateMessage.ts +0 -0
  60. package/controller/comms/messages/status/EquipmentStateMessage.ts +1158 -822
  61. package/controller/comms/messages/status/HeaterStateMessage.ts +135 -135
  62. package/controller/comms/messages/status/IntelliChemStateMessage.ts +448 -448
  63. package/controller/comms/messages/status/IntelliValveStateMessage.ts +36 -36
  64. package/controller/comms/messages/status/PumpStateMessage.ts +0 -0
  65. package/controller/comms/messages/status/RegalModbusStateMessage.ts +411 -0
  66. package/controller/comms/messages/status/VersionMessage.ts +103 -41
  67. package/controller/nixie/Nixie.ts +173 -173
  68. package/controller/nixie/NixieEquipment.ts +104 -104
  69. package/controller/nixie/bodies/Body.ts +120 -120
  70. package/controller/nixie/bodies/Filter.ts +135 -135
  71. package/controller/nixie/chemistry/ChemController.ts +2724 -2724
  72. package/controller/nixie/chemistry/ChemDoser.ts +806 -806
  73. package/controller/nixie/chemistry/Chlorinator.ts +367 -367
  74. package/controller/nixie/circuits/Circuit.ts +478 -478
  75. package/controller/nixie/heaters/Heater.ts +834 -834
  76. package/controller/nixie/pumps/Pump.ts +1194 -996
  77. package/controller/nixie/schedules/Schedule.ts +401 -401
  78. package/controller/nixie/valves/Valve.ts +170 -170
  79. package/defaultConfig.json +352 -347
  80. package/docker-compose.yml +32 -0
  81. package/logger/DataLogger.ts +448 -448
  82. package/logger/Logger.ts +448 -436
  83. package/package.json +58 -60
  84. package/sendSocket.js +32 -32
  85. package/tsconfig.json +25 -25
  86. package/types/express-multer.d.ts +32 -0
  87. package/web/Server.ts +1937 -1927
  88. package/web/bindings/aqualinkD.json +559 -559
  89. package/web/bindings/influxDB.json +1066 -1066
  90. package/web/bindings/mqtt.json +721 -721
  91. package/web/bindings/mqttAlt.json +746 -746
  92. package/web/bindings/rulesManager.json +54 -54
  93. package/web/bindings/smartThings-Hubitat.json +31 -31
  94. package/web/bindings/valveRelays.json +20 -20
  95. package/web/bindings/vera.json +25 -25
  96. package/web/interfaces/baseInterface.ts +188 -188
  97. package/web/interfaces/httpInterface.ts +148 -148
  98. package/web/interfaces/influxInterface.ts +283 -283
  99. package/web/interfaces/mqttInterface.ts +695 -695
  100. package/web/interfaces/ruleInterface.ts +101 -87
  101. package/web/services/config/Config.ts +1063 -1053
  102. package/web/services/config/ConfigSocket.ts +0 -0
  103. package/web/services/state/State.ts +0 -0
  104. package/web/services/state/StateSocket.ts +0 -0
  105. package/web/services/utilities/Utilities.ts +233 -233
  106. package/.github/workflows/docker-publish-njsPC-linux.yml +0 -50
@@ -1,170 +1,170 @@
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 { Valve, ValveCollection, sys } from "../../../controller/Equipment";
7
- import { ValveState, state, } from "../../State";
8
- import { setTimeout, clearTimeout } from 'timers';
9
- import { NixieControlPanel } from '../Nixie';
10
- import { webApp, InterfaceServerResponse } from "../../../web/Server";
11
-
12
- export class NixieValveCollection extends NixieEquipmentCollection<NixieValve> {
13
- public async deleteValveAsync(id: number) {
14
- try {
15
- for (let i = this.length - 1; i >= 0; i--) {
16
- let valve = this[i];
17
- if (valve.id === id) {
18
- await valve.closeAsync();
19
- this.splice(i, 1);
20
- }
21
- }
22
- } catch (err) { return Promise.reject(`Nixie Control Panel deleteValveAsync ${err.message}`); }
23
- }
24
- public async setValveStateAsync(vstate: ValveState, isDiverted: boolean) {
25
- try {
26
- let valve: NixieValve = this.find(elem => elem.id === vstate.id) as NixieValve;
27
- if (typeof valve === 'undefined') {
28
- vstate.isDiverted = isDiverted;
29
- return logger.error(`Nixie Control Panel Error setValveState could not find valve ${vstate.id}-${vstate.name}`);
30
- }
31
- await valve.setValveStateAsync(vstate, isDiverted);
32
- } catch (err) { return Promise.reject(new Error(`Nixie Error setting valve state ${vstate.id}-${vstate.name}: ${err.message}`)); }
33
- }
34
- public async setValveAsync(valve: Valve, data: any) {
35
- // By the time we get here we know that we are in control and this is a Nixie valve.
36
- try {
37
- let c: NixieValve = this.find(elem => elem.id === valve.id) as NixieValve;
38
- if (typeof c === 'undefined') {
39
- valve.master = 1;
40
- c = new NixieValve(this.controlPanel, valve);
41
- this.push(c);
42
- await c.setValveAsync(data);
43
- logger.info(`A valve was not found for id #${valve.id} creating valve`);
44
- }
45
- else {
46
- await c.setValveAsync(data);
47
- }
48
- }
49
- catch (err) { logger.error(`setValveAsync: ${err.message}`); return Promise.reject(err); }
50
- }
51
- public async initAsync(valves: ValveCollection) {
52
- try {
53
- for (let i = 0; i < valves.length; i++) {
54
- let valve = valves.getItemByIndex(i);
55
- if (valve.master === 1) {
56
- if (typeof this.find(elem => elem.id === valve.id) === 'undefined') {
57
- let nvalve = new NixieValve(this.controlPanel, valve);
58
- logger.info(`Initializing Nixie Valve ${nvalve.id}-${valve.name}`);
59
- this.push(nvalve);
60
- }
61
- }
62
- }
63
- }
64
- catch (err) { logger.error(`Nixie Valve initAsync Error: ${err.message}`); return Promise.reject(err); }
65
- }
66
- public async closeAsync() {
67
- try {
68
- for (let i = this.length - 1; i >= 0; i--) {
69
- try {
70
- await this[i].closeAsync();
71
- this.splice(i, 1);
72
- } catch (err) { logger.error(`Error stopping Nixie Valve ${err}`); }
73
- }
74
-
75
- } catch (err) { } // Don't bail if we have an errror.
76
- }
77
-
78
- public async initValveAsync(valve: Valve): Promise<NixieValve> {
79
- try {
80
- let c: NixieValve = this.find(elem => elem.id === valve.id) as NixieValve;
81
- if (typeof c === 'undefined') {
82
- c = new NixieValve(this.controlPanel, valve);
83
- this.push(c);
84
- }
85
- return c;
86
- } catch (err) { return Promise.reject(logger.error(`Nixie Controller: initValveAsync Error: ${err.message}`)); }
87
- }
88
-
89
- }
90
- export class NixieValve extends NixieEquipment {
91
- public pollingInterval: number = 10000;
92
- private _pollTimer: NodeJS.Timeout = null;
93
- public valve: Valve;
94
- private _lastState;
95
- constructor(ncp: INixieControlPanel, valve: Valve) {
96
- super(ncp);
97
- this.valve = valve;
98
- this.pollEquipmentAsync();
99
- }
100
- public get id(): number { return typeof this.valve !== 'undefined' ? this.valve.id : -1; }
101
- public async setValveStateAsync(vstate: ValveState, isDiverted: boolean) {
102
- try {
103
- // Here we go we need to set the valve state.
104
- if (vstate.isDiverted !== isDiverted) {
105
- logger.verbose(`Nixie: Set valve ${vstate.id}-${vstate.name} to ${isDiverted}`);
106
- }
107
- if (utils.isNullOrEmpty(this.valve.connectionId) || utils.isNullOrEmpty(this.valve.deviceBinding)) {
108
- vstate.isDiverted = isDiverted;
109
- return new InterfaceServerResponse(200, 'Success');
110
- }
111
- if (typeof this._lastState === 'undefined' || isDiverted || this._lastState !== isDiverted) {
112
- let res = await NixieEquipment.putDeviceService(this.valve.connectionId, `/state/device/${this.valve.deviceBinding}`, { isOn: isDiverted, latch: isDiverted ? 10000 : undefined });
113
- if (res.status.code === 200) this._lastState = vstate.isDiverted = isDiverted;
114
- return res;
115
- }
116
- else {
117
- vstate.isDiverted = isDiverted;
118
- return new InterfaceServerResponse(200, 'Success');
119
- }
120
- } catch (err) { return logger.error(`Nixie Error setting valve state ${vstate.id}-${vstate.name}: ${err.message}`); }
121
- }
122
- public async setValveAsync(data: any) {
123
- try {
124
- let valve = this.valve;
125
- }
126
- catch (err) { logger.error(`Nixie setValveAsync: ${err.message}`); return Promise.reject(err); }
127
- }
128
- public async pollEquipmentAsync() {
129
- let self = this;
130
- try {
131
- if (typeof this._pollTimer !== 'undefined' || this._pollTimer) clearTimeout(this._pollTimer);
132
- this._pollTimer = null;
133
- let success = false;
134
- }
135
- catch (err) { logger.error(`Nixie Error polling valve - ${err}`); }
136
- finally { this._pollTimer = setTimeout(async () => await self.pollEquipmentAsync(), this.pollingInterval || 10000); }
137
- }
138
- private async checkHardwareStatusAsync(connectionId: string, deviceBinding: string) {
139
- try {
140
- let dev = await NixieEquipment.getDeviceService(connectionId, `/status/device/${deviceBinding}`);
141
- return dev;
142
- } catch (err) { logger.error(`Nixie Valve checkHardwareStatusAsync: ${err.message}`); return { hasFault: true } }
143
- }
144
- public async validateSetupAsync(valve: Valve, vstate: ValveState) {
145
- try {
146
- if (typeof valve.connectionId !== 'undefined' && valve.connectionId !== ''
147
- && typeof valve.deviceBinding !== 'undefined' && valve.deviceBinding !== '') {
148
- try {
149
- let stat = await this.checkHardwareStatusAsync(valve.connectionId, valve.deviceBinding);
150
- // If we have a status check the return.
151
- vstate.commStatus = stat.hasFault ? 1 : 0;
152
- } catch (err) { vstate.commStatus = 1; }
153
- }
154
- else
155
- vstate.commStatus = 0;
156
- // The validation will be different if the valve is on or not. So lets get that information.
157
- } catch (err) { logger.error(`Nixie Error checking Valve Hardware ${this.valve.name}: ${err.message}`); vstate.commStatus = 1; return Promise.reject(err); }
158
- }
159
- public async closeAsync() {
160
- try {
161
- if (typeof this._pollTimer !== 'undefined' || this._pollTimer) clearTimeout(this._pollTimer);
162
- this._pollTimer = null;
163
- let vstate = state.valves.getItemById(this.valve.id);
164
- this.setValveStateAsync(vstate, false);
165
- vstate.emitEquipmentChange();
166
- }
167
- catch (err) { logger.error(`Nixie Valve closeAsync: ${err.message}`); return Promise.reject(err); }
168
- }
169
- public logData(filename: string, data: any) { this.controlPanel.logData(filename, data); }
170
- }
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 { Valve, ValveCollection, sys } from "../../../controller/Equipment";
7
+ import { ValveState, state, } from "../../State";
8
+ import { setTimeout, clearTimeout } from 'timers';
9
+ import { NixieControlPanel } from '../Nixie';
10
+ import { webApp, InterfaceServerResponse } from "../../../web/Server";
11
+
12
+ export class NixieValveCollection extends NixieEquipmentCollection<NixieValve> {
13
+ public async deleteValveAsync(id: number) {
14
+ try {
15
+ for (let i = this.length - 1; i >= 0; i--) {
16
+ let valve = this[i];
17
+ if (valve.id === id) {
18
+ await valve.closeAsync();
19
+ this.splice(i, 1);
20
+ }
21
+ }
22
+ } catch (err) { return Promise.reject(`Nixie Control Panel deleteValveAsync ${err.message}`); }
23
+ }
24
+ public async setValveStateAsync(vstate: ValveState, isDiverted: boolean) {
25
+ try {
26
+ let valve: NixieValve = this.find(elem => elem.id === vstate.id) as NixieValve;
27
+ if (typeof valve === 'undefined') {
28
+ vstate.isDiverted = isDiverted;
29
+ return logger.error(`Nixie Control Panel Error setValveState could not find valve ${vstate.id}-${vstate.name}`);
30
+ }
31
+ await valve.setValveStateAsync(vstate, isDiverted);
32
+ } catch (err) { return Promise.reject(new Error(`Nixie Error setting valve state ${vstate.id}-${vstate.name}: ${err.message}`)); }
33
+ }
34
+ public async setValveAsync(valve: Valve, data: any) {
35
+ // By the time we get here we know that we are in control and this is a Nixie valve.
36
+ try {
37
+ let c: NixieValve = this.find(elem => elem.id === valve.id) as NixieValve;
38
+ if (typeof c === 'undefined') {
39
+ valve.master = 1;
40
+ c = new NixieValve(this.controlPanel, valve);
41
+ this.push(c);
42
+ await c.setValveAsync(data);
43
+ logger.info(`A valve was not found for id #${valve.id} creating valve`);
44
+ }
45
+ else {
46
+ await c.setValveAsync(data);
47
+ }
48
+ }
49
+ catch (err) { logger.error(`setValveAsync: ${err.message}`); return Promise.reject(err); }
50
+ }
51
+ public async initAsync(valves: ValveCollection) {
52
+ try {
53
+ for (let i = 0; i < valves.length; i++) {
54
+ let valve = valves.getItemByIndex(i);
55
+ if (valve.master === 1) {
56
+ if (typeof this.find(elem => elem.id === valve.id) === 'undefined') {
57
+ let nvalve = new NixieValve(this.controlPanel, valve);
58
+ logger.info(`Initializing Nixie Valve ${nvalve.id}-${valve.name}`);
59
+ this.push(nvalve);
60
+ }
61
+ }
62
+ }
63
+ }
64
+ catch (err) { logger.error(`Nixie Valve initAsync Error: ${err.message}`); return Promise.reject(err); }
65
+ }
66
+ public async closeAsync() {
67
+ try {
68
+ for (let i = this.length - 1; i >= 0; i--) {
69
+ try {
70
+ await this[i].closeAsync();
71
+ this.splice(i, 1);
72
+ } catch (err) { logger.error(`Error stopping Nixie Valve ${err}`); }
73
+ }
74
+
75
+ } catch (err) { } // Don't bail if we have an errror.
76
+ }
77
+
78
+ public async initValveAsync(valve: Valve): Promise<NixieValve> {
79
+ try {
80
+ let c: NixieValve = this.find(elem => elem.id === valve.id) as NixieValve;
81
+ if (typeof c === 'undefined') {
82
+ c = new NixieValve(this.controlPanel, valve);
83
+ this.push(c);
84
+ }
85
+ return c;
86
+ } catch (err) { return Promise.reject(logger.error(`Nixie Controller: initValveAsync Error: ${err.message}`)); }
87
+ }
88
+
89
+ }
90
+ export class NixieValve extends NixieEquipment {
91
+ public pollingInterval: number = 10000;
92
+ private _pollTimer: NodeJS.Timeout = null;
93
+ public valve: Valve;
94
+ private _lastState;
95
+ constructor(ncp: INixieControlPanel, valve: Valve) {
96
+ super(ncp);
97
+ this.valve = valve;
98
+ this.pollEquipmentAsync();
99
+ }
100
+ public get id(): number { return typeof this.valve !== 'undefined' ? this.valve.id : -1; }
101
+ public async setValveStateAsync(vstate: ValveState, isDiverted: boolean) {
102
+ try {
103
+ // Here we go we need to set the valve state.
104
+ if (vstate.isDiverted !== isDiverted) {
105
+ logger.verbose(`Nixie: Set valve ${vstate.id}-${vstate.name} to ${isDiverted}`);
106
+ }
107
+ if (utils.isNullOrEmpty(this.valve.connectionId) || utils.isNullOrEmpty(this.valve.deviceBinding)) {
108
+ vstate.isDiverted = isDiverted;
109
+ return new InterfaceServerResponse(200, 'Success');
110
+ }
111
+ if (typeof this._lastState === 'undefined' || isDiverted || this._lastState !== isDiverted) {
112
+ let res = await NixieEquipment.putDeviceService(this.valve.connectionId, `/state/device/${this.valve.deviceBinding}`, { isOn: isDiverted, latch: isDiverted ? 10000 : undefined });
113
+ if (res.status.code === 200) this._lastState = vstate.isDiverted = isDiverted;
114
+ return res;
115
+ }
116
+ else {
117
+ vstate.isDiverted = isDiverted;
118
+ return new InterfaceServerResponse(200, 'Success');
119
+ }
120
+ } catch (err) { return logger.error(`Nixie Error setting valve state ${vstate.id}-${vstate.name}: ${err.message}`); }
121
+ }
122
+ public async setValveAsync(data: any) {
123
+ try {
124
+ let valve = this.valve;
125
+ }
126
+ catch (err) { logger.error(`Nixie setValveAsync: ${err.message}`); return Promise.reject(err); }
127
+ }
128
+ public async pollEquipmentAsync() {
129
+ let self = this;
130
+ try {
131
+ if (typeof this._pollTimer !== 'undefined' || this._pollTimer) clearTimeout(this._pollTimer);
132
+ this._pollTimer = null;
133
+ let success = false;
134
+ }
135
+ catch (err) { logger.error(`Nixie Error polling valve - ${err}`); }
136
+ finally { this._pollTimer = setTimeout(async () => await self.pollEquipmentAsync(), this.pollingInterval || 10000); }
137
+ }
138
+ private async checkHardwareStatusAsync(connectionId: string, deviceBinding: string) {
139
+ try {
140
+ let dev = await NixieEquipment.getDeviceService(connectionId, `/status/device/${deviceBinding}`);
141
+ return dev;
142
+ } catch (err) { logger.error(`Nixie Valve checkHardwareStatusAsync: ${err.message}`); return { hasFault: true } }
143
+ }
144
+ public async validateSetupAsync(valve: Valve, vstate: ValveState) {
145
+ try {
146
+ if (typeof valve.connectionId !== 'undefined' && valve.connectionId !== ''
147
+ && typeof valve.deviceBinding !== 'undefined' && valve.deviceBinding !== '') {
148
+ try {
149
+ let stat = await this.checkHardwareStatusAsync(valve.connectionId, valve.deviceBinding);
150
+ // If we have a status check the return.
151
+ vstate.commStatus = stat.hasFault ? 1 : 0;
152
+ } catch (err) { vstate.commStatus = 1; }
153
+ }
154
+ else
155
+ vstate.commStatus = 0;
156
+ // The validation will be different if the valve is on or not. So lets get that information.
157
+ } catch (err) { logger.error(`Nixie Error checking Valve Hardware ${this.valve.name}: ${err.message}`); vstate.commStatus = 1; return Promise.reject(err); }
158
+ }
159
+ public async closeAsync() {
160
+ try {
161
+ if (typeof this._pollTimer !== 'undefined' || this._pollTimer) clearTimeout(this._pollTimer);
162
+ this._pollTimer = null;
163
+ let vstate = state.valves.getItemById(this.valve.id);
164
+ this.setValveStateAsync(vstate, false);
165
+ vstate.emitEquipmentChange();
166
+ }
167
+ catch (err) { logger.error(`Nixie Valve closeAsync: ${err.message}`); return Promise.reject(err); }
168
+ }
169
+ public logData(filename: string, data: any) { this.controlPanel.logData(filename, data); }
170
+ }