-// Partial Copyright Jerome Benoit. 2021. All Rights Reserved.
-
-import { AvailabilityType, BootNotificationRequest, CachedRequest, IncomingRequest, IncomingRequestCommand, RequestCommand } from '../types/ocpp/Requests';
-import { BootNotificationResponse, RegistrationStatus } from '../types/ocpp/Responses';
-import ChargingStationConfiguration, { ConfigurationKey } from '../types/ChargingStationConfiguration';
-import ChargingStationTemplate, { CurrentType, PowerUnits, Voltage } from '../types/ChargingStationTemplate';
-import { ConnectorPhaseRotation, StandardParametersKey, SupportedFeatureProfiles, VendorDefaultParametersKey } from '../types/ocpp/Configuration';
-import { MeterValueMeasurand, MeterValuePhase } from '../types/ocpp/MeterValues';
-import { WSError, WebSocketCloseEventStatusCode } from '../types/WebSocket';
-import WebSocket, { ClientOptions, Data, OPEN } from 'ws';
-
-import AutomaticTransactionGenerator from './AutomaticTransactionGenerator';
-import { ChargePointStatus } from '../types/ocpp/ChargePointStatus';
-import { ChargingProfile } from '../types/ocpp/ChargingProfile';
-import ChargingStationInfo from '../types/ChargingStationInfo';
-import { ChargingStationWorkerMessageEvents } from '../types/ChargingStationWorker';
-import { ClientRequestArgs } from 'http';
-import Configuration from '../utils/Configuration';
-import { ConnectorStatus } from '../types/ConnectorStatus';
-import Constants from '../utils/Constants';
-import { ErrorType } from '../types/ocpp/ErrorType';
-import FileUtils from '../utils/FileUtils';
-import { JsonType } from '../types/JsonType';
-import { MessageType } from '../types/ocpp/MessageType';
-import OCPP16IncomingRequestService from './ocpp/1.6/OCPP16IncomingRequestService';
-import OCPP16RequestService from './ocpp/1.6/OCPP16RequestService';
-import OCPP16ResponseService from './ocpp/1.6/OCPP16ResponseService';
-import OCPPError from '../exception/OCPPError';
-import OCPPIncomingRequestService from './ocpp/OCPPIncomingRequestService';
-import OCPPRequestService from './ocpp/OCPPRequestService';
-import { OCPPVersion } from '../types/ocpp/OCPPVersion';
-import PerformanceStatistics from '../performance/PerformanceStatistics';
-import { SampledValueTemplate } from '../types/MeasurandPerPhaseSampledValueTemplates';
-import { StopTransactionReason } from '../types/ocpp/Transaction';
-import { SupervisionUrlDistribution } from '../types/ConfigurationData';
-import { URL } from 'url';
-import Utils from '../utils/Utils';
-import crypto from 'crypto';
-import fs from 'fs';
-import logger from '../utils/Logger';
-import { parentPort } from 'worker_threads';
-import path from 'path';
-
-export default class ChargingStation {
- public readonly id: string;
- public readonly stationTemplateFile: string;
- public authorizedTags: string[];
+// Partial Copyright Jerome Benoit. 2021-2023. All Rights Reserved.
+
+import { createHash } from 'node:crypto';
+import { type FSWatcher, existsSync, mkdirSync, readFileSync, writeFileSync } from 'node:fs';
+import { dirname, join } from 'node:path';
+import { URL } from 'node:url';
+import { parentPort } from 'node:worker_threads';
+
+import { millisecondsToSeconds, secondsToMilliseconds } from 'date-fns';
+import merge from 'just-merge';
+import { type RawData, WebSocket } from 'ws';
+
+import { AutomaticTransactionGenerator } from './AutomaticTransactionGenerator';
+import { ChargingStationWorkerBroadcastChannel } from './broadcast-channel/ChargingStationWorkerBroadcastChannel';
+import {
+ addConfigurationKey,
+ deleteConfigurationKey,
+ getConfigurationKey,
+ setConfigurationKeyValue,
+} from './ConfigurationKeyUtils';
+import {
+ buildConnectorsMap,
+ checkChargingStation,
+ checkConnectorsConfiguration,
+ checkStationInfoConnectorStatus,
+ checkTemplate,
+ createBootNotificationRequest,
+ createSerialNumber,
+ getAmperageLimitationUnitDivider,
+ getBootConnectorStatus,
+ getChargingStationConnectorChargingProfilesPowerLimit,
+ getChargingStationId,
+ getDefaultVoltageOut,
+ getHashId,
+ getIdTagsFile,
+ getMaxNumberOfEvses,
+ getNumberOfReservableConnectors,
+ getPhaseRotationValue,
+ hasFeatureProfile,
+ hasReservationExpired,
+ initializeConnectorsMapStatus,
+ propagateSerialNumber,
+ removeExpiredReservations,
+ stationTemplateToStationInfo,
+ warnTemplateKeysDeprecation,
+} from './Helpers';
+import { IdTagsCache } from './IdTagsCache';
+import {
+ OCPP16IncomingRequestService,
+ OCPP16RequestService,
+ OCPP16ResponseService,
+ OCPP16ServiceUtils,
+ OCPP20IncomingRequestService,
+ OCPP20RequestService,
+ OCPP20ResponseService,
+ type OCPPIncomingRequestService,
+ type OCPPRequestService,
+ OCPPServiceUtils,
+} from './ocpp';
+import { SharedLRUCache } from './SharedLRUCache';
+import { BaseError, OCPPError } from '../exception';
+import { PerformanceStatistics } from '../performance';
+import {
+ type AutomaticTransactionGeneratorConfiguration,
+ AvailabilityType,
+ type BootNotificationRequest,
+ type BootNotificationResponse,
+ type CachedRequest,
+ type ChargingStationConfiguration,
+ type ChargingStationInfo,
+ type ChargingStationOcppConfiguration,
+ type ChargingStationTemplate,
+ type ConnectorStatus,
+ ConnectorStatusEnum,
+ CurrentType,
+ type ErrorCallback,
+ type ErrorResponse,
+ ErrorType,
+ type EvseStatus,
+ type EvseStatusConfiguration,
+ FileType,
+ FirmwareStatus,
+ type FirmwareStatusNotificationRequest,
+ type FirmwareStatusNotificationResponse,
+ type FirmwareUpgrade,
+ type HeartbeatRequest,
+ type HeartbeatResponse,
+ type IncomingRequest,
+ type IncomingRequestCommand,
+ type JsonType,
+ MessageType,
+ type MeterValue,
+ MeterValueMeasurand,
+ type MeterValuesRequest,
+ type MeterValuesResponse,
+ OCPPVersion,
+ type OutgoingRequest,
+ PowerUnits,
+ RegistrationStatusEnumType,
+ RequestCommand,
+ type Reservation,
+ type ReservationKey,
+ ReservationTerminationReason,
+ type Response,
+ StandardParametersKey,
+ type Status,
+ type StatusNotificationRequest,
+ type StatusNotificationResponse,
+ StopTransactionReason,
+ type StopTransactionRequest,
+ type StopTransactionResponse,
+ SupervisionUrlDistribution,
+ SupportedFeatureProfiles,
+ VendorParametersKey,
+ type WSError,
+ WebSocketCloseEventStatusCode,
+ type WsOptions,
+} from '../types';
+import {
+ ACElectricUtils,
+ AsyncLock,
+ AsyncLockType,
+ Configuration,
+ Constants,
+ DCElectricUtils,
+ buildChargingStationAutomaticTransactionGeneratorConfiguration,
+ buildConnectorsStatus,
+ buildEvsesStatus,
+ buildStartedMessage,
+ buildStoppedMessage,
+ buildUpdatedMessage,
+ cloneObject,
+ convertToBoolean,
+ convertToInt,
+ exponentialDelay,
+ formatDurationMilliSeconds,
+ formatDurationSeconds,
+ getRandomInteger,
+ getWebSocketCloseEventStatusString,
+ handleFileException,
+ isNotEmptyArray,
+ isNotEmptyString,
+ isNullOrUndefined,
+ isUndefined,
+ logPrefix,
+ logger,
+ min,
+ once,
+ roundTo,
+ secureRandom,
+ sleep,
+ watchJsonFile,
+} from '../utils';
+
+export class ChargingStation {
+ public readonly index: number;
+ public readonly templateFile: string;
public stationInfo!: ChargingStationInfo;
+ public started: boolean;
+ public starting: boolean;
+ public idTagsCache: IdTagsCache;
+ public automaticTransactionGenerator!: AutomaticTransactionGenerator | undefined;
+ public ocppConfiguration!: ChargingStationOcppConfiguration | undefined;
+ public wsConnection!: WebSocket | null;
public readonly connectors: Map<number, ConnectorStatus>;
- public configuration!: ChargingStationConfiguration;
- public wsConnection!: WebSocket;
+ public readonly evses: Map<number, EvseStatus>;
public readonly requests: Map<string, CachedRequest>;
- public performanceStatistics!: PerformanceStatistics;
- public heartbeatSetInterval!: NodeJS.Timeout;
+ public performanceStatistics!: PerformanceStatistics | undefined;
+ public heartbeatSetInterval?: NodeJS.Timeout;
public ocppRequestService!: OCPPRequestService;
- private readonly index: number;
- private bootNotificationRequest!: BootNotificationRequest;
- private bootNotificationResponse!: BootNotificationResponse | null;
+ public bootNotificationRequest!: BootNotificationRequest;
+ public bootNotificationResponse!: BootNotificationResponse | undefined;
+ public powerDivider!: number;
+ private stopping: boolean;
+ private configurationFile!: string;
+ private configurationFileHash!: string;
private connectorsConfigurationHash!: string;
+ private evsesConfigurationHash!: string;
+ private automaticTransactionGeneratorConfiguration?: AutomaticTransactionGeneratorConfiguration;
private ocppIncomingRequestService!: OCPPIncomingRequestService;
private readonly messageBuffer: Set<string>;
- private wsConfiguredConnectionUrl!: URL;
+ private configuredSupervisionUrl!: URL;
private wsConnectionRestarted: boolean;
- private stopped: boolean;
private autoReconnectRetryCount: number;
- private automaticTransactionGenerator!: AutomaticTransactionGenerator;
- private webSocketPingSetInterval!: NodeJS.Timeout;
-
- constructor(index: number, stationTemplateFile: string) {
- this.id = Utils.generateUUID();
- this.index = index;
- this.stationTemplateFile = stationTemplateFile;
- this.stopped = false;
+ private templateFileWatcher!: FSWatcher | undefined;
+ private templateFileHash!: string;
+ private readonly sharedLRUCache: SharedLRUCache;
+ private webSocketPingSetInterval?: NodeJS.Timeout;
+ private readonly chargingStationWorkerBroadcastChannel: ChargingStationWorkerBroadcastChannel;
+ private reservationExpirationSetInterval?: NodeJS.Timeout;
+
+ constructor(index: number, templateFile: string) {
+ this.started = false;
+ this.starting = false;
+ this.stopping = false;
this.wsConnectionRestarted = false;
this.autoReconnectRetryCount = 0;
+ this.index = index;
+ this.templateFile = templateFile;
this.connectors = new Map<number, ConnectorStatus>();
+ this.evses = new Map<number, EvseStatus>();
this.requests = new Map<string, CachedRequest>();
this.messageBuffer = new Set<string>();
- this.initialize();
- this.authorizedTags = this.getAuthorizedTags();
- }
+ this.sharedLRUCache = SharedLRUCache.getInstance();
+ this.idTagsCache = IdTagsCache.getInstance();
+ this.chargingStationWorkerBroadcastChannel = new ChargingStationWorkerBroadcastChannel(this);
- get wsConnectionUrl(): URL {
- return this.getSupervisionUrlOcppConfiguration() ? new URL(this.getConfigurationKey(this.stationInfo.supervisionUrlOcppKey ?? VendorDefaultParametersKey.ConnectionUrl).value + '/' + this.stationInfo.chargingStationId) : this.wsConfiguredConnectionUrl;
+ this.initialize();
}
- public logPrefix(): string {
- return Utils.logPrefix(` ${this.stationInfo.chargingStationId} |`);
+ public get hasEvses(): boolean {
+ return this.connectors.size === 0 && this.evses.size > 0;
}
- public getBootNotificationRequest(): BootNotificationRequest {
- return this.bootNotificationRequest;
+ private get wsConnectionUrl(): URL {
+ return new URL(
+ `${
+ this.getSupervisionUrlOcppConfiguration() &&
+ isNotEmptyString(this.getSupervisionUrlOcppKey()) &&
+ isNotEmptyString(getConfigurationKey(this, this.getSupervisionUrlOcppKey())?.value)
+ ? getConfigurationKey(this, this.getSupervisionUrlOcppKey())!.value
+ : this.configuredSupervisionUrl.href
+ }/${this.stationInfo.chargingStationId}`,
+ );
}
- public getRandomIdTag(): string {
- const index = Math.floor(Utils.secureRandom() * this.authorizedTags.length);
- return this.authorizedTags[index];
- }
+ public logPrefix = (): string => {
+ return logPrefix(
+ ` ${
+ (isNotEmptyString(this?.stationInfo?.chargingStationId)
+ ? this?.stationInfo?.chargingStationId
+ : getChargingStationId(this.index, this.getTemplateFromFile()!)) ??
+ 'Error at building log prefix'
+ } |`,
+ );
+ };
- public hasAuthorizedTags(): boolean {
- return !Utils.isEmptyArray(this.authorizedTags);
+ public hasIdTags(): boolean {
+ return isNotEmptyArray(this.idTagsCache.getIdTags(getIdTagsFile(this.stationInfo)!));
}
- public getEnableStatistics(): boolean | undefined {
- return !Utils.isUndefined(this.stationInfo.enableStatistics) ? this.stationInfo.enableStatistics : true;
+ public getEnableStatistics(): boolean {
+ return this.stationInfo.enableStatistics ?? false;
}
- public getMayAuthorizeAtRemoteStart(): boolean | undefined {
- return this.stationInfo.mayAuthorizeAtRemoteStart ?? true;
+ public getRemoteAuthorization(): boolean {
+ return this.stationInfo.remoteAuthorization ?? true;
}
- public getNumberOfPhases(): number | undefined {
- switch (this.getCurrentOutType()) {
+ public getNumberOfPhases(stationInfo?: ChargingStationInfo): number {
+ const localStationInfo: ChargingStationInfo = stationInfo ?? this.stationInfo;
+ switch (this.getCurrentOutType(stationInfo)) {
case CurrentType.AC:
- return !Utils.isUndefined(this.stationInfo.numberOfPhases) ? this.stationInfo.numberOfPhases : 3;
+ return !isUndefined(localStationInfo.numberOfPhases) ? localStationInfo.numberOfPhases! : 3;
case CurrentType.DC:
return 0;
}
}
public isWebSocketConnectionOpened(): boolean {
- return this?.wsConnection?.readyState === OPEN;
+ return this?.wsConnection?.readyState === WebSocket.OPEN;
}
- public getRegistrationStatus(): RegistrationStatus {
+ public getRegistrationStatus(): RegistrationStatusEnumType | undefined {
return this?.bootNotificationResponse?.status;
}
- public isInUnknownState(): boolean {
- return Utils.isNullOrUndefined(this?.bootNotificationResponse?.status);
+ public inUnknownState(): boolean {
+ return isNullOrUndefined(this?.bootNotificationResponse?.status);
}
- public isInPendingState(): boolean {
- return this?.bootNotificationResponse?.status === RegistrationStatus.PENDING;
+ public inPendingState(): boolean {
+ return this?.bootNotificationResponse?.status === RegistrationStatusEnumType.PENDING;
}
- public isInAcceptedState(): boolean {
- return this?.bootNotificationResponse?.status === RegistrationStatus.ACCEPTED;
+ public inAcceptedState(): boolean {
+ return this?.bootNotificationResponse?.status === RegistrationStatusEnumType.ACCEPTED;
}
- public isInRejectedState(): boolean {
- return this?.bootNotificationResponse?.status === RegistrationStatus.REJECTED;
+ public inRejectedState(): boolean {
+ return this?.bootNotificationResponse?.status === RegistrationStatusEnumType.REJECTED;
}
public isRegistered(): boolean {
- return !this.isInUnknownState() && (this.isInAcceptedState() || this.isInPendingState());
+ return (
+ this.inUnknownState() === false &&
+ (this.inAcceptedState() === true || this.inPendingState() === true)
+ );
}
public isChargingStationAvailable(): boolean {
- return this.getConnectorStatus(0).availability === AvailabilityType.OPERATIVE;
+ return this.getConnectorStatus(0)?.availability === AvailabilityType.Operative;
+ }
+
+ public hasConnector(connectorId: number): boolean {
+ if (this.hasEvses) {
+ for (const evseStatus of this.evses.values()) {
+ if (evseStatus.connectors.has(connectorId)) {
+ return true;
+ }
+ }
+ return false;
+ }
+ return this.connectors.has(connectorId);
}
- public isConnectorAvailable(id: number): boolean {
- return id > 0 && this.getConnectorStatus(id).availability === AvailabilityType.OPERATIVE;
+ public isConnectorAvailable(connectorId: number): boolean {
+ return (
+ connectorId > 0 &&
+ this.getConnectorStatus(connectorId)?.availability === AvailabilityType.Operative
+ );
}
public getNumberOfConnectors(): number {
- return this.connectors.get(0) ? this.connectors.size - 1 : this.connectors.size;
+ if (this.hasEvses) {
+ let numberOfConnectors = 0;
+ for (const [evseId, evseStatus] of this.evses) {
+ if (evseId > 0) {
+ numberOfConnectors += evseStatus.connectors.size;
+ }
+ }
+ return numberOfConnectors;
+ }
+ return this.connectors.has(0) ? this.connectors.size - 1 : this.connectors.size;
}
- public getConnectorStatus(id: number): ConnectorStatus {
- return this.connectors.get(id);
+ public getNumberOfEvses(): number {
+ return this.evses.has(0) ? this.evses.size - 1 : this.evses.size;
}
- public getCurrentOutType(): CurrentType | undefined {
- return this.stationInfo.currentOutType ?? CurrentType.AC;
+ public getConnectorStatus(connectorId: number): ConnectorStatus | undefined {
+ if (this.hasEvses) {
+ for (const evseStatus of this.evses.values()) {
+ if (evseStatus.connectors.has(connectorId)) {
+ return evseStatus.connectors.get(connectorId);
+ }
+ }
+ return undefined;
+ }
+ return this.connectors.get(connectorId);
+ }
+
+ public getCurrentOutType(stationInfo?: ChargingStationInfo): CurrentType {
+ return (stationInfo ?? this.stationInfo)?.currentOutType ?? CurrentType.AC;
}
public getOcppStrictCompliance(): boolean {
- return this.stationInfo.ocppStrictCompliance ?? false;
+ return this.stationInfo?.ocppStrictCompliance ?? true;
+ }
+
+ public getVoltageOut(stationInfo?: ChargingStationInfo): number {
+ const defaultVoltageOut = getDefaultVoltageOut(
+ this.getCurrentOutType(stationInfo),
+ this.logPrefix(),
+ this.templateFile,
+ );
+ return (stationInfo ?? this.stationInfo).voltageOut ?? defaultVoltageOut;
+ }
+
+ public getMaximumPower(stationInfo?: ChargingStationInfo): number {
+ return (stationInfo ?? this.stationInfo).maximumPower!;
+ }
+
+ public getConnectorMaximumAvailablePower(connectorId: number): number {
+ let connectorAmperageLimitationPowerLimit: number | undefined;
+ if (
+ !isNullOrUndefined(this.getAmperageLimitation()) &&
+ this.getAmperageLimitation()! < this.stationInfo.maximumAmperage!
+ ) {
+ connectorAmperageLimitationPowerLimit =
+ (this.getCurrentOutType() === CurrentType.AC
+ ? ACElectricUtils.powerTotal(
+ this.getNumberOfPhases(),
+ this.getVoltageOut(),
+ this.getAmperageLimitation()! *
+ (this.hasEvses ? this.getNumberOfEvses() : this.getNumberOfConnectors()),
+ )
+ : DCElectricUtils.power(this.getVoltageOut(), this.getAmperageLimitation()!)) /
+ this.powerDivider;
+ }
+ const connectorMaximumPower = this.getMaximumPower() / this.powerDivider;
+ const connectorChargingProfilesPowerLimit =
+ getChargingStationConnectorChargingProfilesPowerLimit(this, connectorId);
+ return min(
+ isNaN(connectorMaximumPower) ? Infinity : connectorMaximumPower,
+ isNaN(connectorAmperageLimitationPowerLimit!)
+ ? Infinity
+ : connectorAmperageLimitationPowerLimit!,
+ isNaN(connectorChargingProfilesPowerLimit!) ? Infinity : connectorChargingProfilesPowerLimit!,
+ );
}
- public getVoltageOut(): number | undefined {
- const errMsg = `${this.logPrefix()} Unknown ${this.getCurrentOutType()} currentOutType in template file ${this.stationTemplateFile}, cannot define default voltage out`;
- let defaultVoltageOut: number;
- switch (this.getCurrentOutType()) {
- case CurrentType.AC:
- defaultVoltageOut = Voltage.VOLTAGE_230;
- break;
- case CurrentType.DC:
- defaultVoltageOut = Voltage.VOLTAGE_400;
- break;
- default:
- logger.error(errMsg);
- throw new Error(errMsg);
+ public getTransactionIdTag(transactionId: number): string | undefined {
+ if (this.hasEvses) {
+ for (const evseStatus of this.evses.values()) {
+ for (const connectorStatus of evseStatus.connectors.values()) {
+ if (connectorStatus.transactionId === transactionId) {
+ return connectorStatus.transactionIdTag;
+ }
+ }
+ }
+ } else {
+ for (const connectorId of this.connectors.keys()) {
+ if (this.getConnectorStatus(connectorId)?.transactionId === transactionId) {
+ return this.getConnectorStatus(connectorId)?.transactionIdTag;
+ }
+ }
}
- return !Utils.isUndefined(this.stationInfo.voltageOut) ? this.stationInfo.voltageOut : defaultVoltageOut;
}
- public getTransactionIdTag(transactionId: number): string | undefined {
- for (const connectorId of this.connectors.keys()) {
- if (connectorId > 0 && this.getConnectorStatus(connectorId).transactionId === transactionId) {
- return this.getConnectorStatus(connectorId).transactionIdTag;
+ public getNumberOfRunningTransactions(): number {
+ let numberOfRunningTransactions = 0;
+ if (this.hasEvses) {
+ for (const [evseId, evseStatus] of this.evses) {
+ if (evseId === 0) {
+ continue;
+ }
+ for (const connectorStatus of evseStatus.connectors.values()) {
+ if (connectorStatus.transactionStarted === true) {
+ ++numberOfRunningTransactions;
+ }
+ }
+ }
+ } else {
+ for (const connectorId of this.connectors.keys()) {
+ if (connectorId > 0 && this.getConnectorStatus(connectorId)?.transactionStarted === true) {
+ ++numberOfRunningTransactions;
+ }
}
}
+ return numberOfRunningTransactions;
}
public getOutOfOrderEndMeterValues(): boolean {
- return this.stationInfo.outOfOrderEndMeterValues ?? false;
+ return this.stationInfo?.outOfOrderEndMeterValues ?? false;
}
public getBeginEndMeterValues(): boolean {
- return this.stationInfo.beginEndMeterValues ?? false;
+ return this.stationInfo?.beginEndMeterValues ?? false;
}
public getMeteringPerTransaction(): boolean {
- return this.stationInfo.meteringPerTransaction ?? true;
+ return this.stationInfo?.meteringPerTransaction ?? true;
}
public getTransactionDataMeterValues(): boolean {
- return this.stationInfo.transactionDataMeterValues ?? false;
+ return this.stationInfo?.transactionDataMeterValues ?? false;
}
public getMainVoltageMeterValues(): boolean {
- return this.stationInfo.mainVoltageMeterValues ?? true;
+ return this.stationInfo?.mainVoltageMeterValues ?? true;
}
public getPhaseLineToLineVoltageMeterValues(): boolean {
- return this.stationInfo.phaseLineToLineVoltageMeterValues ?? false;
+ return this.stationInfo?.phaseLineToLineVoltageMeterValues ?? false;
}
- public getEnergyActiveImportRegisterByTransactionId(transactionId: number): number | undefined {
- if (this.getMeteringPerTransaction()) {
- for (const connectorId of this.connectors.keys()) {
- if (connectorId > 0 && this.getConnectorStatus(connectorId).transactionId === transactionId) {
- return this.getConnectorStatus(connectorId).transactionEnergyActiveImportRegisterValue;
+ public getCustomValueLimitationMeterValues(): boolean {
+ return this.stationInfo?.customValueLimitationMeterValues ?? true;
+ }
+
+ public getConnectorIdByTransactionId(transactionId: number): number | undefined {
+ if (this.hasEvses) {
+ for (const evseStatus of this.evses.values()) {
+ for (const [connectorId, connectorStatus] of evseStatus.connectors) {
+ if (connectorStatus.transactionId === transactionId) {
+ return connectorId;
+ }
}
}
- }
- for (const connectorId of this.connectors.keys()) {
- if (connectorId > 0 && this.getConnectorStatus(connectorId).transactionId === transactionId) {
- return this.getConnectorStatus(connectorId).energyActiveImportRegisterValue;
+ } else {
+ for (const connectorId of this.connectors.keys()) {
+ if (this.getConnectorStatus(connectorId)?.transactionId === transactionId) {
+ return connectorId;
+ }
}
}
}
- public getEnergyActiveImportRegisterByConnectorId(connectorId: number): number | undefined {
- if (this.getMeteringPerTransaction()) {
- return this.getConnectorStatus(connectorId).transactionEnergyActiveImportRegisterValue;
- }
- return this.getConnectorStatus(connectorId).energyActiveImportRegisterValue;
+ public getEnergyActiveImportRegisterByTransactionId(
+ transactionId: number,
+ rounded = false,
+ ): number {
+ return this.getEnergyActiveImportRegister(
+ this.getConnectorStatus(this.getConnectorIdByTransactionId(transactionId)!)!,
+ rounded,
+ );
}
- public getAuthorizeRemoteTxRequests(): boolean {
- const authorizeRemoteTxRequests = this.getConfigurationKey(StandardParametersKey.AuthorizeRemoteTxRequests);
- return authorizeRemoteTxRequests ? Utils.convertToBoolean(authorizeRemoteTxRequests.value) : false;
+ public getEnergyActiveImportRegisterByConnectorId(connectorId: number, rounded = false): number {
+ return this.getEnergyActiveImportRegister(this.getConnectorStatus(connectorId)!, rounded);
}
- public getLocalAuthListEnabled(): boolean {
- const localAuthListEnabled = this.getConfigurationKey(StandardParametersKey.LocalAuthListEnabled);
- return localAuthListEnabled ? Utils.convertToBoolean(localAuthListEnabled.value) : false;
+ public getAuthorizeRemoteTxRequests(): boolean {
+ const authorizeRemoteTxRequests = getConfigurationKey(
+ this,
+ StandardParametersKey.AuthorizeRemoteTxRequests,
+ );
+ return authorizeRemoteTxRequests ? convertToBoolean(authorizeRemoteTxRequests.value) : false;
}
- public restartWebSocketPing(): void {
- // Stop WebSocket ping
- this.stopWebSocketPing();
- // Start WebSocket ping
- this.startWebSocketPing();
+ public getLocalAuthListEnabled(): boolean {
+ const localAuthListEnabled = getConfigurationKey(
+ this,
+ StandardParametersKey.LocalAuthListEnabled,
+ );
+ return localAuthListEnabled ? convertToBoolean(localAuthListEnabled.value) : false;
}
- public getSampledValueTemplate(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)) {
- logger.warn(`${this.logPrefix()} Trying to get unsupported MeterValues measurand '${measurand}' ${onPhaseStr}in template on connectorId ${connectorId}`);
- return;
- }
- if (measurand !== MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER && !this.getConfigurationKey(StandardParametersKey.MeterValuesSampledData).value.includes(measurand)) {
- logger.debug(`${this.logPrefix()} Trying to get MeterValues measurand '${measurand}' ${onPhaseStr}in template on connectorId ${connectorId} not found in '${StandardParametersKey.MeterValuesSampledData}' OCPP parameter`);
- return;
- }
- const sampledValueTemplates: SampledValueTemplate[] = this.getConnectorStatus(connectorId).MeterValues;
- for (let index = 0; !Utils.isEmptyArray(sampledValueTemplates) && index < sampledValueTemplates.length; index++) {
- if (!Constants.SUPPORTED_MEASURANDS.includes(sampledValueTemplates[index]?.measurand ?? MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER)) {
- logger.warn(`${this.logPrefix()} Unsupported MeterValues measurand '${measurand}' ${onPhaseStr}in template on connectorId ${connectorId}`);
- } else if (phase && sampledValueTemplates[index]?.phase === phase && sampledValueTemplates[index]?.measurand === measurand
- && this.getConfigurationKey(StandardParametersKey.MeterValuesSampledData).value.includes(measurand)) {
- return sampledValueTemplates[index];
- } else if (!phase && !sampledValueTemplates[index].phase && sampledValueTemplates[index]?.measurand === measurand
- && this.getConfigurationKey(StandardParametersKey.MeterValuesSampledData).value.includes(measurand)) {
- 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 = `${this.logPrefix()} Missing MeterValues for default measurand '${measurand}' in template on connectorId ${connectorId}`;
- logger.error(errorMsg);
- throw new Error(errorMsg);
+ public getHeartbeatInterval(): number {
+ const HeartbeatInterval = getConfigurationKey(this, StandardParametersKey.HeartbeatInterval);
+ if (HeartbeatInterval) {
+ return secondsToMilliseconds(convertToInt(HeartbeatInterval.value));
}
- logger.debug(`${this.logPrefix()} No MeterValues for measurand '${measurand}' ${onPhaseStr}in template on connectorId ${connectorId}`);
+ const HeartBeatInterval = getConfigurationKey(this, StandardParametersKey.HeartBeatInterval);
+ if (HeartBeatInterval) {
+ return secondsToMilliseconds(convertToInt(HeartBeatInterval.value));
+ }
+ this.stationInfo?.autoRegister === false &&
+ logger.warn(
+ `${this.logPrefix()} Heartbeat interval configuration key not set, using default value: ${
+ Constants.DEFAULT_HEARTBEAT_INTERVAL
+ }`,
+ );
+ return Constants.DEFAULT_HEARTBEAT_INTERVAL;
}
- public getAutomaticTransactionGeneratorRequireAuthorize(): boolean {
- return this.stationInfo.AutomaticTransactionGenerator.requireAuthorize ?? true;
+ public setSupervisionUrl(url: string): void {
+ if (
+ this.getSupervisionUrlOcppConfiguration() &&
+ isNotEmptyString(this.getSupervisionUrlOcppKey())
+ ) {
+ setConfigurationKeyValue(this, this.getSupervisionUrlOcppKey(), url);
+ } else {
+ this.stationInfo.supervisionUrls = url;
+ this.saveStationInfo();
+ this.configuredSupervisionUrl = this.getConfiguredSupervisionUrl();
+ }
}
public startHeartbeat(): void {
- if (this.getHeartbeatInterval() && this.getHeartbeatInterval() > 0 && !this.heartbeatSetInterval) {
- // eslint-disable-next-line @typescript-eslint/no-misused-promises
- this.heartbeatSetInterval = setInterval(async (): Promise<void> => {
- await this.ocppRequestService.sendHeartbeat();
+ if (this.getHeartbeatInterval() > 0 && !this.heartbeatSetInterval) {
+ this.heartbeatSetInterval = setInterval(() => {
+ this.ocppRequestService
+ .requestHandler<HeartbeatRequest, HeartbeatResponse>(this, RequestCommand.HEARTBEAT)
+ .catch((error) => {
+ logger.error(
+ `${this.logPrefix()} Error while sending '${RequestCommand.HEARTBEAT}':`,
+ error,
+ );
+ });
}, this.getHeartbeatInterval());
- logger.info(this.logPrefix() + ' Heartbeat started every ' + Utils.formatDurationMilliSeconds(this.getHeartbeatInterval()));
+ logger.info(
+ `${this.logPrefix()} Heartbeat started every ${formatDurationMilliSeconds(
+ this.getHeartbeatInterval(),
+ )}`,
+ );
} else if (this.heartbeatSetInterval) {
- logger.info(this.logPrefix() + ' Heartbeat already started every ' + Utils.formatDurationMilliSeconds(this.getHeartbeatInterval()));
+ logger.info(
+ `${this.logPrefix()} Heartbeat already started every ${formatDurationMilliSeconds(
+ this.getHeartbeatInterval(),
+ )}`,
+ );
} else {
- logger.error(`${this.logPrefix()} Heartbeat interval set to ${this.getHeartbeatInterval() ? Utils.formatDurationMilliSeconds(this.getHeartbeatInterval()) : this.getHeartbeatInterval()}, not starting the heartbeat`);
+ logger.error(
+ `${this.logPrefix()} Heartbeat interval set to ${this.getHeartbeatInterval()}, not starting the heartbeat`,
+ );
}
}
this.startHeartbeat();
}
+ public restartWebSocketPing(): void {
+ // Stop WebSocket ping
+ this.stopWebSocketPing();
+ // Start WebSocket ping
+ this.startWebSocketPing();
+ }
+
public startMeterValues(connectorId: number, interval: number): void {
if (connectorId === 0) {
- logger.error(`${this.logPrefix()} Trying to start MeterValues on connector Id ${connectorId.toString()}`);
+ logger.error(
+ `${this.logPrefix()} Trying to start MeterValues on connector id ${connectorId}`,
+ );
return;
}
if (!this.getConnectorStatus(connectorId)) {
- logger.error(`${this.logPrefix()} Trying to start MeterValues on non existing connector Id ${connectorId.toString()}`);
+ logger.error(
+ `${this.logPrefix()} Trying to start MeterValues on non existing connector id
+ ${connectorId}`,
+ );
return;
}
- if (!this.getConnectorStatus(connectorId)?.transactionStarted) {
- logger.error(`${this.logPrefix()} Trying to start MeterValues on connector Id ${connectorId} with no transaction started`);
+ if (this.getConnectorStatus(connectorId)?.transactionStarted === false) {
+ logger.error(
+ `${this.logPrefix()} Trying to start MeterValues on connector id ${connectorId} with no transaction started`,
+ );
return;
- } else if (this.getConnectorStatus(connectorId)?.transactionStarted && !this.getConnectorStatus(connectorId)?.transactionId) {
- logger.error(`${this.logPrefix()} Trying to start MeterValues on connector Id ${connectorId} with no transaction id`);
+ } else if (
+ this.getConnectorStatus(connectorId)?.transactionStarted === true &&
+ isNullOrUndefined(this.getConnectorStatus(connectorId)?.transactionId)
+ ) {
+ logger.error(
+ `${this.logPrefix()} Trying to start MeterValues on connector id ${connectorId} with no transaction id`,
+ );
return;
}
if (interval > 0) {
- // eslint-disable-next-line @typescript-eslint/no-misused-promises
- this.getConnectorStatus(connectorId).transactionSetInterval = setInterval(async (): Promise<void> => {
- await this.ocppRequestService.sendMeterValues(connectorId, this.getConnectorStatus(connectorId).transactionId, interval);
+ this.getConnectorStatus(connectorId)!.transactionSetInterval = setInterval(() => {
+ // FIXME: Implement OCPP version agnostic helpers
+ const meterValue: MeterValue = OCPP16ServiceUtils.buildMeterValue(
+ this,
+ connectorId,
+ this.getConnectorStatus(connectorId)!.transactionId!,
+ interval,
+ );
+ this.ocppRequestService
+ .requestHandler<MeterValuesRequest, MeterValuesResponse>(
+ this,
+ RequestCommand.METER_VALUES,
+ {
+ connectorId,
+ transactionId: this.getConnectorStatus(connectorId)?.transactionId,
+ meterValue: [meterValue],
+ },
+ )
+ .catch((error) => {
+ logger.error(
+ `${this.logPrefix()} Error while sending '${RequestCommand.METER_VALUES}':`,
+ error,
+ );
+ });
}, interval);
} else {
- logger.error(`${this.logPrefix()} Charging station ${StandardParametersKey.MeterValueSampleInterval} configuration set to ${interval ? Utils.formatDurationMilliSeconds(interval) : interval}, not sending MeterValues`);
+ logger.error(
+ `${this.logPrefix()} Charging station ${
+ StandardParametersKey.MeterValueSampleInterval
+ } configuration set to ${interval}, not sending MeterValues`,
+ );
+ }
+ }
+
+ public stopMeterValues(connectorId: number) {
+ if (this.getConnectorStatus(connectorId)?.transactionSetInterval) {
+ clearInterval(this.getConnectorStatus(connectorId)?.transactionSetInterval);
}
}
public start(): void {
- if (this.getEnableStatistics()) {
- this.performanceStatistics.start();
- }
- this.openWSConnection();
- // Monitor authorization file
- this.startAuthorizationFileMonitoring();
- // Monitor station template file
- this.startStationTemplateFileMonitoring();
+ if (this.started === false) {
+ if (this.starting === false) {
+ this.starting = true;
+ if (this.getEnableStatistics() === true) {
+ this.performanceStatistics?.start();
+ }
+ if (hasFeatureProfile(this, SupportedFeatureProfiles.Reservation)) {
+ this.startReservationExpirationSetInterval();
+ }
+ this.openWSConnection();
+ // Monitor charging station template file
+ this.templateFileWatcher = watchJsonFile(
+ this.templateFile,
+ FileType.ChargingStationTemplate,
+ this.logPrefix(),
+ undefined,
+ (event, filename): void => {
+ if (isNotEmptyString(filename) && event === 'change') {
+ try {
+ logger.debug(
+ `${this.logPrefix()} ${FileType.ChargingStationTemplate} ${
+ this.templateFile
+ } file have changed, reload`,
+ );
+ this.sharedLRUCache.deleteChargingStationTemplate(this.templateFileHash);
+ // Initialize
+ this.initialize();
+ this.idTagsCache.deleteIdTags(getIdTagsFile(this.stationInfo)!);
+ // Restart the ATG
+ this.stopAutomaticTransactionGenerator();
+ delete this.automaticTransactionGeneratorConfiguration;
+ if (this.getAutomaticTransactionGeneratorConfiguration()?.enable === true) {
+ this.startAutomaticTransactionGenerator();
+ }
+ if (this.getEnableStatistics() === true) {
+ this.performanceStatistics?.restart();
+ } else {
+ this.performanceStatistics?.stop();
+ }
+ // FIXME?: restart heartbeat and WebSocket ping when their interval values have changed
+ } catch (error) {
+ logger.error(
+ `${this.logPrefix()} ${FileType.ChargingStationTemplate} file monitoring error:`,
+ error,
+ );
+ }
+ }
+ },
+ );
+ this.started = true;
+ parentPort?.postMessage(buildStartedMessage(this));
+ this.starting = false;
+ } else {
+ logger.warn(`${this.logPrefix()} Charging station is already starting...`);
+ }
+ } else {
+ logger.warn(`${this.logPrefix()} Charging station is already started...`);
+ }
+ }
+
+ public async stop(reason?: StopTransactionReason): Promise<void> {
+ if (this.started === true) {
+ if (this.stopping === false) {
+ this.stopping = true;
+ await this.stopMessageSequence(reason);
+ this.closeWSConnection();
+ if (this.getEnableStatistics() === true) {
+ this.performanceStatistics?.stop();
+ }
+ if (hasFeatureProfile(this, SupportedFeatureProfiles.Reservation)) {
+ this.stopReservationExpirationSetInterval();
+ }
+ this.sharedLRUCache.deleteChargingStationConfiguration(this.configurationFileHash);
+ this.templateFileWatcher?.close();
+ this.sharedLRUCache.deleteChargingStationTemplate(this.templateFileHash);
+ delete this.bootNotificationResponse;
+ this.started = false;
+ this.saveConfiguration();
+ parentPort?.postMessage(buildStoppedMessage(this));
+ this.stopping = false;
+ } else {
+ logger.warn(`${this.logPrefix()} Charging station is already stopping...`);
+ }
+ } else {
+ logger.warn(`${this.logPrefix()} Charging station is already stopped...`);
+ }
+ }
+
+ public async reset(reason?: StopTransactionReason): Promise<void> {
+ await this.stop(reason);
+ await sleep(this.stationInfo.resetTime!);
+ this.initialize();
+ this.start();
+ }
+
+ public saveOcppConfiguration(): void {
+ if (this.getOcppPersistentConfiguration()) {
+ this.saveConfiguration();
+ }
+ }
+
+ public bufferMessage(message: string): void {
+ this.messageBuffer.add(message);
+ }
+
+ public openWSConnection(
+ options?: WsOptions,
+ params?: { closeOpened?: boolean; terminateOpened?: boolean },
+ ): void {
+ options = {
+ handshakeTimeout: secondsToMilliseconds(this.getConnectionTimeout()),
+ ...this.stationInfo?.wsOptions,
+ ...options,
+ };
+ params = { ...{ closeOpened: false, terminateOpened: false }, ...params };
+ if (!checkChargingStation(this, this.logPrefix())) {
+ return;
+ }
+ if (
+ !isNullOrUndefined(this.stationInfo.supervisionUser) &&
+ !isNullOrUndefined(this.stationInfo.supervisionPassword)
+ ) {
+ options.auth = `${this.stationInfo.supervisionUser}:${this.stationInfo.supervisionPassword}`;
+ }
+ if (params?.closeOpened) {
+ this.closeWSConnection();
+ }
+ if (params?.terminateOpened) {
+ this.terminateWSConnection();
+ }
+
+ if (this.isWebSocketConnectionOpened() === true) {
+ logger.warn(
+ `${this.logPrefix()} OCPP connection to URL ${this.wsConnectionUrl.toString()} is already opened`,
+ );
+ return;
+ }
+
+ logger.info(
+ `${this.logPrefix()} Open OCPP connection to URL ${this.wsConnectionUrl.toString()}`,
+ );
+
+ this.wsConnection = new WebSocket(
+ this.wsConnectionUrl,
+ `ocpp${this.stationInfo.ocppVersion ?? OCPPVersion.VERSION_16}`,
+ options,
+ );
+
// Handle WebSocket message
- this.wsConnection.on('message', this.onMessage.bind(this));
+ this.wsConnection.on(
+ 'message',
+ this.onMessage.bind(this) as (this: WebSocket, data: RawData, isBinary: boolean) => void,
+ );
// Handle WebSocket error
- this.wsConnection.on('error', this.onError.bind(this));
+ this.wsConnection.on(
+ 'error',
+ this.onError.bind(this) as (this: WebSocket, error: Error) => void,
+ );
// Handle WebSocket close
- this.wsConnection.on('close', this.onClose.bind(this));
+ this.wsConnection.on(
+ 'close',
+ this.onClose.bind(this) as (this: WebSocket, code: number, reason: Buffer) => void,
+ );
// Handle WebSocket open
- this.wsConnection.on('open', this.onOpen.bind(this));
+ this.wsConnection.on('open', this.onOpen.bind(this) as (this: WebSocket) => void);
// Handle WebSocket ping
- this.wsConnection.on('ping', this.onPing.bind(this));
+ this.wsConnection.on('ping', this.onPing.bind(this) as (this: WebSocket, data: Buffer) => void);
// Handle WebSocket pong
- this.wsConnection.on('pong', this.onPong.bind(this));
- parentPort.postMessage({ id: ChargingStationWorkerMessageEvents.STARTED, data: { id: this.stationInfo.chargingStationId } });
+ this.wsConnection.on('pong', this.onPong.bind(this) as (this: WebSocket, data: Buffer) => void);
}
- public async stop(reason: StopTransactionReason = StopTransactionReason.NONE): Promise<void> {
- // Stop message sequence
- await this.stopMessageSequence(reason);
- for (const connectorId of this.connectors.keys()) {
- if (connectorId > 0) {
- await this.ocppRequestService.sendStatusNotification(connectorId, ChargePointStatus.UNAVAILABLE);
- this.getConnectorStatus(connectorId).status = ChargePointStatus.UNAVAILABLE;
- }
+ public closeWSConnection(): void {
+ if (this.isWebSocketConnectionOpened() === true) {
+ this.wsConnection?.close();
+ this.wsConnection = null;
}
- if (this.isWebSocketConnectionOpened()) {
- this.wsConnection.close();
- }
- if (this.getEnableStatistics()) {
- this.performanceStatistics.stop();
+ }
+
+ public getAutomaticTransactionGeneratorConfiguration(): AutomaticTransactionGeneratorConfiguration {
+ if (isNullOrUndefined(this.automaticTransactionGeneratorConfiguration)) {
+ let automaticTransactionGeneratorConfiguration:
+ | AutomaticTransactionGeneratorConfiguration
+ | undefined;
+ const automaticTransactionGeneratorConfigurationFromFile =
+ this.getConfigurationFromFile()?.automaticTransactionGenerator;
+ if (
+ this.getAutomaticTransactionGeneratorPersistentConfiguration() &&
+ automaticTransactionGeneratorConfigurationFromFile
+ ) {
+ automaticTransactionGeneratorConfiguration =
+ automaticTransactionGeneratorConfigurationFromFile;
+ } else {
+ automaticTransactionGeneratorConfiguration =
+ this.getTemplateFromFile()?.AutomaticTransactionGenerator;
+ }
+ this.automaticTransactionGeneratorConfiguration = {
+ ...Constants.DEFAULT_ATG_CONFIGURATION,
+ ...automaticTransactionGeneratorConfiguration,
+ };
}
- this.bootNotificationResponse = null;
- parentPort.postMessage({ id: ChargingStationWorkerMessageEvents.STOPPED, data: { id: this.stationInfo.chargingStationId } });
- this.stopped = true;
+ return this.automaticTransactionGeneratorConfiguration!;
+ }
+
+ public getAutomaticTransactionGeneratorStatuses(): Status[] | undefined {
+ return this.getConfigurationFromFile()?.automaticTransactionGeneratorStatuses;
}
- public getConfigurationKey(key: string | StandardParametersKey, caseInsensitive = false): ConfigurationKey | undefined {
- return this.configuration.configurationKey.find((configElement) => {
- if (caseInsensitive) {
- return configElement.key.toLowerCase() === key.toLowerCase();
+ public startAutomaticTransactionGenerator(connectorIds?: number[]): void {
+ this.automaticTransactionGenerator = AutomaticTransactionGenerator.getInstance(this);
+ if (isNotEmptyArray(connectorIds)) {
+ for (const connectorId of connectorIds!) {
+ this.automaticTransactionGenerator?.startConnector(connectorId);
}
- return configElement.key === key;
- });
- }
-
- public addConfigurationKey(key: string | StandardParametersKey, value: string, options: { readonly?: boolean, visible?: boolean, reboot?: boolean } = { readonly: false, visible: true, reboot: false }): void {
- const keyFound = this.getConfigurationKey(key);
- const readonly = options.readonly;
- const visible = options.visible;
- const reboot = options.reboot;
- if (!keyFound) {
- this.configuration.configurationKey.push({
- key,
- readonly,
- value,
- visible,
- reboot,
- });
} else {
- logger.error(`${this.logPrefix()} Trying to add an already existing configuration key: %j`, keyFound);
+ this.automaticTransactionGenerator?.start();
}
+ this.saveAutomaticTransactionGeneratorConfiguration();
+ parentPort?.postMessage(buildUpdatedMessage(this));
}
- public setConfigurationKeyValue(key: string | StandardParametersKey, value: string): void {
- const keyFound = this.getConfigurationKey(key);
- if (keyFound) {
- const keyIndex = this.configuration.configurationKey.indexOf(keyFound);
- this.configuration.configurationKey[keyIndex].value = value;
+ public stopAutomaticTransactionGenerator(connectorIds?: number[]): void {
+ if (isNotEmptyArray(connectorIds)) {
+ for (const connectorId of connectorIds!) {
+ this.automaticTransactionGenerator?.stopConnector(connectorId);
+ }
} else {
- logger.error(`${this.logPrefix()} Trying to set a value on a non existing configuration key: %j`, { key, value });
+ this.automaticTransactionGenerator?.stop();
+ }
+ this.saveAutomaticTransactionGeneratorConfiguration();
+ parentPort?.postMessage(buildUpdatedMessage(this));
+ }
+
+ public async stopTransactionOnConnector(
+ connectorId: number,
+ reason = StopTransactionReason.NONE,
+ ): Promise<StopTransactionResponse> {
+ const transactionId = this.getConnectorStatus(connectorId)?.transactionId;
+ if (
+ this.getBeginEndMeterValues() === true &&
+ this.getOcppStrictCompliance() === true &&
+ this.getOutOfOrderEndMeterValues() === false
+ ) {
+ // FIXME: Implement OCPP version agnostic helpers
+ const transactionEndMeterValue = OCPP16ServiceUtils.buildTransactionEndMeterValue(
+ this,
+ connectorId,
+ this.getEnergyActiveImportRegisterByTransactionId(transactionId!),
+ );
+ await this.ocppRequestService.requestHandler<MeterValuesRequest, MeterValuesResponse>(
+ this,
+ RequestCommand.METER_VALUES,
+ {
+ connectorId,
+ transactionId,
+ meterValue: [transactionEndMeterValue],
+ },
+ );
+ }
+ return this.ocppRequestService.requestHandler<StopTransactionRequest, StopTransactionResponse>(
+ this,
+ RequestCommand.STOP_TRANSACTION,
+ {
+ transactionId,
+ meterStop: this.getEnergyActiveImportRegisterByTransactionId(transactionId!, true),
+ reason,
+ },
+ );
+ }
+
+ public getReserveConnectorZeroSupported(): boolean {
+ return convertToBoolean(
+ getConfigurationKey(this, StandardParametersKey.ReserveConnectorZeroSupported)!.value,
+ );
+ }
+
+ public async addReservation(reservation: Reservation): Promise<void> {
+ const reservationFound = this.getReservationBy('reservationId', reservation.reservationId);
+ if (!isUndefined(reservationFound)) {
+ await this.removeReservation(
+ reservationFound!,
+ ReservationTerminationReason.REPLACE_EXISTING,
+ );
+ }
+ this.getConnectorStatus(reservation.connectorId)!.reservation = reservation;
+ await OCPPServiceUtils.sendAndSetConnectorStatus(
+ this,
+ reservation.connectorId,
+ ConnectorStatusEnum.Reserved,
+ undefined,
+ { send: reservation.connectorId !== 0 },
+ );
+ }
+
+ public async removeReservation(
+ reservation: Reservation,
+ reason: ReservationTerminationReason,
+ ): Promise<void> {
+ const connector = this.getConnectorStatus(reservation.connectorId)!;
+ switch (reason) {
+ case ReservationTerminationReason.CONNECTOR_STATE_CHANGED:
+ case ReservationTerminationReason.TRANSACTION_STARTED:
+ delete connector.reservation;
+ break;
+ case ReservationTerminationReason.RESERVATION_CANCELED:
+ case ReservationTerminationReason.REPLACE_EXISTING:
+ case ReservationTerminationReason.EXPIRED:
+ await OCPPServiceUtils.sendAndSetConnectorStatus(
+ this,
+ reservation.connectorId,
+ ConnectorStatusEnum.Available,
+ undefined,
+ { send: reservation.connectorId !== 0 },
+ );
+ delete connector.reservation;
+ break;
+ default:
+ // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
+ throw new BaseError(`Unknown reservation termination reason '${reason}'`);
}
}
- public setChargingProfile(connectorId: number, cp: ChargingProfile): void {
- let cpReplaced = false;
- if (!Utils.isEmptyArray(this.getConnectorStatus(connectorId).chargingProfiles)) {
- this.getConnectorStatus(connectorId).chargingProfiles?.forEach((chargingProfile: ChargingProfile, index: number) => {
- if (chargingProfile.chargingProfileId === cp.chargingProfileId
- || (chargingProfile.stackLevel === cp.stackLevel && chargingProfile.chargingProfilePurpose === cp.chargingProfilePurpose)) {
- this.getConnectorStatus(connectorId).chargingProfiles[index] = cp;
- cpReplaced = true;
+ public getReservationBy(
+ filterKey: ReservationKey,
+ value: number | string,
+ ): Reservation | undefined {
+ if (this.hasEvses) {
+ for (const evseStatus of this.evses.values()) {
+ for (const connectorStatus of evseStatus.connectors.values()) {
+ if (connectorStatus?.reservation?.[filterKey] === value) {
+ return connectorStatus.reservation;
+ }
}
- });
+ }
+ } else {
+ for (const connectorStatus of this.connectors.values()) {
+ if (connectorStatus?.reservation?.[filterKey] === value) {
+ return connectorStatus.reservation;
+ }
+ }
}
- !cpReplaced && this.getConnectorStatus(connectorId).chargingProfiles?.push(cp);
}
- public resetConnectorStatus(connectorId: number): void {
- this.getConnectorStatus(connectorId).idTagLocalAuthorized = false;
- this.getConnectorStatus(connectorId).idTagAuthorized = false;
- this.getConnectorStatus(connectorId).transactionRemoteStarted = false;
- this.getConnectorStatus(connectorId).transactionStarted = false;
- delete this.getConnectorStatus(connectorId).localAuthorizeIdTag;
- delete this.getConnectorStatus(connectorId).authorizeIdTag;
- delete this.getConnectorStatus(connectorId).transactionId;
- delete this.getConnectorStatus(connectorId).transactionIdTag;
- this.getConnectorStatus(connectorId).transactionEnergyActiveImportRegisterValue = 0;
- delete this.getConnectorStatus(connectorId).transactionBeginMeterValue;
- this.stopMeterValues(connectorId);
+ public isConnectorReservable(
+ reservationId: number,
+ idTag?: string,
+ connectorId?: number,
+ ): boolean {
+ const reservation = this.getReservationBy('reservationId', reservationId);
+ const reservationExists = !isUndefined(reservation) && !hasReservationExpired(reservation!);
+ if (arguments.length === 1) {
+ return !reservationExists;
+ } else if (arguments.length > 1) {
+ const userReservation = !isUndefined(idTag)
+ ? this.getReservationBy('idTag', idTag!)
+ : undefined;
+ const userReservationExists =
+ !isUndefined(userReservation) && !hasReservationExpired(userReservation!);
+ const notConnectorZero = isUndefined(connectorId) ? true : connectorId! > 0;
+ const freeConnectorsAvailable = this.getNumberOfReservableConnectors() > 0;
+ return (
+ !reservationExists && !userReservationExists && notConnectorZero && freeConnectorsAvailable
+ );
+ }
+ return false;
+ }
+
+ private startReservationExpirationSetInterval(customInterval?: number): void {
+ const interval = customInterval ?? Constants.DEFAULT_RESERVATION_EXPIRATION_INTERVAL;
+ if (interval > 0) {
+ logger.info(
+ `${this.logPrefix()} Reservation expiration date checks started every ${formatDurationMilliSeconds(
+ interval,
+ )}`,
+ );
+ this.reservationExpirationSetInterval = setInterval((): void => {
+ removeExpiredReservations(this).catch(Constants.EMPTY_FUNCTION);
+ }, interval);
+ }
}
- public bufferMessage(message: string): void {
- this.messageBuffer.add(message);
+ private stopReservationExpirationSetInterval(): void {
+ if (!isNullOrUndefined(this.reservationExpirationSetInterval)) {
+ clearInterval(this.reservationExpirationSetInterval);
+ }
}
- private flushMessageBuffer() {
+ // private restartReservationExpiryDateSetInterval(): void {
+ // this.stopReservationExpirationSetInterval();
+ // this.startReservationExpirationSetInterval();
+ // }
+
+ private getNumberOfReservableConnectors(): number {
+ let numberOfReservableConnectors = 0;
+ if (this.hasEvses) {
+ for (const evseStatus of this.evses.values()) {
+ numberOfReservableConnectors += getNumberOfReservableConnectors(evseStatus.connectors);
+ }
+ } else {
+ numberOfReservableConnectors = getNumberOfReservableConnectors(this.connectors);
+ }
+ return numberOfReservableConnectors - this.getNumberOfReservationsOnConnectorZero();
+ }
+
+ private getNumberOfReservationsOnConnectorZero(): number {
+ if (
+ // eslint-disable-next-line @typescript-eslint/prefer-nullish-coalescing
+ (this.hasEvses && this.evses.get(0)?.connectors.get(0)?.reservation) ||
+ (!this.hasEvses && this.connectors.get(0)?.reservation)
+ ) {
+ return 1;
+ }
+ return 0;
+ }
+
+ private flushMessageBuffer(): void {
if (this.messageBuffer.size > 0) {
- this.messageBuffer.forEach((message) => {
- // TODO: evaluate the need to track performance
- this.wsConnection.send(message);
+ for (const message of this.messageBuffer.values()) {
+ let beginId: string | undefined;
+ let commandName: RequestCommand | undefined;
+ const [messageType] = JSON.parse(message) as OutgoingRequest | Response | ErrorResponse;
+ const isRequest = messageType === MessageType.CALL_MESSAGE;
+ if (isRequest) {
+ [, , commandName] = JSON.parse(message) as OutgoingRequest;
+ beginId = PerformanceStatistics.beginMeasure(commandName);
+ }
+ this.wsConnection?.send(message);
+ isRequest && PerformanceStatistics.endMeasure(commandName!, beginId!);
+ logger.debug(
+ `${this.logPrefix()} >> Buffered ${OCPPServiceUtils.getMessageTypeString(
+ messageType,
+ )} payload sent: ${message}`,
+ );
this.messageBuffer.delete(message);
- });
+ }
}
}
return this.stationInfo.supervisionUrlOcppConfiguration ?? false;
}
- private getChargingStationId(stationTemplate: ChargingStationTemplate): string {
- // In case of multiple instances: add instance index to charging station id
- const instanceIndex = process.env.CF_INSTANCE_INDEX ?? 0;
- const idSuffix = stationTemplate.nameSuffix ?? '';
- return stationTemplate.fixedName ? stationTemplate.baseName : stationTemplate.baseName + '-' + instanceIndex.toString() + ('000000000' + this.index.toString()).substr(('000000000' + this.index.toString()).length - 4) + idSuffix;
+ private getSupervisionUrlOcppKey(): string {
+ return this.stationInfo.supervisionUrlOcppKey ?? VendorParametersKey.ConnectionUrl;
}
- private buildStationInfo(): ChargingStationInfo {
- let stationTemplateFromFile: ChargingStationTemplate;
+ private getTemplateFromFile(): ChargingStationTemplate | undefined {
+ let template: ChargingStationTemplate | undefined;
try {
- // Load template file
- const fileDescriptor = fs.openSync(this.stationTemplateFile, 'r');
- stationTemplateFromFile = JSON.parse(fs.readFileSync(fileDescriptor, 'utf8')) as ChargingStationTemplate;
- fs.closeSync(fileDescriptor);
+ if (this.sharedLRUCache.hasChargingStationTemplate(this.templateFileHash)) {
+ template = this.sharedLRUCache.getChargingStationTemplate(this.templateFileHash);
+ } else {
+ const measureId = `${FileType.ChargingStationTemplate} read`;
+ const beginId = PerformanceStatistics.beginMeasure(measureId);
+ template = JSON.parse(readFileSync(this.templateFile, 'utf8')) as ChargingStationTemplate;
+ PerformanceStatistics.endMeasure(measureId, beginId);
+ template.templateHash = createHash(Constants.DEFAULT_HASH_ALGORITHM)
+ .update(JSON.stringify(template))
+ .digest('hex');
+ this.sharedLRUCache.setChargingStationTemplate(template);
+ this.templateFileHash = template.templateHash;
+ }
} catch (error) {
- FileUtils.handleFileException(this.logPrefix(), 'Template', this.stationTemplateFile, error as NodeJS.ErrnoException);
- }
- const chargingStationId = this.getChargingStationId(stationTemplateFromFile);
- // Deprecation template keys section
- this.warnDeprecatedTemplateKey(stationTemplateFromFile, 'supervisionUrl', chargingStationId, 'Use \'supervisionUrls\' instead');
- this.convertDeprecatedTemplateKey(stationTemplateFromFile, 'supervisionUrl', 'supervisionUrls');
- const stationInfo: ChargingStationInfo = stationTemplateFromFile ?? {} as ChargingStationInfo;
- stationInfo.wsOptions = stationTemplateFromFile?.wsOptions ?? {};
- if (!Utils.isEmptyArray(stationTemplateFromFile.power)) {
- stationTemplateFromFile.power = stationTemplateFromFile.power as number[];
- const powerArrayRandomIndex = Math.floor(Utils.secureRandom() * stationTemplateFromFile.power.length);
- stationInfo.maxPower = stationTemplateFromFile.powerUnit === PowerUnits.KILO_WATT
- ? stationTemplateFromFile.power[powerArrayRandomIndex] * 1000
- : stationTemplateFromFile.power[powerArrayRandomIndex];
+ handleFileException(
+ this.templateFile,
+ FileType.ChargingStationTemplate,
+ error as NodeJS.ErrnoException,
+ this.logPrefix(),
+ );
+ }
+ return template;
+ }
+
+ private getStationInfoFromTemplate(): ChargingStationInfo {
+ const stationTemplate: ChargingStationTemplate = this.getTemplateFromFile()!;
+ checkTemplate(stationTemplate, this.logPrefix(), this.templateFile);
+ const warnTemplateKeysDeprecationOnce = once(warnTemplateKeysDeprecation, this);
+ warnTemplateKeysDeprecationOnce(stationTemplate, this.logPrefix(), this.templateFile);
+ if (stationTemplate?.Connectors) {
+ checkConnectorsConfiguration(stationTemplate, this.logPrefix(), this.templateFile);
+ }
+ const stationInfo: ChargingStationInfo = stationTemplateToStationInfo(stationTemplate);
+ stationInfo.hashId = getHashId(this.index, stationTemplate);
+ stationInfo.chargingStationId = getChargingStationId(this.index, stationTemplate);
+ stationInfo.ocppVersion = stationTemplate?.ocppVersion ?? OCPPVersion.VERSION_16;
+ createSerialNumber(stationTemplate, stationInfo);
+ if (isNotEmptyArray(stationTemplate?.power)) {
+ stationTemplate.power = stationTemplate.power as number[];
+ const powerArrayRandomIndex = Math.floor(secureRandom() * stationTemplate.power.length);
+ stationInfo.maximumPower =
+ stationTemplate?.powerUnit === PowerUnits.KILO_WATT
+ ? stationTemplate.power[powerArrayRandomIndex] * 1000
+ : stationTemplate.power[powerArrayRandomIndex];
} else {
- stationTemplateFromFile.power = stationTemplateFromFile.power as number;
- stationInfo.maxPower = stationTemplateFromFile.powerUnit === PowerUnits.KILO_WATT
- ? stationTemplateFromFile.power * 1000
- : stationTemplateFromFile.power;
- }
- delete stationInfo.power;
- delete stationInfo.powerUnit;
- stationInfo.chargingStationId = chargingStationId;
- stationInfo.resetTime = stationTemplateFromFile.resetTime ? stationTemplateFromFile.resetTime * 1000 : Constants.CHARGING_STATION_DEFAULT_RESET_TIME;
+ stationTemplate.power = stationTemplate?.power as number;
+ stationInfo.maximumPower =
+ stationTemplate?.powerUnit === PowerUnits.KILO_WATT
+ ? stationTemplate.power * 1000
+ : stationTemplate.power;
+ }
+ stationInfo.firmwareVersionPattern =
+ stationTemplate?.firmwareVersionPattern ?? Constants.SEMVER_PATTERN;
+ if (
+ isNotEmptyString(stationInfo.firmwareVersion) &&
+ new RegExp(stationInfo.firmwareVersionPattern).test(stationInfo.firmwareVersion!) === false
+ ) {
+ logger.warn(
+ `${this.logPrefix()} Firmware version '${stationInfo.firmwareVersion}' in template file ${
+ this.templateFile
+ } does not match firmware version pattern '${stationInfo.firmwareVersionPattern}'`,
+ );
+ }
+ stationInfo.firmwareUpgrade = merge<FirmwareUpgrade>(
+ {
+ versionUpgrade: {
+ step: 1,
+ },
+ reset: true,
+ },
+ stationTemplate?.firmwareUpgrade ?? {},
+ );
+ stationInfo.resetTime = !isNullOrUndefined(stationTemplate?.resetTime)
+ ? secondsToMilliseconds(stationTemplate.resetTime!)
+ : Constants.CHARGING_STATION_DEFAULT_RESET_TIME;
+ stationInfo.maximumAmperage = this.getMaximumAmperage(stationInfo);
return stationInfo;
}
- private getOcppVersion(): OCPPVersion {
- return this.stationInfo.ocppVersion ? this.stationInfo.ocppVersion : OCPPVersion.VERSION_16;
+ private getStationInfoFromFile(): ChargingStationInfo | undefined {
+ let stationInfo: ChargingStationInfo | undefined;
+ if (this.getStationInfoPersistentConfiguration()) {
+ stationInfo = this.getConfigurationFromFile()?.stationInfo;
+ if (stationInfo) {
+ delete stationInfo?.infoHash;
+ }
+ }
+ return stationInfo;
+ }
+
+ private getStationInfo(): ChargingStationInfo {
+ const stationInfoFromTemplate: ChargingStationInfo = this.getStationInfoFromTemplate();
+ const stationInfoFromFile: ChargingStationInfo | undefined = this.getStationInfoFromFile();
+ // Priority:
+ // 1. charging station info from template
+ // 2. charging station info from configuration file
+ if (stationInfoFromFile?.templateHash === stationInfoFromTemplate.templateHash) {
+ return stationInfoFromFile!;
+ }
+ stationInfoFromFile &&
+ propagateSerialNumber(
+ this.getTemplateFromFile()!,
+ stationInfoFromFile,
+ stationInfoFromTemplate,
+ );
+ return stationInfoFromTemplate;
+ }
+
+ private saveStationInfo(): void {
+ if (this.getStationInfoPersistentConfiguration()) {
+ this.saveConfiguration();
+ }
+ }
+
+ private getOcppPersistentConfiguration(): boolean {
+ return this.stationInfo?.ocppPersistentConfiguration ?? true;
+ }
+
+ private getStationInfoPersistentConfiguration(): boolean {
+ return this.stationInfo?.stationInfoPersistentConfiguration ?? true;
+ }
+
+ private getAutomaticTransactionGeneratorPersistentConfiguration(): boolean {
+ return this.stationInfo?.automaticTransactionGeneratorPersistentConfiguration ?? true;
}
private handleUnsupportedVersion(version: OCPPVersion) {
- const errMsg = `${this.logPrefix()} Unsupported protocol version '${version}' configured in template file ${this.stationTemplateFile}`;
- logger.error(errMsg);
- throw new Error(errMsg);
+ const errorMsg = `Unsupported protocol version '${version}' configured in template file ${this.templateFile}`;
+ logger.error(`${this.logPrefix()} ${errorMsg}`);
+ throw new BaseError(errorMsg);
}
private initialize(): void {
- this.stationInfo = this.buildStationInfo();
- this.configuration = this.getTemplateChargingStationConfiguration();
- delete this.stationInfo.Configuration;
- this.bootNotificationRequest = {
- chargePointModel: this.stationInfo.chargePointModel,
- chargePointVendor: this.stationInfo.chargePointVendor,
- ...!Utils.isUndefined(this.stationInfo.chargeBoxSerialNumberPrefix) && { chargeBoxSerialNumber: this.stationInfo.chargeBoxSerialNumberPrefix },
- ...!Utils.isUndefined(this.stationInfo.firmwareVersion) && { firmwareVersion: this.stationInfo.firmwareVersion },
- };
- // Build connectors if needed
- const maxConnectors = this.getMaxNumberOfConnectors();
- if (maxConnectors <= 0) {
- logger.warn(`${this.logPrefix()} Charging station template ${this.stationTemplateFile} with ${maxConnectors} connectors`);
- }
- const templateMaxConnectors = this.getTemplateMaxNumberOfConnectors();
- if (templateMaxConnectors <= 0) {
- logger.warn(`${this.logPrefix()} Charging station template ${this.stationTemplateFile} with no connector configuration`);
- }
- if (!this.stationInfo.Connectors[0]) {
- logger.warn(`${this.logPrefix()} Charging station template ${this.stationTemplateFile} with no connector Id 0 configuration`);
- }
- // Sanity check
- if (maxConnectors > (this.stationInfo.Connectors[0] ? templateMaxConnectors - 1 : templateMaxConnectors) && !this.stationInfo.randomConnectors) {
- logger.warn(`${this.logPrefix()} Number of connectors exceeds the number of connector configurations in template ${this.stationTemplateFile}, forcing random connector configurations affectation`);
- this.stationInfo.randomConnectors = true;
- }
- const connectorsConfigHash = crypto.createHash('sha256').update(JSON.stringify(this.stationInfo.Connectors) + maxConnectors.toString()).digest('hex');
- const connectorsConfigChanged = this.connectors?.size !== 0 && this.connectorsConfigurationHash !== connectorsConfigHash;
- if (this.connectors?.size === 0 || connectorsConfigChanged) {
- connectorsConfigChanged && (this.connectors.clear());
- this.connectorsConfigurationHash = connectorsConfigHash;
- // Add connector Id 0
- let lastConnector = '0';
- for (lastConnector in this.stationInfo.Connectors) {
- const lastConnectorId = Utils.convertToInt(lastConnector);
- if (lastConnectorId === 0 && this.getUseConnectorId0() && this.stationInfo.Connectors[lastConnector]) {
- this.connectors.set(lastConnectorId, Utils.cloneObject<ConnectorStatus>(this.stationInfo.Connectors[lastConnector]));
- this.getConnectorStatus(lastConnectorId).availability = AvailabilityType.OPERATIVE;
- if (Utils.isUndefined(this.getConnectorStatus(lastConnectorId)?.chargingProfiles)) {
- this.getConnectorStatus(lastConnectorId).chargingProfiles = [];
- }
- }
- }
- // Generate all connectors
- if ((this.stationInfo.Connectors[0] ? templateMaxConnectors - 1 : templateMaxConnectors) > 0) {
- for (let index = 1; index <= maxConnectors; index++) {
- const randConnectorId = this.stationInfo.randomConnectors ? Utils.getRandomInteger(Utils.convertToInt(lastConnector), 1) : index;
- this.connectors.set(index, Utils.cloneObject<ConnectorStatus>(this.stationInfo.Connectors[randConnectorId]));
- this.getConnectorStatus(index).availability = AvailabilityType.OPERATIVE;
- if (Utils.isUndefined(this.getConnectorStatus(index)?.chargingProfiles)) {
- this.getConnectorStatus(index).chargingProfiles = [];
- }
- }
- }
- }
- // Avoid duplication of connectors related information
- delete this.stationInfo.Connectors;
- // Initialize transaction attributes on connectors
- for (const connectorId of this.connectors.keys()) {
- if (connectorId > 0 && !this.getConnectorStatus(connectorId)?.transactionStarted) {
- this.initializeConnectorStatus(connectorId);
- }
+ const stationTemplate = this.getTemplateFromFile()!;
+ checkTemplate(stationTemplate, this.logPrefix(), this.templateFile);
+ this.configurationFile = join(
+ dirname(this.templateFile.replace('station-templates', 'configurations')),
+ `${getHashId(this.index, stationTemplate)}.json`,
+ );
+ const chargingStationConfiguration = this.getConfigurationFromFile();
+ if (
+ chargingStationConfiguration?.stationInfo?.templateHash === stationTemplate?.templateHash &&
+ // eslint-disable-next-line @typescript-eslint/prefer-nullish-coalescing
+ (chargingStationConfiguration?.connectorsStatus || chargingStationConfiguration?.evsesStatus)
+ ) {
+ this.initializeConnectorsOrEvsesFromFile(chargingStationConfiguration);
+ } else {
+ this.initializeConnectorsOrEvsesFromTemplate(stationTemplate);
+ }
+ this.stationInfo = this.getStationInfo();
+ if (
+ this.stationInfo.firmwareStatus === FirmwareStatus.Installing &&
+ isNotEmptyString(this.stationInfo.firmwareVersion) &&
+ isNotEmptyString(this.stationInfo.firmwareVersionPattern)
+ ) {
+ const patternGroup: number | undefined =
+ this.stationInfo.firmwareUpgrade?.versionUpgrade?.patternGroup ??
+ this.stationInfo.firmwareVersion?.split('.').length;
+ const match = this.stationInfo
+ .firmwareVersion!.match(new RegExp(this.stationInfo.firmwareVersionPattern!))!
+ .slice(1, patternGroup! + 1);
+ const patchLevelIndex = match.length - 1;
+ match[patchLevelIndex] = (
+ convertToInt(match[patchLevelIndex]) +
+ this.stationInfo.firmwareUpgrade!.versionUpgrade!.step!
+ ).toString();
+ this.stationInfo.firmwareVersion = match?.join('.');
+ }
+ this.saveStationInfo();
+ this.configuredSupervisionUrl = this.getConfiguredSupervisionUrl();
+ if (this.getEnableStatistics() === true) {
+ this.performanceStatistics = PerformanceStatistics.getInstance(
+ this.stationInfo.hashId,
+ this.stationInfo.chargingStationId!,
+ this.configuredSupervisionUrl,
+ );
+ }
+ this.bootNotificationRequest = createBootNotificationRequest(this.stationInfo);
+ this.powerDivider = this.getPowerDivider();
+ // OCPP configuration
+ this.ocppConfiguration = this.getOcppConfiguration();
+ this.initializeOcppConfiguration();
+ this.initializeOcppServices();
+ if (this.stationInfo?.autoRegister === true) {
+ this.bootNotificationResponse = {
+ currentTime: new Date(),
+ interval: millisecondsToSeconds(this.getHeartbeatInterval()),
+ status: RegistrationStatusEnumType.ACCEPTED,
+ };
}
- this.wsConfiguredConnectionUrl = new URL(this.getConfiguredSupervisionUrl().href + '/' + this.stationInfo.chargingStationId);
- switch (this.getOcppVersion()) {
+ }
+
+ private initializeOcppServices(): void {
+ const ocppVersion = this.stationInfo.ocppVersion ?? OCPPVersion.VERSION_16;
+ switch (ocppVersion) {
case OCPPVersion.VERSION_16:
- this.ocppIncomingRequestService = OCPP16IncomingRequestService.getInstance<OCPP16IncomingRequestService>(this);
- this.ocppRequestService = OCPP16RequestService.getInstance<OCPP16RequestService>(this, OCPP16ResponseService.getInstance<OCPP16ResponseService>(this));
+ this.ocppIncomingRequestService =
+ OCPP16IncomingRequestService.getInstance<OCPP16IncomingRequestService>();
+ this.ocppRequestService = OCPP16RequestService.getInstance<OCPP16RequestService>(
+ OCPP16ResponseService.getInstance<OCPP16ResponseService>(),
+ );
+ break;
+ case OCPPVersion.VERSION_20:
+ case OCPPVersion.VERSION_201:
+ this.ocppIncomingRequestService =
+ OCPP20IncomingRequestService.getInstance<OCPP20IncomingRequestService>();
+ this.ocppRequestService = OCPP20RequestService.getInstance<OCPP20RequestService>(
+ OCPP20ResponseService.getInstance<OCPP20ResponseService>(),
+ );
break;
default:
- this.handleUnsupportedVersion(this.getOcppVersion());
+ this.handleUnsupportedVersion(ocppVersion);
break;
}
- // OCPP parameters
- this.initOcppParameters();
- if (this.stationInfo.autoRegister) {
- this.bootNotificationResponse = {
- currentTime: new Date().toISOString(),
- interval: this.getHeartbeatInterval() / 1000,
- status: RegistrationStatus.ACCEPTED
- };
- }
- this.stationInfo.powerDivider = this.getPowerDivider();
- if (this.getEnableStatistics()) {
- this.performanceStatistics = PerformanceStatistics.getInstance(this.id, this.stationInfo.chargingStationId, this.wsConnectionUrl);
+ }
+
+ private initializeOcppConfiguration(): void {
+ if (!getConfigurationKey(this, StandardParametersKey.HeartbeatInterval)) {
+ addConfigurationKey(this, StandardParametersKey.HeartbeatInterval, '0');
+ }
+ if (!getConfigurationKey(this, StandardParametersKey.HeartBeatInterval)) {
+ addConfigurationKey(this, StandardParametersKey.HeartBeatInterval, '0', { visible: false });
+ }
+ if (
+ this.getSupervisionUrlOcppConfiguration() &&
+ isNotEmptyString(this.getSupervisionUrlOcppKey()) &&
+ !getConfigurationKey(this, this.getSupervisionUrlOcppKey())
+ ) {
+ addConfigurationKey(
+ this,
+ this.getSupervisionUrlOcppKey(),
+ this.configuredSupervisionUrl.href,
+ { reboot: true },
+ );
+ } else if (
+ !this.getSupervisionUrlOcppConfiguration() &&
+ isNotEmptyString(this.getSupervisionUrlOcppKey()) &&
+ getConfigurationKey(this, this.getSupervisionUrlOcppKey())
+ ) {
+ deleteConfigurationKey(this, this.getSupervisionUrlOcppKey(), { save: false });
+ }
+ if (
+ isNotEmptyString(this.stationInfo?.amperageLimitationOcppKey) &&
+ !getConfigurationKey(this, this.stationInfo.amperageLimitationOcppKey!)
+ ) {
+ addConfigurationKey(
+ this,
+ this.stationInfo.amperageLimitationOcppKey!,
+ (
+ this.stationInfo.maximumAmperage! * getAmperageLimitationUnitDivider(this.stationInfo)
+ ).toString(),
+ );
+ }
+ if (!getConfigurationKey(this, StandardParametersKey.SupportedFeatureProfiles)) {
+ addConfigurationKey(
+ this,
+ StandardParametersKey.SupportedFeatureProfiles,
+ `${SupportedFeatureProfiles.Core},${SupportedFeatureProfiles.FirmwareManagement},${SupportedFeatureProfiles.LocalAuthListManagement},${SupportedFeatureProfiles.SmartCharging},${SupportedFeatureProfiles.RemoteTrigger}`,
+ );
+ }
+ addConfigurationKey(
+ this,
+ StandardParametersKey.NumberOfConnectors,
+ this.getNumberOfConnectors().toString(),
+ { readonly: true },
+ { overwrite: true },
+ );
+ if (!getConfigurationKey(this, StandardParametersKey.MeterValuesSampledData)) {
+ addConfigurationKey(
+ this,
+ StandardParametersKey.MeterValuesSampledData,
+ MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER,
+ );
+ }
+ if (!getConfigurationKey(this, StandardParametersKey.ConnectorPhaseRotation)) {
+ const connectorsPhaseRotation: string[] = [];
+ if (this.hasEvses) {
+ for (const evseStatus of this.evses.values()) {
+ for (const connectorId of evseStatus.connectors.keys()) {
+ connectorsPhaseRotation.push(
+ getPhaseRotationValue(connectorId, this.getNumberOfPhases())!,
+ );
+ }
+ }
+ } else {
+ for (const connectorId of this.connectors.keys()) {
+ connectorsPhaseRotation.push(
+ getPhaseRotationValue(connectorId, this.getNumberOfPhases())!,
+ );
+ }
+ }
+ addConfigurationKey(
+ this,
+ StandardParametersKey.ConnectorPhaseRotation,
+ connectorsPhaseRotation.toString(),
+ );
+ }
+ if (!getConfigurationKey(this, StandardParametersKey.AuthorizeRemoteTxRequests)) {
+ addConfigurationKey(this, StandardParametersKey.AuthorizeRemoteTxRequests, 'true');
+ }
+ if (
+ !getConfigurationKey(this, StandardParametersKey.LocalAuthListEnabled) &&
+ getConfigurationKey(this, StandardParametersKey.SupportedFeatureProfiles)?.value?.includes(
+ SupportedFeatureProfiles.LocalAuthListManagement,
+ )
+ ) {
+ addConfigurationKey(this, StandardParametersKey.LocalAuthListEnabled, 'false');
+ }
+ if (!getConfigurationKey(this, StandardParametersKey.ConnectionTimeOut)) {
+ addConfigurationKey(
+ this,
+ StandardParametersKey.ConnectionTimeOut,
+ Constants.DEFAULT_CONNECTION_TIMEOUT.toString(),
+ );
+ }
+ this.saveOcppConfiguration();
+ }
+
+ private initializeConnectorsOrEvsesFromFile(configuration: ChargingStationConfiguration): void {
+ if (configuration?.connectorsStatus && !configuration?.evsesStatus) {
+ for (const [connectorId, connectorStatus] of configuration.connectorsStatus.entries()) {
+ this.connectors.set(connectorId, cloneObject<ConnectorStatus>(connectorStatus));
+ }
+ } else if (configuration?.evsesStatus && !configuration?.connectorsStatus) {
+ for (const [evseId, evseStatusConfiguration] of configuration.evsesStatus.entries()) {
+ const evseStatus = cloneObject<EvseStatusConfiguration>(evseStatusConfiguration);
+ delete evseStatus.connectorsStatus;
+ this.evses.set(evseId, {
+ ...(evseStatus as EvseStatus),
+ connectors: new Map<number, ConnectorStatus>(
+ evseStatusConfiguration.connectorsStatus!.map((connectorStatus, connectorId) => [
+ connectorId,
+ connectorStatus,
+ ]),
+ ),
+ });
+ }
+ } else if (configuration?.evsesStatus && configuration?.connectorsStatus) {
+ const errorMsg = `Connectors and evses defined at the same time in configuration file ${this.configurationFile}`;
+ logger.error(`${this.logPrefix()} ${errorMsg}`);
+ throw new BaseError(errorMsg);
+ } else {
+ const errorMsg = `No connectors or evses defined in configuration file ${this.configurationFile}`;
+ logger.error(`${this.logPrefix()} ${errorMsg}`);
+ throw new BaseError(errorMsg);
}
}
- private initOcppParameters(): void {
- if (this.getSupervisionUrlOcppConfiguration() && !this.getConfigurationKey(this.stationInfo.supervisionUrlOcppKey ?? VendorDefaultParametersKey.ConnectionUrl)) {
- this.addConfigurationKey(VendorDefaultParametersKey.ConnectionUrl, this.getConfiguredSupervisionUrl().href, { reboot: true });
+ private initializeConnectorsOrEvsesFromTemplate(stationTemplate: ChargingStationTemplate) {
+ if (stationTemplate?.Connectors && !stationTemplate?.Evses) {
+ this.initializeConnectorsFromTemplate(stationTemplate);
+ } else if (stationTemplate?.Evses && !stationTemplate?.Connectors) {
+ this.initializeEvsesFromTemplate(stationTemplate);
+ } else if (stationTemplate?.Evses && stationTemplate?.Connectors) {
+ const errorMsg = `Connectors and evses defined at the same time in template file ${this.templateFile}`;
+ logger.error(`${this.logPrefix()} ${errorMsg}`);
+ throw new BaseError(errorMsg);
+ } else {
+ const errorMsg = `No connectors or evses defined in template file ${this.templateFile}`;
+ logger.error(`${this.logPrefix()} ${errorMsg}`);
+ throw new BaseError(errorMsg);
+ }
+ }
+
+ private initializeConnectorsFromTemplate(stationTemplate: ChargingStationTemplate): void {
+ if (!stationTemplate?.Connectors && this.connectors.size === 0) {
+ const errorMsg = `No already defined connectors and charging station information from template ${this.templateFile} with no connectors configuration defined`;
+ logger.error(`${this.logPrefix()} ${errorMsg}`);
+ throw new BaseError(errorMsg);
+ }
+ if (!stationTemplate?.Connectors?.[0]) {
+ logger.warn(
+ `${this.logPrefix()} Charging station information from template ${
+ this.templateFile
+ } with no connector id 0 configuration`,
+ );
+ }
+ if (stationTemplate?.Connectors) {
+ const { configuredMaxConnectors, templateMaxConnectors, templateMaxAvailableConnectors } =
+ checkConnectorsConfiguration(stationTemplate, this.logPrefix(), this.templateFile);
+ const connectorsConfigHash = createHash(Constants.DEFAULT_HASH_ALGORITHM)
+ .update(
+ `${JSON.stringify(stationTemplate?.Connectors)}${configuredMaxConnectors.toString()}`,
+ )
+ .digest('hex');
+ const connectorsConfigChanged =
+ this.connectors?.size !== 0 && this.connectorsConfigurationHash !== connectorsConfigHash;
+ if (this.connectors?.size === 0 || connectorsConfigChanged) {
+ connectorsConfigChanged && this.connectors.clear();
+ this.connectorsConfigurationHash = connectorsConfigHash;
+ if (templateMaxConnectors > 0) {
+ for (let connectorId = 0; connectorId <= configuredMaxConnectors; connectorId++) {
+ if (
+ connectorId === 0 &&
+ (!stationTemplate?.Connectors?.[connectorId] ||
+ this.getUseConnectorId0(stationTemplate) === false)
+ ) {
+ continue;
+ }
+ const templateConnectorId =
+ connectorId > 0 && stationTemplate?.randomConnectors
+ ? getRandomInteger(templateMaxAvailableConnectors, 1)
+ : connectorId;
+ const connectorStatus = stationTemplate?.Connectors[templateConnectorId];
+ checkStationInfoConnectorStatus(
+ templateConnectorId,
+ connectorStatus,
+ this.logPrefix(),
+ this.templateFile,
+ );
+ this.connectors.set(connectorId, cloneObject<ConnectorStatus>(connectorStatus));
+ }
+ initializeConnectorsMapStatus(this.connectors, this.logPrefix());
+ this.saveConnectorsStatus();
+ } else {
+ logger.warn(
+ `${this.logPrefix()} Charging station information from template ${
+ this.templateFile
+ } with no connectors configuration defined, cannot create connectors`,
+ );
+ }
+ }
+ } else {
+ logger.warn(
+ `${this.logPrefix()} Charging station information from template ${
+ this.templateFile
+ } with no connectors configuration defined, using already defined connectors`,
+ );
+ }
+ }
+
+ private initializeEvsesFromTemplate(stationTemplate: ChargingStationTemplate): void {
+ if (!stationTemplate?.Evses && this.evses.size === 0) {
+ const errorMsg = `No already defined evses and charging station information from template ${this.templateFile} with no evses configuration defined`;
+ logger.error(`${this.logPrefix()} ${errorMsg}`);
+ throw new BaseError(errorMsg);
+ }
+ if (!stationTemplate?.Evses?.[0]) {
+ logger.warn(
+ `${this.logPrefix()} Charging station information from template ${
+ this.templateFile
+ } with no evse id 0 configuration`,
+ );
+ }
+ if (!stationTemplate?.Evses?.[0]?.Connectors?.[0]) {
+ logger.warn(
+ `${this.logPrefix()} Charging station information from template ${
+ this.templateFile
+ } with evse id 0 with no connector id 0 configuration`,
+ );
+ }
+ if (Object.keys(stationTemplate?.Evses?.[0]?.Connectors as object).length > 1) {
+ logger.warn(
+ `${this.logPrefix()} Charging station information from template ${
+ this.templateFile
+ } with evse id 0 with more than one connector configuration, only connector id 0 configuration will be used`,
+ );
+ }
+ if (stationTemplate?.Evses) {
+ const evsesConfigHash = createHash(Constants.DEFAULT_HASH_ALGORITHM)
+ .update(JSON.stringify(stationTemplate?.Evses))
+ .digest('hex');
+ const evsesConfigChanged =
+ this.evses?.size !== 0 && this.evsesConfigurationHash !== evsesConfigHash;
+ if (this.evses?.size === 0 || evsesConfigChanged) {
+ evsesConfigChanged && this.evses.clear();
+ this.evsesConfigurationHash = evsesConfigHash;
+ const templateMaxEvses = getMaxNumberOfEvses(stationTemplate?.Evses);
+ if (templateMaxEvses > 0) {
+ for (const evseKey in stationTemplate.Evses) {
+ const evseId = convertToInt(evseKey);
+ this.evses.set(evseId, {
+ connectors: buildConnectorsMap(
+ stationTemplate?.Evses[evseKey]?.Connectors,
+ this.logPrefix(),
+ this.templateFile,
+ ),
+ availability: AvailabilityType.Operative,
+ });
+ initializeConnectorsMapStatus(this.evses.get(evseId)!.connectors, this.logPrefix());
+ }
+ this.saveEvsesStatus();
+ } else {
+ logger.warn(
+ `${this.logPrefix()} Charging station information from template ${
+ this.templateFile
+ } with no evses configuration defined, cannot create evses`,
+ );
+ }
+ }
+ } else {
+ logger.warn(
+ `${this.logPrefix()} Charging station information from template ${
+ this.templateFile
+ } with no evses configuration defined, using already defined evses`,
+ );
}
- if (!this.getConfigurationKey(StandardParametersKey.SupportedFeatureProfiles)) {
- this.addConfigurationKey(StandardParametersKey.SupportedFeatureProfiles, `${SupportedFeatureProfiles.Core},${SupportedFeatureProfiles.Local_Auth_List_Management},${SupportedFeatureProfiles.Smart_Charging}`);
+ }
+
+ private getConfigurationFromFile(): ChargingStationConfiguration | undefined {
+ let configuration: ChargingStationConfiguration | undefined;
+ if (isNotEmptyString(this.configurationFile) && existsSync(this.configurationFile)) {
+ try {
+ if (this.sharedLRUCache.hasChargingStationConfiguration(this.configurationFileHash)) {
+ configuration = this.sharedLRUCache.getChargingStationConfiguration(
+ this.configurationFileHash,
+ );
+ } else {
+ const measureId = `${FileType.ChargingStationConfiguration} read`;
+ const beginId = PerformanceStatistics.beginMeasure(measureId);
+ configuration = JSON.parse(
+ readFileSync(this.configurationFile, 'utf8'),
+ ) as ChargingStationConfiguration;
+ PerformanceStatistics.endMeasure(measureId, beginId);
+ this.sharedLRUCache.setChargingStationConfiguration(configuration);
+ this.configurationFileHash = configuration.configurationHash!;
+ }
+ } catch (error) {
+ handleFileException(
+ this.configurationFile,
+ FileType.ChargingStationConfiguration,
+ error as NodeJS.ErrnoException,
+ this.logPrefix(),
+ );
+ }
}
- this.addConfigurationKey(StandardParametersKey.NumberOfConnectors, this.getNumberOfConnectors().toString(), { readonly: true });
- if (!this.getConfigurationKey(StandardParametersKey.MeterValuesSampledData)) {
- this.addConfigurationKey(StandardParametersKey.MeterValuesSampledData, MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER);
+ return configuration;
+ }
+
+ private saveAutomaticTransactionGeneratorConfiguration(): void {
+ if (this.getAutomaticTransactionGeneratorPersistentConfiguration()) {
+ this.saveConfiguration();
}
- if (!this.getConfigurationKey(StandardParametersKey.ConnectorPhaseRotation)) {
- const connectorPhaseRotation = [];
- for (const connectorId of this.connectors.keys()) {
- // AC/DC
- if (connectorId === 0 && this.getNumberOfPhases() === 0) {
- connectorPhaseRotation.push(`${connectorId}.${ConnectorPhaseRotation.RST}`);
- } else if (connectorId > 0 && this.getNumberOfPhases() === 0) {
- connectorPhaseRotation.push(`${connectorId}.${ConnectorPhaseRotation.NotApplicable}`);
- // AC
- } else if (connectorId > 0 && this.getNumberOfPhases() === 1) {
- connectorPhaseRotation.push(`${connectorId}.${ConnectorPhaseRotation.NotApplicable}`);
- } else if (connectorId > 0 && this.getNumberOfPhases() === 3) {
- connectorPhaseRotation.push(`${connectorId}.${ConnectorPhaseRotation.RST}`);
+ }
+
+ private saveConnectorsStatus() {
+ this.saveConfiguration();
+ }
+
+ private saveEvsesStatus() {
+ this.saveConfiguration();
+ }
+
+ private saveConfiguration(): void {
+ if (isNotEmptyString(this.configurationFile)) {
+ try {
+ if (!existsSync(dirname(this.configurationFile))) {
+ mkdirSync(dirname(this.configurationFile), { recursive: true });
+ }
+ let configurationData: ChargingStationConfiguration = this.getConfigurationFromFile()
+ ? cloneObject<ChargingStationConfiguration>(this.getConfigurationFromFile()!)
+ : {};
+ if (this.getStationInfoPersistentConfiguration() && this.stationInfo) {
+ configurationData.stationInfo = this.stationInfo;
+ } else {
+ delete configurationData.stationInfo;
+ }
+ if (this.getOcppPersistentConfiguration() && this.ocppConfiguration?.configurationKey) {
+ configurationData.configurationKey = this.ocppConfiguration.configurationKey;
+ } else {
+ delete configurationData.configurationKey;
+ }
+ configurationData = merge<ChargingStationConfiguration>(
+ configurationData,
+ buildChargingStationAutomaticTransactionGeneratorConfiguration(this),
+ );
+ if (
+ !this.getAutomaticTransactionGeneratorPersistentConfiguration() ||
+ !this.getAutomaticTransactionGeneratorConfiguration()
+ ) {
+ delete configurationData.automaticTransactionGenerator;
+ }
+ if (this.connectors.size > 0) {
+ configurationData.connectorsStatus = buildConnectorsStatus(this);
+ } else {
+ delete configurationData.connectorsStatus;
+ }
+ if (this.evses.size > 0) {
+ configurationData.evsesStatus = buildEvsesStatus(this);
+ } else {
+ delete configurationData.evsesStatus;
+ }
+ delete configurationData.configurationHash;
+ const configurationHash = createHash(Constants.DEFAULT_HASH_ALGORITHM)
+ .update(
+ JSON.stringify({
+ stationInfo: configurationData.stationInfo,
+ configurationKey: configurationData.configurationKey,
+ automaticTransactionGenerator: configurationData.automaticTransactionGenerator,
+ } as ChargingStationConfiguration),
+ )
+ .digest('hex');
+ if (this.configurationFileHash !== configurationHash) {
+ AsyncLock.runExclusive(AsyncLockType.configuration, () => {
+ configurationData.configurationHash = configurationHash;
+ const measureId = `${FileType.ChargingStationConfiguration} write`;
+ const beginId = PerformanceStatistics.beginMeasure(measureId);
+ writeFileSync(
+ this.configurationFile,
+ JSON.stringify(configurationData, null, 2),
+ 'utf8',
+ );
+ PerformanceStatistics.endMeasure(measureId, beginId);
+ this.sharedLRUCache.deleteChargingStationConfiguration(this.configurationFileHash);
+ this.sharedLRUCache.setChargingStationConfiguration(configurationData);
+ this.configurationFileHash = configurationHash;
+ }).catch((error) => {
+ handleFileException(
+ this.configurationFile,
+ FileType.ChargingStationConfiguration,
+ error as NodeJS.ErrnoException,
+ this.logPrefix(),
+ );
+ });
+ } else {
+ logger.debug(
+ `${this.logPrefix()} Not saving unchanged charging station configuration file ${
+ this.configurationFile
+ }`,
+ );
}
+ } catch (error) {
+ handleFileException(
+ this.configurationFile,
+ FileType.ChargingStationConfiguration,
+ error as NodeJS.ErrnoException,
+ this.logPrefix(),
+ );
}
- this.addConfigurationKey(StandardParametersKey.ConnectorPhaseRotation, connectorPhaseRotation.toString());
- }
- if (!this.getConfigurationKey(StandardParametersKey.AuthorizeRemoteTxRequests)) {
- this.addConfigurationKey(StandardParametersKey.AuthorizeRemoteTxRequests, 'true');
+ } else {
+ logger.error(
+ `${this.logPrefix()} Trying to save charging station configuration to undefined configuration file`,
+ );
}
- if (!this.getConfigurationKey(StandardParametersKey.LocalAuthListEnabled)
- && this.getConfigurationKey(StandardParametersKey.SupportedFeatureProfiles).value.includes(SupportedFeatureProfiles.Local_Auth_List_Management)) {
- this.addConfigurationKey(StandardParametersKey.LocalAuthListEnabled, 'false');
+ }
+
+ private getOcppConfigurationFromTemplate(): ChargingStationOcppConfiguration | undefined {
+ return this.getTemplateFromFile()?.Configuration;
+ }
+
+ private getOcppConfigurationFromFile(): ChargingStationOcppConfiguration | undefined {
+ const configurationKey = this.getConfigurationFromFile()?.configurationKey;
+ if (this.getOcppPersistentConfiguration() === true && configurationKey) {
+ return { configurationKey };
}
- if (!this.getConfigurationKey(StandardParametersKey.ConnectionTimeOut)) {
- this.addConfigurationKey(StandardParametersKey.ConnectionTimeOut, Constants.DEFAULT_CONNECTION_TIMEOUT.toString());
+ return undefined;
+ }
+
+ private getOcppConfiguration(): ChargingStationOcppConfiguration | undefined {
+ let ocppConfiguration: ChargingStationOcppConfiguration | undefined =
+ this.getOcppConfigurationFromFile();
+ if (!ocppConfiguration) {
+ ocppConfiguration = this.getOcppConfigurationFromTemplate();
}
+ return ocppConfiguration;
}
private async onOpen(): Promise<void> {
- logger.info(`${this.logPrefix()} Connected to OCPP server through ${this.wsConnectionUrl.toString()}`);
- if (!this.isInAcceptedState()) {
- // Send BootNotification
- let registrationRetryCount = 0;
- do {
- this.bootNotificationResponse = await this.ocppRequestService.sendBootNotification(this.bootNotificationRequest.chargePointModel,
- this.bootNotificationRequest.chargePointVendor, this.bootNotificationRequest.chargeBoxSerialNumber, this.bootNotificationRequest.firmwareVersion);
- if (!this.isInAcceptedState()) {
- this.getRegistrationMaxRetries() !== -1 && registrationRetryCount++;
- await Utils.sleep(this.bootNotificationResponse?.interval ? this.bootNotificationResponse.interval * 1000 : Constants.OCPP_DEFAULT_BOOT_NOTIFICATION_INTERVAL);
+ if (this.isWebSocketConnectionOpened() === true) {
+ logger.info(
+ `${this.logPrefix()} Connection to OCPP server through ${this.wsConnectionUrl.toString()} succeeded`,
+ );
+ if (this.isRegistered() === false) {
+ // Send BootNotification
+ let registrationRetryCount = 0;
+ do {
+ this.bootNotificationResponse = await this.ocppRequestService.requestHandler<
+ BootNotificationRequest,
+ BootNotificationResponse
+ >(this, RequestCommand.BOOT_NOTIFICATION, this.bootNotificationRequest, {
+ skipBufferingOnError: true,
+ });
+ if (this.isRegistered() === false) {
+ this.getRegistrationMaxRetries() !== -1 && ++registrationRetryCount;
+ await sleep(
+ this?.bootNotificationResponse?.interval
+ ? secondsToMilliseconds(this.bootNotificationResponse.interval)
+ : Constants.DEFAULT_BOOT_NOTIFICATION_INTERVAL,
+ );
+ }
+ } while (
+ this.isRegistered() === false &&
+ (registrationRetryCount <= this.getRegistrationMaxRetries()! ||
+ this.getRegistrationMaxRetries() === -1)
+ );
+ }
+ if (this.isRegistered() === true) {
+ if (this.inAcceptedState() === true) {
+ await this.startMessageSequence();
}
- } while (!this.isInAcceptedState() && (registrationRetryCount <= this.getRegistrationMaxRetries() || this.getRegistrationMaxRetries() === -1));
- }
- if (this.isInAcceptedState()) {
- await this.startMessageSequence();
- this.stopped && (this.stopped = false);
- if (this.wsConnectionRestarted && this.isWebSocketConnectionOpened()) {
- this.flushMessageBuffer();
+ } else {
+ logger.error(
+ `${this.logPrefix()} Registration failure: max retries reached (${this.getRegistrationMaxRetries()}) or retry disabled (${this.getRegistrationMaxRetries()})`,
+ );
}
+ this.wsConnectionRestarted = false;
+ this.autoReconnectRetryCount = 0;
+ parentPort?.postMessage(buildUpdatedMessage(this));
} else {
- logger.error(`${this.logPrefix()} Registration failure: max retries reached (${this.getRegistrationMaxRetries()}) or retry disabled (${this.getRegistrationMaxRetries()})`);
+ logger.warn(
+ `${this.logPrefix()} Connection to OCPP server through ${this.wsConnectionUrl.toString()} failed`,
+ );
}
- this.autoReconnectRetryCount = 0;
- this.wsConnectionRestarted = false;
}
- private async onClose(code: number, reason: string): Promise<void> {
+ private async onClose(code: number, reason: Buffer): Promise<void> {
switch (code) {
// Normal close
case WebSocketCloseEventStatusCode.CLOSE_NORMAL:
case WebSocketCloseEventStatusCode.CLOSE_NO_STATUS:
- logger.info(`${this.logPrefix()} WebSocket normally closed with status '${Utils.getWebSocketCloseEventStatusString(code)}' and reason '${reason}'`);
+ logger.info(
+ `${this.logPrefix()} WebSocket normally closed with status '${getWebSocketCloseEventStatusString(
+ code,
+ )}' and reason '${reason.toString()}'`,
+ );
this.autoReconnectRetryCount = 0;
break;
// Abnormal close
default:
- logger.error(`${this.logPrefix()} WebSocket abnormally closed with status '${Utils.getWebSocketCloseEventStatusString(code)}' and reason '${reason}'`);
- await this.reconnect(code);
+ logger.error(
+ `${this.logPrefix()} WebSocket abnormally closed with status '${getWebSocketCloseEventStatusString(
+ code,
+ )}' and reason '${reason.toString()}'`,
+ );
+ this.started === true && (await this.reconnect());
break;
}
- }
-
- private async onMessage(data: Data): Promise<void> {
- let [messageType, messageId, commandName, commandPayload, errorDetails]: IncomingRequest = [0, '', '' as IncomingRequestCommand, {}, {}];
- let responseCallback: (payload: JsonType | string, requestPayload: JsonType | OCPPError) => void;
- let rejectCallback: (error: OCPPError, requestStatistic?: boolean) => void;
- let requestCommandName: RequestCommand | IncomingRequestCommand;
- let requestPayload: JsonType | OCPPError;
- let cachedRequest: CachedRequest;
- let errMsg: string;
+ parentPort?.postMessage(buildUpdatedMessage(this));
+ }
+
+ private getCachedRequest(messageType: MessageType, messageId: string): CachedRequest | undefined {
+ const cachedRequest = this.requests.get(messageId);
+ if (Array.isArray(cachedRequest) === true) {
+ return cachedRequest;
+ }
+ throw new OCPPError(
+ ErrorType.PROTOCOL_ERROR,
+ `Cached request for message id ${messageId} ${OCPPServiceUtils.getMessageTypeString(
+ messageType,
+ )} is not an array`,
+ undefined,
+ cachedRequest as JsonType,
+ );
+ }
+
+ private async handleIncomingMessage(request: IncomingRequest): Promise<void> {
+ const [messageType, messageId, commandName, commandPayload] = request;
+ if (this.getEnableStatistics() === true) {
+ this.performanceStatistics?.addRequestStatistic(commandName, messageType);
+ }
+ logger.debug(
+ `${this.logPrefix()} << Command '${commandName}' received request payload: ${JSON.stringify(
+ request,
+ )}`,
+ );
+ // Process the message
+ await this.ocppIncomingRequestService.incomingRequestHandler(
+ this,
+ messageId,
+ commandName,
+ commandPayload,
+ );
+ }
+
+ private handleResponseMessage(response: Response): void {
+ const [messageType, messageId, commandPayload] = response;
+ if (this.requests.has(messageId) === false) {
+ // Error
+ throw new OCPPError(
+ ErrorType.INTERNAL_ERROR,
+ `Response for unknown message id ${messageId}`,
+ undefined,
+ commandPayload,
+ );
+ }
+ // Respond
+ const [responseCallback, , requestCommandName, requestPayload] = this.getCachedRequest(
+ messageType,
+ messageId,
+ )!;
+ logger.debug(
+ `${this.logPrefix()} << Command '${
+ requestCommandName ?? Constants.UNKNOWN_COMMAND
+ }' received response payload: ${JSON.stringify(response)}`,
+ );
+ responseCallback(commandPayload, requestPayload);
+ }
+
+ private handleErrorMessage(errorResponse: ErrorResponse): void {
+ const [messageType, messageId, errorType, errorMessage, errorDetails] = errorResponse;
+ if (this.requests.has(messageId) === false) {
+ // Error
+ throw new OCPPError(
+ ErrorType.INTERNAL_ERROR,
+ `Error response for unknown message id ${messageId}`,
+ undefined,
+ { errorType, errorMessage, errorDetails },
+ );
+ }
+ const [, errorCallback, requestCommandName] = this.getCachedRequest(messageType, messageId)!;
+ logger.debug(
+ `${this.logPrefix()} << Command '${
+ requestCommandName ?? Constants.UNKNOWN_COMMAND
+ }' received error response payload: ${JSON.stringify(errorResponse)}`,
+ );
+ errorCallback(new OCPPError(errorType, errorMessage, requestCommandName, errorDetails));
+ }
+
+ private async onMessage(data: RawData): Promise<void> {
+ let request: IncomingRequest | Response | ErrorResponse | undefined;
+ let messageType: number | undefined;
+ let errorMsg: string;
try {
- const request = JSON.parse(data.toString()) as IncomingRequest;
- if (Utils.isIterable(request)) {
- // Parse the message
- [messageType, messageId, commandName, commandPayload, errorDetails] = request;
+ // eslint-disable-next-line @typescript-eslint/no-base-to-string
+ request = JSON.parse(data.toString()) as IncomingRequest | Response | ErrorResponse;
+ if (Array.isArray(request) === true) {
+ [messageType] = request;
+ // Check the type of message
+ switch (messageType) {
+ // Incoming Message
+ case MessageType.CALL_MESSAGE:
+ await this.handleIncomingMessage(request as IncomingRequest);
+ break;
+ // Response Message
+ case MessageType.CALL_RESULT_MESSAGE:
+ this.handleResponseMessage(request as Response);
+ break;
+ // Error Message
+ case MessageType.CALL_ERROR_MESSAGE:
+ this.handleErrorMessage(request as ErrorResponse);
+ break;
+ // Unknown Message
+ default:
+ // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
+ errorMsg = `Wrong message type ${messageType}`;
+ logger.error(`${this.logPrefix()} ${errorMsg}`);
+ throw new OCPPError(ErrorType.PROTOCOL_ERROR, errorMsg);
+ }
+ parentPort?.postMessage(buildUpdatedMessage(this));
} else {
- throw new OCPPError(ErrorType.PROTOCOL_ERROR, 'Incoming request is not iterable', commandName);
+ throw new OCPPError(
+ ErrorType.PROTOCOL_ERROR,
+ 'Incoming message is not an array',
+ undefined,
+ {
+ request,
+ },
+ );
}
- // Check the Type of message
+ } catch (error) {
+ let commandName: IncomingRequestCommand | undefined;
+ let requestCommandName: RequestCommand | IncomingRequestCommand | undefined;
+ let errorCallback: ErrorCallback;
+ const [, messageId] = request!;
switch (messageType) {
- // Incoming Message
case MessageType.CALL_MESSAGE:
- if (this.getEnableStatistics()) {
- this.performanceStatistics.addRequestStatistic(commandName, messageType);
- }
- // Process the call
- await this.ocppIncomingRequestService.handleRequest(messageId, commandName, commandPayload);
+ [, , commandName] = request as IncomingRequest;
+ // Send error
+ await this.ocppRequestService.sendError(this, messageId, error as OCPPError, commandName);
break;
- // Outcome Message
case MessageType.CALL_RESULT_MESSAGE:
- // Respond
- cachedRequest = this.requests.get(messageId);
- if (Utils.isIterable(cachedRequest)) {
- [responseCallback, , , requestPayload] = cachedRequest;
- } else {
- throw new OCPPError(ErrorType.PROTOCOL_ERROR, `Cached request for message id ${messageId} response is not iterable`, commandName);
- }
- if (!responseCallback) {
- // Error
- throw new OCPPError(ErrorType.INTERNAL_ERROR, `Response for unknown message id ${messageId}`, commandName);
- }
- responseCallback(commandName, requestPayload);
- break;
- // Error Message
case MessageType.CALL_ERROR_MESSAGE:
- cachedRequest = this.requests.get(messageId);
- if (Utils.isIterable(cachedRequest)) {
- [, rejectCallback, requestCommandName] = cachedRequest;
+ if (this.requests.has(messageId) === true) {
+ [, errorCallback, requestCommandName] = this.getCachedRequest(messageType, messageId)!;
+ // Reject the deferred promise in case of error at response handling (rejecting an already fulfilled promise is a no-op)
+ errorCallback(error as OCPPError, false);
} else {
- throw new OCPPError(ErrorType.PROTOCOL_ERROR, `Cached request for message id ${messageId} error response is not iterable`);
- }
- if (!rejectCallback) {
- // Error
- throw new OCPPError(ErrorType.INTERNAL_ERROR, `Error response for unknown message id ${messageId}`, requestCommandName);
+ // Remove the request from the cache in case of error at response handling
+ this.requests.delete(messageId);
}
- rejectCallback(new OCPPError(commandName, commandPayload.toString(), requestCommandName, errorDetails));
break;
- // Error
- default:
- errMsg = `${this.logPrefix()} Wrong message type ${messageType}`;
- logger.error(errMsg);
- throw new OCPPError(ErrorType.PROTOCOL_ERROR, errMsg);
}
- } catch (error) {
- // Log
- logger.error('%s Incoming OCPP message %j matching cached request %j processing error %j', this.logPrefix(), data.toString(), this.requests.get(messageId), error);
- // Send error
- messageType === MessageType.CALL_MESSAGE && await this.ocppRequestService.sendError(messageId, error as OCPPError, commandName);
+ if (error instanceof OCPPError === false) {
+ logger.warn(
+ `${this.logPrefix()} Error thrown at incoming OCPP command '${
+ commandName ?? requestCommandName ?? Constants.UNKNOWN_COMMAND
+ // eslint-disable-next-line @typescript-eslint/no-base-to-string
+ }' message '${data.toString()}' handling is not an OCPPError:`,
+ error,
+ );
+ }
+ logger.error(
+ `${this.logPrefix()} Incoming OCPP command '${
+ commandName ?? requestCommandName ?? Constants.UNKNOWN_COMMAND
+ // eslint-disable-next-line @typescript-eslint/no-base-to-string
+ }' message '${data.toString()}'${
+ messageType !== MessageType.CALL_MESSAGE
+ ? ` matching cached request '${JSON.stringify(this.requests.get(messageId))}'`
+ : ''
+ } processing error:`,
+ error,
+ );
}
}
private onPing(): void {
- logger.debug(this.logPrefix() + ' Received a WS ping (rfc6455) from the server');
+ logger.debug(`${this.logPrefix()} Received a WS ping (rfc6455) from the server`);
}
private onPong(): void {
- logger.debug(this.logPrefix() + ' Received a WS pong (rfc6455) from the server');
+ logger.debug(`${this.logPrefix()} Received a WS pong (rfc6455) from the server`);
}
- private async onError(error: WSError): Promise<void> {
- logger.error(this.logPrefix() + ' WebSocket error: %j', error);
- // switch (error.code) {
- // case 'ECONNREFUSED':
- // await this.reconnect(error);
- // break;
- // }
+ private onError(error: WSError): void {
+ this.closeWSConnection();
+ logger.error(`${this.logPrefix()} WebSocket error:`, error);
}
- private getTemplateChargingStationConfiguration(): ChargingStationConfiguration {
- return this.stationInfo.Configuration ?? {} as ChargingStationConfiguration;
+ private getEnergyActiveImportRegister(connectorStatus: ConnectorStatus, rounded = false): number {
+ if (this.getMeteringPerTransaction() === true) {
+ return (
+ (rounded === true
+ ? Math.round(connectorStatus.transactionEnergyActiveImportRegisterValue!)
+ : connectorStatus?.transactionEnergyActiveImportRegisterValue) ?? 0
+ );
+ }
+ return (
+ (rounded === true
+ ? Math.round(connectorStatus.energyActiveImportRegisterValue!)
+ : connectorStatus?.energyActiveImportRegisterValue) ?? 0
+ );
}
- private getAuthorizationFile(): string | undefined {
- return this.stationInfo.authorizationFile && path.join(path.resolve(__dirname, '../'), 'assets', path.basename(this.stationInfo.authorizationFile));
+ private getUseConnectorId0(stationTemplate?: ChargingStationTemplate): boolean {
+ return stationTemplate?.useConnectorId0 ?? true;
}
- private getAuthorizedTags(): string[] {
- let authorizedTags: string[] = [];
- const authorizationFile = this.getAuthorizationFile();
- if (authorizationFile) {
- try {
- // Load authorization file
- const fileDescriptor = fs.openSync(authorizationFile, 'r');
- authorizedTags = JSON.parse(fs.readFileSync(fileDescriptor, 'utf8')) as string[];
- fs.closeSync(fileDescriptor);
- } catch (error) {
- FileUtils.handleFileException(this.logPrefix(), 'Authorization', authorizationFile, error as NodeJS.ErrnoException);
+ private async stopRunningTransactions(reason = StopTransactionReason.NONE): Promise<void> {
+ if (this.hasEvses) {
+ for (const [evseId, evseStatus] of this.evses) {
+ if (evseId === 0) {
+ continue;
+ }
+ for (const [connectorId, connectorStatus] of evseStatus.connectors) {
+ if (connectorStatus.transactionStarted === true) {
+ await this.stopTransactionOnConnector(connectorId, reason);
+ }
+ }
}
} else {
- logger.info(this.logPrefix() + ' No authorization file given in template file ' + this.stationTemplateFile);
- }
- return authorizedTags;
- }
-
- private getUseConnectorId0(): boolean | undefined {
- return !Utils.isUndefined(this.stationInfo.useConnectorId0) ? this.stationInfo.useConnectorId0 : true;
- }
-
- private getNumberOfRunningTransactions(): number {
- let trxCount = 0;
- for (const connectorId of this.connectors.keys()) {
- if (connectorId > 0 && this.getConnectorStatus(connectorId)?.transactionStarted) {
- trxCount++;
+ for (const connectorId of this.connectors.keys()) {
+ if (connectorId > 0 && this.getConnectorStatus(connectorId)?.transactionStarted === true) {
+ await this.stopTransactionOnConnector(connectorId, reason);
+ }
}
}
- return trxCount;
}
// 0 for disabling
- private getConnectionTimeout(): number | undefined {
- if (this.getConfigurationKey(StandardParametersKey.ConnectionTimeOut)) {
- return parseInt(this.getConfigurationKey(StandardParametersKey.ConnectionTimeOut).value) ?? Constants.DEFAULT_CONNECTION_TIMEOUT;
+ private getConnectionTimeout(): number {
+ if (getConfigurationKey(this, StandardParametersKey.ConnectionTimeOut)) {
+ return (
+ parseInt(getConfigurationKey(this, StandardParametersKey.ConnectionTimeOut)!.value!) ??
+ Constants.DEFAULT_CONNECTION_TIMEOUT
+ );
}
return Constants.DEFAULT_CONNECTION_TIMEOUT;
}
// -1 for unlimited, 0 for disabling
private getAutoReconnectMaxRetries(): number | undefined {
- if (!Utils.isUndefined(this.stationInfo.autoReconnectMaxRetries)) {
- return this.stationInfo.autoReconnectMaxRetries;
- }
- if (!Utils.isUndefined(Configuration.getAutoReconnectMaxRetries())) {
- return Configuration.getAutoReconnectMaxRetries();
- }
- return -1;
+ return this.stationInfo.autoReconnectMaxRetries ?? -1;
}
- // 0 for disabling
+ // -1 for unlimited, 0 for disabling
private getRegistrationMaxRetries(): number | undefined {
- if (!Utils.isUndefined(this.stationInfo.registrationMaxRetries)) {
- return this.stationInfo.registrationMaxRetries;
- }
- return -1;
+ return this.stationInfo.registrationMaxRetries ?? -1;
}
private getPowerDivider(): number {
- let powerDivider = this.getNumberOfConnectors();
- if (this.stationInfo.powerSharedByConnectors) {
+ let powerDivider = this.hasEvses ? this.getNumberOfEvses() : this.getNumberOfConnectors();
+ if (this.stationInfo?.powerSharedByConnectors) {
powerDivider = this.getNumberOfRunningTransactions();
}
return powerDivider;
}
- private getTemplateMaxNumberOfConnectors(): number {
- return Object.keys(this.stationInfo.Connectors).length;
+ private getMaximumAmperage(stationInfo: ChargingStationInfo): number | undefined {
+ const maximumPower = this.getMaximumPower(stationInfo);
+ switch (this.getCurrentOutType(stationInfo)) {
+ case CurrentType.AC:
+ return ACElectricUtils.amperagePerPhaseFromPower(
+ this.getNumberOfPhases(stationInfo),
+ maximumPower / (this.hasEvses ? this.getNumberOfEvses() : this.getNumberOfConnectors()),
+ this.getVoltageOut(stationInfo),
+ );
+ case CurrentType.DC:
+ return DCElectricUtils.amperage(maximumPower, this.getVoltageOut(stationInfo));
+ }
}
- private getMaxNumberOfConnectors(): number {
- let maxConnectors: number;
- if (!Utils.isEmptyArray(this.stationInfo.numberOfConnectors)) {
- const numberOfConnectors = this.stationInfo.numberOfConnectors as number[];
- // Distribute evenly the number of connectors
- maxConnectors = numberOfConnectors[(this.index - 1) % numberOfConnectors.length];
- } else if (!Utils.isUndefined(this.stationInfo.numberOfConnectors)) {
- maxConnectors = this.stationInfo.numberOfConnectors as number;
- } else {
- maxConnectors = this.stationInfo.Connectors[0] ? this.getTemplateMaxNumberOfConnectors() - 1 : this.getTemplateMaxNumberOfConnectors();
+ private getAmperageLimitation(): number | undefined {
+ if (
+ isNotEmptyString(this.stationInfo?.amperageLimitationOcppKey) &&
+ getConfigurationKey(this, this.stationInfo.amperageLimitationOcppKey!)
+ ) {
+ return (
+ convertToInt(
+ getConfigurationKey(this, this.stationInfo.amperageLimitationOcppKey!)?.value,
+ ) / getAmperageLimitationUnitDivider(this.stationInfo)
+ );
}
- return maxConnectors;
}
private async startMessageSequence(): Promise<void> {
- if (this.stationInfo.autoRegister) {
- await this.ocppRequestService.sendBootNotification(this.bootNotificationRequest.chargePointModel,
- this.bootNotificationRequest.chargePointVendor, this.bootNotificationRequest.chargeBoxSerialNumber, this.bootNotificationRequest.firmwareVersion);
+ if (this.stationInfo?.autoRegister === true) {
+ await this.ocppRequestService.requestHandler<
+ BootNotificationRequest,
+ BootNotificationResponse
+ >(this, RequestCommand.BOOT_NOTIFICATION, this.bootNotificationRequest, {
+ skipBufferingOnError: true,
+ });
}
// Start WebSocket ping
this.startWebSocketPing();
// Start heartbeat
this.startHeartbeat();
// Initialize connectors status
- for (const connectorId of this.connectors.keys()) {
- if (connectorId === 0) {
- continue;
- } else if (!this.stopped && !this.getConnectorStatus(connectorId)?.status && this.getConnectorStatus(connectorId)?.bootStatus) {
- // Send status in template at startup
- await this.ocppRequestService.sendStatusNotification(connectorId, this.getConnectorStatus(connectorId).bootStatus);
- this.getConnectorStatus(connectorId).status = this.getConnectorStatus(connectorId).bootStatus;
- } else if (this.stopped && this.getConnectorStatus(connectorId)?.status && this.getConnectorStatus(connectorId)?.bootStatus) {
- // Send status in template after reset
- await this.ocppRequestService.sendStatusNotification(connectorId, this.getConnectorStatus(connectorId).bootStatus);
- this.getConnectorStatus(connectorId).status = this.getConnectorStatus(connectorId).bootStatus;
- } else if (!this.stopped && this.getConnectorStatus(connectorId)?.status) {
- // Send previous status at template reload
- await this.ocppRequestService.sendStatusNotification(connectorId, this.getConnectorStatus(connectorId).status);
- } else {
- // Send default status
- await this.ocppRequestService.sendStatusNotification(connectorId, ChargePointStatus.AVAILABLE);
- this.getConnectorStatus(connectorId).status = ChargePointStatus.AVAILABLE;
+ if (this.hasEvses) {
+ for (const [evseId, evseStatus] of this.evses) {
+ if (evseId > 0) {
+ for (const [connectorId, connectorStatus] of evseStatus.connectors) {
+ const connectorBootStatus = getBootConnectorStatus(this, connectorId, connectorStatus);
+ await OCPPServiceUtils.sendAndSetConnectorStatus(
+ this,
+ connectorId,
+ connectorBootStatus,
+ evseId,
+ );
+ }
+ }
+ }
+ } else {
+ for (const connectorId of this.connectors.keys()) {
+ if (connectorId > 0) {
+ const connectorBootStatus = getBootConnectorStatus(
+ this,
+ connectorId,
+ this.getConnectorStatus(connectorId)!,
+ );
+ await OCPPServiceUtils.sendAndSetConnectorStatus(this, connectorId, connectorBootStatus);
+ }
}
}
- // Start the ATG
- this.startAutomaticTransactionGenerator();
- }
+ if (this.stationInfo?.firmwareStatus === FirmwareStatus.Installing) {
+ await this.ocppRequestService.requestHandler<
+ FirmwareStatusNotificationRequest,
+ FirmwareStatusNotificationResponse
+ >(this, RequestCommand.FIRMWARE_STATUS_NOTIFICATION, {
+ status: FirmwareStatus.Installed,
+ });
+ this.stationInfo.firmwareStatus = FirmwareStatus.Installed;
+ }
- private startAutomaticTransactionGenerator() {
- if (this.stationInfo.AutomaticTransactionGenerator.enable) {
- if (!this.automaticTransactionGenerator) {
- this.automaticTransactionGenerator = AutomaticTransactionGenerator.getInstance(this);
- }
- if (!this.automaticTransactionGenerator.started) {
- this.automaticTransactionGenerator.start();
- }
+ // Start the ATG
+ if (this.getAutomaticTransactionGeneratorConfiguration()?.enable === true) {
+ this.startAutomaticTransactionGenerator();
}
+ this.wsConnectionRestarted === true && this.flushMessageBuffer();
}
- private async stopMessageSequence(reason: StopTransactionReason = StopTransactionReason.NONE): Promise<void> {
+ private async stopMessageSequence(
+ reason: StopTransactionReason = StopTransactionReason.NONE,
+ ): Promise<void> {
// Stop WebSocket ping
this.stopWebSocketPing();
// Stop heartbeat
this.stopHeartbeat();
- // Stop the ATG
- if (this.stationInfo.AutomaticTransactionGenerator.enable &&
- this.automaticTransactionGenerator?.started) {
- this.automaticTransactionGenerator.stop();
+ // Stop ongoing transactions
+ if (this.automaticTransactionGenerator?.started === true) {
+ this.stopAutomaticTransactionGenerator();
+ } else {
+ await this.stopRunningTransactions(reason);
+ }
+ if (this.hasEvses) {
+ for (const [evseId, evseStatus] of this.evses) {
+ if (evseId > 0) {
+ for (const [connectorId, connectorStatus] of evseStatus.connectors) {
+ await this.ocppRequestService.requestHandler<
+ StatusNotificationRequest,
+ StatusNotificationResponse
+ >(
+ this,
+ RequestCommand.STATUS_NOTIFICATION,
+ OCPPServiceUtils.buildStatusNotificationRequest(
+ this,
+ connectorId,
+ ConnectorStatusEnum.Unavailable,
+ evseId,
+ ),
+ );
+ delete connectorStatus?.status;
+ }
+ }
+ }
} else {
for (const connectorId of this.connectors.keys()) {
- if (connectorId > 0 && this.getConnectorStatus(connectorId)?.transactionStarted) {
- const transactionId = this.getConnectorStatus(connectorId).transactionId;
- await this.ocppRequestService.sendStopTransaction(transactionId, this.getEnergyActiveImportRegisterByTransactionId(transactionId),
- this.getTransactionIdTag(transactionId), reason);
+ if (connectorId > 0) {
+ await this.ocppRequestService.requestHandler<
+ StatusNotificationRequest,
+ StatusNotificationResponse
+ >(
+ this,
+ RequestCommand.STATUS_NOTIFICATION,
+ OCPPServiceUtils.buildStatusNotificationRequest(
+ this,
+ connectorId,
+ ConnectorStatusEnum.Unavailable,
+ ),
+ );
+ delete this.getConnectorStatus(connectorId)?.status;
}
}
}
}
private startWebSocketPing(): void {
- const webSocketPingInterval: number = this.getConfigurationKey(StandardParametersKey.WebSocketPingInterval)
- ? Utils.convertToInt(this.getConfigurationKey(StandardParametersKey.WebSocketPingInterval).value)
+ const webSocketPingInterval: number = getConfigurationKey(
+ this,
+ StandardParametersKey.WebSocketPingInterval,
+ )
+ ? convertToInt(getConfigurationKey(this, StandardParametersKey.WebSocketPingInterval)?.value)
: 0;
if (webSocketPingInterval > 0 && !this.webSocketPingSetInterval) {
this.webSocketPingSetInterval = setInterval(() => {
- if (this.isWebSocketConnectionOpened()) {
- this.wsConnection.ping((): void => { /* This is intentional */ });
+ if (this.isWebSocketConnectionOpened() === true) {
+ this.wsConnection?.ping();
}
- }, webSocketPingInterval * 1000);
- logger.info(this.logPrefix() + ' WebSocket ping started every ' + Utils.formatDurationSeconds(webSocketPingInterval));
+ }, secondsToMilliseconds(webSocketPingInterval));
+ logger.info(
+ `${this.logPrefix()} WebSocket ping started every ${formatDurationSeconds(
+ webSocketPingInterval,
+ )}`,
+ );
} else if (this.webSocketPingSetInterval) {
- logger.info(this.logPrefix() + ' WebSocket ping every ' + Utils.formatDurationSeconds(webSocketPingInterval) + ' already started');
+ logger.info(
+ `${this.logPrefix()} WebSocket ping already started every ${formatDurationSeconds(
+ webSocketPingInterval,
+ )}`,
+ );
} else {
- logger.error(`${this.logPrefix()} WebSocket ping interval set to ${webSocketPingInterval ? Utils.formatDurationSeconds(webSocketPingInterval) : webSocketPingInterval}, not starting the WebSocket ping`);
+ logger.error(
+ `${this.logPrefix()} WebSocket ping interval set to ${webSocketPingInterval}, not starting the WebSocket ping`,
+ );
}
}
private stopWebSocketPing(): void {
if (this.webSocketPingSetInterval) {
clearInterval(this.webSocketPingSetInterval);
- }
- }
-
- private warnDeprecatedTemplateKey(template: ChargingStationTemplate, key: string, chargingStationId: string, logMsgToAppend = ''): void {
- if (!Utils.isUndefined(template[key])) {
- logger.warn(`${Utils.logPrefix(` ${chargingStationId} |`)} Deprecated template key '${key}' usage in file '${this.stationTemplateFile}'${logMsgToAppend && '. ' + logMsgToAppend}`);
- }
- }
-
- private convertDeprecatedTemplateKey(template: ChargingStationTemplate, deprecatedKey: string, key: string): void {
- if (!Utils.isUndefined(template[deprecatedKey])) {
- // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
- template[key] = template[deprecatedKey];
- delete template[deprecatedKey];
+ delete this.webSocketPingSetInterval;
}
}
private getConfiguredSupervisionUrl(): URL {
- const supervisionUrls = Utils.cloneObject<string | string[]>(this.stationInfo.supervisionUrls ?? Configuration.getSupervisionUrls());
- if (!Utils.isEmptyArray(supervisionUrls)) {
- let urlIndex = 0;
+ let configuredSupervisionUrl: string;
+ const supervisionUrls = this.stationInfo?.supervisionUrls ?? Configuration.getSupervisionUrls();
+ if (isNotEmptyArray(supervisionUrls)) {
+ let configuredSupervisionUrlIndex: number;
switch (Configuration.getSupervisionUrlDistribution()) {
- case SupervisionUrlDistribution.ROUND_ROBIN:
- urlIndex = (this.index - 1) % supervisionUrls.length;
- break;
case SupervisionUrlDistribution.RANDOM:
- // Get a random url
- urlIndex = Math.floor(Utils.secureRandom() * supervisionUrls.length);
- break;
- case SupervisionUrlDistribution.SEQUENTIAL:
- if (this.index <= supervisionUrls.length) {
- urlIndex = this.index - 1;
- } else {
- logger.warn(`${this.logPrefix()} No more configured supervision urls available, using the first one`);
- }
+ configuredSupervisionUrlIndex = Math.floor(
+ secureRandom() * (supervisionUrls as string[]).length,
+ );
break;
+ case SupervisionUrlDistribution.ROUND_ROBIN:
+ case SupervisionUrlDistribution.CHARGING_STATION_AFFINITY:
default:
- logger.error(`${this.logPrefix()} Unknown supervision url distribution '${Configuration.getSupervisionUrlDistribution()}' from values '${SupervisionUrlDistribution.toString()}', defaulting to ${SupervisionUrlDistribution.ROUND_ROBIN}`);
- urlIndex = (this.index - 1) % supervisionUrls.length;
+ Object.values(SupervisionUrlDistribution).includes(
+ Configuration.getSupervisionUrlDistribution()!,
+ ) === false &&
+ logger.error(
+ // eslint-disable-next-line @typescript-eslint/no-base-to-string
+ `${this.logPrefix()} Unknown supervision url distribution '${Configuration.getSupervisionUrlDistribution()}' from values '${SupervisionUrlDistribution.toString()}', defaulting to ${
+ SupervisionUrlDistribution.CHARGING_STATION_AFFINITY
+ }`,
+ );
+ configuredSupervisionUrlIndex = (this.index - 1) % (supervisionUrls as string[]).length;
break;
}
- return new URL(supervisionUrls[urlIndex]);
- }
- return new URL(supervisionUrls as string);
- }
-
- private getHeartbeatInterval(): number | undefined {
- const HeartbeatInterval = this.getConfigurationKey(StandardParametersKey.HeartbeatInterval);
- if (HeartbeatInterval) {
- return Utils.convertToInt(HeartbeatInterval.value) * 1000;
+ configuredSupervisionUrl = (supervisionUrls as string[])[configuredSupervisionUrlIndex];
+ } else {
+ configuredSupervisionUrl = supervisionUrls as string;
}
- const HeartBeatInterval = this.getConfigurationKey(StandardParametersKey.HeartBeatInterval);
- if (HeartBeatInterval) {
- return Utils.convertToInt(HeartBeatInterval.value) * 1000;
+ if (isNotEmptyString(configuredSupervisionUrl)) {
+ return new URL(configuredSupervisionUrl);
}
- !this.stationInfo.autoRegister && logger.warn(`${this.logPrefix()} Heartbeat interval configuration key not set, using default value: ${Constants.DEFAULT_HEARTBEAT_INTERVAL}`);
- return Constants.DEFAULT_HEARTBEAT_INTERVAL;
+ const errorMsg = 'No supervision url(s) configured';
+ logger.error(`${this.logPrefix()} ${errorMsg}`);
+ throw new BaseError(`${errorMsg}`);
}
private stopHeartbeat(): void {
if (this.heartbeatSetInterval) {
clearInterval(this.heartbeatSetInterval);
+ delete this.heartbeatSetInterval;
}
}
- private openWSConnection(options: ClientOptions & ClientRequestArgs = this.stationInfo.wsOptions, forceCloseOpened = false): void {
- options.handshakeTimeout = options?.handshakeTimeout ?? this.getConnectionTimeout() * 1000;
- if (!Utils.isNullOrUndefined(this.stationInfo.supervisionUser) && !Utils.isNullOrUndefined(this.stationInfo.supervisionPassword)) {
- options.auth = `${this.stationInfo.supervisionUser}:${this.stationInfo.supervisionPassword}`;
- }
- if (this.isWebSocketConnectionOpened() && forceCloseOpened) {
- this.wsConnection.close();
- }
- let protocol: string;
- switch (this.getOcppVersion()) {
- case OCPPVersion.VERSION_16:
- protocol = 'ocpp' + OCPPVersion.VERSION_16;
- break;
- default:
- this.handleUnsupportedVersion(this.getOcppVersion());
- break;
- }
- this.wsConnection = new WebSocket(this.wsConnectionUrl, protocol, options);
- logger.info(this.logPrefix() + ' Open OCPP connection to URL ' + this.wsConnectionUrl.toString());
- }
-
- private stopMeterValues(connectorId: number) {
- if (this.getConnectorStatus(connectorId)?.transactionSetInterval) {
- clearInterval(this.getConnectorStatus(connectorId).transactionSetInterval);
- }
- }
-
- private startAuthorizationFileMonitoring(): void {
- const authorizationFile = this.getAuthorizationFile();
- if (authorizationFile) {
- try {
- fs.watch(authorizationFile, (event, filename) => {
- if (filename && event === 'change') {
- try {
- logger.debug(this.logPrefix() + ' Authorization file ' + authorizationFile + ' have changed, reload');
- // Initialize authorizedTags
- this.authorizedTags = this.getAuthorizedTags();
- } catch (error) {
- logger.error(this.logPrefix() + ' Authorization file monitoring error: %j', error);
- }
- }
- });
- } catch (error) {
- FileUtils.handleFileException(this.logPrefix(), 'Authorization', authorizationFile, error as NodeJS.ErrnoException);
- }
- } else {
- logger.info(this.logPrefix() + ' No authorization file given in template file ' + this.stationTemplateFile + '. Not monitoring changes');
- }
- }
-
- private startStationTemplateFileMonitoring(): void {
- try {
- fs.watch(this.stationTemplateFile, (event, filename): void => {
- if (filename && event === 'change') {
- try {
- logger.debug(this.logPrefix() + ' Template file ' + this.stationTemplateFile + ' have changed, reload');
- // Initialize
- this.initialize();
- // Restart the ATG
- if (!this.stationInfo.AutomaticTransactionGenerator.enable &&
- this.automaticTransactionGenerator) {
- this.automaticTransactionGenerator.stop();
- }
- this.startAutomaticTransactionGenerator();
- if (this.getEnableStatistics()) {
- this.performanceStatistics.restart();
- } else {
- this.performanceStatistics.stop();
- }
- // FIXME?: restart heartbeat and WebSocket ping when their interval values have changed
- } catch (error) {
- logger.error(this.logPrefix() + ' Charging station template file monitoring error: %j', error);
- }
- }
- });
- } catch (error) {
- FileUtils.handleFileException(this.logPrefix(), 'Template', this.stationTemplateFile, error as NodeJS.ErrnoException);
+ private terminateWSConnection(): void {
+ if (this.isWebSocketConnectionOpened() === true) {
+ this.wsConnection?.terminate();
+ this.wsConnection = null;
}
}
- private getReconnectExponentialDelay(): boolean | undefined {
- return !Utils.isUndefined(this.stationInfo.reconnectExponentialDelay) ? this.stationInfo.reconnectExponentialDelay : false;
+ private getReconnectExponentialDelay(): boolean {
+ return this.stationInfo?.reconnectExponentialDelay ?? false;
}
- private async reconnect(code: number): Promise<void> {
+ private async reconnect(): Promise<void> {
// Stop WebSocket ping
this.stopWebSocketPing();
// Stop heartbeat
this.stopHeartbeat();
// Stop the ATG if needed
- if (this.stationInfo.AutomaticTransactionGenerator.enable &&
- this.stationInfo.AutomaticTransactionGenerator.stopOnConnectionFailure &&
- this.automaticTransactionGenerator?.started) {
- this.automaticTransactionGenerator.stop();
- }
- if (this.autoReconnectRetryCount < this.getAutoReconnectMaxRetries() || this.getAutoReconnectMaxRetries() === -1) {
- this.autoReconnectRetryCount++;
- const reconnectDelay = (this.getReconnectExponentialDelay() ? Utils.exponentialDelay(this.autoReconnectRetryCount) : this.getConnectionTimeout() * 1000);
- const reconnectTimeout = (reconnectDelay - 100) > 0 && reconnectDelay;
- logger.error(`${this.logPrefix()} WebSocket: connection retry in ${Utils.roundTo(reconnectDelay, 2)}ms, timeout ${reconnectTimeout}ms`);
- await Utils.sleep(reconnectDelay);
- logger.error(this.logPrefix() + ' WebSocket: reconnecting try #' + this.autoReconnectRetryCount.toString());
- this.openWSConnection({ ...this.stationInfo.wsOptions, handshakeTimeout: reconnectTimeout }, true);
+ if (this.getAutomaticTransactionGeneratorConfiguration().stopOnConnectionFailure === true) {
+ this.stopAutomaticTransactionGenerator();
+ }
+ if (
+ this.autoReconnectRetryCount < this.getAutoReconnectMaxRetries()! ||
+ this.getAutoReconnectMaxRetries() === -1
+ ) {
+ ++this.autoReconnectRetryCount;
+ const reconnectDelay = this.getReconnectExponentialDelay()
+ ? exponentialDelay(this.autoReconnectRetryCount)
+ : secondsToMilliseconds(this.getConnectionTimeout());
+ const reconnectDelayWithdraw = 1000;
+ const reconnectTimeout =
+ reconnectDelay && reconnectDelay - reconnectDelayWithdraw > 0
+ ? reconnectDelay - reconnectDelayWithdraw
+ : 0;
+ logger.error(
+ `${this.logPrefix()} WebSocket connection retry in ${roundTo(
+ reconnectDelay,
+ 2,
+ )}ms, timeout ${reconnectTimeout}ms`,
+ );
+ await sleep(reconnectDelay);
+ logger.error(
+ `${this.logPrefix()} WebSocket connection retry #${this.autoReconnectRetryCount.toString()}`,
+ );
+ this.openWSConnection(
+ {
+ handshakeTimeout: reconnectTimeout,
+ },
+ { closeOpened: true },
+ );
this.wsConnectionRestarted = true;
} else if (this.getAutoReconnectMaxRetries() !== -1) {
- logger.error(`${this.logPrefix()} WebSocket reconnect failure: max retries reached (${this.autoReconnectRetryCount}) or retry disabled (${this.getAutoReconnectMaxRetries()})`);
+ logger.error(
+ `${this.logPrefix()} WebSocket connection retries failure: maximum retries reached (${
+ this.autoReconnectRetryCount
+ }) or retries disabled (${this.getAutoReconnectMaxRetries()})`,
+ );
}
}
-
- private initializeConnectorStatus(connectorId: number): void {
- this.getConnectorStatus(connectorId).idTagLocalAuthorized = false;
- this.getConnectorStatus(connectorId).idTagAuthorized = false;
- this.getConnectorStatus(connectorId).transactionRemoteStarted = false;
- this.getConnectorStatus(connectorId).transactionStarted = false;
- this.getConnectorStatus(connectorId).energyActiveImportRegisterValue = 0;
- this.getConnectorStatus(connectorId).transactionEnergyActiveImportRegisterValue = 0;
- }
}
-