Visual Basic .NET - 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 Visual Basic .NET 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 Visual Basic .NET API
Bindings ist Teil deren allgemeine Beschreibung.
API
Da Visual Basic .NET nicht mehrere Rückgabewerte direkt unterstützt, wird das
ByRef
Schlüsselwort genutzt um mehrere Werte von einer Funktion zurückzugeben.
Alle folgend aufgelisteten Funktionen und Prozeduren sind Thread-sicher.
Grundfunktionen
-
Class
BrickletARINC429
(ByVal uid As String, ByVal ipcon As IPConnection)
Erzeugt ein Objekt mit der eindeutigen Geräte ID uid
:
Dim arinc429 As New BrickletARINC429("YOUR_DEVICE_UID", ipcon)
Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.
-
Sub
BrickletARINC429.
GetCapabilities
(ByRef txTotalSchedulerJobs As Integer, ByRef txUsedSchedulerJobs As Integer, ByRef rxTotalFrameFilters As Integer, ByRef rxUsedFrameFilters() As Integer)
Ausgabeparameter: | - txTotalSchedulerJobs – Typ: Integer, Wertebereich: [0 bis 216 - 1]
- txUsedSchedulerJobs – Typ: Integer, Wertebereich: [0 bis 216 - 1]
- rxTotalFrameFilters – Typ: Integer, Wertebereich: [0 bis 216 - 1]
- rxUsedFrameFilters – Typ: Integer Array, Länge: 2, Wertebereich: [0 bis 216 - 1]
|
-
Sub
BrickletARINC429.
SetChannelConfiguration
(ByVal channel As Byte, ByVal parity As Byte, ByVal speed As 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:
- BrickletARINC429.CHANNEL_TX = 0
- BrickletARINC429.CHANNEL_TX1 = 1
- BrickletARINC429.CHANNEL_RX = 32
- BrickletARINC429.CHANNEL_RX1 = 33
- BrickletARINC429.CHANNEL_RX2 = 34
Für parity:
- BrickletARINC429.PARITY_DATA = 0
- BrickletARINC429.PARITY_AUTO = 1
Für speed:
- BrickletARINC429.SPEED_HS = 0
- BrickletARINC429.SPEED_LS = 1
-
Sub
BrickletARINC429.
GetChannelConfiguration
(ByVal channel As Byte, ByRef parity As Byte, ByRef speed As 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:
- BrickletARINC429.CHANNEL_TX = 0
- BrickletARINC429.CHANNEL_TX1 = 1
- BrickletARINC429.CHANNEL_RX = 32
- BrickletARINC429.CHANNEL_RX1 = 33
- BrickletARINC429.CHANNEL_RX2 = 34
Für parity:
- BrickletARINC429.PARITY_DATA = 0
- BrickletARINC429.PARITY_AUTO = 1
Für speed:
- BrickletARINC429.SPEED_HS = 0
- BrickletARINC429.SPEED_LS = 1
-
Sub
BrickletARINC429.
SetChannelMode
(ByVal channel As Byte, ByVal mode As 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:
- BrickletARINC429.CHANNEL_TX = 0
- BrickletARINC429.CHANNEL_TX1 = 1
- BrickletARINC429.CHANNEL_RX = 32
- BrickletARINC429.CHANNEL_RX1 = 33
- BrickletARINC429.CHANNEL_RX2 = 34
Für mode:
- BrickletARINC429.CHANNEL_MODE_PASSIVE = 0
- BrickletARINC429.CHANNEL_MODE_ACTIVE = 1
- BrickletARINC429.CHANNEL_MODE_RUN = 2
-
Function
BrickletARINC429.
GetChannelMode
(ByVal channel As Byte) As 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:
- BrickletARINC429.CHANNEL_TX = 0
- BrickletARINC429.CHANNEL_TX1 = 1
- BrickletARINC429.CHANNEL_RX = 32
- BrickletARINC429.CHANNEL_RX1 = 33
- BrickletARINC429.CHANNEL_RX2 = 34
Für mode:
- BrickletARINC429.CHANNEL_MODE_PASSIVE = 0
- BrickletARINC429.CHANNEL_MODE_ACTIVE = 1
- BrickletARINC429.CHANNEL_MODE_RUN = 2
-
Sub
BrickletARINC429.
ClearAllRXFilters
(ByVal channel As Byte)
Parameter: | - channel – Typ: Byte, Wertebereich: Siehe Konstanten
|
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für channel:
- BrickletARINC429.CHANNEL_TX = 0
- BrickletARINC429.CHANNEL_TX1 = 1
- BrickletARINC429.CHANNEL_RX = 32
- BrickletARINC429.CHANNEL_RX1 = 33
- BrickletARINC429.CHANNEL_RX2 = 34
-
Function
BrickletARINC429.
ClearRXFilter
(ByVal channel As Byte, ByVal label As Byte, ByVal sdi As Byte) As Boolean
Parameter: | - channel – Typ: Byte, Wertebereich: Siehe Konstanten
- label – Typ: Byte, Wertebereich: [0 bis 255]
- sdi – Typ: Byte, Wertebereich: Siehe Konstanten
|
Rückgabe: | |
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für channel:
- BrickletARINC429.CHANNEL_TX = 0
- BrickletARINC429.CHANNEL_TX1 = 1
- BrickletARINC429.CHANNEL_RX = 32
- BrickletARINC429.CHANNEL_RX1 = 33
- BrickletARINC429.CHANNEL_RX2 = 34
Für sdi:
- BrickletARINC429.SDI_SDI0 = 0
- BrickletARINC429.SDI_SDI1 = 1
- BrickletARINC429.SDI_SDI2 = 2
- BrickletARINC429.SDI_SDI3 = 3
- BrickletARINC429.SDI_DATA = 4
-
Sub
BrickletARINC429.
SetRXStandardFilters
(ByVal channel As Byte)
Parameter: | - channel – Typ: Byte, Wertebereich: Siehe Konstanten
|
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für channel:
- BrickletARINC429.CHANNEL_TX = 0
- BrickletARINC429.CHANNEL_TX1 = 1
- BrickletARINC429.CHANNEL_RX = 32
- BrickletARINC429.CHANNEL_RX1 = 33
- BrickletARINC429.CHANNEL_RX2 = 34
-
Function
BrickletARINC429.
SetRXFilter
(ByVal channel As Byte, ByVal label As Byte, ByVal sdi As Byte) As Boolean
Parameter: | - channel – Typ: Byte, Wertebereich: Siehe Konstanten
- label – Typ: Byte, Wertebereich: [0 bis 255]
- sdi – Typ: Byte, Wertebereich: Siehe Konstanten
|
Rückgabe: | |
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für channel:
- BrickletARINC429.CHANNEL_TX = 0
- BrickletARINC429.CHANNEL_TX1 = 1
- BrickletARINC429.CHANNEL_RX = 32
- BrickletARINC429.CHANNEL_RX1 = 33
- BrickletARINC429.CHANNEL_RX2 = 34
Für sdi:
- BrickletARINC429.SDI_SDI0 = 0
- BrickletARINC429.SDI_SDI1 = 1
- BrickletARINC429.SDI_SDI2 = 2
- BrickletARINC429.SDI_SDI3 = 3
- BrickletARINC429.SDI_DATA = 4
-
Function
BrickletARINC429.
GetRXFilter
(ByVal channel As Byte, ByVal label As Byte, ByVal sdi As Byte) As 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:
- BrickletARINC429.CHANNEL_TX = 0
- BrickletARINC429.CHANNEL_TX1 = 1
- BrickletARINC429.CHANNEL_RX = 32
- BrickletARINC429.CHANNEL_RX1 = 33
- BrickletARINC429.CHANNEL_RX2 = 34
Für sdi:
- BrickletARINC429.SDI_SDI0 = 0
- BrickletARINC429.SDI_SDI1 = 1
- BrickletARINC429.SDI_SDI2 = 2
- BrickletARINC429.SDI_SDI3 = 3
- BrickletARINC429.SDI_DATA = 4
-
Sub
BrickletARINC429.
ReadFrame
(ByVal channel As Byte, ByVal label As Byte, ByVal sdi As Byte, ByRef status As Boolean, ByRef frame As Long, ByRef age As Integer)
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: Long, Wertebereich: [0 bis 232 - 1]
- age – Typ: Integer, Einheit: 1 ms, Wertebereich: [0 bis 216 - 1]
|
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für channel:
- BrickletARINC429.CHANNEL_TX = 0
- BrickletARINC429.CHANNEL_TX1 = 1
- BrickletARINC429.CHANNEL_RX = 32
- BrickletARINC429.CHANNEL_RX1 = 33
- BrickletARINC429.CHANNEL_RX2 = 34
Für sdi:
- BrickletARINC429.SDI_SDI0 = 0
- BrickletARINC429.SDI_SDI1 = 1
- BrickletARINC429.SDI_SDI2 = 2
- BrickletARINC429.SDI_SDI3 = 3
- BrickletARINC429.SDI_DATA = 4
-
Sub
BrickletARINC429.
WriteFrameDirect
(ByVal channel As Byte, ByVal frame As Long)
Parameter: | - channel – Typ: Byte, Wertebereich: Siehe Konstanten
- frame – Typ: Long, Wertebereich: [0 bis 232 - 1]
|
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für channel:
- BrickletARINC429.CHANNEL_TX = 0
- BrickletARINC429.CHANNEL_TX1 = 1
- BrickletARINC429.CHANNEL_RX = 32
- BrickletARINC429.CHANNEL_RX1 = 33
- BrickletARINC429.CHANNEL_RX2 = 34
-
Sub
BrickletARINC429.
WriteFrameScheduled
(ByVal channel As Byte, ByVal frameIndex As Integer, ByVal frame As Long)
Parameter: | - channel – Typ: Byte, Wertebereich: Siehe Konstanten
- frameIndex – Typ: Integer, Wertebereich: [0 bis 216 - 1]
- frame – Typ: Long, Wertebereich: [0 bis 232 - 1]
|
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für channel:
- BrickletARINC429.CHANNEL_TX = 0
- BrickletARINC429.CHANNEL_TX1 = 1
- BrickletARINC429.CHANNEL_RX = 32
- BrickletARINC429.CHANNEL_RX1 = 33
- BrickletARINC429.CHANNEL_RX2 = 34
-
Sub
BrickletARINC429.
ClearScheduleEntries
(ByVal channel As Byte, ByVal jobIndexFirst As Integer, ByVal jobIndexLast As Integer)
Parameter: | - channel – Typ: Byte, Wertebereich: Siehe Konstanten
- jobIndexFirst – Typ: Integer, Wertebereich: [0 bis 216 - 1]
- jobIndexLast – Typ: Integer, Wertebereich: [0 bis 216 - 1]
|
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für channel:
- BrickletARINC429.CHANNEL_TX = 0
- BrickletARINC429.CHANNEL_TX1 = 1
- BrickletARINC429.CHANNEL_RX = 32
- BrickletARINC429.CHANNEL_RX1 = 33
- BrickletARINC429.CHANNEL_RX2 = 34
-
Sub
BrickletARINC429.
SetScheduleEntry
(ByVal channel As Byte, ByVal jobIndex As Integer, ByVal job As Byte, ByVal frameIndex As Integer, ByVal dwellTime As Byte)
Parameter: | - channel – Typ: Byte, Wertebereich: Siehe Konstanten
- jobIndex – Typ: Integer, Wertebereich: [0 bis 216 - 1]
- job – Typ: Byte, Wertebereich: Siehe Konstanten
- frameIndex – Typ: Integer, 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:
- BrickletARINC429.CHANNEL_TX = 0
- BrickletARINC429.CHANNEL_TX1 = 1
- BrickletARINC429.CHANNEL_RX = 32
- BrickletARINC429.CHANNEL_RX1 = 33
- BrickletARINC429.CHANNEL_RX2 = 34
Für job:
- BrickletARINC429.SCHEDULER_JOB_SKIP = 0
- BrickletARINC429.SCHEDULER_JOB_CALLBACK = 1
- BrickletARINC429.SCHEDULER_JOB_STOP = 2
- BrickletARINC429.SCHEDULER_JOB_JUMP = 3
- BrickletARINC429.SCHEDULER_JOB_RETURN = 4
- BrickletARINC429.SCHEDULER_JOB_DWELL = 5
- BrickletARINC429.SCHEDULER_JOB_SINGLE = 6
- BrickletARINC429.SCHEDULER_JOB_CYCLIC = 7
- BrickletARINC429.SCHEDULER_JOB_RETRANS_RX1 = 8
- BrickletARINC429.SCHEDULER_JOB_RETRANS_RX2 = 9
-
Sub
BrickletARINC429.
GetScheduleEntry
(ByVal channel As Byte, ByVal jobIndex As Integer, ByRef job As Byte, ByRef frameIndex As Integer, ByRef frame As Long, ByRef dwellTime As Byte)
Parameter: | - channel – Typ: Byte, Wertebereich: Siehe Konstanten
- jobIndex – Typ: Integer, Wertebereich: [0 bis 216 - 1]
|
Ausgabeparameter: | - job – Typ: Byte, Wertebereich: Siehe Konstanten
- frameIndex – Typ: Integer, Wertebereich: [0 bis 216 - 1]
- frame – Typ: Long, 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:
- BrickletARINC429.CHANNEL_TX = 0
- BrickletARINC429.CHANNEL_TX1 = 1
- BrickletARINC429.CHANNEL_RX = 32
- BrickletARINC429.CHANNEL_RX1 = 33
- BrickletARINC429.CHANNEL_RX2 = 34
Für job:
- BrickletARINC429.SCHEDULER_JOB_SKIP = 0
- BrickletARINC429.SCHEDULER_JOB_CALLBACK = 1
- BrickletARINC429.SCHEDULER_JOB_STOP = 2
- BrickletARINC429.SCHEDULER_JOB_JUMP = 3
- BrickletARINC429.SCHEDULER_JOB_RETURN = 4
- BrickletARINC429.SCHEDULER_JOB_DWELL = 5
- BrickletARINC429.SCHEDULER_JOB_SINGLE = 6
- BrickletARINC429.SCHEDULER_JOB_CYCLIC = 7
- BrickletARINC429.SCHEDULER_JOB_RETRANS_RX1 = 8
- BrickletARINC429.SCHEDULER_JOB_RETRANS_RX2 = 9
-
Sub
BrickletARINC429.
Restart
()
-
Sub
BrickletARINC429.
SetFrameMode
(ByVal channel As Byte, ByVal frameIndex As Integer, ByVal mode As Byte)
Parameter: | - channel – Typ: Byte, Wertebereich: Siehe Konstanten
- frameIndex – Typ: Integer, Wertebereich: [0 bis 216 - 1]
- mode – Typ: Byte, Wertebereich: Siehe Konstanten
|
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für channel:
- BrickletARINC429.CHANNEL_TX = 0
- BrickletARINC429.CHANNEL_TX1 = 1
- BrickletARINC429.CHANNEL_RX = 32
- BrickletARINC429.CHANNEL_RX1 = 33
- BrickletARINC429.CHANNEL_RX2 = 34
Für mode:
- BrickletARINC429.TX_MODE_TRANSMIT = 0
- BrickletARINC429.TX_MODE_MUTE = 1
Fortgeschrittene Funktionen
-
Sub
BrickletARINC429.
GetSPITFPErrorCount
(ByRef errorCountAckChecksum As Long, ByRef errorCountMessageChecksum As Long, ByRef errorCountFrame As Long, ByRef errorCountOverflow As Long)
Ausgabeparameter: | - errorCountAckChecksum – Typ: Long, Wertebereich: [0 bis 232 - 1]
- errorCountMessageChecksum – Typ: Long, Wertebereich: [0 bis 232 - 1]
- errorCountFrame – Typ: Long, Wertebereich: [0 bis 232 - 1]
- errorCountOverflow – Typ: Long, 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.
-
Sub
BrickletARINC429.
SetStatusLEDConfig
(ByVal config As 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:
- BrickletARINC429.STATUS_LED_CONFIG_OFF = 0
- BrickletARINC429.STATUS_LED_CONFIG_ON = 1
- BrickletARINC429.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
- BrickletARINC429.STATUS_LED_CONFIG_SHOW_STATUS = 3
-
Function
BrickletARINC429.
GetStatusLEDConfig
() As 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:
- BrickletARINC429.STATUS_LED_CONFIG_OFF = 0
- BrickletARINC429.STATUS_LED_CONFIG_ON = 1
- BrickletARINC429.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
- BrickletARINC429.STATUS_LED_CONFIG_SHOW_STATUS = 3
-
Function
BrickletARINC429.
GetChipTemperature
() As Short
Rückgabe: | - temperature – Typ: Short, 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.
-
Sub
BrickletARINC429.
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.
-
Sub
BrickletARINC429.
GetIdentity
(ByRef uid As String, ByRef connectedUid As String, ByRef position As Char, ByRef hardwareVersion() As Byte, ByRef firmwareVersion() As Byte, ByRef deviceIdentifier As Integer)
Ausgabeparameter: | - uid – Typ: String, Länge: bis zu 8
- connectedUid – Typ: String, Länge: bis zu 8
- position – Typ: Char, Wertebereich: ["a"C bis "h"C, "z"C]
- hardwareVersion – Typ: Byte Array, Länge: 3
- 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: Byte Array, Länge: 3
- 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: Integer, 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
-
Sub
BrickletARINC429.
SetHeartbeatCallbackConfiguration
(ByVal channel As Byte, ByVal enabled As Boolean, ByVal valueHasToChange As Boolean, ByVal period As Integer)
Parameter: | - channel – Typ: Byte, Wertebereich: Siehe Konstanten
- enabled – Typ: Boolean, Standardwert: false
- valueHasToChange – Typ: Boolean, Standardwert: false
- period – Typ: Integer, Einheit: 1 ms, Wertebereich: [0 bis 216 - 1]
|
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für channel:
- BrickletARINC429.CHANNEL_TX = 0
- BrickletARINC429.CHANNEL_TX1 = 1
- BrickletARINC429.CHANNEL_RX = 32
- BrickletARINC429.CHANNEL_RX1 = 33
- BrickletARINC429.CHANNEL_RX2 = 34
-
Sub
BrickletARINC429.
GetHeartbeatCallbackConfiguration
(ByVal channel As Byte, ByRef enabled As Boolean, ByRef valueHasToChange As Boolean, ByRef period As Integer)
Parameter: | - channel – Typ: Byte, Wertebereich: Siehe Konstanten
|
Ausgabeparameter: | - enabled – Typ: Boolean, Standardwert: false
- valueHasToChange – Typ: Boolean, Standardwert: false
- period – Typ: Integer, Einheit: 1 ms, Wertebereich: [0 bis 216 - 1]
|
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für channel:
- BrickletARINC429.CHANNEL_TX = 0
- BrickletARINC429.CHANNEL_TX1 = 1
- BrickletARINC429.CHANNEL_RX = 32
- BrickletARINC429.CHANNEL_RX1 = 33
- BrickletARINC429.CHANNEL_RX2 = 34
-
Sub
BrickletARINC429.
SetRXCallbackConfiguration
(ByVal channel As Byte, ByVal enabled As Boolean, ByVal valueHasToChange As Boolean, ByVal timeout As Integer)
Parameter: | - channel – Typ: Byte, Wertebereich: Siehe Konstanten
- enabled – Typ: Boolean, Standardwert: false
- valueHasToChange – Typ: Boolean, Standardwert: false
- timeout – Typ: Integer, Einheit: 1 ms, Wertebereich: [0 bis 216 - 1]
|
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für channel:
- BrickletARINC429.CHANNEL_TX = 0
- BrickletARINC429.CHANNEL_TX1 = 1
- BrickletARINC429.CHANNEL_RX = 32
- BrickletARINC429.CHANNEL_RX1 = 33
- BrickletARINC429.CHANNEL_RX2 = 34
-
Sub
BrickletARINC429.
GetRXCallbackConfiguration
(ByVal channel As Byte, ByRef enabled As Boolean, ByRef valueHasToChange As Boolean, ByRef timeout As Integer)
Parameter: | - channel – Typ: Byte, Wertebereich: Siehe Konstanten
|
Ausgabeparameter: | - enabled – Typ: Boolean, Standardwert: false
- valueHasToChange – Typ: Boolean, Standardwert: false
- timeout – Typ: Integer, Einheit: 1 ms, Wertebereich: [0 bis 216 - 1]
|
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für channel:
- BrickletARINC429.CHANNEL_TX = 0
- BrickletARINC429.CHANNEL_TX1 = 1
- BrickletARINC429.CHANNEL_RX = 32
- BrickletARINC429.CHANNEL_RX1 = 33
- BrickletARINC429.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:
Sub MyCallback(ByVal sender As BrickletARINC429, ByVal value As Short)
Console.WriteLine("Value: {0}", value)
End Sub
AddHandler arinc429.ExampleCallback, AddressOf 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.
-
Event
BrickletARINC429.
HeartbeatMessageCallback
(ByVal sender As BrickletARINC429, ByVal channel As Byte, ByVal status As Byte, ByVal seqNumber As Byte, ByVal timestamp As Integer, ByVal framesProcessed As Integer, ByVal framesLost As Integer)
Callback-Parameter: | - sender – Typ: BrickletARINC429
- channel – Typ: Byte, Wertebereich: Siehe Konstanten
- status – Typ: Byte, Wertebereich: Siehe Konstanten
- seqNumber – Typ: Byte, Wertebereich: [0 bis 255]
- timestamp – Typ: Integer, Wertebereich: [0 bis 216 - 1]
- framesProcessed – Typ: Integer, Wertebereich: [0 bis 216 - 1]
- framesLost – Typ: Integer, Wertebereich: [0 bis 216 - 1]
|
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für channel:
- BrickletARINC429.CHANNEL_TX = 0
- BrickletARINC429.CHANNEL_TX1 = 1
- BrickletARINC429.CHANNEL_RX = 32
- BrickletARINC429.CHANNEL_RX1 = 33
- BrickletARINC429.CHANNEL_RX2 = 34
Für status:
- BrickletARINC429.STATUS_NEW = 0
- BrickletARINC429.STATUS_UPDATE = 1
- BrickletARINC429.STATUS_TIMEOUT = 2
- BrickletARINC429.STATUS_SCHEDULER = 3
- BrickletARINC429.STATUS_STATISTICS = 4
-
Event
BrickletARINC429.
FrameMessageCallback
(ByVal sender As BrickletARINC429, ByVal channel As Byte, ByVal status As Byte, ByVal seqNumber As Byte, ByVal timestamp As Integer, ByVal frame As Long, ByVal age As Integer)
Callback-Parameter: | - sender – Typ: BrickletARINC429
- channel – Typ: Byte, Wertebereich: Siehe Konstanten
- status – Typ: Byte, Wertebereich: Siehe Konstanten
- seqNumber – Typ: Byte, Wertebereich: [0 bis 255]
- timestamp – Typ: Integer, Wertebereich: [0 bis 216 - 1]
- frame – Typ: Long, Wertebereich: [0 bis 232 - 1]
- age – Typ: Integer, Einheit: 1 ms, Wertebereich: [0 bis 216 - 1]
|
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für channel:
- BrickletARINC429.CHANNEL_TX = 0
- BrickletARINC429.CHANNEL_TX1 = 1
- BrickletARINC429.CHANNEL_RX = 32
- BrickletARINC429.CHANNEL_RX1 = 33
- BrickletARINC429.CHANNEL_RX2 = 34
Für status:
- BrickletARINC429.STATUS_NEW = 0
- BrickletARINC429.STATUS_UPDATE = 1
- BrickletARINC429.STATUS_TIMEOUT = 2
- BrickletARINC429.STATUS_SCHEDULER = 3
- BrickletARINC429.STATUS_STATISTICS = 4
-
Event
BrickletARINC429.
SchedulerMessageCallback
(ByVal sender As BrickletARINC429, ByVal channel As Byte, ByVal status As Byte, ByVal seqNumber As Byte, ByVal timestamp As Integer, ByVal userdata As Byte)
Callback-Parameter: | - sender – Typ: BrickletARINC429
- channel – Typ: Byte, Wertebereich: Siehe Konstanten
- status – Typ: Byte, Wertebereich: Siehe Konstanten
- seqNumber – Typ: Byte, Wertebereich: [0 bis 255]
- timestamp – Typ: Integer, 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:
- BrickletARINC429.CHANNEL_TX = 0
- BrickletARINC429.CHANNEL_TX1 = 1
- BrickletARINC429.CHANNEL_RX = 32
- BrickletARINC429.CHANNEL_RX1 = 33
- BrickletARINC429.CHANNEL_RX2 = 34
Für status:
- BrickletARINC429.STATUS_NEW = 0
- BrickletARINC429.STATUS_UPDATE = 1
- BrickletARINC429.STATUS_TIMEOUT = 2
- BrickletARINC429.STATUS_SCHEDULER = 3
- BrickletARINC429.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
BrickletARINC429.
GetAPIVersion
() As Byte()
Ausgabeparameter: | - apiVersion – Typ: Byte Array, Länge: 3
- 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
BrickletARINC429.
GetResponseExpected
(ByVal functionId As Byte) As 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:
- BrickletARINC429.FUNCTION_SET_HEARTBEAT_CALLBACK_CONFIGURATION = 2
- BrickletARINC429.FUNCTION_SET_CHANNEL_CONFIGURATION = 5
- BrickletARINC429.FUNCTION_SET_CHANNEL_MODE = 7
- BrickletARINC429.FUNCTION_CLEAR_ALL_RX_FILTERS = 9
- BrickletARINC429.FUNCTION_SET_RX_STANDARD_FILTERS = 11
- BrickletARINC429.FUNCTION_SET_RX_CALLBACK_CONFIGURATION = 15
- BrickletARINC429.FUNCTION_WRITE_FRAME_DIRECT = 18
- BrickletARINC429.FUNCTION_WRITE_FRAME_SCHEDULED = 19
- BrickletARINC429.FUNCTION_CLEAR_SCHEDULE_ENTRIES = 20
- BrickletARINC429.FUNCTION_SET_SCHEDULE_ENTRY = 21
- BrickletARINC429.FUNCTION_RESTART = 23
- BrickletARINC429.FUNCTION_SET_FRAME_MODE = 25
- BrickletARINC429.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
- BrickletARINC429.FUNCTION_SET_STATUS_LED_CONFIG = 239
- BrickletARINC429.FUNCTION_RESET = 243
- BrickletARINC429.FUNCTION_WRITE_UID = 248
-
Sub
BrickletARINC429.
SetResponseExpected
(ByVal functionId As Byte, ByVal responseExpected As 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:
- BrickletARINC429.FUNCTION_SET_HEARTBEAT_CALLBACK_CONFIGURATION = 2
- BrickletARINC429.FUNCTION_SET_CHANNEL_CONFIGURATION = 5
- BrickletARINC429.FUNCTION_SET_CHANNEL_MODE = 7
- BrickletARINC429.FUNCTION_CLEAR_ALL_RX_FILTERS = 9
- BrickletARINC429.FUNCTION_SET_RX_STANDARD_FILTERS = 11
- BrickletARINC429.FUNCTION_SET_RX_CALLBACK_CONFIGURATION = 15
- BrickletARINC429.FUNCTION_WRITE_FRAME_DIRECT = 18
- BrickletARINC429.FUNCTION_WRITE_FRAME_SCHEDULED = 19
- BrickletARINC429.FUNCTION_CLEAR_SCHEDULE_ENTRIES = 20
- BrickletARINC429.FUNCTION_SET_SCHEDULE_ENTRY = 21
- BrickletARINC429.FUNCTION_RESTART = 23
- BrickletARINC429.FUNCTION_SET_FRAME_MODE = 25
- BrickletARINC429.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
- BrickletARINC429.FUNCTION_SET_STATUS_LED_CONFIG = 239
- BrickletARINC429.FUNCTION_RESET = 243
- BrickletARINC429.FUNCTION_WRITE_UID = 248
-
Sub
BrickletARINC429.
SetResponseExpectedAll
(ByVal responseExpected As 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
BrickletARINC429.
SetBootloaderMode
(ByVal mode As Byte) As 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:
- BrickletARINC429.BOOTLOADER_MODE_BOOTLOADER = 0
- BrickletARINC429.BOOTLOADER_MODE_FIRMWARE = 1
- BrickletARINC429.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
- BrickletARINC429.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
- BrickletARINC429.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
Für status:
- BrickletARINC429.BOOTLOADER_STATUS_OK = 0
- BrickletARINC429.BOOTLOADER_STATUS_INVALID_MODE = 1
- BrickletARINC429.BOOTLOADER_STATUS_NO_CHANGE = 2
- BrickletARINC429.BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
- BrickletARINC429.BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
- BrickletARINC429.BOOTLOADER_STATUS_CRC_MISMATCH = 5
-
Function
BrickletARINC429.
GetBootloaderMode
() As 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:
- BrickletARINC429.BOOTLOADER_MODE_BOOTLOADER = 0
- BrickletARINC429.BOOTLOADER_MODE_FIRMWARE = 1
- BrickletARINC429.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
- BrickletARINC429.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
- BrickletARINC429.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
-
Sub
BrickletARINC429.
SetWriteFirmwarePointer
(ByVal pointer As Long)
Parameter: | - pointer – Typ: Long, 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
BrickletARINC429.
WriteFirmware
(ByVal data() As Byte) As Byte
Parameter: | - data – Typ: Byte Array, Länge: 64, 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.
-
Sub
BrickletARINC429.
WriteUID
(ByVal uid As Long)
Parameter: | - uid – Typ: Long, 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
BrickletARINC429.
ReadUID
() As Long
Rückgabe: | - uid – Typ: Long, 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
BrickletARINC429.
DEVICE_IDENTIFIER
Diese Konstante wird verwendet um ein ARINC429 Bricklet zu identifizieren.
Die GetIdentity()
Funktion und der
IPConnection.EnumerateCallback
Callback der IP Connection haben ein deviceIdentifier
Parameter um den Typ
des Bricks oder Bricklets anzugeben.
-
Const
BrickletARINC429.
DEVICE_DISPLAY_NAME
Diese Konstante stellt den Anzeigenamen eines ARINC429 Bricklet dar.