Aktionen

Benötigt: IP-Symcon >= 6.0

Beschreibung

Es ist möglich eigene Aktionen als Teil der Bibliothek zu definieren. Diese können nach der Installation der Bibliothek wie unter Aktionen beschrieben verwendet werden.
Werden Aktionen abgespeichert oder konfiguriert resultiert dies in drei Werten: Dem Aktionsziel, der AktionsID und den Aktionsparametern. Das Aktionsziel stellt hierbei das Zielobjekt dar, beispielsweise im Falle eines Ereignisses das darunterliegende Objekt. Die AktionsID identifiziert eindeutig die ausgewählte Aktion. Die Parameter sind eine Menge an Werten, welche individuell zur Aktion gehören. Hierdurch kann ein Benutzer eine Aktion weiter parametrisieren und beispielsweise angeben auf welchen Wert eine Variable geschaltet werden soll.

Struktur

Für jede Aktion, welche Teil der Bibliothek sein soll, muss eine JSON-Datei im Unterordner "actions" der Bibliothek erstellt werden. Diese JSON-Datei muss ein JSON-Objekt beinhalten, welches der folgenden Struktur folgt.

category

restrictions

Restriktionen für alle Objekttypen

Restriktionen für Zielobjekte vom Typ Instanz

Restriktionen für Zielobjekte vom Typ Variable

Restriktionen für Zielobjekte vom Typ Automation

Restriktionen für Zielobjekte vom Typ Ereignis

Umgebungen

Systemvariablen

Sowohl in einem möglichen PHP-Skript für die Form als auch in dem Skript für die Ausführung kann via Systemvariablen auf das Ziel der Aktion und die eingestellten Parameter zugegriffen werden. So stehen folgende Systemvariablen in diesen Skripten zur Verfügung:

Formatierung

Im Feld format können alle Typen des ICU-Formats verwendet werden. Zusätzlich wurden Symcon-spezifische Typen eingeführt. Wie bei ICU üblich, bestehen diese aus drei Teilen: Der Parameterbezeichnung, der Typbezeichnung und optionalen zusätzlichen Parametern.

profile

Der Wert wird auf Basis des Profils der Zielvariablen dargestellt. Hat das Ziel kein Profil, so wird der Wert direkt dargestellt.

Beispiele: {VALUE, profile}

object

Es wird der Name des Objekts mit der ObjektID des Wertes dargestellt.

Beispiele: {VARIABLE, object}, {TARGET, object, ident IDENT}

action

Es wird die Formatierung der Aktion, welche als JSON-String codiert im Wert steht, dargestellt.

Beispiele: {ACTION, action}, {ACTION, action, targetID VARIABLE}, {ACTION, action, targetID TARGET ident IDENT}, {ACTION, action, linkTarget}, {ACTION, action, targetID LINK linkTarget}

scheduleAction

Es werden die Namen von Wochenplanaktionen von Wochenplänen unter dem angegebenen Elternobjekt mit der ID des Wertes dargestellt.

Beispiele: {SCHEDULE_ACTION, scheduleAction, parent PARENT}, {SCHEDULE_ACTION, scheduleAction, parent PARENT action '{7938A5A2-0981-5FE0-BE6C-8AA610D654EB}'}

Beispiele

switchValueString.json

{
     "id": "{A4D52B67-BE4B-4AD0-964F-B9BA2556AAB0}",
     "caption": "Switch to Value",
     "form": [
         {
             "type": "ValidationTextBox",
             "name": "VALUE",
             "caption": "Value"
         }
     ],
     "action": "RequestAction($_IPS['TARGET'], $_IPS['VALUE']);",
     "restrictions": {
         "objectType": [ 2 ],
         "variableType": [ 3 ],
         "profileIsEnum": false,
         "requestAction": true
     },
     "priority": 10,
     "locale": {
         "de": {
             "Switch to Value": "Schalte auf Wert",
             "Value": "Wert",
             "Set to {VALUE, profile}": "Setze auf {VALUE, profile}"
         }
     },
     "format": "Set to {VALUE, profile}"
 }

setValueIntegerPreviousReminder.json

{
     "id": "{92971E6F-4AC1-BEF8-B325-9E044D27B3EB}",
     "caption": "Set to Value",
     "form": [
         "$form = [",
         "    {",
         "        'type' => 'SelectColor',",
         "        'name' => 'VALUE',",
         "        'allowTransparent' => false,",
         "        'caption' => 'Value',",
         "        'writable' => true",
         "    }",
         "];",
         "if (isset($_IPS['VALUE'])) {",
         "    $form[] = {",
         "        'type' => 'Label'",
         "        'caption' => 'Previously selected value: ' . $_IPS['VALUE']",
         "    };",
         "}",
         "return $form;"
     ],
     "action": "SetValue($_IPS['TARGET'], $_IPS['VALUE']);",
     "restrictions": {
         "objectType": [ 2 ],
         "variableType": [ 1 ],
         "profilesExclude": [ "~HexColor" ]
     },
     "priority": 5,
     "locale": {
         "de": {
             "Set to Value": "Setze auf Wert",
             "Value": "Wert",
             "Set to {VALUE, profile}": "Setze auf {VALUE, profile}"
         }
     },
     "format": "Set to {VALUE, profile}"
 }

