Software / API Bindings / Delphi/Lazarus / API Reference and Examples / Bricklets / RS232 Bricklet 2.0

Delphi/Lazarus - RS232 Bricklet 2.0¶

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

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

Examples¶

The example code below is Public Domain (CC0 1.0).

Loopback¶

Download (ExampleLoopback.pas)

program ExampleLoopback;

{ For this example connect the RX1 and TX pin to receive the send message }

{$ifdef MSWINDOWS}{$apptype CONSOLE}{$endif}
{$ifdef FPC}{$mode OBJFPC}{$H+}{$endif}

uses
  SysUtils, IPConnection, BrickletRS232V2;

type
  TExample = class
  private
    ipcon: TIPConnection;
    rs232: TBrickletRS232V2;
  public
    procedure ReadCB(sender: TBrickletRS232V2; const message_: TArrayOfChar);
    procedure Execute;
  end;

const
  HOST = 'localhost';
  PORT = 4223;
  UID = 'XYZ'; { Change XYZ to the UID of your RS232 Bricklet 2.0 }

var
  e: TExample;

{ Callback procedure for read callback }
procedure TExample.ReadCB(sender: TBrickletRS232V2; const message_: TArrayOfChar);
var str: string;
begin
  { Assume that the message consists of ASCII characters and
    convert it from an array of chars to a string }
  SetString(str, PChar(@message_[0]), Length(message_));
  WriteLn(Format('Message: "%s"', [str]));
end;

