LabVIEW - Temperature IR Bricklet¶

Simple¶

Download (Example Simple.vi)

Water Boiling¶

Download (Example Water Boiling.vi), Download (Example Water Boiling - ObjectTemperatureReached Callback.vi)

Callback¶

Download (Example Callback.vi), Download (Example Callback - ObjectTemperature Callback.vi), Download (Example Callback - AmbientTemperature Callback.vi)

Graph¶

Download (Example Graph.vi), Download (Example Graph - ObjectTemperature Callback.vi)

Grundfunktionen¶

BrickletTemperatureIR(uid, ipcon) → temperatureIR¶

Eingabe:	uid – Typ: String ipcon – Typ: .NET Refnum (IPConnection)
Ausgabe:	temperatureIR – Typ: .NET Refnum (BrickletTemperatureIR)

Erzeugt ein Objekt mit der eindeutigen Geräte ID uid. Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.

BrickletTemperatureIR.GetAmbientTemperature() → temperature¶

Ausgabe:	temperature – Typ: Int16, Einheit: 1/10 °C, Wertebereich: [-400 bis 1250]

Gibt die Umgebungstemperatur des Sensors zurück.

Wenn die Umgebungstemperatur periodisch abgefragt werden soll, wird empfohlen den AmbientTemperatureCallback Callback zu nutzen und die Periode mit SetAmbientTemperatureCallbackPeriod() vorzugeben.

BrickletTemperatureIR.GetObjectTemperature() → temperature¶

Ausgabe:	temperature – Typ: Int16, Einheit: 1/10 °C, Wertebereich: [-700 bis 3800]

Gibt die Objekttemperatur des Sensors zurück, z.B. die Temperatur der Oberfläche auf welche der Sensor zielt.

Die Temperatur von unterschiedlichen Materialien ist abhängig von ihrem Emissionsgrad. Der Emissionsgrad des Materials kann mit SetEmissivity() gesetzt werden.

Wenn die Objekttemperatur periodisch abgefragt werden soll, wird empfohlen den ObjectTemperatureCallback Callback zu nutzen und die Periode mit SetObjectTemperatureCallbackPeriod() vorzugeben.

Fortgeschrittene Funktionen¶

BrickletTemperatureIR.SetEmissivity(emissivity)¶

Eingabe:	emissivity – Typ: Int32, Einheit: 1/65535, Wertebereich: [6553 bis 216 - 1], Standardwert: 216 - 1

Setzt den Emissionsgrad, welcher zur Berechnung der Oberflächentemperatur benutzt wird, wie von GetObjectTemperature() zurückgegeben.

Der Emissionsgrad wird normalerweise als Wert zwischen 0,0 und 1,0 angegeben. Eine Liste von Emissionsgraden unterschiedlicher Materialien ist hier zu finden.

Der Parameter von SetEmissivity() muss mit eine Faktor von 65535 (16-Bit) vorgegeben werden. Beispiel: Ein Emissionsgrad von 0,1 kann mit dem Wert 6553 gesetzt werden, ein Emissionsgrad von 0,5 mit dem Wert 32767 und so weiter.

Bemerkung

Wenn eine exakte Messung der Objekttemperatur notwendig ist, ist es entscheidend eine exakten Emissionsgrad anzugeben.

Der Emissionsgrad wird in nicht-flüchtigem Speicher gespeichert und wird auch noch einem Neustart weiter genutzt.

BrickletTemperatureIR.GetEmissivity() → emissivity¶

Ausgabe:	emissivity – Typ: Int32, Einheit: 1/65535, Wertebereich: [6553 bis 216 - 1], Standardwert: 216 - 1

Gibt den Emissionsgrad zurück, wie von SetEmissivity() gesetzt.

BrickletTemperatureIR.GetIdentity() → uid, connectedUid, position, hardwareVersion, firmwareVersion, deviceIdentifier¶

Ausgabe:

