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 { RequestParams } from '../../../types/ocpp/Requests';
-import logger from '../../../utils/Logger';
-import Utils from '../../../utils/Utils';
-import type ChargingStation from '../../ChargingStation';
-import OCPPRequestService from '../OCPPRequestService';
-import type OCPPResponseService from '../OCPPResponseService';
+import { OCPP20Constants } from './OCPP20Constants';
import { OCPP20ServiceUtils } from './OCPP20ServiceUtils';
+import type { ChargingStation } from '../../../charging-station';
+import { OCPPError } from '../../../exception';
+import {
+ ErrorType,
+ type JsonObject,
+ type JsonType,
+ type OCPP20BootNotificationRequest,
+ type OCPP20HeartbeatRequest,
+ OCPP20RequestCommand,
+ type OCPP20StatusNotificationRequest,
+ OCPPVersion,
+ type RequestParams,
+} from '../../../types';
+import { Utils } from '../../../utils';
+import { OCPPRequestService } from '../OCPPRequestService';
+import type { OCPPResponseService } from '../OCPPResponseService';
const moduleName = 'OCPP20RequestService';
-export default class OCPP20RequestService extends OCPPRequestService {
- private jsonSchemas: Map<OCPP20RequestCommand, JSONSchemaType<JsonObject>>;
+export class OCPP20RequestService extends OCPPRequestService {
+ protected jsonSchemas: Map<OCPP20RequestCommand, JSONSchemaType<JsonObject>>;
public constructor(ocppResponseService: OCPPResponseService) {
- if (new.target?.name === moduleName) {
- throw new TypeError(`Cannot construct ${new.target?.name} instances directly`);
- }
- super(ocppResponseService);
- this.jsonSchemas = new Map<OCPP20RequestCommand, JSONSchemaType<JsonObject>>();
- this.buildRequestPayload.bind(this);
- this.validatePayload.bind(this);
+ // if (new.target?.name === moduleName) {
+ // throw new TypeError(`Cannot construct ${new.target?.name} instances directly`);
+ // }
+ super(OCPPVersion.VERSION_20, ocppResponseService);
+ this.jsonSchemas = new Map<OCPP20RequestCommand, JSONSchemaType<JsonObject>>([
+ [
+ OCPP20RequestCommand.BOOT_NOTIFICATION,
+ OCPP20ServiceUtils.parseJsonSchemaFile<OCPP20BootNotificationRequest>(
+ '../../../assets/json-schemas/ocpp/2.0/BootNotificationRequest.json',
+ moduleName,
+ 'constructor'
+ ),
+ ],
+ [
+ OCPP20RequestCommand.HEARTBEAT,
+ OCPP20ServiceUtils.parseJsonSchemaFile<OCPP20HeartbeatRequest>(
+ '../../../assets/json-schemas/ocpp/2.0/HeartbeatRequest.json',
+ moduleName,
+ 'constructor'
+ ),
+ ],
+ [
+ OCPP20RequestCommand.STATUS_NOTIFICATION,
+ OCPP20ServiceUtils.parseJsonSchemaFile<OCPP20StatusNotificationRequest>(
+ '../../../assets/json-schemas/ocpp/2.0/StatusNotificationRequest.json',
+ moduleName,
+ 'constructor'
+ ),
+ ],
+ ]);
+ this.buildRequestPayload = this.buildRequestPayload.bind(this) as <Request extends JsonType>(
+ chargingStation: ChargingStation,
+ commandName: OCPP20RequestCommand,
+ commandParams?: JsonType
+ ) => Request;
}
public async requestHandler<RequestType extends JsonType, ResponseType extends JsonType>(
commandParams?: JsonType,
params?: RequestParams
): Promise<ResponseType> {
+ // FIXME?: add sanity checks on charging station availability, connector availability, connector status, etc.
if (OCPP20ServiceUtils.isRequestCommandSupported(chargingStation, commandName) === true) {
- const requestPayload = this.buildRequestPayload<RequestType>(
- chargingStation,
- commandName,
- commandParams
- );
- this.validatePayload(chargingStation, commandName, requestPayload);
return (await this.sendMessage(
chargingStation,
Utils.generateUUID(),
- requestPayload,
+ this.buildRequestPayload<RequestType>(chargingStation, commandName, commandParams),
commandName,
params
- )) as unknown as ResponseType;
+ )) as ResponseType;
}
// OCPPError usage here is debatable: it's an error in the OCPP stack but not targeted to sendError().
throw new OCPPError(
): Request {
commandParams = commandParams as JsonObject;
switch (commandName) {
+ case OCPP20RequestCommand.BOOT_NOTIFICATION:
+ return commandParams as unknown as Request;
+ case OCPP20RequestCommand.HEARTBEAT:
+ return OCPP20Constants.OCPP_RESPONSE_EMPTY as unknown as Request;
+ case OCPP20RequestCommand.STATUS_NOTIFICATION:
+ return {
+ timestamp: new Date(),
+ ...commandParams,
+ } as unknown as Request;
default:
// OCPPError usage here is debatable: it's an error in the OCPP stack but not targeted to sendError().
throw new OCPPError(
);
}
}
-
- private validatePayload<Request extends JsonType>(
- chargingStation: ChargingStation,
- commandName: OCPP20RequestCommand,
- requestPayload: Request
- ): boolean {
- if (this.jsonSchemas.has(commandName)) {
- return this.validateRequestPayload(
- chargingStation,
- commandName,
- this.jsonSchemas.get(commandName),
- requestPayload
- );
- }
- logger.warn(
- `${chargingStation.logPrefix()} ${moduleName}.validatePayload: No JSON schema found for command ${commandName} PDU validation`
- );
- return false;
- }
}