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; |
8e242273 | 55 | private readonly messageBuffer: Set<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>(); |
8e242273 | 74 | this.messageBuffer = new Set<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 | ||
a2653482 JB |
403 | public resetConnectorStatus(connectorId: number): void { |
404 | this.getConnectorStatus(connectorId).idTagLocalAuthorized = false; | |
405 | this.getConnectorStatus(connectorId).idTagAuthorized = false; | |
406 | this.getConnectorStatus(connectorId).transactionRemoteStarted = false; | |
734d790d | 407 | this.getConnectorStatus(connectorId).transactionStarted = false; |
a2653482 | 408 | delete this.getConnectorStatus(connectorId).localAuthorizeIdTag; |
734d790d JB |
409 | delete this.getConnectorStatus(connectorId).authorizeIdTag; |
410 | delete this.getConnectorStatus(connectorId).transactionId; | |
411 | delete this.getConnectorStatus(connectorId).transactionIdTag; | |
412 | this.getConnectorStatus(connectorId).transactionEnergyActiveImportRegisterValue = 0; | |
413 | delete this.getConnectorStatus(connectorId).transactionBeginMeterValue; | |
dd119a6b | 414 | this.stopMeterValues(connectorId); |
2e6f5966 JB |
415 | } |
416 | ||
8e242273 JB |
417 | public bufferMessage(message: string): void { |
418 | this.messageBuffer.add(message); | |
3ba2381e JB |
419 | } |
420 | ||
8e242273 JB |
421 | private flushMessageBuffer() { |
422 | if (this.messageBuffer.size > 0) { | |
423 | this.messageBuffer.forEach((message) => { | |
aef1b33a | 424 | // TODO: evaluate the need to track performance |
77f00f84 | 425 | this.wsConnection.send(message); |
8e242273 | 426 | this.messageBuffer.delete(message); |
77f00f84 JB |
427 | }); |
428 | } | |
429 | } | |
430 | ||
c0560973 | 431 | private getChargingStationId(stationTemplate: ChargingStationTemplate): string { |
ef6076c1 | 432 | // In case of multiple instances: add instance index to charging station id |
203bc097 | 433 | const instanceIndex = process.env.CF_INSTANCE_INDEX ?? 0; |
9ccca265 | 434 | const idSuffix = stationTemplate.nameSuffix ?? ''; |
ad2f27c3 | 435 | return stationTemplate.fixedName ? stationTemplate.baseName : stationTemplate.baseName + '-' + instanceIndex.toString() + ('000000000' + this.index.toString()).substr(('000000000' + this.index.toString()).length - 4) + idSuffix; |
5ad8570f JB |
436 | } |
437 | ||
c0560973 | 438 | private buildStationInfo(): ChargingStationInfo { |
9ac86a7e | 439 | let stationTemplateFromFile: ChargingStationTemplate; |
5ad8570f JB |
440 | try { |
441 | // Load template file | |
ad2f27c3 | 442 | const fileDescriptor = fs.openSync(this.stationTemplateFile, 'r'); |
9ac86a7e | 443 | stationTemplateFromFile = JSON.parse(fs.readFileSync(fileDescriptor, 'utf8')) as ChargingStationTemplate; |
5ad8570f JB |
444 | fs.closeSync(fileDescriptor); |
445 | } catch (error) { | |
23132a44 | 446 | FileUtils.handleFileException(this.logPrefix(), 'Template', this.stationTemplateFile, error); |
5ad8570f | 447 | } |
510f0fa5 | 448 | const stationInfo: ChargingStationInfo = stationTemplateFromFile ?? {} as ChargingStationInfo; |
cd8dd457 | 449 | stationInfo.wsOptions = stationTemplateFromFile?.wsOptions ?? {}; |
0a60c33c | 450 | if (!Utils.isEmptyArray(stationTemplateFromFile.power)) { |
9ac86a7e | 451 | stationTemplateFromFile.power = stationTemplateFromFile.power as number[]; |
c37528f1 | 452 | const powerArrayRandomIndex = Math.floor(Utils.secureRandom() * stationTemplateFromFile.power.length); |
510f0fa5 JB |
453 | stationInfo.maxPower = stationTemplateFromFile.powerUnit === PowerUnits.KILO_WATT |
454 | ? stationTemplateFromFile.power[powerArrayRandomIndex] * 1000 | |
455 | : stationTemplateFromFile.power[powerArrayRandomIndex]; | |
5ad8570f | 456 | } else { |
510f0fa5 JB |
457 | stationTemplateFromFile.power = stationTemplateFromFile.power as number; |
458 | stationInfo.maxPower = stationTemplateFromFile.powerUnit === PowerUnits.KILO_WATT | |
fd0c36fa | 459 | ? stationTemplateFromFile.power * 1000 |
510f0fa5 | 460 | : stationTemplateFromFile.power; |
5ad8570f | 461 | } |
fd0c36fa JB |
462 | delete stationInfo.power; |
463 | delete stationInfo.powerUnit; | |
c0560973 | 464 | stationInfo.chargingStationId = this.getChargingStationId(stationTemplateFromFile); |
9ac86a7e JB |
465 | stationInfo.resetTime = stationTemplateFromFile.resetTime ? stationTemplateFromFile.resetTime * 1000 : Constants.CHARGING_STATION_DEFAULT_RESET_TIME; |
466 | return stationInfo; | |
5ad8570f JB |
467 | } |
468 | ||
c0560973 JB |
469 | private getOCPPVersion(): OCPPVersion { |
470 | return this.stationInfo.ocppVersion ? this.stationInfo.ocppVersion : OCPPVersion.VERSION_16; | |
471 | } | |
472 | ||
473 | private handleUnsupportedVersion(version: OCPPVersion) { | |
474 | const errMsg = `${this.logPrefix()} Unsupported protocol version '${version}' configured in template file ${this.stationTemplateFile}`; | |
475 | logger.error(errMsg); | |
476 | throw new Error(errMsg); | |
477 | } | |
478 | ||
479 | private initialize(): void { | |
480 | this.stationInfo = this.buildStationInfo(); | |
37486900 | 481 | this.configuration = this.getTemplateChargingStationConfiguration(); |
ad2f27c3 JB |
482 | this.bootNotificationRequest = { |
483 | chargePointModel: this.stationInfo.chargePointModel, | |
484 | chargePointVendor: this.stationInfo.chargePointVendor, | |
485 | ...!Utils.isUndefined(this.stationInfo.chargeBoxSerialNumberPrefix) && { chargeBoxSerialNumber: this.stationInfo.chargeBoxSerialNumberPrefix }, | |
486 | ...!Utils.isUndefined(this.stationInfo.firmwareVersion) && { firmwareVersion: this.stationInfo.firmwareVersion }, | |
2e6f5966 | 487 | }; |
57939a9d | 488 | this.wsConnectionUrl = new URL(this.getSupervisionURL().href + '/' + this.stationInfo.chargingStationId); |
0a60c33c | 489 | // Build connectors if needed |
c0560973 | 490 | const maxConnectors = this.getMaxNumberOfConnectors(); |
6ecb15e4 | 491 | if (maxConnectors <= 0) { |
c0560973 | 492 | logger.warn(`${this.logPrefix()} Charging station template ${this.stationTemplateFile} with ${maxConnectors} connectors`); |
7abfea5f | 493 | } |
c0560973 | 494 | const templateMaxConnectors = this.getTemplateMaxNumberOfConnectors(); |
7abfea5f | 495 | if (templateMaxConnectors <= 0) { |
c0560973 | 496 | logger.warn(`${this.logPrefix()} Charging station template ${this.stationTemplateFile} with no connector configuration`); |
593cf3f9 | 497 | } |
ad2f27c3 | 498 | if (!this.stationInfo.Connectors[0]) { |
c0560973 | 499 | logger.warn(`${this.logPrefix()} Charging station template ${this.stationTemplateFile} with no connector Id 0 configuration`); |
7abfea5f JB |
500 | } |
501 | // Sanity check | |
ad2f27c3 | 502 | if (maxConnectors > (this.stationInfo.Connectors[0] ? templateMaxConnectors - 1 : templateMaxConnectors) && !this.stationInfo.randomConnectors) { |
c0560973 | 503 | logger.warn(`${this.logPrefix()} Number of connectors exceeds the number of connector configurations in template ${this.stationTemplateFile}, forcing random connector configurations affectation`); |
ad2f27c3 | 504 | this.stationInfo.randomConnectors = true; |
6ecb15e4 | 505 | } |
ad2f27c3 | 506 | const connectorsConfigHash = crypto.createHash('sha256').update(JSON.stringify(this.stationInfo.Connectors) + maxConnectors.toString()).digest('hex'); |
54544ef1 JB |
507 | const connectorsConfigChanged = this.connectors?.size !== 0 && this.connectorsConfigurationHash !== connectorsConfigHash; |
508 | if (this.connectors?.size === 0 || connectorsConfigChanged) { | |
734d790d | 509 | connectorsConfigChanged && (this.connectors.clear()); |
ad2f27c3 | 510 | this.connectorsConfigurationHash = connectorsConfigHash; |
7abfea5f | 511 | // Add connector Id 0 |
6af9012e | 512 | let lastConnector = '0'; |
ad2f27c3 | 513 | for (lastConnector in this.stationInfo.Connectors) { |
734d790d JB |
514 | const lastConnectorId = Utils.convertToInt(lastConnector); |
515 | if (lastConnectorId === 0 && this.getUseConnectorId0() && this.stationInfo.Connectors[lastConnector]) { | |
516 | this.connectors.set(lastConnectorId, Utils.cloneObject<ConnectorStatus>(this.stationInfo.Connectors[lastConnector])); | |
517 | this.getConnectorStatus(lastConnectorId).availability = AvailabilityType.OPERATIVE; | |
518 | if (Utils.isUndefined(this.getConnectorStatus(lastConnectorId)?.chargingProfiles)) { | |
519 | this.getConnectorStatus(lastConnectorId).chargingProfiles = []; | |
418106c8 | 520 | } |
0a60c33c JB |
521 | } |
522 | } | |
0a60c33c | 523 | // Generate all connectors |
ad2f27c3 | 524 | if ((this.stationInfo.Connectors[0] ? templateMaxConnectors - 1 : templateMaxConnectors) > 0) { |
7abfea5f | 525 | for (let index = 1; index <= maxConnectors; index++) { |
72740232 | 526 | const randConnectorId = this.stationInfo.randomConnectors ? Utils.getRandomInteger(Utils.convertToInt(lastConnector), 1) : index; |
734d790d JB |
527 | this.connectors.set(index, Utils.cloneObject<ConnectorStatus>(this.stationInfo.Connectors[randConnectorId])); |
528 | this.getConnectorStatus(index).availability = AvailabilityType.OPERATIVE; | |
529 | if (Utils.isUndefined(this.getConnectorStatus(index)?.chargingProfiles)) { | |
530 | this.getConnectorStatus(index).chargingProfiles = []; | |
418106c8 | 531 | } |
7abfea5f | 532 | } |
0a60c33c JB |
533 | } |
534 | } | |
d4a73fb7 | 535 | // Avoid duplication of connectors related information |
ad2f27c3 | 536 | delete this.stationInfo.Connectors; |
0a60c33c | 537 | // Initialize transaction attributes on connectors |
734d790d JB |
538 | for (const connectorId of this.connectors.keys()) { |
539 | if (connectorId > 0 && !this.getConnectorStatus(connectorId)?.transactionStarted) { | |
a2653482 | 540 | this.initializeConnectorStatus(connectorId); |
0a60c33c JB |
541 | } |
542 | } | |
c0560973 JB |
543 | switch (this.getOCPPVersion()) { |
544 | case OCPPVersion.VERSION_16: | |
545 | this.ocppIncomingRequestService = new OCPP16IncomingRequestService(this); | |
546 | this.ocppRequestService = new OCPP16RequestService(this, new OCPP16ResponseService(this)); | |
547 | break; | |
548 | default: | |
549 | this.handleUnsupportedVersion(this.getOCPPVersion()); | |
550 | break; | |
551 | } | |
7abfea5f | 552 | // OCPP parameters |
147d0e0f | 553 | this.initOCPPParameters(); |
47e22477 JB |
554 | if (this.stationInfo.autoRegister) { |
555 | this.bootNotificationResponse = { | |
556 | currentTime: new Date().toISOString(), | |
557 | interval: this.getHeartbeatInterval() / 1000, | |
558 | status: RegistrationStatus.ACCEPTED | |
559 | }; | |
560 | } | |
147d0e0f JB |
561 | this.stationInfo.powerDivider = this.getPowerDivider(); |
562 | if (this.getEnableStatistics()) { | |
2a370053 | 563 | this.performanceStatistics = new PerformanceStatistics(this.stationInfo.chargingStationId, this.wsConnectionUrl); |
147d0e0f JB |
564 | } |
565 | } | |
566 | ||
567 | private initOCPPParameters(): void { | |
36f6a92e JB |
568 | if (!this.getConfigurationKey(StandardParametersKey.SupportedFeatureProfiles)) { |
569 | this.addConfigurationKey(StandardParametersKey.SupportedFeatureProfiles, `${SupportedFeatureProfiles.Core},${SupportedFeatureProfiles.Local_Auth_List_Management},${SupportedFeatureProfiles.Smart_Charging}`); | |
570 | } | |
c0560973 JB |
571 | this.addConfigurationKey(StandardParametersKey.NumberOfConnectors, this.getNumberOfConnectors().toString(), true); |
572 | if (!this.getConfigurationKey(StandardParametersKey.MeterValuesSampledData)) { | |
573 | this.addConfigurationKey(StandardParametersKey.MeterValuesSampledData, MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER); | |
7abfea5f | 574 | } |
7e1dc878 JB |
575 | if (!this.getConfigurationKey(StandardParametersKey.ConnectorPhaseRotation)) { |
576 | const connectorPhaseRotation = []; | |
734d790d | 577 | for (const connectorId of this.connectors.keys()) { |
7e1dc878 | 578 | // AC/DC |
734d790d JB |
579 | if (connectorId === 0 && this.getNumberOfPhases() === 0) { |
580 | connectorPhaseRotation.push(`${connectorId}.${ConnectorPhaseRotation.RST}`); | |
581 | } else if (connectorId > 0 && this.getNumberOfPhases() === 0) { | |
582 | connectorPhaseRotation.push(`${connectorId}.${ConnectorPhaseRotation.NotApplicable}`); | |
7e1dc878 | 583 | // AC |
734d790d JB |
584 | } else if (connectorId > 0 && this.getNumberOfPhases() === 1) { |
585 | connectorPhaseRotation.push(`${connectorId}.${ConnectorPhaseRotation.NotApplicable}`); | |
586 | } else if (connectorId > 0 && this.getNumberOfPhases() === 3) { | |
587 | connectorPhaseRotation.push(`${connectorId}.${ConnectorPhaseRotation.RST}`); | |
7e1dc878 JB |
588 | } |
589 | } | |
590 | this.addConfigurationKey(StandardParametersKey.ConnectorPhaseRotation, connectorPhaseRotation.toString()); | |
591 | } | |
36f6a92e JB |
592 | if (!this.getConfigurationKey(StandardParametersKey.AuthorizeRemoteTxRequests)) { |
593 | this.addConfigurationKey(StandardParametersKey.AuthorizeRemoteTxRequests, 'true'); | |
594 | } | |
595 | if (!this.getConfigurationKey(StandardParametersKey.LocalAuthListEnabled) | |
32b02249 | 596 | && this.getConfigurationKey(StandardParametersKey.SupportedFeatureProfiles).value.includes(SupportedFeatureProfiles.Local_Auth_List_Management)) { |
36f6a92e JB |
597 | this.addConfigurationKey(StandardParametersKey.LocalAuthListEnabled, 'false'); |
598 | } | |
147d0e0f JB |
599 | if (!this.getConfigurationKey(StandardParametersKey.ConnectionTimeOut)) { |
600 | this.addConfigurationKey(StandardParametersKey.ConnectionTimeOut, Constants.DEFAULT_CONNECTION_TIMEOUT.toString()); | |
8bce55bf | 601 | } |
7dde0b73 JB |
602 | } |
603 | ||
c0560973 | 604 | private async onOpen(): Promise<void> { |
e9017bfc | 605 | logger.info(`${this.logPrefix()} Connected to OCPP server through ${this.wsConnectionUrl.toString()}`); |
c0560973 JB |
606 | if (!this.isRegistered()) { |
607 | // Send BootNotification | |
608 | let registrationRetryCount = 0; | |
609 | do { | |
43d673d9 JB |
610 | this.bootNotificationResponse = await this.ocppRequestService.sendBootNotification(this.bootNotificationRequest.chargePointModel, |
611 | this.bootNotificationRequest.chargePointVendor, this.bootNotificationRequest.chargeBoxSerialNumber, this.bootNotificationRequest.firmwareVersion); | |
c0560973 JB |
612 | if (!this.isRegistered()) { |
613 | registrationRetryCount++; | |
614 | await Utils.sleep(this.bootNotificationResponse?.interval ? this.bootNotificationResponse.interval * 1000 : Constants.OCPP_DEFAULT_BOOT_NOTIFICATION_INTERVAL); | |
615 | } | |
616 | } while (!this.isRegistered() && (registrationRetryCount <= this.getRegistrationMaxRetries() || this.getRegistrationMaxRetries() === -1)); | |
c7db4718 JB |
617 | } |
618 | if (this.isRegistered()) { | |
c0560973 | 619 | await this.startMessageSequence(); |
265e4266 JB |
620 | this.stopped && (this.stopped = false); |
621 | if (this.wsConnectionRestarted && this.isWebSocketConnectionOpened()) { | |
8e242273 | 622 | this.flushMessageBuffer(); |
2e6f5966 JB |
623 | } |
624 | } else { | |
c0560973 | 625 | logger.error(`${this.logPrefix()} Registration failure: max retries reached (${this.getRegistrationMaxRetries()}) or retry disabled (${this.getRegistrationMaxRetries()})`); |
2e6f5966 | 626 | } |
c0560973 | 627 | this.autoReconnectRetryCount = 0; |
265e4266 | 628 | this.wsConnectionRestarted = false; |
2e6f5966 JB |
629 | } |
630 | ||
6c65a295 | 631 | private async onClose(code: number, reason: string): Promise<void> { |
d09085e9 | 632 | switch (code) { |
6c65a295 JB |
633 | // Normal close |
634 | case WebSocketCloseEventStatusCode.CLOSE_NORMAL: | |
c0560973 | 635 | case WebSocketCloseEventStatusCode.CLOSE_NO_STATUS: |
5dc8b1b5 | 636 | logger.info(`${this.logPrefix()} WebSocket normally closed with status '${Utils.getWebSocketCloseEventStatusString(code)}' and reason '${reason}'`); |
c0560973 JB |
637 | this.autoReconnectRetryCount = 0; |
638 | break; | |
6c65a295 JB |
639 | // Abnormal close |
640 | default: | |
5dc8b1b5 | 641 | logger.error(`${this.logPrefix()} WebSocket abnormally closed with status '${Utils.getWebSocketCloseEventStatusString(code)}' and reason '${reason}'`); |
d09085e9 | 642 | await this.reconnect(code); |
c0560973 JB |
643 | break; |
644 | } | |
2e6f5966 JB |
645 | } |
646 | ||
16b0d4e7 | 647 | private async onMessage(data: Data): Promise<void> { |
c0560973 | 648 | let [messageType, messageId, commandName, commandPayload, errorDetails]: IncomingRequest = [0, '', '' as IncomingRequestCommand, {}, {}]; |
193d2c0a | 649 | let responseCallback: (payload: Record<string, unknown> | string, requestPayload: Record<string, unknown>) => void; |
9239b49a | 650 | let rejectCallback: (error: OCPPError, requestStatistic?: boolean) => void; |
32b02249 | 651 | let requestCommandName: RequestCommand | IncomingRequestCommand; |
c0560973 | 652 | let requestPayload: Record<string, unknown>; |
32b02249 | 653 | let cachedRequest: CachedRequest; |
c0560973 JB |
654 | let errMsg: string; |
655 | try { | |
16b0d4e7 | 656 | const request = JSON.parse(data.toString()) as IncomingRequest; |
47e22477 JB |
657 | if (Utils.isIterable(request)) { |
658 | // Parse the message | |
659 | [messageType, messageId, commandName, commandPayload, errorDetails] = request; | |
660 | } else { | |
a6b3c6c3 | 661 | throw new OCPPError(ErrorType.PROTOCOL_ERROR, 'Incoming request is not iterable', commandName); |
47e22477 | 662 | } |
c0560973 JB |
663 | // Check the Type of message |
664 | switch (messageType) { | |
665 | // Incoming Message | |
666 | case MessageType.CALL_MESSAGE: | |
667 | if (this.getEnableStatistics()) { | |
aef1b33a | 668 | this.performanceStatistics.addRequestStatistic(commandName, messageType); |
c0560973 JB |
669 | } |
670 | // Process the call | |
671 | await this.ocppIncomingRequestService.handleRequest(messageId, commandName, commandPayload); | |
672 | break; | |
673 | // Outcome Message | |
674 | case MessageType.CALL_RESULT_MESSAGE: | |
675 | // Respond | |
16b0d4e7 JB |
676 | cachedRequest = this.requests.get(messageId); |
677 | if (Utils.isIterable(cachedRequest)) { | |
32b02249 | 678 | [responseCallback, , , requestPayload] = cachedRequest; |
c0560973 | 679 | } else { |
a685c3af | 680 | throw new OCPPError(ErrorType.PROTOCOL_ERROR, `Cached request for message id ${messageId} response is not iterable`, commandName); |
c0560973 JB |
681 | } |
682 | if (!responseCallback) { | |
683 | // Error | |
a685c3af | 684 | throw new OCPPError(ErrorType.INTERNAL_ERROR, `Response for unknown message id ${messageId}`, commandName); |
c0560973 | 685 | } |
c0560973 JB |
686 | responseCallback(commandName, requestPayload); |
687 | break; | |
688 | // Error Message | |
689 | case MessageType.CALL_ERROR_MESSAGE: | |
16b0d4e7 | 690 | cachedRequest = this.requests.get(messageId); |
16b0d4e7 | 691 | if (Utils.isIterable(cachedRequest)) { |
32b02249 | 692 | [, rejectCallback, requestCommandName] = cachedRequest; |
c0560973 | 693 | } else { |
a685c3af | 694 | throw new OCPPError(ErrorType.PROTOCOL_ERROR, `Cached request for message id ${messageId} error response is not iterable`); |
c0560973 | 695 | } |
32b02249 JB |
696 | if (!rejectCallback) { |
697 | // Error | |
a685c3af | 698 | throw new OCPPError(ErrorType.INTERNAL_ERROR, `Error response for unknown message id ${messageId}`, requestCommandName); |
32b02249 JB |
699 | } |
700 | rejectCallback(new OCPPError(commandName, commandPayload.toString(), requestCommandName, errorDetails)); | |
c0560973 JB |
701 | break; |
702 | // Error | |
703 | default: | |
704 | errMsg = `${this.logPrefix()} Wrong message type ${messageType}`; | |
705 | logger.error(errMsg); | |
14763b46 | 706 | throw new OCPPError(ErrorType.PROTOCOL_ERROR, errMsg); |
c0560973 JB |
707 | } |
708 | } catch (error) { | |
709 | // Log | |
6d9abcc2 | 710 | logger.error('%s Incoming OCPP message %j matching cached request %j processing error %j', this.logPrefix(), data.toString(), this.requests.get(messageId), error); |
c0560973 | 711 | // Send error |
32b02249 | 712 | messageType === MessageType.CALL_MESSAGE && await this.ocppRequestService.sendError(messageId, error, commandName); |
c0560973 | 713 | } |
2328be1e JB |
714 | } |
715 | ||
c0560973 | 716 | private onPing(): void { |
57939a9d | 717 | logger.debug(this.logPrefix() + ' Received a WS ping (rfc6455) from the server'); |
c0560973 JB |
718 | } |
719 | ||
720 | private onPong(): void { | |
57939a9d | 721 | logger.debug(this.logPrefix() + ' Received a WS pong (rfc6455) from the server'); |
c0560973 JB |
722 | } |
723 | ||
16b0d4e7 | 724 | private async onError(error: WSError): Promise<void> { |
5dc8b1b5 | 725 | logger.error(this.logPrefix() + ' WebSocket error: %j', error); |
16b0d4e7 | 726 | // switch (error.code) { |
c0560973 | 727 | // case 'ECONNREFUSED': |
16b0d4e7 | 728 | // await this.reconnect(error); |
c0560973 JB |
729 | // break; |
730 | // } | |
731 | } | |
732 | ||
733 | private getTemplateChargingStationConfiguration(): ChargingStationConfiguration { | |
7874b0b1 | 734 | return this.stationInfo.Configuration ?? {} as ChargingStationConfiguration; |
c0560973 JB |
735 | } |
736 | ||
6e0964c8 | 737 | private getAuthorizationFile(): string | undefined { |
bf1866b2 | 738 | return this.stationInfo.authorizationFile && path.join(path.resolve(__dirname, '../'), 'assets', path.basename(this.stationInfo.authorizationFile)); |
c0560973 JB |
739 | } |
740 | ||
741 | private getAuthorizedTags(): string[] { | |
742 | let authorizedTags: string[] = []; | |
743 | const authorizationFile = this.getAuthorizationFile(); | |
744 | if (authorizationFile) { | |
745 | try { | |
746 | // Load authorization file | |
747 | const fileDescriptor = fs.openSync(authorizationFile, 'r'); | |
748 | authorizedTags = JSON.parse(fs.readFileSync(fileDescriptor, 'utf8')) as string[]; | |
749 | fs.closeSync(fileDescriptor); | |
750 | } catch (error) { | |
23132a44 | 751 | FileUtils.handleFileException(this.logPrefix(), 'Authorization', authorizationFile, error); |
c0560973 JB |
752 | } |
753 | } else { | |
754 | logger.info(this.logPrefix() + ' No authorization file given in template file ' + this.stationTemplateFile); | |
8c4da341 | 755 | } |
c0560973 JB |
756 | return authorizedTags; |
757 | } | |
758 | ||
6e0964c8 | 759 | private getUseConnectorId0(): boolean | undefined { |
c0560973 | 760 | return !Utils.isUndefined(this.stationInfo.useConnectorId0) ? this.stationInfo.useConnectorId0 : true; |
8bce55bf JB |
761 | } |
762 | ||
c0560973 | 763 | private getNumberOfRunningTransactions(): number { |
6ecb15e4 | 764 | let trxCount = 0; |
734d790d JB |
765 | for (const connectorId of this.connectors.keys()) { |
766 | if (connectorId > 0 && this.getConnectorStatus(connectorId)?.transactionStarted) { | |
6ecb15e4 JB |
767 | trxCount++; |
768 | } | |
769 | } | |
770 | return trxCount; | |
771 | } | |
772 | ||
1f761b9a | 773 | // 0 for disabling |
6e0964c8 | 774 | private getConnectionTimeout(): number | undefined { |
291cb255 JB |
775 | if (this.getConfigurationKey(StandardParametersKey.ConnectionTimeOut)) { |
776 | return parseInt(this.getConfigurationKey(StandardParametersKey.ConnectionTimeOut).value) ?? Constants.DEFAULT_CONNECTION_TIMEOUT; | |
777 | } | |
291cb255 | 778 | return Constants.DEFAULT_CONNECTION_TIMEOUT; |
3574dfd3 JB |
779 | } |
780 | ||
1f761b9a | 781 | // -1 for unlimited, 0 for disabling |
6e0964c8 | 782 | private getAutoReconnectMaxRetries(): number | undefined { |
ad2f27c3 JB |
783 | if (!Utils.isUndefined(this.stationInfo.autoReconnectMaxRetries)) { |
784 | return this.stationInfo.autoReconnectMaxRetries; | |
3574dfd3 JB |
785 | } |
786 | if (!Utils.isUndefined(Configuration.getAutoReconnectMaxRetries())) { | |
787 | return Configuration.getAutoReconnectMaxRetries(); | |
788 | } | |
789 | return -1; | |
790 | } | |
791 | ||
ec977daf | 792 | // 0 for disabling |
6e0964c8 | 793 | private getRegistrationMaxRetries(): number | undefined { |
ad2f27c3 JB |
794 | if (!Utils.isUndefined(this.stationInfo.registrationMaxRetries)) { |
795 | return this.stationInfo.registrationMaxRetries; | |
32a1eb7a JB |
796 | } |
797 | return -1; | |
798 | } | |
799 | ||
c0560973 JB |
800 | private getPowerDivider(): number { |
801 | let powerDivider = this.getNumberOfConnectors(); | |
ad2f27c3 | 802 | if (this.stationInfo.powerSharedByConnectors) { |
c0560973 | 803 | powerDivider = this.getNumberOfRunningTransactions(); |
6ecb15e4 JB |
804 | } |
805 | return powerDivider; | |
806 | } | |
807 | ||
c0560973 | 808 | private getTemplateMaxNumberOfConnectors(): number { |
ad2f27c3 | 809 | return Object.keys(this.stationInfo.Connectors).length; |
7abfea5f JB |
810 | } |
811 | ||
c0560973 | 812 | private getMaxNumberOfConnectors(): number { |
5ad8570f | 813 | let maxConnectors = 0; |
ad2f27c3 JB |
814 | if (!Utils.isEmptyArray(this.stationInfo.numberOfConnectors)) { |
815 | const numberOfConnectors = this.stationInfo.numberOfConnectors as number[]; | |
6ecb15e4 | 816 | // Distribute evenly the number of connectors |
ad2f27c3 JB |
817 | maxConnectors = numberOfConnectors[(this.index - 1) % numberOfConnectors.length]; |
818 | } else if (!Utils.isUndefined(this.stationInfo.numberOfConnectors)) { | |
819 | maxConnectors = this.stationInfo.numberOfConnectors as number; | |
488fd3a7 | 820 | } else { |
c0560973 | 821 | maxConnectors = this.stationInfo.Connectors[0] ? this.getTemplateMaxNumberOfConnectors() - 1 : this.getTemplateMaxNumberOfConnectors(); |
5ad8570f JB |
822 | } |
823 | return maxConnectors; | |
2e6f5966 JB |
824 | } |
825 | ||
c0560973 | 826 | private async startMessageSequence(): Promise<void> { |
136c90ba | 827 | // Start WebSocket ping |
c0560973 | 828 | this.startWebSocketPing(); |
5ad8570f | 829 | // Start heartbeat |
c0560973 | 830 | this.startHeartbeat(); |
0a60c33c | 831 | // Initialize connectors status |
734d790d JB |
832 | for (const connectorId of this.connectors.keys()) { |
833 | if (connectorId === 0) { | |
593cf3f9 | 834 | continue; |
734d790d | 835 | } else if (!this.stopped && !this.getConnectorStatus(connectorId)?.status && this.getConnectorStatus(connectorId)?.bootStatus) { |
136c90ba | 836 | // Send status in template at startup |
734d790d JB |
837 | await this.ocppRequestService.sendStatusNotification(connectorId, this.getConnectorStatus(connectorId).bootStatus); |
838 | this.getConnectorStatus(connectorId).status = this.getConnectorStatus(connectorId).bootStatus; | |
839 | } else if (this.stopped && this.getConnectorStatus(connectorId)?.status && this.getConnectorStatus(connectorId)?.bootStatus) { | |
136c90ba | 840 | // Send status in template after reset |
734d790d JB |
841 | await this.ocppRequestService.sendStatusNotification(connectorId, this.getConnectorStatus(connectorId).bootStatus); |
842 | this.getConnectorStatus(connectorId).status = this.getConnectorStatus(connectorId).bootStatus; | |
843 | } else if (!this.stopped && this.getConnectorStatus(connectorId)?.status) { | |
136c90ba | 844 | // Send previous status at template reload |
734d790d | 845 | await this.ocppRequestService.sendStatusNotification(connectorId, this.getConnectorStatus(connectorId).status); |
5ad8570f | 846 | } else { |
136c90ba | 847 | // Send default status |
734d790d JB |
848 | await this.ocppRequestService.sendStatusNotification(connectorId, ChargePointStatus.AVAILABLE); |
849 | this.getConnectorStatus(connectorId).status = ChargePointStatus.AVAILABLE; | |
5ad8570f JB |
850 | } |
851 | } | |
0a60c33c | 852 | // Start the ATG |
dd119a6b | 853 | this.startAutomaticTransactionGenerator(); |
dd119a6b JB |
854 | } |
855 | ||
856 | private startAutomaticTransactionGenerator() { | |
ad2f27c3 | 857 | if (this.stationInfo.AutomaticTransactionGenerator.enable) { |
265e4266 JB |
858 | if (!this.automaticTransactionGenerator) { |
859 | this.automaticTransactionGenerator = new AutomaticTransactionGenerator(this); | |
5ad8570f | 860 | } |
265e4266 JB |
861 | if (!this.automaticTransactionGenerator.started) { |
862 | this.automaticTransactionGenerator.start(); | |
5ad8570f JB |
863 | } |
864 | } | |
5ad8570f JB |
865 | } |
866 | ||
c0560973 | 867 | private async stopMessageSequence(reason: StopTransactionReason = StopTransactionReason.NONE): Promise<void> { |
136c90ba | 868 | // Stop WebSocket ping |
c0560973 | 869 | this.stopWebSocketPing(); |
79411696 | 870 | // Stop heartbeat |
c0560973 | 871 | this.stopHeartbeat(); |
79411696 | 872 | // Stop the ATG |
ad2f27c3 | 873 | if (this.stationInfo.AutomaticTransactionGenerator.enable && |
265e4266 JB |
874 | this.automaticTransactionGenerator && |
875 | this.automaticTransactionGenerator.started) { | |
0045cef5 | 876 | this.automaticTransactionGenerator.stop(); |
79411696 | 877 | } else { |
734d790d JB |
878 | for (const connectorId of this.connectors.keys()) { |
879 | if (connectorId > 0 && this.getConnectorStatus(connectorId)?.transactionStarted) { | |
880 | const transactionId = this.getConnectorStatus(connectorId).transactionId; | |
6ed92bc1 JB |
881 | await this.ocppRequestService.sendStopTransaction(transactionId, this.getEnergyActiveImportRegisterByTransactionId(transactionId), |
882 | this.getTransactionIdTag(transactionId), reason); | |
79411696 JB |
883 | } |
884 | } | |
885 | } | |
886 | } | |
887 | ||
c0560973 | 888 | private startWebSocketPing(): void { |
9cd3dfb0 JB |
889 | const webSocketPingInterval: number = this.getConfigurationKey(StandardParametersKey.WebSocketPingInterval) |
890 | ? Utils.convertToInt(this.getConfigurationKey(StandardParametersKey.WebSocketPingInterval).value) | |
891 | : 0; | |
ad2f27c3 JB |
892 | if (webSocketPingInterval > 0 && !this.webSocketPingSetInterval) { |
893 | this.webSocketPingSetInterval = setInterval(() => { | |
d5bff457 | 894 | if (this.isWebSocketConnectionOpened()) { |
0dad4bda | 895 | this.wsConnection.ping((): void => { /* This is intentional */ }); |
136c90ba JB |
896 | } |
897 | }, webSocketPingInterval * 1000); | |
d7d1db72 | 898 | logger.info(this.logPrefix() + ' WebSocket ping started every ' + Utils.formatDurationSeconds(webSocketPingInterval)); |
ad2f27c3 | 899 | } else if (this.webSocketPingSetInterval) { |
d7d1db72 | 900 | logger.info(this.logPrefix() + ' WebSocket ping every ' + Utils.formatDurationSeconds(webSocketPingInterval) + ' already started'); |
136c90ba | 901 | } else { |
d7d1db72 | 902 | logger.error(`${this.logPrefix()} WebSocket ping interval set to ${webSocketPingInterval ? Utils.formatDurationSeconds(webSocketPingInterval) : webSocketPingInterval}, not starting the WebSocket ping`); |
136c90ba JB |
903 | } |
904 | } | |
905 | ||
c0560973 | 906 | private stopWebSocketPing(): void { |
ad2f27c3 JB |
907 | if (this.webSocketPingSetInterval) { |
908 | clearInterval(this.webSocketPingSetInterval); | |
136c90ba JB |
909 | } |
910 | } | |
911 | ||
57939a9d | 912 | private getSupervisionURL(): URL { |
c0560973 JB |
913 | const supervisionUrls = Utils.cloneObject<string | string[]>(this.stationInfo.supervisionURL ? this.stationInfo.supervisionURL : Configuration.getSupervisionURLs()); |
914 | let indexUrl = 0; | |
915 | if (!Utils.isEmptyArray(supervisionUrls)) { | |
916 | if (Configuration.getDistributeStationsToTenantsEqually()) { | |
917 | indexUrl = this.index % supervisionUrls.length; | |
918 | } else { | |
919 | // Get a random url | |
c37528f1 | 920 | indexUrl = Math.floor(Utils.secureRandom() * supervisionUrls.length); |
c0560973 | 921 | } |
57939a9d | 922 | return new URL(supervisionUrls[indexUrl]); |
c0560973 | 923 | } |
57939a9d | 924 | return new URL(supervisionUrls as string); |
136c90ba JB |
925 | } |
926 | ||
6e0964c8 | 927 | private getHeartbeatInterval(): number | undefined { |
c0560973 JB |
928 | const HeartbeatInterval = this.getConfigurationKey(StandardParametersKey.HeartbeatInterval); |
929 | if (HeartbeatInterval) { | |
930 | return Utils.convertToInt(HeartbeatInterval.value) * 1000; | |
931 | } | |
932 | const HeartBeatInterval = this.getConfigurationKey(StandardParametersKey.HeartBeatInterval); | |
933 | if (HeartBeatInterval) { | |
934 | return Utils.convertToInt(HeartBeatInterval.value) * 1000; | |
0a60c33c | 935 | } |
47e22477 JB |
936 | !this.stationInfo.autoRegister && logger.warn(`${this.logPrefix()} Heartbeat interval configuration key not set, using default value: ${Constants.DEFAULT_HEARTBEAT_INTERVAL}`); |
937 | return Constants.DEFAULT_HEARTBEAT_INTERVAL; | |
0a60c33c JB |
938 | } |
939 | ||
c0560973 | 940 | private stopHeartbeat(): void { |
ad2f27c3 JB |
941 | if (this.heartbeatSetInterval) { |
942 | clearInterval(this.heartbeatSetInterval); | |
7dde0b73 | 943 | } |
5ad8570f JB |
944 | } |
945 | ||
cd8dd457 | 946 | private openWSConnection(options: ClientOptions & ClientRequestArgs = this.stationInfo.wsOptions, forceCloseOpened = false): void { |
37486900 | 947 | options.handshakeTimeout = options?.handshakeTimeout ?? this.getConnectionTimeout() * 1000; |
15042c5f JB |
948 | if (!Utils.isNullOrUndefined(this.stationInfo.supervisionUser) && !Utils.isNullOrUndefined(this.stationInfo.supervisionPassword)) { |
949 | options.auth = `${this.stationInfo.supervisionUser}:${this.stationInfo.supervisionPassword}`; | |
950 | } | |
d5bff457 | 951 | if (this.isWebSocketConnectionOpened() && forceCloseOpened) { |
c0560973 JB |
952 | this.wsConnection.close(); |
953 | } | |
954 | let protocol; | |
955 | switch (this.getOCPPVersion()) { | |
956 | case OCPPVersion.VERSION_16: | |
957 | protocol = 'ocpp' + OCPPVersion.VERSION_16; | |
958 | break; | |
959 | default: | |
960 | this.handleUnsupportedVersion(this.getOCPPVersion()); | |
961 | break; | |
962 | } | |
963 | this.wsConnection = new WebSocket(this.wsConnectionUrl, protocol, options); | |
e9017bfc | 964 | logger.info(this.logPrefix() + ' Open OCPP connection to URL ' + this.wsConnectionUrl.toString()); |
136c90ba JB |
965 | } |
966 | ||
dd119a6b | 967 | private stopMeterValues(connectorId: number) { |
734d790d JB |
968 | if (this.getConnectorStatus(connectorId)?.transactionSetInterval) { |
969 | clearInterval(this.getConnectorStatus(connectorId).transactionSetInterval); | |
dd119a6b JB |
970 | } |
971 | } | |
972 | ||
c0560973 | 973 | private startAuthorizationFileMonitoring(): void { |
23132a44 JB |
974 | const authorizationFile = this.getAuthorizationFile(); |
975 | if (authorizationFile) { | |
5ad8570f | 976 | try { |
3ec10737 JB |
977 | fs.watch(authorizationFile, (event, filename) => { |
978 | if (filename && event === 'change') { | |
979 | try { | |
980 | logger.debug(this.logPrefix() + ' Authorization file ' + authorizationFile + ' have changed, reload'); | |
981 | // Initialize authorizedTags | |
982 | this.authorizedTags = this.getAuthorizedTags(); | |
983 | } catch (error) { | |
984 | logger.error(this.logPrefix() + ' Authorization file monitoring error: %j', error); | |
985 | } | |
23132a44 JB |
986 | } |
987 | }); | |
5ad8570f | 988 | } catch (error) { |
23132a44 | 989 | FileUtils.handleFileException(this.logPrefix(), 'Authorization', authorizationFile, error); |
5ad8570f | 990 | } |
23132a44 JB |
991 | } else { |
992 | logger.info(this.logPrefix() + ' No authorization file given in template file ' + this.stationTemplateFile + '. Not monitoring changes'); | |
993 | } | |
5ad8570f JB |
994 | } |
995 | ||
c0560973 | 996 | private startStationTemplateFileMonitoring(): void { |
23132a44 | 997 | try { |
b809adf1 | 998 | fs.watch(this.stationTemplateFile, (event, filename): void => { |
3ec10737 JB |
999 | if (filename && event === 'change') { |
1000 | try { | |
1001 | logger.debug(this.logPrefix() + ' Template file ' + this.stationTemplateFile + ' have changed, reload'); | |
1002 | // Initialize | |
1003 | this.initialize(); | |
1004 | // Restart the ATG | |
1005 | if (!this.stationInfo.AutomaticTransactionGenerator.enable && | |
32b02249 | 1006 | this.automaticTransactionGenerator) { |
0045cef5 | 1007 | this.automaticTransactionGenerator.stop(); |
3ec10737 JB |
1008 | } |
1009 | this.startAutomaticTransactionGenerator(); | |
1010 | if (this.getEnableStatistics()) { | |
1011 | this.performanceStatistics.restart(); | |
1012 | } else { | |
1013 | this.performanceStatistics.stop(); | |
1014 | } | |
1015 | // FIXME?: restart heartbeat and WebSocket ping when their interval values have changed | |
1016 | } catch (error) { | |
1017 | logger.error(this.logPrefix() + ' Charging station template file monitoring error: %j', error); | |
087a502d | 1018 | } |
79411696 | 1019 | } |
23132a44 JB |
1020 | }); |
1021 | } catch (error) { | |
1022 | FileUtils.handleFileException(this.logPrefix(), 'Template', this.stationTemplateFile, error); | |
1023 | } | |
5ad8570f JB |
1024 | } |
1025 | ||
6e0964c8 | 1026 | private getReconnectExponentialDelay(): boolean | undefined { |
c0560973 | 1027 | return !Utils.isUndefined(this.stationInfo.reconnectExponentialDelay) ? this.stationInfo.reconnectExponentialDelay : false; |
5ad8570f JB |
1028 | } |
1029 | ||
d09085e9 | 1030 | private async reconnect(code: number): Promise<void> { |
7874b0b1 JB |
1031 | // Stop WebSocket ping |
1032 | this.stopWebSocketPing(); | |
136c90ba | 1033 | // Stop heartbeat |
c0560973 | 1034 | this.stopHeartbeat(); |
5ad8570f | 1035 | // Stop the ATG if needed |
ad2f27c3 JB |
1036 | if (this.stationInfo.AutomaticTransactionGenerator.enable && |
1037 | this.stationInfo.AutomaticTransactionGenerator.stopOnConnectionFailure && | |
265e4266 JB |
1038 | this.automaticTransactionGenerator && |
1039 | this.automaticTransactionGenerator.started) { | |
0045cef5 | 1040 | this.automaticTransactionGenerator.stop(); |
ad2f27c3 | 1041 | } |
c0560973 | 1042 | if (this.autoReconnectRetryCount < this.getAutoReconnectMaxRetries() || this.getAutoReconnectMaxRetries() === -1) { |
ad2f27c3 | 1043 | this.autoReconnectRetryCount++; |
c0560973 | 1044 | const reconnectDelay = (this.getReconnectExponentialDelay() ? Utils.exponentialDelay(this.autoReconnectRetryCount) : this.getConnectionTimeout() * 1000); |
37486900 | 1045 | const reconnectTimeout = (reconnectDelay - 100) > 0 && reconnectDelay; |
5dc8b1b5 | 1046 | logger.error(`${this.logPrefix()} WebSocket: connection retry in ${Utils.roundTo(reconnectDelay, 2)}ms, timeout ${reconnectTimeout}ms`); |
032d6efc | 1047 | await Utils.sleep(reconnectDelay); |
5dc8b1b5 | 1048 | logger.error(this.logPrefix() + ' WebSocket: reconnecting try #' + this.autoReconnectRetryCount.toString()); |
cd8dd457 | 1049 | this.openWSConnection({ ...this.stationInfo.wsOptions, handshakeTimeout: reconnectTimeout }, true); |
265e4266 | 1050 | this.wsConnectionRestarted = true; |
c0560973 | 1051 | } else if (this.getAutoReconnectMaxRetries() !== -1) { |
5dc8b1b5 | 1052 | logger.error(`${this.logPrefix()} WebSocket reconnect failure: max retries reached (${this.autoReconnectRetryCount}) or retry disabled (${this.getAutoReconnectMaxRetries()})`); |
5ad8570f JB |
1053 | } |
1054 | } | |
1055 | ||
a2653482 JB |
1056 | private initializeConnectorStatus(connectorId: number): void { |
1057 | this.getConnectorStatus(connectorId).idTagLocalAuthorized = false; | |
1058 | this.getConnectorStatus(connectorId).idTagAuthorized = false; | |
1059 | this.getConnectorStatus(connectorId).transactionRemoteStarted = false; | |
734d790d JB |
1060 | this.getConnectorStatus(connectorId).transactionStarted = false; |
1061 | this.getConnectorStatus(connectorId).energyActiveImportRegisterValue = 0; | |
1062 | this.getConnectorStatus(connectorId).transactionEnergyActiveImportRegisterValue = 0; | |
0a60c33c | 1063 | } |
7dde0b73 JB |
1064 | } |
1065 |