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

# OptStartHeat32

## `OptStartHeat32` (FB)

FUNCTION\_BLOCK OptStartHeat32 EXTENDS Uhr\_Base IMPLEMENTS IUhr

### Short description

> Start-up optimization for heating operation with a connection to the FB ‘ClockSlave32’ (principle: variable preheating time)\
> Goal: room temperature = setpoint temperature at the start of daytime operation\
> Typical application: zone control loop with heating valve

### Representation

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

### Interfaces

#### Inputs

| Name                 | Data type      | Value range | Initial value | Function                                                        |
| -------------------- | -------------- | ----------- | ------------- | --------------------------------------------------------------- |
| *itfFromClockMaster* | IUhrProtocol   |             |               | Interface for connection to the FB ‘ClockMaster32’              |
| *ClockSlaveParam*    | stSlvClockData |             |               | Connection to some selected parameters of the FB ‘ClockSlave32’ |
| *xEn*                | BOOL           |             | FALSE         | General enable of the start-up optimization                     |
| *xEnAdapt*           | BOOL           |             | TRUE          | Enable data storage in the historical memory                    |
| *xResAdapt*          | BOOL           |             | TRUE          | Reset of the historical memory                                  |
| *rTo*                | REAL           |             |               | Current outside temperature                                     |
| *rTi*                | REAL           |             |               | Current room temperature                                        |
| *rSetTemp*           | REAL           |             |               | Current room setpoint temperature in comfort/day operation      |

#### Outputs

| Name           | Data type | Value range | Initial value | Function                                                                                                                         |
| -------------- | --------- | ----------- | ------------- | -------------------------------------------------------------------------------------------------------------------------------- |
| *xDaytime*     | BOOL      |             | FALSE         | Enable of comfort/day operation (Off = FALSE, On = TRUE)                                                                         |
| *xProcess*     | BOOL      |             | FALSE         | Enable - preheating process (Off = FALSE, On = TRUE)                                                                             |
| *bState*       | BYTE      |             | 0             | Phase of the preheating process (0=Off/Deactivated, 1 = checking time, 2 = dead time, 3 = heating time, 4 = end of heating time) |
| *wError*       | WORD      |             | 0             | Error status of the last preheating process                                                                                      |
| *bResult*      | BYTE      |             | 0             | Quality of the last preheating process (0 = invalid, 1 = good, 2 = normal, 3 = poor)                                             |
| *xActive*      | BOOL      |             | FALSE         | State of the clock channel (Off = FALSE, On = TRUE)                                                                              |
| *uiDeadTime*   | UINT      |             | 0             | Display of the current dead time duration (min)                                                                                  |
| *uiHeatTime*   | UINT      |             | 0             | Display of the current heating time duration (min)                                                                               |
| *uiNumber*     | UINT      |             | 0             | Display of the total number of successful preheating processes                                                                   |
| *rAverageDiff* | REAL      |             | 0.0           | Average absolute room temperature deviation of the last 10 successful preheating processes                                       |

#### Setpoints / Parameters

| Name        | Data type | Value range | Initial value | Function                                 |
| ----------- | --------- | ----------- | ------------- | ---------------------------------------- |
| **uiHGMin** | UINT      |             | 30            | Minimum value - heating gradient (min/K) |
| **uiHGMax** | UINT      |             | 240           | Maximum value - heating gradient (min/K) |
| **uiDTMin** | UINT      |             | 10            | Minimum value - dead time (min)          |
| **uiDTMax** | UINT      |             | 180           | Maximum value - dead time (min)          |
| **uiHTMin** | UINT      |             | 15            | Minimum value - heating time (min)       |
| **uiHTMax** | UINT      |             | 600           | Maximum value - heating time (min)       |

#### Global variables

