TCP/IP - Thermal Imaging Bricklet

Dies ist die Beschreibung des TCP/IP Protokolls für das Thermal Imaging Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Thermal Imaging Bricklet sind in dessen Hardware Beschreibung zusammengefasst.

API

Eine allgemeine Beschreibung der TCP/IP Protokollstruktur findet sich hier.

Grundfunktionen

BrickletThermalImaging.get_high_contrast_image_low_level
Funktions-ID:
  • 1
Anfrage:
  • keine Nutzdaten
Antwort:
  • image_chunk_offset – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • image_chunk_data – Typ: uint8[62], Wertebereich: [0 bis 255]

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.

BrickletThermalImaging.get_temperature_image_low_level
Funktions-ID:
  • 2
Anfrage:
  • keine Nutzdaten
Antwort:
  • image_chunk_offset – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • image_chunk_data – Typ: uint16[31], Wertebereich: [0 bis 216 - 1]

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.

BrickletThermalImaging.get_statistics
Funktions-ID:
  • 3
Anfrage:
  • keine Nutzdaten
Antwort:
  • spotmeter_statistics – Typ: uint16[4], Wertebereich: [0 bis 216 - 1]
  • temperatures – Typ: uint16[4], Wertebereich: [0 bis 216 - 1]
  • resolution – Typ: uint8, Wertebereich: Siehe Bedeutungen
  • ffc_status – Typ: uint8, Wertebereich: Siehe Bedeutungen
  • temperature_warning – Typ: bool[2]

Gibt die Spotmeter Statistiken, verschiedene Temperaturen, die aktuelle Auflösung und Status-Bits zurück.

Die Spotmeter Statistiken bestehen aus:

  • Index 0: Durchschnittstemperatur.
  • Index 1: Maximal Temperatur.
  • Index 2: Minimal Temperatur.
  • Index 3: Pixel Anzahl der Spotmeter Region (Spotmeter Region of Interest).

Die Temperaturen sind:

  • Index 0: Sensorflächen Temperatur (Focal Plain Array Temperature).
  • Index 1: Sensorflächen Temperatur bei der letzten FFC (Flat Field Correction).
  • Index 2: Gehäusetemperatur.
  • Index 3: Gehäusetemperatur bei der letzten FFC.

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:

  • FFC Never Commanded: FFC wurde niemals ausgeführt. Dies ist nur nach dem Start vor dem ersten FFC der Fall.
  • FFC Imminent: Dieser Zustand wird zwei Sekunden vor einem FFC angenommen.
  • FFC In Progress: FFC wird ausgeführt (Der Shutter bewegt sich vor die Linse und wieder zurück). Dies benötigt ca. 1 Sekunde.
  • FFC Complete: FFC ist ausgeführt worden. Der Shutter ist wieder in der Warteposition.

Temperaturwarnungs-Status:

  • Index 0: Shutter-Sperre (shutter lockout). Wenn True, ist der Shutter gesperrt, da die Temperatur außerhalb des Bereichs -10°C bis +65°C liegt.
  • Index 1: Übertemperaturabschaltung steht bevor, wenn dieses Bit True ist. Bit wird 10 Sekunden vor der Abschaltung gesetzt.

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

Für resolution:

  • 0 = 0 To 6553 Kelvin
  • 1 = 0 To 655 Kelvin

Für ffc_status:

  • 0 = Never Commanded
  • 1 = Imminent
  • 2 = In Progress
  • 3 = Complete
BrickletThermalImaging.set_resolution
Funktions-ID:
  • 4
Anfrage:
  • resolution – Typ: uint8, Wertebereich: Siehe Bedeutungen
Antwort:
  • keine Antwort

Setzt die Auflösung. Das Thermal Imaging Bricklet kann entweder

  • von 0 bis 6553 Kelvin (-273,15°C bis +6279,85°C) mit 0,1°C Auflösung oder
  • von 0 bis 655 Kelvin (-273,15°C bis +381,85°C) mit 0,01°C Auflösung messen.

Die Genauigkeit ist spezifiziert von -10°C bis 450°C im ersten Auflösungsbereich und von -10°C bis 140°C im zweiten Bereich.

Der Standardwert ist 0 bis 655 Kelvin.

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

Für resolution:

  • 0 = 0 To 6553 Kelvin
  • 1 = 0 To 655 Kelvin
BrickletThermalImaging.get_resolution
Funktions-ID:
  • 5
Anfrage:
  • keine Nutzdaten
Antwort:
  • resolution – Typ: uint8, Wertebereich: Siehe Bedeutungen

