Documentation Home Page HYPERSIM Home Page
Pour la documentation en FRANÇAIS, utilisez l'outil de traduction de votre navigateur Chrome, Edge ou Safari. Voir un exemple.

1-Phase Circuit Breaker


The circuit breaker is simulated as a variable resistance; very low if the breaker is closed and very high if the breaker is open. It can be controlled either with internal timing or by an external source through a control signal or target digital input.

Table of Contents

Mask and Parameters

General Parameters

NameDescriptionUnitVariable = {Possible Values}
DescriptionUse this field to add all kinds of information about the component
Description = {'string'}
Control typeThe breakers' state can be controlled from any of the following sources

CmdBlockSelect = {0, 1, 3}

Internal {0}Internal control defined in the the Timing tab
External (input sensors) {1}Target digital input on CMD sensor
External (input pins) {3}Schematic control signal; binary
RopenOpen state resistance of phase breakersΩROpen = { [0, 1e12] }
RclosedClosed state resistance of phase breakersΩRClose = { [0, 1e12] }
Breaking capacityCurrent absolute value below which phase breakers are allowed to open; applies only when the selected model type is BreakerAImargin = { [0, 1e64] }
Base powerBase value pour PU conversionMVA totalpBase = { [1, 1e64] }
Base voltageBase value pour PU conversionkV rms LNvBase = { [1, 1e64] }
Base frequencyBase value pour PU conversionHzfBase = { [1, 1e64] }

Timing Parameters

NameDescriptionUnitVariable = {Possible Values}
Time unitsUnits applied to the programmed state transition operations

Ut = {s, ms, c}

Second {s}
All operations Tn are in seconds
Millisecond {ms}
All operations Tn are in milliseconds
Cycle {c}
All operations Tn are in electrical cycles (setting the frequency is mandatory)
General operationMaster switch that determines whether the programmed operations will occur upon triggering an acquisition

EnaGen = {0, 1}

Disable {0}
Programmed operations are disabled
Enable {1}
Programmed operations are enabled
Steady-state condition
State of breaker in steady-state; “colored” if the breaker is open and “grey” if the breaker is closed

EtatIniA = {0, 1}

Network frequency
Legacy. Should be set using the parameter "Base frequency".HzFreq = { [45, 70] }
Model typeDetermine whether the component acts as a switch or as a breaker

TypeA = {0, 1}

Breaker {0}Once the time condition is met, the breaker waits for the current to cross the breaking capacity before changing its state
Switch {1}
The state of the switch changes as soon as the time condition is met
EnableEnable/disable the state transition operation on the same line.

EnaT1 = {0, 1}

EnaT2 = {0, 1}


Disable {0}
Disable the state transition operation on the same line
Enable {1}
Enable the state transition operation on the same line. If the line is enabled but no information is filled, the state transition operation is ignored.

Relative time (with respect to POW synchronization) when the command is sent to the breaker (or switch) to change state. There are four ways to input this time.

Important notes:

  • For changes of state to occur, programmed operation times must always respect Tn>Tn-1.
  • If a parameter field is blank or contains “-”, no switching will occur for this line.
  • There is no alias for the type of timing in the API. The timing type and values are entered as a single string.
  • If using referenced operations, the calculated time is applied after it received the command from the other component. See the Referenced Operations section for more information.

Refer to "Time units" parameter

T1 = {'string'}

T2 = {'string'}



(f: fixed time)

At each acquisition, Tn command is sent at the same time.


(i: initial time/final time/time increment)

For the first acquisition, Tn command is sent at the set initial time. Then at each acquisition, Tn command is sent a time increment later than the previous acquisition. Once the final time is reached, the next acquisition will be done using the initial time again.


(u: minimal time/maximal time)

At each acquisition, Tn command is sent at a random time. The probability is uniform over the specified range.

Uniform gaussian

(ug: minimal time/maximal time/ dispersion)

At each acquisition, Tn command is sent at a random time. The probability follows a gaussian distribution over the specified range.

Referenced operations

Use to refer the triggering of Tn to another breaker programmed state transition. See the Referenced Operations section for more information.

NB: all columns must be filled for the referenced operation to work.

ComponentName (or path) of the breaker to which the timing is referenced

Eref1 = {''}

Eref2 = {''}


TimeTime Tn ID of the referenced breaker's step to which the timing is referenced

Tref1 = {Tn}

Tref2 = {Tn}


Phase/CommandActivate (Phase) or deactivate (Command) the reference dependency

T1RPh = {0, 1}

T2RPh = {0, 1}


Ports, Inputs, Outputs and Signals Available for Monitoring


Net_1Network connection; the "+" indicates the current measurement direction (supports only 1-phase connections)
Net_2Network connection (supports only 1-phase connections)


PControl input for the breaker command




CMDBreaker command
IBreaker currentA
PControl input for the breaker command; binary
STATEBreaker state (may differ from the command based on the "Model type" parameter)

OPAL-RT TECHNOLOGIES, Inc. | 1751, rue Richardson, bureau 1060 | Montréal, Québec Canada H3K 1G6 | | +1 514-935-2323