C/C++ - Thermal Imaging Bricklet

Dies ist die Beschreibung der C/C++ 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 C/C++ API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Callback

Download (example_callback.c)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_thermal_imaging.h"

#define HOST "localhost"
#define PORT 4223
#define UID "XYZ" // Change XYZ to the UID of your Thermal Imaging Bricklet

// Callback function for high contrast image callback
void cb_high_contrast_image(uint8_t *image, uint16_t image_length, void *user_data) {
    (void)image; (void)image_length; (void)user_data; // avoid unused parameter warning

    // image is an array of size 80*60 with a 8 bit grey value for each element
}

int main(void) {
    // Create IP connection
    IPConnection ipcon;
    ipcon_create(&ipcon);

    // Create device object
    ThermalImaging ti;
    thermal_imaging_create(&ti, UID, &ipcon);

    // Connect to brickd
    if(ipcon_connect(&ipcon, HOST, PORT) < 0) {
        fprintf(stderr, "Could not connect\n");
        return 1;
    }
    // Don't use device before ipcon is connected

    // Register high contrast image callback to function cb_high_contrast_image
    thermal_imaging_register_callback(&ti,
                                      THERMAL_IMAGING_CALLBACK_HIGH_CONTRAST_IMAGE,
                                      (void (*)(void))cb_high_contrast_image,
                                      NULL);

    // Enable high contrast image transfer for callback
    thermal_imaging_set_image_transfer_config(&ti,
                                              THERMAL_IMAGING_IMAGE_TRANSFER_CALLBACK_HIGH_CONTRAST_IMAGE);

    printf("Press key to exit\n");
    getchar();
    thermal_imaging_destroy(&ti);
    ipcon_destroy(&ipcon); // Calls ipcon_disconnect internally
    return 0;
}

API

Jede Funktion der C/C++ Bindings gibt einen Integer zurück, welcher einen Fehlercode beschreibt. Vom Gerät zurückgegebene Daten werden, wenn eine Abfrage aufgerufen wurde, über Ausgabeparameter gehandhabt. Diese Parameter sind mit dem ret_ Präfix gekennzeichnet.

Mögliche Fehlercodes sind:

  • E_OK = 0
  • E_TIMEOUT = -1
  • E_NO_STREAM_SOCKET = -2
  • E_HOSTNAME_INVALID = -3
  • E_NO_CONNECT = -4
  • E_NO_THREAD = -5
  • E_NOT_ADDED = -6 (wird seit C/C++ Bindings Version 2.0.0 nicht mehr verwendet)
  • E_ALREADY_CONNECTED = -7
  • E_NOT_CONNECTED = -8
  • E_INVALID_PARAMETER = -9
  • E_NOT_SUPPORTED = -10
  • E_UNKNOWN_ERROR_CODE = -11
  • E_STREAM_OUT_OF_SYNC = -12
  • E_INVALID_UID = -13
  • E_NON_ASCII_CHAR_IN_SECRET = -14

wie in ip_connection.h definiert.

Alle folgend aufgelisteten Funktionen sind Thread-sicher.

Grundfunktionen

void thermal_imaging_create(ThermalImaging *thermal_imaging, const char *uid, IPConnection *ipcon)
Parameter:
  • thermal_imaging – Typ: ThermalImaging *
  • uid – Typ: const char *
  • ipcon – Typ: IPConnection *

Erzeugt ein Geräteobjekt thermal_imaging mit der eindeutigen Geräte ID uid und fügt es der IP Connection ipcon hinzu:

ThermalImaging thermal_imaging;
thermal_imaging_create(&thermal_imaging, "YOUR_DEVICE_UID", &ipcon);

Dieses Geräteobjekt kann benutzt werden, nachdem die IP Connection verbunden wurde (siehe Beispiele oben).

void thermal_imaging_destroy(ThermalImaging *thermal_imaging)
Parameter:
  • thermal_imaging – Typ: ThermalImaging *

Entfernt das Geräteobjekt thermal_imaging von dessen IP Connection und zerstört es. Das Geräteobjekt kann hiernach nicht mehr verwendet werden.

int thermal_imaging_get_high_contrast_image(ThermalImaging *thermal_imaging, uint8_t *ret_image, uint16_t *ret_image_length)
Parameter:
  • thermal_imaging – Typ: ThermalImaging *
