X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fcharging-station%2Focpp%2F1.6%2FOCPP16RequestService.ts;h=eee9e9a9d1687939a5e1d523496a6386abd97395;hb=abe9e9dd3d72acc384fa2d3acd434f0053d8c61e;hp=a4b1275f5a4c1474ccb0ac2e447a354d77eb64a8;hpb=91a7d3eac062df6c73d8443a542568c1fe69ec1b;p=e-mobility-charging-stations-simulator.git diff --git a/src/charging-station/ocpp/1.6/OCPP16RequestService.ts b/src/charging-station/ocpp/1.6/OCPP16RequestService.ts index a4b1275f..eee9e9a9 100644 --- a/src/charging-station/ocpp/1.6/OCPP16RequestService.ts +++ b/src/charging-station/ocpp/1.6/OCPP16RequestService.ts @@ -1,159 +1,128 @@ -// Partial Copyright Jerome Benoit. 2021. All Rights Reserved. - -import fs from 'fs'; -import path from 'path'; -import { fileURLToPath } from 'url'; +// 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 { OCPP16MeterValuesRequest } from '../../../types/ocpp/1.6/MeterValues'; +import type { ChargingStation } from '../../../charging-station'; +import { OCPPError } from '../../../exception'; import { - DiagnosticsStatusNotificationRequest, - OCPP16BootNotificationRequest, - OCPP16DataTransferRequest, - OCPP16HeartbeatRequest, + ErrorType, + type JsonObject, + type JsonType, + type OCPP16AuthorizeRequest, + type OCPP16BootNotificationRequest, + type OCPP16DataTransferRequest, + type OCPP16DiagnosticsStatusNotificationRequest, + type OCPP16FirmwareStatusNotificationRequest, + type OCPP16HeartbeatRequest, + type OCPP16MeterValuesRequest, OCPP16RequestCommand, - OCPP16StatusNotificationRequest, -} from '../../../types/ocpp/1.6/Requests'; -import type { - OCPP16AuthorizeRequest, - OCPP16StartTransactionRequest, - OCPP16StopTransactionRequest, -} from '../../../types/ocpp/1.6/Transaction'; -import { ErrorType } from '../../../types/ocpp/ErrorType'; -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 { OCPP16ServiceUtils } from './OCPP16ServiceUtils'; + type OCPP16StartTransactionRequest, + type OCPP16StatusNotificationRequest, + type OCPP16StopTransactionRequest, + OCPPVersion, + type RequestParams, +} from '../../../types'; +import { Constants, Utils } from '../../../utils'; +import { + OCPP16ServiceUtils, + OCPPConstants, + OCPPRequestService, + type OCPPResponseService, +} from '../internal'; const moduleName = 'OCPP16RequestService'; -export default class OCPP16RequestService extends OCPPRequestService { - private jsonSchemas: Map>; +export class OCPP16RequestService extends OCPPRequestService { + protected jsonSchemas: Map>; public constructor(ocppResponseService: OCPPResponseService) { - if (new.target?.name === moduleName) { - throw new TypeError(`Cannot construct ${new.target?.name} instances directly`); - } - super(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.AUTHORIZE, - JSON.parse( - fs.readFileSync( - path.resolve( - path.dirname(fileURLToPath(import.meta.url)), - '../../../assets/json-schemas/ocpp/1.6/Authorize.json' - ), - 'utf8' - ) - ) as JSONSchemaType, + OCPP16ServiceUtils.parseJsonSchemaFile( + '../../../assets/json-schemas/ocpp/1.6/Authorize.json', + moduleName, + 'constructor' + ), ], [ 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, + OCPP16ServiceUtils.parseJsonSchemaFile( + '../../../assets/json-schemas/ocpp/1.6/BootNotification.json', + moduleName, + 'constructor' + ), ], [ 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, + OCPP16ServiceUtils.parseJsonSchemaFile( + '../../../assets/json-schemas/ocpp/1.6/DiagnosticsStatusNotification.json', + moduleName, + 'constructor' + ), ], [ 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, + OCPP16ServiceUtils.parseJsonSchemaFile( + '../../../assets/json-schemas/ocpp/1.6/Heartbeat.json', + moduleName, + 'constructor' + ), ], [ 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, + OCPP16ServiceUtils.parseJsonSchemaFile( + '../../../assets/json-schemas/ocpp/1.6/MeterValues.json', + moduleName, + 'constructor' + ), ], [ 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, + OCPP16ServiceUtils.parseJsonSchemaFile( + '../../../assets/json-schemas/ocpp/1.6/StatusNotification.json', + moduleName, + 'constructor' + ), ], [ 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, + OCPP16ServiceUtils.parseJsonSchemaFile( + '../../../assets/json-schemas/ocpp/1.6/StartTransaction.json', + moduleName, + 'constructor' + ), ], [ 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, + OCPP16ServiceUtils.parseJsonSchemaFile( + '../../../assets/json-schemas/ocpp/1.6/StopTransaction.json', + moduleName, + 'constructor' + ), ], [ OCPP16RequestCommand.DATA_TRANSFER, - JSON.parse( - fs.readFileSync( - path.resolve( - path.dirname(fileURLToPath(import.meta.url)), - '../../../assets/json-schemas/ocpp/1.6/DataTransfer.json' - ), - 'utf8' - ) - ) as JSONSchemaType, + OCPP16ServiceUtils.parseJsonSchemaFile( + '../../../assets/json-schemas/ocpp/1.6/DataTransfer.json', + moduleName, + 'constructor' + ), + ], + [ + OCPP16RequestCommand.FIRMWARE_STATUS_NOTIFICATION, + OCPP16ServiceUtils.parseJsonSchemaFile( + '../../../assets/json-schemas/ocpp/1.6/FirmwareStatusNotification.json', + moduleName, + 'constructor' + ), ], ]); this.buildRequestPayload.bind(this); - this.validatePayload.bind(this); } public async requestHandler( @@ -163,19 +132,13 @@ export default class OCPP16RequestService extends OCPPRequestService { params?: RequestParams ): Promise { if (OCPP16ServiceUtils.isRequestCommandSupported(chargingStation, commandName) === true) { - const requestPayload = this.buildRequestPayload( - chargingStation, - commandName, - commandParams - ); - this.validatePayload(chargingStation, commandName, requestPayload); return (await this.sendMessage( chargingStation, Utils.generateUUID(), - requestPayload, + this.buildRequestPayload(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( @@ -195,94 +158,55 @@ export default class OCPP16RequestService extends OCPPRequestService { 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: 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 OCPPConstants.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 }), + idTag: Constants.DEFAULT_IDTAG, meterStart: chargingStation.getEnergyActiveImportRegisterByConnectorId( - commandParams?.connectorId as number + commandParams?.connectorId as number, + true ), - timestamp: new Date().toISOString(), + timestamp: new Date(), + ...commandParams, } as unknown as Request; case OCPP16RequestCommand.STOP_TRANSACTION: - connectorId = chargingStation.getConnectorIdByTransactionId( - commandParams?.transactionId as number + chargingStation.getTransactionDataMeterValues() && + (connectorId = chargingStation.getConnectorIdByTransactionId( + commandParams?.transactionId as number + )); + energyActiveImportRegister = chargingStation.getEnergyActiveImportRegisterByTransactionId( + commandParams?.transactionId as number, + true ); - commandParams?.meterStop && - (energyActiveImportRegister = - chargingStation.getEnergyActiveImportRegisterByTransactionId( - commandParams?.transactionId as number, - true - )); return { - transactionId: commandParams?.transactionId, - idTag: - commandParams?.idTag ?? - chargingStation.getTransactionIdTag(commandParams?.transactionId as number), - meterStop: commandParams?.meterStop ?? energyActiveImportRegister, - timestamp: new Date().toISOString(), - reason: commandParams?.reason, + idTag: chargingStation.getTransactionIdTag(commandParams?.transactionId as number), + meterStop: energyActiveImportRegister, + timestamp: new Date(), ...(chargingStation.getTransactionDataMeterValues() && { transactionData: OCPP16ServiceUtils.buildTransactionDataMeterValues( chargingStation.getConnectorStatus(connectorId).transactionBeginMeterValue, OCPP16ServiceUtils.buildTransactionEndMeterValue( chargingStation, connectorId, - (commandParams?.meterStop as number) ?? energyActiveImportRegister + energyActiveImportRegister ) ), }), + ...commandParams, } as unknown as Request; - case OCPP16RequestCommand.DATA_TRANSFER: - return 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( @@ -294,23 +218,4 @@ export default class OCPP16RequestService extends OCPPRequestService { ); } } - - private validatePayload( - 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; - } }