Deutsch
English
Menu

Go - 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 Go 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 Go API Bindings ist Teil deren allgemeine Beschreibung. Zusätzliche Dokumentation findet sich auf godoc.org.

API

Die API des ARINC429 Bricklet ist im Package github.com/Tinkerforge/go-api-bindings/arinc429_bricklet definiert.

Fast alle Funktionen der Go Bindings können einen ipconnection.DeviceError, der das error-Interface implementiert, zurückgeben. Dieser kann folgende Werte annehmen:

  • ipconnection.DeviceErrorSuccess = 0
  • ipconnection.DeviceErrorInvalidParameter = 1
  • ipconnection.DeviceErrorFunctionNotSupported = 2
  • ipconnection.DeviceErrorUnknownError = 3

welche den Werten entsprechen, die der Brick oder das Bricklet zurückgeben.

Alle folgend aufgelisteten Funktionen sind Thread-sicher.

Grundfunktionen

func arinc429_bricklet.New(uid string, ipcon *IPConnection) (device ARINC429Bricklet, err error)
Parameter:
  • uid – Typ: string
  • ipcon – Typ: *IPConnection
Rückgabe:
  • device – Typ: ARINC429Bricklet
  • err – Typ: error

Erzeugt ein neues ARINC429Bricklet-Objekt mit der eindeutigen Geräte ID uid und fügt es der IPConnection ipcon hinzu:

device, err := arinc429_bricklet.New("YOUR_DEVICE_UID", &ipcon)

Dieses Geräteobjekt kann benutzt werden, nachdem die IPConnection verbunden.

func (*ARINC429Bricklet) GetCapabilities() (txTotalSchedulerJobs uint16, txUsedSchedulerJobs uint16, rxTotalFrameFilters uint16, rxUsedFrameFilters [2]uint16, err error)
Rückgabe:
  • txTotalSchedulerJobs – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • txUsedSchedulerJobs – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • rxTotalFrameFilters – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • rxUsedFrameFilters – Typ: [2]uint16, Wertebereich: [0 bis 216 - 1]
  • err – Typ: error
func (*ARINC429Bricklet) SetChannelConfiguration(channel uint8, parity uint8, speed uint8) (err error)
Parameter:
  • channel – Typ: uint8, Wertebereich: Siehe Konstanten
  • parity – Typ: uint8, Wertebereich: Siehe Konstanten
  • speed – Typ: uint8, Wertebereich: Siehe Konstanten
Rückgabe:
  • err – Typ: error

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

Für channel:

  • arinc429_bricklet.ChannelTX = 0
  • arinc429_bricklet.ChannelTX1 = 1
  • arinc429_bricklet.ChannelRX = 32
  • arinc429_bricklet.ChannelRX1 = 33
  • arinc429_bricklet.ChannelRX2 = 34

Für parity:

  • arinc429_bricklet.ParityData = 0
  • arinc429_bricklet.ParityAuto = 1

Für speed:

  • arinc429_bricklet.SpeedHS = 0
  • arinc429_bricklet.SpeedLS = 1
func (*ARINC429Bricklet) GetChannelConfiguration(channel uint8) (parity uint8, speed uint8, err error)
Parameter:
  • channel – Typ: uint8, Wertebereich: Siehe Konstanten
Rückgabe:
  • parity – Typ: uint8, Wertebereich: Siehe Konstanten
  • speed – Typ: uint8, Wertebereich: Siehe Konstanten
  • err – Typ: error

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

Für channel:

  • arinc429_bricklet.ChannelTX = 0
  • arinc429_bricklet.ChannelTX1 = 1
  • arinc429_bricklet.ChannelRX = 32
  • arinc429_bricklet.ChannelRX1 = 33
  • arinc429_bricklet.ChannelRX2 = 34

Für parity:

  • arinc429_bricklet.ParityData = 0
  • arinc429_bricklet.ParityAuto = 1

Für speed:

  • arinc429_bricklet.SpeedHS = 0
  • arinc429_bricklet.SpeedLS = 1
func (*ARINC429Bricklet) SetChannelMode(channel uint8, mode uint8) (err error)
Parameter:
  • channel – Typ: uint8, Wertebereich: Siehe Konstanten
  • mode – Typ: uint8, Wertebereich: Siehe Konstanten
Rückgabe:
  • err – Typ: error

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

