Commit | Line | Data |
---|---|---|
efa43e52 | 1 | import { BootNotificationResponse, RegistrationStatus } from '../types/ocpp/Responses'; |
e118beaa | 2 | import ChargingStationConfiguration, { ConfigurationKey } from '../types/ChargingStationConfiguration'; |
7decf1b6 | 3 | import ChargingStationTemplate, { CurrentOutType, VoltageOut } from '../types/ChargingStationTemplate'; |
10570d97 | 4 | import Connectors, { Connector } from '../types/Connectors'; |
6af9012e | 5 | import { PerformanceObserver, performance } from 'perf_hooks'; |
c0560973 | 6 | import Requests, { AvailabilityType, BootNotificationRequest, IncomingRequest, IncomingRequestCommand } from '../types/ocpp/Requests'; |
136c90ba | 7 | import WebSocket, { MessageEvent } from 'ws'; |
3f40bc9c | 8 | |
6af9012e | 9 | import AutomaticTransactionGenerator from './AutomaticTransactionGenerator'; |
c0560973 JB |
10 | import { ChargePointStatus } from '../types/ocpp/ChargePointStatus'; |
11 | import { ChargingProfile } from '../types/ocpp/ChargingProfile'; | |
9ac86a7e | 12 | import ChargingStationInfo from '../types/ChargingStationInfo'; |
6af9012e | 13 | import Configuration from '../utils/Configuration'; |
63b48f77 | 14 | import Constants from '../utils/Constants'; |
d2a64eb5 | 15 | import { MessageType } from '../types/ocpp/MessageType'; |
c0560973 JB |
16 | import { MeterValueMeasurand } from '../types/ocpp/MeterValues'; |
17 | import OCPP16IncomingRequestService from './ocpp/1.6/OCCP16IncomingRequestService'; | |
18 | import OCPP16RequestService from './ocpp/1.6/OCPP16RequestService'; | |
19 | import OCPP16ResponseService from './ocpp/1.6/OCPP16ResponseService'; | |
63b48f77 | 20 | import OCPPError from './OcppError'; |
c0560973 JB |
21 | import OCPPIncomingRequestService from './ocpp/OCPPIncomingRequestService'; |
22 | import OCPPRequestService from './ocpp/OCPPRequestService'; | |
23 | import { OCPPVersion } from '../types/ocpp/OCPPVersion'; | |
54b1efe0 | 24 | import PerformanceStatistics from '../utils/PerformanceStatistics'; |
c0560973 | 25 | import { StandardParametersKey } from '../types/ocpp/Configuration'; |
c0560973 | 26 | import { StopTransactionReason } from '../types/ocpp/Transaction'; |
6af9012e | 27 | import Utils from '../utils/Utils'; |
32a1eb7a | 28 | import { WebSocketCloseEventStatusCode } from '../types/WebSocket'; |
3f40bc9c JB |
29 | import crypto from 'crypto'; |
30 | import fs from 'fs'; | |
6af9012e | 31 | import logger from '../utils/Logger'; |
bf1866b2 | 32 | import path from 'path'; |
3f40bc9c JB |
33 | |
34 | export default class ChargingStation { | |
c0560973 JB |
35 | public stationTemplateFile: string; |
36 | public authorizedTags: string[]; | |
6e0964c8 | 37 | public stationInfo!: ChargingStationInfo; |
ad2f27c3 | 38 | public connectors: Connectors; |
6e0964c8 | 39 | public configuration!: ChargingStationConfiguration; |
c0560973 | 40 | public hasStopped: boolean; |
6e0964c8 | 41 | public wsConnection!: WebSocket; |
c0560973 JB |
42 | public requests: Requests; |
43 | public messageQueue: string[]; | |
6e0964c8 JB |
44 | public performanceStatistics!: PerformanceStatistics; |
45 | public heartbeatSetInterval!: NodeJS.Timeout; | |
46 | public ocppIncomingRequestService!: OCPPIncomingRequestService; | |
47 | public ocppRequestService!: OCPPRequestService; | |
ad2f27c3 | 48 | private index: number; |
6e0964c8 JB |
49 | private bootNotificationRequest!: BootNotificationRequest; |
50 | private bootNotificationResponse!: BootNotificationResponse | null; | |
51 | private connectorsConfigurationHash!: string; | |
52 | private supervisionUrl!: string; | |
53 | private wsConnectionUrl!: string; | |
ad2f27c3 JB |
54 | private hasSocketRestarted: boolean; |
55 | private autoReconnectRetryCount: number; | |
6e0964c8 JB |
56 | private automaticTransactionGeneration!: AutomaticTransactionGenerator; |
57 | private performanceObserver!: PerformanceObserver; | |
58 | private webSocketPingSetInterval!: NodeJS.Timeout; | |
6af9012e JB |
59 | |
60 | constructor(index: number, stationTemplateFile: string) { | |
ad2f27c3 JB |
61 | this.index = index; |
62 | this.stationTemplateFile = stationTemplateFile; | |
63 | this.connectors = {} as Connectors; | |
c0560973 | 64 | this.initialize(); |
2e6f5966 | 65 | |
ad2f27c3 JB |
66 | this.hasStopped = false; |
67 | this.hasSocketRestarted = false; | |
68 | this.autoReconnectRetryCount = 0; | |
2e6f5966 | 69 | |
ad2f27c3 JB |
70 | this.requests = {} as Requests; |
71 | this.messageQueue = [] as string[]; | |
2e6f5966 | 72 | |
c0560973 JB |
73 | this.authorizedTags = this.getAuthorizedTags(); |
74 | } | |
75 | ||
76 | public logPrefix(): string { | |
54b1efe0 | 77 | return Utils.logPrefix(` ${this.stationInfo.chargingStationId} |`); |
c0560973 JB |
78 | } |
79 | ||
80 | public getRandomTagId(): string { | |
81 | const index = Math.floor(Math.random() * this.authorizedTags.length); | |
82 | return this.authorizedTags[index]; | |
83 | } | |
84 | ||
85 | public hasAuthorizedTags(): boolean { | |
86 | return !Utils.isEmptyArray(this.authorizedTags); | |
87 | } | |
88 | ||
6e0964c8 | 89 | public getEnableStatistics(): boolean | undefined { |
c0560973 JB |
90 | return !Utils.isUndefined(this.stationInfo.enableStatistics) ? this.stationInfo.enableStatistics : true; |
91 | } | |
92 | ||
6e0964c8 | 93 | public getNumberOfPhases(): number | undefined { |
7decf1b6 JB |
94 | switch (this.getCurrentOutType()) { |
95 | case CurrentOutType.AC: | |
c0560973 | 96 | return !Utils.isUndefined(this.stationInfo.numberOfPhases) ? this.stationInfo.numberOfPhases : 3; |
7decf1b6 | 97 | case CurrentOutType.DC: |
c0560973 JB |
98 | return 0; |
99 | } | |
100 | } | |
101 | ||
102 | public isWebSocketOpen(): boolean { | |
103 | return this.wsConnection?.readyState === WebSocket.OPEN; | |
104 | } | |
105 | ||
106 | public isRegistered(): boolean { | |
107 | return this.bootNotificationResponse?.status === RegistrationStatus.ACCEPTED; | |
108 | } | |
109 | ||
110 | public isChargingStationAvailable(): boolean { | |
111 | return this.getConnector(0).availability === AvailabilityType.OPERATIVE; | |
112 | } | |
113 | ||
114 | public isConnectorAvailable(id: number): boolean { | |
115 | return this.getConnector(id).availability === AvailabilityType.OPERATIVE; | |
116 | } | |
117 | ||
118 | public getConnector(id: number): Connector { | |
119 | return this.connectors[id]; | |
120 | } | |
121 | ||
6e0964c8 | 122 | public getCurrentOutType(): CurrentOutType | undefined { |
7decf1b6 | 123 | return !Utils.isUndefined(this.stationInfo.currentOutType) ? this.stationInfo.currentOutType : CurrentOutType.AC; |
c0560973 JB |
124 | } |
125 | ||
6e0964c8 | 126 | public getVoltageOut(): number | undefined { |
7decf1b6 | 127 | const errMsg = `${this.logPrefix()} Unknown ${this.getCurrentOutType()} currentOutType in template file ${this.stationTemplateFile}, cannot define default voltage out`; |
c0560973 | 128 | let defaultVoltageOut: number; |
7decf1b6 JB |
129 | switch (this.getCurrentOutType()) { |
130 | case CurrentOutType.AC: | |
c0560973 JB |
131 | defaultVoltageOut = VoltageOut.VOLTAGE_230; |
132 | break; | |
7decf1b6 | 133 | case CurrentOutType.DC: |
c0560973 JB |
134 | defaultVoltageOut = VoltageOut.VOLTAGE_400; |
135 | break; | |
136 | default: | |
137 | logger.error(errMsg); | |
138 | throw Error(errMsg); | |
139 | } | |
140 | return !Utils.isUndefined(this.stationInfo.voltageOut) ? this.stationInfo.voltageOut : defaultVoltageOut; | |
141 | } | |
142 | ||
6e0964c8 | 143 | public getTransactionIdTag(transactionId: number): string | undefined { |
c0560973 JB |
144 | for (const connector in this.connectors) { |
145 | if (Utils.convertToInt(connector) > 0 && this.getConnector(Utils.convertToInt(connector)).transactionId === transactionId) { | |
146 | return this.getConnector(Utils.convertToInt(connector)).idTag; | |
147 | } | |
148 | } | |
149 | } | |
150 | ||
6e0964c8 | 151 | public getTransactionMeterStop(transactionId: number): number | undefined { |
c0560973 JB |
152 | for (const connector in this.connectors) { |
153 | if (Utils.convertToInt(connector) > 0 && this.getConnector(Utils.convertToInt(connector)).transactionId === transactionId) { | |
154 | return this.getConnector(Utils.convertToInt(connector)).lastEnergyActiveImportRegisterValue; | |
155 | } | |
156 | } | |
157 | } | |
158 | ||
159 | public getAuthorizeRemoteTxRequests(): boolean { | |
160 | const authorizeRemoteTxRequests = this.getConfigurationKey(StandardParametersKey.AuthorizeRemoteTxRequests); | |
161 | return authorizeRemoteTxRequests ? Utils.convertToBoolean(authorizeRemoteTxRequests.value) : false; | |
162 | } | |
163 | ||
164 | public getLocalAuthListEnabled(): boolean { | |
165 | const localAuthListEnabled = this.getConfigurationKey(StandardParametersKey.LocalAuthListEnabled); | |
166 | return localAuthListEnabled ? Utils.convertToBoolean(localAuthListEnabled.value) : false; | |
167 | } | |
168 | ||
169 | public restartWebSocketPing(): void { | |
170 | // Stop WebSocket ping | |
171 | this.stopWebSocketPing(); | |
172 | // Start WebSocket ping | |
173 | this.startWebSocketPing(); | |
174 | } | |
175 | ||
176 | public startHeartbeat(): void { | |
177 | if (this.getHeartbeatInterval() && this.getHeartbeatInterval() > 0 && !this.heartbeatSetInterval) { | |
71623267 JB |
178 | // eslint-disable-next-line @typescript-eslint/no-misused-promises |
179 | this.heartbeatSetInterval = setInterval(async (): Promise<void> => { | |
c0560973 JB |
180 | await this.ocppRequestService.sendHeartbeat(); |
181 | }, this.getHeartbeatInterval()); | |
182 | logger.info(this.logPrefix() + ' Heartbeat started every ' + Utils.milliSecondsToHHMMSS(this.getHeartbeatInterval())); | |
183 | } else if (this.heartbeatSetInterval) { | |
54b1efe0 | 184 | logger.info(this.logPrefix() + ' Heartbeat already started every ' + Utils.milliSecondsToHHMMSS(this.getHeartbeatInterval())); |
c0560973 JB |
185 | } else { |
186 | logger.error(`${this.logPrefix()} Heartbeat interval set to ${this.getHeartbeatInterval() ? Utils.milliSecondsToHHMMSS(this.getHeartbeatInterval()) : this.getHeartbeatInterval()}, not starting the heartbeat`); | |
187 | } | |
188 | } | |
189 | ||
190 | public restartHeartbeat(): void { | |
191 | // Stop heartbeat | |
192 | this.stopHeartbeat(); | |
193 | // Start heartbeat | |
194 | this.startHeartbeat(); | |
195 | } | |
196 | ||
197 | public startMeterValues(connectorId: number, interval: number): void { | |
198 | if (connectorId === 0) { | |
199 | logger.error(`${this.logPrefix()} Trying to start MeterValues on connector Id ${connectorId.toString()}`); | |
200 | return; | |
201 | } | |
202 | if (!this.getConnector(connectorId)) { | |
203 | logger.error(`${this.logPrefix()} Trying to start MeterValues on non existing connector Id ${connectorId.toString()}`); | |
204 | return; | |
205 | } | |
206 | if (!this.getConnector(connectorId)?.transactionStarted) { | |
207 | logger.error(`${this.logPrefix()} Trying to start MeterValues on connector Id ${connectorId} with no transaction started`); | |
208 | return; | |
209 | } else if (this.getConnector(connectorId)?.transactionStarted && !this.getConnector(connectorId)?.transactionId) { | |
210 | logger.error(`${this.logPrefix()} Trying to start MeterValues on connector Id ${connectorId} with no transaction id`); | |
211 | return; | |
212 | } | |
213 | if (interval > 0) { | |
71623267 JB |
214 | // eslint-disable-next-line @typescript-eslint/no-misused-promises |
215 | this.getConnector(connectorId).transactionSetInterval = setInterval(async (): Promise<void> => { | |
c0560973 JB |
216 | if (this.getEnableStatistics()) { |
217 | const sendMeterValues = performance.timerify(this.ocppRequestService.sendMeterValues); | |
218 | this.performanceObserver.observe({ | |
219 | entryTypes: ['function'], | |
220 | }); | |
221 | await sendMeterValues(connectorId, this.getConnector(connectorId).transactionId, interval, this.ocppRequestService); | |
222 | } else { | |
223 | await this.ocppRequestService.sendMeterValues(connectorId, this.getConnector(connectorId).transactionId, interval, this.ocppRequestService); | |
224 | } | |
225 | }, interval); | |
226 | } else { | |
eb87fe87 | 227 | logger.error(`${this.logPrefix()} Charging station ${StandardParametersKey.MeterValueSampleInterval} configuration set to ${interval ? Utils.milliSecondsToHHMMSS(interval) : interval}, not sending MeterValues`); |
c0560973 JB |
228 | } |
229 | } | |
230 | ||
231 | public start(): void { | |
232 | this.openWSConnection(); | |
233 | // Monitor authorization file | |
234 | this.startAuthorizationFileMonitoring(); | |
235 | // Monitor station template file | |
236 | this.startStationTemplateFileMonitoring(); | |
237 | // Handle Socket incoming messages | |
238 | this.wsConnection.on('message', this.onMessage.bind(this)); | |
239 | // Handle Socket error | |
240 | this.wsConnection.on('error', this.onError.bind(this)); | |
241 | // Handle Socket close | |
242 | this.wsConnection.on('close', this.onClose.bind(this)); | |
243 | // Handle Socket opening connection | |
244 | this.wsConnection.on('open', this.onOpen.bind(this)); | |
245 | // Handle Socket ping | |
246 | this.wsConnection.on('ping', this.onPing.bind(this)); | |
247 | // Handle Socket pong | |
248 | this.wsConnection.on('pong', this.onPong.bind(this)); | |
249 | } | |
250 | ||
251 | public async stop(reason: StopTransactionReason = StopTransactionReason.NONE): Promise<void> { | |
252 | // Stop message sequence | |
253 | await this.stopMessageSequence(reason); | |
254 | for (const connector in this.connectors) { | |
255 | if (Utils.convertToInt(connector) > 0) { | |
256 | await this.ocppRequestService.sendStatusNotification(Utils.convertToInt(connector), ChargePointStatus.UNAVAILABLE); | |
257 | this.getConnector(Utils.convertToInt(connector)).status = ChargePointStatus.UNAVAILABLE; | |
258 | } | |
259 | } | |
260 | if (this.isWebSocketOpen()) { | |
261 | this.wsConnection.close(); | |
262 | } | |
263 | this.bootNotificationResponse = null; | |
264 | this.hasStopped = true; | |
265 | } | |
266 | ||
6e0964c8 JB |
267 | public getConfigurationKey(key: string | StandardParametersKey, caseInsensitive = false): ConfigurationKey | undefined { |
268 | const configurationKey: ConfigurationKey | undefined = this.configuration.configurationKey.find((configElement) => { | |
c0560973 JB |
269 | if (caseInsensitive) { |
270 | return configElement.key.toLowerCase() === key.toLowerCase(); | |
271 | } | |
272 | return configElement.key === key; | |
273 | }); | |
274 | return configurationKey; | |
275 | } | |
276 | ||
277 | public addConfigurationKey(key: string | StandardParametersKey, value: string, readonly = false, visible = true, reboot = false): void { | |
278 | const keyFound = this.getConfigurationKey(key); | |
279 | if (!keyFound) { | |
280 | this.configuration.configurationKey.push({ | |
281 | key, | |
282 | readonly, | |
283 | value, | |
284 | visible, | |
285 | reboot, | |
286 | }); | |
287 | } else { | |
288 | logger.error(`${this.logPrefix()} Trying to add an already existing configuration key: %j`, keyFound); | |
289 | } | |
290 | } | |
291 | ||
292 | public setConfigurationKeyValue(key: string | StandardParametersKey, value: string): void { | |
293 | const keyFound = this.getConfigurationKey(key); | |
294 | if (keyFound) { | |
295 | const keyIndex = this.configuration.configurationKey.indexOf(keyFound); | |
296 | this.configuration.configurationKey[keyIndex].value = value; | |
297 | } else { | |
298 | logger.error(`${this.logPrefix()} Trying to set a value on a non existing configuration key: %j`, { key, value }); | |
299 | } | |
300 | } | |
301 | ||
302 | public setChargingProfile(connectorId: number, cp: ChargingProfile): boolean { | |
303 | if (!Utils.isEmptyArray(this.getConnector(connectorId).chargingProfiles)) { | |
6e0964c8 | 304 | this.getConnector(connectorId).chargingProfiles?.forEach((chargingProfile: ChargingProfile, index: number) => { |
c0560973 JB |
305 | if (chargingProfile.chargingProfileId === cp.chargingProfileId |
306 | || (chargingProfile.stackLevel === cp.stackLevel && chargingProfile.chargingProfilePurpose === cp.chargingProfilePurpose)) { | |
307 | this.getConnector(connectorId).chargingProfiles[index] = cp; | |
308 | return true; | |
309 | } | |
310 | }); | |
311 | } | |
6e0964c8 | 312 | this.getConnector(connectorId).chargingProfiles?.push(cp); |
c0560973 JB |
313 | return true; |
314 | } | |
315 | ||
316 | public resetTransactionOnConnector(connectorId: number): void { | |
317 | this.initTransactionOnConnector(connectorId); | |
dd119a6b | 318 | this.stopMeterValues(connectorId); |
2e6f5966 JB |
319 | } |
320 | ||
77f00f84 | 321 | public addToMessageQueue(message: string): void { |
3ba2381e | 322 | let dups = false; |
cb31c873 | 323 | // Handle dups in message queue |
3ba2381e | 324 | for (const bufferedMessage of this.messageQueue) { |
cb31c873 | 325 | // Message already in the queue |
3ba2381e JB |
326 | if (message === bufferedMessage) { |
327 | dups = true; | |
328 | break; | |
329 | } | |
330 | } | |
331 | if (!dups) { | |
cb31c873 | 332 | // Queue message |
3ba2381e JB |
333 | this.messageQueue.push(message); |
334 | } | |
335 | } | |
336 | ||
77f00f84 JB |
337 | private flushMessageQueue() { |
338 | if (!Utils.isEmptyArray(this.messageQueue)) { | |
339 | this.messageQueue.forEach((message, index) => { | |
340 | this.messageQueue.splice(index, 1); | |
341 | this.wsConnection.send(message); | |
342 | }); | |
343 | } | |
344 | } | |
345 | ||
c0560973 | 346 | private getChargingStationId(stationTemplate: ChargingStationTemplate): string { |
ef6076c1 J |
347 | // In case of multiple instances: add instance index to charging station id |
348 | let instanceIndex = process.env.CF_INSTANCE_INDEX ? process.env.CF_INSTANCE_INDEX : 0; | |
349 | instanceIndex = instanceIndex > 0 ? instanceIndex : ''; | |
5fdab605 | 350 | const idSuffix = stationTemplate.nameSuffix ? stationTemplate.nameSuffix : ''; |
ad2f27c3 | 351 | return stationTemplate.fixedName ? stationTemplate.baseName : stationTemplate.baseName + '-' + instanceIndex.toString() + ('000000000' + this.index.toString()).substr(('000000000' + this.index.toString()).length - 4) + idSuffix; |
5ad8570f JB |
352 | } |
353 | ||
c0560973 | 354 | private buildStationInfo(): ChargingStationInfo { |
9ac86a7e | 355 | let stationTemplateFromFile: ChargingStationTemplate; |
5ad8570f JB |
356 | try { |
357 | // Load template file | |
ad2f27c3 | 358 | const fileDescriptor = fs.openSync(this.stationTemplateFile, 'r'); |
9ac86a7e | 359 | stationTemplateFromFile = JSON.parse(fs.readFileSync(fileDescriptor, 'utf8')) as ChargingStationTemplate; |
5ad8570f JB |
360 | fs.closeSync(fileDescriptor); |
361 | } catch (error) { | |
ad2f27c3 | 362 | logger.error('Template file ' + this.stationTemplateFile + ' loading error: %j', error); |
cdd9fed5 | 363 | throw error; |
5ad8570f | 364 | } |
9ac86a7e | 365 | const stationInfo: ChargingStationInfo = stationTemplateFromFile || {} as ChargingStationInfo; |
0a60c33c | 366 | if (!Utils.isEmptyArray(stationTemplateFromFile.power)) { |
9ac86a7e JB |
367 | stationTemplateFromFile.power = stationTemplateFromFile.power as number[]; |
368 | stationInfo.maxPower = stationTemplateFromFile.power[Math.floor(Math.random() * stationTemplateFromFile.power.length)]; | |
5ad8570f | 369 | } else { |
9ac86a7e | 370 | stationInfo.maxPower = stationTemplateFromFile.power as number; |
5ad8570f | 371 | } |
c0560973 | 372 | stationInfo.chargingStationId = this.getChargingStationId(stationTemplateFromFile); |
9ac86a7e JB |
373 | stationInfo.resetTime = stationTemplateFromFile.resetTime ? stationTemplateFromFile.resetTime * 1000 : Constants.CHARGING_STATION_DEFAULT_RESET_TIME; |
374 | return stationInfo; | |
5ad8570f JB |
375 | } |
376 | ||
c0560973 JB |
377 | private getOCPPVersion(): OCPPVersion { |
378 | return this.stationInfo.ocppVersion ? this.stationInfo.ocppVersion : OCPPVersion.VERSION_16; | |
379 | } | |
380 | ||
381 | private handleUnsupportedVersion(version: OCPPVersion) { | |
382 | const errMsg = `${this.logPrefix()} Unsupported protocol version '${version}' configured in template file ${this.stationTemplateFile}`; | |
383 | logger.error(errMsg); | |
384 | throw new Error(errMsg); | |
385 | } | |
386 | ||
387 | private initialize(): void { | |
388 | this.stationInfo = this.buildStationInfo(); | |
ad2f27c3 JB |
389 | this.bootNotificationRequest = { |
390 | chargePointModel: this.stationInfo.chargePointModel, | |
391 | chargePointVendor: this.stationInfo.chargePointVendor, | |
392 | ...!Utils.isUndefined(this.stationInfo.chargeBoxSerialNumberPrefix) && { chargeBoxSerialNumber: this.stationInfo.chargeBoxSerialNumberPrefix }, | |
393 | ...!Utils.isUndefined(this.stationInfo.firmwareVersion) && { firmwareVersion: this.stationInfo.firmwareVersion }, | |
2e6f5966 | 394 | }; |
c0560973 JB |
395 | this.configuration = this.getTemplateChargingStationConfiguration(); |
396 | this.supervisionUrl = this.getSupervisionURL(); | |
ad2f27c3 | 397 | this.wsConnectionUrl = this.supervisionUrl + '/' + this.stationInfo.chargingStationId; |
0a60c33c | 398 | // Build connectors if needed |
c0560973 | 399 | const maxConnectors = this.getMaxNumberOfConnectors(); |
6ecb15e4 | 400 | if (maxConnectors <= 0) { |
c0560973 | 401 | logger.warn(`${this.logPrefix()} Charging station template ${this.stationTemplateFile} with ${maxConnectors} connectors`); |
7abfea5f | 402 | } |
c0560973 | 403 | const templateMaxConnectors = this.getTemplateMaxNumberOfConnectors(); |
7abfea5f | 404 | if (templateMaxConnectors <= 0) { |
c0560973 | 405 | logger.warn(`${this.logPrefix()} Charging station template ${this.stationTemplateFile} with no connector configuration`); |
593cf3f9 | 406 | } |
ad2f27c3 | 407 | if (!this.stationInfo.Connectors[0]) { |
c0560973 | 408 | logger.warn(`${this.logPrefix()} Charging station template ${this.stationTemplateFile} with no connector Id 0 configuration`); |
7abfea5f JB |
409 | } |
410 | // Sanity check | |
ad2f27c3 | 411 | if (maxConnectors > (this.stationInfo.Connectors[0] ? templateMaxConnectors - 1 : templateMaxConnectors) && !this.stationInfo.randomConnectors) { |
c0560973 | 412 | logger.warn(`${this.logPrefix()} Number of connectors exceeds the number of connector configurations in template ${this.stationTemplateFile}, forcing random connector configurations affectation`); |
ad2f27c3 | 413 | this.stationInfo.randomConnectors = true; |
6ecb15e4 | 414 | } |
ad2f27c3 | 415 | const connectorsConfigHash = crypto.createHash('sha256').update(JSON.stringify(this.stationInfo.Connectors) + maxConnectors.toString()).digest('hex'); |
de1f5008 | 416 | // FIXME: Handle shrinking the number of connectors |
ad2f27c3 JB |
417 | if (!this.connectors || (this.connectors && this.connectorsConfigurationHash !== connectorsConfigHash)) { |
418 | this.connectorsConfigurationHash = connectorsConfigHash; | |
7abfea5f | 419 | // Add connector Id 0 |
6af9012e | 420 | let lastConnector = '0'; |
ad2f27c3 | 421 | for (lastConnector in this.stationInfo.Connectors) { |
c0560973 | 422 | if (Utils.convertToInt(lastConnector) === 0 && this.getUseConnectorId0() && this.stationInfo.Connectors[lastConnector]) { |
ad2f27c3 JB |
423 | this.connectors[lastConnector] = Utils.cloneObject<Connector>(this.stationInfo.Connectors[lastConnector]); |
424 | this.connectors[lastConnector].availability = AvailabilityType.OPERATIVE; | |
418106c8 JB |
425 | if (Utils.isUndefined(this.connectors[lastConnector]?.chargingProfiles)) { |
426 | this.connectors[lastConnector].chargingProfiles = []; | |
427 | } | |
0a60c33c JB |
428 | } |
429 | } | |
0a60c33c | 430 | // Generate all connectors |
ad2f27c3 | 431 | if ((this.stationInfo.Connectors[0] ? templateMaxConnectors - 1 : templateMaxConnectors) > 0) { |
7abfea5f | 432 | for (let index = 1; index <= maxConnectors; index++) { |
ad2f27c3 JB |
433 | const randConnectorID = this.stationInfo.randomConnectors ? Utils.getRandomInt(Utils.convertToInt(lastConnector), 1) : index; |
434 | this.connectors[index] = Utils.cloneObject<Connector>(this.stationInfo.Connectors[randConnectorID]); | |
435 | this.connectors[index].availability = AvailabilityType.OPERATIVE; | |
418106c8 JB |
436 | if (Utils.isUndefined(this.connectors[lastConnector]?.chargingProfiles)) { |
437 | this.connectors[index].chargingProfiles = []; | |
438 | } | |
7abfea5f | 439 | } |
0a60c33c JB |
440 | } |
441 | } | |
d4a73fb7 | 442 | // Avoid duplication of connectors related information |
ad2f27c3 | 443 | delete this.stationInfo.Connectors; |
0a60c33c | 444 | // Initialize transaction attributes on connectors |
ad2f27c3 | 445 | for (const connector in this.connectors) { |
593cf3f9 | 446 | if (Utils.convertToInt(connector) > 0 && !this.getConnector(Utils.convertToInt(connector)).transactionStarted) { |
c0560973 | 447 | this.initTransactionOnConnector(Utils.convertToInt(connector)); |
0a60c33c JB |
448 | } |
449 | } | |
c0560973 JB |
450 | switch (this.getOCPPVersion()) { |
451 | case OCPPVersion.VERSION_16: | |
452 | this.ocppIncomingRequestService = new OCPP16IncomingRequestService(this); | |
453 | this.ocppRequestService = new OCPP16RequestService(this, new OCPP16ResponseService(this)); | |
454 | break; | |
455 | default: | |
456 | this.handleUnsupportedVersion(this.getOCPPVersion()); | |
457 | break; | |
458 | } | |
7abfea5f | 459 | // OCPP parameters |
c0560973 JB |
460 | this.addConfigurationKey(StandardParametersKey.NumberOfConnectors, this.getNumberOfConnectors().toString(), true); |
461 | if (!this.getConfigurationKey(StandardParametersKey.MeterValuesSampledData)) { | |
462 | this.addConfigurationKey(StandardParametersKey.MeterValuesSampledData, MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER); | |
7abfea5f | 463 | } |
c0560973 | 464 | this.stationInfo.powerDivider = this.getPowerDivider(); |
8bce55bf | 465 | if (this.getEnableStatistics()) { |
54b1efe0 | 466 | this.performanceStatistics = new PerformanceStatistics(this.stationInfo.chargingStationId); |
ad2f27c3 | 467 | this.performanceObserver = new PerformanceObserver((list) => { |
8bce55bf | 468 | const entry = list.getEntries()[0]; |
54b1efe0 | 469 | this.performanceStatistics.logPerformance(entry, Constants.ENTITY_CHARGING_STATION); |
ad2f27c3 | 470 | this.performanceObserver.disconnect(); |
8bce55bf JB |
471 | }); |
472 | } | |
7dde0b73 JB |
473 | } |
474 | ||
c0560973 JB |
475 | private async onOpen(): Promise<void> { |
476 | logger.info(`${this.logPrefix()} Is connected to server through ${this.wsConnectionUrl}`); | |
477 | if (!this.isRegistered()) { | |
478 | // Send BootNotification | |
479 | let registrationRetryCount = 0; | |
480 | do { | |
43d673d9 JB |
481 | this.bootNotificationResponse = await this.ocppRequestService.sendBootNotification(this.bootNotificationRequest.chargePointModel, |
482 | this.bootNotificationRequest.chargePointVendor, this.bootNotificationRequest.chargeBoxSerialNumber, this.bootNotificationRequest.firmwareVersion); | |
c0560973 JB |
483 | if (!this.isRegistered()) { |
484 | registrationRetryCount++; | |
485 | await Utils.sleep(this.bootNotificationResponse?.interval ? this.bootNotificationResponse.interval * 1000 : Constants.OCPP_DEFAULT_BOOT_NOTIFICATION_INTERVAL); | |
486 | } | |
487 | } while (!this.isRegistered() && (registrationRetryCount <= this.getRegistrationMaxRetries() || this.getRegistrationMaxRetries() === -1)); | |
c7db4718 JB |
488 | } |
489 | if (this.isRegistered()) { | |
c0560973 | 490 | await this.startMessageSequence(); |
3ba49ba9 | 491 | this.hasStopped && (this.hasStopped = false); |
c0560973 | 492 | if (this.hasSocketRestarted && this.isWebSocketOpen()) { |
77f00f84 | 493 | this.flushMessageQueue(); |
2e6f5966 JB |
494 | } |
495 | } else { | |
c0560973 | 496 | logger.error(`${this.logPrefix()} Registration failure: max retries reached (${this.getRegistrationMaxRetries()}) or retry disabled (${this.getRegistrationMaxRetries()})`); |
2e6f5966 | 497 | } |
c0560973 JB |
498 | this.autoReconnectRetryCount = 0; |
499 | this.hasSocketRestarted = false; | |
2e6f5966 JB |
500 | } |
501 | ||
6e0964c8 | 502 | private async onClose(closeEvent: any): Promise<void> { |
c0560973 JB |
503 | switch (closeEvent) { |
504 | case WebSocketCloseEventStatusCode.CLOSE_NORMAL: // Normal close | |
505 | case WebSocketCloseEventStatusCode.CLOSE_NO_STATUS: | |
506 | logger.info(`${this.logPrefix()} Socket normally closed with status '${Utils.getWebSocketCloseEventStatusString(closeEvent)}'`); | |
507 | this.autoReconnectRetryCount = 0; | |
508 | break; | |
509 | default: // Abnormal close | |
510 | logger.error(`${this.logPrefix()} Socket abnormally closed with status '${Utils.getWebSocketCloseEventStatusString(closeEvent)}'`); | |
511 | await this.reconnect(closeEvent); | |
512 | break; | |
513 | } | |
2e6f5966 JB |
514 | } |
515 | ||
c0560973 JB |
516 | private async onMessage(messageEvent: MessageEvent): Promise<void> { |
517 | let [messageType, messageId, commandName, commandPayload, errorDetails]: IncomingRequest = [0, '', '' as IncomingRequestCommand, {}, {}]; | |
193d2c0a | 518 | let responseCallback: (payload: Record<string, unknown> | string, requestPayload: Record<string, unknown>) => void; |
c0560973 JB |
519 | let rejectCallback: (error: OCPPError) => void; |
520 | let requestPayload: Record<string, unknown>; | |
521 | let errMsg: string; | |
522 | try { | |
523 | // Parse the message | |
524 | [messageType, messageId, commandName, commandPayload, errorDetails] = JSON.parse(messageEvent.toString()) as IncomingRequest; | |
5ad8570f | 525 | |
c0560973 JB |
526 | // Check the Type of message |
527 | switch (messageType) { | |
528 | // Incoming Message | |
529 | case MessageType.CALL_MESSAGE: | |
530 | if (this.getEnableStatistics()) { | |
54b1efe0 | 531 | this.performanceStatistics.addMessage(commandName, messageType); |
c0560973 JB |
532 | } |
533 | // Process the call | |
534 | await this.ocppIncomingRequestService.handleRequest(messageId, commandName, commandPayload); | |
535 | break; | |
536 | // Outcome Message | |
537 | case MessageType.CALL_RESULT_MESSAGE: | |
538 | // Respond | |
539 | if (Utils.isIterable(this.requests[messageId])) { | |
540 | [responseCallback, , requestPayload] = this.requests[messageId]; | |
541 | } else { | |
542 | throw new Error(`Response request for message id ${messageId} is not iterable`); | |
543 | } | |
544 | if (!responseCallback) { | |
545 | // Error | |
546 | throw new Error(`Response request for unknown message id ${messageId}`); | |
547 | } | |
548 | delete this.requests[messageId]; | |
549 | responseCallback(commandName, requestPayload); | |
550 | break; | |
551 | // Error Message | |
552 | case MessageType.CALL_ERROR_MESSAGE: | |
553 | if (!this.requests[messageId]) { | |
554 | // Error | |
555 | throw new Error(`Error request for unknown message id ${messageId}`); | |
556 | } | |
557 | if (Utils.isIterable(this.requests[messageId])) { | |
558 | [, rejectCallback] = this.requests[messageId]; | |
559 | } else { | |
560 | throw new Error(`Error request for message id ${messageId} is not iterable`); | |
561 | } | |
562 | delete this.requests[messageId]; | |
563 | rejectCallback(new OCPPError(commandName, commandPayload.toString(), errorDetails)); | |
564 | break; | |
565 | // Error | |
566 | default: | |
567 | errMsg = `${this.logPrefix()} Wrong message type ${messageType}`; | |
568 | logger.error(errMsg); | |
569 | throw new Error(errMsg); | |
570 | } | |
571 | } catch (error) { | |
572 | // Log | |
573 | logger.error('%s Incoming message %j processing error %j on request content type %j', this.logPrefix(), messageEvent, error, this.requests[messageId]); | |
574 | // Send error | |
575 | messageType !== MessageType.CALL_ERROR_MESSAGE && await this.ocppRequestService.sendError(messageId, error, commandName); | |
576 | } | |
2328be1e JB |
577 | } |
578 | ||
c0560973 JB |
579 | private onPing(): void { |
580 | logger.debug(this.logPrefix() + ' Has received a WS ping (rfc6455) from the server'); | |
581 | } | |
582 | ||
583 | private onPong(): void { | |
584 | logger.debug(this.logPrefix() + ' Has received a WS pong (rfc6455) from the server'); | |
585 | } | |
586 | ||
6e0964c8 | 587 | private async onError(errorEvent: any): Promise<void> { |
c0560973 JB |
588 | logger.error(this.logPrefix() + ' Socket error: %j', errorEvent); |
589 | // pragma switch (errorEvent.code) { | |
590 | // case 'ECONNREFUSED': | |
591 | // await this._reconnect(errorEvent); | |
592 | // break; | |
593 | // } | |
594 | } | |
595 | ||
596 | private getTemplateChargingStationConfiguration(): ChargingStationConfiguration { | |
597 | return this.stationInfo.Configuration ? this.stationInfo.Configuration : {} as ChargingStationConfiguration; | |
598 | } | |
599 | ||
6e0964c8 | 600 | private getAuthorizationFile(): string | undefined { |
bf1866b2 | 601 | return this.stationInfo.authorizationFile && path.join(path.resolve(__dirname, '../'), 'assets', path.basename(this.stationInfo.authorizationFile)); |
c0560973 JB |
602 | } |
603 | ||
604 | private getAuthorizedTags(): string[] { | |
605 | let authorizedTags: string[] = []; | |
606 | const authorizationFile = this.getAuthorizationFile(); | |
607 | if (authorizationFile) { | |
608 | try { | |
609 | // Load authorization file | |
610 | const fileDescriptor = fs.openSync(authorizationFile, 'r'); | |
611 | authorizedTags = JSON.parse(fs.readFileSync(fileDescriptor, 'utf8')) as string[]; | |
612 | fs.closeSync(fileDescriptor); | |
613 | } catch (error) { | |
614 | logger.error(this.logPrefix() + ' Authorization file ' + authorizationFile + ' loading error: %j', error); | |
615 | throw error; | |
616 | } | |
617 | } else { | |
618 | logger.info(this.logPrefix() + ' No authorization file given in template file ' + this.stationTemplateFile); | |
8c4da341 | 619 | } |
c0560973 JB |
620 | return authorizedTags; |
621 | } | |
622 | ||
6e0964c8 | 623 | private getUseConnectorId0(): boolean | undefined { |
c0560973 | 624 | return !Utils.isUndefined(this.stationInfo.useConnectorId0) ? this.stationInfo.useConnectorId0 : true; |
8bce55bf JB |
625 | } |
626 | ||
c0560973 | 627 | private getNumberOfRunningTransactions(): number { |
6ecb15e4 | 628 | let trxCount = 0; |
ad2f27c3 | 629 | for (const connector in this.connectors) { |
593cf3f9 | 630 | if (Utils.convertToInt(connector) > 0 && this.getConnector(Utils.convertToInt(connector)).transactionStarted) { |
6ecb15e4 JB |
631 | trxCount++; |
632 | } | |
633 | } | |
634 | return trxCount; | |
635 | } | |
636 | ||
1f761b9a | 637 | // 0 for disabling |
6e0964c8 | 638 | private getConnectionTimeout(): number | undefined { |
ad2f27c3 JB |
639 | if (!Utils.isUndefined(this.stationInfo.connectionTimeout)) { |
640 | return this.stationInfo.connectionTimeout; | |
3574dfd3 JB |
641 | } |
642 | if (!Utils.isUndefined(Configuration.getConnectionTimeout())) { | |
643 | return Configuration.getConnectionTimeout(); | |
644 | } | |
645 | return 30; | |
646 | } | |
647 | ||
1f761b9a | 648 | // -1 for unlimited, 0 for disabling |
6e0964c8 | 649 | private getAutoReconnectMaxRetries(): number | undefined { |
ad2f27c3 JB |
650 | if (!Utils.isUndefined(this.stationInfo.autoReconnectMaxRetries)) { |
651 | return this.stationInfo.autoReconnectMaxRetries; | |
3574dfd3 JB |
652 | } |
653 | if (!Utils.isUndefined(Configuration.getAutoReconnectMaxRetries())) { | |
654 | return Configuration.getAutoReconnectMaxRetries(); | |
655 | } | |
656 | return -1; | |
657 | } | |
658 | ||
ec977daf | 659 | // 0 for disabling |
6e0964c8 | 660 | private getRegistrationMaxRetries(): number | undefined { |
ad2f27c3 JB |
661 | if (!Utils.isUndefined(this.stationInfo.registrationMaxRetries)) { |
662 | return this.stationInfo.registrationMaxRetries; | |
32a1eb7a JB |
663 | } |
664 | return -1; | |
665 | } | |
666 | ||
c0560973 JB |
667 | private getPowerDivider(): number { |
668 | let powerDivider = this.getNumberOfConnectors(); | |
ad2f27c3 | 669 | if (this.stationInfo.powerSharedByConnectors) { |
c0560973 | 670 | powerDivider = this.getNumberOfRunningTransactions(); |
6ecb15e4 JB |
671 | } |
672 | return powerDivider; | |
673 | } | |
674 | ||
c0560973 | 675 | private getTemplateMaxNumberOfConnectors(): number { |
ad2f27c3 | 676 | return Object.keys(this.stationInfo.Connectors).length; |
7abfea5f JB |
677 | } |
678 | ||
c0560973 | 679 | private getMaxNumberOfConnectors(): number { |
5ad8570f | 680 | let maxConnectors = 0; |
ad2f27c3 JB |
681 | if (!Utils.isEmptyArray(this.stationInfo.numberOfConnectors)) { |
682 | const numberOfConnectors = this.stationInfo.numberOfConnectors as number[]; | |
6ecb15e4 | 683 | // Distribute evenly the number of connectors |
ad2f27c3 JB |
684 | maxConnectors = numberOfConnectors[(this.index - 1) % numberOfConnectors.length]; |
685 | } else if (!Utils.isUndefined(this.stationInfo.numberOfConnectors)) { | |
686 | maxConnectors = this.stationInfo.numberOfConnectors as number; | |
488fd3a7 | 687 | } else { |
c0560973 | 688 | maxConnectors = this.stationInfo.Connectors[0] ? this.getTemplateMaxNumberOfConnectors() - 1 : this.getTemplateMaxNumberOfConnectors(); |
5ad8570f JB |
689 | } |
690 | return maxConnectors; | |
2e6f5966 JB |
691 | } |
692 | ||
c0560973 | 693 | private getNumberOfConnectors(): number { |
ad2f27c3 | 694 | return this.connectors[0] ? Object.keys(this.connectors).length - 1 : Object.keys(this.connectors).length; |
6ecb15e4 JB |
695 | } |
696 | ||
c0560973 | 697 | private async startMessageSequence(): Promise<void> { |
136c90ba | 698 | // Start WebSocket ping |
c0560973 | 699 | this.startWebSocketPing(); |
5ad8570f | 700 | // Start heartbeat |
c0560973 | 701 | this.startHeartbeat(); |
0a60c33c | 702 | // Initialize connectors status |
ad2f27c3 | 703 | for (const connector in this.connectors) { |
593cf3f9 JB |
704 | if (Utils.convertToInt(connector) === 0) { |
705 | continue; | |
ad2f27c3 | 706 | } else if (!this.hasStopped && !this.getConnector(Utils.convertToInt(connector))?.status && this.getConnector(Utils.convertToInt(connector))?.bootStatus) { |
136c90ba | 707 | // Send status in template at startup |
c0560973 JB |
708 | await this.ocppRequestService.sendStatusNotification(Utils.convertToInt(connector), this.getConnector(Utils.convertToInt(connector)).bootStatus); |
709 | this.getConnector(Utils.convertToInt(connector)).status = this.getConnector(Utils.convertToInt(connector)).bootStatus; | |
ad2f27c3 | 710 | } else if (this.hasStopped && this.getConnector(Utils.convertToInt(connector))?.bootStatus) { |
136c90ba | 711 | // Send status in template after reset |
c0560973 JB |
712 | await this.ocppRequestService.sendStatusNotification(Utils.convertToInt(connector), this.getConnector(Utils.convertToInt(connector)).bootStatus); |
713 | this.getConnector(Utils.convertToInt(connector)).status = this.getConnector(Utils.convertToInt(connector)).bootStatus; | |
ad2f27c3 | 714 | } else if (!this.hasStopped && this.getConnector(Utils.convertToInt(connector))?.status) { |
136c90ba | 715 | // Send previous status at template reload |
c0560973 | 716 | await this.ocppRequestService.sendStatusNotification(Utils.convertToInt(connector), this.getConnector(Utils.convertToInt(connector)).status); |
5ad8570f | 717 | } else { |
136c90ba | 718 | // Send default status |
c0560973 JB |
719 | await this.ocppRequestService.sendStatusNotification(Utils.convertToInt(connector), ChargePointStatus.AVAILABLE); |
720 | this.getConnector(Utils.convertToInt(connector)).status = ChargePointStatus.AVAILABLE; | |
5ad8570f JB |
721 | } |
722 | } | |
0a60c33c | 723 | // Start the ATG |
dd119a6b JB |
724 | this.startAutomaticTransactionGenerator(); |
725 | if (this.getEnableStatistics()) { | |
726 | this.performanceStatistics.start(); | |
727 | } | |
728 | } | |
729 | ||
730 | private startAutomaticTransactionGenerator() { | |
ad2f27c3 JB |
731 | if (this.stationInfo.AutomaticTransactionGenerator.enable) { |
732 | if (!this.automaticTransactionGeneration) { | |
733 | this.automaticTransactionGeneration = new AutomaticTransactionGenerator(this); | |
5ad8570f | 734 | } |
ad2f27c3 | 735 | if (this.automaticTransactionGeneration.timeToStop) { |
a1256107 JB |
736 | // The ATG might sleep |
737 | void this.automaticTransactionGeneration.start(); | |
5ad8570f JB |
738 | } |
739 | } | |
5ad8570f JB |
740 | } |
741 | ||
c0560973 | 742 | private async stopMessageSequence(reason: StopTransactionReason = StopTransactionReason.NONE): Promise<void> { |
136c90ba | 743 | // Stop WebSocket ping |
c0560973 | 744 | this.stopWebSocketPing(); |
79411696 | 745 | // Stop heartbeat |
c0560973 | 746 | this.stopHeartbeat(); |
79411696 | 747 | // Stop the ATG |
ad2f27c3 JB |
748 | if (this.stationInfo.AutomaticTransactionGenerator.enable && |
749 | this.automaticTransactionGeneration && | |
750 | !this.automaticTransactionGeneration.timeToStop) { | |
751 | await this.automaticTransactionGeneration.stop(reason); | |
79411696 | 752 | } else { |
ad2f27c3 | 753 | for (const connector in this.connectors) { |
593cf3f9 | 754 | if (Utils.convertToInt(connector) > 0 && this.getConnector(Utils.convertToInt(connector)).transactionStarted) { |
c0560973 JB |
755 | const transactionId = this.getConnector(Utils.convertToInt(connector)).transactionId; |
756 | await this.ocppRequestService.sendStopTransaction(transactionId, this.getTransactionMeterStop(transactionId), this.getTransactionIdTag(transactionId), reason); | |
79411696 JB |
757 | } |
758 | } | |
759 | } | |
760 | } | |
761 | ||
c0560973 | 762 | private startWebSocketPing(): void { |
9cd3dfb0 JB |
763 | const webSocketPingInterval: number = this.getConfigurationKey(StandardParametersKey.WebSocketPingInterval) |
764 | ? Utils.convertToInt(this.getConfigurationKey(StandardParametersKey.WebSocketPingInterval).value) | |
765 | : 0; | |
ad2f27c3 JB |
766 | if (webSocketPingInterval > 0 && !this.webSocketPingSetInterval) { |
767 | this.webSocketPingSetInterval = setInterval(() => { | |
c0560973 | 768 | if (this.isWebSocketOpen()) { |
ad2f27c3 | 769 | this.wsConnection.ping((): void => { }); |
136c90ba JB |
770 | } |
771 | }, webSocketPingInterval * 1000); | |
c0560973 | 772 | logger.info(this.logPrefix() + ' WebSocket ping started every ' + Utils.secondsToHHMMSS(webSocketPingInterval)); |
ad2f27c3 | 773 | } else if (this.webSocketPingSetInterval) { |
c0560973 | 774 | logger.info(this.logPrefix() + ' WebSocket ping every ' + Utils.secondsToHHMMSS(webSocketPingInterval) + ' already started'); |
136c90ba | 775 | } else { |
c0560973 | 776 | logger.error(`${this.logPrefix()} WebSocket ping interval set to ${webSocketPingInterval ? Utils.secondsToHHMMSS(webSocketPingInterval) : webSocketPingInterval}, not starting the WebSocket ping`); |
136c90ba JB |
777 | } |
778 | } | |
779 | ||
c0560973 | 780 | private stopWebSocketPing(): void { |
ad2f27c3 JB |
781 | if (this.webSocketPingSetInterval) { |
782 | clearInterval(this.webSocketPingSetInterval); | |
136c90ba JB |
783 | } |
784 | } | |
785 | ||
c0560973 JB |
786 | private getSupervisionURL(): string { |
787 | const supervisionUrls = Utils.cloneObject<string | string[]>(this.stationInfo.supervisionURL ? this.stationInfo.supervisionURL : Configuration.getSupervisionURLs()); | |
788 | let indexUrl = 0; | |
789 | if (!Utils.isEmptyArray(supervisionUrls)) { | |
790 | if (Configuration.getDistributeStationsToTenantsEqually()) { | |
791 | indexUrl = this.index % supervisionUrls.length; | |
792 | } else { | |
793 | // Get a random url | |
794 | indexUrl = Math.floor(Math.random() * supervisionUrls.length); | |
795 | } | |
796 | return supervisionUrls[indexUrl]; | |
797 | } | |
798 | return supervisionUrls as string; | |
136c90ba JB |
799 | } |
800 | ||
6e0964c8 | 801 | private getHeartbeatInterval(): number | undefined { |
c0560973 JB |
802 | const HeartbeatInterval = this.getConfigurationKey(StandardParametersKey.HeartbeatInterval); |
803 | if (HeartbeatInterval) { | |
804 | return Utils.convertToInt(HeartbeatInterval.value) * 1000; | |
805 | } | |
806 | const HeartBeatInterval = this.getConfigurationKey(StandardParametersKey.HeartBeatInterval); | |
807 | if (HeartBeatInterval) { | |
808 | return Utils.convertToInt(HeartBeatInterval.value) * 1000; | |
0a60c33c JB |
809 | } |
810 | } | |
811 | ||
c0560973 | 812 | private stopHeartbeat(): void { |
ad2f27c3 JB |
813 | if (this.heartbeatSetInterval) { |
814 | clearInterval(this.heartbeatSetInterval); | |
7dde0b73 | 815 | } |
5ad8570f JB |
816 | } |
817 | ||
c0560973 JB |
818 | private openWSConnection(options?: WebSocket.ClientOptions, forceCloseOpened = false): void { |
819 | if (Utils.isUndefined(options)) { | |
820 | options = {} as WebSocket.ClientOptions; | |
821 | } | |
6e0964c8 | 822 | if (Utils.isUndefined(options?.handshakeTimeout)) { |
c0560973 JB |
823 | options.handshakeTimeout = this.getConnectionTimeout() * 1000; |
824 | } | |
825 | if (this.isWebSocketOpen() && forceCloseOpened) { | |
826 | this.wsConnection.close(); | |
827 | } | |
828 | let protocol; | |
829 | switch (this.getOCPPVersion()) { | |
830 | case OCPPVersion.VERSION_16: | |
831 | protocol = 'ocpp' + OCPPVersion.VERSION_16; | |
832 | break; | |
833 | default: | |
834 | this.handleUnsupportedVersion(this.getOCPPVersion()); | |
835 | break; | |
836 | } | |
837 | this.wsConnection = new WebSocket(this.wsConnectionUrl, protocol, options); | |
838 | logger.info(this.logPrefix() + ' Will communicate through URL ' + this.supervisionUrl); | |
136c90ba JB |
839 | } |
840 | ||
dd119a6b JB |
841 | private stopMeterValues(connectorId: number) { |
842 | if (this.getConnector(connectorId)?.transactionSetInterval) { | |
843 | clearInterval(this.getConnector(connectorId).transactionSetInterval); | |
844 | } | |
845 | } | |
846 | ||
c0560973 JB |
847 | private startAuthorizationFileMonitoring(): void { |
848 | fs.watch(this.getAuthorizationFile()).on('change', (e) => { | |
5ad8570f | 849 | try { |
c0560973 | 850 | logger.debug(this.logPrefix() + ' Authorization file ' + this.getAuthorizationFile() + ' have changed, reload'); |
adeb9b56 | 851 | // Initialize authorizedTags |
c0560973 | 852 | this.authorizedTags = this.getAuthorizedTags(); |
5ad8570f | 853 | } catch (error) { |
c0560973 | 854 | logger.error(this.logPrefix() + ' Authorization file monitoring error: %j', error); |
5ad8570f JB |
855 | } |
856 | }); | |
857 | } | |
858 | ||
c0560973 | 859 | private startStationTemplateFileMonitoring(): void { |
71623267 | 860 | // eslint-disable-next-line @typescript-eslint/no-misused-promises |
e268356b | 861 | fs.watch(this.stationTemplateFile).on('change', async (e): Promise<void> => { |
5ad8570f | 862 | try { |
c0560973 | 863 | logger.debug(this.logPrefix() + ' Template file ' + this.stationTemplateFile + ' have changed, reload'); |
5ad8570f | 864 | // Initialize |
c0560973 | 865 | this.initialize(); |
ef6076c1 | 866 | // Stop the ATG |
ad2f27c3 JB |
867 | if (!this.stationInfo.AutomaticTransactionGenerator.enable && |
868 | this.automaticTransactionGeneration) { | |
e268356b | 869 | await this.automaticTransactionGeneration.stop(); |
79411696 | 870 | } |
ef6076c1 | 871 | // Start the ATG |
dd119a6b | 872 | this.startAutomaticTransactionGenerator(); |
136c90ba | 873 | // FIXME?: restart heartbeat and WebSocket ping when their interval values have changed |
5ad8570f | 874 | } catch (error) { |
c0560973 | 875 | logger.error(this.logPrefix() + ' Charging station template file monitoring error: %j', error); |
5ad8570f JB |
876 | } |
877 | }); | |
878 | } | |
879 | ||
6e0964c8 | 880 | private getReconnectExponentialDelay(): boolean | undefined { |
c0560973 | 881 | return !Utils.isUndefined(this.stationInfo.reconnectExponentialDelay) ? this.stationInfo.reconnectExponentialDelay : false; |
5ad8570f JB |
882 | } |
883 | ||
6e0964c8 | 884 | private async reconnect(error: any): Promise<void> { |
136c90ba | 885 | // Stop heartbeat |
c0560973 | 886 | this.stopHeartbeat(); |
5ad8570f | 887 | // Stop the ATG if needed |
ad2f27c3 JB |
888 | if (this.stationInfo.AutomaticTransactionGenerator.enable && |
889 | this.stationInfo.AutomaticTransactionGenerator.stopOnConnectionFailure && | |
890 | this.automaticTransactionGeneration && | |
891 | !this.automaticTransactionGeneration.timeToStop) { | |
dd119a6b | 892 | await this.automaticTransactionGeneration.stop(); |
ad2f27c3 | 893 | } |
c0560973 | 894 | if (this.autoReconnectRetryCount < this.getAutoReconnectMaxRetries() || this.getAutoReconnectMaxRetries() === -1) { |
ad2f27c3 | 895 | this.autoReconnectRetryCount++; |
c0560973 JB |
896 | const reconnectDelay = (this.getReconnectExponentialDelay() ? Utils.exponentialDelay(this.autoReconnectRetryCount) : this.getConnectionTimeout() * 1000); |
897 | logger.error(`${this.logPrefix()} Socket: connection retry in ${Utils.roundTo(reconnectDelay, 2)}ms, timeout ${reconnectDelay - 100}ms`); | |
032d6efc | 898 | await Utils.sleep(reconnectDelay); |
c0560973 JB |
899 | logger.error(this.logPrefix() + ' Socket: reconnecting try #' + this.autoReconnectRetryCount.toString()); |
900 | this.openWSConnection({ handshakeTimeout: reconnectDelay - 100 }); | |
ad2f27c3 | 901 | this.hasSocketRestarted = true; |
c0560973 JB |
902 | } else if (this.getAutoReconnectMaxRetries() !== -1) { |
903 | logger.error(`${this.logPrefix()} Socket reconnect failure: max retries reached (${this.autoReconnectRetryCount}) or retry disabled (${this.getAutoReconnectMaxRetries()})`); | |
5ad8570f JB |
904 | } |
905 | } | |
906 | ||
c0560973 | 907 | private initTransactionOnConnector(connectorId: number): void { |
8bce55bf | 908 | this.getConnector(connectorId).transactionStarted = false; |
6e0964c8 JB |
909 | delete this.getConnector(connectorId).transactionId; |
910 | delete this.getConnector(connectorId).idTag; | |
8bce55bf | 911 | this.getConnector(connectorId).lastEnergyActiveImportRegisterValue = -1; |
0a60c33c | 912 | } |
7dde0b73 JB |
913 | } |
914 |