Delphi/Lazarus - LCD 16x2 Bricklet¶

Hello World¶

Download (ExampleHelloWorld.pas)

 1program ExampleHelloWorld;
 2
 3{$ifdef MSWINDOWS}{$apptype CONSOLE}{$endif}
 4{$ifdef FPC}{$mode OBJFPC}{$H+}{$endif}
 5
 6uses
 7  SysUtils, IPConnection, BrickletLCD16x2;
 8
 9type
10  TExample = class
11  private
12    ipcon: TIPConnection;
13    lcd: TBrickletLCD16x2;
14  public
15    procedure Execute;
16  end;
17
18const
19  HOST = 'localhost';
20  PORT = 4223;
21  UID = 'XYZ'; { Change XYZ to the UID of your LCD 16x2 Bricklet }
22
23var
24  e: TExample;
25
26procedure TExample.Execute;
27begin
28  { Create IP connection }
29  ipcon := TIPConnection.Create;
30
31  { Create device object }
32  lcd := TBrickletLCD16x2.Create(UID, ipcon);
33
34  { Connect to brickd }
35  ipcon.Connect(HOST, PORT);
36  { Don't use device before ipcon is connected }
37
38  { Turn backlight on }
39  lcd.BacklightOn;
40
41  { Write "Hello World" }
42  lcd.WriteLine(0, 0, 'Hello World');
43
44  WriteLn('Press key to exit');
45  ReadLn;
46  ipcon.Destroy; { Calls ipcon.Disconnect internally }
47end;
48
49begin
50  e := TExample.Create;
51  e.Execute;
52  e.Destroy;
53end.

Button Callback¶

Download (ExampleButtonCallback.pas)

 1program ExampleButtonCallback;
 2
 3{$ifdef MSWINDOWS}{$apptype CONSOLE}{$endif}
 4{$ifdef FPC}{$mode OBJFPC}{$H+}{$endif}
 5
 6uses
 7  SysUtils, IPConnection, BrickletLCD16x2;
 8
 9type
10  TExample = class
11  private
12    ipcon: TIPConnection;
13    lcd: TBrickletLCD16x2;
14  public
15    procedure ButtonPressedCB(sender: TBrickletLCD16x2; const button: byte);
16    procedure ButtonReleasedCB(sender: TBrickletLCD16x2; const button: byte);
17    procedure Execute;
18  end;
19
20const
21  HOST = 'localhost';
22  PORT = 4223;
23  UID = 'XYZ'; { Change XYZ to the UID of your LCD 16x2 Bricklet }
24
25var
26  e: TExample;
27
28{ Callback procedure for button pressed callback }
29procedure TExample.ButtonPressedCB(sender: TBrickletLCD16x2; const button: byte);
30begin
31  WriteLn(Format('Button Pressed: %d', [button]));
32end;
33
34{ Callback procedure for button released callback }
35procedure TExample.ButtonReleasedCB(sender: TBrickletLCD16x2; const button: byte);
36begin
37  WriteLn(Format('Button Released: %d', [button]));
38end;
39
40procedure TExample.Execute;
41begin
42  { Create IP connection }
43  ipcon := TIPConnection.Create;
44
45  { Create device object }
46  lcd := TBrickletLCD16x2.Create(UID, ipcon);
47
48  { Connect to brickd }
49  ipcon.Connect(HOST, PORT);
50  { Don't use device before ipcon is connected }
51
52  { Register button pressed callback to procedure ButtonPressedCB }
53  lcd.OnButtonPressed := {$ifdef FPC}@{$endif}ButtonPressedCB;
54
55  { Register button released callback to procedure ButtonReleasedCB }
56  lcd.OnButtonReleased := {$ifdef FPC}@{$endif}ButtonReleasedCB;
57
58  WriteLn('Press key to exit');
59  ReadLn;
60  ipcon.Destroy; { Calls ipcon.Disconnect internally }
61end;
62
63begin
64  e := TExample.Create;
65  e.Execute;
66  e.Destroy;
67end.

Unicode¶

Download (ExampleUnicode.pas)

  1program ExampleUnicode;
  2
  3{$ifdef MSWINDOWS}{$apptype CONSOLE}{$endif}
  4{$ifdef FPC}{$mode OBJFPC}{$H+}{$endif}
  5
  6uses
  7  SysUtils, IPConnection, BrickletLCD16x2;
  8
  9type
 10  TExample = class
 11  private
 12    ipcon: TIPConnection;
 13    lcd: TBrickletLCD16x2;
 14  public
 15    function WideStringToKS0066U(const text: WideString): string;
 16    procedure Execute;
 17  end;
 18
 19const
 20  HOST = 'localhost';
 21  PORT = 4223;
 22  UID = 'XYZ'; { Change XYZ to the UID of your LCD 16x2 Bricklet }
 23
 24var
 25  e: TExample;
 26
 27function TExample.WideStringToKS0066U(const text: WideString): string;
 28var i, codePoint: longint; w: word; c: char; ks0066u: string;
 29begin
 30  i := 1;
 31  SetLength(ks0066u, 0);
 32  while (i <= Length(text)) do begin
 33    { WideString is UTF-16, handle surrogates }
 34    w := word(text[i]);
 35    if ((w >= $D800) and (w <= $DBFF)) then begin
 36      codePoint := $10000 + (w - $D800) * $400 + (w - $DC00);
 37      i := i + 2;
 38    end
 39    else begin
 40      codePoint := w;
 41      i := i + 1;
 42    end;
 43    { ASCII subset from JIS X 0201 }
 44    if ((codePoint >= $0020) and (codePoint <= $007E)) then begin
 45      { The LCD charset doesn't include '\' and '~', use similar characters instead }
 46      case codePoint of
 47        $005C: c := char($A4); { REVERSE SOLIDUS maps to IDEOGRAPHIC COMMA }
 48        $007E: c := char($2D); { TILDE maps to HYPHEN-MINUS }
 49        else   c := char(codePoint);
 50      end;
 51    end
 52    { Katakana subset from JIS X 0201 }
 53    else if ((codePoint >= $FF61) and (codePoint <= $FF9F)) then begin
 54      c := char(codePoint - $FEC0);
 55    end
 56    { Special characters }
 57    else begin
 58      case codePoint of
 59        $00A5: c := char($5C); { YEN SIGN }
 60        $2192: c := char($7E); { RIGHTWARDS ARROW }
 61        $2190: c := char($7F); { LEFTWARDS ARROW }
 62        $00B0: c := char($DF); { DEGREE SIGN maps to KATAKANA SEMI-VOICED SOUND MARK }
 63        $03B1: c := char($E0); { GREEK SMALL LETTER ALPHA }
 64        $00C4: c := char($E1); { LATIN CAPITAL LETTER A WITH DIAERESIS }
 65        $00E4: c := char($E1); { LATIN SMALL LETTER A WITH DIAERESIS }
 66        $00DF: c := char($E2); { LATIN SMALL LETTER SHARP S }
 67        $03B5: c := char($E3); { GREEK SMALL LETTER EPSILON }
 68        $00B5: c := char($E4); { MICRO SIGN }
 69        $03BC: c := char($E4); { GREEK SMALL LETTER MU }
 70        $03C2: c := char($E5); { GREEK SMALL LETTER FINAL SIGMA }
 71        $03C1: c := char($E6); { GREEK SMALL LETTER RHO }
 72        $221A: c := char($E8); { SQUARE ROOT }
 73        $00B9: c := char($E9); { SUPERSCRIPT ONE maps to SUPERSCRIPT (minus) ONE }
 74        $00A4: c := char($EB); { CURRENCY SIGN }
 75        $00A2: c := char($EC); { CENT SIGN }
 76        $2C60: c := char($ED); { LATIN CAPITAL LETTER L WITH DOUBLE BAR }
 77        $00F1: c := char($EE); { LATIN SMALL LETTER N WITH TILDE }
 78        $00D6: c := char($EF); { LATIN CAPITAL LETTER O WITH DIAERESIS }
 79        $00F6: c := char($EF); { LATIN SMALL LETTER O WITH DIAERESIS }
 80        $03F4: c := char($F2); { GREEK CAPITAL THETA SYMBOL }
 81        $221E: c := char($F3); { INFINITY }
 82        $03A9: c := char($F4); { GREEK CAPITAL LETTER OMEGA }
 83        $00DC: c := char($F5); { LATIN CAPITAL LETTER U WITH DIAERESIS }
 84        $00FC: c := char($F5); { LATIN SMALL LETTER U WITH DIAERESIS }
 85        $03A3: c := char($F6); { GREEK CAPITAL LETTER SIGMA }
 86        $03C0: c := char($F7); { GREEK SMALL LETTER PI }
 87        $0304: c := char($F8); { COMBINING MACRON }
 88        $00F7: c := char($FD); { DIVISION SIGN }
 89        $25A0: c := char($FF); { BLACK SQUARE }
 90        else   c := char($FF); { BLACK SQUARE }
 91      end
 92    end;
 93    { Special handling for 'x' followed by COMBINING MACRON }
 94    if (c = char($F8)) then begin
 95      if (ks0066u[Length(ks0066u) - 1] <> 'x') then begin
 96        c := char($FF); { BLACK SQUARE }
 97      end;
 98      if (Length(ks0066u) > 0) then begin
 99        SetLength(ks0066u, Length(ks0066u) - 1);
100      end;
101    end;
102    ks0066u := ks0066u + c;
103  end;
104  result := ks0066u;
105end;
106
107procedure TExample.Execute;
108begin
109  { Create IP connection }
110  ipcon := TIPConnection.Create;
111
112  { Create device object }
113  lcd := TBrickletLCD16x2.Create(UID, ipcon);
114
115  { Connect to brickd }
116  ipcon.Connect(HOST, PORT);
117  { Don't use device before ipcon is connected }
118
119  { Turn backlight on }
120  lcd.BacklightOn;
121
122  { Write a string using the WideStringToKS0066U function to map to the LCD charset }
123  { Note: For the Free Pascal Compiler (and Lazarus) UTF8Decode is used to create a
124          WideString. It assumes that your source file is UTF-8 encoded }
125  lcd.WriteLine(0, 0, WideStringToKS0066U({$ifdef FPC}UTF8Decode{$endif}('Stromstärke: 5µA')));
126
127  { Write a string directly including characters from the LCD charset }
128  lcd.WriteLine(1, 0, 'Drehzahl: 1000s' + char($E9));
129
130  WriteLn('Press key to exit');
131  ReadLn;
132  ipcon.Destroy; { Calls ipcon.Disconnect internally }
133end;
134
135begin
136  e := TExample.Create;
137  e.Execute;
138  e.Destroy;
139end.

Grundfunktionen¶

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

Parameter:	uid – Typ: string ipcon – Typ: TIPConnection
Rückgabe:	lcd16x2 – Typ: TBrickletLCD16x2

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

lcd16x2 := TBrickletLCD16x2.Create('YOUR_DEVICE_UID', ipcon);

Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.

procedure TBrickletLCD16x2.WriteLine(const line: byte; const position: byte; const text: string)¶

Parameter:	line – Typ: byte, Wertebereich: [0 bis 1] position – Typ: byte, Wertebereich: [0 bis 15] text – Typ: string, Länge: bis zu 16

Schreibt einen Text in die angegebene Zeile mit einer vorgegebenen Position. Der Text kann maximal 16 Zeichen lang sein.

Beispiel: (0, 5, "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.

procedure TBrickletLCD16x2.ClearDisplay¶

Löscht alle Zeichen auf dem Display.

procedure TBrickletLCD16x2.BacklightOn¶

Aktiviert die Hintergrundbeleuchtung.

procedure TBrickletLCD16x2.BacklightOff¶

Deaktiviert die Hintergrundbeleuchtung.

function TBrickletLCD16x2.IsBacklightOn: boolean¶

Rückgabe:	backlight – Typ: boolean

Gibt true zurück wenn die Hintergrundbeleuchtung aktiv ist, sonst false.

Fortgeschrittene Funktionen¶

procedure TBrickletLCD16x2.SetConfig(const cursor: boolean; const blinking: boolean)¶

Parameter:	cursor – Typ: boolean, Standardwert: false blinking – Typ: boolean, Standardwert: false

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.

procedure TBrickletLCD16x2.GetConfig(out cursor: boolean; out blinking: boolean)¶

Ausgabeparameter:	cursor – Typ: boolean, Standardwert: false blinking – Typ: boolean, Standardwert: false

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

function TBrickletLCD16x2.IsButtonPressed(const button: byte): boolean¶

Parameter:	button – Typ: byte, Wertebereich: [0 bis 2]
Rückgabe:	pressed – Typ: boolean

Gibt true zurück wenn die Taste gedrückt ist.

Wenn auf Tastendrücken und -loslassen reagiert werden soll, wird empfohlen die OnButtonPressed und OnButtonReleased Callbacks zu nutzen.

procedure TBrickletLCD16x2.SetCustomCharacter(const index: byte; const character: array [0..7] of byte)¶

Parameter:	index – Typ: byte, Wertebereich: [0 bis 7] character – Typ: array [0..7] of byte, Wertebereich: [0 bis 31]

Das LCD 16x2 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 16x2 Bricklets gesetzt werden.

Added in version 2.0.1$nbsp;(Plugin).

function TBrickletLCD16x2.GetCustomCharacter(const index: byte): array [0..7] of byte¶

Parameter:	index – Typ: byte, Wertebereich: [0 bis 7]
Rückgabe:	character – Typ: array [0..7] of byte, Wertebereich: [0 bis 31]

Gibt den benutzerdefinierten Buchstaben für den gegebenen Index zurück, wie von GetCustomCharacter gesetzt.

Added in version 2.0.1$nbsp;(Plugin).

procedure TBrickletLCD16x2.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:

uid – Typ: string, Länge: bis zu 8 connectedUid – Typ: string, Länge: bis zu 8 position – Typ: char, Wertebereich: ['a' bis 'h', 'z'] hardwareVersion – Typ: array [0..2] of byte 0: major – Typ: byte, Wertebereich: [0 bis 255] 1: minor – Typ: byte, Wertebereich: [0 bis 255] 2: revision – Typ: byte, Wertebereich: [0 bis 255] firmwareVersion – Typ: array [0..2] of byte 0: major – Typ: byte, Wertebereich: [0 bis 255] 1: minor – Typ: byte, Wertebereich: [0 bis 255] 2: revision – Typ: byte, Wertebereich: [0 bis 255] deviceIdentifier – Typ: word, Wertebereich: [0 bis 216 - 1]

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¶

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: TBrickletLCD16x2; const value: longint);
begin
  WriteLn(Format('Value: %d', [value]));
end;

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

Die verfügbaren Callback Properties und ihre Parametertypen werden weiter unten beschrieben.

property TBrickletLCD16x2.OnButtonPressed¶

procedure(sender: TBrickletLCD16x2; const button: byte) of object;

Callback-Parameter:	sender – Typ: TBrickletLCD16x2 button – Typ: byte, Wertebereich: [0 bis 2]

Dieser Callback wird ausgelöst, wenn eine Taste gedrückt wird. Der Parameter ist die Nummer der Taste.

property TBrickletLCD16x2.OnButtonReleased¶

procedure(sender: TBrickletLCD16x2; const button: byte) of object;

Callback-Parameter:	sender – Typ: TBrickletLCD16x2 button – Typ: byte, Wertebereich: [0 bis 2]

Dieser Callback wird ausgelöst, wenn eine Taste losgelassen wird. Der Parameter ist die Nummer der Taste.

Virtuelle Funktionen¶

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.

function TBrickletLCD16x2.GetAPIVersion: array [0..2] of byte¶

Ausgabeparameter:	apiVersion – Typ: array [0..2] of byte 0: major – Typ: byte, Wertebereich: [0 bis 255] 1: minor – Typ: byte, Wertebereich: [0 bis 255] 2: revision – Typ: byte, Wertebereich: [0 bis 255]

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.

function TBrickletLCD16x2.GetResponseExpected(const functionId: byte): boolean¶

Parameter:	functionId – Typ: byte, Wertebereich: Siehe Konstanten
Rückgabe:	responseExpected – Typ: 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:

Für functionId:

• BRICKLET_LCD_16X2_FUNCTION_WRITE_LINE = 1

• BRICKLET_LCD_16X2_FUNCTION_CLEAR_DISPLAY = 2

• BRICKLET_LCD_16X2_FUNCTION_BACKLIGHT_ON = 3

• BRICKLET_LCD_16X2_FUNCTION_BACKLIGHT_OFF = 4

• BRICKLET_LCD_16X2_FUNCTION_SET_CONFIG = 6

• BRICKLET_LCD_16X2_FUNCTION_SET_CUSTOM_CHARACTER = 11

procedure TBrickletLCD16x2.SetResponseExpected(const functionId: byte; const responseExpected: boolean)¶

Parameter:	functionId – Typ: byte, Wertebereich: Siehe Konstanten responseExpected – Typ: 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:

Für functionId:

• BRICKLET_LCD_16X2_FUNCTION_WRITE_LINE = 1

• BRICKLET_LCD_16X2_FUNCTION_CLEAR_DISPLAY = 2

• BRICKLET_LCD_16X2_FUNCTION_BACKLIGHT_ON = 3

• BRICKLET_LCD_16X2_FUNCTION_BACKLIGHT_OFF = 4

• BRICKLET_LCD_16X2_FUNCTION_SET_CONFIG = 6

• BRICKLET_LCD_16X2_FUNCTION_SET_CUSTOM_CHARACTER = 11

procedure TBrickletLCD16x2.SetResponseExpectedAll(const responseExpected: boolean)¶

Parameter:	responseExpected – Typ: boolean

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

Konstanten¶

const BRICKLET_LCD_16X2_DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein LCD 16x2 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_LCD_16X2_DEVICE_DISPLAY_NAME¶

Diese Konstante stellt den Anzeigenamen eines LCD 16x2 Bricklet dar.