notify_der_start_stop

OCPP 2.1 NotifyDERStartStop 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
`control_id`	`String`	✓	Id of the started or stopped DER control. Corresponds to the controlId of the SetDERControlRequest. (max 36 chars)
`custom_data`	`CustomData`	—
`started`	`Bool`	✓	True if DER control has started. False if it has ended.
`superseded_ids`	`List(String)`	—	List of controlIds that are superseded as a result of this control starting. (max 36 chars)
`timestamp`	`DateTime`	✓	Time of start or end of event.

Schema: NotifyDERStartStopRequest

pub type Request {
  Request(
    control_id: String,
    custom_data: option.Option(custom_data.CustomData),
    started: Bool,
    superseded_ids: option.Option(List(String)),
    timestamp: timestamp.Timestamp,
  )
}

Constructors

Request(
  control_id: String,
  custom_data: option.Option(custom_data.CustomData),
  started: Bool,
  superseded_ids: option.Option(List(String)),
  timestamp: timestamp.Timestamp,
)

Response

</>

Field	Type	Req	Description
`custom_data`	`CustomData`	—

Schema: NotifyDERStartStopResponse

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(
  control_id control_id: String,
  started started: Bool,
  timestamp timestamp: timestamp.Timestamp,
) -> 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.