Delphi/Lazarus - RS232 Bricklet 2.0

Dies ist die Beschreibung der Delphi/Lazarus API Bindings für das RS232 Bricklet 2.0. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des RS232 Bricklet 2.0 sind in dessen Hardware Beschreibung zusammengefasst.

Eine Installationanleitung für die Delphi/Lazarus API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Loopback

Download (ExampleLoopback.pas)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
program ExampleLoopback;

{ For this example connect the RX pin to the TX pin on the same Bricklet }

{$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

Da Delphi nicht mehrere Rückgabewerte direkt unterstützt, wird das out Schlüsselwort genutzt um mehrere Werte von einer Funktion zurückzugeben.

Alle folgend aufgelisteten Funktionen und Prozeduren sind Thread-sicher.

Grundfunktionen

constructor TBrickletRS232V2.Create(const uid: string; ipcon: TIPConnection)

Erzeugt ein Objekt mit der eindeutigen Geräte ID uid:

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

Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist (siehe Beispiele oben).

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

Schreibt Zeichen auf die RS232-Schnittstelle. Die Zeichen können Binärdaten sein, ASCII o.ä. ist nicht notwendig.

Der Rückgabewert ist die Anzahl der Zeichen die geschrieben wurden.

Siehe SetConfiguration für Konfigurationsmöglichkeiten bezüglich Baudrate, Parität usw.

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

Gibt bis zu length Zeichen aus dem Empfangsbuffer zurück.

Anstatt mit dieser Funktion zu pollen, ist es auch möglich Callbacks zu nutzen. Diese Funktion gibt nur Daten zurück wenn der Read-Callback nicht aktiv ist. Siehe EnableReadCallback und OnRead Callback.

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

Setzt die Konfiguration für die RS232-Kommunikation. Verfügbare Optionen sind:

  • Baudrate zwischen 100 und 2000000 Baud.
  • Parität von None, Odd und Even.
  • Stopp-Bits von 1 oder 2.
  • Wortlänge zwischen 5 und 8.
  • Flow Control kann aus, Software oder Hardware sein.

Der Standard ist: 115200 Baud, Parität None, 1 Stop Bits, Wortlänge 8.

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

  • BRICKLET_RS232_V2_PARITY_NONE = 0
  • BRICKLET_RS232_V2_PARITY_ODD = 1
  • BRICKLET_RS232_V2_PARITY_EVEN = 2
  • BRICKLET_RS232_V2_STOPBITS_1 = 1
  • BRICKLET_RS232_V2_STOPBITS_2 = 2
  • BRICKLET_RS232_V2_WORDLENGTH_5 = 5
  • BRICKLET_RS232_V2_WORDLENGTH_6 = 6
  • BRICKLET_RS232_V2_WORDLENGTH_7 = 7
  • BRICKLET_RS232_V2_WORDLENGTH_8 = 8
  • 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)

Gibt die Konfiguration zurück, wie von SetConfiguration gesetzt.

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

  • BRICKLET_RS232_V2_PARITY_NONE = 0
  • BRICKLET_RS232_V2_PARITY_ODD = 1
  • BRICKLET_RS232_V2_PARITY_EVEN = 2
  • BRICKLET_RS232_V2_STOPBITS_1 = 1
  • BRICKLET_RS232_V2_STOPBITS_2 = 2
  • BRICKLET_RS232_V2_WORDLENGTH_5 = 5
  • BRICKLET_RS232_V2_WORDLENGTH_6 = 6
  • BRICKLET_RS232_V2_WORDLENGTH_7 = 7
  • BRICKLET_RS232_V2_WORDLENGTH_8 = 8
  • BRICKLET_RS232_V2_FLOWCONTROL_OFF = 0
  • BRICKLET_RS232_V2_FLOWCONTROL_SOFTWARE = 1
  • BRICKLET_RS232_V2_FLOWCONTROL_HARDWARE = 2

Fortgeschrittene Funktionen

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

