MQTT - LCD 128x64 Bricklet¶

Big Font¶

Download (example-big-font.txt)

1
2
3
4
5
6
7
8

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

setup:
    # Clear display
    publish '' to tinkerforge/request/lcd_128x64_bricklet/XYZ/clear_display

    # Write "Hello World" with big 24x32 font
    publish '{"position_x": 0, "position_y": 0, "font": "24x32", "color": "black", "text": "24x32"}' to tinkerforge/request/lcd_128x64_bricklet/XYZ/draw_text

Hello World¶

Download (example-hello-world.txt)

1
2
3
4
5
6
7
8

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

setup:
    # Clear display
    publish '' to tinkerforge/request/lcd_128x64_bricklet/XYZ/clear_display

    # Write "Hello World" starting from upper left corner of the screen
    publish '{"line": 0, "position": 0, "text": "Hello World"}' to tinkerforge/request/lcd_128x64_bricklet/XYZ/write_line

Touch¶

Download (example-touch.txt)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16

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

setup:
    # Handle incoming touch position callbacks
    subscribe to tinkerforge/callback/lcd_128x64_bricklet/XYZ/touch_position
    publish '{"register": true}' to tinkerforge/register/lcd_128x64_bricklet/XYZ/touch_position # Register touch_position callback

    # Handle incoming touch gesture callbacks
    subscribe to tinkerforge/callback/lcd_128x64_bricklet/XYZ/touch_gesture
    publish '{"register": true}' to tinkerforge/register/lcd_128x64_bricklet/XYZ/touch_gesture # Register touch_gesture callback

    # Set period for touch position callback to 0.1s (100ms)
    publish '{"period": 100, "value_has_to_change": true}' to tinkerforge/request/lcd_128x64_bricklet/XYZ/set_touch_position_callback_configuration

    # Set period for touch gesture callback to 0.1s (100ms)
    publish '{"period": 100, "value_has_to_change": true}' to tinkerforge/request/lcd_128x64_bricklet/XYZ/set_touch_gesture_callback_configuration

Gui¶

Download (example-gui.txt)

 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

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

setup:
    # Handle incoming GUI button pressed callbacks
    subscribe to tinkerforge/callback/lcd_128x64_bricklet/XYZ/gui_button_pressed
    publish '{"register": true}' to tinkerforge/register/lcd_128x64_bricklet/XYZ/gui_button_pressed # Register gui_button_pressed callback

    # Handle incoming GUI slider value callbacks
    subscribe to tinkerforge/callback/lcd_128x64_bricklet/XYZ/gui_slider_value
    publish '{"register": true}' to tinkerforge/register/lcd_128x64_bricklet/XYZ/gui_slider_value # Register gui_slider_value callback

    # Handle incoming GUI tab selected callbacks
    subscribe to tinkerforge/callback/lcd_128x64_bricklet/XYZ/gui_tab_selected
    publish '{"register": true}' to tinkerforge/register/lcd_128x64_bricklet/XYZ/gui_tab_selected # Register gui_tab_selected callback

    # Clear display
    publish '' to tinkerforge/request/lcd_128x64_bricklet/XYZ/clear_display

    publish '' to tinkerforge/request/lcd_128x64_bricklet/XYZ/remove_all_gui

    # Add GUI elements: Button, Slider and Graph with 60 data points
    publish '{"index": 0, "position_x": 0, "position_y": 0, "width": 60, "height": 20, "text": "button"}' to tinkerforge/request/lcd_128x64_bricklet/XYZ/set_gui_button

    publish '{"index": 0, "position_x": 0, "position_y": 30, "length": 60, "direction": "horizontal", "value": 50}' to tinkerforge/request/lcd_128x64_bricklet/XYZ/set_gui_slider

    publish '{"index": 0, "graph_type": "line", "position_x": 62, "position_y": 0, "width": 60, "height": 52, "text_x": "X", "text_y": "Y"}' to tinkerforge/request/lcd_128x64_bricklet/XYZ/set_gui_graph_configuration

    # Add a few data points (the remaining points will be 0)
    publish '{"index": 0, "data": [20,40,60,80,100,120,140,160,180,200,220,240]}' to tinkerforge/request/lcd_128x64_bricklet/XYZ/set_gui_graph_data

    # Add 5 text tabs without and configure it for click and swipe without auto-redraw
    publish '{"change_tab_config": "click_and_swipe", "clear_gui": false}' to tinkerforge/request/lcd_128x64_bricklet/XYZ/set_gui_tab_configuration

    publish '{"index": 0, "text": "Tab A"}' to tinkerforge/request/lcd_128x64_bricklet/XYZ/set_gui_tab_text

    publish '{"index": 1, "text": "Tab B"}' to tinkerforge/request/lcd_128x64_bricklet/XYZ/set_gui_tab_text

    publish '{"index": 2, "text": "Tab C"}' to tinkerforge/request/lcd_128x64_bricklet/XYZ/set_gui_tab_text

    publish '{"index": 3, "text": "Tab D"}' to tinkerforge/request/lcd_128x64_bricklet/XYZ/set_gui_tab_text

    publish '{"index": 4, "text": "Tab E"}' to tinkerforge/request/lcd_128x64_bricklet/XYZ/set_gui_tab_text

    # Set period for GUI button pressed callback to 0.1s (100ms)
    publish '{"period": 100, "value_has_to_change": true}' to tinkerforge/request/lcd_128x64_bricklet/XYZ/set_gui_button_pressed_callback_configuration

    # Set period for GUI slider value callback to 0.1s (100ms)
    publish '{"period": 100, "value_has_to_change": true}' to tinkerforge/request/lcd_128x64_bricklet/XYZ/set_gui_slider_value_callback_configuration

    # Set period for GUI tab selected callback to 0.1s (100ms)
    publish '{"period": 100, "value_has_to_change": true}' to tinkerforge/request/lcd_128x64_bricklet/XYZ/set_gui_tab_selected_callback_configuration

