Shell - LCD 128x64 Bricklet

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

Examples

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

Big Font

Download (example-big-font.sh)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
#!/bin/sh
# Connects to localhost:4223 by default, use --host and --port to change this

uid=XYZ # Change XYZ to the UID of your LCD 128x64 Bricklet

# Clear display
tinkerforge call lcd-128x64-bricklet $uid clear-display

# Write "Hello World" with big 24x32 font
tinkerforge call lcd-128x64-bricklet $uid draw-text 0 0 font-24x32 color-black "24x32"

Hello World

Download (example-hello-world.sh)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
#!/bin/sh
# Connects to localhost:4223 by default, use --host and --port to change this

uid=XYZ # Change XYZ to the UID of your LCD 128x64 Bricklet

# Clear display
tinkerforge call lcd-128x64-bricklet $uid clear-display

# Write "Hello World" starting from upper left corner of the screen
tinkerforge call lcd-128x64-bricklet $uid write-line 0 0 "Hello World"

Touch

Download (example-touch.sh)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
#!/bin/sh
# Connects to localhost:4223 by default, use --host and --port to change this

uid=XYZ # Change XYZ to the UID of your LCD 128x64 Bricklet

# Handle incoming touch position callbacks
tinkerforge dispatch lcd-128x64-bricklet $uid touch-position &

# Handle incoming touch gesture callbacks
tinkerforge dispatch lcd-128x64-bricklet $uid touch-gesture &

# Set period for touch position callback to 0.1s (100ms)
tinkerforge call lcd-128x64-bricklet $uid set-touch-position-callback-configuration 100 true

# Set period for touch gesture callback to 0.1s (100ms)
tinkerforge call lcd-128x64-bricklet $uid set-touch-gesture-callback-configuration 100 true

echo "Press key to exit"; read dummy

kill -- -$$ # Stop callback dispatch in background

Pixel Matrix

Download (example-pixel-matrix.sh)

 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
#!/bin/bash
# Connects to localhost:4223 by default, use --host and --port to change this

# This example requires Bash 4

uid=XYZ # Change XYZ to the UID of your LCD 128x64 Bricklet

SCREEN_WIDTH=128
SCREEN_HEIGHT=64

# Clear display
tinkerforge call lcd-128x64-bricklet $uid clear-display

# Draw checkerboard pattern
pixels=""

for ((h=0;h<${SCREEN_HEIGHT};h++))
do
    for ((w=0;w<${SCREEN_WIDTH};w++))
    do
        if [ $((((${h}/8))%2==((${w}/8))%2)) -gt 0  ]; then
            pixels+="true,"
        else
            pixels+="false,"
        fi  
    done
done
    
w=`expr $SCREEN_WIDTH - 1`
h=`expr $SCREEN_HEIGHT - 1`
tinkerforge call lcd-128x64-bricklet ${uid} write-pixels 0 0 $w $h ${pixels::-1}

Gui

Download (example-gui.sh)

 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
#!/bin/sh
# Connects to localhost:4223 by default, use --host and --port to change this

uid=XYZ # Change XYZ to the UID of your LCD 128x64 Bricklet

# Handle incoming GUI button pressed callbacks
tinkerforge dispatch lcd-128x64-bricklet $uid gui-button-pressed &

# Handle incoming GUI slider value callbacks
tinkerforge dispatch lcd-128x64-bricklet $uid gui-slider-value &

# Handle incoming GUI tab selected callbacks
tinkerforge dispatch lcd-128x64-bricklet $uid gui-tab-selected &

# Clear display
tinkerforge call lcd-128x64-bricklet $uid clear-display
tinkerforge call lcd-128x64-bricklet $uid remove-all-gui

# Add GUI elements: Button, Slider and Graph with 60 data points
tinkerforge call lcd-128x64-bricklet $uid set-gui-button 0 0 0 60 20 "button"
tinkerforge call lcd-128x64-bricklet $uid set-gui-slider 0 0 30 60 direction-horizontal 50
tinkerforge call lcd-128x64-bricklet $uid set-gui-graph-configuration 0 graph-type-line 62 0 60 52 "X" "Y"

# Add a few data points (the remaining points will be 0)
tinkerforge call lcd-128x64-bricklet $uid set-gui-graph-data 0 20,40,60,80,100,120,140,160,180,200,220,240

