// 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 } 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,
- ChargingSchedulePeriod,
-} from '../types/ocpp/ChargingProfile';
-import ChargingStationConfiguration, { Section } from '../types/ChargingStationConfiguration';
-import ChargingStationOcppConfiguration, {
- ConfigurationKey,
-} from '../types/ChargingStationOcppConfiguration';
-import ChargingStationTemplate, {
- AmpereUnits,
- CurrentType,
- PowerUnits,
- Voltage,
- WsOptions,
-} from '../types/ChargingStationTemplate';
-import {
- ConnectorPhaseRotation,
- StandardParametersKey,
- SupportedFeatureProfiles,
- VendorDefaultParametersKey,
-} from '../types/ocpp/Configuration';
-import { MeterValue, MeterValueMeasurand, MeterValuePhase } 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 { ChargePointErrorCode } from '../types/ocpp/ChargePointErrorCode';
-import { ChargePointStatus } from '../types/ocpp/ChargePointStatus';
-import ChargingStationInfo from '../types/ChargingStationInfo';
-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 { SampledValueTemplate } from '../types/MeasurandPerPhaseSampledValueTemplates';
-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(
- this.getConfigurationKey(this.getSupervisionUrlOcppKey()).value +
- '/' +
- this.stationInfo.chargingStationId
- )
- : this.wsConfiguredConnectionUrl;
+ return new URL(
+ (this.getSupervisionUrlOcppConfiguration()
+ ? ChargingStationConfigurationUtils.getConfigurationKey(
+ this,
+ this.getSupervisionUrlOcppKey()
+ ).value
+ : this.configuredSupervisionUrl.href) +
+ '/' +
+ this.stationInfo.chargingStationId
+ );
}
public logPrefix(): string {
- return Utils.logPrefix(` ${this.stationInfo.chargingStationId} |`);
+ return Utils.logPrefix(
+ ` ${
+ this?.stationInfo?.chargingStationId ??
+ ChargingStationUtils.getChargingStationId(this.index, this.getTemplateFromFile())
+ } |`
+ );
}
public getBootNotificationRequest(): BootNotificationRequest {
}
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;
+ return this.stationInfo?.ocppStrictCompliance ?? false;
}
- public getVoltageOut(): number | undefined {
- const errMsg = `${this.logPrefix()} Unknown ${this.getCurrentOutType()} currentOutType in template file ${
- this.templateFile
- }, 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);
- }
- return !Utils.isUndefined(this.stationInfo.voltageOut)
- ? this.stationInfo.voltageOut
+ public getVoltageOut(stationInfo?: ChargingStationInfo): number | undefined {
+ const defaultVoltageOut = ChargingStationUtils.getDefaultVoltageOut(
+ this.getCurrentOutType(stationInfo),
+ this.templateFile,
+ this.logPrefix()
+ );
+ 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,
}
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 getCustomValueLimitationMeterValues(): boolean {
+ return this.stationInfo?.customValueLimitationMeterValues ?? true;
}
public getConnectorIdByTransactionId(transactionId: number): number | undefined {
}
public getAuthorizeRemoteTxRequests(): boolean {
- const authorizeRemoteTxRequests = this.getConfigurationKey(
+ const authorizeRemoteTxRequests = ChargingStationConfigurationUtils.getConfigurationKey(
+ this,
StandardParametersKey.AuthorizeRemoteTxRequests
);
return authorizeRemoteTxRequests
}
public getLocalAuthListEnabled(): boolean {
- const localAuthListEnabled = this.getConfigurationKey(
+ const localAuthListEnabled = ChargingStationConfigurationUtils.getConfigurationKey(
+ this,
StandardParametersKey.LocalAuthListEnabled
);
return localAuthListEnabled ? Utils.convertToBoolean(localAuthListEnabled.value) : false;
}
- public restartWebSocketPing(): void {
- // Stop WebSocket ping
- this.stopWebSocketPing();
- // Start WebSocket ping
- this.startWebSocketPing();
- }
-
- 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);
- }
- logger.debug(
- `${this.logPrefix()} No MeterValues for measurand '${measurand}' ${onPhaseStr}in template on connectorId ${connectorId}`
- );
- }
-
- public getAutomaticTransactionGeneratorRequireAuthorize(): boolean {
- return this.stationInfo.AutomaticTransactionGenerator.requireAuthorize ?? true;
- }
-
public startHeartbeat(): void {
if (
this.getHeartbeatInterval() &&
// eslint-disable-next-line @typescript-eslint/no-misused-promises
this.heartbeatSetInterval = setInterval(async (): Promise<void> => {
await this.ocppRequestService.requestHandler<HeartbeatRequest, HeartbeatResponse>(
+ this,
RequestCommand.HEARTBEAT
);
}, this.getHeartbeatInterval());
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(
interval
);
await this.ocppRequestService.requestHandler<MeterValuesRequest, MeterValuesResponse>(
+ this,
RequestCommand.METER_VALUES,
{
connectorId,
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();
await this.ocppRequestService.requestHandler<
StatusNotificationRequest,
StatusNotificationResponse
- >(RequestCommand.STATUS_NOTIFICATION, {
+ >(this, RequestCommand.STATUS_NOTIFICATION, {
connectorId,
status: ChargePointStatus.UNAVAILABLE,
errorCode: ChargePointErrorCode.NO_ERROR,
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,
this.stopped = true;
}
- public getConfigurationKey(
- key: string | StandardParametersKey,
- caseInsensitive = false
- ): ConfigurationKey | undefined {
- return this.ocppConfiguration.configurationKey.find((configElement) => {
- if (caseInsensitive) {
- return configElement.key.toLowerCase() === key.toLowerCase();
- }
- return configElement.key === key;
- });
+ public async reset(reason?: StopTransactionReason): Promise<void> {
+ await this.stop(reason);
+ await Utils.sleep(this.stationInfo.resetTime);
+ this.initialize();
+ this.start();
}
- public addConfigurationKey(
- key: string | StandardParametersKey,
- value: string,
- options: { readonly?: boolean; visible?: boolean; reboot?: boolean } = {
- readonly: false,
- visible: true,
- reboot: false,
- },
- params: { overwrite?: boolean; save?: boolean } = { overwrite: false, save: false }
- ): void {
- options = options ?? ({} as { readonly?: boolean; visible?: boolean; reboot?: boolean });
- options.readonly = options?.readonly ?? false;
- options.visible = options?.visible ?? true;
- options.reboot = options?.reboot ?? false;
- let keyFound = this.getConfigurationKey(key);
- if (keyFound && params?.overwrite) {
- this.deleteConfigurationKey(keyFound.key, { save: false });
- keyFound = undefined;
- }
- if (!keyFound) {
- this.ocppConfiguration.configurationKey.push({
- key,
- readonly: options.readonly,
- value,
- visible: options.visible,
- reboot: options.reboot,
- });
- params?.save && this.saveOcppConfiguration();
- } else {
- logger.error(
- `${this.logPrefix()} Trying to add an already existing configuration key: %j`,
- keyFound
- );
+ public saveOcppConfiguration(): void {
+ if (this.getOcppPersistentConfiguration()) {
+ this.saveConfiguration();
}
}
- public setConfigurationKeyValue(
- key: string | StandardParametersKey,
- value: string,
- caseInsensitive = false
- ): void {
- const keyFound = this.getConfigurationKey(key, caseInsensitive);
- if (keyFound) {
- this.ocppConfiguration.configurationKey[
- this.ocppConfiguration.configurationKey.indexOf(keyFound)
- ].value = value;
- this.saveOcppConfiguration();
- } else {
- logger.error(
- `${this.logPrefix()} Trying to set a value on a non existing configuration key: %j`,
- { key, value }
+ public getChargingProfilePowerLimit(connectorId: number): number | undefined {
+ let limit: number, matchingChargingProfile: ChargingProfile;
+ let chargingProfiles: ChargingProfile[] = [];
+ // Get charging profiles for connector and sort by stack level
+ chargingProfiles = this.getConnectorStatus(connectorId).chargingProfiles.sort(
+ (a, b) => b.stackLevel - a.stackLevel
+ );
+ // Get profiles on connector 0
+ if (this.getConnectorStatus(0).chargingProfiles) {
+ chargingProfiles.push(
+ ...this.getConnectorStatus(0).chargingProfiles.sort((a, b) => b.stackLevel - a.stackLevel)
);
}
- }
-
- public deleteConfigurationKey(
- key: string | StandardParametersKey,
- params: { save?: boolean; caseInsensitive?: boolean } = { save: true, caseInsensitive: false }
- ): ConfigurationKey[] {
- const keyFound = this.getConfigurationKey(key, params?.caseInsensitive);
- if (keyFound) {
- const deletedConfigurationKey = this.ocppConfiguration.configurationKey.splice(
- this.ocppConfiguration.configurationKey.indexOf(keyFound),
- 1
+ if (!Utils.isEmptyArray(chargingProfiles)) {
+ const result = ChargingStationUtils.getLimitFromChargingProfiles(
+ chargingProfiles,
+ Utils.logPrefix()
);
- params?.save && this.saveOcppConfiguration();
- return deletedConfigurationKey;
- }
- }
+ if (!Utils.isNullOrUndefined(result)) {
+ limit = result.limit;
+ matchingChargingProfile = result.matchingChargingProfile;
+ switch (this.getCurrentOutType()) {
+ case CurrentType.AC:
+ limit =
+ matchingChargingProfile.chargingSchedule.chargingRateUnit ===
+ ChargingRateUnitType.WATT
+ ? limit
+ : ACElectricUtils.powerTotal(this.getNumberOfPhases(), this.getVoltageOut(), limit);
+ break;
+ case CurrentType.DC:
+ limit =
+ matchingChargingProfile.chargingSchedule.chargingRateUnit ===
+ ChargingRateUnitType.WATT
+ ? limit
+ : DCElectricUtils.power(this.getVoltageOut(), limit);
+ }
- public getChargingProfilePowerLimit(connectorId: number): number | undefined {
- const timestamp = new Date().getTime();
- let matchingChargingProfile: ChargingProfile;
- let chargingSchedulePeriods: ChargingSchedulePeriod[] = [];
- if (!Utils.isEmptyArray(this.getConnectorStatus(connectorId)?.chargingProfiles)) {
- const chargingProfiles: ChargingProfile[] = this.getConnectorStatus(
- connectorId
- ).chargingProfiles.filter(
- (chargingProfile) =>
- timestamp >= chargingProfile.chargingSchedule?.startSchedule.getTime() &&
- timestamp <
- chargingProfile.chargingSchedule?.startSchedule.getTime() +
- chargingProfile.chargingSchedule.duration * 1000 &&
- chargingProfile?.stackLevel === Math.max(...chargingProfiles.map((cp) => cp?.stackLevel))
- );
- if (!Utils.isEmptyArray(chargingProfiles)) {
- for (const chargingProfile of chargingProfiles) {
- if (!Utils.isEmptyArray(chargingProfile.chargingSchedule.chargingSchedulePeriod)) {
- chargingSchedulePeriods =
- chargingProfile.chargingSchedule.chargingSchedulePeriod.filter(
- (chargingSchedulePeriod, index) => {
- timestamp >=
- chargingProfile.chargingSchedule.startSchedule.getTime() +
- chargingSchedulePeriod.startPeriod * 1000 &&
- ((chargingProfile.chargingSchedule.chargingSchedulePeriod[index + 1] &&
- timestamp <
- chargingProfile.chargingSchedule.startSchedule.getTime() +
- chargingProfile.chargingSchedule.chargingSchedulePeriod[index + 1]
- ?.startPeriod *
- 1000) ||
- !chargingProfile.chargingSchedule.chargingSchedulePeriod[index + 1]);
- }
- );
- if (!Utils.isEmptyArray(chargingSchedulePeriods)) {
- matchingChargingProfile = chargingProfile;
- break;
- }
- }
+ const connectorMaximumPower = this.getMaximumPower() / this.powerDivider;
+ if (limit > connectorMaximumPower) {
+ logger.error(
+ `${this.logPrefix()} Charging profile id ${
+ matchingChargingProfile.chargingProfileId
+ } limit is greater than connector id ${connectorId} maximum, dump charging profiles' stack: %j`,
+ this.getConnectorStatus(connectorId).chargingProfiles
+ );
+ limit = connectorMaximumPower;
}
}
}
- let limit: number;
- if (!Utils.isEmptyArray(chargingSchedulePeriods)) {
- switch (this.getCurrentOutType()) {
- case CurrentType.AC:
- limit =
- matchingChargingProfile.chargingSchedule.chargingRateUnit === ChargingRateUnitType.WATT
- ? chargingSchedulePeriods[0].limit
- : ACElectricUtils.powerTotal(
- this.getNumberOfPhases(),
- this.getVoltageOut(),
- chargingSchedulePeriods[0].limit
- );
- break;
- case CurrentType.DC:
- limit =
- matchingChargingProfile.chargingSchedule.chargingRateUnit === ChargingRateUnitType.WATT
- ? chargingSchedulePeriods[0].limit
- : DCElectricUtils.power(this.getVoltageOut(), chargingSchedulePeriods[0].limit);
- }
- }
- const connectorMaximumPower = this.getMaximumPower() / this.stationInfo.powerDivider;
- if (limit > connectorMaximumPower) {
- logger.error(
- `${this.logPrefix()} Charging profile id ${
- matchingChargingProfile.chargingProfileId
- } limit is greater than connector id ${connectorId} maximum, dump charging profiles' stack: %j`,
- this.getConnectorStatus(connectorId).chargingProfiles
- );
- limit = connectorMaximumPower;
- }
return limit;
}
public setChargingProfile(connectorId: number, cp: ChargingProfile): void {
+ if (Utils.isNullOrUndefined(this.getConnectorStatus(connectorId).chargingProfiles)) {
+ logger.error(
+ `${this.logPrefix()} Trying to set a charging profile on connectorId ${connectorId} with an uninitialized charging profiles array attribute, applying deferred initialization`
+ );
+ this.getConnectorStatus(connectorId).chargingProfiles = [];
+ }
+ if (!Array.isArray(this.getConnectorStatus(connectorId).chargingProfiles)) {
+ logger.error(
+ `${this.logPrefix()} Trying to set a charging profile on connectorId ${connectorId} with an improper attribute type for the charging profiles array, applying proper type initialization`
+ );
+ this.getConnectorStatus(connectorId).chargingProfiles = [];
+ }
let cpReplaced = false;
if (!Utils.isEmptyArray(this.getConnectorStatus(connectorId).chargingProfiles)) {
this.getConnectorStatus(connectorId).chargingProfiles?.forEach(
}
public hasFeatureProfile(featureProfile: SupportedFeatureProfiles) {
- return this.getConfigurationKey(StandardParametersKey.SupportedFeatureProfiles)?.value.includes(
- featureProfile
- );
+ return ChargingStationConfigurationUtils.getConfigurationKey(
+ this,
+ StandardParametersKey.SupportedFeatureProfiles
+ )?.value.includes(featureProfile);
}
public bufferMessage(message: string): void {
return this.stationInfo.supervisionUrlOcppKey ?? VendorDefaultParametersKey.ConnectionUrl;
}
- 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 ?? '';
- const idStr = '000000000' + this.index.toString();
- return stationTemplate.fixedName
- ? stationTemplate.baseName
- : stationTemplate.baseName +
- '-' +
- instanceIndex.toString() +
- idStr.substring(idStr.length - 4) +
- idSuffix;
- }
-
- private getRandomSerialNumberSuffix(params?: {
- randomBytesLength?: number;
- upperCase?: boolean;
- }): string {
- const randomSerialNumberSuffix = crypto
- .randomBytes(params?.randomBytesLength ?? 16)
- .toString('hex');
- if (params?.upperCase) {
- return randomSerialNumberSuffix.toUpperCase();
- }
- return randomSerialNumberSuffix;
- }
-
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) ??
- ({} 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(),
return template;
}
- private createSerialNumber(
- stationInfo: ChargingStationInfo,
- existingStationInfo?: ChargingStationInfo,
- params: { randomSerialNumberUpperCase?: boolean; randomSerialNumber?: boolean } = {
- randomSerialNumberUpperCase: true,
- randomSerialNumber: true,
+ private getStationInfoFromTemplate(): ChargingStationInfo {
+ 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);
}
- ): void {
- params = params ?? {};
- params.randomSerialNumberUpperCase = params?.randomSerialNumberUpperCase ?? true;
- params.randomSerialNumber = params?.randomSerialNumber ?? true;
- if (existingStationInfo) {
- existingStationInfo?.chargePointSerialNumber &&
- (stationInfo.chargePointSerialNumber = existingStationInfo.chargePointSerialNumber);
- existingStationInfo?.chargeBoxSerialNumber &&
- (stationInfo.chargeBoxSerialNumber = existingStationInfo.chargeBoxSerialNumber);
- existingStationInfo?.meterSerialNumber &&
- (stationInfo.meterSerialNumber = existingStationInfo.meterSerialNumber);
- } else {
- const serialNumberSuffix = params?.randomSerialNumber
- ? this.getRandomSerialNumberSuffix({ upperCase: params.randomSerialNumberUpperCase })
- : '';
- stationInfo.chargePointSerialNumber =
- stationInfo?.chargePointSerialNumberPrefix &&
- stationInfo.chargePointSerialNumberPrefix + serialNumberSuffix;
- stationInfo.chargeBoxSerialNumber =
- stationInfo?.chargeBoxSerialNumberPrefix &&
- stationInfo.chargeBoxSerialNumberPrefix + serialNumberSuffix;
- stationInfo.meterSerialNumber =
- stationInfo?.meterSerialNumberPrefix &&
- stationInfo.meterSerialNumberPrefix + serialNumberSuffix;
+ if (Utils.isEmptyObject(stationTemplate)) {
+ const errorMsg = `Empty charging station information from template file ${this.templateFile}`;
+ logger.error(`${this.logPrefix()} ${errorMsg}`);
+ throw new BaseError(errorMsg);
}
- }
-
- private getStationInfoFromTemplate(): ChargingStationInfo {
- const stationInfo: ChargingStationInfo = this.getTemplateFromFile();
- const chargingStationId = this.getChargingStationId(stationInfo);
// Deprecation template keys section
- this.warnDeprecatedTemplateKey(
- stationInfo,
+ ChargingStationUtils.warnDeprecatedTemplateKey(
+ stationTemplate,
'supervisionUrl',
- chargingStationId,
+ this.templateFile,
+ this.logPrefix(),
"Use 'supervisionUrls' instead"
);
- this.convertDeprecatedTemplateKey(stationInfo, 'supervisionUrl', 'supervisionUrls');
- stationInfo.wsOptions = stationInfo?.wsOptions ?? {};
- if (!Utils.isEmptyArray(stationInfo.power)) {
- stationInfo.power = stationInfo.power as number[];
- const powerArrayRandomIndex = Math.floor(Utils.secureRandom() * stationInfo.power.length);
+ ChargingStationUtils.convertDeprecatedTemplateKey(
+ stationTemplate,
+ 'supervisionUrl',
+ 'supervisionUrls'
+ );
+ 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;
- return stationInfo;
- }
-
- private createStationInfoHash(stationInfo: ChargingStationInfo): ChargingStationInfo {
- const previousInfoHash = stationInfo.infoHash ?? '';
- delete stationInfo.infoHash;
- const currentInfoHash = crypto
- .createHash(Constants.DEFAULT_HASH_ALGORITHM)
- .update(JSON.stringify(stationInfo))
- .digest('hex');
+ 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 (
- Utils.isEmptyString(previousInfoHash) ||
- (!Utils.isEmptyString(previousInfoHash) && currentInfoHash !== previousInfoHash)
+ configuredMaxConnectors >
+ (stationTemplate?.Connectors[0] ? templateMaxConnectors - 1 : templateMaxConnectors) &&
+ !stationTemplate?.randomConnectors
) {
- stationInfo.infoHash = currentInfoHash;
- } else {
- stationInfo.infoHash = previousInfoHash;
+ 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 {
- let stationInfo = this.getConfigurationFromFile()?.stationInfo ?? ({} as ChargingStationInfo);
- stationInfo = this.createStationInfoHash(stationInfo);
+ private getStationInfoFromFile(): ChargingStationInfo | null {
+ let stationInfo: ChargingStationInfo = null;
+ this.getStationInfoPersistentConfiguration() &&
+ (stationInfo = this.getConfigurationFromFile()?.stationInfo ?? null);
+ stationInfo && ChargingStationUtils.createStationInfoHash(stationInfo);
return stationInfo;
}
private getStationInfo(): ChargingStationInfo {
const stationInfoFromTemplate: ChargingStationInfo = this.getStationInfoFromTemplate();
- this.hashId = this.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;
}
- this.createSerialNumber(stationInfoFromTemplate, stationInfoFromFile);
+ stationInfoFromFile &&
+ ChargingStationUtils.propagateSerialNumber(
+ this.getTemplateFromFile(),
+ stationInfoFromFile,
+ stationInfoFromTemplate
+ );
return stationInfoFromTemplate;
}
private saveStationInfo(): void {
- this.saveConfiguration(Section.stationInfo);
+ if (this.getStationInfoPersistentConfiguration()) {
+ this.saveConfiguration();
+ }
}
private getOcppVersion(): OCPPVersion {
- return this.stationInfo.ocppVersion ? this.stationInfo.ocppVersion : OCPPVersion.VERSION_16;
- }
-
- private getOcppPersistentConfiguration(): boolean {
- return this.stationInfo.ocppPersistentConfiguration ?? true;
- }
-
- private handleUnsupportedVersion(version: OCPPVersion) {
- const errMsg = `${this.logPrefix()} Unsupported protocol version '${version}' configured in template file ${
- this.templateFile
- }`;
- logger.error(errMsg);
- throw new Error(errMsg);
- }
-
- private createBootNotificationRequest(stationInfo: ChargingStationInfo): BootNotificationRequest {
- return {
- chargePointModel: stationInfo.chargePointModel,
- chargePointVendor: stationInfo.chargePointVendor,
- ...(!Utils.isUndefined(stationInfo.chargeBoxSerialNumber) && {
- chargeBoxSerialNumber: stationInfo.chargeBoxSerialNumber,
- }),
- ...(!Utils.isUndefined(stationInfo.chargePointSerialNumber) && {
- chargePointSerialNumber: stationInfo.chargePointSerialNumber,
- }),
- ...(!Utils.isUndefined(stationInfo.firmwareVersion) && {
- firmwareVersion: stationInfo.firmwareVersion,
- }),
- ...(!Utils.isUndefined(stationInfo.iccid) && { iccid: stationInfo.iccid }),
- ...(!Utils.isUndefined(stationInfo.imsi) && { imsi: stationInfo.imsi }),
- ...(!Utils.isUndefined(stationInfo.meterSerialNumber) && {
- meterSerialNumber: stationInfo.meterSerialNumber,
- }),
- ...(!Utils.isUndefined(stationInfo.meterType) && {
- meterType: stationInfo.meterType,
- }),
- };
- }
-
- private getHashId(stationInfo: ChargingStationInfo): string {
- const hashBootNotificationRequest = {
- chargePointModel: stationInfo.chargePointModel,
- chargePointVendor: stationInfo.chargePointVendor,
- ...(!Utils.isUndefined(stationInfo.chargeBoxSerialNumberPrefix) && {
- chargeBoxSerialNumber: stationInfo.chargeBoxSerialNumberPrefix,
- }),
- ...(!Utils.isUndefined(stationInfo.chargePointSerialNumberPrefix) && {
- chargePointSerialNumber: stationInfo.chargePointSerialNumberPrefix,
- }),
- ...(!Utils.isUndefined(stationInfo.firmwareVersion) && {
- firmwareVersion: stationInfo.firmwareVersion,
- }),
- ...(!Utils.isUndefined(stationInfo.iccid) && { iccid: stationInfo.iccid }),
- ...(!Utils.isUndefined(stationInfo.imsi) && { imsi: stationInfo.imsi }),
- ...(!Utils.isUndefined(stationInfo.meterSerialNumberPrefix) && {
- meterSerialNumber: stationInfo.meterSerialNumberPrefix,
- }),
- ...(!Utils.isUndefined(stationInfo.meterType) && {
- meterType: stationInfo.meterType,
- }),
- };
- return crypto
- .createHash(Constants.DEFAULT_HASH_ALGORITHM)
- .update(JSON.stringify(hashBootNotificationRequest) + stationInfo.chargingStationId)
- .digest('hex');
+ return this.stationInfo.ocppVersion ?? OCPPVersion.VERSION_16;
}
- private initialize(): void {
- this.stationInfo = this.getStationInfo();
- logger.info(`${this.logPrefix()} Charging station hashId '${this.hashId}'`);
- this.bootNotificationRequest = this.createBootNotificationRequest(this.stationInfo);
- this.ocppConfiguration = this.getOcppConfiguration();
- this.stationInfo?.Configuration && delete this.stationInfo.Configuration;
- this.wsConfiguredConnectionUrl = new URL(
- this.getConfiguredSupervisionUrl().href + '/' + this.stationInfo.chargingStationId
- );
- // Build connectors if needed
- const maxConnectors = this.getMaxNumberOfConnectors();
- if (maxConnectors <= 0) {
- logger.warn(
- `${this.logPrefix()} Charging station template ${
- this.templateFile
- } with ${maxConnectors} connectors`
- );
- }
- const templateMaxConnectors = this.getTemplateMaxNumberOfConnectors();
- if (templateMaxConnectors <= 0) {
- logger.warn(
- `${this.logPrefix()} Charging station template ${
- this.templateFile
- } with no connector configuration`
- );
- }
- if (!this.stationInfo.Connectors[0]) {
- logger.warn(
- `${this.logPrefix()} Charging station template ${
- this.templateFile
- } 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.templateFile
- }, forcing random connector configurations affectation`
- );
- this.stationInfo.randomConnectors = true;
- }
- const connectorsConfigHash = crypto
- .createHash(Constants.DEFAULT_HASH_ALGORITHM)
- .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 = [];
- }
- }
- }
- }
- this.stationInfo.maximumAmperage = this.getMaximumAmperage();
- this.stationInfo = this.createStationInfoHash(this.stationInfo);
+ private getOcppPersistentConfiguration(): boolean {
+ return this.stationInfo?.ocppPersistentConfiguration ?? true;
+ }
+
+ private getStationInfoPersistentConfiguration(): boolean {
+ return this.stationInfo?.stationInfoPersistentConfiguration ?? true;
+ }
+
+ private handleUnsupportedVersion(version: OCPPVersion) {
+ const errMsg = `${this.logPrefix()} Unsupported protocol version '${version}' configured in template file ${
+ this.templateFile
+ }`;
+ logger.error(errMsg);
+ throw new Error(errMsg);
+ }
+
+ private initialize(): void {
+ this.hashId = ChargingStationUtils.getHashId(this.index, this.getTemplateFromFile());
+ logger.info(`${this.logPrefix()} Charging station hashId '${this.hashId}'`);
+ this.configurationFile = path.join(
+ path.dirname(this.templateFile.replace('station-templates', 'configurations')),
+ this.hashId + '.json'
+ );
+ this.stationInfo = this.getStationInfo();
this.saveStationInfo();
// Avoid duplication of connectors related information in RAM
- 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);
- }
- }
- // OCPP configuration
- this.initializeOcppConfiguration();
+ this.stationInfo?.Connectors && delete this.stationInfo.Connectors;
+ 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 =
- OCPP16IncomingRequestService.getInstance<OCPP16IncomingRequestService>(this);
+ OCPP16IncomingRequestService.getInstance<OCPP16IncomingRequestService>();
this.ocppRequestService = OCPP16RequestService.getInstance<OCPP16RequestService>(
- this,
- OCPP16ResponseService.getInstance<OCPP16ResponseService>(this)
+ OCPP16ResponseService.getInstance<OCPP16ResponseService>()
);
break;
default:
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 {
- if (!this.getConfigurationKey(StandardParametersKey.HeartbeatInterval)) {
- this.addConfigurationKey(StandardParametersKey.HeartbeatInterval, '0');
+ if (
+ !ChargingStationConfigurationUtils.getConfigurationKey(
+ this,
+ StandardParametersKey.HeartbeatInterval
+ )
+ ) {
+ ChargingStationConfigurationUtils.addConfigurationKey(
+ this,
+ StandardParametersKey.HeartbeatInterval,
+ '0'
+ );
}
- if (!this.getConfigurationKey(StandardParametersKey.HeartBeatInterval)) {
- this.addConfigurationKey(StandardParametersKey.HeartBeatInterval, '0', { visible: false });
+ if (
+ !ChargingStationConfigurationUtils.getConfigurationKey(
+ this,
+ StandardParametersKey.HeartBeatInterval
+ )
+ ) {
+ ChargingStationConfigurationUtils.addConfigurationKey(
+ this,
+ StandardParametersKey.HeartBeatInterval,
+ '0',
+ { visible: false }
+ );
}
if (
this.getSupervisionUrlOcppConfiguration() &&
- !this.getConfigurationKey(this.getSupervisionUrlOcppKey())
+ !ChargingStationConfigurationUtils.getConfigurationKey(this, this.getSupervisionUrlOcppKey())
) {
- this.addConfigurationKey(
+ ChargingStationConfigurationUtils.addConfigurationKey(
+ this,
this.getSupervisionUrlOcppKey(),
- this.getConfiguredSupervisionUrl().href,
+ this.configuredSupervisionUrl.href,
{ reboot: true }
);
} else if (
!this.getSupervisionUrlOcppConfiguration() &&
- this.getConfigurationKey(this.getSupervisionUrlOcppKey())
+ ChargingStationConfigurationUtils.getConfigurationKey(this, this.getSupervisionUrlOcppKey())
) {
- this.deleteConfigurationKey(this.getSupervisionUrlOcppKey(), { save: false });
+ ChargingStationConfigurationUtils.deleteConfigurationKey(
+ this,
+ this.getSupervisionUrlOcppKey(),
+ { save: false }
+ );
}
if (
this.stationInfo.amperageLimitationOcppKey &&
- !this.getConfigurationKey(this.stationInfo.amperageLimitationOcppKey)
+ !ChargingStationConfigurationUtils.getConfigurationKey(
+ this,
+ this.stationInfo.amperageLimitationOcppKey
+ )
) {
- this.addConfigurationKey(
+ ChargingStationConfigurationUtils.addConfigurationKey(
+ this,
this.stationInfo.amperageLimitationOcppKey,
- (this.stationInfo.maximumAmperage * this.getAmperageLimitationUnitDivider()).toString()
+ (
+ this.stationInfo.maximumAmperage *
+ ChargingStationUtils.getAmperageLimitationUnitDivider(this.stationInfo)
+ ).toString()
);
}
- if (!this.getConfigurationKey(StandardParametersKey.SupportedFeatureProfiles)) {
- this.addConfigurationKey(
+ if (
+ !ChargingStationConfigurationUtils.getConfigurationKey(
+ this,
+ StandardParametersKey.SupportedFeatureProfiles
+ )
+ ) {
+ ChargingStationConfigurationUtils.addConfigurationKey(
+ this,
StandardParametersKey.SupportedFeatureProfiles,
`${SupportedFeatureProfiles.Core},${SupportedFeatureProfiles.FirmwareManagement},${SupportedFeatureProfiles.LocalAuthListManagement},${SupportedFeatureProfiles.SmartCharging},${SupportedFeatureProfiles.RemoteTrigger}`
);
}
- this.addConfigurationKey(
+ ChargingStationConfigurationUtils.addConfigurationKey(
+ this,
StandardParametersKey.NumberOfConnectors,
this.getNumberOfConnectors().toString(),
{ readonly: true },
{ overwrite: true }
);
- if (!this.getConfigurationKey(StandardParametersKey.MeterValuesSampledData)) {
- this.addConfigurationKey(
+ if (
+ !ChargingStationConfigurationUtils.getConfigurationKey(
+ this,
+ StandardParametersKey.MeterValuesSampledData
+ )
+ ) {
+ ChargingStationConfigurationUtils.addConfigurationKey(
+ this,
StandardParametersKey.MeterValuesSampledData,
MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER
);
}
- if (!this.getConfigurationKey(StandardParametersKey.ConnectorPhaseRotation)) {
+ if (
+ !ChargingStationConfigurationUtils.getConfigurationKey(
+ this,
+ StandardParametersKey.ConnectorPhaseRotation
+ )
+ ) {
const connectorPhaseRotation = [];
for (const connectorId of this.connectors.keys()) {
// AC/DC
connectorPhaseRotation.push(`${connectorId}.${ConnectorPhaseRotation.RST}`);
}
}
- this.addConfigurationKey(
+ ChargingStationConfigurationUtils.addConfigurationKey(
+ this,
StandardParametersKey.ConnectorPhaseRotation,
connectorPhaseRotation.toString()
);
}
- if (!this.getConfigurationKey(StandardParametersKey.AuthorizeRemoteTxRequests)) {
- this.addConfigurationKey(StandardParametersKey.AuthorizeRemoteTxRequests, 'true');
- }
if (
- !this.getConfigurationKey(StandardParametersKey.LocalAuthListEnabled) &&
- this.getConfigurationKey(StandardParametersKey.SupportedFeatureProfiles)?.value.includes(
- SupportedFeatureProfiles.LocalAuthListManagement
+ !ChargingStationConfigurationUtils.getConfigurationKey(
+ this,
+ StandardParametersKey.AuthorizeRemoteTxRequests
)
) {
- this.addConfigurationKey(StandardParametersKey.LocalAuthListEnabled, 'false');
+ ChargingStationConfigurationUtils.addConfigurationKey(
+ this,
+ StandardParametersKey.AuthorizeRemoteTxRequests,
+ 'true'
+ );
+ }
+ if (
+ !ChargingStationConfigurationUtils.getConfigurationKey(
+ this,
+ StandardParametersKey.LocalAuthListEnabled
+ ) &&
+ ChargingStationConfigurationUtils.getConfigurationKey(
+ this,
+ StandardParametersKey.SupportedFeatureProfiles
+ )?.value.includes(SupportedFeatureProfiles.LocalAuthListManagement)
+ ) {
+ ChargingStationConfigurationUtils.addConfigurationKey(
+ this,
+ StandardParametersKey.LocalAuthListEnabled,
+ 'false'
+ );
}
- if (!this.getConfigurationKey(StandardParametersKey.ConnectionTimeOut)) {
- this.addConfigurationKey(
+ if (
+ !ChargingStationConfigurationUtils.getConfigurationKey(
+ this,
+ StandardParametersKey.ConnectionTimeOut
+ )
+ ) {
+ ChargingStationConfigurationUtils.addConfigurationKey(
+ this,
StandardParametersKey.ConnectionTimeOut,
Constants.DEFAULT_CONNECTION_TIMEOUT.toString()
);
this.saveOcppConfiguration();
}
+ private initializeConnectors(
+ stationInfo: ChargingStationInfo,
+ configuredMaxConnectors: number,
+ templateMaxConnectors: number
+ ): void {
+ if (!stationInfo?.Connectors && this.connectors.size === 0) {
+ const logMsg = `${this.logPrefix()} No already defined connectors and charging station information from template ${
+ this.templateFile
+ } with no connectors configuration defined`;
+ logger.error(logMsg);
+ throw new BaseError(logMsg);
+ }
+ if (!stationInfo?.Connectors[0]) {
+ logger.warn(
+ `${this.logPrefix()} Charging station information from template ${
+ this.templateFile
+ } with no connector Id 0 configuration`
+ );
+ }
+ if (stationInfo?.Connectors) {
+ const connectorsConfigHash = crypto
+ .createHash(Constants.DEFAULT_HASH_ALGORITHM)
+ .update(JSON.stringify(stationInfo?.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;
+ // Add connector Id 0
+ let lastConnector = '0';
+ for (lastConnector in stationInfo?.Connectors) {
+ const lastConnectorId = Utils.convertToInt(lastConnector);
+ if (
+ lastConnectorId === 0 &&
+ this.getUseConnectorId0(stationInfo) &&
+ stationInfo?.Connectors[lastConnector]
+ ) {
+ this.connectors.set(
+ lastConnectorId,
+ Utils.cloneObject<ConnectorStatus>(stationInfo?.Connectors[lastConnector])
+ );
+ this.getConnectorStatus(lastConnectorId).availability = AvailabilityType.OPERATIVE;
+ if (Utils.isUndefined(this.getConnectorStatus(lastConnectorId)?.chargingProfiles)) {
+ this.getConnectorStatus(lastConnectorId).chargingProfiles = [];
+ }
+ }
+ }
+ // Generate all connectors
+ if ((stationInfo?.Connectors[0] ? templateMaxConnectors - 1 : templateMaxConnectors) > 0) {
+ for (let index = 1; index <= configuredMaxConnectors; index++) {
+ const randConnectorId = stationInfo?.randomConnectors
+ ? Utils.getRandomInteger(Utils.convertToInt(lastConnector), 1)
+ : index;
+ this.connectors.set(
+ index,
+ Utils.cloneObject<ConnectorStatus>(stationInfo?.Connectors[randConnectorId])
+ );
+ this.getConnectorStatus(index).availability = AvailabilityType.OPERATIVE;
+ if (Utils.isUndefined(this.getConnectorStatus(index)?.chargingProfiles)) {
+ this.getConnectorStatus(index).chargingProfiles = [];
+ }
+ }
+ }
+ }
+ } else {
+ logger.warn(
+ `${this.logPrefix()} Charging station information from template ${
+ this.templateFile
+ } with no connectors configuration defined, using already defined connectors`
+ );
+ }
+ // Initialize transaction attributes on connectors
+ for (const connectorId of this.connectors.keys()) {
+ if (connectorId > 0 && !this.getConnectorStatus(connectorId)?.transactionStarted) {
+ this.initializeConnectorStatus(connectorId);
+ }
+ }
+ }
+
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 {
- const configurationData: ChargingStationConfiguration =
- this.getConfigurationFromFile() ?? {};
if (!fs.existsSync(path.dirname(this.configurationFile))) {
fs.mkdirSync(path.dirname(this.configurationFile), { recursive: true });
}
- 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 info 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;
+ const configurationData: ChargingStationConfiguration =
+ this.getConfigurationFromFile() ?? {};
+ 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 getOcppConfigurationFromTemplate(): ChargingStationOcppConfiguration {
- return this.getTemplateFromFile().Configuration ?? ({} as ChargingStationOcppConfiguration);
+ private getOcppConfigurationFromTemplate(): ChargingStationOcppConfiguration | null {
+ return this.getTemplateFromFile()?.Configuration ?? null;
}
private getOcppConfigurationFromFile(): ChargingStationOcppConfiguration | null {
return configuration;
}
- private getOcppConfiguration(): ChargingStationOcppConfiguration {
+ private getOcppConfiguration(): ChargingStationOcppConfiguration | null {
let ocppConfiguration: ChargingStationOcppConfiguration = this.getOcppConfigurationFromFile();
if (!ocppConfiguration) {
ocppConfiguration = this.getOcppConfigurationFromTemplate();
return ocppConfiguration;
}
- private saveOcppConfiguration(): void {
- if (this.getOcppPersistentConfiguration()) {
- this.saveConfiguration(Section.ocppConfiguration);
- }
- }
-
private async onOpen(): Promise<void> {
if (this.isWebSocketConnectionOpened()) {
logger.info(
BootNotificationRequest,
BootNotificationResponse
>(
+ this,
RequestCommand.BOOT_NOTIFICATION,
{
chargePointModel: this.bootNotificationRequest.chargePointModel,
case WebSocketCloseEventStatusCode.CLOSE_NORMAL:
case WebSocketCloseEventStatusCode.CLOSE_NO_STATUS:
logger.info(
- `${this.logPrefix()} WebSocket normally closed with status '${Utils.getWebSocketCloseEventStatusString(
+ `${this.logPrefix()} WebSocket normally closed with status '${ChargingStationUtils.getWebSocketCloseEventStatusString(
code
)}' and reason '${reason}'`
);
// Abnormal close
default:
logger.error(
- `${this.logPrefix()} WebSocket abnormally closed with status '${Utils.getWebSocketCloseEventStatusString(
+ `${this.logPrefix()} WebSocket abnormally closed with status '${ChargingStationUtils.getWebSocketCloseEventStatusString(
code
)}' and reason '${reason}'`
);
let errorMessage: string;
let errorDetails: JsonType;
let responseCallback: (payload: JsonType, requestPayload: JsonType) => void;
- let rejectCallback: (error: OCPPError, requestStatistic?: boolean) => void;
+ let errorCallback: (error: OCPPError, requestStatistic?: boolean) => void;
let requestCommandName: RequestCommand | IncomingRequestCommand;
let requestPayload: JsonType;
let cachedRequest: CachedRequest;
);
// Process the message
await this.ocppIncomingRequestService.incomingRequestHandler(
+ this,
messageId,
commandName,
commandPayload
// Outcome Message
case MessageType.CALL_RESULT_MESSAGE:
[, , commandPayload] = request as Response;
+ if (!this.requests.has(messageId)) {
+ // Error
+ throw new OCPPError(
+ ErrorType.INTERNAL_ERROR,
+ `Response for unknown message id ${messageId}`,
+ null,
+ commandPayload
+ );
+ }
// Respond
cachedRequest = this.requests.get(messageId);
if (Utils.isIterable(cachedRequest)) {
}
logger.debug(
`${this.logPrefix()} << Command '${
- requestCommandName ?? ''
+ requestCommandName ?? 'unknown'
}' received response payload: ${JSON.stringify(request)}`
);
- if (!responseCallback) {
+ responseCallback(commandPayload, requestPayload);
+ break;
+ // Error Message
+ case MessageType.CALL_ERROR_MESSAGE:
+ [, , errorType, errorMessage, errorDetails] = request as ErrorResponse;
+ if (!this.requests.has(messageId)) {
// Error
throw new OCPPError(
ErrorType.INTERNAL_ERROR,
- `Response for unknown message id ${messageId}`,
+ `Error response for unknown message id ${messageId}`,
null,
- commandPayload
+ { errorType, errorMessage, errorDetails }
);
}
- responseCallback(commandPayload, requestPayload);
- break;
- // Error Message
- case MessageType.CALL_ERROR_MESSAGE:
- [, , errorType, errorMessage, errorDetails] = request as ErrorResponse;
cachedRequest = this.requests.get(messageId);
if (Utils.isIterable(cachedRequest)) {
- [, rejectCallback, requestCommandName] = cachedRequest;
+ [, errorCallback, requestCommandName] = cachedRequest;
} else {
throw new OCPPError(
ErrorType.PROTOCOL_ERROR,
}
logger.debug(
`${this.logPrefix()} << Command '${
- requestCommandName ?? ''
+ requestCommandName ?? 'unknown'
}' received error payload: ${JSON.stringify(request)}`
);
- if (!rejectCallback) {
- // Error
- throw new OCPPError(
- ErrorType.INTERNAL_ERROR,
- `Error response for unknown message id ${messageId}`,
- null,
- { errorType, errorMessage, errorDetails }
- );
- }
- rejectCallback(
- new OCPPError(errorType, errorMessage, requestCommandName, errorDetails)
- );
+ errorCallback(new OCPPError(errorType, errorMessage, requestCommandName, errorDetails));
break;
// Error
default:
} catch (error) {
// Log
logger.error(
- '%s Incoming OCPP message %j matching cached request %j processing error %j',
+ "%s Incoming OCPP '%s' message '%j' matching cached request '%j' processing error: %j",
this.logPrefix(),
+ commandName ?? requestCommandName ?? null,
data.toString(),
this.requests.get(messageId),
error
);
+ if (!(error instanceof OCPPError)) {
+ logger.warn(
+ "%s Error thrown at incoming OCPP '%s' message '%j' handling is not an OCPPError: %j",
+ this.logPrefix(),
+ commandName ?? requestCommandName ?? null,
+ data.toString(),
+ error
+ );
+ }
// Send error
messageType === MessageType.CALL_MESSAGE &&
(await this.ocppRequestService.sendError(
+ this,
messageId,
error as OCPPError,
- Utils.isString(commandName) ? commandName : requestCommandName ?? null
+ commandName ?? requestCommandName ?? null
));
}
}
}
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;
}
// 0 for disabling
private getConnectionTimeout(): number | undefined {
- if (this.getConfigurationKey(StandardParametersKey.ConnectionTimeOut)) {
+ if (
+ ChargingStationConfigurationUtils.getConfigurationKey(
+ this,
+ StandardParametersKey.ConnectionTimeOut
+ )
+ ) {
return (
- parseInt(this.getConfigurationKey(StandardParametersKey.ConnectionTimeOut).value) ??
- Constants.DEFAULT_CONNECTION_TIMEOUT
+ parseInt(
+ ChargingStationConfigurationUtils.getConfigurationKey(
+ this,
+ StandardParametersKey.ConnectionTimeOut
+ ).value
+ ) ?? Constants.DEFAULT_CONNECTION_TIMEOUT
);
}
return Constants.DEFAULT_CONNECTION_TIMEOUT;
private getPowerDivider(): number {
let powerDivider = this.getNumberOfConnectors();
- if (this.stationInfo.powerSharedByConnectors) {
+ if (this.stationInfo?.powerSharedByConnectors) {
powerDivider = this.getNumberOfRunningTransactions();
}
return powerDivider;
}
- private getTemplateMaxNumberOfConnectors(): number {
- 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());
- }
- }
-
- private getAmperageLimitationUnitDivider(): number {
- let unitDivider = 1;
- switch (this.stationInfo.amperageLimitationUnit) {
- case AmpereUnits.DECI_AMPERE:
- unitDivider = 10;
- break;
- case AmpereUnits.CENTI_AMPERE:
- unitDivider = 100;
- break;
- case AmpereUnits.MILLI_AMPERE:
- unitDivider = 1000;
- break;
+ return DCElectricUtils.amperage(maximumPower, this.getVoltageOut(stationInfo));
}
- return unitDivider;
}
private getAmperageLimitation(): number | undefined {
if (
this.stationInfo.amperageLimitationOcppKey &&
- this.getConfigurationKey(this.stationInfo.amperageLimitationOcppKey)
+ ChargingStationConfigurationUtils.getConfigurationKey(
+ this,
+ this.stationInfo.amperageLimitationOcppKey
+ )
) {
return (
Utils.convertToInt(
- this.getConfigurationKey(this.stationInfo.amperageLimitationOcppKey).value
- ) / this.getAmperageLimitationUnitDivider()
+ ChargingStationConfigurationUtils.getConfigurationKey(
+ this,
+ this.stationInfo.amperageLimitationOcppKey
+ ).value
+ ) / ChargingStationUtils.getAmperageLimitationUnitDivider(this.stationInfo)
);
}
}
private async startMessageSequence(): Promise<void> {
- if (this.stationInfo.autoRegister) {
+ if (this.stationInfo?.autoRegister) {
await this.ocppRequestService.requestHandler<
BootNotificationRequest,
BootNotificationResponse
>(
+ this,
RequestCommand.BOOT_NOTIFICATION,
{
chargePointModel: this.bootNotificationRequest.chargePointModel,
await this.ocppRequestService.requestHandler<
StatusNotificationRequest,
StatusNotificationResponse
- >(RequestCommand.STATUS_NOTIFICATION, {
+ >(this, RequestCommand.STATUS_NOTIFICATION, {
connectorId,
status: this.getConnectorStatus(connectorId).bootStatus,
errorCode: ChargePointErrorCode.NO_ERROR,
await this.ocppRequestService.requestHandler<
StatusNotificationRequest,
StatusNotificationResponse
- >(RequestCommand.STATUS_NOTIFICATION, {
+ >(this, RequestCommand.STATUS_NOTIFICATION, {
connectorId,
status: this.getConnectorStatus(connectorId).bootStatus,
errorCode: ChargePointErrorCode.NO_ERROR,
await this.ocppRequestService.requestHandler<
StatusNotificationRequest,
StatusNotificationResponse
- >(RequestCommand.STATUS_NOTIFICATION, {
+ >(this, RequestCommand.STATUS_NOTIFICATION, {
connectorId,
status: this.getConnectorStatus(connectorId).status,
errorCode: ChargePointErrorCode.NO_ERROR,
await this.ocppRequestService.requestHandler<
StatusNotificationRequest,
StatusNotificationResponse
- >(RequestCommand.STATUS_NOTIFICATION, {
+ >(this, RequestCommand.STATUS_NOTIFICATION, {
connectorId,
status: ChargePointStatus.AVAILABLE,
errorCode: ChargePointErrorCode.NO_ERROR,
}
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) {
this.getEnergyActiveImportRegisterByTransactionId(transactionId)
);
await this.ocppRequestService.requestHandler<MeterValuesRequest, MeterValuesResponse>(
+ this,
RequestCommand.METER_VALUES,
{
connectorId,
transactionId,
- meterValue: transactionEndMeterValue,
+ meterValue: [transactionEndMeterValue],
}
);
}
await this.ocppRequestService.requestHandler<
StopTransactionRequest,
StopTransactionResponse
- >(RequestCommand.STOP_TRANSACTION, {
+ >(this, RequestCommand.STOP_TRANSACTION, {
transactionId,
meterStop: this.getEnergyActiveImportRegisterByTransactionId(transactionId),
idTag: this.getTransactionIdTag(transactionId),
}
private startWebSocketPing(): void {
- const webSocketPingInterval: number = this.getConfigurationKey(
+ const webSocketPingInterval: number = ChargingStationConfigurationUtils.getConfigurationKey(
+ this,
StandardParametersKey.WebSocketPingInterval
)
? Utils.convertToInt(
- this.getConfigurationKey(StandardParametersKey.WebSocketPingInterval).value
+ ChargingStationConfigurationUtils.getConfigurationKey(
+ this,
+ StandardParametersKey.WebSocketPingInterval
+ ).value
)
: 0;
if (webSocketPingInterval > 0 && !this.webSocketPingSetInterval) {
}
}
- private warnDeprecatedTemplateKey(
- template: ChargingStationTemplate,
- key: string,
- chargingStationId: string,
- logMsgToAppend = ''
- ): void {
- if (!Utils.isUndefined(template[key])) {
- const logPrefixStr = ` ${chargingStationId} |`;
- logger.warn(
- `${Utils.logPrefix(logPrefixStr)} Deprecated template key '${key}' usage in file '${
- this.templateFile
- }'${logMsgToAppend && '. ' + logMsgToAppend}`
- );
- }
- }
-
- private convertDeprecatedTemplateKey(
- template: ChargingStationTemplate,
- deprecatedKey: string,
- key: string
- ): void {
- if (!Utils.isUndefined(template[deprecatedKey])) {
- template[key] = template[deprecatedKey] as unknown;
- delete template[deprecatedKey];
- }
- }
-
private getConfiguredSupervisionUrl(): URL {
const supervisionUrls = Utils.cloneObject<string | string[]>(
this.stationInfo.supervisionUrls ?? Configuration.getSupervisionUrls()
}
private getHeartbeatInterval(): number | undefined {
- const HeartbeatInterval = this.getConfigurationKey(StandardParametersKey.HeartbeatInterval);
+ const HeartbeatInterval = ChargingStationConfigurationUtils.getConfigurationKey(
+ this,
+ StandardParametersKey.HeartbeatInterval
+ );
if (HeartbeatInterval) {
return Utils.convertToInt(HeartbeatInterval.value) * 1000;
}
- const HeartBeatInterval = this.getConfigurationKey(StandardParametersKey.HeartBeatInterval);
+ const HeartBeatInterval = ChargingStationConfigurationUtils.getConfigurationKey(
+ this,
+ StandardParametersKey.HeartBeatInterval
+ );
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
+ options: WsOptions = this.stationInfo?.wsOptions ?? {},
+ 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.autoReconnectRetryCount.toString()
);
this.openWSConnection(
- { ...this.stationInfo.wsOptions, handshakeTimeout: reconnectTimeout },
- true
+ { ...(this.stationInfo?.wsOptions ?? {}), handshakeTimeout: reconnectTimeout },
+ { 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