X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fcharging-station%2Focpp%2F1.6%2FOCPP16ResponseService.ts;h=7898ce6e1448d5ae4692839fb9488e737ba07516;hb=d270cc878c61c42098557a0e03cc1620f74112de;hp=c4e7eef879993860e5f94cff257cf6e3150115ff;hpb=08f130a055123f5e47c59e1a64875f8cff44d020;p=e-mobility-charging-stations-simulator.git diff --git a/src/charging-station/ocpp/1.6/OCPP16ResponseService.ts b/src/charging-station/ocpp/1.6/OCPP16ResponseService.ts index c4e7eef8..7898ce6e 100644 --- a/src/charging-station/ocpp/1.6/OCPP16ResponseService.ts +++ b/src/charging-station/ocpp/1.6/OCPP16ResponseService.ts @@ -1,61 +1,185 @@ -// Partial Copyright Jerome Benoit. 2021. All Rights Reserved. +// Partial Copyright Jerome Benoit. 2021-2023. All Rights Reserved. +import fs from 'fs'; +import path from 'path'; +import { fileURLToPath } from 'url'; + +import type { JSONSchemaType } from 'ajv'; + +import OCPPError from '../../../exception/OCPPError'; +import type { JsonObject, JsonType } from '../../../types/JsonType'; +import { OCPP16ChargePointErrorCode } from '../../../types/ocpp/1.6/ChargePointErrorCode'; +import { OCPP16ChargePointStatus } from '../../../types/ocpp/1.6/ChargePointStatus'; +import { OCPP16StandardParametersKey } from '../../../types/ocpp/1.6/Configuration'; +import type { + OCPP16MeterValuesRequest, + OCPP16MeterValuesResponse, +} from '../../../types/ocpp/1.6/MeterValues'; import { - OCPP16AuthorizationStatus, - OCPP16AuthorizeRequest, - OCPP16AuthorizeResponse, - OCPP16StartTransactionRequest, - OCPP16StartTransactionResponse, - OCPP16StopTransactionRequest, - OCPP16StopTransactionResponse, -} from '../../../types/ocpp/1.6/Transaction'; -import { - OCPP16BootNotificationRequest, + type OCPP16BootNotificationRequest, OCPP16RequestCommand, - OCPP16StatusNotificationRequest, + type OCPP16StatusNotificationRequest, } from '../../../types/ocpp/1.6/Requests'; -import { +import type { + DiagnosticsStatusNotificationResponse, OCPP16BootNotificationResponse, - OCPP16RegistrationStatus, + OCPP16DataTransferResponse, + OCPP16HeartbeatResponse, OCPP16StatusNotificationResponse, } from '../../../types/ocpp/1.6/Responses'; import { - OCPP16MeterValuesRequest, - OCPP16MeterValuesResponse, -} from '../../../types/ocpp/1.6/MeterValues'; - -import type ChargingStation from '../../ChargingStation'; + OCPP16AuthorizationStatus, + type OCPP16AuthorizeRequest, + type OCPP16AuthorizeResponse, + type OCPP16StartTransactionRequest, + type OCPP16StartTransactionResponse, + type OCPP16StopTransactionRequest, + type OCPP16StopTransactionResponse, +} from '../../../types/ocpp/1.6/Transaction'; import { ErrorType } from '../../../types/ocpp/ErrorType'; -import { JsonType } from '../../../types/JsonType'; -import { OCPP16ChargePointErrorCode } from '../../../types/ocpp/1.6/ChargePointErrorCode'; -import { OCPP16ChargePointStatus } from '../../../types/ocpp/1.6/ChargePointStatus'; -import { OCPP16ServiceUtils } from './OCPP16ServiceUtils'; -import { OCPP16StandardParametersKey } from '../../../types/ocpp/1.6/Configuration'; -import OCPPError from '../../../exception/OCPPError'; -import OCPPResponseService from '../OCPPResponseService'; -import { ResponseHandler } from '../../../types/ocpp/Responses'; -import Utils from '../../../utils/Utils'; +import { OCPPVersion } from '../../../types/ocpp/OCPPVersion'; +import { RegistrationStatusEnumType, type ResponseHandler } from '../../../types/ocpp/Responses'; +import Constants from '../../../utils/Constants'; import logger from '../../../utils/Logger'; +import Utils from '../../../utils/Utils'; +import type ChargingStation from '../../ChargingStation'; +import { ChargingStationConfigurationUtils } from '../../ChargingStationConfigurationUtils'; +import OCPPResponseService from '../OCPPResponseService'; +import { OCPP16ServiceUtils } from './OCPP16ServiceUtils'; const moduleName = 'OCPP16ResponseService'; export default class OCPP16ResponseService extends OCPPResponseService { private responseHandlers: Map; + private jsonSchemas: Map>; public constructor() { if (new.target?.name === moduleName) { throw new TypeError(`Cannot construct ${new.target?.name} instances directly`); } - super(); + super(OCPPVersion.VERSION_16); this.responseHandlers = new Map([ [OCPP16RequestCommand.BOOT_NOTIFICATION, this.handleResponseBootNotification.bind(this)], - [OCPP16RequestCommand.HEARTBEAT, this.handleResponseHeartbeat.bind(this)], + [OCPP16RequestCommand.HEARTBEAT, this.emptyResponseHandler.bind(this)], [OCPP16RequestCommand.AUTHORIZE, this.handleResponseAuthorize.bind(this)], [OCPP16RequestCommand.START_TRANSACTION, this.handleResponseStartTransaction.bind(this)], [OCPP16RequestCommand.STOP_TRANSACTION, this.handleResponseStopTransaction.bind(this)], - [OCPP16RequestCommand.STATUS_NOTIFICATION, this.handleResponseStatusNotification.bind(this)], - [OCPP16RequestCommand.METER_VALUES, this.handleResponseMeterValues.bind(this)], + [OCPP16RequestCommand.STATUS_NOTIFICATION, this.emptyResponseHandler.bind(this)], + [OCPP16RequestCommand.METER_VALUES, this.emptyResponseHandler.bind(this)], + [OCPP16RequestCommand.DIAGNOSTICS_STATUS_NOTIFICATION, this.emptyResponseHandler.bind(this)], + [OCPP16RequestCommand.DATA_TRANSFER, this.emptyResponseHandler.bind(this)], + ]); + this.jsonSchemas = new Map>([ + [ + OCPP16RequestCommand.BOOT_NOTIFICATION, + JSON.parse( + fs.readFileSync( + path.resolve( + path.dirname(fileURLToPath(import.meta.url)), + '../../../assets/json-schemas/ocpp/1.6/BootNotificationResponse.json' + ), + 'utf8' + ) + ) as JSONSchemaType, + ], + [ + OCPP16RequestCommand.HEARTBEAT, + JSON.parse( + fs.readFileSync( + path.resolve( + path.dirname(fileURLToPath(import.meta.url)), + '../../../assets/json-schemas/ocpp/1.6/HeartbeatResponse.json' + ), + 'utf8' + ) + ) as JSONSchemaType, + ], + [ + OCPP16RequestCommand.AUTHORIZE, + JSON.parse( + fs.readFileSync( + path.resolve( + path.dirname(fileURLToPath(import.meta.url)), + '../../../assets/json-schemas/ocpp/1.6/AuthorizeResponse.json' + ), + 'utf8' + ) + ) as JSONSchemaType, + ], + [ + OCPP16RequestCommand.START_TRANSACTION, + JSON.parse( + fs.readFileSync( + path.resolve( + path.dirname(fileURLToPath(import.meta.url)), + '../../../assets/json-schemas/ocpp/1.6/StartTransactionResponse.json' + ), + 'utf8' + ) + ) as JSONSchemaType, + ], + [ + OCPP16RequestCommand.STOP_TRANSACTION, + JSON.parse( + fs.readFileSync( + path.resolve( + path.dirname(fileURLToPath(import.meta.url)), + '../../../assets/json-schemas/ocpp/1.6/StopTransactionResponse.json' + ), + 'utf8' + ) + ) as JSONSchemaType, + ], + [ + OCPP16RequestCommand.STATUS_NOTIFICATION, + JSON.parse( + fs.readFileSync( + path.resolve( + path.dirname(fileURLToPath(import.meta.url)), + '../../../assets/json-schemas/ocpp/1.6/StatusNotificationResponse.json' + ), + 'utf8' + ) + ) as JSONSchemaType, + ], + [ + OCPP16RequestCommand.METER_VALUES, + JSON.parse( + fs.readFileSync( + path.resolve( + path.dirname(fileURLToPath(import.meta.url)), + '../../../assets/json-schemas/ocpp/1.6/MeterValuesResponse.json' + ), + 'utf8' + ) + ) as JSONSchemaType, + ], + [ + OCPP16RequestCommand.DIAGNOSTICS_STATUS_NOTIFICATION, + JSON.parse( + fs.readFileSync( + path.resolve( + path.dirname(fileURLToPath(import.meta.url)), + '../../../assets/json-schemas/ocpp/1.6/DiagnosticsStatusNotificationResponse.json' + ), + 'utf8' + ) + ) as JSONSchemaType, + ], + [ + OCPP16RequestCommand.DATA_TRANSFER, + JSON.parse( + fs.readFileSync( + path.resolve( + path.dirname(fileURLToPath(import.meta.url)), + '../../../assets/json-schemas/ocpp/1.6/DataTransferResponse.json' + ), + 'utf8' + ) + ) as JSONSchemaType, + ], ]); + this.validatePayload.bind(this); } public async responseHandler( @@ -64,51 +188,84 @@ export default class OCPP16ResponseService extends OCPPResponseService { payload: JsonType, requestPayload: JsonType ): Promise { - if (chargingStation.isRegistered() || commandName === OCPP16RequestCommand.BOOT_NOTIFICATION) { - if (this.responseHandlers.has(commandName)) { + if ( + chargingStation.isRegistered() === true || + commandName === OCPP16RequestCommand.BOOT_NOTIFICATION + ) { + if ( + this.responseHandlers.has(commandName) === true && + OCPP16ServiceUtils.isRequestCommandSupported(chargingStation, commandName) === true + ) { try { + this.validatePayload(chargingStation, commandName, payload); await this.responseHandlers.get(commandName)(chargingStation, payload, requestPayload); } catch (error) { - logger.error(chargingStation.logPrefix() + ' Handle request response error: %j', error); + logger.error( + `${chargingStation.logPrefix()} ${moduleName}.responseHandler: Handle response error:`, + error + ); throw error; } } else { // Throw exception throw new OCPPError( ErrorType.NOT_IMPLEMENTED, - `${commandName} is not implemented to handle request response payload ${JSON.stringify( + `${commandName} is not implemented to handle response PDU ${JSON.stringify( payload, null, 2 )}`, - commandName + commandName, + payload ); } } else { throw new OCPPError( ErrorType.SECURITY_ERROR, - `${commandName} cannot be issued to handle request response payload ${JSON.stringify( + `${commandName} cannot be issued to handle response PDU ${JSON.stringify( payload, null, 2 - )} while the charging station is not registered on the central server. `, - commandName + )} while the charging station is not registered on the central server.`, + commandName, + payload + ); + } + } + + private validatePayload( + chargingStation: ChargingStation, + commandName: OCPP16RequestCommand, + payload: JsonType + ): boolean { + if (this.jsonSchemas.has(commandName)) { + return this.validateResponsePayload( + chargingStation, + commandName, + this.jsonSchemas.get(commandName), + payload ); } + logger.warn( + `${chargingStation.logPrefix()} ${moduleName}.validatePayload: No JSON schema found for command ${commandName} PDU validation` + ); + return false; } private handleResponseBootNotification( chargingStation: ChargingStation, payload: OCPP16BootNotificationResponse ): void { - if (payload.status === OCPP16RegistrationStatus.ACCEPTED) { - chargingStation.addConfigurationKey( + if (payload.status === RegistrationStatusEnumType.ACCEPTED) { + ChargingStationConfigurationUtils.addConfigurationKey( + chargingStation, OCPP16StandardParametersKey.HeartbeatInterval, payload.interval.toString(), {}, { overwrite: true, save: true } ); - chargingStation.addConfigurationKey( + ChargingStationConfigurationUtils.addConfigurationKey( + chargingStation, OCPP16StandardParametersKey.HeartBeatInterval, payload.interval.toString(), { visible: false }, @@ -118,11 +275,11 @@ export default class OCPP16ResponseService extends OCPPResponseService { ? chargingStation.restartHeartbeat() : chargingStation.startHeartbeat(); } - if (Object.values(OCPP16RegistrationStatus).includes(payload.status)) { + if (Object.values(RegistrationStatusEnumType).includes(payload.status)) { const logMsg = `${chargingStation.logPrefix()} Charging station in '${ payload.status }' state on the central server`; - payload.status === OCPP16RegistrationStatus.REJECTED + payload.status === RegistrationStatusEnumType.REJECTED ? logger.warn(logMsg) : logger.info(logMsg); } else { @@ -134,9 +291,6 @@ export default class OCPP16ResponseService extends OCPPResponseService { } } - // eslint-disable-next-line @typescript-eslint/no-empty-function - private handleResponseHeartbeat(): void {} - private handleResponseAuthorize( chargingStation: ChargingStation, payload: OCPP16AuthorizeResponse, @@ -152,20 +306,24 @@ export default class OCPP16ResponseService extends OCPPResponseService { break; } } + const isAuthorizeConnectorIdDefined = authorizeConnectorId !== undefined; if (payload.idTagInfo.status === OCPP16AuthorizationStatus.ACCEPTED) { - chargingStation.getConnectorStatus(authorizeConnectorId).idTagAuthorized = true; + isAuthorizeConnectorIdDefined && + (chargingStation.getConnectorStatus(authorizeConnectorId).idTagAuthorized = true); logger.debug( - `${chargingStation.logPrefix()} IdTag ${ - requestPayload.idTag - } authorized on connector ${authorizeConnectorId}` + `${chargingStation.logPrefix()} IdTag '${requestPayload.idTag}' accepted${ + isAuthorizeConnectorIdDefined ? ` on connector ${authorizeConnectorId}` : '' + }` ); } else { - chargingStation.getConnectorStatus(authorizeConnectorId).idTagAuthorized = false; - delete chargingStation.getConnectorStatus(authorizeConnectorId).authorizeIdTag; + if (isAuthorizeConnectorIdDefined) { + chargingStation.getConnectorStatus(authorizeConnectorId).idTagAuthorized = false; + delete chargingStation.getConnectorStatus(authorizeConnectorId).authorizeIdTag; + } logger.debug( - `${chargingStation.logPrefix()} IdTag ${requestPayload.idTag} refused with status '${ + `${chargingStation.logPrefix()} IdTag '${requestPayload.idTag}' rejected with status '${ payload.idTagInfo.status - }' on connector ${authorizeConnectorId}` + }'${isAuthorizeConnectorIdDefined ? ` on connector ${authorizeConnectorId}` : ''}` ); } } @@ -193,11 +351,11 @@ export default class OCPP16ResponseService extends OCPPResponseService { return; } if ( - chargingStation.getConnectorStatus(connectorId).transactionRemoteStarted && - chargingStation.getAuthorizeRemoteTxRequests() && - chargingStation.getLocalAuthListEnabled() && + chargingStation.getConnectorStatus(connectorId).transactionRemoteStarted === true && + chargingStation.getAuthorizeRemoteTxRequests() === true && + chargingStation.getLocalAuthListEnabled() === true && chargingStation.hasAuthorizedTags() && - !chargingStation.getConnectorStatus(connectorId).idTagLocalAuthorized + chargingStation.getConnectorStatus(connectorId).idTagLocalAuthorized === false ) { logger.error( chargingStation.logPrefix() + @@ -210,11 +368,11 @@ export default class OCPP16ResponseService extends OCPPResponseService { return; } if ( - chargingStation.getConnectorStatus(connectorId).transactionRemoteStarted && - chargingStation.getAuthorizeRemoteTxRequests() && - chargingStation.getMayAuthorizeAtRemoteStart() && - !chargingStation.getConnectorStatus(connectorId).idTagLocalAuthorized && - !chargingStation.getConnectorStatus(connectorId).idTagAuthorized + chargingStation.getConnectorStatus(connectorId).transactionRemoteStarted === true && + chargingStation.getAuthorizeRemoteTxRequests() === true && + chargingStation.getMustAuthorizeAtRemoteStart() === true && + chargingStation.getConnectorStatus(connectorId).idTagLocalAuthorized === false && + chargingStation.getConnectorStatus(connectorId).idTagAuthorized === false ) { logger.error( chargingStation.logPrefix() + @@ -258,7 +416,7 @@ export default class OCPP16ResponseService extends OCPPResponseService { await this.resetConnectorOnStartTransactionError(chargingStation, connectorId); return; } - if (chargingStation.getConnectorStatus(connectorId)?.transactionStarted) { + if (chargingStation.getConnectorStatus(connectorId)?.transactionStarted === true) { logger.debug( chargingStation.logPrefix() + ' Trying to start a transaction on an already used connector ' + @@ -280,14 +438,14 @@ export default class OCPP16ResponseService extends OCPPResponseService { ); return; } - if (!Number.isInteger(payload.transactionId)) { - logger.warn( - `${chargingStation.logPrefix()} Trying to start a transaction on connector ${connectorId.toString()} with a non integer transaction Id ${ - payload.transactionId - }, converting to integer` - ); - payload.transactionId = Utils.convertToInt(payload.transactionId); - } + // if (!Number.isInteger(payload.transactionId)) { + // logger.warn( + // `${chargingStation.logPrefix()} Trying to start a transaction on connector ${connectorId.toString()} with a non integer transaction Id ${ + // payload.transactionId + // }, converting to integer` + // ); + // payload.transactionId = Utils.convertToInt(payload.transactionId); + // } if (payload.idTagInfo?.status === OCPP16AuthorizationStatus.ACCEPTED) { chargingStation.getConnectorStatus(connectorId).transactionStarted = true; @@ -309,7 +467,7 @@ export default class OCPP16ResponseService extends OCPPResponseService { >(chargingStation, OCPP16RequestCommand.METER_VALUES, { connectorId, transactionId: payload.transactionId, - meterValue: chargingStation.getConnectorStatus(connectorId).transactionBeginMeterValue, + meterValue: [chargingStation.getConnectorStatus(connectorId).transactionBeginMeterValue], })); await chargingStation.ocppRequestService.requestHandler< OCPP16StatusNotificationRequest, @@ -328,20 +486,23 @@ export default class OCPP16ResponseService extends OCPPResponseService { chargingStation.stationInfo.chargingStationId + '#' + connectorId.toString() + - ' for idTag ' + - requestPayload.idTag + " for idTag '" + + requestPayload.idTag + + "'" ); if (chargingStation.stationInfo.powerSharedByConnectors) { - chargingStation.stationInfo.powerDivider++; + chargingStation.powerDivider++; } - const configuredMeterValueSampleInterval = chargingStation.getConfigurationKey( - OCPP16StandardParametersKey.MeterValueSampleInterval - ); + const configuredMeterValueSampleInterval = + ChargingStationConfigurationUtils.getConfigurationKey( + chargingStation, + OCPP16StandardParametersKey.MeterValueSampleInterval + ); chargingStation.startMeterValues( connectorId, configuredMeterValueSampleInterval ? Utils.convertToInt(configuredMeterValueSampleInterval.value) * 1000 - : 60000 + : Constants.DEFAULT_METER_VALUES_INTERVAL ); } else { logger.warn( @@ -350,8 +511,9 @@ export default class OCPP16ResponseService extends OCPPResponseService { payload.transactionId.toString() + " REJECTED with status '" + payload?.idTagInfo?.status + - "', idTag " + - requestPayload.idTag + "', idTag '" + + requestPayload.idTag + + "'" ); await this.resetConnectorOnStartTransactionError(chargingStation, connectorId); } @@ -394,24 +556,26 @@ export default class OCPP16ResponseService extends OCPPResponseService { return; } if (payload.idTagInfo?.status === OCPP16AuthorizationStatus.ACCEPTED) { - chargingStation.getBeginEndMeterValues() && - !chargingStation.getOcppStrictCompliance() && - chargingStation.getOutOfOrderEndMeterValues() && + chargingStation.getBeginEndMeterValues() === true && + chargingStation.getOcppStrictCompliance() === false && + chargingStation.getOutOfOrderEndMeterValues() === true && (await chargingStation.ocppRequestService.requestHandler< OCPP16MeterValuesRequest, OCPP16MeterValuesResponse >(chargingStation, OCPP16RequestCommand.METER_VALUES, { connectorId: transactionConnectorId, transactionId: requestPayload.transactionId, - meterValue: OCPP16ServiceUtils.buildTransactionEndMeterValue( - chargingStation, - transactionConnectorId, - requestPayload.meterStop - ), + meterValue: [ + OCPP16ServiceUtils.buildTransactionEndMeterValue( + chargingStation, + transactionConnectorId, + requestPayload.meterStop + ), + ], })); if ( - !chargingStation.isChargingStationAvailable() || - !chargingStation.isConnectorAvailable(transactionConnectorId) + chargingStation.isChargingStationAvailable() === false || + chargingStation.isConnectorAvailable(transactionConnectorId) === false ) { await chargingStation.ocppRequestService.requestHandler< OCPP16StatusNotificationRequest, @@ -436,8 +600,9 @@ export default class OCPP16ResponseService extends OCPPResponseService { OCPP16ChargePointStatus.AVAILABLE; } if (chargingStation.stationInfo.powerSharedByConnectors) { - chargingStation.stationInfo.powerDivider--; + chargingStation.powerDivider--; } + chargingStation.resetConnectorStatus(transactionConnectorId); logger.info( chargingStation.logPrefix() + ' Transaction ' + @@ -447,7 +612,6 @@ export default class OCPP16ResponseService extends OCPPResponseService { '#' + transactionConnectorId.toString() ); - chargingStation.resetConnectorStatus(transactionConnectorId); } else { logger.warn( chargingStation.logPrefix() + @@ -459,10 +623,4 @@ export default class OCPP16ResponseService extends OCPPResponseService { ); } } - - // eslint-disable-next-line @typescript-eslint/no-empty-function - private handleResponseStatusNotification(): void {} - - // eslint-disable-next-line @typescript-eslint/no-empty-function - private handleResponseMeterValues(): void {} }