# Add 5 text tabs without and configure it for click and swipe without auto-redraw
tinkerforge call lcd-128x64-bricklet $uid set-gui-tab-configuration change-tab-on-click-and-swipe false
tinkerforge call lcd-128x64-bricklet $uid set-gui-tab-text 0 "Tab A"
tinkerforge call lcd-128x64-bricklet $uid set-gui-tab-text 1 "Tab B"
tinkerforge call lcd-128x64-bricklet $uid set-gui-tab-text 2 "Tab C"
tinkerforge call lcd-128x64-bricklet $uid set-gui-tab-text 3 "Tab D"
tinkerforge call lcd-128x64-bricklet $uid set-gui-tab-text 4 "Tab E"

# Set period for GUI button pressed callback to 0.1s (100ms)
tinkerforge call lcd-128x64-bricklet $uid set-gui-button-pressed-callback-configuration 100 true

# Set period for GUI slider value callback to 0.1s (100ms)
tinkerforge call lcd-128x64-bricklet $uid set-gui-slider-value-callback-configuration 100 true

# Set period for GUI tab selected callback to 0.1s (100ms)
tinkerforge call lcd-128x64-bricklet $uid set-gui-tab-selected-callback-configuration 100 true

echo "Press key to exit"; read dummy

kill -- -$$ # Stop callback dispatch in background

API

Possible exit codes for all tinkerforge commands are:

  • 1: interrupted (ctrl+c)
  • 2: syntax error
  • 21: Python 2.5 or newer is required
  • 22: Python argparse module is missing
  • 23: socket error
  • 24: other exception
  • 25: invalid placeholder in format string
  • 26: authentication error
  • 201: timeout occurred
  • 209: invalid argument value
  • 210: function is not supported
  • 211: unknown error

Command Structure

The common options of the call and dispatch commands are documented here. The specific command structure is shown below.

tinkerforge call lcd-128x64-bricklet [<option>..] <uid> <function> [<argument>..]
Parameters:
  • <uid> – Type: String
  • <function> – Type: String

The call command is used to call a function of the LCD 128x64 Bricklet. It can take several options:

  • --help shows help for the specific call command and exits
  • --list-functions shows a list of known functions of the LCD 128x64 Bricklet and exits
tinkerforge dispatch lcd-128x64-bricklet [<option>..] <uid> <callback>
Parameters:
  • <uid> – Type: String
  • <callback> – Type: String

The dispatch command is used to dispatch a callback of the LCD 128x64 Bricklet. It can take several options:

  • --help shows help for the specific dispatch command and exits
  • --list-callbacks shows a list of known callbacks of the LCD 128x64 Bricklet and exits
tinkerforge call lcd-128x64-bricklet <uid> <function> [<option>..] [<argument>..]
Parameters:
  • <uid> – Type: String
  • <function> – Type: String

The <function> to be called can take different options depending of its kind. All functions can take the following options:

  • --help shows help for the specific function and exits

Getter functions can take the following options:

  • --execute <command> shell command line to execute for each incoming response (see section about output formatting for details)

Setter functions can take the following options:

  • --expect-response requests response and waits for it

The --expect-response option for setter functions allows to detect timeouts and other error conditions calls of setters as well. The device will then send a response for this purpose. If this option is not given for a setter function then no response is send and errors are silently ignored, because they cannot be detected.

tinkerforge dispatch lcd-128x64-bricklet <uid> <callback> [<option>..]
Parameters:
  • <uid> – Type: String
  • <callback> – Type: String

The <callback> to be dispatched can take several options:

  • --help shows help for the specific callback and exits
  • --execute <command> shell command line to execute for each incoming response (see section about output formatting for details)

Basic Functions

tinkerforge call lcd-128x64-bricklet <uid> write-pixels <x-start> <y-start> <x-end> <y-end> <pixels>
Parameters:
  • <x-start> – Type: Int, Range: [0 to 127]
  • <y-start> – Type: Int, Range: [0 to 63]
  • <x-end> – Type: Int, Range: [0 to 127]
  • <y-end> – Type: Int, Range: [0 to 63]
  • <pixels> – Type: Bool Array, Length: variable
Output:
  • no output

Writes pixels to the specified window.

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

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

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

Automatic draw can be configured with the set-display-configuration function.

tinkerforge call lcd-128x64-bricklet <uid> read-pixels <x-start> <y-start> <x-end> <y-end>
Parameters:
  • <x-start> – Type: Int, Range: [0 to 127]
  • <y-start> – Type: Int, Range: [0 to 63]
  • <x-end> – Type: Int, Range: [0 to 127]
  • <y-end> – Type: Int, Range: [0 to 63]
Output:
  • pixels – Type: Bool Array, Length: variable

Reads pixels from the specified window.

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

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

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

Automatic draw can be configured with the set-display-configuration function.

tinkerforge call lcd-128x64-bricklet <uid> clear-display
Output:
  • no output

