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

Perl - LCD 128x64 Bricklet

This is the description of the Perl 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 Perl API bindings is part of their general description.

Examples

The example code below is Public Domain (CC0 1.0).

Big Font

Download (example_big_font.pl)

 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
#!/usr/bin/perl

use strict;
use Tinkerforge::IPConnection;
use Tinkerforge::BrickletLCD128x64;

use constant HOST => 'localhost';
use constant PORT => 4223;
use constant UID => 'XYZ'; # Change XYZ to the UID of your LCD 128x64 Bricklet

my $ipcon = Tinkerforge::IPConnection->new(); # Create IP connection
my $lcd = Tinkerforge::BrickletLCD128x64->new(&UID, $ipcon); # Create device object

$ipcon->connect(&HOST, &PORT); # Connect to brickd
# Don't use device before ipcon is connected

# Clear display
$lcd->clear_display();

# Write "Hello World" with big 24x32 font
$lcd->draw_text(0, 0, $lcd->FONT_24X32, $lcd->COLOR_BLACK, "24x32");

print "Press key to exit\n";
<STDIN>;
$ipcon->disconnect();

Hello World

Download (example_hello_world.pl)

 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
#!/usr/bin/perl

use strict;
use Tinkerforge::IPConnection;
use Tinkerforge::BrickletLCD128x64;

use constant HOST => 'localhost';
use constant PORT => 4223;
use constant UID => 'XYZ'; # Change XYZ to the UID of your LCD 128x64 Bricklet

my $ipcon = Tinkerforge::IPConnection->new(); # Create IP connection
my $lcd = Tinkerforge::BrickletLCD128x64->new(&UID, $ipcon); # Create device object

$ipcon->connect(&HOST, &PORT); # Connect to brickd
# Don't use device before ipcon is connected

# Clear display
$lcd->clear_display();

# Write "Hello World" starting from upper left corner of the screen
$lcd->write_line(0, 0, "Hello World");

print "Press key to exit\n";
<STDIN>;
$ipcon->disconnect();

Pixel Matrix

Download (example_pixel_matrix.pl)

 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
#!/usr/bin/perl

use strict;
use Tinkerforge::IPConnection;
use Tinkerforge::BrickletLCD128x64;

use constant HOST => 'localhost';
use constant PORT => 4223;
use constant UID => 'XYZ'; # Change XYZ to the UID of your LCD 128x64 Bricklet
use constant WIDTH => 128;
use constant HEIGHT => 64;

my $ipcon = Tinkerforge::IPConnection->new(); # Create IP connection
my $lcd = Tinkerforge::BrickletLCD128x64->new(&UID, $ipcon); # Create device object

$ipcon->connect(&HOST, &PORT); # Connect to brickd
# Don't use device before ipcon is connected

# Clear display
$lcd->clear_display();

# Draw checkerboard pattern
my @pixels = ();

foreach my $row (0..&HEIGHT - 1) {
    foreach my $column (0..&WIDTH - 1) {
        $pixels[$row*&WIDTH + $column] = (($row / 8) % 2) == (($column / 8) % 2);
    }
}

$lcd->write_pixels(0, 0, &WIDTH-1, &HEIGHT-1, \@pixels);

print "Press key to exit\n";
<STDIN>;
$ipcon->disconnect();

Scribble

Download (example_scribble.pl)

 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
#!/usr/bin/perl

use strict;
use Math::Trig;
use Term::ReadKey;
use GD;
use Tinkerforge::IPConnection;
use Tinkerforge::BrickletLCD128x64;

use constant HOST => 'localhost';
use constant PORT => 4223;
use constant UID => 'XYZ'; # Change XYZ to the UID of your LCD 128x64 Bricklet
use constant WIDTH => 128;
use constant HEIGHT => 64;

my $ipcon = Tinkerforge::IPConnection->new(); # Create IP connection
my $lcd = Tinkerforge::BrickletLCD128x64->new(&UID, $ipcon); # Create device object

sub draw_image
{
    my ($lcd, $image) = @_;
    my @pixels = ();

    foreach my $row (0..&HEIGHT - 1) {
        foreach my $column (0..&WIDTH - 1) {
            my $index = $image->getPixel($column, $row);
            $pixels[$row*&WIDTH + $column] = $image->rgb($index) > 0;
        }
    }
    $lcd->write_pixels(0, 0, &WIDTH-1, &HEIGHT-1, \@pixels);
}

$ipcon->connect(&HOST, &PORT); # Connect to brickd
# Don't use device before ipcon is connected

# Clear display
$lcd->clear_display();

# Draw rotating line
my $image = new GD::Image(&WIDTH, &HEIGHT);
my $black = $image->colorAllocate(0, 0, 0);
my $white = $image->colorAllocate(255, 255, 255);
my $origin_x = &WIDTH / 2;
my $origin_y = &HEIGHT / 2;
my $length = &HEIGHT / 2 - 2;
my $angle = 0;

print "Press key to exit\n";
ReadMode(4);

while (!defined(ReadKey(-1))) {
    my $radians = pi * $angle / 180.0;
    my $x = int($origin_x + $length * cos($radians));
    my $y = int($origin_y + $length * sin($radians));

    $image->filledRectangle(0, 0, &WIDTH, &HEIGHT, $black);
    $image->line($origin_x, $origin_y, $x, $y, $white);

    draw_image($lcd, $image);
    sleep 0.025;

    $angle++;
}

ReadMode(0);
$ipcon->disconnect();

Touch

Download (example_touch.pl)

 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
#!/usr/bin/perl

use strict;
use Tinkerforge::IPConnection;
use Tinkerforge::BrickletLCD128x64;

use constant HOST => 'localhost';
use constant PORT => 4223;
use constant UID => 'XYZ'; # Change XYZ to the UID of your LCD 128x64 Bricklet

# Callback subroutine for touch position callback
sub cb_touch_position
{
    my ($pressure, $x, $y, $age) = @_;

    print "Pressure: $pressure\n";
    print "X: $x\n";
    print "Y: $y\n";
    print "Age: $age\n";
    print "\n";
}

