# Computation Module

> 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/logic/computation-module/

Modules, which enables various calculations within IP-Symcon

## Computation Module

Source: https://www.symcon.de/en/service/documentation/module-reference/logic/computation-module/computation-module/

_Requires Symcon >= 4.3_

This module can perform various auxiliary calculations on a set of variables, for example, the sum or the average.

### function scope
- Calculations of various values based on a set of variables:
  - Sum
  - Minimum
  - Maximum
  - Average
  - Number of variables
- Output of the calculated values in variables
- Updating of the values as soon as one of the variables changes

### software installation
- Via the [Module Store](https://www.symcon.de/en/service/documentation/components/management-console/module-store/) install the 'Computation Module'.

### Setting up instances in IP-Symcon
- Under "Add Instance", the 'Computation Modulel' 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                                                                                                                                                    |
| ----------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Calculation | Selection of the performed calculation(s)                                                                                                                      |
| Variables   | VariableIDs of the variables on which the calculation(s) will be performed; for all calculations except Number, all variables must be of type Float or Integer |

#### _possible_calculations:_

| Name    | Description                                                                          |
| ------- | ------------------------------------------------------------------------------------ |
| All     | All calculations presented in this table are performed                               |
| Sum     | The sum of all selected variables is stored in the status variable Sum               |
| Minimum | The minimum value of the selected variables is stored in the Minimum status variable |
| Maximum | The maximum value of the selected variables is stored in the status variable Maximum |
| Average | The average of the selected variables is stored in the status variable Average       |
| Number  | The number of selected variables is stored in the status variable Number             |

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

#### Status variables

A corresponding status variable is created for each calculation.

| Name    | Type  | Description                                 |
| ------- | ----- | ------------------------------------------- |
| Sum     | Float | The sum of all selected variables           |
| Minimum | Float | The minimum value of the selected variables |
| Maximum | Float | The maximum value of the selected variables |
| Average | Float | The average of the selected variables       |
| Number  | Float | The number of selected variables            |

## RM_Update

Source: https://www.symcon.de/en/service/documentation/module-reference/logic/computation-module/computation-module/rm-update/

`bool RM_Update(int $InstanceID)`

_Requires Symcon >= 4.3_

**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
RM_Update(12345);
```

## Converter

Source: https://www.symcon.de/en/service/documentation/module-reference/logic/computation-module/converter/

_Requires Symcon >= 4.3_

### function scope
- Calculates a value from a selected source variable using a set-up formula.
- If the source variable is changed, the value is automatically recalculated.

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

### Setting_up_instances_in IP-Symcon
- Under "Add Instance" the 'Converter' 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 calculation. |
| Formula   | Formula where calculation is to be used.    |
| Value     | Test value to test the formula              |
| Calculate | Calculates the value using the test value   |

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

#### Status variables

| Name  | Type  | Description                                             |
| ----- | ----- | ------------------------------------------------------- |
| Value | Float | Contains the value calculated using the set up formula. |

## UMR_Calculate

Source: https://www.symcon.de/en/service/documentation/module-reference/logic/computation-module/converter/umr-calculate/

`float UMR_Calculate(int $InstanceID, float $Value)`

_Requires Symcon >= 4.3_

Calculates the return of the formula for the Value and returns it.

**Parameters**

- `$InstanceID` (int): ID of the Instance
- `$Value` (float): Value to be inserted in the formula

**Returns** (float): Converted Value __Value__

Value to be inserted in the formula

**Example**

```text
//Function in the configuration: $Value/10\n$output = UMR_Calculate(12345, 50);\nvar_dump($output) //Output is 5
```

## ConvertMultiBoundaries

Source: https://www.symcon.de/en/service/documentation/module-reference/logic/computation-module/convertmultiboundaries/

_Requires Symcon >= 4.3_

### function scope
- Calculates a value from a selected source variable using set-up formulas.
- Which formula is to be used is decided via configurable limit values.
- If the source variable is changed, the value is automatically recalculated.
- If no calculation/limits apply, the original value is entered.

### Software installation
- Install the 'ConvertMultiBoundaries' module 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 'ConvertMultiBoundaries' 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 calculation.            |
| Formula 1-10 | Formula to be applied to the source variable.          |
| Limit 0-10   | Limit values between which the set up formula is used. |
| Value        | Test Value to test the formula                         |
| Calculate    | Calculates the value based on the test value           |

The value of the source variable can be implemented inside the formula with "$Value". Example:

```php
10*$Value+20
```

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

#### Status variables

| Name  | Type  | Description                                             |
| ----- | ----- | ------------------------------------------------------- |
| Value | Float | Contains the value calculated using the set up formula. |

## UMG_Calculate

Source: https://www.symcon.de/en/service/documentation/module-reference/logic/computation-module/convertmultiboundaries/umg-calculate/

`float UMG_Calculate(int $InstanceID, float $Value)`

_Requires Symcon >= 4.3_

**Parameters**

- `$InstanceID` (int): ID of the Instance
- `$Value` (float): In die Formel einzusetzender Wert

**Returns** (float): Result of the calculation.

In die Formel einzusetzender Wert

**Example**

```text
//Funktion in der Konfiguration: $Value/10\n$ausgabe = UMG_Calculate(12345, 50);\nvar_dump($ausgabe) //Ausgabe ist 5
```

## ValueRangeScale

Source: https://www.symcon.de/en/service/documentation/module-reference/logic/computation-module/valuerangescale/

_Requires Symcon >= 4.3_

### functional scope

* Input from input value range
* Input from output value range
* Conversion from an input value
* Calculation on change of value of the input value

### software installation

* Via the [Module Store](../components/management-console.md) install the 'ValueRangeScale' module.

### Setting up the instances in IP-Symcon

 Under 'Add Instance' the 'ValueRangeScaling' module can be found using the quick filter.
	- More information about adding instances in the [Instances documentation](../concepts.md)

#### configuration page:

| Name                 | Description                          |
| -------------------- | ------------------------------------ |
| Input variable       | Variable which serves as input value |
| Minimum input value  | The lower value limit of the input   |
| Maximum input value  | The upper value limit of the input   |
| Minimum output value | The lower value limit of the output  |
| Maximum output value | The upper value limit of the output  |

### status variables

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

#### Status variables

| Name   | Type  | Description                     |
| ------ | ----- | ------------------------------- |
| Output | float | Output value of the calculation |

## VRC_Scale

Source: https://www.symcon.de/en/service/documentation/module-reference/logic/computation-module/valuerangescale/vrc-scale/

`bool VRC_Scale(int $InstanceID)`

_Requires Symcon >= 4.3_

Scales the input variable value

**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**

```php
VRC_Scale(12345)
```