Clears the complete content of the display.

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

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

Automatic draw can be configured with the set-display-configuration function.

tinkerforge call lcd-128x64-bricklet <uid> write-line <line> <position> <text>
Parameters:
  • <line> – Type: Int, Range: [0 to 7]
  • <position> – Type: Int, Range: [0 to 21]
  • <text> – Type: String, Length: up to 22
Output:
  • no output

Writes text to a specific line with a specific position.

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

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

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

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

Automatic draw can be configured with the set-display-configuration function.

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

tinkerforge call lcd-128x64-bricklet <uid> draw-buffered-frame <force-complete-redraw>
Parameters:
  • <force-complete-redraw> – Type: Bool
Output:
  • no output

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

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

tinkerforge call lcd-128x64-bricklet <uid> get-touch-position
Output:
  • pressure – Type: Int, Range: [0 to 300]
  • x – Type: Int, Range: [0 to 127]
  • y – Type: Int, Range: [0 to 63]
  • age – Type: Int, Unit: 1 ms, Range: [0 to 232 - 1]

Returns the last valid touch position:

  • Pressure: Amount of pressure applied by the user
  • X: Touch position on x-axis
  • Y: Touch position on y-axis
  • Age: Age of touch press (how long ago it was)
tinkerforge call lcd-128x64-bricklet <uid> get-touch-gesture
Output:
  • gesture – Type: Int, Range: See symbols
  • duration – Type: Int, Unit: 1 ms, Range: [0 to 232 - 1]
  • pressure-max – Type: Int, Range: [0 to 300]
  • x-start – Type: Int, Range: [0 to 127]
  • y-start – Type: Int, Range: [0 to 63]
  • x-end – Type: Int, Range: [0 to 127]
  • y-end – Type: Int, Range: [0 to 63]
  • age – Type: Int, Unit: 1 ms, Range: [0 to 232 - 1]

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

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

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

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

The following symbols are available for this function:

For gesture:

  • gesture-left-to-right = 0
  • gesture-right-to-left = 1
  • gesture-top-to-bottom = 2
  • gesture-bottom-to-top = 3
tinkerforge call lcd-128x64-bricklet <uid> draw-line <position-x-start> <position-y-start> <position-x-end> <position-y-end> <color>
Parameters:
  • <position-x-start> – Type: Int, Range: [0 to 127]
  • <position-y-start> – Type: Int, Range: [0 to 63]
  • <position-x-end> – Type: Int, Range: [0 to 127]
  • <position-y-end> – Type: Int, Range: [0 to 63]
  • <color> – Type: Bool
Output:
  • no output

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

The following symbols are available for this function:

For <color>:

  • color-white = false
  • color-black = true

New in version 2.0.2 (Plugin).

tinkerforge call lcd-128x64-bricklet <uid> draw-box <position-x-start> <position-y-start> <position-x-end> <position-y-end> <fill> <color>
Parameters:
  • <position-x-start> – Type: Int, Range: [0 to 127]
  • <position-y-start> – Type: Int, Range: [0 to 63]
  • <position-x-end> – Type: Int, Range: [0 to 127]
  • <position-y-end> – Type: Int, Range: [0 to 63]
  • <fill> – Type: Bool
  • <color> – Type: Bool
Output:
  • no output

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

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

The following symbols are available for this function:

For <color>:

  • color-white = false
  • color-black = true

New in version 2.0.2 (Plugin).

tinkerforge call lcd-128x64-bricklet <uid> draw-text <position-x> <position-y> <font> <color> <text>
Parameters:
  • <position-x> – Type: Int, Range: [0 to 127]
  • <position-y> – Type: Int, Range: [0 to 63]
  • <font> – Type: Int, Range: See symbols
  • <color> – Type: Bool
  • <text> – Type: String, Length: up to 22
Output:
  • no output

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

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

The following symbols are available for this function:

For <font>:

  • font-6x8 = 0
  • font-6x16 = 1
  • font-6x24 = 2
  • font-6x32 = 3
  • font-12x16 = 4
  • font-12x24 = 5
  • font-12x32 = 6
  • font-18x24 = 7
  • font-18x32 = 8
  • font-24x32 = 9

For <color>:

  • color-white = false
  • color-black = true

New in version 2.0.2 (Plugin).

tinkerforge call lcd-128x64-bricklet <uid> set-gui-button <index> <position-x> <position-y> <width> <height> <text>
Parameters:
  • <index> – Type: Int, Range: [0 to 11]
  • <position-x> – Type: Int, Range: [0 to 127]
  • <position-y> – Type: Int, Range: [0 to 63]
  • <width> – Type: Int, Range: [1 to 128]
  • <height> – Type: Int, Range: [1 to 64]
  • <text> – Type: String, Length: up to 16