# Callback subroutine for touch gesture callback
sub cb_touch_gesture
{
    my ($gesture, $duration, $pressure_max, $x_start, $x_end, $y_start, $y_end,
        $age) = @_;

    if ($gesture == Tinkerforge::BrickletLCD128x64->GESTURE_LEFT_TO_RIGHT)
    {
        print "Gesture: Left To Right\n";
    }
    elsif ($gesture == Tinkerforge::BrickletLCD128x64->GESTURE_RIGHT_TO_LEFT)
    {
        print "Gesture: Right To Left\n";
    }
    elsif ($gesture == Tinkerforge::BrickletLCD128x64->GESTURE_TOP_TO_BOTTOM)
    {
        print "Gesture: Top To Bottom\n";
    }
    elsif ($gesture == Tinkerforge::BrickletLCD128x64->GESTURE_BOTTOM_TO_TOP)
    {
        print "Gesture: Bottom To Top\n";
    }

    print "Duration: $duration\n";
    print "Pressure Max: $pressure_max\n";
    print "X Start: $x_start\n";
    print "X End: $x_end\n";
    print "Y Start: $y_start\n";
    print "Y End: $y_end\n";
    print "Age: $age\n";
    print "\n";
}

my $ipcon = Tinkerforge::IPConnection->new(); # Create IP connection
my $lcd = Tinkerforge::BrickletLCD128x64->new(&UID, $ipcon); # Create device object

$ipcon->connect(&HOST, &PORT); # Connect to brickd
# Don't use device before ipcon is connected

# Register touch position callback to subroutine cb_touch_position
$lcd->register_callback($lcd->CALLBACK_TOUCH_POSITION, 'cb_touch_position');

# Register touch gesture callback to subroutine cb_touch_gesture
$lcd->register_callback($lcd->CALLBACK_TOUCH_GESTURE, 'cb_touch_gesture');

# Set period for touch position callback to 0.1s (100ms)
$lcd->set_touch_position_callback_configuration(100, 1);

# Set period for touch gesture callback to 0.1s (100ms)
$lcd->set_touch_gesture_callback_configuration(100, 1);

print "Press key to exit\n";
<STDIN>;
$ipcon->disconnect();

Gui

Download (example_gui.pl)

 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
#!/usr/bin/perl

use strict;
use Tinkerforge::IPConnection;
use Tinkerforge::BrickletLCD128x64;

use constant HOST => 'localhost';
use constant PORT => 4223;
use constant UID => 'XYZ'; # Change XYZ to the UID of your LCD 128x64 Bricklet

# Callback subroutine for GUI button pressed callback
sub cb_gui_button_pressed
{
    my ($index, $pressed) = @_;

    print "Index: $index\n";
    print "Pressed: $pressed\n";
    print "\n";
}

# Callback subroutine for GUI slider value callback
sub cb_gui_slider_value
{
    my ($index, $value) = @_;

    print "Index: $index\n";
    print "Value: $value\n";
    print "\n";
}

# Callback subroutine for GUI tab selected callback
sub cb_gui_tab_selected
{
    my ($index) = @_;

    print "Index: $index\n";
}

my $ipcon = Tinkerforge::IPConnection->new(); # Create IP connection
my $lcd = Tinkerforge::BrickletLCD128x64->new(&UID, $ipcon); # Create device object

$ipcon->connect(&HOST, &PORT); # Connect to brickd
# Don't use device before ipcon is connected

# Register GUI button pressed callback to subroutine cb_gui_button_pressed
$lcd->register_callback($lcd->CALLBACK_GUI_BUTTON_PRESSED, 'cb_gui_button_pressed');

# Register GUI slider value callback to subroutine cb_gui_slider_value
$lcd->register_callback($lcd->CALLBACK_GUI_SLIDER_VALUE, 'cb_gui_slider_value');

# Register GUI tab selected callback to subroutine cb_gui_tab_selected
$lcd->register_callback($lcd->CALLBACK_GUI_TAB_SELECTED, 'cb_gui_tab_selected');

# Clear display
$lcd->clear_display();
$lcd->remove_all_gui();

# Add GUI elements: Button, Slider and Graph with 60 data points
$lcd->set_gui_button(0, 0, 0, 60, 20, "button");
$lcd->set_gui_slider(0, 0, 30, 60, $lcd->DIRECTION_HORIZONTAL, 50);
$lcd->set_gui_graph_configuration(0, $lcd->GRAPH_TYPE_LINE, 62, 0, 60, 52, "X", "Y");

