} from '../types/ocpp/Requests';
import {
BootNotificationResponse,
+ ErrorResponse,
HeartbeatResponse,
MeterValuesResponse,
RegistrationStatus,
+ Response,
StatusNotificationResponse,
} from '../types/ocpp/Responses';
import {
) {
// eslint-disable-next-line @typescript-eslint/no-misused-promises
this.heartbeatSetInterval = setInterval(async (): Promise<void> => {
- await this.ocppRequestService.sendMessageHandler<HeartbeatRequest, HeartbeatResponse>(
+ await this.ocppRequestService.requestHandler<HeartbeatRequest, HeartbeatResponse>(
RequestCommand.HEARTBEAT
);
}, this.getHeartbeatInterval());
this.getConnectorStatus(connectorId).transactionId,
interval
);
- await this.ocppRequestService.sendMessageHandler<MeterValuesRequest, MeterValuesResponse>(
+ await this.ocppRequestService.requestHandler<MeterValuesRequest, MeterValuesResponse>(
RequestCommand.METER_VALUES,
{
connectorId,
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 authorization file
FileUtils.watchJsonFile<string[]>(
this.logPrefix(),
}
}
);
- // 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);
parentPort.postMessage({
id: ChargingStationWorkerMessageEvents.STARTED,
data: { id: this.stationInfo.chargingStationId },
await this.stopMessageSequence(reason);
for (const connectorId of this.connectors.keys()) {
if (connectorId > 0) {
- await this.ocppRequestService.sendMessageHandler<
+ await this.ocppRequestService.requestHandler<
StatusNotificationRequest,
StatusNotificationResponse
>(RequestCommand.STATUS_NOTIFICATION, {
try {
const measureId = `${FileType.ChargingStationTemplate} read`;
const beginId = PerformanceStatistics.beginMeasure(measureId);
- template = JSON.parse(fs.readFileSync(this.templateFile, 'utf8')) as ChargingStationTemplate;
+ template =
+ (JSON.parse(fs.readFileSync(this.templateFile, 'utf8')) as ChargingStationTemplate) ??
+ ({} as ChargingStationTemplate);
PerformanceStatistics.endMeasure(measureId, beginId);
+ template.templateHash = crypto
+ .createHash(Constants.DEFAULT_HASH_ALGORITHM)
+ .update(JSON.stringify(template))
+ .digest('hex');
} catch (error) {
FileUtils.handleFileException(
this.logPrefix(),
}
private getStationInfoFromTemplate(): ChargingStationInfo {
- const stationInfo: ChargingStationInfo =
- this.getTemplateFromFile() ?? ({} as ChargingStationInfo);
- stationInfo.hash = crypto
- .createHash(Constants.DEFAULT_HASH_ALGORITHM)
- .update(JSON.stringify(stationInfo))
- .digest('hex');
+ const stationInfo: ChargingStationInfo = this.getTemplateFromFile();
const chargingStationId = this.getChargingStationId(stationInfo);
// Deprecation template keys section
this.warnDeprecatedTemplateKey(
return stationInfo;
}
- private getStationInfoFromFile(): ChargingStationInfo | null {
- return this.getConfigurationFromFile()?.stationInfo ?? null;
+ private getStationInfoFromFile(): ChargingStationInfo {
+ const stationInfo = this.getConfigurationFromFile()?.stationInfo ?? ({} as ChargingStationInfo);
+ stationInfo.infoHash = crypto
+ .createHash(Constants.DEFAULT_HASH_ALGORITHM)
+ .update(JSON.stringify(stationInfo))
+ .digest('hex');
+ return stationInfo;
}
private getStationInfo(): ChargingStationInfo {
this.hashId + '.json'
);
const stationInfoFromFile: ChargingStationInfo = this.getStationInfoFromFile();
- if (stationInfoFromFile?.hash === stationInfoFromTemplate.hash) {
+ // Priority: charging station info from template > charging station info from configuration file > charging station info attribute
+ if (stationInfoFromFile?.templateHash === stationInfoFromTemplate.templateHash) {
return stationInfoFromFile;
+ } else if (stationInfoFromFile?.templateHash !== stationInfoFromTemplate.templateHash) {
+ this.createSerialNumber(stationInfoFromTemplate, stationInfoFromFile);
+ return stationInfoFromTemplate;
+ }
+ if (this.stationInfo?.infoHash === stationInfoFromFile?.infoHash) {
+ return this.stationInfo;
}
- this.createSerialNumber(stationInfoFromTemplate, stationInfoFromFile);
- return stationInfoFromTemplate;
+ return stationInfoFromFile;
}
private saveStationInfo(): void {
logger.info(
`${this.logPrefix()} Connection to OCPP server through ${this.wsConnectionUrl.toString()} succeeded`
);
- if (!this.isInAcceptedState()) {
+ if (!this.isRegistered()) {
// Send BootNotification
let registrationRetryCount = 0;
do {
- this.bootNotificationResponse = await this.ocppRequestService.sendMessageHandler<
+ this.bootNotificationResponse = await this.ocppRequestService.requestHandler<
BootNotificationRequest,
BootNotificationResponse
>(
},
{ skipBufferingOnError: true }
);
- if (!this.isInAcceptedState()) {
+ if (!this.isRegistered()) {
this.getRegistrationMaxRetries() !== -1 && registrationRetryCount++;
await Utils.sleep(
this.bootNotificationResponse?.interval
);
}
} while (
- !this.isInAcceptedState() &&
+ !this.isRegistered() &&
(registrationRetryCount <= this.getRegistrationMaxRetries() ||
this.getRegistrationMaxRetries() === -1)
);
}
- if (this.isInAcceptedState()) {
- await this.startMessageSequence();
- this.stopped && (this.stopped = false);
- if (this.wsConnectionRestarted) {
- this.flushMessageBuffer();
+ if (this.isRegistered()) {
+ if (this.isInAcceptedState()) {
+ await this.startMessageSequence();
+ this.wsConnectionRestarted && this.flushMessageBuffer();
}
} else {
logger.error(
`${this.logPrefix()} Registration failure: max retries reached (${this.getRegistrationMaxRetries()}) or retry disabled (${this.getRegistrationMaxRetries()})`
);
}
+ this.stopped && (this.stopped = false);
this.autoReconnectRetryCount = 0;
this.wsConnectionRestarted = false;
} else {
}
private async onMessage(data: Data): Promise<void> {
- let [messageType, messageId, commandName, commandPayload, errorDetails]: IncomingRequest = [
- 0,
- '',
- '' as IncomingRequestCommand,
- {},
- {},
- ];
- let responseCallback: (
- payload: JsonType | string,
- requestPayload: JsonType | OCPPError
- ) => void;
+ let messageType: number;
+ let messageId: string;
+ let commandName: IncomingRequestCommand;
+ let commandPayload: JsonType;
+ let errorType: ErrorType;
+ let errorMessage: string;
+ let errorDetails: JsonType;
+ let responseCallback: (payload: JsonType, requestPayload: JsonType) => void;
let rejectCallback: (error: OCPPError, requestStatistic?: boolean) => void;
let requestCommandName: RequestCommand | IncomingRequestCommand;
- let requestPayload: JsonType | OCPPError;
+ let requestPayload: JsonType;
let cachedRequest: CachedRequest;
let errMsg: string;
try {
- const request = JSON.parse(data.toString()) as IncomingRequest;
+ const request = JSON.parse(data.toString()) as IncomingRequest | Response | ErrorResponse;
if (Utils.isIterable(request)) {
- // Parse the message
- [messageType, messageId, commandName, commandPayload, errorDetails] = request;
- } else {
- throw new OCPPError(
- ErrorType.PROTOCOL_ERROR,
- 'Incoming message is not iterable',
- Utils.isString(commandName) && commandName,
- { payload: request }
- );
- }
- // Check the Type of message
- switch (messageType) {
- // Incoming Message
- case MessageType.CALL_MESSAGE:
- if (this.getEnableStatistics()) {
- this.performanceStatistics.addRequestStatistic(commandName, messageType);
- }
- // Process the call
- await this.ocppIncomingRequestService.handleRequest(
- messageId,
- commandName,
- commandPayload
- );
- logger.debug(
- `${this.logPrefix()} << Command '${commandName}' received request payload: ${JSON.stringify(
- request
- )}`
- );
- break;
- // Outcome Message
- case MessageType.CALL_RESULT_MESSAGE:
- // Respond
- cachedRequest = this.requests.get(messageId);
- if (Utils.isIterable(cachedRequest)) {
- [responseCallback, , requestCommandName, requestPayload] = cachedRequest;
- } else {
- throw new OCPPError(
- ErrorType.PROTOCOL_ERROR,
- `Cached request for message id ${messageId} response is not iterable`,
- requestCommandName
+ [messageType, messageId] = request;
+ // Check the type of message
+ switch (messageType) {
+ // Incoming Message
+ case MessageType.CALL_MESSAGE:
+ [, , commandName, commandPayload] = request as IncomingRequest;
+ if (this.getEnableStatistics()) {
+ this.performanceStatistics.addRequestStatistic(commandName, messageType);
+ }
+ logger.debug(
+ `${this.logPrefix()} << Command '${commandName}' received request payload: ${JSON.stringify(
+ request
+ )}`
);
- }
- if (!responseCallback) {
- // Error
- throw new OCPPError(
- ErrorType.INTERNAL_ERROR,
- `Response for unknown message id ${messageId}`,
- requestCommandName
+ // Process the message
+ await this.ocppIncomingRequestService.incomingRequestHandler(
+ messageId,
+ commandName,
+ commandPayload
);
- }
- responseCallback(commandName, requestPayload);
- logger.debug(
- `${this.logPrefix()} << Command '${requestCommandName}' received response payload: ${JSON.stringify(
- request
- )}`
- );
- break;
- // Error Message
- case MessageType.CALL_ERROR_MESSAGE:
- cachedRequest = this.requests.get(messageId);
- if (Utils.isIterable(cachedRequest)) {
- [, rejectCallback, requestCommandName] = cachedRequest;
- } else {
- throw new OCPPError(
- ErrorType.PROTOCOL_ERROR,
- `Cached request for message id ${messageId} error response is not iterable`
+ break;
+ // Outcome Message
+ case MessageType.CALL_RESULT_MESSAGE:
+ [, , commandPayload] = request as Response;
+ // Respond
+ cachedRequest = this.requests.get(messageId);
+ if (Utils.isIterable(cachedRequest)) {
+ [responseCallback, , requestCommandName, requestPayload] = cachedRequest;
+ } else {
+ throw new OCPPError(
+ ErrorType.PROTOCOL_ERROR,
+ `Cached request for message id ${messageId} response is not iterable`,
+ null,
+ cachedRequest as unknown as JsonType
+ );
+ }
+ logger.debug(
+ `${this.logPrefix()} << Command '${
+ requestCommandName ?? ''
+ }' received response payload: ${JSON.stringify(request)}`
);
- }
- if (!rejectCallback) {
- // Error
- throw new OCPPError(
- ErrorType.INTERNAL_ERROR,
- `Error response for unknown message id ${messageId}`,
- requestCommandName
+ if (!responseCallback) {
+ // Error
+ throw new OCPPError(
+ ErrorType.INTERNAL_ERROR,
+ `Response for unknown message id ${messageId}`,
+ null,
+ commandPayload
+ );
+ }
+ responseCallback(commandPayload, requestPayload);
+ break;
+ // Error Message
+ case MessageType.CALL_ERROR_MESSAGE:
+ [, , errorType, errorMessage, errorDetails] = request as ErrorResponse;
+ cachedRequest = this.requests.get(messageId);
+ if (Utils.isIterable(cachedRequest)) {
+ [, rejectCallback, requestCommandName] = cachedRequest;
+ } else {
+ throw new OCPPError(
+ ErrorType.PROTOCOL_ERROR,
+ `Cached request for message id ${messageId} error response is not iterable`,
+ null,
+ cachedRequest as unknown as JsonType
+ );
+ }
+ logger.debug(
+ `${this.logPrefix()} << Command '${
+ requestCommandName ?? ''
+ }' received error payload: ${JSON.stringify(request)}`
);
- }
- rejectCallback(
- new OCPPError(commandName, commandPayload.toString(), requestCommandName, errorDetails)
- );
- logger.debug(
- `${this.logPrefix()} << Command '${requestCommandName}' received error payload: ${JSON.stringify(
- request
- )}`
- );
- break;
- // Error
- default:
- // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
- errMsg = `${this.logPrefix()} Wrong message type ${messageType}`;
- logger.error(errMsg);
- throw new OCPPError(ErrorType.PROTOCOL_ERROR, errMsg);
+ if (!rejectCallback) {
+ // Error
+ throw new OCPPError(
+ ErrorType.INTERNAL_ERROR,
+ `Error response for unknown message id ${messageId}`,
+ null,
+ { errorType, errorMessage, errorDetails }
+ );
+ }
+ rejectCallback(
+ new OCPPError(errorType, errorMessage, requestCommandName, errorDetails)
+ );
+ break;
+ // Error
+ default:
+ // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
+ errMsg = `${this.logPrefix()} Wrong message type ${messageType}`;
+ logger.error(errMsg);
+ throw new OCPPError(ErrorType.PROTOCOL_ERROR, errMsg);
+ }
+ } else {
+ throw new OCPPError(ErrorType.PROTOCOL_ERROR, 'Incoming message is not iterable', null, {
+ payload: request,
+ });
}
} catch (error) {
// Log
);
// Send error
messageType === MessageType.CALL_MESSAGE &&
- (await this.ocppRequestService.sendError(messageId, error as OCPPError, commandName));
+ (await this.ocppRequestService.sendError(
+ messageId,
+ error as OCPPError,
+ Utils.isString(commandName) ? commandName : requestCommandName ?? null
+ ));
}
}
private async startMessageSequence(): Promise<void> {
if (this.stationInfo.autoRegister) {
- await this.ocppRequestService.sendMessageHandler<
+ await this.ocppRequestService.requestHandler<
BootNotificationRequest,
BootNotificationResponse
>(
this.getConnectorStatus(connectorId)?.bootStatus
) {
// Send status in template at startup
- await this.ocppRequestService.sendMessageHandler<
+ await this.ocppRequestService.requestHandler<
StatusNotificationRequest,
StatusNotificationResponse
>(RequestCommand.STATUS_NOTIFICATION, {
this.getConnectorStatus(connectorId)?.bootStatus
) {
// Send status in template after reset
- await this.ocppRequestService.sendMessageHandler<
+ await this.ocppRequestService.requestHandler<
StatusNotificationRequest,
StatusNotificationResponse
>(RequestCommand.STATUS_NOTIFICATION, {
this.getConnectorStatus(connectorId).bootStatus;
} else if (!this.stopped && this.getConnectorStatus(connectorId)?.status) {
// Send previous status at template reload
- await this.ocppRequestService.sendMessageHandler<
+ await this.ocppRequestService.requestHandler<
StatusNotificationRequest,
StatusNotificationResponse
>(RequestCommand.STATUS_NOTIFICATION, {
});
} else {
// Send default status
- await this.ocppRequestService.sendMessageHandler<
+ await this.ocppRequestService.requestHandler<
StatusNotificationRequest,
StatusNotificationResponse
>(RequestCommand.STATUS_NOTIFICATION, {
connectorId,
this.getEnergyActiveImportRegisterByTransactionId(transactionId)
);
- await this.ocppRequestService.sendMessageHandler<
- MeterValuesRequest,
- MeterValuesResponse
- >(RequestCommand.METER_VALUES, {
- connectorId,
- transactionId,
- meterValue: transactionEndMeterValue,
- });
+ await this.ocppRequestService.requestHandler<MeterValuesRequest, MeterValuesResponse>(
+ RequestCommand.METER_VALUES,
+ {
+ connectorId,
+ transactionId,
+ meterValue: transactionEndMeterValue,
+ }
+ );
}
- await this.ocppRequestService.sendMessageHandler<
+ await this.ocppRequestService.requestHandler<
StopTransactionRequest,
StopTransactionResponse
>(RequestCommand.STOP_TRANSACTION, {