nodejs-poolcontroller 8.3.0 → 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 (105) 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/AGENTS.md +597 -0
  9. package/CONTRIBUTING.md +74 -74
  10. package/Changelog +292 -284
  11. package/Dockerfile +62 -62
  12. package/Gruntfile.js +40 -40
  13. package/LICENSE +661 -661
  14. package/README.md +318 -309
  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 +0 -0
  23. package/config/VersionCheck.ts +0 -0
  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 -3701
  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 -1944
  36. package/controller/boards/SunTouchBoard.ts +400 -400
  37. package/controller/boards/SystemBoard.ts +5268 -5268
  38. package/controller/comms/Comms.ts +1272 -1255
  39. package/controller/comms/ScreenLogic.ts +1665 -1665
  40. package/controller/comms/messages/Messages.ts +1433 -1406
  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 +410 -410
  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 +1193 -1193
  77. package/controller/nixie/schedules/Schedule.ts +401 -401
  78. package/controller/nixie/valves/Valve.ts +170 -170
  79. package/defaultConfig.json +352 -352
  80. package/docker-compose.yml +31 -31
  81. package/logger/DataLogger.ts +448 -448
  82. package/logger/Logger.ts +448 -436
  83. package/package.json +58 -58
  84. package/sendSocket.js +32 -32
  85. package/tsconfig.json +25 -25
  86. package/types/express-multer.d.ts +32 -32
  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
