X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=src%2Fcharging-station%2FChargingStation.ts;h=ff912e97d36c95eb3220c2743c506b9ad6f62a36;hb=6e0964c8dff48691f7155d12096e777a8f9389f4;hp=a7081aa97eb68c74bc5522a557276972062fdd15;hpb=1af50fac1ab71fed19f11864d1644261046698a3;p=e-mobility-charging-stations-simulator.git diff --git a/src/charging-station/ChargingStation.ts b/src/charging-station/ChargingStation.ts index a7081aa9..ff912e97 100644 --- a/src/charging-station/ChargingStation.ts +++ b/src/charging-station/ChargingStation.ts @@ -1,6 +1,6 @@ -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'; @@ -21,40 +21,41 @@ import OCPPError from './OcppError'; 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; @@ -73,7 +74,7 @@ export default class ChargingStation { } public logPrefix(): string { - return Utils.logPrefix(` ${this.stationInfo.chargingStationId}:`); + return Utils.logPrefix(` ${this.stationInfo.chargingStationId} |`); } public getRandomTagId(): string { @@ -85,15 +86,15 @@ export default class ChargingStation { 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; } } @@ -118,18 +119,18 @@ export default class ChargingStation { 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: @@ -139,7 +140,7 @@ export default class ChargingStation { 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; @@ -147,7 +148,7 @@ export default class ChargingStation { } } - 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; @@ -180,7 +181,7 @@ export default class ChargingStation { }, 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`); } @@ -223,7 +224,7 @@ export default class ChargingStation { } }, 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`); } } @@ -263,8 +264,8 @@ export default class ChargingStation { 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(); } @@ -300,7 +301,7 @@ export default class ChargingStation { 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; @@ -308,7 +309,7 @@ export default class ChargingStation { } }); } - this.getConnector(connectorId).chargingProfiles.push(cp); + this.getConnector(connectorId).chargingProfiles?.push(cp); return true; } @@ -319,6 +320,31 @@ export default class ChargingStation { } } + 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); + }); + } + } + 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; @@ -439,10 +465,10 @@ export default class ChargingStation { } 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(); }); } @@ -454,22 +480,19 @@ export default class ChargingStation { // 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); } } while (!this.isRegistered() && (registrationRetryCount <= this.getRegistrationMaxRetries() || this.getRegistrationMaxRetries() === -1)); - } else if (this.isRegistered()) { + } + if (this.isRegistered()) { 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()})`); @@ -478,7 +501,7 @@ export default class ChargingStation { this.hasSocketRestarted = false; } - private async onClose(closeEvent): Promise { + private async onClose(closeEvent: any): Promise { switch (closeEvent) { case WebSocketCloseEventStatusCode.CLOSE_NORMAL: // Normal close case WebSocketCloseEventStatusCode.CLOSE_NO_STATUS: @@ -494,7 +517,7 @@ export default class ChargingStation { private async onMessage(messageEvent: MessageEvent): Promise { let [messageType, messageId, commandName, commandPayload, errorDetails]: IncomingRequest = [0, '', '' as IncomingRequestCommand, {}, {}]; - let responseCallback: (payload?: Record | string, requestPayload?: Record) => void; + let responseCallback: (payload: Record | string, requestPayload: Record) => void; let rejectCallback: (error: OCPPError) => void; let requestPayload: Record; let errMsg: string; @@ -507,7 +530,7 @@ export default class ChargingStation { // 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); @@ -563,7 +586,7 @@ export default class ChargingStation { logger.debug(this.logPrefix() + ' Has received a WS pong (rfc6455) from the server'); } - private async onError(errorEvent): Promise { + private async onError(errorEvent: any): Promise { logger.error(this.logPrefix() + ' Socket error: %j', errorEvent); // pragma switch (errorEvent.code) { // case 'ECONNREFUSED': @@ -576,8 +599,8 @@ export default class ChargingStation { 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[] { @@ -599,7 +622,7 @@ export default class ChargingStation { return authorizedTags; } - private getUseConnectorId0(): boolean { + private getUseConnectorId0(): boolean | undefined { return !Utils.isUndefined(this.stationInfo.useConnectorId0) ? this.stationInfo.useConnectorId0 : true; } @@ -614,7 +637,7 @@ export default class ChargingStation { } // 0 for disabling - private getConnectionTimeout(): number { + private getConnectionTimeout(): number | undefined { if (!Utils.isUndefined(this.stationInfo.connectionTimeout)) { return this.stationInfo.connectionTimeout; } @@ -625,7 +648,7 @@ export default class ChargingStation { } // -1 for unlimited, 0 for disabling - private getAutoReconnectMaxRetries(): number { + private getAutoReconnectMaxRetries(): number | undefined { if (!Utils.isUndefined(this.stationInfo.autoReconnectMaxRetries)) { return this.stationInfo.autoReconnectMaxRetries; } @@ -636,7 +659,7 @@ export default class ChargingStation { } // 0 for disabling - private getRegistrationMaxRetries(): number { + private getRegistrationMaxRetries(): number | undefined { if (!Utils.isUndefined(this.stationInfo.registrationMaxRetries)) { return this.stationInfo.registrationMaxRetries; } @@ -705,11 +728,12 @@ export default class ChargingStation { 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(); + this.performanceStatistics.start(); } } @@ -752,7 +776,6 @@ export default class ChargingStation { private stopWebSocketPing(): void { if (this.webSocketPingSetInterval) { clearInterval(this.webSocketPingSetInterval); - this.webSocketPingSetInterval = null; } } @@ -771,7 +794,7 @@ export default class ChargingStation { 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; @@ -785,7 +808,6 @@ export default class ChargingStation { private stopHeartbeat(): void { if (this.heartbeatSetInterval) { clearInterval(this.heartbeatSetInterval); - this.heartbeatSetInterval = null; } } @@ -793,7 +815,7 @@ export default class ChargingStation { if (Utils.isUndefined(options)) { options = {} as WebSocket.ClientOptions; } - if (Utils.isUndefined(options.handshakeTimeout)) { + if (Utils.isUndefined(options?.handshakeTimeout)) { options.handshakeTimeout = this.getConnectionTimeout() * 1000; } if (this.isWebSocketOpen() && forceCloseOpened) { @@ -842,7 +864,8 @@ export default class ChargingStation { this.automaticTransactionGeneration = new AutomaticTransactionGenerator(this); } if (this.automaticTransactionGeneration.timeToStop) { - await this.automaticTransactionGeneration.start(); + // The ATG might sleep + void this.automaticTransactionGeneration.start(); } } // FIXME?: restart heartbeat and WebSocket ping when their interval values have changed @@ -852,11 +875,11 @@ export default class ChargingStation { }); } - private getReconnectExponentialDelay(): boolean { + private getReconnectExponentialDelay(): boolean | undefined { return !Utils.isUndefined(this.stationInfo.reconnectExponentialDelay) ? this.stationInfo.reconnectExponentialDelay : false; } - private async reconnect(error): Promise { + private async reconnect(error: any): Promise { // Stop heartbeat this.stopHeartbeat(); // Stop the ATG if needed @@ -881,8 +904,8 @@ export default class ChargingStation { 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; } }