Basic Functions¶

request/lcd_128x64_bricklet/<UID>/write_pixels¶

Request:	x_start – Type: int, Range: [0 to 127] y_start – Type: int, Range: [0 to 63] x_end – Type: int, Range: [0 to 127] y_end – Type: int, Range: [0 to 63] pixels – Type: [bool, ...], Length: variable
Response:	no response

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 request/lcd_128x64_bricklet/<UID>/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 request/lcd_128x64_bricklet/<UID>/set_display_configuration function.

request/lcd_128x64_bricklet/<UID>/read_pixels¶

Request:	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]
Response:	pixels – Type: [bool, ...], Length: variable

Reads pixels from the specified window.

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

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

If automatic draw is disabled the pixels are read from the internal buffer (see request/lcd_128x64_bricklet/<UID>/draw_buffered_frame).

Automatic draw can be configured with the request/lcd_128x64_bricklet/<UID>/set_display_configuration function.

request/lcd_128x64_bricklet/<UID>/clear_display¶

Request:	empty payload
Response:	no response

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 request/lcd_128x64_bricklet/<UID>/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 request/lcd_128x64_bricklet/<UID>/set_display_configuration function.

request/lcd_128x64_bricklet/<UID>/write_line¶

Request:	line – Type: int, Range: [0 to 7] position – Type: int, Range: [0 to 21] text – Type: string, Length: up to 22
Response:	no response

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 request/lcd_128x64_bricklet/<UID>/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 request/lcd_128x64_bricklet/<UID>/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 request/lcd_128x64_bricklet/<UID>/draw_text function.

request/lcd_128x64_bricklet/<UID>/draw_buffered_frame¶

Request:	force_complete_redraw – Type: bool
Response:	no response

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

request/lcd_128x64_bricklet/<UID>/get_touch_position¶

Request:	empty payload
Response:	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)

request/lcd_128x64_bricklet/<UID>/get_touch_gesture¶

Request:	empty payload
Response:	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:

• "left_to_right" = 0
• "right_to_left" = 1
• "top_to_bottom" = 2
• "bottom_to_top" = 3

request/lcd_128x64_bricklet/<UID>/draw_line¶

Request:	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
Response:	no response

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

The following symbols are available for this function:

For color:

• "white" = false
• "black" = true

New in version 2.0.2 (Plugin).

