Delphi/Lazarus - 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 Delphi/Lazarus 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 Delphi/Lazarus API Bindings ist Teil deren allgemeine Beschreibung.

API

Da Delphi nicht mehrere Rückgabewerte direkt unterstützt, wird das out Schlüsselwort genutzt um mehrere Werte von einer Funktion zurückzugeben.

Alle folgend aufgelisteten Funktionen und Prozeduren sind Thread-sicher.

Grundfunktionen

constructor TBrickletARINC429.Create(const uid: string; ipcon: TIPConnection)
Parameter:
  • uid – Typ: string
  • ipcon – Typ: TIPConnection
Rückgabe:
  • arinc429 – Typ: TBrickletARINC429

Erzeugt ein Objekt mit der eindeutigen Geräte ID uid:

arinc429 := TBrickletARINC429.Create('YOUR_DEVICE_UID', ipcon);

Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.

procedure TBrickletARINC429.GetCapabilities(out txTotalSchedulerJobs: word; out txUsedSchedulerJobs: word; out rxTotalFrameFilters: word; out rxUsedFrameFilters: array [0..1] of word)
Ausgabeparameter:
  • txTotalSchedulerJobs – Typ: word, Wertebereich: [0 bis 216 - 1]
  • txUsedSchedulerJobs – Typ: word, Wertebereich: [0 bis 216 - 1]
  • rxTotalFrameFilters – Typ: word, Wertebereich: [0 bis 216 - 1]
  • rxUsedFrameFilters – Typ: array [0..1] of word, Wertebereich: [0 bis 216 - 1]
procedure TBrickletARINC429.SetChannelConfiguration(const channel: byte; const parity: byte; const speed: byte)
Parameter:
  • channel – Typ: byte, Wertebereich: Siehe Konstanten
  • parity – Typ: byte, Wertebereich: Siehe Konstanten
  • speed – Typ: byte, Wertebereich: Siehe Konstanten

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

Für channel:

  • BRICKLET_ARINC429_CHANNEL_TX = 0
  • BRICKLET_ARINC429_CHANNEL_TX1 = 1
  • BRICKLET_ARINC429_CHANNEL_RX = 32
  • BRICKLET_ARINC429_CHANNEL_RX1 = 33
  • BRICKLET_ARINC429_CHANNEL_RX2 = 34

Für parity:

  • BRICKLET_ARINC429_PARITY_DATA = 0
  • BRICKLET_ARINC429_PARITY_AUTO = 1

Für speed:

  • BRICKLET_ARINC429_SPEED_HS = 0
  • BRICKLET_ARINC429_SPEED_LS = 1
procedure TBrickletARINC429.GetChannelConfiguration(const channel: byte; out parity: byte; out speed: byte)
Parameter:
  • channel – Typ: byte, Wertebereich: Siehe Konstanten
Ausgabeparameter:
  • parity – Typ: byte, Wertebereich: Siehe Konstanten
  • speed – Typ: byte, Wertebereich: Siehe Konstanten

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

Für channel:

  • BRICKLET_ARINC429_CHANNEL_TX = 0
  • BRICKLET_ARINC429_CHANNEL_TX1 = 1
  • BRICKLET_ARINC429_CHANNEL_RX = 32
  • BRICKLET_ARINC429_CHANNEL_RX1 = 33
  • BRICKLET_ARINC429_CHANNEL_RX2 = 34

Für parity:

  • BRICKLET_ARINC429_PARITY_DATA = 0
  • BRICKLET_ARINC429_PARITY_AUTO = 1

Für speed:

  • BRICKLET_ARINC429_SPEED_HS = 0
  • BRICKLET_ARINC429_SPEED_LS = 1
procedure TBrickletARINC429.SetChannelMode(const channel: byte; const mode: byte)
Parameter:
  • channel – Typ: byte, Wertebereich: Siehe Konstanten
  • mode – Typ: byte, Wertebereich: Siehe Konstanten

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

Für channel:

  • BRICKLET_ARINC429_CHANNEL_TX = 0
  • BRICKLET_ARINC429_CHANNEL_TX1 = 1
  • BRICKLET_ARINC429_CHANNEL_RX = 32
  • BRICKLET_ARINC429_CHANNEL_RX1 = 33
  • BRICKLET_ARINC429_CHANNEL_RX2 = 34

Für mode:

  • BRICKLET_ARINC429_CHANNEL_MODE_PASSIVE = 0
  • BRICKLET_ARINC429_CHANNEL_MODE_ACTIVE = 1
  • BRICKLET_ARINC429_CHANNEL_MODE_RUN = 2
