Perl - 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 Perl 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 Perl API
Bindings ist Teil deren allgemeine Beschreibung.
API
Allgemein kann jede Subroutine der Perl Bindings Fehler als
Tinkerforge::Error
Objekt mittels croak()
melden. Das Objekt hat eine
get_code()
und eine get_message()
Subroutine. Es sind verschiedene
Fehlercodes definiert:
- Error->ALREADY_CONNECTED = 11
- Error->NOT_CONNECTED = 12
- Error->CONNECT_FAILED = 13
- Error->INVALID_FUNCTION_ID = 21
- Error->TIMEOUT = 31
- Error->INVALID_PARAMETER = 41
- Error->FUNCTION_NOT_SUPPORTED = 42
- Error->UNKNOWN_ERROR = 43
- Error->STREAM_OUT_OF_SYNC = 51
- Error->INVALID_UID = 61
- Error->NON_ASCII_CHAR_IN_SECRET = 71
- Error->WRONG_DEVICE_TYPE = 81
- Error->DEVICE_REPLACED = 82
- Error->WRONG_RESPONSE_LENGTH = 83
Alle folgend aufgelisteten Funktionen sind Thread-sicher.
Grundfunktionen
-
BrickletARINC429
->
new
($uid, $ipcon)
Parameter: | - $uid – Typ: string
- $ipcon – Typ: IPConnection
|
Rückgabe: | - $arinc429 – Typ: BrickletARINC429
|
Erzeugt ein Objekt mit der eindeutigen Geräte ID $uid
:
$arinc429 = BrickletARINC429->new("YOUR_DEVICE_UID", $ipcon);
Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.
-
BrickletARINC429
->
get_capabilities
()
Rückgabe-Array: | - 0: $tx_total_scheduler_jobs – Typ: int, Wertebereich: [0 bis 216 - 1]
- 1: $tx_used_scheduler_jobs – Typ: int, Wertebereich: [0 bis 216 - 1]
- 2: $rx_total_frame_filters – Typ: int, Wertebereich: [0 bis 216 - 1]
- 3: \@rx_used_frame_filters – Typ: [int, ...], Länge: 2, Wertebereich: [0 bis 216 - 1]
|
-
BrickletARINC429
->
set_channel_configuration
($channel, $parity, $speed)
Parameter: | - $channel – Typ: int, Wertebereich: Siehe Konstanten
- $parity – Typ: int, Wertebereich: Siehe Konstanten
- $speed – 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 $parity:
- BrickletARINC429->PARITY_DATA = 0
- BrickletARINC429->PARITY_AUTO = 1
Für $speed:
- BrickletARINC429->SPEED_HS = 0
- BrickletARINC429->SPEED_LS = 1
-
BrickletARINC429
->
get_channel_configuration
($channel)
Parameter: | - $channel – Typ: int, Wertebereich: Siehe Konstanten
|
Rückgabe-Array: | - 0: $parity – Typ: int, Wertebereich: Siehe Konstanten
- 1: $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
->
set_channel_mode
($channel, $mode)
Parameter: | - $channel – Typ: int, Wertebereich: Siehe Konstanten
- $mode – 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 $mode:
- BrickletARINC429->CHANNEL_MODE_PASSIVE = 0
- BrickletARINC429->CHANNEL_MODE_ACTIVE = 1
- BrickletARINC429->CHANNEL_MODE_RUN = 2
-
BrickletARINC429
->
get_channel_mode
($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
-
BrickletARINC429
->
clear_all_rx_filters
($channel)
Parameter: | - $channel – 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
-
BrickletARINC429
->
clear_rx_filter
($channel, $label, $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
-
BrickletARINC429
->
set_rx_standard_filters
($channel)
Parameter: | - $channel – 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
-
BrickletARINC429
->
set_rx_filter
($channel, $label, $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
-
BrickletARINC429
->
get_rx_filter
($channel, $label, $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
-
BrickletARINC429
->
read_frame
($channel, $label, $sdi)
Parameter: | - $channel – Typ: int, Wertebereich: Siehe Konstanten
- $label – Typ: int, Wertebereich: [0 bis 255]
- $sdi – Typ: int, Wertebereich: Siehe Konstanten
|
Rückgabe-Array: | - 0: $status – Typ: bool
- 1: $frame – Typ: int, Wertebereich: [0 bis 232 - 1]
- 2: $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
-
BrickletARINC429
->
write_frame_direct
($channel, $frame)
Parameter: | - $channel – Typ: int, Wertebereich: Siehe Konstanten
- $frame – Typ: int, Wertebereich: [0 bis 232 - 1]
|
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
-
BrickletARINC429
->
write_frame_scheduled
($channel, $frame_index, $frame)
Parameter: | - $channel – Typ: int, Wertebereich: Siehe Konstanten
- $frame_index – Typ: int, Wertebereich: [0 bis 216 - 1]
- $frame – Typ: int, Wertebereich: [0 bis 232 - 1]
|
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
-
BrickletARINC429
->
clear_schedule_entries
($channel, $job_index_first, $job_index_last)
Parameter: | - $channel – Typ: int, Wertebereich: Siehe Konstanten
- $job_index_first – Typ: int, Wertebereich: [0 bis 216 - 1]
- $job_index_last – Typ: int, Wertebereich: [0 bis 216 - 1]
|
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
-
BrickletARINC429
->
set_schedule_entry
($channel, $job_index, $job, $frame_index, $dwell_time)
Parameter: | - $channel – Typ: int, Wertebereich: Siehe Konstanten
- $job_index – Typ: int, Wertebereich: [0 bis 216 - 1]
- $job – Typ: int, Wertebereich: Siehe Konstanten
- $frame_index – Typ: int, Wertebereich: [0 bis 216 - 1]
- $dwell_time – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 255]
|
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 $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
->
get_schedule_entry
($channel, $job_index)
Parameter: | - $channel – Typ: int, Wertebereich: Siehe Konstanten
- $job_index – Typ: int, Wertebereich: [0 bis 216 - 1]
|
Rückgabe-Array: | - 0: $job – Typ: int, Wertebereich: Siehe Konstanten
- 1: $frame_index – Typ: int, Wertebereich: [0 bis 216 - 1]
- 2: $frame – Typ: int, Wertebereich: [0 bis 232 - 1]
- 3: $dwell_time – 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
->
restart
()
-
BrickletARINC429
->
set_frame_mode
($channel, $frame_index, $mode)
Parameter: | - $channel – Typ: int, Wertebereich: Siehe Konstanten
- $frame_index – Typ: int, Wertebereich: [0 bis 216 - 1]
- $mode – 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 $mode:
- BrickletARINC429->TX_MODE_TRANSMIT = 0
- BrickletARINC429->TX_MODE_MUTE = 1
Fortgeschrittene Funktionen
-
BrickletARINC429
->
get_spitfp_error_count
()
Rückgabe-Array: | - 0: $error_count_ack_checksum – Typ: int, Wertebereich: [0 bis 232 - 1]
- 1: $error_count_message_checksum – Typ: int, Wertebereich: [0 bis 232 - 1]
- 2: $error_count_frame – Typ: int, Wertebereich: [0 bis 232 - 1]
- 3: $error_count_overflow – Typ: int, 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.
-
BrickletARINC429
->
set_status_led_config
($config)
Parameter: | - $config – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 3
|
Rückgabe: | |
Setzt die Konfiguration der Status-LED. Standardmäßig zeigt
die LED die Kommunikationsdatenmenge an. Sie blinkt einmal auf pro 10 empfangenen
Datenpaketen zwischen Brick und Bricklet.
Die LED kann auch permanent an/aus gestellt werden oder einen Herzschlag anzeigen.
Wenn das Bricklet sich im Bootlodermodus befindet ist die LED aus.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für $config:
- 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
-
BrickletARINC429
->
get_status_led_config
()
Rückgabe: | - $config – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 3
|
Gibt die Konfiguration zurück, wie von set_status_led_config()
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
-
BrickletARINC429
->
get_chip_temperature
()
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.
-
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
->
get_identity
()
Rückgabe-Array: | - 0: $uid – Typ: string, Länge: bis zu 8
- 1: $connected_uid – Typ: string, Länge: bis zu 8
- 2: $position – Typ: char, Wertebereich: ['a' bis 'h', 'z']
- 3: \@hardware_version – Typ: [int, ...], Länge: 3
- 0: $major – Typ: int, Wertebereich: [0 bis 255]
- 1: $minor – Typ: int, Wertebereich: [0 bis 255]
- 2: $revision – Typ: int, Wertebereich: [0 bis 255]
- 4: \@firmware_version – Typ: [int, ...], Länge: 3
- 0: $major – Typ: int, Wertebereich: [0 bis 255]
- 1: $minor – Typ: int, Wertebereich: [0 bis 255]
- 2: $revision – Typ: int, Wertebereich: [0 bis 255]
- 5: $device_identifier – 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 Callbacks
-
BrickletARINC429
->
register_callback
($callback_id, $function)
Parameter: | - $callback_id – Typ: int
- $function – Typ: string
|
Rückgabe: | |
Registriert den $function
Namen für die gegebene $callback_id
.
Die verfügbaren Callback IDs mit den zugehörigen Funktionssignaturen
sind unten zu finden.
-
BrickletARINC429
->
set_heartbeat_callback_configuration
($channel, $enabled, $value_has_to_change, $period)
Parameter: | - $channel – Typ: int, Wertebereich: Siehe Konstanten
- $enabled – Typ: bool, Standardwert: 0
- $value_has_to_change – Typ: bool, Standardwert: 0
- $period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 216 - 1]
|
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
-
BrickletARINC429
->
get_heartbeat_callback_configuration
($channel)
Parameter: | - $channel – Typ: int, Wertebereich: Siehe Konstanten
|
Rückgabe-Array: | - 0: $enabled – Typ: bool, Standardwert: 0
- 1: $value_has_to_change – Typ: bool, Standardwert: 0
- 2: $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
->
set_rx_callback_configuration
($channel, $enabled, $value_has_to_change, $timeout)
Parameter: | - $channel – Typ: int, Wertebereich: Siehe Konstanten
- $enabled – Typ: bool, Standardwert: 0
- $value_has_to_change – Typ: bool, Standardwert: 0
- $timeout – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 216 - 1]
|
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
-
BrickletARINC429
->
get_rx_callback_configuration
($channel)
Parameter: | - $channel – Typ: int, Wertebereich: Siehe Konstanten
|
Rückgabe-Array: | - 0: $enabled – Typ: bool, Standardwert: 0
- 1: $value_has_to_change – Typ: bool, Standardwert: 0
- 2: $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
Callbacks
Callbacks können registriert werden um zeitkritische
oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann
mit der Funktion register_callback()
des
Geräte Objektes durchgeführt werden. Der erste Parameter ist die Callback ID
und der zweite Parameter ist der Name der Callback-Funktion:
sub my_callback
{
print "@_[0]";
}
$arinc429->register_callback(BrickletARINC429->CALLBACK_EXAMPLE, 'my_callback')
Die Callback Funktion wird dann von einem internen Thread der IP Connection
aufgerufen werden. Im Gegensatz zu vielen anderen Programmiersprachen werden
Variablen nicht automatisch zwischen Threads geteilt. Wenn eine Variable
gleichzeitig in einer Callback Funktion und dem Rest des Programms genutzt
werden soll, dann muss diese als :shared
markiert werden. Siehe dazu auch
die Dokumentation des threads::shared Perl Moduls für weitere
Details.
Die verfügbaren IDs mit der dazugehörigen Parameteranzahl und -typen 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.
-
BrickletARINC429
->
CALLBACK_HEARTBEAT_MESSAGE
Callback-Parameter: | - $channel – Typ: int, Wertebereich: Siehe Konstanten
- $status – Typ: int, Wertebereich: Siehe Konstanten
- $seq_number – Typ: int, Wertebereich: [0 bis 255]
- $timestamp – Typ: int, Wertebereich: [0 bis 216 - 1]
- $frames_processed – Typ: int, Wertebereich: [0 bis 216 - 1]
- $frames_lost – 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
-
BrickletARINC429
->
CALLBACK_FRAME_MESSAGE
Callback-Parameter: | - $channel – Typ: int, Wertebereich: Siehe Konstanten
- $status – Typ: int, Wertebereich: Siehe Konstanten
- $seq_number – Typ: int, Wertebereich: [0 bis 255]
- $timestamp – Typ: int, Wertebereich: [0 bis 216 - 1]
- $frame – Typ: int, 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
-
BrickletARINC429
->
CALLBACK_SCHEDULER_MESSAGE
Callback-Parameter: | - $channel – Typ: int, Wertebereich: Siehe Konstanten
- $status – Typ: int, Wertebereich: Siehe Konstanten
- $seq_number – 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.
-
BrickletARINC429
->
get_api_version
()
Rückgabe-Array: | - 0: \@api_version – Typ: [int, ...], Länge: 3
- 0: $major – Typ: int, Wertebereich: [0 bis 255]
- 1: $minor – Typ: int, Wertebereich: [0 bis 255]
- 2: $revision – Typ: int, 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.
-
BrickletARINC429
->
get_response_expected
($function_id)
Parameter: | - $function_id – Typ: int, Wertebereich: Siehe Konstanten
|
Rückgabe: | - $response_expected – Typ: bool
|
Gibt das Response-Expected-Flag für die Funktion mit der angegebenen Funktions
IDs zurück. Es ist true falls für die Funktion beim Aufruf eine Antwort
erwartet wird, false andernfalls.
Für Getter-Funktionen ist diese Flag immer gesetzt und kann nicht entfernt
werden, da diese Funktionen immer eine Antwort senden. Für
Konfigurationsfunktionen für Callbacks ist es standardmäßig gesetzt, kann aber
entfernt werden mittels set_response_expected()
. Für Setter-Funktionen ist
es standardmäßig nicht gesetzt, kann aber gesetzt werden.
Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können
Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion
detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck.
Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine
Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie
nicht detektiert werden können.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für $function_id:
- 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
-
BrickletARINC429
->
set_response_expected
($function_id, $response_expected)
Parameter: | - $function_id – Typ: int, Wertebereich: Siehe Konstanten
- $response_expected – Typ: bool
|
Rückgabe: | |
Ändert das Response-Expected-Flag für die Funktion mit der angegebenen Funktion
IDs. Diese Flag kann nur für Setter-Funktionen (Standardwert: false) und
Konfigurationsfunktionen für Callbacks (Standardwert: true) geändert werden.
Für Getter-Funktionen ist das Flag immer gesetzt.
Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können
Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion
detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck.
Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine
Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie
nicht detektiert werden können.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für $function_id:
- 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
-
BrickletARINC429
->
set_response_expected_all
($response_expected)
Parameter: | - $response_expected – Typ: bool
|
Rückgabe: | |
Ä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.
-
BrickletARINC429
->
set_bootloader_mode
($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
-
BrickletARINC429
->
get_bootloader_mode
()
Rückgabe: | - $mode – Typ: int, Wertebereich: Siehe Konstanten
|
Gibt den aktuellen Bootloader-Modus zurück, siehe set_bootloader_mode()
.
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
-
BrickletARINC429
->
set_write_firmware_pointer
($pointer)
Parameter: | - $pointer – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]
|
Rückgabe: | |
Setzt den Firmware-Pointer für write_firmware()
. Der Pointer
muss um je 64 Byte erhöht werden. Die Daten werden alle 4 Datenblöcke
in den Flash geschrieben (4 Datenblöcke entsprechen einer Page mit 256 Byte).
Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem
normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.
-
BrickletARINC429
->
write_firmware
(\@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
set_write_firmware_pointer()
gesetzt wurde. Die Firmware wird
alle 4 Datenblöcke in den Flash geschrieben.
Eine Firmware kann nur im Bootloader-Mode geschrieben werden.
Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem
normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.
-
BrickletARINC429
->
write_uid
($uid)
Parameter: | - $uid – Typ: int, Wertebereich: [0 bis 232 - 1]
|
Rückgabe: | |
Schreibt eine neue UID in den Flash. Die UID muss zuerst
vom Base58 encodierten String in einen Integer decodiert
werden.
Wir empfehlen die Nutzung des Brick Viewers zum ändern
der UID.
-
BrickletARINC429
->
read_uid
()
Rückgabe: | - $uid – Typ: int, 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
-
BrickletARINC429
->
DEVICE_IDENTIFIER
Diese Konstante wird verwendet um ein ARINC429 Bricklet zu identifizieren.
Die get_identity()
Funktion und der
IPConnection->CALLBACK_ENUMERATE
Callback der IP Connection haben ein device_identifier
Parameter um den Typ
des Bricks oder Bricklets anzugeben.
-
BrickletARINC429
->
DEVICE_DISPLAY_NAME
Diese Konstante stellt den Anzeigenamen eines ARINC429 Bricklet dar.