Commit | Line | Data |
---|---|---|
c8eeb62b JB |
1 | // Partial Copyright Jerome Benoit. 2021. All Rights Reserved. |
2 | ||
c0560973 | 3 | import { AuthorizeRequest, OCPP16AuthorizationStatus, OCPP16AuthorizeResponse, OCPP16StartTransactionResponse, OCPP16StopTransactionResponse, StartTransactionRequest, StopTransactionRequest } from '../../../types/ocpp/1.6/Transaction'; |
a3868ec4 | 4 | import { HeartbeatRequest, OCPP16RequestCommand, StatusNotificationRequest } from '../../../types/ocpp/1.6/Requests'; |
efa43e52 | 5 | import { HeartbeatResponse, OCPP16BootNotificationResponse, OCPP16RegistrationStatus, StatusNotificationResponse } from '../../../types/ocpp/1.6/Responses'; |
c0560973 JB |
6 | import { MeterValuesRequest, MeterValuesResponse } from '../../../types/ocpp/1.6/MeterValues'; |
7 | ||
58144adb | 8 | import ChargingStation from '../../ChargingStation'; |
a4bc2942 | 9 | import { ErrorType } from '../../../types/ocpp/ErrorType'; |
d1888640 | 10 | import { JsonType } from '../../../types/JsonType'; |
c0560973 | 11 | import { OCPP16ChargePointStatus } from '../../../types/ocpp/1.6/ChargePointStatus'; |
fd0c36fa | 12 | import { OCPP16ServiceUtils } from './OCPP16ServiceUtils'; |
c0560973 | 13 | import { OCPP16StandardParametersKey } from '../../../types/ocpp/1.6/Configuration'; |
e58068fd | 14 | import OCPPError from '../../../exception/OCPPError'; |
c0560973 | 15 | import OCPPResponseService from '../OCPPResponseService'; |
58144adb | 16 | import { ResponseHandler } from '../../../types/ocpp/Responses'; |
c0560973 JB |
17 | import Utils from '../../../utils/Utils'; |
18 | import logger from '../../../utils/Logger'; | |
19 | ||
20 | export default class OCPP16ResponseService extends OCPPResponseService { | |
58144adb JB |
21 | private responseHandlers: Map<OCPP16RequestCommand, ResponseHandler>; |
22 | ||
23 | constructor(chargingStation: ChargingStation) { | |
24 | super(chargingStation); | |
25 | this.responseHandlers = new Map<OCPP16RequestCommand, ResponseHandler>([ | |
26 | [OCPP16RequestCommand.BOOT_NOTIFICATION, this.handleResponseBootNotification.bind(this)], | |
27 | [OCPP16RequestCommand.HEARTBEAT, this.handleResponseHeartbeat.bind(this)], | |
28 | [OCPP16RequestCommand.AUTHORIZE, this.handleResponseAuthorize.bind(this)], | |
29 | [OCPP16RequestCommand.START_TRANSACTION, this.handleResponseStartTransaction.bind(this)], | |
30 | [OCPP16RequestCommand.STOP_TRANSACTION, this.handleResponseStopTransaction.bind(this)], | |
31 | [OCPP16RequestCommand.STATUS_NOTIFICATION, this.handleResponseStatusNotification.bind(this)], | |
331e20bb | 32 | [OCPP16RequestCommand.METER_VALUES, this.handleResponseMeterValues.bind(this)] |
58144adb JB |
33 | ]); |
34 | } | |
35 | ||
d1888640 | 36 | public async handleResponse(commandName: OCPP16RequestCommand, payload: JsonType | string, requestPayload: JsonType): Promise<void> { |
124f3553 JB |
37 | if (this.chargingStation.isRegistered() || commandName === OCPP16RequestCommand.BOOT_NOTIFICATION) { |
38 | if (this.responseHandlers.has(commandName)) { | |
39 | try { | |
40 | await this.responseHandlers.get(commandName)(payload, requestPayload); | |
41 | } catch (error) { | |
42 | logger.error(this.chargingStation.logPrefix() + ' Handle request response error: %j', error); | |
43 | throw error; | |
44 | } | |
45 | } else { | |
46 | // Throw exception | |
47 | throw new OCPPError(ErrorType.NOT_IMPLEMENTED, `${commandName} is not implemented to handle request response payload ${JSON.stringify(payload, null, 2)}`, commandName); | |
887fef76 | 48 | } |
c0560973 | 49 | } else { |
124f3553 | 50 | throw new OCPPError(ErrorType.SECURITY_ERROR, `The charging station is not registered on the central server. ${commandName} cannot be not issued to handle request response payload ${JSON.stringify(payload, null, 2)}`, commandName); |
c0560973 JB |
51 | } |
52 | } | |
53 | ||
624df199 | 54 | private handleResponseBootNotification(payload: OCPP16BootNotificationResponse): void { |
c0560973 | 55 | if (payload.status === OCPP16RegistrationStatus.ACCEPTED) { |
c0560973 | 56 | this.chargingStation.addConfigurationKey(OCPP16StandardParametersKey.HeartBeatInterval, payload.interval.toString()); |
12fc74d6 | 57 | this.chargingStation.addConfigurationKey(OCPP16StandardParametersKey.HeartbeatInterval, payload.interval.toString(), { visible: false }); |
54b1efe0 | 58 | this.chargingStation.heartbeatSetInterval ? this.chargingStation.restartHeartbeat() : this.chargingStation.startHeartbeat(); |
c0560973 JB |
59 | } else if (payload.status === OCPP16RegistrationStatus.PENDING) { |
60 | logger.info(this.chargingStation.logPrefix() + ' Charging station in pending state on the central server'); | |
61 | } else { | |
54b1efe0 | 62 | logger.warn(this.chargingStation.logPrefix() + ' Charging station rejected by the central server'); |
c0560973 JB |
63 | } |
64 | } | |
65 | ||
58144adb JB |
66 | private handleResponseHeartbeat(payload: HeartbeatResponse, requestPayload: HeartbeatRequest): void { |
67 | logger.debug(this.chargingStation.logPrefix() + ' Heartbeat response received: %j to Heartbeat request: %j', payload, requestPayload); | |
68 | } | |
69 | ||
70 | private handleResponseAuthorize(payload: OCPP16AuthorizeResponse, requestPayload: AuthorizeRequest): void { | |
71 | let authorizeConnectorId: number; | |
734d790d JB |
72 | for (const connectorId of this.chargingStation.connectors.keys()) { |
73 | if (connectorId > 0 && this.chargingStation.getConnectorStatus(connectorId)?.authorizeIdTag === requestPayload.idTag) { | |
74 | authorizeConnectorId = connectorId; | |
58144adb JB |
75 | break; |
76 | } | |
77 | } | |
78 | if (payload.idTagInfo.status === OCPP16AuthorizationStatus.ACCEPTED) { | |
a2653482 | 79 | this.chargingStation.getConnectorStatus(authorizeConnectorId).idTagAuthorized = true; |
58144adb JB |
80 | logger.debug(`${this.chargingStation.logPrefix()} IdTag ${requestPayload.idTag} authorized on connector ${authorizeConnectorId}`); |
81 | } else { | |
a2653482 | 82 | this.chargingStation.getConnectorStatus(authorizeConnectorId).idTagAuthorized = false; |
734d790d | 83 | delete this.chargingStation.getConnectorStatus(authorizeConnectorId).authorizeIdTag; |
58144adb JB |
84 | logger.debug(`${this.chargingStation.logPrefix()} IdTag ${requestPayload.idTag} refused with status ${payload.idTagInfo.status} on connector ${authorizeConnectorId}`); |
85 | } | |
86 | } | |
87 | ||
c0560973 JB |
88 | private async handleResponseStartTransaction(payload: OCPP16StartTransactionResponse, requestPayload: StartTransactionRequest): Promise<void> { |
89 | const connectorId = requestPayload.connectorId; | |
90 | ||
91 | let transactionConnectorId: number; | |
734d790d JB |
92 | for (const id of this.chargingStation.connectors.keys()) { |
93 | if (id > 0 && id === connectorId) { | |
94 | transactionConnectorId = id; | |
c0560973 JB |
95 | break; |
96 | } | |
97 | } | |
98 | if (!transactionConnectorId) { | |
99 | logger.error(this.chargingStation.logPrefix() + ' Trying to start a transaction on a non existing connector Id ' + connectorId.toString()); | |
100 | return; | |
101 | } | |
a2653482 JB |
102 | if (this.chargingStation.getConnectorStatus(connectorId).transactionRemoteStarted && this.chargingStation.getAuthorizeRemoteTxRequests() |
103 | && this.chargingStation.getLocalAuthListEnabled() && this.chargingStation.hasAuthorizedTags() && !this.chargingStation.getConnectorStatus(connectorId).idTagLocalAuthorized) { | |
104 | logger.error(this.chargingStation.logPrefix() + ' Trying to start a transaction with a not local authorized idTag ' + this.chargingStation.getConnectorStatus(connectorId).localAuthorizeIdTag + ' on connector Id ' + connectorId.toString()); | |
105 | await this.resetConnectorOnStartTransactionError(connectorId); | |
106 | return; | |
107 | } | |
108 | if (this.chargingStation.getConnectorStatus(connectorId).transactionRemoteStarted && this.chargingStation.getAuthorizeRemoteTxRequests() | |
109 | && this.chargingStation.getMayAuthorizeAtRemoteStart() && !this.chargingStation.getConnectorStatus(connectorId).idTagLocalAuthorized | |
110 | && !this.chargingStation.getConnectorStatus(connectorId).idTagAuthorized) { | |
111 | logger.error(this.chargingStation.logPrefix() + ' Trying to start a transaction with a not authorized idTag ' + this.chargingStation.getConnectorStatus(connectorId).authorizeIdTag + ' on connector Id ' + connectorId.toString()); | |
112 | await this.resetConnectorOnStartTransactionError(connectorId); | |
113 | return; | |
114 | } | |
115 | if (this.chargingStation.getConnectorStatus(connectorId).idTagAuthorized && this.chargingStation.getConnectorStatus(connectorId).authorizeIdTag !== requestPayload.idTag) { | |
734d790d | 116 | logger.error(this.chargingStation.logPrefix() + ' Trying to start a transaction with an idTag ' + requestPayload.idTag + ' different from the authorize request one ' + this.chargingStation.getConnectorStatus(connectorId).authorizeIdTag + ' on connector Id ' + connectorId.toString()); |
a2653482 JB |
117 | await this.resetConnectorOnStartTransactionError(connectorId); |
118 | return; | |
119 | } | |
120 | if (this.chargingStation.getConnectorStatus(connectorId).idTagLocalAuthorized | |
121 | && this.chargingStation.getConnectorStatus(connectorId).localAuthorizeIdTag !== requestPayload.idTag) { | |
122 | logger.error(this.chargingStation.logPrefix() + ' Trying to start a transaction with an idTag ' + requestPayload.idTag + ' different from the local authorized one ' + this.chargingStation.getConnectorStatus(connectorId).localAuthorizeIdTag + ' on connector Id ' + connectorId.toString()); | |
123 | await this.resetConnectorOnStartTransactionError(connectorId); | |
163547b1 JB |
124 | return; |
125 | } | |
734d790d JB |
126 | if (this.chargingStation.getConnectorStatus(connectorId)?.transactionStarted) { |
127 | logger.debug(this.chargingStation.logPrefix() + ' Trying to start a transaction on an already used connector ' + connectorId.toString() + ': %j', this.chargingStation.getConnectorStatus(connectorId)); | |
c0560973 JB |
128 | return; |
129 | } | |
734d790d JB |
130 | if (this.chargingStation.getConnectorStatus(connectorId)?.status !== OCPP16ChargePointStatus.AVAILABLE |
131 | && this.chargingStation.getConnectorStatus(connectorId)?.status !== OCPP16ChargePointStatus.PREPARING) { | |
132 | logger.error(`${this.chargingStation.logPrefix()} Trying to start a transaction on connector ${connectorId.toString()} with status ${this.chargingStation.getConnectorStatus(connectorId)?.status}`); | |
290d006c JB |
133 | return; |
134 | } | |
f3a6f63b JB |
135 | if (!Number.isInteger(payload.transactionId)) { |
136 | logger.warn(`${this.chargingStation.logPrefix()} Trying to start a transaction on connector ${connectorId.toString()} with a non integer transaction Id ${payload.transactionId}, converting to integer`); | |
137 | payload.transactionId = Utils.convertToInt(payload.transactionId); | |
138 | } | |
c0560973 | 139 | |
f0c6ed89 | 140 | if (payload.idTagInfo?.status === OCPP16AuthorizationStatus.ACCEPTED) { |
734d790d JB |
141 | this.chargingStation.getConnectorStatus(connectorId).transactionStarted = true; |
142 | this.chargingStation.getConnectorStatus(connectorId).transactionId = payload.transactionId; | |
143 | this.chargingStation.getConnectorStatus(connectorId).transactionIdTag = requestPayload.idTag; | |
144 | this.chargingStation.getConnectorStatus(connectorId).transactionEnergyActiveImportRegisterValue = 0; | |
145 | this.chargingStation.getConnectorStatus(connectorId).transactionBeginMeterValue = OCPP16ServiceUtils.buildTransactionBeginMeterValue(this.chargingStation, connectorId, | |
fd0c36fa | 146 | requestPayload.meterStart); |
6ed92bc1 | 147 | this.chargingStation.getBeginEndMeterValues() && await this.chargingStation.ocppRequestService.sendTransactionBeginMeterValues(connectorId, payload.transactionId, |
734d790d | 148 | this.chargingStation.getConnectorStatus(connectorId).transactionBeginMeterValue); |
c0560973 | 149 | await this.chargingStation.ocppRequestService.sendStatusNotification(connectorId, OCPP16ChargePointStatus.CHARGING); |
734d790d | 150 | this.chargingStation.getConnectorStatus(connectorId).status = OCPP16ChargePointStatus.CHARGING; |
c0560973 JB |
151 | logger.info(this.chargingStation.logPrefix() + ' Transaction ' + payload.transactionId.toString() + ' STARTED on ' + this.chargingStation.stationInfo.chargingStationId + '#' + connectorId.toString() + ' for idTag ' + requestPayload.idTag); |
152 | if (this.chargingStation.stationInfo.powerSharedByConnectors) { | |
153 | this.chargingStation.stationInfo.powerDivider++; | |
154 | } | |
155 | const configuredMeterValueSampleInterval = this.chargingStation.getConfigurationKey(OCPP16StandardParametersKey.MeterValueSampleInterval); | |
156 | this.chargingStation.startMeterValues(connectorId, configuredMeterValueSampleInterval ? Utils.convertToInt(configuredMeterValueSampleInterval.value) * 1000 : 60000); | |
157 | } else { | |
54b1efe0 | 158 | logger.warn(this.chargingStation.logPrefix() + ' Starting transaction id ' + payload.transactionId.toString() + ' REJECTED with status ' + payload?.idTagInfo?.status + ', idTag ' + requestPayload.idTag); |
a2653482 JB |
159 | await this.resetConnectorOnStartTransactionError(connectorId); |
160 | } | |
161 | } | |
162 | ||
163 | private async resetConnectorOnStartTransactionError(connectorId: number): Promise<void> { | |
164 | this.chargingStation.resetConnectorStatus(connectorId); | |
165 | if (this.chargingStation.getConnectorStatus(connectorId).status !== OCPP16ChargePointStatus.AVAILABLE) { | |
166 | await this.chargingStation.ocppRequestService.sendStatusNotification(connectorId, OCPP16ChargePointStatus.AVAILABLE); | |
167 | this.chargingStation.getConnectorStatus(connectorId).status = OCPP16ChargePointStatus.AVAILABLE; | |
c0560973 JB |
168 | } |
169 | } | |
170 | ||
171 | private async handleResponseStopTransaction(payload: OCPP16StopTransactionResponse, requestPayload: StopTransactionRequest): Promise<void> { | |
172 | let transactionConnectorId: number; | |
734d790d JB |
173 | for (const connectorId of this.chargingStation.connectors.keys()) { |
174 | if (connectorId > 0 && this.chargingStation.getConnectorStatus(connectorId)?.transactionId === requestPayload.transactionId) { | |
175 | transactionConnectorId = connectorId; | |
c0560973 JB |
176 | break; |
177 | } | |
178 | } | |
179 | if (!transactionConnectorId) { | |
180 | logger.error(this.chargingStation.logPrefix() + ' Trying to stop a non existing transaction ' + requestPayload.transactionId.toString()); | |
181 | return; | |
182 | } | |
183 | if (payload.idTagInfo?.status === OCPP16AuthorizationStatus.ACCEPTED) { | |
6ed92bc1 | 184 | (this.chargingStation.getBeginEndMeterValues() && this.chargingStation.getOutOfOrderEndMeterValues()) |
fd0c36fa JB |
185 | && await this.chargingStation.ocppRequestService.sendTransactionEndMeterValues(transactionConnectorId, requestPayload.transactionId, |
186 | OCPP16ServiceUtils.buildTransactionEndMeterValue(this.chargingStation, transactionConnectorId, requestPayload.meterStop)); | |
c0560973 JB |
187 | if (!this.chargingStation.isChargingStationAvailable() || !this.chargingStation.isConnectorAvailable(transactionConnectorId)) { |
188 | await this.chargingStation.ocppRequestService.sendStatusNotification(transactionConnectorId, OCPP16ChargePointStatus.UNAVAILABLE); | |
734d790d | 189 | this.chargingStation.getConnectorStatus(transactionConnectorId).status = OCPP16ChargePointStatus.UNAVAILABLE; |
c0560973 JB |
190 | } else { |
191 | await this.chargingStation.ocppRequestService.sendStatusNotification(transactionConnectorId, OCPP16ChargePointStatus.AVAILABLE); | |
734d790d | 192 | this.chargingStation.getConnectorStatus(transactionConnectorId).status = OCPP16ChargePointStatus.AVAILABLE; |
c0560973 JB |
193 | } |
194 | if (this.chargingStation.stationInfo.powerSharedByConnectors) { | |
195 | this.chargingStation.stationInfo.powerDivider--; | |
196 | } | |
197 | logger.info(this.chargingStation.logPrefix() + ' Transaction ' + requestPayload.transactionId.toString() + ' STOPPED on ' + this.chargingStation.stationInfo.chargingStationId + '#' + transactionConnectorId.toString()); | |
a2653482 | 198 | this.chargingStation.resetConnectorStatus(transactionConnectorId); |
c0560973 | 199 | } else { |
54b1efe0 | 200 | logger.warn(this.chargingStation.logPrefix() + ' Stopping transaction id ' + requestPayload.transactionId.toString() + ' REJECTED with status ' + payload.idTagInfo?.status); |
c0560973 JB |
201 | } |
202 | } | |
203 | ||
204 | private handleResponseStatusNotification(payload: StatusNotificationRequest, requestPayload: StatusNotificationResponse): void { | |
205 | logger.debug(this.chargingStation.logPrefix() + ' Status notification response received: %j to StatusNotification request: %j', payload, requestPayload); | |
206 | } | |
207 | ||
208 | private handleResponseMeterValues(payload: MeterValuesRequest, requestPayload: MeterValuesResponse): void { | |
209 | logger.debug(this.chargingStation.logPrefix() + ' MeterValues response received: %j to MeterValues request: %j', payload, requestPayload); | |
210 | } | |
c0560973 | 211 | } |