function TBrickletARINC429.GetChannelMode(const channel: byte): byte
Parameter:
  • channel – Typ: byte, Wertebereich: Siehe Konstanten
Rückgabe:
  • mode – Typ: byte, Wertebereich: Siehe Konstanten

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

Für channel:

  • BRICKLET_ARINC429_CHANNEL_TX = 0
  • BRICKLET_ARINC429_CHANNEL_TX1 = 1
  • BRICKLET_ARINC429_CHANNEL_RX = 32
  • BRICKLET_ARINC429_CHANNEL_RX1 = 33
  • BRICKLET_ARINC429_CHANNEL_RX2 = 34

Für mode:

  • BRICKLET_ARINC429_CHANNEL_MODE_PASSIVE = 0
  • BRICKLET_ARINC429_CHANNEL_MODE_ACTIVE = 1
  • BRICKLET_ARINC429_CHANNEL_MODE_RUN = 2
procedure TBrickletARINC429.ClearAllRXFilters(const channel: byte)
Parameter:
  • channel – Typ: byte, Wertebereich: Siehe Konstanten

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

Für channel:

  • BRICKLET_ARINC429_CHANNEL_TX = 0
  • BRICKLET_ARINC429_CHANNEL_TX1 = 1
  • BRICKLET_ARINC429_CHANNEL_RX = 32
  • BRICKLET_ARINC429_CHANNEL_RX1 = 33
  • BRICKLET_ARINC429_CHANNEL_RX2 = 34
function TBrickletARINC429.ClearRXFilter(const channel: byte; const label: byte; const sdi: byte): boolean
Parameter:
  • channel – Typ: byte, Wertebereich: Siehe Konstanten
  • label – Typ: byte, Wertebereich: [0 bis 255]
  • sdi – Typ: byte, Wertebereich: Siehe Konstanten
Rückgabe:
  • success – Typ: boolean

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

Für channel:

  • BRICKLET_ARINC429_CHANNEL_TX = 0
  • BRICKLET_ARINC429_CHANNEL_TX1 = 1
  • BRICKLET_ARINC429_CHANNEL_RX = 32
  • BRICKLET_ARINC429_CHANNEL_RX1 = 33
  • BRICKLET_ARINC429_CHANNEL_RX2 = 34

Für sdi:

  • BRICKLET_ARINC429_SDI_SDI0 = 0
  • BRICKLET_ARINC429_SDI_SDI1 = 1
  • BRICKLET_ARINC429_SDI_SDI2 = 2
  • BRICKLET_ARINC429_SDI_SDI3 = 3
  • BRICKLET_ARINC429_SDI_DATA = 4
procedure TBrickletARINC429.SetRXStandardFilters(const channel: byte)
Parameter:
  • channel – Typ: byte, Wertebereich: Siehe Konstanten

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

Für channel:

  • BRICKLET_ARINC429_CHANNEL_TX = 0
  • BRICKLET_ARINC429_CHANNEL_TX1 = 1
  • BRICKLET_ARINC429_CHANNEL_RX = 32
  • BRICKLET_ARINC429_CHANNEL_RX1 = 33
  • BRICKLET_ARINC429_CHANNEL_RX2 = 34
function TBrickletARINC429.SetRXFilter(const channel: byte; const label: byte; const sdi: byte): boolean
Parameter:
  • channel – Typ: byte, Wertebereich: Siehe Konstanten
  • label – Typ: byte, Wertebereich: [0 bis 255]
  • sdi – Typ: byte, Wertebereich: Siehe Konstanten
Rückgabe:
  • success – Typ: boolean

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

Für channel:

  • BRICKLET_ARINC429_CHANNEL_TX = 0
  • BRICKLET_ARINC429_CHANNEL_TX1 = 1
  • BRICKLET_ARINC429_CHANNEL_RX = 32
  • BRICKLET_ARINC429_CHANNEL_RX1 = 33
  • BRICKLET_ARINC429_CHANNEL_RX2 = 34

Für sdi:

  • BRICKLET_ARINC429_SDI_SDI0 = 0
  • BRICKLET_ARINC429_SDI_SDI1 = 1
  • BRICKLET_ARINC429_SDI_SDI2 = 2
  • BRICKLET_ARINC429_SDI_SDI3 = 3
  • BRICKLET_ARINC429_SDI_DATA = 4
function TBrickletARINC429.GetRXFilter(const channel: byte; const label: byte; const sdi: byte): boolean
Parameter:
  • channel – Typ: byte, Wertebereich: Siehe Konstanten
  • label – Typ: byte, Wertebereich: [0 bis 255]
  • sdi – Typ: byte, Wertebereich: Siehe Konstanten
