# Variablenverwaltung

> Symcon Dokumentation · Deutsch · erzeugt am 2026-09-26  
> Index: https://www.symcon.de/de/llms.txt

Quelle: https://www.symcon.de/de/service/dokumentation/befehlsreferenz/variablenverwaltung/

## IPS_CreateVariable

Quelle: https://www.symcon.de/de/service/dokumentation/befehlsreferenz/variablenverwaltung/ips-createvariable/

`int IPS_CreateVariable(int $VariablenTyp)`

legt eine Variable an

**Parameter**

- `$VariablenTyp` (int)

  | Wert | Beschreibung                              |
  | ---- | ----------------------------------------- |
  | 0    | Legt eine Variable vom Typ __Boolean__ an |
  | 1    | Legt eine Variable vom Typ __Integer__ an |
  | 2    | Legt eine Variable vom Typ __Float__ an   |
  | 3    | Legt eine Variable vom Typ __String__ an  |

**Rückgabewert** (int): ID der neu erstellten Variable

| Wert | Beschreibung                              |
| ---- | ----------------------------------------- |
| 0    | Legt eine Variable vom Typ __Boolean__ an |
| 1    | Legt eine Variable vom Typ __Integer__ an |
| 2    | Legt eine Variable vom Typ __Float__ an   |
| 3    | Legt eine Variable vom Typ __String__ an  |

**Beispiel**

```php
// Anlegen einer Float-Variablen mit dem Namen "Raumtemperatur Wohnzimmer"
$VarID_Raumtemperatur = IPS_CreateVariable(2);
IPS_SetName($VarID_Raumtemperatur, "Raumtemperatur Wohnzimmer"); // Variable benennen
IPS_SetParent($VarID_Raumtemperatur, 12345); // Variable einsortieren unter dem Objekt mit der ID "12345"
```

## IPS_DeleteVariable

Quelle: https://www.symcon.de/de/service/dokumentation/befehlsreferenz/variablenverwaltung/ips-deletevariable/

`bool IPS_DeleteVariable(int $VariablenID)`

löscht eine Variable

**Parameter**

- `$VariablenID` (int): ID der zu löschenden Variable

**Rückgabewert** (bool): Konnte der Befehl erfolgreich ausgeführt werden, liefert er als Ergebnis __TRUE__, andernfalls __FALSE__.

ID der zu löschenden Variable

**Beispiel**

```php
// Löschen der Variablen 47788
IPS_DeleteVariable(47788);
```

## IPS_GetVariable

Quelle: https://www.symcon.de/de/service/dokumentation/befehlsreferenz/variablenverwaltung/ips-getvariable/

`array IPS_GetVariable(int $VariablenID)`

liefert umfassende Informationen zu einer bestimmten Variablen

**Parameter**

- `$VariablenID` (int): Die zu zeigende VariablenID

**Rückgabewert** (array): Folgende Informationen stehen als __key => value__ Paare zur Verfügung:

| Index                                   | Typ     | Beschreibung                                                                                                                                                                                                                                                 |
| --------------------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| __VariableAction__                      | integer | ID der Instanz, die bei einer gewünschten Änderungen der Variable den Änderungswunsch entgegen nimmt. 0 bei keiner oder einer deaktivierten Verknüpfung.                                                                                                     |
| __VariableChanged__                     | integer | Unix-Timestamp, wenn die Variable zuletzt verändert wurde                                                                                                                                                                                                    |
| __VariableCustomAction__                | integer | ID des Skriptes, dass bei einer gewünschten Änderung der Variable über die Visualisierung gestartet werden soll. Sofern aktuell eine vorhandene Standardaktion deaktiviert wird, ist die nichtvorhandene SkriptID Eins (1) angegeben. (Ab Version 2.5 #2300) |
| __VariableCustomPresentation__ (ab 8.0) | array   | Vom Benutzer gegebene Darstellung. Leeres Array, falls keine Darstellung angegeben.                                                                                                                                                                          |
| __VariableCustomProfile__               | string  | Name vom Benutzer gegebenen Profil. Leer, falls kein Profil angeben.                                                                                                                                                                                         |
| __VariableID__                          | integer | VariablenID                                                                                                                                                                                                                                                  |
| __VariableIsLocked__                    | boolean | Gibt an, ob diese Variable oberhalb des Variablenlimits ist und deshalb nicht beschrieben werden kann (Verfügbar ab Version 2.3).                                                                                                                            |
| __VariableProfile__                     | string  | Name vom System gegebenen Profil. Leer, falls kein Profil angegeben.                                                                                                                                                                                         |
| __VariablePresentation__ (ab 8.0)       | array   | Vom System gegebene Darstellung. Leeres Array, falls keine Darstellung angegeben.                                                                                                                                                                            |
| __VariableType__ (ab 4.0)               | integer | Enthält den Variablentyp (0: Boolean, 1: Integer,  2: Float, 3: String)                                                                                                                                                                                      |
| __VariableUpdated__                     | integer | Unix-Timestamp, wenn die Variable zuletzt aktualisiert wurde                                                                                                                                                                                                 |
| __VariableValue__ (bis 3.4)             | array   | Siehe Tabelle Variablenwert (durch VariableType und [GetValue](access-variables.md) ersetzt)                                                                                                                                                  |

_Tabelle: VariablenWert (bis 3.4)_

| Index            | Typ      | Beschreibung                                                |
| ---------------- | -------- | ----------------------------------------------------------- |
| __ValueType__    | integer  | Variablentyp (0: Boolean, 1: Integer,  2: Float, 3: String) |
| __ValueBoolean__ | boolean  | Wert der Variable abhängig vom __ValueType__                |
| __ValueInteger__ | integer  | Wert der Variable abhängig vom __ValueType__                |
| __ValueFloat__   | float    | Wert der Variable abhängig vom __ValueType__                |
| __ValueString__  | string   | Wert der Variable abhängig vom __ValueType__                |

Die zu zeigende VariablenID

**Beispiel**

```php
// Ab Version 4.0
print_r(IPS_GetVariable(40770));
/* Beispielausgabe:
Array
(
    [VariableChanged] => 1246039629
    [VariableCustomAction] => 0
    [VariableCustomProfile] => BoolProfile
    [VariableID] => 40770
    [VariableIsLocked] =>
    [VariableProfile] => ~Switch
    [VariableType] => 0
    [VariableUpdated] => 1246039629
)
*/

print_r(IPS_GetVariableCompatibility(40770)); // Ab Version 4.0
/* Beispielausgabe:
Array
(
    [VariableChanged] => 1246039629
    [VariableCustomAction] => 0
    [VariableCustomProfile] => BoolProfile
    [VariableID] => 40770
    [VariableIsLocked] =>
    [VariableProfile] => ~Switch
    [VariableUpdated] => 1246039629
    [VariableValue] => Array
    (
        [ValueArray] => Array
        (
        )

        [ValueBoolean] => 1
        [ValueFloat] => 0
        [ValueIndex] => Array
        (
            [IndexInt] => 0
            [IndexStr] =>
            [IndexType] => 0
        )

        [ValueInteger] => 0
        [ValueString] =>
        [ValueType] => 0
    )
)
*/

// Bis Version 3.4
print_r(IPS_GetVariable(40770));
/* Beispielausgabe:
Array
(
    [VariableChanged] => 1246039629
    [VariableCustomAction] => 0
    [VariableCustomProfile] => BoolProfile
    [VariableID] => 40770
    [VariableIsLocked] =>
    [VariableProfile] => ~Switch
    [VariableUpdated] => 1246039629
    [VariableValue] => Array
    (
        [ValueArray] => Array
        (
        )

        [ValueBoolean] => 1
        [ValueFloat] => 0
        [ValueIndex] => Array
        (
            [IndexInt] => 0
            [IndexStr] =>
            [IndexType] => 0
        )

        [ValueInteger] => 0
        [ValueString] =>
        [ValueType] => 0
    )
)
*/
```

## IPS_GetVariableEventList

Quelle: https://www.symcon.de/de/service/dokumentation/befehlsreferenz/variablenverwaltung/ips-getvariableeventlist/

`array IPS_GetVariableEventList(int $VariablenID)`

liefert alle Ereignisse die einer Variable zugeordnet sind

**Parameter**

- `$VariablenID` (int): VariablenID, zu der verknüpfte Ereignisse gesucht werden sollen

**Rückgabewert** (array): Ein Array von Integer-Werten aller EreignisIDs, die mit der Variable __VariablenID__ verknüpft sind

VariablenID, zu der verknüpfte Ereignisse gesucht werden sollen

**Beispiel**

```php
$events = IPS_GetVariableEventList(12345);
print_r($events);  // ermittelt alle Ereignisse des aktuellen Skripts
```

## IPS_GetVariableIDByName

Quelle: https://www.symcon.de/de/service/dokumentation/befehlsreferenz/variablenverwaltung/ips-getvariableidbyname/

`int IPS_GetVariableIDByName(string $VariablenName, int $ÜbergeordneteID)`

liefert die ID einer Variablen anhand des Namens

**Parameter**

- `$VariablenName` (string): Zu suchender VariablenName
- `$ÜbergeordneteID` (int): Objekt, in deren direkten Unterobjekten gesucht werden soll

**Rückgabewert** (int): ID der gefundenen Variable, sonst FALSE

Objekt, in deren direkten Unterobjekten gesucht werden soll

**Beispiel**

```php
$VariablenID = @IPS_GetVariableIDByName("Regenmenge", $ÜbergeordneteID);
if ($VariablenID === false)
    echo "Variable nicht gefunden!";
else
    echo "Die Variablen-ID lautet: ". $VariablenID;
```

## IPS_GetVariableList

Quelle: https://www.symcon.de/de/service/dokumentation/befehlsreferenz/variablenverwaltung/ips-getvariablelist/

`array IPS_GetVariableList()`

liefert eine Liste aller existierenden Variablen

**Rückgabewert** (array): Ein Array von Integer-Werten aller IDs der Variablen in IP-Symcon

Die Funktion ermittelt die IDs aller in IP-Symcon registrierten IPS-Variablen. Die IDs werden in einem Array aufgelistet. Falls keine Variable existiert, ist das Array leer.

**Beispiel**

```php
$alleVariablen = IPS_GetVariableList();
print_r($alleVariablen);

/* liefert z.B.:
Array
(
    [0] => 37659
    [1] => 18326
    usw. ...
*/
```

## IPS_GetVariablePresentation

Quelle: https://www.symcon.de/de/service/dokumentation/befehlsreferenz/variablenverwaltung/ips-getvariablepresentation/

`array IPS_GetVariablePresentation(int $VariablenID)`

_Benötigt Symcon >= 8.1_

Gibt alle Parameter der aktuell genutzten Darstellung zurück

**Parameter**

- `$VariablenID` (int): VariablenID der Variable deren Darstellung ausgegeben werden soll

**Rückgabewert** (array): Ein Array mit allen Parametern der aktuellen Variablendarstellung

VariablenID der Variable deren Darstellung ausgegeben werden soll

**Beispiel**

```text
print_r(IPS_GetVariablePresentation(12345));
/* Beispielausgabe
Array
(
    [DIGITS] => 0
    [CUSTOM_GRADIENT] => []
    [ICON] => temperature-half
    [DECIMAL_SEPARATOR] => Client
    [GRADIENT_TYPE] => 1
    [MAX] => 25
    [PRESENTATION] => {6B9CAEEC-5958-C223-30F7-BD36569FC57A}
    [INTERVALS] => []
    [INTERVALS_ACTIVE] =>
    [MIN] => 15
    [PERCENTAGE] =>
    [PREFIX] =>
    [STEP_SIZE] => 1
    [SUFFIX] =>  °C
    [THOUSANDS_SEPARATOR] =>
    [USAGE_TYPE] => 0
)
*/
```

## IPS_SetVariableCustomAction

Quelle: https://www.symcon.de/de/service/dokumentation/befehlsreferenz/variablenverwaltung/ips-setvariablecustomaction/

`bool IPS_SetVariableCustomAction(int $VariablenID, int $SkriptID)`

ordnet der Variable ein benutzerdefiniertes Aktionsskript zu

**Parameter**

- `$VariablenID` (int): ID der Variable, der die Aktion zugeordnet werden soll
- `$SkriptID` (int): ID eines Skriptes, das als Aktions aufgeführt werden soll. Sofern eine vorhandene Standardaktion deaktiviert werden soll, kann die nichtvorhandene SkriptID Eins (1) angegeben werden, wodurch die Standardaktion ausgeschaltet wird. Wenn eine gültige SkriptID angegebenen wird, so hat diese Vorrang vor der Standardaktion. Soll die Standardaktion, sofern verfügbar, aktiviert werden, so muss die SkriptID Null (0) angegeben werden.

**Rückgabewert** (bool): Konnte der Befehl erfolgreich ausgeführt werden, liefert er als Ergebnis __TRUE__, andernfalls __FALSE__.

ID eines Skriptes, das als Aktions aufgeführt werden soll. Sofern eine vorhandene Standardaktion deaktiviert werden soll, kann die nichtvorhandene SkriptID Eins (1) angegeben werden, wodurch die Standardaktion ausgeschaltet wird. Wenn eine gültige SkriptID angegebenen wird, so hat diese Vorrang vor der Standardaktion. Soll die Standardaktion, sofern verfügbar, aktiviert werden, so muss die SkriptID Null (0) angegeben werden.

**Beispiel**

```php
IPS_SetVariableCustomAction(12345, 44431);
```

## IPS_SetVariableCustomPresentation

Quelle: https://www.symcon.de/de/service/dokumentation/befehlsreferenz/variablenverwaltung/ips-setvariablecustompresentation/

`bool IPS_SetVariableCustomPresentation(int $VariablenID, array $Presentation)`

_Benötigt Symcon >= 8.0_

ordnet der Variable eine benutzerdefinierte Darstellung zu

**Parameter**

- `$VariablenID` (int): ID der Variable, der die Darstellung zugeordnet werden soll
- `$Presentation` (array): Die Konfiguration der Darstellung. Details sind unter dem Abschnitt [Darstellungen](../developer/sdk-tools/sdk-php.md) zu finden.

**Rückgabewert** (bool): Konnte der Befehl erfolgreich ausgeführt werden, liefert er als Ergebnis __TRUE__, andernfalls __FALSE__.

Die Konfiguration der Darstellung. Details sind unter dem Abschnitt [Darstellungen](../developer/sdk-tools/sdk-php.md) zu finden.

**Beispiel**

```text
// Setzt eine Variable auf die Darstellung Schieberegler mit einem Minimum, Maximum und Suffix
IPS_SetVariableCustomPresentation(12345, [
    'PRESENTATION' => VARIABLE_PRESENTATION_SLIDER,
    'MIN' => 0,
    'MAX' => 100,
    'SUFFIX' => ' %'
]);

// Setzt eine Variable auf die Darstellung Aufzählung mit Icons und Farben.
IPS_SetVariableCustomPresentation(12345, [
    'PRESENTATION' => VARIABLE_PRESENTATION_ENUMERATION,
    'DISPLAY' => 1 /* Icon */,
    'OPTIONS' => json_encode([
        ['Value' => 1, 'Caption' => 'Automatisch', 'IconActive' => true, 'IconValue' => 'circle-a'],
        ['Value' => 2, 'Caption' => 'Eco', 'IconActive' => true, 'IconValue' => 'circle-e', 'Color' => 40448],
        ['Value' => 3, 'Caption' => 'Manuell', 'IconActive' => true, 'IconValue' => 'circle-m'],
    ])
]);
```

## IPS_SetVariableCustomProfile

Quelle: https://www.symcon.de/de/service/dokumentation/befehlsreferenz/variablenverwaltung/ips-setvariablecustomprofile/

`bool IPS_SetVariableCustomProfile(int $VariablenID, string $ProfilName)`

_Benötigt Symcon >= 3.0_

ordnet der Variable ein benutzerdefiniertes Profil zu

**Parameter**

- `$VariablenID` (int): ID der Variable, der das Profil zugeordnet werden soll
- `$ProfilName` (string): Name des Profils. Verfügbare Profile können über [IPS_GetVariableProfileList](management-variables.md) abgefragt werden. Wenn ein Leerstring übergeben wird, dann wird das benutzerdefinierte Profil deaktiviert.

**Rückgabewert** (bool): Konnte der Befehl erfolgreich ausgeführt werden, liefert er als Ergebnis __TRUE__, andernfalls __FALSE__.

Name des Profils. Verfügbare Profile können über [IPS_GetVariableProfileList](management-variables.md) abgefragt werden. Wenn ein Leerstring übergeben wird, dann wird das benutzerdefinierte Profil deaktiviert.

**Beispiel**

```php
IPS_SetVariableCustomProfile(12345, "~Switch");
```

## IPS_VariableExists

Quelle: https://www.symcon.de/de/service/dokumentation/befehlsreferenz/variablenverwaltung/ips-variableexists/

`bool IPS_VariableExists(int $VariablenID)`

prüft, ob eine bestimmte Variable existiert

**Parameter**

- `$VariablenID` (int): ID der zu prüfenden Variable

**Rückgabewert** (bool): Falls die VariablenID im System existiert, wird __TRUE__ zurückgemeldet, andernfalls __FALSE__.

ID der zu prüfenden Variable

**Beispiel**

```php
if (IPS_VariableExists(44788))
    echo "Variable existiert bereits!";
```

## Variablendarstellung

Quelle: https://www.symcon.de/de/service/dokumentation/befehlsreferenz/variablenverwaltung/variablendarstellung/

## IPS_GetPresentation

Quelle: https://www.symcon.de/de/service/dokumentation/befehlsreferenz/variablenverwaltung/variablendarstellung/ips-getpresentation/

`array IPS_GetPresentation(string $DarstellungsID)`

_Benötigt Symcon >= 8.0_

liefert umfassende Informationen über eine bestimmte Darstellung

**Parameter**

- `$DarstellungsID` (string): Die ID der Darstellung, als GUID formatiert

**Rückgabewert** (array): Folgende Informationen stehen als __key => value__ Paare zur Verfügung:

| Index                      | Typ          | Beschreibung                                                                                                                                                    |
| -------------------------- | ------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| __caption__                | string       | Der Anzeigename der Darstellung.                                                                                                                                |
| __chart__                  | array        | Ein Array mit den Zuweisungen der Parameter für die Darstellung eines Diagramms (Siehe chart Tabelle)                                                           |
| __condition__              | array        | Eine Liste an Bedingungen welche die Parameter der Darstellung erfüllen müssen.                                                                                 |
| __conversions__            | array        | Eine Liste von Anweisungen die angewandt werden, um Parameter für verschiedene Variablentypen anzupassen                                                        |
| __form__                   | array/string | Das Konfigurationsformular bestimmt wie die Parameter im Variablen-Dialog oder dem Vorlagenmanager angepasst werden können.                                     |
| __format__                 | array/string | Die Formatierung von Werten innerhalb dieser Darstellung                                                                                                        |
| __id__                     | string       | Die ID der Darstellung, als GUID formatiert                                                                                                                     |
| __locale__                 | array        | Die Lokalisierung der Darstellung                                                                                                                               |
| __presentationParameters__ | array        | Eine Liste, welche die Standardwerte der Parameter dieser Darstellung beschreibt                                                                                |
| __presentationValue__      | string       | Der Standartwert welcher in der Darstellungsvorschau angezeigt wird. Kann alternativ auch PHP-Code als String oder Array enthalten, welcher den Wert zurückgibt |
| __restrictions__           | array        | Eine Liste an Einschränkungen, welche festlegt für welche Variablen diese Darstellung verfügbar ist                                                             |

__chart Tabelle__
Jeder Wert kann entweder eine Zahl sein oder der Name des Parameters, dessen Wert verwendet werden soll.

| Index        | Typ                  | Beschreibung                   |
| ------------ | -------------------- | ------------------------------ |
| __min__      | integer/float/string | Parameter für den Minimalwert  |
| __max__      | integer/float/string | Parameter für den Maximalwert  |
| __stepSize__ | integer/float/string | Parameter für die Schrittweite |

Die ID der Darstellung, als GUID formatiert

**Beispiel**

```php
IPS_GetPresentation('{6B9CAEEC-5958-C223-30F7-BD36569FC57A}' /* Schieberegler*/);
```

## IPS_GetPresentationForm

Quelle: https://www.symcon.de/de/service/dokumentation/befehlsreferenz/variablenverwaltung/variablendarstellung/ips-getpresentationform/

`string IPS_GetPresentationForm(string $DarstellungsID, int $Variablentyp, array $Parameter)`

_Benötigt Symcon >= 8.0_

liefert das Konfigurationsformular einer Darstellung für einen Variablentypen

**Parameter**

- `$DarstellungsID` (string): Die ID der Darstellung, als GUID formatiert
- `$Variablentyp` (int): Der Typ der Variablen deren Formular zurückgegeben werden soll
- `$Parameter` (array): Die Parameterlist, die für das Formular genutzt werden soll

**Rückgabewert** (string): Das Formular der beschriebenen Darstellung als JSON kodierter String.

Die Parameterlist, die für das Formular genutzt werden soll

**Beispiel**

```text
IPS_GetPresentationForm('{6B9CAEEC-5958-C223-30F7-BD36569FC57A}' /* Schieberegler*/, 1 /* Integer */, []);
```

## IPS_GetPresentations

Quelle: https://www.symcon.de/de/service/dokumentation/befehlsreferenz/variablenverwaltung/variablendarstellung/ips-getpresentations/

`string IPS_GetPresentations()`

_Benötigt Symcon >= 8.0_

liefert alle Darstellungen des Systems

**Rückgabewert** (string): Ein JSON-kodieret Liste aller verfügbaren Darstellungen.
Die Felder der einzelnen Darstellungen sind [hier](management-variables.md) näher beschrieben.

Gibt eine JSON-kodieret Liste aller verfügbaren Darstellungen zurück.

**Beispiel**

```text
// Alle Darstellung als Array
$presentations =  json_decode(IPS_GetPresentations(), true);
```

## IPS_PresentationExists

Quelle: https://www.symcon.de/de/service/dokumentation/befehlsreferenz/variablenverwaltung/variablendarstellung/ips-presentationexists/

`bool IPS_PresentationExists(string $DarstellungsID)`

_Benötigt Symcon >= 8.0_

prüft ob eine bestimmte Darstellung existiert

**Parameter**

- `$DarstellungsID` (string): Die ID der zu prüfenden Darstellung, als GUID formatiert

**Rückgabewert** (bool): Falls die Darstellung im System existiert, wird **TRUE** zurückgemeldet, andernfalls **FALSE**.

Die ID der zu prüfenden Darstellung, als GUID formatiert

**Beispiel**

```text
if (IPS_PresentationExists('{60AE6B26-B3E2-BDB1-A3A1-BE232940664B}' /* Schieberegler */)) {
    echo 'Darstellung existiert bereits!';
}
```

## Vorlagenverwaltung

Quelle: https://www.symcon.de/de/service/dokumentation/befehlsreferenz/variablenverwaltung/variablendarstellung/vorlagenverwaltung/

## IPS_CreateTemplate

Quelle: https://www.symcon.de/de/service/dokumentation/befehlsreferenz/variablenverwaltung/variablendarstellung/vorlagenverwaltung/ips-createtemplate/

`string IPS_CreateTemplate(string $DarstellungsID)`

_Benötigt Symcon >= 8.0_

erstellt eine neue Vorlage für eine bestimmte Darstellung

**Parameter**

- `$DarstellungsID` (string): Die ID der Darstellung, als GUID formatiert, für die ein neue Vorlage angelegt werden soll

**Rückgabewert** (string): Die ID der neu erstellten Vorlage als GUID formatiert

Die ID der Darstellung, als GUID formatiert, für die ein neue Vorlage angelegt werden soll

**Beispiel**

```text
$vorlage = IPS_CreateTemplate('{6B9CAEEC-5958-C223-30F7-BD36569FC57A}' /* Schieberegler */);
```

## IPS_DeleteTemplate

Quelle: https://www.symcon.de/de/service/dokumentation/befehlsreferenz/variablenverwaltung/variablendarstellung/vorlagenverwaltung/ips-deletetemplate/

`bool IPS_DeleteTemplate(string $VorlagenID)`

_Benötigt Symcon >= 8.0_

löscht eine Vorlage

**Parameter**

- `$VorlagenID` (string): Die ID der zu löschenden Vorlage, als GUID formatiert

**Rückgabewert** (bool): Konnte der Befehl erfolgreich ausgeführt werden, liefert er als Ergebnis **TRUE**, andernfalls **FALSE**.

Die ID der zu löschenden Vorlage, als GUID formatiert

**Beispiel**

```text
// Löscht die Vorlage mit der GUID {8422E41F-00AA-33F7-E8A4-BB516EC0056B}
IPS_DeleteTemplate('{8422E41F-00AA-33F7-E8A4-BB516EC0056B}');
```

## IPS_GetTemplate

Quelle: https://www.symcon.de/de/service/dokumentation/befehlsreferenz/variablenverwaltung/variablendarstellung/vorlagenverwaltung/ips-gettemplate/

`array IPS_GetTemplate(string $VorlagenID)`

_Benötigt Symcon >= 8.0_

liefert umfassende Informationen über eine Vorlage

**Parameter**

- `$VorlagenID` (string): Die ID der Vorlage, als GUID formatiert

**Rückgabewert** (array): Folgende Informationen stehen als **key=>value** Paare zur Verfügung:

| Index          | Typ    | Beschreibung                                       |
| -------------- | ------ | -------------------------------------------------- |
| TemplateID     | string | Die ID der Vorlage                                 |
| PresentationID | string | Die ID der Darstellung zu der diese Vorlage gehört |
| DisplayName    | string | Der Anzeigename der Vorlage                        |
| Values         | array  | Ein Array mit den Werten der Vorlage               |
| ReadOnly       | bool   | Ob die Vorlage verändert werden kann               |

Die ID der Vorlage, als GUID formatiert

**Beispiel**

```text
// Liefert Informationen über die Raumtemperatur Vorlage
print_r(IPS_GetTemplate('{868B087E-A38D-2155-EBE0-157AFBBF9E8C}' /* Raumptemperatur */);
/* Beispielausgabe:
Array
(
    [TemplateID] => {868B087E-A38D-2155-EBE0-157AFBBF9E8C}
    [PresentationID] => {6B9CAEEC-5958-C223-30F7-BD36569FC57A}
    [DisplayName] => Raumtemperatur
    [Values] => Array
        (
            [MIN] => 15
            [DIGITS] => 1
            [CUSTOM_GRADIENT] => []
            [DECIMAL_SEPARATOR] => Client
            [GRADIENT_TYPE] => 1
            [MAX] => 25
            [INTERVALS] => []
            [INTERVALS_ACTIVE] =>
            [PERCENTAGE] =>
            [PREFIX] =>
            [STEP_SIZE] => 0.5
            [SUFFIX] =>  °C
            [THOUSANDS_SEPARATOR] =>
            [USAGE_TYPE] => 0
        )

    [IsReadOnly] => 1
)
*/
```

## IPS_GetTemplateList

Quelle: https://www.symcon.de/de/service/dokumentation/befehlsreferenz/variablenverwaltung/variablendarstellung/vorlagenverwaltung/ips-gettemplatelist/

`array IPS_GetTemplateList()`

_Benötigt Symcon >= 8.0_

liefert alle verfügbaren Vorlagen

**Rückgabewert** (array): Eine Liste der IDs aller verfügbaren Vorlagen

Die Funktion gibt die IDs aller verfügbaren Vorlagen in einem Array zurück. Mit der Funktion [IPS_GetTemplate](management-variables.md) können mehr Informationen über die einzelnen Vorlagen abgerufen werden.

**Beispiel**

```text
print_r(IPS_GetTemplateList());
```

## IPS_GetTemplateListByPresentation

Quelle: https://www.symcon.de/de/service/dokumentation/befehlsreferenz/variablenverwaltung/variablendarstellung/vorlagenverwaltung/ips-gettemplatelistbypresentation/

`array IPS_GetTemplateListByPresentation(string $DarstellungsID)`

_Benötigt Symcon >= 8.0_

liefert eine Liste der Vorlagen einer Darstellung

**Parameter**

- `$DarstellungsID` (string): Die ID der Darstellung deren Vorlagen aufgelistet werden sollen

**Rückgabewert** (array): Ein Array der IDs einer Darstellung

Die ID der Darstellung deren Vorlagen aufgelistet werden sollen

**Beispiel**

```text
print_r(IPS_GetTemplateListByPresentation('{6B9CAEEC-5958-C223-30F7-BD36569FC57A}' /* Schieberegler */));
```

## IPS_SetTemplateName

Quelle: https://www.symcon.de/de/service/dokumentation/befehlsreferenz/variablenverwaltung/variablendarstellung/vorlagenverwaltung/ips-settemplatename/

`bool IPS_SetTemplateName(string $VorlagenID, string $Name)`

_Benötigt Symcon >= 8.0_

setzt den Namen einer Vorlage

**Parameter**

- `$VorlagenID` (string): Die ID der Vorlage deren Name angepasst werden soll
- `$Name` (string): Der Wert auf den der Name der Vorlage gesetzt werden soll

**Rückgabewert** (bool): Konnte der Befehl erfolgreich ausgeführt werden, liefert er als Ergebnis **TRUE**, andernfalls **FALSE**.

Der Wert auf den der Name der Vorlage gesetzt werden soll

**Beispiel**

```text
IPS_SetTemplateName('{3C257416-99FE-0386-D8D3-20437FF62CEB}' , 'Neue Vorlage');
```

## IPS_SetTemplateValues

Quelle: https://www.symcon.de/de/service/dokumentation/befehlsreferenz/variablenverwaltung/variablendarstellung/vorlagenverwaltung/ips-settemplatevalues/

`bool IPS_SetTemplateValues(string $VorlagenID, array $Werte)`

_Benötigt Symcon >= 8.0_

setzt die Werte einer Vorlage

**Parameter**

- `$VorlagenID` (string): Die ID der Vorlage deren Werte angepasst werden sollen
- `$Werte` (array): Ein Array auf welchen die Werte der Vorlage gesetzt werden soll

**Rückgabewert** (bool): Konnte der Befehl erfolgreich ausgeführt werden, liefert er als Ergebnis **TRUE**, andernfalls **FALSE**.

Ein Array auf welchen die Werte der Vorlage gesetzt werden soll

**Beispiel**

```php
IPS_SetTemplateValues('{E35A875A-E9BC-4C6D-A550-F4DA423BCF18}', ['PROFILE' => '~Intensity.100']);
```

## IPS_TemplateExists

Quelle: https://www.symcon.de/de/service/dokumentation/befehlsreferenz/variablenverwaltung/variablendarstellung/vorlagenverwaltung/ips-templateexists/

`bool IPS_TemplateExists(string $VorlagenID)`

_Benötigt Symcon >= 8.0_

prüft ob eine Vorlage existiert

**Parameter**

- `$VorlagenID` (string): ID der zu prüfenden Vorlage als GUID formatiert

**Rückgabewert** (bool): Falls eine Vorlage mit der **VorlagenGUID** existiert, wird TRUE zurückgemeldet, andernfalls FALSE.

ID der zu prüfenden Vorlage als GUID formatiert

**Beispiel**

```php
if (IPS_TemplateExists('{868B087E-A38D-2155-EBE0-157AFBBF9E8C}' /* Raumtemperatur */)) {
    echo 'Vorlage existiert bereits!';
}
```

## Variablenprofile

Quelle: https://www.symcon.de/de/service/dokumentation/befehlsreferenz/variablenverwaltung/variablenprofile/

## IPS_CreateVariableProfile

Quelle: https://www.symcon.de/de/service/dokumentation/befehlsreferenz/variablenverwaltung/variablenprofile/ips-createvariableprofile/

`bool IPS_CreateVariableProfile(string $ProfilName, int $VariablenTyp)`

legt ein Variablenprofil an

**Parameter**

- `$ProfilName` (string): Name des Profils. Erlaubt sind A-Z, a-z, Punkt, Komma, Unterstrich
- `$VariablenTyp` (int)

  | Wert | Beschreibung                                             |
  | ---- | -------------------------------------------------------- |
  | 0    | Legt ein Variablenprofil für VariablenTyp __Boolean__ an |
  | 1    | Legt ein Variablenprofil für VariablenTyp __Integer__ an |
  | 2    | Legt ein Variablenprofil für VariablenTyp __Float__ an   |
  | 3    | Legt ein Variablenprofil für VariablenTyp __String__ an  |

**Rückgabewert** (bool): Konnte der Befehl erfolgreich ausgeführt werden, liefert er als Ergebnis __TRUE__, andernfalls __FALSE__.

| Wert | Beschreibung                                             |
| ---- | -------------------------------------------------------- |
| 0    | Legt ein Variablenprofil für VariablenTyp __Boolean__ an |
| 1    | Legt ein Variablenprofil für VariablenTyp __Integer__ an |
| 2    | Legt ein Variablenprofil für VariablenTyp __Float__ an   |
| 3    | Legt ein Variablenprofil für VariablenTyp __String__ an  |

**Beispiel**

```php
//Anlegen eines Profils für Boolean-Variablen
IPS_CreateVariableProfile("Schalter", 0);
//... hier die weitere Konfiguration des Profils
```

## IPS_DeleteVariableProfile

Quelle: https://www.symcon.de/de/service/dokumentation/befehlsreferenz/variablenverwaltung/variablenprofile/ips-deletevariableprofile/

`bool IPS_DeleteVariableProfile(string $ProfilName)`

löscht ein Variablenprofil

**Parameter**

- `$ProfilName` (string): Name des zu löschenden Profils

**Rückgabewert** (bool): Konnte der Befehl erfolgreich ausgeführt werden, liefert er als Ergebnis __TRUE__, andernfalls __FALSE__.

Name des zu löschenden Profils

**Beispiel**

```php
//Löschen des Schalter Profils
IPS_DeleteVariableProfile("Schalter");
```

## IPS_GetVariableProfile

Quelle: https://www.symcon.de/de/service/dokumentation/befehlsreferenz/variablenverwaltung/variablenprofile/ips-getvariableprofile/

`array IPS_GetVariableProfile(string $ProfilName)`

liefert umfassende Informationen zu einem bestimmten Variablenprofil

**Parameter**

- `$ProfilName` (string): Name des Variablenprofils

**Rückgabewert** (array): Folgende Informationen stehen als __key => value__ Paare zur Verfügung:

| Index            | Typ     | Beschreibung                                                                         |
| ---------------- | ------- | ------------------------------------------------------------------------------------ |
| __Associations__ | array   | Array mit Wert, Name, Icon, Color Paaren (siehe Associations Tabelle)                |
| __Icon__         | string  | Icon des Variablenprofils                                                            |
| __IsReadOnly__   | boolean | TRUE, wenn es ein systemerstelltes Profil ist, welches nicht geändert werden kann.   |
| __MaxValue__     | float   | Maximalwert für die Visualisierung                                                   |
| __MinValue__     | float   | Minimalwert für die Visualisierung                                                   |
| __StepSize__     | float   | Schrittweite für die Visualisierung; 0, wenn Assoziationstabelle genutzt werden soll |
| __Digits__       | integer | Anzahl der Nachkommastellen                                                          |
| __Prefix__       | string  | Präfix für die Visualisierung                                                        |
| __Suffix__       | string  | Suffix für die Visualisierung                                                        |
| __ProfileName__  | string  | Name des Profils (~ = Systemprofil)                                                  |
| __ProfileType__  | integer | Typ des Profils (Siehe ProfilTyp Tabelle)                                            |

__Associations Tabelle__

| Index     | Typ     | Beschreibung                                                                       |
| --------- | ------- | ---------------------------------------------------------------------------------- |
| __Value__ | float   | Wert, zu dem der Name und das Icon verknüpft werden sollen                         |
| __Name__  | string  | Name zum angegebenen Wert                                                          |
| __Icon__  | string  | Icon zum angegebenen Wert                                                          |
| __Color__ | integer | Farbwert im HTML Farbcode (z.b. 0x0000FF für Blau). Sonderfall: -1 für transparent |

__ProfilTyp__
Profiltyp und der Variablentyp ([IPS_CreateVariable](management-variables.md)) müssen identisch sein, damit eine Anzeige im WebFront korrekt dargestellt werden kann.

| Wert | Beschreibung                   |
| ---- | ------------------------------ |
| 0    | Ein Profil vom Typ __Boolean__ |
| 1    | Ein Profil vom Typ __Integer__ |
| 2    | Ein Profil vom Typ __Float__   |
| 3    | Ein Profil vom Typ __String__  |

Name des Variablenprofils

**Beispiel**

```php
print_r( IPS_GetVariableProfile("~WindDirection") );

/* liefert z.B.:
Array
(
    [Associations] => Array
    (
    )

    [Digits] => 1
    [Icon] => WindDirection
    [IsReadOnly] => 1
    [MaxValue] => 360
    [MinValue] => 0
    [Prefix] =>
    [ProfileName] => ~WindDirection
    [ProfileType] => 2
    [StepSize] => 60
    [Suffix] => °
)
*/
```

## IPS_GetVariableProfileList

Quelle: https://www.symcon.de/de/service/dokumentation/befehlsreferenz/variablenverwaltung/variablenprofile/ips-getvariableprofilelist/

`array IPS_GetVariableProfileList()`

liefert eine Liste aller existierenden Variablenprofile

**Rückgabewert** (array): Ein Array von String-Werten aller Namen der Variablenprofile

Die Funktion ermittelt in IP-Symcon vorhandenen Variablenprofile. Die Namen werden in einem Array aufgelistet.

**Beispiel**

```php
$Profile = IPS_GetVariableProfileList();
print_r($Profile);

/* liefert z.B.:
Array
(
    [0] => ~Temperature
    [1] => ~Humidity
    [2] => ~AirPressure
    usw. ...
*/
```

## IPS_GetVariableProfileListByType

Quelle: https://www.symcon.de/de/service/dokumentation/befehlsreferenz/variablenverwaltung/variablenprofile/ips-getvariableprofilelistbytype/

`array IPS_GetVariableProfileListByType(int $VariablenTyp)`

liefert eine Liste aller existierenden Variablenprofile eines bestimmten Typs

**Parameter**

- `$VariablenTyp` (int)

  | Wert | Beschreibung              |
  | ---- | ------------------------- |
  | 0    | Sucht vom Typ __Boolean__ |
  | 1    | Sucht vom Typ __Integer__ |
  | 2    | Sucht vom Typ __Float__   |
  | 3    | Sucht vom Typ __String__  |

**Rückgabewert** (array): Ein Array von String-Werten aller Namen der Variablenprofile

| Wert | Beschreibung              |
| ---- | ------------------------- |
| 0    | Sucht vom Typ __Boolean__ |
| 1    | Sucht vom Typ __Integer__ |
| 2    | Sucht vom Typ __Float__   |
| 3    | Sucht vom Typ __String__  |

**Beispiel**

```php
$Profile = IPS_GetVariableProfileListByType(0);
print_r($Profile);

/* liefert z.B.:
Array
(
    [0] => ~Switch
    [1] => ~Alert
    [2] => ~Alert.Reversed
    usw. ...
*/
```

## IPS_SetVariableProfileAssociation

Quelle: https://www.symcon.de/de/service/dokumentation/befehlsreferenz/variablenverwaltung/variablenprofile/ips-setvariableprofileassociation/

`bool IPS_SetVariableProfileAssociation(string $ProfilName, mixed $Wert, string $Name, string $Icon, int $Farbe)`

modifiziert die Assoziationstabelle eines Variablenprofils

**Parameter**

- `$ProfilName` (string): Name des Profils. Verfügbare Profile können über [IPS_GetVariableProfileList](management-variables.md) abgefragt werden.
- `$Wert` (mixed): Wert, zu dem der Name, das Icon und die Farbe verknüpft werden sollen
- `$Name` (string): Name zum angegebenen Wert
- `$Icon` (string): Icon zum angegebenen Wert
- `$Farbe` (int): Farbwert im HTML Farbcode (z.b. 0x0000FF für Blau). Sonderfall: -1 für transparent

**Rückgabewert** (bool): Konnte der Befehl erfolgreich ausgeführt werden, liefert er als Ergebnis __TRUE__, andernfalls __FALSE__.

Farbwert im HTML Farbcode (z.b. 0x0000FF für Blau). Sonderfall: -1 für transparent

**Beispiel**

```php
//Anlegen für Wert 1 in der Farbe weiß
IPS_SetVariableProfileAssociation("Temperatur", 1, "Wert 1", "Speaker", 0xFFFFFF);

//Anlegen für Wert "sum" in der Farbe gelb
IPS_SetVariableProfileAssociation("Jahreszeit", "sum", "Sommer", "Sun", 0xFFFF00);

//Löschen für Wert 1
IPS_SetVariableProfileAssociation("Temperatur", 1, "", "", -1);
```

## IPS_SetVariableProfileDigits

Quelle: https://www.symcon.de/de/service/dokumentation/befehlsreferenz/variablenverwaltung/variablenprofile/ips-setvariableprofiledigits/

`bool IPS_SetVariableProfileDigits(string $ProfilName, int $Nachkommastellen)`

setzt die Anzahl der Nachkommastellen eines Variablenprofils

**Parameter**

- `$ProfilName` (string): Name des Profils. Verfügbare Profile können über [IPS_GetVariableProfileList](management-variables.md) abgefragt werden.
- `$Nachkommastellen` (int): Anzahl der in der Visualisierung angezeigten Nachkommastellen

**Rückgabewert** (bool): Konnte der Befehl erfolgreich ausgeführt werden, liefert er als Ergebnis __TRUE__, andernfalls __FALSE__.

Anzahl der in der Visualisierung angezeigten Nachkommastellen

**Beispiel**

```php
IPS_SetVariableProfileDigits("Temperatur", 1);
```

## IPS_SetVariableProfileIcon

Quelle: https://www.symcon.de/de/service/dokumentation/befehlsreferenz/variablenverwaltung/variablenprofile/ips-setvariableprofileicon/

`bool IPS_SetVariableProfileIcon(string $ProfilName, string $Icon)`

setzt das Icon eines Variablenprofils

**Parameter**

- `$ProfilName` (string): Name des Profils. Verfügbare Profile können über [IPS_GetVariableProfileList](management-variables.md) abgefragt werden.
- `$Icon` (string): Icon zum angegebenen Wert

**Rückgabewert** (bool): Konnte der Befehl erfolgreich ausgeführt werden, liefert er als Ergebnis __TRUE__, andernfalls __FALSE__.

Icon zum angegebenen Wert

**Beispiel**

```php
IPS_SetVariableProfileIcon("Temperatur",  "Temperature");
```

## IPS_SetVariableProfileText

Quelle: https://www.symcon.de/de/service/dokumentation/befehlsreferenz/variablenverwaltung/variablenprofile/ips-setvariableprofiletext/

`bool IPS_SetVariableProfileText(string $ProfilName, string $Präfix, string $Suffix)`

setzt das Prefix und Suffix eines Variablenprofils

**Parameter**

- `$ProfilName` (string): Name des Profils. Verfügbare Profile können über [IPS_GetVariableProfileList](management-variables.md) abgefragt werden.
- `$Präfix` (string): Prefix für den Wert
- `$Suffix` (string): Suffix für den Wert

**Rückgabewert** (bool): Konnte der Befehl erfolgreich ausgeführt werden, liefert er als Ergebnis __TRUE__, andernfalls __FALSE__.

Suffix für den Wert

**Beispiel**

```php
IPS_SetVariableProfileText("Schalter", "", "%");
```

## IPS_SetVariableProfileValues

Quelle: https://www.symcon.de/de/service/dokumentation/befehlsreferenz/variablenverwaltung/variablenprofile/ips-setvariableprofilevalues/

`bool IPS_SetVariableProfileValues(string $ProfilName, float $Minimalwert, float $Maximalwert, float $Schrittweite)`

setzt den Minimalwert, Maximalwert und die Schrittweite eines Variablenprofils

**Parameter**

- `$ProfilName` (string): Name des Profils. Verfügbare Profile können über [IPS_GetVariableProfileList](management-variables.md) abgefragt werden.
- `$Minimalwert` (float): Der für die Visualisierung genutzte Minimalwert. Diese Soft-Limitation beeinflusst nicht den Variablenwert.
- `$Maximalwert` (float): Der für die Visualisierung genutzte Maximalwert. Diese Soft-Limitation beeinflusst nicht den Variablenwert.
- `$Schrittweite` (float): Die für die Visualisierung genutzte Schrittweite zur Erstellung der Sollwert-Veränderngsleiste. Eine Schrittweite von __0__ aktiviert die Assoziationsliste.

**Rückgabewert** (bool): Konnte der Befehl erfolgreich ausgeführt werden, liefert er als Ergebnis __TRUE__, andernfalls __FALSE__.

Die für die Visualisierung genutzte Schrittweite zur Erstellung der Sollwert-Veränderngsleiste. Eine Schrittweite von __0__ aktiviert die Assoziationsliste.

**Beispiel**

```php
IPS_SetVariableProfileValues("Temperatur", -10, 40, 0.5);
```

## IPS_VariableProfileExists

Quelle: https://www.symcon.de/de/service/dokumentation/befehlsreferenz/variablenverwaltung/variablenprofile/ips-variableprofileexists/

`bool IPS_VariableProfileExists(string $ProfilName)`

prüft, ob ein bestimmtes Variablenprofil existiert

**Parameter**

- `$ProfilName` (string): Name des gesuchten Variablenprofils

**Rückgabewert** (bool): Falls das Profil mit dem Namen __ProfilName__ im System existiert, wird __TRUE__ zurückgemeldet, andernfalls __FALSE__.

Name des gesuchten Variablenprofils

**Beispiel**

```php
if (IPS_VariableProfileExists("Temperatur"))
    echo "Profil existiert bereits!";
```