// Partial Copyright Jerome Benoit. 2021-2024. All Rights Reserved.
-import { createHash } from 'node:crypto'
+import { millisecondsToSeconds, secondsToMilliseconds } from 'date-fns'
+import { createHash, randomInt } from 'node:crypto'
import { EventEmitter } from 'node:events'
-import { type FSWatcher, existsSync, mkdirSync, readFileSync, rmSync, writeFileSync } from 'node:fs'
-import { dirname, join, parse } from 'node:path'
+import { existsSync, type FSWatcher, mkdirSync, readFileSync, rmSync, writeFileSync } from 'node:fs'
+import { dirname, join } from 'node:path'
import { URL } from 'node:url'
import { parentPort } from 'node:worker_threads'
-
-import { millisecondsToSeconds, secondsToMilliseconds } from 'date-fns'
-import merge from 'just-merge'
+import { mergeDeepRight, once } from 'rambda'
import { type RawData, WebSocket } from 'ws'
-import { AutomaticTransactionGenerator } from './AutomaticTransactionGenerator.js'
-import { ChargingStationWorkerBroadcastChannel } from './broadcast-channel/ChargingStationWorkerBroadcastChannel.js'
-import {
- addConfigurationKey,
- deleteConfigurationKey,
- getConfigurationKey,
- setConfigurationKeyValue
-} from './ConfigurationKeyUtils.js'
-import {
- buildConnectorsMap,
- checkChargingStation,
- checkConfiguration,
- checkConnectorsConfiguration,
- checkStationInfoConnectorStatus,
- checkTemplate,
- createBootNotificationRequest,
- createSerialNumber,
- getAmperageLimitationUnitDivider,
- getBootConnectorStatus,
- getChargingStationConnectorChargingProfilesPowerLimit,
- getChargingStationId,
- getDefaultVoltageOut,
- getHashId,
- getIdTagsFile,
- getMaxNumberOfEvses,
- getNumberOfReservableConnectors,
- getPhaseRotationValue,
- hasFeatureProfile,
- hasReservationExpired,
- initializeConnectorsMapStatus,
- propagateSerialNumber,
- setChargingStationOptions,
- stationTemplateToStationInfo,
- warnTemplateKeysDeprecation
-} from './Helpers.js'
-import { IdTagsCache } from './IdTagsCache.js'
-import {
- OCPP16IncomingRequestService,
- OCPP16RequestService,
- OCPP16ResponseService,
- OCPP20IncomingRequestService,
- OCPP20RequestService,
- OCPP20ResponseService,
- type OCPPIncomingRequestService,
- type OCPPRequestService,
- buildMeterValue,
- buildTransactionEndMeterValue,
- getMessageTypeString,
- sendAndSetConnectorStatus
-} from './ocpp/index.js'
-import { SharedLRUCache } from './SharedLRUCache.js'
import { BaseError, OCPPError } from '../exception/index.js'
import { PerformanceStatistics } from '../performance/index.js'
import {
FirmwareStatus,
type FirmwareStatusNotificationRequest,
type FirmwareStatusNotificationResponse,
- type FirmwareUpgrade,
type HeartbeatRequest,
type HeartbeatResponse,
type IncomingRequest,
SupervisionUrlDistribution,
SupportedFeatureProfiles,
type Voltage,
- type WSError,
WebSocketCloseEventStatusCode,
- type WsOptions
+ type WSError,
+ type WsOptions,
} from '../types/index.js'
import {
ACElectricUtils,
AsyncLock,
AsyncLockType,
- Configuration,
- Constants,
- DCElectricUtils,
buildAddedMessage,
buildChargingStationAutomaticTransactionGeneratorConfiguration,
buildConnectorsStatus,
buildStoppedMessage,
buildUpdatedMessage,
clone,
+ Configuration,
+ Constants,
convertToBoolean,
convertToDate,
convertToInt,
+ DCElectricUtils,
exponentialDelay,
formatDurationMilliSeconds,
formatDurationSeconds,
- getRandomInteger,
getWebSocketCloseEventStatusString,
handleFileException,
isNotEmptyArray,
isNotEmptyString,
- logPrefix,
logger,
+ logPrefix,
min,
- once,
roundTo,
secureRandom,
sleep,
- watchJsonFile
+ watchJsonFile,
} from '../utils/index.js'
+import { AutomaticTransactionGenerator } from './AutomaticTransactionGenerator.js'
+import { ChargingStationWorkerBroadcastChannel } from './broadcast-channel/ChargingStationWorkerBroadcastChannel.js'
+import {
+ addConfigurationKey,
+ deleteConfigurationKey,
+ getConfigurationKey,
+ setConfigurationKeyValue,
+} from './ConfigurationKeyUtils.js'
+import {
+ buildConnectorsMap,
+ buildTemplateName,
+ checkChargingStationState,
+ checkConfiguration,
+ checkConnectorsConfiguration,
+ checkStationInfoConnectorStatus,
+ checkTemplate,
+ createBootNotificationRequest,
+ createSerialNumber,
+ getAmperageLimitationUnitDivider,
+ getBootConnectorStatus,
+ getChargingStationChargingProfilesLimit,
+ getChargingStationId,
+ getConnectorChargingProfilesLimit,
+ getDefaultVoltageOut,
+ getHashId,
+ getIdTagsFile,
+ getMaxNumberOfEvses,
+ getNumberOfReservableConnectors,
+ getPhaseRotationValue,
+ hasFeatureProfile,
+ hasReservationExpired,
+ initializeConnectorsMapStatus,
+ prepareConnectorStatus,
+ propagateSerialNumber,
+ setChargingStationOptions,
+ stationTemplateToStationInfo,
+ validateStationInfo,
+ warnTemplateKeysDeprecation,
+} from './Helpers.js'
+import { IdTagsCache } from './IdTagsCache.js'
+import {
+ buildMeterValue,
+ buildTransactionEndMeterValue,
+ getMessageTypeString,
+ OCPP16IncomingRequestService,
+ OCPP16RequestService,
+ OCPP16ResponseService,
+ OCPP20IncomingRequestService,
+ OCPP20RequestService,
+ OCPP20ResponseService,
+ type OCPPIncomingRequestService,
+ type OCPPRequestService,
+ sendAndSetConnectorStatus,
+} from './ocpp/index.js'
+import { SharedLRUCache } from './SharedLRUCache.js'
export class ChargingStation extends EventEmitter {
- public readonly index: number
- public readonly templateFile: string
- public stationInfo?: ChargingStationInfo
- public started: boolean
- public starting: boolean
- public idTagsCache: IdTagsCache
- public automaticTransactionGenerator?: AutomaticTransactionGenerator
- public ocppConfiguration?: ChargingStationOcppConfiguration
- public wsConnection: WebSocket | null
- public readonly connectors: Map<number, ConnectorStatus>
- public readonly evses: Map<number, EvseStatus>
- public readonly requests: Map<string, CachedRequest>
- public performanceStatistics?: PerformanceStatistics
- public heartbeatSetInterval?: NodeJS.Timeout
- public ocppRequestService!: OCPPRequestService
- public bootNotificationRequest?: BootNotificationRequest
- public bootNotificationResponse?: BootNotificationResponse
- public powerDivider?: number
- private stopping: boolean
+ private automaticTransactionGeneratorConfiguration?: AutomaticTransactionGeneratorConfiguration
+ private readonly chargingStationWorkerBroadcastChannel: ChargingStationWorkerBroadcastChannel
private configurationFile!: string
private configurationFileHash!: string
+ private configuredSupervisionUrl!: URL
private connectorsConfigurationHash!: string
private evsesConfigurationHash!: string
- private automaticTransactionGeneratorConfiguration?: AutomaticTransactionGeneratorConfiguration
- private ocppIncomingRequestService!: OCPPIncomingRequestService
+ private flushMessageBufferSetInterval?: NodeJS.Timeout
private readonly messageBuffer: Set<string>
- private configuredSupervisionUrl!: URL
- private wsConnectionRetried: boolean
- private wsConnectionRetryCount: number
- private templateFileWatcher?: FSWatcher
- private templateFileHash!: string
+ private ocppIncomingRequestService!: OCPPIncomingRequestService
private readonly sharedLRUCache: SharedLRUCache
+ private stopping: boolean
+ private templateFileHash!: string
+ private templateFileWatcher?: FSWatcher
+ private wsConnectionRetryCount: number
private wsPingSetInterval?: NodeJS.Timeout
- private readonly chargingStationWorkerBroadcastChannel: ChargingStationWorkerBroadcastChannel
- private flushMessageBufferSetInterval?: NodeJS.Timeout
+ public automaticTransactionGenerator?: AutomaticTransactionGenerator
+ public bootNotificationRequest?: BootNotificationRequest
+ public bootNotificationResponse?: BootNotificationResponse
+ public readonly connectors: Map<number, ConnectorStatus>
+ public readonly evses: Map<number, EvseStatus>
+ public heartbeatSetInterval?: NodeJS.Timeout
+ public idTagsCache: IdTagsCache
+ public readonly index: number
+ public logPrefix = (): string => {
+ if (
+ this instanceof ChargingStation &&
+ this.stationInfo != null &&
+ isNotEmptyString(this.stationInfo.chargingStationId)
+ ) {
+ return logPrefix(` ${this.stationInfo.chargingStationId} |`)
+ }
+ let stationTemplate: ChargingStationTemplate | undefined
+ try {
+ stationTemplate = JSON.parse(
+ readFileSync(this.templateFile, 'utf8')
+ ) as ChargingStationTemplate
+ } catch {
+ // Ignore
+ }
+ return logPrefix(` ${getChargingStationId(this.index, stationTemplate)} |`)
+ }
+
+ public ocppConfiguration?: ChargingStationOcppConfiguration
+ public ocppRequestService!: OCPPRequestService
+ public performanceStatistics?: PerformanceStatistics
+ public powerDivider?: number
+ public readonly requests: Map<string, CachedRequest>
+ public started: boolean
+ public starting: boolean
+ public stationInfo?: ChargingStationInfo
+ public readonly templateFile: string
+ public wsConnection: null | WebSocket
constructor (index: number, templateFile: string, options?: ChargingStationOptions) {
super()
this.starting = false
this.stopping = false
this.wsConnection = null
- this.wsConnectionRetried = false
this.wsConnectionRetryCount = 0
this.index = index
this.templateFile = templateFile
})
this.on(ChargingStationEvents.accepted, () => {
this.startMessageSequence(
- this.wsConnectionRetried
+ this.wsConnectionRetryCount > 0
? true
: this.getAutomaticTransactionGeneratorConfiguration()?.stopAbsoluteDuration
- ).catch(error => {
+ ).catch((error: unknown) => {
logger.error(`${this.logPrefix()} Error while starting the message sequence:`, error)
})
- this.wsConnectionRetried = false
+ this.wsConnectionRetryCount = 0
})
this.on(ChargingStationEvents.rejected, () => {
- this.wsConnectionRetried = false
+ this.wsConnectionRetryCount = 0
+ })
+ this.on(ChargingStationEvents.connected, () => {
+ if (this.wsPingSetInterval == null) {
+ this.startWebSocketPing()
+ }
})
this.on(ChargingStationEvents.disconnected, () => {
try {
}
}
- public get hasEvses (): boolean {
- return this.connectors.size === 0 && this.evses.size > 0
+ private add (): void {
+ this.emit(ChargingStationEvents.added)
}
- public get wsConnectionUrl (): URL {
- return new URL(
- `${
- this.stationInfo?.supervisionUrlOcppConfiguration === true &&
- isNotEmptyString(this.stationInfo.supervisionUrlOcppKey) &&
- isNotEmptyString(getConfigurationKey(this, this.stationInfo.supervisionUrlOcppKey)?.value)
- ? getConfigurationKey(this, this.stationInfo.supervisionUrlOcppKey)?.value
- : this.configuredSupervisionUrl.href
- }/${this.stationInfo?.chargingStationId}`
- )
+ private clearIntervalFlushMessageBuffer (): void {
+ if (this.flushMessageBufferSetInterval != null) {
+ clearInterval(this.flushMessageBufferSetInterval)
+ delete this.flushMessageBufferSetInterval
+ }
}
- public logPrefix = (): string => {
- if (
- this instanceof ChargingStation &&
- this.stationInfo != null &&
- isNotEmptyString(this.stationInfo.chargingStationId)
- ) {
- return logPrefix(` ${this.stationInfo.chargingStationId} |`)
- }
- let stationTemplate: ChargingStationTemplate | undefined
- try {
- stationTemplate = JSON.parse(
- readFileSync(this.templateFile, 'utf8')
- ) as ChargingStationTemplate
- } catch {
- stationTemplate = undefined
+ private flushMessageBuffer (): void {
+ if (this.messageBuffer.size > 0) {
+ for (const message of this.messageBuffer.values()) {
+ let beginId: string | undefined
+ let commandName: RequestCommand | undefined
+ const [messageType] = JSON.parse(message) as ErrorResponse | OutgoingRequest | Response
+ const isRequest = messageType === MessageType.CALL_MESSAGE
+ if (isRequest) {
+ ;[, , commandName] = JSON.parse(message) as OutgoingRequest
+ beginId = PerformanceStatistics.beginMeasure(commandName)
+ }
+ this.wsConnection?.send(message, (error?: Error) => {
+ // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+ isRequest && PerformanceStatistics.endMeasure(commandName!, beginId!)
+ if (error == null) {
+ logger.debug(
+ `${this.logPrefix()} >> Buffered ${getMessageTypeString(
+ messageType
+ )} OCPP message sent '${JSON.stringify(message)}'`
+ )
+ this.messageBuffer.delete(message)
+ } else {
+ logger.debug(
+ `${this.logPrefix()} >> Buffered ${getMessageTypeString(
+ messageType
+ )} OCPP message '${JSON.stringify(message)}' send failed:`,
+ error
+ )
+ }
+ })
+ }
}
- return logPrefix(` ${getChargingStationId(this.index, stationTemplate)} |`)
}
- public hasIdTags (): boolean {
- // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
- return isNotEmptyArray(this.idTagsCache.getIdTags(getIdTagsFile(this.stationInfo!)!))
+ private getAmperageLimitation (): number | undefined {
+ if (
+ isNotEmptyString(this.stationInfo?.amperageLimitationOcppKey) &&
+ getConfigurationKey(this, this.stationInfo.amperageLimitationOcppKey) != null
+ ) {
+ return (
+ convertToInt(getConfigurationKey(this, this.stationInfo.amperageLimitationOcppKey)?.value) /
+ getAmperageLimitationUnitDivider(this.stationInfo)
+ )
+ }
}
- public getNumberOfPhases (stationInfo?: ChargingStationInfo): number {
- // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
- const localStationInfo = stationInfo ?? this.stationInfo!
- switch (this.getCurrentOutType(stationInfo)) {
- case CurrentType.AC:
- return localStationInfo.numberOfPhases ?? 3
- case CurrentType.DC:
- return 0
+ private getCachedRequest (
+ messageType: MessageType | undefined,
+ messageId: string
+ ): CachedRequest | undefined {
+ const cachedRequest = this.requests.get(messageId)
+ if (Array.isArray(cachedRequest)) {
+ return cachedRequest
}
+ throw new OCPPError(
+ ErrorType.PROTOCOL_ERROR,
+ `Cached request for message id '${messageId}' ${getMessageTypeString(
+ messageType
+ )} is not an array`,
+ undefined,
+ cachedRequest
+ )
}
- public isWebSocketConnectionOpened (): boolean {
- return this.wsConnection?.readyState === WebSocket.OPEN
- }
-
- public inUnknownState (): boolean {
- return this.bootNotificationResponse?.status == null
+ private getConfigurationFromFile (): ChargingStationConfiguration | undefined {
+ let configuration: ChargingStationConfiguration | undefined
+ if (isNotEmptyString(this.configurationFile) && existsSync(this.configurationFile)) {
+ try {
+ if (this.sharedLRUCache.hasChargingStationConfiguration(this.configurationFileHash)) {
+ configuration = this.sharedLRUCache.getChargingStationConfiguration(
+ this.configurationFileHash
+ )
+ } else {
+ const measureId = `${FileType.ChargingStationConfiguration} read`
+ const beginId = PerformanceStatistics.beginMeasure(measureId)
+ configuration = JSON.parse(
+ readFileSync(this.configurationFile, 'utf8')
+ ) as ChargingStationConfiguration
+ PerformanceStatistics.endMeasure(measureId, beginId)
+ this.sharedLRUCache.setChargingStationConfiguration(configuration)
+ // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+ this.configurationFileHash = configuration.configurationHash!
+ }
+ } catch (error) {
+ handleFileException(
+ this.configurationFile,
+ FileType.ChargingStationConfiguration,
+ error as NodeJS.ErrnoException,
+ this.logPrefix()
+ )
+ }
+ }
+ return configuration
}
- public inPendingState (): boolean {
- return this.bootNotificationResponse?.status === RegistrationStatusEnumType.PENDING
+ private getConfiguredSupervisionUrl (): URL {
+ let configuredSupervisionUrl: string | undefined
+ const supervisionUrls = this.stationInfo?.supervisionUrls ?? Configuration.getSupervisionUrls()
+ if (isNotEmptyArray(supervisionUrls)) {
+ let configuredSupervisionUrlIndex: number
+ switch (Configuration.getSupervisionUrlDistribution()) {
+ case SupervisionUrlDistribution.RANDOM:
+ configuredSupervisionUrlIndex = Math.floor(secureRandom() * supervisionUrls.length)
+ break
+ case SupervisionUrlDistribution.ROUND_ROBIN:
+ case SupervisionUrlDistribution.CHARGING_STATION_AFFINITY:
+ default:
+ !Object.values(SupervisionUrlDistribution).includes(
+ // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+ Configuration.getSupervisionUrlDistribution()!
+ ) &&
+ logger.warn(
+ // eslint-disable-next-line @typescript-eslint/restrict-template-expressions, @typescript-eslint/no-base-to-string
+ `${this.logPrefix()} Unknown supervision url distribution '${Configuration.getSupervisionUrlDistribution()}' in configuration from values '${SupervisionUrlDistribution.toString()}', defaulting to '${
+ SupervisionUrlDistribution.CHARGING_STATION_AFFINITY
+ }'`
+ )
+ configuredSupervisionUrlIndex = (this.index - 1) % supervisionUrls.length
+ break
+ }
+ configuredSupervisionUrl = supervisionUrls[configuredSupervisionUrlIndex]
+ } else if (typeof supervisionUrls === 'string') {
+ // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+ configuredSupervisionUrl = supervisionUrls!
+ }
+ if (isNotEmptyString(configuredSupervisionUrl)) {
+ return new URL(configuredSupervisionUrl)
+ }
+ const errorMsg = 'No supervision url(s) configured'
+ logger.error(`${this.logPrefix()} ${errorMsg}`)
+ throw new BaseError(errorMsg)
}
- public inAcceptedState (): boolean {
- return this.bootNotificationResponse?.status === RegistrationStatusEnumType.ACCEPTED
+ // 0 for disabling
+ private getConnectionTimeout (): number {
+ if (getConfigurationKey(this, StandardParametersKey.ConnectionTimeOut) != null) {
+ return convertToInt(
+ getConfigurationKey(this, StandardParametersKey.ConnectionTimeOut)?.value ??
+ Constants.DEFAULT_CONNECTION_TIMEOUT
+ )
+ }
+ return Constants.DEFAULT_CONNECTION_TIMEOUT
}
- public inRejectedState (): boolean {
- return this.bootNotificationResponse?.status === RegistrationStatusEnumType.REJECTED
+ private getCurrentOutType (stationInfo?: ChargingStationInfo): CurrentType {
+ return (
+ // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+ (stationInfo ?? this.stationInfo!).currentOutType ??
+ // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+ Constants.DEFAULT_STATION_INFO.currentOutType!
+ )
}
- public isRegistered (): boolean {
- return !this.inUnknownState() && (this.inAcceptedState() || this.inPendingState())
+ private getEnergyActiveImportRegister (
+ connectorStatus: ConnectorStatus | undefined,
+ rounded = false
+ ): number {
+ if (this.stationInfo?.meteringPerTransaction === true) {
+ return (
+ (rounded
+ ? connectorStatus?.transactionEnergyActiveImportRegisterValue != null
+ ? Math.round(connectorStatus.transactionEnergyActiveImportRegisterValue)
+ : undefined
+ : connectorStatus?.transactionEnergyActiveImportRegisterValue) ?? 0
+ )
+ }
+ return (
+ (rounded
+ ? connectorStatus?.energyActiveImportRegisterValue != null
+ ? Math.round(connectorStatus.energyActiveImportRegisterValue)
+ : undefined
+ : connectorStatus?.energyActiveImportRegisterValue) ?? 0
+ )
}
- public isChargingStationAvailable (): boolean {
- return this.getConnectorStatus(0)?.availability === AvailabilityType.Operative
+ private getMaximumAmperage (stationInfo?: ChargingStationInfo): number | undefined {
+ // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+ const maximumPower = (stationInfo ?? this.stationInfo!).maximumPower!
+ switch (this.getCurrentOutType(stationInfo)) {
+ case CurrentType.AC:
+ return ACElectricUtils.amperagePerPhaseFromPower(
+ this.getNumberOfPhases(stationInfo),
+ maximumPower / (this.hasEvses ? this.getNumberOfEvses() : this.getNumberOfConnectors()),
+ this.getVoltageOut(stationInfo)
+ )
+ case CurrentType.DC:
+ return DCElectricUtils.amperage(maximumPower, this.getVoltageOut(stationInfo))
+ }
}
- public hasConnector (connectorId: number): boolean {
+ private getNumberOfReservableConnectors (): number {
+ let numberOfReservableConnectors = 0
if (this.hasEvses) {
for (const evseStatus of this.evses.values()) {
- if (evseStatus.connectors.has(connectorId)) {
- return true
- }
+ numberOfReservableConnectors += getNumberOfReservableConnectors(evseStatus.connectors)
}
- return false
+ } else {
+ numberOfReservableConnectors = getNumberOfReservableConnectors(this.connectors)
}
- return this.connectors.has(connectorId)
+ return numberOfReservableConnectors - this.getNumberOfReservationsOnConnectorZero()
}
- public isConnectorAvailable (connectorId: number): boolean {
- return (
- connectorId > 0 &&
- this.getConnectorStatus(connectorId)?.availability === AvailabilityType.Operative
- )
+ private getNumberOfReservationsOnConnectorZero (): number {
+ if (
+ (this.hasEvses && this.evses.get(0)?.connectors.get(0)?.reservation != null) ||
+ (!this.hasEvses && this.connectors.get(0)?.reservation != null)
+ ) {
+ return 1
+ }
+ return 0
}
- public getNumberOfConnectors (): number {
- if (this.hasEvses) {
- let numberOfConnectors = 0
- for (const [evseId, evseStatus] of this.evses) {
- if (evseId > 0) {
- numberOfConnectors += evseStatus.connectors.size
- }
- }
- return numberOfConnectors
+ private getOcppConfiguration (
+ ocppPersistentConfiguration: boolean | undefined = this.stationInfo?.ocppPersistentConfiguration
+ ): ChargingStationOcppConfiguration | undefined {
+ let ocppConfiguration: ChargingStationOcppConfiguration | undefined =
+ this.getOcppConfigurationFromFile(ocppPersistentConfiguration)
+ if (ocppConfiguration == null) {
+ ocppConfiguration = this.getOcppConfigurationFromTemplate()
}
- return this.connectors.has(0) ? this.connectors.size - 1 : this.connectors.size
+ return ocppConfiguration
}
- public getNumberOfEvses (): number {
- return this.evses.has(0) ? this.evses.size - 1 : this.evses.size
+ private getOcppConfigurationFromFile (
+ ocppPersistentConfiguration?: boolean
+ ): ChargingStationOcppConfiguration | undefined {
+ const configurationKey = this.getConfigurationFromFile()?.configurationKey
+ if (ocppPersistentConfiguration && Array.isArray(configurationKey)) {
+ return { configurationKey }
+ }
+ return undefined
}
- public getConnectorStatus (connectorId: number): ConnectorStatus | undefined {
- if (this.hasEvses) {
- for (const evseStatus of this.evses.values()) {
- if (evseStatus.connectors.has(connectorId)) {
- return evseStatus.connectors.get(connectorId)
- }
- }
- return undefined
+ private getOcppConfigurationFromTemplate (): ChargingStationOcppConfiguration | undefined {
+ return this.getTemplateFromFile()?.Configuration
+ }
+
+ private getPowerDivider (): number {
+ let powerDivider = this.hasEvses ? this.getNumberOfEvses() : this.getNumberOfConnectors()
+ if (this.stationInfo?.powerSharedByConnectors === true) {
+ powerDivider = this.getNumberOfRunningTransactions()
}
- return this.connectors.get(connectorId)
+ return powerDivider
}
- public getConnectorMaximumAvailablePower (connectorId: number): number {
- let connectorAmperageLimitationPowerLimit: number | undefined
- const amperageLimitation = this.getAmperageLimitation()
+ private getStationInfo (options?: ChargingStationOptions): ChargingStationInfo {
+ const stationInfoFromTemplate = this.getStationInfoFromTemplate()
+ options?.persistentConfiguration != null &&
+ (stationInfoFromTemplate.stationInfoPersistentConfiguration = options.persistentConfiguration)
+ const stationInfoFromFile = this.getStationInfoFromFile(
+ stationInfoFromTemplate.stationInfoPersistentConfiguration
+ )
+ let stationInfo: ChargingStationInfo
+ // Priority:
+ // 1. charging station info from template
+ // 2. charging station info from configuration file
if (
- amperageLimitation != null &&
- // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
- amperageLimitation < this.stationInfo!.maximumAmperage!
+ stationInfoFromFile != null &&
+ stationInfoFromFile.templateHash === stationInfoFromTemplate.templateHash
) {
- connectorAmperageLimitationPowerLimit =
- (this.stationInfo?.currentOutType === CurrentType.AC
- ? ACElectricUtils.powerTotal(
- this.getNumberOfPhases(),
- // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
- this.stationInfo.voltageOut!,
- amperageLimitation *
- (this.hasEvses ? this.getNumberOfEvses() : this.getNumberOfConnectors())
- )
- : // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
- DCElectricUtils.power(this.stationInfo!.voltageOut!, amperageLimitation)) /
- // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
- this.powerDivider!
+ stationInfo = stationInfoFromFile
+ } else {
+ stationInfo = stationInfoFromTemplate
+ stationInfoFromFile != null &&
+ propagateSerialNumber(this.getTemplateFromFile(), stationInfoFromFile, stationInfo)
}
- // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
- const connectorMaximumPower = this.stationInfo!.maximumPower! / this.powerDivider!
- const connectorChargingProfilesPowerLimit =
- getChargingStationConnectorChargingProfilesPowerLimit(this, connectorId)
- return min(
- isNaN(connectorMaximumPower) ? Infinity : connectorMaximumPower,
- // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
- isNaN(connectorAmperageLimitationPowerLimit!)
- ? Infinity
- : // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
- connectorAmperageLimitationPowerLimit!,
- // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
- isNaN(connectorChargingProfilesPowerLimit!) ? Infinity : connectorChargingProfilesPowerLimit!
+ return setChargingStationOptions(
+ mergeDeepRight(Constants.DEFAULT_STATION_INFO, stationInfo),
+ options
)
}
- public getTransactionIdTag (transactionId: number): string | undefined {
- if (this.hasEvses) {
- for (const evseStatus of this.evses.values()) {
- for (const connectorStatus of evseStatus.connectors.values()) {
- if (connectorStatus.transactionId === transactionId) {
- return connectorStatus.transactionIdTag
- }
- }
- }
- } else {
- for (const connectorId of this.connectors.keys()) {
- if (this.getConnectorStatus(connectorId)?.transactionId === transactionId) {
- return this.getConnectorStatus(connectorId)?.transactionIdTag
+ private getStationInfoFromFile (
+ stationInfoPersistentConfiguration: boolean | undefined = Constants.DEFAULT_STATION_INFO
+ .stationInfoPersistentConfiguration
+ ): ChargingStationInfo | undefined {
+ let stationInfo: ChargingStationInfo | undefined
+ if (stationInfoPersistentConfiguration) {
+ stationInfo = this.getConfigurationFromFile()?.stationInfo
+ if (stationInfo != null) {
+ // eslint-disable-next-line @typescript-eslint/no-deprecated
+ delete stationInfo.infoHash
+ delete (stationInfo as ChargingStationTemplate).numberOfConnectors
+ // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
+ if (stationInfo.templateIndex == null) {
+ stationInfo.templateIndex = this.index
+ }
+ // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
+ if (stationInfo.templateName == null) {
+ stationInfo.templateName = buildTemplateName(this.templateFile)
}
}
}
+ return stationInfo
}
- public getNumberOfRunningTransactions (): number {
- let numberOfRunningTransactions = 0
- if (this.hasEvses) {
- for (const [evseId, evseStatus] of this.evses) {
- if (evseId === 0) {
- continue
- }
- for (const connectorStatus of evseStatus.connectors.values()) {
- if (connectorStatus.transactionStarted === true) {
- ++numberOfRunningTransactions
- }
- }
- }
- } else {
- for (const connectorId of this.connectors.keys()) {
- if (connectorId > 0 && this.getConnectorStatus(connectorId)?.transactionStarted === true) {
- ++numberOfRunningTransactions
- }
- }
+ private getStationInfoFromTemplate (): ChargingStationInfo {
+ // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+ const stationTemplate = this.getTemplateFromFile()!
+ checkTemplate(stationTemplate, this.logPrefix(), this.templateFile)
+ const warnTemplateKeysDeprecationOnce = once(warnTemplateKeysDeprecation)
+ warnTemplateKeysDeprecationOnce(stationTemplate, this.logPrefix(), this.templateFile)
+ if (stationTemplate.Connectors != null) {
+ checkConnectorsConfiguration(stationTemplate, this.logPrefix(), this.templateFile)
}
- return numberOfRunningTransactions
+ const stationInfo = stationTemplateToStationInfo(stationTemplate)
+ stationInfo.hashId = getHashId(this.index, stationTemplate)
+ stationInfo.templateIndex = this.index
+ stationInfo.templateName = buildTemplateName(this.templateFile)
+ stationInfo.chargingStationId = getChargingStationId(this.index, stationTemplate)
+ createSerialNumber(stationTemplate, stationInfo)
+ stationInfo.voltageOut = this.getVoltageOut(stationInfo)
+ if (isNotEmptyArray<number>(stationTemplate.power)) {
+ const powerArrayRandomIndex = Math.floor(secureRandom() * stationTemplate.power.length)
+ stationInfo.maximumPower =
+ stationTemplate.powerUnit === PowerUnits.KILO_WATT
+ ? stationTemplate.power[powerArrayRandomIndex] * 1000
+ : stationTemplate.power[powerArrayRandomIndex]
+ } else if (typeof stationTemplate.power === 'number') {
+ stationInfo.maximumPower =
+ stationTemplate.powerUnit === PowerUnits.KILO_WATT
+ ? stationTemplate.power * 1000
+ : stationTemplate.power
+ }
+ stationInfo.maximumAmperage = this.getMaximumAmperage(stationInfo)
+ if (
+ isNotEmptyString(stationInfo.firmwareVersionPattern) &&
+ isNotEmptyString(stationInfo.firmwareVersion) &&
+ !new RegExp(stationInfo.firmwareVersionPattern).test(stationInfo.firmwareVersion)
+ ) {
+ logger.warn(
+ `${this.logPrefix()} Firmware version '${stationInfo.firmwareVersion}' in template file ${
+ this.templateFile
+ } does not match firmware version pattern '${stationInfo.firmwareVersionPattern}'`
+ )
+ }
+ if (stationTemplate.resetTime != null) {
+ stationInfo.resetTime = secondsToMilliseconds(stationTemplate.resetTime)
+ }
+ return stationInfo
}
- public getConnectorIdByTransactionId (transactionId: number | undefined): number | undefined {
- if (transactionId == null) {
- return undefined
- } else if (this.hasEvses) {
- for (const evseStatus of this.evses.values()) {
- for (const [connectorId, connectorStatus] of evseStatus.connectors) {
- if (connectorStatus.transactionId === transactionId) {
- return connectorId
- }
- }
- }
- } else {
- for (const connectorId of this.connectors.keys()) {
- if (this.getConnectorStatus(connectorId)?.transactionId === transactionId) {
- return connectorId
- }
+ private getTemplateFromFile (): ChargingStationTemplate | undefined {
+ let template: ChargingStationTemplate | undefined
+ try {
+ if (this.sharedLRUCache.hasChargingStationTemplate(this.templateFileHash)) {
+ template = this.sharedLRUCache.getChargingStationTemplate(this.templateFileHash)
+ } else {
+ const measureId = `${FileType.ChargingStationTemplate} read`
+ const beginId = PerformanceStatistics.beginMeasure(measureId)
+ template = JSON.parse(readFileSync(this.templateFile, 'utf8')) as ChargingStationTemplate
+ PerformanceStatistics.endMeasure(measureId, beginId)
+ template.templateHash = createHash(Constants.DEFAULT_HASH_ALGORITHM)
+ .update(JSON.stringify(template))
+ .digest('hex')
+ this.sharedLRUCache.setChargingStationTemplate(template)
+ this.templateFileHash = template.templateHash
}
+ } catch (error) {
+ handleFileException(
+ this.templateFile,
+ FileType.ChargingStationTemplate,
+ error as NodeJS.ErrnoException,
+ this.logPrefix()
+ )
}
+ return template
}
- public getEnergyActiveImportRegisterByTransactionId (
- transactionId: number | undefined,
- rounded = false
- ): number {
- return this.getEnergyActiveImportRegister(
+ private getUseConnectorId0 (stationTemplate?: ChargingStationTemplate): boolean {
+ // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+ return stationTemplate?.useConnectorId0 ?? Constants.DEFAULT_STATION_INFO.useConnectorId0!
+ }
+
+ private getVoltageOut (stationInfo?: ChargingStationInfo): Voltage {
+ return (
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
- this.getConnectorStatus(this.getConnectorIdByTransactionId(transactionId)!),
- rounded
+ (stationInfo ?? this.stationInfo!).voltageOut ??
+ getDefaultVoltageOut(this.getCurrentOutType(stationInfo), this.logPrefix(), this.templateFile)
)
}
- public getEnergyActiveImportRegisterByConnectorId (connectorId: number, rounded = false): number {
- return this.getEnergyActiveImportRegister(this.getConnectorStatus(connectorId), rounded)
+ private getWebSocketPingInterval (): number {
+ return getConfigurationKey(this, StandardParametersKey.WebSocketPingInterval) != null
+ ? convertToInt(getConfigurationKey(this, StandardParametersKey.WebSocketPingInterval)?.value)
+ : 0
}
- public getAuthorizeRemoteTxRequests (): boolean {
- const authorizeRemoteTxRequests = getConfigurationKey(
- this,
- StandardParametersKey.AuthorizeRemoteTxRequests
+ private handleErrorMessage (errorResponse: ErrorResponse): void {
+ const [messageType, messageId, errorType, errorMessage, errorDetails] = errorResponse
+ if (!this.requests.has(messageId)) {
+ // Error
+ throw new OCPPError(
+ ErrorType.INTERNAL_ERROR,
+ `Error response for unknown message id '${messageId}'`,
+ undefined,
+ { errorDetails, errorMessage, errorType }
+ )
+ }
+ // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+ const [, errorCallback, requestCommandName] = this.getCachedRequest(messageType, messageId)!
+ logger.debug(
+ `${this.logPrefix()} << Command '${requestCommandName}' received error response payload: ${JSON.stringify(
+ errorResponse
+ )}`
)
- return authorizeRemoteTxRequests != null
- ? convertToBoolean(authorizeRemoteTxRequests.value)
- : false
+ errorCallback(new OCPPError(errorType, errorMessage, requestCommandName, errorDetails))
}
- public getLocalAuthListEnabled (): boolean {
- const localAuthListEnabled = getConfigurationKey(
+ private async handleIncomingMessage (request: IncomingRequest): Promise<void> {
+ const [messageType, messageId, commandName, commandPayload] = request
+ if (this.requests.has(messageId)) {
+ throw new OCPPError(
+ ErrorType.SECURITY_ERROR,
+ `Received message with duplicate message id '${messageId}'`,
+ commandName,
+ commandPayload
+ )
+ }
+ if (this.stationInfo?.enableStatistics === true) {
+ this.performanceStatistics?.addRequestStatistic(commandName, messageType)
+ }
+ logger.debug(
+ `${this.logPrefix()} << Command '${commandName}' received request payload: ${JSON.stringify(
+ request
+ )}`
+ )
+ // Process the message
+ await this.ocppIncomingRequestService.incomingRequestHandler(
this,
- StandardParametersKey.LocalAuthListEnabled
+ messageId,
+ commandName,
+ commandPayload
)
- return localAuthListEnabled != null ? convertToBoolean(localAuthListEnabled.value) : false
+ this.emit(ChargingStationEvents.updated)
}
- public getHeartbeatInterval (): number {
- const HeartbeatInterval = getConfigurationKey(this, StandardParametersKey.HeartbeatInterval)
- if (HeartbeatInterval != null) {
- return secondsToMilliseconds(convertToInt(HeartbeatInterval.value))
- }
- const HeartBeatInterval = getConfigurationKey(this, StandardParametersKey.HeartBeatInterval)
- if (HeartBeatInterval != null) {
- return secondsToMilliseconds(convertToInt(HeartBeatInterval.value))
- }
- this.stationInfo?.autoRegister === false &&
- logger.warn(
- `${this.logPrefix()} Heartbeat interval configuration key not set, using default value: ${
- Constants.DEFAULT_HEARTBEAT_INTERVAL
- }`
+ private handleResponseMessage (response: Response): void {
+ const [messageType, messageId, commandPayload] = response
+ if (!this.requests.has(messageId)) {
+ // Error
+ throw new OCPPError(
+ ErrorType.INTERNAL_ERROR,
+ `Response for unknown message id '${messageId}'`,
+ undefined,
+ commandPayload
)
- return Constants.DEFAULT_HEARTBEAT_INTERVAL
+ }
+ // Respond
+ // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+ const [responseCallback, , requestCommandName, requestPayload] = this.getCachedRequest(
+ messageType,
+ messageId
+ )!
+ logger.debug(
+ `${this.logPrefix()} << Command '${requestCommandName}' received response payload: ${JSON.stringify(
+ response
+ )}`
+ )
+ responseCallback(commandPayload, requestPayload)
}
- public setSupervisionUrl (url: string): void {
+ private handleUnsupportedVersion (version: OCPPVersion | undefined): void {
+ // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
+ const errorMsg = `Unsupported protocol version '${version}' configured in template file ${this.templateFile}`
+ logger.error(`${this.logPrefix()} ${errorMsg}`)
+ throw new BaseError(errorMsg)
+ }
+
+ private initialize (options?: ChargingStationOptions): void {
+ // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+ const stationTemplate = this.getTemplateFromFile()!
+ checkTemplate(stationTemplate, this.logPrefix(), this.templateFile)
+ this.configurationFile = join(
+ dirname(this.templateFile.replace('station-templates', 'configurations')),
+ `${getHashId(this.index, stationTemplate)}.json`
+ )
+ const stationConfiguration = this.getConfigurationFromFile()
if (
- this.stationInfo?.supervisionUrlOcppConfiguration === true &&
- isNotEmptyString(this.stationInfo.supervisionUrlOcppKey)
+ stationConfiguration?.stationInfo?.templateHash === stationTemplate.templateHash &&
+ (stationConfiguration?.connectorsStatus != null || stationConfiguration?.evsesStatus != null)
) {
- setConfigurationKeyValue(this, this.stationInfo.supervisionUrlOcppKey, url)
+ checkConfiguration(stationConfiguration, this.logPrefix(), this.configurationFile)
+ this.initializeConnectorsOrEvsesFromFile(stationConfiguration)
} else {
- // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
- this.stationInfo!.supervisionUrls = url
- this.saveStationInfo()
- this.configuredSupervisionUrl = this.getConfiguredSupervisionUrl()
+ this.initializeConnectorsOrEvsesFromTemplate(stationTemplate)
}
- }
-
- public startHeartbeat (): void {
- if (this.getHeartbeatInterval() > 0 && this.heartbeatSetInterval == null) {
- this.heartbeatSetInterval = setInterval(() => {
- this.ocppRequestService
- .requestHandler<HeartbeatRequest, HeartbeatResponse>(this, RequestCommand.HEARTBEAT)
- .catch(error => {
- logger.error(
- `${this.logPrefix()} Error while sending '${RequestCommand.HEARTBEAT}':`,
- error
- )
- })
- }, this.getHeartbeatInterval())
- logger.info(
- `${this.logPrefix()} Heartbeat started every ${formatDurationMilliSeconds(
- this.getHeartbeatInterval()
- )}`
- )
- } else if (this.heartbeatSetInterval != null) {
- logger.info(
- `${this.logPrefix()} Heartbeat already started every ${formatDurationMilliSeconds(
- this.getHeartbeatInterval()
- )}`
- )
- } else {
- logger.error(
- `${this.logPrefix()} Heartbeat interval set to ${this.getHeartbeatInterval()}, not starting the heartbeat`
+ this.stationInfo = this.getStationInfo(options)
+ validateStationInfo(this)
+ if (
+ this.stationInfo.firmwareStatus === FirmwareStatus.Installing &&
+ isNotEmptyString(this.stationInfo.firmwareVersionPattern) &&
+ isNotEmptyString(this.stationInfo.firmwareVersion)
+ ) {
+ const patternGroup =
+ this.stationInfo.firmwareUpgrade?.versionUpgrade?.patternGroup ??
+ this.stationInfo.firmwareVersion.split('.').length
+ const match = new RegExp(this.stationInfo.firmwareVersionPattern)
+ .exec(this.stationInfo.firmwareVersion)
+ ?.slice(1, patternGroup + 1)
+ if (match != null) {
+ const patchLevelIndex = match.length - 1
+ match[patchLevelIndex] = (
+ convertToInt(match[patchLevelIndex]) +
+ // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+ this.stationInfo.firmwareUpgrade!.versionUpgrade!.step!
+ ).toString()
+ this.stationInfo.firmwareVersion = match.join('.')
+ }
+ }
+ this.saveStationInfo()
+ this.configuredSupervisionUrl = this.getConfiguredSupervisionUrl()
+ if (this.stationInfo.enableStatistics === true) {
+ this.performanceStatistics = PerformanceStatistics.getInstance(
+ this.stationInfo.hashId,
+ this.stationInfo.chargingStationId,
+ this.configuredSupervisionUrl
)
}
+ const bootNotificationRequest = createBootNotificationRequest(this.stationInfo)
+ if (bootNotificationRequest == null) {
+ const errorMsg = 'Error while creating boot notification request'
+ logger.error(`${this.logPrefix()} ${errorMsg}`)
+ throw new BaseError(errorMsg)
+ }
+ this.bootNotificationRequest = bootNotificationRequest
+ this.powerDivider = this.getPowerDivider()
+ // OCPP configuration
+ this.ocppConfiguration = this.getOcppConfiguration(options?.persistentConfiguration)
+ this.initializeOcppConfiguration()
+ this.initializeOcppServices()
+ if (this.stationInfo.autoRegister === true) {
+ this.bootNotificationResponse = {
+ currentTime: new Date(),
+ interval: millisecondsToSeconds(this.getHeartbeatInterval()),
+ status: RegistrationStatusEnumType.ACCEPTED,
+ }
+ }
}
- public restartHeartbeat (): void {
- // Stop heartbeat
- this.stopHeartbeat()
- // Start heartbeat
- this.startHeartbeat()
- }
-
- public restartWebSocketPing (): void {
- // Stop WebSocket ping
- this.stopWebSocketPing()
- // Start WebSocket ping
- this.startWebSocketPing()
- }
-
- public startMeterValues (connectorId: number, interval: number): void {
- if (connectorId === 0) {
- logger.error(`${this.logPrefix()} Trying to start MeterValues on connector id ${connectorId}`)
- return
- }
- const connectorStatus = this.getConnectorStatus(connectorId)
- if (connectorStatus == null) {
- logger.error(
- `${this.logPrefix()} Trying to start MeterValues on non existing connector id
- ${connectorId}`
- )
- return
+ private initializeConnectorsFromTemplate (stationTemplate: ChargingStationTemplate): void {
+ if (stationTemplate.Connectors == null && this.connectors.size === 0) {
+ const errorMsg = `No already defined connectors and charging station information from template ${this.templateFile} with no connectors configuration defined`
+ logger.error(`${this.logPrefix()} ${errorMsg}`)
+ throw new BaseError(errorMsg)
}
- if (connectorStatus.transactionStarted === false) {
- logger.error(
- `${this.logPrefix()} Trying to start MeterValues on connector id ${connectorId} with no transaction started`
- )
- return
- } else if (
- connectorStatus.transactionStarted === true &&
- connectorStatus.transactionId == null
- ) {
- logger.error(
- `${this.logPrefix()} Trying to start MeterValues on connector id ${connectorId} with no transaction id`
+ if (stationTemplate.Connectors?.[0] == null) {
+ logger.warn(
+ `${this.logPrefix()} Charging station information from template ${
+ this.templateFile
+ } with no connector id 0 configuration`
)
- return
}
- if (interval > 0) {
- connectorStatus.transactionSetInterval = setInterval(() => {
- const meterValue = buildMeterValue(
- this,
- connectorId,
- // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
- connectorStatus.transactionId!,
- interval
- )
- this.ocppRequestService
- .requestHandler<MeterValuesRequest, MeterValuesResponse>(
- this,
- RequestCommand.METER_VALUES,
- {
- connectorId,
- transactionId: connectorStatus.transactionId,
- meterValue: [meterValue]
- }
+ if (stationTemplate.Connectors != null) {
+ const { configuredMaxConnectors, templateMaxAvailableConnectors, templateMaxConnectors } =
+ checkConnectorsConfiguration(stationTemplate, this.logPrefix(), this.templateFile)
+ const connectorsConfigHash = createHash(Constants.DEFAULT_HASH_ALGORITHM)
+ .update(
+ `${JSON.stringify(stationTemplate.Connectors)}${configuredMaxConnectors.toString()}`
)
- .catch(error => {
- logger.error(
- `${this.logPrefix()} Error while sending '${RequestCommand.METER_VALUES}':`,
- error
+ .digest('hex')
+ const connectorsConfigChanged =
+ this.connectors.size !== 0 && this.connectorsConfigurationHash !== connectorsConfigHash
+ if (this.connectors.size === 0 || connectorsConfigChanged) {
+ connectorsConfigChanged && this.connectors.clear()
+ this.connectorsConfigurationHash = connectorsConfigHash
+ if (templateMaxConnectors > 0) {
+ for (let connectorId = 0; connectorId <= configuredMaxConnectors; connectorId++) {
+ if (
+ connectorId === 0 &&
+ // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
+ (stationTemplate.Connectors[connectorId] == null ||
+ !this.getUseConnectorId0(stationTemplate))
+ ) {
+ continue
+ }
+ const templateConnectorId =
+ connectorId > 0 && stationTemplate.randomConnectors === true
+ ? randomInt(1, templateMaxAvailableConnectors)
+ : connectorId
+ const connectorStatus = stationTemplate.Connectors[templateConnectorId]
+ checkStationInfoConnectorStatus(
+ templateConnectorId,
+ connectorStatus,
+ this.logPrefix(),
+ this.templateFile
)
- })
- }, interval)
+ this.connectors.set(connectorId, clone<ConnectorStatus>(connectorStatus))
+ }
+ initializeConnectorsMapStatus(this.connectors, this.logPrefix())
+ this.saveConnectorsStatus()
+ } else {
+ logger.warn(
+ `${this.logPrefix()} Charging station information from template ${
+ this.templateFile
+ } with no connectors configuration defined, cannot create connectors`
+ )
+ }
+ }
} else {
- logger.error(
- `${this.logPrefix()} Charging station ${
- StandardParametersKey.MeterValueSampleInterval
- } configuration set to ${interval}, not sending MeterValues`
+ logger.warn(
+ `${this.logPrefix()} Charging station information from template ${
+ this.templateFile
+ } with no connectors configuration defined, using already defined connectors`
)
}
}
- public stopMeterValues (connectorId: number): void {
- const connectorStatus = this.getConnectorStatus(connectorId)
- if (connectorStatus?.transactionSetInterval != null) {
- clearInterval(connectorStatus.transactionSetInterval)
+ private initializeConnectorsOrEvsesFromFile (configuration: ChargingStationConfiguration): void {
+ if (configuration.connectorsStatus != null && configuration.evsesStatus == null) {
+ for (const [connectorId, connectorStatus] of configuration.connectorsStatus.entries()) {
+ this.connectors.set(
+ connectorId,
+ prepareConnectorStatus(clone<ConnectorStatus>(connectorStatus))
+ )
+ }
+ } else if (configuration.evsesStatus != null && configuration.connectorsStatus == null) {
+ for (const [evseId, evseStatusConfiguration] of configuration.evsesStatus.entries()) {
+ const evseStatus = clone<EvseStatusConfiguration>(evseStatusConfiguration)
+ delete evseStatus.connectorsStatus
+ this.evses.set(evseId, {
+ ...(evseStatus as EvseStatus),
+ connectors: new Map<number, ConnectorStatus>(
+ // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+ evseStatusConfiguration.connectorsStatus!.map((connectorStatus, connectorId) => [
+ connectorId,
+ prepareConnectorStatus(connectorStatus),
+ ])
+ ),
+ })
+ }
+ } else if (configuration.evsesStatus != null && configuration.connectorsStatus != null) {
+ const errorMsg = `Connectors and evses defined at the same time in configuration file ${this.configurationFile}`
+ logger.error(`${this.logPrefix()} ${errorMsg}`)
+ throw new BaseError(errorMsg)
+ } else {
+ const errorMsg = `No connectors or evses defined in configuration file ${this.configurationFile}`
+ logger.error(`${this.logPrefix()} ${errorMsg}`)
+ throw new BaseError(errorMsg)
}
}
- private add (): void {
- this.emit(ChargingStationEvents.added)
- }
-
- public async delete (deleteConfiguration = true): Promise<void> {
- if (this.started) {
- await this.stop()
+ private initializeConnectorsOrEvsesFromTemplate (stationTemplate: ChargingStationTemplate): void {
+ if (stationTemplate.Connectors != null && stationTemplate.Evses == null) {
+ this.initializeConnectorsFromTemplate(stationTemplate)
+ } else if (stationTemplate.Evses != null && stationTemplate.Connectors == null) {
+ this.initializeEvsesFromTemplate(stationTemplate)
+ } else if (stationTemplate.Evses != null && stationTemplate.Connectors != null) {
+ const errorMsg = `Connectors and evses defined at the same time in template file ${this.templateFile}`
+ logger.error(`${this.logPrefix()} ${errorMsg}`)
+ throw new BaseError(errorMsg)
+ } else {
+ const errorMsg = `No connectors or evses defined in template file ${this.templateFile}`
+ logger.error(`${this.logPrefix()} ${errorMsg}`)
+ throw new BaseError(errorMsg)
}
- AutomaticTransactionGenerator.deleteInstance(this)
- PerformanceStatistics.deleteInstance(this.stationInfo?.hashId)
- // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
- this.idTagsCache.deleteIdTags(getIdTagsFile(this.stationInfo!)!)
- this.requests.clear()
- this.connectors.clear()
- this.evses.clear()
- this.templateFileWatcher?.unref()
- deleteConfiguration && rmSync(this.configurationFile, { force: true })
- this.chargingStationWorkerBroadcastChannel.unref()
- this.emit(ChargingStationEvents.deleted)
- this.removeAllListeners()
}
- public start (): void {
- if (!this.started) {
- if (!this.starting) {
- this.starting = true
- if (this.stationInfo?.enableStatistics === true) {
- this.performanceStatistics?.start()
- }
- this.openWSConnection()
- // Monitor charging station template file
- this.templateFileWatcher = watchJsonFile(
- this.templateFile,
- FileType.ChargingStationTemplate,
- this.logPrefix(),
- undefined,
- (event, filename): void => {
- if (isNotEmptyString(filename) && event === 'change') {
- try {
- logger.debug(
- `${this.logPrefix()} ${FileType.ChargingStationTemplate} ${
- this.templateFile
- } file have changed, reload`
- )
- this.sharedLRUCache.deleteChargingStationTemplate(this.templateFileHash)
- // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
- this.idTagsCache.deleteIdTags(getIdTagsFile(this.stationInfo!)!)
- // Initialize
- this.initialize()
- // Restart the ATG
- const ATGStarted = this.automaticTransactionGenerator?.started
- if (ATGStarted === true) {
- this.stopAutomaticTransactionGenerator()
- }
- delete this.automaticTransactionGeneratorConfiguration
- if (
- this.getAutomaticTransactionGeneratorConfiguration()?.enable === true &&
- ATGStarted === true
- ) {
- this.startAutomaticTransactionGenerator(undefined, true)
- }
- if (this.stationInfo?.enableStatistics === true) {
- this.performanceStatistics?.restart()
- } else {
- this.performanceStatistics?.stop()
- }
- // FIXME?: restart heartbeat and WebSocket ping when their interval values have changed
- } catch (error) {
- logger.error(
- `${this.logPrefix()} ${FileType.ChargingStationTemplate} file monitoring error:`,
- error
- )
- }
- }
+ private initializeEvsesFromTemplate (stationTemplate: ChargingStationTemplate): void {
+ if (stationTemplate.Evses == null && this.evses.size === 0) {
+ const errorMsg = `No already defined evses and charging station information from template ${this.templateFile} with no evses configuration defined`
+ logger.error(`${this.logPrefix()} ${errorMsg}`)
+ throw new BaseError(errorMsg)
+ }
+ if (stationTemplate.Evses?.[0] == null) {
+ logger.warn(
+ `${this.logPrefix()} Charging station information from template ${
+ this.templateFile
+ } with no evse id 0 configuration`
+ )
+ }
+ if (stationTemplate.Evses?.[0]?.Connectors[0] == null) {
+ logger.warn(
+ `${this.logPrefix()} Charging station information from template ${
+ this.templateFile
+ } with evse id 0 with no connector id 0 configuration`
+ )
+ }
+ if (Object.keys(stationTemplate.Evses?.[0]?.Connectors as object).length > 1) {
+ logger.warn(
+ `${this.logPrefix()} Charging station information from template ${
+ this.templateFile
+ } with evse id 0 with more than one connector configuration, only connector id 0 configuration will be used`
+ )
+ }
+ if (stationTemplate.Evses != null) {
+ const evsesConfigHash = createHash(Constants.DEFAULT_HASH_ALGORITHM)
+ .update(JSON.stringify(stationTemplate.Evses))
+ .digest('hex')
+ const evsesConfigChanged =
+ this.evses.size !== 0 && this.evsesConfigurationHash !== evsesConfigHash
+ if (this.evses.size === 0 || evsesConfigChanged) {
+ evsesConfigChanged && this.evses.clear()
+ this.evsesConfigurationHash = evsesConfigHash
+ const templateMaxEvses = getMaxNumberOfEvses(stationTemplate.Evses)
+ if (templateMaxEvses > 0) {
+ for (const evseKey in stationTemplate.Evses) {
+ const evseId = convertToInt(evseKey)
+ this.evses.set(evseId, {
+ availability: AvailabilityType.Operative,
+ connectors: buildConnectorsMap(
+ stationTemplate.Evses[evseKey].Connectors,
+ this.logPrefix(),
+ this.templateFile
+ ),
+ })
+ // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+ initializeConnectorsMapStatus(this.evses.get(evseId)!.connectors, this.logPrefix())
}
- )
- this.started = true
- this.emit(ChargingStationEvents.started)
- this.starting = false
- } else {
- logger.warn(`${this.logPrefix()} Charging station is already starting...`)
+ this.saveEvsesStatus()
+ } else {
+ logger.warn(
+ `${this.logPrefix()} Charging station information from template ${
+ this.templateFile
+ } with no evses configuration defined, cannot create evses`
+ )
+ }
}
} else {
- logger.warn(`${this.logPrefix()} Charging station is already started...`)
+ logger.warn(
+ `${this.logPrefix()} Charging station information from template ${
+ this.templateFile
+ } with no evses configuration defined, using already defined evses`
+ )
}
}
- public async stop (
- reason?: StopTransactionReason,
- stopTransactions = this.stationInfo?.stopTransactionsOnStopped
- ): Promise<void> {
- if (this.started) {
- if (!this.stopping) {
- this.stopping = true
- await this.stopMessageSequence(reason, stopTransactions)
- this.closeWSConnection()
- if (this.stationInfo?.enableStatistics === true) {
- this.performanceStatistics?.stop()
+ private initializeOcppConfiguration (): void {
+ if (getConfigurationKey(this, StandardParametersKey.HeartbeatInterval) == null) {
+ addConfigurationKey(this, StandardParametersKey.HeartbeatInterval, '0')
+ }
+ if (getConfigurationKey(this, StandardParametersKey.HeartBeatInterval) == null) {
+ addConfigurationKey(this, StandardParametersKey.HeartBeatInterval, '0', {
+ visible: false,
+ })
+ }
+ if (
+ this.stationInfo?.supervisionUrlOcppConfiguration === true &&
+ isNotEmptyString(this.stationInfo.supervisionUrlOcppKey) &&
+ getConfigurationKey(this, this.stationInfo.supervisionUrlOcppKey) == null
+ ) {
+ addConfigurationKey(
+ this,
+ this.stationInfo.supervisionUrlOcppKey,
+ this.configuredSupervisionUrl.href,
+ { reboot: true }
+ )
+ } else if (
+ this.stationInfo?.supervisionUrlOcppConfiguration === false &&
+ isNotEmptyString(this.stationInfo.supervisionUrlOcppKey) &&
+ getConfigurationKey(this, this.stationInfo.supervisionUrlOcppKey) != null
+ ) {
+ deleteConfigurationKey(this, this.stationInfo.supervisionUrlOcppKey, {
+ save: false,
+ })
+ }
+ if (
+ isNotEmptyString(this.stationInfo?.amperageLimitationOcppKey) &&
+ getConfigurationKey(this, this.stationInfo.amperageLimitationOcppKey) == null
+ ) {
+ addConfigurationKey(
+ this,
+ this.stationInfo.amperageLimitationOcppKey,
+ // prettier-ignore
+ // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+ (this.stationInfo.maximumAmperage! * getAmperageLimitationUnitDivider(this.stationInfo)).toString()
+ )
+ }
+ if (getConfigurationKey(this, StandardParametersKey.SupportedFeatureProfiles) == null) {
+ addConfigurationKey(
+ this,
+ StandardParametersKey.SupportedFeatureProfiles,
+ `${SupportedFeatureProfiles.Core},${SupportedFeatureProfiles.FirmwareManagement},${SupportedFeatureProfiles.LocalAuthListManagement},${SupportedFeatureProfiles.SmartCharging},${SupportedFeatureProfiles.RemoteTrigger}`
+ )
+ }
+ addConfigurationKey(
+ this,
+ StandardParametersKey.NumberOfConnectors,
+ this.getNumberOfConnectors().toString(),
+ { readonly: true },
+ { overwrite: true }
+ )
+ if (getConfigurationKey(this, StandardParametersKey.MeterValuesSampledData) == null) {
+ addConfigurationKey(
+ this,
+ StandardParametersKey.MeterValuesSampledData,
+ MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER
+ )
+ }
+ if (getConfigurationKey(this, StandardParametersKey.ConnectorPhaseRotation) == null) {
+ const connectorsPhaseRotation: string[] = []
+ if (this.hasEvses) {
+ for (const evseStatus of this.evses.values()) {
+ for (const connectorId of evseStatus.connectors.keys()) {
+ connectorsPhaseRotation.push(
+ // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+ getPhaseRotationValue(connectorId, this.getNumberOfPhases())!
+ )
+ }
}
- this.templateFileWatcher?.close()
- delete this.bootNotificationResponse
- this.started = false
- this.saveConfiguration()
- this.sharedLRUCache.deleteChargingStationConfiguration(this.configurationFileHash)
- this.emit(ChargingStationEvents.stopped)
- this.stopping = false
} else {
- logger.warn(`${this.logPrefix()} Charging station is already stopping...`)
+ for (const connectorId of this.connectors.keys()) {
+ connectorsPhaseRotation.push(
+ // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+ getPhaseRotationValue(connectorId, this.getNumberOfPhases())!
+ )
+ }
}
- } else {
- logger.warn(`${this.logPrefix()} Charging station is already stopped...`)
+ addConfigurationKey(
+ this,
+ StandardParametersKey.ConnectorPhaseRotation,
+ connectorsPhaseRotation.toString()
+ )
+ }
+ if (getConfigurationKey(this, StandardParametersKey.AuthorizeRemoteTxRequests) == null) {
+ addConfigurationKey(this, StandardParametersKey.AuthorizeRemoteTxRequests, 'true')
+ }
+ if (
+ getConfigurationKey(this, StandardParametersKey.LocalAuthListEnabled) == null &&
+ hasFeatureProfile(this, SupportedFeatureProfiles.LocalAuthListManagement) === true
+ ) {
+ addConfigurationKey(this, StandardParametersKey.LocalAuthListEnabled, 'false')
+ }
+ if (getConfigurationKey(this, StandardParametersKey.ConnectionTimeOut) == null) {
+ addConfigurationKey(
+ this,
+ StandardParametersKey.ConnectionTimeOut,
+ Constants.DEFAULT_CONNECTION_TIMEOUT.toString()
+ )
}
+ this.saveOcppConfiguration()
}
- public async reset (reason?: StopTransactionReason): Promise<void> {
- await this.stop(reason)
- // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
- await sleep(this.stationInfo!.resetTime!)
- this.initialize()
- this.start()
+ private initializeOcppServices (): void {
+ const ocppVersion = this.stationInfo?.ocppVersion
+ switch (ocppVersion) {
+ case OCPPVersion.VERSION_16:
+ this.ocppIncomingRequestService =
+ OCPP16IncomingRequestService.getInstance<OCPP16IncomingRequestService>()
+ this.ocppRequestService = OCPP16RequestService.getInstance<OCPP16RequestService>(
+ OCPP16ResponseService.getInstance<OCPP16ResponseService>()
+ )
+ break
+ case OCPPVersion.VERSION_20:
+ case OCPPVersion.VERSION_201:
+ this.ocppIncomingRequestService =
+ OCPP20IncomingRequestService.getInstance<OCPP20IncomingRequestService>()
+ this.ocppRequestService = OCPP20RequestService.getInstance<OCPP20RequestService>(
+ OCPP20ResponseService.getInstance<OCPP20ResponseService>()
+ )
+ break
+ default:
+ this.handleUnsupportedVersion(ocppVersion)
+ break
+ }
}
- public saveOcppConfiguration (): void {
- if (this.stationInfo?.ocppPersistentConfiguration === true) {
- this.saveConfiguration()
+ private internalStopMessageSequence (): void {
+ // Stop WebSocket ping
+ this.stopWebSocketPing()
+ // Stop heartbeat
+ this.stopHeartbeat()
+ // Stop the ATG
+ if (this.automaticTransactionGenerator?.started === true) {
+ this.stopAutomaticTransactionGenerator()
}
}
- public bufferMessage (message: string): void {
- this.messageBuffer.add(message)
- this.setIntervalFlushMessageBuffer()
- }
-
- public openWSConnection (
- options?: WsOptions,
- params?: { closeOpened?: boolean, terminateOpened?: boolean }
- ): void {
- options = {
- handshakeTimeout: secondsToMilliseconds(this.getConnectionTimeout()),
- ...this.stationInfo?.wsOptions,
- ...options
- }
- params = { ...{ closeOpened: false, terminateOpened: false }, ...params }
- if (!checkChargingStation(this, this.logPrefix())) {
- return
- }
- if (this.stationInfo?.supervisionUser != null && this.stationInfo.supervisionPassword != null) {
- options.auth = `${this.stationInfo.supervisionUser}:${this.stationInfo.supervisionPassword}`
- }
- if (params.closeOpened === true) {
- this.closeWSConnection()
- }
- if (params.terminateOpened === true) {
- this.terminateWSConnection()
- }
-
- if (this.isWebSocketConnectionOpened()) {
- logger.warn(
- `${this.logPrefix()} OCPP connection to URL ${this.wsConnectionUrl.href} is already opened`
- )
- return
- }
-
- logger.info(`${this.logPrefix()} Open OCPP connection to URL ${this.wsConnectionUrl.href}`)
-
- this.wsConnection = new WebSocket(
- this.wsConnectionUrl,
- `ocpp${this.stationInfo?.ocppVersion}`,
- options
- )
-
- // Handle WebSocket message
- this.wsConnection.on('message', data => {
- this.onMessage(data).catch(Constants.EMPTY_FUNCTION)
- })
- // Handle WebSocket error
- this.wsConnection.on('error', this.onError.bind(this))
- // Handle WebSocket close
- this.wsConnection.on('close', this.onClose.bind(this))
- // Handle WebSocket open
- this.wsConnection.on('open', () => {
- this.onOpen().catch(error =>
- logger.error(`${this.logPrefix()} Error while opening WebSocket connection:`, error)
- )
- })
- // Handle WebSocket ping
- this.wsConnection.on('ping', this.onPing.bind(this))
- // Handle WebSocket pong
- this.wsConnection.on('pong', this.onPong.bind(this))
- }
-
- public closeWSConnection (): void {
- if (this.isWebSocketConnectionOpened()) {
- this.wsConnection?.close()
- this.wsConnection = null
- }
- }
-
- public getAutomaticTransactionGeneratorConfiguration ():
- | AutomaticTransactionGeneratorConfiguration
- | undefined {
- if (this.automaticTransactionGeneratorConfiguration == null) {
- let automaticTransactionGeneratorConfiguration:
- | AutomaticTransactionGeneratorConfiguration
- | undefined
- const stationTemplate = this.getTemplateFromFile()
- const stationConfiguration = this.getConfigurationFromFile()
- if (
- this.stationInfo?.automaticTransactionGeneratorPersistentConfiguration === true &&
- stationConfiguration?.stationInfo?.templateHash === stationTemplate?.templateHash &&
- stationConfiguration?.automaticTransactionGenerator != null
- ) {
- automaticTransactionGeneratorConfiguration =
- stationConfiguration.automaticTransactionGenerator
- } else {
- automaticTransactionGeneratorConfiguration = stationTemplate?.AutomaticTransactionGenerator
- }
- this.automaticTransactionGeneratorConfiguration = {
- ...Constants.DEFAULT_ATG_CONFIGURATION,
- ...automaticTransactionGeneratorConfiguration
- }
- }
- return this.automaticTransactionGeneratorConfiguration
- }
-
- public getAutomaticTransactionGeneratorStatuses (): Status[] | undefined {
- return this.getConfigurationFromFile()?.automaticTransactionGeneratorStatuses
- }
-
- public startAutomaticTransactionGenerator (
- connectorIds?: number[],
- stopAbsoluteDuration?: boolean
- ): void {
- this.automaticTransactionGenerator = AutomaticTransactionGenerator.getInstance(this)
- if (isNotEmptyArray(connectorIds)) {
- for (const connectorId of connectorIds) {
- this.automaticTransactionGenerator?.startConnector(connectorId, stopAbsoluteDuration)
- }
- } else {
- this.automaticTransactionGenerator?.start(stopAbsoluteDuration)
- }
- this.saveAutomaticTransactionGeneratorConfiguration()
- this.emit(ChargingStationEvents.updated)
- }
-
- public stopAutomaticTransactionGenerator (connectorIds?: number[]): void {
- if (isNotEmptyArray(connectorIds)) {
- for (const connectorId of connectorIds) {
- this.automaticTransactionGenerator?.stopConnector(connectorId)
- }
- } else {
- this.automaticTransactionGenerator?.stop()
- }
- this.saveAutomaticTransactionGeneratorConfiguration()
- this.emit(ChargingStationEvents.updated)
- }
-
- public async stopTransactionOnConnector (
- connectorId: number,
- reason?: StopTransactionReason
- ): Promise<StopTransactionResponse> {
- const transactionId = this.getConnectorStatus(connectorId)?.transactionId
- if (
- this.stationInfo?.beginEndMeterValues === true &&
- this.stationInfo.ocppStrictCompliance === true &&
- this.stationInfo.outOfOrderEndMeterValues === false
- ) {
- const transactionEndMeterValue = buildTransactionEndMeterValue(
- this,
- connectorId,
- this.getEnergyActiveImportRegisterByTransactionId(transactionId)
- )
- await this.ocppRequestService.requestHandler<MeterValuesRequest, MeterValuesResponse>(
- this,
- RequestCommand.METER_VALUES,
- {
- connectorId,
- transactionId,
- meterValue: [transactionEndMeterValue]
- }
- )
- }
- return await this.ocppRequestService.requestHandler<
- StopTransactionRequest,
- StopTransactionResponse
- >(this, RequestCommand.STOP_TRANSACTION, {
- transactionId,
- meterStop: this.getEnergyActiveImportRegisterByTransactionId(transactionId, true),
- ...(reason != null && { reason })
- })
- }
-
- public getReserveConnectorZeroSupported (): boolean {
- return convertToBoolean(
- // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
- getConfigurationKey(this, StandardParametersKey.ReserveConnectorZeroSupported)!.value
- )
- }
-
- public async addReservation (reservation: Reservation): Promise<void> {
- const reservationFound = this.getReservationBy('reservationId', reservation.reservationId)
- if (reservationFound != null) {
- await this.removeReservation(reservationFound, ReservationTerminationReason.REPLACE_EXISTING)
- }
- // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
- this.getConnectorStatus(reservation.connectorId)!.reservation = reservation
- await sendAndSetConnectorStatus(
- this,
- reservation.connectorId,
- ConnectorStatusEnum.Reserved,
- undefined,
- { send: reservation.connectorId !== 0 }
- )
- }
-
- public async removeReservation (
- reservation: Reservation,
- reason: ReservationTerminationReason
- ): Promise<void> {
- // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
- const connector = this.getConnectorStatus(reservation.connectorId)!
- switch (reason) {
- case ReservationTerminationReason.CONNECTOR_STATE_CHANGED:
- case ReservationTerminationReason.TRANSACTION_STARTED:
- delete connector.reservation
- break
- case ReservationTerminationReason.RESERVATION_CANCELED:
- case ReservationTerminationReason.REPLACE_EXISTING:
- case ReservationTerminationReason.EXPIRED:
- await sendAndSetConnectorStatus(
- this,
- reservation.connectorId,
- ConnectorStatusEnum.Available,
- undefined,
- { send: reservation.connectorId !== 0 }
- )
- delete connector.reservation
- break
- default:
- // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
- throw new BaseError(`Unknown reservation termination reason '${reason}'`)
- }
- }
-
- public getReservationBy (
- filterKey: ReservationKey,
- value: number | string
- ): Reservation | undefined {
- if (this.hasEvses) {
- for (const evseStatus of this.evses.values()) {
- for (const connectorStatus of evseStatus.connectors.values()) {
- if (connectorStatus.reservation?.[filterKey] === value) {
- return connectorStatus.reservation
- }
- }
- }
- } else {
- for (const connectorStatus of this.connectors.values()) {
- if (connectorStatus.reservation?.[filterKey] === value) {
- return connectorStatus.reservation
- }
- }
- }
- }
-
- public isConnectorReservable (
- reservationId: number,
- idTag?: string,
- connectorId?: number
- ): boolean {
- const reservation = this.getReservationBy('reservationId', reservationId)
- const reservationExists = reservation != null && !hasReservationExpired(reservation)
- if (arguments.length === 1) {
- return !reservationExists
- } else if (arguments.length > 1) {
- const userReservation = idTag != null ? this.getReservationBy('idTag', idTag) : undefined
- const userReservationExists =
- userReservation != null && !hasReservationExpired(userReservation)
- const notConnectorZero = connectorId == null ? true : connectorId > 0
- const freeConnectorsAvailable = this.getNumberOfReservableConnectors() > 0
- return (
- !reservationExists && !userReservationExists && notConnectorZero && freeConnectorsAvailable
- )
- }
- return false
- }
-
- private setIntervalFlushMessageBuffer (): void {
- if (this.flushMessageBufferSetInterval == null) {
- this.flushMessageBufferSetInterval = setInterval(() => {
- if (this.isWebSocketConnectionOpened() && this.inAcceptedState()) {
- this.flushMessageBuffer()
- }
- if (this.messageBuffer.size === 0) {
- this.clearIntervalFlushMessageBuffer()
- }
- }, Constants.DEFAULT_MESSAGE_BUFFER_FLUSH_INTERVAL)
- }
- }
-
- private clearIntervalFlushMessageBuffer (): void {
- if (this.flushMessageBufferSetInterval != null) {
- clearInterval(this.flushMessageBufferSetInterval)
- delete this.flushMessageBufferSetInterval
- }
- }
-
- private getNumberOfReservableConnectors (): number {
- let numberOfReservableConnectors = 0
- if (this.hasEvses) {
- for (const evseStatus of this.evses.values()) {
- numberOfReservableConnectors += getNumberOfReservableConnectors(evseStatus.connectors)
- }
- } else {
- numberOfReservableConnectors = getNumberOfReservableConnectors(this.connectors)
- }
- return numberOfReservableConnectors - this.getNumberOfReservationsOnConnectorZero()
- }
-
- private getNumberOfReservationsOnConnectorZero (): number {
- if (
- (this.hasEvses && this.evses.get(0)?.connectors.get(0)?.reservation != null) ||
- (!this.hasEvses && this.connectors.get(0)?.reservation != null)
- ) {
- return 1
- }
- return 0
- }
-
- private flushMessageBuffer (): void {
- if (this.messageBuffer.size > 0) {
- for (const message of this.messageBuffer.values()) {
- let beginId: string | undefined
- let commandName: RequestCommand | undefined
- const [messageType] = JSON.parse(message) as OutgoingRequest | Response | ErrorResponse
- const isRequest = messageType === MessageType.CALL_MESSAGE
- if (isRequest) {
- [, , commandName] = JSON.parse(message) as OutgoingRequest
- beginId = PerformanceStatistics.beginMeasure(commandName)
- }
- this.wsConnection?.send(message, (error?: Error) => {
- // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
- isRequest && PerformanceStatistics.endMeasure(commandName!, beginId!)
- if (error == null) {
- logger.debug(
- `${this.logPrefix()} >> Buffered ${getMessageTypeString(
- messageType
- )} OCPP message sent '${JSON.stringify(message)}'`
- )
- this.messageBuffer.delete(message)
- } else {
- logger.debug(
- `${this.logPrefix()} >> Buffered ${getMessageTypeString(
- messageType
- )} OCPP message '${JSON.stringify(message)}' send failed:`,
- error
- )
- }
- })
- }
- }
- }
-
- private getTemplateFromFile (): ChargingStationTemplate | undefined {
- let template: ChargingStationTemplate | undefined
- try {
- if (this.sharedLRUCache.hasChargingStationTemplate(this.templateFileHash)) {
- template = this.sharedLRUCache.getChargingStationTemplate(this.templateFileHash)
- } else {
- const measureId = `${FileType.ChargingStationTemplate} read`
- const beginId = PerformanceStatistics.beginMeasure(measureId)
- template = JSON.parse(readFileSync(this.templateFile, 'utf8')) as ChargingStationTemplate
- PerformanceStatistics.endMeasure(measureId, beginId)
- template.templateHash = createHash(Constants.DEFAULT_HASH_ALGORITHM)
- .update(JSON.stringify(template))
- .digest('hex')
- this.sharedLRUCache.setChargingStationTemplate(template)
- this.templateFileHash = template.templateHash
- }
- } catch (error) {
- handleFileException(
- this.templateFile,
- FileType.ChargingStationTemplate,
- error as NodeJS.ErrnoException,
- this.logPrefix()
- )
- }
- return template
- }
-
- private getStationInfoFromTemplate (): ChargingStationInfo {
- // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
- const stationTemplate = this.getTemplateFromFile()!
- checkTemplate(stationTemplate, this.logPrefix(), this.templateFile)
- const warnTemplateKeysDeprecationOnce = once(warnTemplateKeysDeprecation, this)
- warnTemplateKeysDeprecationOnce(stationTemplate, this.logPrefix(), this.templateFile)
- if (stationTemplate.Connectors != null) {
- checkConnectorsConfiguration(stationTemplate, this.logPrefix(), this.templateFile)
- }
- const stationInfo = stationTemplateToStationInfo(stationTemplate)
- stationInfo.hashId = getHashId(this.index, stationTemplate)
- stationInfo.templateIndex = this.index
- stationInfo.templateName = parse(this.templateFile).name
- stationInfo.chargingStationId = getChargingStationId(this.index, stationTemplate)
- createSerialNumber(stationTemplate, stationInfo)
- stationInfo.voltageOut = this.getVoltageOut(stationInfo)
- if (isNotEmptyArray(stationTemplate.power)) {
- const powerArrayRandomIndex = Math.floor(secureRandom() * stationTemplate.power.length)
- stationInfo.maximumPower =
- stationTemplate.powerUnit === PowerUnits.KILO_WATT
- ? stationTemplate.power[powerArrayRandomIndex] * 1000
- : stationTemplate.power[powerArrayRandomIndex]
- } else {
- stationInfo.maximumPower =
- stationTemplate.powerUnit === PowerUnits.KILO_WATT
- ? // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
- stationTemplate.power! * 1000
- : stationTemplate.power
- }
- stationInfo.maximumAmperage = this.getMaximumAmperage(stationInfo)
- if (
- isNotEmptyString(stationInfo.firmwareVersionPattern) &&
- isNotEmptyString(stationInfo.firmwareVersion) &&
- !new RegExp(stationInfo.firmwareVersionPattern).test(stationInfo.firmwareVersion)
- ) {
- logger.warn(
- `${this.logPrefix()} Firmware version '${stationInfo.firmwareVersion}' in template file ${
- this.templateFile
- } does not match firmware version pattern '${stationInfo.firmwareVersionPattern}'`
- )
- }
- stationInfo.firmwareUpgrade = merge<FirmwareUpgrade>(
- {
- versionUpgrade: {
- step: 1
- },
- reset: true
- },
- stationTemplate.firmwareUpgrade ?? {}
- )
- if (stationTemplate.resetTime != null) {
- stationInfo.resetTime = secondsToMilliseconds(stationTemplate.resetTime)
- }
- return stationInfo
- }
-
- private getStationInfoFromFile (
- stationInfoPersistentConfiguration: boolean | undefined = Constants.DEFAULT_STATION_INFO
- .stationInfoPersistentConfiguration
- ): ChargingStationInfo | undefined {
- let stationInfo: ChargingStationInfo | undefined
- if (stationInfoPersistentConfiguration === true) {
- stationInfo = this.getConfigurationFromFile()?.stationInfo
- if (stationInfo != null) {
- delete stationInfo.infoHash
- // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
- if (stationInfo.templateIndex == null) {
- stationInfo.templateIndex = this.index
- }
- // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
- if (stationInfo.templateName == null) {
- stationInfo.templateName = parse(this.templateFile).name
- }
- }
- }
- return stationInfo
- }
-
- private getStationInfo (options?: ChargingStationOptions): ChargingStationInfo {
- const stationInfoFromTemplate = this.getStationInfoFromTemplate()
- options?.persistentConfiguration != null &&
- (stationInfoFromTemplate.stationInfoPersistentConfiguration = options.persistentConfiguration)
- const stationInfoFromFile = this.getStationInfoFromFile(
- stationInfoFromTemplate.stationInfoPersistentConfiguration
- )
- // Priority:
- // 1. charging station info from template
- // 2. charging station info from configuration file
- if (
- stationInfoFromFile != null &&
- stationInfoFromFile.templateHash === stationInfoFromTemplate.templateHash
- ) {
- return setChargingStationOptions(
- { ...Constants.DEFAULT_STATION_INFO, ...stationInfoFromFile },
- options
- )
- }
- stationInfoFromFile != null &&
- propagateSerialNumber(
- this.getTemplateFromFile(),
- stationInfoFromFile,
- stationInfoFromTemplate
- )
- return setChargingStationOptions(
- { ...Constants.DEFAULT_STATION_INFO, ...stationInfoFromTemplate },
- options
- )
- }
-
- private saveStationInfo (): void {
- if (this.stationInfo?.stationInfoPersistentConfiguration === true) {
- this.saveConfiguration()
- }
- }
-
- private handleUnsupportedVersion (version: OCPPVersion | undefined): void {
- const errorMsg = `Unsupported protocol version '${version}' configured in template file ${this.templateFile}`
- logger.error(`${this.logPrefix()} ${errorMsg}`)
- throw new BaseError(errorMsg)
- }
-
- private initialize (options?: ChargingStationOptions): void {
- // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
- const stationTemplate = this.getTemplateFromFile()!
- checkTemplate(stationTemplate, this.logPrefix(), this.templateFile)
- this.configurationFile = join(
- dirname(this.templateFile.replace('station-templates', 'configurations')),
- `${getHashId(this.index, stationTemplate)}.json`
- )
- const stationConfiguration = this.getConfigurationFromFile()
- if (
- stationConfiguration?.stationInfo?.templateHash === stationTemplate.templateHash &&
- (stationConfiguration?.connectorsStatus != null || stationConfiguration?.evsesStatus != null)
- ) {
- checkConfiguration(stationConfiguration, this.logPrefix(), this.configurationFile)
- this.initializeConnectorsOrEvsesFromFile(stationConfiguration)
- } else {
- this.initializeConnectorsOrEvsesFromTemplate(stationTemplate)
- }
- this.stationInfo = this.getStationInfo(options)
- if (
- this.stationInfo.firmwareStatus === FirmwareStatus.Installing &&
- isNotEmptyString(this.stationInfo.firmwareVersionPattern) &&
- isNotEmptyString(this.stationInfo.firmwareVersion)
- ) {
- const patternGroup =
- this.stationInfo.firmwareUpgrade?.versionUpgrade?.patternGroup ??
- this.stationInfo.firmwareVersion.split('.').length
- const match = new RegExp(this.stationInfo.firmwareVersionPattern)
- .exec(this.stationInfo.firmwareVersion)
- ?.slice(1, patternGroup + 1)
- if (match != null) {
- const patchLevelIndex = match.length - 1
- match[patchLevelIndex] = (
- convertToInt(match[patchLevelIndex]) +
- // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
- this.stationInfo.firmwareUpgrade!.versionUpgrade!.step!
- ).toString()
- this.stationInfo.firmwareVersion = match.join('.')
- }
- }
- this.saveStationInfo()
- this.configuredSupervisionUrl = this.getConfiguredSupervisionUrl()
- if (this.stationInfo.enableStatistics === true) {
- this.performanceStatistics = PerformanceStatistics.getInstance(
- this.stationInfo.hashId,
- this.stationInfo.chargingStationId,
- this.configuredSupervisionUrl
- )
- }
- const bootNotificationRequest = createBootNotificationRequest(this.stationInfo)
- if (bootNotificationRequest == null) {
- const errorMsg = 'Error while creating boot notification request'
- logger.error(`${this.logPrefix()} ${errorMsg}`)
- throw new BaseError(errorMsg)
- }
- this.bootNotificationRequest = bootNotificationRequest
- this.powerDivider = this.getPowerDivider()
- // OCPP configuration
- this.ocppConfiguration = this.getOcppConfiguration(options?.persistentConfiguration)
- this.initializeOcppConfiguration()
- this.initializeOcppServices()
- if (this.stationInfo.autoRegister === true) {
- this.bootNotificationResponse = {
- currentTime: new Date(),
- interval: millisecondsToSeconds(this.getHeartbeatInterval()),
- status: RegistrationStatusEnumType.ACCEPTED
- }
- }
- }
-
- private initializeOcppServices (): void {
- const ocppVersion = this.stationInfo?.ocppVersion
- switch (ocppVersion) {
- case OCPPVersion.VERSION_16:
- this.ocppIncomingRequestService =
- OCPP16IncomingRequestService.getInstance<OCPP16IncomingRequestService>()
- this.ocppRequestService = OCPP16RequestService.getInstance<OCPP16RequestService>(
- OCPP16ResponseService.getInstance<OCPP16ResponseService>()
- )
- break
- case OCPPVersion.VERSION_20:
- case OCPPVersion.VERSION_201:
- this.ocppIncomingRequestService =
- OCPP20IncomingRequestService.getInstance<OCPP20IncomingRequestService>()
- this.ocppRequestService = OCPP20RequestService.getInstance<OCPP20RequestService>(
- OCPP20ResponseService.getInstance<OCPP20ResponseService>()
- )
- break
- default:
- this.handleUnsupportedVersion(ocppVersion)
- break
- }
- }
-
- private initializeOcppConfiguration (): void {
- if (getConfigurationKey(this, StandardParametersKey.HeartbeatInterval) == null) {
- addConfigurationKey(this, StandardParametersKey.HeartbeatInterval, '0')
- }
- if (getConfigurationKey(this, StandardParametersKey.HeartBeatInterval) == null) {
- addConfigurationKey(this, StandardParametersKey.HeartBeatInterval, '0', { visible: false })
- }
- if (
- this.stationInfo?.supervisionUrlOcppConfiguration === true &&
- isNotEmptyString(this.stationInfo.supervisionUrlOcppKey) &&
- getConfigurationKey(this, this.stationInfo.supervisionUrlOcppKey) == null
- ) {
- addConfigurationKey(
- this,
- this.stationInfo.supervisionUrlOcppKey,
- this.configuredSupervisionUrl.href,
- { reboot: true }
- )
- } else if (
- this.stationInfo?.supervisionUrlOcppConfiguration === false &&
- isNotEmptyString(this.stationInfo.supervisionUrlOcppKey) &&
- getConfigurationKey(this, this.stationInfo.supervisionUrlOcppKey) != null
- ) {
- deleteConfigurationKey(this, this.stationInfo.supervisionUrlOcppKey, { save: false })
- }
- if (
- isNotEmptyString(this.stationInfo?.amperageLimitationOcppKey) &&
- getConfigurationKey(this, this.stationInfo.amperageLimitationOcppKey) == null
- ) {
- addConfigurationKey(
- this,
- this.stationInfo.amperageLimitationOcppKey,
- // prettier-ignore
- // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
- (this.stationInfo.maximumAmperage! * getAmperageLimitationUnitDivider(this.stationInfo)).toString()
- )
- }
- if (getConfigurationKey(this, StandardParametersKey.SupportedFeatureProfiles) == null) {
- addConfigurationKey(
- this,
- StandardParametersKey.SupportedFeatureProfiles,
- `${SupportedFeatureProfiles.Core},${SupportedFeatureProfiles.FirmwareManagement},${SupportedFeatureProfiles.LocalAuthListManagement},${SupportedFeatureProfiles.SmartCharging},${SupportedFeatureProfiles.RemoteTrigger}`
- )
- }
- addConfigurationKey(
- this,
- StandardParametersKey.NumberOfConnectors,
- this.getNumberOfConnectors().toString(),
- { readonly: true },
- { overwrite: true }
- )
- if (getConfigurationKey(this, StandardParametersKey.MeterValuesSampledData) == null) {
- addConfigurationKey(
- this,
- StandardParametersKey.MeterValuesSampledData,
- MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER
- )
- }
- if (getConfigurationKey(this, StandardParametersKey.ConnectorPhaseRotation) == null) {
- const connectorsPhaseRotation: string[] = []
- if (this.hasEvses) {
- for (const evseStatus of this.evses.values()) {
- for (const connectorId of evseStatus.connectors.keys()) {
- connectorsPhaseRotation.push(
- // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
- getPhaseRotationValue(connectorId, this.getNumberOfPhases())!
- )
- }
- }
- } else {
- for (const connectorId of this.connectors.keys()) {
- connectorsPhaseRotation.push(
- // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
- getPhaseRotationValue(connectorId, this.getNumberOfPhases())!
- )
- }
- }
- addConfigurationKey(
- this,
- StandardParametersKey.ConnectorPhaseRotation,
- connectorsPhaseRotation.toString()
- )
- }
- if (getConfigurationKey(this, StandardParametersKey.AuthorizeRemoteTxRequests) == null) {
- addConfigurationKey(this, StandardParametersKey.AuthorizeRemoteTxRequests, 'true')
- }
- if (
- getConfigurationKey(this, StandardParametersKey.LocalAuthListEnabled) == null &&
- hasFeatureProfile(this, SupportedFeatureProfiles.LocalAuthListManagement) === true
- ) {
- addConfigurationKey(this, StandardParametersKey.LocalAuthListEnabled, 'false')
- }
- if (getConfigurationKey(this, StandardParametersKey.ConnectionTimeOut) == null) {
- addConfigurationKey(
- this,
- StandardParametersKey.ConnectionTimeOut,
- Constants.DEFAULT_CONNECTION_TIMEOUT.toString()
- )
- }
- this.saveOcppConfiguration()
- }
-
- private initializeConnectorsOrEvsesFromFile (configuration: ChargingStationConfiguration): void {
- if (configuration.connectorsStatus != null && configuration.evsesStatus == null) {
- for (const [connectorId, connectorStatus] of configuration.connectorsStatus.entries()) {
- this.connectors.set(connectorId, clone<ConnectorStatus>(connectorStatus))
- }
- } else if (configuration.evsesStatus != null && configuration.connectorsStatus == null) {
- for (const [evseId, evseStatusConfiguration] of configuration.evsesStatus.entries()) {
- const evseStatus = clone<EvseStatusConfiguration>(evseStatusConfiguration)
- delete evseStatus.connectorsStatus
- this.evses.set(evseId, {
- ...(evseStatus as EvseStatus),
- connectors: new Map<number, ConnectorStatus>(
- // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
- evseStatusConfiguration.connectorsStatus!.map((connectorStatus, connectorId) => [
- connectorId,
- connectorStatus
- ])
- )
- })
- }
- } else if (configuration.evsesStatus != null && configuration.connectorsStatus != null) {
- const errorMsg = `Connectors and evses defined at the same time in configuration file ${this.configurationFile}`
- logger.error(`${this.logPrefix()} ${errorMsg}`)
- throw new BaseError(errorMsg)
- } else {
- const errorMsg = `No connectors or evses defined in configuration file ${this.configurationFile}`
- logger.error(`${this.logPrefix()} ${errorMsg}`)
- throw new BaseError(errorMsg)
+ private onClose (code: WebSocketCloseEventStatusCode, reason: Buffer): void {
+ this.emit(ChargingStationEvents.disconnected)
+ this.emit(ChargingStationEvents.updated)
+ switch (code) {
+ // Normal close
+ case WebSocketCloseEventStatusCode.CLOSE_NO_STATUS:
+ case WebSocketCloseEventStatusCode.CLOSE_NORMAL:
+ logger.info(
+ `${this.logPrefix()} WebSocket normally closed with status '${getWebSocketCloseEventStatusString(
+ code
+ )}' and reason '${reason.toString()}'`
+ )
+ this.wsConnectionRetryCount = 0
+ break
+ // Abnormal close
+ default:
+ logger.error(
+ `${this.logPrefix()} WebSocket abnormally closed with status '${getWebSocketCloseEventStatusString(
+ code
+ )}' and reason '${reason.toString()}'`
+ )
+ this.started &&
+ this.reconnect()
+ .then(() => {
+ this.emit(ChargingStationEvents.updated)
+ return undefined
+ })
+ .catch((error: unknown) =>
+ logger.error(`${this.logPrefix()} Error while reconnecting:`, error)
+ )
+ break
}
}
- private initializeConnectorsOrEvsesFromTemplate (stationTemplate: ChargingStationTemplate): void {
- if (stationTemplate.Connectors != null && stationTemplate.Evses == null) {
- this.initializeConnectorsFromTemplate(stationTemplate)
- } else if (stationTemplate.Evses != null && stationTemplate.Connectors == null) {
- this.initializeEvsesFromTemplate(stationTemplate)
- } else if (stationTemplate.Evses != null && stationTemplate.Connectors != null) {
- const errorMsg = `Connectors and evses defined at the same time in template file ${this.templateFile}`
- logger.error(`${this.logPrefix()} ${errorMsg}`)
- throw new BaseError(errorMsg)
- } else {
- const errorMsg = `No connectors or evses defined in template file ${this.templateFile}`
- logger.error(`${this.logPrefix()} ${errorMsg}`)
- throw new BaseError(errorMsg)
- }
+ private onError (error: WSError): void {
+ this.closeWSConnection()
+ logger.error(`${this.logPrefix()} WebSocket error:`, error)
}
- private initializeConnectorsFromTemplate (stationTemplate: ChargingStationTemplate): void {
- if (stationTemplate.Connectors == null && this.connectors.size === 0) {
- const errorMsg = `No already defined connectors and charging station information from template ${this.templateFile} with no connectors configuration defined`
- logger.error(`${this.logPrefix()} ${errorMsg}`)
- throw new BaseError(errorMsg)
- }
- if (stationTemplate.Connectors?.[0] == null) {
- logger.warn(
- `${this.logPrefix()} Charging station information from template ${
- this.templateFile
- } with no connector id 0 configuration`
- )
- }
- if (stationTemplate.Connectors != null) {
- const { configuredMaxConnectors, templateMaxConnectors, templateMaxAvailableConnectors } =
- checkConnectorsConfiguration(stationTemplate, this.logPrefix(), this.templateFile)
- const connectorsConfigHash = createHash(Constants.DEFAULT_HASH_ALGORITHM)
- .update(
- `${JSON.stringify(stationTemplate.Connectors)}${configuredMaxConnectors.toString()}`
+ private async onMessage (data: RawData): Promise<void> {
+ let request: ErrorResponse | IncomingRequest | Response | undefined
+ let messageType: MessageType | undefined
+ let errorMsg: string
+ try {
+ // eslint-disable-next-line @typescript-eslint/no-base-to-string
+ request = JSON.parse(data.toString()) as ErrorResponse | IncomingRequest | Response
+ if (Array.isArray(request)) {
+ ;[messageType] = request
+ // Check the type of message
+ switch (messageType) {
+ // Error Message
+ case MessageType.CALL_ERROR_MESSAGE:
+ this.handleErrorMessage(request as ErrorResponse)
+ break
+ // Incoming Message
+ case MessageType.CALL_MESSAGE:
+ await this.handleIncomingMessage(request as IncomingRequest)
+ break
+ // Response Message
+ case MessageType.CALL_RESULT_MESSAGE:
+ this.handleResponseMessage(request as Response)
+ break
+ // Unknown Message
+ default:
+ // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
+ errorMsg = `Wrong message type ${messageType}`
+ logger.error(`${this.logPrefix()} ${errorMsg}`)
+ throw new OCPPError(ErrorType.PROTOCOL_ERROR, errorMsg)
+ }
+ } else {
+ throw new OCPPError(
+ ErrorType.PROTOCOL_ERROR,
+ 'Incoming message is not an array',
+ undefined,
+ {
+ request,
+ }
)
- .digest('hex')
- const connectorsConfigChanged =
- this.connectors.size !== 0 && this.connectorsConfigurationHash !== connectorsConfigHash
- if (this.connectors.size === 0 || connectorsConfigChanged) {
- connectorsConfigChanged && this.connectors.clear()
- this.connectorsConfigurationHash = connectorsConfigHash
- if (templateMaxConnectors > 0) {
- for (let connectorId = 0; connectorId <= configuredMaxConnectors; connectorId++) {
- if (
- connectorId === 0 &&
- // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
- (stationTemplate.Connectors[connectorId] == null ||
- !this.getUseConnectorId0(stationTemplate))
- ) {
- continue
- }
- const templateConnectorId =
- connectorId > 0 && stationTemplate.randomConnectors === true
- ? getRandomInteger(templateMaxAvailableConnectors, 1)
- : connectorId
- const connectorStatus = stationTemplate.Connectors[templateConnectorId]
- checkStationInfoConnectorStatus(
- templateConnectorId,
- connectorStatus,
- this.logPrefix(),
- this.templateFile
- )
- this.connectors.set(connectorId, clone<ConnectorStatus>(connectorStatus))
+ }
+ } catch (error) {
+ if (!Array.isArray(request)) {
+ // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
+ logger.error(`${this.logPrefix()} Incoming message '${request}' parsing error:`, error)
+ return
+ }
+ let commandName: IncomingRequestCommand | undefined
+ let requestCommandName: IncomingRequestCommand | RequestCommand | undefined
+ let errorCallback: ErrorCallback
+ const [, messageId] = request
+ switch (messageType) {
+ case MessageType.CALL_ERROR_MESSAGE:
+ case MessageType.CALL_RESULT_MESSAGE:
+ if (this.requests.has(messageId)) {
+ // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+ ;[, errorCallback, requestCommandName] = this.getCachedRequest(messageType, messageId)!
+ // Reject the deferred promise in case of error at response handling (rejecting an already fulfilled promise is a no-op)
+ errorCallback(error as OCPPError, false)
+ } else {
+ // Remove the request from the cache in case of error at response handling
+ this.requests.delete(messageId)
}
- initializeConnectorsMapStatus(this.connectors, this.logPrefix())
- this.saveConnectorsStatus()
- } else {
- logger.warn(
- `${this.logPrefix()} Charging station information from template ${
- this.templateFile
- } with no connectors configuration defined, cannot create connectors`
- )
- }
+ break
+ case MessageType.CALL_MESSAGE:
+ ;[, , commandName] = request as IncomingRequest
+ // Send error
+ await this.ocppRequestService.sendError(this, messageId, error as OCPPError, commandName)
+ break
}
- } else {
- logger.warn(
- `${this.logPrefix()} Charging station information from template ${
- this.templateFile
- } with no connectors configuration defined, using already defined connectors`
+ if (!(error instanceof OCPPError)) {
+ logger.warn(
+ `${this.logPrefix()} Error thrown at incoming OCPP command ${
+ commandName ?? requestCommandName ?? Constants.UNKNOWN_OCPP_COMMAND
+ // eslint-disable-next-line @typescript-eslint/no-base-to-string
+ } message '${data.toString()}' handling is not an OCPPError:`,
+ error
+ )
+ }
+ logger.error(
+ `${this.logPrefix()} Incoming OCPP command '${
+ commandName ?? requestCommandName ?? Constants.UNKNOWN_OCPP_COMMAND
+ // eslint-disable-next-line @typescript-eslint/no-base-to-string
+ }' message '${data.toString()}'${
+ this.requests.has(messageId)
+ ? ` matching cached request '${JSON.stringify(
+ this.getCachedRequest(messageType, messageId)
+ )}'`
+ : ''
+ } processing error:`,
+ error
)
}
}
- private initializeEvsesFromTemplate (stationTemplate: ChargingStationTemplate): void {
- if (stationTemplate.Evses == null && this.evses.size === 0) {
- const errorMsg = `No already defined evses and charging station information from template ${this.templateFile} with no evses configuration defined`
- logger.error(`${this.logPrefix()} ${errorMsg}`)
- throw new BaseError(errorMsg)
- }
- if (stationTemplate.Evses?.[0] == null) {
- logger.warn(
- `${this.logPrefix()} Charging station information from template ${
- this.templateFile
- } with no evse id 0 configuration`
- )
- }
- if (stationTemplate.Evses?.[0]?.Connectors[0] == null) {
- logger.warn(
- `${this.logPrefix()} Charging station information from template ${
- this.templateFile
- } with evse id 0 with no connector id 0 configuration`
- )
- }
- if (Object.keys(stationTemplate.Evses?.[0]?.Connectors as object).length > 1) {
- logger.warn(
- `${this.logPrefix()} Charging station information from template ${
- this.templateFile
- } with evse id 0 with more than one connector configuration, only connector id 0 configuration will be used`
+ private async onOpen (): Promise<void> {
+ if (this.isWebSocketConnectionOpened()) {
+ this.emit(ChargingStationEvents.connected)
+ this.emit(ChargingStationEvents.updated)
+ logger.info(
+ `${this.logPrefix()} Connection to OCPP server through ${
+ this.wsConnectionUrl.href
+ } succeeded`
)
- }
- if (stationTemplate.Evses != null) {
- const evsesConfigHash = createHash(Constants.DEFAULT_HASH_ALGORITHM)
- .update(JSON.stringify(stationTemplate.Evses))
- .digest('hex')
- const evsesConfigChanged =
- this.evses.size !== 0 && this.evsesConfigurationHash !== evsesConfigHash
- if (this.evses.size === 0 || evsesConfigChanged) {
- evsesConfigChanged && this.evses.clear()
- this.evsesConfigurationHash = evsesConfigHash
- const templateMaxEvses = getMaxNumberOfEvses(stationTemplate.Evses)
- if (templateMaxEvses > 0) {
- for (const evseKey in stationTemplate.Evses) {
- const evseId = convertToInt(evseKey)
- this.evses.set(evseId, {
- connectors: buildConnectorsMap(
- stationTemplate.Evses[evseKey].Connectors,
- this.logPrefix(),
- this.templateFile
- ),
- availability: AvailabilityType.Operative
- })
- // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
- initializeConnectorsMapStatus(this.evses.get(evseId)!.connectors, this.logPrefix())
+ let registrationRetryCount = 0
+ if (!this.isRegistered()) {
+ // Send BootNotification
+ do {
+ await this.ocppRequestService.requestHandler<
+ BootNotificationRequest,
+ BootNotificationResponse
+ >(this, RequestCommand.BOOT_NOTIFICATION, this.bootNotificationRequest, {
+ skipBufferingOnError: true,
+ })
+ // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+ this.bootNotificationResponse!.currentTime = convertToDate(
+ this.bootNotificationResponse?.currentTime
+ )!
+ if (!this.isRegistered()) {
+ this.stationInfo?.registrationMaxRetries !== -1 && ++registrationRetryCount
+ await sleep(
+ this.bootNotificationResponse?.interval != null
+ ? secondsToMilliseconds(this.bootNotificationResponse.interval)
+ : Constants.DEFAULT_BOOT_NOTIFICATION_INTERVAL
+ )
}
- this.saveEvsesStatus()
- } else {
- logger.warn(
- `${this.logPrefix()} Charging station information from template ${
- this.templateFile
- } with no evses configuration defined, cannot create evses`
- )
- }
+ } while (
+ !this.isRegistered() &&
+ // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+ (registrationRetryCount <= this.stationInfo!.registrationMaxRetries! ||
+ this.stationInfo?.registrationMaxRetries === -1)
+ )
+ }
+ if (!this.isRegistered()) {
+ logger.error(
+ // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
+ `${this.logPrefix()} Registration failure: maximum retries reached (${registrationRetryCount.toString()}) or retry disabled (${this.stationInfo?.registrationMaxRetries?.toString()})`
+ )
}
+ this.emit(ChargingStationEvents.updated)
} else {
logger.warn(
- `${this.logPrefix()} Charging station information from template ${
- this.templateFile
- } with no evses configuration defined, using already defined evses`
+ `${this.logPrefix()} Connection to OCPP server through ${this.wsConnectionUrl.href} failed`
)
}
}
- private getConfigurationFromFile (): ChargingStationConfiguration | undefined {
- let configuration: ChargingStationConfiguration | undefined
- if (isNotEmptyString(this.configurationFile) && existsSync(this.configurationFile)) {
- try {
- if (this.sharedLRUCache.hasChargingStationConfiguration(this.configurationFileHash)) {
- configuration = this.sharedLRUCache.getChargingStationConfiguration(
- this.configurationFileHash
- )
- } else {
- const measureId = `${FileType.ChargingStationConfiguration} read`
- const beginId = PerformanceStatistics.beginMeasure(measureId)
- configuration = JSON.parse(
- readFileSync(this.configurationFile, 'utf8')
- ) as ChargingStationConfiguration
- PerformanceStatistics.endMeasure(measureId, beginId)
- this.sharedLRUCache.setChargingStationConfiguration(configuration)
- // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
- this.configurationFileHash = configuration.configurationHash!
- }
- } catch (error) {
- handleFileException(
- this.configurationFile,
- FileType.ChargingStationConfiguration,
- error as NodeJS.ErrnoException,
- this.logPrefix()
- )
- }
+ private onPing (): void {
+ logger.debug(`${this.logPrefix()} Received a WS ping (rfc6455) from the server`)
+ }
+
+ private onPong (): void {
+ logger.debug(`${this.logPrefix()} Received a WS pong (rfc6455) from the server`)
+ }
+
+ private async reconnect (): Promise<void> {
+ if (
+ // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+ this.wsConnectionRetryCount < this.stationInfo!.autoReconnectMaxRetries! ||
+ this.stationInfo?.autoReconnectMaxRetries === -1
+ ) {
+ ++this.wsConnectionRetryCount
+ const reconnectDelay =
+ this.stationInfo?.reconnectExponentialDelay === true
+ ? exponentialDelay(this.wsConnectionRetryCount)
+ : secondsToMilliseconds(this.getConnectionTimeout())
+ const reconnectDelayWithdraw = 1000
+ const reconnectTimeout =
+ reconnectDelay - reconnectDelayWithdraw > 0 ? reconnectDelay - reconnectDelayWithdraw : 0
+ logger.error(
+ `${this.logPrefix()} WebSocket connection retry in ${roundTo(
+ reconnectDelay,
+ 2
+ ).toString()}ms, timeout ${reconnectTimeout.toString()}ms`
+ )
+ await sleep(reconnectDelay)
+ logger.error(
+ `${this.logPrefix()} WebSocket connection retry #${this.wsConnectionRetryCount.toString()}`
+ )
+ this.openWSConnection(
+ {
+ handshakeTimeout: reconnectTimeout,
+ },
+ { closeOpened: true }
+ )
+ } else if (this.stationInfo?.autoReconnectMaxRetries !== -1) {
+ logger.error(
+ // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
+ `${this.logPrefix()} WebSocket connection retries failure: maximum retries reached (${this.wsConnectionRetryCount.toString()}) or retries disabled (${this.stationInfo?.autoReconnectMaxRetries?.toString()})`
+ )
}
- return configuration
}
private saveAutomaticTransactionGeneratorConfiguration (): void {
}
}
- private saveConnectorsStatus (): void {
- this.saveConfiguration()
- }
-
- private saveEvsesStatus (): void {
- this.saveConfiguration()
- }
-
private saveConfiguration (): void {
if (isNotEmptyString(this.configurationFile)) {
try {
} else {
delete configurationData.configurationKey
}
- configurationData = merge<ChargingStationConfiguration>(
+ configurationData = mergeDeepRight(
configurationData,
buildChargingStationAutomaticTransactionGeneratorConfiguration(this)
)
const configurationHash = createHash(Constants.DEFAULT_HASH_ALGORITHM)
.update(
JSON.stringify({
- stationInfo: configurationData.stationInfo,
- configurationKey: configurationData.configurationKey,
automaticTransactionGenerator: configurationData.automaticTransactionGenerator,
+ configurationKey: configurationData.configurationKey,
+ stationInfo: configurationData.stationInfo,
...(this.connectors.size > 0 && {
- connectorsStatus: configurationData.connectorsStatus
+ connectorsStatus: configurationData.connectorsStatus,
+ }),
+ ...(this.evses.size > 0 && {
+ evsesStatus: configurationData.evsesStatus,
}),
- ...(this.evses.size > 0 && { evsesStatus: configurationData.evsesStatus })
} satisfies ChargingStationConfiguration)
)
.digest('hex')
this.sharedLRUCache.deleteChargingStationConfiguration(this.configurationFileHash)
this.sharedLRUCache.setChargingStationConfiguration(configurationData)
this.configurationFileHash = configurationHash
- }).catch(error => {
+ }).catch((error: unknown) => {
handleFileException(
this.configurationFile,
FileType.ChargingStationConfiguration,
}
}
- private getOcppConfigurationFromTemplate (): ChargingStationOcppConfiguration | undefined {
- return this.getTemplateFromFile()?.Configuration
+ private saveConnectorsStatus (): void {
+ this.saveConfiguration()
}
- private getOcppConfigurationFromFile (
- ocppPersistentConfiguration?: boolean
- ): ChargingStationOcppConfiguration | undefined {
- const configurationKey = this.getConfigurationFromFile()?.configurationKey
- if (ocppPersistentConfiguration === true && Array.isArray(configurationKey)) {
- return { configurationKey }
+ private saveEvsesStatus (): void {
+ this.saveConfiguration()
+ }
+
+ private saveStationInfo (): void {
+ if (this.stationInfo?.stationInfoPersistentConfiguration === true) {
+ this.saveConfiguration()
}
- return undefined
}
- private getOcppConfiguration (
- ocppPersistentConfiguration: boolean | undefined = this.stationInfo?.ocppPersistentConfiguration
- ): ChargingStationOcppConfiguration | undefined {
- let ocppConfiguration: ChargingStationOcppConfiguration | undefined =
- this.getOcppConfigurationFromFile(ocppPersistentConfiguration)
- if (ocppConfiguration == null) {
- ocppConfiguration = this.getOcppConfigurationFromTemplate()
+ private setIntervalFlushMessageBuffer (): void {
+ if (this.flushMessageBufferSetInterval == null) {
+ this.flushMessageBufferSetInterval = setInterval(() => {
+ if (this.isWebSocketConnectionOpened() && this.inAcceptedState()) {
+ this.flushMessageBuffer()
+ }
+ if (this.messageBuffer.size === 0) {
+ this.clearIntervalFlushMessageBuffer()
+ }
+ }, Constants.DEFAULT_MESSAGE_BUFFER_FLUSH_INTERVAL)
}
- return ocppConfiguration
}
- private async onOpen (): Promise<void> {
- if (this.isWebSocketConnectionOpened()) {
+ private async startMessageSequence (ATGStopAbsoluteDuration?: boolean): Promise<void> {
+ if (this.stationInfo?.autoRegister === true) {
+ await this.ocppRequestService.requestHandler<
+ BootNotificationRequest,
+ BootNotificationResponse
+ >(this, RequestCommand.BOOT_NOTIFICATION, this.bootNotificationRequest, {
+ skipBufferingOnError: true,
+ })
+ }
+ // Start WebSocket ping
+ if (this.wsPingSetInterval == null) {
+ this.startWebSocketPing()
+ }
+ // Start heartbeat
+ if (this.heartbeatSetInterval == null) {
+ this.startHeartbeat()
+ }
+ // Initialize connectors status
+ if (this.hasEvses) {
+ for (const [evseId, evseStatus] of this.evses) {
+ if (evseId > 0) {
+ for (const [connectorId, connectorStatus] of evseStatus.connectors) {
+ await sendAndSetConnectorStatus(
+ this,
+ connectorId,
+ getBootConnectorStatus(this, connectorId, connectorStatus),
+ evseId
+ )
+ }
+ }
+ }
+ } else {
+ for (const connectorId of this.connectors.keys()) {
+ if (connectorId > 0) {
+ await sendAndSetConnectorStatus(
+ this,
+ connectorId,
+ getBootConnectorStatus(
+ this,
+ connectorId,
+ // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+ this.getConnectorStatus(connectorId)!
+ )
+ )
+ }
+ }
+ }
+ if (this.stationInfo?.firmwareStatus === FirmwareStatus.Installing) {
+ await this.ocppRequestService.requestHandler<
+ FirmwareStatusNotificationRequest,
+ FirmwareStatusNotificationResponse
+ >(this, RequestCommand.FIRMWARE_STATUS_NOTIFICATION, {
+ status: FirmwareStatus.Installed,
+ })
+ this.stationInfo.firmwareStatus = FirmwareStatus.Installed
+ }
+
+ // Start the ATG
+ if (this.getAutomaticTransactionGeneratorConfiguration()?.enable === true) {
+ this.startAutomaticTransactionGenerator(undefined, ATGStopAbsoluteDuration)
+ }
+ this.flushMessageBuffer()
+ }
+
+ private startWebSocketPing (): void {
+ const webSocketPingInterval = this.getWebSocketPingInterval()
+ if (webSocketPingInterval > 0 && this.wsPingSetInterval == null) {
+ this.wsPingSetInterval = setInterval(() => {
+ if (this.isWebSocketConnectionOpened()) {
+ this.wsConnection?.ping()
+ }
+ }, secondsToMilliseconds(webSocketPingInterval))
logger.info(
- `${this.logPrefix()} Connection to OCPP server through ${this.wsConnectionUrl.href} succeeded`
+ `${this.logPrefix()} WebSocket ping started every ${formatDurationSeconds(
+ webSocketPingInterval
+ )}`
)
- let registrationRetryCount = 0
- if (!this.isRegistered()) {
- // Send BootNotification
- do {
- this.bootNotificationResponse = await this.ocppRequestService.requestHandler<
- BootNotificationRequest,
- BootNotificationResponse
- >(this, RequestCommand.BOOT_NOTIFICATION, this.bootNotificationRequest, {
- skipBufferingOnError: true
- })
- // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
- if (this.bootNotificationResponse?.currentTime != null) {
- // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
- this.bootNotificationResponse.currentTime = convertToDate(
- this.bootNotificationResponse.currentTime
- )!
- }
- if (!this.isRegistered()) {
- this.stationInfo?.registrationMaxRetries !== -1 && ++registrationRetryCount
- await sleep(
- // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
- this.bootNotificationResponse?.interval != null
- ? secondsToMilliseconds(this.bootNotificationResponse.interval)
- : Constants.DEFAULT_BOOT_NOTIFICATION_INTERVAL
+ } else if (this.wsPingSetInterval != null) {
+ logger.info(
+ `${this.logPrefix()} WebSocket ping already started every ${formatDurationSeconds(
+ webSocketPingInterval
+ )}`
+ )
+ } else {
+ logger.error(
+ `${this.logPrefix()} WebSocket ping interval set to ${webSocketPingInterval.toString()}, not starting the WebSocket ping`
+ )
+ }
+ }
+
+ private stopHeartbeat (): void {
+ if (this.heartbeatSetInterval != null) {
+ clearInterval(this.heartbeatSetInterval)
+ delete this.heartbeatSetInterval
+ }
+ }
+
+ private async stopMessageSequence (
+ reason?: StopTransactionReason,
+ stopTransactions?: boolean
+ ): Promise<void> {
+ this.internalStopMessageSequence()
+ // Stop ongoing transactions
+ stopTransactions && (await this.stopRunningTransactions(reason))
+ if (this.hasEvses) {
+ for (const [evseId, evseStatus] of this.evses) {
+ if (evseId > 0) {
+ for (const [connectorId, connectorStatus] of evseStatus.connectors) {
+ await sendAndSetConnectorStatus(
+ this,
+ connectorId,
+ ConnectorStatusEnum.Unavailable,
+ evseId
)
+ delete connectorStatus.status
}
- } while (
- !this.isRegistered() &&
- // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
- (registrationRetryCount <= this.stationInfo!.registrationMaxRetries! ||
- this.stationInfo?.registrationMaxRetries === -1)
- )
+ }
+ }
+ } else {
+ for (const connectorId of this.connectors.keys()) {
+ if (connectorId > 0) {
+ await sendAndSetConnectorStatus(this, connectorId, ConnectorStatusEnum.Unavailable)
+ delete this.getConnectorStatus(connectorId)?.status
+ }
}
- if (this.isRegistered()) {
- this.emit(ChargingStationEvents.registered)
- if (this.inAcceptedState()) {
- this.emit(ChargingStationEvents.accepted)
+ }
+ }
+
+ private async stopRunningTransactions (reason?: StopTransactionReason): Promise<void> {
+ if (this.hasEvses) {
+ for (const [evseId, evseStatus] of this.evses) {
+ if (evseId === 0) {
+ continue
}
- } else {
- if (this.inRejectedState()) {
- this.emit(ChargingStationEvents.rejected)
+ for (const [connectorId, connectorStatus] of evseStatus.connectors) {
+ if (connectorStatus.transactionStarted === true) {
+ await this.stopTransactionOnConnector(connectorId, reason)
+ }
}
- logger.error(
- `${this.logPrefix()} Registration failure: maximum retries reached (${registrationRetryCount}) or retry disabled (${
- this.stationInfo?.registrationMaxRetries
- })`
- )
}
- this.wsConnectionRetryCount = 0
- this.emit(ChargingStationEvents.updated)
} else {
- logger.warn(
- `${this.logPrefix()} Connection to OCPP server through ${this.wsConnectionUrl.href} failed`
- )
+ for (const connectorId of this.connectors.keys()) {
+ if (connectorId > 0 && this.getConnectorStatus(connectorId)?.transactionStarted === true) {
+ await this.stopTransactionOnConnector(connectorId, reason)
+ }
+ }
}
}
- private onClose (code: WebSocketCloseEventStatusCode, reason: Buffer): void {
- this.emit(ChargingStationEvents.disconnected)
- switch (code) {
- // Normal close
- case WebSocketCloseEventStatusCode.CLOSE_NORMAL:
- case WebSocketCloseEventStatusCode.CLOSE_NO_STATUS:
- logger.info(
- `${this.logPrefix()} WebSocket normally closed with status '${getWebSocketCloseEventStatusString(
- code
- )}' and reason '${reason.toString()}'`
- )
- this.wsConnectionRetryCount = 0
- break
- // Abnormal close
- default:
- logger.error(
- `${this.logPrefix()} WebSocket abnormally closed with status '${getWebSocketCloseEventStatusString(
- code
- )}' and reason '${reason.toString()}'`
- )
- this.started &&
- this.reconnect().catch(error =>
- logger.error(`${this.logPrefix()} Error while reconnecting:`, error)
- )
- break
+ private stopWebSocketPing (): void {
+ if (this.wsPingSetInterval != null) {
+ clearInterval(this.wsPingSetInterval)
+ delete this.wsPingSetInterval
}
- this.emit(ChargingStationEvents.updated)
}
- private getCachedRequest (
- messageType: MessageType | undefined,
- messageId: string
- ): CachedRequest | undefined {
- const cachedRequest = this.requests.get(messageId)
- if (Array.isArray(cachedRequest)) {
- return cachedRequest
+ private terminateWSConnection (): void {
+ if (this.isWebSocketConnectionOpened()) {
+ this.wsConnection?.terminate()
+ this.wsConnection = null
}
- throw new OCPPError(
- ErrorType.PROTOCOL_ERROR,
- `Cached request for message id ${messageId} ${getMessageTypeString(
- messageType
- )} is not an array`,
- undefined,
- cachedRequest
- )
}
- private async handleIncomingMessage (request: IncomingRequest): Promise<void> {
- const [messageType, messageId, commandName, commandPayload] = request
- if (this.stationInfo?.enableStatistics === true) {
- this.performanceStatistics?.addRequestStatistic(commandName, messageType)
+ public async addReservation (reservation: Reservation): Promise<void> {
+ const reservationFound = this.getReservationBy('reservationId', reservation.reservationId)
+ if (reservationFound != null) {
+ await this.removeReservation(reservationFound, ReservationTerminationReason.REPLACE_EXISTING)
}
- logger.debug(
- `${this.logPrefix()} << Command '${commandName}' received request payload: ${JSON.stringify(
- request
- )}`
- )
- // Process the message
- await this.ocppIncomingRequestService.incomingRequestHandler(
+ // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+ this.getConnectorStatus(reservation.connectorId)!.reservation = reservation
+ await sendAndSetConnectorStatus(
this,
- messageId,
- commandName,
- commandPayload
+ reservation.connectorId,
+ ConnectorStatusEnum.Reserved,
+ undefined,
+ { send: reservation.connectorId !== 0 }
)
- this.emit(ChargingStationEvents.updated)
}
- private handleResponseMessage (response: Response): void {
- const [messageType, messageId, commandPayload] = response
- if (!this.requests.has(messageId)) {
- // Error
- throw new OCPPError(
- ErrorType.INTERNAL_ERROR,
- `Response for unknown message id ${messageId}`,
- undefined,
- commandPayload
- )
+ public bufferMessage (message: string): void {
+ this.messageBuffer.add(message)
+ this.setIntervalFlushMessageBuffer()
+ }
+
+ public closeWSConnection (): void {
+ if (this.isWebSocketConnectionOpened()) {
+ this.wsConnection?.close()
+ this.wsConnection = null
}
- // Respond
- // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
- const [responseCallback, , requestCommandName, requestPayload] = this.getCachedRequest(
- messageType,
- messageId
- )!
- logger.debug(
- `${this.logPrefix()} << Command '${requestCommandName}' received response payload: ${JSON.stringify(
- response
- )}`
- )
- responseCallback(commandPayload, requestPayload)
}
- private handleErrorMessage (errorResponse: ErrorResponse): void {
- const [messageType, messageId, errorType, errorMessage, errorDetails] = errorResponse
- if (!this.requests.has(messageId)) {
- // Error
- throw new OCPPError(
- ErrorType.INTERNAL_ERROR,
- `Error response for unknown message id ${messageId}`,
- undefined,
- { errorType, errorMessage, errorDetails }
- )
+ public async delete (deleteConfiguration = true): Promise<void> {
+ if (this.started) {
+ await this.stop()
}
+ AutomaticTransactionGenerator.deleteInstance(this)
+ PerformanceStatistics.deleteInstance(this.stationInfo?.hashId)
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
- const [, errorCallback, requestCommandName] = this.getCachedRequest(messageType, messageId)!
- logger.debug(
- `${this.logPrefix()} << Command '${requestCommandName}' received error response payload: ${JSON.stringify(
- errorResponse
- )}`
+ this.idTagsCache.deleteIdTags(getIdTagsFile(this.stationInfo!)!)
+ this.requests.clear()
+ this.connectors.clear()
+ this.evses.clear()
+ this.templateFileWatcher?.unref()
+ deleteConfiguration && rmSync(this.configurationFile, { force: true })
+ this.chargingStationWorkerBroadcastChannel.unref()
+ this.emit(ChargingStationEvents.deleted)
+ this.removeAllListeners()
+ }
+
+ public getAuthorizeRemoteTxRequests (): boolean {
+ const authorizeRemoteTxRequests = getConfigurationKey(
+ this,
+ StandardParametersKey.AuthorizeRemoteTxRequests
)
- errorCallback(new OCPPError(errorType, errorMessage, requestCommandName, errorDetails))
+ return authorizeRemoteTxRequests != null
+ ? convertToBoolean(authorizeRemoteTxRequests.value)
+ : false
}
- private async onMessage (data: RawData): Promise<void> {
- let request: IncomingRequest | Response | ErrorResponse | undefined
- let messageType: MessageType | undefined
- let errorMsg: string
- try {
- // eslint-disable-next-line @typescript-eslint/no-base-to-string
- request = JSON.parse(data.toString()) as IncomingRequest | Response | ErrorResponse
- if (Array.isArray(request)) {
- [messageType] = request
- // Check the type of message
- switch (messageType) {
- // Incoming Message
- case MessageType.CALL_MESSAGE:
- await this.handleIncomingMessage(request as IncomingRequest)
- break
- // Response Message
- case MessageType.CALL_RESULT_MESSAGE:
- this.handleResponseMessage(request as Response)
- break
- // Error Message
- case MessageType.CALL_ERROR_MESSAGE:
- this.handleErrorMessage(request as ErrorResponse)
- break
- // Unknown Message
- default:
- // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
- errorMsg = `Wrong message type ${messageType}`
- logger.error(`${this.logPrefix()} ${errorMsg}`)
- throw new OCPPError(ErrorType.PROTOCOL_ERROR, errorMsg)
- }
+ public getAutomaticTransactionGeneratorConfiguration ():
+ | AutomaticTransactionGeneratorConfiguration
+ | undefined {
+ if (this.automaticTransactionGeneratorConfiguration == null) {
+ let automaticTransactionGeneratorConfiguration:
+ | AutomaticTransactionGeneratorConfiguration
+ | undefined
+ const stationTemplate = this.getTemplateFromFile()
+ const stationConfiguration = this.getConfigurationFromFile()
+ if (
+ this.stationInfo?.automaticTransactionGeneratorPersistentConfiguration === true &&
+ stationConfiguration?.stationInfo?.templateHash === stationTemplate?.templateHash &&
+ stationConfiguration?.automaticTransactionGenerator != null
+ ) {
+ automaticTransactionGeneratorConfiguration =
+ stationConfiguration.automaticTransactionGenerator
} else {
- throw new OCPPError(
- ErrorType.PROTOCOL_ERROR,
- 'Incoming message is not an array',
- undefined,
- {
- request
- }
- )
+ automaticTransactionGeneratorConfiguration = stationTemplate?.AutomaticTransactionGenerator
}
- } catch (error) {
- if (!Array.isArray(request)) {
- logger.error(`${this.logPrefix()} Incoming message '${request}' parsing error:`, error)
- return
+ this.automaticTransactionGeneratorConfiguration = {
+ ...Constants.DEFAULT_ATG_CONFIGURATION,
+ ...automaticTransactionGeneratorConfiguration,
}
- let commandName: IncomingRequestCommand | undefined
- let requestCommandName: RequestCommand | IncomingRequestCommand | undefined
- let errorCallback: ErrorCallback
- const [, messageId] = request
- switch (messageType) {
- case MessageType.CALL_MESSAGE:
- [, , commandName] = request as IncomingRequest
- // Send error
- await this.ocppRequestService.sendError(this, messageId, error as OCPPError, commandName)
- break
- case MessageType.CALL_RESULT_MESSAGE:
- case MessageType.CALL_ERROR_MESSAGE:
- if (this.requests.has(messageId)) {
- // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
- [, errorCallback, requestCommandName] = this.getCachedRequest(messageType, messageId)!
- // Reject the deferred promise in case of error at response handling (rejecting an already fulfilled promise is a no-op)
- errorCallback(error as OCPPError, false)
- } else {
- // Remove the request from the cache in case of error at response handling
- this.requests.delete(messageId)
+ }
+ return this.automaticTransactionGeneratorConfiguration
+ }
+
+ public getAutomaticTransactionGeneratorStatuses (): Status[] | undefined {
+ return this.getConfigurationFromFile()?.automaticTransactionGeneratorStatuses
+ }
+
+ public getConnectorIdByTransactionId (transactionId: number | undefined): number | undefined {
+ if (transactionId == null) {
+ return undefined
+ } else if (this.hasEvses) {
+ for (const evseStatus of this.evses.values()) {
+ for (const [connectorId, connectorStatus] of evseStatus.connectors) {
+ if (connectorStatus.transactionId === transactionId) {
+ return connectorId
}
- break
- }
- if (!(error instanceof OCPPError)) {
- logger.warn(
- `${this.logPrefix()} Error thrown at incoming OCPP command '${
- commandName ?? requestCommandName ?? Constants.UNKNOWN_OCPP_COMMAND
- // eslint-disable-next-line @typescript-eslint/no-base-to-string
- }' message '${data.toString()}' handling is not an OCPPError:`,
- error
- )
+ }
+ }
+ } else {
+ for (const connectorId of this.connectors.keys()) {
+ if (this.getConnectorStatus(connectorId)?.transactionId === transactionId) {
+ return connectorId
+ }
}
- logger.error(
- `${this.logPrefix()} Incoming OCPP command '${
- commandName ?? requestCommandName ?? Constants.UNKNOWN_OCPP_COMMAND
- // eslint-disable-next-line @typescript-eslint/no-base-to-string
- }' message '${data.toString()}'${
- this.requests.has(messageId)
- ? ` matching cached request '${JSON.stringify(this.getCachedRequest(messageType, messageId))}'`
- : ''
- } processing error:`,
- error
- )
}
}
- private onPing (): void {
- logger.debug(`${this.logPrefix()} Received a WS ping (rfc6455) from the server`)
+ public getConnectorMaximumAvailablePower (connectorId: number): number {
+ let connectorAmperageLimitationLimit: number | undefined
+ const amperageLimitation = this.getAmperageLimitation()
+ if (
+ amperageLimitation != null &&
+ // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+ amperageLimitation < this.stationInfo!.maximumAmperage!
+ ) {
+ connectorAmperageLimitationLimit =
+ (this.stationInfo?.currentOutType === CurrentType.AC
+ ? ACElectricUtils.powerTotal(
+ this.getNumberOfPhases(),
+ // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+ this.stationInfo.voltageOut!,
+ amperageLimitation *
+ (this.hasEvses ? this.getNumberOfEvses() : this.getNumberOfConnectors())
+ )
+ : // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+ DCElectricUtils.power(this.stationInfo!.voltageOut!, amperageLimitation)) /
+ // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+ this.powerDivider!
+ }
+ // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+ const connectorMaximumPower = this.stationInfo!.maximumPower! / this.powerDivider!
+ const chargingStationChargingProfilesLimit =
+ // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+ getChargingStationChargingProfilesLimit(this)! / this.powerDivider!
+ const connectorChargingProfilesLimit = getConnectorChargingProfilesLimit(this, connectorId)
+ return min(
+ isNaN(connectorMaximumPower) ? Number.POSITIVE_INFINITY : connectorMaximumPower,
+ // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+ isNaN(connectorAmperageLimitationLimit!)
+ ? Number.POSITIVE_INFINITY
+ : // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+ connectorAmperageLimitationLimit!,
+ isNaN(chargingStationChargingProfilesLimit)
+ ? Number.POSITIVE_INFINITY
+ : chargingStationChargingProfilesLimit,
+ // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+ isNaN(connectorChargingProfilesLimit!)
+ ? Number.POSITIVE_INFINITY
+ : // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+ connectorChargingProfilesLimit!
+ )
}
- private onPong (): void {
- logger.debug(`${this.logPrefix()} Received a WS pong (rfc6455) from the server`)
+ public getConnectorStatus (connectorId: number): ConnectorStatus | undefined {
+ if (this.hasEvses) {
+ for (const evseStatus of this.evses.values()) {
+ if (evseStatus.connectors.has(connectorId)) {
+ return evseStatus.connectors.get(connectorId)
+ }
+ }
+ return undefined
+ }
+ return this.connectors.get(connectorId)
}
- private onError (error: WSError): void {
- this.closeWSConnection()
- logger.error(`${this.logPrefix()} WebSocket error:`, error)
+ public getEnergyActiveImportRegisterByConnectorId (connectorId: number, rounded = false): number {
+ return this.getEnergyActiveImportRegister(this.getConnectorStatus(connectorId), rounded)
}
- private getEnergyActiveImportRegister (
- connectorStatus: ConnectorStatus | undefined,
+ public getEnergyActiveImportRegisterByTransactionId (
+ transactionId: number | undefined,
rounded = false
): number {
- if (this.stationInfo?.meteringPerTransaction === true) {
- return (
- (rounded
- ? connectorStatus?.transactionEnergyActiveImportRegisterValue != null
- ? Math.round(connectorStatus.transactionEnergyActiveImportRegisterValue)
- : undefined
- : connectorStatus?.transactionEnergyActiveImportRegisterValue) ?? 0
- )
+ return this.getEnergyActiveImportRegister(
+ // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+ this.getConnectorStatus(this.getConnectorIdByTransactionId(transactionId)!),
+ rounded
+ )
+ }
+
+ public getHeartbeatInterval (): number {
+ const HeartbeatInterval = getConfigurationKey(this, StandardParametersKey.HeartbeatInterval)
+ if (HeartbeatInterval != null) {
+ return secondsToMilliseconds(convertToInt(HeartbeatInterval.value))
}
- return (
- (rounded
- ? connectorStatus?.energyActiveImportRegisterValue != null
- ? Math.round(connectorStatus.energyActiveImportRegisterValue)
- : undefined
- : connectorStatus?.energyActiveImportRegisterValue) ?? 0
+ const HeartBeatInterval = getConfigurationKey(this, StandardParametersKey.HeartBeatInterval)
+ if (HeartBeatInterval != null) {
+ return secondsToMilliseconds(convertToInt(HeartBeatInterval.value))
+ }
+ this.stationInfo?.autoRegister === false &&
+ logger.warn(
+ `${this.logPrefix()} Heartbeat interval configuration key not set, using default value: ${Constants.DEFAULT_HEARTBEAT_INTERVAL.toString()}`
+ )
+ return Constants.DEFAULT_HEARTBEAT_INTERVAL
+ }
+
+ public getLocalAuthListEnabled (): boolean {
+ const localAuthListEnabled = getConfigurationKey(
+ this,
+ StandardParametersKey.LocalAuthListEnabled
)
+ return localAuthListEnabled != null ? convertToBoolean(localAuthListEnabled.value) : false
}
- private getUseConnectorId0 (stationTemplate?: ChargingStationTemplate): boolean {
+ public getNumberOfConnectors (): number {
+ if (this.hasEvses) {
+ let numberOfConnectors = 0
+ for (const [evseId, evseStatus] of this.evses) {
+ if (evseId > 0) {
+ numberOfConnectors += evseStatus.connectors.size
+ }
+ }
+ return numberOfConnectors
+ }
+ return this.connectors.has(0) ? this.connectors.size - 1 : this.connectors.size
+ }
+
+ public getNumberOfEvses (): number {
+ return this.evses.has(0) ? this.evses.size - 1 : this.evses.size
+ }
+
+ public getNumberOfPhases (stationInfo?: ChargingStationInfo): number {
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
- return stationTemplate?.useConnectorId0 ?? Constants.DEFAULT_STATION_INFO.useConnectorId0!
+ const localStationInfo = stationInfo ?? this.stationInfo!
+ switch (this.getCurrentOutType(stationInfo)) {
+ case CurrentType.AC:
+ return localStationInfo.numberOfPhases ?? 3
+ case CurrentType.DC:
+ return 0
+ }
}
- private async stopRunningTransactions (reason?: StopTransactionReason): Promise<void> {
+ public getNumberOfRunningTransactions (): number {
+ let numberOfRunningTransactions = 0
if (this.hasEvses) {
for (const [evseId, evseStatus] of this.evses) {
if (evseId === 0) {
continue
}
- for (const [connectorId, connectorStatus] of evseStatus.connectors) {
+ for (const connectorStatus of evseStatus.connectors.values()) {
if (connectorStatus.transactionStarted === true) {
- await this.stopTransactionOnConnector(connectorId, reason)
+ ++numberOfRunningTransactions
}
}
}
} else {
for (const connectorId of this.connectors.keys()) {
if (connectorId > 0 && this.getConnectorStatus(connectorId)?.transactionStarted === true) {
- await this.stopTransactionOnConnector(connectorId, reason)
+ ++numberOfRunningTransactions
+ }
+ }
+ }
+ return numberOfRunningTransactions
+ }
+
+ public getReservationBy (
+ filterKey: ReservationKey,
+ value: number | string
+ ): Reservation | undefined {
+ if (this.hasEvses) {
+ for (const evseStatus of this.evses.values()) {
+ for (const connectorStatus of evseStatus.connectors.values()) {
+ if (connectorStatus.reservation?.[filterKey] === value) {
+ return connectorStatus.reservation
+ }
+ }
+ }
+ } else {
+ for (const connectorStatus of this.connectors.values()) {
+ if (connectorStatus.reservation?.[filterKey] === value) {
+ return connectorStatus.reservation
+ }
+ }
+ }
+ }
+
+ public getReserveConnectorZeroSupported (): boolean {
+ return convertToBoolean(
+ // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+ getConfigurationKey(this, StandardParametersKey.ReserveConnectorZeroSupported)!.value
+ )
+ }
+
+ public getTransactionIdTag (transactionId: number): string | undefined {
+ if (this.hasEvses) {
+ for (const evseStatus of this.evses.values()) {
+ for (const connectorStatus of evseStatus.connectors.values()) {
+ if (connectorStatus.transactionId === transactionId) {
+ return connectorStatus.transactionIdTag
+ }
+ }
+ }
+ } else {
+ for (const connectorId of this.connectors.keys()) {
+ if (this.getConnectorStatus(connectorId)?.transactionId === transactionId) {
+ return this.getConnectorStatus(connectorId)?.transactionIdTag
+ }
+ }
+ }
+ }
+
+ public hasConnector (connectorId: number): boolean {
+ if (this.hasEvses) {
+ for (const evseStatus of this.evses.values()) {
+ if (evseStatus.connectors.has(connectorId)) {
+ return true
}
}
+ return false
+ }
+ return this.connectors.has(connectorId)
+ }
+
+ public hasIdTags (): boolean {
+ // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+ return isNotEmptyArray(this.idTagsCache.getIdTags(getIdTagsFile(this.stationInfo!)!))
+ }
+
+ public inAcceptedState (): boolean {
+ return this.bootNotificationResponse?.status === RegistrationStatusEnumType.ACCEPTED
+ }
+
+ public inPendingState (): boolean {
+ return this.bootNotificationResponse?.status === RegistrationStatusEnumType.PENDING
+ }
+
+ public inRejectedState (): boolean {
+ return this.bootNotificationResponse?.status === RegistrationStatusEnumType.REJECTED
+ }
+
+ public inUnknownState (): boolean {
+ return this.bootNotificationResponse?.status == null
+ }
+
+ public isChargingStationAvailable (): boolean {
+ return this.getConnectorStatus(0)?.availability === AvailabilityType.Operative
+ }
+
+ public isConnectorAvailable (connectorId: number): boolean {
+ return (
+ connectorId > 0 &&
+ this.getConnectorStatus(connectorId)?.availability === AvailabilityType.Operative
+ )
+ }
+
+ public isConnectorReservable (
+ reservationId: number,
+ idTag?: string,
+ connectorId?: number
+ ): boolean {
+ const reservation = this.getReservationBy('reservationId', reservationId)
+ const reservationExists = reservation != null && !hasReservationExpired(reservation)
+ if (arguments.length === 1) {
+ return !reservationExists
+ } else if (arguments.length > 1) {
+ const userReservation = idTag != null ? this.getReservationBy('idTag', idTag) : undefined
+ const userReservationExists =
+ userReservation != null && !hasReservationExpired(userReservation)
+ const notConnectorZero = connectorId == null ? true : connectorId > 0
+ const freeConnectorsAvailable = this.getNumberOfReservableConnectors() > 0
+ return (
+ !reservationExists && !userReservationExists && notConnectorZero && freeConnectorsAvailable
+ )
}
+ return false
}
- // 0 for disabling
- private getConnectionTimeout (): number {
- if (getConfigurationKey(this, StandardParametersKey.ConnectionTimeOut) != null) {
- return convertToInt(
- getConfigurationKey(this, StandardParametersKey.ConnectionTimeOut)?.value ??
- Constants.DEFAULT_CONNECTION_TIMEOUT
- )
- }
- return Constants.DEFAULT_CONNECTION_TIMEOUT
+ public isRegistered (): boolean {
+ return !this.inUnknownState() && (this.inAcceptedState() || this.inPendingState())
}
- private getPowerDivider (): number {
- let powerDivider = this.hasEvses ? this.getNumberOfEvses() : this.getNumberOfConnectors()
- if (this.stationInfo?.powerSharedByConnectors === true) {
- powerDivider = this.getNumberOfRunningTransactions()
+ public isWebSocketConnectionOpened (): boolean {
+ return this.wsConnection?.readyState === WebSocket.OPEN
+ }
+
+ public openWSConnection (
+ options?: WsOptions,
+ params?: { closeOpened?: boolean; terminateOpened?: boolean }
+ ): void {
+ options = {
+ handshakeTimeout: secondsToMilliseconds(this.getConnectionTimeout()),
+ ...this.stationInfo?.wsOptions,
+ ...options,
}
- return powerDivider
+ params = { ...{ closeOpened: false, terminateOpened: false }, ...params }
+ if (!checkChargingStationState(this, this.logPrefix())) {
+ return
+ }
+ if (this.stationInfo?.supervisionUser != null && this.stationInfo.supervisionPassword != null) {
+ options.auth = `${this.stationInfo.supervisionUser}:${this.stationInfo.supervisionPassword}`
+ }
+ if (params.closeOpened) {
+ this.closeWSConnection()
+ }
+ if (params.terminateOpened) {
+ this.terminateWSConnection()
+ }
+
+ if (this.isWebSocketConnectionOpened()) {
+ logger.warn(
+ `${this.logPrefix()} OCPP connection to URL ${this.wsConnectionUrl.href} is already opened`
+ )
+ return
+ }
+
+ logger.info(`${this.logPrefix()} Open OCPP connection to URL ${this.wsConnectionUrl.href}`)
+
+ this.wsConnection = new WebSocket(
+ this.wsConnectionUrl,
+ // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
+ `ocpp${this.stationInfo?.ocppVersion}`,
+ options
+ )
+
+ // Handle WebSocket message
+ this.wsConnection.on('message', data => {
+ this.onMessage(data).catch(Constants.EMPTY_FUNCTION)
+ })
+ // Handle WebSocket error
+ this.wsConnection.on('error', this.onError.bind(this))
+ // Handle WebSocket close
+ this.wsConnection.on('close', this.onClose.bind(this))
+ // Handle WebSocket open
+ this.wsConnection.on('open', () => {
+ this.onOpen().catch((error: unknown) =>
+ logger.error(`${this.logPrefix()} Error while opening WebSocket connection:`, error)
+ )
+ })
+ // Handle WebSocket ping
+ this.wsConnection.on('ping', this.onPing.bind(this))
+ // Handle WebSocket pong
+ this.wsConnection.on('pong', this.onPong.bind(this))
}
- private getMaximumAmperage (stationInfo?: ChargingStationInfo): number | undefined {
+ public async removeReservation (
+ reservation: Reservation,
+ reason: ReservationTerminationReason
+ ): Promise<void> {
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
- const maximumPower = (stationInfo ?? this.stationInfo!).maximumPower!
- switch (this.getCurrentOutType(stationInfo)) {
- case CurrentType.AC:
- return ACElectricUtils.amperagePerPhaseFromPower(
- this.getNumberOfPhases(stationInfo),
- maximumPower / (this.hasEvses ? this.getNumberOfEvses() : this.getNumberOfConnectors()),
- this.getVoltageOut(stationInfo)
+ const connector = this.getConnectorStatus(reservation.connectorId)!
+ switch (reason) {
+ case ReservationTerminationReason.CONNECTOR_STATE_CHANGED:
+ case ReservationTerminationReason.TRANSACTION_STARTED:
+ delete connector.reservation
+ break
+ case ReservationTerminationReason.EXPIRED:
+ case ReservationTerminationReason.REPLACE_EXISTING:
+ case ReservationTerminationReason.RESERVATION_CANCELED:
+ await sendAndSetConnectorStatus(
+ this,
+ reservation.connectorId,
+ ConnectorStatusEnum.Available,
+ undefined,
+ { send: reservation.connectorId !== 0 }
)
- case CurrentType.DC:
- return DCElectricUtils.amperage(maximumPower, this.getVoltageOut(stationInfo))
+ delete connector.reservation
+ break
+ default:
+ // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
+ throw new BaseError(`Unknown reservation termination reason '${reason}'`)
}
}
- private getCurrentOutType (stationInfo?: ChargingStationInfo): CurrentType {
- return (
- // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
- (stationInfo ?? this.stationInfo!).currentOutType ??
- // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
- Constants.DEFAULT_STATION_INFO.currentOutType!
- )
+ public async reset (reason?: StopTransactionReason): Promise<void> {
+ await this.stop(reason)
+ // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+ await sleep(this.stationInfo!.resetTime!)
+ this.initialize()
+ this.start()
}
- private getVoltageOut (stationInfo?: ChargingStationInfo): Voltage {
- return (
- // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
- (stationInfo ?? this.stationInfo!).voltageOut ??
- getDefaultVoltageOut(this.getCurrentOutType(stationInfo), this.logPrefix(), this.templateFile)
- )
+ public restartHeartbeat (): void {
+ // Stop heartbeat
+ this.stopHeartbeat()
+ // Start heartbeat
+ this.startHeartbeat()
}
- private getAmperageLimitation (): number | undefined {
- if (
- isNotEmptyString(this.stationInfo?.amperageLimitationOcppKey) &&
- getConfigurationKey(this, this.stationInfo.amperageLimitationOcppKey) != null
- ) {
- return (
- convertToInt(getConfigurationKey(this, this.stationInfo.amperageLimitationOcppKey)?.value) /
- getAmperageLimitationUnitDivider(this.stationInfo)
- )
- }
+ public restartMeterValues (connectorId: number, interval: number): void {
+ this.stopMeterValues(connectorId)
+ this.startMeterValues(connectorId, interval)
}
- private async startMessageSequence (ATGStopAbsoluteDuration?: boolean): Promise<void> {
- if (this.stationInfo?.autoRegister === true) {
- await this.ocppRequestService.requestHandler<
- BootNotificationRequest,
- BootNotificationResponse
- >(this, RequestCommand.BOOT_NOTIFICATION, this.bootNotificationRequest, {
- skipBufferingOnError: true
- })
- }
+ public restartWebSocketPing (): void {
+ // Stop WebSocket ping
+ this.stopWebSocketPing()
// Start WebSocket ping
this.startWebSocketPing()
- // Start heartbeat
- this.startHeartbeat()
- // Initialize connectors status
- if (this.hasEvses) {
- for (const [evseId, evseStatus] of this.evses) {
- if (evseId > 0) {
- for (const [connectorId, connectorStatus] of evseStatus.connectors) {
- const connectorBootStatus = getBootConnectorStatus(this, connectorId, connectorStatus)
- await sendAndSetConnectorStatus(this, connectorId, connectorBootStatus, evseId)
- }
- }
- }
- } else {
- for (const connectorId of this.connectors.keys()) {
- if (connectorId > 0) {
- const connectorBootStatus = getBootConnectorStatus(
- this,
- connectorId,
- // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
- this.getConnectorStatus(connectorId)!
- )
- await sendAndSetConnectorStatus(this, connectorId, connectorBootStatus)
- }
- }
- }
- if (this.stationInfo?.firmwareStatus === FirmwareStatus.Installing) {
- await this.ocppRequestService.requestHandler<
- FirmwareStatusNotificationRequest,
- FirmwareStatusNotificationResponse
- >(this, RequestCommand.FIRMWARE_STATUS_NOTIFICATION, {
- status: FirmwareStatus.Installed
- })
- this.stationInfo.firmwareStatus = FirmwareStatus.Installed
+ }
+
+ public saveOcppConfiguration (): void {
+ if (this.stationInfo?.ocppPersistentConfiguration === true) {
+ this.saveConfiguration()
}
+ }
- // Start the ATG
- if (this.getAutomaticTransactionGeneratorConfiguration()?.enable === true) {
- this.startAutomaticTransactionGenerator(undefined, ATGStopAbsoluteDuration)
+ public setSupervisionUrl (url: string): void {
+ if (
+ this.stationInfo?.supervisionUrlOcppConfiguration === true &&
+ isNotEmptyString(this.stationInfo.supervisionUrlOcppKey)
+ ) {
+ setConfigurationKeyValue(this, this.stationInfo.supervisionUrlOcppKey, url)
+ } else {
+ // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+ this.stationInfo!.supervisionUrls = url
+ this.configuredSupervisionUrl = this.getConfiguredSupervisionUrl()
+ this.saveStationInfo()
}
- this.flushMessageBuffer()
}
- private internalStopMessageSequence (): void {
- // Stop WebSocket ping
- this.stopWebSocketPing()
- // Stop heartbeat
- this.stopHeartbeat()
- // Stop the ATG
- if (this.automaticTransactionGenerator?.started === true) {
- this.stopAutomaticTransactionGenerator()
+ public start (): void {
+ if (!this.started) {
+ if (!this.starting) {
+ this.starting = true
+ if (this.stationInfo?.enableStatistics === true) {
+ this.performanceStatistics?.start()
+ }
+ this.openWSConnection()
+ // Monitor charging station template file
+ this.templateFileWatcher = watchJsonFile(
+ this.templateFile,
+ FileType.ChargingStationTemplate,
+ this.logPrefix(),
+ undefined,
+ (event, filename): void => {
+ if (isNotEmptyString(filename) && event === 'change') {
+ try {
+ logger.debug(
+ `${this.logPrefix()} ${FileType.ChargingStationTemplate} ${
+ this.templateFile
+ } file have changed, reload`
+ )
+ this.sharedLRUCache.deleteChargingStationTemplate(this.templateFileHash)
+ // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+ this.idTagsCache.deleteIdTags(getIdTagsFile(this.stationInfo!)!)
+ // Initialize
+ this.initialize()
+ // Restart the ATG
+ const ATGStarted = this.automaticTransactionGenerator?.started
+ if (ATGStarted === true) {
+ this.stopAutomaticTransactionGenerator()
+ }
+ delete this.automaticTransactionGeneratorConfiguration
+ if (
+ this.getAutomaticTransactionGeneratorConfiguration()?.enable === true &&
+ ATGStarted === true
+ ) {
+ this.startAutomaticTransactionGenerator(undefined, true)
+ }
+ if (this.stationInfo?.enableStatistics === true) {
+ this.performanceStatistics?.restart()
+ } else {
+ this.performanceStatistics?.stop()
+ }
+ // FIXME?: restart heartbeat and WebSocket ping when their interval values have changed
+ } catch (error) {
+ logger.error(
+ `${this.logPrefix()} ${FileType.ChargingStationTemplate} file monitoring error:`,
+ error
+ )
+ }
+ }
+ }
+ )
+ this.started = true
+ this.emit(ChargingStationEvents.started)
+ this.starting = false
+ } else {
+ logger.warn(`${this.logPrefix()} Charging station is already starting...`)
+ }
+ } else {
+ logger.warn(`${this.logPrefix()} Charging station is already started...`)
}
}
- private async stopMessageSequence (
- reason?: StopTransactionReason,
- stopTransactions?: boolean
- ): Promise<void> {
- this.internalStopMessageSequence()
- // Stop ongoing transactions
- stopTransactions === true && (await this.stopRunningTransactions(reason))
- if (this.hasEvses) {
- for (const [evseId, evseStatus] of this.evses) {
- if (evseId > 0) {
- for (const [connectorId, connectorStatus] of evseStatus.connectors) {
- await sendAndSetConnectorStatus(
- this,
- connectorId,
- ConnectorStatusEnum.Unavailable,
- evseId
- )
- delete connectorStatus.status
- }
- }
+ public startAutomaticTransactionGenerator (
+ connectorIds?: number[],
+ stopAbsoluteDuration?: boolean
+ ): void {
+ this.automaticTransactionGenerator = AutomaticTransactionGenerator.getInstance(this)
+ if (isNotEmptyArray(connectorIds)) {
+ for (const connectorId of connectorIds) {
+ this.automaticTransactionGenerator?.startConnector(connectorId, stopAbsoluteDuration)
}
} else {
- for (const connectorId of this.connectors.keys()) {
- if (connectorId > 0) {
- await sendAndSetConnectorStatus(this, connectorId, ConnectorStatusEnum.Unavailable)
- delete this.getConnectorStatus(connectorId)?.status
- }
- }
+ this.automaticTransactionGenerator?.start(stopAbsoluteDuration)
}
+ this.saveAutomaticTransactionGeneratorConfiguration()
+ this.emit(ChargingStationEvents.updated)
}
- private startWebSocketPing (): void {
- const webSocketPingInterval =
- getConfigurationKey(this, StandardParametersKey.WebSocketPingInterval) != null
- ? convertToInt(
- getConfigurationKey(this, StandardParametersKey.WebSocketPingInterval)?.value
- )
- : 0
- if (webSocketPingInterval > 0 && this.wsPingSetInterval == null) {
- this.wsPingSetInterval = setInterval(() => {
- if (this.isWebSocketConnectionOpened()) {
- this.wsConnection?.ping()
- }
- }, secondsToMilliseconds(webSocketPingInterval))
+ public startHeartbeat (): void {
+ const heartbeatInterval = this.getHeartbeatInterval()
+ if (heartbeatInterval > 0 && this.heartbeatSetInterval == null) {
+ this.heartbeatSetInterval = setInterval(() => {
+ this.ocppRequestService
+ .requestHandler<HeartbeatRequest, HeartbeatResponse>(this, RequestCommand.HEARTBEAT)
+ .catch((error: unknown) => {
+ logger.error(
+ `${this.logPrefix()} Error while sending '${RequestCommand.HEARTBEAT}':`,
+ error
+ )
+ })
+ }, heartbeatInterval)
logger.info(
- `${this.logPrefix()} WebSocket ping started every ${formatDurationSeconds(
- webSocketPingInterval
+ `${this.logPrefix()} Heartbeat started every ${formatDurationMilliSeconds(
+ heartbeatInterval
)}`
)
- } else if (this.wsPingSetInterval != null) {
+ } else if (this.heartbeatSetInterval != null) {
logger.info(
- `${this.logPrefix()} WebSocket ping already started every ${formatDurationSeconds(
- webSocketPingInterval
+ `${this.logPrefix()} Heartbeat already started every ${formatDurationMilliSeconds(
+ heartbeatInterval
)}`
)
} else {
logger.error(
- `${this.logPrefix()} WebSocket ping interval set to ${webSocketPingInterval}, not starting the WebSocket ping`
+ `${this.logPrefix()} Heartbeat interval set to ${heartbeatInterval.toString()}, not starting the heartbeat`
)
}
}
- private stopWebSocketPing (): void {
- if (this.wsPingSetInterval != null) {
- clearInterval(this.wsPingSetInterval)
- delete this.wsPingSetInterval
+ public startMeterValues (connectorId: number, interval: number): void {
+ if (connectorId === 0) {
+ logger.error(
+ `${this.logPrefix()} Trying to start MeterValues on connector id ${connectorId.toString()}`
+ )
+ return
}
- }
-
- private getConfiguredSupervisionUrl (): URL {
- let configuredSupervisionUrl: string
- const supervisionUrls = this.stationInfo?.supervisionUrls ?? Configuration.getSupervisionUrls()
- if (isNotEmptyArray(supervisionUrls)) {
- let configuredSupervisionUrlIndex: number
- switch (Configuration.getSupervisionUrlDistribution()) {
- case SupervisionUrlDistribution.RANDOM:
- configuredSupervisionUrlIndex = Math.floor(secureRandom() * supervisionUrls.length)
- break
- case SupervisionUrlDistribution.ROUND_ROBIN:
- case SupervisionUrlDistribution.CHARGING_STATION_AFFINITY:
- default:
- !Object.values(SupervisionUrlDistribution).includes(
- // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
- Configuration.getSupervisionUrlDistribution()!
- ) &&
+ const connectorStatus = this.getConnectorStatus(connectorId)
+ if (connectorStatus == null) {
+ logger.error(
+ `${this.logPrefix()} Trying to start MeterValues on non existing connector id
+ ${connectorId.toString()}`
+ )
+ return
+ }
+ if (connectorStatus.transactionStarted === false) {
+ logger.error(
+ `${this.logPrefix()} Trying to start MeterValues on connector id ${connectorId.toString()} with no transaction started`
+ )
+ return
+ } else if (
+ connectorStatus.transactionStarted === true &&
+ connectorStatus.transactionId == null
+ ) {
+ logger.error(
+ `${this.logPrefix()} Trying to start MeterValues on connector id ${connectorId.toString()} with no transaction id`
+ )
+ return
+ }
+ if (interval > 0) {
+ connectorStatus.transactionSetInterval = setInterval(() => {
+ const meterValue = buildMeterValue(
+ this,
+ connectorId,
+ // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+ connectorStatus.transactionId!,
+ interval
+ )
+ this.ocppRequestService
+ .requestHandler<MeterValuesRequest, MeterValuesResponse>(
+ this,
+ RequestCommand.METER_VALUES,
+ {
+ connectorId,
+ meterValue: [meterValue],
+ transactionId: connectorStatus.transactionId,
+ }
+ )
+ .catch((error: unknown) => {
logger.error(
- // eslint-disable-next-line @typescript-eslint/no-base-to-string
- `${this.logPrefix()} Unknown supervision url distribution '${Configuration.getSupervisionUrlDistribution()}' from values '${SupervisionUrlDistribution.toString()}', defaulting to ${
- SupervisionUrlDistribution.CHARGING_STATION_AFFINITY
- }`
+ `${this.logPrefix()} Error while sending '${RequestCommand.METER_VALUES}':`,
+ error
)
- configuredSupervisionUrlIndex = (this.index - 1) % supervisionUrls.length
- break
- }
- configuredSupervisionUrl = supervisionUrls[configuredSupervisionUrlIndex]
+ })
+ }, interval)
} else {
- // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
- configuredSupervisionUrl = supervisionUrls!
+ logger.error(
+ `${this.logPrefix()} Charging station ${
+ StandardParametersKey.MeterValueSampleInterval
+ } configuration set to ${interval.toString()}, not sending MeterValues`
+ )
}
- if (isNotEmptyString(configuredSupervisionUrl)) {
- return new URL(configuredSupervisionUrl)
+ }
+
+ public async stop (
+ reason?: StopTransactionReason,
+ stopTransactions = this.stationInfo?.stopTransactionsOnStopped
+ ): Promise<void> {
+ if (this.started) {
+ if (!this.stopping) {
+ this.stopping = true
+ await this.stopMessageSequence(reason, stopTransactions)
+ this.closeWSConnection()
+ if (this.stationInfo?.enableStatistics === true) {
+ this.performanceStatistics?.stop()
+ }
+ this.templateFileWatcher?.close()
+ delete this.bootNotificationResponse
+ this.started = false
+ this.saveConfiguration()
+ this.sharedLRUCache.deleteChargingStationConfiguration(this.configurationFileHash)
+ this.emit(ChargingStationEvents.stopped)
+ this.stopping = false
+ } else {
+ logger.warn(`${this.logPrefix()} Charging station is already stopping...`)
+ }
+ } else {
+ logger.warn(`${this.logPrefix()} Charging station is already stopped...`)
}
- const errorMsg = 'No supervision url(s) configured'
- logger.error(`${this.logPrefix()} ${errorMsg}`)
- throw new BaseError(errorMsg)
}
- private stopHeartbeat (): void {
- if (this.heartbeatSetInterval != null) {
- clearInterval(this.heartbeatSetInterval)
- delete this.heartbeatSetInterval
+ public stopAutomaticTransactionGenerator (connectorIds?: number[]): void {
+ if (isNotEmptyArray(connectorIds)) {
+ for (const connectorId of connectorIds) {
+ this.automaticTransactionGenerator?.stopConnector(connectorId)
+ }
+ } else {
+ this.automaticTransactionGenerator?.stop()
}
+ this.saveAutomaticTransactionGeneratorConfiguration()
+ this.emit(ChargingStationEvents.updated)
}
- private terminateWSConnection (): void {
- if (this.isWebSocketConnectionOpened()) {
- this.wsConnection?.terminate()
- this.wsConnection = null
+ public stopMeterValues (connectorId: number): void {
+ const connectorStatus = this.getConnectorStatus(connectorId)
+ if (connectorStatus?.transactionSetInterval != null) {
+ clearInterval(connectorStatus.transactionSetInterval)
}
}
- private async reconnect (): Promise<void> {
+ public async stopTransactionOnConnector (
+ connectorId: number,
+ reason?: StopTransactionReason
+ ): Promise<StopTransactionResponse> {
+ const transactionId = this.getConnectorStatus(connectorId)?.transactionId
if (
- // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
- this.wsConnectionRetryCount < this.stationInfo!.autoReconnectMaxRetries! ||
- this.stationInfo?.autoReconnectMaxRetries === -1
+ this.stationInfo?.beginEndMeterValues === true &&
+ this.stationInfo.ocppStrictCompliance === true &&
+ this.stationInfo.outOfOrderEndMeterValues === false
) {
- this.wsConnectionRetried = true
- ++this.wsConnectionRetryCount
- const reconnectDelay =
- this.stationInfo?.reconnectExponentialDelay === true
- ? exponentialDelay(this.wsConnectionRetryCount)
- : secondsToMilliseconds(this.getConnectionTimeout())
- const reconnectDelayWithdraw = 1000
- const reconnectTimeout =
- reconnectDelay - reconnectDelayWithdraw > 0 ? reconnectDelay - reconnectDelayWithdraw : 0
- logger.error(
- `${this.logPrefix()} WebSocket connection retry in ${roundTo(
- reconnectDelay,
- 2
- )}ms, timeout ${reconnectTimeout}ms`
- )
- await sleep(reconnectDelay)
- logger.error(
- `${this.logPrefix()} WebSocket connection retry #${this.wsConnectionRetryCount.toString()}`
+ const transactionEndMeterValue = buildTransactionEndMeterValue(
+ this,
+ connectorId,
+ this.getEnergyActiveImportRegisterByTransactionId(transactionId)
)
- this.openWSConnection(
+ await this.ocppRequestService.requestHandler<MeterValuesRequest, MeterValuesResponse>(
+ this,
+ RequestCommand.METER_VALUES,
{
- handshakeTimeout: reconnectTimeout
- },
- { closeOpened: true }
- )
- } else if (this.stationInfo?.autoReconnectMaxRetries !== -1) {
- logger.error(
- `${this.logPrefix()} WebSocket connection retries failure: maximum retries reached (${
- this.wsConnectionRetryCount
- }) or retries disabled (${this.stationInfo?.autoReconnectMaxRetries})`
+ connectorId,
+ meterValue: [transactionEndMeterValue],
+ transactionId,
+ }
)
}
+ return await this.ocppRequestService.requestHandler<
+ Partial<StopTransactionRequest>,
+ StopTransactionResponse
+ >(this, RequestCommand.STOP_TRANSACTION, {
+ meterStop: this.getEnergyActiveImportRegisterByTransactionId(transactionId, true),
+ transactionId,
+ ...(reason != null && { reason }),
+ })
+ }
+
+ public get hasEvses (): boolean {
+ return this.connectors.size === 0 && this.evses.size > 0
+ }
+
+ public get wsConnectionUrl (): URL {
+ const wsConnectionBaseUrlStr = `${
+ // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
+ this.stationInfo?.supervisionUrlOcppConfiguration === true &&
+ isNotEmptyString(this.stationInfo.supervisionUrlOcppKey) &&
+ isNotEmptyString(getConfigurationKey(this, this.stationInfo.supervisionUrlOcppKey)?.value)
+ ? getConfigurationKey(this, this.stationInfo.supervisionUrlOcppKey)?.value
+ : this.configuredSupervisionUrl.href
+ }`
+ return new URL(
+ `${wsConnectionBaseUrlStr}${
+ !wsConnectionBaseUrlStr.endsWith('/') ? '/' : ''
+ // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
+ }${this.stationInfo?.chargingStationId}`
+ )
}
}
repositories / e-mobility-charging-stations-simulator.git / blobdiff