TCP/IP - LCD 128x64 Bricklet

This is the description of the TCP/IP protocol for the LCD 128x64 Bricklet. General information and technical specifications for the LCD 128x64 Bricklet are summarized in its hardware description.

API

A general description of the TCP/IP protocol structure can be found here.

Basic Functions

BrickletLCD128x64.write_pixels_low_level
Function ID:
  • 1
Request:
  • x_start – Type: uint8, Range: [0 to 127]
  • y_start – Type: uint8, Range: [0 to 63]
  • x_end – Type: uint8, Range: [0 to 127]
  • y_end – Type: uint8, Range: [0 to 63]
  • pixels_length – Type: uint16, Range: [0 to 8192]
  • pixels_chunk_offset – Type: uint16, Range: [0 to 216 - 1]
  • pixels_chunk_data – Type: bool[448]
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 draw_buffered_frame is called. This can be used to avoid flicker when drawing a complex frame in multiple steps.

Automatic draw can be configured with the set_display_configuration function.

BrickletLCD128x64.read_pixels_low_level
Function ID:
  • 2
Request:
  • x_start – Type: uint8, Range: [0 to 127]
  • y_start – Type: uint8, Range: [0 to 63]
  • x_end – Type: uint8, Range: [0 to 127]
  • y_end – Type: uint8, Range: [0 to 63]
Response:
  • pixels_length – Type: uint16, Range: [0 to 8192]
  • pixels_chunk_offset – Type: uint16, Range: [0 to 216 - 1]
  • pixels_chunk_data – Type: bool[480]

Reads pixels from the specified window.

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

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

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

Automatic draw can be configured with the set_display_configuration function.

BrickletLCD128x64.clear_display
Function ID:
  • 3
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 draw_buffered_frame is called. This can be used to avoid flicker when drawing a complex frame in multiple steps.

Automatic draw can be configured with the set_display_configuration function.

BrickletLCD128x64.write_line
Function ID:
  • 6
