Java - LCD 128x64 Bricklet

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

Examples

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

Hello World

Download (ExampleHelloWorld.java)

 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
import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletLCD128x64;

public class ExampleHelloWorld {
    private static final String HOST = "localhost";
    private static final int PORT = 4223;

    // Change XYZ to the UID of your LCD 128x64 Bricklet
    private static final String UID = "XYZ";

    // Note: To make the example code cleaner we do not handle exceptions. Exceptions
    //       you might normally want to catch are described in the documentation
    public static void main(String args[]) throws Exception {
        IPConnection ipcon = new IPConnection(); // Create IP connection
        BrickletLCD128x64 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");

        System.out.println("Press key to exit"); System.in.read();
        ipcon.disconnect();
    }
}

Big Font

Download (ExampleBigFont.java)

 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
import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletLCD128x64;

public class ExampleBigFont {
    private static final String HOST = "localhost";
    private static final int PORT = 4223;

    // Change XYZ to the UID of your LCD 128x64 Bricklet
    private static final String UID = "XYZ";

    // Note: To make the example code cleaner we do not handle exceptions. Exceptions
    //       you might normally want to catch are described in the documentation
    public static void main(String args[]) throws Exception {
        IPConnection ipcon = new IPConnection(); // Create IP connection
        BrickletLCD128x64 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");

        System.out.println("Press key to exit"); System.in.read();
        ipcon.disconnect();
    }
}

Pixel Matrix

Download (ExamplePixelMatrix.java)

 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
import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletLCD128x64;

public class ExamplePixelMatrix {
    private static final String HOST = "localhost";
    private static final int PORT = 4223;

    // Change XYZ to the UID of your OLED 128x64 Bricklet
    private static final String UID = "XYZ";
    private static final short SCREEN_WIDTH = 128;
    private static final short SCREEN_HEIGHT = 64;

    // Note: To make the example code cleaner we do not handle exceptions. Exceptions
    //       you might normally want to catch are described in the documentation
    public static void main(String args[]) throws Exception {
        IPConnection ipcon = new IPConnection(); // Create IP connection
        BrickletLCD128x64 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
        boolean[] pixels = new boolean[SCREEN_HEIGHT * SCREEN_WIDTH];

        for (short h = 0; h < SCREEN_HEIGHT; h++) {
            for (short w = 0; w < SCREEN_WIDTH; w++) {
                pixels[h*SCREEN_WIDTH + w] = (h / 8) % 2 == (w / 8) % 2;
            }
        }

        lcd.writePixels(0, 0, SCREEN_WIDTH-1, SCREEN_HEIGHT-1, pixels);

        System.out.println("Press key to exit"); System.in.read();
        ipcon.disconnect();
    }
}

Touch

Download (ExampleTouch.java)

 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
import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletLCD128x64;

public class ExampleTouch {
    private static final String HOST = "localhost";
    private static final int PORT = 4223;

    // Change XYZ to the UID of your LCD 128x64 Bricklet
    private static final String UID = "XYZ";

    // Note: To make the example code cleaner we do not handle exceptions. Exceptions
    //       you might normally want to catch are described in the documentation
    public static void main(String args[]) throws Exception {
        IPConnection ipcon = new IPConnection(); // Create IP connection
        BrickletLCD128x64 lcd = new BrickletLCD128x64(UID, ipcon); // Create device object

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

        // Add touch position listener
        lcd.addTouchPositionListener(new BrickletLCD128x64.TouchPositionListener() {
            public void touchPosition(int pressure, int x, int y, long age) {
                System.out.println("Pressure: " + pressure);
                System.out.println("X: " + x);
                System.out.println("Y: " + y);
                System.out.println("Age: " + age);
                System.out.println("");
            }
        });

        // Add touch gesture listener
        lcd.addTouchGestureListener(new BrickletLCD128x64.TouchGestureListener() {
            public void touchGesture(int gesture, long duration, int pressureMax,
                                     int xStart, int xEnd, int yStart, int yEnd,
                                     long age) {
                System.out.println("Gesture: " + gesture);
                System.out.println("Duration: " + duration);
                System.out.println("Pressure Max: " + pressureMax);
                System.out.println("X Start: " + xStart);
                System.out.println("X End: " + xEnd);
                System.out.println("Y Start: " + yStart);
                System.out.println("Y End: " + yEnd);
                System.out.println("Age: " + age);
                System.out.println("");
            }
        });

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

        System.out.println("Press key to exit"); System.in.read();
        ipcon.disconnect();
    }
}

