Dies ist die Beschreibung der C/C++ für Mikrocontroller API Bindings für das Distance IR Bricklet 2.0. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Distance IR Bricklet 2.0 sind in dessen Hardware Beschreibung zusammengefasst.
Eine Installationanleitung für die C/C++ für Mikrocontroller API Bindings ist Teil deren allgemeine Beschreibung.
Der folgende Beispielcode ist Public Domain (CC0 1.0).
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 | // This example is not self-contained.
// It requires usage of the example driver specific to your platform.
// See the HAL documentation.
#include "src/bindings/hal_common.h"
#include "src/bindings/bricklet_distance_ir_v2.h"
void check(int rc, const char *msg);
void example_setup(TF_HAL *hal);
void example_loop(TF_HAL *hal);
static TF_DistanceIRV2 dir;
void example_setup(TF_HAL *hal) {
// Create device object
check(tf_distance_ir_v2_create(&dir, NULL, hal), "create device object");
// Get current distance
uint16_t distance;
check(tf_distance_ir_v2_get_distance(&dir, &distance), "get distance");
tf_hal_printf("Distance: %d 1/%d cm\n", distance, 10);
}
void example_loop(TF_HAL *hal) {
// Poll for callbacks
tf_hal_callback_tick(hal, 0);
}
|
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 | // This example is not self-contained.
// It requires usage of the example driver specific to your platform.
// See the HAL documentation.
#include "src/bindings/hal_common.h"
#include "src/bindings/bricklet_distance_ir_v2.h"
void check(int rc, const char *msg);
void example_setup(TF_HAL *hal);
void example_loop(TF_HAL *hal);
// Callback function for distance callback
static void distance_handler(TF_DistanceIRV2 *device, uint16_t distance,
void *user_data) {
(void)device; (void)user_data; // avoid unused parameter warning
tf_hal_printf("Distance: %d 1/%d cm\n", distance, 10);
}
static TF_DistanceIRV2 dir;
void example_setup(TF_HAL *hal) {
// Create device object
check(tf_distance_ir_v2_create(&dir, NULL, hal), "create device object");
// Register distance callback to function distance_handler
tf_distance_ir_v2_register_distance_callback(&dir,
distance_handler,
NULL);
// Set period for distance callback to 1s (1000ms) without a threshold
tf_distance_ir_v2_set_distance_callback_configuration(&dir, 1000, false, 'x', 0, 0);
}
void example_loop(TF_HAL *hal) {
// Poll for callbacks
tf_hal_callback_tick(hal, 0);
}
|
Download (example_threshold.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 | // This example is not self-contained.
// It requires usage of the example driver specific to your platform.
// See the HAL documentation.
#include "src/bindings/hal_common.h"
#include "src/bindings/bricklet_distance_ir_v2.h"
void check(int rc, const char *msg);
void example_setup(TF_HAL *hal);
void example_loop(TF_HAL *hal);
// Callback function for distance callback
static void distance_handler(TF_DistanceIRV2 *device, uint16_t distance,
void *user_data) {
(void)device; (void)user_data; // avoid unused parameter warning
tf_hal_printf("Distance: %d 1/%d cm\n", distance, 10);
}
static TF_DistanceIRV2 dir;
void example_setup(TF_HAL *hal) {
// Create device object
check(tf_distance_ir_v2_create(&dir, NULL, hal), "create device object");
// Register distance callback to function distance_handler
tf_distance_ir_v2_register_distance_callback(&dir,
distance_handler,
NULL);
// Configure threshold for distance "smaller than 30 cm"
// with a debounce period of 1s (1000ms)
tf_distance_ir_v2_set_distance_callback_configuration(&dir, 1000, false, '<', 30*10, 0);
}
void example_loop(TF_HAL *hal) {
// Poll for callbacks
tf_hal_callback_tick(hal, 0);
}
|
Die meistens Funktionen der C/C++ Bindings für Mikrocontroller geben einen
Fehlercode (e_code
) zurück
Mögliche Fehlercodes sind:
(wie in errors.h
definiert), sowie die Fehlercodes des verwendeten
Hardware-Abstraction-Layers (HALs). Mit tf_hal_strerror
(im Header das HALs definiert)
kann ein Fehlerstring zu einem Fehlercode abgefragt werden.
Vom Gerät zurückgegebene Daten werden, wenn eine
Abfrage aufgerufen wurde, über Ausgabeparameter gehandhabt. Diese Parameter
sind mit dem ret_
Präfix gekennzeichnet. Die Bindings schreiben einen
Ausgabeparameter nicht, wenn NULL bzw. nullptr übergeben wird. So können
uninteressante Ausgaben ignoriert werden.
Keine der folgend aufgelisteten Funktionen ist Thread-sicher. Details finden sich in der Beschreibung der API-Bindings.
tf_distance_ir_v2_create
(TF_DistanceIRV2 *distance_ir_v2, const char *uid, TF_HAL *hal)¶Parameter: |
|
---|---|
Rückgabe: |
|
Erzeugt ein Geräteobjekt distance_ir_v2
mit der optionalen eindeutigen Geräte ID oder
dem Portnamen uid_or_port_name
und fügt es dem HAL hal
hinzu:
TF_DistanceIRV2 distance_ir_v2;
tf_distance_ir_v2_create(&distance_ir_v2, NULL, &ipcon);
Im Normalfall kann uid_or_port_name
auf NULL
belassen werden. Für weitere
Details siehe Abschnitt UID oder Port-Name.
tf_distance_ir_v2_destroy
(TF_DistanceIRV2 *distance_ir_v2)¶Parameter: |
|
---|---|
Rückgabe: |
|
Entfernt das Geräteobjekt distance_ir_v2
von dessen HAL und zerstört es.
Das Geräteobjekt kann hiernach nicht mehr verwendet werden.
tf_distance_ir_v2_get_distance
(TF_DistanceIRV2 *distance_ir_v2, uint16_t *ret_distance)¶Parameter: |
|
---|---|
Ausgabeparameter: |
|
Rückgabe: |
|
Gibt die gemessene Entfernung des Sensors zurück. Die möglichen Entfernungsbereiche sind 40 bis 300, 100 bis 800 und 200 bis 1500, in Abhängigkeit vom gewählten IR Sensor.
Wenn der Wert periodisch benötigt wird, kann auch der Distance
Callback
verwendet werden. Der Callback wird mit der Funktion
tf_distance_ir_v2_set_distance_callback_configuration()
konfiguriert.
tf_distance_ir_v2_get_analog_value
(TF_DistanceIRV2 *distance_ir_v2, uint32_t *ret_analog_value)¶Parameter: |
|
---|---|
Ausgabeparameter: |
|
Rückgabe: |
|
Gibt den Analogwert des Analog/Digital-Wandler zurück.
Dieser Wert ist ein unverarbeiteter Rohwert. Wir haben sichergestellt, dass die Integrationszeit des ADCs kleiner ist als das Messintervall des Sensors (10ms vs 16,5ms). Dadurch ist sichergestellt das keine Informationen verloren gehen können.
Der Analogwert kann genutzt werden wenn eine eigene Kalibrierung oder Lookup-Tabelle benötigt wird.
Wenn der Wert periodisch benötigt wird, kann auch der Analog Value
Callback
verwendet werden. Der Callback wird mit der Funktion
tf_distance_ir_v2_set_analog_value_callback_configuration()
konfiguriert.
tf_distance_ir_v2_set_moving_average_configuration
(TF_DistanceIRV2 *distance_ir_v2, uint16_t moving_average_length)¶Parameter: |
|
---|---|
Rückgabe: |
|
Setzt die Länge eines gleitenden Mittelwerts für die Distanz.
Wenn die Länge auf 1 gesetzt wird, ist die Mittelwertbildung deaktiviert. Je kürzer die Länge des Mittelwerts ist, desto mehr Rauschen ist auf den Daten.
Einer neue Wert wird alle ~10ms gemessen. Mit einer Mittelwerts-Länge von 1000 hat das resultierende gleitende Fenster eine Zeitspanne von ca. 10s. Bei Langzeitmessungen gibt ein langer Mittelwert die saubersten Resultate.
tf_distance_ir_v2_get_moving_average_configuration
(TF_DistanceIRV2 *distance_ir_v2, uint16_t *ret_moving_average_length)¶Parameter: |
|
---|---|
Ausgabeparameter: |
|
Rückgabe: |
|
Gibt die Moving Average-Konfiguration zurück, wie von tf_distance_ir_v2_set_moving_average_configuration()
gesetzt.
tf_distance_ir_v2_set_distance_led_config
(TF_DistanceIRV2 *distance_ir_v2, uint8_t config)¶Parameter: |
|
---|---|
Rückgabe: |
|
Konfiguriert die Distanz-LED. Die LED kann ausgeschaltet, eingeschaltet, im Herzschlagmodus betrieben werden. Zusätzlich gibt es die Option mit der LED die Distanz anzuzeigen (heller = Objekt näher).
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für config:
tf_distance_ir_v2_get_distance_led_config
(TF_DistanceIRV2 *distance_ir_v2, uint8_t *ret_config)¶Parameter: |
|
---|---|
Ausgabeparameter: |
|
Rückgabe: |
|
Gibt die LED-Konfiguration zurück, wie von tf_distance_ir_v2_set_distance_led_config()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für ret_config:
tf_distance_ir_v2_set_sensor_type
(TF_DistanceIRV2 *distance_ir_v2, uint8_t sensor)¶Parameter: |
|
---|---|
Rückgabe: |
|
Setzt den Sensor-Typ.
Das Bricklet kommt vorkonfiguriert mit dem korrektem Sensor und der Sensor-Typ wird im Flash gespeichert (d.h. das Bricklet behält die Einstellung auch wenn es vom Strom getrennt wird).
Die Einstellung kann im Brick Viewer vorgenommen werden. Diese Funktion sollte in einem externen Programm also nicht ausgeführt werden müssen.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für sensor:
tf_distance_ir_v2_get_sensor_type
(TF_DistanceIRV2 *distance_ir_v2, uint8_t *ret_sensor)¶Parameter: |
|
---|---|
Ausgabeparameter: |
|
Rückgabe: |
|
Gibt den Sensor-Typ zurück, wie von tf_distance_ir_v2_set_sensor_type()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für ret_sensor:
tf_distance_ir_v2_get_spitfp_error_count
(TF_DistanceIRV2 *distance_ir_v2, 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: |
|
---|---|
Ausgabeparameter: |
|
Rückgabe: |
|
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.
tf_distance_ir_v2_set_status_led_config
(TF_DistanceIRV2 *distance_ir_v2, uint8_t config)¶Parameter: |
|
---|---|
Rückgabe: |
|
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:
tf_distance_ir_v2_get_status_led_config
(TF_DistanceIRV2 *distance_ir_v2, uint8_t *ret_config)¶Parameter: |
|
---|---|
Ausgabeparameter: |
|
Rückgabe: |
|
Gibt die Konfiguration zurück, wie von tf_distance_ir_v2_set_status_led_config()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für ret_config:
tf_distance_ir_v2_get_chip_temperature
(TF_DistanceIRV2 *distance_ir_v2, int16_t *ret_temperature)¶Parameter: |
|
---|---|
Ausgabeparameter: |
|
Rückgabe: |
|
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.
tf_distance_ir_v2_reset
(TF_DistanceIRV2 *distance_ir_v2)¶Parameter: |
|
---|---|
Rückgabe: |
|
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.
tf_distance_ir_v2_get_identity
(TF_DistanceIRV2 *distance_ir_v2, 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: |
|
---|---|
Ausgabeparameter: |
|
Rückgabe: |
|
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. Es gibt auch eine Konstante für den Device Identifier dieses Bricklets.
tf_distance_ir_v2_set_distance_callback_configuration
(TF_DistanceIRV2 *distance_ir_v2, uint32_t period, bool value_has_to_change, char option, uint16_t min, uint16_t max)¶Parameter: |
|
---|---|
Rückgabe: |
|
Die Periode ist die Periode mit der der Distance
Callback ausgelöst wird. Ein Wert von 0
schaltet den Callback ab.
Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.
Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.
Desweiteren ist es möglich den Callback mittels Thresholds einzuschränken.
Der option-Parameter zusammen mit min/max setzt einen Threshold für den Distance
Callback.
Die folgenden Optionen sind möglich:
Option | Beschreibung |
---|---|
'x' | Threshold ist abgeschaltet |
'o' | Threshold wird ausgelöst, wenn der Wert außerhalb der Min und Max Werte sind |
'i' | Threshold wird ausgelöst, wenn der Wert innerhalb der Min und Max Werte sind |
'<' | Threshold wird ausgelöst, wenn der Wert kleiner ist wie der Min Wert (Max wird ignoriert) |
'>' | Threshold wird ausgelöst, wenn der Wert größer ist wie der Max Wert (Min wird ignoriert) |
Wird die Option auf 'x' gesetzt (Threshold abgeschaltet), so wird der Callback mit der festen Periode ausgelöst.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
tf_distance_ir_v2_get_distance_callback_configuration
(TF_DistanceIRV2 *distance_ir_v2, uint32_t *ret_period, bool *ret_value_has_to_change, char *ret_option, uint16_t *ret_min, uint16_t *ret_max)¶Parameter: |
|
---|---|
Ausgabeparameter: |
|
Rückgabe: |
|
Gibt die Callback-Konfiguration zurück, wie mittels tf_distance_ir_v2_set_distance_callback_configuration()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für ret_option:
tf_distance_ir_v2_set_analog_value_callback_configuration
(TF_DistanceIRV2 *distance_ir_v2, uint32_t period, bool value_has_to_change, char option, uint32_t min, uint32_t max)¶Parameter: |
|
---|---|
Rückgabe: |
|
Die Periode ist die Periode mit der der Analog Value
Callback ausgelöst wird. Ein Wert von 0
schaltet den Callback ab.
Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.
Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.
Desweiteren ist es möglich den Callback mittels Thresholds einzuschränken.
Der option-Parameter zusammen mit min/max setzt einen Threshold für den Analog Value
Callback.
Die folgenden Optionen sind möglich:
Option | Beschreibung |
---|---|
'x' | Threshold ist abgeschaltet |
'o' | Threshold wird ausgelöst, wenn der Wert außerhalb der Min und Max Werte sind |
'i' | Threshold wird ausgelöst, wenn der Wert innerhalb der Min und Max Werte sind |
'<' | Threshold wird ausgelöst, wenn der Wert kleiner ist wie der Min Wert (Max wird ignoriert) |
'>' | Threshold wird ausgelöst, wenn der Wert größer ist wie der Max Wert (Min wird ignoriert) |
Wird die Option auf 'x' gesetzt (Threshold abgeschaltet), so wird der Callback mit der festen Periode ausgelöst.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
tf_distance_ir_v2_get_analog_value_callback_configuration
(TF_DistanceIRV2 *distance_ir_v2, uint32_t *ret_period, bool *ret_value_has_to_change, char *ret_option, uint32_t *ret_min, uint32_t *ret_max)¶Parameter: |
|
---|---|
Ausgabeparameter: |
|
Rückgabe: |
|
Gibt die Callback-Konfiguration zurück, wie mittels tf_distance_ir_v2_set_analog_value_callback_configuration()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für ret_option:
Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten
vom Gerät zu erhalten. Die Registrierung kann mit der entsprechenden tf_distance_ir_v2_register_*_callback
Funktion durchgeführt werden. Die user_data
, sowie das Gerät, dass das Callback ausgelöst hat, werden
dem registrierten Callback-Handler übergeben.
Nur ein Handler kann gleichzeitig auf das selbe Callback registriert werden.
Um einen Handler zu deregistrieren, kann die tf_distance_ir_v2_register_*_callback
-Funktion
mit NULL
als Handler aufgerufen werden.
Bemerkung
Callbacks für wiederkehrende Ereignisse zu verwenden ist gegenüber der Verwendung von Abfragen zu bevorzugen. Es muss nur ein Byte abgefragt werden um zu prüfen ob ein Callback vorliegt. Siehe hier Performanceoptimierungen.
Warnung
Aus Callback-Handlern heraus können keine Bindings-Funktionen verwendet werden. Siehe hier Callbacks.
tf_distance_ir_v2_register_distance_callback
(TF_DistanceIRV2 *distance_ir_v2, TF_DistanceIRV2_DistanceHandler handler, void *user_data)¶void handler(TF_DistanceIRV2 *distance_ir_v2, uint16_t distance, void *user_data)
Callback-Parameter: |
|
---|
Dieser Callback wird periodisch ausgelöst abhängig von der mittels
tf_distance_ir_v2_set_distance_callback_configuration()
gesetzten Konfiguration
Der Parameter ist der gleiche wie tf_distance_ir_v2_get_distance()
.
tf_distance_ir_v2_register_analog_value_callback
(TF_DistanceIRV2 *distance_ir_v2, TF_DistanceIRV2_AnalogValueHandler handler, void *user_data)¶void handler(TF_DistanceIRV2 *distance_ir_v2, uint32_t analog_value, void *user_data)
Callback-Parameter: |
|
---|
Dieser Callback wird periodisch ausgelöst abhängig von der mittels
tf_distance_ir_v2_set_analog_value_callback_configuration()
gesetzten Konfiguration
Der Parameter ist der gleiche wie tf_distance_ir_v2_get_analog_value()
.
Virtuelle Funktionen kommunizieren nicht mit dem Gerät selbst, sie arbeiten nur auf dem API Bindings Objekt.
tf_distance_ir_v2_get_response_expected
(TF_DistanceIRV2 *distance_ir_v2, uint8_t function_id, bool *ret_response_expected)¶Parameter: |
|
---|---|
Ausgabeparameter: |
|
Rückgabe: |
|
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 tf_distance_ir_v2_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:
tf_distance_ir_v2_set_response_expected
(TF_DistanceIRV2 *distance_ir_v2, uint8_t function_id, bool response_expected)¶Parameter: |
|
---|---|
Rückgabe: |
|
Ä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:
tf_distance_ir_v2_set_response_expected_all
(TF_DistanceIRV2 *distance_ir_v2, bool response_expected)¶Parameter: |
|
---|---|
Rückgabe: |
|
Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.
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.
tf_distance_ir_v2_set_bootloader_mode
(TF_DistanceIRV2 *distance_ir_v2, uint8_t mode, uint8_t *ret_status)¶Parameter: |
|
---|---|
Ausgabeparameter: |
|
Rückgabe: |
|
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:
Für ret_status:
tf_distance_ir_v2_get_bootloader_mode
(TF_DistanceIRV2 *distance_ir_v2, uint8_t *ret_mode)¶Parameter: |
|
---|---|
Ausgabeparameter: |
|
Rückgabe: |
|
Gibt den aktuellen Bootloader-Modus zurück, siehe tf_distance_ir_v2_set_bootloader_mode()
.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für ret_mode:
tf_distance_ir_v2_set_write_firmware_pointer
(TF_DistanceIRV2 *distance_ir_v2, uint32_t pointer)¶Parameter: |
|
---|---|
Rückgabe: |
|
Setzt den Firmware-Pointer für tf_distance_ir_v2_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.
tf_distance_ir_v2_write_firmware
(TF_DistanceIRV2 *distance_ir_v2, const uint8_t data[64], uint8_t *ret_status)¶Parameter: |
|
---|---|
Ausgabeparameter: |
|
Rückgabe: |
|
Schreibt 64 Bytes Firmware an die Position die vorher von
tf_distance_ir_v2_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.
tf_distance_ir_v2_write_uid
(TF_DistanceIRV2 *distance_ir_v2, uint32_t uid)¶Parameter: |
|
---|---|
Rückgabe: |
|
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.
tf_distance_ir_v2_read_uid
(TF_DistanceIRV2 *distance_ir_v2, uint32_t *ret_uid)¶Parameter: |
|
---|---|
Ausgabeparameter: |
|
Rückgabe: |
|
Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.
TF_DISTANCE_IR_V2_DEVICE_IDENTIFIER
¶Diese Konstante wird verwendet um ein Distance IR Bricklet 2.0 zu identifizieren.
Die Funktionen tf_distance_ir_v2_get_identity()
und tf_hal_get_device_info()
haben einen device_identifier
Ausgabe-Parameter um den Typ
des Bricks oder Bricklets anzugeben.
TF_DISTANCE_IR_V2_DEVICE_DISPLAY_NAME
¶Diese Konstante stellt den Anzeigenamen eines Distance IR Bricklet 2.0 dar.