// Partial Copyright Jerome Benoit. 2021. All Rights Reserved.
-import { ACElectricUtils, DCElectricUtils } from '../utils/ElectricUtils';
+import crypto from 'crypto';
+import fs from 'fs';
+import path from 'path';
+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 ChargingStationTemplate, {
+ CurrentType,
+ PowerUnits,
+ WsOptions,
+} from '../types/ChargingStationTemplate';
+import { SupervisionUrlDistribution } from '../types/ConfigurationData';
+import { ConnectorStatus } from '../types/ConnectorStatus';
+import { FileType } from '../types/FileType';
+import { 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 { 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,
Response,
StatusNotificationResponse,
} from '../types/ocpp/Responses';
-import { ChargingProfile, ChargingRateUnitType } from '../types/ocpp/ChargingProfile';
-import ChargingStationTemplate, {
- CurrentType,
- PowerUnits,
- WsOptions,
-} from '../types/ChargingStationTemplate';
-import {
- ConnectorPhaseRotation,
- StandardParametersKey,
- SupportedFeatureProfiles,
- VendorDefaultParametersKey,
-} from '../types/ocpp/Configuration';
-import { MeterValue, MeterValueMeasurand } from '../types/ocpp/MeterValues';
import {
StopTransactionReason,
StopTransactionRequest,
StopTransactionResponse,
} from '../types/ocpp/Transaction';
-import { URL, fileURLToPath } from 'url';
import { WSError, WebSocketCloseEventStatusCode } from '../types/WebSocket';
-import WebSocket, { Data, RawData } from 'ws';
-
+import Configuration from '../utils/Configuration';
+import Constants from '../utils/Constants';
+import { ACElectricUtils, DCElectricUtils } from '../utils/ElectricUtils';
+import FileUtils from '../utils/FileUtils';
+import logger from '../utils/Logger';
+import Utils from '../utils/Utils';
import AuthorizedTagsCache from './AuthorizedTagsCache';
import AutomaticTransactionGenerator from './AutomaticTransactionGenerator';
-import { AutomaticTransactionGeneratorConfiguration } from '../types/AutomaticTransactionGenerator';
-import BaseError from '../exception/BaseError';
-import { ChargePointErrorCode } from '../types/ocpp/ChargePointErrorCode';
-import { ChargePointStatus } from '../types/ocpp/ChargePointStatus';
-import { ChargingStationCache } from './ChargingStationCache';
-import ChargingStationConfiguration from '../types/ChargingStationConfiguration';
import { ChargingStationConfigurationUtils } from './ChargingStationConfigurationUtils';
-import ChargingStationInfo from '../types/ChargingStationInfo';
-import ChargingStationOcppConfiguration from '../types/ChargingStationOcppConfiguration';
import { ChargingStationUtils } from './ChargingStationUtils';
-import { ChargingStationWorkerMessageEvents } from '../types/ChargingStationWorker';
-import Configuration from '../utils/Configuration';
-import { ConnectorStatus } from '../types/ConnectorStatus';
-import Constants from '../utils/Constants';
-import { ErrorType } from '../types/ocpp/ErrorType';
-import { FileType } from '../types/FileType';
-import FileUtils from '../utils/FileUtils';
-import { JsonType } from '../types/JsonType';
-import { MessageType } from '../types/ocpp/MessageType';
+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 OCPPError from '../exception/OCPPError';
import OCPPIncomingRequestService from './ocpp/OCPPIncomingRequestService';
import OCPPRequestService from './ocpp/OCPPRequestService';
-import { OCPPVersion } from '../types/ocpp/OCPPVersion';
-import PerformanceStatistics from '../performance/PerformanceStatistics';
-import { SupervisionUrlDistribution } from '../types/ConfigurationData';
-import Utils from '../utils/Utils';
-import crypto from 'crypto';
-import fs from 'fs';
-import logger from '../utils/Logger';
-import { parentPort } from 'worker_threads';
-import path from 'path';
+import SharedLRUCache from './SharedLRUCache';
export default class ChargingStation {
public hashId!: string;
public readonly templateFile: string;
public authorizedTagsCache: AuthorizedTagsCache;
public stationInfo!: ChargingStationInfo;
+ public stopped: boolean;
public readonly connectors: Map<number, ConnectorStatus>;
public ocppConfiguration!: ChargingStationOcppConfiguration;
public wsConnection!: WebSocket;
private configuredSupervisionUrl!: URL;
private wsConnectionRestarted: boolean;
private autoReconnectRetryCount: number;
- private stopped: boolean;
private templateFileWatcher!: fs.FSWatcher;
- private readonly cache: ChargingStationCache;
+ private readonly sharedLRUCache: SharedLRUCache;
private automaticTransactionGenerator!: AutomaticTransactionGenerator;
private webSocketPingSetInterval!: NodeJS.Timeout;
+ private readonly chargingStationWorkerBroadcastChannel: ChargingStationWorkerBroadcastChannel;
constructor(index: number, templateFile: string) {
this.index = index;
this.stopped = false;
this.wsConnectionRestarted = false;
this.autoReconnectRetryCount = 0;
- this.cache = ChargingStationCache.getInstance();
+ 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.chargingStationWorkerBroadcastChannel = new ChargingStationWorkerBroadcastChannel(this);
+
this.initialize();
}
return this.stationInfo.mayAuthorizeAtRemoteStart ?? true;
}
+ public getPayloadSchemaValidation(): boolean | undefined {
+ return this.stationInfo.payloadSchemaValidation ?? true;
+ }
+
public getNumberOfPhases(stationInfo?: ChargingStationInfo): number | undefined {
const localStationInfo: ChargingStationInfo = stationInfo ?? this.stationInfo;
switch (this.getCurrentOutType(stationInfo)) {
}
}
- public getEnergyActiveImportRegisterByTransactionId(transactionId: number): number | undefined {
+ public getEnergyActiveImportRegisterByTransactionId(transactionId: number): number {
const transactionConnectorStatus = this.getConnectorStatus(
this.getConnectorIdByTransactionId(transactionId)
);
if (this.getMeteringPerTransaction()) {
- return transactionConnectorStatus?.transactionEnergyActiveImportRegisterValue;
+ return transactionConnectorStatus?.transactionEnergyActiveImportRegisterValue ?? 0;
}
- return transactionConnectorStatus?.energyActiveImportRegisterValue;
+ return transactionConnectorStatus?.energyActiveImportRegisterValue ?? 0;
}
- public getEnergyActiveImportRegisterByConnectorId(connectorId: number): number | undefined {
+ public getEnergyActiveImportRegisterByConnectorId(connectorId: number): number {
const connectorStatus = this.getConnectorStatus(connectorId);
if (this.getMeteringPerTransaction()) {
- return connectorStatus?.transactionEnergyActiveImportRegisterValue;
+ return connectorStatus?.transactionEnergyActiveImportRegisterValue ?? 0;
}
- return connectorStatus?.energyActiveImportRegisterValue;
+ return connectorStatus?.energyActiveImportRegisterValue ?? 0;
}
public getAuthorizeRemoteTxRequests(): boolean {
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 charging station template file
this.templateFileWatcher = FileUtils.watchJsonFile(
this.logPrefix(),
this.templateFile
} file have changed, reload`
);
- this.cache.deleteChargingStationTemplate(this.stationInfo?.templateHash);
+ this.sharedLRUCache.deleteChargingStationTemplate(this.stationInfo?.templateHash);
// Initialize
this.initialize();
// Restart the ATG
// 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> {
if (this.getEnableStatistics()) {
this.performanceStatistics.stop();
}
- this.cache.deleteChargingStationConfiguration(this.configurationFileHash);
+ this.sharedLRUCache.deleteChargingStationConfiguration(this.configurationFileHash);
this.templateFileWatcher.close();
- this.cache.deleteChargingStationTemplate(this.stationInfo?.templateHash);
+ this.sharedLRUCache.deleteChargingStationTemplate(this.stationInfo?.templateHash);
this.bootNotificationResponse = null;
- parentPort.postMessage({
- id: ChargingStationWorkerMessageEvents.STOPPED,
- data: { id: this.stationInfo.chargingStationId },
- });
this.stopped = true;
+ parentPort.postMessage(MessageChannelUtils.buildStoppedMessage(this));
}
public async reset(reason?: StopTransactionReason): Promise<void> {
);
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.messageBuffer.add(message);
}
+ 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;
+ }
+
+ 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;
+ }
+ }
+
private flushMessageBuffer() {
if (this.messageBuffer.size > 0) {
this.messageBuffer.forEach((message) => {
private getTemplateFromFile(): ChargingStationTemplate | null {
let template: ChargingStationTemplate = null;
try {
- if (this.cache.hasChargingStationTemplate(this.stationInfo?.templateHash)) {
- template = this.cache.getChargingStationTemplate(this.stationInfo.templateHash);
+ if (this.sharedLRUCache.hasChargingStationTemplate(this.stationInfo?.templateHash)) {
+ template = this.sharedLRUCache.getChargingStationTemplate(this.stationInfo.templateHash);
} else {
const measureId = `${FileType.ChargingStationTemplate} read`;
const beginId = PerformanceStatistics.beginMeasure(measureId);
.createHash(Constants.DEFAULT_HASH_ALGORITHM)
.update(JSON.stringify(template))
.digest('hex');
- this.cache.setChargingStationTemplate(template);
+ this.sharedLRUCache.setChargingStationTemplate(template);
}
} catch (error) {
FileUtils.handleFileException(
this.templateFile
}`;
logger.error(errMsg);
- throw new Error(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',
+ path.dirname(this.templateFile.replace('station-templates', 'configurations')),
this.hashId + '.json'
);
this.stationInfo = this.getStationInfo();
let configuration: ChargingStationConfiguration = null;
if (this.configurationFile && fs.existsSync(this.configurationFile)) {
try {
- if (this.cache.hasChargingStationConfiguration(this.configurationFileHash)) {
- configuration = this.cache.getChargingStationConfiguration(this.configurationFileHash);
+ if (this.sharedLRUCache.hasChargingStationConfiguration(this.configurationFileHash)) {
+ configuration = this.sharedLRUCache.getChargingStationConfiguration(
+ this.configurationFileHash
+ );
} else {
const measureId = `${FileType.ChargingStationConfiguration} read`;
const beginId = PerformanceStatistics.beginMeasure(measureId);
) as ChargingStationConfiguration;
PerformanceStatistics.endMeasure(measureId, beginId);
this.configurationFileHash = configuration.configurationHash;
- this.cache.setChargingStationConfiguration(configuration);
+ this.sharedLRUCache.setChargingStationConfiguration(configuration);
}
} catch (error) {
FileUtils.handleFileException(
fs.writeFileSync(fileDescriptor, JSON.stringify(configurationData, null, 2), 'utf8');
fs.closeSync(fileDescriptor);
PerformanceStatistics.endMeasure(measureId, beginId);
- this.cache.deleteChargingStationConfiguration(this.configurationFileHash);
+ this.sharedLRUCache.deleteChargingStationConfiguration(this.configurationFileHash);
this.configurationFileHash = configurationHash;
- this.cache.setChargingStationConfiguration(configurationData);
+ this.sharedLRUCache.setChargingStationConfiguration(configurationData);
} else {
logger.debug(
`${this.logPrefix()} Not saving unchanged charging station configuration file ${
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));
logger.error(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',
+ "%s Incoming OCPP '%s' message '%j' matching cached request '%j' processing error:",
this.logPrefix(),
+ commandName ?? requestCommandName ?? null,
data.toString(),
this.requests.get(messageId),
error
);
+ if (!(error instanceof OCPPError)) {
+ logger.warn(
+ "%s Error thrown at incoming OCPP '%s' message '%j' handling is not an OCPPError:",
+ this.logPrefix(),
+ commandName ?? requestCommandName ?? null,
+ data.toString(),
+ error
+ );
+ }
// Send error
messageType === MessageType.CALL_MESSAGE &&
(await this.ocppRequestService.sendError(
}
private onError(error: WSError): void {
- logger.error(this.logPrefix() + ' WebSocket error: %j', error);
+ this.closeWSConnection();
+ logger.error(this.logPrefix() + ' WebSocket error:', error);
}
private getUseConnectorId0(stationInfo?: ChargingStationInfo): boolean | undefined {
{
connectorId,
transactionId,
- meterValue: transactionEndMeterValue,
+ meterValue: [transactionEndMeterValue],
}
);
}
}
}
- 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;
- }
- this.wsConnection = new WebSocket(this.wsConnectionUrl, protocol, options);
- logger.info(
- this.logPrefix() + ' Open OCPP connection to URL ' + this.wsConnectionUrl.toString()
- );
- }
-
- private closeWSConnection(): void {
- if (this.isWebSocketConnectionOpened()) {
- this.wsConnection.close();
- this.wsConnection = null;
- }
- }
-
private terminateWSConnection(): void {
if (this.isWebSocketConnectionOpened()) {
this.wsConnection.terminate();