import { Client, type FTPResponse } from 'basic-ftp';
import tar from 'tar';
+import { OCPP16ServiceUtils } from './OCPP16ServiceUtils';
import OCPPError from '../../../exception/OCPPError';
import type { JsonObject, JsonType } from '../../../types/JsonType';
import { OCPP16ChargePointErrorCode } from '../../../types/ocpp/1.6/ChargePointErrorCode';
type ChangeAvailabilityRequest,
type ChangeConfigurationRequest,
type ClearChargingProfileRequest,
- type DiagnosticsStatusNotificationRequest,
type GetConfigurationRequest,
type GetDiagnosticsRequest,
OCPP16AvailabilityType,
type OCPP16ClearCacheRequest,
type OCPP16DataTransferRequest,
OCPP16DataTransferVendorId,
+ type OCPP16DiagnosticsStatusNotificationRequest,
+ OCPP16FirmwareStatus,
+ type OCPP16FirmwareStatusNotificationRequest,
type OCPP16HeartbeatRequest,
OCPP16IncomingRequestCommand,
OCPP16MessageTrigger,
type ChangeAvailabilityResponse,
type ChangeConfigurationResponse,
type ClearChargingProfileResponse,
- type DiagnosticsStatusNotificationResponse,
type GetConfigurationResponse,
type GetDiagnosticsResponse,
type OCPP16BootNotificationResponse,
type OCPP16DataTransferResponse,
OCPP16DataTransferStatus,
+ type OCPP16DiagnosticsStatusNotificationResponse,
+ type OCPP16FirmwareStatusNotificationResponse,
type OCPP16HeartbeatResponse,
type OCPP16StatusNotificationResponse,
type OCPP16TriggerMessageResponse,
} from '../../../types/ocpp/1.6/Transaction';
import type { OCPPConfigurationKey } from '../../../types/ocpp/Configuration';
import { ErrorType } from '../../../types/ocpp/ErrorType';
+import { OCPPVersion } from '../../../types/ocpp/OCPPVersion';
import type { IncomingRequestHandler } from '../../../types/ocpp/Requests';
-import type { DefaultResponse } from '../../../types/ocpp/Responses';
+import type { GenericResponse } from '../../../types/ocpp/Responses';
import Constants from '../../../utils/Constants';
import logger from '../../../utils/Logger';
import Utils from '../../../utils/Utils';
import type ChargingStation from '../../ChargingStation';
import { ChargingStationConfigurationUtils } from '../../ChargingStationConfigurationUtils';
import { ChargingStationUtils } from '../../ChargingStationUtils';
+import OCPPConstants from '../OCPPConstants';
import OCPPIncomingRequestService from '../OCPPIncomingRequestService';
-import { OCPP16ServiceUtils } from './OCPP16ServiceUtils';
const moduleName = 'OCPP16IncomingRequestService';
export default class OCPP16IncomingRequestService extends OCPPIncomingRequestService {
+ protected jsonSchemas: Map<OCPP16IncomingRequestCommand, JSONSchemaType<JsonObject>>;
private incomingRequestHandlers: Map<OCPP16IncomingRequestCommand, IncomingRequestHandler>;
- private jsonSchemas: Map<OCPP16IncomingRequestCommand, JSONSchemaType<JsonObject>>;
public constructor() {
if (new.target?.name === moduleName) {
throw new TypeError(`Cannot construct ${new.target?.name} instances directly`);
}
- super();
+ super(OCPPVersion.VERSION_16);
this.incomingRequestHandlers = new Map<OCPP16IncomingRequestCommand, IncomingRequestHandler>([
[OCPP16IncomingRequestCommand.RESET, this.handleRequestReset.bind(this)],
[OCPP16IncomingRequestCommand.CLEAR_CACHE, this.handleRequestClearCache.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)],
+ [OCPP16IncomingRequestCommand.UPDATE_FIRMWARE, this.handleRequestUpdateFirmware.bind(this)],
]);
this.jsonSchemas = new Map<OCPP16IncomingRequestCommand, JSONSchemaType<JsonObject>>([
[
OCPP16IncomingRequestCommand.RESET,
- JSON.parse(
- fs.readFileSync(
- path.resolve(
- path.dirname(fileURLToPath(import.meta.url)),
- '../../../assets/json-schemas/ocpp/1.6/Reset.json'
- ),
- 'utf8'
- )
- ) as JSONSchemaType<ResetRequest>,
+ this.parseJsonSchemaFile<ResetRequest>('../../../assets/json-schemas/ocpp/1.6/Reset.json'),
],
[
OCPP16IncomingRequestCommand.CLEAR_CACHE,
- JSON.parse(
- fs.readFileSync(
- path.resolve(
- path.dirname(fileURLToPath(import.meta.url)),
- '../../../assets/json-schemas/ocpp/1.6/ClearCache.json'
- ),
- 'utf8'
- )
- ) as JSONSchemaType<OCPP16ClearCacheRequest>,
+ this.parseJsonSchemaFile<OCPP16ClearCacheRequest>(
+ '../../../assets/json-schemas/ocpp/1.6/ClearCache.json'
+ ),
],
[
OCPP16IncomingRequestCommand.UNLOCK_CONNECTOR,
- JSON.parse(
- fs.readFileSync(
- path.resolve(
- path.dirname(fileURLToPath(import.meta.url)),
- '../../../assets/json-schemas/ocpp/1.6/UnlockConnector.json'
- ),
- 'utf8'
- )
- ) as JSONSchemaType<UnlockConnectorRequest>,
+ this.parseJsonSchemaFile<UnlockConnectorRequest>(
+ '../../../assets/json-schemas/ocpp/1.6/UnlockConnector.json'
+ ),
],
[
OCPP16IncomingRequestCommand.GET_CONFIGURATION,
- JSON.parse(
- fs.readFileSync(
- path.resolve(
- path.dirname(fileURLToPath(import.meta.url)),
- '../../../assets/json-schemas/ocpp/1.6/GetConfiguration.json'
- ),
- 'utf8'
- )
- ) as JSONSchemaType<GetConfigurationRequest>,
+ this.parseJsonSchemaFile<GetConfigurationRequest>(
+ '../../../assets/json-schemas/ocpp/1.6/GetConfiguration.json'
+ ),
],
[
OCPP16IncomingRequestCommand.CHANGE_CONFIGURATION,
- JSON.parse(
- fs.readFileSync(
- path.resolve(
- path.dirname(fileURLToPath(import.meta.url)),
- '../../../assets/json-schemas/ocpp/1.6/ChangeConfiguration.json'
- ),
- 'utf8'
- )
- ) as JSONSchemaType<ChangeConfigurationRequest>,
+ this.parseJsonSchemaFile<ChangeConfigurationRequest>(
+ '../../../assets/json-schemas/ocpp/1.6/ChangeConfiguration.json'
+ ),
],
[
OCPP16IncomingRequestCommand.GET_DIAGNOSTICS,
- JSON.parse(
- fs.readFileSync(
- path.resolve(
- path.dirname(fileURLToPath(import.meta.url)),
- '../../../assets/json-schemas/ocpp/1.6/GetDiagnostics.json'
- ),
- 'utf8'
- )
- ) as JSONSchemaType<GetDiagnosticsRequest>,
+ this.parseJsonSchemaFile<GetDiagnosticsRequest>(
+ '../../../assets/json-schemas/ocpp/1.6/GetDiagnostics.json'
+ ),
],
[
OCPP16IncomingRequestCommand.SET_CHARGING_PROFILE,
- JSON.parse(
- fs.readFileSync(
- path.resolve(
- path.dirname(fileURLToPath(import.meta.url)),
- '../../../assets/json-schemas/ocpp/1.6/SetChargingProfile.json'
- ),
- 'utf8'
- )
- ) as JSONSchemaType<SetChargingProfileRequest>,
+ this.parseJsonSchemaFile<SetChargingProfileRequest>(
+ '../../../assets/json-schemas/ocpp/1.6/SetChargingProfile.json'
+ ),
],
[
OCPP16IncomingRequestCommand.CLEAR_CHARGING_PROFILE,
- JSON.parse(
- fs.readFileSync(
- path.resolve(
- path.dirname(fileURLToPath(import.meta.url)),
- '../../../assets/json-schemas/ocpp/1.6/ClearChargingProfile.json'
- ),
- 'utf8'
- )
- ) as JSONSchemaType<ClearChargingProfileRequest>,
+ this.parseJsonSchemaFile<ClearChargingProfileRequest>(
+ '../../../assets/json-schemas/ocpp/1.6/ClearChargingProfile.json'
+ ),
],
[
OCPP16IncomingRequestCommand.CHANGE_AVAILABILITY,
- JSON.parse(
- fs.readFileSync(
- path.resolve(
- path.dirname(fileURLToPath(import.meta.url)),
- '../../../assets/json-schemas/ocpp/1.6/ChangeAvailability.json'
- ),
- 'utf8'
- )
- ) as JSONSchemaType<ChangeAvailabilityRequest>,
+ this.parseJsonSchemaFile<ChangeAvailabilityRequest>(
+ '../../../assets/json-schemas/ocpp/1.6/ChangeAvailability.json'
+ ),
],
[
OCPP16IncomingRequestCommand.REMOTE_START_TRANSACTION,
- JSON.parse(
- fs.readFileSync(
- path.resolve(
- path.dirname(fileURLToPath(import.meta.url)),
- '../../../assets/json-schemas/ocpp/1.6/RemoteStartTransaction.json'
- ),
- 'utf8'
- )
- ) as JSONSchemaType<RemoteStartTransactionRequest>,
+ this.parseJsonSchemaFile<RemoteStartTransactionRequest>(
+ '../../../assets/json-schemas/ocpp/1.6/RemoteStartTransaction.json'
+ ),
],
[
OCPP16IncomingRequestCommand.REMOTE_STOP_TRANSACTION,
- JSON.parse(
- fs.readFileSync(
- path.resolve(
- path.dirname(fileURLToPath(import.meta.url)),
- '../../../assets/json-schemas/ocpp/1.6/RemoteStopTransaction.json'
- ),
- 'utf8'
- )
- ) as JSONSchemaType<RemoteStopTransactionRequest>,
+ this.parseJsonSchemaFile<RemoteStopTransactionRequest>(
+ '../../../assets/json-schemas/ocpp/1.6/RemoteStopTransaction.json'
+ ),
],
[
OCPP16IncomingRequestCommand.TRIGGER_MESSAGE,
- JSON.parse(
- fs.readFileSync(
- path.resolve(
- path.dirname(fileURLToPath(import.meta.url)),
- '../../../assets/json-schemas/ocpp/1.6/TriggerMessage.json'
- ),
- 'utf8'
- )
- ) as JSONSchemaType<OCPP16TriggerMessageRequest>,
+ this.parseJsonSchemaFile<OCPP16TriggerMessageRequest>(
+ '../../../assets/json-schemas/ocpp/1.6/TriggerMessage.json'
+ ),
],
[
OCPP16IncomingRequestCommand.DATA_TRANSFER,
- JSON.parse(
- fs.readFileSync(
- path.resolve(
- path.dirname(fileURLToPath(import.meta.url)),
- '../../../assets/json-schemas/ocpp/1.6/DataTransfer.json'
- ),
- 'utf8'
- )
- ) as JSONSchemaType<OCPP16DataTransferRequest>,
+ this.parseJsonSchemaFile<OCPP16DataTransferRequest>(
+ '../../../assets/json-schemas/ocpp/1.6/DataTransfer.json'
+ ),
+ ],
+ [
+ OCPP16IncomingRequestCommand.UPDATE_FIRMWARE,
+ this.parseJsonSchemaFile<OCPP16UpdateFirmwareRequest>(
+ '../../../assets/json-schemas/ocpp/1.6/UpdateFirmware.json'
+ ),
],
]);
this.validatePayload.bind(this);
commandName: OCPP16IncomingRequestCommand,
commandPayload: JsonType
): boolean {
- if (this.jsonSchemas.has(commandName)) {
+ if (this.jsonSchemas.has(commandName) === true) {
return this.validateIncomingRequestPayload(
chargingStation,
commandName,
);
}
logger.warn(
- `${chargingStation.logPrefix()} ${moduleName}.validatePayload: No JSON schema found for command ${commandName} PDU validation`
+ `${chargingStation.logPrefix()} ${moduleName}.validatePayload: No JSON schema found for command '${commandName}' PDU validation`
);
return false;
}
private handleRequestReset(
chargingStation: ChargingStation,
commandPayload: ResetRequest
- ): DefaultResponse {
+ ): GenericResponse {
this.asyncResource
.runInAsyncScope(
chargingStation.reset.bind(chargingStation) as (
...args: any[]
) => Promise<void>,
chargingStation,
- (commandPayload.type + 'Reset') as OCPP16StopTransactionReason
+ `${commandPayload.type}Reset` as OCPP16StopTransactionReason
)
.catch(() => {
/* This is intentional */
chargingStation.stationInfo.resetTime
)}`
);
- return Constants.OCPP_RESPONSE_ACCEPTED;
- }
-
- private handleRequestClearCache(chargingStation: ChargingStation): DefaultResponse {
- chargingStation.authorizedTagsCache.deleteAuthorizedTags(
- ChargingStationUtils.getAuthorizationFile(chargingStation.stationInfo)
- );
- return Constants.OCPP_RESPONSE_ACCEPTED;
+ return OCPPConstants.OCPP_RESPONSE_ACCEPTED;
}
private async handleRequestUnlockConnector(
logger.error(
`${chargingStation.logPrefix()} Trying to unlock a non existing connector Id ${connectorId.toString()}`
);
- return Constants.OCPP_RESPONSE_UNLOCK_NOT_SUPPORTED;
+ return OCPPConstants.OCPP_RESPONSE_UNLOCK_NOT_SUPPORTED;
}
if (connectorId === 0) {
logger.error(
- chargingStation.logPrefix() + ' Trying to unlock connector Id ' + connectorId.toString()
+ `${chargingStation.logPrefix()} Trying to unlock connector Id ${connectorId.toString()}`
);
- return Constants.OCPP_RESPONSE_UNLOCK_NOT_SUPPORTED;
+ return OCPPConstants.OCPP_RESPONSE_UNLOCK_NOT_SUPPORTED;
}
if (chargingStation.getConnectorStatus(connectorId)?.transactionStarted === true) {
const stopResponse = await chargingStation.stopTransactionOnConnector(
OCPP16StopTransactionReason.UNLOCK_COMMAND
);
if (stopResponse.idTagInfo?.status === OCPP16AuthorizationStatus.ACCEPTED) {
- return Constants.OCPP_RESPONSE_UNLOCKED;
+ return OCPPConstants.OCPP_RESPONSE_UNLOCKED;
}
- return Constants.OCPP_RESPONSE_UNLOCK_FAILED;
+ return OCPPConstants.OCPP_RESPONSE_UNLOCK_FAILED;
}
await chargingStation.ocppRequestService.requestHandler<
OCPP16StatusNotificationRequest,
errorCode: OCPP16ChargePointErrorCode.NO_ERROR,
});
chargingStation.getConnectorStatus(connectorId).status = OCPP16ChargePointStatus.AVAILABLE;
- return Constants.OCPP_RESPONSE_UNLOCKED;
+ return OCPPConstants.OCPP_RESPONSE_UNLOCKED;
}
private handleRequestGetConfiguration(
true
);
if (!keyToChange) {
- return Constants.OCPP_CONFIGURATION_RESPONSE_NOT_SUPPORTED;
+ return OCPPConstants.OCPP_CONFIGURATION_RESPONSE_NOT_SUPPORTED;
} else if (keyToChange && keyToChange.readonly) {
- return Constants.OCPP_CONFIGURATION_RESPONSE_REJECTED;
+ return OCPPConstants.OCPP_CONFIGURATION_RESPONSE_REJECTED;
} else if (keyToChange && !keyToChange.readonly) {
let valueChanged = false;
if (keyToChange.value !== commandPayload.value) {
chargingStation.restartWebSocketPing();
}
if (keyToChange.reboot) {
- return Constants.OCPP_CONFIGURATION_RESPONSE_REBOOT_REQUIRED;
+ return OCPPConstants.OCPP_CONFIGURATION_RESPONSE_REBOOT_REQUIRED;
}
- return Constants.OCPP_CONFIGURATION_RESPONSE_ACCEPTED;
+ return OCPPConstants.OCPP_CONFIGURATION_RESPONSE_ACCEPTED;
}
}
OCPP16IncomingRequestCommand.SET_CHARGING_PROFILE
) === false
) {
- return Constants.OCPP_SET_CHARGING_PROFILE_RESPONSE_NOT_SUPPORTED;
+ return OCPPConstants.OCPP_SET_CHARGING_PROFILE_RESPONSE_NOT_SUPPORTED;
}
if (chargingStation.connectors.has(commandPayload.connectorId) === false) {
logger.error(
commandPayload.connectorId
}`
);
- return Constants.OCPP_SET_CHARGING_PROFILE_RESPONSE_REJECTED;
+ return OCPPConstants.OCPP_SET_CHARGING_PROFILE_RESPONSE_REJECTED;
}
if (
commandPayload.csChargingProfiles.chargingProfilePurpose ===
ChargingProfilePurposeType.CHARGE_POINT_MAX_PROFILE &&
commandPayload.connectorId !== 0
) {
- return Constants.OCPP_SET_CHARGING_PROFILE_RESPONSE_REJECTED;
+ return OCPPConstants.OCPP_SET_CHARGING_PROFILE_RESPONSE_REJECTED;
}
if (
commandPayload.csChargingProfiles.chargingProfilePurpose ===
commandPayload.connectorId
} without a started transaction`
);
- return Constants.OCPP_SET_CHARGING_PROFILE_RESPONSE_REJECTED;
+ return OCPPConstants.OCPP_SET_CHARGING_PROFILE_RESPONSE_REJECTED;
}
OCPP16ServiceUtils.setChargingProfile(
chargingStation,
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 OCPPConstants.OCPP_SET_CHARGING_PROFILE_RESPONSE_ACCEPTED;
}
private handleRequestClearChargingProfile(
OCPP16IncomingRequestCommand.CLEAR_CHARGING_PROFILE
) === false
) {
- return Constants.OCPP_CLEAR_CHARGING_PROFILE_RESPONSE_UNKNOWN;
+ return OCPPConstants.OCPP_CLEAR_CHARGING_PROFILE_RESPONSE_UNKNOWN;
}
if (chargingStation.connectors.has(commandPayload.connectorId) === false) {
logger.error(
commandPayload.connectorId
}`
);
- return Constants.OCPP_CLEAR_CHARGING_PROFILE_RESPONSE_UNKNOWN;
+ return OCPPConstants.OCPP_CLEAR_CHARGING_PROFILE_RESPONSE_UNKNOWN;
}
const connectorStatus = chargingStation.getConnectorStatus(commandPayload.connectorId);
if (commandPayload.connectorId && !Utils.isEmptyArray(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 OCPPConstants.OCPP_CLEAR_CHARGING_PROFILE_RESPONSE_ACCEPTED;
}
if (!commandPayload.connectorId) {
let clearedCP = false;
if (clearCurrentCP) {
connectorStatus.chargingProfiles.splice(index, 1);
logger.debug(
- `${chargingStation.logPrefix()} Matching charging profile(s) cleared on connector id ${
- commandPayload.connectorId
- }, dump their stack: %j`,
- connectorStatus.chargingProfiles
+ `${chargingStation.logPrefix()} Matching charging profile(s) cleared: %j`,
+ chargingProfile
);
clearedCP = true;
}
}
}
if (clearedCP) {
- return Constants.OCPP_CLEAR_CHARGING_PROFILE_RESPONSE_ACCEPTED;
+ return OCPPConstants.OCPP_CLEAR_CHARGING_PROFILE_RESPONSE_ACCEPTED;
}
}
- return Constants.OCPP_CLEAR_CHARGING_PROFILE_RESPONSE_UNKNOWN;
+ return OCPPConstants.OCPP_CLEAR_CHARGING_PROFILE_RESPONSE_UNKNOWN;
}
private async handleRequestChangeAvailability(
logger.error(
`${chargingStation.logPrefix()} Trying to change the availability of a non existing connector Id ${connectorId.toString()}`
);
- return Constants.OCPP_AVAILABILITY_RESPONSE_REJECTED;
+ return OCPPConstants.OCPP_AVAILABILITY_RESPONSE_REJECTED;
}
const chargePointStatus: OCPP16ChargePointStatus =
commandPayload.type === OCPP16AvailabilityType.OPERATIVE
? OCPP16ChargePointStatus.AVAILABLE
: OCPP16ChargePointStatus.UNAVAILABLE;
if (connectorId === 0) {
- let response: ChangeAvailabilityResponse = Constants.OCPP_AVAILABILITY_RESPONSE_ACCEPTED;
+ let response: ChangeAvailabilityResponse = OCPPConstants.OCPP_AVAILABILITY_RESPONSE_ACCEPTED;
for (const id of chargingStation.connectors.keys()) {
if (chargingStation.getConnectorStatus(id)?.transactionStarted === true) {
- response = Constants.OCPP_AVAILABILITY_RESPONSE_SCHEDULED;
+ response = OCPPConstants.OCPP_AVAILABILITY_RESPONSE_SCHEDULED;
}
chargingStation.getConnectorStatus(id).availability = commandPayload.type;
- if (response === Constants.OCPP_AVAILABILITY_RESPONSE_ACCEPTED) {
+ if (response === OCPPConstants.OCPP_AVAILABILITY_RESPONSE_ACCEPTED) {
await chargingStation.ocppRequestService.requestHandler<
OCPP16StatusNotificationRequest,
OCPP16StatusNotificationResponse
) {
if (chargingStation.getConnectorStatus(connectorId)?.transactionStarted === true) {
chargingStation.getConnectorStatus(connectorId).availability = commandPayload.type;
- return Constants.OCPP_AVAILABILITY_RESPONSE_SCHEDULED;
+ return OCPPConstants.OCPP_AVAILABILITY_RESPONSE_SCHEDULED;
}
chargingStation.getConnectorStatus(connectorId).availability = commandPayload.type;
await chargingStation.ocppRequestService.requestHandler<
errorCode: OCPP16ChargePointErrorCode.NO_ERROR,
});
chargingStation.getConnectorStatus(connectorId).status = chargePointStatus;
- return Constants.OCPP_AVAILABILITY_RESPONSE_ACCEPTED;
+ return OCPPConstants.OCPP_AVAILABILITY_RESPONSE_ACCEPTED;
}
- return Constants.OCPP_AVAILABILITY_RESPONSE_REJECTED;
+ return OCPPConstants.OCPP_AVAILABILITY_RESPONSE_REJECTED;
}
private async handleRequestRemoteStartTransaction(
chargingStation: ChargingStation,
commandPayload: RemoteStartTransactionRequest
- ): Promise<DefaultResponse> {
+ ): Promise<GenericResponse> {
const transactionConnectorId = commandPayload.connectorId;
if (chargingStation.connectors.has(transactionConnectorId) === true) {
- const remoteStartTransactionLogMsg =
- chargingStation.logPrefix() +
- ' Transaction remotely STARTED on ' +
- chargingStation.stationInfo.chargingStationId +
- '#' +
- transactionConnectorId.toString() +
- " for idTag '" +
- commandPayload.idTag +
- "'";
+ const remoteStartTransactionLogMsg = `${chargingStation.logPrefix()} Transaction remotely STARTED on ${
+ chargingStation.stationInfo.chargingStationId
+ }#${transactionConnectorId.toString()} for idTag '${commandPayload.idTag}'`;
await chargingStation.ocppRequestService.requestHandler<
OCPP16StatusNotificationRequest,
OCPP16StatusNotificationResponse
).idTagInfo.status === OCPP16AuthorizationStatus.ACCEPTED
) {
logger.debug(remoteStartTransactionLogMsg);
- return Constants.OCPP_RESPONSE_ACCEPTED;
+ return OCPPConstants.OCPP_RESPONSE_ACCEPTED;
}
return this.notifyRemoteStartTransactionRejected(
chargingStation,
).idTagInfo.status === OCPP16AuthorizationStatus.ACCEPTED
) {
logger.debug(remoteStartTransactionLogMsg);
- return Constants.OCPP_RESPONSE_ACCEPTED;
+ return OCPPConstants.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;
}
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 OCPPConstants.OCPP_RESPONSE_REJECTED;
}
private setRemoteStartTransactionChargingProfile(
if (cp && cp.chargingProfilePurpose === ChargingProfilePurposeType.TX_PROFILE) {
OCPP16ServiceUtils.setChargingProfile(chargingStation, connectorId, cp);
logger.debug(
- `${chargingStation.logPrefix()} Charging profile(s) set at remote start transaction on connector id ${connectorId}, dump their stack: %j`,
- chargingStation.getConnectorStatus(connectorId).chargingProfiles
+ `${chargingStation.logPrefix()} Charging profile(s) set at remote start transaction on connector id ${connectorId}: %j`,
+ cp
);
return true;
} else if (cp && cp.chargingProfilePurpose !== ChargingProfilePurposeType.TX_PROFILE) {
private async handleRequestRemoteStopTransaction(
chargingStation: ChargingStation,
commandPayload: RemoteStopTransactionRequest
- ): Promise<DefaultResponse> {
+ ): Promise<GenericResponse> {
const transactionId = commandPayload.transactionId;
for (const connectorId of chargingStation.connectors.keys()) {
if (
OCPP16StopTransactionReason.REMOTE
);
if (stopResponse.idTagInfo?.status === OCPP16AuthorizationStatus.ACCEPTED) {
- return Constants.OCPP_RESPONSE_ACCEPTED;
+ return OCPPConstants.OCPP_RESPONSE_ACCEPTED;
}
- return Constants.OCPP_RESPONSE_REJECTED;
+ return OCPPConstants.OCPP_RESPONSE_REJECTED;
}
}
logger.warn(
- chargingStation.logPrefix() +
- ' Trying to remote stop a non existing transaction ' +
- transactionId.toString()
+ `${chargingStation.logPrefix()} Trying to remote stop a non existing transaction ${transactionId.toString()}`
);
- return Constants.OCPP_RESPONSE_REJECTED;
+ return OCPPConstants.OCPP_RESPONSE_REJECTED;
}
private handleRequestUpdateFirmware(
OCPP16IncomingRequestCommand.UPDATE_FIRMWARE
) === false
) {
- return Constants.OCPP_RESPONSE_EMPTY;
+ logger.warn(
+ `${chargingStation.logPrefix()} ${moduleName}.handleRequestUpdateFirmware: Cannot simulate firmware update: feature profile not supported`
+ );
+ return OCPPConstants.OCPP_RESPONSE_EMPTY;
+ }
+ if (
+ !Utils.isNullOrUndefined(chargingStation.stationInfo.firmwareStatus) &&
+ chargingStation.stationInfo.firmwareStatus !== OCPP16FirmwareStatus.Installed
+ ) {
+ logger.warn(
+ `${chargingStation.logPrefix()} ${moduleName}.handleRequestUpdateFirmware: Cannot simulate firmware update: firmware update is already in progress`
+ );
+ return OCPPConstants.OCPP_RESPONSE_EMPTY;
+ }
+ const retrieveDate = Utils.convertToDate(commandPayload.retrieveDate);
+ const now = Date.now();
+ if (retrieveDate.getTime() <= now) {
+ this.asyncResource
+ .runInAsyncScope(
+ this.updateFirmware.bind(this) as (
+ this: OCPP16IncomingRequestService,
+ ...args: any[]
+ ) => Promise<void>,
+ this,
+ chargingStation
+ )
+ .catch(() => {
+ /* This is intentional */
+ });
+ } else {
+ setTimeout(() => {
+ this.updateFirmware(chargingStation).catch(() => {
+ /* Intentional */
+ });
+ }, retrieveDate.getTime() - now);
+ }
+ return OCPPConstants.OCPP_RESPONSE_EMPTY;
+ }
+
+ private async updateFirmware(
+ chargingStation: ChargingStation,
+ maxDelay = 30,
+ minDelay = 15
+ ): Promise<void> {
+ chargingStation.stopAutomaticTransactionGenerator();
+ for (const connectorId of chargingStation.connectors.keys()) {
+ if (
+ connectorId > 0 &&
+ chargingStation.getConnectorStatus(connectorId).transactionStarted === false
+ ) {
+ await chargingStation.ocppRequestService.requestHandler<
+ OCPP16StatusNotificationRequest,
+ OCPP16StatusNotificationResponse
+ >(chargingStation, OCPP16RequestCommand.STATUS_NOTIFICATION, {
+ connectorId,
+ status: OCPP16ChargePointStatus.UNAVAILABLE,
+ errorCode: OCPP16ChargePointErrorCode.NO_ERROR,
+ });
+ chargingStation.getConnectorStatus(connectorId).status =
+ OCPP16ChargePointStatus.UNAVAILABLE;
+ }
+ }
+ if (
+ chargingStation.stationInfo?.firmwareUpgrade?.failureStatus &&
+ !Utils.isEmptyString(chargingStation.stationInfo?.firmwareUpgrade?.failureStatus)
+ ) {
+ await chargingStation.ocppRequestService.requestHandler<
+ OCPP16FirmwareStatusNotificationRequest,
+ OCPP16FirmwareStatusNotificationResponse
+ >(chargingStation, OCPP16RequestCommand.FIRMWARE_STATUS_NOTIFICATION, {
+ status: chargingStation.stationInfo?.firmwareUpgrade?.failureStatus,
+ });
+ return;
+ }
+ await chargingStation.ocppRequestService.requestHandler<
+ OCPP16FirmwareStatusNotificationRequest,
+ OCPP16FirmwareStatusNotificationResponse
+ >(chargingStation, OCPP16RequestCommand.FIRMWARE_STATUS_NOTIFICATION, {
+ status: OCPP16FirmwareStatus.Downloading,
+ });
+ chargingStation.stationInfo.firmwareStatus = OCPP16FirmwareStatus.Downloading;
+ await Utils.sleep(Utils.getRandomInteger(maxDelay, minDelay) * 1000);
+ await chargingStation.ocppRequestService.requestHandler<
+ OCPP16FirmwareStatusNotificationRequest,
+ OCPP16FirmwareStatusNotificationResponse
+ >(chargingStation, OCPP16RequestCommand.FIRMWARE_STATUS_NOTIFICATION, {
+ status: OCPP16FirmwareStatus.Downloaded,
+ });
+ chargingStation.stationInfo.firmwareStatus = OCPP16FirmwareStatus.Downloaded;
+ await Utils.sleep(Utils.getRandomInteger(maxDelay, minDelay) * 1000);
+ await chargingStation.ocppRequestService.requestHandler<
+ OCPP16FirmwareStatusNotificationRequest,
+ OCPP16FirmwareStatusNotificationResponse
+ >(chargingStation, OCPP16RequestCommand.FIRMWARE_STATUS_NOTIFICATION, {
+ status: OCPP16FirmwareStatus.Installing,
+ });
+ chargingStation.stationInfo.firmwareStatus = OCPP16FirmwareStatus.Installing;
+ if (chargingStation.stationInfo?.firmwareUpgrade?.reset === true) {
+ await Utils.sleep(Utils.getRandomInteger(maxDelay, minDelay) * 1000);
+ await chargingStation.reset(OCPP16StopTransactionReason.REBOOT);
}
- logger.debug(
- chargingStation.logPrefix() +
- ' ' +
- OCPP16IncomingRequestCommand.UPDATE_FIRMWARE +
- ' request received: %j',
- commandPayload
- );
}
private async handleRequestGetDiagnostics(
OCPP16IncomingRequestCommand.GET_DIAGNOSTICS
) === false
) {
- return Constants.OCPP_RESPONSE_EMPTY;
+ logger.warn(
+ `${chargingStation.logPrefix()} ${moduleName}.handleRequestGetDiagnostics: Cannot get diagnostics: feature profile not supported`
+ );
+ return OCPPConstants.OCPP_RESPONSE_EMPTY;
}
- logger.debug(
- chargingStation.logPrefix() +
- ' ' +
- OCPP16IncomingRequestCommand.GET_DIAGNOSTICS +
- ' request received: %j',
- commandPayload
- );
const uri = new URL(commandPayload.location);
if (uri.protocol.startsWith('ftp:')) {
let ftpClient: Client;
.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({
});
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(path.dirname(fileURLToPath(import.meta.url)), '../../../../'),
diagnosticsArchive
),
- uri.pathname + 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: OCPPConstants.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 OCPPConstants.OCPP_RESPONSE_EMPTY;
}
}
commandPayload.requestedMessage
)
) {
- return Constants.OCPP_TRIGGER_MESSAGE_RESPONSE_NOT_IMPLEMENTED;
+ return OCPPConstants.OCPP_TRIGGER_MESSAGE_RESPONSE_NOT_IMPLEMENTED;
}
if (
!OCPP16ServiceUtils.isConnectorIdValid(
commandPayload.connectorId
)
) {
- return Constants.OCPP_TRIGGER_MESSAGE_RESPONSE_REJECTED;
+ return OCPPConstants.OCPP_TRIGGER_MESSAGE_RESPONSE_REJECTED;
}
try {
switch (commandPayload.requestedMessage) {
/* This is intentional */
});
}, Constants.OCPP_TRIGGER_MESSAGE_DELAY);
- return Constants.OCPP_TRIGGER_MESSAGE_RESPONSE_ACCEPTED;
+ return OCPPConstants.OCPP_TRIGGER_MESSAGE_RESPONSE_ACCEPTED;
case OCPP16MessageTrigger.Heartbeat:
setTimeout(() => {
chargingStation.ocppRequestService
/* This is intentional */
});
}, Constants.OCPP_TRIGGER_MESSAGE_DELAY);
- return Constants.OCPP_TRIGGER_MESSAGE_RESPONSE_ACCEPTED;
+ return OCPPConstants.OCPP_TRIGGER_MESSAGE_RESPONSE_ACCEPTED;
case OCPP16MessageTrigger.StatusNotification:
setTimeout(() => {
if (commandPayload?.connectorId) {
}
}
}, Constants.OCPP_TRIGGER_MESSAGE_DELAY);
- return Constants.OCPP_TRIGGER_MESSAGE_RESPONSE_ACCEPTED;
+ return OCPPConstants.OCPP_TRIGGER_MESSAGE_RESPONSE_ACCEPTED;
default:
- return Constants.OCPP_TRIGGER_MESSAGE_RESPONSE_NOT_IMPLEMENTED;
+ return OCPPConstants.OCPP_TRIGGER_MESSAGE_RESPONSE_NOT_IMPLEMENTED;
}
} catch (error) {
return this.handleIncomingRequestError(
chargingStation,
OCPP16IncomingRequestCommand.TRIGGER_MESSAGE,
error as Error,
- { errorResponse: Constants.OCPP_TRIGGER_MESSAGE_RESPONSE_REJECTED }
+ { errorResponse: OCPPConstants.OCPP_TRIGGER_MESSAGE_RESPONSE_REJECTED }
);
}
}
chargingStation,
OCPP16IncomingRequestCommand.DATA_TRANSFER,
error as Error,
- { errorResponse: Constants.OCPP_DATA_TRANSFER_RESPONSE_REJECTED }
+ { errorResponse: OCPPConstants.OCPP_DATA_TRANSFER_RESPONSE_REJECTED }
);
}
}
+
+ private parseJsonSchemaFile<T extends JsonType>(relativePath: string): JSONSchemaType<T> {
+ return JSON.parse(
+ fs.readFileSync(
+ path.resolve(path.dirname(fileURLToPath(import.meta.url)), relativePath),
+ 'utf8'
+ )
+ ) as JSONSchemaType<T>;
+ }
}
repositories / e-mobility-charging-stations-simulator.git / blobdiff