Dies ist die Beschreibung der Delphi/Lazarus API Bindings für das LCD 20x4 Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des LCD 20x4 Bricklet sind in dessen Hardware Beschreibung zusammengefasst.
Eine Installationanleitung für die Delphi/Lazarus API Bindings ist Teil deren allgemeine Beschreibung.
Der folgende Beispielcode ist Public Domain (CC0 1.0).
Download (ExampleHelloWorld.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 | program ExampleHelloWorld;
{$ifdef MSWINDOWS}{$apptype CONSOLE}{$endif}
{$ifdef FPC}{$mode OBJFPC}{$H+}{$endif}
uses
SysUtils, IPConnection, BrickletLCD20x4;
type
TExample = class
private
ipcon: TIPConnection;
lcd: TBrickletLCD20x4;
public
procedure Execute;
end;
const
HOST = 'localhost';
PORT = 4223;
UID = 'XYZ'; { Change XYZ to the UID of your LCD 20x4 Bricklet }
var
e: TExample;
procedure TExample.Execute;
begin
{ Create IP connection }
ipcon := TIPConnection.Create;
{ Create device object }
lcd := TBrickletLCD20x4.Create(UID, ipcon);
{ Connect to brickd }
ipcon.Connect(HOST, PORT);
{ Don't use device before ipcon is connected }
{ Turn backlight on }
lcd.BacklightOn;
{ Write "Hello World" }
lcd.WriteLine(0, 0, 'Hello World');
WriteLn('Press key to exit');
ReadLn;
ipcon.Destroy; { Calls ipcon.Disconnect internally }
end;
begin
e := TExample.Create;
e.Execute;
e.Destroy;
end.
|
Download (ExampleButtonCallback.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 | program ExampleButtonCallback;
{$ifdef MSWINDOWS}{$apptype CONSOLE}{$endif}
{$ifdef FPC}{$mode OBJFPC}{$H+}{$endif}
uses
SysUtils, IPConnection, BrickletLCD20x4;
type
TExample = class
private
ipcon: TIPConnection;
lcd: TBrickletLCD20x4;
public
procedure ButtonPressedCB(sender: TBrickletLCD20x4; const button: byte);
procedure ButtonReleasedCB(sender: TBrickletLCD20x4; const button: byte);
procedure Execute;
end;
const
HOST = 'localhost';
PORT = 4223;
UID = 'XYZ'; { Change XYZ to the UID of your LCD 20x4 Bricklet }
var
e: TExample;
{ Callback procedure for button pressed callback }
procedure TExample.ButtonPressedCB(sender: TBrickletLCD20x4; const button: byte);
begin
WriteLn(Format('Button Pressed: %d', [button]));
end;
{ Callback procedure for button released callback }
procedure TExample.ButtonReleasedCB(sender: TBrickletLCD20x4; const button: byte);
begin
WriteLn(Format('Button Released: %d', [button]));
end;
procedure TExample.Execute;
begin
{ Create IP connection }
ipcon := TIPConnection.Create;
{ Create device object }
lcd := TBrickletLCD20x4.Create(UID, ipcon);
{ Connect to brickd }
ipcon.Connect(HOST, PORT);
{ Don't use device before ipcon is connected }
{ Register button pressed callback to procedure ButtonPressedCB }
lcd.OnButtonPressed := {$ifdef FPC}@{$endif}ButtonPressedCB;
{ Register button released callback to procedure ButtonReleasedCB }
lcd.OnButtonReleased := {$ifdef FPC}@{$endif}ButtonReleasedCB;
WriteLn('Press key to exit');
ReadLn;
ipcon.Destroy; { Calls ipcon.Disconnect internally }
end;
begin
e := TExample.Create;
e.Execute;
e.Destroy;
end.
|
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 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 | program ExampleUnicode;
{$ifdef MSWINDOWS}{$apptype CONSOLE}{$endif}
{$ifdef FPC}{$mode OBJFPC}{$H+}{$endif}
uses
SysUtils, IPConnection, BrickletLCD20x4;
type
TExample = class
private
ipcon: TIPConnection;
lcd: TBrickletLCD20x4;
public
function WideStringToKS0066U(const text: WideString): string;
procedure Execute;
end;
const
HOST = 'localhost';
PORT = 4223;
UID = 'XYZ'; { Change XYZ to the UID of your LCD 20x4 Bricklet }
var
e: TExample;
function TExample.WideStringToKS0066U(const text: WideString): string;
var i, codePoint: longint; w: word; c: char; ks0066u: string;
begin
i := 1;
SetLength(ks0066u, 0);
while (i <= Length(text)) do begin
{ WideString is UTF-16, handle surrogates }
w := word(text[i]);
if ((w >= $D800) and (w <= $DBFF)) then begin
codePoint := $10000 + (w - $D800) * $400 + (w - $DC00);
i := i + 2;
end
else begin
codePoint := w;
i := i + 1;
end;
{ ASCII subset from JIS X 0201 }
if ((codePoint >= $0020) and (codePoint <= $007E)) then begin
{ The LCD charset doesn't include '\' and '~', use similar characters instead }
case codePoint of
$005C: c := char($A4); { REVERSE SOLIDUS maps to IDEOGRAPHIC COMMA }
$007E: c := char($2D); { TILDE maps to HYPHEN-MINUS }
else c := char(codePoint);
end;
end
{ Katakana subset from JIS X 0201 }
else if ((codePoint >= $FF61) and (codePoint <= $FF9F)) then begin
c := char(codePoint - $FEC0);
end
{ Special characters }
else begin
case codePoint of
$00A5: c := char($5C); { YEN SIGN }
$2192: c := char($7E); { RIGHTWARDS ARROW }
$2190: c := char($7F); { LEFTWARDS ARROW }
$00B0: c := char($DF); { DEGREE SIGN maps to KATAKANA SEMI-VOICED SOUND MARK }
$03B1: c := char($E0); { GREEK SMALL LETTER ALPHA }
$00C4: c := char($E1); { LATIN CAPITAL LETTER A WITH DIAERESIS }
$00E4: c := char($E1); { LATIN SMALL LETTER A WITH DIAERESIS }
$00DF: c := char($E2); { LATIN SMALL LETTER SHARP S }
$03B5: c := char($E3); { GREEK SMALL LETTER EPSILON }
$00B5: c := char($E4); { MICRO SIGN }
$03BC: c := char($E4); { GREEK SMALL LETTER MU }
$03C2: c := char($E5); { GREEK SMALL LETTER FINAL SIGMA }
$03C1: c := char($E6); { GREEK SMALL LETTER RHO }
$221A: c := char($E8); { SQUARE ROOT }
$00B9: c := char($E9); { SUPERSCRIPT ONE maps to SUPERSCRIPT (minus) ONE }
$00A4: c := char($EB); { CURRENCY SIGN }
$00A2: c := char($EC); { CENT SIGN }
$2C60: c := char($ED); { LATIN CAPITAL LETTER L WITH DOUBLE BAR }
$00F1: c := char($EE); { LATIN SMALL LETTER N WITH TILDE }
$00D6: c := char($EF); { LATIN CAPITAL LETTER O WITH DIAERESIS }
$00F6: c := char($EF); { LATIN SMALL LETTER O WITH DIAERESIS }
$03F4: c := char($F2); { GREEK CAPITAL THETA SYMBOL }
$221E: c := char($F3); { INFINITY }
$03A9: c := char($F4); { GREEK CAPITAL LETTER OMEGA }
$00DC: c := char($F5); { LATIN CAPITAL LETTER U WITH DIAERESIS }
$00FC: c := char($F5); { LATIN SMALL LETTER U WITH DIAERESIS }
$03A3: c := char($F6); { GREEK CAPITAL LETTER SIGMA }
$03C0: c := char($F7); { GREEK SMALL LETTER PI }
$0304: c := char($F8); { COMBINING MACRON }
$00F7: c := char($FD); { DIVISION SIGN }
$25A0: c := char($FF); { BLACK SQUARE }
else c := char($FF); { BLACK SQUARE }
end
end;
{ Special handling for 'x' followed by COMBINING MACRON }
if (c = char($F8)) then begin
if (ks0066u[Length(ks0066u) - 1] <> 'x') then begin
c := char($FF); { BLACK SQUARE }
end;
if (Length(ks0066u) > 0) then begin
SetLength(ks0066u, Length(ks0066u) - 1);
end;
end;
ks0066u := ks0066u + c;
end;
result := ks0066u;
end;
procedure TExample.Execute;
begin
{ Create IP connection }
ipcon := TIPConnection.Create;
{ Create device object }
lcd := TBrickletLCD20x4.Create(UID, ipcon);
{ Connect to brickd }
ipcon.Connect(HOST, PORT);
{ Don't use device before ipcon is connected }
{ Turn backlight on }
lcd.BacklightOn;
{ Write a string using the WideStringToKS0066U function to map to the LCD charset }
{ Note: For the Free Pascal Compiler (and Lazarus) UTF8Decode is used to create a
WideString. It assumes that your source file is UTF-8 encoded }
lcd.WriteLine(0, 0, WideStringToKS0066U({$ifdef FPC}UTF8Decode{$endif}('Stromstärke: 17µA')));
lcd.WriteLine(1, 0, WideStringToKS0066U({$ifdef FPC}UTF8Decode{$endif}('Temperatur: 23°C')));
{ Write a string directly including characters from the LCD charset }
lcd.WriteLine(2, 0, 'Drehzahl: 750min' + char($E9));
WriteLn('Press key to exit');
ReadLn;
ipcon.Destroy; { Calls ipcon.Disconnect internally }
end;
begin
e := TExample.Create;
e.Execute;
e.Destroy;
end.
|
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.
TBrickletLCD20x4.
Create
(const uid: string; ipcon: TIPConnection)¶Parameter: |
|
---|---|
Rückgabe: |
|
Erzeugt ein Objekt mit der eindeutigen Geräte ID uid
:
lcd20x4 := TBrickletLCD20x4.Create('YOUR_DEVICE_UID', ipcon);
Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.
TBrickletLCD20x4.
WriteLine
(const line: byte; const position: byte; const text: string)¶Parameter: |
|
---|
Schreibt einen Text in die angegebene Zeile mit einer vorgegebenen Position. Der Text kann maximal 20 Zeichen lang sein.
Beispiel: (0, 7, "Hallo") schreibt Hallo in die Mitte der ersten Zeile des Display.
Das Display nutzt einen speziellen Zeichensatz der alle ASCII Zeichen beinhaltet außer Backslash und Tilde. Der Zeichensatz des LCD beinhaltet weiterhin einige Nicht-ASCII Zeichen, siehe die Zeichensatzspezifikation für Details. Das gezeigte Unicode Beispiel verdeutlicht die Verwendung von Nicht-ASCII Zeichen und wie die Wandlung von Unicode in den LCD Zeichensatz möglich ist.
TBrickletLCD20x4.
ClearDisplay
¶Löscht alle Zeichen auf dem Display.
TBrickletLCD20x4.
BacklightOn
¶Aktiviert die Hintergrundbeleuchtung.
TBrickletLCD20x4.
BacklightOff
¶Deaktiviert die Hintergrundbeleuchtung.
TBrickletLCD20x4.
IsBacklightOn
: boolean¶Rückgabe: |
|
---|
Gibt true zurück wenn die Hintergrundbeleuchtung aktiv ist, sonst false.
TBrickletLCD20x4.
SetConfig
(const cursor: boolean; const blinking: boolean)¶Parameter: |
|
---|
Konfiguriert ob der Cursor (angezeigt als "_") sichtbar ist und ob er
blinkt (angezeigt als blinkender Block). Die Cursor Position ist ein
Zeichen hinter dem zuletzt mit WriteLine
geschriebenen Text.
TBrickletLCD20x4.
GetConfig
(out cursor: boolean; out blinking: boolean)¶Ausgabeparameter: |
|
---|
Gibt die Konfiguration zurück, wie von SetConfig
gesetzt.
TBrickletLCD20x4.
IsButtonPressed
(const button: byte): boolean¶Parameter: |
|
---|---|
Rückgabe: |
|
Gibt true zurück wenn die Taste (0 bis 2 oder 0 bis 3 seit Hardware Version 1.2) gedrückt ist.
Wenn auf Tastendrücken und -loslassen reagiert werden soll, wird empfohlen die
OnButtonPressed
und OnButtonReleased
Callbacks zu nutzen.
TBrickletLCD20x4.
SetCustomCharacter
(const index: byte; const character: array [0..7] of byte)¶Parameter: |
|
---|
Das LCD 20x4 Bricklet kann bis zu 8 benutzerdefinierte Buchstaben speichern. Die Buchstaben bestehen aus 5x8 Pixel und sie können über den Index 0-7 adressiert werden. Um die Pixel zu beschreiben, werden die ersten 5 Bit von 8 Bytes verwenden. Zum Beispiel, um den Buchstaben "H" zu erzeugen, sollte das folgende Array gesendet werden:
character[0] = 0b00010001
(Dezimalwert 17)character[1] = 0b00010001
(Dezimalwert 17)character[2] = 0b00010001
(Dezimalwert 17)character[3] = 0b00011111
(Dezimalwert 31)character[4] = 0b00010001
(Dezimalwert 17)character[5] = 0b00010001
(Dezimalwert 17)character[6] = 0b00010001
(Dezimalwert 17)character[7] = 0b00000000
(Dezimalwert 0)Die Buchstaben können später mit WriteLine
mit den chars mit
den Byterepräsentationen 8 ("\x08" oder "\u0008") bis 15 ("\x0F" oder
"\u000F") geschrieben werden.
Es ist möglich die benutzerdefinierten Buchstaben im Brick Viewer ab Version 2.0.1 einzustellen.
Benutzerdefinierte Buchstaben werden vom LCD im RAM gespeichert, daher müssen sie nach jedem Start des LCD 20x4 Bricklets gesetzt werden.
Neu in Version 2.0.1 (Plugin).
TBrickletLCD20x4.
GetCustomCharacter
(const index: byte): array [0..7] of byte¶Parameter: |
|
---|---|
Rückgabe: |
|
Gibt den benutzerdefinierten Buchstaben für den gegebenen
Index zurück, wie von SetCustomCharacter
gesetzt.
Neu in Version 2.0.1 (Plugin).
TBrickletLCD20x4.
SetDefaultText
(const line: byte; const text: string)¶Parameter: |
|
---|
Setzt den Standard-Text für die Zeilen 0-3. Die maximale Anzahl an Buchstaben pro Zeile ist 20.
Der Standard-Text wird auf dem LCD angezeigt, wenn der Standard-Text-Zähler
ausläuft, siehe SetDefaultTextCounter
.
Neu in Version 2.0.2 (Plugin).
TBrickletLCD20x4.
GetDefaultText
(const line: byte): string¶Parameter: |
|
---|---|
Rückgabe: |
|
Gibt den Standard-Text für die Zeilen 0-3 zurück, wie von
SetDefaultText
gesetzt.
Neu in Version 2.0.2 (Plugin).
TBrickletLCD20x4.
SetDefaultTextCounter
(const counter: longint)¶Parameter: |
|
---|
Setzt den Standard-Text-Zähler. Der Zähler wird von der LCD
Firmware einmal pro ms dekrementiert. Wenn der Zähler 0 erreicht
wird der Standard-Text auf dem LCD angezeigt (siehe SetDefaultText
).
Diese Funktionalität kann genutzt werden um auf dem LCD einen Text anzuzeigen falls das kontrollierende Programm abstürzt oder die Verbindung unterbrochen wird.
Ein möglicher Ansatz dafür ist SetDefaultTextCounter
einmal
pro Minute mit dem Parameter 1000*60*2 (zwei Minuten) aufzurufen.
In diesem Fall wird dann der Standard-Text nach spätestens zwei Minuten
angezeigt wenn das kontrollierende Programm abstürzt.
Ein negativer Zählerwert stellt die Standard-Text Funktionalität aus.
Neu in Version 2.0.2 (Plugin).
TBrickletLCD20x4.
GetDefaultTextCounter
: longint¶Rückgabe: |
|
---|
Gibt den aktuellen Wert des Standard-Text-Zählers zurück.
Neu in Version 2.0.2 (Plugin).
TBrickletLCD20x4.
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)¶Ausgabeparameter: |
|
---|
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.
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: TBrickletLCD20x4; const value: longint); begin WriteLn(Format('Value: %d', [value])); end; lcd20x4.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.
TBrickletLCD20x4.
OnButtonPressed
¶procedure(sender: TBrickletLCD20x4; const button: byte) of object;
Callback-Parameter: |
|
---|
Dieser Callback wird ausgelöst, wenn eine Taste gedrückt wird. Der Parameter ist die Nummer der Taste (0 bis 2 oder 0 bis 3 seit Hardware Version 1.2).
TBrickletLCD20x4.
OnButtonReleased
¶procedure(sender: TBrickletLCD20x4; const button: byte) of object;
Callback-Parameter: |
|
---|
Dieser Callback wird ausgelöst, wenn eine Taste losgelassen wird. Der Parameter ist die Nummer der Taste (0 bis 2 oder 0 bis 3 seit Hardware Version 1.2).
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.
TBrickletLCD20x4.
GetAPIVersion
: array [0..2] of byte¶Ausgabeparameter: |
|
---|
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.
TBrickletLCD20x4.
GetResponseExpected
(const functionId: byte): boolean¶Parameter: |
|
---|---|
Rückgabe: |
|
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:
TBrickletLCD20x4.
SetResponseExpected
(const functionId: byte; const responseExpected: boolean)¶Parameter: |
|
---|
Ä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:
TBrickletLCD20x4.
SetResponseExpectedAll
(const responseExpected: boolean)¶Parameter: |
|
---|
Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.
BRICKLET_LCD_20X4_DEVICE_IDENTIFIER
¶Diese Konstante wird verwendet um ein LCD 20x4 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.
BRICKLET_LCD_20X4_DEVICE_DISPLAY_NAME
¶Diese Konstante stellt den Anzeigenamen eines LCD 20x4 Bricklet dar.