Scribble

Download (ExampleScribble.java)

 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
import java.awt.Color;
import java.awt.Graphics;
import java.awt.image.BufferedImage;
import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletLCD128x64;

public class ExampleScribble {
    private static final String HOST = "localhost";
    private static final int PORT = 4223;
    private static final String UID = "XYZ"; // Change to your UID
    private static final short WIDTH = 128;
    private static final short HEIGHT = 64;

    static void drawImage(BrickletLCD128x64 lcd, BufferedImage image) throws Exception {
        boolean[] pixels = new boolean[HEIGHT * WIDTH];
        short h, w;

        for (h = 0; h < HEIGHT; h++) {
            for (w = 0; w < WIDTH; w++) {
                pixels[h*WIDTH + w] = (image.getRGB(w, h) & 0x00FFFFFF) > 0;
            }
        }
        lcd.writePixels(0, 0, WIDTH-1, HEIGHT-1, pixels);
    }

    // Note: To make the example code cleaner we do not handle exceptions. Exceptions
    //       you might normally want to catch are described in the documentation
    public static void main(String args[]) throws Exception {
        IPConnection ipcon = new IPConnection(); // Create IP connection
        BrickletLCD128x64 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
        BufferedImage image = new BufferedImage(WIDTH, HEIGHT, BufferedImage.TYPE_INT_ARGB);
        int originX = WIDTH / 2;
        int originY = HEIGHT / 2;
        int length = HEIGHT / 2 - 2;
        int angle = 0;

        System.out.println("Press ctrl+c to exit");

        while (true) {
            double radians = Math.toRadians(angle);
            int x = (int)(originX + length * Math.cos(radians));
            int y = (int)(originY + length * Math.sin(radians));
            Graphics g = image.createGraphics();

            g.setColor(Color.black);
            g.fillRect(0, 0, WIDTH, HEIGHT);
            g.setColor(Color.white);
            g.drawLine(originX, originY, x, y);
            g.dispose();

            drawImage(lcd, image);
            Thread.sleep(25);

            angle++;
        }
    }
}

GUI

Download (ExampleGUI.java)

 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
import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletLCD128x64;

public class ExampleGUI {
    private static final String HOST = "localhost";
    private static final int PORT = 4223;

    // Change XYZ to the UID of your LCD 128x64 Bricklet
    private static final String UID = "XYZ";

    // Note: To make the example code cleaner we do not handle exceptions. Exceptions
    //       you might normally want to catch are described in the documentation
    public static void main(String args[]) throws Exception {
        IPConnection ipcon = new IPConnection(); // Create IP connection
        BrickletLCD128x64 lcd = new BrickletLCD128x64(UID, ipcon); // Create device object

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

        // Add gui button pressed listener
        lcd.addGUIButtonPressedListener(new BrickletLCD128x64.GUIButtonPressedListener() {
            public void guiButtonPressed(int index, boolean pressed) {
                System.out.println("Index: " + index);
                System.out.println("Pressed: " + pressed);
                System.out.println("");
            }
        });

        // Add gui slider value listener
        lcd.addGUISliderValueListener(new BrickletLCD128x64.GUISliderValueListener() {
            public void guiSliderValue(int index, int value) {
                System.out.println("Index: " + index);
                System.out.println("Value: " + value);
                System.out.println("");
            }
        });

        // Add gui tab selected listener
        lcd.addGUITabSelectedListener(new BrickletLCD128x64.GUITabSelectedListener() {
            public void guiTabSelected(int index) {
                System.out.println("Index: " + index);
            }
        });

        // 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,
                            new int[]{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);

        System.out.println("Press key to exit"); System.in.read();
        ipcon.disconnect();
    }
}

API

Generally, every method of the Java bindings that returns a value can throw a TimeoutException. This exception gets thrown if the device did not respond. If a cable based connection is used, it is unlikely that this exception gets thrown (assuming nobody unplugs the device). However, if a wireless connection is used, timeouts will occur if the distance to the device gets too big.

Beside the TimeoutException there is also a NotConnectedException that is thrown if a method needs to communicate with the device while the IP Connection is not connected.

Since Java does not support multiple return values and return by reference is not possible for primitive types, we use small classes that only consist of member variables. The member variables of the returned objects are described in the corresponding method descriptions.

The package for all Brick/Bricklet bindings and the IP Connection is com.tinkerforge.*