Request:
  • line – Type: uint8, Range: [0 to 7]
  • position – Type: uint8, Range: [0 to 21]
  • text – Type: char[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 draw_buffered_frame is called. This can be used to avoid flicker when drawing a complex frame in multiple steps.

Automatic draw can be configured with the set_display_configuration function.

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

BrickletLCD128x64.draw_buffered_frame
Function ID:
  • 7
Request:
  • force_complete_redraw – Type: bool
Response:
  • no response

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

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

BrickletLCD128x64.get_touch_position
Function ID:
  • 8
Request:
  • empty payload
Response:
  • pressure – Type: uint16, Range: [0 to 300]
  • x – Type: uint16, Range: [0 to 127]
  • y – Type: uint16, Range: [0 to 63]
  • age – Type: uint32, Unit: 1 ms, Range: [0 to 232 - 1]

Returns the last valid touch position:

  • Pressure: Amount of pressure applied by the user
  • X: Touch position on x-axis
  • Y: Touch position on y-axis
  • Age: Age of touch press (how long ago it was)
BrickletLCD128x64.get_touch_gesture
Function ID:
  • 12
Request:
  • empty payload
Response:
  • gesture – Type: uint8, Range: See meanings
  • duration – Type: uint32, Unit: 1 ms, Range: [0 to 232 - 1]
  • pressure_max – Type: uint16, Range: [0 to 300]
  • x_start – Type: uint16, Range: [0 to 127]
  • y_start – Type: uint16, Range: [0 to 63]
  • x_end – Type: uint16, Range: [0 to 127]
  • y_end – Type: uint16, Range: [0 to 63]
  • age – Type: uint32, 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 meanings are defined for the elements of this function:

For gesture:

  • 0 = Left To Right
  • 1 = Right To Left
  • 2 = Top To Bottom
  • 3 = Bottom To Top
BrickletLCD128x64.draw_line
Function ID:
  • 16
Request:
  • position_x_start – Type: uint8, Range: [0 to 127]
  • position_y_start – Type: uint8, Range: [0 to 63]
  • position_x_end – Type: uint8, Range: [0 to 127]
  • position_y_end – Type: uint8, 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 meanings are defined for the elements of this function:

For color:

  • false = White
  • true = Black

New in version 2.0.2 (Plugin).

BrickletLCD128x64.draw_box
Function ID:
  • 17
Request:
  • position_x_start – Type: uint8, Range: [0 to 127]
  • position_y_start – Type: uint8, Range: [0 to 63]
  • position_x_end – Type: uint8, Range: [0 to 127]
  • position_y_end – Type: uint8, 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 meanings are defined for the elements of this function:

For color:

  • false = White
  • true = Black

New in version 2.0.2 (Plugin).

BrickletLCD128x64.draw_text
Function ID:
  • 18
Request:
  • position_x – Type: uint8, Range: [0 to 127]
  • position_y – Type: uint8, Range: [0 to 63]
  • font – Type: uint8, Range: See meanings
  • color – Type: bool
  • text – Type: char[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 following meanings are defined for the elements of this function:

For font:

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

For color:

  • false = White
  • true = Black

New in version 2.0.2 (Plugin).

BrickletLCD128x64.set_gui_button
Function ID:
  • 19
Request:
  • index – Type: uint8, Range: [0 to 11]
  • position_x – Type: uint8, Range: [0 to 127]
  • position_y – Type: uint8, Range: [0 to 63]
  • width – Type: uint8, Range: [1 to 128]
  • height – Type: uint8, Range: [1 to 64]
  • text – Type: char[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 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_low_level. 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_low_level.

New in version 2.0.2 (Plugin).

BrickletLCD128x64.get_gui_button
Function ID:
  • 20
Request:
  • index – Type: uint8, Range: [0 to 11]
Response:
  • active – Type: bool
  • position_x – Type: uint8, Range: [0 to 127]
  • position_y – Type: uint8, Range: [0 to 63]
  • width – Type: uint8, Range: [1 to 128]
  • height – Type: uint8, Range: [1 to 64]
  • text – Type: char[16]

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

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

New in version 2.0.2 (Plugin).

BrickletLCD128x64.remove_gui_button
Function ID:
  • 21
Request:
  • index – Type: uint8, 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).

BrickletLCD128x64.get_gui_button_pressed
Function ID:
  • 24
Request:
  • index – Type: uint8, 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).

BrickletLCD128x64.set_gui_slider
Function ID:
  • 26
Request:
  • index – Type: uint8, Range: [0 to 5]
  • position_x – Type: uint8, Range: [0 to 128]
  • position_y – Type: uint8, Range: [0 to 64]
  • length – Type: uint8, Range: [8 to 128]
  • direction – Type: uint8, Range: See meanings
  • value – Type: uint8, 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 response value 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_low_level. To remove the button use remove_gui_slider.

The following meanings are defined for the elements of this function:

For direction:

  • 0 = Horizontal
  • 1 = Vertical

New in version 2.0.2 (Plugin).

BrickletLCD128x64.get_gui_slider
Function ID:
  • 27
Request:
  • index – Type: uint8, Range: [0 to 5]
Response:
  • active – Type: bool
  • position_x – Type: uint8, Range: [0 to 128]
  • position_y – Type: uint8, Range: [0 to 64]
  • length – Type: uint8, Range: [8 to 128]
  • direction – Type: uint8, Range: See meanings
  • value – Type: uint8, 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 meanings are defined for the elements of this function:

For direction:

  • 0 = Horizontal
  • 1 = Vertical

New in version 2.0.2 (Plugin).

BrickletLCD128x64.remove_gui_slider
Function ID:
  • 28
Request:
  • index – Type: uint8, 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).

BrickletLCD128x64.get_gui_slider_value
Function ID:
  • 31
Request:
  • index – Type: uint8, Range: [0 to 5]
Response:
  • value – Type: uint8, Range: [0 to 120]

Returns the current slider value for the given index.

New in version 2.0.2 (Plugin).

BrickletLCD128x64.set_gui_tab_configuration
Function ID:
  • 33
Request:
  • change_tab_config – Type: uint8, Range: See meanings, 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 meanings are defined for the elements of this function:

For change_tab_config:

  • 1 = Click
  • 2 = Swipe
  • 3 = Click And Swipe

New in version 2.0.2 (Plugin).

BrickletLCD128x64.get_gui_tab_configuration
Function ID:
  • 34
Request:
  • empty payload
Response:
  • change_tab_config – Type: uint8, Range: See meanings, Default: 3
  • clear_gui – Type: bool, Default: true

Returns the tab configuration as set by set_gui_tab_configuration.

The following meanings are defined for the elements of this function:

For change_tab_config:

  • 1 = Click
  • 2 = Swipe
  • 3 = Click And Swipe

New in version 2.0.2 (Plugin).

BrickletLCD128x64.set_gui_tab_text
Function ID:
  • 35
Request:
  • index – Type: uint8, Range: [0 to 9]
  • text – Type: char[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).

BrickletLCD128x64.get_gui_tab_text
Function ID:
  • 36
Request:
  • index – Type: uint8, Range: [0 to 9]
