X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fcharging-station%2Focpp%2F1.6%2FOCPP16RequestService.ts;h=0671af3386336e5025045d3c347f407a5e4d8951;hb=f1e731bd71b42117f4173830c6ba6dc6eccefce6;hp=d840e5e97a23ca788d7a922697e471215ae60755;hpb=ed3d28080b6597ba2f728d625e34ce05aea49d06;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 d840e5e9..0671af33 100644 --- a/src/charging-station/ocpp/1.6/OCPP16RequestService.ts +++ b/src/charging-station/ocpp/1.6/OCPP16RequestService.ts @@ -1,4 +1,4 @@ -// Partial Copyright Jerome Benoit. 2021. All Rights Reserved. +// Partial Copyright Jerome Benoit. 2021-2023. All Rights Reserved. import fs from 'fs'; import path from 'path'; @@ -6,15 +6,18 @@ import { fileURLToPath } from 'url'; import type { JSONSchemaType } from 'ajv'; +import { OCPP16ServiceUtils } from './OCPP16ServiceUtils'; import OCPPError from '../../../exception/OCPPError'; import type { JsonObject, JsonType } from '../../../types/JsonType'; import type { OCPP16MeterValuesRequest } from '../../../types/ocpp/1.6/MeterValues'; import { - DiagnosticsStatusNotificationRequest, - OCPP16BootNotificationRequest, - OCPP16HeartbeatRequest, + type OCPP16BootNotificationRequest, + type OCPP16DataTransferRequest, + type OCPP16DiagnosticsStatusNotificationRequest, + type OCPP16FirmwareStatusNotificationRequest, + type OCPP16HeartbeatRequest, OCPP16RequestCommand, - OCPP16StatusNotificationRequest, + type OCPP16StatusNotificationRequest, } from '../../../types/ocpp/1.6/Requests'; import type { OCPP16AuthorizeRequest, @@ -22,126 +25,87 @@ import type { OCPP16StopTransactionRequest, } from '../../../types/ocpp/1.6/Transaction'; import { ErrorType } from '../../../types/ocpp/ErrorType'; +import { OCPPVersion } from '../../../types/ocpp/OCPPVersion'; 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 { ChargingStationUtils } from '../../ChargingStationUtils'; import OCPPRequestService from '../OCPPRequestService'; import type OCPPResponseService from '../OCPPResponseService'; -import { OCPP16ServiceUtils } from './OCPP16ServiceUtils'; const moduleName = 'OCPP16RequestService'; export default class OCPP16RequestService extends OCPPRequestService { - private jsonSchemas: Map>; + protected jsonSchemas: Map>; public constructor(ocppResponseService: OCPPResponseService) { if (new.target?.name === moduleName) { throw new TypeError(`Cannot construct ${new.target?.name} instances directly`); } - super(ocppResponseService); + 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, + this.parseJsonSchemaFile( + '../../../assets/json-schemas/ocpp/1.6/Authorize.json' + ), ], [ 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, + this.parseJsonSchemaFile( + '../../../assets/json-schemas/ocpp/1.6/BootNotification.json' + ), ], [ 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, + this.parseJsonSchemaFile( + '../../../assets/json-schemas/ocpp/1.6/DiagnosticsStatusNotification.json' + ), ], [ 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, + this.parseJsonSchemaFile( + '../../../assets/json-schemas/ocpp/1.6/Heartbeat.json' + ), ], [ 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, + this.parseJsonSchemaFile( + '../../../assets/json-schemas/ocpp/1.6/MeterValues.json' + ), ], [ 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, + this.parseJsonSchemaFile( + '../../../assets/json-schemas/ocpp/1.6/StatusNotification.json' + ), ], [ 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, + this.parseJsonSchemaFile( + '../../../assets/json-schemas/ocpp/1.6/StartTransaction.json' + ), ], [ 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, + this.parseJsonSchemaFile( + '../../../assets/json-schemas/ocpp/1.6/StopTransaction.json' + ), + ], + [ + OCPP16RequestCommand.DATA_TRANSFER, + this.parseJsonSchemaFile( + '../../../assets/json-schemas/ocpp/1.6/DataTransfer.json' + ), + ], + [ + OCPP16RequestCommand.FIRMWARE_STATUS_NOTIFICATION, + this.parseJsonSchemaFile( + '../../../assets/json-schemas/ocpp/1.6/FirmwareStatusNotification.json' + ), ], ]); this.buildRequestPayload.bind(this); - this.validatePayload.bind(this); } public async requestHandler( @@ -150,13 +114,12 @@ export default class OCPP16RequestService extends OCPPRequestService { commandParams?: JsonType, params?: RequestParams ): Promise { - if (OCPP16ServiceUtils.isRequestCommandSupported(commandName, chargingStation)) { + 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(), @@ -212,8 +175,9 @@ export default class OCPP16RequestService extends OCPPRequestService { }), } as unknown as Request; case OCPP16RequestCommand.DIAGNOSTICS_STATUS_NOTIFICATION: + case OCPP16RequestCommand.FIRMWARE_STATUS_NOTIFICATION: return { - status: commandParams?.diagnosticsStatus, + status: commandParams?.status, } as unknown as Request; case OCPP16RequestCommand.HEARTBEAT: return {} as unknown as Request; @@ -228,6 +192,18 @@ export default class OCPP16RequestService extends OCPPRequestService { connectorId: commandParams?.connectorId, status: commandParams?.status, errorCode: commandParams?.errorCode, + ...(!Utils.isUndefined(commandParams?.info) && { + info: commandParams?.info, + }), + ...(!Utils.isUndefined(commandParams?.timestamp) && { + timestamp: commandParams?.timestamp, + }), + ...(!Utils.isUndefined(commandParams?.vendorId) && { + vendorId: commandParams?.vendorId, + }), + ...(!Utils.isUndefined(commandParams?.vendorErrorCode) && { + vendorErrorCode: commandParams?.vendorErrorCode, + }), } as unknown as Request; case OCPP16RequestCommand.START_TRANSACTION: return { @@ -235,16 +211,23 @@ export default class OCPP16RequestService extends OCPPRequestService { ...(!Utils.isUndefined(commandParams?.idTag) ? { idTag: commandParams?.idTag } : { idTag: Constants.DEFAULT_IDTAG }), - meterStart: chargingStation.getEnergyActiveImportRegisterByConnectorId( - commandParams?.connectorId as number - ), - timestamp: new Date().toISOString(), + meterStart: + commandParams?.meterStart ?? + chargingStation.getEnergyActiveImportRegisterByConnectorId( + commandParams?.connectorId as number + ), + timestamp: commandParams?.timestamp ?? new Date(), + ...(!Utils.isUndefined(commandParams?.reservationId) && { + reservationId: commandParams?.reservationId, + }), } as unknown as Request; case OCPP16RequestCommand.STOP_TRANSACTION: - connectorId = chargingStation.getConnectorIdByTransactionId( - commandParams?.transactionId as number - ); - commandParams?.meterStop && + chargingStation.getTransactionDataMeterValues() && + Utils.isUndefined(commandParams?.transactionData) && + (connectorId = chargingStation.getConnectorIdByTransactionId( + commandParams?.transactionId as number + )); + !commandParams?.meterStop && (energyActiveImportRegister = chargingStation.getEnergyActiveImportRegisterByTransactionId( commandParams?.transactionId as number, @@ -256,19 +239,25 @@ export default class OCPP16RequestService extends OCPPRequestService { commandParams?.idTag ?? chargingStation.getTransactionIdTag(commandParams?.transactionId as number), meterStop: commandParams?.meterStop ?? energyActiveImportRegister, - timestamp: new Date().toISOString(), - reason: commandParams?.reason, - ...(chargingStation.getTransactionDataMeterValues() && { - transactionData: OCPP16ServiceUtils.buildTransactionDataMeterValues( - chargingStation.getConnectorStatus(connectorId).transactionBeginMeterValue, - OCPP16ServiceUtils.buildTransactionEndMeterValue( - chargingStation, - connectorId, - (commandParams?.meterStop as number) ?? energyActiveImportRegister - ) - ), + timestamp: commandParams?.timestamp ?? new Date(), + ...(!Utils.isUndefined(commandParams?.reason) && { + reason: commandParams?.reason, }), + ...(!Utils.isUndefined(commandParams?.transactionData) + ? { transactionData: commandParams?.transactionData } + : chargingStation.getTransactionDataMeterValues() && { + transactionData: OCPP16ServiceUtils.buildTransactionDataMeterValues( + chargingStation.getConnectorStatus(connectorId).transactionBeginMeterValue, + OCPP16ServiceUtils.buildTransactionEndMeterValue( + chargingStation, + connectorId, + (commandParams?.meterStop as number) ?? energyActiveImportRegister + ) + ), + }), } 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( @@ -281,22 +270,12 @@ 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; + private parseJsonSchemaFile(relativePath: string): JSONSchemaType { + return JSON.parse( + fs.readFileSync( + path.resolve(path.dirname(fileURLToPath(import.meta.url)), relativePath), + 'utf8' + ) + ) as JSONSchemaType; } }