Events

Type: array of object

A list of events, ordered (i.e., later events will overwrite earlier ones if there is a conflict), that can either be a switching action, or a fault.

Must contain a minimum of 0 items

Each item of this array must be:

root root items
Type: object

Event definition

 No Additional Properties

root root items timestep
Type: string, integer or number

Timestep, in string, integer, or float, that identifies the timestep at which this event is applied.

Must match regular expression: ^\d+\.*\d*

root root items event_type
Type: enum (of string)

The type of event (switch or fault)

Must be one of:

  • "fault"
  • "switch"

root root items affected_asset
Type: string

The asset that is being affected by the event

Must match regular expression: ^[Ll][Ii][Nn][Ee]\..+$

Must be at least 5 characters long

root root items event_data

The event data

root root items event_data anyOf item 0
Type: object

Switch event data

 No Additional Properties

root root items event_data anyOf item 0 type
Type: string

Type of switch, e.g., "fuse", "breaker", "recloser", etc.

root root items event_data anyOf item 0 state
Type: enum (of string)

What is the state of the switch, "open" or "closed"? Only used if "event_type" is "switch".

Must be one of:

  • "open"
  • "closed"
  • "OPEN"
  • "CLOSED"

root root items event_data anyOf item 0 dispatchable
Type: enum (of string or boolean) Default: false

Is the affected object dispatchable? (i.e., can be opened or closed), default is false

Must be one of:

  • "YES"
  • "NO"
  • "yes"
  • "no"
  • true
  • false

root root items event_data anyOf item 0 status
Type: enum (of integer or string) Default: 1

Status of the object, if 0, completely outaged from the model. Default 1.

Must be one of:

  • 0
  • 1
  • "DISABLED"
  • "ENABLED"
  • "enabled"
  • "disabled"
root root items event_data anyOf item 1
Type: object

Fault event data

 No Additional Properties

root root items event_data anyOf item 1 duration_ms
Type: numberFormat: float

Duration of a fault, in milliseconds, -1 ==> permanent fault

Value must be greater or equal to -1


Example:

[
    {
        "timestep": 1,
        "event_type": "switch",
        "affected_asset": "line.switch_name",
        "event_data": {
            "type": "breaker",
            "state": "open",
            "dispatchable": false,
            "status": 1
        }
    }
]