Response:
  • active – Type: bool
  • text – Type: char[5]

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

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

New in version 2.0.2 (Plugin).

BrickletLCD128x64.set_gui_tab_icon
Function ID:
  • 37
Request:
  • index – Type: uint8, Range: [0 to 9]
  • icon – Type: bool[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).

BrickletLCD128x64.get_gui_tab_icon
Function ID:
  • 38
Request:
  • index – Type: uint8, Range: [0 to 9]
Response:
  • active – Type: bool
  • icon – Type: bool[168]

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

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

New in version 2.0.2 (Plugin).

BrickletLCD128x64.remove_gui_tab
Function ID:
  • 39
Request:
  • index – Type: uint8, 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).

BrickletLCD128x64.set_gui_tab_selected
Function ID:
  • 40
Request:
  • index – Type: uint8, 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).

BrickletLCD128x64.get_gui_tab_selected
Function ID:
  • 43
Request:
  • empty payload
Response:
  • index – Type: int8, Range: [-1 to 9]

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

New in version 2.0.2 (Plugin).

BrickletLCD128x64.set_gui_graph_configuration
Function ID:
  • 45
Request:
  • index – Type: uint8, Range: [0 to 3]
  • graph_type – Type: uint8, Range: See meanings
  • position_x – Type: uint8, Range: [0 to 127]
  • position_y – Type: uint8, Range: [0 to 63]
  • width – Type: uint8, Range: [0 to 118]
  • height – Type: uint8, Range: [0 to 63]
  • text_x – Type: char[4]
  • text_y – Type: char[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 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_low_level.

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_low_level. To remove the graph use remove_gui_graph.

The following meanings are defined for the elements of this function:

For graph_type:

  • 0 = Dot
  • 1 = Line
  • 2 = Bar

New in version 2.0.2 (Plugin).

BrickletLCD128x64.get_gui_graph_configuration
Function ID:
  • 46
Request:
  • index – Type: uint8, Range: [0 to 3]
Response:
  • active – Type: bool
  • graph_type – Type: uint8, Range: See meanings
  • position_x – Type: uint8, Range: [0 to 127]
  • position_y – Type: uint8, Range: [0 to 63]
  • width – Type: uint8, Range: [0 to 118]
  • height – Type: uint8, Range: [0 to 63]
  • text_x – Type: char[4]
  • text_y – Type: char[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 meanings are defined for the elements of this function:

For graph_type:

  • 0 = Dot
  • 1 = Line
  • 2 = Bar

New in version 2.0.2 (Plugin).

BrickletLCD128x64.set_gui_graph_data_low_level
Function ID:
  • 47
Request:
  • index – Type: uint8, Range: [0 to 3]
  • data_length – Type: uint16, Range: [0 to 118]
  • data_chunk_offset – Type: uint16, Range: [0 to 216 - 1]
  • data_chunk_data – Type: uint8[59], Range: [0 to 255]
Response:
  • no response

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

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

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

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

New in version 2.0.2 (Plugin).

BrickletLCD128x64.get_gui_graph_data_low_level
Function ID:
  • 48
Request:
  • index – Type: uint8, Range: [0 to 3]
Response:
  • data_length – Type: uint16, Range: [0 to 118]
  • data_chunk_offset – Type: uint16, Range: [0 to 216 - 1]
  • data_chunk_data – Type: uint8[59], Range: [0 to 255]

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

New in version 2.0.2 (Plugin).

BrickletLCD128x64.remove_gui_graph
Function ID:
  • 49
Request:
  • index – Type: uint8, 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).

BrickletLCD128x64.remove_all_gui
Function ID:
  • 50
Request:
  • empty payload
Response:
  • no response

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

New in version 2.0.2 (Plugin).

Advanced Functions

BrickletLCD128x64.set_display_configuration
Function ID:
  • 4
Request:
  • contrast – Type: uint8, Range: [0 to 63], Default: 14
  • backlight – Type: uint8, 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 write_pixels_low_level and write_line. If it is set to false, the changes are written into an internal buffer and only shown on the display after a call of draw_buffered_frame.

BrickletLCD128x64.get_display_configuration
Function ID:
  • 5
Request:
  • empty payload
Response:
  • contrast – Type: uint8, Range: [0 to 63], Default: 14
  • backlight – Type: uint8, 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.

BrickletLCD128x64.set_touch_led_config
Function ID:
  • 51
Request:
  • config – Type: uint8, Range: See meanings, 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 meanings are defined for the elements of this function:

For config:

  • 0 = Off
  • 1 = On
  • 2 = Show Heartbeat
  • 3 = Show Touch

New in version 2.0.2 (Plugin).

BrickletLCD128x64.get_touch_led_config
Function ID:
  • 52
Request:
  • empty payload
Response:
  • config – Type: uint8, Range: See meanings, Default: 3

Returns the configuration as set by set_touch_led_config

The following meanings are defined for the elements of this function:

For config:

  • 0 = Off
  • 1 = On
  • 2 = Show Heartbeat
  • 3 = Show Touch

New in version 2.0.2 (Plugin).

BrickletLCD128x64.get_spitfp_error_count
Function ID:
  • 234
Request:
  • empty payload
Response:
  • error_count_ack_checksum – Type: uint32, Range: [0 to 232 - 1]
  • error_count_message_checksum – Type: uint32, Range: [0 to 232 - 1]
  • error_count_frame – Type: uint32, Range: [0 to 232 - 1]
  • error_count_overflow – Type: uint32, Range: [0 to 232 - 1]

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

The errors are divided into

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

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

BrickletLCD128x64.set_bootloader_mode
Function ID:
  • 235
Request:
  • mode – Type: uint8, Range: See meanings
Response:
  • status – Type: uint8, Range: See meanings

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 meanings are defined for the elements of this function:

For mode:

  • 0 = Bootloader
  • 1 = Firmware
  • 2 = Bootloader Wait For Reboot
  • 3 = Firmware Wait For Reboot
  • 4 = Firmware Wait For Erase And Reboot

For status:

  • 0 = OK
  • 1 = Invalid Mode
  • 2 = No Change
  • 3 = Entry Function Not Present
  • 4 = Device Identifier Incorrect
  • 5 = CRC Mismatch
BrickletLCD128x64.get_bootloader_mode
Function ID:
  • 236
Request:
  • empty payload
Response:
  • mode – Type: uint8, Range: See meanings

Returns the current bootloader mode, see set_bootloader_mode.

The following meanings are defined for the elements of this function:

For mode:

  • 0 = Bootloader
  • 1 = Firmware
  • 2 = Bootloader Wait For Reboot
  • 3 = Firmware Wait For Reboot
  • 4 = Firmware Wait For Erase And Reboot
BrickletLCD128x64.set_write_firmware_pointer
Function ID:
  • 237
Request:
  • pointer – Type: uint32, Unit: 1 B, Range: [0 to 232 - 1]
Response:
  • no response

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

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

BrickletLCD128x64.write_firmware
Function ID:
  • 238
Request:
  • data – Type: uint8[64], Range: [0 to 255]
Response:
  • status – Type: uint8, Range: [0 to 255]

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

You can only write firmware in bootloader mode.

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

BrickletLCD128x64.set_status_led_config
Function ID:
  • 239
Request:
  • config – Type: uint8, Range: See meanings, 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 meanings are defined for the elements of this function:

For config:

  • 0 = Off
  • 1 = On
  • 2 = Show Heartbeat
  • 3 = Show Status
BrickletLCD128x64.get_status_led_config
Function ID:
  • 240
Request:
  • empty payload
Response:
  • config – Type: uint8, Range: See meanings, Default: 3

Returns the configuration as set by set_status_led_config

The following meanings are defined for the elements of this function:

For config:

  • 0 = Off
  • 1 = On
  • 2 = Show Heartbeat
  • 3 = Show Status
BrickletLCD128x64.get_chip_temperature
Function ID:
  • 242
Request:
  • empty payload
Response:
  • temperature – Type: int16, Unit: 1 °C, Range: [-215 to 215 - 1]

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

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

BrickletLCD128x64.reset
Function ID:
  • 243
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!

BrickletLCD128x64.write_uid
Function ID:
  • 248
Request:
  • uid – Type: uint32, 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.

BrickletLCD128x64.read_uid
Function ID:
  • 249
Request:
  • empty payload
Response:
  • uid – Type: uint32, Range: [0 to 232 - 1]

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

BrickletLCD128x64.get_identity
Function ID:
  • 255
Request:
  • empty payload
Response:
  • uid – Type: char[8]
  • connected_uid – Type: char[8]
  • position – Type: char, Range: ['a' to 'h', 'i', 'z']
  • hardware_version – Type: uint8[3]
    • 0: major – Type: uint8, Range: [0 to 255]
    • 1: minor – Type: uint8, Range: [0 to 255]
    • 2: revision – Type: uint8, Range: [0 to 255]
  • firmware_version – Type: uint8[3]
    • 0: major – Type: uint8, Range: [0 to 255]
    • 1: minor – Type: uint8, Range: [0 to 255]
    • 2: revision – Type: uint8, Range: [0 to 255]
  • device_identifier – Type: uint16, 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

BrickletLCD128x64.set_touch_position_callback_configuration
Function ID:
  • 9
Request:
  • period – Type: uint32, 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 CALLBACK_TOUCH_POSITION callback is triggered periodically. A value of 0 turns the callback off.

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

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

BrickletLCD128x64.get_touch_position_callback_configuration
Function ID:
  • 10
Request:
  • empty payload
Response:
  • period – Type: uint32, 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.

BrickletLCD128x64.set_touch_gesture_callback_configuration
Function ID:
  • 13
Request:
  • period – Type: uint32, 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 CALLBACK_TOUCH_GESTURE callback is triggered periodically. A value of 0 turns the callback off.

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

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

BrickletLCD128x64.get_touch_gesture_callback_configuration
Function ID:
  • 14
Request:
  • empty payload
Response:
  • period – Type: uint32, 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.

BrickletLCD128x64.set_gui_button_pressed_callback_configuration
Function ID:
  • 22
Request:
  • period – Type: uint32, 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 CALLBACK_GUI_BUTTON_PRESSED callback is triggered periodically. A value of 0 turns the callback off.

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

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

New in version 2.0.2 (Plugin).

BrickletLCD128x64.get_gui_button_pressed_callback_configuration
Function ID:
  • 23
Request:
  • empty payload
Response:
  • period – Type: uint32, 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).