Output:
  • no output

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

You can use up to 12 buttons.

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

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

You can enable a callback for a button press with set-gui-button-pressed-callback-configuration. The callback will be triggered for press and release-events.

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

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

New in version 2.0.2 (Plugin).

tinkerforge call lcd-128x64-bricklet <uid> get-gui-button <index>
Parameters:
  • <index> – Type: Int, Range: [0 to 11]
Output:
  • active – Type: Bool
  • position-x – Type: Int, Range: [0 to 127]
  • position-y – Type: Int, Range: [0 to 63]
  • width – Type: Int, Range: [1 to 128]
  • height – Type: Int, Range: [1 to 64]
  • text – Type: String, Length: up to 16

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

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

New in version 2.0.2 (Plugin).

tinkerforge call lcd-128x64-bricklet <uid> remove-gui-button <index>
Parameters:
  • <index> – Type: Int, Range: [0 to 11, 255]
Output:
  • no output

Removes the button with the given index.

You can use index 255 to remove all buttons.

New in version 2.0.2 (Plugin).

tinkerforge call lcd-128x64-bricklet <uid> get-gui-button-pressed <index>
Parameters:
  • <index> – Type: Int, Range: [0 to 11]
Output:
  • pressed – Type: Bool

Returns the state of the button for the given index.

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

New in version 2.0.2 (Plugin).

tinkerforge call lcd-128x64-bricklet <uid> set-gui-slider <index> <position-x> <position-y> <length> <direction> <value>
Parameters:
  • <index> – Type: Int, Range: [0 to 5]
  • <position-x> – Type: Int, Range: [0 to 128]
  • <position-y> – Type: Int, Range: [0 to 64]
  • <length> – Type: Int, Range: [8 to 128]
  • <direction> – Type: Int, Range: See symbols
  • <value> – Type: Int, Range: [0 to 120]
Output:
  • no output

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

You can use up to 6 sliders.

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

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

The minimum length of a slider is 8.

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

You can enable a callback for the slider value with set-gui-slider-value-callback-configuration.

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

The following symbols are available for this function:

For <direction>:

  • direction-horizontal = 0
  • direction-vertical = 1

New in version 2.0.2 (Plugin).

tinkerforge call lcd-128x64-bricklet <uid> get-gui-slider <index>
Parameters:
  • <index> – Type: Int, Range: [0 to 5]
Output:
  • active – Type: Bool
  • position-x – Type: Int, Range: [0 to 128]
  • position-y – Type: Int, Range: [0 to 64]
  • length – Type: Int, Range: [8 to 128]
  • direction – Type: Int, Range: See symbols
  • value – Type: Int, Range: [0 to 120]

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

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

The following symbols are available for this function:

For direction:

  • direction-horizontal = 0
  • direction-vertical = 1

New in version 2.0.2 (Plugin).

tinkerforge call lcd-128x64-bricklet <uid> remove-gui-slider <index>
Parameters:
  • <index> – Type: Int, Range: [0 to 5, 255]
Output:
  • no output

Removes the slider with the given index.

You can use index 255 to remove all slider.

New in version 2.0.2 (Plugin).

tinkerforge call lcd-128x64-bricklet <uid> get-gui-slider-value <index>
Parameters:
  • <index> – Type: Int, Range: [0 to 5]
Output:
  • value – Type: Int, Range: [0 to 120]

Returns the current slider value for the given index.

New in version 2.0.2 (Plugin).

tinkerforge call lcd-128x64-bricklet <uid> set-gui-tab-configuration <change-tab-config> <clear-gui>
Parameters:
  • <change-tab-config> – Type: Int, Range: See symbols, Default: 3
  • <clear-gui> – Type: Bool, Default: true
Output:
  • no output

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

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

The following symbols are available for this function:

For <change-tab-config>:

  • change-tab-on-click = 1
  • change-tab-on-swipe = 2
  • change-tab-on-click-and-swipe = 3

New in version 2.0.2 (Plugin).

tinkerforge call lcd-128x64-bricklet <uid> get-gui-tab-configuration
Output:
  • change-tab-config – Type: Int, Range: See symbols, Default: 3
  • clear-gui – Type: Bool, Default: true

Returns the tab configuration as set by set-gui-tab-configuration.

The following symbols are available for this function:

For change-tab-config:

  • change-tab-on-click = 1
  • change-tab-on-swipe = 2
  • change-tab-on-click-and-swipe = 3

New in version 2.0.2 (Plugin).

