boot_notification

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

Types

Request

</>

Field	Type	Req	Description
`charge_box_serial_number`	`String`	—	(max 25 chars)
`charge_point_model`	`String`	✓	(max 20 chars)
`charge_point_serial_number`	`String`	—	(max 25 chars)
`charge_point_vendor`	`String`	✓	(max 20 chars)
`firmware_version`	`String`	—	(max 50 chars)
`iccid`	`String`	—	(max 20 chars)
`imsi`	`String`	—	(max 20 chars)
`meter_serial_number`	`String`	—	(max 25 chars)
`meter_type`	`String`	—	(max 25 chars)

Schema: BootNotificationRequest

pub type Request {
  Request(
    charge_box_serial_number: option.Option(String),
    charge_point_model: String,
    charge_point_serial_number: option.Option(String),
    charge_point_vendor: String,
    firmware_version: option.Option(String),
    iccid: option.Option(String),
    imsi: option.Option(String),
    meter_serial_number: option.Option(String),
    meter_type: option.Option(String),
  )
}

Constructors

Request(
  charge_box_serial_number: option.Option(String),
  charge_point_model: String,
  charge_point_serial_number: option.Option(String),
  charge_point_vendor: String,
  firmware_version: option.Option(String),
  iccid: option.Option(String),
  imsi: option.Option(String),
  meter_serial_number: option.Option(String),
  meter_type: option.Option(String),
)

Response

</>

Field	Type	Req
`current_time`	`DateTime`	✓
`interval`	`Int`	✓
`status`	`RegistrationStatus`	✓

Schema: BootNotificationResponse

pub type Response {
  Response(
    current_time: timestamp.Timestamp,
    interval: Int,
    status: registration_status.RegistrationStatus,
  )
}

Constructors

Response(
  current_time: timestamp.Timestamp,
  interval: Int,
  status: registration_status.RegistrationStatus,
)

Values

new_request

</>

pub fn new_request(
  charge_point_model charge_point_model: String,
  charge_point_vendor charge_point_vendor: String,
) -> 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.