trigger_message

OCPP 2.1 TriggerMessage 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`	—
`custom_trigger`	`String`	—	(2.1) When requestedMessage = `CustomTrigger` this will trigger sending the corresponding message in field customTrigger, if supported by Charging Station. (max 50 chars)
`evse`	`Evse`	—
`requested_message`	`MessageTrigger`	✓

Schema: TriggerMessageRequest

pub type Request {
  Request(
    custom_data: option.Option(custom_data.CustomData),
    custom_trigger: option.Option(String),
    evse: option.Option(evse.Evse),
    requested_message: message_trigger.MessageTrigger,
  )
}

Constructors

Request(
  custom_data: option.Option(custom_data.CustomData),
  custom_trigger: option.Option(String),
  evse: option.Option(evse.Evse),
  requested_message: message_trigger.MessageTrigger,
)

Response

</>

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

Schema: TriggerMessageResponse

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

Constructors

Response(
  custom_data: option.Option(custom_data.CustomData),
  status: trigger_message_status.TriggerMessageStatus,
  status_info: option.Option(status_info.StatusInfo),
)

Values

new_request

</>

pub fn new_request(
  requested_message requested_message: message_trigger.MessageTrigger,
) -> Request

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

new_response

</>

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