Deutsch
English
Menu

Rust - ARINC429 Bricklet

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 Rust 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 Rust API Bindings ist Teil deren allgemeine Beschreibung. Zusätzliche Dokumentation findet sich auf docs.rs.

API

Um eine nicht-blockierende Verwendung zu erlauben, gibt fast jede Funktion der Rust-Bindings einen Wrapper um einen mpsc::Receiver zurück. Um das Ergebnis eines Funktionsaufrufs zu erhalten und zu blockieren, bis das Gerät die Anfrage verarbeitet hat, können die recv-Varianten des Receivers verwendet werden. Diese geben entweder das vom Gerät gesendete Ergebnis, oder einen aufgetretenen Fehler zurück.

Funktionen die direkt ein Result zurückgeben, blockieren bis das Gerät die Anfrage verarbeitet hat.

Alle folgend aufgelisteten Funktionen sind Thread-sicher, diese, die einen Receiver zurückgeben, sind Lock-frei.

Grundfunktionen

pub fn Arinc429Bricklet::new(uid: &str, ip_connection: &IpConnection) → Arinc429Bricklet
Parameter:
  • uid – Typ: &str
  • ip_connection – Typ: &IPConnection
Rückgabe:
  • arinc429 – Typ: Arinc429Bricklet

Erzeugt ein neues Arinc429Bricklet-Objekt mit der eindeutigen Geräte ID uid und fügt es der IP-Connection ip_connection hinzu:

let arinc429 = Arinc429Bricklet::new("YOUR_DEVICE_UID", &ip_connection);

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

pub fn Arinc429Bricklet::get_capabilities(&self) → ConvertingReceiver<Capabilities>
Rückgabeobjekt:
  • tx_total_scheduler_jobs – Typ: u16, Wertebereich: [0 bis 216 - 1]
  • tx_used_scheduler_jobs – Typ: u16, Wertebereich: [0 bis 216 - 1]
  • rx_total_frame_filters – Typ: u16, Wertebereich: [0 bis 216 - 1]
  • rx_used_frame_filters – Typ: [u16; 2], Wertebereich: [0 bis 216 - 1]
pub fn Arinc429Bricklet::set_channel_configuration(&self, channel: u8, parity: u8, speed: u8) → ConvertingReceiver<()>
Parameter:
  • channel – Typ: u8, Wertebereich: Siehe Konstanten
  • parity – Typ: u8, Wertebereich: Siehe Konstanten
  • speed – Typ: u8, Wertebereich: Siehe Konstanten

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

Für channel:

  • ARINC429_BRICKLET_CHANNEL_TX = 0
  • ARINC429_BRICKLET_CHANNEL_TX1 = 1
  • ARINC429_BRICKLET_CHANNEL_RX = 32
  • ARINC429_BRICKLET_CHANNEL_RX1 = 33
  • ARINC429_BRICKLET_CHANNEL_RX2 = 34

Für parity:

  • ARINC429_BRICKLET_PARITY_DATA = 0
  • ARINC429_BRICKLET_PARITY_AUTO = 1

Für speed:

  • ARINC429_BRICKLET_SPEED_HS = 0
  • ARINC429_BRICKLET_SPEED_LS = 1
pub fn Arinc429Bricklet::get_channel_configuration(&self, channel: u8) → ConvertingReceiver<ChannelConfiguration>
Parameter:
  • channel – Typ: u8, Wertebereich: Siehe Konstanten
Rückgabeobjekt:
  • parity – Typ: u8, Wertebereich: Siehe Konstanten
  • speed – Typ: u8, Wertebereich: Siehe Konstanten

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

Für channel:

  • ARINC429_BRICKLET_CHANNEL_TX = 0
  • ARINC429_BRICKLET_CHANNEL_TX1 = 1
  • ARINC429_BRICKLET_CHANNEL_RX = 32
  • ARINC429_BRICKLET_CHANNEL_RX1 = 33
  • ARINC429_BRICKLET_CHANNEL_RX2 = 34

Für parity:

  • ARINC429_BRICKLET_PARITY_DATA = 0
  • ARINC429_BRICKLET_PARITY_AUTO = 1

Für speed:

  • ARINC429_BRICKLET_SPEED_HS = 0
  • ARINC429_BRICKLET_SPEED_LS = 1
pub fn Arinc429Bricklet::set_channel_mode(&self, channel: u8, mode: u8) → ConvertingReceiver<()>
Parameter:
  • channel – Typ: u8, Wertebereich: Siehe Konstanten
  • mode – Typ: u8, Wertebereich: Siehe Konstanten

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

Für channel:

  • ARINC429_BRICKLET_CHANNEL_TX = 0
  • ARINC429_BRICKLET_CHANNEL_TX1 = 1
  • ARINC429_BRICKLET_CHANNEL_RX = 32
  • ARINC429_BRICKLET_CHANNEL_RX1 = 33
  • ARINC429_BRICKLET_CHANNEL_RX2 = 34