request/lcd_128x64_bricklet/<UID>/draw_box¶

Request:	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
Response:	no response

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:

• "white" = false
• "black" = true

New in version 2.0.2 (Plugin).

request/lcd_128x64_bricklet/<UID>/draw_text¶

Request:	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
Response:	no response

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

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

The font conforms to code page 437.

The following symbols are available for this function:

For font:

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

For color:

• "white" = false
• "black" = true

New in version 2.0.2 (Plugin).

request/lcd_128x64_bricklet/<UID>/set_gui_button¶

Request:	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
Response:	no response

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 request/lcd_128x64_bricklet/<UID>/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 request/lcd_128x64_bricklet/<UID>/write_pixels. To remove the button use request/lcd_128x64_bricklet/<UID>/remove_gui_button.

If you want an icon instead of text, you can draw the icon inside of the button with request/lcd_128x64_bricklet/<UID>/write_pixels.

New in version 2.0.2 (Plugin).

request/lcd_128x64_bricklet/<UID>/get_gui_button¶

Request:	index – Type: int, Range: [0 to 11]
Response:	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 request/lcd_128x64_bricklet/<UID>/set_gui_button.

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

New in version 2.0.2 (Plugin).

request/lcd_128x64_bricklet/<UID>/remove_gui_button¶

Request:	index – Type: int, Range: [0 to 11, 255]
Response:	no response

Removes the button with the given index.

You can use index 255 to remove all buttons.

New in version 2.0.2 (Plugin).

request/lcd_128x64_bricklet/<UID>/get_gui_button_pressed¶

Request:	index – Type: int, Range: [0 to 11]
Response:	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).

request/lcd_128x64_bricklet/<UID>/set_gui_slider¶

Request:	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]
Response:	no response

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 request/lcd_128x64_bricklet/<UID>/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 request/lcd_128x64_bricklet/<UID>/write_pixels. To remove the button use request/lcd_128x64_bricklet/<UID>/remove_gui_slider.

The following symbols are available for this function:

For direction:

• "horizontal" = 0
• "vertical" = 1

New in version 2.0.2 (Plugin).

request/lcd_128x64_bricklet/<UID>/get_gui_slider¶

Request:	index – Type: int, Range: [0 to 5]
Response:	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 request/lcd_128x64_bricklet/<UID>/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:

• "horizontal" = 0
• "vertical" = 1

New in version 2.0.2 (Plugin).

request/lcd_128x64_bricklet/<UID>/remove_gui_slider¶

Request:	index – Type: int, Range: [0 to 5, 255]
Response:	no response

Removes the slider with the given index.

You can use index 255 to remove all slider.

New in version 2.0.2 (Plugin).

request/lcd_128x64_bricklet/<UID>/get_gui_slider_value¶

Request:	index – Type: int, Range: [0 to 5]
Response:	value – Type: int, Range: [0 to 120]

Returns the current slider value for the given index.

New in version 2.0.2 (Plugin).

request/lcd_128x64_bricklet/<UID>/set_gui_tab_configuration¶

Request:	change_tab_config – Type: int, Range: See symbols, Default: 3 clear_gui – Type: bool, Default: true
Response:	no response

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:

• "click" = 1
• "swipe" = 2
• "click_and_swipe" = 3

New in version 2.0.2 (Plugin).

request/lcd_128x64_bricklet/<UID>/get_gui_tab_configuration¶

Request:	empty payload
Response:	change_tab_config – Type: int, Range: See symbols, Default: 3 clear_gui – Type: bool, Default: true

Returns the tab configuration as set by request/lcd_128x64_bricklet/<UID>/set_gui_tab_configuration.

The following symbols are available for this function:

For change_tab_config:

• "click" = 1
• "swipe" = 2
• "click_and_swipe" = 3

New in version 2.0.2 (Plugin).

request/lcd_128x64_bricklet/<UID>/set_gui_tab_text¶

Request:	index – Type: int, Range: [0 to 9] text – Type: string, Length: up to 5
Response:	no response

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

request/lcd_128x64_bricklet/<UID>/get_gui_tab_text¶

Request:	index – Type: int, Range: [0 to 9]
Response:	active – Type: bool text – Type: string, Length: up to 5

