Delphi/Lazarus - RS232 Bricklet

Dies ist die Beschreibung der Delphi/Lazarus API Bindings für das RS232 Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des RS232 Bricklet 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
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
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, BrickletRS232;

type
  TExample = class
  private
    ipcon: TIPConnection;
    rs232: TBrickletRS232;
  public
    function StringToCharArray(const message_: string): TArray0To59OfChar;
    function CharArrayToString(const message_: TArray0To59OfChar; const length_: byte): string;
    procedure ReadCB(sender: TBrickletRS232; const message_: TArray0To59OfChar;
                     const length_: byte);
    procedure Execute;
  end;

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

var
  e: TExample;

{ Convert string to char array with length 60, as needed by write }
function TExample.StringToCharArray(const message_: string): TArray0To59OfChar;
var i: longint;
begin
  FillChar(result, 60, 0);
  for i := 1 to Length(message_) do begin
    result[i - 1] := message_[i];
  end;
end;

{ Assume that the message consists of ASCII characters and convert it from
  an array of chars to a string }
function TExample.CharArrayToString(const message_: TArray0To59OfChar; const length_: byte): string;
begin
  SetString(result, PChar(@message_[0]), length_);
end;

{ Callback procedure for read callback }
procedure TExample.ReadCB(sender: TBrickletRS232; const message_: TArray0To59OfChar;
                          const length_: byte);
begin
  WriteLn(Format('Message (Length: %d): "%s"', [length_, CharArrayToString(message_, length_)]));
end;

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

  { Create device object }
  rs232 := TBrickletRS232.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(StringToCharArray('test'), 4);

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

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

rs232 := TBrickletRS232.Create('YOUR_DEVICE_UID', ipcon);

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

function TBrickletRS232.Write(const message: array [0..59] of char; const length: byte): byte

Schreibt einen String aus bis zu 60 Zeichen auf die RS232-Schnittstelle. Der String kann aus Binärdaten bestehen, ASCII o.ä. ist nicht notwendig.

Die Länge des Strings muss als ein zusätzlicher Parameter angegeben werden.

Der Rückgabewert ist die Anzahl der Zeichen die geschrieben werden konnten.

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

procedure TBrickletRS232.Read(out message: array [0..59] of char; out length: byte)

Gibt die aktuell gespeicherte Nachricht zurück. Die maximale Länge beträgt 60. Wenn die Länge als 0 gegeben wird, waren keine neuen Daten verfügbar.

Anstatt mit dieser Funktion zu pollen, ist es auch möglich Callbacks zu nutzen. Siehe EnableReadCallback und OnRead Callback.

procedure TBrickletRS232.SetConfiguration(const baudrate: byte; const parity: byte; const stopbits: byte; const wordlength: byte; const hardwareFlowcontrol: byte; const softwareFlowcontrol: byte)

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

  • Baudrate zwischen 300 und 230400 Baud.
  • Parität von None, Odd, Even und Forced Parity.
  • Stop Bits von 1 oder 2.
  • Wortlänge zwischen 5 und 8.
  • Hard-/Software Flow Control kann entweder an oder aus sein aber nicht beides gleichzeitig an.

Der Standard ist: 115200 Baud, Parität None, 1 Stop Bits, Wortlänge 8, Hard-/Software Flow Control aus.

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

  • BRICKLET_RS232_BAUDRATE_300 = 0
  • BRICKLET_RS232_BAUDRATE_600 = 1
  • BRICKLET_RS232_BAUDRATE_1200 = 2
  • BRICKLET_RS232_BAUDRATE_2400 = 3
  • BRICKLET_RS232_BAUDRATE_4800 = 4
  • BRICKLET_RS232_BAUDRATE_9600 = 5
  • BRICKLET_RS232_BAUDRATE_14400 = 6
  • BRICKLET_RS232_BAUDRATE_19200 = 7
  • BRICKLET_RS232_BAUDRATE_28800 = 8
  • BRICKLET_RS232_BAUDRATE_38400 = 9
  • BRICKLET_RS232_BAUDRATE_57600 = 10
  • BRICKLET_RS232_BAUDRATE_115200 = 11
  • BRICKLET_RS232_BAUDRATE_230400 = 12
  • BRICKLET_RS232_PARITY_NONE = 0
  • BRICKLET_RS232_PARITY_ODD = 1
  • BRICKLET_RS232_PARITY_EVEN = 2
  • BRICKLET_RS232_PARITY_FORCED_PARITY_1 = 3
  • BRICKLET_RS232_PARITY_FORCED_PARITY_0 = 4
  • BRICKLET_RS232_STOPBITS_1 = 1
  • BRICKLET_RS232_STOPBITS_2 = 2
  • BRICKLET_RS232_WORDLENGTH_5 = 5
  • BRICKLET_RS232_WORDLENGTH_6 = 6
  • BRICKLET_RS232_WORDLENGTH_7 = 7
  • BRICKLET_RS232_WORDLENGTH_8 = 8
  • BRICKLET_RS232_HARDWARE_FLOWCONTROL_OFF = 0
  • BRICKLET_RS232_HARDWARE_FLOWCONTROL_ON = 1
  • BRICKLET_RS232_SOFTWARE_FLOWCONTROL_OFF = 0
  • BRICKLET_RS232_SOFTWARE_FLOWCONTROL_ON = 1