Für mode:

  • ARINC429_BRICKLET_CHANNEL_MODE_PASSIVE = 0
  • ARINC429_BRICKLET_CHANNEL_MODE_ACTIVE = 1
  • ARINC429_BRICKLET_CHANNEL_MODE_RUN = 2
pub fn Arinc429Bricklet::get_channel_mode(&self, channel: u8) → ConvertingReceiver<u8>
Parameter:
  • channel – Typ: u8, Wertebereich: Siehe Konstanten
Rückgabe:
  • mode – Typ: u8, Wertebereich: Siehe Konstanten

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

Für channel:

  • ARINC429_BRICKLET_CHANNEL_TX = 0
  • ARINC429_BRICKLET_CHANNEL_TX1 = 1
  • ARINC429_BRICKLET_CHANNEL_RX = 32
  • ARINC429_BRICKLET_CHANNEL_RX1 = 33
  • ARINC429_BRICKLET_CHANNEL_RX2 = 34

Für mode:

  • ARINC429_BRICKLET_CHANNEL_MODE_PASSIVE = 0
  • ARINC429_BRICKLET_CHANNEL_MODE_ACTIVE = 1
  • ARINC429_BRICKLET_CHANNEL_MODE_RUN = 2
pub fn Arinc429Bricklet::clear_all_rx_filters(&self, channel: u8) → ConvertingReceiver<()>
Parameter:
  • channel – Typ: u8, Wertebereich: Siehe Konstanten

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

Für channel:

  • ARINC429_BRICKLET_CHANNEL_TX = 0
  • ARINC429_BRICKLET_CHANNEL_TX1 = 1
  • ARINC429_BRICKLET_CHANNEL_RX = 32
  • ARINC429_BRICKLET_CHANNEL_RX1 = 33
  • ARINC429_BRICKLET_CHANNEL_RX2 = 34
pub fn Arinc429Bricklet::clear_rx_filter(&self, channel: u8, label: u8, sdi: u8) → ConvertingReceiver<bool>
Parameter:
  • channel – Typ: u8, Wertebereich: Siehe Konstanten
  • label – Typ: u8, Wertebereich: [0 bis 255]
  • sdi – Typ: u8, Wertebereich: Siehe Konstanten
Rückgabe:
  • success – Typ: bool

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

Für channel:

  • ARINC429_BRICKLET_CHANNEL_TX = 0
  • ARINC429_BRICKLET_CHANNEL_TX1 = 1
  • ARINC429_BRICKLET_CHANNEL_RX = 32
  • ARINC429_BRICKLET_CHANNEL_RX1 = 33
  • ARINC429_BRICKLET_CHANNEL_RX2 = 34

Für sdi:

  • ARINC429_BRICKLET_SDI_SDI0 = 0
  • ARINC429_BRICKLET_SDI_SDI1 = 1
  • ARINC429_BRICKLET_SDI_SDI2 = 2
  • ARINC429_BRICKLET_SDI_SDI3 = 3
  • ARINC429_BRICKLET_SDI_DATA = 4
pub fn Arinc429Bricklet::set_rx_standard_filters(&self, channel: u8) → ConvertingReceiver<()>
Parameter:
  • channel – Typ: u8, Wertebereich: Siehe Konstanten

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

Für channel:

  • ARINC429_BRICKLET_CHANNEL_TX = 0
  • ARINC429_BRICKLET_CHANNEL_TX1 = 1
  • ARINC429_BRICKLET_CHANNEL_RX = 32
  • ARINC429_BRICKLET_CHANNEL_RX1 = 33
  • ARINC429_BRICKLET_CHANNEL_RX2 = 34
pub fn Arinc429Bricklet::set_rx_filter(&self, channel: u8, label: u8, sdi: u8) → ConvertingReceiver<bool>
Parameter:
  • channel – Typ: u8, Wertebereich: Siehe Konstanten
  • label – Typ: u8, Wertebereich: [0 bis 255]
  • sdi – Typ: u8, Wertebereich: Siehe Konstanten
Rückgabe:
  • success – Typ: bool

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

Für channel:

  • ARINC429_BRICKLET_CHANNEL_TX = 0
  • ARINC429_BRICKLET_CHANNEL_TX1 = 1
  • ARINC429_BRICKLET_CHANNEL_RX = 32
  • ARINC429_BRICKLET_CHANNEL_RX1 = 33
  • ARINC429_BRICKLET_CHANNEL_RX2 = 34

Für sdi:

  • ARINC429_BRICKLET_SDI_SDI0 = 0
  • ARINC429_BRICKLET_SDI_SDI1 = 1
  • ARINC429_BRICKLET_SDI_SDI2 = 2
  • ARINC429_BRICKLET_SDI_SDI3 = 3
  • ARINC429_BRICKLET_SDI_DATA = 4