| Name                               | Data type | Value range | Initial value | Function                                                                                     |
| ---------------------------------- | --------- | ----------- | ------------- | -------------------------------------------------------------------------------------------- |
| `gc_Parameters.rTOMin`             | REAL      |             | -25           | Minimum value - outside temperature (°C)                                                     |
| `gc_Parameters.rTOMax`             | REAL      |             | 25            | Maximum value - outside temperature (°C)                                                     |
| `gc_Parameters.rTIMin`             | REAL      |             | 15            | Minimum value - room temperature (°C)                                                        |
| `gc_Parameters.rTIMax`             | REAL      |             | 30            | Maximum value - room temperature (°C)                                                        |
| `gc_Parameters.rDiffSetTemp`       | REAL      |             | 0             | Deviation from the room setpoint temperature at the end of the preheating process (K)        |
| `gc_Parameters.rDTDiffTemp`        | REAL      |             | 0.2           | Increase in room temperature to detect the end of the dead time (K)                          |
| `gc_Parameters.uiPHMaxTime`        | UINT      |             | 720           | Maximum duration of the preheating process                                                   |
| `gc_Parameters.rLimitResultWell`   | REAL      |             | 0.5           | Result display: room temperature deviation - threshold value for a good preheating process   |
| `gc_Parameters.rLimitResultNormal` | REAL      |             | 1             | Result display: room temperature deviation - threshold value for a normal preheating process |

### Restrictions / boundary conditions

1\) This FB does not allow preheating processes that span across days. The preheating process can therefore begin at the earliest at 00:01 on any weekday.

{% hint style="warning" %}
Example: Start - comfort mode: Monday - 05:30 // Calculated preheating time = 7 hours\
Optimal start time - preheating process: Sunday - 22:30\
Actual start time - preheating process: Monday - 00:01
{% endhint %}

2\) Special switching times cause, if assigned (FB ‘ClockSlave32’: parameter ‘xSwitchTimeS’ = TRUE) and active (FB ‘ClockMaster32’: output ‘xSwitchTimeS’ = TRUE),\
no start of a preheating process and an immediate interruption of any preheating process that may be active.\
\
3\) The value of the output ‘ctClockSlave32’ of the FB ‘ClockMaster32’ is incremented by one by each instance of the FB ‘OptStartHeat32’.

### Functional description

\
The output **xDaytime** is activated when the start-up optimization is generally enabled (xEn = TRUE), depending on the historical data, the current outside temperature, the current room temperature, and the current setpoint temperature for day/comfort operation **before** the planned start of comfort/day operation.\
\
This preheating ensures that the room temperature already corresponds to the desired setpoint temperature at the start of day operation.\
The preheating time required for this is **individual** recalculated, the actual preheating time is also incorporated into the historical data.\
Preheating processes across days are not possible.\
The start-up optimization is used to save energy and increase user comfort.\
The components relevant to the start-up optimization are processed every 60 s.\
\
A new preheating process is not started or an active preheating process is interrupted if at least one of the following described conditions is met:\
\
1\) Holiday channel active (FB ‘ClockMaster32’ - xHoliday = TRUE AND FB ‘ClockSlave32’ - ClockSlaveParam.xHoliday = TRUE)\
2\) Public holiday channel active (FB ‘ClockMaster32’ - xPublicHoliday = TRUE AND FB ‘ClockSlave32’ - ClockSlaveParam.xPublicHoliday = TRUE)\
3\) Special switching times channel active (FB ‘ClockMaster32’ - xSwitchTimeS = TRUE AND FB ‘ClockSlave32’ - ClockSlaveParam.xSwitchTimeS = TRUE)\
4\) Central command ON active (FB ‘ClockMaster32’ - xAllOn = TRUE)\
5\) Central command OFF active (FB ‘ClockMaster32’ - xAllOff = TRUE)\
\
The preheating process is divided into four time sections.\
They are passed through one after the other in every successful preheating process.\
The preheating process can end before, exactly at, or after the switch-on point (= transition to comfort/day mode).

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

#### Test time (bState = 1)

The test time is used for cyclical checking (every 60 s) whether the conditions for enabling preheating are met.\
\
It begins if the following conditions are met simultaneously:

1. The preheating process is not active (*xProcess* = FALSE)
2. The clock channel is not active (xActive = FALSE)
3. A valid next switch-on time exists

\
\
It ends properly if the conditions for enabling preheating are met (= start of dead time).\
It ends in any case if the next valid switch-on time is the same as the current time.

