notify_der_alarm

OCPP 2.1 NotifyDERAlarm 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
`alarm_ended`	`Bool`	—	True when error condition has ended. Absent or false when alarm has started.
`control_type`	`DerControl`	✓
`custom_data`	`CustomData`	—
`extra_info`	`String`	—	Optional info provided by EV. (max 200 chars)
`grid_event_fault`	`GridEventFault`	—
`timestamp`	`DateTime`	✓	Time of start or end of alarm.

Schema: NotifyDERAlarmRequest

pub type Request {
  Request(
    alarm_ended: option.Option(Bool),
    control_type: der_control.DerControl,
    custom_data: option.Option(custom_data.CustomData),
    extra_info: option.Option(String),
    grid_event_fault: option.Option(
      grid_event_fault.GridEventFault,
    ),
    timestamp: timestamp.Timestamp,
  )
}

Constructors

Request(
  alarm_ended: option.Option(Bool),
  control_type: der_control.DerControl,
  custom_data: option.Option(custom_data.CustomData),
  extra_info: option.Option(String),
  grid_event_fault: option.Option(grid_event_fault.GridEventFault),
  timestamp: timestamp.Timestamp,
)

Response

</>

Field	Type	Req	Description
`custom_data`	`CustomData`	—

Schema: NotifyDERAlarmResponse

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_type control_type: der_control.DerControl,
  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.