pub fn Arinc429Bricklet::get_rx_filter(&self, channel: u8, label: u8, sdi: u8) → ConvertingReceiver<bool>
Parameter:
  • channel – Typ: u8, Wertebereich: Siehe Konstanten
  • label – Typ: u8, Wertebereich: [0 bis 255]
  • sdi – Typ: u8, Wertebereich: Siehe Konstanten
Rückgabe:
  • configured – Typ: bool

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

Für channel:

  • ARINC429_BRICKLET_CHANNEL_TX = 0
  • ARINC429_BRICKLET_CHANNEL_TX1 = 1
  • ARINC429_BRICKLET_CHANNEL_RX = 32
  • ARINC429_BRICKLET_CHANNEL_RX1 = 33
  • ARINC429_BRICKLET_CHANNEL_RX2 = 34

Für sdi:

  • ARINC429_BRICKLET_SDI_SDI0 = 0
  • ARINC429_BRICKLET_SDI_SDI1 = 1
  • ARINC429_BRICKLET_SDI_SDI2 = 2
  • ARINC429_BRICKLET_SDI_SDI3 = 3
  • ARINC429_BRICKLET_SDI_DATA = 4
pub fn Arinc429Bricklet::read_frame(&self, channel: u8, label: u8, sdi: u8) → ConvertingReceiver<ReadFrame>
Parameter:
  • channel – Typ: u8, Wertebereich: Siehe Konstanten
  • label – Typ: u8, Wertebereich: [0 bis 255]
  • sdi – Typ: u8, Wertebereich: Siehe Konstanten
Rückgabeobjekt:
  • status – Typ: bool
  • frame – Typ: u32, Wertebereich: [0 bis 232 - 1]
  • age – Typ: u16, Einheit: 1 ms, Wertebereich: [0 bis 216 - 1]

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

Für channel:

  • ARINC429_BRICKLET_CHANNEL_TX = 0
  • ARINC429_BRICKLET_CHANNEL_TX1 = 1
  • ARINC429_BRICKLET_CHANNEL_RX = 32
  • ARINC429_BRICKLET_CHANNEL_RX1 = 33
  • ARINC429_BRICKLET_CHANNEL_RX2 = 34

Für sdi:

  • ARINC429_BRICKLET_SDI_SDI0 = 0
  • ARINC429_BRICKLET_SDI_SDI1 = 1
  • ARINC429_BRICKLET_SDI_SDI2 = 2
  • ARINC429_BRICKLET_SDI_SDI3 = 3
  • ARINC429_BRICKLET_SDI_DATA = 4
pub fn Arinc429Bricklet::write_frame_direct(&self, channel: u8, frame: u32) → ConvertingReceiver<()>
Parameter:
  • channel – Typ: u8, Wertebereich: Siehe Konstanten
  • frame – Typ: u32, Wertebereich: [0 bis 232 - 1]

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

Für channel:

  • ARINC429_BRICKLET_CHANNEL_TX = 0
  • ARINC429_BRICKLET_CHANNEL_TX1 = 1
  • ARINC429_BRICKLET_CHANNEL_RX = 32
  • ARINC429_BRICKLET_CHANNEL_RX1 = 33
  • ARINC429_BRICKLET_CHANNEL_RX2 = 34
pub fn Arinc429Bricklet::write_frame_scheduled(&self, channel: u8, frame_index: u16, frame: u32) → ConvertingReceiver<()>
Parameter:
  • channel – Typ: u8, Wertebereich: Siehe Konstanten
  • frame_index – Typ: u16, Wertebereich: [0 bis 216 - 1]
  • frame – Typ: u32, Wertebereich: [0 bis 232 - 1]

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

Für channel:

  • ARINC429_BRICKLET_CHANNEL_TX = 0
  • ARINC429_BRICKLET_CHANNEL_TX1 = 1
  • ARINC429_BRICKLET_CHANNEL_RX = 32
  • ARINC429_BRICKLET_CHANNEL_RX1 = 33
  • ARINC429_BRICKLET_CHANNEL_RX2 = 34
pub fn Arinc429Bricklet::clear_schedule_entries(&self, channel: u8, job_index_first: u16, job_index_last: u16) → ConvertingReceiver<()>
Parameter:
  • channel – Typ: u8, Wertebereich: Siehe Konstanten
  • job_index_first – Typ: u16, Wertebereich: [0 bis 216 - 1]
  • job_index_last – Typ: u16, Wertebereich: [0 bis 216 - 1]

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

Für channel:

  • ARINC429_BRICKLET_CHANNEL_TX = 0
  • ARINC429_BRICKLET_CHANNEL_TX1 = 1
  • ARINC429_BRICKLET_CHANNEL_RX = 32
  • ARINC429_BRICKLET_CHANNEL_RX1 = 33
  • ARINC429_BRICKLET_CHANNEL_RX2 = 34
