nodejs-poolcontroller 7.6.0 → 7.6.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 (85) hide show
  1. package/.eslintrc.json +44 -44
  2. package/.github/ISSUE_TEMPLATE/bug_report.md +52 -52
  3. package/CONTRIBUTING.md +74 -74
  4. package/Changelog +215 -215
  5. package/Dockerfile +17 -17
  6. package/Gruntfile.js +40 -40
  7. package/LICENSE +661 -661
  8. package/README.md +191 -186
  9. package/app.ts +0 -0
  10. package/config/Config.ts +24 -2
  11. package/config/VersionCheck.ts +27 -12
  12. package/config copy.json +299 -299
  13. package/controller/Constants.ts +0 -0
  14. package/controller/Equipment.ts +2459 -2405
  15. package/controller/Errors.ts +180 -180
  16. package/controller/Lockouts.ts +436 -422
  17. package/controller/State.ts +51 -26
  18. package/controller/boards/BoardFactory.ts +45 -45
  19. package/controller/boards/EasyTouchBoard.ts +2653 -2537
  20. package/controller/boards/IntelliCenterBoard.ts +4230 -4034
  21. package/controller/boards/IntelliComBoard.ts +63 -63
  22. package/controller/boards/IntelliTouchBoard.ts +241 -241
  23. package/controller/boards/NixieBoard.ts +1675 -1660
  24. package/controller/boards/SystemBoard.ts +4697 -4463
  25. package/controller/comms/Comms.ts +138 -1
  26. package/controller/comms/messages/Messages.ts +3 -5
  27. package/controller/comms/messages/config/ChlorinatorMessage.ts +1 -1
  28. package/controller/comms/messages/config/CircuitGroupMessage.ts +0 -0
  29. package/controller/comms/messages/config/CircuitMessage.ts +0 -0
  30. package/controller/comms/messages/config/ConfigMessage.ts +0 -0
  31. package/controller/comms/messages/config/CoverMessage.ts +0 -0
  32. package/controller/comms/messages/config/CustomNameMessage.ts +30 -30
  33. package/controller/comms/messages/config/EquipmentMessage.ts +0 -0
  34. package/controller/comms/messages/config/ExternalMessage.ts +9 -7
  35. package/controller/comms/messages/config/FeatureMessage.ts +0 -0
  36. package/controller/comms/messages/config/GeneralMessage.ts +0 -0
  37. package/controller/comms/messages/config/HeaterMessage.ts +0 -20
  38. package/controller/comms/messages/config/IntellichemMessage.ts +0 -0
  39. package/controller/comms/messages/config/OptionsMessage.ts +25 -1
  40. package/controller/comms/messages/config/PumpMessage.ts +0 -0
  41. package/controller/comms/messages/config/RemoteMessage.ts +0 -0
  42. package/controller/comms/messages/config/ScheduleMessage.ts +347 -342
  43. package/controller/comms/messages/config/SecurityMessage.ts +0 -0
  44. package/controller/comms/messages/config/ValveMessage.ts +0 -0
  45. package/controller/comms/messages/status/ChlorinatorStateMessage.ts +0 -0
  46. package/controller/comms/messages/status/EquipmentStateMessage.ts +1 -1
  47. package/controller/comms/messages/status/HeaterStateMessage.ts +86 -86
  48. package/controller/comms/messages/status/IntelliChemStateMessage.ts +445 -397
  49. package/controller/comms/messages/status/IntelliValveStateMessage.ts +35 -35
  50. package/controller/comms/messages/status/PumpStateMessage.ts +0 -0
  51. package/controller/comms/messages/status/VersionMessage.ts +0 -0
  52. package/controller/nixie/Nixie.ts +162 -162
  53. package/controller/nixie/NixieEquipment.ts +103 -103
  54. package/controller/nixie/bodies/Body.ts +120 -120
  55. package/controller/nixie/bodies/Filter.ts +135 -135
  56. package/controller/nixie/chemistry/ChemController.ts +2498 -2398
  57. package/controller/nixie/chemistry/Chlorinator.ts +314 -314
  58. package/controller/nixie/circuits/Circuit.ts +248 -245
  59. package/controller/nixie/heaters/Heater.ts +648 -600
  60. package/controller/nixie/pumps/Pump.ts +661 -661
  61. package/controller/nixie/schedules/Schedule.ts +257 -257
  62. package/controller/nixie/valves/Valve.ts +170 -170
  63. package/defaultConfig.json +286 -286
  64. package/issue_template.md +51 -51
  65. package/logger/DataLogger.ts +448 -448
  66. package/logger/Logger.ts +0 -0
  67. package/package.json +56 -56
  68. package/tsconfig.json +25 -25
  69. package/web/Server.ts +2 -2
  70. package/web/bindings/influxDB.json +1021 -981
  71. package/web/bindings/mqtt.json +654 -654
  72. package/web/bindings/mqttAlt.json +684 -684
  73. package/web/bindings/rulesManager.json +54 -54
  74. package/web/bindings/smartThings-Hubitat.json +31 -31
  75. package/web/bindings/valveRelays.json +20 -20
  76. package/web/bindings/vera.json +25 -25
  77. package/web/interfaces/baseInterface.ts +136 -136
  78. package/web/interfaces/httpInterface.ts +124 -124
  79. package/web/interfaces/influxInterface.ts +245 -241
  80. package/web/interfaces/mqttInterface.ts +475 -475
  81. package/web/services/config/Config.ts +10 -108
  82. package/web/services/config/ConfigSocket.ts +0 -0
  83. package/web/services/state/State.ts +71 -4
  84. package/web/services/state/StateSocket.ts +0 -0
  85. package/web/services/utilities/Utilities.ts +42 -42
