X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fcharging-station%2Focpp%2F1.6%2FOCPP16RequestService.ts;h=1d571b042dfdedecab3add913269c88171714926;hb=617cad0c86c3fea53b56a738bb0d6ddc3da05237;hp=9fa6124312ac12a14376c80c17504f717b65455e;hpb=4d20f040ab91f06c9399dbaf084358183cf75314;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 9fa61243..1d571b04 100644 --- a/src/charging-station/ocpp/1.6/OCPP16RequestService.ts +++ b/src/charging-station/ocpp/1.6/OCPP16RequestService.ts @@ -1,42 +1,38 @@ // 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 { 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 type { ChargingStation } from '../../../charging-station'; +import { OCPPError } from '../../../exception'; import { + ErrorType, + type JsonObject, + type JsonType, + type OCPP16AuthorizeRequest, type OCPP16BootNotificationRequest, 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'; +import { Constants, Utils } from '../../../utils'; +import { + OCPP16ServiceUtils, + OCPPConstants, + OCPPRequestService, + type OCPPResponseService, +} from '../internal'; const moduleName = 'OCPP16RequestService'; -export default class OCPP16RequestService extends OCPPRequestService { +export class OCPP16RequestService extends OCPPRequestService { protected jsonSchemas: Map>; public constructor(ocppResponseService: OCPPResponseService) { @@ -47,62 +43,82 @@ export default class OCPP16RequestService extends OCPPRequestService { this.jsonSchemas = new Map>([ [ OCPP16RequestCommand.AUTHORIZE, - this.parseJsonSchemaFile( - '../../../assets/json-schemas/ocpp/1.6/Authorize.json' + OCPP16ServiceUtils.parseJsonSchemaFile( + '../../../assets/json-schemas/ocpp/1.6/Authorize.json', + moduleName, + 'constructor' ), ], [ OCPP16RequestCommand.BOOT_NOTIFICATION, - this.parseJsonSchemaFile( - '../../../assets/json-schemas/ocpp/1.6/BootNotification.json' + OCPP16ServiceUtils.parseJsonSchemaFile( + '../../../assets/json-schemas/ocpp/1.6/BootNotification.json', + moduleName, + 'constructor' ), ], [ OCPP16RequestCommand.DIAGNOSTICS_STATUS_NOTIFICATION, - this.parseJsonSchemaFile( - '../../../assets/json-schemas/ocpp/1.6/DiagnosticsStatusNotification.json' + OCPP16ServiceUtils.parseJsonSchemaFile( + '../../../assets/json-schemas/ocpp/1.6/DiagnosticsStatusNotification.json', + moduleName, + 'constructor' ), ], [ OCPP16RequestCommand.HEARTBEAT, - this.parseJsonSchemaFile( - '../../../assets/json-schemas/ocpp/1.6/Heartbeat.json' + OCPP16ServiceUtils.parseJsonSchemaFile( + '../../../assets/json-schemas/ocpp/1.6/Heartbeat.json', + moduleName, + 'constructor' ), ], [ OCPP16RequestCommand.METER_VALUES, - this.parseJsonSchemaFile( - '../../../assets/json-schemas/ocpp/1.6/MeterValues.json' + OCPP16ServiceUtils.parseJsonSchemaFile( + '../../../assets/json-schemas/ocpp/1.6/MeterValues.json', + moduleName, + 'constructor' ), ], [ OCPP16RequestCommand.STATUS_NOTIFICATION, - this.parseJsonSchemaFile( - '../../../assets/json-schemas/ocpp/1.6/StatusNotification.json' + OCPP16ServiceUtils.parseJsonSchemaFile( + '../../../assets/json-schemas/ocpp/1.6/StatusNotification.json', + moduleName, + 'constructor' ), ], [ OCPP16RequestCommand.START_TRANSACTION, - this.parseJsonSchemaFile( - '../../../assets/json-schemas/ocpp/1.6/StartTransaction.json' + OCPP16ServiceUtils.parseJsonSchemaFile( + '../../../assets/json-schemas/ocpp/1.6/StartTransaction.json', + moduleName, + 'constructor' ), ], [ OCPP16RequestCommand.STOP_TRANSACTION, - this.parseJsonSchemaFile( - '../../../assets/json-schemas/ocpp/1.6/StopTransaction.json' + OCPP16ServiceUtils.parseJsonSchemaFile( + '../../../assets/json-schemas/ocpp/1.6/StopTransaction.json', + moduleName, + 'constructor' ), ], [ OCPP16RequestCommand.DATA_TRANSFER, - this.parseJsonSchemaFile( - '../../../assets/json-schemas/ocpp/1.6/DataTransfer.json' + OCPP16ServiceUtils.parseJsonSchemaFile( + '../../../assets/json-schemas/ocpp/1.6/DataTransfer.json', + moduleName, + 'constructor' ), ], [ OCPP16RequestCommand.FIRMWARE_STATUS_NOTIFICATION, - this.parseJsonSchemaFile( - '../../../assets/json-schemas/ocpp/1.6/FirmwareStatusNotification.json' + OCPP16ServiceUtils.parseJsonSchemaFile( + '../../../assets/json-schemas/ocpp/1.6/FirmwareStatusNotification.json', + moduleName, + 'constructor' ), ], ]); @@ -116,18 +132,13 @@ export default class OCPP16RequestService extends OCPPRequestService { params?: RequestParams ): Promise { if (OCPP16ServiceUtils.isRequestCommandSupported(chargingStation, commandName) === true) { - const requestPayload = this.buildRequestPayload( - chargingStation, - commandName, - commandParams - ); return (await this.sendMessage( chargingStation, Utils.generateUUID(), - requestPayload, + 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( @@ -147,118 +158,55 @@ export default class OCPP16RequestService extends OCPPRequestService { 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 OCPPConstants.OCPP_REQUEST_EMPTY 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, - ...(!Utils.isUndefined(commandParams?.info) && { - info: commandParams?.info, - }), - ...(!Utils.isUndefined(commandParams?.timestamp) && { - timestamp: commandParams?.timestamp, - }), - ...(!Utils.isUndefined(commandParams?.vendorId) && { - vendorId: commandParams?.vendorId, - }), - ...(!Utils.isUndefined(commandParams?.vendorErrorCode) && { - vendorErrorCode: commandParams?.vendorErrorCode, - }), + idTag: Constants.DEFAULT_IDTAG, + ...commandParams, } as unknown as Request; + case OCPP16RequestCommand.HEARTBEAT: + return OCPPConstants.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: - commandParams?.meterStart ?? - chargingStation.getEnergyActiveImportRegisterByConnectorId( - commandParams?.connectorId as number - ), - timestamp: commandParams?.timestamp ?? new Date(), - ...(!Utils.isUndefined(commandParams?.reservationId) && { - reservationId: commandParams?.reservationId, - }), + idTag: Constants.DEFAULT_IDTAG, + meterStart: chargingStation.getEnergyActiveImportRegisterByConnectorId( + commandParams?.connectorId as number, + true + ), + timestamp: new Date(), + ...commandParams, } as unknown as Request; case OCPP16RequestCommand.STOP_TRANSACTION: chargingStation.getTransactionDataMeterValues() && - Utils.isNullOrUndefined(commandParams?.transactionData) && (connectorId = chargingStation.getConnectorIdByTransactionId( commandParams?.transactionId as number )); - Utils.isNullOrUndefined(commandParams?.meterStop) && - (energyActiveImportRegister = - chargingStation.getEnergyActiveImportRegisterByTransactionId( - commandParams?.transactionId as number, - true - )); + 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, - timestamp: commandParams?.timestamp ?? new Date(), - ...(!Utils.isUndefined(commandParams?.reason) && { - reason: commandParams?.reason, + idTag: chargingStation.getTransactionIdTag(commandParams?.transactionId as number), + meterStop: energyActiveImportRegister, + timestamp: new Date(), + ...(chargingStation.getTransactionDataMeterValues() && { + transactionData: OCPP16ServiceUtils.buildTransactionDataMeterValues( + chargingStation.getConnectorStatus(connectorId).transactionBeginMeterValue, + OCPP16ServiceUtils.buildTransactionEndMeterValue( + chargingStation, + connectorId, + energyActiveImportRegister + ) + ), }), - ...(!Utils.isUndefined(commandParams?.transactionData) - ? { transactionData: commandParams?.transactionData } - : chargingStation.getTransactionDataMeterValues() && { - transactionData: OCPP16ServiceUtils.buildTransactionDataMeterValues( - chargingStation.getConnectorStatus(connectorId).transactionBeginMeterValue, - OCPP16ServiceUtils.buildTransactionEndMeterValue( - chargingStation, - connectorId, - (commandParams?.meterStop as number) ?? energyActiveImportRegister - ) - ), - }), + ...commandParams, } 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( @@ -270,13 +218,4 @@ export default class OCPP16RequestService extends OCPPRequestService { ); } } - - private parseJsonSchemaFile(relativePath: string): JSONSchemaType { - return JSON.parse( - fs.readFileSync( - path.resolve(path.dirname(fileURLToPath(import.meta.url)), relativePath), - 'utf8' - ) - ) as JSONSchemaType; - } }