set_der_control

OCPP 2.1 SetDERControl 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`	✓	Unique id of this control, e.g. UUID (max 36 chars)
`control_type`	`DerControl`	✓
`curve`	`DerCurve`	—
`custom_data`	`CustomData`	—
`enter_service`	`EnterService`	—
`fixed_pf_absorb`	`FixedPf`	—
`fixed_pf_inject`	`FixedPf`	—
`fixed_var`	`FixedVar`	—
`freq_droop`	`FreqDroop`	—
`gradient`	`Gradient`	—
`is_default`	`Bool`	✓	True if this is a default DER control
`limit_max_discharge`	`LimitMaxDischarge`	—

Schema: SetDERControlRequest

pub type Request {
  Request(
    control_id: String,
    control_type: der_control.DerControl,
    curve: option.Option(der_curve.DerCurve),
    custom_data: option.Option(custom_data.CustomData),
    enter_service: option.Option(enter_service.EnterService),
    fixed_pf_absorb: option.Option(fixed_pf.FixedPf),
    fixed_pf_inject: option.Option(fixed_pf.FixedPf),
    fixed_var: option.Option(fixed_var.FixedVar),
    freq_droop: option.Option(freq_droop.FreqDroop),
    gradient: option.Option(gradient.Gradient),
    is_default: Bool,
    limit_max_discharge: option.Option(
      limit_max_discharge.LimitMaxDischarge,
    ),
  )
}

Constructors

Request(
  control_id: String,
  control_type: der_control.DerControl,
  curve: option.Option(der_curve.DerCurve),
  custom_data: option.Option(custom_data.CustomData),
  enter_service: option.Option(enter_service.EnterService),
  fixed_pf_absorb: option.Option(fixed_pf.FixedPf),
  fixed_pf_inject: option.Option(fixed_pf.FixedPf),
  fixed_var: option.Option(fixed_var.FixedVar),
  freq_droop: option.Option(freq_droop.FreqDroop),
  gradient: option.Option(gradient.Gradient),
  is_default: Bool,
  limit_max_discharge: option.Option(
    limit_max_discharge.LimitMaxDischarge,
  ),
)

Response

</>

Field	Type	Req	Description
`custom_data`	`CustomData`	—
`status`	`DerControlStatus`	✓
`status_info`	`StatusInfo`	—
`superseded_ids`	`List(String)`	—	List of controlIds that are superseded as a result of setting this control. (max 36 chars)

Schema: SetDERControlResponse

pub type Response {
  Response(
    custom_data: option.Option(custom_data.CustomData),
    status: der_control_status.DerControlStatus,
    status_info: option.Option(status_info.StatusInfo),
    superseded_ids: option.Option(List(String)),
  )
}

Constructors

Response(
  custom_data: option.Option(custom_data.CustomData),
  status: der_control_status.DerControlStatus,
  status_info: option.Option(status_info.StatusInfo),
  superseded_ids: option.Option(List(String)),
)

Values

new_request

</>

pub fn new_request(
  control_id control_id: String,
  control_type control_type: der_control.DerControl,
  is_default is_default: Bool,
) -> Request

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

new_response

</>

pub fn new_response(
  status status: der_control_status.DerControlStatus,
) -> 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.