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

Modbus - Thermocouple Bricklet¶

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

API¶

Eine allgemeine Beschreibung der Modbus Protokollstruktur findet sich hier.

Grundfunktionen¶

BrickletThermocouple.get_temperature¶

Funktions-ID:	1
Anfrage:	keine Nutzdaten
Antwort:	temperature – Typ: int32, Einheit: 1/100 °C, Wertebereich: [-21000 bis 180000]

Gibt die Temperatur des Thermoelements 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¶

BrickletThermocouple.set_configuration¶

Funktions-ID:	10
Anfrage:	averaging – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 16 thermocouple_type – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 3 filter – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 0
Antwort:	keine Antwort

Konfiguriert werden können Averaging-Größe, Thermoelement-Typ und Frequenz-Filterung.

Mögliche Averaging-Größen sind 1, 2, 4, 8 und 16 Samples.

Als Thermoelement-Typ stehen B, E, J, K, N, R, S und T zur Verfügung. Falls ein anderes Thermoelement benutzt werden soll, können G8 und G32 genutzt werden. Mit diesen Typen wird der Wert nicht in °C/100 zurückgegeben sondern er wird durch folgende Formeln bestimmt:

G8: Wert = 8 * 1.6 * 2^17 * Vin
G32: Wert = 32 * 1.6 * 2^17 * Vin

dabei ist Vin die Eingangsspannung des Thermoelements.

Der Frequenz-Filter kann auf 50Hz und 60Hz konfiguriert werden. Er sollte abhängig von der lokalen Netzfrequenz gewählt werden.

Die Konvertierungszeit ist abhängig von der Averaging-Größe und der Frequenz-Filter-Konfiguration. Sie kann wie folgt bestimmt werden:

60Hz: Zeit = 82 + (Samples - 1) * 16.67
50Hz: Zeit = 98 + (Samples - 1) * 20

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

Für averaging:

1 = 1
2 = 2
4 = 4
8 = 8
16 = 16

Für thermocouple_type:

0 = B
1 = E
2 = J
3 = K
4 = N
5 = R
6 = S
7 = T
8 = G8
9 = G32

Für filter:

0 = 50Hz
1 = 60Hz

BrickletThermocouple.get_configuration¶

Funktions-ID:	11
Anfrage:	keine Nutzdaten
Antwort:	averaging – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 16 thermocouple_type – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 3 filter – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 0

Gibt die Konfiguration zurück, wie von set_configuration gesetzt.

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

Für averaging:

1 = 1
2 = 2
4 = 4
8 = 8
16 = 16

Für thermocouple_type:

0 = B
1 = E
2 = J
3 = K
4 = N
5 = R
6 = S
7 = T
8 = G8
9 = G32

Für filter:

0 = 50Hz
1 = 60Hz

BrickletThermocouple.get_error_state¶

Funktions-ID:	12
Anfrage:	keine Nutzdaten
Antwort:	over_under – Typ: bool open_circuit – Typ: bool

Gibt den aktuellen Error-Status zurück. Es gibt zwei mögliche Status:

Over/Under Voltage und
Open Circuit.

Over/Under Voltage bei Spannungen unter 0V oder über 3.3V ausgelöst. In diesem Fall ist mit hoher Wahrscheinlichkeit das Thermoelement defekt. Ein Open Circuit-Error deutet darauf hin, das kein Thermoelement angeschlossen ist.

Der CALLBACK_ERROR_STATE Callback wird automatisch jedes mal ausgelöst, wenn sich der Error-Status ändert.

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

BrickletThermocouple.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.

BrickletThermocouple.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.

BrickletThermocouple.set_temperature_callback_threshold¶

Funktions-ID:	4
Anfrage:	option – Typ: char, Wertebereich: Siehe Bedeutungen, Standardwert: 'x' min – Typ: int32, Einheit: 1/100 °C, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0 max – Typ: int32, 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

BrickletThermocouple.get_temperature_callback_threshold¶

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

BrickletThermocouple.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.

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

BrickletThermocouple.CALLBACK_TEMPERATURE¶

Funktions-ID:	8
Antwort:	temperature – Typ: int32, Einheit: 1/100 °C, Wertebereich: [-21000 bis 180000]

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

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

BrickletThermocouple.CALLBACK_TEMPERATURE_REACHED¶

Funktions-ID:	9
Antwort:	temperature – Typ: int32, Einheit: 1/100 °C, Wertebereich: [-21000 bis 180000]

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

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

BrickletThermocouple.CALLBACK_ERROR_STATE¶

Funktions-ID:	13
Antwort:	over_under – Typ: bool open_circuit – Typ: bool

Dieser Callback wird ausgelöst, wenn der Error-Status sich verändert (siehe get_error_state).