OCPP 2.0.1 Schemas — SmartCharging

Functional Block: H

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

Deep-dive: For conceptual explanations, composite schedule calculation, worked examples, and implementation guidance, see the Smart Charging Deep-Dive.

#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)

#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": "EMS",
  "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": "EMS"
}

#ClearedChargingLimitResponse

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

#NotifyChargingLimit

Direction: CS → CSMS

#NotifyChargingLimitRequest

{
  "chargingLimit": {
    "chargingLimitSource": "EMS"
  }
}

#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": "DC"
  },
  "evseId": 0
}

#NotifyEVChargingNeedsResponse

#Local Types

Types used only within this block's messages.

#ChargingProfileStatusEnumType

Returns whether the Charging Station has been able to process the message successfully. This does not guarantee the schedule will be followed to the letter. There might be other constraints the Charging Station may need to take into account.

Used in: SetChargingProfile

#ClearChargingProfileStatusEnumType

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

Used in: ClearChargingProfile

#EnergyTransferModeEnumType

Mode of energy transfer requested by the EV.

Used in: NotifyEVChargingNeeds

#GetChargingProfileStatusEnumType

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

Used in: GetChargingProfiles

#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

#ACChargingParametersType

EV AC charging parameters.

Used in: NotifyEVChargingNeeds

#ChargingLimitType

Used in: NotifyChargingLimit

#ChargingNeedsType

Used in: NotifyEVChargingNeeds

#ChargingProfileCriterionType

A ChargingProfile consists of ChargingSchedule, describing the amount of power or current that can be delivered per time interval.

Used in: GetChargingProfiles

#ClearChargingProfileType

A ChargingProfile consists of a ChargingSchedule, describing the amount of power or current that can be delivered per time interval.

Used in: ClearChargingProfile

#CompositeScheduleType

Used in: GetCompositeSchedule

#DCChargingParametersType

EV DC charging parameters

Used in: NotifyEVChargingNeeds