All methods listed below are thread-safe.

Basic Functions

public class BrickletLCD128x64(String uid, IPConnection ipcon)

Creates an object with the unique device ID uid:

BrickletLCD128x64 lcd128x64 = new BrickletLCD128x64("YOUR_DEVICE_UID", ipcon);

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

public void writePixels(int xStart, int yStart, int xEnd, int yEnd, boolean[] 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.

public boolean[] readPixels(int xStart, int yStart, int xEnd, int yEnd)

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.

public void clearDisplay()

Clears the complete content of the display.

public void 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.

public void drawBufferedFrame(boolean forceCompleteRedraw)

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.

public BrickletLCD128x64.TouchPosition 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 object has the public member variables int pressure, int x, int y and long age.

public BrickletLCD128x64.TouchGesture 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 object has the public member variables int gesture, long duration, int pressureMax, int xStart, int yStart, int xEnd, int yEnd and long age.

public void drawLine(int positionXStart, int positionYStart, int positionXEnd, int positionYEnd, boolean 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).

public void drawBox(int positionXStart, int positionYStart, int positionXEnd, int positionYEnd, boolean fill, boolean 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).

public void drawText(int positionX, int positionY, int font, boolean 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).

public void setGUIButton(int index, int positionX, int positionY, 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 listener for a button press with setGUIButtonPressedCallbackConfiguration(). The listener 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).

public BrickletLCD128x64.GUIButton 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 object has the public member variables boolean active, int positionX, int positionY, int width, int height and String text.

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

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

public void setGUISlider(int index, int positionX, int positionY, 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 listener 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).

public BrickletLCD128x64.GUISlider 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 object has the public member variables boolean active, int positionX, int positionY, int length, int direction and int value.

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

public int getGUISliderValue(int index)

Returns the current slider value for the given index.

New in version 2.0.2 (Plugin).

public void setGUITabConfiguration(int changeTabConfig, boolean clearGUI)

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

public BrickletLCD128x64.GUITabConfiguration 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 object has the public member variables int changeTabConfig and boolean clearGUI.

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

public BrickletLCD128x64.GUITabText 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 object has the public member variables boolean active and String text.

public void setGUITabIcon(int index, boolean[] 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).

public BrickletLCD128x64.GUITabIcon 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 object has the public member variables boolean active and boolean[] icon.

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

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

public int getGUITabSelected()

Returns the index of the currently selected tab.

New in version 2.0.2 (Plugin).

public void setGUIGraphConfiguration(int index, int graphType, int positionX, int positionY, int width, int height, String textX, String textY)

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

public BrickletLCD128x64.GUIGraphConfiguration 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 object has the public member variables boolean active, int graphType, int positionX, int positionY, int width, int height, String textX and String textY.

public void setGUIGraphData(int index, int[] 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).

public int[] getGUIGraphData(int index)

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

New in version 2.0.2 (Plugin).

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

public void removeAllGUI()

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

New in version 2.0.2 (Plugin).

Advanced Functions

public void setDisplayConfiguration(int contrast, int backlight, boolean invert, boolean automaticDraw)

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.

public BrickletLCD128x64.DisplayConfiguration getDisplayConfiguration()

Returns the configuration as set by setDisplayConfiguration().

The returned object has the public member variables int contrast, int backlight, boolean invert and boolean automaticDraw.

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

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

public int[] 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.

public boolean getResponseExpected(int functionId)

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

public void setResponseExpected(int functionId, boolean responseExpected)

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 listener 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
public void setResponseExpectedAll(boolean responseExpected)

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

public BrickletLCD128x64.SPITFPErrorCount 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 object has the public member variables long errorCountAckChecksum, long errorCountMessageChecksum, long errorCountFrame and long errorCountOverflow.

public int 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
public int 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
public void setWriteFirmwarePointer(long 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.

public int writeFirmware(int[] 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.

public void 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
public int 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
public int 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.

public void 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!

public void writeUID(long 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.

public long readUID()

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

public BrickletLCD128x64.Identity 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 object has the public member variables String uid, String connectedUid, char position, int[] hardwareVersion, int[] firmwareVersion and int deviceIdentifier.

Listener Configuration Functions

public void setTouchPositionCallbackConfiguration(long period, boolean valueHasToChange)

The period in ms is the period with which the TouchPositionListener listener is triggered periodically. A value of 0 turns the listener off.

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

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

The default value is (0, false).

public BrickletLCD128x64.TouchPositionCallbackConfiguration getTouchPositionCallbackConfiguration()

Returns the listener configuration as set by setTouchPositionCallbackConfiguration().

The returned object has the public member variables long period and boolean valueHasToChange.

public void setTouchGestureCallbackConfiguration(long period, boolean valueHasToChange)

The period in ms is the period with which the TouchGestureListener listener is triggered periodically. A value of 0 turns the listener off.

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

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

The default value is (0, false).

public BrickletLCD128x64.TouchGestureCallbackConfiguration getTouchGestureCallbackConfiguration()

Returns the listener configuration as set by setTouchGestureCallbackConfiguration().

The returned object has the public member variables long period and boolean valueHasToChange.

public void setGUIButtonPressedCallbackConfiguration(long period, boolean valueHasToChange)

The period in ms is the period with which the GUIButtonPressedListener listener is triggered periodically. A value of 0 turns the listener off.

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

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

The default value is (0, false).

New in version 2.0.2 (Plugin).

public BrickletLCD128x64.GUIButtonPressedCallbackConfiguration getGUIButtonPressedCallbackConfiguration()

Returns the listener configuration as set by setGUIButtonPressedCallbackConfiguration().

New in version 2.0.2 (Plugin).

The returned object has the public member variables long period and boolean valueHasToChange.

public void setGUISliderValueCallbackConfiguration(long period, boolean valueHasToChange)

The period in ms is the period with which the GUISliderValueListener listener is triggered periodically. A value of 0 turns the listener off.

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

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

The default value is (0, false).

New in version 2.0.2 (Plugin).

public BrickletLCD128x64.GUISliderValueCallbackConfiguration getGUISliderValueCallbackConfiguration()

Returns the listener configuration as set by setGUISliderValueCallbackConfiguration().

New in version 2.0.2 (Plugin).

The returned object has the public member variables long period and boolean valueHasToChange.

public void setGUITabSelectedCallbackConfiguration(long period, boolean valueHasToChange)

The period in ms is the period with which the GUITabSelectedListener listener is triggered periodically. A value of 0 turns the listener off.

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

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

The default value is (0, false).

New in version 2.0.2 (Plugin).

public BrickletLCD128x64.GUITabSelectedCallbackConfiguration getGUITabSelectedCallbackConfiguration()

Returns the listener configuration as set by setGUITabSelectedCallbackConfiguration().

New in version 2.0.2 (Plugin).

The returned object has the public member variables long period and boolean valueHasToChange.

Listeners

Listeners can be registered to receive time critical or recurring data from the device. The registration is done with "add*Listener" functions of the device object.

The parameter is a listener class object, for example:

device.addExampleListener(new BrickletLCD128x64.ExampleListener() {
    public void property(int value) {
        System.out.println("Value: " + value);
    }
});

The available listener classes with inherent methods to be overwritten are described below. It is possible to add several listeners and to remove them with the corresponding "remove*Listener" function.

Note

Using listeners 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.

public class BrickletLCD128x64.TouchPositionListener()

This listener can be added with the addTouchPositionListener() function. An added listener can be removed with the removeTouchPositionListener() function.

public void touchPosition(int pressure, int x, int y, long age)

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

public class BrickletLCD128x64.TouchGestureListener()

This listener can be added with the addTouchGestureListener() function. An added listener can be removed with the removeTouchGestureListener() function.

public void touchGesture(int gesture, long duration, int pressureMax, int xStart, int yStart, int xEnd, int yEnd, long age)

This listener 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
public class BrickletLCD128x64.GUIButtonPressedListener()

This listener can be added with the addGUIButtonPressedListener() function. An added listener can be removed with the removeGUIButtonPressedListener() function.

public void guiButtonPressed(int index, boolean pressed)

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

public class BrickletLCD128x64.GUISliderValueListener()

This listener can be added with the addGUISliderValueListener() function. An added listener can be removed with the removeGUISliderValueListener() function.

public void guiSliderValue(int index, int value)

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

public class BrickletLCD128x64.GUITabSelectedListener()

This listener can be added with the addGUITabSelectedListener() function. An added listener can be removed with the removeGUITabSelectedListener() function.

public void guiTabSelected(int index)

This listener 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

public static final int BrickletLCD128x64.DEVICE_IDENTIFIER

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

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

public static final String BrickletLCD128x64.DEVICE_DISPLAY_NAME

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