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
package/logger/Logger.ts CHANGED
@@ -1,5 +1,6 @@
1
1
  /* nodejs-poolController. An application to control pool equipment.
2
- Copyright (C) 2016, 2017, 2018, 2019, 2020. Russell Goldin, tagyoureit. russ.goldin@gmail.com
2
+ Copyright (C) 2016, 2017, 2018, 2019, 2020, 2021, 2022.
3
+ Russell Goldin, tagyoureit. russ.goldin@gmail.com
3
4
 
4
5
  This program is free software: you can redistribute it and/or modify
5
6
  it under the terms of the GNU Affero General Public License as
@@ -22,6 +23,7 @@ import { utils } from "../controller/Constants";
22
23
  import { Message } from '../controller/comms/messages/Messages';
23
24
  import { config } from '../config/Config';
24
25
  import { webApp } from '../web/Server';
26
+ import { sl } from '../controller/comms/ScreenLogic';
25
27
 
26
28
  const extend = require("extend");
27
29
 
@@ -32,9 +34,11 @@ class Logger {
32
34
  this.captureForReplayBaseDir = path.join(process.cwd(), '/logs/', this.getLogTimestamp());
33
35
  /* this.captureForReplayPath = path.join(this.captureForReplayBaseDir, '/packetCapture.json'); */
34
36
  this.pkts = [];
37
+ this.slMessages = [];
35
38
  }
36
39
  private cfg;
37
40
  private pkts: Message[];
41
+ private slMessages: any[];
38
42
  private pktPath: string;
39
43
  private consoleToFilePath: string;
40
44
  private transports: { console: winston.transports.ConsoleTransportInstance, file?: winston.transports.FileTransportInstance, consoleFile?: winston.transports.FileTransportInstance } = {
@@ -163,6 +167,25 @@ class Logger {
163
167
  else if (!msg.isValid) logger._logger.warn(msg.toLog());
164
168
  }
165
169
  }
