+// Partial Copyright Jerome Benoit. 2021. All Rights Reserved.
+
+import { AvailabilityType, BootNotificationRequest, IncomingRequest, IncomingRequestCommand, Request } from '../types/ocpp/Requests';
import { BootNotificationResponse, RegistrationStatus } from '../types/ocpp/Responses';
import ChargingStationConfiguration, { ConfigurationKey } from '../types/ChargingStationConfiguration';
-import ChargingStationTemplate, { PowerOutType, 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';
+import ChargingStationTemplate, { CurrentType, PowerUnits, Voltage } from '../types/ChargingStationTemplate';
+import { ConnectorPhaseRotation, StandardParametersKey, SupportedFeatureProfiles } from '../types/ocpp/Configuration';
+import Connectors, { Connector, SampledValueTemplate } from '../types/Connectors';
+import { MeterValueMeasurand, MeterValuePhase } from '../types/ocpp/MeterValues';
+import { WSError, WebSocketCloseEventStatusCode } from '../types/WebSocket';
+import WebSocket, { ClientOptions, Data } from 'ws';
import AutomaticTransactionGenerator from './AutomaticTransactionGenerator';
import { ChargePointStatus } from '../types/ocpp/ChargePointStatus';
import { ChargingProfile } from '../types/ocpp/ChargingProfile';
import ChargingStationInfo from '../types/ChargingStationInfo';
+import { ClientRequestArgs } from 'http';
import Configuration from '../utils/Configuration';
import Constants from '../utils/Constants';
+import { ErrorType } from '../types/ocpp/ErrorType';
+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 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 OCPPError from './ocpp/OCPPError';
import OCPPIncomingRequestService from './ocpp/OCPPIncomingRequestService';
import OCPPRequestService from './ocpp/OCPPRequestService';
import { OCPPVersion } from '../types/ocpp/OCPPVersion';
-import { StandardParametersKey } from '../types/ocpp/Configuration';
-import Statistics from '../utils/Statistics';
+import PerformanceStatistics from '../performance/PerformanceStatistics';
import { StopTransactionReason } from '../types/ocpp/Transaction';
+import { URL } from 'url';
import Utils from '../utils/Utils';
-import { WebSocketCloseEventStatusCode } from '../types/WebSocket';
import crypto from 'crypto';
import fs from 'fs';
import logger from '../utils/Logger';
export default class ChargingStation {
public stationTemplateFile: string;
public authorizedTags: string[];
- public stationInfo: ChargingStationInfo;
+ public stationInfo!: ChargingStationInfo;
public connectors: Connectors;
- public configuration: ChargingStationConfiguration;
+ public configuration!: ChargingStationConfiguration;
public hasStopped: boolean;
- public wsConnection: WebSocket;
- public requests: Requests;
+ public wsConnection!: WebSocket;
+ public requests: Map<string, Request>;
public messageQueue: string[];
- public statistics: Statistics;
- public heartbeatSetInterval: NodeJS.Timeout;
- public ocppIncomingRequestService: OCPPIncomingRequestService;
- public ocppRequestService: OCPPRequestService;
+ public performanceStatistics!: PerformanceStatistics;
+ public heartbeatSetInterval!: NodeJS.Timeout;
+ public ocppIncomingRequestService!: OCPPIncomingRequestService;
+ public ocppRequestService!: OCPPRequestService;
private index: number;
- private bootNotificationRequest: BootNotificationRequest;
- private bootNotificationResponse: BootNotificationResponse;
- private connectorsConfigurationHash: string;
- private supervisionUrl: string;
- private wsConnectionUrl: string;
+ private bootNotificationRequest!: BootNotificationRequest;
+ private bootNotificationResponse!: BootNotificationResponse | null;
+ private connectorsConfigurationHash!: string;
+ private wsConnectionUrl!: URL;
private hasSocketRestarted: boolean;
private autoReconnectRetryCount: number;
- private automaticTransactionGeneration: AutomaticTransactionGenerator;
- private performanceObserver: PerformanceObserver;
- private webSocketPingSetInterval: NodeJS.Timeout;
+ private automaticTransactionGeneration!: AutomaticTransactionGenerator;
+ private webSocketPingSetInterval!: NodeJS.Timeout;
constructor(index: number, stationTemplateFile: string) {
this.index = index;
this.hasSocketRestarted = false;
this.autoReconnectRetryCount = 0;
- this.requests = {} as Requests;
- this.messageQueue = [] as string[];
+ this.requests = new Map<string, Request>();
+ this.messageQueue = new Array<string>();
this.authorizedTags = this.getAuthorizedTags();
}
public logPrefix(): string {
- return Utils.logPrefix(` ${this.stationInfo.chargingStationId}:`);
+ return Utils.logPrefix(` ${this.stationInfo.chargingStationId} |`);
+ }
+
+ public getBootNotificationRequest(): BootNotificationRequest {
+ return this.bootNotificationRequest;
}
public getRandomTagId(): string {
return !Utils.isEmptyArray(this.authorizedTags);
}
- public getEnableStatistics(): boolean {
+ public getEnableStatistics(): boolean | undefined {
return !Utils.isUndefined(this.stationInfo.enableStatistics) ? this.stationInfo.enableStatistics : true;
}
- public getNumberOfPhases(): number {
- switch (this.getPowerOutType()) {
- case PowerOutType.AC:
+ public getMayAuthorizeAtRemoteStart(): boolean | undefined {
+ return this.stationInfo.mayAuthorizeAtRemoteStart ?? true;
+ }
+
+ public getNumberOfPhases(): number | undefined {
+ switch (this.getCurrentOutType()) {
+ case CurrentType.AC:
return !Utils.isUndefined(this.stationInfo.numberOfPhases) ? this.stationInfo.numberOfPhases : 3;
- case PowerOutType.DC:
+ case CurrentType.DC:
return 0;
}
}
- public isWebSocketOpen(): boolean {
+ public isWebSocketConnectionOpened(): boolean {
return this.wsConnection?.readyState === WebSocket.OPEN;
}
return this.connectors[id];
}
- public getPowerOutType(): PowerOutType {
- return !Utils.isUndefined(this.stationInfo.powerOutType) ? this.stationInfo.powerOutType : PowerOutType.AC;
+ public getCurrentOutType(): CurrentType | undefined {
+ return this.stationInfo.currentOutType ?? CurrentType.AC;
}
- public getVoltageOut(): number {
- const errMsg = `${this.logPrefix()} Unknown ${this.getPowerOutType()} powerOutType in template file ${this.stationTemplateFile}, cannot define default voltage out`;
+ 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.getPowerOutType()) {
- case PowerOutType.AC:
- defaultVoltageOut = VoltageOut.VOLTAGE_230;
+ switch (this.getCurrentOutType()) {
+ case CurrentType.AC:
+ defaultVoltageOut = Voltage.VOLTAGE_230;
break;
- case PowerOutType.DC:
- defaultVoltageOut = VoltageOut.VOLTAGE_400;
+ case CurrentType.DC:
+ defaultVoltageOut = Voltage.VOLTAGE_400;
break;
default:
logger.error(errMsg);
- throw Error(errMsg);
+ throw new Error(errMsg);
}
return !Utils.isUndefined(this.stationInfo.voltageOut) ? this.stationInfo.voltageOut : defaultVoltageOut;
}
- public getTransactionIdTag(transactionId: number): string {
+ 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;
+ return this.getConnector(Utils.convertToInt(connector)).transactionIdTag;
}
}
}
- public getTransactionMeterStop(transactionId: number): number {
+ public getOutOfOrderEndMeterValues(): boolean {
+ return this.stationInfo.outOfOrderEndMeterValues ?? false;
+ }
+
+ public getBeginEndMeterValues(): boolean {
+ return this.stationInfo.beginEndMeterValues ?? false;
+ }
+
+ public getMeteringPerTransaction(): boolean {
+ return this.stationInfo.meteringPerTransaction ?? true;
+ }
+
+ 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 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)).lastEnergyActiveImportRegisterValue;
+ return this.getConnector(Utils.convertToInt(connector)).energyActiveImportRegisterValue;
}
}
}
+ public getEnergyActiveImportRegisterByConnectorId(connectorId: number): number | undefined {
+ if (this.getMeteringPerTransaction()) {
+ return this.getConnector(connectorId).transactionEnergyActiveImportRegisterValue;
+ }
+ return this.getConnector(connectorId).energyActiveImportRegisterValue;
+ }
+
public getAuthorizeRemoteTxRequests(): boolean {
const authorizeRemoteTxRequests = this.getConfigurationKey(StandardParametersKey.AuthorizeRemoteTxRequests);
return authorizeRemoteTxRequests ? Utils.convertToBoolean(authorizeRemoteTxRequests.value) : false;
this.startWebSocketPing();
}
+ public getSampledValueTemplate(connectorId: number, measurand: MeterValueMeasurand = MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER,
+ phase?: MeterValuePhase): SampledValueTemplate | undefined {
+ if (!Constants.SUPPORTED_MEASURANDS.includes(measurand)) {
+ logger.warn(`${this.logPrefix()} Trying to get unsupported MeterValues measurand '${measurand}' ${phase ? `on phase ${phase} ` : ''}in template on connectorId ${connectorId}`);
+ return;
+ }
+ if (measurand !== MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER && !this.getConfigurationKey(StandardParametersKey.MeterValuesSampledData).value.includes(measurand)) {
+ logger.debug(`${this.logPrefix()} Trying to get MeterValues measurand '${measurand}' ${phase ? `on phase ${phase} ` : ''}in template on connectorId ${connectorId} not found in '${StandardParametersKey.MeterValuesSampledData}' OCPP parameter`);
+ return;
+ }
+ const sampledValueTemplates: SampledValueTemplate[] = this.getConnector(connectorId).MeterValues;
+ for (let index = 0; !Utils.isEmptyArray(sampledValueTemplates) && index < sampledValueTemplates.length; index++) {
+ if (!Constants.SUPPORTED_MEASURANDS.includes(sampledValueTemplates[index]?.measurand ?? MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER)) {
+ logger.warn(`${this.logPrefix()} Unsupported MeterValues measurand '${measurand}' ${phase ? `on phase ${phase} ` : ''}in template on connectorId ${connectorId}`);
+ } else if (phase && sampledValueTemplates[index]?.phase === phase && sampledValueTemplates[index]?.measurand === measurand
+ && this.getConfigurationKey(StandardParametersKey.MeterValuesSampledData).value.includes(measurand)) {
+ return sampledValueTemplates[index];
+ } else if (!phase && !sampledValueTemplates[index].phase && sampledValueTemplates[index]?.measurand === measurand
+ && this.getConfigurationKey(StandardParametersKey.MeterValuesSampledData).value.includes(measurand)) {
+ return sampledValueTemplates[index];
+ } else if (measurand === MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER
+ && (!sampledValueTemplates[index].measurand || sampledValueTemplates[index].measurand === measurand)) {
+ return sampledValueTemplates[index];
+ }
+ }
+ if (measurand === MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER) {
+ const errorMsg = `${this.logPrefix()} Missing MeterValues for default measurand '${measurand}' in template on connectorId ${connectorId}`;
+ logger.error(errorMsg);
+ throw new Error(errorMsg);
+ }
+ logger.debug(`${this.logPrefix()} No MeterValues for measurand '${measurand}' ${phase ? `on phase ${phase} ` : ''}in template on connectorId ${connectorId}`);
+ }
+
+ public getAutomaticTransactionGeneratorRequireAuthorize(): boolean {
+ return this.stationInfo.AutomaticTransactionGenerator.requireAuthorize ?? true;
+ }
+
public startHeartbeat(): void {
if (this.getHeartbeatInterval() && this.getHeartbeatInterval() > 0 && !this.heartbeatSetInterval) {
// eslint-disable-next-line @typescript-eslint/no-misused-promises
}, this.getHeartbeatInterval());
logger.info(this.logPrefix() + ' Heartbeat started every ' + Utils.milliSecondsToHHMMSS(this.getHeartbeatInterval()));
} else if (this.heartbeatSetInterval) {
- logger.info(this.logPrefix() + ' Heartbeat every ' + Utils.milliSecondsToHHMMSS(this.getHeartbeatInterval()) + ' already started');
+ logger.info(this.logPrefix() + ' Heartbeat already started every ' + Utils.milliSecondsToHHMMSS(this.getHeartbeatInterval()));
} else {
logger.error(`${this.logPrefix()} Heartbeat interval set to ${this.getHeartbeatInterval() ? Utils.milliSecondsToHHMMSS(this.getHeartbeatInterval()) : this.getHeartbeatInterval()}, not starting the heartbeat`);
}
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'],
- });
- await sendMeterValues(connectorId, this.getConnector(connectorId).transactionId, interval, this.ocppRequestService);
- } else {
- await this.ocppRequestService.sendMeterValues(connectorId, this.getConnector(connectorId).transactionId, interval, this.ocppRequestService);
- }
+ await this.ocppRequestService.sendMeterValues(connectorId, this.getConnector(connectorId).transactionId, interval);
}, interval);
} else {
logger.error(`${this.logPrefix()} Charging station ${StandardParametersKey.MeterValueSampleInterval} configuration set to ${interval ? Utils.milliSecondsToHHMMSS(interval) : interval}, not sending MeterValues`);
}
public start(): void {
+ if (this.getEnableStatistics()) {
+ this.performanceStatistics.start();
+ }
this.openWSConnection();
// Monitor authorization file
this.startAuthorizationFileMonitoring();
this.getConnector(Utils.convertToInt(connector)).status = ChargePointStatus.UNAVAILABLE;
}
}
- if (this.isWebSocketOpen()) {
+ if (this.isWebSocketConnectionOpened()) {
this.wsConnection.close();
}
+ if (this.getEnableStatistics()) {
+ this.performanceStatistics.stop();
+ }
this.bootNotificationResponse = null;
this.hasStopped = true;
}
- public getConfigurationKey(key: string | StandardParametersKey, caseInsensitive = false): ConfigurationKey {
- const configurationKey: ConfigurationKey = this.configuration.configurationKey.find((configElement) => {
+ public getConfigurationKey(key: string | StandardParametersKey, caseInsensitive = false): ConfigurationKey | undefined {
+ return this.configuration.configurationKey.find((configElement) => {
if (caseInsensitive) {
return configElement.key.toLowerCase() === key.toLowerCase();
}
return configElement.key === key;
});
- return configurationKey;
}
public addConfigurationKey(key: string | StandardParametersKey, value: string, readonly = false, visible = true, reboot = false): void {
}
}
- public setChargingProfile(connectorId: number, cp: ChargingProfile): boolean {
+ public setChargingProfile(connectorId: number, cp: ChargingProfile): void {
+ let cpReplaced = false;
if (!Utils.isEmptyArray(this.getConnector(connectorId).chargingProfiles)) {
- this.getConnector(connectorId).chargingProfiles.forEach((chargingProfile: ChargingProfile, index: number) => {
+ this.getConnector(connectorId).chargingProfiles?.forEach((chargingProfile: ChargingProfile, index: number) => {
if (chargingProfile.chargingProfileId === cp.chargingProfileId
- || (chargingProfile.stackLevel === cp.stackLevel && chargingProfile.chargingProfilePurpose === cp.chargingProfilePurpose)) {
+ || (chargingProfile.stackLevel === cp.stackLevel && chargingProfile.chargingProfilePurpose === cp.chargingProfilePurpose)) {
this.getConnector(connectorId).chargingProfiles[index] = cp;
- return true;
+ cpReplaced = true;
}
});
}
- this.getConnector(connectorId).chargingProfiles.push(cp);
- return true;
+ !cpReplaced && this.getConnector(connectorId).chargingProfiles?.push(cp);
}
public resetTransactionOnConnector(connectorId: number): void {
- this.initTransactionOnConnector(connectorId);
- if (this.getConnector(connectorId)?.transactionSetInterval) {
- clearInterval(this.getConnector(connectorId).transactionSetInterval);
- }
+ this.getConnector(connectorId).authorized = false;
+ this.getConnector(connectorId).transactionStarted = false;
+ delete this.getConnector(connectorId).authorizeIdTag;
+ delete this.getConnector(connectorId).transactionId;
+ delete this.getConnector(connectorId).transactionIdTag;
+ this.getConnector(connectorId).transactionEnergyActiveImportRegisterValue = 0;
+ delete this.getConnector(connectorId).transactionBeginMeterValue;
+ this.stopMeterValues(connectorId);
}
public addToMessageQueue(message: string): void {
if (!Utils.isEmptyArray(this.messageQueue)) {
this.messageQueue.forEach((message, index) => {
this.messageQueue.splice(index, 1);
+ // TODO: evaluate the need to track performance
this.wsConnection.send(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 : '';
+ const instanceIndex = process.env.CF_INSTANCE_INDEX ?? 0;
+ const idSuffix = stationTemplate.nameSuffix ?? '';
return stationTemplate.fixedName ? stationTemplate.baseName : stationTemplate.baseName + '-' + instanceIndex.toString() + ('000000000' + this.index.toString()).substr(('000000000' + this.index.toString()).length - 4) + idSuffix;
}
stationTemplateFromFile = JSON.parse(fs.readFileSync(fileDescriptor, 'utf8')) as ChargingStationTemplate;
fs.closeSync(fileDescriptor);
} catch (error) {
- logger.error('Template file ' + this.stationTemplateFile + ' loading error: %j', error);
- throw error;
+ FileUtils.handleFileException(this.logPrefix(), 'Template', this.stationTemplateFile, error);
}
- const stationInfo: ChargingStationInfo = stationTemplateFromFile || {} as ChargingStationInfo;
+ 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)];
+ const powerArrayRandomIndex = Math.floor(Math.random() * stationTemplateFromFile.power.length);
+ stationInfo.maxPower = stationTemplateFromFile.powerUnit === PowerUnits.KILO_WATT
+ ? stationTemplateFromFile.power[powerArrayRandomIndex] * 1000
+ : stationTemplateFromFile.power[powerArrayRandomIndex];
} else {
- stationInfo.maxPower = stationTemplateFromFile.power as number;
+ stationTemplateFromFile.power = stationTemplateFromFile.power as number;
+ stationInfo.maxPower = stationTemplateFromFile.powerUnit === PowerUnits.KILO_WATT
+ ? stationTemplateFromFile.power * 1000
+ : stationTemplateFromFile.power;
}
+ delete stationInfo.power;
+ delete stationInfo.powerUnit;
stationInfo.chargingStationId = this.getChargingStationId(stationTemplateFromFile);
stationInfo.resetTime = stationTemplateFromFile.resetTime ? stationTemplateFromFile.resetTime * 1000 : Constants.CHARGING_STATION_DEFAULT_RESET_TIME;
return stationInfo;
...!Utils.isUndefined(this.stationInfo.firmwareVersion) && { firmwareVersion: this.stationInfo.firmwareVersion },
};
this.configuration = this.getTemplateChargingStationConfiguration();
- this.supervisionUrl = this.getSupervisionURL();
- this.wsConnectionUrl = this.supervisionUrl + '/' + this.stationInfo.chargingStationId;
+ this.wsConnectionUrl = new URL(this.getSupervisionURL().href + '/' + this.stationInfo.chargingStationId);
// Build connectors if needed
const maxConnectors = this.getMaxNumberOfConnectors();
if (maxConnectors <= 0) {
// 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]);
+ 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 = [];
// Initialize transaction attributes on connectors
for (const connector in this.connectors) {
if (Utils.convertToInt(connector) > 0 && !this.getConnector(Utils.convertToInt(connector)).transactionStarted) {
- this.initTransactionOnConnector(Utils.convertToInt(connector));
+ this.initTransactionAttributesOnConnector(Utils.convertToInt(connector));
}
}
switch (this.getOCPPVersion()) {
break;
}
// OCPP parameters
+ this.initOCPPParameters();
+ if (this.stationInfo.autoRegister) {
+ this.bootNotificationResponse = {
+ currentTime: new Date().toISOString(),
+ interval: this.getHeartbeatInterval() / 1000,
+ status: RegistrationStatus.ACCEPTED
+ };
+ }
+ this.stationInfo.powerDivider = this.getPowerDivider();
+ if (this.getEnableStatistics()) {
+ this.performanceStatistics = new PerformanceStatistics(this.stationInfo.chargingStationId, this.wsConnectionUrl);
+ }
+ }
+
+ private initOCPPParameters(): void {
+ if (!this.getConfigurationKey(StandardParametersKey.SupportedFeatureProfiles)) {
+ this.addConfigurationKey(StandardParametersKey.SupportedFeatureProfiles, `${SupportedFeatureProfiles.Core},${SupportedFeatureProfiles.Local_Auth_List_Management},${SupportedFeatureProfiles.Smart_Charging}`);
+ }
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.statistics = new Statistics(this.stationInfo.chargingStationId);
- this.performanceObserver = new PerformanceObserver((list) => {
- const entry = list.getEntries()[0];
- this.statistics.logPerformance(entry, Constants.ENTITY_CHARGING_STATION);
- this.performanceObserver.disconnect();
- });
+ if (!this.getConfigurationKey(StandardParametersKey.ConnectorPhaseRotation)) {
+ const connectorPhaseRotation = [];
+ for (const connector in this.connectors) {
+ // AC/DC
+ if (Utils.convertToInt(connector) === 0 && this.getNumberOfPhases() === 0) {
+ connectorPhaseRotation.push(`${connector}.${ConnectorPhaseRotation.RST}`);
+ } else if (Utils.convertToInt(connector) > 0 && this.getNumberOfPhases() === 0) {
+ connectorPhaseRotation.push(`${connector}.${ConnectorPhaseRotation.NotApplicable}`);
+ // AC
+ } else if (Utils.convertToInt(connector) > 0 && this.getNumberOfPhases() === 1) {
+ connectorPhaseRotation.push(`${connector}.${ConnectorPhaseRotation.NotApplicable}`);
+ } else if (Utils.convertToInt(connector) > 0 && this.getNumberOfPhases() === 3) {
+ connectorPhaseRotation.push(`${connector}.${ConnectorPhaseRotation.RST}`);
+ }
+ }
+ this.addConfigurationKey(StandardParametersKey.ConnectorPhaseRotation, connectorPhaseRotation.toString());
+ }
+ if (!this.getConfigurationKey(StandardParametersKey.AuthorizeRemoteTxRequests)) {
+ this.addConfigurationKey(StandardParametersKey.AuthorizeRemoteTxRequests, 'true');
+ }
+ if (!this.getConfigurationKey(StandardParametersKey.LocalAuthListEnabled)
+ && this.getConfigurationKey(StandardParametersKey.SupportedFeatureProfiles).value.includes(SupportedFeatureProfiles.Local_Auth_List_Management)) {
+ this.addConfigurationKey(StandardParametersKey.LocalAuthListEnabled, 'false');
+ }
+ if (!this.getConfigurationKey(StandardParametersKey.ConnectionTimeOut)) {
+ this.addConfigurationKey(StandardParametersKey.ConnectionTimeOut, Constants.DEFAULT_CONNECTION_TIMEOUT.toString());
}
}
private async onOpen(): Promise<void> {
- logger.info(`${this.logPrefix()} Is connected to server through ${this.wsConnectionUrl}`);
+ logger.info(`${this.logPrefix()} Connected to OCPP server through ${this.wsConnectionUrl.toString()}`);
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);
+ 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);
if (this.isRegistered()) {
await this.startMessageSequence();
this.hasStopped && (this.hasStopped = false);
- if (this.hasSocketRestarted && this.isWebSocketOpen()) {
+ if (this.hasSocketRestarted && this.isWebSocketConnectionOpened()) {
this.flushMessageQueue();
}
} else {
this.hasSocketRestarted = false;
}
- private async onClose(closeEvent): Promise<void> {
- switch (closeEvent) {
- case WebSocketCloseEventStatusCode.CLOSE_NORMAL: // Normal close
+ private async onClose(code: number, reason: string): 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()} Socket normally closed with status '${Utils.getWebSocketCloseEventStatusString(code)}' and reason '${reason}'`);
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()} Socket abnormally closed with status '${Utils.getWebSocketCloseEventStatusString(code)}' and reason '${reason}'`);
+ await this.reconnect(code);
break;
}
}
- private async onMessage(messageEvent: MessageEvent): Promise<void> {
+ private async onMessage(data: Data): 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 responseCallback: (payload: Record<string, unknown> | string, requestPayload: Record<string, unknown>) => void;
let rejectCallback: (error: OCPPError) => void;
let requestPayload: Record<string, unknown>;
+ let cachedRequest: Request;
let errMsg: string;
try {
- // Parse the message
- [messageType, messageId, commandName, commandPayload, errorDetails] = JSON.parse(messageEvent.toString()) as IncomingRequest;
-
+ const request = JSON.parse(data.toString()) as IncomingRequest;
+ if (Utils.isIterable(request)) {
+ // Parse the message
+ [messageType, messageId, commandName, commandPayload, errorDetails] = request;
+ } else {
+ throw new OCPPError(ErrorType.PROTOCOL_ERROR, 'Incoming request is not iterable', commandName);
+ }
// Check the Type of message
switch (messageType) {
// Incoming Message
case MessageType.CALL_MESSAGE:
if (this.getEnableStatistics()) {
- this.statistics.addMessage(commandName, messageType);
+ this.performanceStatistics.addRequestStatistic(commandName, messageType);
}
// Process the call
await this.ocppIncomingRequestService.handleRequest(messageId, commandName, commandPayload);
// Outcome Message
case MessageType.CALL_RESULT_MESSAGE:
// Respond
- if (Utils.isIterable(this.requests[messageId])) {
- [responseCallback, , requestPayload] = this.requests[messageId];
+ cachedRequest = this.requests.get(messageId);
+ if (Utils.isIterable(cachedRequest)) {
+ [responseCallback, , requestPayload] = cachedRequest;
} else {
- throw new Error(`Response request for message id ${messageId} is not iterable`);
+ throw new OCPPError(ErrorType.PROTOCOL_ERROR, `Response request for message id ${messageId} is not iterable`, commandName);
}
if (!responseCallback) {
// Error
- throw new Error(`Response request for unknown message id ${messageId}`);
+ throw new OCPPError(ErrorType.INTERNAL_ERROR, `Response request for unknown message id ${messageId}`, commandName);
}
- delete this.requests[messageId];
+ this.requests.delete(messageId);
responseCallback(commandName, requestPayload);
break;
// Error Message
case MessageType.CALL_ERROR_MESSAGE:
- if (!this.requests[messageId]) {
+ cachedRequest = this.requests.get(messageId);
+ if (!cachedRequest) {
// Error
- throw new Error(`Error request for unknown message id ${messageId}`);
+ throw new OCPPError(ErrorType.INTERNAL_ERROR, `Error request for unknown message id ${messageId}`);
}
- if (Utils.isIterable(this.requests[messageId])) {
- [, rejectCallback] = this.requests[messageId];
+ if (Utils.isIterable(cachedRequest)) {
+ [, rejectCallback] = cachedRequest;
} else {
- throw new Error(`Error request for message id ${messageId} is not iterable`);
+ throw new OCPPError(ErrorType.PROTOCOL_ERROR, `Error request for message id ${messageId} is not iterable`);
}
- delete this.requests[messageId];
- rejectCallback(new OCPPError(commandName, commandPayload.toString(), errorDetails));
+ this.requests.delete(messageId);
+ rejectCallback(new OCPPError(commandName, commandPayload.toString(), null, errorDetails));
break;
// Error
default:
errMsg = `${this.logPrefix()} Wrong message type ${messageType}`;
logger.error(errMsg);
- throw new Error(errMsg);
+ throw new OCPPError(ErrorType.PROTOCOL_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]);
+ logger.error('%s Incoming request message %j processing error %j on content type %j', this.logPrefix(), data, error, this.requests.get(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): Promise<void> {
- logger.error(this.logPrefix() + ' Socket error: %j', errorEvent);
- // pragma switch (errorEvent.code) {
+ private async onError(error: WSError): Promise<void> {
+ logger.error(this.logPrefix() + ' Socket error: %j', error);
+ // switch (error.code) {
// case 'ECONNREFUSED':
- // await this._reconnect(errorEvent);
+ // await this.reconnect(error);
// break;
// }
}
private getTemplateChargingStationConfiguration(): ChargingStationConfiguration {
- return this.stationInfo.Configuration ? this.stationInfo.Configuration : {} as ChargingStationConfiguration;
+ return this.stationInfo.Configuration ?? {} as ChargingStationConfiguration;
}
- private getAuthorizationFile(): string {
+ private getAuthorizationFile(): string | undefined {
return this.stationInfo.authorizationFile && path.join(path.resolve(__dirname, '../'), 'assets', path.basename(this.stationInfo.authorizationFile));
}
authorizedTags = JSON.parse(fs.readFileSync(fileDescriptor, 'utf8')) as string[];
fs.closeSync(fileDescriptor);
} catch (error) {
- logger.error(this.logPrefix() + ' Authorization file ' + authorizationFile + ' loading error: %j', error);
- throw error;
+ FileUtils.handleFileException(this.logPrefix(), 'Authorization', authorizationFile, error);
}
} else {
logger.info(this.logPrefix() + ' No authorization file given in template file ' + this.stationTemplateFile);
return authorizedTags;
}
- private getUseConnectorId0(): boolean {
+ private getUseConnectorId0(): boolean | undefined {
return !Utils.isUndefined(this.stationInfo.useConnectorId0) ? this.stationInfo.useConnectorId0 : true;
}
}
// 0 for disabling
- private getConnectionTimeout(): number {
- if (!Utils.isUndefined(this.stationInfo.connectionTimeout)) {
- return this.stationInfo.connectionTimeout;
- }
- if (!Utils.isUndefined(Configuration.getConnectionTimeout())) {
- return Configuration.getConnectionTimeout();
+ private getConnectionTimeout(): number | undefined {
+ if (this.getConfigurationKey(StandardParametersKey.ConnectionTimeOut)) {
+ return parseInt(this.getConfigurationKey(StandardParametersKey.ConnectionTimeOut).value) ?? Constants.DEFAULT_CONNECTION_TIMEOUT;
}
- return 30;
+ return Constants.DEFAULT_CONNECTION_TIMEOUT;
}
// -1 for unlimited, 0 for disabling
- private getAutoReconnectMaxRetries(): number {
+ private getAutoReconnectMaxRetries(): number | undefined {
if (!Utils.isUndefined(this.stationInfo.autoReconnectMaxRetries)) {
return this.stationInfo.autoReconnectMaxRetries;
}
}
// 0 for disabling
- private getRegistrationMaxRetries(): number {
+ private getRegistrationMaxRetries(): number | undefined {
if (!Utils.isUndefined(this.stationInfo.registrationMaxRetries)) {
return this.stationInfo.registrationMaxRetries;
}
}
}
// Start the ATG
+ this.startAutomaticTransactionGenerator();
+ }
+
+ private startAutomaticTransactionGenerator() {
if (this.stationInfo.AutomaticTransactionGenerator.enable) {
if (!this.automaticTransactionGeneration) {
this.automaticTransactionGeneration = new AutomaticTransactionGenerator(this);
}
if (this.automaticTransactionGeneration.timeToStop) {
- await this.automaticTransactionGeneration.start();
+ this.automaticTransactionGeneration.start();
}
}
- if (this.getEnableStatistics()) {
- this.statistics.start();
- }
}
private async stopMessageSequence(reason: StopTransactionReason = StopTransactionReason.NONE): Promise<void> {
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.getTransactionMeterStop(transactionId), this.getTransactionIdTag(transactionId), reason);
+ await this.ocppRequestService.sendStopTransaction(transactionId, this.getEnergyActiveImportRegisterByTransactionId(transactionId),
+ this.getTransactionIdTag(transactionId), reason);
}
}
}
}
private startWebSocketPing(): void {
- const webSocketPingInterval: number = this.getConfigurationKey(StandardParametersKey.WebSocketPingInterval) ? Utils.convertToInt(this.getConfigurationKey(StandardParametersKey.WebSocketPingInterval).value) : 0;
+ const webSocketPingInterval: number = this.getConfigurationKey(StandardParametersKey.WebSocketPingInterval)
+ ? Utils.convertToInt(this.getConfigurationKey(StandardParametersKey.WebSocketPingInterval).value)
+ : 0;
if (webSocketPingInterval > 0 && !this.webSocketPingSetInterval) {
this.webSocketPingSetInterval = setInterval(() => {
- if (this.isWebSocketOpen()) {
- this.wsConnection.ping((): void => { });
+ if (this.isWebSocketConnectionOpened()) {
+ this.wsConnection.ping((): void => { /* This is intentional */ });
}
}, webSocketPingInterval * 1000);
logger.info(this.logPrefix() + ' WebSocket ping started every ' + Utils.secondsToHHMMSS(webSocketPingInterval));
private stopWebSocketPing(): void {
if (this.webSocketPingSetInterval) {
clearInterval(this.webSocketPingSetInterval);
- this.webSocketPingSetInterval = null;
}
}
- private getSupervisionURL(): string {
+ private getSupervisionURL(): URL {
const supervisionUrls = Utils.cloneObject<string | string[]>(this.stationInfo.supervisionURL ? this.stationInfo.supervisionURL : Configuration.getSupervisionURLs());
let indexUrl = 0;
if (!Utils.isEmptyArray(supervisionUrls)) {
// Get a random url
indexUrl = Math.floor(Math.random() * supervisionUrls.length);
}
- return supervisionUrls[indexUrl];
+ return new URL(supervisionUrls[indexUrl]);
}
- return supervisionUrls as string;
+ return new URL(supervisionUrls as string);
}
- private getHeartbeatInterval(): number {
+ private getHeartbeatInterval(): number | undefined {
const HeartbeatInterval = this.getConfigurationKey(StandardParametersKey.HeartbeatInterval);
if (HeartbeatInterval) {
return Utils.convertToInt(HeartbeatInterval.value) * 1000;
if (HeartBeatInterval) {
return Utils.convertToInt(HeartBeatInterval.value) * 1000;
}
+ !this.stationInfo.autoRegister && 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 {
if (this.heartbeatSetInterval) {
clearInterval(this.heartbeatSetInterval);
- this.heartbeatSetInterval = null;
}
}
- private openWSConnection(options?: WebSocket.ClientOptions, forceCloseOpened = false): void {
- if (Utils.isUndefined(options)) {
- options = {} as WebSocket.ClientOptions;
- }
- if (Utils.isUndefined(options.handshakeTimeout)) {
- options.handshakeTimeout = this.getConnectionTimeout() * 1000;
+ private openWSConnection(options?: ClientOptions & ClientRequestArgs, forceCloseOpened = false): void {
+ options = options ?? {};
+ options.handshakeTimeout = options?.handshakeTimeout ?? this.getConnectionTimeout() * 1000;
+ if (!Utils.isNullOrUndefined(this.stationInfo.supervisionUser) && !Utils.isNullOrUndefined(this.stationInfo.supervisionPassword)) {
+ options.auth = `${this.stationInfo.supervisionUser}:${this.stationInfo.supervisionPassword}`;
}
- if (this.isWebSocketOpen() && forceCloseOpened) {
+ if (this.isWebSocketConnectionOpened() && forceCloseOpened) {
this.wsConnection.close();
}
let protocol;
break;
}
this.wsConnection = new WebSocket(this.wsConnectionUrl, protocol, options);
- logger.info(this.logPrefix() + ' Will communicate through URL ' + this.supervisionUrl);
+ logger.info(this.logPrefix() + ' Open OCPP connection to URL ' + this.wsConnectionUrl.toString());
+ }
+
+ private stopMeterValues(connectorId: number) {
+ if (this.getConnector(connectorId)?.transactionSetInterval) {
+ clearInterval(this.getConnector(connectorId).transactionSetInterval);
+ }
}
private startAuthorizationFileMonitoring(): void {
- fs.watch(this.getAuthorizationFile()).on('change', (e) => {
+ const authorizationFile = this.getAuthorizationFile();
+ if (authorizationFile) {
try {
- logger.debug(this.logPrefix() + ' Authorization file ' + this.getAuthorizationFile() + ' have changed, reload');
- // Initialize authorizedTags
- this.authorizedTags = this.getAuthorizedTags();
+ fs.watch(authorizationFile, (event, filename) => {
+ if (filename && event === 'change') {
+ 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) {
- logger.error(this.logPrefix() + ' Authorization file monitoring error: %j', 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 {
- // 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
- if (this.stationInfo.AutomaticTransactionGenerator.enable) {
- if (!this.automaticTransactionGeneration) {
- this.automaticTransactionGeneration = new AutomaticTransactionGenerator(this);
- }
- if (this.automaticTransactionGeneration.timeToStop) {
- await this.automaticTransactionGeneration.start();
+ try {
+ fs.watch(this.stationTemplateFile, async (event, filename): Promise<void> => {
+ if (filename && event === 'change') {
+ try {
+ logger.debug(this.logPrefix() + ' Template file ' + this.stationTemplateFile + ' have changed, reload');
+ // Initialize
+ this.initialize();
+ // Restart the ATG
+ if (!this.stationInfo.AutomaticTransactionGenerator.enable &&
+ this.automaticTransactionGeneration) {
+ await this.automaticTransactionGeneration.stop();
+ }
+ this.startAutomaticTransactionGenerator();
+ if (this.getEnableStatistics()) {
+ 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() + ' Charging station template file monitoring error: %j', error);
}
}
- // 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 {
+ private getReconnectExponentialDelay(): boolean | undefined {
return !Utils.isUndefined(this.stationInfo.reconnectExponentialDelay) ? this.stationInfo.reconnectExponentialDelay : false;
}
- private async reconnect(error): Promise<void> {
+ private async reconnect(code: number): Promise<void> {
+ // Stop WebSocket ping
+ this.stopWebSocketPing();
// Stop heartbeat
this.stopHeartbeat();
// Stop the ATG if needed
this.stationInfo.AutomaticTransactionGenerator.stopOnConnectionFailure &&
this.automaticTransactionGeneration &&
!this.automaticTransactionGeneration.timeToStop) {
- this.automaticTransactionGeneration.stop().catch(() => { });
+ await this.automaticTransactionGeneration.stop();
}
if (this.autoReconnectRetryCount < this.getAutoReconnectMaxRetries() || this.getAutoReconnectMaxRetries() === -1) {
this.autoReconnectRetryCount++;
}
}
- private initTransactionOnConnector(connectorId: number): void {
+ private initTransactionAttributesOnConnector(connectorId: number): void {
+ this.getConnector(connectorId).authorized = false;
this.getConnector(connectorId).transactionStarted = false;
- this.getConnector(connectorId).transactionId = null;
- this.getConnector(connectorId).idTag = null;
- this.getConnector(connectorId).lastEnergyActiveImportRegisterValue = -1;
+ this.getConnector(connectorId).energyActiveImportRegisterValue = 0;
+ this.getConnector(connectorId).transactionEnergyActiveImportRegisterValue = 0;
}
}
repositories / e-mobility-charging-stations-simulator.git / blobdiff