import crypto from 'crypto';
import fs from 'fs';
import path from 'path';
-import { URL, fileURLToPath } from 'url';
+import { URL } from 'url';
import { parentPort } from 'worker_threads';
import WebSocket, { Data, RawData } from 'ws';
import BaseError from '../exception/BaseError';
import OCPPError from '../exception/OCPPError';
import PerformanceStatistics from '../performance/PerformanceStatistics';
-import { AutomaticTransactionGeneratorConfiguration } from '../types/AutomaticTransactionGenerator';
-import ChargingStationConfiguration from '../types/ChargingStationConfiguration';
-import ChargingStationInfo from '../types/ChargingStationInfo';
-import ChargingStationOcppConfiguration from '../types/ChargingStationOcppConfiguration';
+import type { AutomaticTransactionGeneratorConfiguration } from '../types/AutomaticTransactionGenerator';
+import type ChargingStationConfiguration from '../types/ChargingStationConfiguration';
+import type ChargingStationInfo from '../types/ChargingStationInfo';
+import type ChargingStationOcppConfiguration from '../types/ChargingStationOcppConfiguration';
import ChargingStationTemplate, {
CurrentType,
PowerUnits,
WsOptions,
} from '../types/ChargingStationTemplate';
-import { ChargingStationWorkerMessageEvents } from '../types/ChargingStationWorker';
import { SupervisionUrlDistribution } from '../types/ConfigurationData';
-import { ConnectorStatus } from '../types/ConnectorStatus';
+import type { ConnectorStatus } from '../types/ConnectorStatus';
import { FileType } from '../types/FileType';
-import { JsonType } from '../types/JsonType';
+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 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 OCPPIncomingRequestService from './ocpp/OCPPIncomingRequestService';
-import OCPPRequestService from './ocpp/OCPPRequestService';
+import type OCPPIncomingRequestService from './ocpp/OCPPIncomingRequestService';
+import type OCPPRequestService from './ocpp/OCPPRequestService';
import SharedLRUCache from './SharedLRUCache';
export default class ChargingStation {
- public hashId!: string;
public readonly templateFile: string;
- public authorizedTagsCache: AuthorizedTagsCache;
public stationInfo!: ChargingStationInfo;
- public readonly connectors: Map<number, ConnectorStatus>;
+ public started: boolean;
+ public authorizedTagsCache: AuthorizedTagsCache;
+ public automaticTransactionGenerator!: AutomaticTransactionGenerator;
public ocppConfiguration!: ChargingStationOcppConfiguration;
public wsConnection!: WebSocket;
+ public readonly connectors: Map<number, ConnectorStatus>;
public readonly requests: Map<string, CachedRequest>;
public performanceStatistics!: PerformanceStatistics;
public heartbeatSetInterval!: NodeJS.Timeout;
public ocppRequestService!: OCPPRequestService;
+ public bootNotificationRequest!: BootNotificationRequest;
public bootNotificationResponse!: BootNotificationResponse | null;
public powerDivider!: number;
private readonly index: number;
private configurationFile!: string;
private configurationFileHash!: string;
- private bootNotificationRequest!: BootNotificationRequest;
private connectorsConfigurationHash!: string;
private ocppIncomingRequestService!: OCPPIncomingRequestService;
private readonly messageBuffer: Set<string>;
private configuredSupervisionUrl!: URL;
private wsConnectionRestarted: boolean;
private autoReconnectRetryCount: number;
- private stopped: boolean;
private templateFileWatcher!: fs.FSWatcher;
private readonly sharedLRUCache: SharedLRUCache;
- private automaticTransactionGenerator!: AutomaticTransactionGenerator;
private webSocketPingSetInterval!: NodeJS.Timeout;
+ private readonly chargingStationWorkerBroadcastChannel: ChargingStationWorkerBroadcastChannel;
constructor(index: number, templateFile: string) {
this.index = index;
this.templateFile = templateFile;
- this.stopped = false;
- this.wsConnectionRestarted = false;
- this.autoReconnectRetryCount = 0;
- this.sharedLRUCache = SharedLRUCache.getInstance();
- this.authorizedTagsCache = AuthorizedTagsCache.getInstance();
this.connectors = new Map<number, ConnectorStatus>();
this.requests = new Map<string, CachedRequest>();
this.messageBuffer = new Set<string>();
+ this.sharedLRUCache = SharedLRUCache.getInstance();
+ this.authorizedTagsCache = AuthorizedTagsCache.getInstance();
+ this.chargingStationWorkerBroadcastChannel = new ChargingStationWorkerBroadcastChannel(this);
+ this.started = false;
+ this.wsConnectionRestarted = false;
+ this.autoReconnectRetryCount = 0;
+
this.initialize();
}
);
}
- public getBootNotificationRequest(): BootNotificationRequest {
- return this.bootNotificationRequest;
- }
-
public getRandomIdTag(): string {
const authorizationFile = ChargingStationUtils.getAuthorizationFile(this.stationInfo);
const index = Math.floor(
: true;
}
- public getMayAuthorizeAtRemoteStart(): boolean | undefined {
- return this.stationInfo.mayAuthorizeAtRemoteStart ?? true;
+ public getMustAuthorizeAtRemoteStart(): boolean | undefined {
+ return this.stationInfo.mustAuthorizeAtRemoteStart ?? true;
+ }
+
+ public getPayloadSchemaValidation(): boolean | undefined {
+ return this.stationInfo.payloadSchemaValidation ?? true;
}
public getNumberOfPhases(stationInfo?: ChargingStationInfo): number | undefined {
return this.connectors.get(0) ? this.connectors.size - 1 : this.connectors.size;
}
- public getConnectorStatus(id: number): ConnectorStatus {
+ public getConnectorStatus(id: number): ConnectorStatus | undefined {
return this.connectors.get(id);
}
}
}
- public getEnergyActiveImportRegisterByTransactionId(transactionId: number): number | undefined {
- const transactionConnectorStatus = this.getConnectorStatus(
- this.getConnectorIdByTransactionId(transactionId)
+ public getEnergyActiveImportRegisterByTransactionId(
+ transactionId: number,
+ meterStop = false
+ ): number {
+ return this.getEnergyActiveImportRegister(
+ this.getConnectorStatus(this.getConnectorIdByTransactionId(transactionId)),
+ meterStop
);
- if (this.getMeteringPerTransaction()) {
- return transactionConnectorStatus?.transactionEnergyActiveImportRegisterValue;
- }
- return transactionConnectorStatus?.energyActiveImportRegisterValue;
}
- public getEnergyActiveImportRegisterByConnectorId(connectorId: number): number | undefined {
- const connectorStatus = this.getConnectorStatus(connectorId);
- if (this.getMeteringPerTransaction()) {
- return connectorStatus?.transactionEnergyActiveImportRegisterValue;
- }
- return connectorStatus?.energyActiveImportRegisterValue;
+ public getEnergyActiveImportRegisterByConnectorId(connectorId: number): number {
+ return this.getEnergyActiveImportRegister(this.getConnectorStatus(connectorId));
}
public getAuthorizeRemoteTxRequests(): boolean {
);
return;
}
- if (!this.getConnectorStatus(connectorId)?.transactionStarted) {
+ if (this.getConnectorStatus(connectorId)?.transactionStarted === false) {
logger.error(
`${this.logPrefix()} Trying to start MeterValues on connector Id ${connectorId} with no transaction started`
);
return;
} else if (
- this.getConnectorStatus(connectorId)?.transactionStarted &&
+ this.getConnectorStatus(connectorId)?.transactionStarted === true &&
!this.getConnectorStatus(connectorId)?.transactionId
) {
logger.error(
this.initialize();
// Restart the ATG
this.stopAutomaticTransactionGenerator();
- this.startAutomaticTransactionGenerator();
+ if (this.getAutomaticTransactionGeneratorConfigurationFromTemplate()?.enable === true) {
+ this.startAutomaticTransactionGenerator();
+ }
if (this.getEnableStatistics()) {
this.performanceStatistics.restart();
} else {
// FIXME?: restart heartbeat and WebSocket ping when their interval values have changed
} catch (error) {
logger.error(
- `${this.logPrefix()} ${FileType.ChargingStationTemplate} file monitoring error: %j`,
+ `${this.logPrefix()} ${FileType.ChargingStationTemplate} file monitoring error:`,
error
);
}
}
}
);
- parentPort.postMessage({
- id: ChargingStationWorkerMessageEvents.STARTED,
- data: { id: this.stationInfo.chargingStationId },
- });
+ parentPort.postMessage(MessageChannelUtils.buildStartedMessage(this));
}
- public async stop(reason: StopTransactionReason = StopTransactionReason.NONE): Promise<void> {
- // Stop message sequence
+ public async stop(reason?: StopTransactionReason): Promise<void> {
await this.stopMessageSequence(reason);
for (const connectorId of this.connectors.keys()) {
if (connectorId > 0) {
this.templateFileWatcher.close();
this.sharedLRUCache.deleteChargingStationTemplate(this.stationInfo?.templateHash);
this.bootNotificationResponse = null;
- parentPort.postMessage({
- id: ChargingStationWorkerMessageEvents.STOPPED,
- data: { id: this.stationInfo.chargingStationId },
- });
- this.stopped = true;
+ this.started = false;
+ parentPort.postMessage(MessageChannelUtils.buildStoppedMessage(this));
}
public async reset(reason?: StopTransactionReason): Promise<void> {
}
}
- public getChargingProfilePowerLimit(connectorId: number): number | undefined {
- let limit: number, matchingChargingProfile: ChargingProfile;
- let chargingProfiles: ChargingProfile[] = [];
- // Get charging profiles for connector and sort by stack level
- chargingProfiles = this.getConnectorStatus(connectorId).chargingProfiles.sort(
- (a, b) => b.stackLevel - a.stackLevel
- );
- // Get profiles on connector 0
- if (this.getConnectorStatus(0).chargingProfiles) {
- chargingProfiles.push(
- ...this.getConnectorStatus(0).chargingProfiles.sort((a, b) => b.stackLevel - a.stackLevel)
- );
- }
- if (!Utils.isEmptyArray(chargingProfiles)) {
- const result = ChargingStationUtils.getLimitFromChargingProfiles(
- chargingProfiles,
- Utils.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;
- }
-
public setChargingProfile(connectorId: number, cp: ChargingProfile): void {
if (Utils.isNullOrUndefined(this.getConnectorStatus(connectorId).chargingProfiles)) {
logger.error(
);
this.getConnectorStatus(connectorId).chargingProfiles = [];
}
- if (!Array.isArray(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).transactionEnergyActiveImportRegisterValue = 0;
delete this.getConnectorStatus(connectorId).transactionBeginMeterValue;
this.stopMeterValues(connectorId);
+ parentPort.postMessage(MessageChannelUtils.buildUpdatedMessage(this));
}
public hasFeatureProfile(featureProfile: SupportedFeatureProfiles) {
this.messageBuffer.add(message);
}
- private flushMessageBuffer() {
+ public openWSConnection(
+ options: WsOptions = this.stationInfo?.wsOptions ?? {},
+ params: { closeOpened?: boolean; terminateOpened?: boolean } = {
+ closeOpened: false,
+ terminateOpened: false,
+ }
+ ): void {
+ options.handshakeTimeout = options?.handshakeTimeout ?? this.getConnectionTimeout() * 1000;
+ params.closeOpened = params?.closeOpened ?? false;
+ params.terminateOpened = params?.terminateOpened ?? false;
+ if (
+ !Utils.isNullOrUndefined(this.stationInfo.supervisionUser) &&
+ !Utils.isNullOrUndefined(this.stationInfo.supervisionPassword)
+ ) {
+ options.auth = `${this.stationInfo.supervisionUser}:${this.stationInfo.supervisionPassword}`;
+ }
+ if (params?.closeOpened) {
+ this.closeWSConnection();
+ }
+ if (params?.terminateOpened) {
+ this.terminateWSConnection();
+ }
+ let protocol: string;
+ switch (this.getOcppVersion()) {
+ case OCPPVersion.VERSION_16:
+ protocol = 'ocpp' + OCPPVersion.VERSION_16;
+ break;
+ default:
+ this.handleUnsupportedVersion(this.getOcppVersion());
+ break;
+ }
+
+ if (this.isWebSocketConnectionOpened()) {
+ logger.warn(
+ `${this.logPrefix()} OCPP connection to URL ${this.wsConnectionUrl.toString()} is already opened`
+ );
+ return;
+ }
+
+ logger.info(
+ `${this.logPrefix()} Open OCPP connection to URL ${this.wsConnectionUrl.toString()}`
+ );
+
+ this.wsConnection = new WebSocket(this.wsConnectionUrl, protocol, options);
+
+ // 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);
+ }
+
+ public closeWSConnection(): void {
+ if (this.isWebSocketConnectionOpened()) {
+ this.wsConnection.close();
+ this.wsConnection = null;
+ }
+ }
+
+ public startAutomaticTransactionGenerator(connectorIds?: number[]): void {
+ if (!this.automaticTransactionGenerator) {
+ this.automaticTransactionGenerator = AutomaticTransactionGenerator.getInstance(
+ this.getAutomaticTransactionGeneratorConfigurationFromTemplate(),
+ this
+ );
+ }
+ if (!Utils.isEmptyArray(connectorIds)) {
+ for (const connectorId of connectorIds) {
+ this.automaticTransactionGenerator.startConnector(connectorId);
+ }
+ } else {
+ this.automaticTransactionGenerator.start();
+ }
+ }
+
+ public stopAutomaticTransactionGenerator(connectorIds?: number[]): void {
+ if (!Utils.isEmptyArray(connectorIds)) {
+ for (const connectorId of connectorIds) {
+ this.automaticTransactionGenerator?.stopConnector(connectorId);
+ }
+ } else {
+ this.automaticTransactionGenerator?.stop();
+ this.automaticTransactionGenerator = null;
+ }
+ }
+
+ public async stopTransactionOnConnector(
+ connectorId: number,
+ reason = StopTransactionReason.NONE
+ ): Promise<StopTransactionResponse> {
+ const transactionId = this.getConnectorStatus(connectorId).transactionId;
+ if (
+ this.getBeginEndMeterValues() &&
+ this.getOcppStrictCompliance() &&
+ !this.getOutOfOrderEndMeterValues()
+ ) {
+ // FIXME: Implement OCPP version agnostic helpers
+ const transactionEndMeterValue = OCPP16ServiceUtils.buildTransactionEndMeterValue(
+ this,
+ connectorId,
+ this.getEnergyActiveImportRegisterByTransactionId(transactionId)
+ );
+ await this.ocppRequestService.requestHandler<MeterValuesRequest, MeterValuesResponse>(
+ this,
+ RequestCommand.METER_VALUES,
+ {
+ connectorId,
+ transactionId,
+ meterValue: [transactionEndMeterValue],
+ }
+ );
+ }
+ return this.ocppRequestService.requestHandler<StopTransactionRequest, StopTransactionResponse>(
+ this,
+ RequestCommand.STOP_TRANSACTION,
+ {
+ transactionId,
+ meterStop: this.getEnergyActiveImportRegisterByTransactionId(transactionId, true),
+ reason,
+ }
+ );
+ }
+
+ private flushMessageBuffer(): void {
if (this.messageBuffer.size > 0) {
this.messageBuffer.forEach((message) => {
// TODO: evaluate the need to track performance
);
const stationInfo: ChargingStationInfo =
ChargingStationUtils.stationTemplateToStationInfo(stationTemplate);
+ stationInfo.hashId = ChargingStationUtils.getHashId(this.index, stationTemplate);
stationInfo.chargingStationId = ChargingStationUtils.getChargingStationId(
this.index,
stationTemplate
ChargingStationUtils.checkConfiguredMaxConnectors(
configuredMaxConnectors,
this.templateFile,
- Utils.logPrefix()
+ this.logPrefix()
);
const templateMaxConnectors =
ChargingStationUtils.getTemplateMaxNumberOfConnectors(stationTemplate);
ChargingStationUtils.checkTemplateMaxConnectors(
templateMaxConnectors,
this.templateFile,
- Utils.logPrefix()
+ this.logPrefix()
);
if (
configuredMaxConnectors >
}
private handleUnsupportedVersion(version: OCPPVersion) {
- const errMsg = `${this.logPrefix()} Unsupported protocol version '${version}' configured in template file ${
- this.templateFile
- }`;
- logger.error(errMsg);
- throw new Error(errMsg);
+ const errMsg = `Unsupported protocol version '${version}' configured in template file ${this.templateFile}`;
+ logger.error(`${this.logPrefix()} ${errMsg}`);
+ throw new BaseError(errMsg);
}
private initialize(): void {
- this.hashId = ChargingStationUtils.getHashId(this.index, this.getTemplateFromFile());
- logger.info(`${this.logPrefix()} Charging station hashId '${this.hashId}'`);
this.configurationFile = path.join(
- path.resolve(path.dirname(fileURLToPath(import.meta.url)), '../'),
- 'assets',
- 'configurations',
- this.hashId + '.json'
+ path.dirname(this.templateFile.replace('station-templates', 'configurations')),
+ 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()) {
this.performanceStatistics = PerformanceStatistics.getInstance(
- this.hashId,
+ this.stationInfo.hashId,
this.stationInfo.chargingStationId,
this.configuredSupervisionUrl
);
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);
+ const logMsg = `No already defined connectors and charging station information from template ${this.templateFile} with no connectors configuration defined`;
+ logger.error(`${this.logPrefix()} ${logMsg}`);
throw new BaseError(logMsg);
}
if (!stationInfo?.Connectors[0]) {
}
// Initialize transaction attributes on connectors
for (const connectorId of this.connectors.keys()) {
- if (connectorId > 0 && !this.getConnectorStatus(connectorId)?.transactionStarted) {
+ if (
+ connectorId > 0 &&
+ (this.getConnectorStatus(connectorId).transactionStarted === undefined ||
+ this.getConnectorStatus(connectorId).transactionStarted === false)
+ ) {
this.initializeConnectorStatus(connectorId);
}
}
`${this.logPrefix()} Registration failure: max retries reached (${this.getRegistrationMaxRetries()}) or retry disabled (${this.getRegistrationMaxRetries()})`
);
}
- this.stopped && (this.stopped = false);
+ this.started === false && (this.started = true);
this.autoReconnectRetryCount = 0;
this.wsConnectionRestarted = false;
+ parentPort.postMessage(MessageChannelUtils.buildUpdatedMessage(this));
} else {
logger.warn(
`${this.logPrefix()} Connection to OCPP server through ${this.wsConnectionUrl.toString()} failed`
case WebSocketCloseEventStatusCode.CLOSE_NORMAL:
case WebSocketCloseEventStatusCode.CLOSE_NO_STATUS:
logger.info(
- `${this.logPrefix()} WebSocket normally closed with status '${ChargingStationUtils.getWebSocketCloseEventStatusString(
+ `${this.logPrefix()} WebSocket normally closed with status '${Utils.getWebSocketCloseEventStatusString(
code
)}' and reason '${reason}'`
);
// Abnormal close
default:
logger.error(
- `${this.logPrefix()} WebSocket abnormally closed with status '${ChargingStationUtils.getWebSocketCloseEventStatusString(
+ `${this.logPrefix()} WebSocket abnormally closed with status '${Utils.getWebSocketCloseEventStatusString(
code
)}' and reason '${reason}'`
);
await this.reconnect(code);
break;
}
+ parentPort.postMessage(MessageChannelUtils.buildUpdatedMessage(this));
}
private async onMessage(data: Data): Promise<void> {
let errMsg: string;
try {
const request = JSON.parse(data.toString()) as IncomingRequest | Response | ErrorResponse;
- if (Utils.isIterable(request)) {
+ if (Array.isArray(request) === true) {
[messageType, messageId] = request;
// Check the type of message
switch (messageType) {
}
// Respond
cachedRequest = this.requests.get(messageId);
- if (Utils.isIterable(cachedRequest)) {
+ if (Array.isArray(cachedRequest) === true) {
[responseCallback, , requestCommandName, requestPayload] = cachedRequest;
} else {
throw new OCPPError(
ErrorType.PROTOCOL_ERROR,
- `Cached request for message id ${messageId} response is not iterable`,
+ `Cached request for message id ${messageId} response is not an array`,
null,
cachedRequest as unknown as JsonType
);
}
logger.debug(
`${this.logPrefix()} << Command '${
- requestCommandName ?? ''
+ requestCommandName ?? 'unknown'
}' received response payload: ${JSON.stringify(request)}`
);
responseCallback(commandPayload, requestPayload);
);
}
cachedRequest = this.requests.get(messageId);
- if (Utils.isIterable(cachedRequest)) {
+ if (Array.isArray(cachedRequest) === true) {
[, errorCallback, requestCommandName] = cachedRequest;
} else {
throw new OCPPError(
ErrorType.PROTOCOL_ERROR,
- `Cached request for message id ${messageId} error response is not iterable`,
+ `Cached request for message id ${messageId} error response is not an array`,
null,
cachedRequest as unknown as JsonType
);
}
logger.debug(
`${this.logPrefix()} << Command '${
- requestCommandName ?? ''
+ requestCommandName ?? 'unknown'
}' received error payload: ${JSON.stringify(request)}`
);
errorCallback(new OCPPError(errorType, errorMessage, requestCommandName, errorDetails));
// Error
default:
// eslint-disable-next-line @typescript-eslint/restrict-template-expressions
- errMsg = `${this.logPrefix()} Wrong message type ${messageType}`;
- logger.error(errMsg);
+ errMsg = `Wrong message type ${messageType}`;
+ logger.error(`${this.logPrefix()} ${errMsg}`);
throw new OCPPError(ErrorType.PROTOCOL_ERROR, errMsg);
}
+ parentPort.postMessage(MessageChannelUtils.buildUpdatedMessage(this));
} else {
- throw new OCPPError(ErrorType.PROTOCOL_ERROR, 'Incoming message is not iterable', null, {
+ throw new OCPPError(ErrorType.PROTOCOL_ERROR, 'Incoming message is not an array', null, {
payload: request,
});
}
} catch (error) {
// Log
logger.error(
- '%s Incoming OCPP message %j matching cached request %j processing error %j',
- this.logPrefix(),
- data.toString(),
- this.requests.get(messageId),
+ `${this.logPrefix()} Incoming OCPP command '${
+ commandName ?? requestCommandName ?? null
+ }' message '${data.toString()}' matching cached request '${JSON.stringify(
+ this.requests.get(messageId)
+ )}' processing error:`,
error
);
+ if (!(error instanceof OCPPError)) {
+ logger.warn(
+ `${this.logPrefix()} Error thrown at incoming OCPP command '${
+ commandName ?? requestCommandName ?? null
+ }' message '${data.toString()}' handling is not an OCPPError:`,
+ error
+ );
+ }
// Send error
messageType === MessageType.CALL_MESSAGE &&
(await this.ocppRequestService.sendError(
private onError(error: WSError): void {
this.closeWSConnection();
- logger.error(this.logPrefix() + ' WebSocket error: %j', error);
+ logger.error(this.logPrefix() + ' WebSocket error:', error);
+ }
+
+ private getEnergyActiveImportRegister(
+ connectorStatus: ConnectorStatus,
+ meterStop = false
+ ): number {
+ if (this.getMeteringPerTransaction()) {
+ return (
+ (meterStop === true
+ ? Math.round(connectorStatus?.transactionEnergyActiveImportRegisterValue)
+ : connectorStatus?.transactionEnergyActiveImportRegisterValue) ?? 0
+ );
+ }
+ return (
+ (meterStop === true
+ ? Math.round(connectorStatus?.energyActiveImportRegisterValue)
+ : connectorStatus?.energyActiveImportRegisterValue) ?? 0
+ );
}
private getUseConnectorId0(stationInfo?: ChargingStationInfo): boolean | undefined {
private getNumberOfRunningTransactions(): number {
let trxCount = 0;
for (const connectorId of this.connectors.keys()) {
- if (connectorId > 0 && this.getConnectorStatus(connectorId)?.transactionStarted) {
+ if (connectorId > 0 && this.getConnectorStatus(connectorId)?.transactionStarted === true) {
trxCount++;
}
}
return trxCount;
}
+ private async stopRunningTransactions(reason = StopTransactionReason.NONE): Promise<void> {
+ for (const connectorId of this.connectors.keys()) {
+ if (connectorId > 0 && this.getConnectorStatus(connectorId)?.transactionStarted === true) {
+ await this.stopTransactionOnConnector(connectorId, reason);
+ }
+ }
+ }
+
// 0 for disabling
private getConnectionTimeout(): number | undefined {
if (
}
}
+ 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) {
await this.ocppRequestService.requestHandler<
if (connectorId === 0) {
continue;
} else if (
- !this.stopped &&
+ this.started === true &&
!this.getConnectorStatus(connectorId)?.status &&
this.getConnectorStatus(connectorId)?.bootStatus
) {
this.getConnectorStatus(connectorId).status =
this.getConnectorStatus(connectorId).bootStatus;
} else if (
- this.stopped &&
+ this.started === false &&
this.getConnectorStatus(connectorId)?.status &&
this.getConnectorStatus(connectorId)?.bootStatus
) {
});
this.getConnectorStatus(connectorId).status =
this.getConnectorStatus(connectorId).bootStatus;
- } else if (!this.stopped && this.getConnectorStatus(connectorId)?.status) {
+ } else if (this.started === true && this.getConnectorStatus(connectorId)?.status) {
// Send previous status at template reload
await this.ocppRequestService.requestHandler<
StatusNotificationRequest,
}
}
// Start the ATG
- this.startAutomaticTransactionGenerator();
- }
-
- private startAutomaticTransactionGenerator() {
- if (this.getAutomaticTransactionGeneratorConfigurationFromTemplate()?.enable) {
- if (!this.automaticTransactionGenerator) {
- this.automaticTransactionGenerator = AutomaticTransactionGenerator.getInstance(
- this.getAutomaticTransactionGeneratorConfigurationFromTemplate(),
- this
- );
- }
- if (!this.automaticTransactionGenerator.started) {
- this.automaticTransactionGenerator.start();
- }
- }
- }
-
- private stopAutomaticTransactionGenerator(): void {
- if (this.automaticTransactionGenerator?.started) {
- this.automaticTransactionGenerator.stop();
- this.automaticTransactionGenerator = null;
+ if (this.getAutomaticTransactionGeneratorConfigurationFromTemplate()?.enable === true) {
+ this.startAutomaticTransactionGenerator();
}
}
// Stop heartbeat
this.stopHeartbeat();
// Stop ongoing transactions
- if (this.automaticTransactionGenerator?.configuration?.enable) {
+ if (this.automaticTransactionGenerator?.started === true) {
this.stopAutomaticTransactionGenerator();
} else {
- for (const connectorId of this.connectors.keys()) {
- if (connectorId > 0 && this.getConnectorStatus(connectorId)?.transactionStarted) {
- const transactionId = this.getConnectorStatus(connectorId).transactionId;
- if (
- this.getBeginEndMeterValues() &&
- this.getOcppStrictCompliance() &&
- !this.getOutOfOrderEndMeterValues()
- ) {
- // FIXME: Implement OCPP version agnostic helpers
- const transactionEndMeterValue = OCPP16ServiceUtils.buildTransactionEndMeterValue(
- this,
- connectorId,
- this.getEnergyActiveImportRegisterByTransactionId(transactionId)
- );
- await this.ocppRequestService.requestHandler<MeterValuesRequest, MeterValuesResponse>(
- this,
- RequestCommand.METER_VALUES,
- {
- connectorId,
- transactionId,
- meterValue: transactionEndMeterValue,
- }
- );
- }
- await this.ocppRequestService.requestHandler<
- StopTransactionRequest,
- StopTransactionResponse
- >(this, RequestCommand.STOP_TRANSACTION, {
- transactionId,
- meterStop: this.getEnergyActiveImportRegisterByTransactionId(transactionId),
- idTag: this.getTransactionIdTag(transactionId),
- reason,
- });
- }
- }
+ await this.stopRunningTransactions(reason);
}
}
}
}
- private openWSConnection(
- options: WsOptions = this.stationInfo?.wsOptions ?? {},
- params: { closeOpened?: boolean; terminateOpened?: boolean } = {
- closeOpened: false,
- terminateOpened: false,
- }
- ): void {
- options.handshakeTimeout = options?.handshakeTimeout ?? this.getConnectionTimeout() * 1000;
- params.closeOpened = params?.closeOpened ?? false;
- params.terminateOpened = params?.terminateOpened ?? false;
- if (
- !Utils.isNullOrUndefined(this.stationInfo.supervisionUser) &&
- !Utils.isNullOrUndefined(this.stationInfo.supervisionPassword)
- ) {
- options.auth = `${this.stationInfo.supervisionUser}:${this.stationInfo.supervisionPassword}`;
- }
- if (params?.closeOpened) {
- this.closeWSConnection();
- }
- if (params?.terminateOpened) {
- this.terminateWSConnection();
- }
- let protocol: string;
- switch (this.getOcppVersion()) {
- case OCPPVersion.VERSION_16:
- protocol = 'ocpp' + OCPPVersion.VERSION_16;
- break;
- default:
- this.handleUnsupportedVersion(this.getOcppVersion());
- break;
- }
-
- logger.info(
- this.logPrefix() + ' Open OCPP connection to URL ' + this.wsConnectionUrl.toString()
- );
-
- this.wsConnection = new WebSocket(this.wsConnectionUrl, protocol, options);
-
- // 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);
- }
-
- private closeWSConnection(): void {
- if (this.isWebSocketConnectionOpened()) {
- this.wsConnection.close();
- this.wsConnection = null;
- }
- }
-
private terminateWSConnection(): void {
if (this.isWebSocketConnectionOpened()) {
this.wsConnection.terminate();
// Stop heartbeat
this.stopHeartbeat();
// Stop the ATG if needed
- if (this.automaticTransactionGenerator?.configuration?.stopOnConnectionFailure) {
+ if (this.automaticTransactionGenerator?.configuration?.stopOnConnectionFailure === true) {
this.stopAutomaticTransactionGenerator();
}
if (
repositories / e-mobility-charging-stations-simulator.git / blobdiff