Für channel:

  • arinc429_bricklet.ChannelTX = 0
  • arinc429_bricklet.ChannelTX1 = 1
  • arinc429_bricklet.ChannelRX = 32
  • arinc429_bricklet.ChannelRX1 = 33
  • arinc429_bricklet.ChannelRX2 = 34

Für mode:

  • arinc429_bricklet.ChannelModePassive = 0
  • arinc429_bricklet.ChannelModeActive = 1
  • arinc429_bricklet.ChannelModeRun = 2
func (*ARINC429Bricklet) GetChannelMode(channel uint8) (mode uint8, err error)
Parameter:
  • channel – Typ: uint8, Wertebereich: Siehe Konstanten
Rückgabe:
  • mode – Typ: uint8, Wertebereich: Siehe Konstanten
  • err – Typ: error

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

Für channel:

  • arinc429_bricklet.ChannelTX = 0
  • arinc429_bricklet.ChannelTX1 = 1
  • arinc429_bricklet.ChannelRX = 32
  • arinc429_bricklet.ChannelRX1 = 33
  • arinc429_bricklet.ChannelRX2 = 34

Für mode:

  • arinc429_bricklet.ChannelModePassive = 0
  • arinc429_bricklet.ChannelModeActive = 1
  • arinc429_bricklet.ChannelModeRun = 2
func (*ARINC429Bricklet) ClearAllRXFilters(channel uint8) (err error)
Parameter:
  • channel – Typ: uint8, Wertebereich: Siehe Konstanten
Rückgabe:
  • err – Typ: error

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

Für channel:

  • arinc429_bricklet.ChannelTX = 0
  • arinc429_bricklet.ChannelTX1 = 1
  • arinc429_bricklet.ChannelRX = 32
  • arinc429_bricklet.ChannelRX1 = 33
  • arinc429_bricklet.ChannelRX2 = 34
func (*ARINC429Bricklet) ClearRXFilter(channel uint8, label uint8, sdi uint8) (success bool, err error)
Parameter:
  • channel – Typ: uint8, Wertebereich: Siehe Konstanten
  • label – Typ: uint8, Wertebereich: [0 bis 255]
  • sdi – Typ: uint8, Wertebereich: Siehe Konstanten
Rückgabe:
  • success – Typ: bool
  • err – Typ: error

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

Für channel:

  • arinc429_bricklet.ChannelTX = 0
  • arinc429_bricklet.ChannelTX1 = 1
  • arinc429_bricklet.ChannelRX = 32
  • arinc429_bricklet.ChannelRX1 = 33
  • arinc429_bricklet.ChannelRX2 = 34

Für sdi:

  • arinc429_bricklet.SDISDI0 = 0
  • arinc429_bricklet.SDISDI1 = 1
  • arinc429_bricklet.SDISDI2 = 2
  • arinc429_bricklet.SDISDI3 = 3
  • arinc429_bricklet.SDIData = 4
func (*ARINC429Bricklet) SetRXStandardFilters(channel uint8) (err error)
Parameter:
  • channel – Typ: uint8, Wertebereich: Siehe Konstanten
Rückgabe:
  • err – Typ: error

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

Für channel:

  • arinc429_bricklet.ChannelTX = 0
  • arinc429_bricklet.ChannelTX1 = 1
  • arinc429_bricklet.ChannelRX = 32
  • arinc429_bricklet.ChannelRX1 = 33
  • arinc429_bricklet.ChannelRX2 = 34
func (*ARINC429Bricklet) SetRXFilter(channel uint8, label uint8, sdi uint8) (success bool, err error)
Parameter:
  • channel – Typ: uint8, Wertebereich: Siehe Konstanten
  • label – Typ: uint8, Wertebereich: [0 bis 255]
  • sdi – Typ: uint8, Wertebereich: Siehe Konstanten
Rückgabe:
  • success – Typ: bool
  • err – Typ: error

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

Für channel:

  • arinc429_bricklet.ChannelTX = 0
  • arinc429_bricklet.ChannelTX1 = 1
  • arinc429_bricklet.ChannelRX = 32
  • arinc429_bricklet.ChannelRX1 = 33
  • arinc429_bricklet.ChannelRX2 = 34

Für sdi:

  • arinc429_bricklet.SDISDI0 = 0
  • arinc429_bricklet.SDISDI1 = 1
  • arinc429_bricklet.SDISDI2 = 2
  • arinc429_bricklet.SDISDI3 = 3
  • arinc429_bricklet.SDIData = 4
