X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fcharging-station%2Focpp%2F1.6%2FOCPP16IncomingRequestService.ts;h=8b23eddd1e0820c118a8b8242aaa31f413fe7353;hb=b768993dd4636df8276b0ea47158dd9bdc9a997b;hp=4ef74b04c85ec43addbd86484f5bae922653c4c5;hpb=94ec7e9600ffc86ea375d2bfd3f4973074e1db69;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 4ef74b04..8b23eddd 100644 --- a/src/charging-station/ocpp/1.6/OCPP16IncomingRequestService.ts +++ b/src/charging-station/ocpp/1.6/OCPP16IncomingRequestService.ts @@ -1,94 +1,96 @@ -// Partial Copyright Jerome Benoit. 2021. All Rights Reserved. +// Partial Copyright Jerome Benoit. 2021-2023. All Rights Reserved. +import fs from 'node:fs'; +import path from 'node:path'; +import { URL, fileURLToPath } from 'node:url'; + +import type { JSONSchemaType } from 'ajv'; +import { Client, type FTPResponse } from 'basic-ftp'; +import tar from 'tar'; + +import { + type ChargingStation, + ChargingStationConfigurationUtils, + ChargingStationUtils, +} from '../../../charging-station'; +import { OCPPError } from '../../../exception'; import { - ChangeAvailabilityRequest, - ChangeConfigurationRequest, - ClearChargingProfileRequest, - DiagnosticsStatusNotificationRequest, - GetConfigurationRequest, - GetDiagnosticsRequest, - MessageTrigger, + type ChangeAvailabilityRequest, + type ChangeAvailabilityResponse, + type ChangeConfigurationRequest, + type ChangeConfigurationResponse, + type ClearChargingProfileRequest, + type ClearChargingProfileResponse, + ErrorType, + type GenericResponse, + type GetConfigurationRequest, + type GetConfigurationResponse, + type GetDiagnosticsRequest, + type GetDiagnosticsResponse, + type IncomingRequestHandler, + type JsonObject, + type JsonType, + OCPP16AuthorizationStatus, + type OCPP16AuthorizeRequest, + type OCPP16AuthorizeResponse, OCPP16AvailabilityType, - OCPP16BootNotificationRequest, - OCPP16HeartbeatRequest, + type OCPP16BootNotificationRequest, + type OCPP16BootNotificationResponse, + OCPP16ChargePointErrorCode, + OCPP16ChargePointStatus, + type OCPP16ChargingProfile, + OCPP16ChargingProfilePurposeType, + type OCPP16ClearCacheRequest, + type OCPP16DataTransferRequest, + type OCPP16DataTransferResponse, + OCPP16DataTransferStatus, + OCPP16DataTransferVendorId, + OCPP16DiagnosticsStatus, + type OCPP16DiagnosticsStatusNotificationRequest, + type OCPP16DiagnosticsStatusNotificationResponse, + OCPP16FirmwareStatus, + type OCPP16FirmwareStatusNotificationRequest, + type OCPP16FirmwareStatusNotificationResponse, + type OCPP16HeartbeatRequest, + type OCPP16HeartbeatResponse, OCPP16IncomingRequestCommand, + OCPP16MessageTrigger, OCPP16RequestCommand, - OCPP16StatusNotificationRequest, - OCPP16TriggerMessageRequest, - RemoteStartTransactionRequest, - RemoteStopTransactionRequest, - ResetRequest, - SetChargingProfileRequest, - UnlockConnectorRequest, -} from '../../../types/ocpp/1.6/Requests'; -import { - ChangeAvailabilityResponse, - ChangeConfigurationResponse, - ClearChargingProfileResponse, - DiagnosticsStatusNotificationResponse, - GetConfigurationResponse, - GetDiagnosticsResponse, - OCPP16BootNotificationResponse, - OCPP16HeartbeatResponse, - OCPP16StatusNotificationResponse, - OCPP16TriggerMessageResponse, - SetChargingProfileResponse, - UnlockConnectorResponse, -} from '../../../types/ocpp/1.6/Responses'; -import { - ChargingProfilePurposeType, - OCPP16ChargingProfile, -} from '../../../types/ocpp/1.6/ChargingProfile'; -import { Client, FTPResponse } from 'basic-ftp'; -import { - OCPP16AuthorizationStatus, - OCPP16AuthorizeRequest, - OCPP16AuthorizeResponse, - OCPP16StartTransactionRequest, - OCPP16StartTransactionResponse, - OCPP16StopTransactionReason, - OCPP16StopTransactionRequest, - OCPP16StopTransactionResponse, -} from '../../../types/ocpp/1.6/Transaction'; -import { - OCPP16MeterValuesRequest, - OCPP16MeterValuesResponse, -} from '../../../types/ocpp/1.6/MeterValues'; -import { OCPP16StandardParametersKey, + type OCPP16StartTransactionRequest, + type OCPP16StartTransactionResponse, + type OCPP16StatusNotificationRequest, + type OCPP16StatusNotificationResponse, + OCPP16StopTransactionReason, OCPP16SupportedFeatureProfiles, -} from '../../../types/ocpp/1.6/Configuration'; - -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 { OCPP16ChargePointErrorCode } from '../../../types/ocpp/1.6/ChargePointErrorCode'; -import { OCPP16ChargePointStatus } from '../../../types/ocpp/1.6/ChargePointStatus'; -import { OCPP16DiagnosticsStatus } from '../../../types/ocpp/1.6/DiagnosticsStatus'; -import { OCPP16ServiceUtils } from './OCPP16ServiceUtils'; -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'; + type OCPP16TriggerMessageRequest, + type OCPP16TriggerMessageResponse, + type OCPP16UpdateFirmwareRequest, + type OCPP16UpdateFirmwareResponse, + type OCPPConfigurationKey, + OCPPVersion, + type RemoteStartTransactionRequest, + type RemoteStopTransactionRequest, + type ResetRequest, + type SetChargingProfileRequest, + type SetChargingProfileResponse, + type UnlockConnectorRequest, + type UnlockConnectorResponse, +} from '../../../types'; +import { Constants, Utils, logger } from '../../../utils'; +import { OCPP16ServiceUtils, OCPPConstants, OCPPIncomingRequestService } from '../internal'; 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)], @@ -123,162 +125,301 @@ export default class OCPP16IncomingRequestService extends OCPPIncomingRequestSer ], [OCPP16IncomingRequestCommand.GET_DIAGNOSTICS, this.handleRequestGetDiagnostics.bind(this)], [OCPP16IncomingRequestCommand.TRIGGER_MESSAGE, this.handleRequestTriggerMessage.bind(this)], + [OCPP16IncomingRequestCommand.DATA_TRANSFER, this.handleRequestDataTransfer.bind(this)], + [OCPP16IncomingRequestCommand.UPDATE_FIRMWARE, this.handleRequestUpdateFirmware.bind(this)], + ]); + 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, + OCPP16ServiceUtils.parseJsonSchemaFile( + '../../../assets/json-schemas/ocpp/1.6/GetConfiguration.json', + moduleName, + 'constructor' + ), + ], + [ + OCPP16IncomingRequestCommand.CHANGE_CONFIGURATION, + 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.SET_CHARGING_PROFILE, + OCPP16ServiceUtils.parseJsonSchemaFile( + '../../../assets/json-schemas/ocpp/1.6/SetChargingProfile.json', + moduleName, + 'constructor' + ), + ], + [ + OCPP16IncomingRequestCommand.CLEAR_CHARGING_PROFILE, + OCPP16ServiceUtils.parseJsonSchemaFile( + '../../../assets/json-schemas/ocpp/1.6/ClearChargingProfile.json', + moduleName, + 'constructor' + ), + ], + [ + OCPP16IncomingRequestCommand.CHANGE_AVAILABILITY, + OCPP16ServiceUtils.parseJsonSchemaFile( + '../../../assets/json-schemas/ocpp/1.6/ChangeAvailability.json', + moduleName, + 'constructor' + ), + ], + [ + OCPP16IncomingRequestCommand.REMOTE_START_TRANSACTION, + OCPP16ServiceUtils.parseJsonSchemaFile( + '../../../assets/json-schemas/ocpp/1.6/RemoteStartTransaction.json', + moduleName, + 'constructor' + ), + ], + [ + OCPP16IncomingRequestCommand.REMOTE_STOP_TRANSACTION, + 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' + ), + ], ]); + this.validatePayload.bind(this); } public async incomingRequestHandler( + chargingStation: ChargingStation, messageId: string, commandName: OCPP16IncomingRequestCommand, commandPayload: JsonType ): Promise { - let result: JsonType; + let response: JsonType; if ( - this.chargingStation.getOcppStrictCompliance() && - this.chargingStation.isInPendingState() && + chargingStation.getOcppStrictCompliance() === true && + chargingStation.isInPendingState() === 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 )} 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.isInUnknownState() === 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 + ); } 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 )}`, - 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 )} 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.reset( - (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 ); - }); + } + logger.warn( + `${chargingStation.logPrefix()} ${moduleName}.validatePayload: No JSON schema found for command '${commandName}' PDU validation` + ); + return false; + } + + // Simulate charging station restart + private handleRequestReset( + chargingStation: ChargingStation, + commandPayload: ResetRequest + ): GenericResponse { + this.runInAsyncScope( + chargingStation.reset.bind(chargingStation) as ( + this: ChargingStation, + ...args: any[] + ) => Promise, + chargingStation, + `${commandPayload.type}Reset` as OCPP16StopTransactionReason + ).catch(Constants.EMPTY_FUNCTION); logger.info( - `${this.chargingStation.logPrefix()} ${ + `${chargingStation.logPrefix()} ${ commandPayload.type } reset command received, simulating it. The station will be back online in ${Utils.formatDurationMilliSeconds( - this.chargingStation.stationInfo.resetTime + chargingStation.stationInfo.resetTime )}` ); - return Constants.OCPP_RESPONSE_ACCEPTED; - } - - private handleRequestClearCache(): DefaultResponse { - return Constants.OCPP_RESPONSE_ACCEPTED; + return OCPPConstants.OCPP_RESPONSE_ACCEPTED; } private async handleRequestUnlockConnector( + chargingStation: ChargingStation, commandPayload: UnlockConnectorRequest ): Promise { const connectorId = commandPayload.connectorId; + if (chargingStation.connectors.has(connectorId) === false) { + logger.error( + `${chargingStation.logPrefix()} Trying to unlock a non existing connector Id ${connectorId.toString()}` + ); + return OCPPConstants.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; + return OCPPConstants.OCPP_RESPONSE_UNLOCK_NOT_SUPPORTED; } - if (this.chargingStation.getConnectorStatus(connectorId)?.transactionStarted) { - const transactionId = this.chargingStation.getConnectorStatus(connectorId).transactionId; - if ( - this.chargingStation.getBeginEndMeterValues() && - this.chargingStation.getOcppStrictCompliance() && - !this.chargingStation.getOutOfOrderEndMeterValues() - ) { - // FIXME: Implement OCPP version agnostic helpers - const transactionEndMeterValue = OCPP16ServiceUtils.buildTransactionEndMeterValue( - this.chargingStation, - connectorId, - this.chargingStation.getEnergyActiveImportRegisterByTransactionId(transactionId) - ); - await this.chargingStation.ocppRequestService.requestHandler< - OCPP16MeterValuesRequest, - OCPP16MeterValuesResponse - >(OCPP16RequestCommand.METER_VALUES, { - connectorId, - transactionId, - meterValue: transactionEndMeterValue, - }); - } - const stopResponse = await this.chargingStation.ocppRequestService.requestHandler< - OCPP16StopTransactionRequest, - OCPP16StopTransactionResponse - >(OCPP16RequestCommand.STOP_TRANSACTION, { - transactionId, - meterStop: this.chargingStation.getEnergyActiveImportRegisterByTransactionId(transactionId), - idTag: this.chargingStation.getTransactionIdTag(transactionId), - reason: OCPP16StopTransactionReason.UNLOCK_COMMAND, - }); + 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 OCPPConstants.OCPP_RESPONSE_UNLOCKED; } - return Constants.OCPP_RESPONSE_UNLOCK_FAILED; + return OCPPConstants.OCPP_RESPONSE_UNLOCK_FAILED; } - await this.chargingStation.ocppRequestService.requestHandler< + await chargingStation.ocppRequestService.requestHandler< OCPP16StatusNotificationRequest, OCPP16StatusNotificationResponse - >(OCPP16RequestCommand.STATUS_NOTIFICATION, { + >(chargingStation, OCPP16RequestCommand.STATUS_NOTIFICATION, { connectorId, - status: OCPP16ChargePointStatus.AVAILABLE, + status: OCPP16ChargePointStatus.Available, errorCode: OCPP16ChargePointErrorCode.NO_ERROR, }); - this.chargingStation.getConnectorStatus(connectorId).status = OCPP16ChargePointStatus.AVAILABLE; - return Constants.OCPP_RESPONSE_UNLOCKED; + chargingStation.getConnectorStatus(connectorId).status = OCPP16ChargePointStatus.Available; + return OCPPConstants.OCPP_RESPONSE_UNLOCKED; } private handleRequestGetConfiguration( + chargingStation: ChargingStation, commandPayload: GetConfigurationRequest ): GetConfigurationResponse { const configurationKey: OCPPConfigurationKey[] = []; const unknownKey: string[] = []; - if (Utils.isEmptyArray(commandPayload.key)) { - for (const configuration of this.chargingStation.ocppConfiguration.configurationKey) { - if (Utils.isUndefined(configuration.visible)) { + if (Utils.isUndefined(commandPayload.key) === true) { + for (const configuration of chargingStation.ocppConfiguration.configurationKey) { + if (Utils.isUndefined(configuration.visible) === true) { configuration.visible = true; } - if (!configuration.visible) { + if (configuration.visible === false) { continue; } configurationKey.push({ @@ -287,14 +428,18 @@ export default class OCPP16IncomingRequestService extends OCPPIncomingRequestSer value: configuration.value, }); } - } else { + } else if (Utils.isNotEmptyArray(commandPayload.key) === true) { for (const key of commandPayload.key) { - const keyFound = this.chargingStation.getConfigurationKey(key); + const keyFound = ChargingStationConfigurationUtils.getConfigurationKey( + chargingStation, + key, + true + ); if (keyFound) { - if (Utils.isUndefined(keyFound.visible)) { + if (Utils.isUndefined(keyFound.visible) === true) { keyFound.visible = true; } - if (!keyFound.visible) { + if (keyFound.visible === false) { continue; } configurationKey.push({ @@ -314,34 +459,23 @@ export default class OCPP16IncomingRequestService extends OCPPIncomingRequestSer } private handleRequestChangeConfiguration( + 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); + const keyToChange = ChargingStationConfigurationUtils.getConfigurationKey( + chargingStation, + commandPayload.key, + true + ); if (!keyToChange) { - return Constants.OCPP_CONFIGURATION_RESPONSE_NOT_SUPPORTED; + return OCPPConstants.OCPP_CONFIGURATION_RESPONSE_NOT_SUPPORTED; } else if (keyToChange && keyToChange.readonly) { - return Constants.OCPP_CONFIGURATION_RESPONSE_REJECTED; + return OCPPConstants.OCPP_CONFIGURATION_RESPONSE_REJECTED; } else if (keyToChange && !keyToChange.readonly) { let valueChanged = false; if (keyToChange.value !== commandPayload.value) { - this.chargingStation.setConfigurationKeyValue( + ChargingStationConfigurationUtils.setConfigurationKeyValue( + chargingStation, commandPayload.key, commandPayload.value, true @@ -350,120 +484,133 @@ export default class OCPP16IncomingRequestService extends OCPPIncomingRequestSer } let triggerHeartbeatRestart = false; if (keyToChange.key === OCPP16StandardParametersKey.HeartBeatInterval && valueChanged) { - this.chargingStation.setConfigurationKeyValue( + ChargingStationConfigurationUtils.setConfigurationKeyValue( + chargingStation, OCPP16StandardParametersKey.HeartbeatInterval, commandPayload.value ); triggerHeartbeatRestart = true; } if (keyToChange.key === OCPP16StandardParametersKey.HeartbeatInterval && valueChanged) { - this.chargingStation.setConfigurationKeyValue( + ChargingStationConfigurationUtils.setConfigurationKeyValue( + chargingStation, OCPP16StandardParametersKey.HeartBeatInterval, commandPayload.value ); triggerHeartbeatRestart = true; } if (triggerHeartbeatRestart) { - this.chargingStation.restartHeartbeat(); + chargingStation.restartHeartbeat(); } if (keyToChange.key === OCPP16StandardParametersKey.WebSocketPingInterval && valueChanged) { - this.chargingStation.restartWebSocketPing(); + chargingStation.restartWebSocketPing(); } if (keyToChange.reboot) { - return Constants.OCPP_CONFIGURATION_RESPONSE_REBOOT_REQUIRED; + return OCPPConstants.OCPP_CONFIGURATION_RESPONSE_REBOOT_REQUIRED; } - return Constants.OCPP_CONFIGURATION_RESPONSE_ACCEPTED; + return OCPPConstants.OCPP_CONFIGURATION_RESPONSE_ACCEPTED; } } private handleRequestSetChargingProfile( + chargingStation: ChargingStation, commandPayload: SetChargingProfileRequest ): SetChargingProfileResponse { if ( - !OCPP16ServiceUtils.checkFeatureProfile( - this.chargingStation, + OCPP16ServiceUtils.checkFeatureProfile( + chargingStation, OCPP16SupportedFeatureProfiles.SmartCharging, OCPP16IncomingRequestCommand.SET_CHARGING_PROFILE - ) + ) === false ) { - return Constants.OCPP_SET_CHARGING_PROFILE_RESPONSE_NOT_SUPPORTED; + return OCPPConstants.OCPP_SET_CHARGING_PROFILE_RESPONSE_NOT_SUPPORTED; } - if (!this.chargingStation.getConnectorStatus(commandPayload.connectorId)) { + if (chargingStation.connectors.has(commandPayload.connectorId) === false) { logger.error( - `${this.chargingStation.logPrefix()} Trying to set charging profile(s) to a non existing connector Id ${ + `${chargingStation.logPrefix()} Trying to set charging profile(s) to a non existing connector Id ${ commandPayload.connectorId }` ); - return Constants.OCPP_SET_CHARGING_PROFILE_RESPONSE_REJECTED; + return OCPPConstants.OCPP_SET_CHARGING_PROFILE_RESPONSE_REJECTED; } if ( commandPayload.csChargingProfiles.chargingProfilePurpose === - ChargingProfilePurposeType.CHARGE_POINT_MAX_PROFILE && + OCPP16ChargingProfilePurposeType.CHARGE_POINT_MAX_PROFILE && commandPayload.connectorId !== 0 ) { - return Constants.OCPP_SET_CHARGING_PROFILE_RESPONSE_REJECTED; + return OCPPConstants.OCPP_SET_CHARGING_PROFILE_RESPONSE_REJECTED; } if ( commandPayload.csChargingProfiles.chargingProfilePurpose === - ChargingProfilePurposeType.TX_PROFILE && + OCPP16ChargingProfilePurposeType.TX_PROFILE && (commandPayload.connectorId === 0 || - !this.chargingStation.getConnectorStatus(commandPayload.connectorId)?.transactionStarted) + chargingStation.getConnectorStatus(commandPayload.connectorId)?.transactionStarted === + false) ) { - return Constants.OCPP_SET_CHARGING_PROFILE_RESPONSE_REJECTED; + logger.error( + `${chargingStation.logPrefix()} Trying to set transaction charging profile(s) on connector ${ + commandPayload.connectorId + } without a started transaction` + ); + return OCPPConstants.OCPP_SET_CHARGING_PROFILE_RESPONSE_REJECTED; } - this.chargingStation.setChargingProfile( + OCPP16ServiceUtils.setChargingProfile( + chargingStation, commandPayload.connectorId, commandPayload.csChargingProfiles ); logger.debug( - `${this.chargingStation.logPrefix()} Charging profile(s) set on connector id ${ + `${chargingStation.logPrefix()} Charging profile(s) set on connector id ${ commandPayload.connectorId - }, dump their stack: %j`, - this.chargingStation.getConnectorStatus(commandPayload.connectorId).chargingProfiles + }: %j`, + commandPayload.csChargingProfiles ); - return Constants.OCPP_SET_CHARGING_PROFILE_RESPONSE_ACCEPTED; + return OCPPConstants.OCPP_SET_CHARGING_PROFILE_RESPONSE_ACCEPTED; } private handleRequestClearChargingProfile( + chargingStation: ChargingStation, commandPayload: ClearChargingProfileRequest ): ClearChargingProfileResponse { if ( - !OCPP16ServiceUtils.checkFeatureProfile( - this.chargingStation, + OCPP16ServiceUtils.checkFeatureProfile( + chargingStation, OCPP16SupportedFeatureProfiles.SmartCharging, OCPP16IncomingRequestCommand.CLEAR_CHARGING_PROFILE - ) + ) === false ) { - return Constants.OCPP_CLEAR_CHARGING_PROFILE_RESPONSE_UNKNOWN; + return OCPPConstants.OCPP_CLEAR_CHARGING_PROFILE_RESPONSE_UNKNOWN; } - const connectorStatus = this.chargingStation.getConnectorStatus(commandPayload.connectorId); - if (!connectorStatus) { + if (chargingStation.connectors.has(commandPayload.connectorId) === false) { logger.error( - `${this.chargingStation.logPrefix()} Trying to clear a charging profile(s) to a non existing connector Id ${ + `${chargingStation.logPrefix()} Trying to clear a charging profile(s) to a non existing connector Id ${ commandPayload.connectorId }` ); - return Constants.OCPP_CLEAR_CHARGING_PROFILE_RESPONSE_UNKNOWN; + return OCPPConstants.OCPP_CLEAR_CHARGING_PROFILE_RESPONSE_UNKNOWN; } - if (commandPayload.connectorId && !Utils.isEmptyArray(connectorStatus.chargingProfiles)) { + const connectorStatus = chargingStation.getConnectorStatus(commandPayload.connectorId); + if ( + !Utils.isNullOrUndefined(commandPayload.connectorId) && + Utils.isNotEmptyArray(connectorStatus?.chargingProfiles) + ) { connectorStatus.chargingProfiles = []; logger.debug( - `${this.chargingStation.logPrefix()} Charging profile(s) cleared on connector id ${ + `${chargingStation.logPrefix()} Charging profile(s) cleared on connector id ${ commandPayload.connectorId - }, dump their stack: %j`, - connectorStatus.chargingProfiles + }` ); - return Constants.OCPP_CLEAR_CHARGING_PROFILE_RESPONSE_ACCEPTED; + return OCPPConstants.OCPP_CLEAR_CHARGING_PROFILE_RESPONSE_ACCEPTED; } - if (!commandPayload.connectorId) { + if (Utils.isNullOrUndefined(commandPayload.connectorId)) { let clearedCP = false; - for (const connectorId of this.chargingStation.connectors.keys()) { + for (const connectorId of chargingStation.connectors.keys()) { if ( - !Utils.isEmptyArray(this.chargingStation.getConnectorStatus(connectorId).chargingProfiles) + Utils.isNotEmptyArray(chargingStation.getConnectorStatus(connectorId)?.chargingProfiles) ) { - this.chargingStation + chargingStation .getConnectorStatus(connectorId) - .chargingProfiles?.forEach((chargingProfile: OCPP16ChargingProfile, index: number) => { + ?.chargingProfiles?.forEach((chargingProfile: OCPP16ChargingProfile, index: number) => { let clearCurrentCP = false; if (chargingProfile.chargingProfileId === commandPayload.id) { clearCurrentCP = true; @@ -487,12 +634,10 @@ export default class OCPP16IncomingRequestService extends OCPPIncomingRequestSer clearCurrentCP = true; } if (clearCurrentCP) { - connectorStatus.chargingProfiles[index] = {} as OCPP16ChargingProfile; + connectorStatus?.chargingProfiles?.splice(index, 1); logger.debug( - `${this.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; } @@ -500,107 +645,116 @@ export default class OCPP16IncomingRequestService extends OCPPIncomingRequestSer } } if (clearedCP) { - return Constants.OCPP_CLEAR_CHARGING_PROFILE_RESPONSE_ACCEPTED; + return OCPPConstants.OCPP_CLEAR_CHARGING_PROFILE_RESPONSE_ACCEPTED; } } - return Constants.OCPP_CLEAR_CHARGING_PROFILE_RESPONSE_UNKNOWN; + return OCPPConstants.OCPP_CLEAR_CHARGING_PROFILE_RESPONSE_UNKNOWN; } private async handleRequestChangeAvailability( + chargingStation: ChargingStation, commandPayload: ChangeAvailabilityRequest ): Promise { const connectorId: number = commandPayload.connectorId; - if (!this.chargingStation.getConnectorStatus(connectorId)) { + if (chargingStation.connectors.has(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 OCPPConstants.OCPP_AVAILABILITY_RESPONSE_REJECTED; } const chargePointStatus: OCPP16ChargePointStatus = commandPayload.type === OCPP16AvailabilityType.OPERATIVE - ? OCPP16ChargePointStatus.AVAILABLE - : OCPP16ChargePointStatus.UNAVAILABLE; + ? 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; + let response: ChangeAvailabilityResponse = OCPPConstants.OCPP_AVAILABILITY_RESPONSE_ACCEPTED; + for (const id of chargingStation.connectors.keys()) { + if (chargingStation.getConnectorStatus(id)?.transactionStarted === true) { + response = OCPPConstants.OCPP_AVAILABILITY_RESPONSE_SCHEDULED; } - this.chargingStation.getConnectorStatus(id).availability = commandPayload.type; - if (response === Constants.OCPP_AVAILABILITY_RESPONSE_ACCEPTED) { - await this.chargingStation.ocppRequestService.requestHandler< + chargingStation.getConnectorStatus(id).availability = commandPayload.type; + if (response === OCPPConstants.OCPP_AVAILABILITY_RESPONSE_ACCEPTED) { + await chargingStation.ocppRequestService.requestHandler< OCPP16StatusNotificationRequest, OCPP16StatusNotificationResponse - >(OCPP16RequestCommand.STATUS_NOTIFICATION, { + >(chargingStation, OCPP16RequestCommand.STATUS_NOTIFICATION, { connectorId: id, status: chargePointStatus, errorCode: OCPP16ChargePointErrorCode.NO_ERROR, }); - this.chargingStation.getConnectorStatus(id).status = chargePointStatus; + chargingStation.getConnectorStatus(id).status = chargePointStatus; } } return response; } else if ( connectorId > 0 && - (this.chargingStation.getConnectorStatus(0).availability === - OCPP16AvailabilityType.OPERATIVE || - (this.chargingStation.getConnectorStatus(0).availability === - OCPP16AvailabilityType.INOPERATIVE && + (chargingStation.isChargingStationAvailable() === true || + (chargingStation.isChargingStationAvailable() === false && commandPayload.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 = commandPayload.type; + return OCPPConstants.OCPP_AVAILABILITY_RESPONSE_SCHEDULED; } - this.chargingStation.getConnectorStatus(connectorId).availability = commandPayload.type; - await this.chargingStation.ocppRequestService.requestHandler< + chargingStation.getConnectorStatus(connectorId).availability = commandPayload.type; + await chargingStation.ocppRequestService.requestHandler< OCPP16StatusNotificationRequest, OCPP16StatusNotificationResponse - >(OCPP16RequestCommand.STATUS_NOTIFICATION, { + >(chargingStation, OCPP16RequestCommand.STATUS_NOTIFICATION, { connectorId, status: chargePointStatus, errorCode: OCPP16ChargePointErrorCode.NO_ERROR, }); - this.chargingStation.getConnectorStatus(connectorId).status = chargePointStatus; - return Constants.OCPP_AVAILABILITY_RESPONSE_ACCEPTED; + chargingStation.getConnectorStatus(connectorId).status = chargePointStatus; + return OCPPConstants.OCPP_AVAILABILITY_RESPONSE_ACCEPTED; } - return Constants.OCPP_AVAILABILITY_RESPONSE_REJECTED; + return OCPPConstants.OCPP_AVAILABILITY_RESPONSE_REJECTED; } private async handleRequestRemoteStartTransaction( + chargingStation: ChargingStation, commandPayload: RemoteStartTransactionRequest - ): Promise { + ): Promise { const transactionConnectorId = commandPayload.connectorId; - const connectorStatus = this.chargingStation.getConnectorStatus(transactionConnectorId); - if (transactionConnectorId) { - await this.chargingStation.ocppRequestService.requestHandler< + if (chargingStation.connectors.has(transactionConnectorId) === true) { + const remoteStartTransactionLogMsg = `${chargingStation.logPrefix()} Transaction remotely STARTED on ${ + chargingStation.stationInfo.chargingStationId + }#${transactionConnectorId.toString()} for idTag '${commandPayload.idTag}'`; + await chargingStation.ocppRequestService.requestHandler< OCPP16StatusNotificationRequest, OCPP16StatusNotificationResponse - >(OCPP16RequestCommand.STATUS_NOTIFICATION, { + >(chargingStation, OCPP16RequestCommand.STATUS_NOTIFICATION, { connectorId: transactionConnectorId, - status: OCPP16ChargePointStatus.PREPARING, + status: OCPP16ChargePointStatus.Preparing, errorCode: OCPP16ChargePointErrorCode.NO_ERROR, }); - connectorStatus.status = OCPP16ChargePointStatus.PREPARING; - if (this.chargingStation.isChargingStationAvailable() && connectorStatus) { + const connectorStatus = chargingStation.getConnectorStatus(transactionConnectorId); + connectorStatus.status = OCPP16ChargePointStatus.Preparing; + if (chargingStation.isChargingStationAvailable() === true) { // Check if authorized - if (this.chargingStation.getAuthorizeRemoteTxRequests()) { + if (chargingStation.getAuthorizeRemoteTxRequests() === true) { let authorized = false; if ( - this.chargingStation.getLocalAuthListEnabled() && - this.chargingStation.hasAuthorizedTags() && - this.chargingStation.authorizedTags.find((value) => value === commandPayload.idTag) + chargingStation.getLocalAuthListEnabled() === true && + chargingStation.hasAuthorizedTags() === true && + Utils.isNotEmptyString( + chargingStation.authorizedTagsCache + .getAuthorizedTags( + ChargingStationUtils.getAuthorizationFile(chargingStation.stationInfo) + ) + ?.find((idTag) => idTag === commandPayload.idTag) + ) ) { connectorStatus.localAuthorizeIdTag = commandPayload.idTag; connectorStatus.idTagLocalAuthorized = true; authorized = true; - } else if (this.chargingStation.getMayAuthorizeAtRemoteStart()) { + } else if (chargingStation.getMustAuthorizeAtRemoteStart() === true) { connectorStatus.authorizeIdTag = commandPayload.idTag; const authorizeResponse: OCPP16AuthorizeResponse = - await this.chargingStation.ocppRequestService.requestHandler< + await chargingStation.ocppRequestService.requestHandler< OCPP16AuthorizeRequest, OCPP16AuthorizeResponse - >(OCPP16RequestCommand.AUTHORIZE, { + >(chargingStation, OCPP16RequestCommand.AUTHORIZE, { idTag: commandPayload.idTag, }); if (authorizeResponse?.idTagInfo?.status === OCPP16AuthorizationStatus.ACCEPTED) { @@ -608,51 +762,47 @@ export default class OCPP16IncomingRequestService extends OCPPIncomingRequestSer } } else { logger.warn( - `${this.chargingStation.logPrefix()} The charging station configuration expects authorize at remote start transaction but local authorization or authorize isn't enabled` + `${chargingStation.logPrefix()} The charging station configuration expects authorize at remote start transaction but local authorization or authorize isn't enabled` ); } - if (authorized) { + if (authorized === true) { // Authorization successful, start transaction if ( this.setRemoteStartTransactionChargingProfile( + chargingStation, transactionConnectorId, commandPayload.chargingProfile - ) + ) === true ) { connectorStatus.transactionRemoteStarted = true; if ( ( - await this.chargingStation.ocppRequestService.requestHandler< + await chargingStation.ocppRequestService.requestHandler< OCPP16StartTransactionRequest, OCPP16StartTransactionResponse - >(OCPP16RequestCommand.START_TRANSACTION, { + >(chargingStation, OCPP16RequestCommand.START_TRANSACTION, { connectorId: transactionConnectorId, idTag: 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; + logger.debug(remoteStartTransactionLogMsg); + return OCPPConstants.OCPP_RESPONSE_ACCEPTED; } return this.notifyRemoteStartTransactionRejected( + chargingStation, transactionConnectorId, commandPayload.idTag ); } return this.notifyRemoteStartTransactionRejected( + chargingStation, transactionConnectorId, commandPayload.idTag ); } return this.notifyRemoteStartTransactionRejected( + chargingStation, transactionConnectorId, commandPayload.idTag ); @@ -660,98 +810,92 @@ export default class OCPP16IncomingRequestService extends OCPPIncomingRequestSer // No authorization check required, start transaction if ( this.setRemoteStartTransactionChargingProfile( + chargingStation, transactionConnectorId, commandPayload.chargingProfile - ) + ) === true ) { connectorStatus.transactionRemoteStarted = true; if ( ( - await this.chargingStation.ocppRequestService.requestHandler< + await chargingStation.ocppRequestService.requestHandler< OCPP16StartTransactionRequest, OCPP16StartTransactionResponse - >(OCPP16RequestCommand.START_TRANSACTION, { + >(chargingStation, OCPP16RequestCommand.START_TRANSACTION, { connectorId: transactionConnectorId, idTag: 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; + logger.debug(remoteStartTransactionLogMsg); + return OCPPConstants.OCPP_RESPONSE_ACCEPTED; } return this.notifyRemoteStartTransactionRejected( + chargingStation, transactionConnectorId, commandPayload.idTag ); } return this.notifyRemoteStartTransactionRejected( + chargingStation, transactionConnectorId, commandPayload.idTag ); } return this.notifyRemoteStartTransactionRejected( + chargingStation, transactionConnectorId, commandPayload.idTag ); } - return this.notifyRemoteStartTransactionRejected(transactionConnectorId, commandPayload.idTag); + return this.notifyRemoteStartTransactionRejected( + chargingStation, + transactionConnectorId, + commandPayload.idTag + ); } private async notifyRemoteStartTransactionRejected( + chargingStation: ChargingStation, connectorId: number, idTag: string - ): Promise { + ): Promise { if ( - this.chargingStation.getConnectorStatus(connectorId).status !== - OCPP16ChargePointStatus.AVAILABLE + chargingStation.getConnectorStatus(connectorId)?.status !== OCPP16ChargePointStatus.Available ) { - await this.chargingStation.ocppRequestService.requestHandler< + await chargingStation.ocppRequestService.requestHandler< OCPP16StatusNotificationRequest, OCPP16StatusNotificationResponse - >(OCPP16RequestCommand.STATUS_NOTIFICATION, { + >(chargingStation, OCPP16RequestCommand.STATUS_NOTIFICATION, { connectorId, - status: OCPP16ChargePointStatus.AVAILABLE, + status: OCPP16ChargePointStatus.Available, errorCode: OCPP16ChargePointErrorCode.NO_ERROR, }); - this.chargingStation.getConnectorStatus(connectorId).status = - OCPP16ChargePointStatus.AVAILABLE; + 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 OCPPConstants.OCPP_RESPONSE_REJECTED; } private setRemoteStartTransactionChargingProfile( + chargingStation: ChargingStation, connectorId: number, cp: OCPP16ChargingProfile ): boolean { - if (cp && cp.chargingProfilePurpose === ChargingProfilePurposeType.TX_PROFILE) { - this.chargingStation.setChargingProfile(connectorId, cp); + if (cp && cp.chargingProfilePurpose === OCPP16ChargingProfilePurposeType.TX_PROFILE) { + OCPP16ServiceUtils.setChargingProfile(chargingStation, connectorId, cp); logger.debug( - `${this.chargingStation.logPrefix()} Charging profile(s) set at remote start transaction on connector id ${connectorId}, dump their stack: %j`, - this.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) { + } else if (cp && cp.chargingProfilePurpose !== OCPP16ChargingProfilePurposeType.TX_PROFILE) { logger.warn( - `${this.chargingStation.logPrefix()} Not allowed to set ${ + `${chargingStation.logPrefix()} Not allowed to set ${ cp.chargingProfilePurpose } charging profile(s) at remote start transaction` ); @@ -762,126 +906,235 @@ export default class OCPP16IncomingRequestService extends OCPPIncomingRequestSer } private async handleRequestRemoteStopTransaction( + chargingStation: ChargingStation, commandPayload: RemoteStopTransactionRequest - ): Promise { + ): Promise { const transactionId = commandPayload.transactionId; - for (const connectorId of this.chargingStation.connectors.keys()) { + for (const connectorId of chargingStation.connectors.keys()) { if ( connectorId > 0 && - this.chargingStation.getConnectorStatus(connectorId)?.transactionId === transactionId + chargingStation.getConnectorStatus(connectorId)?.transactionId === transactionId ) { - await this.chargingStation.ocppRequestService.requestHandler< + await chargingStation.ocppRequestService.requestHandler< OCPP16StatusNotificationRequest, OCPP16StatusNotificationResponse - >(OCPP16RequestCommand.STATUS_NOTIFICATION, { + >(chargingStation, OCPP16RequestCommand.STATUS_NOTIFICATION, { connectorId, - status: OCPP16ChargePointStatus.FINISHING, + status: OCPP16ChargePointStatus.Finishing, errorCode: OCPP16ChargePointErrorCode.NO_ERROR, }); - this.chargingStation.getConnectorStatus(connectorId).status = - OCPP16ChargePointStatus.FINISHING; - if ( - this.chargingStation.getBeginEndMeterValues() && - this.chargingStation.getOcppStrictCompliance() && - !this.chargingStation.getOutOfOrderEndMeterValues() - ) { - // FIXME: Implement OCPP version agnostic helpers - const transactionEndMeterValue = OCPP16ServiceUtils.buildTransactionEndMeterValue( - this.chargingStation, - connectorId, - this.chargingStation.getEnergyActiveImportRegisterByTransactionId(transactionId) - ); - await this.chargingStation.ocppRequestService.requestHandler< - OCPP16MeterValuesRequest, - OCPP16MeterValuesResponse - >(OCPP16RequestCommand.METER_VALUES, { - connectorId, - transactionId, - meterValue: transactionEndMeterValue, - }); + chargingStation.getConnectorStatus(connectorId).status = OCPP16ChargePointStatus.Finishing; + const stopResponse = await chargingStation.stopTransactionOnConnector( + connectorId, + OCPP16StopTransactionReason.REMOTE + ); + if (stopResponse.idTagInfo?.status === OCPP16AuthorizationStatus.ACCEPTED) { + return OCPPConstants.OCPP_RESPONSE_ACCEPTED; } - await this.chargingStation.ocppRequestService.requestHandler< - OCPP16StopTransactionRequest, - OCPP16StopTransactionResponse - >(OCPP16RequestCommand.STOP_TRANSACTION, { - transactionId, - meterStop: - this.chargingStation.getEnergyActiveImportRegisterByTransactionId(transactionId), - idTag: this.chargingStation.getTransactionIdTag(transactionId), - }); - return Constants.OCPP_RESPONSE_ACCEPTED; + return OCPPConstants.OCPP_RESPONSE_REJECTED; } } - 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 ${transactionId.toString()}` ); - return Constants.OCPP_RESPONSE_REJECTED; + return OCPPConstants.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 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); + const now = Date.now(); + if (retrieveDate?.getTime() <= now) { + this.runInAsyncScope( + this.updateFirmware.bind(this) as ( + this: OCPP16IncomingRequestService, + ...args: any[] + ) => Promise, + this, + chargingStation + ).catch(Constants.EMPTY_FUNCTION); + } else { + setTimeout(() => { + this.updateFirmware(chargingStation).catch(Constants.EMPTY_FUNCTION); + }, retrieveDate?.getTime() - now); + } + return OCPPConstants.OCPP_RESPONSE_EMPTY; + } + + private async updateFirmware( + chargingStation: ChargingStation, + maxDelay = 30, + minDelay = 15 + ): Promise { + chargingStation.stopAutomaticTransactionGenerator(); + for (const connectorId of chargingStation.connectors.keys()) { + if ( + connectorId > 0 && + chargingStation.getConnectorStatus(connectorId)?.transactionStarted === false + ) { + await chargingStation.ocppRequestService.requestHandler< + OCPP16StatusNotificationRequest, + OCPP16StatusNotificationResponse + >(chargingStation, OCPP16RequestCommand.STATUS_NOTIFICATION, { + connectorId, + status: OCPP16ChargePointStatus.Unavailable, + errorCode: OCPP16ChargePointErrorCode.NO_ERROR, + }); + chargingStation.getConnectorStatus(connectorId).status = + 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 Utils.sleep(Utils.getRandomInteger(maxDelay, minDelay) * 1000); + 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 Utils.sleep(Utils.getRandomInteger(maxDelay, minDelay) * 1000); + await chargingStation.ocppRequestService.requestHandler< + OCPP16FirmwareStatusNotificationRequest, + OCPP16FirmwareStatusNotificationResponse + >(chargingStation, OCPP16RequestCommand.FIRMWARE_STATUS_NOTIFICATION, { + status: OCPP16FirmwareStatus.Downloaded, + }); + chargingStation.stationInfo.firmwareStatus = OCPP16FirmwareStatus.Downloaded; + await Utils.sleep(Utils.getRandomInteger(maxDelay, minDelay) * 1000); + 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 Utils.sleep(Utils.getRandomInteger(maxDelay, minDelay) * 1000); + 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 Utils.sleep(Utils.getRandomInteger(maxDelay, minDelay) * 1000); + await chargingStation.reset(OCPP16StopTransactionReason.REBOOT); + } } private async handleRequestGetDiagnostics( + chargingStation: ChargingStation, commandPayload: GetDiagnosticsRequest ): Promise { if ( - !OCPP16ServiceUtils.checkFeatureProfile( - this.chargingStation, + OCPP16ServiceUtils.checkFeatureProfile( + chargingStation, OCPP16SupportedFeatureProfiles.FirmwareManagement, OCPP16IncomingRequestCommand.GET_DIAGNOSTICS - ) + ) === false ) { - return Constants.OCPP_RESPONSE_EMPTY; + logger.warn( + `${chargingStation.logPrefix()} ${moduleName}.handleRequestGetDiagnostics: Cannot get diagnostics: feature profile not supported` + ); + return OCPPConstants.OCPP_RESPONSE_EMPTY; } - logger.debug( - this.chargingStation.logPrefix() + - ' ' + - OCPP16IncomingRequestCommand.GET_DIAGNOSTICS + - ' request received: %j', - commandPayload - ); const uri = new URL(commandPayload.location); if (uri.protocol.startsWith('ftp:')) { let ftpClient: Client; try { const logFiles = fs - .readdirSync(path.resolve(__dirname, '../../../../')) + .readdirSync(path.resolve(path.dirname(fileURLToPath(import.meta.url)), '../../../../')) .filter((file) => file.endsWith('.log')) .map((file) => path.join('./', file)); - const diagnosticsArchive = - this.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({ 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 }), + ...(Utils.isNotEmptyString(uri.port) && { port: Utils.convertToInt(uri.port) }), + ...(Utils.isNotEmptyString(uri.username) && { user: uri.username }), + ...(Utils.isNotEmptyString(uri.password) && { password: uri.password }), }); 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( - `${this.chargingStation.logPrefix()} ${ + `${chargingStation.logPrefix()} ${ info.bytes / 1024 } bytes transferred from diagnostics archive ${info.name}` ); - await this.chargingStation.ocppRequestService.requestHandler< - DiagnosticsStatusNotificationRequest, - DiagnosticsStatusNotificationResponse - >(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(path.resolve(__dirname, '../../../../'), diagnosticsArchive), - uri.pathname + diagnosticsArchive + path.join( + path.resolve(path.dirname(fileURLToPath(import.meta.url)), '../../../../'), + diagnosticsArchive + ), + `${uri.pathname}${diagnosticsArchive}` ); if (uploadResponse.code === 226) { - await this.chargingStation.ocppRequestService.requestHandler< - DiagnosticsStatusNotificationRequest, - DiagnosticsStatusNotificationResponse - >(OCPP16RequestCommand.DIAGNOSTICS_STATUS_NOTIFICATION, { + await chargingStation.ocppRequestService.requestHandler< + OCPP16DiagnosticsStatusNotificationRequest, + OCPP16DiagnosticsStatusNotificationResponse + >(chargingStation, OCPP16RequestCommand.DIAGNOSTICS_STATUS_NOTIFICATION, { status: OCPP16DiagnosticsStatus.Uploaded, }); if (ftpClient) { @@ -892,7 +1145,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 ); @@ -900,163 +1153,172 @@ 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 ); } catch (error) { - await this.chargingStation.ocppRequestService.requestHandler< - DiagnosticsStatusNotificationRequest, - DiagnosticsStatusNotificationResponse - >(OCPP16RequestCommand.DIAGNOSTICS_STATUS_NOTIFICATION, { + await chargingStation.ocppRequestService.requestHandler< + OCPP16DiagnosticsStatusNotificationRequest, + OCPP16DiagnosticsStatusNotificationResponse + >(chargingStation, OCPP16RequestCommand.DIAGNOSTICS_STATUS_NOTIFICATION, { status: OCPP16DiagnosticsStatus.UploadFailed, }); if (ftpClient) { ftpClient.close(); } return this.handleIncomingRequestError( + chargingStation, OCPP16IncomingRequestCommand.GET_DIAGNOSTICS, error as Error, - { errorResponse: Constants.OCPP_RESPONSE_EMPTY } + { errorResponse: OCPPConstants.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.requestHandler< - DiagnosticsStatusNotificationRequest, - DiagnosticsStatusNotificationResponse - >(OCPP16RequestCommand.DIAGNOSTICS_STATUS_NOTIFICATION, { + await chargingStation.ocppRequestService.requestHandler< + OCPP16DiagnosticsStatusNotificationRequest, + OCPP16DiagnosticsStatusNotificationResponse + >(chargingStation, OCPP16RequestCommand.DIAGNOSTICS_STATUS_NOTIFICATION, { status: OCPP16DiagnosticsStatus.UploadFailed, }); - return Constants.OCPP_RESPONSE_EMPTY; + return OCPPConstants.OCPP_RESPONSE_EMPTY; } } private handleRequestTriggerMessage( + chargingStation: ChargingStation, commandPayload: OCPP16TriggerMessageRequest ): OCPP16TriggerMessageResponse { if ( !OCPP16ServiceUtils.checkFeatureProfile( - this.chargingStation, + chargingStation, OCPP16SupportedFeatureProfiles.RemoteTrigger, OCPP16IncomingRequestCommand.TRIGGER_MESSAGE + ) || + !OCPP16ServiceUtils.isMessageTriggerSupported( + chargingStation, + commandPayload.requestedMessage ) ) { - return Constants.OCPP_TRIGGER_MESSAGE_RESPONSE_NOT_IMPLEMENTED; + return OCPPConstants.OCPP_TRIGGER_MESSAGE_RESPONSE_NOT_IMPLEMENTED; } - // TODO: factor out the check on connector id - if (commandPayload?.connectorId < 0) { - logger.warn( - `${this.chargingStation.logPrefix()} ${ - OCPP16IncomingRequestCommand.TRIGGER_MESSAGE - } incoming request received with invalid connectorId ${commandPayload.connectorId}` - ); - return Constants.OCPP_TRIGGER_MESSAGE_RESPONSE_REJECTED; + if ( + !OCPP16ServiceUtils.isConnectorIdValid( + chargingStation, + OCPP16IncomingRequestCommand.TRIGGER_MESSAGE, + commandPayload.connectorId + ) + ) { + return OCPPConstants.OCPP_TRIGGER_MESSAGE_RESPONSE_REJECTED; } try { switch (commandPayload.requestedMessage) { - case MessageTrigger.BootNotification: + case OCPP16MessageTrigger.BootNotification: setTimeout(() => { - this.chargingStation.ocppRequestService + chargingStation.ocppRequestService .requestHandler( + chargingStation, OCPP16RequestCommand.BOOT_NOTIFICATION, - { - chargePointModel: - this.chargingStation.getBootNotificationRequest().chargePointModel, - chargePointVendor: - this.chargingStation.getBootNotificationRequest().chargePointVendor, - chargeBoxSerialNumber: - this.chargingStation.getBootNotificationRequest().chargeBoxSerialNumber, - firmwareVersion: - this.chargingStation.getBootNotificationRequest().firmwareVersion, - chargePointSerialNumber: - this.chargingStation.getBootNotificationRequest().chargePointSerialNumber, - iccid: this.chargingStation.getBootNotificationRequest().iccid, - imsi: this.chargingStation.getBootNotificationRequest().imsi, - meterSerialNumber: - this.chargingStation.getBootNotificationRequest().meterSerialNumber, - meterType: this.chargingStation.getBootNotificationRequest().meterType, - }, + chargingStation.bootNotificationRequest, { skipBufferingOnError: true, triggerMessage: true } ) - .then((value) => { - this.chargingStation.bootNotificationResponse = value; + .then((response) => { + chargingStation.bootNotificationResponse = response; }) - .catch(() => { - /* This is intentional */ - }); + .catch(Constants.EMPTY_FUNCTION); }, Constants.OCPP_TRIGGER_MESSAGE_DELAY); - return Constants.OCPP_TRIGGER_MESSAGE_RESPONSE_ACCEPTED; - case MessageTrigger.Heartbeat: + return OCPPConstants.OCPP_TRIGGER_MESSAGE_RESPONSE_ACCEPTED; + case OCPP16MessageTrigger.Heartbeat: setTimeout(() => { - this.chargingStation.ocppRequestService + chargingStation.ocppRequestService .requestHandler( + chargingStation, OCPP16RequestCommand.HEARTBEAT, null, { triggerMessage: true, } ) - .catch(() => { - /* This is intentional */ - }); + .catch(Constants.EMPTY_FUNCTION); }, Constants.OCPP_TRIGGER_MESSAGE_DELAY); - return Constants.OCPP_TRIGGER_MESSAGE_RESPONSE_ACCEPTED; - case MessageTrigger.StatusNotification: + return OCPPConstants.OCPP_TRIGGER_MESSAGE_RESPONSE_ACCEPTED; + case OCPP16MessageTrigger.StatusNotification: setTimeout(() => { - if (commandPayload?.connectorId) { - this.chargingStation.ocppRequestService + if (!Utils.isNullOrUndefined(commandPayload?.connectorId)) { + chargingStation.ocppRequestService .requestHandler( + chargingStation, OCPP16RequestCommand.STATUS_NOTIFICATION, { connectorId: commandPayload.connectorId, errorCode: OCPP16ChargePointErrorCode.NO_ERROR, - status: this.chargingStation.getConnectorStatus(commandPayload.connectorId) - .status, + status: chargingStation.getConnectorStatus(commandPayload.connectorId)?.status, }, { triggerMessage: true, } ) - .catch(() => { - /* This is intentional */ - }); + .catch(Constants.EMPTY_FUNCTION); } else { - for (const connectorId of this.chargingStation.connectors.keys()) { - this.chargingStation.ocppRequestService + for (const connectorId of chargingStation.connectors.keys()) { + chargingStation.ocppRequestService .requestHandler< OCPP16StatusNotificationRequest, OCPP16StatusNotificationResponse >( + chargingStation, OCPP16RequestCommand.STATUS_NOTIFICATION, { connectorId, errorCode: OCPP16ChargePointErrorCode.NO_ERROR, - status: this.chargingStation.getConnectorStatus(connectorId).status, + status: chargingStation.getConnectorStatus(connectorId)?.status, }, { triggerMessage: true, } ) - .catch(() => { - /* This is intentional */ - }); + .catch(Constants.EMPTY_FUNCTION); } } }, Constants.OCPP_TRIGGER_MESSAGE_DELAY); - return Constants.OCPP_TRIGGER_MESSAGE_RESPONSE_ACCEPTED; + return OCPPConstants.OCPP_TRIGGER_MESSAGE_RESPONSE_ACCEPTED; default: - return Constants.OCPP_TRIGGER_MESSAGE_RESPONSE_NOT_IMPLEMENTED; + return OCPPConstants.OCPP_TRIGGER_MESSAGE_RESPONSE_NOT_IMPLEMENTED; } } catch (error) { return this.handleIncomingRequestError( + chargingStation, OCPP16IncomingRequestCommand.TRIGGER_MESSAGE, error as Error, - { errorResponse: Constants.OCPP_TRIGGER_MESSAGE_RESPONSE_REJECTED } + { errorResponse: OCPPConstants.OCPP_TRIGGER_MESSAGE_RESPONSE_REJECTED } + ); + } + } + + private handleRequestDataTransfer( + chargingStation: ChargingStation, + commandPayload: OCPP16DataTransferRequest + ): OCPP16DataTransferResponse { + try { + if (Object.values(OCPP16DataTransferVendorId).includes(commandPayload.vendorId)) { + return { + status: OCPP16DataTransferStatus.ACCEPTED, + }; + } + return { + status: OCPP16DataTransferStatus.UNKNOWN_VENDOR_ID, + }; + } catch (error) { + return this.handleIncomingRequestError( + chargingStation, + OCPP16IncomingRequestCommand.DATA_TRANSFER, + error as Error, + { errorResponse: OCPPConstants.OCPP_DATA_TRANSFER_RESPONSE_REJECTED } ); } }