Rückgabe:
  • configured – Typ: boolean

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

Für channel:

  • BRICKLET_ARINC429_CHANNEL_TX = 0
  • BRICKLET_ARINC429_CHANNEL_TX1 = 1
  • BRICKLET_ARINC429_CHANNEL_RX = 32
  • BRICKLET_ARINC429_CHANNEL_RX1 = 33
  • BRICKLET_ARINC429_CHANNEL_RX2 = 34

Für sdi:

  • BRICKLET_ARINC429_SDI_SDI0 = 0
  • BRICKLET_ARINC429_SDI_SDI1 = 1
  • BRICKLET_ARINC429_SDI_SDI2 = 2
  • BRICKLET_ARINC429_SDI_SDI3 = 3
  • BRICKLET_ARINC429_SDI_DATA = 4
procedure TBrickletARINC429.ReadFrame(const channel: byte; const label: byte; const sdi: byte; out status: boolean; out frame: longword; out age: word)
Parameter:
  • channel – Typ: byte, Wertebereich: Siehe Konstanten
  • label – Typ: byte, Wertebereich: [0 bis 255]
  • sdi – Typ: byte, Wertebereich: Siehe Konstanten
Ausgabeparameter:
  • status – Typ: boolean
  • frame – Typ: longword, Wertebereich: [0 bis 232 - 1]
  • age – Typ: word, Einheit: 1 ms, Wertebereich: [0 bis 216 - 1]

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

Für channel:

  • BRICKLET_ARINC429_CHANNEL_TX = 0
  • BRICKLET_ARINC429_CHANNEL_TX1 = 1
  • BRICKLET_ARINC429_CHANNEL_RX = 32
  • BRICKLET_ARINC429_CHANNEL_RX1 = 33
  • BRICKLET_ARINC429_CHANNEL_RX2 = 34

Für sdi:

  • BRICKLET_ARINC429_SDI_SDI0 = 0
  • BRICKLET_ARINC429_SDI_SDI1 = 1
  • BRICKLET_ARINC429_SDI_SDI2 = 2
  • BRICKLET_ARINC429_SDI_SDI3 = 3
  • BRICKLET_ARINC429_SDI_DATA = 4
procedure TBrickletARINC429.WriteFrameDirect(const channel: byte; const frame: longword)
Parameter:
  • channel – Typ: byte, Wertebereich: Siehe Konstanten
  • frame – Typ: longword, Wertebereich: [0 bis 232 - 1]

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

Für channel:

  • BRICKLET_ARINC429_CHANNEL_TX = 0
  • BRICKLET_ARINC429_CHANNEL_TX1 = 1
  • BRICKLET_ARINC429_CHANNEL_RX = 32
  • BRICKLET_ARINC429_CHANNEL_RX1 = 33
  • BRICKLET_ARINC429_CHANNEL_RX2 = 34
procedure TBrickletARINC429.WriteFrameScheduled(const channel: byte; const frameIndex: word; const frame: longword)
Parameter:
  • channel – Typ: byte, Wertebereich: Siehe Konstanten
  • frameIndex – Typ: word, Wertebereich: [0 bis 216 - 1]
  • frame – Typ: longword, Wertebereich: [0 bis 232 - 1]

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

Für channel:

  • BRICKLET_ARINC429_CHANNEL_TX = 0
  • BRICKLET_ARINC429_CHANNEL_TX1 = 1
  • BRICKLET_ARINC429_CHANNEL_RX = 32
  • BRICKLET_ARINC429_CHANNEL_RX1 = 33
  • BRICKLET_ARINC429_CHANNEL_RX2 = 34
procedure TBrickletARINC429.ClearScheduleEntries(const channel: byte; const jobIndexFirst: word; const jobIndexLast: word)
Parameter:
  • channel – Typ: byte, Wertebereich: Siehe Konstanten
  • jobIndexFirst – Typ: word, Wertebereich: [0 bis 216 - 1]
  • jobIndexLast – Typ: word, Wertebereich: [0 bis 216 - 1]

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

Für channel:

  • BRICKLET_ARINC429_CHANNEL_TX = 0
  • BRICKLET_ARINC429_CHANNEL_TX1 = 1
  • BRICKLET_ARINC429_CHANNEL_RX = 32
  • BRICKLET_ARINC429_CHANNEL_RX1 = 33
  • BRICKLET_ARINC429_CHANNEL_RX2 = 34
