Add per phase support to MeterValues in template.
[e-mobility-charging-stations-simulator.git] / src / charging-station / ChargingStation.ts
index 164157377d7a03c0d5273a662003867046786fe8..6bab3d86cc1f2958de511a60d1b5f0ea1a422221 100644 (file)
@@ -1,7 +1,9 @@
 import { BootNotificationResponse, RegistrationStatus } from '../types/ocpp/Responses';
 import ChargingStationConfiguration, { ConfigurationKey } from '../types/ChargingStationConfiguration';
-import ChargingStationTemplate, { CurrentOutType, VoltageOut } from '../types/ChargingStationTemplate';
-import Connectors, { Connector } from '../types/Connectors';
+import ChargingStationTemplate, { CurrentOutType, PowerUnits, VoltageOut } from '../types/ChargingStationTemplate';
+import { ConnectorPhaseRotation, StandardParametersKey, SupportedFeatureProfiles } from '../types/ocpp/Configuration';
+import Connectors, { Connector, SampledValueTemplate } from '../types/Connectors';
+import { MeterValueMeasurand, MeterValuePhase } from '../types/ocpp/MeterValues';
 import { PerformanceObserver, performance } from 'perf_hooks';
 import Requests, { AvailabilityType, BootNotificationRequest, IncomingRequest, IncomingRequestCommand } from '../types/ocpp/Requests';
 import WebSocket, { MessageEvent } from 'ws';
@@ -12,8 +14,8 @@ import { ChargingProfile } from '../types/ocpp/ChargingProfile';
 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 OCPP16RequestService from './ocpp/1.6/OCPP16RequestService';
 import OCPP16ResponseService from './ocpp/1.6/OCPP16ResponseService';
@@ -22,7 +24,6 @@ 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 { StopTransactionReason } from '../types/ocpp/Transaction';
 import Utils from '../utils/Utils';
 import { WebSocketCloseEventStatusCode } from '../types/WebSocket';
@@ -148,14 +149,48 @@ export default class ChargingStation {
     }
   }
 
-  public getTransactionMeterStop(transactionId: number): number | undefined {
+  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 getEnergyActiveImportRegisterByTransactionId(transactionId: number): number | undefined {
+    if (this.getMeteringPerTransaction()) {
+      for (const connector in this.connectors) {
+        if (Utils.convertToInt(connector) > 0 && this.getConnector(Utils.convertToInt(connector)).transactionId === transactionId) {
+          return this.getConnector(Utils.convertToInt(connector)).transactionEnergyActiveImportRegisterValue;
+        }
+      }
+    }
     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;
+        return this.getConnector(Utils.convertToInt(connector)).energyActiveImportRegisterValue;
       }
     }
   }
 
