X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fcharging-station%2FChargingStation.ts;h=29119f92cf35d85f449fdf7d360f20b66af63e50;hb=17bc43d765c22c8d8c132484f8dc9c3edd370d91;hp=639123abe9f814631de87409c7fbc7ad66c5a3b0;hpb=72092cfcf8a31c06e4592b25e060e2d74d2ed99c;p=e-mobility-charging-stations-simulator.git diff --git a/src/charging-station/ChargingStation.ts b/src/charging-station/ChargingStation.ts index 639123ab..29119f92 100644 --- a/src/charging-station/ChargingStation.ts +++ b/src/charging-station/ChargingStation.ts @@ -1,111 +1,107 @@ // Partial Copyright Jerome Benoit. 2021-2023. All Rights Reserved. -import fs from 'fs'; import crypto from 'node:crypto'; -import path from 'path'; -import { URL } from 'url'; +import fs from 'node:fs'; +import path from 'node:path'; +import { URL } from 'node:url'; import { parentPort } from 'worker_threads'; import merge from 'just-merge'; import WebSocket, { type RawData } from 'ws'; -import AuthorizedTagsCache from './AuthorizedTagsCache'; -import AutomaticTransactionGenerator from './AutomaticTransactionGenerator'; +import { AuthorizedTagsCache } from './AuthorizedTagsCache'; +import { AutomaticTransactionGenerator } from './AutomaticTransactionGenerator'; import { ChargingStationConfigurationUtils } from './ChargingStationConfigurationUtils'; import { ChargingStationUtils } from './ChargingStationUtils'; -import ChargingStationWorkerBroadcastChannel from './ChargingStationWorkerBroadcastChannel'; +import { ChargingStationWorkerBroadcastChannel } from './ChargingStationWorkerBroadcastChannel'; import { MessageChannelUtils } from './MessageChannelUtils'; -import OCPP16IncomingRequestService from './ocpp/1.6/OCPP16IncomingRequestService'; -import OCPP16RequestService from './ocpp/1.6/OCPP16RequestService'; -import OCPP16ResponseService from './ocpp/1.6/OCPP16ResponseService'; -import { OCPP16ServiceUtils } from './ocpp/1.6/OCPP16ServiceUtils'; -import OCPP20IncomingRequestService from './ocpp/2.0/OCPP20IncomingRequestService'; -import OCPP20RequestService from './ocpp/2.0/OCPP20RequestService'; -import OCPP20ResponseService from './ocpp/2.0/OCPP20ResponseService'; -import type OCPPIncomingRequestService from './ocpp/OCPPIncomingRequestService'; -import type OCPPRequestService from './ocpp/OCPPRequestService'; -import { OCPPServiceUtils } from './ocpp/OCPPServiceUtils'; -import SharedLRUCache from './SharedLRUCache'; -import BaseError from '../exception/BaseError'; -import OCPPError from '../exception/OCPPError'; -import PerformanceStatistics from '../performance/PerformanceStatistics'; -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 { - type ChargingStationTemplate, - CurrentType, - PowerUnits, - type WsOptions, -} from '../types/ChargingStationTemplate'; -import { SupervisionUrlDistribution } from '../types/ConfigurationData'; -import type { ConnectorStatus } from '../types/ConnectorStatus'; -import { FileType } from '../types/FileType'; -import type { JsonType } from '../types/JsonType'; -import { - ConnectorPhaseRotation, - StandardParametersKey, - SupportedFeatureProfiles, - VendorDefaultParametersKey, -} from '../types/ocpp/Configuration'; -import { ConnectorStatusEnum } from '../types/ocpp/ConnectorStatusEnum'; -import { ErrorType } from '../types/ocpp/ErrorType'; -import { MessageType } from '../types/ocpp/MessageType'; -import { MeterValue, MeterValueMeasurand } from '../types/ocpp/MeterValues'; -import { OCPPVersion } from '../types/ocpp/OCPPVersion'; + OCPP16IncomingRequestService, + OCPP16RequestService, + OCPP16ResponseService, + OCPP16ServiceUtils, + OCPP20IncomingRequestService, + OCPP20RequestService, + OCPP20ResponseService, + type OCPPIncomingRequestService, + type OCPPRequestService, + OCPPServiceUtils, +} from './ocpp'; +import { SharedLRUCache } from './SharedLRUCache'; +import { BaseError, OCPPError } from '../exception'; +import { PerformanceStatistics } from '../performance'; import { + type AutomaticTransactionGeneratorConfiguration, AvailabilityType, type BootNotificationRequest, + type BootNotificationResponse, type CachedRequest, + type ChargingStationConfiguration, + type ChargingStationInfo, + type ChargingStationOcppConfiguration, + type ChargingStationTemplate, + ConnectorPhaseRotation, + ConnectorStatus, + ConnectorStatusEnum, + CurrentType, type ErrorCallback, + type ErrorResponse, + ErrorType, + FileType, FirmwareStatus, type FirmwareStatusNotificationRequest, + type FirmwareStatusNotificationResponse, + type FirmwareUpgrade, type HeartbeatRequest, + type HeartbeatResponse, type IncomingRequest, - IncomingRequestCommand, + type IncomingRequestCommand, + type JsonType, + MessageType, + type MeterValue, + MeterValueMeasurand, type MeterValuesRequest, + type MeterValuesResponse, + OCPPVersion, type OutgoingRequest, + PowerUnits, + RegistrationStatusEnumType, RequestCommand, + type Response, type ResponseCallback, + StandardParametersKey, type StatusNotificationRequest, -} from '../types/ocpp/Requests'; -import { - type BootNotificationResponse, - type ErrorResponse, - type FirmwareStatusNotificationResponse, - type HeartbeatResponse, - type MeterValuesResponse, - RegistrationStatusEnumType, - type Response, type StatusNotificationResponse, -} from '../types/ocpp/Responses'; -import { StopTransactionReason, type StopTransactionRequest, type StopTransactionResponse, -} from '../types/ocpp/Transaction'; -import { WSError, WebSocketCloseEventStatusCode } from '../types/WebSocket'; -import Configuration from '../utils/Configuration'; -import Constants from '../utils/Constants'; + SupervisionUrlDistribution, + SupportedFeatureProfiles, + VendorDefaultParametersKey, + type WSError, + WebSocketCloseEventStatusCode, + type WsOptions, +} from '../types'; +import { Configuration } from '../utils/Configuration'; +import { Constants } from '../utils/Constants'; import { ACElectricUtils, DCElectricUtils } from '../utils/ElectricUtils'; -import FileUtils from '../utils/FileUtils'; -import logger from '../utils/Logger'; -import Utils from '../utils/Utils'; +import { FileUtils } from '../utils/FileUtils'; +import { logger } from '../utils/Logger'; +import { Utils } from '../utils/Utils'; -export default class ChargingStation { +export class ChargingStation { public readonly index: number; public readonly templateFile: string; public stationInfo!: ChargingStationInfo; public started: boolean; public starting: boolean; public authorizedTagsCache: AuthorizedTagsCache; - public automaticTransactionGenerator!: AutomaticTransactionGenerator; - public ocppConfiguration!: ChargingStationOcppConfiguration | null; + public automaticTransactionGenerator!: AutomaticTransactionGenerator | undefined; + public ocppConfiguration!: ChargingStationOcppConfiguration | undefined; public wsConnection!: WebSocket | null; public readonly connectors: Map; public readonly requests: Map; - public performanceStatistics!: PerformanceStatistics; + public performanceStatistics!: PerformanceStatistics | undefined; public heartbeatSetInterval!: NodeJS.Timeout; public ocppRequestService!: OCPPRequestService; public bootNotificationRequest!: BootNotificationRequest; @@ -157,17 +153,19 @@ export default class ChargingStation { ); } - public logPrefix(): string { + public logPrefix = (): string => { return Utils.logPrefix( ` ${ - this?.stationInfo?.chargingStationId ?? - ChargingStationUtils.getChargingStationId(this.index, this.getTemplateFromFile()) + (Utils.isNotEmptyString(this?.stationInfo?.chargingStationId) && + this?.stationInfo?.chargingStationId) ?? + ChargingStationUtils.getChargingStationId(this.index, this.getTemplateFromFile()) ?? + '' } |` ); - } + }; public hasAuthorizedTags(): boolean { - return !Utils.isEmptyArray( + return Utils.isNotEmptyArray( this.authorizedTagsCache.getAuthorizedTags( ChargingStationUtils.getAuthorizationFile(this.stationInfo) ) @@ -452,7 +450,7 @@ export default class ChargingStation { return; } else if ( this.getConnectorStatus(connectorId)?.transactionStarted === true && - !this.getConnectorStatus(connectorId)?.transactionId + Utils.isNullOrUndefined(this.getConnectorStatus(connectorId)?.transactionId) ) { logger.error( `${this.logPrefix()} Trying to start MeterValues on connector Id ${connectorId} with no transaction id` @@ -501,17 +499,17 @@ export default class ChargingStation { if (this.starting === false) { this.starting = true; if (this.getEnableStatistics() === true) { - this.performanceStatistics.start(); + this.performanceStatistics?.start(); } this.openWSConnection(); // Monitor charging station template file this.templateFileWatcher = FileUtils.watchJsonFile( - this.logPrefix(), - FileType.ChargingStationTemplate, this.templateFile, - null, + FileType.ChargingStationTemplate, + this.logPrefix(), + undefined, (event, filename): void => { - if (filename && event === 'change') { + if (Utils.isNotEmptyString(filename) && event === 'change') { try { logger.debug( `${this.logPrefix()} ${FileType.ChargingStationTemplate} ${ @@ -529,9 +527,9 @@ export default class ChargingStation { this.startAutomaticTransactionGenerator(); } if (this.getEnableStatistics() === true) { - this.performanceStatistics.restart(); + this.performanceStatistics?.restart(); } else { - this.performanceStatistics.stop(); + this.performanceStatistics?.stop(); } // FIXME?: restart heartbeat and WebSocket ping when their interval values have changed } catch (error) { @@ -561,7 +559,7 @@ export default class ChargingStation { await this.stopMessageSequence(reason); this.closeWSConnection(); if (this.getEnableStatistics() === true) { - this.performanceStatistics.stop(); + this.performanceStatistics?.stop(); } this.sharedLRUCache.deleteChargingStationConfiguration(this.configurationFileHash); this.templateFileWatcher?.close(); @@ -596,12 +594,12 @@ export default class ChargingStation { this.getConnectorStatus(connectorId).idTagAuthorized = false; this.getConnectorStatus(connectorId).transactionRemoteStarted = false; this.getConnectorStatus(connectorId).transactionStarted = false; - delete this.getConnectorStatus(connectorId).localAuthorizeIdTag; - delete this.getConnectorStatus(connectorId).authorizeIdTag; - delete this.getConnectorStatus(connectorId).transactionId; - delete this.getConnectorStatus(connectorId).transactionIdTag; + delete this.getConnectorStatus(connectorId)?.localAuthorizeIdTag; + delete this.getConnectorStatus(connectorId)?.authorizeIdTag; + delete this.getConnectorStatus(connectorId)?.transactionId; + delete this.getConnectorStatus(connectorId)?.transactionIdTag; this.getConnectorStatus(connectorId).transactionEnergyActiveImportRegisterValue = 0; - delete this.getConnectorStatus(connectorId).transactionBeginMeterValue; + delete this.getConnectorStatus(connectorId)?.transactionBeginMeterValue; this.stopMeterValues(connectorId); parentPort?.postMessage(MessageChannelUtils.buildUpdatedMessage(this)); } @@ -710,18 +708,18 @@ export default class ChargingStation { this.getAutomaticTransactionGeneratorConfigurationFromTemplate(), this ); - if (!Utils.isEmptyArray(connectorIds)) { + if (Utils.isNotEmptyArray(connectorIds)) { for (const connectorId of connectorIds) { - this.automaticTransactionGenerator.startConnector(connectorId); + this.automaticTransactionGenerator?.startConnector(connectorId); } } else { - this.automaticTransactionGenerator.start(); + this.automaticTransactionGenerator?.start(); } parentPort?.postMessage(MessageChannelUtils.buildUpdatedMessage(this)); } public stopAutomaticTransactionGenerator(connectorIds?: number[]): void { - if (!Utils.isEmptyArray(connectorIds)) { + if (Utils.isNotEmptyArray(connectorIds)) { for (const connectorId of connectorIds) { this.automaticTransactionGenerator?.stopConnector(connectorId); } @@ -819,10 +817,10 @@ export default class ChargingStation { } } catch (error) { FileUtils.handleFileException( - this.logPrefix(), - FileType.ChargingStationTemplate, this.templateFile, - error as NodeJS.ErrnoException + FileType.ChargingStationTemplate, + error as NodeJS.ErrnoException, + this.logPrefix() ); } return template; @@ -862,15 +860,15 @@ export default class ChargingStation { ); stationInfo.ocppVersion = stationTemplate?.ocppVersion ?? OCPPVersion.VERSION_16; ChargingStationUtils.createSerialNumber(stationTemplate, stationInfo); - if (!Utils.isEmptyArray(stationTemplate?.power)) { - stationTemplate.power = stationTemplate?.power as number[]; + if (Utils.isNotEmptyArray(stationTemplate?.power)) { + stationTemplate.power = stationTemplate.power as number[]; const powerArrayRandomIndex = Math.floor(Utils.secureRandom() * stationTemplate.power.length); stationInfo.maximumPower = stationTemplate?.powerUnit === PowerUnits.KILO_WATT ? stationTemplate.power[powerArrayRandomIndex] * 1000 : stationTemplate.power[powerArrayRandomIndex]; } else { - stationTemplate.power = stationTemplate.power as number; + stationTemplate.power = stationTemplate?.power as number; stationInfo.maximumPower = stationTemplate?.powerUnit === PowerUnits.KILO_WATT ? stationTemplate.power * 1000 @@ -879,7 +877,7 @@ export default class ChargingStation { stationInfo.firmwareVersionPattern = stationTemplate?.firmwareVersionPattern ?? Constants.SEMVER_PATTERN; if ( - stationInfo.firmwareVersion && + Utils.isNotEmptyString(stationInfo.firmwareVersion) && new RegExp(stationInfo.firmwareVersionPattern).test(stationInfo.firmwareVersion) === false ) { logger.warn( @@ -888,13 +886,16 @@ export default class ChargingStation { } does not match firmware version pattern '${stationInfo.firmwareVersionPattern}'` ); } - stationInfo.firmwareUpgrade = merge( + stationInfo.firmwareUpgrade = merge( { + versionUpgrade: { + step: 1, + }, reset: true, }, stationTemplate?.firmwareUpgrade ?? {} ); - stationInfo.resetTime = stationTemplate?.resetTime + stationInfo.resetTime = !Utils.isNullOrUndefined(stationTemplate?.resetTime) ? stationTemplate.resetTime * 1000 : Constants.CHARGING_STATION_DEFAULT_RESET_TIME; const configuredMaxConnectors = @@ -930,17 +931,17 @@ export default class ChargingStation { return stationInfo; } - private getStationInfoFromFile(): ChargingStationInfo | null { - let stationInfo: ChargingStationInfo | null = null; + private getStationInfoFromFile(): ChargingStationInfo | undefined { + let stationInfo: ChargingStationInfo | undefined; this.getStationInfoPersistentConfiguration() && - (stationInfo = this.getConfigurationFromFile()?.stationInfo ?? null); + (stationInfo = this.getConfigurationFromFile()?.stationInfo); stationInfo && ChargingStationUtils.createStationInfoHash(stationInfo); return stationInfo; } private getStationInfo(): ChargingStationInfo { const stationInfoFromTemplate: ChargingStationInfo = this.getStationInfoFromTemplate(); - const stationInfoFromFile: ChargingStationInfo | null = this.getStationInfoFromFile(); + const stationInfoFromFile: ChargingStationInfo | undefined = this.getStationInfoFromFile(); // Priority: charging station info from template > charging station info from configuration file > charging station info attribute if (stationInfoFromFile?.templateHash === stationInfoFromTemplate.templateHash) { if (this.stationInfo?.infoHash === stationInfoFromFile?.infoHash) { @@ -1031,19 +1032,19 @@ export default class ChargingStation { } if ( this.stationInfo.firmwareStatus === FirmwareStatus.Installing && - this.stationInfo.firmwareVersion && - this.stationInfo.firmwareVersionPattern + Utils.isNotEmptyString(this.stationInfo.firmwareVersion) && + Utils.isNotEmptyString(this.stationInfo.firmwareVersionPattern) ) { - const versionStep = this.stationInfo.firmwareUpgrade?.versionUpgrade?.step ?? 1; - const patternGroup: number = + const patternGroup: number | undefined = this.stationInfo.firmwareUpgrade?.versionUpgrade?.patternGroup ?? - this.stationInfo.firmwareVersion.split('.').length; + this.stationInfo.firmwareVersion?.split('.').length; const match = this.stationInfo?.firmwareVersion ?.match(new RegExp(this.stationInfo.firmwareVersionPattern)) ?.slice(1, patternGroup + 1); const patchLevelIndex = match.length - 1; match[patchLevelIndex] = ( - Utils.convertToInt(match[patchLevelIndex]) + versionStep + Utils.convertToInt(match[patchLevelIndex]) + + this.stationInfo.firmwareUpgrade?.versionUpgrade?.step ).toString(); this.stationInfo.firmwareVersion = match?.join('.'); } @@ -1096,7 +1097,7 @@ export default class ChargingStation { ); } if ( - this.stationInfo.amperageLimitationOcppKey && + Utils.isNotEmptyString(this.stationInfo?.amperageLimitationOcppKey) && !ChargingStationConfigurationUtils.getConfigurationKey( this, this.stationInfo.amperageLimitationOcppKey @@ -1315,8 +1316,8 @@ export default class ChargingStation { } } - private getConfigurationFromFile(): ChargingStationConfiguration | null { - let configuration: ChargingStationConfiguration | null = null; + private getConfigurationFromFile(): ChargingStationConfiguration | undefined { + let configuration: ChargingStationConfiguration | undefined; if (this.configurationFile && fs.existsSync(this.configurationFile)) { try { if (this.sharedLRUCache.hasChargingStationConfiguration(this.configurationFileHash)) { @@ -1335,10 +1336,10 @@ export default class ChargingStation { } } catch (error) { FileUtils.handleFileException( - this.logPrefix(), - FileType.ChargingStationConfiguration, this.configurationFile, - error as NodeJS.ErrnoException + FileType.ChargingStationConfiguration, + error as NodeJS.ErrnoException, + this.logPrefix() ); } } @@ -1381,10 +1382,10 @@ export default class ChargingStation { } } catch (error) { FileUtils.handleFileException( - this.logPrefix(), - FileType.ChargingStationConfiguration, this.configurationFile, - error as NodeJS.ErrnoException + FileType.ChargingStationConfiguration, + error as NodeJS.ErrnoException, + this.logPrefix() ); } } else { @@ -1394,12 +1395,12 @@ export default class ChargingStation { } } - private getOcppConfigurationFromTemplate(): ChargingStationOcppConfiguration | null { - return this.getTemplateFromFile()?.Configuration ?? null; + private getOcppConfigurationFromTemplate(): ChargingStationOcppConfiguration | undefined { + return this.getTemplateFromFile()?.Configuration; } - private getOcppConfigurationFromFile(): ChargingStationOcppConfiguration | null { - let configuration: ChargingStationConfiguration | null = null; + private getOcppConfigurationFromFile(): ChargingStationOcppConfiguration | undefined { + let configuration: ChargingStationConfiguration | undefined; if (this.getOcppPersistentConfiguration() === true) { const configurationFromFile = this.getConfigurationFromFile(); configuration = configurationFromFile?.configurationKey && configurationFromFile; @@ -1408,8 +1409,8 @@ export default class ChargingStation { return configuration; } - private getOcppConfiguration(): ChargingStationOcppConfiguration | null { - let ocppConfiguration: ChargingStationOcppConfiguration | null = + private getOcppConfiguration(): ChargingStationOcppConfiguration | undefined { + let ocppConfiguration: ChargingStationOcppConfiguration | undefined = this.getOcppConfigurationFromFile(); if (!ocppConfiguration) { ocppConfiguration = this.getOcppConfigurationFromTemplate(); @@ -1514,7 +1515,7 @@ export default class ChargingStation { case MessageType.CALL_MESSAGE: [, , commandName, commandPayload] = request as IncomingRequest; if (this.getEnableStatistics() === true) { - this.performanceStatistics.addRequestStatistic(commandName, messageType); + this.performanceStatistics?.addRequestStatistic(commandName, messageType); } logger.debug( `${this.logPrefix()} << Command '${commandName}' received request payload: ${JSON.stringify( @@ -1677,9 +1678,7 @@ export default class ChargingStation { private getUseConnectorId0(stationInfo?: ChargingStationInfo): boolean { const localStationInfo = stationInfo ?? this.stationInfo; - return !Utils.isUndefined(localStationInfo.useConnectorId0) - ? localStationInfo.useConnectorId0 - : true; + return localStationInfo?.useConnectorId0 ?? true; } private getNumberOfRunningTransactions(): number { @@ -1763,7 +1762,7 @@ export default class ChargingStation { private getAmperageLimitation(): number | undefined { if ( - this.stationInfo.amperageLimitationOcppKey && + Utils.isNotEmptyString(this.stationInfo?.amperageLimitationOcppKey) && ChargingStationConfigurationUtils.getConfigurationKey( this, this.stationInfo.amperageLimitationOcppKey @@ -1924,7 +1923,7 @@ export default class ChargingStation { private getConfiguredSupervisionUrl(): URL { const supervisionUrls = this.stationInfo?.supervisionUrls ?? Configuration.getSupervisionUrls(); - if (!Utils.isEmptyArray(supervisionUrls)) { + if (Utils.isNotEmptyArray(supervisionUrls)) { switch (Configuration.getSupervisionUrlDistribution()) { case SupervisionUrlDistribution.ROUND_ROBIN: // FIXME @@ -1996,9 +1995,7 @@ export default class ChargingStation { } private getReconnectExponentialDelay(): boolean { - return !Utils.isUndefined(this.stationInfo.reconnectExponentialDelay) - ? this.stationInfo.reconnectExponentialDelay - : false; + return this.stationInfo?.reconnectExponentialDelay ?? false; } private async reconnect(): Promise { @@ -2047,8 +2044,10 @@ export default class ChargingStation { } } - private getAutomaticTransactionGeneratorConfigurationFromTemplate(): AutomaticTransactionGeneratorConfiguration | null { - return this.getTemplateFromFile()?.AutomaticTransactionGenerator ?? null; + private getAutomaticTransactionGeneratorConfigurationFromTemplate(): + | AutomaticTransactionGeneratorConfiguration + | undefined { + return this.getTemplateFromFile()?.AutomaticTransactionGenerator; } private initializeConnectorStatus(connectorId: number): void {