get_charging_profiles

OCPP 2.1 GetChargingProfiles 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_1/dispatch.

Types

Request

</>

Field	Type	Req	Description
`charging_profile`	`ChargingProfileCriterion`	✓
`custom_data`	`CustomData`	—
`evse_id`	`Int`	—	For which EVSE installed charging profiles SHALL be reported. If 0, only charging profiles installed on the Charging Station itself (the grid connection) SHALL be reported. If omitted, all installed charging profiles SHALL be reported. + Reported charging profiles SHALL match the criteria in field chargingProfile. (≥ 0)
`request_id`	`Int`	✓	Reference identification that is to be used by the Charging Station in the `ReportChargingProfilesRequest` when provided.

Schema: GetChargingProfilesRequest

pub type Request {
  Request(
    charging_profile: charging_profile_criterion.ChargingProfileCriterion,
    custom_data: option.Option(custom_data.CustomData),
    evse_id: option.Option(Int),
    request_id: Int,
  )
}

Constructors

Request(
  charging_profile: charging_profile_criterion.ChargingProfileCriterion,
  custom_data: option.Option(custom_data.CustomData),
  evse_id: option.Option(Int),
  request_id: Int,
)

Response

</>

Field	Type	Req
`custom_data`	`CustomData`	—
`status`	`GetChargingProfileStatus`	✓
`status_info`	`StatusInfo`	—

Schema: GetChargingProfilesResponse

pub type Response {
  Response(
    custom_data: option.Option(custom_data.CustomData),
    status: get_charging_profile_status.GetChargingProfileStatus,
    status_info: option.Option(status_info.StatusInfo),
  )
}

Constructors

Response(
  custom_data: option.Option(custom_data.CustomData),
  status: get_charging_profile_status.GetChargingProfileStatus,
  status_info: option.Option(status_info.StatusInfo),
)

Values

new_request

</>

pub fn new_request(
  charging_profile charging_profile: charging_profile_criterion.ChargingProfileCriterion,
  request_id request_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: get_charging_profile_status.GetChargingProfileStatus,
) -> 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.