> For the complete documentation index, see [llms.txt](https://www.opal-rt.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://www.opal-rt.com/docs/hypersim/library-blocks-reference/network-switches-and-breakers/circuit-breaker-3-phase.md).

# Circuit Breaker, 3-Phase

## Description

<figure><img src="https://3623212549-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLxgTpoh7kyPmQ5vuyqD7%2Fuploads%2Fgit-blob-26be7c8361fa3285794d8d6323a8569cb2ce7d27%2Fimage%20(1082).png?alt=media" alt="" width="96"><figcaption></figcaption></figure>

The **Circuit Breaker 3-Phase** block, located in the **Network Switches and Breakers** library, is simulated as a variable resistance: very low when closed and very high when open. It can be controlled by internal timing or by an external source through control signals or simulator digital inputs.

For a breaker, all phases receive the command simultaneously, but each phase changes state when its current crosses the breaking capacity; this difference between CMD and STATE is visible when opening (closing occurs at zero current).

The circuit breaker can be controlled with the external pin.

<details>

<summary><strong>Using the Input Pin</strong></summary>

The input signal is of integer type and is internally converted to a logic value for all phases:

Input=0 -> State open ; Input=1 -> State close

| Input | C | B | A |     |
| ----- | - | - | - | --- |
| 0     | 0 | 0 | 0 |     |
| 1     | 0 | 0 | 1 | A   |
| 2     | 0 | 1 | 0 | B   |
| 3     | 0 | 1 | 1 | AB  |
| 4     | 1 | 0 | 0 | C   |
| 5     | 1 | 0 | 1 | AC  |
| 6     | 1 | 1 | 0 | BC  |
| 7     | 1 | 1 | 1 | ABC |

</details>

### Using Referenced Operations <a href="#using-referenced-operations" id="using-referenced-operations"></a>

It is possible to trigger T<sub>n</sub> when another breaker's programmed state transition has been triggered. In this case, the effective state transition occurrence is given by summing the referenced component referenced operation time, the locally programmed operation time and the delay related to waiting for the current to drop below the breaking capacity (for the breaker model type only).

\
In the example below, the breaker Di1 refers to the breaker Di2.

For T1

* At 0.1 s, the command is sent for phases B and C of Di1 and phases A,B and C of Di2 to open, what they will do as soon as the current drops below the breaking capacity.
* Phase A of Di1 will remain closed.

For T2

* Di2 will fully reclose at 0.2 s.
* Di1 will wait for Di2.T1, which happened at 0.1 s, and will send the change command at a random time between 0.1 and 0.4 s. Thus the effective change command will occur in the range \[0.1+0.1, 0.1+0.4].
* Still, phase A still being closed, it'll wait for the current to drop below the breaking capacity before changing, whereas phases B and C will reclose as soon as the command is received.

In ScopeView, let's look at all sensors for the 2 breakers, and apply the following acquisition parameters :

<figure><img src="https://3623212549-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLxgTpoh7kyPmQ5vuyqD7%2Fuploads%2Fgit-blob-0fd712b051473dbf673b1dcf490087964b4ceae2%2Fimage%20(446).png?alt=media" alt=""><figcaption></figcaption></figure>

Once an acquisition is triggered, the following results are obtained:

<figure><img src="https://3623212549-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLxgTpoh7kyPmQ5vuyqD7%2Fuploads%2Fgit-blob-c362b160d93420a2b8c67e7c3f28266c17afc7dd%2Fimage%20(447).png?alt=media" alt=""><figcaption></figcaption></figure>

Here are some observations :

* The *CMD* entries show when the command was sent to the breaker. Therefore, the transition is immediate from 1 to 0.
* The *STATE* entries show the effective state changes that depend on the "Model type" parameter. Therefore:
  * If the device is configured as a switch, *STATE = CMD*
  * If the device is configured as a breaker, all phases receive the command at the same time, but they wait for their value to reach the breaking capacity parameter, thus the small time difference for each phase
* This difference between *CMD* and *STATE* is only visible when open a breaker (as when closing, the current is always 0)
* The times are respected as stated above, Di2 opens and closes at 0.1 and 0.2, whereas Di1 opens at 0.1, and closed at 0.305s.
* The phase A of Di1 does not act like Di1's other phases. It has the opposite behaviour, i.e. closes when the other phases open and vice versa. It could be possible to synchronize them again by adding another step where only phase A would change.

## Mask parameters

<figure><img src="https://3623212549-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLxgTpoh7kyPmQ5vuyqD7%2Fuploads%2Fgit-blob-d68ab9c61962d4a5137de37b2ce89f20dc1efc7f%2FCB3.jpg?alt=media" alt=""><figcaption></figcaption></figure>

{% tabs %}
{% tab title="Timing" %}

<table><thead><tr><th width="201.79998779296875" valign="top">Parameter</th><th>Description</th></tr></thead><tbody><tr><td valign="top"><strong>Time units</strong></td><td><p>Units applied to the programmed state-transition operations, Ut = {s, ms, c}.</p><ul><li>Second {s}: All operations T<sub>n</sub> are in seconds.</li><li>Millisecond {ms}: All operations T<sub>n</sub> are in milliseconds.</li><li>Cycle {c}: All operations T<sub>n</sub> are in electrical cycles (set the frequency).</li></ul></td></tr><tr><td valign="top"><strong>General operation</strong></td><td><p>Master switch enabling programmed operations upon acquisition trigger, EnaGen = {0, 1}.</p><ul><li>Disable {0}: Programmed operations are disabled.</li><li>Enable {1}: Programmed operations are enabled.</li></ul></td></tr><tr><td valign="top"><strong>Steady-state condition</strong></td><td>Steady-state breaker position (open or closed), EtatIniA = {0, 1}, EtatIniB = {0, 1}, EtatIniC = {0, 1}.</td></tr><tr><td valign="top"><strong>Network frequency</strong></td><td>Legacy parameter; set frequency using Base frequency (Hz), Freq = [45, 70].</td></tr><tr><td valign="top"><strong>Model type</strong></td><td><p>For each phase, determines whether the device acts as a breaker or as a switch, TypeA = {0, 1}, TypeB = {0, 1}, TypeC = {0, 1},</p><ul><li><strong>Breaker</strong> {0}: After the time condition is met, the breaker waits for the current to cross the breaking capacity before changing state.</li><li><strong>Switch</strong> {1}: The state changes as soon as the time condition is met.</li></ul></td></tr><tr><td valign="top"><strong>Enable</strong></td><td><p>Enable/disable each state-transition operation line, EnaT1, EnaT2, ... = {0, 1}.</p><ul><li>Disable {0}: The operation on that line is disabled.</li><li>Enable {1}: The operation on that line is enabled. If a line is enabled but no information is provided, the operation is ignored.</li></ul></td></tr><tr><td valign="top"><strong>Time</strong></td><td><p>Relative time (with respect to POW synchronization) when the command is sent to change state. Timing type and values are entered as a single string (no alias in the API).</p><ul><li><strong>Fixed</strong>: <em>f: fixed time</em>. At each acquisition, T<sub>n</sub> occurs at the same time.</li><li><strong>Incremental</strong>: <em>i: initial time/final time/time increment</em>. First acquisition at initial time; subsequent acquisitions occur after the increment until final time, then wrap to initial.</li><li><strong>Uniform</strong>: <em>u: minimal time/maximal time</em>. Random time with uniform probability in the range.</li><li><strong>Uniform gaussian</strong>: <em>ug: minimal time/maximal time/dispersion</em>. Random time with gaussian probability in the range.</li></ul><p>Important notes:</p><ul><li>Times must satisfy: <span class="math">T_n > T_{n-1}</span></li><li>If a parameter field is blank or contains “-”, no switching will occur for this line.</li><li>There is no alias for the type of timing in the API. The timing type and values are entered as a single string.</li><li>If using referenced operations, the calculated time is applied after it received the command from the other component.</li></ul></td></tr><tr><td valign="top"><strong>Component</strong></td><td>Name (or path) of the breaker to which the timing is referenced</td></tr><tr><td valign="top"><strong>Referenced operations Time</strong></td><td>Time T<sub>n</sub> ID of the referenced breaker's step to which the timing is referenced</td></tr><tr><td valign="top"><strong>Phase/Command</strong></td><td>Activate (Phase) or deactivate (Command) the reference dependency</td></tr><tr><td valign="top"><strong>Phase operated</strong></td><td>The list of all phases that will change state when the timing condition is reached. So if after T<sub>n-1</sub> the A and C phases are OFF and T<sub>n</sub> triggers B and C, after T<sub>n</sub> phases A and B will be OFF, and C will be ON<br>On: Colored; OFF: Grayed out</td></tr><tr><td valign="top"><strong>Single Trig</strong></td><td></td></tr></tbody></table>
{% endtab %}

{% tab title="General" %}

<table><thead><tr><th width="169.79998779296875">Parameter</th><th>Description</th></tr></thead><tbody><tr><td><strong>Description</strong></td><td>Free-text field for documenting the block.</td></tr><tr><td><strong>Control type</strong></td><td><p>Select the source for the breaker state command,CmdBlockSelect = {0, 1, 3}.</p><ul><li><strong>Internal</strong> {0}: Control defined in the Timing tab.</li><li><strong>External (input sensors)</strong> {1}: Simulator digital input on CMD(a,b,c) sensor.</li><li><strong>External (input pins)</strong> {3}: Schematic control signal; binary.</li></ul></td></tr><tr><td><strong>Ropen</strong></td><td>Open-state resistance of the breaker (Ω) ROpen = [0, 1e12].</td></tr><tr><td><strong>Rclosed</strong></td><td>Closed-state resistance of the breaker (Ω) RClose = [0, 1e12].</td></tr><tr><td><strong>Current chopping limit</strong></td><td>Absolute current threshold below which the breaker is forced to open (current chopping) (A), Imargin = [0, 1e64].<br>Applies only when Model type = Breaker.</td></tr><tr><td><strong>Base power</strong></td><td>Base value for per-unit conversion (MVA total), pBase = [1, 1e64].</td></tr><tr><td><strong>Base voltage</strong></td><td>Base value for per-unit conversion (kV rms LN), vBase = [1, 1e64].</td></tr><tr><td><strong>Base frequency</strong></td><td>Base value for per-unit conversion (Hz). fBase = [1, 1e64].</td></tr></tbody></table>
{% endtab %}
{% endtabs %}

## Conserving ports

<table><thead><tr><th width="221.199951171875">Port</th><th>Description</th></tr></thead><tbody><tr><td><strong>Net_1</strong></td><td>Network connection; “+” indicates current measurement direction (supports 3-phase connections only).</td></tr><tr><td><strong>Net_2</strong></td><td>Network connection (supports 3-phase connections only).</td></tr></tbody></table>

## Inputs

<table><thead><tr><th width="219.60003662109375">Input</th><th>Description</th></tr></thead><tbody><tr><td>P</td><td>Control input for all phase breaker commands.<br>The received integer is converted to a binary string where each digit corresponds to a phase; the most significant bit (MSB) corresponds to phase C and the least significant bit (LSB) to phase A.</td></tr></tbody></table>

## Outputs

This block has no outputs.

## Signals available for monitoring and external I/O connections (via sensors form)

All block inputs and outputs are available as signals for monitoring and for external I/O connections.

Additional signals are also available and are listed below with their descriptions.

<table><thead><tr><th width="199.5999755859375">Signal</th><th>Description</th></tr></thead><tbody><tr><td><strong>CMD(a,b,c)</strong></td><td>Phase breaker commands.</td></tr><tr><td><strong>I(a,b,c)</strong></td><td>Phase breaker currents (A).</td></tr><tr><td><strong>Psw(a,b,c)</strong></td><td>Instantaneous apparent power measured at the positive port of the breaker for each phase (VA).</td></tr><tr><td><strong>STATE(a,b,c)</strong></td><td>Phase breaker states (may differ from commands depending on the “Model type” parameter).</td></tr><tr><td><strong>V(a,b,c)</strong></td><td>Phase breaker voltage (V).</td></tr></tbody></table>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://www.opal-rt.com/docs/hypersim/library-blocks-reference/network-switches-and-breakers/circuit-breaker-3-phase.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
