# Consumption within Timespan

> Symcon documentation · English · generated on 2026-09-26  
> Index: https://www.symcon.de/en/llms.txt

Source: https://www.symcon.de/en/service/documentation/module-reference/energy/consumption-within-timespan/

_Requires Symcon >= 4.2_

### function scope
- Calculates consumption for a time span based on the aggregation of the selected source variable.
- When the time span is changed, the consumption is recalculated
- Different detail lines for start and end date
- Adjustable interval for updating the calculation

### software installation
- Install the module 'Consumption within Timespan' via the [Module Store](https://www.symcon.de/en/service/documentation/components/management-console/module-store/).

### Set up instances in IP-Symcon
- Under "Add instance" the 'Consumption within Timespan' module can be found using the quick filter.
  - More information about adding instances in the [Instances documentation](https://www.symcon.de/en/service/documentation/basics/instances/)

#### Configuration Page:

| name                   | description                                                                        |
| ---------------------- | ---------------------------------------------------------------------------------- |
| Source                 | Source variable to be used for consumption                                         |
| Level of Detail        | Determines how precisely the start and end time can be set (date, time, date/time) |
| Use interval to update | If active, an interval will be used to update the calculation                      |
| Interval               | The interval in minutes at which the calculation will be updated                   |

> **Note:** If the date is selected in level of detail, the start date with the time 00:00 and the end date with the time 23:59:59 is used.

### status variables
The status variables/categories are created automatically. Deleting individual ones can lead to malfunctions.

#### Status variables

| Name        | Type    | Description                                                 |
| ----------- | ------- | ----------------------------------------------------------- |
| Start       | Integer | Start date/start time for consumption (seconds are ignored) |
| End         | Integer | End date/end time for consumption (seconds are ignored)     |
| Consumption | Float   | Consumption between start and end date                      |

## VIZ_Calculate

Source: https://www.symcon.de/en/service/documentation/module-reference/energy/consumption-within-timespan/viz-calculate/

`bool VIZ_Calculate(int $InstanceID)`

_Requires Symcon >= 4.2_

**Parameters**

- `$InstanceID` (int): ID of the Instance

**Returns** (bool): If the command could be executed successfully, it returns __TRUE__ as result, otherwise __FALSE__.

ID of the Instance

**Example**

```text
VIZ_Calculate(12345);
```