Gibt die Auflösung zurück, wie von set_resolution gesetzt.

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

Für resolution:

  • 0 = 0 To 6553 Kelvin
  • 1 = 0 To 655 Kelvin
BrickletThermalImaging.set_spotmeter_config
Funktions-ID:
  • 6
Anfrage:
  • region_of_interest – Typ: uint8[4], Wertebereich: [0 bis 255]
Antwort:
  • keine Antwort

Setzt die Spotmeter Region (Spotmeter Region of Interest). Die 4 Werte sind

  • Index 0: Spaltenstart (muss kleiner sein wie Spaltenende).
  • Index 1: Zeilenstart (muss kleine sein wie Zeilenende).
  • Index 2: Spaltenende (muss kleiner sein wie 80).
  • Index 3: Zeilenende (muss kleiner sein wie 60).

Die Spotmeter Statistiken können mittels get_statistics ausgelesen werden.

Der Standardwert für die Spotmeter Region ist (39, 29, 40, 30).

BrickletThermalImaging.get_spotmeter_config
Funktions-ID:
  • 7
Anfrage:
  • keine Nutzdaten
Antwort:
  • region_of_interest – Typ: uint8[4], Wertebereich: [0 bis 255]

Gibt die Spotmeter Konfiguration zurück, wie von set_spotmeter_config gesetzt.

BrickletThermalImaging.set_high_contrast_config
Funktions-ID:
  • 8
Anfrage:
  • region_of_interest – Typ: uint8[4], Wertebereich: [0 bis 255]
  • dampening_factor – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • clip_limit – Typ: uint16[2], Wertebereich: [0 bis 216 - 1]
  • empty_counts – Typ: uint16, Wertebereich: [0 bis 216 - 1]
Antwort:
  • keine Antwort

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:

  • Index 0: Spaltenstart (muss kleiner sein wie Spaltenende).
  • Index 1: Zeilenstart (muss kleiner sein wie Zeilenende).
  • Index 2: Spaltenende (muss kleiner sein wie 80).
  • Index 3: Zeilenende (muss kleiner sein wie 60).

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.

Die Standardwerte sind:

  • Region Of Interest = (0, 0, 79, 59),
  • Dampening Factor = 64,
  • Clip Limit = (4800, 512) und
  • Empty Counts = 2.
BrickletThermalImaging.get_high_contrast_config
Funktions-ID:
  • 9
Anfrage:
  • keine Nutzdaten
Antwort:
  • region_of_interest – Typ: uint8[4], Wertebereich: [0 bis 255]
  • dampening_factor – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • clip_limit – Typ: uint16[2], Wertebereich: [0 bis 216 - 1]
  • empty_counts – Typ: uint16, Wertebereich: [0 bis 216 - 1]

Gibt die High Contrast Konfiguration zurück, wie von set_high_contrast_config gesetzt.

Fortgeschrittene Funktionen

BrickletThermalImaging.get_spitfp_error_count
Funktions-ID:
  • 234
Anfrage:
  • keine Nutzdaten
Antwort:
  • error_count_ack_checksum – Typ: uint32, Wertebereich: [0 bis 232 - 1]
  • error_count_message_checksum – Typ: uint32, Wertebereich: [0 bis 232 - 1]
  • error_count_frame – Typ: uint32, Wertebereich: [0 bis 232 - 1]
  • error_count_overflow – Typ: uint32, Wertebereich: [0 bis 232 - 1]

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.

BrickletThermalImaging.set_bootloader_mode
Funktions-ID:
  • 235
Anfrage:
  • mode – Typ: uint8, Wertebereich: Siehe Bedeutungen
Antwort:
  • status – Typ: uint8, Wertebereich: Siehe Bedeutungen

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 Bedeutungen sind für die Elemente dieser Funktion definiert:

Für mode:

  • 0 = Bootloader
  • 1 = Firmware
  • 2 = Bootloader Wait For Reboot
  • 3 = Firmware Wait For Reboot
  • 4 = Firmware Wait For Erase And Reboot

Für status:

  • 0 = OK
  • 1 = Invalid Mode
  • 2 = No Change
  • 3 = Entry Function Not Present
  • 4 = Device Identifier Incorrect
  • 5 = CRC Mismatch
BrickletThermalImaging.get_bootloader_mode
Funktions-ID:
  • 236
Anfrage:
  • keine Nutzdaten
Antwort:
  • mode – Typ: uint8, Wertebereich: Siehe Bedeutungen

Gibt den aktuellen Bootloader-Modus zurück, siehe set_bootloader_mode.

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

