> 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-1-phase.md).

# Circuit Breaker, 1-Phase

## Description

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

The **Circuit Breaker** 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 a control signal or a simulator digital input.

## Mask parameters

<figure><img src="https://3623212549-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLxgTpoh7kyPmQ5vuyqD7%2Fuploads%2Fgit-blob-8f182f66986f40e273924f2af07a446b75d98ce8%2FCB1.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}.</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>Determines whether the device acts as a breaker or as a switch, TypeA = {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>Change of state when the timing condition is reached.</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>Internal {0}: Control defined in the Timing tab.</li><li>External (input sensors) {1}: Simulator digital input on CMD sensor.</li><li>External (input pins) {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 %}

## Conservating ports <a href="#conservating-ports" id="conservating-ports"></a>

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

## Inputs <a href="#inputs" id="inputs"></a>

<table><thead><tr><th width="209.20001220703125">Input</th><th>Description</th></tr></thead><tbody><tr><td><strong>P</strong></td><td>Control input for the breaker command</td></tr></tbody></table>

## Outputs <a href="#outputs" id="outputs"></a>

This block has no outputs.

## Signals available for monitoring and external I/O connections (via sensors form) <a href="#signals-available-for-monitoring-and-external-i-o-connections-via-sensors-form" id="signals-available-for-monitoring-and-external-i-o-connections-via-sensors-form"></a>

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="209.20001220703125">Input</th><th>Description</th></tr></thead><tbody><tr><td><strong>CMD</strong></td><td>Breaker command</td></tr><tr><td><strong>I</strong></td><td>Breaker current (A)</td></tr><tr><td><strong>Psw</strong></td><td>Instantaneous apparent power measured at positive port of the breaker (VA)</td></tr><tr><td><strong>STATE</strong></td><td>Breaker state (may differ from the command based on the "Model type" parameter)</td></tr><tr><td><strong>V</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-1-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.
