-// Partial Copyright Jerome Benoit. 2021. All Rights Reserved.
+// Partial Copyright Jerome Benoit. 2021-2023. All Rights Reserved.
-import type ChargingStation from '../../ChargingStation';
-import Constants from '../../../utils/Constants';
-import { ErrorType } from '../../../types/ocpp/ErrorType';
-import { JsonType } from '../../../types/JsonType';
-import { OCPP16RequestCommand } from '../../../types/ocpp/1.6/Requests';
+import type { JSONSchemaType } from 'ajv';
+
+import { OCPP16Constants } from './OCPP16Constants';
import { OCPP16ServiceUtils } from './OCPP16ServiceUtils';
-import OCPPError from '../../../exception/OCPPError';
-import OCPPRequestService from '../OCPPRequestService';
-import type OCPPResponseService from '../OCPPResponseService';
-import { RequestParams } from '../../../types/ocpp/Requests';
-import Utils from '../../../utils/Utils';
+import type { ChargingStation } from '../../../charging-station';
+import { OCPPError } from '../../../exception';
+import {
+ ErrorType,
+ type JsonObject,
+ type JsonType,
+ type OCPP16AuthorizeRequest,
+ type OCPP16BootNotificationRequest,
+ type OCPP16DataTransferRequest,
+ type OCPP16DiagnosticsStatusNotificationRequest,
+ type OCPP16FirmwareStatusNotificationRequest,
+ type OCPP16HeartbeatRequest,
+ type OCPP16MeterValuesRequest,
+ OCPP16RequestCommand,
+ type OCPP16StartTransactionRequest,
+ type OCPP16StatusNotificationRequest,
+ type OCPP16StopTransactionRequest,
+ OCPPVersion,
+ type RequestParams,
+} from '../../../types';
+import { Constants, Utils } from '../../../utils';
+import { OCPPRequestService } from '../OCPPRequestService';
+import type { OCPPResponseService } from '../OCPPResponseService';
const moduleName = 'OCPP16RequestService';
-export default class OCPP16RequestService extends OCPPRequestService {
- public constructor(chargingStation: ChargingStation, ocppResponseService: OCPPResponseService) {
- if (new.target?.name === moduleName) {
- throw new TypeError(`Cannot construct ${new.target?.name} instances directly`);
- }
- super(chargingStation, ocppResponseService);
+export class OCPP16RequestService extends OCPPRequestService {
+ protected 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(OCPPVersion.VERSION_16, ocppResponseService);
+ this.jsonSchemas = new Map<OCPP16RequestCommand, JSONSchemaType<JsonObject>>([
+ [
+ OCPP16RequestCommand.AUTHORIZE,
+ OCPP16ServiceUtils.parseJsonSchemaFile<OCPP16AuthorizeRequest>(
+ '../../../assets/json-schemas/ocpp/1.6/Authorize.json',
+ moduleName,
+ 'constructor'
+ ),
+ ],
+ [
+ OCPP16RequestCommand.BOOT_NOTIFICATION,
+ OCPP16ServiceUtils.parseJsonSchemaFile<OCPP16BootNotificationRequest>(
+ '../../../assets/json-schemas/ocpp/1.6/BootNotification.json',
+ moduleName,
+ 'constructor'
+ ),
+ ],
+ [
+ OCPP16RequestCommand.DIAGNOSTICS_STATUS_NOTIFICATION,
+ OCPP16ServiceUtils.parseJsonSchemaFile<OCPP16DiagnosticsStatusNotificationRequest>(
+ '../../../assets/json-schemas/ocpp/1.6/DiagnosticsStatusNotification.json',
+ moduleName,
+ 'constructor'
+ ),
+ ],
+ [
+ OCPP16RequestCommand.HEARTBEAT,
+ OCPP16ServiceUtils.parseJsonSchemaFile<OCPP16HeartbeatRequest>(
+ '../../../assets/json-schemas/ocpp/1.6/Heartbeat.json',
+ moduleName,
+ 'constructor'
+ ),
+ ],
+ [
+ OCPP16RequestCommand.METER_VALUES,
+ OCPP16ServiceUtils.parseJsonSchemaFile<OCPP16MeterValuesRequest>(
+ '../../../assets/json-schemas/ocpp/1.6/MeterValues.json',
+ moduleName,
+ 'constructor'
+ ),
+ ],
+ [
+ OCPP16RequestCommand.STATUS_NOTIFICATION,
+ OCPP16ServiceUtils.parseJsonSchemaFile<OCPP16StatusNotificationRequest>(
+ '../../../assets/json-schemas/ocpp/1.6/StatusNotification.json',
+ moduleName,
+ 'constructor'
+ ),
+ ],
+ [
+ OCPP16RequestCommand.START_TRANSACTION,
+ OCPP16ServiceUtils.parseJsonSchemaFile<OCPP16StartTransactionRequest>(
+ '../../../assets/json-schemas/ocpp/1.6/StartTransaction.json',
+ moduleName,
+ 'constructor'
+ ),
+ ],
+ [
+ OCPP16RequestCommand.STOP_TRANSACTION,
+ OCPP16ServiceUtils.parseJsonSchemaFile<OCPP16StopTransactionRequest>(
+ '../../../assets/json-schemas/ocpp/1.6/StopTransaction.json',
+ moduleName,
+ 'constructor'
+ ),
+ ],
+ [
+ OCPP16RequestCommand.DATA_TRANSFER,
+ OCPP16ServiceUtils.parseJsonSchemaFile<OCPP16DataTransferRequest>(
+ '../../../assets/json-schemas/ocpp/1.6/DataTransfer.json',
+ moduleName,
+ 'constructor'
+ ),
+ ],
+ [
+ OCPP16RequestCommand.FIRMWARE_STATUS_NOTIFICATION,
+ OCPP16ServiceUtils.parseJsonSchemaFile<OCPP16FirmwareStatusNotificationRequest>(
+ '../../../assets/json-schemas/ocpp/1.6/FirmwareStatusNotification.json',
+ moduleName,
+ 'constructor'
+ ),
+ ],
+ ]);
+ this.buildRequestPayload = this.buildRequestPayload.bind(this) as <Request extends JsonType>(
+ chargingStation: ChargingStation,
+ commandName: OCPP16RequestCommand,
+ commandParams?: JsonType
+ ) => Request;
}
- public async requestHandler<Request extends JsonType, Response extends JsonType>(
+ public async requestHandler<RequestType extends JsonType, ResponseType extends JsonType>(
+ chargingStation: ChargingStation,
commandName: OCPP16RequestCommand,
commandParams?: JsonType,
params?: RequestParams
- ): Promise<Response> {
- if (Object.values(OCPP16RequestCommand).includes(commandName)) {
+ ): Promise<ResponseType> {
+ // FIXME?: add sanity checks on charging station availability, connector availability, connector status, etc.
+ if (OCPP16ServiceUtils.isRequestCommandSupported(chargingStation, commandName) === true) {
return (await this.sendMessage(
+ chargingStation,
Utils.generateUUID(),
- this.buildRequestPayload<Request>(commandName, commandParams),
+ this.buildRequestPayload<RequestType>(chargingStation, commandName, commandParams),
commandName,
params
- )) as unknown as Response;
+ )) 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 }
+ commandParams
);
}
private buildRequestPayload<Request extends JsonType>(
+ chargingStation: ChargingStation,
commandName: OCPP16RequestCommand,
commandParams?: 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 unknown as Request;
case OCPP16RequestCommand.BOOT_NOTIFICATION:
- return {
- chargePointModel: commandParams?.chargePointModel,
- chargePointVendor: commandParams?.chargePointVendor,
- ...(!Utils.isUndefined(commandParams?.chargeBoxSerialNumber) && {
- chargeBoxSerialNumber: commandParams.chargeBoxSerialNumber,
- }),
- ...(!Utils.isUndefined(commandParams?.chargePointSerialNumber) && {
- chargePointSerialNumber: commandParams.chargePointSerialNumber,
- }),
- ...(!Utils.isUndefined(commandParams?.firmwareVersion) && {
- firmwareVersion: commandParams.firmwareVersion,
- }),
- ...(!Utils.isUndefined(commandParams?.iccid) && { iccid: commandParams.iccid }),
- ...(!Utils.isUndefined(commandParams?.imsi) && { imsi: commandParams.imsi }),
- ...(!Utils.isUndefined(commandParams?.meterSerialNumber) && {
- meterSerialNumber: commandParams.meterSerialNumber,
- }),
- ...(!Utils.isUndefined(commandParams?.meterType) && {
- meterType: commandParams.meterType,
- }),
- } as unknown as Request;
case OCPP16RequestCommand.DIAGNOSTICS_STATUS_NOTIFICATION:
- return {
- status: commandParams?.diagnosticsStatus,
- } as unknown as Request;
- case OCPP16RequestCommand.HEARTBEAT:
- return {} as unknown as Request;
+ case OCPP16RequestCommand.FIRMWARE_STATUS_NOTIFICATION:
case OCPP16RequestCommand.METER_VALUES:
- return {
- connectorId: commandParams?.connectorId,
- transactionId: commandParams?.transactionId,
- meterValue: Array.isArray(commandParams?.meterValue)
- ? commandParams?.meterValue
- : [commandParams?.meterValue],
- } as unknown as Request;
case OCPP16RequestCommand.STATUS_NOTIFICATION:
+ case OCPP16RequestCommand.DATA_TRANSFER:
+ return commandParams as unknown as Request;
+ case OCPP16RequestCommand.AUTHORIZE:
return {
- connectorId: commandParams?.connectorId,
- status: commandParams?.status,
- errorCode: commandParams?.errorCode,
+ idTag: Constants.DEFAULT_IDTAG,
+ ...commandParams,
} as unknown as Request;
+ case OCPP16RequestCommand.HEARTBEAT:
+ return OCPP16Constants.OCPP_REQUEST_EMPTY 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(
- commandParams?.connectorId as number
+ idTag: Constants.DEFAULT_IDTAG,
+ meterStart: chargingStation.getEnergyActiveImportRegisterByConnectorId(
+ commandParams?.connectorId as number,
+ true
),
- timestamp: new Date().toISOString(),
+ timestamp: new Date(),
+ ...commandParams,
} as unknown as Request;
case OCPP16RequestCommand.STOP_TRANSACTION:
- connectorId = this.chargingStation.getConnectorIdByTransactionId(
- commandParams?.transactionId as number
+ chargingStation.getTransactionDataMeterValues() &&
+ (connectorId = chargingStation.getConnectorIdByTransactionId(
+ commandParams?.transactionId as number
+ ));
+ energyActiveImportRegister = chargingStation.getEnergyActiveImportRegisterByTransactionId(
+ commandParams?.transactionId as number,
+ true
);
return {
- transactionId: commandParams?.transactionId,
- ...(!Utils.isUndefined(commandParams?.idTag) && { idTag: commandParams.idTag }),
- meterStop: commandParams?.meterStop,
- timestamp: new Date().toISOString(),
- ...(commandParams?.reason && { reason: commandParams.reason }),
- ...(this.chargingStation.getTransactionDataMeterValues() && {
+ idTag: chargingStation.getTransactionIdTag(commandParams?.transactionId as number),
+ meterStop: energyActiveImportRegister,
+ timestamp: new Date(),
+ ...(chargingStation.getTransactionDataMeterValues() && {
transactionData: OCPP16ServiceUtils.buildTransactionDataMeterValues(
- this.chargingStation.getConnectorStatus(connectorId).transactionBeginMeterValue,
+ chargingStation.getConnectorStatus(connectorId).transactionBeginMeterValue,
OCPP16ServiceUtils.buildTransactionEndMeterValue(
- this.chargingStation,
+ chargingStation,
connectorId,
- commandParams?.meterStop as number
+ energyActiveImportRegister
)
),
}),
+ ...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(
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
);
}
}
repositories / e-mobility-charging-stations-simulator.git / blobdiff