#### Dead time (bState = 2)

The dead time serves to precondition the heating.\
\
It begins with the proper end of the test time.\
\
It ends properly if the current room temperature *rTi* the room temperature at the start of the dead time by the adjustable difference `gc_Parameters.rDTDiffTemp` continuously exceeds for a duration of at least 120 s (= start of heating time).\
\
It ends in any case if the next valid switch-on time is the same as the current time.

#### Heating time (bState = 3)

The heating time serves to preheat the zone.\
\
It begins with the proper end of the dead time.\
\
It ends properly if the current room temperature *rTI* the current room setpoint temperature in comfort/day operation *rSetTemp* approaches continuously for a duration of at least 120 s to within a difference smaller than the global variable `gc_Parameters.rDiffSetTemp` approaches.\
\
It ends if a falling signal edge at the state of the clock channel *xActive* is detected.\
\
It ends if the current heating time duration exceeds the adjustable maximum value **uiHTMax** exceeds.

#### End of heating time (bState = 4)

The end of heating time serves to complete the successful preheating process. The historical data are updated, provided no limit values are violated, if the enable for data storage in the historical memory (*xEnAdapt*) is active.\
\
It begins with the proper end of the heating time.

#### Enable *xEn*

This input serves as the general enable for the start-up optimization (*xEn* = TRUE). In the blocked state (*xEn* = FALSE), the outputs are defined as follows:

| Output         | State/Value | Notes |
| -------------- | ----------- | ----- |
| *xDaytime*     | FALSE       |       |
| *xProcess*     | FALSE       |       |
| *bState*       | 0           |       |
| *wError*       | 0           |       |
| *bResult*      | 0           |       |
| *uiDeadTime*   | 0           |       |
| *uiHeatTime*   | 0           |       |
| *uiNumber*     | 0           |       |
| *rAverageDiff* | 0           |       |

The historical data are retained even in the blocked state.\
\
This input can also be used to superimpose sensor faults (fault - room temperature sensor, fault - outside temperature sensor) or for operation of the zone in occupied time extension.

#### Enable *xEnAdapt*

This input serves to enable data storage in the historical memory (*xEnAdapt* = TRUE, prerequisite: *xEn* = TRUE).\
After each successful preheating process, the relevant parameters are stored and are therefore available again during the next preheating process.\
In the blocked state (*xEnAdapt* = FALSE) no data storage takes place.

#### Enable *xResAdapt*

This input serves to initialize the historical memory on every rising signal edge (prerequisite: *xEn* = TRUE).

| Memory                         | State/Value | Notes |
| ------------------------------ | ----------- | ----- |
| Heating gradients              | **uiHGMax** |       |
| Dead times                     | **uiDTMax** |       |
| Number of preheating processes | 0           |       |

In addition, the buffer memory for the average absolute room temperature deviation of the last 10 successful preheating processes and the data memory for the current data are reset.

{% hint style="info" %}
**Typical use of the input&#x20;*****xResAdapt***

This input can be used in combination with the output *rAverageDiff* (Average absolute room temperature deviation of the last 10 successful preheating processes) to cause reinitialization of the historical and current data in the event of larger deviations.
{% endhint %}

#### Input *rTo*

This input serves to capture the current outside temperature.\
It is additionally time-filtered and limited for the start-up optimization (minimum value = `gc_Parameters.rTOMin`, maximum value = `gc_Parameters.rTOMax`).

#### Input *rTi*

This input serves to capture the current room temperature.\
It is additionally time-filtered and limited for the start-up optimization (minimum value = `gc_Parameters.rTIMin`, maximum value = `gc_Parameters.rTIMax`).

#### Input *rSetTemp*

This input serves to capture the current room setpoint temperature for comfort/day operation.\
With every change of the setpoint temperature, a reset to the default state occurs (see enable *xEn* - blocked state).

#### Output *xDaytime*

This output serves to enable comfort/day operation (Off = FALSE, On = TRUE) **by the start-up optimization**.\
It is activated when the transition from test time to dead time occurs.\
It is deactivated if the next valid switch-on time is reached.

#### Output *xProcess*

