// Partial Copyright Jerome Benoit. 2021-2023. All Rights Reserved.
-import crypto from 'node:crypto';
-import fs from 'node:fs';
-import path from 'node:path';
+import { createHash } from 'node:crypto';
+import { type FSWatcher, existsSync, mkdirSync, readFileSync, writeFileSync } from 'node:fs';
+import { dirname, join } from 'node:path';
import { URL } from 'node:url';
-import { parentPort } from 'worker_threads';
+import { parentPort } from 'node:worker_threads';
+import { millisecondsToSeconds, secondsToMilliseconds } from 'date-fns';
import merge from 'just-merge';
-import WebSocket, { type RawData } from 'ws';
+import { type RawData, WebSocket } from 'ws';
+import { AutomaticTransactionGenerator } from './AutomaticTransactionGenerator';
+import { ChargingStationWorkerBroadcastChannel } from './broadcast-channel/ChargingStationWorkerBroadcastChannel';
import {
- AuthorizedTagsCache,
- AutomaticTransactionGenerator,
- ChargingStationConfigurationUtils,
- ChargingStationUtils,
- ChargingStationWorkerBroadcastChannel,
- MessageChannelUtils,
- SharedLRUCache,
-} from './internal';
+ addConfigurationKey,
+ deleteConfigurationKey,
+ getConfigurationKey,
+ setConfigurationKeyValue,
+} from './ConfigurationKeyUtils';
import {
- // OCPP16IncomingRequestService,
+ buildConnectorsMap,
+ checkChargingStation,
+ checkConnectorsConfiguration,
+ checkStationInfoConnectorStatus,
+ checkTemplate,
+ createBootNotificationRequest,
+ createSerialNumber,
+ getAmperageLimitationUnitDivider,
+ getBootConnectorStatus,
+ getChargingStationConnectorChargingProfilesPowerLimit,
+ getChargingStationId,
+ getDefaultVoltageOut,
+ getHashId,
+ getIdTagsFile,
+ getMaxNumberOfEvses,
+ getNumberOfReservableConnectors,
+ getPhaseRotationValue,
+ hasFeatureProfile,
+ hasReservationExpired,
+ initializeConnectorsMapStatus,
+ propagateSerialNumber,
+ removeExpiredReservations,
+ stationTemplateToStationInfo,
+ warnTemplateKeysDeprecation,
+} from './Helpers';
+import { IdTagsCache } from './IdTagsCache';
+import {
+ OCPP16IncomingRequestService,
OCPP16RequestService,
- // OCPP16ResponseService,
+ OCPP16ResponseService,
OCPP16ServiceUtils,
OCPP20IncomingRequestService,
OCPP20RequestService,
- // OCPP20ResponseService,
+ OCPP20ResponseService,
type OCPPIncomingRequestService,
type OCPPRequestService,
- // OCPPServiceUtils,
+ OCPPServiceUtils,
} from './ocpp';
-import { OCPP16IncomingRequestService } from './ocpp/1.6/OCPP16IncomingRequestService';
-import { OCPP16ResponseService } from './ocpp/1.6/OCPP16ResponseService';
-import { OCPP20ResponseService } from './ocpp/2.0/OCPP20ResponseService';
-import { OCPPServiceUtils } from './ocpp/OCPPServiceUtils';
+import { SharedLRUCache } from './SharedLRUCache';
import { BaseError, OCPPError } from '../exception';
-// import { PerformanceStatistics } from '../performance';
-import { PerformanceStatistics } from '../performance/PerformanceStatistics';
+import { PerformanceStatistics } from '../performance';
import {
type AutomaticTransactionGeneratorConfiguration,
AvailabilityType,
type ChargingStationInfo,
type ChargingStationOcppConfiguration,
type ChargingStationTemplate,
- ConnectorPhaseRotation,
- ConnectorStatus,
+ type ConnectorStatus,
ConnectorStatusEnum,
CurrentType,
type ErrorCallback,
type ErrorResponse,
ErrorType,
+ type EvseStatus,
+ type EvseStatusConfiguration,
FileType,
FirmwareStatus,
type FirmwareStatusNotificationRequest,
PowerUnits,
RegistrationStatusEnumType,
RequestCommand,
+ type Reservation,
+ type ReservationKey,
+ ReservationTerminationReason,
type Response,
- type ResponseCallback,
StandardParametersKey,
+ type Status,
type StatusNotificationRequest,
type StatusNotificationResponse,
StopTransactionReason,
type StopTransactionResponse,
SupervisionUrlDistribution,
SupportedFeatureProfiles,
- VendorDefaultParametersKey,
+ VendorParametersKey,
type WSError,
WebSocketCloseEventStatusCode,
type WsOptions,
} from '../types';
import {
ACElectricUtils,
+ AsyncLock,
+ AsyncLockType,
Configuration,
Constants,
DCElectricUtils,
- FileUtils,
- Utils,
+ buildChargingStationAutomaticTransactionGeneratorConfiguration,
+ buildConnectorsStatus,
+ buildEvsesStatus,
+ buildStartedMessage,
+ buildStoppedMessage,
+ buildUpdatedMessage,
+ cloneObject,
+ convertToBoolean,
+ convertToInt,
+ exponentialDelay,
+ formatDurationMilliSeconds,
+ formatDurationSeconds,
+ getRandomInteger,
+ getWebSocketCloseEventStatusString,
+ handleFileException,
+ isNotEmptyArray,
+ isNotEmptyString,
+ isNullOrUndefined,
+ isUndefined,
+ logPrefix,
logger,
+ min,
+ once,
+ roundTo,
+ secureRandom,
+ sleep,
+ watchJsonFile,
} from '../utils';
export class ChargingStation {
public stationInfo!: ChargingStationInfo;
public started: boolean;
public starting: boolean;
- public authorizedTagsCache: AuthorizedTagsCache;
+ public idTagsCache: IdTagsCache;
public automaticTransactionGenerator!: AutomaticTransactionGenerator | undefined;
public ocppConfiguration!: ChargingStationOcppConfiguration | undefined;
public wsConnection!: WebSocket | null;
public readonly connectors: Map<number, ConnectorStatus>;
+ public readonly evses: Map<number, EvseStatus>;
public readonly requests: Map<string, CachedRequest>;
public performanceStatistics!: PerformanceStatistics | undefined;
- public heartbeatSetInterval!: NodeJS.Timeout;
+ public heartbeatSetInterval?: NodeJS.Timeout;
public ocppRequestService!: OCPPRequestService;
public bootNotificationRequest!: BootNotificationRequest;
public bootNotificationResponse!: BootNotificationResponse | undefined;
private configurationFile!: string;
private configurationFileHash!: string;
private connectorsConfigurationHash!: string;
+ private evsesConfigurationHash!: string;
+ private automaticTransactionGeneratorConfiguration?: AutomaticTransactionGeneratorConfiguration;
private ocppIncomingRequestService!: OCPPIncomingRequestService;
private readonly messageBuffer: Set<string>;
private configuredSupervisionUrl!: URL;
- private configuredSupervisionUrlIndex!: number;
private wsConnectionRestarted: boolean;
private autoReconnectRetryCount: number;
- private templateFileWatcher!: fs.FSWatcher | undefined;
+ private templateFileWatcher!: FSWatcher | undefined;
+ private templateFileHash!: string;
private readonly sharedLRUCache: SharedLRUCache;
- private webSocketPingSetInterval!: NodeJS.Timeout;
+ private webSocketPingSetInterval?: NodeJS.Timeout;
private readonly chargingStationWorkerBroadcastChannel: ChargingStationWorkerBroadcastChannel;
+ private reservationExpirationSetInterval?: NodeJS.Timeout;
constructor(index: number, templateFile: string) {
this.started = false;
this.index = index;
this.templateFile = templateFile;
this.connectors = new Map<number, ConnectorStatus>();
+ this.evses = new Map<number, EvseStatus>();
this.requests = new Map<string, CachedRequest>();
this.messageBuffer = new Set<string>();
this.sharedLRUCache = SharedLRUCache.getInstance();
- this.authorizedTagsCache = AuthorizedTagsCache.getInstance();
+ this.idTagsCache = IdTagsCache.getInstance();
this.chargingStationWorkerBroadcastChannel = new ChargingStationWorkerBroadcastChannel(this);
this.initialize();
}
+ public get hasEvses(): boolean {
+ return this.connectors.size === 0 && this.evses.size > 0;
+ }
+
private get wsConnectionUrl(): URL {
return new URL(
`${
- this.getSupervisionUrlOcppConfiguration()
- ? ChargingStationConfigurationUtils.getConfigurationKey(
- this,
- this.getSupervisionUrlOcppKey()
- )?.value
+ this.getSupervisionUrlOcppConfiguration() &&
+ isNotEmptyString(this.getSupervisionUrlOcppKey()) &&
+ isNotEmptyString(getConfigurationKey(this, this.getSupervisionUrlOcppKey())?.value)
+ ? getConfigurationKey(this, this.getSupervisionUrlOcppKey())!.value
: this.configuredSupervisionUrl.href
- }/${this.stationInfo.chargingStationId}`
+ }/${this.stationInfo.chargingStationId}`,
);
}
public logPrefix = (): string => {
- return Utils.logPrefix(
+ return logPrefix(
` ${
- (Utils.isNotEmptyString(this?.stationInfo?.chargingStationId) &&
- this?.stationInfo?.chargingStationId) ??
- ChargingStationUtils.getChargingStationId(this.index, this.getTemplateFromFile()) ??
- ''
- } |`
+ (isNotEmptyString(this?.stationInfo?.chargingStationId)
+ ? this?.stationInfo?.chargingStationId
+ : getChargingStationId(this.index, this.getTemplateFromFile()!)) ??
+ 'Error at building log prefix'
+ } |`,
);
};
- public hasAuthorizedTags(): boolean {
- return Utils.isNotEmptyArray(
- this.authorizedTagsCache.getAuthorizedTags(
- ChargingStationUtils.getAuthorizationFile(this.stationInfo)
- )
- );
+ public hasIdTags(): boolean {
+ return isNotEmptyArray(this.idTagsCache.getIdTags(getIdTagsFile(this.stationInfo)!));
}
public getEnableStatistics(): boolean {
return this.stationInfo.enableStatistics ?? false;
}
- public getMustAuthorizeAtRemoteStart(): boolean {
- return this.stationInfo.mustAuthorizeAtRemoteStart ?? true;
- }
-
- public getPayloadSchemaValidation(): boolean {
- return this.stationInfo.payloadSchemaValidation ?? true;
+ public getRemoteAuthorization(): boolean {
+ return this.stationInfo.remoteAuthorization ?? true;
}
- public getNumberOfPhases(stationInfo?: ChargingStationInfo): number | undefined {
+ public getNumberOfPhases(stationInfo?: ChargingStationInfo): number {
const localStationInfo: ChargingStationInfo = stationInfo ?? this.stationInfo;
switch (this.getCurrentOutType(stationInfo)) {
case CurrentType.AC:
- return !Utils.isUndefined(localStationInfo.numberOfPhases)
- ? localStationInfo.numberOfPhases
- : 3;
+ return !isUndefined(localStationInfo.numberOfPhases) ? localStationInfo.numberOfPhases! : 3;
case CurrentType.DC:
return 0;
}
return this?.bootNotificationResponse?.status;
}
- public isInUnknownState(): boolean {
- return Utils.isNullOrUndefined(this?.bootNotificationResponse?.status);
+ public inUnknownState(): boolean {
+ return isNullOrUndefined(this?.bootNotificationResponse?.status);
}
- public isInPendingState(): boolean {
+ public inPendingState(): boolean {
return this?.bootNotificationResponse?.status === RegistrationStatusEnumType.PENDING;
}
- public isInAcceptedState(): boolean {
+ public inAcceptedState(): boolean {
return this?.bootNotificationResponse?.status === RegistrationStatusEnumType.ACCEPTED;
}
- public isInRejectedState(): boolean {
+ public inRejectedState(): boolean {
return this?.bootNotificationResponse?.status === RegistrationStatusEnumType.REJECTED;
}
public isRegistered(): boolean {
return (
- this.isInUnknownState() === false &&
- (this.isInAcceptedState() === true || this.isInPendingState() === true)
+ this.inUnknownState() === false &&
+ (this.inAcceptedState() === true || this.inPendingState() === true)
);
}
public isChargingStationAvailable(): boolean {
- return this.getConnectorStatus(0)?.availability === AvailabilityType.OPERATIVE;
+ return this.getConnectorStatus(0)?.availability === AvailabilityType.Operative;
}
- public isConnectorAvailable(id: number): boolean {
- return id > 0 && this.getConnectorStatus(id)?.availability === AvailabilityType.OPERATIVE;
+ public hasConnector(connectorId: number): boolean {
+ if (this.hasEvses) {
+ for (const evseStatus of this.evses.values()) {
+ if (evseStatus.connectors.has(connectorId)) {
+ return true;
+ }
+ }
+ return false;
+ }
+ return this.connectors.has(connectorId);
+ }
+
+ public isConnectorAvailable(connectorId: number): boolean {
+ return (
+ connectorId > 0 &&
+ this.getConnectorStatus(connectorId)?.availability === AvailabilityType.Operative
+ );
}
public getNumberOfConnectors(): number {
- return this.connectors.get(0) ? this.connectors.size - 1 : this.connectors.size;
+ if (this.hasEvses) {
+ let numberOfConnectors = 0;
+ for (const [evseId, evseStatus] of this.evses) {
+ if (evseId > 0) {
+ numberOfConnectors += evseStatus.connectors.size;
+ }
+ }
+ return numberOfConnectors;
+ }
+ return this.connectors.has(0) ? this.connectors.size - 1 : this.connectors.size;
+ }
+
+ public getNumberOfEvses(): number {
+ return this.evses.has(0) ? this.evses.size - 1 : this.evses.size;
}
- public getConnectorStatus(id: number): ConnectorStatus | undefined {
- return this.connectors.get(id);
+ public getConnectorStatus(connectorId: number): ConnectorStatus | undefined {
+ if (this.hasEvses) {
+ for (const evseStatus of this.evses.values()) {
+ if (evseStatus.connectors.has(connectorId)) {
+ return evseStatus.connectors.get(connectorId);
+ }
+ }
+ return undefined;
+ }
+ return this.connectors.get(connectorId);
}
public getCurrentOutType(stationInfo?: ChargingStationInfo): CurrentType {
}
public getOcppStrictCompliance(): boolean {
- return this.stationInfo?.ocppStrictCompliance ?? false;
+ return this.stationInfo?.ocppStrictCompliance ?? true;
}
- public getVoltageOut(stationInfo?: ChargingStationInfo): number | undefined {
- const defaultVoltageOut = ChargingStationUtils.getDefaultVoltageOut(
+ public getVoltageOut(stationInfo?: ChargingStationInfo): number {
+ const defaultVoltageOut = getDefaultVoltageOut(
this.getCurrentOutType(stationInfo),
+ this.logPrefix(),
this.templateFile,
- this.logPrefix()
);
- const localStationInfo: ChargingStationInfo = stationInfo ?? this.stationInfo;
- return !Utils.isUndefined(localStationInfo.voltageOut)
- ? localStationInfo.voltageOut
- : defaultVoltageOut;
+ return (stationInfo ?? this.stationInfo).voltageOut ?? defaultVoltageOut;
}
public getMaximumPower(stationInfo?: ChargingStationInfo): number {
- const localStationInfo = stationInfo ?? this.stationInfo;
- return (localStationInfo['maxPower'] as number) ?? localStationInfo.maximumPower;
+ return (stationInfo ?? this.stationInfo).maximumPower!;
}
public getConnectorMaximumAvailablePower(connectorId: number): number {
- let connectorAmperageLimitationPowerLimit: number;
+ let connectorAmperageLimitationPowerLimit: number | undefined;
if (
- !Utils.isNullOrUndefined(this.getAmperageLimitation()) &&
- this.getAmperageLimitation() < this.stationInfo?.maximumAmperage
+ !isNullOrUndefined(this.getAmperageLimitation()) &&
+ this.getAmperageLimitation()! < this.stationInfo.maximumAmperage!
) {
connectorAmperageLimitationPowerLimit =
(this.getCurrentOutType() === CurrentType.AC
? ACElectricUtils.powerTotal(
this.getNumberOfPhases(),
this.getVoltageOut(),
- this.getAmperageLimitation() * this.getNumberOfConnectors()
+ this.getAmperageLimitation()! *
+ (this.hasEvses ? this.getNumberOfEvses() : this.getNumberOfConnectors()),
)
- : DCElectricUtils.power(this.getVoltageOut(), this.getAmperageLimitation())) /
+ : DCElectricUtils.power(this.getVoltageOut(), this.getAmperageLimitation()!)) /
this.powerDivider;
}
const connectorMaximumPower = this.getMaximumPower() / this.powerDivider;
const connectorChargingProfilesPowerLimit =
- ChargingStationUtils.getChargingStationConnectorChargingProfilesPowerLimit(this, connectorId);
- return Math.min(
+ getChargingStationConnectorChargingProfilesPowerLimit(this, connectorId);
+ return min(
isNaN(connectorMaximumPower) ? Infinity : connectorMaximumPower,
- isNaN(connectorAmperageLimitationPowerLimit)
+ isNaN(connectorAmperageLimitationPowerLimit!)
? Infinity
- : connectorAmperageLimitationPowerLimit,
- isNaN(connectorChargingProfilesPowerLimit) ? Infinity : connectorChargingProfilesPowerLimit
+ : connectorAmperageLimitationPowerLimit!,
+ isNaN(connectorChargingProfilesPowerLimit!) ? Infinity : connectorChargingProfilesPowerLimit!,
);
}
public getTransactionIdTag(transactionId: number): string | undefined {
- for (const connectorId of this.connectors.keys()) {
- if (
- connectorId > 0 &&
- this.getConnectorStatus(connectorId)?.transactionId === transactionId
- ) {
- return this.getConnectorStatus(connectorId)?.transactionIdTag;
+ if (this.hasEvses) {
+ for (const evseStatus of this.evses.values()) {
+ for (const connectorStatus of evseStatus.connectors.values()) {
+ if (connectorStatus.transactionId === transactionId) {
+ return connectorStatus.transactionIdTag;
+ }
+ }
+ }
+ } else {
+ for (const connectorId of this.connectors.keys()) {
+ if (this.getConnectorStatus(connectorId)?.transactionId === transactionId) {
+ return this.getConnectorStatus(connectorId)?.transactionIdTag;
+ }
+ }
+ }
+ }
+
+ public getNumberOfRunningTransactions(): number {
+ let numberOfRunningTransactions = 0;
+ if (this.hasEvses) {
+ for (const [evseId, evseStatus] of this.evses) {
+ if (evseId === 0) {
+ continue;
+ }
+ for (const connectorStatus of evseStatus.connectors.values()) {
+ if (connectorStatus.transactionStarted === true) {
+ ++numberOfRunningTransactions;
+ }
+ }
+ }
+ } else {
+ for (const connectorId of this.connectors.keys()) {
+ if (connectorId > 0 && this.getConnectorStatus(connectorId)?.transactionStarted === true) {
+ ++numberOfRunningTransactions;
+ }
}
}
+ return numberOfRunningTransactions;
}
public getOutOfOrderEndMeterValues(): boolean {
}
public getConnectorIdByTransactionId(transactionId: number): number | undefined {
- for (const connectorId of this.connectors.keys()) {
- if (
- connectorId > 0 &&
- this.getConnectorStatus(connectorId)?.transactionId === transactionId
- ) {
- return connectorId;
+ if (this.hasEvses) {
+ for (const evseStatus of this.evses.values()) {
+ for (const [connectorId, connectorStatus] of evseStatus.connectors) {
+ if (connectorStatus.transactionId === transactionId) {
+ return connectorId;
+ }
+ }
+ }
+ } else {
+ for (const connectorId of this.connectors.keys()) {
+ if (this.getConnectorStatus(connectorId)?.transactionId === transactionId) {
+ return connectorId;
+ }
}
}
}
public getEnergyActiveImportRegisterByTransactionId(
transactionId: number,
- rounded = false
+ rounded = false,
): number {
return this.getEnergyActiveImportRegister(
- this.getConnectorStatus(this.getConnectorIdByTransactionId(transactionId)),
- rounded
+ this.getConnectorStatus(this.getConnectorIdByTransactionId(transactionId)!)!,
+ rounded,
);
}
public getEnergyActiveImportRegisterByConnectorId(connectorId: number, rounded = false): number {
- return this.getEnergyActiveImportRegister(this.getConnectorStatus(connectorId), rounded);
+ return this.getEnergyActiveImportRegister(this.getConnectorStatus(connectorId)!, rounded);
}
public getAuthorizeRemoteTxRequests(): boolean {
- const authorizeRemoteTxRequests = ChargingStationConfigurationUtils.getConfigurationKey(
+ const authorizeRemoteTxRequests = getConfigurationKey(
this,
- StandardParametersKey.AuthorizeRemoteTxRequests
+ StandardParametersKey.AuthorizeRemoteTxRequests,
);
- return authorizeRemoteTxRequests
- ? Utils.convertToBoolean(authorizeRemoteTxRequests.value)
- : false;
+ return authorizeRemoteTxRequests ? convertToBoolean(authorizeRemoteTxRequests.value) : false;
}
public getLocalAuthListEnabled(): boolean {
- const localAuthListEnabled = ChargingStationConfigurationUtils.getConfigurationKey(
+ const localAuthListEnabled = getConfigurationKey(
this,
- StandardParametersKey.LocalAuthListEnabled
+ StandardParametersKey.LocalAuthListEnabled,
);
- return localAuthListEnabled ? Utils.convertToBoolean(localAuthListEnabled.value) : false;
+ return localAuthListEnabled ? convertToBoolean(localAuthListEnabled.value) : false;
}
- public startHeartbeat(): void {
+ public getHeartbeatInterval(): number {
+ const HeartbeatInterval = getConfigurationKey(this, StandardParametersKey.HeartbeatInterval);
+ if (HeartbeatInterval) {
+ return secondsToMilliseconds(convertToInt(HeartbeatInterval.value));
+ }
+ const HeartBeatInterval = getConfigurationKey(this, StandardParametersKey.HeartBeatInterval);
+ if (HeartBeatInterval) {
+ return secondsToMilliseconds(convertToInt(HeartBeatInterval.value));
+ }
+ this.stationInfo?.autoRegister === false &&
+ logger.warn(
+ `${this.logPrefix()} Heartbeat interval configuration key not set, using default value: ${
+ Constants.DEFAULT_HEARTBEAT_INTERVAL
+ }`,
+ );
+ return Constants.DEFAULT_HEARTBEAT_INTERVAL;
+ }
+
+ public setSupervisionUrl(url: string): void {
if (
- this.getHeartbeatInterval() &&
- this.getHeartbeatInterval() > 0 &&
- !this.heartbeatSetInterval
+ this.getSupervisionUrlOcppConfiguration() &&
+ isNotEmptyString(this.getSupervisionUrlOcppKey())
) {
+ setConfigurationKeyValue(this, this.getSupervisionUrlOcppKey(), url);
+ } else {
+ this.stationInfo.supervisionUrls = url;
+ this.saveStationInfo();
+ this.configuredSupervisionUrl = this.getConfiguredSupervisionUrl();
+ }
+ }
+
+ public startHeartbeat(): void {
+ if (this.getHeartbeatInterval() > 0 && !this.heartbeatSetInterval) {
this.heartbeatSetInterval = setInterval(() => {
this.ocppRequestService
.requestHandler<HeartbeatRequest, HeartbeatResponse>(this, RequestCommand.HEARTBEAT)
.catch((error) => {
logger.error(
`${this.logPrefix()} Error while sending '${RequestCommand.HEARTBEAT}':`,
- error
+ error,
);
});
}, this.getHeartbeatInterval());
logger.info(
- `${this.logPrefix()} Heartbeat started every ${Utils.formatDurationMilliSeconds(
- this.getHeartbeatInterval()
- )}`
+ `${this.logPrefix()} Heartbeat started every ${formatDurationMilliSeconds(
+ this.getHeartbeatInterval(),
+ )}`,
);
} else if (this.heartbeatSetInterval) {
logger.info(
- `${this.logPrefix()} Heartbeat already started every ${Utils.formatDurationMilliSeconds(
- this.getHeartbeatInterval()
- )}`
+ `${this.logPrefix()} Heartbeat already started every ${formatDurationMilliSeconds(
+ this.getHeartbeatInterval(),
+ )}`,
);
} else {
logger.error(
- `${this.logPrefix()} Heartbeat interval set to ${
- this.getHeartbeatInterval()
- ? Utils.formatDurationMilliSeconds(this.getHeartbeatInterval())
- : this.getHeartbeatInterval()
- }, not starting the heartbeat`
+ `${this.logPrefix()} Heartbeat interval set to ${this.getHeartbeatInterval()}, not starting the heartbeat`,
);
}
}
public startMeterValues(connectorId: number, interval: number): void {
if (connectorId === 0) {
logger.error(
- `${this.logPrefix()} Trying to start MeterValues on connector Id ${connectorId.toString()}`
+ `${this.logPrefix()} Trying to start MeterValues on connector id ${connectorId}`,
);
return;
}
if (!this.getConnectorStatus(connectorId)) {
logger.error(
- `${this.logPrefix()} Trying to start MeterValues on non existing connector Id ${connectorId.toString()}`
+ `${this.logPrefix()} Trying to start MeterValues on non existing connector id
+ ${connectorId}`,
);
return;
}
if (this.getConnectorStatus(connectorId)?.transactionStarted === false) {
logger.error(
- `${this.logPrefix()} Trying to start MeterValues on connector Id ${connectorId} with no transaction started`
+ `${this.logPrefix()} Trying to start MeterValues on connector id ${connectorId} with no transaction started`,
);
return;
} else if (
this.getConnectorStatus(connectorId)?.transactionStarted === true &&
- Utils.isNullOrUndefined(this.getConnectorStatus(connectorId)?.transactionId)
+ isNullOrUndefined(this.getConnectorStatus(connectorId)?.transactionId)
) {
logger.error(
- `${this.logPrefix()} Trying to start MeterValues on connector Id ${connectorId} with no transaction id`
+ `${this.logPrefix()} Trying to start MeterValues on connector id ${connectorId} with no transaction id`,
);
return;
}
if (interval > 0) {
- this.getConnectorStatus(connectorId).transactionSetInterval = setInterval(() => {
+ this.getConnectorStatus(connectorId)!.transactionSetInterval = setInterval(() => {
// FIXME: Implement OCPP version agnostic helpers
const meterValue: MeterValue = OCPP16ServiceUtils.buildMeterValue(
this,
connectorId,
- this.getConnectorStatus(connectorId).transactionId,
- interval
+ this.getConnectorStatus(connectorId)!.transactionId!,
+ interval,
);
this.ocppRequestService
.requestHandler<MeterValuesRequest, MeterValuesResponse>(
connectorId,
transactionId: this.getConnectorStatus(connectorId)?.transactionId,
meterValue: [meterValue],
- }
+ },
)
.catch((error) => {
logger.error(
`${this.logPrefix()} Error while sending '${RequestCommand.METER_VALUES}':`,
- error
+ error,
);
});
}, interval);
logger.error(
`${this.logPrefix()} Charging station ${
StandardParametersKey.MeterValueSampleInterval
- } configuration set to ${
- interval ? Utils.formatDurationMilliSeconds(interval) : interval
- }, not sending MeterValues`
+ } configuration set to ${interval}, not sending MeterValues`,
);
}
}
+ public stopMeterValues(connectorId: number) {
+ if (this.getConnectorStatus(connectorId)?.transactionSetInterval) {
+ clearInterval(this.getConnectorStatus(connectorId)?.transactionSetInterval);
+ }
+ }
+
public start(): void {
if (this.started === false) {
if (this.starting === false) {
if (this.getEnableStatistics() === true) {
this.performanceStatistics?.start();
}
+ if (hasFeatureProfile(this, SupportedFeatureProfiles.Reservation)) {
+ this.startReservationExpirationSetInterval();
+ }
this.openWSConnection();
// Monitor charging station template file
- this.templateFileWatcher = FileUtils.watchJsonFile(
+ this.templateFileWatcher = watchJsonFile(
this.templateFile,
FileType.ChargingStationTemplate,
this.logPrefix(),
undefined,
(event, filename): void => {
- if (Utils.isNotEmptyString(filename) && event === 'change') {
+ if (isNotEmptyString(filename) && event === 'change') {
try {
logger.debug(
`${this.logPrefix()} ${FileType.ChargingStationTemplate} ${
this.templateFile
- } file have changed, reload`
+ } file have changed, reload`,
);
- this.sharedLRUCache.deleteChargingStationTemplate(this.stationInfo?.templateHash);
+ this.sharedLRUCache.deleteChargingStationTemplate(this.templateFileHash);
// Initialize
this.initialize();
+ this.idTagsCache.deleteIdTags(getIdTagsFile(this.stationInfo)!);
// Restart the ATG
this.stopAutomaticTransactionGenerator();
- if (
- this.getAutomaticTransactionGeneratorConfigurationFromTemplate()?.enable === true
- ) {
+ delete this.automaticTransactionGeneratorConfiguration;
+ if (this.getAutomaticTransactionGeneratorConfiguration()?.enable === true) {
this.startAutomaticTransactionGenerator();
}
if (this.getEnableStatistics() === true) {
} catch (error) {
logger.error(
`${this.logPrefix()} ${FileType.ChargingStationTemplate} file monitoring error:`,
- error
+ error,
);
}
}
- }
+ },
);
this.started = true;
- parentPort?.postMessage(MessageChannelUtils.buildStartedMessage(this));
+ parentPort?.postMessage(buildStartedMessage(this));
this.starting = false;
} else {
logger.warn(`${this.logPrefix()} Charging station is already starting...`);
if (this.getEnableStatistics() === true) {
this.performanceStatistics?.stop();
}
+ if (hasFeatureProfile(this, SupportedFeatureProfiles.Reservation)) {
+ this.stopReservationExpirationSetInterval();
+ }
this.sharedLRUCache.deleteChargingStationConfiguration(this.configurationFileHash);
this.templateFileWatcher?.close();
- this.sharedLRUCache.deleteChargingStationTemplate(this.stationInfo?.templateHash);
- this.bootNotificationResponse = undefined;
+ this.sharedLRUCache.deleteChargingStationTemplate(this.templateFileHash);
+ delete this.bootNotificationResponse;
this.started = false;
- parentPort?.postMessage(MessageChannelUtils.buildStoppedMessage(this));
+ this.saveConfiguration();
+ parentPort?.postMessage(buildStoppedMessage(this));
this.stopping = false;
} else {
logger.warn(`${this.logPrefix()} Charging station is already stopping...`);
public async reset(reason?: StopTransactionReason): Promise<void> {
await this.stop(reason);
- await Utils.sleep(this.stationInfo.resetTime);
+ await sleep(this.stationInfo.resetTime!);
this.initialize();
this.start();
}
}
}
- public resetConnectorStatus(connectorId: number): void {
- this.getConnectorStatus(connectorId).idTagLocalAuthorized = false;
- this.getConnectorStatus(connectorId).idTagAuthorized = false;
- this.getConnectorStatus(connectorId).transactionRemoteStarted = false;
- this.getConnectorStatus(connectorId).transactionStarted = false;
- delete this.getConnectorStatus(connectorId)?.localAuthorizeIdTag;
- delete this.getConnectorStatus(connectorId)?.authorizeIdTag;
- delete this.getConnectorStatus(connectorId)?.transactionId;
- delete this.getConnectorStatus(connectorId)?.transactionIdTag;
- this.getConnectorStatus(connectorId).transactionEnergyActiveImportRegisterValue = 0;
- delete this.getConnectorStatus(connectorId)?.transactionBeginMeterValue;
- this.stopMeterValues(connectorId);
- parentPort?.postMessage(MessageChannelUtils.buildUpdatedMessage(this));
- }
-
- public hasFeatureProfile(featureProfile: SupportedFeatureProfiles): boolean | undefined {
- return ChargingStationConfigurationUtils.getConfigurationKey(
- this,
- StandardParametersKey.SupportedFeatureProfiles
- )?.value?.includes(featureProfile);
- }
-
public bufferMessage(message: string): void {
this.messageBuffer.add(message);
}
public openWSConnection(
- options: WsOptions = this.stationInfo?.wsOptions ?? {},
- params: { closeOpened?: boolean; terminateOpened?: boolean } = {
- closeOpened: false,
- terminateOpened: false,
- }
+ options?: WsOptions,
+ params?: { closeOpened?: boolean; terminateOpened?: boolean },
): void {
- options.handshakeTimeout = options?.handshakeTimeout ?? this.getConnectionTimeout() * 1000;
- params.closeOpened = params?.closeOpened ?? false;
- params.terminateOpened = params?.terminateOpened ?? false;
- if (this.started === false && this.starting === false) {
- logger.warn(
- `${this.logPrefix()} Cannot open OCPP connection to URL ${this.wsConnectionUrl.toString()} on stopped charging station`
- );
+ options = {
+ handshakeTimeout: secondsToMilliseconds(this.getConnectionTimeout()),
+ ...this.stationInfo?.wsOptions,
+ ...options,
+ };
+ params = { ...{ closeOpened: false, terminateOpened: false }, ...params };
+ if (!checkChargingStation(this, this.logPrefix())) {
return;
}
if (
- !Utils.isNullOrUndefined(this.stationInfo.supervisionUser) &&
- !Utils.isNullOrUndefined(this.stationInfo.supervisionPassword)
+ !isNullOrUndefined(this.stationInfo.supervisionUser) &&
+ !isNullOrUndefined(this.stationInfo.supervisionPassword)
) {
options.auth = `${this.stationInfo.supervisionUser}:${this.stationInfo.supervisionPassword}`;
}
if (params?.terminateOpened) {
this.terminateWSConnection();
}
- const ocppVersion = this.stationInfo.ocppVersion ?? OCPPVersion.VERSION_16;
- let protocol: string;
- switch (ocppVersion) {
- case OCPPVersion.VERSION_16:
- case OCPPVersion.VERSION_20:
- case OCPPVersion.VERSION_201:
- protocol = `ocpp${ocppVersion}`;
- break;
- default:
- this.handleUnsupportedVersion(ocppVersion);
- break;
- }
if (this.isWebSocketConnectionOpened() === true) {
logger.warn(
- `${this.logPrefix()} OCPP connection to URL ${this.wsConnectionUrl.toString()} is already opened`
+ `${this.logPrefix()} OCPP connection to URL ${this.wsConnectionUrl.toString()} is already opened`,
);
return;
}
logger.info(
- `${this.logPrefix()} Open OCPP connection to URL ${this.wsConnectionUrl.toString()}`
+ `${this.logPrefix()} Open OCPP connection to URL ${this.wsConnectionUrl.toString()}`,
);
- this.wsConnection = new WebSocket(this.wsConnectionUrl, protocol, options);
+ this.wsConnection = new WebSocket(
+ this.wsConnectionUrl,
+ `ocpp${this.stationInfo.ocppVersion ?? OCPPVersion.VERSION_16}`,
+ options,
+ );
// Handle WebSocket message
this.wsConnection.on(
'message',
- this.onMessage.bind(this) as (this: WebSocket, data: RawData, isBinary: boolean) => void
+ 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
+ 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
+ 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);
}
}
- public startAutomaticTransactionGenerator(
- connectorIds?: number[],
- automaticTransactionGeneratorConfiguration?: AutomaticTransactionGeneratorConfiguration
- ): void {
- this.automaticTransactionGenerator = AutomaticTransactionGenerator.getInstance(
- automaticTransactionGeneratorConfiguration ??
- this.getAutomaticTransactionGeneratorConfigurationFromTemplate(),
- this
- );
- if (Utils.isNotEmptyArray(connectorIds)) {
- for (const connectorId of connectorIds) {
+ public getAutomaticTransactionGeneratorConfiguration(): AutomaticTransactionGeneratorConfiguration {
+ if (isNullOrUndefined(this.automaticTransactionGeneratorConfiguration)) {
+ let automaticTransactionGeneratorConfiguration:
+ | AutomaticTransactionGeneratorConfiguration
+ | undefined;
+ const automaticTransactionGeneratorConfigurationFromFile =
+ this.getConfigurationFromFile()?.automaticTransactionGenerator;
+ if (
+ this.getAutomaticTransactionGeneratorPersistentConfiguration() &&
+ automaticTransactionGeneratorConfigurationFromFile
+ ) {
+ automaticTransactionGeneratorConfiguration =
+ automaticTransactionGeneratorConfigurationFromFile;
+ } else {
+ automaticTransactionGeneratorConfiguration =
+ this.getTemplateFromFile()?.AutomaticTransactionGenerator;
+ }
+ this.automaticTransactionGeneratorConfiguration = {
+ ...Constants.DEFAULT_ATG_CONFIGURATION,
+ ...automaticTransactionGeneratorConfiguration,
+ };
+ }
+ return this.automaticTransactionGeneratorConfiguration!;
+ }
+
+ public getAutomaticTransactionGeneratorStatuses(): Status[] | undefined {
+ return this.getConfigurationFromFile()?.automaticTransactionGeneratorStatuses;
+ }
+
+ public startAutomaticTransactionGenerator(connectorIds?: number[]): void {
+ this.automaticTransactionGenerator = AutomaticTransactionGenerator.getInstance(this);
+ if (isNotEmptyArray(connectorIds)) {
+ for (const connectorId of connectorIds!) {
this.automaticTransactionGenerator?.startConnector(connectorId);
}
} else {
this.automaticTransactionGenerator?.start();
}
- parentPort?.postMessage(MessageChannelUtils.buildUpdatedMessage(this));
+ this.saveAutomaticTransactionGeneratorConfiguration();
+ parentPort?.postMessage(buildUpdatedMessage(this));
}
public stopAutomaticTransactionGenerator(connectorIds?: number[]): void {
- if (Utils.isNotEmptyArray(connectorIds)) {
- for (const connectorId of connectorIds) {
+ if (isNotEmptyArray(connectorIds)) {
+ for (const connectorId of connectorIds!) {
this.automaticTransactionGenerator?.stopConnector(connectorId);
}
} else {
this.automaticTransactionGenerator?.stop();
}
- parentPort?.postMessage(MessageChannelUtils.buildUpdatedMessage(this));
+ this.saveAutomaticTransactionGeneratorConfiguration();
+ parentPort?.postMessage(buildUpdatedMessage(this));
}
public async stopTransactionOnConnector(
connectorId: number,
- reason = StopTransactionReason.NONE
+ reason = StopTransactionReason.NONE,
): Promise<StopTransactionResponse> {
const transactionId = this.getConnectorStatus(connectorId)?.transactionId;
if (
const transactionEndMeterValue = OCPP16ServiceUtils.buildTransactionEndMeterValue(
this,
connectorId,
- this.getEnergyActiveImportRegisterByTransactionId(transactionId)
+ this.getEnergyActiveImportRegisterByTransactionId(transactionId!),
);
await this.ocppRequestService.requestHandler<MeterValuesRequest, MeterValuesResponse>(
this,
connectorId,
transactionId,
meterValue: [transactionEndMeterValue],
- }
+ },
);
}
return this.ocppRequestService.requestHandler<StopTransactionRequest, StopTransactionResponse>(
RequestCommand.STOP_TRANSACTION,
{
transactionId,
- meterStop: this.getEnergyActiveImportRegisterByTransactionId(transactionId, true),
+ meterStop: this.getEnergyActiveImportRegisterByTransactionId(transactionId!, true),
reason,
- }
+ },
+ );
+ }
+
+ public getReserveConnectorZeroSupported(): boolean {
+ return convertToBoolean(
+ getConfigurationKey(this, StandardParametersKey.ReserveConnectorZeroSupported)!.value,
+ );
+ }
+
+ public async addReservation(reservation: Reservation): Promise<void> {
+ const reservationFound = this.getReservationBy('reservationId', reservation.reservationId);
+ if (!isUndefined(reservationFound)) {
+ await this.removeReservation(
+ reservationFound!,
+ ReservationTerminationReason.REPLACE_EXISTING,
+ );
+ }
+ this.getConnectorStatus(reservation.connectorId)!.reservation = reservation;
+ await OCPPServiceUtils.sendAndSetConnectorStatus(
+ this,
+ reservation.connectorId,
+ ConnectorStatusEnum.Reserved,
+ undefined,
+ { send: reservation.connectorId !== 0 },
);
}
+ public async removeReservation(
+ reservation: Reservation,
+ reason: ReservationTerminationReason,
+ ): Promise<void> {
+ const connector = this.getConnectorStatus(reservation.connectorId)!;
+ switch (reason) {
+ case ReservationTerminationReason.CONNECTOR_STATE_CHANGED:
+ case ReservationTerminationReason.TRANSACTION_STARTED:
+ delete connector.reservation;
+ break;
+ case ReservationTerminationReason.RESERVATION_CANCELED:
+ case ReservationTerminationReason.REPLACE_EXISTING:
+ case ReservationTerminationReason.EXPIRED:
+ await OCPPServiceUtils.sendAndSetConnectorStatus(
+ this,
+ reservation.connectorId,
+ ConnectorStatusEnum.Available,
+ undefined,
+ { send: reservation.connectorId !== 0 },
+ );
+ delete connector.reservation;
+ break;
+ default:
+ // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
+ throw new BaseError(`Unknown reservation termination reason '${reason}'`);
+ }
+ }
+
+ public getReservationBy(
+ filterKey: ReservationKey,
+ value: number | string,
+ ): Reservation | undefined {
+ if (this.hasEvses) {
+ for (const evseStatus of this.evses.values()) {
+ for (const connectorStatus of evseStatus.connectors.values()) {
+ if (connectorStatus?.reservation?.[filterKey] === value) {
+ return connectorStatus.reservation;
+ }
+ }
+ }
+ } else {
+ for (const connectorStatus of this.connectors.values()) {
+ if (connectorStatus?.reservation?.[filterKey] === value) {
+ return connectorStatus.reservation;
+ }
+ }
+ }
+ }
+
+ public isConnectorReservable(
+ reservationId: number,
+ idTag?: string,
+ connectorId?: number,
+ ): boolean {
+ const reservation = this.getReservationBy('reservationId', reservationId);
+ const reservationExists = !isUndefined(reservation) && !hasReservationExpired(reservation!);
+ if (arguments.length === 1) {
+ return !reservationExists;
+ } else if (arguments.length > 1) {
+ const userReservation = !isUndefined(idTag)
+ ? this.getReservationBy('idTag', idTag!)
+ : undefined;
+ const userReservationExists =
+ !isUndefined(userReservation) && !hasReservationExpired(userReservation!);
+ const notConnectorZero = isUndefined(connectorId) ? true : connectorId! > 0;
+ const freeConnectorsAvailable = this.getNumberOfReservableConnectors() > 0;
+ return (
+ !reservationExists && !userReservationExists && notConnectorZero && freeConnectorsAvailable
+ );
+ }
+ return false;
+ }
+
+ private startReservationExpirationSetInterval(customInterval?: number): void {
+ const interval = customInterval ?? Constants.DEFAULT_RESERVATION_EXPIRATION_INTERVAL;
+ if (interval > 0) {
+ logger.info(
+ `${this.logPrefix()} Reservation expiration date checks started every ${formatDurationMilliSeconds(
+ interval,
+ )}`,
+ );
+ this.reservationExpirationSetInterval = setInterval((): void => {
+ removeExpiredReservations(this).catch(Constants.EMPTY_FUNCTION);
+ }, interval);
+ }
+ }
+
+ private stopReservationExpirationSetInterval(): void {
+ if (!isNullOrUndefined(this.reservationExpirationSetInterval)) {
+ clearInterval(this.reservationExpirationSetInterval);
+ }
+ }
+
+ // private restartReservationExpiryDateSetInterval(): void {
+ // this.stopReservationExpirationSetInterval();
+ // this.startReservationExpirationSetInterval();
+ // }
+
+ private getNumberOfReservableConnectors(): number {
+ let numberOfReservableConnectors = 0;
+ if (this.hasEvses) {
+ for (const evseStatus of this.evses.values()) {
+ numberOfReservableConnectors += getNumberOfReservableConnectors(evseStatus.connectors);
+ }
+ } else {
+ numberOfReservableConnectors = getNumberOfReservableConnectors(this.connectors);
+ }
+ return numberOfReservableConnectors - this.getNumberOfReservationsOnConnectorZero();
+ }
+
+ private getNumberOfReservationsOnConnectorZero(): number {
+ if (
+ // eslint-disable-next-line @typescript-eslint/prefer-nullish-coalescing
+ (this.hasEvses && this.evses.get(0)?.connectors.get(0)?.reservation) ||
+ (!this.hasEvses && this.connectors.get(0)?.reservation)
+ ) {
+ return 1;
+ }
+ return 0;
+ }
+
private flushMessageBuffer(): void {
if (this.messageBuffer.size > 0) {
- this.messageBuffer.forEach((message) => {
- let beginId: string;
- let commandName: RequestCommand;
+ for (const message of this.messageBuffer.values()) {
+ let beginId: string | undefined;
+ let commandName: RequestCommand | undefined;
const [messageType] = JSON.parse(message) as OutgoingRequest | Response | ErrorResponse;
const isRequest = messageType === MessageType.CALL_MESSAGE;
if (isRequest) {
beginId = PerformanceStatistics.beginMeasure(commandName);
}
this.wsConnection?.send(message);
- isRequest && PerformanceStatistics.endMeasure(commandName, beginId);
+ isRequest && PerformanceStatistics.endMeasure(commandName!, beginId!);
logger.debug(
`${this.logPrefix()} >> Buffered ${OCPPServiceUtils.getMessageTypeString(
- messageType
- )} payload sent: ${message}`
+ messageType,
+ )} payload sent: ${message}`,
);
this.messageBuffer.delete(message);
- });
+ }
}
}
}
private getSupervisionUrlOcppKey(): string {
- return this.stationInfo.supervisionUrlOcppKey ?? VendorDefaultParametersKey.ConnectionUrl;
+ return this.stationInfo.supervisionUrlOcppKey ?? VendorParametersKey.ConnectionUrl;
}
private getTemplateFromFile(): ChargingStationTemplate | undefined {
- let template: ChargingStationTemplate;
+ let template: ChargingStationTemplate | undefined;
try {
- if (this.sharedLRUCache.hasChargingStationTemplate(this.stationInfo?.templateHash)) {
- template = this.sharedLRUCache.getChargingStationTemplate(this.stationInfo.templateHash);
+ if (this.sharedLRUCache.hasChargingStationTemplate(this.templateFileHash)) {
+ template = this.sharedLRUCache.getChargingStationTemplate(this.templateFileHash);
} else {
const measureId = `${FileType.ChargingStationTemplate} read`;
const beginId = PerformanceStatistics.beginMeasure(measureId);
- template = JSON.parse(
- fs.readFileSync(this.templateFile, 'utf8')
- ) as ChargingStationTemplate;
+ template = JSON.parse(readFileSync(this.templateFile, 'utf8')) as ChargingStationTemplate;
PerformanceStatistics.endMeasure(measureId, beginId);
- template.templateHash = crypto
- .createHash(Constants.DEFAULT_HASH_ALGORITHM)
+ template.templateHash = createHash(Constants.DEFAULT_HASH_ALGORITHM)
.update(JSON.stringify(template))
.digest('hex');
this.sharedLRUCache.setChargingStationTemplate(template);
+ this.templateFileHash = template.templateHash;
}
} catch (error) {
- FileUtils.handleFileException(
+ handleFileException(
this.templateFile,
FileType.ChargingStationTemplate,
error as NodeJS.ErrnoException,
- this.logPrefix()
+ this.logPrefix(),
);
}
return template;
}
private getStationInfoFromTemplate(): ChargingStationInfo {
- const stationTemplate: ChargingStationTemplate | undefined = this.getTemplateFromFile();
- if (Utils.isNullOrUndefined(stationTemplate)) {
- const errorMsg = `Failed to read charging station template file ${this.templateFile}`;
- logger.error(`${this.logPrefix()} ${errorMsg}`);
- throw new BaseError(errorMsg);
- }
- if (Utils.isEmptyObject(stationTemplate)) {
- const errorMsg = `Empty charging station information from template file ${this.templateFile}`;
- logger.error(`${this.logPrefix()} ${errorMsg}`);
- throw new BaseError(errorMsg);
- }
- // Deprecation template keys section
- ChargingStationUtils.warnDeprecatedTemplateKey(
- stationTemplate,
- 'supervisionUrl',
- this.templateFile,
- this.logPrefix(),
- "Use 'supervisionUrls' instead"
- );
- ChargingStationUtils.convertDeprecatedTemplateKey(
- stationTemplate,
- 'supervisionUrl',
- 'supervisionUrls'
- );
- const stationInfo: ChargingStationInfo =
- ChargingStationUtils.stationTemplateToStationInfo(stationTemplate);
- stationInfo.hashId = ChargingStationUtils.getHashId(this.index, stationTemplate);
- stationInfo.chargingStationId = ChargingStationUtils.getChargingStationId(
- this.index,
- stationTemplate
- );
+ const stationTemplate: ChargingStationTemplate = this.getTemplateFromFile()!;
+ checkTemplate(stationTemplate, this.logPrefix(), this.templateFile);
+ const warnTemplateKeysDeprecationOnce = once(warnTemplateKeysDeprecation, this);
+ warnTemplateKeysDeprecationOnce(stationTemplate, this.logPrefix(), this.templateFile);
+ if (stationTemplate?.Connectors) {
+ checkConnectorsConfiguration(stationTemplate, this.logPrefix(), this.templateFile);
+ }
+ const stationInfo: ChargingStationInfo = stationTemplateToStationInfo(stationTemplate);
+ stationInfo.hashId = getHashId(this.index, stationTemplate);
+ stationInfo.chargingStationId = getChargingStationId(this.index, stationTemplate);
stationInfo.ocppVersion = stationTemplate?.ocppVersion ?? OCPPVersion.VERSION_16;
- ChargingStationUtils.createSerialNumber(stationTemplate, stationInfo);
- if (Utils.isNotEmptyArray(stationTemplate?.power)) {
+ createSerialNumber(stationTemplate, stationInfo);
+ if (isNotEmptyArray(stationTemplate?.power)) {
stationTemplate.power = stationTemplate.power as number[];
- const powerArrayRandomIndex = Math.floor(Utils.secureRandom() * stationTemplate.power.length);
+ const powerArrayRandomIndex = Math.floor(secureRandom() * stationTemplate.power.length);
stationInfo.maximumPower =
stationTemplate?.powerUnit === PowerUnits.KILO_WATT
? stationTemplate.power[powerArrayRandomIndex] * 1000
stationInfo.firmwareVersionPattern =
stationTemplate?.firmwareVersionPattern ?? Constants.SEMVER_PATTERN;
if (
- Utils.isNotEmptyString(stationInfo.firmwareVersion) &&
- new RegExp(stationInfo.firmwareVersionPattern).test(stationInfo.firmwareVersion) === false
+ isNotEmptyString(stationInfo.firmwareVersion) &&
+ new RegExp(stationInfo.firmwareVersionPattern).test(stationInfo.firmwareVersion!) === false
) {
logger.warn(
`${this.logPrefix()} Firmware version '${stationInfo.firmwareVersion}' in template file ${
this.templateFile
- } does not match firmware version pattern '${stationInfo.firmwareVersionPattern}'`
+ } does not match firmware version pattern '${stationInfo.firmwareVersionPattern}'`,
);
}
stationInfo.firmwareUpgrade = merge<FirmwareUpgrade>(
},
reset: true,
},
- stationTemplate?.firmwareUpgrade ?? {}
+ stationTemplate?.firmwareUpgrade ?? {},
);
- stationInfo.resetTime = !Utils.isNullOrUndefined(stationTemplate?.resetTime)
- ? stationTemplate.resetTime * 1000
+ stationInfo.resetTime = !isNullOrUndefined(stationTemplate?.resetTime)
+ ? secondsToMilliseconds(stationTemplate.resetTime!)
: Constants.CHARGING_STATION_DEFAULT_RESET_TIME;
- const configuredMaxConnectors =
- ChargingStationUtils.getConfiguredNumberOfConnectors(stationTemplate);
- ChargingStationUtils.checkConfiguredMaxConnectors(
- configuredMaxConnectors,
- this.templateFile,
- this.logPrefix()
- );
- const templateMaxConnectors =
- ChargingStationUtils.getTemplateMaxNumberOfConnectors(stationTemplate);
- ChargingStationUtils.checkTemplateMaxConnectors(
- templateMaxConnectors,
- this.templateFile,
- this.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 | undefined {
let stationInfo: ChargingStationInfo | undefined;
- this.getStationInfoPersistentConfiguration() &&
- (stationInfo = this.getConfigurationFromFile()?.stationInfo);
- stationInfo && ChargingStationUtils.createStationInfoHash(stationInfo);
+ if (this.getStationInfoPersistentConfiguration()) {
+ stationInfo = this.getConfigurationFromFile()?.stationInfo;
+ if (stationInfo) {
+ delete stationInfo?.infoHash;
+ }
+ }
return stationInfo;
}
private getStationInfo(): ChargingStationInfo {
const stationInfoFromTemplate: ChargingStationInfo = this.getStationInfoFromTemplate();
const stationInfoFromFile: ChargingStationInfo | undefined = this.getStationInfoFromFile();
- // Priority: charging station info from template > charging station info from configuration file > charging station info attribute
+ // Priority:
+ // 1. charging station info from template
+ // 2. charging station info from configuration file
if (stationInfoFromFile?.templateHash === stationInfoFromTemplate.templateHash) {
- if (this.stationInfo?.infoHash === stationInfoFromFile?.infoHash) {
- return this.stationInfo;
- }
- return stationInfoFromFile;
+ return stationInfoFromFile!;
}
stationInfoFromFile &&
- ChargingStationUtils.propagateSerialNumber(
- this.getTemplateFromFile(),
+ propagateSerialNumber(
+ this.getTemplateFromFile()!,
stationInfoFromFile,
- stationInfoFromTemplate
+ stationInfoFromTemplate,
);
return stationInfoFromTemplate;
}
return this.stationInfo?.stationInfoPersistentConfiguration ?? true;
}
+ private getAutomaticTransactionGeneratorPersistentConfiguration(): boolean {
+ return this.stationInfo?.automaticTransactionGeneratorPersistentConfiguration ?? true;
+ }
+
private handleUnsupportedVersion(version: OCPPVersion) {
- const errMsg = `Unsupported protocol version '${version}' configured in template file ${this.templateFile}`;
- logger.error(`${this.logPrefix()} ${errMsg}`);
- throw new BaseError(errMsg);
+ const errorMsg = `Unsupported protocol version '${version}' configured in template file ${this.templateFile}`;
+ logger.error(`${this.logPrefix()} ${errorMsg}`);
+ throw new BaseError(errorMsg);
}
private initialize(): void {
- this.configurationFile = path.join(
- path.dirname(this.templateFile.replace('station-templates', 'configurations')),
- `${ChargingStationUtils.getHashId(this.index, this.getTemplateFromFile())}.json`
+ const stationTemplate = this.getTemplateFromFile()!;
+ checkTemplate(stationTemplate, this.logPrefix(), this.templateFile);
+ this.configurationFile = join(
+ dirname(this.templateFile.replace('station-templates', 'configurations')),
+ `${getHashId(this.index, stationTemplate)}.json`,
);
+ const chargingStationConfiguration = this.getConfigurationFromFile();
+ if (
+ chargingStationConfiguration?.stationInfo?.templateHash === stationTemplate?.templateHash &&
+ // eslint-disable-next-line @typescript-eslint/prefer-nullish-coalescing
+ (chargingStationConfiguration?.connectorsStatus || chargingStationConfiguration?.evsesStatus)
+ ) {
+ this.initializeConnectorsOrEvsesFromFile(chargingStationConfiguration);
+ } else {
+ this.initializeConnectorsOrEvsesFromTemplate(stationTemplate);
+ }
this.stationInfo = this.getStationInfo();
+ if (
+ this.stationInfo.firmwareStatus === FirmwareStatus.Installing &&
+ isNotEmptyString(this.stationInfo.firmwareVersion) &&
+ isNotEmptyString(this.stationInfo.firmwareVersionPattern)
+ ) {
+ const patternGroup: number | undefined =
+ this.stationInfo.firmwareUpgrade?.versionUpgrade?.patternGroup ??
+ this.stationInfo.firmwareVersion?.split('.').length;
+ const match = this.stationInfo
+ .firmwareVersion!.match(new RegExp(this.stationInfo.firmwareVersionPattern!))!
+ .slice(1, patternGroup! + 1);
+ const patchLevelIndex = match.length - 1;
+ match[patchLevelIndex] = (
+ convertToInt(match[patchLevelIndex]) +
+ this.stationInfo.firmwareUpgrade!.versionUpgrade!.step!
+ ).toString();
+ this.stationInfo.firmwareVersion = match?.join('.');
+ }
this.saveStationInfo();
- // Avoid duplication of connectors related information in RAM
- this.stationInfo?.Connectors && delete this.stationInfo.Connectors;
this.configuredSupervisionUrl = this.getConfiguredSupervisionUrl();
if (this.getEnableStatistics() === true) {
this.performanceStatistics = PerformanceStatistics.getInstance(
this.stationInfo.hashId,
- this.stationInfo.chargingStationId,
- this.configuredSupervisionUrl
+ this.stationInfo.chargingStationId!,
+ this.configuredSupervisionUrl,
);
}
- this.bootNotificationRequest = ChargingStationUtils.createBootNotificationRequest(
- this.stationInfo
- );
+ this.bootNotificationRequest = createBootNotificationRequest(this.stationInfo);
this.powerDivider = this.getPowerDivider();
// OCPP configuration
this.ocppConfiguration = this.getOcppConfiguration();
this.initializeOcppConfiguration();
+ this.initializeOcppServices();
+ if (this.stationInfo?.autoRegister === true) {
+ this.bootNotificationResponse = {
+ currentTime: new Date(),
+ interval: millisecondsToSeconds(this.getHeartbeatInterval()),
+ status: RegistrationStatusEnumType.ACCEPTED,
+ };
+ }
+ }
+
+ private initializeOcppServices(): void {
const ocppVersion = this.stationInfo.ocppVersion ?? OCPPVersion.VERSION_16;
switch (ocppVersion) {
case OCPPVersion.VERSION_16:
this.ocppIncomingRequestService =
OCPP16IncomingRequestService.getInstance<OCPP16IncomingRequestService>();
this.ocppRequestService = OCPP16RequestService.getInstance<OCPP16RequestService>(
- OCPP16ResponseService.getInstance<OCPP16ResponseService>()
+ OCPP16ResponseService.getInstance<OCPP16ResponseService>(),
);
break;
case OCPPVersion.VERSION_20:
this.ocppIncomingRequestService =
OCPP20IncomingRequestService.getInstance<OCPP20IncomingRequestService>();
this.ocppRequestService = OCPP20RequestService.getInstance<OCPP20RequestService>(
- OCPP20ResponseService.getInstance<OCPP20ResponseService>()
+ OCPP20ResponseService.getInstance<OCPP20ResponseService>(),
);
break;
default:
this.handleUnsupportedVersion(ocppVersion);
break;
}
- if (this.stationInfo?.autoRegister === true) {
- this.bootNotificationResponse = {
- currentTime: new Date(),
- interval: this.getHeartbeatInterval() / 1000,
- status: RegistrationStatusEnumType.ACCEPTED,
- };
- }
- if (
- this.stationInfo.firmwareStatus === FirmwareStatus.Installing &&
- Utils.isNotEmptyString(this.stationInfo.firmwareVersion) &&
- Utils.isNotEmptyString(this.stationInfo.firmwareVersionPattern)
- ) {
- const patternGroup: number | undefined =
- this.stationInfo.firmwareUpgrade?.versionUpgrade?.patternGroup ??
- this.stationInfo.firmwareVersion?.split('.').length;
- const match = this.stationInfo?.firmwareVersion
- ?.match(new RegExp(this.stationInfo.firmwareVersionPattern))
- ?.slice(1, patternGroup + 1);
- const patchLevelIndex = match.length - 1;
- match[patchLevelIndex] = (
- Utils.convertToInt(match[patchLevelIndex]) +
- this.stationInfo.firmwareUpgrade?.versionUpgrade?.step
- ).toString();
- this.stationInfo.firmwareVersion = match?.join('.');
- }
}
private initializeOcppConfiguration(): void {
- if (
- !ChargingStationConfigurationUtils.getConfigurationKey(
- this,
- StandardParametersKey.HeartbeatInterval
- )
- ) {
- ChargingStationConfigurationUtils.addConfigurationKey(
- this,
- StandardParametersKey.HeartbeatInterval,
- '0'
- );
+ if (!getConfigurationKey(this, StandardParametersKey.HeartbeatInterval)) {
+ addConfigurationKey(this, StandardParametersKey.HeartbeatInterval, '0');
}
- if (
- !ChargingStationConfigurationUtils.getConfigurationKey(
- this,
- StandardParametersKey.HeartBeatInterval
- )
- ) {
- ChargingStationConfigurationUtils.addConfigurationKey(
- this,
- StandardParametersKey.HeartBeatInterval,
- '0',
- { visible: false }
- );
+ if (!getConfigurationKey(this, StandardParametersKey.HeartBeatInterval)) {
+ addConfigurationKey(this, StandardParametersKey.HeartBeatInterval, '0', { visible: false });
}
if (
this.getSupervisionUrlOcppConfiguration() &&
- !ChargingStationConfigurationUtils.getConfigurationKey(this, this.getSupervisionUrlOcppKey())
+ isNotEmptyString(this.getSupervisionUrlOcppKey()) &&
+ !getConfigurationKey(this, this.getSupervisionUrlOcppKey())
) {
- ChargingStationConfigurationUtils.addConfigurationKey(
+ addConfigurationKey(
this,
this.getSupervisionUrlOcppKey(),
this.configuredSupervisionUrl.href,
- { reboot: true }
+ { reboot: true },
);
} else if (
!this.getSupervisionUrlOcppConfiguration() &&
- ChargingStationConfigurationUtils.getConfigurationKey(this, this.getSupervisionUrlOcppKey())
+ isNotEmptyString(this.getSupervisionUrlOcppKey()) &&
+ getConfigurationKey(this, this.getSupervisionUrlOcppKey())
) {
- ChargingStationConfigurationUtils.deleteConfigurationKey(
- this,
- this.getSupervisionUrlOcppKey(),
- { save: false }
- );
+ deleteConfigurationKey(this, this.getSupervisionUrlOcppKey(), { save: false });
}
if (
- Utils.isNotEmptyString(this.stationInfo?.amperageLimitationOcppKey) &&
- !ChargingStationConfigurationUtils.getConfigurationKey(
- this,
- this.stationInfo.amperageLimitationOcppKey
- )
+ isNotEmptyString(this.stationInfo?.amperageLimitationOcppKey) &&
+ !getConfigurationKey(this, this.stationInfo.amperageLimitationOcppKey!)
) {
- ChargingStationConfigurationUtils.addConfigurationKey(
+ addConfigurationKey(
this,
- this.stationInfo.amperageLimitationOcppKey,
+ this.stationInfo.amperageLimitationOcppKey!,
(
- this.stationInfo.maximumAmperage *
- ChargingStationUtils.getAmperageLimitationUnitDivider(this.stationInfo)
- ).toString()
+ this.stationInfo.maximumAmperage! * getAmperageLimitationUnitDivider(this.stationInfo)
+ ).toString(),
);
}
- if (
- !ChargingStationConfigurationUtils.getConfigurationKey(
- this,
- StandardParametersKey.SupportedFeatureProfiles
- )
- ) {
- ChargingStationConfigurationUtils.addConfigurationKey(
+ if (!getConfigurationKey(this, StandardParametersKey.SupportedFeatureProfiles)) {
+ addConfigurationKey(
this,
StandardParametersKey.SupportedFeatureProfiles,
- `${SupportedFeatureProfiles.Core},${SupportedFeatureProfiles.FirmwareManagement},${SupportedFeatureProfiles.LocalAuthListManagement},${SupportedFeatureProfiles.SmartCharging},${SupportedFeatureProfiles.RemoteTrigger}`
+ `${SupportedFeatureProfiles.Core},${SupportedFeatureProfiles.FirmwareManagement},${SupportedFeatureProfiles.LocalAuthListManagement},${SupportedFeatureProfiles.SmartCharging},${SupportedFeatureProfiles.RemoteTrigger}`,
);
}
- ChargingStationConfigurationUtils.addConfigurationKey(
+ addConfigurationKey(
this,
StandardParametersKey.NumberOfConnectors,
this.getNumberOfConnectors().toString(),
{ readonly: true },
- { overwrite: true }
+ { overwrite: true },
);
- if (
- !ChargingStationConfigurationUtils.getConfigurationKey(
- this,
- StandardParametersKey.MeterValuesSampledData
- )
- ) {
- ChargingStationConfigurationUtils.addConfigurationKey(
+ if (!getConfigurationKey(this, StandardParametersKey.MeterValuesSampledData)) {
+ addConfigurationKey(
this,
StandardParametersKey.MeterValuesSampledData,
- MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER
+ MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER,
);
}
- if (
- !ChargingStationConfigurationUtils.getConfigurationKey(
- this,
- StandardParametersKey.ConnectorPhaseRotation
- )
- ) {
- const connectorPhaseRotation = [];
- for (const connectorId of this.connectors.keys()) {
- // AC/DC
- if (connectorId === 0 && this.getNumberOfPhases() === 0) {
- connectorPhaseRotation.push(`${connectorId}.${ConnectorPhaseRotation.RST}`);
- } else if (connectorId > 0 && this.getNumberOfPhases() === 0) {
- connectorPhaseRotation.push(`${connectorId}.${ConnectorPhaseRotation.NotApplicable}`);
- // AC
- } else if (connectorId > 0 && this.getNumberOfPhases() === 1) {
- connectorPhaseRotation.push(`${connectorId}.${ConnectorPhaseRotation.NotApplicable}`);
- } else if (connectorId > 0 && this.getNumberOfPhases() === 3) {
- connectorPhaseRotation.push(`${connectorId}.${ConnectorPhaseRotation.RST}`);
+ if (!getConfigurationKey(this, StandardParametersKey.ConnectorPhaseRotation)) {
+ const connectorsPhaseRotation: string[] = [];
+ if (this.hasEvses) {
+ for (const evseStatus of this.evses.values()) {
+ for (const connectorId of evseStatus.connectors.keys()) {
+ connectorsPhaseRotation.push(
+ getPhaseRotationValue(connectorId, this.getNumberOfPhases())!,
+ );
+ }
+ }
+ } else {
+ for (const connectorId of this.connectors.keys()) {
+ connectorsPhaseRotation.push(
+ getPhaseRotationValue(connectorId, this.getNumberOfPhases())!,
+ );
}
}
- ChargingStationConfigurationUtils.addConfigurationKey(
+ addConfigurationKey(
this,
StandardParametersKey.ConnectorPhaseRotation,
- connectorPhaseRotation.toString()
+ connectorsPhaseRotation.toString(),
);
}
- if (
- !ChargingStationConfigurationUtils.getConfigurationKey(
- this,
- StandardParametersKey.AuthorizeRemoteTxRequests
- )
- ) {
- 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 (!getConfigurationKey(this, StandardParametersKey.AuthorizeRemoteTxRequests)) {
+ addConfigurationKey(this, StandardParametersKey.AuthorizeRemoteTxRequests, 'true');
}
if (
- !ChargingStationConfigurationUtils.getConfigurationKey(
- this,
- StandardParametersKey.ConnectionTimeOut
+ !getConfigurationKey(this, StandardParametersKey.LocalAuthListEnabled) &&
+ getConfigurationKey(this, StandardParametersKey.SupportedFeatureProfiles)?.value?.includes(
+ SupportedFeatureProfiles.LocalAuthListManagement,
)
) {
- ChargingStationConfigurationUtils.addConfigurationKey(
+ addConfigurationKey(this, StandardParametersKey.LocalAuthListEnabled, 'false');
+ }
+ if (!getConfigurationKey(this, StandardParametersKey.ConnectionTimeOut)) {
+ addConfigurationKey(
this,
StandardParametersKey.ConnectionTimeOut,
- Constants.DEFAULT_CONNECTION_TIMEOUT.toString()
+ 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 = `No already defined connectors and charging station information from template ${this.templateFile} with no connectors configuration defined`;
- logger.error(`${this.logPrefix()} ${logMsg}`);
- throw new BaseError(logMsg);
+ private initializeConnectorsOrEvsesFromFile(configuration: ChargingStationConfiguration): void {
+ if (configuration?.connectorsStatus && !configuration?.evsesStatus) {
+ for (const [connectorId, connectorStatus] of configuration.connectorsStatus.entries()) {
+ this.connectors.set(connectorId, cloneObject<ConnectorStatus>(connectorStatus));
+ }
+ } else if (configuration?.evsesStatus && !configuration?.connectorsStatus) {
+ for (const [evseId, evseStatusConfiguration] of configuration.evsesStatus.entries()) {
+ const evseStatus = cloneObject<EvseStatusConfiguration>(evseStatusConfiguration);
+ delete evseStatus.connectorsStatus;
+ this.evses.set(evseId, {
+ ...(evseStatus as EvseStatus),
+ connectors: new Map<number, ConnectorStatus>(
+ evseStatusConfiguration.connectorsStatus!.map((connectorStatus, connectorId) => [
+ connectorId,
+ connectorStatus,
+ ]),
+ ),
+ });
+ }
+ } else if (configuration?.evsesStatus && configuration?.connectorsStatus) {
+ const errorMsg = `Connectors and evses defined at the same time in configuration file ${this.configurationFile}`;
+ logger.error(`${this.logPrefix()} ${errorMsg}`);
+ throw new BaseError(errorMsg);
+ } else {
+ const errorMsg = `No connectors or evses defined in configuration file ${this.configurationFile}`;
+ logger.error(`${this.logPrefix()} ${errorMsg}`);
+ throw new BaseError(errorMsg);
+ }
+ }
+
+ private initializeConnectorsOrEvsesFromTemplate(stationTemplate: ChargingStationTemplate) {
+ if (stationTemplate?.Connectors && !stationTemplate?.Evses) {
+ this.initializeConnectorsFromTemplate(stationTemplate);
+ } else if (stationTemplate?.Evses && !stationTemplate?.Connectors) {
+ this.initializeEvsesFromTemplate(stationTemplate);
+ } else if (stationTemplate?.Evses && stationTemplate?.Connectors) {
+ const errorMsg = `Connectors and evses defined at the same time in template file ${this.templateFile}`;
+ logger.error(`${this.logPrefix()} ${errorMsg}`);
+ throw new BaseError(errorMsg);
+ } else {
+ const errorMsg = `No connectors or evses defined in template file ${this.templateFile}`;
+ logger.error(`${this.logPrefix()} ${errorMsg}`);
+ throw new BaseError(errorMsg);
+ }
+ }
+
+ private initializeConnectorsFromTemplate(stationTemplate: ChargingStationTemplate): void {
+ if (!stationTemplate?.Connectors && this.connectors.size === 0) {
+ const errorMsg = `No already defined connectors and charging station information from template ${this.templateFile} with no connectors configuration defined`;
+ logger.error(`${this.logPrefix()} ${errorMsg}`);
+ throw new BaseError(errorMsg);
}
- if (!stationInfo?.Connectors[0]) {
+ if (!stationTemplate?.Connectors?.[0]) {
logger.warn(
`${this.logPrefix()} Charging station information from template ${
this.templateFile
- } with no connector Id 0 configuration`
+ } with no connector id 0 configuration`,
);
}
- if (stationInfo?.Connectors) {
- const connectorsConfigHash = crypto
- .createHash(Constants.DEFAULT_HASH_ALGORITHM)
- .update(`${JSON.stringify(stationInfo?.Connectors)}${configuredMaxConnectors.toString()}`)
+ if (stationTemplate?.Connectors) {
+ const { configuredMaxConnectors, templateMaxConnectors, templateMaxAvailableConnectors } =
+ checkConnectorsConfiguration(stationTemplate, this.logPrefix(), this.templateFile);
+ const connectorsConfigHash = createHash(Constants.DEFAULT_HASH_ALGORITHM)
+ .update(
+ `${JSON.stringify(stationTemplate?.Connectors)}${configuredMaxConnectors.toString()}`,
+ )
.digest('hex');
const connectorsConfigChanged =
this.connectors?.size !== 0 && this.connectorsConfigurationHash !== connectorsConfigHash;
if (this.connectors?.size === 0 || connectorsConfigChanged) {
connectorsConfigChanged && this.connectors.clear();
this.connectorsConfigurationHash = connectorsConfigHash;
- // Add connector Id 0
- let lastConnector = '0';
- for (lastConnector in stationInfo?.Connectors) {
- const connectorStatus = stationInfo?.Connectors[lastConnector];
- const lastConnectorId = Utils.convertToInt(lastConnector);
- if (
- lastConnectorId === 0 &&
- this.getUseConnectorId0(stationInfo) === true &&
- connectorStatus
- ) {
- this.checkStationInfoConnectorStatus(lastConnectorId, connectorStatus);
- this.connectors.set(
- lastConnectorId,
- Utils.cloneObject<ConnectorStatus>(connectorStatus)
- );
- 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;
- const connectorStatus = stationInfo?.Connectors[randConnectorId.toString()];
- this.checkStationInfoConnectorStatus(randConnectorId, connectorStatus);
- this.connectors.set(index, Utils.cloneObject<ConnectorStatus>(connectorStatus));
- this.getConnectorStatus(index).availability = AvailabilityType.OPERATIVE;
- if (Utils.isUndefined(this.getConnectorStatus(index)?.chargingProfiles)) {
- this.getConnectorStatus(index).chargingProfiles = [];
+ if (templateMaxConnectors > 0) {
+ for (let connectorId = 0; connectorId <= configuredMaxConnectors; connectorId++) {
+ if (
+ connectorId === 0 &&
+ (!stationTemplate?.Connectors?.[connectorId] ||
+ this.getUseConnectorId0(stationTemplate) === false)
+ ) {
+ continue;
}
+ const templateConnectorId =
+ connectorId > 0 && stationTemplate?.randomConnectors
+ ? getRandomInteger(templateMaxAvailableConnectors, 1)
+ : connectorId;
+ const connectorStatus = stationTemplate?.Connectors[templateConnectorId];
+ checkStationInfoConnectorStatus(
+ templateConnectorId,
+ connectorStatus,
+ this.logPrefix(),
+ this.templateFile,
+ );
+ this.connectors.set(connectorId, cloneObject<ConnectorStatus>(connectorStatus));
}
+ initializeConnectorsMapStatus(this.connectors, this.logPrefix());
+ this.saveConnectorsStatus();
+ } else {
+ logger.warn(
+ `${this.logPrefix()} Charging station information from template ${
+ this.templateFile
+ } with no connectors configuration defined, cannot create connectors`,
+ );
}
}
} else {
logger.warn(
`${this.logPrefix()} Charging station information from template ${
this.templateFile
- } with no connectors configuration defined, using already defined connectors`
+ } 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 === true) {
- logger.warn(
- `${this.logPrefix()} Connector ${connectorId} at initialization has a transaction started: ${
- this.getConnectorStatus(connectorId)?.transactionId
- }`
- );
- }
- if (
- connectorId > 0 &&
- (this.getConnectorStatus(connectorId)?.transactionStarted === undefined ||
- this.getConnectorStatus(connectorId)?.transactionStarted === null)
- ) {
- this.initializeConnectorStatus(connectorId);
- }
- }
}
- private checkStationInfoConnectorStatus(
- connectorId: number,
- connectorStatus: ConnectorStatus
- ): void {
- if (!Utils.isNullOrUndefined(connectorStatus?.status)) {
+ private initializeEvsesFromTemplate(stationTemplate: ChargingStationTemplate): void {
+ if (!stationTemplate?.Evses && this.evses.size === 0) {
+ const errorMsg = `No already defined evses and charging station information from template ${this.templateFile} with no evses configuration defined`;
+ logger.error(`${this.logPrefix()} ${errorMsg}`);
+ throw new BaseError(errorMsg);
+ }
+ if (!stationTemplate?.Evses?.[0]) {
+ logger.warn(
+ `${this.logPrefix()} Charging station information from template ${
+ this.templateFile
+ } with no evse id 0 configuration`,
+ );
+ }
+ if (!stationTemplate?.Evses?.[0]?.Connectors?.[0]) {
+ logger.warn(
+ `${this.logPrefix()} Charging station information from template ${
+ this.templateFile
+ } with evse id 0 with no connector id 0 configuration`,
+ );
+ }
+ if (Object.keys(stationTemplate?.Evses?.[0]?.Connectors as object).length > 1) {
+ logger.warn(
+ `${this.logPrefix()} Charging station information from template ${
+ this.templateFile
+ } with evse id 0 with more than one connector configuration, only connector id 0 configuration will be used`,
+ );
+ }
+ if (stationTemplate?.Evses) {
+ const evsesConfigHash = createHash(Constants.DEFAULT_HASH_ALGORITHM)
+ .update(JSON.stringify(stationTemplate?.Evses))
+ .digest('hex');
+ const evsesConfigChanged =
+ this.evses?.size !== 0 && this.evsesConfigurationHash !== evsesConfigHash;
+ if (this.evses?.size === 0 || evsesConfigChanged) {
+ evsesConfigChanged && this.evses.clear();
+ this.evsesConfigurationHash = evsesConfigHash;
+ const templateMaxEvses = getMaxNumberOfEvses(stationTemplate?.Evses);
+ if (templateMaxEvses > 0) {
+ for (const evseKey in stationTemplate.Evses) {
+ const evseId = convertToInt(evseKey);
+ this.evses.set(evseId, {
+ connectors: buildConnectorsMap(
+ stationTemplate?.Evses[evseKey]?.Connectors,
+ this.logPrefix(),
+ this.templateFile,
+ ),
+ availability: AvailabilityType.Operative,
+ });
+ initializeConnectorsMapStatus(this.evses.get(evseId)!.connectors, this.logPrefix());
+ }
+ this.saveEvsesStatus();
+ } else {
+ logger.warn(
+ `${this.logPrefix()} Charging station information from template ${
+ this.templateFile
+ } with no evses configuration defined, cannot create evses`,
+ );
+ }
+ }
+ } else {
logger.warn(
`${this.logPrefix()} Charging station information from template ${
this.templateFile
- } with connector ${connectorId} status configuration defined, undefine it`
+ } with no evses configuration defined, using already defined evses`,
);
- connectorStatus.status = undefined;
}
}
private getConfigurationFromFile(): ChargingStationConfiguration | undefined {
let configuration: ChargingStationConfiguration | undefined;
- if (this.configurationFile && fs.existsSync(this.configurationFile)) {
+ if (isNotEmptyString(this.configurationFile) && existsSync(this.configurationFile)) {
try {
if (this.sharedLRUCache.hasChargingStationConfiguration(this.configurationFileHash)) {
configuration = this.sharedLRUCache.getChargingStationConfiguration(
- this.configurationFileHash
+ this.configurationFileHash,
);
} else {
const measureId = `${FileType.ChargingStationConfiguration} read`;
const beginId = PerformanceStatistics.beginMeasure(measureId);
configuration = JSON.parse(
- fs.readFileSync(this.configurationFile, 'utf8')
+ readFileSync(this.configurationFile, 'utf8'),
) as ChargingStationConfiguration;
PerformanceStatistics.endMeasure(measureId, beginId);
- this.configurationFileHash = configuration.configurationHash;
this.sharedLRUCache.setChargingStationConfiguration(configuration);
+ this.configurationFileHash = configuration.configurationHash!;
}
} catch (error) {
- FileUtils.handleFileException(
+ handleFileException(
this.configurationFile,
FileType.ChargingStationConfiguration,
error as NodeJS.ErrnoException,
- this.logPrefix()
+ this.logPrefix(),
);
}
}
return configuration;
}
+ private saveAutomaticTransactionGeneratorConfiguration(): void {
+ if (this.getAutomaticTransactionGeneratorPersistentConfiguration()) {
+ this.saveConfiguration();
+ }
+ }
+
+ private saveConnectorsStatus() {
+ this.saveConfiguration();
+ }
+
+ private saveEvsesStatus() {
+ this.saveConfiguration();
+ }
+
private saveConfiguration(): void {
- if (this.configurationFile) {
+ if (isNotEmptyString(this.configurationFile)) {
try {
- if (!fs.existsSync(path.dirname(this.configurationFile))) {
- fs.mkdirSync(path.dirname(this.configurationFile), { recursive: true });
+ if (!existsSync(dirname(this.configurationFile))) {
+ mkdirSync(dirname(this.configurationFile), { recursive: true });
+ }
+ let configurationData: ChargingStationConfiguration = this.getConfigurationFromFile()
+ ? cloneObject<ChargingStationConfiguration>(this.getConfigurationFromFile()!)
+ : {};
+ if (this.getStationInfoPersistentConfiguration() && this.stationInfo) {
+ configurationData.stationInfo = this.stationInfo;
+ } else {
+ delete configurationData.stationInfo;
+ }
+ if (this.getOcppPersistentConfiguration() && this.ocppConfiguration?.configurationKey) {
+ configurationData.configurationKey = this.ocppConfiguration.configurationKey;
+ } else {
+ delete configurationData.configurationKey;
+ }
+ configurationData = merge<ChargingStationConfiguration>(
+ configurationData,
+ buildChargingStationAutomaticTransactionGeneratorConfiguration(this),
+ );
+ if (
+ !this.getAutomaticTransactionGeneratorPersistentConfiguration() ||
+ !this.getAutomaticTransactionGeneratorConfiguration()
+ ) {
+ delete configurationData.automaticTransactionGenerator;
+ }
+ if (this.connectors.size > 0) {
+ configurationData.connectorsStatus = buildConnectorsStatus(this);
+ } else {
+ delete configurationData.connectorsStatus;
+ }
+ if (this.evses.size > 0) {
+ configurationData.evsesStatus = buildEvsesStatus(this);
+ } else {
+ delete configurationData.evsesStatus;
}
- 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))
+ const configurationHash = createHash(Constants.DEFAULT_HASH_ALGORITHM)
+ .update(
+ JSON.stringify({
+ stationInfo: configurationData.stationInfo,
+ configurationKey: configurationData.configurationKey,
+ automaticTransactionGenerator: configurationData.automaticTransactionGenerator,
+ } as ChargingStationConfiguration),
+ )
.digest('hex');
if (this.configurationFileHash !== configurationHash) {
- 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);
+ AsyncLock.runExclusive(AsyncLockType.configuration, () => {
+ configurationData.configurationHash = configurationHash;
+ const measureId = `${FileType.ChargingStationConfiguration} write`;
+ const beginId = PerformanceStatistics.beginMeasure(measureId);
+ writeFileSync(
+ this.configurationFile,
+ JSON.stringify(configurationData, null, 2),
+ 'utf8',
+ );
+ PerformanceStatistics.endMeasure(measureId, beginId);
+ this.sharedLRUCache.deleteChargingStationConfiguration(this.configurationFileHash);
+ this.sharedLRUCache.setChargingStationConfiguration(configurationData);
+ this.configurationFileHash = configurationHash;
+ }).catch((error) => {
+ handleFileException(
+ this.configurationFile,
+ FileType.ChargingStationConfiguration,
+ error as NodeJS.ErrnoException,
+ this.logPrefix(),
+ );
+ });
} else {
logger.debug(
`${this.logPrefix()} Not saving unchanged charging station configuration file ${
this.configurationFile
- }`
+ }`,
);
}
} catch (error) {
- FileUtils.handleFileException(
+ handleFileException(
this.configurationFile,
FileType.ChargingStationConfiguration,
error as NodeJS.ErrnoException,
- this.logPrefix()
+ this.logPrefix(),
);
}
} else {
logger.error(
- `${this.logPrefix()} Trying to save charging station configuration to undefined configuration file`
+ `${this.logPrefix()} Trying to save charging station configuration to undefined configuration file`,
);
}
}
}
private getOcppConfigurationFromFile(): ChargingStationOcppConfiguration | undefined {
- let configuration: ChargingStationConfiguration | undefined;
- if (this.getOcppPersistentConfiguration() === true) {
- const configurationFromFile = this.getConfigurationFromFile();
- configuration = configurationFromFile?.configurationKey && configurationFromFile;
+ const configurationKey = this.getConfigurationFromFile()?.configurationKey;
+ if (this.getOcppPersistentConfiguration() === true && configurationKey) {
+ return { configurationKey };
}
- configuration && delete configuration.stationInfo;
- return configuration;
+ return undefined;
}
private getOcppConfiguration(): ChargingStationOcppConfiguration | undefined {
private async onOpen(): Promise<void> {
if (this.isWebSocketConnectionOpened() === true) {
logger.info(
- `${this.logPrefix()} Connection to OCPP server through ${this.wsConnectionUrl.toString()} succeeded`
+ `${this.logPrefix()} Connection to OCPP server through ${this.wsConnectionUrl.toString()} succeeded`,
);
if (this.isRegistered() === false) {
// Send BootNotification
skipBufferingOnError: true,
});
if (this.isRegistered() === false) {
- this.getRegistrationMaxRetries() !== -1 && registrationRetryCount++;
- await Utils.sleep(
+ this.getRegistrationMaxRetries() !== -1 && ++registrationRetryCount;
+ await sleep(
this?.bootNotificationResponse?.interval
- ? this.bootNotificationResponse.interval * 1000
- : Constants.OCPP_DEFAULT_BOOT_NOTIFICATION_INTERVAL
+ ? secondsToMilliseconds(this.bootNotificationResponse.interval)
+ : Constants.DEFAULT_BOOT_NOTIFICATION_INTERVAL,
);
}
} while (
this.isRegistered() === false &&
- (registrationRetryCount <= this.getRegistrationMaxRetries() ||
+ (registrationRetryCount <= this.getRegistrationMaxRetries()! ||
this.getRegistrationMaxRetries() === -1)
);
}
if (this.isRegistered() === true) {
- if (this.isInAcceptedState() === true) {
+ if (this.inAcceptedState() === true) {
await this.startMessageSequence();
}
} else {
logger.error(
- `${this.logPrefix()} Registration failure: max retries reached (${this.getRegistrationMaxRetries()}) or retry disabled (${this.getRegistrationMaxRetries()})`
+ `${this.logPrefix()} Registration failure: max retries reached (${this.getRegistrationMaxRetries()}) or retry disabled (${this.getRegistrationMaxRetries()})`,
);
}
this.wsConnectionRestarted = false;
this.autoReconnectRetryCount = 0;
- parentPort?.postMessage(MessageChannelUtils.buildUpdatedMessage(this));
+ parentPort?.postMessage(buildUpdatedMessage(this));
} else {
logger.warn(
- `${this.logPrefix()} Connection to OCPP server through ${this.wsConnectionUrl.toString()} failed`
+ `${this.logPrefix()} Connection to OCPP server through ${this.wsConnectionUrl.toString()} failed`,
);
}
}
case WebSocketCloseEventStatusCode.CLOSE_NORMAL:
case WebSocketCloseEventStatusCode.CLOSE_NO_STATUS:
logger.info(
- `${this.logPrefix()} WebSocket normally closed with status '${Utils.getWebSocketCloseEventStatusString(
- code
- )}' and reason '${reason.toString()}'`
+ `${this.logPrefix()} WebSocket normally closed with status '${getWebSocketCloseEventStatusString(
+ code,
+ )}' and reason '${reason.toString()}'`,
);
this.autoReconnectRetryCount = 0;
break;
// Abnormal close
default:
logger.error(
- `${this.logPrefix()} WebSocket abnormally closed with status '${Utils.getWebSocketCloseEventStatusString(
- code
- )}' and reason '${reason.toString()}'`
+ `${this.logPrefix()} WebSocket abnormally closed with status '${getWebSocketCloseEventStatusString(
+ code,
+ )}' and reason '${reason.toString()}'`,
);
this.started === true && (await this.reconnect());
break;
}
- parentPort?.postMessage(MessageChannelUtils.buildUpdatedMessage(this));
+ parentPort?.postMessage(buildUpdatedMessage(this));
+ }
+
+ private getCachedRequest(messageType: MessageType, messageId: string): CachedRequest | undefined {
+ const cachedRequest = this.requests.get(messageId);
+ if (Array.isArray(cachedRequest) === true) {
+ return cachedRequest;
+ }
+ throw new OCPPError(
+ ErrorType.PROTOCOL_ERROR,
+ `Cached request for message id ${messageId} ${OCPPServiceUtils.getMessageTypeString(
+ messageType,
+ )} is not an array`,
+ undefined,
+ cachedRequest as JsonType,
+ );
+ }
+
+ private async handleIncomingMessage(request: IncomingRequest): Promise<void> {
+ const [messageType, messageId, commandName, commandPayload] = request;
+ if (this.getEnableStatistics() === true) {
+ this.performanceStatistics?.addRequestStatistic(commandName, messageType);
+ }
+ logger.debug(
+ `${this.logPrefix()} << Command '${commandName}' received request payload: ${JSON.stringify(
+ request,
+ )}`,
+ );
+ // Process the message
+ await this.ocppIncomingRequestService.incomingRequestHandler(
+ this,
+ messageId,
+ commandName,
+ commandPayload,
+ );
+ }
+
+ private handleResponseMessage(response: Response): void {
+ const [messageType, messageId, commandPayload] = response;
+ if (this.requests.has(messageId) === false) {
+ // Error
+ throw new OCPPError(
+ ErrorType.INTERNAL_ERROR,
+ `Response for unknown message id ${messageId}`,
+ undefined,
+ commandPayload,
+ );
+ }
+ // Respond
+ const [responseCallback, , requestCommandName, requestPayload] = this.getCachedRequest(
+ messageType,
+ messageId,
+ )!;
+ logger.debug(
+ `${this.logPrefix()} << Command '${
+ requestCommandName ?? Constants.UNKNOWN_COMMAND
+ }' received response payload: ${JSON.stringify(response)}`,
+ );
+ responseCallback(commandPayload, requestPayload);
+ }
+
+ private handleErrorMessage(errorResponse: ErrorResponse): void {
+ const [messageType, messageId, errorType, errorMessage, errorDetails] = errorResponse;
+ if (this.requests.has(messageId) === false) {
+ // Error
+ throw new OCPPError(
+ ErrorType.INTERNAL_ERROR,
+ `Error response for unknown message id ${messageId}`,
+ undefined,
+ { errorType, errorMessage, errorDetails },
+ );
+ }
+ const [, errorCallback, requestCommandName] = this.getCachedRequest(messageType, messageId)!;
+ logger.debug(
+ `${this.logPrefix()} << Command '${
+ requestCommandName ?? Constants.UNKNOWN_COMMAND
+ }' received error response payload: ${JSON.stringify(errorResponse)}`,
+ );
+ errorCallback(new OCPPError(errorType, errorMessage, requestCommandName, errorDetails));
}
private async onMessage(data: RawData): Promise<void> {
- let messageType: number;
- let messageId: string;
- let commandName: IncomingRequestCommand;
- let commandPayload: JsonType;
- let errorType: ErrorType;
- let errorMessage: string;
- let errorDetails: JsonType;
- let responseCallback: ResponseCallback;
- let errorCallback: ErrorCallback;
- let requestCommandName: RequestCommand | IncomingRequestCommand;
- let requestPayload: JsonType;
- let cachedRequest: CachedRequest;
- let errMsg: string;
+ let request: IncomingRequest | Response | ErrorResponse | undefined;
+ let messageType: number | undefined;
+ let errorMsg: string;
try {
- const request = JSON.parse(data.toString()) as IncomingRequest | Response | ErrorResponse;
+ // eslint-disable-next-line @typescript-eslint/no-base-to-string
+ request = JSON.parse(data.toString()) as IncomingRequest | Response | ErrorResponse;
if (Array.isArray(request) === true) {
- [messageType, messageId] = request;
+ [messageType] = request;
// Check the type of message
switch (messageType) {
// Incoming Message
case MessageType.CALL_MESSAGE:
- [, , commandName, commandPayload] = request as IncomingRequest;
- if (this.getEnableStatistics() === true) {
- this.performanceStatistics?.addRequestStatistic(commandName, messageType);
- }
- logger.debug(
- `${this.logPrefix()} << Command '${commandName}' received request payload: ${JSON.stringify(
- request
- )}`
- );
- // Process the message
- await this.ocppIncomingRequestService.incomingRequestHandler(
- this,
- messageId,
- commandName,
- commandPayload
- );
+ await this.handleIncomingMessage(request as IncomingRequest);
break;
- // Outcome Message
+ // Response Message
case MessageType.CALL_RESULT_MESSAGE:
- [, , commandPayload] = request as Response;
- if (this.requests.has(messageId) === false) {
- // Error
- throw new OCPPError(
- ErrorType.INTERNAL_ERROR,
- `Response for unknown message id ${messageId}`,
- undefined,
- commandPayload
- );
- }
- // Respond
- cachedRequest = this.requests.get(messageId);
- if (Array.isArray(cachedRequest) === true) {
- [responseCallback, errorCallback, requestCommandName, requestPayload] = cachedRequest;
- } else {
- throw new OCPPError(
- ErrorType.PROTOCOL_ERROR,
- `Cached request for message id ${messageId} response is not an array`,
- undefined,
- cachedRequest as unknown as JsonType
- );
- }
- logger.debug(
- `${this.logPrefix()} << Command '${
- requestCommandName ?? Constants.UNKNOWN_COMMAND
- }' received response payload: ${JSON.stringify(request)}`
- );
- responseCallback(commandPayload, requestPayload);
+ this.handleResponseMessage(request as Response);
break;
// Error Message
case MessageType.CALL_ERROR_MESSAGE:
- [, , errorType, errorMessage, errorDetails] = request as ErrorResponse;
- if (this.requests.has(messageId) === false) {
- // Error
- throw new OCPPError(
- ErrorType.INTERNAL_ERROR,
- `Error response for unknown message id ${messageId}`,
- undefined,
- { errorType, errorMessage, errorDetails }
- );
- }
- cachedRequest = this.requests.get(messageId);
- if (Array.isArray(cachedRequest) === true) {
- [, errorCallback, requestCommandName] = cachedRequest;
- } else {
- throw new OCPPError(
- ErrorType.PROTOCOL_ERROR,
- `Cached request for message id ${messageId} error response is not an array`,
- undefined,
- cachedRequest as unknown as JsonType
- );
- }
- logger.debug(
- `${this.logPrefix()} << Command '${
- requestCommandName ?? Constants.UNKNOWN_COMMAND
- }' received error response payload: ${JSON.stringify(request)}`
- );
- errorCallback(new OCPPError(errorType, errorMessage, requestCommandName, errorDetails));
+ this.handleErrorMessage(request as ErrorResponse);
break;
- // Error
+ // Unknown Message
default:
// eslint-disable-next-line @typescript-eslint/restrict-template-expressions
- errMsg = `Wrong message type ${messageType}`;
- logger.error(`${this.logPrefix()} ${errMsg}`);
- throw new OCPPError(ErrorType.PROTOCOL_ERROR, errMsg);
+ errorMsg = `Wrong message type ${messageType}`;
+ logger.error(`${this.logPrefix()} ${errorMsg}`);
+ throw new OCPPError(ErrorType.PROTOCOL_ERROR, errorMsg);
}
- parentPort?.postMessage(MessageChannelUtils.buildUpdatedMessage(this));
+ parentPort?.postMessage(buildUpdatedMessage(this));
} else {
- throw new OCPPError(ErrorType.PROTOCOL_ERROR, 'Incoming message is not an array', null, {
- request,
- });
- }
- } catch (error) {
- // Log
- logger.error(
- `${this.logPrefix()} Incoming OCPP command '${
- commandName ?? requestCommandName ?? Constants.UNKNOWN_COMMAND
- }' message '${data.toString()}'${
- messageType !== MessageType.CALL_MESSAGE
- ? ` matching cached request '${JSON.stringify(this.requests.get(messageId))}'`
- : ''
- } processing error:`,
- error
- );
- if (error instanceof OCPPError === false) {
- logger.warn(
- `${this.logPrefix()} Error thrown at incoming OCPP command '${
- commandName ?? requestCommandName ?? Constants.UNKNOWN_COMMAND
- }' message '${data.toString()}' handling is not an OCPPError:`,
- error
+ throw new OCPPError(
+ ErrorType.PROTOCOL_ERROR,
+ 'Incoming message is not an array',
+ undefined,
+ {
+ request,
+ },
);
}
+ } catch (error) {
+ let commandName: IncomingRequestCommand | undefined;
+ let requestCommandName: RequestCommand | IncomingRequestCommand | undefined;
+ let errorCallback: ErrorCallback;
+ const [, messageId] = request!;
switch (messageType) {
case MessageType.CALL_MESSAGE:
+ [, , commandName] = request as IncomingRequest;
// Send error
- await this.ocppRequestService.sendError(
- this,
- messageId,
- error as OCPPError,
- commandName ?? requestCommandName ?? null
- );
+ await this.ocppRequestService.sendError(this, messageId, error as OCPPError, commandName);
break;
case MessageType.CALL_RESULT_MESSAGE:
case MessageType.CALL_ERROR_MESSAGE:
- if (errorCallback) {
+ if (this.requests.has(messageId) === true) {
+ [, errorCallback, requestCommandName] = this.getCachedRequest(messageType, messageId)!;
// Reject the deferred promise in case of error at response handling (rejecting an already fulfilled promise is a no-op)
errorCallback(error as OCPPError, false);
} else {
}
break;
}
+ if (error instanceof OCPPError === false) {
+ logger.warn(
+ `${this.logPrefix()} Error thrown at incoming OCPP command '${
+ commandName ?? requestCommandName ?? Constants.UNKNOWN_COMMAND
+ // eslint-disable-next-line @typescript-eslint/no-base-to-string
+ }' message '${data.toString()}' handling is not an OCPPError:`,
+ error,
+ );
+ }
+ logger.error(
+ `${this.logPrefix()} Incoming OCPP command '${
+ commandName ?? requestCommandName ?? Constants.UNKNOWN_COMMAND
+ // eslint-disable-next-line @typescript-eslint/no-base-to-string
+ }' message '${data.toString()}'${
+ messageType !== MessageType.CALL_MESSAGE
+ ? ` matching cached request '${JSON.stringify(this.requests.get(messageId))}'`
+ : ''
+ } processing error:`,
+ error,
+ );
}
}
if (this.getMeteringPerTransaction() === true) {
return (
(rounded === true
- ? Math.round(connectorStatus?.transactionEnergyActiveImportRegisterValue)
+ ? Math.round(connectorStatus.transactionEnergyActiveImportRegisterValue!)
: connectorStatus?.transactionEnergyActiveImportRegisterValue) ?? 0
);
}
return (
(rounded === true
- ? Math.round(connectorStatus?.energyActiveImportRegisterValue)
+ ? Math.round(connectorStatus.energyActiveImportRegisterValue!)
: connectorStatus?.energyActiveImportRegisterValue) ?? 0
);
}
- private getUseConnectorId0(stationInfo?: ChargingStationInfo): boolean {
- const localStationInfo = stationInfo ?? this.stationInfo;
- return localStationInfo?.useConnectorId0 ?? true;
- }
-
- private getNumberOfRunningTransactions(): number {
- let trxCount = 0;
- for (const connectorId of this.connectors.keys()) {
- if (connectorId > 0 && this.getConnectorStatus(connectorId)?.transactionStarted === true) {
- trxCount++;
- }
- }
- return trxCount;
+ private getUseConnectorId0(stationTemplate?: ChargingStationTemplate): boolean {
+ return stationTemplate?.useConnectorId0 ?? true;
}
private async stopRunningTransactions(reason = StopTransactionReason.NONE): Promise<void> {
- for (const connectorId of this.connectors.keys()) {
- if (connectorId > 0 && this.getConnectorStatus(connectorId)?.transactionStarted === true) {
- await this.stopTransactionOnConnector(connectorId, reason);
+ if (this.hasEvses) {
+ for (const [evseId, evseStatus] of this.evses) {
+ if (evseId === 0) {
+ continue;
+ }
+ for (const [connectorId, connectorStatus] of evseStatus.connectors) {
+ if (connectorStatus.transactionStarted === true) {
+ await this.stopTransactionOnConnector(connectorId, reason);
+ }
+ }
+ }
+ } else {
+ for (const connectorId of this.connectors.keys()) {
+ if (connectorId > 0 && this.getConnectorStatus(connectorId)?.transactionStarted === true) {
+ await this.stopTransactionOnConnector(connectorId, reason);
+ }
}
}
}
// 0 for disabling
private getConnectionTimeout(): number {
- if (
- ChargingStationConfigurationUtils.getConfigurationKey(
- this,
- StandardParametersKey.ConnectionTimeOut
- )
- ) {
+ if (getConfigurationKey(this, StandardParametersKey.ConnectionTimeOut)) {
return (
- parseInt(
- ChargingStationConfigurationUtils.getConfigurationKey(
- this,
- StandardParametersKey.ConnectionTimeOut
- ).value
- ) ?? Constants.DEFAULT_CONNECTION_TIMEOUT
+ parseInt(getConfigurationKey(this, StandardParametersKey.ConnectionTimeOut)!.value!) ??
+ Constants.DEFAULT_CONNECTION_TIMEOUT
);
}
return Constants.DEFAULT_CONNECTION_TIMEOUT;
// -1 for unlimited, 0 for disabling
private getAutoReconnectMaxRetries(): number | undefined {
- if (!Utils.isUndefined(this.stationInfo.autoReconnectMaxRetries)) {
- return this.stationInfo.autoReconnectMaxRetries;
- }
- if (!Utils.isUndefined(Configuration.getAutoReconnectMaxRetries())) {
- return Configuration.getAutoReconnectMaxRetries();
- }
- return -1;
+ return this.stationInfo.autoReconnectMaxRetries ?? -1;
}
- // 0 for disabling
+ // -1 for unlimited, 0 for disabling
private getRegistrationMaxRetries(): number | undefined {
- if (!Utils.isUndefined(this.stationInfo.registrationMaxRetries)) {
- return this.stationInfo.registrationMaxRetries;
- }
- return -1;
+ return this.stationInfo.registrationMaxRetries ?? -1;
}
private getPowerDivider(): number {
- let powerDivider = this.getNumberOfConnectors();
+ let powerDivider = this.hasEvses ? this.getNumberOfEvses() : this.getNumberOfConnectors();
if (this.stationInfo?.powerSharedByConnectors) {
powerDivider = this.getNumberOfRunningTransactions();
}
case CurrentType.AC:
return ACElectricUtils.amperagePerPhaseFromPower(
this.getNumberOfPhases(stationInfo),
- maximumPower / this.getNumberOfConnectors(),
- this.getVoltageOut(stationInfo)
+ maximumPower / (this.hasEvses ? this.getNumberOfEvses() : this.getNumberOfConnectors()),
+ this.getVoltageOut(stationInfo),
);
case CurrentType.DC:
return DCElectricUtils.amperage(maximumPower, this.getVoltageOut(stationInfo));
private getAmperageLimitation(): number | undefined {
if (
- Utils.isNotEmptyString(this.stationInfo?.amperageLimitationOcppKey) &&
- ChargingStationConfigurationUtils.getConfigurationKey(
- this,
- this.stationInfo.amperageLimitationOcppKey
- )
+ isNotEmptyString(this.stationInfo?.amperageLimitationOcppKey) &&
+ getConfigurationKey(this, this.stationInfo.amperageLimitationOcppKey!)
) {
return (
- Utils.convertToInt(
- ChargingStationConfigurationUtils.getConfigurationKey(
- this,
- this.stationInfo.amperageLimitationOcppKey
- )?.value
- ) / ChargingStationUtils.getAmperageLimitationUnitDivider(this.stationInfo)
+ convertToInt(
+ getConfigurationKey(this, this.stationInfo.amperageLimitationOcppKey!)?.value,
+ ) / getAmperageLimitationUnitDivider(this.stationInfo)
);
}
}
// Start heartbeat
this.startHeartbeat();
// Initialize connectors status
- for (const connectorId of this.connectors.keys()) {
- let connectorStatus: ConnectorStatusEnum | undefined;
- if (connectorId === 0) {
- continue;
- } else if (
- !this.getConnectorStatus(connectorId)?.status &&
- (this.isChargingStationAvailable() === false ||
- this.isConnectorAvailable(connectorId) === false)
- ) {
- connectorStatus = ConnectorStatusEnum.UNAVAILABLE;
- } else if (
- !this.getConnectorStatus(connectorId)?.status &&
- this.getConnectorStatus(connectorId)?.bootStatus
- ) {
- // Set boot status in template at startup
- connectorStatus = this.getConnectorStatus(connectorId)?.bootStatus;
- } else if (this.getConnectorStatus(connectorId)?.status) {
- // Set previous status at startup
- connectorStatus = this.getConnectorStatus(connectorId)?.status;
- } else {
- // Set default status
- connectorStatus = ConnectorStatusEnum.AVAILABLE;
+ if (this.hasEvses) {
+ for (const [evseId, evseStatus] of this.evses) {
+ if (evseId > 0) {
+ for (const [connectorId, connectorStatus] of evseStatus.connectors) {
+ const connectorBootStatus = getBootConnectorStatus(this, connectorId, connectorStatus);
+ await OCPPServiceUtils.sendAndSetConnectorStatus(
+ this,
+ connectorId,
+ connectorBootStatus,
+ evseId,
+ );
+ }
+ }
+ }
+ } else {
+ for (const connectorId of this.connectors.keys()) {
+ if (connectorId > 0) {
+ const connectorBootStatus = getBootConnectorStatus(
+ this,
+ connectorId,
+ this.getConnectorStatus(connectorId)!,
+ );
+ await OCPPServiceUtils.sendAndSetConnectorStatus(this, connectorId, connectorBootStatus);
+ }
}
- await this.ocppRequestService.requestHandler<
- StatusNotificationRequest,
- StatusNotificationResponse
- >(
- this,
- RequestCommand.STATUS_NOTIFICATION,
- OCPPServiceUtils.buildStatusNotificationRequest(this, connectorId, connectorStatus)
- );
- this.getConnectorStatus(connectorId).status = connectorStatus;
}
if (this.stationInfo?.firmwareStatus === FirmwareStatus.Installing) {
await this.ocppRequestService.requestHandler<
}
// Start the ATG
- if (this.getAutomaticTransactionGeneratorConfigurationFromTemplate()?.enable === true) {
+ if (this.getAutomaticTransactionGeneratorConfiguration()?.enable === true) {
this.startAutomaticTransactionGenerator();
}
this.wsConnectionRestarted === true && this.flushMessageBuffer();
}
private async stopMessageSequence(
- reason: StopTransactionReason = StopTransactionReason.NONE
+ reason: StopTransactionReason = StopTransactionReason.NONE,
): Promise<void> {
// Stop WebSocket ping
this.stopWebSocketPing();
} else {
await this.stopRunningTransactions(reason);
}
- for (const connectorId of this.connectors.keys()) {
- if (connectorId > 0) {
- await this.ocppRequestService.requestHandler<
- StatusNotificationRequest,
- StatusNotificationResponse
- >(
- this,
- RequestCommand.STATUS_NOTIFICATION,
- OCPPServiceUtils.buildStatusNotificationRequest(
+ if (this.hasEvses) {
+ for (const [evseId, evseStatus] of this.evses) {
+ if (evseId > 0) {
+ for (const [connectorId, connectorStatus] of evseStatus.connectors) {
+ await this.ocppRequestService.requestHandler<
+ StatusNotificationRequest,
+ StatusNotificationResponse
+ >(
+ this,
+ RequestCommand.STATUS_NOTIFICATION,
+ OCPPServiceUtils.buildStatusNotificationRequest(
+ this,
+ connectorId,
+ ConnectorStatusEnum.Unavailable,
+ evseId,
+ ),
+ );
+ delete connectorStatus?.status;
+ }
+ }
+ }
+ } else {
+ for (const connectorId of this.connectors.keys()) {
+ if (connectorId > 0) {
+ await this.ocppRequestService.requestHandler<
+ StatusNotificationRequest,
+ StatusNotificationResponse
+ >(
this,
- connectorId,
- ConnectorStatusEnum.UNAVAILABLE
- )
- );
- this.getConnectorStatus(connectorId).status = undefined;
+ RequestCommand.STATUS_NOTIFICATION,
+ OCPPServiceUtils.buildStatusNotificationRequest(
+ this,
+ connectorId,
+ ConnectorStatusEnum.Unavailable,
+ ),
+ );
+ delete this.getConnectorStatus(connectorId)?.status;
+ }
}
}
}
private startWebSocketPing(): void {
- const webSocketPingInterval: number = ChargingStationConfigurationUtils.getConfigurationKey(
+ const webSocketPingInterval: number = getConfigurationKey(
this,
- StandardParametersKey.WebSocketPingInterval
+ StandardParametersKey.WebSocketPingInterval,
)
- ? Utils.convertToInt(
- ChargingStationConfigurationUtils.getConfigurationKey(
- this,
- StandardParametersKey.WebSocketPingInterval
- )?.value
- )
+ ? convertToInt(getConfigurationKey(this, StandardParametersKey.WebSocketPingInterval)?.value)
: 0;
if (webSocketPingInterval > 0 && !this.webSocketPingSetInterval) {
this.webSocketPingSetInterval = setInterval(() => {
if (this.isWebSocketConnectionOpened() === true) {
this.wsConnection?.ping();
}
- }, webSocketPingInterval * 1000);
+ }, secondsToMilliseconds(webSocketPingInterval));
logger.info(
- `${this.logPrefix()} WebSocket ping started every ${Utils.formatDurationSeconds(
- webSocketPingInterval
- )}`
+ `${this.logPrefix()} WebSocket ping started every ${formatDurationSeconds(
+ webSocketPingInterval,
+ )}`,
);
} else if (this.webSocketPingSetInterval) {
logger.info(
- `${this.logPrefix()} WebSocket ping already started every ${Utils.formatDurationSeconds(
- webSocketPingInterval
- )}`
+ `${this.logPrefix()} WebSocket ping already started every ${formatDurationSeconds(
+ webSocketPingInterval,
+ )}`,
);
} else {
logger.error(
- `${this.logPrefix()} WebSocket ping interval set to ${
- webSocketPingInterval
- ? Utils.formatDurationSeconds(webSocketPingInterval)
- : webSocketPingInterval
- }, not starting the WebSocket ping`
+ `${this.logPrefix()} WebSocket ping interval set to ${webSocketPingInterval}, not starting the WebSocket ping`,
);
}
}
private stopWebSocketPing(): void {
if (this.webSocketPingSetInterval) {
clearInterval(this.webSocketPingSetInterval);
+ delete this.webSocketPingSetInterval;
}
}
private getConfiguredSupervisionUrl(): URL {
+ let configuredSupervisionUrl: string;
const supervisionUrls = this.stationInfo?.supervisionUrls ?? Configuration.getSupervisionUrls();
- if (Utils.isNotEmptyArray(supervisionUrls)) {
+ if (isNotEmptyArray(supervisionUrls)) {
+ let configuredSupervisionUrlIndex: number;
switch (Configuration.getSupervisionUrlDistribution()) {
- case SupervisionUrlDistribution.ROUND_ROBIN:
- // FIXME
- this.configuredSupervisionUrlIndex = (this.index - 1) % supervisionUrls.length;
- break;
case SupervisionUrlDistribution.RANDOM:
- this.configuredSupervisionUrlIndex = Math.floor(
- Utils.secureRandom() * supervisionUrls.length
+ configuredSupervisionUrlIndex = Math.floor(
+ secureRandom() * (supervisionUrls as string[]).length,
);
break;
+ case SupervisionUrlDistribution.ROUND_ROBIN:
case SupervisionUrlDistribution.CHARGING_STATION_AFFINITY:
- this.configuredSupervisionUrlIndex = (this.index - 1) % supervisionUrls.length;
- break;
default:
- logger.error(
- `${this.logPrefix()} Unknown supervision url distribution '${Configuration.getSupervisionUrlDistribution()}' from values '${SupervisionUrlDistribution.toString()}', defaulting to ${
- SupervisionUrlDistribution.CHARGING_STATION_AFFINITY
- }`
- );
- this.configuredSupervisionUrlIndex = (this.index - 1) % supervisionUrls.length;
+ Object.values(SupervisionUrlDistribution).includes(
+ Configuration.getSupervisionUrlDistribution()!,
+ ) === false &&
+ logger.error(
+ // eslint-disable-next-line @typescript-eslint/no-base-to-string
+ `${this.logPrefix()} Unknown supervision url distribution '${Configuration.getSupervisionUrlDistribution()}' from values '${SupervisionUrlDistribution.toString()}', defaulting to ${
+ SupervisionUrlDistribution.CHARGING_STATION_AFFINITY
+ }`,
+ );
+ configuredSupervisionUrlIndex = (this.index - 1) % (supervisionUrls as string[]).length;
break;
}
- return new URL(supervisionUrls[this.configuredSupervisionUrlIndex]);
- }
- return new URL(supervisionUrls as string);
- }
-
- private getHeartbeatInterval(): number {
- const HeartbeatInterval = ChargingStationConfigurationUtils.getConfigurationKey(
- this,
- StandardParametersKey.HeartbeatInterval
- );
- if (HeartbeatInterval) {
- return Utils.convertToInt(HeartbeatInterval.value) * 1000;
+ configuredSupervisionUrl = (supervisionUrls as string[])[configuredSupervisionUrlIndex];
+ } else {
+ configuredSupervisionUrl = supervisionUrls as string;
}
- const HeartBeatInterval = ChargingStationConfigurationUtils.getConfigurationKey(
- this,
- StandardParametersKey.HeartBeatInterval
- );
- if (HeartBeatInterval) {
- return Utils.convertToInt(HeartBeatInterval.value) * 1000;
+ if (isNotEmptyString(configuredSupervisionUrl)) {
+ return new URL(configuredSupervisionUrl);
}
- this.stationInfo?.autoRegister === false &&
- logger.warn(
- `${this.logPrefix()} Heartbeat interval configuration key not set, using default value: ${
- Constants.DEFAULT_HEARTBEAT_INTERVAL
- }`
- );
- return Constants.DEFAULT_HEARTBEAT_INTERVAL;
+ const errorMsg = 'No supervision url(s) configured';
+ logger.error(`${this.logPrefix()} ${errorMsg}`);
+ throw new BaseError(`${errorMsg}`);
}
private stopHeartbeat(): void {
if (this.heartbeatSetInterval) {
clearInterval(this.heartbeatSetInterval);
+ delete this.heartbeatSetInterval;
}
}
}
}
- private stopMeterValues(connectorId: number) {
- if (this.getConnectorStatus(connectorId)?.transactionSetInterval) {
- clearInterval(this.getConnectorStatus(connectorId)?.transactionSetInterval);
- }
- }
-
private getReconnectExponentialDelay(): boolean {
return this.stationInfo?.reconnectExponentialDelay ?? false;
}
// Stop heartbeat
this.stopHeartbeat();
// Stop the ATG if needed
- if (this.automaticTransactionGenerator?.configuration?.stopOnConnectionFailure === true) {
+ if (this.getAutomaticTransactionGeneratorConfiguration().stopOnConnectionFailure === true) {
this.stopAutomaticTransactionGenerator();
}
if (
- this.autoReconnectRetryCount < this.getAutoReconnectMaxRetries() ||
+ this.autoReconnectRetryCount < this.getAutoReconnectMaxRetries()! ||
this.getAutoReconnectMaxRetries() === -1
) {
- this.autoReconnectRetryCount++;
+ ++this.autoReconnectRetryCount;
const reconnectDelay = this.getReconnectExponentialDelay()
- ? Utils.exponentialDelay(this.autoReconnectRetryCount)
- : this.getConnectionTimeout() * 1000;
+ ? exponentialDelay(this.autoReconnectRetryCount)
+ : secondsToMilliseconds(this.getConnectionTimeout());
const reconnectDelayWithdraw = 1000;
const reconnectTimeout =
reconnectDelay && reconnectDelay - reconnectDelayWithdraw > 0
? reconnectDelay - reconnectDelayWithdraw
: 0;
logger.error(
- `${this.logPrefix()} WebSocket connection retry in ${Utils.roundTo(
+ `${this.logPrefix()} WebSocket connection retry in ${roundTo(
reconnectDelay,
- 2
- )}ms, timeout ${reconnectTimeout}ms`
+ 2,
+ )}ms, timeout ${reconnectTimeout}ms`,
);
- await Utils.sleep(reconnectDelay);
+ await sleep(reconnectDelay);
logger.error(
- `${this.logPrefix()} WebSocket connection retry #${this.autoReconnectRetryCount.toString()}`
+ `${this.logPrefix()} WebSocket connection retry #${this.autoReconnectRetryCount.toString()}`,
);
this.openWSConnection(
- { ...(this.stationInfo?.wsOptions ?? {}), handshakeTimeout: reconnectTimeout },
- { closeOpened: true }
+ {
+ handshakeTimeout: reconnectTimeout,
+ },
+ { closeOpened: true },
);
this.wsConnectionRestarted = true;
} else if (this.getAutoReconnectMaxRetries() !== -1) {
logger.error(
`${this.logPrefix()} WebSocket connection retries failure: maximum retries reached (${
this.autoReconnectRetryCount
- }) or retries disabled (${this.getAutoReconnectMaxRetries()})`
+ }) or retries disabled (${this.getAutoReconnectMaxRetries()})`,
);
}
}
-
- private getAutomaticTransactionGeneratorConfigurationFromTemplate():
- | AutomaticTransactionGeneratorConfiguration
- | undefined {
- return this.getTemplateFromFile()?.AutomaticTransactionGenerator;
- }
-
- private initializeConnectorStatus(connectorId: number): void {
- this.getConnectorStatus(connectorId).idTagLocalAuthorized = false;
- this.getConnectorStatus(connectorId).idTagAuthorized = false;
- this.getConnectorStatus(connectorId).transactionRemoteStarted = false;
- this.getConnectorStatus(connectorId).transactionStarted = false;
- this.getConnectorStatus(connectorId).energyActiveImportRegisterValue = 0;
- this.getConnectorStatus(connectorId).transactionEnergyActiveImportRegisterValue = 0;
- }
}