get_display_messages

OCPP 2.1 GetDisplayMessages 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`	—
`id`	`List(Int)`	—	If provided the Charging Station shall return Display Messages of the given ids. This field SHALL NOT contain more ids than set in `NumberOfDisplayMessages.maxLimit` (≥ 0)
`priority`	`MessagePriority`	—
`request_id`	`Int`	✓	The Id of this request.
`state`	`MessageState`	—

Schema: GetDisplayMessagesRequest

pub type Request {
  Request(
    custom_data: option.Option(custom_data.CustomData),
    id: option.Option(List(Int)),
    priority: option.Option(message_priority.MessagePriority),
    request_id: Int,
    state: option.Option(message_state.MessageState),
  )
}

Constructors

Request(
  custom_data: option.Option(custom_data.CustomData),
  id: option.Option(List(Int)),
  priority: option.Option(message_priority.MessagePriority),
  request_id: Int,
  state: option.Option(message_state.MessageState),
)

Response

</>

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

Schema: GetDisplayMessagesResponse

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

Constructors

Response(
  custom_data: option.Option(custom_data.CustomData),
  status: get_display_messages_status.GetDisplayMessagesStatus,
  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: get_display_messages_status.GetDisplayMessagesStatus,
) -> 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.