Delphi/Lazarus - ARINC429 Bricklet

This is the description of the Delphi/Lazarus API bindings for the ARINC429 Bricklet. General information and technical specifications for the ARINC429 Bricklet are summarized in its hardware description.

An installation guide for the Delphi/Lazarus API bindings is part of their general description.

API

Since Delphi does not support multiple return values directly, we use the out keyword to return multiple values from a function.

All functions and procedures listed below are thread-safe.

Basic Functions

constructor TBrickletARINC429.Create(const uid: string; ipcon: TIPConnection)
Parameters:
  • uid – Type: string
  • ipcon – Type: TIPConnection
Returns:
  • arinc429 – Type: TBrickletARINC429

Creates an object with the unique device ID uid:

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

This object can then be used after the IP Connection is connected.

procedure TBrickletARINC429.DebugGetDiscretes(out rxDiscretes: word; out txDiscretes: word)
Output Parameters:
  • rxDiscretes – Type: word, Range: [0 to 210 - 1]
  • txDiscretes – Type: word, Range: [0 to 3]

Debug function to read the discrete signals from the A429 chip.

RX Discretes Bit 9: MB2-1 - pending frame in RX2, PRIO 1
8: MB2-2 - 2 7: MB2-3 - 3 6: R2FLAG - FIFO 5: R2INT - FIFO 4: MB1-1 - pending frame in RX1, PRIO 1 3: MB1-2 - 2 2: MB1-3 - 3 1: R1FLAG - FIFO 0: R1INT - FIFO
TX Discretes Bit 2-7: unused
1: TFULL - TX buffer full 0: TEMPTY - TX buffer empty
procedure TBrickletARINC429.DebugReadRegister(const opCode: byte; out value: array of byte; out rwError: byte)
Parameters:
  • opCode – Type: byte, Range: [0 to 255]
Output Parameters:
  • value – Type: array of byte, Range: [0 to 255]
  • rwError – Type: byte, Range: See constants

Debug function to read from a SPI register of the A429 chip.

The following constants are available for this function:

For rwError:

  • BRICKLET_ARINC429_RW_ERROR_OK = 0
  • BRICKLET_ARINC429_RW_ERROR_NO_WRITE = 1
  • BRICKLET_ARINC429_RW_ERROR_NO_READ = 2
  • BRICKLET_ARINC429_RW_ERROR_INVALID_OP_CODE = 3
  • BRICKLET_ARINC429_RW_ERROR_INVALID_LENGTH = 4
  • BRICKLET_ARINC429_RW_ERROR_SPI = 5
function TBrickletARINC429.DebugWriteRegister(const opCode: byte; const value: array of byte): byte
Parameters:
  • opCode – Type: byte, Range: [0 to 255]
  • value – Type: array of byte, Range: [0 to 255]
Returns:
  • rwError – Type: byte, Range: See constants

Debug function to write to a SPI register of the A429 chip.

The following constants are available for this function:

For rwError:

  • BRICKLET_ARINC429_RW_ERROR_OK = 0
  • BRICKLET_ARINC429_RW_ERROR_NO_WRITE = 1
  • BRICKLET_ARINC429_RW_ERROR_NO_READ = 2
  • BRICKLET_ARINC429_RW_ERROR_INVALID_OP_CODE = 3
  • BRICKLET_ARINC429_RW_ERROR_INVALID_LENGTH = 4
  • BRICKLET_ARINC429_RW_ERROR_SPI = 5

Advanced Functions

procedure TBrickletARINC429.GetSPITFPErrorCount(out errorCountAckChecksum: longword; out errorCountMessageChecksum: longword; out errorCountFrame: longword; out errorCountOverflow: longword)
Output Parameters:
  • errorCountAckChecksum – Type: longword, Range: [0 to 232 - 1]
  • errorCountMessageChecksum – Type: longword, Range: [0 to 232 - 1]
  • errorCountFrame – Type: longword, Range: [0 to 232 - 1]
  • errorCountOverflow – Type: longword, Range: [0 to 232 - 1]

Returns the error count for the communication between Brick and Bricklet.

The errors are divided into

  • ACK checksum errors,
  • message checksum errors,
  • framing errors and
  • overflow errors.

The errors counts are for errors that occur on the Bricklet side. All Bricks have a similar function that returns the errors on the Brick side.

procedure TBrickletARINC429.SetStatusLEDConfig(const config: byte)
Parameters:
  • config – Type: byte, Range: See constants, Default: 3