This output serves to display the active preheating process (Off = FALSE, On = TRUE).\
It is active if the preheating process is in phases 1 - 4 and / or the output *xDaytime* is active.

#### Output *bState*

This output serves to display the active phase of the preheating process.

| Value | Phase                      |
| ----- | -------------------------- |
| 0     | Off / Deactivated          |
| 1     | Test time active           |
| 2     | Dead time active           |
| 3     | Heating time active        |
| 4     | End of heating time active |

#### Output *wError*

This output serves to display warnings / errors during the last preheating process.\
Each message is assigned a bit (Bit = 0 = no error, Bit = 1 = warning / error active).\
This output is continuously updated.\
With every change, the date / current time is additionally recorded.\
This output is always initialized to 0 (= no error) at the start of the test time.\
With every occurrence of an error, the preheating process is stopped and the phase 'Off / Deactivated' is initiated.\
With every occurrence of a warning, the output *wError* is updated.

| Bit | Cause                                    | Error type | Notes |
| --- | ---------------------------------------- | ---------- | ----- |
| 1   | Exceeding the maximum heating time       | Error      |       |
| 4   | Heating gradient threshold violation     | Warning    |       |
| 5   | Dead time threshold violation            | Warning    |       |
| 6   | Undercutting of the minimum heating time | Warning    |       |

#### Output *bResult*

This output serves to display the quality of the last successful preheating process.\
The output is updated at the switch-on time (= transition to comfort/day operation) if required.\
The absolute value from the calculation of *rSetTemp* - `gc_Parameters.rDiffSetTemp` - *rTi* is used for the evaluation.\
This output is always initialized to 0 (= no result) at the start of the test time.

| Result                   | Threshold                          | *bResult* | Notes                     |
| ------------------------ | ---------------------------------- | --------- | ------------------------- |
| less than                | `gc_Parameters.rLimitResultWell`   | 1         | Good preheating process   |
| less than                | `gc_Parameters.rLimitResultNormal` | 2         | Normal preheating process |
| greater than or equal to | `gc_Parameters.rLimitResultNormal` | 3         | Poor preheating process   |

#### Output *xActive*

This output is used to display the state of the output ‘xClockActive’ of the FB ‘ClockSlave32’ (Off = FALSE, On = TRUE).\
It is continuously updated independently of the state of *xEn* (= general enable of the start-up optimization) updated.

#### Output *uiDeadTime*

This output serves to display the current dead time duration (min).\
This output is always initialized to 0 min at the start of the test time.

#### Output *uiHeatTime*

This output serves to display the current heating time duration (min).\
This output is always initialized to 0 min at the start of the test time.

#### Output *uiNumber*

This output serves to display the total number of successful preheating processes.

#### Output *rAverageDiff*

This output serves to display the average absolute room temperature deviation of the last 10 successful preheating processes.\
This output is always after the update of output *bResult* updated.\
This output is initialized with 0 K on every rising signal edge at input *xResAdapt* is initialized to 0 K.

{% hint style="info" %}
**Typical use of the output&#x20;*****rAverageDiff***

This output can be used in combination with the input *xResAdapt* (Reset of the historical memory) to cause reinitialization of the historical and current data in the event of larger deviations.
{% endhint %}

#### 1. Preheating process

After the software download or after every rising signal edge at input *xResAdapt* the historical data are reinitialized.\
The dead times are then assigned the parameter **uiDTMax**, the heating gradients with the parameter **uiHGMax** and the number of successful preheating processes with the value 0.

#### Parameter **uiHGMin**

This parameter is used to define the minimum permissible heating gradient (min/K).\
It is used to check for limit violations. In the event of a limit violation, the historical data are not updated.

#### Parameter **uiHGMax**

This parameter is used to define the maximum permissible heating gradient (min/K).\
It is used to check for limit violations. In the event of a limit violation, the historical data are not updated.

#### Parameter **uiDTMin**

This parameter is used to define the minimum permissible dead time (min).\
It is used to check for limit violations. In the event of a limit violation, the historical data are not updated.

#### Parameter **uiDTMax**

