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
, addConfigurationKey
} from
'../../../charging-station';
7 import { OCPPError
} from
'../../../exception';
11 type OCPP20BootNotificationResponse
,
12 type OCPP20ClearCacheResponse
,
13 type OCPP20HeartbeatResponse
,
14 OCPP20IncomingRequestCommand
,
15 OCPP20OptionalVariableName
,
17 type OCPP20StatusNotificationResponse
,
19 RegistrationStatusEnumType
,
21 } from
'../../../types';
22 import { logger
} from
'../../../utils';
23 import { OCPPResponseService
} from
'../OCPPResponseService';
25 const moduleName
= 'OCPP20ResponseService';
27 export class OCPP20ResponseService
extends OCPPResponseService
{
28 public jsonIncomingRequestResponseSchemas
: Map
<
29 OCPP20IncomingRequestCommand
,
30 JSONSchemaType
<JsonType
>
33 private responseHandlers
: Map
<OCPP20RequestCommand
, ResponseHandler
>;
34 private jsonSchemas
: Map
<OCPP20RequestCommand
, JSONSchemaType
<JsonType
>>;
36 public constructor() {
37 // if (new.target?.name === moduleName) {
38 // throw new TypeError(`Cannot construct ${new.target?.name} instances directly`);
40 super(OCPPVersion
.VERSION_20
);
41 this.responseHandlers
= new Map
<OCPP20RequestCommand
, ResponseHandler
>([
43 OCPP20RequestCommand
.BOOT_NOTIFICATION
,
44 this.handleResponseBootNotification
.bind(this) as ResponseHandler
,
46 [OCPP20RequestCommand
.HEARTBEAT
, this.emptyResponseHandler
.bind(this) as ResponseHandler
],
48 OCPP20RequestCommand
.STATUS_NOTIFICATION
,
49 this.emptyResponseHandler
.bind(this) as ResponseHandler
,
52 this.jsonSchemas
= new Map
<OCPP20RequestCommand
, JSONSchemaType
<JsonType
>>([
54 OCPP20RequestCommand
.BOOT_NOTIFICATION
,
55 OCPP20ServiceUtils
.parseJsonSchemaFile
<OCPP20BootNotificationResponse
>(
56 'assets/json-schemas/ocpp/2.0/BootNotificationResponse.json',
62 OCPP20RequestCommand
.HEARTBEAT
,
63 OCPP20ServiceUtils
.parseJsonSchemaFile
<OCPP20HeartbeatResponse
>(
64 'assets/json-schemas/ocpp/2.0/HeartbeatResponse.json',
70 OCPP20RequestCommand
.STATUS_NOTIFICATION
,
71 OCPP20ServiceUtils
.parseJsonSchemaFile
<OCPP20StatusNotificationResponse
>(
72 'assets/json-schemas/ocpp/2.0/StatusNotificationResponse.json',
78 this.jsonIncomingRequestResponseSchemas
= new Map([
80 OCPP20IncomingRequestCommand
.CLEAR_CACHE
,
81 OCPP20ServiceUtils
.parseJsonSchemaFile
<OCPP20ClearCacheResponse
>(
82 'assets/json-schemas/ocpp/2.0/ClearCacheResponse.json',
88 this.validatePayload
= this.validatePayload
.bind(this) as (
89 chargingStation
: ChargingStation
,
90 commandName
: OCPP20RequestCommand
,
95 public async responseHandler
<ReqType
extends JsonType
, ResType
extends JsonType
>(
96 chargingStation
: ChargingStation
,
97 commandName
: OCPP20RequestCommand
,
99 requestPayload
: ReqType
,
102 chargingStation
.isRegistered() === true ||
103 commandName
=== OCPP20RequestCommand
.BOOT_NOTIFICATION
106 this.responseHandlers
.has(commandName
) === true &&
107 OCPP20ServiceUtils
.isRequestCommandSupported(chargingStation
, commandName
) === true
110 this.validatePayload(chargingStation
, commandName
, payload
);
111 await this.responseHandlers
.get(commandName
)!(chargingStation
, payload
, requestPayload
);
114 `${chargingStation.logPrefix()} ${moduleName}.responseHandler: Handle response error:`,
122 ErrorType
.NOT_IMPLEMENTED
,
123 `${commandName} is not implemented to handle response PDU ${JSON.stringify(
134 ErrorType
.SECURITY_ERROR
,
135 `${commandName} cannot be issued to handle response PDU ${JSON.stringify(
139 )} while the charging station is not registered on the central server.`,
146 private validatePayload(
147 chargingStation
: ChargingStation
,
148 commandName
: OCPP20RequestCommand
,
151 if (this.jsonSchemas
.has(commandName
) === true) {
152 return this.validateResponsePayload(
155 this.jsonSchemas
.get(commandName
)!,
160 `${chargingStation.logPrefix()} ${moduleName}.validatePayload: No JSON schema found for command '${commandName}' PDU validation`,
165 private handleResponseBootNotification(
166 chargingStation
: ChargingStation
,
167 payload
: OCPP20BootNotificationResponse
,
169 if (payload
.status === RegistrationStatusEnumType
.ACCEPTED
) {
172 OCPP20OptionalVariableName
.HeartbeatInterval
,
173 payload
.interval
.toString(),
175 { overwrite
: true, save
: true },
177 OCPP20ServiceUtils
.startHeartbeatInterval(chargingStation
, payload
.interval
);
179 if (Object.values(RegistrationStatusEnumType
).includes(payload
.status)) {
180 const logMsg
= `${chargingStation.logPrefix()} Charging station in '${
182 }' state on the central server`;
183 payload
.status === RegistrationStatusEnumType
.REJECTED
184 ? logger
.warn(logMsg
)
185 : logger
.info(logMsg
);
188 `${chargingStation.logPrefix()} Charging station boot notification response received: %j with undefined registration status`,