ocpp - v0.3.1

ocpp/v2_1/message/get_tariffs

OCPP 2.1 GetTariffs 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

</>
FieldTypeReqDescription
custom_dataCustomData—
evse_idInt✓EVSE id to get tariff from. When evseId = 0, this gets tariffs from all EVSEs. (≥ 0)

Schema: GetTariffsRequest

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

Constructors

Response

</>
FieldTypeReqDescription
custom_dataCustomData—
statusTariffGetStatus✓
status_infoStatusInfo—
tariff_assignmentsList(TariffAssignment)—

Schema: GetTariffsResponse

pub type Response {
  Response(
    custom_data: option.Option(custom_data.CustomData),
    status: tariff_get_status.TariffGetStatus,
    status_info: option.Option(status_info.StatusInfo),
    tariff_assignments: option.Option(
      List(tariff_assignment.TariffAssignment),
    ),
  )
}

Constructors

Values

new_request

</> 
pub fn new_request(evse_id evse_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: tariff_get_status.TariffGetStatus,
) -> 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.

✨ Search Document