pub fn Arinc429Bricklet::set_schedule_entry(&self, channel: u8, job_index: u16, job: u8, frame_index: u16, dwell_time: u8) → ConvertingReceiver<()>
Parameter:
  • channel – Typ: u8, Wertebereich: Siehe Konstanten
  • job_index – Typ: u16, Wertebereich: [0 bis 216 - 1]
  • job – Typ: u8, Wertebereich: Siehe Konstanten
  • frame_index – Typ: u16, Wertebereich: [0 bis 216 - 1]
  • dwell_time – Typ: u8, Einheit: 1 ms, Wertebereich: [0 bis 255]

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

Für channel:

  • ARINC429_BRICKLET_CHANNEL_TX = 0
  • ARINC429_BRICKLET_CHANNEL_TX1 = 1
  • ARINC429_BRICKLET_CHANNEL_RX = 32
  • ARINC429_BRICKLET_CHANNEL_RX1 = 33
  • ARINC429_BRICKLET_CHANNEL_RX2 = 34

Für job:

  • ARINC429_BRICKLET_SCHEDULER_JOB_SKIP = 0
  • ARINC429_BRICKLET_SCHEDULER_JOB_CALLBACK = 1
  • ARINC429_BRICKLET_SCHEDULER_JOB_STOP = 2
  • ARINC429_BRICKLET_SCHEDULER_JOB_JUMP = 3
  • ARINC429_BRICKLET_SCHEDULER_JOB_RETURN = 4
  • ARINC429_BRICKLET_SCHEDULER_JOB_DWELL = 5
  • ARINC429_BRICKLET_SCHEDULER_JOB_SINGLE = 6
  • ARINC429_BRICKLET_SCHEDULER_JOB_CYCLIC = 7
  • ARINC429_BRICKLET_SCHEDULER_JOB_RETRANS_RX1 = 8
  • ARINC429_BRICKLET_SCHEDULER_JOB_RETRANS_RX2 = 9
pub fn Arinc429Bricklet::get_schedule_entry(&self, channel: u8, job_index: u16) → ConvertingReceiver<ScheduleEntry>
Parameter:
  • channel – Typ: u8, Wertebereich: Siehe Konstanten
  • job_index – Typ: u16, Wertebereich: [0 bis 216 - 1]
Rückgabeobjekt:
  • job – Typ: u8, Wertebereich: Siehe Konstanten
  • frame_index – Typ: u16, Wertebereich: [0 bis 216 - 1]
  • frame – Typ: u32, Wertebereich: [0 bis 232 - 1]
  • dwell_time – Typ: u8, Einheit: 1 ms, Wertebereich: [0 bis 255]

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

Für channel:

  • ARINC429_BRICKLET_CHANNEL_TX = 0
  • ARINC429_BRICKLET_CHANNEL_TX1 = 1
  • ARINC429_BRICKLET_CHANNEL_RX = 32
  • ARINC429_BRICKLET_CHANNEL_RX1 = 33
  • ARINC429_BRICKLET_CHANNEL_RX2 = 34

Für job:

  • ARINC429_BRICKLET_SCHEDULER_JOB_SKIP = 0
  • ARINC429_BRICKLET_SCHEDULER_JOB_CALLBACK = 1
  • ARINC429_BRICKLET_SCHEDULER_JOB_STOP = 2
  • ARINC429_BRICKLET_SCHEDULER_JOB_JUMP = 3
  • ARINC429_BRICKLET_SCHEDULER_JOB_RETURN = 4
  • ARINC429_BRICKLET_SCHEDULER_JOB_DWELL = 5
  • ARINC429_BRICKLET_SCHEDULER_JOB_SINGLE = 6
  • ARINC429_BRICKLET_SCHEDULER_JOB_CYCLIC = 7
  • ARINC429_BRICKLET_SCHEDULER_JOB_RETRANS_RX1 = 8
  • ARINC429_BRICKLET_SCHEDULER_JOB_RETRANS_RX2 = 9
pub fn Arinc429Bricklet::restart(&self) → ConvertingReceiver<()>
pub fn Arinc429Bricklet::set_frame_mode(&self, channel: u8, frame_index: u16, mode: u8) → ConvertingReceiver<()>
Parameter:
  • channel – Typ: u8, Wertebereich: Siehe Konstanten
  • frame_index – Typ: u16, Wertebereich: [0 bis 216 - 1]
  • mode – Typ: u8, Wertebereich: Siehe Konstanten

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

Für channel:

  • ARINC429_BRICKLET_CHANNEL_TX = 0
  • ARINC429_BRICKLET_CHANNEL_TX1 = 1
  • ARINC429_BRICKLET_CHANNEL_RX = 32
  • ARINC429_BRICKLET_CHANNEL_RX1 = 33
  • ARINC429_BRICKLET_CHANNEL_RX2 = 34