Ausgabeparameter:
  • ret_image – Typ: uint8_t[4800], Wertebereich: [0 bis 255]
  • ret_image_length – Typ: uint16_t
Rückgabe:
  • error_code – Typ: int

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 thermal_imaging_set_image_transfer_config() aktiviert werden.

int thermal_imaging_get_temperature_image(ThermalImaging *thermal_imaging, uint16_t *ret_image, uint16_t *ret_image_length)
Parameter:
  • thermal_imaging – Typ: ThermalImaging *
Ausgabeparameter:
  • ret_image – Typ: uint16_t[4800], Einheit: ? K, Wertebereich: [-1000 bis 1400]
  • ret_image_length – Typ: uint16_t
Rückgabe:
  • error_code – Typ: int

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 thermal_imaging_set_resolution() eingestellt wurde).

Bevor die Funktion genutzt werden kann muss diese mittels thermal_imaging_set_image_transfer_config() aktiviert werden.

int thermal_imaging_get_statistics(ThermalImaging *thermal_imaging, uint16_t ret_spotmeter_statistics[4], uint16_t ret_temperatures[4], uint8_t *ret_resolution, uint8_t *ret_ffc_status, bool ret_temperature_warning[2])
Parameter:
  • thermal_imaging – Typ: ThermalImaging *
Ausgabeparameter:
  • ret_spotmeter_statistics – Typ: uint16_t[4]
    • 0: mean_temperature – Typ: uint16_t, Einheit: ? K, Wertebereich: [0 bis 216 - 1]
    • 1: max_temperature – Typ: uint16_t, Einheit: ? K, Wertebereich: [0 bis 216 - 1]
    • 2: min_temperature – Typ: uint16_t, Einheit: ? K, Wertebereich: [0 bis 216 - 1]
    • 3: pixel_count – Typ: uint16_t, Wertebereich: [0 bis 4800]
  • ret_temperatures – Typ: uint16_t[4]
    • 0: focal_plain_array – Typ: uint16_t, Einheit: ? K, Wertebereich: [0 bis 216 - 1]
    • 1: focal_plain_array_last_ffc – Typ: uint16_t, Einheit: ? K, Wertebereich: [0 bis 216 - 1]
    • 2: housing – Typ: uint16_t, Einheit: ? K, Wertebereich: [0 bis 216 - 1]
    • 3: housing_last_ffc – Typ: uint16_t, Einheit: ? K, Wertebereich: [0 bis 216 - 1]
  • ret_resolution – Typ: uint8_t, Wertebereich: Siehe Konstanten
  • ret_ffc_status – Typ: uint8_t, Wertebereich: Siehe Konstanten
  • ret_temperature_warning – Typ: bool[2]
    • 0: shutter_lockout – Typ: bool
    • 1: overtemperature_shut_down_imminent – Typ: bool
Rückgabe:
  • error_code – Typ: int

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

Für ret_resolution:

  • THERMAL_IMAGING_RESOLUTION_0_TO_6553_KELVIN = 0
  • THERMAL_IMAGING_RESOLUTION_0_TO_655_KELVIN = 1

Für ret_ffc_status:

  • THERMAL_IMAGING_FFC_STATUS_NEVER_COMMANDED = 0
  • THERMAL_IMAGING_FFC_STATUS_IMMINENT = 1
  • THERMAL_IMAGING_FFC_STATUS_IN_PROGRESS = 2
  • THERMAL_IMAGING_FFC_STATUS_COMPLETE = 3
int thermal_imaging_set_resolution(ThermalImaging *thermal_imaging, uint8_t resolution)
Parameter:
  • thermal_imaging – Typ: ThermalImaging *
  • resolution – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 1
Rückgabe:
  • error_code – Typ: int

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.

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

Für resolution:

  • THERMAL_IMAGING_RESOLUTION_0_TO_6553_KELVIN = 0
  • THERMAL_IMAGING_RESOLUTION_0_TO_655_KELVIN = 1
int thermal_imaging_get_resolution(ThermalImaging *thermal_imaging, uint8_t *ret_resolution)
Parameter:
  • thermal_imaging – Typ: ThermalImaging *
Ausgabeparameter:
  • ret_resolution – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:
  • error_code – Typ: int

Gibt die Auflösung zurück, wie von thermal_imaging_set_resolution() gesetzt.

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