@@ -1,84 +1,84 @@
1
- import { sys } from "../../controller/Equipment";
2
- import { PumpState, state } from "../../controller/State";
3
- import { Outbound } from "../../controller/comms/messages/Messages";
4
- import { conn } from "controller/comms/Comms";
5
-
6
- export class MockPump {
7
- constructor(){}
8
-
9
- public process(outboundMsg: Outbound){
10
- let response: Outbound = Outbound.create({
11
- portId: outboundMsg.portId,
12
- protocol: outboundMsg.protocol
13
- });
14
-
15
- switch (outboundMsg.action){
16
- case 7:
17
- this.pumpStatus(outboundMsg, response);
18
- default:
19
- this.pumpAck(outboundMsg, response);
20
- }
21
- }
22
-
23
- public pumpStatus(outboundMsg: Outbound, response: Outbound){
24
- let pState:PumpState = state.pumps.getItemById(outboundMsg.dest - 96);
25
- let pt = sys.board.valueMaps.pumpTypes.get(pState.type);
26
- response.action = 7;
27
- response.source = outboundMsg.dest;
28
- response.dest = outboundMsg.source;
29
- response.appendPayloadBytes(0, 15);
30
- response.setPayloadByte(0, pState.command, 2);
31
- response.setPayloadByte(1, pState.mode, 0);
32
- response.setPayloadByte(2, pState.driveState, 2);
33
- let watts = 0;
34
- if (Math.max(pState.rpm, pState.flow) > 0){
35
- if (pState.rpm > 0) watts = pState.rpm/pt.maxSpeed * 2000 + this.random(100);
36
- else if (pState.flow > 0) watts = pState.flow/pt.maxFlow * 2000 + this.random(100);
37
- else //ss, ds, etc
38
- watts = 2000 + this.random(250);
39
- }
40
- response.setPayloadByte(3, Math.floor(watts / 256), 0);
41
- response.setPayloadByte(4, watts % 256, 0);
42
- response.setPayloadByte(5, Math.floor(pState.rpm / 256), 0);
43
- response.setPayloadByte(6, pState.rpm % 256, 0);
44
- response.setPayloadByte(7, pState.flow, 0);
45
- response.setPayloadByte(8, pState.ppc, 0);
46
- // 9, 10 = unknown
47
- // 11, 12 = Status code;
48
- response.setPayloadByte(11, Math.floor(pState.status / 256), 0);
49
- response.setPayloadByte(12, pState.status % 256, 1);
50
- let time = new Date();
51
- response.setPayloadByte(13, time.getHours() * 60);
52
- response.setPayloadByte(14, time.getMinutes());
53
-
54
- conn.queueSendMessage(response);
55
- }
56
-
57
- public pumpAck(outboundMsg: Outbound, response: Outbound){
58
- response.action = outboundMsg.action;
59
- response.source = outboundMsg.dest;
60
- response.dest = outboundMsg.source;
61
- switch (outboundMsg.action){
62
- case 1:
63
- case 10: {
64
- response.appendPayloadByte(outboundMsg.payload[2]);
65
- response.appendPayloadByte(outboundMsg.payload[3]);
66
- break;
67
- }
68
- default:
69
- response.appendPayloadByte(outboundMsg.payload[0]);
70
- }
71
- conn.queueSendMessage(response);
72
- }
73
-
74
- private random(bounds: number, onlyPositive: boolean = false){
75
- let rand = Math.random() * bounds;
76
- if (!onlyPositive) {
77
- if (Math.random()<=.5) rand = rand * -1;
78
- }
79
- return rand;
80
- }
81
-
82
- }
83
-
1
+ import { sys } from "../../controller/Equipment";
2
+ import { PumpState, state } from "../../controller/State";
3
+ import { Outbound } from "../../controller/comms/messages/Messages";
4
+ import { conn } from "controller/comms/Comms";
5
+
6
+ export class MockPump {
7
+ constructor(){}
8
+
9
+ public process(outboundMsg: Outbound){
10
+ let response: Outbound = Outbound.create({
11
+ portId: outboundMsg.portId,
12
+ protocol: outboundMsg.protocol
13
+ });
14
+
15
+ switch (outboundMsg.action){
16
+ case 7:
17
+ this.pumpStatus(outboundMsg, response);
18
+ default:
19
+ this.pumpAck(outboundMsg, response);
20
+ }
21
+ }
22
+
23
+ public pumpStatus(outboundMsg: Outbound, response: Outbound){
24
+ let pState:PumpState = state.pumps.getItemById(outboundMsg.dest - 96);
25
+ let pt = sys.board.valueMaps.pumpTypes.get(pState.type);
26
+ response.action = 7;
27
+ response.source = outboundMsg.dest;
28
+ response.dest = outboundMsg.source;
29
+ response.appendPayloadBytes(0, 15);
30
+ response.setPayloadByte(0, pState.command, 2);
31
+ response.setPayloadByte(1, pState.mode, 0);
32
+ response.setPayloadByte(2, pState.driveState, 2);
33
+ let watts = 0;
34
+ if (Math.max(pState.rpm, pState.flow) > 0){
35
+ if (pState.rpm > 0) watts = pState.rpm/pt.maxSpeed * 2000 + this.random(100);
36
+ else if (pState.flow > 0) watts = pState.flow/pt.maxFlow * 2000 + this.random(100);
37
+ else //ss, ds, etc
38
+ watts = 2000 + this.random(250);
39
+ }
40
+ response.setPayloadByte(3, Math.floor(watts / 256), 0);
41
+ response.setPayloadByte(4, watts % 256, 0);
42
+ response.setPayloadByte(5, Math.floor(pState.rpm / 256), 0);
43
+ response.setPayloadByte(6, pState.rpm % 256, 0);
44
+ response.setPayloadByte(7, pState.flow, 0);
45
+ response.setPayloadByte(8, pState.ppc, 0);
46
+ // 9, 10 = unknown
47
+ // 11, 12 = Status code;
48
+ response.setPayloadByte(11, Math.floor(pState.status / 256), 0);
49
+ response.setPayloadByte(12, pState.status % 256, 1);
50
+ let time = new Date();
51
+ response.setPayloadByte(13, time.getHours() * 60);
52
+ response.setPayloadByte(14, time.getMinutes());
53
+
54
+ conn.queueSendMessage(response);
55
+ }
56
+
57
+ public pumpAck(outboundMsg: Outbound, response: Outbound){
58
+ response.action = outboundMsg.action;
59
+ response.source = outboundMsg.dest;
60
+ response.dest = outboundMsg.source;
61
+ switch (outboundMsg.action){
62
+ case 1:
63
+ case 10: {
64
+ response.appendPayloadByte(outboundMsg.payload[2]);
65
+ response.appendPayloadByte(outboundMsg.payload[3]);
66
+ break;
67
+ }
68
+ default:
69
+ response.appendPayloadByte(outboundMsg.payload[0]);
70
+ }
71
+ conn.queueSendMessage(response);
72
+ }
73
+
74
+ private random(bounds: number, onlyPositive: boolean = false){
75
+ let rand = Math.random() * bounds;
76
+ if (!onlyPositive) {
77
+ if (Math.random()<=.5) rand = rand * -1;
78
+ }
79
+ return rand;
80
+ }
81
+
82
+ }
83
+
84
84
  export var mockPump: MockPump = new MockPump();