# Add a few data points (the remaining points will be 0)
$lcd->set_gui_graph_data(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->set_gui_tab_configuration($lcd->CHANGE_TAB_ON_CLICK_AND_SWIPE, 0);
$lcd->set_gui_tab_text(0, "Tab A");
$lcd->set_gui_tab_text(1, "Tab B");
$lcd->set_gui_tab_text(2, "Tab C");
$lcd->set_gui_tab_text(3, "Tab D");
$lcd->set_gui_tab_text(4, "Tab E");

# Set period for GUI button pressed callback to 0.1s (100ms)
$lcd->set_gui_button_pressed_callback_configuration(100, 1);

# Set period for GUI slider value callback to 0.1s (100ms)
$lcd->set_gui_slider_value_callback_configuration(100, 1);

# Set period for GUI tab selected callback to 0.1s (100ms)
$lcd->set_gui_tab_selected_callback_configuration(100, 1);

print "Press key to exit\n";
<STDIN>;
$ipcon->disconnect();

API

Generally, every subroutine of the Perl bindings can report an error as Tinkerforge::Error object via croak(). The object has a get_code() and a get_message() subroutine. There are different error code:

  • Error->ALREADY_CONNECTED = 11
  • Error->NOT_CONNECTED = 12
  • Error->CONNECT_FAILED = 13
  • Error->INVALID_FUNCTION_ID = 21
  • Error->TIMEOUT = 31
  • Error->INVALID_PARAMETER = 41
  • Error->FUNCTION_NOT_SUPPORTED = 42
  • Error->UNKNOWN_ERROR = 43
  • Error->STREAM_OUT_OF_SYNC = 51
  • Error->INVALID_UID = 61
  • Error->NON_ASCII_CHAR_IN_SECRET = 71
  • Error->WRONG_DEVICE_TYPE = 81
  • Error->DEVICE_REPLACED = 82
  • Error->WRONG_RESPONSE_LENGTH = 83

All functions listed below are thread-safe.

Basic Functions

BrickletLCD128x64->new($uid, $ipcon)
Parameters:
  • $uid – Type: string
  • $ipcon – Type: IPConnection
Returns:
  • $lcd_128x64 – Type: BrickletLCD128x64

Creates an object with the unique device ID $uid:

$lcd_128x64 = BrickletLCD128x64->new("YOUR_DEVICE_UID", $ipcon);

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

BrickletLCD128x64->write_pixels($x_start, $y_start, $x_end, $y_end, \@pixels)
Parameters:
  • $x_start – Type: int, Range: [0 to 127]
  • $y_start – Type: int, Range: [0 to 63]
  • $x_end – Type: int, Range: [0 to 127]
  • $y_end – Type: int, Range: [0 to 63]
  • \@pixels – Type: [bool, ...], Length: variable
Returns:
  • undef

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 draw_buffered_frame() is called. This can be used to avoid flicker when drawing a complex frame in multiple steps.

Automatic draw can be configured with the set_display_configuration() function.

BrickletLCD128x64->read_pixels($x_start, $y_start, $x_end, $y_end)
Parameters:
  • $x_start – Type: int, Range: [0 to 127]
  • $y_start – Type: int, Range: [0 to 63]
  • $x_end – Type: int, Range: [0 to 127]
  • $y_end – Type: int, Range: [0 to 63]
Returns:
  • \@pixels – Type: [bool, ...], Length: variable

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 draw_buffered_frame()).

Automatic draw can be configured with the set_display_configuration() function.

BrickletLCD128x64->clear_display()
Returns:
  • undef

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 draw_buffered_frame() is called. This can be used to avoid flicker when drawing a complex frame in multiple steps.

Automatic draw can be configured with the set_display_configuration() function.

BrickletLCD128x64->write_line($line, $position, $text)
Parameters:
  • $line – Type: int, Range: [0 to 7]
  • $position – Type: int, Range: [0 to 21]
  • $text – Type: string, Length: up to 22
Returns:
  • undef

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 draw_buffered_frame() is called. This can be used to avoid flicker when drawing a complex frame in multiple steps.

Automatic draw can be configured with the set_display_configuration() 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 draw_text() function.

BrickletLCD128x64->draw_buffered_frame($force_complete_redraw)
Parameters:
  • $force_complete_redraw – Type: bool
Returns:
  • undef

Draws the currently buffered frame. Normally each call of write_pixels() and write_line() draws directly onto the display. If you turn automatic draw off (set_display_configuration()), 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.

BrickletLCD128x64->get_touch_position()
Return Array:
  • 0: $pressure – Type: int, Range: [0 to 300]
  • 1: $x – Type: int, Range: [0 to 127]
  • 2: $y – Type: int, Range: [0 to 63]
  • 3: $age – Type: int, 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)
BrickletLCD128x64->get_touch_gesture()
Return Array:
  • 0: $gesture – Type: int, Range: See constants
  • 1: $duration – Type: int, Unit: 1 ms, Range: [0 to 232 - 1]
  • 2: $pressure_max – Type: int, Range: [0 to 300]
  • 3: $x_start – Type: int, Range: [0 to 127]
  • 4: $y_start – Type: int, Range: [0 to 63]
  • 5: $x_end – Type: int, Range: [0 to 127]
  • 6: $y_end – Type: int, Range: [0 to 63]
  • 7: $age – Type: int, 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:

  • BrickletLCD128x64->GESTURE_LEFT_TO_RIGHT = 0
  • BrickletLCD128x64->GESTURE_RIGHT_TO_LEFT = 1
  • BrickletLCD128x64->GESTURE_TOP_TO_BOTTOM = 2
  • BrickletLCD128x64->GESTURE_BOTTOM_TO_TOP = 3
BrickletLCD128x64->draw_line($position_x_start, $position_y_start, $position_x_end, $position_y_end, $color)
Parameters:
  • $position_x_start – Type: int, Range: [0 to 127]
  • $position_y_start – Type: int, Range: [0 to 63]
  • $position_x_end – Type: int, Range: [0 to 127]
  • $position_y_end – Type: int, Range: [0 to 63]
  • $color – Type: bool
Returns:
  • undef

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

The following constants are available for this function:

For $color:

  • BrickletLCD128x64->COLOR_WHITE = 0
  • BrickletLCD128x64->COLOR_BLACK = 1

New in version 2.0.2 (Plugin).

BrickletLCD128x64->draw_box($position_x_start, $position_y_start, $position_x_end, $position_y_end, $fill, $color)
Parameters:
  • $position_x_start – Type: int, Range: [0 to 127]
  • $position_y_start – Type: int, Range: [0 to 63]
  • $position_x_end – Type: int, Range: [0 to 127]
  • $position_y_end – Type: int, Range: [0 to 63]
  • $fill – Type: bool
  • $color – Type: bool
Returns:
  • undef

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:

  • BrickletLCD128x64->COLOR_WHITE = 0
  • BrickletLCD128x64->COLOR_BLACK = 1

New in version 2.0.2 (Plugin).

BrickletLCD128x64->draw_text($position_x, $position_y, $font, $color, $text)
Parameters:
  • $position_x – Type: int, Range: [0 to 127]
  • $position_y – Type: int, Range: [0 to 63]
  • $font – Type: int, Range: See constants
  • $color – Type: bool
  • $text – Type: string, Length: up to 22
