> 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/damping/averagetimecal.md).
# AverageTimeCal
## `AverageTimeCal` (FB)
FUNCTION\_BLOCK AverageTimeCal
### Short description
> Averaging of an analog value over four different time periods\
> Averaging: Weighted average (see formula below)\
> Typical application: Time-based averaging of the outside temperature
### Representation
### Interfaces
#### Inputs
| Name | Data type | Value range | Initial value | Function |
| ----- | --------- | ----------- | ------------- | ------------ |
| *rIn* | REAL | | | Analog input |
#### Outputs
| Name | Data type | Value range | Initial value | Function |
| ---------------- | --------------- | ----------- | ------------- | --------------------------------------- |
| *rOutCH0* | REAL | | | Average value period 1 |
| *rOutCH1* | REAL | | | Average value period 2 |
| *rOutCH2* | REAL | | | Average value period 3 |
| *rOutCH3* | REAL | | | Average value period 4 |
| *rOutMin* | REAL | | | Minimum value of all measured values |
| *rOutMax* | REAL | | | Maximum value of all measured values |
| *dtLastNewValue* | DATE\_AND\_TIME | | | Storage time of the last measured value |
| *sErr* | STRING | | | Current error text |
#### Setpoints / Parameters
| Name | Data type | Value range | Initial value | Function |
| ----------------- | --------- | ----------- | ---------------- | --------------------------------------------------------------------------------------------------------------------- |
| **xCalculation** | BOOL | | TRUE | Enable / disable data logging |
| **xResetOnInput** | BOOL | | FALSE | Initialization of the measured value storage and the average value outputs with *rIn* |
| **rInitValue** | REAL | | 10 | Initialization value for the measured value storage and the average value outputs at **eInitial** = eInit2.InitValue. |
| **tInitDelay** | TIME | | 5s | Delay time for storing measured values at **eInitial** = eInit2.InputValueDelayed. |
| **eInitial** | eInit2 | | eInit2.LastValue | Specification of the type of initialization |
| **wCH3Time** | WORD | | 48 | Definition of period 4 in hours |
| **wCH2Time** | WORD | | 36 | Definition of period 3 in hours |
| **wCH1Time** | WORD | | 24 | Definition of period 2 in hours |
| **wCH0Time** | WORD | | 12 | Definition of period 1 in hours |
| **wInterval** | WORD | | 15 | Definition of the recording interval in minutes |
### Functional description
#### General
Averaging\
\
The value at the analog input *rIn* is recorded at the recording interval **iInterval** (Default = 15 minutes) is captured.\
To calculate the average of a period X (X = 0 ... 3), three factors are now determined in each case.\
\
\
Factor 1 - Period X: Total number of measured values to be considered\
\
Factor 1 = ( **iCHXTime** \* 60 ) / **iInterval**\
\
\
Factor 2 - Period X: Factor for the stored average\
\
Factor 2 = ( Factor 1 - 1 ) / Factor 1\
\
\
Factor 3 - Period X: Factor for the current value at the analog input *rIn*\
\
Factor 3 = 1 - Factor 2\
\
\
The average of each period is calculated in the recording interval **iInterval** calculated according to the following formula and transferred to the average value outputs:\
\
\
Average = (Old average \* Factor 2) + (*rIn* \* Factor 3)\
\
\
Legend: X = 0 ... 3
> **Example**
>
> **iInterval** = 15 minutes, **wCH0Time** = 12 hours, old average = 20.0, *rIn* = 22.0\
> \
> Factor 1 = 48\
> \
> Factor 2 = 47 / 48\
> \
> Factor 3 = 1 / 48\
> \
> Average = 20.041
#### Average value outputs *rOutCHX* (X = 0 ... 3)
At the average value output *rOutCHX* (X = 0 ... 3) the correct arithmetic mean **iCHXTime** the average of the recorded input values is available.
#### Minimum value output *rOutMin*
At the minimum value output *rOutMin* is available for the first time after a recording interval **iInterval** the absolute minimum value of all recorded input values is available.
#### Maximum value output *rOutMax*
At the maximum value output *rOutMax* is available for the first time after a recording interval **iInterval** the absolute maximum value of all recorded input values is available.
#### Time stamp *dtLastNewValue*
At the time stamp output *dtLastNewValue* is available for the first time after a recording interval **iInterval** the timestamp of the last storage in the measured value memory is available.
#### Error text *sErr*
At the output for the current error text *sErr* In the event of an error, a descriptive text is available. If there is no error, an empty string is output.
#### Type of initialization **eInitial**
This setpoint / parameter determines the type of initialization of the measured value memory and the average value outputs. The following options are possible:
| Type | Value of initialization | Note |
| ------------------------ | ------------------------------------------------------------ | ------------------------ |
| eInit2.InitValue | **rInitValue** | Adjustable initial value |
| Input value | *rIn* | eInit2.InputValue |
| eInit2.InputValueDelayed | *rIn* | Delayed input value |
| eInit2.LastValue | Average - measured value memory (measured value memory full) | Last value |
| eInit2.LastValue | *rIn* (measured value memory empty) | Last value |
#### Enable / disable data logging **xCalculation**
This setpoint / parameter enables data logging (= TRUE) or disables it (= FALSE)
#### Reset of the measured value memory / the average value outputs **xResetOnInput**
With this setpoint/parameter, the measured value memory / the average value outputs are set to the value **rIn** reset (= TRUE).
### CODESYS
InOut:
| Scope | Name | Type | Initial |
| ----------- | ---------------- | -------- | ---------------- |
| Input | `rIn` | `REAL` | |
| Input Const | `xCalculation` | `BOOL` | TRUE |
| Input Const | `xResetOnInput` | `BOOL` | FALSE |
| Input Const | `rInitValue` | `REAL` | 10 |
| Input Const | `tInitDelay` | `TIME` | TIME#5s0ms |
| Input Const | `eInitial` | eInit2 | eInit2.LastValue |
| Input Const | `wCH3Time` | `WORD` | 48 |
| Input Const | `wCH2Time` | `WORD` | 36 |
| Input Const | `wCH1Time` | `WORD` | 24 |
| Input Const | `wCH0Time` | `WORD` | 12 |
| Input Const | `wInterval` | `WORD` | 15 |
| Output | `rOutCH0` | `REAL` | |
| Output | `rOutCH1` | `REAL` | |
| Output | `rOutCH2` | `REAL` | |
| Output | `rOutCH3` | `REAL` | |
| Output | `rOutMin` | `REAL` | |
| Output | `rOutMax` | `REAL` | |
| Output | `dtLastNewValue` | `DT` | |
| Output | `sErr` | `STRING` | |
---
# 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/damping/averagetimecal.md?ask=&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.
