1 // Partial Copyright Jerome Benoit. 2021-2024. All Rights Reserved.
3 import type { ValidateFunction
} from
'ajv'
5 import { OCPP20ServiceUtils
} from
'./OCPP20ServiceUtils.js'
6 import { type ChargingStation
, addConfigurationKey
} from
'../../../charging-station/index.js'
7 import { OCPPError
} from
'../../../exception/index.js'
11 type OCPP20BootNotificationResponse
,
12 type OCPP20ClearCacheResponse
,
13 type OCPP20HeartbeatResponse
,
14 OCPP20IncomingRequestCommand
,
15 OCPP20OptionalVariableName
,
17 type OCPP20StatusNotificationResponse
,
19 RegistrationStatusEnumType
,
21 } from
'../../../types/index.js'
22 import { isAsyncFunction
, logger
} from
'../../../utils/index.js'
23 import { OCPPResponseService
} from
'../OCPPResponseService.js'
25 const moduleName
= 'OCPP20ResponseService'
27 export class OCPP20ResponseService
extends OCPPResponseService
{
28 public incomingRequestResponsePayloadValidateFunctions
: Map
<
29 OCPP20IncomingRequestCommand
,
30 ValidateFunction
<JsonType
>
33 protected payloadValidateFunctions
: Map
<OCPP20RequestCommand
, ValidateFunction
<JsonType
>>
34 private readonly responseHandlers
: Map
<OCPP20RequestCommand
, ResponseHandler
>
36 public constructor () {
37 // if (new.target.name === moduleName) {
38 // throw new TypeError(`Cannot construct ${new.target.name} instances directly`)
40 super(OCPPVersion
.VERSION_201
)
41 this.responseHandlers
= new Map
<OCPP20RequestCommand
, ResponseHandler
>([
43 OCPP20RequestCommand
.BOOT_NOTIFICATION
,
44 this.handleResponseBootNotification
.bind(this) as ResponseHandler
46 [OCPP20RequestCommand
.HEARTBEAT
, this.emptyResponseHandler
],
47 [OCPP20RequestCommand
.STATUS_NOTIFICATION
, this.emptyResponseHandler
]
49 this.payloadValidateFunctions
= new Map
<OCPP20RequestCommand
, ValidateFunction
<JsonType
>>([
51 OCPP20RequestCommand
.BOOT_NOTIFICATION
,
54 OCPP20ServiceUtils
.parseJsonSchemaFile
<OCPP20BootNotificationResponse
>(
55 'assets/json-schemas/ocpp/2.0/BootNotificationResponse.json',
63 OCPP20RequestCommand
.HEARTBEAT
,
66 OCPP20ServiceUtils
.parseJsonSchemaFile
<OCPP20HeartbeatResponse
>(
67 'assets/json-schemas/ocpp/2.0/HeartbeatResponse.json',
75 OCPP20RequestCommand
.STATUS_NOTIFICATION
,
78 OCPP20ServiceUtils
.parseJsonSchemaFile
<OCPP20StatusNotificationResponse
>(
79 'assets/json-schemas/ocpp/2.0/StatusNotificationResponse.json',
87 this.incomingRequestResponsePayloadValidateFunctions
= new Map
<
88 OCPP20IncomingRequestCommand
,
89 ValidateFunction
<JsonType
>
92 OCPP20IncomingRequestCommand
.CLEAR_CACHE
,
93 this.ajvIncomingRequest
95 OCPP20ServiceUtils
.parseJsonSchemaFile
<OCPP20ClearCacheResponse
>(
96 'assets/json-schemas/ocpp/2.0/ClearCacheResponse.json',
104 this.validatePayload
= this.validatePayload
.bind(this)
107 public async responseHandler
<ReqType
extends JsonType
, ResType
extends JsonType
>(
108 chargingStation
: ChargingStation
,
109 commandName
: OCPP20RequestCommand
,
111 requestPayload
: ReqType
113 if (chargingStation
.isRegistered() || commandName
=== OCPP20RequestCommand
.BOOT_NOTIFICATION
) {
115 this.responseHandlers
.has(commandName
) &&
116 OCPP20ServiceUtils
.isRequestCommandSupported(chargingStation
, commandName
)
119 this.validatePayload(chargingStation
, commandName
, payload
)
120 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
121 const responseHandler
= this.responseHandlers
.get(commandName
)!
122 if (isAsyncFunction(responseHandler
)) {
123 await responseHandler(chargingStation
, payload
, requestPayload
)
127 chargingStation
: ChargingStation
,
129 requestPayload
?: JsonType
131 )(chargingStation
, payload
, requestPayload
)
135 `${chargingStation.logPrefix()} ${moduleName}.responseHandler: Handle response error:`,
143 ErrorType
.NOT_IMPLEMENTED
,
144 `'${commandName}' is not implemented to handle response PDU ${JSON.stringify(
155 ErrorType
.SECURITY_ERROR
,
156 `${commandName} cannot be issued to handle response PDU ${JSON.stringify(
160 )} while the charging station is not registered on the central server`,
167 private validatePayload (
168 chargingStation
: ChargingStation
,
169 commandName
: OCPP20RequestCommand
,
172 if (this.payloadValidateFunctions
.has(commandName
)) {
173 return this.validateResponsePayload(chargingStation
, commandName
, payload
)
176 `${chargingStation.logPrefix()} ${moduleName}.validatePayload: No JSON schema validation function found for command '${commandName}' PDU validation`
181 private handleResponseBootNotification (
182 chargingStation
: ChargingStation
,
183 payload
: OCPP20BootNotificationResponse
185 if (payload
.status === RegistrationStatusEnumType
.ACCEPTED
) {
188 OCPP20OptionalVariableName
.HeartbeatInterval
,
189 payload
.interval
.toString(),
191 { overwrite
: true, save
: true }
193 OCPP20ServiceUtils
.startHeartbeatInterval(chargingStation
, payload
.interval
)
195 if (Object.values(RegistrationStatusEnumType
).includes(payload
.status)) {
196 const logMsg
= `${chargingStation.logPrefix()} Charging station in '${
198 }' state on the central server`
199 payload
.status === RegistrationStatusEnumType
.REJECTED
200 ? logger
.warn(logMsg
)
201 : logger
.info(logMsg
)
204 `${chargingStation.logPrefix()} Charging station boot notification response received: %j with undefined registration status`,