> 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/components/devicesimple1.md).

# DeviceSimple1

## `DeviceSimple1` (FB)

FUNCTION\_BLOCK DeviceSimple1

### Short description

### Representation

<figure><img src="https://2592874069-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FQR4vCFzt6ixgsqlR3pdR%2Fuploads%2Frp2wEnuxxFz0q2O1Rqzk%2FDeviceSimple1.png?alt=media&amp;token=4e9ac910-9515-4d9f-9cb4-244627fd2237" alt=""><figcaption></figcaption></figure>

### Interfaces

#### Inputs

| Name       | Data type         | Value range                                                               | Initial value          | Function                                         |
| ---------- | ----------------- | ------------------------------------------------------------------------- | ---------------------- | ------------------------------------------------ |
| *xEn*      | BOOL              |                                                                           |                        | Circulation pump request                         |
| *xForce*   | BOOL              |                                                                           | FALSE                  | Forced override after manual override            |
| *xFb*      | BOOL              |                                                                           |                        | Operating message of the circulation pump        |
| *xAlarmIn* | BOOL              |                                                                           |                        | Fault message of the circulation pump            |
| *eAOO*     | HVACTYPES.eManBin | HVACTYPES.eManBin.Auto, HVACTYPES.eManBin.ManOff, HVACTYPES.eManBin.ManOn | HVACTYPES.eManBin.Auto | Operating mode of the manual override - hardware |
| *xQuit*    | BOOL              |                                                                           | FALSE                  | Reset of the operating supervision fault message |

#### Outputs

| Name                | Data type       | Value range | Initial value | Function                                                                                                                                                               |
| ------------------- | --------------- | ----------- | ------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| *xHB*               | BOOL            |             |               | <p>\* <strong>FALSE:</strong><br>Manual output: circulation pump not enabled<br>\* <strong>TRUE:</strong><br>Manual output: circulation pump enabled</p>               |
| *xAB*               | BOOL            |             |               | <p>\* <strong>FALSE:</strong><br>Automatic output: circulation pump not enabled<br>\* <strong>TRUE:</strong><br>Automatic output: circulation pump enabled</p>         |
| *xEnergyRequest*    | BOOL            |             |               | <p>\* <strong>FALSE:</strong><br>Energy generation request not enabled<br>\* <strong>TRUE:</strong><br>Energy generation request enabled</p>                           |
| *xAlarmFb*          | BOOL            |             |               | <p>\* <strong>FALSE:</strong><br>Operating supervision fault message not enabled<br>\* <strong>TRUE:</strong><br>Operating supervision fault message enabled</p>       |
| *tOffDelay*         | TIME            |             |               | Remaining run-on time of the circulation pump                                                                                                                          |
| *dtLastFb*          | DATE\_AND\_TIME |             |               | Date / time of the last operation of the circulation pump                                                                                                              |
| *dtAbsLastOn*       | DATE\_AND\_TIME |             |               | Date / time of the last anti-blocking operation                                                                                                                        |
| *udiOperatingHours* | UDINT           |             |               | Operating hours of the circulation pump                                                                                                                                |
| *udiCountFb*        | UDINT           |             |               | Number of pump switch-ons                                                                                                                                              |
| *xAlarm*            | BOOL            |             |               | <p>\* <strong>FALSE:</strong><br>Collective fault message not enabled<br>\* <strong>TRUE:</strong><br>Collective fault message enabled</p>                             |
| *xAuto*             | BOOL            |             |               | <p>\* <strong>FALSE:</strong><br>Collective automatic operation message not enabled<br>\* <strong>TRUE:</strong><br>Collective automatic operation message enabled</p> |

#### Setpoints / Parameters

