X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fcharging-station%2Focpp%2F1.6%2FOCPP16RequestService.ts;h=b9643469a791831937d9774e4ef0b9fb68abacbf;hb=923ac728c8636e5d8e7cc387ade07990385c6fdd;hp=f184c7ab24bc8c7b21bfc553b9298f39003df7fc;hpb=bad85ee42a1c6a12be50560e535331dadff453b4;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 f184c7ab..b9643469 100644 --- a/src/charging-station/ocpp/1.6/OCPP16RequestService.ts +++ b/src/charging-station/ocpp/1.6/OCPP16RequestService.ts @@ -1,163 +1,286 @@ -// Partial Copyright Jerome Benoit. 2021. All Rights Reserved. +// Partial Copyright Jerome Benoit. 2021-2024. All Rights Reserved. +import type { ValidateFunction } from 'ajv' + +import type { ChargingStation } from '../../../charging-station/index.js' +import { OCPPError } from '../../../exception/index.js' import { - AuthorizeRequest, - StartTransactionRequest, - StopTransactionRequest, -} from '../../../types/ocpp/1.6/Transaction'; -import { - DiagnosticsStatusNotificationRequest, - HeartbeatRequest, - OCPP16BootNotificationRequest, + ErrorType, + type JsonObject, + type JsonType, + type OCPP16AuthorizeRequest, + type OCPP16BootNotificationRequest, + OCPP16ChargePointStatus, + type OCPP16DataTransferRequest, + type OCPP16DiagnosticsStatusNotificationRequest, + type OCPP16FirmwareStatusNotificationRequest, + type OCPP16HeartbeatRequest, + type OCPP16MeterValuesRequest, OCPP16RequestCommand, - StatusNotificationRequest, -} from '../../../types/ocpp/1.6/Requests'; -import { ResponseType, SendParams } from '../../../types/ocpp/Requests'; + type OCPP16StartTransactionRequest, + type OCPP16StatusNotificationRequest, + type OCPP16StopTransactionRequest, + OCPPVersion, + type RequestParams +} from '../../../types/index.js' +import { Constants, generateUUID } from '../../../utils/index.js' +import { OCPPRequestService } from '../OCPPRequestService.js' +import type { OCPPResponseService } from '../OCPPResponseService.js' +import { OCPP16Constants } from './OCPP16Constants.js' +import { OCPP16ServiceUtils } from './OCPP16ServiceUtils.js' -import type ChargingStation from '../../ChargingStation'; -import Constants from '../../../utils/Constants'; -import { ErrorType } from '../../../types/ocpp/ErrorType'; -import { JsonType } from '../../../types/JsonType'; -import { MeterValuesRequest } from '../../../types/ocpp/1.6/MeterValues'; -import { OCPP16DiagnosticsStatus } from '../../../types/ocpp/1.6/DiagnosticsStatus'; -import { OCPP16ServiceUtils } from './OCPP16ServiceUtils'; -import OCPPError from '../../../exception/OCPPError'; -import OCPPRequestService from '../OCPPRequestService'; -import type OCPPResponseService from '../OCPPResponseService'; -import Utils from '../../../utils/Utils'; +const moduleName = 'OCPP16RequestService' -const moduleName = 'OCPP16RequestService'; +export class OCPP16RequestService extends OCPPRequestService { + protected payloadValidateFunctions: Map> -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); + 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.payloadValidateFunctions = new Map>([ + [ + OCPP16RequestCommand.AUTHORIZE, + this.ajv + .compile( + OCPP16ServiceUtils.parseJsonSchemaFile( + 'assets/json-schemas/ocpp/1.6/Authorize.json', + moduleName, + 'constructor' + ) + ) + .bind(this) + ], + [ + OCPP16RequestCommand.BOOT_NOTIFICATION, + this.ajv + .compile( + OCPP16ServiceUtils.parseJsonSchemaFile( + 'assets/json-schemas/ocpp/1.6/BootNotification.json', + moduleName, + 'constructor' + ) + ) + .bind(this) + ], + [ + OCPP16RequestCommand.DIAGNOSTICS_STATUS_NOTIFICATION, + this.ajv + .compile( + OCPP16ServiceUtils.parseJsonSchemaFile( + 'assets/json-schemas/ocpp/1.6/DiagnosticsStatusNotification.json', + moduleName, + 'constructor' + ) + ) + .bind(this) + ], + [ + OCPP16RequestCommand.HEARTBEAT, + this.ajv + .compile( + OCPP16ServiceUtils.parseJsonSchemaFile( + 'assets/json-schemas/ocpp/1.6/Heartbeat.json', + moduleName, + 'constructor' + ) + ) + .bind(this) + ], + [ + OCPP16RequestCommand.METER_VALUES, + this.ajv + .compile( + OCPP16ServiceUtils.parseJsonSchemaFile( + 'assets/json-schemas/ocpp/1.6/MeterValues.json', + moduleName, + 'constructor' + ) + ) + .bind(this) + ], + [ + OCPP16RequestCommand.STATUS_NOTIFICATION, + this.ajv + .compile( + OCPP16ServiceUtils.parseJsonSchemaFile( + 'assets/json-schemas/ocpp/1.6/StatusNotification.json', + moduleName, + 'constructor' + ) + ) + .bind(this) + ], + [ + OCPP16RequestCommand.START_TRANSACTION, + this.ajv + .compile( + OCPP16ServiceUtils.parseJsonSchemaFile( + 'assets/json-schemas/ocpp/1.6/StartTransaction.json', + moduleName, + 'constructor' + ) + ) + .bind(this) + ], + [ + OCPP16RequestCommand.STOP_TRANSACTION, + this.ajv + .compile( + OCPP16ServiceUtils.parseJsonSchemaFile( + 'assets/json-schemas/ocpp/1.6/StopTransaction.json', + moduleName, + 'constructor' + ) + ) + .bind(this) + ], + [ + OCPP16RequestCommand.DATA_TRANSFER, + this.ajv + .compile( + OCPP16ServiceUtils.parseJsonSchemaFile( + 'assets/json-schemas/ocpp/1.6/DataTransfer.json', + moduleName, + 'constructor' + ) + ) + .bind(this) + ], + [ + OCPP16RequestCommand.FIRMWARE_STATUS_NOTIFICATION, + this.ajv + .compile( + OCPP16ServiceUtils.parseJsonSchemaFile( + 'assets/json-schemas/ocpp/1.6/FirmwareStatusNotification.json', + moduleName, + 'constructor' + ) + ) + .bind(this) + ] + ]) + this.buildRequestPayload = this.buildRequestPayload.bind(this) } - public async sendMessageHandler( + public async requestHandler( + chargingStation: ChargingStation, commandName: OCPP16RequestCommand, - commandParams?: JsonType, - params?: SendParams + commandParams?: RequestType, + params?: RequestParams ): Promise { - if (Object.values(OCPP16RequestCommand).includes(commandName)) { - return this.sendMessage( - Utils.generateUUID(), - this.buildCommandPayload(commandName, commandParams), + // FIXME?: add sanity checks on charging station availability, connector availability, connector status, etc. + if (OCPP16ServiceUtils.isRequestCommandSupported(chargingStation, commandName)) { + // Post request actions hook + switch (commandName) { + case OCPP16RequestCommand.START_TRANSACTION: + await OCPP16ServiceUtils.sendAndSetConnectorStatus( + chargingStation, + (commandParams as OCPP16StartTransactionRequest).connectorId, + OCPP16ChargePointStatus.Preparing + ) + break + } + return (await this.sendMessage( + chargingStation, + generateUUID(), + this.buildRequestPayload(chargingStation, commandName, commandParams), commandName, params - ); + )) 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 buildCommandPayload( + private buildRequestPayload( + chargingStation: ChargingStation, commandName: OCPP16RequestCommand, commandParams?: JsonType - ): JsonType { - let connectorId: number; + ): Request { + let connectorId: number | undefined + 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; 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 OCPP16BootNotificationRequest; case OCPP16RequestCommand.DIAGNOSTICS_STATUS_NOTIFICATION: - return { - status: commandParams?.diagnosticsStatus, - } as DiagnosticsStatusNotificationRequest; - case OCPP16RequestCommand.HEARTBEAT: - return {} as HeartbeatRequest; + case OCPP16RequestCommand.FIRMWARE_STATUS_NOTIFICATION: case OCPP16RequestCommand.METER_VALUES: - return { - connectorId: commandParams?.connectorId, - transactionId: commandParams?.transactionId, - meterValue: Array.isArray(commandParams?.meterValues) - ? commandParams?.meterValues - : [commandParams?.meterValue], - } as MeterValuesRequest; 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, - } as StatusNotificationRequest; + 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(), - } as StartTransactionRequest; + timestamp: new Date(), + ...(OCPP16ServiceUtils.hasReservation( + chargingStation, + commandParams.connectorId as number, + commandParams.idTag as string + ) && { + // eslint-disable-next-line @typescript-eslint/no-non-null-assertion + reservationId: chargingStation.getReservationBy( + 'connectorId', + chargingStation.getConnectorStatus(0)?.status === OCPP16ChargePointStatus.Reserved + ? 0 + : (commandParams.connectorId as number) + )!.reservationId + }), + ...commandParams + } as unknown as Request case OCPP16RequestCommand.STOP_TRANSACTION: - for (const id of this.chargingStation.connectors.keys()) { - if ( - id > 0 && - this.chargingStation.getConnectorStatus(id)?.transactionId === - commandParams?.transactionId - ) { - connectorId = id; - break; - } - } + chargingStation.stationInfo?.transactionDataMeterValues === true && + (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.stationInfo?.transactionDataMeterValues === true && { transactionData: OCPP16ServiceUtils.buildTransactionDataMeterValues( - this.chargingStation.getConnectorStatus(connectorId).transactionBeginMeterValue, + // eslint-disable-next-line @typescript-eslint/no-non-null-assertion + chargingStation.getConnectorStatus(connectorId!)!.transactionBeginMeterValue!, OCPP16ServiceUtils.buildTransactionEndMeterValue( - this.chargingStation, - connectorId, - commandParams?.meterStop as number + chargingStation, + // eslint-disable-next-line @typescript-eslint/no-non-null-assertion + connectorId!, + energyActiveImportRegister ) - ), + ) }), - } as StopTransactionRequest; + ...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 + ) } } }