Setzt die Größe des Sende- und Empfangsbuffers. In Summe müssen die Buffer eine Größe von 10240 Byte (10kb) haben, die Minimalgröße ist 1024 Byte (1kb) für beide.

Der aktuelle Bufferinhalt geht bei einem Aufruf dieser Funktion verloren.

Der Sendebuffer hält die Daten welche über Write übergeben und noch nicht geschrieben werden konnten. Der Empfangsbuffer hält Daten welche über RS232 empfangen wurden aber noch nicht über Read oder OnRead Callback an ein Nutzerprogramm übertragen werden konnten.

Die Standardkonfiguration ist 5120 Byte (5kb) pro Buffer.

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

Gibt die Buffer-Konfiguration zurück, wie von SetBufferConfig gesetzt.

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

Gibt die aktuell genutzten Bytes des Sende- und Empfangsbuffers zurück.

Siehe SetBufferConfig zur Konfiguration der Buffergrößen.

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

Gibt die aktuelle Anzahl an Overrun und Parity Fehlern zurück.

function TBrickletRS232V2.GetAPIVersion: array [0..2] of byte

Gibt die Version der API Definition (Major, Minor, Revision) 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.

function TBrickletRS232V2.GetResponseExpected(const functionId: byte): boolean

Gibt das Response-Expected-Flag für die Funktion mit der angegebenen Funktions IDs zurück. Es ist true falls für die Funktion beim Aufruf eine Antwort erwartet wird, false andernfalls.

Für Getter-Funktionen ist diese Flag immer gesetzt und kann nicht entfernt werden, da diese Funktionen immer eine Antwort senden. Für Konfigurationsfunktionen für 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:

  • 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_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)

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

  • 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_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)

Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.

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

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.

function TBrickletRS232V2.SetBootloaderMode(const mode: byte): byte

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

  • 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
  • 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

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

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

  • 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)

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.

function TBrickletRS232V2.WriteFirmware(const data: array [0..63] of byte): byte

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.

procedure TBrickletRS232V2.SetStatusLEDConfig(const config: byte)

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:

  • 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

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

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

  • 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

Gibt die Temperatur in °C, 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.

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

procedure TBrickletRS232V2.WriteUID(const uid: longword)

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.

function TBrickletRS232V2.ReadUID: longword

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

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)

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 kann 'a', 'b', 'c' oder 'd' sein.

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

procedure TBrickletRS232V2.EnableReadCallback

Aktiviert den OnRead Callback.

Im Startzustand ist der Callback deaktiviert.

procedure TBrickletRS232V2.DisableReadCallback

Deaktiviert den OnRead Callback.

Im Startzustand ist der Callback deaktiviert.

function TBrickletRS232V2.IsReadCallbackEnabled: boolean

Gibt true zurück falls OnRead Callback aktiviert ist, false sonst.

Callbacks

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung erfolgt indem eine Prozedur einem Callback Property des Geräte Objektes zugewiesen wird:

procedure TExample.MyCallback(sender: TBrickletRS232V2; const param: word);
begin
  WriteLn(param);
end;

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

Die verfügbaren Callback Properties und ihre Parametertypen 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.

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

Dieser Callback wird aufgerufen wenn neue Daten zur Verfügung stehen.

Dieser Callback kann durch EnableReadCallback aktiviert werden.

Bemerkung

Falls das Rekonstruieren des Wertes fehlschlägt, wird der Callback mit nil für message ausgelöst.

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

Dieser Callback wird aufgerufen wenn ein neuer Fehler auftritt. Er gibt die Anzahl der aufgetreten Overrun und Parity Fehler zurück.

Konstanten

const BRICKLET_RS232_V2_DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein RS232 Bricklet 2.0 zu identifizieren.

Die GetIdentity Funktion und der TIPConnection.OnEnumerate Callback der IP Connection haben ein deviceIdentifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

const BRICKLET_RS232_V2_DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines RS232 Bricklet 2.0 dar.