func (*ARINC429Bricklet) GetRXFilter(channel uint8, label uint8, sdi uint8) (configured bool, err error)
Parameter:
  • channel – Typ: uint8, Wertebereich: Siehe Konstanten
  • label – Typ: uint8, Wertebereich: [0 bis 255]
  • sdi – Typ: uint8, Wertebereich: Siehe Konstanten
Rückgabe:
  • configured – Typ: bool
  • err – Typ: error

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

Für channel:

  • arinc429_bricklet.ChannelTX = 0
  • arinc429_bricklet.ChannelTX1 = 1
  • arinc429_bricklet.ChannelRX = 32
  • arinc429_bricklet.ChannelRX1 = 33
  • arinc429_bricklet.ChannelRX2 = 34

Für sdi:

  • arinc429_bricklet.SDISDI0 = 0
  • arinc429_bricklet.SDISDI1 = 1
  • arinc429_bricklet.SDISDI2 = 2
  • arinc429_bricklet.SDISDI3 = 3
  • arinc429_bricklet.SDIData = 4
func (*ARINC429Bricklet) ReadFrame(channel uint8, label uint8, sdi uint8) (status bool, frame uint32, age uint16, err error)
Parameter:
  • channel – Typ: uint8, Wertebereich: Siehe Konstanten
  • label – Typ: uint8, Wertebereich: [0 bis 255]
  • sdi – Typ: uint8, Wertebereich: Siehe Konstanten
Rückgabe:
  • status – Typ: bool
  • frame – Typ: uint32, Wertebereich: [0 bis 232 - 1]
  • age – Typ: uint16, Einheit: 1 ms, Wertebereich: [0 bis 216 - 1]
  • err – Typ: error

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

Für channel:

  • arinc429_bricklet.ChannelTX = 0
  • arinc429_bricklet.ChannelTX1 = 1
  • arinc429_bricklet.ChannelRX = 32
  • arinc429_bricklet.ChannelRX1 = 33
  • arinc429_bricklet.ChannelRX2 = 34

Für sdi:

  • arinc429_bricklet.SDISDI0 = 0
  • arinc429_bricklet.SDISDI1 = 1
  • arinc429_bricklet.SDISDI2 = 2
  • arinc429_bricklet.SDISDI3 = 3
  • arinc429_bricklet.SDIData = 4
func (*ARINC429Bricklet) WriteFrameDirect(channel uint8, frame uint32) (err error)
Parameter:
  • channel – Typ: uint8, Wertebereich: Siehe Konstanten
  • frame – Typ: uint32, Wertebereich: [0 bis 232 - 1]
Rückgabe:
  • err – Typ: error

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

Für channel:

  • arinc429_bricklet.ChannelTX = 0
  • arinc429_bricklet.ChannelTX1 = 1
  • arinc429_bricklet.ChannelRX = 32
  • arinc429_bricklet.ChannelRX1 = 33
  • arinc429_bricklet.ChannelRX2 = 34
func (*ARINC429Bricklet) WriteFrameScheduled(channel uint8, frameIndex uint16, frame uint32) (err error)
Parameter:
  • channel – Typ: uint8, Wertebereich: Siehe Konstanten
  • frameIndex – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • frame – Typ: uint32, Wertebereich: [0 bis 232 - 1]
Rückgabe:
  • err – Typ: error

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

Für channel:

  • arinc429_bricklet.ChannelTX = 0
  • arinc429_bricklet.ChannelTX1 = 1
  • arinc429_bricklet.ChannelRX = 32
  • arinc429_bricklet.ChannelRX1 = 33
  • arinc429_bricklet.ChannelRX2 = 34
func (*ARINC429Bricklet) ClearScheduleEntries(channel uint8, jobIndexFirst uint16, jobIndexLast uint16) (err error)
Parameter:
  • channel – Typ: uint8, Wertebereich: Siehe Konstanten
  • jobIndexFirst – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • jobIndexLast – Typ: uint16, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • err – Typ: error

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

Für channel:

  • arinc429_bricklet.ChannelTX = 0
  • arinc429_bricklet.ChannelTX1 = 1
  • arinc429_bricklet.ChannelRX = 32
  • arinc429_bricklet.ChannelRX1 = 33
  • arinc429_bricklet.ChannelRX2 = 34