Für ret_resolution:

  • THERMAL_IMAGING_RESOLUTION_0_TO_6553_KELVIN = 0
  • THERMAL_IMAGING_RESOLUTION_0_TO_655_KELVIN = 1
int thermal_imaging_set_spotmeter_config(ThermalImaging *thermal_imaging, uint8_t region_of_interest[4])
Parameter:
  • thermal_imaging – Typ: ThermalImaging *
  • region_of_interest – Typ: uint8_t[4]
    • 0: first_column – Typ: uint8_t, Wertebereich: [0 bis 79], Standardwert: 39
    • 1: first_row – Typ: uint8_t, Wertebereich: [0 bis 59], Standardwert: 29
    • 2: last_column – Typ: uint8_t, Wertebereich: [1 bis 80], Standardwert: 40
    • 3: last_row – Typ: uint8_t, Wertebereich: [1 bis 60], Standardwert: 30
Rückgabe:
  • error_code – Typ: int

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

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

Die Spotmeter Statistiken können mittels thermal_imaging_get_statistics() ausgelesen werden.

int thermal_imaging_get_spotmeter_config(ThermalImaging *thermal_imaging, uint8_t ret_region_of_interest[4])
Parameter:
  • thermal_imaging – Typ: ThermalImaging *
Ausgabeparameter:
  • ret_region_of_interest – Typ: uint8_t[4]
    • 0: first_column – Typ: uint8_t, Wertebereich: [0 bis 78], Standardwert: 39
    • 1: first_row – Typ: uint8_t, Wertebereich: [0 bis 58], Standardwert: 29
    • 2: last_column – Typ: uint8_t, Wertebereich: [1 bis 79], Standardwert: 40
    • 3: last_row – Typ: uint8_t, Wertebereich: [1 bis 59], Standardwert: 30
Rückgabe:
  • error_code – Typ: int

Gibt die Spotmeter Konfiguration zurück, wie von thermal_imaging_set_spotmeter_config() gesetzt.

int thermal_imaging_set_high_contrast_config(ThermalImaging *thermal_imaging, uint8_t region_of_interest[4], uint16_t dampening_factor, uint16_t clip_limit[2], uint16_t empty_counts)
Parameter:
  • thermal_imaging – Typ: ThermalImaging *
  • region_of_interest – Typ: uint8_t[4]
    • 0: first_column – Typ: uint8_t, Wertebereich: [0 bis 78], Standardwert: 0
    • 1: first_row – Typ: uint8_t, Wertebereich: [0 bis 58], Standardwert: 0
    • 2: last_column – Typ: uint8_t, Wertebereich: [1 bis 79], Standardwert: 79
    • 3: last_row – Typ: uint8_t, Wertebereich: [1 bis 59], Standardwert: 59
  • dampening_factor – Typ: uint16_t, Wertebereich: [0 bis 256], Standardwert: 64
  • clip_limit – Typ: uint16_t[2]
    • 0: agc_heq_clip_limit_high – Typ: uint16_t, Wertebereich: [0 bis 4800], Standardwert: 4800
    • 1: agc_heq_clip_limit_low – Typ: uint16_t, Wertebereich: [0 bis 1024], Standardwert: 512
  • empty_counts – Typ: uint16_t, Wertebereich: [0 bis 216 - 1], Standardwert: 2
Rückgabe:
  • error_code – Typ: int

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 thermal_imaging_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.

int thermal_imaging_get_high_contrast_config(ThermalImaging *thermal_imaging, uint8_t ret_region_of_interest[4], uint16_t *ret_dampening_factor, uint16_t ret_clip_limit[2], uint16_t *ret_empty_counts)
Parameter:
  • thermal_imaging – Typ: ThermalImaging *
Ausgabeparameter:
  • ret_region_of_interest – Typ: uint8_t[4]
    • 0: first_column – Typ: uint8_t, Wertebereich: [0 bis 78], Standardwert: 0
    • 1: first_row – Typ: uint8_t, Wertebereich: [0 bis 58], Standardwert: 0
    • 2: last_column – Typ: uint8_t, Wertebereich: [1 bis 79], Standardwert: 79
    • 3: last_row – Typ: uint8_t, Wertebereich: [1 bis 59], Standardwert: 59
  • ret_dampening_factor – Typ: uint16_t, Wertebereich: [0 bis 256], Standardwert: 64
  • ret_clip_limit – Typ: uint16_t[2]
    • 0: agc_heq_clip_limit_high – Typ: uint16_t, Wertebereich: [0 bis 4800], Standardwert: 4800
    • 1: agc_heq_clip_limit_low – Typ: uint16_t, Wertebereich: [0 bis 1024], Standardwert: 512
  • ret_empty_counts – Typ: uint16_t, Wertebereich: [0 bis 216 - 1], Standardwert: 2
