Deutsch
English
Menu

C/C++ for Microcontrollers - LCD 128x64 Bricklet

This is the description of the C/C++ for Microcontrollers 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 C/C++ for Microcontrollers API bindings is part of their general description.

Examples

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

Hello World

Download (example_hello_world.c)

 1// This example is not self-contained.
 2// It requires usage of the example driver specific to your platform.
 3// See the HAL documentation.
 4
 5#include "src/bindings/hal_common.h"
 6#include "src/bindings/bricklet_lcd_128x64.h"
 7
 8void check(int rc, const char *msg);
 9void example_setup(TF_HAL *hal);
10void example_loop(TF_HAL *hal);
11
12static TF_LCD128x64 lcd;
13
14void example_setup(TF_HAL *hal) {
15    // Create device object
16    check(tf_lcd_128x64_create(&lcd, NULL, hal), "create device object");
17
18    // Clear display
19    check(tf_lcd_128x64_clear_display(&lcd), "call clear_display");
20
21    // Write "Hello World" starting from upper left corner of the screen
22    check(tf_lcd_128x64_write_line(&lcd, 0, 0, "Hello World"), "call write_line");
23}
24
25void example_loop(TF_HAL *hal) {
26    // Poll for callbacks
27    tf_hal_callback_tick(hal, 0);
28}

Big Font

Download (example_big_font.c)

 1// This example is not self-contained.
 2// It requires usage of the example driver specific to your platform.
 3// See the HAL documentation.
 4
 5#include "src/bindings/hal_common.h"
 6#include "src/bindings/bricklet_lcd_128x64.h"
 7
 8void check(int rc, const char *msg);
 9void example_setup(TF_HAL *hal);
10void example_loop(TF_HAL *hal);
11
12static TF_LCD128x64 lcd;
13
14void example_setup(TF_HAL *hal) {
15    // Create device object
16    check(tf_lcd_128x64_create(&lcd, NULL, hal), "create device object");
17
18    // Clear display
19    check(tf_lcd_128x64_clear_display(&lcd), "call clear_display");
20
21    // Write "Hello World" with big 24x32 font
22    check(tf_lcd_128x64_draw_text(&lcd, 0, 0, TF_LCD_128X64_FONT_24X32,
23                                  TF_LCD_128X64_COLOR_BLACK, "24x32"), "call draw_text");
24}
25
26void example_loop(TF_HAL *hal) {
27    // Poll for callbacks
28    tf_hal_callback_tick(hal, 0);
29}

Touch

Download (example_touch.c)

 1// This example is not self-contained.
 2// It requires usage of the example driver specific to your platform.
 3// See the HAL documentation.
 4
 5#include "src/bindings/hal_common.h"
 6#include "src/bindings/bricklet_lcd_128x64.h"
 7
 8void check(int rc, const char *msg);
 9void example_setup(TF_HAL *hal);
10void example_loop(TF_HAL *hal);
11
12// Callback function for touch position callback
13static void touch_position_handler(TF_LCD128x64 *device, uint16_t pressure, uint16_t x,
14                                   uint16_t y, uint32_t age, void *user_data) {
15    (void)device; (void)user_data; // avoid unused parameter warning
16
17    tf_hal_printf("Pressure: %I16u\n", pressure);
18    tf_hal_printf("X: %I16u\n", x);
19    tf_hal_printf("Y: %I16u\n", y);
20    tf_hal_printf("Age: %I32u\n", age);
21    tf_hal_printf("\n");
22}
23
24// Callback function for touch gesture callback
25static void touch_gesture_handler(TF_LCD128x64 *device, uint8_t gesture,
26                                  uint32_t duration, uint16_t pressure_max,
27                                  uint16_t x_start, uint16_t x_end, uint16_t y_start,
28                                  uint16_t y_end, uint32_t age, void *user_data) {
29    (void)device; (void)user_data; // avoid unused parameter warning
30
31    if (gesture == TF_LCD_128X64_GESTURE_LEFT_TO_RIGHT) {
32        tf_hal_printf("Gesture: Left To Right\n");
33    } else if (gesture == TF_LCD_128X64_GESTURE_RIGHT_TO_LEFT) {
34        tf_hal_printf("Gesture: Right To Left\n");
35    } else if (gesture == TF_LCD_128X64_GESTURE_TOP_TO_BOTTOM) {
36        tf_hal_printf("Gesture: Top To Bottom\n");
37    } else if (gesture == TF_LCD_128X64_GESTURE_BOTTOM_TO_TOP) {
38        tf_hal_printf("Gesture: Bottom To Top\n");
39    }
40
41    tf_hal_printf("Duration: %I32u\n", duration);
42    tf_hal_printf("Pressure Max: %I16u\n", pressure_max);
43    tf_hal_printf("X Start: %I16u\n", x_start);
44    tf_hal_printf("X End: %I16u\n", x_end);
45    tf_hal_printf("Y Start: %I16u\n", y_start);
46    tf_hal_printf("Y End: %I16u\n", y_end);
47    tf_hal_printf("Age: %I32u\n", age);
48    tf_hal_printf("\n");
49}
50
51static TF_LCD128x64 lcd;
52
53void example_setup(TF_HAL *hal) {
54    // Create device object
55    check(tf_lcd_128x64_create(&lcd, NULL, hal), "create device object");
56
57    // Register touch position callback to function touch_position_handler
58    tf_lcd_128x64_register_touch_position_callback(&lcd,
59                                                   touch_position_handler,
60                                                   NULL);
61
62    // Register touch gesture callback to function touch_gesture_handler
63    tf_lcd_128x64_register_touch_gesture_callback(&lcd,
64                                                  touch_gesture_handler,
65                                                  NULL);
66
67    // Set period for touch position callback to 0.1s (100ms)
68    tf_lcd_128x64_set_touch_position_callback_configuration(&lcd, 100, true);
69
70    // Set period for touch gesture callback to 0.1s (100ms)
71    tf_lcd_128x64_set_touch_gesture_callback_configuration(&lcd, 100, true);
72}
73
74void example_loop(TF_HAL *hal) {
75    // Poll for callbacks
76    tf_hal_callback_tick(hal, 0);
77}

Gui

