import Connectors, { Connector } from '../types/Connectors';
import MeterValue, { MeterValueLocation, MeterValueMeasurand, MeterValuePhase, MeterValueUnit } from '../types/ocpp/1.6/MeterValue';
import { PerformanceObserver, performance } from 'perf_hooks';
+import WebSocket, { MessageEvent } from 'ws';
import AutomaticTransactionGenerator from './AutomaticTransactionGenerator';
import { ChargePointErrorCode } from '../types/ocpp/1.6/ChargePointErrorCode';
import Requests from '../types/ocpp/1.6/Requests';
import Statistics from '../utils/Statistics';
import Utils from '../utils/Utils';
-import WebSocket from 'ws';
import crypto from 'crypto';
import fs from 'fs';
import logger from '../utils/Logger';
private _wsConnection: WebSocket;
private _hasStopped: boolean;
private _hasSocketRestarted: boolean;
+ private _connectionTimeout: number;
private _autoReconnectRetryCount: number;
private _autoReconnectMaxRetries: number;
- private _autoReconnectTimeout: number;
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;
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 = {} as Requests;
this._messageQueue = [] as string[];
...!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;
+ this._connectionTimeout = this._getConnectionTimeout() * 1000; // Ms, zero for disabling
+ this._autoReconnectMaxRetries = this._getAutoReconnectMaxRetries(); // -1 for unlimited
// Build connectors if needed
const maxConnectors = this._getMaxNumberOfConnectors();
if (maxConnectors <= 0) {
return Utils.logPrefix(` ${this._stationInfo.name}:`);
}
- _getConfiguration(): ChargingStationConfiguration {
+ _getTemplateChargingStationConfiguration(): ChargingStationConfiguration {
return this._stationInfo.Configuration ? this._stationInfo.Configuration : {} as ChargingStationConfiguration;
}
return trxCount;
}
+ _getConnectionTimeout(): number {
+ if (!Utils.isUndefined(this._stationInfo.connectionTimeout)) {
+ return this._stationInfo.connectionTimeout;
+ }
+ if (!Utils.isUndefined(Configuration.getConnectionTimeout())) {
+ return Configuration.getConnectionTimeout();
+ }
+ return 30;
+ }
+
+ _getAutoReconnectMaxRetries(): number {
+ if (!Utils.isUndefined(this._stationInfo.autoReconnectMaxRetries)) {
+ return this._stationInfo.autoReconnectMaxRetries;
+ }
+ if (!Utils.isUndefined(Configuration.getAutoReconnectMaxRetries())) {
+ return Configuration.getAutoReconnectMaxRetries();
+ }
+ return -1;
+ }
+
_getPowerDivider(): number {
let powerDivider = this._getNumberOfConnectors();
if (this._stationInfo.powerSharedByConnectors) {
return !Utils.isUndefined(this._stationInfo.voltageOut) ? Utils.convertToInt(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) {
return this.getConnector(Utils.convertToInt(connector)).idTag;
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 (!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
}
}
+ _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._wsConnection?.readyState === WebSocket.OPEN) {
+ 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): 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._connectionTimeout;
+ }
+ 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 (this._wsConnection && this._wsConnection.readyState === WebSocket.OPEN) {
+ if (this._wsConnection?.readyState === WebSocket.OPEN) {
this._wsConnection.close();
}
this._hasStopped = true;
}
- _reconnect(error): void {
- logger.error(this._logPrefix() + ' Socket: abnormally closed %j', error);
+ async _reconnect(error): Promise<void> {
+ logger.error(this._logPrefix() + ' Socket: abnormally closed: %j', error);
+ // 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._autoReconnectMaxRetries || this._autoReconnectMaxRetries === -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._connectionTimeout);
+ 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 });
+ } else if (this._autoReconnectMaxRetries !== -1) {
+ logger.error(`${this._logPrefix()} Socket: max retries reached (${this._autoReconnectRetryCount}) or retry disabled (${this._autoReconnectMaxRetries})`);
}
}
- onOpen(): void {
+ async onOpen(): Promise<void> {
logger.info(`${this._logPrefix()} Is connected to server through ${this._wsConnectionUrl}`);
- if (!this._hasSocketRestarted) {
+ if (!this._hasSocketRestarted || this._hasStopped) {
// Send BootNotification
- this.sendBootNotification();
+ await this.sendBootNotification();
}
+ await this._startMessageSequence();
if (this._hasSocketRestarted) {
- this._startMessageSequence();
if (!Utils.isEmptyArray(this._messageQueue)) {
this._messageQueue.forEach((message, index) => {
- if (this._wsConnection && this._wsConnection.readyState === WebSocket.OPEN) {
+ if (this._wsConnection?.readyState === WebSocket.OPEN) {
this._messageQueue.splice(index, 1);
this._wsConnection.send(message);
}
this._hasSocketRestarted = false;
}
- onError(errorEvent): void {
- switch (errorEvent) {
+ async onError(errorEvent): Promise<void> {
+ switch (errorEvent.code) {
case 'ECONNREFUSED':
this._hasSocketRestarted = true;
- this._reconnect(errorEvent);
+ await this._reconnect(errorEvent);
break;
default:
logger.error(this._logPrefix() + ' Socket error: %j', errorEvent);
}
}
- onClose(closeEvent): void {
+ async onClose(closeEvent): Promise<void> {
switch (closeEvent) {
case 1000: // Normal close
case 1005:
- logger.info(this._logPrefix() + ' Socket normally closed %j', closeEvent);
+ logger.info(this._logPrefix() + ' Socket normally closed: %j', closeEvent);
this._autoReconnectRetryCount = 0;
break;
default: // Abnormal close
this._hasSocketRestarted = true;
- this._reconnect(closeEvent);
+ await this._reconnect(closeEvent);
break;
}
}
logger.debug(this._logPrefix() + ' Has received a WS ping (rfc6455) from the server');
}
- async onMessage(messageEvent): Promise<void> {
+ 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] = [0, '', Constants.ENTITY_CHARGING_STATION, '', ''];
try {
// Parse the message
- [messageType, messageId, commandName, commandPayload, errorDetails] = JSON.parse(messageEvent);
+ [messageType, messageId, commandName, commandPayload, errorDetails] = JSON.parse(messageEvent.toString());
// Check the Type of message
switch (messageType) {
// Log
logger.error('%s Incoming message %j processing error %s on request content type %s', this._logPrefix(), messageEvent, error, this._requests[messageId]);
// Send error
- await this.sendError(messageId, error, commandName);
+ messageType !== Constants.OCPP_JSON_CALL_ERROR_MESSAGE && await this.sendError(messageId, error, commandName);
}
}
}
async sendStopTransaction(transactionId: number, reason: StopTransactionReason = StopTransactionReason.NONE): Promise<StopTransactionResponse> {
- const idTag = this._getTransactionidTag(transactionId);
+ const idTag = this._getTransactionIdTag(transactionId);
try {
const payload = {
transactionId,
break;
}
// Check if wsConnection is ready
- if (this._wsConnection && this._wsConnection.readyState === WebSocket.OPEN) {
+ if (this._wsConnection?.readyState === WebSocket.OPEN) {
if (this.getEnableStatistics()) {
this._statistics.addMessage(commandName, messageType);
}
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 : Constants.OCPP_ERROR_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 (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
handleResponseBootNotification(payload, requestPayload): void {
if (payload.status === 'Accepted') {
- this._heartbeatInterval = payload.interval * 1000;
+ this._heartbeatInterval = Utils.convertToInt(payload.interval) * 1000;
+ this._heartbeatSetInterval ? this._restartHeartbeat() : this._startHeartbeat();
this._addConfigurationKey('HeartBeatInterval', payload.interval);
this._addConfigurationKey('HeartbeatInterval', payload.interval, false, false);
- this._startMessageSequence();
this._hasStopped && (this._hasStopped = false);
} else if (payload.status === 'Pending') {
logger.info(this._logPrefix() + ' Charging station in pending state on the central server');
handleResponseStartTransaction(payload: StartTransactionResponse, requestPayload): void {
const connectorId = Utils.convertToInt(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;
}
}
}
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) {
}
}
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);
return;
}
if (payload.idTagInfo?.status === AuthorizationStatus.ACCEPTED) {
async handleRequestUnlockConnector(commandPayload): Promise<UnlockResponse> {
const connectorId = Utils.convertToInt(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_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 as string;
+ 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;
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;
}
}
repositories / e-mobility-charging-stations-simulator.git / blobdiff