// Partial Copyright Jerome Benoit. 2021-2024. All Rights Reserved.
-import { createHash } from 'node:crypto'
+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 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
} 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,
+ 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 {
+ 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
this.wsConnectionRetried
? true
: this.getAutomaticTransactionGeneratorConfiguration()?.stopAbsoluteDuration
- ).catch(error => {
+ ).catch((error: unknown) => {
logger.error(`${this.logPrefix()} Error while starting the message sequence:`, error)
})
this.wsConnectionRetried = false
readFileSync(this.templateFile, 'utf8')
) as ChargingStationTemplate
} catch {
- stationTemplate = undefined
+ // Ignore
}
return logPrefix(` ${getChargingStationId(this.index, stationTemplate)} |`)
}
return Constants.DEFAULT_HEARTBEAT_INTERVAL
}
- public setSupervisionUrls (urls: string | string[], saveStationInfo = true): void {
- // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
- this.stationInfo!.supervisionUrls = urls
- if (saveStationInfo) {
- this.saveStationInfo()
- }
- this.configuredSupervisionUrl = this.getConfiguredSupervisionUrl()
- }
-
public setSupervisionUrl (url: string): void {
if (
this.stationInfo?.supervisionUrlOcppConfiguration === true &&
) {
setConfigurationKeyValue(this, this.stationInfo.supervisionUrlOcppKey, url)
} else {
- this.setSupervisionUrls(url)
+ // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+ this.stationInfo!.supervisionUrls = url
+ this.configuredSupervisionUrl = this.getConfiguredSupervisionUrl()
+ this.saveStationInfo()
}
}
this.heartbeatSetInterval = setInterval(() => {
this.ocppRequestService
.requestHandler<HeartbeatRequest, HeartbeatResponse>(this, RequestCommand.HEARTBEAT)
- .catch(error => {
+ .catch((error: unknown) => {
logger.error(
`${this.logPrefix()} Error while sending '${RequestCommand.HEARTBEAT}':`,
error
meterValue: [meterValue]
}
)
- .catch(error => {
+ .catch((error: unknown) => {
logger.error(
`${this.logPrefix()} Error while sending '${RequestCommand.METER_VALUES}':`,
error
this.wsConnection.on('close', this.onClose.bind(this))
// Handle WebSocket open
this.wsConnection.on('open', () => {
- this.onOpen().catch(error =>
+ this.onOpen().catch((error: unknown) =>
logger.error(`${this.logPrefix()} Error while opening WebSocket connection:`, error)
)
})
)
}
return await this.ocppRequestService.requestHandler<
- StopTransactionRequest,
+ Partial<StopTransactionRequest>,
StopTransactionResponse
>(this, RequestCommand.STOP_TRANSACTION, {
transactionId,
// 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)
+ const warnTemplateKeysDeprecationOnce = once(warnTemplateKeysDeprecation)
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.templateName = buildTemplateName(this.templateFile)
stationInfo.chargingStationId = getChargingStationId(this.index, stationTemplate)
createSerialNumber(stationTemplate, stationInfo)
stationInfo.voltageOut = this.getVoltageOut(stationInfo)
} 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)
}
}
// eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
if (stationInfo.templateName == null) {
- stationInfo.templateName = parse(this.templateFile).name
+ stationInfo.templateName = buildTemplateName(this.templateFile)
}
}
}
const stationInfoFromFile = this.getStationInfoFromFile(
stationInfoFromTemplate.stationInfoPersistentConfiguration
)
+ let stationInfo: ChargingStationInfo
// Priority:
// 1. charging station info from template
// 2. charging station info from configuration file
stationInfoFromFile != null &&
stationInfoFromFile.templateHash === stationInfoFromTemplate.templateHash
) {
- return setChargingStationOptions(
- this,
- { ...Constants.DEFAULT_STATION_INFO, ...stationInfoFromFile },
- options
- )
+ stationInfo = stationInfoFromFile
+ } else {
+ stationInfo = stationInfoFromTemplate
+ stationInfoFromFile != null &&
+ propagateSerialNumber(this.getTemplateFromFile(), stationInfoFromFile, stationInfo)
}
- stationInfoFromFile != null &&
- propagateSerialNumber(
- this.getTemplateFromFile(),
- stationInfoFromFile,
- stationInfoFromTemplate
- )
return setChargingStationOptions(
- this,
- { ...Constants.DEFAULT_STATION_INFO, ...stationInfoFromTemplate },
+ mergeDeepRight(Constants.DEFAULT_STATION_INFO, stationInfo),
options
)
}
}
const templateConnectorId =
connectorId > 0 && stationTemplate.randomConnectors === true
- ? getRandomInteger(templateMaxAvailableConnectors, 1)
+ ? randomInt(1, templateMaxAvailableConnectors)
: connectorId
const connectorStatus = stationTemplate.Connectors[templateConnectorId]
checkStationInfoConnectorStatus(
} else {
delete configurationData.configurationKey
}
- configurationData = merge<ChargingStationConfiguration>(
+ configurationData = mergeDeepRight(
configurationData,
buildChargingStationAutomaticTransactionGeneratorConfiguration(this)
)
this.sharedLRUCache.deleteChargingStationConfiguration(this.configurationFileHash)
this.sharedLRUCache.setChargingStationConfiguration(configurationData)
this.configurationFileHash = configurationHash
- }).catch(error => {
+ }).catch((error: unknown) => {
handleFileException(
this.configurationFile,
FileType.ChargingStationConfiguration,
private async onOpen (): Promise<void> {
if (this.isWebSocketConnectionOpened()) {
+ this.emit(ChargingStationEvents.updated)
logger.info(
`${this.logPrefix()} Connection to OCPP server through ${this.wsConnectionUrl.href} succeeded`
)
private onClose (code: WebSocketCloseEventStatusCode, reason: Buffer): void {
this.emit(ChargingStationEvents.disconnected)
+ this.emit(ChargingStationEvents.updated)
switch (code) {
// Normal close
case WebSocketCloseEventStatusCode.CLOSE_NORMAL:
)}' and reason '${reason.toString()}'`
)
this.started &&
- this.reconnect().catch(error =>
- logger.error(`${this.logPrefix()} Error while reconnecting:`, error)
- )
+ this.reconnect()
+ .then(() => {
+ this.emit(ChargingStationEvents.updated)
+ })
+ .catch((error: unknown) =>
+ logger.error(`${this.logPrefix()} Error while reconnecting:`, error)
+ )
break
}
- this.emit(ChargingStationEvents.updated)
}
private getCachedRequest (
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)
+ await sendAndSetConnectorStatus(
+ this,
+ connectorId,
+ getBootConnectorStatus(this, connectorId, connectorStatus),
+ evseId
+ )
}
}
}
} else {
for (const connectorId of this.connectors.keys()) {
if (connectorId > 0) {
- const connectorBootStatus = getBootConnectorStatus(
+ await sendAndSetConnectorStatus(
this,
connectorId,
- // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
- this.getConnectorStatus(connectorId)!
+ getBootConnectorStatus(
+ this,
+ connectorId,
+ // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+ this.getConnectorStatus(connectorId)!
+ )
)
- await sendAndSetConnectorStatus(this, connectorId, connectorBootStatus)
}
}
}
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
Configuration.getSupervisionUrlDistribution()!
) &&
- logger.error(
+ logger.warn(
// eslint-disable-next-line @typescript-eslint/no-base-to-string
- `${this.logPrefix()} Unknown supervision url distribution '${Configuration.getSupervisionUrlDistribution()}' from values '${SupervisionUrlDistribution.toString()}', defaulting to ${
+ `${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