Für mode:

  • 0 = Bootloader
  • 1 = Firmware
  • 2 = Bootloader Wait For Reboot
  • 3 = Firmware Wait For Reboot
  • 4 = Firmware Wait For Erase And Reboot
BrickletThermalImaging.set_write_firmware_pointer
Funktions-ID:
  • 237
Anfrage:
  • pointer – Typ: uint32, Wertebereich: [0 bis 232 - 1]
Antwort:
  • keine Antwort

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.

BrickletThermalImaging.write_firmware
Funktions-ID:
  • 238
Anfrage:
  • data – Typ: uint8[64], Wertebereich: [0 bis 255]
Antwort:
  • status – Typ: uint8, Wertebereich: [0 bis 255]

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.

BrickletThermalImaging.set_status_led_config
Funktions-ID:
  • 239
Anfrage:
  • config – Typ: uint8, Wertebereich: Siehe Bedeutungen
Antwort:
  • keine Antwort

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 Bedeutungen sind für die Elemente dieser Funktion definiert:

Für config:

  • 0 = Off
  • 1 = On
  • 2 = Show Heartbeat
  • 3 = Show Status
BrickletThermalImaging.get_status_led_config
Funktions-ID:
  • 240
Anfrage:
  • keine Nutzdaten
Antwort:
  • config – Typ: uint8, Wertebereich: Siehe Bedeutungen

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

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

Für config:

  • 0 = Off
  • 1 = On
  • 2 = Show Heartbeat
  • 3 = Show Status
BrickletThermalImaging.get_chip_temperature
Funktions-ID:
  • 242
Anfrage:
  • keine Nutzdaten
Antwort:
  • temperature – Typ: int16, Wertebereich: [-215 bis 215 - 1]

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.

BrickletThermalImaging.reset
Funktions-ID:
  • 243
Anfrage:
  • keine Nutzdaten
Antwort:
  • keine Antwort

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.

BrickletThermalImaging.write_uid
Funktions-ID:
  • 248
Anfrage:
  • uid – Typ: uint32, Wertebereich: [0 bis 232 - 1]
Antwort:
  • keine Antwort

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.

BrickletThermalImaging.read_uid
Funktions-ID:
  • 249
Anfrage:
  • keine Nutzdaten
Antwort:
  • uid – Typ: uint32, Wertebereich: [0 bis 232 - 1]

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

BrickletThermalImaging.get_identity
Funktions-ID:
  • 255
Anfrage:
  • keine Nutzdaten
Antwort:
  • uid – Typ: char[8]
  • connected_uid – Typ: char[8]
  • position – Typ: char
  • hardware_version – Typ: uint8[3], Wertebereich: [0 bis 255]
  • firmware_version – Typ: uint8[3], Wertebereich: [0 bis 255]
  • device_identifier – Typ: uint16, 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 kann 'a', 'b', 'c' oder 'd' sein.

Eine Liste der Device Identifier Werte ist hier zu finden. 

Konfigurationsfunktionen für Callbacks

BrickletThermalImaging.set_image_transfer_config
Funktions-ID:
  • 10
Anfrage:
  • config – Typ: uint8, Wertebereich: Siehe Bedeutungen
Antwort:
  • keine Antwort

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:

Der Standardwert ist Manual High Contrast Image (0).

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

Für config:

  • 0 = Manual High Contrast Image
  • 1 = Manual Temperature Image
  • 2 = Callback High Contrast Image
  • 3 = Callback Temperature Image
BrickletThermalImaging.get_image_transfer_config
Funktions-ID:
  • 11
Anfrage:
  • keine Nutzdaten
Antwort:
  • config – Typ: uint8, Wertebereich: Siehe Bedeutungen

Gibt die Image Transfer Konfiguration zurück, wie von set_image_transfer_config gesetzt.

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

Für config:

  • 0 = Manual High Contrast Image
  • 1 = Manual Temperature Image
  • 2 = Callback High Contrast Image
  • 3 = Callback Temperature Image

Callbacks

BrickletThermalImaging.CALLBACK_HIGH_CONTRAST_IMAGE_LOW_LEVEL
Funktions-ID:
  • 12
Antwort:
  • image_chunk_offset – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • image_chunk_data – Typ: uint8[62], Wertebereich: [0 bis 255]

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.

BrickletThermalImaging.CALLBACK_TEMPERATURE_IMAGE_LOW_LEVEL
Funktions-ID:
  • 13
Antwort:
  • image_chunk_offset – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • image_chunk_data – Typ: uint16[31], Wertebereich: [0 bis 216 - 1]

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.