Dies ist die Beschreibung der Shell API Bindings für das Thermal Imaging Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Thermal Imaging Bricklet sind in dessen Hardware Beschreibung zusammengefasst.
Eine Installationanleitung für die Shell API Bindings ist Teil deren allgemeine Beschreibung.
Der folgende Beispielcode ist Public Domain (CC0 1.0).
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 Thermal Imaging Bricklet
# Handle incoming high contrast image callbacks
tinkerforge dispatch thermal-imaging-bricklet $uid high-contrast-image &
# Enable high contrast image transfer for callback
tinkerforge call thermal-imaging-bricklet $uid set-image-transfer-config image-transfer-callback-high-contrast-image
echo "Press key to exit"; read dummy
kill -- -$$ # Stop callback dispatch in background
|
Mögliche Exit Codes für alle tinkerforge
Befehle sind:
argparse
Modul fehltAllgemeine Optionen des call
und des dispatch
Befehls sind
hier zu finden. Im Folgenden wird die spezifische
Befehlsstruktur dargestellt.
call
thermal-imaging-bricklet
[<option>..] <uid> <function> [<argument>..]¶Parameter: |
|
---|
Der call
Befehl wird verwendet um eine Funktion des Thermal Imaging 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 Thermal Imaging Bricklet an
und endet danndispatch
thermal-imaging-bricklet
[<option>..] <uid> <callback>¶Parameter: |
|
---|
Der dispatch
Befehl wird verwendet um eingehende Callbacks des Thermal Imaging 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 Thermal Imaging Bricklet an
und endet dannthermal-imaging-bricklet
<uid> <function>
[<option>..] [<argument>..]¶Parameter: |
|
---|
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 dannGetter-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 dieseMit 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.
thermal-imaging-bricklet
<uid> <callback>
[<option>..]¶Parameter: |
|
---|
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)thermal-imaging-bricklet
<uid> get-high-contrast-image
¶Ausgabe: |
|
---|
Gibt das aktuelle High Contrast Image zurück. Siehe hier für eine Beschreibung des Unterschieds zwischen High Contrast Image und einem Temperature Image. Wenn unbekannt ist welche Darstellungsform genutzt werden soll, ist vermutlich das High Contrast Image die richtige form.
Die Daten der 80x60 Pixel-Matrix werden als ein eindimensionales Array bestehend aus 8-Bit Werten dargestellt. Die Daten sind Zeile für Zeile von oben links bis unten rechts angeordnet.
Jeder 8-Bit Wert stellt ein Pixel aus dem Grauwertbild dar und kann als solcher direkt dargestellt werden.
Bevor die Funktion genutzt werden kann muss diese mittels
set-image-transfer-config
aktiviert werden.
thermal-imaging-bricklet
<uid> get-temperature-image
¶Ausgabe: |
|
---|
Gibt das aktuelle Temperature Image zurück. See hier für eine Beschreibung des Unterschieds zwischen High Contrast und Temperature Image. Wenn unbekannt ist welche Darstellungsform genutzt werden soll, ist vermutlich das High Contrast Image die richtige Form.
Die Daten der 80x60 Pixel-Matrix werden als ein eindimensionales Array bestehend aus 16-Bit Werten dargestellt. Die Daten sind Zeile für Zeile von oben links bis unten rechts angeordnet.
Jeder 16-Bit Wert stellt eine Temperaturmessung in entweder Kelvin/10 oder
Kelvin/100 dar (abhängig von der Auflösung die mittels set-resolution
eingestellt wurde).
Bevor die Funktion genutzt werden kann muss diese mittels
set-image-transfer-config
aktiviert werden.
thermal-imaging-bricklet
<uid> get-statistics
¶Ausgabe: |
|
---|
Gibt die Spotmeter Statistiken, verschiedene Temperaturen, die aktuelle Auflösung und Status-Bits zurück.
Die Spotmeter Statistiken bestehen aus:
Die Temperaturen sind:
Die Auflösung ist entweder 0 bis 6553 Kelvin oder 0 bis 655 Kelvin. Ist die Auflösung ersteres, so ist die Auflösung Kelvin/10. Ansonsten ist sie Kelvin/100.
FFC (Flat Field Correction) Status:
Temperaturwarnungs-Status:
Die folgenden Symbole sind für diese Funktion verfügbar:
Für resolution:
Für ffc-status:
thermal-imaging-bricklet
<uid> set-resolution
<resolution>¶Parameter: |
|
---|---|
Ausgabe: |
|
Setzt die Auflösung. Das Thermal Imaging Bricklet kann entweder
Die Genauigkeit ist spezifiziert von -10°C bis 450°C im ersten Auflösungsbereich und von -10°C bis 140°C im zweiten Bereich.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für <resolution>:
thermal-imaging-bricklet
<uid> get-resolution
¶Ausgabe: |
|
---|
Gibt die Auflösung zurück, wie von set-resolution
gesetzt.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für resolution:
thermal-imaging-bricklet
<uid> set-spotmeter-config
<region-of-interest>¶Parameter: |
|
---|---|
Ausgabe: |
|
Setzt die Spotmeter Region (Spotmeter Region of Interest). Die 4 Werte sind
Die Spotmeter Statistiken können mittels get-statistics
ausgelesen werden.
thermal-imaging-bricklet
<uid> get-spotmeter-config
¶Ausgabe: |
|
---|
Gibt die Spotmeter Konfiguration zurück, wie von set-spotmeter-config
gesetzt.
thermal-imaging-bricklet
<uid> set-high-contrast-config
<region-of-interest> <dampening-factor> <clip-limit> <empty-counts>¶Parameter: |
|
---|---|
Ausgabe: |
|
Setzt die Region of Interest für das High Contrast Image, den Dampening Faktor, das
Clip Limit und die Empty Counts. Diese Konfiguration wird nur im High Contrast Modus
genutzt (siehe set-image-transfer-config
).
Die High Contrast Region of Interest besteht aus vier Werten:
Der Algorithmus zum Erzeugen eines High Contrast Images wird auf diese Region angewandt.
Dampening Factor: Dieser Parameter stellt die Stärke der zeitlichen Dämpfung dar, die auf der HEQ (History Equalization) Transformationsfunktion angewendet wird. Ein IIR-Filter der Form:
(N / 256) * transformation_zuvor + ((256 - N) / 256) * transformation_aktuell
wird dort angewendet. Der HEQ Dämpfungsfaktor stellt dabei den Wert N in der Gleichung dar. Der Faktor stellt also ein, wie stark der Einfluss der vorherigen HEQ Transformation auf die aktuelle ist. Umso niedriger der Wert von N um so größer ist der Einfluss des aktuellen Bildes. Umso größer der Wert von N umso kleiner ist der Einfluss der vorherigen Dämpfungs-Transferfunktion.
Clip Limit Index 0 (AGC HEQ Clip Limit High): Dieser Parameter definiert die maximale Anzahl an Pixeln, die sich in jeder Histogrammklasse sammeln dürfen. Jedes weitere Pixel wird verworfen. Der Effekt dieses Parameters ist den Einfluss von stark gefüllten Klassen in der HEQ Transformation zu beschränken.
Clip Limit Index 1 (AGC HEQ Clip Limit Low): Dieser Parameter definiert einen künstliche Menge, die jeder nicht leeren Histogrammklasse hinzugefügt wird. Wenn Clip Limit Low mit L dargestellt wird, so erhält jede Klasse mit der aktuellen Menge X die effektive Menge L + X. Jede Klasse, die nahe einer gefüllten Klasse ist erhält die Menge L. Der Effekt von höheren Werten ist eine stärkere lineare Transferfunktion bereitzustellen. Niedrigere Werte führen zu einer nichtlinearen Transferfunktion.
Empty Counts: Dieser Parameter spezifiziert die maximale Anzahl von Pixeln in einer Klasse, damit die Klasse als leere Klasse interpretiert wird. Jede Histogrammklasse mit dieser Anzahl an Pixeln oder weniger wird als leere Klasse behandelt.
thermal-imaging-bricklet
<uid> get-high-contrast-config
¶Ausgabe: |
|
---|
Gibt die High Contrast Konfiguration zurück, wie von
set-high-contrast-config
gesetzt.
thermal-imaging-bricklet
<uid> set-flux-linear-parameters
<scene-emissivity> <temperature-background> <tau-window> <temperatur-window> <tau-atmosphere> <temperature-atmosphere> <reflection-window> <temperature-reflection>¶Parameter: |
|
---|---|
Ausgabe: |
|
Setzt die Flux-Linear-Parmaeter die für eine Radiometrie-Kalibrierung benötigt werden.
Siehe FLIR-Dokument 102-PS245-100-01 für mehr Informationen.
Neu in Version 2.0.5 (Plugin).
thermal-imaging-bricklet
<uid> get-flux-linear-parameters
¶Ausgabe: |
|
---|
Gibt die Flux-Linear-Parameter zurück, wie von set-flux-linear-parameters
gesetzt.
Neu in Version 2.0.5 (Plugin).
thermal-imaging-bricklet
<uid> set-ffc-shutter-mode
<shutter-mode> <temp-lockout-state> <video-freeze-during-ffc> <ffc-desired> <elapsed-time-since-last-ffc> <desired-ffc-period> <explicit-cmd-to-open> <desired-ffc-temp-delta> <imminent-delay>¶Parameter: |
|
---|---|
Ausgabe: |
|
Setzt die FFC-Shutter-Mode Parameter.
Siehe FLIR-Dokument 110-0144-03 4.5.15 für mehr Informationen.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für <shutter-mode>:
Für <temp-lockout-state>:
Neu in Version 2.0.6 (Plugin).
thermal-imaging-bricklet
<uid> get-ffc-shutter-mode
¶Ausgabe: |
|
---|
Setzt die FFC-Shutter-Mode Parameter.
Siehe FLIR-Dokument 110-0144-03 4.5.15 für mehr Informationen.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für shutter-mode:
Für temp-lockout-state:
Neu in Version 2.0.6 (Plugin).
thermal-imaging-bricklet
<uid> run-ffc-normalization
¶Ausgabe: |
|
---|
Startet die Flat-Field Correction (FFC) Normalisierung.
Siehe FLIR-Dokument 110-0144-03 4.5.16 für mehr Informationen.
Neu in Version 2.0.6 (Plugin).
thermal-imaging-bricklet
<uid> get-spitfp-error-count
¶Ausgabe: |
|
---|
Gibt die Anzahl der Fehler die während der Kommunikation zwischen Brick und Bricklet aufgetreten sind zurück.
Die Fehler sind aufgeteilt in
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.
thermal-imaging-bricklet
<uid> set-status-led-config
<config>¶Parameter: |
|
---|---|
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:
Für <config>:
thermal-imaging-bricklet
<uid> get-status-led-config
¶Ausgabe: |
|
---|
Gibt die Konfiguration zurück, wie von set-status-led-config
gesetzt.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für config:
thermal-imaging-bricklet
<uid> get-chip-temperature
¶Ausgabe: |
|
---|
Gibt die Temperatur, 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.
thermal-imaging-bricklet
<uid> reset
¶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.
thermal-imaging-bricklet
<uid> get-identity
¶Ausgabe: |
|
---|
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.
thermal-imaging-bricklet
<uid> set-image-transfer-config
<config>¶Parameter: |
|
---|---|
Ausgabe: |
|
Die notwendige Bandbreite für dieses Bricklet ist zu groß um Getter/Callbacks oder High Contrast/Temperature Images gleichzeitig zu nutzen. Daher muss konfiguriert werden was genutzt werden soll. Das Bricklet optimiert seine interne Konfiguration anschließend dahingehend.
Zugehörige Funktionen:
get-high-contrast-image
.get-temperature-image
.high-contrast-image
callback.temperature-image
callback.Die folgenden Symbole sind für diese Funktion verfügbar:
Für <config>:
thermal-imaging-bricklet
<uid> get-image-transfer-config
¶Ausgabe: |
|
---|
Gibt die Image Transfer Konfiguration zurück, wie von set-image-transfer-config
gesetzt.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für config:
Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten:
tinkerforge dispatch thermal-imaging-bricklet <uid> example
Die verfügbaren Callbacks werden weiter unten beschrieben.
Bemerkung
Callbacks für wiederkehrende Ereignisse zu verwenden ist immer zu bevorzugen gegenüber der Verwendung von Abfragen. Es wird weniger USB-Bandbreite benutzt und die Latenz ist erheblich geringer, da es keine Paketumlaufzeit gibt.
thermal-imaging-bricklet
<uid> high-contrast-image
¶Ausgabe: |
|
---|
Dieser Callback wird für jedes neue High Contrast Image ausgelöst, wenn die
Transfer Image Config für diesen Callback konfiguriert wurde (siehe
set-image-transfer-config
).
Die Daten der 80x60 Pixel-Matrix werden als ein eindimensionales Array bestehend aus 8-Bit Werten dargestellt. Die Daten sind Zeile für Zeile von oben links bis unten rechts angeordnet.
Jeder 8-Bit Wert stellt ein Pixel aus dem Grauwertbild dar und kann als solcher direkt dargestellt werden.
Bemerkung
Falls das Rekonstruieren des Wertes fehlschlägt, wird der Callback mit None für image ausgelöst.
thermal-imaging-bricklet
<uid> temperature-image
¶Ausgabe: |
|
---|
Dieser Callback wird für jedes neue Temperature Image ausgelöst, wenn die Transfer
Image Config für diesen Callback konfiguriert wurde (siehe
set-image-transfer-config
).
Die Daten der 80x60 Pixel-Matrix werden als ein eindimensionales Array bestehend aus 16-Bit Werten dargestellt. Die Daten sind Zeile für Zeile von oben links bis unten rechts angeordnet.
Jeder 16-Bit Wert stellt ein Pixel aus dem Temperatur Bild dar und kann als solcher direkt dargestellt werden.
Bemerkung
Falls das Rekonstruieren des Wertes fehlschlägt, wird der Callback mit None für image ausgelöst.
Interne Funktionen werden für Wartungsaufgaben, wie zum Beispiel das Flashen einer neuen Firmware oder das Ändern der UID eines Bricklets, verwendet. Diese Aufgaben sollten mit Brick Viewer durchgeführt werden, anstelle die internen Funktionen direkt zu verwenden.
thermal-imaging-bricklet
<uid> set-bootloader-mode
<mode>¶Parameter: |
|
---|---|
Ausgabe: |
|
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 Bootloader- 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:
Für <mode>:
Für status:
thermal-imaging-bricklet
<uid> get-bootloader-mode
¶Ausgabe: |
|
---|
Gibt den aktuellen Bootloader-Modus zurück, siehe set-bootloader-mode
.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für mode:
thermal-imaging-bricklet
<uid> set-write-firmware-pointer
<pointer>¶Parameter: |
|
---|---|
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.
thermal-imaging-bricklet
<uid> write-firmware
<data>¶Parameter: |
|
---|---|
Ausgabe: |
|
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.
thermal-imaging-bricklet
<uid> write-uid
<uid>¶Parameter: |
|
---|---|
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.
thermal-imaging-bricklet
<uid> read-uid
¶Ausgabe: |
|
---|
Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.