Shell - Thermocouple Bricklet 2.0¶

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 2.0

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

Callback¶

Download (example-callback.sh)

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

#!/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 2.0

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

# Set period for temperature callback to 1s (1000ms) without a threshold
tinkerforge call thermocouple-v2-bricklet $uid set-temperature-callback-configuration 1000 false threshold-option-off 0 0

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

#!/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 2.0

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

# Configure threshold for temperature "greater than 30 °C"
# with a debounce period of 10s (10000ms)
tinkerforge call thermocouple-v2-bricklet $uid set-temperature-callback-configuration 10000 false 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-v2-bricklet [<option>..] <uid> <function> [<argument>..]¶

Parameter:	<uid> -- string <function> -- string

Der call Befehl wird verwendet um eine Funktion des Thermocouple Bricklet 2.0 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 2.0 an und endet dann

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

Parameter:	<uid> -- string <callback> -- string

Der dispatch Befehl wird verwendet um eingehende Callbacks des Thermocouple Bricklet 2.0 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 2.0 an und endet dann

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

Parameter:	<uid> -- string <function> -- 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-v2-bricklet <uid> <callback> [<option>..]¶

Parameter:	<uid> -- string <callback> -- 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-v2-bricklet <uid> get-temperature¶

Ausgabe:	temperature -- int

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 temperature Callback zu nutzen und die Periode mit set-temperature-callback-configuration vorzugeben.

Wenn der Wert periodisch benötigt wird, kann auch der temperature Callback verwendet werden. Der Callback wird mit der Funktion set-temperature-callback-configuration konfiguriert.

Fortgeschrittene Funktionen¶

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

Parameter:	<averaging> -- int (hat Symbole) <thermocouple-type> -- int (hat Symbole) <filter> -- int (hat Symbole)
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 Standardkonfiguration ist 16 Samples, Typ K und 50Hz.

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

• averaging-1 = 1, für <averaging>
• averaging-2 = 2, für <averaging>
• averaging-4 = 4, für <averaging>
• averaging-8 = 8, für <averaging>
• averaging-16 = 16, für <averaging>
• type-b = 0, für <thermocouple-type>
• type-e = 1, für <thermocouple-type>
• type-j = 2, für <thermocouple-type>
• type-k = 3, für <thermocouple-type>
• type-n = 4, für <thermocouple-type>
• type-r = 5, für <thermocouple-type>
• type-s = 6, für <thermocouple-type>
• type-t = 7, für <thermocouple-type>
• type-g8 = 8, für <thermocouple-type>
• type-g32 = 9, für <thermocouple-type>
• filter-option-50hz = 0, für <filter>
• filter-option-60hz = 1, für <filter>

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

Ausgabe:	averaging -- int (hat Symbole) thermocouple-type -- int (hat Symbole) filter -- int (hat Symbole)

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

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

• averaging-1 = 1, für averaging
• averaging-2 = 2, für averaging
• averaging-4 = 4, für averaging
• averaging-8 = 8, für averaging
• averaging-16 = 16, für averaging
• type-b = 0, für thermocouple-type
• type-e = 1, für thermocouple-type
• type-j = 2, für thermocouple-type
• type-k = 3, für thermocouple-type
• type-n = 4, für thermocouple-type
• type-r = 5, für thermocouple-type
• type-s = 6, für thermocouple-type
• type-t = 7, für thermocouple-type
• type-g8 = 8, für thermocouple-type
• type-g32 = 9, für thermocouple-type
• filter-option-50hz = 0, für filter
• filter-option-60hz = 1, für filter

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

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

tinkerforge call thermocouple-v2-bricklet <uid> get-spitfp-error-count¶

Ausgabe:	error-count-ack-checksum -- int error-count-message-checksum -- int error-count-frame -- int error-count-overflow -- int

Gibt die Anzahl der Fehler die während der Kommunikation zwischen Brick und Bricklet aufgetreten sind zurück.

Die Fehler sind aufgeteilt in

• ACK-Checksummen Fehler,
• Message-Checksummen Fehler,
• Framing Fehler und
• Overflow Fehler.

