get_report

OCPP 2.1 GetReport 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
`component_criteria`	`List(ComponentCriterion)`	—	This field contains criteria for components for which a report is requested
`component_variable`	`List(ComponentVariable)`	—
`custom_data`	`CustomData`	—
`request_id`	`Int`	✓	The Id of the request.

Schema: GetReportRequest

pub type Request {
  Request(
    component_criteria: option.Option(
      List(component_criterion.ComponentCriterion),
    ),
    component_variable: option.Option(
      List(component_variable.ComponentVariable),
    ),
    custom_data: option.Option(custom_data.CustomData),
    request_id: Int,
  )
}

Constructors

Request(
  component_criteria: option.Option(
    List(component_criterion.ComponentCriterion),
  ),
  component_variable: option.Option(
    List(component_variable.ComponentVariable),
  ),
  custom_data: option.Option(custom_data.CustomData),
  request_id: Int,
)

Response

</>

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

Schema: GetReportResponse

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

Constructors

Response(
  custom_data: option.Option(custom_data.CustomData),
  status: generic_device_model_status.GenericDeviceModelStatus,
  status_info: option.Option(status_info.StatusInfo),
)

Values

new_request

</>

pub fn new_request(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: generic_device_model_status.GenericDeviceModelStatus,
) -> 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.