Software / API Bindings / C/C++ für Mikrocontroller / API Referenz und Beispiele / Bricklets / XMC1400 Breakout Bricklet

C/C++ für Mikrocontroller - XMC1400 Breakout Bricklet¶

Dies ist die Beschreibung der C/C++ für Mikrocontroller API Bindings für das XMC1400 Breakout Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des XMC1400 Breakout Bricklet sind in dessen Hardware Beschreibung zusammengefasst.

Eine Installationanleitung für die C/C++ für Mikrocontroller API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele¶

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Gpio¶

Download (example_gpio.c)

// 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_xmc1400_breakout.h"

void check(int rc, const char *msg);
void example_setup(TF_HAL *hal);
void example_loop(TF_HAL *hal);

static TF_XMC1400Breakout xb;

void example_setup(TF_HAL *hal) {
    // Create device object
    check(tf_xmc1400_breakout_create(&xb, NULL, hal), "create device object");

    // Set Port 1, Pin 0 alternating high/low for 5 times with 1s delay
    int i;
    for (i = 0; i < 5; ++i) {
        tf_hal_sleep_us(hal, 1000 * 1000);
        check(tf_xmc1400_breakout_set_gpio_config(&xb, 1, 0,
                                                  TF_XMC1400_BREAKOUT_GPIO_MODE_OUTPUT_PUSH_PULL,
                                                  0, false), "call set_gpio_config");
        tf_hal_sleep_us(hal, 1000 * 1000);
        check(tf_xmc1400_breakout_set_gpio_config(&xb, 1, 0,
                                                  TF_XMC1400_BREAKOUT_GPIO_MODE_OUTPUT_PUSH_PULL,
                                                  0, true), "call set_gpio_config");
    }
}

void example_loop(TF_HAL *hal) {
    // Poll for callbacks
    tf_hal_callback_tick(hal, 0);
}

API¶

Die meistens Funktionen der C/C++ Bindings für Mikrocontroller geben einen Fehlercode (e_code) zurück

Mögliche Fehlercodes sind:

TF_E_OK = 0
TF_E_TIMEOUT = -1
TF_E_INVALID_PARAMETER = -2
TF_E_NOT_SUPPORTED = -3
TF_E_UNKNOWN_ERROR_CODE = -4
TF_E_STREAM_OUT_OF_SYNC = -5
TF_E_INVALID_CHAR_IN_UID = -6
TF_E_UID_TOO_LONG = -7
TF_E_UID_OVERFLOW = -8
TF_E_TOO_MANY_DEVICES = -9
TF_E_DEVICE_NOT_FOUND = -10
TF_E_WRONG_DEVICE_TYPE = -11
TF_E_CALLBACK_EXEC = -12
TF_E_PORT_NOT_FOUND = -13

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

Grundfunktionen¶

int tf_xmc1400_breakout_create(TF_XMC1400Breakout *xmc1400_breakout, const char *uid, TF_HAL *hal)¶

Parameter:	xmc1400_breakout – Typ: TF_XMC1400Breakout * uid – Typ: const char * hal – Typ: TF_HAL *
Rückgabe:	e_code – Typ: int

Erzeugt ein Geräteobjekt xmc1400_breakout mit der optionalen eindeutigen Geräte ID oder dem Portnamen uid_or_port_name und fügt es dem HAL hal hinzu:

TF_XMC1400Breakout xmc1400_breakout;
tf_xmc1400_breakout_create(&xmc1400_breakout, NULL, &ipcon);

Im Normalfall kann uid_or_port_name auf NULL belassen werden. Für weitere Details siehe Abschnitt UID oder Port-Name.

int tf_xmc1400_breakout_destroy(TF_XMC1400Breakout *xmc1400_breakout)¶

Parameter:	xmc1400_breakout – Typ: TF_XMC1400Breakout *
Rückgabe:	e_code – Typ: int

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

int tf_xmc1400_breakout_set_gpio_config(TF_XMC1400Breakout *xmc1400_breakout, uint8_t port, uint8_t pin, uint8_t mode, uint8_t input_hysteresis, bool output_level)¶