procedure TBrickletARINC429.SetScheduleEntry(const channel: byte; const jobIndex: word; const job: byte; const frameIndex: word; const dwellTime: byte)
Parameter:
  • channel – Typ: byte, Wertebereich: Siehe Konstanten
  • jobIndex – Typ: word, Wertebereich: [0 bis 216 - 1]
  • job – Typ: byte, Wertebereich: Siehe Konstanten
  • frameIndex – Typ: word, Wertebereich: [0 bis 216 - 1]
  • dwellTime – Typ: byte, Einheit: 1 ms, Wertebereich: [0 bis 255]

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

Für channel:

  • BRICKLET_ARINC429_CHANNEL_TX = 0
  • BRICKLET_ARINC429_CHANNEL_TX1 = 1
  • BRICKLET_ARINC429_CHANNEL_RX = 32
  • BRICKLET_ARINC429_CHANNEL_RX1 = 33
  • BRICKLET_ARINC429_CHANNEL_RX2 = 34

Für job:

  • BRICKLET_ARINC429_SCHEDULER_JOB_SKIP = 0
  • BRICKLET_ARINC429_SCHEDULER_JOB_CALLBACK = 1
  • BRICKLET_ARINC429_SCHEDULER_JOB_STOP = 2
  • BRICKLET_ARINC429_SCHEDULER_JOB_JUMP = 3
  • BRICKLET_ARINC429_SCHEDULER_JOB_RETURN = 4
  • BRICKLET_ARINC429_SCHEDULER_JOB_DWELL = 5
  • BRICKLET_ARINC429_SCHEDULER_JOB_SINGLE = 6
  • BRICKLET_ARINC429_SCHEDULER_JOB_CYCLIC = 7
  • BRICKLET_ARINC429_SCHEDULER_JOB_RETRANS_RX1 = 8
  • BRICKLET_ARINC429_SCHEDULER_JOB_RETRANS_RX2 = 9
procedure TBrickletARINC429.GetScheduleEntry(const channel: byte; const jobIndex: word; out job: byte; out frameIndex: word; out frame: longword; out dwellTime: byte)
Parameter:
  • channel – Typ: byte, Wertebereich: Siehe Konstanten
  • jobIndex – Typ: word, Wertebereich: [0 bis 216 - 1]
Ausgabeparameter:
  • job – Typ: byte, Wertebereich: Siehe Konstanten
  • frameIndex – Typ: word, Wertebereich: [0 bis 216 - 1]
  • frame – Typ: longword, Wertebereich: [0 bis 232 - 1]
  • dwellTime – Typ: byte, Einheit: 1 ms, Wertebereich: [0 bis 255]

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

Für channel:

  • BRICKLET_ARINC429_CHANNEL_TX = 0
  • BRICKLET_ARINC429_CHANNEL_TX1 = 1
  • BRICKLET_ARINC429_CHANNEL_RX = 32
  • BRICKLET_ARINC429_CHANNEL_RX1 = 33
  • BRICKLET_ARINC429_CHANNEL_RX2 = 34

Für job:

  • BRICKLET_ARINC429_SCHEDULER_JOB_SKIP = 0
  • BRICKLET_ARINC429_SCHEDULER_JOB_CALLBACK = 1
  • BRICKLET_ARINC429_SCHEDULER_JOB_STOP = 2
  • BRICKLET_ARINC429_SCHEDULER_JOB_JUMP = 3
  • BRICKLET_ARINC429_SCHEDULER_JOB_RETURN = 4
  • BRICKLET_ARINC429_SCHEDULER_JOB_DWELL = 5
  • BRICKLET_ARINC429_SCHEDULER_JOB_SINGLE = 6
  • BRICKLET_ARINC429_SCHEDULER_JOB_CYCLIC = 7
  • BRICKLET_ARINC429_SCHEDULER_JOB_RETRANS_RX1 = 8
  • BRICKLET_ARINC429_SCHEDULER_JOB_RETRANS_RX2 = 9
procedure TBrickletARINC429.Restart
procedure TBrickletARINC429.SetFrameMode(const channel: byte; const frameIndex: word; const mode: byte)
Parameter:
  • channel – Typ: byte, Wertebereich: Siehe Konstanten
  • frameIndex – Typ: word, Wertebereich: [0 bis 216 - 1]
  • mode – Typ: byte, Wertebereich: Siehe Konstanten

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

Für channel:

  • BRICKLET_ARINC429_CHANNEL_TX = 0
  • BRICKLET_ARINC429_CHANNEL_TX1 = 1
  • BRICKLET_ARINC429_CHANNEL_RX = 32
  • BRICKLET_ARINC429_CHANNEL_RX1 = 33
  • BRICKLET_ARINC429_CHANNEL_RX2 = 34

