-import { AuthorizationStatus, StartTransactionResponse, StopTransactionReason, StopTransactionResponse } from '../types/Transaction';
+import { AuthorizationStatus, StartTransactionRequest, StartTransactionResponse, StopTransactionReason, StopTransactionRequest, StopTransactionResponse } from '../types/ocpp/1.6/Transaction';
+import { BootNotificationResponse, ChangeConfigurationResponse, DefaultResponse, GetConfigurationResponse, HeartbeatResponse, RegistrationStatus, SetChargingProfileResponse, StatusNotificationResponse, UnlockConnectorResponse } from '../types/ocpp/1.6/RequestResponses';
+import { ChargingProfile, ChargingProfilePurposeType } from '../types/ocpp/1.6/ChargingProfile';
import ChargingStationConfiguration, { ConfigurationKey } from '../types/ChargingStationConfiguration';
import ChargingStationTemplate, { PowerOutType } from '../types/ChargingStationTemplate';
-import { ConfigurationResponse, DefaultRequestResponse, UnlockResponse } from '../types/RequestResponses';
import Connectors, { Connector } from '../types/Connectors';
-import MeterValue, { MeterValueLocation, MeterValueMeasurand, MeterValuePhase, MeterValueUnit } from '../types/MeterValue';
+import { MeterValue, MeterValueLocation, MeterValueMeasurand, MeterValuePhase, MeterValueUnit, MeterValuesRequest, MeterValuesResponse, SampledValue } from '../types/ocpp/1.6/MeterValues';
import { PerformanceObserver, performance } from 'perf_hooks';
+import Requests, { BootNotificationRequest, ChangeConfigurationRequest, GetConfigurationRequest, HeartbeatRequest, IncomingRequest, IncomingRequestCommand, RemoteStartTransactionRequest, RemoteStopTransactionRequest, Request, RequestCommand, ResetRequest, SetChargingProfileRequest, StatusNotificationRequest, UnlockConnectorRequest } from '../types/ocpp/1.6/Requests';
+import WebSocket, { MessageEvent } from 'ws';
import AutomaticTransactionGenerator from './AutomaticTransactionGenerator';
-import { ChargePointErrorCode } from '../types/ChargePointErrorCode';
-import { ChargePointStatus } from '../types/ChargePointStatus';
+import { ChargePointErrorCode } from '../types/ocpp/1.6/ChargePointErrorCode';
+import { ChargePointStatus } from '../types/ocpp/1.6/ChargePointStatus';
import ChargingStationInfo from '../types/ChargingStationInfo';
import Configuration from '../utils/Configuration';
-import Constants from '../utils/Constants.js';
+import Constants from '../utils/Constants';
import ElectricUtils from '../utils/ElectricUtils';
+import { ErrorType } from '../types/ocpp/ErrorType';
import MeasurandValues from '../types/MeasurandValues';
-import OCPPError from './OcppError.js';
+import { MessageType } from '../types/ocpp/MessageType';
+import OCPPError from './OcppError';
import Statistics from '../utils/Statistics';
import Utils from '../utils/Utils';
-import WebSocket from 'ws';
+import { WebSocketCloseEventStatusCode } from '../types/WebSocket';
import crypto from 'crypto';
import fs from 'fs';
import logger from '../utils/Logger';
private _index: number;
private _stationTemplateFile: string;
private _stationInfo: ChargingStationInfo;
- private _bootNotificationMessage: {
- chargePointModel: string,
- chargePointVendor: string,
- chargeBoxSerialNumber?: string,
- firmwareVersion?: string,
- };
-
+ private _bootNotificationRequest: BootNotificationRequest;
+ private _bootNotificationResponse: BootNotificationResponse;
private _connectors: Connectors;
private _configuration: ChargingStationConfiguration;
private _connectorsConfigurationHash: string;
private _hasStopped: boolean;
private _hasSocketRestarted: boolean;
private _autoReconnectRetryCount: number;
- private _autoReconnectMaxRetries: number;
- private _autoReconnectTimeout: number;
- private _requests: { [id: string]: [(payload?, requestPayload?) => void, (error?: OCPPError) => void, object] };
- private _messageQueue: any[];
+ private _requests: Requests;
+ private _messageQueue: string[];
private _automaticTransactionGeneration: AutomaticTransactionGenerator;
private _authorizedTags: string[];
private _heartbeatInterval: number;
private _heartbeatSetInterval: NodeJS.Timeout;
+ private _webSocketPingSetInterval: NodeJS.Timeout;
private _statistics: Statistics;
private _performanceObserver: PerformanceObserver;
constructor(index: number, stationTemplateFile: string) {
this._index = index;
this._stationTemplateFile = stationTemplateFile;
- this._connectors = {};
+ this._connectors = {} as Connectors;
this._initialize();
this._hasStopped = false;
this._hasSocketRestarted = false;
this._autoReconnectRetryCount = 0;
- this._autoReconnectMaxRetries = Configuration.getAutoReconnectMaxRetries(); // -1 for unlimited
- this._autoReconnectTimeout = Configuration.getAutoReconnectTimeout() * 1000; // Ms, zero for disabling
- this._requests = {};
- this._messageQueue = [];
+ this._requests = {} as Requests;
+ this._messageQueue = [] as string[];
this._authorizedTags = this._loadAndGetAuthorizedTags();
}
_initialize(): void {
this._stationInfo = this._buildStationInfo();
- this._bootNotificationMessage = {
+ this._bootNotificationRequest = {
chargePointModel: this._stationInfo.chargePointModel,
chargePointVendor: this._stationInfo.chargePointVendor,
...!Utils.isUndefined(this._stationInfo.chargeBoxSerialNumberPrefix) && { chargeBoxSerialNumber: this._stationInfo.chargeBoxSerialNumberPrefix },
...!Utils.isUndefined(this._stationInfo.firmwareVersion) && { firmwareVersion: this._stationInfo.firmwareVersion },
};
- this._configuration = this._getConfiguration();
+ this._configuration = this._getTemplateChargingStationConfiguration();
this._supervisionUrl = this._getSupervisionURL();
this._wsConnectionUrl = this._supervisionUrl + '/' + this._stationInfo.name;
// Build connectors if needed
}
const templateMaxConnectors = this._getTemplateMaxNumberOfConnectors();
if (templateMaxConnectors <= 0) {
- logger.warn(`${this._logPrefix()} Charging station template ${this._stationTemplateFile} with no connector configurations`);
+ logger.warn(`${this._logPrefix()} Charging station template ${this._stationTemplateFile} with no connector configuration`);
+ }
+ if (!this._stationInfo.Connectors[0]) {
+ logger.warn(`${this._logPrefix()} Charging station template ${this._stationTemplateFile} with no connector Id 0 configuration`);
}
// Sanity check
if (maxConnectors > (this._stationInfo.Connectors[0] ? templateMaxConnectors - 1 : templateMaxConnectors) && !this._stationInfo.randomConnectors) {
// Add connector Id 0
let lastConnector = '0';
for (lastConnector in this._stationInfo.Connectors) {
- if (Utils.convertToInt(lastConnector) === 0 && this._stationInfo.useConnectorId0 && this._stationInfo.Connectors[lastConnector]) {
- this._connectors[lastConnector] = Utils.cloneObject(this._stationInfo.Connectors[lastConnector]) as Connector;
+ if (Utils.convertToInt(lastConnector) === 0 && this._getUseConnectorId0() && this._stationInfo.Connectors[lastConnector]) {
+ this._connectors[lastConnector] = Utils.cloneObject<Connector>(this._stationInfo.Connectors[lastConnector]);
}
}
// Generate all connectors
if ((this._stationInfo.Connectors[0] ? templateMaxConnectors - 1 : templateMaxConnectors) > 0) {
for (let index = 1; index <= maxConnectors; index++) {
const randConnectorID = this._stationInfo.randomConnectors ? Utils.getRandomInt(Utils.convertToInt(lastConnector), 1) : index;
- this._connectors[index] = Utils.cloneObject(this._stationInfo.Connectors[randConnectorID]) as Connector;
+ this._connectors[index] = Utils.cloneObject<Connector>(this._stationInfo.Connectors[randConnectorID]);
}
}
}
delete this._stationInfo.Connectors;
// Initialize transaction attributes on connectors
for (const connector in this._connectors) {
- if (!this.getConnector(Utils.convertToInt(connector)).transactionStarted) {
+ if (Utils.convertToInt(connector) > 0 && !this.getConnector(Utils.convertToInt(connector)).transactionStarted) {
this._initTransactionOnConnector(Utils.convertToInt(connector));
}
}
return Utils.logPrefix(` ${this._stationInfo.name}:`);
}
- _getConfiguration(): ChargingStationConfiguration {
+ _isWebSocketOpen(): boolean {
+ return this._wsConnection?.readyState === WebSocket.OPEN;
+ }
+
+ _isRegistered(): boolean {
+ return this._bootNotificationResponse?.status === RegistrationStatus.ACCEPTED;
+ }
+
+ _getTemplateChargingStationConfiguration(): ChargingStationConfiguration {
return this._stationInfo.Configuration ? this._stationInfo.Configuration : {} as ChargingStationConfiguration;
}
return this._stationInfo.authorizationFile && this._stationInfo.authorizationFile;
}
+ _getUseConnectorId0(): boolean {
+ return !Utils.isUndefined(this._stationInfo.useConnectorId0) ? this._stationInfo.useConnectorId0 : true;
+ }
+
_loadAndGetAuthorizedTags(): string[] {
let authorizedTags: string[] = [];
const authorizationFile = this._getAuthorizationFile();
_getNumberOfPhases(): number {
switch (this._getPowerOutType()) {
case PowerOutType.AC:
- return !Utils.isUndefined(this._stationInfo.numberOfPhases) ? Utils.convertToInt(this._stationInfo.numberOfPhases) : 3;
+ return !Utils.isUndefined(this._stationInfo.numberOfPhases) ? this._stationInfo.numberOfPhases : 3;
case PowerOutType.DC:
return 0;
}
_getNumberOfRunningTransactions(): number {
let trxCount = 0;
for (const connector in this._connectors) {
- if (this.getConnector(Utils.convertToInt(connector)).transactionStarted) {
+ if (Utils.convertToInt(connector) > 0 && this.getConnector(Utils.convertToInt(connector)).transactionStarted) {
trxCount++;
}
}
return trxCount;
}
+ // 0 for disabling
+ _getConnectionTimeout(): number {
+ if (!Utils.isUndefined(this._stationInfo.connectionTimeout)) {
+ return this._stationInfo.connectionTimeout;
+ }
+ if (!Utils.isUndefined(Configuration.getConnectionTimeout())) {
+ return Configuration.getConnectionTimeout();
+ }
+ return 30;
+ }
+
+ // -1 for unlimited, 0 for disabling
+ _getAutoReconnectMaxRetries(): number {
+ if (!Utils.isUndefined(this._stationInfo.autoReconnectMaxRetries)) {
+ return this._stationInfo.autoReconnectMaxRetries;
+ }
+ if (!Utils.isUndefined(Configuration.getAutoReconnectMaxRetries())) {
+ return Configuration.getAutoReconnectMaxRetries();
+ }
+ return -1;
+ }
+
+ // 0 for disabling
+ _getRegistrationMaxRetries(): number {
+ if (!Utils.isUndefined(this._stationInfo.registrationMaxRetries)) {
+ return this._stationInfo.registrationMaxRetries;
+ }
+ return -1;
+ }
+
_getPowerDivider(): number {
let powerDivider = this._getNumberOfConnectors();
if (this._stationInfo.powerSharedByConnectors) {
logger.error(errMsg);
throw Error(errMsg);
}
- return !Utils.isUndefined(this._stationInfo.voltageOut) ? Utils.convertToInt(this._stationInfo.voltageOut) : defaultVoltageOut;
+ return !Utils.isUndefined(this._stationInfo.voltageOut) ? this._stationInfo.voltageOut : defaultVoltageOut;
}
- _getTransactionidTag(transactionId: number): string {
+ _getTransactionIdTag(transactionId: number): string {
for (const connector in this._connectors) {
- if (this.getConnector(Utils.convertToInt(connector)).transactionId === transactionId) {
+ if (Utils.convertToInt(connector) > 0 && this.getConnector(Utils.convertToInt(connector)).transactionId === transactionId) {
return this.getConnector(Utils.convertToInt(connector)).idTag;
}
}
}
+ _getTransactionMeterStop(transactionId: number): number {
+ for (const connector in this._connectors) {
+ if (Utils.convertToInt(connector) > 0 && this.getConnector(Utils.convertToInt(connector)).transactionId === transactionId) {
+ return this.getConnector(Utils.convertToInt(connector)).lastEnergyActiveImportRegisterValue;
+ }
+ }
+ }
+
_getPowerOutType(): PowerOutType {
return !Utils.isUndefined(this._stationInfo.powerOutType) ? this._stationInfo.powerOutType : PowerOutType.AC;
}
_getSupervisionURL(): string {
- const supervisionUrls = Utils.cloneObject(this._stationInfo.supervisionURL ? this._stationInfo.supervisionURL : Configuration.getSupervisionURLs()) as string | string[];
+ const supervisionUrls = Utils.cloneObject<string | string[]>(this._stationInfo.supervisionURL ? this._stationInfo.supervisionURL : Configuration.getSupervisionURLs());
let indexUrl = 0;
if (!Utils.isEmptyArray(supervisionUrls)) {
- if (Configuration.getDistributeStationToTenantEqually()) {
+ if (Configuration.getDistributeStationsToTenantsEqually()) {
indexUrl = this._index % supervisionUrls.length;
} else {
// Get a random url
return supervisionUrls as string;
}
+ _getReconnectExponentialDelay(): boolean {
+ return !Utils.isUndefined(this._stationInfo.reconnectExponentialDelay) ? this._stationInfo.reconnectExponentialDelay : false;
+ }
+
_getAuthorizeRemoteTxRequests(): boolean {
const authorizeRemoteTxRequests = this._getConfigurationKey('AuthorizeRemoteTxRequests');
return authorizeRemoteTxRequests ? Utils.convertToBoolean(authorizeRemoteTxRequests.value) : false;
return localAuthListEnabled ? Utils.convertToBoolean(localAuthListEnabled.value) : false;
}
- _startMessageSequence(): void {
+ async _startMessageSequence(): Promise<void> {
+ // Start WebSocket ping
+ this._startWebSocketPing();
// Start heartbeat
this._startHeartbeat();
// Initialize connectors status
for (const connector in this._connectors) {
- if (!this.getConnector(Utils.convertToInt(connector)).transactionStarted) {
- if (!this.getConnector(Utils.convertToInt(connector)).status && this.getConnector(Utils.convertToInt(connector)).bootStatus) {
- this.sendStatusNotification(Utils.convertToInt(connector), this.getConnector(Utils.convertToInt(connector)).bootStatus);
- } else if (!this._hasStopped && this.getConnector(Utils.convertToInt(connector)).status) {
- this.sendStatusNotification(Utils.convertToInt(connector), this.getConnector(Utils.convertToInt(connector)).status);
- } else {
- this.sendStatusNotification(Utils.convertToInt(connector), ChargePointStatus.AVAILABLE);
- }
+ if (Utils.convertToInt(connector) === 0) {
+ continue;
+ } else if (!this._hasStopped && !this.getConnector(Utils.convertToInt(connector)).status && this.getConnector(Utils.convertToInt(connector)).bootStatus) {
+ // Send status in template at startup
+ await this.sendStatusNotification(Utils.convertToInt(connector), this.getConnector(Utils.convertToInt(connector)).bootStatus);
+ } else if (this._hasStopped && this.getConnector(Utils.convertToInt(connector)).bootStatus) {
+ // Send status in template after reset
+ await this.sendStatusNotification(Utils.convertToInt(connector), this.getConnector(Utils.convertToInt(connector)).bootStatus);
+ } else if (!this._hasStopped && this.getConnector(Utils.convertToInt(connector)).status) {
+ // Send previous status at template reload
+ await this.sendStatusNotification(Utils.convertToInt(connector), this.getConnector(Utils.convertToInt(connector)).status);
} else {
- this.sendStatusNotification(Utils.convertToInt(connector), ChargePointStatus.CHARGING);
+ // Send default status
+ await this.sendStatusNotification(Utils.convertToInt(connector), ChargePointStatus.AVAILABLE);
}
}
// Start the ATG
}
async _stopMessageSequence(reason: StopTransactionReason = StopTransactionReason.NONE): Promise<void> {
+ // Stop WebSocket ping
+ this._stopWebSocketPing();
// Stop heartbeat
this._stopHeartbeat();
// Stop the ATG
await this._automaticTransactionGeneration.stop(reason);
} else {
for (const connector in this._connectors) {
- if (this.getConnector(Utils.convertToInt(connector)).transactionStarted) {
+ if (Utils.convertToInt(connector) > 0 && this.getConnector(Utils.convertToInt(connector)).transactionStarted) {
await this.sendStopTransaction(this.getConnector(Utils.convertToInt(connector)).transactionId, reason);
}
}
}
}
+ _startWebSocketPing(): void {
+ const webSocketPingInterval: number = this._getConfigurationKey('WebSocketPingInterval') ? Utils.convertToInt(this._getConfigurationKey('WebSocketPingInterval').value) : 0;
+ if (webSocketPingInterval > 0 && !this._webSocketPingSetInterval) {
+ this._webSocketPingSetInterval = setInterval(() => {
+ if (this._isWebSocketOpen()) {
+ this._wsConnection.ping((): void => { });
+ }
+ }, webSocketPingInterval * 1000);
+ logger.info(this._logPrefix() + ' WebSocket ping started every ' + Utils.secondsToHHMMSS(webSocketPingInterval));
+ } else if (this._webSocketPingSetInterval) {
+ logger.info(this._logPrefix() + ' WebSocket ping every ' + Utils.secondsToHHMMSS(webSocketPingInterval) + ' already started');
+ } else {
+ logger.error(`${this._logPrefix()} WebSocket ping interval set to ${webSocketPingInterval ? Utils.secondsToHHMMSS(webSocketPingInterval) : webSocketPingInterval}, not starting the WebSocket ping`);
+ }
+ }
+
+ _stopWebSocketPing(): void {
+ if (this._webSocketPingSetInterval) {
+ clearInterval(this._webSocketPingSetInterval);
+ this._webSocketPingSetInterval = null;
+ }
+ }
+
+ _restartWebSocketPing(): void {
+ // Stop WebSocket ping
+ this._stopWebSocketPing();
+ // Start WebSocket ping
+ this._startWebSocketPing();
+ }
+
_startHeartbeat(): void {
if (this._heartbeatInterval && this._heartbeatInterval > 0 && !this._heartbeatSetInterval) {
- this._heartbeatSetInterval = setInterval(() => {
- this.sendHeartbeat();
+ this._heartbeatSetInterval = setInterval(async () => {
+ await this.sendHeartbeat();
}, this._heartbeatInterval);
logger.info(this._logPrefix() + ' Heartbeat started every ' + Utils.milliSecondsToHHMMSS(this._heartbeatInterval));
+ } else if (this._heartbeatSetInterval) {
+ logger.info(this._logPrefix() + ' Heartbeat every ' + Utils.milliSecondsToHHMMSS(this._heartbeatInterval) + ' already started');
} else {
- logger.error(`${this._logPrefix()} Heartbeat interval set to ${Utils.milliSecondsToHHMMSS(this._heartbeatInterval)}, not starting the heartbeat`);
+ logger.error(`${this._logPrefix()} Heartbeat interval set to ${this._heartbeatInterval ? Utils.milliSecondsToHHMMSS(this._heartbeatInterval) : this._heartbeatInterval}, not starting the heartbeat`);
}
}
}
}
+ _restartHeartbeat(): void {
+ // Stop heartbeat
+ this._stopHeartbeat();
+ // Start heartbeat
+ this._startHeartbeat();
+ }
+
_startAuthorizationFileMonitoring(): void {
// eslint-disable-next-line @typescript-eslint/no-unused-vars
fs.watchFile(this._getAuthorizationFile(), (current, previous) => {
this._automaticTransactionGeneration) {
this._automaticTransactionGeneration.stop().catch(() => { });
}
+ // FIXME?: restart heartbeat and WebSocket ping when their interval values have changed
} catch (error) {
logger.error(this._logPrefix() + ' Charging station template file monitoring error: %j', error);
}
}
}
- start(): void {
- if (!this._wsConnectionUrl) {
- this._wsConnectionUrl = this._supervisionUrl + '/' + this._stationInfo.name;
+ _openWSConnection(options?: WebSocket.ClientOptions, forceCloseOpened = false): void {
+ if (Utils.isUndefined(options)) {
+ options = {} as WebSocket.ClientOptions;
}
- this._wsConnection = new WebSocket(this._wsConnectionUrl, 'ocpp' + Constants.OCPP_VERSION_16);
+ if (Utils.isUndefined(options.handshakeTimeout)) {
+ options.handshakeTimeout = this._getConnectionTimeout() * 1000;
+ }
+ if (this._isWebSocketOpen() && forceCloseOpened) {
+ this._wsConnection.close();
+ }
+ this._wsConnection = new WebSocket(this._wsConnectionUrl, 'ocpp' + Constants.OCPP_VERSION_16, options);
logger.info(this._logPrefix() + ' Will communicate through URL ' + this._supervisionUrl);
+ }
+
+ start(): void {
+ this._openWSConnection();
// Monitor authorization file
this._startAuthorizationFileMonitoring();
// Monitor station template file
this._wsConnection.on('open', this.onOpen.bind(this));
// Handle Socket ping
this._wsConnection.on('ping', this.onPing.bind(this));
+ // Handle Socket pong
+ this._wsConnection.on('pong', this.onPong.bind(this));
}
async stop(reason: StopTransactionReason = StopTransactionReason.NONE): Promise<void> {
- // Stop
+ // Stop message sequence
await this._stopMessageSequence(reason);
- // eslint-disable-next-line guard-for-in
for (const connector in this._connectors) {
- await this.sendStatusNotification(Utils.convertToInt(connector), ChargePointStatus.UNAVAILABLE);
+ if (Utils.convertToInt(connector) > 0) {
+ await this.sendStatusNotification(Utils.convertToInt(connector), ChargePointStatus.UNAVAILABLE);
+ }
}
- if (this._wsConnection && this._wsConnection.readyState === WebSocket.OPEN) {
+ if (this._isWebSocketOpen()) {
this._wsConnection.close();
}
+ this._bootNotificationResponse = null;
this._hasStopped = true;
}
- _reconnect(error): void {
- logger.error(this._logPrefix() + ' Socket: abnormally closed %j', error);
+ async _reconnect(error): Promise<void> {
+ // Stop heartbeat
+ this._stopHeartbeat();
// Stop the ATG if needed
if (this._stationInfo.AutomaticTransactionGenerator.enable &&
this._stationInfo.AutomaticTransactionGenerator.stopOnConnectionFailure &&
!this._automaticTransactionGeneration.timeToStop) {
this._automaticTransactionGeneration.stop().catch(() => { });
}
- // Stop heartbeat
- this._stopHeartbeat();
- if (this._autoReconnectTimeout !== 0 &&
- (this._autoReconnectRetryCount < this._autoReconnectMaxRetries || this._autoReconnectMaxRetries === -1)) {
- logger.error(`${this._logPrefix()} Socket: connection retry with timeout ${this._autoReconnectTimeout}ms`);
+ if (this._autoReconnectRetryCount < this._getAutoReconnectMaxRetries() || this._getAutoReconnectMaxRetries() === -1) {
this._autoReconnectRetryCount++;
- setTimeout(() => {
- logger.error(this._logPrefix() + ' Socket: reconnecting try #' + this._autoReconnectRetryCount.toString());
- this.start();
- }, this._autoReconnectTimeout);
- } else if (this._autoReconnectTimeout !== 0 || this._autoReconnectMaxRetries !== -1) {
- logger.error(`${this._logPrefix()} Socket: max retries reached (${this._autoReconnectRetryCount}) or retry disabled (${this._autoReconnectTimeout})`);
+ const reconnectDelay = (this._getReconnectExponentialDelay() ? Utils.exponentialDelay(this._autoReconnectRetryCount) : this._getConnectionTimeout() * 1000);
+ logger.error(`${this._logPrefix()} Socket: connection retry in ${Utils.roundTo(reconnectDelay, 2)}ms, timeout ${reconnectDelay - 100}ms`);
+ await Utils.sleep(reconnectDelay);
+ logger.error(this._logPrefix() + ' Socket: reconnecting try #' + this._autoReconnectRetryCount.toString());
+ this._openWSConnection({ handshakeTimeout: reconnectDelay - 100 });
+ this._hasSocketRestarted = true;
+ } else if (this._getAutoReconnectMaxRetries() !== -1) {
+ logger.error(`${this._logPrefix()} Socket reconnect failure: max retries reached (${this._autoReconnectRetryCount}) or retry disabled (${this._getAutoReconnectMaxRetries()})`);
}
}
- onOpen(): void {
+ async onOpen(): Promise<void> {
logger.info(`${this._logPrefix()} Is connected to server through ${this._wsConnectionUrl}`);
- if (!this._hasSocketRestarted) {
+ if (!this._isRegistered()) {
// Send BootNotification
- this.sendBootNotification();
+ let registrationRetryCount = 0;
+ do {
+ this._bootNotificationResponse = await this.sendBootNotification();
+ if (!this._isRegistered()) {
+ registrationRetryCount++;
+ await Utils.sleep(this._bootNotificationResponse.interval * 1000);
+ }
+ } while (!this._isRegistered() && (registrationRetryCount <= this._getRegistrationMaxRetries() || this._getRegistrationMaxRetries() === -1));
}
- if (this._hasSocketRestarted) {
- this._startMessageSequence();
- if (!Utils.isEmptyArray(this._messageQueue)) {
- this._messageQueue.forEach((message) => {
- if (this._wsConnection && this._wsConnection.readyState === WebSocket.OPEN) {
+ if (this._isRegistered()) {
+ await this._startMessageSequence();
+ if (this._hasSocketRestarted && this._isWebSocketOpen()) {
+ if (!Utils.isEmptyArray(this._messageQueue)) {
+ this._messageQueue.forEach((message, index) => {
+ this._messageQueue.splice(index, 1);
this._wsConnection.send(message);
- }
- });
+ });
+ }
}
+ } else {
+ logger.error(`${this._logPrefix()} Registration failure: max retries reached (${this._getRegistrationMaxRetries()}) or retry disabled (${this._getRegistrationMaxRetries()})`);
}
this._autoReconnectRetryCount = 0;
this._hasSocketRestarted = false;
}
- onError(error): void {
- switch (error) {
- case 'ECONNREFUSED':
- this._hasSocketRestarted = true;
- this._reconnect(error);
- break;
- default:
- logger.error(this._logPrefix() + ' Socket error: %j', error);
- break;
- }
+ async onError(errorEvent): Promise<void> {
+ logger.error(this._logPrefix() + ' Socket error: %j', errorEvent);
+ // pragma switch (errorEvent.code) {
+ // case 'ECONNREFUSED':
+ // await this._reconnect(errorEvent);
+ // break;
+ // }
}
- onClose(error): void {
- switch (error) {
- case 1000: // Normal close
- case 1005:
- logger.info(this._logPrefix() + ' Socket normally closed %j', error);
+ async onClose(closeEvent): Promise<void> {
+ switch (closeEvent) {
+ case WebSocketCloseEventStatusCode.CLOSE_NORMAL: // Normal close
+ case WebSocketCloseEventStatusCode.CLOSE_NO_STATUS:
+ logger.info(`${this._logPrefix()} Socket normally closed with status '${Utils.getWebSocketCloseEventStatusString(closeEvent)}'`);
this._autoReconnectRetryCount = 0;
break;
default: // Abnormal close
- this._hasSocketRestarted = true;
- this._reconnect(error);
+ logger.error(`${this._logPrefix()} Socket abnormally closed with status '${Utils.getWebSocketCloseEventStatusString(closeEvent)}'`);
+ await this._reconnect(closeEvent);
break;
}
}
logger.debug(this._logPrefix() + ' Has received a WS ping (rfc6455) from the server');
}
- async onMessage(message): Promise<void> {
- let [messageType, messageId, commandName, commandPayload, errorDetails] = [0, '', Constants.ENTITY_CHARGING_STATION, '', ''];
+ onPong(): void {
+ logger.debug(this._logPrefix() + ' Has received a WS pong (rfc6455) from the server');
+ }
+
+ async onMessage(messageEvent: MessageEvent): Promise<void> {
+ let [messageType, messageId, commandName, commandPayload, errorDetails]: IncomingRequest = [0, '', '' as IncomingRequestCommand, '', ''];
+ let responseCallback: (payload?, requestPayload?) => void;
+ let rejectCallback: (error: OCPPError) => void;
+ let requestPayload: Record<string, unknown>;
+ let errMsg: string;
try {
// Parse the message
- [messageType, messageId, commandName, commandPayload, errorDetails] = JSON.parse(message);
+ [messageType, messageId, commandName, commandPayload, errorDetails] = JSON.parse(messageEvent.toString()) as IncomingRequest;
// Check the Type of message
switch (messageType) {
// Incoming Message
- case Constants.OCPP_JSON_CALL_MESSAGE:
+ case MessageType.CALL_MESSAGE:
if (this.getEnableStatistics()) {
this._statistics.addMessage(commandName, messageType);
}
await this.handleRequest(messageId, commandName, commandPayload);
break;
// Outcome Message
- case Constants.OCPP_JSON_CALL_RESULT_MESSAGE:
+ case MessageType.CALL_RESULT_MESSAGE:
// Respond
- // eslint-disable-next-line no-case-declarations
- let responseCallback; let requestPayload;
if (Utils.isIterable(this._requests[messageId])) {
[responseCallback, , requestPayload] = this._requests[messageId];
} else {
responseCallback(commandName, requestPayload);
break;
// Error Message
- case Constants.OCPP_JSON_CALL_ERROR_MESSAGE:
+ case MessageType.CALL_ERROR_MESSAGE:
if (!this._requests[messageId]) {
// Error
throw new Error(`Error request for unknown message id ${messageId}`);
}
- // eslint-disable-next-line no-case-declarations
- let rejectCallback;
if (Utils.isIterable(this._requests[messageId])) {
[, rejectCallback] = this._requests[messageId];
} else {
break;
// Error
default:
- // eslint-disable-next-line no-case-declarations
- const errMsg = `${this._logPrefix()} Wrong message type ${messageType}`;
+ errMsg = `${this._logPrefix()} Wrong message type ${messageType}`;
logger.error(errMsg);
throw new Error(errMsg);
}
} catch (error) {
// Log
- logger.error('%s Incoming message %j processing error %s on request content type %s', this._logPrefix(), message, error, this._requests[messageId]);
+ logger.error('%s Incoming message %j processing error %j on request content type %j', this._logPrefix(), messageEvent, error, this._requests[messageId]);
// Send error
- await this.sendError(messageId, error, commandName);
+ messageType !== MessageType.CALL_ERROR_MESSAGE && await this.sendError(messageId, error, commandName);
}
}
async sendHeartbeat(): Promise<void> {
try {
- const payload = {
- currentTime: new Date().toISOString(),
- };
- await this.sendMessage(Utils.generateUUID(), payload, Constants.OCPP_JSON_CALL_MESSAGE, 'Heartbeat');
+ const payload: HeartbeatRequest = {};
+ await this.sendMessage(Utils.generateUUID(), payload, MessageType.CALL_MESSAGE, RequestCommand.HEARTBEAT);
} catch (error) {
- logger.error(this._logPrefix() + ' Send Heartbeat error: %j', error);
- throw error;
+ this.handleRequestError(RequestCommand.HEARTBEAT, error);
}
}
- async sendBootNotification(): Promise<void> {
+ async sendBootNotification(): Promise<BootNotificationResponse> {
try {
- await this.sendMessage(Utils.generateUUID(), this._bootNotificationMessage, Constants.OCPP_JSON_CALL_MESSAGE, 'BootNotification');
+ return await this.sendMessage(Utils.generateUUID(), this._bootNotificationRequest, MessageType.CALL_MESSAGE, RequestCommand.BOOT_NOTIFICATION) as BootNotificationResponse;
} catch (error) {
- logger.error(this._logPrefix() + ' Send BootNotification error: %j', error);
- throw error;
+ this.handleRequestError(RequestCommand.BOOT_NOTIFICATION, error);
}
}
async sendStatusNotification(connectorId: number, status: ChargePointStatus, errorCode: ChargePointErrorCode = ChargePointErrorCode.NO_ERROR): Promise<void> {
this.getConnector(connectorId).status = status;
try {
- const payload = {
+ const payload: StatusNotificationRequest = {
connectorId,
errorCode,
status,
};
- await this.sendMessage(Utils.generateUUID(), payload, Constants.OCPP_JSON_CALL_MESSAGE, 'StatusNotification');
+ await this.sendMessage(Utils.generateUUID(), payload, MessageType.CALL_MESSAGE, RequestCommand.STATUS_NOTIFICATION);
} catch (error) {
- logger.error(this._logPrefix() + ' Send StatusNotification error: %j', error);
- throw error;
+ this.handleRequestError(RequestCommand.STATUS_NOTIFICATION, error);
}
}
async sendStartTransaction(connectorId: number, idTag?: string): Promise<StartTransactionResponse> {
try {
- const payload = {
+ const payload: StartTransactionRequest = {
connectorId,
...!Utils.isUndefined(idTag) ? { idTag } : { idTag: Constants.TRANSACTION_DEFAULT_IDTAG },
meterStart: 0,
timestamp: new Date().toISOString(),
};
- return await this.sendMessage(Utils.generateUUID(), payload, Constants.OCPP_JSON_CALL_MESSAGE, 'StartTransaction') as StartTransactionResponse;
+ return await this.sendMessage(Utils.generateUUID(), payload, MessageType.CALL_MESSAGE, RequestCommand.START_TRANSACTION) as StartTransactionResponse;
} catch (error) {
- logger.error(this._logPrefix() + ' Send StartTransaction error: %j', error);
- throw error;
+ this.handleRequestError(RequestCommand.START_TRANSACTION, error);
}
}
async sendStopTransaction(transactionId: number, reason: StopTransactionReason = StopTransactionReason.NONE): Promise<StopTransactionResponse> {
- const idTag = this._getTransactionidTag(transactionId);
+ const idTag = this._getTransactionIdTag(transactionId);
try {
- const payload = {
+ const payload: StopTransactionRequest = {
transactionId,
...!Utils.isUndefined(idTag) && { idTag: idTag },
- meterStop: 0,
+ meterStop: this._getTransactionMeterStop(transactionId),
timestamp: new Date().toISOString(),
...reason && { reason },
};
- return await this.sendMessage(Utils.generateUUID(), payload, Constants.OCPP_JSON_CALL_MESSAGE, 'StopTransaction') as StartTransactionResponse;
+ return await this.sendMessage(Utils.generateUUID(), payload, MessageType.CALL_MESSAGE, RequestCommand.STOP_TRANSACTION) as StartTransactionResponse;
} catch (error) {
- logger.error(this._logPrefix() + ' Send StopTransaction error: %j', error);
- throw error;
+ this.handleRequestError(RequestCommand.STOP_TRANSACTION, error);
}
}
// eslint-disable-next-line consistent-this
async sendMeterValues(connectorId: number, interval: number, self: ChargingStation, debug = false): Promise<void> {
try {
- const sampledValues: {
- timestamp: string;
- sampledValue: MeterValue[];
- } = {
+ const meterValue: MeterValue = {
timestamp: new Date().toISOString(),
sampledValue: [],
};
- const meterValuesTemplate = self.getConnector(connectorId).MeterValues;
+ const meterValuesTemplate: SampledValue[] = self.getConnector(connectorId).MeterValues;
for (let index = 0; index < meterValuesTemplate.length; index++) {
const connector = self.getConnector(connectorId);
// SoC measurand
if (meterValuesTemplate[index].measurand && meterValuesTemplate[index].measurand === MeterValueMeasurand.STATE_OF_CHARGE && self._getConfigurationKey('MeterValuesSampledData').value.includes(MeterValueMeasurand.STATE_OF_CHARGE)) {
- sampledValues.sampledValue.push({
+ meterValue.sampledValue.push({
...!Utils.isUndefined(meterValuesTemplate[index].unit) ? { unit: meterValuesTemplate[index].unit } : { unit: MeterValueUnit.PERCENT },
...!Utils.isUndefined(meterValuesTemplate[index].context) && { context: meterValuesTemplate[index].context },
measurand: meterValuesTemplate[index].measurand,
...!Utils.isUndefined(meterValuesTemplate[index].location) ? { location: meterValuesTemplate[index].location } : { location: MeterValueLocation.EV },
...!Utils.isUndefined(meterValuesTemplate[index].value) ? { value: meterValuesTemplate[index].value } : { value: Utils.getRandomInt(100).toString() },
});
- const sampledValuesIndex = sampledValues.sampledValue.length - 1;
- if (Utils.convertToInt(sampledValues.sampledValue[sampledValuesIndex].value) > 100 || debug) {
- logger.error(`${self._logPrefix()} MeterValues measurand ${sampledValues.sampledValue[sampledValuesIndex].measurand ? sampledValues.sampledValue[sampledValuesIndex].measurand : MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER}: connectorId ${connectorId}, transaction ${connector.transactionId}, value: ${sampledValues.sampledValue[sampledValuesIndex].value}/100`);
+ const sampledValuesIndex = meterValue.sampledValue.length - 1;
+ if (Utils.convertToInt(meterValue.sampledValue[sampledValuesIndex].value) > 100 || debug) {
+ logger.error(`${self._logPrefix()} MeterValues measurand ${meterValue.sampledValue[sampledValuesIndex].measurand ? meterValue.sampledValue[sampledValuesIndex].measurand : MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER}: connectorId ${connectorId}, transaction ${connector.transactionId}, value: ${meterValue.sampledValue[sampledValuesIndex].value}/100`);
}
// Voltage measurand
} else if (meterValuesTemplate[index].measurand && meterValuesTemplate[index].measurand === MeterValueMeasurand.VOLTAGE && self._getConfigurationKey('MeterValuesSampledData').value.includes(MeterValueMeasurand.VOLTAGE)) {
const voltageMeasurandValue = Utils.getRandomFloatRounded(self._getVoltageOut() + self._getVoltageOut() * 0.1, self._getVoltageOut() - self._getVoltageOut() * 0.1);
- sampledValues.sampledValue.push({
+ meterValue.sampledValue.push({
...!Utils.isUndefined(meterValuesTemplate[index].unit) ? { unit: meterValuesTemplate[index].unit } : { unit: MeterValueUnit.VOLT },
...!Utils.isUndefined(meterValuesTemplate[index].context) && { context: meterValuesTemplate[index].context },
measurand: meterValuesTemplate[index].measurand,
...!Utils.isUndefined(meterValuesTemplate[index].value) ? { value: meterValuesTemplate[index].value } : { value: voltageMeasurandValue.toString() },
});
for (let phase = 1; self._getNumberOfPhases() === 3 && phase <= self._getNumberOfPhases(); phase++) {
- const voltageValue = Utils.convertToFloat(sampledValues.sampledValue[sampledValues.sampledValue.length - 1].value);
let phaseValue: string;
- if (voltageValue >= 0 && voltageValue <= 250) {
+ if (self._getVoltageOut() >= 0 && self._getVoltageOut() <= 250) {
phaseValue = `L${phase}-N`;
- } else if (voltageValue > 250) {
+ } else if (self._getVoltageOut() > 250) {
phaseValue = `L${phase}-L${(phase + 1) % self._getNumberOfPhases() !== 0 ? (phase + 1) % self._getNumberOfPhases() : self._getNumberOfPhases()}`;
}
- sampledValues.sampledValue.push({
+ meterValue.sampledValue.push({
...!Utils.isUndefined(meterValuesTemplate[index].unit) ? { unit: meterValuesTemplate[index].unit } : { unit: MeterValueUnit.VOLT },
...!Utils.isUndefined(meterValuesTemplate[index].context) && { context: meterValuesTemplate[index].context },
measurand: meterValuesTemplate[index].measurand,
logger.error(errMsg);
throw Error(errMsg);
}
- sampledValues.sampledValue.push({
+ meterValue.sampledValue.push({
...!Utils.isUndefined(meterValuesTemplate[index].unit) ? { unit: meterValuesTemplate[index].unit } : { unit: MeterValueUnit.WATT },
...!Utils.isUndefined(meterValuesTemplate[index].context) && { context: meterValuesTemplate[index].context },
measurand: meterValuesTemplate[index].measurand,
...!Utils.isUndefined(meterValuesTemplate[index].location) && { location: meterValuesTemplate[index].location },
...!Utils.isUndefined(meterValuesTemplate[index].value) ? { value: meterValuesTemplate[index].value } : { value: powerMeasurandValues.allPhases.toString() },
});
- const sampledValuesIndex = sampledValues.sampledValue.length - 1;
- if (Utils.convertToFloat(sampledValues.sampledValue[sampledValuesIndex].value) > maxPower || debug) {
- logger.error(`${self._logPrefix()} MeterValues measurand ${sampledValues.sampledValue[sampledValuesIndex].measurand ? sampledValues.sampledValue[sampledValuesIndex].measurand : MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER}: connectorId ${connectorId}, transaction ${connector.transactionId}, value: ${sampledValues.sampledValue[sampledValuesIndex].value}/${maxPower}`);
+ const sampledValuesIndex = meterValue.sampledValue.length - 1;
+ if (Utils.convertToFloat(meterValue.sampledValue[sampledValuesIndex].value) > maxPower || debug) {
+ logger.error(`${self._logPrefix()} MeterValues measurand ${meterValue.sampledValue[sampledValuesIndex].measurand ? meterValue.sampledValue[sampledValuesIndex].measurand : MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER}: connectorId ${connectorId}, transaction ${connector.transactionId}, value: ${meterValue.sampledValue[sampledValuesIndex].value}/${maxPower}`);
}
for (let phase = 1; self._getNumberOfPhases() === 3 && phase <= self._getNumberOfPhases(); phase++) {
const phaseValue = `L${phase}-N`;
- sampledValues.sampledValue.push({
+ meterValue.sampledValue.push({
...!Utils.isUndefined(meterValuesTemplate[index].unit) ? { unit: meterValuesTemplate[index].unit } : { unit: MeterValueUnit.WATT },
...!Utils.isUndefined(meterValuesTemplate[index].context) && { context: meterValuesTemplate[index].context },
...!Utils.isUndefined(meterValuesTemplate[index].measurand) && { measurand: meterValuesTemplate[index].measurand },
logger.error(errMsg);
throw Error(errMsg);
}
- sampledValues.sampledValue.push({
+ meterValue.sampledValue.push({
...!Utils.isUndefined(meterValuesTemplate[index].unit) ? { unit: meterValuesTemplate[index].unit } : { unit: MeterValueUnit.AMP },
...!Utils.isUndefined(meterValuesTemplate[index].context) && { context: meterValuesTemplate[index].context },
measurand: meterValuesTemplate[index].measurand,
...!Utils.isUndefined(meterValuesTemplate[index].location) && { location: meterValuesTemplate[index].location },
...!Utils.isUndefined(meterValuesTemplate[index].value) ? { value: meterValuesTemplate[index].value } : { value: currentMeasurandValues.allPhases.toString() },
});
- const sampledValuesIndex = sampledValues.sampledValue.length - 1;
- if (Utils.convertToFloat(sampledValues.sampledValue[sampledValuesIndex].value) > maxAmperage || debug) {
- logger.error(`${self._logPrefix()} MeterValues measurand ${sampledValues.sampledValue[sampledValuesIndex].measurand ? sampledValues.sampledValue[sampledValuesIndex].measurand : MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER}: connectorId ${connectorId}, transaction ${connector.transactionId}, value: ${sampledValues.sampledValue[sampledValuesIndex].value}/${maxAmperage}`);
+ const sampledValuesIndex = meterValue.sampledValue.length - 1;
+ if (Utils.convertToFloat(meterValue.sampledValue[sampledValuesIndex].value) > maxAmperage || debug) {
+ logger.error(`${self._logPrefix()} MeterValues measurand ${meterValue.sampledValue[sampledValuesIndex].measurand ? meterValue.sampledValue[sampledValuesIndex].measurand : MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER}: connectorId ${connectorId}, transaction ${connector.transactionId}, value: ${meterValue.sampledValue[sampledValuesIndex].value}/${maxAmperage}`);
}
for (let phase = 1; self._getNumberOfPhases() === 3 && phase <= self._getNumberOfPhases(); phase++) {
const phaseValue = `L${phase}`;
- sampledValues.sampledValue.push({
+ meterValue.sampledValue.push({
...!Utils.isUndefined(meterValuesTemplate[index].unit) ? { unit: meterValuesTemplate[index].unit } : { unit: MeterValueUnit.AMP },
...!Utils.isUndefined(meterValuesTemplate[index].context) && { context: meterValuesTemplate[index].context },
...!Utils.isUndefined(meterValuesTemplate[index].measurand) && { measurand: meterValuesTemplate[index].measurand },
connector.lastEnergyActiveImportRegisterValue = 0;
}
}
- sampledValues.sampledValue.push({
+ meterValue.sampledValue.push({
...!Utils.isUndefined(meterValuesTemplate[index].unit) ? { unit: meterValuesTemplate[index].unit } : { unit: MeterValueUnit.WATT_HOUR },
...!Utils.isUndefined(meterValuesTemplate[index].context) && { context: meterValuesTemplate[index].context },
...!Utils.isUndefined(meterValuesTemplate[index].measurand) && { measurand: meterValuesTemplate[index].measurand },
...!Utils.isUndefined(meterValuesTemplate[index].value) ? { value: meterValuesTemplate[index].value } :
{ value: connector.lastEnergyActiveImportRegisterValue.toString() },
});
- const sampledValuesIndex = sampledValues.sampledValue.length - 1;
+ const sampledValuesIndex = meterValue.sampledValue.length - 1;
const maxConsumption = Math.round(self._stationInfo.maxPower * 3600 / (self._stationInfo.powerDivider * interval));
- if (Utils.convertToFloat(sampledValues.sampledValue[sampledValuesIndex].value) > maxConsumption || debug) {
- logger.error(`${self._logPrefix()} MeterValues measurand ${sampledValues.sampledValue[sampledValuesIndex].measurand ? sampledValues.sampledValue[sampledValuesIndex].measurand : MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER}: connectorId ${connectorId}, transaction ${connector.transactionId}, value: ${sampledValues.sampledValue[sampledValuesIndex].value}/${maxConsumption}`);
+ if (Utils.convertToFloat(meterValue.sampledValue[sampledValuesIndex].value) > maxConsumption || debug) {
+ logger.error(`${self._logPrefix()} MeterValues measurand ${meterValue.sampledValue[sampledValuesIndex].measurand ? meterValue.sampledValue[sampledValuesIndex].measurand : MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER}: connectorId ${connectorId}, transaction ${connector.transactionId}, value: ${meterValue.sampledValue[sampledValuesIndex].value}/${maxConsumption}`);
}
// Unsupported measurand
} else {
logger.info(`${self._logPrefix()} Unsupported MeterValues measurand ${meterValuesTemplate[index].measurand ? meterValuesTemplate[index].measurand : MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER} on connectorId ${connectorId}`);
}
}
-
- const payload = {
+ const payload: MeterValuesRequest = {
connectorId,
transactionId: self.getConnector(connectorId).transactionId,
- meterValue: sampledValues,
+ meterValue: meterValue,
};
- await self.sendMessage(Utils.generateUUID(), payload, Constants.OCPP_JSON_CALL_MESSAGE, 'MeterValues');
+ await self.sendMessage(Utils.generateUUID(), payload, MessageType.CALL_MESSAGE, RequestCommand.METERVALUES);
} catch (error) {
- logger.error(self._logPrefix() + ' Send MeterValues error: %j', error);
- throw error;
+ this.handleRequestError(RequestCommand.METERVALUES, error);
}
}
- async sendError(messageId: string, err: Error | OCPPError, commandName: string): Promise<unknown> {
+ async sendError(messageId: string, err: Error | OCPPError, commandName: RequestCommand | IncomingRequestCommand): Promise<unknown> {
// Check exception type: only OCPP error are accepted
- const error = err instanceof OCPPError ? err : new OCPPError(Constants.OCPP_ERROR_INTERNAL_ERROR, err.message, err.stack && err.stack);
+ const error = err instanceof OCPPError ? err : new OCPPError(ErrorType.INTERNAL_ERROR, err.message, err.stack && err.stack);
// Send error
- return this.sendMessage(messageId, error, Constants.OCPP_JSON_CALL_ERROR_MESSAGE, commandName);
+ return this.sendMessage(messageId, error, MessageType.CALL_ERROR_MESSAGE, commandName);
}
- async sendMessage(messageId: string, commandParams, messageType =
Constants.OCPP_JSON_CALL_RESULT_MESSAGE, commandName: string): Promise<any> {
+ async sendMessage(messageId: string, commandParams, messageType =
MessageType.CALL_RESULT_MESSAGE, commandName: RequestCommand | IncomingRequestCommand): Promise<any> {
// eslint-disable-next-line @typescript-eslint/no-this-alias
const self = this;
// Send a message through wsConnection
- return new Promise((resolve, reject) => {
- let messageToSend;
+ return new Promise((resolve: (value?: any | PromiseLike<any>) => void, reject: (reason?: any) => void) => {
+ let messageToSend: string;
// Type of message
switch (messageType) {
// Request
- case Constants.OCPP_JSON_CALL_MESSAGE:
+ case MessageType.CALL_MESSAGE:
// Build request
- this._requests[messageId] = [responseCallback, rejectCallback, commandParams];
+ this._requests[messageId] = [responseCallback, rejectCallback, commandParams] as Request;
messageToSend = JSON.stringify([messageType, messageId, commandName, commandParams]);
break;
// Response
- case Constants.OCPP_JSON_CALL_RESULT_MESSAGE:
+ case MessageType.CALL_RESULT_MESSAGE:
// Build response
messageToSend = JSON.stringify([messageType, messageId, commandParams]);
break;
// Error Message
- case Constants.OCPP_JSON_CALL_ERROR_MESSAGE:
+ case MessageType.CALL_ERROR_MESSAGE:
// Build Error Message
- messageToSend = JSON.stringify([messageType, messageId, commandParams.code ? commandParams.code : Constants.OCPP_ERROR_GENERIC_ERROR, commandParams.message ? commandParams.message : '', commandParams.details ? commandParams.details : {}]);
+ messageToSend = JSON.stringify([messageType, messageId, commandParams.code ? commandParams.code : ErrorType.GENERIC_ERROR, commandParams.message ? commandParams.message : '', commandParams.details ? commandParams.details : {}]);
break;
}
- // Check if wsConnection is ready
- if (this._wsConnection && this._wsConnection.readyState === WebSocket.OPEN) {
+ // Check if wsConnection opened and charging station registered
+ if (this._isWebSocketOpen() && (this._isRegistered() || commandName === RequestCommand.BOOT_NOTIFICATION)) {
if (this.getEnableStatistics()) {
this._statistics.addMessage(commandName, messageType);
}
// Handle dups in buffer
for (const message of this._messageQueue) {
// Same message
- if (JSON.stringify(messageToSend) === JSON.stringify(message)) {
+ if (messageToSend === message) {
dups = true;
break;
}
this._messageQueue.push(messageToSend);
}
// Reject it
- return rejectCallback(new OCPPError(commandParams.code ? commandParams.code : Constants.OCPP_ERROR_GENERIC_ERROR, commandParams.message ? commandParams.message : `Web socket closed for message id '${messageId}' with content '${messageToSend}', message buffered`, commandParams.details ? commandParams.details : {}));
+ return rejectCallback(new OCPPError(commandParams.code ? commandParams.code : ErrorType.GENERIC_ERROR, commandParams.message ? commandParams.message : `WebSocket closed for message id '${messageId}' with content '${messageToSend}', message buffered`, commandParams.details ? commandParams.details : {}));
}
// Response?
- if (messageType === Constants.OCPP_JSON_CALL_RESULT_MESSAGE) {
+ if (messageType === MessageType.CALL_RESULT_MESSAGE) {
// Yes: send Ok
resolve();
- } else if (messageType === Constants.OCPP_JSON_CALL_ERROR_MESSAGE) {
+ } else if (messageType === MessageType.CALL_ERROR_MESSAGE) {
// Send timeout
- setTimeout(() => rejectCallback(new OCPPError(commandParams.code ? commandParams.code : Constants.OCPP_ERROR_GENERIC_ERROR, commandParams.message ? commandParams.message : `Timeout for message id '${messageId}' with content '${messageToSend}'`, commandParams.details ? commandParams.details : {})), Constants.OCPP_SOCKET_TIMEOUT);
+ setTimeout(() => rejectCallback(new OCPPError(commandParams.code ? commandParams.code : ErrorType.GENERIC_ERROR, commandParams.message ? commandParams.message : `Timeout for message id '${messageId}' with content '${messageToSend}'`, commandParams.details ? commandParams.details : {})), Constants.OCPP_ERROR_TIMEOUT);
}
// Function that will receive the request's response
- function responseCallback(payload, requestPayload): void {
+ async function responseCallback(payload, requestPayload): Promise<void> {
if (self.getEnableStatistics()) {
self._statistics.addMessage(commandName, messageType);
}
// Send the response
- self.handleResponse(commandName, payload, requestPayload);
+ await self.handleResponse(commandName as RequestCommand, payload, requestPayload);
resolve(payload);
}
if (self.getEnableStatistics()) {
self._statistics.addMessage(commandName, messageType);
}
- logger.debug(`${self._logPrefix()} Error %j occurred when calling command %s with parameters %j`, error, commandName, commandParams);
+ logger.debug(`${self._logPrefix()} Error: %j occurred when calling command %s with parameters: %j`, error, commandName, commandParams);
// Build Exception
// eslint-disable-next-line no-empty-function
self._requests[messageId] = [() => { }, () => { }, {}]; // Properly format the request
});
}
- handleResponse(commandName: string, payload, requestPayload): void {
+ async handleResponse(commandName: RequestCommand, payload, requestPayload): Promise<void> {
const responseCallbackFn = 'handleResponse' + commandName;
if (typeof this[responseCallbackFn] === 'function') {
- this[responseCallbackFn](payload, requestPayload);
+ await this[responseCallbackFn](payload, requestPayload);
} else {
logger.error(this._logPrefix() + ' Trying to call an undefined response callback function: ' + responseCallbackFn);
}
}
- handleResponseBootNotification(payload, requestPayload): void {
- if (payload.status === 'Accepted') {
+ handleResponseBootNotification(payload: BootNotificationResponse, requestPayload: BootNotificationRequest): void {
+ if (payload.status === RegistrationStatus.ACCEPTED) {
this._heartbeatInterval = payload.interval * 1000;
- this._addConfigurationKey('HeartBeatInterval', payload.interval);
- this._addConfigurationKey('HeartbeatInterval', payload.interval, false, false);
- this._startMessageSequence();
+ this._heartbeatSetInterval ? this._restartHeartbeat() : this._startHeartbeat();
+ this._addConfigurationKey('HeartBeatInterval', payload.interval.toString());
+ this._addConfigurationKey('HeartbeatInterval', payload.interval.toString(), false, false);
this._hasStopped && (this._hasStopped = false);
- } else if (payload.status === 'Pending') {
+ } else if (payload.status === RegistrationStatus.PENDING) {
logger.info(this._logPrefix() + ' Charging station in pending state on the central server');
} else {
logger.info(this._logPrefix() + ' Charging station rejected by the central server');
}
}
- handleResponseStartTransaction(payload: StartTransactionResponse, requestPayload): void {
- const connectorId = Utils.convertToInt(requestPayload.connectorId);
+ async handleResponseStartTransaction(payload: StartTransactionResponse, requestPayload: StartTransactionRequest): Promise<void> {
+ const connectorId = requestPayload.connectorId;
if (this.getConnector(connectorId).transactionStarted) {
- logger.debug(this._logPrefix() + ' Try to start a transaction on an already used connector ' + connectorId.toString() + ': %j', this.getConnector(connectorId));
+ logger.debug(this._logPrefix() + ' Trying to start a transaction on an already used connector ' + connectorId.toString() + ': %j', this.getConnector(connectorId));
return;
}
let transactionConnectorId: number;
for (const connector in this._connectors) {
- if (Utils.convertToInt(connector) === connectorId) {
+ if (Utils.convertToInt(connector) > 0 && Utils.convertToInt(connector) === connectorId) {
transactionConnectorId = Utils.convertToInt(connector);
break;
}
}
if (!transactionConnectorId) {
- logger.error(this._logPrefix() + ' Try to start a transaction on a non existing connector Id ' + connectorId.toString());
+ logger.error(this._logPrefix() + ' Trying to start a transaction on a non existing connector Id ' + connectorId.toString());
return;
}
if (payload.idTagInfo?.status === AuthorizationStatus.ACCEPTED) {
this.getConnector(connectorId).transactionId = payload.transactionId;
this.getConnector(connectorId).idTag = requestPayload.idTag;
this.getConnector(connectorId).lastEnergyActiveImportRegisterValue = 0;
- this.sendStatusNotification(connectorId, ChargePointStatus.CHARGING).catch(() => { });
+ await this.sendStatusNotification(connectorId, ChargePointStatus.CHARGING);
logger.info(this._logPrefix() + ' Transaction ' + payload.transactionId.toString() + ' STARTED on ' + this._stationInfo.name + '#' + connectorId.toString() + ' for idTag ' + requestPayload.idTag);
if (this._stationInfo.powerSharedByConnectors) {
this._stationInfo.powerDivider++;
this._startMeterValues(connectorId,
configuredMeterValueSampleInterval ? Utils.convertToInt(configuredMeterValueSampleInterval.value) * 1000 : 60000);
} else {
- logger.error(this._logPrefix() + ' Starting transaction id ' + payload.transactionId.toString() + ' REJECTED with status ' + payload.idTagInfo?.status + ', idTag ' + requestPayload.idTag);
+ logger.error(this._logPrefix() + ' Starting transaction id ' + payload.transactionId.toString() + ' REJECTED with status ' + payload.idTagInfo.status + ', idTag ' + requestPayload.idTag);
this._resetTransactionOnConnector(connectorId);
- this.sendStatusNotification(connectorId, ChargePointStatus.AVAILABLE).catch(() => { });
+ await this.sendStatusNotification(connectorId, ChargePointStatus.AVAILABLE);
}
}
- handleResponseStopTransaction(payload: StopTransactionResponse, requestPayload): void {
+ async handleResponseStopTransaction(payload: StopTransactionResponse, requestPayload: StopTransactionRequest): Promise<void> {
let transactionConnectorId: number;
for (const connector in this._connectors) {
- if (this.getConnector(Utils.convertToInt(connector)).transactionId === Utils.convertToInt(requestPayload.transactionId)) {
+ if (Utils.convertToInt(connector) > 0 && this.getConnector(Utils.convertToInt(connector)).transactionId === requestPayload.transactionId) {
transactionConnectorId = Utils.convertToInt(connector);
break;
}
}
if (!transactionConnectorId) {
- logger.error(this._logPrefix() + ' Try to stop a non existing transaction ' + requestPayload.transactionId);
+ logger.error(this._logPrefix() + ' Trying to stop a non existing transaction ' + requestPayload.transactionId.toString());
return;
}
if (payload.idTagInfo?.status === AuthorizationStatus.ACCEPTED) {
- this.sendStatusNotification(transactionConnectorId, ChargePointStatus.AVAILABLE).catch(() => { });
+ await this.sendStatusNotification(transactionConnectorId, ChargePointStatus.AVAILABLE);
if (this._stationInfo.powerSharedByConnectors) {
this._stationInfo.powerDivider--;
}
- logger.info(this._logPrefix() + ' Transaction ' + requestPayload.transactionId + ' STOPPED on ' + this._stationInfo.name + '#' + transactionConnectorId.toString());
+ logger.info(this._logPrefix() + ' Transaction ' + requestPayload.transactionId.toString() + ' STOPPED on ' + this._stationInfo.name + '#' + transactionConnectorId.toString());
this._resetTransactionOnConnector(transactionConnectorId);
} else {
- logger.error(this._logPrefix() + ' Stopping transaction id ' + requestPayload.transactionId + ' REJECTED with status ' + payload.idTagInfo?.status);
+ logger.error(this._logPrefix() + ' Stopping transaction id ' + requestPayload.transactionId.toString() + ' REJECTED with status ' + payload.idTagInfo?.status);
}
}
- handleResponseStatusNotification(payload, requestPayload): void {
+ handleResponseStatusNotification(payload: StatusNotificationRequest, requestPayload: StatusNotificationResponse): void {
logger.debug(this._logPrefix() + ' Status notification response received: %j to StatusNotification request: %j', payload, requestPayload);
}
- handleResponseMeterValues(payload, requestPayload): void {
+ handleResponseMeterValues(payload: MeterValuesRequest, requestPayload: MeterValuesResponse): void {
logger.debug(this._logPrefix() + ' MeterValues response received: %j to MeterValues request: %j', payload, requestPayload);
}
- handleResponseHeartbeat(payload, requestPayload): void {
+ handleResponseHeartbeat(payload: HeartbeatResponse, requestPayload: HeartbeatRequest): void {
logger.debug(this._logPrefix() + ' Heartbeat response received: %j to Heartbeat request: %j', payload, requestPayload);
}
- async handleRequest(messageId: string, commandName: string, commandPayload): Promise<void> {
+ async handleRequest(messageId: string, commandName: IncomingRequestCommand, commandPayload): Promise<void> {
let response;
// Call
if (typeof this['handleRequest' + commandName] === 'function') {
}
} else {
// Throw exception
- await this.sendError(messageId, new OCPPError(Constants.OCPP_ERROR_NOT_IMPLEMENTED, `${commandName} is not implemented`, {}), commandName);
+ await this.sendError(messageId, new OCPPError(ErrorType.NOT_IMPLEMENTED, `${commandName} is not implemented`, {}), commandName);
throw new Error(`${commandName} is not implemented ${JSON.stringify(commandPayload, null, ' ')}`);
}
// Send response
- await this.sendMessage(messageId, response, Constants.OCPP_JSON_CALL_RESULT_MESSAGE, commandName);
+ await this.sendMessage(messageId, response, MessageType.CALL_RESULT_MESSAGE, commandName);
}
// Simulate charging station restart
- handleRequestReset(commandPayload): DefaultRequestResponse {
+ handleRequestReset(commandPayload: ResetRequest): DefaultResponse {
setImmediate(async () => {
await this.stop(commandPayload.type + 'Reset' as StopTransactionReason);
await Utils.sleep(this._stationInfo.resetTime);
return Constants.OCPP_RESPONSE_ACCEPTED;
}
- async handleRequestUnlockConnector(commandPayload): Promise<UnlockResponse> {
- const connectorId = Utils.convertToInt(commandPayload.connectorId);
+ handleRequestClearCache(): DefaultResponse {
+ return Constants.OCPP_RESPONSE_ACCEPTED;
+ }
+
+ async handleRequestUnlockConnector(commandPayload: UnlockConnectorRequest): Promise<UnlockConnectorResponse> {
+ const connectorId = commandPayload.connectorId;
if (connectorId === 0) {
- logger.error(this._logPrefix() + ' Try to unlock connector ' + connectorId.toString());
+ logger.error(this._logPrefix() + ' Trying to unlock connector ' + connectorId.toString());
return Constants.OCPP_RESPONSE_UNLOCK_NOT_SUPPORTED;
}
if (this.getConnector(connectorId).transactionStarted) {
return Constants.OCPP_RESPONSE_UNLOCKED;
}
- _getConfigurationKey(key: string): ConfigurationKey {
- return this._configuration.configurationKey.find((configElement) => configElement.key === key);
+ _getConfigurationKey(key: string, caseInsensitive = false): ConfigurationKey {
+ return this._configuration.configurationKey.find((configElement) => {
+ if (caseInsensitive) {
+ return configElement.key.toLowerCase() === key.toLowerCase();
+ }
+ return configElement.key === key;
+ });
}
_addConfigurationKey(key: string, value: string, readonly = false, visible = true, reboot = false): void {
}
}
- handleRequestGetConfiguration(commandPayload): { configurationKey: ConfigurationKey[]; unknownKey: string[] } {
+ handleRequestGetConfiguration(commandPayload: GetConfigurationRequest): GetConfigurationResponse {
const configurationKey: ConfigurationKey[] = [];
const unknownKey: string[] = [];
if (Utils.isEmptyArray(commandPayload.key)) {
});
}
} else {
- for (const key of commandPayload.key as string[]) {
+ for (const key of commandPayload.key) {
const keyFound = this._getConfigurationKey(key);
if (keyFound) {
if (Utils.isUndefined(keyFound.visible)) {
};
}
- handleRequestChangeConfiguration(commandPayload): ConfigurationResponse {
- const keyToChange = this._getConfigurationKey(commandPayload.key);
+ handleRequestChangeConfiguration(commandPayload: ChangeConfigurationRequest): ChangeConfigurationResponse {
+ // JSON request fields type sanity check
+ if (!Utils.isString(commandPayload.key)) {
+ logger.error(`${this._logPrefix()} ChangeConfiguration request key field is not a string:`, commandPayload);
+ }
+ if (!Utils.isString(commandPayload.value)) {
+ logger.error(`${this._logPrefix()} ChangeConfiguration request value field is not a string:`, commandPayload);
+ }
+ const keyToChange = this._getConfigurationKey(commandPayload.key, true);
if (!keyToChange) {
return Constants.OCPP_CONFIGURATION_RESPONSE_NOT_SUPPORTED;
} else if (keyToChange && keyToChange.readonly) {
return Constants.OCPP_CONFIGURATION_RESPONSE_REJECTED;
} else if (keyToChange && !keyToChange.readonly) {
const keyIndex = this._configuration.configurationKey.indexOf(keyToChange);
- this._configuration.configurationKey[keyIndex].value = commandPayload.value;
+ let valueChanged = false;
+ if (this._configuration.configurationKey[keyIndex].value !== commandPayload.value) {
+ this._configuration.configurationKey[keyIndex].value = commandPayload.value;
+ valueChanged = true;
+ }
let triggerHeartbeatRestart = false;
- if (keyToChange.key === 'HeartBeatInterval') {
+ if (keyToChange.key === 'HeartBeatInterval' && valueChanged) {
this._setConfigurationKeyValue('HeartbeatInterval', commandPayload.value);
triggerHeartbeatRestart = true;
}
- if (keyToChange.key === 'HeartbeatInterval') {
+ if (keyToChange.key === 'HeartbeatInterval' && valueChanged) {
this._setConfigurationKeyValue('HeartBeatInterval', commandPayload.value);
triggerHeartbeatRestart = true;
}
if (triggerHeartbeatRestart) {
this._heartbeatInterval = Utils.convertToInt(commandPayload.value) * 1000;
- // Stop heartbeat
- this._stopHeartbeat();
- // Start heartbeat
- this._startHeartbeat();
+ this._restartHeartbeat();
+ }
+ if (keyToChange.key === 'WebSocketPingInterval' && valueChanged) {
+ this._restartWebSocketPing();
}
if (keyToChange.reboot) {
return Constants.OCPP_CONFIGURATION_RESPONSE_REBOOT_REQUIRED;
}
}
- async handleRequestRemoteStartTransaction(commandPayload): Promise<DefaultRequestResponse> {
- const transactionConnectorID: number = commandPayload.connectorId ? Utils.convertToInt(commandPayload.connectorId) : 1;
+ handleRequestSetChargingProfile(commandPayload: SetChargingProfileRequest): SetChargingProfileResponse {
+ if (!this.getConnector(commandPayload.connectorId)) {
+ logger.error(`${this._logPrefix()} Trying to set a charging profile to a non existing connector Id ${commandPayload.connectorId}`);
+ return Constants.OCPP_CHARGING_PROFILE_RESPONSE_REJECTED;
+ }
+ if (commandPayload.csChargingProfiles.chargingProfilePurpose === ChargingProfilePurposeType.TX_PROFILE && !this.getConnector(commandPayload.connectorId)?.transactionStarted) {
+ return Constants.OCPP_CHARGING_PROFILE_RESPONSE_REJECTED;
+ }
+ this.getConnector(commandPayload.connectorId).chargingProfiles.forEach((chargingProfile: ChargingProfile, index: number) => {
+ if (chargingProfile.chargingProfileId === commandPayload.csChargingProfiles.chargingProfileId
+ || (chargingProfile.stackLevel === commandPayload.csChargingProfiles.stackLevel && chargingProfile.chargingProfilePurpose === commandPayload.csChargingProfiles.chargingProfilePurpose)) {
+ this.getConnector(commandPayload.connectorId).chargingProfiles[index] = chargingProfile;
+ return Constants.OCPP_CHARGING_PROFILE_RESPONSE_ACCEPTED;
+ }
+ });
+ this.getConnector(commandPayload.connectorId).chargingProfiles.push(commandPayload.csChargingProfiles);
+ return Constants.OCPP_CHARGING_PROFILE_RESPONSE_ACCEPTED;
+ }
+
+ async handleRequestRemoteStartTransaction(commandPayload: RemoteStartTransactionRequest): Promise<DefaultResponse> {
+ const transactionConnectorID: number = commandPayload.connectorId ? commandPayload.connectorId : 1;
if (this._getAuthorizeRemoteTxRequests() && this._getLocalAuthListEnabled() && this.hasAuthorizedTags()) {
// Check if authorized
if (this._authorizedTags.find((value) => value === commandPayload.idTag)) {
logger.debug(this._logPrefix() + ' Transaction remotely STARTED on ' + this._stationInfo.name + '#' + transactionConnectorID.toString() + ' for idTag ' + commandPayload.idTag);
return Constants.OCPP_RESPONSE_ACCEPTED;
}
- logger.error(this._logPrefix() + ' Remote starting transaction REJECTED with status ' + commandPayload.idTagInfo?.status + ', idTag ' + commandPayload.idTag);
+ logger.error(this._logPrefix() + ' Remote starting transaction REJECTED, idTag ' + commandPayload.idTag);
return Constants.OCPP_RESPONSE_REJECTED;
}
// No local authorization check required => start transaction
return Constants.OCPP_RESPONSE_ACCEPTED;
}
- async handleRequestRemoteStopTransaction(commandPayload): Promise<DefaultRequestResponse> {
- const transactionId = Utils.convertToInt(commandPayload.transactionId);
+ async handleRequestRemoteStopTransaction(commandPayload: RemoteStopTransactionRequest): Promise<DefaultResponse> {
+ const transactionId = commandPayload.transactionId;
for (const connector in this._connectors) {
- if (this.getConnector(Utils.convertToInt(connector)).transactionId === transactionId) {
+ if (Utils.convertToInt(connector) > 0 && this.getConnector(Utils.convertToInt(connector)).transactionId === transactionId) {
await this.sendStopTransaction(transactionId);
return Constants.OCPP_RESPONSE_ACCEPTED;
}
}
- logger.info(this._logPrefix() + ' Try to stop remotely a non existing transaction ' + transactionId.toString());
+ logger.info(this._logPrefix() + ' Trying to remote stop a non existing transaction ' + transactionId.toString());
return Constants.OCPP_RESPONSE_REJECTED;
}
+
+ private handleRequestError(commandName: RequestCommand, error: Error) {
+ logger.error(this._logPrefix() + ' Send ' + commandName + ' error: %j', error);
+ throw error;
+ }
}
repositories / e-mobility-charging-stations-simulator.git / blobdiff