BrickletLCD128x64.set_gui_slider_value_callback_configuration
Function ID:
  • 29
Request:
  • period – Type: uint32, 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 CALLBACK_GUI_SLIDER_VALUE callback is triggered periodically. A value of 0 turns the callback off.

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

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

New in version 2.0.2 (Plugin).

BrickletLCD128x64.get_gui_slider_value_callback_configuration
Function ID:
  • 30
Request:
  • empty payload
Response:
  • period – Type: uint32, 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).

BrickletLCD128x64.set_gui_tab_selected_callback_configuration
Function ID:
  • 41
Request:
  • period – Type: uint32, 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 CALLBACK_GUI_TAB_SELECTED callback is triggered periodically. A value of 0 turns the callback off.

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

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

New in version 2.0.2 (Plugin).

BrickletLCD128x64.get_gui_tab_selected_callback_configuration
Function ID:
  • 42
Request:
  • empty payload
Response:
  • period – Type: uint32, 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

BrickletLCD128x64.CALLBACK_TOUCH_POSITION
Function ID:
  • 11
Response:
  • pressure – Type: uint16, Range: [0 to 300]
  • x – Type: uint16, Range: [0 to 127]
  • y – Type: uint16, Range: [0 to 63]
  • age – Type: uint32, 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 response values are the same as for get_touch_position.