Für mode:

  • BRICKLET_ARINC429_TX_MODE_TRANSMIT = 0
  • BRICKLET_ARINC429_TX_MODE_MUTE = 1

Fortgeschrittene Funktionen

procedure TBrickletARINC429.GetSPITFPErrorCount(out errorCountAckChecksum: longword; out errorCountMessageChecksum: longword; out errorCountFrame: longword; out errorCountOverflow: longword)
Ausgabeparameter:
  • errorCountAckChecksum – Typ: longword, Wertebereich: [0 bis 232 - 1]
  • errorCountMessageChecksum – Typ: longword, Wertebereich: [0 bis 232 - 1]
  • errorCountFrame – Typ: longword, Wertebereich: [0 bis 232 - 1]
  • errorCountOverflow – Typ: longword, 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.

procedure TBrickletARINC429.SetStatusLEDConfig(const config: byte)
Parameter:
  • config – Typ: byte, 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:

  • BRICKLET_ARINC429_STATUS_LED_CONFIG_OFF = 0
  • BRICKLET_ARINC429_STATUS_LED_CONFIG_ON = 1
  • BRICKLET_ARINC429_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BRICKLET_ARINC429_STATUS_LED_CONFIG_SHOW_STATUS = 3
function TBrickletARINC429.GetStatusLEDConfig: byte
Rückgabe:
  • config – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: 3

Gibt die Konfiguration zurück, wie von SetStatusLEDConfig gesetzt.

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

Für config:

  • BRICKLET_ARINC429_STATUS_LED_CONFIG_OFF = 0
  • BRICKLET_ARINC429_STATUS_LED_CONFIG_ON = 1
  • BRICKLET_ARINC429_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BRICKLET_ARINC429_STATUS_LED_CONFIG_SHOW_STATUS = 3
function TBrickletARINC429.GetChipTemperature: smallint
Rückgabe:
  • temperature – Typ: smallint, 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.

procedure TBrickletARINC429.Reset

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.

procedure TBrickletARINC429.GetIdentity(out uid: string; out connectedUid: string; out position: char; out hardwareVersion: array [0..2] of byte; out firmwareVersion: array [0..2] of byte; out deviceIdentifier: word)
Ausgabeparameter:
  • uid – Typ: string, Länge: bis zu 8
  • connectedUid – Typ: string, Länge: bis zu 8
  • position – Typ: char, Wertebereich: ['a' bis 'h', 'z']
  • hardwareVersion – Typ: array [0..2] of byte
    • 0: major – Typ: byte, Wertebereich: [0 bis 255]
    • 1: minor – Typ: byte, Wertebereich: [0 bis 255]
    • 2: revision – Typ: byte, Wertebereich: [0 bis 255]
  • firmwareVersion – Typ: array [0..2] of byte
    • 0: major – Typ: byte, Wertebereich: [0 bis 255]
    • 1: minor – Typ: byte, Wertebereich: [0 bis 255]
    • 2: revision – Typ: byte, Wertebereich: [0 bis 255]
  • deviceIdentifier – Typ: word, 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

procedure TBrickletARINC429.SetHeartbeatCallbackConfiguration(const channel: byte; const enabled: boolean; const valueHasToChange: boolean; const period: word)
Parameter:
  • channel – Typ: byte, Wertebereich: Siehe Konstanten
  • enabled – Typ: boolean, Standardwert: false
  • valueHasToChange – Typ: boolean, Standardwert: false
  • period – Typ: word, Einheit: 1 ms, Wertebereich: [0 bis 216 - 1]

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

Für channel:

  • BRICKLET_ARINC429_CHANNEL_TX = 0
  • BRICKLET_ARINC429_CHANNEL_TX1 = 1
  • BRICKLET_ARINC429_CHANNEL_RX = 32
  • BRICKLET_ARINC429_CHANNEL_RX1 = 33
  • BRICKLET_ARINC429_CHANNEL_RX2 = 34
procedure TBrickletARINC429.GetHeartbeatCallbackConfiguration(const channel: byte; out enabled: boolean; out valueHasToChange: boolean; out period: word)
Parameter:
  • channel – Typ: byte, Wertebereich: Siehe Konstanten
Ausgabeparameter:
  • enabled – Typ: boolean, Standardwert: false
  • valueHasToChange – Typ: boolean, Standardwert: false
  • period – Typ: word, Einheit: 1 ms, Wertebereich: [0 bis 216 - 1]

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