Returns:
  • undef

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:

  • BrickletLCD128x64->FONT_6X8 = 0
  • BrickletLCD128x64->FONT_6X16 = 1
  • BrickletLCD128x64->FONT_6X24 = 2
  • BrickletLCD128x64->FONT_6X32 = 3
  • BrickletLCD128x64->FONT_12X16 = 4
  • BrickletLCD128x64->FONT_12X24 = 5
  • BrickletLCD128x64->FONT_12X32 = 6
  • BrickletLCD128x64->FONT_18X24 = 7
  • BrickletLCD128x64->FONT_18X32 = 8
  • BrickletLCD128x64->FONT_24X32 = 9

For $color:

  • BrickletLCD128x64->COLOR_WHITE = 0
  • BrickletLCD128x64->COLOR_BLACK = 1

New in version 2.0.2 (Plugin).

BrickletLCD128x64->set_gui_button($index, $position_x, $position_y, $width, $height, $text)
Parameters:
  • $index – Type: int, Range: [0 to 11]
  • $position_x – Type: int, Range: [0 to 127]
  • $position_y – Type: int, Range: [0 to 63]
  • $width – Type: int, Range: [1 to 128]
  • $height – Type: int, Range: [1 to 64]
  • $text – Type: string, Length: up to 16
Returns:
  • undef

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 set_gui_button_pressed_callback_configuration(). 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 write_pixels(). To remove the button use remove_gui_button().

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

New in version 2.0.2 (Plugin).

BrickletLCD128x64->get_gui_button($index)
Parameters:
  • $index – Type: int, Range: [0 to 11]
Return Array:
  • 0: $active – Type: bool
  • 1: $position_x – Type: int, Range: [0 to 127]
  • 2: $position_y – Type: int, Range: [0 to 63]
  • 3: $width – Type: int, Range: [1 to 128]
  • 4: $height – Type: int, Range: [1 to 64]
  • 5: $text – Type: string, Length: up to 16

Returns the button properties for a given Index as set by set_gui_button().

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

New in version 2.0.2 (Plugin).

BrickletLCD128x64->remove_gui_button($index)
Parameters:
  • $index – Type: int, Range: [0 to 11, 255]
Returns:
  • undef

Removes the button with the given index.

You can use index 255 to remove all buttons.

New in version 2.0.2 (Plugin).

BrickletLCD128x64->get_gui_button_pressed($index)
Parameters:
  • $index – Type: int, Range: [0 to 11]
Returns:
  • $pressed – Type: bool

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

BrickletLCD128x64->set_gui_slider($index, $position_x, $position_y, $length, $direction, $value)
Parameters:
  • $index – Type: int, Range: [0 to 5]
  • $position_x – Type: int, Range: [0 to 128]
  • $position_y – Type: int, Range: [0 to 64]
  • $length – Type: int, Range: [8 to 128]
  • $direction – Type: int, Range: See constants
  • $value – Type: int, Range: [0 to 120]
Returns:
  • undef

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 set_gui_slider_value_callback_configuration().

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

The following constants are available for this function:

For $direction:

  • BrickletLCD128x64->DIRECTION_HORIZONTAL = 0
  • BrickletLCD128x64->DIRECTION_VERTICAL = 1

New in version 2.0.2 (Plugin).

BrickletLCD128x64->get_gui_slider($index)
Parameters:
  • $index – Type: int, Range: [0 to 5]
Return Array:
  • 0: $active – Type: bool
  • 1: $position_x – Type: int, Range: [0 to 128]
  • 2: $position_y – Type: int, Range: [0 to 64]
  • 3: $length – Type: int, Range: [8 to 128]
  • 4: $direction – Type: int, Range: See constants
  • 5: $value – Type: int, Range: [0 to 120]

Returns the slider properties for a given Index as set by set_gui_slider().

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

The following constants are available for this function:

For $direction:

  • BrickletLCD128x64->DIRECTION_HORIZONTAL = 0
  • BrickletLCD128x64->DIRECTION_VERTICAL = 1

New in version 2.0.2 (Plugin).

BrickletLCD128x64->remove_gui_slider($index)
Parameters:
  • $index – Type: int, Range: [0 to 5, 255]
Returns:
  • undef

Removes the slider with the given index.

You can use index 255 to remove all slider.

New in version 2.0.2 (Plugin).

BrickletLCD128x64->get_gui_slider_value($index)
Parameters:
  • $index – Type: int, Range: [0 to 5]
Returns:
  • $value – Type: int, Range: [0 to 120]

Returns the current slider value for the given index.

New in version 2.0.2 (Plugin).

BrickletLCD128x64->set_gui_tab_configuration($change_tab_config, $clear_gui)
Parameters:
  • $change_tab_config – Type: int, Range: See constants, Default: 3
  • $clear_gui – Type: bool, Default: 1
Returns:
  • undef

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 $change_tab_config:

  • BrickletLCD128x64->CHANGE_TAB_ON_CLICK = 1
  • BrickletLCD128x64->CHANGE_TAB_ON_SWIPE = 2
  • BrickletLCD128x64->CHANGE_TAB_ON_CLICK_AND_SWIPE = 3

New in version 2.0.2 (Plugin).

BrickletLCD128x64->get_gui_tab_configuration()
Return Array:
  • 0: $change_tab_config – Type: int, Range: See constants, Default: 3
  • 1: $clear_gui – Type: bool, Default: 1

Returns the tab configuration as set by set_gui_tab_configuration().

The following constants are available for this function:

For $change_tab_config:

  • BrickletLCD128x64->CHANGE_TAB_ON_CLICK = 1
  • BrickletLCD128x64->CHANGE_TAB_ON_SWIPE = 2
  • BrickletLCD128x64->CHANGE_TAB_ON_CLICK_AND_SWIPE = 3

New in version 2.0.2 (Plugin).

BrickletLCD128x64->set_gui_tab_text($index, $text)
Parameters:
  • $index – Type: int, Range: [0 to 9]
  • $text – Type: string, Length: up to 5
Returns:
  • undef

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

BrickletLCD128x64->get_gui_tab_text($index)
Parameters:
  • $index – Type: int, Range: [0 to 9]
Return Array:
  • 0: $active – Type: bool
  • 1: $text – Type: string, Length: up to 5