Rückgabe:
  • error_code – Typ: int

Gibt die High Contrast Konfiguration zurück, wie von thermal_imaging_set_high_contrast_config() gesetzt.

Fortgeschrittene Funktionen

int thermal_imaging_get_spitfp_error_count(ThermalImaging *thermal_imaging, uint32_t *ret_error_count_ack_checksum, uint32_t *ret_error_count_message_checksum, uint32_t *ret_error_count_frame, uint32_t *ret_error_count_overflow)
Parameter:
  • thermal_imaging – Typ: ThermalImaging *
Ausgabeparameter:
  • ret_error_count_ack_checksum – Typ: uint32_t, Wertebereich: [0 bis 232 - 1]
  • ret_error_count_message_checksum – Typ: uint32_t, Wertebereich: [0 bis 232 - 1]
  • ret_error_count_frame – Typ: uint32_t, Wertebereich: [0 bis 232 - 1]
  • ret_error_count_overflow – Typ: uint32_t, Wertebereich: [0 bis 232 - 1]
Rückgabe:
  • error_code – Typ: 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.

int thermal_imaging_set_bootloader_mode(ThermalImaging *thermal_imaging, uint8_t mode, uint8_t *ret_status)
Parameter:
  • thermal_imaging – Typ: ThermalImaging *
  • mode – Typ: uint8_t, Wertebereich: Siehe Konstanten
Ausgabeparameter:
  • ret_status – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:
  • error_code – Typ: int

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

Für mode:

  • THERMAL_IMAGING_BOOTLOADER_MODE_BOOTLOADER = 0
  • THERMAL_IMAGING_BOOTLOADER_MODE_FIRMWARE = 1
  • THERMAL_IMAGING_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • THERMAL_IMAGING_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • THERMAL_IMAGING_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für ret_status:

  • THERMAL_IMAGING_BOOTLOADER_STATUS_OK = 0
  • THERMAL_IMAGING_BOOTLOADER_STATUS_INVALID_MODE = 1
  • THERMAL_IMAGING_BOOTLOADER_STATUS_NO_CHANGE = 2
  • THERMAL_IMAGING_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • THERMAL_IMAGING_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • THERMAL_IMAGING_BOOTLOADER_STATUS_CRC_MISMATCH = 5
int thermal_imaging_get_bootloader_mode(ThermalImaging *thermal_imaging, uint8_t *ret_mode)
Parameter:
  • thermal_imaging – Typ: ThermalImaging *
Ausgabeparameter:
  • ret_mode – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:
  • error_code – Typ: int

Gibt den aktuellen Bootloader-Modus zurück, siehe thermal_imaging_set_bootloader_mode().

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

Für ret_mode:

  • THERMAL_IMAGING_BOOTLOADER_MODE_BOOTLOADER = 0
  • THERMAL_IMAGING_BOOTLOADER_MODE_FIRMWARE = 1
  • THERMAL_IMAGING_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • THERMAL_IMAGING_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • THERMAL_IMAGING_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
int thermal_imaging_set_write_firmware_pointer(ThermalImaging *thermal_imaging, uint32_t pointer)
Parameter:
  • thermal_imaging – Typ: ThermalImaging *
  • pointer – Typ: uint32_t, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]
Rückgabe:
  • error_code – Typ: int

Setzt den Firmware-Pointer für thermal_imaging_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.

int thermal_imaging_write_firmware(ThermalImaging *thermal_imaging, uint8_t data[64], uint8_t *ret_status)
Parameter:
  • thermal_imaging – Typ: ThermalImaging *
  • data – Typ: uint8_t[64], Wertebereich: [0 bis 255]
Ausgabeparameter:
  • ret_status – Typ: uint8_t, Wertebereich: [0 bis 255]
Rückgabe:
  • error_code – Typ: int

