data_transfer

OCPP 2.1 DataTransfer 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
`custom_data`	`CustomData`	—
`data`	`JsonValue`	—	Data without specified length or format. This needs to be decided by both parties (Open to implementation).
`message_id`	`String`	—	May be used to indicate a specific message or implementation. (max 50 chars)
`vendor_id`	`String`	✓	This identifies the Vendor specific implementation (max 255 chars)

Schema: DataTransferRequest

pub type Request {
  Request(
    custom_data: option.Option(custom_data.CustomData),
    data: option.Option(json_value.JsonValue),
    message_id: option.Option(String),
    vendor_id: String,
  )
}

Constructors

Request(
  custom_data: option.Option(custom_data.CustomData),
  data: option.Option(json_value.JsonValue),
  message_id: option.Option(String),
  vendor_id: String,
)

Response

</>

Field	Type	Req	Description
`custom_data`	`CustomData`	—
`data`	`JsonValue`	—	Data without specified length or format, in response to request.
`status`	`DataTransferStatus`	✓
`status_info`	`StatusInfo`	—

Schema: DataTransferResponse

pub type Response {
  Response(
    custom_data: option.Option(custom_data.CustomData),
    data: option.Option(json_value.JsonValue),
    status: data_transfer_status.DataTransferStatus,
    status_info: option.Option(status_info.StatusInfo),
  )
}

Constructors

Response(
  custom_data: option.Option(custom_data.CustomData),
  data: option.Option(json_value.JsonValue),
  status: data_transfer_status.DataTransferStatus,
  status_info: option.Option(status_info.StatusInfo),
)

Values

new_request

</>

pub fn new_request(vendor_id vendor_id: String) -> Request

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

new_response

</>

pub fn new_response(
  status status: data_transfer_status.DataTransferStatus,
) -> 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.