procedure TBrickletRS232.GetConfiguration(out baudrate: byte; out parity: byte; out stopbits: byte; out wordlength: byte; out hardwareFlowcontrol: byte; out softwareFlowcontrol: byte)

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

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

  • BRICKLET_RS232_BAUDRATE_300 = 0
  • BRICKLET_RS232_BAUDRATE_600 = 1
  • BRICKLET_RS232_BAUDRATE_1200 = 2
  • BRICKLET_RS232_BAUDRATE_2400 = 3
  • BRICKLET_RS232_BAUDRATE_4800 = 4
  • BRICKLET_RS232_BAUDRATE_9600 = 5
  • BRICKLET_RS232_BAUDRATE_14400 = 6
  • BRICKLET_RS232_BAUDRATE_19200 = 7
  • BRICKLET_RS232_BAUDRATE_28800 = 8
  • BRICKLET_RS232_BAUDRATE_38400 = 9
  • BRICKLET_RS232_BAUDRATE_57600 = 10
  • BRICKLET_RS232_BAUDRATE_115200 = 11
  • BRICKLET_RS232_BAUDRATE_230400 = 12
  • BRICKLET_RS232_PARITY_NONE = 0
  • BRICKLET_RS232_PARITY_ODD = 1
  • BRICKLET_RS232_PARITY_EVEN = 2
  • BRICKLET_RS232_PARITY_FORCED_PARITY_1 = 3
  • BRICKLET_RS232_PARITY_FORCED_PARITY_0 = 4
  • BRICKLET_RS232_STOPBITS_1 = 1
  • BRICKLET_RS232_STOPBITS_2 = 2
  • BRICKLET_RS232_WORDLENGTH_5 = 5
  • BRICKLET_RS232_WORDLENGTH_6 = 6
  • BRICKLET_RS232_WORDLENGTH_7 = 7
  • BRICKLET_RS232_WORDLENGTH_8 = 8
  • BRICKLET_RS232_HARDWARE_FLOWCONTROL_OFF = 0
  • BRICKLET_RS232_HARDWARE_FLOWCONTROL_ON = 1
  • BRICKLET_RS232_SOFTWARE_FLOWCONTROL_OFF = 0
  • BRICKLET_RS232_SOFTWARE_FLOWCONTROL_ON = 1
procedure TBrickletRS232.SetBreakCondition(const breakTime: word)

Setzt eine Break Condition (die TX-Ausgabe wird fest of logisch 0 gezwungen). Der Parameter setzt die Haltezeit der Break Condition (in ms).

Neu in Version 2.0.2 (Plugin).

Fortgeschrittene Funktionen

function TBrickletRS232.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 TBrickletRS232.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.

Siehe SetResponseExpected für die Liste der verfügbaren Funktions ID Konstanten für diese Funktion.

procedure TBrickletRS232.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 Funktions ID Konstanten sind für diese Funktion verfügbar:

  • BRICKLET_RS232_FUNCTION_ENABLE_READ_CALLBACK = 3
  • BRICKLET_RS232_FUNCTION_DISABLE_READ_CALLBACK = 4
  • BRICKLET_RS232_FUNCTION_SET_CONFIGURATION = 6
  • BRICKLET_RS232_FUNCTION_SET_BREAK_CONDITION = 10
procedure TBrickletRS232.SetResponseExpectedAll(const responseExpected: boolean)

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

procedure TBrickletRS232.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 TBrickletRS232.EnableReadCallback

Aktiviert den OnRead Callback.

Im Startzustand ist der Callback deaktiviert

procedure TBrickletRS232.DisableReadCallback

Deaktiviert den OnRead Callback.

Im Startzustand ist der Callback deaktiviert

function TBrickletRS232.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: TBrickletRS232; const param: word);
begin
  WriteLn(param);
end;

rs232.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 TBrickletRS232.OnRead
procedure(sender: TBrickletRS232; const message: array [0..59] of char; const length: byte) of object;

Dieser Callback wird aufgerufen wenn neue Daten zur Verfügung stehen. Die Nachricht hat eine Maximalgröße von 60 Zeichen. Die Länge der Nachricht wird zusätzlich übergeben.

Dieser Callback kann durch EnableReadCallback aktiviert werden.

property TBrickletRS232.OnError
procedure(sender: TBrickletRS232; const error: byte) of object;

Dieser Callback wird aufgerufen wenn ein Fehler auftritt. Mögliche Fehler sind Overrun-, Parity- oder Framing-Fehler.

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

  • BRICKLET_RS232_ERROR_OVERRUN = 1
  • BRICKLET_RS232_ERROR_PARITY = 2
  • BRICKLET_RS232_ERROR_FRAMING = 4

Neu in Version 2.0.1 (Plugin).

Konstanten

const BRICKLET_RS232_DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein RS232 Bricklet 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_DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines RS232 Bricklet dar.