tinkerforge call lcd-128x64-bricklet <uid> set-gui-tab-text <index> <text>
Parameters:
  • <index> – Type: Int, Range: [0 to 9]
  • <text> – Type: String, Length: up to 5
Output:
  • no output

Adds a text-tab with the given index.

You can use up to 10 tabs.

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

New in version 2.0.2 (Plugin).

tinkerforge call lcd-128x64-bricklet <uid> get-gui-tab-text <index>
Parameters:
  • <index> – Type: Int, Range: [0 to 9]
Output:
  • active – Type: Bool
  • text – Type: String, Length: up to 5

Returns the text for a given index as set by set-gui-tab-text.

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

New in version 2.0.2 (Plugin).

tinkerforge call lcd-128x64-bricklet <uid> set-gui-tab-icon <index> <icon>
Parameters:
  • <index> – Type: Int, Range: [0 to 9]
  • <icon> – Type: Bool Array, Length: 168
Output:
  • no output

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

You can use up to 10 tabs.

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

New in version 2.0.2 (Plugin).

tinkerforge call lcd-128x64-bricklet <uid> get-gui-tab-icon <index>
Parameters:
  • <index> – Type: Int, Range: [0 to 9]
Output:
  • active – Type: Bool
  • icon – Type: Bool Array, Length: 168

Returns the icon for a given index as set by set-gui-tab-icon.

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

New in version 2.0.2 (Plugin).

tinkerforge call lcd-128x64-bricklet <uid> remove-gui-tab <index>
Parameters:
  • <index> – Type: Int, Range: [0 to 9, 255]
Output:
  • no output

Removes the tab with the given index.

You can use index 255 to remove all tabs.

New in version 2.0.2 (Plugin).

tinkerforge call lcd-128x64-bricklet <uid> set-gui-tab-selected <index>
Parameters:
  • <index> – Type: Int, Range: [0 to 9]
Output:
  • no output

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

New in version 2.0.2 (Plugin).

tinkerforge call lcd-128x64-bricklet <uid> get-gui-tab-selected
Output:
  • index – Type: Int, Range: [-1 to 9]

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

New in version 2.0.2 (Plugin).

tinkerforge call lcd-128x64-bricklet <uid> set-gui-graph-configuration <index> <graph-type> <position-x> <position-y> <width> <height> <text-x> <text-y>
Parameters:
  • <index> – Type: Int, Range: [0 to 3]
  • <graph-type> – Type: Int, Range: See symbols
  • <position-x> – Type: Int, Range: [0 to 127]
  • <position-y> – Type: Int, Range: [0 to 63]
  • <width> – Type: Int, Range: [0 to 118]
  • <height> – Type: Int, Range: [0 to 63]
  • <text-x> – Type: String, Length: up to 4
  • <text-y> – Type: String, Length: up to 4
Output:
  • no output

Sets the configuration for up to four graphs.

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

The x and y position are pixel positions.

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

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

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

The following symbols are available for this function:

For <graph-type>:

  • graph-type-dot = 0
  • graph-type-line = 1
  • graph-type-bar = 2

New in version 2.0.2 (Plugin).

tinkerforge call lcd-128x64-bricklet <uid> get-gui-graph-configuration <index>
Parameters:
  • <index> – Type: Int, Range: [0 to 3]
Output:
  • active – Type: Bool
  • graph-type – Type: Int, Range: See symbols
  • position-x – Type: Int, Range: [0 to 127]
  • position-y – Type: Int, Range: [0 to 63]
  • width – Type: Int, Range: [0 to 118]
  • height – Type: Int, Range: [0 to 63]
  • text-x – Type: String, Length: up to 4
  • text-y – Type: String, Length: up to 4

Returns the graph properties for a given Index as set by set-gui-graph-configuration.

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

The following symbols are available for this function:

For graph-type:

  • graph-type-dot = 0
  • graph-type-line = 1
  • graph-type-bar = 2

New in version 2.0.2 (Plugin).

tinkerforge call lcd-128x64-bricklet <uid> set-gui-graph-data <index> <data>
Parameters:
  • <index> – Type: Int, Range: [0 to 3]
  • <data> – Type: Int Array, Length: variable, Range: [0 to 255]
Output:
  • no output

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

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

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

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

New in version 2.0.2 (Plugin).

tinkerforge call lcd-128x64-bricklet <uid> get-gui-graph-data <index>
Parameters:
  • <index> – Type: Int, Range: [0 to 3]
Output:
  • data – Type: Int Array, Length: variable, Range: [0 to 255]

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

New in version 2.0.2 (Plugin).