Für mode:

  • ARINC429_BRICKLET_TX_MODE_TRANSMIT = 0
  • ARINC429_BRICKLET_TX_MODE_MUTE = 1

Fortgeschrittene Funktionen

pub fn Arinc429Bricklet::get_spitfp_error_count(&self) → ConvertingReceiver<SpitfpErrorCount>
Rückgabeobjekt:
  • error_count_ack_checksum – Typ: u32, Wertebereich: [0 bis 232 - 1]
  • error_count_message_checksum – Typ: u32, Wertebereich: [0 bis 232 - 1]
  • error_count_frame – Typ: u32, Wertebereich: [0 bis 232 - 1]
  • error_count_overflow – Typ: u32, Wertebereich: [0 bis 232 - 1]

Gibt die Anzahl der Fehler die während der Kommunikation zwischen Brick und Bricklet aufgetreten sind zurück.

Die Fehler sind aufgeteilt in

  • ACK-Checksummen Fehler,
  • Message-Checksummen Fehler,
  • Framing Fehler und
  • Overflow Fehler.

Die Fehlerzähler sind für Fehler die auf der Seite des Bricklets auftreten. Jedes Brick hat eine ähnliche Funktion welche die Fehler auf Brickseite ausgibt.

pub fn Arinc429Bricklet::set_status_led_config(&self, config: u8) → ConvertingReceiver<()>
Parameter:
  • config – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 3

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:

  • ARINC429_BRICKLET_STATUS_LED_CONFIG_OFF = 0
  • ARINC429_BRICKLET_STATUS_LED_CONFIG_ON = 1
  • ARINC429_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • ARINC429_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS = 3
pub fn Arinc429Bricklet::get_status_led_config(&self) → ConvertingReceiver<u8>
Rückgabe:
  • config – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 3

Gibt die Konfiguration zurück, wie von Arinc429Bricklet::set_status_led_config gesetzt.

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

Für config:

  • ARINC429_BRICKLET_STATUS_LED_CONFIG_OFF = 0
  • ARINC429_BRICKLET_STATUS_LED_CONFIG_ON = 1
  • ARINC429_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • ARINC429_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS = 3
pub fn Arinc429Bricklet::get_chip_temperature(&self) → ConvertingReceiver<i16>
Rückgabe:
  • temperature – Typ: i16, Einheit: 1 °C, Wertebereich: [-215 bis 215 - 1]

Gibt die Temperatur, gemessen im Mikrocontroller, aus. Der Rückgabewert ist nicht die Umgebungstemperatur.

Die Temperatur ist lediglich proportional zur echten Temperatur und hat eine hohe Ungenauigkeit. Daher beschränkt sich der praktische Nutzen auf die Indikation von Temperaturveränderungen.

pub fn Arinc429Bricklet::reset(&self) → ConvertingReceiver<()>

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.

pub fn Arinc429Bricklet::get_identity(&self) → ConvertingReceiver<Identity>
Rückgabeobjekt:
  • uid – Typ: String, Länge: bis zu 8
  • connected_uid – Typ: String, Länge: bis zu 8
  • position – Typ: char, Wertebereich: ['a' bis 'h', 'z']
  • hardware_version – Typ: [u8; 3]
    • 0: major – Typ: u8, Wertebereich: [0 bis 255]
    • 1: minor – Typ: u8, Wertebereich: [0 bis 255]
    • 2: revision – Typ: u8, Wertebereich: [0 bis 255]
  • firmware_version – Typ: [u8; 3]
    • 0: major – Typ: u8, Wertebereich: [0 bis 255]
    • 1: minor – Typ: u8, Wertebereich: [0 bis 255]
    • 2: revision – Typ: u8, Wertebereich: [0 bis 255]
  • device_identifier – Typ: u16, Wertebereich: [0 bis 216 - 1]

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

pub fn Arinc429Bricklet::set_heartbeat_callback_configuration(&self, channel: u8, enabled: bool, value_has_to_change: bool, period: u16) → ConvertingReceiver<()>
Parameter:
  • channel – Typ: u8, Wertebereich: Siehe Konstanten
  • enabled – Typ: bool, Standardwert: false
  • value_has_to_change – Typ: bool, Standardwert: false
  • period – Typ: u16, Einheit: 1 ms, Wertebereich: [0 bis 216 - 1]

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

Für channel:

  • ARINC429_BRICKLET_CHANNEL_TX = 0
  • ARINC429_BRICKLET_CHANNEL_TX1 = 1
  • ARINC429_BRICKLET_CHANNEL_RX = 32
  • ARINC429_BRICKLET_CHANNEL_RX1 = 33
  • ARINC429_BRICKLET_CHANNEL_RX2 = 34
