// Partial Copyright Jerome Benoit. 2021. All Rights Reserved.
-import { ACElectricUtils, DCElectricUtils } from '../utils/ElectricUtils';
+import crypto from 'crypto';
+import fs from 'fs';
+import path from 'path';
+import { URL, fileURLToPath } from 'url';
+import { parentPort } from 'worker_threads';
+
+import WebSocket, { Data, RawData } from 'ws';
+
+import BaseError from '../exception/BaseError';
+import OCPPError from '../exception/OCPPError';
+import PerformanceStatistics from '../performance/PerformanceStatistics';
+import { AutomaticTransactionGeneratorConfiguration } from '../types/AutomaticTransactionGenerator';
+import ChargingStationConfiguration from '../types/ChargingStationConfiguration';
+import ChargingStationInfo from '../types/ChargingStationInfo';
+import ChargingStationOcppConfiguration from '../types/ChargingStationOcppConfiguration';
+import ChargingStationTemplate, {
+ CurrentType,
+ PowerUnits,
+ WsOptions,
+} from '../types/ChargingStationTemplate';
+import { ChargingStationWorkerMessageEvents } from '../types/ChargingStationWorker';
+import { SupervisionUrlDistribution } from '../types/ConfigurationData';
+import { ConnectorStatus } from '../types/ConnectorStatus';
+import { FileType } from '../types/FileType';
+import { JsonType } from '../types/JsonType';
+import { ChargePointErrorCode } from '../types/ocpp/ChargePointErrorCode';
+import { ChargePointStatus } from '../types/ocpp/ChargePointStatus';
+import { ChargingProfile, ChargingRateUnitType } from '../types/ocpp/ChargingProfile';
+import {
+ ConnectorPhaseRotation,
+ StandardParametersKey,
+ SupportedFeatureProfiles,
+ VendorDefaultParametersKey,
+} from '../types/ocpp/Configuration';
+import { ErrorType } from '../types/ocpp/ErrorType';
+import { MessageType } from '../types/ocpp/MessageType';
+import { MeterValue, MeterValueMeasurand } from '../types/ocpp/MeterValues';
+import { OCPPVersion } from '../types/ocpp/OCPPVersion';
import {
AvailabilityType,
BootNotificationRequest,
Response,
StatusNotificationResponse,
} from '../types/ocpp/Responses';
-import { ChargingProfile, ChargingRateUnitType } from '../types/ocpp/ChargingProfile';
-import ChargingStationConfiguration, { Section } from '../types/ChargingStationConfiguration';
-import ChargingStationTemplate, {
- CurrentType,
- PowerUnits,
- WsOptions,
-} from '../types/ChargingStationTemplate';
-import {
- ConnectorPhaseRotation,
- StandardParametersKey,
- SupportedFeatureProfiles,
- VendorDefaultParametersKey,
-} from '../types/ocpp/Configuration';
-import { MeterValue, MeterValueMeasurand } from '../types/ocpp/MeterValues';
import {
StopTransactionReason,
StopTransactionRequest,
StopTransactionResponse,
} from '../types/ocpp/Transaction';
import { WSError, WebSocketCloseEventStatusCode } from '../types/WebSocket';
-import WebSocket, { Data, OPEN, RawData } from 'ws';
-
-import AutomaticTransactionGenerator from './AutomaticTransactionGenerator';
-import BaseError from '../exception/BaseError';
-import { ChargePointErrorCode } from '../types/ocpp/ChargePointErrorCode';
-import { ChargePointStatus } from '../types/ocpp/ChargePointStatus';
-import { ChargingStationConfigurationUtils } from './ChargingStationConfigurationUtils';
-import ChargingStationInfo from '../types/ChargingStationInfo';
-import ChargingStationOcppConfiguration from '../types/ChargingStationOcppConfiguration';
-import { ChargingStationUtils } from './ChargingStationUtils';
-import { ChargingStationWorkerMessageEvents } from '../types/ChargingStationWorker';
import Configuration from '../utils/Configuration';
-import { ConnectorStatus } from '../types/ConnectorStatus';
import Constants from '../utils/Constants';
-import { ErrorType } from '../types/ocpp/ErrorType';
-import { FileType } from '../types/FileType';
+import { ACElectricUtils, DCElectricUtils } from '../utils/ElectricUtils';
import FileUtils from '../utils/FileUtils';
-import { JsonType } from '../types/JsonType';
-import { MessageType } from '../types/ocpp/MessageType';
+import logger from '../utils/Logger';
+import Utils from '../utils/Utils';
+import AuthorizedTagsCache from './AuthorizedTagsCache';
+import AutomaticTransactionGenerator from './AutomaticTransactionGenerator';
+import { ChargingStationConfigurationUtils } from './ChargingStationConfigurationUtils';
+import { ChargingStationUtils } from './ChargingStationUtils';
import OCPP16IncomingRequestService from './ocpp/1.6/OCPP16IncomingRequestService';
import OCPP16RequestService from './ocpp/1.6/OCPP16RequestService';
import OCPP16ResponseService from './ocpp/1.6/OCPP16ResponseService';
import { OCPP16ServiceUtils } from './ocpp/1.6/OCPP16ServiceUtils';
-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 { 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';
+import SharedLRUCache from './SharedLRUCache';
export default class ChargingStation {
public hashId!: string;
public readonly templateFile: string;
- public authorizedTags: string[];
+ public authorizedTagsCache: AuthorizedTagsCache;
public stationInfo!: ChargingStationInfo;
public readonly connectors: Map<number, ConnectorStatus>;
public ocppConfiguration!: ChargingStationOcppConfiguration;
public heartbeatSetInterval!: NodeJS.Timeout;
public ocppRequestService!: OCPPRequestService;
public bootNotificationResponse!: BootNotificationResponse | null;
+ public powerDivider!: number;
private readonly index: number;
private configurationFile!: string;
+ private configurationFileHash!: string;
private bootNotificationRequest!: BootNotificationRequest;
private connectorsConfigurationHash!: string;
private ocppIncomingRequestService!: OCPPIncomingRequestService;
private readonly messageBuffer: Set<string>;
- private wsConfiguredConnectionUrl!: URL;
+ private configuredSupervisionUrl!: URL;
private wsConnectionRestarted: boolean;
- private stopped: boolean;
private autoReconnectRetryCount: number;
+ private stopped: boolean;
+ private templateFileWatcher!: fs.FSWatcher;
+ private readonly sharedLRUCache: SharedLRUCache;
private automaticTransactionGenerator!: AutomaticTransactionGenerator;
private webSocketPingSetInterval!: NodeJS.Timeout;
this.stopped = false;
this.wsConnectionRestarted = false;
this.autoReconnectRetryCount = 0;
+ this.sharedLRUCache = SharedLRUCache.getInstance();
+ this.authorizedTagsCache = AuthorizedTagsCache.getInstance();
this.connectors = new Map<number, ConnectorStatus>();
this.requests = new Map<string, CachedRequest>();
this.messageBuffer = new Set<string>();
this.initialize();
- this.authorizedTags = this.getAuthorizedTags();
}
private get wsConnectionUrl(): URL {
- return this.getSupervisionUrlOcppConfiguration()
- ? new URL(
- ChargingStationConfigurationUtils.getConfigurationKey(
+ return new URL(
+ (this.getSupervisionUrlOcppConfiguration()
+ ? ChargingStationConfigurationUtils.getConfigurationKey(
this,
this.getSupervisionUrlOcppKey()
- ).value +
- '/' +
- this.stationInfo.chargingStationId
- )
- : this.wsConfiguredConnectionUrl;
+ ).value
+ : this.configuredSupervisionUrl.href) +
+ '/' +
+ this.stationInfo.chargingStationId
+ );
}
public logPrefix(): string {
}
public getRandomIdTag(): string {
- const index = Math.floor(Utils.secureRandom() * this.authorizedTags.length);
- return this.authorizedTags[index];
+ const authorizationFile = ChargingStationUtils.getAuthorizationFile(this.stationInfo);
+ const index = Math.floor(
+ Utils.secureRandom() * this.authorizedTagsCache.getAuthorizedTags(authorizationFile).length
+ );
+ return this.authorizedTagsCache.getAuthorizedTags(authorizationFile)[index];
}
public hasAuthorizedTags(): boolean {
- return !Utils.isEmptyArray(this.authorizedTags);
+ return !Utils.isEmptyArray(
+ this.authorizedTagsCache.getAuthorizedTags(
+ ChargingStationUtils.getAuthorizationFile(this.stationInfo)
+ )
+ );
}
public getEnableStatistics(): boolean | undefined {
return this.stationInfo.mayAuthorizeAtRemoteStart ?? true;
}
- public getNumberOfPhases(): number | undefined {
- switch (this.getCurrentOutType()) {
+ public getNumberOfPhases(stationInfo?: ChargingStationInfo): number | undefined {
+ const localStationInfo: ChargingStationInfo = stationInfo ?? this.stationInfo;
+ switch (this.getCurrentOutType(stationInfo)) {
case CurrentType.AC:
- return !Utils.isUndefined(this.stationInfo.numberOfPhases)
- ? this.stationInfo.numberOfPhases
+ return !Utils.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 {
return this.connectors.get(id);
}
- public getCurrentOutType(): CurrentType | undefined {
- return this.stationInfo.currentOutType ?? CurrentType.AC;
+ public getCurrentOutType(stationInfo?: ChargingStationInfo): CurrentType {
+ return (stationInfo ?? this.stationInfo).currentOutType ?? CurrentType.AC;
}
public getOcppStrictCompliance(): boolean {
return this.stationInfo?.ocppStrictCompliance ?? false;
}
- public getVoltageOut(): number | undefined {
+ public getVoltageOut(stationInfo?: ChargingStationInfo): number | undefined {
const defaultVoltageOut = ChargingStationUtils.getDefaultVoltageOut(
- this.getCurrentOutType(),
+ this.getCurrentOutType(stationInfo),
this.templateFile,
this.logPrefix()
);
- return !Utils.isUndefined(this.stationInfo.voltageOut)
- ? this.stationInfo.voltageOut
+ const localStationInfo: ChargingStationInfo = stationInfo ?? this.stationInfo;
+ return !Utils.isUndefined(localStationInfo.voltageOut)
+ ? localStationInfo.voltageOut
: defaultVoltageOut;
}
this.getAmperageLimitation() * this.getNumberOfConnectors()
)
: DCElectricUtils.power(this.getVoltageOut(), this.getAmperageLimitation())) /
- this.stationInfo.powerDivider;
+ this.powerDivider;
}
- const connectorMaximumPower = this.getMaximumPower() / this.stationInfo.powerDivider;
+ const connectorMaximumPower = this.getMaximumPower() / this.powerDivider;
const connectorChargingProfilePowerLimit = this.getChargingProfilePowerLimit(connectorId);
return Math.min(
isNaN(connectorMaximumPower) ? Infinity : connectorMaximumPower,
this.performanceStatistics.start();
}
this.openWSConnection();
- // Handle WebSocket message
- 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) as (this: WebSocket, error: Error) => void
- );
- // Handle WebSocket close
- 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) as (this: WebSocket) => void);
- // Handle WebSocket ping
- 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) as (this: WebSocket, data: Buffer) => void);
- // Monitor authorization file
- FileUtils.watchJsonFile<string[]>(
- this.logPrefix(),
- FileType.Authorization,
- this.getAuthorizationFile(),
- this.authorizedTags
- );
// Monitor charging station template file
- FileUtils.watchJsonFile(
+ this.templateFileWatcher = FileUtils.watchJsonFile(
this.logPrefix(),
FileType.ChargingStationTemplate,
this.templateFile,
this.templateFile
} file have changed, reload`
);
+ this.sharedLRUCache.deleteChargingStationTemplate(this.stationInfo?.templateHash);
// Initialize
this.initialize();
// Restart the ATG
- if (
- !this.stationInfo.AutomaticTransactionGenerator.enable &&
- this.automaticTransactionGenerator
- ) {
- this.automaticTransactionGenerator.stop();
- }
+ this.stopAutomaticTransactionGenerator();
this.startAutomaticTransactionGenerator();
if (this.getEnableStatistics()) {
this.performanceStatistics.restart();
this.getConnectorStatus(connectorId).status = ChargePointStatus.UNAVAILABLE;
}
}
- if (this.isWebSocketConnectionOpened()) {
- this.wsConnection.close();
- }
+ this.closeWSConnection();
if (this.getEnableStatistics()) {
this.performanceStatistics.stop();
}
+ this.sharedLRUCache.deleteChargingStationConfiguration(this.configurationFileHash);
+ this.templateFileWatcher.close();
+ this.sharedLRUCache.deleteChargingStationTemplate(this.stationInfo?.templateHash);
this.bootNotificationResponse = null;
parentPort.postMessage({
id: ChargingStationWorkerMessageEvents.STOPPED,
public async reset(reason?: StopTransactionReason): Promise<void> {
await this.stop(reason);
await Utils.sleep(this.stationInfo.resetTime);
- this.stationInfo = this.getStationInfo();
- this.stationInfo?.Connectors && delete this.stationInfo.Connectors;
+ this.initialize();
this.start();
}
public saveOcppConfiguration(): void {
if (this.getOcppPersistentConfiguration()) {
- this.saveConfiguration(Section.ocppConfiguration);
+ this.saveConfiguration();
}
}
: DCElectricUtils.power(this.getVoltageOut(), limit);
}
- const connectorMaximumPower = this.getMaximumPower() / this.stationInfo.powerDivider;
+ const connectorMaximumPower = this.getMaximumPower() / this.powerDivider;
if (limit > connectorMaximumPower) {
logger.error(
`${this.logPrefix()} Charging profile id ${
private getTemplateFromFile(): ChargingStationTemplate | null {
let template: ChargingStationTemplate = null;
try {
- const measureId = `${FileType.ChargingStationTemplate} read`;
- const beginId = PerformanceStatistics.beginMeasure(measureId);
- template = JSON.parse(fs.readFileSync(this.templateFile, 'utf8')) as ChargingStationTemplate;
- PerformanceStatistics.endMeasure(measureId, beginId);
- template.templateHash = crypto
- .createHash(Constants.DEFAULT_HASH_ALGORITHM)
- .update(JSON.stringify(template))
- .digest('hex');
+ if (this.sharedLRUCache.hasChargingStationTemplate(this.stationInfo?.templateHash)) {
+ template = this.sharedLRUCache.getChargingStationTemplate(this.stationInfo.templateHash);
+ } else {
+ const measureId = `${FileType.ChargingStationTemplate} read`;
+ const beginId = PerformanceStatistics.beginMeasure(measureId);
+ template = JSON.parse(
+ fs.readFileSync(this.templateFile, 'utf8')
+ ) as ChargingStationTemplate;
+ PerformanceStatistics.endMeasure(measureId, beginId);
+ template.templateHash = crypto
+ .createHash(Constants.DEFAULT_HASH_ALGORITHM)
+ .update(JSON.stringify(template))
+ .digest('hex');
+ this.sharedLRUCache.setChargingStationTemplate(template);
+ }
} catch (error) {
FileUtils.handleFileException(
this.logPrefix(),
}
private getStationInfoFromTemplate(): ChargingStationInfo {
- const stationInfo: ChargingStationInfo = this.getTemplateFromFile();
- if (Utils.isNullOrUndefined(stationInfo)) {
+ const stationTemplate: ChargingStationTemplate = this.getTemplateFromFile();
+ if (Utils.isNullOrUndefined(stationTemplate)) {
const errorMsg = 'Failed to read charging station template file';
logger.error(`${this.logPrefix()} ${errorMsg}`);
throw new BaseError(errorMsg);
}
- if (Utils.isEmptyObject(stationInfo)) {
+ if (Utils.isEmptyObject(stationTemplate)) {
const errorMsg = `Empty charging station information from template file ${this.templateFile}`;
logger.error(`${this.logPrefix()} ${errorMsg}`);
throw new BaseError(errorMsg);
}
- const chargingStationId = ChargingStationUtils.getChargingStationId(this.index, stationInfo);
// Deprecation template keys section
ChargingStationUtils.warnDeprecatedTemplateKey(
- stationInfo,
+ stationTemplate,
'supervisionUrl',
this.templateFile,
this.logPrefix(),
"Use 'supervisionUrls' instead"
);
ChargingStationUtils.convertDeprecatedTemplateKey(
- stationInfo,
+ stationTemplate,
'supervisionUrl',
'supervisionUrls'
);
- if (!Utils.isEmptyArray(stationInfo.power)) {
- stationInfo.power = stationInfo.power as number[];
- const powerArrayRandomIndex = Math.floor(Utils.secureRandom() * stationInfo.power.length);
+ const stationInfo: ChargingStationInfo =
+ ChargingStationUtils.stationTemplateToStationInfo(stationTemplate);
+ stationInfo.chargingStationId = ChargingStationUtils.getChargingStationId(
+ this.index,
+ stationTemplate
+ );
+ ChargingStationUtils.createSerialNumber(stationTemplate, stationInfo);
+ if (!Utils.isEmptyArray(stationTemplate.power)) {
+ stationTemplate.power = stationTemplate.power as number[];
+ const powerArrayRandomIndex = Math.floor(Utils.secureRandom() * stationTemplate.power.length);
stationInfo.maximumPower =
- stationInfo.powerUnit === PowerUnits.KILO_WATT
- ? stationInfo.power[powerArrayRandomIndex] * 1000
- : stationInfo.power[powerArrayRandomIndex];
+ stationTemplate.powerUnit === PowerUnits.KILO_WATT
+ ? stationTemplate.power[powerArrayRandomIndex] * 1000
+ : stationTemplate.power[powerArrayRandomIndex];
} else {
- stationInfo.power = stationInfo.power as number;
+ stationTemplate.power = stationTemplate.power as number;
stationInfo.maximumPower =
- stationInfo.powerUnit === PowerUnits.KILO_WATT
- ? stationInfo.power * 1000
- : stationInfo.power;
- }
- delete stationInfo.power;
- delete stationInfo.powerUnit;
- stationInfo.chargingStationId = chargingStationId;
- stationInfo.resetTime = stationInfo.resetTime
- ? stationInfo.resetTime * 1000
+ stationTemplate.powerUnit === PowerUnits.KILO_WATT
+ ? stationTemplate.power * 1000
+ : stationTemplate.power;
+ }
+ stationInfo.resetTime = stationTemplate.resetTime
+ ? stationTemplate.resetTime * 1000
: Constants.CHARGING_STATION_DEFAULT_RESET_TIME;
+ const configuredMaxConnectors = ChargingStationUtils.getConfiguredNumberOfConnectors(
+ this.index,
+ stationTemplate
+ );
+ ChargingStationUtils.checkConfiguredMaxConnectors(
+ configuredMaxConnectors,
+ this.templateFile,
+ Utils.logPrefix()
+ );
+ const templateMaxConnectors =
+ ChargingStationUtils.getTemplateMaxNumberOfConnectors(stationTemplate);
+ ChargingStationUtils.checkTemplateMaxConnectors(
+ templateMaxConnectors,
+ this.templateFile,
+ Utils.logPrefix()
+ );
+ if (
+ configuredMaxConnectors >
+ (stationTemplate?.Connectors[0] ? templateMaxConnectors - 1 : templateMaxConnectors) &&
+ !stationTemplate?.randomConnectors
+ ) {
+ logger.warn(
+ `${this.logPrefix()} Number of connectors exceeds the number of connector configurations in template ${
+ this.templateFile
+ }, forcing random connector configurations affectation`
+ );
+ stationInfo.randomConnectors = true;
+ }
+ // Build connectors if needed (FIXME: should be factored out)
+ this.initializeConnectors(stationInfo, configuredMaxConnectors, templateMaxConnectors);
+ stationInfo.maximumAmperage = this.getMaximumAmperage(stationInfo);
+ ChargingStationUtils.createStationInfoHash(stationInfo);
return stationInfo;
}
private getStationInfoFromFile(): ChargingStationInfo | null {
let stationInfo: ChargingStationInfo = null;
- if (this.getStationInfoPersistentConfiguration()) {
- stationInfo = this.getConfigurationFromFile()?.stationInfo ?? null;
- }
- if (stationInfo) {
- stationInfo = ChargingStationUtils.createStationInfoHash(stationInfo);
- }
+ this.getStationInfoPersistentConfiguration() &&
+ (stationInfo = this.getConfigurationFromFile()?.stationInfo ?? null);
+ stationInfo && ChargingStationUtils.createStationInfoHash(stationInfo);
return stationInfo;
}
private getStationInfo(): ChargingStationInfo {
const stationInfoFromTemplate: ChargingStationInfo = this.getStationInfoFromTemplate();
- this.hashId = ChargingStationUtils.getHashId(stationInfoFromTemplate);
- this.configurationFile = path.join(
- path.resolve(__dirname, '../'),
- 'assets',
- 'configurations',
- this.hashId + '.json'
- );
const stationInfoFromFile: ChargingStationInfo = this.getStationInfoFromFile();
// Priority: charging station info from template > charging station info from configuration file > charging station info attribute
if (stationInfoFromFile?.templateHash === stationInfoFromTemplate.templateHash) {
}
return stationInfoFromFile;
}
- ChargingStationUtils.createSerialNumber(stationInfoFromTemplate, stationInfoFromFile);
+ stationInfoFromFile &&
+ ChargingStationUtils.propagateSerialNumber(
+ this.getTemplateFromFile(),
+ stationInfoFromFile,
+ stationInfoFromTemplate
+ );
return stationInfoFromTemplate;
}
private saveStationInfo(): void {
if (this.getStationInfoPersistentConfiguration()) {
- this.saveConfiguration(Section.stationInfo);
+ this.saveConfiguration();
}
}
}
private initialize(): void {
- this.stationInfo = this.getStationInfo();
+ this.hashId = ChargingStationUtils.getHashId(this.index, this.getTemplateFromFile());
logger.info(`${this.logPrefix()} Charging station hashId '${this.hashId}'`);
- this.bootNotificationRequest = ChargingStationUtils.createBootNotificationRequest(
- this.stationInfo
- );
- this.ocppConfiguration = this.getOcppConfiguration();
- this.stationInfo?.Configuration && delete this.stationInfo.Configuration;
- this.wsConfiguredConnectionUrl = new URL(
- this.getConfiguredSupervisionUrl().href + '/' + this.stationInfo.chargingStationId
+ this.configurationFile = path.join(
+ path.resolve(path.dirname(fileURLToPath(import.meta.url)), '../'),
+ 'assets',
+ 'configurations',
+ this.hashId + '.json'
);
- // Build connectors if needed
- const maxConnectors = this.getMaxNumberOfConnectors();
- this.checkMaxConnectors(maxConnectors);
- const templateMaxConnectors = this.getTemplateMaxNumberOfConnectors();
- this.checkTemplateMaxConnectors(templateMaxConnectors);
- 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.templateFile
- }, forcing random connector configurations affectation`
- );
- this.stationInfo.randomConnectors = true;
- }
- this.initializeConnectors(this.stationInfo, maxConnectors, templateMaxConnectors);
- this.stationInfo.maximumAmperage = this.getMaximumAmperage();
- if (this.stationInfo) {
- this.stationInfo = ChargingStationUtils.createStationInfoHash(this.stationInfo);
- }
+ this.stationInfo = this.getStationInfo();
this.saveStationInfo();
// Avoid duplication of connectors related information in RAM
this.stationInfo?.Connectors && delete this.stationInfo.Connectors;
- // OCPP configuration
- this.initializeOcppConfiguration();
+ this.configuredSupervisionUrl = this.getConfiguredSupervisionUrl();
if (this.getEnableStatistics()) {
this.performanceStatistics = PerformanceStatistics.getInstance(
this.hashId,
this.stationInfo.chargingStationId,
- this.wsConnectionUrl
+ this.configuredSupervisionUrl
);
}
+ this.bootNotificationRequest = ChargingStationUtils.createBootNotificationRequest(
+ this.stationInfo
+ );
+ this.powerDivider = this.getPowerDivider();
+ // OCPP configuration
+ this.ocppConfiguration = this.getOcppConfiguration();
+ this.initializeOcppConfiguration();
switch (this.getOcppVersion()) {
case OCPPVersion.VERSION_16:
this.ocppIncomingRequestService =
this.handleUnsupportedVersion(this.getOcppVersion());
break;
}
- if (this.stationInfo.autoRegister) {
+ if (this.stationInfo?.autoRegister) {
this.bootNotificationResponse = {
currentTime: new Date().toISOString(),
interval: this.getHeartbeatInterval() / 1000,
status: RegistrationStatus.ACCEPTED,
};
}
- this.stationInfo.powerDivider = this.getPowerDivider();
}
private initializeOcppConfiguration(): void {
ChargingStationConfigurationUtils.addConfigurationKey(
this,
this.getSupervisionUrlOcppKey(),
- this.getConfiguredSupervisionUrl().href,
+ this.configuredSupervisionUrl.href,
{ reboot: true }
);
} else if (
private initializeConnectors(
stationInfo: ChargingStationInfo,
- maxConnectors: number,
+ configuredMaxConnectors: number,
templateMaxConnectors: number
): void {
if (!stationInfo?.Connectors && this.connectors.size === 0) {
if (stationInfo?.Connectors) {
const connectorsConfigHash = crypto
.createHash(Constants.DEFAULT_HASH_ALGORITHM)
- .update(JSON.stringify(stationInfo?.Connectors) + maxConnectors.toString())
+ .update(JSON.stringify(stationInfo?.Connectors) + configuredMaxConnectors.toString())
.digest('hex');
const connectorsConfigChanged =
this.connectors?.size !== 0 && this.connectorsConfigurationHash !== connectorsConfigHash;
const lastConnectorId = Utils.convertToInt(lastConnector);
if (
lastConnectorId === 0 &&
- this.getUseConnectorId0() &&
+ this.getUseConnectorId0(stationInfo) &&
stationInfo?.Connectors[lastConnector]
) {
this.connectors.set(
}
// Generate all connectors
if ((stationInfo?.Connectors[0] ? templateMaxConnectors - 1 : templateMaxConnectors) > 0) {
- for (let index = 1; index <= maxConnectors; index++) {
+ for (let index = 1; index <= configuredMaxConnectors; index++) {
const randConnectorId = stationInfo?.randomConnectors
? Utils.getRandomInteger(Utils.convertToInt(lastConnector), 1)
: index;
}
}
- private checkMaxConnectors(maxConnectors: number): void {
- if (maxConnectors <= 0) {
- logger.warn(
- `${this.logPrefix()} Charging station information from template ${
- this.templateFile
- } with ${maxConnectors} connectors`
- );
- }
- }
-
- private checkTemplateMaxConnectors(templateMaxConnectors: number): void {
- if (templateMaxConnectors === 0) {
- logger.warn(
- `${this.logPrefix()} Charging station information from template ${
- this.templateFile
- } with empty connectors configuration`
- );
- } else if (templateMaxConnectors < 0) {
- logger.error(
- `${this.logPrefix()} Charging station information from template ${
- this.templateFile
- } with no connectors configuration defined`
- );
- }
- }
-
private getConfigurationFromFile(): ChargingStationConfiguration | null {
let configuration: ChargingStationConfiguration = null;
if (this.configurationFile && fs.existsSync(this.configurationFile)) {
try {
- const measureId = `${FileType.ChargingStationConfiguration} read`;
- const beginId = PerformanceStatistics.beginMeasure(measureId);
- configuration = JSON.parse(
- fs.readFileSync(this.configurationFile, 'utf8')
- ) as ChargingStationConfiguration;
- PerformanceStatistics.endMeasure(measureId, beginId);
+ 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(
+ fs.readFileSync(this.configurationFile, 'utf8')
+ ) as ChargingStationConfiguration;
+ PerformanceStatistics.endMeasure(measureId, beginId);
+ this.configurationFileHash = configuration.configurationHash;
+ this.sharedLRUCache.setChargingStationConfiguration(configuration);
+ }
} catch (error) {
FileUtils.handleFileException(
this.logPrefix(),
return configuration;
}
- private saveConfiguration(section?: Section): void {
+ private saveConfiguration(): void {
if (this.configurationFile) {
try {
if (!fs.existsSync(path.dirname(this.configurationFile))) {
}
const configurationData: ChargingStationConfiguration =
this.getConfigurationFromFile() ?? {};
- switch (section) {
- case Section.ocppConfiguration:
- configurationData.configurationKey = this.ocppConfiguration.configurationKey;
- break;
- case Section.stationInfo:
- if (configurationData?.stationInfo?.infoHash === this.stationInfo?.infoHash) {
- logger.debug(
- `${this.logPrefix()} Not saving unchanged charging station information to configuration file ${
- this.configurationFile
- }`
- );
- return;
- }
- configurationData.stationInfo = this.stationInfo;
- break;
- default:
- configurationData.configurationKey = this.ocppConfiguration.configurationKey;
- if (configurationData?.stationInfo?.infoHash !== this.stationInfo?.infoHash) {
- configurationData.stationInfo = this.stationInfo;
- }
- break;
+ this.ocppConfiguration?.configurationKey &&
+ (configurationData.configurationKey = this.ocppConfiguration.configurationKey);
+ this.stationInfo && (configurationData.stationInfo = this.stationInfo);
+ delete configurationData.configurationHash;
+ const configurationHash = crypto
+ .createHash(Constants.DEFAULT_HASH_ALGORITHM)
+ .update(JSON.stringify(configurationData))
+ .digest('hex');
+ if (this.configurationFileHash !== configurationHash) {
+ configurationData.configurationHash = configurationHash;
+ const measureId = `${FileType.ChargingStationConfiguration} write`;
+ const beginId = PerformanceStatistics.beginMeasure(measureId);
+ const fileDescriptor = fs.openSync(this.configurationFile, 'w');
+ fs.writeFileSync(fileDescriptor, JSON.stringify(configurationData, null, 2), 'utf8');
+ fs.closeSync(fileDescriptor);
+ PerformanceStatistics.endMeasure(measureId, beginId);
+ this.sharedLRUCache.deleteChargingStationConfiguration(this.configurationFileHash);
+ this.configurationFileHash = configurationHash;
+ this.sharedLRUCache.setChargingStationConfiguration(configurationData);
+ } else {
+ logger.debug(
+ `${this.logPrefix()} Not saving unchanged charging station configuration file ${
+ this.configurationFile
+ }`
+ );
}
- const measureId = `${FileType.ChargingStationConfiguration} write`;
- const beginId = PerformanceStatistics.beginMeasure(measureId);
- const fileDescriptor = fs.openSync(this.configurationFile, 'w');
- fs.writeFileSync(fileDescriptor, JSON.stringify(configurationData, null, 2), 'utf8');
- fs.closeSync(fileDescriptor);
- PerformanceStatistics.endMeasure(measureId, beginId);
} catch (error) {
FileUtils.handleFileException(
this.logPrefix(),
}
private onError(error: WSError): void {
+ this.closeWSConnection();
logger.error(this.logPrefix() + ' WebSocket error: %j', error);
}
- private getAuthorizationFile(): string | undefined {
- return (
- this.stationInfo.authorizationFile &&
- path.join(
- path.resolve(__dirname, '../'),
- 'assets',
- path.basename(this.stationInfo.authorizationFile)
- )
- );
- }
-
- private getAuthorizedTags(): string[] {
- let authorizedTags: string[] = [];
- const authorizationFile = this.getAuthorizationFile();
- if (authorizationFile) {
- try {
- // Load authorization file
- authorizedTags = JSON.parse(fs.readFileSync(authorizationFile, 'utf8')) as string[];
- } catch (error) {
- FileUtils.handleFileException(
- this.logPrefix(),
- FileType.Authorization,
- authorizationFile,
- error as NodeJS.ErrnoException
- );
- }
- } else {
- logger.info(
- this.logPrefix() + ' No authorization file given in template file ' + this.templateFile
- );
- }
- return authorizedTags;
- }
-
- private getUseConnectorId0(): boolean | undefined {
- return !Utils.isUndefined(this.stationInfo.useConnectorId0)
- ? this.stationInfo.useConnectorId0
+ private getUseConnectorId0(stationInfo?: ChargingStationInfo): boolean | undefined {
+ const localStationInfo = stationInfo ?? this.stationInfo;
+ return !Utils.isUndefined(localStationInfo.useConnectorId0)
+ ? localStationInfo.useConnectorId0
: true;
}
private getPowerDivider(): number {
let powerDivider = this.getNumberOfConnectors();
- if (this.stationInfo.powerSharedByConnectors) {
+ if (this.stationInfo?.powerSharedByConnectors) {
powerDivider = this.getNumberOfRunningTransactions();
}
return powerDivider;
}
- private getTemplateMaxNumberOfConnectors(): number {
- if (!this.stationInfo?.Connectors) {
- return -1;
- }
- return Object.keys(this.stationInfo?.Connectors).length;
+ private getMaximumPower(stationInfo?: ChargingStationInfo): number {
+ const localStationInfo = stationInfo ?? this.stationInfo;
+ return (localStationInfo['maxPower'] as number) ?? localStationInfo.maximumPower;
}
- 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();
- }
- return maxConnectors;
- }
-
- private getMaximumPower(): number {
- return (this.stationInfo['maxPower'] as number) ?? this.stationInfo.maximumPower;
- }
-
- private getMaximumAmperage(): number | undefined {
- const maximumPower = this.getMaximumPower();
- switch (this.getCurrentOutType()) {
+ private getMaximumAmperage(stationInfo: ChargingStationInfo): number | undefined {
+ const maximumPower = this.getMaximumPower(stationInfo);
+ switch (this.getCurrentOutType(stationInfo)) {
case CurrentType.AC:
return ACElectricUtils.amperagePerPhaseFromPower(
- this.getNumberOfPhases(),
+ this.getNumberOfPhases(stationInfo),
maximumPower / this.getNumberOfConnectors(),
- this.getVoltageOut()
+ this.getVoltageOut(stationInfo)
);
case CurrentType.DC:
- return DCElectricUtils.amperage(maximumPower, this.getVoltageOut());
+ return DCElectricUtils.amperage(maximumPower, this.getVoltageOut(stationInfo));
}
}
}
private async startMessageSequence(): Promise<void> {
- if (this.stationInfo.autoRegister) {
+ if (this.stationInfo?.autoRegister) {
await this.ocppRequestService.requestHandler<
BootNotificationRequest,
BootNotificationResponse
}
private startAutomaticTransactionGenerator() {
- if (this.stationInfo.AutomaticTransactionGenerator.enable) {
+ if (this.getAutomaticTransactionGeneratorConfigurationFromTemplate()?.enable) {
if (!this.automaticTransactionGenerator) {
- this.automaticTransactionGenerator = AutomaticTransactionGenerator.getInstance(this);
+ this.automaticTransactionGenerator = AutomaticTransactionGenerator.getInstance(
+ this.getAutomaticTransactionGeneratorConfigurationFromTemplate(),
+ this
+ );
}
if (!this.automaticTransactionGenerator.started) {
this.automaticTransactionGenerator.start();
}
}
+ private stopAutomaticTransactionGenerator(): void {
+ if (this.automaticTransactionGenerator?.started) {
+ this.automaticTransactionGenerator.stop();
+ this.automaticTransactionGenerator = null;
+ }
+ }
+
private async stopMessageSequence(
reason: StopTransactionReason = StopTransactionReason.NONE
): Promise<void> {
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?.configuration?.enable) {
+ this.stopAutomaticTransactionGenerator();
} else {
for (const connectorId of this.connectors.keys()) {
if (connectorId > 0 && this.getConnectorStatus(connectorId)?.transactionStarted) {
if (HeartBeatInterval) {
return Utils.convertToInt(HeartBeatInterval.value) * 1000;
}
- !this.stationInfo.autoRegister &&
+ !this.stationInfo?.autoRegister &&
logger.warn(
`${this.logPrefix()} Heartbeat interval configuration key not set, using default value: ${
Constants.DEFAULT_HEARTBEAT_INTERVAL
private openWSConnection(
options: WsOptions = this.stationInfo?.wsOptions ?? {},
- forceCloseOpened = false
+ params: { closeOpened?: boolean; terminateOpened?: boolean } = {
+ closeOpened: false,
+ terminateOpened: false,
+ }
): void {
options.handshakeTimeout = options?.handshakeTimeout ?? this.getConnectionTimeout() * 1000;
+ params.closeOpened = params?.closeOpened ?? false;
+ params.terminateOpened = params?.terminateOpened ?? false;
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();
+ if (params?.closeOpened) {
+ this.closeWSConnection();
+ }
+ if (params?.terminateOpened) {
+ this.terminateWSConnection();
}
let protocol: string;
switch (this.getOcppVersion()) {
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()
);
+
+ this.wsConnection = new WebSocket(this.wsConnectionUrl, protocol, options);
+
+ // Handle WebSocket message
+ 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) as (this: WebSocket, error: Error) => void
+ );
+ // Handle WebSocket close
+ 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) as (this: WebSocket) => void);
+ // Handle WebSocket ping
+ 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) as (this: WebSocket, data: Buffer) => void);
+ }
+
+ private closeWSConnection(): void {
+ if (this.isWebSocketConnectionOpened()) {
+ this.wsConnection.close();
+ this.wsConnection = null;
+ }
+ }
+
+ private terminateWSConnection(): void {
+ if (this.isWebSocketConnectionOpened()) {
+ this.wsConnection.terminate();
+ this.wsConnection = null;
+ }
}
private stopMeterValues(connectorId: number) {
// 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.automaticTransactionGenerator?.configuration?.stopOnConnectionFailure) {
+ this.stopAutomaticTransactionGenerator();
}
if (
this.autoReconnectRetryCount < this.getAutoReconnectMaxRetries() ||
const reconnectDelay = this.getReconnectExponentialDelay()
? Utils.exponentialDelay(this.autoReconnectRetryCount)
: this.getConnectionTimeout() * 1000;
- const reconnectTimeout = reconnectDelay - 100 > 0 && reconnectDelay;
+ const reconnectDelayWithdraw = 1000;
+ const reconnectTimeout =
+ reconnectDelay && reconnectDelay - reconnectDelayWithdraw > 0
+ ? reconnectDelay - reconnectDelayWithdraw
+ : 0;
logger.error(
`${this.logPrefix()} WebSocket: connection retry in ${Utils.roundTo(
reconnectDelay,
);
this.openWSConnection(
{ ...(this.stationInfo?.wsOptions ?? {}), handshakeTimeout: reconnectTimeout },
- true
+ { closeOpened: true }
);
this.wsConnectionRestarted = true;
} else if (this.getAutoReconnectMaxRetries() !== -1) {
}
}
+ private getAutomaticTransactionGeneratorConfigurationFromTemplate(): AutomaticTransactionGeneratorConfiguration | null {
+ return this.getTemplateFromFile()?.AutomaticTransactionGenerator ?? null;
+ }
+
private initializeConnectorStatus(connectorId: number): void {
this.getConnectorStatus(connectorId).idTagLocalAuthorized = false;
this.getConnectorStatus(connectorId).idTagAuthorized = false;
repositories / e-mobility-charging-stations-simulator.git / blobdiff