Returns the text for a given index as set by set_gui_tab_text().

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

New in version 2.0.2 (Plugin).

BrickletLCD128x64->set_gui_tab_icon($index, \@icon)
Parameters:
  • $index – Type: int, Range: [0 to 9]
  • \@icon – Type: [bool, ...], Length: 168
Returns:
  • undef

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

BrickletLCD128x64->get_gui_tab_icon($index)
Parameters:
  • $index – Type: int, Range: [0 to 9]
Return Array:
  • 0: $active – Type: bool
  • 1: \@icon – Type: [bool, ...], Length: 168

Returns the icon for a given index as set by set_gui_tab_icon().

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

New in version 2.0.2 (Plugin).

BrickletLCD128x64->remove_gui_tab($index)
Parameters:
  • $index – Type: int, Range: [0 to 9, 255]
Returns:
  • undef

Removes the tab with the given index.

You can use index 255 to remove all tabs.

New in version 2.0.2 (Plugin).

BrickletLCD128x64->set_gui_tab_selected($index)
Parameters:
  • $index – Type: int, Range: [0 to 9]
Returns:
  • undef

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

New in version 2.0.2 (Plugin).

BrickletLCD128x64->get_gui_tab_selected()
Returns:
  • $index – Type: int, 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).

BrickletLCD128x64->set_gui_graph_configuration($index, $graph_type, $position_x, $position_y, $width, $height, $text_x, $text_y)
Parameters:
  • $index – Type: int, Range: [0 to 3]
  • $graph_type – Type: int, Range: See constants
  • $position_x – Type: int, Range: [0 to 127]
  • $position_y – Type: int, Range: [0 to 63]
  • $width – Type: int, Range: [0 to 118]
  • $height – Type: int, Range: [0 to 63]
  • $text_x – Type: string, Length: up to 4
  • $text_y – Type: string, Length: up to 4
Returns:
  • undef

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 draw_text() to draw the caption outside of the graph.

The data of the graph can be set and updated with set_gui_graph_data().

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 write_pixels(). To remove the graph use remove_gui_graph().

The following constants are available for this function:

For $graph_type:

  • BrickletLCD128x64->GRAPH_TYPE_DOT = 0
  • BrickletLCD128x64->GRAPH_TYPE_LINE = 1
  • BrickletLCD128x64->GRAPH_TYPE_BAR = 2

New in version 2.0.2 (Plugin).

BrickletLCD128x64->get_gui_graph_configuration($index)
Parameters:
  • $index – Type: int, Range: [0 to 3]
Return Array:
  • 0: $active – Type: bool
  • 1: $graph_type – Type: int, Range: See constants
  • 2: $position_x – Type: int, Range: [0 to 127]
  • 3: $position_y – Type: int, Range: [0 to 63]
  • 4: $width – Type: int, Range: [0 to 118]
  • 5: $height – Type: int, Range: [0 to 63]
  • 6: $text_x – Type: string, Length: up to 4
  • 7: $text_y – Type: string, Length: up to 4

Returns the graph properties for a given Index as set by set_gui_graph_configuration().

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

The following constants are available for this function:

For $graph_type:

  • BrickletLCD128x64->GRAPH_TYPE_DOT = 0
  • BrickletLCD128x64->GRAPH_TYPE_LINE = 1
  • BrickletLCD128x64->GRAPH_TYPE_BAR = 2

New in version 2.0.2 (Plugin).

BrickletLCD128x64->set_gui_graph_data($index, \@data)
Parameters:
  • $index – Type: int, Range: [0 to 3]
  • \@data – Type: [int, ...], Length: variable, Range: [0 to 255]
Returns:
  • undef

Sets the data for a graph with the given index. You have to configure the graph with set_gui_graph_configuration() 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 set_gui_graph_configuration(). 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).

BrickletLCD128x64->get_gui_graph_data($index)
Parameters:
  • $index – Type: int, Range: [0 to 3]
Returns:
  • \@data – Type: [int, ...], Length: variable, Range: [0 to 255]

Returns the graph data for a given index as set by set_gui_graph_data().

New in version 2.0.2 (Plugin).

BrickletLCD128x64->remove_gui_graph($index)
Parameters:
  • $index – Type: int, Range: [0 to 3, 255]
Returns:
  • undef

Removes the graph with the given index.

You can use index 255 to remove all graphs.

New in version 2.0.2 (Plugin).

BrickletLCD128x64->remove_all_gui()
Returns:
  • undef

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

New in version 2.0.2 (Plugin).

Advanced Functions

BrickletLCD128x64->set_display_configuration($contrast, $backlight, $invert, $automatic_draw)
Parameters:
  • $contrast – Type: int, Range: [0 to 63], Default: 14
  • $backlight – Type: int, Range: [0 to 100], Default: 100
  • $invert – Type: bool, Default: 0
  • $automatic_draw – Type: bool, Default: 1
Returns:
  • undef

Sets the configuration of the display.

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

BrickletLCD128x64->get_display_configuration()
Return Array:
  • 0: $contrast – Type: int, Range: [0 to 63], Default: 14
  • 1: $backlight – Type: int, Range: [0 to 100], Default: 100
  • 2: $invert – Type: bool, Default: 0
  • 3: $automatic_draw – Type: bool, Default: 1

Returns the configuration as set by set_display_configuration().

BrickletLCD128x64->set_touch_led_config($config)
Parameters:
  • $config – Type: int, Range: See constants, Default: 3
Returns:
  • undef

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:

  • BrickletLCD128x64->TOUCH_LED_CONFIG_OFF = 0
  • BrickletLCD128x64->TOUCH_LED_CONFIG_ON = 1
  • BrickletLCD128x64->TOUCH_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletLCD128x64->TOUCH_LED_CONFIG_SHOW_TOUCH = 3

New in version 2.0.2 (Plugin).

BrickletLCD128x64->get_touch_led_config()
Returns:
  • $config – Type: int, Range: See constants, Default: 3

Returns the configuration as set by set_touch_led_config()

The following constants are available for this function:

For $config:

  • BrickletLCD128x64->TOUCH_LED_CONFIG_OFF = 0
  • BrickletLCD128x64->TOUCH_LED_CONFIG_ON = 1
  • BrickletLCD128x64->TOUCH_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletLCD128x64->TOUCH_LED_CONFIG_SHOW_TOUCH = 3

New in version 2.0.2 (Plugin).

BrickletLCD128x64->get_spitfp_error_count()
Return Array:
  • 0: $error_count_ack_checksum – Type: int, Range: [0 to 232 - 1]
  • 1: $error_count_message_checksum – Type: int, Range: [0 to 232 - 1]
  • 2: $error_count_frame – Type: int, Range: [0 to 232 - 1]
  • 3: $error_count_overflow – Type: int, 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.

BrickletLCD128x64->set_status_led_config($config)
Parameters:
  • $config – Type: int, Range: See constants, Default: 3
Returns:
  • undef

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:

  • BrickletLCD128x64->STATUS_LED_CONFIG_OFF = 0
  • BrickletLCD128x64->STATUS_LED_CONFIG_ON = 1
  • BrickletLCD128x64->STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletLCD128x64->STATUS_LED_CONFIG_SHOW_STATUS = 3
BrickletLCD128x64->get_status_led_config()
Returns:
  • $config – Type: int, Range: See constants, Default: 3

Returns the configuration as set by set_status_led_config()

The following constants are available for this function:

For $config:

  • BrickletLCD128x64->STATUS_LED_CONFIG_OFF = 0
  • BrickletLCD128x64->STATUS_LED_CONFIG_ON = 1
  • BrickletLCD128x64->STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletLCD128x64->STATUS_LED_CONFIG_SHOW_STATUS = 3
BrickletLCD128x64->get_chip_temperature()
Returns:
  • $temperature – Type: int, 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.

BrickletLCD128x64->reset()
Returns:
  • undef

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!

BrickletLCD128x64->get_identity()
Return Array:
  • 0: $uid – Type: string, Length: up to 8
  • 1: $connected_uid – Type: string, Length: up to 8
  • 2: $position – Type: char, Range: ['a' to 'h', 'z']
  • 3: \@hardware_version – Type: [int, ...], Length: 3
    • 0: $major – Type: int, Range: [0 to 255]
    • 1: $minor – Type: int, Range: [0 to 255]
    • 2: $revision – Type: int, Range: [0 to 255]
  • 4: \@firmware_version – Type: [int, ...], Length: 3
    • 0: $major – Type: int, Range: [0 to 255]
    • 1: $minor – Type: int, Range: [0 to 255]
    • 2: $revision – Type: int, Range: [0 to 255]
  • 5: $device_identifier – Type: int, 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

BrickletLCD128x64->register_callback($callback_id, $function)
Parameters:
  • $callback_id – Type: int
  • $function – Type: string
Returns:
  • undef

Registers the given $function name with the given $callback_id.

The available callback IDs with corresponding function signatures are listed below.

BrickletLCD128x64->set_touch_position_callback_configuration($period, $value_has_to_change)
Parameters:
  • $period – Type: int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • $value_has_to_change – Type: bool, Default: 0
Returns:
  • undef

The period is the period with which the CALLBACK_TOUCH_POSITION 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.

BrickletLCD128x64->get_touch_position_callback_configuration()
Return Array:
  • 0: $period – Type: int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • 1: $value_has_to_change – Type: bool, Default: 0

Returns the callback configuration as set by set_touch_position_callback_configuration().

BrickletLCD128x64->set_touch_gesture_callback_configuration($period, $value_has_to_change)
Parameters:
  • $period – Type: int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • $value_has_to_change – Type: bool, Default: 0
Returns:
  • undef

The period is the period with which the CALLBACK_TOUCH_GESTURE 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.

BrickletLCD128x64->get_touch_gesture_callback_configuration()
Return Array:
  • 0: $period – Type: int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • 1: $value_has_to_change – Type: bool, Default: 0

Returns the callback configuration as set by set_touch_gesture_callback_configuration().

BrickletLCD128x64->set_gui_button_pressed_callback_configuration($period, $value_has_to_change)
Parameters:
  • $period – Type: int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • $value_has_to_change – Type: bool, Default: 0
Returns:
  • undef

The period is the period with which the CALLBACK_GUI_BUTTON_PRESSED 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).

BrickletLCD128x64->get_gui_button_pressed_callback_configuration()
Return Array:
  • 0: $period – Type: int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • 1: $value_has_to_change – Type: bool, Default: 0

Returns the callback configuration as set by set_gui_button_pressed_callback_configuration().

New in version 2.0.2 (Plugin).

BrickletLCD128x64->set_gui_slider_value_callback_configuration($period, $value_has_to_change)
Parameters:
  • $period – Type: int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • $value_has_to_change – Type: bool, Default: 0
Returns:
  • undef

The period is the period with which the CALLBACK_GUI_SLIDER_VALUE 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).

BrickletLCD128x64->get_gui_slider_value_callback_configuration()
Return Array:
  • 0: $period – Type: int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • 1: $value_has_to_change – Type: bool, Default: 0

Returns the callback configuration as set by set_gui_slider_value_callback_configuration().

New in version 2.0.2 (Plugin).

BrickletLCD128x64->set_gui_tab_selected_callback_configuration($period, $value_has_to_change)
Parameters:
  • $period – Type: int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • $value_has_to_change – Type: bool, Default: 0
Returns:
  • undef

The period is the period with which the CALLBACK_GUI_TAB_SELECTED 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).

BrickletLCD128x64->get_gui_tab_selected_callback_configuration()
Return Array:
  • 0: $period – Type: int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • 1: $value_has_to_change – Type: bool, Default: 0

Returns the callback configuration as set by set_gui_tab_selected_callback_configuration().

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 with the register_callback() function of the device object. The first parameter is the callback ID and the second parameter the callback function name:

sub my_callback
{
    print "@_[0]";
}

$lcd_128x64->register_callback(BrickletLCD128x64->CALLBACK_EXAMPLE, 'my_callback')