uid – Typ: String, Länge: bis zu 8 connectedUid – Typ: String, Länge: bis zu 8 position – Typ: Char, Wertebereich: ["a" bis "h", "z"] hardwareVersion – Typ: Byte[3] 0: major – Typ: Byte, Wertebereich: [0 bis 255] 1: minor – Typ: Byte, Wertebereich: [0 bis 255] 2: revision – Typ: Byte, Wertebereich: [0 bis 255] firmwareVersion – Typ: Byte[3] 0: major – Typ: Byte, Wertebereich: [0 bis 255] 1: minor – Typ: Byte, Wertebereich: [0 bis 255] 2: revision – Typ: Byte, Wertebereich: [0 bis 255] deviceIdentifier – Typ: Int32, Wertebereich: [0 bis 216 - 1]

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.

Konfigurationsfunktionen für Callbacks¶

BrickletTemperatureIR.SetAmbientTemperatureCallbackPeriod(period)¶

Eingabe:	period – Typ: Int64, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Setzt die Periode mit welcher der AmbientTemperatureCallback Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

Der AmbientTemperatureCallback Callback wird nur ausgelöst, wenn sich die Temperatur seit der letzten Auslösung geändert hat.

BrickletTemperatureIR.GetAmbientTemperatureCallbackPeriod() → period¶

Ausgabe:	period – Typ: Int64, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Gibt die Periode zurück, wie von SetAmbientTemperatureCallbackPeriod() gesetzt.

BrickletTemperatureIR.SetObjectTemperatureCallbackPeriod(period)¶

Eingabe:	period – Typ: Int64, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Setzt die Periode mit welcher der ObjectTemperatureCallback Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

Der ObjectTemperatureCallback Callback wird nur ausgelöst, wenn sich die Temperatur seit der letzten Auslösung geändert hat.

BrickletTemperatureIR.GetObjectTemperatureCallbackPeriod() → period¶

Ausgabe:	period – Typ: Int64, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Gibt die Periode zurück, wie von SetObjectTemperatureCallbackPeriod() gesetzt.

BrickletTemperatureIR.SetAmbientTemperatureCallbackThreshold(option, min, max)¶

Eingabe:	option – Typ: Char, Wertebereich: Siehe Konstanten, Standardwert: "x" min – Typ: Int16, Einheit: 1/10 °C, Wertebereich: [-215 bis 215 - 1], Standardwert: 0 max – Typ: Int16, Einheit: 1/10 °C, Wertebereich: [-215 bis 215 - 1], Standardwert: 0

Setzt den Schwellwert für den AmbientTemperatureReachedCallback Callback.

Die folgenden Optionen sind möglich:

Option	Beschreibung
'x'	Callback ist inaktiv
'o'	Callback wird ausgelöst, wenn die Umgebungstemperatur außerhalb des min und max Wertes ist
'i'	Callback wird ausgelöst, wenn die Umgebungstemperatur innerhalb des min und max Wertes ist
'<'	Callback wird ausgelöst, wenn die Umgebungstemperatur kleiner als der min Wert ist (max wird ignoriert)
'>'	Callback wird ausgelöst, wenn die Umgebungstemperatur größer als der min Wert ist (max wird ignoriert)

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für option:

• BrickletTemperatureIR.THRESHOLD_OPTION_OFF = "x"
• BrickletTemperatureIR.THRESHOLD_OPTION_OUTSIDE = "o"
• BrickletTemperatureIR.THRESHOLD_OPTION_INSIDE = "i"
• BrickletTemperatureIR.THRESHOLD_OPTION_SMALLER = "<"
• BrickletTemperatureIR.THRESHOLD_OPTION_GREATER = ">"

BrickletTemperatureIR.GetAmbientTemperatureCallbackThreshold() → option, min, max¶

Ausgabe:	option – Typ: Char, Wertebereich: Siehe Konstanten, Standardwert: "x" min – Typ: Int16, Einheit: 1/10 °C, Wertebereich: [-215 bis 215 - 1], Standardwert: 0 max – Typ: Int16, Einheit: 1/10 °C, Wertebereich: [-215 bis 215 - 1], Standardwert: 0

Gibt den Schwellwert zurück, wie von SetAmbientTemperatureCallbackThreshold() gesetzt.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für option:

• BrickletTemperatureIR.THRESHOLD_OPTION_OFF = "x"
• BrickletTemperatureIR.THRESHOLD_OPTION_OUTSIDE = "o"
• BrickletTemperatureIR.THRESHOLD_OPTION_INSIDE = "i"
• BrickletTemperatureIR.THRESHOLD_OPTION_SMALLER = "<"
• BrickletTemperatureIR.THRESHOLD_OPTION_GREATER = ">"

