UI services: fix connectors status update at transaction start/stop
[e-mobility-charging-stations-simulator.git] / src / charging-station / ChargingStation.ts
index d771ebe08ab969147e65dcc2d7efcaa726ed6c2e..7d633eb07b97940002922cbefae236dad8e3e39a 100644 (file)
@@ -84,24 +84,24 @@ 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>;
@@ -110,22 +110,21 @@ export default class ChargingStation {
   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();
   }
@@ -152,10 +151,6 @@ export default class ChargingStation {
     );
   }
 
-  public getBootNotificationRequest(): BootNotificationRequest {
-    return this.bootNotificationRequest;
-  }
-
   public getRandomIdTag(): string {
     const authorizationFile = ChargingStationUtils.getAuthorizationFile(this.stationInfo);
     const index = Math.floor(
@@ -238,7 +233,7 @@ export default class ChargingStation {
     return this.connectors.get(0) ? this.connectors.size - 1 : this.connectors.size;
   }
 
-  public getConnectorStatus(id: number): ConnectorStatus {
+  public getConnectorStatus(id: number): ConnectorStatus | undefined {
     return this.connectors.get(id);
   }
 
@@ -336,22 +331,18 @@ export default class ChargingStation {
     }
   }
 
-  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 {
@@ -434,13 +425,13 @@ export default class ChargingStation {
       );
       return;
     }
-    if (!this.getConnectorStatus(connectorId)?.transactionStarted) {
+    if (this.getConnectorStatus(connectorId)?.transactionStarted === false) {
       logger.error(
         `${this.logPrefix()} Trying to start MeterValues on connector Id ${connectorId} with no transaction started`
       );
       return;
     } else if (
-      this.getConnectorStatus(connectorId)?.transactionStarted &&
+      this.getConnectorStatus(connectorId)?.transactionStarted === true &&
       !this.getConnectorStatus(connectorId)?.transactionId
     ) {
       logger.error(
@@ -507,7 +498,9 @@ export default class ChargingStation {
             this.initialize();
             // Restart the ATG
             this.stopAutomaticTransactionGenerator();
-            this.startAutomaticTransactionGenerator();
+            if (this.getAutomaticTransactionGeneratorConfigurationFromTemplate()?.enable) {
+              this.startAutomaticTransactionGenerator();
+            }
             if (this.getEnableStatistics()) {
               this.performanceStatistics.restart();
             } else {
@@ -526,9 +519,7 @@ export default class ChargingStation {
     parentPort.postMessage(MessageChannelUtils.buildStartedMessage(this));
   }
 
-  public async stop(reason: StopTransactionReason = StopTransactionReason.NONE): Promise<void> {
-    // Stop message sequence
-    await this.stopMessageSequence(reason);
+  public async stop(): Promise<void> {
     for (const connectorId of this.connectors.keys()) {
       if (connectorId > 0) {
         await this.ocppRequestService.requestHandler<
@@ -550,12 +541,12 @@ export default class ChargingStation {
     this.templateFileWatcher.close();
     this.sharedLRUCache.deleteChargingStationTemplate(this.stationInfo?.templateHash);
     this.bootNotificationResponse = null;
-    this.stopped = true;
+    this.started = false;
     parentPort.postMessage(MessageChannelUtils.buildStoppedMessage(this));
   }
 
-  public async reset(reason?: StopTransactionReason): Promise<void> {
-    await this.stop(reason);
+  public async reset(): Promise<void> {
+    await this.stop();
     await Utils.sleep(this.stationInfo.resetTime);
     this.initialize();
     this.start();
@@ -603,7 +594,6 @@ export default class ChargingStation {
                 ? limit
                 : DCElectricUtils.power(this.getVoltageOut(), limit);
         }
-
         const connectorMaximumPower = this.getMaximumPower() / this.powerDivider;
         if (limit > connectorMaximumPower) {
           logger.error(
@@ -662,6 +652,7 @@ export default class ChargingStation {
     this.getConnectorStatus(connectorId).transactionEnergyActiveImportRegisterValue = 0;
     delete this.getConnectorStatus(connectorId).transactionBeginMeterValue;
     this.stopMeterValues(connectorId);
+    parentPort.postMessage(MessageChannelUtils.buildUpdatedMessage(this));
   }
 
   public hasFeatureProfile(featureProfile: SupportedFeatureProfiles) {
@@ -707,8 +698,15 @@ export default class ChargingStation {
         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);
@@ -743,7 +741,90 @@ export default class ChargingStation {
     }
   }
 
-  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;
+    }
+  }
+
+  public getNumberOfRunningTransactions(): number {
+    let trxCount = 0;
+    for (const connectorId of this.connectors.keys()) {
+      if (connectorId > 0 && this.getConnectorStatus(connectorId)?.transactionStarted === true) {
+        trxCount++;
+      }
+    }
+    return trxCount;
+  }
+
+  public async stopRunningTransactions(reason = StopTransactionReason.NONE): Promise<void> {
+    for (const connectorId of this.connectors.keys()) {
+      if (connectorId > 0 && this.getConnectorStatus(connectorId)?.transactionStarted === true) {
+        await this.stopTransactionOnConnector(connectorId, reason);
+      }
+    }
+  }
+
+  public async stopTransactionOnConnector(
+    connectorId: number,
+    reason = StopTransactionReason.NONE
+  ): Promise<StopTransactionResponse> {
+    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,
+        {
+          connectorId,
+          transactionId,
+          meterValue: [transactionEndMeterValue],
+        }
+      );
+    }
+    return this.ocppRequestService.requestHandler<StopTransactionRequest, StopTransactionResponse>(
+      this,
+      RequestCommand.STOP_TRANSACTION,
+      {
+        transactionId,
+        meterStop: this.getEnergyActiveImportRegisterByTransactionId(transactionId, true),
+        idTag: this.getTransactionIdTag(transactionId),
+        reason,
+      }
+    );
+  }
+
+  private flushMessageBuffer(): void {
     if (this.messageBuffer.size > 0) {
       this.messageBuffer.forEach((message) => {
         // TODO: evaluate the need to track performance
@@ -817,6 +898,7 @@ export default class ChargingStation {
     );
     const stationInfo: ChargingStationInfo =
       ChargingStationUtils.stationTemplateToStationInfo(stationTemplate);
+    stationInfo.hashId = ChargingStationUtils.getHashId(this.index, stationTemplate);
     stationInfo.chargingStationId = ChargingStationUtils.getChargingStationId(
       this.index,
       stationTemplate
@@ -926,20 +1008,19 @@ export default class ChargingStation {
   }
 
   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
       );
@@ -1206,7 +1287,7 @@ export default class ChargingStation {
     }
     // Initialize transaction attributes on connectors
     for (const connectorId of this.connectors.keys()) {
-      if (connectorId > 0 && !this.getConnectorStatus(connectorId)?.transactionStarted) {
+      if (connectorId > 0 && this.getConnectorStatus(connectorId)?.transactionStarted === false) {
         this.initializeConnectorStatus(connectorId);
       }
     }
@@ -1365,9 +1446,10 @@ export default class ChargingStation {
           `${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;
+      parentPort.postMessage(MessageChannelUtils.buildUpdatedMessage(this));
     } else {
       logger.warn(
         `${this.logPrefix()} Connection to OCPP server through ${this.wsConnectionUrl.toString()} failed`
@@ -1381,22 +1463,24 @@ export default class ChargingStation {
       case WebSocketCloseEventStatusCode.CLOSE_NORMAL:
       case WebSocketCloseEventStatusCode.CLOSE_NO_STATUS:
         logger.info(
-          `${this.logPrefix()} WebSocket normally closed with status '${ChargingStationUtils.getWebSocketCloseEventStatusString(
+          `${this.logPrefix()} WebSocket normally closed with status '${Utils.getWebSocketCloseEventStatusString(
             code
           )}' and reason '${reason}'`
         );
         this.autoReconnectRetryCount = 0;
+        await this.stopMessageSequence(StopTransactionReason.OTHER);
         break;
       // Abnormal close
       default:
         logger.error(
-          `${this.logPrefix()} WebSocket abnormally closed with status '${ChargingStationUtils.getWebSocketCloseEventStatusString(
+          `${this.logPrefix()} WebSocket abnormally closed with status '${Utils.getWebSocketCloseEventStatusString(
             code
           )}' and reason '${reason}'`
         );
         await this.reconnect(code);
         break;
     }
+    parentPort.postMessage(MessageChannelUtils.buildUpdatedMessage(this));
   }
 
   private async onMessage(data: Data): Promise<void> {
@@ -1554,6 +1638,24 @@ export default class ChargingStation {
     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)
@@ -1561,16 +1663,6 @@ export default class ChargingStation {
       : true;
   }
 
-  private getNumberOfRunningTransactions(): number {
-    let trxCount = 0;
-    for (const connectorId of this.connectors.keys()) {
-      if (connectorId > 0 && this.getConnectorStatus(connectorId)?.transactionStarted) {
-        trxCount++;
-      }
-    }
-    return trxCount;
-  }
-
   // 0 for disabling
   private getConnectionTimeout(): number | undefined {
     if (
@@ -1687,7 +1779,7 @@ export default class ChargingStation {
       if (connectorId === 0) {
         continue;
       } else if (
-        !this.stopped &&
+        this.started === true &&
         !this.getConnectorStatus(connectorId)?.status &&
         this.getConnectorStatus(connectorId)?.bootStatus
       ) {
@@ -1703,7 +1795,7 @@ export default class ChargingStation {
         this.getConnectorStatus(connectorId).status =
           this.getConnectorStatus(connectorId).bootStatus;
       } else if (
-        this.stopped &&
+        this.started === false &&
         this.getConnectorStatus(connectorId)?.status &&
         this.getConnectorStatus(connectorId)?.bootStatus
       ) {
@@ -1718,7 +1810,7 @@ export default class ChargingStation {
         });
         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,
@@ -1742,27 +1834,8 @@ export default class ChargingStation {
       }
     }
     // 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();
     }
   }
 
@@ -1774,43 +1847,11 @@ export default class ChargingStation {
     // 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,
-              {
-                connectorId,
-                transactionId,
-                meterValue: [transactionEndMeterValue],
-              }
-            );
-          }
-          await this.ocppRequestService.requestHandler<
-            StopTransactionRequest,
-            StopTransactionResponse
-          >(this, RequestCommand.STOP_TRANSACTION, {
-            transactionId,
-            meterStop: this.getEnergyActiveImportRegisterByTransactionId(transactionId),
-            idTag: this.getTransactionIdTag(transactionId),
-            reason,
-          });
-        }
+    if (this.getNumberOfRunningTransactions() > 0) {
+      if (this.automaticTransactionGenerator?.started) {
+        this.stopAutomaticTransactionGenerator();
+      } else {
+        await this.stopRunningTransactions(reason);
       }
     }
   }
@@ -1956,7 +1997,7 @@ export default class ChargingStation {
     // Stop heartbeat
     this.stopHeartbeat();
     // Stop the ATG if needed
-    if (this.automaticTransactionGenerator?.configuration?.stopOnConnectionFailure) {
+    if (this.automaticTransactionGenerator?.configuration?.stopOnConnectionFailure === true) {
       this.stopAutomaticTransactionGenerator();
     }
     if (
@@ -1990,6 +2031,7 @@ export default class ChargingStation {
       );
       this.wsConnectionRestarted = true;
     } else if (this.getAutoReconnectMaxRetries() !== -1) {
+      await this.stopMessageSequence(StopTransactionReason.OTHER);
       logger.error(
         `${this.logPrefix()} WebSocket reconnect failure: maximum retries reached (${
           this.autoReconnectRetryCount