func (*ARINC429Bricklet) SetScheduleEntry(channel uint8, jobIndex uint16, job uint8, frameIndex uint16, dwellTime uint8) (err error)
Parameter:
  • channel – Typ: uint8, Wertebereich: Siehe Konstanten
  • jobIndex – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • job – Typ: uint8, Wertebereich: Siehe Konstanten
  • frameIndex – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • dwellTime – Typ: uint8, Einheit: 1 ms, Wertebereich: [0 bis 255]
Rückgabe:
  • err – Typ: error

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

Für channel:

  • arinc429_bricklet.ChannelTX = 0
  • arinc429_bricklet.ChannelTX1 = 1
  • arinc429_bricklet.ChannelRX = 32
  • arinc429_bricklet.ChannelRX1 = 33
  • arinc429_bricklet.ChannelRX2 = 34

Für job:

  • arinc429_bricklet.SchedulerJobSkip = 0
  • arinc429_bricklet.SchedulerJobCallback = 1
  • arinc429_bricklet.SchedulerJobStop = 2
  • arinc429_bricklet.SchedulerJobJump = 3
  • arinc429_bricklet.SchedulerJobReturn = 4
  • arinc429_bricklet.SchedulerJobDwell = 5
  • arinc429_bricklet.SchedulerJobSingle = 6
  • arinc429_bricklet.SchedulerJobCyclic = 7
  • arinc429_bricklet.SchedulerJobRetransRX1 = 8
  • arinc429_bricklet.SchedulerJobRetransRX2 = 9
func (*ARINC429Bricklet) GetScheduleEntry(channel uint8, jobIndex uint16) (job uint8, frameIndex uint16, frame uint32, dwellTime uint8, err error)
Parameter:
  • channel – Typ: uint8, Wertebereich: Siehe Konstanten
  • jobIndex – Typ: uint16, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • job – Typ: uint8, Wertebereich: Siehe Konstanten
  • frameIndex – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • frame – Typ: uint32, Wertebereich: [0 bis 232 - 1]
  • dwellTime – Typ: uint8, Einheit: 1 ms, Wertebereich: [0 bis 255]
  • err – Typ: error

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

Für channel:

  • arinc429_bricklet.ChannelTX = 0
  • arinc429_bricklet.ChannelTX1 = 1
  • arinc429_bricklet.ChannelRX = 32
  • arinc429_bricklet.ChannelRX1 = 33
  • arinc429_bricklet.ChannelRX2 = 34

Für job:

  • arinc429_bricklet.SchedulerJobSkip = 0
  • arinc429_bricklet.SchedulerJobCallback = 1
  • arinc429_bricklet.SchedulerJobStop = 2
  • arinc429_bricklet.SchedulerJobJump = 3
  • arinc429_bricklet.SchedulerJobReturn = 4
  • arinc429_bricklet.SchedulerJobDwell = 5
  • arinc429_bricklet.SchedulerJobSingle = 6
  • arinc429_bricklet.SchedulerJobCyclic = 7
  • arinc429_bricklet.SchedulerJobRetransRX1 = 8
  • arinc429_bricklet.SchedulerJobRetransRX2 = 9
func (*ARINC429Bricklet) Restart() (err error)
Rückgabe:
  • err – Typ: error
func (*ARINC429Bricklet) SetFrameMode(channel uint8, frameIndex uint16, mode uint8) (err error)
Parameter:
  • channel – Typ: uint8, Wertebereich: Siehe Konstanten
  • frameIndex – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • mode – Typ: uint8, Wertebereich: Siehe Konstanten
Rückgabe:
  • err – Typ: error

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

Für channel:

  • arinc429_bricklet.ChannelTX = 0
  • arinc429_bricklet.ChannelTX1 = 1
  • arinc429_bricklet.ChannelRX = 32
  • arinc429_bricklet.ChannelRX1 = 33
  • arinc429_bricklet.ChannelRX2 = 34

Für mode:

  • arinc429_bricklet.TXModeTransmit = 0
  • arinc429_bricklet.TXModeMute = 1

Fortgeschrittene Funktionen