Für channel:

  • BRICKLET_ARINC429_CHANNEL_TX = 0
  • BRICKLET_ARINC429_CHANNEL_TX1 = 1
  • BRICKLET_ARINC429_CHANNEL_RX = 32
  • BRICKLET_ARINC429_CHANNEL_RX1 = 33
  • BRICKLET_ARINC429_CHANNEL_RX2 = 34
procedure TBrickletARINC429.SetRXCallbackConfiguration(const channel: byte; const enabled: boolean; const valueHasToChange: boolean; const timeout: word)
Parameter:
  • channel – Typ: byte, Wertebereich: Siehe Konstanten
  • enabled – Typ: boolean, Standardwert: false
  • valueHasToChange – Typ: boolean, Standardwert: false
  • timeout – Typ: word, Einheit: 1 ms, Wertebereich: [0 bis 216 - 1]

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

Für channel:

  • BRICKLET_ARINC429_CHANNEL_TX = 0
  • BRICKLET_ARINC429_CHANNEL_TX1 = 1
  • BRICKLET_ARINC429_CHANNEL_RX = 32
  • BRICKLET_ARINC429_CHANNEL_RX1 = 33
  • BRICKLET_ARINC429_CHANNEL_RX2 = 34
procedure TBrickletARINC429.GetRXCallbackConfiguration(const channel: byte; out enabled: boolean; out valueHasToChange: boolean; out timeout: word)
Parameter:
  • channel – Typ: byte, Wertebereich: Siehe Konstanten
Ausgabeparameter:
  • enabled – Typ: boolean, Standardwert: false
  • valueHasToChange – Typ: boolean, Standardwert: false
  • timeout – Typ: word, Einheit: 1 ms, Wertebereich: [0 bis 216 - 1]

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

Für channel:

  • BRICKLET_ARINC429_CHANNEL_TX = 0
  • BRICKLET_ARINC429_CHANNEL_TX1 = 1
  • BRICKLET_ARINC429_CHANNEL_RX = 32
  • BRICKLET_ARINC429_CHANNEL_RX1 = 33
  • BRICKLET_ARINC429_CHANNEL_RX2 = 34

Callbacks

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung erfolgt indem eine Prozedur einem Callback Property des Geräte Objektes zugewiesen wird:

procedure TExample.MyCallback(sender: TBrickletARINC429; const value: longint);
begin
  WriteLn(Format('Value: %d', [value]));
end;

arinc429.OnExample := {$ifdef FPC}@{$endif}example.MyCallback;

Die verfügbaren Callback Properties und ihre Parametertypen 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.

property TBrickletARINC429.OnHeartbeatMessage
procedure(sender: TBrickletARINC429; const channel: byte; const status: byte; const seqNumber: byte; const timestamp: word; const framesProcessed: word; const framesLost: word) of object;
Callback-Parameter:
  • sender – Typ: TBrickletARINC429
  • channel – Typ: byte, Wertebereich: Siehe Konstanten
  • status – Typ: byte, Wertebereich: Siehe Konstanten
  • seqNumber – Typ: byte, Wertebereich: [0 bis 255]
  • timestamp – Typ: word, Wertebereich: [0 bis 216 - 1]
  • framesProcessed – Typ: word, Wertebereich: [0 bis 216 - 1]
  • framesLost – Typ: word, Wertebereich: [0 bis 216 - 1]

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

Für channel:

  • BRICKLET_ARINC429_CHANNEL_TX = 0
  • BRICKLET_ARINC429_CHANNEL_TX1 = 1
  • BRICKLET_ARINC429_CHANNEL_RX = 32
  • BRICKLET_ARINC429_CHANNEL_RX1 = 33
  • BRICKLET_ARINC429_CHANNEL_RX2 = 34

Für status:

  • BRICKLET_ARINC429_STATUS_NEW = 0
  • BRICKLET_ARINC429_STATUS_UPDATE = 1
  • BRICKLET_ARINC429_STATUS_TIMEOUT = 2
  • BRICKLET_ARINC429_STATUS_SCHEDULER = 3
  • BRICKLET_ARINC429_STATUS_STATISTICS = 4
property TBrickletARINC429.OnFrameMessage
procedure(sender: TBrickletARINC429; const channel: byte; const status: byte; const seqNumber: byte; const timestamp: word; const frame: longword; const age: word) of object;
Callback-Parameter:
  • sender – Typ: TBrickletARINC429
  • channel – Typ: byte, Wertebereich: Siehe Konstanten
  • status – Typ: byte, Wertebereich: Siehe Konstanten
  • seqNumber – Typ: byte, Wertebereich: [0 bis 255]
  • timestamp – Typ: word, Wertebereich: [0 bis 216 - 1]
  • frame – Typ: longword, Wertebereich: [0 bis 232 - 1]
  • age – Typ: word, Einheit: 1 ms, Wertebereich: [0 bis 216 - 1]

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

