nodejs-poolcontroller 8.3.0 → 8.4.1

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 (107) 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 -63
  7. package/.github/workflows/ghcr-publish.yml +67 -67
  8. package/157_issues.md +101 -0
  9. package/AGENTS.md +613 -0
  10. package/CONTRIBUTING.md +74 -74
  11. package/Changelog +292 -284
  12. package/Dockerfile +62 -62
  13. package/Gruntfile.js +40 -40
  14. package/LICENSE +661 -661
  15. package/README.md +329 -309
  16. package/anslq25/MessagesMock.ts +221 -221
  17. package/anslq25/boards/MockBoardFactory.ts +49 -49
  18. package/anslq25/boards/MockEasyTouchBoard.ts +696 -696
  19. package/anslq25/boards/MockSystemBoard.ts +216 -216
  20. package/anslq25/chemistry/MockChlorinator.ts +98 -98
  21. package/anslq25/pumps/MockPump.ts +83 -83
  22. package/app.ts +115 -115
  23. package/config/Config.ts +0 -0
  24. package/config/VersionCheck.ts +0 -0
  25. package/controller/Constants.ts +809 -805
  26. package/controller/Equipment.ts +2737 -2664
  27. package/controller/Errors.ts +181 -181
  28. package/controller/Lockouts.ts +549 -549
  29. package/controller/State.ts +3746 -3701
  30. package/controller/boards/AquaLinkBoard.ts +1175 -1003
  31. package/controller/boards/BoardFactory.ts +53 -53
  32. package/controller/boards/EasyTouchBoard.ts +3246 -3202
  33. package/controller/boards/IntelliCenterBoard.ts +4581 -3899
  34. package/controller/boards/IntelliComBoard.ts +69 -69
  35. package/controller/boards/IntelliTouchBoard.ts +382 -382
  36. package/controller/boards/NixieBoard.ts +1947 -1944
  37. package/controller/boards/SunTouchBoard.ts +401 -400
  38. package/controller/boards/SystemBoard.ts +5303 -5268
  39. package/controller/comms/Comms.ts +1278 -1255
  40. package/controller/comms/ScreenLogic.ts +1665 -1665
  41. package/controller/comms/messages/Messages.ts +1627 -1406
  42. package/controller/comms/messages/config/ChlorinatorMessage.ts +5 -0
  43. package/controller/comms/messages/config/CircuitGroupMessage.ts +0 -0
  44. package/controller/comms/messages/config/CircuitMessage.ts +0 -0
  45. package/controller/comms/messages/config/ConfigMessage.ts +6 -0
  46. package/controller/comms/messages/config/CoverMessage.ts +0 -0
  47. package/controller/comms/messages/config/CustomNameMessage.ts +31 -31
  48. package/controller/comms/messages/config/EquipmentMessage.ts +250 -210
  49. package/controller/comms/messages/config/ExternalMessage.ts +1051 -903
  50. package/controller/comms/messages/config/FeatureMessage.ts +0 -0
  51. package/controller/comms/messages/config/GeneralMessage.ts +65 -0
  52. package/controller/comms/messages/config/HeaterMessage.ts +0 -0
  53. package/controller/comms/messages/config/IntellichemMessage.ts +0 -0
  54. package/controller/comms/messages/config/OptionsMessage.ts +207 -174
  55. package/controller/comms/messages/config/PumpMessage.ts +427 -421
  56. package/controller/comms/messages/config/RemoteMessage.ts +0 -0
  57. package/controller/comms/messages/config/ScheduleMessage.ts +401 -390
  58. package/controller/comms/messages/config/SecurityMessage.ts +37 -13
  59. package/controller/comms/messages/config/ValveMessage.ts +0 -0
  60. package/controller/comms/messages/status/ChlorinatorStateMessage.ts +0 -0
  61. package/controller/comms/messages/status/EquipmentStateMessage.ts +940 -822
  62. package/controller/comms/messages/status/HeaterStateMessage.ts +147 -135
  63. package/controller/comms/messages/status/IntelliChemStateMessage.ts +448 -448
  64. package/controller/comms/messages/status/IntelliValveStateMessage.ts +36 -36
  65. package/controller/comms/messages/status/NeptuneModbusStateMessage.ts +217 -0
  66. package/controller/comms/messages/status/PumpStateMessage.ts +0 -0
  67. package/controller/comms/messages/status/RegalModbusStateMessage.ts +410 -410
  68. package/controller/comms/messages/status/VersionMessage.ts +152 -41
  69. package/controller/nixie/Nixie.ts +173 -173
  70. package/controller/nixie/NixieEquipment.ts +104 -104
  71. package/controller/nixie/bodies/Body.ts +120 -120
  72. package/controller/nixie/bodies/Filter.ts +135 -135
  73. package/controller/nixie/chemistry/ChemController.ts +2756 -2724
  74. package/controller/nixie/chemistry/ChemDoser.ts +806 -806
  75. package/controller/nixie/chemistry/Chlorinator.ts +367 -367
  76. package/controller/nixie/circuits/Circuit.ts +478 -478
  77. package/controller/nixie/heaters/Heater.ts +843 -834
  78. package/controller/nixie/pumps/Pump.ts +1336 -1193
  79. package/controller/nixie/schedules/Schedule.ts +401 -401
  80. package/controller/nixie/valves/Valve.ts +170 -170
  81. package/defaultConfig.json +352 -352
  82. package/docker-compose.yml +32 -31
  83. package/logger/DataLogger.ts +448 -448
  84. package/logger/Logger.ts +459 -436
  85. package/package.json +58 -58
  86. package/sendSocket.js +32 -32
  87. package/tsconfig.json +26 -25
  88. package/types/express-multer.d.ts +32 -32
  89. package/web/Server.ts +1939 -1927
  90. package/web/bindings/aqualinkD.json +559 -559
  91. package/web/bindings/influxDB.json +1066 -1066
  92. package/web/bindings/mqtt.json +721 -721
  93. package/web/bindings/mqttAlt.json +746 -746
  94. package/web/bindings/rulesManager.json +54 -54
  95. package/web/bindings/smartThings-Hubitat.json +31 -31
  96. package/web/bindings/valveRelays.json +20 -20
  97. package/web/bindings/vera.json +25 -25
  98. package/web/interfaces/baseInterface.ts +188 -188
  99. package/web/interfaces/httpInterface.ts +148 -148
  100. package/web/interfaces/influxInterface.ts +283 -283
  101. package/web/interfaces/mqttInterface.ts +695 -695
  102. package/web/interfaces/ruleInterface.ts +101 -87
  103. package/web/services/config/Config.ts +1212 -1053
  104. package/web/services/config/ConfigSocket.ts +0 -0
  105. package/web/services/state/State.ts +21 -0
  106. package/web/services/state/StateSocket.ts +28 -0
  107. package/web/services/utilities/Utilities.ts +233 -233