func (*ARINC429Bricklet) GetSPITFPErrorCount() (errorCountAckChecksum uint32, errorCountMessageChecksum uint32, errorCountFrame uint32, errorCountOverflow uint32, err error)
Rückgabe:
  • errorCountAckChecksum – Typ: uint32, Wertebereich: [0 bis 232 - 1]
  • errorCountMessageChecksum – Typ: uint32, Wertebereich: [0 bis 232 - 1]
  • errorCountFrame – Typ: uint32, Wertebereich: [0 bis 232 - 1]
  • errorCountOverflow – Typ: uint32, Wertebereich: [0 bis 232 - 1]
  • err – Typ: error

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.

func (*ARINC429Bricklet) SetStatusLEDConfig(config uint8) (err error)
Parameter:
  • config – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 3
Rückgabe:
  • err – Typ: error

Setzt die Konfiguration der Status-LED. Standardmäßig zeigt die LED die Kommunikationsdatenmenge an. Sie blinkt einmal auf pro 10 empfangenen Datenpaketen zwischen Brick und Bricklet.

Die LED kann auch permanent an/aus gestellt werden oder einen Herzschlag anzeigen.

Wenn das Bricklet sich im Bootlodermodus befindet ist die LED aus.

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

Für config:

  • arinc429_bricklet.StatusLEDConfigOff = 0
  • arinc429_bricklet.StatusLEDConfigOn = 1
  • arinc429_bricklet.StatusLEDConfigShowHeartbeat = 2
  • arinc429_bricklet.StatusLEDConfigShowStatus = 3
func (*ARINC429Bricklet) GetStatusLEDConfig() (config uint8, err error)
Rückgabe:
  • config – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 3
  • err – Typ: error

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

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

Für config:

  • arinc429_bricklet.StatusLEDConfigOff = 0
  • arinc429_bricklet.StatusLEDConfigOn = 1
  • arinc429_bricklet.StatusLEDConfigShowHeartbeat = 2
  • arinc429_bricklet.StatusLEDConfigShowStatus = 3
func (*ARINC429Bricklet) GetChipTemperature() (temperature int16, err error)
Rückgabe:
  • temperature – Typ: int16, Einheit: 1 °C, Wertebereich: [-215 bis 215 - 1]
  • err – Typ: error

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.

func (*ARINC429Bricklet) Reset() (err error)
Rückgabe:
  • err – Typ: error

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.

func (*ARINC429Bricklet) GetIdentity() (uid string, connectedUid string, position rune, hardwareVersion [3]uint8, firmwareVersion [3]uint8, deviceIdentifier uint16, err error)
Rückgabe:
  • uid – Typ: string, Länge: bis zu 8
  • connectedUid – Typ: string, Länge: bis zu 8
  • position – Typ: rune, Wertebereich: ['a' bis 'h', 'z']
  • hardwareVersion – Typ: [3]uint8
    • 0: major – Typ: uint8, Wertebereich: [0 bis 255]
    • 1: minor – Typ: uint8, Wertebereich: [0 bis 255]
    • 2: revision – Typ: uint8, Wertebereich: [0 bis 255]
  • firmwareVersion – Typ: [3]uint8
    • 0: major – Typ: uint8, Wertebereich: [0 bis 255]
    • 1: minor – Typ: uint8, Wertebereich: [0 bis 255]
    • 2: revision – Typ: uint8, Wertebereich: [0 bis 255]
  • deviceIdentifier – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • err – Typ: error

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

func (*ARINC429Bricklet) SetHeartbeatCallbackConfiguration(channel uint8, enabled bool, valueHasToChange bool, period uint16) (err error)
Parameter:
  • channel – Typ: uint8, Wertebereich: Siehe Konstanten
  • enabled – Typ: bool, Standardwert: false
  • valueHasToChange – Typ: bool, Standardwert: false
  • period – Typ: uint16, Einheit: 1 ms, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • err – Typ: error

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

Für channel:

  • arinc429_bricklet.ChannelTX = 0
  • arinc429_bricklet.ChannelTX1 = 1
  • arinc429_bricklet.ChannelRX = 32
  • arinc429_bricklet.ChannelRX1 = 33
  • arinc429_bricklet.ChannelRX2 = 34
func (*ARINC429Bricklet) GetHeartbeatCallbackConfiguration(channel uint8) (enabled bool, valueHasToChange bool, period uint16, err error)
Parameter:
  • channel – Typ: uint8, Wertebereich: Siehe Konstanten
Rückgabe:
  • enabled – Typ: bool, Standardwert: false
  • valueHasToChange – Typ: bool, Standardwert: false
  • period – Typ: uint16, Einheit: 1 ms, Wertebereich: [0 bis 216 - 1]
  • err – Typ: error

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