pub fn Arinc429Bricklet::get_heartbeat_callback_configuration(&self, channel: u8) → ConvertingReceiver<HeartbeatCallbackConfiguration>
Parameter:
  • channel – Typ: u8, Wertebereich: Siehe Konstanten
Rückgabeobjekt:
  • enabled – Typ: bool, Standardwert: false
  • value_has_to_change – Typ: bool, Standardwert: false
  • period – Typ: u16, Einheit: 1 ms, Wertebereich: [0 bis 216 - 1]

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

Für channel:

  • ARINC429_BRICKLET_CHANNEL_TX = 0
  • ARINC429_BRICKLET_CHANNEL_TX1 = 1
  • ARINC429_BRICKLET_CHANNEL_RX = 32
  • ARINC429_BRICKLET_CHANNEL_RX1 = 33
  • ARINC429_BRICKLET_CHANNEL_RX2 = 34
pub fn Arinc429Bricklet::set_rx_callback_configuration(&self, channel: u8, enabled: bool, value_has_to_change: bool, timeout: u16) → ConvertingReceiver<()>
Parameter:
  • channel – Typ: u8, Wertebereich: Siehe Konstanten
  • enabled – Typ: bool, Standardwert: false
  • value_has_to_change – Typ: bool, Standardwert: false
  • timeout – Typ: u16, Einheit: 1 ms, Wertebereich: [0 bis 216 - 1]

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

Für channel:

  • ARINC429_BRICKLET_CHANNEL_TX = 0
  • ARINC429_BRICKLET_CHANNEL_TX1 = 1
  • ARINC429_BRICKLET_CHANNEL_RX = 32
  • ARINC429_BRICKLET_CHANNEL_RX1 = 33
  • ARINC429_BRICKLET_CHANNEL_RX2 = 34
pub fn Arinc429Bricklet::get_rx_callback_configuration(&self, channel: u8) → ConvertingReceiver<RxCallbackConfiguration>
Parameter:
  • channel – Typ: u8, Wertebereich: Siehe Konstanten
Rückgabeobjekt:
  • enabled – Typ: bool, Standardwert: false
  • value_has_to_change – Typ: bool, Standardwert: false
  • timeout – Typ: u16, Einheit: 1 ms, Wertebereich: [0 bis 216 - 1]

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

Für channel:

  • ARINC429_BRICKLET_CHANNEL_TX = 0
  • ARINC429_BRICKLET_CHANNEL_TX1 = 1
  • ARINC429_BRICKLET_CHANNEL_RX = 32
  • ARINC429_BRICKLET_CHANNEL_RX1 = 33
  • ARINC429_BRICKLET_CHANNEL_RX2 = 34

Callbacks

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann mit der entsprechenden get_*_callback_receiver-Function durchgeführt werden, welche einen Receiver für Callback-Events zurück gibt.

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.

pub fn Arinc429Bricklet::get_heartbeat_message_callback_receiver(&self) → ConvertingCallbackReceiver<HeartbeatMessageEvent>
Event-Objekt:
  • channel – Typ: u8, Wertebereich: Siehe Konstanten
  • status – Typ: u8, Wertebereich: Siehe Konstanten
  • seq_number – Typ: u8, Wertebereich: [0 bis 255]
  • timestamp – Typ: u16, Wertebereich: [0 bis 216 - 1]
  • frames_processed – Typ: u16, Wertebereich: [0 bis 216 - 1]
  • frames_lost – Typ: u16, Wertebereich: [0 bis 216 - 1]

Receiver die mit dieser Funktion erstellt werden, empfangen Heartbeat Message-Events.

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

Für channel:

  • ARINC429_BRICKLET_CHANNEL_TX = 0
  • ARINC429_BRICKLET_CHANNEL_TX1 = 1
  • ARINC429_BRICKLET_CHANNEL_RX = 32
  • ARINC429_BRICKLET_CHANNEL_RX1 = 33
  • ARINC429_BRICKLET_CHANNEL_RX2 = 34

Für status:

  • ARINC429_BRICKLET_STATUS_NEW = 0
  • ARINC429_BRICKLET_STATUS_UPDATE = 1
  • ARINC429_BRICKLET_STATUS_TIMEOUT = 2
  • ARINC429_BRICKLET_STATUS_SCHEDULER = 3
  • ARINC429_BRICKLET_STATUS_STATISTICS = 4
pub fn Arinc429Bricklet::get_frame_message_callback_receiver(&self) → ConvertingCallbackReceiver<FrameMessageEvent>
Event-Objekt:
  • channel – Typ: u8, Wertebereich: Siehe Konstanten
  • status – Typ: u8, Wertebereich: Siehe Konstanten
  • seq_number – Typ: u8, Wertebereich: [0 bis 255]
  • timestamp – Typ: u16, Wertebereich: [0 bis 216 - 1]
  • frame – Typ: u32, Wertebereich: [0 bis 232 - 1]
  • age – Typ: u16, Einheit: 1 ms, Wertebereich: [0 bis 216 - 1]