tinkerforge call lcd-128x64-bricklet <uid> remove-gui-graph <index>
Parameters:
  • <index> – Type: Int, Range: [0 to 3, 255]
Output:
  • no output

Removes the graph with the given index.

You can use index 255 to remove all graphs.

New in version 2.0.2 (Plugin).

tinkerforge call lcd-128x64-bricklet <uid> remove-all-gui
Output:
  • no output

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

New in version 2.0.2 (Plugin).

Advanced Functions

tinkerforge call lcd-128x64-bricklet <uid> set-display-configuration <contrast> <backlight> <invert> <automatic-draw>
Parameters:
  • <contrast> – Type: Int, Range: [0 to 63], Default: 14
  • <backlight> – Type: Int, Range: [0 to 100], Default: 100
  • <invert> – Type: Bool, Default: false
  • <automatic-draw> – Type: Bool, Default: true
Output:
  • no output

Sets the configuration of the display.

If automatic draw is set to true, the display is automatically updated with every call of write-pixels and write-line. If it is set to false, the changes are written into an internal buffer and only shown on the display after a call of draw-buffered-frame.

tinkerforge call lcd-128x64-bricklet <uid> get-display-configuration
Output:
  • contrast – Type: Int, Range: [0 to 63], Default: 14
  • backlight – Type: Int, Range: [0 to 100], Default: 100
  • invert – Type: Bool, Default: false
  • automatic-draw – Type: Bool, Default: true

Returns the configuration as set by set-display-configuration.

tinkerforge call lcd-128x64-bricklet <uid> set-touch-led-config <config>
Parameters:
  • <config> – Type: Int, Range: See symbols, Default: 3
Output:
  • no output

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 symbols are available for this function:

For <config>:

  • touch-led-config-off = 0
  • touch-led-config-on = 1
  • touch-led-config-show-heartbeat = 2
  • touch-led-config-show-touch = 3

New in version 2.0.2 (Plugin).

tinkerforge call lcd-128x64-bricklet <uid> get-touch-led-config
Output:
  • config – Type: Int, Range: See symbols, Default: 3

Returns the configuration as set by set-touch-led-config

The following symbols are available for this function:

For config:

  • touch-led-config-off = 0
  • touch-led-config-on = 1
  • touch-led-config-show-heartbeat = 2
  • touch-led-config-show-touch = 3

New in version 2.0.2 (Plugin).

tinkerforge call lcd-128x64-bricklet <uid> get-spitfp-error-count
Output:
  • error-count-ack-checksum – Type: Int, Range: [0 to 232 - 1]
  • error-count-message-checksum – Type: Int, Range: [0 to 232 - 1]
  • error-count-frame – Type: Int, Range: [0 to 232 - 1]
  • error-count-overflow – Type: Int, Range: [0 to 232 - 1]

Returns the error count for the communication between Brick and Bricklet.

The errors are divided into

  • ACK checksum errors,
  • message checksum errors,
  • framing errors and
  • overflow errors.

The errors counts are for errors that occur on the Bricklet side. All Bricks have a similar function that returns the errors on the Brick side.

tinkerforge call lcd-128x64-bricklet <uid> set-bootloader-mode <mode>
Parameters:
  • <mode> – Type: Int, Range: See symbols
Output:
  • status – Type: Int, Range: See symbols

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 symbols are available for this function:

For <mode>:

  • bootloader-mode-bootloader = 0
  • bootloader-mode-firmware = 1
  • bootloader-mode-bootloader-wait-for-reboot = 2
  • bootloader-mode-firmware-wait-for-reboot = 3
  • bootloader-mode-firmware-wait-for-erase-and-reboot = 4

For status:

  • bootloader-status-ok = 0
  • bootloader-status-invalid-mode = 1
  • bootloader-status-no-change = 2
  • bootloader-status-entry-function-not-present = 3
  • bootloader-status-device-identifier-incorrect = 4
  • bootloader-status-crc-mismatch = 5
tinkerforge call lcd-128x64-bricklet <uid> get-bootloader-mode
Output:
  • mode – Type: Int, Range: See symbols

Returns the current bootloader mode, see set-bootloader-mode.

The following symbols are available for this function:

For mode:

  • bootloader-mode-bootloader = 0
  • bootloader-mode-firmware = 1
  • bootloader-mode-bootloader-wait-for-reboot = 2
  • bootloader-mode-firmware-wait-for-reboot = 3
  • bootloader-mode-firmware-wait-for-erase-and-reboot = 4
tinkerforge call lcd-128x64-bricklet <uid> set-write-firmware-pointer <pointer>
Parameters:
  • <pointer> – Type: Int, Unit: 1 B, Range: [0 to 232 - 1]
