-// Partial Copyright Jerome Benoit. 2021. All Rights Reserved.
+// Partial Copyright Jerome Benoit. 2021-2023. All Rights Reserved.
import fs from 'fs';
import path from 'path';
import { URL, fileURLToPath } from 'url';
import type { JSONSchemaType } from 'ajv';
-import { Client, FTPResponse } from 'basic-ftp';
+import { Client, type FTPResponse } from 'basic-ftp';
import tar from 'tar';
import OCPPError from '../../../exception/OCPPError';
import { OCPP16ChargePointStatus } from '../../../types/ocpp/1.6/ChargePointStatus';
import {
ChargingProfilePurposeType,
- OCPP16ChargingProfile,
+ type OCPP16ChargingProfile,
} from '../../../types/ocpp/1.6/ChargingProfile';
import {
OCPP16StandardParametersKey,
} from '../../../types/ocpp/1.6/Configuration';
import { OCPP16DiagnosticsStatus } from '../../../types/ocpp/1.6/DiagnosticsStatus';
import {
- ChangeAvailabilityRequest,
- ChangeConfigurationRequest,
- ClearChargingProfileRequest,
- DiagnosticsStatusNotificationRequest,
- GetConfigurationRequest,
- GetDiagnosticsRequest,
+ type ChangeAvailabilityRequest,
+ type ChangeConfigurationRequest,
+ type ClearChargingProfileRequest,
+ type DiagnosticsStatusNotificationRequest,
+ type GetConfigurationRequest,
+ type GetDiagnosticsRequest,
OCPP16AvailabilityType,
- OCPP16BootNotificationRequest,
- OCPP16ClearCacheRequest,
- OCPP16HeartbeatRequest,
+ type OCPP16BootNotificationRequest,
+ type OCPP16ClearCacheRequest,
+ type OCPP16DataTransferRequest,
+ OCPP16DataTransferVendorId,
+ type OCPP16HeartbeatRequest,
OCPP16IncomingRequestCommand,
OCPP16MessageTrigger,
OCPP16RequestCommand,
- OCPP16StatusNotificationRequest,
- OCPP16TriggerMessageRequest,
- RemoteStartTransactionRequest,
- RemoteStopTransactionRequest,
- ResetRequest,
- SetChargingProfileRequest,
- UnlockConnectorRequest,
+ type OCPP16StatusNotificationRequest,
+ type OCPP16TriggerMessageRequest,
+ type OCPP16UpdateFirmwareRequest,
+ type RemoteStartTransactionRequest,
+ type RemoteStopTransactionRequest,
+ type ResetRequest,
+ type SetChargingProfileRequest,
+ type UnlockConnectorRequest,
} from '../../../types/ocpp/1.6/Requests';
-import type {
- ChangeAvailabilityResponse,
- ChangeConfigurationResponse,
- ClearChargingProfileResponse,
- DiagnosticsStatusNotificationResponse,
- GetConfigurationResponse,
- GetDiagnosticsResponse,
- OCPP16BootNotificationResponse,
- OCPP16HeartbeatResponse,
- OCPP16StatusNotificationResponse,
- OCPP16TriggerMessageResponse,
- SetChargingProfileResponse,
- UnlockConnectorResponse,
+import {
+ type ChangeAvailabilityResponse,
+ type ChangeConfigurationResponse,
+ type ClearChargingProfileResponse,
+ type DiagnosticsStatusNotificationResponse,
+ type GetConfigurationResponse,
+ type GetDiagnosticsResponse,
+ type OCPP16BootNotificationResponse,
+ type OCPP16DataTransferResponse,
+ OCPP16DataTransferStatus,
+ type OCPP16HeartbeatResponse,
+ type OCPP16StatusNotificationResponse,
+ type OCPP16TriggerMessageResponse,
+ type OCPP16UpdateFirmwareResponse,
+ type SetChargingProfileResponse,
+ type UnlockConnectorResponse,
} from '../../../types/ocpp/1.6/Responses';
import {
OCPP16AuthorizationStatus,
- OCPP16AuthorizeRequest,
- OCPP16AuthorizeResponse,
- OCPP16StartTransactionRequest,
- OCPP16StartTransactionResponse,
+ type OCPP16AuthorizeRequest,
+ type OCPP16AuthorizeResponse,
+ type OCPP16StartTransactionRequest,
+ type OCPP16StartTransactionResponse,
OCPP16StopTransactionReason,
} 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 Constants from '../../../utils/Constants';
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';
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)],
]);
this.jsonSchemas = new Map<OCPP16IncomingRequestCommand, JSONSchemaType<JsonObject>>([
[
)
) as JSONSchemaType<OCPP16TriggerMessageRequest>,
],
+ [
+ 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>,
+ ],
+ [
+ OCPP16IncomingRequestCommand.UPDATE_FIRMWARE,
+ JSON.parse(
+ fs.readFileSync(
+ path.resolve(
+ path.dirname(fileURLToPath(import.meta.url)),
+ '../../../assets/json-schemas/ocpp/1.6/UpdateFirmware.json'
+ ),
+ 'utf8'
+ )
+ ) as JSONSchemaType<OCPP16UpdateFirmwareRequest>,
+ ],
]);
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,
chargingStation.stationInfo.resetTime
)}`
);
- return Constants.OCPP_RESPONSE_ACCEPTED;
+ return OCPPConstants.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()
);
- 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,
}, dump their stack: %j`,
chargingStation.getConnectorStatus(commandPayload.connectorId).chargingProfiles
);
- 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)) {
}, 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 (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(
).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.getConnectorStatus(connectorId).status +
"'"
);
- return Constants.OCPP_RESPONSE_REJECTED;
+ return OCPPConstants.OCPP_RESPONSE_REJECTED;
}
private setRemoteStartTransactionChargingProfile(
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(
' Trying to remote stop a non existing transaction ' +
transactionId.toString()
);
- return Constants.OCPP_RESPONSE_REJECTED;
+ return OCPPConstants.OCPP_RESPONSE_REJECTED;
+ }
+
+ private handleRequestUpdateFirmware(
+ chargingStation: ChargingStation,
+ commandPayload: OCPP16UpdateFirmwareRequest
+ ): OCPP16UpdateFirmwareResponse {
+ if (
+ OCPP16ServiceUtils.checkFeatureProfile(
+ chargingStation,
+ OCPP16SupportedFeatureProfiles.FirmwareManagement,
+ OCPP16IncomingRequestCommand.UPDATE_FIRMWARE
+ ) === false
+ ) {
+ return OCPPConstants.OCPP_RESPONSE_EMPTY;
+ }
+ logger.debug(
+ chargingStation.logPrefix() +
+ ' ' +
+ OCPP16IncomingRequestCommand.UPDATE_FIRMWARE +
+ ' request received: %j',
+ commandPayload
+ );
}
private async handleRequestGetDiagnostics(
OCPP16IncomingRequestCommand.GET_DIAGNOSTICS
) === false
) {
- return Constants.OCPP_RESPONSE_EMPTY;
+ return OCPPConstants.OCPP_RESPONSE_EMPTY;
}
logger.debug(
chargingStation.logPrefix() +
chargingStation,
OCPP16IncomingRequestCommand.GET_DIAGNOSTICS,
error as Error,
- { errorResponse: Constants.OCPP_RESPONSE_EMPTY }
+ { errorResponse: OCPPConstants.OCPP_RESPONSE_EMPTY }
);
}
} else {
>(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 }
+ );
+ }
+ }
+
+ private handleRequestDataTransfer(
+ chargingStation: ChargingStation,
+ commandPayload: OCPP16DataTransferRequest
+ ): OCPP16DataTransferResponse {
+ try {
+ if (Object.values(OCPP16DataTransferVendorId).includes(commandPayload.vendorId)) {
+ return {
+ status: OCPP16DataTransferStatus.ACCEPTED,
+ };
+ }
+ return {
+ status: OCPP16DataTransferStatus.UNKNOWN_VENDOR_ID,
+ };
+ } catch (error) {
+ return this.handleIncomingRequestError(
+ chargingStation,
+ OCPP16IncomingRequestCommand.DATA_TRANSFER,
+ error as Error,
+ { errorResponse: OCPPConstants.OCPP_DATA_TRANSFER_RESPONSE_REJECTED }
);
}
}
repositories / e-mobility-charging-stations-simulator.git / blobdiff