Parameter:	xmc1400_breakout – Typ: TF_XMC1400Breakout * port – Typ: uint8_t, Wertebereich: [0 bis 4] pin – Typ: uint8_t, Wertebereich: ? mode – Typ: uint8_t, Wertebereich: Siehe Konstanten input_hysteresis – Typ: uint8_t, Wertebereich: Siehe Konstanten output_level – Typ: bool
Rückgabe:	e_code – Typ: int

Beispiel für eine Setter-Funktion. Die Werte werden direkt an die Funktion XMC_GPIO_Init übergeben. Siehe communication.c in der Firmware.

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

Für mode:

TF_XMC1400_BREAKOUT_GPIO_MODE_INPUT_TRISTATE = 0
TF_XMC1400_BREAKOUT_GPIO_MODE_INPUT_PULL_DOWN = 1
TF_XMC1400_BREAKOUT_GPIO_MODE_INPUT_PULL_UP = 2
TF_XMC1400_BREAKOUT_GPIO_MODE_INPUT_SAMPLING = 3
TF_XMC1400_BREAKOUT_GPIO_MODE_INPUT_INVERTED_TRISTATE = 4
TF_XMC1400_BREAKOUT_GPIO_MODE_INPUT_INVERTED_PULL_DOWN = 5
TF_XMC1400_BREAKOUT_GPIO_MODE_INPUT_INVERTED_PULL_UP = 6
TF_XMC1400_BREAKOUT_GPIO_MODE_INPUT_INVERTED_SAMPLING = 7
TF_XMC1400_BREAKOUT_GPIO_MODE_OUTPUT_PUSH_PULL = 8
TF_XMC1400_BREAKOUT_GPIO_MODE_OUTPUT_OPEN_DRAIN = 9

Für input_hysteresis:

TF_XMC1400_BREAKOUT_GPIO_INPUT_HYSTERESIS_STANDARD = 0
TF_XMC1400_BREAKOUT_GPIO_INPUT_HYSTERESIS_LARGE = 4

int tf_xmc1400_breakout_get_gpio_input(TF_XMC1400Breakout *xmc1400_breakout, uint8_t port, uint8_t pin, bool *ret_value)¶

Parameter:	xmc1400_breakout – Typ: TF_XMC1400Breakout * port – Typ: uint8_t, Wertebereich: [0 bis 4] pin – Typ: uint8_t, Wertebereich: ?
Ausgabeparameter:	ret_value – Typ: bool
Rückgabe:	e_code – Typ: int

Beispiel für eine Getter-Funktion. Gibt das Resultat eines XMC_GPIO_GetInput-Aufrufs für den gegebenen Port/Pin zurück.

int tf_xmc1400_breakout_set_adc_channel_config(TF_XMC1400Breakout *xmc1400_breakout, uint8_t channel, bool enable)¶

Parameter:	xmc1400_breakout – Typ: TF_XMC1400Breakout * channel – Typ: uint8_t, Wertebereich: [0 bis 7] enable – Typ: bool
Rückgabe:	e_code – Typ: int

Aktiviert einen ADC-Kanal für das ADC-Treiber Beispiel (adc.c/adc.h).

Es gibt 8 ADC-Kanäle und sie korrespondieren zu den folgenden Pinnen:

Kanal 0: P2_6
Kanal 1: P2_8
Kanal 2: P2_9
Kanal 3: P2_10
Kanal 4: P2_11
Kanal 5: P2_0
Kanal 6: P2_1
Kanal 7: P2_2

int tf_xmc1400_breakout_get_adc_channel_config(TF_XMC1400Breakout *xmc1400_breakout, uint8_t channel, bool *ret_enable)¶

Parameter:	xmc1400_breakout – Typ: TF_XMC1400Breakout * channel – Typ: uint8_t, Wertebereich: [0 bis 7]
Ausgabeparameter:	ret_enable – Typ: bool
Rückgabe:	e_code – Typ: int

Gibt die Konfiguration für den gegebenen Kanal zurück, wie von tf_xmc1400_breakout_set_adc_channel_config() gesetzt.

int tf_xmc1400_breakout_get_adc_channel_value(TF_XMC1400Breakout *xmc1400_breakout, uint8_t channel, uint16_t *ret_value)¶

