Dies ist die Beschreibung des TCP/IP Protokolls für das Thermocouple Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Thermocouple Bricklet sind in dessen Hardware Beschreibung zusammengefasst.
Eine allgemeine Beschreibung der TCP/IP Protokollstruktur findet sich hier.
BrickletThermocouple.
get_temperature
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
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.
BrickletThermocouple.
set_configuration
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
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:
Wert = 8 * 1.6 * 2^17 * Vin
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:
Zeit = 82 + (Samples - 1) * 16.67
Zeit = 98 + (Samples - 1) * 20
Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:
Für averaging:
Für thermocouple_type:
Für filter:
BrickletThermocouple.
get_configuration
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Gibt die Konfiguration zurück, wie von set_configuration
gesetzt.
Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:
Für averaging:
Für thermocouple_type:
Für filter:
BrickletThermocouple.
get_error_state
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Gibt den aktuellen Error-Status zurück. Es gibt zwei mögliche Status:
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: |
|
---|---|
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.
BrickletThermocouple.
set_temperature_callback_period
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
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: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Gibt die Periode zurück, wie von set_temperature_callback_period
gesetzt.
BrickletThermocouple.
set_temperature_callback_threshold
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
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:
BrickletThermocouple.
get_temperature_callback_threshold
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
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:
BrickletThermocouple.
set_debounce_period
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Setzt die Periode mit welcher die Schwellwert Callback
ausgelöst wird, wenn der Schwellwert
weiterhin erreicht bleibt.
BrickletThermocouple.
get_debounce_period
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Gibt die Entprellperiode zurück, wie von set_debounce_period
gesetzt.
BrickletThermocouple.
CALLBACK_TEMPERATURE
¶Funktions-ID: |
|
---|---|
Antwort: |
|
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: |
|
---|---|
Antwort: |
|
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: |
|
---|---|
Antwort: |
|
Dieser Callback wird ausgelöst, wenn der Error-Status sich verändert
(siehe get_error_state
).