X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fcharging-station%2Focpp%2F1.6%2FOCPP16IncomingRequestService.ts;h=b67090af8fc6a9e7a5794cda32f6ed152c9e0645;hb=cc6e8ab5f669ff49b1d476efffc509be8128bccc;hp=37457ceea91c3549dd69b593602a8d67ece7d7a4;hpb=e81916227dc1a059ae4080cdb5fb4c0ef383788d;p=e-mobility-charging-stations-simulator.git diff --git a/src/charging-station/ocpp/1.6/OCPP16IncomingRequestService.ts b/src/charging-station/ocpp/1.6/OCPP16IncomingRequestService.ts index 37457cee..b67090af 100644 --- a/src/charging-station/ocpp/1.6/OCPP16IncomingRequestService.ts +++ b/src/charging-station/ocpp/1.6/OCPP16IncomingRequestService.ts @@ -21,8 +21,12 @@ import { ChangeAvailabilityResponse, ChangeConfigurationResponse, ClearChargingProfileResponse, + DiagnosticsStatusNotificationResponse, GetConfigurationResponse, GetDiagnosticsResponse, + OCPP16BootNotificationResponse, + OCPP16HeartbeatResponse, + OCPP16StatusNotificationResponse, OCPP16TriggerMessageResponse, SetChargingProfileResponse, UnlockConnectorResponse, @@ -34,7 +38,10 @@ import { import { Client, FTPResponse } from 'basic-ftp'; import { OCPP16AuthorizationStatus, + OCPP16AuthorizeResponse, + OCPP16StartTransactionResponse, OCPP16StopTransactionReason, + OCPP16StopTransactionResponse, } from '../../../types/ocpp/1.6/Transaction'; import type ChargingStation from '../../ChargingStation'; @@ -43,8 +50,11 @@ import { DefaultResponse } from '../../../types/ocpp/Responses'; import { ErrorType } from '../../../types/ocpp/ErrorType'; import { IncomingRequestHandler } from '../../../types/ocpp/Requests'; import { JsonType } from '../../../types/JsonType'; +import { OCPP16ChargePointErrorCode } from '../../../types/ocpp/1.6/ChargePointErrorCode'; import { OCPP16ChargePointStatus } from '../../../types/ocpp/1.6/ChargePointStatus'; import { OCPP16DiagnosticsStatus } from '../../../types/ocpp/1.6/DiagnosticsStatus'; +import { OCPP16MeterValuesResponse } from '../../../types/ocpp/1.6/MeterValues'; +import { OCPP16ServiceUtils } from './OCPP16ServiceUtils'; import { OCPP16StandardParametersKey } from '../../../types/ocpp/1.6/Configuration'; import { OCPPConfigurationKey } from '../../../types/ocpp/Configuration'; import OCPPError from '../../../exception/OCPPError'; @@ -201,20 +211,49 @@ export default class OCPP16IncomingRequestService extends OCPPIncomingRequestSer } if (this.chargingStation.getConnectorStatus(connectorId)?.transactionStarted) { const transactionId = this.chargingStation.getConnectorStatus(connectorId).transactionId; - const stopResponse = await this.chargingStation.ocppRequestService.sendStopTransaction( - transactionId, - this.chargingStation.getEnergyActiveImportRegisterByTransactionId(transactionId), - this.chargingStation.getTransactionIdTag(transactionId), - OCPP16StopTransactionReason.UNLOCK_COMMAND - ); + if ( + this.chargingStation.getBeginEndMeterValues() && + this.chargingStation.getOcppStrictCompliance() && + !this.chargingStation.getOutOfOrderEndMeterValues() + ) { + // FIXME: Implement OCPP version agnostic helpers + const transactionEndMeterValue = OCPP16ServiceUtils.buildTransactionEndMeterValue( + this.chargingStation, + connectorId, + this.chargingStation.getEnergyActiveImportRegisterByTransactionId(transactionId) + ); + await this.chargingStation.ocppRequestService.sendMessageHandler( + OCPP16RequestCommand.METER_VALUES, + { + connectorId, + transactionId, + meterValue: transactionEndMeterValue, + } + ); + } + const stopResponse = + await this.chargingStation.ocppRequestService.sendMessageHandler( + OCPP16RequestCommand.STOP_TRANSACTION, + { + transactionId, + meterStop: + this.chargingStation.getEnergyActiveImportRegisterByTransactionId(transactionId), + idTag: this.chargingStation.getTransactionIdTag(transactionId), + reason: OCPP16StopTransactionReason.UNLOCK_COMMAND, + } + ); if (stopResponse.idTagInfo?.status === OCPP16AuthorizationStatus.ACCEPTED) { return Constants.OCPP_RESPONSE_UNLOCKED; } return Constants.OCPP_RESPONSE_UNLOCK_FAILED; } - await this.chargingStation.ocppRequestService.sendStatusNotification( - connectorId, - OCPP16ChargePointStatus.AVAILABLE + await this.chargingStation.ocppRequestService.sendMessageHandler( + OCPP16RequestCommand.STATUS_NOTIFICATION, + { + connectorId, + status: OCPP16ChargePointStatus.AVAILABLE, + errorCode: OCPP16ChargePointErrorCode.NO_ERROR, + } ); this.chargingStation.getConnectorStatus(connectorId).status = OCPP16ChargePointStatus.AVAILABLE; return Constants.OCPP_RESPONSE_UNLOCKED; @@ -226,7 +265,7 @@ export default class OCPP16IncomingRequestService extends OCPPIncomingRequestSer const configurationKey: OCPPConfigurationKey[] = []; const unknownKey: string[] = []; if (Utils.isEmptyArray(commandPayload.key)) { - for (const configuration of this.chargingStation.configuration.configurationKey) { + for (const configuration of this.chargingStation.ocppConfiguration.configurationKey) { if (Utils.isUndefined(configuration.visible)) { configuration.visible = true; } @@ -272,7 +311,7 @@ export default class OCPP16IncomingRequestService extends OCPPIncomingRequestSer if (!Utils.isString(commandPayload.key)) { logger.error( `${this.chargingStation.logPrefix()} ${ - OCPP16RequestCommand.CHANGE_CONFIGURATION + OCPP16IncomingRequestCommand.CHANGE_CONFIGURATION } request key field is not a string:`, commandPayload ); @@ -280,7 +319,7 @@ export default class OCPP16IncomingRequestService extends OCPPIncomingRequestSer if (!Utils.isString(commandPayload.value)) { logger.error( `${this.chargingStation.logPrefix()} ${ - OCPP16RequestCommand.CHANGE_CONFIGURATION + OCPP16IncomingRequestCommand.CHANGE_CONFIGURATION } request value field is not a string:`, commandPayload ); @@ -291,12 +330,13 @@ export default class OCPP16IncomingRequestService extends OCPPIncomingRequestSer } else if (keyToChange && keyToChange.readonly) { return Constants.OCPP_CONFIGURATION_RESPONSE_REJECTED; } else if (keyToChange && !keyToChange.readonly) { - const keyIndex = this.chargingStation.configuration.configurationKey.indexOf(keyToChange); let valueChanged = false; - if ( - this.chargingStation.configuration.configurationKey[keyIndex].value !== commandPayload.value - ) { - this.chargingStation.configuration.configurationKey[keyIndex].value = commandPayload.value; + if (keyToChange.value !== commandPayload.value) { + this.chargingStation.setConfigurationKeyValue( + commandPayload.key, + commandPayload.value, + true + ); valueChanged = true; } let triggerHeartbeatRestart = false; @@ -367,7 +407,8 @@ export default class OCPP16IncomingRequestService extends OCPPIncomingRequestSer private handleRequestClearChargingProfile( commandPayload: ClearChargingProfileRequest ): ClearChargingProfileResponse { - if (!this.chargingStation.getConnectorStatus(commandPayload.connectorId)) { + const connectorStatus = this.chargingStation.getConnectorStatus(commandPayload.connectorId); + if (!connectorStatus) { logger.error( `${this.chargingStation.logPrefix()} Trying to clear a charging profile(s) to a non existing connector Id ${ commandPayload.connectorId @@ -375,16 +416,11 @@ export default class OCPP16IncomingRequestService extends OCPPIncomingRequestSer ); return Constants.OCPP_CLEAR_CHARGING_PROFILE_RESPONSE_UNKNOWN; } - if ( - commandPayload.connectorId && - !Utils.isEmptyArray( - this.chargingStation.getConnectorStatus(commandPayload.connectorId).chargingProfiles - ) - ) { - this.chargingStation.getConnectorStatus(commandPayload.connectorId).chargingProfiles = []; + if (commandPayload.connectorId && !Utils.isEmptyArray(connectorStatus.chargingProfiles)) { + connectorStatus.chargingProfiles = []; logger.debug( `${this.chargingStation.logPrefix()} Charging profile(s) cleared, dump their stack: %j`, - this.chargingStation.getConnectorStatus(commandPayload.connectorId).chargingProfiles + connectorStatus.chargingProfiles ); return Constants.OCPP_CLEAR_CHARGING_PROFILE_RESPONSE_ACCEPTED; } @@ -420,13 +456,10 @@ export default class OCPP16IncomingRequestService extends OCPPIncomingRequestSer clearCurrentCP = true; } if (clearCurrentCP) { - this.chargingStation.getConnectorStatus( - commandPayload.connectorId - ).chargingProfiles[index] = {} as OCPP16ChargingProfile; + connectorStatus.chargingProfiles[index] = {} as OCPP16ChargingProfile; logger.debug( `${this.chargingStation.logPrefix()} Charging profile(s) cleared, dump their stack: %j`, - this.chargingStation.getConnectorStatus(commandPayload.connectorId) - .chargingProfiles + connectorStatus.chargingProfiles ); clearedCP = true; } @@ -462,9 +495,13 @@ export default class OCPP16IncomingRequestService extends OCPPIncomingRequestSer } this.chargingStation.getConnectorStatus(id).availability = commandPayload.type; if (response === Constants.OCPP_AVAILABILITY_RESPONSE_ACCEPTED) { - await this.chargingStation.ocppRequestService.sendStatusNotification( - id, - chargePointStatus + await this.chargingStation.ocppRequestService.sendMessageHandler( + OCPP16RequestCommand.STATUS_NOTIFICATION, + { + connectorId: id, + status: chargePointStatus, + errorCode: OCPP16ChargePointErrorCode.NO_ERROR, + } ); this.chargingStation.getConnectorStatus(id).status = chargePointStatus; } @@ -483,9 +520,9 @@ export default class OCPP16IncomingRequestService extends OCPPIncomingRequestSer return Constants.OCPP_AVAILABILITY_RESPONSE_SCHEDULED; } this.chargingStation.getConnectorStatus(connectorId).availability = commandPayload.type; - await this.chargingStation.ocppRequestService.sendStatusNotification( - connectorId, - chargePointStatus + await this.chargingStation.ocppRequestService.sendMessageHandler( + OCPP16RequestCommand.STATUS_NOTIFICATION, + { connectorId, status: chargePointStatus, errorCode: OCPP16ChargePointErrorCode.NO_ERROR } ); this.chargingStation.getConnectorStatus(connectorId).status = chargePointStatus; return Constants.OCPP_AVAILABILITY_RESPONSE_ACCEPTED; @@ -496,18 +533,19 @@ export default class OCPP16IncomingRequestService extends OCPPIncomingRequestSer private async handleRequestRemoteStartTransaction( commandPayload: RemoteStartTransactionRequest ): Promise { - const transactionConnectorId: number = commandPayload.connectorId; + const transactionConnectorId = commandPayload.connectorId; + const connectorStatus = this.chargingStation.getConnectorStatus(transactionConnectorId); if (transactionConnectorId) { - await this.chargingStation.ocppRequestService.sendStatusNotification( - transactionConnectorId, - OCPP16ChargePointStatus.PREPARING + await this.chargingStation.ocppRequestService.sendMessageHandler( + OCPP16RequestCommand.STATUS_NOTIFICATION, + { + connectorId: transactionConnectorId, + status: OCPP16ChargePointStatus.PREPARING, + errorCode: OCPP16ChargePointErrorCode.NO_ERROR, + } ); - this.chargingStation.getConnectorStatus(transactionConnectorId).status = - OCPP16ChargePointStatus.PREPARING; - if ( - this.chargingStation.isChargingStationAvailable() && - this.chargingStation.isConnectorAvailable(transactionConnectorId) - ) { + connectorStatus.status = OCPP16ChargePointStatus.PREPARING; + if (this.chargingStation.isChargingStationAvailable() && connectorStatus) { // Check if authorized if (this.chargingStation.getAuthorizeRemoteTxRequests()) { let authorized = false; @@ -516,16 +554,18 @@ export default class OCPP16IncomingRequestService extends OCPPIncomingRequestSer this.chargingStation.hasAuthorizedTags() && this.chargingStation.authorizedTags.find((value) => value === commandPayload.idTag) ) { - this.chargingStation.getConnectorStatus(transactionConnectorId).localAuthorizeIdTag = - commandPayload.idTag; - this.chargingStation.getConnectorStatus(transactionConnectorId).idTagLocalAuthorized = - true; + connectorStatus.localAuthorizeIdTag = commandPayload.idTag; + connectorStatus.idTagLocalAuthorized = true; authorized = true; } else if (this.chargingStation.getMayAuthorizeAtRemoteStart()) { - const authorizeResponse = await this.chargingStation.ocppRequestService.sendAuthorize( - transactionConnectorId, - commandPayload.idTag - ); + connectorStatus.authorizeIdTag = commandPayload.idTag; + const authorizeResponse: OCPP16AuthorizeResponse = + await this.chargingStation.ocppRequestService.sendMessageHandler( + OCPP16RequestCommand.AUTHORIZE, + { + idTag: commandPayload.idTag, + } + ); if (authorizeResponse?.idTagInfo?.status === OCPP16AuthorizationStatus.ACCEPTED) { authorized = true; } @@ -542,14 +582,15 @@ export default class OCPP16IncomingRequestService extends OCPPIncomingRequestSer commandPayload.chargingProfile ) ) { - this.chargingStation.getConnectorStatus( - transactionConnectorId - ).transactionRemoteStarted = true; + connectorStatus.transactionRemoteStarted = true; if ( ( - await this.chargingStation.ocppRequestService.sendStartTransaction( - transactionConnectorId, - commandPayload.idTag + await this.chargingStation.ocppRequestService.sendMessageHandler( + OCPP16RequestCommand.START_TRANSACTION, + { + connectorId: transactionConnectorId, + idTag: commandPayload.idTag, + } ) ).idTagInfo.status === OCPP16AuthorizationStatus.ACCEPTED ) { @@ -586,13 +627,15 @@ export default class OCPP16IncomingRequestService extends OCPPIncomingRequestSer commandPayload.chargingProfile ) ) { - this.chargingStation.getConnectorStatus(transactionConnectorId).transactionRemoteStarted = - true; + connectorStatus.transactionRemoteStarted = true; if ( ( - await this.chargingStation.ocppRequestService.sendStartTransaction( - transactionConnectorId, - commandPayload.idTag + await this.chargingStation.ocppRequestService.sendMessageHandler( + OCPP16RequestCommand.START_TRANSACTION, + { + connectorId: transactionConnectorId, + idTag: commandPayload.idTag, + } ) ).idTagInfo.status === OCPP16AuthorizationStatus.ACCEPTED ) { @@ -633,9 +676,13 @@ export default class OCPP16IncomingRequestService extends OCPPIncomingRequestSer this.chargingStation.getConnectorStatus(connectorId).status !== OCPP16ChargePointStatus.AVAILABLE ) { - await this.chargingStation.ocppRequestService.sendStatusNotification( - connectorId, - OCPP16ChargePointStatus.AVAILABLE + await this.chargingStation.ocppRequestService.sendMessageHandler( + OCPP16RequestCommand.STATUS_NOTIFICATION, + { + connectorId, + status: OCPP16ChargePointStatus.AVAILABLE, + errorCode: OCPP16ChargePointErrorCode.NO_ERROR, + } ); this.chargingStation.getConnectorStatus(connectorId).status = OCPP16ChargePointStatus.AVAILABLE; @@ -686,16 +733,44 @@ export default class OCPP16IncomingRequestService extends OCPPIncomingRequestSer connectorId > 0 && this.chargingStation.getConnectorStatus(connectorId)?.transactionId === transactionId ) { - await this.chargingStation.ocppRequestService.sendStatusNotification( - connectorId, - OCPP16ChargePointStatus.FINISHING + await this.chargingStation.ocppRequestService.sendMessageHandler( + OCPP16RequestCommand.STATUS_NOTIFICATION, + { + connectorId, + status: OCPP16ChargePointStatus.FINISHING, + errorCode: OCPP16ChargePointErrorCode.NO_ERROR, + } ); this.chargingStation.getConnectorStatus(connectorId).status = OCPP16ChargePointStatus.FINISHING; - await this.chargingStation.ocppRequestService.sendStopTransaction( - transactionId, - this.chargingStation.getEnergyActiveImportRegisterByTransactionId(transactionId), - this.chargingStation.getTransactionIdTag(transactionId) + if ( + this.chargingStation.getBeginEndMeterValues() && + this.chargingStation.getOcppStrictCompliance() && + !this.chargingStation.getOutOfOrderEndMeterValues() + ) { + // FIXME: Implement OCPP version agnostic helpers + const transactionEndMeterValue = OCPP16ServiceUtils.buildTransactionEndMeterValue( + this.chargingStation, + connectorId, + this.chargingStation.getEnergyActiveImportRegisterByTransactionId(transactionId) + ); + await this.chargingStation.ocppRequestService.sendMessageHandler( + OCPP16RequestCommand.METER_VALUES, + { + connectorId, + transactionId, + meterValue: transactionEndMeterValue, + } + ); + } + await this.chargingStation.ocppRequestService.sendMessageHandler( + OCPP16RequestCommand.STOP_TRANSACTION, + { + transactionId, + meterStop: + this.chargingStation.getEnergyActiveImportRegisterByTransactionId(transactionId), + idTag: this.chargingStation.getTransactionIdTag(transactionId), + } ); return Constants.OCPP_RESPONSE_ACCEPTED; } @@ -745,8 +820,11 @@ export default class OCPP16IncomingRequestService extends OCPPIncomingRequestSer info.bytes / 1024 } bytes transferred from diagnostics archive ${info.name}` ); - await this.chargingStation.ocppRequestService.sendDiagnosticsStatusNotification( - OCPP16DiagnosticsStatus.Uploading + await this.chargingStation.ocppRequestService.sendMessageHandler( + OCPP16RequestCommand.DIAGNOSTICS_STATUS_NOTIFICATION, + { + status: OCPP16DiagnosticsStatus.Uploading, + } ); }); uploadResponse = await ftpClient.uploadFrom( @@ -754,8 +832,11 @@ export default class OCPP16IncomingRequestService extends OCPPIncomingRequestSer uri.pathname + diagnosticsArchive ); if (uploadResponse.code === 226) { - await this.chargingStation.ocppRequestService.sendDiagnosticsStatusNotification( - OCPP16DiagnosticsStatus.Uploaded + await this.chargingStation.ocppRequestService.sendMessageHandler( + OCPP16RequestCommand.DIAGNOSTICS_STATUS_NOTIFICATION, + { + status: OCPP16DiagnosticsStatus.Uploaded, + } ); if (ftpClient) { ftpClient.close(); @@ -778,8 +859,11 @@ export default class OCPP16IncomingRequestService extends OCPPIncomingRequestSer OCPP16IncomingRequestCommand.GET_DIAGNOSTICS ); } catch (error) { - await this.chargingStation.ocppRequestService.sendDiagnosticsStatusNotification( - OCPP16DiagnosticsStatus.UploadFailed + await this.chargingStation.ocppRequestService.sendMessageHandler( + OCPP16RequestCommand.DIAGNOSTICS_STATUS_NOTIFICATION, + { + status: OCPP16DiagnosticsStatus.UploadFailed, + } ); if (ftpClient) { ftpClient.close(); @@ -796,8 +880,11 @@ export default class OCPP16IncomingRequestService extends OCPPIncomingRequestSer uri.protocol } to transfer the diagnostic logs archive` ); - await this.chargingStation.ocppRequestService.sendDiagnosticsStatusNotification( - OCPP16DiagnosticsStatus.UploadFailed + await this.chargingStation.ocppRequestService.sendMessageHandler( + OCPP16RequestCommand.DIAGNOSTICS_STATUS_NOTIFICATION, + { + status: OCPP16DiagnosticsStatus.UploadFailed, + } ); return Constants.OCPP_RESPONSE_EMPTY; } @@ -811,18 +898,30 @@ export default class OCPP16IncomingRequestService extends OCPPIncomingRequestSer case MessageTrigger.BootNotification: setTimeout(() => { this.chargingStation.ocppRequestService - .sendBootNotification( - this.chargingStation.getBootNotificationRequest().chargePointModel, - this.chargingStation.getBootNotificationRequest().chargePointVendor, - this.chargingStation.getBootNotificationRequest().chargeBoxSerialNumber, - this.chargingStation.getBootNotificationRequest().firmwareVersion, - this.chargingStation.getBootNotificationRequest().chargePointSerialNumber, - this.chargingStation.getBootNotificationRequest().iccid, - this.chargingStation.getBootNotificationRequest().imsi, - this.chargingStation.getBootNotificationRequest().meterSerialNumber, - this.chargingStation.getBootNotificationRequest().meterType, - { triggerMessage: true } + .sendMessageHandler( + OCPP16RequestCommand.BOOT_NOTIFICATION, + { + chargePointModel: + this.chargingStation.getBootNotificationRequest().chargePointModel, + chargePointVendor: + this.chargingStation.getBootNotificationRequest().chargePointVendor, + chargeBoxSerialNumber: + this.chargingStation.getBootNotificationRequest().chargeBoxSerialNumber, + firmwareVersion: + this.chargingStation.getBootNotificationRequest().firmwareVersion, + chargePointSerialNumber: + this.chargingStation.getBootNotificationRequest().chargePointSerialNumber, + iccid: this.chargingStation.getBootNotificationRequest().iccid, + imsi: this.chargingStation.getBootNotificationRequest().imsi, + meterSerialNumber: + this.chargingStation.getBootNotificationRequest().meterSerialNumber, + meterType: this.chargingStation.getBootNotificationRequest().meterType, + }, + { skipBufferingOnError: true, triggerMessage: true } ) + .then((value) => { + this.chargingStation.bootNotificationResponse = value; + }) .catch(() => { /* This is intentional */ }); @@ -831,7 +930,9 @@ export default class OCPP16IncomingRequestService extends OCPPIncomingRequestSer case MessageTrigger.Heartbeat: setTimeout(() => { this.chargingStation.ocppRequestService - .sendHeartbeat({ triggerMessage: true }) + .sendMessageHandler(OCPP16RequestCommand.HEARTBEAT, null, { + triggerMessage: true, + }) .catch(() => { /* This is intentional */ });