Commit | Line | Data |
---|---|---|
b4d34251 JB |
1 | // Partial Copyright Jerome Benoit. 2021. All Rights Reserved. |
2 | ||
32b02249 | 3 | import { AvailabilityType, BootNotificationRequest, CachedRequest, IncomingRequest, IncomingRequestCommand, RequestCommand } from '../types/ocpp/Requests'; |
efa43e52 | 4 | import { BootNotificationResponse, RegistrationStatus } from '../types/ocpp/Responses'; |
e118beaa | 5 | import ChargingStationConfiguration, { ConfigurationKey } from '../types/ChargingStationConfiguration'; |
4c2b4904 | 6 | import ChargingStationTemplate, { CurrentType, PowerUnits, Voltage } from '../types/ChargingStationTemplate'; |
7e1dc878 | 7 | import { ConnectorPhaseRotation, StandardParametersKey, SupportedFeatureProfiles } from '../types/ocpp/Configuration'; |
734d790d | 8 | import { ConnectorStatus, SampledValueTemplate } from '../types/Connectors'; |
9ccca265 | 9 | import { MeterValueMeasurand, MeterValuePhase } from '../types/ocpp/MeterValues'; |
16b0d4e7 | 10 | import { WSError, WebSocketCloseEventStatusCode } from '../types/WebSocket'; |
58fad749 | 11 | import WebSocket, { ClientOptions, Data, OPEN } from 'ws'; |
3f40bc9c | 12 | |
6af9012e | 13 | import AutomaticTransactionGenerator from './AutomaticTransactionGenerator'; |
c0560973 JB |
14 | import { ChargePointStatus } from '../types/ocpp/ChargePointStatus'; |
15 | import { ChargingProfile } from '../types/ocpp/ChargingProfile'; | |
9ac86a7e | 16 | import ChargingStationInfo from '../types/ChargingStationInfo'; |
15042c5f | 17 | import { ClientRequestArgs } from 'http'; |
6af9012e | 18 | import Configuration from '../utils/Configuration'; |
63b48f77 | 19 | import Constants from '../utils/Constants'; |
14763b46 | 20 | import { ErrorType } from '../types/ocpp/ErrorType'; |
23132a44 | 21 | import FileUtils from '../utils/FileUtils'; |
d2a64eb5 | 22 | import { MessageType } from '../types/ocpp/MessageType'; |
e7171280 | 23 | import OCPP16IncomingRequestService from './ocpp/1.6/OCPP16IncomingRequestService'; |
c0560973 JB |
24 | import OCPP16RequestService from './ocpp/1.6/OCPP16RequestService'; |
25 | import OCPP16ResponseService from './ocpp/1.6/OCPP16ResponseService'; | |
14763b46 | 26 | import OCPPError from './ocpp/OCPPError'; |
c0560973 JB |
27 | import OCPPIncomingRequestService from './ocpp/OCPPIncomingRequestService'; |
28 | import OCPPRequestService from './ocpp/OCPPRequestService'; | |
29 | import { OCPPVersion } from '../types/ocpp/OCPPVersion'; | |
a6b3c6c3 | 30 | import PerformanceStatistics from '../performance/PerformanceStatistics'; |
c0560973 | 31 | import { StopTransactionReason } from '../types/ocpp/Transaction'; |
57939a9d | 32 | import { URL } from 'url'; |
6af9012e | 33 | import Utils from '../utils/Utils'; |
3f40bc9c JB |
34 | import crypto from 'crypto'; |
35 | import fs from 'fs'; | |
6af9012e | 36 | import logger from '../utils/Logger'; |
bf1866b2 | 37 | import path from 'path'; |
3f40bc9c JB |
38 | |
39 | export default class ChargingStation { | |
9e23580d | 40 | public readonly stationTemplateFile: string; |
c0560973 | 41 | public authorizedTags: string[]; |
6e0964c8 | 42 | public stationInfo!: ChargingStationInfo; |
9e23580d | 43 | public readonly connectors: Map<number, ConnectorStatus>; |
6e0964c8 | 44 | public configuration!: ChargingStationConfiguration; |
6e0964c8 | 45 | public wsConnection!: WebSocket; |
9e23580d | 46 | public readonly requests: Map<string, CachedRequest>; |
6e0964c8 JB |
47 | public performanceStatistics!: PerformanceStatistics; |
48 | public heartbeatSetInterval!: NodeJS.Timeout; | |
6e0964c8 | 49 | public ocppRequestService!: OCPPRequestService; |
9e23580d | 50 | private readonly index: number; |
6e0964c8 JB |
51 | private bootNotificationRequest!: BootNotificationRequest; |
52 | private bootNotificationResponse!: BootNotificationResponse | null; | |
53 | private connectorsConfigurationHash!: string; | |
a472cf2b | 54 | private ocppIncomingRequestService!: OCPPIncomingRequestService; |
9e23580d | 55 | private readonly messageQueue: string[]; |
57939a9d | 56 | private wsConnectionUrl!: URL; |
265e4266 | 57 | private wsConnectionRestarted: boolean; |
a472cf2b | 58 | private stopped: boolean; |
ad2f27c3 | 59 | private autoReconnectRetryCount: number; |
265e4266 | 60 | private automaticTransactionGenerator!: AutomaticTransactionGenerator; |
6e0964c8 | 61 | private webSocketPingSetInterval!: NodeJS.Timeout; |
6af9012e JB |
62 | |
63 | constructor(index: number, stationTemplateFile: string) { | |
ad2f27c3 JB |
64 | this.index = index; |
65 | this.stationTemplateFile = stationTemplateFile; | |
734d790d | 66 | this.connectors = new Map<number, ConnectorStatus>(); |
c0560973 | 67 | this.initialize(); |
2e6f5966 | 68 | |
265e4266 JB |
69 | this.stopped = false; |
70 | this.wsConnectionRestarted = false; | |
ad2f27c3 | 71 | this.autoReconnectRetryCount = 0; |
2e6f5966 | 72 | |
32b02249 | 73 | this.requests = new Map<string, CachedRequest>(); |
16b0d4e7 | 74 | this.messageQueue = new Array<string>(); |
2e6f5966 | 75 | |
c0560973 JB |
76 | this.authorizedTags = this.getAuthorizedTags(); |
77 | } | |
78 | ||
79 | public logPrefix(): string { | |
54b1efe0 | 80 | return Utils.logPrefix(` ${this.stationInfo.chargingStationId} |`); |
c0560973 JB |
81 | } |
82 | ||
802cfa13 JB |
83 | public getBootNotificationRequest(): BootNotificationRequest { |
84 | return this.bootNotificationRequest; | |
85 | } | |
86 | ||
f4bf2abd | 87 | public getRandomIdTag(): string { |
c37528f1 | 88 | const index = Math.floor(Utils.secureRandom() * this.authorizedTags.length); |
c0560973 JB |
89 | return this.authorizedTags[index]; |
90 | } | |
91 | ||
92 | public hasAuthorizedTags(): boolean { | |
93 | return !Utils.isEmptyArray(this.authorizedTags); | |
94 | } | |
95 | ||
6e0964c8 | 96 | public getEnableStatistics(): boolean | undefined { |
c0560973 JB |
97 | return !Utils.isUndefined(this.stationInfo.enableStatistics) ? this.stationInfo.enableStatistics : true; |
98 | } | |
99 | ||
a7fc8211 JB |
100 | public getMayAuthorizeAtRemoteStart(): boolean | undefined { |
101 | return this.stationInfo.mayAuthorizeAtRemoteStart ?? true; | |
102 | } | |
103 | ||
6e0964c8 | 104 | public getNumberOfPhases(): number | undefined { |
7decf1b6 | 105 | switch (this.getCurrentOutType()) { |
4c2b4904 | 106 | case CurrentType.AC: |
c0560973 | 107 | return !Utils.isUndefined(this.stationInfo.numberOfPhases) ? this.stationInfo.numberOfPhases : 3; |
4c2b4904 | 108 | case CurrentType.DC: |
c0560973 JB |
109 | return 0; |
110 | } | |
111 | } | |
112 | ||
d5bff457 | 113 | public isWebSocketConnectionOpened(): boolean { |
58fad749 | 114 | return this.wsConnection?.readyState === OPEN; |
c0560973 JB |
115 | } |
116 | ||
117 | public isRegistered(): boolean { | |
118 | return this.bootNotificationResponse?.status === RegistrationStatus.ACCEPTED; | |
119 | } | |
120 | ||
121 | public isChargingStationAvailable(): boolean { | |
734d790d | 122 | return this.getConnectorStatus(0).availability === AvailabilityType.OPERATIVE; |
c0560973 JB |
123 | } |
124 | ||
125 | public isConnectorAvailable(id: number): boolean { | |
734d790d | 126 | return this.getConnectorStatus(id).availability === AvailabilityType.OPERATIVE; |
c0560973 JB |
127 | } |
128 | ||
54544ef1 JB |
129 | public getNumberOfConnectors(): number { |
130 | return this.connectors.get(0) ? this.connectors.size - 1 : this.connectors.size; | |
131 | } | |
132 | ||
734d790d JB |
133 | public getConnectorStatus(id: number): ConnectorStatus { |
134 | return this.connectors.get(id); | |
c0560973 JB |
135 | } |
136 | ||
4c2b4904 JB |
137 | public getCurrentOutType(): CurrentType | undefined { |
138 | return this.stationInfo.currentOutType ?? CurrentType.AC; | |
c0560973 JB |
139 | } |
140 | ||
6e0964c8 | 141 | public getVoltageOut(): number | undefined { |
7decf1b6 | 142 | const errMsg = `${this.logPrefix()} Unknown ${this.getCurrentOutType()} currentOutType in template file ${this.stationTemplateFile}, cannot define default voltage out`; |
c0560973 | 143 | let defaultVoltageOut: number; |
7decf1b6 | 144 | switch (this.getCurrentOutType()) { |
4c2b4904 JB |
145 | case CurrentType.AC: |
146 | defaultVoltageOut = Voltage.VOLTAGE_230; | |
c0560973 | 147 | break; |
4c2b4904 JB |
148 | case CurrentType.DC: |
149 | defaultVoltageOut = Voltage.VOLTAGE_400; | |
c0560973 JB |
150 | break; |
151 | default: | |
152 | logger.error(errMsg); | |
290d006c | 153 | throw new Error(errMsg); |
c0560973 JB |
154 | } |
155 | return !Utils.isUndefined(this.stationInfo.voltageOut) ? this.stationInfo.voltageOut : defaultVoltageOut; | |
156 | } | |
157 | ||
6e0964c8 | 158 | public getTransactionIdTag(transactionId: number): string | undefined { |
734d790d JB |
159 | for (const connectorId of this.connectors.keys()) { |
160 | if (connectorId > 0 && this.getConnectorStatus(connectorId).transactionId === transactionId) { | |
161 | return this.getConnectorStatus(connectorId).transactionIdTag; | |
c0560973 JB |
162 | } |
163 | } | |
164 | } | |
165 | ||
6ed92bc1 JB |
166 | public getOutOfOrderEndMeterValues(): boolean { |
167 | return this.stationInfo.outOfOrderEndMeterValues ?? false; | |
168 | } | |
169 | ||
170 | public getBeginEndMeterValues(): boolean { | |
171 | return this.stationInfo.beginEndMeterValues ?? false; | |
172 | } | |
173 | ||
174 | public getMeteringPerTransaction(): boolean { | |
175 | return this.stationInfo.meteringPerTransaction ?? true; | |
176 | } | |
177 | ||
fd0c36fa JB |
178 | public getTransactionDataMeterValues(): boolean { |
179 | return this.stationInfo.transactionDataMeterValues ?? false; | |
180 | } | |
181 | ||
9ccca265 JB |
182 | public getMainVoltageMeterValues(): boolean { |
183 | return this.stationInfo.mainVoltageMeterValues ?? true; | |
184 | } | |
185 | ||
6b10669b JB |
186 | public getPhaseLineToLineVoltageMeterValues(): boolean { |
187 | return this.stationInfo.phaseLineToLineVoltageMeterValues ?? false; | |
9bd87386 JB |
188 | } |
189 | ||
6ed92bc1 JB |
190 | public getEnergyActiveImportRegisterByTransactionId(transactionId: number): number | undefined { |
191 | if (this.getMeteringPerTransaction()) { | |
734d790d JB |
192 | for (const connectorId of this.connectors.keys()) { |
193 | if (connectorId > 0 && this.getConnectorStatus(connectorId).transactionId === transactionId) { | |
194 | return this.getConnectorStatus(connectorId).transactionEnergyActiveImportRegisterValue; | |
6ed92bc1 JB |
195 | } |
196 | } | |
197 | } | |
734d790d JB |
198 | for (const connectorId of this.connectors.keys()) { |
199 | if (connectorId > 0 && this.getConnectorStatus(connectorId).transactionId === transactionId) { | |
200 | return this.getConnectorStatus(connectorId).energyActiveImportRegisterValue; | |
c0560973 JB |
201 | } |
202 | } | |
203 | } | |
204 | ||
6ed92bc1 JB |
205 | public getEnergyActiveImportRegisterByConnectorId(connectorId: number): number | undefined { |
206 | if (this.getMeteringPerTransaction()) { | |
734d790d | 207 | return this.getConnectorStatus(connectorId).transactionEnergyActiveImportRegisterValue; |
6ed92bc1 | 208 | } |
734d790d | 209 | return this.getConnectorStatus(connectorId).energyActiveImportRegisterValue; |
6ed92bc1 JB |
210 | } |
211 | ||
c0560973 JB |
212 | public getAuthorizeRemoteTxRequests(): boolean { |
213 | const authorizeRemoteTxRequests = this.getConfigurationKey(StandardParametersKey.AuthorizeRemoteTxRequests); | |
214 | return authorizeRemoteTxRequests ? Utils.convertToBoolean(authorizeRemoteTxRequests.value) : false; | |
215 | } | |
216 | ||
217 | public getLocalAuthListEnabled(): boolean { | |
218 | const localAuthListEnabled = this.getConfigurationKey(StandardParametersKey.LocalAuthListEnabled); | |
219 | return localAuthListEnabled ? Utils.convertToBoolean(localAuthListEnabled.value) : false; | |
220 | } | |
221 | ||
222 | public restartWebSocketPing(): void { | |
223 | // Stop WebSocket ping | |
224 | this.stopWebSocketPing(); | |
225 | // Start WebSocket ping | |
226 | this.startWebSocketPing(); | |
227 | } | |
228 | ||
9ccca265 JB |
229 | public getSampledValueTemplate(connectorId: number, measurand: MeterValueMeasurand = MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER, |
230 | phase?: MeterValuePhase): SampledValueTemplate | undefined { | |
231 | if (!Constants.SUPPORTED_MEASURANDS.includes(measurand)) { | |
7d75bee1 | 232 | logger.warn(`${this.logPrefix()} Trying to get unsupported MeterValues measurand '${measurand}' ${phase ? `on phase ${phase} ` : ''}in template on connectorId ${connectorId}`); |
9bd87386 JB |
233 | return; |
234 | } | |
235 | if (measurand !== MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER && !this.getConfigurationKey(StandardParametersKey.MeterValuesSampledData).value.includes(measurand)) { | |
7d75bee1 | 236 | logger.debug(`${this.logPrefix()} Trying to get MeterValues measurand '${measurand}' ${phase ? `on phase ${phase} ` : ''}in template on connectorId ${connectorId} not found in '${StandardParametersKey.MeterValuesSampledData}' OCPP parameter`); |
9ccca265 JB |
237 | return; |
238 | } | |
734d790d | 239 | const sampledValueTemplates: SampledValueTemplate[] = this.getConnectorStatus(connectorId).MeterValues; |
9ccca265 | 240 | for (let index = 0; !Utils.isEmptyArray(sampledValueTemplates) && index < sampledValueTemplates.length; index++) { |
290d006c | 241 | if (!Constants.SUPPORTED_MEASURANDS.includes(sampledValueTemplates[index]?.measurand ?? MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER)) { |
7d75bee1 | 242 | logger.warn(`${this.logPrefix()} Unsupported MeterValues measurand '${measurand}' ${phase ? `on phase ${phase} ` : ''}in template on connectorId ${connectorId}`); |
47e22477 | 243 | } else if (phase && sampledValueTemplates[index]?.phase === phase && sampledValueTemplates[index]?.measurand === measurand |
32b02249 | 244 | && this.getConfigurationKey(StandardParametersKey.MeterValuesSampledData).value.includes(measurand)) { |
9ccca265 JB |
245 | return sampledValueTemplates[index]; |
246 | } else if (!phase && !sampledValueTemplates[index].phase && sampledValueTemplates[index]?.measurand === measurand | |
32b02249 | 247 | && this.getConfigurationKey(StandardParametersKey.MeterValuesSampledData).value.includes(measurand)) { |
9ccca265 JB |
248 | return sampledValueTemplates[index]; |
249 | } else if (measurand === MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER | |
32b02249 | 250 | && (!sampledValueTemplates[index].measurand || sampledValueTemplates[index].measurand === measurand)) { |
9ccca265 JB |
251 | return sampledValueTemplates[index]; |
252 | } | |
253 | } | |
9bd87386 | 254 | if (measurand === MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER) { |
7d75bee1 | 255 | const errorMsg = `${this.logPrefix()} Missing MeterValues for default measurand '${measurand}' in template on connectorId ${connectorId}`; |
de96acad JB |
256 | logger.error(errorMsg); |
257 | throw new Error(errorMsg); | |
9ccca265 | 258 | } |
7d75bee1 | 259 | logger.debug(`${this.logPrefix()} No MeterValues for measurand '${measurand}' ${phase ? `on phase ${phase} ` : ''}in template on connectorId ${connectorId}`); |
9ccca265 JB |
260 | } |
261 | ||
e644918b JB |
262 | public getAutomaticTransactionGeneratorRequireAuthorize(): boolean { |
263 | return this.stationInfo.AutomaticTransactionGenerator.requireAuthorize ?? true; | |
264 | } | |
265 | ||
c0560973 JB |
266 | public startHeartbeat(): void { |
267 | if (this.getHeartbeatInterval() && this.getHeartbeatInterval() > 0 && !this.heartbeatSetInterval) { | |
71623267 JB |
268 | // eslint-disable-next-line @typescript-eslint/no-misused-promises |
269 | this.heartbeatSetInterval = setInterval(async (): Promise<void> => { | |
c0560973 JB |
270 | await this.ocppRequestService.sendHeartbeat(); |
271 | }, this.getHeartbeatInterval()); | |
d7d1db72 | 272 | logger.info(this.logPrefix() + ' Heartbeat started every ' + Utils.formatDurationMilliSeconds(this.getHeartbeatInterval())); |
c0560973 | 273 | } else if (this.heartbeatSetInterval) { |
d7d1db72 | 274 | logger.info(this.logPrefix() + ' Heartbeat already started every ' + Utils.formatDurationMilliSeconds(this.getHeartbeatInterval())); |
c0560973 | 275 | } else { |
d7d1db72 | 276 | logger.error(`${this.logPrefix()} Heartbeat interval set to ${this.getHeartbeatInterval() ? Utils.formatDurationMilliSeconds(this.getHeartbeatInterval()) : this.getHeartbeatInterval()}, not starting the heartbeat`); |
c0560973 JB |
277 | } |
278 | } | |
279 | ||
280 | public restartHeartbeat(): void { | |
281 | // Stop heartbeat | |
282 | this.stopHeartbeat(); | |
283 | // Start heartbeat | |
284 | this.startHeartbeat(); | |
285 | } | |
286 | ||
287 | public startMeterValues(connectorId: number, interval: number): void { | |
288 | if (connectorId === 0) { | |
289 | logger.error(`${this.logPrefix()} Trying to start MeterValues on connector Id ${connectorId.toString()}`); | |
290 | return; | |
291 | } | |
734d790d | 292 | if (!this.getConnectorStatus(connectorId)) { |
c0560973 JB |
293 | logger.error(`${this.logPrefix()} Trying to start MeterValues on non existing connector Id ${connectorId.toString()}`); |
294 | return; | |
295 | } | |
734d790d | 296 | if (!this.getConnectorStatus(connectorId)?.transactionStarted) { |
c0560973 JB |
297 | logger.error(`${this.logPrefix()} Trying to start MeterValues on connector Id ${connectorId} with no transaction started`); |
298 | return; | |
734d790d | 299 | } else if (this.getConnectorStatus(connectorId)?.transactionStarted && !this.getConnectorStatus(connectorId)?.transactionId) { |
c0560973 JB |
300 | logger.error(`${this.logPrefix()} Trying to start MeterValues on connector Id ${connectorId} with no transaction id`); |
301 | return; | |
302 | } | |
303 | if (interval > 0) { | |
71623267 | 304 | // eslint-disable-next-line @typescript-eslint/no-misused-promises |
734d790d JB |
305 | this.getConnectorStatus(connectorId).transactionSetInterval = setInterval(async (): Promise<void> => { |
306 | await this.ocppRequestService.sendMeterValues(connectorId, this.getConnectorStatus(connectorId).transactionId, interval); | |
c0560973 JB |
307 | }, interval); |
308 | } else { | |
d7d1db72 | 309 | logger.error(`${this.logPrefix()} Charging station ${StandardParametersKey.MeterValueSampleInterval} configuration set to ${interval ? Utils.formatDurationMilliSeconds(interval) : interval}, not sending MeterValues`); |
c0560973 JB |
310 | } |
311 | } | |
312 | ||
313 | public start(): void { | |
7874b0b1 JB |
314 | if (this.getEnableStatistics()) { |
315 | this.performanceStatistics.start(); | |
316 | } | |
c0560973 JB |
317 | this.openWSConnection(); |
318 | // Monitor authorization file | |
319 | this.startAuthorizationFileMonitoring(); | |
320 | // Monitor station template file | |
321 | this.startStationTemplateFileMonitoring(); | |
8bf88613 | 322 | // Handle WebSocket message |
c0560973 | 323 | this.wsConnection.on('message', this.onMessage.bind(this)); |
5dc8b1b5 | 324 | // Handle WebSocket error |
c0560973 | 325 | this.wsConnection.on('error', this.onError.bind(this)); |
5dc8b1b5 | 326 | // Handle WebSocket close |
c0560973 | 327 | this.wsConnection.on('close', this.onClose.bind(this)); |
8bf88613 | 328 | // Handle WebSocket open |
c0560973 | 329 | this.wsConnection.on('open', this.onOpen.bind(this)); |
5dc8b1b5 | 330 | // Handle WebSocket ping |
c0560973 | 331 | this.wsConnection.on('ping', this.onPing.bind(this)); |
5dc8b1b5 | 332 | // Handle WebSocket pong |
c0560973 JB |
333 | this.wsConnection.on('pong', this.onPong.bind(this)); |
334 | } | |
335 | ||
336 | public async stop(reason: StopTransactionReason = StopTransactionReason.NONE): Promise<void> { | |
337 | // Stop message sequence | |
338 | await this.stopMessageSequence(reason); | |
734d790d JB |
339 | for (const connectorId of this.connectors.keys()) { |
340 | if (connectorId > 0) { | |
341 | await this.ocppRequestService.sendStatusNotification(connectorId, ChargePointStatus.UNAVAILABLE); | |
342 | this.getConnectorStatus(connectorId).status = ChargePointStatus.UNAVAILABLE; | |
c0560973 JB |
343 | } |
344 | } | |
d5bff457 | 345 | if (this.isWebSocketConnectionOpened()) { |
c0560973 JB |
346 | this.wsConnection.close(); |
347 | } | |
7874b0b1 JB |
348 | if (this.getEnableStatistics()) { |
349 | this.performanceStatistics.stop(); | |
350 | } | |
c0560973 | 351 | this.bootNotificationResponse = null; |
265e4266 | 352 | this.stopped = true; |
c0560973 JB |
353 | } |
354 | ||
6e0964c8 | 355 | public getConfigurationKey(key: string | StandardParametersKey, caseInsensitive = false): ConfigurationKey | undefined { |
7874b0b1 | 356 | return this.configuration.configurationKey.find((configElement) => { |
c0560973 JB |
357 | if (caseInsensitive) { |
358 | return configElement.key.toLowerCase() === key.toLowerCase(); | |
359 | } | |
360 | return configElement.key === key; | |
361 | }); | |
c0560973 JB |
362 | } |
363 | ||
364 | public addConfigurationKey(key: string | StandardParametersKey, value: string, readonly = false, visible = true, reboot = false): void { | |
365 | const keyFound = this.getConfigurationKey(key); | |
366 | if (!keyFound) { | |
367 | this.configuration.configurationKey.push({ | |
368 | key, | |
369 | readonly, | |
370 | value, | |
371 | visible, | |
372 | reboot, | |
373 | }); | |
374 | } else { | |
375 | logger.error(`${this.logPrefix()} Trying to add an already existing configuration key: %j`, keyFound); | |
376 | } | |
377 | } | |
378 | ||
379 | public setConfigurationKeyValue(key: string | StandardParametersKey, value: string): void { | |
380 | const keyFound = this.getConfigurationKey(key); | |
381 | if (keyFound) { | |
382 | const keyIndex = this.configuration.configurationKey.indexOf(keyFound); | |
383 | this.configuration.configurationKey[keyIndex].value = value; | |
384 | } else { | |
385 | logger.error(`${this.logPrefix()} Trying to set a value on a non existing configuration key: %j`, { key, value }); | |
386 | } | |
387 | } | |
388 | ||
a7fc8211 JB |
389 | public setChargingProfile(connectorId: number, cp: ChargingProfile): void { |
390 | let cpReplaced = false; | |
734d790d JB |
391 | if (!Utils.isEmptyArray(this.getConnectorStatus(connectorId).chargingProfiles)) { |
392 | this.getConnectorStatus(connectorId).chargingProfiles?.forEach((chargingProfile: ChargingProfile, index: number) => { | |
c0560973 | 393 | if (chargingProfile.chargingProfileId === cp.chargingProfileId |
32b02249 | 394 | || (chargingProfile.stackLevel === cp.stackLevel && chargingProfile.chargingProfilePurpose === cp.chargingProfilePurpose)) { |
734d790d | 395 | this.getConnectorStatus(connectorId).chargingProfiles[index] = cp; |
a7fc8211 | 396 | cpReplaced = true; |
c0560973 JB |
397 | } |
398 | }); | |
399 | } | |
734d790d | 400 | !cpReplaced && this.getConnectorStatus(connectorId).chargingProfiles?.push(cp); |
c0560973 JB |
401 | } |
402 | ||
403 | public resetTransactionOnConnector(connectorId: number): void { | |
734d790d JB |
404 | this.getConnectorStatus(connectorId).authorized = false; |
405 | this.getConnectorStatus(connectorId).transactionStarted = false; | |
406 | delete this.getConnectorStatus(connectorId).authorizeIdTag; | |
407 | delete this.getConnectorStatus(connectorId).transactionId; | |
408 | delete this.getConnectorStatus(connectorId).transactionIdTag; | |
409 | this.getConnectorStatus(connectorId).transactionEnergyActiveImportRegisterValue = 0; | |
410 | delete this.getConnectorStatus(connectorId).transactionBeginMeterValue; | |
dd119a6b | 411 | this.stopMeterValues(connectorId); |
2e6f5966 JB |
412 | } |
413 | ||
77f00f84 | 414 | public addToMessageQueue(message: string): void { |
3ba2381e | 415 | let dups = false; |
cb31c873 | 416 | // Handle dups in message queue |
3ba2381e | 417 | for (const bufferedMessage of this.messageQueue) { |
cb31c873 | 418 | // Message already in the queue |
3ba2381e JB |
419 | if (message === bufferedMessage) { |
420 | dups = true; | |
421 | break; | |
422 | } | |
423 | } | |
424 | if (!dups) { | |
cb31c873 | 425 | // Queue message |
3ba2381e JB |
426 | this.messageQueue.push(message); |
427 | } | |
428 | } | |
429 | ||
77f00f84 JB |
430 | private flushMessageQueue() { |
431 | if (!Utils.isEmptyArray(this.messageQueue)) { | |
432 | this.messageQueue.forEach((message, index) => { | |
433 | this.messageQueue.splice(index, 1); | |
aef1b33a | 434 | // TODO: evaluate the need to track performance |
77f00f84 JB |
435 | this.wsConnection.send(message); |
436 | }); | |
437 | } | |
438 | } | |
439 | ||
c0560973 | 440 | private getChargingStationId(stationTemplate: ChargingStationTemplate): string { |
ef6076c1 | 441 | // In case of multiple instances: add instance index to charging station id |
203bc097 | 442 | const instanceIndex = process.env.CF_INSTANCE_INDEX ?? 0; |
9ccca265 | 443 | const idSuffix = stationTemplate.nameSuffix ?? ''; |
ad2f27c3 | 444 | return stationTemplate.fixedName ? stationTemplate.baseName : stationTemplate.baseName + '-' + instanceIndex.toString() + ('000000000' + this.index.toString()).substr(('000000000' + this.index.toString()).length - 4) + idSuffix; |
5ad8570f JB |
445 | } |
446 | ||
c0560973 | 447 | private buildStationInfo(): ChargingStationInfo { |
9ac86a7e | 448 | let stationTemplateFromFile: ChargingStationTemplate; |
5ad8570f JB |
449 | try { |
450 | // Load template file | |
ad2f27c3 | 451 | const fileDescriptor = fs.openSync(this.stationTemplateFile, 'r'); |
9ac86a7e | 452 | stationTemplateFromFile = JSON.parse(fs.readFileSync(fileDescriptor, 'utf8')) as ChargingStationTemplate; |
5ad8570f JB |
453 | fs.closeSync(fileDescriptor); |
454 | } catch (error) { | |
23132a44 | 455 | FileUtils.handleFileException(this.logPrefix(), 'Template', this.stationTemplateFile, error); |
5ad8570f | 456 | } |
510f0fa5 | 457 | const stationInfo: ChargingStationInfo = stationTemplateFromFile ?? {} as ChargingStationInfo; |
0a60c33c | 458 | if (!Utils.isEmptyArray(stationTemplateFromFile.power)) { |
9ac86a7e | 459 | stationTemplateFromFile.power = stationTemplateFromFile.power as number[]; |
c37528f1 | 460 | const powerArrayRandomIndex = Math.floor(Utils.secureRandom() * stationTemplateFromFile.power.length); |
510f0fa5 JB |
461 | stationInfo.maxPower = stationTemplateFromFile.powerUnit === PowerUnits.KILO_WATT |
462 | ? stationTemplateFromFile.power[powerArrayRandomIndex] * 1000 | |
463 | : stationTemplateFromFile.power[powerArrayRandomIndex]; | |
5ad8570f | 464 | } else { |
510f0fa5 JB |
465 | stationTemplateFromFile.power = stationTemplateFromFile.power as number; |
466 | stationInfo.maxPower = stationTemplateFromFile.powerUnit === PowerUnits.KILO_WATT | |
fd0c36fa | 467 | ? stationTemplateFromFile.power * 1000 |
510f0fa5 | 468 | : stationTemplateFromFile.power; |
5ad8570f | 469 | } |
fd0c36fa JB |
470 | delete stationInfo.power; |
471 | delete stationInfo.powerUnit; | |
c0560973 | 472 | stationInfo.chargingStationId = this.getChargingStationId(stationTemplateFromFile); |
9ac86a7e JB |
473 | stationInfo.resetTime = stationTemplateFromFile.resetTime ? stationTemplateFromFile.resetTime * 1000 : Constants.CHARGING_STATION_DEFAULT_RESET_TIME; |
474 | return stationInfo; | |
5ad8570f JB |
475 | } |
476 | ||
c0560973 JB |
477 | private getOCPPVersion(): OCPPVersion { |
478 | return this.stationInfo.ocppVersion ? this.stationInfo.ocppVersion : OCPPVersion.VERSION_16; | |
479 | } | |
480 | ||
481 | private handleUnsupportedVersion(version: OCPPVersion) { | |
482 | const errMsg = `${this.logPrefix()} Unsupported protocol version '${version}' configured in template file ${this.stationTemplateFile}`; | |
483 | logger.error(errMsg); | |
484 | throw new Error(errMsg); | |
485 | } | |
486 | ||
487 | private initialize(): void { | |
488 | this.stationInfo = this.buildStationInfo(); | |
ad2f27c3 JB |
489 | this.bootNotificationRequest = { |
490 | chargePointModel: this.stationInfo.chargePointModel, | |
491 | chargePointVendor: this.stationInfo.chargePointVendor, | |
492 | ...!Utils.isUndefined(this.stationInfo.chargeBoxSerialNumberPrefix) && { chargeBoxSerialNumber: this.stationInfo.chargeBoxSerialNumberPrefix }, | |
493 | ...!Utils.isUndefined(this.stationInfo.firmwareVersion) && { firmwareVersion: this.stationInfo.firmwareVersion }, | |
2e6f5966 | 494 | }; |
c0560973 | 495 | this.configuration = this.getTemplateChargingStationConfiguration(); |
57939a9d | 496 | this.wsConnectionUrl = new URL(this.getSupervisionURL().href + '/' + this.stationInfo.chargingStationId); |
0a60c33c | 497 | // Build connectors if needed |
c0560973 | 498 | const maxConnectors = this.getMaxNumberOfConnectors(); |
6ecb15e4 | 499 | if (maxConnectors <= 0) { |
c0560973 | 500 | logger.warn(`${this.logPrefix()} Charging station template ${this.stationTemplateFile} with ${maxConnectors} connectors`); |
7abfea5f | 501 | } |
c0560973 | 502 | const templateMaxConnectors = this.getTemplateMaxNumberOfConnectors(); |
7abfea5f | 503 | if (templateMaxConnectors <= 0) { |
c0560973 | 504 | logger.warn(`${this.logPrefix()} Charging station template ${this.stationTemplateFile} with no connector configuration`); |
593cf3f9 | 505 | } |
ad2f27c3 | 506 | if (!this.stationInfo.Connectors[0]) { |
c0560973 | 507 | logger.warn(`${this.logPrefix()} Charging station template ${this.stationTemplateFile} with no connector Id 0 configuration`); |
7abfea5f JB |
508 | } |
509 | // Sanity check | |
ad2f27c3 | 510 | if (maxConnectors > (this.stationInfo.Connectors[0] ? templateMaxConnectors - 1 : templateMaxConnectors) && !this.stationInfo.randomConnectors) { |
c0560973 | 511 | logger.warn(`${this.logPrefix()} Number of connectors exceeds the number of connector configurations in template ${this.stationTemplateFile}, forcing random connector configurations affectation`); |
ad2f27c3 | 512 | this.stationInfo.randomConnectors = true; |
6ecb15e4 | 513 | } |
ad2f27c3 | 514 | const connectorsConfigHash = crypto.createHash('sha256').update(JSON.stringify(this.stationInfo.Connectors) + maxConnectors.toString()).digest('hex'); |
54544ef1 JB |
515 | const connectorsConfigChanged = this.connectors?.size !== 0 && this.connectorsConfigurationHash !== connectorsConfigHash; |
516 | if (this.connectors?.size === 0 || connectorsConfigChanged) { | |
734d790d | 517 | connectorsConfigChanged && (this.connectors.clear()); |
ad2f27c3 | 518 | this.connectorsConfigurationHash = connectorsConfigHash; |
7abfea5f | 519 | // Add connector Id 0 |
6af9012e | 520 | let lastConnector = '0'; |
ad2f27c3 | 521 | for (lastConnector in this.stationInfo.Connectors) { |
734d790d JB |
522 | const lastConnectorId = Utils.convertToInt(lastConnector); |
523 | if (lastConnectorId === 0 && this.getUseConnectorId0() && this.stationInfo.Connectors[lastConnector]) { | |
524 | this.connectors.set(lastConnectorId, Utils.cloneObject<ConnectorStatus>(this.stationInfo.Connectors[lastConnector])); | |
525 | this.getConnectorStatus(lastConnectorId).availability = AvailabilityType.OPERATIVE; | |
526 | if (Utils.isUndefined(this.getConnectorStatus(lastConnectorId)?.chargingProfiles)) { | |
527 | this.getConnectorStatus(lastConnectorId).chargingProfiles = []; | |
418106c8 | 528 | } |
0a60c33c JB |
529 | } |
530 | } | |
0a60c33c | 531 | // Generate all connectors |
ad2f27c3 | 532 | if ((this.stationInfo.Connectors[0] ? templateMaxConnectors - 1 : templateMaxConnectors) > 0) { |
7abfea5f | 533 | for (let index = 1; index <= maxConnectors; index++) { |
72740232 | 534 | const randConnectorId = this.stationInfo.randomConnectors ? Utils.getRandomInteger(Utils.convertToInt(lastConnector), 1) : index; |
734d790d JB |
535 | this.connectors.set(index, Utils.cloneObject<ConnectorStatus>(this.stationInfo.Connectors[randConnectorId])); |
536 | this.getConnectorStatus(index).availability = AvailabilityType.OPERATIVE; | |
537 | if (Utils.isUndefined(this.getConnectorStatus(index)?.chargingProfiles)) { | |
538 | this.getConnectorStatus(index).chargingProfiles = []; | |
418106c8 | 539 | } |
7abfea5f | 540 | } |
0a60c33c JB |
541 | } |
542 | } | |
d4a73fb7 | 543 | // Avoid duplication of connectors related information |
ad2f27c3 | 544 | delete this.stationInfo.Connectors; |
0a60c33c | 545 | // Initialize transaction attributes on connectors |
734d790d JB |
546 | for (const connectorId of this.connectors.keys()) { |
547 | if (connectorId > 0 && !this.getConnectorStatus(connectorId)?.transactionStarted) { | |
548 | this.initTransactionAttributesOnConnector(connectorId); | |
0a60c33c JB |
549 | } |
550 | } | |
c0560973 JB |
551 | switch (this.getOCPPVersion()) { |
552 | case OCPPVersion.VERSION_16: | |
553 | this.ocppIncomingRequestService = new OCPP16IncomingRequestService(this); | |
554 | this.ocppRequestService = new OCPP16RequestService(this, new OCPP16ResponseService(this)); | |
555 | break; | |
556 | default: | |
557 | this.handleUnsupportedVersion(this.getOCPPVersion()); | |
558 | break; | |
559 | } | |
7abfea5f | 560 | // OCPP parameters |
147d0e0f | 561 | this.initOCPPParameters(); |
47e22477 JB |
562 | if (this.stationInfo.autoRegister) { |
563 | this.bootNotificationResponse = { | |
564 | currentTime: new Date().toISOString(), | |
565 | interval: this.getHeartbeatInterval() / 1000, | |
566 | status: RegistrationStatus.ACCEPTED | |
567 | }; | |
568 | } | |
147d0e0f JB |
569 | this.stationInfo.powerDivider = this.getPowerDivider(); |
570 | if (this.getEnableStatistics()) { | |
2a370053 | 571 | this.performanceStatistics = new PerformanceStatistics(this.stationInfo.chargingStationId, this.wsConnectionUrl); |
147d0e0f JB |
572 | } |
573 | } | |
574 | ||
575 | private initOCPPParameters(): void { | |
36f6a92e JB |
576 | if (!this.getConfigurationKey(StandardParametersKey.SupportedFeatureProfiles)) { |
577 | this.addConfigurationKey(StandardParametersKey.SupportedFeatureProfiles, `${SupportedFeatureProfiles.Core},${SupportedFeatureProfiles.Local_Auth_List_Management},${SupportedFeatureProfiles.Smart_Charging}`); | |
578 | } | |
c0560973 JB |
579 | this.addConfigurationKey(StandardParametersKey.NumberOfConnectors, this.getNumberOfConnectors().toString(), true); |
580 | if (!this.getConfigurationKey(StandardParametersKey.MeterValuesSampledData)) { | |
581 | this.addConfigurationKey(StandardParametersKey.MeterValuesSampledData, MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER); | |
7abfea5f | 582 | } |
7e1dc878 JB |
583 | if (!this.getConfigurationKey(StandardParametersKey.ConnectorPhaseRotation)) { |
584 | const connectorPhaseRotation = []; | |
734d790d | 585 | for (const connectorId of this.connectors.keys()) { |
7e1dc878 | 586 | // AC/DC |
734d790d JB |
587 | if (connectorId === 0 && this.getNumberOfPhases() === 0) { |
588 | connectorPhaseRotation.push(`${connectorId}.${ConnectorPhaseRotation.RST}`); | |
589 | } else if (connectorId > 0 && this.getNumberOfPhases() === 0) { | |
590 | connectorPhaseRotation.push(`${connectorId}.${ConnectorPhaseRotation.NotApplicable}`); | |
7e1dc878 | 591 | // AC |
734d790d JB |
592 | } else if (connectorId > 0 && this.getNumberOfPhases() === 1) { |
593 | connectorPhaseRotation.push(`${connectorId}.${ConnectorPhaseRotation.NotApplicable}`); | |
594 | } else if (connectorId > 0 && this.getNumberOfPhases() === 3) { | |
595 | connectorPhaseRotation.push(`${connectorId}.${ConnectorPhaseRotation.RST}`); | |
7e1dc878 JB |
596 | } |
597 | } | |
598 | this.addConfigurationKey(StandardParametersKey.ConnectorPhaseRotation, connectorPhaseRotation.toString()); | |
599 | } | |
36f6a92e JB |
600 | if (!this.getConfigurationKey(StandardParametersKey.AuthorizeRemoteTxRequests)) { |
601 | this.addConfigurationKey(StandardParametersKey.AuthorizeRemoteTxRequests, 'true'); | |
602 | } | |
603 | if (!this.getConfigurationKey(StandardParametersKey.LocalAuthListEnabled) | |
32b02249 | 604 | && this.getConfigurationKey(StandardParametersKey.SupportedFeatureProfiles).value.includes(SupportedFeatureProfiles.Local_Auth_List_Management)) { |
36f6a92e JB |
605 | this.addConfigurationKey(StandardParametersKey.LocalAuthListEnabled, 'false'); |
606 | } | |
147d0e0f JB |
607 | if (!this.getConfigurationKey(StandardParametersKey.ConnectionTimeOut)) { |
608 | this.addConfigurationKey(StandardParametersKey.ConnectionTimeOut, Constants.DEFAULT_CONNECTION_TIMEOUT.toString()); | |
8bce55bf | 609 | } |
7dde0b73 JB |
610 | } |
611 | ||
c0560973 | 612 | private async onOpen(): Promise<void> { |
e9017bfc | 613 | logger.info(`${this.logPrefix()} Connected to OCPP server through ${this.wsConnectionUrl.toString()}`); |
c0560973 JB |
614 | if (!this.isRegistered()) { |
615 | // Send BootNotification | |
616 | let registrationRetryCount = 0; | |
617 | do { | |
43d673d9 JB |
618 | this.bootNotificationResponse = await this.ocppRequestService.sendBootNotification(this.bootNotificationRequest.chargePointModel, |
619 | this.bootNotificationRequest.chargePointVendor, this.bootNotificationRequest.chargeBoxSerialNumber, this.bootNotificationRequest.firmwareVersion); | |
c0560973 JB |
620 | if (!this.isRegistered()) { |
621 | registrationRetryCount++; | |
622 | await Utils.sleep(this.bootNotificationResponse?.interval ? this.bootNotificationResponse.interval * 1000 : Constants.OCPP_DEFAULT_BOOT_NOTIFICATION_INTERVAL); | |
623 | } | |
624 | } while (!this.isRegistered() && (registrationRetryCount <= this.getRegistrationMaxRetries() || this.getRegistrationMaxRetries() === -1)); | |
c7db4718 JB |
625 | } |
626 | if (this.isRegistered()) { | |
c0560973 | 627 | await this.startMessageSequence(); |
265e4266 JB |
628 | this.stopped && (this.stopped = false); |
629 | if (this.wsConnectionRestarted && this.isWebSocketConnectionOpened()) { | |
77f00f84 | 630 | this.flushMessageQueue(); |
2e6f5966 JB |
631 | } |
632 | } else { | |
c0560973 | 633 | logger.error(`${this.logPrefix()} Registration failure: max retries reached (${this.getRegistrationMaxRetries()}) or retry disabled (${this.getRegistrationMaxRetries()})`); |
2e6f5966 | 634 | } |
c0560973 | 635 | this.autoReconnectRetryCount = 0; |
265e4266 | 636 | this.wsConnectionRestarted = false; |
2e6f5966 JB |
637 | } |
638 | ||
6c65a295 | 639 | private async onClose(code: number, reason: string): Promise<void> { |
d09085e9 | 640 | switch (code) { |
6c65a295 JB |
641 | // Normal close |
642 | case WebSocketCloseEventStatusCode.CLOSE_NORMAL: | |
c0560973 | 643 | case WebSocketCloseEventStatusCode.CLOSE_NO_STATUS: |
5dc8b1b5 | 644 | logger.info(`${this.logPrefix()} WebSocket normally closed with status '${Utils.getWebSocketCloseEventStatusString(code)}' and reason '${reason}'`); |
c0560973 JB |
645 | this.autoReconnectRetryCount = 0; |
646 | break; | |
6c65a295 JB |
647 | // Abnormal close |
648 | default: | |
5dc8b1b5 | 649 | logger.error(`${this.logPrefix()} WebSocket abnormally closed with status '${Utils.getWebSocketCloseEventStatusString(code)}' and reason '${reason}'`); |
d09085e9 | 650 | await this.reconnect(code); |
c0560973 JB |
651 | break; |
652 | } | |
2e6f5966 JB |
653 | } |
654 | ||
16b0d4e7 | 655 | private async onMessage(data: Data): Promise<void> { |
c0560973 | 656 | let [messageType, messageId, commandName, commandPayload, errorDetails]: IncomingRequest = [0, '', '' as IncomingRequestCommand, {}, {}]; |
193d2c0a | 657 | let responseCallback: (payload: Record<string, unknown> | string, requestPayload: Record<string, unknown>) => void; |
9239b49a | 658 | let rejectCallback: (error: OCPPError, requestStatistic?: boolean) => void; |
32b02249 | 659 | let requestCommandName: RequestCommand | IncomingRequestCommand; |
c0560973 | 660 | let requestPayload: Record<string, unknown>; |
32b02249 | 661 | let cachedRequest: CachedRequest; |
c0560973 JB |
662 | let errMsg: string; |
663 | try { | |
16b0d4e7 | 664 | const request = JSON.parse(data.toString()) as IncomingRequest; |
47e22477 JB |
665 | if (Utils.isIterable(request)) { |
666 | // Parse the message | |
667 | [messageType, messageId, commandName, commandPayload, errorDetails] = request; | |
668 | } else { | |
a6b3c6c3 | 669 | throw new OCPPError(ErrorType.PROTOCOL_ERROR, 'Incoming request is not iterable', commandName); |
47e22477 | 670 | } |
c0560973 JB |
671 | // Check the Type of message |
672 | switch (messageType) { | |
673 | // Incoming Message | |
674 | case MessageType.CALL_MESSAGE: | |
675 | if (this.getEnableStatistics()) { | |
aef1b33a | 676 | this.performanceStatistics.addRequestStatistic(commandName, messageType); |
c0560973 JB |
677 | } |
678 | // Process the call | |
679 | await this.ocppIncomingRequestService.handleRequest(messageId, commandName, commandPayload); | |
680 | break; | |
681 | // Outcome Message | |
682 | case MessageType.CALL_RESULT_MESSAGE: | |
683 | // Respond | |
16b0d4e7 JB |
684 | cachedRequest = this.requests.get(messageId); |
685 | if (Utils.isIterable(cachedRequest)) { | |
32b02249 | 686 | [responseCallback, , , requestPayload] = cachedRequest; |
c0560973 | 687 | } else { |
a685c3af | 688 | throw new OCPPError(ErrorType.PROTOCOL_ERROR, `Cached request for message id ${messageId} response is not iterable`, commandName); |
c0560973 JB |
689 | } |
690 | if (!responseCallback) { | |
691 | // Error | |
a685c3af | 692 | throw new OCPPError(ErrorType.INTERNAL_ERROR, `Response for unknown message id ${messageId}`, commandName); |
c0560973 | 693 | } |
c0560973 JB |
694 | responseCallback(commandName, requestPayload); |
695 | break; | |
696 | // Error Message | |
697 | case MessageType.CALL_ERROR_MESSAGE: | |
16b0d4e7 | 698 | cachedRequest = this.requests.get(messageId); |
16b0d4e7 | 699 | if (Utils.isIterable(cachedRequest)) { |
32b02249 | 700 | [, rejectCallback, requestCommandName] = cachedRequest; |
c0560973 | 701 | } else { |
a685c3af | 702 | throw new OCPPError(ErrorType.PROTOCOL_ERROR, `Cached request for message id ${messageId} error response is not iterable`); |
c0560973 | 703 | } |
32b02249 JB |
704 | if (!rejectCallback) { |
705 | // Error | |
a685c3af | 706 | throw new OCPPError(ErrorType.INTERNAL_ERROR, `Error response for unknown message id ${messageId}`, requestCommandName); |
32b02249 JB |
707 | } |
708 | rejectCallback(new OCPPError(commandName, commandPayload.toString(), requestCommandName, errorDetails)); | |
c0560973 JB |
709 | break; |
710 | // Error | |
711 | default: | |
712 | errMsg = `${this.logPrefix()} Wrong message type ${messageType}`; | |
713 | logger.error(errMsg); | |
14763b46 | 714 | throw new OCPPError(ErrorType.PROTOCOL_ERROR, errMsg); |
c0560973 JB |
715 | } |
716 | } catch (error) { | |
717 | // Log | |
a685c3af | 718 | logger.error('%s Incoming OCPP message %j matching cached request %j processing error %j', this.logPrefix(), data, this.requests.get(messageId), error); |
c0560973 | 719 | // Send error |
32b02249 | 720 | messageType === MessageType.CALL_MESSAGE && await this.ocppRequestService.sendError(messageId, error, commandName); |
c0560973 | 721 | } |
2328be1e JB |
722 | } |
723 | ||
c0560973 | 724 | private onPing(): void { |
57939a9d | 725 | logger.debug(this.logPrefix() + ' Received a WS ping (rfc6455) from the server'); |
c0560973 JB |
726 | } |
727 | ||
728 | private onPong(): void { | |
57939a9d | 729 | logger.debug(this.logPrefix() + ' Received a WS pong (rfc6455) from the server'); |
c0560973 JB |
730 | } |
731 | ||
16b0d4e7 | 732 | private async onError(error: WSError): Promise<void> { |
5dc8b1b5 | 733 | logger.error(this.logPrefix() + ' WebSocket error: %j', error); |
16b0d4e7 | 734 | // switch (error.code) { |
c0560973 | 735 | // case 'ECONNREFUSED': |
16b0d4e7 | 736 | // await this.reconnect(error); |
c0560973 JB |
737 | // break; |
738 | // } | |
739 | } | |
740 | ||
741 | private getTemplateChargingStationConfiguration(): ChargingStationConfiguration { | |
7874b0b1 | 742 | return this.stationInfo.Configuration ?? {} as ChargingStationConfiguration; |
c0560973 JB |
743 | } |
744 | ||
6e0964c8 | 745 | private getAuthorizationFile(): string | undefined { |
bf1866b2 | 746 | return this.stationInfo.authorizationFile && path.join(path.resolve(__dirname, '../'), 'assets', path.basename(this.stationInfo.authorizationFile)); |
c0560973 JB |
747 | } |
748 | ||
749 | private getAuthorizedTags(): string[] { | |
750 | let authorizedTags: string[] = []; | |
751 | const authorizationFile = this.getAuthorizationFile(); | |
752 | if (authorizationFile) { | |
753 | try { | |
754 | // Load authorization file | |
755 | const fileDescriptor = fs.openSync(authorizationFile, 'r'); | |
756 | authorizedTags = JSON.parse(fs.readFileSync(fileDescriptor, 'utf8')) as string[]; | |
757 | fs.closeSync(fileDescriptor); | |
758 | } catch (error) { | |
23132a44 | 759 | FileUtils.handleFileException(this.logPrefix(), 'Authorization', authorizationFile, error); |
c0560973 JB |
760 | } |
761 | } else { | |
762 | logger.info(this.logPrefix() + ' No authorization file given in template file ' + this.stationTemplateFile); | |
8c4da341 | 763 | } |
c0560973 JB |
764 | return authorizedTags; |
765 | } | |
766 | ||
6e0964c8 | 767 | private getUseConnectorId0(): boolean | undefined { |
c0560973 | 768 | return !Utils.isUndefined(this.stationInfo.useConnectorId0) ? this.stationInfo.useConnectorId0 : true; |
8bce55bf JB |
769 | } |
770 | ||
c0560973 | 771 | private getNumberOfRunningTransactions(): number { |
6ecb15e4 | 772 | let trxCount = 0; |
734d790d JB |
773 | for (const connectorId of this.connectors.keys()) { |
774 | if (connectorId > 0 && this.getConnectorStatus(connectorId)?.transactionStarted) { | |
6ecb15e4 JB |
775 | trxCount++; |
776 | } | |
777 | } | |
778 | return trxCount; | |
779 | } | |
780 | ||
1f761b9a | 781 | // 0 for disabling |
6e0964c8 | 782 | private getConnectionTimeout(): number | undefined { |
291cb255 JB |
783 | if (this.getConfigurationKey(StandardParametersKey.ConnectionTimeOut)) { |
784 | return parseInt(this.getConfigurationKey(StandardParametersKey.ConnectionTimeOut).value) ?? Constants.DEFAULT_CONNECTION_TIMEOUT; | |
785 | } | |
291cb255 | 786 | return Constants.DEFAULT_CONNECTION_TIMEOUT; |
3574dfd3 JB |
787 | } |
788 | ||
1f761b9a | 789 | // -1 for unlimited, 0 for disabling |
6e0964c8 | 790 | private getAutoReconnectMaxRetries(): number | undefined { |
ad2f27c3 JB |
791 | if (!Utils.isUndefined(this.stationInfo.autoReconnectMaxRetries)) { |
792 | return this.stationInfo.autoReconnectMaxRetries; | |
3574dfd3 JB |
793 | } |
794 | if (!Utils.isUndefined(Configuration.getAutoReconnectMaxRetries())) { | |
795 | return Configuration.getAutoReconnectMaxRetries(); | |
796 | } | |
797 | return -1; | |
798 | } | |
799 | ||
ec977daf | 800 | // 0 for disabling |
6e0964c8 | 801 | private getRegistrationMaxRetries(): number | undefined { |
ad2f27c3 JB |
802 | if (!Utils.isUndefined(this.stationInfo.registrationMaxRetries)) { |
803 | return this.stationInfo.registrationMaxRetries; | |
32a1eb7a JB |
804 | } |
805 | return -1; | |
806 | } | |
807 | ||
c0560973 JB |
808 | private getPowerDivider(): number { |
809 | let powerDivider = this.getNumberOfConnectors(); | |
ad2f27c3 | 810 | if (this.stationInfo.powerSharedByConnectors) { |
c0560973 | 811 | powerDivider = this.getNumberOfRunningTransactions(); |
6ecb15e4 JB |
812 | } |
813 | return powerDivider; | |
814 | } | |
815 | ||
c0560973 | 816 | private getTemplateMaxNumberOfConnectors(): number { |
ad2f27c3 | 817 | return Object.keys(this.stationInfo.Connectors).length; |
7abfea5f JB |
818 | } |
819 | ||
c0560973 | 820 | private getMaxNumberOfConnectors(): number { |
5ad8570f | 821 | let maxConnectors = 0; |
ad2f27c3 JB |
822 | if (!Utils.isEmptyArray(this.stationInfo.numberOfConnectors)) { |
823 | const numberOfConnectors = this.stationInfo.numberOfConnectors as number[]; | |
6ecb15e4 | 824 | // Distribute evenly the number of connectors |
ad2f27c3 JB |
825 | maxConnectors = numberOfConnectors[(this.index - 1) % numberOfConnectors.length]; |
826 | } else if (!Utils.isUndefined(this.stationInfo.numberOfConnectors)) { | |
827 | maxConnectors = this.stationInfo.numberOfConnectors as number; | |
488fd3a7 | 828 | } else { |
c0560973 | 829 | maxConnectors = this.stationInfo.Connectors[0] ? this.getTemplateMaxNumberOfConnectors() - 1 : this.getTemplateMaxNumberOfConnectors(); |
5ad8570f JB |
830 | } |
831 | return maxConnectors; | |
2e6f5966 JB |
832 | } |
833 | ||
c0560973 | 834 | private async startMessageSequence(): Promise<void> { |
136c90ba | 835 | // Start WebSocket ping |
c0560973 | 836 | this.startWebSocketPing(); |
5ad8570f | 837 | // Start heartbeat |
c0560973 | 838 | this.startHeartbeat(); |
0a60c33c | 839 | // Initialize connectors status |
734d790d JB |
840 | for (const connectorId of this.connectors.keys()) { |
841 | if (connectorId === 0) { | |
593cf3f9 | 842 | continue; |
734d790d | 843 | } else if (!this.stopped && !this.getConnectorStatus(connectorId)?.status && this.getConnectorStatus(connectorId)?.bootStatus) { |
136c90ba | 844 | // Send status in template at startup |
734d790d JB |
845 | await this.ocppRequestService.sendStatusNotification(connectorId, this.getConnectorStatus(connectorId).bootStatus); |
846 | this.getConnectorStatus(connectorId).status = this.getConnectorStatus(connectorId).bootStatus; | |
847 | } else if (this.stopped && this.getConnectorStatus(connectorId)?.status && this.getConnectorStatus(connectorId)?.bootStatus) { | |
136c90ba | 848 | // Send status in template after reset |
734d790d JB |
849 | await this.ocppRequestService.sendStatusNotification(connectorId, this.getConnectorStatus(connectorId).bootStatus); |
850 | this.getConnectorStatus(connectorId).status = this.getConnectorStatus(connectorId).bootStatus; | |
851 | } else if (!this.stopped && this.getConnectorStatus(connectorId)?.status) { | |
136c90ba | 852 | // Send previous status at template reload |
734d790d | 853 | await this.ocppRequestService.sendStatusNotification(connectorId, this.getConnectorStatus(connectorId).status); |
5ad8570f | 854 | } else { |
136c90ba | 855 | // Send default status |
734d790d JB |
856 | await this.ocppRequestService.sendStatusNotification(connectorId, ChargePointStatus.AVAILABLE); |
857 | this.getConnectorStatus(connectorId).status = ChargePointStatus.AVAILABLE; | |
5ad8570f JB |
858 | } |
859 | } | |
0a60c33c | 860 | // Start the ATG |
dd119a6b | 861 | this.startAutomaticTransactionGenerator(); |
dd119a6b JB |
862 | } |
863 | ||
864 | private startAutomaticTransactionGenerator() { | |
ad2f27c3 | 865 | if (this.stationInfo.AutomaticTransactionGenerator.enable) { |
265e4266 JB |
866 | if (!this.automaticTransactionGenerator) { |
867 | this.automaticTransactionGenerator = new AutomaticTransactionGenerator(this); | |
5ad8570f | 868 | } |
265e4266 JB |
869 | if (!this.automaticTransactionGenerator.started) { |
870 | this.automaticTransactionGenerator.start(); | |
5ad8570f JB |
871 | } |
872 | } | |
5ad8570f JB |
873 | } |
874 | ||
c0560973 | 875 | private async stopMessageSequence(reason: StopTransactionReason = StopTransactionReason.NONE): Promise<void> { |
136c90ba | 876 | // Stop WebSocket ping |
c0560973 | 877 | this.stopWebSocketPing(); |
79411696 | 878 | // Stop heartbeat |
c0560973 | 879 | this.stopHeartbeat(); |
79411696 | 880 | // Stop the ATG |
ad2f27c3 | 881 | if (this.stationInfo.AutomaticTransactionGenerator.enable && |
265e4266 JB |
882 | this.automaticTransactionGenerator && |
883 | this.automaticTransactionGenerator.started) { | |
0045cef5 | 884 | this.automaticTransactionGenerator.stop(); |
79411696 | 885 | } else { |
734d790d JB |
886 | for (const connectorId of this.connectors.keys()) { |
887 | if (connectorId > 0 && this.getConnectorStatus(connectorId)?.transactionStarted) { | |
888 | const transactionId = this.getConnectorStatus(connectorId).transactionId; | |
6ed92bc1 JB |
889 | await this.ocppRequestService.sendStopTransaction(transactionId, this.getEnergyActiveImportRegisterByTransactionId(transactionId), |
890 | this.getTransactionIdTag(transactionId), reason); | |
79411696 JB |
891 | } |
892 | } | |
893 | } | |
894 | } | |
895 | ||
c0560973 | 896 | private startWebSocketPing(): void { |
9cd3dfb0 JB |
897 | const webSocketPingInterval: number = this.getConfigurationKey(StandardParametersKey.WebSocketPingInterval) |
898 | ? Utils.convertToInt(this.getConfigurationKey(StandardParametersKey.WebSocketPingInterval).value) | |
899 | : 0; | |
ad2f27c3 JB |
900 | if (webSocketPingInterval > 0 && !this.webSocketPingSetInterval) { |
901 | this.webSocketPingSetInterval = setInterval(() => { | |
d5bff457 | 902 | if (this.isWebSocketConnectionOpened()) { |
0dad4bda | 903 | this.wsConnection.ping((): void => { /* This is intentional */ }); |
136c90ba JB |
904 | } |
905 | }, webSocketPingInterval * 1000); | |
d7d1db72 | 906 | logger.info(this.logPrefix() + ' WebSocket ping started every ' + Utils.formatDurationSeconds(webSocketPingInterval)); |
ad2f27c3 | 907 | } else if (this.webSocketPingSetInterval) { |
d7d1db72 | 908 | logger.info(this.logPrefix() + ' WebSocket ping every ' + Utils.formatDurationSeconds(webSocketPingInterval) + ' already started'); |
136c90ba | 909 | } else { |
d7d1db72 | 910 | logger.error(`${this.logPrefix()} WebSocket ping interval set to ${webSocketPingInterval ? Utils.formatDurationSeconds(webSocketPingInterval) : webSocketPingInterval}, not starting the WebSocket ping`); |
136c90ba JB |
911 | } |
912 | } | |
913 | ||
c0560973 | 914 | private stopWebSocketPing(): void { |
ad2f27c3 JB |
915 | if (this.webSocketPingSetInterval) { |
916 | clearInterval(this.webSocketPingSetInterval); | |
136c90ba JB |
917 | } |
918 | } | |
919 | ||
57939a9d | 920 | private getSupervisionURL(): URL { |
c0560973 JB |
921 | const supervisionUrls = Utils.cloneObject<string | string[]>(this.stationInfo.supervisionURL ? this.stationInfo.supervisionURL : Configuration.getSupervisionURLs()); |
922 | let indexUrl = 0; | |
923 | if (!Utils.isEmptyArray(supervisionUrls)) { | |
924 | if (Configuration.getDistributeStationsToTenantsEqually()) { | |
925 | indexUrl = this.index % supervisionUrls.length; | |
926 | } else { | |
927 | // Get a random url | |
c37528f1 | 928 | indexUrl = Math.floor(Utils.secureRandom() * supervisionUrls.length); |
c0560973 | 929 | } |
57939a9d | 930 | return new URL(supervisionUrls[indexUrl]); |
c0560973 | 931 | } |
57939a9d | 932 | return new URL(supervisionUrls as string); |
136c90ba JB |
933 | } |
934 | ||
6e0964c8 | 935 | private getHeartbeatInterval(): number | undefined { |
c0560973 JB |
936 | const HeartbeatInterval = this.getConfigurationKey(StandardParametersKey.HeartbeatInterval); |
937 | if (HeartbeatInterval) { | |
938 | return Utils.convertToInt(HeartbeatInterval.value) * 1000; | |
939 | } | |
940 | const HeartBeatInterval = this.getConfigurationKey(StandardParametersKey.HeartBeatInterval); | |
941 | if (HeartBeatInterval) { | |
942 | return Utils.convertToInt(HeartBeatInterval.value) * 1000; | |
0a60c33c | 943 | } |
47e22477 JB |
944 | !this.stationInfo.autoRegister && logger.warn(`${this.logPrefix()} Heartbeat interval configuration key not set, using default value: ${Constants.DEFAULT_HEARTBEAT_INTERVAL}`); |
945 | return Constants.DEFAULT_HEARTBEAT_INTERVAL; | |
0a60c33c JB |
946 | } |
947 | ||
c0560973 | 948 | private stopHeartbeat(): void { |
ad2f27c3 JB |
949 | if (this.heartbeatSetInterval) { |
950 | clearInterval(this.heartbeatSetInterval); | |
7dde0b73 | 951 | } |
5ad8570f JB |
952 | } |
953 | ||
15042c5f | 954 | private openWSConnection(options?: ClientOptions & ClientRequestArgs, forceCloseOpened = false): void { |
2891f761 JB |
955 | options = options ?? {}; |
956 | options.handshakeTimeout = options?.handshakeTimeout ?? this.getConnectionTimeout() * 1000; | |
15042c5f JB |
957 | if (!Utils.isNullOrUndefined(this.stationInfo.supervisionUser) && !Utils.isNullOrUndefined(this.stationInfo.supervisionPassword)) { |
958 | options.auth = `${this.stationInfo.supervisionUser}:${this.stationInfo.supervisionPassword}`; | |
959 | } | |
d5bff457 | 960 | if (this.isWebSocketConnectionOpened() && forceCloseOpened) { |
c0560973 JB |
961 | this.wsConnection.close(); |
962 | } | |
963 | let protocol; | |
964 | switch (this.getOCPPVersion()) { | |
965 | case OCPPVersion.VERSION_16: | |
966 | protocol = 'ocpp' + OCPPVersion.VERSION_16; | |
967 | break; | |
968 | default: | |
969 | this.handleUnsupportedVersion(this.getOCPPVersion()); | |
970 | break; | |
971 | } | |
972 | this.wsConnection = new WebSocket(this.wsConnectionUrl, protocol, options); | |
e9017bfc | 973 | logger.info(this.logPrefix() + ' Open OCPP connection to URL ' + this.wsConnectionUrl.toString()); |
136c90ba JB |
974 | } |
975 | ||
dd119a6b | 976 | private stopMeterValues(connectorId: number) { |
734d790d JB |
977 | if (this.getConnectorStatus(connectorId)?.transactionSetInterval) { |
978 | clearInterval(this.getConnectorStatus(connectorId).transactionSetInterval); | |
dd119a6b JB |
979 | } |
980 | } | |
981 | ||
c0560973 | 982 | private startAuthorizationFileMonitoring(): void { |
23132a44 JB |
983 | const authorizationFile = this.getAuthorizationFile(); |
984 | if (authorizationFile) { | |
5ad8570f | 985 | try { |
3ec10737 JB |
986 | fs.watch(authorizationFile, (event, filename) => { |
987 | if (filename && event === 'change') { | |
988 | try { | |
989 | logger.debug(this.logPrefix() + ' Authorization file ' + authorizationFile + ' have changed, reload'); | |
990 | // Initialize authorizedTags | |
991 | this.authorizedTags = this.getAuthorizedTags(); | |
992 | } catch (error) { | |
993 | logger.error(this.logPrefix() + ' Authorization file monitoring error: %j', error); | |
994 | } | |
23132a44 JB |
995 | } |
996 | }); | |
5ad8570f | 997 | } catch (error) { |
23132a44 | 998 | FileUtils.handleFileException(this.logPrefix(), 'Authorization', authorizationFile, error); |
5ad8570f | 999 | } |
23132a44 JB |
1000 | } else { |
1001 | logger.info(this.logPrefix() + ' No authorization file given in template file ' + this.stationTemplateFile + '. Not monitoring changes'); | |
1002 | } | |
5ad8570f JB |
1003 | } |
1004 | ||
c0560973 | 1005 | private startStationTemplateFileMonitoring(): void { |
23132a44 | 1006 | try { |
b809adf1 | 1007 | fs.watch(this.stationTemplateFile, (event, filename): void => { |
3ec10737 JB |
1008 | if (filename && event === 'change') { |
1009 | try { | |
1010 | logger.debug(this.logPrefix() + ' Template file ' + this.stationTemplateFile + ' have changed, reload'); | |
1011 | // Initialize | |
1012 | this.initialize(); | |
1013 | // Restart the ATG | |
1014 | if (!this.stationInfo.AutomaticTransactionGenerator.enable && | |
32b02249 | 1015 | this.automaticTransactionGenerator) { |
0045cef5 | 1016 | this.automaticTransactionGenerator.stop(); |
3ec10737 JB |
1017 | } |
1018 | this.startAutomaticTransactionGenerator(); | |
1019 | if (this.getEnableStatistics()) { | |
1020 | this.performanceStatistics.restart(); | |
1021 | } else { | |
1022 | this.performanceStatistics.stop(); | |
1023 | } | |
1024 | // FIXME?: restart heartbeat and WebSocket ping when their interval values have changed | |
1025 | } catch (error) { | |
1026 | logger.error(this.logPrefix() + ' Charging station template file monitoring error: %j', error); | |
087a502d | 1027 | } |
79411696 | 1028 | } |
23132a44 JB |
1029 | }); |
1030 | } catch (error) { | |
1031 | FileUtils.handleFileException(this.logPrefix(), 'Template', this.stationTemplateFile, error); | |
1032 | } | |
5ad8570f JB |
1033 | } |
1034 | ||
6e0964c8 | 1035 | private getReconnectExponentialDelay(): boolean | undefined { |
c0560973 | 1036 | return !Utils.isUndefined(this.stationInfo.reconnectExponentialDelay) ? this.stationInfo.reconnectExponentialDelay : false; |
5ad8570f JB |
1037 | } |
1038 | ||
d09085e9 | 1039 | private async reconnect(code: number): Promise<void> { |
7874b0b1 JB |
1040 | // Stop WebSocket ping |
1041 | this.stopWebSocketPing(); | |
136c90ba | 1042 | // Stop heartbeat |
c0560973 | 1043 | this.stopHeartbeat(); |
5ad8570f | 1044 | // Stop the ATG if needed |
ad2f27c3 JB |
1045 | if (this.stationInfo.AutomaticTransactionGenerator.enable && |
1046 | this.stationInfo.AutomaticTransactionGenerator.stopOnConnectionFailure && | |
265e4266 JB |
1047 | this.automaticTransactionGenerator && |
1048 | this.automaticTransactionGenerator.started) { | |
0045cef5 | 1049 | this.automaticTransactionGenerator.stop(); |
ad2f27c3 | 1050 | } |
c0560973 | 1051 | if (this.autoReconnectRetryCount < this.getAutoReconnectMaxRetries() || this.getAutoReconnectMaxRetries() === -1) { |
ad2f27c3 | 1052 | this.autoReconnectRetryCount++; |
c0560973 | 1053 | const reconnectDelay = (this.getReconnectExponentialDelay() ? Utils.exponentialDelay(this.autoReconnectRetryCount) : this.getConnectionTimeout() * 1000); |
a0f59b75 | 1054 | const reconnectTimeout = reconnectDelay - 100; |
5dc8b1b5 | 1055 | logger.error(`${this.logPrefix()} WebSocket: connection retry in ${Utils.roundTo(reconnectDelay, 2)}ms, timeout ${reconnectTimeout}ms`); |
032d6efc | 1056 | await Utils.sleep(reconnectDelay); |
5dc8b1b5 | 1057 | logger.error(this.logPrefix() + ' WebSocket: reconnecting try #' + this.autoReconnectRetryCount.toString()); |
a0f59b75 | 1058 | this.openWSConnection({ handshakeTimeout: reconnectTimeout }, true); |
265e4266 | 1059 | this.wsConnectionRestarted = true; |
c0560973 | 1060 | } else if (this.getAutoReconnectMaxRetries() !== -1) { |
5dc8b1b5 | 1061 | logger.error(`${this.logPrefix()} WebSocket reconnect failure: max retries reached (${this.autoReconnectRetryCount}) or retry disabled (${this.getAutoReconnectMaxRetries()})`); |
5ad8570f JB |
1062 | } |
1063 | } | |
1064 | ||
6ed92bc1 | 1065 | private initTransactionAttributesOnConnector(connectorId: number): void { |
734d790d JB |
1066 | this.getConnectorStatus(connectorId).authorized = false; |
1067 | this.getConnectorStatus(connectorId).transactionStarted = false; | |
1068 | this.getConnectorStatus(connectorId).energyActiveImportRegisterValue = 0; | |
1069 | this.getConnectorStatus(connectorId).transactionEnergyActiveImportRegisterValue = 0; | |
0a60c33c | 1070 | } |
7dde0b73 JB |
1071 | } |
1072 |