Parameter:	xmc1400_breakout – Typ: TF_XMC1400Breakout * channel – Typ: uint8_t, Wertebereich: [0 bis 7]
Ausgabeparameter:	ret_value – Typ: uint16_t, Wertebereich: [0 bis 2¹² - 1]
Rückgabe:	e_code – Typ: int

Gibt den 12-Bit Wert für den gegebenen ADC-Kanal des ADC-Treiber-Beispiels zurück.

int tf_xmc1400_breakout_get_adc_values(TF_XMC1400Breakout *xmc1400_breakout, uint16_t ret_values[8])¶

Parameter:	xmc1400_breakout – Typ: TF_XMC1400Breakout *
Ausgabeparameter:	ret_values – Typ: uint16_t[8], Wertebereich: [0 bis 2¹² - 1]
Rückgabe:	e_code – Typ: int

Gibt die Werte aller 8 ADC-Kanäle des ADC-Treiber-Beispiels zurück.

Diese Beispiel-Funktion hat auch einen korrespondierenden Callback.

Siehe tf_xmc1400_breakout_set_adc_values_callback_configuration() und ADC Values Callback.

int tf_xmc1400_breakout_get_count(TF_XMC1400Breakout *xmc1400_breakout, uint32_t *ret_count)¶

Parameter:	xmc1400_breakout – Typ: TF_XMC1400Breakout *
Ausgabeparameter:	ret_count – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1]
Rückgabe:	e_code – Typ: int

Gibt den Wert des Beispiel-Zählers zurück (siehe example.c).

Diese Beispiel-Funktion nutzt die "add_callback_value_function"-Hilfsfunktion im Generator. Der Getter sowie der Callback und die Callback-Konfigurations-Funktionen werden automatisch für die API und die Firmware generiert.

Wenn der Wert periodisch benötigt wird, kann auch der Count Callback verwendet werden. Der Callback wird mit der Funktion tf_xmc1400_breakout_set_count_callback_configuration() konfiguriert.

Fortgeschrittene Funktionen¶

int tf_xmc1400_breakout_get_spitfp_error_count(TF_XMC1400Breakout *xmc1400_breakout, 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:	xmc1400_breakout – Typ: TF_XMC1400Breakout *
Ausgabeparameter:	ret_error_count_ack_checksum – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1] ret_error_count_message_checksum – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1] ret_error_count_frame – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1] ret_error_count_overflow – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1]
Rückgabe:	e_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 tf_xmc1400_breakout_set_status_led_config(TF_XMC1400Breakout *xmc1400_breakout, uint8_t config)¶

Parameter:	xmc1400_breakout – Typ: TF_XMC1400Breakout * config – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 3
Rückgabe:	e_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:

TF_XMC1400_BREAKOUT_STATUS_LED_CONFIG_OFF = 0
TF_XMC1400_BREAKOUT_STATUS_LED_CONFIG_ON = 1
TF_XMC1400_BREAKOUT_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
TF_XMC1400_BREAKOUT_STATUS_LED_CONFIG_SHOW_STATUS = 3

int tf_xmc1400_breakout_get_status_led_config(TF_XMC1400Breakout *xmc1400_breakout, uint8_t *ret_config)¶

Parameter:	xmc1400_breakout – Typ: TF_XMC1400Breakout *
Ausgabeparameter:	ret_config – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 3
Rückgabe:	e_code – Typ: int

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

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

Für ret_config:

TF_XMC1400_BREAKOUT_STATUS_LED_CONFIG_OFF = 0
TF_XMC1400_BREAKOUT_STATUS_LED_CONFIG_ON = 1
TF_XMC1400_BREAKOUT_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
TF_XMC1400_BREAKOUT_STATUS_LED_CONFIG_SHOW_STATUS = 3

int tf_xmc1400_breakout_get_chip_temperature(TF_XMC1400Breakout *xmc1400_breakout, int16_t *ret_temperature)¶

Parameter:	xmc1400_breakout – Typ: TF_XMC1400Breakout *
Ausgabeparameter:	ret_temperature – Typ: int16_t, Einheit: 1 °C, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1]
Rückgabe:	e_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 tf_xmc1400_breakout_reset(TF_XMC1400Breakout *xmc1400_breakout)¶