| Name                  | Data type | Value range                                 | Initial value | Function                                                                                                                                                                   |
| --------------------- | --------- | ------------------------------------------- | ------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **xAlarmControl**     | BOOL      |                                             | FALSE         | <p>\* <strong>FALSE:</strong><br><em>xHb</em> from <em>xAlarm</em> independent<br>\* <strong>TRUE:</strong><br><em>xHb</em> is when <em>xAlarm</em> locked when = TRUE</p> |
| **udiFbControlTime**  | UDINT     | 0 … 300s                                    | 60s           | Duration of the operating supervision                                                                                                                                      |
| **xFbControl**        | BOOL      |                                             | TRUE          | <p>\* <strong>FALSE:</strong><br>Operating supervision not enabled<br>\* <strong>TRUE:</strong><br>Operating supervision enabled</p>                                       |
| **xForceOption**      | BOOL      |                                             | TRUE          | <p>\* <strong>FALSE:</strong><br>Output <em>xHB</em> with forced override OFF<br>\* <strong>TRUE:</strong><br>Output <em>xHB</em> with forced override ON</p>              |
| **tAbsTime**          | UDINT     | 0 … 600s                                    | 120s          | Duration of the anti-blocking operation                                                                                                                                    |
| **tAbsTime**          | TOD       | 00:00:00 - 23:59:59                         | 08:00:00      | Time of the anti-blocking operation                                                                                                                                        |
| **eAbsDay**           | eDoW      | eDoW\.Monday … eDoW\.Sunday                 | eDoW\.Monday  | Day of the week of the anti-blocking operation                                                                                                                             |
| **eOffDelayTimeBase** | eTime     | eTime.Second, eTime.Minute, eTime.Hour      | eTime.Second  | Scaling of the run-on time (seconds / minutes / hours)                                                                                                                     |
| **udiOffDelay**       | UDINT     | 0 … 60min                                   | 120s          | Run-on time duration of the circulation pump                                                                                                                               |
| **eManModeB**         | eMANBIN   | eMANBIN.Auto, eMANBIN.ManOff, eMANBIN.ManOn | eMANBIN.Auto  | Operating mode of the manual override for the digital output *xHB*                                                                                                         |

### Functional description

#### Automatic output *xAB*

The digital automatic output *xAB* is influenced by the input *xEn*, the output *xAlarm*, the run-on module and the anti-blocking protection module.

| *xEn* | *xAlarm* | *xAlarmControl* | Run-on module | Anti-blocking protection module | *xAB* | Notes                                 |
| ----- | -------- | --------------- | ------------- | ------------------------------- | ----- | ------------------------------------- |
| X     | TRUE     | TRUE            | X             | X                               | FALSE | Shutdown via collective fault enabled |
| FALSE | X        | FALSE           | FALSE         | FALSE                           | FALSE | Automatic operation Off               |
| TRUE  | x        | FALSE           | FALSE         | FALSE                           | TRUE  | Automatic operation On                |
| X     | X        | FALSE           | TRUE          | X                               | TRUE  | Run-on operation                      |
| X     | x        | FALSE           | X             | TRUE                            | TRUE  | Anti-blocking operation               |

Legend: X = any\
\
With the parameter *xAlarmControl* the behavior of the output can *xAB* be influenced in the event of a fault.\
If *xAlarmControl* = TRUE, in the event of a fault (*xAlarm* = TRUE) the automatic output *xAB* is switched off; if the manual override module is in automatic mode, then the output *xHB* is also switched off.\
If *xAlarmControl* = FALSE, there is no reaction.

#### Manual output *xHB*

The digital manual output *xHB* corresponds to the digital automatic output *xAB*, additionally extended by a manual override module and by a forced override.

| *xAB* | eMANBIN        | *xForce* | **xForceOption** | *xHB* | Notes                                     |
| ----- | -------------- | -------- | ---------------- | ----- | ----------------------------------------- |
| FALSE | eMANBIN.Auto   | FALSE    | X                | FALSE | Manual override module in automatic mode  |
| TRUE  | eMANBIN.Auto   | FALSE    | X                | TRUE  | Manual override module in automatic mode  |
| X     | eMANBIN.ManOn  | FALSE    | X                | TRUE  | Manual override module in manual mode On  |
| X     | eMANBIN.ManOff | FALSE    | X                | FALSE | Manual override module in manual mode Off |
| X     | X              | TRUE     | FALSE            | FALSE | Forced override Off                       |
| X     | X              | TRUE     | TRUE             | TRUE  | Forced override On                        |

Legend: X = any

#### Request - energy generation *xEnergyRequest*

The digital output *xEnergyRequest* is influenced by the input *xFb*, the run-on module and the anti-blocking protection module.

| *xFB* | Run-on module | Anti-blocking protection module | *xEnergyRequest* | Notes                                           |
| ----- | ------------- | ------------------------------- | ---------------- | ----------------------------------------------- |
| FALSE | X             | X                               | FALSE            | Circulation pump is not in operation            |
| TRUE  | FALSE         | FALSE                           | TRUE             | Circulation pump is in operation                |
| TRUE  | TRUE          | X                               | FALSE            | Run-on module is in operation                   |
| TRUE  | X             | TRUE                            | FALSE            | Anti-blocking protection module is in operation |