Returns the text for a given index as set by request/lcd_128x64_bricklet/<UID>/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).

request/lcd_128x64_bricklet/<UID>/set_gui_tab_icon¶

Request:	index – Type: int, Range: [0 to 9] icon – Type: [bool, ...], Length: 168
Response:	no response

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

request/lcd_128x64_bricklet/<UID>/get_gui_tab_icon¶

Request:	index – Type: int, Range: [0 to 9]
Response:	active – Type: bool icon – Type: [bool, ...], Length: 168

Returns the icon for a given index as set by request/lcd_128x64_bricklet/<UID>/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).

request/lcd_128x64_bricklet/<UID>/remove_gui_tab¶

Request:	index – Type: int, Range: [0 to 9, 255]
Response:	no response

Removes the tab with the given index.

You can use index 255 to remove all tabs.

New in version 2.0.2 (Plugin).

request/lcd_128x64_bricklet/<UID>/set_gui_tab_selected¶

Request:	index – Type: int, Range: [0 to 9]
Response:	no response

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

New in version 2.0.2 (Plugin).

request/lcd_128x64_bricklet/<UID>/get_gui_tab_selected¶

Request:	empty payload
Response:	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).

request/lcd_128x64_bricklet/<UID>/set_gui_graph_configuration¶

Request:	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
Response:	no response

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 request/lcd_128x64_bricklet/<UID>/draw_text to draw the caption outside of the graph.

The data of the graph can be set and updated with request/lcd_128x64_bricklet/<UID>/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 request/lcd_128x64_bricklet/<UID>/write_pixels. To remove the graph use request/lcd_128x64_bricklet/<UID>/remove_gui_graph.

The following symbols are available for this function:

For graph_type:

• "dot" = 0
• "line" = 1
• "bar" = 2

New in version 2.0.2 (Plugin).

request/lcd_128x64_bricklet/<UID>/get_gui_graph_configuration¶

Request:	index – Type: int, Range: [0 to 3]
Response:	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 request/lcd_128x64_bricklet/<UID>/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:

• "dot" = 0
• "line" = 1
• "bar" = 2

New in version 2.0.2 (Plugin).

request/lcd_128x64_bricklet/<UID>/set_gui_graph_data¶

Request:	index – Type: int, Range: [0 to 3] data – Type: [int, ...], Length: variable, Range: [0 to 255]
Response:	no response

Sets the data for a graph with the given index. You have to configure the graph with request/lcd_128x64_bricklet/<UID>/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 request/lcd_128x64_bricklet/<UID>/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).

request/lcd_128x64_bricklet/<UID>/get_gui_graph_data¶

Request:	index – Type: int, Range: [0 to 3]
Response:	data – Type: [int, ...], Length: variable, Range: [0 to 255]

Returns the graph data for a given index as set by request/lcd_128x64_bricklet/<UID>/set_gui_graph_data.

New in version 2.0.2 (Plugin).

request/lcd_128x64_bricklet/<UID>/remove_gui_graph¶

Request:	index – Type: int, Range: [0 to 3, 255]
Response:	no response

Removes the graph with the given index.

You can use index 255 to remove all graphs.

New in version 2.0.2 (Plugin).

request/lcd_128x64_bricklet/<UID>/remove_all_gui¶

Request:	empty payload
Response:	no response

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

New in version 2.0.2 (Plugin).

Advanced Functions¶

request/lcd_128x64_bricklet/<UID>/set_display_configuration¶

Request:	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
Response:	no response

Sets the configuration of the display.

If automatic draw is set to true, the display is automatically updated with every call of request/lcd_128x64_bricklet/<UID>/write_pixels and request/lcd_128x64_bricklet/<UID>/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 request/lcd_128x64_bricklet/<UID>/draw_buffered_frame.

request/lcd_128x64_bricklet/<UID>/get_display_configuration¶

Request:	empty payload
Response:	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 request/lcd_128x64_bricklet/<UID>/set_display_configuration.

request/lcd_128x64_bricklet/<UID>/set_touch_led_config¶

Request:	config – Type: int, Range: See symbols, Default: 3
Response:	no response

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:

• "off" = 0
• "on" = 1
• "show_heartbeat" = 2
• "show_touch" = 3

New in version 2.0.2 (Plugin).

request/lcd_128x64_bricklet/<UID>/get_touch_led_config¶

Request:	empty payload
Response:	config – Type: int, Range: See symbols, Default: 3

Returns the configuration as set by request/lcd_128x64_bricklet/<UID>/set_touch_led_config

The following symbols are available for this function:

For config:

• "off" = 0
• "on" = 1
• "show_heartbeat" = 2
• "show_touch" = 3

New in version 2.0.2 (Plugin).

request/lcd_128x64_bricklet/<UID>/get_spitfp_error_count¶

Request:	empty payload
Response:	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.

request/lcd_128x64_bricklet/<UID>/set_status_led_config¶

Request:	config – Type: int, Range: See symbols, Default: 3
Response:	no response

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:

• "off" = 0
• "on" = 1
• "show_heartbeat" = 2
• "show_status" = 3

request/lcd_128x64_bricklet/<UID>/get_status_led_config¶

Request:	empty payload
Response:	config – Type: int, Range: See symbols, Default: 3

Returns the configuration as set by request/lcd_128x64_bricklet/<UID>/set_status_led_config

The following symbols are available for this function:

For config:

• "off" = 0
• "on" = 1
• "show_heartbeat" = 2
• "show_status" = 3

request/lcd_128x64_bricklet/<UID>/get_chip_temperature¶

Request:	empty payload
Response:	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.

request/lcd_128x64_bricklet/<UID>/reset¶

Request:	empty payload
Response:	no response

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!

request/lcd_128x64_bricklet/<UID>/get_identity¶

Request:

empty payload

Response:

uid – Type: string, Length: up to 8 connected_uid – Type: string, Length: up to 8 position – Type: char, Range: ["a" to "h", "z"] hardware_version – Type: [int, ...], Length: 3 0: major – Type: int, Range: [0 to 255] 1: minor – Type: int, Range: [0 to 255] 2: revision – Type: int, Range: [0 to 255] firmware_version – Type: [int, ...], Length: 3 0: major – Type: int, Range: [0 to 255] 1: minor – Type: int, Range: [0 to 255] 2: revision – Type: int, Range: [0 to 255] device_identifier – Type: int, Range: [0 to 216 - 1] _display_name – Type: string

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

The position can be 'a', 'b', 'c', 'd', 'e', 'f', 'g' or 'h' (Bricklet Port). A Bricklet connected to an Isolator Bricklet is always at position 'z'.

The device identifier numbers can be found here. If symbolic output is not disabled, the device identifier is mapped to the corresponding name in the format used in topics.

The display name contains the LCD 128x64's name in a human readable form.

Callback Configuration Functions¶

request/lcd_128x64_bricklet/<UID>/set_touch_position_callback_configuration¶

Request:	period – Type: int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0 value_has_to_change – Type: bool, Default: false
Response:	no response

The period is the period with which the register/lcd_128x64_bricklet/<UID>/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.

request/lcd_128x64_bricklet/<UID>/get_touch_position_callback_configuration¶

Request:	empty payload
Response:	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 request/lcd_128x64_bricklet/<UID>/set_touch_position_callback_configuration.

request/lcd_128x64_bricklet/<UID>/set_touch_gesture_callback_configuration¶

Request:	period – Type: int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0 value_has_to_change – Type: bool, Default: false
Response:	no response

The period is the period with which the register/lcd_128x64_bricklet/<UID>/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.

request/lcd_128x64_bricklet/<UID>/get_touch_gesture_callback_configuration¶

Request:	empty payload
Response:	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 request/lcd_128x64_bricklet/<UID>/set_touch_gesture_callback_configuration.

request/lcd_128x64_bricklet/<UID>/set_gui_button_pressed_callback_configuration¶

Request:	period – Type: int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0 value_has_to_change – Type: bool, Default: false
Response:	no response

The period is the period with which the register/lcd_128x64_bricklet/<UID>/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).

request/lcd_128x64_bricklet/<UID>/get_gui_button_pressed_callback_configuration¶

Request:	empty payload
Response:	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 request/lcd_128x64_bricklet/<UID>/set_gui_button_pressed_callback_configuration.

