OCPP 2.1 Schemas — SmartCharging

Functional Block: K

Types Reference: Shared types referenced below are defined in OCPP-2.1-DataTypes.md.
Types used only within this block are documented inline below.

#Messages

• SetChargingProfile (CSMS → CS)
• GetChargingProfiles (CSMS → CS)
• ClearChargingProfile (CSMS → CS)
• ReportChargingProfiles (CS → CSMS)
• GetCompositeSchedule (CSMS → CS)
• ClearedChargingLimit (CS → CSMS)
• NotifyChargingLimit (CS → CSMS)
• NotifyEVChargingSchedule (CS → CSMS)
• NotifyEVChargingNeeds (CS → CSMS)
• PullDynamicScheduleUpdate (CS → CSMS)
• UpdateDynamicSchedule (CSMS → CS)
• NotifyPriorityCharging (CS → CSMS)
• UsePriorityCharging (CSMS → CS)

#SetChargingProfile

Direction: CSMS → CS

#SetChargingProfileRequest

{
  "chargingProfile": {
    "id": 0,
    "stackLevel": 0,
    "chargingProfilePurpose": "ChargingStationExternalConstraints",
    "chargingProfileKind": "Absolute",
    "chargingSchedule": [
      "{...}"
    ]
  },
  "evseId": 0
}

#SetChargingProfileResponse

#GetChargingProfiles

Direction: CSMS → CS

#GetChargingProfilesRequest

{
  "chargingProfile": {},
  "requestId": 0
}

#GetChargingProfilesResponse

#ClearChargingProfile

Direction: CSMS → CS

#ClearChargingProfileRequest

#ClearChargingProfileResponse

#ReportChargingProfiles

Direction: CS → CSMS

#ReportChargingProfilesRequest

{
  "chargingLimitSource": "string",
  "chargingProfile": [
    {
      "id": 0,
      "stackLevel": 0,
      "chargingProfilePurpose": "ChargingStationExternalConstraints",
      "chargingProfileKind": "Absolute",
      "chargingSchedule": [
        "{...}"
      ]
    }
  ],
  "evseId": 0,
  "requestId": 0
}

#ReportChargingProfilesResponse

No required fields. An empty {} is a valid response.

#GetCompositeSchedule

Direction: CSMS → CS

#GetCompositeScheduleRequest

{
  "duration": 0,
  "evseId": 0
}

#GetCompositeScheduleResponse

#ClearedChargingLimit

Direction: CS → CSMS

#ClearedChargingLimitRequest

{
  "chargingLimitSource": "string"
}

#ClearedChargingLimitResponse

No required fields. An empty {} is a valid response.

#NotifyChargingLimit

Direction: CS → CSMS

#NotifyChargingLimitRequest

{
  "chargingLimit": {
    "chargingLimitSource": "string"
  }
}

#NotifyChargingLimitResponse

No required fields. An empty {} is a valid response.

#NotifyEVChargingSchedule

Direction: CS → CSMS

#NotifyEVChargingScheduleRequest

{
  "chargingSchedule": {
    "id": 0,
    "chargingRateUnit": "W",
    "chargingSchedulePeriod": [
      "{...}"
    ]
  },
  "evseId": 0,
  "timeBase": "2024-01-15T10:30:00Z"
}

#NotifyEVChargingScheduleResponse

#NotifyEVChargingNeeds

Direction: CS → CSMS

#NotifyEVChargingNeedsRequest

{
  "chargingNeeds": {
    "requestedEnergyTransfer": "AC_single_phase"
  },
  "evseId": 0
}

#NotifyEVChargingNeedsResponse

#PullDynamicScheduleUpdate

Direction: CS → CSMS

#PullDynamicScheduleUpdateRequest

{
  "chargingProfileId": 0
}

#PullDynamicScheduleUpdateResponse

#UpdateDynamicSchedule

Direction: CSMS → CS

#UpdateDynamicScheduleRequest

{
  "chargingProfileId": 0,
  "scheduleUpdate": {}
}

#UpdateDynamicScheduleResponse

#NotifyPriorityCharging

Direction: CS → CSMS

#NotifyPriorityChargingRequest

{
  "activated": false,
  "transactionId": "string"
}

#NotifyPriorityChargingResponse

No required fields. An empty {} is a valid response.

#UsePriorityCharging

Direction: CSMS → CS

#UsePriorityChargingRequest

{
  "activate": false,
  "transactionId": "string"
}

#UsePriorityChargingResponse

