1 // Partial Copyright Jerome Benoit. 2021-2023. All Rights Reserved.
3 import type { JSONSchemaType
} from
'ajv';
5 import { OCPP20ServiceUtils
} from
'./OCPP20ServiceUtils';
6 import { type ChargingStation
, ChargingStationConfigurationUtils
} from
'../../../charging-station';
7 import { OCPPError
} from
'../../../exception';
12 type OCPP20BootNotificationResponse
,
13 type OCPP20ClearCacheResponse
,
14 type OCPP20HeartbeatResponse
,
15 OCPP20IncomingRequestCommand
,
16 OCPP20OptionalVariableName
,
18 type OCPP20StatusNotificationResponse
,
20 RegistrationStatusEnumType
,
22 } from
'../../../types';
23 import { logger
} from
'../../../utils';
24 import { OCPPResponseService
} from
'../OCPPResponseService';
26 const moduleName
= 'OCPP20ResponseService';
28 export class OCPP20ResponseService
extends OCPPResponseService
{
29 public jsonIncomingRequestResponseSchemas
: Map
<
30 OCPP20IncomingRequestCommand
,
31 JSONSchemaType
<JsonObject
>
34 private responseHandlers
: Map
<OCPP20RequestCommand
, ResponseHandler
>;
35 private jsonSchemas
: Map
<OCPP20RequestCommand
, JSONSchemaType
<JsonObject
>>;
37 public constructor() {
38 // if (new.target?.name === moduleName) {
39 // throw new TypeError(`Cannot construct ${new.target?.name} instances directly`);
41 super(OCPPVersion
.VERSION_20
);
42 this.responseHandlers
= new Map
<OCPP20RequestCommand
, ResponseHandler
>([
43 [OCPP20RequestCommand
.BOOT_NOTIFICATION
, this.handleResponseBootNotification
.bind(this)],
44 [OCPP20RequestCommand
.HEARTBEAT
, this.emptyResponseHandler
.bind(this)],
45 [OCPP20RequestCommand
.STATUS_NOTIFICATION
, this.emptyResponseHandler
.bind(this)],
47 this.jsonSchemas
= new Map
<OCPP20RequestCommand
, JSONSchemaType
<JsonObject
>>([
49 OCPP20RequestCommand
.BOOT_NOTIFICATION
,
50 OCPP20ServiceUtils
.parseJsonSchemaFile
<OCPP20BootNotificationResponse
>(
51 'assets/json-schemas/ocpp/2.0/BootNotificationResponse.json',
57 OCPP20RequestCommand
.HEARTBEAT
,
58 OCPP20ServiceUtils
.parseJsonSchemaFile
<OCPP20HeartbeatResponse
>(
59 'assets/json-schemas/ocpp/2.0/HeartbeatResponse.json',
65 OCPP20RequestCommand
.STATUS_NOTIFICATION
,
66 OCPP20ServiceUtils
.parseJsonSchemaFile
<OCPP20StatusNotificationResponse
>(
67 'assets/json-schemas/ocpp/2.0/StatusNotificationResponse.json',
73 this.jsonIncomingRequestResponseSchemas
= new Map([
75 OCPP20IncomingRequestCommand
.CLEAR_CACHE
,
76 OCPP20ServiceUtils
.parseJsonSchemaFile
<OCPP20ClearCacheResponse
>(
77 'assets/json-schemas/ocpp/2.0/ClearCacheResponse.json',
83 this.validatePayload
= this.validatePayload
.bind(this) as (
84 chargingStation
: ChargingStation
,
85 commandName
: OCPP20RequestCommand
,
90 public async responseHandler(
91 chargingStation
: ChargingStation
,
92 commandName
: OCPP20RequestCommand
,
94 requestPayload
: JsonType
97 chargingStation
.isRegistered() === true ||
98 commandName
=== OCPP20RequestCommand
.BOOT_NOTIFICATION
101 this.responseHandlers
.has(commandName
) === true &&
102 OCPP20ServiceUtils
.isRequestCommandSupported(chargingStation
, commandName
) === true
105 this.validatePayload(chargingStation
, commandName
, payload
);
106 await this.responseHandlers
.get(commandName
)(chargingStation
, payload
, requestPayload
);
109 `${chargingStation.logPrefix()} ${moduleName}.responseHandler: Handle response error:`,
117 ErrorType
.NOT_IMPLEMENTED
,
118 `${commandName} is not implemented to handle response PDU ${JSON.stringify(
129 ErrorType
.SECURITY_ERROR
,
130 `${commandName} cannot be issued to handle response PDU ${JSON.stringify(
134 )} while the charging station is not registered on the central server.`,
141 private validatePayload(
142 chargingStation
: ChargingStation
,
143 commandName
: OCPP20RequestCommand
,
146 if (this.jsonSchemas
.has(commandName
) === true) {
147 return this.validateResponsePayload(
150 this.jsonSchemas
.get(commandName
),
155 `${chargingStation.logPrefix()} ${moduleName}.validatePayload: No JSON schema found for command '${commandName}' PDU validation`
160 private handleResponseBootNotification(
161 chargingStation
: ChargingStation
,
162 payload
: OCPP20BootNotificationResponse
164 if (payload
.status === RegistrationStatusEnumType
.ACCEPTED
) {
165 ChargingStationConfigurationUtils
.addConfigurationKey(
167 OCPP20OptionalVariableName
.HeartbeatInterval
,
168 payload
.interval
.toString(),
170 { overwrite
: true, save
: true }
172 OCPP20ServiceUtils
.startHeartbeatInterval(chargingStation
, payload
.interval
);
174 if (Object.values(RegistrationStatusEnumType
).includes(payload
.status)) {
175 const logMsg
= `${chargingStation.logPrefix()} Charging station in '${
177 }' state on the central server`;
178 payload
.status === RegistrationStatusEnumType
.REJECTED
179 ? logger
.warn(logMsg
)
180 : logger
.info(logMsg
);
183 `${chargingStation.logPrefix()} Charging station boot notification response received: %j with undefined registration status`,