import merge from 'just-merge';
import WebSocket, { type RawData } from 'ws';
+import { AutomaticTransactionGenerator } from './AutomaticTransactionGenerator';
+import { ChargingStationWorkerBroadcastChannel } from './broadcast-channel/ChargingStationWorkerBroadcastChannel';
+import { ChargingStationConfigurationUtils } from './ChargingStationConfigurationUtils';
+import { ChargingStationUtils } from './ChargingStationUtils';
+import { IdTagsCache } from './IdTagsCache';
import {
- AutomaticTransactionGenerator,
- ChargingStationConfigurationUtils,
- ChargingStationUtils,
- ChargingStationWorkerBroadcastChannel,
- IdTagsCache,
- MessageChannelUtils,
- SharedLRUCache,
-} from './internal';
-import {
- // OCPP16IncomingRequestService,
+ 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 {
type BootNotificationRequest,
type BootNotificationResponse,
type CachedRequest,
- type ChargingStationAutomaticTransactionGeneratorConfiguration,
type ChargingStationConfiguration,
type ChargingStationInfo,
type ChargingStationOcppConfiguration,
PowerUnits,
RegistrationStatusEnumType,
RequestCommand,
+ type Reservation,
+ ReservationFilterKey,
+ ReservationTerminationReason,
type Response,
StandardParametersKey,
type StatusNotificationRequest,
Configuration,
Constants,
DCElectricUtils,
+ ErrorUtils,
FileUtils,
+ MessageChannelUtils,
Utils,
+ buildChargingStationAutomaticTransactionGeneratorConfiguration,
+ buildConnectorsStatus,
+ buildEvsesStatus,
logger,
} from '../utils';
private readonly sharedLRUCache: SharedLRUCache;
private webSocketPingSetInterval!: NodeJS.Timeout;
private readonly chargingStationWorkerBroadcastChannel: ChargingStationWorkerBroadcastChannel;
+ private reservationExpiryDateSetInterval?: NodeJS.Timeout;
constructor(index: number, templateFile: string) {
this.started = false;
return new URL(
`${
this.getSupervisionUrlOcppConfiguration() &&
- Utils.isNotEmptyString(this.getSupervisionUrlOcppKey())
+ Utils.isNotEmptyString(this.getSupervisionUrlOcppKey()) &&
+ Utils.isNotEmptyString(
+ ChargingStationConfigurationUtils.getConfigurationKey(
+ this,
+ this.getSupervisionUrlOcppKey()
+ )?.value
+ )
? ChargingStationConfigurationUtils.getConfigurationKey(
this,
this.getSupervisionUrlOcppKey()
- )?.value
+ ).value
: this.configuredSupervisionUrl.href
}/${this.stationInfo.chargingStationId}`
);
};
public hasIdTags(): boolean {
- const idTagsFile = ChargingStationUtils.getIdTagsFile(this.stationInfo);
- return Utils.isNotEmptyArray(this.idTagsCache.getIdTags(idTagsFile));
+ return Utils.isNotEmptyArray(
+ this.idTagsCache.getIdTags(ChargingStationUtils.getIdTagsFile(this.stationInfo))
+ );
}
public getEnableStatistics(): boolean {
return this?.bootNotificationResponse?.status;
}
- public isInUnknownState(): boolean {
+ public inUnknownState(): boolean {
return Utils.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)
);
}
);
} else {
logger.error(
- `${this.logPrefix()} Heartbeat interval set to ${this.getHeartbeatInterval()}, not starting the heartbeat`
+ `${this.logPrefix()} Heartbeat interval set to ${this.getHeartbeatInterval()},
+ not starting the heartbeat`
);
}
}
}
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.toString()}`
);
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 (
Utils.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 (this.getEnableStatistics() === true) {
this.performanceStatistics?.start();
}
+ if (this.hasFeatureProfile(SupportedFeatureProfiles.Reservation)) {
+ this.startReservationExpiryDateSetInterval();
+ }
this.openWSConnection();
// Monitor charging station template file
this.templateFileWatcher = FileUtils.watchJsonFile(
params = { ...{ closeOpened: false, terminateOpened: false }, ...params };
if (this.started === false && this.starting === false) {
logger.warn(
- `${this.logPrefix()} Cannot open OCPP connection to URL ${this.wsConnectionUrl.toString()} on stopped charging station`
+ `${this.logPrefix()} Cannot open OCPP connection to URL ${this.wsConnectionUrl.toString()}
+ on stopped charging station`
);
return;
}
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;
}
public getAutomaticTransactionGeneratorConfiguration():
| AutomaticTransactionGeneratorConfiguration
| undefined {
+ let automaticTransactionGeneratorConfiguration:
+ | AutomaticTransactionGeneratorConfiguration
+ | undefined;
const automaticTransactionGeneratorConfigurationFromFile =
this.getConfigurationFromFile()?.automaticTransactionGenerator;
if (automaticTransactionGeneratorConfigurationFromFile) {
- return automaticTransactionGeneratorConfigurationFromFile;
+ automaticTransactionGeneratorConfiguration =
+ automaticTransactionGeneratorConfigurationFromFile;
+ } else {
+ automaticTransactionGeneratorConfiguration =
+ this.getTemplateFromFile()?.AutomaticTransactionGenerator;
}
- return this.getTemplateFromFile()?.AutomaticTransactionGenerator;
+ return {
+ ...Constants.DEFAULT_ATG_CONFIGURATION,
+ ...automaticTransactionGeneratorConfiguration,
+ };
}
public startAutomaticTransactionGenerator(connectorIds?: number[]): void {
);
}
+ public getReservationOnConnectorId0Enabled(): boolean {
+ return Utils.convertToBoolean(
+ ChargingStationConfigurationUtils.getConfigurationKey(
+ this,
+ StandardParametersKey.ReserveConnectorZeroSupported
+ ).value
+ );
+ }
+
+ public async addReservation(reservation: Reservation): Promise<void> {
+ const [exists, reservationFound] = this.doesReservationExists(reservation);
+ if (exists) {
+ await this.removeReservation(reservationFound);
+ }
+ const connectorStatus = this.getConnectorStatus(reservation.connectorId);
+ connectorStatus.reservation = reservation;
+ connectorStatus.status = ConnectorStatusEnum.Reserved;
+ if (reservation.connectorId === 0) {
+ return;
+ }
+ await this.ocppRequestService.requestHandler<
+ StatusNotificationRequest,
+ StatusNotificationResponse
+ >(
+ this,
+ RequestCommand.STATUS_NOTIFICATION,
+ OCPPServiceUtils.buildStatusNotificationRequest(
+ this,
+ reservation.connectorId,
+ ConnectorStatusEnum.Reserved
+ )
+ );
+ }
+
+ public async removeReservation(
+ reservation: Reservation,
+ reason?: ReservationTerminationReason
+ ): Promise<void> {
+ const connector = this.getConnectorStatus(reservation.connectorId);
+ switch (reason) {
+ case ReservationTerminationReason.TRANSACTION_STARTED: {
+ delete connector.reservation;
+ if (reservation.connectorId === 0) {
+ connector.status = ConnectorStatusEnum.Available;
+ }
+ break;
+ }
+ case ReservationTerminationReason.CONNECTOR_STATE_CHANGED: {
+ delete connector.reservation;
+ break;
+ }
+ default: {
+ // ReservationTerminationReason.EXPIRED, ReservationTerminationReason.CANCELED
+ connector.status = ConnectorStatusEnum.Available;
+ delete connector.reservation;
+ await this.ocppRequestService.requestHandler<
+ StatusNotificationRequest,
+ StatusNotificationResponse
+ >(
+ this,
+ RequestCommand.STATUS_NOTIFICATION,
+ OCPPServiceUtils.buildStatusNotificationRequest(
+ this,
+ reservation.connectorId,
+ ConnectorStatusEnum.Available
+ )
+ );
+ break;
+ }
+ }
+ }
+
+ public getReservationBy(key: string, value: number | string): Reservation {
+ if (this.hasEvses) {
+ for (const evse of this.evses.values()) {
+ for (const connector of evse.connectors.values()) {
+ if (connector?.reservation?.[key] === value) {
+ return connector.reservation;
+ }
+ }
+ }
+ } else {
+ for (const connector of this.connectors.values()) {
+ if (connector?.reservation?.[key] === value) {
+ return connector.reservation;
+ }
+ }
+ }
+ }
+
+ public doesReservationExists(reservation: Partial<Reservation>): [boolean, Reservation] {
+ const foundReservation = this.getReservationBy(
+ ReservationFilterKey.RESERVATION_ID,
+ reservation?.id
+ );
+ return Utils.isUndefined(foundReservation) ? [false, null] : [true, foundReservation];
+ }
+
+ public startReservationExpiryDateSetInterval(customInterval?: number): void {
+ const interval =
+ customInterval ?? Constants.DEFAULT_RESERVATION_EXPIRATION_OBSERVATION_INTERVAL;
+ logger.info(
+ `${this.logPrefix()} Reservation expiration date interval is set to ${interval}
+ and starts on CS now`
+ );
+ // eslint-disable-next-line @typescript-eslint/no-misused-promises
+ this.reservationExpiryDateSetInterval = setInterval(async (): Promise<void> => {
+ if (this.hasEvses) {
+ for (const evse of this.evses.values()) {
+ for (const connector of evse.connectors.values()) {
+ if (connector?.reservation?.expiryDate.toString() < new Date().toISOString()) {
+ await this.removeReservation(connector.reservation);
+ }
+ }
+ }
+ } else {
+ for (const connector of this.connectors.values()) {
+ if (connector?.reservation?.expiryDate.toString() < new Date().toISOString()) {
+ await this.removeReservation(connector.reservation);
+ }
+ }
+ }
+ }, interval);
+ }
+
+ public restartReservationExpiryDateSetInterval(): void {
+ this.stopReservationExpiryDateSetInterval();
+ this.startReservationExpiryDateSetInterval();
+ }
+
+ public validateIncomingRequestWithReservation(connectorId: number, idTag: string): boolean {
+ const reservation = this.getReservationBy(ReservationFilterKey.CONNECTOR_ID, connectorId);
+ return !Utils.isUndefined(reservation) && reservation.idTag === idTag;
+ }
+
+ public isConnectorReservable(
+ reservationId: number,
+ idTag?: string,
+ connectorId?: number
+ ): boolean {
+ const [alreadyExists] = this.doesReservationExists({ id: reservationId });
+ if (alreadyExists) {
+ return alreadyExists;
+ }
+ const userReservedAlready = Utils.isUndefined(
+ this.getReservationBy(ReservationFilterKey.ID_TAG, idTag)
+ )
+ ? false
+ : true;
+ const notConnectorZero = Utils.isUndefined(connectorId) ? true : connectorId > 0;
+ const freeConnectorsAvailable = this.getNumberOfReservableConnectors() > 0;
+ return !alreadyExists && !userReservedAlready && notConnectorZero && freeConnectorsAvailable;
+ }
+
+ private getNumberOfReservableConnectors(): number {
+ let reservableConnectors = 0;
+ if (this.hasEvses) {
+ for (const evse of this.evses.values()) {
+ reservableConnectors = this.countReservableConnectors(evse.connectors);
+ }
+ } else {
+ reservableConnectors = this.countReservableConnectors(this.connectors);
+ }
+ return reservableConnectors - this.getNumberOfReservationsOnConnectorZero();
+ }
+
+ private countReservableConnectors(connectors: Map<number, ConnectorStatus>) {
+ let reservableConnectors = 0;
+ for (const [id, connector] of connectors) {
+ if (id === 0) {
+ continue;
+ }
+ if (connector.status === ConnectorStatusEnum.Available) {
+ ++reservableConnectors;
+ }
+ }
+ return reservableConnectors;
+ }
+
+ private getNumberOfReservationsOnConnectorZero(): number {
+ let numberOfReservations = 0;
+ if (this.hasEvses) {
+ for (const evse of this.evses.values()) {
+ if (evse.connectors.get(0)?.reservation) {
+ ++numberOfReservations;
+ }
+ }
+ } else if (this.connectors.get(0)?.reservation) {
+ ++numberOfReservations;
+ }
+ return numberOfReservations;
+ }
+
private flushMessageBuffer(): void {
if (this.messageBuffer.size > 0) {
for (const message of this.messageBuffer.values()) {
return this.stationInfo.supervisionUrlOcppConfiguration ?? false;
}
+ private stopReservationExpiryDateSetInterval(): void {
+ if (this.reservationExpiryDateSetInterval) {
+ clearInterval(this.reservationExpiryDateSetInterval);
+ }
+ }
+
private getSupervisionUrlOcppKey(): string {
return this.stationInfo.supervisionUrlOcppKey ?? VendorParametersKey.ConnectionUrl;
}
this.templateFileHash = template.templateHash;
}
} catch (error) {
- FileUtils.handleFileException(
+ ErrorUtils.handleFileException(
this.templateFile,
FileType.ChargingStationTemplate,
error as NodeJS.ErrnoException,
private getStationInfoFromTemplate(): ChargingStationInfo {
const stationTemplate: ChargingStationTemplate | undefined = this.getTemplateFromFile();
- ChargingStationUtils.checkTemplateFile(stationTemplate, this.logPrefix(), this.templateFile);
+ ChargingStationUtils.checkTemplate(stationTemplate, this.logPrefix(), this.templateFile);
ChargingStationUtils.warnTemplateKeysDeprecation(
stationTemplate,
this.logPrefix(),
}
private handleUnsupportedVersion(version: OCPPVersion) {
- const errorMsg = `Unsupported protocol version '${version}' configured in template file ${this.templateFile}`;
+ const errorMsg = `Unsupported protocol version '${version}' configured
+ in template file ${this.templateFile}`;
logger.error(`${this.logPrefix()} ${errorMsg}`);
throw new BaseError(errorMsg);
}
private initialize(): void {
const stationTemplate = this.getTemplateFromFile();
- ChargingStationUtils.checkTemplateFile(stationTemplate, this.logPrefix(), this.templateFile);
+ ChargingStationUtils.checkTemplate(stationTemplate, this.logPrefix(), this.templateFile);
this.configurationFile = path.join(
path.dirname(this.templateFile.replace('station-templates', 'configurations')),
`${ChargingStationUtils.getHashId(this.index, stationTemplate)}.json`
private getConfigurationFromFile(): ChargingStationConfiguration | undefined {
let configuration: ChargingStationConfiguration | undefined;
- if (this.configurationFile && fs.existsSync(this.configurationFile)) {
+ if (Utils.isNotEmptyString(this.configurationFile) && fs.existsSync(this.configurationFile)) {
try {
if (this.sharedLRUCache.hasChargingStationConfiguration(this.configurationFileHash)) {
configuration = this.sharedLRUCache.getChargingStationConfiguration(
this.configurationFileHash = configuration.configurationHash;
}
} catch (error) {
- FileUtils.handleFileException(
+ ErrorUtils.handleFileException(
this.configurationFile,
FileType.ChargingStationConfiguration,
error as NodeJS.ErrnoException,
return configuration;
}
- private saveChargingStationAutomaticTransactionGeneratorConfiguration(
- stationTemplate?: ChargingStationTemplate
- ): void {
- this.saveConfiguration({
- automaticTransactionGenerator: (stationTemplate ?? this.getTemplateFromFile())
- .AutomaticTransactionGenerator,
- ...(!Utils.isNullOrUndefined(this.automaticTransactionGenerator?.connectorsStatus) && {
- automaticTransactionGeneratorStatuses: [
- ...this.automaticTransactionGenerator.connectorsStatus.values(),
- ],
- }),
- });
+ private saveChargingStationAutomaticTransactionGeneratorConfiguration(): void {
+ this.saveConfiguration();
}
private saveConnectorsStatus() {
this.saveConfiguration();
}
- private saveConfiguration(
- chargingStationAutomaticTransactionGeneratorConfiguration?: ChargingStationAutomaticTransactionGeneratorConfiguration
- ): void {
- if (this.configurationFile) {
+ private saveConfiguration(): void {
+ if (Utils.isNotEmptyString(this.configurationFile)) {
try {
if (!fs.existsSync(path.dirname(this.configurationFile))) {
fs.mkdirSync(path.dirname(this.configurationFile), { recursive: true });
if (this.getOcppPersistentConfiguration() && this.ocppConfiguration?.configurationKey) {
configurationData.configurationKey = this.ocppConfiguration.configurationKey;
}
- if (chargingStationAutomaticTransactionGeneratorConfiguration) {
- configurationData = merge<ChargingStationConfiguration>(
- configurationData,
- chargingStationAutomaticTransactionGeneratorConfiguration
- );
- }
+ configurationData = merge<ChargingStationConfiguration>(
+ configurationData,
+ buildChargingStationAutomaticTransactionGeneratorConfiguration(this)
+ );
if (this.connectors.size > 0) {
- configurationData.connectorsStatus = [...this.connectors.values()].map(
- // eslint-disable-next-line @typescript-eslint/no-unused-vars
- ({ transactionSetInterval, ...connectorStatusRest }) => connectorStatusRest
- );
+ configurationData.connectorsStatus = buildConnectorsStatus(this);
}
if (this.evses.size > 0) {
- configurationData.evsesStatus = [...this.evses.values()].map((evseStatus) => {
- const status = {
- ...evseStatus,
- connectorsStatus: [...evseStatus.connectors.values()].map(
- // eslint-disable-next-line @typescript-eslint/no-unused-vars
- ({ transactionSetInterval, ...connectorStatusRest }) => connectorStatusRest
- ),
- };
- delete status.connectors;
- return status as EvseStatusConfiguration;
- });
+ configurationData.evsesStatus = buildEvsesStatus(this);
}
delete configurationData.configurationHash;
const configurationHash = crypto
.update(JSON.stringify(configurationData))
.digest('hex');
if (this.configurationFileHash !== configurationHash) {
- const asyncLock = AsyncLock.getInstance(AsyncLockType.configuration);
- asyncLock
- .acquire()
+ AsyncLock.acquire(AsyncLockType.configuration)
.then(() => {
configurationData.configurationHash = configurationHash;
const measureId = `${FileType.ChargingStationConfiguration} write`;
this.configurationFileHash = configurationHash;
})
.catch((error) => {
- FileUtils.handleFileException(
+ ErrorUtils.handleFileException(
this.configurationFile,
FileType.ChargingStationConfiguration,
error as NodeJS.ErrnoException,
);
})
.finally(() => {
- asyncLock.release().catch(Constants.EMPTY_FUNCTION);
+ AsyncLock.release(AsyncLockType.configuration).catch(Constants.EMPTY_FUNCTION);
});
} else {
logger.debug(
);
}
} catch (error) {
- FileUtils.handleFileException(
+ ErrorUtils.handleFileException(
this.configurationFile,
FileType.ChargingStationConfiguration,
error as NodeJS.ErrnoException,
}
private getOcppConfigurationFromFile(): ChargingStationOcppConfiguration | undefined {
- if (this.getOcppPersistentConfiguration() === true) {
- return { configurationKey: this.getConfigurationFromFile()?.configurationKey };
+ const configurationKey = this.getConfigurationFromFile()?.configurationKey;
+ if (this.getOcppPersistentConfiguration() === true && configurationKey) {
+ return { configurationKey };
}
+ return undefined;
}
private getOcppConfiguration(): ChargingStationOcppConfiguration | undefined {
skipBufferingOnError: true,
});
if (this.isRegistered() === false) {
- this.getRegistrationMaxRetries() !== -1 && registrationRetryCount++;
+ this.getRegistrationMaxRetries() !== -1 && ++registrationRetryCount;
await Utils.sleep(
this?.bootNotificationResponse?.interval
? this.bootNotificationResponse.interval * 1000
- : Constants.OCPP_DEFAULT_BOOT_NOTIFICATION_INTERVAL
+ : Constants.DEFAULT_BOOT_NOTIFICATION_INTERVAL
);
}
} while (
);
}
if (this.isRegistered() === true) {
- if (this.isInAcceptedState() === true) {
+ if (this.inAcceptedState() === true) {
await this.startMessageSequence();
}
} else {
await OCPPServiceUtils.sendAndSetConnectorStatus(
this,
connectorId,
- connectorBootStatus
+ connectorBootStatus,
+ evseId
);
}
}
OCPPServiceUtils.buildStatusNotificationRequest(
this,
connectorId,
- ConnectorStatusEnum.Unavailable
+ ConnectorStatusEnum.Unavailable,
+ evseId
)
);
delete connectorStatus?.status;
}
private getConfiguredSupervisionUrl(): URL {
+ let configuredSupervisionUrl: string;
const supervisionUrls = this.stationInfo?.supervisionUrls ?? Configuration.getSupervisionUrls();
if (Utils.isNotEmptyArray(supervisionUrls)) {
let configuredSupervisionUrlIndex: number;
configuredSupervisionUrlIndex = (this.index - 1) % supervisionUrls.length;
break;
}
- return new URL(supervisionUrls[configuredSupervisionUrlIndex]);
+ configuredSupervisionUrl = supervisionUrls[configuredSupervisionUrlIndex];
+ } else {
+ configuredSupervisionUrl = supervisionUrls as string;
+ }
+ if (Utils.isNotEmptyString(configuredSupervisionUrl)) {
+ return new URL(configuredSupervisionUrl);
}
- return new URL(supervisionUrls as string);
+ const errorMsg = 'No supervision url(s) configured';
+ logger.error(`${this.logPrefix()} ${errorMsg}`);
+ throw new BaseError(`${errorMsg}`);
}
private stopHeartbeat(): void {
this.autoReconnectRetryCount < this.getAutoReconnectMaxRetries() ||
this.getAutoReconnectMaxRetries() === -1
) {
- this.autoReconnectRetryCount++;
+ ++this.autoReconnectRetryCount;
const reconnectDelay = this.getReconnectExponentialDelay()
? Utils.exponentialDelay(this.autoReconnectRetryCount)
: this.getConnectionTimeout() * 1000;
repositories / e-mobility-charging-stations-simulator.git / blobdiff