Schreibt 64 Bytes Firmware an die Position die vorher von thermal_imaging_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.

int thermal_imaging_set_status_led_config(ThermalImaging *thermal_imaging, uint8_t config)
Parameter:
  • thermal_imaging – Typ: ThermalImaging *
  • config – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 3
Rückgabe:
  • error_code – Typ: int

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

Für config:

  • THERMAL_IMAGING_STATUS_LED_CONFIG_OFF = 0
  • THERMAL_IMAGING_STATUS_LED_CONFIG_ON = 1
  • THERMAL_IMAGING_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • THERMAL_IMAGING_STATUS_LED_CONFIG_SHOW_STATUS = 3
int thermal_imaging_get_status_led_config(ThermalImaging *thermal_imaging, uint8_t *ret_config)
Parameter:
  • thermal_imaging – Typ: ThermalImaging *
Ausgabeparameter:
  • ret_config – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 3
Rückgabe:
  • error_code – Typ: int

Gibt die Konfiguration zurück, wie von thermal_imaging_set_status_led_config() gesetzt.

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

Für ret_config:

  • THERMAL_IMAGING_STATUS_LED_CONFIG_OFF = 0
  • THERMAL_IMAGING_STATUS_LED_CONFIG_ON = 1
  • THERMAL_IMAGING_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • THERMAL_IMAGING_STATUS_LED_CONFIG_SHOW_STATUS = 3
int thermal_imaging_get_chip_temperature(ThermalImaging *thermal_imaging, int16_t *ret_temperature)
Parameter:
  • thermal_imaging – Typ: ThermalImaging *
Ausgabeparameter:
  • ret_temperature – Typ: int16_t, Einheit: 1 °C, Wertebereich: [-215 bis 215 - 1]
Rückgabe:
  • error_code – Typ: int

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.

int thermal_imaging_reset(ThermalImaging *thermal_imaging)
Parameter:
  • thermal_imaging – Typ: ThermalImaging *
Rückgabe:
  • error_code – Typ: int

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.

int thermal_imaging_write_uid(ThermalImaging *thermal_imaging, uint32_t uid)
Parameter:
  • thermal_imaging – Typ: ThermalImaging *
  • uid – Typ: uint32_t, Wertebereich: [0 bis 232 - 1]
Rückgabe:
  • error_code – Typ: int

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.

int thermal_imaging_read_uid(ThermalImaging *thermal_imaging, uint32_t *ret_uid)
Parameter:
  • thermal_imaging – Typ: ThermalImaging *
Ausgabeparameter:
  • ret_uid – Typ: uint32_t, Wertebereich: [0 bis 232 - 1]
Rückgabe:
  • error_code – Typ: int

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

int thermal_imaging_get_identity(ThermalImaging *thermal_imaging, char ret_uid[8], char ret_connected_uid[8], char *ret_position, uint8_t ret_hardware_version[3], uint8_t ret_firmware_version[3], uint16_t *ret_device_identifier)
Parameter:
  • thermal_imaging – Typ: ThermalImaging *
Ausgabeparameter:
  • ret_uid – Typ: char[8]
  • ret_connected_uid – Typ: char[8]
  • ret_position – Typ: char, Wertebereich: ['a' bis 'h', 'i', 'z']
  • ret_hardware_version – Typ: uint8_t[3]
    • 0: major – Typ: uint8_t, Wertebereich: [0 bis 255]
    • 1: minor – Typ: uint8_t, Wertebereich: [0 bis 255]
    • 2: revision – Typ: uint8_t, Wertebereich: [0 bis 255]
  • ret_firmware_version – Typ: uint8_t[3]
    • 0: major – Typ: uint8_t, Wertebereich: [0 bis 255]
    • 1: minor – Typ: uint8_t, Wertebereich: [0 bis 255]
    • 2: revision – Typ: uint8_t, Wertebereich: [0 bis 255]
  • ret_device_identifier – Typ: uint16_t, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • error_code – Typ: int

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 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss) sein. Der Raspberry Pi HAT (Zero) Brick ist immer an Position 'i' und das Bricklet hinter einem Isolator Bricklet ist immer an Position 'z'.

Eine Liste der Device Identifier Werte ist hier zu finden. Es gibt auch eine Konstante für den Device Identifier dieses Bricklets.

Konfigurationsfunktionen für Callbacks

