Commit | Line | Data |
---|---|---|
edd13439 | 1 | // Partial Copyright Jerome Benoit. 2021-2023. All Rights Reserved. |
953d6b02 | 2 | |
d270cc87 JB |
3 | import fs from 'fs'; |
4 | import path from 'path'; | |
5 | import { fileURLToPath } from 'url'; | |
6 | ||
953d6b02 JB |
7 | import type { JSONSchemaType } from 'ajv'; |
8 | ||
78202038 | 9 | import { OCPP20ServiceUtils } from './OCPP20ServiceUtils'; |
953d6b02 JB |
10 | import OCPPError from '../../../exception/OCPPError'; |
11 | import type { JsonObject, JsonType } from '../../../types/JsonType'; | |
d270cc87 | 12 | import { |
96a52d08 | 13 | type OCPP20BootNotificationRequest, |
81533a20 | 14 | type OCPP20HeartbeatRequest, |
d270cc87 | 15 | OCPP20RequestCommand, |
6e939d9e | 16 | type OCPP20StatusNotificationRequest, |
d270cc87 | 17 | } from '../../../types/ocpp/2.0/Requests'; |
953d6b02 | 18 | import { ErrorType } from '../../../types/ocpp/ErrorType'; |
d270cc87 | 19 | import { OCPPVersion } from '../../../types/ocpp/OCPPVersion'; |
953d6b02 | 20 | import type { RequestParams } from '../../../types/ocpp/Requests'; |
953d6b02 JB |
21 | import Utils from '../../../utils/Utils'; |
22 | import type ChargingStation from '../../ChargingStation'; | |
4d20f040 | 23 | import OCPPConstants from '../OCPPConstants'; |
953d6b02 JB |
24 | import OCPPRequestService from '../OCPPRequestService'; |
25 | import type OCPPResponseService from '../OCPPResponseService'; | |
953d6b02 JB |
26 | |
27 | const moduleName = 'OCPP20RequestService'; | |
28 | ||
29 | export default class OCPP20RequestService extends OCPPRequestService { | |
b3fc3ff5 | 30 | protected jsonSchemas: Map<OCPP20RequestCommand, JSONSchemaType<JsonObject>>; |
953d6b02 JB |
31 | |
32 | public constructor(ocppResponseService: OCPPResponseService) { | |
33 | if (new.target?.name === moduleName) { | |
34 | throw new TypeError(`Cannot construct ${new.target?.name} instances directly`); | |
35 | } | |
d270cc87 JB |
36 | super(OCPPVersion.VERSION_20, ocppResponseService); |
37 | this.jsonSchemas = new Map<OCPP20RequestCommand, JSONSchemaType<JsonObject>>([ | |
38 | [ | |
39 | OCPP20RequestCommand.BOOT_NOTIFICATION, | |
e9a4164c JB |
40 | this.parseJsonSchemaFile<OCPP20BootNotificationRequest>( |
41 | '../../../assets/json-schemas/ocpp/2.0/BootNotificationRequest.json' | |
42 | ), | |
d270cc87 | 43 | ], |
81533a20 JB |
44 | [ |
45 | OCPP20RequestCommand.HEARTBEAT, | |
e9a4164c JB |
46 | this.parseJsonSchemaFile<OCPP20HeartbeatRequest>( |
47 | '../../../assets/json-schemas/ocpp/2.0/HeartbeatRequest.json' | |
48 | ), | |
81533a20 | 49 | ], |
6e939d9e JB |
50 | [ |
51 | OCPP20RequestCommand.STATUS_NOTIFICATION, | |
e9a4164c JB |
52 | this.parseJsonSchemaFile<OCPP20StatusNotificationRequest>( |
53 | '../../../assets/json-schemas/ocpp/2.0/StatusNotificationRequest.json' | |
54 | ), | |
6e939d9e | 55 | ], |
d270cc87 | 56 | ]); |
953d6b02 | 57 | this.buildRequestPayload.bind(this); |
953d6b02 JB |
58 | } |
59 | ||
60 | public async requestHandler<RequestType extends JsonType, ResponseType extends JsonType>( | |
61 | chargingStation: ChargingStation, | |
62 | commandName: OCPP20RequestCommand, | |
63 | commandParams?: JsonType, | |
64 | params?: RequestParams | |
65 | ): Promise<ResponseType> { | |
66 | if (OCPP20ServiceUtils.isRequestCommandSupported(chargingStation, commandName) === true) { | |
67 | const requestPayload = this.buildRequestPayload<RequestType>( | |
68 | chargingStation, | |
69 | commandName, | |
70 | commandParams | |
71 | ); | |
953d6b02 JB |
72 | return (await this.sendMessage( |
73 | chargingStation, | |
74 | Utils.generateUUID(), | |
75 | requestPayload, | |
76 | commandName, | |
77 | params | |
78 | )) as unknown as ResponseType; | |
79 | } | |
80 | // OCPPError usage here is debatable: it's an error in the OCPP stack but not targeted to sendError(). | |
81 | throw new OCPPError( | |
82 | ErrorType.NOT_SUPPORTED, | |
83 | `Unsupported OCPP command '${commandName}'`, | |
84 | commandName, | |
85 | commandParams | |
86 | ); | |
87 | } | |
88 | ||
89 | private buildRequestPayload<Request extends JsonType>( | |
90 | chargingStation: ChargingStation, | |
91 | commandName: OCPP20RequestCommand, | |
92 | commandParams?: JsonType | |
93 | ): Request { | |
94 | commandParams = commandParams as JsonObject; | |
95 | switch (commandName) { | |
d270cc87 | 96 | case OCPP20RequestCommand.BOOT_NOTIFICATION: |
98fc1389 JB |
97 | commandParams.chargingStation = commandParams.chargingStation as JsonObject; |
98 | commandParams.chargingStation.modem = commandParams.chargingStation.modem as JsonObject; | |
d270cc87 JB |
99 | return { |
100 | reason: commandParams?.reason, | |
101 | chargingStation: { | |
98fc1389 JB |
102 | model: commandParams?.chargingStation?.model, |
103 | vendorName: commandParams?.chargingStation?.vendorName, | |
104 | ...(!Utils.isUndefined(commandParams?.chargingStation?.firmwareVersion) && { | |
105 | firmwareVersion: commandParams.chargingStation?.firmwareVersion, | |
d270cc87 | 106 | }), |
98fc1389 JB |
107 | ...(!Utils.isUndefined(commandParams?.chargingStation?.serialNumber) && { |
108 | serialNumber: commandParams.chargingStation?.serialNumber, | |
109 | }), | |
110 | ...(!Utils.isUndefined(commandParams?.chargingStation?.modem) && { | |
111 | modem: { | |
112 | ...(!Utils.isUndefined(commandParams?.chargingStation?.modem?.iccid) && { | |
113 | iccid: commandParams.chargingStation.modem.iccid, | |
114 | }), | |
115 | ...(!Utils.isUndefined(commandParams?.chargingStation?.modem?.imsi) && { | |
116 | imsi: commandParams.chargingStation.modem.imsi, | |
117 | }), | |
118 | }, | |
d270cc87 | 119 | }), |
d270cc87 JB |
120 | }, |
121 | } as unknown as Request; | |
81533a20 | 122 | case OCPP20RequestCommand.HEARTBEAT: |
4d20f040 | 123 | return OCPPConstants.OCPP_RESPONSE_EMPTY as unknown as Request; |
6e939d9e JB |
124 | case OCPP20RequestCommand.STATUS_NOTIFICATION: |
125 | return { | |
b2a0452d | 126 | timestamp: commandParams?.timestamp ?? new Date(), |
6e939d9e JB |
127 | connectorStatus: commandParams?.connectorStatus, |
128 | evseId: commandParams?.evseId, | |
129 | connectorId: commandParams?.connectorId, | |
130 | } as unknown as Request; | |
953d6b02 JB |
131 | default: |
132 | // OCPPError usage here is debatable: it's an error in the OCPP stack but not targeted to sendError(). | |
133 | throw new OCPPError( | |
134 | ErrorType.NOT_SUPPORTED, | |
135 | // eslint-disable-next-line @typescript-eslint/restrict-template-expressions | |
136 | `Unsupported OCPP command '${commandName}'`, | |
137 | commandName, | |
138 | commandParams | |
139 | ); | |
140 | } | |
141 | } | |
e9a4164c JB |
142 | |
143 | private parseJsonSchemaFile<T extends JsonType>(relativePath: string): JSONSchemaType<T> { | |
144 | return JSON.parse( | |
145 | fs.readFileSync( | |
146 | path.resolve(path.dirname(fileURLToPath(import.meta.url)), relativePath), | |
147 | 'utf8' | |
148 | ) | |
149 | ) as JSONSchemaType<T>; | |
150 | } | |
953d6b02 | 151 | } |