Parameter:	xmc1400_breakout – Typ: TF_XMC1400Breakout *
Rückgabe:	e_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 tf_xmc1400_breakout_get_identity(TF_XMC1400Breakout *xmc1400_breakout, 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:	xmc1400_breakout – Typ: TF_XMC1400Breakout *
Ausgabeparameter:	ret_uid – Typ: char[8] ret_connected_uid – Typ: char[8] ret_position – Typ: char, Wertebereich: ['a' bis 'h', '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 2¹⁶ - 1]
Rückgabe:	e_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 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.

Konfigurationsfunktionen für Callbacks¶

int tf_xmc1400_breakout_set_adc_values_callback_configuration(TF_XMC1400Breakout *xmc1400_breakout, uint32_t period, bool value_has_to_change)¶

Parameter:	xmc1400_breakout – Typ: TF_XMC1400Breakout * period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0 value_has_to_change – Typ: bool, Standardwert: false
Rückgabe:	e_code – Typ: int

Die Periode ist die Periode mit der der ADC Values 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.

int tf_xmc1400_breakout_get_adc_values_callback_configuration(TF_XMC1400Breakout *xmc1400_breakout, uint32_t *ret_period, bool *ret_value_has_to_change)¶

Parameter:	xmc1400_breakout – Typ: TF_XMC1400Breakout *
Ausgabeparameter:	ret_period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0 ret_value_has_to_change – Typ: bool, Standardwert: false
Rückgabe:	e_code – Typ: int

Gibt die Callback-Konfiguration zurück, wie mittels tf_xmc1400_breakout_set_adc_values_callback_configuration() gesetzt.

int tf_xmc1400_breakout_set_count_callback_configuration(TF_XMC1400Breakout *xmc1400_breakout, uint32_t period, bool value_has_to_change, char option, uint32_t min, uint32_t max)¶

Parameter:

Parameter:	xmc1400_breakout – Typ: TF_XMC1400Breakout * period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0 value_has_to_change – Typ: bool, Standardwert: false option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1], Standardwert: 0 max – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1], Standardwert: 0
Rückgabe:	e_code – Typ: int

xmc1400_breakout – Typ: TF_XMC1400Breakout *
period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0
value_has_to_change – Typ: bool, Standardwert: false
option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
min – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1], Standardwert: 0
max – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1], Standardwert: 0

Rückgabe:

e_code – Typ: int

Die Periode ist die Periode mit der der Count Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

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 Count 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_XMC1400_BREAKOUT_THRESHOLD_OPTION_OFF = 'x'
TF_XMC1400_BREAKOUT_THRESHOLD_OPTION_OUTSIDE = 'o'
TF_XMC1400_BREAKOUT_THRESHOLD_OPTION_INSIDE = 'i'
TF_XMC1400_BREAKOUT_THRESHOLD_OPTION_SMALLER = '<'
TF_XMC1400_BREAKOUT_THRESHOLD_OPTION_GREATER = '>'

int tf_xmc1400_breakout_get_count_callback_configuration(TF_XMC1400Breakout *xmc1400_breakout, uint32_t *ret_period, bool *ret_value_has_to_change, char *ret_option, uint32_t *ret_min, uint32_t *ret_max)¶

Parameter:	xmc1400_breakout – Typ: TF_XMC1400Breakout *
Ausgabeparameter:	ret_period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0 ret_value_has_to_change – Typ: bool, Standardwert: false ret_option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' ret_min – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1], Standardwert: 0 ret_max – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1], Standardwert: 0
Rückgabe:	e_code – Typ: int

Gibt die Callback-Konfiguration zurück, wie mittels tf_xmc1400_breakout_set_count_callback_configuration() gesetzt.

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

Für ret_option:

TF_XMC1400_BREAKOUT_THRESHOLD_OPTION_OFF = 'x'
TF_XMC1400_BREAKOUT_THRESHOLD_OPTION_OUTSIDE = 'o'
TF_XMC1400_BREAKOUT_THRESHOLD_OPTION_INSIDE = 'i'
TF_XMC1400_BREAKOUT_THRESHOLD_OPTION_SMALLER = '<'
TF_XMC1400_BREAKOUT_THRESHOLD_OPTION_GREATER = '>'

Callbacks¶

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann mit der entsprechenden tf_xmc1400_breakout_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_xmc1400_breakout_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.