170
+ public screenlogic(data: any){
171
+ if (logger.cfg.screenlogic.enabled || logger.cfg.app.captureForReplay){
172
+ if (logger.cfg.screenlogic.logToFile) {
173
+ logger.slMessages.push(data);
174
+ if (logger.slMessages.length > 5)
175
+ logger.flushSLLogs();
176
+ else {
177
+ // Attempt to ease up on the writes if we are logging a bunch of packets.
178
+ if (logger.pktTimer) clearTimeout(logger.pktTimer);
179
+ logger.pktTimer = setTimeout(logger.flushSLLogs, 1000);
180
+ }
181
+ }
182
+ webApp.emitToChannel('msgLogger', 'logMessage', data);
183
+
184
+ }
185
+ if (logger.cfg.screenlogic.logToConsole){
186
+ logger._logger.info(sl.toLog(data));
187
+ }
188
+ }
166
189
  public logAPI(apiReq:string){
167
190
  if (logger.cfg.app.captureForReplay){
168
191
  // TODO: buffer this
@@ -183,6 +206,7 @@ class Logger {
183
206
  var buf: string = '';
184
207
  if (logger.cfg.packet.enabled) {
185
208
  for (let i = 0; i < p.length; i++) {
209
+
186
210
  buf += (p[i].toLog() + os.EOL);
187
211
  }
188
212
  fs.appendFile(logger.pktPath, buf, function(err) {
@@ -190,14 +214,19 @@ class Logger {
190
214
  });
191
215
  }
192
216
  buf = '';
193
- /* if (logger.cfg.app.captureForReplay) {
194
- for (let i = 0; i < p.length; i++) {
195
- buf += (p[i].toReplay() + os.EOL);
196
- }
197
- fs.appendFile(logger.captureForReplayPath, buf, function (err) {
198
- if (err) logger.error('Error writing replay to %s: %s', logger.captureForReplayPath, err);
199
- });
200
- } */
217
+ }
218
+ public flushSLLogs() {
219
+ var p: any[] = logger.slMessages.splice(0, logger.slMessages.length);
220
+ var buf: string = '';
221
+
222
+ for (let i = 0; i < p.length; i++) {
223
+ buf += (p[i] + os.EOL);
224
+ }
225
+ fs.appendFile(logger.pktPath, buf, function(err) {
226
+ if (err) logger.error(`Error writing screenlogic message to ${logger.pktPath}: ${err.message}`);
227
+ });
228
+
229
+ buf = '';
201
230
  }
202
231
  public setOptions(opts, c?: any) {
203
232
  c = typeof c === 'undefined' ? this.cfg : c;
package/package.json CHANGED
@@ -1,56 +1,60 @@
1
- {
2
- "name": "nodejs-poolcontroller",
3
- "version": "7.6.1",
4
- "description": "nodejs-poolController",
5
- "main": "app.js",
6
- "author": {
7
- "name": "Russell Goldin",
8
- "name2": "Robert Strouse"
9
- },
10
- "license": "GNU Affero General Public License v3.0",
11
- "repository": {
12
- "type": "git",
13
- "url": "https://github.com/tagyoureit/nodejs-poolController.git"
14
- },
15
- "scripts": {
16
- "start": "npm run build && node dist/app.js",
17
- "start:cached": "node dist/app.js",
18
- "build": "tsc",
19
- "watch": "tsc -w"
20
- },
21
- "dependencies": {
22
- "@influxdata/influxdb-client": "^1.22.0",
23
- "eslint-config-promise": "^2.0.2",
24
- "express": "^4.17.2",
25
- "extend": "^3.0.2",
26
- "jszip": "^3.7.1",
27
- "mqtt": "^4.3.5",
28
- "multer": "^1.4.4",
29
- "multicast-dns": "^7.2.4",
30
- "node-ssdp": "^4.0.1",
31
- "serialport": "^9.2.8",
32
- "socket.io": "^4.4.1",
33
- "socket.io-client": "^4.4.1",
34
- "source-map-support": "^0.5.21",
35
- "winston": "^3.5.1"
36
- },
37
- "devDependencies": {
38
- "@types/express": "^4.17.13",
39
- "@types/extend": "^3.0.1",
40
- "@types/multer": "^1.4.7",
41
- "@types/node": "^12.20.43",
42
- "@typescript-eslint/eslint-plugin": "^5.11.0",
43
- "@typescript-eslint/parser": "^5.11.0",
44
- "eslint": "^8.8.0",
45
- "eslint-config-defaults": "^9.0.0",
46
- "eslint-config-standard": "^16.0.3",
47
- "eslint-plugin-import": "^2.25.4",
48
- "eslint-plugin-node": "^11.1.0",
49
- "eslint-plugin-promise": "^6.0.0",
50
- "eslint-plugin-standard": "^5.0.0",
51
- "grunt": "^1.4.1",
52
- "grunt-banner": "^0.6.0",
53
- "ts-node": "^10.5.0",
54
- "typescript": "^4.5.5"
55
- }
56
- }
1
+ {
2
+ "name": "nodejs-poolcontroller",
3
+ "version": "8.0.0",
4
+ "description": "nodejs-poolController",
5
+ "main": "app.js",
6
+ "author": {
7
+ "name": "Russell Goldin",
8
+ "name2": "Robert Strouse"
9
+ },
10
+ "license": "GNU Affero General Public License v3.0",
11
+ "repository": {
12
+ "type": "git",
13
+ "url": "https://github.com/tagyoureit/nodejs-poolController.git"
14
+ },
15
+ "engines": {
16
+ "npm": ">=7.0.0",
17
+ "node": ">=16.0.0"
18
+ },
19
+ "scripts": {
20
+ "start": "npm run build && node dist/app.js",
21
+ "start:cached": "node dist/app.js",
22
+ "build": "tsc",
23
+ "watch": "tsc -w"
24
+ },
25
+ "dependencies": {
26
+ "@influxdata/influxdb-client": "^1.32.0",
27
+ "eslint-config-promise": "^2.0.2",
28
+ "express": "^4.18.1",
29
+ "extend": "^3.0.2",
30
+ "jszip": "^3.9.1",
31
+ "mqtt": "^4.3.7",
32
+ "multer": "^1.4.5-lts.1",
33
+ "multicast-dns": "^7.2.4",
34
+ "node-screenlogic": "^1.10.1",
35
+ "node-ssdp": "^4.0.1",
36
+ "serialport": "^10.4.0",
37
+ "socket.io": "^4.5.0",
38
+ "socket.io-client": "^4.5.0",
39
+ "source-map-support": "^0.5.21",
40
+ "winston": "^3.7.2"
41
+ },
42
+ "devDependencies": {
43
+ "@types/express": "^4.17.13",
44
+ "@types/extend": "^3.0.1",
45
+ "@types/multer": "^1.4.7",
46
+ "@types/node": "^16.11.48",
47
+ "@typescript-eslint/eslint-plugin": "^5.33.0",
48
+ "@typescript-eslint/parser": "^5.33.0",
49
+ "eslint": "^8.21.0",
50
+ "eslint-config-defaults": "^9.0.0",
51
+ "eslint-plugin-import": "^2.26.0",
52
+ "eslint-plugin-node": "^11.1.0",
53
+ "eslint-plugin-promise": "^6.0.0",
54
+ "eslint-plugin-standard": "^5.0.0",
55
+ "grunt": "^1.5.3",
56
+ "grunt-banner": "^0.6.0",
57
+ "ts-node": "^10.7.0",
58
+ "typescript": "^4.6.4"
59
+ }
60
+ }
package/tsconfig.json CHANGED
@@ -1,25 +1,25 @@
1
- {
2
- "compilerOptions": {
3
- "baseUrl": ".",
4
- // "paths": { "*": [ "@types/*" ] },
5
- "target":"esnext",
6
- "module":"commonjs",
7
- "noImplicitAny": false,
8
- "removeComments": true,
9
- "preserveConstEnums": true,
10
- "sourceMap": true,
11
- "outDir": "dist",
12
- "moduleResolution": "node",
13
- "allowJs": false,
14
- "allowSyntheticDefaultImports": false,
15
- "esModuleInterop": false,
16
- "jsx": "react"
17
- },
18
- "include": [
19
- "web/**/*",
20
- "logger/**/*",
21
- "controller/**/*",
22
- "config/**/*",
23
- "**/*.ts"
24
- ]
25
- }
1
+ {
2
+ "compilerOptions": {
3
+ "baseUrl": ".",
4
+ // "paths": { "*": [ "@types/*" ] },
5
+ "target":"esnext",
6
+ "module":"commonjs",
7
+ "noImplicitAny": false,
8
+ "removeComments": true,
9
+ "preserveConstEnums": true,
10
+ "sourceMap": true,
11
+ "outDir": "dist",
12
+ "moduleResolution": "node",
13
+ "allowJs": false,
14
+ "allowSyntheticDefaultImports": false,
15
+ "esModuleInterop": false,
16
+ "jsx": "react"
17
+ },
18
+ "include": [
19
+ "web/**/*",
20
+ "logger/**/*",
21
+ "controller/**/*",
22
+ "config/**/*",
23
+ "**/*.ts"
24
+ ]
25
+ }