void thermal_imaging_register_callback(ThermalImaging *thermal_imaging, int16_t callback_id, void (*function)(void), void *user_data)
Parameter:
  • thermal_imaging – Typ: ThermalImaging *
  • callback_id – Typ: int16_t
  • function – Typ: void (*)(void)
  • user_data – Typ: void *

Registriert die function für die gegebene callback_id. Die user_data werden der Funktion als letztes Parameter mit übergeben.

Die verfügbaren Callback IDs mit den zugehörigen Funktionssignaturen sind unten zu finden.

int thermal_imaging_set_image_transfer_config(ThermalImaging *thermal_imaging, uint8_t config)
Parameter:
  • thermal_imaging – Typ: ThermalImaging *
  • config – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 0
Rückgabe:
  • error_code – Typ: int

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:

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

Für config:

  • THERMAL_IMAGING_IMAGE_TRANSFER_MANUAL_HIGH_CONTRAST_IMAGE = 0
  • THERMAL_IMAGING_IMAGE_TRANSFER_MANUAL_TEMPERATURE_IMAGE = 1
  • THERMAL_IMAGING_IMAGE_TRANSFER_CALLBACK_HIGH_CONTRAST_IMAGE = 2
  • THERMAL_IMAGING_IMAGE_TRANSFER_CALLBACK_TEMPERATURE_IMAGE = 3
int thermal_imaging_get_image_transfer_config(ThermalImaging *thermal_imaging, uint8_t *ret_config)
Parameter:
  • thermal_imaging – Typ: ThermalImaging *
Ausgabeparameter:
  • ret_config – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 0
Rückgabe:
  • error_code – Typ: int

Gibt die Image Transfer Konfiguration zurück, wie von thermal_imaging_set_image_transfer_config() gesetzt.

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

Für ret_config:

  • THERMAL_IMAGING_IMAGE_TRANSFER_MANUAL_HIGH_CONTRAST_IMAGE = 0
  • THERMAL_IMAGING_IMAGE_TRANSFER_MANUAL_TEMPERATURE_IMAGE = 1
  • THERMAL_IMAGING_IMAGE_TRANSFER_CALLBACK_HIGH_CONTRAST_IMAGE = 2
  • THERMAL_IMAGING_IMAGE_TRANSFER_CALLBACK_TEMPERATURE_IMAGE = 3

Callbacks

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann mit der thermal_imaging_register_callback() Funktion durchgeführt werden:

void my_callback(int value, void *user_data) {
    printf("Value: %d\n", value);
}

thermal_imaging_register_callback(&thermal_imaging,
                                  THERMAL_IMAGING_CALLBACK_EXAMPLE,
                                  (void (*)(void))my_callback,
                                  NULL);

Die verfügbaren Konstanten mit den zugehörigen Funktionssignaturen 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_CALLBACK_HIGH_CONTRAST_IMAGE
void callback(uint8_t *image, uint16_t image_length, void *user_data)
Callback-Parameter:
  • image – Typ: uint8_t[4800], Wertebereich: [0 bis 255]
  • image_length – Typ: uint16_t
  • user_data – Typ: void *

