1 import { AuthorizeResponse
, StartTransactionResponse
, StopTransactionReason
, StopTransactionResponse
} from
'../../types/ocpp/Transaction';
2 import { DiagnosticsStatus
, IncomingRequestCommand
, RequestCommand
} from
'../../types/ocpp/Requests';
4 import { BootNotificationResponse
} from
'../../types/ocpp/Responses';
5 import { ChargePointErrorCode
} from
'../../types/ocpp/ChargePointErrorCode';
6 import { ChargePointStatus
} from
'../../types/ocpp/ChargePointStatus';
7 import ChargingStation from
'../ChargingStation';
8 import Constants from
'../../utils/Constants';
9 import { ErrorType
} from
'../../types/ocpp/ErrorType';
10 import { MessageType
} from
'../../types/ocpp/MessageType';
11 import { MeterValue
} from
'../../types/ocpp/MeterValues';
12 import OCPPError from
'../OCPPError';
13 import OCPPResponseService from
'./OCPPResponseService';
14 import PerformanceStatistics from
'../../utils/PerformanceStatistics';
15 import logger from
'../../utils/Logger';
17 export default abstract class OCPPRequestService
{
18 public chargingStation
: ChargingStation
;
19 protected ocppResponseService
: OCPPResponseService
;
21 constructor(chargingStation
: ChargingStation
, ocppResponseService
: OCPPResponseService
) {
22 this.chargingStation
= chargingStation
;
23 this.ocppResponseService
= ocppResponseService
;
26 public async sendMessage(messageId
: string, commandParams
: any, messageType
: MessageType
, commandName
: RequestCommand
| IncomingRequestCommand
): Promise
<any> {
27 // eslint-disable-next-line @typescript-eslint/no-this-alias
29 // Send a message through wsConnection
30 return new Promise((resolve
: (value
?: any | PromiseLike
<any>) => void, reject
: (reason
?: any) => void) => {
31 let messageToSend
: string;
33 switch (messageType
) {
35 case MessageType
.CALL_MESSAGE
:
37 this.chargingStation
.requests
[messageId
] = [responseCallback
, rejectCallback
, commandParams
as Record
<string, unknown
>];
38 messageToSend
= JSON
.stringify([messageType
, messageId
, commandName
, commandParams
]);
41 case MessageType
.CALL_RESULT_MESSAGE
:
43 messageToSend
= JSON
.stringify([messageType
, messageId
, commandParams
]);
46 case MessageType
.CALL_ERROR_MESSAGE
:
47 // Build Error Message
48 messageToSend
= JSON
.stringify([messageType
, messageId
, commandParams
.code
? commandParams
.code
: ErrorType
.GENERIC_ERROR
, commandParams
.message
? commandParams
.message
: '', commandParams
.details
? commandParams
.details
: {}]);
51 // Check if wsConnection opened and charging station registered
52 if (this.chargingStation
.isWebSocketOpen() && (this.chargingStation
.isRegistered() || commandName
=== RequestCommand
.BOOT_NOTIFICATION
)) {
53 if (this.chargingStation
.getEnableStatistics()) {
54 this.chargingStation
.performanceStatistics
.addRequestStatistic(commandName
, messageType
);
57 const beginId
= PerformanceStatistics
.beginMeasure(commandName
);
58 this.chargingStation
.wsConnection
.send(messageToSend
);
59 PerformanceStatistics
.endMeasure(commandName
, beginId
);
60 } else if (commandName
!== RequestCommand
.BOOT_NOTIFICATION
) {
62 this.chargingStation
.addToMessageQueue(messageToSend
);
64 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
: {}));
67 if (messageType
=== MessageType
.CALL_RESULT_MESSAGE
) {
70 } else if (messageType
=== MessageType
.CALL_ERROR_MESSAGE
) {
72 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
);
76 * Function that will receive the request's response
78 * @param {Record<string, unknown> | string} payload
79 * @param {Record<string, unknown>} requestPayload
81 async function responseCallback(payload
: Record
<string, unknown
> | string, requestPayload
: Record
<string, unknown
>): Promise
<void> {
82 if (self.chargingStation
.getEnableStatistics()) {
83 self.chargingStation
.performanceStatistics
.addRequestStatistic(commandName
, MessageType
.CALL_RESULT_MESSAGE
);
86 await self.ocppResponseService
.handleResponse(commandName
as RequestCommand
, payload
, requestPayload
);
91 * Function that will receive the request's rejection
93 * @param {OCPPError} error
95 function rejectCallback(error
: OCPPError
): void {
96 if (self.chargingStation
.getEnableStatistics()) {
97 self.chargingStation
.performanceStatistics
.addRequestStatistic(commandName
, MessageType
.CALL_ERROR_MESSAGE
);
99 logger
.debug(`${self.chargingStation.logPrefix()} Error: %j occurred when calling command %s with parameters: %j`, error
, commandName
, commandParams
);
101 // eslint-disable-next-line no-empty-function
102 self.chargingStation
.requests
[messageId
] = [() => { }, () => { }, {}];
109 protected handleRequestError(commandName
: RequestCommand
, error
: Error): void {
110 logger
.error(this.chargingStation
.logPrefix() + ' Request command ' + commandName
+ ' error: %j', error
);
114 public abstract sendHeartbeat(): Promise
<void>;
115 public abstract sendBootNotification(chargePointModel
: string, chargePointVendor
: string, chargeBoxSerialNumber
?: string, firmwareVersion
?: string, chargePointSerialNumber
?: string, iccid
?: string, imsi
?: string, meterSerialNumber
?: string, meterType
?: string): Promise
<BootNotificationResponse
>;
116 public abstract sendStatusNotification(connectorId
: number, status: ChargePointStatus
, errorCode
?: ChargePointErrorCode
): Promise
<void>;
117 public abstract sendAuthorize(connectorId
: number, idTag
?: string): Promise
<AuthorizeResponse
>;
118 public abstract sendStartTransaction(connectorId
: number, idTag
?: string): Promise
<StartTransactionResponse
>;
119 public abstract sendStopTransaction(transactionId
: number, meterStop
: number, idTag
?: string, reason
?: StopTransactionReason
): Promise
<StopTransactionResponse
>;
120 public abstract sendMeterValues(connectorId
: number, transactionId
: number, interval
: number): Promise
<void>;
121 public abstract sendTransactionBeginMeterValues(connectorId
: number, transactionId
: number, beginMeterValue
: MeterValue
): Promise
<void>;
122 public abstract sendTransactionEndMeterValues(connectorId
: number, transactionId
: number, endMeterValue
: MeterValue
): Promise
<void>;
123 public abstract sendDiagnosticsStatusNotification(diagnosticsStatus
: DiagnosticsStatus
): Promise
<void>;
124 public abstract sendError(messageId
: string, error
: OCPPError
, commandName
: RequestCommand
| IncomingRequestCommand
): Promise
<unknown
>;