The callback function will be called from an internal thread of the IP Connection. In contrast to many other programming languages, variables are not automatically shared between threads in Perl. If you want to share a global variable between a callback function and the rest for your program it has to be marked as :shared. See the documentation of the threads::shared Perl module for more details.

The available constants with inherent number and type of parameters 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.

BrickletLCD128x64->CALLBACK_TOUCH_POSITION
Callback Parameters:
  • $pressure – Type: int, Range: [0 to 300]
  • $x – Type: int, Range: [0 to 127]
  • $y – Type: int, Range: [0 to 63]
  • $age – Type: int, Unit: 1 ms, Range: [0 to 232 - 1]

This callback is triggered periodically with the period that is set by set_touch_position_callback_configuration(). The parameters are the same as for get_touch_position().

BrickletLCD128x64->CALLBACK_TOUCH_GESTURE
Callback Parameters:
  • $gesture – Type: int, Range: See constants
  • $duration – Type: int, Unit: 1 ms, Range: [0 to 232 - 1]
  • $pressure_max – Type: int, Range: [0 to 300]
  • $x_start – Type: int, Range: [0 to 127]
  • $y_start – Type: int, Range: [0 to 63]
  • $x_end – Type: int, Range: [0 to 127]
  • $y_end – Type: int, Range: [0 to 63]
  • $age – Type: int, Unit: 1 ms, Range: [0 to 232 - 1]

This callback is triggered periodically with the period that is set by set_touch_gesture_callback_configuration(). The parameters are the same as for get_touch_gesture().

The following constants are available for this function:

For $gesture:

  • BrickletLCD128x64->GESTURE_LEFT_TO_RIGHT = 0
  • BrickletLCD128x64->GESTURE_RIGHT_TO_LEFT = 1
  • BrickletLCD128x64->GESTURE_TOP_TO_BOTTOM = 2
  • BrickletLCD128x64->GESTURE_BOTTOM_TO_TOP = 3
BrickletLCD128x64->CALLBACK_GUI_BUTTON_PRESSED
Callback Parameters:
  • $index – Type: int, Range: [0 to 11]
  • $pressed – Type: bool

This callback is triggered periodically with the period that is set by set_gui_button_pressed_callback_configuration(). The parameters are the same as for get_gui_button_pressed().

New in version 2.0.2 (Plugin).

BrickletLCD128x64->CALLBACK_GUI_SLIDER_VALUE
Callback Parameters:
  • $index – Type: int, Range: [0 to 5]
  • $value – Type: int, Range: [0 to 120]

This callback is triggered periodically with the period that is set by set_gui_slider_value_callback_configuration(). The parameters are the same as for get_gui_slider_value().

New in version 2.0.2 (Plugin).

BrickletLCD128x64->CALLBACK_GUI_TAB_SELECTED
Callback Parameters:
  • $index – Type: int, Range: [0 to 9]

This callback is triggered periodically with the period that is set by set_gui_tab_selected_callback_configuration(). The parameters are the same as for get_gui_tab_selected().

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.

BrickletLCD128x64->get_api_version()
Return Array:
  • 0: \@api_version – Type: [int, ...], Length: 3
    • 0: $major – Type: int, Range: [0 to 255]
    • 1: $minor – Type: int, Range: [0 to 255]
    • 2: $revision – Type: int, 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.

BrickletLCD128x64->get_response_expected($function_id)
Parameters:
  • $function_id – Type: int, Range: See constants
Returns:
  • $response_expected – Type: bool

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 set_response_expected(). 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 $function_id:

  • BrickletLCD128x64->FUNCTION_WRITE_PIXELS = 1
  • BrickletLCD128x64->FUNCTION_CLEAR_DISPLAY = 3
  • BrickletLCD128x64->FUNCTION_SET_DISPLAY_CONFIGURATION = 4
  • BrickletLCD128x64->FUNCTION_WRITE_LINE = 6
  • BrickletLCD128x64->FUNCTION_DRAW_BUFFERED_FRAME = 7
  • BrickletLCD128x64->FUNCTION_SET_TOUCH_POSITION_CALLBACK_CONFIGURATION = 9
  • BrickletLCD128x64->FUNCTION_SET_TOUCH_GESTURE_CALLBACK_CONFIGURATION = 13
  • BrickletLCD128x64->FUNCTION_DRAW_LINE = 16
  • BrickletLCD128x64->FUNCTION_DRAW_BOX = 17
  • BrickletLCD128x64->FUNCTION_DRAW_TEXT = 18
  • BrickletLCD128x64->FUNCTION_SET_GUI_BUTTON = 19
  • BrickletLCD128x64->FUNCTION_REMOVE_GUI_BUTTON = 21
  • BrickletLCD128x64->FUNCTION_SET_GUI_BUTTON_PRESSED_CALLBACK_CONFIGURATION = 22
  • BrickletLCD128x64->FUNCTION_SET_GUI_SLIDER = 26
  • BrickletLCD128x64->FUNCTION_REMOVE_GUI_SLIDER = 28
  • BrickletLCD128x64->FUNCTION_SET_GUI_SLIDER_VALUE_CALLBACK_CONFIGURATION = 29
  • BrickletLCD128x64->FUNCTION_SET_GUI_TAB_CONFIGURATION = 33
  • BrickletLCD128x64->FUNCTION_SET_GUI_TAB_TEXT = 35
  • BrickletLCD128x64->FUNCTION_SET_GUI_TAB_ICON = 37
  • BrickletLCD128x64->FUNCTION_REMOVE_GUI_TAB = 39
  • BrickletLCD128x64->FUNCTION_SET_GUI_TAB_SELECTED = 40
  • BrickletLCD128x64->FUNCTION_SET_GUI_TAB_SELECTED_CALLBACK_CONFIGURATION = 41
  • BrickletLCD128x64->FUNCTION_SET_GUI_GRAPH_CONFIGURATION = 45
  • BrickletLCD128x64->FUNCTION_SET_GUI_GRAPH_DATA = 47
  • BrickletLCD128x64->FUNCTION_REMOVE_GUI_GRAPH = 49
  • BrickletLCD128x64->FUNCTION_REMOVE_ALL_GUI = 50
  • BrickletLCD128x64->FUNCTION_SET_TOUCH_LED_CONFIG = 51
  • BrickletLCD128x64->FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletLCD128x64->FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletLCD128x64->FUNCTION_RESET = 243
  • BrickletLCD128x64->FUNCTION_WRITE_UID = 248
