get_composite_schedule

OCPP 2.0.1 GetCompositeSchedule action.

Request/Response payload types with their OCPP-J codecs (request_to_json/request_decoder, response_to_json/ response_decoder). Transport-agnostic; the action-string mapping lives in ocpp/v2_0_1/dispatch.

Types

Request

</>

Field	Type	Req	Description
`charging_rate_unit`	`ChargingRateUnit`	—
`custom_data`	`CustomData`	—
`duration`	`Int`	✓	Length of the requested schedule in seconds.
`evse_id`	`Int`	✓	The ID of the EVSE for which the schedule is requested. When evseid=0, the Charging Station will calculate the expected consumption for the grid connection.

Schema: GetCompositeScheduleRequest

pub type Request {
  Request(
    charging_rate_unit: option.Option(
      charging_rate_unit.ChargingRateUnit,
    ),
    custom_data: option.Option(custom_data.CustomData),
    duration: Int,
    evse_id: Int,
  )
}

Constructors

Request(
  charging_rate_unit: option.Option(
    charging_rate_unit.ChargingRateUnit,
  ),
  custom_data: option.Option(custom_data.CustomData),
  duration: Int,
  evse_id: Int,
)

Response

</>

Field	Type	Req
`custom_data`	`CustomData`	—
`schedule`	`CompositeSchedule`	—
`status`	`GenericStatus`	✓
`status_info`	`StatusInfo`	—

Schema: GetCompositeScheduleResponse

pub type Response {
  Response(
    custom_data: option.Option(custom_data.CustomData),
    schedule: option.Option(composite_schedule.CompositeSchedule),
    status: generic_status.GenericStatus,
    status_info: option.Option(status_info.StatusInfo),
  )
}

Constructors

Response(
  custom_data: option.Option(custom_data.CustomData),
  schedule: option.Option(composite_schedule.CompositeSchedule),
  status: generic_status.GenericStatus,
  status_info: option.Option(status_info.StatusInfo),
)

Values

new_request

</>

pub fn new_request(
  duration duration: Int,
  evse_id evse_id: Int,
) -> Request

Construct a Request from its required fields, with every optional field set to None.

new_response

</>

pub fn new_response(
  status status: generic_status.GenericStatus,
) -> Response

Construct a Response from its required fields, with every optional field set to None.

request_decoder

</>

pub fn request_decoder() -> decode.Decoder(Request)

Decode a Request from its OCPP-J JSON object, enforcing schema constraints.

request_to_json

</>

pub fn request_to_json(value: Request) -> json.Json

Encode a Request to its OCPP-J JSON object.

response_decoder

</>

pub fn response_decoder() -> decode.Decoder(Response)

Decode a Response from its OCPP-J JSON object, enforcing schema constraints.

response_to_json

</>

pub fn response_to_json(value: Response) -> json.Json

Encode a Response to its OCPP-J JSON object.