X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=inline;f=src%2Fcharging-station%2Focpp%2F1.6%2FOCPP16IncomingRequestService.ts;h=6f77cde0f5afaf920cfbff7c9f72d75e878fb697;hb=44eb6026079c8dc2c77b10a96a42d0c0b2da7c8f;hp=9e0849e987080be00f57f931e62fcfc9f3b8a3d9;hpb=22e0d48e12052aaa7ed3f76fc59cac779ae67a5c;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 9e0849e9..6f77cde0 100644 --- a/src/charging-station/ocpp/1.6/OCPP16IncomingRequestService.ts +++ b/src/charging-station/ocpp/1.6/OCPP16IncomingRequestService.ts @@ -8,6 +8,7 @@ import type { JSONSchemaType } from 'ajv'; import { Client, type FTPResponse } from 'basic-ftp'; import tar from 'tar'; +import { OCPP16ServiceUtils } from './OCPP16ServiceUtils'; import OCPPError from '../../../exception/OCPPError'; import type { JsonObject, JsonType } from '../../../types/JsonType'; import { OCPP16ChargePointErrorCode } from '../../../types/ocpp/1.6/ChargePointErrorCode'; @@ -78,7 +79,7 @@ import type { OCPPConfigurationKey } from '../../../types/ocpp/Configuration'; import { ErrorType } from '../../../types/ocpp/ErrorType'; import { OCPPVersion } from '../../../types/ocpp/OCPPVersion'; import type { IncomingRequestHandler } from '../../../types/ocpp/Requests'; -import type { DefaultResponse } from '../../../types/ocpp/Responses'; +import type { GenericResponse } from '../../../types/ocpp/Responses'; import Constants from '../../../utils/Constants'; import logger from '../../../utils/Logger'; import Utils from '../../../utils/Utils'; @@ -87,7 +88,6 @@ import { ChargingStationConfigurationUtils } from '../../ChargingStationConfigur import { ChargingStationUtils } from '../../ChargingStationUtils'; import OCPPConstants from '../OCPPConstants'; import OCPPIncomingRequestService from '../OCPPIncomingRequestService'; -import { OCPP16ServiceUtils } from './OCPP16ServiceUtils'; const moduleName = 'OCPP16IncomingRequestService'; @@ -140,171 +140,85 @@ export default class OCPP16IncomingRequestService extends OCPPIncomingRequestSer this.jsonSchemas = new Map>([ [ OCPP16IncomingRequestCommand.RESET, - JSON.parse( - fs.readFileSync( - path.resolve( - path.dirname(fileURLToPath(import.meta.url)), - '../../../assets/json-schemas/ocpp/1.6/Reset.json' - ), - 'utf8' - ) - ) as JSONSchemaType, + this.parseJsonSchemaFile('../../../assets/json-schemas/ocpp/1.6/Reset.json'), ], [ OCPP16IncomingRequestCommand.CLEAR_CACHE, - JSON.parse( - fs.readFileSync( - path.resolve( - path.dirname(fileURLToPath(import.meta.url)), - '../../../assets/json-schemas/ocpp/1.6/ClearCache.json' - ), - 'utf8' - ) - ) as JSONSchemaType, + this.parseJsonSchemaFile( + '../../../assets/json-schemas/ocpp/1.6/ClearCache.json' + ), ], [ OCPP16IncomingRequestCommand.UNLOCK_CONNECTOR, - JSON.parse( - fs.readFileSync( - path.resolve( - path.dirname(fileURLToPath(import.meta.url)), - '../../../assets/json-schemas/ocpp/1.6/UnlockConnector.json' - ), - 'utf8' - ) - ) as JSONSchemaType, + this.parseJsonSchemaFile( + '../../../assets/json-schemas/ocpp/1.6/UnlockConnector.json' + ), ], [ OCPP16IncomingRequestCommand.GET_CONFIGURATION, - JSON.parse( - fs.readFileSync( - path.resolve( - path.dirname(fileURLToPath(import.meta.url)), - '../../../assets/json-schemas/ocpp/1.6/GetConfiguration.json' - ), - 'utf8' - ) - ) as JSONSchemaType, + this.parseJsonSchemaFile( + '../../../assets/json-schemas/ocpp/1.6/GetConfiguration.json' + ), ], [ OCPP16IncomingRequestCommand.CHANGE_CONFIGURATION, - JSON.parse( - fs.readFileSync( - path.resolve( - path.dirname(fileURLToPath(import.meta.url)), - '../../../assets/json-schemas/ocpp/1.6/ChangeConfiguration.json' - ), - 'utf8' - ) - ) as JSONSchemaType, + this.parseJsonSchemaFile( + '../../../assets/json-schemas/ocpp/1.6/ChangeConfiguration.json' + ), ], [ OCPP16IncomingRequestCommand.GET_DIAGNOSTICS, - JSON.parse( - fs.readFileSync( - path.resolve( - path.dirname(fileURLToPath(import.meta.url)), - '../../../assets/json-schemas/ocpp/1.6/GetDiagnostics.json' - ), - 'utf8' - ) - ) as JSONSchemaType, + this.parseJsonSchemaFile( + '../../../assets/json-schemas/ocpp/1.6/GetDiagnostics.json' + ), ], [ OCPP16IncomingRequestCommand.SET_CHARGING_PROFILE, - JSON.parse( - fs.readFileSync( - path.resolve( - path.dirname(fileURLToPath(import.meta.url)), - '../../../assets/json-schemas/ocpp/1.6/SetChargingProfile.json' - ), - 'utf8' - ) - ) as JSONSchemaType, + this.parseJsonSchemaFile( + '../../../assets/json-schemas/ocpp/1.6/SetChargingProfile.json' + ), ], [ OCPP16IncomingRequestCommand.CLEAR_CHARGING_PROFILE, - JSON.parse( - fs.readFileSync( - path.resolve( - path.dirname(fileURLToPath(import.meta.url)), - '../../../assets/json-schemas/ocpp/1.6/ClearChargingProfile.json' - ), - 'utf8' - ) - ) as JSONSchemaType, + this.parseJsonSchemaFile( + '../../../assets/json-schemas/ocpp/1.6/ClearChargingProfile.json' + ), ], [ OCPP16IncomingRequestCommand.CHANGE_AVAILABILITY, - JSON.parse( - fs.readFileSync( - path.resolve( - path.dirname(fileURLToPath(import.meta.url)), - '../../../assets/json-schemas/ocpp/1.6/ChangeAvailability.json' - ), - 'utf8' - ) - ) as JSONSchemaType, + this.parseJsonSchemaFile( + '../../../assets/json-schemas/ocpp/1.6/ChangeAvailability.json' + ), ], [ OCPP16IncomingRequestCommand.REMOTE_START_TRANSACTION, - JSON.parse( - fs.readFileSync( - path.resolve( - path.dirname(fileURLToPath(import.meta.url)), - '../../../assets/json-schemas/ocpp/1.6/RemoteStartTransaction.json' - ), - 'utf8' - ) - ) as JSONSchemaType, + this.parseJsonSchemaFile( + '../../../assets/json-schemas/ocpp/1.6/RemoteStartTransaction.json' + ), ], [ OCPP16IncomingRequestCommand.REMOTE_STOP_TRANSACTION, - JSON.parse( - fs.readFileSync( - path.resolve( - path.dirname(fileURLToPath(import.meta.url)), - '../../../assets/json-schemas/ocpp/1.6/RemoteStopTransaction.json' - ), - 'utf8' - ) - ) as JSONSchemaType, + this.parseJsonSchemaFile( + '../../../assets/json-schemas/ocpp/1.6/RemoteStopTransaction.json' + ), ], [ OCPP16IncomingRequestCommand.TRIGGER_MESSAGE, - JSON.parse( - fs.readFileSync( - path.resolve( - path.dirname(fileURLToPath(import.meta.url)), - '../../../assets/json-schemas/ocpp/1.6/TriggerMessage.json' - ), - 'utf8' - ) - ) as JSONSchemaType, + this.parseJsonSchemaFile( + '../../../assets/json-schemas/ocpp/1.6/TriggerMessage.json' + ), ], [ OCPP16IncomingRequestCommand.DATA_TRANSFER, - JSON.parse( - fs.readFileSync( - path.resolve( - path.dirname(fileURLToPath(import.meta.url)), - '../../../assets/json-schemas/ocpp/1.6/DataTransfer.json' - ), - 'utf8' - ) - ) as JSONSchemaType, + this.parseJsonSchemaFile( + '../../../assets/json-schemas/ocpp/1.6/DataTransfer.json' + ), ], [ OCPP16IncomingRequestCommand.UPDATE_FIRMWARE, - JSON.parse( - fs.readFileSync( - path.resolve( - path.dirname(fileURLToPath(import.meta.url)), - '../../../assets/json-schemas/ocpp/1.6/UpdateFirmware.json' - ), - 'utf8' - ) - ) as JSONSchemaType, + this.parseJsonSchemaFile( + '../../../assets/json-schemas/ocpp/1.6/UpdateFirmware.json' + ), ], ]); this.validatePayload.bind(this); @@ -415,7 +329,7 @@ export default class OCPP16IncomingRequestService extends OCPPIncomingRequestSer private handleRequestReset( chargingStation: ChargingStation, commandPayload: ResetRequest - ): DefaultResponse { + ): GenericResponse { this.asyncResource .runInAsyncScope( chargingStation.reset.bind(chargingStation) as ( @@ -423,7 +337,7 @@ export default class OCPP16IncomingRequestService extends OCPPIncomingRequestSer ...args: any[] ) => Promise, chargingStation, - (commandPayload.type + 'Reset') as OCPP16StopTransactionReason + `${commandPayload.type}Reset` as OCPP16StopTransactionReason ) .catch(() => { /* This is intentional */ @@ -451,7 +365,7 @@ export default class OCPP16IncomingRequestService extends OCPPIncomingRequestSer } if (connectorId === 0) { logger.error( - chargingStation.logPrefix() + ' Trying to unlock connector Id ' + connectorId.toString() + `${chargingStation.logPrefix()} Trying to unlock connector Id ${connectorId.toString()}` ); return OCPPConstants.OCPP_RESPONSE_UNLOCK_NOT_SUPPORTED; } @@ -630,8 +544,8 @@ export default class OCPP16IncomingRequestService extends OCPPIncomingRequestSer logger.debug( `${chargingStation.logPrefix()} Charging profile(s) set on connector id ${ commandPayload.connectorId - }, dump their stack: %j`, - chargingStation.getConnectorStatus(commandPayload.connectorId).chargingProfiles + }: %j`, + commandPayload.csChargingProfiles ); return OCPPConstants.OCPP_SET_CHARGING_PROFILE_RESPONSE_ACCEPTED; } @@ -663,8 +577,7 @@ export default class OCPP16IncomingRequestService extends OCPPIncomingRequestSer logger.debug( `${chargingStation.logPrefix()} Charging profile(s) cleared on connector id ${ commandPayload.connectorId - }, dump their stack: %j`, - connectorStatus.chargingProfiles + }` ); return OCPPConstants.OCPP_CLEAR_CHARGING_PROFILE_RESPONSE_ACCEPTED; } @@ -700,10 +613,8 @@ export default class OCPP16IncomingRequestService extends OCPPIncomingRequestSer if (clearCurrentCP) { connectorStatus.chargingProfiles.splice(index, 1); logger.debug( - `${chargingStation.logPrefix()} Matching charging profile(s) cleared on connector id ${ - commandPayload.connectorId - }, dump their stack: %j`, - connectorStatus.chargingProfiles + `${chargingStation.logPrefix()} Matching charging profile(s) cleared: %j`, + chargingProfile ); clearedCP = true; } @@ -780,18 +691,12 @@ export default class OCPP16IncomingRequestService extends OCPPIncomingRequestSer private async handleRequestRemoteStartTransaction( chargingStation: ChargingStation, commandPayload: RemoteStartTransactionRequest - ): Promise { + ): Promise { const transactionConnectorId = commandPayload.connectorId; if (chargingStation.connectors.has(transactionConnectorId) === true) { - const remoteStartTransactionLogMsg = - chargingStation.logPrefix() + - ' Transaction remotely STARTED on ' + - chargingStation.stationInfo.chargingStationId + - '#' + - transactionConnectorId.toString() + - " for idTag '" + - commandPayload.idTag + - "'"; + const remoteStartTransactionLogMsg = `${chargingStation.logPrefix()} Transaction remotely STARTED on ${ + chargingStation.stationInfo.chargingStationId + }#${transactionConnectorId.toString()} for idTag '${commandPayload.idTag}'`; await chargingStation.ocppRequestService.requestHandler< OCPP16StatusNotificationRequest, OCPP16StatusNotificationResponse @@ -929,7 +834,7 @@ export default class OCPP16IncomingRequestService extends OCPPIncomingRequestSer chargingStation: ChargingStation, connectorId: number, idTag: string - ): Promise { + ): Promise { if ( chargingStation.getConnectorStatus(connectorId).status !== OCPP16ChargePointStatus.AVAILABLE ) { @@ -944,16 +849,9 @@ export default class OCPP16IncomingRequestService extends OCPPIncomingRequestSer chargingStation.getConnectorStatus(connectorId).status = OCPP16ChargePointStatus.AVAILABLE; } logger.warn( - chargingStation.logPrefix() + - ' Remote starting transaction REJECTED on connector Id ' + - connectorId.toString() + - ", idTag '" + - idTag + - "', availability '" + - chargingStation.getConnectorStatus(connectorId).availability + - "', status '" + - chargingStation.getConnectorStatus(connectorId).status + - "'" + `${chargingStation.logPrefix()} Remote starting transaction REJECTED on connector Id ${connectorId.toString()}, idTag '${idTag}', availability '${ + chargingStation.getConnectorStatus(connectorId).availability + }', status '${chargingStation.getConnectorStatus(connectorId).status}'` ); return OCPPConstants.OCPP_RESPONSE_REJECTED; } @@ -966,8 +864,8 @@ export default class OCPP16IncomingRequestService extends OCPPIncomingRequestSer if (cp && cp.chargingProfilePurpose === ChargingProfilePurposeType.TX_PROFILE) { OCPP16ServiceUtils.setChargingProfile(chargingStation, connectorId, cp); logger.debug( - `${chargingStation.logPrefix()} Charging profile(s) set at remote start transaction on connector id ${connectorId}, dump their stack: %j`, - chargingStation.getConnectorStatus(connectorId).chargingProfiles + `${chargingStation.logPrefix()} Charging profile(s) set at remote start transaction on connector id ${connectorId}: %j`, + cp ); return true; } else if (cp && cp.chargingProfilePurpose !== ChargingProfilePurposeType.TX_PROFILE) { @@ -985,7 +883,7 @@ export default class OCPP16IncomingRequestService extends OCPPIncomingRequestSer private async handleRequestRemoteStopTransaction( chargingStation: ChargingStation, commandPayload: RemoteStopTransactionRequest - ): Promise { + ): Promise { const transactionId = commandPayload.transactionId; for (const connectorId of chargingStation.connectors.keys()) { if ( @@ -1012,9 +910,7 @@ export default class OCPP16IncomingRequestService extends OCPPIncomingRequestSer } } logger.warn( - chargingStation.logPrefix() + - ' Trying to remote stop a non existing transaction ' + - transactionId.toString() + `${chargingStation.logPrefix()} Trying to remote stop a non existing transaction ${transactionId.toString()}` ); return OCPPConstants.OCPP_RESPONSE_REJECTED; } @@ -1030,10 +926,23 @@ export default class OCPP16IncomingRequestService extends OCPPIncomingRequestSer OCPP16IncomingRequestCommand.UPDATE_FIRMWARE ) === false ) { + logger.warn( + `${chargingStation.logPrefix()} ${moduleName}.handleRequestUpdateFirmware: Cannot simulate firmware update: feature profile not supported` + ); + return OCPPConstants.OCPP_RESPONSE_EMPTY; + } + if ( + !Utils.isNullOrUndefined(chargingStation.stationInfo.firmwareStatus) && + chargingStation.stationInfo.firmwareStatus !== OCPP16FirmwareStatus.Installed + ) { + logger.warn( + `${chargingStation.logPrefix()} ${moduleName}.handleRequestUpdateFirmware: Cannot simulate firmware update: firmware update is already in progress` + ); return OCPPConstants.OCPP_RESPONSE_EMPTY; } const retrieveDate = Utils.convertToDate(commandPayload.retrieveDate); - if (retrieveDate.getTime() <= Date.now()) { + const now = Date.now(); + if (retrieveDate.getTime() <= now) { this.asyncResource .runInAsyncScope( this.updateFirmware.bind(this) as ( @@ -1051,15 +960,15 @@ export default class OCPP16IncomingRequestService extends OCPPIncomingRequestSer this.updateFirmware(chargingStation).catch(() => { /* Intentional */ }); - }, retrieveDate.getTime() - Date.now()); + }, retrieveDate.getTime() - now); } return OCPPConstants.OCPP_RESPONSE_EMPTY; } private async updateFirmware( chargingStation: ChargingStation, - minDelay = 15, - maxDelay = 30 + maxDelay = 30, + minDelay = 15 ): Promise { chargingStation.stopAutomaticTransactionGenerator(); for (const connectorId of chargingStation.connectors.keys()) { @@ -1079,6 +988,18 @@ export default class OCPP16IncomingRequestService extends OCPPIncomingRequestSer OCPP16ChargePointStatus.UNAVAILABLE; } } + if ( + chargingStation.stationInfo?.firmwareUpgrade?.failureStatus && + !Utils.isEmptyString(chargingStation.stationInfo?.firmwareUpgrade?.failureStatus) + ) { + await chargingStation.ocppRequestService.requestHandler< + OCPP16FirmwareStatusNotificationRequest, + OCPP16FirmwareStatusNotificationResponse + >(chargingStation, OCPP16RequestCommand.FIRMWARE_STATUS_NOTIFICATION, { + status: chargingStation.stationInfo?.firmwareUpgrade?.failureStatus, + }); + return; + } await chargingStation.ocppRequestService.requestHandler< OCPP16FirmwareStatusNotificationRequest, OCPP16FirmwareStatusNotificationResponse @@ -1086,7 +1007,7 @@ export default class OCPP16IncomingRequestService extends OCPPIncomingRequestSer status: OCPP16FirmwareStatus.Downloading, }); chargingStation.stationInfo.firmwareStatus = OCPP16FirmwareStatus.Downloading; - await Utils.sleep(Utils.getRandomInteger(minDelay, maxDelay) * 1000); + await Utils.sleep(Utils.getRandomInteger(maxDelay, minDelay) * 1000); await chargingStation.ocppRequestService.requestHandler< OCPP16FirmwareStatusNotificationRequest, OCPP16FirmwareStatusNotificationResponse @@ -1094,7 +1015,7 @@ export default class OCPP16IncomingRequestService extends OCPPIncomingRequestSer status: OCPP16FirmwareStatus.Downloaded, }); chargingStation.stationInfo.firmwareStatus = OCPP16FirmwareStatus.Downloaded; - await Utils.sleep(Utils.getRandomInteger(minDelay, maxDelay) * 1000); + await Utils.sleep(Utils.getRandomInteger(maxDelay, minDelay) * 1000); await chargingStation.ocppRequestService.requestHandler< OCPP16FirmwareStatusNotificationRequest, OCPP16FirmwareStatusNotificationResponse @@ -1102,8 +1023,10 @@ export default class OCPP16IncomingRequestService extends OCPPIncomingRequestSer status: OCPP16FirmwareStatus.Installing, }); chargingStation.stationInfo.firmwareStatus = OCPP16FirmwareStatus.Installing; - await Utils.sleep(Utils.getRandomInteger(minDelay, maxDelay) * 1000); - await chargingStation.reset(OCPP16StopTransactionReason.REBOOT); + if (chargingStation.stationInfo?.firmwareUpgrade?.reset === true) { + await Utils.sleep(Utils.getRandomInteger(maxDelay, minDelay) * 1000); + await chargingStation.reset(OCPP16StopTransactionReason.REBOOT); + } } private async handleRequestGetDiagnostics( @@ -1117,6 +1040,9 @@ export default class OCPP16IncomingRequestService extends OCPPIncomingRequestSer OCPP16IncomingRequestCommand.GET_DIAGNOSTICS ) === false ) { + logger.warn( + `${chargingStation.logPrefix()} ${moduleName}.handleRequestGetDiagnostics: Cannot get diagnostics: feature profile not supported` + ); return OCPPConstants.OCPP_RESPONSE_EMPTY; } const uri = new URL(commandPayload.location); @@ -1127,7 +1053,7 @@ export default class OCPP16IncomingRequestService extends OCPPIncomingRequestSer .readdirSync(path.resolve(path.dirname(fileURLToPath(import.meta.url)), '../../../../')) .filter((file) => file.endsWith('.log')) .map((file) => path.join('./', file)); - const diagnosticsArchive = chargingStation.stationInfo.chargingStationId + '_logs.tar.gz'; + const diagnosticsArchive = `${chargingStation.stationInfo.chargingStationId}_logs.tar.gz`; tar.create({ gzip: true }, logFiles).pipe(fs.createWriteStream(diagnosticsArchive)); ftpClient = new Client(); const accessResponse = await ftpClient.access({ @@ -1138,19 +1064,27 @@ export default class OCPP16IncomingRequestService extends OCPPIncomingRequestSer }); let uploadResponse: FTPResponse; if (accessResponse.code === 220) { - // eslint-disable-next-line @typescript-eslint/no-misused-promises - ftpClient.trackProgress(async (info) => { + ftpClient.trackProgress((info) => { logger.info( `${chargingStation.logPrefix()} ${ info.bytes / 1024 } bytes transferred from diagnostics archive ${info.name}` ); - await chargingStation.ocppRequestService.requestHandler< - OCPP16DiagnosticsStatusNotificationRequest, - OCPP16DiagnosticsStatusNotificationResponse - >(chargingStation, OCPP16RequestCommand.DIAGNOSTICS_STATUS_NOTIFICATION, { - status: OCPP16DiagnosticsStatus.Uploading, - }); + chargingStation.ocppRequestService + .requestHandler< + OCPP16DiagnosticsStatusNotificationRequest, + OCPP16DiagnosticsStatusNotificationResponse + >(chargingStation, OCPP16RequestCommand.DIAGNOSTICS_STATUS_NOTIFICATION, { + status: OCPP16DiagnosticsStatus.Uploading, + }) + .catch((error) => { + logger.error( + `${chargingStation.logPrefix()} ${moduleName}.handleRequestGetDiagnostics: Error while sending '${ + OCPP16RequestCommand.DIAGNOSTICS_STATUS_NOTIFICATION + }'`, + error + ); + }); }); uploadResponse = await ftpClient.uploadFrom( path.join( @@ -1174,7 +1108,7 @@ export default class OCPP16IncomingRequestService extends OCPPIncomingRequestSer throw new OCPPError( ErrorType.GENERIC_ERROR, `Diagnostics transfer failed with error code ${accessResponse.code.toString()}${ - uploadResponse?.code && '|' + uploadResponse?.code.toString() + uploadResponse?.code && `|${uploadResponse?.code.toString()}` }`, OCPP16IncomingRequestCommand.GET_DIAGNOSTICS ); @@ -1182,7 +1116,7 @@ export default class OCPP16IncomingRequestService extends OCPPIncomingRequestSer throw new OCPPError( ErrorType.GENERIC_ERROR, `Diagnostics transfer failed with error code ${accessResponse.code.toString()}${ - uploadResponse?.code && '|' + uploadResponse?.code.toString() + uploadResponse?.code && `|${uploadResponse?.code.toString()}` }`, OCPP16IncomingRequestCommand.GET_DIAGNOSTICS ); @@ -1359,4 +1293,13 @@ export default class OCPP16IncomingRequestService extends OCPPIncomingRequestSer ); } } + + private parseJsonSchemaFile(relativePath: string): JSONSchemaType { + return JSON.parse( + fs.readFileSync( + path.resolve(path.dirname(fileURLToPath(import.meta.url)), relativePath), + 'utf8' + ) + ) as JSONSchemaType; + } }