Spezifikationen / Modbus Protokoll / API / Bricklets (Abgekündigt) / Temperature IR Bricklet

Modbus - Temperature IR Bricklet¶

Dies ist die Beschreibung des Modbus 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.

API¶

Eine allgemeine Beschreibung der Modbus Protokollstruktur findet sich hier.

Grundfunktionen¶

BrickletTemperatureIR.get_ambient_temperature¶

Funktions-ID:	1
Anfrage:	keine Nutzdaten
Antwort:	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 CALLBACK_AMBIENT_TEMPERATURE Callback zu nutzen und die Periode mit set_ambient_temperature_callback_period vorzugeben.

BrickletTemperatureIR.get_object_temperature¶

Funktions-ID:	2
Anfrage:	keine Nutzdaten
Antwort:	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 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.

Fortgeschrittene Funktionen¶

BrickletTemperatureIR.set_emissivity¶

Funktions-ID:	3
Anfrage:	emissivity – Typ: uint16, Einheit: 1/65535, Wertebereich: [6553 bis 2¹⁶ - 1], Standardwert: 2¹⁶ - 1
Antwort:	keine 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:	4
Anfrage:	keine Nutzdaten
Antwort:	emissivity – Typ: uint16, Einheit: 1/65535, Wertebereich: [6553 bis 2¹⁶ - 1], Standardwert: 2¹⁶ - 1

Gibt den Emissionsgrad zurück, wie von set_emissivity gesetzt.

BrickletTemperatureIR.get_identity¶

Funktions-ID:	255
Anfrage:	keine Nutzdaten
Antwort:	uid – Typ: char[8] connected_uid – Typ: char[8] position – Typ: char, Wertebereich: ['a' bis 'h', 'z'] hardware_version – Typ: uint8[3] 0: major – Typ: uint8, Wertebereich: [0 bis 255] 1: minor – Typ: uint8, Wertebereich: [0 bis 255] 2: revision – Typ: uint8, Wertebereich: [0 bis 255] firmware_version – Typ: uint8[3] 0: major – Typ: uint8, Wertebereich: [0 bis 255] 1: minor – Typ: uint8, Wertebereich: [0 bis 255] 2: revision – Typ: uint8, Wertebereich: [0 bis 255] device_identifier – Typ: uint16, Wertebereich: [0 bis 2¹⁶ - 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.

Konfigurationsfunktionen für Callbacks¶

BrickletTemperatureIR.set_ambient_temperature_callback_period¶

Funktions-ID:	5
Anfrage:	period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0
Antwort:	keine 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:	6
Anfrage:	keine Nutzdaten
Antwort:	period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0

Gibt die Periode zurück, wie von set_ambient_temperature_callback_period gesetzt.

BrickletTemperatureIR.set_object_temperature_callback_period¶

Funktions-ID:	7
Anfrage:	period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0
Antwort:	keine 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:	8
Anfrage:	keine Nutzdaten
Antwort:	period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0

Gibt die Periode zurück, wie von set_object_temperature_callback_period gesetzt.

BrickletTemperatureIR.set_ambient_temperature_callback_threshold¶

Funktions-ID:	9
Anfrage:	option – Typ: char, Wertebereich: Siehe Bedeutungen, Standardwert: 'x' min – Typ: int16, Einheit: 1/10 °C, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1], Standardwert: 0 max – Typ: int16, Einheit: 1/10 °C, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1], Standardwert: 0
Antwort:	keine 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:

'x' = Off
'o' = Outside
'i' = Inside
'<' = Smaller
'>' = Greater

BrickletTemperatureIR.get_ambient_temperature_callback_threshold¶

Funktions-ID:	10
Anfrage:	keine Nutzdaten
Antwort:	option – Typ: char, Wertebereich: Siehe Bedeutungen, Standardwert: 'x' min – Typ: int16, Einheit: 1/10 °C, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1], Standardwert: 0 max – Typ: int16, Einheit: 1/10 °C, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1], Standardwert: 0

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:

'x' = Off
'o' = Outside
'i' = Inside
'<' = Smaller
'>' = Greater

BrickletTemperatureIR.set_object_temperature_callback_threshold¶

Funktions-ID:	11
Anfrage:	option – Typ: char, Wertebereich: Siehe Bedeutungen, Standardwert: 'x' min – Typ: int16, Einheit: 1/10 °C, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1], Standardwert: 0 max – Typ: int16, Einheit: 1/10 °C, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1], Standardwert: 0
Antwort:	keine 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:

'x' = Off
'o' = Outside
'i' = Inside
'<' = Smaller
'>' = Greater

BrickletTemperatureIR.get_object_temperature_callback_threshold¶

Funktions-ID:	12
Anfrage:	keine Nutzdaten
Antwort:	option – Typ: char, Wertebereich: Siehe Bedeutungen, Standardwert: 'x' min – Typ: int16, Einheit: 1/10 °C, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1], Standardwert: 0 max – Typ: int16, Einheit: 1/10 °C, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1], Standardwert: 0

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:

'x' = Off
'o' = Outside
'i' = Inside
'<' = Smaller
'>' = Greater

BrickletTemperatureIR.set_debounce_period¶

Funktions-ID:	13
Anfrage:	debounce – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 100
Antwort:	keine Antwort

Setzt die Periode mit welcher die Schwellwert Callbacks

CALLBACK_AMBIENT_TEMPERATURE_REACHED,
CALLBACK_OBJECT_TEMPERATURE_REACHED

ausgelöst werden, wenn die Schwellwerte

set_ambient_temperature_callback_threshold,
set_object_temperature_callback_threshold

weiterhin erreicht bleiben.

BrickletTemperatureIR.get_debounce_period¶

Funktions-ID:	14
Anfrage:	keine Nutzdaten
Antwort:	debounce – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 100

Gibt die Entprellperiode zurück, wie von set_debounce_period gesetzt.

Callbacks¶

BrickletTemperatureIR.CALLBACK_AMBIENT_TEMPERATURE¶

Funktions-ID:	15
Antwort:	temperature – Typ: int16, Einheit: 1/10 °C, Wertebereich: [-400 bis 1250]

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:	16
Antwort:	temperature – Typ: int16, Einheit: 1/10 °C, Wertebereich: [-700 bis 3800]

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:	17
Antwort:	temperature – Typ: int16, Einheit: 1/10 °C, Wertebereich: [-400 bis 1250]

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:	18
Antwort:	temperature – Typ: int16, Einheit: 1/10 °C, Wertebereich: [-700 bis 3800]

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.