#Local Types

Types used only within this block's messages.

#ClearChargingProfileStatusEnumType

Indicates if the Charging Station was able to execute the request.

Used in: ClearChargingProfile

#ControlModeEnumType

(2.1) Indicates whether EV wants to operate in Dynamic or Scheduled mode. When absent, Scheduled mode is assumed for backwards compatibility. + ISO 15118-20: + ServiceSelectionReq(SelectedEnergyTransferService)

Used in: NotifyEVChargingNeeds

#GetChargingProfileStatusEnumType

This indicates whether the Charging Station is able to process this request and will send ReportChargingProfilesRequest messages.

Used in: GetChargingProfiles

#IslandingDetectionEnumType

Used in: NotifyEVChargingNeeds

#MobilityNeedsModeEnumType

(2.1) Value of EVCC indicates that EV determines min/target SOC and departure time. + A value of EVCC_SECC indicates that charging station or CSMS may also update min/target SOC and departure time. + ISO 15118-20: + ServiceSelectionReq(SelectedEnergyTransferService)

Used in: NotifyEVChargingNeeds

#NotifyEVChargingNeedsStatusEnumType

Returns whether the CSMS has been able to process the message successfully. It does not imply that the evChargingNeeds can be met with the current charging profile.

Used in: NotifyEVChargingNeeds

#PriorityChargingStatusEnumType

Result of the request.

Used in: UsePriorityCharging

#ACChargingParametersType

EV AC charging parameters for ISO 15118-2

Used in: NotifyEVChargingNeeds

#ChargingLimitType

Used in: NotifyChargingLimit

#ChargingNeedsType

Used in: NotifyEVChargingNeeds

#ChargingProfileCriterionType

A ChargingProfileCriterionType is a filter for charging profiles to be selected by a GetChargingProfilesRequest.

Used in: GetChargingProfiles

#ChargingScheduleUpdateType

Updates to a ChargingSchedulePeriodType for dynamic charging profiles.

Used in: PullDynamicScheduleUpdate, UpdateDynamicSchedule

#ClearChargingProfileType

A ClearChargingProfileType is a filter for charging profiles to be cleared by ClearChargingProfileRequest.

Used in: ClearChargingProfile

#CompositeScheduleType

Used in: GetCompositeSchedule

#DCChargingParametersType

EV DC charging parameters for ISO 15118-2

Used in: NotifyEVChargingNeeds

#DERChargingParametersType

(2.1) DERChargingParametersType is used in ChargingNeedsType during an ISO 15118-20 session for AC_BPT_DER to report the inverter settings related to DER control that were agreed between EVSE and EV. Fields starting with "ev" contain values from the EV. Other fields contain a value that is supported by both EV and EVSE. DERChargingParametersType type is only relevant in case of an ISO 15118-20 AC_BPT_DER/AC_DER charging session. NOTE: All these fields have values greater or equal to zero (i.e. are non-negative)

Used in: NotifyEVChargingNeeds

#EVAbsolutePriceScheduleEntryType

(2.1) An entry in price schedule over time for which EV is willing to discharge.

Used in: NotifyEVChargingNeeds

#EVAbsolutePriceScheduleType

(2.1) Price schedule of EV energy offer.

Used in: NotifyEVChargingNeeds

#EVEnergyOfferType

(2.1) A schedule of the energy amount over time that EV is willing to discharge. A negative value indicates the willingness to discharge under specific conditions, a positive value indicates that the EV currently is not able to offer energy to discharge.

Used in: NotifyEVChargingNeeds

#EVPowerScheduleEntryType

(2.1) An entry in schedule of the energy amount over time that EV is willing to discharge. A negative value indicates the willingness to discharge under specific conditions, a positive value indicates that the EV currently is not able to offer energy to discharge.

Used in: NotifyEVChargingNeeds

#EVPowerScheduleType

(2.1) Schedule of EV energy offer.

Used in: NotifyEVChargingNeeds

#EVPriceRuleType

(2.1) An entry in price schedule over time for which EV is willing to discharge.

Used in: NotifyEVChargingNeeds

#V2XChargingParametersType

Charging parameters for ISO 15118-20, also supporting V2X charging/discharging.+ All values are greater or equal to zero, with the exception of EVMinEnergyRequest, EVMaxEnergyRequest, EVTargetEnergyRequest, EVMinV2XEnergyRequest and EVMaxV2XEnergyRequest.

Used in: NotifyEVChargingNeeds