This parameter is used to define the maximum permissible dead time (min).\
It is used to check for limit violations. In the event of a limit violation, the historical data are not updated.

#### Parameter **uiHTMin**

This parameter is used to define the minimum permissible heating time (min).\
It is used to check for limit violations.

#### Parameter **uiHTMax**

This parameter is used to define the maximum permissible heating time (min).\
It is used to check for limit violations.\
With every occurrence of a limit violation, the preheating process is stopped and the phase 'Off / Deactivated' is initiated.

#### Global variable `gc_Parameters.rTOMin`

This global variable is used to define the minimum permissible outside temperature (°C).\
It is used to check and correct limit violations.

#### Global variable `gc_Parameters.rTOMax`

This global variable is used to define the maximum permissible outside temperature (°C).\
It is used to check and correct limit violations.

#### Global variable `gc_Parameters.rTIMin`

This global variable is used to define the minimum permissible room temperature (°C).\
It is used to check and correct limit violations.

#### Global variable `gc_Parameters.rTIMax`

This global variable is used to define the maximum permissible room temperature (°C).\
It is used to check and correct limit violations.

#### Global variable `gc_Parameters.rDiffSetTemp`

This global variable is used to define the deviation from the room setpoint temperature at the end of the preheating process (K).\
It specifies how far the room temperature must approach the setpoint temperature in day/comfort operation in order to end the active preheating process.

#### Global variable `gc_Parameters.rDTDiffTemp`

This global variable is used to define the increase in room temperature for detecting the end of the dead time (K).\
It specifies how much the room temperature must increase continuously during the dead time in order to initiate the heating time.

#### Global variable `gc_Parameters.uiPHMaxTime`

This global variable is used to define the maximum duration of the preheating process.\
It is used for internal calculations.

#### Global variable `gc_Parameters.rLimitResultWell`

This global variable is used to define the threshold value 'Good preheating process' for the quality display *bResult*.

#### Global variable `gc_Parameters.rLimitResultNormal`

This global variable is used to define the threshold value 'Normal preheating process' for the quality display *bResult*.

#### Typical application

This function block can be used as follows:

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

### CODESYS

InOut:

| Scope       | Name                   | Type           | Initial | Inherited from |
| ----------- | ---------------------- | -------------- | ------- | -------------- |
| Input       | `itfFromClockMaster32` | `IUhrProtocol` |         | Uhr\_Base      |
| Input       | `ClockSlaveParam`      | stSlvClockData |         |                |
| Input       | `xEn`                  | `BOOL`         | FALSE   |                |
| Input       | `xEnAdapt`             | `BOOL`         | TRUE    |                |
| Input       | `xResAdapt`            | `BOOL`         | FALSE   |                |
| Input       | `rTo`                  | `REAL`         |         |                |
| Input       | `rTi`                  | `REAL`         |         |                |
| Input       | `rSetTemp`             | `REAL`         |         |                |
| Output      | `xDaytime`             | `BOOL`         | FALSE   |                |
| Output      | `xProcess`             | `BOOL`         | FALSE   |                |
| Output      | `bState`               | `BYTE`         | 0       |                |
| Output      | `wError`               | `WORD`         | 0       |                |
| Output      | `bResult`              | `BYTE`         | 0       |                |
| Output      | `xActive`              | `BOOL`         | FALSE   |                |
| Output      | `uiDeadTime`           | `UINT`         | 0       |                |
| Output      | `uiHeatTime`           | `UINT`         | 0       |                |
| Output      | `uiNumber`             | `UINT`         | 0       |                |
| Output      | `rAverageDiff`         | `REAL`         | 0.0     |                |
| Input Const | `uiHGMin`              | `UINT`         | 30      |                |
| Input Const | `uiHGMax`              | `UINT`         | 240     |                |
| Input Const | `uiDTMin`              | `UINT`         | 10      |                |
| Input Const | `uiDTMax`              | `UINT`         | 180     |                |
| Input Const | `uiHTMin`              | `UINT`         | 15      |                |
| Input Const | `uiHTMax`              | `UINT`         | 600     |                |


---

# 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/optimizer/optstartheat32.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.
