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