Shell - Thermocouple Bricklet¶

Simple¶

Download (example-simple.sh)

1
2
3
4
5
6
7

#!/bin/sh
# Connects to localhost:4223 by default, use --host and --port to change this

uid=XYZ # Change XYZ to the UID of your Thermocouple Bricklet

# Get current temperature
tinkerforge call thermocouple-bricklet $uid get-temperature

Callback¶

Download (example-callback.sh)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16

#!/bin/sh
# Connects to localhost:4223 by default, use --host and --port to change this

uid=XYZ # Change XYZ to the UID of your Thermocouple Bricklet

# Handle incoming temperature callbacks
tinkerforge dispatch thermocouple-bricklet $uid temperature &

# Set period for temperature callback to 1s (1000ms)
# Note: The temperature callback is only called every second
#       if the temperature has changed since the last call!
tinkerforge call thermocouple-bricklet $uid set-temperature-callback-period 1000

echo "Press key to exit"; read dummy

kill -- -$$ # Stop callback dispatch in background

Threshold¶

Download (example-threshold.sh)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17

#!/bin/sh
# Connects to localhost:4223 by default, use --host and --port to change this

uid=XYZ # Change XYZ to the UID of your Thermocouple Bricklet

# Get threshold callbacks with a debounce time of 10 seconds (10000ms)
tinkerforge call thermocouple-bricklet $uid set-debounce-period 10000

# Handle incoming temperature reached callbacks
tinkerforge dispatch thermocouple-bricklet $uid temperature-reached &

# Configure threshold for temperature "greater than 30 °C"
tinkerforge call thermocouple-bricklet $uid set-temperature-callback-threshold threshold-option-greater 3000 0

echo "Press key to exit"; read dummy

kill -- -$$ # Stop callback dispatch in background

Befehlsstruktur¶

Allgemeine Optionen des call und des dispatch Befehls sind hier zu finden. Im Folgenden wird die spezifische Befehlsstruktur dargestellt.

tinkerforge call thermocouple-bricklet [<option>..] <uid> <function> [<argument>..]¶

Parameter:	<uid> – Typ: String <function> – Typ: String

Der call Befehl wird verwendet um eine Funktion des Thermocouple Bricklet aufzurufen. Der Befehl kennt mehrere Optionen:

• --help zeigt Hilfe für den spezifischen call Befehl an und endet dann
• --list-functions zeigt eine Liste der bekannten Funktionen des Thermocouple Bricklet an und endet dann

tinkerforge dispatch thermocouple-bricklet [<option>..] <uid> <callback>¶

Parameter:	<uid> – Typ: String <callback> – Typ: String

Der dispatch Befehl wird verwendet um eingehende Callbacks des Thermocouple Bricklet abzufertigen. Der Befehl kennt mehrere Optionen:

• --help zeigt Hilfe für den spezifischen dispatch Befehl an und endet dann
• --list-callbacks zeigt eine Liste der bekannten Callbacks des Thermocouple Bricklet an und endet dann

tinkerforge call thermocouple-bricklet <uid> <function> [<option>..] [<argument>..]¶

Parameter:	<uid> – Typ: String <function> – Typ: String

Abhängig von der Art der aufzurufenden <function> kennt diese verschiedene Optionen. Alle Funktionen kennen die folgenden Optionen:

• --help zeigt Hilfe für die spezifische <function> an und endet dann

Getter-Funktionen kennen zusätzlich die folgenden Optionen:

• --execute <command> Shell-Befehl der für jede eingehende Antwort ausgeführt wird (siehe den Abschnitt über Ausgabeformatierung für Details)

Setter-Funktionen kennen zusätzlich die folgenden Optionen:

• --expect-response fragt Antwort an und wartet auf diese

Mit der --expect-response Option für Setter-Funktionen können Timeouts und andere Fehlerfälle auch für Aufrufe von Setter-Funktionen detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn diese Option für eine Setter-Funktion nicht angegeben ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

tinkerforge dispatch thermocouple-bricklet <uid> <callback> [<option>..]¶

Parameter:	<uid> – Typ: String <callback> – Typ: String

Der abzufertigende <callback> kennt mehrere Optionen:

• --help zeigt Hilfe für den spezifische <callback> an und endet dann
• --execute <command> Shell-Befehlszeile der für jede eingehende Antwort ausgeführt wird (siehe den Abschnitt über Ausgabeformatierung für Details)

Grundfunktionen¶

tinkerforge call thermocouple-bricklet <uid> get-temperature¶

Ausgabe:	temperature – Typ: Int, 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 temperature Callback zu nutzen und die Periode mit set-temperature-callback-period vorzugeben.

Fortgeschrittene Funktionen¶

tinkerforge call thermocouple-bricklet <uid> set-configuration <averaging> <thermocouple-type> <filter>¶

Parameter:	<averaging> – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 16 <thermocouple-type> – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 3 <filter> – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 0
Ausgabe:	keine Ausgabe

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 Symbole sind für diese Funktion verfügbar:

Für <averaging>:

• averaging-1 = 1
• averaging-2 = 2
• averaging-4 = 4
• averaging-8 = 8
• averaging-16 = 16

Für <thermocouple-type>:

• type-b = 0
• type-e = 1
• type-j = 2
• type-k = 3
• type-n = 4
• type-r = 5
• type-s = 6
• type-t = 7
• type-g8 = 8
• type-g32 = 9