package/app.ts CHANGED
@@ -1,116 +1,116 @@
1
- /* nodejs-poolController. An application to control pool equipment.
2
- Copyright (C) 2016, 2017, 2018, 2019, 2020, 2021, 2022.
3
- Russell Goldin, tagyoureit. russ.goldin@gmail.com
4
-
5
- This program is free software: you can redistribute it and/or modify
6
- it under the terms of the GNU Affero General Public License as
7
- published by the Free Software Foundation, either version 3 of the
8
- License, or (at your option) any later version.
9
-
10
- This program is distributed in the hope that it will be useful,
11
- but WITHOUT ANY WARRANTY; without even the implied warranty of
12
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13
- GNU Affero General Public License for more details.
14
-
15
- You should have received a copy of the GNU Affero General Public License
16
- along with this program. If not, see <http://www.gnu.org/licenses/>.
17
- */
18
- // add source map support for .js to .ts files
19
- //require('source-map-support').install();
20
- import 'source-map-support/register';
21
-
22
- import { logger } from "./logger/Logger";
23
- import { config } from "./config/Config";
24
- import { conn } from "./controller/comms/Comms";
25
- import { sys } from "./controller/Equipment";
26
-
27
- import { state } from "./controller/State";
28
- import { webApp, REMInterfaceServer } from "./web/Server";
29
- import * as readline from 'readline';
30
- import { sl } from './controller/comms/ScreenLogic'
31
-
32
- export async function initAsync() {
33
- try {
34
- await config.init();
35
- await logger.init();
36
- await sys.init();
37
- await state.init();
38
- await webApp.init();
39
- await conn.initAsync();
40
- await sys.start();
41
- await webApp.initAutoBackup();
42
- await sl.openAsync();
43
- } catch (err) { console.log(`Error Initializing nodejs-PoolController ${err.message}`); }
44
- }
45
-
46
- export async function startPacketCapture(bResetLogs: boolean) {
47
- try {
48
- let log = config.getSection('log');
49
- log.app.captureForReplay = true;
50
- config.setSection('log', log);
51
- logger.startCaptureForReplay(bResetLogs);
52
- if (bResetLogs){
53
- sys.resetSystem();
54
- }
55
-
56
- // Start packet capture on the REM server
57
- await REMInterfaceServer.startPacketCaptureOnRemServer();
58
- }
59
- catch (err) {
60
- console.error(`Error starting replay: ${ err.message }`);
61
- }
62
- }
63
- export async function stopPacketCaptureAsync() {
64
- let log = config.getSection('log');
65
- log.app.captureForReplay = false;
66
- config.setSection('log', log);
67
-
68
- // Stop packet capture on the REM server and collect its logs
69
- let remLogs = await REMInterfaceServer.stopPacketCaptureOnRemServer();
70
-
71
- // Pass REM logs to the logger for inclusion in the backup
72
- return logger.stopCaptureForReplayAsync(remLogs);
73
- }
74
- export async function stopAsync(): Promise<void> {
75
- try {
76
- console.log('Shutting down open processes');
77
- await webApp.stopAutoBackup();
78
- await sys.stopAsync();
79
- await state.stopAsync();
80
- await conn.stopAsync();
81
- await sl.closeAsync();
82
- await webApp.stopAsync();
83
- await config.updateAsync();
84
- await logger.stopAsync();
85
- // RKS: Uncomment below to see the shutdown process
86
- //await new Promise<void>((resolve, reject) => { setTimeout(() => { resolve(); }, 20000); });
87
- }
88
- catch (err) {
89
- console.error(`Error stopping processes: ${ err.message }`);
90
- }
91
- finally {
92
- process.exit();
93
- }
94
- }
95
- if (process.platform === 'win32') {
96
- let rl = readline.createInterface({ input: process.stdin, output: process.stdout });
97
- rl.on('SIGINT', async function () {
98
- try { await stopAsync(); } catch (err) { console.log(`Error shutting down processes ${err.message}`); }
99
- });
100
- }
101
- else {
102
- process.stdin.resume();
103
- process.on('SIGINT', async function () {
104
- try { return await stopAsync(); } catch (err) { console.log(`Error shutting down processes ${err.message}`); }
105
- });
106
- }
107
- if (typeof process === 'object') {
108
- process.on('unhandledRejection', (error: Error, promise) => {
109
- console.group('unhandled rejection');
110
- console.error("== Node detected an unhandled rejection! ==");
111
- console.error(error.message);
112
- console.error(error.stack);
113
- console.groupEnd();
114
- });
115
- }
1
+ /* nodejs-poolController. An application to control pool equipment.
2
+ Copyright (C) 2016, 2017, 2018, 2019, 2020, 2021, 2022.
3
+ Russell Goldin, tagyoureit. russ.goldin@gmail.com
4
+
5
+ This program is free software: you can redistribute it and/or modify
6
+ it under the terms of the GNU Affero General Public License as
7
+ published by the Free Software Foundation, either version 3 of the
8
+ License, or (at your option) any later version.
9
+
10
+ This program is distributed in the hope that it will be useful,
11
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
12
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13
+ GNU Affero General Public License for more details.
14
+
15
+ You should have received a copy of the GNU Affero General Public License
16
+ along with this program. If not, see <http://www.gnu.org/licenses/>.
17
+ */
18
+ // add source map support for .js to .ts files
19
+ //require('source-map-support').install();
20
+ import 'source-map-support/register';
21
+
22
+ import { logger } from "./logger/Logger";
23
+ import { config } from "./config/Config";
24
+ import { conn } from "./controller/comms/Comms";
25
+ import { sys } from "./controller/Equipment";
26
+
27
+ import { state } from "./controller/State";
28
+ import { webApp, REMInterfaceServer } from "./web/Server";
29
+ import * as readline from 'readline';
30
+ import { sl } from './controller/comms/ScreenLogic'
31
+
32
+ export async function initAsync() {
33
+ try {
34
+ await config.init();
35
+ await logger.init();
36
+ await sys.init();
37
+ await state.init();
38
+ await webApp.init();
39
+ await conn.initAsync();
40
+ await sys.start();
41
+ await webApp.initAutoBackup();
42
+ await sl.openAsync();
43
+ } catch (err) { console.log(`Error Initializing nodejs-PoolController ${err.message}`); }
44
+ }
45
+
46
+ export async function startPacketCapture(bResetLogs: boolean) {
47
+ try {
48
+ let log = config.getSection('log');
49
+ log.app.captureForReplay = true;
50
+ config.setSection('log', log);
51
+ logger.startCaptureForReplay(bResetLogs);
52
+ if (bResetLogs){
53
+ await sys.resetSystemAsync();
54
+ }
55
+
56
+ // Start packet capture on the REM server
57
+ await REMInterfaceServer.startPacketCaptureOnRemServer();
58
+ }
59
+ catch (err) {
60
+ console.error(`Error starting replay: ${ err.message }`);
61
+ }
62
+ }
63
+ export async function stopPacketCaptureAsync() {
64
+ let log = config.getSection('log');
65
+ log.app.captureForReplay = false;
66
+ config.setSection('log', log);
67
+
68
+ // Stop packet capture on the REM server and collect its logs
69
+ let remLogs = await REMInterfaceServer.stopPacketCaptureOnRemServer();
70
+
71
+ // Pass REM logs to the logger for inclusion in the backup
72
+ return logger.stopCaptureForReplayAsync(remLogs);
73
+ }
74
+ export async function stopAsync(): Promise<void> {
75
+ try {
76
+ console.log('Shutting down open processes');
77
+ await webApp.stopAutoBackup();
78
+ await sys.stopAsync();
79
+ await state.stopAsync();
80
+ await conn.stopAsync();
81
+ await sl.closeAsync();
82
+ await webApp.stopAsync();
83
+ await config.updateAsync();
84
+ await logger.stopAsync();
85
+ // RKS: Uncomment below to see the shutdown process
86
+ //await new Promise<void>((resolve, reject) => { setTimeout(() => { resolve(); }, 20000); });
87
+ }
88
+ catch (err) {
89
+ console.error(`Error stopping processes: ${ err.message }`);
90
+ }
91
+ finally {
92
+ process.exit();
93
+ }
94
+ }
95
+ if (process.platform === 'win32') {
96
+ let rl = readline.createInterface({ input: process.stdin, output: process.stdout });
97
+ rl.on('SIGINT', async function () {
98
+ try { await stopAsync(); } catch (err) { console.log(`Error shutting down processes ${err.message}`); }
99
+ });
100
+ }
101
+ else {
102
+ process.stdin.resume();
103
+ process.on('SIGINT', async function () {
104
+ try { return await stopAsync(); } catch (err) { console.log(`Error shutting down processes ${err.message}`); }
105
+ });
106
+ }
107
+ if (typeof process === 'object') {
108
+ process.on('unhandledRejection', (error: Error, promise) => {
109
+ console.group('unhandled rejection');
110
+ console.error("== Node detected an unhandled rejection! ==");
111
+ console.error(error.message);
112
+ console.error(error.stack);
113
+ console.groupEnd();
114
+ });
115
+ }
116
116
  ( async () => { await initAsync() })();
package/config/Config.ts CHANGED
File without changes
File without changes