+  public getEnergyActiveImportRegisterByConnectorId(connectorId: number): number | undefined {
+    if (this.getMeteringPerTransaction()) {
+      return this.getConnector(connectorId).transactionEnergyActiveImportRegisterValue;
+    }
+    return this.getConnector(connectorId).energyActiveImportRegisterValue;
+  }
+
   public getAuthorizeRemoteTxRequests(): boolean {
     const authorizeRemoteTxRequests = this.getConfigurationKey(StandardParametersKey.AuthorizeRemoteTxRequests);
     return authorizeRemoteTxRequests ? Utils.convertToBoolean(authorizeRemoteTxRequests.value) : false;
@@ -173,6 +208,37 @@ export default class ChargingStation {
     this.startWebSocketPing();
   }
 
+  public getSampledValueTemplate(connectorId: number, measurand: MeterValueMeasurand = MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER,
+      phase?: MeterValuePhase): SampledValueTemplate | undefined {
+    if (!Constants.SUPPORTED_MEASURANDS.includes(measurand)) {
+      logger.warn(`${this.logPrefix()} Unsupported MeterValues measurand ${measurand} in template on connectorId ${connectorId}`);
+      return;
+    }
+    const sampledValueTemplates: SampledValueTemplate[] = this.getConnector(connectorId).MeterValues;
+    let defaultMeasurandFound = false;
+    for (let index = 0; !Utils.isEmptyArray(sampledValueTemplates) && index < sampledValueTemplates.length; index++) {
+      if (phase && sampledValueTemplates[index]?.phase === phase && sampledValueTemplates[index]?.measurand === measurand
+          && this.getConfigurationKey(StandardParametersKey.MeterValuesSampledData).value.includes(measurand)) {
+        return sampledValueTemplates[index];
+      } else if (!phase && !sampledValueTemplates[index].phase && sampledValueTemplates[index]?.measurand === measurand
+                 && this.getConfigurationKey(StandardParametersKey.MeterValuesSampledData).value.includes(measurand)) {
+        return sampledValueTemplates[index];
+      } else if (measurand === MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER
+                 && (!sampledValueTemplates[index].measurand || sampledValueTemplates[index].measurand === measurand)) {
+        defaultMeasurandFound = true;
+        return sampledValueTemplates[index];
+      }
+    }
+    if (measurand === MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER && !defaultMeasurandFound) {
+      logger.error(`${this.logPrefix()} Missing MeterValues for default measurand ${MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER} in template on connectorId ${connectorId}`);
+    }
+    logger.debug(`${this.logPrefix()} No MeterValues for measurand ${measurand} ${phase ? `on phase ${phase} ` : ''}in template on connectorId ${connectorId}`);
+  }
+
+  public getAutomaticTransactionGeneratorRequireAuthorize(): boolean {
+    return this.stationInfo.AutomaticTransactionGenerator.requireAuthorize ?? true;
+  }
+
   public startHeartbeat(): void {
     if (this.getHeartbeatInterval() && this.getHeartbeatInterval() > 0 && !this.heartbeatSetInterval) {
       // eslint-disable-next-line @typescript-eslint/no-misused-promises
@@ -314,7 +380,11 @@ export default class ChargingStation {
   }
 
   public resetTransactionOnConnector(connectorId: number): void {
-    this.initTransactionOnConnector(connectorId);
+    this.getConnector(connectorId).transactionStarted = false;
+    delete this.getConnector(connectorId).transactionId;
+    delete this.getConnector(connectorId).idTag;
+    this.getConnector(connectorId).transactionEnergyActiveImportRegisterValue = 0;
+    delete this.getConnector(connectorId).transactionBeginMeterValue;
     this.stopMeterValues(connectorId);
   }
 
@@ -345,9 +415,9 @@ export default class ChargingStation {
 
   private getChargingStationId(stationTemplate: ChargingStationTemplate): string {
     // In case of multiple instances: add instance index to charging station id
-    let instanceIndex = process.env.CF_INSTANCE_INDEX ? process.env.CF_INSTANCE_INDEX : 0;
+    let instanceIndex = process.env.CF_INSTANCE_INDEX ?? 0;
     instanceIndex = instanceIndex > 0 ? instanceIndex : '';
-    const idSuffix = stationTemplate.nameSuffix ? stationTemplate.nameSuffix : '';
+    const idSuffix = stationTemplate.nameSuffix ?? '';
     return stationTemplate.fixedName ? stationTemplate.baseName : stationTemplate.baseName + '-' + instanceIndex.toString() + ('000000000' + this.index.toString()).substr(('000000000' + this.index.toString()).length - 4) + idSuffix;
   }
 
@@ -359,16 +429,23 @@ export default class ChargingStation {
       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;
+    const stationInfo: ChargingStationInfo = stationTemplateFromFile ?? {} as ChargingStationInfo;
     if (!Utils.isEmptyArray(stationTemplateFromFile.power)) {
       stationTemplateFromFile.power = stationTemplateFromFile.power as number[];
-      stationInfo.maxPower = stationTemplateFromFile.power[Math.floor(Math.random() * stationTemplateFromFile.power.length)];
+      const powerArrayRandomIndex = Math.floor(Math.random() * stationTemplateFromFile.power.length);
+      stationInfo.maxPower = stationTemplateFromFile.powerUnit === PowerUnits.KILO_WATT
+        ? stationTemplateFromFile.power[powerArrayRandomIndex] * 1000
+        : stationTemplateFromFile.power[powerArrayRandomIndex];
     } else {
-      stationInfo.maxPower = stationTemplateFromFile.power as number;
+      stationTemplateFromFile.power = stationTemplateFromFile.power as number;
+      stationInfo.maxPower = stationTemplateFromFile.powerUnit === PowerUnits.KILO_WATT
+        ? stationTemplateFromFile.power * 1000
+        : stationTemplateFromFile.power;
     }
+    delete stationInfo.power;
+    delete stationInfo.powerUnit;
     stationInfo.chargingStationId = this.getChargingStationId(stationTemplateFromFile);
     stationInfo.resetTime = stationTemplateFromFile.resetTime ? stationTemplateFromFile.resetTime * 1000 : Constants.CHARGING_STATION_DEFAULT_RESET_TIME;
     return stationInfo;
@@ -444,7 +521,7 @@ export default class ChargingStation {
     // Initialize transaction attributes on connectors
     for (const connector in this.connectors) {
       if (Utils.convertToInt(connector) > 0 && !this.getConnector(Utils.convertToInt(connector)).transactionStarted) {
-        this.initTransactionOnConnector(Utils.convertToInt(connector));
+        this.initTransactionAttributesOnConnector(Utils.convertToInt(connector));
       }
     }
     switch (this.getOCPPVersion()) {
@@ -457,10 +534,7 @@ export default class ChargingStation {
         break;
     }
     // OCPP parameters
-    this.addConfigurationKey(StandardParametersKey.NumberOfConnectors, this.getNumberOfConnectors().toString(), true);
-    if (!this.getConfigurationKey(StandardParametersKey.MeterValuesSampledData)) {
-      this.addConfigurationKey(StandardParametersKey.MeterValuesSampledData, MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER);
-    }
+    this.initOCPPParameters();
     this.stationInfo.powerDivider = this.getPowerDivider();
     if (this.getEnableStatistics()) {
       this.performanceStatistics = new PerformanceStatistics(this.stationInfo.chargingStationId);
@@ -472,6 +546,43 @@ export default class ChargingStation {
     }
   }
 
+  private initOCPPParameters(): void {
+    if (!this.getConfigurationKey(StandardParametersKey.SupportedFeatureProfiles)) {
+      this.addConfigurationKey(StandardParametersKey.SupportedFeatureProfiles, `${SupportedFeatureProfiles.Core},${SupportedFeatureProfiles.Local_Auth_List_Management},${SupportedFeatureProfiles.Smart_Charging}`);
+    }
+    this.addConfigurationKey(StandardParametersKey.NumberOfConnectors, this.getNumberOfConnectors().toString(), true);
+    if (!this.getConfigurationKey(StandardParametersKey.MeterValuesSampledData)) {
+      this.addConfigurationKey(StandardParametersKey.MeterValuesSampledData, MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER);
+    }
+    if (!this.getConfigurationKey(StandardParametersKey.ConnectorPhaseRotation)) {
+      const connectorPhaseRotation = [];
+      for (const connector in this.connectors) {
+        // AC/DC
+        if (Utils.convertToInt(connector) === 0 && this.getNumberOfPhases() === 0) {
+          connectorPhaseRotation.push(`${connector}.${ConnectorPhaseRotation.RST}`);
+        } else if (Utils.convertToInt(connector) > 0 && this.getNumberOfPhases() === 0) {
+          connectorPhaseRotation.push(`${connector}.${ConnectorPhaseRotation.NotApplicable}`);
+        // AC
+        } else if (Utils.convertToInt(connector) > 0 && this.getNumberOfPhases() === 1) {
+          connectorPhaseRotation.push(`${connector}.${ConnectorPhaseRotation.NotApplicable}`);
+        } else if (Utils.convertToInt(connector) > 0 && this.getNumberOfPhases() === 3) {
+          connectorPhaseRotation.push(`${connector}.${ConnectorPhaseRotation.RST}`);
+        }
+      }
+      this.addConfigurationKey(StandardParametersKey.ConnectorPhaseRotation, connectorPhaseRotation.toString());
+    }
+    if (!this.getConfigurationKey(StandardParametersKey.AuthorizeRemoteTxRequests)) {
+      this.addConfigurationKey(StandardParametersKey.AuthorizeRemoteTxRequests, 'true');
+    }
+    if (!this.getConfigurationKey(StandardParametersKey.LocalAuthListEnabled)
+        && this.getConfigurationKey(StandardParametersKey.SupportedFeatureProfiles).value.includes(SupportedFeatureProfiles.Local_Auth_List_Management)) {
+      this.addConfigurationKey(StandardParametersKey.LocalAuthListEnabled, 'false');
+    }
+    if (!this.getConfigurationKey(StandardParametersKey.ConnectionTimeOut)) {
+      this.addConfigurationKey(StandardParametersKey.ConnectionTimeOut, Constants.DEFAULT_CONNECTION_TIMEOUT.toString());
+    }
+  }
+
   private async onOpen(): Promise<void> {
     logger.info(`${this.logPrefix()} Is connected to server through ${this.wsConnectionUrl}`);
     if (!this.isRegistered()) {
@@ -522,7 +633,6 @@ export default class ChargingStation {
     try {
       // Parse the message
       [messageType, messageId, commandName, commandPayload, errorDetails] = JSON.parse(messageEvent.toString()) as IncomingRequest;
-
       // Check the Type of message
       switch (messageType) {
         // Incoming Message
@@ -586,7 +696,7 @@ export default class ChargingStation {
 
   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;
@@ -611,8 +721,7 @@ export default class ChargingStation {
         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);
@@ -636,13 +745,10 @@ export default class ChargingStation {
 
   // 0 for disabling
   private getConnectionTimeout(): number | undefined {
-    if (!Utils.isUndefined(this.stationInfo.connectionTimeout)) {
-      return this.stationInfo.connectionTimeout;
+    if (this.getConfigurationKey(StandardParametersKey.ConnectionTimeOut)) {
+      return parseInt(this.getConfigurationKey(StandardParametersKey.ConnectionTimeOut).value) ?? Constants.DEFAULT_CONNECTION_TIMEOUT;
     }
-    if (!Utils.isUndefined(Configuration.getConnectionTimeout())) {
-      return Configuration.getConnectionTimeout();
-    }
-    return 30;
+    return Constants.DEFAULT_CONNECTION_TIMEOUT;
   }
 
   // -1 for unlimited, 0 for disabling
@@ -753,7 +859,8 @@ export default class ChargingStation {
       for (const connector in this.connectors) {
         if (Utils.convertToInt(connector) > 0 && this.getConnector(Utils.convertToInt(connector)).transactionStarted) {
           const transactionId = this.getConnector(Utils.convertToInt(connector)).transactionId;
-          await this.ocppRequestService.sendStopTransaction(transactionId, this.getTransactionMeterStop(transactionId), this.getTransactionIdTag(transactionId), reason);
+          await this.ocppRequestService.sendStopTransaction(transactionId, this.getEnergyActiveImportRegisterByTransactionId(transactionId),
+            this.getTransactionIdTag(transactionId), reason);
         }
       }
     }
@@ -816,12 +923,8 @@ export default class ChargingStation {
   }
 
   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();
     }
@@ -845,36 +948,49 @@ export default class ChargingStation {
   }
 
   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', () => {
+          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 {
-    // 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 &&
+    try {
+      // eslint-disable-next-line @typescript-eslint/no-misused-promises
+      fs.watch(this.stationTemplateFile).on('change', async (): 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();
+            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);
         }
-        // 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);
-      }
-    });
+      });
+    } catch (error) {
+      FileUtils.handleFileException(this.logPrefix(), 'Template', this.stationTemplateFile, error);
+    }
   }
 
   private getReconnectExponentialDelay(): boolean | undefined {
@@ -904,11 +1020,10 @@ export default class ChargingStation {
     }
   }
 
-  private initTransactionOnConnector(connectorId: number): void {
+  private initTransactionAttributesOnConnector(connectorId: number): void {
     this.getConnector(connectorId).transactionStarted = false;
-    delete this.getConnector(connectorId).transactionId;
-    delete this.getConnector(connectorId).idTag;
-    this.getConnector(connectorId).lastEnergyActiveImportRegisterValue = -1;
+    this.getConnector(connectorId).energyActiveImportRegisterValue = 0;
+    this.getConnector(connectorId).transactionEnergyActiveImportRegisterValue = 0;
   }
 }