1 // Partial Copyright Jerome Benoit. 2021-2024. All Rights Reserved.
3 import { createHash
} from
'node:crypto'
4 import { EventEmitter
} from
'node:events'
5 import { type FSWatcher
, existsSync
, mkdirSync
, readFileSync
, rmSync
, writeFileSync
} from
'node:fs'
6 import { dirname
, join
} from
'node:path'
7 import { URL
} from
'node:url'
8 import { parentPort
} from
'node:worker_threads'
10 import { millisecondsToSeconds
, secondsToMilliseconds
} from
'date-fns'
11 import { mergeDeepRight
} from
'rambda'
12 import { type RawData
, WebSocket
} from
'ws'
14 import { AutomaticTransactionGenerator
} from
'./AutomaticTransactionGenerator.js'
15 import { ChargingStationWorkerBroadcastChannel
} from
'./broadcast-channel/ChargingStationWorkerBroadcastChannel.js'
18 deleteConfigurationKey
,
20 setConfigurationKeyValue
21 } from
'./ConfigurationKeyUtils.js'
27 checkConnectorsConfiguration
,
28 checkStationInfoConnectorStatus
,
30 createBootNotificationRequest
,
32 getAmperageLimitationUnitDivider
,
33 getBootConnectorStatus
,
34 getChargingStationConnectorChargingProfilesPowerLimit
,
40 getNumberOfReservableConnectors
,
41 getPhaseRotationValue
,
43 hasReservationExpired
,
44 initializeConnectorsMapStatus
,
45 propagateSerialNumber
,
46 setChargingStationOptions
,
47 stationTemplateToStationInfo
,
48 warnTemplateKeysDeprecation
50 import { IdTagsCache
} from
'./IdTagsCache.js'
52 OCPP16IncomingRequestService
,
54 OCPP16ResponseService
,
55 OCPP20IncomingRequestService
,
57 OCPP20ResponseService
,
58 type OCPPIncomingRequestService
,
59 type OCPPRequestService
,
61 buildTransactionEndMeterValue
,
63 sendAndSetConnectorStatus
64 } from
'./ocpp/index.js'
65 import { SharedLRUCache
} from
'./SharedLRUCache.js'
66 import { BaseError
, OCPPError
} from
'../exception/index.js'
67 import { PerformanceStatistics
} from
'../performance/index.js'
69 type AutomaticTransactionGeneratorConfiguration
,
71 type BootNotificationRequest
,
72 type BootNotificationResponse
,
74 type ChargingStationConfiguration
,
75 ChargingStationEvents
,
76 type ChargingStationInfo
,
77 type ChargingStationOcppConfiguration
,
78 type ChargingStationOptions
,
79 type ChargingStationTemplate
,
87 type EvseStatusConfiguration
,
90 type FirmwareStatusNotificationRequest
,
91 type FirmwareStatusNotificationResponse
,
92 type HeartbeatRequest
,
93 type HeartbeatResponse
,
95 type IncomingRequestCommand
,
98 type MeterValuesRequest
,
99 type MeterValuesResponse
,
101 type OutgoingRequest
,
103 RegistrationStatusEnumType
,
107 ReservationTerminationReason
,
109 StandardParametersKey
,
111 type StopTransactionReason
,
112 type StopTransactionRequest
,
113 type StopTransactionResponse
,
114 SupervisionUrlDistribution
,
115 SupportedFeatureProfiles
,
118 WebSocketCloseEventStatusCode
,
120 } from
'../types/index.js'
129 buildChargingStationAutomaticTransactionGeneratorConfiguration
,
130 buildConnectorsStatus
,
141 formatDurationMilliSeconds
,
142 formatDurationSeconds
,
144 getWebSocketCloseEventStatusString
,
156 } from
'../utils/index.js'
158 export class ChargingStation
extends EventEmitter
{
159 public readonly index
: number
160 public readonly templateFile
: string
161 public stationInfo
?: ChargingStationInfo
162 public started
: boolean
163 public starting
: boolean
164 public idTagsCache
: IdTagsCache
165 public automaticTransactionGenerator
?: AutomaticTransactionGenerator
166 public ocppConfiguration
?: ChargingStationOcppConfiguration
167 public wsConnection
: WebSocket
| null
168 public readonly connectors
: Map
<number, ConnectorStatus
>
169 public readonly evses
: Map
<number, EvseStatus
>
170 public readonly requests
: Map
<string, CachedRequest
>
171 public performanceStatistics
?: PerformanceStatistics
172 public heartbeatSetInterval
?: NodeJS
.Timeout
173 public ocppRequestService
!: OCPPRequestService
174 public bootNotificationRequest
?: BootNotificationRequest
175 public bootNotificationResponse
?: BootNotificationResponse
176 public powerDivider
?: number
177 private stopping
: boolean
178 private configurationFile
!: string
179 private configurationFileHash
!: string
180 private connectorsConfigurationHash
!: string
181 private evsesConfigurationHash
!: string
182 private automaticTransactionGeneratorConfiguration
?: AutomaticTransactionGeneratorConfiguration
183 private ocppIncomingRequestService
!: OCPPIncomingRequestService
184 private readonly messageBuffer
: Set
<string>
185 private configuredSupervisionUrl
!: URL
186 private wsConnectionRetried
: boolean
187 private wsConnectionRetryCount
: number
188 private templateFileWatcher
?: FSWatcher
189 private templateFileHash
!: string
190 private readonly sharedLRUCache
: SharedLRUCache
191 private wsPingSetInterval
?: NodeJS
.Timeout
192 private readonly chargingStationWorkerBroadcastChannel
: ChargingStationWorkerBroadcastChannel
193 private flushMessageBufferSetInterval
?: NodeJS
.Timeout
195 constructor (index
: number, templateFile
: string, options
?: ChargingStationOptions
) {
198 this.starting
= false
199 this.stopping
= false
200 this.wsConnection
= null
201 this.wsConnectionRetried
= false
202 this.wsConnectionRetryCount
= 0
204 this.templateFile
= templateFile
205 this.connectors
= new Map
<number, ConnectorStatus
>()
206 this.evses
= new Map
<number, EvseStatus
>()
207 this.requests
= new Map
<string, CachedRequest
>()
208 this.messageBuffer
= new Set
<string>()
209 this.sharedLRUCache
= SharedLRUCache
.getInstance()
210 this.idTagsCache
= IdTagsCache
.getInstance()
211 this.chargingStationWorkerBroadcastChannel
= new ChargingStationWorkerBroadcastChannel(this)
213 this.on(ChargingStationEvents
.added
, () => {
214 parentPort
?.postMessage(buildAddedMessage(this))
216 this.on(ChargingStationEvents
.deleted
, () => {
217 parentPort
?.postMessage(buildDeletedMessage(this))
219 this.on(ChargingStationEvents
.started
, () => {
220 parentPort
?.postMessage(buildStartedMessage(this))
222 this.on(ChargingStationEvents
.stopped
, () => {
223 parentPort
?.postMessage(buildStoppedMessage(this))
225 this.on(ChargingStationEvents
.updated
, () => {
226 parentPort
?.postMessage(buildUpdatedMessage(this))
228 this.on(ChargingStationEvents
.accepted
, () => {
229 this.startMessageSequence(
230 this.wsConnectionRetried
232 : this.getAutomaticTransactionGeneratorConfiguration()?.stopAbsoluteDuration
234 logger
.error(`${this.logPrefix()} Error while starting the message sequence:`, error
)
236 this.wsConnectionRetried
= false
238 this.on(ChargingStationEvents
.rejected
, () => {
239 this.wsConnectionRetried
= false
241 this.on(ChargingStationEvents
.disconnected
, () => {
243 this.internalStopMessageSequence()
246 `${this.logPrefix()} Error while stopping the internal message sequence:`,
252 this.initialize(options
)
256 if (this.stationInfo
?.autoStart
=== true) {
261 public get
hasEvses (): boolean {
262 return this.connectors
.size
=== 0 && this.evses
.size
> 0
265 public get
wsConnectionUrl (): URL
{
268 this.stationInfo?.supervisionUrlOcppConfiguration === true &&
269 isNotEmptyString(this.stationInfo.supervisionUrlOcppKey) &&
270 isNotEmptyString(getConfigurationKey(this, this.stationInfo.supervisionUrlOcppKey)?.value)
271 ? getConfigurationKey(this, this.stationInfo.supervisionUrlOcppKey)?.value
272 : this.configuredSupervisionUrl.href
273 }/${this.stationInfo?.chargingStationId}`
277 public logPrefix
= (): string => {
279 this instanceof ChargingStation
&&
280 this.stationInfo
!= null &&
281 isNotEmptyString(this.stationInfo
.chargingStationId
)
283 return logPrefix(` ${this.stationInfo.chargingStationId} |`)
285 let stationTemplate
: ChargingStationTemplate
| undefined
287 stationTemplate
= JSON
.parse(
288 readFileSync(this.templateFile
, 'utf8')
289 ) as ChargingStationTemplate
291 stationTemplate
= undefined
293 return logPrefix(` ${getChargingStationId(this.index, stationTemplate)} |`)
296 public hasIdTags (): boolean {
297 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
298 return isNotEmptyArray(this.idTagsCache
.getIdTags(getIdTagsFile(this.stationInfo
!)!))
301 public getNumberOfPhases (stationInfo
?: ChargingStationInfo
): number {
302 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
303 const localStationInfo
= stationInfo
?? this.stationInfo
!
304 switch (this.getCurrentOutType(stationInfo
)) {
306 return localStationInfo
.numberOfPhases
?? 3
312 public isWebSocketConnectionOpened (): boolean {
313 return this.wsConnection
?.readyState
=== WebSocket
.OPEN
316 public inUnknownState (): boolean {
317 return this.bootNotificationResponse
?.status == null
320 public inPendingState (): boolean {
321 return this.bootNotificationResponse
?.status === RegistrationStatusEnumType
.PENDING
324 public inAcceptedState (): boolean {
325 return this.bootNotificationResponse
?.status === RegistrationStatusEnumType
.ACCEPTED
328 public inRejectedState (): boolean {
329 return this.bootNotificationResponse
?.status === RegistrationStatusEnumType
.REJECTED
332 public isRegistered (): boolean {
333 return !this.inUnknownState() && (this.inAcceptedState() || this.inPendingState())
336 public isChargingStationAvailable (): boolean {
337 return this.getConnectorStatus(0)?.availability
=== AvailabilityType
.Operative
340 public hasConnector (connectorId
: number): boolean {
342 for (const evseStatus
of this.evses
.values()) {
343 if (evseStatus
.connectors
.has(connectorId
)) {
349 return this.connectors
.has(connectorId
)
352 public isConnectorAvailable (connectorId
: number): boolean {
355 this.getConnectorStatus(connectorId
)?.availability
=== AvailabilityType
.Operative
359 public getNumberOfConnectors (): number {
361 let numberOfConnectors
= 0
362 for (const [evseId
, evseStatus
] of this.evses
) {
364 numberOfConnectors
+= evseStatus
.connectors
.size
367 return numberOfConnectors
369 return this.connectors
.has(0) ? this.connectors
.size
- 1 : this.connectors
.size
372 public getNumberOfEvses (): number {
373 return this.evses
.has(0) ? this.evses
.size
- 1 : this.evses
.size
376 public getConnectorStatus (connectorId
: number): ConnectorStatus
| undefined {
378 for (const evseStatus
of this.evses
.values()) {
379 if (evseStatus
.connectors
.has(connectorId
)) {
380 return evseStatus
.connectors
.get(connectorId
)
385 return this.connectors
.get(connectorId
)
388 public getConnectorMaximumAvailablePower (connectorId
: number): number {
389 let connectorAmperageLimitationPowerLimit
: number | undefined
390 const amperageLimitation
= this.getAmperageLimitation()
392 amperageLimitation
!= null &&
393 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
394 amperageLimitation
< this.stationInfo
!.maximumAmperage
!
396 connectorAmperageLimitationPowerLimit
=
397 (this.stationInfo
?.currentOutType
=== CurrentType
.AC
398 ? ACElectricUtils
.powerTotal(
399 this.getNumberOfPhases(),
400 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
401 this.stationInfo
.voltageOut
!,
403 (this.hasEvses
? this.getNumberOfEvses() : this.getNumberOfConnectors())
405 : // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
406 DCElectricUtils
.power(this.stationInfo
!.voltageOut
!, amperageLimitation
)) /
407 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
410 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
411 const connectorMaximumPower
= this.stationInfo
!.maximumPower
! / this.powerDivider
!
412 const connectorChargingProfilesPowerLimit
=
413 getChargingStationConnectorChargingProfilesPowerLimit(this, connectorId
)
415 isNaN(connectorMaximumPower
) ? Infinity : connectorMaximumPower
,
416 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
417 isNaN(connectorAmperageLimitationPowerLimit
!)
419 : // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
420 connectorAmperageLimitationPowerLimit
!,
421 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
422 isNaN(connectorChargingProfilesPowerLimit
!) ? Infinity : connectorChargingProfilesPowerLimit
!
426 public getTransactionIdTag (transactionId
: number): string | undefined {
428 for (const evseStatus
of this.evses
.values()) {
429 for (const connectorStatus
of evseStatus
.connectors
.values()) {
430 if (connectorStatus
.transactionId
=== transactionId
) {
431 return connectorStatus
.transactionIdTag
436 for (const connectorId
of this.connectors
.keys()) {
437 if (this.getConnectorStatus(connectorId
)?.transactionId
=== transactionId
) {
438 return this.getConnectorStatus(connectorId
)?.transactionIdTag
444 public getNumberOfRunningTransactions (): number {
445 let numberOfRunningTransactions
= 0
447 for (const [evseId
, evseStatus
] of this.evses
) {
451 for (const connectorStatus
of evseStatus
.connectors
.values()) {
452 if (connectorStatus
.transactionStarted
=== true) {
453 ++numberOfRunningTransactions
458 for (const connectorId
of this.connectors
.keys()) {
459 if (connectorId
> 0 && this.getConnectorStatus(connectorId
)?.transactionStarted
=== true) {
460 ++numberOfRunningTransactions
464 return numberOfRunningTransactions
467 public getConnectorIdByTransactionId (transactionId
: number | undefined): number | undefined {
468 if (transactionId
== null) {
470 } else if (this.hasEvses
) {
471 for (const evseStatus
of this.evses
.values()) {
472 for (const [connectorId
, connectorStatus
] of evseStatus
.connectors
) {
473 if (connectorStatus
.transactionId
=== transactionId
) {
479 for (const connectorId
of this.connectors
.keys()) {
480 if (this.getConnectorStatus(connectorId
)?.transactionId
=== transactionId
) {
487 public getEnergyActiveImportRegisterByTransactionId (
488 transactionId
: number | undefined,
491 return this.getEnergyActiveImportRegister(
492 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
493 this.getConnectorStatus(this.getConnectorIdByTransactionId(transactionId
)!),
498 public getEnergyActiveImportRegisterByConnectorId (connectorId
: number, rounded
= false): number {
499 return this.getEnergyActiveImportRegister(this.getConnectorStatus(connectorId
), rounded
)
502 public getAuthorizeRemoteTxRequests (): boolean {
503 const authorizeRemoteTxRequests
= getConfigurationKey(
505 StandardParametersKey
.AuthorizeRemoteTxRequests
507 return authorizeRemoteTxRequests
!= null
508 ? convertToBoolean(authorizeRemoteTxRequests
.value
)
512 public getLocalAuthListEnabled (): boolean {
513 const localAuthListEnabled
= getConfigurationKey(
515 StandardParametersKey
.LocalAuthListEnabled
517 return localAuthListEnabled
!= null ? convertToBoolean(localAuthListEnabled
.value
) : false
520 public getHeartbeatInterval (): number {
521 const HeartbeatInterval
= getConfigurationKey(this, StandardParametersKey
.HeartbeatInterval
)
522 if (HeartbeatInterval
!= null) {
523 return secondsToMilliseconds(convertToInt(HeartbeatInterval
.value
))
525 const HeartBeatInterval
= getConfigurationKey(this, StandardParametersKey
.HeartBeatInterval
)
526 if (HeartBeatInterval
!= null) {
527 return secondsToMilliseconds(convertToInt(HeartBeatInterval
.value
))
529 this.stationInfo
?.autoRegister
=== false &&
531 `${this.logPrefix()} Heartbeat interval configuration key not set, using default value: ${
532 Constants.DEFAULT_HEARTBEAT_INTERVAL
535 return Constants
.DEFAULT_HEARTBEAT_INTERVAL
538 public setSupervisionUrl (url
: string): void {
540 this.stationInfo
?.supervisionUrlOcppConfiguration
=== true &&
541 isNotEmptyString(this.stationInfo
.supervisionUrlOcppKey
)
543 setConfigurationKeyValue(this, this.stationInfo
.supervisionUrlOcppKey
, url
)
545 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
546 this.stationInfo
!.supervisionUrls
= url
547 this.configuredSupervisionUrl
= this.getConfiguredSupervisionUrl()
548 this.saveStationInfo()
552 public startHeartbeat (): void {
553 if (this.getHeartbeatInterval() > 0 && this.heartbeatSetInterval
== null) {
554 this.heartbeatSetInterval
= setInterval(() => {
555 this.ocppRequestService
556 .requestHandler
<HeartbeatRequest
, HeartbeatResponse
>(this, RequestCommand
.HEARTBEAT
)
559 `${this.logPrefix()} Error while sending '${RequestCommand.HEARTBEAT}':`,
563 }, this.getHeartbeatInterval())
565 `${this.logPrefix()} Heartbeat started every ${formatDurationMilliSeconds(
566 this.getHeartbeatInterval()
569 } else if (this.heartbeatSetInterval
!= null) {
571 `${this.logPrefix()} Heartbeat already started every ${formatDurationMilliSeconds(
572 this.getHeartbeatInterval()
577 `${this.logPrefix()} Heartbeat interval set to ${this.getHeartbeatInterval()}, not starting the heartbeat`
582 public restartHeartbeat (): void {
586 this.startHeartbeat()
589 public restartWebSocketPing (): void {
590 // Stop WebSocket ping
591 this.stopWebSocketPing()
592 // Start WebSocket ping
593 this.startWebSocketPing()
596 public startMeterValues (connectorId
: number, interval
: number): void {
597 if (connectorId
=== 0) {
598 logger
.error(`${this.logPrefix()} Trying to start MeterValues on connector id ${connectorId}`)
601 const connectorStatus
= this.getConnectorStatus(connectorId
)
602 if (connectorStatus
== null) {
604 `${this.logPrefix()} Trying to start MeterValues on non existing connector id
609 if (connectorStatus
.transactionStarted
=== false) {
611 `${this.logPrefix()} Trying to start MeterValues on connector id ${connectorId} with no transaction started`
615 connectorStatus
.transactionStarted
=== true &&
616 connectorStatus
.transactionId
== null
619 `${this.logPrefix()} Trying to start MeterValues on connector id ${connectorId} with no transaction id`
624 connectorStatus
.transactionSetInterval
= setInterval(() => {
625 const meterValue
= buildMeterValue(
628 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
629 connectorStatus
.transactionId
!,
632 this.ocppRequestService
633 .requestHandler
<MeterValuesRequest
, MeterValuesResponse
>(
635 RequestCommand
.METER_VALUES
,
638 transactionId
: connectorStatus
.transactionId
,
639 meterValue
: [meterValue
]
644 `${this.logPrefix()} Error while sending '${RequestCommand.METER_VALUES}':`,
651 `${this.logPrefix()} Charging station ${
652 StandardParametersKey.MeterValueSampleInterval
653 } configuration set to ${interval}, not sending MeterValues`
658 public stopMeterValues (connectorId
: number): void {
659 const connectorStatus
= this.getConnectorStatus(connectorId
)
660 if (connectorStatus
?.transactionSetInterval
!= null) {
661 clearInterval(connectorStatus
.transactionSetInterval
)
665 private add (): void {
666 this.emit(ChargingStationEvents
.added
)
669 public async delete (deleteConfiguration
= true): Promise
<void> {
673 AutomaticTransactionGenerator
.deleteInstance(this)
674 PerformanceStatistics
.deleteInstance(this.stationInfo
?.hashId
)
675 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
676 this.idTagsCache
.deleteIdTags(getIdTagsFile(this.stationInfo
!)!)
677 this.requests
.clear()
678 this.connectors
.clear()
680 this.templateFileWatcher
?.unref()
681 deleteConfiguration
&& rmSync(this.configurationFile
, { force
: true })
682 this.chargingStationWorkerBroadcastChannel
.unref()
683 this.emit(ChargingStationEvents
.deleted
)
684 this.removeAllListeners()
687 public start (): void {
689 if (!this.starting
) {
691 if (this.stationInfo
?.enableStatistics
=== true) {
692 this.performanceStatistics
?.start()
694 this.openWSConnection()
695 // Monitor charging station template file
696 this.templateFileWatcher
= watchJsonFile(
698 FileType
.ChargingStationTemplate
,
701 (event
, filename
): void => {
702 if (isNotEmptyString(filename
) && event
=== 'change') {
705 `${this.logPrefix()} ${FileType.ChargingStationTemplate} ${
707 } file have changed, reload`
709 this.sharedLRUCache
.deleteChargingStationTemplate(this.templateFileHash
)
710 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
711 this.idTagsCache
.deleteIdTags(getIdTagsFile(this.stationInfo
!)!)
715 const ATGStarted
= this.automaticTransactionGenerator
?.started
716 if (ATGStarted
=== true) {
717 this.stopAutomaticTransactionGenerator()
719 delete this.automaticTransactionGeneratorConfiguration
721 this.getAutomaticTransactionGeneratorConfiguration()?.enable
=== true &&
724 this.startAutomaticTransactionGenerator(undefined, true)
726 if (this.stationInfo
?.enableStatistics
=== true) {
727 this.performanceStatistics
?.restart()
729 this.performanceStatistics
?.stop()
731 // FIXME?: restart heartbeat and WebSocket ping when their interval values have changed
734 `${this.logPrefix()} ${FileType.ChargingStationTemplate} file monitoring error:`,
742 this.emit(ChargingStationEvents
.started
)
743 this.starting
= false
745 logger
.warn(`${this.logPrefix()} Charging station is already starting...`)
748 logger
.warn(`${this.logPrefix()} Charging station is already started...`)
753 reason
?: StopTransactionReason
,
754 stopTransactions
= this.stationInfo
?.stopTransactionsOnStopped
757 if (!this.stopping
) {
759 await this.stopMessageSequence(reason
, stopTransactions
)
760 this.closeWSConnection()
761 if (this.stationInfo
?.enableStatistics
=== true) {
762 this.performanceStatistics
?.stop()
764 this.templateFileWatcher
?.close()
765 delete this.bootNotificationResponse
767 this.saveConfiguration()
768 this.sharedLRUCache
.deleteChargingStationConfiguration(this.configurationFileHash
)
769 this.emit(ChargingStationEvents
.stopped
)
770 this.stopping
= false
772 logger
.warn(`${this.logPrefix()} Charging station is already stopping...`)
775 logger
.warn(`${this.logPrefix()} Charging station is already stopped...`)
779 public async reset (reason
?: StopTransactionReason
): Promise
<void> {
780 await this.stop(reason
)
781 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
782 await sleep(this.stationInfo
!.resetTime
!)
787 public saveOcppConfiguration (): void {
788 if (this.stationInfo
?.ocppPersistentConfiguration
=== true) {
789 this.saveConfiguration()
793 public bufferMessage (message
: string): void {
794 this.messageBuffer
.add(message
)
795 this.setIntervalFlushMessageBuffer()
798 public openWSConnection (
800 params
?: { closeOpened
?: boolean, terminateOpened
?: boolean }
803 handshakeTimeout
: secondsToMilliseconds(this.getConnectionTimeout()),
804 ...this.stationInfo
?.wsOptions
,
807 params
= { ...{ closeOpened
: false, terminateOpened
: false }, ...params
}
808 if (!checkChargingStation(this, this.logPrefix())) {
811 if (this.stationInfo
?.supervisionUser
!= null && this.stationInfo
.supervisionPassword
!= null) {
812 options
.auth
= `${this.stationInfo.supervisionUser}:${this.stationInfo.supervisionPassword}`
814 if (params
.closeOpened
=== true) {
815 this.closeWSConnection()
817 if (params
.terminateOpened
=== true) {
818 this.terminateWSConnection()
821 if (this.isWebSocketConnectionOpened()) {
823 `${this.logPrefix()} OCPP connection to URL ${this.wsConnectionUrl.href} is already opened`
828 logger
.info(`${this.logPrefix()} Open OCPP connection to URL ${this.wsConnectionUrl.href}`)
830 this.wsConnection
= new WebSocket(
831 this.wsConnectionUrl
,
832 `ocpp${this.stationInfo?.ocppVersion}`,
836 // Handle WebSocket message
837 this.wsConnection
.on('message', data
=> {
838 this.onMessage(data
).catch(Constants
.EMPTY_FUNCTION
)
840 // Handle WebSocket error
841 this.wsConnection
.on('error', this.onError
.bind(this))
842 // Handle WebSocket close
843 this.wsConnection
.on('close', this.onClose
.bind(this))
844 // Handle WebSocket open
845 this.wsConnection
.on('open', () => {
846 this.onOpen().catch(error
=>
847 logger
.error(`${this.logPrefix()} Error while opening WebSocket connection:`, error
)
850 // Handle WebSocket ping
851 this.wsConnection
.on('ping', this.onPing
.bind(this))
852 // Handle WebSocket pong
853 this.wsConnection
.on('pong', this.onPong
.bind(this))
856 public closeWSConnection (): void {
857 if (this.isWebSocketConnectionOpened()) {
858 this.wsConnection
?.close()
859 this.wsConnection
= null
863 public getAutomaticTransactionGeneratorConfiguration ():
864 | AutomaticTransactionGeneratorConfiguration
866 if (this.automaticTransactionGeneratorConfiguration
== null) {
867 let automaticTransactionGeneratorConfiguration
:
868 | AutomaticTransactionGeneratorConfiguration
870 const stationTemplate
= this.getTemplateFromFile()
871 const stationConfiguration
= this.getConfigurationFromFile()
873 this.stationInfo
?.automaticTransactionGeneratorPersistentConfiguration
=== true &&
874 stationConfiguration
?.stationInfo
?.templateHash
=== stationTemplate
?.templateHash
&&
875 stationConfiguration
?.automaticTransactionGenerator
!= null
877 automaticTransactionGeneratorConfiguration
=
878 stationConfiguration
.automaticTransactionGenerator
880 automaticTransactionGeneratorConfiguration
= stationTemplate
?.AutomaticTransactionGenerator
882 this.automaticTransactionGeneratorConfiguration
= {
883 ...Constants
.DEFAULT_ATG_CONFIGURATION
,
884 ...automaticTransactionGeneratorConfiguration
887 return this.automaticTransactionGeneratorConfiguration
890 public getAutomaticTransactionGeneratorStatuses (): Status
[] | undefined {
891 return this.getConfigurationFromFile()?.automaticTransactionGeneratorStatuses
894 public startAutomaticTransactionGenerator (
895 connectorIds
?: number[],
896 stopAbsoluteDuration
?: boolean
898 this.automaticTransactionGenerator
= AutomaticTransactionGenerator
.getInstance(this)
899 if (isNotEmptyArray(connectorIds
)) {
900 for (const connectorId
of connectorIds
) {
901 this.automaticTransactionGenerator
?.startConnector(connectorId
, stopAbsoluteDuration
)
904 this.automaticTransactionGenerator
?.start(stopAbsoluteDuration
)
906 this.saveAutomaticTransactionGeneratorConfiguration()
907 this.emit(ChargingStationEvents
.updated
)
910 public stopAutomaticTransactionGenerator (connectorIds
?: number[]): void {
911 if (isNotEmptyArray(connectorIds
)) {
912 for (const connectorId
of connectorIds
) {
913 this.automaticTransactionGenerator
?.stopConnector(connectorId
)
916 this.automaticTransactionGenerator
?.stop()
918 this.saveAutomaticTransactionGeneratorConfiguration()
919 this.emit(ChargingStationEvents
.updated
)
922 public async stopTransactionOnConnector (
924 reason
?: StopTransactionReason
925 ): Promise
<StopTransactionResponse
> {
926 const transactionId
= this.getConnectorStatus(connectorId
)?.transactionId
928 this.stationInfo
?.beginEndMeterValues
=== true &&
929 this.stationInfo
.ocppStrictCompliance
=== true &&
930 this.stationInfo
.outOfOrderEndMeterValues
=== false
932 const transactionEndMeterValue
= buildTransactionEndMeterValue(
935 this.getEnergyActiveImportRegisterByTransactionId(transactionId
)
937 await this.ocppRequestService
.requestHandler
<MeterValuesRequest
, MeterValuesResponse
>(
939 RequestCommand
.METER_VALUES
,
943 meterValue
: [transactionEndMeterValue
]
947 return await this.ocppRequestService
.requestHandler
<
948 StopTransactionRequest
,
949 StopTransactionResponse
950 >(this, RequestCommand
.STOP_TRANSACTION
, {
952 meterStop
: this.getEnergyActiveImportRegisterByTransactionId(transactionId
, true),
953 ...(reason
!= null && { reason
})
957 public getReserveConnectorZeroSupported (): boolean {
958 return convertToBoolean(
959 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
960 getConfigurationKey(this, StandardParametersKey
.ReserveConnectorZeroSupported
)!.value
964 public async addReservation (reservation
: Reservation
): Promise
<void> {
965 const reservationFound
= this.getReservationBy('reservationId', reservation
.reservationId
)
966 if (reservationFound
!= null) {
967 await this.removeReservation(reservationFound
, ReservationTerminationReason
.REPLACE_EXISTING
)
969 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
970 this.getConnectorStatus(reservation
.connectorId
)!.reservation
= reservation
971 await sendAndSetConnectorStatus(
973 reservation
.connectorId
,
974 ConnectorStatusEnum
.Reserved
,
976 { send
: reservation
.connectorId
!== 0 }
980 public async removeReservation (
981 reservation
: Reservation
,
982 reason
: ReservationTerminationReason
984 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
985 const connector
= this.getConnectorStatus(reservation
.connectorId
)!
987 case ReservationTerminationReason
.CONNECTOR_STATE_CHANGED
:
988 case ReservationTerminationReason
.TRANSACTION_STARTED
:
989 delete connector
.reservation
991 case ReservationTerminationReason
.RESERVATION_CANCELED
:
992 case ReservationTerminationReason
.REPLACE_EXISTING
:
993 case ReservationTerminationReason
.EXPIRED
:
994 await sendAndSetConnectorStatus(
996 reservation
.connectorId
,
997 ConnectorStatusEnum
.Available
,
999 { send
: reservation
.connectorId
!== 0 }
1001 delete connector
.reservation
1004 // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
1005 throw new BaseError(`Unknown reservation termination reason '${reason}'`)
1009 public getReservationBy (
1010 filterKey
: ReservationKey
,
1011 value
: number | string
1012 ): Reservation
| undefined {
1013 if (this.hasEvses
) {
1014 for (const evseStatus
of this.evses
.values()) {
1015 for (const connectorStatus
of evseStatus
.connectors
.values()) {
1016 if (connectorStatus
.reservation
?.[filterKey
] === value
) {
1017 return connectorStatus
.reservation
1022 for (const connectorStatus
of this.connectors
.values()) {
1023 if (connectorStatus
.reservation
?.[filterKey
] === value
) {
1024 return connectorStatus
.reservation
1030 public isConnectorReservable (
1031 reservationId
: number,
1033 connectorId
?: number
1035 const reservation
= this.getReservationBy('reservationId', reservationId
)
1036 const reservationExists
= reservation
!= null && !hasReservationExpired(reservation
)
1037 if (arguments.length
=== 1) {
1038 return !reservationExists
1039 } else if (arguments.length
> 1) {
1040 const userReservation
= idTag
!= null ? this.getReservationBy('idTag', idTag
) : undefined
1041 const userReservationExists
=
1042 userReservation
!= null && !hasReservationExpired(userReservation
)
1043 const notConnectorZero
= connectorId
== null ? true : connectorId
> 0
1044 const freeConnectorsAvailable
= this.getNumberOfReservableConnectors() > 0
1046 !reservationExists
&& !userReservationExists
&& notConnectorZero
&& freeConnectorsAvailable
1052 private setIntervalFlushMessageBuffer (): void {
1053 if (this.flushMessageBufferSetInterval
== null) {
1054 this.flushMessageBufferSetInterval
= setInterval(() => {
1055 if (this.isWebSocketConnectionOpened() && this.inAcceptedState()) {
1056 this.flushMessageBuffer()
1058 if (this.messageBuffer
.size
=== 0) {
1059 this.clearIntervalFlushMessageBuffer()
1061 }, Constants
.DEFAULT_MESSAGE_BUFFER_FLUSH_INTERVAL
)
1065 private clearIntervalFlushMessageBuffer (): void {
1066 if (this.flushMessageBufferSetInterval
!= null) {
1067 clearInterval(this.flushMessageBufferSetInterval
)
1068 delete this.flushMessageBufferSetInterval
1072 private getNumberOfReservableConnectors (): number {
1073 let numberOfReservableConnectors
= 0
1074 if (this.hasEvses
) {
1075 for (const evseStatus
of this.evses
.values()) {
1076 numberOfReservableConnectors
+= getNumberOfReservableConnectors(evseStatus
.connectors
)
1079 numberOfReservableConnectors
= getNumberOfReservableConnectors(this.connectors
)
1081 return numberOfReservableConnectors
- this.getNumberOfReservationsOnConnectorZero()
1084 private getNumberOfReservationsOnConnectorZero (): number {
1086 (this.hasEvses
&& this.evses
.get(0)?.connectors
.get(0)?.reservation
!= null) ||
1087 (!this.hasEvses
&& this.connectors
.get(0)?.reservation
!= null)
1094 private flushMessageBuffer (): void {
1095 if (this.messageBuffer
.size
> 0) {
1096 for (const message
of this.messageBuffer
.values()) {
1097 let beginId
: string | undefined
1098 let commandName
: RequestCommand
| undefined
1099 const [messageType
] = JSON
.parse(message
) as OutgoingRequest
| Response
| ErrorResponse
1100 const isRequest
= messageType
=== MessageType
.CALL_MESSAGE
1102 [, , commandName
] = JSON
.parse(message
) as OutgoingRequest
1103 beginId
= PerformanceStatistics
.beginMeasure(commandName
)
1105 this.wsConnection
?.send(message
, (error
?: Error) => {
1106 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
1107 isRequest
&& PerformanceStatistics
.endMeasure(commandName
!, beginId
!)
1108 if (error
== null) {
1110 `${this.logPrefix()} >> Buffered ${getMessageTypeString(
1112 )} OCPP message sent '${JSON.stringify(message)}'`
1114 this.messageBuffer
.delete(message
)
1117 `${this.logPrefix()} >> Buffered ${getMessageTypeString(
1119 )} OCPP message '${JSON.stringify(message)}' send failed:`,
1128 private getTemplateFromFile (): ChargingStationTemplate
| undefined {
1129 let template
: ChargingStationTemplate
| undefined
1131 if (this.sharedLRUCache
.hasChargingStationTemplate(this.templateFileHash
)) {
1132 template
= this.sharedLRUCache
.getChargingStationTemplate(this.templateFileHash
)
1134 const measureId
= `${FileType.ChargingStationTemplate} read`
1135 const beginId
= PerformanceStatistics
.beginMeasure(measureId
)
1136 template
= JSON
.parse(readFileSync(this.templateFile
, 'utf8')) as ChargingStationTemplate
1137 PerformanceStatistics
.endMeasure(measureId
, beginId
)
1138 template
.templateHash
= createHash(Constants
.DEFAULT_HASH_ALGORITHM
)
1139 .update(JSON
.stringify(template
))
1141 this.sharedLRUCache
.setChargingStationTemplate(template
)
1142 this.templateFileHash
= template
.templateHash
1145 handleFileException(
1147 FileType
.ChargingStationTemplate
,
1148 error
as NodeJS
.ErrnoException
,
1155 private getStationInfoFromTemplate (): ChargingStationInfo
{
1156 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
1157 const stationTemplate
= this.getTemplateFromFile()!
1158 checkTemplate(stationTemplate
, this.logPrefix(), this.templateFile
)
1159 const warnTemplateKeysDeprecationOnce
= once(warnTemplateKeysDeprecation
, this)
1160 warnTemplateKeysDeprecationOnce(stationTemplate
, this.logPrefix(), this.templateFile
)
1161 if (stationTemplate
.Connectors
!= null) {
1162 checkConnectorsConfiguration(stationTemplate
, this.logPrefix(), this.templateFile
)
1164 const stationInfo
= stationTemplateToStationInfo(stationTemplate
)
1165 stationInfo
.hashId
= getHashId(this.index
, stationTemplate
)
1166 stationInfo
.templateIndex
= this.index
1167 stationInfo
.templateName
= buildTemplateName(this.templateFile
)
1168 stationInfo
.chargingStationId
= getChargingStationId(this.index
, stationTemplate
)
1169 createSerialNumber(stationTemplate
, stationInfo
)
1170 stationInfo
.voltageOut
= this.getVoltageOut(stationInfo
)
1171 if (isNotEmptyArray(stationTemplate
.power
)) {
1172 const powerArrayRandomIndex
= Math.floor(secureRandom() * stationTemplate
.power
.length
)
1173 stationInfo
.maximumPower
=
1174 stationTemplate
.powerUnit
=== PowerUnits
.KILO_WATT
1175 ? stationTemplate
.power
[powerArrayRandomIndex
] * 1000
1176 : stationTemplate
.power
[powerArrayRandomIndex
]
1178 stationInfo
.maximumPower
=
1179 stationTemplate
.powerUnit
=== PowerUnits
.KILO_WATT
1180 ? // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
1181 stationTemplate
.power
! * 1000
1182 : stationTemplate
.power
1184 stationInfo
.maximumAmperage
= this.getMaximumAmperage(stationInfo
)
1186 isNotEmptyString(stationInfo
.firmwareVersionPattern
) &&
1187 isNotEmptyString(stationInfo
.firmwareVersion
) &&
1188 !new RegExp(stationInfo
.firmwareVersionPattern
).test(stationInfo
.firmwareVersion
)
1191 `${this.logPrefix()} Firmware version '${stationInfo.firmwareVersion}' in template file ${
1193 } does not match firmware version pattern '${stationInfo.firmwareVersionPattern}'`
1196 stationInfo
.firmwareUpgrade
= mergeDeepRight(
1203 stationTemplate
.firmwareUpgrade
?? {}
1205 if (stationTemplate
.resetTime
!= null) {
1206 stationInfo
.resetTime
= secondsToMilliseconds(stationTemplate
.resetTime
)
1211 private getStationInfoFromFile (
1212 stationInfoPersistentConfiguration
: boolean | undefined = Constants
.DEFAULT_STATION_INFO
1213 .stationInfoPersistentConfiguration
1214 ): ChargingStationInfo
| undefined {
1215 let stationInfo
: ChargingStationInfo
| undefined
1216 if (stationInfoPersistentConfiguration
=== true) {
1217 stationInfo
= this.getConfigurationFromFile()?.stationInfo
1218 if (stationInfo
!= null) {
1219 delete stationInfo
.infoHash
1220 delete (stationInfo
as ChargingStationTemplate
).numberOfConnectors
1221 // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
1222 if (stationInfo
.templateIndex
== null) {
1223 stationInfo
.templateIndex
= this.index
1225 // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
1226 if (stationInfo
.templateName
== null) {
1227 stationInfo
.templateName
= buildTemplateName(this.templateFile
)
1234 private getStationInfo (options
?: ChargingStationOptions
): ChargingStationInfo
{
1235 const stationInfoFromTemplate
= this.getStationInfoFromTemplate()
1236 options
?.persistentConfiguration
!= null &&
1237 (stationInfoFromTemplate
.stationInfoPersistentConfiguration
= options
.persistentConfiguration
)
1238 const stationInfoFromFile
= this.getStationInfoFromFile(
1239 stationInfoFromTemplate
.stationInfoPersistentConfiguration
1242 // 1. charging station info from template
1243 // 2. charging station info from configuration file
1245 stationInfoFromFile
!= null &&
1246 stationInfoFromFile
.templateHash
=== stationInfoFromTemplate
.templateHash
1248 return setChargingStationOptions(
1249 { ...Constants
.DEFAULT_STATION_INFO
, ...stationInfoFromFile
},
1253 stationInfoFromFile
!= null &&
1254 propagateSerialNumber(
1255 this.getTemplateFromFile(),
1256 stationInfoFromFile
,
1257 stationInfoFromTemplate
1259 return setChargingStationOptions(
1260 { ...Constants
.DEFAULT_STATION_INFO
, ...stationInfoFromTemplate
},
1265 private saveStationInfo (): void {
1266 if (this.stationInfo
?.stationInfoPersistentConfiguration
=== true) {
1267 this.saveConfiguration()
1271 private handleUnsupportedVersion (version
: OCPPVersion
| undefined): void {
1272 const errorMsg
= `Unsupported protocol version '${version}' configured in template file ${this.templateFile}`
1273 logger
.error(`${this.logPrefix()} ${errorMsg}`)
1274 throw new BaseError(errorMsg
)
1277 private initialize (options
?: ChargingStationOptions
): void {
1278 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
1279 const stationTemplate
= this.getTemplateFromFile()!
1280 checkTemplate(stationTemplate
, this.logPrefix(), this.templateFile
)
1281 this.configurationFile
= join(
1282 dirname(this.templateFile
.replace('station-templates', 'configurations')),
1283 `${getHashId(this.index, stationTemplate)}.json`
1285 const stationConfiguration
= this.getConfigurationFromFile()
1287 stationConfiguration
?.stationInfo
?.templateHash
=== stationTemplate
.templateHash
&&
1288 (stationConfiguration
?.connectorsStatus
!= null || stationConfiguration
?.evsesStatus
!= null)
1290 checkConfiguration(stationConfiguration
, this.logPrefix(), this.configurationFile
)
1291 this.initializeConnectorsOrEvsesFromFile(stationConfiguration
)
1293 this.initializeConnectorsOrEvsesFromTemplate(stationTemplate
)
1295 this.stationInfo
= this.getStationInfo(options
)
1297 this.stationInfo
.firmwareStatus
=== FirmwareStatus
.Installing
&&
1298 isNotEmptyString(this.stationInfo
.firmwareVersionPattern
) &&
1299 isNotEmptyString(this.stationInfo
.firmwareVersion
)
1301 const patternGroup
=
1302 this.stationInfo
.firmwareUpgrade
?.versionUpgrade
?.patternGroup
??
1303 this.stationInfo
.firmwareVersion
.split('.').length
1304 const match
= new RegExp(this.stationInfo
.firmwareVersionPattern
)
1305 .exec(this.stationInfo
.firmwareVersion
)
1306 ?.slice(1, patternGroup
+ 1)
1307 if (match
!= null) {
1308 const patchLevelIndex
= match
.length
- 1
1309 match
[patchLevelIndex
] = (
1310 convertToInt(match
[patchLevelIndex
]) +
1311 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
1312 this.stationInfo
.firmwareUpgrade
!.versionUpgrade
!.step
!
1314 this.stationInfo
.firmwareVersion
= match
.join('.')
1317 this.saveStationInfo()
1318 this.configuredSupervisionUrl
= this.getConfiguredSupervisionUrl()
1319 if (this.stationInfo
.enableStatistics
=== true) {
1320 this.performanceStatistics
= PerformanceStatistics
.getInstance(
1321 this.stationInfo
.hashId
,
1322 this.stationInfo
.chargingStationId
,
1323 this.configuredSupervisionUrl
1326 const bootNotificationRequest
= createBootNotificationRequest(this.stationInfo
)
1327 if (bootNotificationRequest
== null) {
1328 const errorMsg
= 'Error while creating boot notification request'
1329 logger
.error(`${this.logPrefix()} ${errorMsg}`)
1330 throw new BaseError(errorMsg
)
1332 this.bootNotificationRequest
= bootNotificationRequest
1333 this.powerDivider
= this.getPowerDivider()
1334 // OCPP configuration
1335 this.ocppConfiguration
= this.getOcppConfiguration(options
?.persistentConfiguration
)
1336 this.initializeOcppConfiguration()
1337 this.initializeOcppServices()
1338 if (this.stationInfo
.autoRegister
=== true) {
1339 this.bootNotificationResponse
= {
1340 currentTime
: new Date(),
1341 interval
: millisecondsToSeconds(this.getHeartbeatInterval()),
1342 status: RegistrationStatusEnumType
.ACCEPTED
1347 private initializeOcppServices (): void {
1348 const ocppVersion
= this.stationInfo
?.ocppVersion
1349 switch (ocppVersion
) {
1350 case OCPPVersion
.VERSION_16
:
1351 this.ocppIncomingRequestService
=
1352 OCPP16IncomingRequestService
.getInstance
<OCPP16IncomingRequestService
>()
1353 this.ocppRequestService
= OCPP16RequestService
.getInstance
<OCPP16RequestService
>(
1354 OCPP16ResponseService
.getInstance
<OCPP16ResponseService
>()
1357 case OCPPVersion
.VERSION_20
:
1358 case OCPPVersion
.VERSION_201
:
1359 this.ocppIncomingRequestService
=
1360 OCPP20IncomingRequestService
.getInstance
<OCPP20IncomingRequestService
>()
1361 this.ocppRequestService
= OCPP20RequestService
.getInstance
<OCPP20RequestService
>(
1362 OCPP20ResponseService
.getInstance
<OCPP20ResponseService
>()
1366 this.handleUnsupportedVersion(ocppVersion
)
1371 private initializeOcppConfiguration (): void {
1372 if (getConfigurationKey(this, StandardParametersKey
.HeartbeatInterval
) == null) {
1373 addConfigurationKey(this, StandardParametersKey
.HeartbeatInterval
, '0')
1375 if (getConfigurationKey(this, StandardParametersKey
.HeartBeatInterval
) == null) {
1376 addConfigurationKey(this, StandardParametersKey
.HeartBeatInterval
, '0', { visible
: false })
1379 this.stationInfo
?.supervisionUrlOcppConfiguration
=== true &&
1380 isNotEmptyString(this.stationInfo
.supervisionUrlOcppKey
) &&
1381 getConfigurationKey(this, this.stationInfo
.supervisionUrlOcppKey
) == null
1383 addConfigurationKey(
1385 this.stationInfo
.supervisionUrlOcppKey
,
1386 this.configuredSupervisionUrl
.href
,
1390 this.stationInfo
?.supervisionUrlOcppConfiguration
=== false &&
1391 isNotEmptyString(this.stationInfo
.supervisionUrlOcppKey
) &&
1392 getConfigurationKey(this, this.stationInfo
.supervisionUrlOcppKey
) != null
1394 deleteConfigurationKey(this, this.stationInfo
.supervisionUrlOcppKey
, { save
: false })
1397 isNotEmptyString(this.stationInfo
?.amperageLimitationOcppKey
) &&
1398 getConfigurationKey(this, this.stationInfo
.amperageLimitationOcppKey
) == null
1400 addConfigurationKey(
1402 this.stationInfo
.amperageLimitationOcppKey
,
1404 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
1405 (this.stationInfo
.maximumAmperage
! * getAmperageLimitationUnitDivider(this.stationInfo
)).toString()
1408 if (getConfigurationKey(this, StandardParametersKey
.SupportedFeatureProfiles
) == null) {
1409 addConfigurationKey(
1411 StandardParametersKey
.SupportedFeatureProfiles
,
1412 `${SupportedFeatureProfiles.Core},${SupportedFeatureProfiles.FirmwareManagement},${SupportedFeatureProfiles.LocalAuthListManagement},${SupportedFeatureProfiles.SmartCharging},${SupportedFeatureProfiles.RemoteTrigger}`
1415 addConfigurationKey(
1417 StandardParametersKey
.NumberOfConnectors
,
1418 this.getNumberOfConnectors().toString(),
1422 if (getConfigurationKey(this, StandardParametersKey
.MeterValuesSampledData
) == null) {
1423 addConfigurationKey(
1425 StandardParametersKey
.MeterValuesSampledData
,
1426 MeterValueMeasurand
.ENERGY_ACTIVE_IMPORT_REGISTER
1429 if (getConfigurationKey(this, StandardParametersKey
.ConnectorPhaseRotation
) == null) {
1430 const connectorsPhaseRotation
: string[] = []
1431 if (this.hasEvses
) {
1432 for (const evseStatus
of this.evses
.values()) {
1433 for (const connectorId
of evseStatus
.connectors
.keys()) {
1434 connectorsPhaseRotation
.push(
1435 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
1436 getPhaseRotationValue(connectorId
, this.getNumberOfPhases())!
1441 for (const connectorId
of this.connectors
.keys()) {
1442 connectorsPhaseRotation
.push(
1443 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
1444 getPhaseRotationValue(connectorId
, this.getNumberOfPhases())!
1448 addConfigurationKey(
1450 StandardParametersKey
.ConnectorPhaseRotation
,
1451 connectorsPhaseRotation
.toString()
1454 if (getConfigurationKey(this, StandardParametersKey
.AuthorizeRemoteTxRequests
) == null) {
1455 addConfigurationKey(this, StandardParametersKey
.AuthorizeRemoteTxRequests
, 'true')
1458 getConfigurationKey(this, StandardParametersKey
.LocalAuthListEnabled
) == null &&
1459 hasFeatureProfile(this, SupportedFeatureProfiles
.LocalAuthListManagement
) === true
1461 addConfigurationKey(this, StandardParametersKey
.LocalAuthListEnabled
, 'false')
1463 if (getConfigurationKey(this, StandardParametersKey
.ConnectionTimeOut
) == null) {
1464 addConfigurationKey(
1466 StandardParametersKey
.ConnectionTimeOut
,
1467 Constants
.DEFAULT_CONNECTION_TIMEOUT
.toString()
1470 this.saveOcppConfiguration()
1473 private initializeConnectorsOrEvsesFromFile (configuration
: ChargingStationConfiguration
): void {
1474 if (configuration
.connectorsStatus
!= null && configuration
.evsesStatus
== null) {
1475 for (const [connectorId
, connectorStatus
] of configuration
.connectorsStatus
.entries()) {
1476 this.connectors
.set(connectorId
, clone
<ConnectorStatus
>(connectorStatus
))
1478 } else if (configuration
.evsesStatus
!= null && configuration
.connectorsStatus
== null) {
1479 for (const [evseId
, evseStatusConfiguration
] of configuration
.evsesStatus
.entries()) {
1480 const evseStatus
= clone
<EvseStatusConfiguration
>(evseStatusConfiguration
)
1481 delete evseStatus
.connectorsStatus
1482 this.evses
.set(evseId
, {
1483 ...(evseStatus
as EvseStatus
),
1484 connectors
: new Map
<number, ConnectorStatus
>(
1485 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
1486 evseStatusConfiguration
.connectorsStatus
!.map((connectorStatus
, connectorId
) => [
1493 } else if (configuration
.evsesStatus
!= null && configuration
.connectorsStatus
!= null) {
1494 const errorMsg
= `Connectors and evses defined at the same time in configuration file ${this.configurationFile}`
1495 logger
.error(`${this.logPrefix()} ${errorMsg}`)
1496 throw new BaseError(errorMsg
)
1498 const errorMsg
= `No connectors or evses defined in configuration file ${this.configurationFile}`
1499 logger
.error(`${this.logPrefix()} ${errorMsg}`)
1500 throw new BaseError(errorMsg
)
1504 private initializeConnectorsOrEvsesFromTemplate (stationTemplate
: ChargingStationTemplate
): void {
1505 if (stationTemplate
.Connectors
!= null && stationTemplate
.Evses
== null) {
1506 this.initializeConnectorsFromTemplate(stationTemplate
)
1507 } else if (stationTemplate
.Evses
!= null && stationTemplate
.Connectors
== null) {
1508 this.initializeEvsesFromTemplate(stationTemplate
)
1509 } else if (stationTemplate
.Evses
!= null && stationTemplate
.Connectors
!= null) {
1510 const errorMsg
= `Connectors and evses defined at the same time in template file ${this.templateFile}`
1511 logger
.error(`${this.logPrefix()} ${errorMsg}`)
1512 throw new BaseError(errorMsg
)
1514 const errorMsg
= `No connectors or evses defined in template file ${this.templateFile}`
1515 logger
.error(`${this.logPrefix()} ${errorMsg}`)
1516 throw new BaseError(errorMsg
)
1520 private initializeConnectorsFromTemplate (stationTemplate
: ChargingStationTemplate
): void {
1521 if (stationTemplate
.Connectors
== null && this.connectors
.size
=== 0) {
1522 const errorMsg
= `No already defined connectors and charging station information from template ${this.templateFile} with no connectors configuration defined`
1523 logger
.error(`${this.logPrefix()} ${errorMsg}`)
1524 throw new BaseError(errorMsg
)
1526 if (stationTemplate
.Connectors
?.[0] == null) {
1528 `${this.logPrefix()} Charging station information from template ${
1530 } with no connector id 0 configuration`
1533 if (stationTemplate
.Connectors
!= null) {
1534 const { configuredMaxConnectors
, templateMaxConnectors
, templateMaxAvailableConnectors
} =
1535 checkConnectorsConfiguration(stationTemplate
, this.logPrefix(), this.templateFile
)
1536 const connectorsConfigHash
= createHash(Constants
.DEFAULT_HASH_ALGORITHM
)
1538 `${JSON.stringify(stationTemplate.Connectors)}${configuredMaxConnectors.toString()}`
1541 const connectorsConfigChanged
=
1542 this.connectors
.size
!== 0 && this.connectorsConfigurationHash
!== connectorsConfigHash
1543 if (this.connectors
.size
=== 0 || connectorsConfigChanged
) {
1544 connectorsConfigChanged
&& this.connectors
.clear()
1545 this.connectorsConfigurationHash
= connectorsConfigHash
1546 if (templateMaxConnectors
> 0) {
1547 for (let connectorId
= 0; connectorId
<= configuredMaxConnectors
; connectorId
++) {
1549 connectorId
=== 0 &&
1550 // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
1551 (stationTemplate
.Connectors
[connectorId
] == null ||
1552 !this.getUseConnectorId0(stationTemplate
))
1556 const templateConnectorId
=
1557 connectorId
> 0 && stationTemplate
.randomConnectors
=== true
1558 ? getRandomInteger(templateMaxAvailableConnectors
, 1)
1560 const connectorStatus
= stationTemplate
.Connectors
[templateConnectorId
]
1561 checkStationInfoConnectorStatus(
1562 templateConnectorId
,
1567 this.connectors
.set(connectorId
, clone
<ConnectorStatus
>(connectorStatus
))
1569 initializeConnectorsMapStatus(this.connectors
, this.logPrefix())
1570 this.saveConnectorsStatus()
1573 `${this.logPrefix()} Charging station information from template ${
1575 } with no connectors configuration defined, cannot create connectors`
1581 `${this.logPrefix()} Charging station information from template ${
1583 } with no connectors configuration defined, using already defined connectors`
1588 private initializeEvsesFromTemplate (stationTemplate
: ChargingStationTemplate
): void {
1589 if (stationTemplate
.Evses
== null && this.evses
.size
=== 0) {
1590 const errorMsg
= `No already defined evses and charging station information from template ${this.templateFile} with no evses configuration defined`
1591 logger
.error(`${this.logPrefix()} ${errorMsg}`)
1592 throw new BaseError(errorMsg
)
1594 if (stationTemplate
.Evses
?.[0] == null) {
1596 `${this.logPrefix()} Charging station information from template ${
1598 } with no evse id 0 configuration`
1601 if (stationTemplate
.Evses
?.[0]?.Connectors
[0] == null) {
1603 `${this.logPrefix()} Charging station information from template ${
1605 } with evse id 0 with no connector id 0 configuration`
1608 if (Object.keys(stationTemplate
.Evses
?.[0]?.Connectors
as object
).length
> 1) {
1610 `${this.logPrefix()} Charging station information from template ${
1612 } with evse id 0 with more than one connector configuration, only connector id 0 configuration will be used`
1615 if (stationTemplate
.Evses
!= null) {
1616 const evsesConfigHash
= createHash(Constants
.DEFAULT_HASH_ALGORITHM
)
1617 .update(JSON
.stringify(stationTemplate
.Evses
))
1619 const evsesConfigChanged
=
1620 this.evses
.size
!== 0 && this.evsesConfigurationHash
!== evsesConfigHash
1621 if (this.evses
.size
=== 0 || evsesConfigChanged
) {
1622 evsesConfigChanged
&& this.evses
.clear()
1623 this.evsesConfigurationHash
= evsesConfigHash
1624 const templateMaxEvses
= getMaxNumberOfEvses(stationTemplate
.Evses
)
1625 if (templateMaxEvses
> 0) {
1626 for (const evseKey
in stationTemplate
.Evses
) {
1627 const evseId
= convertToInt(evseKey
)
1628 this.evses
.set(evseId
, {
1629 connectors
: buildConnectorsMap(
1630 stationTemplate
.Evses
[evseKey
].Connectors
,
1634 availability
: AvailabilityType
.Operative
1636 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
1637 initializeConnectorsMapStatus(this.evses
.get(evseId
)!.connectors
, this.logPrefix())
1639 this.saveEvsesStatus()
1642 `${this.logPrefix()} Charging station information from template ${
1644 } with no evses configuration defined, cannot create evses`
1650 `${this.logPrefix()} Charging station information from template ${
1652 } with no evses configuration defined, using already defined evses`
1657 private getConfigurationFromFile (): ChargingStationConfiguration
| undefined {
1658 let configuration
: ChargingStationConfiguration
| undefined
1659 if (isNotEmptyString(this.configurationFile
) && existsSync(this.configurationFile
)) {
1661 if (this.sharedLRUCache
.hasChargingStationConfiguration(this.configurationFileHash
)) {
1662 configuration
= this.sharedLRUCache
.getChargingStationConfiguration(
1663 this.configurationFileHash
1666 const measureId
= `${FileType.ChargingStationConfiguration} read`
1667 const beginId
= PerformanceStatistics
.beginMeasure(measureId
)
1668 configuration
= JSON
.parse(
1669 readFileSync(this.configurationFile
, 'utf8')
1670 ) as ChargingStationConfiguration
1671 PerformanceStatistics
.endMeasure(measureId
, beginId
)
1672 this.sharedLRUCache
.setChargingStationConfiguration(configuration
)
1673 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
1674 this.configurationFileHash
= configuration
.configurationHash
!
1677 handleFileException(
1678 this.configurationFile
,
1679 FileType
.ChargingStationConfiguration
,
1680 error
as NodeJS
.ErrnoException
,
1685 return configuration
1688 private saveAutomaticTransactionGeneratorConfiguration (): void {
1689 if (this.stationInfo
?.automaticTransactionGeneratorPersistentConfiguration
=== true) {
1690 this.saveConfiguration()
1694 private saveConnectorsStatus (): void {
1695 this.saveConfiguration()
1698 private saveEvsesStatus (): void {
1699 this.saveConfiguration()
1702 private saveConfiguration (): void {
1703 if (isNotEmptyString(this.configurationFile
)) {
1705 if (!existsSync(dirname(this.configurationFile
))) {
1706 mkdirSync(dirname(this.configurationFile
), { recursive
: true })
1708 const configurationFromFile
= this.getConfigurationFromFile()
1709 let configurationData
: ChargingStationConfiguration
=
1710 configurationFromFile
!= null
1711 ? clone
<ChargingStationConfiguration
>(configurationFromFile
)
1713 if (this.stationInfo
?.stationInfoPersistentConfiguration
=== true) {
1714 configurationData
.stationInfo
= this.stationInfo
1716 delete configurationData
.stationInfo
1719 this.stationInfo
?.ocppPersistentConfiguration
=== true &&
1720 Array.isArray(this.ocppConfiguration
?.configurationKey
)
1722 configurationData
.configurationKey
= this.ocppConfiguration
.configurationKey
1724 delete configurationData
.configurationKey
1726 configurationData
= mergeDeepRight(
1728 buildChargingStationAutomaticTransactionGeneratorConfiguration(this)
1730 if (this.stationInfo
?.automaticTransactionGeneratorPersistentConfiguration
!== true) {
1731 delete configurationData
.automaticTransactionGenerator
1733 if (this.connectors
.size
> 0) {
1734 configurationData
.connectorsStatus
= buildConnectorsStatus(this)
1736 delete configurationData
.connectorsStatus
1738 if (this.evses
.size
> 0) {
1739 configurationData
.evsesStatus
= buildEvsesStatus(this)
1741 delete configurationData
.evsesStatus
1743 delete configurationData
.configurationHash
1744 const configurationHash
= createHash(Constants
.DEFAULT_HASH_ALGORITHM
)
1747 stationInfo
: configurationData
.stationInfo
,
1748 configurationKey
: configurationData
.configurationKey
,
1749 automaticTransactionGenerator
: configurationData
.automaticTransactionGenerator
,
1750 ...(this.connectors
.size
> 0 && {
1751 connectorsStatus
: configurationData
.connectorsStatus
1753 ...(this.evses
.size
> 0 && { evsesStatus
: configurationData
.evsesStatus
})
1754 } satisfies ChargingStationConfiguration
)
1757 if (this.configurationFileHash
!== configurationHash
) {
1758 AsyncLock
.runExclusive(AsyncLockType
.configuration
, () => {
1759 configurationData
.configurationHash
= configurationHash
1760 const measureId
= `${FileType.ChargingStationConfiguration} write`
1761 const beginId
= PerformanceStatistics
.beginMeasure(measureId
)
1763 this.configurationFile
,
1764 JSON
.stringify(configurationData
, undefined, 2),
1767 PerformanceStatistics
.endMeasure(measureId
, beginId
)
1768 this.sharedLRUCache
.deleteChargingStationConfiguration(this.configurationFileHash
)
1769 this.sharedLRUCache
.setChargingStationConfiguration(configurationData
)
1770 this.configurationFileHash
= configurationHash
1772 handleFileException(
1773 this.configurationFile
,
1774 FileType
.ChargingStationConfiguration
,
1775 error
as NodeJS
.ErrnoException
,
1781 `${this.logPrefix()} Not saving unchanged charging station configuration file ${
1782 this.configurationFile
1787 handleFileException(
1788 this.configurationFile
,
1789 FileType
.ChargingStationConfiguration
,
1790 error
as NodeJS
.ErrnoException
,
1796 `${this.logPrefix()} Trying to save charging station configuration to undefined configuration file`
1801 private getOcppConfigurationFromTemplate (): ChargingStationOcppConfiguration
| undefined {
1802 return this.getTemplateFromFile()?.Configuration
1805 private getOcppConfigurationFromFile (
1806 ocppPersistentConfiguration
?: boolean
1807 ): ChargingStationOcppConfiguration
| undefined {
1808 const configurationKey
= this.getConfigurationFromFile()?.configurationKey
1809 if (ocppPersistentConfiguration
=== true && Array.isArray(configurationKey
)) {
1810 return { configurationKey
}
1815 private getOcppConfiguration (
1816 ocppPersistentConfiguration
: boolean | undefined = this.stationInfo
?.ocppPersistentConfiguration
1817 ): ChargingStationOcppConfiguration
| undefined {
1818 let ocppConfiguration
: ChargingStationOcppConfiguration
| undefined =
1819 this.getOcppConfigurationFromFile(ocppPersistentConfiguration
)
1820 if (ocppConfiguration
== null) {
1821 ocppConfiguration
= this.getOcppConfigurationFromTemplate()
1823 return ocppConfiguration
1826 private async onOpen (): Promise
<void> {
1827 if (this.isWebSocketConnectionOpened()) {
1828 this.emit(ChargingStationEvents
.updated
)
1830 `${this.logPrefix()} Connection to OCPP server through ${this.wsConnectionUrl.href} succeeded`
1832 let registrationRetryCount
= 0
1833 if (!this.isRegistered()) {
1834 // Send BootNotification
1836 this.bootNotificationResponse
= await this.ocppRequestService
.requestHandler
<
1837 BootNotificationRequest
,
1838 BootNotificationResponse
1839 >(this, RequestCommand
.BOOT_NOTIFICATION
, this.bootNotificationRequest
, {
1840 skipBufferingOnError
: true
1842 // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
1843 if (this.bootNotificationResponse
?.currentTime
!= null) {
1844 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
1845 this.bootNotificationResponse
.currentTime
= convertToDate(
1846 this.bootNotificationResponse
.currentTime
1849 if (!this.isRegistered()) {
1850 this.stationInfo
?.registrationMaxRetries
!== -1 && ++registrationRetryCount
1852 // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
1853 this.bootNotificationResponse
?.interval
!= null
1854 ? secondsToMilliseconds(this.bootNotificationResponse
.interval
)
1855 : Constants
.DEFAULT_BOOT_NOTIFICATION_INTERVAL
1859 !this.isRegistered() &&
1860 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
1861 (registrationRetryCount
<= this.stationInfo
!.registrationMaxRetries
! ||
1862 this.stationInfo
?.registrationMaxRetries
=== -1)
1865 if (this.isRegistered()) {
1866 this.emit(ChargingStationEvents
.registered
)
1867 if (this.inAcceptedState()) {
1868 this.emit(ChargingStationEvents
.accepted
)
1871 if (this.inRejectedState()) {
1872 this.emit(ChargingStationEvents
.rejected
)
1875 `${this.logPrefix()} Registration failure: maximum retries reached (${registrationRetryCount}) or retry disabled (${
1876 this.stationInfo?.registrationMaxRetries
1880 this.wsConnectionRetryCount
= 0
1881 this.emit(ChargingStationEvents
.updated
)
1884 `${this.logPrefix()} Connection to OCPP server through ${this.wsConnectionUrl.href} failed`
1889 private onClose (code
: WebSocketCloseEventStatusCode
, reason
: Buffer
): void {
1890 this.emit(ChargingStationEvents
.disconnected
)
1891 this.emit(ChargingStationEvents
.updated
)
1894 case WebSocketCloseEventStatusCode
.CLOSE_NORMAL
:
1895 case WebSocketCloseEventStatusCode
.CLOSE_NO_STATUS
:
1897 `${this.logPrefix()} WebSocket normally closed with status '${getWebSocketCloseEventStatusString(
1899 )}' and reason '${reason.toString()}'`
1901 this.wsConnectionRetryCount
= 0
1906 `${this.logPrefix()} WebSocket abnormally closed with status '${getWebSocketCloseEventStatusString(
1908 )}' and reason '${reason.toString()}'`
1913 this.emit(ChargingStationEvents
.updated
)
1915 .catch(error
=> logger
.error(`${this.logPrefix()} Error while reconnecting:`, error
))
1920 private getCachedRequest (
1921 messageType
: MessageType
| undefined,
1923 ): CachedRequest
| undefined {
1924 const cachedRequest
= this.requests
.get(messageId
)
1925 if (Array.isArray(cachedRequest
)) {
1926 return cachedRequest
1928 throw new OCPPError(
1929 ErrorType
.PROTOCOL_ERROR
,
1930 `Cached request for message id ${messageId} ${getMessageTypeString(
1932 )} is not an array`,
1938 private async handleIncomingMessage (request
: IncomingRequest
): Promise
<void> {
1939 const [messageType
, messageId
, commandName
, commandPayload
] = request
1940 if (this.stationInfo
?.enableStatistics
=== true) {
1941 this.performanceStatistics
?.addRequestStatistic(commandName
, messageType
)
1944 `${this.logPrefix()} << Command '${commandName}' received request payload: ${JSON.stringify(
1948 // Process the message
1949 await this.ocppIncomingRequestService
.incomingRequestHandler(
1955 this.emit(ChargingStationEvents
.updated
)
1958 private handleResponseMessage (response
: Response
): void {
1959 const [messageType
, messageId
, commandPayload
] = response
1960 if (!this.requests
.has(messageId
)) {
1962 throw new OCPPError(
1963 ErrorType
.INTERNAL_ERROR
,
1964 `Response for unknown message id ${messageId}`,
1970 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
1971 const [responseCallback
, , requestCommandName
, requestPayload
] = this.getCachedRequest(
1976 `${this.logPrefix()} << Command '${requestCommandName}' received response payload: ${JSON.stringify(
1980 responseCallback(commandPayload
, requestPayload
)
1983 private handleErrorMessage (errorResponse
: ErrorResponse
): void {
1984 const [messageType
, messageId
, errorType
, errorMessage
, errorDetails
] = errorResponse
1985 if (!this.requests
.has(messageId
)) {
1987 throw new OCPPError(
1988 ErrorType
.INTERNAL_ERROR
,
1989 `Error response for unknown message id ${messageId}`,
1991 { errorType
, errorMessage
, errorDetails
}
1994 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
1995 const [, errorCallback
, requestCommandName
] = this.getCachedRequest(messageType
, messageId
)!
1997 `${this.logPrefix()} << Command '${requestCommandName}' received error response payload: ${JSON.stringify(
2001 errorCallback(new OCPPError(errorType
, errorMessage
, requestCommandName
, errorDetails
))
2004 private async onMessage (data
: RawData
): Promise
<void> {
2005 let request
: IncomingRequest
| Response
| ErrorResponse
| undefined
2006 let messageType
: MessageType
| undefined
2007 let errorMsg
: string
2009 // eslint-disable-next-line @typescript-eslint/no-base-to-string
2010 request
= JSON
.parse(data
.toString()) as IncomingRequest
| Response
| ErrorResponse
2011 if (Array.isArray(request
)) {
2012 [messageType
] = request
2013 // Check the type of message
2014 switch (messageType
) {
2016 case MessageType
.CALL_MESSAGE
:
2017 await this.handleIncomingMessage(request
as IncomingRequest
)
2020 case MessageType
.CALL_RESULT_MESSAGE
:
2021 this.handleResponseMessage(request
as Response
)
2024 case MessageType
.CALL_ERROR_MESSAGE
:
2025 this.handleErrorMessage(request
as ErrorResponse
)
2029 // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
2030 errorMsg
= `Wrong message type ${messageType}`
2031 logger
.error(`${this.logPrefix()} ${errorMsg}`)
2032 throw new OCPPError(ErrorType
.PROTOCOL_ERROR
, errorMsg
)
2035 throw new OCPPError(
2036 ErrorType
.PROTOCOL_ERROR
,
2037 'Incoming message is not an array',
2045 if (!Array.isArray(request
)) {
2046 logger
.error(`${this.logPrefix()} Incoming message '${request}' parsing error:`, error
)
2049 let commandName
: IncomingRequestCommand
| undefined
2050 let requestCommandName
: RequestCommand
| IncomingRequestCommand
| undefined
2051 let errorCallback
: ErrorCallback
2052 const [, messageId
] = request
2053 switch (messageType
) {
2054 case MessageType
.CALL_MESSAGE
:
2055 [, , commandName
] = request
as IncomingRequest
2057 await this.ocppRequestService
.sendError(this, messageId
, error
as OCPPError
, commandName
)
2059 case MessageType
.CALL_RESULT_MESSAGE
:
2060 case MessageType
.CALL_ERROR_MESSAGE
:
2061 if (this.requests
.has(messageId
)) {
2062 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
2063 [, errorCallback
, requestCommandName
] = this.getCachedRequest(messageType
, messageId
)!
2064 // Reject the deferred promise in case of error at response handling (rejecting an already fulfilled promise is a no-op)
2065 errorCallback(error
as OCPPError
, false)
2067 // Remove the request from the cache in case of error at response handling
2068 this.requests
.delete(messageId
)
2072 if (!(error
instanceof OCPPError
)) {
2074 `${this.logPrefix()} Error thrown at incoming OCPP command '${
2075 commandName ?? requestCommandName ?? Constants.UNKNOWN_OCPP_COMMAND
2076 // eslint-disable-next-line @typescript-eslint/no-base-to-string
2077 }' message '${data.toString()}' handling is not an OCPPError:`,
2082 `${this.logPrefix()} Incoming OCPP command '${
2083 commandName ?? requestCommandName ?? Constants.UNKNOWN_OCPP_COMMAND
2084 // eslint-disable-next-line @typescript-eslint/no-base-to-string
2085 }' message '${data.toString()}'${
2086 this.requests.has(messageId)
2087 ? ` matching cached request
'${JSON.stringify(this.getCachedRequest(messageType, messageId))}'`
2089 } processing error:`,
2095 private onPing (): void {
2096 logger
.debug(`${this.logPrefix()} Received a WS ping (rfc6455) from the server`)
2099 private onPong (): void {
2100 logger
.debug(`${this.logPrefix()} Received a WS pong (rfc6455) from the server`)
2103 private onError (error
: WSError
): void {
2104 this.closeWSConnection()
2105 logger
.error(`${this.logPrefix()} WebSocket error:`, error
)
2108 private getEnergyActiveImportRegister (
2109 connectorStatus
: ConnectorStatus
| undefined,
2112 if (this.stationInfo
?.meteringPerTransaction
=== true) {
2115 ? connectorStatus
?.transactionEnergyActiveImportRegisterValue
!= null
2116 ? Math.round(connectorStatus
.transactionEnergyActiveImportRegisterValue
)
2118 : connectorStatus
?.transactionEnergyActiveImportRegisterValue
) ?? 0
2123 ? connectorStatus
?.energyActiveImportRegisterValue
!= null
2124 ? Math.round(connectorStatus
.energyActiveImportRegisterValue
)
2126 : connectorStatus
?.energyActiveImportRegisterValue
) ?? 0
2130 private getUseConnectorId0 (stationTemplate
?: ChargingStationTemplate
): boolean {
2131 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
2132 return stationTemplate
?.useConnectorId0
?? Constants
.DEFAULT_STATION_INFO
.useConnectorId0
!
2135 private async stopRunningTransactions (reason
?: StopTransactionReason
): Promise
<void> {
2136 if (this.hasEvses
) {
2137 for (const [evseId
, evseStatus
] of this.evses
) {
2141 for (const [connectorId
, connectorStatus
] of evseStatus
.connectors
) {
2142 if (connectorStatus
.transactionStarted
=== true) {
2143 await this.stopTransactionOnConnector(connectorId
, reason
)
2148 for (const connectorId
of this.connectors
.keys()) {
2149 if (connectorId
> 0 && this.getConnectorStatus(connectorId
)?.transactionStarted
=== true) {
2150 await this.stopTransactionOnConnector(connectorId
, reason
)
2157 private getConnectionTimeout (): number {
2158 if (getConfigurationKey(this, StandardParametersKey
.ConnectionTimeOut
) != null) {
2159 return convertToInt(
2160 getConfigurationKey(this, StandardParametersKey
.ConnectionTimeOut
)?.value
??
2161 Constants
.DEFAULT_CONNECTION_TIMEOUT
2164 return Constants
.DEFAULT_CONNECTION_TIMEOUT
2167 private getPowerDivider (): number {
2168 let powerDivider
= this.hasEvses
? this.getNumberOfEvses() : this.getNumberOfConnectors()
2169 if (this.stationInfo
?.powerSharedByConnectors
=== true) {
2170 powerDivider
= this.getNumberOfRunningTransactions()
2175 private getMaximumAmperage (stationInfo
?: ChargingStationInfo
): number | undefined {
2176 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
2177 const maximumPower
= (stationInfo
?? this.stationInfo
!).maximumPower
!
2178 switch (this.getCurrentOutType(stationInfo
)) {
2179 case CurrentType
.AC
:
2180 return ACElectricUtils
.amperagePerPhaseFromPower(
2181 this.getNumberOfPhases(stationInfo
),
2182 maximumPower
/ (this.hasEvses
? this.getNumberOfEvses() : this.getNumberOfConnectors()),
2183 this.getVoltageOut(stationInfo
)
2185 case CurrentType
.DC
:
2186 return DCElectricUtils
.amperage(maximumPower
, this.getVoltageOut(stationInfo
))
2190 private getCurrentOutType (stationInfo
?: ChargingStationInfo
): CurrentType
{
2192 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
2193 (stationInfo
?? this.stationInfo
!).currentOutType
??
2194 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
2195 Constants
.DEFAULT_STATION_INFO
.currentOutType
!
2199 private getVoltageOut (stationInfo
?: ChargingStationInfo
): Voltage
{
2201 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
2202 (stationInfo
?? this.stationInfo
!).voltageOut
??
2203 getDefaultVoltageOut(this.getCurrentOutType(stationInfo
), this.logPrefix(), this.templateFile
)
2207 private getAmperageLimitation (): number | undefined {
2209 isNotEmptyString(this.stationInfo
?.amperageLimitationOcppKey
) &&
2210 getConfigurationKey(this, this.stationInfo
.amperageLimitationOcppKey
) != null
2213 convertToInt(getConfigurationKey(this, this.stationInfo
.amperageLimitationOcppKey
)?.value
) /
2214 getAmperageLimitationUnitDivider(this.stationInfo
)
2219 private async startMessageSequence (ATGStopAbsoluteDuration
?: boolean): Promise
<void> {
2220 if (this.stationInfo
?.autoRegister
=== true) {
2221 await this.ocppRequestService
.requestHandler
<
2222 BootNotificationRequest
,
2223 BootNotificationResponse
2224 >(this, RequestCommand
.BOOT_NOTIFICATION
, this.bootNotificationRequest
, {
2225 skipBufferingOnError
: true
2228 // Start WebSocket ping
2229 this.startWebSocketPing()
2231 this.startHeartbeat()
2232 // Initialize connectors status
2233 if (this.hasEvses
) {
2234 for (const [evseId
, evseStatus
] of this.evses
) {
2236 for (const [connectorId
, connectorStatus
] of evseStatus
.connectors
) {
2237 const connectorBootStatus
= getBootConnectorStatus(this, connectorId
, connectorStatus
)
2238 await sendAndSetConnectorStatus(this, connectorId
, connectorBootStatus
, evseId
)
2243 for (const connectorId
of this.connectors
.keys()) {
2244 if (connectorId
> 0) {
2245 const connectorBootStatus
= getBootConnectorStatus(
2248 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
2249 this.getConnectorStatus(connectorId
)!
2251 await sendAndSetConnectorStatus(this, connectorId
, connectorBootStatus
)
2255 if (this.stationInfo
?.firmwareStatus
=== FirmwareStatus
.Installing
) {
2256 await this.ocppRequestService
.requestHandler
<
2257 FirmwareStatusNotificationRequest
,
2258 FirmwareStatusNotificationResponse
2259 >(this, RequestCommand
.FIRMWARE_STATUS_NOTIFICATION
, {
2260 status: FirmwareStatus
.Installed
2262 this.stationInfo
.firmwareStatus
= FirmwareStatus
.Installed
2266 if (this.getAutomaticTransactionGeneratorConfiguration()?.enable
=== true) {
2267 this.startAutomaticTransactionGenerator(undefined, ATGStopAbsoluteDuration
)
2269 this.flushMessageBuffer()
2272 private internalStopMessageSequence (): void {
2273 // Stop WebSocket ping
2274 this.stopWebSocketPing()
2276 this.stopHeartbeat()
2278 if (this.automaticTransactionGenerator
?.started
=== true) {
2279 this.stopAutomaticTransactionGenerator()
2283 private async stopMessageSequence (
2284 reason
?: StopTransactionReason
,
2285 stopTransactions
?: boolean
2287 this.internalStopMessageSequence()
2288 // Stop ongoing transactions
2289 stopTransactions
=== true && (await this.stopRunningTransactions(reason
))
2290 if (this.hasEvses
) {
2291 for (const [evseId
, evseStatus
] of this.evses
) {
2293 for (const [connectorId
, connectorStatus
] of evseStatus
.connectors
) {
2294 await sendAndSetConnectorStatus(
2297 ConnectorStatusEnum
.Unavailable
,
2300 delete connectorStatus
.status
2305 for (const connectorId
of this.connectors
.keys()) {
2306 if (connectorId
> 0) {
2307 await sendAndSetConnectorStatus(this, connectorId
, ConnectorStatusEnum
.Unavailable
)
2308 delete this.getConnectorStatus(connectorId
)?.status
2314 private startWebSocketPing (): void {
2315 const webSocketPingInterval
=
2316 getConfigurationKey(this, StandardParametersKey
.WebSocketPingInterval
) != null
2318 getConfigurationKey(this, StandardParametersKey
.WebSocketPingInterval
)?.value
2321 if (webSocketPingInterval
> 0 && this.wsPingSetInterval
== null) {
2322 this.wsPingSetInterval
= setInterval(() => {
2323 if (this.isWebSocketConnectionOpened()) {
2324 this.wsConnection
?.ping()
2326 }, secondsToMilliseconds(webSocketPingInterval
))
2328 `${this.logPrefix()} WebSocket ping started every ${formatDurationSeconds(
2329 webSocketPingInterval
2332 } else if (this.wsPingSetInterval
!= null) {
2334 `${this.logPrefix()} WebSocket ping already started every ${formatDurationSeconds(
2335 webSocketPingInterval
2340 `${this.logPrefix()} WebSocket ping interval set to ${webSocketPingInterval}, not starting the WebSocket ping`
2345 private stopWebSocketPing (): void {
2346 if (this.wsPingSetInterval
!= null) {
2347 clearInterval(this.wsPingSetInterval
)
2348 delete this.wsPingSetInterval
2352 private getConfiguredSupervisionUrl (): URL
{
2353 let configuredSupervisionUrl
: string
2354 const supervisionUrls
= this.stationInfo
?.supervisionUrls
?? Configuration
.getSupervisionUrls()
2355 if (isNotEmptyArray(supervisionUrls
)) {
2356 let configuredSupervisionUrlIndex
: number
2357 switch (Configuration
.getSupervisionUrlDistribution()) {
2358 case SupervisionUrlDistribution
.RANDOM
:
2359 configuredSupervisionUrlIndex
= Math.floor(secureRandom() * supervisionUrls
.length
)
2361 case SupervisionUrlDistribution
.ROUND_ROBIN
:
2362 case SupervisionUrlDistribution
.CHARGING_STATION_AFFINITY
:
2364 !Object.values(SupervisionUrlDistribution
).includes(
2365 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
2366 Configuration
.getSupervisionUrlDistribution()!
2369 // eslint-disable-next-line @typescript-eslint/no-base-to-string
2370 `${this.logPrefix()} Unknown supervision url distribution '${Configuration.getSupervisionUrlDistribution()}' from values '${SupervisionUrlDistribution.toString()}', defaulting to ${
2371 SupervisionUrlDistribution.CHARGING_STATION_AFFINITY
2374 configuredSupervisionUrlIndex
= (this.index
- 1) % supervisionUrls
.length
2377 configuredSupervisionUrl
= supervisionUrls
[configuredSupervisionUrlIndex
]
2379 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
2380 configuredSupervisionUrl
= supervisionUrls
!
2382 if (isNotEmptyString(configuredSupervisionUrl
)) {
2383 return new URL(configuredSupervisionUrl
)
2385 const errorMsg
= 'No supervision url(s) configured'
2386 logger
.error(`${this.logPrefix()} ${errorMsg}`)
2387 throw new BaseError(errorMsg
)
2390 private stopHeartbeat (): void {
2391 if (this.heartbeatSetInterval
!= null) {
2392 clearInterval(this.heartbeatSetInterval
)
2393 delete this.heartbeatSetInterval
2397 private terminateWSConnection (): void {
2398 if (this.isWebSocketConnectionOpened()) {
2399 this.wsConnection
?.terminate()
2400 this.wsConnection
= null
2404 private async reconnect (): Promise
<void> {
2406 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
2407 this.wsConnectionRetryCount
< this.stationInfo
!.autoReconnectMaxRetries
! ||
2408 this.stationInfo
?.autoReconnectMaxRetries
=== -1
2410 this.wsConnectionRetried
= true
2411 ++this.wsConnectionRetryCount
2412 const reconnectDelay
=
2413 this.stationInfo
?.reconnectExponentialDelay
=== true
2414 ? exponentialDelay(this.wsConnectionRetryCount
)
2415 : secondsToMilliseconds(this.getConnectionTimeout())
2416 const reconnectDelayWithdraw
= 1000
2417 const reconnectTimeout
=
2418 reconnectDelay
- reconnectDelayWithdraw
> 0 ? reconnectDelay
- reconnectDelayWithdraw
: 0
2420 `${this.logPrefix()} WebSocket connection retry in ${roundTo(
2423 )}ms, timeout ${reconnectTimeout}ms`
2425 await sleep(reconnectDelay
)
2427 `${this.logPrefix()} WebSocket connection retry #${this.wsConnectionRetryCount.toString()}`
2429 this.openWSConnection(
2431 handshakeTimeout
: reconnectTimeout
2433 { closeOpened
: true }
2435 } else if (this.stationInfo
?.autoReconnectMaxRetries
!== -1) {
2437 `${this.logPrefix()} WebSocket connection retries failure: maximum retries reached (${
2438 this.wsConnectionRetryCount
2439 }) or retries disabled (${this.stationInfo?.autoReconnectMaxRetries})`