notify_display_messages

OCPP 2.1 NotifyDisplayMessages 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`	—
`message_info`	`List(MessageInfo)`	—
`request_id`	`Int`	✓	The id of the `GetDisplayMessagesRequest` that requested this message.
`tbc`	`Bool`	—	“to be continued” indicator. Indicates whether another part of the report follows in an upcoming NotifyDisplayMessagesRequest message. Default value when omitted is false.

Schema: NotifyDisplayMessagesRequest

pub type Request {
  Request(
    custom_data: option.Option(custom_data.CustomData),
    message_info: option.Option(List(message_info.MessageInfo)),
    request_id: Int,
    tbc: option.Option(Bool),
  )
}

Constructors

Request(
  custom_data: option.Option(custom_data.CustomData),
  message_info: option.Option(List(message_info.MessageInfo)),
  request_id: Int,
  tbc: option.Option(Bool),
)

Response

</>

Field	Type	Req	Description
`custom_data`	`CustomData`	—

Schema: NotifyDisplayMessagesResponse

pub type Response {
  Response(custom_data: option.Option(custom_data.CustomData))
}

Constructors

Response(custom_data: option.Option(custom_data.CustomData))

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() -> 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.