nodejs-poolcontroller 7.6.1 → 7.7.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 (91) hide show
  1. package/.eslintrc.json +44 -44
  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 +220 -215
  8. package/Dockerfile +17 -17
  9. package/Gruntfile.js +40 -40
  10. package/LICENSE +661 -661
  11. package/README.md +191 -191
  12. package/app.ts +1 -1
  13. package/config/Config.ts +14 -0
  14. package/config/VersionCheck.ts +2 -2
  15. package/controller/Constants.ts +2 -1
  16. package/controller/Equipment.ts +2484 -2459
  17. package/controller/Errors.ts +180 -180
  18. package/controller/Lockouts.ts +502 -436
  19. package/controller/State.ts +106 -30
  20. package/controller/boards/AquaLinkBoard.ts +1000 -0
  21. package/controller/boards/BoardFactory.ts +49 -45
  22. package/controller/boards/EasyTouchBoard.ts +2859 -2653
  23. package/controller/boards/IntelliCenterBoard.ts +4198 -4230
  24. package/controller/boards/IntelliComBoard.ts +63 -63
  25. package/controller/boards/IntelliTouchBoard.ts +273 -241
  26. package/controller/boards/NixieBoard.ts +1728 -1675
  27. package/controller/boards/SystemBoard.ts +4925 -4697
  28. package/controller/comms/Comms.ts +442 -479
  29. package/controller/comms/messages/Messages.ts +171 -25
  30. package/controller/comms/messages/config/ChlorinatorMessage.ts +5 -2
  31. package/controller/comms/messages/config/CircuitGroupMessage.ts +0 -0
  32. package/controller/comms/messages/config/CircuitMessage.ts +1 -0
  33. package/controller/comms/messages/config/ConfigMessage.ts +0 -0
  34. package/controller/comms/messages/config/CoverMessage.ts +0 -0
  35. package/controller/comms/messages/config/CustomNameMessage.ts +30 -30
  36. package/controller/comms/messages/config/EquipmentMessage.ts +0 -0
  37. package/controller/comms/messages/config/ExternalMessage.ts +0 -0
  38. package/controller/comms/messages/config/FeatureMessage.ts +0 -0
  39. package/controller/comms/messages/config/GeneralMessage.ts +0 -0
  40. package/controller/comms/messages/config/HeaterMessage.ts +142 -10
  41. package/controller/comms/messages/config/IntellichemMessage.ts +0 -0
  42. package/controller/comms/messages/config/OptionsMessage.ts +4 -21
  43. package/controller/comms/messages/config/PumpMessage.ts +53 -35
  44. package/controller/comms/messages/config/RemoteMessage.ts +0 -0
  45. package/controller/comms/messages/config/ScheduleMessage.ts +350 -347
  46. package/controller/comms/messages/config/SecurityMessage.ts +0 -0
  47. package/controller/comms/messages/config/ValveMessage.ts +1 -1
  48. package/controller/comms/messages/status/ChlorinatorStateMessage.ts +38 -86
  49. package/controller/comms/messages/status/EquipmentStateMessage.ts +58 -22
  50. package/controller/comms/messages/status/HeaterStateMessage.ts +116 -86
  51. package/controller/comms/messages/status/IntelliChemStateMessage.ts +445 -445
  52. package/controller/comms/messages/status/IntelliValveStateMessage.ts +35 -35
  53. package/controller/comms/messages/status/PumpStateMessage.ts +23 -1
  54. package/controller/comms/messages/status/VersionMessage.ts +0 -0
  55. package/controller/nixie/Nixie.ts +162 -162
  56. package/controller/nixie/NixieEquipment.ts +103 -103
  57. package/controller/nixie/bodies/Body.ts +120 -120
  58. package/controller/nixie/bodies/Filter.ts +135 -135
  59. package/controller/nixie/chemistry/ChemController.ts +2511 -2498
  60. package/controller/nixie/chemistry/Chlorinator.ts +363 -314
  61. package/controller/nixie/circuits/Circuit.ts +261 -248
  62. package/controller/nixie/heaters/Heater.ts +650 -648
  63. package/controller/nixie/pumps/Pump.ts +906 -661
  64. package/controller/nixie/schedules/Schedule.ts +313 -257
  65. package/controller/nixie/valves/Valve.ts +170 -170
  66. package/defaultConfig.json +306 -286
  67. package/logger/DataLogger.ts +448 -448
  68. package/logger/Logger.ts +0 -0
  69. package/package.json +56 -56
  70. package/tsconfig.json +25 -25
  71. package/web/Server.ts +92 -47
  72. package/web/bindings/aqualinkD.json +505 -0
  73. package/web/bindings/influxDB.json +1051 -1021
  74. package/web/bindings/mqtt.json +702 -654
  75. package/web/bindings/mqttAlt.json +731 -684
  76. package/web/bindings/rulesManager.json +54 -54
  77. package/web/bindings/smartThings-Hubitat.json +31 -31
  78. package/web/bindings/valveRelays.json +20 -20
  79. package/web/bindings/vera.json +25 -25
  80. package/web/interfaces/baseInterface.ts +137 -136
  81. package/web/interfaces/httpInterface.ts +145 -124
  82. package/web/interfaces/influxInterface.ts +276 -245
  83. package/web/interfaces/mqttInterface.ts +535 -475
  84. package/web/services/config/Config.ts +39 -18
  85. package/web/services/config/ConfigSocket.ts +0 -0
  86. package/web/services/state/State.ts +10 -0
  87. package/web/services/state/StateSocket.ts +4 -4
  88. package/web/services/utilities/Utilities.ts +44 -42
  89. package/.github/ISSUE_TEMPLATE/bug_report.md +0 -52
  90. package/config copy.json +0 -300
  91. package/issue_template.md +0 -52