New in version 2.0.2 (Plugin).

request/lcd_128x64_bricklet/<UID>/set_gui_slider_value_callback_configuration¶

Request:	period – Type: int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0 value_has_to_change – Type: bool, Default: false
Response:	no response

The period is the period with which the register/lcd_128x64_bricklet/<UID>/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).

request/lcd_128x64_bricklet/<UID>/get_gui_slider_value_callback_configuration¶

Request:	empty payload
Response:	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 request/lcd_128x64_bricklet/<UID>/set_gui_slider_value_callback_configuration.

New in version 2.0.2 (Plugin).

request/lcd_128x64_bricklet/<UID>/set_gui_tab_selected_callback_configuration¶

Request:	period – Type: int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0 value_has_to_change – Type: bool, Default: false
Response:	no response

The period is the period with which the register/lcd_128x64_bricklet/<UID>/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).

request/lcd_128x64_bricklet/<UID>/get_gui_tab_selected_callback_configuration¶

Request:	empty payload
Response:	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 request/lcd_128x64_bricklet/<UID>/set_gui_tab_selected_callback_configuration.

New in version 2.0.2 (Plugin).

Callbacks¶

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done with the corresponding .../register/... topic and an optional suffix. This suffix can be used to deregister the callback later.

register/lcd_128x64_bricklet/<UID>/touch_position¶

Register Request:	register – Type: bool
Callback Response:	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]

A callback can be registered for this event by publishing to the .../register/lcd_128x64_bricklet/<UID>/touch_position[/<SUFFIX>] topic with the payload "true". An added callback can be removed by publishing to the same topic with the payload "false". To support multiple (de)registrations, e.g. for message filtering, an optional suffix can be used.

If the callback is triggered, a message with it's payload is published under the corresponding .../callback/lcd_128x64_bricklet/<UID>/touch_position[/<SUFFIX>] topic for each registered suffix.

This callback is triggered periodically with the period that is set by request/lcd_128x64_bricklet/<UID>/set_touch_position_callback_configuration. The callback payload members are the same as for request/lcd_128x64_bricklet/<UID>/get_touch_position.

register/lcd_128x64_bricklet/<UID>/touch_gesture¶

Register Request:	register – Type: bool
Callback Response:	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]

A callback can be registered for this event by publishing to the .../register/lcd_128x64_bricklet/<UID>/touch_gesture[/<SUFFIX>] topic with the payload "true". An added callback can be removed by publishing to the same topic with the payload "false". To support multiple (de)registrations, e.g. for message filtering, an optional suffix can be used.

If the callback is triggered, a message with it's payload is published under the corresponding .../callback/lcd_128x64_bricklet/<UID>/touch_gesture[/<SUFFIX>] topic for each registered suffix.

This callback is triggered periodically with the period that is set by request/lcd_128x64_bricklet/<UID>/set_touch_gesture_callback_configuration. The callback payload members are the same as for request/lcd_128x64_bricklet/<UID>/get_touch_gesture.

The following symbols are available for this function:

For gesture:

• "left_to_right" = 0
• "right_to_left" = 1
• "top_to_bottom" = 2
• "bottom_to_top" = 3

register/lcd_128x64_bricklet/<UID>/gui_button_pressed¶

Register Request:	register – Type: bool
Callback Response:	index – Type: int, Range: [0 to 11] pressed – Type: bool

A callback can be registered for this event by publishing to the .../register/lcd_128x64_bricklet/<UID>/gui_button_pressed[/<SUFFIX>] topic with the payload "true". An added callback can be removed by publishing to the same topic with the payload "false". To support multiple (de)registrations, e.g. for message filtering, an optional suffix can be used.

If the callback is triggered, a message with it's payload is published under the corresponding .../callback/lcd_128x64_bricklet/<UID>/gui_button_pressed[/<SUFFIX>] topic for each registered suffix.

This callback is triggered periodically with the period that is set by request/lcd_128x64_bricklet/<UID>/set_gui_button_pressed_callback_configuration. The callback payload members are the same as for request/lcd_128x64_bricklet/<UID>/get_gui_button_pressed.