Legend: X = any

#### Run-on module

The run-on module is implemented by a switch-off delay with adjustable duration. The input of the run-on module is active if the enable ‘xEn’ is active and at the same time the collective fault message *xAlarm* is not active.

#### Anti-blocking protection module

The anti-blocking protection module is implemented by the binary anti-blocking protection module with adjustable duration.\
The duration *tAbsTime*, the time **tAbsTime** and the weekday **eAbsDay** are adjustable.\
The timestamp (date / time) of the last anti-blocking operation *dtAbsLastOn* is available.

#### Output *xAlarm*

| *xAlarmIn* | *xAlarmFb* | *xAlarm* | Notes                                 |
| ---------- | ---------- | -------- | ------------------------------------- |
| FALSE      | FALSE      | FALSE    | Collective fault is inactive          |
| TRUE       | FALSE      | TRUE     | External hardware fault is active     |
| FALSE      | TRUE       | TRUE     | Operating supervision fault is active |
| TRUE       | TRUE       | TRUE     | Both faults are active                |

Legend: X = any

#### Collective automatic operation message *xAuto*

The collective automatic operation message *xAuto* is activated (= TRUE) if the input *eAOO* contains the value HVACTYPES.eManBin.Auto and the setpoint / parameter **eManModeB** contains the value eMANBIN.Auto.\
In all other cases, the collective automatic operation message *xAuto* is not activated (= FALSE).

#### Forced override *xForce*

The forced override acts directly on the output *xHB*. With the parameter **xForceOption** it is determined which state the output *xHB* assumes when TRUE is at the input *xForce* .

#### Operating hours counter

The operating hours counter is active if the circulation pump is in operation (*xFb* = TRUE) and at the same time the collective fault *xAlarm* is not active (*xAlarm* = FALSE).\
The number of operating hours **udiOperatingHours**, and the number of switch-ons **udiCountFb** are output at the corresponding outputs.\
The timestamp (date / time) of the operation of the circulation pump *dtLastFb* is available.

> **Write access to the counter values**
>
> Via the path ‘InstanceName.\_OperatingHours.udiOperatingHours’ or ‘InstanceName.\_OperatingHours.udiCountFb’, write access to both counter values is possible.

#### Operating supervision

The operating supervision monitors the proper function of the circulation pump.\
The supervision can generally be enabled (**xFbControl** = TRUE) or locked (**xFbControl** = FALSE).\
Automatic operation of the circulation pump must also be active (*eAOO* = HVACTYPES.eManBin.Auto).\
\
The input *xFb* and the output *xHB* are continuously compared with each other.\
If the states are always different during an adjustable period of time **udiFbControlTime** always unequal (i.e. pump enabled but no operating feedback), then the fault message of the operating supervision *xAlarmFb* is activated.\
\
The fault message of the operating supervision *xAlarmFb* is reset if the enable of the supervision **xFbControl** is locked, or the reset input *xQuit* is active, or automatic operation of the circulation pump (*eAOO* = HVACTYPES.eManBin.Auto) is activated.

### Visualization

#### Representation

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

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

#### Interfaces visualization element

| Name          | Data type | Type         | Initial value | Function                                                                                                                                                                                               |
| ------------- | --------- | ------------ | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| **FB\_Pump**  | Pump      | VAR\_IN\_OUT |               | Enter FB Pump here, e.g. PRG.Pump                                                                                                                                                                      |
| **rRotation** | INT       | VAR\_INPUT   |               | The rotation of the pump graphic can be entered here as a degree value. E.g. 90 corresponds to a rotation of 90 degrees to the right. -90 degrees corresponds to a rotation of 90 degrees to the left. |

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

{% hint style="info" %}
Note: VAR\_IN\_OUT interfaces must be assigned; VAR\_INPUT is optional.
{% endhint %}

### CODESYS

InOut:

| Scope       | Name        | Type    | Initial      |
| ----------- | ----------- | ------- | ------------ |
| Input       | `xEn`       | `BOOL`  |              |
| Input       | `eAOO`      | eManBin | eManBin.Auto |
| Output      | `xHB`       | `BOOL`  |              |
| Output      | `xAB`       | `BOOL`  |              |
| Output      | `xAuto`     | `BOOL`  |              |
| Input Const | `eManModeB` | eMANBIN | eMANBIN.Auto |


---

# 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/components/devicesimple1.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.
