PHP - LCD 128x64 Bricklet

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

Examples

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

Hello World

Download (ExampleHelloWorld.php)

 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
<?php

require_once('Tinkerforge/IPConnection.php');
require_once('Tinkerforge/BrickletLCD128x64.php');

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletLCD128x64;

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

$ipcon = new IPConnection(); // Create IP connection
$lcd = new BrickletLCD128x64(UID, $ipcon); // Create device object

$ipcon->connect(HOST, PORT); // Connect to brickd
// 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');

echo "Press key to exit\n";
fgetc(fopen('php://stdin', 'r'));
$ipcon->disconnect();

?>

Big Font

Download (ExampleBigFont.php)

 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
<?php

require_once('Tinkerforge/IPConnection.php');
require_once('Tinkerforge/BrickletLCD128x64.php');

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletLCD128x64;

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

$ipcon = new IPConnection(); // Create IP connection
$lcd = new BrickletLCD128x64(UID, $ipcon); // Create device object

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

// Clear display
$lcd->clearDisplay();

// Write "Hello World" with big 24x32 font
$lcd->drawText(0, 0, BrickletLCD128x64::FONT_24X32, BrickletLCD128x64::COLOR_BLACK,
               '24x32');

echo "Press key to exit\n";
fgetc(fopen('php://stdin', 'r'));
$ipcon->disconnect();

?>

Pixel Matrix

Download (ExamplePixelMatrix.php)

 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
<?php

require_once('Tinkerforge/IPConnection.php');
require_once('Tinkerforge/BrickletLCD128x64.php');

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletLCD128x64;

const HOST = 'localhost';
const PORT = 4223;
const UID = 'XYZ'; // Change XYZ to the UID of your LCD 128x64 Bricklet
const WIDTH = 128; // Columns
const HEIGHT = 64; // Rows

$ipcon = new IPConnection(); // Create IP connection
$lcd = new BrickletLCD128x64(UID, $ipcon); // Create device object

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

// Clear display
$lcd->clearDisplay();

// Draw checkerboard pattern
$pixels = array();

for ($y = 0; $y < HEIGHT; $y++)
{
    for ($x = 0; $x < WIDTH; $x++)
    {
        $pixels[$y*WIDTH + $x] = ($y / 8) % 2 == ($x / 8) % 2;
    }
}

$lcd->writePixels(0, 0, WIDTH-1, HEIGHT-1, $pixels);

echo "Press key to exit\n";
fgetc(fopen('php://stdin', 'r'));
$ipcon->disconnect();

?>

Touch

Download (ExampleTouch.php)

 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
<?php

require_once('Tinkerforge/IPConnection.php');
require_once('Tinkerforge/BrickletLCD128x64.php');

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletLCD128x64;

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

// Callback function for touch position callback
function cb_touchPosition($pressure, $x, $y, $age)
{
    echo "Pressure: $pressure\n";
    echo "X: $x\n";
    echo "Y: $y\n";
    echo "Age: $age\n";
    echo "\n";
}

// Callback function for touch gesture callback
function cb_touchGesture($gesture, $duration, $pressure_max, $x_start, $x_end, $y_start,
                         $y_end, $age)
{
    echo "Gesture: $gesture\n";
    echo "Duration: $duration\n";
    echo "Pressure Max: $pressure_max\n";
    echo "X Start: $x_start\n";
    echo "X End: $x_end\n";
    echo "Y Start: $y_start\n";
    echo "Y End: $y_end\n";
    echo "Age: $age\n";
    echo "\n";
}