Sets the status LED configuration. By default the LED shows communication traffic between Brick and Bricklet, it flickers once for every 10 received data packets.

You can also turn the LED permanently on/off or show a heartbeat.

If the Bricklet is in bootloader mode, the LED is will show heartbeat by default.

The following constants are available for this function:

For config:

  • BRICKLET_ARINC429_STATUS_LED_CONFIG_OFF = 0
  • BRICKLET_ARINC429_STATUS_LED_CONFIG_ON = 1
  • BRICKLET_ARINC429_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BRICKLET_ARINC429_STATUS_LED_CONFIG_SHOW_STATUS = 3
function TBrickletARINC429.GetStatusLEDConfig: byte
Returns:
  • config – Type: byte, Range: See constants, Default: 3

Returns the configuration as set by SetStatusLEDConfig

The following constants are available for this function:

For config:

  • BRICKLET_ARINC429_STATUS_LED_CONFIG_OFF = 0
  • BRICKLET_ARINC429_STATUS_LED_CONFIG_ON = 1
  • BRICKLET_ARINC429_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BRICKLET_ARINC429_STATUS_LED_CONFIG_SHOW_STATUS = 3
function TBrickletARINC429.GetChipTemperature: smallint
Returns:
  • temperature – Type: smallint, Unit: 1 °C, Range: [-215 to 215 - 1]

Returns the temperature as measured inside the microcontroller. The value returned is not the ambient temperature!

The temperature is only proportional to the real temperature and it has bad accuracy. Practically it is only useful as an indicator for temperature changes.

procedure TBrickletARINC429.Reset

Calling this function will reset the Bricklet. All configurations will be lost.

After a reset you have to create new device objects, calling functions on the existing ones will result in undefined behavior!

procedure TBrickletARINC429.GetIdentity(out uid: string; out connectedUid: string; out position: char; out hardwareVersion: array [0..2] of byte; out firmwareVersion: array [0..2] of byte; out deviceIdentifier: word)
Output Parameters:
  • uid – Type: string, Length: up to 8
  • connectedUid – Type: string, Length: up to 8
  • position – Type: char, Range: ['a' to 'h', 'i', 'z']
  • hardwareVersion – Type: array [0..2] of byte
    • 0: major – Type: byte, Range: [0 to 255]
    • 1: minor – Type: byte, Range: [0 to 255]
    • 2: revision – Type: byte, Range: [0 to 255]
  • firmwareVersion – Type: array [0..2] of byte
    • 0: major – Type: byte, Range: [0 to 255]
    • 1: minor – Type: byte, Range: [0 to 255]
    • 2: revision – Type: byte, Range: [0 to 255]
  • deviceIdentifier – Type: word, Range: [0 to 216 - 1]

Returns the UID, the UID where the Bricklet is connected to, the position, the hardware and firmware version as well as the device identifier.

The position can be 'a', 'b', 'c', 'd', 'e', 'f', 'g' or 'h' (Bricklet Port). The Raspberry Pi HAT (Zero) Brick is always at position 'i' and the Bricklet connected to an Isolator Bricklet is always as position 'z'.

The device identifier numbers can be found here. There is also a constant for the device identifier of this Bricklet.

Virtual Functions

Virtual functions don't communicate with the device itself, but operate only on the API bindings device object. They can be called without the corresponding IP Connection object being connected.

function TBrickletARINC429.GetAPIVersion: array [0..2] of byte
Output Parameters:
  • apiVersion – Type: array [0..2] of byte
    • 0: major – Type: byte, Range: [0 to 255]
    • 1: minor – Type: byte, Range: [0 to 255]
    • 2: revision – Type: byte, Range: [0 to 255]

Returns the version of the API definition implemented by this API bindings. This is neither the release version of this API bindings nor does it tell you anything about the represented Brick or Bricklet.

function TBrickletARINC429.GetResponseExpected(const functionId: byte): boolean
Parameters:
  • functionId – Type: byte, Range: See constants
Returns:
  • responseExpected – Type: boolean

Returns the response expected flag for the function specified by the function ID parameter. It is true if the function is expected to send a response, false otherwise.

For getter functions this is enabled by default and cannot be disabled, because those functions will always send a response. For callback configuration functions it is enabled by default too, but can be disabled by SetResponseExpected. For setter functions it is disabled by default and can be enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is sent and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For functionId:

  • BRICKLET_ARINC429_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BRICKLET_ARINC429_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BRICKLET_ARINC429_FUNCTION_RESET = 243
  • BRICKLET_ARINC429_FUNCTION_WRITE_UID = 248
