message_info

OCPP 2.1 MessageInfo data type (schema MessageInfoType).

to_json/decoder map to/from its OCPP-J JSON object; new (when present) builds a value from the required fields only.

Types

MessageInfo

</>

Contains message details, for a message to be displayed on a Charging Station.

Field	Type	Req	Description
`custom_data`	`CustomData`	—
`display`	`Component`	—
`end_date_time`	`DateTime`	—	Until what date-time should this message be shown, after this date/time this message SHALL be removed.
`id`	`Int`	✓	Unique id within an exchange context. It is defined within the OCPP context as a positive Integer value (greater or equal to zero). (≥ 0)
`message`	`MessageContent`	✓
`message_extra`	`List(MessageContent)`	—
`priority`	`MessagePriority`	✓
`start_date_time`	`DateTime`	—	From what date-time should this message be shown. If omitted: directly.
`state`	`MessageState`	—
`transaction_id`	`String`	—	During which transaction shall this message be shown. Message SHALL be removed by the Charging Station after transaction has ended. (max 36 chars)

Schema: MessageInfoType

pub type MessageInfo {
  MessageInfo(
    custom_data: option.Option(custom_data.CustomData),
    display: option.Option(component.Component),
    end_date_time: option.Option(timestamp.Timestamp),
    id: Int,
    message: message_content.MessageContent,
    message_extra: option.Option(
      List(message_content.MessageContent),
    ),
    priority: message_priority.MessagePriority,
    start_date_time: option.Option(timestamp.Timestamp),
    state: option.Option(message_state.MessageState),
    transaction_id: option.Option(String),
  )
}

Constructors

MessageInfo(
  custom_data: option.Option(custom_data.CustomData),
  display: option.Option(component.Component),
  end_date_time: option.Option(timestamp.Timestamp),
  id: Int,
  message: message_content.MessageContent,
  message_extra: option.Option(
    List(message_content.MessageContent),
  ),
  priority: message_priority.MessagePriority,
  start_date_time: option.Option(timestamp.Timestamp),
  state: option.Option(message_state.MessageState),
  transaction_id: option.Option(String),
)

Values

decoder

</>

pub fn decoder() -> decode.Decoder(MessageInfo)

Decode a MessageInfo from its OCPP-J JSON object, enforcing schema constraints.

new

</>

pub fn new(
  id id: Int,
  message message: message_content.MessageContent,
  priority priority: message_priority.MessagePriority,
) -> MessageInfo

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

to_json

</>

pub fn to_json(value: MessageInfo) -> json.Json

Encode a MessageInfo to its OCPP-J JSON object.