Für channel:

  • arinc429_bricklet.ChannelTX = 0
  • arinc429_bricklet.ChannelTX1 = 1
  • arinc429_bricklet.ChannelRX = 32
  • arinc429_bricklet.ChannelRX1 = 33
  • arinc429_bricklet.ChannelRX2 = 34
func (*ARINC429Bricklet) SetRXCallbackConfiguration(channel uint8, enabled bool, valueHasToChange bool, timeout uint16) (err error)
Parameter:
  • channel – Typ: uint8, Wertebereich: Siehe Konstanten
  • enabled – Typ: bool, Standardwert: false
  • valueHasToChange – Typ: bool, Standardwert: false
  • timeout – Typ: uint16, Einheit: 1 ms, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • err – Typ: error

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

Für channel:

  • arinc429_bricklet.ChannelTX = 0
  • arinc429_bricklet.ChannelTX1 = 1
  • arinc429_bricklet.ChannelRX = 32
  • arinc429_bricklet.ChannelRX1 = 33
  • arinc429_bricklet.ChannelRX2 = 34
func (*ARINC429Bricklet) GetRXCallbackConfiguration(channel uint8) (enabled bool, valueHasToChange bool, timeout uint16, err error)
Parameter:
  • channel – Typ: uint8, Wertebereich: Siehe Konstanten
Rückgabe:
  • enabled – Typ: bool, Standardwert: false
  • valueHasToChange – Typ: bool, Standardwert: false
  • timeout – Typ: uint16, Einheit: 1 ms, Wertebereich: [0 bis 216 - 1]
  • err – Typ: error

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

Für channel:

  • arinc429_bricklet.ChannelTX = 0
  • arinc429_bricklet.ChannelTX1 = 1
  • arinc429_bricklet.ChannelRX = 32
  • arinc429_bricklet.ChannelRX1 = 33
  • arinc429_bricklet.ChannelRX2 = 34

Callbacks

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann mit der entsprechenden Register*Callback-Function durchgeführt werden, welche eine eindeutige Callback-ID zurück gibt. Mit dieser ID kann das Callback später deregistriert werden.

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.

func (*ARINC429Bricklet) RegisterHeartbeatMessageCallback(func(channel uint8, status uint8, seqNumber uint8, timestamp uint16, framesProcessed uint16, framesLost uint16)) (registrationId uint64)
Callback-Parameter:
  • channel – Typ: uint8, Wertebereich: Siehe Konstanten
  • status – Typ: uint8, Wertebereich: Siehe Konstanten
  • seqNumber – Typ: uint8, Wertebereich: [0 bis 255]
  • timestamp – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • framesProcessed – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • framesLost – Typ: uint16, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • registrationId – Typ: uint64

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

Für channel:

  • arinc429_bricklet.ChannelTX = 0
  • arinc429_bricklet.ChannelTX1 = 1
  • arinc429_bricklet.ChannelRX = 32
  • arinc429_bricklet.ChannelRX1 = 33
  • arinc429_bricklet.ChannelRX2 = 34

Für status:

  • arinc429_bricklet.StatusNew = 0
  • arinc429_bricklet.StatusUpdate = 1
  • arinc429_bricklet.StatusTimeout = 2
  • arinc429_bricklet.StatusScheduler = 3
  • arinc429_bricklet.StatusStatistics = 4
func (*ARINC429Bricklet) RegisterFrameMessageCallback(func(channel uint8, status uint8, seqNumber uint8, timestamp uint16, frame uint32, age uint16)) (registrationId uint64)
Callback-Parameter:
  • channel – Typ: uint8, Wertebereich: Siehe Konstanten
  • status – Typ: uint8, Wertebereich: Siehe Konstanten
  • seqNumber – Typ: uint8, Wertebereich: [0 bis 255]
  • timestamp – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • frame – Typ: uint32, Wertebereich: [0 bis 232 - 1]
  • age – Typ: uint16, Einheit: 1 ms, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • registrationId – Typ: uint64

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

Für channel:

  • arinc429_bricklet.ChannelTX = 0
  • arinc429_bricklet.ChannelTX1 = 1
  • arinc429_bricklet.ChannelRX = 32
  • arinc429_bricklet.ChannelRX1 = 33
  • arinc429_bricklet.ChannelRX2 = 34

