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
@@ -49,11 +49,16 @@ export class ChlorinatorMessage {
49
49
  chlor.isActive = msg.extractPayloadByte(i + 22) === 1;
50
50
  chlor.superChlorHours = msg.extractPayloadByte(i + 26);
51
51
  chlor.address = 80 + i;
52
+ // Set a default name if not already set (name comes from chlorinator's Action 3 response)
53
+ if (typeof chlor.name === 'undefined' || chlor.name === '') {
54
+ chlor.name = `Chlorinator ${chlorId}`;
55
+ }
52
56
  schlor.body = chlor.body;
53
57
  schlor.poolSetpoint = chlor.poolSetpoint;
54
58
  schlor.spaSetpoint = chlor.spaSetpoint;
55
59
  schlor.type = chlor.type;
56
60
  schlor.model = chlor.model;
61
+ schlor.name = chlor.name;
57
62
  schlor.isActive = chlor.isActive;
58
63
  schlor.superChlorHours = chlor.superChlorHours;
59
64
  state.emitEquipmentChanges();
@@ -46,6 +46,12 @@ export class ConfigMessage {
46
46
  public static process(msg: Inbound): void {
47
47
  switch (sys.controllerType) {
48
48
  case ControllerType.IntelliCenter:
49
+ // v3.004+ can return Action 30 with a zero-length payload for some (category,item) requests.
50
+ // These still unblock the config queue, but there is nothing to parse here.
51
+ if (msg.action === 30 && msg.payload.length === 0) {
52
+ msg.isProcessed = true;
53
+ return;
54
+ }
49
55
  switch (msg.extractPayloadByte(0)) {
50
56
  case 0:
51
57
  OptionsMessage.process(msg);
File without changes
@@ -1,32 +1,32 @@
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
- import { Inbound } from "../Messages";
19
- import { sys } from "../../../Equipment";
20
- export class CustomNameMessage
21
- {
22
- public static process ( msg: Inbound ): void
23
- {
24
- let customNameId = msg.extractPayloadByte( 0 );
25
- let customName = sys.customNames.getItemById( customNameId, customNameId <= sys.equipment.maxCustomNames );
26
- customName.name = msg.extractPayloadString( 1, 11 );
27
- // customName.isActive = customNameId <= sys.equipment.maxCustomNames && !customName.name.includes('USERNAME-')
28
- if (customNameId >= sys.equipment.maxCustomNames) sys.equipment.maxCustomNames = customNameId + 1;
29
- sys.board.system.syncCustomNamesValueMap();
30
- msg.isProcessed = true;
31
- }
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
+ import { Inbound } from "../Messages";
19
+ import { sys } from "../../../Equipment";
20
+ export class CustomNameMessage
21
+ {
22
+ public static process ( msg: Inbound ): void
23
+ {
24
+ let customNameId = msg.extractPayloadByte( 0 );
25
+ let customName = sys.customNames.getItemById( customNameId, customNameId <= sys.equipment.maxCustomNames );
26
+ customName.name = msg.extractPayloadString( 1, 11 );
27
+ // customName.isActive = customNameId <= sys.equipment.maxCustomNames && !customName.name.includes('USERNAME-')
28
+ if (customNameId >= sys.equipment.maxCustomNames) sys.equipment.maxCustomNames = customNameId + 1;
29
+ sys.board.system.syncCustomNamesValueMap();
30
+ msg.isProcessed = true;
31
+ }
32
32
  }
@@ -1,210 +1,250 @@
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
- import { Inbound } from '../Messages';
19
- import { sys, Equipment, ExpansionPanel, Body } from '../../../Equipment';
20
- import { state, BodyTempState } from '../../../State';
21
- import { ControllerType } from '../../../Constants';
22
- import { logger } from "../../../../logger/Logger";
23
- export class EquipmentMessage {
24
- public static process(msg: Inbound): void {
25
- let pnl: ExpansionPanel;
26
- let bodyId: number;
27
- let body: Body;
28
- let sbody: BodyTempState;
29
- switch (sys.controllerType) {
30
- case ControllerType.IntelliCenter:
31
- switch (msg.extractPayloadByte(1)) {
32
- case 0:
33
- sys.equipment.name = msg.extractPayloadString(2, 16);
34
- sys.equipment.type = msg.extractPayloadByte(35);
35
- pnl = sys.equipment.expansions.getItemById(1, true);
36
- pnl.type = msg.extractPayloadByte(36);
37
- pnl.name = msg.extractPayloadString(18, 16);
38
- pnl.isActive = false; //pnl.type !== 0 && pnl.type !== 255; RKS: We will have to see what a system looks like with an expansion panel installed.
39
- // A system withouth any expansion panels installed has been shown to have a 1 in byte(38) i10PS.
40
- pnl = sys.equipment.expansions.getItemById(2, true);
41
- pnl.type = msg.extractPayloadByte(37);
42
- pnl.isActive = false; //pnl.type !== 0 && pnl.type !== 255;
43
- pnl = sys.equipment.expansions.getItemById(3, true);
44
- pnl.type = msg.extractPayloadByte(38);
45
- pnl.isActive = false; //pnl.type !== 0 && pnl.type !== 255;
46
- body = sys.bodies.getItemById(1, sys.equipment.maxBodies >= 1);
47
- sbody = state.temps.bodies.getItemById(1, sys.equipment.maxBodies >= 1);
48
- sbody.type = body.type = msg.extractPayloadByte(39);
49
- body.capacity = msg.extractPayloadByte(34) * 1000;
50
- if (body.isActive && sys.equipment.maxBodies === 0) sys.bodies.removeItemById(1);
51
- body.isActive = sys.equipment.maxBodies > 0;
52
- msg.isProcessed = true;
53
- break;
54
- case 1:
55
- pnl = sys.equipment.expansions.getItemById(2);
56
- pnl.name = msg.extractPayloadString(2, 16);
57
- bodyId = 2;
58
- if (sys.equipment.maxBodies >= bodyId) {
59
- body = sys.bodies.getItemById(bodyId, true);
60
- sbody = state.temps.bodies.getItemById(bodyId, true);
61
- sbody.type = body.type = msg.extractPayloadByte(35);
62
- body.capacity = msg.extractPayloadByte(34) * 1000;
63
- body.isActive = true;
64
- }
65
- else {
66
- sys.bodies.removeItemById(bodyId);
67
- state.temps.bodies.removeItemById(bodyId);
68
- }
69
- pnl = sys.equipment.expansions.getItemById(3);
70
- pnl.name = msg.extractPayloadString(18, 16);
71
- msg.isProcessed = true;
72
- break;
73
- case 2:
74
- // The first name is the first body in this packet and the second is the third. Go figure.
75
- bodyId = 1;
76
- body = sys.bodies.getItemById(bodyId, bodyId <= sys.equipment.maxBodies);
77
- sbody = state.temps.bodies.getItemById(bodyId, bodyId <= sys.equipment.maxBodies);
78
- sbody.name = body.name = msg.extractPayloadString(2, 16);
79
- bodyId = 3;
80
- if (sys.equipment.maxBodies >= bodyId) {
81
- body = sys.bodies.getItemById(bodyId, bodyId <= sys.equipment.maxBodies);
82
- sbody = state.temps.bodies.getItemById(bodyId, bodyId <= sys.equipment.maxBodies);
83
- sbody.type = body.type = msg.extractPayloadByte(35);
84
- body.capacity = msg.extractPayloadByte(34) * 1000;
85
- body.isActive = bodyId <= sys.equipment.maxBodies;
86
- sbody.name = body.name = msg.extractPayloadString(18, 16);
87
- body.isActive = bodyId <= sys.equipment.maxBodies;
88
- }
89
- else {
90
- sys.bodies.removeItemById(bodyId);
91
- state.temps.bodies.removeItemById(bodyId);
92
- }
93
- msg.isProcessed = true;
94
- break;
95
- case 3:
96
- // The first name is the second body and the 2nd is the 4th. This packet also contains
97
- // any additional information related to bodies 3 & 4 that were not previously included.
98
- bodyId = 2;
99
- if (sys.equipment.maxBodies >= bodyId) {
100
- body = sys.bodies.getItemById(bodyId, bodyId <= sys.equipment.maxBodies);
101
- sbody = state.temps.bodies.getItemById(bodyId, bodyId <= sys.equipment.maxBodies);
102
- sbody.name = body.name = msg.extractPayloadString(2, 16);
103
- }
104
- else {
105
- sys.bodies.removeItemById(bodyId);
106
- state.temps.bodies.removeItemById(bodyId);
107
- }
108
- bodyId = 4;
109
- if (sys.equipment.maxBodies >= bodyId) {
110
- body = sys.bodies.getItemById(bodyId, bodyId <= sys.equipment.maxBodies);
111
- sbody = state.temps.bodies.getItemById(bodyId, bodyId <= sys.equipment.maxBodies);
112
- sbody.name = body.name = msg.extractPayloadString(18, 16);
113
- sbody.type = body.type = msg.extractPayloadByte(37);
114
- body.capacity = msg.extractPayloadByte(36) * 1000;
115
- if (body.isActive && bodyId > sys.equipment.maxBodies) sys.bodies.removeItemById(bodyId);
116
- body.isActive = bodyId <= sys.equipment.maxBodies;
117
- }
118
- else {
119
- sys.bodies.removeItemById(bodyId);
120
- state.temps.bodies.removeItemById(bodyId);
121
- }
122
- bodyId = 3;
123
- if (sys.equipment.maxBodies >= bodyId) {
124
- body = sys.bodies.getItemById(bodyId, bodyId <= sys.equipment.maxBodies);
125
- sbody = state.temps.bodies.getItemById(bodyId, bodyId <= sys.equipment.maxBodies);
126
- sbody.type = body.type = msg.extractPayloadByte(35);
127
- body.capacity = msg.extractPayloadByte(34) * 1000;
128
- if (body.isActive && bodyId > sys.equipment.maxBodies) sys.bodies.removeItemById(bodyId);
129
- body.isActive = bodyId <= sys.equipment.maxBodies;
130
- }
131
- else {
132
- sys.bodies.removeItemById(bodyId);
133
- state.temps.bodies.removeItemById(bodyId);
134
- }
135
- state.equipment.single = sys.equipment.single = sys.equipment.shared == false && sys.equipment.dual === false;
136
- state.equipment.shared = sys.equipment.shared;
137
- state.equipment.dual = sys.equipment.dual;
138
- state.equipment.model = sys.equipment.model;
139
- state.equipment.controllerType = sys.controllerType;
140
- state.equipment.maxBodies = sys.equipment.maxBodies;
141
- state.equipment.maxCircuits = sys.equipment.maxCircuits;
142
- state.equipment.maxValves = sys.equipment.maxValves;
143
- state.equipment.maxSchedules = sys.equipment.maxSchedules;
144
- state.equipment.maxPumps = sys.equipment.maxPumps;
145
- msg.isProcessed = true;
146
- break;
147
- default:
148
- logger.debug(`Unprocessed Config Message ${msg.toPacket()}`)
149
- break;
150
- }
151
- break;
152
- case ControllerType.IntelliCom:
153
- case ControllerType.EasyTouch:
154
- case ControllerType.IntelliTouch:
155
- case ControllerType.SunTouch:
156
- switch (msg.action) {
157
- case 252:
158
- EquipmentMessage.processSoftwareVersion(msg);
159
- break;
160
- }
161
- break;
162
- }
163
- }
164
- private static processSoftwareVersion(msg: Inbound) {
165
- // sample packet
166
- // [165,33,15,16,252,17],0,{2,90},0,0,{1,10},0,0,0,0,0,0,0,0,0,0],[2,89]
167
- sys.equipment.bootloaderVersion = `${msg.extractPayloadByte(5)}.${msg.extractPayloadByte(6) < 100 ? '0' + msg.extractPayloadByte(6) : msg.extractPayloadByte(6)}`;
168
- sys.equipment.controllerFirmware = `${msg.extractPayloadByte(1)}.${msg.extractPayloadByte(2) < 100 ? '0' + msg.extractPayloadByte(2) : msg.extractPayloadByte(2)}`;
169
- }
170
- //private static calcModel(eq: Equipment) {
171
- // eq.shared = (eq.type & 8) === 8;
172
- // eq.maxPumps = 16;
173
- // eq.maxLightGroups = 40;
174
- // eq.maxCircuitGroups = 16;
175
- // eq.maxValves = EquipmentMessage.calcMaxValves(eq);
176
- // eq.maxCircuits = EquipmentMessage.calcMaxCircuits(eq);
177
- // eq.maxBodies = EquipmentMessage.calcMaxBodies(eq);
178
- // eq.model = 'IntelliCenter i' + (eq.maxCircuits + (eq.shared ? -1 : 0)).toString() + 'P' + (eq.shared ? 'S' : '');
179
- //}
180
- //private static calcMaxBodies(eq: Equipment): number {
181
- // let max: number = eq.shared ? 2 : 1;
182
- // for (let i = 0; i < eq.expansions.length; i++) {
183
- // const exp: ExpansionPanel = eq.expansions.getItemById(i + 1);
184
- // if (exp.type === 0) continue;
185
- // max += (exp.type & 8) === 8 ? 2 : 1;
186
- // }
187
- // return max;
188
- //}
189
- //private static calcMaxValves(eq: Equipment): number {
190
- // let max: number = 4;
191
- // max += (eq.type & 1) === 1 ? 6 : 0;
192
- // for (let i = 0; i < eq.expansions.length; i++) {
193
- // const exp: ExpansionPanel = eq.expansions.getItemById(i + 1);
194
- // max += (exp.type & 1) === 1 ? 6 : 0;
195
- // }
196
- // return max;
197
- //}
198
- //private static calcMaxCircuits(eq: Equipment): number {
199
- // let max: number = 6;
200
- // max += (eq.type & 2) === 2 ? 2 : 0;
201
- // max += (eq.type & 4) === 4 ? 2 : 0;
202
- // max += eq.shared ? 1 : 0;
203
- // for (let i = 0; i < eq.expansions.length; i++) {
204
- // const exp: ExpansionPanel = eq.expansions.getItemById(i + 1);
205
- // max += (exp.type & 2) === 2 ? 5 : 0;
206
- // max += (exp.type & 4) === 2 ? 5 : 0;
207
- // }
208
- // return max;
209
- //}
210
- }
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
+ import { Inbound } from '../Messages';
19
+ import { sys, Equipment, ExpansionPanel, Body } from '../../../Equipment';
20
+ import { state, BodyTempState } from '../../../State';
21
+ import { ControllerType } from '../../../Constants';
22
+ import { logger } from "../../../../logger/Logger";
23
+ export class EquipmentMessage {
24
+ public static process(msg: Inbound): void {
25
+ let pnl: ExpansionPanel;
26
+ let bodyId: number;
27
+ let body: Body;
28
+ let sbody: BodyTempState;
29
+ switch (sys.controllerType) {
30
+ case ControllerType.IntelliCenter:
31
+ switch (msg.extractPayloadByte(1)) {
32
+ case 0:
33
+ sys.equipment.name = msg.extractPayloadString(2, 16);
34
+ sys.equipment.type = msg.extractPayloadByte(35);
35
+ pnl = sys.equipment.expansions.getItemById(1, true);
36
+ pnl.type = msg.extractPayloadByte(36);
37
+ pnl.name = msg.extractPayloadString(18, 16);
38
+ pnl.isActive = false; //pnl.type !== 0 && pnl.type !== 255; RKS: We will have to see what a system looks like with an expansion panel installed.
39
+ // A system withouth any expansion panels installed has been shown to have a 1 in byte(38) i10PS.
40
+ pnl = sys.equipment.expansions.getItemById(2, true);
41
+ pnl.type = msg.extractPayloadByte(37);
42
+ pnl.isActive = false; //pnl.type !== 0 && pnl.type !== 255;
43
+ pnl = sys.equipment.expansions.getItemById(3, true);
44
+ pnl.type = msg.extractPayloadByte(38);
45
+ pnl.isActive = false; //pnl.type !== 0 && pnl.type !== 255;
46
+ body = sys.bodies.getItemById(1, sys.equipment.maxBodies >= 1);
47
+ sbody = state.temps.bodies.getItemById(1, sys.equipment.maxBodies >= 1);
48
+ sbody.type = body.type = msg.extractPayloadByte(39);
49
+ body.capacity = msg.extractPayloadByte(34) * 1000;
50
+ if (body.isActive && sys.equipment.maxBodies === 0) sys.bodies.removeItemById(1);
51
+ body.isActive = sys.equipment.maxBodies > 0;
52
+ msg.isProcessed = true;
53
+ break;
54
+ case 1:
55
+ pnl = sys.equipment.expansions.getItemById(2);
56
+ pnl.name = msg.extractPayloadString(2, 16);
57
+ bodyId = 2;
58
+ if (sys.equipment.maxBodies >= bodyId) {
59
+ body = sys.bodies.getItemById(bodyId, true);
60
+ sbody = state.temps.bodies.getItemById(bodyId, true);
61
+ sbody.type = body.type = msg.extractPayloadByte(35);
62
+ body.capacity = msg.extractPayloadByte(34) * 1000;
63
+ body.isActive = true;
64
+ }
65
+ else {
66
+ sys.bodies.removeItemById(bodyId);
67
+ state.temps.bodies.removeItemById(bodyId);
68
+ }
69
+ pnl = sys.equipment.expansions.getItemById(3);
70
+ pnl.name = msg.extractPayloadString(18, 16);
71
+ msg.isProcessed = true;
72
+ break;
73
+ case 2:
74
+ // The first name is the first body in this packet and the second is the third. Go figure.
75
+ bodyId = 1;
76
+ body = sys.bodies.getItemById(bodyId, bodyId <= sys.equipment.maxBodies);
77
+ sbody = state.temps.bodies.getItemById(bodyId, bodyId <= sys.equipment.maxBodies);
78
+ sbody.name = body.name = msg.extractPayloadString(2, 16);
79
+ // IntelliCenter shared-body systems (e.g. i10PS) have Pool+Spa (Body1+Body2). In those systems,
80
+ // the second string in this packet is Body2 (Spa). Non-shared multi-body systems keep the legacy mapping.
81
+ const secondBodyId = (sys.equipment.shared === true && sys.equipment.dual !== true) ? 2 : 3;
82
+ if (sys.equipment.maxBodies >= secondBodyId) {
83
+ body = sys.bodies.getItemById(secondBodyId, secondBodyId <= sys.equipment.maxBodies);
84
+ sbody = state.temps.bodies.getItemById(secondBodyId, secondBodyId <= sys.equipment.maxBodies);
85
+ // Only body3+ packets include type/capacity bytes here; avoid corrupting 2-body systems.
86
+ if (secondBodyId >= 3) {
87
+ sbody.type = body.type = msg.extractPayloadByte(35);
88
+ body.capacity = msg.extractPayloadByte(34) * 1000;
89
+ }
90
+ body.isActive = secondBodyId <= sys.equipment.maxBodies;
91
+ sbody.name = body.name = msg.extractPayloadString(18, 16);
92
+ } else {
93
+ sys.bodies.removeItemById(secondBodyId);
94
+ state.temps.bodies.removeItemById(secondBodyId);
95
+ }
96
+ msg.isProcessed = true;
97
+ break;
98
+ case 3:
99
+ // The first name is the second body and the 2nd is the 4th. This packet also contains
100
+ // any additional information related to bodies 3 & 4 that were not previously included.
101
+ bodyId = 2;
102
+ if (sys.equipment.maxBodies >= bodyId) {
103
+ body = sys.bodies.getItemById(bodyId, bodyId <= sys.equipment.maxBodies);
104
+ sbody = state.temps.bodies.getItemById(bodyId, bodyId <= sys.equipment.maxBodies);
105
+ // On shared-body IntelliCenter (Pool+Spa), the Spa name is often in the SECOND string (offset 18),
106
+ // while the first string (offset 2) repeats Pool.
107
+ const nameOffset = (sys.equipment.shared === true && sys.equipment.dual !== true) ? 18 : 2;
108
+ sbody.name = body.name = msg.extractPayloadString(nameOffset, 16);
109
+ }
110
+ else {
111
+ sys.bodies.removeItemById(bodyId);
112
+ state.temps.bodies.removeItemById(bodyId);
113
+ }
114
+ bodyId = 4;
115
+ if (sys.equipment.maxBodies >= bodyId) {
116
+ body = sys.bodies.getItemById(bodyId, bodyId <= sys.equipment.maxBodies);
117
+ sbody = state.temps.bodies.getItemById(bodyId, bodyId <= sys.equipment.maxBodies);
118
+ sbody.name = body.name = msg.extractPayloadString(18, 16);
119
+ sbody.type = body.type = msg.extractPayloadByte(37);
120
+ body.capacity = msg.extractPayloadByte(36) * 1000;
121
+ if (body.isActive && bodyId > sys.equipment.maxBodies) sys.bodies.removeItemById(bodyId);
122
+ body.isActive = bodyId <= sys.equipment.maxBodies;
123
+ }
124
+ else {
125
+ sys.bodies.removeItemById(bodyId);
126
+ state.temps.bodies.removeItemById(bodyId);
127
+ }
128
+ bodyId = 3;
129
+ if (sys.equipment.maxBodies >= bodyId) {
130
+ body = sys.bodies.getItemById(bodyId, bodyId <= sys.equipment.maxBodies);
131
+ sbody = state.temps.bodies.getItemById(bodyId, bodyId <= sys.equipment.maxBodies);
132
+ sbody.type = body.type = msg.extractPayloadByte(35);
133
+ body.capacity = msg.extractPayloadByte(34) * 1000;
134
+ if (body.isActive && bodyId > sys.equipment.maxBodies) sys.bodies.removeItemById(bodyId);
135
+ body.isActive = bodyId <= sys.equipment.maxBodies;
136
+ }
137
+ else {
138
+ sys.bodies.removeItemById(bodyId);
139
+ state.temps.bodies.removeItemById(bodyId);
140
+ }
141
+ state.equipment.single = sys.equipment.single = sys.equipment.shared == false && sys.equipment.dual === false;
142
+ state.equipment.shared = sys.equipment.shared;
143
+ state.equipment.dual = sys.equipment.dual;
144
+ state.equipment.model = sys.equipment.model;
145
+ state.equipment.controllerType = sys.controllerType;
146
+ state.equipment.maxBodies = sys.equipment.maxBodies;
147
+ state.equipment.maxCircuits = sys.equipment.maxCircuits;
148
+ state.equipment.maxValves = sys.equipment.maxValves;
149
+ state.equipment.maxSchedules = sys.equipment.maxSchedules;
150
+ state.equipment.maxPumps = sys.equipment.maxPumps;
151
+ msg.isProcessed = true;
152
+ break;
153
+ case 12:
154
+ case 13:
155
+ case 14:
156
+ case 15: {
157
+ const selector = msg.extractPayloadByte(1);
158
+ const raw = EquipmentMessage.extractAlertRaw(msg);
159
+ sys.alerts.setRaw(selector, raw);
160
+ switch (selector) {
161
+ case 12:
162
+ sys.alerts.circuitNotifications = raw.length > 0 ? raw[0] : 0;
163
+ break;
164
+ case 13:
165
+ sys.alerts.pumpNotifications = EquipmentMessage.extractAlertMask(raw);
166
+ break;
167
+ case 14:
168
+ sys.alerts.heaterNotifications = EquipmentMessage.extractAlertMask(raw);
169
+ break;
170
+ case 15:
171
+ sys.alerts.chlorinatorNotifications = EquipmentMessage.extractAlertMask(raw);
172
+ break;
173
+ }
174
+ msg.isProcessed = true;
175
+ break;
176
+ }
177
+ default:
178
+ logger.debug(`Unprocessed Config Message ${msg.toPacket()}`)
179
+ break;
180
+ }
181
+ break;
182
+ case ControllerType.IntelliCom:
183
+ case ControllerType.EasyTouch:
184
+ case ControllerType.IntelliTouch:
185
+ case ControllerType.SunTouch:
186
+ switch (msg.action) {
187
+ case 252:
188
+ EquipmentMessage.processSoftwareVersion(msg);
189
+ break;
190
+ }
191
+ break;
192
+ }
193
+ }
194
+ private static processSoftwareVersion(msg: Inbound) {
195
+ // sample packet
196
+ // [165,33,15,16,252,17],0,{2,90},0,0,{1,10},0,0,0,0,0,0,0,0,0,0],[2,89]
197
+ sys.equipment.bootloaderVersion = `${msg.extractPayloadByte(5)}.${msg.extractPayloadByte(6) < 100 ? '0' + msg.extractPayloadByte(6) : msg.extractPayloadByte(6)}`;
198
+ sys.equipment.controllerFirmware = `${msg.extractPayloadByte(1)}.${msg.extractPayloadByte(2) < 100 ? '0' + msg.extractPayloadByte(2) : msg.extractPayloadByte(2)}`;
199
+ }
200
+ private static extractAlertRaw(msg: Inbound): number[] {
201
+ const raw: number[] = [];
202
+ for (let i = 2; i < msg.payload.length; i++) raw.push(msg.extractPayloadByte(i, 0));
203
+ return raw;
204
+ }
205
+ private static extractAlertMask(raw: number[]): number {
206
+ if (raw.length === 0) return 0;
207
+ if (raw.length === 1) return raw[0] & 0xFF;
208
+ return ((raw[raw.length - 2] & 0xFF) << 8) | (raw[raw.length - 1] & 0xFF);
209
+ }
210
+ //private static calcModel(eq: Equipment) {
211
+ // eq.shared = (eq.type & 8) === 8;
212
+ // eq.maxPumps = 16;
213
+ // eq.maxLightGroups = 40;
214
+ // eq.maxCircuitGroups = 16;
215
+ // eq.maxValves = EquipmentMessage.calcMaxValves(eq);
216
+ // eq.maxCircuits = EquipmentMessage.calcMaxCircuits(eq);
217
+ // eq.maxBodies = EquipmentMessage.calcMaxBodies(eq);
218
+ // eq.model = 'IntelliCenter i' + (eq.maxCircuits + (eq.shared ? -1 : 0)).toString() + 'P' + (eq.shared ? 'S' : '');
219
+ //}
220
+ //private static calcMaxBodies(eq: Equipment): number {
221
+ // let max: number = eq.shared ? 2 : 1;
222
+ // for (let i = 0; i < eq.expansions.length; i++) {
223
+ // const exp: ExpansionPanel = eq.expansions.getItemById(i + 1);
224
+ // if (exp.type === 0) continue;
225
+ // max += (exp.type & 8) === 8 ? 2 : 1;
226
+ // }
227
+ // return max;
228
+ //}
229
+ //private static calcMaxValves(eq: Equipment): number {
230
+ // let max: number = 4;
231
+ // max += (eq.type & 1) === 1 ? 6 : 0;
232
+ // for (let i = 0; i < eq.expansions.length; i++) {
233
+ // const exp: ExpansionPanel = eq.expansions.getItemById(i + 1);
234
+ // max += (exp.type & 1) === 1 ? 6 : 0;
235
+ // }
236
+ // return max;
237
+ //}
238
+ //private static calcMaxCircuits(eq: Equipment): number {
239
+ // let max: number = 6;
240
+ // max += (eq.type & 2) === 2 ? 2 : 0;
241
+ // max += (eq.type & 4) === 4 ? 2 : 0;
242
+ // max += eq.shared ? 1 : 0;
243
+ // for (let i = 0; i < eq.expansions.length; i++) {
244
+ // const exp: ExpansionPanel = eq.expansions.getItemById(i + 1);
245
+ // max += (exp.type & 2) === 2 ? 5 : 0;
246
+ // max += (exp.type & 4) === 2 ? 5 : 0;
247
+ // }
248
+ // return max;
249
+ //}
250
+ }