// Partial Copyright Jerome Benoit. 2021-2023. All Rights Reserved.
import { createHash } from 'node:crypto';
-import {
- type FSWatcher,
- closeSync,
- existsSync,
- mkdirSync,
- openSync,
- readFileSync,
- writeFileSync,
-} from 'node:fs';
+import { EventEmitter } from 'node:events';
+import { type FSWatcher, existsSync, mkdirSync, readFileSync, writeFileSync } from 'node:fs';
import { dirname, join } from 'node:path';
import { URL } from 'node:url';
import { parentPort } from 'node:worker_threads';
} from './ConfigurationKeyUtils';
import {
buildConnectorsMap,
+ checkChargingStation,
checkConnectorsConfiguration,
checkStationInfoConnectorStatus,
checkTemplate,
type BootNotificationResponse,
type CachedRequest,
type ChargingStationConfiguration,
+ ChargingStationEvents,
type ChargingStationInfo,
type ChargingStationOcppConfiguration,
type ChargingStationTemplate,
SupervisionUrlDistribution,
SupportedFeatureProfiles,
VendorParametersKey,
+ Voltage,
type WSError,
WebSocketCloseEventStatusCode,
type WsOptions,
isUndefined,
logPrefix,
logger,
+ min,
+ once,
roundTo,
secureRandom,
sleep,
watchJsonFile,
} from '../utils';
-export class ChargingStation {
+export class ChargingStation extends EventEmitter {
public readonly index: number;
public readonly templateFile: string;
- public stationInfo!: ChargingStationInfo;
public started: boolean;
public starting: boolean;
public idTagsCache: IdTagsCache;
public automaticTransactionGenerator!: AutomaticTransactionGenerator | undefined;
public ocppConfiguration!: ChargingStationOcppConfiguration | undefined;
- public wsConnection!: WebSocket | null;
+ public wsConnection: WebSocket | null;
public readonly connectors: Map<number, ConnectorStatus>;
public readonly evses: Map<number, EvseStatus>;
public readonly requests: Map<string, CachedRequest>;
public bootNotificationRequest!: BootNotificationRequest;
public bootNotificationResponse!: BootNotificationResponse | undefined;
public powerDivider!: number;
+ private internalStationInfo!: ChargingStationInfo;
private stopping: boolean;
private configurationFile!: string;
private configurationFileHash!: string;
private ocppIncomingRequestService!: OCPPIncomingRequestService;
private readonly messageBuffer: Set<string>;
private configuredSupervisionUrl!: URL;
- private wsConnectionRestarted: boolean;
private autoReconnectRetryCount: number;
private templateFileWatcher!: FSWatcher | undefined;
private templateFileHash!: string;
private reservationExpirationSetInterval?: NodeJS.Timeout;
constructor(index: number, templateFile: string) {
+ super();
this.started = false;
this.starting = false;
this.stopping = false;
- this.wsConnectionRestarted = false;
+ this.wsConnection = null;
this.autoReconnectRetryCount = 0;
this.index = index;
this.templateFile = templateFile;
this.idTagsCache = IdTagsCache.getInstance();
this.chargingStationWorkerBroadcastChannel = new ChargingStationWorkerBroadcastChannel(this);
+ this.on(ChargingStationEvents.started, () => {
+ parentPort?.postMessage(buildStartedMessage(this));
+ });
+ this.on(ChargingStationEvents.stopped, () => {
+ parentPort?.postMessage(buildStoppedMessage(this));
+ });
+ this.on(ChargingStationEvents.updated, () => {
+ parentPort?.postMessage(buildUpdatedMessage(this));
+ });
+
this.initialize();
}
return this.connectors.size === 0 && this.evses.size > 0;
}
+ public get stationInfo(): ChargingStationInfo {
+ return {
+ ...{
+ enableStatistics: false,
+ remoteAuthorization: true,
+ currentOutType: CurrentType.AC,
+ mainVoltageMeterValues: true,
+ phaseLineToLineVoltageMeterValues: false,
+ customValueLimitationMeterValues: true,
+ ocppStrictCompliance: true,
+ outOfOrderEndMeterValues: false,
+ beginEndMeterValues: false,
+ meteringPerTransaction: true,
+ transactionDataMeterValues: false,
+ supervisionUrlOcppConfiguration: false,
+ supervisionUrlOcppKey: VendorParametersKey.ConnectionUrl,
+ ocppVersion: OCPPVersion.VERSION_16,
+ ocppPersistentConfiguration: true,
+ stationInfoPersistentConfiguration: true,
+ automaticTransactionGeneratorPersistentConfiguration: true,
+ autoReconnectMaxRetries: -1,
+ registrationMaxRetries: -1,
+ reconnectExponentialDelay: false,
+ stopTransactionsOnStopped: true,
+ },
+ ...this.internalStationInfo,
+ };
+ }
+
private get wsConnectionUrl(): URL {
return new URL(
`${
- this.getSupervisionUrlOcppConfiguration() &&
- isNotEmptyString(this.getSupervisionUrlOcppKey()) &&
- isNotEmptyString(getConfigurationKey(this, this.getSupervisionUrlOcppKey())?.value)
- ? getConfigurationKey(this, this.getSupervisionUrlOcppKey())!.value
+ this.stationInfo?.supervisionUrlOcppConfiguration === true &&
+ isNotEmptyString(this.stationInfo?.supervisionUrlOcppKey) &&
+ isNotEmptyString(getConfigurationKey(this, this.stationInfo.supervisionUrlOcppKey!)?.value)
+ ? getConfigurationKey(this, this.stationInfo.supervisionUrlOcppKey!)!.value
: this.configuredSupervisionUrl.href
}/${this.stationInfo.chargingStationId}`,
);
return isNotEmptyArray(this.idTagsCache.getIdTags(getIdTagsFile(this.stationInfo)!));
}
- public getEnableStatistics(): boolean {
- return this.stationInfo.enableStatistics ?? false;
- }
-
- public getRemoteAuthorization(): boolean {
- return this.stationInfo.remoteAuthorization ?? true;
- }
-
public getNumberOfPhases(stationInfo?: ChargingStationInfo): number {
const localStationInfo: ChargingStationInfo = stationInfo ?? this.stationInfo;
switch (this.getCurrentOutType(stationInfo)) {
case CurrentType.AC:
- return !isUndefined(localStationInfo.numberOfPhases) ? localStationInfo.numberOfPhases! : 3;
+ return localStationInfo.numberOfPhases ?? 3;
case CurrentType.DC:
return 0;
}
return this.connectors.get(connectorId);
}
- public getCurrentOutType(stationInfo?: ChargingStationInfo): CurrentType {
- return (stationInfo ?? this.stationInfo)?.currentOutType ?? CurrentType.AC;
- }
-
- public getOcppStrictCompliance(): boolean {
- return this.stationInfo?.ocppStrictCompliance ?? true;
- }
-
- public getVoltageOut(stationInfo?: ChargingStationInfo): number {
- const defaultVoltageOut = getDefaultVoltageOut(
- this.getCurrentOutType(stationInfo),
- this.logPrefix(),
- this.templateFile,
- );
- return (stationInfo ?? this.stationInfo).voltageOut ?? defaultVoltageOut;
- }
-
- public getMaximumPower(stationInfo?: ChargingStationInfo): number {
- const localStationInfo = stationInfo ?? this.stationInfo;
- // eslint-disable-next-line @typescript-eslint/dot-notation
- return (
- (localStationInfo['maxPower' as keyof ChargingStationInfo] as number) ??
- localStationInfo.maximumPower
- );
- }
-
public getConnectorMaximumAvailablePower(connectorId: number): number {
let connectorAmperageLimitationPowerLimit: number | undefined;
if (
this.getAmperageLimitation()! < this.stationInfo.maximumAmperage!
) {
connectorAmperageLimitationPowerLimit =
- (this.getCurrentOutType() === CurrentType.AC
+ (this.stationInfo?.currentOutType === CurrentType.AC
? ACElectricUtils.powerTotal(
this.getNumberOfPhases(),
- this.getVoltageOut(),
+ this.stationInfo.voltageOut!,
this.getAmperageLimitation()! *
(this.hasEvses ? this.getNumberOfEvses() : this.getNumberOfConnectors()),
)
- : DCElectricUtils.power(this.getVoltageOut(), this.getAmperageLimitation()!)) /
+ : DCElectricUtils.power(this.stationInfo.voltageOut!, this.getAmperageLimitation()!)) /
this.powerDivider;
}
- const connectorMaximumPower = this.getMaximumPower() / this.powerDivider;
+ const connectorMaximumPower = this.stationInfo.maximumPower! / this.powerDivider;
const connectorChargingProfilesPowerLimit =
getChargingStationConnectorChargingProfilesPowerLimit(this, connectorId);
- return Math.min(
+ return min(
isNaN(connectorMaximumPower) ? Infinity : connectorMaximumPower,
isNaN(connectorAmperageLimitationPowerLimit!)
? Infinity
return numberOfRunningTransactions;
}
- public getOutOfOrderEndMeterValues(): boolean {
- return this.stationInfo?.outOfOrderEndMeterValues ?? false;
- }
-
- public getBeginEndMeterValues(): boolean {
- return this.stationInfo?.beginEndMeterValues ?? false;
- }
-
- public getMeteringPerTransaction(): boolean {
- return this.stationInfo?.meteringPerTransaction ?? true;
- }
-
- public getTransactionDataMeterValues(): boolean {
- return this.stationInfo?.transactionDataMeterValues ?? false;
- }
-
- public getMainVoltageMeterValues(): boolean {
- return this.stationInfo?.mainVoltageMeterValues ?? true;
- }
-
- public getPhaseLineToLineVoltageMeterValues(): boolean {
- return this.stationInfo?.phaseLineToLineVoltageMeterValues ?? false;
- }
-
- public getCustomValueLimitationMeterValues(): boolean {
- return this.stationInfo?.customValueLimitationMeterValues ?? true;
- }
-
public getConnectorIdByTransactionId(transactionId: number): number | undefined {
if (this.hasEvses) {
for (const evseStatus of this.evses.values()) {
this,
StandardParametersKey.AuthorizeRemoteTxRequests,
);
- return authorizeRemoteTxRequests ? convertToBoolean(authorizeRemoteTxRequests.value) : false;
+ return authorizeRemoteTxRequests !== undefined
+ ? convertToBoolean(authorizeRemoteTxRequests.value)
+ : false;
}
public getLocalAuthListEnabled(): boolean {
this,
StandardParametersKey.LocalAuthListEnabled,
);
- return localAuthListEnabled ? convertToBoolean(localAuthListEnabled.value) : false;
+ return localAuthListEnabled !== undefined
+ ? convertToBoolean(localAuthListEnabled.value)
+ : false;
}
public getHeartbeatInterval(): number {
const HeartbeatInterval = getConfigurationKey(this, StandardParametersKey.HeartbeatInterval);
- if (HeartbeatInterval) {
+ if (HeartbeatInterval !== undefined) {
return secondsToMilliseconds(convertToInt(HeartbeatInterval.value));
}
const HeartBeatInterval = getConfigurationKey(this, StandardParametersKey.HeartBeatInterval);
- if (HeartBeatInterval) {
+ if (HeartBeatInterval !== undefined) {
return secondsToMilliseconds(convertToInt(HeartBeatInterval.value));
}
this.stationInfo?.autoRegister === false &&
public setSupervisionUrl(url: string): void {
if (
- this.getSupervisionUrlOcppConfiguration() &&
- isNotEmptyString(this.getSupervisionUrlOcppKey())
+ this.stationInfo?.supervisionUrlOcppConfiguration === true &&
+ isNotEmptyString(this.stationInfo?.supervisionUrlOcppKey)
) {
- setConfigurationKeyValue(this, this.getSupervisionUrlOcppKey(), url);
+ setConfigurationKeyValue(this, this.stationInfo.supervisionUrlOcppKey!, url);
} else {
this.stationInfo.supervisionUrls = url;
this.saveStationInfo();
);
} 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)?.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 (
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.started === false) {
if (this.starting === false) {
this.starting = true;
- if (this.getEnableStatistics() === true) {
+ if (this.stationInfo?.enableStatistics === true) {
this.performanceStatistics?.start();
}
if (hasFeatureProfile(this, SupportedFeatureProfiles.Reservation)) {
// Restart the ATG
this.stopAutomaticTransactionGenerator();
delete this.automaticTransactionGeneratorConfiguration;
- if (this.getAutomaticTransactionGeneratorConfiguration()?.enable === true) {
+ if (this.getAutomaticTransactionGeneratorConfiguration().enable === true) {
this.startAutomaticTransactionGenerator();
}
- if (this.getEnableStatistics() === true) {
+ if (this.stationInfo?.enableStatistics === true) {
this.performanceStatistics?.restart();
} else {
this.performanceStatistics?.stop();
},
);
this.started = true;
- parentPort?.postMessage(buildStartedMessage(this));
+ this.emit(ChargingStationEvents.started);
this.starting = false;
} else {
logger.warn(`${this.logPrefix()} Charging station is already starting...`);
}
}
- public async stop(reason?: StopTransactionReason): Promise<void> {
+ public async stop(reason?: StopTransactionReason, stopTransactions?: boolean): Promise<void> {
if (this.started === true) {
if (this.stopping === false) {
this.stopping = true;
- await this.stopMessageSequence(reason);
+ await this.stopMessageSequence(reason, stopTransactions);
this.closeWSConnection();
- if (this.getEnableStatistics() === true) {
+ if (this.stationInfo?.enableStatistics === true) {
this.performanceStatistics?.stop();
}
if (hasFeatureProfile(this, SupportedFeatureProfiles.Reservation)) {
delete this.bootNotificationResponse;
this.started = false;
this.saveConfiguration();
- parentPort?.postMessage(buildStoppedMessage(this));
+ this.emit(ChargingStationEvents.stopped);
this.stopping = false;
} else {
logger.warn(`${this.logPrefix()} Charging station is already stopping...`);
}
public saveOcppConfiguration(): void {
- if (this.getOcppPersistentConfiguration()) {
+ if (this.stationInfo?.ocppPersistentConfiguration === true) {
this.saveConfiguration();
}
}
}
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: secondsToMilliseconds(this.getConnectionTimeout()), ...options };
+ options = {
+ handshakeTimeout: secondsToMilliseconds(this.getConnectionTimeout()),
+ ...this.stationInfo?.wsOptions,
+ ...options,
+ };
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`,
- );
+ if (!checkChargingStation(this, this.logPrefix())) {
return;
}
if (
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;
}
this.wsConnection = new WebSocket(
this.wsConnectionUrl,
- `ocpp${this.stationInfo.ocppVersion ?? OCPPVersion.VERSION_16}`,
+ `ocpp${this.stationInfo?.ocppVersion}`,
options,
);
let automaticTransactionGeneratorConfiguration:
| AutomaticTransactionGeneratorConfiguration
| undefined;
- const automaticTransactionGeneratorConfigurationFromFile =
- this.getConfigurationFromFile()?.automaticTransactionGenerator;
+ const stationTemplate = this.getTemplateFromFile();
+ const stationConfiguration = this.getConfigurationFromFile();
if (
- this.getAutomaticTransactionGeneratorPersistentConfiguration() &&
- automaticTransactionGeneratorConfigurationFromFile
+ this.stationInfo?.automaticTransactionGeneratorPersistentConfiguration === true &&
+ stationConfiguration?.stationInfo?.templateHash === stationTemplate?.templateHash &&
+ stationConfiguration?.automaticTransactionGenerator
) {
automaticTransactionGeneratorConfiguration =
- automaticTransactionGeneratorConfigurationFromFile;
+ stationConfiguration?.automaticTransactionGenerator;
} else {
- automaticTransactionGeneratorConfiguration =
- this.getTemplateFromFile()?.AutomaticTransactionGenerator;
+ automaticTransactionGeneratorConfiguration = stationTemplate?.AutomaticTransactionGenerator;
}
this.automaticTransactionGeneratorConfiguration = {
...Constants.DEFAULT_ATG_CONFIGURATION,
this.automaticTransactionGenerator?.start();
}
this.saveAutomaticTransactionGeneratorConfiguration();
- parentPort?.postMessage(buildUpdatedMessage(this));
+ this.emit(ChargingStationEvents.updated);
}
public stopAutomaticTransactionGenerator(connectorIds?: number[]): void {
this.automaticTransactionGenerator?.stop();
}
this.saveAutomaticTransactionGeneratorConfiguration();
- parentPort?.postMessage(buildUpdatedMessage(this));
+ this.emit(ChargingStationEvents.updated);
}
public async stopTransactionOnConnector(
connectorId: number,
- reason = StopTransactionReason.NONE,
+ reason?: StopTransactionReason,
): Promise<StopTransactionResponse> {
const transactionId = this.getConnectorStatus(connectorId)?.transactionId;
if (
- this.getBeginEndMeterValues() === true &&
- this.getOcppStrictCompliance() === true &&
- this.getOutOfOrderEndMeterValues() === false
+ this.stationInfo?.beginEndMeterValues === true &&
+ this.stationInfo?.ocppStrictCompliance === true &&
+ this.stationInfo?.outOfOrderEndMeterValues === false
) {
// FIXME: Implement OCPP version agnostic helpers
const transactionEndMeterValue = OCPP16ServiceUtils.buildTransactionEndMeterValue(
{
transactionId,
meterStop: this.getEnergyActiveImportRegisterByTransactionId(transactionId!, true),
- reason,
+ ...(isNullOrUndefined(reason) && { reason }),
},
);
}
public async addReservation(reservation: Reservation): Promise<void> {
const reservationFound = this.getReservationBy('reservationId', reservation.reservationId);
- if (!isUndefined(reservationFound)) {
- await this.removeReservation(
- reservationFound!,
- ReservationTerminationReason.REPLACE_EXISTING,
- );
+ if (reservationFound !== undefined) {
+ await this.removeReservation(reservationFound, ReservationTerminationReason.REPLACE_EXISTING);
}
this.getConnectorStatus(reservation.connectorId)!.reservation = reservation;
await OCPPServiceUtils.sendAndSetConnectorStatus(
}
private startReservationExpirationSetInterval(customInterval?: number): void {
- const interval =
- customInterval ?? Constants.DEFAULT_RESERVATION_EXPIRATION_OBSERVATION_INTERVAL;
+ const interval = customInterval ?? Constants.DEFAULT_RESERVATION_EXPIRATION_INTERVAL;
if (interval > 0) {
logger.info(
`${this.logPrefix()} Reservation expiration date checks started every ${formatDurationMilliSeconds(
}
private stopReservationExpirationSetInterval(): void {
- if (this.reservationExpirationSetInterval) {
+ if (!isNullOrUndefined(this.reservationExpirationSetInterval)) {
clearInterval(this.reservationExpirationSetInterval);
}
}
[, , commandName] = JSON.parse(message) as OutgoingRequest;
beginId = PerformanceStatistics.beginMeasure(commandName);
}
- this.wsConnection?.send(message);
- isRequest && PerformanceStatistics.endMeasure(commandName!, beginId!);
- logger.debug(
- `${this.logPrefix()} >> Buffered ${OCPPServiceUtils.getMessageTypeString(
- messageType,
- )} payload sent: ${message}`,
- );
- this.messageBuffer.delete(message);
+ this.wsConnection?.send(message, (error?: Error) => {
+ isRequest && PerformanceStatistics.endMeasure(commandName!, beginId!);
+ if (isNullOrUndefined(error)) {
+ logger.debug(
+ `${this.logPrefix()} >> Buffered ${OCPPServiceUtils.getMessageTypeString(
+ messageType,
+ )} payload sent: ${message}`,
+ );
+ this.messageBuffer.delete(message);
+ }
+ });
}
}
}
- private getSupervisionUrlOcppConfiguration(): boolean {
- return this.stationInfo.supervisionUrlOcppConfiguration ?? false;
- }
-
- private getSupervisionUrlOcppKey(): string {
- return this.stationInfo.supervisionUrlOcppKey ?? VendorParametersKey.ConnectionUrl;
- }
-
private getTemplateFromFile(): ChargingStationTemplate | undefined {
let template: ChargingStationTemplate | undefined;
try {
private getStationInfoFromTemplate(): ChargingStationInfo {
const stationTemplate: ChargingStationTemplate = this.getTemplateFromFile()!;
checkTemplate(stationTemplate, this.logPrefix(), this.templateFile);
- warnTemplateKeysDeprecation(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);
}
stationInfo.chargingStationId = getChargingStationId(this.index, stationTemplate);
stationInfo.ocppVersion = stationTemplate?.ocppVersion ?? OCPPVersion.VERSION_16;
createSerialNumber(stationTemplate, stationInfo);
+ stationInfo.voltageOut = this.getVoltageOut(stationInfo);
if (isNotEmptyArray(stationTemplate?.power)) {
stationTemplate.power = stationTemplate.power as number[];
const powerArrayRandomIndex = Math.floor(secureRandom() * stationTemplate.power.length);
? stationTemplate.power * 1000
: stationTemplate.power;
}
+ stationInfo.maximumAmperage = this.getMaximumAmperage(stationInfo);
stationInfo.firmwareVersionPattern =
stationTemplate?.firmwareVersionPattern ?? Constants.SEMVER_PATTERN;
if (
stationInfo.resetTime = !isNullOrUndefined(stationTemplate?.resetTime)
? secondsToMilliseconds(stationTemplate.resetTime!)
: Constants.CHARGING_STATION_DEFAULT_RESET_TIME;
- stationInfo.maximumAmperage = this.getMaximumAmperage(stationInfo);
return stationInfo;
}
private getStationInfoFromFile(): ChargingStationInfo | undefined {
let stationInfo: ChargingStationInfo | undefined;
- if (this.getStationInfoPersistentConfiguration()) {
+ if (this.stationInfo?.stationInfoPersistentConfiguration === true) {
stationInfo = this.getConfigurationFromFile()?.stationInfo;
if (stationInfo) {
delete stationInfo?.infoHash;
}
private saveStationInfo(): void {
- if (this.getStationInfoPersistentConfiguration()) {
+ if (this.stationInfo?.stationInfoPersistentConfiguration === true) {
this.saveConfiguration();
}
}
- private getOcppPersistentConfiguration(): boolean {
- return this.stationInfo?.ocppPersistentConfiguration ?? true;
- }
-
- private getStationInfoPersistentConfiguration(): boolean {
- return this.stationInfo?.stationInfoPersistentConfiguration ?? true;
- }
-
- private getAutomaticTransactionGeneratorPersistentConfiguration(): boolean {
- return this.stationInfo?.automaticTransactionGeneratorPersistentConfiguration ?? true;
- }
-
- private handleUnsupportedVersion(version: OCPPVersion) {
- const errorMsg = `Unsupported protocol version '${version}' configured
- in template file ${this.templateFile}`;
+ private handleUnsupportedVersion(version: OCPPVersion | undefined) {
+ const errorMsg = `Unsupported protocol version '${version}' configured in template file ${this.templateFile}`;
logger.error(`${this.logPrefix()} ${errorMsg}`);
throw new BaseError(errorMsg);
}
dirname(this.templateFile.replace('station-templates', 'configurations')),
`${getHashId(this.index, stationTemplate)}.json`,
);
- const chargingStationConfiguration = this.getConfigurationFromFile();
+ const stationConfiguration = this.getConfigurationFromFile();
if (
- chargingStationConfiguration?.stationInfo?.templateHash === stationTemplate?.templateHash &&
+ stationConfiguration?.stationInfo?.templateHash === stationTemplate?.templateHash &&
// eslint-disable-next-line @typescript-eslint/prefer-nullish-coalescing
- (chargingStationConfiguration?.connectorsStatus || chargingStationConfiguration?.evsesStatus)
+ (stationConfiguration?.connectorsStatus || stationConfiguration?.evsesStatus)
) {
- this.initializeConnectorsOrEvsesFromFile(chargingStationConfiguration);
+ this.initializeConnectorsOrEvsesFromFile(stationConfiguration);
} else {
this.initializeConnectorsOrEvsesFromTemplate(stationTemplate);
}
- this.stationInfo = this.getStationInfo();
+ this.internalStationInfo = this.getStationInfo();
if (
this.stationInfo.firmwareStatus === FirmwareStatus.Installing &&
isNotEmptyString(this.stationInfo.firmwareVersion) &&
}
this.saveStationInfo();
this.configuredSupervisionUrl = this.getConfiguredSupervisionUrl();
- if (this.getEnableStatistics() === true) {
+ if (this.stationInfo?.enableStatistics === true) {
this.performanceStatistics = PerformanceStatistics.getInstance(
this.stationInfo.hashId,
this.stationInfo.chargingStationId!,
this.ocppConfiguration = this.getOcppConfiguration();
this.initializeOcppConfiguration();
this.initializeOcppServices();
+ this.once(ChargingStationEvents.accepted, () => {
+ this.startMessageSequence().catch((error) => {
+ logger.error(`${this.logPrefix()} Error while starting the message sequence:`, error);
+ });
+ });
if (this.stationInfo?.autoRegister === true) {
this.bootNotificationResponse = {
currentTime: new Date(),
}
private initializeOcppServices(): void {
- const ocppVersion = this.stationInfo.ocppVersion ?? OCPPVersion.VERSION_16;
+ const ocppVersion = this.stationInfo?.ocppVersion;
switch (ocppVersion) {
case OCPPVersion.VERSION_16:
this.ocppIncomingRequestService =
}
private initializeOcppConfiguration(): void {
- if (!getConfigurationKey(this, StandardParametersKey.HeartbeatInterval)) {
+ if (isNullOrUndefined(getConfigurationKey(this, StandardParametersKey.HeartbeatInterval))) {
addConfigurationKey(this, StandardParametersKey.HeartbeatInterval, '0');
}
- if (!getConfigurationKey(this, StandardParametersKey.HeartBeatInterval)) {
+ if (isNullOrUndefined(getConfigurationKey(this, StandardParametersKey.HeartBeatInterval))) {
addConfigurationKey(this, StandardParametersKey.HeartBeatInterval, '0', { visible: false });
}
if (
- this.getSupervisionUrlOcppConfiguration() &&
- isNotEmptyString(this.getSupervisionUrlOcppKey()) &&
- !getConfigurationKey(this, this.getSupervisionUrlOcppKey())
+ this.stationInfo?.supervisionUrlOcppConfiguration === true &&
+ isNotEmptyString(this.stationInfo?.supervisionUrlOcppKey) &&
+ isNullOrUndefined(getConfigurationKey(this, this.stationInfo.supervisionUrlOcppKey!))
) {
addConfigurationKey(
this,
- this.getSupervisionUrlOcppKey(),
+ this.stationInfo.supervisionUrlOcppKey!,
this.configuredSupervisionUrl.href,
{ reboot: true },
);
} else if (
- !this.getSupervisionUrlOcppConfiguration() &&
- isNotEmptyString(this.getSupervisionUrlOcppKey()) &&
- getConfigurationKey(this, this.getSupervisionUrlOcppKey())
+ this.stationInfo?.supervisionUrlOcppConfiguration === false &&
+ isNotEmptyString(this.stationInfo?.supervisionUrlOcppKey) &&
+ !isNullOrUndefined(getConfigurationKey(this, this.stationInfo.supervisionUrlOcppKey!))
) {
- deleteConfigurationKey(this, this.getSupervisionUrlOcppKey(), { save: false });
+ deleteConfigurationKey(this, this.stationInfo.supervisionUrlOcppKey!, { save: false });
}
if (
isNotEmptyString(this.stationInfo?.amperageLimitationOcppKey) &&
- !getConfigurationKey(this, this.stationInfo.amperageLimitationOcppKey!)
+ isNullOrUndefined(getConfigurationKey(this, this.stationInfo.amperageLimitationOcppKey!))
) {
addConfigurationKey(
this,
).toString(),
);
}
- if (!getConfigurationKey(this, StandardParametersKey.SupportedFeatureProfiles)) {
+ if (
+ isNullOrUndefined(getConfigurationKey(this, StandardParametersKey.SupportedFeatureProfiles))
+ ) {
addConfigurationKey(
this,
StandardParametersKey.SupportedFeatureProfiles,
{ readonly: true },
{ overwrite: true },
);
- if (!getConfigurationKey(this, StandardParametersKey.MeterValuesSampledData)) {
+ if (
+ isNullOrUndefined(getConfigurationKey(this, StandardParametersKey.MeterValuesSampledData))
+ ) {
addConfigurationKey(
this,
StandardParametersKey.MeterValuesSampledData,
MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER,
);
}
- if (!getConfigurationKey(this, StandardParametersKey.ConnectorPhaseRotation)) {
+ if (
+ isNullOrUndefined(getConfigurationKey(this, StandardParametersKey.ConnectorPhaseRotation))
+ ) {
const connectorsPhaseRotation: string[] = [];
if (this.hasEvses) {
for (const evseStatus of this.evses.values()) {
connectorsPhaseRotation.toString(),
);
}
- if (!getConfigurationKey(this, StandardParametersKey.AuthorizeRemoteTxRequests)) {
+ if (
+ isNullOrUndefined(getConfigurationKey(this, StandardParametersKey.AuthorizeRemoteTxRequests))
+ ) {
addConfigurationKey(this, StandardParametersKey.AuthorizeRemoteTxRequests, 'true');
}
if (
- !getConfigurationKey(this, StandardParametersKey.LocalAuthListEnabled) &&
+ isNullOrUndefined(getConfigurationKey(this, StandardParametersKey.LocalAuthListEnabled)) &&
getConfigurationKey(this, StandardParametersKey.SupportedFeatureProfiles)?.value?.includes(
SupportedFeatureProfiles.LocalAuthListManagement,
)
) {
addConfigurationKey(this, StandardParametersKey.LocalAuthListEnabled, 'false');
}
- if (!getConfigurationKey(this, StandardParametersKey.ConnectionTimeOut)) {
+ if (isNullOrUndefined(getConfigurationKey(this, StandardParametersKey.ConnectionTimeOut))) {
addConfigurationKey(
this,
StandardParametersKey.ConnectionTimeOut,
for (let connectorId = 0; connectorId <= configuredMaxConnectors; connectorId++) {
if (
connectorId === 0 &&
- (!stationTemplate?.Connectors[connectorId] ||
+ (!stationTemplate?.Connectors?.[connectorId] ||
this.getUseConnectorId0(stationTemplate) === false)
) {
continue;
} 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))
this.evsesConfigurationHash = evsesConfigHash;
const templateMaxEvses = getMaxNumberOfEvses(stationTemplate?.Evses);
if (templateMaxEvses > 0) {
- for (const evse in stationTemplate.Evses) {
- const evseId = convertToInt(evse);
+ for (const evseKey in stationTemplate.Evses) {
+ const evseId = convertToInt(evseKey);
this.evses.set(evseId, {
connectors: buildConnectorsMap(
- stationTemplate?.Evses[evse]?.Connectors,
+ stationTemplate?.Evses[evseKey]?.Connectors,
this.logPrefix(),
this.templateFile,
),
}
private saveAutomaticTransactionGeneratorConfiguration(): void {
- if (this.getAutomaticTransactionGeneratorPersistentConfiguration()) {
+ if (this.stationInfo?.automaticTransactionGeneratorPersistentConfiguration === true) {
this.saveConfiguration();
}
}
let configurationData: ChargingStationConfiguration = this.getConfigurationFromFile()
? cloneObject<ChargingStationConfiguration>(this.getConfigurationFromFile()!)
: {};
- if (this.getStationInfoPersistentConfiguration() && this.stationInfo) {
+ if (this.stationInfo?.stationInfoPersistentConfiguration === true && this.stationInfo) {
configurationData.stationInfo = this.stationInfo;
} else {
delete configurationData.stationInfo;
}
- if (this.getOcppPersistentConfiguration() && this.ocppConfiguration?.configurationKey) {
+ if (
+ this.stationInfo?.ocppPersistentConfiguration === true &&
+ this.ocppConfiguration?.configurationKey
+ ) {
configurationData.configurationKey = this.ocppConfiguration.configurationKey;
} else {
delete configurationData.configurationKey;
buildChargingStationAutomaticTransactionGeneratorConfiguration(this),
);
if (
- !this.getAutomaticTransactionGeneratorPersistentConfiguration() ||
+ !this.stationInfo?.automaticTransactionGeneratorPersistentConfiguration ||
!this.getAutomaticTransactionGeneratorConfiguration()
) {
delete configurationData.automaticTransactionGenerator;
stationInfo: configurationData.stationInfo,
configurationKey: configurationData.configurationKey,
automaticTransactionGenerator: configurationData.automaticTransactionGenerator,
+ ...(this.connectors.size > 0 && {
+ connectorsStatus: configurationData.connectorsStatus,
+ }),
+ ...(this.evses.size > 0 && { evsesStatus: configurationData.evsesStatus }),
} as ChargingStationConfiguration),
)
.digest('hex');
if (this.configurationFileHash !== configurationHash) {
- AsyncLock.acquire(AsyncLockType.configuration)
- .then(() => {
- configurationData.configurationHash = configurationHash;
- const measureId = `${FileType.ChargingStationConfiguration} write`;
- const beginId = PerformanceStatistics.beginMeasure(measureId);
- const fileDescriptor = openSync(this.configurationFile, 'w');
- writeFileSync(fileDescriptor, JSON.stringify(configurationData, null, 2), 'utf8');
- closeSync(fileDescriptor);
- 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(),
- );
- })
- .finally(() => {
- AsyncLock.release(AsyncLockType.configuration).catch(Constants.EMPTY_FUNCTION);
- });
+ AsyncLock.runExclusive(AsyncLockType.configuration, () => {
+ configurationData.configurationHash = configurationHash;
+ const measureId = `${FileType.ChargingStationConfiguration} write`;
+ const beginId = PerformanceStatistics.beginMeasure(measureId);
+ writeFileSync(
+ this.configurationFile,
+ JSON.stringify(configurationData, undefined, 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 ${
private getOcppConfigurationFromFile(): ChargingStationOcppConfiguration | undefined {
const configurationKey = this.getConfigurationFromFile()?.configurationKey;
- if (this.getOcppPersistentConfiguration() === true && configurationKey) {
+ if (this.stationInfo?.ocppPersistentConfiguration === true && configurationKey) {
return { configurationKey };
}
return undefined;
logger.info(
`${this.logPrefix()} Connection to OCPP server through ${this.wsConnectionUrl.toString()} succeeded`,
);
+ let registrationRetryCount = 0;
if (this.isRegistered() === false) {
// Send BootNotification
- let registrationRetryCount = 0;
do {
this.bootNotificationResponse = await this.ocppRequestService.requestHandler<
BootNotificationRequest,
skipBufferingOnError: true,
});
if (this.isRegistered() === false) {
- this.getRegistrationMaxRetries() !== -1 && ++registrationRetryCount;
+ this.stationInfo?.registrationMaxRetries !== -1 && ++registrationRetryCount;
await sleep(
this?.bootNotificationResponse?.interval
? secondsToMilliseconds(this.bootNotificationResponse.interval)
}
} while (
this.isRegistered() === false &&
- (registrationRetryCount <= this.getRegistrationMaxRetries()! ||
- this.getRegistrationMaxRetries() === -1)
+ (registrationRetryCount <= this.stationInfo.registrationMaxRetries! ||
+ this.stationInfo?.registrationMaxRetries === -1)
);
}
if (this.isRegistered() === true) {
+ this.emit(ChargingStationEvents.registered);
if (this.inAcceptedState() === true) {
- await this.startMessageSequence();
+ this.emit(ChargingStationEvents.accepted);
}
} else {
logger.error(
- `${this.logPrefix()} Registration failure: max retries reached (${this.getRegistrationMaxRetries()}) or retry disabled (${this.getRegistrationMaxRetries()})`,
+ `${this.logPrefix()} Registration failure: maximum retries reached (${registrationRetryCount}) or retry disabled (${this
+ .stationInfo?.registrationMaxRetries})`,
);
}
- this.wsConnectionRestarted = false;
this.autoReconnectRetryCount = 0;
- parentPort?.postMessage(buildUpdatedMessage(this));
+ this.emit(ChargingStationEvents.updated);
} else {
logger.warn(
`${this.logPrefix()} Connection to OCPP server through ${this.wsConnectionUrl.toString()} failed`,
}
}
- private async onClose(code: number, reason: Buffer): Promise<void> {
+ private async onClose(code: WebSocketCloseEventStatusCode, reason: Buffer): Promise<void> {
switch (code) {
// Normal close
case WebSocketCloseEventStatusCode.CLOSE_NORMAL:
this.started === true && (await this.reconnect());
break;
}
- parentPort?.postMessage(buildUpdatedMessage(this));
+ this.emit(ChargingStationEvents.updated);
}
private getCachedRequest(messageType: MessageType, messageId: string): CachedRequest | undefined {
private async handleIncomingMessage(request: IncomingRequest): Promise<void> {
const [messageType, messageId, commandName, commandPayload] = request;
- if (this.getEnableStatistics() === true) {
+ if (this.stationInfo?.enableStatistics === true) {
this.performanceStatistics?.addRequestStatistic(commandName, messageType);
}
logger.debug(
commandName,
commandPayload,
);
+ this.emit(ChargingStationEvents.updated);
}
private handleResponseMessage(response: Response): void {
private async onMessage(data: RawData): Promise<void> {
let request: IncomingRequest | Response | ErrorResponse | undefined;
- let messageType: number | undefined;
+ let messageType: MessageType | undefined;
let errorMsg: string;
try {
// eslint-disable-next-line @typescript-eslint/no-base-to-string
logger.error(`${this.logPrefix()} ${errorMsg}`);
throw new OCPPError(ErrorType.PROTOCOL_ERROR, errorMsg);
}
- parentPort?.postMessage(buildUpdatedMessage(this));
} else {
throw new OCPPError(
ErrorType.PROTOCOL_ERROR,
}
private getEnergyActiveImportRegister(connectorStatus: ConnectorStatus, rounded = false): number {
- if (this.getMeteringPerTransaction() === true) {
+ if (this.stationInfo?.meteringPerTransaction === true) {
return (
(rounded === true
? Math.round(connectorStatus.transactionEnergyActiveImportRegisterValue!)
return stationTemplate?.useConnectorId0 ?? true;
}
- private async stopRunningTransactions(reason = StopTransactionReason.NONE): Promise<void> {
+ private async stopRunningTransactions(reason?: StopTransactionReason): Promise<void> {
if (this.hasEvses) {
for (const [evseId, evseStatus] of this.evses) {
if (evseId === 0) {
// 0 for disabling
private getConnectionTimeout(): number {
- if (getConfigurationKey(this, StandardParametersKey.ConnectionTimeOut)) {
- return (
- parseInt(getConfigurationKey(this, StandardParametersKey.ConnectionTimeOut)!.value!) ??
- Constants.DEFAULT_CONNECTION_TIMEOUT
+ if (getConfigurationKey(this, StandardParametersKey.ConnectionTimeOut) !== undefined) {
+ return convertToInt(
+ getConfigurationKey(this, StandardParametersKey.ConnectionTimeOut)!.value! ??
+ Constants.DEFAULT_CONNECTION_TIMEOUT,
);
}
return Constants.DEFAULT_CONNECTION_TIMEOUT;
}
- // -1 for unlimited, 0 for disabling
- private getAutoReconnectMaxRetries(): number | undefined {
- return (
- this.stationInfo.autoReconnectMaxRetries ?? Configuration.getAutoReconnectMaxRetries() ?? -1
- );
- }
-
- // 0 for disabling
- private getRegistrationMaxRetries(): number | undefined {
- return this.stationInfo.registrationMaxRetries ?? -1;
- }
-
private getPowerDivider(): number {
let powerDivider = this.hasEvses ? this.getNumberOfEvses() : this.getNumberOfConnectors();
- if (this.stationInfo?.powerSharedByConnectors) {
+ if (this.stationInfo?.powerSharedByConnectors === true) {
powerDivider = this.getNumberOfRunningTransactions();
}
return powerDivider;
}
}
+ private getMaximumPower(stationInfo?: ChargingStationInfo): number {
+ return (stationInfo ?? this.stationInfo).maximumPower!;
+ }
+
+ private getCurrentOutType(stationInfo?: ChargingStationInfo): CurrentType {
+ return (stationInfo ?? this.stationInfo).currentOutType ?? CurrentType.AC;
+ }
+
+ private getVoltageOut(stationInfo?: ChargingStationInfo): Voltage {
+ return (
+ (stationInfo ?? this.stationInfo).voltageOut ??
+ getDefaultVoltageOut(this.getCurrentOutType(stationInfo), this.logPrefix(), this.templateFile)
+ );
+ }
+
private getAmperageLimitation(): number | undefined {
if (
isNotEmptyString(this.stationInfo?.amperageLimitationOcppKey) &&
- getConfigurationKey(this, this.stationInfo.amperageLimitationOcppKey!)
+ getConfigurationKey(this, this.stationInfo.amperageLimitationOcppKey!) !== undefined
) {
return (
convertToInt(
}
// Start the ATG
- if (this.getAutomaticTransactionGeneratorConfiguration()?.enable === true) {
+ if (this.getAutomaticTransactionGeneratorConfiguration().enable === true) {
this.startAutomaticTransactionGenerator();
}
- this.wsConnectionRestarted === true && this.flushMessageBuffer();
+ this.flushMessageBuffer();
}
private async stopMessageSequence(
- reason: StopTransactionReason = StopTransactionReason.NONE,
+ reason?: StopTransactionReason,
+ stopTransactions = this.stationInfo?.stopTransactionsOnStopped,
): Promise<void> {
// Stop WebSocket ping
this.stopWebSocketPing();
// Stop heartbeat
this.stopHeartbeat();
- // Stop ongoing transactions
+ // Stop the ATG
if (this.automaticTransactionGenerator?.started === true) {
this.stopAutomaticTransactionGenerator();
- } else {
- await this.stopRunningTransactions(reason);
}
+ // Stop ongoing transactions
+ stopTransactions && (await this.stopRunningTransactions(reason));
if (this.hasEvses) {
for (const [evseId, evseStatus] of this.evses) {
if (evseId > 0) {
}
private startWebSocketPing(): void {
- const webSocketPingInterval: number = getConfigurationKey(
- this,
- StandardParametersKey.WebSocketPingInterval,
- )
- ? convertToInt(getConfigurationKey(this, StandardParametersKey.WebSocketPingInterval)?.value)
- : 0;
+ const webSocketPingInterval: number =
+ getConfigurationKey(this, StandardParametersKey.WebSocketPingInterval) !== undefined
+ ? convertToInt(
+ getConfigurationKey(this, StandardParametersKey.WebSocketPingInterval)?.value,
+ )
+ : 0;
if (webSocketPingInterval > 0 && !this.webSocketPingSetInterval) {
this.webSocketPingSetInterval = setInterval(() => {
if (this.isWebSocketConnectionOpened() === true) {
}
}
- private getReconnectExponentialDelay(): boolean {
- return this.stationInfo?.reconnectExponentialDelay ?? false;
- }
-
private async reconnect(): Promise<void> {
// Stop WebSocket ping
this.stopWebSocketPing();
this.stopAutomaticTransactionGenerator();
}
if (
- this.autoReconnectRetryCount < this.getAutoReconnectMaxRetries()! ||
- this.getAutoReconnectMaxRetries() === -1
+ this.autoReconnectRetryCount < this.stationInfo.autoReconnectMaxRetries! ||
+ this.stationInfo?.autoReconnectMaxRetries === -1
) {
++this.autoReconnectRetryCount;
- const reconnectDelay = this.getReconnectExponentialDelay()
- ? exponentialDelay(this.autoReconnectRetryCount)
- : secondsToMilliseconds(this.getConnectionTimeout());
+ const reconnectDelay =
+ this.stationInfo?.reconnectExponentialDelay === true
+ ? exponentialDelay(this.autoReconnectRetryCount)
+ : secondsToMilliseconds(this.getConnectionTimeout());
const reconnectDelayWithdraw = 1000;
const reconnectTimeout =
reconnectDelay && reconnectDelay - reconnectDelayWithdraw > 0
);
this.openWSConnection(
{
- ...(this.stationInfo?.wsOptions ?? {}),
handshakeTimeout: reconnectTimeout,
},
{ closeOpened: true },
);
- this.wsConnectionRestarted = true;
- } else if (this.getAutoReconnectMaxRetries() !== -1) {
+ } else if (this.stationInfo?.autoReconnectMaxRetries !== -1) {
logger.error(
`${this.logPrefix()} WebSocket connection retries failure: maximum retries reached (${
this.autoReconnectRetryCount
- }) or retries disabled (${this.getAutoReconnectMaxRetries()})`,
+ }) or retries disabled (${this.stationInfo?.autoReconnectMaxRetries})`,
);
}
}