Output:
  • no output

Sets the firmware pointer for write-firmware. The pointer has to be increased by chunks of size 64. The data is written to flash every 4 chunks (which equals to one page of size 256).

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

tinkerforge call lcd-128x64-bricklet <uid> write-firmware <data>
Parameters:
  • <data> – Type: Int Array, Length: 64, Range: [0 to 255]
Output:
  • status – Type: Int, Range: [0 to 255]

Writes 64 Bytes of firmware at the position as written by set-write-firmware-pointer before. The firmware is written to flash every 4 chunks.

You can only write firmware in bootloader mode.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

tinkerforge call lcd-128x64-bricklet <uid> set-status-led-config <config>
Parameters:
  • <config> – Type: Int, Range: See symbols, Default: 3
Output:
  • no output

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 symbols are available for this function:

For <config>:

  • status-led-config-off = 0
  • status-led-config-on = 1
  • status-led-config-show-heartbeat = 2
  • status-led-config-show-status = 3
tinkerforge call lcd-128x64-bricklet <uid> get-status-led-config
Output:
  • config – Type: Int, Range: See symbols, Default: 3

Returns the configuration as set by set-status-led-config

The following symbols are available for this function:

For config:

  • status-led-config-off = 0
  • status-led-config-on = 1
  • status-led-config-show-heartbeat = 2
  • status-led-config-show-status = 3
tinkerforge call lcd-128x64-bricklet <uid> get-chip-temperature
Output:
  • temperature – Type: Int, Unit: 1 °C, Range: [-215 to 215 - 1]

Returns the temperature as measured inside the microcontroller. The value returned is not the ambient temperature!

The temperature is only proportional to the real temperature and it has bad accuracy. Practically it is only useful as an indicator for temperature changes.

tinkerforge call lcd-128x64-bricklet <uid> reset
Output:
  • no output

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!

tinkerforge call lcd-128x64-bricklet <uid> write-uid <uid>
Parameters:
  • <uid> – Type: Int, Range: [0 to 232 - 1]
Output:
  • no output

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.

tinkerforge call lcd-128x64-bricklet <uid> read-uid
Output:
  • uid – Type: Int, Range: [0 to 232 - 1]

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

tinkerforge call lcd-128x64-bricklet <uid> get-identity
Output:
  • uid – Type: String, Length: up to 8
  • connected-uid – Type: String, Length: up to 8
  • position – Type: Char, Range: [a to h, i, z]
  • hardware-version – Type: Int Array, Length: 3
    • 0: major – Type: Int, Range: [0 to 255]
    • 1: minor – Type: Int, Range: [0 to 255]
    • 2: revision – Type: Int, Range: [0 to 255]
  • firmware-version – Type: Int Array, Length: 3
    • 0: major – Type: Int, Range: [0 to 255]
    • 1: minor – Type: Int, Range: [0 to 255]
    • 2: revision – Type: Int, Range: [0 to 255]
  • device-identifier – Type: Int, Range: [0 to 216 - 1]

Returns the UID, the UID where the Bricklet is connected to, the position, the hardware and firmware version as well as the device identifier.

The position can be 'a', 'b', 'c', 'd', 'e', 'f', 'g' or 'h' (Bricklet Port). The Raspberry Pi HAT (Zero) Brick is always at position 'i' and the Bricklet connected to an Isolator Bricklet is always as position 'z'.

The device identifier numbers can be found here

Callback Configuration Functions

tinkerforge call lcd-128x64-bricklet <uid> set-touch-position-callback-configuration <period> <value-has-to-change>
Parameters:
  • <period> – Type: Int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • <value-has-to-change> – Type: Bool, Default: false
Output:
  • no output

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

tinkerforge call lcd-128x64-bricklet <uid> get-touch-position-callback-configuration
Output:
  • period – Type: Int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • value-has-to-change – Type: Bool, Default: false

Returns the callback configuration as set by set-touch-position-callback-configuration.

tinkerforge call lcd-128x64-bricklet <uid> set-touch-gesture-callback-configuration <period> <value-has-to-change>
Parameters:
  • <period> – Type: Int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • <value-has-to-change> – Type: Bool, Default: false
Output:
  • no output

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

tinkerforge call lcd-128x64-bricklet <uid> get-touch-gesture-callback-configuration
Output:
  • period – Type: Int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • value-has-to-change – Type: Bool, Default: false

Returns the callback configuration as set by set-touch-gesture-callback-configuration.

tinkerforge call lcd-128x64-bricklet <uid> set-gui-button-pressed-callback-configuration <period> <value-has-to-change>
Parameters:
  • <period> – Type: Int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • <value-has-to-change> – Type: Bool, Default: false
