MQTT - Thermal Imaging Bricklet¶

Callback¶

Download (example-callback.txt)

1
2
3
4
5
6
7
8
9

# Change XYZ to the UID of your Thermal Imaging Bricklet

setup:
    # Handle incoming high contrast image callbacks
    subscribe to tinkerforge/callback/thermal_imaging_bricklet/XYZ/high_contrast_image
    publish '{"register": true}' to tinkerforge/register/thermal_imaging_bricklet/XYZ/high_contrast_image # Register high_contrast_image callback

    # Enable high contrast image transfer for callback
    publish '{"config": "callback_high_contrast_image"}' to tinkerforge/request/thermal_imaging_bricklet/XYZ/set_image_transfer_config

Grundfunktionen¶

request/thermal_imaging_bricklet/<UID>/get_high_contrast_image¶

Anfrage:	keine Nutzdaten
Antwort:	image – Typ: [int, ...], Länge: 4800, 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 request/thermal_imaging_bricklet/<UID>/set_image_transfer_config aktiviert werden.

request/thermal_imaging_bricklet/<UID>/get_temperature_image¶

Anfrage:	keine Nutzdaten
Antwort:	image – Typ: [int, ...], Länge: 4800, Einheit: ? K, 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 request/thermal_imaging_bricklet/<UID>/set_resolution eingestellt wurde).

Bevor die Funktion genutzt werden kann muss diese mittels request/thermal_imaging_bricklet/<UID>/set_image_transfer_config aktiviert werden.

request/thermal_imaging_bricklet/<UID>/get_statistics¶

Anfrage:

keine Nutzdaten

Antwort:

spotmeter_statistics – Typ: [int, ...], Länge: 4 0: mean_temperature – Typ: int, Einheit: ? K, Wertebereich: [0 bis 216 - 1] 1: max_temperature – Typ: int, Einheit: ? K, Wertebereich: [0 bis 216 - 1] 2: min_temperature – Typ: int, Einheit: ? K, Wertebereich: [0 bis 216 - 1] 3: pixel_count – Typ: int, Wertebereich: [0 bis 4800] temperatures – Typ: [int, ...], Länge: 4 0: focal_plain_array – Typ: int, Einheit: ? K, Wertebereich: [0 bis 216 - 1] 1: focal_plain_array_last_ffc – Typ: int, Einheit: ? K, Wertebereich: [0 bis 216 - 1] 2: housing – Typ: int, Einheit: ? K, Wertebereich: [0 bis 216 - 1] 3: housing_last_ffc – Typ: int, Einheit: ? K, Wertebereich: [0 bis 216 - 1] resolution – Typ: int, Wertebereich: Siehe Symbole ffc_status – Typ: int, Wertebereich: Siehe Symbole temperature_warning – Typ: [bool, ...], Länge: 2 0: shutter_lockout – Typ: bool 1: overtemperature_shut_down_imminent – Typ: bool

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

Für resolution:

• "0_to_6553_kelvin" = 0
• "0_to_655_kelvin" = 1

Für ffc_status:

• "never_commanded" = 0
• "imminent" = 1
• "in_progress" = 2
• "complete" = 3

request/thermal_imaging_bricklet/<UID>/set_resolution¶

Anfrage:	resolution – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 1
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.

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

Für resolution:

• "0_to_6553_kelvin" = 0
• "0_to_655_kelvin" = 1

request/thermal_imaging_bricklet/<UID>/get_resolution¶

Anfrage:	keine Nutzdaten
Antwort:	resolution – Typ: int, Wertebereich: Siehe Symbole

Gibt die Auflösung zurück, wie von request/thermal_imaging_bricklet/<UID>/set_resolution gesetzt.

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

Für resolution:

• "0_to_6553_kelvin" = 0
• "0_to_655_kelvin" = 1

request/thermal_imaging_bricklet/<UID>/set_spotmeter_config¶