BrickletTemperatureIR.SetObjectTemperatureCallbackThreshold(option, min, max)¶

Eingabe:	option – Typ: Char, Wertebereich: Siehe Konstanten, Standardwert: "x" min – Typ: Int16, Einheit: 1/10 °C, Wertebereich: [-215 bis 215 - 1], Standardwert: 0 max – Typ: Int16, Einheit: 1/10 °C, Wertebereich: [-215 bis 215 - 1], Standardwert: 0

Setzt den Schwellwert für den ObjectTemperatureReachedCallback Callback.

Die folgenden Optionen sind möglich:

Option	Beschreibung
'x'	Callback ist inaktiv
'o'	Callback wird ausgelöst, wenn die Objekttemperatur außerhalb des min und max Wertes ist
'i'	Callback wird ausgelöst, wenn die Objekttemperatur innerhalb des min und max Wertes ist
'<'	Callback wird ausgelöst, wenn die Objekttemperatur kleiner als der min Wert ist (max wird ignoriert)
'>'	Callback wird ausgelöst, wenn die Objekttemperatur größer als der min Wert ist (max wird ignoriert)

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für option:

• BrickletTemperatureIR.THRESHOLD_OPTION_OFF = "x"
• BrickletTemperatureIR.THRESHOLD_OPTION_OUTSIDE = "o"
• BrickletTemperatureIR.THRESHOLD_OPTION_INSIDE = "i"
• BrickletTemperatureIR.THRESHOLD_OPTION_SMALLER = "<"
• BrickletTemperatureIR.THRESHOLD_OPTION_GREATER = ">"

BrickletTemperatureIR.GetObjectTemperatureCallbackThreshold() → option, min, max¶

Ausgabe:	option – Typ: Char, Wertebereich: Siehe Konstanten, Standardwert: "x" min – Typ: Int16, Einheit: 1/10 °C, Wertebereich: [-215 bis 215 - 1], Standardwert: 0 max – Typ: Int16, Einheit: 1/10 °C, Wertebereich: [-215 bis 215 - 1], Standardwert: 0

Gibt den Schwellwert zurück, wie von SetObjectTemperatureCallbackThreshold() gesetzt.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für option:

• BrickletTemperatureIR.THRESHOLD_OPTION_OFF = "x"
• BrickletTemperatureIR.THRESHOLD_OPTION_OUTSIDE = "o"
• BrickletTemperatureIR.THRESHOLD_OPTION_INSIDE = "i"
• BrickletTemperatureIR.THRESHOLD_OPTION_SMALLER = "<"
• BrickletTemperatureIR.THRESHOLD_OPTION_GREATER = ">"

BrickletTemperatureIR.SetDebouncePeriod(debounce)¶

Eingabe:	debounce – Typ: Int64, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100

Setzt die Periode mit welcher die Schwellwert Callbacks

• AmbientTemperatureReachedCallback,
• ObjectTemperatureReachedCallback

ausgelöst werden, wenn die Schwellwerte

• SetAmbientTemperatureCallbackThreshold(),
• SetObjectTemperatureCallbackThreshold()

weiterhin erreicht bleiben.

BrickletTemperatureIR.GetDebouncePeriod() → debounce¶

Ausgabe:	debounce – Typ: Int64, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100

Gibt die Entprellperiode zurück, wie von SetDebouncePeriod() gesetzt.

Callbacks¶

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.

event BrickletTemperatureIR.AmbientTemperatureCallback → sender, temperature¶

Callback-Ausgabe:	sender – Typ: .NET Refnum (BrickletTemperatureIR) temperature – Typ: Int16, Einheit: 1/10 °C, Wertebereich: [-400 bis 1250]

Dieser Callback wird mit der Periode, wie gesetzt mit SetAmbientTemperatureCallbackPeriod(), ausgelöst. Der Parameter ist die Temperatur des Sensors.

Der AmbientTemperatureCallback Callback wird nur ausgelöst, wenn sich die Temperatur seit der letzten Auslösung geändert hat.

event BrickletTemperatureIR.ObjectTemperatureCallback → sender, temperature¶

Callback-Ausgabe:	sender – Typ: .NET Refnum (BrickletTemperatureIR) temperature – Typ: Int16, Einheit: 1/10 °C, Wertebereich: [-700 bis 3800]

