Download handbuch

Transcript
SCRIPTINGHANDBUCH
5.3 LADEN EINES OBJEKTS
Um ein Objekt als Variable in ein Script zu laden, kann folgender Aufruf verwendet werden:
$namevariable = objM::objGet(XXX);
XXX ist die einzigartige numerische ID, welche das Objekt innerhalb der Software identifiziert. Die ID eines Objekts kann
über die Suchfunktion in der Konfigurations-Ebene festgestellt werden, wie in folgendem Ausschnitt ersichtlich:
Für das im Screenshot gezeigte “Szenario Film” würde der Aufruf im Script z.B. folgendermaßen lauten:
$scenarioFilm = objM::objGet(548);
Die Variable, die nun eine Referenz des gewählten Objekts enthält, stellt folgende Eigenschaften im Script zur Verfügung:
Eigenschaft
Beschreibung
Beispiel Zugriff
id
ID des Objekts
$obj->id
name
Bezeichnung des Objekts innerhalb der Visualisierung
$obj->name
state
Aktueller Status des Objekts.
$obj->state
HINWEIS: diese Eigenschaft kann nur in Kombination mit
Szenarien verwendet werden; in diesem Fall:
1 → Szenario gestoppt
2 → Szenario in Ausführung
value
Aktueller Wert des Objekts
$obj->value
HINWEIS: diese Eigenschaft kann mit allen Objekt-Typen, die
über einen Wert verfügen, verwendet werden, außer den
Szenarien (siehe Eigenschaft „state“)
enabled
Gibt Auskunft, ob das Objekt aktiv ist oder nicht. Mögliche $obj->enabled
Werte: 0 , 1
msp
Wichtigster Parameter des Objekts, in Abhängigkeit des Typs. $obj->msp
Einige Beispiele:
•
KNX Objekte: Gruppenadresse
- 25 -