Die Fehlerzähler sind für Fehler die auf der Seite des Bricklets auftreten. Jedes Brick hat eine ähnliche Funktion welche die Fehler auf Brickseite ausgibt.

tinkerforge call thermocouple-v2-bricklet <uid> set-bootloader-mode <mode>¶

Parameter:	<mode> -- int (hat Symbole)
Ausgabe:	status -- int (hat Symbole)

Setzt den Bootloader-Modus und gibt den Status zurück nachdem die Modusänderungsanfrage bearbeitet wurde.

Mit dieser Funktion ist es möglich vom Bootloader- in den Firmware-Modus zu wechseln und umgekehrt. Ein Welchsel vom Bootlodaer- in der den Firmware-Modus ist nur möglich wenn Entry-Funktion, Device Identifier und CRC vorhanden und korrekt sind.

Diese Funktion wird vom Brick Viewer während des flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

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

• bootloader-mode-bootloader = 0, für <mode>
• bootloader-mode-firmware = 1, für <mode>
• bootloader-mode-bootloader-wait-for-reboot = 2, für <mode>
• bootloader-mode-firmware-wait-for-reboot = 3, für <mode>
• bootloader-mode-firmware-wait-for-erase-and-reboot = 4, für <mode>
• bootloader-status-ok = 0, für status
• bootloader-status-invalid-mode = 1, für status
• bootloader-status-no-change = 2, für status
• bootloader-status-entry-function-not-present = 3, für status
• bootloader-status-device-identifier-incorrect = 4, für status
• bootloader-status-crc-mismatch = 5, für status

tinkerforge call thermocouple-v2-bricklet <uid> get-bootloader-mode¶

Ausgabe:	mode -- int (hat Symbole)

Gibt den aktuellen Bootloader-Modus zurück, siehe set-bootloader-mode.

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

• bootloader-mode-bootloader = 0, für mode
• bootloader-mode-firmware = 1, für mode
• bootloader-mode-bootloader-wait-for-reboot = 2, für mode
• bootloader-mode-firmware-wait-for-reboot = 3, für mode
• bootloader-mode-firmware-wait-for-erase-and-reboot = 4, für mode

tinkerforge call thermocouple-v2-bricklet <uid> set-write-firmware-pointer <pointer>¶

Parameter:	<pointer> -- int
Ausgabe:	keine Ausgabe

Setzt den Firmware-Pointer für write-firmware. Der Pointer muss um je 64 Byte erhöht werden. Die Daten werden alle 4 Datenblöcke in den Flash geschrieben (4 Datenblöcke entsprechen einer Page mit 256 Byte).

Diese Funktion wird vom Brick Viewer während des flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

tinkerforge call thermocouple-v2-bricklet <uid> write-firmware <data>¶

Parameter:	<data> -- int,int,..61x..,int
Ausgabe:	status -- int

Schreibt 64 Bytes Firmware an die Position die vorher von set-write-firmware-pointer gesetzt wurde. Die Firmware wird alle 4 Datenblöcke in den Flash geschrieben.

Eine Firmware kann nur im Bootloader-Mode geschrieben werden.

Diese Funktion wird vom Brick Viewer während des flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

tinkerforge call thermocouple-v2-bricklet <uid> set-status-led-config <config>¶

Parameter:	<config> -- int (hat Symbole)
Ausgabe:	keine Ausgabe

Setzt die Konfiguration der Status-LED. Standardmäßig zeigt die LED die Kommunikationsdatenmenge an. Sie blinkt einmal auf pro 10 empfangenen Datenpaketen zwischen Brick und Bricklet.

Die LED kann auch permanent an/aus gestellt werden oder einen Herzschlag anzeigen.

Wenn das Bricklet sich im Bootlodermodus befindet ist die LED aus.

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

• status-led-config-off = 0, für <config>
• status-led-config-on = 1, für <config>
• status-led-config-show-heartbeat = 2, für <config>
• status-led-config-show-status = 3, für <config>

tinkerforge call thermocouple-v2-bricklet <uid> get-status-led-config¶

Ausgabe:	config -- int (hat Symbole)