BrickletLCD128x64.CALLBACK_TOUCH_GESTURE
Function ID:
  • 15
Response:
  • gesture – Type: uint8, Range: See meanings
  • duration – Type: uint32, Unit: 1 ms, Range: [0 to 232 - 1]
  • pressure_max – Type: uint16, Range: [0 to 300]
  • x_start – Type: uint16, Range: [0 to 127]
  • y_start – Type: uint16, Range: [0 to 63]
  • x_end – Type: uint16, Range: [0 to 127]
  • y_end – Type: uint16, Range: [0 to 63]
  • age – Type: uint32, 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 response values are the same as for get_touch_gesture.

The following meanings are defined for the elements of this function:

For gesture:

  • 0 = Left To Right
  • 1 = Right To Left
  • 2 = Top To Bottom
  • 3 = Bottom To Top
BrickletLCD128x64.CALLBACK_GUI_BUTTON_PRESSED
Function ID:
  • 25
Response:
  • index – Type: uint8, 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 response values are the same as for get_gui_button_pressed.

New in version 2.0.2 (Plugin).

BrickletLCD128x64.CALLBACK_GUI_SLIDER_VALUE
Function ID:
  • 32
Response:
  • index – Type: uint8, Range: [0 to 5]
  • value – Type: uint8, Range: [0 to 120]

This callback is triggered periodically with the period that is set by set_gui_slider_value_callback_configuration. The response values are the same as for get_gui_slider_value.

New in version 2.0.2 (Plugin).

BrickletLCD128x64.CALLBACK_GUI_TAB_SELECTED
Function ID:
  • 44
Response:
  • index – Type: int8, Range: [0 to 9]

This callback is triggered periodically with the period that is set by set_gui_tab_selected_callback_configuration. The response values are the same as for get_gui_tab_selected.

New in version 2.0.2 (Plugin).