-import { BootNotificationResponse, RegistrationStatus } from '../types/ocpp/RequestResponses';
+import { BootNotificationResponse, RegistrationStatus } from '../types/ocpp/Responses';
import ChargingStationConfiguration, { ConfigurationKey } from '../types/ChargingStationConfiguration';
-import ChargingStationTemplate, { PowerOutType, VoltageOut } from '../types/ChargingStationTemplate';
+import ChargingStationTemplate, { CurrentOutType, VoltageOut } from '../types/ChargingStationTemplate';
import Connectors, { Connector } from '../types/Connectors';
import { PerformanceObserver, performance } from 'perf_hooks';
import Requests, { AvailabilityType, BootNotificationRequest, IncomingRequest, IncomingRequestCommand } from '../types/ocpp/Requests';
import ChargingStationInfo from '../types/ChargingStationInfo';
import Configuration from '../utils/Configuration';
import Constants from '../utils/Constants';
+import FileUtils from '../utils/FileUtils';
import { MessageType } from '../types/ocpp/MessageType';
import { MeterValueMeasurand } from '../types/ocpp/MeterValues';
import OCPP16IncomingRequestService from './ocpp/1.6/OCCP16IncomingRequestService';
import OCPPIncomingRequestService from './ocpp/OCPPIncomingRequestService';
import OCPPRequestService from './ocpp/OCPPRequestService';
import { OCPPVersion } from '../types/ocpp/OCPPVersion';
+import PerformanceStatistics from '../utils/PerformanceStatistics';
import { StandardParametersKey } from '../types/ocpp/Configuration';
-import Statistics from '../utils/Statistics';
import { StopTransactionReason } from '../types/ocpp/Transaction';
import Utils from '../utils/Utils';
import { WebSocketCloseEventStatusCode } from '../types/WebSocket';
import crypto from 'crypto';
import fs from 'fs';
import logger from '../utils/Logger';
+import path from 'path';
export default class ChargingStation {
public stationTemplateFile: string;
public authorizedTags: string[];
- public stationInfo: ChargingStationInfo;
+ public stationInfo!: ChargingStationInfo;
public connectors: Connectors;
- public configuration: ChargingStationConfiguration;
+ public configuration!: ChargingStationConfiguration;
public hasStopped: boolean;
- public wsConnection: WebSocket;
+ public wsConnection!: WebSocket;
public requests: Requests;
public messageQueue: string[];
- public statistics: Statistics;
- public heartbeatSetInterval: NodeJS.Timeout;
- public ocppIncomingRequestService: OCPPIncomingRequestService;
- public ocppRequestService: OCPPRequestService;
+ public performanceStatistics!: PerformanceStatistics;
+ public heartbeatSetInterval!: NodeJS.Timeout;
+ public ocppIncomingRequestService!: OCPPIncomingRequestService;
+ public ocppRequestService!: OCPPRequestService;
private index: number;
- private bootNotificationRequest: BootNotificationRequest;
- private bootNotificationResponse: BootNotificationResponse;
- private connectorsConfigurationHash: string;
- private supervisionUrl: string;
- private wsConnectionUrl: string;
+ private bootNotificationRequest!: BootNotificationRequest;
+ private bootNotificationResponse!: BootNotificationResponse | null;
+ private connectorsConfigurationHash!: string;
+ private supervisionUrl!: string;
+ private wsConnectionUrl!: string;
private hasSocketRestarted: boolean;
private autoReconnectRetryCount: number;
- private automaticTransactionGeneration: AutomaticTransactionGenerator;
- private performanceObserver: PerformanceObserver;
- private webSocketPingSetInterval: NodeJS.Timeout;
+ private automaticTransactionGeneration!: AutomaticTransactionGenerator;
+ private performanceObserver!: PerformanceObserver;
+ private webSocketPingSetInterval!: NodeJS.Timeout;
constructor(index: number, stationTemplateFile: string) {
this.index = index;
}
public logPrefix(): string {
- return Utils.logPrefix(` ${this.stationInfo.chargingStationId}:`);
+ return Utils.logPrefix(` ${this.stationInfo.chargingStationId} |`);
}
public getRandomTagId(): string {
return !Utils.isEmptyArray(this.authorizedTags);
}
- public getEnableStatistics(): boolean {
+ public getEnableStatistics(): boolean | undefined {
return !Utils.isUndefined(this.stationInfo.enableStatistics) ? this.stationInfo.enableStatistics : true;
}
- public getNumberOfPhases(): number {
- switch (this.getPowerOutType()) {
- case PowerOutType.AC:
+ public getNumberOfPhases(): number | undefined {
+ switch (this.getCurrentOutType()) {
+ case CurrentOutType.AC:
return !Utils.isUndefined(this.stationInfo.numberOfPhases) ? this.stationInfo.numberOfPhases : 3;
- case PowerOutType.DC:
+ case CurrentOutType.DC:
return 0;
}
}
return this.connectors[id];
}
- public getPowerOutType(): PowerOutType {
- return !Utils.isUndefined(this.stationInfo.powerOutType) ? this.stationInfo.powerOutType : PowerOutType.AC;
+ public getCurrentOutType(): CurrentOutType | undefined {
+ return !Utils.isUndefined(this.stationInfo.currentOutType) ? this.stationInfo.currentOutType : CurrentOutType.AC;
}
- public getVoltageOut(): number {
- const errMsg = `${this.logPrefix()} Unknown ${this.getPowerOutType()} powerOutType in template file ${this.stationTemplateFile}, cannot define default voltage out`;
+ public getVoltageOut(): number | undefined {
+ const errMsg = `${this.logPrefix()} Unknown ${this.getCurrentOutType()} currentOutType in template file ${this.stationTemplateFile}, cannot define default voltage out`;
let defaultVoltageOut: number;
- switch (this.getPowerOutType()) {
- case PowerOutType.AC:
+ switch (this.getCurrentOutType()) {
+ case CurrentOutType.AC:
defaultVoltageOut = VoltageOut.VOLTAGE_230;
break;
- case PowerOutType.DC:
+ case CurrentOutType.DC:
defaultVoltageOut = VoltageOut.VOLTAGE_400;
break;
default:
return !Utils.isUndefined(this.stationInfo.voltageOut) ? this.stationInfo.voltageOut : defaultVoltageOut;
}
- public getTransactionIdTag(transactionId: number): string {
+ public getTransactionIdTag(transactionId: number): string | undefined {
for (const connector in this.connectors) {
if (Utils.convertToInt(connector) > 0 && this.getConnector(Utils.convertToInt(connector)).transactionId === transactionId) {
return this.getConnector(Utils.convertToInt(connector)).idTag;
}
}
- public getTransactionMeterStop(transactionId: number): number {
+ public getTransactionMeterStop(transactionId: number): number | undefined {
for (const connector in this.connectors) {
if (Utils.convertToInt(connector) > 0 && this.getConnector(Utils.convertToInt(connector)).transactionId === transactionId) {
return this.getConnector(Utils.convertToInt(connector)).lastEnergyActiveImportRegisterValue;
}, this.getHeartbeatInterval());
logger.info(this.logPrefix() + ' Heartbeat started every ' + Utils.milliSecondsToHHMMSS(this.getHeartbeatInterval()));
} else if (this.heartbeatSetInterval) {
- logger.info(this.logPrefix() + ' Heartbeat every ' + Utils.milliSecondsToHHMMSS(this.getHeartbeatInterval()) + ' already started');
+ logger.info(this.logPrefix() + ' Heartbeat already started every ' + Utils.milliSecondsToHHMMSS(this.getHeartbeatInterval()));
} else {
logger.error(`${this.logPrefix()} Heartbeat interval set to ${this.getHeartbeatInterval() ? Utils.milliSecondsToHHMMSS(this.getHeartbeatInterval()) : this.getHeartbeatInterval()}, not starting the heartbeat`);
}
}
}, interval);
} else {
- logger.error(`${this.logPrefix()} Charging station ${StandardParametersKey.MeterValueSampleInterval} configuration set to ${Utils.milliSecondsToHHMMSS(interval)}, not sending MeterValues`);
+ logger.error(`${this.logPrefix()} Charging station ${StandardParametersKey.MeterValueSampleInterval} configuration set to ${interval ? Utils.milliSecondsToHHMMSS(interval) : interval}, not sending MeterValues`);
}
}
this.hasStopped = true;
}
- public getConfigurationKey(key: string | StandardParametersKey, caseInsensitive = false): ConfigurationKey {
- const configurationKey: ConfigurationKey = this.configuration.configurationKey.find((configElement) => {
+ public getConfigurationKey(key: string | StandardParametersKey, caseInsensitive = false): ConfigurationKey | undefined {
+ const configurationKey: ConfigurationKey | undefined = this.configuration.configurationKey.find((configElement) => {
if (caseInsensitive) {
return configElement.key.toLowerCase() === key.toLowerCase();
}
public setChargingProfile(connectorId: number, cp: ChargingProfile): boolean {
if (!Utils.isEmptyArray(this.getConnector(connectorId).chargingProfiles)) {
- this.getConnector(connectorId).chargingProfiles.forEach((chargingProfile: ChargingProfile, index: number) => {
+ this.getConnector(connectorId).chargingProfiles?.forEach((chargingProfile: ChargingProfile, index: number) => {
if (chargingProfile.chargingProfileId === cp.chargingProfileId
|| (chargingProfile.stackLevel === cp.stackLevel && chargingProfile.chargingProfilePurpose === cp.chargingProfilePurpose)) {
this.getConnector(connectorId).chargingProfiles[index] = cp;
}
});
}
- this.getConnector(connectorId).chargingProfiles.push(cp);
+ this.getConnector(connectorId).chargingProfiles?.push(cp);
return true;
}
public resetTransactionOnConnector(connectorId: number): void {
this.initTransactionOnConnector(connectorId);
- if (this.getConnector(connectorId)?.transactionSetInterval) {
- clearInterval(this.getConnector(connectorId).transactionSetInterval);
+ this.stopMeterValues(connectorId);
+ }
+
+ public addToMessageQueue(message: string): void {
+ let dups = false;
+ // Handle dups in message queue
+ for (const bufferedMessage of this.messageQueue) {
+ // Message already in the queue
+ if (message === bufferedMessage) {
+ dups = true;
+ break;
+ }
+ }
+ if (!dups) {
+ // Queue message
+ this.messageQueue.push(message);
+ }
+ }
+
+ private flushMessageQueue() {
+ if (!Utils.isEmptyArray(this.messageQueue)) {
+ this.messageQueue.forEach((message, index) => {
+ this.messageQueue.splice(index, 1);
+ this.wsConnection.send(message);
+ });
}
}
stationTemplateFromFile = JSON.parse(fs.readFileSync(fileDescriptor, 'utf8')) as ChargingStationTemplate;
fs.closeSync(fileDescriptor);
} catch (error) {
- logger.error('Template file ' + this.stationTemplateFile + ' loading error: %j', error);
- throw error;
+ FileUtils.handleFileException(this.logPrefix(), 'Template', this.stationTemplateFile, error);
}
const stationInfo: ChargingStationInfo = stationTemplateFromFile || {} as ChargingStationInfo;
if (!Utils.isEmptyArray(stationTemplateFromFile.power)) {
}
this.stationInfo.powerDivider = this.getPowerDivider();
if (this.getEnableStatistics()) {
- this.statistics = new Statistics(this.stationInfo.chargingStationId);
+ this.performanceStatistics = new PerformanceStatistics(this.stationInfo.chargingStationId);
this.performanceObserver = new PerformanceObserver((list) => {
const entry = list.getEntries()[0];
- this.statistics.logPerformance(entry, Constants.ENTITY_CHARGING_STATION);
+ this.performanceStatistics.logPerformance(entry, Constants.ENTITY_CHARGING_STATION);
this.performanceObserver.disconnect();
});
}
// Send BootNotification
let registrationRetryCount = 0;
do {
- this.bootNotificationResponse = await this.ocppRequestService.sendBootNotification(this.bootNotificationRequest.chargePointModel, this.bootNotificationRequest.chargePointVendor, this.bootNotificationRequest.chargeBoxSerialNumber, this.bootNotificationRequest.firmwareVersion);
+ this.bootNotificationResponse = await this.ocppRequestService.sendBootNotification(this.bootNotificationRequest.chargePointModel,
+ this.bootNotificationRequest.chargePointVendor, this.bootNotificationRequest.chargeBoxSerialNumber, this.bootNotificationRequest.firmwareVersion);
if (!this.isRegistered()) {
registrationRetryCount++;
await Utils.sleep(this.bootNotificationResponse?.interval ? this.bootNotificationResponse.interval * 1000 : Constants.OCPP_DEFAULT_BOOT_NOTIFICATION_INTERVAL);
await this.startMessageSequence();
this.hasStopped && (this.hasStopped = false);
if (this.hasSocketRestarted && this.isWebSocketOpen()) {
- if (!Utils.isEmptyArray(this.messageQueue)) {
- this.messageQueue.forEach((message, index) => {
- this.messageQueue.splice(index, 1);
- this.wsConnection.send(message);
- });
- }
+ this.flushMessageQueue();
}
} else {
logger.error(`${this.logPrefix()} Registration failure: max retries reached (${this.getRegistrationMaxRetries()}) or retry disabled (${this.getRegistrationMaxRetries()})`);
this.hasSocketRestarted = false;
}
- private async onClose(closeEvent): Promise<void> {
+ private async onClose(closeEvent: any): Promise<void> {
switch (closeEvent) {
case WebSocketCloseEventStatusCode.CLOSE_NORMAL: // Normal close
case WebSocketCloseEventStatusCode.CLOSE_NO_STATUS:
private async onMessage(messageEvent: MessageEvent): Promise<void> {
let [messageType, messageId, commandName, commandPayload, errorDetails]: IncomingRequest = [0, '', '' as IncomingRequestCommand, {}, {}];
- let responseCallback: (payload?: Record<string, unknown> | string, requestPayload?: Record<string, unknown>) => void;
+ let responseCallback: (payload: Record<string, unknown> | string, requestPayload: Record<string, unknown>) => void;
let rejectCallback: (error: OCPPError) => void;
let requestPayload: Record<string, unknown>;
let errMsg: string;
// Incoming Message
case MessageType.CALL_MESSAGE:
if (this.getEnableStatistics()) {
- this.statistics.addMessage(commandName, messageType);
+ this.performanceStatistics.addMessage(commandName, messageType);
}
// Process the call
await this.ocppIncomingRequestService.handleRequest(messageId, commandName, commandPayload);
logger.debug(this.logPrefix() + ' Has received a WS pong (rfc6455) from the server');
}
- private async onError(errorEvent): Promise<void> {
+ private async onError(errorEvent: any): Promise<void> {
logger.error(this.logPrefix() + ' Socket error: %j', errorEvent);
- // pragma switch (errorEvent.code) {
+ // switch (errorEvent.code) {
// case 'ECONNREFUSED':
// await this._reconnect(errorEvent);
// break;
return this.stationInfo.Configuration ? this.stationInfo.Configuration : {} as ChargingStationConfiguration;
}
- private getAuthorizationFile(): string {
- return this.stationInfo.authorizationFile && this.stationInfo.authorizationFile;
+ private getAuthorizationFile(): string | undefined {
+ return this.stationInfo.authorizationFile && path.join(path.resolve(__dirname, '../'), 'assets', path.basename(this.stationInfo.authorizationFile));
}
private getAuthorizedTags(): string[] {
authorizedTags = JSON.parse(fs.readFileSync(fileDescriptor, 'utf8')) as string[];
fs.closeSync(fileDescriptor);
} catch (error) {
- logger.error(this.logPrefix() + ' Authorization file ' + authorizationFile + ' loading error: %j', error);
- throw error;
+ FileUtils.handleFileException(this.logPrefix(), 'Authorization', authorizationFile, error);
}
} else {
logger.info(this.logPrefix() + ' No authorization file given in template file ' + this.stationTemplateFile);
return authorizedTags;
}
- private getUseConnectorId0(): boolean {
+ private getUseConnectorId0(): boolean | undefined {
return !Utils.isUndefined(this.stationInfo.useConnectorId0) ? this.stationInfo.useConnectorId0 : true;
}
}
// 0 for disabling
- private getConnectionTimeout(): number {
+ private getConnectionTimeout(): number | undefined {
if (!Utils.isUndefined(this.stationInfo.connectionTimeout)) {
return this.stationInfo.connectionTimeout;
}
}
// -1 for unlimited, 0 for disabling
- private getAutoReconnectMaxRetries(): number {
+ private getAutoReconnectMaxRetries(): number | undefined {
if (!Utils.isUndefined(this.stationInfo.autoReconnectMaxRetries)) {
return this.stationInfo.autoReconnectMaxRetries;
}
}
// 0 for disabling
- private getRegistrationMaxRetries(): number {
+ private getRegistrationMaxRetries(): number | undefined {
if (!Utils.isUndefined(this.stationInfo.registrationMaxRetries)) {
return this.stationInfo.registrationMaxRetries;
}
}
}
// Start the ATG
+ this.startAutomaticTransactionGenerator();
+ if (this.getEnableStatistics()) {
+ this.performanceStatistics.start();
+ }
+ }
+
+ private startAutomaticTransactionGenerator() {
if (this.stationInfo.AutomaticTransactionGenerator.enable) {
if (!this.automaticTransactionGeneration) {
this.automaticTransactionGeneration = new AutomaticTransactionGenerator(this);
}
if (this.automaticTransactionGeneration.timeToStop) {
- await this.automaticTransactionGeneration.start();
+ // The ATG might sleep
+ void this.automaticTransactionGeneration.start();
}
}
- if (this.getEnableStatistics()) {
- this.statistics.start();
- }
}
private async stopMessageSequence(reason: StopTransactionReason = StopTransactionReason.NONE): Promise<void> {
}
private startWebSocketPing(): void {
- const webSocketPingInterval: number = this.getConfigurationKey(StandardParametersKey.WebSocketPingInterval) ? Utils.convertToInt(this.getConfigurationKey(StandardParametersKey.WebSocketPingInterval).value) : 0;
+ const webSocketPingInterval: number = this.getConfigurationKey(StandardParametersKey.WebSocketPingInterval)
+ ? Utils.convertToInt(this.getConfigurationKey(StandardParametersKey.WebSocketPingInterval).value)
+ : 0;
if (webSocketPingInterval > 0 && !this.webSocketPingSetInterval) {
this.webSocketPingSetInterval = setInterval(() => {
if (this.isWebSocketOpen()) {
private stopWebSocketPing(): void {
if (this.webSocketPingSetInterval) {
clearInterval(this.webSocketPingSetInterval);
- this.webSocketPingSetInterval = null;
}
}
return supervisionUrls as string;
}
- private getHeartbeatInterval(): number {
+ private getHeartbeatInterval(): number | undefined {
const HeartbeatInterval = this.getConfigurationKey(StandardParametersKey.HeartbeatInterval);
if (HeartbeatInterval) {
return Utils.convertToInt(HeartbeatInterval.value) * 1000;
private stopHeartbeat(): void {
if (this.heartbeatSetInterval) {
clearInterval(this.heartbeatSetInterval);
- this.heartbeatSetInterval = null;
}
}
private openWSConnection(options?: WebSocket.ClientOptions, forceCloseOpened = false): void {
- if (Utils.isUndefined(options)) {
- options = {} as WebSocket.ClientOptions;
- }
- if (Utils.isUndefined(options.handshakeTimeout)) {
- options.handshakeTimeout = this.getConnectionTimeout() * 1000;
- }
+ options ?? {} as WebSocket.ClientOptions;
+ options?.handshakeTimeout ?? this.getConnectionTimeout() * 1000;
if (this.isWebSocketOpen() && forceCloseOpened) {
this.wsConnection.close();
}
logger.info(this.logPrefix() + ' Will communicate through URL ' + this.supervisionUrl);
}
+ private stopMeterValues(connectorId: number) {
+ if (this.getConnector(connectorId)?.transactionSetInterval) {
+ clearInterval(this.getConnector(connectorId).transactionSetInterval);
+ }
+ }
+
private startAuthorizationFileMonitoring(): void {
- fs.watch(this.getAuthorizationFile()).on('change', (e) => {
+ const authorizationFile = this.getAuthorizationFile();
+ if (authorizationFile) {
try {
- logger.debug(this.logPrefix() + ' Authorization file ' + this.getAuthorizationFile() + ' have changed, reload');
- // Initialize authorizedTags
- this.authorizedTags = this.getAuthorizedTags();
+ fs.watch(authorizationFile).on('change', (e) => {
+ try {
+ logger.debug(this.logPrefix() + ' Authorization file ' + authorizationFile + ' have changed, reload');
+ // Initialize authorizedTags
+ this.authorizedTags = this.getAuthorizedTags();
+ } catch (error) {
+ logger.error(this.logPrefix() + ' Authorization file monitoring error: %j', error);
+ }
+ });
} catch (error) {
- logger.error(this.logPrefix() + ' Authorization file monitoring error: %j', error);
+ FileUtils.handleFileException(this.logPrefix(), 'Authorization', authorizationFile, error);
}
- });
+ } else {
+ logger.info(this.logPrefix() + ' No authorization file given in template file ' + this.stationTemplateFile + '. Not monitoring changes');
+ }
}
private startStationTemplateFileMonitoring(): void {
+ try {
// eslint-disable-next-line @typescript-eslint/no-misused-promises
- fs.watch(this.stationTemplateFile).on('change', async (e): Promise<void> => {
- try {
- logger.debug(this.logPrefix() + ' Template file ' + this.stationTemplateFile + ' have changed, reload');
- // Initialize
- this.initialize();
- // Stop the ATG
- if (!this.stationInfo.AutomaticTransactionGenerator.enable &&
+ fs.watch(this.stationTemplateFile).on('change', async (e): Promise<void> => {
+ try {
+ logger.debug(this.logPrefix() + ' Template file ' + this.stationTemplateFile + ' have changed, reload');
+ // Initialize
+ this.initialize();
+ // Stop the ATG
+ if (!this.stationInfo.AutomaticTransactionGenerator.enable &&
this.automaticTransactionGeneration) {
- await this.automaticTransactionGeneration.stop();
- }
- // Start the ATG
- if (this.stationInfo.AutomaticTransactionGenerator.enable) {
- if (!this.automaticTransactionGeneration) {
- this.automaticTransactionGeneration = new AutomaticTransactionGenerator(this);
- }
- if (this.automaticTransactionGeneration.timeToStop) {
- await this.automaticTransactionGeneration.start();
+ await this.automaticTransactionGeneration.stop();
}
+ // Start the ATG
+ this.startAutomaticTransactionGenerator();
+ // FIXME?: restart heartbeat and WebSocket ping when their interval values have changed
+ } catch (error) {
+ logger.error(this.logPrefix() + ' Charging station template file monitoring error: %j', error);
}
- // FIXME?: restart heartbeat and WebSocket ping when their interval values have changed
- } catch (error) {
- logger.error(this.logPrefix() + ' Charging station template file monitoring error: %j', error);
- }
- });
+ });
+ } catch (error) {
+ FileUtils.handleFileException(this.logPrefix(), 'Template', this.stationTemplateFile, error);
+ }
}
- private getReconnectExponentialDelay(): boolean {
+ private getReconnectExponentialDelay(): boolean | undefined {
return !Utils.isUndefined(this.stationInfo.reconnectExponentialDelay) ? this.stationInfo.reconnectExponentialDelay : false;
}
- private async reconnect(error): Promise<void> {
+ private async reconnect(error: any): Promise<void> {
// Stop heartbeat
this.stopHeartbeat();
// Stop the ATG if needed
this.stationInfo.AutomaticTransactionGenerator.stopOnConnectionFailure &&
this.automaticTransactionGeneration &&
!this.automaticTransactionGeneration.timeToStop) {
- this.automaticTransactionGeneration.stop().catch(() => { });
+ await this.automaticTransactionGeneration.stop();
}
if (this.autoReconnectRetryCount < this.getAutoReconnectMaxRetries() || this.getAutoReconnectMaxRetries() === -1) {
this.autoReconnectRetryCount++;
private initTransactionOnConnector(connectorId: number): void {
this.getConnector(connectorId).transactionStarted = false;
- this.getConnector(connectorId).transactionId = null;
- this.getConnector(connectorId).idTag = null;
+ delete this.getConnector(connectorId).transactionId;
+ delete this.getConnector(connectorId).idTag;
this.getConnector(connectorId).lastEnergyActiveImportRegisterValue = -1;
}
}
repositories / e-mobility-charging-stations-simulator.git / blobdiff