Dies ist die Beschreibung des TCP/IP Protokolls für das Temperature IR Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Temperature IR Bricklet sind in dessen Hardware Beschreibung zusammengefasst.
Eine allgemeine Beschreibung der TCP/IP Protokollstruktur findet sich hier.
BrickletTemperatureIR.
get_ambient_temperature
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Gibt die Umgebungstemperatur des Sensors zurück.
Wenn die Umgebungstemperatur periodisch abgefragt werden soll, wird empfohlen
den CALLBACK_AMBIENT_TEMPERATURE
Callback zu nutzen und die Periode mit
set_ambient_temperature_callback_period
vorzugeben.
BrickletTemperatureIR.
get_object_temperature
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
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 set_emissivity
gesetzt werden.
Wenn die Objekttemperatur periodisch abgefragt werden soll, wird empfohlen
den CALLBACK_OBJECT_TEMPERATURE
Callback zu nutzen und die Periode mit
set_object_temperature_callback_period
vorzugeben.
BrickletTemperatureIR.
set_emissivity
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Setzt den Emissionsgrad,
welcher zur Berechnung der Oberflächentemperatur benutzt wird, wie von
get_object_temperature
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 set_emissivity
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.
get_emissivity
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Gibt den Emissionsgrad zurück, wie von set_emissivity
gesetzt.
BrickletTemperatureIR.
get_identity
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
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.
BrickletTemperatureIR.
set_ambient_temperature_callback_period
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Setzt die Periode mit welcher der CALLBACK_AMBIENT_TEMPERATURE
Callback
ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.
Der CALLBACK_AMBIENT_TEMPERATURE
Callback wird nur ausgelöst, wenn sich die
Temperatur seit der letzten Auslösung geändert hat.
BrickletTemperatureIR.
get_ambient_temperature_callback_period
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Gibt die Periode zurück, wie von set_ambient_temperature_callback_period
gesetzt.
BrickletTemperatureIR.
set_object_temperature_callback_period
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Setzt die Periode mit welcher der CALLBACK_OBJECT_TEMPERATURE
Callback
ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.
Der CALLBACK_OBJECT_TEMPERATURE
Callback wird nur ausgelöst, wenn sich die
Temperatur seit der letzten Auslösung geändert hat.
BrickletTemperatureIR.
get_object_temperature_callback_period
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Gibt die Periode zurück, wie von set_object_temperature_callback_period
gesetzt.
BrickletTemperatureIR.
set_ambient_temperature_callback_threshold
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Setzt den Schwellwert für den CALLBACK_AMBIENT_TEMPERATURE_REACHED
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 Bedeutungen sind für die Elemente dieser Funktion definiert:
Für option:
BrickletTemperatureIR.
get_ambient_temperature_callback_threshold
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Gibt den Schwellwert zurück, wie von set_ambient_temperature_callback_threshold
gesetzt.
Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:
Für option:
BrickletTemperatureIR.
set_object_temperature_callback_threshold
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Setzt den Schwellwert für den CALLBACK_OBJECT_TEMPERATURE_REACHED
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 Bedeutungen sind für die Elemente dieser Funktion definiert:
Für option:
BrickletTemperatureIR.
get_object_temperature_callback_threshold
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Gibt den Schwellwert zurück, wie von set_object_temperature_callback_threshold
gesetzt.
Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:
Für option:
BrickletTemperatureIR.
set_debounce_period
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Setzt die Periode mit welcher die Schwellwert Callbacks
ausgelöst werden, wenn die Schwellwerte
weiterhin erreicht bleiben.
BrickletTemperatureIR.
get_debounce_period
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Gibt die Entprellperiode zurück, wie von set_debounce_period
gesetzt.
BrickletTemperatureIR.
CALLBACK_AMBIENT_TEMPERATURE
¶Funktions-ID: |
|
---|---|
Antwort: |
|
Dieser Callback wird mit der Periode, wie gesetzt mit set_ambient_temperature_callback_period
,
ausgelöst. Der Rückgabewert ist die Temperatur des Sensors.
Der CALLBACK_AMBIENT_TEMPERATURE
Callback wird nur ausgelöst, wenn sich die
Temperatur seit der letzten Auslösung geändert hat.
BrickletTemperatureIR.
CALLBACK_OBJECT_TEMPERATURE
¶Funktions-ID: |
|
---|---|
Antwort: |
|
Dieser Callback wird mit der Periode, wie gesetzt mit
set_object_temperature_callback_period
, ausgelöst. Der
Rückgabewert ist die Objekttemperatur des Sensors.
Der CALLBACK_OBJECT_TEMPERATURE
Callback wird nur ausgelöst, wenn sich die
Objekttemperatur seit der letzten Auslösung geändert hat.
BrickletTemperatureIR.
CALLBACK_AMBIENT_TEMPERATURE_REACHED
¶Funktions-ID: |
|
---|---|
Antwort: |
|
Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von
set_ambient_temperature_callback_threshold
gesetzt, erreicht wird.
Der Rückgabewert ist die Umgebungstemperatur des Sensors.
Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie
mit set_debounce_period
gesetzt, ausgelöst.
BrickletTemperatureIR.
CALLBACK_OBJECT_TEMPERATURE_REACHED
¶Funktions-ID: |
|
---|---|
Antwort: |
|
Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von
set_object_temperature_callback_threshold
gesetzt, erreicht wird.
Der Rückgabewert ist die Objekttemperatur des Sensors.
Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie
mit set_debounce_period
gesetzt, ausgelöst.