Für channel:

  • BRICKLET_ARINC429_CHANNEL_TX = 0
  • BRICKLET_ARINC429_CHANNEL_TX1 = 1
  • BRICKLET_ARINC429_CHANNEL_RX = 32
  • BRICKLET_ARINC429_CHANNEL_RX1 = 33
  • BRICKLET_ARINC429_CHANNEL_RX2 = 34

Für status:

  • BRICKLET_ARINC429_STATUS_NEW = 0
  • BRICKLET_ARINC429_STATUS_UPDATE = 1
  • BRICKLET_ARINC429_STATUS_TIMEOUT = 2
  • BRICKLET_ARINC429_STATUS_SCHEDULER = 3
  • BRICKLET_ARINC429_STATUS_STATISTICS = 4
property TBrickletARINC429.OnSchedulerMessage
procedure(sender: TBrickletARINC429; const channel: byte; const status: byte; const seqNumber: byte; const timestamp: word; const userdata: byte) of object;
Callback-Parameter:
  • sender – Typ: TBrickletARINC429
  • channel – Typ: byte, Wertebereich: Siehe Konstanten
  • status – Typ: byte, Wertebereich: Siehe Konstanten
  • seqNumber – Typ: byte, Wertebereich: [0 bis 255]
  • timestamp – Typ: word, Wertebereich: [0 bis 216 - 1]
  • userdata – Typ: byte, Wertebereich: [0 bis 255]

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

Für channel:

  • BRICKLET_ARINC429_CHANNEL_TX = 0
  • BRICKLET_ARINC429_CHANNEL_TX1 = 1
  • BRICKLET_ARINC429_CHANNEL_RX = 32
  • BRICKLET_ARINC429_CHANNEL_RX1 = 33
  • BRICKLET_ARINC429_CHANNEL_RX2 = 34

Für status:

  • BRICKLET_ARINC429_STATUS_NEW = 0
  • BRICKLET_ARINC429_STATUS_UPDATE = 1
  • BRICKLET_ARINC429_STATUS_TIMEOUT = 2
  • BRICKLET_ARINC429_STATUS_SCHEDULER = 3
  • BRICKLET_ARINC429_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.

function TBrickletARINC429.GetAPIVersion: array [0..2] of byte
Ausgabeparameter:
  • apiVersion – Typ: array [0..2] of byte
    • 0: major – Typ: byte, Wertebereich: [0 bis 255]
    • 1: minor – Typ: byte, Wertebereich: [0 bis 255]
    • 2: revision – Typ: byte, 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.

function TBrickletARINC429.GetResponseExpected(const functionId: byte): boolean
Parameter:
  • functionId – Typ: byte, Wertebereich: Siehe Konstanten
Rückgabe:
  • responseExpected – Typ: boolean

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 SetResponseExpected. 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 functionId:

  • BRICKLET_ARINC429_FUNCTION_SET_HEARTBEAT_CALLBACK_CONFIGURATION = 2
  • BRICKLET_ARINC429_FUNCTION_SET_CHANNEL_CONFIGURATION = 5
  • BRICKLET_ARINC429_FUNCTION_SET_CHANNEL_MODE = 7
  • BRICKLET_ARINC429_FUNCTION_CLEAR_ALL_RX_FILTERS = 9
  • BRICKLET_ARINC429_FUNCTION_SET_RX_STANDARD_FILTERS = 11
  • BRICKLET_ARINC429_FUNCTION_SET_RX_CALLBACK_CONFIGURATION = 15
  • BRICKLET_ARINC429_FUNCTION_WRITE_FRAME_DIRECT = 18
  • BRICKLET_ARINC429_FUNCTION_WRITE_FRAME_SCHEDULED = 19
  • BRICKLET_ARINC429_FUNCTION_CLEAR_SCHEDULE_ENTRIES = 20
  • BRICKLET_ARINC429_FUNCTION_SET_SCHEDULE_ENTRY = 21
  • BRICKLET_ARINC429_FUNCTION_RESTART = 23
  • BRICKLET_ARINC429_FUNCTION_SET_FRAME_MODE = 25
  • BRICKLET_ARINC429_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BRICKLET_ARINC429_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BRICKLET_ARINC429_FUNCTION_RESET = 243
  • BRICKLET_ARINC429_FUNCTION_WRITE_UID = 248
