1 // Partial Copyright Jerome Benoit. 2021-2023. All Rights Reserved.
3 import type { JSONSchemaType
} from
'ajv';
5 import { OCPP20Constants
} from
'./OCPP20Constants';
6 import { OCPP20ServiceUtils
} from
'./OCPP20ServiceUtils';
7 import type { ChargingStation
} from
'../../../charging-station';
8 import { OCPPError
} from
'../../../exception';
13 type OCPP20BootNotificationRequest
,
14 type OCPP20HeartbeatRequest
,
16 type OCPP20StatusNotificationRequest
,
19 } from
'../../../types';
20 import { generateUUID
} from
'../../../utils';
21 import { OCPPRequestService
} from
'../OCPPRequestService';
22 import type { OCPPResponseService
} from
'../OCPPResponseService';
24 const moduleName
= 'OCPP20RequestService';
26 export class OCPP20RequestService
extends OCPPRequestService
{
27 protected jsonSchemas
: Map
<OCPP20RequestCommand
, JSONSchemaType
<JsonObject
>>;
29 public constructor(ocppResponseService
: OCPPResponseService
) {
30 // if (new.target?.name === moduleName) {
31 // throw new TypeError(`Cannot construct ${new.target?.name} instances directly`);
33 super(OCPPVersion
.VERSION_20
, ocppResponseService
);
34 this.jsonSchemas
= new Map
<OCPP20RequestCommand
, JSONSchemaType
<JsonObject
>>([
36 OCPP20RequestCommand
.BOOT_NOTIFICATION
,
37 OCPP20ServiceUtils
.parseJsonSchemaFile
<OCPP20BootNotificationRequest
>(
38 'assets/json-schemas/ocpp/2.0/BootNotificationRequest.json',
44 OCPP20RequestCommand
.HEARTBEAT
,
45 OCPP20ServiceUtils
.parseJsonSchemaFile
<OCPP20HeartbeatRequest
>(
46 'assets/json-schemas/ocpp/2.0/HeartbeatRequest.json',
52 OCPP20RequestCommand
.STATUS_NOTIFICATION
,
53 OCPP20ServiceUtils
.parseJsonSchemaFile
<OCPP20StatusNotificationRequest
>(
54 'assets/json-schemas/ocpp/2.0/StatusNotificationRequest.json',
60 this.buildRequestPayload
= this.buildRequestPayload
.bind(this) as <Request
extends JsonType
>(
61 chargingStation
: ChargingStation
,
62 commandName
: OCPP20RequestCommand
,
63 commandParams
?: JsonType
,
67 public async requestHandler
<RequestType
extends JsonType
, ResponseType
extends JsonType
>(
68 chargingStation
: ChargingStation
,
69 commandName
: OCPP20RequestCommand
,
70 commandParams
?: JsonType
,
71 params
?: RequestParams
,
72 ): Promise
<ResponseType
> {
73 // FIXME?: add sanity checks on charging station availability, connector availability, connector status, etc.
74 if (OCPP20ServiceUtils
.isRequestCommandSupported(chargingStation
, commandName
) === true) {
75 return (await this.sendMessage(
78 this.buildRequestPayload
<RequestType
>(chargingStation
, commandName
, commandParams
),
83 // OCPPError usage here is debatable: it's an error in the OCPP stack but not targeted to sendError().
85 ErrorType
.NOT_SUPPORTED
,
86 `Unsupported OCPP command '${commandName}'`,
92 private buildRequestPayload
<Request
extends JsonType
>(
93 chargingStation
: ChargingStation
,
94 commandName
: OCPP20RequestCommand
,
95 commandParams
?: JsonType
,
97 commandParams
= commandParams
as JsonObject
;
98 switch (commandName
) {
99 case OCPP20RequestCommand
.BOOT_NOTIFICATION
:
100 return commandParams
as unknown
as Request
;
101 case OCPP20RequestCommand
.HEARTBEAT
:
102 return OCPP20Constants
.OCPP_RESPONSE_EMPTY
as unknown
as Request
;
103 case OCPP20RequestCommand
.STATUS_NOTIFICATION
:
105 timestamp
: new Date(),
107 } as unknown
as Request
;
109 // OCPPError usage here is debatable: it's an error in the OCPP stack but not targeted to sendError().
111 ErrorType
.NOT_SUPPORTED
,
112 // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
113 `Unsupported OCPP command '${commandName}'`,