battery_swap

OCPP 2.1 BatterySwap 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
`battery_data`	`List(BatteryData)`	✓
`custom_data`	`CustomData`	—
`event_type`	`BatterySwapEvent`	✓
`id_token`	`IdToken`	✓
`request_id`	`Int`	✓	RequestId to correlate BatteryIn/Out events and optional RequestBatterySwapRequest.

Schema: BatterySwapRequest

pub type Request {
  Request(
    battery_data: List(battery_data.BatteryData),
    custom_data: option.Option(custom_data.CustomData),
    event_type: battery_swap_event.BatterySwapEvent,
    id_token: id_token.IdToken,
    request_id: Int,
  )
}

Constructors

Request(
  battery_data: List(battery_data.BatteryData),
  custom_data: option.Option(custom_data.CustomData),
  event_type: battery_swap_event.BatterySwapEvent,
  id_token: id_token.IdToken,
  request_id: Int,
)

Response

</>

This is an empty response that just acknowledges receipt of the request. (The request cannot be rejected).

Field	Type	Req	Description
`custom_data`	`CustomData`	—

Schema: BatterySwapResponse

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

Constructors

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

Values

new_request

</>

pub fn new_request(
  battery_data battery_data: List(battery_data.BatteryData),
  event_type event_type: battery_swap_event.BatterySwapEvent,
  id_token id_token: id_token.IdToken,
  request_id request_id: Int,
) -> Request

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

new_response

</>

pub fn new_response() -> 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.