X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fcharging-station%2Focpp%2F1.6%2FOCPP16RequestService.ts;h=658664092d71451b5e088bd3e3390fba6deb69c8;hb=262c47b2dbe7ad59fa523e77668dd0b994214cb2;hp=e7fa7751eb88f39e2e0533c5a6b5a8427932ca3d;hpb=6a8b180d4cd55803e41abdc90f016d1323d37ae9;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 e7fa7751..65866409 100644 --- a/src/charging-station/ocpp/1.6/OCPP16RequestService.ts +++ b/src/charging-station/ocpp/1.6/OCPP16RequestService.ts @@ -1,229 +1,218 @@ -// 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'; +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 { - AuthorizeRequest, - OCPP16AuthorizeResponse, - OCPP16StartTransactionResponse, - OCPP16StopTransactionReason, - OCPP16StopTransactionResponse, - StartTransactionRequest, - StopTransactionRequest, -} from '../../../types/ocpp/1.6/Transaction'; -import { - DiagnosticsStatusNotificationRequest, - HeartbeatRequest, - OCPP16BootNotificationRequest, + type DiagnosticsStatusNotificationRequest, + type OCPP16BootNotificationRequest, + type OCPP16DataTransferRequest, + type OCPP16HeartbeatRequest, OCPP16RequestCommand, - StatusNotificationRequest, + type 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 { OCPP16ChargePointErrorCode } from '../../../types/ocpp/1.6/ChargePointErrorCode'; -import { OCPP16ChargePointStatus } from '../../../types/ocpp/1.6/ChargePointStatus'; -import { OCPP16DiagnosticsStatus } from '../../../types/ocpp/1.6/DiagnosticsStatus'; -import { OCPP16ServiceUtils } from './OCPP16ServiceUtils'; -import OCPPError from '../../../exception/OCPPError'; +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 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>; + + public constructor(ocppResponseService: OCPPResponseService) { if (new.target?.name === moduleName) { throw new TypeError(`Cannot construct ${new.target?.name} instances directly`); } - super(chargingStation, 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, + ], + [ + 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, + ], + [ + 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, + ], + ]); + this.buildRequestPayload.bind(this); } - public async sendMessageHandler( + public async requestHandler( + chargingStation: ChargingStation, commandName: OCPP16RequestCommand, commandParams?: JsonType, - params?: SendParams + params?: RequestParams ): Promise { - if (Object.values(OCPP16RequestCommand).includes(commandName)) { - return this.sendMessage( + if (OCPP16ServiceUtils.isRequestCommandSupported(chargingStation, commandName) === true) { + const requestPayload = this.buildRequestPayload( + chargingStation, + commandName, + commandParams + ); + 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 } + commandParams ); } - public async sendStatusNotification( - connectorId: number, - status: OCPP16ChargePointStatus, - errorCode: OCPP16ChargePointErrorCode = OCPP16ChargePointErrorCode.NO_ERROR - ): Promise { - const payload: StatusNotificationRequest = { - connectorId, - errorCode, - status, - }; - await this.sendMessage(Utils.generateUUID(), payload, OCPP16RequestCommand.STATUS_NOTIFICATION); - } - - public async sendAuthorize( - connectorId: number, - idTag?: string - ): Promise { - const payload: AuthorizeRequest = { - ...(!Utils.isUndefined(idTag) ? { idTag } : { idTag: Constants.DEFAULT_IDTAG }), - }; - this.chargingStation.getConnectorStatus(connectorId).authorizeIdTag = idTag; - return (await this.sendMessage( - Utils.generateUUID(), - payload, - OCPP16RequestCommand.AUTHORIZE - )) as OCPP16AuthorizeResponse; - } - - public async sendStartTransaction( - connectorId: number, - idTag?: string - ): Promise { - const payload: StartTransactionRequest = { - connectorId, - ...(!Utils.isUndefined(idTag) ? { idTag } : { idTag: Constants.DEFAULT_IDTAG }), - meterStart: this.chargingStation.getEnergyActiveImportRegisterByConnectorId(connectorId), - timestamp: new Date().toISOString(), - }; - return (await this.sendMessage( - Utils.generateUUID(), - payload, - OCPP16RequestCommand.START_TRANSACTION - )) as OCPP16StartTransactionResponse; - } - - public async sendStopTransaction( - transactionId: number, - meterStop: number, - idTag?: string, - reason: OCPP16StopTransactionReason = OCPP16StopTransactionReason.NONE - ): Promise { - let connectorId: number; - for (const id of this.chargingStation.connectors.keys()) { - if (id > 0 && this.chargingStation.getConnectorStatus(id)?.transactionId === transactionId) { - connectorId = id; - break; - } + protected getRequestPayloadValidationSchema( + chargingStation: ChargingStation, + commandName: OCPP16RequestCommand + ): JSONSchemaType | false { + if (this.jsonSchemas.has(commandName) === true) { + return this.jsonSchemas.get(commandName); } - const transactionEndMeterValue = OCPP16ServiceUtils.buildTransactionEndMeterValue( - this.chargingStation, - connectorId, - meterStop + logger.warn( + `${chargingStation.logPrefix()} ${moduleName}.getPayloadValidationSchema: No JSON schema found for command ${commandName} PDU validation` ); - // FIXME: should be a callback, each OCPP commands implementation must do only one job - this.chargingStation.getBeginEndMeterValues() && - this.chargingStation.getOcppStrictCompliance() && - !this.chargingStation.getOutOfOrderEndMeterValues() && - (await this.sendTransactionEndMeterValues( - connectorId, - transactionId, - transactionEndMeterValue - )); - const payload: StopTransactionRequest = { - transactionId, - ...(!Utils.isUndefined(idTag) && { idTag }), - meterStop, - timestamp: new Date().toISOString(), - ...(reason && { reason }), - ...(this.chargingStation.getTransactionDataMeterValues() && { - transactionData: OCPP16ServiceUtils.buildTransactionDataMeterValues( - this.chargingStation.getConnectorStatus(connectorId).transactionBeginMeterValue, - transactionEndMeterValue - ), - }), - }; - return (await this.sendMessage( - Utils.generateUUID(), - payload, - OCPP16RequestCommand.STOP_TRANSACTION - )) as OCPP16StartTransactionResponse; + return false; } - public async sendMeterValues( - connectorId: number, - transactionId: number, - interval: number - ): Promise { - const meterValue: OCPP16MeterValue = OCPP16ServiceUtils.buildMeterValue( - this.chargingStation, - connectorId, - transactionId, - interval - ); - 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 { - 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 { - const payload: MeterValuesRequest = { - connectorId, - transactionId, - meterValue: [endMeterValue], - }; - await this.sendMessage(Utils.generateUUID(), payload, OCPP16RequestCommand.METER_VALUES); - } - - public async sendDiagnosticsStatusNotification( - diagnosticsStatus: OCPP16DiagnosticsStatus - ): Promise { - const payload: DiagnosticsStatusNotificationRequest = { - status: diagnosticsStatus, - }; - await this.sendMessage( - Utils.generateUUID(), - payload, - OCPP16RequestCommand.DIAGNOSTICS_STATUS_NOTIFICATION - ); - } - - private buildCommandPayload( + private buildRequestPayload( + 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, @@ -245,64 +234,75 @@ export default class OCPP16RequestService extends OCPPRequestService { ...(!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, - errorCode: commandParams?.errorCode, status: commandParams?.status, - } as StatusNotificationRequest; + errorCode: commandParams?.errorCode, + } 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; + timestamp: new Date(), + } as unknown as Request; case OCPP16RequestCommand.STOP_TRANSACTION: + 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, - timestamp: new Date().toISOString(), - ...(commandParams?.reason && { reason: commandParams.reason }), - ...(this.chargingStation.getTransactionDataMeterValues() && { + idTag: + commandParams?.idTag ?? + chargingStation.getTransactionIdTag(commandParams?.transactionId as number), + meterStop: commandParams?.meterStop ?? energyActiveImportRegister, + timestamp: new Date(), + reason: commandParams?.reason, + ...(chargingStation.getTransactionDataMeterValues() && { transactionData: OCPP16ServiceUtils.buildTransactionDataMeterValues( - this.chargingStation.getConnectorStatus(commandParams?.connectorId as number) - .transactionBeginMeterValue, + chargingStation.getConnectorStatus(connectorId).transactionBeginMeterValue, OCPP16ServiceUtils.buildTransactionEndMeterValue( - this.chargingStation, - commandParams?.connectorId as number, - commandParams?.meterStop as number + chargingStation, + connectorId, + (commandParams?.meterStop as number) ?? energyActiveImportRegister ) ), }), - } as StopTransactionRequest; + } 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( 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 ); } }