Software / API Bindings / C/C++ / API Referenz und Beispiele / Bricklets / XMC1400 Breakout Bricklet

C/C++ - XMC1400 Breakout Bricklet¶

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

Beispiele¶

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Gpio¶

Download (example_gpio.c)

#define IPCON_EXPOSE_MILLISLEEP

#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_xmc1400_breakout.h"

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

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

    // Create device object
    XMC1400Breakout xb;
    xmc1400_breakout_create(&xb, 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

    // Set Port 1, Pin 0 alternating high/low for 5 times with 1s delay
    int i;
    for(i = 0; i < 5; ++i) {
        millisleep(1000);
        xmc1400_breakout_set_gpio_config(&xb, 1, 0,
                                         XMC1400_BREAKOUT_GPIO_MODE_OUTPUT_PUSH_PULL, 0,
                                         false);
        millisleep(1000);
        xmc1400_breakout_set_gpio_config(&xb, 1, 0,
                                         XMC1400_BREAKOUT_GPIO_MODE_OUTPUT_PUSH_PULL, 0,
                                         true);
    }

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

API¶

Die meistens Funktionen der C/C++ Bindings geben einen Fehlercode (e_code) zurück. 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 (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
E_WRONG_DEVICE_TYPE = -15
E_DEVICE_REPLACED = -16
E_WRONG_RESPONSE_LENGTH = -17

wie in ip_connection.h definiert.

Alle folgend aufgelisteten Funktionen sind Thread-sicher.

Grundfunktionen¶

void xmc1400_breakout_create(XMC1400Breakout *xmc1400_breakout, const char *uid, IPConnection *ipcon)¶

Parameter:	xmc1400_breakout – Typ: XMC1400Breakout * uid – Typ: const char * ipcon – Typ: IPConnection *

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

XMC1400Breakout xmc1400_breakout;
xmc1400_breakout_create(&xmc1400_breakout, "YOUR_DEVICE_UID", &ipcon);

Dieses Geräteobjekt kann benutzt werden, nachdem die IP Connection verbunden.

void xmc1400_breakout_destroy(XMC1400Breakout *xmc1400_breakout)¶

Parameter:	xmc1400_breakout – Typ: XMC1400Breakout *

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

int xmc1400_breakout_set_gpio_config(XMC1400Breakout *xmc1400_breakout, uint8_t port, uint8_t pin, uint8_t mode, uint8_t input_hysteresis, bool output_level)¶

Parameter:	xmc1400_breakout – Typ: 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:

XMC1400_BREAKOUT_GPIO_MODE_INPUT_TRISTATE = 0
XMC1400_BREAKOUT_GPIO_MODE_INPUT_PULL_DOWN = 1
XMC1400_BREAKOUT_GPIO_MODE_INPUT_PULL_UP = 2
XMC1400_BREAKOUT_GPIO_MODE_INPUT_SAMPLING = 3
XMC1400_BREAKOUT_GPIO_MODE_INPUT_INVERTED_TRISTATE = 4
XMC1400_BREAKOUT_GPIO_MODE_INPUT_INVERTED_PULL_DOWN = 5
XMC1400_BREAKOUT_GPIO_MODE_INPUT_INVERTED_PULL_UP = 6
XMC1400_BREAKOUT_GPIO_MODE_INPUT_INVERTED_SAMPLING = 7
XMC1400_BREAKOUT_GPIO_MODE_OUTPUT_PUSH_PULL = 8
XMC1400_BREAKOUT_GPIO_MODE_OUTPUT_OPEN_DRAIN = 9

Für input_hysteresis:

XMC1400_BREAKOUT_GPIO_INPUT_HYSTERESIS_STANDARD = 0
XMC1400_BREAKOUT_GPIO_INPUT_HYSTERESIS_LARGE = 4

int xmc1400_breakout_get_gpio_input(XMC1400Breakout *xmc1400_breakout, uint8_t port, uint8_t pin, bool *ret_value)¶

Parameter:	xmc1400_breakout – Typ: 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 xmc1400_breakout_set_adc_channel_config(XMC1400Breakout *xmc1400_breakout, uint8_t channel, bool enable)¶

Parameter:	xmc1400_breakout – Typ: 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 xmc1400_breakout_get_adc_channel_config(XMC1400Breakout *xmc1400_breakout, uint8_t channel, bool *ret_enable)¶

Parameter:	xmc1400_breakout – Typ: 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 xmc1400_breakout_set_adc_channel_config() gesetzt.

int xmc1400_breakout_get_adc_channel_value(XMC1400Breakout *xmc1400_breakout, uint8_t channel, uint16_t *ret_value)¶

Parameter:	xmc1400_breakout – Typ: 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 xmc1400_breakout_get_adc_values(XMC1400Breakout *xmc1400_breakout, uint16_t ret_values[8])¶

Parameter:	xmc1400_breakout – Typ: 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 xmc1400_breakout_set_adc_values_callback_configuration() und XMC1400_BREAKOUT_CALLBACK_ADC_VALUES Callback.

int xmc1400_breakout_get_count(XMC1400Breakout *xmc1400_breakout, uint32_t *ret_count)¶

Parameter:	xmc1400_breakout – Typ: 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 XMC1400_BREAKOUT_CALLBACK_COUNT Callback verwendet werden. Der Callback wird mit der Funktion xmc1400_breakout_set_count_callback_configuration() konfiguriert.

Fortgeschrittene Funktionen¶

int xmc1400_breakout_get_spitfp_error_count(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: 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 xmc1400_breakout_set_status_led_config(XMC1400Breakout *xmc1400_breakout, uint8_t config)¶

Parameter:	xmc1400_breakout – Typ: 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:

XMC1400_BREAKOUT_STATUS_LED_CONFIG_OFF = 0
XMC1400_BREAKOUT_STATUS_LED_CONFIG_ON = 1
XMC1400_BREAKOUT_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
XMC1400_BREAKOUT_STATUS_LED_CONFIG_SHOW_STATUS = 3

int xmc1400_breakout_get_status_led_config(XMC1400Breakout *xmc1400_breakout, uint8_t *ret_config)¶

Parameter:	xmc1400_breakout – Typ: 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 xmc1400_breakout_set_status_led_config() gesetzt.

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

Für ret_config:

XMC1400_BREAKOUT_STATUS_LED_CONFIG_OFF = 0
XMC1400_BREAKOUT_STATUS_LED_CONFIG_ON = 1
XMC1400_BREAKOUT_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
XMC1400_BREAKOUT_STATUS_LED_CONFIG_SHOW_STATUS = 3

int xmc1400_breakout_get_chip_temperature(XMC1400Breakout *xmc1400_breakout, int16_t *ret_temperature)¶

Parameter:	xmc1400_breakout – Typ: 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 xmc1400_breakout_reset(XMC1400Breakout *xmc1400_breakout)¶

Parameter:	xmc1400_breakout – Typ: 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 xmc1400_breakout_get_identity(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: 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¶

void xmc1400_breakout_register_callback(XMC1400Breakout *xmc1400_breakout, int16_t callback_id, void (*function)(void), void *user_data)¶

Parameter:	xmc1400_breakout – Typ: XMC1400Breakout * 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 xmc1400_breakout_set_adc_values_callback_configuration(XMC1400Breakout *xmc1400_breakout, uint32_t period, bool value_has_to_change)¶

Parameter:	xmc1400_breakout – Typ: 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 XMC1400_BREAKOUT_CALLBACK_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 xmc1400_breakout_get_adc_values_callback_configuration(XMC1400Breakout *xmc1400_breakout, uint32_t *ret_period, bool *ret_value_has_to_change)¶

Parameter:	xmc1400_breakout – Typ: 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 xmc1400_breakout_set_adc_values_callback_configuration() gesetzt.

int xmc1400_breakout_set_count_callback_configuration(XMC1400Breakout *xmc1400_breakout, uint32_t period, bool value_has_to_change, char option, uint32_t min, uint32_t max)¶

Parameter:

Parameter:	xmc1400_breakout – Typ: 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: 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 XMC1400_BREAKOUT_CALLBACK_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 XMC1400_BREAKOUT_CALLBACK_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:

XMC1400_BREAKOUT_THRESHOLD_OPTION_OFF = 'x'
XMC1400_BREAKOUT_THRESHOLD_OPTION_OUTSIDE = 'o'
XMC1400_BREAKOUT_THRESHOLD_OPTION_INSIDE = 'i'
XMC1400_BREAKOUT_THRESHOLD_OPTION_SMALLER = '<'
XMC1400_BREAKOUT_THRESHOLD_OPTION_GREATER = '>'

int xmc1400_breakout_get_count_callback_configuration(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: 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 xmc1400_breakout_set_count_callback_configuration() gesetzt.

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

Für ret_option:

XMC1400_BREAKOUT_THRESHOLD_OPTION_OFF = 'x'
XMC1400_BREAKOUT_THRESHOLD_OPTION_OUTSIDE = 'o'
XMC1400_BREAKOUT_THRESHOLD_OPTION_INSIDE = 'i'
XMC1400_BREAKOUT_THRESHOLD_OPTION_SMALLER = '<'
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 xmc1400_breakout_register_callback() Funktion durchgeführt werden:

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

xmc1400_breakout_register_callback(&xmc1400_breakout,
                                   XMC1400_BREAKOUT_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.

XMC1400_BREAKOUT_CALLBACK_ADC_VALUES¶

void callback(uint16_t values[8], void *user_data)

Callback-Parameter:	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 xmc1400_breakout_set_adc_values_callback_configuration() gesetzten Konfiguration

Die Parameter sind der gleiche wie xmc1400_breakout_get_adc_values().

XMC1400_BREAKOUT_CALLBACK_COUNT¶

void callback(uint32_t count, void *user_data)

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

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

Der Parameter ist der gleiche wie xmc1400_breakout_get_count().

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 xmc1400_breakout_get_api_version(XMC1400Breakout *xmc1400_breakout, uint8_t ret_api_version[3])¶

Parameter:	xmc1400_breakout – Typ: XMC1400Breakout *
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:	e_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 xmc1400_breakout_get_response_expected(XMC1400Breakout *xmc1400_breakout, uint8_t function_id, bool *ret_response_expected)¶

Parameter:	xmc1400_breakout – Typ: 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 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:

XMC1400_BREAKOUT_FUNCTION_SET_GPIO_CONFIG = 1
XMC1400_BREAKOUT_FUNCTION_SET_ADC_CHANNEL_CONFIG = 3
XMC1400_BREAKOUT_FUNCTION_SET_ADC_VALUES_CALLBACK_CONFIGURATION = 7
XMC1400_BREAKOUT_FUNCTION_SET_COUNT_CALLBACK_CONFIGURATION = 11
XMC1400_BREAKOUT_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
XMC1400_BREAKOUT_FUNCTION_SET_STATUS_LED_CONFIG = 239
XMC1400_BREAKOUT_FUNCTION_RESET = 243
XMC1400_BREAKOUT_FUNCTION_WRITE_UID = 248

int xmc1400_breakout_set_response_expected(XMC1400Breakout *xmc1400_breakout, uint8_t function_id, bool response_expected)¶

Parameter:	xmc1400_breakout – Typ: 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:

XMC1400_BREAKOUT_FUNCTION_SET_GPIO_CONFIG = 1
XMC1400_BREAKOUT_FUNCTION_SET_ADC_CHANNEL_CONFIG = 3
XMC1400_BREAKOUT_FUNCTION_SET_ADC_VALUES_CALLBACK_CONFIGURATION = 7
XMC1400_BREAKOUT_FUNCTION_SET_COUNT_CALLBACK_CONFIGURATION = 11
XMC1400_BREAKOUT_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
XMC1400_BREAKOUT_FUNCTION_SET_STATUS_LED_CONFIG = 239
XMC1400_BREAKOUT_FUNCTION_RESET = 243
XMC1400_BREAKOUT_FUNCTION_WRITE_UID = 248

int xmc1400_breakout_set_response_expected_all(XMC1400Breakout *xmc1400_breakout, bool response_expected)¶

Parameter:	xmc1400_breakout – Typ: 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 xmc1400_breakout_set_bootloader_mode(XMC1400Breakout *xmc1400_breakout, uint8_t mode, uint8_t *ret_status)¶

Parameter:	xmc1400_breakout – Typ: 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:

XMC1400_BREAKOUT_BOOTLOADER_MODE_BOOTLOADER = 0
XMC1400_BREAKOUT_BOOTLOADER_MODE_FIRMWARE = 1
XMC1400_BREAKOUT_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
XMC1400_BREAKOUT_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
XMC1400_BREAKOUT_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für ret_status:

XMC1400_BREAKOUT_BOOTLOADER_STATUS_OK = 0
XMC1400_BREAKOUT_BOOTLOADER_STATUS_INVALID_MODE = 1
XMC1400_BREAKOUT_BOOTLOADER_STATUS_NO_CHANGE = 2
XMC1400_BREAKOUT_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
XMC1400_BREAKOUT_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
XMC1400_BREAKOUT_BOOTLOADER_STATUS_CRC_MISMATCH = 5

int xmc1400_breakout_get_bootloader_mode(XMC1400Breakout *xmc1400_breakout, uint8_t *ret_mode)¶

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

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

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

Für ret_mode:

XMC1400_BREAKOUT_BOOTLOADER_MODE_BOOTLOADER = 0
XMC1400_BREAKOUT_BOOTLOADER_MODE_FIRMWARE = 1
XMC1400_BREAKOUT_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
XMC1400_BREAKOUT_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
XMC1400_BREAKOUT_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

int xmc1400_breakout_set_write_firmware_pointer(XMC1400Breakout *xmc1400_breakout, uint32_t pointer)¶

Parameter:	xmc1400_breakout – Typ: 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 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 xmc1400_breakout_write_firmware(XMC1400Breakout *xmc1400_breakout, uint8_t data[64], uint8_t *ret_status)¶

Parameter:	xmc1400_breakout – Typ: XMC1400Breakout * data – Typ: 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 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 xmc1400_breakout_write_uid(XMC1400Breakout *xmc1400_breakout, uint32_t uid)¶

Parameter:	xmc1400_breakout – Typ: 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 xmc1400_breakout_read_uid(XMC1400Breakout *xmc1400_breakout, uint32_t *ret_uid)¶

Parameter:	xmc1400_breakout – Typ: 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¶

XMC1400_BREAKOUT_DEVICE_IDENTIFIER¶

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

Die xmc1400_breakout_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.

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