import BaseError from '../exception/BaseError';
import OCPPError from '../exception/OCPPError';
import PerformanceStatistics from '../performance/PerformanceStatistics';
-import { AutomaticTransactionGeneratorConfiguration } from '../types/AutomaticTransactionGenerator';
-import ChargingStationConfiguration from '../types/ChargingStationConfiguration';
-import ChargingStationInfo from '../types/ChargingStationInfo';
-import ChargingStationOcppConfiguration from '../types/ChargingStationOcppConfiguration';
+import type { AutomaticTransactionGeneratorConfiguration } from '../types/AutomaticTransactionGenerator';
+import type ChargingStationConfiguration from '../types/ChargingStationConfiguration';
+import type ChargingStationInfo from '../types/ChargingStationInfo';
+import type ChargingStationOcppConfiguration from '../types/ChargingStationOcppConfiguration';
import ChargingStationTemplate, {
CurrentType,
PowerUnits,
WsOptions,
} from '../types/ChargingStationTemplate';
import { SupervisionUrlDistribution } from '../types/ConfigurationData';
-import { ConnectorStatus } from '../types/ConnectorStatus';
+import type { ConnectorStatus } from '../types/ConnectorStatus';
import { FileType } from '../types/FileType';
-import { JsonType } from '../types/JsonType';
+import type { JsonType } from '../types/JsonType';
import { ChargePointErrorCode } from '../types/ocpp/ChargePointErrorCode';
import { ChargePointStatus } from '../types/ocpp/ChargePointStatus';
import { ChargingProfile, ChargingRateUnitType } from '../types/ocpp/ChargingProfile';
import OCPP16RequestService from './ocpp/1.6/OCPP16RequestService';
import OCPP16ResponseService from './ocpp/1.6/OCPP16ResponseService';
import { OCPP16ServiceUtils } from './ocpp/1.6/OCPP16ServiceUtils';
-import OCPPIncomingRequestService from './ocpp/OCPPIncomingRequestService';
-import OCPPRequestService from './ocpp/OCPPRequestService';
+import type OCPPIncomingRequestService from './ocpp/OCPPIncomingRequestService';
+import type OCPPRequestService from './ocpp/OCPPRequestService';
import SharedLRUCache from './SharedLRUCache';
export default class ChargingStation {
- public hashId!: string;
public readonly templateFile: string;
- public authorizedTagsCache: AuthorizedTagsCache;
public stationInfo!: ChargingStationInfo;
- public stopped: boolean;
- public readonly connectors: Map<number, ConnectorStatus>;
+ public started: boolean;
+ public authorizedTagsCache: AuthorizedTagsCache;
+ public automaticTransactionGenerator!: AutomaticTransactionGenerator;
public ocppConfiguration!: ChargingStationOcppConfiguration;
public wsConnection!: WebSocket;
+ public readonly connectors: Map<number, ConnectorStatus>;
public readonly requests: Map<string, CachedRequest>;
public performanceStatistics!: PerformanceStatistics;
public heartbeatSetInterval!: NodeJS.Timeout;
public ocppRequestService!: OCPPRequestService;
+ public bootNotificationRequest!: BootNotificationRequest;
public bootNotificationResponse!: BootNotificationResponse | null;
public powerDivider!: number;
private readonly index: number;
private configurationFile!: string;
private configurationFileHash!: string;
- private bootNotificationRequest!: BootNotificationRequest;
private connectorsConfigurationHash!: string;
private ocppIncomingRequestService!: OCPPIncomingRequestService;
private readonly messageBuffer: Set<string>;
private autoReconnectRetryCount: number;
private templateFileWatcher!: fs.FSWatcher;
private readonly sharedLRUCache: SharedLRUCache;
- private automaticTransactionGenerator!: AutomaticTransactionGenerator;
private webSocketPingSetInterval!: NodeJS.Timeout;
private readonly chargingStationWorkerBroadcastChannel: ChargingStationWorkerBroadcastChannel;
constructor(index: number, templateFile: string) {
this.index = index;
this.templateFile = templateFile;
- this.stopped = false;
- this.wsConnectionRestarted = false;
- this.autoReconnectRetryCount = 0;
- this.sharedLRUCache = SharedLRUCache.getInstance();
- this.authorizedTagsCache = AuthorizedTagsCache.getInstance();
this.connectors = new Map<number, ConnectorStatus>();
this.requests = new Map<string, CachedRequest>();
this.messageBuffer = new Set<string>();
+ this.sharedLRUCache = SharedLRUCache.getInstance();
+ this.authorizedTagsCache = AuthorizedTagsCache.getInstance();
this.chargingStationWorkerBroadcastChannel = new ChargingStationWorkerBroadcastChannel(this);
+ this.started = false;
+ this.wsConnectionRestarted = false;
+ this.autoReconnectRetryCount = 0;
this.initialize();
}
);
}
- public getBootNotificationRequest(): BootNotificationRequest {
- return this.bootNotificationRequest;
- }
-
public getRandomIdTag(): string {
const authorizationFile = ChargingStationUtils.getAuthorizationFile(this.stationInfo);
const index = Math.floor(
: true;
}
- public getMayAuthorizeAtRemoteStart(): boolean | undefined {
- return this.stationInfo.mayAuthorizeAtRemoteStart ?? true;
+ public getMustAuthorizeAtRemoteStart(): boolean | undefined {
+ return this.stationInfo.mustAuthorizeAtRemoteStart ?? true;
}
public getPayloadSchemaValidation(): boolean | undefined {
}
}
- public getEnergyActiveImportRegisterByTransactionId(transactionId: number): number {
- const transactionConnectorStatus = this.getConnectorStatus(
- this.getConnectorIdByTransactionId(transactionId)
+ public getEnergyActiveImportRegisterByTransactionId(
+ transactionId: number,
+ meterStop = false
+ ): number {
+ return this.getEnergyActiveImportRegister(
+ this.getConnectorStatus(this.getConnectorIdByTransactionId(transactionId)),
+ meterStop
);
- if (this.getMeteringPerTransaction()) {
- return transactionConnectorStatus?.transactionEnergyActiveImportRegisterValue ?? 0;
- }
- return transactionConnectorStatus?.energyActiveImportRegisterValue ?? 0;
}
public getEnergyActiveImportRegisterByConnectorId(connectorId: number): number {
- const connectorStatus = this.getConnectorStatus(connectorId);
- if (this.getMeteringPerTransaction()) {
- return connectorStatus?.transactionEnergyActiveImportRegisterValue ?? 0;
- }
- return connectorStatus?.energyActiveImportRegisterValue ?? 0;
+ return this.getEnergyActiveImportRegister(this.getConnectorStatus(connectorId));
}
public getAuthorizeRemoteTxRequests(): boolean {
this.initialize();
// Restart the ATG
this.stopAutomaticTransactionGenerator();
- this.startAutomaticTransactionGenerator();
+ if (this.getAutomaticTransactionGeneratorConfigurationFromTemplate()?.enable) {
+ this.startAutomaticTransactionGenerator();
+ }
if (this.getEnableStatistics()) {
this.performanceStatistics.restart();
} else {
this.templateFileWatcher.close();
this.sharedLRUCache.deleteChargingStationTemplate(this.stationInfo?.templateHash);
this.bootNotificationResponse = null;
- this.stopped = true;
+ this.started = false;
parentPort.postMessage(MessageChannelUtils.buildStoppedMessage(this));
}
if (!Utils.isEmptyArray(chargingProfiles)) {
const result = ChargingStationUtils.getLimitFromChargingProfiles(
chargingProfiles,
- Utils.logPrefix()
+ this.logPrefix()
);
if (!Utils.isNullOrUndefined(result)) {
limit = result.limit;
break;
}
+ if (this.isWebSocketConnectionOpened()) {
+ logger.warn(
+ `${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);
}
}
- private flushMessageBuffer() {
+ public startAutomaticTransactionGenerator(connectorIds?: number[]): void {
+ if (!this.automaticTransactionGenerator) {
+ this.automaticTransactionGenerator = AutomaticTransactionGenerator.getInstance(
+ this.getAutomaticTransactionGeneratorConfigurationFromTemplate(),
+ this
+ );
+ }
+ if (!Utils.isEmptyArray(connectorIds)) {
+ for (const connectorId of connectorIds) {
+ this.automaticTransactionGenerator.startConnector(connectorId);
+ }
+ } else {
+ this.automaticTransactionGenerator.start();
+ }
+ }
+
+ public stopAutomaticTransactionGenerator(connectorIds?: number[]): void {
+ if (!Utils.isEmptyArray(connectorIds)) {
+ for (const connectorId of connectorIds) {
+ this.automaticTransactionGenerator?.stopConnector(connectorId);
+ }
+ } else {
+ this.automaticTransactionGenerator?.stop();
+ this.automaticTransactionGenerator = null;
+ }
+ }
+
+ private flushMessageBuffer(): void {
if (this.messageBuffer.size > 0) {
this.messageBuffer.forEach((message) => {
// TODO: evaluate the need to track performance
);
const stationInfo: ChargingStationInfo =
ChargingStationUtils.stationTemplateToStationInfo(stationTemplate);
+ stationInfo.hashId = ChargingStationUtils.getHashId(this.index, stationTemplate);
stationInfo.chargingStationId = ChargingStationUtils.getChargingStationId(
this.index,
stationTemplate
ChargingStationUtils.checkConfiguredMaxConnectors(
configuredMaxConnectors,
this.templateFile,
- Utils.logPrefix()
+ this.logPrefix()
);
const templateMaxConnectors =
ChargingStationUtils.getTemplateMaxNumberOfConnectors(stationTemplate);
ChargingStationUtils.checkTemplateMaxConnectors(
templateMaxConnectors,
this.templateFile,
- Utils.logPrefix()
+ this.logPrefix()
);
if (
configuredMaxConnectors >
}
private handleUnsupportedVersion(version: OCPPVersion) {
- const errMsg = `${this.logPrefix()} Unsupported protocol version '${version}' configured in template file ${
- this.templateFile
- }`;
- logger.error(errMsg);
+ const errMsg = `Unsupported protocol version '${version}' configured in template file ${this.templateFile}`;
+ logger.error(`${this.logPrefix()} ${errMsg}`);
throw new BaseError(errMsg);
}
private initialize(): void {
- this.hashId = ChargingStationUtils.getHashId(this.index, this.getTemplateFromFile());
- logger.info(`${this.logPrefix()} Charging station hashId '${this.hashId}'`);
this.configurationFile = path.join(
path.dirname(this.templateFile.replace('station-templates', 'configurations')),
- this.hashId + '.json'
+ ChargingStationUtils.getHashId(this.index, this.getTemplateFromFile()) + '.json'
);
this.stationInfo = this.getStationInfo();
this.saveStationInfo();
+ logger.info(`${this.logPrefix()} Charging station hashId '${this.stationInfo.hashId}'`);
// Avoid duplication of connectors related information in RAM
this.stationInfo?.Connectors && delete this.stationInfo.Connectors;
this.configuredSupervisionUrl = this.getConfiguredSupervisionUrl();
if (this.getEnableStatistics()) {
this.performanceStatistics = PerformanceStatistics.getInstance(
- this.hashId,
+ this.stationInfo.hashId,
this.stationInfo.chargingStationId,
this.configuredSupervisionUrl
);
templateMaxConnectors: number
): void {
if (!stationInfo?.Connectors && this.connectors.size === 0) {
- const logMsg = `${this.logPrefix()} No already defined connectors and charging station information from template ${
- this.templateFile
- } with no connectors configuration defined`;
- logger.error(logMsg);
+ 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);
}
if (!stationInfo?.Connectors[0]) {
`${this.logPrefix()} Registration failure: max retries reached (${this.getRegistrationMaxRetries()}) or retry disabled (${this.getRegistrationMaxRetries()})`
);
}
- this.stopped && (this.stopped = false);
+ this.started === false && (this.started = true);
this.autoReconnectRetryCount = 0;
this.wsConnectionRestarted = false;
} else {
// Error
default:
// eslint-disable-next-line @typescript-eslint/restrict-template-expressions
- errMsg = `${this.logPrefix()} Wrong message type ${messageType}`;
- logger.error(errMsg);
+ errMsg = `Wrong message type ${messageType}`;
+ logger.error(`${this.logPrefix()} ${errMsg}`);
throw new OCPPError(ErrorType.PROTOCOL_ERROR, errMsg);
}
parentPort.postMessage(MessageChannelUtils.buildUpdatedMessage(this));
} catch (error) {
// Log
logger.error(
- "%s Incoming OCPP '%s' message '%j' matching cached request '%j' processing error:",
- this.logPrefix(),
- commandName ?? requestCommandName ?? null,
- data.toString(),
- this.requests.get(messageId),
+ `${this.logPrefix()} Incoming OCPP command '${
+ commandName ?? requestCommandName ?? null
+ }' message '${data.toString()}' matching cached request '${JSON.stringify(
+ this.requests.get(messageId)
+ )}' processing error:`,
error
);
if (!(error instanceof OCPPError)) {
logger.warn(
- "%s Error thrown at incoming OCPP '%s' message '%j' handling is not an OCPPError:",
- this.logPrefix(),
- commandName ?? requestCommandName ?? null,
- data.toString(),
+ `${this.logPrefix()} Error thrown at incoming OCPP command '${
+ commandName ?? requestCommandName ?? null
+ }' message '${data.toString()}' handling is not an OCPPError:`,
error
);
}
logger.error(this.logPrefix() + ' WebSocket error:', error);
}
+ private getEnergyActiveImportRegister(
+ connectorStatus: ConnectorStatus,
+ meterStop = false
+ ): number {
+ if (this.getMeteringPerTransaction()) {
+ return (
+ (meterStop === true
+ ? Math.round(connectorStatus?.transactionEnergyActiveImportRegisterValue)
+ : connectorStatus?.transactionEnergyActiveImportRegisterValue) ?? 0
+ );
+ }
+ return (
+ (meterStop === true
+ ? Math.round(connectorStatus?.energyActiveImportRegisterValue)
+ : connectorStatus?.energyActiveImportRegisterValue) ?? 0
+ );
+ }
+
private getUseConnectorId0(stationInfo?: ChargingStationInfo): boolean | undefined {
const localStationInfo = stationInfo ?? this.stationInfo;
return !Utils.isUndefined(localStationInfo.useConnectorId0)
if (connectorId === 0) {
continue;
} else if (
- !this.stopped &&
+ this.started === true &&
!this.getConnectorStatus(connectorId)?.status &&
this.getConnectorStatus(connectorId)?.bootStatus
) {
this.getConnectorStatus(connectorId).status =
this.getConnectorStatus(connectorId).bootStatus;
} else if (
- this.stopped &&
+ this.started === false &&
this.getConnectorStatus(connectorId)?.status &&
this.getConnectorStatus(connectorId)?.bootStatus
) {
});
this.getConnectorStatus(connectorId).status =
this.getConnectorStatus(connectorId).bootStatus;
- } else if (!this.stopped && this.getConnectorStatus(connectorId)?.status) {
+ } else if (this.started === true && this.getConnectorStatus(connectorId)?.status) {
// Send previous status at template reload
await this.ocppRequestService.requestHandler<
StatusNotificationRequest,
}
}
// Start the ATG
- this.startAutomaticTransactionGenerator();
- }
-
- private startAutomaticTransactionGenerator() {
if (this.getAutomaticTransactionGeneratorConfigurationFromTemplate()?.enable) {
- if (!this.automaticTransactionGenerator) {
- this.automaticTransactionGenerator = AutomaticTransactionGenerator.getInstance(
- this.getAutomaticTransactionGeneratorConfigurationFromTemplate(),
- this
- );
- }
- if (!this.automaticTransactionGenerator.started) {
- this.automaticTransactionGenerator.start();
- }
- }
- }
-
- private stopAutomaticTransactionGenerator(): void {
- if (this.automaticTransactionGenerator?.started) {
- this.automaticTransactionGenerator.stop();
- this.automaticTransactionGenerator = null;
+ this.startAutomaticTransactionGenerator();
}
}
// Stop heartbeat
this.stopHeartbeat();
// Stop ongoing transactions
- if (this.automaticTransactionGenerator?.configuration?.enable) {
- this.stopAutomaticTransactionGenerator();
- } else {
- for (const connectorId of this.connectors.keys()) {
- if (connectorId > 0 && this.getConnectorStatus(connectorId)?.transactionStarted) {
- const transactionId = this.getConnectorStatus(connectorId).transactionId;
- if (
- this.getBeginEndMeterValues() &&
- this.getOcppStrictCompliance() &&
- !this.getOutOfOrderEndMeterValues()
- ) {
- // FIXME: Implement OCPP version agnostic helpers
- const transactionEndMeterValue = OCPP16ServiceUtils.buildTransactionEndMeterValue(
- this,
- connectorId,
- this.getEnergyActiveImportRegisterByTransactionId(transactionId)
- );
- await this.ocppRequestService.requestHandler<MeterValuesRequest, MeterValuesResponse>(
- this,
- RequestCommand.METER_VALUES,
- {
+ if (this.getNumberOfRunningTransactions() > 0) {
+ if (this.automaticTransactionGenerator?.started) {
+ this.stopAutomaticTransactionGenerator();
+ } else {
+ for (const connectorId of this.connectors.keys()) {
+ if (connectorId > 0 && this.getConnectorStatus(connectorId)?.transactionStarted) {
+ const transactionId = this.getConnectorStatus(connectorId).transactionId;
+ if (
+ this.getBeginEndMeterValues() &&
+ this.getOcppStrictCompliance() &&
+ !this.getOutOfOrderEndMeterValues()
+ ) {
+ // FIXME: Implement OCPP version agnostic helpers
+ const transactionEndMeterValue = OCPP16ServiceUtils.buildTransactionEndMeterValue(
+ this,
connectorId,
- transactionId,
- meterValue: [transactionEndMeterValue],
- }
- );
+ this.getEnergyActiveImportRegisterByTransactionId(transactionId)
+ );
+ await this.ocppRequestService.requestHandler<MeterValuesRequest, MeterValuesResponse>(
+ this,
+ RequestCommand.METER_VALUES,
+ {
+ connectorId,
+ transactionId,
+ meterValue: [transactionEndMeterValue],
+ }
+ );
+ }
+ await this.ocppRequestService.requestHandler<
+ StopTransactionRequest,
+ StopTransactionResponse
+ >(this, RequestCommand.STOP_TRANSACTION, {
+ transactionId,
+ meterStop: this.getEnergyActiveImportRegisterByTransactionId(transactionId, true),
+ idTag: this.getTransactionIdTag(transactionId),
+ reason,
+ });
}
- await this.ocppRequestService.requestHandler<
- StopTransactionRequest,
- StopTransactionResponse
- >(this, RequestCommand.STOP_TRANSACTION, {
- transactionId,
- meterStop: this.getEnergyActiveImportRegisterByTransactionId(transactionId),
- idTag: this.getTransactionIdTag(transactionId),
- reason,
- });
}
}
}