X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fcharging-station%2Focpp%2F1.6%2FOCPP16RequestService.ts;h=a7bacae9b2814fd5cc813fcb77d43db2964125b8;hb=298be10c5c800e43b0b9dcd6c50f6d49e2cb786b;hp=bf63ba2e6b84e764bc27728524171caec64220f2;hpb=78202038ffd2aca15aa97f45bc66ba42f40f2ec4;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 bf63ba2e..a7bacae9 100644 --- a/src/charging-station/ocpp/1.6/OCPP16RequestService.ts +++ b/src/charging-station/ocpp/1.6/OCPP16RequestService.ts @@ -1,111 +1,167 @@ -// Partial Copyright Jerome Benoit. 2021-2023. All Rights Reserved. +// Partial Copyright Jerome Benoit. 2021-2024. All Rights Reserved. -import fs from 'fs'; -import path from 'path'; -import { fileURLToPath } from 'url'; +import type { ValidateFunction } from 'ajv' -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 { 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 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 jsonSchemasValidateFunction: 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.jsonSchemasValidateFunction = new Map>([ [ OCPP16RequestCommand.AUTHORIZE, - this.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, - this.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, - this.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, - this.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, - this.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, - this.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, - this.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, - this.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, - this.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, - this.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( @@ -114,19 +170,15 @@ export default class OCPP16RequestService extends OCPPRequestService { commandParams?: JsonType, params?: RequestParams ): Promise { - if (OCPP16ServiceUtils.isRequestCommandSupported(chargingStation, commandName) === true) { - const requestPayload = this.buildRequestPayload( - chargingStation, - commandName, - commandParams - ); + // 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(), - requestPayload, + 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( @@ -134,7 +186,7 @@ export default class OCPP16RequestService extends OCPPRequestService { `Unsupported OCPP command '${commandName}'`, commandName, commandParams - ); + ) } private buildRequestPayload( @@ -142,99 +194,74 @@ 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.AUTHORIZE: - return { - ...(!Utils.isUndefined(commandParams?.idTag) - ? { idTag: commandParams.idTag } - : { idTag: Constants.DEFAULT_IDTAG }), - } as unknown as Request; 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 unknown as Request; case OCPP16RequestCommand.DIAGNOSTICS_STATUS_NOTIFICATION: case OCPP16RequestCommand.FIRMWARE_STATUS_NOTIFICATION: - return { - status: commandParams?.status, - } as unknown as Request; - case OCPP16RequestCommand.HEARTBEAT: - return {} as unknown as Request; case OCPP16RequestCommand.METER_VALUES: - return { - connectorId: commandParams?.connectorId, - transactionId: commandParams?.transactionId, - meterValue: commandParams?.meterValue, - } as unknown as Request; 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 unknown as Request; + 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 }), + idTag: Constants.DEFAULT_IDTAG, meterStart: chargingStation.getEnergyActiveImportRegisterByConnectorId( - commandParams?.connectorId as number + commandParams.connectorId as number, + true ), timestamp: new Date(), - } 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: - connectorId = chargingStation.getConnectorIdByTransactionId( - commandParams?.transactionId as number - ); - commandParams?.meterStop && - (energyActiveImportRegister = - chargingStation.getEnergyActiveImportRegisterByTransactionId( - commandParams?.transactionId as number, - true - )); + chargingStation.stationInfo?.transactionDataMeterValues === true && + (connectorId = chargingStation.getConnectorIdByTransactionId( + commandParams.transactionId as number + )) + energyActiveImportRegister = chargingStation.getEnergyActiveImportRegisterByTransactionId( + commandParams.transactionId as number, + true + ) return { - transactionId: commandParams?.transactionId, - idTag: - commandParams?.idTag ?? - chargingStation.getTransactionIdTag(commandParams?.transactionId as number), - meterStop: commandParams?.meterStop ?? energyActiveImportRegister, + idTag: chargingStation.getTransactionIdTag(commandParams.transactionId as number), + meterStop: energyActiveImportRegister, timestamp: new Date(), - reason: commandParams?.reason, - ...(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, - (commandParams?.meterStop as number) ?? energyActiveImportRegister + // eslint-disable-next-line @typescript-eslint/no-non-null-assertion + connectorId!, + energyActiveImportRegister ) - ), + ) }), - } as unknown as Request; - case OCPP16RequestCommand.DATA_TRANSFER: - return 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( @@ -243,16 +270,7 @@ export default class OCPP16RequestService extends OCPPRequestService { `Unsupported OCPP command '${commandName}'`, commandName, commandParams - ); + ) } } - - private parseJsonSchemaFile(relativePath: string): JSONSchemaType { - return JSON.parse( - fs.readFileSync( - path.resolve(path.dirname(fileURLToPath(import.meta.url)), relativePath), - 'utf8' - ) - ) as JSONSchemaType; - } }