Deutsch
English
Menu
Software / API Bindings / Delphi/Lazarus / API Reference and Examples / Bricklets / LCD 128x64 Bricklet

Delphi/Lazarus - LCD 128x64 Bricklet

This is the description of the Delphi/Lazarus API bindings for the LCD 128x64 Bricklet. General information and technical specifications for the LCD 128x64 Bricklet 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).

Hello World

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, BrickletLCD128x64;

type
  TExample = class
  private
    ipcon: TIPConnection;
    lcd: TBrickletLCD128x64;
  public
    procedure Execute;
  end;

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

var
  e: TExample;

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

  { Create device object }
  lcd := TBrickletLCD128x64.Create(UID, ipcon);

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

  { Clear display }
  lcd.ClearDisplay;

  { Write "Hello World" starting from upper left corner of the screen }
  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.

Big Font

Download (ExampleBigFont.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
program ExampleBigFont;

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

uses
  SysUtils, IPConnection, BrickletLCD128x64;

type
  TExample = class
  private
    ipcon: TIPConnection;
    lcd: TBrickletLCD128x64;
  public
    procedure Execute;
  end;

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

var
  e: TExample;

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

  { Create device object }
  lcd := TBrickletLCD128x64.Create(UID, ipcon);

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

  { Clear display }
  lcd.ClearDisplay;

  { Write "Hello World" with big 24x32 font }
  lcd.DrawText(0, 0, BRICKLET_LCD_128X64_FONT_24X32, BRICKLET_LCD_128X64_COLOR_BLACK,
               '24x32');

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

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

Pixel Matrix

Download (ExamplePixelMatrix.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
program ExamplePixelMatrix;

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

uses
  Math, SysUtils, IPConnection, BrickletLCD128x64;

const
  WIDTH = 128;
  HEIGHT = 64;

type
  TPixels = array [0..(HEIGHT*WIDTH - 1)] of boolean;
  TExample = class
  private
    ipcon: TIPConnection;
    lcd: TBrickletLCD128x64;
  public
    procedure Execute;
  end;

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

var
  e: TExample;

procedure TExample.Execute;
var row, column: integer; pixels: TPixels;
begin
  { Create IP connection }
  ipcon := TIPConnection.Create;

  { Create device object }
  lcd := TBrickletLCD128x64.Create(UID, ipcon);

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

  { Clear display }
  lcd.ClearDisplay;

  { Draw checkerboard pattern }
  for row := 0 to HEIGHT - 1 do begin
    for column := 0 to WIDTH - 1 do begin
      pixels[row * WIDTH + column] := (row div 8) mod 2 = (column div 8) mod 2;
    end;
  end;

  lcd.WritePixels(0, 0, WIDTH-1, HEIGHT-1, pixels);

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

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

Touch

Download (ExampleTouch.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
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
program ExampleTouch;

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

uses
  SysUtils, IPConnection, BrickletLCD128x64;

type
  TExample = class
  private
    ipcon: TIPConnection;
    lcd: TBrickletLCD128x64;
  public
    procedure TouchPositionCB(sender: TBrickletLCD128x64; const pressure: word;
                              const x: word; const y: word; const age: longword);
    procedure TouchGestureCB(sender: TBrickletLCD128x64; const gesture: byte;
                             const duration: longword; const pressureMax: word;
                             const xStart: word; const xEnd: word; const yStart: word;
                             const yEnd: word; const age: longword);
    procedure Execute;
  end;

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

var
  e: TExample;

{ Callback procedure for touch position callback }
procedure TExample.TouchPositionCB(sender: TBrickletLCD128x64; const pressure: word;
                                   const x: word; const y: word; const age: longword);
begin
  WriteLn(Format('Pressure: %d', [pressure]));
  WriteLn(Format('X: %d', [x]));
  WriteLn(Format('Y: %d', [y]));
  WriteLn(Format('Age: %d', [age]));
  WriteLn('');
end;

{ Callback procedure for touch gesture callback }
procedure TExample.TouchGestureCB(sender: TBrickletLCD128x64; const gesture: byte;
                                  const duration: longword; const pressureMax: word;
                                  const xStart: word; const xEnd: word;
                                  const yStart: word; const yEnd: word;
                                  const age: longword);
begin
  if (gesture = BRICKLET_LCD_128X64_GESTURE_LEFT_TO_RIGHT) then begin
    WriteLn('Gesture: Left To Right');
  end
  else if (gesture = BRICKLET_LCD_128X64_GESTURE_RIGHT_TO_LEFT) then begin
    WriteLn('Gesture: Right To Left');
  end
  else if (gesture = BRICKLET_LCD_128X64_GESTURE_TOP_TO_BOTTOM) then begin
    WriteLn('Gesture: Top To Bottom');
  end
  else if (gesture = BRICKLET_LCD_128X64_GESTURE_BOTTOM_TO_TOP) then begin
    WriteLn('Gesture: Bottom To Top');
  end;

  WriteLn(Format('Duration: %d', [duration]));
  WriteLn(Format('Pressure Max: %d', [pressureMax]));
  WriteLn(Format('X Start: %d', [xStart]));
  WriteLn(Format('X End: %d', [xEnd]));
  WriteLn(Format('Y Start: %d', [yStart]));
  WriteLn(Format('Y End: %d', [yEnd]));
  WriteLn(Format('Age: %d', [age]));
  WriteLn('');
end;

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

  { Create device object }
  lcd := TBrickletLCD128x64.Create(UID, ipcon);

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

  { Register touch position callback to procedure TouchPositionCB }
  lcd.OnTouchPosition := {$ifdef FPC}@{$endif}TouchPositionCB;

  { Register touch gesture callback to procedure TouchGestureCB }
  lcd.OnTouchGesture := {$ifdef FPC}@{$endif}TouchGestureCB;

  { Set period for touch position callback to 0.1s (100ms) }
  lcd.SetTouchPositionCallbackConfiguration(100, true);

  { Set period for touch gesture callback to 0.1s (100ms) }
  lcd.SetTouchGestureCallbackConfiguration(100, true);

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

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

GUI

Download (ExampleGUI.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
 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
program ExampleGUI;

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

uses
  SysUtils, IPConnection, BrickletLCD128x64;

type
  TExample = class
  private
    ipcon: TIPConnection;
    lcd: TBrickletLCD128x64;
  public
    procedure GUIButtonPressedCB(sender: TBrickletLCD128x64; const index: byte;
                                 const pressed: boolean);
    procedure GUISliderValueCB(sender: TBrickletLCD128x64; const index: byte;
                               const value: byte);
    procedure GUITabSelectedCB(sender: TBrickletLCD128x64; const index: shortint);
    procedure Execute;
  end;

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

var
  e: TExample;

{ Callback procedure for GUI button pressed callback }
procedure TExample.GUIButtonPressedCB(sender: TBrickletLCD128x64; const index: byte;
                                      const pressed: boolean);
begin
  WriteLn(Format('Index: %d', [index]));
  WriteLn(Format('Pressed: %d', [pressed]));
  WriteLn('');
end;

{ Callback procedure for GUI slider value callback }
procedure TExample.GUISliderValueCB(sender: TBrickletLCD128x64; const index: byte;
                                    const value: byte);
begin
  WriteLn(Format('Index: %d', [index]));
  WriteLn(Format('Value: %d', [value]));
  WriteLn('');
end;

{ Callback procedure for GUI tab selected callback }
procedure TExample.GUITabSelectedCB(sender: TBrickletLCD128x64; const index: shortint);
begin
  WriteLn(Format('Index: %d', [index]));
end;

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

  { Create device object }
  lcd := TBrickletLCD128x64.Create(UID, ipcon);

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

  { Register GUI button pressed callback to procedure GUIButtonPressedCB }
  lcd.OnGUIButtonPressed := {$ifdef FPC}@{$endif}GUIButtonPressedCB;

  { Register GUI slider value callback to procedure GUISliderValueCB }
  lcd.OnGUISliderValue := {$ifdef FPC}@{$endif}GUISliderValueCB;

  { Register GUI tab selected callback to procedure GUITabSelectedCB }
  lcd.OnGUITabSelected := {$ifdef FPC}@{$endif}GUITabSelectedCB;

  { Clear display }
  lcd.ClearDisplay;
  lcd.RemoveAllGUI;

  { Add GUI elements: Button, Slider and Graph with 60 data points }
  lcd.SetGUIButton(0, 0, 0, 60, 20, 'button');
  lcd.SetGUISlider(0, 0, 30, 60, BRICKLET_LCD_128X64_DIRECTION_HORIZONTAL, 50);
  lcd.SetGUIGraphConfiguration(0, BRICKLET_LCD_128X64_GRAPH_TYPE_LINE, 62, 0, 60, 52,
                               'X', 'Y');

  { Add a few data points (the remaining points will be 0) }
  lcd.SetGUIGraphData(0, [20, 40, 60, 80, 100, 120, 140, 160, 180, 200, 220, 240]);

  { Add 5 text tabs without and configure it for click and swipe without auto-redraw }
  lcd.SetGUITabConfiguration(BRICKLET_LCD_128X64_CHANGE_TAB_ON_CLICK_AND_SWIPE, false);
  lcd.SetGUITabText(0, 'Tab A');
  lcd.SetGUITabText(1, 'Tab B');
  lcd.SetGUITabText(2, 'Tab C');
  lcd.SetGUITabText(3, 'Tab D');
  lcd.SetGUITabText(4, 'Tab E');

  { Set period for GUI button pressed callback to 0.1s (100ms) }
  lcd.SetGUIButtonPressedCallbackConfiguration(100, true);

  { Set period for GUI slider value callback to 0.1s (100ms) }
  lcd.SetGUISliderValueCallbackConfiguration(100, true);

  { Set period for GUI tab selected callback to 0.1s (100ms) }
  lcd.SetGUITabSelectedCallbackConfiguration(100, true);

  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 TBrickletLCD128x64.Create(const uid: string; ipcon: TIPConnection)
Parameters:
  • uid – Type: string
  • ipcon – Type: TIPConnection
Returns:
  • lcd128x64 – Type: TBrickletLCD128x64

Creates an object with the unique device ID uid:

lcd128x64 := TBrickletLCD128x64.Create('YOUR_DEVICE_UID', ipcon);

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

procedure TBrickletLCD128x64.WritePixels(const xStart: byte; const yStart: byte; const xEnd: byte; const yEnd: byte; const pixels: array of boolean)
Parameters:
  • xStart – Type: byte, Range: [0 to 127]
  • yStart – Type: byte, Range: [0 to 63]
  • xEnd – Type: byte, Range: [0 to 127]
  • yEnd – Type: byte, Range: [0 to 63]
  • pixels – Type: array of boolean

Writes pixels to the specified window.

The pixels are written into the window line by line top to bottom and each line is written from left to right.

If automatic draw is enabled (default) the pixels are directly written to the screen. Only pixels that have actually changed are updated on the screen, the rest stays the same.

If automatic draw is disabled the pixels are written to an internal buffer and the buffer is transferred to the display only after DrawBufferedFrame is called. This can be used to avoid flicker when drawing a complex frame in multiple steps.

Automatic draw can be configured with the SetDisplayConfiguration function.

function TBrickletLCD128x64.ReadPixels(const xStart: byte; const yStart: byte; const xEnd: byte; const yEnd: byte): array of boolean
Parameters:
  • xStart – Type: byte, Range: [0 to 127]
  • yStart – Type: byte, Range: [0 to 63]
  • xEnd – Type: byte, Range: [0 to 127]
  • yEnd – Type: byte, Range: [0 to 63]
Returns:
  • pixels – Type: array of boolean

Reads pixels from the specified window.

The pixels are read from the window line by line top to bottom and each line is read from left to right.

If automatic draw is enabled (default) the pixels that are read are always the same that are shown on the display.

If automatic draw is disabled the pixels are read from the internal buffer (see DrawBufferedFrame).

Automatic draw can be configured with the SetDisplayConfiguration function.

procedure TBrickletLCD128x64.ClearDisplay

Clears the complete content of the display.

If automatic draw is enabled (default) the pixels are directly cleared.

If automatic draw is disabled the the internal buffer is cleared and the buffer is transferred to the display only after DrawBufferedFrame is called. This can be used to avoid flicker when drawing a complex frame in multiple steps.

Automatic draw can be configured with the SetDisplayConfiguration function.

procedure TBrickletLCD128x64.WriteLine(const line: byte; const position: byte; const text: string)
Parameters:
  • line – Type: byte, Range: [0 to 7]
  • position – Type: byte, Range: [0 to 21]
  • text – Type: string, Length: up to 22

Writes text to a specific line with a specific position.

For example: (1, 10, "Hello") will write Hello in the middle of the second line of the display.

The display uses a special 5x7 pixel charset. You can view the characters of the charset in Brick Viewer.

If automatic draw is enabled (default) the text is directly written to the screen. Only pixels that have actually changed are updated on the screen, the rest stays the same.

If automatic draw is disabled the text is written to an internal buffer and the buffer is transferred to the display only after DrawBufferedFrame is called. This can be used to avoid flicker when drawing a complex frame in multiple steps.

Automatic draw can be configured with the SetDisplayConfiguration function.

This function is a 1:1 replacement for the function with the same name in the LCD 20x4 Bricklet. You can draw text at a specific pixel position and with different font sizes with the DrawText function.

procedure TBrickletLCD128x64.DrawBufferedFrame(const forceCompleteRedraw: boolean)
Parameters:
  • forceCompleteRedraw – Type: boolean

Draws the currently buffered frame. Normally each call of WritePixels and WriteLine draws directly onto the display. If you turn automatic draw off (SetDisplayConfiguration), the data is written in an internal buffer and only transferred to the display by calling this function. This can be used to avoid flicker when drawing a complex frame in multiple steps.

Set the force complete redraw to true to redraw the whole display instead of only the changed parts. Normally it should not be necessary to set this to true. It may only become necessary in case of stuck pixels because of errors.

procedure TBrickletLCD128x64.GetTouchPosition(out pressure: word; out x: word; out y: word; out age: longword)
Output Parameters:
  • pressure – Type: word, Range: [0 to 300]
  • x – Type: word, Range: [0 to 127]
  • y – Type: word, Range: [0 to 63]
  • age – Type: longword, Unit: 1 ms, Range: [0 to 232 - 1]

Returns the last valid touch position:

  • Pressure: Amount of pressure applied by the user
  • X: Touch position on x-axis
  • Y: Touch position on y-axis
  • Age: Age of touch press (how long ago it was)
procedure TBrickletLCD128x64.GetTouchGesture(out gesture: byte; out duration: longword; out pressureMax: word; out xStart: word; out yStart: word; out xEnd: word; out yEnd: word; out age: longword)
Output Parameters:
  • gesture – Type: byte, Range: See constants
  • duration – Type: longword, Unit: 1 ms, Range: [0 to 232 - 1]
  • pressureMax – Type: word, Range: [0 to 300]
  • xStart – Type: word, Range: [0 to 127]
  • yStart – Type: word, Range: [0 to 63]
  • xEnd – Type: word, Range: [0 to 127]
  • yEnd – Type: word, Range: [0 to 63]
  • age – Type: longword, Unit: 1 ms, Range: [0 to 232 - 1]

Returns one of four touch gestures that can be automatically detected by the Bricklet.

The gestures are swipes from left to right, right to left, top to bottom and bottom to top.

Additionally to the gestures a vector with a start and end position of the gesture is provided. You can use this vector do determine a more exact location of the gesture (e.g. the swipe from top to bottom was on the left or right part of the screen).

The age parameter corresponds to the age of gesture (how long ago it was).

The following constants are available for this function:

For gesture:

  • BRICKLET_LCD_128X64_GESTURE_LEFT_TO_RIGHT = 0
  • BRICKLET_LCD_128X64_GESTURE_RIGHT_TO_LEFT = 1
  • BRICKLET_LCD_128X64_GESTURE_TOP_TO_BOTTOM = 2
  • BRICKLET_LCD_128X64_GESTURE_BOTTOM_TO_TOP = 3
procedure TBrickletLCD128x64.DrawLine(const positionXStart: byte; const positionYStart: byte; const positionXEnd: byte; const positionYEnd: byte; const color: boolean)
Parameters:
  • positionXStart – Type: byte, Range: [0 to 127]
  • positionYStart – Type: byte, Range: [0 to 63]
  • positionXEnd – Type: byte, Range: [0 to 127]
  • positionYEnd – Type: byte, Range: [0 to 63]
  • color – Type: boolean

Draws a white or black line from (x, y)-start to (x, y)-end.

The following constants are available for this function:

For color:

  • BRICKLET_LCD_128X64_COLOR_WHITE = false
  • BRICKLET_LCD_128X64_COLOR_BLACK = true

New in version 2.0.2 (Plugin).

procedure TBrickletLCD128x64.DrawBox(const positionXStart: byte; const positionYStart: byte; const positionXEnd: byte; const positionYEnd: byte; const fill: boolean; const color: boolean)
Parameters:
  • positionXStart – Type: byte, Range: [0 to 127]
  • positionYStart – Type: byte, Range: [0 to 63]
  • positionXEnd – Type: byte, Range: [0 to 127]
  • positionYEnd – Type: byte, Range: [0 to 63]
  • fill – Type: boolean
  • color – Type: boolean

Draws a white or black box from (x, y)-start to (x, y)-end.

If you set fill to true, the box will be filled with the color. Otherwise only the outline will be drawn.

The following constants are available for this function:

For color:

  • BRICKLET_LCD_128X64_COLOR_WHITE = false
  • BRICKLET_LCD_128X64_COLOR_BLACK = true

New in version 2.0.2 (Plugin).

procedure TBrickletLCD128x64.DrawText(const positionX: byte; const positionY: byte; const font: byte; const color: boolean; const text: string)
Parameters:
  • positionX – Type: byte, Range: [0 to 127]
  • positionY – Type: byte, Range: [0 to 63]
  • font – Type: byte, Range: See constants
  • color – Type: boolean
  • text – Type: string, Length: up to 22

Draws a text at the pixel position (x, y).

You can use one of 9 different font sizes and draw the text in white or black.

The font conforms to code page 437.

The following constants are available for this function:

For font:

  • BRICKLET_LCD_128X64_FONT_6X8 = 0
  • BRICKLET_LCD_128X64_FONT_6X16 = 1
  • BRICKLET_LCD_128X64_FONT_6X24 = 2
  • BRICKLET_LCD_128X64_FONT_6X32 = 3
  • BRICKLET_LCD_128X64_FONT_12X16 = 4
  • BRICKLET_LCD_128X64_FONT_12X24 = 5
  • BRICKLET_LCD_128X64_FONT_12X32 = 6
  • BRICKLET_LCD_128X64_FONT_18X24 = 7
  • BRICKLET_LCD_128X64_FONT_18X32 = 8
  • BRICKLET_LCD_128X64_FONT_24X32 = 9

For color:

  • BRICKLET_LCD_128X64_COLOR_WHITE = false
  • BRICKLET_LCD_128X64_COLOR_BLACK = true

New in version 2.0.2 (Plugin).

procedure TBrickletLCD128x64.SetGUIButton(const index: byte; const positionX: byte; const positionY: byte; const width: byte; const height: byte; const text: string)
Parameters:
  • index – Type: byte, Range: [0 to 11]
  • positionX – Type: byte, Range: [0 to 127]
  • positionY – Type: byte, Range: [0 to 63]
  • width – Type: byte, Range: [1 to 128]
  • height – Type: byte, Range: [1 to 64]
  • text – Type: string, Length: up to 16

Draws a clickable button at position (x, y) with the given text.

You can use up to 12 buttons.

The x position + width has to be within the range of 1 to 128 and the y position + height has to be within the range of 1 to 64.

The minimum useful width/height of a button is 3.

You can enable a callback for a button press with SetGUIButtonPressedCallbackConfiguration. The callback will be triggered for press and release-events.

The button is drawn in a separate GUI buffer and the button-frame will always stay on top of the graphics drawn with WritePixels. To remove the button use RemoveGUIButton.

If you want an icon instead of text, you can draw the icon inside of the button with WritePixels.

New in version 2.0.2 (Plugin).

procedure TBrickletLCD128x64.GetGUIButton(const index: byte; out active: boolean; out positionX: byte; out positionY: byte; out width: byte; out height: byte; out text: string)
Parameters:
  • index – Type: byte, Range: [0 to 11]
Output Parameters:
  • active – Type: boolean
  • positionX – Type: byte, Range: [0 to 127]
  • positionY – Type: byte, Range: [0 to 63]
  • width – Type: byte, Range: [1 to 128]
  • height – Type: byte, Range: [1 to 64]
  • text – Type: string, Length: up to 16

Returns the button properties for a given Index as set by SetGUIButton.

Additionally the Active parameter shows if a button is currently active/visible or not.

New in version 2.0.2 (Plugin).

procedure TBrickletLCD128x64.RemoveGUIButton(const index: byte)
Parameters:
  • index – Type: byte, Range: [0 to 11, 255]

Removes the button with the given index.

You can use index 255 to remove all buttons.

New in version 2.0.2 (Plugin).

function TBrickletLCD128x64.GetGUIButtonPressed(const index: byte): boolean
Parameters:
  • index – Type: byte, Range: [0 to 11]
Returns:
  • pressed – Type: boolean

Returns the state of the button for the given index.

The state can either be pressed (true) or released (false).

New in version 2.0.2 (Plugin).

procedure TBrickletLCD128x64.SetGUISlider(const index: byte; const positionX: byte; const positionY: byte; const length: byte; const direction: byte; const value: byte)
Parameters:
  • index – Type: byte, Range: [0 to 5]
  • positionX – Type: byte, Range: [0 to 128]
  • positionY – Type: byte, Range: [0 to 64]
  • length – Type: byte, Range: [8 to 128]
  • direction – Type: byte, Range: See constants
  • value – Type: byte, Range: [0 to 120]

Draws a slider at position (x, y) with the given length.

You can use up to 6 sliders.

If you use the horizontal direction, the x position + length has to be within the range of 1 to 128 and the y position has to be within the range of 0 to 46.

If you use the vertical direction, the y position + length has to be within the range of 1 to 64 and the x position has to be within the range of 0 to 110.

The minimum length of a slider is 8.

The parameter value is the start-position of the slider, it can be between 0 and length-8.

You can enable a callback for the slider value with SetGUISliderValueCallbackConfiguration.

The slider is drawn in a separate GUI buffer and it will always stay on top of the graphics drawn with WritePixels. To remove the button use RemoveGUISlider.

The following constants are available for this function:

For direction:

  • BRICKLET_LCD_128X64_DIRECTION_HORIZONTAL = 0
  • BRICKLET_LCD_128X64_DIRECTION_VERTICAL = 1

New in version 2.0.2 (Plugin).

procedure TBrickletLCD128x64.GetGUISlider(const index: byte; out active: boolean; out positionX: byte; out positionY: byte; out length: byte; out direction: byte; out value: byte)
Parameters:
  • index – Type: byte, Range: [0 to 5]
Output Parameters:
  • active – Type: boolean
  • positionX – Type: byte, Range: [0 to 128]
  • positionY – Type: byte, Range: [0 to 64]
  • length – Type: byte, Range: [8 to 128]
  • direction – Type: byte, Range: See constants
  • value – Type: byte, Range: [0 to 120]

Returns the slider properties for a given Index as set by SetGUISlider.

Additionally the Active parameter shows if a button is currently active/visible or not.

The following constants are available for this function:

For direction:

  • BRICKLET_LCD_128X64_DIRECTION_HORIZONTAL = 0
  • BRICKLET_LCD_128X64_DIRECTION_VERTICAL = 1

New in version 2.0.2 (Plugin).

procedure TBrickletLCD128x64.RemoveGUISlider(const index: byte)
Parameters:
  • index – Type: byte, Range: [0 to 5, 255]

Removes the slider with the given index.

You can use index 255 to remove all slider.

New in version 2.0.2 (Plugin).

function TBrickletLCD128x64.GetGUISliderValue(const index: byte): byte
Parameters:
  • index – Type: byte, Range: [0 to 5]
Returns:
  • value – Type: byte, Range: [0 to 120]

Returns the current slider value for the given index.

New in version 2.0.2 (Plugin).

procedure TBrickletLCD128x64.SetGUITabConfiguration(const changeTabConfig: byte; const clearGUI: boolean)
Parameters:
  • changeTabConfig – Type: byte, Range: See constants, Default: 3
  • clearGUI – Type: boolean, Default: true

Sets the general configuration for tabs. You can configure the tabs to only accept clicks or only swipes (gesture left/right and right/left) or both.

Additionally, if you set Clear GUI to true, all of the GUI elements (buttons, slider, graphs) will automatically be removed on every tab change.

The following constants are available for this function:

For changeTabConfig:

  • BRICKLET_LCD_128X64_CHANGE_TAB_ON_CLICK = 1
  • BRICKLET_LCD_128X64_CHANGE_TAB_ON_SWIPE = 2
  • BRICKLET_LCD_128X64_CHANGE_TAB_ON_CLICK_AND_SWIPE = 3

New in version 2.0.2 (Plugin).

procedure TBrickletLCD128x64.GetGUITabConfiguration(out changeTabConfig: byte; out clearGUI: boolean)
Output Parameters:
  • changeTabConfig – Type: byte, Range: See constants, Default: 3
  • clearGUI – Type: boolean, Default: true

Returns the tab configuration as set by SetGUITabConfiguration.

The following constants are available for this function:

For changeTabConfig:

  • BRICKLET_LCD_128X64_CHANGE_TAB_ON_CLICK = 1
  • BRICKLET_LCD_128X64_CHANGE_TAB_ON_SWIPE = 2
  • BRICKLET_LCD_128X64_CHANGE_TAB_ON_CLICK_AND_SWIPE = 3

New in version 2.0.2 (Plugin).

procedure TBrickletLCD128x64.SetGUITabText(const index: byte; const text: string)
Parameters:
  • index – Type: byte, Range: [0 to 9]
  • text – Type: string, Length: up to 5

Adds a text-tab with the given index.

You can use up to 10 tabs.

A text-tab with the same index as a icon-tab will overwrite the icon-tab.

New in version 2.0.2 (Plugin).

procedure TBrickletLCD128x64.GetGUITabText(const index: byte; out active: boolean; out text: string)
Parameters:
  • index – Type: byte, Range: [0 to 9]
Output Parameters:
  • active – Type: boolean
  • text – Type: string, Length: up to 5

Returns the text for a given index as set by SetGUITabText.

Additionally the Active parameter shows if the tab is currently active/visible or not.

New in version 2.0.2 (Plugin).

procedure TBrickletLCD128x64.SetGUITabIcon(const index: byte; const icon: array [0..167] of boolean)
Parameters:
  • index – Type: byte, Range: [0 to 9]
  • icon – Type: array [0..167] of boolean

Adds a icon-tab with the given index. The icon can have a width of 28 pixels with a height of 6 pixels. It is drawn line-by-line from left to right.

You can use up to 10 tabs.

A icon-tab with the same index as a text-tab will overwrite the text-tab.

New in version 2.0.2 (Plugin).

procedure TBrickletLCD128x64.GetGUITabIcon(const index: byte; out active: boolean; out icon: array [0..167] of boolean)
Parameters:
  • index – Type: byte, Range: [0 to 9]
Output Parameters:
  • active – Type: boolean
  • icon – Type: array [0..167] of boolean

Returns the icon for a given index as set by SetGUITabIcon.

Additionally the Active parameter shows if the tab is currently active/visible or not.

New in version 2.0.2 (Plugin).

procedure TBrickletLCD128x64.RemoveGUITab(const index: byte)
Parameters:
  • index – Type: byte, Range: [0 to 9, 255]

Removes the tab with the given index.

You can use index 255 to remove all tabs.

New in version 2.0.2 (Plugin).

procedure TBrickletLCD128x64.SetGUITabSelected(const index: byte)
Parameters:
  • index – Type: byte, Range: [0 to 9]

Sets the tab with the given index as selected (drawn as selected on the display).

New in version 2.0.2 (Plugin).

function TBrickletLCD128x64.GetGUITabSelected: shortint
Returns:
  • index – Type: shortint, Range: [-1 to 9]

Returns the index of the currently selected tab. If there are not tabs, the returned index is -1.

New in version 2.0.2 (Plugin).

procedure TBrickletLCD128x64.SetGUIGraphConfiguration(const index: byte; const graphType: byte; const positionX: byte; const positionY: byte; const width: byte; const height: byte; const textX: string; const textY: string)
Parameters:
  • index – Type: byte, Range: [0 to 3]
  • graphType – Type: byte, Range: See constants
  • positionX – Type: byte, Range: [0 to 127]
  • positionY – Type: byte, Range: [0 to 63]
  • width – Type: byte, Range: [0 to 118]
  • height – Type: byte, Range: [0 to 63]
  • textX – Type: string, Length: up to 4
  • textY – Type: string, Length: up to 4

Sets the configuration for up to four graphs.

The graph type can be dot-, line- or bar-graph.

The x and y position are pixel positions.

You can add a text for the x and y axis. The text is drawn at the inside of the graph and it can overwrite some of the graph data. If you need the text outside of the graph you can leave this text here empty and use DrawText to draw the caption outside of the graph.

The data of the graph can be set and updated with SetGUIGraphData.

The graph is drawn in a separate GUI buffer and the graph-frame and data will always stay on top of the graphics drawn with WritePixels. To remove the graph use RemoveGUIGraph.

The following constants are available for this function:

For graphType:

  • BRICKLET_LCD_128X64_GRAPH_TYPE_DOT = 0
  • BRICKLET_LCD_128X64_GRAPH_TYPE_LINE = 1
  • BRICKLET_LCD_128X64_GRAPH_TYPE_BAR = 2

New in version 2.0.2 (Plugin).

procedure TBrickletLCD128x64.GetGUIGraphConfiguration(const index: byte; out active: boolean; out graphType: byte; out positionX: byte; out positionY: byte; out width: byte; out height: byte; out textX: string; out textY: string)
Parameters:
  • index – Type: byte, Range: [0 to 3]
Output Parameters:
  • active – Type: boolean
  • graphType – Type: byte, Range: See constants
  • positionX – Type: byte, Range: [0 to 127]
  • positionY – Type: byte, Range: [0 to 63]
  • width – Type: byte, Range: [0 to 118]
  • height – Type: byte, Range: [0 to 63]
  • textX – Type: string, Length: up to 4
  • textY – Type: string, Length: up to 4

Returns the graph properties for a given Index as set by SetGUIGraphConfiguration.

Additionally the Active parameter shows if a graph is currently active/visible or not.

The following constants are available for this function:

For graphType:

  • BRICKLET_LCD_128X64_GRAPH_TYPE_DOT = 0
  • BRICKLET_LCD_128X64_GRAPH_TYPE_LINE = 1
  • BRICKLET_LCD_128X64_GRAPH_TYPE_BAR = 2

New in version 2.0.2 (Plugin).

procedure TBrickletLCD128x64.SetGUIGraphData(const index: byte; const data: array of byte)
Parameters:
  • index – Type: byte, Range: [0 to 3]
  • data – Type: array of byte, Range: [0 to 255]

Sets the data for a graph with the given index. You have to configure the graph with SetGUIGraphConfiguration before you can set the first data.

The graph will show the first n values of the data that you set, where n is the width set with SetGUIGraphConfiguration. If you set less then n values it will show the rest of the values as zero.

The maximum number of data-points you can set is 118 (which also corresponds to the maximum width of the graph).

You have to scale your values to be between 0 and 255. 0 will be shown at the bottom of the graph and 255 at the top.

New in version 2.0.2 (Plugin).

function TBrickletLCD128x64.GetGUIGraphData(const index: byte): array of byte
Parameters:
  • index – Type: byte, Range: [0 to 3]
Returns:
  • data – Type: array of byte, Range: [0 to 255]

Returns the graph data for a given index as set by SetGUIGraphData.

New in version 2.0.2 (Plugin).

procedure TBrickletLCD128x64.RemoveGUIGraph(const index: byte)
Parameters:
  • index – Type: byte, Range: [0 to 3, 255]

Removes the graph with the given index.

You can use index 255 to remove all graphs.

New in version 2.0.2 (Plugin).

procedure TBrickletLCD128x64.RemoveAllGUI

Removes all GUI elements (buttons, slider, graphs, tabs).

New in version 2.0.2 (Plugin).

Advanced Functions

procedure TBrickletLCD128x64.SetDisplayConfiguration(const contrast: byte; const backlight: byte; const invert: boolean; const automaticDraw: boolean)
Parameters:
  • contrast – Type: byte, Range: [0 to 63], Default: 14
  • backlight – Type: byte, Range: [0 to 100], Default: 100
  • invert – Type: boolean, Default: false
  • automaticDraw – Type: boolean, Default: true

Sets the configuration of the display.

If automatic draw is set to true, the display is automatically updated with every call of WritePixels and WriteLine. If it is set to false, the changes are written into an internal buffer and only shown on the display after a call of DrawBufferedFrame.

procedure TBrickletLCD128x64.GetDisplayConfiguration(out contrast: byte; out backlight: byte; out invert: boolean; out automaticDraw: boolean)
Output Parameters:
  • contrast – Type: byte, Range: [0 to 63], Default: 14
  • backlight – Type: byte, Range: [0 to 100], Default: 100
  • invert – Type: boolean, Default: false
  • automaticDraw – Type: boolean, Default: true

Returns the configuration as set by SetDisplayConfiguration.

procedure TBrickletLCD128x64.SetTouchLEDConfig(const config: byte)
Parameters:
  • config – Type: byte, Range: See constants, Default: 3

Sets the touch LED configuration. By default the LED is on if the LCD is touched.

You can also turn the LED permanently on/off or show a heartbeat.

If the Bricklet is in bootloader mode, the LED is off.

The following constants are available for this function:

For config:

  • BRICKLET_LCD_128X64_TOUCH_LED_CONFIG_OFF = 0
  • BRICKLET_LCD_128X64_TOUCH_LED_CONFIG_ON = 1
  • BRICKLET_LCD_128X64_TOUCH_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BRICKLET_LCD_128X64_TOUCH_LED_CONFIG_SHOW_TOUCH = 3

New in version 2.0.2 (Plugin).

function TBrickletLCD128x64.GetTouchLEDConfig: byte
Returns:
  • config – Type: byte, Range: See constants, Default: 3

Returns the configuration as set by SetTouchLEDConfig

The following constants are available for this function:

For config:

  • BRICKLET_LCD_128X64_TOUCH_LED_CONFIG_OFF = 0
  • BRICKLET_LCD_128X64_TOUCH_LED_CONFIG_ON = 1
  • BRICKLET_LCD_128X64_TOUCH_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BRICKLET_LCD_128X64_TOUCH_LED_CONFIG_SHOW_TOUCH = 3

New in version 2.0.2 (Plugin).

procedure TBrickletLCD128x64.GetSPITFPErrorCount(out errorCountAckChecksum: longword; out errorCountMessageChecksum: longword; out errorCountFrame: longword; out errorCountOverflow: longword)
Output Parameters:
  • errorCountAckChecksum – Type: longword, Range: [0 to 232 - 1]
  • errorCountMessageChecksum – Type: longword, Range: [0 to 232 - 1]
  • errorCountFrame – Type: longword, Range: [0 to 232 - 1]
  • errorCountOverflow – Type: longword, Range: [0 to 232 - 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 TBrickletLCD128x64.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_LCD_128X64_STATUS_LED_CONFIG_OFF = 0
  • BRICKLET_LCD_128X64_STATUS_LED_CONFIG_ON = 1
  • BRICKLET_LCD_128X64_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BRICKLET_LCD_128X64_STATUS_LED_CONFIG_SHOW_STATUS = 3
function TBrickletLCD128x64.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_LCD_128X64_STATUS_LED_CONFIG_OFF = 0
  • BRICKLET_LCD_128X64_STATUS_LED_CONFIG_ON = 1
  • BRICKLET_LCD_128X64_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BRICKLET_LCD_128X64_STATUS_LED_CONFIG_SHOW_STATUS = 3
function TBrickletLCD128x64.GetChipTemperature: smallint
Returns:
  • temperature – Type: smallint, Unit: 1 °C, Range: [-215 to 215 - 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 TBrickletLCD128x64.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 TBrickletLCD128x64.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:
  • 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 216 - 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 TBrickletLCD128x64.SetTouchPositionCallbackConfiguration(const period: longword; const valueHasToChange: boolean)
Parameters:
  • period – Type: longword, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • valueHasToChange – Type: boolean, Default: false

The period is the period with which the OnTouchPosition callback is triggered periodically. A value of 0 turns the callback off.

If the value has to change-parameter is set to true, the callback is only triggered after the value has changed. If the value didn't change within the period, the callback is triggered immediately on change.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

procedure TBrickletLCD128x64.GetTouchPositionCallbackConfiguration(out period: longword; out valueHasToChange: boolean)
Output Parameters:
  • period – Type: longword, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • valueHasToChange – Type: boolean, Default: false

Returns the callback configuration as set by SetTouchPositionCallbackConfiguration.

procedure TBrickletLCD128x64.SetTouchGestureCallbackConfiguration(const period: longword; const valueHasToChange: boolean)
Parameters:
  • period – Type: longword, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • valueHasToChange – Type: boolean, Default: false

The period is the period with which the OnTouchGesture callback is triggered periodically. A value of 0 turns the callback off.

If the value has to change-parameter is set to true, the callback is only triggered after the value has changed. If the value didn't change within the period, the callback is triggered immediately on change.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

procedure TBrickletLCD128x64.GetTouchGestureCallbackConfiguration(out period: longword; out valueHasToChange: boolean)
Output Parameters:
  • period – Type: longword, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • valueHasToChange – Type: boolean, Default: false

Returns the callback configuration as set by SetTouchGestureCallbackConfiguration.

procedure TBrickletLCD128x64.SetGUIButtonPressedCallbackConfiguration(const period: longword; const valueHasToChange: boolean)
Parameters:
  • period – Type: longword, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • valueHasToChange – Type: boolean, Default: false

The period is the period with which the OnGUIButtonPressed callback is triggered periodically. A value of 0 turns the callback off.

If the value has to change-parameter is set to true, the callback is only triggered after the value has changed. If the value didn't change within the period, the callback is triggered immediately on change.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

New in version 2.0.2 (Plugin).

procedure TBrickletLCD128x64.GetGUIButtonPressedCallbackConfiguration(out period: longword; out valueHasToChange: boolean)
Output Parameters:
  • period – Type: longword, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • valueHasToChange – Type: boolean, Default: false

Returns the callback configuration as set by SetGUIButtonPressedCallbackConfiguration.

New in version 2.0.2 (Plugin).

procedure TBrickletLCD128x64.SetGUISliderValueCallbackConfiguration(const period: longword; const valueHasToChange: boolean)
Parameters:
  • period – Type: longword, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • valueHasToChange – Type: boolean, Default: false

The period is the period with which the OnGUISliderValue callback is triggered periodically. A value of 0 turns the callback off.

If the value has to change-parameter is set to true, the callback is only triggered after the value has changed. If the value didn't change within the period, the callback is triggered immediately on change.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

New in version 2.0.2 (Plugin).

procedure TBrickletLCD128x64.GetGUISliderValueCallbackConfiguration(out period: longword; out valueHasToChange: boolean)
Output Parameters:
  • period – Type: longword, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • valueHasToChange – Type: boolean, Default: false

Returns the callback configuration as set by SetGUISliderValueCallbackConfiguration.

New in version 2.0.2 (Plugin).

procedure TBrickletLCD128x64.SetGUITabSelectedCallbackConfiguration(const period: longword; const valueHasToChange: boolean)
Parameters:
  • period – Type: longword, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • valueHasToChange – Type: boolean, Default: false

The period is the period with which the OnGUITabSelected callback is triggered periodically. A value of 0 turns the callback off.

If the value has to change-parameter is set to true, the callback is only triggered after the value has changed. If the value didn't change within the period, the callback is triggered immediately on change.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

New in version 2.0.2 (Plugin).

procedure TBrickletLCD128x64.GetGUITabSelectedCallbackConfiguration(out period: longword; out valueHasToChange: boolean)
Output Parameters:
  • period – Type: longword, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • valueHasToChange – Type: boolean, Default: false

Returns the callback configuration as set by SetGUITabSelectedCallbackConfiguration.

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

lcd128x64.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 TBrickletLCD128x64.OnTouchPosition
procedure(sender: TBrickletLCD128x64; const pressure: word; const x: word; const y: word; const age: longword) of object;
Callback Parameters:
  • sender – Type: TBrickletLCD128x64
  • pressure – Type: word, Range: [0 to 300]
  • x – Type: word, Range: [0 to 127]
  • y – Type: word, Range: [0 to 63]
  • age – Type: longword, Unit: 1 ms, Range: [0 to 232 - 1]

This callback is triggered periodically with the period that is set by SetTouchPositionCallbackConfiguration. The parameters are the same as for GetTouchPosition.

property TBrickletLCD128x64.OnTouchGesture
procedure(sender: TBrickletLCD128x64; const gesture: byte; const duration: longword; const pressureMax: word; const xStart: word; const yStart: word; const xEnd: word; const yEnd: word; const age: longword) of object;
Callback Parameters:
  • sender – Type: TBrickletLCD128x64
  • gesture – Type: byte, Range: See constants
  • duration – Type: longword, Unit: 1 ms, Range: [0 to 232 - 1]
  • pressureMax – Type: word, Range: [0 to 300]
  • xStart – Type: word, Range: [0 to 127]
  • yStart – Type: word, Range: [0 to 63]
  • xEnd – Type: word, Range: [0 to 127]
  • yEnd – Type: word, Range: [0 to 63]
  • age – Type: longword, Unit: 1 ms, Range: [0 to 232 - 1]

This callback is triggered periodically with the period that is set by SetTouchGestureCallbackConfiguration. The parameters are the same as for GetTouchGesture.

The following constants are available for this function:

For gesture:

  • BRICKLET_LCD_128X64_GESTURE_LEFT_TO_RIGHT = 0
  • BRICKLET_LCD_128X64_GESTURE_RIGHT_TO_LEFT = 1
  • BRICKLET_LCD_128X64_GESTURE_TOP_TO_BOTTOM = 2
  • BRICKLET_LCD_128X64_GESTURE_BOTTOM_TO_TOP = 3
property TBrickletLCD128x64.OnGUIButtonPressed
procedure(sender: TBrickletLCD128x64; const index: byte; const pressed: boolean) of object;
Callback Parameters:
  • sender – Type: TBrickletLCD128x64
  • index – Type: byte, Range: [0 to 11]
  • pressed – Type: boolean

This callback is triggered periodically with the period that is set by SetGUIButtonPressedCallbackConfiguration. The parameters are the same as for GetGUIButtonPressed.

New in version 2.0.2 (Plugin).

property TBrickletLCD128x64.OnGUISliderValue
procedure(sender: TBrickletLCD128x64; const index: byte; const value: byte) of object;
Callback Parameters:
  • sender – Type: TBrickletLCD128x64
  • index – Type: byte, Range: [0 to 5]
  • value – Type: byte, Range: [0 to 120]

This callback is triggered periodically with the period that is set by SetGUISliderValueCallbackConfiguration. The parameters are the same as for GetGUISliderValue.

New in version 2.0.2 (Plugin).

property TBrickletLCD128x64.OnGUITabSelected
procedure(sender: TBrickletLCD128x64; const index: shortint) of object;
Callback Parameters:
  • sender – Type: TBrickletLCD128x64
  • index – Type: shortint, Range: [0 to 9]

This callback is triggered periodically with the period that is set by SetGUITabSelectedCallbackConfiguration. The parameters are the same as for GetGUITabSelected.

New in version 2.0.2 (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 TBrickletLCD128x64.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 TBrickletLCD128x64.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_LCD_128X64_FUNCTION_WRITE_PIXELS = 1
  • BRICKLET_LCD_128X64_FUNCTION_CLEAR_DISPLAY = 3
  • BRICKLET_LCD_128X64_FUNCTION_SET_DISPLAY_CONFIGURATION = 4
  • BRICKLET_LCD_128X64_FUNCTION_WRITE_LINE = 6
  • BRICKLET_LCD_128X64_FUNCTION_DRAW_BUFFERED_FRAME = 7
  • BRICKLET_LCD_128X64_FUNCTION_SET_TOUCH_POSITION_CALLBACK_CONFIGURATION = 9
  • BRICKLET_LCD_128X64_FUNCTION_SET_TOUCH_GESTURE_CALLBACK_CONFIGURATION = 13
  • BRICKLET_LCD_128X64_FUNCTION_DRAW_LINE = 16
  • BRICKLET_LCD_128X64_FUNCTION_DRAW_BOX = 17
  • BRICKLET_LCD_128X64_FUNCTION_DRAW_TEXT = 18
  • BRICKLET_LCD_128X64_FUNCTION_SET_GUI_BUTTON = 19
  • BRICKLET_LCD_128X64_FUNCTION_REMOVE_GUI_BUTTON = 21
  • BRICKLET_LCD_128X64_FUNCTION_SET_GUI_BUTTON_PRESSED_CALLBACK_CONFIGURATION = 22
  • BRICKLET_LCD_128X64_FUNCTION_SET_GUI_SLIDER = 26
  • BRICKLET_LCD_128X64_FUNCTION_REMOVE_GUI_SLIDER = 28
  • BRICKLET_LCD_128X64_FUNCTION_SET_GUI_SLIDER_VALUE_CALLBACK_CONFIGURATION = 29
  • BRICKLET_LCD_128X64_FUNCTION_SET_GUI_TAB_CONFIGURATION = 33
  • BRICKLET_LCD_128X64_FUNCTION_SET_GUI_TAB_TEXT = 35
  • BRICKLET_LCD_128X64_FUNCTION_SET_GUI_TAB_ICON = 37
  • BRICKLET_LCD_128X64_FUNCTION_REMOVE_GUI_TAB = 39
  • BRICKLET_LCD_128X64_FUNCTION_SET_GUI_TAB_SELECTED = 40
  • BRICKLET_LCD_128X64_FUNCTION_SET_GUI_TAB_SELECTED_CALLBACK_CONFIGURATION = 41
  • BRICKLET_LCD_128X64_FUNCTION_SET_GUI_GRAPH_CONFIGURATION = 45
  • BRICKLET_LCD_128X64_FUNCTION_SET_GUI_GRAPH_DATA = 47
  • BRICKLET_LCD_128X64_FUNCTION_REMOVE_GUI_GRAPH = 49
  • BRICKLET_LCD_128X64_FUNCTION_REMOVE_ALL_GUI = 50
  • BRICKLET_LCD_128X64_FUNCTION_SET_TOUCH_LED_CONFIG = 51
  • BRICKLET_LCD_128X64_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BRICKLET_LCD_128X64_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BRICKLET_LCD_128X64_FUNCTION_RESET = 243
  • BRICKLET_LCD_128X64_FUNCTION_WRITE_UID = 248
procedure TBrickletLCD128x64.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.

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_LCD_128X64_FUNCTION_WRITE_PIXELS = 1
  • BRICKLET_LCD_128X64_FUNCTION_CLEAR_DISPLAY = 3
  • BRICKLET_LCD_128X64_FUNCTION_SET_DISPLAY_CONFIGURATION = 4
  • BRICKLET_LCD_128X64_FUNCTION_WRITE_LINE = 6
  • BRICKLET_LCD_128X64_FUNCTION_DRAW_BUFFERED_FRAME = 7
  • BRICKLET_LCD_128X64_FUNCTION_SET_TOUCH_POSITION_CALLBACK_CONFIGURATION = 9
  • BRICKLET_LCD_128X64_FUNCTION_SET_TOUCH_GESTURE_CALLBACK_CONFIGURATION = 13
  • BRICKLET_LCD_128X64_FUNCTION_DRAW_LINE = 16
  • BRICKLET_LCD_128X64_FUNCTION_DRAW_BOX = 17
  • BRICKLET_LCD_128X64_FUNCTION_DRAW_TEXT = 18
  • BRICKLET_LCD_128X64_FUNCTION_SET_GUI_BUTTON = 19
  • BRICKLET_LCD_128X64_FUNCTION_REMOVE_GUI_BUTTON = 21
  • BRICKLET_LCD_128X64_FUNCTION_SET_GUI_BUTTON_PRESSED_CALLBACK_CONFIGURATION = 22
  • BRICKLET_LCD_128X64_FUNCTION_SET_GUI_SLIDER = 26
  • BRICKLET_LCD_128X64_FUNCTION_REMOVE_GUI_SLIDER = 28
  • BRICKLET_LCD_128X64_FUNCTION_SET_GUI_SLIDER_VALUE_CALLBACK_CONFIGURATION = 29
  • BRICKLET_LCD_128X64_FUNCTION_SET_GUI_TAB_CONFIGURATION = 33
  • BRICKLET_LCD_128X64_FUNCTION_SET_GUI_TAB_TEXT = 35
  • BRICKLET_LCD_128X64_FUNCTION_SET_GUI_TAB_ICON = 37
  • BRICKLET_LCD_128X64_FUNCTION_REMOVE_GUI_TAB = 39
  • BRICKLET_LCD_128X64_FUNCTION_SET_GUI_TAB_SELECTED = 40
  • BRICKLET_LCD_128X64_FUNCTION_SET_GUI_TAB_SELECTED_CALLBACK_CONFIGURATION = 41
  • BRICKLET_LCD_128X64_FUNCTION_SET_GUI_GRAPH_CONFIGURATION = 45
  • BRICKLET_LCD_128X64_FUNCTION_SET_GUI_GRAPH_DATA = 47
  • BRICKLET_LCD_128X64_FUNCTION_REMOVE_GUI_GRAPH = 49
  • BRICKLET_LCD_128X64_FUNCTION_REMOVE_ALL_GUI = 50
  • BRICKLET_LCD_128X64_FUNCTION_SET_TOUCH_LED_CONFIG = 51
  • BRICKLET_LCD_128X64_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BRICKLET_LCD_128X64_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BRICKLET_LCD_128X64_FUNCTION_RESET = 243
  • BRICKLET_LCD_128X64_FUNCTION_WRITE_UID = 248
procedure TBrickletLCD128x64.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 TBrickletLCD128x64.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_LCD_128X64_BOOTLOADER_MODE_BOOTLOADER = 0
  • BRICKLET_LCD_128X64_BOOTLOADER_MODE_FIRMWARE = 1
  • BRICKLET_LCD_128X64_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BRICKLET_LCD_128X64_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BRICKLET_LCD_128X64_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

For status:

  • BRICKLET_LCD_128X64_BOOTLOADER_STATUS_OK = 0
  • BRICKLET_LCD_128X64_BOOTLOADER_STATUS_INVALID_MODE = 1
  • BRICKLET_LCD_128X64_BOOTLOADER_STATUS_NO_CHANGE = 2
  • BRICKLET_LCD_128X64_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • BRICKLET_LCD_128X64_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • BRICKLET_LCD_128X64_BOOTLOADER_STATUS_CRC_MISMATCH = 5
function TBrickletLCD128x64.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_LCD_128X64_BOOTLOADER_MODE_BOOTLOADER = 0
  • BRICKLET_LCD_128X64_BOOTLOADER_MODE_FIRMWARE = 1
  • BRICKLET_LCD_128X64_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BRICKLET_LCD_128X64_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BRICKLET_LCD_128X64_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
procedure TBrickletLCD128x64.SetWriteFirmwarePointer(const pointer: longword)
Parameters:
  • pointer – Type: longword, Unit: 1 B, Range: [0 to 232 - 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 TBrickletLCD128x64.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 TBrickletLCD128x64.WriteUID(const uid: longword)
Parameters:
  • uid – Type: longword, Range: [0 to 232 - 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 TBrickletLCD128x64.ReadUID: longword
Returns:
  • uid – Type: longword, Range: [0 to 232 - 1]

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

Constants

const BRICKLET_LCD_128X64_DEVICE_IDENTIFIER

This constant is used to identify a LCD 128x64 Bricklet.

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_LCD_128X64_DEVICE_DISPLAY_NAME

This constant represents the human readable name of a LCD 128x64 Bricklet.