X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fcharging-station%2Focpp%2F1.6%2FOCPP16RequestService.ts;h=fef9d86daa6cbe3a855b8e9c3d09b27584ae9eee;hb=cf058664a0053a43b9ac08815b6e430179ff5ddf;hp=62e96b52e4653f1c80d5d359066c34119a4a26e0;hpb=f7f98c68f78566039b7d6f53391e874d79a8b022;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 62e96b52..fef9d86d 100644 --- a/src/charging-station/ocpp/1.6/OCPP16RequestService.ts +++ b/src/charging-station/ocpp/1.6/OCPP16RequestService.ts @@ -1,53 +1,186 @@ // Partial Copyright Jerome Benoit. 2021. 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 { OCPP16ServiceUtils } from './OCPP16ServiceUtils'; +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, + OCPP16BootNotificationRequest, + OCPP16HeartbeatRequest, + 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 { ChargingStationUtils } from '../../ChargingStationUtils'; import OCPPRequestService from '../OCPPRequestService'; import type OCPPResponseService from '../OCPPResponseService'; -import { SendParams } from '../../../types/ocpp/Requests'; -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>; + + 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.AUTHORIZE, + JSON.parse( + fs.readFileSync( + path.resolve( + path.dirname(fileURLToPath(import.meta.url)), + '../../../assets/json-schemas/ocpp/1.6/Authorize.json' + ), + 'utf8' + ) + ) as JSONSchemaType, + ], + [ + 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, + ], + [ + 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, + ], + [ + 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, + ], + [ + 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, + ], + [ + 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, + ], + [ + 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, + ], + [ + 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.buildRequestPayload.bind(this); + this.validatePayload.bind(this); } - public async requestHandler( + public async requestHandler( + chargingStation: ChargingStation, commandName: OCPP16RequestCommand, commandParams?: JsonType, - params?: SendParams - ): Promise { - if (Object.values(OCPP16RequestCommand).includes(commandName)) { + params?: RequestParams + ): Promise { + if (ChargingStationUtils.isRequestCommandSupported(commandName, chargingStation)) { + const requestPayload = this.buildRequestPayload( + chargingStation, + commandName, + commandParams + ); + this.validatePayload(chargingStation, commandName, requestPayload); return (await this.sendMessage( + chargingStation, Utils.generateUUID(), - this.buildRequestPayload(commandName, commandParams), + requestPayload, commandName, params - )) as unknown as Response; + )) as unknown as ResponseType; } throw new OCPPError( ErrorType.NOT_SUPPORTED, - `${moduleName}.sendMessageHandler: Unsupported OCPP command ${commandName}`, + `Unsupported OCPP command '${commandName}'`, commandName, - { commandName } + commandParams ); } private buildRequestPayload( + chargingStation: ChargingStation, commandName: OCPP16RequestCommand, commandParams?: JsonType ): Request { let connectorId: number; + let energyActiveImportRegister: number; + commandParams = commandParams as JsonObject; switch (commandName) { case OCPP16RequestCommand.AUTHORIZE: return { @@ -87,9 +220,7 @@ export default class OCPP16RequestService extends OCPPRequestService { return { connectorId: commandParams?.connectorId, transactionId: commandParams?.transactionId, - meterValue: Array.isArray(commandParams?.meterValue) - ? commandParams?.meterValue - : [commandParams?.meterValue], + meterValue: commandParams?.meterValue, } as unknown as Request; case OCPP16RequestCommand.STATUS_NOTIFICATION: return { @@ -103,28 +234,34 @@ export default class OCPP16RequestService extends OCPPRequestService { ...(!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 unknown as Request; case OCPP16RequestCommand.STOP_TRANSACTION: - connectorId = this.chargingStation.getConnectorIdByTransactionId( + 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, + 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 ) ), }), @@ -133,10 +270,29 @@ export default class OCPP16RequestService extends OCPPRequestService { 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( + 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; + } }