switchStatusVariable.json

{
     "id": "{E616C2B2-A827-1712-4AE0-841C57B3DD74}",
     "caption": "Switch Status Variable",
     "form": [
         "$options = [];",
         "$firstVariable = false;",
         "foreach (IPS_GetChildrenIDs($_IPS['TARGET']) as $childID) {",
         "    $object = IPS_GetObject($childID);",
         "    if (($object['ObjectType'] === 2) && ($object['ObjectIdent'] !== '')) {",
         "        if (!HasAction($childID)) {",
         "            continue;",
         "        }",
         "        if (!$firstVariable) {",
         "            $firstVariable = $object;",
         "        }",
         "        $options[] = [",
         "            'caption' => $object['ObjectName'],",
         "            'value' => $object['ObjectIdent']",
         "        ];",
         "    }",
         "}",
         "return [",
         "   [",
         "       'type' => 'Select',",
         "       'name' => 'IDENT',",
         "       'caption' => 'Status Variable',",
         "       'options' => $options,",
         "       'value' => $firstVariable['ObjectIdent'],",
         "       'onChange' => 'IPS_UpdateFormField(\"ACTION\", \"targetID\", IPS_GetObjectIDByIdent($IDENT, ' . $_IPS['TARGET'] . '), $id);'",
         "   ],",
         "   [",
         "       'type' => 'SelectAction',",
         "       'name' => 'ACTION',",
         "       'caption' => 'Action',",
         "       'targetID' => isset($_IPS['IDENT']) ? IPS_GetObjectIDByIdent($_IPS['IDENT'], $_IPS['TARGET']) : $firstVariable['ObjectID']",
         "   ]",
         "];"
     ],
     "action": [
         "$targetVariableID = IPS_GetObjectIDByIdent($_IPS['IDENT'], $_IPS['TARGET']);",
         "$action = json_decode($_IPS['ACTION'], true);",
         "echo IPS_RunActionWait($action['actionID'], $targetVariableID, $action['parameters']);"
     ],
     "restrictions": {
         "objectType": [ 1 ],
         "hasActionStatusVariables": true
     },
     "locale": {
         "de": {
             "Switch Status Variable": "Schalte Statusvariable",
             "Status Variable": "Statusvariable",
             "{TARGET, object, ident IDENT}: Switch Variable": "{TARGET, object, ident IDENT}: Schalte Variable"
         }
     },
     "format": "{TARGET, object, ident IDENT}: {ACTION, action, targetID TARGET ident IDENT}",
     "readable": [
         "$targetVariableID = IPS_GetObjectIDByIdent($_IPS['IDENT'], $_IPS['TARGET']);",
         "$action = json_decode($_IPS['ACTION'], true);",
         "$action['parameters']['TARGET'] = $targetVariableID;",
         "$action['parameters']['ENVIRONMENT'] = $_IPS['ENVIRONMENT'];",
         "$action['parameters']['PARENT'] = $_IPS['PARENT'];",
         "echo IPS_GetActionReadableCode($action['actionID'], $action['parameters']) . \"\\n\";"
     ]
 }

multiplySetVariable.json (veraltete Aktion)

{
     "id": "{085176EC-BEE5-3732-15E5-8C82875CABD4}",
     "caption": "Multiply with Value of other Variable",
     "form": [
         "$variable = IPS_GetVariable($_IPS['TARGET']);",
         "$types = [];",
         "if ($variable['VariableType'] === 2) {",
         "    $types = [1, 2];",
         "}",
         "else {",
         "    $types = [ $variable['VariableType'] ];",
         "}",
         "return [",
         "   [",
         "       'type' => 'SelectVariable',",
         "       'name' => 'VARIABLE',",
         "       'caption' => 'Variable',",
         "       'validVariableTypes' => $types",
         "   ]",
         "];"
     ],
     "action": "SetValue($_IPS['TARGET'], GetValue($_IPS['TARGET']) * GetValue($_IPS['VARIABLE']));",
     "restrictions": {
         "objectType": [ 2 ],
         "variableType": [ 1, 2 ],
         "profileIsEnum": false,
         "writable": true
     },
     "locale": {
         "de": {
             "Multiply with Value of other Variable": "Multipliziere mit Wert einer anderen Variablen",
             "Variable": "Variable",
             "Multiply by value of {VARIABLE, object}": "Multipliziere mit Wert von {VARIABLE, object}",
             "Set the target variable to its current value multiplied with the value of another variable": "Setze die Zielvariable auf ihren aktuellen Wert multipliziert mit dem Wert einer anderen Variablen"
         }
     },
     "format": "Multiply by value of {VARIABLE, object}",
     "category": "math",
     "description": "Set the target variable to its current value multiplied with the value of another variable",
     "deprecated": [
         "return [",
         "   'actionID' => '{A3153696-013A-41B1-A001-5E8085D95465}',",
         "   'parameters' => [",
         "       'DYNAMIC' => true,",
         "       'FACTOR' => 0,",
         "       'VARIABLE' => $_IPS['VARIABLE']",
         "   ]",
         "];"
     ]
 }