int tf_xmc1400_breakout_register_adc_values_callback(TF_XMC1400Breakout *xmc1400_breakout, TF_XMC1400Breakout_ADCValuesHandler handler, void *user_data)¶

void handler(TF_XMC1400Breakout *xmc1400_breakout, uint16_t values[8], void *user_data)

Callback-Parameter:	xmc1400_breakout – Typ: TF_XMC1400Breakout * values – Typ: uint16_t[8], Wertebereich: [0 bis 2¹² - 1] user_data – Typ: void *

Dieser Callback wird periodisch ausgelöst abhängig von der mittels tf_xmc1400_breakout_set_adc_values_callback_configuration() gesetzten Konfiguration

Die Parameter sind der gleiche wie tf_xmc1400_breakout_get_adc_values().

int tf_xmc1400_breakout_register_count_callback(TF_XMC1400Breakout *xmc1400_breakout, TF_XMC1400Breakout_CountHandler handler, void *user_data)¶

void handler(TF_XMC1400Breakout *xmc1400_breakout, uint32_t count, void *user_data)

Callback-Parameter:	xmc1400_breakout – Typ: TF_XMC1400Breakout * count – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1] user_data – Typ: void *

Dieser Callback wird periodisch ausgelöst abhängig von der mittels tf_xmc1400_breakout_set_count_callback_configuration() gesetzten Konfiguration

Der Parameter ist der gleiche wie tf_xmc1400_breakout_get_count().

Virtuelle Funktionen¶

Virtuelle Funktionen kommunizieren nicht mit dem Gerät selbst, sie arbeiten nur auf dem API Bindings Objekt.

int tf_xmc1400_breakout_get_response_expected(TF_XMC1400Breakout *xmc1400_breakout, uint8_t function_id, bool *ret_response_expected)¶

Parameter:	xmc1400_breakout – Typ: TF_XMC1400Breakout * function_id – Typ: uint8_t, Wertebereich: Siehe Konstanten
Ausgabeparameter:	ret_response_expected – Typ: bool
Rückgabe:	e_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 tf_xmc1400_breakout_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_XMC1400_BREAKOUT_FUNCTION_SET_GPIO_CONFIG = 1
TF_XMC1400_BREAKOUT_FUNCTION_SET_ADC_CHANNEL_CONFIG = 3
TF_XMC1400_BREAKOUT_FUNCTION_SET_ADC_VALUES_CALLBACK_CONFIGURATION = 7
TF_XMC1400_BREAKOUT_FUNCTION_SET_COUNT_CALLBACK_CONFIGURATION = 11
TF_XMC1400_BREAKOUT_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
TF_XMC1400_BREAKOUT_FUNCTION_SET_STATUS_LED_CONFIG = 239
TF_XMC1400_BREAKOUT_FUNCTION_RESET = 243
TF_XMC1400_BREAKOUT_FUNCTION_WRITE_UID = 248

int tf_xmc1400_breakout_set_response_expected(TF_XMC1400Breakout *xmc1400_breakout, uint8_t function_id, bool response_expected)¶

Parameter:	xmc1400_breakout – Typ: TF_XMC1400Breakout * function_id – Typ: uint8_t, Wertebereich: Siehe Konstanten response_expected – Typ: bool
Rückgabe:	e_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.

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

Für function_id:

TF_XMC1400_BREAKOUT_FUNCTION_SET_GPIO_CONFIG = 1
TF_XMC1400_BREAKOUT_FUNCTION_SET_ADC_CHANNEL_CONFIG = 3
TF_XMC1400_BREAKOUT_FUNCTION_SET_ADC_VALUES_CALLBACK_CONFIGURATION = 7
TF_XMC1400_BREAKOUT_FUNCTION_SET_COUNT_CALLBACK_CONFIGURATION = 11
TF_XMC1400_BREAKOUT_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
TF_XMC1400_BREAKOUT_FUNCTION_SET_STATUS_LED_CONFIG = 239
TF_XMC1400_BREAKOUT_FUNCTION_RESET = 243
TF_XMC1400_BREAKOUT_FUNCTION_WRITE_UID = 248

int tf_xmc1400_breakout_set_response_expected_all(TF_XMC1400Breakout *xmc1400_breakout, bool response_expected)¶