Output:
  • no output

The period is the period with which the gui-button-pressed callback is triggered periodically. A value of 0 turns the callback off.

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

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

New in version 2.0.2 (Plugin).

tinkerforge call lcd-128x64-bricklet <uid> get-gui-button-pressed-callback-configuration
Output:
  • period – Type: Int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • value-has-to-change – Type: Bool, Default: false

Returns the callback configuration as set by set-gui-button-pressed-callback-configuration.

New in version 2.0.2 (Plugin).

tinkerforge call lcd-128x64-bricklet <uid> set-gui-slider-value-callback-configuration <period> <value-has-to-change>
Parameters:
  • <period> – Type: Int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • <value-has-to-change> – Type: Bool, Default: false
Output:
  • no output

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

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

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

New in version 2.0.2 (Plugin).

tinkerforge call lcd-128x64-bricklet <uid> get-gui-slider-value-callback-configuration
Output:
  • period – Type: Int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • value-has-to-change – Type: Bool, Default: false

Returns the callback configuration as set by set-gui-slider-value-callback-configuration.

New in version 2.0.2 (Plugin).

tinkerforge call lcd-128x64-bricklet <uid> set-gui-tab-selected-callback-configuration <period> <value-has-to-change>
Parameters:
  • <period> – Type: Int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • <value-has-to-change> – Type: Bool, Default: false
Output:
  • no output

The period is the period with which the gui-tab-selected callback is triggered periodically. A value of 0 turns the callback off.

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

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

New in version 2.0.2 (Plugin).

tinkerforge call lcd-128x64-bricklet <uid> get-gui-tab-selected-callback-configuration
Output:
  • period – Type: Int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • value-has-to-change – Type: Bool, Default: false

Returns the callback configuration as set by set-gui-tab-selected-callback-configuration.

New in version 2.0.2 (Plugin).

Callbacks

Callbacks can be used to receive time critical or recurring data from the device:

tinkerforge dispatch lcd-128x64-bricklet <uid> example

The available callbacks 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.

tinkerforge dispatch lcd-128x64-bricklet <uid> touch-position
Output:
  • pressure – Type: Int, Range: [0 to 300]
  • x – Type: Int, Range: [0 to 127]
  • y – Type: Int, Range: [0 to 63]
  • age – Type: Int, Unit: 1 ms, Range: [0 to 232 - 1]

This callback is triggered periodically with the period that is set by set-touch-position-callback-configuration. The parameters are the same as for get-touch-position.

tinkerforge dispatch lcd-128x64-bricklet <uid> touch-gesture
Output:
  • gesture – Type: Int, Range: See symbols
  • duration – Type: Int, Unit: 1 ms, Range: [0 to 232 - 1]
  • pressure-max – Type: Int, Range: [0 to 300]
  • x-start – Type: Int, Range: [0 to 127]
  • y-start – Type: Int, Range: [0 to 63]
  • x-end – Type: Int, Range: [0 to 127]
  • y-end – Type: Int, Range: [0 to 63]
  • age – Type: Int, Unit: 1 ms, Range: [0 to 232 - 1]

This callback is triggered periodically with the period that is set by set-touch-gesture-callback-configuration. The parameters are the same as for get-touch-gesture.

The following symbols are available for this function:

For gesture:

  • gesture-left-to-right = 0
  • gesture-right-to-left = 1
  • gesture-top-to-bottom = 2
  • gesture-bottom-to-top = 3
tinkerforge dispatch lcd-128x64-bricklet <uid> gui-button-pressed
Output:
  • index – Type: Int, Range: [0 to 11]
  • pressed – Type: Bool

This callback is triggered periodically with the period that is set by set-gui-button-pressed-callback-configuration. The parameters are the same as for get-gui-button-pressed.

New in version 2.0.2 (Plugin).

tinkerforge dispatch lcd-128x64-bricklet <uid> gui-slider-value
Output:
  • index – Type: Int, Range: [0 to 5]
  • value – Type: Int, Range: [0 to 120]

This callback is triggered periodically with the period that is set by set-gui-slider-value-callback-configuration. The parameters are the same as for get-gui-slider-value.

New in version 2.0.2 (Plugin).

tinkerforge dispatch lcd-128x64-bricklet <uid> gui-tab-selected
Output:
  • index – Type: Int, Range: [0 to 9]

This callback is triggered periodically with the period that is set by set-gui-tab-selected-callback-configuration. The parameters are the same as for get-gui-tab-selected.

New in version 2.0.2 (Plugin).