New in version 2.0.2 (Plugin).

register/lcd_128x64_bricklet/<UID>/gui_slider_value¶

Register Request:	register – Type: bool
Callback Response:	index – Type: int, Range: [0 to 5] value – Type: int, Range: [0 to 120]

A callback can be registered for this event by publishing to the .../register/lcd_128x64_bricklet/<UID>/gui_slider_value[/<SUFFIX>] topic with the payload "true". An added callback can be removed by publishing to the same topic with the payload "false". To support multiple (de)registrations, e.g. for message filtering, an optional suffix can be used.

If the callback is triggered, a message with it's payload is published under the corresponding .../callback/lcd_128x64_bricklet/<UID>/gui_slider_value[/<SUFFIX>] topic for each registered suffix.

This callback is triggered periodically with the period that is set by request/lcd_128x64_bricklet/<UID>/set_gui_slider_value_callback_configuration. The callback payload members are the same as for request/lcd_128x64_bricklet/<UID>/get_gui_slider_value.

New in version 2.0.2 (Plugin).

register/lcd_128x64_bricklet/<UID>/gui_tab_selected¶

Register Request:	register – Type: bool
Callback Response:	index – Type: int, Range: [0 to 9]

A callback can be registered for this event by publishing to the .../register/lcd_128x64_bricklet/<UID>/gui_tab_selected[/<SUFFIX>] topic with the payload "true". An added callback can be removed by publishing to the same topic with the payload "false". To support multiple (de)registrations, e.g. for message filtering, an optional suffix can be used.

If the callback is triggered, a message with it's payload is published under the corresponding .../callback/lcd_128x64_bricklet/<UID>/gui_tab_selected[/<SUFFIX>] topic for each registered suffix.

This callback is triggered periodically with the period that is set by request/lcd_128x64_bricklet/<UID>/set_gui_tab_selected_callback_configuration. The callback payload members are the same as for request/lcd_128x64_bricklet/<UID>/get_gui_tab_selected.

New in version 2.0.2 (Plugin).

Internal Functions¶

Internal functions are used for maintenance tasks such as flashing a new firmware of changing the UID of a Bricklet. These task should be performed using Brick Viewer instead of using the internal functions directly.

request/lcd_128x64_bricklet/<UID>/set_bootloader_mode¶

Request:	mode – Type: int, Range: See symbols
Response:	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" = 0
• "firmware" = 1
• "bootloader_wait_for_reboot" = 2
• "firmware_wait_for_reboot" = 3
• "firmware_wait_for_erase_and_reboot" = 4

For status:

• "ok" = 0
• "invalid_mode" = 1
• "no_change" = 2
• "entry_function_not_present" = 3
• "device_identifier_incorrect" = 4
• "crc_mismatch" = 5

request/lcd_128x64_bricklet/<UID>/get_bootloader_mode¶

Request:	empty payload
Response:	mode – Type: int, Range: See symbols

Returns the current bootloader mode, see request/lcd_128x64_bricklet/<UID>/set_bootloader_mode.

The following symbols are available for this function:

For mode:

• "bootloader" = 0
• "firmware" = 1
• "bootloader_wait_for_reboot" = 2
• "firmware_wait_for_reboot" = 3
• "firmware_wait_for_erase_and_reboot" = 4

request/lcd_128x64_bricklet/<UID>/set_write_firmware_pointer¶

Request:	pointer – Type: int, Unit: 1 B, Range: [0 to 232 - 1]
Response:	no response

Sets the firmware pointer for request/lcd_128x64_bricklet/<UID>/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.

request/lcd_128x64_bricklet/<UID>/write_firmware¶

Request:	data – Type: [int, ...], Length: 64, Range: [0 to 255]
Response:	status – Type: int, Range: [0 to 255]

Writes 64 Bytes of firmware at the position as written by request/lcd_128x64_bricklet/<UID>/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.

request/lcd_128x64_bricklet/<UID>/write_uid¶

Request:	uid – Type: int, Range: [0 to 232 - 1]
Response:	no response

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.

request/lcd_128x64_bricklet/<UID>/read_uid¶

Request:	empty payload
Response:	uid – Type: int, Range: [0 to 232 - 1]

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