Für <filter>:

• filter-option-50hz = 0
• filter-option-60hz = 1

tinkerforge call thermocouple-bricklet <uid> get-configuration¶

Ausgabe:	averaging – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 16 thermocouple-type – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 3 filter – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 0

Gibt die Konfiguration zurück, wie von set-configuration gesetzt.

Die folgenden Symbole sind für diese Funktion verfügbar:

Für averaging:

• averaging-1 = 1
• averaging-2 = 2
• averaging-4 = 4
• averaging-8 = 8
• averaging-16 = 16

Für thermocouple-type:

• type-b = 0
• type-e = 1
• type-j = 2
• type-k = 3
• type-n = 4
• type-r = 5
• type-s = 6
• type-t = 7
• type-g8 = 8
• type-g32 = 9

Für filter:

• filter-option-50hz = 0
• filter-option-60hz = 1

tinkerforge call thermocouple-bricklet <uid> get-error-state¶

Ausgabe:	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 error-state Callback wird automatisch jedes mal ausgelöst, wenn sich der Error-Status ändert.

tinkerforge call thermocouple-bricklet <uid> get-identity¶

Ausgabe:

uid – Typ: String, Länge: bis zu 8 connected-uid – Typ: String, Länge: bis zu 8 position – Typ: Char, Wertebereich: [a bis h, z] hardware-version – Typ: Int Array, Länge: 3 0: major – Typ: Int, Wertebereich: [0 bis 255] 1: minor – Typ: Int, Wertebereich: [0 bis 255] 2: revision – Typ: Int, Wertebereich: [0 bis 255] firmware-version – Typ: Int Array, Länge: 3 0: major – Typ: Int, Wertebereich: [0 bis 255] 1: minor – Typ: Int, Wertebereich: [0 bis 255] 2: revision – Typ: Int, Wertebereich: [0 bis 255] device-identifier – Typ: Int, Wertebereich: [0 bis 216 - 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¶

tinkerforge call thermocouple-bricklet <uid> set-temperature-callback-period <period>¶

Parameter:	<period> – Typ: Int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Ausgabe:	keine Ausgabe

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

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

tinkerforge call thermocouple-bricklet <uid> get-temperature-callback-period¶

Ausgabe:	period – Typ: Int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Gibt die Periode zurück, wie von set-temperature-callback-period gesetzt.

tinkerforge call thermocouple-bricklet <uid> set-temperature-callback-threshold <option> <min> <max>¶

Parameter:	<option> – Typ: Char, Wertebereich: Siehe Symbole, Standardwert: x <min> – Typ: Int, Einheit: 1/100 °C, Wertebereich: [-231 bis 231 - 1], Standardwert: 0 <max> – Typ: Int, Einheit: 1/100 °C, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
Ausgabe:	keine Ausgabe

Setzt den Schwellwert für den 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 Symbole sind für diese Funktion verfügbar:

Für <option>:

• threshold-option-off = x
• threshold-option-outside = o
• threshold-option-inside = i
• threshold-option-smaller = <
• threshold-option-greater = >

tinkerforge call thermocouple-bricklet <uid> get-temperature-callback-threshold¶

Ausgabe:	option – Typ: Char, Wertebereich: Siehe Symbole, Standardwert: x min – Typ: Int, Einheit: 1/100 °C, Wertebereich: [-231 bis 231 - 1], Standardwert: 0 max – Typ: Int, Einheit: 1/100 °C, Wertebereich: [-231 bis 231 - 1], Standardwert: 0

Gibt den Schwellwert zurück, wie von set-temperature-callback-threshold gesetzt.

Die folgenden Symbole sind für diese Funktion verfügbar:

Für option:

• threshold-option-off = x
• threshold-option-outside = o
• threshold-option-inside = i
• threshold-option-smaller = <
• threshold-option-greater = >

tinkerforge call thermocouple-bricklet <uid> set-debounce-period <debounce>¶

Parameter:	<debounce> – Typ: Int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100
Ausgabe:	keine Ausgabe

Setzt die Periode mit welcher die Schwellwert Callback

• temperature-reached

ausgelöst wird, wenn der Schwellwert

• set-temperature-callback-threshold

weiterhin erreicht bleibt.

tinkerforge call thermocouple-bricklet <uid> get-debounce-period¶

Ausgabe:	debounce – Typ: Int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100

Gibt die Entprellperiode zurück, wie von set-debounce-period gesetzt.

Callbacks¶

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten:

tinkerforge dispatch thermocouple-bricklet <uid> example

Die verfügbaren Callbacks werden weiter unten beschrieben.

tinkerforge dispatch thermocouple-bricklet <uid> temperature¶

Ausgabe:	temperature – Typ: Int, Einheit: 1/100 °C, Wertebereich: [-21000 bis 180000]

Dieser Callback wird mit der Periode, wie gesetzt mit set-temperature-callback-period, ausgelöst. Der Parameter ist die Temperatur des Thermoelements.

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

tinkerforge dispatch thermocouple-bricklet <uid> temperature-reached¶

Ausgabe:	temperature – Typ: Int, 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 Parameter ist die Temperatur des Thermoelements.

Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie mit set-debounce-period gesetzt, ausgelöst.

tinkerforge dispatch thermocouple-bricklet <uid> error-state¶

Ausgabe:	over-under – Typ: Bool open-circuit – Typ: Bool

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