> For the complete documentation index, see [llms.txt](https://support.powerio.com/hub/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://support.powerio.com/hub/codesys-hvac/en/hvac-library/functionblocks/button/buttontoggle.md).

# ButtonToggle

## `ButtonToggle` (FB)

FUNCTION\_BLOCK ButtonToggle

### Short description

> Switching element with pushbutton and central control.\
> Typical application: light pushbutton and light output.

### Representation

<figure><img src="https://2592874069-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FQR4vCFzt6ixgsqlR3pdR%2Fuploads%2Fgit-blob-f3ba70e5f13e4fc63a147778782dcc38c344b4b1%2FButtonToggle_FB.png?alt=media" alt=""><figcaption></figcaption></figure>

### Interfaces

#### Inputs

| Name          | Data type | Value range | Initial value | Function                 |
| ------------- | --------- | ----------- | ------------- | ------------------------ |
| *xButton*     | BOOL      |             |               | Input - operating button |
| *xCentralOn*  | BOOL      |             |               | Central switch-on        |
| *xCentralOff* | BOOL      |             |               | Central switch-off       |

#### Outputs

| Name   | Data type | Value range | Initial value | Function        |
| ------ | --------- | ----------- | ------------- | --------------- |
| *xOut* | BOOL      |             |               | Enable - Output |

#### Setpoints / Parameters

| Name            | Data type | Value range | Initial value | Function                |
| --------------- | --------- | ----------- | ------------- | ----------------------- |
| **xButtonVisu** | BOOL      |             | FALSE         | Function like *xButton* |

### Functional description

#### General

The function block is generally used for the direct control of the enable output *xOut* depending on the rising edges at the inputs *xButton* (= operating button), *xCentralOn* (= central switch-on), *xCentralOff* (= central switch-off) and the setpoint / parameter **xButtonVisu**.\
Each rising edge at the input - operating button *xButton* and / or at the setpoint / parameter **xButtonVisu** switches the output *xOut* to the opposite state, provided no central operation takes place.\
If no rising edges are detected, the state of the enable output *xOut* does not change.

#### Function table

| *xButton* or **xButtonVisu** | *xCentralOn*     | *xCentralOff*    | *xOut*                     | Note                                  |
| ---------------------------- | ---------------- | ---------------- | -------------------------- | ------------------------------------- |
| FALSE, TRUE, H/L             | FALSE, TRUE, H/L | FALSE, TRUE, H/L | unchanged                  | Inputs not active                     |
| L/H                          | FALSE, TRUE, H/L | FALSE, TRUE, H/L | FALSE > TRUE, TRUE > FALSE | State change at the output            |
| FALSE, TRUE, H/L             | L/H              | FALSE, TRUE, H/L | TRUE                       | Central switch-on                     |
| FALSE, TRUE, H/L             | FALSE, TRUE, H/L | L/H              | FALSE                      | Central switch-off                    |
| L/H                          | L/H              | FALSE, TRUE, H/L | TRUE                       | Central switch-on (higher priority)   |
| L/H                          | L/H              | L/H              | FALSE                      | Central switch-off (highest priority) |

Legend: L/H … rising edge, H/L … falling edge

### CODESYS

InOut:

| Scope       | Name          | Type   | Initial |
| ----------- | ------------- | ------ | ------- |
| Input       | `xButton`     | `BOOL` |         |
| Input       | `xCentralOn`  | `BOOL` |         |
| Input       | `xCentralOff` | `BOOL` |         |
| Input Const | `xButtonVisu` | `BOOL` | FALSE   |
| Output      | `xOut`        | `BOOL` |         |


---

# 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://support.powerio.com/hub/codesys-hvac/en/hvac-library/functionblocks/button/buttontoggle.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.
