-// 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,
- MessageTrigger,
+ 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';
],
[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>,
+ ],
]);
this.validatePayload.bind(this);
}
): 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)
) {
);
}
if (
- chargingStation.isRegistered() ||
- (!chargingStation.getOcppStrictCompliance() && chargingStation.isInUnknownState())
+ chargingStation.isRegistered() === true ||
+ (chargingStation.getOcppStrictCompliance() === false &&
+ chargingStation.isInUnknownState() === true)
) {
if (
- this.incomingRequestHandlers.has(commandName) &&
- OCPP16ServiceUtils.isIncomingRequestCommandSupported(commandName, chargingStation)
+ this.incomingRequestHandlers.has(commandName) === true &&
+ OCPP16ServiceUtils.isIncomingRequestCommandSupported(chargingStation, commandName) === true
) {
try {
this.validatePayload(chargingStation, commandName, commandPayload);
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);
- });
+ this.asyncResource
+ .runInAsyncScope(
+ chargingStation.reset.bind(chargingStation) as (
+ this: ChargingStation,
+ ...args: any[]
+ ) => Promise<void>,
+ chargingStation,
+ (commandPayload.type + 'Reset') as OCPP16StopTransactionReason
+ )
+ .catch(() => {
+ /* This is intentional */
+ });
logger.info(
`${chargingStation.logPrefix()} ${
commandPayload.type
return Constants.OCPP_RESPONSE_ACCEPTED;
}
- private handleRequestClearCache(): DefaultResponse {
+ private handleRequestClearCache(chargingStation: ChargingStation): DefaultResponse {
+ chargingStation.authorizedTagsCache.deleteAuthorizedTags(
+ ChargingStationUtils.getAuthorizationFile(chargingStation.stationInfo)
+ );
return Constants.OCPP_RESPONSE_ACCEPTED;
}
commandPayload: UnlockConnectorRequest
): Promise<UnlockConnectorResponse> {
const connectorId = commandPayload.connectorId;
+ if (chargingStation.connectors.has(connectorId) === false) {
+ logger.error(
+ `${chargingStation.logPrefix()} Trying to unlock a non existing connector Id ${connectorId.toString()}`
+ );
+ return Constants.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;
}
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;
}
- if (!chargingStation.getConnectorStatus(commandPayload.connectorId)) {
+ if (chargingStation.connectors.has(commandPayload.connectorId) === false) {
logger.error(
`${chargingStation.logPrefix()} Trying to set charging profile(s) to a non existing connector Id ${
commandPayload.connectorId
chargingStation.getConnectorStatus(commandPayload.connectorId)?.transactionStarted ===
false)
) {
+ logger.error(
+ `${chargingStation.logPrefix()} Trying to set transaction charging profile(s) on connector ${
+ commandPayload.connectorId
+ } without a started transaction`
+ );
return Constants.OCPP_SET_CHARGING_PROFILE_RESPONSE_REJECTED;
}
OCPP16ServiceUtils.setChargingProfile(
commandPayload: ClearChargingProfileRequest
): ClearChargingProfileResponse {
if (
- !OCPP16ServiceUtils.checkFeatureProfile(
+ OCPP16ServiceUtils.checkFeatureProfile(
chargingStation,
OCPP16SupportedFeatureProfiles.SmartCharging,
OCPP16IncomingRequestCommand.CLEAR_CHARGING_PROFILE
- )
+ ) === false
) {
return Constants.OCPP_CLEAR_CHARGING_PROFILE_RESPONSE_UNKNOWN;
}
- const connectorStatus = chargingStation.getConnectorStatus(commandPayload.connectorId);
- if (!connectorStatus) {
+ if (chargingStation.connectors.has(commandPayload.connectorId) === false) {
logger.error(
`${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;
}
+ const connectorStatus = chargingStation.getConnectorStatus(commandPayload.connectorId);
if (commandPayload.connectorId && !Utils.isEmptyArray(connectorStatus.chargingProfiles)) {
connectorStatus.chargingProfiles = [];
logger.debug(
commandPayload: ChangeAvailabilityRequest
): Promise<ChangeAvailabilityResponse> {
const connectorId: number = commandPayload.connectorId;
- if (!chargingStation.getConnectorStatus(connectorId)) {
+ if (chargingStation.connectors.has(connectorId) === false) {
logger.error(
`${chargingStation.logPrefix()} Trying to change the availability of a non existing connector Id ${connectorId.toString()}`
);
return response;
} else if (
connectorId > 0 &&
- (chargingStation.getConnectorStatus(0).availability === OCPP16AvailabilityType.OPERATIVE ||
- (chargingStation.getConnectorStatus(0).availability ===
- OCPP16AvailabilityType.INOPERATIVE &&
+ (chargingStation.isChargingStationAvailable() === true ||
+ (chargingStation.isChargingStationAvailable() === false &&
commandPayload.type === OCPP16AvailabilityType.INOPERATIVE))
) {
if (chargingStation.getConnectorStatus(connectorId)?.transactionStarted === true) {
commandPayload: RemoteStartTransactionRequest
): Promise<DefaultResponse> {
const transactionConnectorId = commandPayload.connectorId;
- const connectorStatus = chargingStation.getConnectorStatus(transactionConnectorId);
- if (transactionConnectorId) {
+ if (chargingStation.connectors.has(transactionConnectorId) === true) {
const remoteStartTransactionLogMsg =
chargingStation.logPrefix() +
' Transaction remotely STARTED on ' +
status: OCPP16ChargePointStatus.PREPARING,
errorCode: OCPP16ChargePointErrorCode.NO_ERROR,
});
+ const connectorStatus = chargingStation.getConnectorStatus(transactionConnectorId);
connectorStatus.status = OCPP16ChargePointStatus.PREPARING;
- if (chargingStation.isChargingStationAvailable() && connectorStatus) {
+ if (chargingStation.isChargingStationAvailable() === true) {
// Check if authorized
- if (chargingStation.getAuthorizeRemoteTxRequests()) {
+ if (chargingStation.getAuthorizeRemoteTxRequests() === true) {
let authorized = false;
if (
- chargingStation.getLocalAuthListEnabled() &&
- chargingStation.hasAuthorizedTags() &&
+ chargingStation.getLocalAuthListEnabled() === true &&
+ chargingStation.hasAuthorizedTags() === true &&
chargingStation.authorizedTagsCache
.getAuthorizedTags(
ChargingStationUtils.getAuthorizationFile(chargingStation.stationInfo)
)
- .find((value) => value === commandPayload.idTag)
+ .find((idTag) => idTag === commandPayload.idTag)
) {
connectorStatus.localAuthorizeIdTag = commandPayload.idTag;
connectorStatus.idTagLocalAuthorized = true;
authorized = true;
- } else if (chargingStation.getMustAuthorizeAtRemoteStart()) {
+ } 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 (
chargingStation,
transactionConnectorId,
commandPayload.chargingProfile
- )
+ ) === true
) {
connectorStatus.transactionRemoteStarted = true;
if (
return Constants.OCPP_RESPONSE_REJECTED;
}
+ private handleRequestUpdateFirmware(
+ chargingStation: ChargingStation,
+ commandPayload: OCPP16UpdateFirmwareRequest
+ ): OCPP16UpdateFirmwareResponse {
+ if (
+ OCPP16ServiceUtils.checkFeatureProfile(
+ chargingStation,
+ OCPP16SupportedFeatureProfiles.FirmwareManagement,
+ OCPP16IncomingRequestCommand.UPDATE_FIRMWARE
+ ) === false
+ ) {
+ return Constants.OCPP_RESPONSE_EMPTY;
+ }
+ logger.debug(
+ chargingStation.logPrefix() +
+ ' ' +
+ OCPP16IncomingRequestCommand.UPDATE_FIRMWARE +
+ ' request received: %j',
+ commandPayload
+ );
+ }
+
private async handleRequestGetDiagnostics(
chargingStation: ChargingStation,
commandPayload: GetDiagnosticsRequest
): Promise<GetDiagnosticsResponse> {
if (
- !OCPP16ServiceUtils.checkFeatureProfile(
+ OCPP16ServiceUtils.checkFeatureProfile(
chargingStation,
OCPP16SupportedFeatureProfiles.FirmwareManagement,
OCPP16IncomingRequestCommand.GET_DIAGNOSTICS
- )
+ ) === false
) {
return Constants.OCPP_RESPONSE_EMPTY;
}
chargingStation,
OCPP16SupportedFeatureProfiles.RemoteTrigger,
OCPP16IncomingRequestCommand.TRIGGER_MESSAGE
+ ) ||
+ !OCPP16ServiceUtils.isMessageTriggerSupported(
+ chargingStation,
+ commandPayload.requestedMessage
)
) {
return Constants.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}`
- );
+ if (
+ !OCPP16ServiceUtils.isConnectorIdValid(
+ chargingStation,
+ OCPP16IncomingRequestCommand.TRIGGER_MESSAGE,
+ commandPayload.connectorId
+ )
+ ) {
return Constants.OCPP_TRIGGER_MESSAGE_RESPONSE_REJECTED;
}
try {
switch (commandPayload.requestedMessage) {
- case MessageTrigger.BootNotification:
+ case OCPP16MessageTrigger.BootNotification:
setTimeout(() => {
chargingStation.ocppRequestService
.requestHandler<OCPP16BootNotificationRequest, OCPP16BootNotificationResponse>(
});
}, Constants.OCPP_TRIGGER_MESSAGE_DELAY);
return Constants.OCPP_TRIGGER_MESSAGE_RESPONSE_ACCEPTED;
- case MessageTrigger.Heartbeat:
+ case OCPP16MessageTrigger.Heartbeat:
setTimeout(() => {
chargingStation.ocppRequestService
.requestHandler<OCPP16HeartbeatRequest, OCPP16HeartbeatResponse>(
});
}, Constants.OCPP_TRIGGER_MESSAGE_DELAY);
return Constants.OCPP_TRIGGER_MESSAGE_RESPONSE_ACCEPTED;
- case MessageTrigger.StatusNotification:
+ case OCPP16MessageTrigger.StatusNotification:
setTimeout(() => {
if (commandPayload?.connectorId) {
chargingStation.ocppRequestService
);
}
}
+
+ 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: Constants.OCPP_DATA_TRANSFER_RESPONSE_REJECTED }
+ );
+ }
+ }
}