-// 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 { 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 BaseError from '../exception/BaseError';
import OCPPError from '../exception/OCPPError';
import {
type ChargingStationTemplate,
CurrentType,
+ type FirmwareUpgrade,
PowerUnits,
type WsOptions,
} from '../types/ChargingStationTemplate';
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,
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,
- ErrorCallback,
- HeartbeatRequest,
- IncomingRequest,
+ type BootNotificationRequest,
+ type CachedRequest,
+ type ErrorCallback,
+ FirmwareStatus,
+ type FirmwareStatusNotificationRequest,
+ type HeartbeatRequest,
+ type IncomingRequest,
IncomingRequestCommand,
- MeterValuesRequest,
+ type MeterValuesRequest,
RequestCommand,
- ResponseCallback,
- 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 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';
export default class ChargingStation {
);
}
- 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 {
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.stopping = true;
await this.stopMessageSequence(reason);
this.closeWSConnection();
- if (this.getEnableStatistics()) {
+ if (this.getEnableStatistics() === true) {
this.performanceStatistics.stop();
}
this.sharedLRUCache.deleteChargingStationConfiguration(this.configurationFileHash);
}
}
+ public getFirmwareUpgrade(): FirmwareUpgrade {
+ return merge(
+ {
+ reset: true,
+ },
+ this.stationInfo.firmwareUpgrade
+ );
+ }
+
public async reset(reason?: StopTransactionReason): Promise<void> {
await this.stop(reason);
await Utils.sleep(this.stationInfo.resetTime);
if (params?.terminateOpened) {
this.terminateWSConnection();
}
+ const ocppVersion = this.getOcppVersion();
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;
}
'supervisionUrl',
'supervisionUrls'
);
- const firmwareVersionRegExp = stationTemplate.firmwareVersionPattern
- ? new RegExp(stationTemplate.firmwareVersionPattern)
- : Constants.SEMVER_REGEXP;
- if (
- stationTemplate.firmwareVersion &&
- firmwareVersionRegExp.test(stationTemplate.firmwareVersion) === false
- ) {
- logger.warn(
- `${this.logPrefix()} Firmware version '${
- stationTemplate.firmwareVersion
- }' in template file ${
- this.templateFile
- } does not match regular expression '${firmwareVersionRegExp.toString()}'`
- );
- }
const stationInfo: ChargingStationInfo =
ChargingStationUtils.stationTemplateToStationInfo(stationTemplate);
stationInfo.hashId = ChargingStationUtils.getHashId(this.index, stationTemplate);
? 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.resetTime = stationTemplate.resetTime
? stationTemplate.resetTime * 1000
: Constants.CHARGING_STATION_DEFAULT_RESET_TIME;
// 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,
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());
break;
}
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.getFirmwareUpgrade()?.versionUpgrade?.step ?? 1;
+ const patternGroup: number =
+ this.getFirmwareUpgrade()?.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 {
}
}
- 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()}'`
);
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;
logger.error(
`${this.logPrefix()} Charging profile id ${
matchingChargingProfile.chargingProfileId
- } limit is greater than connector id ${connectorId} maximum, dump charging profiles' stack: %j`,
+ } limit ${limit} is greater than connector id ${connectorId} maximum ${connectorMaximumPower}, dump charging profiles' stack: %j`,
this.getConnectorStatus(connectorId).chargingProfiles
);
limit = connectorMaximumPower;
this.startHeartbeat();
// Initialize connectors status
for (const connectorId of this.connectors.keys()) {
- let chargePointStatus: ChargePointStatus;
+ let connectorStatus: ConnectorStatusEnum;
if (connectorId === 0) {
continue;
} else if (
(this.isChargingStationAvailable() === false ||
this.isConnectorAvailable(connectorId) === false)
) {
- chargePointStatus = ChargePointStatus.UNAVAILABLE;
+ connectorStatus = ConnectorStatusEnum.UNAVAILABLE;
} else if (
!this.getConnectorStatus(connectorId)?.status &&
this.getConnectorStatus(connectorId)?.bootStatus
) {
// Set boot status in template at startup
- chargePointStatus = this.getConnectorStatus(connectorId).bootStatus;
+ connectorStatus = this.getConnectorStatus(connectorId).bootStatus;
} else if (this.getConnectorStatus(connectorId)?.status) {
// Set previous status at startup
- chargePointStatus = this.getConnectorStatus(connectorId).status;
+ connectorStatus = this.getConnectorStatus(connectorId).status;
} else {
// Set default status
- chargePointStatus = ChargePointStatus.AVAILABLE;
+ connectorStatus = ConnectorStatusEnum.AVAILABLE;
}
await this.ocppRequestService.requestHandler<
StatusNotificationRequest,
StatusNotificationResponse
- >(this, RequestCommand.STATUS_NOTIFICATION, {
- connectorId,
- status: chargePointStatus,
- errorCode: ChargePointErrorCode.NO_ERROR,
+ >(
+ 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.getConnectorStatus(connectorId).status = chargePointStatus;
+ this.stationInfo.firmwareStatus = FirmwareStatus.Installed;
}
+
// Start the ATG
if (this.getAutomaticTransactionGeneratorConfigurationFromTemplate()?.enable === true) {
this.startAutomaticTransactionGenerator();
await this.ocppRequestService.requestHandler<
StatusNotificationRequest,
StatusNotificationResponse
- >(this, RequestCommand.STATUS_NOTIFICATION, {
- connectorId,
- status: ChargePointStatus.UNAVAILABLE,
- errorCode: ChargePointErrorCode.NO_ERROR,
- });
+ >(
+ this,
+ RequestCommand.STATUS_NOTIFICATION,
+ OCPPServiceUtils.buildStatusNotificationRequest(
+ this,
+ connectorId,
+ ConnectorStatusEnum.UNAVAILABLE
+ )
+ );
this.getConnectorStatus(connectorId).status = null;
}
}
repositories / e-mobility-charging-stations-simulator.git / blobdiff