-// Partial Copyright Jerome Benoit. 2021. All Rights Reserved.
+// Partial Copyright Jerome Benoit. 2021-2023. All Rights Reserved.
import type { JSONSchemaType } from 'ajv';
-import OCPPError from '../../../exception/OCPPError';
-import type { JsonObject, JsonType } from '../../../types/JsonType';
-import type { OCPP20RequestCommand } from '../../../types/ocpp/2.0/Requests';
-import { ErrorType } from '../../../types/ocpp/ErrorType';
-import type { ResponseHandler } from '../../../types/ocpp/Responses';
-import logger from '../../../utils/Logger';
-import type ChargingStation from '../../ChargingStation';
-import OCPPResponseService from '../OCPPResponseService';
import { OCPP20ServiceUtils } from './OCPP20ServiceUtils';
+import { type ChargingStation, addConfigurationKey } from '../../../charging-station';
+import { OCPPError } from '../../../exception';
+import {
+ ErrorType,
+ type JsonObject,
+ type JsonType,
+ type OCPP20BootNotificationResponse,
+ type OCPP20ClearCacheResponse,
+ type OCPP20HeartbeatResponse,
+ OCPP20IncomingRequestCommand,
+ OCPP20OptionalVariableName,
+ OCPP20RequestCommand,
+ type OCPP20StatusNotificationResponse,
+ OCPPVersion,
+ RegistrationStatusEnumType,
+ type ResponseHandler,
+} from '../../../types';
+import { logger } from '../../../utils';
+import { OCPPResponseService } from '../OCPPResponseService';
const moduleName = 'OCPP20ResponseService';
-export default class OCPP20ResponseService extends OCPPResponseService {
+export class OCPP20ResponseService extends OCPPResponseService {
+ public jsonIncomingRequestResponseSchemas: Map<
+ OCPP20IncomingRequestCommand,
+ JSONSchemaType<JsonObject>
+ >;
+
private responseHandlers: Map<OCPP20RequestCommand, ResponseHandler>;
private jsonSchemas: Map<OCPP20RequestCommand, JSONSchemaType<JsonObject>>;
public constructor() {
- if (new.target?.name === moduleName) {
- throw new TypeError(`Cannot construct ${new.target?.name} instances directly`);
- }
- super();
- this.responseHandlers = new Map<OCPP20RequestCommand, ResponseHandler>();
- this.jsonSchemas = new Map<OCPP20RequestCommand, JSONSchemaType<JsonObject>>();
- this.validatePayload.bind(this);
+ // if (new.target?.name === moduleName) {
+ // throw new TypeError(`Cannot construct ${new.target?.name} instances directly`);
+ // }
+ super(OCPPVersion.VERSION_20);
+ this.responseHandlers = new Map<OCPP20RequestCommand, ResponseHandler>([
+ [
+ OCPP20RequestCommand.BOOT_NOTIFICATION,
+ this.handleResponseBootNotification.bind(this) as ResponseHandler,
+ ],
+ [OCPP20RequestCommand.HEARTBEAT, this.emptyResponseHandler.bind(this) as ResponseHandler],
+ [
+ OCPP20RequestCommand.STATUS_NOTIFICATION,
+ this.emptyResponseHandler.bind(this) as ResponseHandler,
+ ],
+ ]);
+ this.jsonSchemas = new Map<OCPP20RequestCommand, JSONSchemaType<JsonObject>>([
+ [
+ OCPP20RequestCommand.BOOT_NOTIFICATION,
+ OCPP20ServiceUtils.parseJsonSchemaFile<OCPP20BootNotificationResponse>(
+ 'assets/json-schemas/ocpp/2.0/BootNotificationResponse.json',
+ moduleName,
+ 'constructor',
+ ),
+ ],
+ [
+ OCPP20RequestCommand.HEARTBEAT,
+ OCPP20ServiceUtils.parseJsonSchemaFile<OCPP20HeartbeatResponse>(
+ 'assets/json-schemas/ocpp/2.0/HeartbeatResponse.json',
+ moduleName,
+ 'constructor',
+ ),
+ ],
+ [
+ OCPP20RequestCommand.STATUS_NOTIFICATION,
+ OCPP20ServiceUtils.parseJsonSchemaFile<OCPP20StatusNotificationResponse>(
+ 'assets/json-schemas/ocpp/2.0/StatusNotificationResponse.json',
+ moduleName,
+ 'constructor',
+ ),
+ ],
+ ]);
+ this.jsonIncomingRequestResponseSchemas = new Map([
+ [
+ OCPP20IncomingRequestCommand.CLEAR_CACHE,
+ OCPP20ServiceUtils.parseJsonSchemaFile<OCPP20ClearCacheResponse>(
+ 'assets/json-schemas/ocpp/2.0/ClearCacheResponse.json',
+ moduleName,
+ 'constructor',
+ ),
+ ],
+ ]);
+ this.validatePayload = this.validatePayload.bind(this) as (
+ chargingStation: ChargingStation,
+ commandName: OCPP20RequestCommand,
+ payload: JsonType,
+ ) => boolean;
}
- public async responseHandler(
+ public async responseHandler<ReqType extends JsonType, ResType extends JsonType>(
chargingStation: ChargingStation,
commandName: OCPP20RequestCommand,
- payload: JsonType,
- requestPayload: JsonType
+ payload: ResType,
+ requestPayload: ReqType,
): Promise<void> {
if (
- chargingStation.isRegistered() === true /* ||
- commandName === OCPP20RequestCommand.BOOT_NOTIFICATION */
+ chargingStation.isRegistered() === true ||
+ commandName === OCPP20RequestCommand.BOOT_NOTIFICATION
) {
if (
this.responseHandlers.has(commandName) === true &&
) {
try {
this.validatePayload(chargingStation, commandName, payload);
- await this.responseHandlers.get(commandName)(chargingStation, payload, requestPayload);
+ await this.responseHandlers.get(commandName)!(chargingStation, payload, requestPayload);
} catch (error) {
logger.error(
`${chargingStation.logPrefix()} ${moduleName}.responseHandler: Handle response error:`,
- error
+ error,
);
throw error;
}
`${commandName} is not implemented to handle response PDU ${JSON.stringify(
payload,
null,
- 2
+ 2,
)}`,
commandName,
- payload
+ payload,
);
}
} else {
`${commandName} cannot be issued to handle response PDU ${JSON.stringify(
payload,
null,
- 2
- )} while the charging station is not registered on the central server. `,
+ 2,
+ )} while the charging station is not registered on the central server.`,
commandName,
- payload
+ payload,
);
}
}
private validatePayload(
chargingStation: ChargingStation,
commandName: OCPP20RequestCommand,
- payload: JsonType
+ payload: JsonType,
): boolean {
- if (this.jsonSchemas.has(commandName)) {
+ if (this.jsonSchemas.has(commandName) === true) {
return this.validateResponsePayload(
chargingStation,
commandName,
- this.jsonSchemas.get(commandName),
- payload
+ this.jsonSchemas.get(commandName)!,
+ payload,
);
}
logger.warn(
- `${chargingStation.logPrefix()} ${moduleName}.validatePayload: No JSON schema found for command ${commandName} PDU validation`
+ `${chargingStation.logPrefix()} ${moduleName}.validatePayload: No JSON schema found for command '${commandName}' PDU validation`,
);
return false;
}
+
+ private handleResponseBootNotification(
+ chargingStation: ChargingStation,
+ payload: OCPP20BootNotificationResponse,
+ ): void {
+ if (payload.status === RegistrationStatusEnumType.ACCEPTED) {
+ addConfigurationKey(
+ chargingStation,
+ OCPP20OptionalVariableName.HeartbeatInterval,
+ payload.interval.toString(),
+ {},
+ { overwrite: true, save: true },
+ );
+ OCPP20ServiceUtils.startHeartbeatInterval(chargingStation, payload.interval);
+ }
+ if (Object.values(RegistrationStatusEnumType).includes(payload.status)) {
+ const logMsg = `${chargingStation.logPrefix()} Charging station in '${
+ payload.status
+ }' state on the central server`;
+ payload.status === RegistrationStatusEnumType.REJECTED
+ ? logger.warn(logMsg)
+ : logger.info(logMsg);
+ } else {
+ logger.error(
+ `${chargingStation.logPrefix()} Charging station boot notification response received: %j with undefined registration status`,
+ payload,
+ );
+ }
+ }
}
repositories / e-mobility-charging-stations-simulator.git / blobdiff