// Partial Copyright Jerome Benoit. 2021. All Rights Reserved.
-import {
- AuthorizeRequest,
- StartTransactionRequest,
- StopTransactionRequest,
-} from '../../../types/ocpp/1.6/Transaction';
+import fs from 'fs';
+import path from 'path';
+import { fileURLToPath } from 'url';
+
+import type { JSONSchemaType } from 'ajv';
+
+import OCPPError from '../../../exception/OCPPError';
+import type { JsonObject, JsonType } from '../../../types/JsonType';
+import type { OCPP16MeterValuesRequest } from '../../../types/ocpp/1.6/MeterValues';
import {
DiagnosticsStatusNotificationRequest,
- HeartbeatRequest,
OCPP16BootNotificationRequest,
+ OCPP16HeartbeatRequest,
OCPP16RequestCommand,
- StatusNotificationRequest,
+ OCPP16StatusNotificationRequest,
} from '../../../types/ocpp/1.6/Requests';
-import { MeterValuesRequest, OCPP16MeterValue } from '../../../types/ocpp/1.6/MeterValues';
-import { ResponseType, SendParams } from '../../../types/ocpp/Requests';
-
-import type ChargingStation from '../../ChargingStation';
-import Constants from '../../../utils/Constants';
+import type {
+ OCPP16AuthorizeRequest,
+ OCPP16StartTransactionRequest,
+ OCPP16StopTransactionRequest,
+} from '../../../types/ocpp/1.6/Transaction';
import { ErrorType } from '../../../types/ocpp/ErrorType';
-import { JsonType } from '../../../types/JsonType';
-import { OCPP16DiagnosticsStatus } from '../../../types/ocpp/1.6/DiagnosticsStatus';
-import { OCPP16ServiceUtils } from './OCPP16ServiceUtils';
-import OCPPError from '../../../exception/OCPPError';
+import type { RequestParams } from '../../../types/ocpp/Requests';
+import Constants from '../../../utils/Constants';
+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 Utils from '../../../utils/Utils';
+import { OCPP16ServiceUtils } from './OCPP16ServiceUtils';
const moduleName = 'OCPP16RequestService';
export default class OCPP16RequestService extends OCPPRequestService {
- public constructor(chargingStation: ChargingStation, ocppResponseService: OCPPResponseService) {
+ private jsonSchemas: Map<OCPP16RequestCommand, JSONSchemaType<JsonObject>>;
+
+ public constructor(ocppResponseService: OCPPResponseService) {
if (new.target?.name === moduleName) {
throw new TypeError(`Cannot construct ${new.target?.name} instances directly`);
}
- super(chargingStation, ocppResponseService);
+ super(ocppResponseService);
+ this.jsonSchemas = new Map<OCPP16RequestCommand, JSONSchemaType<JsonObject>>([
+ [
+ OCPP16RequestCommand.AUTHORIZE,
+ JSON.parse(
+ fs.readFileSync(
+ path.resolve(
+ path.dirname(fileURLToPath(import.meta.url)),
+ '../../../assets/json-schemas/ocpp/1.6/Authorize.json'
+ ),
+ 'utf8'
+ )
+ ) as JSONSchemaType<OCPP16AuthorizeRequest>,
+ ],
+ [
+ OCPP16RequestCommand.BOOT_NOTIFICATION,
+ JSON.parse(
+ fs.readFileSync(
+ path.resolve(
+ path.dirname(fileURLToPath(import.meta.url)),
+ '../../../assets/json-schemas/ocpp/1.6/BootNotification.json'
+ ),
+ 'utf8'
+ )
+ ) as JSONSchemaType<OCPP16BootNotificationRequest>,
+ ],
+ [
+ OCPP16RequestCommand.DIAGNOSTICS_STATUS_NOTIFICATION,
+ JSON.parse(
+ fs.readFileSync(
+ path.resolve(
+ path.dirname(fileURLToPath(import.meta.url)),
+ '../../../assets/json-schemas/ocpp/1.6/DiagnosticsStatusNotification.json'
+ ),
+ 'utf8'
+ )
+ ) as JSONSchemaType<DiagnosticsStatusNotificationRequest>,
+ ],
+ [
+ OCPP16RequestCommand.HEARTBEAT,
+ JSON.parse(
+ fs.readFileSync(
+ path.resolve(
+ path.dirname(fileURLToPath(import.meta.url)),
+ '../../../assets/json-schemas/ocpp/1.6/Heartbeat.json'
+ ),
+ 'utf8'
+ )
+ ) as JSONSchemaType<OCPP16HeartbeatRequest>,
+ ],
+ [
+ OCPP16RequestCommand.METER_VALUES,
+ JSON.parse(
+ fs.readFileSync(
+ path.resolve(
+ path.dirname(fileURLToPath(import.meta.url)),
+ '../../../assets/json-schemas/ocpp/1.6/MeterValues.json'
+ ),
+ 'utf8'
+ )
+ ) as JSONSchemaType<OCPP16MeterValuesRequest>,
+ ],
+ [
+ OCPP16RequestCommand.STATUS_NOTIFICATION,
+ JSON.parse(
+ fs.readFileSync(
+ path.resolve(
+ path.dirname(fileURLToPath(import.meta.url)),
+ '../../../assets/json-schemas/ocpp/1.6/StatusNotification.json'
+ ),
+ 'utf8'
+ )
+ ) as JSONSchemaType<OCPP16StatusNotificationRequest>,
+ ],
+ [
+ OCPP16RequestCommand.START_TRANSACTION,
+ JSON.parse(
+ fs.readFileSync(
+ path.resolve(
+ path.dirname(fileURLToPath(import.meta.url)),
+ '../../../assets/json-schemas/ocpp/1.6/StartTransaction.json'
+ ),
+ 'utf8'
+ )
+ ) as JSONSchemaType<OCPP16StartTransactionRequest>,
+ ],
+ [
+ OCPP16RequestCommand.STOP_TRANSACTION,
+ JSON.parse(
+ fs.readFileSync(
+ path.resolve(
+ path.dirname(fileURLToPath(import.meta.url)),
+ '../../../assets/json-schemas/ocpp/1.6/StopTransaction.json'
+ ),
+ 'utf8'
+ )
+ ) as JSONSchemaType<OCPP16StopTransactionRequest>,
+ ],
+ ]);
+ this.buildRequestPayload.bind(this);
+ this.validatePayload.bind(this);
}
- public async sendMessageHandler(
+ public async requestHandler<RequestType extends JsonType, ResponseType extends JsonType>(
+ chargingStation: ChargingStation,
commandName: OCPP16RequestCommand,
commandParams?: JsonType,
- params?: SendParams
+ params?: RequestParams
): Promise<ResponseType> {
- if (Object.values(OCPP16RequestCommand).includes(commandName)) {
- return this.sendMessage(
+ if (OCPP16ServiceUtils.isRequestCommandSupported(chargingStation, commandName) === true) {
+ const requestPayload = this.buildRequestPayload<RequestType>(
+ chargingStation,
+ commandName,
+ commandParams
+ );
+ this.validatePayload(chargingStation, commandName, requestPayload);
+ return (await this.sendMessage(
+ chargingStation,
Utils.generateUUID(),
- this.buildCommandPayload(commandName, commandParams),
+ requestPayload,
commandName,
params
- );
+ )) as unknown as ResponseType;
}
+ // OCPPError usage here is debatable: it's an error in the OCPP stack but not targeted to sendError().
throw new OCPPError(
ErrorType.NOT_SUPPORTED,
- `${moduleName}.sendMessageHandler: Unsupported OCPP command ${commandName}`,
+ `Unsupported OCPP command '${commandName}'`,
commandName,
- { commandName }
- );
- }
-
- public async sendMeterValues(
- connectorId: number,
- transactionId: number,
- interval: number
- ): Promise<void> {
- const meterValue: OCPP16MeterValue = OCPP16ServiceUtils.buildMeterValue(
- this.chargingStation,
- connectorId,
- transactionId,
- interval
+ commandParams
);
- const payload: MeterValuesRequest = {
- connectorId,
- transactionId,
- meterValue: [meterValue],
- };
- await this.sendMessage(Utils.generateUUID(), payload, OCPP16RequestCommand.METER_VALUES);
- }
-
- public async sendTransactionBeginMeterValues(
- connectorId: number,
- transactionId: number,
- beginMeterValue: OCPP16MeterValue
- ): Promise<void> {
- const payload: MeterValuesRequest = {
- connectorId,
- transactionId,
- meterValue: [beginMeterValue],
- };
- await this.sendMessage(Utils.generateUUID(), payload, OCPP16RequestCommand.METER_VALUES);
- }
-
- public async sendTransactionEndMeterValues(
- connectorId: number,
- transactionId: number,
- endMeterValue: OCPP16MeterValue
- ): Promise<void> {
- const payload: MeterValuesRequest = {
- connectorId,
- transactionId,
- meterValue: [endMeterValue],
- };
- await this.sendMessage(Utils.generateUUID(), payload, OCPP16RequestCommand.METER_VALUES);
}
- public async sendDiagnosticsStatusNotification(
- diagnosticsStatus: OCPP16DiagnosticsStatus
- ): Promise<void> {
- const payload: DiagnosticsStatusNotificationRequest = {
- status: diagnosticsStatus,
- };
- await this.sendMessage(
- Utils.generateUUID(),
- payload,
- OCPP16RequestCommand.DIAGNOSTICS_STATUS_NOTIFICATION
- );
- }
-
- private buildCommandPayload(
+ private buildRequestPayload<Request extends JsonType>(
+ chargingStation: ChargingStation,
commandName: OCPP16RequestCommand,
commandParams?: JsonType
- ): JsonType {
+ ): Request {
let connectorId: number;
+ let energyActiveImportRegister: number;
+ commandParams = commandParams as JsonObject;
switch (commandName) {
case OCPP16RequestCommand.AUTHORIZE:
return {
...(!Utils.isUndefined(commandParams?.idTag)
? { idTag: commandParams.idTag }
: { idTag: Constants.DEFAULT_IDTAG }),
- } as AuthorizeRequest;
+ } as unknown as Request;
case OCPP16RequestCommand.BOOT_NOTIFICATION:
return {
chargePointModel: commandParams?.chargePointModel,
...(!Utils.isUndefined(commandParams?.meterType) && {
meterType: commandParams.meterType,
}),
- } as OCPP16BootNotificationRequest;
+ } as unknown as Request;
case OCPP16RequestCommand.DIAGNOSTICS_STATUS_NOTIFICATION:
return {
status: commandParams?.diagnosticsStatus,
- } as DiagnosticsStatusNotificationRequest;
+ } as unknown as Request;
case OCPP16RequestCommand.HEARTBEAT:
- return {} as HeartbeatRequest;
+ return {} as unknown as Request;
case OCPP16RequestCommand.METER_VALUES:
return {
connectorId: commandParams?.connectorId,
transactionId: commandParams?.transactionId,
- meterValue: Array.isArray(commandParams?.meterValues)
- ? commandParams?.meterValues
- : [commandParams?.meterValue],
- } as MeterValuesRequest;
+ meterValue: commandParams?.meterValue,
+ } as unknown as Request;
case OCPP16RequestCommand.STATUS_NOTIFICATION:
return {
connectorId: commandParams?.connectorId,
status: commandParams?.status,
errorCode: commandParams?.errorCode,
- } as StatusNotificationRequest;
+ } as unknown as Request;
case OCPP16RequestCommand.START_TRANSACTION:
return {
connectorId: commandParams?.connectorId,
...(!Utils.isUndefined(commandParams?.idTag)
? { idTag: commandParams?.idTag }
: { idTag: Constants.DEFAULT_IDTAG }),
- meterStart: this.chargingStation.getEnergyActiveImportRegisterByConnectorId(
+ meterStart: chargingStation.getEnergyActiveImportRegisterByConnectorId(
commandParams?.connectorId as number
),
timestamp: new Date().toISOString(),
- } as StartTransactionRequest;
+ } as unknown as Request;
case OCPP16RequestCommand.STOP_TRANSACTION:
- for (const id of this.chargingStation.connectors.keys()) {
- if (
- id > 0 &&
- this.chargingStation.getConnectorStatus(id)?.transactionId ===
- commandParams?.transactionId
- ) {
- connectorId = id;
- break;
- }
- }
+ connectorId = chargingStation.getConnectorIdByTransactionId(
+ commandParams?.transactionId as number
+ );
+ commandParams?.meterStop &&
+ (energyActiveImportRegister =
+ chargingStation.getEnergyActiveImportRegisterByTransactionId(
+ commandParams?.transactionId as number,
+ true
+ ));
return {
transactionId: commandParams?.transactionId,
- ...(!Utils.isUndefined(commandParams?.idTag) && { idTag: commandParams.idTag }),
- meterStop: commandParams?.meterStop,
+ idTag:
+ commandParams?.idTag ??
+ chargingStation.getTransactionIdTag(commandParams?.transactionId as number),
+ meterStop: commandParams?.meterStop ?? energyActiveImportRegister,
timestamp: new Date().toISOString(),
- ...(commandParams?.reason && { reason: commandParams.reason }),
- ...(this.chargingStation.getTransactionDataMeterValues() && {
+ reason: commandParams?.reason,
+ ...(chargingStation.getTransactionDataMeterValues() && {
transactionData: OCPP16ServiceUtils.buildTransactionDataMeterValues(
- this.chargingStation.getConnectorStatus(connectorId).transactionBeginMeterValue,
+ chargingStation.getConnectorStatus(connectorId).transactionBeginMeterValue,
OCPP16ServiceUtils.buildTransactionEndMeterValue(
- this.chargingStation,
+ chargingStation,
connectorId,
- commandParams?.meterStop as number
+ (commandParams?.meterStop as number) ?? energyActiveImportRegister
)
),
}),
- } as StopTransactionRequest;
+ } 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(
ErrorType.NOT_SUPPORTED,
// eslint-disable-next-line @typescript-eslint/restrict-template-expressions
- `${moduleName}.buildCommandPayload: Unsupported OCPP command: ${commandName}`,
+ `Unsupported OCPP command '${commandName}'`,
commandName,
- { commandName }
+ commandParams
);
}
}
+
+ private validatePayload<Request extends JsonType>(
+ chargingStation: ChargingStation,
+ commandName: OCPP16RequestCommand,
+ 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;
+ }
}
repositories / e-mobility-charging-stations-simulator.git / blobdiff