} from '../types/ocpp/Requests';
import {
BootNotificationResponse,
+ ErrorResponse,
HeartbeatResponse,
MeterValuesResponse,
RegistrationStatus,
+ Response,
StatusNotificationResponse,
} from '../types/ocpp/Responses';
-import {
- ChargingProfile,
- ChargingRateUnitType,
- ChargingSchedulePeriod,
-} from '../types/ocpp/ChargingProfile';
+import { ChargingProfile, ChargingRateUnitType } from '../types/ocpp/ChargingProfile';
import ChargingStationConfiguration, { Section } from '../types/ChargingStationConfiguration';
-import ChargingStationOcppConfiguration, {
- ConfigurationKey,
-} from '../types/ChargingStationOcppConfiguration';
import ChargingStationTemplate, {
- AmpereUnits,
CurrentType,
PowerUnits,
Voltage,
import WebSocket, { Data, OPEN, RawData } from 'ws';
import AutomaticTransactionGenerator from './AutomaticTransactionGenerator';
+import BaseError from '../exception/BaseError';
import { ChargePointErrorCode } from '../types/ocpp/ChargePointErrorCode';
import { ChargePointStatus } from '../types/ocpp/ChargePointStatus';
+import { ChargingStationConfigurationUtils } from './ChargingStationConfigurationUtils';
import ChargingStationInfo from '../types/ChargingStationInfo';
+import ChargingStationOcppConfiguration from '../types/ChargingStationOcppConfiguration';
+import { ChargingStationUtils } from './ChargingStationUtils';
import { ChargingStationWorkerMessageEvents } from '../types/ChargingStationWorker';
import Configuration from '../utils/Configuration';
import { ConnectorStatus } from '../types/ConnectorStatus';
import { SupervisionUrlDistribution } from '../types/ConfigurationData';
import { URL } from 'url';
import Utils from '../utils/Utils';
-import chalk from 'chalk';
import crypto from 'crypto';
import fs from 'fs';
import logger from '../utils/Logger';
private get wsConnectionUrl(): URL {
return this.getSupervisionUrlOcppConfiguration()
? new URL(
- this.getConfigurationKey(this.getSupervisionUrlOcppKey()).value +
+ ChargingStationConfigurationUtils.getConfigurationKey(
+ this,
+ this.getSupervisionUrlOcppKey()
+ ).value +
'/' +
this.stationInfo.chargingStationId
)
return this.stationInfo.phaseLineToLineVoltageMeterValues ?? false;
}
+ public getCustomValueLimitationMeterValues(): boolean {
+ return this.stationInfo.customValueLimitationMeterValues ?? true;
+ }
+
public getConnectorIdByTransactionId(transactionId: number): number | undefined {
for (const connectorId of this.connectors.keys()) {
if (
}
public getAuthorizeRemoteTxRequests(): boolean {
- const authorizeRemoteTxRequests = this.getConfigurationKey(
+ const authorizeRemoteTxRequests = ChargingStationConfigurationUtils.getConfigurationKey(
+ this,
StandardParametersKey.AuthorizeRemoteTxRequests
);
return authorizeRemoteTxRequests
}
public getLocalAuthListEnabled(): boolean {
- const localAuthListEnabled = this.getConfigurationKey(
+ const localAuthListEnabled = ChargingStationConfigurationUtils.getConfigurationKey(
+ this,
StandardParametersKey.LocalAuthListEnabled
);
return localAuthListEnabled ? Utils.convertToBoolean(localAuthListEnabled.value) : false;
}
- public restartWebSocketPing(): void {
- // Stop WebSocket ping
- this.stopWebSocketPing();
- // Start WebSocket ping
- this.startWebSocketPing();
- }
-
public getSampledValueTemplate(
connectorId: number,
measurand: MeterValueMeasurand = MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER,
}
if (
measurand !== MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER &&
- !this.getConfigurationKey(StandardParametersKey.MeterValuesSampledData)?.value.includes(
- measurand
- )
+ !ChargingStationConfigurationUtils.getConfigurationKey(
+ this,
+ StandardParametersKey.MeterValuesSampledData
+ )?.value.includes(measurand)
) {
logger.debug(
`${this.logPrefix()} Trying to get MeterValues measurand '${measurand}' ${onPhaseStr}in template on connectorId ${connectorId} not found in '${
phase &&
sampledValueTemplates[index]?.phase === phase &&
sampledValueTemplates[index]?.measurand === measurand &&
- this.getConfigurationKey(StandardParametersKey.MeterValuesSampledData)?.value.includes(
- measurand
- )
+ ChargingStationConfigurationUtils.getConfigurationKey(
+ this,
+ 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
- )
+ ChargingStationConfigurationUtils.getConfigurationKey(
+ this,
+ StandardParametersKey.MeterValuesSampledData
+ )?.value.includes(measurand)
) {
return sampledValueTemplates[index];
} else if (
) {
// eslint-disable-next-line @typescript-eslint/no-misused-promises
this.heartbeatSetInterval = setInterval(async (): Promise<void> => {
- await this.ocppRequestService.sendMessageHandler<HeartbeatRequest, HeartbeatResponse>(
+ await this.ocppRequestService.requestHandler<HeartbeatRequest, HeartbeatResponse>(
+ this,
RequestCommand.HEARTBEAT
);
}, this.getHeartbeatInterval());
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.getConnectorStatus(connectorId).transactionId,
interval
);
- await this.ocppRequestService.sendMessageHandler<MeterValuesRequest, MeterValuesResponse>(
+ await this.ocppRequestService.requestHandler<MeterValuesRequest, MeterValuesResponse>(
+ this,
RequestCommand.METER_VALUES,
{
connectorId,
this.performanceStatistics.start();
}
this.openWSConnection();
+ // 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);
// Monitor authorization file
FileUtils.watchJsonFile<string[]>(
this.logPrefix(),
}
}
);
- // 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);
parentPort.postMessage({
id: ChargingStationWorkerMessageEvents.STARTED,
data: { id: this.stationInfo.chargingStationId },
await this.stopMessageSequence(reason);
for (const connectorId of this.connectors.keys()) {
if (connectorId > 0) {
- await this.ocppRequestService.sendMessageHandler<
+ await this.ocppRequestService.requestHandler<
StatusNotificationRequest,
StatusNotificationResponse
- >(RequestCommand.STATUS_NOTIFICATION, {
+ >(this, RequestCommand.STATUS_NOTIFICATION, {
connectorId,
status: ChargePointStatus.UNAVAILABLE,
errorCode: ChargePointErrorCode.NO_ERROR,
this.stopped = true;
}
- public getConfigurationKey(
- key: string | StandardParametersKey,
- caseInsensitive = false
- ): ConfigurationKey | undefined {
- return this.ocppConfiguration.configurationKey.find((configElement) => {
- if (caseInsensitive) {
- return configElement.key.toLowerCase() === key.toLowerCase();
- }
- return configElement.key === key;
- });
+ public async reset(reason?: StopTransactionReason): Promise<void> {
+ await this.stop(reason);
+ await Utils.sleep(this.stationInfo.resetTime);
+ this.stationInfo = this.getStationInfo();
+ this.stationInfo?.Connectors && delete this.stationInfo.Connectors;
+ this.start();
}
- public addConfigurationKey(
- key: string | StandardParametersKey,
- value: string,
- options: { readonly?: boolean; visible?: boolean; reboot?: boolean } = {
- readonly: false,
- visible: true,
- reboot: false,
- },
- params: { overwrite?: boolean; save?: boolean } = { overwrite: false, save: false }
- ): void {
- options = options ?? ({} as { readonly?: boolean; visible?: boolean; reboot?: boolean });
- options.readonly = options?.readonly ?? false;
- options.visible = options?.visible ?? true;
- options.reboot = options?.reboot ?? false;
- let keyFound = this.getConfigurationKey(key);
- if (keyFound && params?.overwrite) {
- this.deleteConfigurationKey(keyFound.key, { save: false });
- keyFound = undefined;
- }
- if (!keyFound) {
- this.ocppConfiguration.configurationKey.push({
- key,
- readonly: options.readonly,
- value,
- visible: options.visible,
- reboot: options.reboot,
- });
- params?.save && this.saveOcppConfiguration();
- } else {
- logger.error(
- `${this.logPrefix()} Trying to add an already existing configuration key: %j`,
- keyFound
- );
+ public saveOcppConfiguration(): void {
+ if (this.getOcppPersistentConfiguration()) {
+ this.saveConfiguration(Section.ocppConfiguration);
}
}
- public setConfigurationKeyValue(
- key: string | StandardParametersKey,
- value: string,
- caseInsensitive = false
- ): void {
- const keyFound = this.getConfigurationKey(key, caseInsensitive);
- if (keyFound) {
- this.ocppConfiguration.configurationKey[
- this.ocppConfiguration.configurationKey.indexOf(keyFound)
- ].value = value;
- this.saveOcppConfiguration();
- } else {
- logger.error(
- `${this.logPrefix()} Trying to set a value on a non existing configuration key: %j`,
- { key, value }
+ public getChargingProfilePowerLimit(connectorId: number): number | undefined {
+ let limit: number, matchingChargingProfile: ChargingProfile;
+ let chargingProfiles: ChargingProfile[] = [];
+ // Get charging profiles for connector and sort by stack level
+ chargingProfiles = this.getConnectorStatus(connectorId).chargingProfiles.sort(
+ (a, b) => b.stackLevel - a.stackLevel
+ );
+ // Get profiles on connector 0
+ if (this.getConnectorStatus(0).chargingProfiles) {
+ chargingProfiles.push(
+ ...this.getConnectorStatus(0).chargingProfiles.sort((a, b) => b.stackLevel - a.stackLevel)
);
}
- }
-
- public deleteConfigurationKey(
- key: string | StandardParametersKey,
- params: { save?: boolean; caseInsensitive?: boolean } = { save: true, caseInsensitive: false }
- ): ConfigurationKey[] {
- const keyFound = this.getConfigurationKey(key, params?.caseInsensitive);
- if (keyFound) {
- const deletedConfigurationKey = this.ocppConfiguration.configurationKey.splice(
- this.ocppConfiguration.configurationKey.indexOf(keyFound),
- 1
+ if (!Utils.isEmptyArray(chargingProfiles)) {
+ const result = ChargingStationUtils.getLimitFromChargingProfiles(
+ chargingProfiles,
+ Utils.logPrefix()
);
- params?.save && this.saveOcppConfiguration();
- return deletedConfigurationKey;
- }
- }
+ if (!Utils.isNullOrUndefined(result)) {
+ limit = result.limit;
+ matchingChargingProfile = result.matchingChargingProfile;
+ switch (this.getCurrentOutType()) {
+ case CurrentType.AC:
+ limit =
+ matchingChargingProfile.chargingSchedule.chargingRateUnit ===
+ ChargingRateUnitType.WATT
+ ? limit
+ : ACElectricUtils.powerTotal(this.getNumberOfPhases(), this.getVoltageOut(), limit);
+ break;
+ case CurrentType.DC:
+ limit =
+ matchingChargingProfile.chargingSchedule.chargingRateUnit ===
+ ChargingRateUnitType.WATT
+ ? limit
+ : DCElectricUtils.power(this.getVoltageOut(), limit);
+ }
- public getChargingProfilePowerLimit(connectorId: number): number | undefined {
- const timestamp = new Date().getTime();
- let matchingChargingProfile: ChargingProfile;
- let chargingSchedulePeriods: ChargingSchedulePeriod[] = [];
- if (!Utils.isEmptyArray(this.getConnectorStatus(connectorId)?.chargingProfiles)) {
- const chargingProfiles: ChargingProfile[] = this.getConnectorStatus(
- connectorId
- ).chargingProfiles.filter(
- (chargingProfile) =>
- timestamp >= chargingProfile.chargingSchedule?.startSchedule.getTime() &&
- timestamp <
- chargingProfile.chargingSchedule?.startSchedule.getTime() +
- chargingProfile.chargingSchedule.duration * 1000 &&
- chargingProfile?.stackLevel === Math.max(...chargingProfiles.map((cp) => cp?.stackLevel))
- );
- if (!Utils.isEmptyArray(chargingProfiles)) {
- for (const chargingProfile of chargingProfiles) {
- if (!Utils.isEmptyArray(chargingProfile.chargingSchedule.chargingSchedulePeriod)) {
- chargingSchedulePeriods =
- chargingProfile.chargingSchedule.chargingSchedulePeriod.filter(
- (chargingSchedulePeriod, index) => {
- timestamp >=
- chargingProfile.chargingSchedule.startSchedule.getTime() +
- chargingSchedulePeriod.startPeriod * 1000 &&
- ((chargingProfile.chargingSchedule.chargingSchedulePeriod[index + 1] &&
- timestamp <
- chargingProfile.chargingSchedule.startSchedule.getTime() +
- chargingProfile.chargingSchedule.chargingSchedulePeriod[index + 1]
- ?.startPeriod *
- 1000) ||
- !chargingProfile.chargingSchedule.chargingSchedulePeriod[index + 1]);
- }
- );
- if (!Utils.isEmptyArray(chargingSchedulePeriods)) {
- matchingChargingProfile = chargingProfile;
- break;
- }
- }
+ const connectorMaximumPower = this.getMaximumPower() / this.stationInfo.powerDivider;
+ if (limit > connectorMaximumPower) {
+ logger.error(
+ `${this.logPrefix()} Charging profile id ${
+ matchingChargingProfile.chargingProfileId
+ } limit is greater than connector id ${connectorId} maximum, dump charging profiles' stack: %j`,
+ this.getConnectorStatus(connectorId).chargingProfiles
+ );
+ limit = connectorMaximumPower;
}
}
}
- let limit: number;
- if (!Utils.isEmptyArray(chargingSchedulePeriods)) {
- switch (this.getCurrentOutType()) {
- case CurrentType.AC:
- limit =
- matchingChargingProfile.chargingSchedule.chargingRateUnit === ChargingRateUnitType.WATT
- ? chargingSchedulePeriods[0].limit
- : ACElectricUtils.powerTotal(
- this.getNumberOfPhases(),
- this.getVoltageOut(),
- chargingSchedulePeriods[0].limit
- );
- break;
- case CurrentType.DC:
- limit =
- matchingChargingProfile.chargingSchedule.chargingRateUnit === ChargingRateUnitType.WATT
- ? chargingSchedulePeriods[0].limit
- : DCElectricUtils.power(this.getVoltageOut(), chargingSchedulePeriods[0].limit);
- }
- }
- const connectorMaximumPower = this.getMaximumPower() / this.stationInfo.powerDivider;
- if (limit > connectorMaximumPower) {
- logger.error(
- `${this.logPrefix()} Charging profile id ${
- matchingChargingProfile.chargingProfileId
- } limit is greater than connector id ${connectorId} maximum, dump charging profiles' stack: %j`,
- this.getConnectorStatus(connectorId).chargingProfiles
- );
- limit = connectorMaximumPower;
- }
return limit;
}
public setChargingProfile(connectorId: number, cp: ChargingProfile): void {
+ if (Utils.isNullOrUndefined(this.getConnectorStatus(connectorId).chargingProfiles)) {
+ logger.error(
+ `${this.logPrefix()} Trying to set a charging profile on connectorId ${connectorId} with an uninitialized charging profiles array attribute, applying deferred initialization`
+ );
+ this.getConnectorStatus(connectorId).chargingProfiles = [];
+ }
+ if (!Array.isArray(this.getConnectorStatus(connectorId).chargingProfiles)) {
+ logger.error(
+ `${this.logPrefix()} Trying to set a charging profile on connectorId ${connectorId} with an improper attribute type for the charging profiles array, applying proper type initialization`
+ );
+ this.getConnectorStatus(connectorId).chargingProfiles = [];
+ }
let cpReplaced = false;
if (!Utils.isEmptyArray(this.getConnectorStatus(connectorId).chargingProfiles)) {
this.getConnectorStatus(connectorId).chargingProfiles?.forEach(
}
public hasFeatureProfile(featureProfile: SupportedFeatureProfiles) {
- return this.getConfigurationKey(StandardParametersKey.SupportedFeatureProfiles)?.value.includes(
- featureProfile
- );
+ return ChargingStationConfigurationUtils.getConfigurationKey(
+ this,
+ StandardParametersKey.SupportedFeatureProfiles
+ )?.value.includes(featureProfile);
}
public bufferMessage(message: string): void {
return this.stationInfo.supervisionUrlOcppKey ?? VendorDefaultParametersKey.ConnectionUrl;
}
- private getChargingStationId(stationTemplate: ChargingStationTemplate): string {
- // In case of multiple instances: add instance index to charging station id
- const instanceIndex = process.env.CF_INSTANCE_INDEX ?? 0;
- const idSuffix = stationTemplate.nameSuffix ?? '';
- const idStr = '000000000' + this.index.toString();
- return stationTemplate.fixedName
- ? stationTemplate.baseName
- : stationTemplate.baseName +
- '-' +
- instanceIndex.toString() +
- idStr.substring(idStr.length - 4) +
- idSuffix;
- }
-
- private getRandomSerialNumberSuffix(params?: {
- randomBytesLength?: number;
- upperCase?: boolean;
- }): string {
- const randomSerialNumberSuffix = crypto
- .randomBytes(params?.randomBytesLength ?? 16)
- .toString('hex');
- if (params?.upperCase) {
- return randomSerialNumberSuffix.toUpperCase();
- }
- return randomSerialNumberSuffix;
- }
-
private getTemplateFromFile(): ChargingStationTemplate | null {
let template: ChargingStationTemplate = null;
try {
const measureId = `${FileType.ChargingStationTemplate} read`;
const beginId = PerformanceStatistics.beginMeasure(measureId);
- template = JSON.parse(fs.readFileSync(this.templateFile, 'utf8')) as ChargingStationTemplate;
+ template =
+ (JSON.parse(fs.readFileSync(this.templateFile, 'utf8')) as ChargingStationTemplate) ??
+ ({} as ChargingStationTemplate);
PerformanceStatistics.endMeasure(measureId, beginId);
+ template.templateHash = crypto
+ .createHash(Constants.DEFAULT_HASH_ALGORITHM)
+ .update(JSON.stringify(template))
+ .digest('hex');
} catch (error) {
FileUtils.handleFileException(
this.logPrefix(),
return template;
}
- private createSerialNumber(
- stationInfo: ChargingStationInfo,
- existingStationInfo?: ChargingStationInfo,
- params: { randomSerialNumberUpperCase?: boolean; randomSerialNumber?: boolean } = {
- randomSerialNumberUpperCase: true,
- randomSerialNumber: true,
+ private getStationInfoFromTemplate(): ChargingStationInfo {
+ const stationInfo: ChargingStationInfo = this.getTemplateFromFile();
+ if (Utils.isNullOrUndefined(stationInfo)) {
+ const logMsg = 'Failed to read charging station template file';
+ logger.error(`${this.logPrefix()} ${logMsg}`);
+ throw new BaseError(logMsg);
}
- ): void {
- params = params ?? {};
- params.randomSerialNumberUpperCase = params?.randomSerialNumberUpperCase ?? true;
- params.randomSerialNumber = params?.randomSerialNumber ?? true;
- if (existingStationInfo) {
- existingStationInfo?.chargePointSerialNumber &&
- (stationInfo.chargePointSerialNumber = existingStationInfo.chargePointSerialNumber);
- existingStationInfo?.chargeBoxSerialNumber &&
- (stationInfo.chargeBoxSerialNumber = existingStationInfo.chargeBoxSerialNumber);
- existingStationInfo?.meterSerialNumber &&
- (stationInfo.meterSerialNumber = existingStationInfo.meterSerialNumber);
- } else {
- const serialNumberSuffix = params?.randomSerialNumber
- ? this.getRandomSerialNumberSuffix({ upperCase: params.randomSerialNumberUpperCase })
- : '';
- stationInfo.chargePointSerialNumber =
- stationInfo?.chargePointSerialNumberPrefix &&
- stationInfo.chargePointSerialNumberPrefix + serialNumberSuffix;
- stationInfo.chargeBoxSerialNumber =
- stationInfo?.chargeBoxSerialNumberPrefix &&
- stationInfo.chargeBoxSerialNumberPrefix + serialNumberSuffix;
- stationInfo.meterSerialNumber =
- stationInfo?.meterSerialNumberPrefix &&
- stationInfo.meterSerialNumberPrefix + serialNumberSuffix;
+ if (Utils.isEmptyObject(stationInfo)) {
+ logger.warn(
+ `${this.logPrefix()} Empty charging station information from template file ${
+ this.templateFile
+ }`
+ );
}
- }
-
- private getStationInfoFromTemplate(): ChargingStationInfo {
- const stationInfo: ChargingStationInfo =
- this.getTemplateFromFile() ?? ({} as ChargingStationInfo);
- stationInfo.hash = crypto
- .createHash(Constants.DEFAULT_HASH_ALGORITHM)
- .update(JSON.stringify(stationInfo))
- .digest('hex');
- const chargingStationId = this.getChargingStationId(stationInfo);
+ const chargingStationId = ChargingStationUtils.getChargingStationId(this.index, stationInfo);
// Deprecation template keys section
- this.warnDeprecatedTemplateKey(
+ ChargingStationUtils.warnDeprecatedTemplateKey(
stationInfo,
'supervisionUrl',
- chargingStationId,
+ this.templateFile,
+ Utils.logPrefix(` ${chargingStationId} |`),
"Use 'supervisionUrls' instead"
);
- this.convertDeprecatedTemplateKey(stationInfo, 'supervisionUrl', 'supervisionUrls');
+ ChargingStationUtils.convertDeprecatedTemplateKey(
+ stationInfo,
+ 'supervisionUrl',
+ 'supervisionUrls'
+ );
stationInfo.wsOptions = stationInfo?.wsOptions ?? {};
if (!Utils.isEmptyArray(stationInfo.power)) {
stationInfo.power = stationInfo.power as number[];
return stationInfo;
}
- private getStationInfoFromFile(): ChargingStationInfo | null {
- return this.getConfigurationFromFile()?.stationInfo ?? null;
+ private getStationInfoFromFile(): ChargingStationInfo {
+ let stationInfo = this.getConfigurationFromFile()?.stationInfo ?? ({} as ChargingStationInfo);
+ stationInfo = ChargingStationUtils.createStationInfoHash(stationInfo);
+ return stationInfo;
}
private getStationInfo(): ChargingStationInfo {
const stationInfoFromTemplate: ChargingStationInfo = this.getStationInfoFromTemplate();
- this.hashId = this.getHashId(stationInfoFromTemplate);
+ this.hashId = ChargingStationUtils.getHashId(stationInfoFromTemplate);
this.configurationFile = path.join(
path.resolve(__dirname, '../'),
'assets',
this.hashId + '.json'
);
const stationInfoFromFile: ChargingStationInfo = this.getStationInfoFromFile();
- if (stationInfoFromFile?.hash === stationInfoFromTemplate.hash) {
+ // 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;
}
- this.createSerialNumber(stationInfoFromTemplate, stationInfoFromFile);
+ ChargingStationUtils.createSerialNumber(stationInfoFromTemplate, stationInfoFromFile);
return stationInfoFromTemplate;
}
}
private getOcppVersion(): OCPPVersion {
- return this.stationInfo.ocppVersion ? this.stationInfo.ocppVersion : OCPPVersion.VERSION_16;
+ return this.stationInfo.ocppVersion ?? OCPPVersion.VERSION_16;
}
private getOcppPersistentConfiguration(): boolean {
throw new Error(errMsg);
}
- private createBootNotificationRequest(stationInfo: ChargingStationInfo): BootNotificationRequest {
- return {
- chargePointModel: stationInfo.chargePointModel,
- chargePointVendor: stationInfo.chargePointVendor,
- ...(!Utils.isUndefined(stationInfo.chargeBoxSerialNumber) && {
- chargeBoxSerialNumber: stationInfo.chargeBoxSerialNumber,
- }),
- ...(!Utils.isUndefined(stationInfo.chargePointSerialNumber) && {
- chargePointSerialNumber: stationInfo.chargePointSerialNumber,
- }),
- ...(!Utils.isUndefined(stationInfo.firmwareVersion) && {
- firmwareVersion: stationInfo.firmwareVersion,
- }),
- ...(!Utils.isUndefined(stationInfo.iccid) && { iccid: stationInfo.iccid }),
- ...(!Utils.isUndefined(stationInfo.imsi) && { imsi: stationInfo.imsi }),
- ...(!Utils.isUndefined(stationInfo.meterSerialNumber) && {
- meterSerialNumber: stationInfo.meterSerialNumber,
- }),
- ...(!Utils.isUndefined(stationInfo.meterType) && {
- meterType: stationInfo.meterType,
- }),
- };
- }
-
- private getHashId(stationInfo: ChargingStationInfo): string {
- const hashBootNotificationRequest = {
- chargePointModel: stationInfo.chargePointModel,
- chargePointVendor: stationInfo.chargePointVendor,
- ...(!Utils.isUndefined(stationInfo.chargeBoxSerialNumberPrefix) && {
- chargeBoxSerialNumber: stationInfo.chargeBoxSerialNumberPrefix,
- }),
- ...(!Utils.isUndefined(stationInfo.chargePointSerialNumberPrefix) && {
- chargePointSerialNumber: stationInfo.chargePointSerialNumberPrefix,
- }),
- ...(!Utils.isUndefined(stationInfo.firmwareVersion) && {
- firmwareVersion: stationInfo.firmwareVersion,
- }),
- ...(!Utils.isUndefined(stationInfo.iccid) && { iccid: stationInfo.iccid }),
- ...(!Utils.isUndefined(stationInfo.imsi) && { imsi: stationInfo.imsi }),
- ...(!Utils.isUndefined(stationInfo.meterSerialNumberPrefix) && {
- meterSerialNumber: stationInfo.meterSerialNumberPrefix,
- }),
- ...(!Utils.isUndefined(stationInfo.meterType) && {
- meterType: stationInfo.meterType,
- }),
- };
- return crypto
- .createHash(Constants.DEFAULT_HASH_ALGORITHM)
- .update(JSON.stringify(hashBootNotificationRequest) + stationInfo.chargingStationId)
- .digest('hex');
- }
-
private initialize(): void {
this.stationInfo = this.getStationInfo();
logger.info(`${this.logPrefix()} Charging station hashId '${this.hashId}'`);
- this.bootNotificationRequest = this.createBootNotificationRequest(this.stationInfo);
+ this.bootNotificationRequest = ChargingStationUtils.createBootNotificationRequest(
+ this.stationInfo
+ );
this.ocppConfiguration = this.getOcppConfiguration();
- delete this.stationInfo.Configuration;
+ this.stationInfo?.Configuration && delete this.stationInfo.Configuration;
this.wsConfiguredConnectionUrl = new URL(
this.getConfiguredSupervisionUrl().href + '/' + this.stationInfo.chargingStationId
);
// Build connectors if needed
const maxConnectors = this.getMaxNumberOfConnectors();
- if (maxConnectors <= 0) {
- logger.warn(
- `${this.logPrefix()} Charging station template ${
- this.templateFile
- } with ${maxConnectors} connectors`
- );
- }
+ this.checkMaxConnectors(maxConnectors);
const templateMaxConnectors = this.getTemplateMaxNumberOfConnectors();
- if (templateMaxConnectors <= 0) {
- logger.warn(
- `${this.logPrefix()} Charging station template ${
- this.templateFile
- } with no connector configuration`
- );
- }
- if (!this.stationInfo.Connectors[0]) {
- logger.warn(
- `${this.logPrefix()} Charging station template ${
- this.templateFile
- } with no connector Id 0 configuration`
- );
- }
- // Sanity check
+ this.checkTemplateMaxConnectors(templateMaxConnectors);
if (
maxConnectors >
- (this.stationInfo.Connectors[0] ? templateMaxConnectors - 1 : templateMaxConnectors) &&
+ (this.stationInfo?.Connectors[0] ? templateMaxConnectors - 1 : templateMaxConnectors) &&
!this.stationInfo.randomConnectors
) {
logger.warn(
);
this.stationInfo.randomConnectors = true;
}
- const connectorsConfigHash = crypto
- .createHash(Constants.DEFAULT_HASH_ALGORITHM)
- .update(JSON.stringify(this.stationInfo.Connectors) + maxConnectors.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 this.stationInfo.Connectors) {
- const lastConnectorId = Utils.convertToInt(lastConnector);
- if (
- lastConnectorId === 0 &&
- this.getUseConnectorId0() &&
- this.stationInfo.Connectors[lastConnector]
- ) {
- this.connectors.set(
- lastConnectorId,
- Utils.cloneObject<ConnectorStatus>(this.stationInfo.Connectors[lastConnector])
- );
- this.getConnectorStatus(lastConnectorId).availability = AvailabilityType.OPERATIVE;
- if (Utils.isUndefined(this.getConnectorStatus(lastConnectorId)?.chargingProfiles)) {
- this.getConnectorStatus(lastConnectorId).chargingProfiles = [];
- }
- }
- }
- // 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.getRandomInteger(Utils.convertToInt(lastConnector), 1)
- : index;
- this.connectors.set(
- index,
- Utils.cloneObject<ConnectorStatus>(this.stationInfo.Connectors[randConnectorId])
- );
- this.getConnectorStatus(index).availability = AvailabilityType.OPERATIVE;
- if (Utils.isUndefined(this.getConnectorStatus(index)?.chargingProfiles)) {
- this.getConnectorStatus(index).chargingProfiles = [];
- }
- }
- }
- }
+ this.initializeConnectors(this.stationInfo, maxConnectors, templateMaxConnectors);
this.stationInfo.maximumAmperage = this.getMaximumAmperage();
+ this.stationInfo = ChargingStationUtils.createStationInfoHash(this.stationInfo);
this.saveStationInfo();
// Avoid duplication of connectors related information in RAM
- delete this.stationInfo.Connectors;
- // Initialize transaction attributes on connectors
- for (const connectorId of this.connectors.keys()) {
- if (connectorId > 0 && !this.getConnectorStatus(connectorId)?.transactionStarted) {
- this.initializeConnectorStatus(connectorId);
- }
- }
+ this.stationInfo?.Connectors && delete this.stationInfo.Connectors;
// OCPP configuration
this.initializeOcppConfiguration();
if (this.getEnableStatistics()) {
switch (this.getOcppVersion()) {
case OCPPVersion.VERSION_16:
this.ocppIncomingRequestService =
- OCPP16IncomingRequestService.getInstance<OCPP16IncomingRequestService>(this);
+ OCPP16IncomingRequestService.getInstance<OCPP16IncomingRequestService>();
this.ocppRequestService = OCPP16RequestService.getInstance<OCPP16RequestService>(
- this,
- OCPP16ResponseService.getInstance<OCPP16ResponseService>(this)
+ OCPP16ResponseService.getInstance<OCPP16ResponseService>()
);
break;
default:
}
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() &&
- !this.getConfigurationKey(this.getSupervisionUrlOcppKey())
+ !ChargingStationConfigurationUtils.getConfigurationKey(this, this.getSupervisionUrlOcppKey())
) {
- this.addConfigurationKey(
+ ChargingStationConfigurationUtils.addConfigurationKey(
+ this,
this.getSupervisionUrlOcppKey(),
this.getConfiguredSupervisionUrl().href,
{ reboot: true }
);
} else if (
!this.getSupervisionUrlOcppConfiguration() &&
- this.getConfigurationKey(this.getSupervisionUrlOcppKey())
+ ChargingStationConfigurationUtils.getConfigurationKey(this, this.getSupervisionUrlOcppKey())
) {
- this.deleteConfigurationKey(this.getSupervisionUrlOcppKey(), { save: false });
+ ChargingStationConfigurationUtils.deleteConfigurationKey(
+ this,
+ this.getSupervisionUrlOcppKey(),
+ { save: false }
+ );
}
if (
this.stationInfo.amperageLimitationOcppKey &&
- !this.getConfigurationKey(this.stationInfo.amperageLimitationOcppKey)
+ !ChargingStationConfigurationUtils.getConfigurationKey(
+ this,
+ this.stationInfo.amperageLimitationOcppKey
+ )
) {
- this.addConfigurationKey(
+ ChargingStationConfigurationUtils.addConfigurationKey(
+ this,
this.stationInfo.amperageLimitationOcppKey,
- (this.stationInfo.maximumAmperage * this.getAmperageLimitationUnitDivider()).toString()
+ (
+ this.stationInfo.maximumAmperage *
+ ChargingStationUtils.getAmperageLimitationUnitDivider(this.stationInfo)
+ ).toString()
);
}
- if (!this.getConfigurationKey(StandardParametersKey.SupportedFeatureProfiles)) {
- this.addConfigurationKey(
+ if (
+ !ChargingStationConfigurationUtils.getConfigurationKey(
+ this,
+ StandardParametersKey.SupportedFeatureProfiles
+ )
+ ) {
+ ChargingStationConfigurationUtils.addConfigurationKey(
+ this,
StandardParametersKey.SupportedFeatureProfiles,
`${SupportedFeatureProfiles.Core},${SupportedFeatureProfiles.FirmwareManagement},${SupportedFeatureProfiles.LocalAuthListManagement},${SupportedFeatureProfiles.SmartCharging},${SupportedFeatureProfiles.RemoteTrigger}`
);
}
- this.addConfigurationKey(
+ ChargingStationConfigurationUtils.addConfigurationKey(
+ this,
StandardParametersKey.NumberOfConnectors,
this.getNumberOfConnectors().toString(),
{ readonly: true },
{ overwrite: true }
);
- if (!this.getConfigurationKey(StandardParametersKey.MeterValuesSampledData)) {
- this.addConfigurationKey(
+ if (
+ !ChargingStationConfigurationUtils.getConfigurationKey(
+ this,
+ StandardParametersKey.MeterValuesSampledData
+ )
+ ) {
+ ChargingStationConfigurationUtils.addConfigurationKey(
+ this,
StandardParametersKey.MeterValuesSampledData,
MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER
);
}
- if (!this.getConfigurationKey(StandardParametersKey.ConnectorPhaseRotation)) {
+ if (
+ !ChargingStationConfigurationUtils.getConfigurationKey(
+ this,
+ StandardParametersKey.ConnectorPhaseRotation
+ )
+ ) {
const connectorPhaseRotation = [];
for (const connectorId of this.connectors.keys()) {
// AC/DC
connectorPhaseRotation.push(`${connectorId}.${ConnectorPhaseRotation.RST}`);
}
}
- this.addConfigurationKey(
+ ChargingStationConfigurationUtils.addConfigurationKey(
+ this,
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.LocalAuthListManagement
+ !ChargingStationConfigurationUtils.getConfigurationKey(
+ this,
+ StandardParametersKey.AuthorizeRemoteTxRequests
)
) {
- this.addConfigurationKey(StandardParametersKey.LocalAuthListEnabled, 'false');
+ 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 (!this.getConfigurationKey(StandardParametersKey.ConnectionTimeOut)) {
- this.addConfigurationKey(
+ if (
+ !ChargingStationConfigurationUtils.getConfigurationKey(
+ this,
+ StandardParametersKey.ConnectionTimeOut
+ )
+ ) {
+ ChargingStationConfigurationUtils.addConfigurationKey(
+ this,
StandardParametersKey.ConnectionTimeOut,
Constants.DEFAULT_CONNECTION_TIMEOUT.toString()
);
this.saveOcppConfiguration();
}
+ private initializeConnectors(
+ stationInfo: ChargingStationInfo,
+ maxConnectors: number,
+ templateMaxConnectors: number
+ ): void {
+ if (!stationInfo?.Connectors && this.connectors.size === 0) {
+ const logMsg = `${this.logPrefix()} No already defined connectors and charging station information from template ${
+ this.templateFile
+ } with no connectors configuration defined`;
+ logger.error(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) + maxConnectors.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 lastConnectorId = Utils.convertToInt(lastConnector);
+ if (
+ lastConnectorId === 0 &&
+ this.getUseConnectorId0() &&
+ stationInfo?.Connectors[lastConnector]
+ ) {
+ this.connectors.set(
+ lastConnectorId,
+ Utils.cloneObject<ConnectorStatus>(stationInfo?.Connectors[lastConnector])
+ );
+ 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 <= maxConnectors; index++) {
+ const randConnectorId = stationInfo.randomConnectors
+ ? Utils.getRandomInteger(Utils.convertToInt(lastConnector), 1)
+ : index;
+ this.connectors.set(
+ index,
+ Utils.cloneObject<ConnectorStatus>(stationInfo?.Connectors[randConnectorId])
+ );
+ 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`
+ );
+ }
+ // Initialize transaction attributes on connectors
+ for (const connectorId of this.connectors.keys()) {
+ if (connectorId > 0 && !this.getConnectorStatus(connectorId)?.transactionStarted) {
+ this.initializeConnectorStatus(connectorId);
+ }
+ }
+ }
+
+ private checkMaxConnectors(maxConnectors: number): void {
+ if (maxConnectors <= 0) {
+ logger.warn(
+ `${this.logPrefix()} Charging station information from template ${
+ this.templateFile
+ } with ${maxConnectors} connectors`
+ );
+ }
+ }
+
+ private checkTemplateMaxConnectors(templateMaxConnectors: number): void {
+ if (templateMaxConnectors === 0) {
+ logger.warn(
+ `${this.logPrefix()} Charging station information from template ${
+ this.templateFile
+ } with empty connectors configuration`
+ );
+ } else if (templateMaxConnectors < 0) {
+ logger.error(
+ `${this.logPrefix()} Charging station information from template ${
+ this.templateFile
+ } with no connectors configuration defined`
+ );
+ }
+ }
+
private getConfigurationFromFile(): ChargingStationConfiguration | null {
let configuration: ChargingStationConfiguration = null;
if (this.configurationFile && fs.existsSync(this.configurationFile)) {
configurationData.configurationKey = this.ocppConfiguration.configurationKey;
break;
case Section.stationInfo:
+ if (configurationData?.stationInfo?.infoHash === this.stationInfo?.infoHash) {
+ logger.debug(
+ `${this.logPrefix()} Not saving unchanged charging station information to configuration file ${
+ this.configurationFile
+ }`
+ );
+ return;
+ }
configurationData.stationInfo = this.stationInfo;
break;
default:
configurationData.configurationKey = this.ocppConfiguration.configurationKey;
- configurationData.stationInfo = this.stationInfo;
+ if (configurationData?.stationInfo?.infoHash !== this.stationInfo?.infoHash) {
+ configurationData.stationInfo = this.stationInfo;
+ }
break;
}
const measureId = `${FileType.ChargingStationConfiguration} write`;
}
} else {
logger.error(
- `${this.logPrefix()} Trying to save charging station configuration to undefined file`
+ `${this.logPrefix()} Trying to save charging station configuration to undefined configuration file`
);
}
}
return ocppConfiguration;
}
- private saveOcppConfiguration(): void {
- if (this.getOcppPersistentConfiguration()) {
- this.saveConfiguration(Section.ocppConfiguration);
- }
- }
-
private async onOpen(): Promise<void> {
if (this.isWebSocketConnectionOpened()) {
logger.info(
`${this.logPrefix()} Connection to OCPP server through ${this.wsConnectionUrl.toString()} succeeded`
);
- if (!this.isInAcceptedState()) {
+ if (!this.isRegistered()) {
// Send BootNotification
let registrationRetryCount = 0;
do {
- this.bootNotificationResponse = await this.ocppRequestService.sendMessageHandler<
+ this.bootNotificationResponse = await this.ocppRequestService.requestHandler<
BootNotificationRequest,
BootNotificationResponse
>(
+ this,
RequestCommand.BOOT_NOTIFICATION,
{
chargePointModel: this.bootNotificationRequest.chargePointModel,
},
{ skipBufferingOnError: true }
);
- if (!this.isInAcceptedState()) {
+ if (!this.isRegistered()) {
this.getRegistrationMaxRetries() !== -1 && registrationRetryCount++;
await Utils.sleep(
this.bootNotificationResponse?.interval
);
}
} while (
- !this.isInAcceptedState() &&
+ !this.isRegistered() &&
(registrationRetryCount <= this.getRegistrationMaxRetries() ||
this.getRegistrationMaxRetries() === -1)
);
}
- if (this.isInAcceptedState()) {
- await this.startMessageSequence();
- this.stopped && (this.stopped = false);
- if (this.wsConnectionRestarted) {
- this.flushMessageBuffer();
+ if (this.isRegistered()) {
+ if (this.isInAcceptedState()) {
+ await this.startMessageSequence();
+ this.wsConnectionRestarted && this.flushMessageBuffer();
}
} else {
logger.error(
`${this.logPrefix()} Registration failure: max retries reached (${this.getRegistrationMaxRetries()}) or retry disabled (${this.getRegistrationMaxRetries()})`
);
}
+ this.stopped && (this.stopped = false);
this.autoReconnectRetryCount = 0;
this.wsConnectionRestarted = false;
} else {
case WebSocketCloseEventStatusCode.CLOSE_NORMAL:
case WebSocketCloseEventStatusCode.CLOSE_NO_STATUS:
logger.info(
- `${this.logPrefix()} WebSocket normally closed with status '${Utils.getWebSocketCloseEventStatusString(
+ `${this.logPrefix()} WebSocket normally closed with status '${ChargingStationUtils.getWebSocketCloseEventStatusString(
code
)}' and reason '${reason}'`
);
// Abnormal close
default:
logger.error(
- `${this.logPrefix()} WebSocket abnormally closed with status '${Utils.getWebSocketCloseEventStatusString(
+ `${this.logPrefix()} WebSocket abnormally closed with status '${ChargingStationUtils.getWebSocketCloseEventStatusString(
code
)}' and reason '${reason}'`
);
}
private async onMessage(data: Data): Promise<void> {
- let [messageType, messageId, commandName, commandPayload, errorDetails]: IncomingRequest = [
- 0,
- '',
- '' as IncomingRequestCommand,
- {},
- {},
- ];
- let responseCallback: (
- payload: JsonType | string,
- requestPayload: JsonType | OCPPError
- ) => void;
- let rejectCallback: (error: OCPPError, requestStatistic?: boolean) => void;
+ let messageType: number;
+ let messageId: string;
+ let commandName: IncomingRequestCommand;
+ let commandPayload: JsonType;
+ let errorType: ErrorType;
+ let errorMessage: string;
+ let errorDetails: JsonType;
+ let responseCallback: (payload: JsonType, requestPayload: JsonType) => void;
+ let errorCallback: (error: OCPPError, requestStatistic?: boolean) => void;
let requestCommandName: RequestCommand | IncomingRequestCommand;
- let requestPayload: JsonType | OCPPError;
+ let requestPayload: JsonType;
let cachedRequest: CachedRequest;
let errMsg: string;
try {
- const request = JSON.parse(data.toString()) as IncomingRequest;
- const requestAsString = JSON.stringify(request);
- console.log(chalk`{yellow << Received message = ${requestAsString}}`);
+ const request = JSON.parse(data.toString()) as IncomingRequest | Response | ErrorResponse;
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.performanceStatistics.addRequestStatistic(commandName, messageType);
- }
- // Process the call
- await this.ocppIncomingRequestService.handleRequest(
- messageId,
- commandName,
- commandPayload
- );
- break;
- // Outcome Message
- case MessageType.CALL_RESULT_MESSAGE:
- // Respond
- cachedRequest = this.requests.get(messageId);
- if (Utils.isIterable(cachedRequest)) {
- [responseCallback, , , requestPayload] = cachedRequest;
- } else {
- throw new OCPPError(
- ErrorType.PROTOCOL_ERROR,
- `Cached request for message id ${messageId} response is not iterable`,
- commandName
+ [messageType, messageId] = request;
+ // Check the type of message
+ switch (messageType) {
+ // Incoming Message
+ case MessageType.CALL_MESSAGE:
+ [, , commandName, commandPayload] = request as IncomingRequest;
+ if (this.getEnableStatistics()) {
+ this.performanceStatistics.addRequestStatistic(commandName, messageType);
+ }
+ logger.debug(
+ `${this.logPrefix()} << Command '${commandName}' received request payload: ${JSON.stringify(
+ request
+ )}`
);
- }
- if (!responseCallback) {
- // Error
- throw new OCPPError(
- ErrorType.INTERNAL_ERROR,
- `Response for unknown message id ${messageId}`,
- commandName
+ // Process the message
+ await this.ocppIncomingRequestService.incomingRequestHandler(
+ this,
+ messageId,
+ commandName,
+ commandPayload
);
- }
- responseCallback(commandName, requestPayload);
- break;
- // Error Message
- case MessageType.CALL_ERROR_MESSAGE:
- cachedRequest = this.requests.get(messageId);
- if (Utils.isIterable(cachedRequest)) {
- [, rejectCallback, requestCommandName] = cachedRequest;
- } else {
- throw new OCPPError(
- ErrorType.PROTOCOL_ERROR,
- `Cached request for message id ${messageId} error response is not iterable`
+ break;
+ // Outcome Message
+ case MessageType.CALL_RESULT_MESSAGE:
+ [, , commandPayload] = request as Response;
+ if (!this.requests.has(messageId)) {
+ // Error
+ throw new OCPPError(
+ ErrorType.INTERNAL_ERROR,
+ `Response for unknown message id ${messageId}`,
+ null,
+ commandPayload
+ );
+ }
+ // Respond
+ cachedRequest = this.requests.get(messageId);
+ if (Utils.isIterable(cachedRequest)) {
+ [responseCallback, , requestCommandName, requestPayload] = cachedRequest;
+ } else {
+ throw new OCPPError(
+ ErrorType.PROTOCOL_ERROR,
+ `Cached request for message id ${messageId} response is not iterable`,
+ null,
+ cachedRequest as unknown as JsonType
+ );
+ }
+ logger.debug(
+ `${this.logPrefix()} << Command '${
+ requestCommandName ?? ''
+ }' received response payload: ${JSON.stringify(request)}`
);
- }
- if (!rejectCallback) {
- // Error
- throw new OCPPError(
- ErrorType.INTERNAL_ERROR,
- `Error response for unknown message id ${messageId}`,
- requestCommandName
+ responseCallback(commandPayload, requestPayload);
+ break;
+ // Error Message
+ case MessageType.CALL_ERROR_MESSAGE:
+ [, , errorType, errorMessage, errorDetails] = request as ErrorResponse;
+ if (!this.requests.has(messageId)) {
+ // Error
+ throw new OCPPError(
+ ErrorType.INTERNAL_ERROR,
+ `Error response for unknown message id ${messageId}`,
+ null,
+ { errorType, errorMessage, errorDetails }
+ );
+ }
+ cachedRequest = this.requests.get(messageId);
+ if (Utils.isIterable(cachedRequest)) {
+ [, errorCallback, requestCommandName] = cachedRequest;
+ } else {
+ throw new OCPPError(
+ ErrorType.PROTOCOL_ERROR,
+ `Cached request for message id ${messageId} error response is not iterable`,
+ null,
+ cachedRequest as unknown as JsonType
+ );
+ }
+ logger.debug(
+ `${this.logPrefix()} << Command '${
+ requestCommandName ?? ''
+ }' received error payload: ${JSON.stringify(request)}`
);
- }
- rejectCallback(
- new OCPPError(commandName, commandPayload.toString(), requestCommandName, errorDetails)
- );
- break;
- // Error
- default:
- // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
- errMsg = `${this.logPrefix()} Wrong message type ${messageType}`;
- logger.error(errMsg);
- throw new OCPPError(ErrorType.PROTOCOL_ERROR, errMsg);
+ errorCallback(new OCPPError(errorType, errorMessage, requestCommandName, errorDetails));
+ break;
+ // Error
+ default:
+ // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
+ errMsg = `${this.logPrefix()} Wrong message type ${messageType}`;
+ logger.error(errMsg);
+ throw new OCPPError(ErrorType.PROTOCOL_ERROR, errMsg);
+ }
+ } else {
+ throw new OCPPError(ErrorType.PROTOCOL_ERROR, 'Incoming message is not iterable', null, {
+ payload: request,
+ });
}
} catch (error) {
// Log
);
// Send error
messageType === MessageType.CALL_MESSAGE &&
- (await this.ocppRequestService.sendError(messageId, error as OCPPError, commandName));
+ (await this.ocppRequestService.sendError(
+ this,
+ messageId,
+ error as OCPPError,
+ commandName ?? requestCommandName ?? null
+ ));
}
}
// 0 for disabling
private getConnectionTimeout(): number | undefined {
- if (this.getConfigurationKey(StandardParametersKey.ConnectionTimeOut)) {
+ if (
+ ChargingStationConfigurationUtils.getConfigurationKey(
+ this,
+ StandardParametersKey.ConnectionTimeOut
+ )
+ ) {
return (
- parseInt(this.getConfigurationKey(StandardParametersKey.ConnectionTimeOut).value) ??
- Constants.DEFAULT_CONNECTION_TIMEOUT
+ parseInt(
+ ChargingStationConfigurationUtils.getConfigurationKey(
+ this,
+ StandardParametersKey.ConnectionTimeOut
+ ).value
+ ) ?? Constants.DEFAULT_CONNECTION_TIMEOUT
);
}
return Constants.DEFAULT_CONNECTION_TIMEOUT;
}
private getTemplateMaxNumberOfConnectors(): number {
- return Object.keys(this.stationInfo.Connectors).length;
+ if (!this.stationInfo?.Connectors) {
+ return -1;
+ }
+ return Object.keys(this.stationInfo?.Connectors).length;
}
private getMaxNumberOfConnectors(): number {
} else if (!Utils.isUndefined(this.stationInfo.numberOfConnectors)) {
maxConnectors = this.stationInfo.numberOfConnectors as number;
} else {
- maxConnectors = this.stationInfo.Connectors[0]
+ maxConnectors = this.stationInfo?.Connectors[0]
? this.getTemplateMaxNumberOfConnectors() - 1
: this.getTemplateMaxNumberOfConnectors();
}
}
}
- private getAmperageLimitationUnitDivider(): number {
- let unitDivider = 1;
- switch (this.stationInfo.amperageLimitationUnit) {
- case AmpereUnits.DECI_AMPERE:
- unitDivider = 10;
- break;
- case AmpereUnits.CENTI_AMPERE:
- unitDivider = 100;
- break;
- case AmpereUnits.MILLI_AMPERE:
- unitDivider = 1000;
- break;
- }
- return unitDivider;
- }
-
private getAmperageLimitation(): number | undefined {
if (
this.stationInfo.amperageLimitationOcppKey &&
- this.getConfigurationKey(this.stationInfo.amperageLimitationOcppKey)
+ ChargingStationConfigurationUtils.getConfigurationKey(
+ this,
+ this.stationInfo.amperageLimitationOcppKey
+ )
) {
return (
Utils.convertToInt(
- this.getConfigurationKey(this.stationInfo.amperageLimitationOcppKey).value
- ) / this.getAmperageLimitationUnitDivider()
+ ChargingStationConfigurationUtils.getConfigurationKey(
+ this,
+ this.stationInfo.amperageLimitationOcppKey
+ ).value
+ ) / ChargingStationUtils.getAmperageLimitationUnitDivider(this.stationInfo)
);
}
}
private async startMessageSequence(): Promise<void> {
if (this.stationInfo.autoRegister) {
- await this.ocppRequestService.sendMessageHandler<
+ await this.ocppRequestService.requestHandler<
BootNotificationRequest,
BootNotificationResponse
>(
+ this,
RequestCommand.BOOT_NOTIFICATION,
{
chargePointModel: this.bootNotificationRequest.chargePointModel,
this.getConnectorStatus(connectorId)?.bootStatus
) {
// Send status in template at startup
- await this.ocppRequestService.sendMessageHandler<
+ await this.ocppRequestService.requestHandler<
StatusNotificationRequest,
StatusNotificationResponse
- >(RequestCommand.STATUS_NOTIFICATION, {
+ >(this, RequestCommand.STATUS_NOTIFICATION, {
connectorId,
status: this.getConnectorStatus(connectorId).bootStatus,
errorCode: ChargePointErrorCode.NO_ERROR,
this.getConnectorStatus(connectorId)?.bootStatus
) {
// Send status in template after reset
- await this.ocppRequestService.sendMessageHandler<
+ await this.ocppRequestService.requestHandler<
StatusNotificationRequest,
StatusNotificationResponse
- >(RequestCommand.STATUS_NOTIFICATION, {
+ >(this, RequestCommand.STATUS_NOTIFICATION, {
connectorId,
status: this.getConnectorStatus(connectorId).bootStatus,
errorCode: ChargePointErrorCode.NO_ERROR,
this.getConnectorStatus(connectorId).bootStatus;
} else if (!this.stopped && this.getConnectorStatus(connectorId)?.status) {
// Send previous status at template reload
- await this.ocppRequestService.sendMessageHandler<
+ await this.ocppRequestService.requestHandler<
StatusNotificationRequest,
StatusNotificationResponse
- >(RequestCommand.STATUS_NOTIFICATION, {
+ >(this, RequestCommand.STATUS_NOTIFICATION, {
connectorId,
status: this.getConnectorStatus(connectorId).status,
errorCode: ChargePointErrorCode.NO_ERROR,
});
} else {
// Send default status
- await this.ocppRequestService.sendMessageHandler<
+ await this.ocppRequestService.requestHandler<
StatusNotificationRequest,
StatusNotificationResponse
- >(RequestCommand.STATUS_NOTIFICATION, {
+ >(this, RequestCommand.STATUS_NOTIFICATION, {
connectorId,
status: ChargePointStatus.AVAILABLE,
errorCode: ChargePointErrorCode.NO_ERROR,
connectorId,
this.getEnergyActiveImportRegisterByTransactionId(transactionId)
);
- await this.ocppRequestService.sendMessageHandler<
- MeterValuesRequest,
- MeterValuesResponse
- >(RequestCommand.METER_VALUES, {
- connectorId,
- transactionId,
- meterValue: transactionEndMeterValue,
- });
+ await this.ocppRequestService.requestHandler<MeterValuesRequest, MeterValuesResponse>(
+ this,
+ RequestCommand.METER_VALUES,
+ {
+ connectorId,
+ transactionId,
+ meterValue: transactionEndMeterValue,
+ }
+ );
}
- await this.ocppRequestService.sendMessageHandler<
+ await this.ocppRequestService.requestHandler<
StopTransactionRequest,
StopTransactionResponse
- >(RequestCommand.STOP_TRANSACTION, {
+ >(this, RequestCommand.STOP_TRANSACTION, {
transactionId,
meterStop: this.getEnergyActiveImportRegisterByTransactionId(transactionId),
idTag: this.getTransactionIdTag(transactionId),
}
private startWebSocketPing(): void {
- const webSocketPingInterval: number = this.getConfigurationKey(
+ const webSocketPingInterval: number = ChargingStationConfigurationUtils.getConfigurationKey(
+ this,
StandardParametersKey.WebSocketPingInterval
)
? Utils.convertToInt(
- this.getConfigurationKey(StandardParametersKey.WebSocketPingInterval).value
+ ChargingStationConfigurationUtils.getConfigurationKey(
+ this,
+ StandardParametersKey.WebSocketPingInterval
+ ).value
)
: 0;
if (webSocketPingInterval > 0 && !this.webSocketPingSetInterval) {
}
}
- private warnDeprecatedTemplateKey(
- template: ChargingStationTemplate,
- key: string,
- chargingStationId: string,
- logMsgToAppend = ''
- ): void {
- if (!Utils.isUndefined(template[key])) {
- const logPrefixStr = ` ${chargingStationId} |`;
- logger.warn(
- `${Utils.logPrefix(logPrefixStr)} Deprecated template key '${key}' usage in file '${
- this.templateFile
- }'${logMsgToAppend && '. ' + logMsgToAppend}`
- );
- }
- }
-
- private convertDeprecatedTemplateKey(
- template: ChargingStationTemplate,
- deprecatedKey: string,
- key: string
- ): void {
- if (!Utils.isUndefined(template[deprecatedKey])) {
- template[key] = template[deprecatedKey] as unknown;
- delete template[deprecatedKey];
- }
- }
-
private getConfiguredSupervisionUrl(): URL {
const supervisionUrls = Utils.cloneObject<string | string[]>(
this.stationInfo.supervisionUrls ?? Configuration.getSupervisionUrls()
}
private getHeartbeatInterval(): number | undefined {
- const HeartbeatInterval = this.getConfigurationKey(StandardParametersKey.HeartbeatInterval);
+ 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;
}