Anfrage:	region_of_interest – Typ: [int, ...], Länge: 4 0: first_column – Typ: int, Wertebereich: [0 bis 78], Standardwert: 39 1: first_row – Typ: int, Wertebereich: [0 bis 58], Standardwert: 29 2: last_column – Typ: int, Wertebereich: [1 bis 79], Standardwert: 40 3: last_row – Typ: int, Wertebereich: [1 bis 59], Standardwert: 30
Antwort:	keine Antwort

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 request/thermal_imaging_bricklet/<UID>/get_statistics ausgelesen werden.

request/thermal_imaging_bricklet/<UID>/get_spotmeter_config¶

Anfrage:	keine Nutzdaten
Antwort:	region_of_interest – Typ: [int, ...], Länge: 4 0: first_column – Typ: int, Wertebereich: [0 bis 78], Standardwert: 39 1: first_row – Typ: int, Wertebereich: [0 bis 58], Standardwert: 29 2: last_column – Typ: int, Wertebereich: [1 bis 79], Standardwert: 40 3: last_row – Typ: int, Wertebereich: [1 bis 59], Standardwert: 30

Gibt die Spotmeter Konfiguration zurück, wie von request/thermal_imaging_bricklet/<UID>/set_spotmeter_config gesetzt.

request/thermal_imaging_bricklet/<UID>/set_high_contrast_config¶

Anfrage:

region_of_interest – Typ: [int, ...], Länge: 4 0: first_column – Typ: int, Wertebereich: [0 bis 79], Standardwert: 0 1: first_row – Typ: int, Wertebereich: [0 bis 58], Standardwert: 0 2: last_column – Typ: int, Wertebereich: [0 bis 79], Standardwert: 79 3: last_row – Typ: int, Wertebereich: [1 bis 59], Standardwert: 59 dampening_factor – Typ: int, Wertebereich: [0 bis 256], Standardwert: 64 clip_limit – Typ: [int, ...], Länge: 2 0: agc_heq_clip_limit_high – Typ: int, Wertebereich: [0 bis 4800], Standardwert: 4800 1: agc_heq_clip_limit_low – Typ: int, Wertebereich: [0 bis 210], Standardwert: 29 empty_counts – Typ: int, Wertebereich: [0 bis 214 - 1], Standardwert: 2

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 request/thermal_imaging_bricklet/<UID>/set_image_transfer_config).

Die High Contrast Region of Interest besteht aus vier Werten:

• Index 0: Spaltenstart (muss kleiner als oder gleich dem 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).

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.

request/thermal_imaging_bricklet/<UID>/get_high_contrast_config¶

Anfrage:

keine Nutzdaten

Antwort:

region_of_interest – Typ: [int, ...], Länge: 4 0: first_column – Typ: int, Wertebereich: [0 bis 78], Standardwert: 0 1: first_row – Typ: int, Wertebereich: [0 bis 58], Standardwert: 0 2: last_column – Typ: int, Wertebereich: [1 bis 79], Standardwert: 79 3: last_row – Typ: int, Wertebereich: [1 bis 59], Standardwert: 59 dampening_factor – Typ: int, Wertebereich: [0 bis 256], Standardwert: 64 clip_limit – Typ: [int, ...], Länge: 2 0: agc_heq_clip_limit_high – Typ: int, Wertebereich: [0 bis 4800], Standardwert: 4800 1: agc_heq_clip_limit_low – Typ: int, Wertebereich: [0 bis 210], Standardwert: 29 empty_counts – Typ: int, Wertebereich: [0 bis 216 - 1], Standardwert: 2

Gibt die High Contrast Konfiguration zurück, wie von request/thermal_imaging_bricklet/<UID>/set_high_contrast_config gesetzt.

Fortgeschrittene Funktionen¶

request/thermal_imaging_bricklet/<UID>/set_flux_linear_parameters¶

Anfrage:

scene_emissivity – Typ: int, Einheit: 25/2048 %, Wertebereich: [82 bis 213], Standardwert: 213 temperature_background – Typ: int, Einheit: 1/100 K, Wertebereich: [0 bis 216 - 1], Standardwert: 29515 tau_window – Typ: int, Einheit: 25/2048 %, Wertebereich: [82 bis 213], Standardwert: 213 temperatur_window – Typ: int, Einheit: 1/100 K, Wertebereich: [0 bis 216 - 1], Standardwert: 29515 tau_atmosphere – Typ: int, Einheit: 25/2048 %, Wertebereich: [82 bis 213], Standardwert: 213 temperature_atmosphere – Typ: int, Einheit: 1/100 K, Wertebereich: [0 bis 216 - 1], Standardwert: 29515 reflection_window – Typ: int, Einheit: 25/2048 %, Wertebereich: [0 bis 213], Standardwert: 0 temperature_reflection – Typ: int, Einheit: 1/100 K, Wertebereich: [0 bis 216 - 1], Standardwert: 29515

Antwort:

keine Antwort

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

request/thermal_imaging_bricklet/<UID>/get_flux_linear_parameters¶

Anfrage:

keine Nutzdaten

Antwort:

scene_emissivity – Typ: int, Einheit: 25/2048 %, Wertebereich: [82 bis 213], Standardwert: 213 temperature_background – Typ: int, Einheit: 1/100 K, Wertebereich: [0 bis 216 - 1], Standardwert: 29515 tau_window – Typ: int, Einheit: 25/2048 %, Wertebereich: [82 bis 213], Standardwert: 213 temperatur_window – Typ: int, Einheit: 1/100 K, Wertebereich: [0 bis 216 - 1], Standardwert: 29515 tau_atmosphere – Typ: int, Einheit: 25/2048 %, Wertebereich: [82 bis 213], Standardwert: 213 temperature_atmosphere – Typ: int, Einheit: 1/100 K, Wertebereich: [0 bis 216 - 1], Standardwert: 29515 reflection_window – Typ: int, Einheit: 25/2048 %, Wertebereich: [0 bis 213], Standardwert: 0 temperature_reflection – Typ: int, Einheit: 1/100 K, Wertebereich: [0 bis 216 - 1], Standardwert: 29515

Gibt die Flux-Linear-Parameter zurück, wie von request/thermal_imaging_bricklet/<UID>/set_flux_linear_parameters gesetzt.

Neu in Version 2.0.5 (Plugin).

request/thermal_imaging_bricklet/<UID>/set_ffc_shutter_mode¶

Anfrage:

shutter_mode – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 1 temp_lockout_state – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 0 video_freeze_during_ffc – Typ: bool, Standardwert: true ffc_desired – Typ: bool, Standardwert: false elapsed_time_since_last_ffc – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0 desired_ffc_period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 300000 explicit_cmd_to_open – Typ: bool, Standardwert: false desired_ffc_temp_delta – Typ: int, Einheit: 1/100 K, Wertebereich: [0 bis 216 - 1], Standardwert: 300 imminent_delay – Typ: int, Wertebereich: [0 bis 216 - 1], Standardwert: 52

Antwort:

keine Antwort

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:

• "manual" = 0
• "auto" = 1
• "external" = 2

Für temp_lockout_state:

• "inactive" = 0
• "high" = 1
• "low" = 2

Neu in Version 2.0.6 (Plugin).

request/thermal_imaging_bricklet/<UID>/get_ffc_shutter_mode¶

Anfrage:

keine Nutzdaten

Antwort:

shutter_mode – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 1 temp_lockout_state – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 0 video_freeze_during_ffc – Typ: bool, Standardwert: true ffc_desired – Typ: bool, Standardwert: false elapsed_time_since_last_ffc – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0 desired_ffc_period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 300000 explicit_cmd_to_open – Typ: bool, Standardwert: false desired_ffc_temp_delta – Typ: int, Einheit: 1/100 K, Wertebereich: [0 bis 216 - 1], Standardwert: 300 imminent_delay – Typ: int, Wertebereich: [0 bis 216 - 1], Standardwert: 52

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:

• "manual" = 0
• "auto" = 1
• "external" = 2

Für temp_lockout_state:

• "inactive" = 0
• "high" = 1
• "low" = 2

Neu in Version 2.0.6 (Plugin).

request/thermal_imaging_bricklet/<UID>/run_ffc_normalization¶

Anfrage:	keine Nutzdaten
Antwort:	keine Antwort

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

request/thermal_imaging_bricklet/<UID>/get_spitfp_error_count¶

Anfrage:	keine Nutzdaten
Antwort:	error_count_ack_checksum – Typ: int, Wertebereich: [0 bis 232 - 1] error_count_message_checksum – Typ: int, Wertebereich: [0 bis 232 - 1] error_count_frame – Typ: int, Wertebereich: [0 bis 232 - 1] error_count_overflow – Typ: int, 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.

request/thermal_imaging_bricklet/<UID>/set_status_led_config¶

Anfrage:	config – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 3
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 Symbole sind für diese Funktion verfügbar:

Für config:

• "off" = 0
• "on" = 1
• "show_heartbeat" = 2
• "show_status" = 3

request/thermal_imaging_bricklet/<UID>/get_status_led_config¶

Anfrage:	keine Nutzdaten
Antwort:	config – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 3

Gibt die Konfiguration zurück, wie von request/thermal_imaging_bricklet/<UID>/set_status_led_config gesetzt.

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

Für config:

• "off" = 0
• "on" = 1
• "show_heartbeat" = 2
• "show_status" = 3

request/thermal_imaging_bricklet/<UID>/get_chip_temperature¶

Anfrage:	keine Nutzdaten
Antwort:	temperature – Typ: int, Einheit: 1 °C, Wertebereich: [-215 bis 215 - 1]

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.

request/thermal_imaging_bricklet/<UID>/reset¶

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.

request/thermal_imaging_bricklet/<UID>/get_identity¶

Anfrage:

keine Nutzdaten

Antwort:

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, ...], 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, ...], 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] _display_name – Typ: string

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. Falls die symbolische Ausgabe nicht deaktiviert wurde, wird der Device Identifier auf den entsprechenden Namen im Format, welches die Topics verwenden, abgebildet.

Der Display Name enthält den Anzeigenamen des Thermal Imaging.

Konfigurationsfunktionen für Callbacks¶

request/thermal_imaging_bricklet/<UID>/set_image_transfer_config¶

Anfrage:	config – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 0
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:

• Manual High Contrast Image: request/thermal_imaging_bricklet/<UID>/get_high_contrast_image.
• Manual Temperature Image: request/thermal_imaging_bricklet/<UID>/get_temperature_image.
• Callback High Contrast Image: register/thermal_imaging_bricklet/<UID>/high_contrast_image callback.
• Callback Temperature Image: register/thermal_imaging_bricklet/<UID>/temperature_image callback.

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

Für config:

• "manual_high_contrast_image" = 0
• "manual_temperature_image" = 1
• "callback_high_contrast_image" = 2
• "callback_temperature_image" = 3

request/thermal_imaging_bricklet/<UID>/get_image_transfer_config¶

Anfrage:	keine Nutzdaten
Antwort:	config – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 0

Gibt die Image Transfer Konfiguration zurück, wie von request/thermal_imaging_bricklet/<UID>/set_image_transfer_config gesetzt.

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

Für config:

• "manual_high_contrast_image" = 0
• "manual_temperature_image" = 1
• "callback_high_contrast_image" = 2
• "callback_temperature_image" = 3

Callbacks¶

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann mit dem entsprechenden .../register/...-Topic und einem optionalen Suffix durchgeführt werden. Mit diesem Suffix kann das Callback später deregistriert werden.

register/thermal_imaging_bricklet/<UID>/high_contrast_image¶