Für status:

  • arinc429_bricklet.StatusNew = 0
  • arinc429_bricklet.StatusUpdate = 1
  • arinc429_bricklet.StatusTimeout = 2
  • arinc429_bricklet.StatusScheduler = 3
  • arinc429_bricklet.StatusStatistics = 4
func (*ARINC429Bricklet) RegisterSchedulerMessageCallback(func(channel uint8, status uint8, seqNumber uint8, timestamp uint16, userdata uint8)) (registrationId uint64)
Callback-Parameter:
  • channel – Typ: uint8, Wertebereich: Siehe Konstanten
  • status – Typ: uint8, Wertebereich: Siehe Konstanten
  • seqNumber – Typ: uint8, Wertebereich: [0 bis 255]
  • timestamp – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • userdata – Typ: uint8, Wertebereich: [0 bis 255]
Rückgabe:
  • registrationId – Typ: uint64

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

Für channel:

  • arinc429_bricklet.ChannelTX = 0
  • arinc429_bricklet.ChannelTX1 = 1
  • arinc429_bricklet.ChannelRX = 32
  • arinc429_bricklet.ChannelRX1 = 33
  • arinc429_bricklet.ChannelRX2 = 34

Für status:

  • arinc429_bricklet.StatusNew = 0
  • arinc429_bricklet.StatusUpdate = 1
  • arinc429_bricklet.StatusTimeout = 2
  • arinc429_bricklet.StatusScheduler = 3
  • arinc429_bricklet.StatusStatistics = 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.

func (*ARINC429Bricklet) GetAPIVersion() (apiVersion [3]uint8, err error)
Rückgabe:
  • apiVersion – Typ: [3]uint8
    • 0: major – Typ: uint8, Wertebereich: [0 bis 255]
    • 1: minor – Typ: uint8, Wertebereich: [0 bis 255]
    • 2: revision – Typ: uint8, Wertebereich: [0 bis 255]
  • err – Typ: error

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.

func (*ARINC429Bricklet) GetResponseExpected(functionId uint8) (responseExpected bool, err error)
Parameter:
  • functionId – Typ: uint8, Wertebereich: Siehe Konstanten
Rückgabe:
  • responseExpected – Typ: bool
  • err – Typ: error

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:

  • arinc429_bricklet.FunctionSetHeartbeatCallbackConfiguration = 2
  • arinc429_bricklet.FunctionSetChannelConfiguration = 5
  • arinc429_bricklet.FunctionSetChannelMode = 7
  • arinc429_bricklet.FunctionClearAllRXFilters = 9
  • arinc429_bricklet.FunctionSetRXStandardFilters = 11
  • arinc429_bricklet.FunctionSetRXCallbackConfiguration = 15
  • arinc429_bricklet.FunctionWriteFrameDirect = 18
  • arinc429_bricklet.FunctionWriteFrameScheduled = 19
  • arinc429_bricklet.FunctionClearScheduleEntries = 20
  • arinc429_bricklet.FunctionSetScheduleEntry = 21
  • arinc429_bricklet.FunctionRestart = 23
  • arinc429_bricklet.FunctionSetFrameMode = 25
  • arinc429_bricklet.FunctionSetWriteFirmwarePointer = 237
  • arinc429_bricklet.FunctionSetStatusLEDConfig = 239
  • arinc429_bricklet.FunctionReset = 243
  • arinc429_bricklet.FunctionWriteUID = 248
func (*ARINC429Bricklet) SetResponseExpected(functionId uint8, responseExpected bool) (err error)
Parameter:
  • functionId – Typ: uint8, Wertebereich: Siehe Konstanten
  • responseExpected – Typ: bool
Rückgabe:
  • err – Typ: error

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

  • arinc429_bricklet.FunctionSetHeartbeatCallbackConfiguration = 2
  • arinc429_bricklet.FunctionSetChannelConfiguration = 5
  • arinc429_bricklet.FunctionSetChannelMode = 7
  • arinc429_bricklet.FunctionClearAllRXFilters = 9
  • arinc429_bricklet.FunctionSetRXStandardFilters = 11
  • arinc429_bricklet.FunctionSetRXCallbackConfiguration = 15
  • arinc429_bricklet.FunctionWriteFrameDirect = 18
  • arinc429_bricklet.FunctionWriteFrameScheduled = 19
  • arinc429_bricklet.FunctionClearScheduleEntries = 20
  • arinc429_bricklet.FunctionSetScheduleEntry = 21
  • arinc429_bricklet.FunctionRestart = 23
  • arinc429_bricklet.FunctionSetFrameMode = 25
  • arinc429_bricklet.FunctionSetWriteFirmwarePointer = 237
  • arinc429_bricklet.FunctionSetStatusLEDConfig = 239
  • arinc429_bricklet.FunctionReset = 243
  • arinc429_bricklet.FunctionWriteUID = 248
