// Partial Copyright Jerome Benoit. 2021. All Rights Reserved.
+import { ACElectricUtils, DCElectricUtils } from '../utils/ElectricUtils';
import {
AvailabilityType,
BootNotificationRequest,
CachedRequest,
+ HeartbeatRequest,
IncomingRequest,
IncomingRequestCommand,
+ MeterValuesRequest,
RequestCommand,
+ StatusNotificationRequest,
} from '../types/ocpp/Requests';
-import { BootNotificationResponse, RegistrationStatus } from '../types/ocpp/Responses';
-import ChargingStationConfiguration, {
+import {
+ BootNotificationResponse,
+ ErrorResponse,
+ HeartbeatResponse,
+ MeterValuesResponse,
+ RegistrationStatus,
+ Response,
+ StatusNotificationResponse,
+} from '../types/ocpp/Responses';
+import {
+ ChargingProfile,
+ ChargingRateUnitType,
+ ChargingSchedulePeriod,
+} from '../types/ocpp/ChargingProfile';
+import ChargingStationConfiguration, { Section } from '../types/ChargingStationConfiguration';
+import ChargingStationOcppConfiguration, {
ConfigurationKey,
-} from '../types/ChargingStationConfiguration';
+} from '../types/ChargingStationOcppConfiguration';
import ChargingStationTemplate, {
+ AmpereUnits,
CurrentType,
PowerUnits,
Voltage,
+ WsOptions,
} from '../types/ChargingStationTemplate';
import {
ConnectorPhaseRotation,
VendorDefaultParametersKey,
} from '../types/ocpp/Configuration';
import { MeterValue, MeterValueMeasurand, MeterValuePhase } from '../types/ocpp/MeterValues';
+import {
+ StopTransactionReason,
+ StopTransactionRequest,
+ StopTransactionResponse,
+} from '../types/ocpp/Transaction';
import { WSError, WebSocketCloseEventStatusCode } from '../types/WebSocket';
-import WebSocket, { ClientOptions, Data, OPEN, RawData } from 'ws';
+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 { ChargingProfile } from '../types/ocpp/ChargingProfile';
import ChargingStationInfo from '../types/ChargingStationInfo';
import { ChargingStationWorkerMessageEvents } from '../types/ChargingStationWorker';
-import { ClientRequestArgs } from 'http';
import Configuration from '../utils/Configuration';
import { ConnectorStatus } from '../types/ConnectorStatus';
import Constants from '../utils/Constants';
import { OCPPVersion } from '../types/ocpp/OCPPVersion';
import PerformanceStatistics from '../performance/PerformanceStatistics';
import { SampledValueTemplate } from '../types/MeasurandPerPhaseSampledValueTemplates';
-import { StopTransactionReason } from '../types/ocpp/Transaction';
import { SupervisionUrlDistribution } from '../types/ConfigurationData';
import { URL } from 'url';
import Utils from '../utils/Utils';
export default class ChargingStation {
public hashId!: string;
- public readonly stationTemplateFile: string;
+ public readonly templateFile: string;
public authorizedTags: string[];
public stationInfo!: ChargingStationInfo;
public readonly connectors: Map<number, ConnectorStatus>;
- public configuration!: ChargingStationConfiguration;
+ public ocppConfiguration!: ChargingStationOcppConfiguration;
public wsConnection!: WebSocket;
public readonly requests: Map<string, CachedRequest>;
public performanceStatistics!: PerformanceStatistics;
public heartbeatSetInterval!: NodeJS.Timeout;
public ocppRequestService!: OCPPRequestService;
+ public bootNotificationResponse!: BootNotificationResponse | null;
private readonly index: number;
private configurationFile!: string;
private bootNotificationRequest!: BootNotificationRequest;
- private bootNotificationResponse!: BootNotificationResponse | null;
private connectorsConfigurationHash!: string;
private ocppIncomingRequestService!: OCPPIncomingRequestService;
private readonly messageBuffer: Set<string>;
private automaticTransactionGenerator!: AutomaticTransactionGenerator;
private webSocketPingSetInterval!: NodeJS.Timeout;
- constructor(index: number, stationTemplateFile: string) {
+ constructor(index: number, templateFile: string) {
this.index = index;
- this.stationTemplateFile = stationTemplateFile;
+ this.templateFile = templateFile;
this.stopped = false;
this.wsConnectionRestarted = false;
this.autoReconnectRetryCount = 0;
public getVoltageOut(): number | undefined {
const errMsg = `${this.logPrefix()} Unknown ${this.getCurrentOutType()} currentOutType in template file ${
- this.stationTemplateFile
+ this.templateFile
}, cannot define default voltage out`;
let defaultVoltageOut: number;
switch (this.getCurrentOutType()) {
: defaultVoltageOut;
}
+ public getConnectorMaximumAvailablePower(connectorId: number): number {
+ let connectorAmperageLimitationPowerLimit: number;
+ if (
+ !Utils.isNullOrUndefined(this.getAmperageLimitation()) &&
+ this.getAmperageLimitation() < this.stationInfo.maximumAmperage
+ ) {
+ connectorAmperageLimitationPowerLimit =
+ (this.getCurrentOutType() === CurrentType.AC
+ ? ACElectricUtils.powerTotal(
+ this.getNumberOfPhases(),
+ this.getVoltageOut(),
+ this.getAmperageLimitation() * this.getNumberOfConnectors()
+ )
+ : DCElectricUtils.power(this.getVoltageOut(), this.getAmperageLimitation())) /
+ this.stationInfo.powerDivider;
+ }
+ const connectorMaximumPower = this.getMaximumPower() / this.stationInfo.powerDivider;
+ const connectorChargingProfilePowerLimit = this.getChargingProfilePowerLimit(connectorId);
+ return Math.min(
+ isNaN(connectorMaximumPower) ? Infinity : connectorMaximumPower,
+ isNaN(connectorAmperageLimitationPowerLimit)
+ ? Infinity
+ : connectorAmperageLimitationPowerLimit,
+ isNaN(connectorChargingProfilePowerLimit) ? Infinity : connectorChargingProfilePowerLimit
+ );
+ }
+
public getTransactionIdTag(transactionId: number): string | undefined {
for (const connectorId of this.connectors.keys()) {
if (connectorId > 0 && this.getConnectorStatus(connectorId).transactionId === transactionId) {
}
if (
measurand !== MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER &&
- !this.getConfigurationKey(StandardParametersKey.MeterValuesSampledData).value.includes(
+ !this.getConfigurationKey(StandardParametersKey.MeterValuesSampledData)?.value.includes(
measurand
)
) {
phase &&
sampledValueTemplates[index]?.phase === phase &&
sampledValueTemplates[index]?.measurand === measurand &&
- this.getConfigurationKey(StandardParametersKey.MeterValuesSampledData).value.includes(
+ this.getConfigurationKey(StandardParametersKey.MeterValuesSampledData)?.value.includes(
measurand
)
) {
!phase &&
!sampledValueTemplates[index].phase &&
sampledValueTemplates[index]?.measurand === measurand &&
- this.getConfigurationKey(StandardParametersKey.MeterValuesSampledData).value.includes(
+ this.getConfigurationKey(StandardParametersKey.MeterValuesSampledData)?.value.includes(
measurand
)
) {
) {
// eslint-disable-next-line @typescript-eslint/no-misused-promises
this.heartbeatSetInterval = setInterval(async (): Promise<void> => {
- await this.ocppRequestService.sendMessageHandler(RequestCommand.HEARTBEAT);
+ await this.ocppRequestService.requestHandler<HeartbeatRequest, HeartbeatResponse>(
+ RequestCommand.HEARTBEAT
+ );
}, this.getHeartbeatInterval());
logger.info(
this.logPrefix() +
this.getConnectorStatus(connectorId).transactionId,
interval
);
- await this.ocppRequestService.sendMessageHandler(RequestCommand.METER_VALUES, {
- connectorId,
- transactionId: this.getConnectorStatus(connectorId).transactionId,
- meterValue: [meterValue],
- });
+ await this.ocppRequestService.requestHandler<MeterValuesRequest, MeterValuesResponse>(
+ RequestCommand.METER_VALUES,
+ {
+ connectorId,
+ transactionId: this.getConnectorStatus(connectorId).transactionId,
+ meterValue: [meterValue],
+ }
+ );
},
interval
);
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(),
FileUtils.watchJsonFile(
this.logPrefix(),
FileType.ChargingStationTemplate,
- this.stationTemplateFile,
+ this.templateFile,
null,
(event, filename): void => {
if (filename && event === 'change') {
try {
logger.debug(
`${this.logPrefix()} ${FileType.ChargingStationTemplate} ${
- this.stationTemplateFile
+ this.templateFile
} file have changed, reload`
);
// Initialize
}
}
);
- // 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(RequestCommand.STATUS_NOTIFICATION, {
+ await this.ocppRequestService.requestHandler<
+ StatusNotificationRequest,
+ StatusNotificationResponse
+ >(RequestCommand.STATUS_NOTIFICATION, {
connectorId,
status: ChargePointStatus.UNAVAILABLE,
errorCode: ChargePointErrorCode.NO_ERROR,
this.stopped = true;
}
+ 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 getConfigurationKey(
key: string | StandardParametersKey,
caseInsensitive = false
): ConfigurationKey | undefined {
- return this.configuration.configurationKey.find((configElement) => {
+ return this.ocppConfiguration.configurationKey.find((configElement) => {
if (caseInsensitive) {
return configElement.key.toLowerCase() === key.toLowerCase();
}
},
params: { overwrite?: boolean; save?: boolean } = { overwrite: false, save: false }
): void {
- if (!options || Utils.isEmptyObject(options)) {
- options = {
- readonly: false,
- visible: true,
- reboot: false,
- };
- }
- const readonly = options.readonly;
- const visible = options.visible;
- const reboot = options.reboot;
+ 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.configuration.configurationKey.push({
+ this.ocppConfiguration.configurationKey.push({
key,
- readonly,
+ readonly: options.readonly,
value,
- visible,
- reboot,
+ visible: options.visible,
+ reboot: options.reboot,
});
- params?.save && this.saveConfiguration();
+ params?.save && this.saveOcppConfiguration();
} else {
logger.error(
`${this.logPrefix()} Trying to add an already existing configuration key: %j`,
): void {
const keyFound = this.getConfigurationKey(key, caseInsensitive);
if (keyFound) {
- const keyIndex = this.configuration.configurationKey.indexOf(keyFound);
- this.configuration.configurationKey[keyIndex].value = value;
- this.saveConfiguration();
+ 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`,
): ConfigurationKey[] {
const keyFound = this.getConfigurationKey(key, params?.caseInsensitive);
if (keyFound) {
- const deletedConfigurationKey = this.configuration.configurationKey.splice(
- this.configuration.configurationKey.indexOf(keyFound),
+ const deletedConfigurationKey = this.ocppConfiguration.configurationKey.splice(
+ this.ocppConfiguration.configurationKey.indexOf(keyFound),
1
);
- params?.save && this.saveConfiguration();
+ params?.save && this.saveOcppConfiguration();
return deletedConfigurationKey;
}
}
+ 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;
+ }
+ }
+ }
+ }
+ }
+ 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 {
let cpReplaced = false;
if (!Utils.isEmptyArray(this.getConnectorStatus(connectorId).chargingProfiles)) {
this.stopMeterValues(connectorId);
}
+ public hasFeatureProfile(featureProfile: SupportedFeatureProfiles) {
+ return this.getConfigurationKey(StandardParametersKey.SupportedFeatureProfiles)?.value.includes(
+ featureProfile
+ );
+ }
+
public bufferMessage(message: string): void {
this.messageBuffer.add(message);
}
idSuffix;
}
- private buildStationInfo(): ChargingStationInfo {
- let stationTemplateFromFile: ChargingStationTemplate;
+ 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 {
- // Load template file
- stationTemplateFromFile = JSON.parse(
- fs.readFileSync(this.stationTemplateFile, 'utf8')
- ) as ChargingStationTemplate;
+ const measureId = `${FileType.ChargingStationTemplate} read`;
+ const beginId = PerformanceStatistics.beginMeasure(measureId);
+ 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(),
FileType.ChargingStationTemplate,
- this.stationTemplateFile,
+ this.templateFile,
error as NodeJS.ErrnoException
);
}
- const chargingStationId = this.getChargingStationId(stationTemplateFromFile);
+ return template;
+ }
+
+ private createSerialNumber(
+ stationInfo: ChargingStationInfo,
+ existingStationInfo?: ChargingStationInfo,
+ params: { randomSerialNumberUpperCase?: boolean; randomSerialNumber?: boolean } = {
+ randomSerialNumberUpperCase: true,
+ randomSerialNumber: true,
+ }
+ ): void {
+ params = params ?? {};
+ params.randomSerialNumberUpperCase = params?.randomSerialNumberUpperCase ?? true;
+ params.randomSerialNumber = params?.randomSerialNumber ?? true;
+ if (!Utils.isEmptyObject(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;
+ }
+ }
+
+ 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);
+ }
+ if (Utils.isEmptyObject(stationInfo)) {
+ logger.warn(
+ `${this.logPrefix()} Empty charging station information from template file ${
+ this.templateFile
+ }`
+ );
+ }
+ const chargingStationId = this.getChargingStationId(stationInfo);
// Deprecation template keys section
this.warnDeprecatedTemplateKey(
- stationTemplateFromFile,
+ stationInfo,
'supervisionUrl',
chargingStationId,
"Use 'supervisionUrls' instead"
);
- this.convertDeprecatedTemplateKey(stationTemplateFromFile, 'supervisionUrl', 'supervisionUrls');
- const stationInfo: ChargingStationInfo = stationTemplateFromFile ?? ({} as ChargingStationInfo);
- stationInfo.wsOptions = stationTemplateFromFile?.wsOptions ?? {};
- if (!Utils.isEmptyArray(stationTemplateFromFile.power)) {
- stationTemplateFromFile.power = stationTemplateFromFile.power as number[];
- const powerArrayRandomIndex = Math.floor(
- Utils.secureRandom() * stationTemplateFromFile.power.length
- );
- stationInfo.maxPower =
- stationTemplateFromFile.powerUnit === PowerUnits.KILO_WATT
- ? stationTemplateFromFile.power[powerArrayRandomIndex] * 1000
- : stationTemplateFromFile.power[powerArrayRandomIndex];
+ this.convertDeprecatedTemplateKey(stationInfo, 'supervisionUrl', 'supervisionUrls');
+ stationInfo.wsOptions = stationInfo?.wsOptions ?? {};
+ if (!Utils.isEmptyArray(stationInfo.power)) {
+ stationInfo.power = stationInfo.power as number[];
+ const powerArrayRandomIndex = Math.floor(Utils.secureRandom() * stationInfo.power.length);
+ stationInfo.maximumPower =
+ stationInfo.powerUnit === PowerUnits.KILO_WATT
+ ? stationInfo.power[powerArrayRandomIndex] * 1000
+ : stationInfo.power[powerArrayRandomIndex];
} else {
- stationTemplateFromFile.power = stationTemplateFromFile.power as number;
- stationInfo.maxPower =
- stationTemplateFromFile.powerUnit === PowerUnits.KILO_WATT
- ? stationTemplateFromFile.power * 1000
- : stationTemplateFromFile.power;
+ stationInfo.power = stationInfo.power as number;
+ stationInfo.maximumPower =
+ stationInfo.powerUnit === PowerUnits.KILO_WATT
+ ? stationInfo.power * 1000
+ : stationInfo.power;
}
delete stationInfo.power;
delete stationInfo.powerUnit;
stationInfo.chargingStationId = chargingStationId;
- stationInfo.resetTime = stationTemplateFromFile.resetTime
- ? stationTemplateFromFile.resetTime * 1000
+ stationInfo.resetTime = stationInfo.resetTime
+ ? stationInfo.resetTime * 1000
: Constants.CHARGING_STATION_DEFAULT_RESET_TIME;
return stationInfo;
}
+ private createStationInfoHash(stationInfo: ChargingStationInfo): ChargingStationInfo {
+ if (!Utils.isEmptyObject(stationInfo)) {
+ const previousInfoHash = stationInfo?.infoHash ?? '';
+ delete stationInfo.infoHash;
+ const currentInfoHash = crypto
+ .createHash(Constants.DEFAULT_HASH_ALGORITHM)
+ .update(JSON.stringify(stationInfo))
+ .digest('hex');
+ if (
+ Utils.isEmptyString(previousInfoHash) ||
+ (!Utils.isEmptyString(previousInfoHash) && currentInfoHash !== previousInfoHash)
+ ) {
+ stationInfo.infoHash = currentInfoHash;
+ } else {
+ stationInfo.infoHash = previousInfoHash;
+ }
+ }
+ return stationInfo;
+ }
+
+ private getStationInfoFromFile(): ChargingStationInfo {
+ let stationInfo = this.getConfigurationFromFile()?.stationInfo ?? ({} as ChargingStationInfo);
+ stationInfo = this.createStationInfoHash(stationInfo);
+ return stationInfo;
+ }
+
+ private getStationInfo(): ChargingStationInfo {
+ const stationInfoFromTemplate: ChargingStationInfo = this.getStationInfoFromTemplate();
+ this.hashId = this.getHashId(stationInfoFromTemplate);
+ this.configurationFile = path.join(
+ path.resolve(__dirname, '../'),
+ 'assets',
+ 'configurations',
+ this.hashId + '.json'
+ );
+ const stationInfoFromFile: ChargingStationInfo = this.getStationInfoFromFile();
+ // Priority: charging station info from template > charging station info from configuration file > charging station info attribute
+ if (stationInfoFromFile?.templateHash === stationInfoFromTemplate.templateHash) {
+ if (this.stationInfo?.infoHash === stationInfoFromFile?.infoHash) {
+ return this.stationInfo;
+ }
+ return stationInfoFromFile;
+ }
+ this.createSerialNumber(stationInfoFromTemplate, stationInfoFromFile);
+ return stationInfoFromTemplate;
+ }
+
+ private saveStationInfo(): void {
+ this.saveConfiguration(Section.stationInfo);
+ }
+
private getOcppVersion(): OCPPVersion {
- return this.stationInfo.ocppVersion ? this.stationInfo.ocppVersion : OCPPVersion.VERSION_16;
+ return this.stationInfo.ocppVersion ?? OCPPVersion.VERSION_16;
}
private getOcppPersistentConfiguration(): boolean {
private handleUnsupportedVersion(version: OCPPVersion) {
const errMsg = `${this.logPrefix()} Unsupported protocol version '${version}' configured in template file ${
- this.stationTemplateFile
+ this.templateFile
}`;
logger.error(errMsg);
throw new Error(errMsg);
}
- private initialize(): void {
- this.stationInfo = this.buildStationInfo();
- this.bootNotificationRequest = {
- chargePointModel: this.stationInfo.chargePointModel,
- chargePointVendor: this.stationInfo.chargePointVendor,
- ...(!Utils.isUndefined(this.stationInfo.chargeBoxSerialNumberPrefix) && {
- chargeBoxSerialNumber: this.stationInfo.chargeBoxSerialNumberPrefix,
+ 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(this.stationInfo.firmwareVersion) && {
- firmwareVersion: this.stationInfo.firmwareVersion,
+ ...(!Utils.isUndefined(stationInfo.firmwareVersion) && {
+ firmwareVersion: stationInfo.firmwareVersion,
}),
- ...(Utils.isUndefined(this.stationInfo.iccid) && { iccid: this.stationInfo.iccid }),
- ...(Utils.isUndefined(this.stationInfo.imsi) && { imsi: this.stationInfo.imsi }),
- ...(Utils.isUndefined(this.stationInfo.meterSerialNumber) && {
- meterSerialNumber: this.stationInfo.meterSerialNumber,
+ ...(!Utils.isUndefined(stationInfo.iccid) && { iccid: stationInfo.iccid }),
+ ...(!Utils.isUndefined(stationInfo.imsi) && { imsi: stationInfo.imsi }),
+ ...(!Utils.isUndefined(stationInfo.meterSerialNumber) && {
+ meterSerialNumber: stationInfo.meterSerialNumber,
}),
- ...(Utils.isUndefined(this.stationInfo.meterType) && {
- meterType: this.stationInfo.meterType,
+ ...(!Utils.isUndefined(stationInfo.meterType) && {
+ meterType: stationInfo.meterType,
}),
};
+ }
- this.hashId = crypto
+ 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(this.bootNotificationRequest) + this.stationInfo.chargingStationId)
+ .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.configurationFile = path.join(
- path.resolve(__dirname, '../'),
- 'assets',
- 'configurations',
- this.hashId + '.json'
+ this.bootNotificationRequest = this.createBootNotificationRequest(this.stationInfo);
+ this.ocppConfiguration = this.getOcppConfiguration();
+ this.stationInfo?.Configuration && delete this.stationInfo.Configuration;
+ this.wsConfiguredConnectionUrl = new URL(
+ this.getConfiguredSupervisionUrl().href + '/' + this.stationInfo.chargingStationId
);
- this.configuration = this.getConfiguration();
- delete this.stationInfo.Configuration;
// Build connectors if needed
const maxConnectors = this.getMaxNumberOfConnectors();
- if (maxConnectors <= 0) {
- logger.warn(
- `${this.logPrefix()} Charging station template ${
- this.stationTemplateFile
- } with ${maxConnectors} connectors`
- );
- }
+ this.checkMaxConnectors(maxConnectors);
const templateMaxConnectors = this.getTemplateMaxNumberOfConnectors();
- if (templateMaxConnectors <= 0) {
- logger.warn(
- `${this.logPrefix()} Charging station template ${
- this.stationTemplateFile
- } with no connector configuration`
- );
- }
- if (!this.stationInfo.Connectors[0]) {
- logger.warn(
- `${this.logPrefix()} Charging station template ${
- this.stationTemplateFile
- } with no connector Id 0 configuration`
- );
- }
- // Sanity check
+ 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.logPrefix()} Number of connectors exceeds the number of connector configurations in template ${
- this.stationTemplateFile
+ this.templateFile
}, forcing random connector configurations affectation`
);
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 = [];
- }
- }
- }
- }
- // Avoid duplication of connectors related information
- 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.initializeConnectors(this.stationInfo, maxConnectors, templateMaxConnectors);
+ this.stationInfo.maximumAmperage = this.getMaximumAmperage();
+ this.stationInfo = this.createStationInfoHash(this.stationInfo);
+ this.saveStationInfo();
+ // Avoid duplication of connectors related information in RAM
+ this.stationInfo?.Connectors && delete this.stationInfo.Connectors;
+ // OCPP configuration
+ this.initializeOcppConfiguration();
+ if (this.getEnableStatistics()) {
+ this.performanceStatistics = PerformanceStatistics.getInstance(
+ this.hashId,
+ this.stationInfo.chargingStationId,
+ this.wsConnectionUrl
+ );
}
- this.wsConfiguredConnectionUrl = new URL(
- this.getConfiguredSupervisionUrl().href + '/' + this.stationInfo.chargingStationId
- );
- // OCPP parameters
- this.initOcppParameters();
switch (this.getOcppVersion()) {
case OCPPVersion.VERSION_16:
this.ocppIncomingRequestService =
};
}
this.stationInfo.powerDivider = this.getPowerDivider();
- if (this.getEnableStatistics()) {
- this.performanceStatistics = PerformanceStatistics.getInstance(
- this.hashId,
- this.stationInfo.chargingStationId,
- this.wsConnectionUrl
- );
- }
}
- private initOcppParameters(): void {
+ private initializeOcppConfiguration(): void {
+ if (!this.getConfigurationKey(StandardParametersKey.HeartbeatInterval)) {
+ this.addConfigurationKey(StandardParametersKey.HeartbeatInterval, '0');
+ }
+ if (!this.getConfigurationKey(StandardParametersKey.HeartBeatInterval)) {
+ this.addConfigurationKey(StandardParametersKey.HeartBeatInterval, '0', { visible: false });
+ }
if (
this.getSupervisionUrlOcppConfiguration() &&
!this.getConfigurationKey(this.getSupervisionUrlOcppKey())
) {
this.deleteConfigurationKey(this.getSupervisionUrlOcppKey(), { save: false });
}
+ if (
+ this.stationInfo.amperageLimitationOcppKey &&
+ !this.getConfigurationKey(this.stationInfo.amperageLimitationOcppKey)
+ ) {
+ this.addConfigurationKey(
+ this.stationInfo.amperageLimitationOcppKey,
+ (this.stationInfo.maximumAmperage * this.getAmperageLimitationUnitDivider()).toString()
+ );
+ }
if (!this.getConfigurationKey(StandardParametersKey.SupportedFeatureProfiles)) {
this.addConfigurationKey(
StandardParametersKey.SupportedFeatureProfiles,
- `${SupportedFeatureProfiles.Core},${SupportedFeatureProfiles.Local_Auth_List_Management},${SupportedFeatureProfiles.Smart_Charging}`
+ `${SupportedFeatureProfiles.Core},${SupportedFeatureProfiles.FirmwareManagement},${SupportedFeatureProfiles.LocalAuthListManagement},${SupportedFeatureProfiles.SmartCharging},${SupportedFeatureProfiles.RemoteTrigger}`
);
}
this.addConfigurationKey(
}
if (
!this.getConfigurationKey(StandardParametersKey.LocalAuthListEnabled) &&
- this.getConfigurationKey(StandardParametersKey.SupportedFeatureProfiles).value.includes(
- SupportedFeatureProfiles.Local_Auth_List_Management
+ this.getConfigurationKey(StandardParametersKey.SupportedFeatureProfiles)?.value.includes(
+ SupportedFeatureProfiles.LocalAuthListManagement
)
) {
this.addConfigurationKey(StandardParametersKey.LocalAuthListEnabled, 'false');
Constants.DEFAULT_CONNECTION_TIMEOUT.toString()
);
}
- this.saveConfiguration();
+ this.saveOcppConfiguration();
}
- private getConfigurationFromTemplate(): ChargingStationConfiguration {
- return this.stationInfo.Configuration ?? ({} as ChargingStationConfiguration);
+ 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.getOcppPersistentConfiguration() &&
- this.configurationFile &&
- fs.existsSync(this.configurationFile)
- ) {
+ if (this.configurationFile && fs.existsSync(this.configurationFile)) {
try {
+ const measureId = `${FileType.ChargingStationConfiguration} read`;
+ const beginId = PerformanceStatistics.beginMeasure(measureId);
configuration = JSON.parse(
fs.readFileSync(this.configurationFile, 'utf8')
) as ChargingStationConfiguration;
+ PerformanceStatistics.endMeasure(measureId, beginId);
} catch (error) {
FileUtils.handleFileException(
this.logPrefix(),
return configuration;
}
- private saveConfiguration(): void {
- if (this.getOcppPersistentConfiguration()) {
- if (this.configurationFile) {
- try {
- if (!fs.existsSync(path.dirname(this.configurationFile))) {
- fs.mkdirSync(path.dirname(this.configurationFile), { recursive: true });
- }
- const fileDescriptor = fs.openSync(this.configurationFile, 'w');
- fs.writeFileSync(fileDescriptor, JSON.stringify(this.configuration, null, 2));
- fs.closeSync(fileDescriptor);
- } catch (error) {
- FileUtils.handleFileException(
- this.logPrefix(),
- FileType.ChargingStationConfiguration,
- this.configurationFile,
- error as NodeJS.ErrnoException
- );
+ private saveConfiguration(section?: Section): void {
+ if (this.configurationFile) {
+ try {
+ const configurationData: ChargingStationConfiguration =
+ this.getConfigurationFromFile() ?? {};
+ if (!fs.existsSync(path.dirname(this.configurationFile))) {
+ fs.mkdirSync(path.dirname(this.configurationFile), { recursive: true });
}
- } else {
- logger.error(
- `${this.logPrefix()} Trying to save charging station configuration to undefined file`
+ switch (section) {
+ case Section.ocppConfiguration:
+ 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;
+ if (configurationData?.stationInfo?.infoHash !== this.stationInfo?.infoHash) {
+ configurationData.stationInfo = this.stationInfo;
+ }
+ break;
+ }
+ const measureId = `${FileType.ChargingStationConfiguration} write`;
+ const beginId = PerformanceStatistics.beginMeasure(measureId);
+ const fileDescriptor = fs.openSync(this.configurationFile, 'w');
+ fs.writeFileSync(fileDescriptor, JSON.stringify(configurationData, null, 2), 'utf8');
+ fs.closeSync(fileDescriptor);
+ PerformanceStatistics.endMeasure(measureId, beginId);
+ } catch (error) {
+ FileUtils.handleFileException(
+ this.logPrefix(),
+ FileType.ChargingStationConfiguration,
+ this.configurationFile,
+ error as NodeJS.ErrnoException
);
}
+ } else {
+ logger.error(
+ `${this.logPrefix()} Trying to save charging station configuration to undefined configuration file`
+ );
}
}
- private getConfiguration(): ChargingStationConfiguration {
- let configuration: ChargingStationConfiguration = this.getConfigurationFromFile();
- if (!configuration) {
- configuration = this.getConfigurationFromTemplate();
+ private getOcppConfigurationFromTemplate(): ChargingStationOcppConfiguration {
+ return this.getTemplateFromFile().Configuration ?? ({} as ChargingStationOcppConfiguration);
+ }
+
+ private getOcppConfigurationFromFile(): ChargingStationOcppConfiguration | null {
+ let configuration: ChargingStationConfiguration = null;
+ if (this.getOcppPersistentConfiguration()) {
+ const configurationFromFile = this.getConfigurationFromFile();
+ configuration = configurationFromFile?.configurationKey && configurationFromFile;
}
+ configuration && delete configuration.stationInfo;
return configuration;
}
+ private getOcppConfiguration(): ChargingStationOcppConfiguration {
+ let ocppConfiguration: ChargingStationOcppConfiguration = this.getOcppConfigurationFromFile();
+ if (!ocppConfiguration) {
+ ocppConfiguration = this.getOcppConfigurationFromTemplate();
+ }
+ return ocppConfiguration;
+ }
+
+ private saveOcppConfiguration(): void {
+ if (this.getOcppPersistentConfiguration()) {
+ this.saveConfiguration(Section.ocppConfiguration);
+ }
+ }
+
private async onOpen(): Promise<void> {
- logger.info(
- `${this.logPrefix()} Connected to OCPP server through ${this.wsConnectionUrl.toString()}`
- );
- if (!this.isInAcceptedState()) {
- // Send BootNotification
- let registrationRetryCount = 0;
- do {
- this.bootNotificationResponse = (await this.ocppRequestService.sendMessageHandler(
- RequestCommand.BOOT_NOTIFICATION,
- {
- chargePointModel: this.bootNotificationRequest.chargePointModel,
- chargePointVendor: this.bootNotificationRequest.chargePointVendor,
- chargeBoxSerialNumber: this.bootNotificationRequest.chargeBoxSerialNumber,
- firmwareVersion: this.bootNotificationRequest.firmwareVersion,
- chargePointSerialNumber: this.bootNotificationRequest.chargePointSerialNumber,
- iccid: this.bootNotificationRequest.iccid,
- imsi: this.bootNotificationRequest.imsi,
- meterSerialNumber: this.bootNotificationRequest.meterSerialNumber,
- meterType: this.bootNotificationRequest.meterType,
- },
- { skipBufferingOnError: true }
- )) as BootNotificationResponse;
- if (!this.isInAcceptedState()) {
- this.getRegistrationMaxRetries() !== -1 && registrationRetryCount++;
- await Utils.sleep(
- this.bootNotificationResponse?.interval
- ? this.bootNotificationResponse.interval * 1000
- : Constants.OCPP_DEFAULT_BOOT_NOTIFICATION_INTERVAL
+ if (this.isWebSocketConnectionOpened()) {
+ logger.info(
+ `${this.logPrefix()} Connection to OCPP server through ${this.wsConnectionUrl.toString()} succeeded`
+ );
+ if (!this.isRegistered()) {
+ // Send BootNotification
+ let registrationRetryCount = 0;
+ do {
+ this.bootNotificationResponse = await this.ocppRequestService.requestHandler<
+ BootNotificationRequest,
+ BootNotificationResponse
+ >(
+ RequestCommand.BOOT_NOTIFICATION,
+ {
+ chargePointModel: this.bootNotificationRequest.chargePointModel,
+ chargePointVendor: this.bootNotificationRequest.chargePointVendor,
+ chargeBoxSerialNumber: this.bootNotificationRequest.chargeBoxSerialNumber,
+ firmwareVersion: this.bootNotificationRequest.firmwareVersion,
+ chargePointSerialNumber: this.bootNotificationRequest.chargePointSerialNumber,
+ iccid: this.bootNotificationRequest.iccid,
+ imsi: this.bootNotificationRequest.imsi,
+ meterSerialNumber: this.bootNotificationRequest.meterSerialNumber,
+ meterType: this.bootNotificationRequest.meterType,
+ },
+ { skipBufferingOnError: true }
);
+ if (!this.isRegistered()) {
+ this.getRegistrationMaxRetries() !== -1 && registrationRetryCount++;
+ await Utils.sleep(
+ this.bootNotificationResponse?.interval
+ ? this.bootNotificationResponse.interval * 1000
+ : Constants.OCPP_DEFAULT_BOOT_NOTIFICATION_INTERVAL
+ );
+ }
+ } while (
+ !this.isRegistered() &&
+ (registrationRetryCount <= this.getRegistrationMaxRetries() ||
+ this.getRegistrationMaxRetries() === -1)
+ );
+ }
+ if (this.isRegistered()) {
+ if (this.isInAcceptedState()) {
+ await this.startMessageSequence();
+ this.wsConnectionRestarted && this.flushMessageBuffer();
}
- } while (
- !this.isInAcceptedState() &&
- (registrationRetryCount <= this.getRegistrationMaxRetries() ||
- this.getRegistrationMaxRetries() === -1)
- );
- }
- if (this.isInAcceptedState()) {
- await this.startMessageSequence();
- this.stopped && (this.stopped = false);
- if (this.wsConnectionRestarted && this.isWebSocketConnectionOpened()) {
- 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 {
- logger.error(
- `${this.logPrefix()} Registration failure: max retries reached (${this.getRegistrationMaxRetries()}) or retry disabled (${this.getRegistrationMaxRetries()})`
+ logger.warn(
+ `${this.logPrefix()} Connection to OCPP server through ${this.wsConnectionUrl.toString()} failed`
);
}
- this.autoReconnectRetryCount = 0;
- this.wsConnectionRestarted = false;
}
private async onClose(code: number, reason: string): Promise<void> {
}
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 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(
+ 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(
+ messageId,
+ error as OCPPError,
+ commandName ?? requestCommandName ?? null
+ ));
}
}
}
} else {
logger.info(
- this.logPrefix() +
- ' No authorization file given in template file ' +
- this.stationTemplateFile
+ this.logPrefix() + ' No authorization file given in template file ' + this.templateFile
);
}
return authorizedTags;
}
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();
}
return maxConnectors;
}
+ private getMaximumPower(): number {
+ return (this.stationInfo['maxPower'] as number) ?? this.stationInfo.maximumPower;
+ }
+
+ private getMaximumAmperage(): number | undefined {
+ const maximumPower = this.getMaximumPower();
+ switch (this.getCurrentOutType()) {
+ case CurrentType.AC:
+ return ACElectricUtils.amperagePerPhaseFromPower(
+ this.getNumberOfPhases(),
+ maximumPower / this.getNumberOfConnectors(),
+ this.getVoltageOut()
+ );
+ case CurrentType.DC:
+ return DCElectricUtils.amperage(maximumPower, this.getVoltageOut());
+ }
+ }
+
+ 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)
+ ) {
+ return (
+ Utils.convertToInt(
+ this.getConfigurationKey(this.stationInfo.amperageLimitationOcppKey).value
+ ) / this.getAmperageLimitationUnitDivider()
+ );
+ }
+ }
+
private async startMessageSequence(): Promise<void> {
if (this.stationInfo.autoRegister) {
- await this.ocppRequestService.sendMessageHandler(
+ await this.ocppRequestService.requestHandler<
+ BootNotificationRequest,
+ BootNotificationResponse
+ >(
RequestCommand.BOOT_NOTIFICATION,
{
chargePointModel: this.bootNotificationRequest.chargePointModel,
this.getConnectorStatus(connectorId)?.bootStatus
) {
// Send status in template at startup
- await this.ocppRequestService.sendMessageHandler(RequestCommand.STATUS_NOTIFICATION, {
+ await this.ocppRequestService.requestHandler<
+ StatusNotificationRequest,
+ StatusNotificationResponse
+ >(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(RequestCommand.STATUS_NOTIFICATION, {
+ await this.ocppRequestService.requestHandler<
+ StatusNotificationRequest,
+ StatusNotificationResponse
+ >(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(RequestCommand.STATUS_NOTIFICATION, {
+ await this.ocppRequestService.requestHandler<
+ StatusNotificationRequest,
+ StatusNotificationResponse
+ >(RequestCommand.STATUS_NOTIFICATION, {
connectorId,
status: this.getConnectorStatus(connectorId).status,
errorCode: ChargePointErrorCode.NO_ERROR,
});
} else {
// Send default status
- await this.ocppRequestService.sendMessageHandler(RequestCommand.STATUS_NOTIFICATION, {
+ await this.ocppRequestService.requestHandler<
+ StatusNotificationRequest,
+ StatusNotificationResponse
+ >(RequestCommand.STATUS_NOTIFICATION, {
connectorId,
status: ChargePointStatus.AVAILABLE,
errorCode: ChargePointErrorCode.NO_ERROR,
connectorId,
this.getEnergyActiveImportRegisterByTransactionId(transactionId)
);
- await this.ocppRequestService.sendMessageHandler(RequestCommand.METER_VALUES, {
- connectorId,
- transactionId,
- meterValue: transactionEndMeterValue,
- });
+ await this.ocppRequestService.requestHandler<MeterValuesRequest, MeterValuesResponse>(
+ RequestCommand.METER_VALUES,
+ {
+ connectorId,
+ transactionId,
+ meterValue: transactionEndMeterValue,
+ }
+ );
}
- await this.ocppRequestService.sendMessageHandler(RequestCommand.STOP_TRANSACTION, {
+ await this.ocppRequestService.requestHandler<
+ StopTransactionRequest,
+ StopTransactionResponse
+ >(RequestCommand.STOP_TRANSACTION, {
transactionId,
meterStop: this.getEnergyActiveImportRegisterByTransactionId(transactionId),
idTag: this.getTransactionIdTag(transactionId),
const logPrefixStr = ` ${chargingStationId} |`;
logger.warn(
`${Utils.logPrefix(logPrefixStr)} Deprecated template key '${key}' usage in file '${
- this.stationTemplateFile
+ this.templateFile
}'${logMsgToAppend && '. ' + logMsgToAppend}`
);
}
}
private openWSConnection(
- options: ClientOptions & ClientRequestArgs = this.stationInfo.wsOptions,
+ options: WsOptions = this.stationInfo.wsOptions,
forceCloseOpened = false
): void {
options.handshakeTimeout = options?.handshakeTimeout ?? this.getConnectionTimeout() * 1000;
this.wsConnectionRestarted = true;
} else if (this.getAutoReconnectMaxRetries() !== -1) {
logger.error(
- `${this.logPrefix()} WebSocket reconnect failure: max retries reached (${
+ `${this.logPrefix()} WebSocket reconnect failure: maximum retries reached (${
this.autoReconnectRetryCount
}) or retry disabled (${this.getAutoReconnectMaxRetries()})`
);
repositories / e-mobility-charging-stations-simulator.git / blobdiff