Commit | Line | Data |
---|---|---|
edd13439 | 1 | // Partial Copyright Jerome Benoit. 2021-2023. All Rights Reserved. |
953d6b02 | 2 | |
66a7748d | 3 | import type { JSONSchemaType } from 'ajv' |
953d6b02 | 4 | |
66a7748d JB |
5 | import { OCPP20Constants } from './OCPP20Constants.js' |
6 | import { OCPP20ServiceUtils } from './OCPP20ServiceUtils.js' | |
7 | import type { ChargingStation } from '../../../charging-station/index.js' | |
8 | import { OCPPError } from '../../../exception/index.js' | |
d270cc87 | 9 | import { |
268a74bb JB |
10 | ErrorType, |
11 | type JsonObject, | |
12 | type JsonType, | |
96a52d08 | 13 | type OCPP20BootNotificationRequest, |
81533a20 | 14 | type OCPP20HeartbeatRequest, |
d270cc87 | 15 | OCPP20RequestCommand, |
6e939d9e | 16 | type OCPP20StatusNotificationRequest, |
268a74bb | 17 | OCPPVersion, |
66a7748d JB |
18 | type RequestParams |
19 | } from '../../../types/index.js' | |
20 | import { generateUUID } from '../../../utils/index.js' | |
21 | import { OCPPRequestService } from '../OCPPRequestService.js' | |
22 | import type { OCPPResponseService } from '../OCPPResponseService.js' | |
953d6b02 | 23 | |
66a7748d | 24 | const moduleName = 'OCPP20RequestService' |
953d6b02 | 25 | |
268a74bb | 26 | export class OCPP20RequestService extends OCPPRequestService { |
66a7748d | 27 | protected jsonSchemas: Map<OCPP20RequestCommand, JSONSchemaType<JsonType>> |
953d6b02 | 28 | |
66a7748d | 29 | public constructor (ocppResponseService: OCPPResponseService) { |
b768993d | 30 | // if (new.target?.name === moduleName) { |
66a7748d | 31 | // throw new TypeError(`Cannot construct ${new.target?.name} instances directly`) |
b768993d | 32 | // } |
66a7748d | 33 | super(OCPPVersion.VERSION_20, ocppResponseService) |
291b5ec8 | 34 | this.jsonSchemas = new Map<OCPP20RequestCommand, JSONSchemaType<JsonType>>([ |
d270cc87 JB |
35 | [ |
36 | OCPP20RequestCommand.BOOT_NOTIFICATION, | |
130783a7 | 37 | OCPP20ServiceUtils.parseJsonSchemaFile<OCPP20BootNotificationRequest>( |
51022aa0 | 38 | 'assets/json-schemas/ocpp/2.0/BootNotificationRequest.json', |
1b271a54 | 39 | moduleName, |
66a7748d JB |
40 | 'constructor' |
41 | ) | |
d270cc87 | 42 | ], |
81533a20 JB |
43 | [ |
44 | OCPP20RequestCommand.HEARTBEAT, | |
130783a7 | 45 | OCPP20ServiceUtils.parseJsonSchemaFile<OCPP20HeartbeatRequest>( |
51022aa0 | 46 | 'assets/json-schemas/ocpp/2.0/HeartbeatRequest.json', |
1b271a54 | 47 | moduleName, |
66a7748d JB |
48 | 'constructor' |
49 | ) | |
81533a20 | 50 | ], |
6e939d9e JB |
51 | [ |
52 | OCPP20RequestCommand.STATUS_NOTIFICATION, | |
130783a7 | 53 | OCPP20ServiceUtils.parseJsonSchemaFile<OCPP20StatusNotificationRequest>( |
51022aa0 | 54 | 'assets/json-schemas/ocpp/2.0/StatusNotificationRequest.json', |
1b271a54 | 55 | moduleName, |
66a7748d JB |
56 | 'constructor' |
57 | ) | |
58 | ] | |
59 | ]) | |
31f59c6d JB |
60 | this.buildRequestPayload = this.buildRequestPayload.bind(this) as <Request extends JsonType>( |
61 | chargingStation: ChargingStation, | |
62 | commandName: OCPP20RequestCommand, | |
66a7748d JB |
63 | commandParams?: JsonType |
64 | ) => Request | |
953d6b02 JB |
65 | } |
66 | ||
67 | public async requestHandler<RequestType extends JsonType, ResponseType extends JsonType>( | |
68 | chargingStation: ChargingStation, | |
69 | commandName: OCPP20RequestCommand, | |
70 | commandParams?: JsonType, | |
66a7748d | 71 | params?: RequestParams |
953d6b02 | 72 | ): Promise<ResponseType> { |
62340a29 | 73 | // FIXME?: add sanity checks on charging station availability, connector availability, connector status, etc. |
66a7748d | 74 | if (OCPP20ServiceUtils.isRequestCommandSupported(chargingStation, commandName)) { |
953d6b02 JB |
75 | return (await this.sendMessage( |
76 | chargingStation, | |
9bf0ef23 | 77 | generateUUID(), |
18bf8274 | 78 | this.buildRequestPayload<RequestType>(chargingStation, commandName, commandParams), |
953d6b02 | 79 | commandName, |
66a7748d JB |
80 | params |
81 | )) as ResponseType | |
953d6b02 JB |
82 | } |
83 | // OCPPError usage here is debatable: it's an error in the OCPP stack but not targeted to sendError(). | |
84 | throw new OCPPError( | |
85 | ErrorType.NOT_SUPPORTED, | |
86 | `Unsupported OCPP command '${commandName}'`, | |
87 | commandName, | |
66a7748d JB |
88 | commandParams |
89 | ) | |
953d6b02 JB |
90 | } |
91 | ||
92 | private buildRequestPayload<Request extends JsonType>( | |
93 | chargingStation: ChargingStation, | |
94 | commandName: OCPP20RequestCommand, | |
66a7748d | 95 | commandParams?: JsonType |
953d6b02 | 96 | ): Request { |
66a7748d | 97 | commandParams = commandParams as JsonObject |
953d6b02 | 98 | switch (commandName) { |
d270cc87 | 99 | case OCPP20RequestCommand.BOOT_NOTIFICATION: |
66a7748d | 100 | return commandParams as unknown as Request |
81533a20 | 101 | case OCPP20RequestCommand.HEARTBEAT: |
66a7748d | 102 | return OCPP20Constants.OCPP_RESPONSE_EMPTY as unknown as Request |
6e939d9e JB |
103 | case OCPP20RequestCommand.STATUS_NOTIFICATION: |
104 | return { | |
36c462a4 | 105 | timestamp: new Date(), |
66a7748d JB |
106 | ...commandParams |
107 | } as unknown as Request | |
953d6b02 JB |
108 | default: |
109 | // OCPPError usage here is debatable: it's an error in the OCPP stack but not targeted to sendError(). | |
110 | throw new OCPPError( | |
111 | ErrorType.NOT_SUPPORTED, | |
112 | // eslint-disable-next-line @typescript-eslint/restrict-template-expressions | |
113 | `Unsupported OCPP command '${commandName}'`, | |
114 | commandName, | |
66a7748d JB |
115 | commandParams |
116 | ) | |
953d6b02 JB |
117 | } |
118 | } | |
953d6b02 | 119 | } |