func (*ARINC429Bricklet) SetResponseExpectedAll(responseExpected bool) (err error)
Parameter:
  • responseExpected – Typ: bool
Rückgabe:
  • err – Typ: error

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

func (*ARINC429Bricklet) SetBootloaderMode(mode uint8) (status uint8, err error)
Parameter:
  • mode – Typ: uint8, Wertebereich: Siehe Konstanten
Rückgabe:
  • status – Typ: uint8, Wertebereich: Siehe Konstanten
  • err – Typ: error

Setzt den Bootloader-Modus und gibt den Status zurück nachdem die Modusänderungsanfrage bearbeitet wurde.

Mit dieser Funktion ist es möglich vom Bootloader- in den Firmware-Modus zu wechseln und umgekehrt. Ein Welchsel vom Bootloader- in der den Firmware-Modus ist nur möglich wenn Entry-Funktion, Device Identifier und CRC vorhanden und korrekt sind.

Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

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

Für mode:

  • arinc429_bricklet.BootloaderModeBootloader = 0
  • arinc429_bricklet.BootloaderModeFirmware = 1
  • arinc429_bricklet.BootloaderModeBootloaderWaitForReboot = 2
  • arinc429_bricklet.BootloaderModeFirmwareWaitForReboot = 3
  • arinc429_bricklet.BootloaderModeFirmwareWaitForEraseAndReboot = 4

Für status:

  • arinc429_bricklet.BootloaderStatusOK = 0
  • arinc429_bricklet.BootloaderStatusInvalidMode = 1
  • arinc429_bricklet.BootloaderStatusNoChange = 2
  • arinc429_bricklet.BootloaderStatusEntryFunctionNotPresent = 3
  • arinc429_bricklet.BootloaderStatusDeviceIdentifierIncorrect = 4
  • arinc429_bricklet.BootloaderStatusCRCMismatch = 5
func (*ARINC429Bricklet) GetBootloaderMode() (mode uint8, err error)
Rückgabe:
  • mode – Typ: uint8, Wertebereich: Siehe Konstanten
  • err – Typ: error

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

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

Für mode:

  • arinc429_bricklet.BootloaderModeBootloader = 0
  • arinc429_bricklet.BootloaderModeFirmware = 1
  • arinc429_bricklet.BootloaderModeBootloaderWaitForReboot = 2
  • arinc429_bricklet.BootloaderModeFirmwareWaitForReboot = 3
  • arinc429_bricklet.BootloaderModeFirmwareWaitForEraseAndReboot = 4
func (*ARINC429Bricklet) SetWriteFirmwarePointer(pointer uint32) (err error)
Parameter:
  • pointer – Typ: uint32, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]
Rückgabe:
  • err – Typ: error

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.

func (*ARINC429Bricklet) WriteFirmware(data [64]uint8) (status uint8, err error)
Parameter:
  • data – Typ: [64]uint8, Wertebereich: [0 bis 255]
Rückgabe:
  • status – Typ: uint8, Wertebereich: [0 bis 255]
  • err – Typ: error

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.

func (*ARINC429Bricklet) WriteUID(uid uint32) (err error)
Parameter:
  • uid – Typ: uint32, Wertebereich: [0 bis 232 - 1]
Rückgabe:
  • err – Typ: error

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.

func (*ARINC429Bricklet) ReadUID() (uid uint32, err error)
Rückgabe:
  • uid – Typ: uint32, Wertebereich: [0 bis 232 - 1]
  • err – Typ: error

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

Konstanten

arinc429_bricklet.DeviceIdentifier

Diese Konstante wird verwendet um ein ARINC429 Bricklet zu identifizieren.

Die GetIdentity() Funktion und der (*IPConnection) RegisterEnumerateCallback Callback der IPConnection haben ein deviceIdentifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

arinc429_bricklet.DeviceDisplayName

Diese Konstante stellt den Anzeigenamen eines ARINC429 Bricklet dar.