Dieser Callback wird mit der Periode, wie gesetzt mit SetObjectTemperatureCallbackPeriod(), ausgelöst. Der Parameter ist die Objekttemperatur des Sensors.

Der ObjectTemperatureCallback Callback wird nur ausgelöst, wenn sich die Objekttemperatur seit der letzten Auslösung geändert hat.

event BrickletTemperatureIR.AmbientTemperatureReachedCallback → sender, temperature¶

Callback-Ausgabe:	sender – Typ: .NET Refnum (BrickletTemperatureIR) temperature – Typ: Int16, Einheit: 1/10 °C, Wertebereich: [-400 bis 1250]

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von SetAmbientTemperatureCallbackThreshold() gesetzt, erreicht wird. Der Parameter ist die Umgebungstemperatur des Sensors.

Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie mit SetDebouncePeriod() gesetzt, ausgelöst.

event BrickletTemperatureIR.ObjectTemperatureReachedCallback → sender, temperature¶

Callback-Ausgabe:	sender – Typ: .NET Refnum (BrickletTemperatureIR) temperature – Typ: Int16, Einheit: 1/10 °C, Wertebereich: [-700 bis 3800]

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von SetObjectTemperatureCallbackThreshold() gesetzt, erreicht wird. Der Parameter ist die Objekttemperatur des Sensors.

Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie mit SetDebouncePeriod() gesetzt, ausgelöst.

Virtuelle Funktionen¶

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.

BrickletTemperatureIR.GetAPIVersion() → apiVersion¶

Ausgabe:	apiVersion – Typ: Byte[3] 0: major – Typ: Byte, Wertebereich: [0 bis 255] 1: minor – Typ: Byte, Wertebereich: [0 bis 255] 2: revision – Typ: Byte, Wertebereich: [0 bis 255]

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.

BrickletTemperatureIR.GetResponseExpected(functionId) → responseExpected¶

Eingabe:	functionId – Typ: Byte, Wertebereich: Siehe Konstanten
Ausgabe:	responseExpected – Typ: Boolean

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:

• BrickletTemperatureIR.FUNCTION_SET_EMISSIVITY = 3
• BrickletTemperatureIR.FUNCTION_SET_AMBIENT_TEMPERATURE_CALLBACK_PERIOD = 5
• BrickletTemperatureIR.FUNCTION_SET_OBJECT_TEMPERATURE_CALLBACK_PERIOD = 7
• BrickletTemperatureIR.FUNCTION_SET_AMBIENT_TEMPERATURE_CALLBACK_THRESHOLD = 9
• BrickletTemperatureIR.FUNCTION_SET_OBJECT_TEMPERATURE_CALLBACK_THRESHOLD = 11
• BrickletTemperatureIR.FUNCTION_SET_DEBOUNCE_PERIOD = 13

BrickletTemperatureIR.SetResponseExpected(functionId, responseExpected)¶

Eingabe:	functionId – Typ: Byte, Wertebereich: Siehe Konstanten responseExpected – Typ: Boolean

Ä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:

• BrickletTemperatureIR.FUNCTION_SET_EMISSIVITY = 3
• BrickletTemperatureIR.FUNCTION_SET_AMBIENT_TEMPERATURE_CALLBACK_PERIOD = 5
• BrickletTemperatureIR.FUNCTION_SET_OBJECT_TEMPERATURE_CALLBACK_PERIOD = 7
• BrickletTemperatureIR.FUNCTION_SET_AMBIENT_TEMPERATURE_CALLBACK_THRESHOLD = 9
• BrickletTemperatureIR.FUNCTION_SET_OBJECT_TEMPERATURE_CALLBACK_THRESHOLD = 11
• BrickletTemperatureIR.FUNCTION_SET_DEBOUNCE_PERIOD = 13

BrickletTemperatureIR.SetResponseExpectedAll(responseExpected)¶

Eingabe:	responseExpected – Typ: Boolean

Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.

Konstanten¶

BrickletTemperatureIR.DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein Temperature IR 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.

BrickletTemperatureIR.DEVICE_DISPLAY_NAME¶

Diese Konstante stellt den Anzeigenamen eines Temperature IR Bricklet dar.