-// Partial Copyright Jerome Benoit. 2021-2023. All Rights Reserved.
+// Partial Copyright Jerome Benoit. 2021-2024. All Rights Reserved.
-import fs from 'fs';
-import path from 'path';
-import { fileURLToPath } from 'url';
+import type { ValidateFunction } from 'ajv'
-import type { JSONSchemaType } from 'ajv';
-
-import { OCPP20ServiceUtils } from './OCPP20ServiceUtils';
-import OCPPError from '../../../exception/OCPPError';
-import type { JsonObject, JsonType } from '../../../types/JsonType';
+import type { ChargingStation } from '../../../charging-station/index.js'
+import { OCPPError } from '../../../exception/index.js'
import {
+ ErrorType,
+ type JsonObject,
+ type JsonType,
type OCPP20BootNotificationRequest,
type OCPP20HeartbeatRequest,
OCPP20RequestCommand,
type OCPP20StatusNotificationRequest,
-} from '../../../types/ocpp/2.0/Requests';
-import { ErrorType } from '../../../types/ocpp/ErrorType';
-import { OCPPVersion } from '../../../types/ocpp/OCPPVersion';
-import type { RequestParams } from '../../../types/ocpp/Requests';
-import Utils from '../../../utils/Utils';
-import type ChargingStation from '../../ChargingStation';
-import OCPPRequestService from '../OCPPRequestService';
-import type OCPPResponseService from '../OCPPResponseService';
+ OCPPVersion,
+ type RequestParams
+} from '../../../types/index.js'
+import { generateUUID } from '../../../utils/index.js'
+import { OCPPRequestService } from '../OCPPRequestService.js'
+import type { OCPPResponseService } from '../OCPPResponseService.js'
+import { OCPP20Constants } from './OCPP20Constants.js'
+import { OCPP20ServiceUtils } from './OCPP20ServiceUtils.js'
-const moduleName = 'OCPP20RequestService';
+const moduleName = 'OCPP20RequestService'
-export default class OCPP20RequestService extends OCPPRequestService {
- protected jsonSchemas: Map<OCPP20RequestCommand, JSONSchemaType<JsonObject>>;
+export class OCPP20RequestService extends OCPPRequestService {
+ protected payloadValidateFunctions: Map<OCPP20RequestCommand, ValidateFunction<JsonType>>
- public constructor(ocppResponseService: OCPPResponseService) {
- 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>>([
+ public constructor (ocppResponseService: OCPPResponseService) {
+ // if (new.target.name === moduleName) {
+ // throw new TypeError(`Cannot construct ${new.target.name} instances directly`)
+ // }
+ super(OCPPVersion.VERSION_201, ocppResponseService)
+ this.payloadValidateFunctions = new Map<OCPP20RequestCommand, ValidateFunction<JsonType>>([
[
OCPP20RequestCommand.BOOT_NOTIFICATION,
- this.parseJsonSchemaFile<OCPP20BootNotificationRequest>(
- '../../../assets/json-schemas/ocpp/2.0/BootNotificationRequest.json'
- ),
+ this.ajv
+ .compile(
+ OCPP20ServiceUtils.parseJsonSchemaFile<OCPP20BootNotificationRequest>(
+ 'assets/json-schemas/ocpp/2.0/BootNotificationRequest.json',
+ moduleName,
+ 'constructor'
+ )
+ )
+ .bind(this)
],
[
OCPP20RequestCommand.HEARTBEAT,
- this.parseJsonSchemaFile<OCPP20HeartbeatRequest>(
- '../../../assets/json-schemas/ocpp/2.0/HeartbeatRequest.json'
- ),
+ this.ajv
+ .compile(
+ OCPP20ServiceUtils.parseJsonSchemaFile<OCPP20HeartbeatRequest>(
+ 'assets/json-schemas/ocpp/2.0/HeartbeatRequest.json',
+ moduleName,
+ 'constructor'
+ )
+ )
+ .bind(this)
],
[
OCPP20RequestCommand.STATUS_NOTIFICATION,
- this.parseJsonSchemaFile<OCPP20StatusNotificationRequest>(
- '../../../assets/json-schemas/ocpp/2.0/StatusNotificationRequest.json'
- ),
- ],
- ]);
- this.buildRequestPayload.bind(this);
+ this.ajv
+ .compile(
+ OCPP20ServiceUtils.parseJsonSchemaFile<OCPP20StatusNotificationRequest>(
+ 'assets/json-schemas/ocpp/2.0/StatusNotificationRequest.json',
+ moduleName,
+ 'constructor'
+ )
+ )
+ .bind(this)
+ ]
+ ])
+ this.buildRequestPayload = this.buildRequestPayload.bind(this)
}
public async requestHandler<RequestType extends JsonType, ResponseType extends JsonType>(
chargingStation: ChargingStation,
commandName: OCPP20RequestCommand,
- commandParams?: JsonType,
+ commandParams?: RequestType,
params?: RequestParams
): Promise<ResponseType> {
- if (OCPP20ServiceUtils.isRequestCommandSupported(chargingStation, commandName) === true) {
- const requestPayload = this.buildRequestPayload<RequestType>(
- chargingStation,
- commandName,
- commandParams
- );
+ // FIXME?: add sanity checks on charging station availability, connector availability, connector status, etc.
+ if (OCPP20ServiceUtils.isRequestCommandSupported(chargingStation, commandName)) {
+ // TODO: post request actions hook
return (await this.sendMessage(
chargingStation,
- Utils.generateUUID(),
- requestPayload,
+ generateUUID(),
+ 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(
`Unsupported OCPP command '${commandName}'`,
commandName,
commandParams
- );
+ )
}
private buildRequestPayload<Request extends JsonType>(
commandName: OCPP20RequestCommand,
commandParams?: JsonType
): Request {
- commandParams = commandParams as JsonObject;
+ commandParams = commandParams as JsonObject
switch (commandName) {
case OCPP20RequestCommand.BOOT_NOTIFICATION:
- commandParams.chargingStation = commandParams.chargingStation as JsonObject;
- commandParams.chargingStation.modem = commandParams.chargingStation.modem as JsonObject;
- return {
- reason: commandParams?.reason,
- chargingStation: {
- model: commandParams?.chargingStation?.model,
- vendorName: commandParams?.chargingStation?.vendorName,
- ...(!Utils.isUndefined(commandParams?.chargingStation?.firmwareVersion) && {
- firmwareVersion: commandParams.chargingStation?.firmwareVersion,
- }),
- ...(!Utils.isUndefined(commandParams?.chargingStation?.serialNumber) && {
- serialNumber: commandParams.chargingStation?.serialNumber,
- }),
- ...(!Utils.isUndefined(commandParams?.chargingStation?.modem) && {
- modem: {
- ...(!Utils.isUndefined(commandParams?.chargingStation?.modem?.iccid) && {
- iccid: commandParams.chargingStation.modem.iccid,
- }),
- ...(!Utils.isUndefined(commandParams?.chargingStation?.modem?.imsi) && {
- imsi: commandParams.chargingStation.modem.imsi,
- }),
- },
- }),
- },
- } as unknown as Request;
+ return commandParams as unknown as Request
case OCPP20RequestCommand.HEARTBEAT:
- return {} as unknown as Request;
+ return OCPP20Constants.OCPP_RESPONSE_EMPTY as unknown as Request
case OCPP20RequestCommand.STATUS_NOTIFICATION:
return {
- timestamp: commandParams?.timestamp ?? new Date(),
- connectorStatus: commandParams?.connectorStatus,
- evseId: commandParams?.evseId,
- connectorId: commandParams?.connectorId,
- } as unknown as Request;
+ 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(
`Unsupported OCPP command '${commandName}'`,
commandName,
commandParams
- );
+ )
}
}
-
- private parseJsonSchemaFile<T extends JsonType>(relativePath: string): JSONSchemaType<T> {
- return JSON.parse(
- fs.readFileSync(
- path.resolve(path.dirname(fileURLToPath(import.meta.url)), relativePath),
- 'utf8'
- )
- ) as JSONSchemaType<T>;
- }
}
repositories / e-mobility-charging-stations-simulator.git / blobdiff