X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fcharging-station%2Focpp%2F1.6%2FOCPP16IncomingRequestService.ts;h=66a6ee5960a95b7050a1888122e9bcef4cfe7a24;hb=6fc0c6f3db444377c0fdea238183a14823278046;hp=f8ca8de69745192c0baefea62b68ba38ba804507;hpb=94a464f92b8113a17129baa63d0d1469385b081b;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 f8ca8de6..66a6ee59 100644 --- a/src/charging-station/ocpp/1.6/OCPP16IncomingRequestService.ts +++ b/src/charging-station/ocpp/1.6/OCPP16IncomingRequestService.ts @@ -1,236 +1,525 @@ -// Partial Copyright Jerome Benoit. 2021. All Rights Reserved. +// Partial Copyright Jerome Benoit. 2021-2023. All Rights Reserved. +import { createWriteStream, readdirSync } from 'node:fs'; +import { dirname, join, resolve } from 'node:path'; +import { URL, fileURLToPath } from 'node:url'; + +import type { JSONSchemaType } from 'ajv'; +import { Client, type FTPResponse } from 'basic-ftp'; import { - ChangeAvailabilityRequest, - ChangeConfigurationRequest, - ClearChargingProfileRequest, - GetConfigurationRequest, - GetDiagnosticsRequest, - MessageTrigger, - OCPP16AvailabilityType, - OCPP16IncomingRequestCommand, - OCPP16RequestCommand, - OCPP16TriggerMessageRequest, - RemoteStartTransactionRequest, - RemoteStopTransactionRequest, - ResetRequest, - SetChargingProfileRequest, - UnlockConnectorRequest, -} from '../../../types/ocpp/1.6/Requests'; -import { - ChangeAvailabilityResponse, - ChangeConfigurationResponse, - ClearChargingProfileResponse, - GetConfigurationResponse, - GetDiagnosticsResponse, - OCPP16TriggerMessageResponse, - SetChargingProfileResponse, - UnlockConnectorResponse, -} from '../../../types/ocpp/1.6/Responses'; + addSeconds, + differenceInSeconds, + isAfter, + isBefore, + isDate, + isWithinInterval, + max, + maxTime, + min, + minTime, + secondsToMilliseconds, +} from 'date-fns'; +import { create } from 'tar'; + +import { OCPP16Constants } from './OCPP16Constants'; +import { OCPP16ServiceUtils } from './OCPP16ServiceUtils'; import { - ChargingProfilePurposeType, - OCPP16ChargingProfile, -} from '../../../types/ocpp/1.6/ChargingProfile'; -import { Client, FTPResponse } from 'basic-ftp'; + type ChargingStation, + canProceedChargingProfile, + checkChargingStation, + getConfigurationKey, + getConnectorChargingProfiles, + prepareChargingProfileKind, + removeExpiredReservations, + setConfigurationKeyValue, +} from '../../../charging-station'; +import { OCPPError } from '../../../exception'; import { + type ChangeConfigurationRequest, + type ChangeConfigurationResponse, + type ClearChargingProfileRequest, + type ClearChargingProfileResponse, + ErrorType, + type GenericResponse, + GenericStatus, + type GetConfigurationRequest, + type GetConfigurationResponse, + type GetDiagnosticsRequest, + type GetDiagnosticsResponse, + type IncomingRequestHandler, + type JsonObject, + type JsonType, OCPP16AuthorizationStatus, + OCPP16AvailabilityType, + type OCPP16BootNotificationRequest, + type OCPP16BootNotificationResponse, + type OCPP16CancelReservationRequest, + type OCPP16ChangeAvailabilityRequest, + type OCPP16ChangeAvailabilityResponse, + OCPP16ChargePointErrorCode, + OCPP16ChargePointStatus, + type OCPP16ChargingProfile, + OCPP16ChargingProfilePurposeType, + OCPP16ChargingRateUnitType, + type OCPP16ChargingSchedule, + type OCPP16ChargingSchedulePeriod, + type OCPP16ClearCacheRequest, + type OCPP16DataTransferRequest, + type OCPP16DataTransferResponse, + OCPP16DataTransferVendorId, + OCPP16DiagnosticsStatus, + type OCPP16DiagnosticsStatusNotificationRequest, + type OCPP16DiagnosticsStatusNotificationResponse, + OCPP16FirmwareStatus, + type OCPP16FirmwareStatusNotificationRequest, + type OCPP16FirmwareStatusNotificationResponse, + type OCPP16GetCompositeScheduleRequest, + type OCPP16GetCompositeScheduleResponse, + type OCPP16HeartbeatRequest, + type OCPP16HeartbeatResponse, + OCPP16IncomingRequestCommand, + OCPP16MessageTrigger, + OCPP16RequestCommand, + type OCPP16ReserveNowRequest, + type OCPP16ReserveNowResponse, + OCPP16StandardParametersKey, + type OCPP16StartTransactionRequest, + type OCPP16StartTransactionResponse, + type OCPP16StatusNotificationRequest, + type OCPP16StatusNotificationResponse, OCPP16StopTransactionReason, -} from '../../../types/ocpp/1.6/Transaction'; - -import type ChargingStation from '../../ChargingStation'; -import Constants from '../../../utils/Constants'; -import { DefaultResponse } from '../../../types/ocpp/Responses'; -import { ErrorType } from '../../../types/ocpp/ErrorType'; -import { IncomingRequestHandler } from '../../../types/ocpp/Requests'; -import { JsonType } from '../../../types/JsonType'; -import { OCPP16ChargePointStatus } from '../../../types/ocpp/1.6/ChargePointStatus'; -import { OCPP16DiagnosticsStatus } from '../../../types/ocpp/1.6/DiagnosticsStatus'; -import { OCPP16StandardParametersKey } from '../../../types/ocpp/1.6/Configuration'; -import { OCPPConfigurationKey } from '../../../types/ocpp/Configuration'; -import OCPPError from '../../../exception/OCPPError'; -import OCPPIncomingRequestService from '../OCPPIncomingRequestService'; -import { URL } from 'url'; -import Utils from '../../../utils/Utils'; -import fs from 'fs'; -import logger from '../../../utils/Logger'; -import path from 'path'; -import tar from 'tar'; + OCPP16SupportedFeatureProfiles, + type OCPP16TriggerMessageRequest, + type OCPP16TriggerMessageResponse, + type OCPP16UpdateFirmwareRequest, + type OCPP16UpdateFirmwareResponse, + type OCPPConfigurationKey, + OCPPVersion, + type RemoteStartTransactionRequest, + type RemoteStopTransactionRequest, + ReservationTerminationReason, + type ResetRequest, + type SetChargingProfileRequest, + type SetChargingProfileResponse, + type UnlockConnectorRequest, + type UnlockConnectorResponse, +} from '../../../types'; +import { + Constants, + convertToDate, + convertToInt, + formatDurationMilliSeconds, + getRandomInteger, + isEmptyArray, + isNotEmptyArray, + isNotEmptyString, + isNullOrUndefined, + isUndefined, + isValidTime, + logger, + sleep, +} from '../../../utils'; +import { OCPPIncomingRequestService } from '../OCPPIncomingRequestService'; const moduleName = 'OCPP16IncomingRequestService'; -export default class OCPP16IncomingRequestService extends OCPPIncomingRequestService { +export class OCPP16IncomingRequestService extends OCPPIncomingRequestService { + protected jsonSchemas: Map>; private incomingRequestHandlers: Map; - public constructor(chargingStation: ChargingStation) { - if (new.target?.name === moduleName) { - throw new TypeError(`Cannot construct ${new.target?.name} instances directly`); - } - super(chargingStation); + public constructor() { + // if (new.target?.name === moduleName) { + // throw new TypeError(`Cannot construct ${new.target?.name} instances directly`); + // } + super(OCPPVersion.VERSION_16); this.incomingRequestHandlers = new Map([ - [OCPP16IncomingRequestCommand.RESET, this.handleRequestReset.bind(this)], - [OCPP16IncomingRequestCommand.CLEAR_CACHE, this.handleRequestClearCache.bind(this)], - [OCPP16IncomingRequestCommand.UNLOCK_CONNECTOR, this.handleRequestUnlockConnector.bind(this)], + [ + OCPP16IncomingRequestCommand.RESET, + this.handleRequestReset.bind(this) as unknown as IncomingRequestHandler, + ], + [ + OCPP16IncomingRequestCommand.CLEAR_CACHE, + this.handleRequestClearCache.bind(this) as IncomingRequestHandler, + ], + [ + OCPP16IncomingRequestCommand.UNLOCK_CONNECTOR, + this.handleRequestUnlockConnector.bind(this) as unknown as IncomingRequestHandler, + ], + [ + OCPP16IncomingRequestCommand.GET_CONFIGURATION, + this.handleRequestGetConfiguration.bind(this) as IncomingRequestHandler, + ], + [ + OCPP16IncomingRequestCommand.CHANGE_CONFIGURATION, + this.handleRequestChangeConfiguration.bind(this) as unknown as IncomingRequestHandler, + ], + [ + OCPP16IncomingRequestCommand.GET_COMPOSITE_SCHEDULE, + this.handleRequestGetCompositeSchedule.bind(this) as unknown as IncomingRequestHandler, + ], + [ + OCPP16IncomingRequestCommand.SET_CHARGING_PROFILE, + this.handleRequestSetChargingProfile.bind(this) as unknown as IncomingRequestHandler, + ], + [ + OCPP16IncomingRequestCommand.CLEAR_CHARGING_PROFILE, + this.handleRequestClearChargingProfile.bind(this) as IncomingRequestHandler, + ], + [ + OCPP16IncomingRequestCommand.CHANGE_AVAILABILITY, + this.handleRequestChangeAvailability.bind(this) as unknown as IncomingRequestHandler, + ], + [ + OCPP16IncomingRequestCommand.REMOTE_START_TRANSACTION, + this.handleRequestRemoteStartTransaction.bind(this) as unknown as IncomingRequestHandler, + ], + [ + OCPP16IncomingRequestCommand.REMOTE_STOP_TRANSACTION, + this.handleRequestRemoteStopTransaction.bind(this) as unknown as IncomingRequestHandler, + ], + [ + OCPP16IncomingRequestCommand.GET_DIAGNOSTICS, + this.handleRequestGetDiagnostics.bind(this) as IncomingRequestHandler, + ], + [ + OCPP16IncomingRequestCommand.TRIGGER_MESSAGE, + this.handleRequestTriggerMessage.bind(this) as unknown as IncomingRequestHandler, + ], + [ + OCPP16IncomingRequestCommand.DATA_TRANSFER, + this.handleRequestDataTransfer.bind(this) as unknown as IncomingRequestHandler, + ], + [ + OCPP16IncomingRequestCommand.UPDATE_FIRMWARE, + this.handleRequestUpdateFirmware.bind(this) as unknown as IncomingRequestHandler, + ], + [ + OCPP16IncomingRequestCommand.RESERVE_NOW, + this.handleRequestReserveNow.bind(this) as unknown as IncomingRequestHandler, + ], + [ + OCPP16IncomingRequestCommand.CANCEL_RESERVATION, + this.handleRequestCancelReservation.bind(this) as unknown as IncomingRequestHandler, + ], + ]); + this.jsonSchemas = new Map>([ + [ + OCPP16IncomingRequestCommand.RESET, + OCPP16ServiceUtils.parseJsonSchemaFile( + 'assets/json-schemas/ocpp/1.6/Reset.json', + moduleName, + 'constructor', + ), + ], + [ + OCPP16IncomingRequestCommand.CLEAR_CACHE, + OCPP16ServiceUtils.parseJsonSchemaFile( + 'assets/json-schemas/ocpp/1.6/ClearCache.json', + moduleName, + 'constructor', + ), + ], + [ + OCPP16IncomingRequestCommand.UNLOCK_CONNECTOR, + OCPP16ServiceUtils.parseJsonSchemaFile( + 'assets/json-schemas/ocpp/1.6/UnlockConnector.json', + moduleName, + 'constructor', + ), + ], [ OCPP16IncomingRequestCommand.GET_CONFIGURATION, - this.handleRequestGetConfiguration.bind(this), + OCPP16ServiceUtils.parseJsonSchemaFile( + 'assets/json-schemas/ocpp/1.6/GetConfiguration.json', + moduleName, + 'constructor', + ), ], [ OCPP16IncomingRequestCommand.CHANGE_CONFIGURATION, - this.handleRequestChangeConfiguration.bind(this), + OCPP16ServiceUtils.parseJsonSchemaFile( + 'assets/json-schemas/ocpp/1.6/ChangeConfiguration.json', + moduleName, + 'constructor', + ), + ], + [ + OCPP16IncomingRequestCommand.GET_DIAGNOSTICS, + OCPP16ServiceUtils.parseJsonSchemaFile( + 'assets/json-schemas/ocpp/1.6/GetDiagnostics.json', + moduleName, + 'constructor', + ), + ], + [ + OCPP16IncomingRequestCommand.GET_COMPOSITE_SCHEDULE, + OCPP16ServiceUtils.parseJsonSchemaFile( + 'assets/json-schemas/ocpp/1.6/GetCompositeSchedule.json', + moduleName, + 'constructor', + ), ], [ OCPP16IncomingRequestCommand.SET_CHARGING_PROFILE, - this.handleRequestSetChargingProfile.bind(this), + OCPP16ServiceUtils.parseJsonSchemaFile( + 'assets/json-schemas/ocpp/1.6/SetChargingProfile.json', + moduleName, + 'constructor', + ), ], [ OCPP16IncomingRequestCommand.CLEAR_CHARGING_PROFILE, - this.handleRequestClearChargingProfile.bind(this), + OCPP16ServiceUtils.parseJsonSchemaFile( + 'assets/json-schemas/ocpp/1.6/ClearChargingProfile.json', + moduleName, + 'constructor', + ), ], [ OCPP16IncomingRequestCommand.CHANGE_AVAILABILITY, - this.handleRequestChangeAvailability.bind(this), + OCPP16ServiceUtils.parseJsonSchemaFile( + 'assets/json-schemas/ocpp/1.6/ChangeAvailability.json', + moduleName, + 'constructor', + ), ], [ OCPP16IncomingRequestCommand.REMOTE_START_TRANSACTION, - this.handleRequestRemoteStartTransaction.bind(this), + OCPP16ServiceUtils.parseJsonSchemaFile( + 'assets/json-schemas/ocpp/1.6/RemoteStartTransaction.json', + moduleName, + 'constructor', + ), ], [ OCPP16IncomingRequestCommand.REMOTE_STOP_TRANSACTION, - this.handleRequestRemoteStopTransaction.bind(this), + OCPP16ServiceUtils.parseJsonSchemaFile( + 'assets/json-schemas/ocpp/1.6/RemoteStopTransaction.json', + moduleName, + 'constructor', + ), + ], + [ + OCPP16IncomingRequestCommand.TRIGGER_MESSAGE, + OCPP16ServiceUtils.parseJsonSchemaFile( + 'assets/json-schemas/ocpp/1.6/TriggerMessage.json', + moduleName, + 'constructor', + ), + ], + [ + OCPP16IncomingRequestCommand.DATA_TRANSFER, + OCPP16ServiceUtils.parseJsonSchemaFile( + 'assets/json-schemas/ocpp/1.6/DataTransfer.json', + moduleName, + 'constructor', + ), + ], + [ + OCPP16IncomingRequestCommand.UPDATE_FIRMWARE, + OCPP16ServiceUtils.parseJsonSchemaFile( + 'assets/json-schemas/ocpp/1.6/UpdateFirmware.json', + moduleName, + 'constructor', + ), + ], + [ + OCPP16IncomingRequestCommand.RESERVE_NOW, + OCPP16ServiceUtils.parseJsonSchemaFile( + 'assets/json-schemas/ocpp/1.6/ReserveNow.json', + moduleName, + 'constructor', + ), + ], + [ + OCPP16IncomingRequestCommand.CANCEL_RESERVATION, + OCPP16ServiceUtils.parseJsonSchemaFile( + 'assets/json-schemas/ocpp/1.6/CancelReservation.json', + moduleName, + 'constructor', + ), ], - [OCPP16IncomingRequestCommand.GET_DIAGNOSTICS, this.handleRequestGetDiagnostics.bind(this)], - [OCPP16IncomingRequestCommand.TRIGGER_MESSAGE, this.handleRequestTriggerMessage.bind(this)], ]); + this.validatePayload = this.validatePayload.bind(this) as ( + chargingStation: ChargingStation, + commandName: OCPP16IncomingRequestCommand, + commandPayload: JsonType, + ) => boolean; } - public async handleRequest( + public async incomingRequestHandler( + chargingStation: ChargingStation, messageId: string, commandName: OCPP16IncomingRequestCommand, - commandPayload: JsonType + commandPayload: ReqType, ): Promise { - let result: JsonType; + let response: ResType; if ( - this.chargingStation.getOcppStrictCompliance() && - this.chargingStation.isInPendingState() && + chargingStation.getOcppStrictCompliance() === true && + chargingStation.inPendingState() === true && (commandName === OCPP16IncomingRequestCommand.REMOTE_START_TRANSACTION || commandName === OCPP16IncomingRequestCommand.REMOTE_STOP_TRANSACTION) ) { throw new OCPPError( ErrorType.SECURITY_ERROR, - `${commandName} cannot be issued to handle request payload ${JSON.stringify( + `${commandName} cannot be issued to handle request PDU ${JSON.stringify( commandPayload, null, - 2 + 2, )} while the charging station is in pending state on the central server`, - commandName + commandName, + commandPayload, ); } if ( - this.chargingStation.isRegistered() || - (!this.chargingStation.getOcppStrictCompliance() && this.chargingStation.isInUnknownState()) + chargingStation.isRegistered() === true || + (chargingStation.getOcppStrictCompliance() === false && + chargingStation.inUnknownState() === true) ) { - if (this.incomingRequestHandlers.has(commandName)) { + if ( + this.incomingRequestHandlers.has(commandName) === true && + OCPP16ServiceUtils.isIncomingRequestCommandSupported(chargingStation, commandName) === true + ) { try { - // Call the method to build the result - result = await this.incomingRequestHandlers.get(commandName)(commandPayload); + this.validatePayload(chargingStation, commandName, commandPayload); + // Call the method to build the response + response = (await this.incomingRequestHandlers.get(commandName)!( + chargingStation, + commandPayload, + )) as ResType; } catch (error) { // Log - logger.error(this.chargingStation.logPrefix() + ' Handle request error: %j', error); + logger.error( + `${chargingStation.logPrefix()} ${moduleName}.incomingRequestHandler: + Handle incoming request error:`, + error, + ); throw error; } } else { // Throw exception throw new OCPPError( ErrorType.NOT_IMPLEMENTED, - `${commandName} is not implemented to handle request payload ${JSON.stringify( + `${commandName} is not implemented to handle request PDU ${JSON.stringify( commandPayload, null, - 2 + 2, )}`, - commandName + commandName, + commandPayload, ); } } else { throw new OCPPError( ErrorType.SECURITY_ERROR, - `${commandName} cannot be issued to handle request payload ${JSON.stringify( + `${commandName} cannot be issued to handle request PDU ${JSON.stringify( commandPayload, null, - 2 + 2, )} while the charging station is not registered on the central server.`, - commandName + commandName, + commandPayload, ); } - // Send the built result - await this.chargingStation.ocppRequestService.sendResult(messageId, result, commandName); + // Send the built response + await chargingStation.ocppRequestService.sendResponse( + chargingStation, + messageId, + response, + commandName, + ); } - // Simulate charging station restart - private handleRequestReset(commandPayload: ResetRequest): DefaultResponse { - // eslint-disable-next-line @typescript-eslint/no-misused-promises - setImmediate(async (): Promise => { - await this.chargingStation.stop( - (commandPayload.type + 'Reset') as OCPP16StopTransactionReason + private validatePayload( + chargingStation: ChargingStation, + commandName: OCPP16IncomingRequestCommand, + commandPayload: JsonType, + ): boolean { + if (this.jsonSchemas.has(commandName) === true) { + return this.validateIncomingRequestPayload( + chargingStation, + commandName, + this.jsonSchemas.get(commandName)!, + commandPayload, ); - await Utils.sleep(this.chargingStation.stationInfo.resetTime); - this.chargingStation.start(); - }); - logger.info( - `${this.chargingStation.logPrefix()} ${ - commandPayload.type - } reset command received, simulating it. The station will be back online in ${Utils.formatDurationMilliSeconds( - this.chargingStation.stationInfo.resetTime - )}` + } + logger.warn( + `${chargingStation.logPrefix()} ${moduleName}.validatePayload: No JSON schema found + for command '${commandName}' PDU validation`, ); - return Constants.OCPP_RESPONSE_ACCEPTED; + return false; } - private handleRequestClearCache(): DefaultResponse { - return Constants.OCPP_RESPONSE_ACCEPTED; + // Simulate charging station restart + private handleRequestReset( + chargingStation: ChargingStation, + commandPayload: ResetRequest, + ): GenericResponse { + const { type } = commandPayload; + this.runInAsyncScope( + chargingStation.reset.bind(chargingStation) as ( + this: ChargingStation, + ...args: unknown[] + ) => Promise, + chargingStation, + `${type}Reset` as OCPP16StopTransactionReason, + ).catch(Constants.EMPTY_FUNCTION); + logger.info( + `${chargingStation.logPrefix()} ${type} reset command received, simulating it. The station will be + back online in ${formatDurationMilliSeconds(chargingStation.stationInfo.resetTime!)}`, + ); + return OCPP16Constants.OCPP_RESPONSE_ACCEPTED; } private async handleRequestUnlockConnector( - commandPayload: UnlockConnectorRequest + chargingStation: ChargingStation, + commandPayload: UnlockConnectorRequest, ): Promise { - const connectorId = commandPayload.connectorId; + const { connectorId } = commandPayload; + if (chargingStation.hasConnector(connectorId) === false) { + logger.error( + `${chargingStation.logPrefix()} Trying to unlock a non existing + connector id ${connectorId.toString()}`, + ); + return OCPP16Constants.OCPP_RESPONSE_UNLOCK_NOT_SUPPORTED; + } if (connectorId === 0) { logger.error( - this.chargingStation.logPrefix() + ' Trying to unlock connector ' + connectorId.toString() + `${chargingStation.logPrefix()} Trying to unlock connector id ${connectorId.toString()}`, ); - return Constants.OCPP_RESPONSE_UNLOCK_NOT_SUPPORTED; - } - 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 + return OCPP16Constants.OCPP_RESPONSE_UNLOCK_NOT_SUPPORTED; + } + if (chargingStation.getConnectorStatus(connectorId)?.transactionStarted === true) { + const stopResponse = await chargingStation.stopTransactionOnConnector( + connectorId, + OCPP16StopTransactionReason.UNLOCK_COMMAND, ); if (stopResponse.idTagInfo?.status === OCPP16AuthorizationStatus.ACCEPTED) { - return Constants.OCPP_RESPONSE_UNLOCKED; + return OCPP16Constants.OCPP_RESPONSE_UNLOCKED; } - return Constants.OCPP_RESPONSE_UNLOCK_FAILED; + return OCPP16Constants.OCPP_RESPONSE_UNLOCK_FAILED; } - await this.chargingStation.ocppRequestService.sendStatusNotification( + await OCPP16ServiceUtils.sendAndSetConnectorStatus( + chargingStation, connectorId, - OCPP16ChargePointStatus.AVAILABLE + OCPP16ChargePointStatus.Available, ); - this.chargingStation.getConnectorStatus(connectorId).status = OCPP16ChargePointStatus.AVAILABLE; - return Constants.OCPP_RESPONSE_UNLOCKED; + return OCPP16Constants.OCPP_RESPONSE_UNLOCKED; } private handleRequestGetConfiguration( - commandPayload: GetConfigurationRequest + chargingStation: ChargingStation, + commandPayload: GetConfigurationRequest, ): GetConfigurationResponse { + const { key } = commandPayload; const configurationKey: OCPPConfigurationKey[] = []; const unknownKey: string[] = []; - if (Utils.isEmptyArray(commandPayload.key)) { - for (const configuration of this.chargingStation.configuration.configurationKey) { - if (Utils.isUndefined(configuration.visible)) { + if (isUndefined(key) === true) { + for (const configuration of chargingStation.ocppConfiguration!.configurationKey!) { + if (isUndefined(configuration.visible) === true) { configuration.visible = true; } - if (!configuration.visible) { + if (configuration.visible === false) { continue; } configurationKey.push({ @@ -239,14 +528,14 @@ export default class OCPP16IncomingRequestService extends OCPPIncomingRequestSer value: configuration.value, }); } - } else { - for (const key of commandPayload.key) { - const keyFound = this.chargingStation.getConfigurationKey(key); + } else if (isNotEmptyArray(key) === true) { + for (const k of key!) { + const keyFound = getConfigurationKey(chargingStation, k, true); if (keyFound) { - if (Utils.isUndefined(keyFound.visible)) { + if (isUndefined(keyFound.visible) === true) { keyFound.visible = true; } - if (!keyFound.visible) { + if (keyFound.visible === false) { continue; } configurationKey.push({ @@ -255,7 +544,7 @@ export default class OCPP16IncomingRequestService extends OCPPIncomingRequestSer value: keyFound.value, }); } else { - unknownKey.push(key); + unknownKey.push(k); } } } @@ -266,497 +555,940 @@ export default class OCPP16IncomingRequestService extends OCPPIncomingRequestSer } private handleRequestChangeConfiguration( - commandPayload: ChangeConfigurationRequest + chargingStation: ChargingStation, + commandPayload: ChangeConfigurationRequest, ): ChangeConfigurationResponse { - // JSON request fields type sanity check - if (!Utils.isString(commandPayload.key)) { - logger.error( - `${this.chargingStation.logPrefix()} ${ - OCPP16IncomingRequestCommand.CHANGE_CONFIGURATION - } request key field is not a string:`, - commandPayload - ); - } - if (!Utils.isString(commandPayload.value)) { - logger.error( - `${this.chargingStation.logPrefix()} ${ - OCPP16IncomingRequestCommand.CHANGE_CONFIGURATION - } request value field is not a string:`, - commandPayload - ); - } - const keyToChange = this.chargingStation.getConfigurationKey(commandPayload.key, true); - if (!keyToChange) { - return Constants.OCPP_CONFIGURATION_RESPONSE_NOT_SUPPORTED; - } else if (keyToChange && keyToChange.readonly) { - return Constants.OCPP_CONFIGURATION_RESPONSE_REJECTED; - } else if (keyToChange && !keyToChange.readonly) { - const keyIndex = this.chargingStation.configuration.configurationKey.indexOf(keyToChange); + const { key, value } = commandPayload; + const keyToChange = getConfigurationKey(chargingStation, key, true); + if (keyToChange?.readonly === true) { + return OCPP16Constants.OCPP_CONFIGURATION_RESPONSE_REJECTED; + } else if (keyToChange?.readonly === false) { let valueChanged = false; - if ( - this.chargingStation.configuration.configurationKey[keyIndex].value !== commandPayload.value - ) { - this.chargingStation.configuration.configurationKey[keyIndex].value = commandPayload.value; + if (keyToChange.value !== value) { + setConfigurationKeyValue(chargingStation, key, value, true); valueChanged = true; } let triggerHeartbeatRestart = false; - if (keyToChange.key === OCPP16StandardParametersKey.HeartBeatInterval && valueChanged) { - this.chargingStation.setConfigurationKeyValue( + if ( + (keyToChange.key as OCPP16StandardParametersKey) === + OCPP16StandardParametersKey.HeartBeatInterval && + valueChanged + ) { + setConfigurationKeyValue( + chargingStation, OCPP16StandardParametersKey.HeartbeatInterval, - commandPayload.value + value, ); triggerHeartbeatRestart = true; } - if (keyToChange.key === OCPP16StandardParametersKey.HeartbeatInterval && valueChanged) { - this.chargingStation.setConfigurationKeyValue( + if ( + (keyToChange.key as OCPP16StandardParametersKey) === + OCPP16StandardParametersKey.HeartbeatInterval && + valueChanged + ) { + setConfigurationKeyValue( + chargingStation, OCPP16StandardParametersKey.HeartBeatInterval, - commandPayload.value + value, ); triggerHeartbeatRestart = true; } if (triggerHeartbeatRestart) { - this.chargingStation.restartHeartbeat(); + chargingStation.restartHeartbeat(); } - if (keyToChange.key === OCPP16StandardParametersKey.WebSocketPingInterval && valueChanged) { - this.chargingStation.restartWebSocketPing(); + if ( + (keyToChange.key as OCPP16StandardParametersKey) === + OCPP16StandardParametersKey.WebSocketPingInterval && + valueChanged + ) { + chargingStation.restartWebSocketPing(); } if (keyToChange.reboot) { - return Constants.OCPP_CONFIGURATION_RESPONSE_REBOOT_REQUIRED; + return OCPP16Constants.OCPP_CONFIGURATION_RESPONSE_REBOOT_REQUIRED; } - return Constants.OCPP_CONFIGURATION_RESPONSE_ACCEPTED; + return OCPP16Constants.OCPP_CONFIGURATION_RESPONSE_ACCEPTED; } + return OCPP16Constants.OCPP_CONFIGURATION_RESPONSE_NOT_SUPPORTED; } private handleRequestSetChargingProfile( - commandPayload: SetChargingProfileRequest + chargingStation: ChargingStation, + commandPayload: SetChargingProfileRequest, ): SetChargingProfileResponse { - if (!this.chargingStation.getConnectorStatus(commandPayload.connectorId)) { + if ( + OCPP16ServiceUtils.checkFeatureProfile( + chargingStation, + OCPP16SupportedFeatureProfiles.SmartCharging, + OCPP16IncomingRequestCommand.SET_CHARGING_PROFILE, + ) === false + ) { + return OCPP16Constants.OCPP_SET_CHARGING_PROFILE_RESPONSE_NOT_SUPPORTED; + } + const { connectorId, csChargingProfiles } = commandPayload; + if (chargingStation.hasConnector(connectorId) === false) { logger.error( - `${this.chargingStation.logPrefix()} Trying to set charging profile(s) to a non existing connector Id ${ - commandPayload.connectorId - }` + `${chargingStation.logPrefix()} Trying to set charging profile(s) to a + non existing connector id ${connectorId}`, ); - return Constants.OCPP_SET_CHARGING_PROFILE_RESPONSE_REJECTED; + return OCPP16Constants.OCPP_SET_CHARGING_PROFILE_RESPONSE_REJECTED; } if ( - commandPayload.csChargingProfiles.chargingProfilePurpose === - ChargingProfilePurposeType.CHARGE_POINT_MAX_PROFILE && - commandPayload.connectorId !== 0 + csChargingProfiles.chargingProfilePurpose === + OCPP16ChargingProfilePurposeType.CHARGE_POINT_MAX_PROFILE && + connectorId !== 0 ) { - return Constants.OCPP_SET_CHARGING_PROFILE_RESPONSE_REJECTED; + return OCPP16Constants.OCPP_SET_CHARGING_PROFILE_RESPONSE_REJECTED; } if ( - commandPayload.csChargingProfiles.chargingProfilePurpose === - ChargingProfilePurposeType.TX_PROFILE && - (commandPayload.connectorId === 0 || - !this.chargingStation.getConnectorStatus(commandPayload.connectorId)?.transactionStarted) + csChargingProfiles.chargingProfilePurpose === OCPP16ChargingProfilePurposeType.TX_PROFILE && + (connectorId === 0 || + chargingStation.getConnectorStatus(connectorId)?.transactionStarted === false) ) { - return Constants.OCPP_SET_CHARGING_PROFILE_RESPONSE_REJECTED; + logger.error( + `${chargingStation.logPrefix()} Trying to set transaction charging profile(s) + on connector ${connectorId} without a started transaction`, + ); + return OCPP16Constants.OCPP_SET_CHARGING_PROFILE_RESPONSE_REJECTED; } - this.chargingStation.setChargingProfile( - commandPayload.connectorId, - commandPayload.csChargingProfiles - ); + OCPP16ServiceUtils.setChargingProfile(chargingStation, connectorId, csChargingProfiles); logger.debug( - `${this.chargingStation.logPrefix()} Charging profile(s) set, dump their stack: %j`, - this.chargingStation.getConnectorStatus(commandPayload.connectorId).chargingProfiles + `${chargingStation.logPrefix()} Charging profile(s) set on connector id ${connectorId}: %j`, + csChargingProfiles, ); - return Constants.OCPP_SET_CHARGING_PROFILE_RESPONSE_ACCEPTED; + return OCPP16Constants.OCPP_SET_CHARGING_PROFILE_RESPONSE_ACCEPTED; + } + + private handleRequestGetCompositeSchedule( + chargingStation: ChargingStation, + commandPayload: OCPP16GetCompositeScheduleRequest, + ): OCPP16GetCompositeScheduleResponse { + if ( + OCPP16ServiceUtils.checkFeatureProfile( + chargingStation, + OCPP16SupportedFeatureProfiles.SmartCharging, + OCPP16IncomingRequestCommand.GET_COMPOSITE_SCHEDULE, + ) === false + ) { + return OCPP16Constants.OCPP_RESPONSE_REJECTED; + } + const { connectorId, duration, chargingRateUnit } = commandPayload; + if (chargingStation.hasConnector(connectorId) === false) { + logger.error( + `${chargingStation.logPrefix()} Trying to get composite schedule to a + non existing connector id ${connectorId}`, + ); + return OCPP16Constants.OCPP_RESPONSE_REJECTED; + } + if (connectorId === 0) { + logger.error( + `${chargingStation.logPrefix()} Get composite schedule on connector id ${connectorId} is not yet supported`, + ); + return OCPP16Constants.OCPP_RESPONSE_REJECTED; + } + if (chargingRateUnit) { + logger.warn( + `${chargingStation.logPrefix()} Get composite schedule with a specified rate unit is not yet supported, no conversion will be done`, + ); + } + const connectorStatus = chargingStation.getConnectorStatus(connectorId)!; + if ( + isEmptyArray( + connectorStatus?.chargingProfiles && + isEmptyArray(chargingStation.getConnectorStatus(0)?.chargingProfiles), + ) + ) { + return OCPP16Constants.OCPP_RESPONSE_REJECTED; + } + const currentDate = new Date(); + const interval: Interval = { + start: currentDate, + end: addSeconds(currentDate, duration), + }; + // Get charging profiles sorted by connector id then stack level + const storedChargingProfiles: OCPP16ChargingProfile[] = getConnectorChargingProfiles( + chargingStation, + connectorId, + ); + const chargingProfiles: OCPP16ChargingProfile[] = []; + for (const storedChargingProfile of storedChargingProfiles) { + if ( + connectorStatus?.transactionStarted && + isNullOrUndefined(storedChargingProfile.chargingSchedule?.startSchedule) + ) { + logger.debug( + `${chargingStation.logPrefix()} ${moduleName}.handleRequestGetCompositeSchedule: Charging profile id ${ + storedChargingProfile.chargingProfileId + } has no startSchedule defined. Trying to set it to the connector current transaction start date`, + ); + // OCPP specifies that if startSchedule is not defined, it should be relative to start of the connector transaction + storedChargingProfile.chargingSchedule.startSchedule = connectorStatus?.transactionStart; + } + if (!isDate(storedChargingProfile.chargingSchedule?.startSchedule)) { + logger.warn( + `${chargingStation.logPrefix()} ${moduleName}.handleRequestGetCompositeSchedule: Charging profile id ${ + storedChargingProfile.chargingProfileId + } startSchedule property is not a Date object. Trying to convert it to a Date object`, + ); + storedChargingProfile.chargingSchedule.startSchedule = convertToDate( + storedChargingProfile.chargingSchedule?.startSchedule, + )!; + } + if ( + !prepareChargingProfileKind( + connectorStatus, + storedChargingProfile, + interval.start as Date, + chargingStation.logPrefix(), + ) + ) { + continue; + } + if ( + !canProceedChargingProfile( + storedChargingProfile, + interval.start as Date, + chargingStation.logPrefix(), + ) + ) { + continue; + } + // Add active charging profiles into chargingProfiles array + if ( + isValidTime(storedChargingProfile.chargingSchedule?.startSchedule) && + isWithinInterval(storedChargingProfile.chargingSchedule.startSchedule!, interval) + ) { + if (isEmptyArray(chargingProfiles)) { + if ( + isAfter( + addSeconds( + storedChargingProfile.chargingSchedule.startSchedule!, + storedChargingProfile.chargingSchedule.duration!, + ), + interval.end, + ) + ) { + storedChargingProfile.chargingSchedule.chargingSchedulePeriod = + storedChargingProfile.chargingSchedule.chargingSchedulePeriod.filter( + (schedulePeriod) => + isWithinInterval( + addSeconds( + storedChargingProfile.chargingSchedule.startSchedule!, + schedulePeriod.startPeriod, + )!, + interval, + ), + ); + storedChargingProfile.chargingSchedule.duration = differenceInSeconds( + interval.end, + storedChargingProfile.chargingSchedule.startSchedule!, + ); + } + chargingProfiles.push(storedChargingProfile); + } else if (isNotEmptyArray(chargingProfiles)) { + const chargingProfilesInterval: Interval = { + start: min( + chargingProfiles.map( + (chargingProfile) => chargingProfile.chargingSchedule.startSchedule ?? maxTime, + ), + ), + end: max( + chargingProfiles.map( + (chargingProfile) => + addSeconds( + chargingProfile.chargingSchedule.startSchedule!, + chargingProfile.chargingSchedule.duration!, + ) ?? minTime, + ), + ), + }; + let addChargingProfile = false; + if ( + isBefore(interval.start, chargingProfilesInterval.start) && + isBefore( + storedChargingProfile.chargingSchedule.startSchedule!, + chargingProfilesInterval.start, + ) + ) { + // Remove charging schedule periods that are after the start of the active profiles interval + storedChargingProfile.chargingSchedule.chargingSchedulePeriod = + storedChargingProfile.chargingSchedule.chargingSchedulePeriod.filter( + (schedulePeriod) => + isWithinInterval( + addSeconds( + storedChargingProfile.chargingSchedule.startSchedule!, + schedulePeriod.startPeriod, + ), + { + start: interval.start, + end: chargingProfilesInterval.start, + }, + ), + ); + addChargingProfile = true; + } + if ( + isBefore(chargingProfilesInterval.end, interval.end) && + isAfter( + addSeconds( + storedChargingProfile.chargingSchedule.startSchedule!, + storedChargingProfile.chargingSchedule.duration!, + ), + chargingProfilesInterval.end, + ) + ) { + // Remove charging schedule periods that are before the end of the active profiles interval + // FIXME: can lead to a gap in the charging schedule: chargingProfilesInterval.end -> first matching schedulePeriod.startPeriod + storedChargingProfile.chargingSchedule.chargingSchedulePeriod = + storedChargingProfile.chargingSchedule.chargingSchedulePeriod.filter( + (schedulePeriod) => + isWithinInterval( + addSeconds( + storedChargingProfile.chargingSchedule.startSchedule!, + schedulePeriod.startPeriod, + ), + { + start: chargingProfilesInterval.end, + end: interval.end, + }, + ), + ); + addChargingProfile = true; + } + addChargingProfile && chargingProfiles.push(storedChargingProfile); + } + } + } + const compositeScheduleStart: Date = min( + chargingProfiles.map( + (chargingProfile) => chargingProfile.chargingSchedule.startSchedule ?? maxTime, + ), + ); + const compositeScheduleDuration: number = Math.max( + ...chargingProfiles.map((chargingProfile) => + isNaN(chargingProfile.chargingSchedule.duration!) + ? -Infinity + : chargingProfile.chargingSchedule.duration!, + ), + ); + const compositeSchedulePeriods: OCPP16ChargingSchedulePeriod[] = chargingProfiles + .map((chargingProfile) => chargingProfile.chargingSchedule.chargingSchedulePeriod) + .reduce( + (accumulator, value) => + accumulator.concat(value).sort((a, b) => a.startPeriod - b.startPeriod), + [], + ); + const compositeSchedule: OCPP16ChargingSchedule = { + startSchedule: compositeScheduleStart, + duration: compositeScheduleDuration, + chargingRateUnit: chargingProfiles.every( + (chargingProfile) => + chargingProfile.chargingSchedule.chargingRateUnit === OCPP16ChargingRateUnitType.AMPERE, + ) + ? OCPP16ChargingRateUnitType.AMPERE + : chargingProfiles.every( + (chargingProfile) => + chargingProfile.chargingSchedule.chargingRateUnit === OCPP16ChargingRateUnitType.WATT, + ) + ? OCPP16ChargingRateUnitType.WATT + : OCPP16ChargingRateUnitType.AMPERE, + chargingSchedulePeriod: compositeSchedulePeriods, + minChargeRate: Math.min( + ...chargingProfiles.map((chargingProfile) => + isNaN(chargingProfile.chargingSchedule.minChargeRate!) + ? Infinity + : chargingProfile.chargingSchedule.minChargeRate!, + ), + ), + }; + return { + status: GenericStatus.Accepted, + scheduleStart: compositeSchedule.startSchedule!, + connectorId, + chargingSchedule: compositeSchedule, + }; } private handleRequestClearChargingProfile( - commandPayload: ClearChargingProfileRequest + chargingStation: ChargingStation, + commandPayload: ClearChargingProfileRequest, ): ClearChargingProfileResponse { - if (!this.chargingStation.getConnectorStatus(commandPayload.connectorId)) { + if ( + OCPP16ServiceUtils.checkFeatureProfile( + chargingStation, + OCPP16SupportedFeatureProfiles.SmartCharging, + OCPP16IncomingRequestCommand.CLEAR_CHARGING_PROFILE, + ) === false + ) { + return OCPP16Constants.OCPP_CLEAR_CHARGING_PROFILE_RESPONSE_UNKNOWN; + } + const { connectorId } = commandPayload; + if (chargingStation.hasConnector(connectorId!) === false) { logger.error( - `${this.chargingStation.logPrefix()} Trying to clear a charging profile(s) to a non existing connector Id ${ - commandPayload.connectorId - }` + `${chargingStation.logPrefix()} Trying to clear a charging profile(s) to + a non existing connector id ${connectorId}`, ); - return Constants.OCPP_CLEAR_CHARGING_PROFILE_RESPONSE_UNKNOWN; + return OCPP16Constants.OCPP_CLEAR_CHARGING_PROFILE_RESPONSE_UNKNOWN; } if ( - commandPayload.connectorId && - !Utils.isEmptyArray( - this.chargingStation.getConnectorStatus(commandPayload.connectorId).chargingProfiles - ) + !isNullOrUndefined(connectorId) && + isNotEmptyArray(chargingStation.getConnectorStatus(connectorId!)?.chargingProfiles) ) { - this.chargingStation.getConnectorStatus(commandPayload.connectorId).chargingProfiles = []; + chargingStation.getConnectorStatus(connectorId!)!.chargingProfiles = []; logger.debug( - `${this.chargingStation.logPrefix()} Charging profile(s) cleared, dump their stack: %j`, - this.chargingStation.getConnectorStatus(commandPayload.connectorId).chargingProfiles + `${chargingStation.logPrefix()} Charging profile(s) cleared on connector id ${connectorId}`, ); - return Constants.OCPP_CLEAR_CHARGING_PROFILE_RESPONSE_ACCEPTED; + return OCPP16Constants.OCPP_CLEAR_CHARGING_PROFILE_RESPONSE_ACCEPTED; } - if (!commandPayload.connectorId) { + if (isNullOrUndefined(connectorId)) { let clearedCP = false; - for (const connectorId of this.chargingStation.connectors.keys()) { - if ( - !Utils.isEmptyArray(this.chargingStation.getConnectorStatus(connectorId).chargingProfiles) - ) { - this.chargingStation - .getConnectorStatus(connectorId) - .chargingProfiles?.forEach((chargingProfile: OCPP16ChargingProfile, index: number) => { - let clearCurrentCP = false; - if (chargingProfile.chargingProfileId === commandPayload.id) { - clearCurrentCP = true; - } - if ( - !commandPayload.chargingProfilePurpose && - chargingProfile.stackLevel === commandPayload.stackLevel - ) { - clearCurrentCP = true; - } - if ( - !chargingProfile.stackLevel && - chargingProfile.chargingProfilePurpose === commandPayload.chargingProfilePurpose - ) { - clearCurrentCP = true; - } - if ( - chargingProfile.stackLevel === commandPayload.stackLevel && - chargingProfile.chargingProfilePurpose === commandPayload.chargingProfilePurpose - ) { - clearCurrentCP = true; - } - if (clearCurrentCP) { - this.chargingStation.getConnectorStatus( - commandPayload.connectorId - ).chargingProfiles[index] = {} as OCPP16ChargingProfile; - logger.debug( - `${this.chargingStation.logPrefix()} Charging profile(s) cleared, dump their stack: %j`, - this.chargingStation.getConnectorStatus(commandPayload.connectorId) - .chargingProfiles - ); - clearedCP = true; - } - }); + if (chargingStation.hasEvses) { + for (const evseStatus of chargingStation.evses.values()) { + for (const connectorStatus of evseStatus.connectors.values()) { + clearedCP = OCPP16ServiceUtils.clearChargingProfiles( + chargingStation, + commandPayload, + connectorStatus.chargingProfiles, + ); + } + } + } else { + for (const id of chargingStation.connectors.keys()) { + clearedCP = OCPP16ServiceUtils.clearChargingProfiles( + chargingStation, + commandPayload, + chargingStation.getConnectorStatus(id)?.chargingProfiles, + ); } } if (clearedCP) { - return Constants.OCPP_CLEAR_CHARGING_PROFILE_RESPONSE_ACCEPTED; + return OCPP16Constants.OCPP_CLEAR_CHARGING_PROFILE_RESPONSE_ACCEPTED; } } - return Constants.OCPP_CLEAR_CHARGING_PROFILE_RESPONSE_UNKNOWN; + return OCPP16Constants.OCPP_CLEAR_CHARGING_PROFILE_RESPONSE_UNKNOWN; } private async handleRequestChangeAvailability( - commandPayload: ChangeAvailabilityRequest - ): Promise { - const connectorId: number = commandPayload.connectorId; - if (!this.chargingStation.getConnectorStatus(connectorId)) { + chargingStation: ChargingStation, + commandPayload: OCPP16ChangeAvailabilityRequest, + ): Promise { + const { connectorId, type } = commandPayload; + if (chargingStation.hasConnector(connectorId) === false) { logger.error( - `${this.chargingStation.logPrefix()} Trying to change the availability of a non existing connector Id ${connectorId.toString()}` + `${chargingStation.logPrefix()} Trying to change the availability of a + non existing connector id ${connectorId.toString()}`, ); - return Constants.OCPP_AVAILABILITY_RESPONSE_REJECTED; + return OCPP16Constants.OCPP_AVAILABILITY_RESPONSE_REJECTED; } const chargePointStatus: OCPP16ChargePointStatus = - commandPayload.type === OCPP16AvailabilityType.OPERATIVE - ? OCPP16ChargePointStatus.AVAILABLE - : OCPP16ChargePointStatus.UNAVAILABLE; + type === OCPP16AvailabilityType.Operative + ? OCPP16ChargePointStatus.Available + : OCPP16ChargePointStatus.Unavailable; if (connectorId === 0) { - let response: ChangeAvailabilityResponse = Constants.OCPP_AVAILABILITY_RESPONSE_ACCEPTED; - for (const id of this.chargingStation.connectors.keys()) { - if (this.chargingStation.getConnectorStatus(id)?.transactionStarted) { - response = Constants.OCPP_AVAILABILITY_RESPONSE_SCHEDULED; - } - this.chargingStation.getConnectorStatus(id).availability = commandPayload.type; - if (response === Constants.OCPP_AVAILABILITY_RESPONSE_ACCEPTED) { - await this.chargingStation.ocppRequestService.sendStatusNotification( - id, - chargePointStatus + let response: OCPP16ChangeAvailabilityResponse; + if (chargingStation.hasEvses) { + for (const evseStatus of chargingStation.evses.values()) { + response = await OCPP16ServiceUtils.changeAvailability( + chargingStation, + [...evseStatus.connectors.keys()], + chargePointStatus, + type, ); - this.chargingStation.getConnectorStatus(id).status = chargePointStatus; } + } else { + response = await OCPP16ServiceUtils.changeAvailability( + chargingStation, + [...chargingStation.connectors.keys()], + chargePointStatus, + type, + ); } - return response; + return response!; } else if ( connectorId > 0 && - (this.chargingStation.getConnectorStatus(0).availability === - OCPP16AvailabilityType.OPERATIVE || - (this.chargingStation.getConnectorStatus(0).availability === - OCPP16AvailabilityType.INOPERATIVE && - commandPayload.type === OCPP16AvailabilityType.INOPERATIVE)) + (chargingStation.isChargingStationAvailable() === true || + (chargingStation.isChargingStationAvailable() === false && + type === OCPP16AvailabilityType.Inoperative)) ) { - if (this.chargingStation.getConnectorStatus(connectorId)?.transactionStarted) { - this.chargingStation.getConnectorStatus(connectorId).availability = commandPayload.type; - return Constants.OCPP_AVAILABILITY_RESPONSE_SCHEDULED; + if (chargingStation.getConnectorStatus(connectorId)?.transactionStarted === true) { + chargingStation.getConnectorStatus(connectorId)!.availability = type; + return OCPP16Constants.OCPP_AVAILABILITY_RESPONSE_SCHEDULED; } - this.chargingStation.getConnectorStatus(connectorId).availability = commandPayload.type; - await this.chargingStation.ocppRequestService.sendStatusNotification( + chargingStation.getConnectorStatus(connectorId)!.availability = type; + await OCPP16ServiceUtils.sendAndSetConnectorStatus( + chargingStation, connectorId, - chargePointStatus + chargePointStatus, ); - this.chargingStation.getConnectorStatus(connectorId).status = chargePointStatus; - return Constants.OCPP_AVAILABILITY_RESPONSE_ACCEPTED; + return OCPP16Constants.OCPP_AVAILABILITY_RESPONSE_ACCEPTED; } - return Constants.OCPP_AVAILABILITY_RESPONSE_REJECTED; + return OCPP16Constants.OCPP_AVAILABILITY_RESPONSE_REJECTED; } private async handleRequestRemoteStartTransaction( - commandPayload: RemoteStartTransactionRequest - ): Promise { - const transactionConnectorId: number = commandPayload.connectorId; - if (transactionConnectorId) { - await this.chargingStation.ocppRequestService.sendStatusNotification( + chargingStation: ChargingStation, + commandPayload: RemoteStartTransactionRequest, + ): Promise { + const { connectorId: transactionConnectorId, idTag, chargingProfile } = commandPayload; + if (chargingStation.hasConnector(transactionConnectorId) === false) { + return this.notifyRemoteStartTransactionRejected( + chargingStation, transactionConnectorId, - OCPP16ChargePointStatus.PREPARING + idTag, ); - this.chargingStation.getConnectorStatus(transactionConnectorId).status = - OCPP16ChargePointStatus.PREPARING; + } + if ( + !chargingStation.isChargingStationAvailable() || + !chargingStation.isConnectorAvailable(transactionConnectorId) + ) { + return this.notifyRemoteStartTransactionRejected( + chargingStation, + transactionConnectorId, + idTag, + ); + } + const remoteStartTransactionLogMsg = ` + ${chargingStation.logPrefix()} Transaction remotely STARTED on ${ + chargingStation.stationInfo.chargingStationId + }#${transactionConnectorId.toString()} for idTag '${idTag}'`; + await OCPP16ServiceUtils.sendAndSetConnectorStatus( + chargingStation, + transactionConnectorId, + OCPP16ChargePointStatus.Preparing, + ); + const connectorStatus = chargingStation.getConnectorStatus(transactionConnectorId)!; + // Authorization check required + if ( + chargingStation.getAuthorizeRemoteTxRequests() === true && + (await OCPP16ServiceUtils.isIdTagAuthorized(chargingStation, transactionConnectorId, idTag)) + ) { + // Authorization successful, start transaction if ( - this.chargingStation.isChargingStationAvailable() && - this.chargingStation.isConnectorAvailable(transactionConnectorId) + this.setRemoteStartTransactionChargingProfile( + chargingStation, + transactionConnectorId, + chargingProfile!, + ) === true ) { - // Check if authorized - if (this.chargingStation.getAuthorizeRemoteTxRequests()) { - let authorized = false; - if ( - this.chargingStation.getLocalAuthListEnabled() && - this.chargingStation.hasAuthorizedTags() && - this.chargingStation.authorizedTags.find((value) => value === commandPayload.idTag) - ) { - this.chargingStation.getConnectorStatus(transactionConnectorId).localAuthorizeIdTag = - commandPayload.idTag; - this.chargingStation.getConnectorStatus(transactionConnectorId).idTagLocalAuthorized = - true; - authorized = true; - } else if (this.chargingStation.getMayAuthorizeAtRemoteStart()) { - const authorizeResponse = await this.chargingStation.ocppRequestService.sendAuthorize( - transactionConnectorId, - commandPayload.idTag - ); - if (authorizeResponse?.idTagInfo?.status === OCPP16AuthorizationStatus.ACCEPTED) { - authorized = true; - } - } else { - logger.warn( - `${this.chargingStation.logPrefix()} The charging station configuration expects authorize at remote start transaction but local authorization or authorize isn't enabled` - ); - } - if (authorized) { - // Authorization successful, start transaction - if ( - this.setRemoteStartTransactionChargingProfile( - transactionConnectorId, - commandPayload.chargingProfile - ) - ) { - this.chargingStation.getConnectorStatus( - transactionConnectorId - ).transactionRemoteStarted = true; - if ( - ( - await this.chargingStation.ocppRequestService.sendStartTransaction( - transactionConnectorId, - commandPayload.idTag - ) - ).idTagInfo.status === OCPP16AuthorizationStatus.ACCEPTED - ) { - logger.debug( - this.chargingStation.logPrefix() + - ' Transaction remotely STARTED on ' + - this.chargingStation.stationInfo.chargingStationId + - '#' + - transactionConnectorId.toString() + - ' for idTag ' + - commandPayload.idTag - ); - return Constants.OCPP_RESPONSE_ACCEPTED; - } - return this.notifyRemoteStartTransactionRejected( - transactionConnectorId, - commandPayload.idTag - ); - } - return this.notifyRemoteStartTransactionRejected( - transactionConnectorId, - commandPayload.idTag - ); - } - return this.notifyRemoteStartTransactionRejected( - transactionConnectorId, - commandPayload.idTag - ); - } - // No authorization check required, start transaction + connectorStatus.transactionRemoteStarted = true; if ( - this.setRemoteStartTransactionChargingProfile( - transactionConnectorId, - commandPayload.chargingProfile - ) + ( + await chargingStation.ocppRequestService.requestHandler< + OCPP16StartTransactionRequest, + OCPP16StartTransactionResponse + >(chargingStation, OCPP16RequestCommand.START_TRANSACTION, { + connectorId: transactionConnectorId, + idTag, + }) + ).idTagInfo.status === OCPP16AuthorizationStatus.ACCEPTED ) { - this.chargingStation.getConnectorStatus(transactionConnectorId).transactionRemoteStarted = - true; - if ( - ( - await this.chargingStation.ocppRequestService.sendStartTransaction( - transactionConnectorId, - commandPayload.idTag - ) - ).idTagInfo.status === OCPP16AuthorizationStatus.ACCEPTED - ) { - logger.debug( - this.chargingStation.logPrefix() + - ' Transaction remotely STARTED on ' + - this.chargingStation.stationInfo.chargingStationId + - '#' + - transactionConnectorId.toString() + - ' for idTag ' + - commandPayload.idTag - ); - return Constants.OCPP_RESPONSE_ACCEPTED; - } - return this.notifyRemoteStartTransactionRejected( - transactionConnectorId, - commandPayload.idTag - ); + logger.debug(remoteStartTransactionLogMsg); + return OCPP16Constants.OCPP_RESPONSE_ACCEPTED; } return this.notifyRemoteStartTransactionRejected( + chargingStation, transactionConnectorId, - commandPayload.idTag + idTag, ); } return this.notifyRemoteStartTransactionRejected( + chargingStation, transactionConnectorId, - commandPayload.idTag + idTag, ); } - return this.notifyRemoteStartTransactionRejected(transactionConnectorId, commandPayload.idTag); + // No authorization check required, start transaction + if ( + this.setRemoteStartTransactionChargingProfile( + chargingStation, + transactionConnectorId, + chargingProfile!, + ) === true + ) { + connectorStatus.transactionRemoteStarted = true; + if ( + ( + await chargingStation.ocppRequestService.requestHandler< + OCPP16StartTransactionRequest, + OCPP16StartTransactionResponse + >(chargingStation, OCPP16RequestCommand.START_TRANSACTION, { + connectorId: transactionConnectorId, + idTag, + }) + ).idTagInfo.status === OCPP16AuthorizationStatus.ACCEPTED + ) { + logger.debug(remoteStartTransactionLogMsg); + return OCPP16Constants.OCPP_RESPONSE_ACCEPTED; + } + return this.notifyRemoteStartTransactionRejected( + chargingStation, + transactionConnectorId, + idTag, + ); + } + return this.notifyRemoteStartTransactionRejected( + chargingStation, + transactionConnectorId, + idTag, + ); } private async notifyRemoteStartTransactionRejected( + chargingStation: ChargingStation, connectorId: number, - idTag: string - ): Promise { + idTag: string, + ): Promise { if ( - this.chargingStation.getConnectorStatus(connectorId).status !== - OCPP16ChargePointStatus.AVAILABLE + chargingStation.getConnectorStatus(connectorId)?.status !== OCPP16ChargePointStatus.Available ) { - await this.chargingStation.ocppRequestService.sendStatusNotification( + await OCPP16ServiceUtils.sendAndSetConnectorStatus( + chargingStation, connectorId, - OCPP16ChargePointStatus.AVAILABLE + OCPP16ChargePointStatus.Available, ); - this.chargingStation.getConnectorStatus(connectorId).status = - OCPP16ChargePointStatus.AVAILABLE; } logger.warn( - this.chargingStation.logPrefix() + - ' Remote starting transaction REJECTED on connector Id ' + - connectorId.toString() + - ', idTag ' + - idTag + - ', availability ' + - this.chargingStation.getConnectorStatus(connectorId).availability + - ', status ' + - this.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 Constants.OCPP_RESPONSE_REJECTED; + return OCPP16Constants.OCPP_RESPONSE_REJECTED; } private setRemoteStartTransactionChargingProfile( + chargingStation: ChargingStation, connectorId: number, - cp: OCPP16ChargingProfile + chargingProfile: OCPP16ChargingProfile, ): boolean { - if (cp && cp.chargingProfilePurpose === ChargingProfilePurposeType.TX_PROFILE) { - this.chargingStation.setChargingProfile(connectorId, cp); + if ( + chargingProfile && + chargingProfile.chargingProfilePurpose === OCPP16ChargingProfilePurposeType.TX_PROFILE + ) { + OCPP16ServiceUtils.setChargingProfile(chargingStation, connectorId, chargingProfile); logger.debug( - `${this.chargingStation.logPrefix()} Charging profile(s) set at remote start transaction, dump their stack: %j`, - this.chargingStation.getConnectorStatus(connectorId).chargingProfiles + `${chargingStation.logPrefix()} Charging profile(s) set at remote start transaction + on connector id ${connectorId}: %j`, + chargingProfile, ); return true; - } else if (cp && cp.chargingProfilePurpose !== ChargingProfilePurposeType.TX_PROFILE) { + } else if ( + chargingProfile && + chargingProfile.chargingProfilePurpose !== OCPP16ChargingProfilePurposeType.TX_PROFILE + ) { logger.warn( - `${this.chargingStation.logPrefix()} Not allowed to set ${ - cp.chargingProfilePurpose - } charging profile(s) at remote start transaction` + `${chargingStation.logPrefix()} Not allowed to set ${ + chargingProfile.chargingProfilePurpose + } charging profile(s) at remote start transaction`, ); return false; - } else if (!cp) { - return true; } + return true; } private async handleRequestRemoteStopTransaction( - commandPayload: RemoteStopTransactionRequest - ): Promise { - const transactionId = commandPayload.transactionId; - for (const connectorId of this.chargingStation.connectors.keys()) { - if ( - connectorId > 0 && - this.chargingStation.getConnectorStatus(connectorId)?.transactionId === transactionId - ) { - await this.chargingStation.ocppRequestService.sendStatusNotification( - connectorId, - OCPP16ChargePointStatus.FINISHING - ); - this.chargingStation.getConnectorStatus(connectorId).status = - OCPP16ChargePointStatus.FINISHING; - await this.chargingStation.ocppRequestService.sendStopTransaction( - transactionId, - this.chargingStation.getEnergyActiveImportRegisterByTransactionId(transactionId), - this.chargingStation.getTransactionIdTag(transactionId) - ); - return Constants.OCPP_RESPONSE_ACCEPTED; + chargingStation: ChargingStation, + commandPayload: RemoteStopTransactionRequest, + ): Promise { + const { transactionId } = commandPayload; + if (chargingStation.hasEvses) { + for (const [evseId, evseStatus] of chargingStation.evses) { + if (evseId > 0) { + for (const [connectorId, connectorStatus] of evseStatus.connectors) { + if (connectorStatus.transactionId === transactionId) { + return OCPP16ServiceUtils.remoteStopTransaction(chargingStation, connectorId); + } + } + } + } + } else { + for (const connectorId of chargingStation.connectors.keys()) { + if ( + connectorId > 0 && + chargingStation.getConnectorStatus(connectorId)?.transactionId === transactionId + ) { + return OCPP16ServiceUtils.remoteStopTransaction(chargingStation, connectorId); + } } } - logger.info( - this.chargingStation.logPrefix() + - ' Trying to remote stop a non existing transaction ' + - transactionId.toString() + logger.warn( + `${chargingStation.logPrefix()} Trying to remote stop a non existing transaction with id + ${transactionId.toString()}`, ); - return Constants.OCPP_RESPONSE_REJECTED; + return OCPP16Constants.OCPP_RESPONSE_REJECTED; + } + + private handleRequestUpdateFirmware( + chargingStation: ChargingStation, + commandPayload: OCPP16UpdateFirmwareRequest, + ): OCPP16UpdateFirmwareResponse { + if ( + OCPP16ServiceUtils.checkFeatureProfile( + chargingStation, + OCPP16SupportedFeatureProfiles.FirmwareManagement, + OCPP16IncomingRequestCommand.UPDATE_FIRMWARE, + ) === false + ) { + logger.warn( + `${chargingStation.logPrefix()} ${moduleName}.handleRequestUpdateFirmware: + Cannot simulate firmware update: feature profile not supported`, + ); + return OCPP16Constants.OCPP_RESPONSE_EMPTY; + } + let { retrieveDate } = commandPayload; + if ( + !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 OCPP16Constants.OCPP_RESPONSE_EMPTY; + } + retrieveDate = convertToDate(retrieveDate)!; + const now = Date.now(); + if (retrieveDate?.getTime() <= now) { + this.runInAsyncScope( + this.updateFirmwareSimulation.bind(this) as ( + this: OCPP16IncomingRequestService, + ...args: unknown[] + ) => Promise, + this, + chargingStation, + ).catch(Constants.EMPTY_FUNCTION); + } else { + setTimeout( + () => { + this.runInAsyncScope( + this.updateFirmwareSimulation.bind(this) as ( + this: OCPP16IncomingRequestService, + ...args: unknown[] + ) => Promise, + this, + chargingStation, + ).catch(Constants.EMPTY_FUNCTION); + }, + retrieveDate?.getTime() - now, + ); + } + return OCPP16Constants.OCPP_RESPONSE_EMPTY; + } + + private async updateFirmwareSimulation( + chargingStation: ChargingStation, + maxDelay = 30, + minDelay = 15, + ): Promise { + if (checkChargingStation(chargingStation, chargingStation.logPrefix()) === false) { + return; + } + if (chargingStation.hasEvses) { + for (const [evseId, evseStatus] of chargingStation.evses) { + if (evseId > 0) { + for (const [connectorId, connectorStatus] of evseStatus.connectors) { + if (connectorStatus?.transactionStarted === false) { + await OCPP16ServiceUtils.sendAndSetConnectorStatus( + chargingStation, + connectorId, + OCPP16ChargePointStatus.Unavailable, + ); + } + } + } + } + } else { + for (const connectorId of chargingStation.connectors.keys()) { + if ( + connectorId > 0 && + chargingStation.getConnectorStatus(connectorId)?.transactionStarted === false + ) { + await OCPP16ServiceUtils.sendAndSetConnectorStatus( + chargingStation, + connectorId, + OCPP16ChargePointStatus.Unavailable, + ); + } + } + } + await chargingStation.ocppRequestService.requestHandler< + OCPP16FirmwareStatusNotificationRequest, + OCPP16FirmwareStatusNotificationResponse + >(chargingStation, OCPP16RequestCommand.FIRMWARE_STATUS_NOTIFICATION, { + status: OCPP16FirmwareStatus.Downloading, + }); + chargingStation.stationInfo.firmwareStatus = OCPP16FirmwareStatus.Downloading; + if ( + chargingStation.stationInfo?.firmwareUpgrade?.failureStatus === + OCPP16FirmwareStatus.DownloadFailed + ) { + await sleep(secondsToMilliseconds(getRandomInteger(maxDelay, minDelay))); + await chargingStation.ocppRequestService.requestHandler< + OCPP16FirmwareStatusNotificationRequest, + OCPP16FirmwareStatusNotificationResponse + >(chargingStation, OCPP16RequestCommand.FIRMWARE_STATUS_NOTIFICATION, { + status: chargingStation.stationInfo?.firmwareUpgrade?.failureStatus, + }); + chargingStation.stationInfo.firmwareStatus = + chargingStation.stationInfo?.firmwareUpgrade?.failureStatus; + return; + } + await sleep(secondsToMilliseconds(getRandomInteger(maxDelay, minDelay))); + await chargingStation.ocppRequestService.requestHandler< + OCPP16FirmwareStatusNotificationRequest, + OCPP16FirmwareStatusNotificationResponse + >(chargingStation, OCPP16RequestCommand.FIRMWARE_STATUS_NOTIFICATION, { + status: OCPP16FirmwareStatus.Downloaded, + }); + chargingStation.stationInfo.firmwareStatus = OCPP16FirmwareStatus.Downloaded; + let wasTransactionsStarted = false; + let transactionsStarted: boolean; + do { + const runningTransactions = chargingStation.getNumberOfRunningTransactions(); + if (runningTransactions > 0) { + const waitTime = secondsToMilliseconds(15); + logger.debug( + `${chargingStation.logPrefix()} ${moduleName}.updateFirmwareSimulation: + ${runningTransactions} transaction(s) in progress, waiting ${formatDurationMilliSeconds( + waitTime, + )} before continuing firmware update simulation`, + ); + await sleep(waitTime); + transactionsStarted = true; + wasTransactionsStarted = true; + } else { + if (chargingStation.hasEvses) { + for (const [evseId, evseStatus] of chargingStation.evses) { + if (evseId > 0) { + for (const [connectorId, connectorStatus] of evseStatus.connectors) { + if (connectorStatus?.status !== OCPP16ChargePointStatus.Unavailable) { + await OCPP16ServiceUtils.sendAndSetConnectorStatus( + chargingStation, + connectorId, + OCPP16ChargePointStatus.Unavailable, + ); + } + } + } + } + } else { + for (const connectorId of chargingStation.connectors.keys()) { + if ( + connectorId > 0 && + chargingStation.getConnectorStatus(connectorId)?.status !== + OCPP16ChargePointStatus.Unavailable + ) { + await OCPP16ServiceUtils.sendAndSetConnectorStatus( + chargingStation, + connectorId, + OCPP16ChargePointStatus.Unavailable, + ); + } + } + } + transactionsStarted = false; + } + } while (transactionsStarted); + !wasTransactionsStarted && + (await sleep(secondsToMilliseconds(getRandomInteger(maxDelay, minDelay)))); + if (checkChargingStation(chargingStation, chargingStation.logPrefix()) === false) { + return; + } + await chargingStation.ocppRequestService.requestHandler< + OCPP16FirmwareStatusNotificationRequest, + OCPP16FirmwareStatusNotificationResponse + >(chargingStation, OCPP16RequestCommand.FIRMWARE_STATUS_NOTIFICATION, { + status: OCPP16FirmwareStatus.Installing, + }); + chargingStation.stationInfo.firmwareStatus = OCPP16FirmwareStatus.Installing; + if ( + chargingStation.stationInfo?.firmwareUpgrade?.failureStatus === + OCPP16FirmwareStatus.InstallationFailed + ) { + await sleep(secondsToMilliseconds(getRandomInteger(maxDelay, minDelay))); + await chargingStation.ocppRequestService.requestHandler< + OCPP16FirmwareStatusNotificationRequest, + OCPP16FirmwareStatusNotificationResponse + >(chargingStation, OCPP16RequestCommand.FIRMWARE_STATUS_NOTIFICATION, { + status: chargingStation.stationInfo?.firmwareUpgrade?.failureStatus, + }); + chargingStation.stationInfo.firmwareStatus = + chargingStation.stationInfo?.firmwareUpgrade?.failureStatus; + return; + } + if (chargingStation.stationInfo?.firmwareUpgrade?.reset === true) { + await sleep(secondsToMilliseconds(getRandomInteger(maxDelay, minDelay))); + await chargingStation.reset(OCPP16StopTransactionReason.REBOOT); + } } private async handleRequestGetDiagnostics( - commandPayload: GetDiagnosticsRequest + chargingStation: ChargingStation, + commandPayload: GetDiagnosticsRequest, ): Promise { - logger.debug( - this.chargingStation.logPrefix() + - ' ' + - OCPP16IncomingRequestCommand.GET_DIAGNOSTICS + - ' request received: %j', - commandPayload - ); - const uri = new URL(commandPayload.location); + if ( + OCPP16ServiceUtils.checkFeatureProfile( + chargingStation, + OCPP16SupportedFeatureProfiles.FirmwareManagement, + OCPP16IncomingRequestCommand.GET_DIAGNOSTICS, + ) === false + ) { + logger.warn( + `${chargingStation.logPrefix()} ${moduleName}.handleRequestGetDiagnostics: + Cannot get diagnostics: feature profile not supported`, + ); + return OCPP16Constants.OCPP_RESPONSE_EMPTY; + } + const { location } = commandPayload; + const uri = new URL(location); if (uri.protocol.startsWith('ftp:')) { - let ftpClient: Client; + let ftpClient: Client | undefined; try { - const logFiles = fs - .readdirSync(path.resolve(__dirname, '../../../../')) + const logFiles = readdirSync(resolve(dirname(fileURLToPath(import.meta.url)), '../')) .filter((file) => file.endsWith('.log')) - .map((file) => path.join('./', file)); - const diagnosticsArchive = - this.chargingStation.stationInfo.chargingStationId + '_logs.tar.gz'; - tar.create({ gzip: true }, logFiles).pipe(fs.createWriteStream(diagnosticsArchive)); + .map((file) => join('./', file)); + const diagnosticsArchive = `${chargingStation.stationInfo.chargingStationId}_logs.tar.gz`; + create({ gzip: true }, logFiles).pipe(createWriteStream(diagnosticsArchive)); ftpClient = new Client(); const accessResponse = await ftpClient.access({ host: uri.host, - ...(!Utils.isEmptyString(uri.port) && { port: Utils.convertToInt(uri.port) }), - ...(!Utils.isEmptyString(uri.username) && { user: uri.username }), - ...(!Utils.isEmptyString(uri.password) && { password: uri.password }), + ...(isNotEmptyString(uri.port) && { port: convertToInt(uri.port) }), + ...(isNotEmptyString(uri.username) && { user: uri.username }), + ...(isNotEmptyString(uri.password) && { password: uri.password }), }); - let uploadResponse: FTPResponse; + let uploadResponse: FTPResponse | undefined; if (accessResponse.code === 220) { - // eslint-disable-next-line @typescript-eslint/no-misused-promises - ftpClient.trackProgress(async (info) => { + ftpClient.trackProgress((info) => { logger.info( - `${this.chargingStation.logPrefix()} ${ + `${chargingStation.logPrefix()} ${moduleName}.handleRequestGetDiagnostics: ${ info.bytes / 1024 - } bytes transferred from diagnostics archive ${info.name}` - ); - await this.chargingStation.ocppRequestService.sendDiagnosticsStatusNotification( - OCPP16DiagnosticsStatus.Uploading + } bytes transferred from diagnostics archive ${info.name}`, ); + 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(path.resolve(__dirname, '../../../../'), diagnosticsArchive), - uri.pathname + diagnosticsArchive + join(resolve(dirname(fileURLToPath(import.meta.url)), '../'), diagnosticsArchive), + `${uri.pathname}${diagnosticsArchive}`, ); if (uploadResponse.code === 226) { - await this.chargingStation.ocppRequestService.sendDiagnosticsStatusNotification( - OCPP16DiagnosticsStatus.Uploaded - ); + await chargingStation.ocppRequestService.requestHandler< + OCPP16DiagnosticsStatusNotificationRequest, + OCPP16DiagnosticsStatusNotificationResponse + >(chargingStation, OCPP16RequestCommand.DIAGNOSTICS_STATUS_NOTIFICATION, { + status: OCPP16DiagnosticsStatus.Uploaded, + }); if (ftpClient) { ftpClient.close(); } @@ -765,87 +1497,309 @@ 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 + OCPP16IncomingRequestCommand.GET_DIAGNOSTICS, ); } 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 + OCPP16IncomingRequestCommand.GET_DIAGNOSTICS, ); } catch (error) { - await this.chargingStation.ocppRequestService.sendDiagnosticsStatusNotification( - OCPP16DiagnosticsStatus.UploadFailed - ); + await chargingStation.ocppRequestService.requestHandler< + OCPP16DiagnosticsStatusNotificationRequest, + OCPP16DiagnosticsStatusNotificationResponse + >(chargingStation, OCPP16RequestCommand.DIAGNOSTICS_STATUS_NOTIFICATION, { + status: OCPP16DiagnosticsStatus.UploadFailed, + }); if (ftpClient) { ftpClient.close(); } - return this.handleIncomingRequestError( + return this.handleIncomingRequestError( + chargingStation, OCPP16IncomingRequestCommand.GET_DIAGNOSTICS, error as Error, - { errorResponse: Constants.OCPP_RESPONSE_EMPTY } - ); + { errorResponse: OCPP16Constants.OCPP_RESPONSE_EMPTY }, + )!; } } else { logger.error( - `${this.chargingStation.logPrefix()} Unsupported protocol ${ + `${chargingStation.logPrefix()} Unsupported protocol ${ uri.protocol - } to transfer the diagnostic logs archive` - ); - await this.chargingStation.ocppRequestService.sendDiagnosticsStatusNotification( - OCPP16DiagnosticsStatus.UploadFailed + } to transfer the diagnostic logs archive`, ); - return Constants.OCPP_RESPONSE_EMPTY; + await chargingStation.ocppRequestService.requestHandler< + OCPP16DiagnosticsStatusNotificationRequest, + OCPP16DiagnosticsStatusNotificationResponse + >(chargingStation, OCPP16RequestCommand.DIAGNOSTICS_STATUS_NOTIFICATION, { + status: OCPP16DiagnosticsStatus.UploadFailed, + }); + return OCPP16Constants.OCPP_RESPONSE_EMPTY; } } private handleRequestTriggerMessage( - commandPayload: OCPP16TriggerMessageRequest + chargingStation: ChargingStation, + commandPayload: OCPP16TriggerMessageRequest, ): OCPP16TriggerMessageResponse { + const { requestedMessage, connectorId } = commandPayload; + if ( + !OCPP16ServiceUtils.checkFeatureProfile( + chargingStation, + OCPP16SupportedFeatureProfiles.RemoteTrigger, + OCPP16IncomingRequestCommand.TRIGGER_MESSAGE, + ) || + !OCPP16ServiceUtils.isMessageTriggerSupported(chargingStation, requestedMessage) + ) { + return OCPP16Constants.OCPP_TRIGGER_MESSAGE_RESPONSE_NOT_IMPLEMENTED; + } + if ( + !OCPP16ServiceUtils.isConnectorIdValid( + chargingStation, + OCPP16IncomingRequestCommand.TRIGGER_MESSAGE, + connectorId!, + ) + ) { + return OCPP16Constants.OCPP_TRIGGER_MESSAGE_RESPONSE_REJECTED; + } try { - switch (commandPayload.requestedMessage) { - case MessageTrigger.BootNotification: + switch (requestedMessage) { + case OCPP16MessageTrigger.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 } + chargingStation.ocppRequestService + .requestHandler( + chargingStation, + OCPP16RequestCommand.BOOT_NOTIFICATION, + chargingStation.bootNotificationRequest, + { skipBufferingOnError: true, triggerMessage: true }, ) - .catch(() => { - /* This is intentional */ - }); - }, Constants.OCPP_TRIGGER_MESSAGE_DELAY); - return Constants.OCPP_TRIGGER_MESSAGE_RESPONSE_ACCEPTED; - case MessageTrigger.Heartbeat: + .then((response) => { + chargingStation.bootNotificationResponse = response; + }) + .catch(Constants.EMPTY_FUNCTION); + }, OCPP16Constants.OCPP_TRIGGER_MESSAGE_DELAY); + return OCPP16Constants.OCPP_TRIGGER_MESSAGE_RESPONSE_ACCEPTED; + case OCPP16MessageTrigger.Heartbeat: setTimeout(() => { - this.chargingStation.ocppRequestService - .sendMessageHandler(OCPP16RequestCommand.HEARTBEAT, null, { triggerMessage: true }) - .catch(() => { - /* This is intentional */ - }); - }, Constants.OCPP_TRIGGER_MESSAGE_DELAY); - return Constants.OCPP_TRIGGER_MESSAGE_RESPONSE_ACCEPTED; + chargingStation.ocppRequestService + .requestHandler( + chargingStation, + OCPP16RequestCommand.HEARTBEAT, + null, + { + triggerMessage: true, + }, + ) + .catch(Constants.EMPTY_FUNCTION); + }, OCPP16Constants.OCPP_TRIGGER_MESSAGE_DELAY); + return OCPP16Constants.OCPP_TRIGGER_MESSAGE_RESPONSE_ACCEPTED; + case OCPP16MessageTrigger.StatusNotification: + setTimeout(() => { + if (!isNullOrUndefined(connectorId)) { + chargingStation.ocppRequestService + .requestHandler( + chargingStation, + OCPP16RequestCommand.STATUS_NOTIFICATION, + { + connectorId, + errorCode: OCPP16ChargePointErrorCode.NO_ERROR, + status: chargingStation.getConnectorStatus(connectorId!)?.status, + }, + { + triggerMessage: true, + }, + ) + .catch(Constants.EMPTY_FUNCTION); + } else { + // eslint-disable-next-line no-lonely-if + if (chargingStation.hasEvses) { + for (const evseStatus of chargingStation.evses.values()) { + for (const [id, connectorStatus] of evseStatus.connectors) { + chargingStation.ocppRequestService + .requestHandler< + OCPP16StatusNotificationRequest, + OCPP16StatusNotificationResponse + >( + chargingStation, + OCPP16RequestCommand.STATUS_NOTIFICATION, + { + connectorId: id, + errorCode: OCPP16ChargePointErrorCode.NO_ERROR, + status: connectorStatus.status, + }, + { + triggerMessage: true, + }, + ) + .catch(Constants.EMPTY_FUNCTION); + } + } + } else { + for (const id of chargingStation.connectors.keys()) { + chargingStation.ocppRequestService + .requestHandler< + OCPP16StatusNotificationRequest, + OCPP16StatusNotificationResponse + >( + chargingStation, + OCPP16RequestCommand.STATUS_NOTIFICATION, + { + connectorId: id, + errorCode: OCPP16ChargePointErrorCode.NO_ERROR, + status: chargingStation.getConnectorStatus(id)?.status, + }, + { + triggerMessage: true, + }, + ) + .catch(Constants.EMPTY_FUNCTION); + } + } + } + }, OCPP16Constants.OCPP_TRIGGER_MESSAGE_DELAY); + return OCPP16Constants.OCPP_TRIGGER_MESSAGE_RESPONSE_ACCEPTED; default: - return Constants.OCPP_TRIGGER_MESSAGE_RESPONSE_NOT_IMPLEMENTED; + return OCPP16Constants.OCPP_TRIGGER_MESSAGE_RESPONSE_NOT_IMPLEMENTED; } } catch (error) { - return this.handleIncomingRequestError( + return this.handleIncomingRequestError( + chargingStation, OCPP16IncomingRequestCommand.TRIGGER_MESSAGE, error as Error, - { errorResponse: Constants.OCPP_TRIGGER_MESSAGE_RESPONSE_REJECTED } + { errorResponse: OCPP16Constants.OCPP_TRIGGER_MESSAGE_RESPONSE_REJECTED }, + )!; + } + } + + private handleRequestDataTransfer( + chargingStation: ChargingStation, + commandPayload: OCPP16DataTransferRequest, + ): OCPP16DataTransferResponse { + const { vendorId } = commandPayload; + try { + if (Object.values(OCPP16DataTransferVendorId).includes(vendorId)) { + return OCPP16Constants.OCPP_DATA_TRANSFER_RESPONSE_ACCEPTED; + } + return OCPP16Constants.OCPP_DATA_TRANSFER_RESPONSE_UNKNOWN_VENDOR_ID; + } catch (error) { + return this.handleIncomingRequestError( + chargingStation, + OCPP16IncomingRequestCommand.DATA_TRANSFER, + error as Error, + { errorResponse: OCPP16Constants.OCPP_DATA_TRANSFER_RESPONSE_REJECTED }, + )!; + } + } + + private async handleRequestReserveNow( + chargingStation: ChargingStation, + commandPayload: OCPP16ReserveNowRequest, + ): Promise { + if ( + !OCPP16ServiceUtils.checkFeatureProfile( + chargingStation, + OCPP16SupportedFeatureProfiles.Reservation, + OCPP16IncomingRequestCommand.RESERVE_NOW, + ) + ) { + return OCPP16Constants.OCPP_RESERVATION_RESPONSE_REJECTED; + } + const { reservationId, idTag, connectorId } = commandPayload; + let response: OCPP16ReserveNowResponse; + try { + if (connectorId > 0 && !chargingStation.isConnectorAvailable(connectorId)) { + return OCPP16Constants.OCPP_RESERVATION_RESPONSE_REJECTED; + } + if (connectorId === 0 && !chargingStation.getReserveConnectorZeroSupported()) { + return OCPP16Constants.OCPP_RESERVATION_RESPONSE_REJECTED; + } + if (!(await OCPP16ServiceUtils.isIdTagAuthorized(chargingStation, connectorId, idTag))) { + return OCPP16Constants.OCPP_RESERVATION_RESPONSE_REJECTED; + } + await removeExpiredReservations(chargingStation); + switch (chargingStation.getConnectorStatus(connectorId)!.status) { + case OCPP16ChargePointStatus.Faulted: + response = OCPP16Constants.OCPP_RESERVATION_RESPONSE_FAULTED; + break; + case OCPP16ChargePointStatus.Preparing: + case OCPP16ChargePointStatus.Charging: + case OCPP16ChargePointStatus.SuspendedEV: + case OCPP16ChargePointStatus.SuspendedEVSE: + case OCPP16ChargePointStatus.Finishing: + response = OCPP16Constants.OCPP_RESERVATION_RESPONSE_OCCUPIED; + break; + case OCPP16ChargePointStatus.Unavailable: + response = OCPP16Constants.OCPP_RESERVATION_RESPONSE_UNAVAILABLE; + break; + case OCPP16ChargePointStatus.Reserved: + if (!chargingStation.isConnectorReservable(reservationId, idTag, connectorId)) { + response = OCPP16Constants.OCPP_RESERVATION_RESPONSE_OCCUPIED; + break; + } + // eslint-disable-next-line no-fallthrough + default: + if (!chargingStation.isConnectorReservable(reservationId, idTag)) { + response = OCPP16Constants.OCPP_RESERVATION_RESPONSE_OCCUPIED; + break; + } + await chargingStation.addReservation({ + id: commandPayload.reservationId, + ...commandPayload, + }); + response = OCPP16Constants.OCPP_RESERVATION_RESPONSE_ACCEPTED; + break; + } + return response; + } catch (error) { + chargingStation.getConnectorStatus(connectorId)!.status = OCPP16ChargePointStatus.Available; + return this.handleIncomingRequestError( + chargingStation, + OCPP16IncomingRequestCommand.RESERVE_NOW, + error as Error, + { errorResponse: OCPP16Constants.OCPP_RESERVATION_RESPONSE_FAULTED }, + )!; + } + } + + private async handleRequestCancelReservation( + chargingStation: ChargingStation, + commandPayload: OCPP16CancelReservationRequest, + ): Promise { + if ( + !OCPP16ServiceUtils.checkFeatureProfile( + chargingStation, + OCPP16SupportedFeatureProfiles.Reservation, + OCPP16IncomingRequestCommand.CANCEL_RESERVATION, + ) + ) { + return OCPP16Constants.OCPP_CANCEL_RESERVATION_RESPONSE_REJECTED; + } + try { + const { reservationId } = commandPayload; + const reservation = chargingStation.getReservationBy('reservationId', reservationId); + if (isUndefined(reservation)) { + logger.debug( + `${chargingStation.logPrefix()} Reservation with id ${reservationId} + does not exist on charging station`, + ); + return OCPP16Constants.OCPP_CANCEL_RESERVATION_RESPONSE_REJECTED; + } + await chargingStation.removeReservation( + reservation!, + ReservationTerminationReason.RESERVATION_CANCELED, ); + return OCPP16Constants.OCPP_CANCEL_RESERVATION_RESPONSE_ACCEPTED; + } catch (error) { + return this.handleIncomingRequestError( + chargingStation, + OCPP16IncomingRequestCommand.CANCEL_RESERVATION, + error as Error, + { errorResponse: OCPP16Constants.OCPP_CANCEL_RESERVATION_RESPONSE_REJECTED }, + )!; } } }