Parameter:	xmc1400_breakout – Typ: TF_XMC1400Breakout * response_expected – Typ: bool
Rückgabe:	e_code – Typ: int

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

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.

int tf_xmc1400_breakout_set_bootloader_mode(TF_XMC1400Breakout *xmc1400_breakout, uint8_t mode, uint8_t *ret_status)¶

Parameter:	xmc1400_breakout – Typ: TF_XMC1400Breakout * mode – Typ: uint8_t, Wertebereich: Siehe Konstanten
Ausgabeparameter:	ret_status – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:	e_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:

TF_XMC1400_BREAKOUT_BOOTLOADER_MODE_BOOTLOADER = 0
TF_XMC1400_BREAKOUT_BOOTLOADER_MODE_FIRMWARE = 1
TF_XMC1400_BREAKOUT_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
TF_XMC1400_BREAKOUT_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
TF_XMC1400_BREAKOUT_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für ret_status:

TF_XMC1400_BREAKOUT_BOOTLOADER_STATUS_OK = 0
TF_XMC1400_BREAKOUT_BOOTLOADER_STATUS_INVALID_MODE = 1
TF_XMC1400_BREAKOUT_BOOTLOADER_STATUS_NO_CHANGE = 2
TF_XMC1400_BREAKOUT_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
TF_XMC1400_BREAKOUT_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
TF_XMC1400_BREAKOUT_BOOTLOADER_STATUS_CRC_MISMATCH = 5

int tf_xmc1400_breakout_get_bootloader_mode(TF_XMC1400Breakout *xmc1400_breakout, uint8_t *ret_mode)¶

Parameter:	xmc1400_breakout – Typ: TF_XMC1400Breakout *
Ausgabeparameter:	ret_mode – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:	e_code – Typ: int

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

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

Für ret_mode:

TF_XMC1400_BREAKOUT_BOOTLOADER_MODE_BOOTLOADER = 0
TF_XMC1400_BREAKOUT_BOOTLOADER_MODE_FIRMWARE = 1
TF_XMC1400_BREAKOUT_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
TF_XMC1400_BREAKOUT_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
TF_XMC1400_BREAKOUT_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

int tf_xmc1400_breakout_set_write_firmware_pointer(TF_XMC1400Breakout *xmc1400_breakout, uint32_t pointer)¶

Parameter:	xmc1400_breakout – Typ: TF_XMC1400Breakout * pointer – Typ: uint32_t, Einheit: 1 B, Wertebereich: [0 bis 2³² - 1]
Rückgabe:	e_code – Typ: int

Setzt den Firmware-Pointer für tf_xmc1400_breakout_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 tf_xmc1400_breakout_write_firmware(TF_XMC1400Breakout *xmc1400_breakout, const uint8_t data[64], uint8_t *ret_status)¶

Parameter:	xmc1400_breakout – Typ: TF_XMC1400Breakout * data – Typ: const uint8_t[64], Wertebereich: [0 bis 255]
Ausgabeparameter:	ret_status – Typ: uint8_t, Wertebereich: [0 bis 255]
Rückgabe:	e_code – Typ: int

Schreibt 64 Bytes Firmware an die Position die vorher von tf_xmc1400_breakout_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 tf_xmc1400_breakout_write_uid(TF_XMC1400Breakout *xmc1400_breakout, uint32_t uid)¶

Parameter:	xmc1400_breakout – Typ: TF_XMC1400Breakout * uid – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1]
Rückgabe:	e_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 tf_xmc1400_breakout_read_uid(TF_XMC1400Breakout *xmc1400_breakout, uint32_t *ret_uid)¶

Parameter:	xmc1400_breakout – Typ: TF_XMC1400Breakout *
Ausgabeparameter:	ret_uid – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1]
Rückgabe:	e_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.

Konstanten¶

TF_XMC1400_BREAKOUT_DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein XMC1400 Breakout Bricklet zu identifizieren.

Die Funktionen tf_xmc1400_breakout_get_identity() und tf_hal_get_device_info() haben einen device_identifier Ausgabe-Parameter um den Typ des Bricks oder Bricklets anzugeben.

TF_XMC1400_BREAKOUT_DEVICE_DISPLAY_NAME¶: Diese Konstante stellt den Anzeigenamen eines XMC1400 Breakout Bricklet dar.