Dieser Callback wird für jedes neue High Contrast Image ausgelöst, wenn die Transfer Image Config für diesen Callback konfiguriert wurde (siehe thermal_imaging_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 NULL für image ausgelöst.

THERMAL_IMAGING_CALLBACK_TEMPERATURE_IMAGE
void callback(uint16_t *image, uint16_t image_length, void *user_data)
Callback-Parameter:
  • image – Typ: uint16_t[4800], Einheit: ? K, Wertebereich: [-1000 bis 1400]
  • image_length – Typ: uint16_t
  • user_data – Typ: void *

Dieser Callback wird für jedes neue Temperature Image ausgelöst, wenn die Transfer Image Config für diesen Callback konfiguriert wurde (siehe thermal_imaging_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 NULL für image ausgelöst.

Virtuelle Funktionen

Virtuelle Funktionen kommunizieren nicht mit dem Gerät selbst, sie arbeiten nur auf dem API Bindings Objekt. Dadurch können sie auch aufgerufen werden, ohne das das dazugehörige IP Connection Objekt verbunden ist.

int thermal_imaging_get_api_version(ThermalImaging *thermal_imaging, uint8_t ret_api_version[3])
Parameter:
  • thermal_imaging – Typ: ThermalImaging *
Ausgabeparameter:
  • ret_api_version – Typ: uint8_t[3]
    • 0: major – Typ: uint8_t, Wertebereich: [0 bis 255]
    • 1: minor – Typ: uint8_t, Wertebereich: [0 bis 255]
    • 2: revision – Typ: uint8_t, Wertebereich: [0 bis 255]
Rückgabe:
  • error_code – Typ: int

Gibt die Version der API Definition zurück, die diese API Bindings implementieren. Dies ist weder die Release-Version dieser API Bindings noch gibt es in irgendeiner Weise Auskunft über den oder das repräsentierte(n) Brick oder Bricklet.

int thermal_imaging_get_response_expected(ThermalImaging *thermal_imaging, uint8_t function_id, bool *ret_response_expected)
Parameter:
  • thermal_imaging – Typ: ThermalImaging *
  • function_id – Typ: uint8_t, Wertebereich: Siehe Konstanten
Ausgabeparameter:
  • ret_response_expected – Typ: bool
Rückgabe:
  • error_code – Typ: int

Gibt das Response-Expected-Flag für die Funktion mit der angegebenen Funktions IDs zurück. Es ist true falls für die Funktion beim Aufruf eine Antwort erwartet wird, false andernfalls.

Für Getter-Funktionen ist diese Flag immer gesetzt und kann nicht entfernt werden, da diese Funktionen immer eine Antwort senden. Für Konfigurationsfunktionen für Callbacks ist es standardmäßig gesetzt, kann aber entfernt werden mittels thermal_imaging_set_response_expected(). Für Setter-Funktionen ist es standardmäßig nicht gesetzt, kann aber gesetzt werden.

Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

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

Für function_id:

  • THERMAL_IMAGING_FUNCTION_SET_RESOLUTION = 4
  • THERMAL_IMAGING_FUNCTION_SET_SPOTMETER_CONFIG = 6
  • THERMAL_IMAGING_FUNCTION_SET_HIGH_CONTRAST_CONFIG = 8
  • THERMAL_IMAGING_FUNCTION_SET_IMAGE_TRANSFER_CONFIG = 10
  • THERMAL_IMAGING_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • THERMAL_IMAGING_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • THERMAL_IMAGING_FUNCTION_RESET = 243
  • THERMAL_IMAGING_FUNCTION_WRITE_UID = 248
int thermal_imaging_set_response_expected(ThermalImaging *thermal_imaging, uint8_t function_id, bool response_expected)
Parameter:
  • thermal_imaging – Typ: ThermalImaging *
  • function_id – Typ: uint8_t, Wertebereich: Siehe Konstanten
  • response_expected – Typ: bool
Rückgabe:
  • error_code – Typ: int

Ändert das Response-Expected-Flag für die Funktion mit der angegebenen Funktion IDs. Diese Flag kann nur für Setter-Funktionen (Standardwert: false) und Konfigurationsfunktionen für Callbacks (Standardwert: true) geändert werden. Für Getter-Funktionen ist das Flag immer gesetzt.

Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

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

Für function_id:

  • THERMAL_IMAGING_FUNCTION_SET_RESOLUTION = 4
  • THERMAL_IMAGING_FUNCTION_SET_SPOTMETER_CONFIG = 6
  • THERMAL_IMAGING_FUNCTION_SET_HIGH_CONTRAST_CONFIG = 8
  • THERMAL_IMAGING_FUNCTION_SET_IMAGE_TRANSFER_CONFIG = 10
  • THERMAL_IMAGING_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • THERMAL_IMAGING_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • THERMAL_IMAGING_FUNCTION_RESET = 243
  • THERMAL_IMAGING_FUNCTION_WRITE_UID = 248
int thermal_imaging_set_response_expected_all(ThermalImaging *thermal_imaging, bool response_expected)
Parameter:
  • thermal_imaging – Typ: ThermalImaging *
  • response_expected – Typ: bool
Rückgabe:
  • error_code – Typ: int

Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.

Konstanten

THERMAL_IMAGING_DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Thermal Imaging Bricklet zu identifizieren.

Die thermal_imaging_get_identity() Funktion und der IPCON_CALLBACK_ENUMERATE Callback der IP Connection haben ein device_identifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

THERMAL_IMAGING_DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Thermal Imaging Bricklet dar.