boot_notification

OCPP 2.1 BootNotification 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
`charging_station`	`ChargingStation`	✓
`custom_data`	`CustomData`	—
`reason`	`BootReason`	✓

Schema: BootNotificationRequest

pub type Request {
  Request(
    charging_station: charging_station.ChargingStation,
    custom_data: option.Option(custom_data.CustomData),
    reason: boot_reason.BootReason,
  )
}

Constructors

Request(
  charging_station: charging_station.ChargingStation,
  custom_data: option.Option(custom_data.CustomData),
  reason: boot_reason.BootReason,
)

Response

</>

Field	Type	Req	Description
`current_time`	`DateTime`	✓	This contains the CSMS’s current time.
`custom_data`	`CustomData`	—
`interval`	`Int`	✓	When `Status` is Accepted, this contains the heartbeat interval in seconds. If the CSMS returns something other than Accepted, the value of the interval field indicates the minimum wait time before sending a next BootNotification request.
`status`	`RegistrationStatus`	✓
`status_info`	`StatusInfo`	—

Schema: BootNotificationResponse

pub type Response {
  Response(
    current_time: timestamp.Timestamp,
    custom_data: option.Option(custom_data.CustomData),
    interval: Int,
    status: registration_status.RegistrationStatus,
    status_info: option.Option(status_info.StatusInfo),
  )
}

Constructors

Response(
  current_time: timestamp.Timestamp,
  custom_data: option.Option(custom_data.CustomData),
  interval: Int,
  status: registration_status.RegistrationStatus,
  status_info: option.Option(status_info.StatusInfo),
)

Values

new_request

</>

pub fn new_request(
  charging_station charging_station: charging_station.ChargingStation,
  reason reason: boot_reason.BootReason,
) -> 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,
  interval interval: Int,
  status status: registration_status.RegistrationStatus,
) -> 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.