Download (example_gui.c)

  1// This example is not self-contained.
  2// It requires usage of the example driver specific to your platform.
  3// See the HAL documentation.
  4
  5#include "src/bindings/hal_common.h"
  6#include "src/bindings/bricklet_lcd_128x64.h"
  7
  8void check(int rc, const char *msg);
  9void example_setup(TF_HAL *hal);
 10void example_loop(TF_HAL *hal);
 11
 12// Callback function for GUI button pressed callback
 13static void gui_button_pressed_handler(TF_LCD128x64 *device, uint8_t index, bool pressed,
 14                                       void *user_data) {
 15    (void)device; (void)user_data; // avoid unused parameter warning
 16
 17    tf_hal_printf("Index: %I8u\n", index);
 18    tf_hal_printf("Pressed: %s\n", pressed ? "true" : "false");
 19    tf_hal_printf("\n");
 20}
 21
 22// Callback function for GUI slider value callback
 23static void gui_slider_value_handler(TF_LCD128x64 *device, uint8_t index, uint8_t value,
 24                                     void *user_data) {
 25    (void)device; (void)user_data; // avoid unused parameter warning
 26
 27    tf_hal_printf("Index: %I8u\n", index);
 28    tf_hal_printf("Value: %I8u\n", value);
 29    tf_hal_printf("\n");
 30}
 31
 32// Callback function for GUI tab selected callback
 33static void gui_tab_selected_handler(TF_LCD128x64 *device, int8_t index,
 34                                     void *user_data) {
 35    (void)device; (void)user_data; // avoid unused parameter warning
 36
 37    tf_hal_printf("Index: %I8d\n", index);
 38}
 39
 40static TF_LCD128x64 lcd;
 41
 42void example_setup(TF_HAL *hal) {
 43    // Create device object
 44    check(tf_lcd_128x64_create(&lcd, NULL, hal), "create device object");
 45
 46    // Register GUI button pressed callback to function gui_button_pressed_handler
 47    tf_lcd_128x64_register_gui_button_pressed_callback(&lcd,
 48                                                       gui_button_pressed_handler,
 49                                                       NULL);
 50
 51    // Register GUI slider value callback to function gui_slider_value_handler
 52    tf_lcd_128x64_register_gui_slider_value_callback(&lcd,
 53                                                     gui_slider_value_handler,
 54                                                     NULL);
 55
 56    // Register GUI tab selected callback to function gui_tab_selected_handler
 57    tf_lcd_128x64_register_gui_tab_selected_callback(&lcd,
 58                                                     gui_tab_selected_handler,
 59                                                     NULL);
 60
 61    // Clear display
 62    check(tf_lcd_128x64_clear_display(&lcd), "call clear_display");
 63    check(tf_lcd_128x64_remove_all_gui(&lcd), "call remove_all_gui");
 64
 65    // Add GUI elements: Button, Slider and Graph with 60 data points
 66    check(tf_lcd_128x64_set_gui_button(&lcd, 0, 0, 0, 60, 20,
 67                                       "button"), "call set_gui_button");
 68    check(tf_lcd_128x64_set_gui_slider(&lcd, 0, 0, 30, 60,
 69                                       TF_LCD_128X64_DIRECTION_HORIZONTAL,
 70                                       50), "call set_gui_slider");
 71    check(tf_lcd_128x64_set_gui_graph_configuration(&lcd, 0,
 72                                                    TF_LCD_128X64_GRAPH_TYPE_LINE, 62, 0,
 73                                                    60, 52, "X",
 74                                                    "Y"), "call set_gui_graph_configuration");
 75
 76    // Add a few data points (the remaining points will be 0)
 77    uint8_t data[12] = {20, 40, 60, 80, 100, 120, 140, 160, 180, 200, 220, 240};
 78    check(tf_lcd_128x64_set_gui_graph_data(&lcd, 0, data, 12), "call set_gui_graph_data");
 79
 80    // Add 5 text tabs without and configure it for click and swipe without auto-redraw
 81    check(tf_lcd_128x64_set_gui_tab_configuration(&lcd,
 82                                                  TF_LCD_128X64_CHANGE_TAB_ON_CLICK_AND_SWIPE,
 83                                                  false), "call set_gui_tab_configuration");
 84    check(tf_lcd_128x64_set_gui_tab_text(&lcd, 0, "Tab A"), "call set_gui_tab_text");
 85    check(tf_lcd_128x64_set_gui_tab_text(&lcd, 1, "Tab B"), "call set_gui_tab_text");
 86    check(tf_lcd_128x64_set_gui_tab_text(&lcd, 2, "Tab C"), "call set_gui_tab_text");
 87    check(tf_lcd_128x64_set_gui_tab_text(&lcd, 3, "Tab D"), "call set_gui_tab_text");
 88    check(tf_lcd_128x64_set_gui_tab_text(&lcd, 4, "Tab E"), "call set_gui_tab_text");
 89
 90    // Set period for GUI button pressed callback to 0.1s (100ms)
 91    tf_lcd_128x64_set_gui_button_pressed_callback_configuration(&lcd, 100, true);
 92
 93    // Set period for GUI slider value callback to 0.1s (100ms)
 94    tf_lcd_128x64_set_gui_slider_value_callback_configuration(&lcd, 100, true);
 95
 96    // Set period for GUI tab selected callback to 0.1s (100ms)
 97    tf_lcd_128x64_set_gui_tab_selected_callback_configuration(&lcd, 100, true);
 98}
 99
100void example_loop(TF_HAL *hal) {
101    // Poll for callbacks
102    tf_hal_callback_tick(hal, 0);
103}

API

Most functions of the C/C++ bindings for microcontrollers return an error code (e_code).

Possible error codes are:

  • TF_E\ _OK = 0

  • TF_E\ _TIMEOUT = -1

  • TF_E\ _INVALID_PARAMETER = -2

  • TF_E\ _NOT_SUPPORTED = -3

  • TF_E\ _UNKNOWN_ERROR_CODE = -4

  • TF_E\ _STREAM_OUT_OF_SYNC = -5

  • TF_E\ _INVALID_CHAR_IN_UID = -6

  • TF_E\ _UID_TOO_LONG = -7

  • TF_E\ _UID_OVERFLOW = -8

  • TF_E\ _TOO_MANY_DEVICES = -9

  • TF_E\ _DEVICE_NOT_FOUND = -10

  • TF_E\ _WRONG_DEVICE_TYPE = -11

  • TF_E\ _LOCKED = -12

  • TF_E\ _PORT_NOT_FOUND = -13

(as defined in errors.h) as well as the errors returned from the hardware abstraction layer (HAL) that is used.