procedure TBrickletARINC429.SetResponseExpected(const functionId: byte; const responseExpected: boolean)
Parameter:
  • functionId – Typ: byte, Wertebereich: Siehe Konstanten
  • responseExpected – Typ: boolean

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

  • BRICKLET_ARINC429_FUNCTION_SET_HEARTBEAT_CALLBACK_CONFIGURATION = 2
  • BRICKLET_ARINC429_FUNCTION_SET_CHANNEL_CONFIGURATION = 5
  • BRICKLET_ARINC429_FUNCTION_SET_CHANNEL_MODE = 7
  • BRICKLET_ARINC429_FUNCTION_CLEAR_ALL_RX_FILTERS = 9
  • BRICKLET_ARINC429_FUNCTION_SET_RX_STANDARD_FILTERS = 11
  • BRICKLET_ARINC429_FUNCTION_SET_RX_CALLBACK_CONFIGURATION = 15
  • BRICKLET_ARINC429_FUNCTION_WRITE_FRAME_DIRECT = 18
  • BRICKLET_ARINC429_FUNCTION_WRITE_FRAME_SCHEDULED = 19
  • BRICKLET_ARINC429_FUNCTION_CLEAR_SCHEDULE_ENTRIES = 20
  • BRICKLET_ARINC429_FUNCTION_SET_SCHEDULE_ENTRY = 21
  • BRICKLET_ARINC429_FUNCTION_RESTART = 23
  • BRICKLET_ARINC429_FUNCTION_SET_FRAME_MODE = 25
  • BRICKLET_ARINC429_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BRICKLET_ARINC429_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BRICKLET_ARINC429_FUNCTION_RESET = 243
  • BRICKLET_ARINC429_FUNCTION_WRITE_UID = 248
procedure TBrickletARINC429.SetResponseExpectedAll(const responseExpected: boolean)
Parameter:
  • responseExpected – Typ: boolean

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

function TBrickletARINC429.SetBootloaderMode(const mode: byte): byte
Parameter:
  • mode – Typ: byte, Wertebereich: Siehe Konstanten
Rückgabe:
  • status – Typ: byte, 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:

  • BRICKLET_ARINC429_BOOTLOADER_MODE_BOOTLOADER = 0
  • BRICKLET_ARINC429_BOOTLOADER_MODE_FIRMWARE = 1
  • BRICKLET_ARINC429_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BRICKLET_ARINC429_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BRICKLET_ARINC429_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für status:

  • BRICKLET_ARINC429_BOOTLOADER_STATUS_OK = 0
  • BRICKLET_ARINC429_BOOTLOADER_STATUS_INVALID_MODE = 1
  • BRICKLET_ARINC429_BOOTLOADER_STATUS_NO_CHANGE = 2
  • BRICKLET_ARINC429_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • BRICKLET_ARINC429_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • BRICKLET_ARINC429_BOOTLOADER_STATUS_CRC_MISMATCH = 5
function TBrickletARINC429.GetBootloaderMode: byte
Rückgabe:
  • mode – Typ: byte, Wertebereich: Siehe Konstanten

Gibt den aktuellen Bootloader-Modus zurück, siehe SetBootloaderMode.

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

Für mode:

  • BRICKLET_ARINC429_BOOTLOADER_MODE_BOOTLOADER = 0
  • BRICKLET_ARINC429_BOOTLOADER_MODE_FIRMWARE = 1
  • BRICKLET_ARINC429_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BRICKLET_ARINC429_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BRICKLET_ARINC429_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
procedure TBrickletARINC429.SetWriteFirmwarePointer(const pointer: longword)
Parameter:
  • pointer – Typ: longword, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]

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

function TBrickletARINC429.WriteFirmware(const data: array [0..63] of byte): byte
Parameter:
  • data – Typ: array [0..63] of byte, Wertebereich: [0 bis 255]
Rückgabe:
  • status – Typ: byte, Wertebereich: [0 bis 255]

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

procedure TBrickletARINC429.WriteUID(const uid: longword)
Parameter:
  • uid – Typ: longword, 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.

function TBrickletARINC429.ReadUID: longword
Rückgabe:
  • uid – Typ: longword, 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

const BRICKLET_ARINC429_DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein ARINC429 Bricklet zu identifizieren.

Die GetIdentity Funktion und der TIPConnection.OnEnumerate Callback der IP Connection haben ein deviceIdentifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

const BRICKLET_ARINC429_DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines ARINC429 Bricklet dar.