Registrierungsanfrage:	register – Typ: bool
Callback-Antwort:	image – Typ: [int, ...], Länge: 4800, Wertebereich: [0 bis 255]

Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/thermal_imaging_bricklet/<UID>/high_contrast_image[/<SUFFIX>]-Topic hinzugefügt werden. Ein hinzugefügtes Callback kann durch Senden des Payloads "false" an das selbe Topic wieder entfernt werden. Um mehrere (De-)Registrierungen zu unterstützen, z.B. um Nachrichten filtern zu können, kann ein optionaler Suffix verwendet werden.

Wenn das Callback ausgelöst wird, wird dessen Payload für jeden Suffix auf dem entsprechenden .../callback/thermal_imaging_bricklet/<UID>/high_contrast_image[/<SUFFIX>]-Topic veröffentlicht.

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

register/thermal_imaging_bricklet/<UID>/temperature_image¶

Registrierungsanfrage:	register – Typ: bool
Callback-Antwort:	image – Typ: [int, ...], Länge: 4800, Einheit: ? K, Wertebereich: [0 bis 216 - 1]

Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/thermal_imaging_bricklet/<UID>/temperature_image[/<SUFFIX>]-Topic hinzugefügt werden. Ein hinzugefügtes Callback kann durch Senden des Payloads "false" an das selbe Topic wieder entfernt werden. Um mehrere (De-)Registrierungen zu unterstützen, z.B. um Nachrichten filtern zu können, kann ein optionaler Suffix verwendet werden.

Wenn das Callback ausgelöst wird, wird dessen Payload für jeden Suffix auf dem entsprechenden .../callback/thermal_imaging_bricklet/<UID>/temperature_image[/<SUFFIX>]-Topic veröffentlicht.

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

Interne Funktionen¶

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.

request/thermal_imaging_bricklet/<UID>/set_bootloader_mode¶

Anfrage:	mode – Typ: int, Wertebereich: Siehe Symbole
Antwort:	status – Typ: int, Wertebereich: Siehe 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 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:

• "bootloader" = 0
• "firmware" = 1
• "bootloader_wait_for_reboot" = 2
• "firmware_wait_for_reboot" = 3
• "firmware_wait_for_erase_and_reboot" = 4

Für status:

• "ok" = 0
• "invalid_mode" = 1
• "no_change" = 2
• "entry_function_not_present" = 3
• "device_identifier_incorrect" = 4
• "crc_mismatch" = 5

request/thermal_imaging_bricklet/<UID>/get_bootloader_mode¶

Anfrage:	keine Nutzdaten
Antwort:	mode – Typ: int, Wertebereich: Siehe Symbole

Gibt den aktuellen Bootloader-Modus zurück, siehe request/thermal_imaging_bricklet/<UID>/set_bootloader_mode.

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

Für mode:

• "bootloader" = 0
• "firmware" = 1
• "bootloader_wait_for_reboot" = 2
• "firmware_wait_for_reboot" = 3
• "firmware_wait_for_erase_and_reboot" = 4

request/thermal_imaging_bricklet/<UID>/set_write_firmware_pointer¶

Anfrage:	pointer – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]
Antwort:	keine Antwort

Setzt den Firmware-Pointer für request/thermal_imaging_bricklet/<UID>/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.

request/thermal_imaging_bricklet/<UID>/write_firmware¶

Anfrage:	data – Typ: [int, ...], Länge: 64, Wertebereich: [0 bis 255]
Antwort:	status – Typ: int, Wertebereich: [0 bis 255]

Schreibt 64 Bytes Firmware an die Position die vorher von request/thermal_imaging_bricklet/<UID>/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.

request/thermal_imaging_bricklet/<UID>/write_uid¶

Anfrage:	uid – Typ: int, 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.

request/thermal_imaging_bricklet/<UID>/read_uid¶

Anfrage:	keine Nutzdaten
Antwort:	uid – Typ: int, 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.