Bemerkung
Dieses Bricklet ist im Moment in der Prototyp-Phase und die Software/Hardware sowie die Dokumentation sind in einem unfertigen Zustand.
Dies ist die Beschreibung der C/C++ für Mikrocontroller API Bindings für das ARINC429 Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des ARINC429 Bricklet sind in dessen Hardware Beschreibung zusammengefasst.
Eine Installationanleitung für die C/C++ für Mikrocontroller API Bindings ist Teil deren allgemeine Beschreibung.
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_arinc429_create
(TF_ARINC429 *arinc429, const char *uid, TF_HAL *hal)¶Parameter: |
|
---|---|
Rückgabe: |
|
Erzeugt ein Geräteobjekt arinc429
mit der optionalen eindeutigen Geräte ID oder
dem Portnamen uid_or_port_name
und fügt es dem HAL hal
hinzu:
TF_ARINC429 arinc429;
tf_arinc429_create(&arinc429, NULL, &ipcon);
Im Normalfall kann uid_or_port_name
auf NULL
belassen werden. Für weitere
Details siehe Abschnitt UID oder Port-Name.
tf_arinc429_destroy
(TF_ARINC429 *arinc429)¶Parameter: |
|
---|---|
Rückgabe: |
|
Entfernt das Geräteobjekt arinc429
von dessen HAL und zerstört es.
Das Geräteobjekt kann hiernach nicht mehr verwendet werden.
tf_arinc429_get_capabilities
(TF_ARINC429 *arinc429, uint16_t *ret_tx_total_scheduler_jobs, uint16_t *ret_tx_used_scheduler_jobs, uint16_t *ret_rx_total_frame_filters, uint16_t ret_rx_used_frame_filters[2])¶Parameter: |
|
---|---|
Ausgabeparameter: |
|
Rückgabe: |
|
tf_arinc429_set_channel_configuration
(TF_ARINC429 *arinc429, uint8_t channel, uint8_t parity, uint8_t speed)¶Parameter: |
|
---|---|
Rückgabe: |
|
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für channel:
Für parity:
Für speed:
tf_arinc429_get_channel_configuration
(TF_ARINC429 *arinc429, uint8_t channel, uint8_t *ret_parity, uint8_t *ret_speed)¶Parameter: |
|
---|---|
Ausgabeparameter: |
|
Rückgabe: |
|
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für channel:
Für ret_parity:
Für ret_speed:
tf_arinc429_set_channel_mode
(TF_ARINC429 *arinc429, uint8_t channel, uint8_t mode)¶Parameter: |
|
---|---|
Rückgabe: |
|
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für channel:
Für mode:
tf_arinc429_get_channel_mode
(TF_ARINC429 *arinc429, uint8_t channel, uint8_t *ret_mode)¶Parameter: |
|
---|---|
Ausgabeparameter: |
|
Rückgabe: |
|
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für channel:
Für ret_mode:
tf_arinc429_clear_all_rx_filters
(TF_ARINC429 *arinc429, uint8_t channel)¶Parameter: |
|
---|---|
Rückgabe: |
|
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für channel:
tf_arinc429_clear_rx_filter
(TF_ARINC429 *arinc429, uint8_t channel, uint8_t label, uint8_t sdi, bool *ret_success)¶Parameter: |
|
---|---|
Ausgabeparameter: |
|
Rückgabe: |
|
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für channel:
Für sdi:
tf_arinc429_set_rx_standard_filters
(TF_ARINC429 *arinc429, uint8_t channel)¶Parameter: |
|
---|---|
Rückgabe: |
|
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für channel:
tf_arinc429_set_rx_filter
(TF_ARINC429 *arinc429, uint8_t channel, uint8_t label, uint8_t sdi, bool *ret_success)¶Parameter: |
|
---|---|
Ausgabeparameter: |
|
Rückgabe: |
|
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für channel:
Für sdi:
tf_arinc429_get_rx_filter
(TF_ARINC429 *arinc429, uint8_t channel, uint8_t label, uint8_t sdi, bool *ret_configured)¶Parameter: |
|
---|---|
Ausgabeparameter: |
|
Rückgabe: |
|
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für channel:
Für sdi:
tf_arinc429_read_frame
(TF_ARINC429 *arinc429, uint8_t channel, uint8_t label, uint8_t sdi, bool *ret_status, uint32_t *ret_frame, uint16_t *ret_age)¶Parameter: |
|
---|---|
Ausgabeparameter: |
|
Rückgabe: |
|
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für channel:
Für sdi:
tf_arinc429_write_frame_direct
(TF_ARINC429 *arinc429, uint8_t channel, uint32_t frame)¶Parameter: |
|
---|---|
Rückgabe: |
|
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für channel:
tf_arinc429_write_frame_scheduled
(TF_ARINC429 *arinc429, uint8_t channel, uint16_t frame_index, uint32_t frame)¶Parameter: |
|
---|---|
Rückgabe: |
|
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für channel:
tf_arinc429_clear_schedule_entries
(TF_ARINC429 *arinc429, uint8_t channel, uint16_t job_index_first, uint16_t job_index_last)¶Parameter: |
|
---|---|
Rückgabe: |
|
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für channel:
tf_arinc429_set_schedule_entry
(TF_ARINC429 *arinc429, uint8_t channel, uint16_t job_index, uint8_t job, uint16_t frame_index, uint8_t dwell_time)¶Parameter: |
|
---|---|
Rückgabe: |
|
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für channel:
Für job:
tf_arinc429_get_schedule_entry
(TF_ARINC429 *arinc429, uint8_t channel, uint16_t job_index, uint8_t *ret_job, uint16_t *ret_frame_index, uint32_t *ret_frame, uint8_t *ret_dwell_time)¶Parameter: |
|
---|---|
Ausgabeparameter: |
|
Rückgabe: |
|
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für channel:
Für ret_job:
tf_arinc429_restart
(TF_ARINC429 *arinc429)¶Parameter: |
|
---|---|
Rückgabe: |
|
tf_arinc429_set_frame_mode
(TF_ARINC429 *arinc429, uint8_t channel, uint16_t frame_index, uint8_t mode)¶Parameter: |
|
---|---|
Rückgabe: |
|
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für channel:
Für mode:
tf_arinc429_get_spitfp_error_count
(TF_ARINC429 *arinc429, 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_arinc429_set_status_led_config
(TF_ARINC429 *arinc429, 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_arinc429_get_status_led_config
(TF_ARINC429 *arinc429, uint8_t *ret_config)¶Parameter: |
|
---|---|
Ausgabeparameter: |
|
Rückgabe: |
|
Gibt die Konfiguration zurück, wie von tf_arinc429_set_status_led_config()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für ret_config:
tf_arinc429_get_chip_temperature
(TF_ARINC429 *arinc429, 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_arinc429_reset
(TF_ARINC429 *arinc429)¶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_arinc429_get_identity
(TF_ARINC429 *arinc429, 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_arinc429_set_heartbeat_callback_configuration
(TF_ARINC429 *arinc429, uint8_t channel, bool enabled, bool value_has_to_change, uint16_t period)¶Parameter: |
|
---|---|
Rückgabe: |
|
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für channel:
tf_arinc429_get_heartbeat_callback_configuration
(TF_ARINC429 *arinc429, uint8_t channel, bool *ret_enabled, bool *ret_value_has_to_change, uint16_t *ret_period)¶Parameter: |
|
---|---|
Ausgabeparameter: |
|
Rückgabe: |
|
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für channel:
tf_arinc429_set_rx_callback_configuration
(TF_ARINC429 *arinc429, uint8_t channel, bool enabled, bool value_has_to_change, uint16_t timeout)¶Parameter: |
|
---|---|
Rückgabe: |
|
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für channel:
tf_arinc429_get_rx_callback_configuration
(TF_ARINC429 *arinc429, uint8_t channel, bool *ret_enabled, bool *ret_value_has_to_change, uint16_t *ret_timeout)¶Parameter: |
|
---|---|
Ausgabeparameter: |
|
Rückgabe: |
|
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für channel:
Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten
vom Gerät zu erhalten. Die Registrierung kann mit der entsprechenden tf_arinc429_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_arinc429_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_arinc429_register_heartbeat_message_callback
(TF_ARINC429 *arinc429, TF_ARINC429_HeartbeatMessageHandler handler, void *user_data)¶void handler(TF_ARINC429 *arinc429, uint8_t channel, uint8_t status, uint8_t seq_number, uint16_t timestamp, uint16_t frames_processed, uint16_t frames_lost, void *user_data)
Callback-Parameter: |
|
---|
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für channel:
Für status:
tf_arinc429_register_frame_message_callback
(TF_ARINC429 *arinc429, TF_ARINC429_FrameMessageHandler handler, void *user_data)¶void handler(TF_ARINC429 *arinc429, uint8_t channel, uint8_t status, uint8_t seq_number, uint16_t timestamp, uint32_t frame, uint16_t age, void *user_data)
Callback-Parameter: |
|
---|
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für channel:
Für status:
tf_arinc429_register_scheduler_message_callback
(TF_ARINC429 *arinc429, TF_ARINC429_SchedulerMessageHandler handler, void *user_data)¶void handler(TF_ARINC429 *arinc429, uint8_t channel, uint8_t status, uint8_t seq_number, uint16_t timestamp, uint8_t userdata, void *user_data)
Callback-Parameter: |
|
---|
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für channel:
Für status:
Virtuelle Funktionen kommunizieren nicht mit dem Gerät selbst, sie arbeiten nur auf dem API Bindings Objekt.
tf_arinc429_get_response_expected
(TF_ARINC429 *arinc429, 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_arinc429_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_arinc429_set_response_expected
(TF_ARINC429 *arinc429, 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_arinc429_set_response_expected_all
(TF_ARINC429 *arinc429, 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_arinc429_set_bootloader_mode
(TF_ARINC429 *arinc429, 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_arinc429_get_bootloader_mode
(TF_ARINC429 *arinc429, uint8_t *ret_mode)¶Parameter: |
|
---|---|
Ausgabeparameter: |
|
Rückgabe: |
|
Gibt den aktuellen Bootloader-Modus zurück, siehe tf_arinc429_set_bootloader_mode()
.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für ret_mode:
tf_arinc429_set_write_firmware_pointer
(TF_ARINC429 *arinc429, uint32_t pointer)¶Parameter: |
|
---|---|
Rückgabe: |
|
Setzt den Firmware-Pointer für tf_arinc429_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_arinc429_write_firmware
(TF_ARINC429 *arinc429, const uint8_t data[64], uint8_t *ret_status)¶Parameter: |
|
---|---|
Ausgabeparameter: |
|
Rückgabe: |
|
Schreibt 64 Bytes Firmware an die Position die vorher von
tf_arinc429_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_arinc429_write_uid
(TF_ARINC429 *arinc429, 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_arinc429_read_uid
(TF_ARINC429 *arinc429, 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_ARINC429_DEVICE_IDENTIFIER
¶Diese Konstante wird verwendet um ein ARINC429 Bricklet zu identifizieren.
Die Funktionen tf_arinc429_get_identity()
und tf_hal_get_device_info()
haben einen device_identifier
Ausgabe-Parameter um den Typ
des Bricks oder Bricklets anzugeben.
TF_ARINC429_DEVICE_DISPLAY_NAME
¶Diese Konstante stellt den Anzeigenamen eines ARINC429 Bricklet dar.