-// Partial Copyright Jerome Benoit. 2021. All Rights Reserved.
+// Partial Copyright Jerome Benoit. 2021-2023. All Rights Reserved.
-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';
-import { ChargingProfilePurposeType, OCPP16ChargingProfile } from '../../../types/ocpp/1.6/ChargingProfile';
-import { Client, FTPResponse } from 'basic-ftp';
-import { OCPP16AuthorizationStatus, OCPP16StopTransactionReason } from '../../../types/ocpp/1.6/Transaction';
+import { createWriteStream, readdirSync } from 'node:fs';
+import { dirname, join, resolve } from 'node:path';
+import { URL, fileURLToPath } from 'node:url';
-import 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 { MessageType } from '../../../types/ocpp/MessageType';
-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 '../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';
+import type { JSONSchemaType } from 'ajv';
+import { Client, type FTPResponse } from 'basic-ftp';
+import { create } from 'tar';
-export default class OCPP16IncomingRequestService extends OCPPIncomingRequestService {
+import { OCPP16Constants } from './OCPP16Constants';
+import { OCPP16ServiceUtils } from './OCPP16ServiceUtils';
+import {
+ type ChargingStation,
+ ChargingStationConfigurationUtils,
+ checkChargingStation,
+} from '../../../charging-station';
+import { OCPPError } from '../../../exception';
+import {
+ type ChangeAvailabilityRequest,
+ type ChangeAvailabilityResponse,
+ type ChangeConfigurationRequest,
+ type ChangeConfigurationResponse,
+ type ClearChargingProfileRequest,
+ type ClearChargingProfileResponse,
+ type ConnectorStatus,
+ 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,
+ OCPP16ChargePointErrorCode,
+ OCPP16ChargePointStatus,
+ type OCPP16ChargingProfile,
+ OCPP16ChargingProfilePurposeType,
+ type OCPP16ChargingSchedule,
+ 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,
+ OCPP16SupportedFeatureProfiles,
+ type OCPP16TriggerMessageRequest,
+ type OCPP16TriggerMessageResponse,
+ type OCPP16UpdateFirmwareRequest,
+ type OCPP16UpdateFirmwareResponse,
+ type OCPPConfigurationKey,
+ OCPPVersion,
+ type RemoteStartTransactionRequest,
+ type RemoteStopTransactionRequest,
+ ReservationFilterKey,
+ ReservationTerminationReason,
+ type ResetRequest,
+ type SetChargingProfileRequest,
+ type SetChargingProfileResponse,
+ type StartTransactionRequest,
+ type UnlockConnectorRequest,
+ type UnlockConnectorResponse,
+} from '../../../types';
+import {
+ Constants,
+ convertToDate,
+ convertToInt,
+ formatDurationMilliSeconds,
+ getRandomInteger,
+ isEmptyArray,
+ isNotEmptyArray,
+ isNotEmptyString,
+ isNullOrUndefined,
+ isUndefined,
+ logger,
+ sleep,
+} from '../../../utils';
+import { OCPPIncomingRequestService } from '../OCPPIncomingRequestService';
+
+const moduleName = 'OCPP16IncomingRequestService';
+
+export class OCPP16IncomingRequestService extends OCPPIncomingRequestService {
+ protected jsonSchemas: Map<OCPP16IncomingRequestCommand, JSONSchemaType<JsonObject>>;
private incomingRequestHandlers: Map<OCPP16IncomingRequestCommand, IncomingRequestHandler>;
- constructor(chargingStation: ChargingStation) {
- 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, IncomingRequestHandler>([
- [OCPP16IncomingRequestCommand.RESET, this.handleRequestReset.bind(this)],
- [OCPP16IncomingRequestCommand.CLEAR_CACHE, this.handleRequestClearCache.bind(this)],
- [OCPP16IncomingRequestCommand.UNLOCK_CONNECTOR, this.handleRequestUnlockConnector.bind(this)],
- [OCPP16IncomingRequestCommand.GET_CONFIGURATION, this.handleRequestGetConfiguration.bind(this)],
- [OCPP16IncomingRequestCommand.CHANGE_CONFIGURATION, this.handleRequestChangeConfiguration.bind(this)],
- [OCPP16IncomingRequestCommand.SET_CHARGING_PROFILE, this.handleRequestSetChargingProfile.bind(this)],
- [OCPP16IncomingRequestCommand.CLEAR_CHARGING_PROFILE, this.handleRequestClearChargingProfile.bind(this)],
- [OCPP16IncomingRequestCommand.CHANGE_AVAILABILITY, this.handleRequestChangeAvailability.bind(this)],
- [OCPP16IncomingRequestCommand.REMOTE_START_TRANSACTION, this.handleRequestRemoteStartTransaction.bind(this)],
- [OCPP16IncomingRequestCommand.REMOTE_STOP_TRANSACTION, this.handleRequestRemoteStopTransaction.bind(this)],
- [OCPP16IncomingRequestCommand.GET_DIAGNOSTICS, this.handleRequestGetDiagnostics.bind(this)],
- [OCPP16IncomingRequestCommand.TRIGGER_MESSAGE, this.handleRequestTriggerMessage.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, JSONSchemaType<JsonObject>>([
+ [
+ OCPP16IncomingRequestCommand.RESET,
+ OCPP16ServiceUtils.parseJsonSchemaFile<ResetRequest>(
+ 'assets/json-schemas/ocpp/1.6/Reset.json',
+ moduleName,
+ 'constructor',
+ ),
+ ],
+ [
+ OCPP16IncomingRequestCommand.CLEAR_CACHE,
+ OCPP16ServiceUtils.parseJsonSchemaFile<OCPP16ClearCacheRequest>(
+ 'assets/json-schemas/ocpp/1.6/ClearCache.json',
+ moduleName,
+ 'constructor',
+ ),
+ ],
+ [
+ OCPP16IncomingRequestCommand.UNLOCK_CONNECTOR,
+ OCPP16ServiceUtils.parseJsonSchemaFile<UnlockConnectorRequest>(
+ 'assets/json-schemas/ocpp/1.6/UnlockConnector.json',
+ moduleName,
+ 'constructor',
+ ),
+ ],
+ [
+ OCPP16IncomingRequestCommand.GET_CONFIGURATION,
+ OCPP16ServiceUtils.parseJsonSchemaFile<GetConfigurationRequest>(
+ 'assets/json-schemas/ocpp/1.6/GetConfiguration.json',
+ moduleName,
+ 'constructor',
+ ),
+ ],
+ [
+ OCPP16IncomingRequestCommand.CHANGE_CONFIGURATION,
+ OCPP16ServiceUtils.parseJsonSchemaFile<ChangeConfigurationRequest>(
+ 'assets/json-schemas/ocpp/1.6/ChangeConfiguration.json',
+ moduleName,
+ 'constructor',
+ ),
+ ],
+ [
+ OCPP16IncomingRequestCommand.GET_DIAGNOSTICS,
+ OCPP16ServiceUtils.parseJsonSchemaFile<GetDiagnosticsRequest>(
+ 'assets/json-schemas/ocpp/1.6/GetDiagnostics.json',
+ moduleName,
+ 'constructor',
+ ),
+ ],
+ [
+ OCPP16IncomingRequestCommand.GET_COMPOSITE_SCHEDULE,
+ OCPP16ServiceUtils.parseJsonSchemaFile<OCPP16GetCompositeScheduleRequest>(
+ 'assets/json-schemas/ocpp/1.6/GetCompositeSchedule.json',
+ moduleName,
+ 'constructor',
+ ),
+ ],
+ [
+ OCPP16IncomingRequestCommand.SET_CHARGING_PROFILE,
+ OCPP16ServiceUtils.parseJsonSchemaFile<SetChargingProfileRequest>(
+ 'assets/json-schemas/ocpp/1.6/SetChargingProfile.json',
+ moduleName,
+ 'constructor',
+ ),
+ ],
+ [
+ OCPP16IncomingRequestCommand.CLEAR_CHARGING_PROFILE,
+ OCPP16ServiceUtils.parseJsonSchemaFile<ClearChargingProfileRequest>(
+ 'assets/json-schemas/ocpp/1.6/ClearChargingProfile.json',
+ moduleName,
+ 'constructor',
+ ),
+ ],
+ [
+ OCPP16IncomingRequestCommand.CHANGE_AVAILABILITY,
+ OCPP16ServiceUtils.parseJsonSchemaFile<ChangeAvailabilityRequest>(
+ 'assets/json-schemas/ocpp/1.6/ChangeAvailability.json',
+ moduleName,
+ 'constructor',
+ ),
+ ],
+ [
+ OCPP16IncomingRequestCommand.REMOTE_START_TRANSACTION,
+ OCPP16ServiceUtils.parseJsonSchemaFile<RemoteStartTransactionRequest>(
+ 'assets/json-schemas/ocpp/1.6/RemoteStartTransaction.json',
+ moduleName,
+ 'constructor',
+ ),
+ ],
+ [
+ OCPP16IncomingRequestCommand.REMOTE_STOP_TRANSACTION,
+ OCPP16ServiceUtils.parseJsonSchemaFile<RemoteStopTransactionRequest>(
+ 'assets/json-schemas/ocpp/1.6/RemoteStopTransaction.json',
+ moduleName,
+ 'constructor',
+ ),
+ ],
+ [
+ OCPP16IncomingRequestCommand.TRIGGER_MESSAGE,
+ OCPP16ServiceUtils.parseJsonSchemaFile<OCPP16TriggerMessageRequest>(
+ 'assets/json-schemas/ocpp/1.6/TriggerMessage.json',
+ moduleName,
+ 'constructor',
+ ),
+ ],
+ [
+ OCPP16IncomingRequestCommand.DATA_TRANSFER,
+ OCPP16ServiceUtils.parseJsonSchemaFile<OCPP16DataTransferRequest>(
+ 'assets/json-schemas/ocpp/1.6/DataTransfer.json',
+ moduleName,
+ 'constructor',
+ ),
+ ],
+ [
+ OCPP16IncomingRequestCommand.UPDATE_FIRMWARE,
+ OCPP16ServiceUtils.parseJsonSchemaFile<OCPP16UpdateFirmwareRequest>(
+ 'assets/json-schemas/ocpp/1.6/UpdateFirmware.json',
+ moduleName,
+ 'constructor',
+ ),
+ ],
+ [
+ OCPP16IncomingRequestCommand.RESERVE_NOW,
+ OCPP16ServiceUtils.parseJsonSchemaFile<OCPP16ReserveNowRequest>(
+ 'assets/json-schemas/ocpp/1.6/ReserveNow.json',
+ moduleName,
+ 'constructor',
+ ),
+ ],
+ [
+ OCPP16IncomingRequestCommand.CANCEL_RESERVATION,
+ OCPP16ServiceUtils.parseJsonSchemaFile<OCPP16CancelReservationRequest>(
+ 'assets/json-schemas/ocpp/1.6/CancelReservation.json',
+ moduleName,
+ 'constructor',
+ ),
+ ],
]);
+ this.validatePayload = this.validatePayload.bind(this) as (
+ chargingStation: ChargingStation,
+ commandName: OCPP16IncomingRequestCommand,
+ commandPayload: JsonType,
+ ) => boolean;
}
- public async handleRequest(messageId: string, commandName: OCPP16IncomingRequestCommand, commandPayload: Record<string, unknown>): Promise<void> {
- let response: Record<string, unknown>;
- if (this.incomingRequestHandlers.has(commandName)) {
- try {
- // Call the method to build the response
- response = await this.incomingRequestHandlers.get(commandName)(commandPayload);
- } catch (error) {
- // Log
- logger.error(this.chargingStation.logPrefix() + ' Handle request error: %j', error);
- throw error;
+ public async incomingRequestHandler<ReqType extends JsonType, ResType extends JsonType>(
+ chargingStation: ChargingStation,
+ messageId: string,
+ commandName: OCPP16IncomingRequestCommand,
+ commandPayload: ReqType,
+ ): Promise<void> {
+ let response: ResType;
+ if (
+ 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 PDU ${JSON.stringify(
+ commandPayload,
+ null,
+ 2,
+ )} while the charging station is in pending state on the central server`,
+ commandName,
+ commandPayload,
+ );
+ }
+ if (
+ chargingStation.isRegistered() === true ||
+ (chargingStation.getOcppStrictCompliance() === false &&
+ chargingStation.inUnknownState() === true)
+ ) {
+ if (
+ this.incomingRequestHandlers.has(commandName) === true &&
+ OCPP16ServiceUtils.isIncomingRequestCommandSupported(chargingStation, commandName) === true
+ ) {
+ try {
+ 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(
+ `${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 PDU ${JSON.stringify(
+ commandPayload,
+ null,
+ 2,
+ )}`,
+ commandName,
+ commandPayload,
+ );
}
} else {
- // Throw exception
- throw new OCPPError(ErrorType.NOT_IMPLEMENTED, `${commandName} is not implemented to handle request payload ${JSON.stringify(commandPayload, null, 2)}`, commandName);
+ throw new OCPPError(
+ ErrorType.SECURITY_ERROR,
+ `${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,
+ commandPayload,
+ );
}
// Send the built response
- await this.chargingStation.ocppRequestService.sendMessage(messageId, response, MessageType.CALL_RESULT_MESSAGE, commandName);
+ 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<void> => {
- await this.chargingStation.stop(commandPayload.type + 'Reset' as OCPP16StopTransactionReason);
- 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)}`);
- return Constants.OCPP_RESPONSE_ACCEPTED;
+ 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;
}
- private handleRequestClearCache(): DefaultResponse {
- return Constants.OCPP_RESPONSE_ACCEPTED;
+ // Simulate charging station restart
+ private handleRequestReset(
+ chargingStation: ChargingStation,
+ commandPayload: ResetRequest,
+ ): GenericResponse {
+ this.runInAsyncScope(
+ chargingStation.reset.bind(chargingStation) as (
+ this: ChargingStation,
+ ...args: unknown[]
+ ) => Promise<void>,
+ chargingStation,
+ `${commandPayload.type}Reset` as OCPP16StopTransactionReason,
+ ).catch(Constants.EMPTY_FUNCTION);
+ logger.info(
+ `${chargingStation.logPrefix()} ${
+ commandPayload.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): Promise<UnlockConnectorResponse> {
+ private async handleRequestUnlockConnector(
+ chargingStation: ChargingStation,
+ commandPayload: UnlockConnectorRequest,
+ ): Promise<UnlockConnectorResponse> {
const connectorId = commandPayload.connectorId;
+ 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());
- 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);
+ logger.error(
+ `${chargingStation.logPrefix()} Trying to unlock connector id ${connectorId.toString()}`,
+ );
+ 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(connectorId, OCPP16ChargePointStatus.AVAILABLE);
- this.chargingStation.getConnectorStatus(connectorId).status = OCPP16ChargePointStatus.AVAILABLE;
- return Constants.OCPP_RESPONSE_UNLOCKED;
+ await OCPP16ServiceUtils.sendAndSetConnectorStatus(
+ chargingStation,
+ connectorId,
+ OCPP16ChargePointStatus.Available,
+ );
+ return OCPP16Constants.OCPP_RESPONSE_UNLOCKED;
}
- private handleRequestGetConfiguration(commandPayload: GetConfigurationRequest): GetConfigurationResponse {
+ private handleRequestGetConfiguration(
+ chargingStation: ChargingStation,
+ commandPayload: GetConfigurationRequest,
+ ): GetConfigurationResponse {
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(commandPayload.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({
value: configuration.value,
});
}
- } else {
- for (const key of commandPayload.key) {
- const keyFound = this.chargingStation.getConfigurationKey(key);
+ } else if (isNotEmptyArray(commandPayload.key) === true) {
+ for (const key of commandPayload.key!) {
+ const keyFound = ChargingStationConfigurationUtils.getConfigurationKey(
+ chargingStation,
+ key,
+ 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({
};
}
- private handleRequestChangeConfiguration(commandPayload: ChangeConfigurationRequest): ChangeConfigurationResponse {
- // JSON request fields type sanity check
- if (!Utils.isString(commandPayload.key)) {
- logger.error(`${this.chargingStation.logPrefix()} ${OCPP16RequestCommand.CHANGE_CONFIGURATION} request key field is not a string:`, commandPayload);
- }
- if (!Utils.isString(commandPayload.value)) {
- logger.error(`${this.chargingStation.logPrefix()} ${OCPP16RequestCommand.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);
+ private handleRequestChangeConfiguration(
+ chargingStation: ChargingStation,
+ commandPayload: ChangeConfigurationRequest,
+ ): ChangeConfigurationResponse {
+ const keyToChange = ChargingStationConfigurationUtils.getConfigurationKey(
+ chargingStation,
+ commandPayload.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 !== commandPayload.value) {
+ ChargingStationConfigurationUtils.setConfigurationKeyValue(
+ chargingStation,
+ commandPayload.key,
+ commandPayload.value,
+ true,
+ );
valueChanged = true;
}
let triggerHeartbeatRestart = false;
- if (keyToChange.key === OCPP16StandardParametersKey.HeartBeatInterval && valueChanged) {
- this.chargingStation.setConfigurationKeyValue(OCPP16StandardParametersKey.HeartbeatInterval, commandPayload.value);
+ if (
+ (keyToChange.key as OCPP16StandardParametersKey) ===
+ OCPP16StandardParametersKey.HeartBeatInterval &&
+ valueChanged
+ ) {
+ ChargingStationConfigurationUtils.setConfigurationKeyValue(
+ chargingStation,
+ OCPP16StandardParametersKey.HeartbeatInterval,
+ commandPayload.value,
+ );
triggerHeartbeatRestart = true;
}
- if (keyToChange.key === OCPP16StandardParametersKey.HeartbeatInterval && valueChanged) {
- this.chargingStation.setConfigurationKeyValue(OCPP16StandardParametersKey.HeartBeatInterval, commandPayload.value);
+ if (
+ (keyToChange.key as OCPP16StandardParametersKey) ===
+ OCPP16StandardParametersKey.HeartbeatInterval &&
+ valueChanged
+ ) {
+ 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();
+ 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): SetChargingProfileResponse {
- if (!this.chargingStation.getConnectorStatus(commandPayload.connectorId)) {
- logger.error(`${this.chargingStation.logPrefix()} Trying to set charging profile(s) to a non existing connector Id ${commandPayload.connectorId}`);
- return Constants.OCPP_SET_CHARGING_PROFILE_RESPONSE_REJECTED;
+ private handleRequestSetChargingProfile(
+ chargingStation: ChargingStation,
+ commandPayload: SetChargingProfileRequest,
+ ): SetChargingProfileResponse {
+ if (
+ OCPP16ServiceUtils.checkFeatureProfile(
+ chargingStation,
+ OCPP16SupportedFeatureProfiles.SmartCharging,
+ OCPP16IncomingRequestCommand.SET_CHARGING_PROFILE,
+ ) === false
+ ) {
+ return OCPP16Constants.OCPP_SET_CHARGING_PROFILE_RESPONSE_NOT_SUPPORTED;
+ }
+ if (chargingStation.hasConnector(commandPayload.connectorId) === false) {
+ logger.error(
+ `${chargingStation.logPrefix()} Trying to set charging profile(s) to a
+ non existing connector id ${commandPayload.connectorId}`,
+ );
+ return OCPP16Constants.OCPP_SET_CHARGING_PROFILE_RESPONSE_REJECTED;
}
- if (commandPayload.csChargingProfiles.chargingProfilePurpose === ChargingProfilePurposeType.CHARGE_POINT_MAX_PROFILE && commandPayload.connectorId !== 0) {
- return Constants.OCPP_SET_CHARGING_PROFILE_RESPONSE_REJECTED;
+ if (
+ commandPayload.csChargingProfiles.chargingProfilePurpose ===
+ OCPP16ChargingProfilePurposeType.CHARGE_POINT_MAX_PROFILE &&
+ commandPayload.connectorId !== 0
+ ) {
+ return OCPP16Constants.OCPP_SET_CHARGING_PROFILE_RESPONSE_REJECTED;
}
- if (commandPayload.csChargingProfiles.chargingProfilePurpose === ChargingProfilePurposeType.TX_PROFILE && (commandPayload.connectorId === 0 || !this.chargingStation.getConnectorStatus(commandPayload.connectorId)?.transactionStarted)) {
- return Constants.OCPP_SET_CHARGING_PROFILE_RESPONSE_REJECTED;
+ if (
+ commandPayload.csChargingProfiles.chargingProfilePurpose ===
+ OCPP16ChargingProfilePurposeType.TX_PROFILE &&
+ (commandPayload.connectorId === 0 ||
+ chargingStation.getConnectorStatus(commandPayload.connectorId)?.transactionStarted ===
+ false)
+ ) {
+ logger.error(
+ `${chargingStation.logPrefix()} Trying to set transaction charging profile(s)
+ on connector ${commandPayload.connectorId} without a started transaction`,
+ );
+ return OCPP16Constants.OCPP_SET_CHARGING_PROFILE_RESPONSE_REJECTED;
}
- this.chargingStation.setChargingProfile(commandPayload.connectorId, commandPayload.csChargingProfiles);
- logger.debug(`${this.chargingStation.logPrefix()} Charging profile(s) set, dump their stack: %j`, this.chargingStation.getConnectorStatus(commandPayload.connectorId).chargingProfiles);
- return Constants.OCPP_SET_CHARGING_PROFILE_RESPONSE_ACCEPTED;
+ OCPP16ServiceUtils.setChargingProfile(
+ chargingStation,
+ commandPayload.connectorId,
+ commandPayload.csChargingProfiles,
+ );
+ logger.debug(
+ `${chargingStation.logPrefix()} Charging profile(s) set on connector id ${
+ commandPayload.connectorId
+ }: %j`,
+ commandPayload.csChargingProfiles,
+ );
+ return OCPP16Constants.OCPP_SET_CHARGING_PROFILE_RESPONSE_ACCEPTED;
}
- private handleRequestClearChargingProfile(commandPayload: ClearChargingProfileRequest): ClearChargingProfileResponse {
- if (!this.chargingStation.getConnectorStatus(commandPayload.connectorId)) {
- logger.error(`${this.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;
+ private handleRequestGetCompositeSchedule(
+ chargingStation: ChargingStation,
+ commandPayload: OCPP16GetCompositeScheduleRequest,
+ ): OCPP16GetCompositeScheduleResponse {
+ if (
+ OCPP16ServiceUtils.checkFeatureProfile(
+ chargingStation,
+ OCPP16SupportedFeatureProfiles.SmartCharging,
+ OCPP16IncomingRequestCommand.GET_COMPOSITE_SCHEDULE,
+ ) === false
+ ) {
+ return OCPP16Constants.OCPP_RESPONSE_REJECTED;
}
- if (commandPayload.connectorId && !Utils.isEmptyArray(this.chargingStation.getConnectorStatus(commandPayload.connectorId).chargingProfiles)) {
- this.chargingStation.getConnectorStatus(commandPayload.connectorId).chargingProfiles = [];
- logger.debug(`${this.chargingStation.logPrefix()} Charging profile(s) cleared, dump their stack: %j`, this.chargingStation.getConnectorStatus(commandPayload.connectorId).chargingProfiles);
- return Constants.OCPP_CLEAR_CHARGING_PROFILE_RESPONSE_ACCEPTED;
+ if (chargingStation.hasConnector(commandPayload.connectorId) === false) {
+ logger.error(
+ `${chargingStation.logPrefix()} Trying to get composite schedule to a
+ non existing connector id ${commandPayload.connectorId}`,
+ );
+ return OCPP16Constants.OCPP_RESPONSE_REJECTED;
}
- if (!commandPayload.connectorId) {
+ if (
+ isEmptyArray(chargingStation.getConnectorStatus(commandPayload.connectorId)?.chargingProfiles)
+ ) {
+ return OCPP16Constants.OCPP_RESPONSE_REJECTED;
+ }
+ const startDate = new Date();
+ const endDate = new Date(startDate.getTime() + commandPayload.duration * 1000);
+ let compositeSchedule: OCPP16ChargingSchedule | undefined;
+ for (const chargingProfile of chargingStation.getConnectorStatus(commandPayload.connectorId)!
+ .chargingProfiles!) {
+ // FIXME: build the composite schedule including the local power limit, the stack level, the charging rate unit, etc.
+ if (
+ chargingProfile.chargingSchedule.startSchedule! >= startDate &&
+ chargingProfile.chargingSchedule.startSchedule! <= endDate
+ ) {
+ compositeSchedule = chargingProfile.chargingSchedule;
+ break;
+ }
+ }
+ return {
+ status: GenericStatus.Accepted,
+ scheduleStart: compositeSchedule?.startSchedule,
+ connectorId: commandPayload.connectorId,
+ chargingSchedule: compositeSchedule,
+ };
+ }
+
+ private handleRequestClearChargingProfile(
+ chargingStation: ChargingStation,
+ commandPayload: ClearChargingProfileRequest,
+ ): ClearChargingProfileResponse {
+ if (
+ OCPP16ServiceUtils.checkFeatureProfile(
+ chargingStation,
+ OCPP16SupportedFeatureProfiles.SmartCharging,
+ OCPP16IncomingRequestCommand.CLEAR_CHARGING_PROFILE,
+ ) === false
+ ) {
+ return OCPP16Constants.OCPP_CLEAR_CHARGING_PROFILE_RESPONSE_UNKNOWN;
+ }
+ if (chargingStation.hasConnector(commandPayload.connectorId!) === false) {
+ logger.error(
+ `${chargingStation.logPrefix()} Trying to clear a charging profile(s) to
+ a non existing connector id ${commandPayload.connectorId}`,
+ );
+ return OCPP16Constants.OCPP_CLEAR_CHARGING_PROFILE_RESPONSE_UNKNOWN;
+ }
+ if (
+ !isNullOrUndefined(commandPayload.connectorId) &&
+ isNotEmptyArray(
+ chargingStation.getConnectorStatus(commandPayload.connectorId!)?.chargingProfiles,
+ )
+ ) {
+ chargingStation.getConnectorStatus(commandPayload.connectorId!)!.chargingProfiles = [];
+ logger.debug(
+ `${chargingStation.logPrefix()} Charging profile(s) cleared on connector id ${
+ commandPayload.connectorId
+ }`,
+ );
+ return OCPP16Constants.OCPP_CLEAR_CHARGING_PROFILE_RESPONSE_ACCEPTED;
+ }
+ if (isNullOrUndefined(commandPayload.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;
- }
- });
+ const clearChargingProfiles = (connectorStatus: ConnectorStatus) => {
+ if (isNotEmptyArray(connectorStatus?.chargingProfiles)) {
+ connectorStatus?.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) {
+ connectorStatus?.chargingProfiles?.splice(index, 1);
+ logger.debug(
+ `${chargingStation.logPrefix()} Matching charging profile(s) cleared: %j`,
+ chargingProfile,
+ );
+ clearedCP = true;
+ }
+ },
+ );
+ }
+ };
+ if (chargingStation.hasEvses) {
+ for (const evseStatus of chargingStation.evses.values()) {
+ for (const connectorStatus of evseStatus.connectors.values()) {
+ clearChargingProfiles(connectorStatus);
+ }
+ }
+ } else {
+ for (const connectorId of chargingStation.connectors.keys()) {
+ clearChargingProfiles(chargingStation.getConnectorStatus(connectorId)!);
}
}
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<ChangeAvailabilityResponse> {
+ private async handleRequestChangeAvailability(
+ chargingStation: ChargingStation,
+ commandPayload: ChangeAvailabilityRequest,
+ ): Promise<ChangeAvailabilityResponse> {
const connectorId: number = commandPayload.connectorId;
- if (!this.chargingStation.getConnectorStatus(connectorId)) {
- logger.error(`${this.chargingStation.logPrefix()} Trying to change the availability of a non existing connector Id ${connectorId.toString()}`);
- return Constants.OCPP_AVAILABILITY_RESPONSE_REJECTED;
+ if (chargingStation.hasConnector(connectorId) === false) {
+ logger.error(
+ `${chargingStation.logPrefix()} Trying to change the availability of a
+ non existing connector id ${connectorId.toString()}`,
+ );
+ return OCPP16Constants.OCPP_AVAILABILITY_RESPONSE_REJECTED;
}
- const chargePointStatus: OCPP16ChargePointStatus = commandPayload.type === OCPP16AvailabilityType.OPERATIVE
- ? OCPP16ChargePointStatus.AVAILABLE
- : OCPP16ChargePointStatus.UNAVAILABLE;
+ const chargePointStatus: OCPP16ChargePointStatus =
+ commandPayload.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;
+ let response: ChangeAvailabilityResponse =
+ OCPP16Constants.OCPP_AVAILABILITY_RESPONSE_ACCEPTED;
+ const changeAvailability = async (id: number, connectorStatus: ConnectorStatus) => {
+ if (connectorStatus?.transactionStarted === true) {
+ response = OCPP16Constants.OCPP_AVAILABILITY_RESPONSE_SCHEDULED;
+ }
+ connectorStatus.availability = commandPayload.type;
+ if (response === OCPP16Constants.OCPP_AVAILABILITY_RESPONSE_ACCEPTED) {
+ await OCPP16ServiceUtils.sendAndSetConnectorStatus(
+ chargingStation,
+ id,
+ chargePointStatus,
+ );
+ }
+ };
+ if (chargingStation.hasEvses) {
+ for (const evseStatus of chargingStation.evses.values()) {
+ for (const [id, connectorStatus] of evseStatus.connectors) {
+ await changeAvailability(id, connectorStatus);
+ }
}
- this.chargingStation.getConnectorStatus(id).availability = commandPayload.type;
- if (response === Constants.OCPP_AVAILABILITY_RESPONSE_ACCEPTED) {
- await this.chargingStation.ocppRequestService.sendStatusNotification(id, chargePointStatus);
- this.chargingStation.getConnectorStatus(id).status = chargePointStatus;
+ } else {
+ for (const id of chargingStation.connectors.keys()) {
+ await changeAvailability(id, chargingStation.getConnectorStatus(id)!);
}
}
return response;
- } else if (connectorId > 0 && (this.chargingStation.getConnectorStatus(0).availability === OCPP16AvailabilityType.OPERATIVE || (this.chargingStation.getConnectorStatus(0).availability === OCPP16AvailabilityType.INOPERATIVE && commandPayload.type === OCPP16AvailabilityType.INOPERATIVE))) {
- if (this.chargingStation.getConnectorStatus(connectorId)?.transactionStarted) {
- this.chargingStation.getConnectorStatus(connectorId).availability = commandPayload.type;
- return Constants.OCPP_AVAILABILITY_RESPONSE_SCHEDULED;
+ } else if (
+ connectorId > 0 &&
+ (chargingStation.isChargingStationAvailable() === true ||
+ (chargingStation.isChargingStationAvailable() === false &&
+ commandPayload.type === OCPP16AvailabilityType.Inoperative))
+ ) {
+ if (chargingStation.getConnectorStatus(connectorId)?.transactionStarted === true) {
+ chargingStation.getConnectorStatus(connectorId)!.availability = commandPayload.type;
+ return OCPP16Constants.OCPP_AVAILABILITY_RESPONSE_SCHEDULED;
}
- this.chargingStation.getConnectorStatus(connectorId).availability = commandPayload.type;
- await this.chargingStation.ocppRequestService.sendStatusNotification(connectorId, chargePointStatus);
- this.chargingStation.getConnectorStatus(connectorId).status = chargePointStatus;
- return Constants.OCPP_AVAILABILITY_RESPONSE_ACCEPTED;
+ chargingStation.getConnectorStatus(connectorId)!.availability = commandPayload.type;
+ await OCPP16ServiceUtils.sendAndSetConnectorStatus(
+ chargingStation,
+ connectorId,
+ chargePointStatus,
+ );
+ return OCPP16Constants.OCPP_AVAILABILITY_RESPONSE_ACCEPTED;
}
- return Constants.OCPP_AVAILABILITY_RESPONSE_REJECTED;
+ return OCPP16Constants.OCPP_AVAILABILITY_RESPONSE_REJECTED;
}
- private async handleRequestRemoteStartTransaction(commandPayload: RemoteStartTransactionRequest): Promise<DefaultResponse> {
- const transactionConnectorId: number = commandPayload.connectorId;
- if (transactionConnectorId) {
- await this.chargingStation.ocppRequestService.sendStatusNotification(transactionConnectorId, OCPP16ChargePointStatus.PREPARING);
- this.chargingStation.getConnectorStatus(transactionConnectorId).status = OCPP16ChargePointStatus.PREPARING;
- if (this.chargingStation.isChargingStationAvailable() && this.chargingStation.isConnectorAvailable(transactionConnectorId)) {
- // 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;
- }
- if (!authorized && this.chargingStation.getMayAuthorizeAtRemoteStart()) {
- const authorizeResponse = await this.chargingStation.ocppRequestService.sendAuthorize(transactionConnectorId, commandPayload.idTag);
- if (authorizeResponse?.idTagInfo?.status === OCPP16AuthorizationStatus.ACCEPTED) {
- authorized = true;
- }
- }
- 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);
+ private async handleRequestRemoteStartTransaction(
+ chargingStation: ChargingStation,
+ commandPayload: RemoteStartTransactionRequest,
+ ): Promise<GenericResponse> {
+ const { connectorId: transactionConnectorId, idTag, chargingProfile } = commandPayload;
+ const reserved =
+ chargingStation.getConnectorStatus(transactionConnectorId)!.status ===
+ OCPP16ChargePointStatus.Reserved;
+ const reservedOnConnectorZero =
+ chargingStation.getConnectorStatus(0)!.status === OCPP16ChargePointStatus.Reserved;
+ if (
+ (reserved &&
+ !chargingStation.validateIncomingRequestWithReservation(transactionConnectorId, idTag)) ||
+ (reservedOnConnectorZero && !chargingStation.validateIncomingRequestWithReservation(0, idTag))
+ ) {
+ return OCPP16Constants.OCPP_RESPONSE_REJECTED;
+ }
+ if (chargingStation.hasConnector(transactionConnectorId) === false) {
+ return this.notifyRemoteStartTransactionRejected(
+ chargingStation,
+ transactionConnectorId,
+ idTag,
+ );
+ }
+ 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)!;
+ // Check if authorized
+ if (
+ chargingStation.getAuthorizeRemoteTxRequests() &&
+ (await OCPP16ServiceUtils.isIdTagAuthorized(chargingStation, transactionConnectorId, idTag))
+ ) {
+ // Authorization successful, start transaction
+ if (
+ this.setRemoteStartTransactionChargingProfile(
+ chargingStation,
+ transactionConnectorId,
+ chargingProfile!,
+ ) === true
+ ) {
+ connectorStatus.transactionRemoteStarted = true;
+ const startTransactionPayload: Partial<StartTransactionRequest> = {
+ connectorId: transactionConnectorId,
+ idTag,
+ };
+ if (reserved || reservedOnConnectorZero) {
+ const reservation = chargingStation.getReservationBy(
+ ReservationFilterKey.CONNECTOR_ID,
+ reservedOnConnectorZero ? 0 : transactionConnectorId,
+ )!;
+ startTransactionPayload.reservationId = reservation.id;
+ await chargingStation.removeReservation(
+ reservation,
+ ReservationTerminationReason.TRANSACTION_STARTED,
+ );
}
- // No authorization check required, 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);
+ if (
+ (
+ await chargingStation.ocppRequestService.requestHandler<
+ OCPP16StartTransactionRequest,
+ OCPP16StartTransactionResponse
+ >(chargingStation, OCPP16RequestCommand.START_TRANSACTION, startTransactionPayload)
+ ).idTagInfo.status === OCPP16AuthorizationStatus.ACCEPTED
+ ) {
+ logger.debug(remoteStartTransactionLogMsg);
+ return OCPP16Constants.OCPP_RESPONSE_ACCEPTED;
}
- return this.notifyRemoteStartTransactionRejected(transactionConnectorId, commandPayload.idTag);
+ return this.notifyRemoteStartTransactionRejected(
+ chargingStation,
+ transactionConnectorId,
+ idTag,
+ );
+ }
+ return this.notifyRemoteStartTransactionRejected(
+ chargingStation,
+ transactionConnectorId,
+ 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(transactionConnectorId, commandPayload.idTag);
+ return this.notifyRemoteStartTransactionRejected(
+ chargingStation,
+ transactionConnectorId,
+ idTag,
+ );
}
- return this.notifyRemoteStartTransactionRejected(transactionConnectorId, commandPayload.idTag);
+ return this.notifyRemoteStartTransactionRejected(
+ chargingStation,
+ transactionConnectorId,
+ idTag,
+ );
}
- private async notifyRemoteStartTransactionRejected(connectorId: number, idTag: string): Promise<DefaultResponse> {
- if (this.chargingStation.getConnectorStatus(connectorId).status !== OCPP16ChargePointStatus.AVAILABLE) {
- await this.chargingStation.ocppRequestService.sendStatusNotification(connectorId, OCPP16ChargePointStatus.AVAILABLE);
- this.chargingStation.getConnectorStatus(connectorId).status = OCPP16ChargePointStatus.AVAILABLE;
+ private async notifyRemoteStartTransactionRejected(
+ chargingStation: ChargingStation,
+ connectorId: number,
+ idTag: string,
+ ): Promise<GenericResponse> {
+ if (
+ chargingStation.getConnectorStatus(connectorId)?.status !== OCPP16ChargePointStatus.Available
+ ) {
+ await OCPP16ServiceUtils.sendAndSetConnectorStatus(
+ chargingStation,
+ connectorId,
+ 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);
- return Constants.OCPP_RESPONSE_REJECTED;
+ logger.warn(
+ `${chargingStation.logPrefix()} Remote starting transaction REJECTED on connector id
+ ${connectorId.toString()}, idTag '${idTag}', availability '${chargingStation.getConnectorStatus(
+ connectorId,
+ )?.availability}', status '${chargingStation.getConnectorStatus(connectorId)?.status}'`,
+ );
+ return OCPP16Constants.OCPP_RESPONSE_REJECTED;
}
- private setRemoteStartTransactionChargingProfile(connectorId: number, cp: OCPP16ChargingProfile): boolean {
- if (cp && cp.chargingProfilePurpose === ChargingProfilePurposeType.TX_PROFILE) {
- this.chargingStation.setChargingProfile(connectorId, cp);
- logger.debug(`${this.chargingStation.logPrefix()} Charging profile(s) set at remote start transaction, dump their stack: %j`, this.chargingStation.getConnectorStatus(connectorId).chargingProfiles);
+ private setRemoteStartTransactionChargingProfile(
+ chargingStation: ChargingStation,
+ connectorId: number,
+ cp: OCPP16ChargingProfile,
+ ): boolean {
+ if (cp && cp.chargingProfilePurpose === OCPP16ChargingProfilePurposeType.TX_PROFILE) {
+ OCPP16ServiceUtils.setChargingProfile(chargingStation, connectorId, cp);
+ logger.debug(
+ `${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) {
- logger.warn(`${this.chargingStation.logPrefix()} Not allowed to set ${cp.chargingProfilePurpose} charging profile(s) at remote start transaction`);
+ } else if (cp && cp.chargingProfilePurpose !== OCPP16ChargingProfilePurposeType.TX_PROFILE) {
+ logger.warn(
+ `${chargingStation.logPrefix()} Not allowed to set ${
+ cp.chargingProfilePurpose
+ } charging profile(s) at remote start transaction`,
+ );
return false;
- } else if (!cp) {
- return true;
}
+ return true;
}
- private async handleRequestRemoteStopTransaction(commandPayload: RemoteStopTransactionRequest): Promise<DefaultResponse> {
+ private async handleRequestRemoteStopTransaction(
+ chargingStation: ChargingStation,
+ commandPayload: RemoteStopTransactionRequest,
+ ): Promise<GenericResponse> {
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;
+ const remoteStopTransaction = async (connectorId: number): Promise<GenericResponse> => {
+ await OCPP16ServiceUtils.sendAndSetConnectorStatus(
+ chargingStation,
+ connectorId,
+ OCPP16ChargePointStatus.Finishing,
+ );
+ const stopResponse = await chargingStation.stopTransactionOnConnector(
+ connectorId,
+ OCPP16StopTransactionReason.REMOTE,
+ );
+ if (stopResponse.idTagInfo?.status === OCPP16AuthorizationStatus.ACCEPTED) {
+ return OCPP16Constants.OCPP_RESPONSE_ACCEPTED;
+ }
+ return OCPP16Constants.OCPP_RESPONSE_REJECTED;
+ };
+ 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 remoteStopTransaction(connectorId);
+ }
+ }
+ }
+ }
+ } else {
+ for (const connectorId of chargingStation.connectors.keys()) {
+ if (
+ connectorId > 0 &&
+ chargingStation.getConnectorStatus(connectorId)?.transactionId === transactionId
+ ) {
+ return remoteStopTransaction(connectorId);
+ }
}
}
- logger.info(this.chargingStation.logPrefix() + ' Trying to remote stop a non existing transaction ' + transactionId.toString());
- return Constants.OCPP_RESPONSE_REJECTED;
+ logger.warn(
+ `${chargingStation.logPrefix()} Trying to remote stop a non existing transaction with id:
+ ${transactionId.toString()}`,
+ );
+ return OCPP16Constants.OCPP_RESPONSE_REJECTED;
}
- private async handleRequestGetDiagnostics(commandPayload: GetDiagnosticsRequest): Promise<GetDiagnosticsResponse> {
- logger.debug(this.chargingStation.logPrefix() + ' ' + OCPP16IncomingRequestCommand.GET_DIAGNOSTICS + ' request received: %j', commandPayload);
+ 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;
+ }
+ 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;
+ }
+ const retrieveDate = convertToDate(commandPayload.retrieveDate)!;
+ const now = Date.now();
+ if (retrieveDate?.getTime() <= now) {
+ this.runInAsyncScope(
+ this.updateFirmwareSimulation.bind(this) as (
+ this: OCPP16IncomingRequestService,
+ ...args: unknown[]
+ ) => Promise<void>,
+ this,
+ chargingStation,
+ ).catch(Constants.EMPTY_FUNCTION);
+ } else {
+ setTimeout(
+ () => {
+ this.runInAsyncScope(
+ this.updateFirmwareSimulation.bind(this) as (
+ this: OCPP16IncomingRequestService,
+ ...args: unknown[]
+ ) => Promise<void>,
+ this,
+ chargingStation,
+ ).catch(Constants.EMPTY_FUNCTION);
+ },
+ retrieveDate?.getTime() - now,
+ );
+ }
+ return OCPP16Constants.OCPP_RESPONSE_EMPTY;
+ }
+
+ private async updateFirmwareSimulation(
+ chargingStation: ChargingStation,
+ maxDelay = 30,
+ minDelay = 15,
+ ): Promise<void> {
+ 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(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 sleep(getRandomInteger(maxDelay, minDelay) * 1000);
+ 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 = 15 * 1000;
+ logger.debug(
+ `${chargingStation.logPrefix()} ${moduleName}.updateFirmwareSimulation:
+ ${runningTransactions} transaction(s) in progress, waiting ${
+ waitTime / 1000
+ } seconds 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(getRandomInteger(maxDelay, minDelay) * 1000));
+ 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(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 sleep(getRandomInteger(maxDelay, minDelay) * 1000);
+ await chargingStation.reset(OCPP16StopTransactionReason.REBOOT);
+ }
+ }
+
+ private async handleRequestGetDiagnostics(
+ chargingStation: ChargingStation,
+ commandPayload: GetDiagnosticsRequest,
+ ): Promise<GetDiagnosticsResponse> {
+ 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 uri = new URL(commandPayload.location);
if (uri.protocol.startsWith('ftp:')) {
- let ftpClient: Client;
+ let ftpClient: Client | undefined;
try {
- const logFiles = fs.readdirSync(path.resolve(__dirname, '../../../../')).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));
+ const logFiles = readdirSync(resolve(dirname(fileURLToPath(import.meta.url)), '../'))
+ .filter((file) => file.endsWith('.log'))
+ .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,
- ...(uri.port !== '') && { port: Utils.convertToInt(uri.port) },
- ...(uri.username !== '') && { user: uri.username },
- ...(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) => {
- logger.info(`${this.chargingStation.logPrefix()} ${info.bytes / 1024} bytes transferred from diagnostics archive ${info.name}`);
- await this.chargingStation.ocppRequestService.sendDiagnosticsStatusNotification(OCPP16DiagnosticsStatus.Uploading);
+ ftpClient.trackProgress((info) => {
+ logger.info(
+ `${chargingStation.logPrefix()} ${
+ info.bytes / 1024
+ } 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);
+ uploadResponse = await ftpClient.uploadFrom(
+ 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();
}
return { fileName: diagnosticsArchive };
}
- throw new OCPPError(ErrorType.GENERIC_ERROR, `Diagnostics transfer failed with error code ${accessResponse.code.toString()}${uploadResponse?.code && '|' + uploadResponse?.code.toString()}`, OCPP16IncomingRequestCommand.GET_DIAGNOSTICS);
+ throw new OCPPError(
+ ErrorType.GENERIC_ERROR,
+ `Diagnostics transfer failed with error code ${accessResponse.code.toString()}${
+ uploadResponse?.code && `|${uploadResponse?.code.toString()}`
+ }`,
+ OCPP16IncomingRequestCommand.GET_DIAGNOSTICS,
+ );
}
- throw new OCPPError(ErrorType.GENERIC_ERROR, `Diagnostics transfer failed with error code ${accessResponse.code.toString()}${uploadResponse?.code && '|' + uploadResponse?.code.toString()}`, OCPP16IncomingRequestCommand.GET_DIAGNOSTICS);
+ throw new OCPPError(
+ ErrorType.GENERIC_ERROR,
+ `Diagnostics transfer failed with error code ${accessResponse.code.toString()}${
+ uploadResponse?.code && `|${uploadResponse?.code.toString()}`
+ }`,
+ 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(OCPP16IncomingRequestCommand.GET_DIAGNOSTICS, error, Constants.OCPP_RESPONSE_EMPTY);
+ return this.handleIncomingRequestError<GetDiagnosticsResponse>(
+ chargingStation,
+ OCPP16IncomingRequestCommand.GET_DIAGNOSTICS,
+ error as Error,
+ { errorResponse: OCPP16Constants.OCPP_RESPONSE_EMPTY },
+ )!;
}
} else {
- logger.error(`${this.chargingStation.logPrefix()} Unsupported protocol ${uri.protocol} to transfer the diagnostic logs archive`);
- await this.chargingStation.ocppRequestService.sendDiagnosticsStatusNotification(OCPP16DiagnosticsStatus.UploadFailed);
- return Constants.OCPP_RESPONSE_EMPTY;
+ logger.error(
+ `${chargingStation.logPrefix()} Unsupported protocol ${
+ uri.protocol
+ } to transfer the diagnostic logs archive`,
+ );
+ await chargingStation.ocppRequestService.requestHandler<
+ OCPP16DiagnosticsStatusNotificationRequest,
+ OCPP16DiagnosticsStatusNotificationResponse
+ >(chargingStation, OCPP16RequestCommand.DIAGNOSTICS_STATUS_NOTIFICATION, {
+ status: OCPP16DiagnosticsStatus.UploadFailed,
+ });
+ return OCPP16Constants.OCPP_RESPONSE_EMPTY;
}
}
- private handleRequestTriggerMessage(commandPayload: OCPP16TriggerMessageRequest): OCPP16TriggerMessageResponse {
+ private handleRequestTriggerMessage(
+ chargingStation: ChargingStation,
+ commandPayload: OCPP16TriggerMessageRequest,
+ ): OCPP16TriggerMessageResponse {
+ if (
+ !OCPP16ServiceUtils.checkFeatureProfile(
+ chargingStation,
+ OCPP16SupportedFeatureProfiles.RemoteTrigger,
+ OCPP16IncomingRequestCommand.TRIGGER_MESSAGE,
+ ) ||
+ !OCPP16ServiceUtils.isMessageTriggerSupported(
+ chargingStation,
+ commandPayload.requestedMessage,
+ )
+ ) {
+ return OCPP16Constants.OCPP_TRIGGER_MESSAGE_RESPONSE_NOT_IMPLEMENTED;
+ }
+ if (
+ !OCPP16ServiceUtils.isConnectorIdValid(
+ chargingStation,
+ OCPP16IncomingRequestCommand.TRIGGER_MESSAGE,
+ commandPayload.connectorId!,
+ )
+ ) {
+ return OCPP16Constants.OCPP_TRIGGER_MESSAGE_RESPONSE_REJECTED;
+ }
try {
switch (commandPayload.requestedMessage) {
- case MessageTrigger.BootNotification:
+ case OCPP16MessageTrigger.BootNotification:
+ setTimeout(() => {
+ chargingStation.ocppRequestService
+ .requestHandler<OCPP16BootNotificationRequest, OCPP16BootNotificationResponse>(
+ chargingStation,
+ OCPP16RequestCommand.BOOT_NOTIFICATION,
+ chargingStation.bootNotificationRequest,
+ { skipBufferingOnError: true, triggerMessage: true },
+ )
+ .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.sendBootNotification(this.chargingStation.getBootNotificationRequest().chargePointModel,
- this.chargingStation.getBootNotificationRequest().chargePointVendor, this.chargingStation.getBootNotificationRequest().chargeBoxSerialNumber,
- this.chargingStation.getBootNotificationRequest().firmwareVersion).catch(() => { /* This is intentional */ });
- }, Constants.OCPP_TRIGGER_MESSAGE_DELAY);
- return Constants.OCPP_TRIGGER_MESSAGE_RESPONSE_ACCEPTED;
- case MessageTrigger.Heartbeat:
+ chargingStation.ocppRequestService
+ .requestHandler<OCPP16HeartbeatRequest, OCPP16HeartbeatResponse>(
+ 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(() => {
- this.chargingStation.ocppRequestService.sendHeartbeat().catch(() => { /* This is intentional */ });
- }, Constants.OCPP_TRIGGER_MESSAGE_DELAY);
- return Constants.OCPP_TRIGGER_MESSAGE_RESPONSE_ACCEPTED;
+ if (!isNullOrUndefined(commandPayload?.connectorId)) {
+ chargingStation.ocppRequestService
+ .requestHandler<OCPP16StatusNotificationRequest, OCPP16StatusNotificationResponse>(
+ chargingStation,
+ OCPP16RequestCommand.STATUS_NOTIFICATION,
+ {
+ connectorId: commandPayload.connectorId,
+ errorCode: OCPP16ChargePointErrorCode.NO_ERROR,
+ status: chargingStation.getConnectorStatus(commandPayload.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 [connectorId, connectorStatus] of evseStatus.connectors) {
+ chargingStation.ocppRequestService
+ .requestHandler<
+ OCPP16StatusNotificationRequest,
+ OCPP16StatusNotificationResponse
+ >(
+ chargingStation,
+ OCPP16RequestCommand.STATUS_NOTIFICATION,
+ {
+ connectorId,
+ errorCode: OCPP16ChargePointErrorCode.NO_ERROR,
+ status: connectorStatus.status,
+ },
+ {
+ triggerMessage: true,
+ },
+ )
+ .catch(Constants.EMPTY_FUNCTION);
+ }
+ }
+ } else {
+ for (const connectorId of chargingStation.connectors.keys()) {
+ chargingStation.ocppRequestService
+ .requestHandler<
+ OCPP16StatusNotificationRequest,
+ OCPP16StatusNotificationResponse
+ >(
+ chargingStation,
+ OCPP16RequestCommand.STATUS_NOTIFICATION,
+ {
+ connectorId,
+ errorCode: OCPP16ChargePointErrorCode.NO_ERROR,
+ status: chargingStation.getConnectorStatus(connectorId)?.status,
+ },
+ {
+ triggerMessage: true,
+ },
+ )
+ .catch(Constants.EMPTY_FUNCTION);
+ }
+ }
+ }
+ }, OCPP16Constants.OCPP_TRIGGER_MESSAGE_DELAY);
+ return OCPP16Constants.OCPP_TRIGGER_MESSAGE_RESPONSE_ACCEPTED;
+ default:
+ return OCPP16Constants.OCPP_TRIGGER_MESSAGE_RESPONSE_NOT_IMPLEMENTED;
+ }
+ } catch (error) {
+ return this.handleIncomingRequestError<OCPP16TriggerMessageResponse>(
+ chargingStation,
+ OCPP16IncomingRequestCommand.TRIGGER_MESSAGE,
+ error as Error,
+ { errorResponse: OCPP16Constants.OCPP_TRIGGER_MESSAGE_RESPONSE_REJECTED },
+ )!;
+ }
+ }
+
+ private handleRequestDataTransfer(
+ chargingStation: ChargingStation,
+ commandPayload: OCPP16DataTransferRequest,
+ ): OCPP16DataTransferResponse {
+ try {
+ if (Object.values(OCPP16DataTransferVendorId).includes(commandPayload.vendorId)) {
+ return OCPP16Constants.OCPP_DATA_TRANSFER_RESPONSE_ACCEPTED;
+ }
+ return OCPP16Constants.OCPP_DATA_TRANSFER_RESPONSE_UNKNOWN_VENDOR_ID;
+ } catch (error) {
+ return this.handleIncomingRequestError<OCPP16DataTransferResponse>(
+ chargingStation,
+ OCPP16IncomingRequestCommand.DATA_TRANSFER,
+ error as Error,
+ { errorResponse: OCPP16Constants.OCPP_DATA_TRANSFER_RESPONSE_REJECTED },
+ )!;
+ }
+ }
+
+ private async handleRequestReserveNow(
+ chargingStation: ChargingStation,
+ commandPayload: OCPP16ReserveNowRequest,
+ ): Promise<OCPP16ReserveNowResponse> {
+ 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 (!chargingStation.isConnectorAvailable(connectorId) && connectorId > 0) {
+ return OCPP16Constants.OCPP_RESERVATION_RESPONSE_REJECTED;
+ }
+ if (connectorId === 0 && !chargingStation.getReservationOnConnectorId0Enabled()) {
+ return OCPP16Constants.OCPP_RESERVATION_RESPONSE_REJECTED;
+ }
+ if (!(await OCPP16ServiceUtils.isIdTagAuthorized(chargingStation, connectorId, idTag))) {
+ return OCPP16Constants.OCPP_RESERVATION_RESPONSE_REJECTED;
+ }
+ 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:
- return Constants.OCPP_TRIGGER_MESSAGE_RESPONSE_NOT_IMPLEMENTED;
+ 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<OCPP16ReserveNowResponse>(
+ chargingStation,
+ OCPP16IncomingRequestCommand.RESERVE_NOW,
+ error as Error,
+ { errorResponse: OCPP16Constants.OCPP_RESERVATION_RESPONSE_FAULTED },
+ )!;
+ }
+ }
+
+ private async handleRequestCancelReservation(
+ chargingStation: ChargingStation,
+ commandPayload: OCPP16CancelReservationRequest,
+ ): Promise<GenericResponse> {
+ if (
+ !OCPP16ServiceUtils.checkFeatureProfile(
+ chargingStation,
+ OCPP16SupportedFeatureProfiles.Reservation,
+ OCPP16IncomingRequestCommand.CANCEL_RESERVATION,
+ )
+ ) {
+ return OCPP16Constants.OCPP_CANCEL_RESERVATION_RESPONSE_REJECTED;
+ }
+ try {
+ const { reservationId } = commandPayload;
+ const [exists, reservation] = chargingStation.doesReservationExists({ id: reservationId });
+ if (!exists) {
+ logger.error(
+ `${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(OCPP16IncomingRequestCommand.TRIGGER_MESSAGE, error, Constants.OCPP_TRIGGER_MESSAGE_RESPONSE_REJECTED);
+ return this.handleIncomingRequestError<GenericResponse>(
+ chargingStation,
+ OCPP16IncomingRequestCommand.CANCEL_RESERVATION,
+ error as Error,
+ { errorResponse: OCPP16Constants.OCPP_CANCEL_RESERVATION_RESPONSE_REJECTED },
+ )!;
}
}
}