heartbeat

OCPP 2.0.1 Heartbeat 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_0_1/dispatch.

Types

Request

</>

Field	Type	Req	Description
`custom_data`	`CustomData`	—

Schema: HeartbeatRequest

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

Constructors

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

Response

</>

Field	Type	Req	Description
`current_time`	`DateTime`	✓	Contains the current time of the CSMS.
`custom_data`	`CustomData`	—

Schema: HeartbeatResponse

pub type Response {
  Response(
    current_time: timestamp.Timestamp,
    custom_data: option.Option(custom_data.CustomData),
  )
}

Constructors

Response(
  current_time: timestamp.Timestamp,
  custom_data: option.Option(custom_data.CustomData),
)

Values

new_request

</>

pub fn new_request() -> Request

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

new_response

</>

pub fn new_response(
  current_time current_time: timestamp.Timestamp,
) -> 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.