X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fcharging-station%2FChargingStation.ts;h=78db2058c3bcac8b170a823b354cb7431a5b1013;hb=853ed24a1ca05b0de603402228dd99e7c41fa397;hp=25d9733b0e67063939d7174bae430e39bb058841;hpb=db2336d96424096d5570606680824af180e33c3a;p=e-mobility-charging-stations-simulator.git diff --git a/src/charging-station/ChargingStation.ts b/src/charging-station/ChargingStation.ts index 25d9733b..78db2058 100644 --- a/src/charging-station/ChargingStation.ts +++ b/src/charging-station/ChargingStation.ts @@ -11,19 +11,19 @@ import WebSocket, { Data, RawData } from 'ws'; import BaseError from '../exception/BaseError'; import OCPPError from '../exception/OCPPError'; import PerformanceStatistics from '../performance/PerformanceStatistics'; -import { AutomaticTransactionGeneratorConfiguration } from '../types/AutomaticTransactionGenerator'; -import ChargingStationConfiguration from '../types/ChargingStationConfiguration'; -import ChargingStationInfo from '../types/ChargingStationInfo'; -import ChargingStationOcppConfiguration from '../types/ChargingStationOcppConfiguration'; +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, { CurrentType, PowerUnits, WsOptions, } from '../types/ChargingStationTemplate'; import { SupervisionUrlDistribution } from '../types/ConfigurationData'; -import { ConnectorStatus } from '../types/ConnectorStatus'; +import type { ConnectorStatus } from '../types/ConnectorStatus'; import { FileType } from '../types/FileType'; -import { JsonType } from '../types/JsonType'; +import type { JsonType } from '../types/JsonType'; import { ChargePointErrorCode } from '../types/ocpp/ChargePointErrorCode'; import { ChargePointStatus } from '../types/ocpp/ChargePointStatus'; import { ChargingProfile, ChargingRateUnitType } from '../types/ocpp/ChargingProfile'; @@ -79,29 +79,29 @@ import OCPP16IncomingRequestService from './ocpp/1.6/OCPP16IncomingRequestServic import OCPP16RequestService from './ocpp/1.6/OCPP16RequestService'; import OCPP16ResponseService from './ocpp/1.6/OCPP16ResponseService'; import { OCPP16ServiceUtils } from './ocpp/1.6/OCPP16ServiceUtils'; -import OCPPIncomingRequestService from './ocpp/OCPPIncomingRequestService'; -import OCPPRequestService from './ocpp/OCPPRequestService'; +import type OCPPIncomingRequestService from './ocpp/OCPPIncomingRequestService'; +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; + public started: boolean; + public authorizedTagsCache: AuthorizedTagsCache; + public automaticTransactionGenerator!: AutomaticTransactionGenerator; public ocppConfiguration!: ChargingStationOcppConfiguration; public wsConnection!: WebSocket; + public readonly connectors: Map; public readonly requests: Map; 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; @@ -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(); this.requests = new Map(); this.messageBuffer = new Set(); + 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( @@ -178,8 +173,8 @@ export default class ChargingStation { : true; } - public getMayAuthorizeAtRemoteStart(): boolean | undefined { - return this.stationInfo.mayAuthorizeAtRemoteStart ?? true; + public getMustAuthorizeAtRemoteStart(): boolean | undefined { + return this.stationInfo.mustAuthorizeAtRemoteStart ?? true; } public getPayloadSchemaValidation(): boolean | undefined { @@ -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 { @@ -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 { @@ -550,8 +543,8 @@ export default class ChargingStation { this.templateFileWatcher.close(); this.sharedLRUCache.deleteChargingStationTemplate(this.stationInfo?.templateHash); this.bootNotificationResponse = null; + this.started = false; parentPort.postMessage(MessageChannelUtils.buildStoppedMessage(this)); - this.stopped = true; } public async reset(reason?: StopTransactionReason): Promise { @@ -583,7 +576,7 @@ export default class ChargingStation { if (!Utils.isEmptyArray(chargingProfiles)) { const result = ChargingStationUtils.getLimitFromChargingProfiles( chargingProfiles, - Utils.logPrefix() + this.logPrefix() ); if (!Utils.isNullOrUndefined(result)) { limit = result.limit; @@ -626,7 +619,7 @@ export default class ChargingStation { ); this.getConnectorStatus(connectorId).chargingProfiles = []; } - if (!Array.isArray(this.getConnectorStatus(connectorId).chargingProfiles)) { + if (Array.isArray(this.getConnectorStatus(connectorId).chargingProfiles) === false) { logger.error( `${this.logPrefix()} Trying to set a charging profile on connectorId ${connectorId} with an improper attribute type for the charging profiles array, applying proper type initialization` ); @@ -707,8 +700,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 +743,34 @@ 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; + } + } + + private flushMessageBuffer(): void { if (this.messageBuffer.size > 0) { this.messageBuffer.forEach((message) => { // TODO: evaluate the need to track performance @@ -817,6 +844,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 @@ -846,14 +874,14 @@ export default class ChargingStation { ChargingStationUtils.checkConfiguredMaxConnectors( configuredMaxConnectors, this.templateFile, - Utils.logPrefix() + this.logPrefix() ); const templateMaxConnectors = ChargingStationUtils.getTemplateMaxNumberOfConnectors(stationTemplate); ChargingStationUtils.checkTemplateMaxConnectors( templateMaxConnectors, this.templateFile, - Utils.logPrefix() + this.logPrefix() ); if ( configuredMaxConnectors > @@ -920,28 +948,25 @@ export default class ChargingStation { } private handleUnsupportedVersion(version: OCPPVersion) { - const errMsg = `${this.logPrefix()} Unsupported protocol version '${version}' configured in template file ${ - this.templateFile - }`; - logger.error(errMsg); + const errMsg = `Unsupported protocol version '${version}' configured in template file ${this.templateFile}`; + logger.error(`${this.logPrefix()} ${errMsg}`); throw new BaseError(errMsg); } 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 ); @@ -1142,10 +1167,8 @@ export default class ChargingStation { templateMaxConnectors: number ): void { if (!stationInfo?.Connectors && this.connectors.size === 0) { - const logMsg = `${this.logPrefix()} No already defined connectors and charging station information from template ${ - this.templateFile - } with no connectors configuration defined`; - logger.error(logMsg); + const logMsg = `No already defined connectors and charging station information from template ${this.templateFile} with no connectors configuration defined`; + logger.error(`${this.logPrefix()} ${logMsg}`); throw new BaseError(logMsg); } if (!stationInfo?.Connectors[0]) { @@ -1369,7 +1392,7 @@ 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; } else { @@ -1419,7 +1442,7 @@ export default class ChargingStation { let errMsg: string; try { const request = JSON.parse(data.toString()) as IncomingRequest | Response | ErrorResponse; - if (Utils.isIterable(request)) { + if (Array.isArray(request) === true) { [messageType, messageId] = request; // Check the type of message switch (messageType) { @@ -1456,12 +1479,12 @@ export default class ChargingStation { } // Respond cachedRequest = this.requests.get(messageId); - if (Utils.isIterable(cachedRequest)) { + if (Array.isArray(cachedRequest) === true) { [responseCallback, , requestCommandName, requestPayload] = cachedRequest; } else { throw new OCPPError( ErrorType.PROTOCOL_ERROR, - `Cached request for message id ${messageId} response is not iterable`, + `Cached request for message id ${messageId} response is not an array`, null, cachedRequest as unknown as JsonType ); @@ -1486,12 +1509,12 @@ export default class ChargingStation { ); } cachedRequest = this.requests.get(messageId); - if (Utils.isIterable(cachedRequest)) { + if (Array.isArray(cachedRequest) === true) { [, errorCallback, requestCommandName] = cachedRequest; } else { throw new OCPPError( ErrorType.PROTOCOL_ERROR, - `Cached request for message id ${messageId} error response is not iterable`, + `Cached request for message id ${messageId} error response is not an array`, null, cachedRequest as unknown as JsonType ); @@ -1506,32 +1529,31 @@ export default class ChargingStation { // Error default: // eslint-disable-next-line @typescript-eslint/restrict-template-expressions - errMsg = `${this.logPrefix()} Wrong message type ${messageType}`; - logger.error(errMsg); + errMsg = `Wrong message type ${messageType}`; + logger.error(`${this.logPrefix()} ${errMsg}`); throw new OCPPError(ErrorType.PROTOCOL_ERROR, errMsg); } parentPort.postMessage(MessageChannelUtils.buildUpdatedMessage(this)); } else { - throw new OCPPError(ErrorType.PROTOCOL_ERROR, 'Incoming message is not iterable', null, { + throw new OCPPError(ErrorType.PROTOCOL_ERROR, 'Incoming message is not an array', null, { payload: request, }); } } catch (error) { // Log logger.error( - "%s Incoming OCPP '%s' message '%j' matching cached request '%j' processing error:", - this.logPrefix(), - commandName ?? requestCommandName ?? null, - data.toString(), - this.requests.get(messageId), + `${this.logPrefix()} Incoming OCPP command '${ + commandName ?? requestCommandName ?? null + }' message '${data.toString()}' matching cached request '${JSON.stringify( + this.requests.get(messageId) + )}' processing error:`, error ); if (!(error instanceof OCPPError)) { logger.warn( - "%s Error thrown at incoming OCPP '%s' message '%j' handling is not an OCPPError:", - this.logPrefix(), - commandName ?? requestCommandName ?? null, - data.toString(), + `${this.logPrefix()} Error thrown at incoming OCPP command '${ + commandName ?? requestCommandName ?? null + }' message '${data.toString()}' handling is not an OCPPError:`, error ); } @@ -1559,6 +1581,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) @@ -1692,7 +1732,7 @@ export default class ChargingStation { if (connectorId === 0) { continue; } else if ( - !this.stopped && + this.started === true && !this.getConnectorStatus(connectorId)?.status && this.getConnectorStatus(connectorId)?.bootStatus ) { @@ -1708,7 +1748,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 ) { @@ -1723,7 +1763,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, @@ -1747,27 +1787,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(); } } @@ -1779,42 +1800,44 @@ 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( - this, - RequestCommand.METER_VALUES, - { + if (this.getNumberOfRunningTransactions() > 0) { + if (this.automaticTransactionGenerator?.started) { + 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, - transactionId, - meterValue: [transactionEndMeterValue], - } - ); + this.getEnergyActiveImportRegisterByTransactionId(transactionId) + ); + await this.ocppRequestService.requestHandler( + this, + RequestCommand.METER_VALUES, + { + connectorId, + transactionId, + meterValue: [transactionEndMeterValue], + } + ); + } + await this.ocppRequestService.requestHandler< + StopTransactionRequest, + StopTransactionResponse + >(this, RequestCommand.STOP_TRANSACTION, { + transactionId, + meterStop: this.getEnergyActiveImportRegisterByTransactionId(transactionId, true), + idTag: this.getTransactionIdTag(transactionId), + reason, + }); } - await this.ocppRequestService.requestHandler< - StopTransactionRequest, - StopTransactionResponse - >(this, RequestCommand.STOP_TRANSACTION, { - transactionId, - meterStop: this.getEnergyActiveImportRegisterByTransactionId(transactionId), - idTag: this.getTransactionIdTag(transactionId), - reason, - }); } } }