X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fcharging-station%2Focpp%2F1.6%2FOCPP16RequestService.ts;h=74c00daa8f42335383b7d5d7f603cdd40fd90303;hb=dd21af153ed64c6220b6b14a5165c11443032f4f;hp=845506958fb633500504a04ca3eff118df2382cb;hpb=130783a74f495abcb198b7f01abe19dab4f7fb47;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 84550695..74c00daa 100644 --- a/src/charging-station/ocpp/1.6/OCPP16RequestService.ts +++ b/src/charging-station/ocpp/1.6/OCPP16RequestService.ts @@ -1,108 +1,167 @@ -// Partial Copyright Jerome Benoit. 2021-2023. All Rights Reserved. +// Partial Copyright Jerome Benoit. 2021-2024. All Rights Reserved. -import type { JSONSchemaType } from 'ajv'; +import type { ValidateFunction } 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 { OCPP16Constants } from './OCPP16Constants.js' +import { OCPP16ServiceUtils } from './OCPP16ServiceUtils.js' +import type { ChargingStation } from '../../../charging-station/index.js' +import { OCPPError } from '../../../exception/index.js' import { + ErrorType, + type JsonObject, + type JsonType, + type OCPP16AuthorizeRequest, type OCPP16BootNotificationRequest, + OCPP16ChargePointStatus, type OCPP16DataTransferRequest, type OCPP16DiagnosticsStatusNotificationRequest, type OCPP16FirmwareStatusNotificationRequest, type OCPP16HeartbeatRequest, + type OCPP16MeterValuesRequest, OCPP16RequestCommand, + type OCPP16StartTransactionRequest, type 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 { OCPPVersion } from '../../../types/ocpp/OCPPVersion'; -import type { RequestParams } from '../../../types/ocpp/Requests'; -import Constants from '../../../utils/Constants'; -import Utils from '../../../utils/Utils'; -import type ChargingStation from '../../ChargingStation'; -import OCPPConstants from '../OCPPConstants'; -import OCPPRequestService from '../OCPPRequestService'; -import type OCPPResponseService from '../OCPPResponseService'; + 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' -const moduleName = 'OCPP16RequestService'; +const moduleName = 'OCPP16RequestService' -export default class OCPP16RequestService extends OCPPRequestService { - protected jsonSchemas: Map>; +export class OCPP16RequestService extends OCPPRequestService { + protected payloadValidateFunctions: Map> - 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.jsonSchemas = new Map>([ + 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, - OCPP16ServiceUtils.parseJsonSchemaFile( - '../../../assets/json-schemas/ocpp/1.6/Authorize.json' - ), + this.ajv + .compile( + OCPP16ServiceUtils.parseJsonSchemaFile( + 'assets/json-schemas/ocpp/1.6/Authorize.json', + moduleName, + 'constructor' + ) + ) + .bind(this) ], [ OCPP16RequestCommand.BOOT_NOTIFICATION, - OCPP16ServiceUtils.parseJsonSchemaFile( - '../../../assets/json-schemas/ocpp/1.6/BootNotification.json' - ), + this.ajv + .compile( + OCPP16ServiceUtils.parseJsonSchemaFile( + 'assets/json-schemas/ocpp/1.6/BootNotification.json', + moduleName, + 'constructor' + ) + ) + .bind(this) ], [ OCPP16RequestCommand.DIAGNOSTICS_STATUS_NOTIFICATION, - OCPP16ServiceUtils.parseJsonSchemaFile( - '../../../assets/json-schemas/ocpp/1.6/DiagnosticsStatusNotification.json' - ), + this.ajv + .compile( + OCPP16ServiceUtils.parseJsonSchemaFile( + 'assets/json-schemas/ocpp/1.6/DiagnosticsStatusNotification.json', + moduleName, + 'constructor' + ) + ) + .bind(this) ], [ OCPP16RequestCommand.HEARTBEAT, - OCPP16ServiceUtils.parseJsonSchemaFile( - '../../../assets/json-schemas/ocpp/1.6/Heartbeat.json' - ), + this.ajv + .compile( + OCPP16ServiceUtils.parseJsonSchemaFile( + 'assets/json-schemas/ocpp/1.6/Heartbeat.json', + moduleName, + 'constructor' + ) + ) + .bind(this) ], [ OCPP16RequestCommand.METER_VALUES, - OCPP16ServiceUtils.parseJsonSchemaFile( - '../../../assets/json-schemas/ocpp/1.6/MeterValues.json' - ), + this.ajv + .compile( + OCPP16ServiceUtils.parseJsonSchemaFile( + 'assets/json-schemas/ocpp/1.6/MeterValues.json', + moduleName, + 'constructor' + ) + ) + .bind(this) ], [ OCPP16RequestCommand.STATUS_NOTIFICATION, - OCPP16ServiceUtils.parseJsonSchemaFile( - '../../../assets/json-schemas/ocpp/1.6/StatusNotification.json' - ), + this.ajv + .compile( + OCPP16ServiceUtils.parseJsonSchemaFile( + 'assets/json-schemas/ocpp/1.6/StatusNotification.json', + moduleName, + 'constructor' + ) + ) + .bind(this) ], [ OCPP16RequestCommand.START_TRANSACTION, - OCPP16ServiceUtils.parseJsonSchemaFile( - '../../../assets/json-schemas/ocpp/1.6/StartTransaction.json' - ), + this.ajv + .compile( + OCPP16ServiceUtils.parseJsonSchemaFile( + 'assets/json-schemas/ocpp/1.6/StartTransaction.json', + moduleName, + 'constructor' + ) + ) + .bind(this) ], [ OCPP16RequestCommand.STOP_TRANSACTION, - OCPP16ServiceUtils.parseJsonSchemaFile( - '../../../assets/json-schemas/ocpp/1.6/StopTransaction.json' - ), + this.ajv + .compile( + OCPP16ServiceUtils.parseJsonSchemaFile( + 'assets/json-schemas/ocpp/1.6/StopTransaction.json', + moduleName, + 'constructor' + ) + ) + .bind(this) ], [ OCPP16RequestCommand.DATA_TRANSFER, - OCPP16ServiceUtils.parseJsonSchemaFile( - '../../../assets/json-schemas/ocpp/1.6/DataTransfer.json' - ), + this.ajv + .compile( + OCPP16ServiceUtils.parseJsonSchemaFile( + 'assets/json-schemas/ocpp/1.6/DataTransfer.json', + moduleName, + 'constructor' + ) + ) + .bind(this) ], [ OCPP16RequestCommand.FIRMWARE_STATUS_NOTIFICATION, - OCPP16ServiceUtils.parseJsonSchemaFile( - '../../../assets/json-schemas/ocpp/1.6/FirmwareStatusNotification.json' - ), - ], - ]); - this.buildRequestPayload.bind(this); + 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 requestHandler( @@ -111,14 +170,15 @@ export default class OCPP16RequestService extends OCPPRequestService { commandParams?: JsonType, params?: RequestParams ): Promise { - if (OCPP16ServiceUtils.isRequestCommandSupported(chargingStation, commandName) === true) { + // FIXME?: add sanity checks on charging station availability, connector availability, connector status, etc. + if (OCPP16ServiceUtils.isRequestCommandSupported(chargingStation, commandName)) { return (await this.sendMessage( chargingStation, - Utils.generateUUID(), + generateUUID(), 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( @@ -126,7 +186,7 @@ export default class OCPP16RequestService extends OCPPRequestService { `Unsupported OCPP command '${commandName}'`, commandName, commandParams - ); + ) } private buildRequestPayload( @@ -134,9 +194,9 @@ export default class OCPP16RequestService extends OCPPRequestService { commandName: OCPP16RequestCommand, commandParams?: JsonType ): Request { - let connectorId: number; - let energyActiveImportRegister: number; - commandParams = commandParams as JsonObject; + let connectorId: number | undefined + let energyActiveImportRegister: number + commandParams = commandParams as JsonObject switch (commandName) { case OCPP16RequestCommand.BOOT_NOTIFICATION: case OCPP16RequestCommand.DIAGNOSTICS_STATUS_NOTIFICATION: @@ -144,49 +204,64 @@ export default class OCPP16RequestService extends OCPPRequestService { case OCPP16RequestCommand.METER_VALUES: case OCPP16RequestCommand.STATUS_NOTIFICATION: case OCPP16RequestCommand.DATA_TRANSFER: - return commandParams as unknown as Request; + return commandParams as unknown as Request case OCPP16RequestCommand.AUTHORIZE: return { idTag: Constants.DEFAULT_IDTAG, - ...commandParams, - } as unknown as Request; + ...commandParams + } as unknown as Request case OCPP16RequestCommand.HEARTBEAT: - return OCPPConstants.OCPP_REQUEST_EMPTY as unknown as Request; + return OCPP16Constants.OCPP_REQUEST_EMPTY as unknown as Request case OCPP16RequestCommand.START_TRANSACTION: return { idTag: Constants.DEFAULT_IDTAG, meterStart: chargingStation.getEnergyActiveImportRegisterByConnectorId( - commandParams?.connectorId as number, + commandParams.connectorId as number, true ), timestamp: new Date(), - ...commandParams, - } as unknown as Request; + ...(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: - chargingStation.getTransactionDataMeterValues() && + chargingStation.stationInfo?.transactionDataMeterValues === true && (connectorId = chargingStation.getConnectorIdByTransactionId( - commandParams?.transactionId as number - )); + commandParams.transactionId as number + )) energyActiveImportRegister = chargingStation.getEnergyActiveImportRegisterByTransactionId( - commandParams?.transactionId as number, + commandParams.transactionId as number, true - ); + ) return { - idTag: chargingStation.getTransactionIdTag(commandParams?.transactionId as number), + idTag: chargingStation.getTransactionIdTag(commandParams.transactionId as number), meterStop: energyActiveImportRegister, timestamp: new Date(), - ...(chargingStation.getTransactionDataMeterValues() && { + ...(chargingStation.stationInfo?.transactionDataMeterValues === true && { transactionData: OCPP16ServiceUtils.buildTransactionDataMeterValues( - chargingStation.getConnectorStatus(connectorId).transactionBeginMeterValue, + // eslint-disable-next-line @typescript-eslint/no-non-null-assertion + chargingStation.getConnectorStatus(connectorId!)!.transactionBeginMeterValue!, OCPP16ServiceUtils.buildTransactionEndMeterValue( chargingStation, - connectorId, + // eslint-disable-next-line @typescript-eslint/no-non-null-assertion + connectorId!, energyActiveImportRegister ) - ), + ) }), - ...commandParams, - } as unknown as Request; + ...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( @@ -195,7 +270,7 @@ export default class OCPP16RequestService extends OCPPRequestService { `Unsupported OCPP command '${commandName}'`, commandName, commandParams - ); + ) } } }