API
Prinzipiell kann jede Methode der Java Bindings eine TimeoutException
werfen. Diese Exception wird
geworfen wenn das Gerät nicht antwortet. Wenn eine Kabelverbindung genutzt
wird, ist es unwahrscheinlich, dass die Exception geworfen wird (unter der
Annahme, dass das Gerät nicht abgesteckt wird). Bei einer drahtlosen Verbindung
können Zeitüberschreitungen auftreten, sobald die Entfernung zum Gerät zu
groß wird.
Neben der TimeoutException
kann auch noch eine NotConnectedException
geworfen werden, wenn versucht wird mit einem Brick oder Bricklet zu
kommunizieren, aber die IP Connection nicht verbunden ist.
Da Java nicht mehrere Rückgabewerte unterstützt und eine Referenzrückgabe
für elementare Type nicht möglich ist, werden kleine Klassen verwendet, die
nur aus Member-Variablen bestehen. Die Member-Variablen des zurückgegebenen
Objektes werden in der jeweiligen Methodenbeschreibung erläutert.
Das Package für alle Brick/Bricklet Bindings und die IP Connection ist
com.tinkerforge.*
Alle folgend aufgelisteten Methoden sind Thread-sicher.
Grundfunktionen
-
class
BrickletARINC429
(String uid, IPConnection ipcon)
Parameter: | - uid – Typ: String
- ipcon – Typ: IPConnection
|
Rückgabe: | - arinc429 – Typ: BrickletARINC429
|
Erzeugt ein Objekt mit der eindeutigen Geräte ID uid
:
BrickletARINC429 arinc429 = new BrickletARINC429("YOUR_DEVICE_UID", ipcon);
Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.
-
BrickletARINC429.Capabilities
BrickletARINC429.
getCapabilities
()
Rückgabeobjekt: | - txTotalSchedulerJobs – Typ: int, Wertebereich: [0 bis 216 - 1]
- txUsedSchedulerJobs – Typ: int, Wertebereich: [0 bis 216 - 1]
- rxTotalFrameFilters – Typ: int, Wertebereich: [0 bis 216 - 1]
- rxUsedFrameFilters – Typ: int[], Länge: 2, Wertebereich: [0 bis 216 - 1]
|
-
void
BrickletARINC429.
setChannelConfiguration
(int channel, int parity, int speed)
Parameter: | - channel – Typ: int, Wertebereich: Siehe Konstanten
- parity – Typ: int, Wertebereich: Siehe Konstanten
- speed – Typ: int, 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
-
BrickletARINC429.ChannelConfiguration
BrickletARINC429.
getChannelConfiguration
(int channel)
Parameter: | - channel – Typ: int, Wertebereich: Siehe Konstanten
|
Rückgabeobjekt: | - parity – Typ: int, Wertebereich: Siehe Konstanten
- speed – Typ: int, 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
-
void
BrickletARINC429.
setChannelMode
(int channel, int mode)
Parameter: | - channel – Typ: int, Wertebereich: Siehe Konstanten
- mode – Typ: int, 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
-
int
BrickletARINC429.
getChannelMode
(int channel)
Parameter: | - channel – Typ: int, Wertebereich: Siehe Konstanten
|
Rückgabe: | - mode – Typ: int, 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
-
void
BrickletARINC429.
clearAllRXFilters
(int channel)
Parameter: | - channel – Typ: int, 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
-
boolean
BrickletARINC429.
clearRXFilter
(int channel, int label, int sdi)
Parameter: | - channel – Typ: int, Wertebereich: Siehe Konstanten
- label – Typ: int, Wertebereich: [0 bis 255]
- sdi – Typ: int, 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
-
void
BrickletARINC429.
setRXStandardFilters
(int channel)
Parameter: | - channel – Typ: int, 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
-
boolean
BrickletARINC429.
setRXFilter
(int channel, int label, int sdi)
Parameter: | - channel – Typ: int, Wertebereich: Siehe Konstanten
- label – Typ: int, Wertebereich: [0 bis 255]
- sdi – Typ: int, 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
-
boolean
BrickletARINC429.
getRXFilter
(int channel, int label, int sdi)
Parameter: | - channel – Typ: int, Wertebereich: Siehe Konstanten
- label – Typ: int, Wertebereich: [0 bis 255]
- sdi – Typ: int, 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
-
BrickletARINC429.ReadFrame
BrickletARINC429.
readFrame
(int channel, int label, int sdi)
Parameter: | - channel – Typ: int, Wertebereich: Siehe Konstanten
- label – Typ: int, Wertebereich: [0 bis 255]
- sdi – Typ: int, Wertebereich: Siehe Konstanten
|
Rückgabeobjekt: | - status – Typ: boolean
- frame – Typ: long, Wertebereich: [0 bis 232 - 1]
- age – Typ: int, 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
-
void
BrickletARINC429.
writeFrameDirect
(int channel, long frame)
Parameter: | - channel – Typ: int, 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
-
void
BrickletARINC429.
writeFrameScheduled
(int channel, int frameIndex, long frame)
Parameter: | - channel – Typ: int, Wertebereich: Siehe Konstanten
- frameIndex – Typ: int, 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
-
void
BrickletARINC429.
clearScheduleEntries
(int channel, int jobIndexFirst, int jobIndexLast)
Parameter: | - channel – Typ: int, Wertebereich: Siehe Konstanten
- jobIndexFirst – Typ: int, Wertebereich: [0 bis 216 - 1]
- jobIndexLast – Typ: int, 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
-
void
BrickletARINC429.
setScheduleEntry
(int channel, int jobIndex, int job, int frameIndex, int dwellTime)
Parameter: | - channel – Typ: int, Wertebereich: Siehe Konstanten
- jobIndex – Typ: int, Wertebereich: [0 bis 216 - 1]
- job – Typ: int, Wertebereich: Siehe Konstanten
- frameIndex – Typ: int, Wertebereich: [0 bis 216 - 1]
- dwellTime – Typ: int, 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
-
BrickletARINC429.ScheduleEntry
BrickletARINC429.
getScheduleEntry
(int channel, int jobIndex)
Parameter: | - channel – Typ: int, Wertebereich: Siehe Konstanten
- jobIndex – Typ: int, Wertebereich: [0 bis 216 - 1]
|
Rückgabeobjekt: | - job – Typ: int, Wertebereich: Siehe Konstanten
- frameIndex – Typ: int, Wertebereich: [0 bis 216 - 1]
- frame – Typ: long, Wertebereich: [0 bis 232 - 1]
- dwellTime – Typ: int, 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
-
void
BrickletARINC429.
restart
()
-
void
BrickletARINC429.
setFrameMode
(int channel, int frameIndex, int mode)
Parameter: | - channel – Typ: int, Wertebereich: Siehe Konstanten
- frameIndex – Typ: int, Wertebereich: [0 bis 216 - 1]
- mode – Typ: int, 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
-
BrickletARINC429.SPITFPErrorCount
BrickletARINC429.
getSPITFPErrorCount
()
Rückgabeobjekt: | - 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.
-
void
BrickletARINC429.
setStatusLEDConfig
(int config)
Parameter: | - config – Typ: int, 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
-
int
BrickletARINC429.
getStatusLEDConfig
()
Rückgabe: | - config – Typ: int, 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
-
int
BrickletARINC429.
getChipTemperature
()
Rückgabe: | - temperature – Typ: int, 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.
-
void
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.
-
BrickletARINC429.Identity
BrickletARINC429.
getIdentity
()
Rückgabeobjekt: | - 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: short[], Länge: 3
- 0: major – Typ: short, Wertebereich: [0 bis 255]
- 1: minor – Typ: short, Wertebereich: [0 bis 255]
- 2: revision – Typ: short, Wertebereich: [0 bis 255]
- firmwareVersion – Typ: short[], Länge: 3
- 0: major – Typ: short, Wertebereich: [0 bis 255]
- 1: minor – Typ: short, Wertebereich: [0 bis 255]
- 2: revision – Typ: short, Wertebereich: [0 bis 255]
- deviceIdentifier – Typ: int, 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 Listener
-
void
BrickletARINC429.
setHeartbeatCallbackConfiguration
(int channel, boolean enabled, boolean valueHasToChange, int period)
Parameter: | - channel – Typ: int, Wertebereich: Siehe Konstanten
- enabled – Typ: boolean, Standardwert: false
- valueHasToChange – Typ: boolean, Standardwert: false
- period – Typ: int, 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
-
BrickletARINC429.HeartbeatCallbackConfiguration
BrickletARINC429.
getHeartbeatCallbackConfiguration
(int channel)
Parameter: | - channel – Typ: int, Wertebereich: Siehe Konstanten
|
Rückgabeobjekt: | - enabled – Typ: boolean, Standardwert: false
- valueHasToChange – Typ: boolean, Standardwert: false
- period – Typ: int, 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
-
void
BrickletARINC429.
setRXCallbackConfiguration
(int channel, boolean enabled, boolean valueHasToChange, int timeout)
Parameter: | - channel – Typ: int, Wertebereich: Siehe Konstanten
- enabled – Typ: boolean, Standardwert: false
- valueHasToChange – Typ: boolean, Standardwert: false
- timeout – Typ: int, 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
-
BrickletARINC429.RXCallbackConfiguration
BrickletARINC429.
getRXCallbackConfiguration
(int channel)
Parameter: | - channel – Typ: int, Wertebereich: Siehe Konstanten
|
Rückgabeobjekt: | - enabled – Typ: boolean, Standardwert: false
- valueHasToChange – Typ: boolean, Standardwert: false
- timeout – Typ: int, 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
Listener
Listener können registriert werden um zeitkritische
oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann
mit add*Listener()
Funktionen eines Geräteobjekts durchgeführt werden.
Der Parameter ist ein Listener Klassen Objekt, z.B.:
device.addExampleListener(new BrickletARINC429.ExampleListener() {
public void property(int value) {
System.out.println("Value: " + value);
}
});
Die verfügbaren Listener Klassen mit den Methoden welche überschrieben
werden können werden unterhalb beschrieben. Es ist möglich mehrere
Listener hinzuzufügen und auch mit einem korrespondierenden
remove*Listener()
wieder zu entfernen.
Bemerkung
Listener 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.
-
class
BrickletARINC429.
HeartbeatMessageListener
()
Dieser Listener kann mit der Funktion addHeartbeatMessageListener()
hinzugefügt werden.
Ein hinzugefügter Listener kann mit der Funktion removeHeartbeatMessageListener()
wieder
entfernt werden.
-
void
heartbeatMessage
(int channel, int status, int seqNumber, int timestamp, int framesProcessed, int framesLost)
Parameter: | - channel – Typ: int, Wertebereich: Siehe Konstanten
- status – Typ: int, Wertebereich: Siehe Konstanten
- seqNumber – Typ: int, Wertebereich: [0 bis 255]
- timestamp – Typ: int, Wertebereich: [0 bis 216 - 1]
- framesProcessed – Typ: int, Wertebereich: [0 bis 216 - 1]
- framesLost – Typ: int, 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
-
class
BrickletARINC429.
FrameMessageListener
()
Dieser Listener kann mit der Funktion addFrameMessageListener()
hinzugefügt werden.
Ein hinzugefügter Listener kann mit der Funktion removeFrameMessageListener()
wieder
entfernt werden.
-
void
frameMessage
(int channel, int status, int seqNumber, int timestamp, long frame, int age)
Parameter: | - channel – Typ: int, Wertebereich: Siehe Konstanten
- status – Typ: int, Wertebereich: Siehe Konstanten
- seqNumber – Typ: int, Wertebereich: [0 bis 255]
- timestamp – Typ: int, Wertebereich: [0 bis 216 - 1]
- frame – Typ: long, Wertebereich: [0 bis 232 - 1]
- age – Typ: int, 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
-
class
BrickletARINC429.
SchedulerMessageListener
()
Dieser Listener kann mit der Funktion addSchedulerMessageListener()
hinzugefügt werden.
Ein hinzugefügter Listener kann mit der Funktion removeSchedulerMessageListener()
wieder
entfernt werden.
-
void
schedulerMessage
(int channel, int status, int seqNumber, int timestamp, int userdata)
Parameter: | - channel – Typ: int, Wertebereich: Siehe Konstanten
- status – Typ: int, Wertebereich: Siehe Konstanten
- seqNumber – Typ: int, Wertebereich: [0 bis 255]
- timestamp – Typ: int, Wertebereich: [0 bis 216 - 1]
- userdata – Typ: int, 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.
-
short[]
BrickletARINC429.
getAPIVersion
()
Rückgabeobjekt: | - apiVersion – Typ: short[], Länge: 3
- 0: major – Typ: short, Wertebereich: [0 bis 255]
- 1: minor – Typ: short, Wertebereich: [0 bis 255]
- 2: revision – Typ: short, 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.
-
boolean
BrickletARINC429.
getResponseExpected
(byte functionId)
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 Listeners 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
-
void
BrickletARINC429.
setResponseExpected
(byte functionId, boolean responseExpected)
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 Listeners (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
-
void
BrickletARINC429.
setResponseExpectedAll
(boolean responseExpected)
Parameter: | - responseExpected – Typ: boolean
|
Ändert das Response-Expected-Flag für alle Setter-Funktionen und
Konfigurationsfunktionen für Listeners diese Gerätes.
Interne Funktionen
Interne Funktionen werden für Wartungsaufgaben, wie zum Beispiel das Flashen
einer neuen Firmware oder das Ändern der UID eines Bricklets, verwendet. Diese
Aufgaben sollten mit Brick Viewer durchgeführt werden, anstelle die internen
Funktionen direkt zu verwenden.
-
int
BrickletARINC429.
setBootloaderMode
(int mode)
Parameter: | - mode – Typ: int, Wertebereich: Siehe Konstanten
|
Rückgabe: | - status – Typ: int, 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
-
int
BrickletARINC429.
getBootloaderMode
()
Rückgabe: | - mode – Typ: int, 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
-
void
BrickletARINC429.
setWriteFirmwarePointer
(long pointer)
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.
-
int
BrickletARINC429.
writeFirmware
(int[] data)
Parameter: | - data – Typ: int[], Länge: 64, Wertebereich: [0 bis 255]
|
Rückgabe: | - status – Typ: int, 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.
-
void
BrickletARINC429.
writeUID
(long uid)
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.
-
long
BrickletARINC429.
readUID
()
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
-
int
BrickletARINC429.
DEVICE_IDENTIFIER
Diese Konstante wird verwendet um ein ARINC429 Bricklet zu identifizieren.
Die getIdentity()
Funktion und der
IPConnection.EnumerateListener
Listener der IP Connection haben ein deviceIdentifier
Parameter um den Typ
des Bricks oder Bricklets anzugeben.
-
String
BrickletARINC429.
DEVICE_DISPLAY_NAME
Diese Konstante stellt den Anzeigenamen eines ARINC429 Bricklet dar.