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

# ValveTherm

## `ValveTherm` (FB)

FUNCTION\_BLOCK ValveTherm

### Short description

> Control of a thermal actuator with anti-seize function\
> \
> Typical application: valve actuator on a radiator

### Representation

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

### Interfaces

#### Inputs

| Name       | Data type         | Value range                                                               | Initial value          | Function                                         |
| ---------- | ----------------- | ------------------------------------------------------------------------- | ---------------------- | ------------------------------------------------ |
| *xY*       | BOOL              |                                                                           |                        | Requirement                                      |
| *xForce*   | BOOL              |                                                                           | FALSE                  | Forced override after manual override            |
| *xAlarmIn* | BOOL              |                                                                           | FALSE                  | Actuator fault message                           |
| *eAOO*     | HVACTYPES.eManBin | HVACTYPES.eManBin.Auto, HVACTYPES.eManBin.ManOff, HVACTYPES.eManBin.ManOn | HVACTYPES.eManBin.Auto | Operating mode of the manual override - hardware |

#### Outputs

| Name             | Data type       | Value range | Initial value | Function                                        |
| ---------------- | --------------- | ----------- | ------------- | ----------------------------------------------- |
| *xHB*            | BOOL            |             |               | Enable after manual override                    |
| *xAB*            | BOOL            |             |               | Enable before manual override                   |
| *xEnergyRequest* | BOOL            |             |               | Request - energy generation                     |
| *dtAbsLastOn*    | DATE\_AND\_TIME |             |               | Date / time of the last anti-blocking operation |
| *xAuto*          | BOOL            |             |               | Collective automatic operation message          |

#### Setpoints / Parameters

| Name                | Data type | Value range                                 | Initial value | Function                                        |
| ------------------- | --------- | ------------------------------------------- | ------------- | ----------------------------------------------- |
| **udiAbsTime**      | UDINT     | 0 … 600s                                    | 200s          | Duration of anti-seize operation in seconds     |
| **todAbsStartTime** | TOD       | 00:00:00 - 23:59:59                         | 09:00:00      | Time of the anti-blocking operation             |
| **eAbsDay**         | eDoW      | eDow\.Inactive, eDoW\.Monday … eDoW\.Sunday | eDoW\.Monday  | Day of the week of the anti-blocking operation  |
| **xForceOption**    | BOOL      |                                             | TRUE          | State of the output *xHB* under forced override |
| **eManModeB**       | eMANBIN   | eMANBIN.Auto, eMANBIN.Off, eMANBIN.On       | eMANBIN.Auto  | Operating mode of the manual override           |

### Functional description

#### Enable before manual override *xAB*

The output Enable before manual override *xAB* is influenced by the input *xY* and the anti-blocking protection module.

| *xY*  | Anti-blocking protection module | *xAB* | Notes                                                      |
| ----- | ------------------------------- | ----- | ---------------------------------------------------------- |
| TRUE  | X                               | TRUE  | Enable before manual override via request                  |
| X     | TRUE                            | TRUE  | Enable before manual override via anti-seize module        |
| FALSE | FALSE                           | FALSE | Blocking of Enable before manual override via the requests |

Legend: X = any

#### Enable after manual override *xHB*

The output Enable after manual override *xHB* corresponds to Enable before manual override *xAB*, additionally extended by a manual override module and by a forced override.

| *xAB* | **eManModeB** | *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.On    | FALSE    | X                | TRUE  | Manual override module in manual mode On  |
| X     | eMANBIN.Off   | FALSE    | X                | FALSE | Manual override module in manual mode Off |
| X     | X             | TRUE     | FALSE            | FALSE | Forced override Close                     |
| X     | X             | TRUE     | TRUE             | TRUE  | Forced override Open                      |

Legend: X = any

#### Request - energy generation *xEnergyRequest*

The request - energy generation *xEnergyRequest* is generated by the anti-seize process, the Enable after manual override *xHB* and the operating mode of the manual override - hardware *eAOO* is affected.

| Anti-blocking protection process | *xHB* | *eAOO*                  | *xEnergyRequest* | Notes                                                       |
| -------------------------------- | ----- | ----------------------- | ---------------- | ----------------------------------------------------------- |
| FALSE                            | TRUE  | HVACTYPES.eManBin.Auto  | TRUE             | Request in automatic mode of the manual override - hardware |
| X                                | X     | HVACTYPES.eManBin.ManOn | TRUE             | Request in manual mode of the manual override - hardware    |

In all other situations, the request - energy generation *xEnergyRequest* is not active (= FALSE).\
\
Legend: X = any

#### Anti-blocking protection module

The anti-seizing protection module is implemented by the binary anti-seizing protection module with adjustable duration (FB: AbsB).\
The duration *udiAbsTime*, the time **todAbsStartTime** and the weekday **eAbsDay** can be adjusted.\
The minimum run time for blocking the anti-seizing operation is 30 s.\
The timestamp (date / time) of the last anti-seizing operation *dtAbsLastOn* is available.

#### Collective fault *xAlarm*

The collective fault *xAlarm* is activated (= TRUE) if the input *xAlarmIn* is active.\
In all other cases the collective fault is *xAlarm* is not activated (= FALSE).

#### 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 message Automatic mode *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* .

### CODESYS

InOut:

| Scope       | Name              | Type    | Initial           |
| ----------- | ----------------- | ------- | ----------------- |
| Input       | `xY`              | `BOOL`  |                   |
| Input       | `xForce`          | `BOOL`  | FALSE             |
| Input       | `xAlarmIn`        | `BOOL`  | FALSE             |
| Input       | `eAOO`            | eManBin | eManBin.Auto      |
| Output      | `xHB`             | `BOOL`  |                   |
| Output      | `xAB`             | `BOOL`  |                   |
| Output      | `xEnergyRequest`  | `BOOL`  |                   |
| Output      | `dtAbsLastOn`     | `DT`    |                   |
| Output      | `xAlarm`          | `BOOL`  |                   |
| Output      | `xAuto`           | `BOOL`  |                   |
| Input Const | `udiAbsTime`      | `UDINT` | 200               |
| Input Const | `todAbsStartTime` | `TOD`   | TIME\_OF\_DAY#9:0 |
| Input Const | `eAbsDay`         | eDoW    | eDow\.Monday      |
| Input Const | `xForceOption`    | `BOOL`  | TRUE              |
| 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/valvetherm.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.