$ipcon = new IPConnection(); // Create IP connection
$lcd = new BrickletLCD128x64(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 function cb_touchPosition
$lcd->registerCallback(BrickletLCD128x64::CALLBACK_TOUCH_POSITION, 'cb_touchPosition');

// Register touch gesture callback to function cb_touchGesture
$lcd->registerCallback(BrickletLCD128x64::CALLBACK_TOUCH_GESTURE, 'cb_touchGesture');

// 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);

echo "Press ctrl+c to exit\n";
$ipcon->dispatchCallbacks(-1); // Dispatch callbacks forever

?>

Scribble

Download (ExampleScribble.php)

 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
<?php

if (!extension_loaded('gd')) {
    echo "Required gd extension is not available\n";
    exit;
}

require_once('Tinkerforge/IPConnection.php');
require_once('Tinkerforge/BrickletLCD128x64.php');

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletLCD128x64;

const HOST = 'localhost';
const PORT = 4223;
const UID = 'XYZ'; // Change to your UID
const WIDTH = 128; // Columns
const HEIGHT = 64; // Rows

function drawImage($lcd, $startColumn, $startRow, $columnCount, $rowCount, $image)
{
    $pixels = array();

    // Convert image pixels into 8bit pages
    for ($row = 0; $row < $rowCount; $row++)
    {
        for ($column = 0; $column < $columnCount; $column++)
        {
            $index = imagecolorat($image, $column, $row);
            $color = imagecolorsforindex($image, $index);
            $pixels[$row*$columnCount + $column] = ($color['red'] + $color['green'] + $color['blue'] > 0);
        }
    }
        
    $lcd->writePixels(0, 0, WIDTH-1, HEIGHT-1, $pixels);
}

$ipcon = new IPConnection(); // Create IP connection
$lcd = new BrickletLCD128x64(UID, $ipcon); // Create device object

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

// Clear display
$lcd->clearDisplay();

// Draw rotating line
$image = imagecreate(WIDTH, HEIGHT);
$black = imagecolorallocate($image, 0, 0, 0);
$white = imagecolorallocate($image, 255, 255, 255);
$originX = WIDTH / 2;
$originY = HEIGHT / 2;
$length = HEIGHT / 2 - 2;
$angle = 0;

echo "Press ctrl+c to exit\n";

while (true)
{
    $radians = M_PI * $angle / 180.0;
    $x = (int)($originX + $length * cos($radians));
    $y = (int)($originY + $length * sin($radians));

    imagefilledrectangle($image, 0, 0, WIDTH, HEIGHT, $black);
    imageline($image, $originX, $originY, $x, $y, $white);

    drawImage($lcd, 0, 0, WIDTH, HEIGHT, $image);
    usleep(25*1000);

    $angle++;
}

?>

GUI

Download (ExampleGUI.php)

 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
<?php

require_once('Tinkerforge/IPConnection.php');
require_once('Tinkerforge/BrickletLCD128x64.php');

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletLCD128x64;

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

// Callback function for gui button pressed callback
function cb_guiButtonPressed($index, $pressed)
{
    echo "Index: $index\n";
    echo "Pressed: $pressed\n";
    echo "\n";
}

// Callback function for gui slider value callback
function cb_guiSliderValue($index, $value)
{
    echo "Index: $index\n";
    echo "Value: $value\n";
    echo "\n";
}

// Callback function for gui tab selected callback
function cb_guiTabSelected($index)
{
    echo "Index: $index\n";
}

$ipcon = new IPConnection(); // Create IP connection
$lcd = new BrickletLCD128x64(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 function cb_guiButtonPressed
$lcd->registerCallback(BrickletLCD128x64::CALLBACK_GUI_BUTTON_PRESSED,
                       'cb_guiButtonPressed');

// Register gui slider value callback to function cb_guiSliderValue
$lcd->registerCallback(BrickletLCD128x64::CALLBACK_GUI_SLIDER_VALUE, 'cb_guiSliderValue');

// Register gui tab selected callback to function cb_guiTabSelected
$lcd->registerCallback(BrickletLCD128x64::CALLBACK_GUI_TAB_SELECTED, 'cb_guiTabSelected');

// 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, BrickletLCD128x64::DIRECTION_HORIZONTAL, 50);
$lcd->setGUIGraphConfiguration(0, BrickletLCD128x64::GRAPH_TYPE_LINE, 62, 0, 60, 52, 'X',
                               'Y');

// Add a few data points (the remaining points will be 0)
$lcd->setGUIGraphData(0, array(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(BrickletLCD128x64::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);

echo "Press ctrl+c to exit\n";
$ipcon->dispatchCallbacks(-1); // Dispatch callbacks forever

?>

API

Functions that return multiple values return them in an associative array.

Basic Functions

class BrickletLCD128x64(string $uid, IPConnection $ipcon)

Creates an object with the unique device ID $uid:

<?php   $lcd_128x64 = new BrickletLCD128x64('YOUR_DEVICE_UID', $ipcon);   ?>

This object can then be used after the IP Connection is connected (see examples above).

void BrickletLCD128x64::writePixels(int $x_start, int $y_start, int $x_end, int $y_end, array $pixels)

Writes pixels to the specified window.

The x-axis goes from 0 to 127 and the y-axis from 0 to 63. 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.

array BrickletLCD128x64::readPixels(int $x_start, int $y_start, int $x_end, int $y_end)

Reads pixels from the specified window.

The x-axis goes from 0 to 127 and the y-axis from 0 to 63. 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.

void BrickletLCD128x64::clearDisplay()

Clears the complete content of the display.

void BrickletLCD128x64::writeLine(int $line, int $position, string $text)

Writes text to a specific line (0 to 7) with a specific position (0 to 21). The text can have a maximum of 22 characters.

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.

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.

void BrickletLCD128x64::drawBufferedFrame(bool $force_complete_redraw)

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.

array BrickletLCD128x64::getTouchPosition()

Returns the last valid touch position:

  • Pressure: Amount of pressure applied by the user (0-300)
  • X: Touch position on x-axis (0-127)
  • Y: Touch position on y-axis (0-63)
  • Age: Age of touch press in ms (how long ago it was)

The returned array has the keys pressure, x, y and age.

array BrickletLCD128x64::getTouchGesture()

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 in ms (how long ago it was).

The following constants are available for this function:

  • BrickletLCD128x64::GESTURE_LEFT_TO_RIGHT = 0
  • BrickletLCD128x64::GESTURE_RIGHT_TO_LEFT = 1
  • BrickletLCD128x64::GESTURE_TOP_TO_BOTTOM = 2
  • BrickletLCD128x64::GESTURE_BOTTOM_TO_TOP = 3

The returned array has the keys gesture, duration, pressure_max, x_start, y_start, x_end, y_end and age.

void BrickletLCD128x64::drawLine(int $position_x_start, int $position_y_start, int $position_x_end, int $position_y_end, bool $color)

Draws a white or black line from (x, y)-start to (x, y)-end. The x values have to be within the range of 0 to 127 and the y values have t be within the range of 0 to 63.

The following constants are available for this function:

  • BrickletLCD128x64::COLOR_WHITE = false
  • BrickletLCD128x64::COLOR_BLACK = true

New in version 2.0.2 (Plugin).

void BrickletLCD128x64::drawBox(int $position_x_start, int $position_y_start, int $position_x_end, int $position_y_end, bool $fill, bool $color)

Draws a white or black box from (x, y)-start to (x, y)-end. The x values have to be within the range of 0 to 127 and the y values have to be within the range of 0 to 63.

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:

  • BrickletLCD128x64::COLOR_WHITE = false
  • BrickletLCD128x64::COLOR_BLACK = true

New in version 2.0.2 (Plugin).

void BrickletLCD128x64::drawText(int $position_x, int $position_y, int $font, bool $color, string $text)

Draws a text with up to 22 characters at the pixel position (x, y).

The x values have to be within the range of 0 to 127 and the y values have to be within the range of 0 to 63.

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

The following constants are available for this function:

  • 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
  • BrickletLCD128x64::COLOR_WHITE = false
  • BrickletLCD128x64::COLOR_BLACK = true

New in version 2.0.2 (Plugin).

void BrickletLCD128x64::setGUIButton(int $index, int $position_x, int $position_y, int $width, int $height, string $text)

Draws a clickable button at position (x, y) with the given text of up to 16 characters.

You can use up to 12 buttons (index 0-11).

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

array BrickletLCD128x64::getGUIButton(int $index)

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

The returned array has the keys active, position_x, position_y, width, height and text.

void BrickletLCD128x64::removeGUIButton(int $index)

Removes the button with the given index.

You can use index 255 to remove all buttons.

New in version 2.0.2 (Plugin).

bool BrickletLCD128x64::getGUIButtonPressed(int $index)

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

void BrickletLCD128x64::setGUISlider(int $index, int $position_x, int $position_y, int $length, int $direction, int $value)

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

You can use up to 6 sliders (index 0-5).

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:

  • BrickletLCD128x64::DIRECTION_HORIZONTAL = 0
  • BrickletLCD128x64::DIRECTION_VERTICAL = 1

New in version 2.0.2 (Plugin).

array BrickletLCD128x64::getGUISlider(int $index)

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:

  • BrickletLCD128x64::DIRECTION_HORIZONTAL = 0
  • BrickletLCD128x64::DIRECTION_VERTICAL = 1

New in version 2.0.2 (Plugin).

The returned array has the keys active, position_x, position_y, length, direction and value.

void BrickletLCD128x64::removeGUISlider(int $index)

Removes the slider with the given index.

You can use index 255 to remove all slider.

New in version 2.0.2 (Plugin).

int BrickletLCD128x64::getGUISliderValue(int $index)

Returns the current slider value for the given index.

New in version 2.0.2 (Plugin).

void BrickletLCD128x64::setGUITabConfiguration(int $change_tab_config, bool $clear_gui)

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.

By default click and swipe as well as automatic GUI clear is enabled.

The following constants are available for this function:

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

array BrickletLCD128x64::getGUITabConfiguration()

Returns the tab configuration as set by setGUITabConfiguration().

The following constants are available for this function:

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

The returned array has the keys change_tab_config and clear_gui.

void BrickletLCD128x64::setGUITabText(int $index, string $text)

Adds a text-tab with the given index. The text can have a length of up to 5 characters.

You can use up to 10 tabs (index 0-9).

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

New in version 2.0.2 (Plugin).

array BrickletLCD128x64::getGUITabText(int $index)

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

The returned array has the keys active and text.

void BrickletLCD128x64::setGUITabIcon(int $index, array $icon)

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 (index 0-9).

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

New in version 2.0.2 (Plugin).

array BrickletLCD128x64::getGUITabIcon(int $index)

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

The returned array has the keys active and icon.

void BrickletLCD128x64::removeGUITab(int $index)

Removes the tab with the given index.

You can use index 255 to remove all tabs.

New in version 2.0.2 (Plugin).

void BrickletLCD128x64::setGUITabSelected(int $index)

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

New in version 2.0.2 (Plugin).

int BrickletLCD128x64::getGUITabSelected()

Returns the index of the currently selected tab.

New in version 2.0.2 (Plugin).

void BrickletLCD128x64::setGUIGraphConfiguration(int $index, int $graph_type, int $position_x, int $position_y, int $width, int $height, string $text_x, string $text_y)

Sets the configuration for up to four graphs (index 0-3).

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

The x and y position are pixel positions. They have to be within the range of (0, 0) to (127, 63). The maximum width is 118 and the maximum height is 63.

You can add a text for the x and y axis with at most 4 characters each. 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:

  • BrickletLCD128x64::GRAPH_TYPE_DOT = 0
  • BrickletLCD128x64::GRAPH_TYPE_LINE = 1
  • BrickletLCD128x64::GRAPH_TYPE_BAR = 2

New in version 2.0.2 (Plugin).

array BrickletLCD128x64::getGUIGraphConfiguration(int $index)

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:

  • BrickletLCD128x64::GRAPH_TYPE_DOT = 0
  • BrickletLCD128x64::GRAPH_TYPE_LINE = 1
  • BrickletLCD128x64::GRAPH_TYPE_BAR = 2

New in version 2.0.2 (Plugin).

The returned array has the keys active, graph_type, position_x, position_y, width, height, text_x and text_y.

void BrickletLCD128x64::setGUIGraphData(int $index, array $data)

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

array BrickletLCD128x64::getGUIGraphData(int $index)

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

New in version 2.0.2 (Plugin).

void BrickletLCD128x64::removeGUIGraph(int $index)

Removes the graph with the given index.

You can use index 255 to remove all graphs.

New in version 2.0.2 (Plugin).

void BrickletLCD128x64::removeAllGUI()

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

New in version 2.0.2 (Plugin).

Advanced Functions

void BrickletLCD128x64::setDisplayConfiguration(int $contrast, int $backlight, bool $invert, bool $automatic_draw)

Sets the configuration of the display.

You can set a contrast value from 0 to 63, a backlight intensity value from 0 to 100 and you can invert the color (white/black) 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().

The default values are contrast 14, backlight intensity 100, inverting off and automatic draw on.

array BrickletLCD128x64::getDisplayConfiguration()

Returns the configuration as set by setDisplayConfiguration().

The returned array has the keys contrast, backlight, invert and automatic_draw.

void BrickletLCD128x64::setTouchLEDConfig(int $config)

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:

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

int BrickletLCD128x64::getTouchLEDConfig()

Returns the configuration as set by setTouchLEDConfig()

The following constants are available for this function:

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

array BrickletLCD128x64::getAPIVersion()

Returns the version of the API definition (major, minor, revision) 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.

bool BrickletLCD128x64::getResponseExpected(int $function_id)

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 send and errors are silently ignored, because they cannot be detected.

See setResponseExpected() for the list of function ID constants available for this function.

void BrickletLCD128x64::setResponseExpected(int $function_id, bool $response_expected)

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 send and errors are silently ignored, because they cannot be detected.

The following function ID constants are available for this function:

  • 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
void BrickletLCD128x64::setResponseExpectedAll(bool $response_expected)

Changes the response expected flag for all setter and callback configuration functions of this device at once.

array BrickletLCD128x64::getSPITFPErrorCount()

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.

The returned array has the keys error_count_ack_checksum, error_count_message_checksum, error_count_frame and error_count_overflow.

int BrickletLCD128x64::setBootloaderMode(int $mode)

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:

  • 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::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
int BrickletLCD128x64::getBootloaderMode()

Returns the current bootloader mode, see setBootloaderMode().

The following constants are available for this function:

  • 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
void BrickletLCD128x64::setWriteFirmwarePointer(int $pointer)

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.

int BrickletLCD128x64::writeFirmware(array $data)

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.

void BrickletLCD128x64::setStatusLEDConfig(int $config)

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:

  • 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
int BrickletLCD128x64::getStatusLEDConfig()

Returns the configuration as set by setStatusLEDConfig()

The following constants are available for this function:

  • 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
int BrickletLCD128x64::getChipTemperature()

Returns the temperature in °C 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.

void BrickletLCD128x64::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!

void BrickletLCD128x64::writeUID(int $uid)

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.

int BrickletLCD128x64::readUID()

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

array BrickletLCD128x64::getIdentity()

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' or 'd'.

The device identifier numbers can be found here. There is also a constant for the device identifier of this Bricklet.

The returned array has the keys uid, connected_uid, position, hardware_version, firmware_version and device_identifier.

Callback Configuration Functions

void BrickletLCD128x64::registerCallback(int $callback_id, callable $callback, mixed $user_data=NULL)

Registers the given $function with the given $callback_id. The optional $user_data will be passed as the last parameter to the function.

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

void BrickletLCD128x64::setTouchPositionCallbackConfiguration(int $period, bool $value_has_to_change)

The period in ms 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.

The default value is (0, false).

array BrickletLCD128x64::getTouchPositionCallbackConfiguration()

Returns the callback configuration as set by setTouchPositionCallbackConfiguration().

The returned array has the keys period and value_has_to_change.

void BrickletLCD128x64::setTouchGestureCallbackConfiguration(int $period, bool $value_has_to_change)

The period in ms 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.

The default value is (0, false).

array BrickletLCD128x64::getTouchGestureCallbackConfiguration()

Returns the callback configuration as set by setTouchGestureCallbackConfiguration().

The returned array has the keys period and value_has_to_change.

void BrickletLCD128x64::setGUIButtonPressedCallbackConfiguration(int $period, bool $value_has_to_change)

The period in ms 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.

The default value is (0, false).

New in version 2.0.2 (Plugin).

array BrickletLCD128x64::getGUIButtonPressedCallbackConfiguration()

Returns the callback configuration as set by setGUIButtonPressedCallbackConfiguration().

New in version 2.0.2 (Plugin).

The returned array has the keys period and value_has_to_change.

void BrickletLCD128x64::setGUISliderValueCallbackConfiguration(int $period, bool $value_has_to_change)

The period in ms 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.

The default value is (0, false).

New in version 2.0.2 (Plugin).

array BrickletLCD128x64::getGUISliderValueCallbackConfiguration()

Returns the callback configuration as set by setGUISliderValueCallbackConfiguration().

New in version 2.0.2 (Plugin).

The returned array has the keys period and value_has_to_change.

void BrickletLCD128x64::setGUITabSelectedCallbackConfiguration(int $period, bool $value_has_to_change)

The period in ms 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.

The default value is (0, false).

New in version 2.0.2 (Plugin).

array BrickletLCD128x64::getGUITabSelectedCallbackConfiguration()

Returns the callback configuration as set by setGUITabSelectedCallbackConfiguration().

New in version 2.0.2 (Plugin).

The returned array has the keys period and value_has_to_change.

Callbacks

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done with the registerCallback() function of the device object. The first parameter is the callback ID and the second parameter the callback function:

<?php

function myCallback($param)
{
    echo $param . "\n";
}

$lcd_128x64->registerCallback(BrickletLCD128x64::CALLBACK_EXAMPLE, 'myCallback');

?>

The available constants with corresponding function signatures 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.

int BrickletLCD128x64::CALLBACK_TOUCH_POSITION
<?php   void callback(int $pressure, int $x, int $y, int $age [, mixed $user_data])   ?>

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

int BrickletLCD128x64::CALLBACK_TOUCH_GESTURE
<?php   void callback(int $gesture, int $duration, int $pressure_max, int $x_start, int $y_start, int $x_end, int $y_end, int $age [, mixed $user_data])   ?>

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:

  • BrickletLCD128x64::GESTURE_LEFT_TO_RIGHT = 0
  • BrickletLCD128x64::GESTURE_RIGHT_TO_LEFT = 1
  • BrickletLCD128x64::GESTURE_TOP_TO_BOTTOM = 2
  • BrickletLCD128x64::GESTURE_BOTTOM_TO_TOP = 3
int BrickletLCD128x64::CALLBACK_GUI_BUTTON_PRESSED
<?php   void callback(int $index, bool $pressed [, mixed $user_data])   ?>

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

int BrickletLCD128x64::CALLBACK_GUI_SLIDER_VALUE
<?php   void callback(int $index, int $value [, mixed $user_data])   ?>

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

int BrickletLCD128x64::CALLBACK_GUI_TAB_SELECTED
<?php   void callback(int $index [, mixed $user_data])   ?>

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

Constants

int BrickletLCD128x64::DEVICE_IDENTIFIER

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

The getIdentity() function and the CALLBACK_ENUMERATE callback of the IP Connection have a deviceIdentifier parameter to specify the Brick's or Bricklet's type.

string BrickletLCD128x64::DEVICE_DISPLAY_NAME

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