Gibt die Konfiguration zurück, wie von set-status-led-config gesetzt.

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

• status-led-config-off = 0, für config
• status-led-config-on = 1, für config
• status-led-config-show-heartbeat = 2, für config
• status-led-config-show-status = 3, für config

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

Ausgabe:	temperature -- int

Gibt die Temperatur in °C, gemessen im Mikrocontroller, aus. Der Rückgabewert ist nicht die Umgebungstemperatur.

Die Temperatur ist lediglich proportional zur echten Temperatur und hat eine hohe Ungenauigkeit. Daher beschränkt sich der praktische Nutzen auf die Indikation von Temperaturveränderungen.

tinkerforge call thermocouple-v2-bricklet <uid> reset¶

Ausgabe:	keine Ausgabe

Ein Aufruf dieser Funktion setzt das Bricklet zurück. Nach einem Neustart sind alle Konfiguration verloren.

Nach dem Zurücksetzen ist es notwendig neue Objekte zu erzeugen, Funktionsaufrufe auf bestehenden führen zu undefiniertem Verhalten.

tinkerforge call thermocouple-v2-bricklet <uid> write-uid <uid>¶

Parameter:	<uid> -- int
Ausgabe:	keine Ausgabe

Schreibt eine neue UID in den Flash. Die UID muss zuerst vom Base58 encodierten String in einen Integer decodiert werden.

Wir empfehlen die Nutzung des Brick Viewers zum ändern der UID.

tinkerforge call thermocouple-v2-bricklet <uid> read-uid¶

Ausgabe:	uid -- int

Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.

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

Ausgabe:	uid -- string connected-uid -- string position -- char hardware-version -- int,int,int firmware-version -- int,int,int device-identifier -- int (hat Symbole)

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¶

tinkerforge call thermocouple-v2-bricklet <uid> set-temperature-callback-configuration <period> <value-has-to-change> <option> <min> <max>¶

Parameter:	<period> -- int <value-has-to-change> -- bool <option> -- char (hat Symbole) <min> -- int <max> -- int
Ausgabe:	keine Ausgabe

Die Periode in ms ist die Periode mit der der temperature Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

Desweiteren ist es möglich den Callback mittels Thresholds einzuschränken.

Der option-Parameter`zusammen mit min/max setzt einen Threshold für den temperature Callback.

Die folgenden Optionen sind möglich:

Option	Beschreibung
'x'	Threshold ist abgeschaltet
'o'	Threshold wird ausgelöst, wenn der Wert außerhalb der Min und Max Werte sind
'i'	Threshold wird ausgelöst, wenn der Wert innerhalb der Min und Max Werte sind
'<'	Threshold wird ausgelöst, wenn der Wert kleiner ist wie der Min Wert (Max wird ignoriert)
'>'	Threshold wird ausgelöst, wenn der Wert größer ist wie der Max Wert (Min wird ignoriert)

Wird die Option auf 'x' gesetzt (Threshold abgeschaltet), so wird der Callback mit der festen Periode ausgelöst.

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

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

• threshold-option-off = x, für <option>
• threshold-option-outside = o, für <option>
• threshold-option-inside = i, für <option>
• threshold-option-smaller = <, für <option>
• threshold-option-greater = >, für <option>

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

Ausgabe:	period -- int value-has-to-change -- bool option -- char (hat Symbole) min -- int max -- int

Gibt die Callback-Konfiguration zurück, wie mittels set-temperature-callback-configuration gesetzt.

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

• threshold-option-off = x, für option
• threshold-option-outside = o, für option
• threshold-option-inside = i, für option
• threshold-option-smaller = <, für option
• threshold-option-greater = >, für option

Callbacks¶

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

tinkerforge dispatch thermocouple-v2-bricklet <uid> example

Die verfügbaren Callbacks werden weiter unten beschrieben.

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

Ausgabe:	temperature -- int

Dieser Callback wird periodisch ausgelöst abhängig von der mittels set-temperature-callback-configuration gesetzten Konfiguration

Der Parameter ist der gleiche wie get-temperature.

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

Ausgabe:	over-under -- bool open-circuit -- bool

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