@@ -1,342 +1,347 @@
1
- /* nodejs-poolController. An application to control pool equipment.
2
- Copyright (C) 2016, 2017, 2018, 2019, 2020. Russell Goldin, tagyoureit. russ.goldin@gmail.com
3
-
4
- This program is free software: you can redistribute it and/or modify
5
- it under the terms of the GNU Affero General Public License as
6
- published by the Free Software Foundation, either version 3 of the
7
- License, or (at your option) any later version.
8
-
9
- This program is distributed in the hope that it will be useful,
10
- but WITHOUT ANY WARRANTY; without even the implied warranty of
11
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12
- GNU Affero General Public License for more details.
13
-
14
- You should have received a copy of the GNU Affero General Public License
15
- along with this program. If not, see <http://www.gnu.org/licenses/>.
16
- */
17
- import { Inbound } from "../Messages";
18
- import { sys, Schedule, EggTimer } from "../../../Equipment";
19
- import { state } from "../../../State";
20
- import { ControllerType } from "../../../Constants";
21
- import { logger } from "../../../../logger/Logger";
22
- export class ScheduleMessage {
23
- // [165, 63, 15, 16, 30, 42][3, 28, 5, 32, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0][1, 143]
24
- //
25
-
26
- // [165, 63, 15, 16, 164, 48][0, 0, 0, 0, 0, 0, 39, 159, 117, 122, 137, 64, 92, 201, 126, 201, 79, 248, 39, 141, 2, 96, 20, 108, 123, 22, 56, 30, 8, 21, 49, 147, 22, 64, 24, 141, 4, 29, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0][12, 130]
27
- // [165, 63, 15, 16, 164, 48][0, 0, 0, 0, 0, 0, 39, 159, 117, 122, 137, 64, 92, 228, 126, 201, 79, 248, 39, 141, 2, 96, 20, 108, 123, 22, 56, 30, 8, 21, 49, 147, 22, 64, 24, 141, 4, 29, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0][12, 157]
28
-
29
- // Change heat source #1
30
- // [165, 63, 15, 16, 30, 42][3, 28, 32, 32, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0][1, 170]
31
- // [165, 63, 15, 16, 30, 42][3, 28, 5, 32, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0][1, 143]
32
-
33
- // Run once
34
- // [165, 63, 15, 16, 30, 42][3, 8, 128, 128, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0][2, 86]
35
- // [165, 63, 15, 16, 30, 42][3, 8, 129, 128, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0][2, 87]
36
- public static _maxSchedId: number = 0;
37
- public static process(msg: Inbound): void {
38
- if (sys.controllerType === ControllerType.IntelliCenter)
39
- switch (msg.extractPayloadByte(1)) {
40
- case 0:
41
- case 1:
42
- case 2:
43
- case 3:
44
- case 4:
45
- ScheduleMessage.processStartTimes(msg);
46
- break;
47
- case 5:
48
- case 6:
49
- ScheduleMessage.processCircuit(msg);
50
- break;
51
- case 8: // Run Once Flags
52
- case 9:
53
- case 10:
54
- ScheduleMessage.processRunOnce(msg);
55
- break;
56
- case 11:
57
- case 12:
58
- case 13:
59
- ScheduleMessage.processDays(msg);
60
- break;
61
- case 14: // Start Month
62
- case 15:
63
- case 16:
64
- ScheduleMessage.processStartMonth(msg);
65
- break;
66
- case 17: // Start Day
67
- case 18:
68
- case 19:
69
- ScheduleMessage.processStartDay(msg);
70
- break;
71
- case 20: // Start Year
72
- case 21:
73
- case 22:
74
- ScheduleMessage.processStartYear(msg);
75
- break;
76
- case 23:
77
- case 24:
78
- case 25:
79
- case 26:
80
- case 27:
81
- ScheduleMessage.processEndTimes(msg);
82
- break;
83
- case 28: // Heat Source
84
- case 29:
85
- case 30:
86
- ScheduleMessage.processHeatSource(msg);
87
- break;
88
- case 31: // Heat Setpoint
89
- case 32:
90
- case 33:
91
- ScheduleMessage.processHeatSetpoint(msg);
92
- break;
93
- case 34: // Cool Setpoint
94
- case 35:
95
- case 36:
96
- ScheduleMessage.processCoolSetpoint(msg);
97
- break;
98
- default:
99
- logger.debug(`Unprocessed Config Message ${msg.toPacket()}`)
100
- break;
101
-
102
- }
103
- else if (sys.controllerType !== ControllerType.Unknown)
104
- ScheduleMessage.processScheduleDetails(msg);
105
- }
106
- public static processScheduleDetails(msg: Inbound) {
107
- // Sample packet
108
- // [165,33,15,16,17,7][6,12,25,0,6,30,0][1,76]
109
- const schedId = msg.extractPayloadByte(0);
110
- const circuitId = msg.extractPayloadByte(1) & 127;
111
- const eggTimerRunTime = msg.extractPayloadByte(4) * 60 + msg.extractPayloadByte(5);
112
- const eggTimerActive = msg.extractPayloadByte(2) === 25 && circuitId > 0 && eggTimerRunTime !== 256;
113
- const scheduleActive = !eggTimerActive && circuitId > 0;
114
- if (eggTimerActive) {
115
- // egg timer
116
- const eggTimer: EggTimer = sys.eggTimers.getItemById(schedId, true);
117
- eggTimer.circuit = circuitId;
118
- eggTimer.runTime = eggTimerRunTime;
119
- eggTimer.isActive = eggTimerActive;
120
- const circuit = sys.circuits.getInterfaceById(circuitId);
121
- circuit.eggTimer = eggTimer.runTime;
122
- circuit.eggTimer === 720;
123
- circuit.dontStop = circuit.eggTimer === 1620;
124
- // When eggTimers are found go back and check existing schedules to see if a runOnce schedule already exists.
125
- // It is possible that the runOnce schedule will be discovered before the eggTimer so we need to adjust the endTime
126
- for (let i = 0; i < sys.schedules.length; i++){
127
- const schedule: Schedule = sys.schedules.getItemByIndex(i);
128
- if (schedule.scheduleType === sys.board.valueMaps.scheduleTypes.getValue('runonce') && schedule.circuit === eggTimer.circuit){
129
- const sstate = state.schedules.getItemById(schedule.id);
130
- sstate.endTime = schedule.endTime = (schedule.startTime + eggTimer.runTime) % 1440; // remove days if we go past midnight
131
- }
132
- }
133
- } else if (circuitId > 0) {
134
- const schedule: Schedule = sys.schedules.getItemById(schedId, true);
135
- schedule.circuit = circuitId;
136
- schedule.startTime = msg.extractPayloadByte(2) * 60 + msg.extractPayloadByte(3);
137
- // 26 is 'let the eggTimer control end time' & run once
138
- schedule.scheduleType = msg.extractPayloadByte(4) === 26 ? 26 : 0;
139
- if (msg.extractPayloadByte(4) !== 26)
140
- schedule.endTime = msg.extractPayloadByte(4) * 60 + msg.extractPayloadByte(5);
141
- else {
142
- let _eggTimer = sys.circuits.getInterfaceById(circuitId).eggTimer || 720;
143
- schedule.endTime = (schedule.startTime + _eggTimer) % 1440; // remove days if we go past midnight
144
- }
145
- schedule.isActive = schedule.startTime !== 0;
146
- schedule.scheduleDays = msg.extractPayloadByte(6) & 0x7F; // 127
147
- if (schedule.startTimeType === 'undefined') schedule.startTimeType = 0;
148
- if (schedule.endTimeType === 'undefined') schedule.endTimeType = 0;
149
-
150
- if (sys.circuits.getItemById(schedule.circuit).hasHeatSource && typeof schedule.heatSource === 'undefined') schedule.heatSource = sys.board.valueMaps.heatSources.getValue('nochange');
151
- // todo: add to base sched item
152
- // (msg.extractPayloadByte(1) & 128) === 1 ? schedule.smartStart = 1 : schedule.smartStart = 0;
153
- if (schedule.isActive) {
154
- const sstate = state.schedules.getItemById(schedule.id, true);
155
- sstate.circuit = schedule.circuit;
156
- sstate.startTime = schedule.startTime;
157
- sstate.endTime = schedule.endTime;
158
- sstate.scheduleType = schedule.scheduleType;
159
- sstate.scheduleDays = schedule.scheduleDays;
160
- sstate.startTimeType = schedule.startTimeType;
161
- sstate.endTimeType = schedule.endTimeType;
162
- sstate.heatSource = schedule.heatSource;
163
- sstate.heatSetpoint = schedule.heatSetpoint;
164
- sstate.isActive = schedule.isActive;
165
- state.schedules.sortById();
166
- }
167
- }
168
- if (!scheduleActive) {
169
- sys.schedules.removeItemById(schedId);
170
- state.schedules.removeItemById(schedId);
171
- state.emitEquipmentChanges();
172
- }
173
-
174
- if (!eggTimerActive) {
175
- const circId = sys.eggTimers.getItemById(schedId).circuit;
176
- if (circId)
177
- {
178
- const circuit = sys.circuits.getInterfaceById(circId);
179
- circuit.eggTimer = 0;
180
- }
181
- sys.eggTimers.removeItemById(schedId);
182
- }
183
- }
184
- private static processStartMonth(msg: Inbound) {
185
- let schedId = (msg.extractPayloadByte(1) - 14) * 40 + 1;
186
- for (let i = 1; i < msg.payload.length && schedId <= ScheduleMessage._maxSchedId; i++) {
187
- const schedule: Schedule = sys.schedules.getItemById(schedId++, false, { isActive: false });
188
- if (schedule.isActive !== false) schedule.startMonth = msg.extractPayloadByte(i + 1);
189
- }
190
- msg.isProcessed = true;
191
- }
192
- private static processStartDay(msg: Inbound) {
193
- let schedId = (msg.extractPayloadByte(1) - 17) * 40 + 1;
194
- for (let i = 1; i < msg.payload.length; i++) {
195
- const schedule: Schedule = sys.schedules.getItemById(schedId++, false, { isActive: false });
196
- if (schedule.isActive !== false) {
197
- schedule.startDay = msg.extractPayloadByte(i + 1);
198
- let csched = state.schedules.getItemById(schedule.id);
199
- csched.startTime = schedule.startTime;
200
- }
201
- }
202
- msg.isProcessed = true;
203
- }
204
- private static processStartYear(msg: Inbound) {
205
- let schedId = (msg.extractPayloadByte(1) - 20) * 40 + 1;
206
- for (let i = 1; i < msg.payload.length; i++) {
207
- const schedule: Schedule = sys.schedules.getItemById(schedId++, false, { isActive: false });
208
- if (schedule.isActive !== false) {
209
- schedule.startYear = msg.extractPayloadByte(i + 1);
210
- }
211
- }
212
- msg.isProcessed = true;
213
- }
214
- private static processStartTimes(msg: Inbound) {
215
- let schedId = msg.extractPayloadByte(1) * 20 + 1;
216
- for (let i = 1; i < msg.payload.length - 1;) {
217
- let time = msg.extractPayloadInt(i + 1);
218
- let schedule: Schedule = sys.schedules.getItemById(schedId++, time !== 0);
219
- if (time !== 0) {
220
- schedule.startTime = time;
221
- schedule.isActive = schedule.startTime !== 0;
222
- let csched = state.schedules.getItemById(schedule.id, true);
223
- csched.startTime = schedule.startTime;
224
- }
225
- else {
226
- state.schedules.removeItemById(schedule.id);
227
- sys.schedules.removeItemById(schedule.id);
228
- }
229
- i += 2;
230
- }
231
- ScheduleMessage._maxSchedId = sys.schedules.getMaxId(true, 0);
232
- msg.isProcessed = true;
233
- }
234
- private static processEndTimes(msg: Inbound) {
235
- let schedId = (msg.extractPayloadByte(1) - 23) * 20 + 1;
236
- for (let i = 1; i < msg.payload.length - 1 && schedId <= ScheduleMessage._maxSchedId;) {
237
- const time = msg.extractPayloadInt(i + 1);
238
- const schedule: Schedule = sys.schedules.getItemById(schedId++, false, { isActive: false });
239
- if (schedule.isActive !== false) {
240
- schedule.endTime = time;
241
- let csched = state.schedules.getItemById(schedule.id);
242
- csched.endTime = schedule.endTime;
243
- }
244
- i += 2;
245
- }
246
- msg.isProcessed = true;
247
- }
248
- private static processCircuit(msg: Inbound) {
249
- let schedId = (msg.extractPayloadByte(1) - 5) * 40 + 1;
250
- for (let i = 1; i < msg.payload.length && schedId <= ScheduleMessage._maxSchedId; i++) {
251
- let schedule: Schedule = sys.schedules.getItemById(schedId++, false, { isActive: false });
252
- if (schedule.isActive) {
253
- let csched = state.schedules.getItemById(schedule.id);
254
- schedule.circuit = msg.extractPayloadByte(i + 1) + 1;
255
- if (schedule.circuit === 256 || schedule.circuit === 0) {
256
- // This is some of the IntelliCenter craziness where the schedule has a start time but
257
- // the circuit is undefined.
258
- csched.isActive = false;
259
- state.schedules.removeItemById(schedule.id);
260
- sys.schedules.removeItemById(schedule.id);
261
- }
262
- else
263
- csched.circuit = schedule.circuit;
264
- }
265
- }
266
- msg.isProcessed = true;
267
- }
268
- private static processRunOnce(msg: Inbound) {
269
- let schedId = (msg.extractPayloadByte(1) - 8) * 40 + 1;
270
- for (let i = 1; i < msg.payload.length && schedId <= ScheduleMessage._maxSchedId; i++) {
271
- let schedule: Schedule = sys.schedules.getItemById(schedId++, false, { isActive: false });
272
- if (schedule.isActive !== false) {
273
- let byte = msg.extractPayloadByte(i + 1);
274
- // schedule.runOnce = byte;
275
- schedule.scheduleType = (byte & 1 & 0xFF) === 1 ? 0 : 128;
276
- if ((byte & 4 & 0xFF) === 4) schedule.startTimeType = 1;
277
- else if ((byte & 8 & 0xFF) === 8) schedule.startTimeType = 2;
278
- else schedule.startTimeType = 0;
279
-
280
- if ((byte & 16 & 0xFF) === 16) schedule.endTimeType = 1;
281
- else if ((byte & 32 & 0xFF) === 32) schedule.endTimeType = 2;
282
- else schedule.endTimeType = 0;
283
- let csched = state.schedules.getItemById(schedule.id);
284
- csched.startTimeType = schedule.startTimeType;
285
- csched.endTimeType = schedule.endTimeType;
286
- csched.scheduleType = schedule.scheduleType;
287
- }
288
- }
289
- msg.isProcessed = true;
290
- }
291
- private static processDays(msg: Inbound) {
292
- let schedId = (msg.extractPayloadByte(1) - 11) * 40 + 1;
293
- for (let i = 1; i < msg.payload.length && schedId <= ScheduleMessage._maxSchedId; i++) {
294
- let schedule: Schedule = sys.schedules.getItemById(schedId++, false, { isActive: false });
295
- if (schedule.isActive !== false) {
296
- schedule.scheduleDays = msg.extractPayloadByte(i + 1);
297
- let csched = state.schedules.getItemById(schedule.id);
298
- csched.scheduleDays = csched.scheduleType === 128 ? schedule.scheduleDays : 0;
299
- }
300
- }
301
- msg.isProcessed = true;
302
- }
303
- private static processHeatSource(msg: Inbound) {
304
- let schedId = (msg.extractPayloadByte(1) - 28) * 40 + 1;
305
- for (let i = 1; i < msg.payload.length && schedId <= ScheduleMessage._maxSchedId; i++) {
306
- let schedule: Schedule = sys.schedules.getItemById(schedId++, false, { isActive: false });
307
- if (schedule.isActive !== false) {
308
- let hs = msg.extractPayloadByte(i + 1);
309
- // RKS: During the transition to 1.047 then heat sources were all screwed up. This meant that 0 was no change and 1 was off.
310
- //if (hs === 1) hs = 0; // Shim for 1.047 a heat source of 1 is not valid.
311
- schedule.heatSource = hs;
312
- let csched = state.schedules.getItemById(schedule.id);
313
- csched.heatSource = schedule.heatSource;
314
- }
315
- }
316
- msg.isProcessed = true;
317
- }
318
- private static processHeatSetpoint(msg: Inbound) {
319
- let schedId = (msg.extractPayloadByte(1) - 31) * 40 + 1;
320
- for (let i = 1; i < msg.payload.length && schedId <= ScheduleMessage._maxSchedId; i++) {
321
- let schedule: Schedule = sys.schedules.getItemById(schedId++, false, { isActive: false });
322
- if (schedule.isActive !== false) {
323
- schedule.heatSetpoint = msg.extractPayloadByte(i + 1);
324
- let csched = state.schedules.getItemById(schedule.id);
325
- csched.heatSetpoint = schedule.heatSetpoint;
326
- }
327
- }
328
- msg.isProcessed = true;
329
- }
330
- private static processCoolSetpoint(msg: Inbound) {
331
- let schedId = (msg.extractPayloadByte(1) - 34) * 40 + 1;
332
- for (let i = 1; i < msg.payload.length && schedId <= ScheduleMessage._maxSchedId; i++) {
333
- let schedule: Schedule = sys.schedules.getItemById(schedId++, false, { isActive: false });
334
- if (schedule.isActive !== false) {
335
- schedule.coolSetpoint = msg.extractPayloadByte(i + 1);
336
- let csched = state.schedules.getItemById(schedule.id);
337
- csched.coolSetpoint = schedule.coolSetpoint;
338
- }
339
- }
340
- msg.isProcessed = true;
341
- }
342
- }
1
+ /* nodejs-poolController. An application to control pool equipment.
2
+ Copyright (C) 2016, 2017, 2018, 2019, 2020. Russell Goldin, tagyoureit. russ.goldin@gmail.com
3
+
4
+ This program is free software: you can redistribute it and/or modify
5
+ it under the terms of the GNU Affero General Public License as
6
+ published by the Free Software Foundation, either version 3 of the
7
+ License, or (at your option) any later version.
8
+
9
+ This program is distributed in the hope that it will be useful,
10
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
11
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12
+ GNU Affero General Public License for more details.
13
+
14
+ You should have received a copy of the GNU Affero General Public License
15
+ along with this program. If not, see <http://www.gnu.org/licenses/>.
16
+ */
17
+ import { Inbound } from "../Messages";
18
+ import { sys, Schedule, EggTimer } from "../../../Equipment";
19
+ import { state } from "../../../State";
20
+ import { ControllerType } from "../../../Constants";
21
+ import { logger } from "../../../../logger/Logger";
22
+ export class ScheduleMessage {
23
+ // [165, 63, 15, 16, 30, 42][3, 28, 5, 32, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0][1, 143]
24
+ //
25
+
26
+ // [165, 63, 15, 16, 164, 48][0, 0, 0, 0, 0, 0, 39, 159, 117, 122, 137, 64, 92, 201, 126, 201, 79, 248, 39, 141, 2, 96, 20, 108, 123, 22, 56, 30, 8, 21, 49, 147, 22, 64, 24, 141, 4, 29, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0][12, 130]
27
+ // [165, 63, 15, 16, 164, 48][0, 0, 0, 0, 0, 0, 39, 159, 117, 122, 137, 64, 92, 228, 126, 201, 79, 248, 39, 141, 2, 96, 20, 108, 123, 22, 56, 30, 8, 21, 49, 147, 22, 64, 24, 141, 4, 29, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0][12, 157]
28
+
29
+ // Change heat source #1
30
+ // [165, 63, 15, 16, 30, 42][3, 28, 32, 32, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0][1, 170]
31
+ // [165, 63, 15, 16, 30, 42][3, 28, 5, 32, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0][1, 143]
32
+
33
+ // Run once
34
+ // [165, 63, 15, 16, 30, 42][3, 8, 128, 128, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0][2, 86]
35
+ // [165, 63, 15, 16, 30, 42][3, 8, 129, 128, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0][2, 87]
36
+ public static _maxSchedId: number = 0;
37
+ public static process(msg: Inbound): void {
38
+ if (sys.controllerType === ControllerType.IntelliCenter)
39
+ switch (msg.extractPayloadByte(1)) {
40
+ case 0:
41
+ case 1:
42
+ case 2:
43
+ case 3:
44
+ case 4:
45
+ ScheduleMessage.processStartTimes(msg);
46
+ break;
47
+ case 5:
48
+ case 6:
49
+ ScheduleMessage.processCircuit(msg);
50
+ break;
51
+ case 8: // Schedule Type
52
+ case 9:
53
+ case 10:
54
+ ScheduleMessage.processScheduleType(msg);
55
+ break;
56
+ case 11:
57
+ case 12:
58
+ case 13:
59
+ ScheduleMessage.processDays(msg);
60
+ break;
61
+ case 14: // Start Month
62
+ case 15:
63
+ case 16:
64
+ ScheduleMessage.processStartMonth(msg);
65
+ break;
66
+ case 17: // Start Day
67
+ case 18:
68
+ case 19:
69
+ ScheduleMessage.processStartDay(msg);
70
+ break;
71
+ case 20: // Start Year
72
+ case 21:
73
+ case 22:
74
+ ScheduleMessage.processStartYear(msg);
75
+ break;
76
+ case 23:
77
+ case 24:
78
+ case 25:
79
+ case 26:
80
+ case 27:
81
+ ScheduleMessage.processEndTimes(msg);
82
+ break;
83
+ case 28: // Heat Source
84
+ case 29:
85
+ case 30:
86
+ ScheduleMessage.processHeatSource(msg);
87
+ break;
88
+ case 31: // Heat Setpoint
89
+ case 32:
90
+ case 33:
91
+ ScheduleMessage.processHeatSetpoint(msg);
92
+ break;
93
+ case 34: // Cool Setpoint
94
+ case 35:
95
+ case 36:
96
+ ScheduleMessage.processCoolSetpoint(msg);
97
+ break;
98
+ default:
99
+ logger.debug(`Unprocessed Config Message ${msg.toPacket()}`)
100
+ break;
101
+
102
+ }
103
+ else if (sys.controllerType !== ControllerType.Unknown)
104
+ ScheduleMessage.processScheduleDetails(msg);
105
+ }
106
+ public static processScheduleDetails(msg: Inbound) {
107
+ // Sample packet
108
+ // [165,33,15,16,17,7][6,12,25,0,6,30,0][1,76]
109
+ const schedId = msg.extractPayloadByte(0);
110
+ const circuitId = msg.extractPayloadByte(1) & 127;
111
+ const eggTimerRunTime = msg.extractPayloadByte(4) * 60 + msg.extractPayloadByte(5);
112
+ const eggTimerActive = msg.extractPayloadByte(2) === 25 && circuitId > 0 && eggTimerRunTime !== 256;
113
+ const scheduleActive = !eggTimerActive && circuitId > 0;
114
+ if (eggTimerActive) {
115
+ // egg timer
116
+ const eggTimer: EggTimer = sys.eggTimers.getItemById(schedId, true);
117
+ eggTimer.circuit = circuitId;
118
+ eggTimer.runTime = eggTimerRunTime;
119
+ eggTimer.isActive = eggTimerActive;
120
+ const circuit = sys.circuits.getInterfaceById(circuitId);
121
+ circuit.eggTimer = eggTimer.runTime;
122
+ circuit.eggTimer === 720;
123
+ circuit.dontStop = circuit.eggTimer === 1620;
124
+ // When eggTimers are found go back and check existing schedules to see if a runOnce schedule already exists.
125
+ // It is possible that the runOnce schedule will be discovered before the eggTimer so we need to adjust the endTime
126
+ for (let i = 0; i < sys.schedules.length; i++){
127
+ const schedule: Schedule = sys.schedules.getItemByIndex(i);
128
+ if (schedule.scheduleType === sys.board.valueMaps.scheduleTypes.getValue('runonce') && schedule.circuit === eggTimer.circuit){
129
+ const sstate = state.schedules.getItemById(schedule.id);
130
+ sstate.endTime = schedule.endTime = (schedule.startTime + eggTimer.runTime) % 1440; // remove days if we go past midnight
131
+ }
132
+ }
133
+ } else if (circuitId > 0) {
134
+ const schedule: Schedule = sys.schedules.getItemById(schedId, true);
135
+ schedule.circuit = circuitId;
136
+ schedule.startTime = msg.extractPayloadByte(2) * 60 + msg.extractPayloadByte(3);
137
+ // 26 is 'let the eggTimer control end time' & run once
138
+ schedule.scheduleType = msg.extractPayloadByte(4) === 26 ? 26 : 0;
139
+ if (msg.extractPayloadByte(4) !== 26)
140
+ schedule.endTime = msg.extractPayloadByte(4) * 60 + msg.extractPayloadByte(5);
141
+ else {
142
+ let _eggTimer = sys.circuits.getInterfaceById(circuitId).eggTimer || 720;
143
+ schedule.endTime = (schedule.startTime + _eggTimer) % 1440; // remove days if we go past midnight
144
+ }
145
+ schedule.isActive = schedule.startTime !== 0;
146
+ schedule.scheduleDays = msg.extractPayloadByte(6) & 0x7F; // 127
147
+ if (schedule.startTimeType === 'undefined') schedule.startTimeType = 0;
148
+ if (schedule.endTimeType === 'undefined') schedule.endTimeType = 0;
149
+
150
+ if (sys.circuits.getItemById(schedule.circuit).hasHeatSource && typeof schedule.heatSource === 'undefined') schedule.heatSource = sys.board.valueMaps.heatSources.getValue('nochange');
151
+ // todo: add to base sched item
152
+ // (msg.extractPayloadByte(1) & 128) === 1 ? schedule.smartStart = 1 : schedule.smartStart = 0;
153
+ if (schedule.isActive) {
154
+ const sstate = state.schedules.getItemById(schedule.id, true);
155
+ sstate.circuit = schedule.circuit;
156
+ sstate.startTime = schedule.startTime;
157
+ sstate.endTime = schedule.endTime;
158
+ sstate.scheduleType = schedule.scheduleType;
159
+ sstate.scheduleDays = schedule.scheduleDays;
160
+ sstate.startTimeType = schedule.startTimeType;
161
+ sstate.endTimeType = schedule.endTimeType;
162
+ sstate.heatSource = schedule.heatSource;
163
+ sstate.heatSetpoint = schedule.heatSetpoint;
164
+ sstate.isActive = schedule.isActive;
165
+ state.schedules.sortById();
166
+ }
167
+ }
168
+ if (!scheduleActive) {
169
+ sys.schedules.removeItemById(schedId);
170
+ state.schedules.removeItemById(schedId);
171
+ state.emitEquipmentChanges();
172
+ }
173
+
174
+ if (!eggTimerActive) {
175
+ const circId = sys.eggTimers.getItemById(schedId).circuit;
176
+ if (circId)
177
+ {
178
+ const circuit = sys.circuits.getInterfaceById(circId);
179
+ circuit.eggTimer = 0;
180
+ }
181
+ sys.eggTimers.removeItemById(schedId);
182
+ }
183
+ }
184
+ private static processStartMonth(msg: Inbound) {
185
+ let schedId = (msg.extractPayloadByte(1) - 14) * 40 + 1;
186
+ for (let i = 1; i < msg.payload.length && schedId <= ScheduleMessage._maxSchedId; i++) {
187
+ const schedule: Schedule = sys.schedules.getItemById(schedId++, false, { isActive: false });
188
+ if (schedule.isActive !== false) schedule.startMonth = msg.extractPayloadByte(i + 1);
189
+ }
190
+ msg.isProcessed = true;
191
+ }
192
+ private static processStartDay(msg: Inbound) {
193
+ let schedId = (msg.extractPayloadByte(1) - 17) * 40 + 1;
194
+ for (let i = 1; i < msg.payload.length && schedId <= ScheduleMessage._maxSchedId; i++) {
195
+ const schedule: Schedule = sys.schedules.getItemById(schedId++, false, { isActive: false });
196
+ if (schedule.isActive !== false) {
197
+ schedule.startDay = msg.extractPayloadByte(i + 1);
198
+ let csched = state.schedules.getItemById(schedule.id);
199
+ csched.startTime = schedule.startTime;
200
+ }
201
+ }
202
+ msg.isProcessed = true;
203
+ }
204
+ private static processStartYear(msg: Inbound) {
205
+ let schedId = (msg.extractPayloadByte(1) - 20) * 40 + 1;
206
+ for (let i = 1; i < msg.payload.length && schedId <= ScheduleMessage._maxSchedId; i++) {
207
+ const schedule: Schedule = sys.schedules.getItemById(schedId++, false, { isActive: false });
208
+ if (schedule.isActive !== false) {
209
+ schedule.startYear = msg.extractPayloadByte(i + 1);
210
+ }
211
+ }
212
+ msg.isProcessed = true;
213
+ }
214
+ private static processStartTimes(msg: Inbound) {
215
+ let schedId = msg.extractPayloadByte(1) * 20 + 1;
216
+ for (let i = 1; i < msg.payload.length - 1 && schedId <= ScheduleMessage._maxSchedId;) {
217
+ let schedule: Schedule = sys.schedules.getItemById(schedId++, false, { isActive: false });
218
+ if (schedule.isActive) {
219
+ schedule.startTime = msg.extractPayloadInt(i + 1);
220
+ let csched = state.schedules.getItemById(schedule.id, true);
221
+ csched.startTime = schedule.startTime;
222
+ }
223
+ i += 2;
224
+ }
225
+ msg.isProcessed = true;
226
+ }
227
+ private static processEndTimes(msg: Inbound) {
228
+ let schedId = (msg.extractPayloadByte(1) - 23) * 20 + 1;
229
+ for (let i = 1; i < msg.payload.length - 1 && schedId <= ScheduleMessage._maxSchedId;) {
230
+ const time = msg.extractPayloadInt(i + 1);
231
+ const schedule: Schedule = sys.schedules.getItemById(schedId++, false, { isActive: false });
232
+ if (schedule.isActive !== false) {
233
+ schedule.endTime = time;
234
+ let csched = state.schedules.getItemById(schedule.id, true);
235
+ csched.endTime = schedule.endTime;
236
+ }
237
+ i += 2;
238
+ }
239
+ msg.isProcessed = true;
240
+ }
241
+ private static processCircuit(msg: Inbound) {
242
+ let schedId = (msg.extractPayloadByte(1) - 5) * 40 + 1;
243
+ for (let i = 1; i < msg.payload.length && schedId <= ScheduleMessage._maxSchedId; i++) {
244
+ let schedule: Schedule = sys.schedules.getItemById(schedId++, false, { isActive: false });
245
+ if (schedule.isActive) {
246
+ let csched = state.schedules.getItemById(schedule.id, true);
247
+ schedule.circuit = msg.extractPayloadByte(i + 1) + 1;
248
+ if (schedule.circuit === 256 || schedule.circuit === 0) {
249
+ // This is some of the IntelliCenter craziness where the schedule is marked as active but the circuit is not defined.
250
+ csched.isActive = false;
251
+ state.schedules.removeItemById(schedule.id);
252
+ sys.schedules.removeItemById(schedule.id);
253
+ }
254
+ else
255
+ csched.circuit = schedule.circuit;
256
+ }
257
+ }
258
+ msg.isProcessed = true;
259
+ }
260
+ private static processScheduleType(msg: Inbound) {
261
+ let schedId = (msg.extractPayloadByte(1) - 8) * 40 + 1;
262
+ for (let i = 1; i < msg.payload.length; i++) {
263
+ let byte = msg.extractPayloadByte(i + 1);
264
+ let schedule: Schedule = sys.schedules.getItemById(schedId++, (byte & 128) === 128);
265
+ if ((byte & 128) === 128) {
266
+ // If bit 8 is set on the time type then this indicates whether the schedule is active. If it is not
267
+ // active then we will be removing it.
268
+ schedule.isActive = true;
269
+ schedule.scheduleType = (byte & 1 & 0xFF) === 1 ? 0 : 128;
270
+ if ((byte & 4 & 0xFF) === 4) schedule.startTimeType = 1;
271
+ else if ((byte & 8 & 0xFF) === 8) schedule.startTimeType = 2;
272
+ else schedule.startTimeType = 0;
273
+
274
+ if ((byte & 16 & 0xFF) === 16) schedule.endTimeType = 1;
275
+ else if ((byte & 32 & 0xFF) === 32) schedule.endTimeType = 2;
276
+ else schedule.endTimeType = 0;
277
+ let csched = state.schedules.getItemById(schedule.id);
278
+ csched.isActive = true;
279
+ csched.startTimeType = schedule.startTimeType;
280
+ csched.endTimeType = schedule.endTimeType;
281
+ csched.scheduleType = schedule.scheduleType;
282
+ }
283
+ else {
284
+ // Now we need to remove this pig because this is not an active schedule.
285
+ sys.schedules.removeItemById(schedule.id);
286
+ if (schedule.isActive) {
287
+ let csched = state.schedules.getItemById(schedule.id);
288
+ schedule.isActive = csched.isActive = false;
289
+ }
290
+ state.schedules.removeItemById(schedule.id);
291
+ }
292
+ }
293
+ ScheduleMessage._maxSchedId = sys.schedules.getMaxId(true, 0);
294
+ msg.isProcessed = true;
295
+ }
296
+ private static processDays(msg: Inbound) {
297
+ let schedId = (msg.extractPayloadByte(1) - 11) * 40 + 1;
298
+ for (let i = 1; i < msg.payload.length && schedId <= ScheduleMessage._maxSchedId; i++) {
299
+ let schedule: Schedule = sys.schedules.getItemById(schedId++, false, { isActive: false });
300
+ if (schedule.isActive !== false) {
301
+ schedule.scheduleDays = msg.extractPayloadByte(i + 1);
302
+ let csched = state.schedules.getItemById(schedule.id);
303
+ csched.scheduleDays = csched.scheduleType === 128 ? schedule.scheduleDays : 0;
304
+ }
305
+ }
306
+ msg.isProcessed = true;
307
+ }
308
+ private static processHeatSource(msg: Inbound) {
309
+ let schedId = (msg.extractPayloadByte(1) - 28) * 40 + 1;
310
+ for (let i = 1; i < msg.payload.length && schedId <= ScheduleMessage._maxSchedId; i++) {
311
+ let schedule: Schedule = sys.schedules.getItemById(schedId++, false, { isActive: false });
312
+ if (schedule.isActive !== false) {
313
+ let hs = msg.extractPayloadByte(i + 1);
314
+ // RKS: During the transition to 1.047 then heat sources were all screwed up. This meant that 0 was no change and 1 was off.
315
+ //if (hs === 1) hs = 0; // Shim for 1.047 a heat source of 1 is not valid.
316
+ schedule.heatSource = hs;
317
+ let csched = state.schedules.getItemById(schedule.id);
318
+ csched.heatSource = schedule.heatSource;
319
+ }
320
+ }
321
+ msg.isProcessed = true;
322
+ }
323
+ private static processHeatSetpoint(msg: Inbound) {
324
+ let schedId = (msg.extractPayloadByte(1) - 31) * 40 + 1;
325
+ for (let i = 1; i < msg.payload.length && schedId <= ScheduleMessage._maxSchedId; i++) {
326
+ let schedule: Schedule = sys.schedules.getItemById(schedId++, false, { isActive: false });
327
+ if (schedule.isActive !== false) {
328
+ schedule.heatSetpoint = msg.extractPayloadByte(i + 1);
329
+ let csched = state.schedules.getItemById(schedule.id);
330
+ csched.heatSetpoint = schedule.heatSetpoint;
331
+ }
332
+ }
333
+ msg.isProcessed = true;
334
+ }
335
+ private static processCoolSetpoint(msg: Inbound) {
336
+ let schedId = (msg.extractPayloadByte(1) - 34) * 40 + 1;
337
+ for (let i = 1; i < msg.payload.length && schedId <= ScheduleMessage._maxSchedId; i++) {
338
+ let schedule: Schedule = sys.schedules.getItemById(schedId++, false, { isActive: false });
339
+ if (schedule.isActive !== false) {
340
+ schedule.coolSetpoint = msg.extractPayloadByte(i + 1);
341
+ let csched = state.schedules.getItemById(schedule.id);
342
+ csched.coolSetpoint = schedule.coolSetpoint;
343
+ }
344
+ }
345
+ msg.isProcessed = true;
346
+ }
347
+ }