request_start_transaction

OCPP 2.1 RequestStartTransaction 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
`charging_profile`	`ChargingProfile`	—
`custom_data`	`CustomData`	—
`evse_id`	`Int`	—	Number of the EVSE on which to start the transaction. EvseId SHALL be > 0 (≥ 1)
`group_id_token`	`IdToken`	—
`id_token`	`IdToken`	✓
`remote_start_id`	`Int`	✓	Id given by the server to this start request. The Charging Station will return this in the `TransactionEventRequest`, letting the server know which transaction was started for this request. Use to start a transaction.

Schema: RequestStartTransactionRequest

pub type Request {
  Request(
    charging_profile: option.Option(
      charging_profile.ChargingProfile,
    ),
    custom_data: option.Option(custom_data.CustomData),
    evse_id: option.Option(Int),
    group_id_token: option.Option(id_token.IdToken),
    id_token: id_token.IdToken,
    remote_start_id: Int,
  )
}

Constructors

Request(
  charging_profile: option.Option(
    charging_profile.ChargingProfile,
  ),
  custom_data: option.Option(custom_data.CustomData),
  evse_id: option.Option(Int),
  group_id_token: option.Option(id_token.IdToken),
  id_token: id_token.IdToken,
  remote_start_id: Int,
)

Response

</>

Field	Type	Req	Description
`custom_data`	`CustomData`	—
`status`	`RequestStartStopStatus`	✓
`status_info`	`StatusInfo`	—
`transaction_id`	`String`	—	When the transaction was already started by the Charging Station before the RequestStartTransactionRequest was received, for example: cable plugged in first. This contains the transactionId of the already started transaction. (max 36 chars)

Schema: RequestStartTransactionResponse

pub type Response {
  Response(
    custom_data: option.Option(custom_data.CustomData),
    status: request_start_stop_status.RequestStartStopStatus,
    status_info: option.Option(status_info.StatusInfo),
    transaction_id: option.Option(String),
  )
}

Constructors

Response(
  custom_data: option.Option(custom_data.CustomData),
  status: request_start_stop_status.RequestStartStopStatus,
  status_info: option.Option(status_info.StatusInfo),
  transaction_id: option.Option(String),
)

Values

new_request

</>

pub fn new_request(
  id_token id_token: id_token.IdToken,
  remote_start_id remote_start_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: request_start_stop_status.RequestStartStopStatus,
) -> 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.