-// Partial Copyright Jerome Benoit. 2021. All Rights Reserved.
+// Partial Copyright Jerome Benoit. 2021-2023. All Rights Reserved.
-import crypto from 'crypto';
import fs from 'fs';
+import crypto from 'node:crypto';
import path from 'path';
import { URL } from 'url';
import { parentPort } from 'worker_threads';
-import WebSocket, { Data, RawData } from 'ws';
+import merge from 'just-merge';
+import WebSocket, { type RawData } from 'ws';
+import AuthorizedTagsCache from './AuthorizedTagsCache';
+import AutomaticTransactionGenerator from './AutomaticTransactionGenerator';
+import { ChargingStationConfigurationUtils } from './ChargingStationConfigurationUtils';
+import { ChargingStationUtils } from './ChargingStationUtils';
+import ChargingStationWorkerBroadcastChannel from './ChargingStationWorkerBroadcastChannel';
+import { MessageChannelUtils } from './MessageChannelUtils';
+import OCPP16IncomingRequestService from './ocpp/1.6/OCPP16IncomingRequestService';
+import OCPP16RequestService from './ocpp/1.6/OCPP16RequestService';
+import OCPP16ResponseService from './ocpp/1.6/OCPP16ResponseService';
+import { OCPP16ServiceUtils } from './ocpp/1.6/OCPP16ServiceUtils';
+import OCPP20IncomingRequestService from './ocpp/2.0/OCPP20IncomingRequestService';
+import OCPP20RequestService from './ocpp/2.0/OCPP20RequestService';
+import OCPP20ResponseService from './ocpp/2.0/OCPP20ResponseService';
+import type OCPPIncomingRequestService from './ocpp/OCPPIncomingRequestService';
+import type OCPPRequestService from './ocpp/OCPPRequestService';
+import { OCPPServiceUtils } from './ocpp/OCPPServiceUtils';
+import SharedLRUCache from './SharedLRUCache';
import BaseError from '../exception/BaseError';
import OCPPError from '../exception/OCPPError';
import PerformanceStatistics from '../performance/PerformanceStatistics';
import type { ConnectorStatus } from '../types/ConnectorStatus';
import { FileType } from '../types/FileType';
import type { JsonType } from '../types/JsonType';
-import { ChargePointErrorCode } from '../types/ocpp/ChargePointErrorCode';
-import { ChargePointStatus } from '../types/ocpp/ChargePointStatus';
-import { ChargingProfile, ChargingRateUnitType } from '../types/ocpp/ChargingProfile';
import {
ConnectorPhaseRotation,
StandardParametersKey,
SupportedFeatureProfiles,
VendorDefaultParametersKey,
} from '../types/ocpp/Configuration';
+import { ConnectorStatusEnum } from '../types/ocpp/ConnectorStatusEnum';
import { ErrorType } from '../types/ocpp/ErrorType';
import { MessageType } from '../types/ocpp/MessageType';
import { MeterValue, MeterValueMeasurand } from '../types/ocpp/MeterValues';
import { OCPPVersion } from '../types/ocpp/OCPPVersion';
import {
AvailabilityType,
- BootNotificationRequest,
- CachedRequest,
- HeartbeatRequest,
- IncomingRequest,
+ type BootNotificationRequest,
+ type CachedRequest,
+ type ErrorCallback,
+ FirmwareStatus,
+ type FirmwareStatusNotificationRequest,
+ type HeartbeatRequest,
+ type IncomingRequest,
IncomingRequestCommand,
- MeterValuesRequest,
+ type MeterValuesRequest,
+ type OutgoingRequest,
RequestCommand,
- StatusNotificationRequest,
+ type ResponseCallback,
+ type StatusNotificationRequest,
} from '../types/ocpp/Requests';
import {
- BootNotificationResponse,
- ErrorResponse,
- HeartbeatResponse,
- MeterValuesResponse,
- RegistrationStatus,
- Response,
- StatusNotificationResponse,
+ type BootNotificationResponse,
+ type ErrorResponse,
+ type FirmwareStatusNotificationResponse,
+ type HeartbeatResponse,
+ type MeterValuesResponse,
+ RegistrationStatusEnumType,
+ type Response,
+ type StatusNotificationResponse,
} from '../types/ocpp/Responses';
import {
StopTransactionReason,
- StopTransactionRequest,
- StopTransactionResponse,
+ type StopTransactionRequest,
+ type StopTransactionResponse,
} from '../types/ocpp/Transaction';
import { WSError, WebSocketCloseEventStatusCode } from '../types/WebSocket';
import Configuration from '../utils/Configuration';
import FileUtils from '../utils/FileUtils';
import logger from '../utils/Logger';
import Utils from '../utils/Utils';
-import AuthorizedTagsCache from './AuthorizedTagsCache';
-import AutomaticTransactionGenerator from './AutomaticTransactionGenerator';
-import { ChargingStationConfigurationUtils } from './ChargingStationConfigurationUtils';
-import { ChargingStationUtils } from './ChargingStationUtils';
-import ChargingStationWorkerBroadcastChannel from './ChargingStationWorkerBroadcastChannel';
-import { MessageChannelUtils } from './MessageChannelUtils';
-import OCPP16IncomingRequestService from './ocpp/1.6/OCPP16IncomingRequestService';
-import OCPP16RequestService from './ocpp/1.6/OCPP16RequestService';
-import OCPP16ResponseService from './ocpp/1.6/OCPP16ResponseService';
-import { OCPP16ServiceUtils } from './ocpp/1.6/OCPP16ServiceUtils';
-import type OCPPIncomingRequestService from './ocpp/OCPPIncomingRequestService';
-import type OCPPRequestService from './ocpp/OCPPRequestService';
-import SharedLRUCache from './SharedLRUCache';
export default class ChargingStation {
public readonly index: number;
public readonly templateFile: string;
public stationInfo!: ChargingStationInfo;
public started: boolean;
+ public starting: boolean;
public authorizedTagsCache: AuthorizedTagsCache;
public automaticTransactionGenerator!: AutomaticTransactionGenerator;
public ocppConfiguration!: ChargingStationOcppConfiguration;
public bootNotificationRequest!: BootNotificationRequest;
public bootNotificationResponse!: BootNotificationResponse | null;
public powerDivider!: number;
- private starting: boolean;
private stopping: boolean;
private configurationFile!: string;
private configurationFileHash!: string;
private get wsConnectionUrl(): URL {
return new URL(
- (this.getSupervisionUrlOcppConfiguration()
- ? ChargingStationConfigurationUtils.getConfigurationKey(
- this,
- this.getSupervisionUrlOcppKey()
- ).value
- : this.configuredSupervisionUrl.href) +
- '/' +
- this.stationInfo.chargingStationId
+ `${
+ this.getSupervisionUrlOcppConfiguration()
+ ? ChargingStationConfigurationUtils.getConfigurationKey(
+ this,
+ this.getSupervisionUrlOcppKey()
+ ).value
+ : this.configuredSupervisionUrl.href
+ }/${this.stationInfo.chargingStationId}`
);
}
);
}
- public getEnableStatistics(): boolean | undefined {
- return !Utils.isUndefined(this.stationInfo.enableStatistics)
- ? this.stationInfo.enableStatistics
- : true;
+ public getEnableStatistics(): boolean {
+ return this.stationInfo.enableStatistics ?? false;
}
- public getMustAuthorizeAtRemoteStart(): boolean | undefined {
+ public getMustAuthorizeAtRemoteStart(): boolean {
return this.stationInfo.mustAuthorizeAtRemoteStart ?? true;
}
- public getPayloadSchemaValidation(): boolean | undefined {
+ public getPayloadSchemaValidation(): boolean {
return this.stationInfo.payloadSchemaValidation ?? true;
}
return this?.wsConnection?.readyState === WebSocket.OPEN;
}
- public getRegistrationStatus(): RegistrationStatus {
+ public getRegistrationStatus(): RegistrationStatusEnumType {
return this?.bootNotificationResponse?.status;
}
}
public isInPendingState(): boolean {
- return this?.bootNotificationResponse?.status === RegistrationStatus.PENDING;
+ return this?.bootNotificationResponse?.status === RegistrationStatusEnumType.PENDING;
}
public isInAcceptedState(): boolean {
- return this?.bootNotificationResponse?.status === RegistrationStatus.ACCEPTED;
+ return this?.bootNotificationResponse?.status === RegistrationStatusEnumType.ACCEPTED;
}
public isInRejectedState(): boolean {
- return this?.bootNotificationResponse?.status === RegistrationStatus.REJECTED;
+ return this?.bootNotificationResponse?.status === RegistrationStatusEnumType.REJECTED;
}
public isRegistered(): boolean {
- return !this.isInUnknownState() && (this.isInAcceptedState() || this.isInPendingState());
+ return (
+ this.isInUnknownState() === false &&
+ (this.isInAcceptedState() === true || this.isInPendingState() === true)
+ );
}
public isChargingStationAvailable(): boolean {
: defaultVoltageOut;
}
+ public getMaximumPower(stationInfo?: ChargingStationInfo): number {
+ const localStationInfo = stationInfo ?? this.stationInfo;
+ return (localStationInfo['maxPower'] as number) ?? localStationInfo.maximumPower;
+ }
+
public getConnectorMaximumAvailablePower(connectorId: number): number {
let connectorAmperageLimitationPowerLimit: number;
if (
this.powerDivider;
}
const connectorMaximumPower = this.getMaximumPower() / this.powerDivider;
- const connectorChargingProfilePowerLimit = this.getChargingProfilePowerLimit(connectorId);
+ const connectorChargingProfilesPowerLimit =
+ ChargingStationUtils.getChargingStationConnectorChargingProfilesPowerLimit(this, connectorId);
return Math.min(
isNaN(connectorMaximumPower) ? Infinity : connectorMaximumPower,
isNaN(connectorAmperageLimitationPowerLimit)
? Infinity
: connectorAmperageLimitationPowerLimit,
- isNaN(connectorChargingProfilePowerLimit) ? Infinity : connectorChargingProfilePowerLimit
+ isNaN(connectorChargingProfilesPowerLimit) ? Infinity : connectorChargingProfilesPowerLimit
);
}
public getEnergyActiveImportRegisterByTransactionId(
transactionId: number,
- meterStop = false
+ rounded = false
): number {
return this.getEnergyActiveImportRegister(
this.getConnectorStatus(this.getConnectorIdByTransactionId(transactionId)),
- meterStop
+ rounded
);
}
- public getEnergyActiveImportRegisterByConnectorId(connectorId: number): number {
- return this.getEnergyActiveImportRegister(this.getConnectorStatus(connectorId));
+ public getEnergyActiveImportRegisterByConnectorId(connectorId: number, rounded = false): number {
+ return this.getEnergyActiveImportRegister(this.getConnectorStatus(connectorId), rounded);
}
public getAuthorizeRemoteTxRequests(): boolean {
this.getHeartbeatInterval() > 0 &&
!this.heartbeatSetInterval
) {
- // eslint-disable-next-line @typescript-eslint/no-misused-promises
- this.heartbeatSetInterval = setInterval(async (): Promise<void> => {
- await this.ocppRequestService.requestHandler<HeartbeatRequest, HeartbeatResponse>(
- this,
- RequestCommand.HEARTBEAT
- );
+ this.heartbeatSetInterval = setInterval(() => {
+ this.ocppRequestService
+ .requestHandler<HeartbeatRequest, HeartbeatResponse>(this, RequestCommand.HEARTBEAT)
+ .catch((error) => {
+ logger.error(
+ `${this.logPrefix()} Error while sending '${RequestCommand.HEARTBEAT}':`,
+ error
+ );
+ });
}, this.getHeartbeatInterval());
logger.info(
- this.logPrefix() +
- ' Heartbeat started every ' +
- Utils.formatDurationMilliSeconds(this.getHeartbeatInterval())
+ `${this.logPrefix()} Heartbeat started every ${Utils.formatDurationMilliSeconds(
+ this.getHeartbeatInterval()
+ )}`
);
} else if (this.heartbeatSetInterval) {
logger.info(
- this.logPrefix() +
- ' Heartbeat already started every ' +
- Utils.formatDurationMilliSeconds(this.getHeartbeatInterval())
+ `${this.logPrefix()} Heartbeat already started every ${Utils.formatDurationMilliSeconds(
+ this.getHeartbeatInterval()
+ )}`
);
} else {
logger.error(
return;
}
if (interval > 0) {
- // eslint-disable-next-line @typescript-eslint/no-misused-promises
- this.getConnectorStatus(connectorId).transactionSetInterval = setInterval(
- // eslint-disable-next-line @typescript-eslint/no-misused-promises
- async (): Promise<void> => {
- // FIXME: Implement OCPP version agnostic helpers
- const meterValue: MeterValue = OCPP16ServiceUtils.buildMeterValue(
- this,
- connectorId,
- this.getConnectorStatus(connectorId).transactionId,
- interval
- );
- await this.ocppRequestService.requestHandler<MeterValuesRequest, MeterValuesResponse>(
+ this.getConnectorStatus(connectorId).transactionSetInterval = setInterval(() => {
+ // FIXME: Implement OCPP version agnostic helpers
+ const meterValue: MeterValue = OCPP16ServiceUtils.buildMeterValue(
+ this,
+ connectorId,
+ this.getConnectorStatus(connectorId).transactionId,
+ interval
+ );
+ this.ocppRequestService
+ .requestHandler<MeterValuesRequest, MeterValuesResponse>(
this,
RequestCommand.METER_VALUES,
{
transactionId: this.getConnectorStatus(connectorId).transactionId,
meterValue: [meterValue],
}
- );
- },
- interval
- );
+ )
+ .catch((error) => {
+ logger.error(
+ `${this.logPrefix()} Error while sending '${RequestCommand.METER_VALUES}':`,
+ error
+ );
+ });
+ }, interval);
} else {
logger.error(
`${this.logPrefix()} Charging station ${
if (this.started === false) {
if (this.starting === false) {
this.starting = true;
- if (this.getEnableStatistics()) {
+ if (this.getEnableStatistics() === true) {
this.performanceStatistics.start();
}
this.openWSConnection();
) {
this.startAutomaticTransactionGenerator();
}
- if (this.getEnableStatistics()) {
+ if (this.getEnableStatistics() === true) {
this.performanceStatistics.restart();
} else {
this.performanceStatistics.stop();
}
}
);
+ this.started = true;
parentPort.postMessage(MessageChannelUtils.buildStartedMessage(this));
this.starting = false;
} else {
if (this.stopping === false) {
this.stopping = true;
await this.stopMessageSequence(reason);
- for (const connectorId of this.connectors.keys()) {
- if (connectorId > 0) {
- await this.ocppRequestService.requestHandler<
- StatusNotificationRequest,
- StatusNotificationResponse
- >(this, RequestCommand.STATUS_NOTIFICATION, {
- connectorId,
- status: ChargePointStatus.UNAVAILABLE,
- errorCode: ChargePointErrorCode.NO_ERROR,
- });
- this.getConnectorStatus(connectorId).status = ChargePointStatus.UNAVAILABLE;
- }
- }
this.closeWSConnection();
- if (this.getEnableStatistics()) {
+ if (this.getEnableStatistics() === true) {
this.performanceStatistics.stop();
}
this.sharedLRUCache.deleteChargingStationConfiguration(this.configurationFileHash);
}
}
- 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) === false) {
- 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(
- (chargingProfile: ChargingProfile, index: number) => {
- if (
- chargingProfile.chargingProfileId === cp.chargingProfileId ||
- (chargingProfile.stackLevel === cp.stackLevel &&
- chargingProfile.chargingProfilePurpose === cp.chargingProfilePurpose)
- ) {
- this.getConnectorStatus(connectorId).chargingProfiles[index] = cp;
- cpReplaced = true;
- }
- }
- );
- }
- !cpReplaced && this.getConnectorStatus(connectorId).chargingProfiles?.push(cp);
- }
-
public resetConnectorStatus(connectorId: number): void {
this.getConnectorStatus(connectorId).idTagLocalAuthorized = false;
this.getConnectorStatus(connectorId).idTagAuthorized = false;
options.handshakeTimeout = options?.handshakeTimeout ?? this.getConnectionTimeout() * 1000;
params.closeOpened = params?.closeOpened ?? false;
params.terminateOpened = params?.terminateOpened ?? false;
+ if (this.started === false && this.starting === false) {
+ logger.warn(
+ `${this.logPrefix()} Cannot open OCPP connection to URL ${this.wsConnectionUrl.toString()} on stopped charging station`
+ );
+ return;
+ }
if (
!Utils.isNullOrUndefined(this.stationInfo.supervisionUser) &&
!Utils.isNullOrUndefined(this.stationInfo.supervisionPassword)
if (params?.terminateOpened) {
this.terminateWSConnection();
}
+ const ocppVersion = this.stationInfo.ocppVersion ?? OCPPVersion.VERSION_16;
let protocol: string;
- switch (this.getOcppVersion()) {
+ switch (ocppVersion) {
case OCPPVersion.VERSION_16:
- protocol = 'ocpp' + OCPPVersion.VERSION_16;
+ case OCPPVersion.VERSION_20:
+ case OCPPVersion.VERSION_201:
+ protocol = `ocpp${ocppVersion}`;
break;
default:
- this.handleUnsupportedVersion(this.getOcppVersion());
+ this.handleUnsupportedVersion(ocppVersion);
break;
}
- if (this.isWebSocketConnectionOpened()) {
+ if (this.isWebSocketConnectionOpened() === true) {
logger.warn(
`${this.logPrefix()} OCPP connection to URL ${this.wsConnectionUrl.toString()} is already opened`
);
}
public closeWSConnection(): void {
- if (this.isWebSocketConnectionOpened()) {
+ if (this.isWebSocketConnectionOpened() === true) {
this.wsConnection.close();
this.wsConnection = null;
}
): Promise<StopTransactionResponse> {
const transactionId = this.getConnectorStatus(connectorId).transactionId;
if (
- this.getBeginEndMeterValues() &&
- this.getOcppStrictCompliance() &&
- !this.getOutOfOrderEndMeterValues()
+ this.getBeginEndMeterValues() === true &&
+ this.getOcppStrictCompliance() === true &&
+ this.getOutOfOrderEndMeterValues() === false
) {
// FIXME: Implement OCPP version agnostic helpers
const transactionEndMeterValue = OCPP16ServiceUtils.buildTransactionEndMeterValue(
private flushMessageBuffer(): void {
if (this.messageBuffer.size > 0) {
this.messageBuffer.forEach((message) => {
- // TODO: evaluate the need to track performance
+ let beginId: string;
+ let commandName: RequestCommand;
+ const [messageType] = JSON.parse(message) as OutgoingRequest | Response | ErrorResponse;
+ const isRequest = messageType === MessageType.CALL_MESSAGE;
+ if (isRequest) {
+ [, , commandName] = JSON.parse(message) as OutgoingRequest;
+ beginId = PerformanceStatistics.beginMeasure(commandName);
+ }
this.wsConnection.send(message);
+ isRequest && PerformanceStatistics.endMeasure(commandName, beginId);
+ logger.debug(
+ `${this.logPrefix()} >> Buffered ${OCPPServiceUtils.getMessageTypeString(
+ messageType
+ )} payload sent: ${message}`
+ );
this.messageBuffer.delete(message);
});
}
private getStationInfoFromTemplate(): ChargingStationInfo {
const stationTemplate: ChargingStationTemplate = this.getTemplateFromFile();
if (Utils.isNullOrUndefined(stationTemplate)) {
- const errorMsg = 'Failed to read charging station template file';
+ const errorMsg = `Failed to read charging station template file ${this.templateFile}`;
logger.error(`${this.logPrefix()} ${errorMsg}`);
throw new BaseError(errorMsg);
}
this.index,
stationTemplate
);
+ stationInfo.ocppVersion = stationTemplate.ocppVersion ?? OCPPVersion.VERSION_16;
ChargingStationUtils.createSerialNumber(stationTemplate, stationInfo);
if (!Utils.isEmptyArray(stationTemplate.power)) {
stationTemplate.power = stationTemplate.power as number[];
? stationTemplate.power * 1000
: stationTemplate.power;
}
+ stationInfo.firmwareVersionPattern =
+ stationTemplate.firmwareVersionPattern ?? Constants.SEMVER_PATTERN;
+ if (
+ stationInfo.firmwareVersion &&
+ new RegExp(stationInfo.firmwareVersionPattern).test(stationInfo.firmwareVersion) === false
+ ) {
+ logger.warn(
+ `${this.logPrefix()} Firmware version '${stationInfo.firmwareVersion}' in template file ${
+ this.templateFile
+ } does not match firmware version pattern '${stationInfo.firmwareVersionPattern}'`
+ );
+ }
+ stationInfo.firmwareUpgrade = merge(
+ {
+ reset: true,
+ },
+ stationTemplate.firmwareUpgrade ?? {}
+ );
stationInfo.resetTime = stationTemplate.resetTime
? stationTemplate.resetTime * 1000
: Constants.CHARGING_STATION_DEFAULT_RESET_TIME;
}
}
- private getOcppVersion(): OCPPVersion {
- return this.stationInfo.ocppVersion ?? OCPPVersion.VERSION_16;
- }
-
private getOcppPersistentConfiguration(): boolean {
return this.stationInfo?.ocppPersistentConfiguration ?? true;
}
private initialize(): void {
this.configurationFile = path.join(
path.dirname(this.templateFile.replace('station-templates', 'configurations')),
- ChargingStationUtils.getHashId(this.index, this.getTemplateFromFile()) + '.json'
+ `${ChargingStationUtils.getHashId(this.index, this.getTemplateFromFile())}.json`
);
this.stationInfo = this.getStationInfo();
this.saveStationInfo();
- logger.info(`${this.logPrefix()} Charging station hashId '${this.stationInfo.hashId}'`);
// Avoid duplication of connectors related information in RAM
this.stationInfo?.Connectors && delete this.stationInfo.Connectors;
this.configuredSupervisionUrl = this.getConfiguredSupervisionUrl();
- if (this.getEnableStatistics()) {
+ if (this.getEnableStatistics() === true) {
this.performanceStatistics = PerformanceStatistics.getInstance(
this.stationInfo.hashId,
this.stationInfo.chargingStationId,
// OCPP configuration
this.ocppConfiguration = this.getOcppConfiguration();
this.initializeOcppConfiguration();
- switch (this.getOcppVersion()) {
+ const ocppVersion = this.stationInfo.ocppVersion ?? OCPPVersion.VERSION_16;
+ switch (ocppVersion) {
case OCPPVersion.VERSION_16:
this.ocppIncomingRequestService =
OCPP16IncomingRequestService.getInstance<OCPP16IncomingRequestService>();
OCPP16ResponseService.getInstance<OCPP16ResponseService>()
);
break;
+ case OCPPVersion.VERSION_20:
+ case OCPPVersion.VERSION_201:
+ this.ocppIncomingRequestService =
+ OCPP20IncomingRequestService.getInstance<OCPP20IncomingRequestService>();
+ this.ocppRequestService = OCPP20RequestService.getInstance<OCPP20RequestService>(
+ OCPP20ResponseService.getInstance<OCPP20ResponseService>()
+ );
+ break;
default:
- this.handleUnsupportedVersion(this.getOcppVersion());
+ this.handleUnsupportedVersion(ocppVersion);
break;
}
- if (this.stationInfo?.autoRegister) {
+ if (this.stationInfo?.autoRegister === true) {
this.bootNotificationResponse = {
- currentTime: new Date().toISOString(),
+ currentTime: new Date(),
interval: this.getHeartbeatInterval() / 1000,
- status: RegistrationStatus.ACCEPTED,
+ status: RegistrationStatusEnumType.ACCEPTED,
};
}
+ if (
+ this.stationInfo.firmwareStatus === FirmwareStatus.Installing &&
+ this.stationInfo.firmwareVersion &&
+ this.stationInfo.firmwareVersionPattern
+ ) {
+ const versionStep = this.stationInfo.firmwareUpgrade?.versionUpgrade?.step ?? 1;
+ const patternGroup: number =
+ this.stationInfo.firmwareUpgrade?.versionUpgrade?.patternGroup ??
+ this.stationInfo.firmwareVersion.split('.').length;
+ const match = this.stationInfo.firmwareVersion
+ .match(new RegExp(this.stationInfo.firmwareVersionPattern))
+ .slice(1, patternGroup + 1);
+ const patchLevelIndex = match.length - 1;
+ match[patchLevelIndex] = (
+ Utils.convertToInt(match[patchLevelIndex]) + versionStep
+ ).toString();
+ this.stationInfo.firmwareVersion = match.join('.');
+ }
}
private initializeOcppConfiguration(): void {
// Add connector Id 0
let lastConnector = '0';
for (lastConnector in stationInfo?.Connectors) {
+ const connectorStatus = stationInfo?.Connectors[lastConnector];
const lastConnectorId = Utils.convertToInt(lastConnector);
if (
lastConnectorId === 0 &&
this.getUseConnectorId0(stationInfo) === true &&
- stationInfo?.Connectors[lastConnector]
+ connectorStatus
) {
+ this.checkStationInfoConnectorStatus(lastConnectorId, connectorStatus);
this.connectors.set(
lastConnectorId,
- Utils.cloneObject<ConnectorStatus>(stationInfo?.Connectors[lastConnector])
+ Utils.cloneObject<ConnectorStatus>(connectorStatus)
);
this.getConnectorStatus(lastConnectorId).availability = AvailabilityType.OPERATIVE;
if (Utils.isUndefined(this.getConnectorStatus(lastConnectorId)?.chargingProfiles)) {
const randConnectorId = stationInfo?.randomConnectors
? Utils.getRandomInteger(Utils.convertToInt(lastConnector), 1)
: index;
- this.connectors.set(
- index,
- Utils.cloneObject<ConnectorStatus>(stationInfo?.Connectors[randConnectorId])
- );
+ const connectorStatus = stationInfo?.Connectors[randConnectorId.toString()];
+ this.checkStationInfoConnectorStatus(randConnectorId, connectorStatus);
+ this.connectors.set(index, Utils.cloneObject<ConnectorStatus>(connectorStatus));
this.getConnectorStatus(index).availability = AvailabilityType.OPERATIVE;
if (Utils.isUndefined(this.getConnectorStatus(index)?.chargingProfiles)) {
this.getConnectorStatus(index).chargingProfiles = [];
}
// Initialize transaction attributes on connectors
for (const connectorId of this.connectors.keys()) {
+ if (connectorId > 0 && this.getConnectorStatus(connectorId).transactionStarted === true) {
+ logger.warn(
+ `${this.logPrefix()} Connector ${connectorId} at initialization has a transaction started: ${
+ this.getConnectorStatus(connectorId).transactionId
+ }`
+ );
+ }
if (
connectorId > 0 &&
(this.getConnectorStatus(connectorId).transactionStarted === undefined ||
- this.getConnectorStatus(connectorId).transactionStarted === false)
+ this.getConnectorStatus(connectorId).transactionStarted === null)
) {
this.initializeConnectorStatus(connectorId);
}
}
}
+ private checkStationInfoConnectorStatus(
+ connectorId: number,
+ connectorStatus: ConnectorStatus
+ ): void {
+ if (!Utils.isNullOrUndefined(connectorStatus?.status)) {
+ logger.warn(
+ `${this.logPrefix()} Charging station information from template ${
+ this.templateFile
+ } with connector ${connectorId} status configuration defined, undefine it`
+ );
+ connectorStatus.status = undefined;
+ }
+ }
+
private getConfigurationFromFile(): ChargingStationConfiguration | null {
let configuration: ChargingStationConfiguration = null;
if (this.configurationFile && fs.existsSync(this.configurationFile)) {
private getOcppConfigurationFromFile(): ChargingStationOcppConfiguration | null {
let configuration: ChargingStationConfiguration = null;
- if (this.getOcppPersistentConfiguration()) {
+ if (this.getOcppPersistentConfiguration() === true) {
const configurationFromFile = this.getConfigurationFromFile();
configuration = configurationFromFile?.configurationKey && configurationFromFile;
}
}
private async onOpen(): Promise<void> {
- if (this.isWebSocketConnectionOpened()) {
+ if (this.isWebSocketConnectionOpened() === true) {
logger.info(
`${this.logPrefix()} Connection to OCPP server through ${this.wsConnectionUrl.toString()} succeeded`
);
- if (!this.isRegistered()) {
+ if (this.isRegistered() === false) {
// Send BootNotification
let registrationRetryCount = 0;
do {
>(this, RequestCommand.BOOT_NOTIFICATION, this.bootNotificationRequest, {
skipBufferingOnError: true,
});
- if (!this.isRegistered()) {
+ if (this.isRegistered() === false) {
this.getRegistrationMaxRetries() !== -1 && registrationRetryCount++;
await Utils.sleep(
this.bootNotificationResponse?.interval
);
}
} while (
- !this.isRegistered() &&
+ this.isRegistered() === false &&
(registrationRetryCount <= this.getRegistrationMaxRetries() ||
this.getRegistrationMaxRetries() === -1)
);
}
- if (this.isRegistered()) {
- if (this.isInAcceptedState()) {
+ if (this.isRegistered() === true) {
+ if (this.isInAcceptedState() === true) {
await this.startMessageSequence();
}
} else {
}
this.wsConnectionRestarted = false;
this.autoReconnectRetryCount = 0;
- this.started = true;
parentPort.postMessage(MessageChannelUtils.buildUpdatedMessage(this));
} else {
logger.warn(
}
}
- private async onClose(code: number, reason: string): Promise<void> {
+ private async onClose(code: number, reason: Buffer): Promise<void> {
switch (code) {
// Normal close
case WebSocketCloseEventStatusCode.CLOSE_NORMAL:
logger.info(
`${this.logPrefix()} WebSocket normally closed with status '${Utils.getWebSocketCloseEventStatusString(
code
- )}' and reason '${reason}'`
+ )}' and reason '${reason.toString()}'`
);
this.autoReconnectRetryCount = 0;
break;
logger.error(
`${this.logPrefix()} WebSocket abnormally closed with status '${Utils.getWebSocketCloseEventStatusString(
code
- )}' and reason '${reason}'`
+ )}' and reason '${reason.toString()}'`
);
- await this.reconnect();
+ this.started === true && (await this.reconnect());
break;
}
parentPort.postMessage(MessageChannelUtils.buildUpdatedMessage(this));
}
- private async onMessage(data: Data): Promise<void> {
+ private async onMessage(data: RawData): Promise<void> {
let messageType: number;
let messageId: string;
let commandName: IncomingRequestCommand;
let errorType: ErrorType;
let errorMessage: string;
let errorDetails: JsonType;
- let responseCallback: (payload: JsonType, requestPayload: JsonType) => void;
- let errorCallback: (error: OCPPError, requestStatistic?: boolean) => void;
+ let responseCallback: ResponseCallback;
+ let errorCallback: ErrorCallback;
let requestCommandName: RequestCommand | IncomingRequestCommand;
let requestPayload: JsonType;
let cachedRequest: CachedRequest;
logger.debug(
`${this.logPrefix()} << Command '${
requestCommandName ?? Constants.UNKNOWN_COMMAND
- }' received error payload: ${JSON.stringify(request)}`
+ }' received error response payload: ${JSON.stringify(request)}`
);
errorCallback(new OCPPError(errorType, errorMessage, requestCommandName, errorDetails));
break;
}
private onPing(): void {
- logger.debug(this.logPrefix() + ' Received a WS ping (rfc6455) from the server');
+ logger.debug(`${this.logPrefix()} Received a WS ping (rfc6455) from the server`);
}
private onPong(): void {
- logger.debug(this.logPrefix() + ' Received a WS pong (rfc6455) from the server');
+ logger.debug(`${this.logPrefix()} Received a WS pong (rfc6455) from the server`);
}
private onError(error: WSError): void {
this.closeWSConnection();
- logger.error(this.logPrefix() + ' WebSocket error:', error);
+ logger.error(`${this.logPrefix()} WebSocket error:`, error);
}
- private getEnergyActiveImportRegister(
- connectorStatus: ConnectorStatus,
- meterStop = false
- ): number {
+ private getEnergyActiveImportRegister(connectorStatus: ConnectorStatus, rounded = false): number {
if (this.getMeteringPerTransaction() === true) {
return (
- (meterStop === true
+ (rounded === true
? Math.round(connectorStatus?.transactionEnergyActiveImportRegisterValue)
: connectorStatus?.transactionEnergyActiveImportRegisterValue) ?? 0
);
}
return (
- (meterStop === true
+ (rounded === true
? Math.round(connectorStatus?.energyActiveImportRegisterValue)
: connectorStatus?.energyActiveImportRegisterValue) ?? 0
);
return powerDivider;
}
- private getMaximumPower(stationInfo?: ChargingStationInfo): number {
- const localStationInfo = stationInfo ?? this.stationInfo;
- return (localStationInfo['maxPower'] as number) ?? localStationInfo.maximumPower;
- }
-
private getMaximumAmperage(stationInfo: ChargingStationInfo): number | undefined {
const maximumPower = this.getMaximumPower(stationInfo);
switch (this.getCurrentOutType(stationInfo)) {
}
}
- private 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)
- );
- }
- if (!Utils.isEmptyArray(chargingProfiles)) {
- const result = ChargingStationUtils.getLimitFromChargingProfiles(
- chargingProfiles,
- this.logPrefix()
- );
- 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);
- }
- const connectorMaximumPower = this.getMaximumPower() / this.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;
- }
-
private async startMessageSequence(): Promise<void> {
- if (this.stationInfo?.autoRegister) {
+ if (this.stationInfo?.autoRegister === true) {
await this.ocppRequestService.requestHandler<
BootNotificationRequest,
BootNotificationResponse
this.startHeartbeat();
// Initialize connectors status
for (const connectorId of this.connectors.keys()) {
+ let connectorStatus: ConnectorStatusEnum;
if (connectorId === 0) {
continue;
} else if (
- this.started === true &&
!this.getConnectorStatus(connectorId)?.status &&
- this.getConnectorStatus(connectorId)?.bootStatus
+ (this.isChargingStationAvailable() === false ||
+ this.isConnectorAvailable(connectorId) === false)
) {
- // Send status in template at startup
- await this.ocppRequestService.requestHandler<
- StatusNotificationRequest,
- StatusNotificationResponse
- >(this, RequestCommand.STATUS_NOTIFICATION, {
- connectorId,
- status: this.getConnectorStatus(connectorId).bootStatus,
- errorCode: ChargePointErrorCode.NO_ERROR,
- });
- this.getConnectorStatus(connectorId).status =
- this.getConnectorStatus(connectorId).bootStatus;
+ connectorStatus = ConnectorStatusEnum.UNAVAILABLE;
} else if (
- this.started === false &&
- this.getConnectorStatus(connectorId)?.status &&
+ !this.getConnectorStatus(connectorId)?.status &&
this.getConnectorStatus(connectorId)?.bootStatus
) {
- // Send status in template after reset
- await this.ocppRequestService.requestHandler<
- StatusNotificationRequest,
- StatusNotificationResponse
- >(this, RequestCommand.STATUS_NOTIFICATION, {
- connectorId,
- status: this.getConnectorStatus(connectorId).bootStatus,
- errorCode: ChargePointErrorCode.NO_ERROR,
- });
- this.getConnectorStatus(connectorId).status =
- this.getConnectorStatus(connectorId).bootStatus;
- } else if (this.started === true && this.getConnectorStatus(connectorId)?.status) {
- // Send previous status at template reload
- await this.ocppRequestService.requestHandler<
- StatusNotificationRequest,
- StatusNotificationResponse
- >(this, RequestCommand.STATUS_NOTIFICATION, {
- connectorId,
- status: this.getConnectorStatus(connectorId).status,
- errorCode: ChargePointErrorCode.NO_ERROR,
- });
+ // Set boot status in template at startup
+ connectorStatus = this.getConnectorStatus(connectorId).bootStatus;
+ } else if (this.getConnectorStatus(connectorId)?.status) {
+ // Set previous status at startup
+ connectorStatus = this.getConnectorStatus(connectorId).status;
} else {
- // Send default status
- await this.ocppRequestService.requestHandler<
- StatusNotificationRequest,
- StatusNotificationResponse
- >(this, RequestCommand.STATUS_NOTIFICATION, {
- connectorId,
- status: ChargePointStatus.AVAILABLE,
- errorCode: ChargePointErrorCode.NO_ERROR,
- });
- this.getConnectorStatus(connectorId).status = ChargePointStatus.AVAILABLE;
+ // Set default status
+ connectorStatus = ConnectorStatusEnum.AVAILABLE;
}
+ await this.ocppRequestService.requestHandler<
+ StatusNotificationRequest,
+ StatusNotificationResponse
+ >(
+ this,
+ RequestCommand.STATUS_NOTIFICATION,
+ OCPPServiceUtils.buildStatusNotificationRequest(this, connectorId, connectorStatus)
+ );
+ this.getConnectorStatus(connectorId).status = connectorStatus;
+ }
+ if (this.stationInfo?.firmwareStatus === FirmwareStatus.Installing) {
+ await this.ocppRequestService.requestHandler<
+ FirmwareStatusNotificationRequest,
+ FirmwareStatusNotificationResponse
+ >(this, RequestCommand.FIRMWARE_STATUS_NOTIFICATION, {
+ status: FirmwareStatus.Installed,
+ });
+ this.stationInfo.firmwareStatus = FirmwareStatus.Installed;
}
+
// Start the ATG
if (this.getAutomaticTransactionGeneratorConfigurationFromTemplate()?.enable === true) {
this.startAutomaticTransactionGenerator();
} else {
await this.stopRunningTransactions(reason);
}
+ for (const connectorId of this.connectors.keys()) {
+ if (connectorId > 0) {
+ await this.ocppRequestService.requestHandler<
+ StatusNotificationRequest,
+ StatusNotificationResponse
+ >(
+ this,
+ RequestCommand.STATUS_NOTIFICATION,
+ OCPPServiceUtils.buildStatusNotificationRequest(
+ this,
+ connectorId,
+ ConnectorStatusEnum.UNAVAILABLE
+ )
+ );
+ this.getConnectorStatus(connectorId).status = null;
+ }
+ }
}
private startWebSocketPing(): void {
: 0;
if (webSocketPingInterval > 0 && !this.webSocketPingSetInterval) {
this.webSocketPingSetInterval = setInterval(() => {
- if (this.isWebSocketConnectionOpened()) {
- this.wsConnection.ping((): void => {
- /* This is intentional */
- });
+ if (this.isWebSocketConnectionOpened() === true) {
+ this.wsConnection.ping();
}
}, webSocketPingInterval * 1000);
logger.info(
- this.logPrefix() +
- ' WebSocket ping started every ' +
- Utils.formatDurationSeconds(webSocketPingInterval)
+ `${this.logPrefix()} WebSocket ping started every ${Utils.formatDurationSeconds(
+ webSocketPingInterval
+ )}`
);
} else if (this.webSocketPingSetInterval) {
logger.info(
- this.logPrefix() +
- ' WebSocket ping every ' +
- Utils.formatDurationSeconds(webSocketPingInterval) +
- ' already started'
+ `${this.logPrefix()} WebSocket ping already started every ${Utils.formatDurationSeconds(
+ webSocketPingInterval
+ )}`
);
} else {
logger.error(
}
private getConfiguredSupervisionUrl(): URL {
- const supervisionUrls = Utils.cloneObject<string | string[]>(
- this.stationInfo.supervisionUrls ?? Configuration.getSupervisionUrls()
- );
+ const supervisionUrls = this.stationInfo.supervisionUrls ?? Configuration.getSupervisionUrls();
if (!Utils.isEmptyArray(supervisionUrls)) {
switch (Configuration.getSupervisionUrlDistribution()) {
case SupervisionUrlDistribution.ROUND_ROBIN:
if (HeartBeatInterval) {
return Utils.convertToInt(HeartBeatInterval.value) * 1000;
}
- !this.stationInfo?.autoRegister &&
+ this.stationInfo?.autoRegister === false &&
logger.warn(
`${this.logPrefix()} Heartbeat interval configuration key not set, using default value: ${
Constants.DEFAULT_HEARTBEAT_INTERVAL
}
private terminateWSConnection(): void {
- if (this.isWebSocketConnectionOpened()) {
+ if (this.isWebSocketConnectionOpened() === true) {
this.wsConnection.terminate();
this.wsConnection = null;
}
? reconnectDelay - reconnectDelayWithdraw
: 0;
logger.error(
- `${this.logPrefix()} WebSocket: connection retry in ${Utils.roundTo(
+ `${this.logPrefix()} WebSocket connection retry in ${Utils.roundTo(
reconnectDelay,
2
)}ms, timeout ${reconnectTimeout}ms`
);
await Utils.sleep(reconnectDelay);
logger.error(
- this.logPrefix() +
- ' WebSocket: reconnecting try #' +
- this.autoReconnectRetryCount.toString()
+ `${this.logPrefix()} WebSocket connection retry #${this.autoReconnectRetryCount.toString()}`
);
this.openWSConnection(
{ ...(this.stationInfo?.wsOptions ?? {}), handshakeTimeout: reconnectTimeout },
this.wsConnectionRestarted = true;
} else if (this.getAutoReconnectMaxRetries() !== -1) {
logger.error(
- `${this.logPrefix()} WebSocket reconnect failure: maximum retries reached (${
+ `${this.logPrefix()} WebSocket connection retries failure: maximum retries reached (${
this.autoReconnectRetryCount
- }) or retry disabled (${this.getAutoReconnectMaxRetries()})`
+ }) or retries disabled (${this.getAutoReconnectMaxRetries()})`
);
}
}
repositories / e-mobility-charging-stations-simulator.git / blobdiff