Commit | Line | Data |
---|---|---|
b4d34251 JB |
1 | // Partial Copyright Jerome Benoit. 2021. All Rights Reserved. |
2 | ||
8114d10e JB |
3 | import crypto from 'crypto'; |
4 | import fs from 'fs'; | |
5 | import path from 'path'; | |
ee5f26a2 | 6 | import { URL } from 'url'; |
8114d10e JB |
7 | import { parentPort } from 'worker_threads'; |
8 | ||
89b7a234 | 9 | import WebSocket, { Data, RawData } from 'ws'; |
8114d10e JB |
10 | |
11 | import BaseError from '../exception/BaseError'; | |
12 | import OCPPError from '../exception/OCPPError'; | |
13 | import PerformanceStatistics from '../performance/PerformanceStatistics'; | |
6c1761d4 JB |
14 | import type { AutomaticTransactionGeneratorConfiguration } from '../types/AutomaticTransactionGenerator'; |
15 | import type ChargingStationConfiguration from '../types/ChargingStationConfiguration'; | |
16 | import type ChargingStationInfo from '../types/ChargingStationInfo'; | |
17 | import type ChargingStationOcppConfiguration from '../types/ChargingStationOcppConfiguration'; | |
8114d10e JB |
18 | import ChargingStationTemplate, { |
19 | CurrentType, | |
20 | PowerUnits, | |
21 | WsOptions, | |
22 | } from '../types/ChargingStationTemplate'; | |
8114d10e | 23 | import { SupervisionUrlDistribution } from '../types/ConfigurationData'; |
6c1761d4 | 24 | import type { ConnectorStatus } from '../types/ConnectorStatus'; |
8114d10e | 25 | import { FileType } from '../types/FileType'; |
6c1761d4 | 26 | import type { JsonType } from '../types/JsonType'; |
8114d10e JB |
27 | import { ChargePointErrorCode } from '../types/ocpp/ChargePointErrorCode'; |
28 | import { ChargePointStatus } from '../types/ocpp/ChargePointStatus'; | |
29 | import { ChargingProfile, ChargingRateUnitType } from '../types/ocpp/ChargingProfile'; | |
30 | import { | |
31 | ConnectorPhaseRotation, | |
32 | StandardParametersKey, | |
33 | SupportedFeatureProfiles, | |
34 | VendorDefaultParametersKey, | |
35 | } from '../types/ocpp/Configuration'; | |
36 | import { ErrorType } from '../types/ocpp/ErrorType'; | |
37 | import { MessageType } from '../types/ocpp/MessageType'; | |
38 | import { MeterValue, MeterValueMeasurand } from '../types/ocpp/MeterValues'; | |
39 | import { OCPPVersion } from '../types/ocpp/OCPPVersion'; | |
e7aeea18 JB |
40 | import { |
41 | AvailabilityType, | |
42 | BootNotificationRequest, | |
43 | CachedRequest, | |
ef6fa3fb | 44 | HeartbeatRequest, |
e7aeea18 JB |
45 | IncomingRequest, |
46 | IncomingRequestCommand, | |
ef6fa3fb | 47 | MeterValuesRequest, |
e7aeea18 | 48 | RequestCommand, |
ef6fa3fb | 49 | StatusNotificationRequest, |
e7aeea18 | 50 | } from '../types/ocpp/Requests'; |
f22266fd JB |
51 | import { |
52 | BootNotificationResponse, | |
b3ec7bc1 | 53 | ErrorResponse, |
f22266fd JB |
54 | HeartbeatResponse, |
55 | MeterValuesResponse, | |
56 | RegistrationStatus, | |
b3ec7bc1 | 57 | Response, |
f22266fd JB |
58 | StatusNotificationResponse, |
59 | } from '../types/ocpp/Responses'; | |
ef6fa3fb JB |
60 | import { |
61 | StopTransactionReason, | |
62 | StopTransactionRequest, | |
63 | StopTransactionResponse, | |
64 | } from '../types/ocpp/Transaction'; | |
16b0d4e7 | 65 | import { WSError, WebSocketCloseEventStatusCode } from '../types/WebSocket'; |
8114d10e JB |
66 | import Configuration from '../utils/Configuration'; |
67 | import Constants from '../utils/Constants'; | |
68 | import { ACElectricUtils, DCElectricUtils } from '../utils/ElectricUtils'; | |
69 | import FileUtils from '../utils/FileUtils'; | |
70 | import logger from '../utils/Logger'; | |
71 | import Utils from '../utils/Utils'; | |
9d7484a4 | 72 | import AuthorizedTagsCache from './AuthorizedTagsCache'; |
6af9012e | 73 | import AutomaticTransactionGenerator from './AutomaticTransactionGenerator'; |
17ac262c | 74 | import { ChargingStationConfigurationUtils } from './ChargingStationConfigurationUtils'; |
17ac262c | 75 | import { ChargingStationUtils } from './ChargingStationUtils'; |
89b7a234 | 76 | import ChargingStationWorkerBroadcastChannel from './ChargingStationWorkerBroadcastChannel'; |
32de5a57 | 77 | import { MessageChannelUtils } from './MessageChannelUtils'; |
e7171280 | 78 | import OCPP16IncomingRequestService from './ocpp/1.6/OCPP16IncomingRequestService'; |
c0560973 JB |
79 | import OCPP16RequestService from './ocpp/1.6/OCPP16RequestService'; |
80 | import OCPP16ResponseService from './ocpp/1.6/OCPP16ResponseService'; | |
68c993d5 | 81 | import { OCPP16ServiceUtils } from './ocpp/1.6/OCPP16ServiceUtils'; |
6c1761d4 JB |
82 | import type OCPPIncomingRequestService from './ocpp/OCPPIncomingRequestService'; |
83 | import type OCPPRequestService from './ocpp/OCPPRequestService'; | |
57adbebc | 84 | import SharedLRUCache from './SharedLRUCache'; |
3f40bc9c JB |
85 | |
86 | export default class ChargingStation { | |
2484ac1e | 87 | public readonly templateFile: string; |
6e0964c8 | 88 | public stationInfo!: ChargingStationInfo; |
452a82ca | 89 | public started: boolean; |
a5e9befc JB |
90 | public authorizedTagsCache: AuthorizedTagsCache; |
91 | public automaticTransactionGenerator!: AutomaticTransactionGenerator; | |
2484ac1e | 92 | public ocppConfiguration!: ChargingStationOcppConfiguration; |
6e0964c8 | 93 | public wsConnection!: WebSocket; |
a5e9befc | 94 | public readonly connectors: Map<number, ConnectorStatus>; |
9e23580d | 95 | public readonly requests: Map<string, CachedRequest>; |
6e0964c8 JB |
96 | public performanceStatistics!: PerformanceStatistics; |
97 | public heartbeatSetInterval!: NodeJS.Timeout; | |
6e0964c8 | 98 | public ocppRequestService!: OCPPRequestService; |
0a03f36c | 99 | public bootNotificationRequest!: BootNotificationRequest; |
ae711c83 | 100 | public bootNotificationResponse!: BootNotificationResponse | null; |
fa7bccf4 | 101 | public powerDivider!: number; |
950b1349 JB |
102 | private starting: boolean; |
103 | private stopping: boolean; | |
9e23580d | 104 | private readonly index: number; |
073bd098 | 105 | private configurationFile!: string; |
7c72977b | 106 | private configurationFileHash!: string; |
6e0964c8 | 107 | private connectorsConfigurationHash!: string; |
a472cf2b | 108 | private ocppIncomingRequestService!: OCPPIncomingRequestService; |
8e242273 | 109 | private readonly messageBuffer: Set<string>; |
fa7bccf4 | 110 | private configuredSupervisionUrl!: URL; |
265e4266 | 111 | private wsConnectionRestarted: boolean; |
ad2f27c3 | 112 | private autoReconnectRetryCount: number; |
9d7484a4 | 113 | private templateFileWatcher!: fs.FSWatcher; |
57adbebc | 114 | private readonly sharedLRUCache: SharedLRUCache; |
6e0964c8 | 115 | private webSocketPingSetInterval!: NodeJS.Timeout; |
89b7a234 | 116 | private readonly chargingStationWorkerBroadcastChannel: ChargingStationWorkerBroadcastChannel; |
6af9012e | 117 | |
2484ac1e | 118 | constructor(index: number, templateFile: string) { |
aa428a31 | 119 | this.started = false; |
950b1349 JB |
120 | this.starting = false; |
121 | this.stopping = false; | |
aa428a31 JB |
122 | this.wsConnectionRestarted = false; |
123 | this.autoReconnectRetryCount = 0; | |
ad2f27c3 | 124 | this.index = index; |
2484ac1e | 125 | this.templateFile = templateFile; |
9f2e3130 | 126 | this.connectors = new Map<number, ConnectorStatus>(); |
32b02249 | 127 | this.requests = new Map<string, CachedRequest>(); |
8e242273 | 128 | this.messageBuffer = new Set<string>(); |
b44b779a JB |
129 | this.sharedLRUCache = SharedLRUCache.getInstance(); |
130 | this.authorizedTagsCache = AuthorizedTagsCache.getInstance(); | |
89b7a234 | 131 | this.chargingStationWorkerBroadcastChannel = new ChargingStationWorkerBroadcastChannel(this); |
32de5a57 | 132 | |
9f2e3130 | 133 | this.initialize(); |
c0560973 JB |
134 | } |
135 | ||
25f5a959 | 136 | private get wsConnectionUrl(): URL { |
fa7bccf4 JB |
137 | return new URL( |
138 | (this.getSupervisionUrlOcppConfiguration() | |
139 | ? ChargingStationConfigurationUtils.getConfigurationKey( | |
17ac262c JB |
140 | this, |
141 | this.getSupervisionUrlOcppKey() | |
fa7bccf4 JB |
142 | ).value |
143 | : this.configuredSupervisionUrl.href) + | |
144 | '/' + | |
145 | this.stationInfo.chargingStationId | |
146 | ); | |
12fc74d6 JB |
147 | } |
148 | ||
c0560973 | 149 | public logPrefix(): string { |
ccb1d6e9 JB |
150 | return Utils.logPrefix( |
151 | ` ${ | |
152 | this?.stationInfo?.chargingStationId ?? | |
153 | ChargingStationUtils.getChargingStationId(this.index, this.getTemplateFromFile()) | |
154 | } |` | |
155 | ); | |
c0560973 JB |
156 | } |
157 | ||
f4bf2abd | 158 | public getRandomIdTag(): string { |
9d7484a4 JB |
159 | const authorizationFile = ChargingStationUtils.getAuthorizationFile(this.stationInfo); |
160 | const index = Math.floor( | |
161 | Utils.secureRandom() * this.authorizedTagsCache.getAuthorizedTags(authorizationFile).length | |
162 | ); | |
163 | return this.authorizedTagsCache.getAuthorizedTags(authorizationFile)[index]; | |
c0560973 JB |
164 | } |
165 | ||
166 | public hasAuthorizedTags(): boolean { | |
9d7484a4 JB |
167 | return !Utils.isEmptyArray( |
168 | this.authorizedTagsCache.getAuthorizedTags( | |
169 | ChargingStationUtils.getAuthorizationFile(this.stationInfo) | |
170 | ) | |
171 | ); | |
c0560973 JB |
172 | } |
173 | ||
6e0964c8 | 174 | public getEnableStatistics(): boolean | undefined { |
e7aeea18 JB |
175 | return !Utils.isUndefined(this.stationInfo.enableStatistics) |
176 | ? this.stationInfo.enableStatistics | |
177 | : true; | |
c0560973 JB |
178 | } |
179 | ||
03ebf4c1 JB |
180 | public getMustAuthorizeAtRemoteStart(): boolean | undefined { |
181 | return this.stationInfo.mustAuthorizeAtRemoteStart ?? true; | |
a7fc8211 JB |
182 | } |
183 | ||
e3018bc4 JB |
184 | public getPayloadSchemaValidation(): boolean | undefined { |
185 | return this.stationInfo.payloadSchemaValidation ?? true; | |
186 | } | |
187 | ||
fa7bccf4 JB |
188 | public getNumberOfPhases(stationInfo?: ChargingStationInfo): number | undefined { |
189 | const localStationInfo: ChargingStationInfo = stationInfo ?? this.stationInfo; | |
190 | switch (this.getCurrentOutType(stationInfo)) { | |
4c2b4904 | 191 | case CurrentType.AC: |
fa7bccf4 JB |
192 | return !Utils.isUndefined(localStationInfo.numberOfPhases) |
193 | ? localStationInfo.numberOfPhases | |
e7aeea18 | 194 | : 3; |
4c2b4904 | 195 | case CurrentType.DC: |
c0560973 JB |
196 | return 0; |
197 | } | |
198 | } | |
199 | ||
d5bff457 | 200 | public isWebSocketConnectionOpened(): boolean { |
0d8140bd | 201 | return this?.wsConnection?.readyState === WebSocket.OPEN; |
c0560973 JB |
202 | } |
203 | ||
672fed6e JB |
204 | public getRegistrationStatus(): RegistrationStatus { |
205 | return this?.bootNotificationResponse?.status; | |
206 | } | |
207 | ||
73c4266d JB |
208 | public isInUnknownState(): boolean { |
209 | return Utils.isNullOrUndefined(this?.bootNotificationResponse?.status); | |
210 | } | |
211 | ||
16cd35ad JB |
212 | public isInPendingState(): boolean { |
213 | return this?.bootNotificationResponse?.status === RegistrationStatus.PENDING; | |
214 | } | |
215 | ||
216 | public isInAcceptedState(): boolean { | |
e58068fd | 217 | return this?.bootNotificationResponse?.status === RegistrationStatus.ACCEPTED; |
c0560973 JB |
218 | } |
219 | ||
16cd35ad JB |
220 | public isInRejectedState(): boolean { |
221 | return this?.bootNotificationResponse?.status === RegistrationStatus.REJECTED; | |
222 | } | |
223 | ||
224 | public isRegistered(): boolean { | |
73c4266d | 225 | return !this.isInUnknownState() && (this.isInAcceptedState() || this.isInPendingState()); |
16cd35ad JB |
226 | } |
227 | ||
c0560973 | 228 | public isChargingStationAvailable(): boolean { |
734d790d | 229 | return this.getConnectorStatus(0).availability === AvailabilityType.OPERATIVE; |
c0560973 JB |
230 | } |
231 | ||
232 | public isConnectorAvailable(id: number): boolean { | |
9f2e3130 | 233 | return id > 0 && this.getConnectorStatus(id).availability === AvailabilityType.OPERATIVE; |
c0560973 JB |
234 | } |
235 | ||
54544ef1 JB |
236 | public getNumberOfConnectors(): number { |
237 | return this.connectors.get(0) ? this.connectors.size - 1 : this.connectors.size; | |
238 | } | |
239 | ||
6d9876e7 | 240 | public getConnectorStatus(id: number): ConnectorStatus | undefined { |
734d790d | 241 | return this.connectors.get(id); |
c0560973 JB |
242 | } |
243 | ||
fa7bccf4 JB |
244 | public getCurrentOutType(stationInfo?: ChargingStationInfo): CurrentType { |
245 | return (stationInfo ?? this.stationInfo).currentOutType ?? CurrentType.AC; | |
c0560973 JB |
246 | } |
247 | ||
672fed6e | 248 | public getOcppStrictCompliance(): boolean { |
ccb1d6e9 | 249 | return this.stationInfo?.ocppStrictCompliance ?? false; |
672fed6e JB |
250 | } |
251 | ||
fa7bccf4 | 252 | public getVoltageOut(stationInfo?: ChargingStationInfo): number | undefined { |
492cf6ab | 253 | const defaultVoltageOut = ChargingStationUtils.getDefaultVoltageOut( |
fa7bccf4 | 254 | this.getCurrentOutType(stationInfo), |
492cf6ab JB |
255 | this.templateFile, |
256 | this.logPrefix() | |
257 | ); | |
fa7bccf4 JB |
258 | const localStationInfo: ChargingStationInfo = stationInfo ?? this.stationInfo; |
259 | return !Utils.isUndefined(localStationInfo.voltageOut) | |
260 | ? localStationInfo.voltageOut | |
e7aeea18 | 261 | : defaultVoltageOut; |
c0560973 JB |
262 | } |
263 | ||
ad8537a7 | 264 | public getConnectorMaximumAvailablePower(connectorId: number): number { |
d20f43b5 | 265 | let connectorAmperageLimitationPowerLimit: number; |
b47d68d7 JB |
266 | if ( |
267 | !Utils.isNullOrUndefined(this.getAmperageLimitation()) && | |
268 | this.getAmperageLimitation() < this.stationInfo.maximumAmperage | |
269 | ) { | |
4160ae28 JB |
270 | connectorAmperageLimitationPowerLimit = |
271 | (this.getCurrentOutType() === CurrentType.AC | |
cc6e8ab5 JB |
272 | ? ACElectricUtils.powerTotal( |
273 | this.getNumberOfPhases(), | |
274 | this.getVoltageOut(), | |
da57964c | 275 | this.getAmperageLimitation() * this.getNumberOfConnectors() |
cc6e8ab5 | 276 | ) |
4160ae28 | 277 | : DCElectricUtils.power(this.getVoltageOut(), this.getAmperageLimitation())) / |
fa7bccf4 | 278 | this.powerDivider; |
cc6e8ab5 | 279 | } |
fa7bccf4 | 280 | const connectorMaximumPower = this.getMaximumPower() / this.powerDivider; |
7b872eaa | 281 | const connectorChargingProfilePowerLimit = this.getChargingProfilePowerLimit(connectorId); |
ad8537a7 JB |
282 | return Math.min( |
283 | isNaN(connectorMaximumPower) ? Infinity : connectorMaximumPower, | |
284 | isNaN(connectorAmperageLimitationPowerLimit) | |
285 | ? Infinity | |
286 | : connectorAmperageLimitationPowerLimit, | |
287 | isNaN(connectorChargingProfilePowerLimit) ? Infinity : connectorChargingProfilePowerLimit | |
288 | ); | |
cc6e8ab5 JB |
289 | } |
290 | ||
6e0964c8 | 291 | public getTransactionIdTag(transactionId: number): string | undefined { |
734d790d JB |
292 | for (const connectorId of this.connectors.keys()) { |
293 | if (connectorId > 0 && this.getConnectorStatus(connectorId).transactionId === transactionId) { | |
294 | return this.getConnectorStatus(connectorId).transactionIdTag; | |
c0560973 JB |
295 | } |
296 | } | |
297 | } | |
298 | ||
6ed92bc1 | 299 | public getOutOfOrderEndMeterValues(): boolean { |
ccb1d6e9 | 300 | return this.stationInfo?.outOfOrderEndMeterValues ?? false; |
6ed92bc1 JB |
301 | } |
302 | ||
303 | public getBeginEndMeterValues(): boolean { | |
ccb1d6e9 | 304 | return this.stationInfo?.beginEndMeterValues ?? false; |
6ed92bc1 JB |
305 | } |
306 | ||
307 | public getMeteringPerTransaction(): boolean { | |
ccb1d6e9 | 308 | return this.stationInfo?.meteringPerTransaction ?? true; |
6ed92bc1 JB |
309 | } |
310 | ||
fd0c36fa | 311 | public getTransactionDataMeterValues(): boolean { |
ccb1d6e9 | 312 | return this.stationInfo?.transactionDataMeterValues ?? false; |
fd0c36fa JB |
313 | } |
314 | ||
9ccca265 | 315 | public getMainVoltageMeterValues(): boolean { |
ccb1d6e9 | 316 | return this.stationInfo?.mainVoltageMeterValues ?? true; |
9ccca265 JB |
317 | } |
318 | ||
6b10669b | 319 | public getPhaseLineToLineVoltageMeterValues(): boolean { |
ccb1d6e9 | 320 | return this.stationInfo?.phaseLineToLineVoltageMeterValues ?? false; |
9bd87386 JB |
321 | } |
322 | ||
7bc31f9c | 323 | public getCustomValueLimitationMeterValues(): boolean { |
ccb1d6e9 | 324 | return this.stationInfo?.customValueLimitationMeterValues ?? true; |
7bc31f9c JB |
325 | } |
326 | ||
f479a792 | 327 | public getConnectorIdByTransactionId(transactionId: number): number | undefined { |
734d790d | 328 | for (const connectorId of this.connectors.keys()) { |
f479a792 JB |
329 | if ( |
330 | connectorId > 0 && | |
331 | this.getConnectorStatus(connectorId)?.transactionId === transactionId | |
332 | ) { | |
333 | return connectorId; | |
c0560973 JB |
334 | } |
335 | } | |
336 | } | |
337 | ||
07989fad JB |
338 | public getEnergyActiveImportRegisterByTransactionId( |
339 | transactionId: number, | |
340 | meterStop = false | |
341 | ): number { | |
342 | return this.getEnergyActiveImportRegister( | |
343 | this.getConnectorStatus(this.getConnectorIdByTransactionId(transactionId)), | |
344 | meterStop | |
cbad1217 | 345 | ); |
cbad1217 JB |
346 | } |
347 | ||
df637b0d | 348 | public getEnergyActiveImportRegisterByConnectorId(connectorId: number): number { |
07989fad | 349 | return this.getEnergyActiveImportRegister(this.getConnectorStatus(connectorId)); |
6ed92bc1 JB |
350 | } |
351 | ||
c0560973 | 352 | public getAuthorizeRemoteTxRequests(): boolean { |
17ac262c JB |
353 | const authorizeRemoteTxRequests = ChargingStationConfigurationUtils.getConfigurationKey( |
354 | this, | |
e7aeea18 JB |
355 | StandardParametersKey.AuthorizeRemoteTxRequests |
356 | ); | |
357 | return authorizeRemoteTxRequests | |
358 | ? Utils.convertToBoolean(authorizeRemoteTxRequests.value) | |
359 | : false; | |
c0560973 JB |
360 | } |
361 | ||
362 | public getLocalAuthListEnabled(): boolean { | |
17ac262c JB |
363 | const localAuthListEnabled = ChargingStationConfigurationUtils.getConfigurationKey( |
364 | this, | |
e7aeea18 JB |
365 | StandardParametersKey.LocalAuthListEnabled |
366 | ); | |
c0560973 JB |
367 | return localAuthListEnabled ? Utils.convertToBoolean(localAuthListEnabled.value) : false; |
368 | } | |
369 | ||
c0560973 | 370 | public startHeartbeat(): void { |
e7aeea18 JB |
371 | if ( |
372 | this.getHeartbeatInterval() && | |
373 | this.getHeartbeatInterval() > 0 && | |
374 | !this.heartbeatSetInterval | |
375 | ) { | |
71623267 JB |
376 | // eslint-disable-next-line @typescript-eslint/no-misused-promises |
377 | this.heartbeatSetInterval = setInterval(async (): Promise<void> => { | |
f7f98c68 | 378 | await this.ocppRequestService.requestHandler<HeartbeatRequest, HeartbeatResponse>( |
08f130a0 | 379 | this, |
f22266fd JB |
380 | RequestCommand.HEARTBEAT |
381 | ); | |
c0560973 | 382 | }, this.getHeartbeatInterval()); |
e7aeea18 JB |
383 | logger.info( |
384 | this.logPrefix() + | |
385 | ' Heartbeat started every ' + | |
386 | Utils.formatDurationMilliSeconds(this.getHeartbeatInterval()) | |
387 | ); | |
c0560973 | 388 | } else if (this.heartbeatSetInterval) { |
e7aeea18 JB |
389 | logger.info( |
390 | this.logPrefix() + | |
391 | ' Heartbeat already started every ' + | |
392 | Utils.formatDurationMilliSeconds(this.getHeartbeatInterval()) | |
393 | ); | |
c0560973 | 394 | } else { |
e7aeea18 JB |
395 | logger.error( |
396 | `${this.logPrefix()} Heartbeat interval set to ${ | |
397 | this.getHeartbeatInterval() | |
398 | ? Utils.formatDurationMilliSeconds(this.getHeartbeatInterval()) | |
399 | : this.getHeartbeatInterval() | |
400 | }, not starting the heartbeat` | |
401 | ); | |
c0560973 JB |
402 | } |
403 | } | |
404 | ||
405 | public restartHeartbeat(): void { | |
406 | // Stop heartbeat | |
407 | this.stopHeartbeat(); | |
408 | // Start heartbeat | |
409 | this.startHeartbeat(); | |
410 | } | |
411 | ||
17ac262c JB |
412 | public restartWebSocketPing(): void { |
413 | // Stop WebSocket ping | |
414 | this.stopWebSocketPing(); | |
415 | // Start WebSocket ping | |
416 | this.startWebSocketPing(); | |
417 | } | |
418 | ||
c0560973 JB |
419 | public startMeterValues(connectorId: number, interval: number): void { |
420 | if (connectorId === 0) { | |
e7aeea18 JB |
421 | logger.error( |
422 | `${this.logPrefix()} Trying to start MeterValues on connector Id ${connectorId.toString()}` | |
423 | ); | |
c0560973 JB |
424 | return; |
425 | } | |
734d790d | 426 | if (!this.getConnectorStatus(connectorId)) { |
e7aeea18 JB |
427 | logger.error( |
428 | `${this.logPrefix()} Trying to start MeterValues on non existing connector Id ${connectorId.toString()}` | |
429 | ); | |
c0560973 JB |
430 | return; |
431 | } | |
5e3cb728 | 432 | if (this.getConnectorStatus(connectorId)?.transactionStarted === false) { |
e7aeea18 JB |
433 | logger.error( |
434 | `${this.logPrefix()} Trying to start MeterValues on connector Id ${connectorId} with no transaction started` | |
435 | ); | |
c0560973 | 436 | return; |
e7aeea18 | 437 | } else if ( |
5e3cb728 | 438 | this.getConnectorStatus(connectorId)?.transactionStarted === true && |
e7aeea18 JB |
439 | !this.getConnectorStatus(connectorId)?.transactionId |
440 | ) { | |
441 | logger.error( | |
442 | `${this.logPrefix()} Trying to start MeterValues on connector Id ${connectorId} with no transaction id` | |
443 | ); | |
c0560973 JB |
444 | return; |
445 | } | |
446 | if (interval > 0) { | |
71623267 | 447 | // eslint-disable-next-line @typescript-eslint/no-misused-promises |
e7aeea18 | 448 | this.getConnectorStatus(connectorId).transactionSetInterval = setInterval( |
9534e74e | 449 | // eslint-disable-next-line @typescript-eslint/no-misused-promises |
e7aeea18 | 450 | async (): Promise<void> => { |
0f3d5941 JB |
451 | // FIXME: Implement OCPP version agnostic helpers |
452 | const meterValue: MeterValue = OCPP16ServiceUtils.buildMeterValue( | |
453 | this, | |
e7aeea18 JB |
454 | connectorId, |
455 | this.getConnectorStatus(connectorId).transactionId, | |
456 | interval | |
457 | ); | |
f7f98c68 | 458 | await this.ocppRequestService.requestHandler<MeterValuesRequest, MeterValuesResponse>( |
08f130a0 | 459 | this, |
f22266fd JB |
460 | RequestCommand.METER_VALUES, |
461 | { | |
462 | connectorId, | |
463 | transactionId: this.getConnectorStatus(connectorId).transactionId, | |
464 | meterValue: [meterValue], | |
465 | } | |
466 | ); | |
e7aeea18 JB |
467 | }, |
468 | interval | |
469 | ); | |
c0560973 | 470 | } else { |
e7aeea18 JB |
471 | logger.error( |
472 | `${this.logPrefix()} Charging station ${ | |
473 | StandardParametersKey.MeterValueSampleInterval | |
474 | } configuration set to ${ | |
475 | interval ? Utils.formatDurationMilliSeconds(interval) : interval | |
476 | }, not sending MeterValues` | |
477 | ); | |
c0560973 JB |
478 | } |
479 | } | |
480 | ||
481 | public start(): void { | |
0d8852a5 JB |
482 | if (this.started === false) { |
483 | if (this.starting === false) { | |
484 | this.starting = true; | |
485 | if (this.getEnableStatistics()) { | |
486 | this.performanceStatistics.start(); | |
487 | } | |
488 | this.openWSConnection(); | |
489 | // Monitor charging station template file | |
490 | this.templateFileWatcher = FileUtils.watchJsonFile( | |
491 | this.logPrefix(), | |
492 | FileType.ChargingStationTemplate, | |
493 | this.templateFile, | |
494 | null, | |
495 | (event, filename): void => { | |
496 | if (filename && event === 'change') { | |
497 | try { | |
498 | logger.debug( | |
499 | `${this.logPrefix()} ${FileType.ChargingStationTemplate} ${ | |
500 | this.templateFile | |
501 | } file have changed, reload` | |
502 | ); | |
503 | this.sharedLRUCache.deleteChargingStationTemplate(this.stationInfo?.templateHash); | |
504 | // Initialize | |
505 | this.initialize(); | |
506 | // Restart the ATG | |
507 | this.stopAutomaticTransactionGenerator(); | |
508 | if ( | |
509 | this.getAutomaticTransactionGeneratorConfigurationFromTemplate()?.enable === true | |
510 | ) { | |
511 | this.startAutomaticTransactionGenerator(); | |
512 | } | |
513 | if (this.getEnableStatistics()) { | |
514 | this.performanceStatistics.restart(); | |
515 | } else { | |
516 | this.performanceStatistics.stop(); | |
517 | } | |
518 | // FIXME?: restart heartbeat and WebSocket ping when their interval values have changed | |
519 | } catch (error) { | |
520 | logger.error( | |
521 | `${this.logPrefix()} ${FileType.ChargingStationTemplate} file monitoring error:`, | |
522 | error | |
523 | ); | |
950b1349 | 524 | } |
a95873d8 | 525 | } |
a95873d8 | 526 | } |
0d8852a5 JB |
527 | ); |
528 | parentPort.postMessage(MessageChannelUtils.buildStartedMessage(this)); | |
529 | this.starting = false; | |
530 | } else { | |
531 | logger.warn(`${this.logPrefix()} Charging station is already starting...`); | |
532 | } | |
950b1349 | 533 | } else { |
0d8852a5 | 534 | logger.warn(`${this.logPrefix()} Charging station is already started...`); |
950b1349 | 535 | } |
c0560973 JB |
536 | } |
537 | ||
60ddad53 | 538 | public async stop(reason?: StopTransactionReason): Promise<void> { |
0d8852a5 JB |
539 | if (this.started === true) { |
540 | if (this.stopping === false) { | |
541 | this.stopping = true; | |
542 | await this.stopMessageSequence(reason); | |
543 | for (const connectorId of this.connectors.keys()) { | |
544 | if (connectorId > 0) { | |
545 | await this.ocppRequestService.requestHandler< | |
546 | StatusNotificationRequest, | |
547 | StatusNotificationResponse | |
548 | >(this, RequestCommand.STATUS_NOTIFICATION, { | |
549 | connectorId, | |
550 | status: ChargePointStatus.UNAVAILABLE, | |
551 | errorCode: ChargePointErrorCode.NO_ERROR, | |
552 | }); | |
553 | this.getConnectorStatus(connectorId).status = ChargePointStatus.UNAVAILABLE; | |
554 | } | |
950b1349 | 555 | } |
0d8852a5 JB |
556 | this.closeWSConnection(); |
557 | if (this.getEnableStatistics()) { | |
558 | this.performanceStatistics.stop(); | |
559 | } | |
560 | this.sharedLRUCache.deleteChargingStationConfiguration(this.configurationFileHash); | |
561 | this.templateFileWatcher.close(); | |
562 | this.sharedLRUCache.deleteChargingStationTemplate(this.stationInfo?.templateHash); | |
563 | this.bootNotificationResponse = null; | |
564 | this.started = false; | |
565 | parentPort.postMessage(MessageChannelUtils.buildStoppedMessage(this)); | |
566 | this.stopping = false; | |
567 | } else { | |
568 | logger.warn(`${this.logPrefix()} Charging station is already stopping...`); | |
c0560973 | 569 | } |
950b1349 | 570 | } else { |
0d8852a5 | 571 | logger.warn(`${this.logPrefix()} Charging station is already stopped...`); |
c0560973 | 572 | } |
c0560973 JB |
573 | } |
574 | ||
60ddad53 JB |
575 | public async reset(reason?: StopTransactionReason): Promise<void> { |
576 | await this.stop(reason); | |
94ec7e96 | 577 | await Utils.sleep(this.stationInfo.resetTime); |
fa7bccf4 | 578 | this.initialize(); |
94ec7e96 JB |
579 | this.start(); |
580 | } | |
581 | ||
17ac262c JB |
582 | public saveOcppConfiguration(): void { |
583 | if (this.getOcppPersistentConfiguration()) { | |
7c72977b | 584 | this.saveConfiguration(); |
e6895390 JB |
585 | } |
586 | } | |
587 | ||
a7fc8211 | 588 | public setChargingProfile(connectorId: number, cp: ChargingProfile): void { |
0bb3ee61 JB |
589 | if (Utils.isNullOrUndefined(this.getConnectorStatus(connectorId).chargingProfiles)) { |
590 | logger.error( | |
591 | `${this.logPrefix()} Trying to set a charging profile on connectorId ${connectorId} with an uninitialized charging profiles array attribute, applying deferred initialization` | |
592 | ); | |
593 | this.getConnectorStatus(connectorId).chargingProfiles = []; | |
594 | } | |
53e5fd67 | 595 | if (Array.isArray(this.getConnectorStatus(connectorId).chargingProfiles) === false) { |
0bb3ee61 JB |
596 | logger.error( |
597 | `${this.logPrefix()} Trying to set a charging profile on connectorId ${connectorId} with an improper attribute type for the charging profiles array, applying proper type initialization` | |
598 | ); | |
1e5bbb96 O |
599 | this.getConnectorStatus(connectorId).chargingProfiles = []; |
600 | } | |
a7fc8211 | 601 | let cpReplaced = false; |
734d790d | 602 | if (!Utils.isEmptyArray(this.getConnectorStatus(connectorId).chargingProfiles)) { |
e7aeea18 JB |
603 | this.getConnectorStatus(connectorId).chargingProfiles?.forEach( |
604 | (chargingProfile: ChargingProfile, index: number) => { | |
605 | if ( | |
606 | chargingProfile.chargingProfileId === cp.chargingProfileId || | |
607 | (chargingProfile.stackLevel === cp.stackLevel && | |
608 | chargingProfile.chargingProfilePurpose === cp.chargingProfilePurpose) | |
609 | ) { | |
610 | this.getConnectorStatus(connectorId).chargingProfiles[index] = cp; | |
611 | cpReplaced = true; | |
612 | } | |
c0560973 | 613 | } |
e7aeea18 | 614 | ); |
c0560973 | 615 | } |
734d790d | 616 | !cpReplaced && this.getConnectorStatus(connectorId).chargingProfiles?.push(cp); |
c0560973 JB |
617 | } |
618 | ||
a2653482 JB |
619 | public resetConnectorStatus(connectorId: number): void { |
620 | this.getConnectorStatus(connectorId).idTagLocalAuthorized = false; | |
621 | this.getConnectorStatus(connectorId).idTagAuthorized = false; | |
622 | this.getConnectorStatus(connectorId).transactionRemoteStarted = false; | |
734d790d | 623 | this.getConnectorStatus(connectorId).transactionStarted = false; |
a2653482 | 624 | delete this.getConnectorStatus(connectorId).localAuthorizeIdTag; |
734d790d JB |
625 | delete this.getConnectorStatus(connectorId).authorizeIdTag; |
626 | delete this.getConnectorStatus(connectorId).transactionId; | |
627 | delete this.getConnectorStatus(connectorId).transactionIdTag; | |
628 | this.getConnectorStatus(connectorId).transactionEnergyActiveImportRegisterValue = 0; | |
629 | delete this.getConnectorStatus(connectorId).transactionBeginMeterValue; | |
dd119a6b | 630 | this.stopMeterValues(connectorId); |
4f317101 | 631 | parentPort.postMessage(MessageChannelUtils.buildUpdatedMessage(this)); |
2e6f5966 JB |
632 | } |
633 | ||
68cb8b91 | 634 | public hasFeatureProfile(featureProfile: SupportedFeatureProfiles) { |
17ac262c JB |
635 | return ChargingStationConfigurationUtils.getConfigurationKey( |
636 | this, | |
637 | StandardParametersKey.SupportedFeatureProfiles | |
638 | )?.value.includes(featureProfile); | |
68cb8b91 JB |
639 | } |
640 | ||
8e242273 JB |
641 | public bufferMessage(message: string): void { |
642 | this.messageBuffer.add(message); | |
3ba2381e JB |
643 | } |
644 | ||
db2336d9 JB |
645 | public openWSConnection( |
646 | options: WsOptions = this.stationInfo?.wsOptions ?? {}, | |
647 | params: { closeOpened?: boolean; terminateOpened?: boolean } = { | |
648 | closeOpened: false, | |
649 | terminateOpened: false, | |
650 | } | |
651 | ): void { | |
652 | options.handshakeTimeout = options?.handshakeTimeout ?? this.getConnectionTimeout() * 1000; | |
653 | params.closeOpened = params?.closeOpened ?? false; | |
654 | params.terminateOpened = params?.terminateOpened ?? false; | |
655 | if ( | |
656 | !Utils.isNullOrUndefined(this.stationInfo.supervisionUser) && | |
657 | !Utils.isNullOrUndefined(this.stationInfo.supervisionPassword) | |
658 | ) { | |
659 | options.auth = `${this.stationInfo.supervisionUser}:${this.stationInfo.supervisionPassword}`; | |
660 | } | |
661 | if (params?.closeOpened) { | |
662 | this.closeWSConnection(); | |
663 | } | |
664 | if (params?.terminateOpened) { | |
665 | this.terminateWSConnection(); | |
666 | } | |
667 | let protocol: string; | |
668 | switch (this.getOcppVersion()) { | |
669 | case OCPPVersion.VERSION_16: | |
670 | protocol = 'ocpp' + OCPPVersion.VERSION_16; | |
671 | break; | |
672 | default: | |
673 | this.handleUnsupportedVersion(this.getOcppVersion()); | |
674 | break; | |
675 | } | |
676 | ||
0a03f36c JB |
677 | if (this.isWebSocketConnectionOpened()) { |
678 | logger.warn( | |
679 | `${this.logPrefix()} OCPP connection to URL ${this.wsConnectionUrl.toString()} is already opened` | |
680 | ); | |
681 | return; | |
682 | } | |
683 | ||
db2336d9 | 684 | logger.info( |
0a03f36c | 685 | `${this.logPrefix()} Open OCPP connection to URL ${this.wsConnectionUrl.toString()}` |
db2336d9 JB |
686 | ); |
687 | ||
688 | this.wsConnection = new WebSocket(this.wsConnectionUrl, protocol, options); | |
689 | ||
690 | // Handle WebSocket message | |
691 | this.wsConnection.on( | |
692 | 'message', | |
693 | this.onMessage.bind(this) as (this: WebSocket, data: RawData, isBinary: boolean) => void | |
694 | ); | |
695 | // Handle WebSocket error | |
696 | this.wsConnection.on( | |
697 | 'error', | |
698 | this.onError.bind(this) as (this: WebSocket, error: Error) => void | |
699 | ); | |
700 | // Handle WebSocket close | |
701 | this.wsConnection.on( | |
702 | 'close', | |
703 | this.onClose.bind(this) as (this: WebSocket, code: number, reason: Buffer) => void | |
704 | ); | |
705 | // Handle WebSocket open | |
706 | this.wsConnection.on('open', this.onOpen.bind(this) as (this: WebSocket) => void); | |
707 | // Handle WebSocket ping | |
708 | this.wsConnection.on('ping', this.onPing.bind(this) as (this: WebSocket, data: Buffer) => void); | |
709 | // Handle WebSocket pong | |
710 | this.wsConnection.on('pong', this.onPong.bind(this) as (this: WebSocket, data: Buffer) => void); | |
711 | } | |
712 | ||
713 | public closeWSConnection(): void { | |
714 | if (this.isWebSocketConnectionOpened()) { | |
715 | this.wsConnection.close(); | |
716 | this.wsConnection = null; | |
717 | } | |
718 | } | |
719 | ||
a5e9befc | 720 | public startAutomaticTransactionGenerator(connectorIds?: number[]): void { |
4f69be04 JB |
721 | if (!this.automaticTransactionGenerator) { |
722 | this.automaticTransactionGenerator = AutomaticTransactionGenerator.getInstance( | |
723 | this.getAutomaticTransactionGeneratorConfigurationFromTemplate(), | |
724 | this | |
725 | ); | |
726 | } | |
a5e9befc JB |
727 | if (!Utils.isEmptyArray(connectorIds)) { |
728 | for (const connectorId of connectorIds) { | |
729 | this.automaticTransactionGenerator.startConnector(connectorId); | |
730 | } | |
731 | } else { | |
4f69be04 JB |
732 | this.automaticTransactionGenerator.start(); |
733 | } | |
734 | } | |
735 | ||
a5e9befc JB |
736 | public stopAutomaticTransactionGenerator(connectorIds?: number[]): void { |
737 | if (!Utils.isEmptyArray(connectorIds)) { | |
738 | for (const connectorId of connectorIds) { | |
739 | this.automaticTransactionGenerator?.stopConnector(connectorId); | |
4dff3039 | 740 | // FIXME: check if the number of connectors match the CS number of connectors |
a5e9befc JB |
741 | } |
742 | } else { | |
743 | this.automaticTransactionGenerator?.stop(); | |
4f69be04 JB |
744 | this.automaticTransactionGenerator = null; |
745 | } | |
746 | } | |
747 | ||
5e3cb728 JB |
748 | public async stopTransactionOnConnector( |
749 | connectorId: number, | |
750 | reason = StopTransactionReason.NONE | |
751 | ): Promise<StopTransactionResponse> { | |
752 | const transactionId = this.getConnectorStatus(connectorId).transactionId; | |
753 | if ( | |
754 | this.getBeginEndMeterValues() && | |
755 | this.getOcppStrictCompliance() && | |
756 | !this.getOutOfOrderEndMeterValues() | |
757 | ) { | |
758 | // FIXME: Implement OCPP version agnostic helpers | |
759 | const transactionEndMeterValue = OCPP16ServiceUtils.buildTransactionEndMeterValue( | |
760 | this, | |
761 | connectorId, | |
762 | this.getEnergyActiveImportRegisterByTransactionId(transactionId) | |
763 | ); | |
764 | await this.ocppRequestService.requestHandler<MeterValuesRequest, MeterValuesResponse>( | |
765 | this, | |
766 | RequestCommand.METER_VALUES, | |
767 | { | |
768 | connectorId, | |
769 | transactionId, | |
770 | meterValue: [transactionEndMeterValue], | |
771 | } | |
772 | ); | |
773 | } | |
774 | return this.ocppRequestService.requestHandler<StopTransactionRequest, StopTransactionResponse>( | |
775 | this, | |
776 | RequestCommand.STOP_TRANSACTION, | |
777 | { | |
778 | transactionId, | |
779 | meterStop: this.getEnergyActiveImportRegisterByTransactionId(transactionId, true), | |
5e3cb728 JB |
780 | reason, |
781 | } | |
782 | ); | |
783 | } | |
784 | ||
f90c1757 | 785 | private flushMessageBuffer(): void { |
8e242273 JB |
786 | if (this.messageBuffer.size > 0) { |
787 | this.messageBuffer.forEach((message) => { | |
aef1b33a | 788 | // TODO: evaluate the need to track performance |
77f00f84 | 789 | this.wsConnection.send(message); |
8e242273 | 790 | this.messageBuffer.delete(message); |
77f00f84 JB |
791 | }); |
792 | } | |
793 | } | |
794 | ||
1f5df42a JB |
795 | private getSupervisionUrlOcppConfiguration(): boolean { |
796 | return this.stationInfo.supervisionUrlOcppConfiguration ?? false; | |
12fc74d6 JB |
797 | } |
798 | ||
e8e865ea JB |
799 | private getSupervisionUrlOcppKey(): string { |
800 | return this.stationInfo.supervisionUrlOcppKey ?? VendorDefaultParametersKey.ConnectionUrl; | |
801 | } | |
802 | ||
9214b603 | 803 | private getTemplateFromFile(): ChargingStationTemplate | null { |
2484ac1e | 804 | let template: ChargingStationTemplate = null; |
5ad8570f | 805 | try { |
57adbebc JB |
806 | if (this.sharedLRUCache.hasChargingStationTemplate(this.stationInfo?.templateHash)) { |
807 | template = this.sharedLRUCache.getChargingStationTemplate(this.stationInfo.templateHash); | |
7c72977b JB |
808 | } else { |
809 | const measureId = `${FileType.ChargingStationTemplate} read`; | |
810 | const beginId = PerformanceStatistics.beginMeasure(measureId); | |
811 | template = JSON.parse( | |
812 | fs.readFileSync(this.templateFile, 'utf8') | |
813 | ) as ChargingStationTemplate; | |
814 | PerformanceStatistics.endMeasure(measureId, beginId); | |
815 | template.templateHash = crypto | |
816 | .createHash(Constants.DEFAULT_HASH_ALGORITHM) | |
817 | .update(JSON.stringify(template)) | |
818 | .digest('hex'); | |
57adbebc | 819 | this.sharedLRUCache.setChargingStationTemplate(template); |
7c72977b | 820 | } |
5ad8570f | 821 | } catch (error) { |
e7aeea18 JB |
822 | FileUtils.handleFileException( |
823 | this.logPrefix(), | |
a95873d8 | 824 | FileType.ChargingStationTemplate, |
2484ac1e | 825 | this.templateFile, |
e7aeea18 JB |
826 | error as NodeJS.ErrnoException |
827 | ); | |
5ad8570f | 828 | } |
2484ac1e JB |
829 | return template; |
830 | } | |
831 | ||
7a3a2ebb | 832 | private getStationInfoFromTemplate(): ChargingStationInfo { |
fa7bccf4 JB |
833 | const stationTemplate: ChargingStationTemplate = this.getTemplateFromFile(); |
834 | if (Utils.isNullOrUndefined(stationTemplate)) { | |
ccb1d6e9 JB |
835 | const errorMsg = 'Failed to read charging station template file'; |
836 | logger.error(`${this.logPrefix()} ${errorMsg}`); | |
837 | throw new BaseError(errorMsg); | |
94ec7e96 | 838 | } |
fa7bccf4 | 839 | if (Utils.isEmptyObject(stationTemplate)) { |
ccb1d6e9 JB |
840 | const errorMsg = `Empty charging station information from template file ${this.templateFile}`; |
841 | logger.error(`${this.logPrefix()} ${errorMsg}`); | |
842 | throw new BaseError(errorMsg); | |
94ec7e96 | 843 | } |
2dcfe98e | 844 | // Deprecation template keys section |
17ac262c | 845 | ChargingStationUtils.warnDeprecatedTemplateKey( |
fa7bccf4 | 846 | stationTemplate, |
e7aeea18 | 847 | 'supervisionUrl', |
17ac262c | 848 | this.templateFile, |
ccb1d6e9 | 849 | this.logPrefix(), |
e7aeea18 JB |
850 | "Use 'supervisionUrls' instead" |
851 | ); | |
17ac262c | 852 | ChargingStationUtils.convertDeprecatedTemplateKey( |
fa7bccf4 | 853 | stationTemplate, |
17ac262c JB |
854 | 'supervisionUrl', |
855 | 'supervisionUrls' | |
856 | ); | |
fa7bccf4 JB |
857 | const stationInfo: ChargingStationInfo = |
858 | ChargingStationUtils.stationTemplateToStationInfo(stationTemplate); | |
51c83d6f | 859 | stationInfo.hashId = ChargingStationUtils.getHashId(this.index, stationTemplate); |
fa7bccf4 JB |
860 | stationInfo.chargingStationId = ChargingStationUtils.getChargingStationId( |
861 | this.index, | |
862 | stationTemplate | |
863 | ); | |
864 | ChargingStationUtils.createSerialNumber(stationTemplate, stationInfo); | |
865 | if (!Utils.isEmptyArray(stationTemplate.power)) { | |
866 | stationTemplate.power = stationTemplate.power as number[]; | |
867 | const powerArrayRandomIndex = Math.floor(Utils.secureRandom() * stationTemplate.power.length); | |
cc6e8ab5 | 868 | stationInfo.maximumPower = |
fa7bccf4 JB |
869 | stationTemplate.powerUnit === PowerUnits.KILO_WATT |
870 | ? stationTemplate.power[powerArrayRandomIndex] * 1000 | |
871 | : stationTemplate.power[powerArrayRandomIndex]; | |
5ad8570f | 872 | } else { |
fa7bccf4 | 873 | stationTemplate.power = stationTemplate.power as number; |
cc6e8ab5 | 874 | stationInfo.maximumPower = |
fa7bccf4 JB |
875 | stationTemplate.powerUnit === PowerUnits.KILO_WATT |
876 | ? stationTemplate.power * 1000 | |
877 | : stationTemplate.power; | |
878 | } | |
879 | stationInfo.resetTime = stationTemplate.resetTime | |
880 | ? stationTemplate.resetTime * 1000 | |
e7aeea18 | 881 | : Constants.CHARGING_STATION_DEFAULT_RESET_TIME; |
fa7bccf4 JB |
882 | const configuredMaxConnectors = ChargingStationUtils.getConfiguredNumberOfConnectors( |
883 | this.index, | |
884 | stationTemplate | |
885 | ); | |
886 | ChargingStationUtils.checkConfiguredMaxConnectors( | |
887 | configuredMaxConnectors, | |
888 | this.templateFile, | |
fc040c43 | 889 | this.logPrefix() |
fa7bccf4 JB |
890 | ); |
891 | const templateMaxConnectors = | |
892 | ChargingStationUtils.getTemplateMaxNumberOfConnectors(stationTemplate); | |
893 | ChargingStationUtils.checkTemplateMaxConnectors( | |
894 | templateMaxConnectors, | |
895 | this.templateFile, | |
fc040c43 | 896 | this.logPrefix() |
fa7bccf4 JB |
897 | ); |
898 | if ( | |
899 | configuredMaxConnectors > | |
900 | (stationTemplate?.Connectors[0] ? templateMaxConnectors - 1 : templateMaxConnectors) && | |
901 | !stationTemplate?.randomConnectors | |
902 | ) { | |
903 | logger.warn( | |
904 | `${this.logPrefix()} Number of connectors exceeds the number of connector configurations in template ${ | |
905 | this.templateFile | |
906 | }, forcing random connector configurations affectation` | |
907 | ); | |
908 | stationInfo.randomConnectors = true; | |
909 | } | |
910 | // Build connectors if needed (FIXME: should be factored out) | |
911 | this.initializeConnectors(stationInfo, configuredMaxConnectors, templateMaxConnectors); | |
912 | stationInfo.maximumAmperage = this.getMaximumAmperage(stationInfo); | |
913 | ChargingStationUtils.createStationInfoHash(stationInfo); | |
9ac86a7e | 914 | return stationInfo; |
5ad8570f JB |
915 | } |
916 | ||
ccb1d6e9 JB |
917 | private getStationInfoFromFile(): ChargingStationInfo | null { |
918 | let stationInfo: ChargingStationInfo = null; | |
fa7bccf4 JB |
919 | this.getStationInfoPersistentConfiguration() && |
920 | (stationInfo = this.getConfigurationFromFile()?.stationInfo ?? null); | |
921 | stationInfo && ChargingStationUtils.createStationInfoHash(stationInfo); | |
f765beaa | 922 | return stationInfo; |
2484ac1e JB |
923 | } |
924 | ||
925 | private getStationInfo(): ChargingStationInfo { | |
926 | const stationInfoFromTemplate: ChargingStationInfo = this.getStationInfoFromTemplate(); | |
2484ac1e | 927 | const stationInfoFromFile: ChargingStationInfo = this.getStationInfoFromFile(); |
aca53a1a | 928 | // Priority: charging station info from template > charging station info from configuration file > charging station info attribute |
f765beaa | 929 | if (stationInfoFromFile?.templateHash === stationInfoFromTemplate.templateHash) { |
01efc60a JB |
930 | if (this.stationInfo?.infoHash === stationInfoFromFile?.infoHash) { |
931 | return this.stationInfo; | |
932 | } | |
2484ac1e | 933 | return stationInfoFromFile; |
f765beaa | 934 | } |
fec4d204 JB |
935 | stationInfoFromFile && |
936 | ChargingStationUtils.propagateSerialNumber( | |
937 | this.getTemplateFromFile(), | |
938 | stationInfoFromFile, | |
939 | stationInfoFromTemplate | |
940 | ); | |
01efc60a | 941 | return stationInfoFromTemplate; |
2484ac1e JB |
942 | } |
943 | ||
944 | private saveStationInfo(): void { | |
ccb1d6e9 | 945 | if (this.getStationInfoPersistentConfiguration()) { |
7c72977b | 946 | this.saveConfiguration(); |
ccb1d6e9 | 947 | } |
2484ac1e JB |
948 | } |
949 | ||
1f5df42a | 950 | private getOcppVersion(): OCPPVersion { |
aba95196 | 951 | return this.stationInfo.ocppVersion ?? OCPPVersion.VERSION_16; |
c0560973 JB |
952 | } |
953 | ||
e8e865ea | 954 | private getOcppPersistentConfiguration(): boolean { |
ccb1d6e9 JB |
955 | return this.stationInfo?.ocppPersistentConfiguration ?? true; |
956 | } | |
957 | ||
958 | private getStationInfoPersistentConfiguration(): boolean { | |
959 | return this.stationInfo?.stationInfoPersistentConfiguration ?? true; | |
e8e865ea JB |
960 | } |
961 | ||
c0560973 | 962 | private handleUnsupportedVersion(version: OCPPVersion) { |
fc040c43 JB |
963 | const errMsg = `Unsupported protocol version '${version}' configured in template file ${this.templateFile}`; |
964 | logger.error(`${this.logPrefix()} ${errMsg}`); | |
6c8f5d90 | 965 | throw new BaseError(errMsg); |
c0560973 JB |
966 | } |
967 | ||
2484ac1e | 968 | private initialize(): void { |
fa7bccf4 | 969 | this.configurationFile = path.join( |
ee5f26a2 | 970 | path.dirname(this.templateFile.replace('station-templates', 'configurations')), |
b44b779a | 971 | ChargingStationUtils.getHashId(this.index, this.getTemplateFromFile()) + '.json' |
0642c3d2 | 972 | ); |
b44b779a JB |
973 | this.stationInfo = this.getStationInfo(); |
974 | this.saveStationInfo(); | |
975 | logger.info(`${this.logPrefix()} Charging station hashId '${this.stationInfo.hashId}'`); | |
7a3a2ebb | 976 | // Avoid duplication of connectors related information in RAM |
94ec7e96 | 977 | this.stationInfo?.Connectors && delete this.stationInfo.Connectors; |
fa7bccf4 | 978 | this.configuredSupervisionUrl = this.getConfiguredSupervisionUrl(); |
0642c3d2 JB |
979 | if (this.getEnableStatistics()) { |
980 | this.performanceStatistics = PerformanceStatistics.getInstance( | |
51c83d6f | 981 | this.stationInfo.hashId, |
0642c3d2 | 982 | this.stationInfo.chargingStationId, |
fa7bccf4 | 983 | this.configuredSupervisionUrl |
0642c3d2 JB |
984 | ); |
985 | } | |
fa7bccf4 JB |
986 | this.bootNotificationRequest = ChargingStationUtils.createBootNotificationRequest( |
987 | this.stationInfo | |
988 | ); | |
fa7bccf4 JB |
989 | this.powerDivider = this.getPowerDivider(); |
990 | // OCPP configuration | |
991 | this.ocppConfiguration = this.getOcppConfiguration(); | |
992 | this.initializeOcppConfiguration(); | |
1f5df42a | 993 | switch (this.getOcppVersion()) { |
c0560973 | 994 | case OCPPVersion.VERSION_16: |
e7aeea18 | 995 | this.ocppIncomingRequestService = |
08f130a0 | 996 | OCPP16IncomingRequestService.getInstance<OCPP16IncomingRequestService>(); |
e7aeea18 | 997 | this.ocppRequestService = OCPP16RequestService.getInstance<OCPP16RequestService>( |
08f130a0 | 998 | OCPP16ResponseService.getInstance<OCPP16ResponseService>() |
e7aeea18 | 999 | ); |
c0560973 JB |
1000 | break; |
1001 | default: | |
1f5df42a | 1002 | this.handleUnsupportedVersion(this.getOcppVersion()); |
c0560973 JB |
1003 | break; |
1004 | } | |
7c72977b | 1005 | if (this.stationInfo?.autoRegister) { |
47e22477 JB |
1006 | this.bootNotificationResponse = { |
1007 | currentTime: new Date().toISOString(), | |
1008 | interval: this.getHeartbeatInterval() / 1000, | |
e7aeea18 | 1009 | status: RegistrationStatus.ACCEPTED, |
47e22477 JB |
1010 | }; |
1011 | } | |
147d0e0f JB |
1012 | } |
1013 | ||
2484ac1e | 1014 | private initializeOcppConfiguration(): void { |
17ac262c JB |
1015 | if ( |
1016 | !ChargingStationConfigurationUtils.getConfigurationKey( | |
1017 | this, | |
1018 | StandardParametersKey.HeartbeatInterval | |
1019 | ) | |
1020 | ) { | |
1021 | ChargingStationConfigurationUtils.addConfigurationKey( | |
1022 | this, | |
1023 | StandardParametersKey.HeartbeatInterval, | |
1024 | '0' | |
1025 | ); | |
f0f65a62 | 1026 | } |
17ac262c JB |
1027 | if ( |
1028 | !ChargingStationConfigurationUtils.getConfigurationKey( | |
1029 | this, | |
1030 | StandardParametersKey.HeartBeatInterval | |
1031 | ) | |
1032 | ) { | |
1033 | ChargingStationConfigurationUtils.addConfigurationKey( | |
1034 | this, | |
1035 | StandardParametersKey.HeartBeatInterval, | |
1036 | '0', | |
1037 | { visible: false } | |
1038 | ); | |
f0f65a62 | 1039 | } |
e7aeea18 JB |
1040 | if ( |
1041 | this.getSupervisionUrlOcppConfiguration() && | |
17ac262c | 1042 | !ChargingStationConfigurationUtils.getConfigurationKey(this, this.getSupervisionUrlOcppKey()) |
e7aeea18 | 1043 | ) { |
17ac262c JB |
1044 | ChargingStationConfigurationUtils.addConfigurationKey( |
1045 | this, | |
a59737e3 | 1046 | this.getSupervisionUrlOcppKey(), |
fa7bccf4 | 1047 | this.configuredSupervisionUrl.href, |
e7aeea18 JB |
1048 | { reboot: true } |
1049 | ); | |
e6895390 JB |
1050 | } else if ( |
1051 | !this.getSupervisionUrlOcppConfiguration() && | |
17ac262c | 1052 | ChargingStationConfigurationUtils.getConfigurationKey(this, this.getSupervisionUrlOcppKey()) |
e6895390 | 1053 | ) { |
17ac262c JB |
1054 | ChargingStationConfigurationUtils.deleteConfigurationKey( |
1055 | this, | |
1056 | this.getSupervisionUrlOcppKey(), | |
1057 | { save: false } | |
1058 | ); | |
12fc74d6 | 1059 | } |
cc6e8ab5 JB |
1060 | if ( |
1061 | this.stationInfo.amperageLimitationOcppKey && | |
17ac262c JB |
1062 | !ChargingStationConfigurationUtils.getConfigurationKey( |
1063 | this, | |
1064 | this.stationInfo.amperageLimitationOcppKey | |
1065 | ) | |
cc6e8ab5 | 1066 | ) { |
17ac262c JB |
1067 | ChargingStationConfigurationUtils.addConfigurationKey( |
1068 | this, | |
cc6e8ab5 | 1069 | this.stationInfo.amperageLimitationOcppKey, |
17ac262c JB |
1070 | ( |
1071 | this.stationInfo.maximumAmperage * | |
1072 | ChargingStationUtils.getAmperageLimitationUnitDivider(this.stationInfo) | |
1073 | ).toString() | |
cc6e8ab5 JB |
1074 | ); |
1075 | } | |
17ac262c JB |
1076 | if ( |
1077 | !ChargingStationConfigurationUtils.getConfigurationKey( | |
1078 | this, | |
1079 | StandardParametersKey.SupportedFeatureProfiles | |
1080 | ) | |
1081 | ) { | |
1082 | ChargingStationConfigurationUtils.addConfigurationKey( | |
1083 | this, | |
e7aeea18 | 1084 | StandardParametersKey.SupportedFeatureProfiles, |
b22787b4 | 1085 | `${SupportedFeatureProfiles.Core},${SupportedFeatureProfiles.FirmwareManagement},${SupportedFeatureProfiles.LocalAuthListManagement},${SupportedFeatureProfiles.SmartCharging},${SupportedFeatureProfiles.RemoteTrigger}` |
e7aeea18 JB |
1086 | ); |
1087 | } | |
17ac262c JB |
1088 | ChargingStationConfigurationUtils.addConfigurationKey( |
1089 | this, | |
e7aeea18 JB |
1090 | StandardParametersKey.NumberOfConnectors, |
1091 | this.getNumberOfConnectors().toString(), | |
a95873d8 JB |
1092 | { readonly: true }, |
1093 | { overwrite: true } | |
e7aeea18 | 1094 | ); |
17ac262c JB |
1095 | if ( |
1096 | !ChargingStationConfigurationUtils.getConfigurationKey( | |
1097 | this, | |
1098 | StandardParametersKey.MeterValuesSampledData | |
1099 | ) | |
1100 | ) { | |
1101 | ChargingStationConfigurationUtils.addConfigurationKey( | |
1102 | this, | |
e7aeea18 JB |
1103 | StandardParametersKey.MeterValuesSampledData, |
1104 | MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER | |
1105 | ); | |
7abfea5f | 1106 | } |
17ac262c JB |
1107 | if ( |
1108 | !ChargingStationConfigurationUtils.getConfigurationKey( | |
1109 | this, | |
1110 | StandardParametersKey.ConnectorPhaseRotation | |
1111 | ) | |
1112 | ) { | |
7e1dc878 | 1113 | const connectorPhaseRotation = []; |
734d790d | 1114 | for (const connectorId of this.connectors.keys()) { |
7e1dc878 | 1115 | // AC/DC |
734d790d JB |
1116 | if (connectorId === 0 && this.getNumberOfPhases() === 0) { |
1117 | connectorPhaseRotation.push(`${connectorId}.${ConnectorPhaseRotation.RST}`); | |
1118 | } else if (connectorId > 0 && this.getNumberOfPhases() === 0) { | |
1119 | connectorPhaseRotation.push(`${connectorId}.${ConnectorPhaseRotation.NotApplicable}`); | |
e7aeea18 | 1120 | // AC |
734d790d JB |
1121 | } else if (connectorId > 0 && this.getNumberOfPhases() === 1) { |
1122 | connectorPhaseRotation.push(`${connectorId}.${ConnectorPhaseRotation.NotApplicable}`); | |
1123 | } else if (connectorId > 0 && this.getNumberOfPhases() === 3) { | |
1124 | connectorPhaseRotation.push(`${connectorId}.${ConnectorPhaseRotation.RST}`); | |
7e1dc878 JB |
1125 | } |
1126 | } | |
17ac262c JB |
1127 | ChargingStationConfigurationUtils.addConfigurationKey( |
1128 | this, | |
e7aeea18 JB |
1129 | StandardParametersKey.ConnectorPhaseRotation, |
1130 | connectorPhaseRotation.toString() | |
1131 | ); | |
7e1dc878 | 1132 | } |
e7aeea18 | 1133 | if ( |
17ac262c JB |
1134 | !ChargingStationConfigurationUtils.getConfigurationKey( |
1135 | this, | |
1136 | StandardParametersKey.AuthorizeRemoteTxRequests | |
e7aeea18 JB |
1137 | ) |
1138 | ) { | |
17ac262c JB |
1139 | ChargingStationConfigurationUtils.addConfigurationKey( |
1140 | this, | |
1141 | StandardParametersKey.AuthorizeRemoteTxRequests, | |
1142 | 'true' | |
1143 | ); | |
36f6a92e | 1144 | } |
17ac262c JB |
1145 | if ( |
1146 | !ChargingStationConfigurationUtils.getConfigurationKey( | |
1147 | this, | |
1148 | StandardParametersKey.LocalAuthListEnabled | |
1149 | ) && | |
1150 | ChargingStationConfigurationUtils.getConfigurationKey( | |
1151 | this, | |
1152 | StandardParametersKey.SupportedFeatureProfiles | |
1153 | )?.value.includes(SupportedFeatureProfiles.LocalAuthListManagement) | |
1154 | ) { | |
1155 | ChargingStationConfigurationUtils.addConfigurationKey( | |
1156 | this, | |
1157 | StandardParametersKey.LocalAuthListEnabled, | |
1158 | 'false' | |
1159 | ); | |
1160 | } | |
1161 | if ( | |
1162 | !ChargingStationConfigurationUtils.getConfigurationKey( | |
1163 | this, | |
1164 | StandardParametersKey.ConnectionTimeOut | |
1165 | ) | |
1166 | ) { | |
1167 | ChargingStationConfigurationUtils.addConfigurationKey( | |
1168 | this, | |
e7aeea18 JB |
1169 | StandardParametersKey.ConnectionTimeOut, |
1170 | Constants.DEFAULT_CONNECTION_TIMEOUT.toString() | |
1171 | ); | |
8bce55bf | 1172 | } |
2484ac1e | 1173 | this.saveOcppConfiguration(); |
073bd098 JB |
1174 | } |
1175 | ||
3d25cc86 JB |
1176 | private initializeConnectors( |
1177 | stationInfo: ChargingStationInfo, | |
fa7bccf4 | 1178 | configuredMaxConnectors: number, |
3d25cc86 JB |
1179 | templateMaxConnectors: number |
1180 | ): void { | |
1181 | if (!stationInfo?.Connectors && this.connectors.size === 0) { | |
fc040c43 JB |
1182 | const logMsg = `No already defined connectors and charging station information from template ${this.templateFile} with no connectors configuration defined`; |
1183 | logger.error(`${this.logPrefix()} ${logMsg}`); | |
3d25cc86 JB |
1184 | throw new BaseError(logMsg); |
1185 | } | |
1186 | if (!stationInfo?.Connectors[0]) { | |
1187 | logger.warn( | |
1188 | `${this.logPrefix()} Charging station information from template ${ | |
1189 | this.templateFile | |
1190 | } with no connector Id 0 configuration` | |
1191 | ); | |
1192 | } | |
1193 | if (stationInfo?.Connectors) { | |
1194 | const connectorsConfigHash = crypto | |
1195 | .createHash(Constants.DEFAULT_HASH_ALGORITHM) | |
fa7bccf4 | 1196 | .update(JSON.stringify(stationInfo?.Connectors) + configuredMaxConnectors.toString()) |
3d25cc86 JB |
1197 | .digest('hex'); |
1198 | const connectorsConfigChanged = | |
1199 | this.connectors?.size !== 0 && this.connectorsConfigurationHash !== connectorsConfigHash; | |
1200 | if (this.connectors?.size === 0 || connectorsConfigChanged) { | |
1201 | connectorsConfigChanged && this.connectors.clear(); | |
1202 | this.connectorsConfigurationHash = connectorsConfigHash; | |
1203 | // Add connector Id 0 | |
1204 | let lastConnector = '0'; | |
1205 | for (lastConnector in stationInfo?.Connectors) { | |
1206 | const lastConnectorId = Utils.convertToInt(lastConnector); | |
1207 | if ( | |
1208 | lastConnectorId === 0 && | |
bb83b5ed | 1209 | this.getUseConnectorId0(stationInfo) === true && |
3d25cc86 JB |
1210 | stationInfo?.Connectors[lastConnector] |
1211 | ) { | |
1212 | this.connectors.set( | |
1213 | lastConnectorId, | |
1214 | Utils.cloneObject<ConnectorStatus>(stationInfo?.Connectors[lastConnector]) | |
1215 | ); | |
1216 | this.getConnectorStatus(lastConnectorId).availability = AvailabilityType.OPERATIVE; | |
1217 | if (Utils.isUndefined(this.getConnectorStatus(lastConnectorId)?.chargingProfiles)) { | |
1218 | this.getConnectorStatus(lastConnectorId).chargingProfiles = []; | |
1219 | } | |
1220 | } | |
1221 | } | |
1222 | // Generate all connectors | |
1223 | if ((stationInfo?.Connectors[0] ? templateMaxConnectors - 1 : templateMaxConnectors) > 0) { | |
fa7bccf4 | 1224 | for (let index = 1; index <= configuredMaxConnectors; index++) { |
ccb1d6e9 | 1225 | const randConnectorId = stationInfo?.randomConnectors |
3d25cc86 JB |
1226 | ? Utils.getRandomInteger(Utils.convertToInt(lastConnector), 1) |
1227 | : index; | |
1228 | this.connectors.set( | |
1229 | index, | |
1230 | Utils.cloneObject<ConnectorStatus>(stationInfo?.Connectors[randConnectorId]) | |
1231 | ); | |
1232 | this.getConnectorStatus(index).availability = AvailabilityType.OPERATIVE; | |
1233 | if (Utils.isUndefined(this.getConnectorStatus(index)?.chargingProfiles)) { | |
1234 | this.getConnectorStatus(index).chargingProfiles = []; | |
1235 | } | |
1236 | } | |
1237 | } | |
1238 | } | |
1239 | } else { | |
1240 | logger.warn( | |
1241 | `${this.logPrefix()} Charging station information from template ${ | |
1242 | this.templateFile | |
1243 | } with no connectors configuration defined, using already defined connectors` | |
1244 | ); | |
1245 | } | |
1246 | // Initialize transaction attributes on connectors | |
1247 | for (const connectorId of this.connectors.keys()) { | |
1984f194 JB |
1248 | if ( |
1249 | connectorId > 0 && | |
1250 | (this.getConnectorStatus(connectorId).transactionStarted === undefined || | |
1251 | this.getConnectorStatus(connectorId).transactionStarted === false) | |
1252 | ) { | |
3d25cc86 JB |
1253 | this.initializeConnectorStatus(connectorId); |
1254 | } | |
1255 | } | |
1256 | } | |
1257 | ||
7f7b65ca | 1258 | private getConfigurationFromFile(): ChargingStationConfiguration | null { |
073bd098 | 1259 | let configuration: ChargingStationConfiguration = null; |
2484ac1e | 1260 | if (this.configurationFile && fs.existsSync(this.configurationFile)) { |
073bd098 | 1261 | try { |
57adbebc JB |
1262 | if (this.sharedLRUCache.hasChargingStationConfiguration(this.configurationFileHash)) { |
1263 | configuration = this.sharedLRUCache.getChargingStationConfiguration( | |
1264 | this.configurationFileHash | |
1265 | ); | |
7c72977b JB |
1266 | } else { |
1267 | const measureId = `${FileType.ChargingStationConfiguration} read`; | |
1268 | const beginId = PerformanceStatistics.beginMeasure(measureId); | |
1269 | configuration = JSON.parse( | |
1270 | fs.readFileSync(this.configurationFile, 'utf8') | |
1271 | ) as ChargingStationConfiguration; | |
1272 | PerformanceStatistics.endMeasure(measureId, beginId); | |
1273 | this.configurationFileHash = configuration.configurationHash; | |
57adbebc | 1274 | this.sharedLRUCache.setChargingStationConfiguration(configuration); |
7c72977b | 1275 | } |
073bd098 JB |
1276 | } catch (error) { |
1277 | FileUtils.handleFileException( | |
1278 | this.logPrefix(), | |
a95873d8 | 1279 | FileType.ChargingStationConfiguration, |
073bd098 JB |
1280 | this.configurationFile, |
1281 | error as NodeJS.ErrnoException | |
1282 | ); | |
1283 | } | |
1284 | } | |
1285 | return configuration; | |
1286 | } | |
1287 | ||
7c72977b | 1288 | private saveConfiguration(): void { |
2484ac1e JB |
1289 | if (this.configurationFile) { |
1290 | try { | |
2484ac1e JB |
1291 | if (!fs.existsSync(path.dirname(this.configurationFile))) { |
1292 | fs.mkdirSync(path.dirname(this.configurationFile), { recursive: true }); | |
073bd098 | 1293 | } |
ccb1d6e9 JB |
1294 | const configurationData: ChargingStationConfiguration = |
1295 | this.getConfigurationFromFile() ?? {}; | |
7c72977b JB |
1296 | this.ocppConfiguration?.configurationKey && |
1297 | (configurationData.configurationKey = this.ocppConfiguration.configurationKey); | |
1298 | this.stationInfo && (configurationData.stationInfo = this.stationInfo); | |
1299 | delete configurationData.configurationHash; | |
1300 | const configurationHash = crypto | |
1301 | .createHash(Constants.DEFAULT_HASH_ALGORITHM) | |
1302 | .update(JSON.stringify(configurationData)) | |
1303 | .digest('hex'); | |
1304 | if (this.configurationFileHash !== configurationHash) { | |
1305 | configurationData.configurationHash = configurationHash; | |
1306 | const measureId = `${FileType.ChargingStationConfiguration} write`; | |
1307 | const beginId = PerformanceStatistics.beginMeasure(measureId); | |
1308 | const fileDescriptor = fs.openSync(this.configurationFile, 'w'); | |
1309 | fs.writeFileSync(fileDescriptor, JSON.stringify(configurationData, null, 2), 'utf8'); | |
1310 | fs.closeSync(fileDescriptor); | |
1311 | PerformanceStatistics.endMeasure(measureId, beginId); | |
57adbebc | 1312 | this.sharedLRUCache.deleteChargingStationConfiguration(this.configurationFileHash); |
7c72977b | 1313 | this.configurationFileHash = configurationHash; |
57adbebc | 1314 | this.sharedLRUCache.setChargingStationConfiguration(configurationData); |
7c72977b JB |
1315 | } else { |
1316 | logger.debug( | |
1317 | `${this.logPrefix()} Not saving unchanged charging station configuration file ${ | |
1318 | this.configurationFile | |
1319 | }` | |
1320 | ); | |
2484ac1e | 1321 | } |
2484ac1e JB |
1322 | } catch (error) { |
1323 | FileUtils.handleFileException( | |
1324 | this.logPrefix(), | |
1325 | FileType.ChargingStationConfiguration, | |
1326 | this.configurationFile, | |
1327 | error as NodeJS.ErrnoException | |
073bd098 JB |
1328 | ); |
1329 | } | |
2484ac1e JB |
1330 | } else { |
1331 | logger.error( | |
01efc60a | 1332 | `${this.logPrefix()} Trying to save charging station configuration to undefined configuration file` |
2484ac1e | 1333 | ); |
073bd098 JB |
1334 | } |
1335 | } | |
1336 | ||
ccb1d6e9 JB |
1337 | private getOcppConfigurationFromTemplate(): ChargingStationOcppConfiguration | null { |
1338 | return this.getTemplateFromFile()?.Configuration ?? null; | |
2484ac1e JB |
1339 | } |
1340 | ||
1341 | private getOcppConfigurationFromFile(): ChargingStationOcppConfiguration | null { | |
1342 | let configuration: ChargingStationConfiguration = null; | |
1343 | if (this.getOcppPersistentConfiguration()) { | |
7a3a2ebb JB |
1344 | const configurationFromFile = this.getConfigurationFromFile(); |
1345 | configuration = configurationFromFile?.configurationKey && configurationFromFile; | |
073bd098 | 1346 | } |
2484ac1e | 1347 | configuration && delete configuration.stationInfo; |
073bd098 | 1348 | return configuration; |
7dde0b73 JB |
1349 | } |
1350 | ||
ccb1d6e9 | 1351 | private getOcppConfiguration(): ChargingStationOcppConfiguration | null { |
2484ac1e JB |
1352 | let ocppConfiguration: ChargingStationOcppConfiguration = this.getOcppConfigurationFromFile(); |
1353 | if (!ocppConfiguration) { | |
1354 | ocppConfiguration = this.getOcppConfigurationFromTemplate(); | |
1355 | } | |
1356 | return ocppConfiguration; | |
1357 | } | |
1358 | ||
c0560973 | 1359 | private async onOpen(): Promise<void> { |
5144f4d1 JB |
1360 | if (this.isWebSocketConnectionOpened()) { |
1361 | logger.info( | |
1362 | `${this.logPrefix()} Connection to OCPP server through ${this.wsConnectionUrl.toString()} succeeded` | |
1363 | ); | |
94bb24d5 | 1364 | if (!this.isRegistered()) { |
5144f4d1 JB |
1365 | // Send BootNotification |
1366 | let registrationRetryCount = 0; | |
1367 | do { | |
f7f98c68 | 1368 | this.bootNotificationResponse = await this.ocppRequestService.requestHandler< |
5144f4d1 JB |
1369 | BootNotificationRequest, |
1370 | BootNotificationResponse | |
8bfbc743 JB |
1371 | >(this, RequestCommand.BOOT_NOTIFICATION, this.bootNotificationRequest, { |
1372 | skipBufferingOnError: true, | |
1373 | }); | |
94bb24d5 | 1374 | if (!this.isRegistered()) { |
5144f4d1 JB |
1375 | this.getRegistrationMaxRetries() !== -1 && registrationRetryCount++; |
1376 | await Utils.sleep( | |
1377 | this.bootNotificationResponse?.interval | |
1378 | ? this.bootNotificationResponse.interval * 1000 | |
1379 | : Constants.OCPP_DEFAULT_BOOT_NOTIFICATION_INTERVAL | |
1380 | ); | |
1381 | } | |
1382 | } while ( | |
94bb24d5 | 1383 | !this.isRegistered() && |
5144f4d1 JB |
1384 | (registrationRetryCount <= this.getRegistrationMaxRetries() || |
1385 | this.getRegistrationMaxRetries() === -1) | |
1386 | ); | |
1387 | } | |
94bb24d5 JB |
1388 | if (this.isRegistered()) { |
1389 | if (this.isInAcceptedState()) { | |
1390 | await this.startMessageSequence(); | |
c0560973 | 1391 | } |
5144f4d1 JB |
1392 | } else { |
1393 | logger.error( | |
1394 | `${this.logPrefix()} Registration failure: max retries reached (${this.getRegistrationMaxRetries()}) or retry disabled (${this.getRegistrationMaxRetries()})` | |
1395 | ); | |
caad9d6b | 1396 | } |
5144f4d1 | 1397 | this.wsConnectionRestarted = false; |
aa428a31 JB |
1398 | this.autoReconnectRetryCount = 0; |
1399 | this.started = true; | |
5e3cb728 | 1400 | parentPort.postMessage(MessageChannelUtils.buildUpdatedMessage(this)); |
2e6f5966 | 1401 | } else { |
5144f4d1 JB |
1402 | logger.warn( |
1403 | `${this.logPrefix()} Connection to OCPP server through ${this.wsConnectionUrl.toString()} failed` | |
e7aeea18 | 1404 | ); |
2e6f5966 | 1405 | } |
2e6f5966 JB |
1406 | } |
1407 | ||
6c65a295 | 1408 | private async onClose(code: number, reason: string): Promise<void> { |
d09085e9 | 1409 | switch (code) { |
6c65a295 JB |
1410 | // Normal close |
1411 | case WebSocketCloseEventStatusCode.CLOSE_NORMAL: | |
c0560973 | 1412 | case WebSocketCloseEventStatusCode.CLOSE_NO_STATUS: |
e7aeea18 | 1413 | logger.info( |
5e3cb728 | 1414 | `${this.logPrefix()} WebSocket normally closed with status '${Utils.getWebSocketCloseEventStatusString( |
e7aeea18 JB |
1415 | code |
1416 | )}' and reason '${reason}'` | |
1417 | ); | |
c0560973 JB |
1418 | this.autoReconnectRetryCount = 0; |
1419 | break; | |
6c65a295 JB |
1420 | // Abnormal close |
1421 | default: | |
e7aeea18 | 1422 | logger.error( |
5e3cb728 | 1423 | `${this.logPrefix()} WebSocket abnormally closed with status '${Utils.getWebSocketCloseEventStatusString( |
e7aeea18 JB |
1424 | code |
1425 | )}' and reason '${reason}'` | |
1426 | ); | |
aa428a31 | 1427 | await this.reconnect(); |
c0560973 JB |
1428 | break; |
1429 | } | |
5e3cb728 | 1430 | parentPort.postMessage(MessageChannelUtils.buildUpdatedMessage(this)); |
2e6f5966 JB |
1431 | } |
1432 | ||
16b0d4e7 | 1433 | private async onMessage(data: Data): Promise<void> { |
b3ec7bc1 JB |
1434 | let messageType: number; |
1435 | let messageId: string; | |
1436 | let commandName: IncomingRequestCommand; | |
1437 | let commandPayload: JsonType; | |
1438 | let errorType: ErrorType; | |
1439 | let errorMessage: string; | |
1440 | let errorDetails: JsonType; | |
1441 | let responseCallback: (payload: JsonType, requestPayload: JsonType) => void; | |
a2d1c0f1 | 1442 | let errorCallback: (error: OCPPError, requestStatistic?: boolean) => void; |
32b02249 | 1443 | let requestCommandName: RequestCommand | IncomingRequestCommand; |
b3ec7bc1 | 1444 | let requestPayload: JsonType; |
32b02249 | 1445 | let cachedRequest: CachedRequest; |
c0560973 JB |
1446 | let errMsg: string; |
1447 | try { | |
b3ec7bc1 | 1448 | const request = JSON.parse(data.toString()) as IncomingRequest | Response | ErrorResponse; |
53e5fd67 | 1449 | if (Array.isArray(request) === true) { |
9934652c | 1450 | [messageType, messageId] = request; |
b3ec7bc1 JB |
1451 | // Check the type of message |
1452 | switch (messageType) { | |
1453 | // Incoming Message | |
1454 | case MessageType.CALL_MESSAGE: | |
9934652c | 1455 | [, , commandName, commandPayload] = request as IncomingRequest; |
0638ddd2 | 1456 | if (this.getEnableStatistics() === true) { |
b3ec7bc1 JB |
1457 | this.performanceStatistics.addRequestStatistic(commandName, messageType); |
1458 | } | |
1459 | logger.debug( | |
1460 | `${this.logPrefix()} << Command '${commandName}' received request payload: ${JSON.stringify( | |
1461 | request | |
1462 | )}` | |
1463 | ); | |
1464 | // Process the message | |
1465 | await this.ocppIncomingRequestService.incomingRequestHandler( | |
08f130a0 | 1466 | this, |
b3ec7bc1 JB |
1467 | messageId, |
1468 | commandName, | |
1469 | commandPayload | |
1470 | ); | |
1471 | break; | |
1472 | // Outcome Message | |
1473 | case MessageType.CALL_RESULT_MESSAGE: | |
9934652c | 1474 | [, , commandPayload] = request as Response; |
ba7965c4 | 1475 | if (this.requests.has(messageId) === false) { |
a2d1c0f1 JB |
1476 | // Error |
1477 | throw new OCPPError( | |
1478 | ErrorType.INTERNAL_ERROR, | |
1479 | `Response for unknown message id ${messageId}`, | |
1480 | null, | |
1481 | commandPayload | |
1482 | ); | |
1483 | } | |
b3ec7bc1 JB |
1484 | // Respond |
1485 | cachedRequest = this.requests.get(messageId); | |
53e5fd67 | 1486 | if (Array.isArray(cachedRequest) === true) { |
b3ec7bc1 JB |
1487 | [responseCallback, , requestCommandName, requestPayload] = cachedRequest; |
1488 | } else { | |
1489 | throw new OCPPError( | |
1490 | ErrorType.PROTOCOL_ERROR, | |
53e5fd67 | 1491 | `Cached request for message id ${messageId} response is not an array`, |
c2bc716f JB |
1492 | null, |
1493 | cachedRequest as unknown as JsonType | |
b3ec7bc1 JB |
1494 | ); |
1495 | } | |
1496 | logger.debug( | |
7ec6c5c9 | 1497 | `${this.logPrefix()} << Command '${ |
7369e417 | 1498 | requestCommandName ?? 'unknown' |
7ec6c5c9 | 1499 | }' received response payload: ${JSON.stringify(request)}` |
b3ec7bc1 | 1500 | ); |
a2d1c0f1 JB |
1501 | responseCallback(commandPayload, requestPayload); |
1502 | break; | |
1503 | // Error Message | |
1504 | case MessageType.CALL_ERROR_MESSAGE: | |
1505 | [, , errorType, errorMessage, errorDetails] = request as ErrorResponse; | |
ba7965c4 | 1506 | if (this.requests.has(messageId) === false) { |
b3ec7bc1 JB |
1507 | // Error |
1508 | throw new OCPPError( | |
1509 | ErrorType.INTERNAL_ERROR, | |
a2d1c0f1 | 1510 | `Error response for unknown message id ${messageId}`, |
c2bc716f | 1511 | null, |
a2d1c0f1 | 1512 | { errorType, errorMessage, errorDetails } |
b3ec7bc1 JB |
1513 | ); |
1514 | } | |
b3ec7bc1 | 1515 | cachedRequest = this.requests.get(messageId); |
53e5fd67 | 1516 | if (Array.isArray(cachedRequest) === true) { |
a2d1c0f1 | 1517 | [, errorCallback, requestCommandName] = cachedRequest; |
b3ec7bc1 JB |
1518 | } else { |
1519 | throw new OCPPError( | |
1520 | ErrorType.PROTOCOL_ERROR, | |
53e5fd67 | 1521 | `Cached request for message id ${messageId} error response is not an array`, |
c2bc716f JB |
1522 | null, |
1523 | cachedRequest as unknown as JsonType | |
b3ec7bc1 JB |
1524 | ); |
1525 | } | |
1526 | logger.debug( | |
7ec6c5c9 | 1527 | `${this.logPrefix()} << Command '${ |
7369e417 | 1528 | requestCommandName ?? 'unknown' |
7ec6c5c9 | 1529 | }' received error payload: ${JSON.stringify(request)}` |
b3ec7bc1 | 1530 | ); |
a2d1c0f1 | 1531 | errorCallback(new OCPPError(errorType, errorMessage, requestCommandName, errorDetails)); |
b3ec7bc1 JB |
1532 | break; |
1533 | // Error | |
1534 | default: | |
1535 | // eslint-disable-next-line @typescript-eslint/restrict-template-expressions | |
fc040c43 JB |
1536 | errMsg = `Wrong message type ${messageType}`; |
1537 | logger.error(`${this.logPrefix()} ${errMsg}`); | |
b3ec7bc1 JB |
1538 | throw new OCPPError(ErrorType.PROTOCOL_ERROR, errMsg); |
1539 | } | |
32de5a57 | 1540 | parentPort.postMessage(MessageChannelUtils.buildUpdatedMessage(this)); |
47e22477 | 1541 | } else { |
53e5fd67 | 1542 | throw new OCPPError(ErrorType.PROTOCOL_ERROR, 'Incoming message is not an array', null, { |
ba7965c4 | 1543 | request, |
ac54a9bb | 1544 | }); |
47e22477 | 1545 | } |
c0560973 JB |
1546 | } catch (error) { |
1547 | // Log | |
e7aeea18 | 1548 | logger.error( |
91a4f151 | 1549 | `${this.logPrefix()} Incoming OCPP command '${ |
fc040c43 | 1550 | commandName ?? requestCommandName ?? null |
9c5d9fa4 JB |
1551 | }' message '${data.toString()}'${ |
1552 | messageType !== MessageType.CALL_MESSAGE | |
1553 | ? ` matching cached request '${JSON.stringify(this.requests.get(messageId))}'` | |
1554 | : '' | |
1555 | } processing error:`, | |
e7aeea18 JB |
1556 | error |
1557 | ); | |
ba7965c4 | 1558 | if (error instanceof OCPPError === false) { |
247659af | 1559 | logger.warn( |
91a4f151 | 1560 | `${this.logPrefix()} Error thrown at incoming OCPP command '${ |
fc040c43 JB |
1561 | commandName ?? requestCommandName ?? null |
1562 | }' message '${data.toString()}' handling is not an OCPPError:`, | |
247659af JB |
1563 | error |
1564 | ); | |
1565 | } | |
ba7965c4 JB |
1566 | if (messageType === MessageType.CALL_MESSAGE) { |
1567 | // Send error | |
1568 | await this.ocppRequestService.sendError( | |
08f130a0 | 1569 | this, |
b3ec7bc1 JB |
1570 | messageId, |
1571 | error as OCPPError, | |
a2d1c0f1 | 1572 | commandName ?? requestCommandName ?? null |
ba7965c4 | 1573 | ); |
1ec17ecd | 1574 | } else if ( |
95bdbf12 JB |
1575 | [MessageType.CALL_RESULT_MESSAGE, MessageType.CALL_ERROR_MESSAGE].includes(messageType) === |
1576 | true | |
1ec17ecd JB |
1577 | ) { |
1578 | // Remove the request from the cache | |
1579 | this.requests.delete(messageId); | |
ba7965c4 | 1580 | } |
c0560973 | 1581 | } |
2328be1e JB |
1582 | } |
1583 | ||
c0560973 | 1584 | private onPing(): void { |
9f2e3130 | 1585 | logger.debug(this.logPrefix() + ' Received a WS ping (rfc6455) from the server'); |
c0560973 JB |
1586 | } |
1587 | ||
1588 | private onPong(): void { | |
9f2e3130 | 1589 | logger.debug(this.logPrefix() + ' Received a WS pong (rfc6455) from the server'); |
c0560973 JB |
1590 | } |
1591 | ||
9534e74e | 1592 | private onError(error: WSError): void { |
bcc9c3c0 | 1593 | this.closeWSConnection(); |
32de5a57 | 1594 | logger.error(this.logPrefix() + ' WebSocket error:', error); |
c0560973 JB |
1595 | } |
1596 | ||
07989fad JB |
1597 | private getEnergyActiveImportRegister( |
1598 | connectorStatus: ConnectorStatus, | |
1599 | meterStop = false | |
1600 | ): number { | |
95bdbf12 | 1601 | if (this.getMeteringPerTransaction() === true) { |
07989fad JB |
1602 | return ( |
1603 | (meterStop === true | |
1604 | ? Math.round(connectorStatus?.transactionEnergyActiveImportRegisterValue) | |
1605 | : connectorStatus?.transactionEnergyActiveImportRegisterValue) ?? 0 | |
1606 | ); | |
1607 | } | |
1608 | return ( | |
1609 | (meterStop === true | |
1610 | ? Math.round(connectorStatus?.energyActiveImportRegisterValue) | |
1611 | : connectorStatus?.energyActiveImportRegisterValue) ?? 0 | |
1612 | ); | |
1613 | } | |
1614 | ||
bb83b5ed | 1615 | private getUseConnectorId0(stationInfo?: ChargingStationInfo): boolean { |
fa7bccf4 JB |
1616 | const localStationInfo = stationInfo ?? this.stationInfo; |
1617 | return !Utils.isUndefined(localStationInfo.useConnectorId0) | |
1618 | ? localStationInfo.useConnectorId0 | |
e7aeea18 | 1619 | : true; |
8bce55bf JB |
1620 | } |
1621 | ||
60ddad53 JB |
1622 | private getNumberOfRunningTransactions(): number { |
1623 | let trxCount = 0; | |
1624 | for (const connectorId of this.connectors.keys()) { | |
1625 | if (connectorId > 0 && this.getConnectorStatus(connectorId)?.transactionStarted === true) { | |
1626 | trxCount++; | |
1627 | } | |
1628 | } | |
1629 | return trxCount; | |
1630 | } | |
1631 | ||
1632 | private async stopRunningTransactions(reason = StopTransactionReason.NONE): Promise<void> { | |
1633 | for (const connectorId of this.connectors.keys()) { | |
1634 | if (connectorId > 0 && this.getConnectorStatus(connectorId)?.transactionStarted === true) { | |
1635 | await this.stopTransactionOnConnector(connectorId, reason); | |
1636 | } | |
1637 | } | |
1638 | } | |
1639 | ||
1f761b9a | 1640 | // 0 for disabling |
6e0964c8 | 1641 | private getConnectionTimeout(): number | undefined { |
17ac262c JB |
1642 | if ( |
1643 | ChargingStationConfigurationUtils.getConfigurationKey( | |
1644 | this, | |
1645 | StandardParametersKey.ConnectionTimeOut | |
1646 | ) | |
1647 | ) { | |
e7aeea18 | 1648 | return ( |
17ac262c JB |
1649 | parseInt( |
1650 | ChargingStationConfigurationUtils.getConfigurationKey( | |
1651 | this, | |
1652 | StandardParametersKey.ConnectionTimeOut | |
1653 | ).value | |
1654 | ) ?? Constants.DEFAULT_CONNECTION_TIMEOUT | |
e7aeea18 | 1655 | ); |
291cb255 | 1656 | } |
291cb255 | 1657 | return Constants.DEFAULT_CONNECTION_TIMEOUT; |
3574dfd3 JB |
1658 | } |
1659 | ||
1f761b9a | 1660 | // -1 for unlimited, 0 for disabling |
6e0964c8 | 1661 | private getAutoReconnectMaxRetries(): number | undefined { |
ad2f27c3 JB |
1662 | if (!Utils.isUndefined(this.stationInfo.autoReconnectMaxRetries)) { |
1663 | return this.stationInfo.autoReconnectMaxRetries; | |
3574dfd3 JB |
1664 | } |
1665 | if (!Utils.isUndefined(Configuration.getAutoReconnectMaxRetries())) { | |
1666 | return Configuration.getAutoReconnectMaxRetries(); | |
1667 | } | |
1668 | return -1; | |
1669 | } | |
1670 | ||
ec977daf | 1671 | // 0 for disabling |
6e0964c8 | 1672 | private getRegistrationMaxRetries(): number | undefined { |
ad2f27c3 JB |
1673 | if (!Utils.isUndefined(this.stationInfo.registrationMaxRetries)) { |
1674 | return this.stationInfo.registrationMaxRetries; | |
32a1eb7a JB |
1675 | } |
1676 | return -1; | |
1677 | } | |
1678 | ||
c0560973 JB |
1679 | private getPowerDivider(): number { |
1680 | let powerDivider = this.getNumberOfConnectors(); | |
fa7bccf4 | 1681 | if (this.stationInfo?.powerSharedByConnectors) { |
c0560973 | 1682 | powerDivider = this.getNumberOfRunningTransactions(); |
6ecb15e4 JB |
1683 | } |
1684 | return powerDivider; | |
1685 | } | |
1686 | ||
fa7bccf4 JB |
1687 | private getMaximumPower(stationInfo?: ChargingStationInfo): number { |
1688 | const localStationInfo = stationInfo ?? this.stationInfo; | |
1689 | return (localStationInfo['maxPower'] as number) ?? localStationInfo.maximumPower; | |
0642c3d2 JB |
1690 | } |
1691 | ||
fa7bccf4 JB |
1692 | private getMaximumAmperage(stationInfo: ChargingStationInfo): number | undefined { |
1693 | const maximumPower = this.getMaximumPower(stationInfo); | |
1694 | switch (this.getCurrentOutType(stationInfo)) { | |
cc6e8ab5 JB |
1695 | case CurrentType.AC: |
1696 | return ACElectricUtils.amperagePerPhaseFromPower( | |
fa7bccf4 | 1697 | this.getNumberOfPhases(stationInfo), |
ad8537a7 | 1698 | maximumPower / this.getNumberOfConnectors(), |
fa7bccf4 | 1699 | this.getVoltageOut(stationInfo) |
cc6e8ab5 JB |
1700 | ); |
1701 | case CurrentType.DC: | |
fa7bccf4 | 1702 | return DCElectricUtils.amperage(maximumPower, this.getVoltageOut(stationInfo)); |
cc6e8ab5 JB |
1703 | } |
1704 | } | |
1705 | ||
cc6e8ab5 JB |
1706 | private getAmperageLimitation(): number | undefined { |
1707 | if ( | |
1708 | this.stationInfo.amperageLimitationOcppKey && | |
17ac262c JB |
1709 | ChargingStationConfigurationUtils.getConfigurationKey( |
1710 | this, | |
1711 | this.stationInfo.amperageLimitationOcppKey | |
1712 | ) | |
cc6e8ab5 JB |
1713 | ) { |
1714 | return ( | |
1715 | Utils.convertToInt( | |
17ac262c JB |
1716 | ChargingStationConfigurationUtils.getConfigurationKey( |
1717 | this, | |
1718 | this.stationInfo.amperageLimitationOcppKey | |
1719 | ).value | |
1720 | ) / ChargingStationUtils.getAmperageLimitationUnitDivider(this.stationInfo) | |
cc6e8ab5 JB |
1721 | ); |
1722 | } | |
1723 | } | |
1724 | ||
60ddad53 JB |
1725 | private getChargingProfilePowerLimit(connectorId: number): number | undefined { |
1726 | let limit: number, matchingChargingProfile: ChargingProfile; | |
1727 | let chargingProfiles: ChargingProfile[] = []; | |
1728 | // Get charging profiles for connector and sort by stack level | |
1729 | chargingProfiles = this.getConnectorStatus(connectorId).chargingProfiles.sort( | |
1730 | (a, b) => b.stackLevel - a.stackLevel | |
1731 | ); | |
1732 | // Get profiles on connector 0 | |
1733 | if (this.getConnectorStatus(0).chargingProfiles) { | |
1734 | chargingProfiles.push( | |
1735 | ...this.getConnectorStatus(0).chargingProfiles.sort((a, b) => b.stackLevel - a.stackLevel) | |
1736 | ); | |
1737 | } | |
1738 | if (!Utils.isEmptyArray(chargingProfiles)) { | |
1739 | const result = ChargingStationUtils.getLimitFromChargingProfiles( | |
1740 | chargingProfiles, | |
1741 | this.logPrefix() | |
1742 | ); | |
1743 | if (!Utils.isNullOrUndefined(result)) { | |
1744 | limit = result.limit; | |
1745 | matchingChargingProfile = result.matchingChargingProfile; | |
1746 | switch (this.getCurrentOutType()) { | |
1747 | case CurrentType.AC: | |
1748 | limit = | |
1749 | matchingChargingProfile.chargingSchedule.chargingRateUnit === | |
1750 | ChargingRateUnitType.WATT | |
1751 | ? limit | |
1752 | : ACElectricUtils.powerTotal(this.getNumberOfPhases(), this.getVoltageOut(), limit); | |
1753 | break; | |
1754 | case CurrentType.DC: | |
1755 | limit = | |
1756 | matchingChargingProfile.chargingSchedule.chargingRateUnit === | |
1757 | ChargingRateUnitType.WATT | |
1758 | ? limit | |
1759 | : DCElectricUtils.power(this.getVoltageOut(), limit); | |
1760 | } | |
1761 | const connectorMaximumPower = this.getMaximumPower() / this.powerDivider; | |
1762 | if (limit > connectorMaximumPower) { | |
1763 | logger.error( | |
1764 | `${this.logPrefix()} Charging profile id ${ | |
1765 | matchingChargingProfile.chargingProfileId | |
1766 | } limit is greater than connector id ${connectorId} maximum, dump charging profiles' stack: %j`, | |
1767 | this.getConnectorStatus(connectorId).chargingProfiles | |
1768 | ); | |
1769 | limit = connectorMaximumPower; | |
1770 | } | |
1771 | } | |
1772 | } | |
1773 | return limit; | |
1774 | } | |
1775 | ||
c0560973 | 1776 | private async startMessageSequence(): Promise<void> { |
7c72977b | 1777 | if (this.stationInfo?.autoRegister) { |
f7f98c68 | 1778 | await this.ocppRequestService.requestHandler< |
ef6fa3fb JB |
1779 | BootNotificationRequest, |
1780 | BootNotificationResponse | |
8bfbc743 JB |
1781 | >(this, RequestCommand.BOOT_NOTIFICATION, this.bootNotificationRequest, { |
1782 | skipBufferingOnError: true, | |
1783 | }); | |
6114e6f1 | 1784 | } |
136c90ba | 1785 | // Start WebSocket ping |
c0560973 | 1786 | this.startWebSocketPing(); |
5ad8570f | 1787 | // Start heartbeat |
c0560973 | 1788 | this.startHeartbeat(); |
0a60c33c | 1789 | // Initialize connectors status |
734d790d JB |
1790 | for (const connectorId of this.connectors.keys()) { |
1791 | if (connectorId === 0) { | |
593cf3f9 | 1792 | continue; |
e7aeea18 | 1793 | } else if ( |
452a82ca | 1794 | this.started === true && |
e7aeea18 JB |
1795 | !this.getConnectorStatus(connectorId)?.status && |
1796 | this.getConnectorStatus(connectorId)?.bootStatus | |
1797 | ) { | |
136c90ba | 1798 | // Send status in template at startup |
f7f98c68 | 1799 | await this.ocppRequestService.requestHandler< |
ef6fa3fb JB |
1800 | StatusNotificationRequest, |
1801 | StatusNotificationResponse | |
08f130a0 | 1802 | >(this, RequestCommand.STATUS_NOTIFICATION, { |
ef6fa3fb JB |
1803 | connectorId, |
1804 | status: this.getConnectorStatus(connectorId).bootStatus, | |
1805 | errorCode: ChargePointErrorCode.NO_ERROR, | |
1806 | }); | |
e7aeea18 JB |
1807 | this.getConnectorStatus(connectorId).status = |
1808 | this.getConnectorStatus(connectorId).bootStatus; | |
1809 | } else if ( | |
452a82ca | 1810 | this.started === false && |
e7aeea18 JB |
1811 | this.getConnectorStatus(connectorId)?.status && |
1812 | this.getConnectorStatus(connectorId)?.bootStatus | |
1813 | ) { | |
136c90ba | 1814 | // Send status in template after reset |
f7f98c68 | 1815 | await this.ocppRequestService.requestHandler< |
ef6fa3fb JB |
1816 | StatusNotificationRequest, |
1817 | StatusNotificationResponse | |
08f130a0 | 1818 | >(this, RequestCommand.STATUS_NOTIFICATION, { |
ef6fa3fb JB |
1819 | connectorId, |
1820 | status: this.getConnectorStatus(connectorId).bootStatus, | |
1821 | errorCode: ChargePointErrorCode.NO_ERROR, | |
1822 | }); | |
e7aeea18 JB |
1823 | this.getConnectorStatus(connectorId).status = |
1824 | this.getConnectorStatus(connectorId).bootStatus; | |
452a82ca | 1825 | } else if (this.started === true && this.getConnectorStatus(connectorId)?.status) { |
136c90ba | 1826 | // Send previous status at template reload |
f7f98c68 | 1827 | await this.ocppRequestService.requestHandler< |
ef6fa3fb JB |
1828 | StatusNotificationRequest, |
1829 | StatusNotificationResponse | |
08f130a0 | 1830 | >(this, RequestCommand.STATUS_NOTIFICATION, { |
ef6fa3fb JB |
1831 | connectorId, |
1832 | status: this.getConnectorStatus(connectorId).status, | |
1833 | errorCode: ChargePointErrorCode.NO_ERROR, | |
1834 | }); | |
5ad8570f | 1835 | } else { |
136c90ba | 1836 | // Send default status |
f7f98c68 | 1837 | await this.ocppRequestService.requestHandler< |
ef6fa3fb JB |
1838 | StatusNotificationRequest, |
1839 | StatusNotificationResponse | |
08f130a0 | 1840 | >(this, RequestCommand.STATUS_NOTIFICATION, { |
ef6fa3fb JB |
1841 | connectorId, |
1842 | status: ChargePointStatus.AVAILABLE, | |
1843 | errorCode: ChargePointErrorCode.NO_ERROR, | |
1844 | }); | |
734d790d | 1845 | this.getConnectorStatus(connectorId).status = ChargePointStatus.AVAILABLE; |
5ad8570f JB |
1846 | } |
1847 | } | |
0a60c33c | 1848 | // Start the ATG |
60ddad53 | 1849 | if (this.getAutomaticTransactionGeneratorConfigurationFromTemplate()?.enable === true) { |
4f69be04 | 1850 | this.startAutomaticTransactionGenerator(); |
fa7bccf4 | 1851 | } |
aa428a31 | 1852 | this.wsConnectionRestarted === true && this.flushMessageBuffer(); |
fa7bccf4 JB |
1853 | } |
1854 | ||
e7aeea18 JB |
1855 | private async stopMessageSequence( |
1856 | reason: StopTransactionReason = StopTransactionReason.NONE | |
1857 | ): Promise<void> { | |
136c90ba | 1858 | // Stop WebSocket ping |
c0560973 | 1859 | this.stopWebSocketPing(); |
79411696 | 1860 | // Stop heartbeat |
c0560973 | 1861 | this.stopHeartbeat(); |
fa7bccf4 | 1862 | // Stop ongoing transactions |
b20eb107 | 1863 | if (this.automaticTransactionGenerator?.started === true) { |
60ddad53 JB |
1864 | this.stopAutomaticTransactionGenerator(); |
1865 | } else { | |
1866 | await this.stopRunningTransactions(reason); | |
79411696 JB |
1867 | } |
1868 | } | |
1869 | ||
c0560973 | 1870 | private startWebSocketPing(): void { |
17ac262c JB |
1871 | const webSocketPingInterval: number = ChargingStationConfigurationUtils.getConfigurationKey( |
1872 | this, | |
e7aeea18 JB |
1873 | StandardParametersKey.WebSocketPingInterval |
1874 | ) | |
1875 | ? Utils.convertToInt( | |
17ac262c JB |
1876 | ChargingStationConfigurationUtils.getConfigurationKey( |
1877 | this, | |
1878 | StandardParametersKey.WebSocketPingInterval | |
1879 | ).value | |
e7aeea18 | 1880 | ) |
9cd3dfb0 | 1881 | : 0; |
ad2f27c3 JB |
1882 | if (webSocketPingInterval > 0 && !this.webSocketPingSetInterval) { |
1883 | this.webSocketPingSetInterval = setInterval(() => { | |
d5bff457 | 1884 | if (this.isWebSocketConnectionOpened()) { |
e7aeea18 JB |
1885 | this.wsConnection.ping((): void => { |
1886 | /* This is intentional */ | |
1887 | }); | |
136c90ba JB |
1888 | } |
1889 | }, webSocketPingInterval * 1000); | |
e7aeea18 JB |
1890 | logger.info( |
1891 | this.logPrefix() + | |
1892 | ' WebSocket ping started every ' + | |
1893 | Utils.formatDurationSeconds(webSocketPingInterval) | |
1894 | ); | |
ad2f27c3 | 1895 | } else if (this.webSocketPingSetInterval) { |
e7aeea18 JB |
1896 | logger.info( |
1897 | this.logPrefix() + | |
1898 | ' WebSocket ping every ' + | |
1899 | Utils.formatDurationSeconds(webSocketPingInterval) + | |
1900 | ' already started' | |
1901 | ); | |
136c90ba | 1902 | } else { |
e7aeea18 JB |
1903 | logger.error( |
1904 | `${this.logPrefix()} WebSocket ping interval set to ${ | |
1905 | webSocketPingInterval | |
1906 | ? Utils.formatDurationSeconds(webSocketPingInterval) | |
1907 | : webSocketPingInterval | |
1908 | }, not starting the WebSocket ping` | |
1909 | ); | |
136c90ba JB |
1910 | } |
1911 | } | |
1912 | ||
c0560973 | 1913 | private stopWebSocketPing(): void { |
ad2f27c3 JB |
1914 | if (this.webSocketPingSetInterval) { |
1915 | clearInterval(this.webSocketPingSetInterval); | |
136c90ba JB |
1916 | } |
1917 | } | |
1918 | ||
1f5df42a | 1919 | private getConfiguredSupervisionUrl(): URL { |
e7aeea18 JB |
1920 | const supervisionUrls = Utils.cloneObject<string | string[]>( |
1921 | this.stationInfo.supervisionUrls ?? Configuration.getSupervisionUrls() | |
1922 | ); | |
c0560973 | 1923 | if (!Utils.isEmptyArray(supervisionUrls)) { |
2dcfe98e JB |
1924 | let urlIndex = 0; |
1925 | switch (Configuration.getSupervisionUrlDistribution()) { | |
1926 | case SupervisionUrlDistribution.ROUND_ROBIN: | |
1927 | urlIndex = (this.index - 1) % supervisionUrls.length; | |
1928 | break; | |
1929 | case SupervisionUrlDistribution.RANDOM: | |
1930 | // Get a random url | |
1931 | urlIndex = Math.floor(Utils.secureRandom() * supervisionUrls.length); | |
1932 | break; | |
1933 | case SupervisionUrlDistribution.SEQUENTIAL: | |
1934 | if (this.index <= supervisionUrls.length) { | |
1935 | urlIndex = this.index - 1; | |
1936 | } else { | |
e7aeea18 JB |
1937 | logger.warn( |
1938 | `${this.logPrefix()} No more configured supervision urls available, using the first one` | |
1939 | ); | |
2dcfe98e JB |
1940 | } |
1941 | break; | |
1942 | default: | |
e7aeea18 JB |
1943 | logger.error( |
1944 | `${this.logPrefix()} Unknown supervision url distribution '${Configuration.getSupervisionUrlDistribution()}' from values '${SupervisionUrlDistribution.toString()}', defaulting to ${ | |
1945 | SupervisionUrlDistribution.ROUND_ROBIN | |
1946 | }` | |
1947 | ); | |
2dcfe98e JB |
1948 | urlIndex = (this.index - 1) % supervisionUrls.length; |
1949 | break; | |
c0560973 | 1950 | } |
2dcfe98e | 1951 | return new URL(supervisionUrls[urlIndex]); |
c0560973 | 1952 | } |
57939a9d | 1953 | return new URL(supervisionUrls as string); |
136c90ba JB |
1954 | } |
1955 | ||
6e0964c8 | 1956 | private getHeartbeatInterval(): number | undefined { |
17ac262c JB |
1957 | const HeartbeatInterval = ChargingStationConfigurationUtils.getConfigurationKey( |
1958 | this, | |
1959 | StandardParametersKey.HeartbeatInterval | |
1960 | ); | |
c0560973 JB |
1961 | if (HeartbeatInterval) { |
1962 | return Utils.convertToInt(HeartbeatInterval.value) * 1000; | |
1963 | } | |
17ac262c JB |
1964 | const HeartBeatInterval = ChargingStationConfigurationUtils.getConfigurationKey( |
1965 | this, | |
1966 | StandardParametersKey.HeartBeatInterval | |
1967 | ); | |
c0560973 JB |
1968 | if (HeartBeatInterval) { |
1969 | return Utils.convertToInt(HeartBeatInterval.value) * 1000; | |
0a60c33c | 1970 | } |
7c72977b | 1971 | !this.stationInfo?.autoRegister && |
e7aeea18 JB |
1972 | logger.warn( |
1973 | `${this.logPrefix()} Heartbeat interval configuration key not set, using default value: ${ | |
1974 | Constants.DEFAULT_HEARTBEAT_INTERVAL | |
1975 | }` | |
1976 | ); | |
47e22477 | 1977 | return Constants.DEFAULT_HEARTBEAT_INTERVAL; |
0a60c33c JB |
1978 | } |
1979 | ||
c0560973 | 1980 | private stopHeartbeat(): void { |
ad2f27c3 JB |
1981 | if (this.heartbeatSetInterval) { |
1982 | clearInterval(this.heartbeatSetInterval); | |
7dde0b73 | 1983 | } |
5ad8570f JB |
1984 | } |
1985 | ||
55516218 JB |
1986 | private terminateWSConnection(): void { |
1987 | if (this.isWebSocketConnectionOpened()) { | |
1988 | this.wsConnection.terminate(); | |
1989 | this.wsConnection = null; | |
1990 | } | |
1991 | } | |
1992 | ||
dd119a6b | 1993 | private stopMeterValues(connectorId: number) { |
734d790d JB |
1994 | if (this.getConnectorStatus(connectorId)?.transactionSetInterval) { |
1995 | clearInterval(this.getConnectorStatus(connectorId).transactionSetInterval); | |
dd119a6b JB |
1996 | } |
1997 | } | |
1998 | ||
6e0964c8 | 1999 | private getReconnectExponentialDelay(): boolean | undefined { |
e7aeea18 JB |
2000 | return !Utils.isUndefined(this.stationInfo.reconnectExponentialDelay) |
2001 | ? this.stationInfo.reconnectExponentialDelay | |
2002 | : false; | |
5ad8570f JB |
2003 | } |
2004 | ||
aa428a31 | 2005 | private async reconnect(): Promise<void> { |
7874b0b1 JB |
2006 | // Stop WebSocket ping |
2007 | this.stopWebSocketPing(); | |
136c90ba | 2008 | // Stop heartbeat |
c0560973 | 2009 | this.stopHeartbeat(); |
5ad8570f | 2010 | // Stop the ATG if needed |
6d9876e7 | 2011 | if (this.automaticTransactionGenerator?.configuration?.stopOnConnectionFailure === true) { |
fa7bccf4 | 2012 | this.stopAutomaticTransactionGenerator(); |
ad2f27c3 | 2013 | } |
e7aeea18 JB |
2014 | if ( |
2015 | this.autoReconnectRetryCount < this.getAutoReconnectMaxRetries() || | |
2016 | this.getAutoReconnectMaxRetries() === -1 | |
2017 | ) { | |
ad2f27c3 | 2018 | this.autoReconnectRetryCount++; |
e7aeea18 JB |
2019 | const reconnectDelay = this.getReconnectExponentialDelay() |
2020 | ? Utils.exponentialDelay(this.autoReconnectRetryCount) | |
2021 | : this.getConnectionTimeout() * 1000; | |
1e080116 JB |
2022 | const reconnectDelayWithdraw = 1000; |
2023 | const reconnectTimeout = | |
2024 | reconnectDelay && reconnectDelay - reconnectDelayWithdraw > 0 | |
2025 | ? reconnectDelay - reconnectDelayWithdraw | |
2026 | : 0; | |
e7aeea18 JB |
2027 | logger.error( |
2028 | `${this.logPrefix()} WebSocket: connection retry in ${Utils.roundTo( | |
2029 | reconnectDelay, | |
2030 | 2 | |
2031 | )}ms, timeout ${reconnectTimeout}ms` | |
2032 | ); | |
032d6efc | 2033 | await Utils.sleep(reconnectDelay); |
e7aeea18 JB |
2034 | logger.error( |
2035 | this.logPrefix() + | |
2036 | ' WebSocket: reconnecting try #' + | |
2037 | this.autoReconnectRetryCount.toString() | |
2038 | ); | |
2039 | this.openWSConnection( | |
ccb1d6e9 | 2040 | { ...(this.stationInfo?.wsOptions ?? {}), handshakeTimeout: reconnectTimeout }, |
1e080116 | 2041 | { closeOpened: true } |
e7aeea18 | 2042 | ); |
265e4266 | 2043 | this.wsConnectionRestarted = true; |
c0560973 | 2044 | } else if (this.getAutoReconnectMaxRetries() !== -1) { |
e7aeea18 | 2045 | logger.error( |
71a77ac2 | 2046 | `${this.logPrefix()} WebSocket reconnect failure: maximum retries reached (${ |
e7aeea18 JB |
2047 | this.autoReconnectRetryCount |
2048 | }) or retry disabled (${this.getAutoReconnectMaxRetries()})` | |
2049 | ); | |
5ad8570f JB |
2050 | } |
2051 | } | |
2052 | ||
fa7bccf4 JB |
2053 | private getAutomaticTransactionGeneratorConfigurationFromTemplate(): AutomaticTransactionGeneratorConfiguration | null { |
2054 | return this.getTemplateFromFile()?.AutomaticTransactionGenerator ?? null; | |
2055 | } | |
2056 | ||
a2653482 JB |
2057 | private initializeConnectorStatus(connectorId: number): void { |
2058 | this.getConnectorStatus(connectorId).idTagLocalAuthorized = false; | |
2059 | this.getConnectorStatus(connectorId).idTagAuthorized = false; | |
2060 | this.getConnectorStatus(connectorId).transactionRemoteStarted = false; | |
734d790d JB |
2061 | this.getConnectorStatus(connectorId).transactionStarted = false; |
2062 | this.getConnectorStatus(connectorId).energyActiveImportRegisterValue = 0; | |
2063 | this.getConnectorStatus(connectorId).transactionEnergyActiveImportRegisterValue = 0; | |
0a60c33c | 2064 | } |
7dde0b73 | 2065 | } |