procedure TExample.Execute;
begin
  { Create IP connection }
  ipcon := TIPConnection.Create;

  { Create device object }
  rs232 := TBrickletRS232V2.Create(UID, ipcon);

  { Connect to brickd }
  ipcon.Connect(HOST, PORT);
  { Don't use device before ipcon is connected }

  { Register read callback to procedure ReadCB }
  rs232.OnRead := {$ifdef FPC}@{$endif}ReadCB;

  { Enable read callback }
  rs232.EnableReadCallback;

  { Write "test" string }
  rs232.Write(['t', 'e', 's', 't']);

  WriteLn('Press key to exit');
  ReadLn;
  ipcon.Destroy; { Calls ipcon.Disconnect internally }
end;

begin
  e := TExample.Create;
  e.Execute;
  e.Destroy;
end.

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 TBrickletRS232V2.Create(const uid: string; ipcon: TIPConnection)¶

Parameters:	uid – Type: string ipcon – Type: TIPConnection
Returns:	rs232V2 – Type: TBrickletRS232V2

Creates an object with the unique device ID uid:

rs232V2 := TBrickletRS232V2.Create('YOUR_DEVICE_UID', ipcon);

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

function TBrickletRS232V2.Write(const message: array of char): word¶

Parameters:	message – Type: array of char
Returns:	messageWritten – Type: word, Range: [0 to 2¹⁶ - 1]

Writes characters to the RS232 interface. The characters can be binary data, ASCII or similar is not necessary.

The return value is the number of characters that were written.

See SetConfiguration for configuration possibilities regarding baud rate, parity and so on.

function TBrickletRS232V2.Read(const length: word): array of char¶

Parameters:	length – Type: word, Range: [0 to 2¹⁶ - 1]
Returns:	message – Type: array of char

Returns up to length characters from receive buffer.

Instead of polling with this function, you can also use callbacks. But note that this function will return available data only when the read callback is disabled. See EnableReadCallback and OnRead callback.

procedure TBrickletRS232V2.SetConfiguration(const baudrate: longword; const parity: byte; const stopbits: byte; const wordlength: byte; const flowcontrol: byte)¶

Parameters:	baudrate – Type: longword, Unit: 1 Bd, Range: [100 to 2000000], Default: 115200 parity – Type: byte, Range: See constants, Default: 0 stopbits – Type: byte, Range: See constants, Default: 1 wordlength – Type: byte, Range: See constants, Default: 8 flowcontrol – Type: byte, Range: See constants, Default: 0

Sets the configuration for the RS232 communication.

The following constants are available for this function:

For parity:

BRICKLET_RS232_V2_PARITY_NONE = 0
BRICKLET_RS232_V2_PARITY_ODD = 1
BRICKLET_RS232_V2_PARITY_EVEN = 2

For stopbits:

BRICKLET_RS232_V2_STOPBITS_1 = 1
BRICKLET_RS232_V2_STOPBITS_2 = 2

For wordlength:

BRICKLET_RS232_V2_WORDLENGTH_5 = 5
BRICKLET_RS232_V2_WORDLENGTH_6 = 6
BRICKLET_RS232_V2_WORDLENGTH_7 = 7
BRICKLET_RS232_V2_WORDLENGTH_8 = 8

For flowcontrol:

BRICKLET_RS232_V2_FLOWCONTROL_OFF = 0
BRICKLET_RS232_V2_FLOWCONTROL_SOFTWARE = 1
BRICKLET_RS232_V2_FLOWCONTROL_HARDWARE = 2

procedure TBrickletRS232V2.GetConfiguration(out baudrate: longword; out parity: byte; out stopbits: byte; out wordlength: byte; out flowcontrol: byte)¶

Output Parameters:	baudrate – Type: longword, Unit: 1 Bd, Range: [100 to 2000000], Default: 115200 parity – Type: byte, Range: See constants, Default: 0 stopbits – Type: byte, Range: See constants, Default: 1 wordlength – Type: byte, Range: See constants, Default: 8 flowcontrol – Type: byte, Range: See constants, Default: 0

Returns the configuration as set by SetConfiguration.

The following constants are available for this function:

For parity:

BRICKLET_RS232_V2_PARITY_NONE = 0
BRICKLET_RS232_V2_PARITY_ODD = 1
BRICKLET_RS232_V2_PARITY_EVEN = 2

For stopbits:

BRICKLET_RS232_V2_STOPBITS_1 = 1
BRICKLET_RS232_V2_STOPBITS_2 = 2

For wordlength:

BRICKLET_RS232_V2_WORDLENGTH_5 = 5
BRICKLET_RS232_V2_WORDLENGTH_6 = 6
BRICKLET_RS232_V2_WORDLENGTH_7 = 7
BRICKLET_RS232_V2_WORDLENGTH_8 = 8

For flowcontrol:

BRICKLET_RS232_V2_FLOWCONTROL_OFF = 0
BRICKLET_RS232_V2_FLOWCONTROL_SOFTWARE = 1
BRICKLET_RS232_V2_FLOWCONTROL_HARDWARE = 2

Advanced Functions¶

procedure TBrickletRS232V2.SetBufferConfig(const sendBufferSize: word; const receiveBufferSize: word)¶

Parameters:	sendBufferSize – Type: word, Unit: 1 B, Range: [2¹⁰ to 9216], Default: 5120 receiveBufferSize – Type: word, Unit: 1 B, Range: [2¹⁰ to 9216], Default: 5120

Sets the send and receive buffer size in byte. In total the buffers have to be 10240 byte (10KiB) in size, the minimum buffer size is 1024 byte (1KiB) for each.

The current buffer content is lost if this function is called.

The send buffer holds data that is given by Write and can not be written yet. The receive buffer holds data that is received through RS232 but could not yet be send to the user, either by Read or through OnRead callback.

procedure TBrickletRS232V2.GetBufferConfig(out sendBufferSize: word; out receiveBufferSize: word)¶

Output Parameters:	sendBufferSize – Type: word, Unit: 1 B, Range: [2¹⁰ to 9216], Default: 5120 receiveBufferSize – Type: word, Unit: 1 B, Range: [2¹⁰ to 9216], Default: 5120

Returns the buffer configuration as set by SetBufferConfig.

procedure TBrickletRS232V2.GetBufferStatus(out sendBufferUsed: word; out receiveBufferUsed: word)¶

Output Parameters:	sendBufferUsed – Type: word, Unit: 1 B, Range: [0 to 9216] receiveBufferUsed – Type: word, Unit: 1 B, Range: [0 to 9216]

Returns the currently used bytes for the send and received buffer.

See SetBufferConfig for buffer size configuration.

procedure TBrickletRS232V2.GetErrorCount(out errorCountOverrun: longword; out errorCountParity: longword)¶

Output Parameters:	errorCountOverrun – Type: longword, Range: [0 to 2³² - 1] errorCountParity – Type: longword, Range: [0 to 2³² - 1]

Returns the current number of overrun and parity errors.

procedure TBrickletRS232V2.GetSPITFPErrorCount(out errorCountAckChecksum: longword; out errorCountMessageChecksum: longword; out errorCountFrame: longword; out errorCountOverflow: longword)¶

Output Parameters:	errorCountAckChecksum – Type: longword, Range: [0 to 2³² - 1] errorCountMessageChecksum – Type: longword, Range: [0 to 2³² - 1] errorCountFrame – Type: longword, Range: [0 to 2³² - 1] errorCountOverflow – Type: longword, Range: [0 to 2³² - 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 TBrickletRS232V2.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_RS232_V2_STATUS_LED_CONFIG_OFF = 0
BRICKLET_RS232_V2_STATUS_LED_CONFIG_ON = 1
BRICKLET_RS232_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
BRICKLET_RS232_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3

function TBrickletRS232V2.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_RS232_V2_STATUS_LED_CONFIG_OFF = 0
BRICKLET_RS232_V2_STATUS_LED_CONFIG_ON = 1
BRICKLET_RS232_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
BRICKLET_RS232_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3

function TBrickletRS232V2.GetChipTemperature: smallint¶

Returns:	temperature – Type: smallint, Unit: 1 °C, Range: [-2¹⁵ to 2¹⁵ - 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 TBrickletRS232V2.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 TBrickletRS232V2.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:

Output Parameters:	uid – Type: string, Length: up to 8 connectedUid – Type: string, Length: up to 8 position – Type: char, Range: ['a' to 'h', '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 2¹⁶ - 1]

uid – Type: string, Length: up to 8
connectedUid – Type: string, Length: up to 8
position – Type: char, Range: ['a' to 'h', '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 2¹⁶ - 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). A Bricklet connected to an Isolator Bricklet is always at position 'z'.

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

Callback Configuration Functions¶

procedure TBrickletRS232V2.EnableReadCallback¶

Enables the OnRead callback. This will disable the OnFrameReadable callback.

By default the callback is disabled.

procedure TBrickletRS232V2.DisableReadCallback¶

Disables the OnRead callback.

By default the callback is disabled.

function TBrickletRS232V2.IsReadCallbackEnabled: boolean¶

Returns:	enabled – Type: boolean, Default: false

Returns true if the OnRead callback is enabled, false otherwise.

procedure TBrickletRS232V2.SetFrameReadableCallbackConfiguration(const frameSize: word)¶

Parameters:	frameSize – Type: word, Unit: 1 B, Range: [0 to 9216], Default: 0

Configures the OnFrameReadable callback. The frame size is the number of bytes, that have to be readable to trigger the callback. A frame size of 0 disables the callback. A frame size greater than 0 enables the callback and disables the OnRead callback.

By default the callback is disabled.

New in version 2.0.3 (Plugin).

function TBrickletRS232V2.GetFrameReadableCallbackConfiguration: word¶

Returns:	frameSize – Type: word, Unit: 1 B, Range: [0 to 9216], Default: 0

Returns the callback configuration as set by SetFrameReadableCallbackConfiguration.

New in version 2.0.3 (Plugin).

Callbacks¶

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done by assigning a procedure to an callback property of the device object:

procedure TExample.MyCallback(sender: TBrickletRS232V2; const value: longint);
begin
  WriteLn(Format('Value: %d', [value]));
end;

rs232V2.OnExample := {$ifdef FPC}@{$endif}example.MyCallback;

The available callback properties and their parameter types are described below.

Note

Using callbacks for recurring events is always preferred compared to using getters. It will use less USB bandwidth and the latency will be a lot better, since there is no round trip time.

property TBrickletRS232V2.OnRead¶

procedure(sender: TBrickletRS232V2; const message: array of char) of object;

Callback Parameters:	sender – Type: TBrickletRS232V2 message – Type: array of char

This callback is called if new data is available.

To enable this callback, use EnableReadCallback.

Note

If reconstructing the value fails, the callback is triggered with nil for message.

property TBrickletRS232V2.OnErrorCount¶

procedure(sender: TBrickletRS232V2; const errorCountOverrun: longword; const errorCountParity: longword) of object;

Callback Parameters:	sender – Type: TBrickletRS232V2 errorCountOverrun – Type: longword, Range: [0 to 2³² - 1] errorCountParity – Type: longword, Range: [0 to 2³² - 1]

This callback is called if a new error occurs. It returns the current overrun and parity error count.

property TBrickletRS232V2.OnFrameReadable¶

procedure(sender: TBrickletRS232V2; const frameCount: word) of object;

Callback Parameters:	sender – Type: TBrickletRS232V2 frameCount – Type: word, Range: [0 to 2¹⁶ - 1]

This callback is called if at least one frame of data is readable. The frame size is configured with SetFrameReadableCallbackConfiguration. The frame count parameter is the number of frames that can be read. This callback is triggered only once until Read is called. This means, that if you have configured a frame size of X bytes, you can read exactly X bytes using the Read function, every time the callback triggers without checking the frame count parameter.

New in version 2.0.3 (Plugin).

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 TBrickletRS232V2.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 TBrickletRS232V2.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_RS232_V2_FUNCTION_ENABLE_READ_CALLBACK = 3
BRICKLET_RS232_V2_FUNCTION_DISABLE_READ_CALLBACK = 4
BRICKLET_RS232_V2_FUNCTION_SET_CONFIGURATION = 6
BRICKLET_RS232_V2_FUNCTION_SET_BUFFER_CONFIG = 8
BRICKLET_RS232_V2_FUNCTION_SET_FRAME_READABLE_CALLBACK_CONFIGURATION = 14
BRICKLET_RS232_V2_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
BRICKLET_RS232_V2_FUNCTION_SET_STATUS_LED_CONFIG = 239
BRICKLET_RS232_V2_FUNCTION_RESET = 243
BRICKLET_RS232_V2_FUNCTION_WRITE_UID = 248

procedure TBrickletRS232V2.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.

The following constants are available for this function:

For functionId:

BRICKLET_RS232_V2_FUNCTION_ENABLE_READ_CALLBACK = 3
BRICKLET_RS232_V2_FUNCTION_DISABLE_READ_CALLBACK = 4
BRICKLET_RS232_V2_FUNCTION_SET_CONFIGURATION = 6
BRICKLET_RS232_V2_FUNCTION_SET_BUFFER_CONFIG = 8
BRICKLET_RS232_V2_FUNCTION_SET_FRAME_READABLE_CALLBACK_CONFIGURATION = 14
BRICKLET_RS232_V2_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
BRICKLET_RS232_V2_FUNCTION_SET_STATUS_LED_CONFIG = 239
BRICKLET_RS232_V2_FUNCTION_RESET = 243
BRICKLET_RS232_V2_FUNCTION_WRITE_UID = 248

procedure TBrickletRS232V2.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 TBrickletRS232V2.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_RS232_V2_BOOTLOADER_MODE_BOOTLOADER = 0
BRICKLET_RS232_V2_BOOTLOADER_MODE_FIRMWARE = 1
BRICKLET_RS232_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
BRICKLET_RS232_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
BRICKLET_RS232_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

For status:

BRICKLET_RS232_V2_BOOTLOADER_STATUS_OK = 0
BRICKLET_RS232_V2_BOOTLOADER_STATUS_INVALID_MODE = 1
BRICKLET_RS232_V2_BOOTLOADER_STATUS_NO_CHANGE = 2
BRICKLET_RS232_V2_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
BRICKLET_RS232_V2_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
BRICKLET_RS232_V2_BOOTLOADER_STATUS_CRC_MISMATCH = 5

function TBrickletRS232V2.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_RS232_V2_BOOTLOADER_MODE_BOOTLOADER = 0
BRICKLET_RS232_V2_BOOTLOADER_MODE_FIRMWARE = 1
BRICKLET_RS232_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
BRICKLET_RS232_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
BRICKLET_RS232_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

procedure TBrickletRS232V2.SetWriteFirmwarePointer(const pointer: longword)¶

Parameters:	pointer – Type: longword, Unit: 1 B, Range: [0 to 2³² - 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 TBrickletRS232V2.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 TBrickletRS232V2.WriteUID(const uid: longword)¶

Parameters:	uid – Type: longword, Range: [0 to 2³² - 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 TBrickletRS232V2.ReadUID: longword¶

Returns:	uid – Type: longword, Range: [0 to 2³² - 1]

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

Constants¶

const BRICKLET_RS232_V2_DEVICE_IDENTIFIER¶

This constant is used to identify a RS232 Bricklet 2.0.

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_RS232_V2_DEVICE_DISPLAY_NAME¶: This constant represents the human readable name of a RS232 Bricklet 2.0.