Spezifikationen / TCP/IP Protokoll / API / Bricks und Bricklets / Bricklets / Temperature Bricklet

TCP/IP - Temperature Bricklet¶

Dies ist die Beschreibung des TCP/IP Protokolls für das Temperature Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Temperature Bricklet sind in dessen Hardware Beschreibung zusammengefasst.

API¶

Eine allgemeine Beschreibung der TCP/IP Protokollstruktur findet sich hier.

Grundfunktionen¶

BrickletTemperature.get_temperature¶

Funktions-ID:	1
Anfrage:	keine Nutzdaten
Antwort:	temperature – Typ: int16, Einheit: 1/100 °C, Wertebereich: [-2500 bis 8500]

Gibt die Temperatur des Sensors zurück.

Wenn die Temperatur periodisch abgefragt werden soll, wird empfohlen den CALLBACK_TEMPERATURE Callback zu nutzen und die Periode mit set_temperature_callback_period vorzugeben.

Fortgeschrittene Funktionen¶

BrickletTemperature.set_i2c_mode¶

Funktions-ID:	10
Anfrage:	mode – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 0
Antwort:	keine Antwort

Setzt den I2C Modus. Mögliche Modi sind:

0: Fast (400kHz)
1: Slow (100kHz)

Wenn Probleme mit offensichtlichen Ausreißern in den Temperature Bricklet Messungen auftreten, können diese eventuell aufgrund von elektromagnetischen Störungen sein. In diesem Fall kann es helfen die I2C Geschwindigkeit zu verringern.

Falls in einem System ein hoher Durchsatz an Nachrichten erwünscht ist, sollte die I2C Geschwindigkeit allerdings nicht verringert werden.

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für mode:

0 = Fast
1 = Slow

Neu in Version 2.0.1 (Plugin).

BrickletTemperature.get_i2c_mode¶

Funktions-ID:	11
Anfrage:	keine Nutzdaten
Antwort:	mode – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 0

Gibt den I2C Modus zurück, wie von set_i2c_mode gesetzt.

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für mode:

0 = Fast
1 = Slow

Neu in Version 2.0.1 (Plugin).

BrickletTemperature.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¶

BrickletTemperature.set_temperature_callback_period¶

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

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

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

BrickletTemperature.get_temperature_callback_period¶

Funktions-ID:	3
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_temperature_callback_period gesetzt.

BrickletTemperature.set_temperature_callback_threshold¶

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

Setzt den Schwellwert für den CALLBACK_TEMPERATURE_REACHED Callback.

Die folgenden Optionen sind möglich:

Option	Beschreibung
'x'	Callback ist inaktiv
'o'	Callback wird ausgelöst, wenn die Temperatur außerhalb des min und max Wertes ist
'i'	Callback wird ausgelöst, wenn die Temperatur innerhalb des min und max Wertes ist
'<'	Callback wird ausgelöst, wenn die Temperatur kleiner als der min Wert ist (max wird ignoriert)
'>'	Callback wird ausgelöst, wenn die Temperatur 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

BrickletTemperature.get_temperature_callback_threshold¶

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

Gibt den Schwellwert zurück, wie von set_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

BrickletTemperature.set_debounce_period¶

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

Setzt die Periode mit welcher die Schwellwert Callback

CALLBACK_TEMPERATURE_REACHED

ausgelöst wird, wenn der Schwellwert

set_temperature_callback_threshold

weiterhin erreicht bleibt.

BrickletTemperature.get_debounce_period¶

Funktions-ID:	7
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¶

BrickletTemperature.CALLBACK_TEMPERATURE¶

Funktions-ID:	8
Antwort:	temperature – Typ: int16, Einheit: 1/100 °C, Wertebereich: [-2500 bis 8500]

Dieser Callback wird mit der Periode, wie gesetzt mit set_temperature_callback_period, ausgelöst. Der Rückgabewert ist die Temperatur des Sensors.

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

BrickletTemperature.CALLBACK_TEMPERATURE_REACHED¶

Funktions-ID:	9
Antwort:	temperature – Typ: int16, Einheit: 1/100 °C, Wertebereich: [-2500 bis 8500]

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von set_temperature_callback_threshold gesetzt, erreicht wird. Der Rückgabewert ist die Temperatur des Sensors.

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