X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fcharging-station%2Focpp%2FOCPPServiceUtils.ts;h=33637c65a9e7501ea045cee9fd521863b27c1f0a;hb=aef5c03ddd1489b52df3801284d704342d60a41c;hp=7a1fde29cc1c9af7eb4171fdbaf9ae4ad3042b6d;hpb=f126aa15c2efd27cc174011b8eb4e5bfdf27b73c;p=e-mobility-charging-stations-simulator.git diff --git a/src/charging-station/ocpp/OCPPServiceUtils.ts b/src/charging-station/ocpp/OCPPServiceUtils.ts index 7a1fde29..33637c65 100644 --- a/src/charging-station/ocpp/OCPPServiceUtils.ts +++ b/src/charging-station/ocpp/OCPPServiceUtils.ts @@ -1,4 +1,190 @@ +import type { DefinedError, ErrorObject } from 'ajv'; + +import BaseError from '../../exception/BaseError'; +import type { SampledValueTemplate } from '../../types/MeasurandPerPhaseSampledValueTemplates'; +import { StandardParametersKey } from '../../types/ocpp/Configuration'; +import { ErrorType } from '../../types/ocpp/ErrorType'; +import { MeterValueMeasurand, type MeterValuePhase } from '../../types/ocpp/MeterValues'; +import { IncomingRequestCommand, MessageTrigger, RequestCommand } 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 { ChargingStationConfigurationUtils } from '../ChargingStationConfigurationUtils'; + export class OCPPServiceUtils { + protected constructor() { + // This is intentional + } + + public static ajvErrorsToErrorType(errors: ErrorObject[]): ErrorType { + for (const error of errors as DefinedError[]) { + switch (error.keyword) { + case 'type': + return ErrorType.TYPE_CONSTRAINT_VIOLATION; + case 'dependencies': + case 'required': + return ErrorType.OCCURRENCE_CONSTRAINT_VIOLATION; + case 'pattern': + case 'format': + return ErrorType.PROPERTY_CONSTRAINT_VIOLATION; + } + } + return ErrorType.FORMAT_VIOLATION; + } + + public static isRequestCommandSupported( + chargingStation: ChargingStation, + command: RequestCommand + ): boolean { + const isRequestCommand = Object.values(RequestCommand).includes(command); + if ( + isRequestCommand === true && + !chargingStation.stationInfo?.commandsSupport?.outgoingCommands + ) { + return true; + } else if ( + isRequestCommand === true && + chargingStation.stationInfo?.commandsSupport?.outgoingCommands + ) { + return chargingStation.stationInfo?.commandsSupport?.outgoingCommands[command] ?? false; + } + logger.error(`${chargingStation.logPrefix()} Unknown outgoing OCPP command '${command}'`); + return false; + } + + public static isIncomingRequestCommandSupported( + chargingStation: ChargingStation, + command: IncomingRequestCommand + ): boolean { + const isIncomingRequestCommand = + Object.values(IncomingRequestCommand).includes(command); + if ( + isIncomingRequestCommand === true && + !chargingStation.stationInfo?.commandsSupport?.incomingCommands + ) { + return true; + } else if ( + isIncomingRequestCommand === true && + chargingStation.stationInfo?.commandsSupport?.incomingCommands + ) { + return chargingStation.stationInfo?.commandsSupport?.incomingCommands[command] ?? false; + } + logger.error(`${chargingStation.logPrefix()} Unknown incoming OCPP command '${command}'`); + return false; + } + + public static isMessageTriggerSupported( + chargingStation: ChargingStation, + messageTrigger: MessageTrigger + ): boolean { + const isMessageTrigger = Object.values(MessageTrigger).includes(messageTrigger); + if (isMessageTrigger === true && !chargingStation.stationInfo?.messageTriggerSupport) { + return true; + } else if (isMessageTrigger === true && chargingStation.stationInfo?.messageTriggerSupport) { + return chargingStation.stationInfo?.messageTriggerSupport[messageTrigger] ?? false; + } + logger.error( + `${chargingStation.logPrefix()} Unknown incoming OCPP message trigger '${messageTrigger}'` + ); + return false; + } + + public static isConnectorIdValid( + chargingStation: ChargingStation, + ocppCommand: IncomingRequestCommand, + connectorId: number + ): boolean { + if (connectorId < 0) { + logger.error( + `${chargingStation.logPrefix()} ${ocppCommand} incoming request received with invalid connector Id ${connectorId}` + ); + return false; + } + return true; + } + + protected static getSampledValueTemplate( + chargingStation: ChargingStation, + connectorId: number, + measurand: MeterValueMeasurand = MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER, + phase?: MeterValuePhase + ): SampledValueTemplate | undefined { + const onPhaseStr = phase ? `on phase ${phase} ` : ''; + if (Constants.SUPPORTED_MEASURANDS.includes(measurand) === false) { + logger.warn( + `${chargingStation.logPrefix()} Trying to get unsupported MeterValues measurand '${measurand}' ${onPhaseStr}in template on connectorId ${connectorId}` + ); + return; + } + if ( + measurand !== MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER && + ChargingStationConfigurationUtils.getConfigurationKey( + chargingStation, + StandardParametersKey.MeterValuesSampledData + )?.value.includes(measurand) === false + ) { + logger.debug( + `${chargingStation.logPrefix()} Trying to get MeterValues measurand '${measurand}' ${onPhaseStr}in template on connectorId ${connectorId} not found in '${ + StandardParametersKey.MeterValuesSampledData + }' OCPP parameter` + ); + return; + } + const sampledValueTemplates: SampledValueTemplate[] = + chargingStation.getConnectorStatus(connectorId).MeterValues; + for ( + let index = 0; + Utils.isEmptyArray(sampledValueTemplates) === false && index < sampledValueTemplates.length; + index++ + ) { + if ( + Constants.SUPPORTED_MEASURANDS.includes( + sampledValueTemplates[index]?.measurand ?? + MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER + ) === false + ) { + logger.warn( + `${chargingStation.logPrefix()} Unsupported MeterValues measurand '${measurand}' ${onPhaseStr}in template on connectorId ${connectorId}` + ); + } else if ( + phase && + sampledValueTemplates[index]?.phase === phase && + sampledValueTemplates[index]?.measurand === measurand && + ChargingStationConfigurationUtils.getConfigurationKey( + chargingStation, + StandardParametersKey.MeterValuesSampledData + )?.value.includes(measurand) === true + ) { + return sampledValueTemplates[index]; + } else if ( + !phase && + !sampledValueTemplates[index].phase && + sampledValueTemplates[index]?.measurand === measurand && + ChargingStationConfigurationUtils.getConfigurationKey( + chargingStation, + StandardParametersKey.MeterValuesSampledData + )?.value.includes(measurand) === true + ) { + return sampledValueTemplates[index]; + } else if ( + measurand === MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER && + (!sampledValueTemplates[index].measurand || + sampledValueTemplates[index].measurand === measurand) + ) { + return sampledValueTemplates[index]; + } + } + if (measurand === MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER) { + const errorMsg = `Missing MeterValues for default measurand '${measurand}' in template on connectorId ${connectorId}`; + logger.error(`${chargingStation.logPrefix()} ${errorMsg}`); + throw new BaseError(errorMsg); + } + logger.debug( + `${chargingStation.logPrefix()} No MeterValues for measurand '${measurand}' ${onPhaseStr}in template on connectorId ${connectorId}` + ); + } + protected static getLimitFromSampledValueTemplateCustomValue( value: string, limit: number, @@ -9,7 +195,8 @@ export class OCPPServiceUtils { ): number { options.limitationEnabled = options?.limitationEnabled ?? true; options.unitMultiplier = options?.unitMultiplier ?? 1; - const numberValue = isNaN(parseInt(value)) ? Infinity : parseInt(value); + const parsedInt = parseInt(value); + const numberValue = isNaN(parsedInt) ? Infinity : parsedInt; return options?.limitationEnabled ? Math.min(numberValue * options.unitMultiplier, limit) : numberValue * options.unitMultiplier;