@@ -1,135 +1,135 @@
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 { Filter, FilterCollection, sys } from "../../../controller/Equipment";
7
- import { FilterState, 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 NixieFilterCollection extends NixieEquipmentCollection<NixieFilter> {
13
- public async setFilterStateAsync(fstate: FilterState, val: boolean) {
14
- try {
15
- let f: NixieFilter = this.find(elem => elem.id === fstate.id) as NixieFilter;
16
- if (typeof f === 'undefined') return Promise.reject(new Error(`NCP: Filter ${fstate.id}-${fstate.name} could not be found to set the state to ${val}.`));
17
- await f.setFilterStateAsync(fstate, val);
18
- }
19
- catch (err) { return logger.error(`NCP: setCircuitFilterAsync ${fstate.id}-${fstate.name}: ${err.message}`); }
20
- }
21
-
22
- public async setFilterAsync(filter: Filter, data: any) {
23
- // By the time we get here we know that we are in control and this is a REMChem.
24
- try {
25
- let c: NixieFilter = this.find(elem => elem.id === filter.id) as NixieFilter;
26
- if (typeof c === 'undefined') {
27
- filter.master = 1;
28
- c = new NixieFilter(this.controlPanel, filter);
29
- this.push(c);
30
- await c.setFilterAsync(data);
31
- logger.info(`A Filter was not found for id #${filter.id} creating Filter`);
32
- }
33
- else {
34
- await c.setFilterAsync(data);
35
- }
36
- }
37
- catch (err) { logger.error(`setFilterAsync: ${err.message}`); return Promise.reject(err); }
38
- }
39
- public async initAsync(filters: FilterCollection) {
40
- try {
41
- this.length = 0;
42
- for (let i = 0; i < filters.length; i++) {
43
- let filter = filters.getItemByIndex(i);
44
- if (filter.master === 1) {
45
- if (typeof this.find(elem => elem.id === filter.id) === 'undefined') {
46
- logger.info(`Initializing Filter ${Filter.name}`);
47
- let nFilter = new NixieFilter(this.controlPanel, filter);
48
- this.push(nFilter);
49
- }
50
- }
51
- }
52
- }
53
- catch (err) { logger.error(`Nixie Filter initAsync: ${err.message}`); return Promise.reject(err); }
54
- }
55
- public async closeAsync() {
56
- try {
57
- for (let i = this.length - 1; i >= 0; i--) {
58
- try {
59
- await this[i].closeAsync();
60
- this.splice(i, 1);
61
- } catch (err) { logger.error(`Error stopping Nixie Filter ${err}`); }
62
- }
63
-
64
- } catch (err) { } // Don't bail if we have an errror.
65
- }
66
- }
67
- export class NixieFilter extends NixieEquipment {
68
- public pollingInterval: number = 10000;
69
- private _pollTimer: NodeJS.Timeout = null;
70
- private _lastState;
71
- public filter: Filter;
72
- constructor(ncp: INixieControlPanel, filter: Filter) {
73
- super(ncp);
74
- this.filter = filter;
75
- this.pollEquipmentAsync();
76
- }
77
- public get id(): number { return typeof this.filter !== 'undefined' ? this.filter.id : -1; }
78
- public async setFilterAsync(data: any) {
79
- try {
80
- let filter = this.filter;
81
- }
82
- catch (err) { logger.error(`Nixie setFilterAsync: ${err.message}`); return Promise.reject(err); }
83
- }
84
- public async setFilterStateAsync(fstate: FilterState, val: boolean): Promise<InterfaceServerResponse> {
85
- try {
86
- if (utils.isNullOrEmpty(this.filter.connectionId) || utils.isNullOrEmpty(this.filter.deviceBinding)) {
87
- fstate.isOn = val;
88
- return new InterfaceServerResponse(200, 'Success');
89
- }
90
- if (typeof this._lastState === 'undefined' || val || this._lastState !== val) {
91
- let res = await NixieEquipment.putDeviceService(this.filter.connectionId, `/state/device/${this.filter.deviceBinding}`, { isOn: val, latch: val ? 10000 : undefined });
92
- if (res.status.code === 200) this._lastState = fstate.isOn = val;
93
- return res;
94
- }
95
- else {
96
- fstate.isOn = val;
97
- return new InterfaceServerResponse(200, 'Success');
98
- }
99
- } catch (err) { logger.error(`Nixie: Error setting filter state ${fstate.id}-${fstate.name} to ${val}`); }
100
- }
101
-
102
- public async pollEquipmentAsync() {
103
- let self = this;
104
- try {
105
- if (typeof this._pollTimer !== 'undefined' || this._pollTimer) clearTimeout(this._pollTimer);
106
- this._pollTimer = null;
107
- let success = false;
108
- }
109
- catch (err) { logger.error(`Nixie Error polling Filter - ${err}`); }
110
- finally { this._pollTimer = setTimeout(async () => await self.pollEquipmentAsync(), this.pollingInterval || 10000); }
111
- }
112
- private async checkHardwareStatusAsync(connectionId: string, deviceBinding: string) {
113
- try {
114
- let dev = await NixieEquipment.getDeviceService(connectionId, `/status/device/${deviceBinding}`);
115
- return dev;
116
- } catch (err) { logger.error(`Nixie Filter checkHardwareStatusAsync: ${err.message}`); return { hasFault: true } }
117
- }
118
- public async validateSetupAsync(Filter: Filter, temp: FilterState) {
119
- try {
120
- // The validation will be different if the Filter is on or not. So lets get that information.
121
- } catch (err) { logger.error(`Nixie Error checking Filter Hardware ${this.filter.name}: ${err.message}`); return Promise.reject(err); }
122
- }
123
- public async closeAsync() {
124
- try {
125
- if (typeof this._pollTimer !== 'undefined' || this._pollTimer) clearTimeout(this._pollTimer);
126
- this._pollTimer = null;
127
- let fstate = state.filters.getItemById(this.filter.id);
128
- logger.info(`Closing filter ${fstate.name}`)
129
- await this.setFilterStateAsync(fstate, false);
130
- fstate.emitEquipmentChange();
131
- }
132
- catch (err) { logger.error(`Nixie Filter closeAsync: ${err.message}`); return Promise.reject(err); }
133
- }
134
- public logData(filename: string, data: any) { this.controlPanel.logData(filename, data); }
135
- }
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 { Filter, FilterCollection, sys } from "../../../controller/Equipment";
7
+ import { FilterState, 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 NixieFilterCollection extends NixieEquipmentCollection<NixieFilter> {
13
+ public async setFilterStateAsync(fstate: FilterState, val: boolean) {
14
+ try {
15
+ let f: NixieFilter = this.find(elem => elem.id === fstate.id) as NixieFilter;
16
+ if (typeof f === 'undefined') return Promise.reject(new Error(`NCP: Filter ${fstate.id}-${fstate.name} could not be found to set the state to ${val}.`));
17
+ await f.setFilterStateAsync(fstate, val);
18
+ }
19
+ catch (err) { return logger.error(`NCP: setCircuitFilterAsync ${fstate.id}-${fstate.name}: ${err.message}`); }
20
+ }
21
+
22
+ public async setFilterAsync(filter: Filter, data: any) {
23
+ // By the time we get here we know that we are in control and this is a REMChem.
24
+ try {
25
+ let c: NixieFilter = this.find(elem => elem.id === filter.id) as NixieFilter;
26
+ if (typeof c === 'undefined') {
27
+ filter.master = 1;
28
+ c = new NixieFilter(this.controlPanel, filter);
29
+ this.push(c);
30
+ await c.setFilterAsync(data);
31
+ logger.info(`A Filter was not found for id #${filter.id} creating Filter`);
32
+ }
33
+ else {
34
+ await c.setFilterAsync(data);
35
+ }
36
+ }
37
+ catch (err) { logger.error(`setFilterAsync: ${err.message}`); return Promise.reject(err); }
38
+ }
39
+ public async initAsync(filters: FilterCollection) {
40
+ try {
41
+ this.length = 0;
42
+ for (let i = 0; i < filters.length; i++) {
43
+ let filter = filters.getItemByIndex(i);
44
+ if (filter.master === 1) {
45
+ if (typeof this.find(elem => elem.id === filter.id) === 'undefined') {
46
+ logger.info(`Initializing Filter ${Filter.name}`);
47
+ let nFilter = new NixieFilter(this.controlPanel, filter);
48
+ this.push(nFilter);
49
+ }
50
+ }
51
+ }
52
+ }
53
+ catch (err) { logger.error(`Nixie Filter initAsync: ${err.message}`); return Promise.reject(err); }
54
+ }
55
+ public async closeAsync() {
56
+ try {
57
+ for (let i = this.length - 1; i >= 0; i--) {
58
+ try {
59
+ await this[i].closeAsync();
60
+ this.splice(i, 1);
61
+ } catch (err) { logger.error(`Error stopping Nixie Filter ${err}`); }
62
+ }
63
+
64
+ } catch (err) { } // Don't bail if we have an errror.
65
+ }
66
+ }
67
+ export class NixieFilter extends NixieEquipment {
68
+ public pollingInterval: number = 10000;
69
+ private _pollTimer: NodeJS.Timeout = null;
70
+ private _lastState;
71
+ public filter: Filter;
72
+ constructor(ncp: INixieControlPanel, filter: Filter) {
73
+ super(ncp);
74
+ this.filter = filter;
75
+ this.pollEquipmentAsync();
76
+ }
77
+ public get id(): number { return typeof this.filter !== 'undefined' ? this.filter.id : -1; }
78
+ public async setFilterAsync(data: any) {
79
+ try {
80
+ let filter = this.filter;
81
+ }
82
+ catch (err) { logger.error(`Nixie setFilterAsync: ${err.message}`); return Promise.reject(err); }
83
+ }
84
+ public async setFilterStateAsync(fstate: FilterState, val: boolean): Promise<InterfaceServerResponse> {
85
+ try {
86
+ if (utils.isNullOrEmpty(this.filter.connectionId) || utils.isNullOrEmpty(this.filter.deviceBinding)) {
87
+ fstate.isOn = val;
88
+ return new InterfaceServerResponse(200, 'Success');
89
+ }
90
+ if (typeof this._lastState === 'undefined' || val || this._lastState !== val) {
91
+ let res = await NixieEquipment.putDeviceService(this.filter.connectionId, `/state/device/${this.filter.deviceBinding}`, { isOn: val, latch: val ? 10000 : undefined });
92
+ if (res.status.code === 200) this._lastState = fstate.isOn = val;
93
+ return res;
94
+ }
95
+ else {
96
+ fstate.isOn = val;
97
+ return new InterfaceServerResponse(200, 'Success');
98
+ }
99
+ } catch (err) { logger.error(`Nixie: Error setting filter state ${fstate.id}-${fstate.name} to ${val}`); }
100
+ }
101
+
102
+ public async pollEquipmentAsync() {
103
+ let self = this;
104
+ try {
105
+ if (typeof this._pollTimer !== 'undefined' || this._pollTimer) clearTimeout(this._pollTimer);
106
+ this._pollTimer = null;
107
+ let success = false;
108
+ }
109
+ catch (err) { logger.error(`Nixie Error polling Filter - ${err}`); }
110
+ finally { this._pollTimer = setTimeout(async () => await self.pollEquipmentAsync(), this.pollingInterval || 10000); }
111
+ }
112
+ private async checkHardwareStatusAsync(connectionId: string, deviceBinding: string) {
113
+ try {
114
+ let dev = await NixieEquipment.getDeviceService(connectionId, `/status/device/${deviceBinding}`);
115
+ return dev;
116
+ } catch (err) { logger.error(`Nixie Filter checkHardwareStatusAsync: ${err.message}`); return { hasFault: true } }
117
+ }
118
+ public async validateSetupAsync(Filter: Filter, temp: FilterState) {
119
+ try {
120
+ // The validation will be different if the Filter is on or not. So lets get that information.
121
+ } catch (err) { logger.error(`Nixie Error checking Filter Hardware ${this.filter.name}: ${err.message}`); return Promise.reject(err); }
122
+ }
123
+ public async closeAsync() {
124
+ try {
125
+ if (typeof this._pollTimer !== 'undefined' || this._pollTimer) clearTimeout(this._pollTimer);
126
+ this._pollTimer = null;
127
+ let fstate = state.filters.getItemById(this.filter.id);
128
+ logger.info(`Closing filter ${fstate.name}`)
129
+ await this.setFilterStateAsync(fstate, false);
130
+ fstate.emitEquipmentChange();
131
+ }
132
+ catch (err) { logger.error(`Nixie Filter closeAsync: ${err.message}`); return Promise.reject(err); }
133
+ }
134
+ public logData(filename: string, data: any) { this.controlPanel.logData(filename, data); }
135
+ }