1 import { secondsToMilliseconds
} from
'date-fns'
3 import { WorkerBroadcastChannel
} from
'./WorkerBroadcastChannel.js'
4 import { BaseError
, type OCPPError
} from
'../../exception/index.js'
8 type AuthorizeResponse
,
9 type BootNotificationRequest
,
10 type BootNotificationResponse
,
11 BroadcastChannelProcedureName
,
12 type BroadcastChannelRequest
,
13 type BroadcastChannelRequestPayload
,
14 type BroadcastChannelResponsePayload
,
15 type DataTransferRequest
,
16 type DataTransferResponse
,
18 type DiagnosticsStatusNotificationRequest
,
19 type DiagnosticsStatusNotificationResponse
,
21 type FirmwareStatusNotificationRequest
,
22 type FirmwareStatusNotificationResponse
,
23 type HeartbeatRequest
,
24 type HeartbeatResponse
,
26 type MeterValuesRequest
,
27 type MeterValuesResponse
,
28 RegistrationStatusEnumType
,
32 StandardParametersKey
,
33 type StartTransactionRequest
,
34 type StartTransactionResponse
,
35 type StatusNotificationRequest
,
36 type StatusNotificationResponse
,
37 type StopTransactionRequest
,
38 type StopTransactionResponse
39 } from
'../../types/index.js'
40 import { Constants
, convertToInt
, isEmptyObject
, logger
} from
'../../utils/index.js'
41 import type { ChargingStation
} from
'../ChargingStation.js'
42 import { getConfigurationKey
} from
'../ConfigurationKeyUtils.js'
43 import { buildMeterValue
} from
'../ocpp/index.js'
45 const moduleName
= 'ChargingStationWorkerBroadcastChannel'
47 type CommandResponse
=
49 | StartTransactionResponse
50 | StopTransactionResponse
52 | BootNotificationResponse
54 | DataTransferResponse
56 type CommandHandler
= (
57 requestPayload
?: BroadcastChannelRequestPayload
58 // eslint-disable-next-line @typescript-eslint/no-invalid-void-type
59 ) => Promise
<CommandResponse
| void> | void
61 export class ChargingStationWorkerBroadcastChannel
extends WorkerBroadcastChannel
{
62 private readonly commandHandlers
: Map
<BroadcastChannelProcedureName
, CommandHandler
>
63 private readonly chargingStation
: ChargingStation
65 constructor (chargingStation
: ChargingStation
) {
67 const requestParams
: RequestParams
= {
70 this.commandHandlers
= new Map
<BroadcastChannelProcedureName
, CommandHandler
>([
72 BroadcastChannelProcedureName
.START_CHARGING_STATION
,
74 this.chargingStation
.start()
78 BroadcastChannelProcedureName
.STOP_CHARGING_STATION
,
80 await this.chargingStation
.stop()
84 BroadcastChannelProcedureName
.OPEN_CONNECTION
,
86 this.chargingStation
.openWSConnection()
90 BroadcastChannelProcedureName
.CLOSE_CONNECTION
,
92 this.chargingStation
.closeWSConnection()
96 BroadcastChannelProcedureName
.START_AUTOMATIC_TRANSACTION_GENERATOR
,
97 (requestPayload
?: BroadcastChannelRequestPayload
) => {
98 this.chargingStation
.startAutomaticTransactionGenerator(requestPayload
?.connectorIds
)
102 BroadcastChannelProcedureName
.STOP_AUTOMATIC_TRANSACTION_GENERATOR
,
103 (requestPayload
?: BroadcastChannelRequestPayload
) => {
104 this.chargingStation
.stopAutomaticTransactionGenerator(requestPayload
?.connectorIds
)
108 BroadcastChannelProcedureName
.SET_SUPERVISION_URL
,
109 (requestPayload
?: BroadcastChannelRequestPayload
) => {
110 this.chargingStation
.setSupervisionUrl(requestPayload
?.url
as string)
114 BroadcastChannelProcedureName
.START_TRANSACTION
,
115 async (requestPayload
?: BroadcastChannelRequestPayload
) =>
116 await this.chargingStation
.ocppRequestService
.requestHandler
<
117 StartTransactionRequest
,
118 StartTransactionResponse
119 >(this.chargingStation
, RequestCommand
.START_TRANSACTION
, requestPayload
, requestParams
)
122 BroadcastChannelProcedureName
.STOP_TRANSACTION
,
123 async (requestPayload
?: BroadcastChannelRequestPayload
) =>
124 await this.chargingStation
.ocppRequestService
.requestHandler
<
125 StopTransactionRequest
,
126 StartTransactionResponse
128 this.chargingStation
,
129 RequestCommand
.STOP_TRANSACTION
,
131 meterStop
: this.chargingStation
.getEnergyActiveImportRegisterByTransactionId(
132 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
133 requestPayload
!.transactionId
!,
142 BroadcastChannelProcedureName
.AUTHORIZE
,
143 async (requestPayload
?: BroadcastChannelRequestPayload
) =>
144 await this.chargingStation
.ocppRequestService
.requestHandler
<
147 >(this.chargingStation
, RequestCommand
.AUTHORIZE
, requestPayload
, requestParams
)
150 BroadcastChannelProcedureName
.BOOT_NOTIFICATION
,
151 async (requestPayload
?: BroadcastChannelRequestPayload
) => {
152 this.chargingStation
.bootNotificationResponse
=
153 await this.chargingStation
.ocppRequestService
.requestHandler
<
154 BootNotificationRequest
,
155 BootNotificationResponse
157 this.chargingStation
,
158 RequestCommand
.BOOT_NOTIFICATION
,
160 ...this.chargingStation
.bootNotificationRequest
,
164 skipBufferingOnError
: true,
168 return this.chargingStation
.bootNotificationResponse
172 BroadcastChannelProcedureName
.STATUS_NOTIFICATION
,
173 async (requestPayload
?: BroadcastChannelRequestPayload
) =>
174 await this.chargingStation
.ocppRequestService
.requestHandler
<
175 StatusNotificationRequest
,
176 StatusNotificationResponse
178 this.chargingStation
,
179 RequestCommand
.STATUS_NOTIFICATION
,
185 BroadcastChannelProcedureName
.HEARTBEAT
,
186 async (requestPayload
?: BroadcastChannelRequestPayload
) =>
187 await this.chargingStation
.ocppRequestService
.requestHandler
<
190 >(this.chargingStation
, RequestCommand
.HEARTBEAT
, requestPayload
, requestParams
)
193 BroadcastChannelProcedureName
.METER_VALUES
,
194 async (requestPayload
?: BroadcastChannelRequestPayload
) => {
195 const configuredMeterValueSampleInterval
= getConfigurationKey(
197 StandardParametersKey
.MeterValueSampleInterval
199 return await this.chargingStation
.ocppRequestService
.requestHandler
<
203 this.chargingStation
,
204 RequestCommand
.METER_VALUES
,
208 this.chargingStation
,
209 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
210 requestPayload
!.connectorId
!,
211 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
212 this.chargingStation
.getConnectorStatus(requestPayload
!.connectorId
!)!
214 configuredMeterValueSampleInterval
!= null
215 ? secondsToMilliseconds(convertToInt(configuredMeterValueSampleInterval
.value
))
216 : Constants
.DEFAULT_METER_VALUES_INTERVAL
226 BroadcastChannelProcedureName
.DATA_TRANSFER
,
227 async (requestPayload
?: BroadcastChannelRequestPayload
) =>
228 await this.chargingStation
.ocppRequestService
.requestHandler
<
231 >(this.chargingStation
, RequestCommand
.DATA_TRANSFER
, requestPayload
, requestParams
)
234 BroadcastChannelProcedureName
.DIAGNOSTICS_STATUS_NOTIFICATION
,
235 async (requestPayload
?: BroadcastChannelRequestPayload
) =>
236 await this.chargingStation
.ocppRequestService
.requestHandler
<
237 DiagnosticsStatusNotificationRequest
,
238 DiagnosticsStatusNotificationResponse
240 this.chargingStation
,
241 RequestCommand
.DIAGNOSTICS_STATUS_NOTIFICATION
,
247 BroadcastChannelProcedureName
.FIRMWARE_STATUS_NOTIFICATION
,
248 async (requestPayload
?: BroadcastChannelRequestPayload
) =>
249 await this.chargingStation
.ocppRequestService
.requestHandler
<
250 FirmwareStatusNotificationRequest
,
251 FirmwareStatusNotificationResponse
253 this.chargingStation
,
254 RequestCommand
.FIRMWARE_STATUS_NOTIFICATION
,
260 this.chargingStation
= chargingStation
261 this.onmessage
= this.requestHandler
.bind(this) as (message
: unknown
) => void
262 this.onmessageerror
= this.messageErrorHandler
.bind(this) as (message
: unknown
) => void
265 private async requestHandler (messageEvent
: MessageEvent
): Promise
<void> {
266 const validatedMessageEvent
= this.validateMessageEvent(messageEvent
)
267 if (validatedMessageEvent
=== false) {
270 if (this.isResponse(validatedMessageEvent
.data
)) {
273 const [uuid
, command
, requestPayload
] = validatedMessageEvent
.data
as BroadcastChannelRequest
275 requestPayload
.hashIds
!= null &&
276 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
277 !requestPayload
.hashIds
.includes(this.chargingStation
.stationInfo
!.hashId
)
281 if (requestPayload
.hashId
!= null) {
283 `${this.chargingStation.logPrefix()} ${moduleName}.requestHandler: 'hashId' field usage in PDU is deprecated, use 'hashIds' array instead`
287 let responsePayload
: BroadcastChannelResponsePayload
| undefined
288 // eslint-disable-next-line @typescript-eslint/no-invalid-void-type
289 let commandResponse
: CommandResponse
| void
291 commandResponse
= await this.commandHandler(command
, requestPayload
)
292 if (commandResponse
== null || isEmptyObject(commandResponse
)) {
294 hashId
: this.chargingStation
.stationInfo
?.hashId
,
295 status: ResponseStatus
.SUCCESS
298 responsePayload
= this.commandResponseToResponsePayload(
306 `${this.chargingStation.logPrefix()} ${moduleName}.requestHandler: Handle request error:`,
310 hashId
: this.chargingStation
.stationInfo
?.hashId
,
311 status: ResponseStatus
.FAILURE
,
314 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
315 commandResponse
: commandResponse
!,
316 errorMessage
: (error
as OCPPError
).message
,
317 errorStack
: (error
as OCPPError
).stack
,
318 errorDetails
: (error
as OCPPError
).details
321 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
322 this.sendResponse([uuid
, responsePayload
!])
326 private messageErrorHandler (messageEvent
: MessageEvent
): void {
328 `${this.chargingStation.logPrefix()} ${moduleName}.messageErrorHandler: Error at handling message:`,
333 private async commandHandler (
334 command
: BroadcastChannelProcedureName
,
335 requestPayload
: BroadcastChannelRequestPayload
336 // eslint-disable-next-line @typescript-eslint/no-invalid-void-type
337 ): Promise
<CommandResponse
| void> {
338 if (this.commandHandlers
.has(command
)) {
339 this.cleanRequestPayload(command
, requestPayload
)
340 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
341 return await this.commandHandlers
.get(command
)!(requestPayload
)
343 throw new BaseError(`Unknown worker broadcast channel command: '${command}'`)
346 private cleanRequestPayload (
347 command
: BroadcastChannelProcedureName
,
348 requestPayload
: BroadcastChannelRequestPayload
350 delete requestPayload
.hashId
351 delete requestPayload
.hashIds
353 BroadcastChannelProcedureName
.START_AUTOMATIC_TRANSACTION_GENERATOR
,
354 BroadcastChannelProcedureName
.STOP_AUTOMATIC_TRANSACTION_GENERATOR
355 ].includes(command
) && delete requestPayload
.connectorIds
358 private commandResponseToResponsePayload (
359 command
: BroadcastChannelProcedureName
,
360 requestPayload
: BroadcastChannelRequestPayload
,
361 commandResponse
: CommandResponse
362 ): BroadcastChannelResponsePayload
{
363 const responseStatus
= this.commandResponseToResponseStatus(command
, commandResponse
)
364 if (responseStatus
=== ResponseStatus
.SUCCESS
) {
366 hashId
: this.chargingStation
.stationInfo
?.hashId
,
367 status: responseStatus
371 hashId
: this.chargingStation
.stationInfo
?.hashId
,
372 status: responseStatus
,
379 private commandResponseToResponseStatus (
380 command
: BroadcastChannelProcedureName
,
381 commandResponse
: CommandResponse
384 case BroadcastChannelProcedureName
.START_TRANSACTION
:
385 case BroadcastChannelProcedureName
.STOP_TRANSACTION
:
386 case BroadcastChannelProcedureName
.AUTHORIZE
:
390 | StartTransactionResponse
391 | StopTransactionResponse
393 ).idTagInfo
?.status === AuthorizationStatus
.ACCEPTED
395 return ResponseStatus
.SUCCESS
397 return ResponseStatus
.FAILURE
398 case BroadcastChannelProcedureName
.BOOT_NOTIFICATION
:
399 if (commandResponse
.status === RegistrationStatusEnumType
.ACCEPTED
) {
400 return ResponseStatus
.SUCCESS
402 return ResponseStatus
.FAILURE
403 case BroadcastChannelProcedureName
.DATA_TRANSFER
:
404 if (commandResponse
.status === DataTransferStatus
.ACCEPTED
) {
405 return ResponseStatus
.SUCCESS
407 return ResponseStatus
.FAILURE
408 case BroadcastChannelProcedureName
.STATUS_NOTIFICATION
:
409 case BroadcastChannelProcedureName
.METER_VALUES
:
410 if (isEmptyObject(commandResponse
)) {
411 return ResponseStatus
.SUCCESS
413 return ResponseStatus
.FAILURE
414 case BroadcastChannelProcedureName
.HEARTBEAT
:
415 if ('currentTime' in commandResponse
) {
416 return ResponseStatus
.SUCCESS
418 return ResponseStatus
.FAILURE
420 return ResponseStatus
.FAILURE