Use :cpp:func`tf_hal_strerror` (defined in the HAL's header file) to get an error string for an error code.

Data returned from the device, when a getter is called, is handled via output parameters. These parameters are labeled with the ret_ prefix. The bindings will not write to an output parameter if NULL or nullptr is passed. This can be used to ignore outputs that you are not interested in.

None of the functions listed below are thread-safe. See the API bindings description for details.

Basic Functions

int tf_lcd_128x64_create(TF_LCD128x64 *lcd_128x64, const char *uid_or_port_name, TF_HAL *hal)
Parameters:
  • lcd_128x64 – Type: TF_LCD128x64 *
  • uid – Type: const char *
  • hal – Type: TF_HAL *
Returns:
  • e_code – Type: int

Creates the device object lcd_128x64 with the optional unique device ID or port name uid_or_port_name and adds it to the HAL hal:

TF_LCD128x64 lcd_128x64;
tf_lcd_128x64_create(&lcd_128x64, NULL, &hal);

Normally uid_or_port_name can stay NULL. For more details about this see section UID or Port Name.

int tf_lcd_128x64_destroy(TF_LCD128x64 *lcd_128x64)
Parameters:
  • lcd_128x64 – Type: TF_LCD128x64 *
Returns:
  • e_code – Type: int

Removes the device object lcd_128x64 from its HAL and destroys it. The device object cannot be used anymore afterwards.

int tf_lcd_128x64_write_pixels(TF_LCD128x64 *lcd_128x64, uint8_t x_start, uint8_t y_start, uint8_t x_end, uint8_t y_end, const bool *pixels, uint16_t pixels_length)
Parameters:
  • lcd_128x64 – Type: TF_LCD128x64 *
  • x_start – Type: uint8_t, Range: [0 to 127]
  • y_start – Type: uint8_t, Range: [0 to 63]
  • x_end – Type: uint8_t, Range: [0 to 127]
  • y_end – Type: uint8_t, Range: [0 to 63]
  • pixels – Type: const bool *
  • pixels_length – Type: uint16_t
Returns:
  • e_code – Type: int

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 tf_lcd_128x64_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 tf_lcd_128x64_set_display_configuration() function.

int tf_lcd_128x64_read_pixels(TF_LCD128x64 *lcd_128x64, uint8_t x_start, uint8_t y_start, uint8_t x_end, uint8_t y_end, bool *ret_pixels, uint16_t *ret_pixels_length)
Parameters:
  • lcd_128x64 – Type: TF_LCD128x64 *
  • x_start – Type: uint8_t, Range: [0 to 127]
  • y_start – Type: uint8_t, Range: [0 to 63]
  • x_end – Type: uint8_t, Range: [0 to 127]
  • y_end – Type: uint8_t, Range: [0 to 63]
Output Parameters:
  • ret_pixels – Type: bool *
  • ret_pixels_length – Type: uint16_t
Returns:
  • e_code – Type: int

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

Automatic draw can be configured with the tf_lcd_128x64_set_display_configuration() function.

int tf_lcd_128x64_clear_display(TF_LCD128x64 *lcd_128x64)
Parameters:
  • lcd_128x64 – Type: TF_LCD128x64 *
Returns:
  • e_code – Type: int

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 tf_lcd_128x64_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 tf_lcd_128x64_set_display_configuration() function.

int tf_lcd_128x64_write_line(TF_LCD128x64 *lcd_128x64, uint8_t line, uint8_t position, const char *text)
Parameters:
  • lcd_128x64 – Type: TF_LCD128x64 *
  • line – Type: uint8_t, Range: [0 to 7]
  • position – Type: uint8_t, Range: [0 to 21]
  • text – Type: const char[22]
Returns:
  • e_code – Type: int

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 tf_lcd_128x64_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 tf_lcd_128x64_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 tf_lcd_128x64_draw_text() function.

int tf_lcd_128x64_draw_buffered_frame(TF_LCD128x64 *lcd_128x64, bool force_complete_redraw)
Parameters:
  • lcd_128x64 – Type: TF_LCD128x64 *
  • force_complete_redraw – Type: bool
Returns:
  • e_code – Type: int

Draws the currently buffered frame. Normally each call of tf_lcd_128x64_write_pixels() and tf_lcd_128x64_write_line() draws directly onto the display. If you turn automatic draw off (tf_lcd_128x64_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.

int tf_lcd_128x64_get_touch_position(TF_LCD128x64 *lcd_128x64, uint16_t *ret_pressure, uint16_t *ret_x, uint16_t *ret_y, uint32_t *ret_age)
Parameters:
  • lcd_128x64 – Type: TF_LCD128x64 *
Output Parameters:
  • ret_pressure – Type: uint16_t, Range: [0 to 300]
  • ret_x – Type: uint16_t, Range: [0 to 127]
  • ret_y – Type: uint16_t, Range: [0 to 63]
  • ret_age – Type: uint32_t, Unit: 1 ms, Range: [0 to 232 - 1]
Returns:
  • e_code – Type: int

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)

int tf_lcd_128x64_get_touch_gesture(TF_LCD128x64 *lcd_128x64, uint8_t *ret_gesture, uint32_t *ret_duration, uint16_t *ret_pressure_max, uint16_t *ret_x_start, uint16_t *ret_y_start, uint16_t *ret_x_end, uint16_t *ret_y_end, uint32_t *ret_age)
Parameters:
  • lcd_128x64 – Type: TF_LCD128x64 *
Output Parameters:
  • ret_gesture – Type: uint8_t, Range: See constants
  • ret_duration – Type: uint32_t, Unit: 1 ms, Range: [0 to 232 - 1]
  • ret_pressure_max – Type: uint16_t, Range: [0 to 300]
  • ret_x_start – Type: uint16_t, Range: [0 to 127]
  • ret_y_start – Type: uint16_t, Range: [0 to 63]
  • ret_x_end – Type: uint16_t, Range: [0 to 127]
  • ret_y_end – Type: uint16_t, Range: [0 to 63]
  • ret_age – Type: uint32_t, Unit: 1 ms, Range: [0 to 232 - 1]
Returns:
  • e_code – Type: int

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

For ret_gesture:

  • TF_LCD_128X64_GESTURE_LEFT_TO_RIGHT = 0

  • TF_LCD_128X64_GESTURE_RIGHT_TO_LEFT = 1

  • TF_LCD_128X64_GESTURE_TOP_TO_BOTTOM = 2

  • TF_LCD_128X64_GESTURE_BOTTOM_TO_TOP = 3

int tf_lcd_128x64_draw_line(TF_LCD128x64 *lcd_128x64, uint8_t position_x_start, uint8_t position_y_start, uint8_t position_x_end, uint8_t position_y_end, bool color)
Parameters:
  • lcd_128x64 – Type: TF_LCD128x64 *
  • position_x_start – Type: uint8_t, Range: [0 to 127]
  • position_y_start – Type: uint8_t, Range: [0 to 63]
  • position_x_end – Type: uint8_t, Range: [0 to 127]
  • position_y_end – Type: uint8_t, Range: [0 to 63]
  • color – Type: bool
Returns:
  • e_code – Type: int

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

The following constants are available for this function:

For color:

  • TF_LCD_128X64_COLOR_WHITE = false

  • TF_LCD_128X64_COLOR_BLACK = true

Added in version 2.0.2$nbsp;(Plugin).

int tf_lcd_128x64_draw_box(TF_LCD128x64 *lcd_128x64, uint8_t position_x_start, uint8_t position_y_start, uint8_t position_x_end, uint8_t position_y_end, bool fill, bool color)
Parameters:
  • lcd_128x64 – Type: TF_LCD128x64 *
  • position_x_start – Type: uint8_t, Range: [0 to 127]
  • position_y_start – Type: uint8_t, Range: [0 to 63]
  • position_x_end – Type: uint8_t, Range: [0 to 127]
  • position_y_end – Type: uint8_t, Range: [0 to 63]
  • fill – Type: bool
  • color – Type: bool
Returns:
  • e_code – Type: int

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

For color:

  • TF_LCD_128X64_COLOR_WHITE = false

  • TF_LCD_128X64_COLOR_BLACK = true

Added in version 2.0.2$nbsp;(Plugin).

int tf_lcd_128x64_draw_text(TF_LCD128x64 *lcd_128x64, uint8_t position_x, uint8_t position_y, uint8_t font, bool color, const char *text)
Parameters:
  • lcd_128x64 – Type: TF_LCD128x64 *
  • position_x – Type: uint8_t, Range: [0 to 127]
  • position_y – Type: uint8_t, Range: [0 to 63]
  • font – Type: uint8_t, Range: See constants
  • color – Type: bool
  • text – Type: const char[22]
Returns:
  • e_code – Type: int

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

For font:

  • TF_LCD_128X64_FONT_6X8 = 0

  • TF_LCD_128X64_FONT_6X16 = 1

  • TF_LCD_128X64_FONT_6X24 = 2

  • TF_LCD_128X64_FONT_6X32 = 3

  • TF_LCD_128X64_FONT_12X16 = 4

  • TF_LCD_128X64_FONT_12X24 = 5

  • TF_LCD_128X64_FONT_12X32 = 6

  • TF_LCD_128X64_FONT_18X24 = 7

  • TF_LCD_128X64_FONT_18X32 = 8

  • TF_LCD_128X64_FONT_24X32 = 9

For color:

  • TF_LCD_128X64_COLOR_WHITE = false

  • TF_LCD_128X64_COLOR_BLACK = true

Added in version 2.0.2$nbsp;(Plugin).

int tf_lcd_128x64_set_gui_button(TF_LCD128x64 *lcd_128x64, uint8_t index, uint8_t position_x, uint8_t position_y, uint8_t width, uint8_t height, const char *text)
Parameters:
  • lcd_128x64 – Type: TF_LCD128x64 *
  • index – Type: uint8_t, Range: [0 to 11]
  • position_x – Type: uint8_t, Range: [0 to 127]
  • position_y – Type: uint8_t, Range: [0 to 63]
  • width – Type: uint8_t, Range: [1 to 128]
  • height – Type: uint8_t, Range: [1 to 64]
  • text – Type: const char[16]
Returns:
  • e_code – Type: int

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 tf_lcd_128x64_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 tf_lcd_128x64_write_pixels(). To remove the button use tf_lcd_128x64_remove_gui_button().

If you want an icon instead of text, you can draw the icon inside of the button with tf_lcd_128x64_write_pixels().

Added in version 2.0.2$nbsp;(Plugin).

int tf_lcd_128x64_get_gui_button(TF_LCD128x64 *lcd_128x64, uint8_t index, bool *ret_active, uint8_t *ret_position_x, uint8_t *ret_position_y, uint8_t *ret_width, uint8_t *ret_height, char ret_text[16])
Parameters:
  • lcd_128x64 – Type: TF_LCD128x64 *
  • index – Type: uint8_t, Range: [0 to 11]
Output Parameters:
  • ret_active – Type: bool
  • ret_position_x – Type: uint8_t, Range: [0 to 127]
  • ret_position_y – Type: uint8_t, Range: [0 to 63]
  • ret_width – Type: uint8_t, Range: [1 to 128]
  • ret_height – Type: uint8_t, Range: [1 to 64]
  • ret_text – Type: char[16]
Returns:
  • e_code – Type: int

Returns the button properties for a given Index as set by tf_lcd_128x64_set_gui_button().

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

Added in version 2.0.2$nbsp;(Plugin).

int tf_lcd_128x64_remove_gui_button(TF_LCD128x64 *lcd_128x64, uint8_t index)
Parameters:
  • lcd_128x64 – Type: TF_LCD128x64 *
  • index – Type: uint8_t, Range: [0 to 11, 255]
Returns:
  • e_code – Type: int

Removes the button with the given index.

You can use index 255 to remove all buttons.

Added in version 2.0.2$nbsp;(Plugin).

int tf_lcd_128x64_get_gui_button_pressed(TF_LCD128x64 *lcd_128x64, uint8_t index, bool *ret_pressed)
Parameters:
  • lcd_128x64 – Type: TF_LCD128x64 *
  • index – Type: uint8_t, Range: [0 to 11]
Output Parameters:
  • ret_pressed – Type: bool
Returns:
  • e_code – Type: int

Returns the state of the button for the given index.

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

Added in version 2.0.2$nbsp;(Plugin).

int tf_lcd_128x64_set_gui_slider(TF_LCD128x64 *lcd_128x64, uint8_t index, uint8_t position_x, uint8_t position_y, uint8_t length, uint8_t direction, uint8_t value)
Parameters:
  • lcd_128x64 – Type: TF_LCD128x64 *
  • index – Type: uint8_t, Range: [0 to 5]
  • position_x – Type: uint8_t, Range: [0 to 128]
  • position_y – Type: uint8_t, Range: [0 to 64]
  • length – Type: uint8_t, Range: [8 to 128]
  • direction – Type: uint8_t, Range: See constants
  • value – Type: uint8_t, Range: [0 to 120]
Returns:
  • e_code – Type: int

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 tf_lcd_128x64_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 tf_lcd_128x64_write_pixels(). To remove the button use tf_lcd_128x64_remove_gui_slider().

The following constants are available for this function:

For direction:

  • TF_LCD_128X64_DIRECTION_HORIZONTAL = 0

  • TF_LCD_128X64_DIRECTION_VERTICAL = 1

Added in version 2.0.2$nbsp;(Plugin).

int tf_lcd_128x64_get_gui_slider(TF_LCD128x64 *lcd_128x64, uint8_t index, bool *ret_active, uint8_t *ret_position_x, uint8_t *ret_position_y, uint8_t *ret_length, uint8_t *ret_direction, uint8_t *ret_value)
Parameters:
  • lcd_128x64 – Type: TF_LCD128x64 *
  • index – Type: uint8_t, Range: [0 to 5]
Output Parameters:
  • ret_active – Type: bool
  • ret_position_x – Type: uint8_t, Range: [0 to 128]
  • ret_position_y – Type: uint8_t, Range: [0 to 64]
  • ret_length – Type: uint8_t, Range: [8 to 128]
  • ret_direction – Type: uint8_t, Range: See constants
  • ret_value – Type: uint8_t, Range: [0 to 120]
Returns:
  • e_code – Type: int

Returns the slider properties for a given Index as set by tf_lcd_128x64_set_gui_slider().

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

The following constants are available for this function:

For ret_direction:

  • TF_LCD_128X64_DIRECTION_HORIZONTAL = 0

  • TF_LCD_128X64_DIRECTION_VERTICAL = 1

Added in version 2.0.2$nbsp;(Plugin).

int tf_lcd_128x64_remove_gui_slider(TF_LCD128x64 *lcd_128x64, uint8_t index)
Parameters:
  • lcd_128x64 – Type: TF_LCD128x64 *
  • index – Type: uint8_t, Range: [0 to 5, 255]
Returns:
  • e_code – Type: int

Removes the slider with the given index.

You can use index 255 to remove all slider.

Added in version 2.0.2$nbsp;(Plugin).

int tf_lcd_128x64_get_gui_slider_value(TF_LCD128x64 *lcd_128x64, uint8_t index, uint8_t *ret_value)
Parameters:
  • lcd_128x64 – Type: TF_LCD128x64 *
  • index – Type: uint8_t, Range: [0 to 5]
Output Parameters:
  • ret_value – Type: uint8_t, Range: [0 to 120]
Returns:
  • e_code – Type: int

Returns the current slider value for the given index.

Added in version 2.0.2$nbsp;(Plugin).

int tf_lcd_128x64_set_gui_tab_configuration(TF_LCD128x64 *lcd_128x64, uint8_t change_tab_config, bool clear_gui)
Parameters:
  • lcd_128x64 – Type: TF_LCD128x64 *
  • change_tab_config – Type: uint8_t, Range: See constants, Default: 3
  • clear_gui – Type: bool, Default: true
Returns:
  • e_code – Type: int

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

For change_tab_config:

  • TF_LCD_128X64_CHANGE_TAB_ON_CLICK = 1

  • TF_LCD_128X64_CHANGE_TAB_ON_SWIPE = 2

  • TF_LCD_128X64_CHANGE_TAB_ON_CLICK_AND_SWIPE = 3

Added in version 2.0.2$nbsp;(Plugin).

int tf_lcd_128x64_get_gui_tab_configuration(TF_LCD128x64 *lcd_128x64, uint8_t *ret_change_tab_config, bool *ret_clear_gui)
Parameters:
  • lcd_128x64 – Type: TF_LCD128x64 *
Output Parameters:
  • ret_change_tab_config – Type: uint8_t, Range: See constants, Default: 3
  • ret_clear_gui – Type: bool, Default: true
Returns:
  • e_code – Type: int

Returns the tab configuration as set by tf_lcd_128x64_set_gui_tab_configuration().

The following constants are available for this function:

For ret_change_tab_config:

  • TF_LCD_128X64_CHANGE_TAB_ON_CLICK = 1

  • TF_LCD_128X64_CHANGE_TAB_ON_SWIPE = 2

  • TF_LCD_128X64_CHANGE_TAB_ON_CLICK_AND_SWIPE = 3

Added in version 2.0.2$nbsp;(Plugin).

int tf_lcd_128x64_set_gui_tab_text(TF_LCD128x64 *lcd_128x64, uint8_t index, const char *text)
Parameters:
  • lcd_128x64 – Type: TF_LCD128x64 *
  • index – Type: uint8_t, Range: [0 to 9]
  • text – Type: const char[5]
Returns:
  • e_code – Type: int

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.

Added in version 2.0.2$nbsp;(Plugin).

int tf_lcd_128x64_get_gui_tab_text(TF_LCD128x64 *lcd_128x64, uint8_t index, bool *ret_active, char ret_text[5])
Parameters:
  • lcd_128x64 – Type: TF_LCD128x64 *
  • index – Type: uint8_t, Range: [0 to 9]
Output Parameters:
  • ret_active – Type: bool
  • ret_text – Type: char[5]
Returns:
  • e_code – Type: int

Returns the text for a given index as set by tf_lcd_128x64_set_gui_tab_text().

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

Added in version 2.0.2$nbsp;(Plugin).

int tf_lcd_128x64_set_gui_tab_icon(TF_LCD128x64 *lcd_128x64, uint8_t index, const bool icon[168])
Parameters:
  • lcd_128x64 – Type: TF_LCD128x64 *
  • index – Type: uint8_t, Range: [0 to 9]
  • icon – Type: const bool[168]
Returns:
  • e_code – Type: int

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.

Added in version 2.0.2$nbsp;(Plugin).

int tf_lcd_128x64_get_gui_tab_icon(TF_LCD128x64 *lcd_128x64, uint8_t index, bool *ret_active, bool ret_icon[168])
Parameters:
  • lcd_128x64 – Type: TF_LCD128x64 *
  • index – Type: uint8_t, Range: [0 to 9]
Output Parameters:
  • ret_active – Type: bool
  • ret_icon – Type: bool[168]
Returns:
  • e_code – Type: int

Returns the icon for a given index as set by tf_lcd_128x64_set_gui_tab_icon().

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

Added in version 2.0.2$nbsp;(Plugin).

int tf_lcd_128x64_remove_gui_tab(TF_LCD128x64 *lcd_128x64, uint8_t index)
Parameters:
  • lcd_128x64 – Type: TF_LCD128x64 *
  • index – Type: uint8_t, Range: [0 to 9, 255]
Returns:
  • e_code – Type: int

Removes the tab with the given index.

You can use index 255 to remove all tabs.

Added in version 2.0.2$nbsp;(Plugin).

int tf_lcd_128x64_set_gui_tab_selected(TF_LCD128x64 *lcd_128x64, uint8_t index)
Parameters:
  • lcd_128x64 – Type: TF_LCD128x64 *
  • index – Type: uint8_t, Range: [0 to 9]
Returns:
  • e_code – Type: int

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

Added in version 2.0.2$nbsp;(Plugin).

int tf_lcd_128x64_get_gui_tab_selected(TF_LCD128x64 *lcd_128x64, int8_t *ret_index)
Parameters:
  • lcd_128x64 – Type: TF_LCD128x64 *
Output Parameters:
  • ret_index – Type: int8_t, Range: [-1 to 9]
Returns:
  • e_code – Type: int

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

Added in version 2.0.2$nbsp;(Plugin).

int tf_lcd_128x64_set_gui_graph_configuration(TF_LCD128x64 *lcd_128x64, uint8_t index, uint8_t graph_type, uint8_t position_x, uint8_t position_y, uint8_t width, uint8_t height, const char *text_x, const char *text_y)
Parameters:
  • lcd_128x64 – Type: TF_LCD128x64 *
  • index – Type: uint8_t, Range: [0 to 3]
  • graph_type – Type: uint8_t, Range: See constants
  • position_x – Type: uint8_t, Range: [0 to 127]
  • position_y – Type: uint8_t, Range: [0 to 63]
  • width – Type: uint8_t, Range: [0 to 118]
  • height – Type: uint8_t, Range: [0 to 63]
  • text_x – Type: const char[4]
  • text_y – Type: const char[4]
Returns:
  • e_code – Type: int

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 tf_lcd_128x64_draw_text() to draw the caption outside of the graph.

The data of the graph can be set and updated with tf_lcd_128x64_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 tf_lcd_128x64_write_pixels(). To remove the graph use tf_lcd_128x64_remove_gui_graph().

The following constants are available for this function:

For graph_type:

  • TF_LCD_128X64_GRAPH_TYPE_DOT = 0

  • TF_LCD_128X64_GRAPH_TYPE_LINE = 1

  • TF_LCD_128X64_GRAPH_TYPE_BAR = 2

Added in version 2.0.2$nbsp;(Plugin).

int tf_lcd_128x64_get_gui_graph_configuration(TF_LCD128x64 *lcd_128x64, uint8_t index, bool *ret_active, uint8_t *ret_graph_type, uint8_t *ret_position_x, uint8_t *ret_position_y, uint8_t *ret_width, uint8_t *ret_height, char ret_text_x[4], char ret_text_y[4])
Parameters:
  • lcd_128x64 – Type: TF_LCD128x64 *
  • index – Type: uint8_t, Range: [0 to 3]
Output Parameters:
  • ret_active – Type: bool
  • ret_graph_type – Type: uint8_t, Range: See constants
  • ret_position_x – Type: uint8_t, Range: [0 to 127]
  • ret_position_y – Type: uint8_t, Range: [0 to 63]
  • ret_width – Type: uint8_t, Range: [0 to 118]
  • ret_height – Type: uint8_t, Range: [0 to 63]
  • ret_text_x – Type: char[4]
  • ret_text_y – Type: char[4]
Returns:
  • e_code – Type: int

Returns the graph properties for a given Index as set by tf_lcd_128x64_set_gui_graph_configuration().

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

The following constants are available for this function:

For ret_graph_type:

  • TF_LCD_128X64_GRAPH_TYPE_DOT = 0

  • TF_LCD_128X64_GRAPH_TYPE_LINE = 1

  • TF_LCD_128X64_GRAPH_TYPE_BAR = 2

Added in version 2.0.2$nbsp;(Plugin).

int tf_lcd_128x64_set_gui_graph_data(TF_LCD128x64 *lcd_128x64, uint8_t index, const uint8_t *data, uint16_t data_length)
Parameters:
  • lcd_128x64 – Type: TF_LCD128x64 *
  • index – Type: uint8_t, Range: [0 to 3]
  • data – Type: const uint8_t *, Range: [0 to 255]
  • data_length – Type: uint16_t
Returns:
  • e_code – Type: int

Sets the data for a graph with the given index. You have to configure the graph with tf_lcd_128x64_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 tf_lcd_128x64_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.

Added in version 2.0.2$nbsp;(Plugin).

int tf_lcd_128x64_get_gui_graph_data(TF_LCD128x64 *lcd_128x64, uint8_t index, uint8_t *ret_data, uint16_t *ret_data_length)
Parameters:
  • lcd_128x64 – Type: TF_LCD128x64 *
  • index – Type: uint8_t, Range: [0 to 3]
Output Parameters:
  • ret_data – Type: uint8_t *, Range: [0 to 255]
  • ret_data_length – Type: uint16_t
Returns:
  • e_code – Type: int

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

Added in version 2.0.2$nbsp;(Plugin).

int tf_lcd_128x64_remove_gui_graph(TF_LCD128x64 *lcd_128x64, uint8_t index)
Parameters:
  • lcd_128x64 – Type: TF_LCD128x64 *
  • index – Type: uint8_t, Range: [0 to 3, 255]
Returns:
  • e_code – Type: int

Removes the graph with the given index.

You can use index 255 to remove all graphs.

Added in version 2.0.2$nbsp;(Plugin).

int tf_lcd_128x64_remove_all_gui(TF_LCD128x64 *lcd_128x64)
Parameters:
  • lcd_128x64 – Type: TF_LCD128x64 *
Returns:
  • e_code – Type: int

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

Added in version 2.0.2$nbsp;(Plugin).

Advanced Functions

int tf_lcd_128x64_set_display_configuration(TF_LCD128x64 *lcd_128x64, uint8_t contrast, uint8_t backlight, bool invert, bool automatic_draw)
Parameters:
  • lcd_128x64 – Type: TF_LCD128x64 *
  • contrast – Type: uint8_t, Range: [0 to 63], Default: 14
  • backlight – Type: uint8_t, Range: [0 to 100], Default: 100
  • invert – Type: bool, Default: false
  • automatic_draw – Type: bool, Default: true
Returns:
  • e_code – Type: int

Sets the configuration of the display.

If automatic draw is set to true, the display is automatically updated with every call of tf_lcd_128x64_write_pixels() and tf_lcd_128x64_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 tf_lcd_128x64_draw_buffered_frame().

int tf_lcd_128x64_get_display_configuration(TF_LCD128x64 *lcd_128x64, uint8_t *ret_contrast, uint8_t *ret_backlight, bool *ret_invert, bool *ret_automatic_draw)
Parameters:
  • lcd_128x64 – Type: TF_LCD128x64 *
Output Parameters:
  • ret_contrast – Type: uint8_t, Range: [0 to 63], Default: 14
  • ret_backlight – Type: uint8_t, Range: [0 to 100], Default: 100
  • ret_invert – Type: bool, Default: false
  • ret_automatic_draw – Type: bool, Default: true
Returns:
  • e_code – Type: int

Returns the configuration as set by tf_lcd_128x64_set_display_configuration().

int tf_lcd_128x64_set_touch_led_config(TF_LCD128x64 *lcd_128x64, uint8_t config)
Parameters:
  • lcd_128x64 – Type: TF_LCD128x64 *
  • config – Type: uint8_t, Range: See constants, Default: 3
Returns:
  • e_code – Type: int

Sets the touch LED configuration. By default the LED is on if the LCD is touched.

You can also turn the LED permanently on/off or show a heartbeat.

If the Bricklet is in bootloader mode, the LED is off.

The following constants are available for this function:

For config:

  • TF_LCD_128X64_TOUCH_LED_CONFIG_OFF = 0

  • TF_LCD_128X64_TOUCH_LED_CONFIG_ON = 1

  • TF_LCD_128X64_TOUCH_LED_CONFIG_SHOW_HEARTBEAT = 2

  • TF_LCD_128X64_TOUCH_LED_CONFIG_SHOW_TOUCH = 3

Added in version 2.0.2$nbsp;(Plugin).

int tf_lcd_128x64_get_touch_led_config(TF_LCD128x64 *lcd_128x64, uint8_t *ret_config)
Parameters:
  • lcd_128x64 – Type: TF_LCD128x64 *
Output Parameters:
  • ret_config – Type: uint8_t, Range: See constants, Default: 3
Returns:
  • e_code – Type: int

Returns the configuration as set by tf_lcd_128x64_set_touch_led_config()

The following constants are available for this function:

For ret_config:

  • TF_LCD_128X64_TOUCH_LED_CONFIG_OFF = 0

  • TF_LCD_128X64_TOUCH_LED_CONFIG_ON = 1

  • TF_LCD_128X64_TOUCH_LED_CONFIG_SHOW_HEARTBEAT = 2

  • TF_LCD_128X64_TOUCH_LED_CONFIG_SHOW_TOUCH = 3

Added in version 2.0.2$nbsp;(Plugin).

int tf_lcd_128x64_get_spitfp_error_count(TF_LCD128x64 *lcd_128x64, uint32_t *ret_error_count_ack_checksum, uint32_t *ret_error_count_message_checksum, uint32_t *ret_error_count_frame, uint32_t *ret_error_count_overflow)
Parameters:
  • lcd_128x64 – Type: TF_LCD128x64 *
Output Parameters:
  • ret_error_count_ack_checksum – Type: uint32_t, Range: [0 to 232 - 1]
  • ret_error_count_message_checksum – Type: uint32_t, Range: [0 to 232 - 1]
  • ret_error_count_frame – Type: uint32_t, Range: [0 to 232 - 1]
  • ret_error_count_overflow – Type: uint32_t, Range: [0 to 232 - 1]
Returns:
  • e_code – Type: int

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.

int tf_lcd_128x64_set_status_led_config(TF_LCD128x64 *lcd_128x64, uint8_t config)
Parameters:
  • lcd_128x64 – Type: TF_LCD128x64 *
  • config – Type: uint8_t, Range: See constants, Default: 3
Returns:
  • e_code – Type: int

Sets the status LED configuration. By default the LED shows communication traffic between Brick and Bricklet, it flickers once for every 10 received data packets.

You can also turn the LED permanently on/off or show a heartbeat.

If the Bricklet is in bootloader mode, the LED is will show heartbeat by default.

The following constants are available for this function:

For config:

  • TF_LCD_128X64_STATUS_LED_CONFIG_OFF = 0

  • TF_LCD_128X64_STATUS_LED_CONFIG_ON = 1

  • TF_LCD_128X64_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2

  • TF_LCD_128X64_STATUS_LED_CONFIG_SHOW_STATUS = 3

int tf_lcd_128x64_get_status_led_config(TF_LCD128x64 *lcd_128x64, uint8_t *ret_config)
Parameters:
  • lcd_128x64 – Type: TF_LCD128x64 *
Output Parameters:
  • ret_config – Type: uint8_t, Range: See constants, Default: 3
Returns:
  • e_code – Type: int

Returns the configuration as set by tf_lcd_128x64_set_status_led_config()

The following constants are available for this function:

For ret_config:

  • TF_LCD_128X64_STATUS_LED_CONFIG_OFF = 0

  • TF_LCD_128X64_STATUS_LED_CONFIG_ON = 1

  • TF_LCD_128X64_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2

  • TF_LCD_128X64_STATUS_LED_CONFIG_SHOW_STATUS = 3

int tf_lcd_128x64_get_chip_temperature(TF_LCD128x64 *lcd_128x64, int16_t *ret_temperature)
Parameters:
  • lcd_128x64 – Type: TF_LCD128x64 *
Output Parameters:
  • ret_temperature – Type: int16_t, Unit: 1 °C, Range: [-215 to 215 - 1]
Returns:
  • e_code – Type: int

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.

int tf_lcd_128x64_reset(TF_LCD128x64 *lcd_128x64)
Parameters:
  • lcd_128x64 – Type: TF_LCD128x64 *
Returns:
  • e_code – Type: int

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!

int tf_lcd_128x64_get_identity(TF_LCD128x64 *lcd_128x64, char ret_uid[8], char ret_connected_uid[8], char *ret_position, uint8_t ret_hardware_version[3], uint8_t ret_firmware_version[3], uint16_t *ret_device_identifier)
Parameters:
  • lcd_128x64 – Type: TF_LCD128x64 *
Output Parameters:
  • ret_uid – Type: char[8]
  • ret_connected_uid – Type: char[8]
  • ret_position – Type: char, Range: ['a' to 'h', 'z']
  • ret_hardware_version – Type: uint8_t[3]
    • 0: major – Type: uint8_t, Range: [0 to 255]
    • 1: minor – Type: uint8_t, Range: [0 to 255]
    • 2: revision – Type: uint8_t, Range: [0 to 255]
  • ret_firmware_version – Type: uint8_t[3]
    • 0: major – Type: uint8_t, Range: [0 to 255]
    • 1: minor – Type: uint8_t, Range: [0 to 255]
    • 2: revision – Type: uint8_t, Range: [0 to 255]
  • ret_device_identifier – Type: uint16_t, Range: [0 to 216 - 1]
Returns:
  • e_code – Type: int

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. There is also a constant for the device identifier of this Bricklet.

Callback Configuration Functions

int tf_lcd_128x64_set_touch_position_callback_configuration(TF_LCD128x64 *lcd_128x64, uint32_t period, bool value_has_to_change)
Parameters:
  • lcd_128x64 – Type: TF_LCD128x64 *
  • period – Type: uint32_t, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • value_has_to_change – Type: bool, Default: false
Returns:
  • e_code – Type: int

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.

int tf_lcd_128x64_get_touch_position_callback_configuration(TF_LCD128x64 *lcd_128x64, uint32_t *ret_period, bool *ret_value_has_to_change)
Parameters:
  • lcd_128x64 – Type: TF_LCD128x64 *
Output Parameters:
  • ret_period – Type: uint32_t, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • ret_value_has_to_change – Type: bool, Default: false
Returns:
  • e_code – Type: int

Returns the callback configuration as set by tf_lcd_128x64_set_touch_position_callback_configuration().

int tf_lcd_128x64_set_touch_gesture_callback_configuration(TF_LCD128x64 *lcd_128x64, uint32_t period, bool value_has_to_change)
Parameters:
  • lcd_128x64 – Type: TF_LCD128x64 *
  • period – Type: uint32_t, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • value_has_to_change – Type: bool, Default: false
Returns:
  • e_code – Type: int

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.

int tf_lcd_128x64_get_touch_gesture_callback_configuration(TF_LCD128x64 *lcd_128x64, uint32_t *ret_period, bool *ret_value_has_to_change)
Parameters:
  • lcd_128x64 – Type: TF_LCD128x64 *
Output Parameters:
  • ret_period – Type: uint32_t, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • ret_value_has_to_change – Type: bool, Default: false
Returns:
  • e_code – Type: int

Returns the callback configuration as set by tf_lcd_128x64_set_touch_gesture_callback_configuration().

int tf_lcd_128x64_set_gui_button_pressed_callback_configuration(TF_LCD128x64 *lcd_128x64, uint32_t period, bool value_has_to_change)
Parameters:
  • lcd_128x64 – Type: TF_LCD128x64 *
  • period – Type: uint32_t, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • value_has_to_change – Type: bool, Default: false
Returns:
  • e_code – Type: int

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.

Added in version 2.0.2$nbsp;(Plugin).

int tf_lcd_128x64_get_gui_button_pressed_callback_configuration(TF_LCD128x64 *lcd_128x64, uint32_t *ret_period, bool *ret_value_has_to_change)
Parameters:
  • lcd_128x64 – Type: TF_LCD128x64 *
Output Parameters:
  • ret_period – Type: uint32_t, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • ret_value_has_to_change – Type: bool, Default: false
Returns:
  • e_code – Type: int

Returns the callback configuration as set by tf_lcd_128x64_set_gui_button_pressed_callback_configuration().

Added in version 2.0.2$nbsp;(Plugin).

int tf_lcd_128x64_set_gui_slider_value_callback_configuration(TF_LCD128x64 *lcd_128x64, uint32_t period, bool value_has_to_change)
Parameters:
  • lcd_128x64 – Type: TF_LCD128x64 *
  • period – Type: uint32_t, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • value_has_to_change – Type: bool, Default: false
Returns:
  • e_code – Type: int

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.

Added in version 2.0.2$nbsp;(Plugin).

int tf_lcd_128x64_get_gui_slider_value_callback_configuration(TF_LCD128x64 *lcd_128x64, uint32_t *ret_period, bool *ret_value_has_to_change)
Parameters:
  • lcd_128x64 – Type: TF_LCD128x64 *
Output Parameters:
  • ret_period – Type: uint32_t, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • ret_value_has_to_change – Type: bool, Default: false
Returns:
  • e_code – Type: int

Returns the callback configuration as set by tf_lcd_128x64_set_gui_slider_value_callback_configuration().

Added in version 2.0.2$nbsp;(Plugin).

int tf_lcd_128x64_set_gui_tab_selected_callback_configuration(TF_LCD128x64 *lcd_128x64, uint32_t period, bool value_has_to_change)
Parameters:
  • lcd_128x64 – Type: TF_LCD128x64 *
  • period – Type: uint32_t, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • value_has_to_change – Type: bool, Default: false
Returns:
  • e_code – Type: int

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.

Added in version 2.0.2$nbsp;(Plugin).

int tf_lcd_128x64_get_gui_tab_selected_callback_configuration(TF_LCD128x64 *lcd_128x64, uint32_t *ret_period, bool *ret_value_has_to_change)
Parameters:
  • lcd_128x64 – Type: TF_LCD128x64 *
Output Parameters:
  • ret_period – Type: uint32_t, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • ret_value_has_to_change – Type: bool, Default: false
Returns:
  • e_code – Type: int

Returns the callback configuration as set by tf_lcd_128x64_set_gui_tab_selected_callback_configuration().

Added in version 2.0.2$nbsp;(Plugin).

Callbacks

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done with the corresponding tf_lcd_128x64_register_*_callback function. The user_data passed to the registration function as well as the device that triggered the callback are passed to the registered callback handler.

Only one handler can be registered to a callback at the same time. To deregister a callback, call the tf_lcd_128x64_register_*_callback function with NULL as handler.

Note

Using callbacks for recurring events is preferred compared to using getters. Polling for a callback requires writing one byte only. See here Optimizing Performance.

Warning

Calling bindings function from inside a callback handler is not allowed. See here Thread safety.

int tf_lcd_128x64_register_touch_position_callback(TF_LCD128x64 *lcd_128x64, TF_LCD128x64_TouchPositionHandler handler, void *user_data)
void handler(TF_LCD128x64 *lcd_128x64, uint16_t pressure, uint16_t x, uint16_t y, uint32_t age, void *user_data)
Callback Parameters:
  • lcd_128x64 – Type: TF_LCD128x64 *
  • pressure – Type: uint16_t, Range: [0 to 300]
  • x – Type: uint16_t, Range: [0 to 127]
  • y – Type: uint16_t, Range: [0 to 63]
  • age – Type: uint32_t, Unit: 1 ms, Range: [0 to 232 - 1]
  • user_data – Type: void *

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

int tf_lcd_128x64_register_touch_gesture_callback(TF_LCD128x64 *lcd_128x64, TF_LCD128x64_TouchGestureHandler handler, void *user_data)
void handler(TF_LCD128x64 *lcd_128x64, uint8_t gesture, uint32_t duration, uint16_t pressure_max, uint16_t x_start, uint16_t y_start, uint16_t x_end, uint16_t y_end, uint32_t age, void *user_data)
Callback Parameters:
  • lcd_128x64 – Type: TF_LCD128x64 *
  • gesture – Type: uint8_t, Range: See constants
  • duration – Type: uint32_t, Unit: 1 ms, Range: [0 to 232 - 1]
  • pressure_max – Type: uint16_t, Range: [0 to 300]
  • x_start – Type: uint16_t, Range: [0 to 127]
  • y_start – Type: uint16_t, Range: [0 to 63]
  • x_end – Type: uint16_t, Range: [0 to 127]
  • y_end – Type: uint16_t, Range: [0 to 63]
  • age – Type: uint32_t, Unit: 1 ms, Range: [0 to 232 - 1]
  • user_data – Type: void *

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

The following constants are available for this function:

For gesture:

  • TF_LCD_128X64_GESTURE_LEFT_TO_RIGHT = 0

  • TF_LCD_128X64_GESTURE_RIGHT_TO_LEFT = 1

  • TF_LCD_128X64_GESTURE_TOP_TO_BOTTOM = 2

  • TF_LCD_128X64_GESTURE_BOTTOM_TO_TOP = 3

int tf_lcd_128x64_register_gui_button_pressed_callback(TF_LCD128x64 *lcd_128x64, TF_LCD128x64_GUIButtonPressedHandler handler, void *user_data)
void handler(TF_LCD128x64 *lcd_128x64, uint8_t index, bool pressed, void *user_data)
Callback Parameters:
  • lcd_128x64 – Type: TF_LCD128x64 *
  • index – Type: uint8_t, Range: [0 to 11]
  • pressed – Type: bool
  • user_data – Type: void *

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

Added in version 2.0.2$nbsp;(Plugin).

int tf_lcd_128x64_register_gui_slider_value_callback(TF_LCD128x64 *lcd_128x64, TF_LCD128x64_GUISliderValueHandler handler, void *user_data)
void handler(TF_LCD128x64 *lcd_128x64, uint8_t index, uint8_t value, void *user_data)
Callback Parameters:
  • lcd_128x64 – Type: TF_LCD128x64 *
  • index – Type: uint8_t, Range: [0 to 5]
  • value – Type: uint8_t, Range: [0 to 120]
  • user_data – Type: void *

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

Added in version 2.0.2$nbsp;(Plugin).

int tf_lcd_128x64_register_gui_tab_selected_callback(TF_LCD128x64 *lcd_128x64, TF_LCD128x64_GUITabSelectedHandler handler, void *user_data)
void handler(TF_LCD128x64 *lcd_128x64, int8_t index, void *user_data)
Callback Parameters:
  • lcd_128x64 – Type: TF_LCD128x64 *
  • index – Type: int8_t, Range: [0 to 9]
  • user_data – Type: void *

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

Added in version 2.0.2$nbsp;(Plugin).

Virtual Functions

Virtual functions don't communicate with the device itself, but operate only on the API bindings device object.

int tf_lcd_128x64_get_response_expected(TF_LCD128x64 *lcd_128x64, uint8_t function_id, bool *ret_response_expected)
Parameters:
  • lcd_128x64 – Type: TF_LCD128x64 *
  • function_id – Type: uint8_t, Range: See constants
Output Parameters:
  • ret_response_expected – Type: bool
Returns:
  • e_code – Type: int

Returns the response expected flag for the function specified by the function ID parameter. It is true if the function is expected to send a response, false otherwise.

For getter functions this is enabled by default and cannot be disabled, because those functions will always send a response. For callback configuration functions it is enabled by default too, but can be disabled by tf_lcd_128x64_set_response_expected(). For setter functions it is disabled by default and can be enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is sent and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For function_id:

  • TF_LCD_128X64_FUNCTION_WRITE_PIXELS = 1

  • TF_LCD_128X64_FUNCTION_CLEAR_DISPLAY = 3

  • TF_LCD_128X64_FUNCTION_SET_DISPLAY_CONFIGURATION = 4

  • TF_LCD_128X64_FUNCTION_WRITE_LINE = 6

  • TF_LCD_128X64_FUNCTION_DRAW_BUFFERED_FRAME = 7

  • TF_LCD_128X64_FUNCTION_SET_TOUCH_POSITION_CALLBACK_CONFIGURATION = 9

  • TF_LCD_128X64_FUNCTION_SET_TOUCH_GESTURE_CALLBACK_CONFIGURATION = 13

  • TF_LCD_128X64_FUNCTION_DRAW_LINE = 16

  • TF_LCD_128X64_FUNCTION_DRAW_BOX = 17

  • TF_LCD_128X64_FUNCTION_DRAW_TEXT = 18

  • TF_LCD_128X64_FUNCTION_SET_GUI_BUTTON = 19

  • TF_LCD_128X64_FUNCTION_REMOVE_GUI_BUTTON = 21

  • TF_LCD_128X64_FUNCTION_SET_GUI_BUTTON_PRESSED_CALLBACK_CONFIGURATION = 22

  • TF_LCD_128X64_FUNCTION_SET_GUI_SLIDER = 26

  • TF_LCD_128X64_FUNCTION_REMOVE_GUI_SLIDER = 28

  • TF_LCD_128X64_FUNCTION_SET_GUI_SLIDER_VALUE_CALLBACK_CONFIGURATION = 29

  • TF_LCD_128X64_FUNCTION_SET_GUI_TAB_CONFIGURATION = 33

  • TF_LCD_128X64_FUNCTION_SET_GUI_TAB_TEXT = 35

  • TF_LCD_128X64_FUNCTION_SET_GUI_TAB_ICON = 37

  • TF_LCD_128X64_FUNCTION_REMOVE_GUI_TAB = 39

  • TF_LCD_128X64_FUNCTION_SET_GUI_TAB_SELECTED = 40

  • TF_LCD_128X64_FUNCTION_SET_GUI_TAB_SELECTED_CALLBACK_CONFIGURATION = 41

  • TF_LCD_128X64_FUNCTION_SET_GUI_GRAPH_CONFIGURATION = 45

  • TF_LCD_128X64_FUNCTION_SET_GUI_GRAPH_DATA = 47

  • TF_LCD_128X64_FUNCTION_REMOVE_GUI_GRAPH = 49

  • TF_LCD_128X64_FUNCTION_REMOVE_ALL_GUI = 50

  • TF_LCD_128X64_FUNCTION_SET_TOUCH_LED_CONFIG = 51

  • TF_LCD_128X64_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237

  • TF_LCD_128X64_FUNCTION_SET_STATUS_LED_CONFIG = 239

  • TF_LCD_128X64_FUNCTION_RESET = 243

  • TF_LCD_128X64_FUNCTION_WRITE_UID = 248

int tf_lcd_128x64_set_response_expected(TF_LCD128x64 *lcd_128x64, uint8_t function_id, bool response_expected)
Parameters:
  • lcd_128x64 – Type: TF_LCD128x64 *
  • function_id – Type: uint8_t, Range: See constants
  • response_expected – Type: bool
Returns:
  • e_code – Type: int

Changes the response expected flag of the function specified by the function ID parameter. This flag can only be changed for setter (default value: false) and callback configuration functions (default value: true). For getter functions it is always enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is sent and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For function_id:

  • TF_LCD_128X64_FUNCTION_WRITE_PIXELS = 1

  • TF_LCD_128X64_FUNCTION_CLEAR_DISPLAY = 3

  • TF_LCD_128X64_FUNCTION_SET_DISPLAY_CONFIGURATION = 4

  • TF_LCD_128X64_FUNCTION_WRITE_LINE = 6

  • TF_LCD_128X64_FUNCTION_DRAW_BUFFERED_FRAME = 7

  • TF_LCD_128X64_FUNCTION_SET_TOUCH_POSITION_CALLBACK_CONFIGURATION = 9

  • TF_LCD_128X64_FUNCTION_SET_TOUCH_GESTURE_CALLBACK_CONFIGURATION = 13

  • TF_LCD_128X64_FUNCTION_DRAW_LINE = 16

  • TF_LCD_128X64_FUNCTION_DRAW_BOX = 17

  • TF_LCD_128X64_FUNCTION_DRAW_TEXT = 18

  • TF_LCD_128X64_FUNCTION_SET_GUI_BUTTON = 19

  • TF_LCD_128X64_FUNCTION_REMOVE_GUI_BUTTON = 21

  • TF_LCD_128X64_FUNCTION_SET_GUI_BUTTON_PRESSED_CALLBACK_CONFIGURATION = 22

  • TF_LCD_128X64_FUNCTION_SET_GUI_SLIDER = 26

  • TF_LCD_128X64_FUNCTION_REMOVE_GUI_SLIDER = 28

  • TF_LCD_128X64_FUNCTION_SET_GUI_SLIDER_VALUE_CALLBACK_CONFIGURATION = 29

  • TF_LCD_128X64_FUNCTION_SET_GUI_TAB_CONFIGURATION = 33

  • TF_LCD_128X64_FUNCTION_SET_GUI_TAB_TEXT = 35

  • TF_LCD_128X64_FUNCTION_SET_GUI_TAB_ICON = 37

  • TF_LCD_128X64_FUNCTION_REMOVE_GUI_TAB = 39

  • TF_LCD_128X64_FUNCTION_SET_GUI_TAB_SELECTED = 40

  • TF_LCD_128X64_FUNCTION_SET_GUI_TAB_SELECTED_CALLBACK_CONFIGURATION = 41

  • TF_LCD_128X64_FUNCTION_SET_GUI_GRAPH_CONFIGURATION = 45

  • TF_LCD_128X64_FUNCTION_SET_GUI_GRAPH_DATA = 47

  • TF_LCD_128X64_FUNCTION_REMOVE_GUI_GRAPH = 49

  • TF_LCD_128X64_FUNCTION_REMOVE_ALL_GUI = 50

  • TF_LCD_128X64_FUNCTION_SET_TOUCH_LED_CONFIG = 51

  • TF_LCD_128X64_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237

  • TF_LCD_128X64_FUNCTION_SET_STATUS_LED_CONFIG = 239

  • TF_LCD_128X64_FUNCTION_RESET = 243

  • TF_LCD_128X64_FUNCTION_WRITE_UID = 248

int tf_lcd_128x64_set_response_expected_all(TF_LCD128x64 *lcd_128x64, bool response_expected)
Parameters:
  • lcd_128x64 – Type: TF_LCD128x64 *
  • response_expected – Type: bool
Returns:
  • e_code – Type: int

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

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.

int tf_lcd_128x64_set_bootloader_mode(TF_LCD128x64 *lcd_128x64, uint8_t mode, uint8_t *ret_status)
Parameters:
  • lcd_128x64 – Type: TF_LCD128x64 *
  • mode – Type: uint8_t, Range: See constants
Output Parameters:
  • ret_status – Type: uint8_t, Range: See constants
Returns:
  • e_code – Type: int

Sets the bootloader mode and returns the status after the requested mode change was instigated.

You can change from bootloader mode to firmware mode and vice versa. A change from bootloader mode to firmware mode will only take place if the entry function, device identifier and CRC are present and correct.

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

The following constants are available for this function:

For mode:

  • TF_LCD_128X64_BOOTLOADER_MODE_BOOTLOADER = 0

  • TF_LCD_128X64_BOOTLOADER_MODE_FIRMWARE = 1

  • TF_LCD_128X64_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2

  • TF_LCD_128X64_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3

  • TF_LCD_128X64_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

For ret_status:

  • TF_LCD_128X64_BOOTLOADER_STATUS_OK = 0

  • TF_LCD_128X64_BOOTLOADER_STATUS_INVALID_MODE = 1

  • TF_LCD_128X64_BOOTLOADER_STATUS_NO_CHANGE = 2

  • TF_LCD_128X64_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3

  • TF_LCD_128X64_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4

  • TF_LCD_128X64_BOOTLOADER_STATUS_CRC_MISMATCH = 5

int tf_lcd_128x64_get_bootloader_mode(TF_LCD128x64 *lcd_128x64, uint8_t *ret_mode)
Parameters:
  • lcd_128x64 – Type: TF_LCD128x64 *
Output Parameters:
  • ret_mode – Type: uint8_t, Range: See constants
Returns:
  • e_code – Type: int

Returns the current bootloader mode, see tf_lcd_128x64_set_bootloader_mode().

The following constants are available for this function:

For ret_mode:

  • TF_LCD_128X64_BOOTLOADER_MODE_BOOTLOADER = 0

  • TF_LCD_128X64_BOOTLOADER_MODE_FIRMWARE = 1

  • TF_LCD_128X64_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2

  • TF_LCD_128X64_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3

  • TF_LCD_128X64_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

int tf_lcd_128x64_set_write_firmware_pointer(TF_LCD128x64 *lcd_128x64, uint32_t pointer)
Parameters:
  • lcd_128x64 – Type: TF_LCD128x64 *
  • pointer – Type: uint32_t, Unit: 1 B, Range: [0 to 232 - 1]
Returns:
  • e_code – Type: int

Sets the firmware pointer for tf_lcd_128x64_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.

int tf_lcd_128x64_write_firmware(TF_LCD128x64 *lcd_128x64, const uint8_t data[64], uint8_t *ret_status)
Parameters:
  • lcd_128x64 – Type: TF_LCD128x64 *
  • data – Type: const uint8_t[64], Range: [0 to 255]
Output Parameters:
  • ret_status – Type: uint8_t, Range: [0 to 255]
Returns:
  • e_code – Type: int

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

int tf_lcd_128x64_write_uid(TF_LCD128x64 *lcd_128x64, uint32_t uid)
Parameters:
  • lcd_128x64 – Type: TF_LCD128x64 *
  • uid – Type: uint32_t, Range: [0 to 232 - 1]
Returns:
  • e_code – Type: int

Writes a new UID into flash. If you want to set a new UID you have to decode the Base58 encoded UID string into an integer first.

We recommend that you use Brick Viewer to change the UID.

int tf_lcd_128x64_read_uid(TF_LCD128x64 *lcd_128x64, uint32_t *ret_uid)
Parameters:
  • lcd_128x64 – Type: TF_LCD128x64 *
Output Parameters:
  • ret_uid – Type: uint32_t, Range: [0 to 232 - 1]
Returns:
  • e_code – Type: int

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

Constants

TF_LCD_128X64_DEVICE_IDENTIFIER

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

The functions tf_lcd_128x64_get_identity() and tf_hal_get_device_info() have a device_identifier output parameter to specify the Brick's or Bricklet's type.

TF_LCD_128X64_DEVICE_DISPLAY_NAME

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