import OCPPError from '../exception/OCPPError';
import PerformanceStatistics from '../performance/PerformanceStatistics';
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, {
+import type { ChargingStationConfiguration } from '../types/ChargingStationConfiguration';
+import type { ChargingStationInfo } from '../types/ChargingStationInfo';
+import type { ChargingStationOcppConfiguration } from '../types/ChargingStationOcppConfiguration';
+import {
+ type ChargingStationTemplate,
CurrentType,
PowerUnits,
- WsOptions,
+ type WsOptions,
} from '../types/ChargingStationTemplate';
import { SupervisionUrlDistribution } from '../types/ConfigurationData';
import type { ConnectorStatus } from '../types/ConnectorStatus';
import SharedLRUCache from './SharedLRUCache';
export default class ChargingStation {
+ public readonly index: number;
public readonly templateFile: string;
public stationInfo!: ChargingStationInfo;
public started: boolean;
public bootNotificationRequest!: BootNotificationRequest;
public bootNotificationResponse!: BootNotificationResponse | null;
public powerDivider!: number;
- private readonly index: number;
+ private starting: boolean;
+ private stopping: boolean;
private configurationFile!: string;
private configurationFileHash!: string;
private connectorsConfigurationHash!: string;
private ocppIncomingRequestService!: OCPPIncomingRequestService;
private readonly messageBuffer: Set<string>;
private configuredSupervisionUrl!: URL;
+ private configuredSupervisionUrlIndex!: number;
private wsConnectionRestarted: boolean;
private autoReconnectRetryCount: number;
private templateFileWatcher!: fs.FSWatcher;
private readonly chargingStationWorkerBroadcastChannel: ChargingStationWorkerBroadcastChannel;
constructor(index: number, templateFile: string) {
+ this.started = false;
+ this.starting = false;
+ this.stopping = false;
+ this.wsConnectionRestarted = false;
+ this.autoReconnectRetryCount = 0;
this.index = index;
this.templateFile = templateFile;
this.connectors = new Map<number, ConnectorStatus>();
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 getRandomIdTag(): string {
- const authorizationFile = ChargingStationUtils.getAuthorizationFile(this.stationInfo);
- const index = Math.floor(
- Utils.secureRandom() * this.authorizedTagsCache.getAuthorizedTags(authorizationFile).length
- );
- return this.authorizedTagsCache.getAuthorizedTags(authorizationFile)[index];
- }
-
public hasAuthorizedTags(): boolean {
return !Utils.isEmptyArray(
this.authorizedTagsCache.getAuthorizedTags(
}
public start(): void {
- if (this.getEnableStatistics()) {
- this.performanceStatistics.start();
- }
- this.openWSConnection();
- // Monitor charging station template file
- this.templateFileWatcher = FileUtils.watchJsonFile(
- this.logPrefix(),
- FileType.ChargingStationTemplate,
- this.templateFile,
- null,
- (event, filename): void => {
- if (filename && event === 'change') {
- try {
- logger.debug(
- `${this.logPrefix()} ${FileType.ChargingStationTemplate} ${
- this.templateFile
- } file have changed, reload`
- );
- this.sharedLRUCache.deleteChargingStationTemplate(this.stationInfo?.templateHash);
- // Initialize
- this.initialize();
- // Restart the ATG
- this.stopAutomaticTransactionGenerator();
- if (this.getAutomaticTransactionGeneratorConfigurationFromTemplate()?.enable === true) {
- this.startAutomaticTransactionGenerator();
- }
- if (this.getEnableStatistics()) {
- this.performanceStatistics.restart();
- } else {
- this.performanceStatistics.stop();
+ if (this.started === false) {
+ if (this.starting === false) {
+ this.starting = true;
+ if (this.getEnableStatistics()) {
+ this.performanceStatistics.start();
+ }
+ this.openWSConnection();
+ // Monitor charging station template file
+ this.templateFileWatcher = FileUtils.watchJsonFile(
+ this.logPrefix(),
+ FileType.ChargingStationTemplate,
+ this.templateFile,
+ null,
+ (event, filename): void => {
+ if (filename && event === 'change') {
+ try {
+ logger.debug(
+ `${this.logPrefix()} ${FileType.ChargingStationTemplate} ${
+ this.templateFile
+ } file have changed, reload`
+ );
+ this.sharedLRUCache.deleteChargingStationTemplate(this.stationInfo?.templateHash);
+ // Initialize
+ this.initialize();
+ // Restart the ATG
+ this.stopAutomaticTransactionGenerator();
+ if (
+ this.getAutomaticTransactionGeneratorConfigurationFromTemplate()?.enable === true
+ ) {
+ this.startAutomaticTransactionGenerator();
+ }
+ if (this.getEnableStatistics()) {
+ this.performanceStatistics.restart();
+ } else {
+ this.performanceStatistics.stop();
+ }
+ // FIXME?: restart heartbeat and WebSocket ping when their interval values have changed
+ } catch (error) {
+ logger.error(
+ `${this.logPrefix()} ${FileType.ChargingStationTemplate} file monitoring error:`,
+ error
+ );
+ }
}
- // FIXME?: restart heartbeat and WebSocket ping when their interval values have changed
- } catch (error) {
- logger.error(
- `${this.logPrefix()} ${FileType.ChargingStationTemplate} file monitoring error:`,
- error
- );
}
- }
+ );
+ parentPort.postMessage(MessageChannelUtils.buildStartedMessage(this));
+ this.starting = false;
+ } else {
+ logger.warn(`${this.logPrefix()} Charging station is already starting...`);
}
- );
- parentPort.postMessage(MessageChannelUtils.buildStartedMessage(this));
+ } else {
+ logger.warn(`${this.logPrefix()} Charging station is already started...`);
+ }
}
public async stop(reason?: StopTransactionReason): Promise<void> {
- await this.stopMessageSequence(reason);
- for (const connectorId of this.connectors.keys()) {
- if (connectorId > 0) {
- await this.ocppRequestService.requestHandler<
- StatusNotificationRequest,
- StatusNotificationResponse
- >(this, RequestCommand.STATUS_NOTIFICATION, {
- connectorId,
- status: ChargePointStatus.UNAVAILABLE,
- errorCode: ChargePointErrorCode.NO_ERROR,
- });
- this.getConnectorStatus(connectorId).status = ChargePointStatus.UNAVAILABLE;
+ if (this.started === true) {
+ if (this.stopping === false) {
+ this.stopping = true;
+ await this.stopMessageSequence(reason);
+ for (const connectorId of this.connectors.keys()) {
+ if (connectorId > 0) {
+ await this.ocppRequestService.requestHandler<
+ StatusNotificationRequest,
+ StatusNotificationResponse
+ >(this, RequestCommand.STATUS_NOTIFICATION, {
+ connectorId,
+ status: ChargePointStatus.UNAVAILABLE,
+ errorCode: ChargePointErrorCode.NO_ERROR,
+ });
+ this.getConnectorStatus(connectorId).status = ChargePointStatus.UNAVAILABLE;
+ }
+ }
+ this.closeWSConnection();
+ if (this.getEnableStatistics()) {
+ this.performanceStatistics.stop();
+ }
+ this.sharedLRUCache.deleteChargingStationConfiguration(this.configurationFileHash);
+ this.templateFileWatcher.close();
+ this.sharedLRUCache.deleteChargingStationTemplate(this.stationInfo?.templateHash);
+ this.bootNotificationResponse = null;
+ this.started = false;
+ parentPort.postMessage(MessageChannelUtils.buildStoppedMessage(this));
+ this.stopping = false;
+ } else {
+ logger.warn(`${this.logPrefix()} Charging station is already stopping...`);
}
+ } else {
+ logger.warn(`${this.logPrefix()} Charging station is already stopped...`);
}
- this.closeWSConnection();
- if (this.getEnableStatistics()) {
- this.performanceStatistics.stop();
- }
- this.sharedLRUCache.deleteChargingStationConfiguration(this.configurationFileHash);
- this.templateFileWatcher.close();
- this.sharedLRUCache.deleteChargingStationTemplate(this.stationInfo?.templateHash);
- this.bootNotificationResponse = null;
- this.started = false;
- parentPort.postMessage(MessageChannelUtils.buildStoppedMessage(this));
}
public async reset(reason?: StopTransactionReason): Promise<void> {
parentPort.postMessage(MessageChannelUtils.buildUpdatedMessage(this));
}
- public hasFeatureProfile(featureProfile: SupportedFeatureProfiles) {
+ public hasFeatureProfile(featureProfile: SupportedFeatureProfiles): boolean {
return ChargingStationConfigurationUtils.getConfigurationKey(
this,
StandardParametersKey.SupportedFeatureProfiles
}
}
- public startAutomaticTransactionGenerator(connectorIds?: number[]): void {
- if (!this.automaticTransactionGenerator) {
- this.automaticTransactionGenerator = AutomaticTransactionGenerator.getInstance(
+ public startAutomaticTransactionGenerator(
+ connectorIds?: number[],
+ automaticTransactionGeneratorConfiguration?: AutomaticTransactionGeneratorConfiguration
+ ): void {
+ this.automaticTransactionGenerator = AutomaticTransactionGenerator.getInstance(
+ automaticTransactionGeneratorConfiguration ??
this.getAutomaticTransactionGeneratorConfigurationFromTemplate(),
- this
- );
- }
+ this
+ );
if (!Utils.isEmptyArray(connectorIds)) {
for (const connectorId of connectorIds) {
this.automaticTransactionGenerator.startConnector(connectorId);
} else {
this.automaticTransactionGenerator.start();
}
+ parentPort.postMessage(MessageChannelUtils.buildUpdatedMessage(this));
}
public stopAutomaticTransactionGenerator(connectorIds?: number[]): void {
}
} else {
this.automaticTransactionGenerator?.stop();
- this.automaticTransactionGenerator = null;
}
+ parentPort.postMessage(MessageChannelUtils.buildUpdatedMessage(this));
}
public async stopTransactionOnConnector(
stationInfo.resetTime = stationTemplate.resetTime
? stationTemplate.resetTime * 1000
: Constants.CHARGING_STATION_DEFAULT_RESET_TIME;
- const configuredMaxConnectors = ChargingStationUtils.getConfiguredNumberOfConnectors(
- this.index,
- stationTemplate
- );
+ const configuredMaxConnectors =
+ ChargingStationUtils.getConfiguredNumberOfConnectors(stationTemplate);
ChargingStationUtils.checkConfiguredMaxConnectors(
configuredMaxConnectors,
this.templateFile,
const lastConnectorId = Utils.convertToInt(lastConnector);
if (
lastConnectorId === 0 &&
- this.getUseConnectorId0(stationInfo) &&
+ this.getUseConnectorId0(stationInfo) === true &&
stationInfo?.Connectors[lastConnector]
) {
this.connectors.set(
if (this.isRegistered()) {
if (this.isInAcceptedState()) {
await this.startMessageSequence();
- this.wsConnectionRestarted && this.flushMessageBuffer();
}
} else {
logger.error(
`${this.logPrefix()} Registration failure: max retries reached (${this.getRegistrationMaxRetries()}) or retry disabled (${this.getRegistrationMaxRetries()})`
);
}
- this.started === false && (this.started = true);
- this.autoReconnectRetryCount = 0;
this.wsConnectionRestarted = false;
+ this.autoReconnectRetryCount = 0;
+ this.started = true;
parentPort.postMessage(MessageChannelUtils.buildUpdatedMessage(this));
} else {
logger.warn(
code
)}' and reason '${reason}'`
);
- await this.reconnect(code);
+ await this.reconnect();
break;
}
parentPort.postMessage(MessageChannelUtils.buildUpdatedMessage(this));
// Incoming Message
case MessageType.CALL_MESSAGE:
[, , commandName, commandPayload] = request as IncomingRequest;
- if (this.getEnableStatistics()) {
+ if (this.getEnableStatistics() === true) {
this.performanceStatistics.addRequestStatistic(commandName, messageType);
}
logger.debug(
// Outcome Message
case MessageType.CALL_RESULT_MESSAGE:
[, , commandPayload] = request as Response;
- if (!this.requests.has(messageId)) {
+ if (this.requests.has(messageId) === false) {
// Error
throw new OCPPError(
ErrorType.INTERNAL_ERROR,
// Respond
cachedRequest = this.requests.get(messageId);
if (Array.isArray(cachedRequest) === true) {
- [responseCallback, , requestCommandName, requestPayload] = cachedRequest;
+ [responseCallback, errorCallback, requestCommandName, requestPayload] = cachedRequest;
} else {
throw new OCPPError(
ErrorType.PROTOCOL_ERROR,
}
logger.debug(
`${this.logPrefix()} << Command '${
- requestCommandName ?? 'unknown'
+ requestCommandName ?? Constants.UNKNOWN_COMMAND
}' received response payload: ${JSON.stringify(request)}`
);
responseCallback(commandPayload, requestPayload);
// Error Message
case MessageType.CALL_ERROR_MESSAGE:
[, , errorType, errorMessage, errorDetails] = request as ErrorResponse;
- if (!this.requests.has(messageId)) {
+ if (this.requests.has(messageId) === false) {
// Error
throw new OCPPError(
ErrorType.INTERNAL_ERROR,
}
logger.debug(
`${this.logPrefix()} << Command '${
- requestCommandName ?? 'unknown'
+ requestCommandName ?? Constants.UNKNOWN_COMMAND
}' received error payload: ${JSON.stringify(request)}`
);
errorCallback(new OCPPError(errorType, errorMessage, requestCommandName, errorDetails));
parentPort.postMessage(MessageChannelUtils.buildUpdatedMessage(this));
} else {
throw new OCPPError(ErrorType.PROTOCOL_ERROR, 'Incoming message is not an array', null, {
- payload: request,
+ request,
});
}
} catch (error) {
// Log
logger.error(
`${this.logPrefix()} Incoming OCPP command '${
- commandName ?? requestCommandName ?? null
- }' message '${data.toString()}' matching cached request '${JSON.stringify(
- this.requests.get(messageId)
- )}' processing error:`,
+ 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)) {
+ if (error instanceof OCPPError === false) {
logger.warn(
`${this.logPrefix()} Error thrown at incoming OCPP command '${
- commandName ?? requestCommandName ?? null
+ commandName ?? requestCommandName ?? Constants.UNKNOWN_COMMAND
}' message '${data.toString()}' handling is not an OCPPError:`,
error
);
}
- // Send error
- messageType === MessageType.CALL_MESSAGE &&
- (await this.ocppRequestService.sendError(
- this,
- messageId,
- error as OCPPError,
- commandName ?? requestCommandName ?? null
- ));
+ switch (messageType) {
+ case MessageType.CALL_MESSAGE:
+ // Send error
+ await this.ocppRequestService.sendError(
+ this,
+ messageId,
+ error as OCPPError,
+ commandName ?? requestCommandName ?? null
+ );
+ break;
+ case MessageType.CALL_RESULT_MESSAGE:
+ case MessageType.CALL_ERROR_MESSAGE:
+ if (errorCallback) {
+ // 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 {
+ // Remove the request from the cache in case of error at response handling
+ this.requests.delete(messageId);
+ }
+ break;
+ }
}
}
connectorStatus: ConnectorStatus,
meterStop = false
): number {
- if (this.getMeteringPerTransaction()) {
+ if (this.getMeteringPerTransaction() === true) {
return (
(meterStop === true
? Math.round(connectorStatus?.transactionEnergyActiveImportRegisterValue)
);
}
- private getUseConnectorId0(stationInfo?: ChargingStationInfo): boolean | undefined {
+ private getUseConnectorId0(stationInfo?: ChargingStationInfo): boolean {
const localStationInfo = stationInfo ?? this.stationInfo;
return !Utils.isUndefined(localStationInfo.useConnectorId0)
? localStationInfo.useConnectorId0
}
// 0 for disabling
- private getConnectionTimeout(): number | undefined {
+ private getConnectionTimeout(): number {
if (
ChargingStationConfigurationUtils.getConfigurationKey(
this,
}
// -1 for unlimited, 0 for disabling
- private getAutoReconnectMaxRetries(): number | undefined {
+ private getAutoReconnectMaxRetries(): number {
if (!Utils.isUndefined(this.stationInfo.autoReconnectMaxRetries)) {
return this.stationInfo.autoReconnectMaxRetries;
}
}
// 0 for disabling
- private getRegistrationMaxRetries(): number | undefined {
+ private getRegistrationMaxRetries(): number {
if (!Utils.isUndefined(this.stationInfo.registrationMaxRetries)) {
return this.stationInfo.registrationMaxRetries;
}
if (this.getAutomaticTransactionGeneratorConfigurationFromTemplate()?.enable === true) {
this.startAutomaticTransactionGenerator();
}
+ this.wsConnectionRestarted === true && this.flushMessageBuffer();
}
private async stopMessageSequence(
this.stationInfo.supervisionUrls ?? Configuration.getSupervisionUrls()
);
if (!Utils.isEmptyArray(supervisionUrls)) {
- let urlIndex = 0;
switch (Configuration.getSupervisionUrlDistribution()) {
case SupervisionUrlDistribution.ROUND_ROBIN:
- urlIndex = (this.index - 1) % supervisionUrls.length;
+ // FIXME
+ this.configuredSupervisionUrlIndex = (this.index - 1) % supervisionUrls.length;
break;
case SupervisionUrlDistribution.RANDOM:
- // Get a random url
- urlIndex = Math.floor(Utils.secureRandom() * supervisionUrls.length);
+ this.configuredSupervisionUrlIndex = Math.floor(
+ Utils.secureRandom() * supervisionUrls.length
+ );
break;
- case SupervisionUrlDistribution.SEQUENTIAL:
- if (this.index <= supervisionUrls.length) {
- urlIndex = this.index - 1;
- } else {
- logger.warn(
- `${this.logPrefix()} No more configured supervision urls available, using the first one`
- );
- }
+ 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.ROUND_ROBIN
+ SupervisionUrlDistribution.CHARGING_STATION_AFFINITY
}`
);
- urlIndex = (this.index - 1) % supervisionUrls.length;
+ this.configuredSupervisionUrlIndex = (this.index - 1) % supervisionUrls.length;
break;
}
- return new URL(supervisionUrls[urlIndex]);
+ return new URL(supervisionUrls[this.configuredSupervisionUrlIndex]);
}
return new URL(supervisionUrls as string);
}
- private getHeartbeatInterval(): number | undefined {
+ private getHeartbeatInterval(): number {
const HeartbeatInterval = ChargingStationConfigurationUtils.getConfigurationKey(
this,
StandardParametersKey.HeartbeatInterval
}
}
- private getReconnectExponentialDelay(): boolean | undefined {
+ private getReconnectExponentialDelay(): boolean {
return !Utils.isUndefined(this.stationInfo.reconnectExponentialDelay)
? this.stationInfo.reconnectExponentialDelay
: false;
}
- private async reconnect(code: number): Promise<void> {
+ private async reconnect(): Promise<void> {
// Stop WebSocket ping
this.stopWebSocketPing();
// Stop heartbeat