Receiver die mit dieser Funktion erstellt werden, empfangen Frame Message-Events.

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

Für channel:

  • ARINC429_BRICKLET_CHANNEL_TX = 0
  • ARINC429_BRICKLET_CHANNEL_TX1 = 1
  • ARINC429_BRICKLET_CHANNEL_RX = 32
  • ARINC429_BRICKLET_CHANNEL_RX1 = 33
  • ARINC429_BRICKLET_CHANNEL_RX2 = 34

Für status:

  • ARINC429_BRICKLET_STATUS_NEW = 0
  • ARINC429_BRICKLET_STATUS_UPDATE = 1
  • ARINC429_BRICKLET_STATUS_TIMEOUT = 2
  • ARINC429_BRICKLET_STATUS_SCHEDULER = 3
  • ARINC429_BRICKLET_STATUS_STATISTICS = 4
pub fn Arinc429Bricklet::get_scheduler_message_callback_receiver(&self) → ConvertingCallbackReceiver<SchedulerMessageEvent>
Event-Objekt:
  • channel – Typ: u8, Wertebereich: Siehe Konstanten
  • status – Typ: u8, Wertebereich: Siehe Konstanten
  • seq_number – Typ: u8, Wertebereich: [0 bis 255]
  • timestamp – Typ: u16, Wertebereich: [0 bis 216 - 1]
  • userdata – Typ: u8, Wertebereich: [0 bis 255]

Receiver die mit dieser Funktion erstellt werden, empfangen Scheduler Message-Events.

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

Für channel:

  • ARINC429_BRICKLET_CHANNEL_TX = 0
  • ARINC429_BRICKLET_CHANNEL_TX1 = 1
  • ARINC429_BRICKLET_CHANNEL_RX = 32
  • ARINC429_BRICKLET_CHANNEL_RX1 = 33
  • ARINC429_BRICKLET_CHANNEL_RX2 = 34

Für status:

  • ARINC429_BRICKLET_STATUS_NEW = 0
  • ARINC429_BRICKLET_STATUS_UPDATE = 1
  • ARINC429_BRICKLET_STATUS_TIMEOUT = 2
  • ARINC429_BRICKLET_STATUS_SCHEDULER = 3
  • ARINC429_BRICKLET_STATUS_STATISTICS = 4

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.

pub fn Arinc429Bricklet::get_api_version(&self) → [u8; 3]
Rückgabeobjekt:
  • api_version – Typ: [u8; 3]
    • 0: major – Typ: u8, Wertebereich: [0 bis 255]
    • 1: minor – Typ: u8, Wertebereich: [0 bis 255]
    • 2: revision – Typ: u8, Wertebereich: [0 bis 255]

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.

pub fn Arinc429Bricklet::get_response_expected(&mut self, function_id: u8) → bool
Parameter:
  • function_id – Typ: u8, Wertebereich: Siehe Konstanten
Rückgabe:
  • response_expected – Typ: bool

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 Arinc429Bricklet::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:

  • ARINC429_BRICKLET_FUNCTION_SET_HEARTBEAT_CALLBACK_CONFIGURATION = 2
  • ARINC429_BRICKLET_FUNCTION_SET_CHANNEL_CONFIGURATION = 5
  • ARINC429_BRICKLET_FUNCTION_SET_CHANNEL_MODE = 7
  • ARINC429_BRICKLET_FUNCTION_CLEAR_ALL_RX_FILTERS = 9
  • ARINC429_BRICKLET_FUNCTION_SET_RX_STANDARD_FILTERS = 11
  • ARINC429_BRICKLET_FUNCTION_SET_RX_CALLBACK_CONFIGURATION = 15
  • ARINC429_BRICKLET_FUNCTION_WRITE_FRAME_DIRECT = 18
  • ARINC429_BRICKLET_FUNCTION_WRITE_FRAME_SCHEDULED = 19
  • ARINC429_BRICKLET_FUNCTION_CLEAR_SCHEDULE_ENTRIES = 20
  • ARINC429_BRICKLET_FUNCTION_SET_SCHEDULE_ENTRY = 21
  • ARINC429_BRICKLET_FUNCTION_RESTART = 23
  • ARINC429_BRICKLET_FUNCTION_SET_FRAME_MODE = 25
  • ARINC429_BRICKLET_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • ARINC429_BRICKLET_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • ARINC429_BRICKLET_FUNCTION_RESET = 243
  • ARINC429_BRICKLET_FUNCTION_WRITE_UID = 248
pub fn Arinc429Bricklet::set_response_expected(&mut self, function_id: u8, response_expected: bool) → ()
Parameter:
  • function_id – Typ: u8, Wertebereich: Siehe Konstanten
  • response_expected – Typ: bool

