-// 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 {
- ChangeAvailabilityRequest,
- ChangeConfigurationRequest,
- ClearChargingProfileRequest,
- DiagnosticsStatusNotificationRequest,
- GetConfigurationRequest,
- GetDiagnosticsRequest,
- MessageTrigger,
+ type ChargingStation,
+ ChargingStationConfigurationUtils,
+ ChargingStationUtils,
+} from '../../../charging-station';
+import { OCPPError } from '../../../exception';
+import {
+ type ChangeAvailabilityRequest,
+ type ChangeAvailabilityResponse,
+ type ChangeConfigurationRequest,
+ type ChangeConfigurationResponse,
+ type ClearChargingProfileRequest,
+ type ClearChargingProfileResponse,
+ ErrorType,
+ type GenericResponse,
+ GenericStatus,
+ type GetConfigurationRequest,
+ type GetConfigurationResponse,
+ type GetDiagnosticsRequest,
+ type GetDiagnosticsResponse,
+ type IncomingRequestHandler,
+ type JsonObject,
+ type JsonType,
+ OCPP16AuthorizationStatus,
+ type OCPP16AuthorizeRequest,
+ type OCPP16AuthorizeResponse,
OCPP16AvailabilityType,
- OCPP16BootNotificationRequest,
- OCPP16HeartbeatRequest,
+ type OCPP16BootNotificationRequest,
+ type OCPP16BootNotificationResponse,
+ OCPP16ChargePointErrorCode,
+ OCPP16ChargePointStatus,
+ type OCPP16ChargingProfile,
+ OCPP16ChargingProfilePurposeType,
+ type OCPP16ChargingSchedule,
+ type OCPP16ClearCacheRequest,
+ type OCPP16DataTransferRequest,
+ type OCPP16DataTransferResponse,
+ OCPP16DataTransferStatus,
+ OCPP16DataTransferVendorId,
+ OCPP16DiagnosticsStatus,
+ type OCPP16DiagnosticsStatusNotificationRequest,
+ type OCPP16DiagnosticsStatusNotificationResponse,
+ OCPP16FirmwareStatus,
+ type OCPP16FirmwareStatusNotificationRequest,
+ type OCPP16FirmwareStatusNotificationResponse,
+ type OCPP16GetCompositeScheduleRequest,
+ type OCPP16GetCompositeScheduleResponse,
+ 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 { OCPP16Constants, OCPP16ServiceUtils, OCPPIncomingRequestService } from '../internal';
const moduleName = 'OCPP16IncomingRequestService';
-export default class OCPP16IncomingRequestService extends OCPPIncomingRequestService {
+export class OCPP16IncomingRequestService extends OCPPIncomingRequestService {
+ protected jsonSchemas: Map<OCPP16IncomingRequestCommand, JSONSchemaType<JsonObject>>;
private incomingRequestHandlers: Map<OCPP16IncomingRequestCommand, IncomingRequestHandler>;
public constructor() {
- if (new.target?.name === moduleName) {
- throw new TypeError(`Cannot construct ${new.target?.name} instances directly`);
- }
- super();
+ // 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.CHANGE_CONFIGURATION,
this.handleRequestChangeConfiguration.bind(this),
],
+ [
+ OCPP16IncomingRequestCommand.GET_COMPOSITE_SCHEDULE,
+ this.handleRequestGetCompositeSchedule.bind(this),
+ ],
[
OCPP16IncomingRequestCommand.SET_CHARGING_PROFILE,
this.handleRequestSetChargingProfile.bind(this),
],
[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, 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'
+ ),
+ ],
]);
+ this.validatePayload = this.validatePayload.bind(this) as (
+ chargingStation: ChargingStation,
+ commandName: OCPP16IncomingRequestCommand,
+ commandPayload: JsonType
+ ) => boolean;
}
public async incomingRequestHandler(
): Promise<void> {
let response: JsonType;
if (
- chargingStation.getOcppStrictCompliance() &&
- 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 (
- chargingStation.isRegistered() ||
- (!chargingStation.getOcppStrictCompliance() && 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 {
+ this.validatePayload(chargingStation, commandName, commandPayload);
// Call the method to build the response
response = await this.incomingRequestHandlers.get(commandName)(
chargingStation,
);
} catch (error) {
// Log
- logger.error(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 response
);
}
+ 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
- ): DefaultResponse {
- // eslint-disable-next-line @typescript-eslint/no-misused-promises
- setImmediate(async (): Promise<void> => {
- await chargingStation.reset((commandPayload.type + 'Reset') as OCPP16StopTransactionReason);
- });
+ ): GenericResponse {
+ this.runInAsyncScope(
+ chargingStation.reset.bind(chargingStation) as (
+ this: ChargingStation,
+ ...args: any[]
+ ) => Promise<void>,
+ chargingStation,
+ `${commandPayload.type}Reset` as OCPP16StopTransactionReason
+ ).catch(Constants.EMPTY_FUNCTION);
logger.info(
`${chargingStation.logPrefix()} ${
commandPayload.type
chargingStation.stationInfo.resetTime
)}`
);
- return Constants.OCPP_RESPONSE_ACCEPTED;
- }
-
- private handleRequestClearCache(): DefaultResponse {
- return Constants.OCPP_RESPONSE_ACCEPTED;
+ return OCPP16Constants.OCPP_RESPONSE_ACCEPTED;
}
private async handleRequestUnlockConnector(
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(
- 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 OCPP16Constants.OCPP_RESPONSE_UNLOCK_NOT_SUPPORTED;
}
- if (chargingStation.getConnectorStatus(connectorId)?.transactionStarted) {
- const transactionId = chargingStation.getConnectorStatus(connectorId).transactionId;
- if (
- chargingStation.getBeginEndMeterValues() &&
- chargingStation.getOcppStrictCompliance() &&
- !chargingStation.getOutOfOrderEndMeterValues()
- ) {
- // FIXME: Implement OCPP version agnostic helpers
- const transactionEndMeterValue = OCPP16ServiceUtils.buildTransactionEndMeterValue(
- chargingStation,
- connectorId,
- chargingStation.getEnergyActiveImportRegisterByTransactionId(transactionId)
- );
- await chargingStation.ocppRequestService.requestHandler<
- OCPP16MeterValuesRequest,
- OCPP16MeterValuesResponse
- >(chargingStation, OCPP16RequestCommand.METER_VALUES, {
- connectorId,
- transactionId,
- meterValue: transactionEndMeterValue,
- });
- }
- const stopResponse = await chargingStation.ocppRequestService.requestHandler<
- OCPP16StopTransactionRequest,
- OCPP16StopTransactionResponse
- >(chargingStation, OCPP16RequestCommand.STOP_TRANSACTION, {
- transactionId,
- meterStop: chargingStation.getEnergyActiveImportRegisterByTransactionId(transactionId),
- idTag: 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 OCPP16Constants.OCPP_RESPONSE_UNLOCKED;
}
- return Constants.OCPP_RESPONSE_UNLOCK_FAILED;
+ return OCPP16Constants.OCPP_RESPONSE_UNLOCK_FAILED;
}
- await chargingStation.ocppRequestService.requestHandler<
- OCPP16StatusNotificationRequest,
- OCPP16StatusNotificationResponse
- >(chargingStation, OCPP16RequestCommand.STATUS_NOTIFICATION, {
+ await OCPP16ServiceUtils.sendAndSetConnectorStatus(
+ chargingStation,
connectorId,
- status: OCPP16ChargePointStatus.AVAILABLE,
- errorCode: OCPP16ChargePointErrorCode.NO_ERROR,
- });
- chargingStation.getConnectorStatus(connectorId).status = OCPP16ChargePointStatus.AVAILABLE;
- return Constants.OCPP_RESPONSE_UNLOCKED;
+ OCPP16ChargePointStatus.Available
+ );
+ return OCPP16Constants.OCPP_RESPONSE_UNLOCKED;
}
private handleRequestGetConfiguration(
): GetConfigurationResponse {
const configurationKey: OCPPConfigurationKey[] = [];
const unknownKey: string[] = [];
- if (Utils.isEmptyArray(commandPayload.key)) {
+ if (Utils.isUndefined(commandPayload.key) === true) {
for (const configuration of chargingStation.ocppConfiguration.configurationKey) {
- if (Utils.isUndefined(configuration.visible)) {
+ if (Utils.isUndefined(configuration.visible) === true) {
configuration.visible = true;
}
- if (!configuration.visible) {
+ if (configuration.visible === false) {
continue;
}
configurationKey.push({
value: configuration.value,
});
}
- } else {
+ } else if (Utils.isNotEmptyArray(commandPayload.key) === true) {
for (const key of commandPayload.key) {
- const keyFound = 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({
chargingStation: ChargingStation,
commandPayload: ChangeConfigurationRequest
): ChangeConfigurationResponse {
- // JSON request fields type sanity check
- if (!Utils.isString(commandPayload.key)) {
- logger.error(
- `${chargingStation.logPrefix()} ${
- OCPP16IncomingRequestCommand.CHANGE_CONFIGURATION
- } request key field is not a string:`,
- commandPayload
- );
- }
- if (!Utils.isString(commandPayload.value)) {
- logger.error(
- `${chargingStation.logPrefix()} ${
- OCPP16IncomingRequestCommand.CHANGE_CONFIGURATION
- } request value field is not a string:`,
- commandPayload
- );
- }
- const keyToChange = chargingStation.getConfigurationKey(commandPayload.key, true);
+ const keyToChange = ChargingStationConfigurationUtils.getConfigurationKey(
+ chargingStation,
+ commandPayload.key,
+ true
+ );
if (!keyToChange) {
- return Constants.OCPP_CONFIGURATION_RESPONSE_NOT_SUPPORTED;
+ return OCPP16Constants.OCPP_CONFIGURATION_RESPONSE_NOT_SUPPORTED;
} else if (keyToChange && keyToChange.readonly) {
- return Constants.OCPP_CONFIGURATION_RESPONSE_REJECTED;
+ return OCPP16Constants.OCPP_CONFIGURATION_RESPONSE_REJECTED;
} else if (keyToChange && !keyToChange.readonly) {
let valueChanged = false;
if (keyToChange.value !== commandPayload.value) {
- chargingStation.setConfigurationKeyValue(commandPayload.key, commandPayload.value, true);
+ ChargingStationConfigurationUtils.setConfigurationKeyValue(
+ chargingStation,
+ commandPayload.key,
+ commandPayload.value,
+ true
+ );
valueChanged = true;
}
let triggerHeartbeatRestart = false;
if (keyToChange.key === OCPP16StandardParametersKey.HeartBeatInterval && valueChanged) {
- chargingStation.setConfigurationKeyValue(
+ ChargingStationConfigurationUtils.setConfigurationKeyValue(
+ chargingStation,
OCPP16StandardParametersKey.HeartbeatInterval,
commandPayload.value
);
triggerHeartbeatRestart = true;
}
if (keyToChange.key === OCPP16StandardParametersKey.HeartbeatInterval && valueChanged) {
- chargingStation.setConfigurationKeyValue(
+ ChargingStationConfigurationUtils.setConfigurationKeyValue(
+ chargingStation,
OCPP16StandardParametersKey.HeartBeatInterval,
commandPayload.value
);
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;
}
}
commandPayload: SetChargingProfileRequest
): SetChargingProfileResponse {
if (
- !OCPP16ServiceUtils.checkFeatureProfile(
+ OCPP16ServiceUtils.checkFeatureProfile(
chargingStation,
OCPP16SupportedFeatureProfiles.SmartCharging,
OCPP16IncomingRequestCommand.SET_CHARGING_PROFILE
- )
+ ) === false
) {
- return Constants.OCPP_SET_CHARGING_PROFILE_RESPONSE_NOT_SUPPORTED;
+ return OCPP16Constants.OCPP_SET_CHARGING_PROFILE_RESPONSE_NOT_SUPPORTED;
}
- if (!chargingStation.getConnectorStatus(commandPayload.connectorId)) {
+ if (chargingStation.hasConnector(commandPayload.connectorId) === false) {
logger.error(
- `${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 OCPP16Constants.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 OCPP16Constants.OCPP_SET_CHARGING_PROFILE_RESPONSE_REJECTED;
}
if (
commandPayload.csChargingProfiles.chargingProfilePurpose ===
- ChargingProfilePurposeType.TX_PROFILE &&
+ OCPP16ChargingProfilePurposeType.TX_PROFILE &&
(commandPayload.connectorId === 0 ||
- !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 OCPP16Constants.OCPP_SET_CHARGING_PROFILE_RESPONSE_REJECTED;
}
- chargingStation.setChargingProfile(
+ OCPP16ServiceUtils.setChargingProfile(
+ chargingStation,
commandPayload.connectorId,
commandPayload.csChargingProfiles
);
logger.debug(
`${chargingStation.logPrefix()} Charging profile(s) set on connector id ${
commandPayload.connectorId
- }, dump their stack: %j`,
- chargingStation.getConnectorStatus(commandPayload.connectorId).chargingProfiles
+ }: %j`,
+ commandPayload.csChargingProfiles
);
- return Constants.OCPP_SET_CHARGING_PROFILE_RESPONSE_ACCEPTED;
+ return OCPP16Constants.OCPP_SET_CHARGING_PROFILE_RESPONSE_ACCEPTED;
+ }
+
+ private handleRequestGetCompositeSchedule(
+ chargingStation: ChargingStation,
+ commandPayload: OCPP16GetCompositeScheduleRequest
+ ): OCPP16GetCompositeScheduleResponse {
+ if (
+ OCPP16ServiceUtils.checkFeatureProfile(
+ chargingStation,
+ OCPP16SupportedFeatureProfiles.SmartCharging,
+ OCPP16IncomingRequestCommand.CLEAR_CHARGING_PROFILE
+ ) === false
+ ) {
+ return OCPP16Constants.OCPP_RESPONSE_REJECTED;
+ }
+ 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 (
+ Utils.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;
+ 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(
commandPayload: ClearChargingProfileRequest
): ClearChargingProfileResponse {
if (
- !OCPP16ServiceUtils.checkFeatureProfile(
+ OCPP16ServiceUtils.checkFeatureProfile(
chargingStation,
OCPP16SupportedFeatureProfiles.SmartCharging,
OCPP16IncomingRequestCommand.CLEAR_CHARGING_PROFILE
- )
+ ) === false
) {
- return Constants.OCPP_CLEAR_CHARGING_PROFILE_RESPONSE_UNKNOWN;
+ return OCPP16Constants.OCPP_CLEAR_CHARGING_PROFILE_RESPONSE_UNKNOWN;
}
- const connectorStatus = chargingStation.getConnectorStatus(commandPayload.connectorId);
- if (!connectorStatus) {
+ if (chargingStation.hasConnector(commandPayload.connectorId) === false) {
logger.error(
- `${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 OCPP16Constants.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(
`${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 OCPP16Constants.OCPP_CLEAR_CHARGING_PROFILE_RESPONSE_ACCEPTED;
}
- if (!commandPayload.connectorId) {
+ if (Utils.isNullOrUndefined(commandPayload.connectorId)) {
let clearedCP = false;
for (const connectorId of chargingStation.connectors.keys()) {
- if (!Utils.isEmptyArray(chargingStation.getConnectorStatus(connectorId).chargingProfiles)) {
+ if (
+ Utils.isNotEmptyArray(chargingStation.getConnectorStatus(connectorId)?.chargingProfiles)
+ ) {
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;
clearCurrentCP = true;
}
if (clearCurrentCP) {
- connectorStatus.chargingProfiles[index] = {} as OCPP16ChargingProfile;
+ connectorStatus?.chargingProfiles?.splice(index, 1);
logger.debug(
- `${chargingStation.logPrefix()} Matching charging profile(s) cleared on connector id ${
- commandPayload.connectorId
- }, dump their stack: %j`,
- connectorStatus.chargingProfiles
+ `${chargingStation.logPrefix()} Matching charging profile(s) cleared: %j`,
+ chargingProfile
);
clearedCP = true;
}
}
}
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> {
const connectorId: number = commandPayload.connectorId;
- if (!chargingStation.getConnectorStatus(connectorId)) {
+ if (chargingStation.hasConnector(connectorId) === false) {
logger.error(
- `${chargingStation.logPrefix()} Trying to change the availability of a non existing connector Id ${connectorId.toString()}`
+ `${chargingStation.logPrefix()} Trying to change the availability of a non existing connector id ${connectorId.toString()}`
);
- return Constants.OCPP_AVAILABILITY_RESPONSE_REJECTED;
+ return OCPP16Constants.OCPP_AVAILABILITY_RESPONSE_REJECTED;
}
const chargePointStatus: OCPP16ChargePointStatus =
- commandPayload.type === OCPP16AvailabilityType.OPERATIVE
- ? OCPP16ChargePointStatus.AVAILABLE
- : OCPP16ChargePointStatus.UNAVAILABLE;
+ commandPayload.type === OCPP16AvailabilityType.Operative
+ ? OCPP16ChargePointStatus.Available
+ : OCPP16ChargePointStatus.Unavailable;
if (connectorId === 0) {
- let response: ChangeAvailabilityResponse = Constants.OCPP_AVAILABILITY_RESPONSE_ACCEPTED;
+ let response: ChangeAvailabilityResponse =
+ OCPP16Constants.OCPP_AVAILABILITY_RESPONSE_ACCEPTED;
for (const id of chargingStation.connectors.keys()) {
- if (chargingStation.getConnectorStatus(id)?.transactionStarted) {
- response = Constants.OCPP_AVAILABILITY_RESPONSE_SCHEDULED;
+ if (chargingStation.getConnectorStatus(id)?.transactionStarted === true) {
+ response = OCPP16Constants.OCPP_AVAILABILITY_RESPONSE_SCHEDULED;
}
chargingStation.getConnectorStatus(id).availability = commandPayload.type;
- if (response === Constants.OCPP_AVAILABILITY_RESPONSE_ACCEPTED) {
- await chargingStation.ocppRequestService.requestHandler<
- OCPP16StatusNotificationRequest,
- OCPP16StatusNotificationResponse
- >(chargingStation, OCPP16RequestCommand.STATUS_NOTIFICATION, {
- connectorId: id,
- status: chargePointStatus,
- errorCode: OCPP16ChargePointErrorCode.NO_ERROR,
- });
- chargingStation.getConnectorStatus(id).status = chargePointStatus;
+ if (response === OCPP16Constants.OCPP_AVAILABILITY_RESPONSE_ACCEPTED) {
+ await OCPP16ServiceUtils.sendAndSetConnectorStatus(
+ chargingStation,
+ id,
+ chargePointStatus
+ );
}
}
return response;
} else if (
connectorId > 0 &&
- (chargingStation.getConnectorStatus(0).availability === OCPP16AvailabilityType.OPERATIVE ||
- (chargingStation.getConnectorStatus(0).availability ===
- OCPP16AvailabilityType.INOPERATIVE &&
- commandPayload.type === OCPP16AvailabilityType.INOPERATIVE))
+ (chargingStation.isChargingStationAvailable() === true ||
+ (chargingStation.isChargingStationAvailable() === false &&
+ commandPayload.type === OCPP16AvailabilityType.Inoperative))
) {
- if (chargingStation.getConnectorStatus(connectorId)?.transactionStarted) {
+ if (chargingStation.getConnectorStatus(connectorId)?.transactionStarted === true) {
chargingStation.getConnectorStatus(connectorId).availability = commandPayload.type;
- return Constants.OCPP_AVAILABILITY_RESPONSE_SCHEDULED;
+ return OCPP16Constants.OCPP_AVAILABILITY_RESPONSE_SCHEDULED;
}
chargingStation.getConnectorStatus(connectorId).availability = commandPayload.type;
- await chargingStation.ocppRequestService.requestHandler<
- OCPP16StatusNotificationRequest,
- OCPP16StatusNotificationResponse
- >(chargingStation, OCPP16RequestCommand.STATUS_NOTIFICATION, {
+ await OCPP16ServiceUtils.sendAndSetConnectorStatus(
+ chargingStation,
connectorId,
- status: chargePointStatus,
- errorCode: OCPP16ChargePointErrorCode.NO_ERROR,
- });
- chargingStation.getConnectorStatus(connectorId).status = chargePointStatus;
- return Constants.OCPP_AVAILABILITY_RESPONSE_ACCEPTED;
+ chargePointStatus
+ );
+ return OCPP16Constants.OCPP_AVAILABILITY_RESPONSE_ACCEPTED;
}
- return Constants.OCPP_AVAILABILITY_RESPONSE_REJECTED;
+ return OCPP16Constants.OCPP_AVAILABILITY_RESPONSE_REJECTED;
}
private async handleRequestRemoteStartTransaction(
chargingStation: ChargingStation,
commandPayload: RemoteStartTransactionRequest
- ): Promise<DefaultResponse> {
+ ): Promise<GenericResponse> {
const transactionConnectorId = commandPayload.connectorId;
- const connectorStatus = chargingStation.getConnectorStatus(transactionConnectorId);
- if (transactionConnectorId) {
- await chargingStation.ocppRequestService.requestHandler<
- OCPP16StatusNotificationRequest,
- OCPP16StatusNotificationResponse
- >(chargingStation, OCPP16RequestCommand.STATUS_NOTIFICATION, {
- connectorId: transactionConnectorId,
- status: OCPP16ChargePointStatus.PREPARING,
- errorCode: OCPP16ChargePointErrorCode.NO_ERROR,
- });
- connectorStatus.status = OCPP16ChargePointStatus.PREPARING;
- if (chargingStation.isChargingStationAvailable() && connectorStatus) {
+ if (chargingStation.hasConnector(transactionConnectorId) === true) {
+ const remoteStartTransactionLogMsg = `${chargingStation.logPrefix()} Transaction remotely STARTED on ${
+ chargingStation.stationInfo.chargingStationId
+ }#${transactionConnectorId.toString()} for idTag '${commandPayload.idTag}'`;
+ await OCPP16ServiceUtils.sendAndSetConnectorStatus(
+ chargingStation,
+ transactionConnectorId,
+ OCPP16ChargePointStatus.Preparing
+ );
+ const connectorStatus = chargingStation.getConnectorStatus(transactionConnectorId);
+ if (
+ chargingStation.isChargingStationAvailable() === true &&
+ chargingStation.isConnectorAvailable(transactionConnectorId) === true
+ ) {
// Check if authorized
- if (chargingStation.getAuthorizeRemoteTxRequests()) {
+ if (chargingStation.getAuthorizeRemoteTxRequests() === true) {
let authorized = false;
if (
- chargingStation.getLocalAuthListEnabled() &&
- chargingStation.hasAuthorizedTags() &&
- chargingStation.authorizedTags.find((value) => value === commandPayload.idTag)
+ chargingStation.getLocalAuthListEnabled() === true &&
+ chargingStation.hasIdTags() === true &&
+ Utils.isNotEmptyString(
+ chargingStation.idTagsCache
+ .getIdTags(ChargingStationUtils.getIdTagsFile(chargingStation.stationInfo))
+ ?.find((idTag) => idTag === commandPayload.idTag)
+ )
) {
connectorStatus.localAuthorizeIdTag = commandPayload.idTag;
connectorStatus.idTagLocalAuthorized = true;
authorized = true;
- } else if (chargingStation.getMayAuthorizeAtRemoteStart()) {
+ } else if (chargingStation.getMustAuthorizeAtRemoteStart() === true) {
connectorStatus.authorizeIdTag = commandPayload.idTag;
const authorizeResponse: OCPP16AuthorizeResponse =
await chargingStation.ocppRequestService.requestHandler<
`${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 (
})
).idTagInfo.status === OCPP16AuthorizationStatus.ACCEPTED
) {
- logger.debug(
- chargingStation.logPrefix() +
- ' Transaction remotely STARTED on ' +
- chargingStation.stationInfo.chargingStationId +
- '#' +
- transactionConnectorId.toString() +
- ' for idTag ' +
- commandPayload.idTag
- );
- return Constants.OCPP_RESPONSE_ACCEPTED;
+ logger.debug(remoteStartTransactionLogMsg);
+ return OCPP16Constants.OCPP_RESPONSE_ACCEPTED;
}
return this.notifyRemoteStartTransactionRejected(
chargingStation,
chargingStation,
transactionConnectorId,
commandPayload.chargingProfile
- )
+ ) === true
) {
connectorStatus.transactionRemoteStarted = true;
if (
})
).idTagInfo.status === OCPP16AuthorizationStatus.ACCEPTED
) {
- logger.debug(
- chargingStation.logPrefix() +
- ' Transaction remotely STARTED on ' +
- chargingStation.stationInfo.chargingStationId +
- '#' +
- transactionConnectorId.toString() +
- ' for idTag ' +
- commandPayload.idTag
- );
- return Constants.OCPP_RESPONSE_ACCEPTED;
+ logger.debug(remoteStartTransactionLogMsg);
+ return OCPP16Constants.OCPP_RESPONSE_ACCEPTED;
}
return this.notifyRemoteStartTransactionRejected(
chargingStation,
chargingStation: ChargingStation,
connectorId: number,
idTag: string
- ): Promise<DefaultResponse> {
+ ): Promise<GenericResponse> {
if (
- chargingStation.getConnectorStatus(connectorId).status !== OCPP16ChargePointStatus.AVAILABLE
+ chargingStation.getConnectorStatus(connectorId)?.status !== OCPP16ChargePointStatus.Available
) {
- await chargingStation.ocppRequestService.requestHandler<
- OCPP16StatusNotificationRequest,
- OCPP16StatusNotificationResponse
- >(chargingStation, OCPP16RequestCommand.STATUS_NOTIFICATION, {
+ await OCPP16ServiceUtils.sendAndSetConnectorStatus(
+ chargingStation,
connectorId,
- status: OCPP16ChargePointStatus.AVAILABLE,
- errorCode: OCPP16ChargePointErrorCode.NO_ERROR,
- });
- chargingStation.getConnectorStatus(connectorId).status = OCPP16ChargePointStatus.AVAILABLE;
+ OCPP16ChargePointStatus.Available
+ );
}
logger.warn(
- chargingStation.logPrefix() +
- ' Remote starting transaction REJECTED on connector Id ' +
- connectorId.toString() +
- ', idTag ' +
- idTag +
- ', availability ' +
- chargingStation.getConnectorStatus(connectorId).availability +
- ', status ' +
- chargingStation.getConnectorStatus(connectorId).status
+ `${chargingStation.logPrefix()} Remote starting transaction REJECTED on connector id ${connectorId.toString()}, idTag '${idTag}', availability '${
+ chargingStation.getConnectorStatus(connectorId)?.availability
+ }', status '${chargingStation.getConnectorStatus(connectorId)?.status}'`
);
- return Constants.OCPP_RESPONSE_REJECTED;
+ return OCPP16Constants.OCPP_RESPONSE_REJECTED;
}
private setRemoteStartTransactionChargingProfile(
connectorId: number,
cp: OCPP16ChargingProfile
): boolean {
- if (cp && cp.chargingProfilePurpose === ChargingProfilePurposeType.TX_PROFILE) {
- chargingStation.setChargingProfile(connectorId, cp);
+ 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}, dump their stack: %j`,
- chargingStation.getConnectorStatus(connectorId).chargingProfiles
+ `${chargingStation.logPrefix()} Charging profile(s) set at remote start transaction on connector id ${connectorId}: %j`,
+ cp
);
return true;
- } else if (cp && cp.chargingProfilePurpose !== ChargingProfilePurposeType.TX_PROFILE) {
+ } else if (cp && cp.chargingProfilePurpose !== OCPP16ChargingProfilePurposeType.TX_PROFILE) {
logger.warn(
`${chargingStation.logPrefix()} Not allowed to set ${
cp.chargingProfilePurpose
private async handleRequestRemoteStopTransaction(
chargingStation: ChargingStation,
commandPayload: RemoteStopTransactionRequest
- ): Promise<DefaultResponse> {
+ ): Promise<GenericResponse> {
const transactionId = commandPayload.transactionId;
for (const connectorId of chargingStation.connectors.keys()) {
if (
connectorId > 0 &&
chargingStation.getConnectorStatus(connectorId)?.transactionId === transactionId
) {
- await chargingStation.ocppRequestService.requestHandler<
- OCPP16StatusNotificationRequest,
- OCPP16StatusNotificationResponse
- >(chargingStation, OCPP16RequestCommand.STATUS_NOTIFICATION, {
+ await OCPP16ServiceUtils.sendAndSetConnectorStatus(
+ chargingStation,
connectorId,
- status: OCPP16ChargePointStatus.FINISHING,
- errorCode: OCPP16ChargePointErrorCode.NO_ERROR,
- });
- chargingStation.getConnectorStatus(connectorId).status = OCPP16ChargePointStatus.FINISHING;
+ 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;
+ }
+ }
+ logger.warn(
+ `${chargingStation.logPrefix()} Trying to remote stop a non existing transaction with id: ${transactionId.toString()}`
+ );
+ return OCPP16Constants.OCPP_RESPONSE_REJECTED;
+ }
+
+ private handleRequestUpdateFirmware(
+ chargingStation: ChargingStation,
+ commandPayload: OCPP16UpdateFirmwareRequest
+ ): OCPP16UpdateFirmwareResponse {
+ if (
+ OCPP16ServiceUtils.checkFeatureProfile(
+ chargingStation,
+ OCPP16SupportedFeatureProfiles.FirmwareManagement,
+ OCPP16IncomingRequestCommand.UPDATE_FIRMWARE
+ ) === false
+ ) {
+ logger.warn(
+ `${chargingStation.logPrefix()} ${moduleName}.handleRequestUpdateFirmware: Cannot simulate firmware update: feature profile not supported`
+ );
+ return OCPP16Constants.OCPP_RESPONSE_EMPTY;
+ }
+ 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 OCPP16Constants.OCPP_RESPONSE_EMPTY;
+ }
+ const retrieveDate = Utils.convertToDate(commandPayload.retrieveDate);
+ const now = Date.now();
+ if (retrieveDate?.getTime() <= now) {
+ this.runInAsyncScope(
+ this.updateFirmwareSimulation.bind(this) as (
+ this: OCPP16IncomingRequestService,
+ ...args: any[]
+ ) => Promise<void>,
+ this,
+ chargingStation
+ ).catch(Constants.EMPTY_FUNCTION);
+ } else {
+ setTimeout(() => {
+ this.updateFirmwareSimulation(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 (
+ ChargingStationUtils.checkChargingStation(chargingStation, chargingStation.logPrefix()) ===
+ false
+ ) {
+ return;
+ }
+ 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 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;
+ let wasTransactionsStarted = false;
+ let transactionsStarted: boolean;
+ do {
+ let trxCount = 0;
+ for (const connectorId of chargingStation.connectors.keys()) {
if (
- chargingStation.getBeginEndMeterValues() &&
- chargingStation.getOcppStrictCompliance() &&
- !chargingStation.getOutOfOrderEndMeterValues()
+ connectorId > 0 &&
+ chargingStation.getConnectorStatus(connectorId)?.transactionStarted === true
) {
- // FIXME: Implement OCPP version agnostic helpers
- const transactionEndMeterValue = OCPP16ServiceUtils.buildTransactionEndMeterValue(
- chargingStation,
- connectorId,
- chargingStation.getEnergyActiveImportRegisterByTransactionId(transactionId)
- );
- await chargingStation.ocppRequestService.requestHandler<
- OCPP16MeterValuesRequest,
- OCPP16MeterValuesResponse
- >(chargingStation, OCPP16RequestCommand.METER_VALUES, {
- connectorId,
- transactionId,
- meterValue: transactionEndMeterValue,
- });
+ trxCount++;
}
- await chargingStation.ocppRequestService.requestHandler<
- OCPP16StopTransactionRequest,
- OCPP16StopTransactionResponse
- >(chargingStation, OCPP16RequestCommand.STOP_TRANSACTION, {
- transactionId,
- meterStop: chargingStation.getEnergyActiveImportRegisterByTransactionId(transactionId),
- idTag: chargingStation.getTransactionIdTag(transactionId),
- });
- return Constants.OCPP_RESPONSE_ACCEPTED;
}
+ if (trxCount > 0) {
+ const waitTime = 15 * 1000;
+ logger.debug(
+ `${chargingStation.logPrefix()} ${moduleName}.updateFirmwareSimulation: ${trxCount} transaction(s) in progress, waiting ${
+ waitTime / 1000
+ } seconds before continuing firmware update simulation`
+ );
+ await Utils.sleep(waitTime);
+ transactionsStarted = true;
+ wasTransactionsStarted = true;
+ } 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 Utils.sleep(Utils.getRandomInteger(maxDelay, minDelay) * 1000));
+ if (
+ ChargingStationUtils.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 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);
}
- logger.info(
- chargingStation.logPrefix() +
- ' Trying to remote stop a non existing transaction ' +
- transactionId.toString()
- );
- return Constants.OCPP_RESPONSE_REJECTED;
}
private async handleRequestGetDiagnostics(
commandPayload: GetDiagnosticsRequest
): Promise<GetDiagnosticsResponse> {
if (
- !OCPP16ServiceUtils.checkFeatureProfile(
+ 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 OCPP16Constants.OCPP_RESPONSE_EMPTY;
}
- logger.debug(
- 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 = 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(
`${chargingStation.logPrefix()} ${
info.bytes / 1024
} bytes transferred from diagnostics archive ${info.name}`
);
- await chargingStation.ocppRequestService.requestHandler<
- DiagnosticsStatusNotificationRequest,
- DiagnosticsStatusNotificationResponse
- >(chargingStation, OCPP16RequestCommand.DIAGNOSTICS_STATUS_NOTIFICATION, {
- status: OCPP16DiagnosticsStatus.Uploading,
- });
+ chargingStation.ocppRequestService
+ .requestHandler<
+ OCPP16DiagnosticsStatusNotificationRequest,
+ OCPP16DiagnosticsStatusNotificationResponse
+ >(chargingStation, OCPP16RequestCommand.DIAGNOSTICS_STATUS_NOTIFICATION, {
+ status: OCPP16DiagnosticsStatus.Uploading,
+ })
+ .catch((error) => {
+ logger.error(
+ `${chargingStation.logPrefix()} ${moduleName}.handleRequestGetDiagnostics: Error while sending '${
+ OCPP16RequestCommand.DIAGNOSTICS_STATUS_NOTIFICATION
+ }'`,
+ error
+ );
+ });
});
uploadResponse = await ftpClient.uploadFrom(
- path.join(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 chargingStation.ocppRequestService.requestHandler<
- DiagnosticsStatusNotificationRequest,
- DiagnosticsStatusNotificationResponse
+ OCPP16DiagnosticsStatusNotificationRequest,
+ OCPP16DiagnosticsStatusNotificationResponse
>(chargingStation, OCPP16RequestCommand.DIAGNOSTICS_STATUS_NOTIFICATION, {
status: OCPP16DiagnosticsStatus.Uploaded,
});
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
);
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 chargingStation.ocppRequestService.requestHandler<
- DiagnosticsStatusNotificationRequest,
- DiagnosticsStatusNotificationResponse
+ OCPP16DiagnosticsStatusNotificationRequest,
+ OCPP16DiagnosticsStatusNotificationResponse
>(chargingStation, OCPP16RequestCommand.DIAGNOSTICS_STATUS_NOTIFICATION, {
status: OCPP16DiagnosticsStatus.UploadFailed,
});
chargingStation,
OCPP16IncomingRequestCommand.GET_DIAGNOSTICS,
error as Error,
- { errorResponse: Constants.OCPP_RESPONSE_EMPTY }
+ { errorResponse: OCPP16Constants.OCPP_RESPONSE_EMPTY }
);
}
} else {
} to transfer the diagnostic logs archive`
);
await chargingStation.ocppRequestService.requestHandler<
- DiagnosticsStatusNotificationRequest,
- DiagnosticsStatusNotificationResponse
+ OCPP16DiagnosticsStatusNotificationRequest,
+ OCPP16DiagnosticsStatusNotificationResponse
>(chargingStation, OCPP16RequestCommand.DIAGNOSTICS_STATUS_NOTIFICATION, {
status: OCPP16DiagnosticsStatus.UploadFailed,
});
- return Constants.OCPP_RESPONSE_EMPTY;
+ return OCPP16Constants.OCPP_RESPONSE_EMPTY;
}
}
chargingStation,
OCPP16SupportedFeatureProfiles.RemoteTrigger,
OCPP16IncomingRequestCommand.TRIGGER_MESSAGE
+ ) ||
+ !OCPP16ServiceUtils.isMessageTriggerSupported(
+ chargingStation,
+ commandPayload.requestedMessage
)
) {
- return Constants.OCPP_TRIGGER_MESSAGE_RESPONSE_NOT_IMPLEMENTED;
+ return OCPP16Constants.OCPP_TRIGGER_MESSAGE_RESPONSE_NOT_IMPLEMENTED;
}
- // TODO: factor out the check on connector id
- if (commandPayload?.connectorId < 0) {
- logger.warn(
- `${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 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,
- {
- chargePointModel: chargingStation.getBootNotificationRequest().chargePointModel,
- chargePointVendor: chargingStation.getBootNotificationRequest().chargePointVendor,
- chargeBoxSerialNumber:
- chargingStation.getBootNotificationRequest().chargeBoxSerialNumber,
- firmwareVersion: chargingStation.getBootNotificationRequest().firmwareVersion,
- chargePointSerialNumber:
- chargingStation.getBootNotificationRequest().chargePointSerialNumber,
- iccid: chargingStation.getBootNotificationRequest().iccid,
- imsi: chargingStation.getBootNotificationRequest().imsi,
- meterSerialNumber: chargingStation.getBootNotificationRequest().meterSerialNumber,
- meterType: chargingStation.getBootNotificationRequest().meterType,
- },
+ chargingStation.bootNotificationRequest,
{ skipBufferingOnError: true, triggerMessage: true }
)
- .then((value) => {
- chargingStation.bootNotificationResponse = value;
+ .then((response) => {
+ chargingStation.bootNotificationResponse = response;
})
- .catch(() => {
- /* This is intentional */
- });
- }, Constants.OCPP_TRIGGER_MESSAGE_DELAY);
- return Constants.OCPP_TRIGGER_MESSAGE_RESPONSE_ACCEPTED;
- case MessageTrigger.Heartbeat:
+ .catch(Constants.EMPTY_FUNCTION);
+ }, OCPP16Constants.OCPP_TRIGGER_MESSAGE_DELAY);
+ return OCPP16Constants.OCPP_TRIGGER_MESSAGE_RESPONSE_ACCEPTED;
+ case OCPP16MessageTrigger.Heartbeat:
setTimeout(() => {
chargingStation.ocppRequestService
.requestHandler<OCPP16HeartbeatRequest, OCPP16HeartbeatResponse>(
triggerMessage: true,
}
)
- .catch(() => {
- /* This is intentional */
- });
- }, Constants.OCPP_TRIGGER_MESSAGE_DELAY);
- return Constants.OCPP_TRIGGER_MESSAGE_RESPONSE_ACCEPTED;
- case MessageTrigger.StatusNotification:
+ .catch(Constants.EMPTY_FUNCTION);
+ }, OCPP16Constants.OCPP_TRIGGER_MESSAGE_DELAY);
+ return OCPP16Constants.OCPP_TRIGGER_MESSAGE_RESPONSE_ACCEPTED;
+ case OCPP16MessageTrigger.StatusNotification:
setTimeout(() => {
- if (commandPayload?.connectorId) {
+ if (!Utils.isNullOrUndefined(commandPayload?.connectorId)) {
chargingStation.ocppRequestService
.requestHandler<OCPP16StatusNotificationRequest, OCPP16StatusNotificationResponse>(
chargingStation,
{
connectorId: commandPayload.connectorId,
errorCode: OCPP16ChargePointErrorCode.NO_ERROR,
- status: 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 chargingStation.connectors.keys()) {
chargingStation.ocppRequestService
{
connectorId,
errorCode: OCPP16ChargePointErrorCode.NO_ERROR,
- status: 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;
+ }, OCPP16Constants.OCPP_TRIGGER_MESSAGE_DELAY);
+ return OCPP16Constants.OCPP_TRIGGER_MESSAGE_RESPONSE_ACCEPTED;
default:
- return Constants.OCPP_TRIGGER_MESSAGE_RESPONSE_NOT_IMPLEMENTED;
+ return OCPP16Constants.OCPP_TRIGGER_MESSAGE_RESPONSE_NOT_IMPLEMENTED;
}
} catch (error) {
return this.handleIncomingRequestError(
chargingStation,
OCPP16IncomingRequestCommand.TRIGGER_MESSAGE,
error as Error,
- { errorResponse: Constants.OCPP_TRIGGER_MESSAGE_RESPONSE_REJECTED }
+ { errorResponse: OCPP16Constants.OCPP_TRIGGER_MESSAGE_RESPONSE_REJECTED }
+ );
+ }
+ }
+
+ private handleRequestDataTransfer(
+ chargingStation: ChargingStation,
+ commandPayload: OCPP16DataTransferRequest
+ ): OCPP16DataTransferResponse {
+ 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: OCPP16Constants.OCPP_DATA_TRANSFER_RESPONSE_REJECTED }
);
}
}
repositories / e-mobility-charging-stations-simulator.git / blobdiff