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 -- int32

Gibt die Temperatur des Thermoelements zurück. Der Wert wird in °C/100 angegeben, z.B. bedeutet ein Wert von 4223 eine gemessene Temperatur von 42,23 °C.

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 -- uint8
  • thermocouple_type -- uint8
  • filter -- uint8
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 Standardkonfiguration ist 16 Samples, Typ K und 50Hz.

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

  • 1: 1, für averaging
  • 2: 2, für averaging
  • 4: 4, für averaging
  • 8: 8, für averaging
  • 16: 16, für averaging
  • 0: b, für thermocouple_type
  • 1: e, für thermocouple_type
  • 2: j, für thermocouple_type
  • 3: k, für thermocouple_type
  • 4: n, für thermocouple_type
  • 5: r, für thermocouple_type
  • 6: s, für thermocouple_type
  • 7: t, für thermocouple_type
  • 8: g8, für thermocouple_type
  • 9: g32, für thermocouple_type
  • 0: 50hz, für filter
  • 1: 60hz, für filter
BrickletThermocouple.get_configuration
Funktions ID:

11

Anfrage:

keine Nutzdaten

Antwort:
  • averaging -- uint8
  • thermocouple_type -- uint8
  • filter -- uint8

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

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

  • 1: 1, für averaging
  • 2: 2, für averaging
  • 4: 4, für averaging
  • 8: 8, für averaging
  • 16: 16, für averaging
  • 0: b, für thermocouple_type
  • 1: e, für thermocouple_type
  • 2: j, für thermocouple_type
  • 3: k, für thermocouple_type
  • 4: n, für thermocouple_type
  • 5: r, für thermocouple_type
  • 6: s, für thermocouple_type
  • 7: t, für thermocouple_type
  • 8: g8, für thermocouple_type
  • 9: g32, für thermocouple_type
  • 0: 50hz, für filter
  • 1: 60hz, für filter
BrickletThermocouple.get_error_state
Funktions ID:

12

Anfrage:

keine Nutzdaten

Antwort:
  • over_under -- bool
  • open_circuit -- 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 -- char[8]
  • connected_uid -- char[8]
  • position -- char
  • hardware_version -- uint8[3]
  • firmware_version -- uint8[3]
  • device_identifier -- uint16

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 kann 'a', 'b', 'c' oder 'd' sein.

Eine Liste der Device Identifier Werte ist hier zu finden. 

Konfigurationsfunktionen für Callbacks

BrickletThermocouple.set_temperature_callback_period
Funktions ID:

2

Anfrage:
  • period -- uint32
Antwort:

keine Antwort

Setzt die Periode in ms 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.

Der Standardwert ist 0.

BrickletThermocouple.get_temperature_callback_period
Funktions ID:

3

Anfrage:

keine Nutzdaten

Antwort:
  • period -- uint32

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

BrickletThermocouple.set_temperature_callback_threshold
Funktions ID:

4

Anfrage:
  • option -- char
  • min -- int32
  • max -- int32
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)

Der Standardwert ist ('x', 0, 0).

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

  • x: off, für option
  • o: outside, für option
  • i: inside, für option
  • <: smaller, für option
  • >: greater, für option
BrickletThermocouple.get_temperature_callback_threshold
Funktions ID:

5

Anfrage:

keine Nutzdaten

Antwort:
  • option -- char
  • min -- int32
  • max -- int32

Gibt den Schwellwert zurück, wie von set_temperature_callback_threshold gesetzt.

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

  • x: off, für option
  • o: outside, für option
  • i: inside, für option
  • <: smaller, für option
  • >: greater, für option
BrickletThermocouple.set_debounce_period
Funktions ID:

6

Anfrage:
  • debounce -- uint32
Antwort:

keine Antwort

Setzt die Periode in ms mit welcher die Schwellwert Callback

ausgelöst wird, wenn der Schwellwert

weiterhin erreicht bleibt.

Der Standardwert ist 100.

BrickletThermocouple.get_debounce_period
Funktions ID:

7

Anfrage:

keine Nutzdaten

Antwort:
  • debounce -- uint32

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

Callbacks

BrickletThermocouple.CALLBACK_TEMPERATURE
Funktions ID:

8

Antwort:
  • temperature -- int32

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 -- int32

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 -- bool
  • open_circuit -- bool

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