Class: Relay¶
A Relay object in OpenDSS.
URI: dss:Relay
classDiagram
class Relay
click Relay href "../Relay/"
Relay : action
Relay : basefreq
Relay : Breakertime
Relay : DebugTrace
Relay : Delay
Relay : DistReverse
Relay : DOC_DelayInner
Relay : DOC_P1Blocking
Relay : DOC_PhaseCurveInner
Relay : DOC_PhaseTripInner
Relay : DOC_TDPhaseInner
Relay : DOC_TiltAngleHigh
Relay : DOC_TiltAngleLow
Relay : DOC_TripSettingHigh
Relay : DOC_TripSettingLow
Relay : DOC_TripSettingMag
Relay : enabled
Relay : EventLog
Relay : Groundcurve
Relay : GroundInst
Relay : GroundTrip
Relay : kvbase
Relay : like
Relay : Mground
Relay : MonitoredObj
Relay : MonitoredTerm
Relay : Mphase
Relay : name
Relay : neg_seq_46_base_amps
Relay : neg_seq_46_isqt
Relay : Normal
Relay : overtrip
Relay : Overvoltcurve
Relay : pct_46_pickup
Relay : pct_47_pickup
Relay : Phasecurve
Relay : PhaseInst
Relay : PhaseTrip
Relay : RecloseIntervals
Relay : Reset
Relay : Shots
Relay : State
Relay : SwitchedObj
Relay : SwitchedTerm
Relay : TDGround
Relay : TDPhase
Relay : type
Relay : undertrip
Relay : Undervoltcurve
Relay : Variable
Relay : Z0ang
Relay : Z0mag
Relay : Z1ang
Relay : Z1mag
Class Properties¶
| Property | Value |
|---|---|
| Class URI | dss:Relay |
Slots¶
| Name | Cardinality and Range | Description | Inheritance |
|---|---|---|---|
| name | 1 String |
Object name | direct |
| MonitoredObj | 0..1 String |
Full object name of the circuit element, typically a line, transformer, load,... | direct |
| MonitoredTerm | 0..1 Integer |
Number of the terminal of the circuit element to which the Relay is connected | direct |
| SwitchedObj | 0..1 String |
Name of circuit element switch that the Relay controls | direct |
| SwitchedTerm | 0..1 Integer |
Number of the terminal of the controlled element in which the switch is contr... | direct |
| type | 0..1 Float |
One of a legal relay type: Current Voltage Reversepower 46 (neg seq curre... | direct |
| Phasecurve | 0..1 Float |
Name of the TCC Curve object that determines the phase trip | direct |
| Groundcurve | 0..1 Float |
Name of the TCC Curve object that determines the ground trip | direct |
| PhaseTrip | 0..1 String |
Multiplier or actual phase amps for the phase TCC curve | direct |
| GroundTrip | 0..1 String |
Multiplier or actual ground amps (3I0) for the ground TCC curve | direct |
| TDPhase | 0..1 String |
Time dial for Phase trip curve | direct |
| TDGround | 0..1 String |
Time dial for Ground trip curve | direct |
| PhaseInst | 0..1 Float |
Actual amps (Current relay) or kW (reverse power relay) for instantaneous ph... | direct |
| GroundInst | 0..1 String |
Actual amps for instantaneous ground trip which is assumed to happen in 0 | direct |
| Reset | 0..1 String |
Reset time in sec for relay | direct |
| Shots | 0..1 Integer |
Number of shots to lockout | direct |
| RecloseIntervals | 0..1 Float |
Array of reclose intervals | direct |
| Delay | 0..1 Float |
Trip time delay (sec) for DEFINITE TIME relays | direct |
| Overvoltcurve | 0..1 Float |
TCC Curve object to use for overvoltage relay | direct |
| Undervoltcurve | 0..1 Float |
TCC Curve object to use for undervoltage relay | direct |
| kvbase | 0..1 Integer |
Voltage base (kV) for the relay | direct |
| pct_47_pickup | 0..1 Float |
Percent voltage pickup for 47 relay (Neg seq voltage) | direct |
| neg_seq_46_base_amps | 0..1 Float |
Base current, Amps, for 46 relay (neg seq current) | direct |
| pct_46_pickup | 0..1 Float |
Percent pickup current for 46 relay (neg seq current) | direct |
| neg_seq_46_isqt | 0..1 Float |
Negative Sequence I-squared-t trip value for 46 relay (neg seq current) | direct |
| Variable | 0..1 String |
Name of variable in PC Elements being monitored | direct |
| overtrip | 0..1 String |
Trip setting (high value) for Generic relay variable | direct |
| undertrip | 0..1 String |
Trip setting (low value) for Generic relay variable | direct |
| Breakertime | 0..1 Float |
Fixed delay time (sec) added to relay time | direct |
| action | 0..1 String |
DEPRECATED | direct |
| Z1mag | 0..1 Float |
Positive sequence reach impedance in primary ohms for Distance and TD21 funct... | direct |
| Z1ang | 0..1 Float |
Positive sequence reach impedance angle in degrees for Distance and TD21 func... | direct |
| Z0mag | 0..1 Float |
Zero sequence reach impedance in primary ohms for Distance and TD21 functions | direct |
| Z0ang | 0..1 Float |
Zero sequence reach impedance angle in degrees for Distance and TD21 function... | direct |
| Mphase | 0..1 String |
Phase reach multiplier in per-unit for Distance and TD21 functions | direct |
| Mground | 0..1 String |
Ground reach multiplier in per-unit for Distance and TD21 functions | direct |
| EventLog | 0..1 String |
{Yes/True* | No/False} Default is Yes for Relay |
| DebugTrace | 0..1 String |
{Yes/True* | No/False} Default is No for Relay |
| DistReverse | 0..1 String |
{Yes/True* | No/False} Default is No; reverse direction for distance and td21... |
| Normal | 0..1 String |
{Open | Closed} Normal state of the relay |
| State | 0..1 String |
{Open | Closed} Actual state of the relay |
| DOC_TiltAngleLow | 0..1 Float |
Tilt angle for low-current trip line | direct |
| DOC_TiltAngleHigh | 0..1 Float |
Tilt angle for high-current trip line | direct |
| DOC_TripSettingLow | 0..1 Float |
Resistive trip setting for low-current line | direct |
| DOC_TripSettingHigh | 0..1 Float |
Resistive trip setting for high-current line | direct |
| DOC_TripSettingMag | 0..1 Float |
Trip setting for current magnitude (defines a circle in the relay characteris... | direct |
| DOC_DelayInner | 0..1 String |
Trip time delay (sec) for operation in inner region for DOC relay, defined wh... | direct |
| DOC_PhaseCurveInner | 0..1 Float |
Name of the TCC Curve object that determines the phase trip for operation in ... | direct |
| DOC_PhaseTripInner | 0..1 String |
Multiplier for the "DOC_PhaseCurveInner" TCC curve | direct |
| DOC_TDPhaseInner | 0..1 String |
Time dial for "DOC_PhaseCurveInner" TCC curve | direct |
| DOC_P1Blocking | 0..1 Float |
{Yes/True* | No/False} Blocking element that impedes relay from tripping if b... |
| basefreq | 0..1 Float |
Base Frequency for ratings | direct |
| enabled | 0..1 Boolean |
{Yes | No or True |
| like | 0..1 String |
Make like another object, e | direct |
Identifier and Mapping Information¶
Schema Source¶
- from schema: https://gridappsd.github.io/dss-graph/opendss
Mappings¶
| Mapping Type | Mapped Value |
|---|---|
| self | dss:Relay |
| native | dss:Relay |
LinkML Source¶
Direct¶
name: Relay
description: A Relay object in OpenDSS.
from_schema: https://gridappsd.github.io/dss-graph/opendss
attributes:
name:
name: name
description: Object name. Must be unique per object type.
from_schema: https://gridappsd.github.io/dss-graph/controls/relay
identifier: true
domain_of:
- Load
- Generator
- Generic5
- Gicline
- Indmach012
- Pvsystem
- Storage
- Upfc
- Vccs
- Vsconverter
- Windgen
- Autotrans
- Capacitor
- Gictransformer
- Line
- Reactor
- Transformer
- Capcontrol
- Espvlcontrol
- Expcontrol
- Fuse
- Gendispatcher
- Invcontrol
- Pycontrol
- Recloser
- Regcontrol
- Relay
- Storagecontroller
- Swtcontrol
- Upfccontrol
- Cndata
- Dynamicexp
- Growthshape
- Linecode
- Linegeometry
- Linespacing
- Loadshape
- Priceshape
- Spectrum
- TccCurve
- Tsdata
- Tshape
- Wiredata
- Xfmrcode
- Xycurve
- Energymeter
- Fmonitor
- Monitor
- Sensor
- Fault
- Gicsource
- Isource
- Vsource
range: string
required: true
MonitoredObj:
name: MonitoredObj
annotations:
order:
tag: order
value: 1
description: Full object name of the circuit element, typically a line, transformer,
load, or generator, to which the relay's PT and/or CT are connected
from_schema: https://gridappsd.github.io/dss-graph/controls/relay
domain_of:
- Fuse
- Recloser
- Relay
range: string
required: false
MonitoredTerm:
name: MonitoredTerm
annotations:
order:
tag: order
value: 2
description: Number of the terminal of the circuit element to which the Relay
is connected
from_schema: https://gridappsd.github.io/dss-graph/controls/relay
domain_of:
- Fuse
- Recloser
- Relay
range: integer
required: false
SwitchedObj:
name: SwitchedObj
annotations:
order:
tag: order
value: 3
description: Name of circuit element switch that the Relay controls
from_schema: https://gridappsd.github.io/dss-graph/controls/relay
domain_of:
- Fuse
- Recloser
- Relay
- Swtcontrol
range: string
required: false
SwitchedTerm:
name: SwitchedTerm
annotations:
order:
tag: order
value: 4
description: Number of the terminal of the controlled element in which the switch
is controlled by the Relay
from_schema: https://gridappsd.github.io/dss-graph/controls/relay
domain_of:
- Fuse
- Recloser
- Relay
- Swtcontrol
range: integer
required: false
type:
name: type
annotations:
order:
tag: order
value: 5
description: 'One of a legal relay type: Current Voltage Reversepower 46 (neg
seq current) 47 (neg seq voltage) Generic (generic over/under relay) Distance TD21 DOC
(directional overcurrent)D...'
from_schema: https://gridappsd.github.io/dss-graph/controls/relay
domain_of:
- Capcontrol
- Relay
range: float
required: false
Phasecurve:
name: Phasecurve
annotations:
order:
tag: order
value: 6
description: Name of the TCC Curve object that determines the phase trip
from_schema: https://gridappsd.github.io/dss-graph/controls/relay
rank: 1000
domain_of:
- Relay
range: float
required: false
Groundcurve:
name: Groundcurve
annotations:
order:
tag: order
value: 7
description: Name of the TCC Curve object that determines the ground trip
from_schema: https://gridappsd.github.io/dss-graph/controls/relay
rank: 1000
domain_of:
- Relay
range: float
required: false
PhaseTrip:
name: PhaseTrip
annotations:
order:
tag: order
value: 8
description: Multiplier or actual phase amps for the phase TCC curve
from_schema: https://gridappsd.github.io/dss-graph/controls/relay
domain_of:
- Recloser
- Relay
range: string
required: false
GroundTrip:
name: GroundTrip
annotations:
order:
tag: order
value: 9
description: Multiplier or actual ground amps (3I0) for the ground TCC curve
from_schema: https://gridappsd.github.io/dss-graph/controls/relay
domain_of:
- Recloser
- Relay
range: string
required: false
TDPhase:
name: TDPhase
annotations:
order:
tag: order
value: 10
description: Time dial for Phase trip curve
from_schema: https://gridappsd.github.io/dss-graph/controls/relay
rank: 1000
domain_of:
- Relay
range: string
required: false
TDGround:
name: TDGround
annotations:
order:
tag: order
value: 11
description: Time dial for Ground trip curve
from_schema: https://gridappsd.github.io/dss-graph/controls/relay
rank: 1000
domain_of:
- Relay
range: string
required: false
PhaseInst:
name: PhaseInst
annotations:
order:
tag: order
value: 12
description: Actual amps (Current relay) or kW (reverse power relay) for instantaneous
phase trip which is assumed to happen in 0
from_schema: https://gridappsd.github.io/dss-graph/controls/relay
domain_of:
- Recloser
- Relay
range: float
required: false
GroundInst:
name: GroundInst
annotations:
order:
tag: order
value: 13
description: Actual amps for instantaneous ground trip which is assumed to happen
in 0
from_schema: https://gridappsd.github.io/dss-graph/controls/relay
domain_of:
- Recloser
- Relay
range: string
required: false
Reset:
name: Reset
annotations:
order:
tag: order
value: 14
description: Reset time in sec for relay
from_schema: https://gridappsd.github.io/dss-graph/controls/relay
domain_of:
- Capcontrol
- Recloser
- Regcontrol
- Relay
- Swtcontrol
range: string
required: false
Shots:
name: Shots
annotations:
order:
tag: order
value: 15
description: Number of shots to lockout
from_schema: https://gridappsd.github.io/dss-graph/controls/relay
domain_of:
- Recloser
- Relay
range: integer
required: false
RecloseIntervals:
name: RecloseIntervals
annotations:
order:
tag: order
value: 16
description: Array of reclose intervals
from_schema: https://gridappsd.github.io/dss-graph/controls/relay
domain_of:
- Recloser
- Relay
range: float
required: false
Delay:
name: Delay
annotations:
order:
tag: order
value: 17
description: Trip time delay (sec) for DEFINITE TIME relays
from_schema: https://gridappsd.github.io/dss-graph/controls/relay
domain_of:
- Capcontrol
- Fuse
- Recloser
- Relay
- Swtcontrol
range: float
required: false
Overvoltcurve:
name: Overvoltcurve
annotations:
order:
tag: order
value: 18
description: TCC Curve object to use for overvoltage relay
from_schema: https://gridappsd.github.io/dss-graph/controls/relay
rank: 1000
domain_of:
- Relay
range: float
required: false
Undervoltcurve:
name: Undervoltcurve
annotations:
order:
tag: order
value: 19
description: TCC Curve object to use for undervoltage relay
from_schema: https://gridappsd.github.io/dss-graph/controls/relay
rank: 1000
domain_of:
- Relay
range: float
required: false
kvbase:
name: kvbase
annotations:
order:
tag: order
value: 20
description: Voltage base (kV) for the relay
from_schema: https://gridappsd.github.io/dss-graph/controls/relay
rank: 1000
domain_of:
- Relay
- Sensor
range: integer
required: false
pct_47_pickup:
name: pct_47_pickup
annotations:
order:
tag: order
value: 21
dss_name:
tag: dss_name
value: 47%Pickup
description: Percent voltage pickup for 47 relay (Neg seq voltage)
from_schema: https://gridappsd.github.io/dss-graph/controls/relay
rank: 1000
domain_of:
- Relay
range: float
required: false
neg_seq_46_base_amps:
name: neg_seq_46_base_amps
annotations:
order:
tag: order
value: 22
dss_name:
tag: dss_name
value: 46BaseAmps
description: Base current, Amps, for 46 relay (neg seq current)
from_schema: https://gridappsd.github.io/dss-graph/controls/relay
rank: 1000
domain_of:
- Relay
range: float
required: false
pct_46_pickup:
name: pct_46_pickup
annotations:
order:
tag: order
value: 23
dss_name:
tag: dss_name
value: 46%Pickup
description: Percent pickup current for 46 relay (neg seq current)
from_schema: https://gridappsd.github.io/dss-graph/controls/relay
rank: 1000
domain_of:
- Relay
range: float
required: false
neg_seq_46_isqt:
name: neg_seq_46_isqt
annotations:
order:
tag: order
value: 24
dss_name:
tag: dss_name
value: 46isqt
description: Negative Sequence I-squared-t trip value for 46 relay (neg seq current)
from_schema: https://gridappsd.github.io/dss-graph/controls/relay
rank: 1000
domain_of:
- Relay
range: float
required: false
Variable:
name: Variable
annotations:
order:
tag: order
value: 25
description: Name of variable in PC Elements being monitored
from_schema: https://gridappsd.github.io/dss-graph/controls/relay
rank: 1000
domain_of:
- Relay
range: string
required: false
overtrip:
name: overtrip
annotations:
order:
tag: order
value: 26
description: Trip setting (high value) for Generic relay variable
from_schema: https://gridappsd.github.io/dss-graph/controls/relay
rank: 1000
domain_of:
- Relay
range: string
required: false
undertrip:
name: undertrip
annotations:
order:
tag: order
value: 27
description: Trip setting (low value) for Generic relay variable
from_schema: https://gridappsd.github.io/dss-graph/controls/relay
rank: 1000
domain_of:
- Relay
range: string
required: false
Breakertime:
name: Breakertime
annotations:
order:
tag: order
value: 28
description: Fixed delay time (sec) added to relay time
from_schema: https://gridappsd.github.io/dss-graph/controls/relay
rank: 1000
domain_of:
- Relay
range: float
required: false
action:
name: action
annotations:
order:
tag: order
value: 29
description: DEPRECATED
from_schema: https://gridappsd.github.io/dss-graph/controls/relay
rank: 1000
domain_of:
- Relay
- Loadshape
- Priceshape
- Tshape
- Energymeter
- Fmonitor
- Monitor
- Sensor
range: string
required: false
Z1mag:
name: Z1mag
annotations:
order:
tag: order
value: 30
description: Positive sequence reach impedance in primary ohms for Distance and
TD21 functions
from_schema: https://gridappsd.github.io/dss-graph/controls/relay
rank: 1000
domain_of:
- Relay
range: float
required: false
Z1ang:
name: Z1ang
annotations:
order:
tag: order
value: 31
description: Positive sequence reach impedance angle in degrees for Distance and
TD21 functions
from_schema: https://gridappsd.github.io/dss-graph/controls/relay
rank: 1000
domain_of:
- Relay
range: float
required: false
Z0mag:
name: Z0mag
annotations:
order:
tag: order
value: 32
description: Zero sequence reach impedance in primary ohms for Distance and TD21
functions
from_schema: https://gridappsd.github.io/dss-graph/controls/relay
rank: 1000
domain_of:
- Relay
range: float
required: false
Z0ang:
name: Z0ang
annotations:
order:
tag: order
value: 33
description: Zero sequence reach impedance angle in degrees for Distance and TD21
functions
from_schema: https://gridappsd.github.io/dss-graph/controls/relay
rank: 1000
domain_of:
- Relay
range: float
required: false
Mphase:
name: Mphase
annotations:
order:
tag: order
value: 34
description: Phase reach multiplier in per-unit for Distance and TD21 functions
from_schema: https://gridappsd.github.io/dss-graph/controls/relay
rank: 1000
domain_of:
- Relay
range: string
required: false
Mground:
name: Mground
annotations:
order:
tag: order
value: 35
description: Ground reach multiplier in per-unit for Distance and TD21 functions
from_schema: https://gridappsd.github.io/dss-graph/controls/relay
rank: 1000
domain_of:
- Relay
range: string
required: false
EventLog:
name: EventLog
annotations:
order:
tag: order
value: 36
description: '{Yes/True* | No/False} Default is Yes for Relay'
from_schema: https://gridappsd.github.io/dss-graph/controls/relay
domain_of:
- Capcontrol
- Expcontrol
- Invcontrol
- Regcontrol
- Relay
- Storagecontroller
range: string
required: false
DebugTrace:
name: DebugTrace
annotations:
order:
tag: order
value: 37
description: '{Yes/True* | No/False} Default is No for Relay'
from_schema: https://gridappsd.github.io/dss-graph/controls/relay
rank: 1000
domain_of:
- Relay
range: string
required: false
DistReverse:
name: DistReverse
annotations:
order:
tag: order
value: 38
description: '{Yes/True* | No/False} Default is No; reverse direction for distance
and td21 types'
from_schema: https://gridappsd.github.io/dss-graph/controls/relay
rank: 1000
domain_of:
- Relay
range: string
required: false
Normal:
name: Normal
annotations:
order:
tag: order
value: 39
description: '{Open | Closed} Normal state of the relay'
from_schema: https://gridappsd.github.io/dss-graph/controls/relay
domain_of:
- Fuse
- Recloser
- Relay
- Swtcontrol
range: string
required: false
State:
name: State
annotations:
order:
tag: order
value: 40
description: '{Open | Closed} Actual state of the relay'
from_schema: https://gridappsd.github.io/dss-graph/controls/relay
domain_of:
- Storage
- Fuse
- Recloser
- Relay
- Swtcontrol
range: string
required: false
DOC_TiltAngleLow:
name: DOC_TiltAngleLow
annotations:
order:
tag: order
value: 41
description: Tilt angle for low-current trip line
from_schema: https://gridappsd.github.io/dss-graph/controls/relay
rank: 1000
domain_of:
- Relay
range: float
required: false
DOC_TiltAngleHigh:
name: DOC_TiltAngleHigh
annotations:
order:
tag: order
value: 42
description: Tilt angle for high-current trip line
from_schema: https://gridappsd.github.io/dss-graph/controls/relay
rank: 1000
domain_of:
- Relay
range: float
required: false
DOC_TripSettingLow:
name: DOC_TripSettingLow
annotations:
order:
tag: order
value: 43
description: Resistive trip setting for low-current line
from_schema: https://gridappsd.github.io/dss-graph/controls/relay
rank: 1000
domain_of:
- Relay
range: float
required: false
DOC_TripSettingHigh:
name: DOC_TripSettingHigh
annotations:
order:
tag: order
value: 44
description: Resistive trip setting for high-current line
from_schema: https://gridappsd.github.io/dss-graph/controls/relay
rank: 1000
domain_of:
- Relay
range: float
required: false
DOC_TripSettingMag:
name: DOC_TripSettingMag
annotations:
order:
tag: order
value: 45
description: Trip setting for current magnitude (defines a circle in the relay
characteristics)
from_schema: https://gridappsd.github.io/dss-graph/controls/relay
rank: 1000
domain_of:
- Relay
range: float
required: false
DOC_DelayInner:
name: DOC_DelayInner
annotations:
order:
tag: order
value: 46
description: Trip time delay (sec) for operation in inner region for DOC relay,
defined when "DOC_TripSettingMag" or "DOC_TripSettingHigh" are activate
from_schema: https://gridappsd.github.io/dss-graph/controls/relay
rank: 1000
domain_of:
- Relay
range: string
required: false
DOC_PhaseCurveInner:
name: DOC_PhaseCurveInner
annotations:
order:
tag: order
value: 47
description: Name of the TCC Curve object that determines the phase trip for operation
in inner region for DOC relay
from_schema: https://gridappsd.github.io/dss-graph/controls/relay
rank: 1000
domain_of:
- Relay
range: float
required: false
DOC_PhaseTripInner:
name: DOC_PhaseTripInner
annotations:
order:
tag: order
value: 48
description: Multiplier for the "DOC_PhaseCurveInner" TCC curve
from_schema: https://gridappsd.github.io/dss-graph/controls/relay
rank: 1000
domain_of:
- Relay
range: string
required: false
DOC_TDPhaseInner:
name: DOC_TDPhaseInner
annotations:
order:
tag: order
value: 49
description: Time dial for "DOC_PhaseCurveInner" TCC curve
from_schema: https://gridappsd.github.io/dss-graph/controls/relay
rank: 1000
domain_of:
- Relay
range: string
required: false
DOC_P1Blocking:
name: DOC_P1Blocking
annotations:
order:
tag: order
value: 50
description: '{Yes/True* | No/False} Blocking element that impedes relay from
tripping if balanced net three-phase active power is in the forward direction
(i'
from_schema: https://gridappsd.github.io/dss-graph/controls/relay
rank: 1000
domain_of:
- Relay
range: float
required: false
basefreq:
name: basefreq
annotations:
order:
tag: order
value: 51
description: Base Frequency for ratings
from_schema: https://gridappsd.github.io/dss-graph/controls/relay
domain_of:
- Load
- Generator
- Generic5
- Gicline
- Indmach012
- Pvsystem
- Storage
- Upfc
- Vccs
- Vsconverter
- Windgen
- Autotrans
- Capacitor
- Gictransformer
- Line
- Reactor
- Transformer
- Capcontrol
- Espvlcontrol
- Expcontrol
- Fuse
- Gendispatcher
- Invcontrol
- Pycontrol
- Recloser
- Regcontrol
- Relay
- Storagecontroller
- Swtcontrol
- Upfccontrol
- Energymeter
- Fmonitor
- Monitor
- Sensor
- Fault
- Gicsource
- Isource
- Vsource
range: float
required: false
enabled:
name: enabled
annotations:
order:
tag: order
value: 52
description: '{Yes|No or True|False} Indicates whether this element is enabled'
from_schema: https://gridappsd.github.io/dss-graph/controls/relay
domain_of:
- Load
- Generator
- Generic5
- Gicline
- Indmach012
- Pvsystem
- Storage
- Upfc
- Vccs
- Vsconverter
- Windgen
- Autotrans
- Capacitor
- Gictransformer
- Line
- Reactor
- Transformer
- Capcontrol
- Espvlcontrol
- Expcontrol
- Fuse
- Gendispatcher
- Invcontrol
- Pycontrol
- Recloser
- Regcontrol
- Relay
- Storagecontroller
- Swtcontrol
- Upfccontrol
- Energymeter
- Fmonitor
- Monitor
- Sensor
- Fault
- Gicsource
- Isource
- Vsource
range: boolean
required: false
like:
name: like
annotations:
order:
tag: order
value: 53
description: Make like another object, e
from_schema: https://gridappsd.github.io/dss-graph/controls/relay
domain_of:
- Load
- Generator
- Generic5
- Gicline
- Indmach012
- Pvsystem
- Storage
- Upfc
- Vccs
- Vsconverter
- Windgen
- Autotrans
- Capacitor
- Gictransformer
- Line
- Reactor
- Transformer
- Capcontrol
- Espvlcontrol
- Expcontrol
- Fuse
- Gendispatcher
- Invcontrol
- Pycontrol
- Recloser
- Regcontrol
- Relay
- Storagecontroller
- Swtcontrol
- Upfccontrol
- Cndata
- Dynamicexp
- Growthshape
- Linecode
- Linegeometry
- Linespacing
- Loadshape
- Priceshape
- Spectrum
- TccCurve
- Tsdata
- Tshape
- Wiredata
- Xfmrcode
- Xycurve
- Energymeter
- Fmonitor
- Monitor
- Sensor
- Fault
- Gicsource
- Isource
- Vsource
range: string
required: false
class_uri: dss:Relay
Induced¶
name: Relay
description: A Relay object in OpenDSS.
from_schema: https://gridappsd.github.io/dss-graph/opendss
attributes:
name:
name: name
description: Object name. Must be unique per object type.
from_schema: https://gridappsd.github.io/dss-graph/controls/relay
identifier: true
owner: Relay
domain_of:
- Load
- Generator
- Generic5
- Gicline
- Indmach012
- Pvsystem
- Storage
- Upfc
- Vccs
- Vsconverter
- Windgen
- Autotrans
- Capacitor
- Gictransformer
- Line
- Reactor
- Transformer
- Capcontrol
- Espvlcontrol
- Expcontrol
- Fuse
- Gendispatcher
- Invcontrol
- Pycontrol
- Recloser
- Regcontrol
- Relay
- Storagecontroller
- Swtcontrol
- Upfccontrol
- Cndata
- Dynamicexp
- Growthshape
- Linecode
- Linegeometry
- Linespacing
- Loadshape
- Priceshape
- Spectrum
- TccCurve
- Tsdata
- Tshape
- Wiredata
- Xfmrcode
- Xycurve
- Energymeter
- Fmonitor
- Monitor
- Sensor
- Fault
- Gicsource
- Isource
- Vsource
range: string
required: true
MonitoredObj:
name: MonitoredObj
annotations:
order:
tag: order
value: 1
description: Full object name of the circuit element, typically a line, transformer,
load, or generator, to which the relay's PT and/or CT are connected
from_schema: https://gridappsd.github.io/dss-graph/controls/relay
owner: Relay
domain_of:
- Fuse
- Recloser
- Relay
range: string
required: false
MonitoredTerm:
name: MonitoredTerm
annotations:
order:
tag: order
value: 2
description: Number of the terminal of the circuit element to which the Relay
is connected
from_schema: https://gridappsd.github.io/dss-graph/controls/relay
owner: Relay
domain_of:
- Fuse
- Recloser
- Relay
range: integer
required: false
SwitchedObj:
name: SwitchedObj
annotations:
order:
tag: order
value: 3
description: Name of circuit element switch that the Relay controls
from_schema: https://gridappsd.github.io/dss-graph/controls/relay
owner: Relay
domain_of:
- Fuse
- Recloser
- Relay
- Swtcontrol
range: string
required: false
SwitchedTerm:
name: SwitchedTerm
annotations:
order:
tag: order
value: 4
description: Number of the terminal of the controlled element in which the switch
is controlled by the Relay
from_schema: https://gridappsd.github.io/dss-graph/controls/relay
owner: Relay
domain_of:
- Fuse
- Recloser
- Relay
- Swtcontrol
range: integer
required: false
type:
name: type
annotations:
order:
tag: order
value: 5
description: 'One of a legal relay type: Current Voltage Reversepower 46 (neg
seq current) 47 (neg seq voltage) Generic (generic over/under relay) Distance TD21 DOC
(directional overcurrent)D...'
from_schema: https://gridappsd.github.io/dss-graph/controls/relay
owner: Relay
domain_of:
- Capcontrol
- Relay
range: float
required: false
Phasecurve:
name: Phasecurve
annotations:
order:
tag: order
value: 6
description: Name of the TCC Curve object that determines the phase trip
from_schema: https://gridappsd.github.io/dss-graph/controls/relay
rank: 1000
owner: Relay
domain_of:
- Relay
range: float
required: false
Groundcurve:
name: Groundcurve
annotations:
order:
tag: order
value: 7
description: Name of the TCC Curve object that determines the ground trip
from_schema: https://gridappsd.github.io/dss-graph/controls/relay
rank: 1000
owner: Relay
domain_of:
- Relay
range: float
required: false
PhaseTrip:
name: PhaseTrip
annotations:
order:
tag: order
value: 8
description: Multiplier or actual phase amps for the phase TCC curve
from_schema: https://gridappsd.github.io/dss-graph/controls/relay
owner: Relay
domain_of:
- Recloser
- Relay
range: string
required: false
GroundTrip:
name: GroundTrip
annotations:
order:
tag: order
value: 9
description: Multiplier or actual ground amps (3I0) for the ground TCC curve
from_schema: https://gridappsd.github.io/dss-graph/controls/relay
owner: Relay
domain_of:
- Recloser
- Relay
range: string
required: false
TDPhase:
name: TDPhase
annotations:
order:
tag: order
value: 10
description: Time dial for Phase trip curve
from_schema: https://gridappsd.github.io/dss-graph/controls/relay
rank: 1000
owner: Relay
domain_of:
- Relay
range: string
required: false
TDGround:
name: TDGround
annotations:
order:
tag: order
value: 11
description: Time dial for Ground trip curve
from_schema: https://gridappsd.github.io/dss-graph/controls/relay
rank: 1000
owner: Relay
domain_of:
- Relay
range: string
required: false
PhaseInst:
name: PhaseInst
annotations:
order:
tag: order
value: 12
description: Actual amps (Current relay) or kW (reverse power relay) for instantaneous
phase trip which is assumed to happen in 0
from_schema: https://gridappsd.github.io/dss-graph/controls/relay
owner: Relay
domain_of:
- Recloser
- Relay
range: float
required: false
GroundInst:
name: GroundInst
annotations:
order:
tag: order
value: 13
description: Actual amps for instantaneous ground trip which is assumed to happen
in 0
from_schema: https://gridappsd.github.io/dss-graph/controls/relay
owner: Relay
domain_of:
- Recloser
- Relay
range: string
required: false
Reset:
name: Reset
annotations:
order:
tag: order
value: 14
description: Reset time in sec for relay
from_schema: https://gridappsd.github.io/dss-graph/controls/relay
owner: Relay
domain_of:
- Capcontrol
- Recloser
- Regcontrol
- Relay
- Swtcontrol
range: string
required: false
Shots:
name: Shots
annotations:
order:
tag: order
value: 15
description: Number of shots to lockout
from_schema: https://gridappsd.github.io/dss-graph/controls/relay
owner: Relay
domain_of:
- Recloser
- Relay
range: integer
required: false
RecloseIntervals:
name: RecloseIntervals
annotations:
order:
tag: order
value: 16
description: Array of reclose intervals
from_schema: https://gridappsd.github.io/dss-graph/controls/relay
owner: Relay
domain_of:
- Recloser
- Relay
range: float
required: false
Delay:
name: Delay
annotations:
order:
tag: order
value: 17
description: Trip time delay (sec) for DEFINITE TIME relays
from_schema: https://gridappsd.github.io/dss-graph/controls/relay
owner: Relay
domain_of:
- Capcontrol
- Fuse
- Recloser
- Relay
- Swtcontrol
range: float
required: false
Overvoltcurve:
name: Overvoltcurve
annotations:
order:
tag: order
value: 18
description: TCC Curve object to use for overvoltage relay
from_schema: https://gridappsd.github.io/dss-graph/controls/relay
rank: 1000
owner: Relay
domain_of:
- Relay
range: float
required: false
Undervoltcurve:
name: Undervoltcurve
annotations:
order:
tag: order
value: 19
description: TCC Curve object to use for undervoltage relay
from_schema: https://gridappsd.github.io/dss-graph/controls/relay
rank: 1000
owner: Relay
domain_of:
- Relay
range: float
required: false
kvbase:
name: kvbase
annotations:
order:
tag: order
value: 20
description: Voltage base (kV) for the relay
from_schema: https://gridappsd.github.io/dss-graph/controls/relay
rank: 1000
owner: Relay
domain_of:
- Relay
- Sensor
range: integer
required: false
pct_47_pickup:
name: pct_47_pickup
annotations:
order:
tag: order
value: 21
dss_name:
tag: dss_name
value: 47%Pickup
description: Percent voltage pickup for 47 relay (Neg seq voltage)
from_schema: https://gridappsd.github.io/dss-graph/controls/relay
rank: 1000
owner: Relay
domain_of:
- Relay
range: float
required: false
neg_seq_46_base_amps:
name: neg_seq_46_base_amps
annotations:
order:
tag: order
value: 22
dss_name:
tag: dss_name
value: 46BaseAmps
description: Base current, Amps, for 46 relay (neg seq current)
from_schema: https://gridappsd.github.io/dss-graph/controls/relay
rank: 1000
owner: Relay
domain_of:
- Relay
range: float
required: false
pct_46_pickup:
name: pct_46_pickup
annotations:
order:
tag: order
value: 23
dss_name:
tag: dss_name
value: 46%Pickup
description: Percent pickup current for 46 relay (neg seq current)
from_schema: https://gridappsd.github.io/dss-graph/controls/relay
rank: 1000
owner: Relay
domain_of:
- Relay
range: float
required: false
neg_seq_46_isqt:
name: neg_seq_46_isqt
annotations:
order:
tag: order
value: 24
dss_name:
tag: dss_name
value: 46isqt
description: Negative Sequence I-squared-t trip value for 46 relay (neg seq current)
from_schema: https://gridappsd.github.io/dss-graph/controls/relay
rank: 1000
owner: Relay
domain_of:
- Relay
range: float
required: false
Variable:
name: Variable
annotations:
order:
tag: order
value: 25
description: Name of variable in PC Elements being monitored
from_schema: https://gridappsd.github.io/dss-graph/controls/relay
rank: 1000
owner: Relay
domain_of:
- Relay
range: string
required: false
overtrip:
name: overtrip
annotations:
order:
tag: order
value: 26
description: Trip setting (high value) for Generic relay variable
from_schema: https://gridappsd.github.io/dss-graph/controls/relay
rank: 1000
owner: Relay
domain_of:
- Relay
range: string
required: false
undertrip:
name: undertrip
annotations:
order:
tag: order
value: 27
description: Trip setting (low value) for Generic relay variable
from_schema: https://gridappsd.github.io/dss-graph/controls/relay
rank: 1000
owner: Relay
domain_of:
- Relay
range: string
required: false
Breakertime:
name: Breakertime
annotations:
order:
tag: order
value: 28
description: Fixed delay time (sec) added to relay time
from_schema: https://gridappsd.github.io/dss-graph/controls/relay
rank: 1000
owner: Relay
domain_of:
- Relay
range: float
required: false
action:
name: action
annotations:
order:
tag: order
value: 29
description: DEPRECATED
from_schema: https://gridappsd.github.io/dss-graph/controls/relay
rank: 1000
owner: Relay
domain_of:
- Relay
- Loadshape
- Priceshape
- Tshape
- Energymeter
- Fmonitor
- Monitor
- Sensor
range: string
required: false
Z1mag:
name: Z1mag
annotations:
order:
tag: order
value: 30
description: Positive sequence reach impedance in primary ohms for Distance and
TD21 functions
from_schema: https://gridappsd.github.io/dss-graph/controls/relay
rank: 1000
owner: Relay
domain_of:
- Relay
range: float
required: false
Z1ang:
name: Z1ang
annotations:
order:
tag: order
value: 31
description: Positive sequence reach impedance angle in degrees for Distance and
TD21 functions
from_schema: https://gridappsd.github.io/dss-graph/controls/relay
rank: 1000
owner: Relay
domain_of:
- Relay
range: float
required: false
Z0mag:
name: Z0mag
annotations:
order:
tag: order
value: 32
description: Zero sequence reach impedance in primary ohms for Distance and TD21
functions
from_schema: https://gridappsd.github.io/dss-graph/controls/relay
rank: 1000
owner: Relay
domain_of:
- Relay
range: float
required: false
Z0ang:
name: Z0ang
annotations:
order:
tag: order
value: 33
description: Zero sequence reach impedance angle in degrees for Distance and TD21
functions
from_schema: https://gridappsd.github.io/dss-graph/controls/relay
rank: 1000
owner: Relay
domain_of:
- Relay
range: float
required: false
Mphase:
name: Mphase
annotations:
order:
tag: order
value: 34
description: Phase reach multiplier in per-unit for Distance and TD21 functions
from_schema: https://gridappsd.github.io/dss-graph/controls/relay
rank: 1000
owner: Relay
domain_of:
- Relay
range: string
required: false
Mground:
name: Mground
annotations:
order:
tag: order
value: 35
description: Ground reach multiplier in per-unit for Distance and TD21 functions
from_schema: https://gridappsd.github.io/dss-graph/controls/relay
rank: 1000
owner: Relay
domain_of:
- Relay
range: string
required: false
EventLog:
name: EventLog
annotations:
order:
tag: order
value: 36
description: '{Yes/True* | No/False} Default is Yes for Relay'
from_schema: https://gridappsd.github.io/dss-graph/controls/relay
owner: Relay
domain_of:
- Capcontrol
- Expcontrol
- Invcontrol
- Regcontrol
- Relay
- Storagecontroller
range: string
required: false
DebugTrace:
name: DebugTrace
annotations:
order:
tag: order
value: 37
description: '{Yes/True* | No/False} Default is No for Relay'
from_schema: https://gridappsd.github.io/dss-graph/controls/relay
rank: 1000
owner: Relay
domain_of:
- Relay
range: string
required: false
DistReverse:
name: DistReverse
annotations:
order:
tag: order
value: 38
description: '{Yes/True* | No/False} Default is No; reverse direction for distance
and td21 types'
from_schema: https://gridappsd.github.io/dss-graph/controls/relay
rank: 1000
owner: Relay
domain_of:
- Relay
range: string
required: false
Normal:
name: Normal
annotations:
order:
tag: order
value: 39
description: '{Open | Closed} Normal state of the relay'
from_schema: https://gridappsd.github.io/dss-graph/controls/relay
owner: Relay
domain_of:
- Fuse
- Recloser
- Relay
- Swtcontrol
range: string
required: false
State:
name: State
annotations:
order:
tag: order
value: 40
description: '{Open | Closed} Actual state of the relay'
from_schema: https://gridappsd.github.io/dss-graph/controls/relay
owner: Relay
domain_of:
- Storage
- Fuse
- Recloser
- Relay
- Swtcontrol
range: string
required: false
DOC_TiltAngleLow:
name: DOC_TiltAngleLow
annotations:
order:
tag: order
value: 41
description: Tilt angle for low-current trip line
from_schema: https://gridappsd.github.io/dss-graph/controls/relay
rank: 1000
owner: Relay
domain_of:
- Relay
range: float
required: false
DOC_TiltAngleHigh:
name: DOC_TiltAngleHigh
annotations:
order:
tag: order
value: 42
description: Tilt angle for high-current trip line
from_schema: https://gridappsd.github.io/dss-graph/controls/relay
rank: 1000
owner: Relay
domain_of:
- Relay
range: float
required: false
DOC_TripSettingLow:
name: DOC_TripSettingLow
annotations:
order:
tag: order
value: 43
description: Resistive trip setting for low-current line
from_schema: https://gridappsd.github.io/dss-graph/controls/relay
rank: 1000
owner: Relay
domain_of:
- Relay
range: float
required: false
DOC_TripSettingHigh:
name: DOC_TripSettingHigh
annotations:
order:
tag: order
value: 44
description: Resistive trip setting for high-current line
from_schema: https://gridappsd.github.io/dss-graph/controls/relay
rank: 1000
owner: Relay
domain_of:
- Relay
range: float
required: false
DOC_TripSettingMag:
name: DOC_TripSettingMag
annotations:
order:
tag: order
value: 45
description: Trip setting for current magnitude (defines a circle in the relay
characteristics)
from_schema: https://gridappsd.github.io/dss-graph/controls/relay
rank: 1000
owner: Relay
domain_of:
- Relay
range: float
required: false
DOC_DelayInner:
name: DOC_DelayInner
annotations:
order:
tag: order
value: 46
description: Trip time delay (sec) for operation in inner region for DOC relay,
defined when "DOC_TripSettingMag" or "DOC_TripSettingHigh" are activate
from_schema: https://gridappsd.github.io/dss-graph/controls/relay
rank: 1000
owner: Relay
domain_of:
- Relay
range: string
required: false
DOC_PhaseCurveInner:
name: DOC_PhaseCurveInner
annotations:
order:
tag: order
value: 47
description: Name of the TCC Curve object that determines the phase trip for operation
in inner region for DOC relay
from_schema: https://gridappsd.github.io/dss-graph/controls/relay
rank: 1000
owner: Relay
domain_of:
- Relay
range: float
required: false
DOC_PhaseTripInner:
name: DOC_PhaseTripInner
annotations:
order:
tag: order
value: 48
description: Multiplier for the "DOC_PhaseCurveInner" TCC curve
from_schema: https://gridappsd.github.io/dss-graph/controls/relay
rank: 1000
owner: Relay
domain_of:
- Relay
range: string
required: false
DOC_TDPhaseInner:
name: DOC_TDPhaseInner
annotations:
order:
tag: order
value: 49
description: Time dial for "DOC_PhaseCurveInner" TCC curve
from_schema: https://gridappsd.github.io/dss-graph/controls/relay
rank: 1000
owner: Relay
domain_of:
- Relay
range: string
required: false
DOC_P1Blocking:
name: DOC_P1Blocking
annotations:
order:
tag: order
value: 50
description: '{Yes/True* | No/False} Blocking element that impedes relay from
tripping if balanced net three-phase active power is in the forward direction
(i'
from_schema: https://gridappsd.github.io/dss-graph/controls/relay
rank: 1000
owner: Relay
domain_of:
- Relay
range: float
required: false
basefreq:
name: basefreq
annotations:
order:
tag: order
value: 51
description: Base Frequency for ratings
from_schema: https://gridappsd.github.io/dss-graph/controls/relay
owner: Relay
domain_of:
- Load
- Generator
- Generic5
- Gicline
- Indmach012
- Pvsystem
- Storage
- Upfc
- Vccs
- Vsconverter
- Windgen
- Autotrans
- Capacitor
- Gictransformer
- Line
- Reactor
- Transformer
- Capcontrol
- Espvlcontrol
- Expcontrol
- Fuse
- Gendispatcher
- Invcontrol
- Pycontrol
- Recloser
- Regcontrol
- Relay
- Storagecontroller
- Swtcontrol
- Upfccontrol
- Energymeter
- Fmonitor
- Monitor
- Sensor
- Fault
- Gicsource
- Isource
- Vsource
range: float
required: false
enabled:
name: enabled
annotations:
order:
tag: order
value: 52
description: '{Yes|No or True|False} Indicates whether this element is enabled'
from_schema: https://gridappsd.github.io/dss-graph/controls/relay
owner: Relay
domain_of:
- Load
- Generator
- Generic5
- Gicline
- Indmach012
- Pvsystem
- Storage
- Upfc
- Vccs
- Vsconverter
- Windgen
- Autotrans
- Capacitor
- Gictransformer
- Line
- Reactor
- Transformer
- Capcontrol
- Espvlcontrol
- Expcontrol
- Fuse
- Gendispatcher
- Invcontrol
- Pycontrol
- Recloser
- Regcontrol
- Relay
- Storagecontroller
- Swtcontrol
- Upfccontrol
- Energymeter
- Fmonitor
- Monitor
- Sensor
- Fault
- Gicsource
- Isource
- Vsource
range: boolean
required: false
like:
name: like
annotations:
order:
tag: order
value: 53
description: Make like another object, e
from_schema: https://gridappsd.github.io/dss-graph/controls/relay
owner: Relay
domain_of:
- Load
- Generator
- Generic5
- Gicline
- Indmach012
- Pvsystem
- Storage
- Upfc
- Vccs
- Vsconverter
- Windgen
- Autotrans
- Capacitor
- Gictransformer
- Line
- Reactor
- Transformer
- Capcontrol
- Espvlcontrol
- Expcontrol
- Fuse
- Gendispatcher
- Invcontrol
- Pycontrol
- Recloser
- Regcontrol
- Relay
- Storagecontroller
- Swtcontrol
- Upfccontrol
- Cndata
- Dynamicexp
- Growthshape
- Linecode
- Linegeometry
- Linespacing
- Loadshape
- Priceshape
- Spectrum
- TccCurve
- Tsdata
- Tshape
- Wiredata
- Xfmrcode
- Xycurve
- Energymeter
- Fmonitor
- Monitor
- Sensor
- Fault
- Gicsource
- Isource
- Vsource
range: string
required: false
class_uri: dss:Relay