-import { BootNotificationResponse, RegistrationStatus } from '../types/ocpp/Responses';
-import ChargingStationConfiguration, { ConfigurationKey } from '../types/ChargingStationConfiguration';
-import ChargingStationTemplate, { CurrentOutType, VoltageOut } from '../types/ChargingStationTemplate';
-import Connectors, { Connector } from '../types/Connectors';
-import { PerformanceObserver, performance } from 'perf_hooks';
-import Requests, { AvailabilityType, BootNotificationRequest, IncomingRequest, IncomingRequestCommand } from '../types/ocpp/Requests';
-import WebSocket, { MessageEvent } from 'ws';
+// Partial Copyright Jerome Benoit. 2021-2023. All Rights Reserved.
+import fs from 'fs';
+import crypto from 'node:crypto';
+import path from 'path';
+import { URL } from 'url';
+import { parentPort } from 'worker_threads';
+
+import merge from 'just-merge';
+import WebSocket, { type RawData } from 'ws';
+
+import AuthorizedTagsCache from './AuthorizedTagsCache';
import AutomaticTransactionGenerator from './AutomaticTransactionGenerator';
-import { ChargePointStatus } from '../types/ocpp/ChargePointStatus';
-import { ChargingProfile } from '../types/ocpp/ChargingProfile';
-import ChargingStationInfo from '../types/ChargingStationInfo';
-import Configuration from '../utils/Configuration';
-import Constants from '../utils/Constants';
-import FileUtils from '../utils/FileUtils';
-import { MessageType } from '../types/ocpp/MessageType';
-import { MeterValueMeasurand } from '../types/ocpp/MeterValues';
-import OCPP16IncomingRequestService from './ocpp/1.6/OCCP16IncomingRequestService';
+import { ChargingStationConfigurationUtils } from './ChargingStationConfigurationUtils';
+import { ChargingStationUtils } from './ChargingStationUtils';
+import ChargingStationWorkerBroadcastChannel from './ChargingStationWorkerBroadcastChannel';
+import { MessageChannelUtils } from './MessageChannelUtils';
+import OCPP16IncomingRequestService from './ocpp/1.6/OCPP16IncomingRequestService';
import OCPP16RequestService from './ocpp/1.6/OCPP16RequestService';
import OCPP16ResponseService from './ocpp/1.6/OCPP16ResponseService';
-import OCPPError from './OcppError';
-import OCPPIncomingRequestService from './ocpp/OCPPIncomingRequestService';
-import OCPPRequestService from './ocpp/OCPPRequestService';
+import { OCPP16ServiceUtils } from './ocpp/1.6/OCPP16ServiceUtils';
+import OCPP20IncomingRequestService from './ocpp/2.0/OCPP20IncomingRequestService';
+import OCPP20RequestService from './ocpp/2.0/OCPP20RequestService';
+import OCPP20ResponseService from './ocpp/2.0/OCPP20ResponseService';
+import type OCPPIncomingRequestService from './ocpp/OCPPIncomingRequestService';
+import type OCPPRequestService from './ocpp/OCPPRequestService';
+import { OCPPServiceUtils } from './ocpp/OCPPServiceUtils';
+import SharedLRUCache from './SharedLRUCache';
+import BaseError from '../exception/BaseError';
+import OCPPError from '../exception/OCPPError';
+import PerformanceStatistics from '../performance/PerformanceStatistics';
+import type { AutomaticTransactionGeneratorConfiguration } from '../types/AutomaticTransactionGenerator';
+import type { ChargingStationConfiguration } from '../types/ChargingStationConfiguration';
+import type { ChargingStationInfo } from '../types/ChargingStationInfo';
+import type { ChargingStationOcppConfiguration } from '../types/ChargingStationOcppConfiguration';
+import {
+ type ChargingStationTemplate,
+ CurrentType,
+ PowerUnits,
+ type WsOptions,
+} from '../types/ChargingStationTemplate';
+import { SupervisionUrlDistribution } from '../types/ConfigurationData';
+import type { ConnectorStatus } from '../types/ConnectorStatus';
+import { FileType } from '../types/FileType';
+import type { JsonType } from '../types/JsonType';
+import {
+ ConnectorPhaseRotation,
+ StandardParametersKey,
+ SupportedFeatureProfiles,
+ VendorDefaultParametersKey,
+} from '../types/ocpp/Configuration';
+import { ConnectorStatusEnum } from '../types/ocpp/ConnectorStatusEnum';
+import { ErrorType } from '../types/ocpp/ErrorType';
+import { MessageType } from '../types/ocpp/MessageType';
+import { MeterValue, MeterValueMeasurand } from '../types/ocpp/MeterValues';
import { OCPPVersion } from '../types/ocpp/OCPPVersion';
-import PerformanceStatistics from '../utils/PerformanceStatistics';
-import { StandardParametersKey } from '../types/ocpp/Configuration';
-import { StopTransactionReason } from '../types/ocpp/Transaction';
-import Utils from '../utils/Utils';
-import { WebSocketCloseEventStatusCode } from '../types/WebSocket';
-import crypto from 'crypto';
-import fs from 'fs';
+import {
+ AvailabilityType,
+ type BootNotificationRequest,
+ type CachedRequest,
+ type ErrorCallback,
+ FirmwareStatus,
+ type FirmwareStatusNotificationRequest,
+ type HeartbeatRequest,
+ type IncomingRequest,
+ IncomingRequestCommand,
+ type MeterValuesRequest,
+ type OutgoingRequest,
+ RequestCommand,
+ type ResponseCallback,
+ type StatusNotificationRequest,
+} from '../types/ocpp/Requests';
+import {
+ type BootNotificationResponse,
+ type ErrorResponse,
+ type FirmwareStatusNotificationResponse,
+ type HeartbeatResponse,
+ type MeterValuesResponse,
+ RegistrationStatusEnumType,
+ type Response,
+ type StatusNotificationResponse,
+} from '../types/ocpp/Responses';
+import {
+ StopTransactionReason,
+ type StopTransactionRequest,
+ type StopTransactionResponse,
+} from '../types/ocpp/Transaction';
+import { WSError, WebSocketCloseEventStatusCode } from '../types/WebSocket';
+import Configuration from '../utils/Configuration';
+import Constants from '../utils/Constants';
+import { ACElectricUtils, DCElectricUtils } from '../utils/ElectricUtils';
+import FileUtils from '../utils/FileUtils';
import logger from '../utils/Logger';
-import path from 'path';
+import Utils from '../utils/Utils';
export default class ChargingStation {
- public stationTemplateFile: string;
- public authorizedTags: string[];
+ public readonly index: number;
+ public readonly templateFile: string;
public stationInfo!: ChargingStationInfo;
- public connectors: Connectors;
- public configuration!: ChargingStationConfiguration;
- public hasStopped: boolean;
+ public started: boolean;
+ public starting: boolean;
+ public authorizedTagsCache: AuthorizedTagsCache;
+ public automaticTransactionGenerator!: AutomaticTransactionGenerator;
+ public ocppConfiguration!: ChargingStationOcppConfiguration;
public wsConnection!: WebSocket;
- public requests: Requests;
- public messageQueue: string[];
+ public readonly connectors: Map<number, ConnectorStatus>;
+ public readonly requests: Map<string, CachedRequest>;
public performanceStatistics!: PerformanceStatistics;
public heartbeatSetInterval!: NodeJS.Timeout;
- public ocppIncomingRequestService!: OCPPIncomingRequestService;
public ocppRequestService!: OCPPRequestService;
- private index: number;
- private bootNotificationRequest!: BootNotificationRequest;
- private bootNotificationResponse!: BootNotificationResponse | null;
+ public bootNotificationRequest!: BootNotificationRequest;
+ public bootNotificationResponse!: BootNotificationResponse | null;
+ public powerDivider!: number;
+ private stopping: boolean;
+ private configurationFile!: string;
+ private configurationFileHash!: string;
private connectorsConfigurationHash!: string;
- private supervisionUrl!: string;
- private wsConnectionUrl!: string;
- private hasSocketRestarted: boolean;
+ private ocppIncomingRequestService!: OCPPIncomingRequestService;
+ private readonly messageBuffer: Set<string>;
+ private configuredSupervisionUrl!: URL;
+ private configuredSupervisionUrlIndex!: number;
+ private wsConnectionRestarted: boolean;
private autoReconnectRetryCount: number;
- private automaticTransactionGeneration!: AutomaticTransactionGenerator;
- private performanceObserver!: PerformanceObserver;
+ private templateFileWatcher!: fs.FSWatcher;
+ private readonly sharedLRUCache: SharedLRUCache;
private webSocketPingSetInterval!: NodeJS.Timeout;
+ private readonly chargingStationWorkerBroadcastChannel: ChargingStationWorkerBroadcastChannel;
- constructor(index: number, stationTemplateFile: string) {
- this.index = index;
- this.stationTemplateFile = stationTemplateFile;
- this.connectors = {} as Connectors;
- this.initialize();
-
- this.hasStopped = false;
- this.hasSocketRestarted = false;
+ constructor(index: number, templateFile: string) {
+ this.started = false;
+ this.starting = false;
+ this.stopping = false;
+ this.wsConnectionRestarted = false;
this.autoReconnectRetryCount = 0;
+ this.index = index;
+ this.templateFile = templateFile;
+ this.connectors = new Map<number, ConnectorStatus>();
+ this.requests = new Map<string, CachedRequest>();
+ this.messageBuffer = new Set<string>();
+ this.sharedLRUCache = SharedLRUCache.getInstance();
+ this.authorizedTagsCache = AuthorizedTagsCache.getInstance();
+ this.chargingStationWorkerBroadcastChannel = new ChargingStationWorkerBroadcastChannel(this);
- this.requests = {} as Requests;
- this.messageQueue = [] as string[];
+ this.initialize();
+ }
- this.authorizedTags = this.getAuthorizedTags();
+ private get wsConnectionUrl(): URL {
+ return new URL(
+ `${
+ this.getSupervisionUrlOcppConfiguration()
+ ? ChargingStationConfigurationUtils.getConfigurationKey(
+ this,
+ this.getSupervisionUrlOcppKey()
+ ).value
+ : this.configuredSupervisionUrl.href
+ }/${this.stationInfo.chargingStationId}`
+ );
}
public logPrefix(): string {
- return Utils.logPrefix(` ${this.stationInfo.chargingStationId} |`);
+ return Utils.logPrefix(
+ ` ${
+ this?.stationInfo?.chargingStationId ??
+ ChargingStationUtils.getChargingStationId(this.index, this.getTemplateFromFile())
+ } |`
+ );
}
- public getRandomTagId(): string {
- const index = Math.floor(Math.random() * this.authorizedTags.length);
- return this.authorizedTags[index];
+ public hasAuthorizedTags(): boolean {
+ return !Utils.isEmptyArray(
+ this.authorizedTagsCache.getAuthorizedTags(
+ ChargingStationUtils.getAuthorizationFile(this.stationInfo)
+ )
+ );
}
- public hasAuthorizedTags(): boolean {
- return !Utils.isEmptyArray(this.authorizedTags);
+ public getEnableStatistics(): boolean {
+ return this.stationInfo.enableStatistics ?? false;
}
- public getEnableStatistics(): boolean | undefined {
- return !Utils.isUndefined(this.stationInfo.enableStatistics) ? this.stationInfo.enableStatistics : true;
+ public getMustAuthorizeAtRemoteStart(): boolean {
+ return this.stationInfo.mustAuthorizeAtRemoteStart ?? true;
}
- public getNumberOfPhases(): number | undefined {
- switch (this.getCurrentOutType()) {
- case CurrentOutType.AC:
- return !Utils.isUndefined(this.stationInfo.numberOfPhases) ? this.stationInfo.numberOfPhases : 3;
- case CurrentOutType.DC:
+ public getPayloadSchemaValidation(): boolean {
+ return this.stationInfo.payloadSchemaValidation ?? true;
+ }
+
+ public getNumberOfPhases(stationInfo?: ChargingStationInfo): number | undefined {
+ const localStationInfo: ChargingStationInfo = stationInfo ?? this.stationInfo;
+ switch (this.getCurrentOutType(stationInfo)) {
+ case CurrentType.AC:
+ return !Utils.isUndefined(localStationInfo.numberOfPhases)
+ ? localStationInfo.numberOfPhases
+ : 3;
+ case CurrentType.DC:
return 0;
}
}
- public isWebSocketOpen(): boolean {
- return this.wsConnection?.readyState === WebSocket.OPEN;
+ public isWebSocketConnectionOpened(): boolean {
+ return this?.wsConnection?.readyState === WebSocket.OPEN;
+ }
+
+ public getRegistrationStatus(): RegistrationStatusEnumType {
+ return this?.bootNotificationResponse?.status;
+ }
+
+ public isInUnknownState(): boolean {
+ return Utils.isNullOrUndefined(this?.bootNotificationResponse?.status);
+ }
+
+ public isInPendingState(): boolean {
+ return this?.bootNotificationResponse?.status === RegistrationStatusEnumType.PENDING;
+ }
+
+ public isInAcceptedState(): boolean {
+ return this?.bootNotificationResponse?.status === RegistrationStatusEnumType.ACCEPTED;
+ }
+
+ public isInRejectedState(): boolean {
+ return this?.bootNotificationResponse?.status === RegistrationStatusEnumType.REJECTED;
}
public isRegistered(): boolean {
- return this.bootNotificationResponse?.status === RegistrationStatus.ACCEPTED;
+ return (
+ this.isInUnknownState() === false &&
+ (this.isInAcceptedState() === true || this.isInPendingState() === true)
+ );
}
public isChargingStationAvailable(): boolean {
- return this.getConnector(0).availability === AvailabilityType.OPERATIVE;
+ return this.getConnectorStatus(0).availability === AvailabilityType.OPERATIVE;
}
public isConnectorAvailable(id: number): boolean {
- return this.getConnector(id).availability === AvailabilityType.OPERATIVE;
+ return id > 0 && this.getConnectorStatus(id).availability === AvailabilityType.OPERATIVE;
}
- public getConnector(id: number): Connector {
- return this.connectors[id];
+ public getNumberOfConnectors(): number {
+ return this.connectors.get(0) ? this.connectors.size - 1 : this.connectors.size;
}
- public getCurrentOutType(): CurrentOutType | undefined {
- return !Utils.isUndefined(this.stationInfo.currentOutType) ? this.stationInfo.currentOutType : CurrentOutType.AC;
+ public getConnectorStatus(id: number): ConnectorStatus | undefined {
+ return this.connectors.get(id);
}
- public getVoltageOut(): number | undefined {
- const errMsg = `${this.logPrefix()} Unknown ${this.getCurrentOutType()} currentOutType in template file ${this.stationTemplateFile}, cannot define default voltage out`;
- let defaultVoltageOut: number;
- switch (this.getCurrentOutType()) {
- case CurrentOutType.AC:
- defaultVoltageOut = VoltageOut.VOLTAGE_230;
- break;
- case CurrentOutType.DC:
- defaultVoltageOut = VoltageOut.VOLTAGE_400;
- break;
- default:
- logger.error(errMsg);
- throw Error(errMsg);
+ public getCurrentOutType(stationInfo?: ChargingStationInfo): CurrentType {
+ return (stationInfo ?? this.stationInfo).currentOutType ?? CurrentType.AC;
+ }
+
+ public getOcppStrictCompliance(): boolean {
+ return this.stationInfo?.ocppStrictCompliance ?? false;
+ }
+
+ public getVoltageOut(stationInfo?: ChargingStationInfo): number | undefined {
+ const defaultVoltageOut = ChargingStationUtils.getDefaultVoltageOut(
+ this.getCurrentOutType(stationInfo),
+ this.templateFile,
+ this.logPrefix()
+ );
+ const localStationInfo: ChargingStationInfo = stationInfo ?? this.stationInfo;
+ return !Utils.isUndefined(localStationInfo.voltageOut)
+ ? localStationInfo.voltageOut
+ : defaultVoltageOut;
+ }
+
+ public getMaximumPower(stationInfo?: ChargingStationInfo): number {
+ const localStationInfo = stationInfo ?? this.stationInfo;
+ return (localStationInfo['maxPower'] as number) ?? localStationInfo.maximumPower;
+ }
+
+ public getConnectorMaximumAvailablePower(connectorId: number): number {
+ let connectorAmperageLimitationPowerLimit: number;
+ if (
+ !Utils.isNullOrUndefined(this.getAmperageLimitation()) &&
+ this.getAmperageLimitation() < this.stationInfo.maximumAmperage
+ ) {
+ connectorAmperageLimitationPowerLimit =
+ (this.getCurrentOutType() === CurrentType.AC
+ ? ACElectricUtils.powerTotal(
+ this.getNumberOfPhases(),
+ this.getVoltageOut(),
+ this.getAmperageLimitation() * this.getNumberOfConnectors()
+ )
+ : DCElectricUtils.power(this.getVoltageOut(), this.getAmperageLimitation())) /
+ this.powerDivider;
}
- return !Utils.isUndefined(this.stationInfo.voltageOut) ? this.stationInfo.voltageOut : defaultVoltageOut;
+ const connectorMaximumPower = this.getMaximumPower() / this.powerDivider;
+ const connectorChargingProfilesPowerLimit =
+ ChargingStationUtils.getChargingStationConnectorChargingProfilesPowerLimit(this, connectorId);
+ return Math.min(
+ isNaN(connectorMaximumPower) ? Infinity : connectorMaximumPower,
+ isNaN(connectorAmperageLimitationPowerLimit)
+ ? Infinity
+ : connectorAmperageLimitationPowerLimit,
+ isNaN(connectorChargingProfilesPowerLimit) ? Infinity : connectorChargingProfilesPowerLimit
+ );
}
public getTransactionIdTag(transactionId: number): string | undefined {
- for (const connector in this.connectors) {
- if (Utils.convertToInt(connector) > 0 && this.getConnector(Utils.convertToInt(connector)).transactionId === transactionId) {
- return this.getConnector(Utils.convertToInt(connector)).idTag;
+ for (const connectorId of this.connectors.keys()) {
+ if (connectorId > 0 && this.getConnectorStatus(connectorId).transactionId === transactionId) {
+ return this.getConnectorStatus(connectorId).transactionIdTag;
}
}
}
public getOutOfOrderEndMeterValues(): boolean {
- return this.stationInfo.outOfOrderEndMeterValues ?? false;
+ return this.stationInfo?.outOfOrderEndMeterValues ?? false;
}
public getBeginEndMeterValues(): boolean {
- return this.stationInfo.beginEndMeterValues ?? false;
+ return this.stationInfo?.beginEndMeterValues ?? false;
}
public getMeteringPerTransaction(): boolean {
- return this.stationInfo.meteringPerTransaction ?? true;
+ return this.stationInfo?.meteringPerTransaction ?? true;
}
- public getEnergyActiveImportRegisterByTransactionId(transactionId: number): number | undefined {
- if (this.getMeteringPerTransaction()) {
- for (const connector in this.connectors) {
- if (Utils.convertToInt(connector) > 0 && this.getConnector(Utils.convertToInt(connector)).transactionId === transactionId) {
- return this.getConnector(Utils.convertToInt(connector)).transactionEnergyActiveImportRegisterValue;
- }
- }
- }
- for (const connector in this.connectors) {
- if (Utils.convertToInt(connector) > 0 && this.getConnector(Utils.convertToInt(connector)).transactionId === transactionId) {
- return this.getConnector(Utils.convertToInt(connector)).energyActiveImportRegisterValue;
- }
- }
+ public getTransactionDataMeterValues(): boolean {
+ return this.stationInfo?.transactionDataMeterValues ?? false;
+ }
+
+ public getMainVoltageMeterValues(): boolean {
+ return this.stationInfo?.mainVoltageMeterValues ?? true;
+ }
+
+ public getPhaseLineToLineVoltageMeterValues(): boolean {
+ return this.stationInfo?.phaseLineToLineVoltageMeterValues ?? false;
}
- public getEnergyActiveImportRegisterByConnectorId(connectorId: number): number | undefined {
- if (this.getMeteringPerTransaction()) {
- return this.getConnector(connectorId).transactionEnergyActiveImportRegisterValue;
+ public getCustomValueLimitationMeterValues(): boolean {
+ return this.stationInfo?.customValueLimitationMeterValues ?? true;
+ }
+
+ public getConnectorIdByTransactionId(transactionId: number): number | undefined {
+ for (const connectorId of this.connectors.keys()) {
+ if (
+ connectorId > 0 &&
+ this.getConnectorStatus(connectorId)?.transactionId === transactionId
+ ) {
+ return connectorId;
+ }
}
- return this.getConnector(connectorId).energyActiveImportRegisterValue;
}
- public getAuthorizeRemoteTxRequests(): boolean {
- const authorizeRemoteTxRequests = this.getConfigurationKey(StandardParametersKey.AuthorizeRemoteTxRequests);
- return authorizeRemoteTxRequests ? Utils.convertToBoolean(authorizeRemoteTxRequests.value) : false;
+ public getEnergyActiveImportRegisterByTransactionId(
+ transactionId: number,
+ rounded = false
+ ): number {
+ return this.getEnergyActiveImportRegister(
+ this.getConnectorStatus(this.getConnectorIdByTransactionId(transactionId)),
+ rounded
+ );
}
- public getLocalAuthListEnabled(): boolean {
- const localAuthListEnabled = this.getConfigurationKey(StandardParametersKey.LocalAuthListEnabled);
- return localAuthListEnabled ? Utils.convertToBoolean(localAuthListEnabled.value) : false;
+ public getEnergyActiveImportRegisterByConnectorId(connectorId: number, rounded = false): number {
+ return this.getEnergyActiveImportRegister(this.getConnectorStatus(connectorId), rounded);
}
- public restartWebSocketPing(): void {
- // Stop WebSocket ping
- this.stopWebSocketPing();
- // Start WebSocket ping
- this.startWebSocketPing();
+ public getAuthorizeRemoteTxRequests(): boolean {
+ const authorizeRemoteTxRequests = ChargingStationConfigurationUtils.getConfigurationKey(
+ this,
+ StandardParametersKey.AuthorizeRemoteTxRequests
+ );
+ return authorizeRemoteTxRequests
+ ? Utils.convertToBoolean(authorizeRemoteTxRequests.value)
+ : false;
}
- public getAutomaticTransactionGeneratorRequireAuthorize(): boolean {
- return this.stationInfo.AutomaticTransactionGenerator.requireAuthorize ?? true;
+ public getLocalAuthListEnabled(): boolean {
+ const localAuthListEnabled = ChargingStationConfigurationUtils.getConfigurationKey(
+ this,
+ StandardParametersKey.LocalAuthListEnabled
+ );
+ return localAuthListEnabled ? Utils.convertToBoolean(localAuthListEnabled.value) : false;
}
public startHeartbeat(): void {
- if (this.getHeartbeatInterval() && this.getHeartbeatInterval() > 0 && !this.heartbeatSetInterval) {
- // eslint-disable-next-line @typescript-eslint/no-misused-promises
- this.heartbeatSetInterval = setInterval(async (): Promise<void> => {
- await this.ocppRequestService.sendHeartbeat();
+ if (
+ this.getHeartbeatInterval() &&
+ this.getHeartbeatInterval() > 0 &&
+ !this.heartbeatSetInterval
+ ) {
+ 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 ' + Utils.milliSecondsToHHMMSS(this.getHeartbeatInterval()));
+ logger.info(
+ `${this.logPrefix()} Heartbeat started every ${Utils.formatDurationMilliSeconds(
+ this.getHeartbeatInterval()
+ )}`
+ );
} else if (this.heartbeatSetInterval) {
- logger.info(this.logPrefix() + ' Heartbeat already started every ' + Utils.milliSecondsToHHMMSS(this.getHeartbeatInterval()));
+ logger.info(
+ `${this.logPrefix()} Heartbeat already started every ${Utils.formatDurationMilliSeconds(
+ this.getHeartbeatInterval()
+ )}`
+ );
} else {
- logger.error(`${this.logPrefix()} Heartbeat interval set to ${this.getHeartbeatInterval() ? Utils.milliSecondsToHHMMSS(this.getHeartbeatInterval()) : this.getHeartbeatInterval()}, not starting the heartbeat`);
+ logger.error(
+ `${this.logPrefix()} Heartbeat interval set to ${
+ this.getHeartbeatInterval()
+ ? Utils.formatDurationMilliSeconds(this.getHeartbeatInterval())
+ : this.getHeartbeatInterval()
+ }, not starting the 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.toString()}`);
+ logger.error(
+ `${this.logPrefix()} Trying to start MeterValues on connector Id ${connectorId.toString()}`
+ );
return;
}
- if (!this.getConnector(connectorId)) {
- logger.error(`${this.logPrefix()} Trying to start MeterValues on non existing connector Id ${connectorId.toString()}`);
+ if (!this.getConnectorStatus(connectorId)) {
+ logger.error(
+ `${this.logPrefix()} Trying to start MeterValues on non existing connector Id ${connectorId.toString()}`
+ );
return;
}
- if (!this.getConnector(connectorId)?.transactionStarted) {
- logger.error(`${this.logPrefix()} Trying to start MeterValues on connector Id ${connectorId} with no transaction started`);
+ if (this.getConnectorStatus(connectorId)?.transactionStarted === false) {
+ logger.error(
+ `${this.logPrefix()} Trying to start MeterValues on connector Id ${connectorId} with no transaction started`
+ );
return;
- } else if (this.getConnector(connectorId)?.transactionStarted && !this.getConnector(connectorId)?.transactionId) {
- logger.error(`${this.logPrefix()} Trying to start MeterValues on connector Id ${connectorId} with no transaction id`);
+ } else if (
+ this.getConnectorStatus(connectorId)?.transactionStarted === true &&
+ !this.getConnectorStatus(connectorId)?.transactionId
+ ) {
+ logger.error(
+ `${this.logPrefix()} Trying to start MeterValues on connector Id ${connectorId} with no transaction id`
+ );
return;
}
if (interval > 0) {
- // eslint-disable-next-line @typescript-eslint/no-misused-promises
- this.getConnector(connectorId).transactionSetInterval = setInterval(async (): Promise<void> => {
- if (this.getEnableStatistics()) {
- const sendMeterValues = performance.timerify(this.ocppRequestService.sendMeterValues);
- this.performanceObserver.observe({
- entryTypes: ['function'],
+ this.getConnectorStatus(connectorId).transactionSetInterval = setInterval(() => {
+ // FIXME: Implement OCPP version agnostic helpers
+ const meterValue: MeterValue = OCPP16ServiceUtils.buildMeterValue(
+ this,
+ connectorId,
+ this.getConnectorStatus(connectorId).transactionId,
+ interval
+ );
+ this.ocppRequestService
+ .requestHandler<MeterValuesRequest, MeterValuesResponse>(
+ this,
+ RequestCommand.METER_VALUES,
+ {
+ connectorId,
+ transactionId: this.getConnectorStatus(connectorId).transactionId,
+ meterValue: [meterValue],
+ }
+ )
+ .catch((error) => {
+ logger.error(
+ `${this.logPrefix()} Error while sending '${RequestCommand.METER_VALUES}':`,
+ error
+ );
});
- await sendMeterValues(connectorId, this.getConnector(connectorId).transactionId, interval, this.ocppRequestService);
- } else {
- await this.ocppRequestService.sendMeterValues(connectorId, this.getConnector(connectorId).transactionId, interval, this.ocppRequestService);
- }
}, interval);
} else {
- logger.error(`${this.logPrefix()} Charging station ${StandardParametersKey.MeterValueSampleInterval} configuration set to ${interval ? Utils.milliSecondsToHHMMSS(interval) : interval}, not sending MeterValues`);
+ logger.error(
+ `${this.logPrefix()} Charging station ${
+ StandardParametersKey.MeterValueSampleInterval
+ } configuration set to ${
+ interval ? Utils.formatDurationMilliSeconds(interval) : interval
+ }, not sending MeterValues`
+ );
}
}
public start(): void {
- this.openWSConnection();
- // Monitor authorization file
- this.startAuthorizationFileMonitoring();
- // Monitor station template file
- this.startStationTemplateFileMonitoring();
- // Handle Socket incoming messages
- this.wsConnection.on('message', this.onMessage.bind(this));
- // Handle Socket error
- this.wsConnection.on('error', this.onError.bind(this));
- // Handle Socket close
- this.wsConnection.on('close', this.onClose.bind(this));
- // Handle Socket opening connection
- this.wsConnection.on('open', this.onOpen.bind(this));
- // Handle Socket ping
- this.wsConnection.on('ping', this.onPing.bind(this));
- // Handle Socket pong
- this.wsConnection.on('pong', this.onPong.bind(this));
- }
-
- public async stop(reason: StopTransactionReason = StopTransactionReason.NONE): Promise<void> {
- // Stop message sequence
- await this.stopMessageSequence(reason);
- for (const connector in this.connectors) {
- if (Utils.convertToInt(connector) > 0) {
- await this.ocppRequestService.sendStatusNotification(Utils.convertToInt(connector), ChargePointStatus.UNAVAILABLE);
- this.getConnector(Utils.convertToInt(connector)).status = ChargePointStatus.UNAVAILABLE;
+ if (this.started === false) {
+ if (this.starting === false) {
+ this.starting = true;
+ if (this.getEnableStatistics() === true) {
+ this.performanceStatistics.start();
+ }
+ this.openWSConnection();
+ // Monitor charging station template file
+ this.templateFileWatcher = FileUtils.watchJsonFile(
+ this.logPrefix(),
+ FileType.ChargingStationTemplate,
+ this.templateFile,
+ null,
+ (event, filename): void => {
+ if (filename && event === 'change') {
+ try {
+ logger.debug(
+ `${this.logPrefix()} ${FileType.ChargingStationTemplate} ${
+ this.templateFile
+ } file have changed, reload`
+ );
+ this.sharedLRUCache.deleteChargingStationTemplate(this.stationInfo?.templateHash);
+ // Initialize
+ this.initialize();
+ // Restart the ATG
+ this.stopAutomaticTransactionGenerator();
+ if (
+ this.getAutomaticTransactionGeneratorConfigurationFromTemplate()?.enable === true
+ ) {
+ this.startAutomaticTransactionGenerator();
+ }
+ if (this.getEnableStatistics() === 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;
+ parentPort.postMessage(MessageChannelUtils.buildStartedMessage(this));
+ this.starting = false;
+ } else {
+ logger.warn(`${this.logPrefix()} Charging station is already starting...`);
}
+ } else {
+ logger.warn(`${this.logPrefix()} Charging station is already started...`);
}
- if (this.isWebSocketOpen()) {
- this.wsConnection.close();
- }
- this.bootNotificationResponse = null;
- this.hasStopped = true;
}
- public getConfigurationKey(key: string | StandardParametersKey, caseInsensitive = false): ConfigurationKey | undefined {
- const configurationKey: ConfigurationKey | undefined = this.configuration.configurationKey.find((configElement) => {
- if (caseInsensitive) {
- return configElement.key.toLowerCase() === key.toLowerCase();
+ public async stop(reason?: StopTransactionReason): Promise<void> {
+ if (this.started === true) {
+ if (this.stopping === false) {
+ this.stopping = true;
+ await this.stopMessageSequence(reason);
+ this.closeWSConnection();
+ if (this.getEnableStatistics() === true) {
+ this.performanceStatistics.stop();
+ }
+ this.sharedLRUCache.deleteChargingStationConfiguration(this.configurationFileHash);
+ this.templateFileWatcher.close();
+ this.sharedLRUCache.deleteChargingStationTemplate(this.stationInfo?.templateHash);
+ this.bootNotificationResponse = null;
+ this.started = false;
+ parentPort.postMessage(MessageChannelUtils.buildStoppedMessage(this));
+ this.stopping = false;
+ } else {
+ logger.warn(`${this.logPrefix()} Charging station is already stopping...`);
}
- return configElement.key === key;
- });
- return configurationKey;
- }
-
- public addConfigurationKey(key: string | StandardParametersKey, value: string, readonly = false, visible = true, reboot = false): void {
- const keyFound = this.getConfigurationKey(key);
- if (!keyFound) {
- this.configuration.configurationKey.push({
- key,
- readonly,
- value,
- visible,
- reboot,
- });
} else {
- logger.error(`${this.logPrefix()} Trying to add an already existing configuration key: %j`, keyFound);
+ logger.warn(`${this.logPrefix()} Charging station is already stopped...`);
}
}
- public setConfigurationKeyValue(key: string | StandardParametersKey, value: string): void {
- const keyFound = this.getConfigurationKey(key);
- if (keyFound) {
- const keyIndex = this.configuration.configurationKey.indexOf(keyFound);
- this.configuration.configurationKey[keyIndex].value = value;
- } else {
- logger.error(`${this.logPrefix()} Trying to set a value on a non existing configuration key: %j`, { key, value });
- }
+ public async reset(reason?: StopTransactionReason): Promise<void> {
+ await this.stop(reason);
+ await Utils.sleep(this.stationInfo.resetTime);
+ this.initialize();
+ this.start();
}
- public setChargingProfile(connectorId: number, cp: ChargingProfile): boolean {
- if (!Utils.isEmptyArray(this.getConnector(connectorId).chargingProfiles)) {
- this.getConnector(connectorId).chargingProfiles?.forEach((chargingProfile: ChargingProfile, index: number) => {
- if (chargingProfile.chargingProfileId === cp.chargingProfileId
- || (chargingProfile.stackLevel === cp.stackLevel && chargingProfile.chargingProfilePurpose === cp.chargingProfilePurpose)) {
- this.getConnector(connectorId).chargingProfiles[index] = cp;
- return true;
- }
- });
+ public saveOcppConfiguration(): void {
+ if (this.getOcppPersistentConfiguration()) {
+ this.saveConfiguration();
}
- this.getConnector(connectorId).chargingProfiles?.push(cp);
- return true;
}
- public resetTransactionOnConnector(connectorId: number): void {
- this.getConnector(connectorId).transactionStarted = false;
- delete this.getConnector(connectorId).transactionId;
- delete this.getConnector(connectorId).idTag;
- this.getConnector(connectorId).transactionEnergyActiveImportRegisterValue = 0;
+ public resetConnectorStatus(connectorId: number): void {
+ this.getConnectorStatus(connectorId).idTagLocalAuthorized = false;
+ this.getConnectorStatus(connectorId).idTagAuthorized = false;
+ this.getConnectorStatus(connectorId).transactionRemoteStarted = false;
+ this.getConnectorStatus(connectorId).transactionStarted = false;
+ delete this.getConnectorStatus(connectorId).localAuthorizeIdTag;
+ delete this.getConnectorStatus(connectorId).authorizeIdTag;
+ delete this.getConnectorStatus(connectorId).transactionId;
+ delete this.getConnectorStatus(connectorId).transactionIdTag;
+ this.getConnectorStatus(connectorId).transactionEnergyActiveImportRegisterValue = 0;
+ delete this.getConnectorStatus(connectorId).transactionBeginMeterValue;
this.stopMeterValues(connectorId);
+ parentPort.postMessage(MessageChannelUtils.buildUpdatedMessage(this));
+ }
+
+ public hasFeatureProfile(featureProfile: SupportedFeatureProfiles): boolean {
+ return ChargingStationConfigurationUtils.getConfigurationKey(
+ this,
+ StandardParametersKey.SupportedFeatureProfiles
+ )?.value.includes(featureProfile);
+ }
+
+ public bufferMessage(message: string): void {
+ this.messageBuffer.add(message);
}
- public addToMessageQueue(message: string): void {
- let dups = false;
- // Handle dups in message queue
- for (const bufferedMessage of this.messageQueue) {
- // Message already in the queue
- if (message === bufferedMessage) {
- dups = true;
+ public openWSConnection(
+ options: WsOptions = this.stationInfo?.wsOptions ?? {},
+ params: { closeOpened?: boolean; terminateOpened?: boolean } = {
+ closeOpened: false,
+ terminateOpened: false,
+ }
+ ): void {
+ options.handshakeTimeout = options?.handshakeTimeout ?? this.getConnectionTimeout() * 1000;
+ params.closeOpened = params?.closeOpened ?? false;
+ params.terminateOpened = params?.terminateOpened ?? false;
+ if (this.started === false && this.starting === false) {
+ logger.warn(
+ `${this.logPrefix()} Cannot open OCPP connection to URL ${this.wsConnectionUrl.toString()} on stopped charging station`
+ );
+ return;
+ }
+ if (
+ !Utils.isNullOrUndefined(this.stationInfo.supervisionUser) &&
+ !Utils.isNullOrUndefined(this.stationInfo.supervisionPassword)
+ ) {
+ options.auth = `${this.stationInfo.supervisionUser}:${this.stationInfo.supervisionPassword}`;
+ }
+ if (params?.closeOpened) {
+ this.closeWSConnection();
+ }
+ if (params?.terminateOpened) {
+ this.terminateWSConnection();
+ }
+ const ocppVersion = this.stationInfo.ocppVersion ?? OCPPVersion.VERSION_16;
+ let protocol: string;
+ switch (ocppVersion) {
+ case OCPPVersion.VERSION_16:
+ case OCPPVersion.VERSION_20:
+ case OCPPVersion.VERSION_201:
+ protocol = `ocpp${ocppVersion}`;
break;
- }
+ default:
+ this.handleUnsupportedVersion(ocppVersion);
+ break;
+ }
+
+ if (this.isWebSocketConnectionOpened() === true) {
+ logger.warn(
+ `${this.logPrefix()} OCPP connection to URL ${this.wsConnectionUrl.toString()} is already opened`
+ );
+ return;
}
- if (!dups) {
- // Queue message
- this.messageQueue.push(message);
+
+ logger.info(
+ `${this.logPrefix()} Open OCPP connection to URL ${this.wsConnectionUrl.toString()}`
+ );
+
+ this.wsConnection = new WebSocket(this.wsConnectionUrl, protocol, options);
+
+ // Handle WebSocket message
+ this.wsConnection.on(
+ 'message',
+ this.onMessage.bind(this) as (this: WebSocket, data: RawData, isBinary: boolean) => void
+ );
+ // Handle WebSocket error
+ this.wsConnection.on(
+ 'error',
+ this.onError.bind(this) as (this: WebSocket, error: Error) => void
+ );
+ // Handle WebSocket close
+ this.wsConnection.on(
+ 'close',
+ this.onClose.bind(this) as (this: WebSocket, code: number, reason: Buffer) => void
+ );
+ // Handle WebSocket open
+ this.wsConnection.on('open', this.onOpen.bind(this) as (this: WebSocket) => void);
+ // Handle WebSocket ping
+ this.wsConnection.on('ping', this.onPing.bind(this) as (this: WebSocket, data: Buffer) => void);
+ // Handle WebSocket pong
+ this.wsConnection.on('pong', this.onPong.bind(this) as (this: WebSocket, data: Buffer) => void);
+ }
+
+ public closeWSConnection(): void {
+ if (this.isWebSocketConnectionOpened() === true) {
+ this.wsConnection.close();
+ this.wsConnection = null;
+ }
+ }
+
+ public startAutomaticTransactionGenerator(
+ connectorIds?: number[],
+ automaticTransactionGeneratorConfiguration?: AutomaticTransactionGeneratorConfiguration
+ ): void {
+ this.automaticTransactionGenerator = AutomaticTransactionGenerator.getInstance(
+ automaticTransactionGeneratorConfiguration ??
+ this.getAutomaticTransactionGeneratorConfigurationFromTemplate(),
+ this
+ );
+ if (!Utils.isEmptyArray(connectorIds)) {
+ for (const connectorId of connectorIds) {
+ this.automaticTransactionGenerator.startConnector(connectorId);
+ }
+ } else {
+ this.automaticTransactionGenerator.start();
}
+ parentPort.postMessage(MessageChannelUtils.buildUpdatedMessage(this));
}
- private flushMessageQueue() {
- if (!Utils.isEmptyArray(this.messageQueue)) {
- this.messageQueue.forEach((message, index) => {
- this.messageQueue.splice(index, 1);
+ public stopAutomaticTransactionGenerator(connectorIds?: number[]): void {
+ if (!Utils.isEmptyArray(connectorIds)) {
+ for (const connectorId of connectorIds) {
+ this.automaticTransactionGenerator?.stopConnector(connectorId);
+ }
+ } else {
+ this.automaticTransactionGenerator?.stop();
+ }
+ parentPort.postMessage(MessageChannelUtils.buildUpdatedMessage(this));
+ }
+
+ public async stopTransactionOnConnector(
+ connectorId: number,
+ reason = StopTransactionReason.NONE
+ ): Promise<StopTransactionResponse> {
+ const transactionId = this.getConnectorStatus(connectorId).transactionId;
+ if (
+ this.getBeginEndMeterValues() === true &&
+ this.getOcppStrictCompliance() === true &&
+ this.getOutOfOrderEndMeterValues() === false
+ ) {
+ // FIXME: Implement OCPP version agnostic helpers
+ const transactionEndMeterValue = OCPP16ServiceUtils.buildTransactionEndMeterValue(
+ this,
+ connectorId,
+ this.getEnergyActiveImportRegisterByTransactionId(transactionId)
+ );
+ await this.ocppRequestService.requestHandler<MeterValuesRequest, MeterValuesResponse>(
+ this,
+ RequestCommand.METER_VALUES,
+ {
+ connectorId,
+ transactionId,
+ meterValue: [transactionEndMeterValue],
+ }
+ );
+ }
+ return this.ocppRequestService.requestHandler<StopTransactionRequest, StopTransactionResponse>(
+ this,
+ RequestCommand.STOP_TRANSACTION,
+ {
+ transactionId,
+ meterStop: this.getEnergyActiveImportRegisterByTransactionId(transactionId, true),
+ reason,
+ }
+ );
+ }
+
+ private flushMessageBuffer(): void {
+ if (this.messageBuffer.size > 0) {
+ this.messageBuffer.forEach((message) => {
+ let beginId: string;
+ let commandName: RequestCommand;
+ 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);
+ isRequest && PerformanceStatistics.endMeasure(commandName, beginId);
+ logger.debug(
+ `${this.logPrefix()} >> Buffered ${OCPPServiceUtils.getMessageTypeString(
+ messageType
+ )} payload sent: ${message}`
+ );
+ this.messageBuffer.delete(message);
});
}
}
- private getChargingStationId(stationTemplate: ChargingStationTemplate): string {
- // In case of multiple instances: add instance index to charging station id
- let instanceIndex = process.env.CF_INSTANCE_INDEX ? process.env.CF_INSTANCE_INDEX : 0;
- instanceIndex = instanceIndex > 0 ? instanceIndex : '';
- const idSuffix = stationTemplate.nameSuffix ? stationTemplate.nameSuffix : '';
- return stationTemplate.fixedName ? stationTemplate.baseName : stationTemplate.baseName + '-' + instanceIndex.toString() + ('000000000' + this.index.toString()).substr(('000000000' + this.index.toString()).length - 4) + idSuffix;
+ private getSupervisionUrlOcppConfiguration(): boolean {
+ return this.stationInfo.supervisionUrlOcppConfiguration ?? false;
+ }
+
+ private getSupervisionUrlOcppKey(): string {
+ return this.stationInfo.supervisionUrlOcppKey ?? VendorDefaultParametersKey.ConnectionUrl;
}
- private buildStationInfo(): ChargingStationInfo {
- let stationTemplateFromFile: ChargingStationTemplate;
+ private getTemplateFromFile(): ChargingStationTemplate | null {
+ let template: ChargingStationTemplate = null;
try {
- // Load template file
- const fileDescriptor = fs.openSync(this.stationTemplateFile, 'r');
- stationTemplateFromFile = JSON.parse(fs.readFileSync(fileDescriptor, 'utf8')) as ChargingStationTemplate;
- fs.closeSync(fileDescriptor);
+ if (this.sharedLRUCache.hasChargingStationTemplate(this.stationInfo?.templateHash)) {
+ template = this.sharedLRUCache.getChargingStationTemplate(this.stationInfo.templateHash);
+ } else {
+ const measureId = `${FileType.ChargingStationTemplate} read`;
+ const beginId = PerformanceStatistics.beginMeasure(measureId);
+ template = JSON.parse(
+ fs.readFileSync(this.templateFile, 'utf8')
+ ) as ChargingStationTemplate;
+ PerformanceStatistics.endMeasure(measureId, beginId);
+ template.templateHash = crypto
+ .createHash(Constants.DEFAULT_HASH_ALGORITHM)
+ .update(JSON.stringify(template))
+ .digest('hex');
+ this.sharedLRUCache.setChargingStationTemplate(template);
+ }
} catch (error) {
- FileUtils.handleFileException(this.logPrefix(), 'Template', this.stationTemplateFile, error);
+ FileUtils.handleFileException(
+ this.logPrefix(),
+ FileType.ChargingStationTemplate,
+ this.templateFile,
+ error as NodeJS.ErrnoException
+ );
+ }
+ return template;
+ }
+
+ private getStationInfoFromTemplate(): ChargingStationInfo {
+ const stationTemplate: ChargingStationTemplate = this.getTemplateFromFile();
+ if (Utils.isNullOrUndefined(stationTemplate)) {
+ const errorMsg = `Failed to read charging station template file ${this.templateFile}`;
+ logger.error(`${this.logPrefix()} ${errorMsg}`);
+ throw new BaseError(errorMsg);
}
- const stationInfo: ChargingStationInfo = stationTemplateFromFile || {} as ChargingStationInfo;
- if (!Utils.isEmptyArray(stationTemplateFromFile.power)) {
- stationTemplateFromFile.power = stationTemplateFromFile.power as number[];
- stationInfo.maxPower = stationTemplateFromFile.power[Math.floor(Math.random() * stationTemplateFromFile.power.length)];
+ if (Utils.isEmptyObject(stationTemplate)) {
+ const errorMsg = `Empty charging station information from template file ${this.templateFile}`;
+ logger.error(`${this.logPrefix()} ${errorMsg}`);
+ throw new BaseError(errorMsg);
+ }
+ // Deprecation template keys section
+ ChargingStationUtils.warnDeprecatedTemplateKey(
+ stationTemplate,
+ 'supervisionUrl',
+ this.templateFile,
+ this.logPrefix(),
+ "Use 'supervisionUrls' instead"
+ );
+ ChargingStationUtils.convertDeprecatedTemplateKey(
+ stationTemplate,
+ 'supervisionUrl',
+ 'supervisionUrls'
+ );
+ const stationInfo: ChargingStationInfo =
+ ChargingStationUtils.stationTemplateToStationInfo(stationTemplate);
+ stationInfo.hashId = ChargingStationUtils.getHashId(this.index, stationTemplate);
+ stationInfo.chargingStationId = ChargingStationUtils.getChargingStationId(
+ this.index,
+ stationTemplate
+ );
+ stationInfo.ocppVersion = stationTemplate.ocppVersion ?? OCPPVersion.VERSION_16;
+ ChargingStationUtils.createSerialNumber(stationTemplate, stationInfo);
+ if (!Utils.isEmptyArray(stationTemplate.power)) {
+ stationTemplate.power = stationTemplate.power as number[];
+ const powerArrayRandomIndex = Math.floor(Utils.secureRandom() * stationTemplate.power.length);
+ stationInfo.maximumPower =
+ stationTemplate.powerUnit === PowerUnits.KILO_WATT
+ ? stationTemplate.power[powerArrayRandomIndex] * 1000
+ : stationTemplate.power[powerArrayRandomIndex];
} else {
- stationInfo.maxPower = stationTemplateFromFile.power as number;
+ stationTemplate.power = stationTemplate.power as number;
+ stationInfo.maximumPower =
+ stationTemplate.powerUnit === PowerUnits.KILO_WATT
+ ? stationTemplate.power * 1000
+ : stationTemplate.power;
+ }
+ stationInfo.firmwareVersionPattern =
+ stationTemplate.firmwareVersionPattern ?? Constants.SEMVER_PATTERN;
+ if (
+ stationInfo.firmwareVersion &&
+ new RegExp(stationInfo.firmwareVersionPattern).test(stationInfo.firmwareVersion) === false
+ ) {
+ logger.warn(
+ `${this.logPrefix()} Firmware version '${stationInfo.firmwareVersion}' in template file ${
+ this.templateFile
+ } does not match firmware version pattern '${stationInfo.firmwareVersionPattern}'`
+ );
}
- stationInfo.chargingStationId = this.getChargingStationId(stationTemplateFromFile);
- stationInfo.resetTime = stationTemplateFromFile.resetTime ? stationTemplateFromFile.resetTime * 1000 : Constants.CHARGING_STATION_DEFAULT_RESET_TIME;
+ stationInfo.firmwareUpgrade = merge(
+ {
+ reset: true,
+ },
+ stationTemplate.firmwareUpgrade ?? {}
+ );
+ stationInfo.resetTime = stationTemplate.resetTime
+ ? stationTemplate.resetTime * 1000
+ : Constants.CHARGING_STATION_DEFAULT_RESET_TIME;
+ const configuredMaxConnectors =
+ ChargingStationUtils.getConfiguredNumberOfConnectors(stationTemplate);
+ ChargingStationUtils.checkConfiguredMaxConnectors(
+ configuredMaxConnectors,
+ this.templateFile,
+ this.logPrefix()
+ );
+ const templateMaxConnectors =
+ ChargingStationUtils.getTemplateMaxNumberOfConnectors(stationTemplate);
+ ChargingStationUtils.checkTemplateMaxConnectors(
+ templateMaxConnectors,
+ this.templateFile,
+ this.logPrefix()
+ );
+ if (
+ configuredMaxConnectors >
+ (stationTemplate?.Connectors[0] ? templateMaxConnectors - 1 : templateMaxConnectors) &&
+ !stationTemplate?.randomConnectors
+ ) {
+ logger.warn(
+ `${this.logPrefix()} Number of connectors exceeds the number of connector configurations in template ${
+ this.templateFile
+ }, forcing random connector configurations affectation`
+ );
+ stationInfo.randomConnectors = true;
+ }
+ // Build connectors if needed (FIXME: should be factored out)
+ this.initializeConnectors(stationInfo, configuredMaxConnectors, templateMaxConnectors);
+ stationInfo.maximumAmperage = this.getMaximumAmperage(stationInfo);
+ ChargingStationUtils.createStationInfoHash(stationInfo);
+ return stationInfo;
+ }
+
+ private getStationInfoFromFile(): ChargingStationInfo | null {
+ let stationInfo: ChargingStationInfo = null;
+ this.getStationInfoPersistentConfiguration() &&
+ (stationInfo = this.getConfigurationFromFile()?.stationInfo ?? null);
+ stationInfo && ChargingStationUtils.createStationInfoHash(stationInfo);
return stationInfo;
}
- private getOCPPVersion(): OCPPVersion {
- return this.stationInfo.ocppVersion ? this.stationInfo.ocppVersion : OCPPVersion.VERSION_16;
+ private getStationInfo(): ChargingStationInfo {
+ const stationInfoFromTemplate: ChargingStationInfo = this.getStationInfoFromTemplate();
+ const stationInfoFromFile: ChargingStationInfo = this.getStationInfoFromFile();
+ // Priority: charging station info from template > charging station info from configuration file > charging station info attribute
+ if (stationInfoFromFile?.templateHash === stationInfoFromTemplate.templateHash) {
+ if (this.stationInfo?.infoHash === stationInfoFromFile?.infoHash) {
+ return this.stationInfo;
+ }
+ return stationInfoFromFile;
+ }
+ stationInfoFromFile &&
+ ChargingStationUtils.propagateSerialNumber(
+ this.getTemplateFromFile(),
+ stationInfoFromFile,
+ stationInfoFromTemplate
+ );
+ return stationInfoFromTemplate;
+ }
+
+ private saveStationInfo(): void {
+ if (this.getStationInfoPersistentConfiguration()) {
+ this.saveConfiguration();
+ }
+ }
+
+ private getOcppPersistentConfiguration(): boolean {
+ return this.stationInfo?.ocppPersistentConfiguration ?? true;
+ }
+
+ private getStationInfoPersistentConfiguration(): boolean {
+ return this.stationInfo?.stationInfoPersistentConfiguration ?? true;
}
private handleUnsupportedVersion(version: OCPPVersion) {
- const errMsg = `${this.logPrefix()} Unsupported protocol version '${version}' configured in template file ${this.stationTemplateFile}`;
- logger.error(errMsg);
- throw new Error(errMsg);
+ const errMsg = `Unsupported protocol version '${version}' configured in template file ${this.templateFile}`;
+ logger.error(`${this.logPrefix()} ${errMsg}`);
+ throw new BaseError(errMsg);
}
private initialize(): void {
- this.stationInfo = this.buildStationInfo();
- this.bootNotificationRequest = {
- chargePointModel: this.stationInfo.chargePointModel,
- chargePointVendor: this.stationInfo.chargePointVendor,
- ...!Utils.isUndefined(this.stationInfo.chargeBoxSerialNumberPrefix) && { chargeBoxSerialNumber: this.stationInfo.chargeBoxSerialNumberPrefix },
- ...!Utils.isUndefined(this.stationInfo.firmwareVersion) && { firmwareVersion: this.stationInfo.firmwareVersion },
- };
- this.configuration = this.getTemplateChargingStationConfiguration();
- this.supervisionUrl = this.getSupervisionURL();
- this.wsConnectionUrl = this.supervisionUrl + '/' + this.stationInfo.chargingStationId;
- // Build connectors if needed
- const maxConnectors = this.getMaxNumberOfConnectors();
- if (maxConnectors <= 0) {
- logger.warn(`${this.logPrefix()} Charging station template ${this.stationTemplateFile} with ${maxConnectors} connectors`);
- }
- const templateMaxConnectors = this.getTemplateMaxNumberOfConnectors();
- if (templateMaxConnectors <= 0) {
- logger.warn(`${this.logPrefix()} Charging station template ${this.stationTemplateFile} with no connector configuration`);
- }
- if (!this.stationInfo.Connectors[0]) {
- logger.warn(`${this.logPrefix()} Charging station template ${this.stationTemplateFile} with no connector Id 0 configuration`);
- }
- // Sanity check
- if (maxConnectors > (this.stationInfo.Connectors[0] ? templateMaxConnectors - 1 : templateMaxConnectors) && !this.stationInfo.randomConnectors) {
- logger.warn(`${this.logPrefix()} Number of connectors exceeds the number of connector configurations in template ${this.stationTemplateFile}, forcing random connector configurations affectation`);
- this.stationInfo.randomConnectors = true;
- }
- const connectorsConfigHash = crypto.createHash('sha256').update(JSON.stringify(this.stationInfo.Connectors) + maxConnectors.toString()).digest('hex');
- // FIXME: Handle shrinking the number of connectors
- if (!this.connectors || (this.connectors && this.connectorsConfigurationHash !== connectorsConfigHash)) {
- this.connectorsConfigurationHash = connectorsConfigHash;
- // Add connector Id 0
- let lastConnector = '0';
- for (lastConnector in this.stationInfo.Connectors) {
- if (Utils.convertToInt(lastConnector) === 0 && this.getUseConnectorId0() && this.stationInfo.Connectors[lastConnector]) {
- this.connectors[lastConnector] = Utils.cloneObject<Connector>(this.stationInfo.Connectors[lastConnector]);
- this.connectors[lastConnector].availability = AvailabilityType.OPERATIVE;
- if (Utils.isUndefined(this.connectors[lastConnector]?.chargingProfiles)) {
- this.connectors[lastConnector].chargingProfiles = [];
- }
+ this.configurationFile = path.join(
+ path.dirname(this.templateFile.replace('station-templates', 'configurations')),
+ `${ChargingStationUtils.getHashId(this.index, this.getTemplateFromFile())}.json`
+ );
+ this.stationInfo = this.getStationInfo();
+ this.saveStationInfo();
+ // Avoid duplication of connectors related information in RAM
+ this.stationInfo?.Connectors && delete this.stationInfo.Connectors;
+ this.configuredSupervisionUrl = this.getConfiguredSupervisionUrl();
+ if (this.getEnableStatistics() === true) {
+ this.performanceStatistics = PerformanceStatistics.getInstance(
+ this.stationInfo.hashId,
+ this.stationInfo.chargingStationId,
+ this.configuredSupervisionUrl
+ );
+ }
+ this.bootNotificationRequest = ChargingStationUtils.createBootNotificationRequest(
+ this.stationInfo
+ );
+ this.powerDivider = this.getPowerDivider();
+ // OCPP configuration
+ this.ocppConfiguration = this.getOcppConfiguration();
+ this.initializeOcppConfiguration();
+ const ocppVersion = this.stationInfo.ocppVersion ?? OCPPVersion.VERSION_16;
+ 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;
+ }
+ if (this.stationInfo?.autoRegister === true) {
+ this.bootNotificationResponse = {
+ currentTime: new Date(),
+ interval: this.getHeartbeatInterval() / 1000,
+ status: RegistrationStatusEnumType.ACCEPTED,
+ };
+ }
+ if (
+ this.stationInfo.firmwareStatus === FirmwareStatus.Installing &&
+ this.stationInfo.firmwareVersion &&
+ this.stationInfo.firmwareVersionPattern
+ ) {
+ const versionStep = this.stationInfo.firmwareUpgrade?.versionUpgrade?.step ?? 1;
+ const patternGroup: number =
+ this.stationInfo.firmwareUpgrade?.versionUpgrade?.patternGroup ??
+ this.stationInfo.firmwareVersion.split('.').length;
+ const match = this.stationInfo.firmwareVersion
+ .match(new RegExp(this.stationInfo.firmwareVersionPattern))
+ .slice(1, patternGroup + 1);
+ const patchLevelIndex = match.length - 1;
+ match[patchLevelIndex] = (
+ Utils.convertToInt(match[patchLevelIndex]) + versionStep
+ ).toString();
+ this.stationInfo.firmwareVersion = match.join('.');
+ }
+ }
+
+ private initializeOcppConfiguration(): void {
+ if (
+ !ChargingStationConfigurationUtils.getConfigurationKey(
+ this,
+ StandardParametersKey.HeartbeatInterval
+ )
+ ) {
+ ChargingStationConfigurationUtils.addConfigurationKey(
+ this,
+ StandardParametersKey.HeartbeatInterval,
+ '0'
+ );
+ }
+ if (
+ !ChargingStationConfigurationUtils.getConfigurationKey(
+ this,
+ StandardParametersKey.HeartBeatInterval
+ )
+ ) {
+ ChargingStationConfigurationUtils.addConfigurationKey(
+ this,
+ StandardParametersKey.HeartBeatInterval,
+ '0',
+ { visible: false }
+ );
+ }
+ if (
+ this.getSupervisionUrlOcppConfiguration() &&
+ !ChargingStationConfigurationUtils.getConfigurationKey(this, this.getSupervisionUrlOcppKey())
+ ) {
+ ChargingStationConfigurationUtils.addConfigurationKey(
+ this,
+ this.getSupervisionUrlOcppKey(),
+ this.configuredSupervisionUrl.href,
+ { reboot: true }
+ );
+ } else if (
+ !this.getSupervisionUrlOcppConfiguration() &&
+ ChargingStationConfigurationUtils.getConfigurationKey(this, this.getSupervisionUrlOcppKey())
+ ) {
+ ChargingStationConfigurationUtils.deleteConfigurationKey(
+ this,
+ this.getSupervisionUrlOcppKey(),
+ { save: false }
+ );
+ }
+ if (
+ this.stationInfo.amperageLimitationOcppKey &&
+ !ChargingStationConfigurationUtils.getConfigurationKey(
+ this,
+ this.stationInfo.amperageLimitationOcppKey
+ )
+ ) {
+ ChargingStationConfigurationUtils.addConfigurationKey(
+ this,
+ this.stationInfo.amperageLimitationOcppKey,
+ (
+ this.stationInfo.maximumAmperage *
+ ChargingStationUtils.getAmperageLimitationUnitDivider(this.stationInfo)
+ ).toString()
+ );
+ }
+ if (
+ !ChargingStationConfigurationUtils.getConfigurationKey(
+ this,
+ StandardParametersKey.SupportedFeatureProfiles
+ )
+ ) {
+ ChargingStationConfigurationUtils.addConfigurationKey(
+ this,
+ StandardParametersKey.SupportedFeatureProfiles,
+ `${SupportedFeatureProfiles.Core},${SupportedFeatureProfiles.FirmwareManagement},${SupportedFeatureProfiles.LocalAuthListManagement},${SupportedFeatureProfiles.SmartCharging},${SupportedFeatureProfiles.RemoteTrigger}`
+ );
+ }
+ ChargingStationConfigurationUtils.addConfigurationKey(
+ this,
+ StandardParametersKey.NumberOfConnectors,
+ this.getNumberOfConnectors().toString(),
+ { readonly: true },
+ { overwrite: true }
+ );
+ if (
+ !ChargingStationConfigurationUtils.getConfigurationKey(
+ this,
+ StandardParametersKey.MeterValuesSampledData
+ )
+ ) {
+ ChargingStationConfigurationUtils.addConfigurationKey(
+ this,
+ StandardParametersKey.MeterValuesSampledData,
+ MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER
+ );
+ }
+ if (
+ !ChargingStationConfigurationUtils.getConfigurationKey(
+ this,
+ StandardParametersKey.ConnectorPhaseRotation
+ )
+ ) {
+ const connectorPhaseRotation = [];
+ for (const connectorId of this.connectors.keys()) {
+ // AC/DC
+ if (connectorId === 0 && this.getNumberOfPhases() === 0) {
+ connectorPhaseRotation.push(`${connectorId}.${ConnectorPhaseRotation.RST}`);
+ } else if (connectorId > 0 && this.getNumberOfPhases() === 0) {
+ connectorPhaseRotation.push(`${connectorId}.${ConnectorPhaseRotation.NotApplicable}`);
+ // AC
+ } else if (connectorId > 0 && this.getNumberOfPhases() === 1) {
+ connectorPhaseRotation.push(`${connectorId}.${ConnectorPhaseRotation.NotApplicable}`);
+ } else if (connectorId > 0 && this.getNumberOfPhases() === 3) {
+ connectorPhaseRotation.push(`${connectorId}.${ConnectorPhaseRotation.RST}`);
}
}
- // Generate all connectors
- if ((this.stationInfo.Connectors[0] ? templateMaxConnectors - 1 : templateMaxConnectors) > 0) {
- for (let index = 1; index <= maxConnectors; index++) {
- const randConnectorID = this.stationInfo.randomConnectors ? Utils.getRandomInt(Utils.convertToInt(lastConnector), 1) : index;
- this.connectors[index] = Utils.cloneObject<Connector>(this.stationInfo.Connectors[randConnectorID]);
- this.connectors[index].availability = AvailabilityType.OPERATIVE;
- if (Utils.isUndefined(this.connectors[lastConnector]?.chargingProfiles)) {
- this.connectors[index].chargingProfiles = [];
+ ChargingStationConfigurationUtils.addConfigurationKey(
+ this,
+ StandardParametersKey.ConnectorPhaseRotation,
+ connectorPhaseRotation.toString()
+ );
+ }
+ if (
+ !ChargingStationConfigurationUtils.getConfigurationKey(
+ this,
+ StandardParametersKey.AuthorizeRemoteTxRequests
+ )
+ ) {
+ ChargingStationConfigurationUtils.addConfigurationKey(
+ this,
+ StandardParametersKey.AuthorizeRemoteTxRequests,
+ 'true'
+ );
+ }
+ if (
+ !ChargingStationConfigurationUtils.getConfigurationKey(
+ this,
+ StandardParametersKey.LocalAuthListEnabled
+ ) &&
+ ChargingStationConfigurationUtils.getConfigurationKey(
+ this,
+ StandardParametersKey.SupportedFeatureProfiles
+ )?.value.includes(SupportedFeatureProfiles.LocalAuthListManagement)
+ ) {
+ ChargingStationConfigurationUtils.addConfigurationKey(
+ this,
+ StandardParametersKey.LocalAuthListEnabled,
+ 'false'
+ );
+ }
+ if (
+ !ChargingStationConfigurationUtils.getConfigurationKey(
+ this,
+ StandardParametersKey.ConnectionTimeOut
+ )
+ ) {
+ ChargingStationConfigurationUtils.addConfigurationKey(
+ this,
+ StandardParametersKey.ConnectionTimeOut,
+ Constants.DEFAULT_CONNECTION_TIMEOUT.toString()
+ );
+ }
+ this.saveOcppConfiguration();
+ }
+
+ private initializeConnectors(
+ stationInfo: ChargingStationInfo,
+ configuredMaxConnectors: number,
+ templateMaxConnectors: number
+ ): void {
+ if (!stationInfo?.Connectors && this.connectors.size === 0) {
+ const logMsg = `No already defined connectors and charging station information from template ${this.templateFile} with no connectors configuration defined`;
+ logger.error(`${this.logPrefix()} ${logMsg}`);
+ throw new BaseError(logMsg);
+ }
+ if (!stationInfo?.Connectors[0]) {
+ logger.warn(
+ `${this.logPrefix()} Charging station information from template ${
+ this.templateFile
+ } with no connector Id 0 configuration`
+ );
+ }
+ if (stationInfo?.Connectors) {
+ const connectorsConfigHash = crypto
+ .createHash(Constants.DEFAULT_HASH_ALGORITHM)
+ .update(JSON.stringify(stationInfo?.Connectors) + configuredMaxConnectors.toString())
+ .digest('hex');
+ const connectorsConfigChanged =
+ this.connectors?.size !== 0 && this.connectorsConfigurationHash !== connectorsConfigHash;
+ if (this.connectors?.size === 0 || connectorsConfigChanged) {
+ connectorsConfigChanged && this.connectors.clear();
+ this.connectorsConfigurationHash = connectorsConfigHash;
+ // Add connector Id 0
+ let lastConnector = '0';
+ for (lastConnector in stationInfo?.Connectors) {
+ const connectorStatus = stationInfo?.Connectors[lastConnector];
+ const lastConnectorId = Utils.convertToInt(lastConnector);
+ if (
+ lastConnectorId === 0 &&
+ this.getUseConnectorId0(stationInfo) === true &&
+ connectorStatus
+ ) {
+ this.checkStationInfoConnectorStatus(lastConnectorId, connectorStatus);
+ this.connectors.set(
+ lastConnectorId,
+ Utils.cloneObject<ConnectorStatus>(connectorStatus)
+ );
+ this.getConnectorStatus(lastConnectorId).availability = AvailabilityType.OPERATIVE;
+ if (Utils.isUndefined(this.getConnectorStatus(lastConnectorId)?.chargingProfiles)) {
+ this.getConnectorStatus(lastConnectorId).chargingProfiles = [];
+ }
+ }
+ }
+ // Generate all connectors
+ if ((stationInfo?.Connectors[0] ? templateMaxConnectors - 1 : templateMaxConnectors) > 0) {
+ for (let index = 1; index <= configuredMaxConnectors; index++) {
+ const randConnectorId = stationInfo?.randomConnectors
+ ? Utils.getRandomInteger(Utils.convertToInt(lastConnector), 1)
+ : index;
+ const connectorStatus = stationInfo?.Connectors[randConnectorId.toString()];
+ this.checkStationInfoConnectorStatus(randConnectorId, connectorStatus);
+ this.connectors.set(index, Utils.cloneObject<ConnectorStatus>(connectorStatus));
+ this.getConnectorStatus(index).availability = AvailabilityType.OPERATIVE;
+ if (Utils.isUndefined(this.getConnectorStatus(index)?.chargingProfiles)) {
+ this.getConnectorStatus(index).chargingProfiles = [];
+ }
}
}
}
+ } else {
+ logger.warn(
+ `${this.logPrefix()} Charging station information from template ${
+ this.templateFile
+ } with no connectors configuration defined, using already defined connectors`
+ );
}
- // Avoid duplication of connectors related information
- delete this.stationInfo.Connectors;
// Initialize transaction attributes on connectors
- for (const connector in this.connectors) {
- if (Utils.convertToInt(connector) > 0 && !this.getConnector(Utils.convertToInt(connector)).transactionStarted) {
- this.initTransactionAttributesOnConnector(Utils.convertToInt(connector));
+ for (const connectorId of this.connectors.keys()) {
+ if (connectorId > 0 && this.getConnectorStatus(connectorId).transactionStarted === true) {
+ logger.warn(
+ `${this.logPrefix()} Connector ${connectorId} at initialization has a transaction started: ${
+ this.getConnectorStatus(connectorId).transactionId
+ }`
+ );
+ }
+ if (
+ connectorId > 0 &&
+ (this.getConnectorStatus(connectorId).transactionStarted === undefined ||
+ this.getConnectorStatus(connectorId).transactionStarted === null)
+ ) {
+ this.initializeConnectorStatus(connectorId);
}
}
- switch (this.getOCPPVersion()) {
- case OCPPVersion.VERSION_16:
- this.ocppIncomingRequestService = new OCPP16IncomingRequestService(this);
- this.ocppRequestService = new OCPP16RequestService(this, new OCPP16ResponseService(this));
- break;
- default:
- this.handleUnsupportedVersion(this.getOCPPVersion());
- break;
+ }
+
+ private checkStationInfoConnectorStatus(
+ connectorId: number,
+ connectorStatus: ConnectorStatus
+ ): void {
+ if (!Utils.isNullOrUndefined(connectorStatus?.status)) {
+ logger.warn(
+ `${this.logPrefix()} Charging station information from template ${
+ this.templateFile
+ } with connector ${connectorId} status configuration defined, undefine it`
+ );
+ connectorStatus.status = undefined;
}
- // OCPP parameters
- this.addConfigurationKey(StandardParametersKey.NumberOfConnectors, this.getNumberOfConnectors().toString(), true);
- if (!this.getConfigurationKey(StandardParametersKey.MeterValuesSampledData)) {
- this.addConfigurationKey(StandardParametersKey.MeterValuesSampledData, MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER);
- }
- this.stationInfo.powerDivider = this.getPowerDivider();
- if (this.getEnableStatistics()) {
- this.performanceStatistics = new PerformanceStatistics(this.stationInfo.chargingStationId);
- this.performanceObserver = new PerformanceObserver((list) => {
- const entry = list.getEntries()[0];
- this.performanceStatistics.logPerformance(entry, Constants.ENTITY_CHARGING_STATION);
- this.performanceObserver.disconnect();
- });
+ }
+
+ private getConfigurationFromFile(): ChargingStationConfiguration | null {
+ let configuration: ChargingStationConfiguration = null;
+ if (this.configurationFile && fs.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(
+ fs.readFileSync(this.configurationFile, 'utf8')
+ ) as ChargingStationConfiguration;
+ PerformanceStatistics.endMeasure(measureId, beginId);
+ this.configurationFileHash = configuration.configurationHash;
+ this.sharedLRUCache.setChargingStationConfiguration(configuration);
+ }
+ } catch (error) {
+ FileUtils.handleFileException(
+ this.logPrefix(),
+ FileType.ChargingStationConfiguration,
+ this.configurationFile,
+ error as NodeJS.ErrnoException
+ );
+ }
}
+ return configuration;
}
- private async onOpen(): Promise<void> {
- logger.info(`${this.logPrefix()} Is connected to server through ${this.wsConnectionUrl}`);
- if (!this.isRegistered()) {
- // Send BootNotification
- let registrationRetryCount = 0;
- do {
- this.bootNotificationResponse = await this.ocppRequestService.sendBootNotification(this.bootNotificationRequest.chargePointModel,
- this.bootNotificationRequest.chargePointVendor, this.bootNotificationRequest.chargeBoxSerialNumber, this.bootNotificationRequest.firmwareVersion);
- if (!this.isRegistered()) {
- registrationRetryCount++;
- await Utils.sleep(this.bootNotificationResponse?.interval ? this.bootNotificationResponse.interval * 1000 : Constants.OCPP_DEFAULT_BOOT_NOTIFICATION_INTERVAL);
+ private saveConfiguration(): void {
+ if (this.configurationFile) {
+ try {
+ if (!fs.existsSync(path.dirname(this.configurationFile))) {
+ fs.mkdirSync(path.dirname(this.configurationFile), { recursive: true });
}
- } while (!this.isRegistered() && (registrationRetryCount <= this.getRegistrationMaxRetries() || this.getRegistrationMaxRetries() === -1));
+ const configurationData: ChargingStationConfiguration =
+ this.getConfigurationFromFile() ?? {};
+ this.ocppConfiguration?.configurationKey &&
+ (configurationData.configurationKey = this.ocppConfiguration.configurationKey);
+ this.stationInfo && (configurationData.stationInfo = this.stationInfo);
+ delete configurationData.configurationHash;
+ const configurationHash = crypto
+ .createHash(Constants.DEFAULT_HASH_ALGORITHM)
+ .update(JSON.stringify(configurationData))
+ .digest('hex');
+ if (this.configurationFileHash !== configurationHash) {
+ configurationData.configurationHash = configurationHash;
+ const measureId = `${FileType.ChargingStationConfiguration} write`;
+ const beginId = PerformanceStatistics.beginMeasure(measureId);
+ const fileDescriptor = fs.openSync(this.configurationFile, 'w');
+ fs.writeFileSync(fileDescriptor, JSON.stringify(configurationData, null, 2), 'utf8');
+ fs.closeSync(fileDescriptor);
+ PerformanceStatistics.endMeasure(measureId, beginId);
+ this.sharedLRUCache.deleteChargingStationConfiguration(this.configurationFileHash);
+ this.configurationFileHash = configurationHash;
+ this.sharedLRUCache.setChargingStationConfiguration(configurationData);
+ } else {
+ logger.debug(
+ `${this.logPrefix()} Not saving unchanged charging station configuration file ${
+ this.configurationFile
+ }`
+ );
+ }
+ } catch (error) {
+ FileUtils.handleFileException(
+ this.logPrefix(),
+ FileType.ChargingStationConfiguration,
+ this.configurationFile,
+ error as NodeJS.ErrnoException
+ );
+ }
+ } else {
+ logger.error(
+ `${this.logPrefix()} Trying to save charging station configuration to undefined configuration file`
+ );
}
- if (this.isRegistered()) {
- await this.startMessageSequence();
- this.hasStopped && (this.hasStopped = false);
- if (this.hasSocketRestarted && this.isWebSocketOpen()) {
- this.flushMessageQueue();
+ }
+
+ private getOcppConfigurationFromTemplate(): ChargingStationOcppConfiguration | null {
+ return this.getTemplateFromFile()?.Configuration ?? null;
+ }
+
+ private getOcppConfigurationFromFile(): ChargingStationOcppConfiguration | null {
+ let configuration: ChargingStationConfiguration = null;
+ if (this.getOcppPersistentConfiguration() === true) {
+ const configurationFromFile = this.getConfigurationFromFile();
+ configuration = configurationFromFile?.configurationKey && configurationFromFile;
+ }
+ configuration && delete configuration.stationInfo;
+ return configuration;
+ }
+
+ private getOcppConfiguration(): ChargingStationOcppConfiguration | null {
+ let ocppConfiguration: ChargingStationOcppConfiguration = this.getOcppConfigurationFromFile();
+ if (!ocppConfiguration) {
+ ocppConfiguration = this.getOcppConfigurationFromTemplate();
+ }
+ return ocppConfiguration;
+ }
+
+ private async onOpen(): Promise<void> {
+ if (this.isWebSocketConnectionOpened() === true) {
+ logger.info(
+ `${this.logPrefix()} Connection to OCPP server through ${this.wsConnectionUrl.toString()} succeeded`
+ );
+ if (this.isRegistered() === false) {
+ // Send BootNotification
+ let registrationRetryCount = 0;
+ do {
+ this.bootNotificationResponse = await this.ocppRequestService.requestHandler<
+ BootNotificationRequest,
+ BootNotificationResponse
+ >(this, RequestCommand.BOOT_NOTIFICATION, this.bootNotificationRequest, {
+ skipBufferingOnError: true,
+ });
+ if (this.isRegistered() === false) {
+ this.getRegistrationMaxRetries() !== -1 && registrationRetryCount++;
+ await Utils.sleep(
+ this.bootNotificationResponse?.interval
+ ? this.bootNotificationResponse.interval * 1000
+ : Constants.OCPP_DEFAULT_BOOT_NOTIFICATION_INTERVAL
+ );
+ }
+ } while (
+ this.isRegistered() === false &&
+ (registrationRetryCount <= this.getRegistrationMaxRetries() ||
+ this.getRegistrationMaxRetries() === -1)
+ );
+ }
+ if (this.isRegistered() === true) {
+ if (this.isInAcceptedState() === true) {
+ await this.startMessageSequence();
+ }
+ } else {
+ logger.error(
+ `${this.logPrefix()} Registration failure: max retries reached (${this.getRegistrationMaxRetries()}) or retry disabled (${this.getRegistrationMaxRetries()})`
+ );
}
+ this.wsConnectionRestarted = false;
+ this.autoReconnectRetryCount = 0;
+ parentPort.postMessage(MessageChannelUtils.buildUpdatedMessage(this));
} else {
- logger.error(`${this.logPrefix()} Registration failure: max retries reached (${this.getRegistrationMaxRetries()}) or retry disabled (${this.getRegistrationMaxRetries()})`);
+ logger.warn(
+ `${this.logPrefix()} Connection to OCPP server through ${this.wsConnectionUrl.toString()} failed`
+ );
}
- this.autoReconnectRetryCount = 0;
- this.hasSocketRestarted = false;
}
- private async onClose(closeEvent: any): Promise<void> {
- switch (closeEvent) {
- case WebSocketCloseEventStatusCode.CLOSE_NORMAL: // Normal close
+ private async onClose(code: number, reason: Buffer): Promise<void> {
+ switch (code) {
+ // Normal close
+ case WebSocketCloseEventStatusCode.CLOSE_NORMAL:
case WebSocketCloseEventStatusCode.CLOSE_NO_STATUS:
- logger.info(`${this.logPrefix()} Socket normally closed with status '${Utils.getWebSocketCloseEventStatusString(closeEvent)}'`);
+ logger.info(
+ `${this.logPrefix()} WebSocket normally closed with status '${Utils.getWebSocketCloseEventStatusString(
+ code
+ )}' and reason '${reason.toString()}'`
+ );
this.autoReconnectRetryCount = 0;
break;
- default: // Abnormal close
- logger.error(`${this.logPrefix()} Socket abnormally closed with status '${Utils.getWebSocketCloseEventStatusString(closeEvent)}'`);
- await this.reconnect(closeEvent);
+ // Abnormal close
+ default:
+ logger.error(
+ `${this.logPrefix()} WebSocket abnormally closed with status '${Utils.getWebSocketCloseEventStatusString(
+ code
+ )}' and reason '${reason.toString()}'`
+ );
+ this.started === true && (await this.reconnect());
break;
}
- }
-
- private async onMessage(messageEvent: MessageEvent): Promise<void> {
- let [messageType, messageId, commandName, commandPayload, errorDetails]: IncomingRequest = [0, '', '' as IncomingRequestCommand, {}, {}];
- let responseCallback: (payload: Record<string, unknown> | string, requestPayload: Record<string, unknown>) => void;
- let rejectCallback: (error: OCPPError) => void;
- let requestPayload: Record<string, unknown>;
+ parentPort.postMessage(MessageChannelUtils.buildUpdatedMessage(this));
+ }
+
+ private async onMessage(data: RawData): Promise<void> {
+ let messageType: number;
+ let messageId: string;
+ let commandName: IncomingRequestCommand;
+ let commandPayload: JsonType;
+ let errorType: ErrorType;
+ let errorMessage: string;
+ let errorDetails: JsonType;
+ let responseCallback: ResponseCallback;
+ let errorCallback: ErrorCallback;
+ let requestCommandName: RequestCommand | IncomingRequestCommand;
+ let requestPayload: JsonType;
+ let cachedRequest: CachedRequest;
let errMsg: string;
try {
- // Parse the message
- [messageType, messageId, commandName, commandPayload, errorDetails] = JSON.parse(messageEvent.toString()) as IncomingRequest;
-
- // Check the Type of message
+ const request = JSON.parse(data.toString()) as IncomingRequest | Response | ErrorResponse;
+ if (Array.isArray(request) === true) {
+ [messageType, messageId] = request;
+ // Check the type of message
+ switch (messageType) {
+ // Incoming Message
+ case MessageType.CALL_MESSAGE:
+ [, , commandName, commandPayload] = request as IncomingRequest;
+ if (this.getEnableStatistics() === 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,
+ messageId,
+ commandName,
+ commandPayload
+ );
+ break;
+ // Outcome Message
+ case MessageType.CALL_RESULT_MESSAGE:
+ [, , commandPayload] = request as Response;
+ if (this.requests.has(messageId) === false) {
+ // Error
+ throw new OCPPError(
+ ErrorType.INTERNAL_ERROR,
+ `Response for unknown message id ${messageId}`,
+ null,
+ commandPayload
+ );
+ }
+ // Respond
+ cachedRequest = this.requests.get(messageId);
+ if (Array.isArray(cachedRequest) === true) {
+ [responseCallback, errorCallback, requestCommandName, requestPayload] = cachedRequest;
+ } else {
+ throw new OCPPError(
+ ErrorType.PROTOCOL_ERROR,
+ `Cached request for message id ${messageId} response is not an array`,
+ null,
+ cachedRequest as unknown as JsonType
+ );
+ }
+ logger.debug(
+ `${this.logPrefix()} << Command '${
+ requestCommandName ?? Constants.UNKNOWN_COMMAND
+ }' received response payload: ${JSON.stringify(request)}`
+ );
+ responseCallback(commandPayload, requestPayload);
+ break;
+ // Error Message
+ case MessageType.CALL_ERROR_MESSAGE:
+ [, , errorType, errorMessage, errorDetails] = request as ErrorResponse;
+ if (this.requests.has(messageId) === false) {
+ // Error
+ throw new OCPPError(
+ ErrorType.INTERNAL_ERROR,
+ `Error response for unknown message id ${messageId}`,
+ null,
+ { errorType, errorMessage, errorDetails }
+ );
+ }
+ cachedRequest = this.requests.get(messageId);
+ if (Array.isArray(cachedRequest) === true) {
+ [, errorCallback, requestCommandName] = cachedRequest;
+ } else {
+ throw new OCPPError(
+ ErrorType.PROTOCOL_ERROR,
+ `Cached request for message id ${messageId} error response is not an array`,
+ null,
+ cachedRequest as unknown as JsonType
+ );
+ }
+ logger.debug(
+ `${this.logPrefix()} << Command '${
+ requestCommandName ?? Constants.UNKNOWN_COMMAND
+ }' received error response payload: ${JSON.stringify(request)}`
+ );
+ errorCallback(new OCPPError(errorType, errorMessage, requestCommandName, errorDetails));
+ break;
+ // Error
+ default:
+ // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
+ errMsg = `Wrong message type ${messageType}`;
+ logger.error(`${this.logPrefix()} ${errMsg}`);
+ throw new OCPPError(ErrorType.PROTOCOL_ERROR, errMsg);
+ }
+ parentPort.postMessage(MessageChannelUtils.buildUpdatedMessage(this));
+ } else {
+ throw new OCPPError(ErrorType.PROTOCOL_ERROR, 'Incoming message is not an array', null, {
+ request,
+ });
+ }
+ } catch (error) {
+ // Log
+ logger.error(
+ `${this.logPrefix()} Incoming OCPP command '${
+ commandName ?? requestCommandName ?? Constants.UNKNOWN_COMMAND
+ }' message '${data.toString()}'${
+ messageType !== MessageType.CALL_MESSAGE
+ ? ` matching cached request '${JSON.stringify(this.requests.get(messageId))}'`
+ : ''
+ } processing error:`,
+ error
+ );
+ if (error instanceof OCPPError === false) {
+ logger.warn(
+ `${this.logPrefix()} Error thrown at incoming OCPP command '${
+ commandName ?? requestCommandName ?? Constants.UNKNOWN_COMMAND
+ }' message '${data.toString()}' handling is not an OCPPError:`,
+ error
+ );
+ }
switch (messageType) {
- // Incoming Message
case MessageType.CALL_MESSAGE:
- if (this.getEnableStatistics()) {
- this.performanceStatistics.addMessage(commandName, messageType);
- }
- // Process the call
- await this.ocppIncomingRequestService.handleRequest(messageId, commandName, commandPayload);
+ // Send error
+ await this.ocppRequestService.sendError(
+ this,
+ messageId,
+ error as OCPPError,
+ commandName ?? requestCommandName ?? null
+ );
break;
- // Outcome Message
case MessageType.CALL_RESULT_MESSAGE:
- // Respond
- if (Utils.isIterable(this.requests[messageId])) {
- [responseCallback, , requestPayload] = this.requests[messageId];
- } else {
- throw new Error(`Response request for message id ${messageId} is not iterable`);
- }
- if (!responseCallback) {
- // Error
- throw new Error(`Response request for unknown message id ${messageId}`);
- }
- delete this.requests[messageId];
- responseCallback(commandName, requestPayload);
- break;
- // Error Message
case MessageType.CALL_ERROR_MESSAGE:
- if (!this.requests[messageId]) {
- // Error
- throw new Error(`Error request for unknown message id ${messageId}`);
- }
- if (Utils.isIterable(this.requests[messageId])) {
- [, rejectCallback] = this.requests[messageId];
+ if (errorCallback) {
+ // 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 {
- throw new Error(`Error request for message id ${messageId} is not iterable`);
+ // Remove the request from the cache in case of error at response handling
+ this.requests.delete(messageId);
}
- delete this.requests[messageId];
- rejectCallback(new OCPPError(commandName, commandPayload.toString(), errorDetails));
break;
- // Error
- default:
- errMsg = `${this.logPrefix()} Wrong message type ${messageType}`;
- logger.error(errMsg);
- throw new Error(errMsg);
}
- } catch (error) {
- // Log
- logger.error('%s Incoming message %j processing error %j on request content type %j', this.logPrefix(), messageEvent, error, this.requests[messageId]);
- // Send error
- messageType !== MessageType.CALL_ERROR_MESSAGE && await this.ocppRequestService.sendError(messageId, error, commandName);
}
}
private onPing(): void {
- logger.debug(this.logPrefix() + ' Has received a WS ping (rfc6455) from the server');
+ logger.debug(`${this.logPrefix()} Received a WS ping (rfc6455) from the server`);
}
private onPong(): void {
- logger.debug(this.logPrefix() + ' Has received a WS pong (rfc6455) from the server');
+ logger.debug(`${this.logPrefix()} Received a WS pong (rfc6455) from the server`);
}
- private async onError(errorEvent: any): Promise<void> {
- logger.error(this.logPrefix() + ' Socket error: %j', errorEvent);
- // switch (errorEvent.code) {
- // case 'ECONNREFUSED':
- // await this._reconnect(errorEvent);
- // break;
- // }
+ private onError(error: WSError): void {
+ this.closeWSConnection();
+ logger.error(`${this.logPrefix()} WebSocket error:`, error);
}
- private getTemplateChargingStationConfiguration(): ChargingStationConfiguration {
- return this.stationInfo.Configuration ? this.stationInfo.Configuration : {} as ChargingStationConfiguration;
- }
-
- private getAuthorizationFile(): string | undefined {
- return this.stationInfo.authorizationFile && path.join(path.resolve(__dirname, '../'), 'assets', path.basename(this.stationInfo.authorizationFile));
- }
-
- private getAuthorizedTags(): string[] {
- let authorizedTags: string[] = [];
- const authorizationFile = this.getAuthorizationFile();
- if (authorizationFile) {
- try {
- // Load authorization file
- const fileDescriptor = fs.openSync(authorizationFile, 'r');
- authorizedTags = JSON.parse(fs.readFileSync(fileDescriptor, 'utf8')) as string[];
- fs.closeSync(fileDescriptor);
- } catch (error) {
- FileUtils.handleFileException(this.logPrefix(), 'Authorization', authorizationFile, error);
- }
- } else {
- logger.info(this.logPrefix() + ' No authorization file given in template file ' + this.stationTemplateFile);
+ private getEnergyActiveImportRegister(connectorStatus: ConnectorStatus, rounded = false): number {
+ if (this.getMeteringPerTransaction() === true) {
+ return (
+ (rounded === true
+ ? Math.round(connectorStatus?.transactionEnergyActiveImportRegisterValue)
+ : connectorStatus?.transactionEnergyActiveImportRegisterValue) ?? 0
+ );
}
- return authorizedTags;
+ return (
+ (rounded === true
+ ? Math.round(connectorStatus?.energyActiveImportRegisterValue)
+ : connectorStatus?.energyActiveImportRegisterValue) ?? 0
+ );
}
- private getUseConnectorId0(): boolean | undefined {
- return !Utils.isUndefined(this.stationInfo.useConnectorId0) ? this.stationInfo.useConnectorId0 : true;
+ private getUseConnectorId0(stationInfo?: ChargingStationInfo): boolean {
+ const localStationInfo = stationInfo ?? this.stationInfo;
+ return !Utils.isUndefined(localStationInfo.useConnectorId0)
+ ? localStationInfo.useConnectorId0
+ : true;
}
private getNumberOfRunningTransactions(): number {
let trxCount = 0;
- for (const connector in this.connectors) {
- if (Utils.convertToInt(connector) > 0 && this.getConnector(Utils.convertToInt(connector)).transactionStarted) {
+ for (const connectorId of this.connectors.keys()) {
+ if (connectorId > 0 && this.getConnectorStatus(connectorId)?.transactionStarted === true) {
trxCount++;
}
}
return trxCount;
}
- // 0 for disabling
- private getConnectionTimeout(): number | undefined {
- if (!Utils.isUndefined(this.stationInfo.connectionTimeout)) {
- return this.stationInfo.connectionTimeout;
+ private async stopRunningTransactions(reason = StopTransactionReason.NONE): Promise<void> {
+ for (const connectorId of this.connectors.keys()) {
+ if (connectorId > 0 && this.getConnectorStatus(connectorId)?.transactionStarted === true) {
+ await this.stopTransactionOnConnector(connectorId, reason);
+ }
}
- if (!Utils.isUndefined(Configuration.getConnectionTimeout())) {
- return Configuration.getConnectionTimeout();
+ }
+
+ // 0 for disabling
+ private getConnectionTimeout(): number {
+ if (
+ ChargingStationConfigurationUtils.getConfigurationKey(
+ this,
+ StandardParametersKey.ConnectionTimeOut
+ )
+ ) {
+ return (
+ parseInt(
+ ChargingStationConfigurationUtils.getConfigurationKey(
+ this,
+ StandardParametersKey.ConnectionTimeOut
+ ).value
+ ) ?? Constants.DEFAULT_CONNECTION_TIMEOUT
+ );
}
- return 30;
+ return Constants.DEFAULT_CONNECTION_TIMEOUT;
}
// -1 for unlimited, 0 for disabling
- private getAutoReconnectMaxRetries(): number | undefined {
+ private getAutoReconnectMaxRetries(): number {
if (!Utils.isUndefined(this.stationInfo.autoReconnectMaxRetries)) {
return this.stationInfo.autoReconnectMaxRetries;
}
}
// 0 for disabling
- private getRegistrationMaxRetries(): number | undefined {
+ private getRegistrationMaxRetries(): number {
if (!Utils.isUndefined(this.stationInfo.registrationMaxRetries)) {
return this.stationInfo.registrationMaxRetries;
}
private getPowerDivider(): number {
let powerDivider = this.getNumberOfConnectors();
- if (this.stationInfo.powerSharedByConnectors) {
+ if (this.stationInfo?.powerSharedByConnectors) {
powerDivider = this.getNumberOfRunningTransactions();
}
return powerDivider;
}
- private getTemplateMaxNumberOfConnectors(): number {
- return Object.keys(this.stationInfo.Connectors).length;
- }
-
- private getMaxNumberOfConnectors(): number {
- let maxConnectors = 0;
- if (!Utils.isEmptyArray(this.stationInfo.numberOfConnectors)) {
- const numberOfConnectors = this.stationInfo.numberOfConnectors as number[];
- // Distribute evenly the number of connectors
- maxConnectors = numberOfConnectors[(this.index - 1) % numberOfConnectors.length];
- } else if (!Utils.isUndefined(this.stationInfo.numberOfConnectors)) {
- maxConnectors = this.stationInfo.numberOfConnectors as number;
- } else {
- maxConnectors = this.stationInfo.Connectors[0] ? this.getTemplateMaxNumberOfConnectors() - 1 : this.getTemplateMaxNumberOfConnectors();
+ private getMaximumAmperage(stationInfo: ChargingStationInfo): number | undefined {
+ const maximumPower = this.getMaximumPower(stationInfo);
+ switch (this.getCurrentOutType(stationInfo)) {
+ case CurrentType.AC:
+ return ACElectricUtils.amperagePerPhaseFromPower(
+ this.getNumberOfPhases(stationInfo),
+ maximumPower / this.getNumberOfConnectors(),
+ this.getVoltageOut(stationInfo)
+ );
+ case CurrentType.DC:
+ return DCElectricUtils.amperage(maximumPower, this.getVoltageOut(stationInfo));
}
- return maxConnectors;
}
- private getNumberOfConnectors(): number {
- return this.connectors[0] ? Object.keys(this.connectors).length - 1 : Object.keys(this.connectors).length;
+ private getAmperageLimitation(): number | undefined {
+ if (
+ this.stationInfo.amperageLimitationOcppKey &&
+ ChargingStationConfigurationUtils.getConfigurationKey(
+ this,
+ this.stationInfo.amperageLimitationOcppKey
+ )
+ ) {
+ return (
+ Utils.convertToInt(
+ ChargingStationConfigurationUtils.getConfigurationKey(
+ this,
+ this.stationInfo.amperageLimitationOcppKey
+ ).value
+ ) / ChargingStationUtils.getAmperageLimitationUnitDivider(this.stationInfo)
+ );
+ }
}
private async startMessageSequence(): Promise<void> {
+ if (this.stationInfo?.autoRegister === true) {
+ await this.ocppRequestService.requestHandler<
+ BootNotificationRequest,
+ BootNotificationResponse
+ >(this, RequestCommand.BOOT_NOTIFICATION, this.bootNotificationRequest, {
+ skipBufferingOnError: true,
+ });
+ }
// Start WebSocket ping
this.startWebSocketPing();
// Start heartbeat
this.startHeartbeat();
// Initialize connectors status
- for (const connector in this.connectors) {
- if (Utils.convertToInt(connector) === 0) {
+ for (const connectorId of this.connectors.keys()) {
+ let connectorStatus: ConnectorStatusEnum;
+ if (connectorId === 0) {
continue;
- } else if (!this.hasStopped && !this.getConnector(Utils.convertToInt(connector))?.status && this.getConnector(Utils.convertToInt(connector))?.bootStatus) {
- // Send status in template at startup
- await this.ocppRequestService.sendStatusNotification(Utils.convertToInt(connector), this.getConnector(Utils.convertToInt(connector)).bootStatus);
- this.getConnector(Utils.convertToInt(connector)).status = this.getConnector(Utils.convertToInt(connector)).bootStatus;
- } else if (this.hasStopped && this.getConnector(Utils.convertToInt(connector))?.bootStatus) {
- // Send status in template after reset
- await this.ocppRequestService.sendStatusNotification(Utils.convertToInt(connector), this.getConnector(Utils.convertToInt(connector)).bootStatus);
- this.getConnector(Utils.convertToInt(connector)).status = this.getConnector(Utils.convertToInt(connector)).bootStatus;
- } else if (!this.hasStopped && this.getConnector(Utils.convertToInt(connector))?.status) {
- // Send previous status at template reload
- await this.ocppRequestService.sendStatusNotification(Utils.convertToInt(connector), this.getConnector(Utils.convertToInt(connector)).status);
+ } else if (
+ !this.getConnectorStatus(connectorId)?.status &&
+ (this.isChargingStationAvailable() === false ||
+ this.isConnectorAvailable(connectorId) === false)
+ ) {
+ connectorStatus = ConnectorStatusEnum.UNAVAILABLE;
+ } else if (
+ !this.getConnectorStatus(connectorId)?.status &&
+ this.getConnectorStatus(connectorId)?.bootStatus
+ ) {
+ // Set boot status in template at startup
+ connectorStatus = this.getConnectorStatus(connectorId).bootStatus;
+ } else if (this.getConnectorStatus(connectorId)?.status) {
+ // Set previous status at startup
+ connectorStatus = this.getConnectorStatus(connectorId).status;
} else {
- // Send default status
- await this.ocppRequestService.sendStatusNotification(Utils.convertToInt(connector), ChargePointStatus.AVAILABLE);
- this.getConnector(Utils.convertToInt(connector)).status = ChargePointStatus.AVAILABLE;
+ // Set default status
+ connectorStatus = ConnectorStatusEnum.AVAILABLE;
}
+ await this.ocppRequestService.requestHandler<
+ StatusNotificationRequest,
+ StatusNotificationResponse
+ >(
+ this,
+ RequestCommand.STATUS_NOTIFICATION,
+ OCPPServiceUtils.buildStatusNotificationRequest(this, connectorId, connectorStatus)
+ );
+ this.getConnectorStatus(connectorId).status = connectorStatus;
}
- // Start the ATG
- this.startAutomaticTransactionGenerator();
- if (this.getEnableStatistics()) {
- this.performanceStatistics.start();
+ 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;
}
- }
- private startAutomaticTransactionGenerator() {
- if (this.stationInfo.AutomaticTransactionGenerator.enable) {
- if (!this.automaticTransactionGeneration) {
- this.automaticTransactionGeneration = new AutomaticTransactionGenerator(this);
- }
- if (this.automaticTransactionGeneration.timeToStop) {
- // The ATG might sleep
- void this.automaticTransactionGeneration.start();
- }
+ // Start the ATG
+ if (this.getAutomaticTransactionGeneratorConfigurationFromTemplate()?.enable === true) {
+ this.startAutomaticTransactionGenerator();
}
+ this.wsConnectionRestarted === true && this.flushMessageBuffer();
}
- private async stopMessageSequence(reason: StopTransactionReason = StopTransactionReason.NONE): Promise<void> {
+ private async stopMessageSequence(
+ reason: StopTransactionReason = StopTransactionReason.NONE
+ ): Promise<void> {
// Stop WebSocket ping
this.stopWebSocketPing();
// Stop heartbeat
this.stopHeartbeat();
- // Stop the ATG
- if (this.stationInfo.AutomaticTransactionGenerator.enable &&
- this.automaticTransactionGeneration &&
- !this.automaticTransactionGeneration.timeToStop) {
- await this.automaticTransactionGeneration.stop(reason);
+ // Stop ongoing transactions
+ if (this.automaticTransactionGenerator?.started === true) {
+ this.stopAutomaticTransactionGenerator();
} else {
- for (const connector in this.connectors) {
- if (Utils.convertToInt(connector) > 0 && this.getConnector(Utils.convertToInt(connector)).transactionStarted) {
- const transactionId = this.getConnector(Utils.convertToInt(connector)).transactionId;
- await this.ocppRequestService.sendStopTransaction(transactionId, this.getEnergyActiveImportRegisterByTransactionId(transactionId),
- this.getTransactionIdTag(transactionId), reason);
- }
+ await this.stopRunningTransactions(reason);
+ }
+ for (const connectorId of this.connectors.keys()) {
+ if (connectorId > 0) {
+ await this.ocppRequestService.requestHandler<
+ StatusNotificationRequest,
+ StatusNotificationResponse
+ >(
+ this,
+ RequestCommand.STATUS_NOTIFICATION,
+ OCPPServiceUtils.buildStatusNotificationRequest(
+ this,
+ connectorId,
+ ConnectorStatusEnum.UNAVAILABLE
+ )
+ );
+ this.getConnectorStatus(connectorId).status = null;
}
}
}
private startWebSocketPing(): void {
- const webSocketPingInterval: number = this.getConfigurationKey(StandardParametersKey.WebSocketPingInterval)
- ? Utils.convertToInt(this.getConfigurationKey(StandardParametersKey.WebSocketPingInterval).value)
+ const webSocketPingInterval: number = ChargingStationConfigurationUtils.getConfigurationKey(
+ this,
+ StandardParametersKey.WebSocketPingInterval
+ )
+ ? Utils.convertToInt(
+ ChargingStationConfigurationUtils.getConfigurationKey(
+ this,
+ StandardParametersKey.WebSocketPingInterval
+ ).value
+ )
: 0;
if (webSocketPingInterval > 0 && !this.webSocketPingSetInterval) {
this.webSocketPingSetInterval = setInterval(() => {
- if (this.isWebSocketOpen()) {
- this.wsConnection.ping((): void => { });
+ if (this.isWebSocketConnectionOpened() === true) {
+ this.wsConnection.ping();
}
}, webSocketPingInterval * 1000);
- logger.info(this.logPrefix() + ' WebSocket ping started every ' + Utils.secondsToHHMMSS(webSocketPingInterval));
+ logger.info(
+ `${this.logPrefix()} WebSocket ping started every ${Utils.formatDurationSeconds(
+ webSocketPingInterval
+ )}`
+ );
} else if (this.webSocketPingSetInterval) {
- logger.info(this.logPrefix() + ' WebSocket ping every ' + Utils.secondsToHHMMSS(webSocketPingInterval) + ' already started');
+ logger.info(
+ `${this.logPrefix()} WebSocket ping already started every ${Utils.formatDurationSeconds(
+ webSocketPingInterval
+ )}`
+ );
} else {
- logger.error(`${this.logPrefix()} WebSocket ping interval set to ${webSocketPingInterval ? Utils.secondsToHHMMSS(webSocketPingInterval) : webSocketPingInterval}, not starting the WebSocket ping`);
+ logger.error(
+ `${this.logPrefix()} WebSocket ping interval set to ${
+ webSocketPingInterval
+ ? Utils.formatDurationSeconds(webSocketPingInterval)
+ : webSocketPingInterval
+ }, not starting the WebSocket ping`
+ );
}
}
}
}
- private getSupervisionURL(): string {
- const supervisionUrls = Utils.cloneObject<string | string[]>(this.stationInfo.supervisionURL ? this.stationInfo.supervisionURL : Configuration.getSupervisionURLs());
- let indexUrl = 0;
+ private getConfiguredSupervisionUrl(): URL {
+ const supervisionUrls = this.stationInfo.supervisionUrls ?? Configuration.getSupervisionUrls();
if (!Utils.isEmptyArray(supervisionUrls)) {
- if (Configuration.getDistributeStationsToTenantsEqually()) {
- indexUrl = this.index % supervisionUrls.length;
- } else {
- // Get a random url
- indexUrl = Math.floor(Math.random() * supervisionUrls.length);
+ switch (Configuration.getSupervisionUrlDistribution()) {
+ case SupervisionUrlDistribution.ROUND_ROBIN:
+ // FIXME
+ this.configuredSupervisionUrlIndex = (this.index - 1) % supervisionUrls.length;
+ break;
+ case SupervisionUrlDistribution.RANDOM:
+ this.configuredSupervisionUrlIndex = Math.floor(
+ Utils.secureRandom() * supervisionUrls.length
+ );
+ break;
+ case SupervisionUrlDistribution.CHARGING_STATION_AFFINITY:
+ this.configuredSupervisionUrlIndex = (this.index - 1) % supervisionUrls.length;
+ break;
+ default:
+ logger.error(
+ `${this.logPrefix()} Unknown supervision url distribution '${Configuration.getSupervisionUrlDistribution()}' from values '${SupervisionUrlDistribution.toString()}', defaulting to ${
+ SupervisionUrlDistribution.CHARGING_STATION_AFFINITY
+ }`
+ );
+ this.configuredSupervisionUrlIndex = (this.index - 1) % supervisionUrls.length;
+ break;
}
- return supervisionUrls[indexUrl];
+ return new URL(supervisionUrls[this.configuredSupervisionUrlIndex]);
}
- return supervisionUrls as string;
+ return new URL(supervisionUrls as string);
}
- private getHeartbeatInterval(): number | undefined {
- const HeartbeatInterval = this.getConfigurationKey(StandardParametersKey.HeartbeatInterval);
+ private getHeartbeatInterval(): number {
+ const HeartbeatInterval = ChargingStationConfigurationUtils.getConfigurationKey(
+ this,
+ StandardParametersKey.HeartbeatInterval
+ );
if (HeartbeatInterval) {
return Utils.convertToInt(HeartbeatInterval.value) * 1000;
}
- const HeartBeatInterval = this.getConfigurationKey(StandardParametersKey.HeartBeatInterval);
+ const HeartBeatInterval = ChargingStationConfigurationUtils.getConfigurationKey(
+ this,
+ StandardParametersKey.HeartBeatInterval
+ );
if (HeartBeatInterval) {
return Utils.convertToInt(HeartBeatInterval.value) * 1000;
}
+ this.stationInfo?.autoRegister === false &&
+ logger.warn(
+ `${this.logPrefix()} Heartbeat interval configuration key not set, using default value: ${
+ Constants.DEFAULT_HEARTBEAT_INTERVAL
+ }`
+ );
+ return Constants.DEFAULT_HEARTBEAT_INTERVAL;
}
private stopHeartbeat(): void {
}
}
- private openWSConnection(options?: WebSocket.ClientOptions, forceCloseOpened = false): void {
- options ?? {} as WebSocket.ClientOptions;
- options?.handshakeTimeout ?? this.getConnectionTimeout() * 1000;
- if (this.isWebSocketOpen() && forceCloseOpened) {
- this.wsConnection.close();
+ private terminateWSConnection(): void {
+ if (this.isWebSocketConnectionOpened() === true) {
+ this.wsConnection.terminate();
+ this.wsConnection = null;
}
- let protocol;
- switch (this.getOCPPVersion()) {
- case OCPPVersion.VERSION_16:
- protocol = 'ocpp' + OCPPVersion.VERSION_16;
- break;
- default:
- this.handleUnsupportedVersion(this.getOCPPVersion());
- break;
- }
- this.wsConnection = new WebSocket(this.wsConnectionUrl, protocol, options);
- logger.info(this.logPrefix() + ' Will communicate through URL ' + this.supervisionUrl);
}
private stopMeterValues(connectorId: number) {
- if (this.getConnector(connectorId)?.transactionSetInterval) {
- clearInterval(this.getConnector(connectorId).transactionSetInterval);
+ if (this.getConnectorStatus(connectorId)?.transactionSetInterval) {
+ clearInterval(this.getConnectorStatus(connectorId).transactionSetInterval);
}
}
- private startAuthorizationFileMonitoring(): void {
- const authorizationFile = this.getAuthorizationFile();
- if (authorizationFile) {
- try {
- fs.watch(authorizationFile).on('change', (e) => {
- try {
- logger.debug(this.logPrefix() + ' Authorization file ' + authorizationFile + ' have changed, reload');
- // Initialize authorizedTags
- this.authorizedTags = this.getAuthorizedTags();
- } catch (error) {
- logger.error(this.logPrefix() + ' Authorization file monitoring error: %j', error);
- }
- });
- } catch (error) {
- FileUtils.handleFileException(this.logPrefix(), 'Authorization', authorizationFile, error);
- }
- } else {
- logger.info(this.logPrefix() + ' No authorization file given in template file ' + this.stationTemplateFile + '. Not monitoring changes');
- }
- }
-
- private startStationTemplateFileMonitoring(): void {
- try {
- // eslint-disable-next-line @typescript-eslint/no-misused-promises
- fs.watch(this.stationTemplateFile).on('change', async (e): Promise<void> => {
- try {
- logger.debug(this.logPrefix() + ' Template file ' + this.stationTemplateFile + ' have changed, reload');
- // Initialize
- this.initialize();
- // Stop the ATG
- if (!this.stationInfo.AutomaticTransactionGenerator.enable &&
- this.automaticTransactionGeneration) {
- await this.automaticTransactionGeneration.stop();
- }
- // Start the ATG
- this.startAutomaticTransactionGenerator();
- // FIXME?: restart heartbeat and WebSocket ping when their interval values have changed
- } catch (error) {
- logger.error(this.logPrefix() + ' Charging station template file monitoring error: %j', error);
- }
- });
- } catch (error) {
- FileUtils.handleFileException(this.logPrefix(), 'Template', this.stationTemplateFile, error);
- }
+ private getReconnectExponentialDelay(): boolean {
+ return !Utils.isUndefined(this.stationInfo.reconnectExponentialDelay)
+ ? this.stationInfo.reconnectExponentialDelay
+ : false;
}
- private getReconnectExponentialDelay(): boolean | undefined {
- return !Utils.isUndefined(this.stationInfo.reconnectExponentialDelay) ? this.stationInfo.reconnectExponentialDelay : false;
- }
-
- private async reconnect(error: any): Promise<void> {
+ private async reconnect(): Promise<void> {
+ // Stop WebSocket ping
+ this.stopWebSocketPing();
// Stop heartbeat
this.stopHeartbeat();
// Stop the ATG if needed
- if (this.stationInfo.AutomaticTransactionGenerator.enable &&
- this.stationInfo.AutomaticTransactionGenerator.stopOnConnectionFailure &&
- this.automaticTransactionGeneration &&
- !this.automaticTransactionGeneration.timeToStop) {
- await this.automaticTransactionGeneration.stop();
+ if (this.automaticTransactionGenerator?.configuration?.stopOnConnectionFailure === true) {
+ this.stopAutomaticTransactionGenerator();
}
- if (this.autoReconnectRetryCount < this.getAutoReconnectMaxRetries() || this.getAutoReconnectMaxRetries() === -1) {
+ if (
+ this.autoReconnectRetryCount < this.getAutoReconnectMaxRetries() ||
+ this.getAutoReconnectMaxRetries() === -1
+ ) {
this.autoReconnectRetryCount++;
- const reconnectDelay = (this.getReconnectExponentialDelay() ? Utils.exponentialDelay(this.autoReconnectRetryCount) : this.getConnectionTimeout() * 1000);
- logger.error(`${this.logPrefix()} Socket: connection retry in ${Utils.roundTo(reconnectDelay, 2)}ms, timeout ${reconnectDelay - 100}ms`);
+ const reconnectDelay = this.getReconnectExponentialDelay()
+ ? Utils.exponentialDelay(this.autoReconnectRetryCount)
+ : this.getConnectionTimeout() * 1000;
+ const reconnectDelayWithdraw = 1000;
+ const reconnectTimeout =
+ reconnectDelay && reconnectDelay - reconnectDelayWithdraw > 0
+ ? reconnectDelay - reconnectDelayWithdraw
+ : 0;
+ logger.error(
+ `${this.logPrefix()} WebSocket connection retry in ${Utils.roundTo(
+ reconnectDelay,
+ 2
+ )}ms, timeout ${reconnectTimeout}ms`
+ );
await Utils.sleep(reconnectDelay);
- logger.error(this.logPrefix() + ' Socket: reconnecting try #' + this.autoReconnectRetryCount.toString());
- this.openWSConnection({ handshakeTimeout: reconnectDelay - 100 });
- this.hasSocketRestarted = true;
+ logger.error(
+ `${this.logPrefix()} WebSocket connection retry #${this.autoReconnectRetryCount.toString()}`
+ );
+ this.openWSConnection(
+ { ...(this.stationInfo?.wsOptions ?? {}), handshakeTimeout: reconnectTimeout },
+ { closeOpened: true }
+ );
+ this.wsConnectionRestarted = true;
} else if (this.getAutoReconnectMaxRetries() !== -1) {
- logger.error(`${this.logPrefix()} Socket reconnect failure: max retries reached (${this.autoReconnectRetryCount}) or retry disabled (${this.getAutoReconnectMaxRetries()})`);
+ logger.error(
+ `${this.logPrefix()} WebSocket connection retries failure: maximum retries reached (${
+ this.autoReconnectRetryCount
+ }) or retries disabled (${this.getAutoReconnectMaxRetries()})`
+ );
}
}
- private initTransactionAttributesOnConnector(connectorId: number): void {
- this.getConnector(connectorId).transactionStarted = false;
- this.getConnector(connectorId).energyActiveImportRegisterValue = 0;
- this.getConnector(connectorId).transactionEnergyActiveImportRegisterValue = 0;
+ private getAutomaticTransactionGeneratorConfigurationFromTemplate(): AutomaticTransactionGeneratorConfiguration | null {
+ return this.getTemplateFromFile()?.AutomaticTransactionGenerator ?? null;
}
-}
+ private initializeConnectorStatus(connectorId: number): void {
+ this.getConnectorStatus(connectorId).idTagLocalAuthorized = false;
+ this.getConnectorStatus(connectorId).idTagAuthorized = false;
+ this.getConnectorStatus(connectorId).transactionRemoteStarted = false;
+ this.getConnectorStatus(connectorId).transactionStarted = false;
+ this.getConnectorStatus(connectorId).energyActiveImportRegisterValue = 0;
+ this.getConnectorStatus(connectorId).transactionEnergyActiveImportRegisterValue = 0;
+ }
+}
repositories / e-mobility-charging-stations-simulator.git / blobdiff