1 // Partial Copyright Jerome Benoit. 2021-2023. All Rights Reserved.
3 import { hoursToMilliseconds
, secondsToMilliseconds
} from
'date-fns'
5 import type { ChargingStation
} from
'./ChargingStation.js'
6 import { checkChargingStation
} from
'./Helpers.js'
7 import { IdTagsCache
} from
'./IdTagsCache.js'
8 import { isIdTagAuthorized
} from
'./ocpp/index.js'
9 import { BaseError
} from
'../exception/index.js'
10 import { PerformanceStatistics
} from
'../performance/index.js'
14 type StartTransactionRequest
,
15 type StartTransactionResponse
,
17 StopTransactionReason
,
18 type StopTransactionResponse
19 } from
'../types/index.js'
24 formatDurationMilliSeconds
,
31 } from
'../utils/index.js'
33 export class AutomaticTransactionGenerator
{
34 private static readonly instances
: Map
<string, AutomaticTransactionGenerator
> = new Map
<
36 AutomaticTransactionGenerator
39 public readonly connectorsStatus
: Map
<number, Status
>
40 public started
: boolean
41 private starting
: boolean
42 private stopping
: boolean
43 private readonly chargingStation
: ChargingStation
45 private constructor (chargingStation
: ChargingStation
) {
49 this.chargingStation
= chargingStation
50 this.connectorsStatus
= new Map
<number, Status
>()
51 this.initializeConnectorsStatus()
54 public static getInstance (
55 chargingStation
: ChargingStation
56 ): AutomaticTransactionGenerator
| undefined {
57 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
58 if (!AutomaticTransactionGenerator
.instances
.has(chargingStation
.stationInfo
!.hashId
)) {
59 AutomaticTransactionGenerator
.instances
.set(
60 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
61 chargingStation
.stationInfo
!.hashId
,
62 new AutomaticTransactionGenerator(chargingStation
)
65 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
66 return AutomaticTransactionGenerator
.instances
.get(chargingStation
.stationInfo
!.hashId
)
69 public start (): void {
70 if (!checkChargingStation(this.chargingStation
, this.logPrefix())) {
74 logger
.warn(`${this.logPrefix()} is already started`)
78 logger
.warn(`${this.logPrefix()} is already starting`)
82 this.startConnectors()
87 public stop (): void {
89 logger
.warn(`${this.logPrefix()} is already stopped`)
93 logger
.warn(`${this.logPrefix()} is already stopping`)
102 public startConnector (connectorId
: number): void {
103 if (!checkChargingStation(this.chargingStation
, this.logPrefix(connectorId
))) {
106 if (!this.connectorsStatus
.has(connectorId
)) {
107 logger
.error(`${this.logPrefix(connectorId)} starting on non existing connector`)
108 throw new BaseError(`Connector ${connectorId} does not exist`)
110 if (this.connectorsStatus
.get(connectorId
)?.start
=== false) {
111 this.internalStartConnector(connectorId
).catch(Constants
.EMPTY_FUNCTION
)
112 } else if (this.connectorsStatus
.get(connectorId
)?.start
=== true) {
113 logger
.warn(`${this.logPrefix(connectorId)} is already started on connector`)
117 public stopConnector (connectorId
: number): void {
118 if (!this.connectorsStatus
.has(connectorId
)) {
119 logger
.error(`${this.logPrefix(connectorId)} stopping on non existing connector`)
120 throw new BaseError(`Connector ${connectorId} does not exist`)
122 if (this.connectorsStatus
.get(connectorId
)?.start
=== true) {
123 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
124 this.connectorsStatus
.get(connectorId
)!.start
= false
125 } else if (this.connectorsStatus
.get(connectorId
)?.start
=== false) {
126 logger
.warn(`${this.logPrefix(connectorId)} is already stopped on connector`)
130 private startConnectors (): void {
132 this.connectorsStatus
.size
> 0 &&
133 this.connectorsStatus
.size
!== this.chargingStation
.getNumberOfConnectors()
135 this.connectorsStatus
.clear()
136 this.initializeConnectorsStatus()
138 if (this.chargingStation
.hasEvses
) {
139 for (const [evseId
, evseStatus
] of this.chargingStation
.evses
) {
141 for (const connectorId
of evseStatus
.connectors
.keys()) {
142 this.startConnector(connectorId
)
147 for (const connectorId
of this.chargingStation
.connectors
.keys()) {
148 if (connectorId
> 0) {
149 this.startConnector(connectorId
)
155 private stopConnectors (): void {
156 if (this.chargingStation
.hasEvses
) {
157 for (const [evseId
, evseStatus
] of this.chargingStation
.evses
) {
159 for (const connectorId
of evseStatus
.connectors
.keys()) {
160 this.stopConnector(connectorId
)
165 for (const connectorId
of this.chargingStation
.connectors
.keys()) {
166 if (connectorId
> 0) {
167 this.stopConnector(connectorId
)
173 private async internalStartConnector (connectorId
: number): Promise
<void> {
174 this.setStartConnectorStatus(connectorId
)
178 )} started on connector and will run for ${formatDurationMilliSeconds(
179 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
180 this.connectorsStatus.get(connectorId)!.stopDate!.getTime() -
181 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
182 this.connectorsStatus.get(connectorId)!.startDate!.getTime()
185 while (this.connectorsStatus
.get(connectorId
)?.start
=== true) {
186 await this.waitChargingStationAvailable(connectorId
)
187 await this.waitConnectorAvailable(connectorId
)
188 if (!this.canStartConnector(connectorId
)) {
189 this.stopConnector(connectorId
)
192 const wait
= secondsToMilliseconds(
194 this.chargingStation
.getAutomaticTransactionGeneratorConfiguration()
195 ?.maxDelayBetweenTwoTransactions
,
196 this.chargingStation
.getAutomaticTransactionGeneratorConfiguration()
197 ?.minDelayBetweenTwoTransactions
200 logger
.info(`${this.logPrefix(connectorId)} waiting for ${formatDurationMilliSeconds(wait)}`)
202 const start
= secureRandom()
205 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
206 this.chargingStation
.getAutomaticTransactionGeneratorConfiguration()!.probabilityOfStart
208 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
209 this.connectorsStatus
.get(connectorId
)!.skippedConsecutiveTransactions
= 0
211 const startResponse
= await this.startTransaction(connectorId
)
212 if (startResponse
?.idTagInfo
.status === AuthorizationStatus
.ACCEPTED
) {
213 // Wait until end of transaction
214 const waitTrxEnd
= secondsToMilliseconds(
216 this.chargingStation
.getAutomaticTransactionGeneratorConfiguration()?.maxDuration
,
217 this.chargingStation
.getAutomaticTransactionGeneratorConfiguration()?.minDuration
223 )} transaction started with id ${this.chargingStation.getConnectorStatus(connectorId)
224 ?.transactionId} and will stop in ${formatDurationMilliSeconds(waitTrxEnd)}`
226 await sleep(waitTrxEnd
)
227 await this.stopTransaction(connectorId
)
230 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
231 ++this.connectorsStatus
.get(connectorId
)!.skippedConsecutiveTransactions
232 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
233 ++this.connectorsStatus
.get(connectorId
)!.skippedTransactions
235 `${this.logPrefix(connectorId)} skipped consecutively ${this.connectorsStatus.get(
237 )?.skippedConsecutiveTransactions}/${this.connectorsStatus.get(connectorId)
238 ?.skippedTransactions} transaction(s)`
241 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
242 this.connectorsStatus
.get(connectorId
)!.lastRunDate
= new Date()
244 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
245 this.connectorsStatus
.get(connectorId
)!.stoppedDate
= new Date()
249 )} stopped on connector and lasted for ${formatDurationMilliSeconds(
250 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
251 this.connectorsStatus.get(connectorId)!.stoppedDate!.getTime() -
252 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
253 this.connectorsStatus.get(connectorId)!.startDate!.getTime()
257 `${this.logPrefix(connectorId)} connector status: %j`,
258 this.connectorsStatus
.get(connectorId
)
262 private setStartConnectorStatus (connectorId
: number): void {
263 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
264 this.connectorsStatus
.get(connectorId
)!.startDate
= new Date()
266 this.chargingStation
.getAutomaticTransactionGeneratorConfiguration()?.stopAbsoluteDuration
===
268 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
269 !isValidTime(this.connectorsStatus
.get(connectorId
)!.stopDate
)
271 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
272 this.connectorsStatus
.get(connectorId
)!.stopDate
= new Date(
273 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
274 this.connectorsStatus
.get(connectorId
)!.startDate
!.getTime() +
276 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
277 this.chargingStation
.getAutomaticTransactionGeneratorConfiguration()!.stopAfterHours
281 delete this.connectorsStatus
.get(connectorId
)?.stoppedDate
282 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
283 this.connectorsStatus
.get(connectorId
)!.skippedConsecutiveTransactions
= 0
284 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
285 this.connectorsStatus
.get(connectorId
)!.start
= true
288 private canStartConnector (connectorId
: number): boolean {
289 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
290 if (new Date() > this.connectorsStatus
.get(connectorId
)!.stopDate
!) {
294 )} entered in transaction loop while the ATG stop date has been reached`
298 if (!this.chargingStation
.inAcceptedState()) {
302 )} entered in transaction loop while the charging station is not in accepted state`
306 if (!this.chargingStation
.isChargingStationAvailable()) {
310 )} entered in transaction loop while the charging station is unavailable`
314 if (!this.chargingStation
.isConnectorAvailable(connectorId
)) {
318 )} entered in transaction loop while the connector ${connectorId} is unavailable`
325 private async waitChargingStationAvailable (connectorId
: number): Promise
<void> {
327 while (!this.chargingStation
.isChargingStationAvailable()) {
332 )} transaction loop waiting for charging station to be available`
336 await sleep(Constants
.CHARGING_STATION_ATG_AVAILABILITY_TIME
)
340 private async waitConnectorAvailable (connectorId
: number): Promise
<void> {
342 while (!this.chargingStation
.isConnectorAvailable(connectorId
)) {
347 )} transaction loop waiting for connector ${connectorId} to be available`
351 await sleep(Constants
.CHARGING_STATION_ATG_AVAILABILITY_TIME
)
355 private initializeConnectorsStatus (): void {
356 if (this.chargingStation
.hasEvses
) {
357 for (const [evseId
, evseStatus
] of this.chargingStation
.evses
) {
359 for (const connectorId
of evseStatus
.connectors
.keys()) {
360 this.connectorsStatus
.set(connectorId
, this.getConnectorStatus(connectorId
))
365 for (const connectorId
of this.chargingStation
.connectors
.keys()) {
366 if (connectorId
> 0) {
367 this.connectorsStatus
.set(connectorId
, this.getConnectorStatus(connectorId
))
373 private getConnectorStatus (connectorId
: number): Status
{
374 const connectorStatus
=
375 this.chargingStation
.getAutomaticTransactionGeneratorStatuses()?.[connectorId
- 1] != null
376 ? cloneObject
<Status
>(
377 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
378 this.chargingStation
.getAutomaticTransactionGeneratorStatuses()![connectorId
- 1]
381 if (connectorStatus
!= null) {
382 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
383 connectorStatus
.startDate
= convertToDate(connectorStatus
.startDate
)!
384 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
385 connectorStatus
.lastRunDate
= convertToDate(connectorStatus
.lastRunDate
)!
386 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
387 connectorStatus
.stopDate
= convertToDate(connectorStatus
.stopDate
)!
388 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
389 connectorStatus
.stoppedDate
= convertToDate(connectorStatus
.stoppedDate
)!
392 (connectorStatus
.start
||
393 this.chargingStation
.getAutomaticTransactionGeneratorConfiguration()?.enable
!== true)
395 connectorStatus
.start
= false
401 authorizeRequests
: 0,
402 acceptedAuthorizeRequests
: 0,
403 rejectedAuthorizeRequests
: 0,
404 startTransactionRequests
: 0,
405 acceptedStartTransactionRequests
: 0,
406 rejectedStartTransactionRequests
: 0,
407 stopTransactionRequests
: 0,
408 acceptedStopTransactionRequests
: 0,
409 rejectedStopTransactionRequests
: 0,
410 skippedConsecutiveTransactions
: 0,
411 skippedTransactions
: 0
416 private async startTransaction (
418 ): Promise
<StartTransactionResponse
| undefined> {
419 const measureId
= 'StartTransaction with ATG'
420 const beginId
= PerformanceStatistics
.beginMeasure(measureId
)
421 let startResponse
: StartTransactionResponse
| undefined
422 if (this.chargingStation
.hasIdTags()) {
423 const idTag
= IdTagsCache
.getInstance().getIdTag(
424 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
425 this.chargingStation
.getAutomaticTransactionGeneratorConfiguration()!.idTagDistribution
!,
426 this.chargingStation
,
429 const startTransactionLogMsg
= `${this.logPrefix(
431 )} start transaction with an idTag '${idTag}'`
432 if (this.getRequireAuthorize()) {
433 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
434 ++this.connectorsStatus
.get(connectorId
)!.authorizeRequests
435 if (await isIdTagAuthorized(this.chargingStation
, connectorId
, idTag
)) {
436 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
437 ++this.connectorsStatus
.get(connectorId
)!.acceptedAuthorizeRequests
438 logger
.info(startTransactionLogMsg
)
440 startResponse
= await this.chargingStation
.ocppRequestService
.requestHandler
<
441 StartTransactionRequest
,
442 StartTransactionResponse
443 >(this.chargingStation
, RequestCommand
.START_TRANSACTION
, {
447 this.handleStartTransactionResponse(connectorId
, startResponse
)
448 PerformanceStatistics
.endMeasure(measureId
, beginId
)
451 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
452 ++this.connectorsStatus
.get(connectorId
)!.rejectedAuthorizeRequests
453 PerformanceStatistics
.endMeasure(measureId
, beginId
)
456 logger
.info(startTransactionLogMsg
)
458 startResponse
= await this.chargingStation
.ocppRequestService
.requestHandler
<
459 StartTransactionRequest
,
460 StartTransactionResponse
461 >(this.chargingStation
, RequestCommand
.START_TRANSACTION
, {
465 this.handleStartTransactionResponse(connectorId
, startResponse
)
466 PerformanceStatistics
.endMeasure(measureId
, beginId
)
469 logger
.info(`${this.logPrefix(connectorId)} start transaction without an idTag`)
470 startResponse
= await this.chargingStation
.ocppRequestService
.requestHandler
<
471 StartTransactionRequest
,
472 StartTransactionResponse
473 >(this.chargingStation
, RequestCommand
.START_TRANSACTION
, { connectorId
})
474 this.handleStartTransactionResponse(connectorId
, startResponse
)
475 PerformanceStatistics
.endMeasure(measureId
, beginId
)
479 private async stopTransaction (
481 reason
= StopTransactionReason
.LOCAL
482 ): Promise
<StopTransactionResponse
| undefined> {
483 const measureId
= 'StopTransaction with ATG'
484 const beginId
= PerformanceStatistics
.beginMeasure(measureId
)
485 let stopResponse
: StopTransactionResponse
| undefined
486 if (this.chargingStation
.getConnectorStatus(connectorId
)?.transactionStarted
=== true) {
490 )} stop transaction with id ${this.chargingStation.getConnectorStatus(connectorId)
493 stopResponse
= await this.chargingStation
.stopTransactionOnConnector(connectorId
, reason
)
494 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
495 ++this.connectorsStatus
.get(connectorId
)!.stopTransactionRequests
496 if (stopResponse
.idTagInfo
?.status === AuthorizationStatus
.ACCEPTED
) {
497 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
498 ++this.connectorsStatus
.get(connectorId
)!.acceptedStopTransactionRequests
500 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
501 ++this.connectorsStatus
.get(connectorId
)!.rejectedStopTransactionRequests
504 const transactionId
= this.chargingStation
.getConnectorStatus(connectorId
)?.transactionId
506 `${this.logPrefix(connectorId)} stopping a not started transaction${
507 transactionId != null ? ` with id ${transactionId}
` : ''
511 PerformanceStatistics
.endMeasure(measureId
, beginId
)
515 private getRequireAuthorize (): boolean {
517 this.chargingStation
.getAutomaticTransactionGeneratorConfiguration()?.requireAuthorize
?? true
521 private readonly logPrefix
= (connectorId
?: number): string => {
523 ` ${this.chargingStation.stationInfo?.chargingStationId} | ATG${
524 connectorId != null ? ` on connector #${connectorId}
` : ''
529 private handleStartTransactionResponse (
531 startResponse
: StartTransactionResponse
533 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
534 ++this.connectorsStatus
.get(connectorId
)!.startTransactionRequests
535 if (startResponse
.idTagInfo
.status === AuthorizationStatus
.ACCEPTED
) {
536 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
537 ++this.connectorsStatus
.get(connectorId
)!.acceptedStartTransactionRequests
539 logger
.warn(`${this.logPrefix(connectorId)} start transaction rejected`)
540 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
541 ++this.connectorsStatus
.get(connectorId
)!.rejectedStartTransactionRequests