Dies ist die Beschreibung der LabVIEW API Bindings für das Ambient Light Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Ambient Light Bricklet sind in dessen Hardware Beschreibung zusammengefasst.
Eine Installationanleitung für die LabVIEW API Bindings ist Teil deren allgemeine Beschreibung.
Der folgende Beispielcode ist Public Domain (CC0 1.0).
Prinzipiell kann jede Funktion der LabVIEW Bindings, welche einen Wert ausgibt
eine Tinkerforge.TimeoutException
melden. Dieser Fehler wird
gemeldet wenn das Gerät nicht antwortet. Wenn eine Kabelverbindung genutzt
wird, ist es unwahrscheinlich, dass die Exception geworfen wird (unter der
Annahme, dass das Gerät nicht abgesteckt wird). Bei einer drahtlosen Verbindung
können Zeitüberschreitungen auftreten, sobald die Entfernung zum Gerät zu
groß wird.
Der Namensraum für alle Brick/Bricklet Bindings und die IPConnection ist
Tinkerforge.*
.
BrickletAmbientLight
(uid, ipcon) → ambientLight¶Eingabe: |
|
---|---|
Ausgabe: |
|
Erzeugt ein Objekt mit der eindeutigen Geräte ID uid
.
Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.
BrickletAmbientLight.
GetIlluminance
() → illuminance¶Ausgabe: |
|
---|
Gibt die Beleuchtungsstärke des Umgebungslichtsensors zurück.
Wenn die Beleuchtungsstärke periodisch abgefragt werden soll, wird empfohlen
den IlluminanceCallback
Callback zu nutzen und die Periode mit
SetIlluminanceCallbackPeriod()
vorzugeben.
BrickletAmbientLight.
GetAnalogValue
() → value¶Ausgabe: |
|
---|
Gibt den Wert, wie vom 12-Bit Analog-Digital-Wandler gelesen, zurück.
Bemerkung
Der von GetIlluminance()
zurückgegebene Wert ist über mehrere
Messwerte gemittelt um das Rauschen zu vermindern, während GetAnalogValue()
unverarbeitete Analogwerte zurück gibt. Der einzige Grund GetAnalogValue()
zu nutzen, ist die volle Auflösung des Analog-Digital-Wandlers zu erhalten.
Weiterhin deckt der Analog-Digital-Wandler drei unterschiedliche Bereiche ab, welche dynamisch gewechselt werden abhängig von der Lichtintensität. Es ist nicht möglich, anhand der Analogwerte, zwischen diesen Bereichen zu unterscheiden.
Wenn der Analogwert periodisch abgefragt werden soll, wird empfohlen
den AnalogValueCallback
Callback zu nutzen und die Periode mit
SetAnalogValueCallbackPeriod()
vorzugeben.
BrickletAmbientLight.
GetIdentity
() → uid, connectedUid, position, hardwareVersion, firmwareVersion, deviceIdentifier¶Ausgabe: |
|
---|
Gibt die UID, die UID zu der das Bricklet verbunden ist, die Position, die Hard- und Firmware Version sowie den Device Identifier zurück.
Die Position ist 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss). Ein Bricklet hinter einem Isolator Bricklet ist immer an Position 'z'.
Eine Liste der Device Identifier Werte ist hier zu finden. Es gibt auch eine Konstante für den Device Identifier dieses Bricklets.
BrickletAmbientLight.
SetIlluminanceCallbackPeriod
(period)¶Eingabe: |
|
---|
Setzt die Periode mit welcher der IlluminanceCallback
Callback ausgelöst wird.
Ein Wert von 0 deaktiviert den Callback.
Der IlluminanceCallback
Callback wird nur ausgelöst, wenn sich die
Beleuchtungsstärke seit der letzten Auslösung geändert hat.
BrickletAmbientLight.
GetIlluminanceCallbackPeriod
() → period¶Ausgabe: |
|
---|
Gibt die Periode zurück, wie von SetIlluminanceCallbackPeriod()
gesetzt.
BrickletAmbientLight.
SetAnalogValueCallbackPeriod
(period)¶Eingabe: |
|
---|
Setzt die Periode mit welcher der AnalogValueCallback
Callback ausgelöst wird.
Ein Wert von 0 deaktiviert den Callback.
Der AnalogValueCallback
Callback wird nur ausgelöst, wenn sich der Analogwert
seit der letzten Auslösung geändert hat.
BrickletAmbientLight.
GetAnalogValueCallbackPeriod
() → period¶Ausgabe: |
|
---|
Gibt die Periode zurück, wie von SetAnalogValueCallbackPeriod()
gesetzt.
BrickletAmbientLight.
SetIlluminanceCallbackThreshold
(option, min, max)¶Eingabe: |
|
---|
Setzt den Schwellwert für den IlluminanceReachedCallback
Callback.
Die folgenden Optionen sind möglich:
Option | Beschreibung |
---|---|
'x' | Callback ist inaktiv |
'o' | Callback wird ausgelöst, wenn die Beleuchtungsstärke außerhalb des min und max Wertes ist |
'i' | Callback wird ausgelöst, wenn die Beleuchtungsstärke innerhalb des min und max Wertes ist |
'<' | Callback wird ausgelöst, wenn die Beleuchtungsstärke kleiner als der min Wert ist (max wird ignoriert) |
'>' | Callback wird ausgelöst, wenn die Beleuchtungsstärke größer als der min Wert ist (max wird ignoriert) |
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
BrickletAmbientLight.
GetIlluminanceCallbackThreshold
() → option, min, max¶Ausgabe: |
|
---|
Gibt den Schwellwert zurück, wie von SetIlluminanceCallbackThreshold()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
BrickletAmbientLight.
SetAnalogValueCallbackThreshold
(option, min, max)¶Eingabe: |
|
---|
Setzt den Schwellwert für den AnalogValueReachedCallback
Callback.
Die folgenden Optionen sind möglich:
Option | Beschreibung |
---|---|
'x' | Callback ist inaktiv |
'o' | Callback wird ausgelöst, wenn der Analogwert außerhalb des min und max Wertes ist |
'i' | Callback wird ausgelöst, wenn der Analogwert innerhalb des min und max Wertes ist |
'<' | Callback wird ausgelöst, wenn der Analogwert kleiner als der min Wert ist (max wird ignoriert) |
'>' | Callback wird ausgelöst, wenn der Analogwert größer als der min Wert ist (max wird ignoriert) |
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
BrickletAmbientLight.
GetAnalogValueCallbackThreshold
() → option, min, max¶Ausgabe: |
|
---|
Gibt den Schwellwert zurück, wie von SetAnalogValueCallbackThreshold()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
BrickletAmbientLight.
SetDebouncePeriod
(debounce)¶Eingabe: |
|
---|
Setzt die Periode mit welcher die Schwellwert Callbacks
ausgelöst werden, wenn die Schwellwerte
weiterhin erreicht bleiben.
BrickletAmbientLight.
GetDebouncePeriod
() → debounce¶Ausgabe: |
|
---|
Gibt die Entprellperiode zurück, wie von SetDebouncePeriod()
gesetzt.
Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung erfolgt indem eine Funktion einem Callback Property des Geräte Objektes zugewiesen wird. Die verfügbaren Callback Properties und ihre Parametertypen werden weiter unten beschrieben.
Bemerkung
Callbacks für wiederkehrende Ereignisse zu verwenden ist immer zu bevorzugen gegenüber der Verwendung von Abfragen. Es wird weniger USB-Bandbreite benutzt und die Latenz ist erheblich geringer, da es keine Paketumlaufzeit gibt.
BrickletAmbientLight.
IlluminanceCallback
→ sender, illuminance¶Callback-Ausgabe: |
|
---|
Dieser Callback wird mit der Periode, wie gesetzt mit SetIlluminanceCallbackPeriod()
,
ausgelöst. Der Parameter ist die Beleuchtungsstärke des Umgebungslichtsensors.
Der IlluminanceCallback
Callback wird nur ausgelöst, wenn sich die
Beleuchtungsstärke seit der letzten Auslösung geändert hat.
BrickletAmbientLight.
AnalogValueCallback
→ sender, value¶Callback-Ausgabe: |
|
---|
Dieser Callback wird mit der Periode, wie gesetzt mit SetAnalogValueCallbackPeriod()
,
ausgelöst. Der Parameter ist der Analogwert des Umgebungslichtsensors.
Der AnalogValueCallback
Callback wird nur ausgelöst, wenn sich der Analogwert seit
der letzten Auslösung geändert hat.
BrickletAmbientLight.
IlluminanceReachedCallback
→ sender, illuminance¶Callback-Ausgabe: |
|
---|
Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von
SetIlluminanceCallbackThreshold()
gesetzt, erreicht wird.
Der Parameter ist die Beleuchtungsstärke des Umgebungslichtsensors.
Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie
mit SetDebouncePeriod()
gesetzt, ausgelöst.
BrickletAmbientLight.
AnalogValueReachedCallback
→ sender, value¶Callback-Ausgabe: |
|
---|
Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von
SetAnalogValueCallbackThreshold()
gesetzt, erreicht wird.
Der Parameter ist der Analogwert des Umgebungslichtsensors.
Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie
mit SetDebouncePeriod()
gesetzt, ausgelöst.
Virtuelle Funktionen kommunizieren nicht mit dem Gerät selbst, sie arbeiten nur auf dem API Bindings Objekt. Dadurch können sie auch aufgerufen werden, ohne das das dazugehörige IP Connection Objekt verbunden ist.
BrickletAmbientLight.
GetAPIVersion
() → apiVersion¶Ausgabe: |
|
---|
Gibt die Version der API Definition zurück, die diese API Bindings implementieren. Dies ist weder die Release-Version dieser API Bindings noch gibt es in irgendeiner Weise Auskunft über den oder das repräsentierte(n) Brick oder Bricklet.
BrickletAmbientLight.
GetResponseExpected
(functionId) → responseExpected¶Eingabe: |
|
---|---|
Ausgabe: |
|
Gibt das Response-Expected-Flag für die Funktion mit der angegebenen Funktions IDs zurück. Es ist true falls für die Funktion beim Aufruf eine Antwort erwartet wird, false andernfalls.
Für Getter-Funktionen ist diese Flag immer gesetzt und kann nicht entfernt
werden, da diese Funktionen immer eine Antwort senden. Für
Konfigurationsfunktionen für Callbacks ist es standardmäßig gesetzt, kann aber
entfernt werden mittels SetResponseExpected()
. Für Setter-Funktionen ist
es standardmäßig nicht gesetzt, kann aber gesetzt werden.
Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für functionId:
BrickletAmbientLight.
SetResponseExpected
(functionId, responseExpected)¶Eingabe: |
|
---|
Ändert das Response-Expected-Flag für die Funktion mit der angegebenen Funktion IDs. Diese Flag kann nur für Setter-Funktionen (Standardwert: false) und Konfigurationsfunktionen für Callbacks (Standardwert: true) geändert werden. Für Getter-Funktionen ist das Flag immer gesetzt.
Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für functionId:
BrickletAmbientLight.
SetResponseExpectedAll
(responseExpected)¶Eingabe: |
|
---|
Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.
BrickletAmbientLight.
DEVICE_IDENTIFIER
¶Diese Konstante wird verwendet um ein Ambient Light Bricklet zu identifizieren.
Die GetIdentity()
Funktion und der
IPConnection.EnumerateCallback
Callback der IP Connection haben ein deviceIdentifier
Parameter um den Typ
des Bricks oder Bricklets anzugeben.
BrickletAmbientLight.
DEVICE_DISPLAY_NAME
¶Diese Konstante stellt den Anzeigenamen eines Ambient Light Bricklet dar.