start_transaction

OCPP 1.6 StartTransaction 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/v1_6/dispatch.

Types

Request

</>

Field	Type	Req	Description
`connector_id`	`Int`	✓
`id_tag`	`String`	✓	(max 20 chars)
`meter_start`	`Int`	✓
`reservation_id`	`Int`	—
`timestamp`	`DateTime`	✓

Schema: StartTransactionRequest

pub type Request {
  Request(
    connector_id: Int,
    id_tag: String,
    meter_start: Int,
    reservation_id: option.Option(Int),
    timestamp: timestamp.Timestamp,
  )
}

Constructors

Request(
  connector_id: Int,
  id_tag: String,
  meter_start: Int,
  reservation_id: option.Option(Int),
  timestamp: timestamp.Timestamp,
)

Response

</>

Field	Type	Req	Description
`id_tag_info`	`IdTagInfo`	✓
`transaction_id`	`Int`	✓

Schema: StartTransactionResponse

pub type Response {
  Response(
    id_tag_info: id_tag_info.IdTagInfo,
    transaction_id: Int,
  )
}

Constructors

Response(id_tag_info: id_tag_info.IdTagInfo, transaction_id: Int)

Values

new_request

</>

pub fn new_request(
  connector_id connector_id: Int,
  id_tag id_tag: String,
  meter_start meter_start: Int,
  timestamp timestamp: timestamp.Timestamp,
) -> Request

Construct a Request 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.