@@ -1,170 +1,170 @@
1
- import { EquipmentNotFoundError, InvalidEquipmentDataError, InvalidEquipmentIdError, ParameterOutOfRangeError } from '../../Errors';
2
- import { utils, Timestamp } from '../../Constants';
3
- import { logger } from '../../../logger/Logger';
4
-
5
- import { NixieEquipment, NixieChildEquipment, NixieEquipmentCollection, INixieControlPanel } from "../NixieEquipment";
6
- import { Valve, ValveCollection, sys } from "../../../controller/Equipment";
7
- import { ValveState, state, } from "../../State";
8
- import { setTimeout, clearTimeout } from 'timers';
9
- import { NixieControlPanel } from '../Nixie';
10
- import { webApp, InterfaceServerResponse } from "../../../web/Server";
11
-
12
- export class NixieValveCollection extends NixieEquipmentCollection<NixieValve> {
13
- public async deleteValveAsync(id: number) {
14
- try {
15
- for (let i = this.length - 1; i >= 0; i--) {
16
- let valve = this[i];
17
- if (valve.id === id) {
18
- await valve.closeAsync();
19
- this.splice(i, 1);
20
- }
21
- }
22
- } catch (err) { return Promise.reject(`Nixie Control Panel deleteValveAsync ${err.message}`); }
23
- }
24
- public async setValveStateAsync(vstate: ValveState, isDiverted: boolean) {
25
- try {
26
- let valve: NixieValve = this.find(elem => elem.id === vstate.id) as NixieValve;
27
- if (typeof valve === 'undefined') {
28
- vstate.isDiverted = isDiverted;
29
- return logger.error(`Nixie Control Panel Error setValveState could not find valve ${vstate.id}-${vstate.name}`);
30
- }
31
- await valve.setValveStateAsync(vstate, isDiverted);
32
- } catch (err) { return Promise.reject(new Error(`Nixie Error setting valve state ${vstate.id}-${vstate.name}: ${err.message}`)); }
33
- }
34
- public async setValveAsync(valve: Valve, data: any) {
35
- // By the time we get here we know that we are in control and this is a Nixie valve.
36
- try {
37
- let c: NixieValve = this.find(elem => elem.id === valve.id) as NixieValve;
38
- if (typeof c === 'undefined') {
39
- valve.master = 1;
40
- c = new NixieValve(this.controlPanel, valve);
41
- this.push(c);
42
- await c.setValveAsync(data);
43
- logger.info(`A valve was not found for id #${valve.id} creating valve`);
44
- }
45
- else {
46
- await c.setValveAsync(data);
47
- }
48
- }
49
- catch (err) { logger.error(`setValveAsync: ${err.message}`); return Promise.reject(err); }
50
- }
51
- public async initAsync(valves: ValveCollection) {
52
- try {
53
- for (let i = 0; i < valves.length; i++) {
54
- let valve = valves.getItemByIndex(i);
55
- if (valve.master === 1) {
56
- if (typeof this.find(elem => elem.id === valve.id) === 'undefined') {
57
- let nvalve = new NixieValve(this.controlPanel, valve);
58
- logger.info(`Initializing Nixie Valve ${nvalve.id}-${valve.name}`);
59
- this.push(nvalve);
60
- }
61
- }
62
- }
63
- }
64
- catch (err) { logger.error(`Nixie Valve initAsync Error: ${err.message}`); return Promise.reject(err); }
65
- }
66
- public async closeAsync() {
67
- try {
68
- for (let i = this.length - 1; i >= 0; i--) {
69
- try {
70
- await this[i].closeAsync();
71
- this.splice(i, 1);
72
- } catch (err) { logger.error(`Error stopping Nixie Valve ${err}`); }
73
- }
74
-
75
- } catch (err) { } // Don't bail if we have an errror.
76
- }
77
-
78
- public async initValveAsync(valve: Valve): Promise<NixieValve> {
79
- try {
80
- let c: NixieValve = this.find(elem => elem.id === valve.id) as NixieValve;
81
- if (typeof c === 'undefined') {
82
- c = new NixieValve(this.controlPanel, valve);
83
- this.push(c);
84
- }
85
- return c;
86
- } catch (err) { return Promise.reject(logger.error(`Nixie Controller: initValveAsync Error: ${err.message}`)); }
87
- }
88
-
89
- }
90
- export class NixieValve extends NixieEquipment {
91
- public pollingInterval: number = 10000;
92
- private _pollTimer: NodeJS.Timeout = null;
93
- public valve: Valve;
94
- private _lastState;
95
- constructor(ncp: INixieControlPanel, valve: Valve) {
96
- super(ncp);
97
- this.valve = valve;
98
- this.pollEquipmentAsync();
99
- }
100
- public get id(): number { return typeof this.valve !== 'undefined' ? this.valve.id : -1; }
101
- public async setValveStateAsync(vstate: ValveState, isDiverted: boolean) {
102
- try {
103
- // Here we go we need to set the valve state.
104
- if (vstate.isDiverted !== isDiverted) {
105
- logger.verbose(`Nixie: Set valve ${vstate.id}-${vstate.name} to ${isDiverted}`);
106
- }
107
- if (utils.isNullOrEmpty(this.valve.connectionId) || utils.isNullOrEmpty(this.valve.deviceBinding)) {
108
- vstate.isDiverted = isDiverted;
109
- return new InterfaceServerResponse(200, 'Success');
110
- }
111
- if (typeof this._lastState === 'undefined' || isDiverted || this._lastState !== isDiverted) {
112
- let res = await NixieEquipment.putDeviceService(this.valve.connectionId, `/state/device/${this.valve.deviceBinding}`, { isOn: isDiverted, latch: isDiverted ? 10000 : undefined });
113
- if (res.status.code === 200) this._lastState = vstate.isDiverted = isDiverted;
114
- return res;
115
- }
116
- else {
117
- vstate.isDiverted = isDiverted;
118
- return new InterfaceServerResponse(200, 'Success');
119
- }
120
- } catch (err) { return logger.error(`Nixie Error setting valve state ${vstate.id}-${vstate.name}: ${err.message}`); }
121
- }
122
- public async setValveAsync(data: any) {
123
- try {
124
- let valve = this.valve;
125
- }
126
- catch (err) { logger.error(`Nixie setValveAsync: ${err.message}`); return Promise.reject(err); }
127
- }
128
- public async pollEquipmentAsync() {
129
- let self = this;
130
- try {
131
- if (typeof this._pollTimer !== 'undefined' || this._pollTimer) clearTimeout(this._pollTimer);
132
- this._pollTimer = null;
133
- let success = false;
134
- }
135
- catch (err) { logger.error(`Nixie Error polling valve - ${err}`); }
136
- finally { this._pollTimer = setTimeout(async () => await self.pollEquipmentAsync(), this.pollingInterval || 10000); }
137
- }
138
- private async checkHardwareStatusAsync(connectionId: string, deviceBinding: string) {
139
- try {
140
- let dev = await NixieEquipment.getDeviceService(connectionId, `/status/device/${deviceBinding}`);
141
- return dev;
142
- } catch (err) { logger.error(`Nixie Valve checkHardwareStatusAsync: ${err.message}`); return { hasFault: true } }
143
- }
144
- public async validateSetupAsync(valve: Valve, vstate: ValveState) {
145
- try {
146
- if (typeof valve.connectionId !== 'undefined' && valve.connectionId !== ''
147
- && typeof valve.deviceBinding !== 'undefined' && valve.deviceBinding !== '') {
148
- try {
149
- let stat = await this.checkHardwareStatusAsync(valve.connectionId, valve.deviceBinding);
150
- // If we have a status check the return.
151
- vstate.commStatus = stat.hasFault ? 1 : 0;
152
- } catch (err) { vstate.commStatus = 1; }
153
- }
154
- else
155
- vstate.commStatus = 0;
156
- // The validation will be different if the valve is on or not. So lets get that information.
157
- } catch (err) { logger.error(`Nixie Error checking Valve Hardware ${this.valve.name}: ${err.message}`); vstate.commStatus = 1; return Promise.reject(err); }
158
- }
159
- public async closeAsync() {
160
- try {
161
- if (typeof this._pollTimer !== 'undefined' || this._pollTimer) clearTimeout(this._pollTimer);
162
- this._pollTimer = null;
163
- let vstate = state.valves.getItemById(this.valve.id);
164
- this.setValveStateAsync(vstate, false);
165
- vstate.emitEquipmentChange();
166
- }
167
- catch (err) { logger.error(`Nixie Valve closeAsync: ${err.message}`); return Promise.reject(err); }
168
- }
169
- public logData(filename: string, data: any) { this.controlPanel.logData(filename, data); }
170
- }
1
+ import { EquipmentNotFoundError, InvalidEquipmentDataError, InvalidEquipmentIdError, ParameterOutOfRangeError } from '../../Errors';
2
+ import { utils, Timestamp } from '../../Constants';
3
+ import { logger } from '../../../logger/Logger';
4
+
5
+ import { NixieEquipment, NixieChildEquipment, NixieEquipmentCollection, INixieControlPanel } from "../NixieEquipment";
6
+ import { Valve, ValveCollection, sys } from "../../../controller/Equipment";
7
+ import { ValveState, state, } from "../../State";
8
+ import { setTimeout, clearTimeout } from 'timers';
9
+ import { NixieControlPanel } from '../Nixie';
10
+ import { webApp, InterfaceServerResponse } from "../../../web/Server";
11
+
12
+ export class NixieValveCollection extends NixieEquipmentCollection<NixieValve> {
13
+ public async deleteValveAsync(id: number) {
14
+ try {
15
+ for (let i = this.length - 1; i >= 0; i--) {
16
+ let valve = this[i];
17
+ if (valve.id === id) {
18
+ await valve.closeAsync();
19
+ this.splice(i, 1);
20
+ }
21
+ }
22
+ } catch (err) { return Promise.reject(`Nixie Control Panel deleteValveAsync ${err.message}`); }
23
+ }
24
+ public async setValveStateAsync(vstate: ValveState, isDiverted: boolean) {
25
+ try {
26
+ let valve: NixieValve = this.find(elem => elem.id === vstate.id) as NixieValve;
27
+ if (typeof valve === 'undefined') {
28
+ vstate.isDiverted = isDiverted;
29
+ return logger.error(`Nixie Control Panel Error setValveState could not find valve ${vstate.id}-${vstate.name}`);
30
+ }
31
+ await valve.setValveStateAsync(vstate, isDiverted);
32
+ } catch (err) { return Promise.reject(new Error(`Nixie Error setting valve state ${vstate.id}-${vstate.name}: ${err.message}`)); }
33
+ }
34
+ public async setValveAsync(valve: Valve, data: any) {
35
+ // By the time we get here we know that we are in control and this is a Nixie valve.
36
+ try {
37
+ let c: NixieValve = this.find(elem => elem.id === valve.id) as NixieValve;
38
+ if (typeof c === 'undefined') {
39
+ valve.master = 1;
40
+ c = new NixieValve(this.controlPanel, valve);
41
+ this.push(c);
42
+ await c.setValveAsync(data);
43
+ logger.info(`A valve was not found for id #${valve.id} creating valve`);
44
+ }
45
+ else {
46
+ await c.setValveAsync(data);
47
+ }
48
+ }
49
+ catch (err) { logger.error(`setValveAsync: ${err.message}`); return Promise.reject(err); }
50
+ }
51
+ public async initAsync(valves: ValveCollection) {
52
+ try {
53
+ for (let i = 0; i < valves.length; i++) {
54
+ let valve = valves.getItemByIndex(i);
55
+ if (valve.master === 1) {
56
+ if (typeof this.find(elem => elem.id === valve.id) === 'undefined') {
57
+ let nvalve = new NixieValve(this.controlPanel, valve);
58
+ logger.info(`Initializing Nixie Valve ${nvalve.id}-${valve.name}`);
59
+ this.push(nvalve);
60
+ }
61
+ }
62
+ }
63
+ }
64
+ catch (err) { logger.error(`Nixie Valve initAsync Error: ${err.message}`); return Promise.reject(err); }
65
+ }
66
+ public async closeAsync() {
67
+ try {
68
+ for (let i = this.length - 1; i >= 0; i--) {
69
+ try {
70
+ await this[i].closeAsync();
71
+ this.splice(i, 1);
72
+ } catch (err) { logger.error(`Error stopping Nixie Valve ${err}`); }
73
+ }
74
+
75
+ } catch (err) { } // Don't bail if we have an errror.
76
+ }
77
+
78
+ public async initValveAsync(valve: Valve): Promise<NixieValve> {
79
+ try {
80
+ let c: NixieValve = this.find(elem => elem.id === valve.id) as NixieValve;
81
+ if (typeof c === 'undefined') {
82
+ c = new NixieValve(this.controlPanel, valve);
83
+ this.push(c);
84
+ }
85
+ return c;
86
+ } catch (err) { return Promise.reject(logger.error(`Nixie Controller: initValveAsync Error: ${err.message}`)); }
87
+ }
88
+
89
+ }
90
+ export class NixieValve extends NixieEquipment {
91
+ public pollingInterval: number = 10000;
92
+ private _pollTimer: NodeJS.Timeout = null;
93
+ public valve: Valve;
94
+ private _lastState;
95
+ constructor(ncp: INixieControlPanel, valve: Valve) {
96
+ super(ncp);
97
+ this.valve = valve;
98
+ this.pollEquipmentAsync();
99
+ }
100
+ public get id(): number { return typeof this.valve !== 'undefined' ? this.valve.id : -1; }
101
+ public async setValveStateAsync(vstate: ValveState, isDiverted: boolean) {
102
+ try {
103
+ // Here we go we need to set the valve state.
104
+ if (vstate.isDiverted !== isDiverted) {
105
+ logger.verbose(`Nixie: Set valve ${vstate.id}-${vstate.name} to ${isDiverted}`);
106
+ }
107
+ if (utils.isNullOrEmpty(this.valve.connectionId) || utils.isNullOrEmpty(this.valve.deviceBinding)) {
108
+ vstate.isDiverted = isDiverted;
109
+ return new InterfaceServerResponse(200, 'Success');
110
+ }
111
+ if (typeof this._lastState === 'undefined' || isDiverted || this._lastState !== isDiverted) {
112
+ let res = await NixieEquipment.putDeviceService(this.valve.connectionId, `/state/device/${this.valve.deviceBinding}`, { isOn: isDiverted, latch: isDiverted ? 10000 : undefined });
113
+ if (res.status.code === 200) this._lastState = vstate.isDiverted = isDiverted;
114
+ return res;
115
+ }
116
+ else {
117
+ vstate.isDiverted = isDiverted;
118
+ return new InterfaceServerResponse(200, 'Success');
119
+ }
120
+ } catch (err) { return logger.error(`Nixie Error setting valve state ${vstate.id}-${vstate.name}: ${err.message}`); }
121
+ }
122
+ public async setValveAsync(data: any) {
123
+ try {
124
+ let valve = this.valve;
125
+ }
126
+ catch (err) { logger.error(`Nixie setValveAsync: ${err.message}`); return Promise.reject(err); }
127
+ }
128
+ public async pollEquipmentAsync() {
129
+ let self = this;
130
+ try {
131
+ if (typeof this._pollTimer !== 'undefined' || this._pollTimer) clearTimeout(this._pollTimer);
132
+ this._pollTimer = null;
133
+ let success = false;
134
+ }
135
+ catch (err) { logger.error(`Nixie Error polling valve - ${err}`); }
136
+ finally { this._pollTimer = setTimeout(async () => await self.pollEquipmentAsync(), this.pollingInterval || 10000); }
137
+ }
138
+ private async checkHardwareStatusAsync(connectionId: string, deviceBinding: string) {
139
+ try {
140
+ let dev = await NixieEquipment.getDeviceService(connectionId, `/status/device/${deviceBinding}`);
141
+ return dev;
142
+ } catch (err) { logger.error(`Nixie Valve checkHardwareStatusAsync: ${err.message}`); return { hasFault: true } }
143
+ }
144
+ public async validateSetupAsync(valve: Valve, vstate: ValveState) {
145
+ try {
146
+ if (typeof valve.connectionId !== 'undefined' && valve.connectionId !== ''
147
+ && typeof valve.deviceBinding !== 'undefined' && valve.deviceBinding !== '') {
148
+ try {
149
+ let stat = await this.checkHardwareStatusAsync(valve.connectionId, valve.deviceBinding);
150
+ // If we have a status check the return.
151
+ vstate.commStatus = stat.hasFault ? 1 : 0;
152
+ } catch (err) { vstate.commStatus = 1; }
153
+ }
154
+ else
155
+ vstate.commStatus = 0;
156
+ // The validation will be different if the valve is on or not. So lets get that information.
157
+ } catch (err) { logger.error(`Nixie Error checking Valve Hardware ${this.valve.name}: ${err.message}`); vstate.commStatus = 1; return Promise.reject(err); }
158
+ }
159
+ public async closeAsync() {
160
+ try {
161
+ if (typeof this._pollTimer !== 'undefined' || this._pollTimer) clearTimeout(this._pollTimer);
162
+ this._pollTimer = null;
163
+ let vstate = state.valves.getItemById(this.valve.id);
164
+ this.setValveStateAsync(vstate, false);
165
+ vstate.emitEquipmentChange();
166
+ }
167
+ catch (err) { logger.error(`Nixie Valve closeAsync: ${err.message}`); return Promise.reject(err); }
168
+ }
169
+ public logData(filename: string, data: any) { this.controlPanel.logData(filename, data); }
170
+ }