procedure TBrickletARINC429.SetResponseExpected(const functionId: byte; const responseExpected: boolean)
Parameters:
  • functionId – Type: byte, Range: See constants
  • responseExpected – Type: boolean

Changes the response expected flag of the function specified by the function ID parameter. This flag can only be changed for setter (default value: false) and callback configuration functions (default value: true). For getter functions it is always enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is sent and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For functionId:

  • BRICKLET_ARINC429_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BRICKLET_ARINC429_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BRICKLET_ARINC429_FUNCTION_RESET = 243
  • BRICKLET_ARINC429_FUNCTION_WRITE_UID = 248
procedure TBrickletARINC429.SetResponseExpectedAll(const responseExpected: boolean)
Parameters:
  • responseExpected – Type: boolean

Changes the response expected flag for all setter and callback configuration functions of this device at once.

Internal Functions

Internal functions are used for maintenance tasks such as flashing a new firmware of changing the UID of a Bricklet. These task should be performed using Brick Viewer instead of using the internal functions directly.

function TBrickletARINC429.SetBootloaderMode(const mode: byte): byte
Parameters:
  • mode – Type: byte, Range: See constants
Returns:
  • status – Type: byte, Range: See constants

Sets the bootloader mode and returns the status after the requested mode change was instigated.

You can change from bootloader mode to firmware mode and vice versa. A change from bootloader mode to firmware mode will only take place if the entry function, device identifier and CRC are present and correct.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

The following constants are available for this function:

For mode:

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

For status:

  • BRICKLET_ARINC429_BOOTLOADER_STATUS_OK = 0
  • BRICKLET_ARINC429_BOOTLOADER_STATUS_INVALID_MODE = 1
  • BRICKLET_ARINC429_BOOTLOADER_STATUS_NO_CHANGE = 2
  • BRICKLET_ARINC429_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • BRICKLET_ARINC429_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • BRICKLET_ARINC429_BOOTLOADER_STATUS_CRC_MISMATCH = 5
function TBrickletARINC429.GetBootloaderMode: byte
Returns:
  • mode – Type: byte, Range: See constants

Returns the current bootloader mode, see SetBootloaderMode.

The following constants are available for this function:

For mode:

  • BRICKLET_ARINC429_BOOTLOADER_MODE_BOOTLOADER = 0
  • BRICKLET_ARINC429_BOOTLOADER_MODE_FIRMWARE = 1
  • BRICKLET_ARINC429_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BRICKLET_ARINC429_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BRICKLET_ARINC429_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
procedure TBrickletARINC429.SetWriteFirmwarePointer(const pointer: longword)
Parameters:
  • pointer – Type: longword, Unit: 1 B, Range: [0 to 232 - 1]

Sets the firmware pointer for WriteFirmware. The pointer has to be increased by chunks of size 64. The data is written to flash every 4 chunks (which equals to one page of size 256).

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

function TBrickletARINC429.WriteFirmware(const data: array [0..63] of byte): byte
Parameters:
  • data – Type: array [0..63] of byte, Range: [0 to 255]
Returns:
  • status – Type: byte, Range: [0 to 255]

Writes 64 Bytes of firmware at the position as written by SetWriteFirmwarePointer before. The firmware is written to flash every 4 chunks.

You can only write firmware in bootloader mode.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

procedure TBrickletARINC429.WriteUID(const uid: longword)
Parameters:
  • uid – Type: longword, Range: [0 to 232 - 1]

Writes a new UID into flash. If you want to set a new UID you have to decode the Base58 encoded UID string into an integer first.

We recommend that you use Brick Viewer to change the UID.

function TBrickletARINC429.ReadUID: longword
Returns:
  • uid – Type: longword, Range: [0 to 232 - 1]

Returns the current UID as an integer. Encode as Base58 to get the usual string version.

Constants

const BRICKLET_ARINC429_DEVICE_IDENTIFIER

This constant is used to identify a ARINC429 Bricklet.

The GetIdentity function and the TIPConnection.OnEnumerate callback of the IP Connection have a deviceIdentifier parameter to specify the Brick's or Bricklet's type.

const BRICKLET_ARINC429_DEVICE_DISPLAY_NAME

This constant represents the human readable name of a ARINC429 Bricklet.