Ä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:

  • ARINC429_BRICKLET_FUNCTION_SET_HEARTBEAT_CALLBACK_CONFIGURATION = 2
  • ARINC429_BRICKLET_FUNCTION_SET_CHANNEL_CONFIGURATION = 5
  • ARINC429_BRICKLET_FUNCTION_SET_CHANNEL_MODE = 7
  • ARINC429_BRICKLET_FUNCTION_CLEAR_ALL_RX_FILTERS = 9
  • ARINC429_BRICKLET_FUNCTION_SET_RX_STANDARD_FILTERS = 11
  • ARINC429_BRICKLET_FUNCTION_SET_RX_CALLBACK_CONFIGURATION = 15
  • ARINC429_BRICKLET_FUNCTION_WRITE_FRAME_DIRECT = 18
  • ARINC429_BRICKLET_FUNCTION_WRITE_FRAME_SCHEDULED = 19
  • ARINC429_BRICKLET_FUNCTION_CLEAR_SCHEDULE_ENTRIES = 20
  • ARINC429_BRICKLET_FUNCTION_SET_SCHEDULE_ENTRY = 21
  • ARINC429_BRICKLET_FUNCTION_RESTART = 23
  • ARINC429_BRICKLET_FUNCTION_SET_FRAME_MODE = 25
  • ARINC429_BRICKLET_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • ARINC429_BRICKLET_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • ARINC429_BRICKLET_FUNCTION_RESET = 243
  • ARINC429_BRICKLET_FUNCTION_WRITE_UID = 248
pub fn Arinc429Bricklet::set_response_expected_all(&mut self, response_expected: bool) → ()
Parameter:
  • response_expected – Typ: bool

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

pub fn Arinc429Bricklet::set_bootloader_mode(&self, mode: u8) → ConvertingReceiver<u8>
Parameter:
  • mode – Typ: u8, Wertebereich: Siehe Konstanten
Rückgabe:
  • status – Typ: u8, Wertebereich: Siehe Konstanten

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:

  • ARINC429_BRICKLET_BOOTLOADER_MODE_BOOTLOADER = 0
  • ARINC429_BRICKLET_BOOTLOADER_MODE_FIRMWARE = 1
  • ARINC429_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • ARINC429_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • ARINC429_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für status:

  • ARINC429_BRICKLET_BOOTLOADER_STATUS_OK = 0
  • ARINC429_BRICKLET_BOOTLOADER_STATUS_INVALID_MODE = 1
  • ARINC429_BRICKLET_BOOTLOADER_STATUS_NO_CHANGE = 2
  • ARINC429_BRICKLET_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • ARINC429_BRICKLET_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • ARINC429_BRICKLET_BOOTLOADER_STATUS_CRC_MISMATCH = 5
pub fn Arinc429Bricklet::get_bootloader_mode(&self) → ConvertingReceiver<u8>
Rückgabe:
  • mode – Typ: u8, Wertebereich: Siehe Konstanten

Gibt den aktuellen Bootloader-Modus zurück, siehe Arinc429Bricklet::set_bootloader_mode.

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

Für mode:

  • ARINC429_BRICKLET_BOOTLOADER_MODE_BOOTLOADER = 0
  • ARINC429_BRICKLET_BOOTLOADER_MODE_FIRMWARE = 1
  • ARINC429_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • ARINC429_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • ARINC429_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
pub fn Arinc429Bricklet::set_write_firmware_pointer(&self, pointer: u32) → ConvertingReceiver<()>
Parameter:
  • pointer – Typ: u32, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]

Setzt den Firmware-Pointer für Arinc429Bricklet::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.

pub fn Arinc429Bricklet::write_firmware(&self, data: [u8; 64]) → ConvertingReceiver<u8>
Parameter:
  • data – Typ: [u8; 64], Wertebereich: [0 bis 255]
Rückgabe:
  • status – Typ: u8, Wertebereich: [0 bis 255]

Schreibt 64 Bytes Firmware an die Position die vorher von Arinc429Bricklet::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.

pub fn Arinc429Bricklet::write_uid(&self, uid: u32) → ConvertingReceiver<()>
Parameter:
  • uid – Typ: u32, Wertebereich: [0 bis 232 - 1]

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.

pub fn Arinc429Bricklet::read_uid(&self) → ConvertingReceiver<u32>
Rückgabe:
  • uid – Typ: u32, Wertebereich: [0 bis 232 - 1]

Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.

Konstanten

pub const Arinc429Bricklet::DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein ARINC429 Bricklet zu identifizieren.

Die Arinc429Bricklet::get_identity Funktion und der IpConnection::get_enumerate_callback_receiver Callback der IP Connection haben ein device_identifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

pub const Arinc429Bricklet::DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines ARINC429 Bricklet dar.