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
package/Dockerfile CHANGED
@@ -1,62 +1,62 @@
1
- ### Build stage
2
- FROM node:20-alpine AS build
3
- LABEL maintainer="nodejs-poolController"
4
- LABEL org.opencontainers.image.title="nodejs-poolController"
5
- LABEL org.opencontainers.image.description="Bridge Pentair / compatible pool automation equipment to modern interfaces (REST, WebSockets, MQTT, Influx, Rules)."
6
- LABEL org.opencontainers.image.licenses="AGPL-3.0-only"
7
- LABEL org.opencontainers.image.source="https://github.com/tagyoureit/nodejs-poolController"
8
-
9
- # Install build toolchain only for native deps (serialport, etc.)
10
- RUN apk add --no-cache make gcc g++ python3 linux-headers udev tzdata git
11
-
12
- WORKDIR /app
13
-
14
- # Leverage Docker layer caching: copy only manifests first
15
- COPY package*.json ./
16
- COPY defaultConfig.json config.json
17
-
18
- # Install all deps (including dev) for build
19
- RUN npm ci
20
-
21
- # Copy source
22
- COPY . .
23
-
24
- # Build Typescript
25
- RUN npm run build
26
-
27
- # Remove dev dependencies while keeping a clean node_modules with prod deps only
28
- RUN npm prune --production
29
-
30
- ### Runtime stage
31
- FROM node:20-alpine AS prod
32
- LABEL org.opencontainers.image.title="nodejs-poolController"
33
- LABEL org.opencontainers.image.description="Bridge Pentair / compatible pool automation equipment to modern interfaces (REST, WebSockets, MQTT, Influx, Rules)."
34
- LABEL org.opencontainers.image.licenses="AGPL-3.0-only"
35
- LABEL org.opencontainers.image.source="https://github.com/tagyoureit/nodejs-poolController"
36
- ENV NODE_ENV=production
37
-
38
- # Use existing 'node' user from base image; just ensure work directory exists
39
- WORKDIR /app
40
- RUN mkdir -p /app
41
- RUN mkdir -p /app/logs /app/data /app/backups /app/web/bindings/custom \
42
- && chown -R node:node /app/logs /app/data /app/backups /app/web/bindings /app/web/bindings/custom || true
43
-
44
- # Copy only the necessary runtime artifacts from build stage
45
- COPY --chown=node:node --from=build /app/package*.json ./
46
- COPY --chown=node:node --from=build /app/node_modules ./node_modules
47
- COPY --chown=node:node --from=build /app/dist ./dist
48
- COPY --chown=node:node --from=build /app/defaultConfig.json ./defaultConfig.json
49
- COPY --chown=node:node --from=build /app/config.json ./config.json
50
- COPY --chown=node:node --from=build /app/README.md ./README.md
51
- COPY --chown=node:node --from=build /app/LICENSE ./LICENSE
52
-
53
- USER node
54
-
55
- # Default HTTP / HTTPS (if enabled) ports from defaultConfig (http 4200, https 4201)
56
- EXPOSE 4200 4201
57
-
58
- # Basic healthcheck (container considered healthy if process responds to tcp socket open)
59
- HEALTHCHECK --interval=45s --timeout=6s --start-period=40s --retries=4 \
60
- CMD node -e "const n=require('net');const s=n.createConnection({host:'127.0.0.1',port:4200},()=>{s.end();process.exit(0)});s.on('error',()=>process.exit(1));setTimeout(()=>{s.destroy();process.exit(1)},5000);" || exit 1
61
-
62
- ENTRYPOINT ["node", "dist/app.js"]
1
+ ### Build stage
2
+ FROM node:20-alpine AS build
3
+ LABEL maintainer="nodejs-poolController"
4
+ LABEL org.opencontainers.image.title="nodejs-poolController"
5
+ LABEL org.opencontainers.image.description="Bridge Pentair / compatible pool automation equipment to modern interfaces (REST, WebSockets, MQTT, Influx, Rules)."
6
+ LABEL org.opencontainers.image.licenses="AGPL-3.0-only"
7
+ LABEL org.opencontainers.image.source="https://github.com/tagyoureit/nodejs-poolController"
8
+
9
+ # Install build toolchain only for native deps (serialport, etc.)
10
+ RUN apk add --no-cache make gcc g++ python3 linux-headers udev tzdata git
11
+
12
+ WORKDIR /app
13
+
14
+ # Leverage Docker layer caching: copy only manifests first
15
+ COPY package*.json ./
16
+ COPY defaultConfig.json config.json
17
+
18
+ # Install all deps (including dev) for build
19
+ RUN npm ci
20
+
21
+ # Copy source
22
+ COPY . .
23
+
24
+ # Build Typescript
25
+ RUN npm run build
26
+
27
+ # Remove dev dependencies while keeping a clean node_modules with prod deps only
28
+ RUN npm prune --production
29
+
30
+ ### Runtime stage
31
+ FROM node:20-alpine AS prod
32
+ LABEL org.opencontainers.image.title="nodejs-poolController"
33
+ LABEL org.opencontainers.image.description="Bridge Pentair / compatible pool automation equipment to modern interfaces (REST, WebSockets, MQTT, Influx, Rules)."
34
+ LABEL org.opencontainers.image.licenses="AGPL-3.0-only"
35
+ LABEL org.opencontainers.image.source="https://github.com/tagyoureit/nodejs-poolController"
36
+ ENV NODE_ENV=production
37
+
38
+ # Use existing 'node' user from base image; just ensure work directory exists
39
+ WORKDIR /app
40
+ RUN mkdir -p /app
41
+ RUN mkdir -p /app/logs /app/data /app/backups /app/web/bindings/custom \
42
+ && chown -R node:node /app/logs /app/data /app/backups /app/web/bindings /app/web/bindings/custom || true
43
+
44
+ # Copy only the necessary runtime artifacts from build stage
45
+ COPY --chown=node:node --from=build /app/package*.json ./
46
+ COPY --chown=node:node --from=build /app/node_modules ./node_modules
47
+ COPY --chown=node:node --from=build /app/dist ./dist
48
+ COPY --chown=node:node --from=build /app/defaultConfig.json ./defaultConfig.json
49
+ COPY --chown=node:node --from=build /app/config.json ./config.json
50
+ COPY --chown=node:node --from=build /app/README.md ./README.md
51
+ COPY --chown=node:node --from=build /app/LICENSE ./LICENSE
52
+
53
+ USER node
54
+
55
+ # Default HTTP / HTTPS (if enabled) ports from defaultConfig (http 4200, https 4201)
56
+ EXPOSE 4200 4201
57
+
58
+ # Basic healthcheck (container considered healthy if process responds to tcp socket open)
59
+ HEALTHCHECK --interval=45s --timeout=6s --start-period=40s --retries=4 \
60
+ CMD node -e "const n=require('net');const s=n.createConnection({host:'127.0.0.1',port:4200},()=>{s.end();process.exit(0)});s.on('error',()=>process.exit(1));setTimeout(()=>{s.destroy();process.exit(1)},5000);" || exit 1
61
+
62
+ ENTRYPOINT ["node", "dist/app.js"]
package/Gruntfile.js CHANGED
@@ -1,41 +1,41 @@
1
- module.exports = function(grunt) {
2
-
3
- grunt.initConfig({
4
- usebanner: {
5
- taskName: {
6
- options: {
7
- position: 'top',
8
- banner: `/* nodejs-poolController. An application to control pool equipment.
9
- Copyright (C) 2016, 2017. Russell Goldin, tagyoureit. russ.goldin@gmail.com
10
-
11
- This program is free software: you can redistribute it and/or modify
12
- it under the terms of the GNU Affero General Public License as
13
- published by the Free Software Foundation, either version 3 of the
14
- License, or (at your option) any later version.
15
-
16
- This program is distributed in the hope that it will be useful,
17
- but WITHOUT ANY WARRANTY; without even the implied warranty of
18
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19
- GNU Affero General Public License for more details.
20
-
21
- You should have received a copy of the GNU Affero General Public License
22
- along with this program. If not, see <http://www.gnu.org/licenses/>.
23
- */`,
24
- linebreak: true,
25
- replace: false
26
- },
27
- files: {
28
- src: [ 'config/*.ts', 'controller/**/*.ts', 'logger/*.ts', 'web/**/*.ts', 'app.ts' ]
29
- }
30
- }
31
- }
32
- })
33
-
34
- grunt.loadNpmTasks('grunt-banner');
35
-
36
- }
37
-
38
-
39
-
40
-
1
+ module.exports = function(grunt) {
2
+
3
+ grunt.initConfig({
4
+ usebanner: {
5
+ taskName: {
6
+ options: {
7
+ position: 'top',
8
+ banner: `/* nodejs-poolController. An application to control pool equipment.
9
+ Copyright (C) 2016, 2017. Russell Goldin, tagyoureit. russ.goldin@gmail.com
10
+
11
+ This program is free software: you can redistribute it and/or modify
12
+ it under the terms of the GNU Affero General Public License as
13
+ published by the Free Software Foundation, either version 3 of the
14
+ License, or (at your option) any later version.
15
+
16
+ This program is distributed in the hope that it will be useful,
17
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
18
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19
+ GNU Affero General Public License for more details.
20
+
21
+ You should have received a copy of the GNU Affero General Public License
22
+ along with this program. If not, see <http://www.gnu.org/licenses/>.
23
+ */`,
24
+ linebreak: true,
25
+ replace: false
26
+ },
27
+ files: {
28
+ src: [ 'config/*.ts', 'controller/**/*.ts', 'logger/*.ts', 'web/**/*.ts', 'app.ts' ]
29
+ }
30
+ }
31
+ }
32
+ })
33
+
34
+ grunt.loadNpmTasks('grunt-banner');
35
+
36
+ }
37
+
38
+
39
+
40
+
41
41