Get Composite Schedule¶

Description.

Forwards a CSMS requests to the Charging Station to report the Composite Charging Schedule.

The CompositeSchedule is the result of the calculation of all active schedules and possible local limits present in the Charging Station.

The request and response defined on this page are based on OCPP 2.0.1’s GetCompositeSchedule.

GetCompositeScheduleRequest¶

Topic: ocpp/smart_charging. Used by OCPP to request Smart Charging service to return a composite schedule for the given duration.
type	object
properties
id	type	string
	format	uuid
name	const	get_composite_schedule
type	const	request
data	type	object
	properties
	duration	type	integer
	charging_rate_unit	enum	W, A
	evse_id	type	string

Example:

{
    "id": "2b0aa109-21a1-4f2f-bdbd-6cdf139e7bb1",
    "name": "get_composite_schedule",
    "type": "request",
    "data": {
      "duration": 3600,
      "charging_rate_unit": "W", # or "A" [OPTIONAL]
      "evse_id": "DE*SEV*E123456789"
    }
}

GetCompositeScheduleResponse¶

Topic: smart_charging/ocpp. Used by Smart Charging service to reply OCPP with a composite schedule for the given duration.
type	object
properties
id	type	string
	format	uuid
name	const	get_composite_schedule
type	const	response
data	type	object
	properties
	status	enum	Accepted, Rejected
	schedule	type	object
		properties
		evse_id	type	string
		duration	type	integer
		schedule_start	type	string
			pattern	^\d{4}-\d{2}-\d{2}[Tt]\d{2}:\d{2}:\d{2}(\.\d{1,3})?([Zz]\|([+-])\d{2}:\d{2})?$
			format	date-time
		charging_rate_unit	enum	W, A
		charging_schedule_period	type	array
			items	type	object
				properties
				start_period	type	integer
				limit	type	number
				number_of_phases_available	enum	1, 2, 3
				phase_to_use	enum	1, 2, 3
	status_info	type	object
		properties
		reason_code	type	string
		additional_info	type	string
			maxLength	512

Example:

{
  "id": "2b0aa109-21a1-4f2f-bdbd-6cdf139e7bb1",
  "name": "get_composite_schedule",
  "type": "response",
  "data": {
    "status": "Accepted", # or "Rejected"
    "schedule": { [OPTIONAL]
        "evse_id": "DE*SEV*E123456789",
        "duration": 1352,
        "schedule_start": "2021-11-10T14:29:37Z",
        "charging_rate_unit": "W", # or "A"
        "charging_schedule_period": [
            {
                "start_period": 760,
                "limit": 80.34,
                "number_of_phases_available": 1, # or 2, 3 [OPTIONAL]
                "phase_to_use": 1, # or 2, 3 [OPTIONAL]
            }
        ]
    }
    "status_info":{ [OPTIONAL]
        "reason_code": "Other",
        "additional_info": "Any additional string"
    }
  }
}