BrickletLCD128x64->set_response_expected($function_id, $response_expected)
Parameters:
  • $function_id – Type: int, Range: See constants
  • $response_expected – Type: bool
Returns:
  • undef

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 $function_id:

  • BrickletLCD128x64->FUNCTION_WRITE_PIXELS = 1
  • BrickletLCD128x64->FUNCTION_CLEAR_DISPLAY = 3
  • BrickletLCD128x64->FUNCTION_SET_DISPLAY_CONFIGURATION = 4
  • BrickletLCD128x64->FUNCTION_WRITE_LINE = 6
  • BrickletLCD128x64->FUNCTION_DRAW_BUFFERED_FRAME = 7
  • BrickletLCD128x64->FUNCTION_SET_TOUCH_POSITION_CALLBACK_CONFIGURATION = 9
  • BrickletLCD128x64->FUNCTION_SET_TOUCH_GESTURE_CALLBACK_CONFIGURATION = 13
  • BrickletLCD128x64->FUNCTION_DRAW_LINE = 16
  • BrickletLCD128x64->FUNCTION_DRAW_BOX = 17
  • BrickletLCD128x64->FUNCTION_DRAW_TEXT = 18
  • BrickletLCD128x64->FUNCTION_SET_GUI_BUTTON = 19
  • BrickletLCD128x64->FUNCTION_REMOVE_GUI_BUTTON = 21
  • BrickletLCD128x64->FUNCTION_SET_GUI_BUTTON_PRESSED_CALLBACK_CONFIGURATION = 22
  • BrickletLCD128x64->FUNCTION_SET_GUI_SLIDER = 26
  • BrickletLCD128x64->FUNCTION_REMOVE_GUI_SLIDER = 28
  • BrickletLCD128x64->FUNCTION_SET_GUI_SLIDER_VALUE_CALLBACK_CONFIGURATION = 29
  • BrickletLCD128x64->FUNCTION_SET_GUI_TAB_CONFIGURATION = 33
  • BrickletLCD128x64->FUNCTION_SET_GUI_TAB_TEXT = 35
  • BrickletLCD128x64->FUNCTION_SET_GUI_TAB_ICON = 37
  • BrickletLCD128x64->FUNCTION_REMOVE_GUI_TAB = 39
  • BrickletLCD128x64->FUNCTION_SET_GUI_TAB_SELECTED = 40
  • BrickletLCD128x64->FUNCTION_SET_GUI_TAB_SELECTED_CALLBACK_CONFIGURATION = 41
  • BrickletLCD128x64->FUNCTION_SET_GUI_GRAPH_CONFIGURATION = 45
  • BrickletLCD128x64->FUNCTION_SET_GUI_GRAPH_DATA = 47
  • BrickletLCD128x64->FUNCTION_REMOVE_GUI_GRAPH = 49
  • BrickletLCD128x64->FUNCTION_REMOVE_ALL_GUI = 50
  • BrickletLCD128x64->FUNCTION_SET_TOUCH_LED_CONFIG = 51
  • BrickletLCD128x64->FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletLCD128x64->FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletLCD128x64->FUNCTION_RESET = 243
  • BrickletLCD128x64->FUNCTION_WRITE_UID = 248
BrickletLCD128x64->set_response_expected_all($response_expected)
Parameters:
  • $response_expected – Type: bool
Returns:
  • undef

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.

BrickletLCD128x64->set_bootloader_mode($mode)
Parameters:
  • $mode – Type: int, Range: See constants
Returns:
  • $status – Type: int, 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:

  • BrickletLCD128x64->BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletLCD128x64->BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletLCD128x64->BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletLCD128x64->BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletLCD128x64->BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

For $status:

  • BrickletLCD128x64->BOOTLOADER_STATUS_OK = 0
  • BrickletLCD128x64->BOOTLOADER_STATUS_INVALID_MODE = 1
  • BrickletLCD128x64->BOOTLOADER_STATUS_NO_CHANGE = 2
  • BrickletLCD128x64->BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • BrickletLCD128x64->BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • BrickletLCD128x64->BOOTLOADER_STATUS_CRC_MISMATCH = 5
BrickletLCD128x64->get_bootloader_mode()
Returns:
  • $mode – Type: int, Range: See constants

Returns the current bootloader mode, see set_bootloader_mode().

The following constants are available for this function:

For $mode:

  • BrickletLCD128x64->BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletLCD128x64->BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletLCD128x64->BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletLCD128x64->BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletLCD128x64->BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
BrickletLCD128x64->set_write_firmware_pointer($pointer)
Parameters:
  • $pointer – Type: int, Unit: 1 B, Range: [0 to 232 - 1]
Returns:
  • undef

Sets the firmware pointer for write_firmware(). 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.

BrickletLCD128x64->write_firmware(\@data)
Parameters:
  • \@data – Type: [int, ...], Length: 64, Range: [0 to 255]
Returns:
  • $status – Type: int, Range: [0 to 255]

Writes 64 Bytes of firmware at the position as written by set_write_firmware_pointer() 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.

BrickletLCD128x64->write_uid($uid)
Parameters:
  • $uid – Type: int, Range: [0 to 232 - 1]
Returns:
  • undef

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.

BrickletLCD128x64->read_uid()
Returns:
  • $uid – Type: int, Range: [0 to 232 - 1]

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

Constants

BrickletLCD128x64->DEVICE_IDENTIFIER

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

The get_identity() function and the IPConnection->CALLBACK_ENUMERATE callback of the IP Connection have a device_identifier parameter to specify the Brick's or Bricklet's type.

BrickletLCD128x64->DEVICE_DISPLAY_NAME

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