C/C++ - LCD 128x64 Bricklet

This is the description of the C/C++ 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++ 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
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_lcd_128x64.h"

#define HOST "localhost"
#define PORT 4223
#define UID "XYZ" // Change XYZ to the UID of your LCD 128x64 Bricklet

int main(void) {
    // Create IP connection
    IPConnection ipcon;
    ipcon_create(&ipcon);

    // Create device object
    LCD128x64 lcd;
    lcd_128x64_create(&lcd, UID, &ipcon);

    // Connect to brickd
    if(ipcon_connect(&ipcon, HOST, PORT) < 0) {
        fprintf(stderr, "Could not connect\n");
        return 1;
    }
    // Don't use device before ipcon is connected

    // Clear display
    lcd_128x64_clear_display(&lcd);

    // Write "Hello World" starting from upper left corner of the screen
    lcd_128x64_write_line(&lcd, 0, 0, "Hello World");

    printf("Press key to exit\n");
    getchar();
    lcd_128x64_destroy(&lcd);
    ipcon_destroy(&ipcon); // Calls ipcon_disconnect internally
    return 0;
}

Big Font

Download (example_big_font.c)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_lcd_128x64.h"

#define HOST "localhost"
#define PORT 4223
#define UID "XYZ" // Change XYZ to the UID of your LCD 128x64 Bricklet

int main(void) {
    // Create IP connection
    IPConnection ipcon;
    ipcon_create(&ipcon);

    // Create device object
    LCD128x64 lcd;
    lcd_128x64_create(&lcd, UID, &ipcon);

    // Connect to brickd
    if(ipcon_connect(&ipcon, HOST, PORT) < 0) {
        fprintf(stderr, "Could not connect\n");
        return 1;
    }
    // Don't use device before ipcon is connected

    // Clear display
    lcd_128x64_clear_display(&lcd);

    // Write "Hello World" with big 24x32 font
    lcd_128x64_draw_text(&lcd, 0, 0, LCD_128X64_FONT_24X32, LCD_128X64_COLOR_BLACK,
                         "24x32");

    printf("Press key to exit\n");
    getchar();
    lcd_128x64_destroy(&lcd);
    ipcon_destroy(&ipcon); // Calls ipcon_disconnect internally
    return 0;
}

Pixel Matrix

Download (example_pixel_matrix.c)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_lcd_128x64.h"

#define HOST "localhost"
#define PORT 4223
#define UID "XYZ" // Change XYZ to the UID of your OLED 128x64 Bricklet
#define WIDTH 128
#define HEIGHT 64

int main(void) {
    // Create IP connection
    IPConnection ipcon;
    ipcon_create(&ipcon);

    // Create device object
    LCD128x64 lcd;
    lcd_128x64_create(&lcd, UID, &ipcon);

    // Connect to brickd
    if(ipcon_connect(&ipcon, HOST, PORT) < 0) {
        fprintf(stderr, "Could not connect\n");
        return 1;
    }
    // Don't use device before ipcon is connected

    // Clear display
    lcd_128x64_clear_display(&lcd);

    // Draw checkerboard pattern
    int row, column;
    bool pixels[HEIGHT * WIDTH];

    for (row = 0; row < HEIGHT; row++) {
        for (column = 0; column < WIDTH; column++) {
            pixels[row * WIDTH + column] = (row / 8) % 2 == (column / 8) % 2;
        }
    }

    lcd_128x64_write_pixels(&lcd, 0, 0, WIDTH-1, HEIGHT-1, pixels, HEIGHT*WIDTH);

    printf("Press key to exit\n");
    getchar();
    lcd_128x64_destroy(&lcd);
    ipcon_destroy(&ipcon); // Calls ipcon_disconnect internally
    return 0;
}

Touch

Download (example_touch.c)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_lcd_128x64.h"

#define HOST "localhost"
#define PORT 4223
#define UID "XYZ" // Change XYZ to the UID of your LCD 128x64 Bricklet

// Callback function for touch position callback
void cb_touch_position(uint16_t pressure, uint16_t x, uint16_t y, uint32_t age,
                       void *user_data) {
    (void)user_data; // avoid unused parameter warning

    printf("Pressure: %u\n", pressure);
    printf("X: %u\n", x);
    printf("Y: %u\n", y);
    printf("Age: %u\n", age);
    printf("\n");
}

// Callback function for touch gesture callback
void cb_touch_gesture(uint8_t gesture, uint32_t duration, uint16_t pressure_max,
                      uint16_t x_start, uint16_t x_end, uint16_t y_start, uint16_t y_end,
                      uint32_t age, void *user_data) {
    (void)user_data; // avoid unused parameter warning

    printf("Gesture: %u\n", gesture);
    printf("Duration: %u\n", duration);
    printf("Pressure Max: %u\n", pressure_max);
    printf("X Start: %u\n", x_start);
    printf("X End: %u\n", x_end);
    printf("Y Start: %u\n", y_start);
    printf("Y End: %u\n", y_end);
    printf("Age: %u\n", age);
    printf("\n");
}

int main(void) {
    // Create IP connection
    IPConnection ipcon;
    ipcon_create(&ipcon);

    // Create device object
    LCD128x64 lcd;
    lcd_128x64_create(&lcd, UID, &ipcon);

    // Connect to brickd
    if(ipcon_connect(&ipcon, HOST, PORT) < 0) {
        fprintf(stderr, "Could not connect\n");
        return 1;
    }
    // Don't use device before ipcon is connected

    // Register touch position callback to function cb_touch_position
    lcd_128x64_register_callback(&lcd,
                                 LCD_128X64_CALLBACK_TOUCH_POSITION,
                                 (void *)cb_touch_position,
                                 NULL);

    // Register touch gesture callback to function cb_touch_gesture
    lcd_128x64_register_callback(&lcd,
                                 LCD_128X64_CALLBACK_TOUCH_GESTURE,
                                 (void *)cb_touch_gesture,
                                 NULL);

    // Set period for touch position callback to 0.1s (100ms)
    lcd_128x64_set_touch_position_callback_configuration(&lcd, 100, true);

    // Set period for touch gesture callback to 0.1s (100ms)
    lcd_128x64_set_touch_gesture_callback_configuration(&lcd, 100, true);

    printf("Press key to exit\n");
    getchar();
    lcd_128x64_destroy(&lcd);
    ipcon_destroy(&ipcon); // Calls ipcon_disconnect internally
    return 0;
}

Scribble

Download (example_scribble.c)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
// Tested with gcc:
// > gcc -pthread example_scribble.c ip_connection.c bricklet_lcd_128x64.c -lgd -lm -o example

#include <stdio.h>
#include <math.h>
#include <gd.h> // https://libgd.github.io/

#define IPCON_EXPOSE_MILLISLEEP

#include "ip_connection.h"
#include "bricklet_lcd_128x64.h"

#define HOST "localhost"
#define PORT 4223
#define UID "XYZ" // Change to your UID
#define WIDTH 128
#define HEIGHT 64

void draw_image(LCD128x64 *lcd, gdImagePtr image) {
    bool pixels[HEIGHT * WIDTH];
    int row, column, index;

    // Convert pixels into pages
    for (row = 0; row < HEIGHT; row++) {
        for (column = 0; column < WIDTH; column++) {
            index = gdImageGetPixel(image, column, row);
            pixels[row*WIDTH + column] = gdImageRed(image, index) > 0;
        }
    }

    lcd_128x64_write_pixels(lcd, 0, 0, WIDTH-1, HEIGHT-1, pixels, HEIGHT*WIDTH);
}

int main(void) {
    // Create IP connection
    IPConnection ipcon;
    ipcon_create(&ipcon);

    // Create device object
    LCD128x64 lcd;
    lcd_128x64_create(&lcd, UID, &ipcon);

    // Connect to brickd
    if(ipcon_connect(&ipcon, HOST, PORT) < 0) {
        fprintf(stderr, "Could not connect\n");
        return 1;
    }
    // Don't use device before ipcon is connected

    // Clear display
    lcd_128x64_clear_display(&lcd);

    // Draw rotating line
    gdImagePtr image = gdImageCreate(WIDTH, HEIGHT);
    int black = gdImageColorAllocate(image, 0, 0, 0);
    int white = gdImageColorAllocate(image, 255, 255, 255);
    int origin_x = WIDTH / 2;
    int origin_y = HEIGHT / 2;
    int length = HEIGHT / 2 - 2;
    int angle = 0;

    printf("Press ctrl+c exit\n");

    while (true) {
        double radians = M_PI * angle / 180.0;
        int x = (int)(origin_x + length * cos(radians));
        int y = (int)(origin_y + length * sin(radians));

        gdImageFilledRectangle(image, 0, 0, WIDTH, HEIGHT, black);
        gdImageLine(image, origin_x, origin_y, x, y, white);

        draw_image(&lcd, image);
        millisleep(25);

        angle++;
    }

    gdImageDestroy(image);
    ipcon_destroy(&ipcon); // Calls ipcon_disconnect internally
    return 0;
}

Gui

Download (example_gui.c)

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_lcd_128x64.h"

#define HOST "localhost"
#define PORT 4223
#define UID "XYZ" // Change XYZ to the UID of your LCD 128x64 Bricklet

// Callback function for gui button pressed callback
void cb_gui_button_pressed(uint8_t index, bool pressed, void *user_data) {
    (void)user_data; // avoid unused parameter warning

    printf("Index: %u\n", index);
    printf("Pressed: %s\n", pressed ? "true" : "false");
    printf("\n");
}

// Callback function for gui slider value callback
void cb_gui_slider_value(uint8_t index, uint8_t value, void *user_data) {
    (void)user_data; // avoid unused parameter warning

    printf("Index: %u\n", index);
    printf("Value: %u\n", value);
    printf("\n");
}

// Callback function for gui tab selected callback
void cb_gui_tab_selected(uint8_t index, void *user_data) {
    (void)user_data; // avoid unused parameter warning

    printf("Index: %u\n", index);
}

int main(void) {
    // Create IP connection
    IPConnection ipcon;
    ipcon_create(&ipcon);

    // Create device object
    LCD128x64 lcd;
    lcd_128x64_create(&lcd, UID, &ipcon);

    // Connect to brickd
    if(ipcon_connect(&ipcon, HOST, PORT) < 0) {
        fprintf(stderr, "Could not connect\n");
        return 1;
    }
    // Don't use device before ipcon is connected

    // Register gui button pressed callback to function cb_gui_button_pressed
    lcd_128x64_register_callback(&lcd,
                                 LCD_128X64_CALLBACK_GUI_BUTTON_PRESSED,
                                 (void *)cb_gui_button_pressed,
                                 NULL);

    // Register gui slider value callback to function cb_gui_slider_value
    lcd_128x64_register_callback(&lcd,
                                 LCD_128X64_CALLBACK_GUI_SLIDER_VALUE,
                                 (void *)cb_gui_slider_value,
                                 NULL);

    // Register gui tab selected callback to function cb_gui_tab_selected
    lcd_128x64_register_callback(&lcd,
                                 LCD_128X64_CALLBACK_GUI_TAB_SELECTED,
                                 (void *)cb_gui_tab_selected,
                                 NULL);

    // Clear display
    lcd_128x64_clear_display(&lcd);
    lcd_128x64_remove_all_gui(&lcd);

    // Add GUI elements: Button, Slider and Graph with 60 data points
    lcd_128x64_set_gui_button(&lcd, 0, 0, 0, 60, 20, "button");
    lcd_128x64_set_gui_slider(&lcd, 0, 0, 30, 60, LCD_128X64_DIRECTION_HORIZONTAL, 50);
    lcd_128x64_set_gui_graph_configuration(&lcd, 0, LCD_128X64_GRAPH_TYPE_LINE, 62, 0,
                                           60, 52, "X", "Y");

    // Add a few data points (the remaining points will be 0)
    lcd_128x64_set_gui_graph_data(&lcd, 0,
                                  (uint8_t[]){20, 40, 60, 80, 100, 120, 140, 160, 180, 200, 220, 240});

    // Add 5 text tabs without and configure it for click and swipe without auto-redraw
    lcd_128x64_set_gui_tab_configuration(&lcd, LCD_128X64_CHANGE_TAB_ON_CLICK_AND_SWIPE,
                                         false);
    lcd_128x64_set_gui_tab_text(&lcd, 0, "Tab A");
    lcd_128x64_set_gui_tab_text(&lcd, 1, "Tab B");
    lcd_128x64_set_gui_tab_text(&lcd, 2, "Tab C");
    lcd_128x64_set_gui_tab_text(&lcd, 3, "Tab D");
    lcd_128x64_set_gui_tab_text(&lcd, 4, "Tab E");

    // Set period for gui button pressed callback to 0.1s (100ms)
    lcd_128x64_set_gui_button_pressed_callback_configuration(&lcd, 100, true);

    // Set period for gui slider value callback to 0.1s (100ms)
    lcd_128x64_set_gui_slider_value_callback_configuration(&lcd, 100, true);

    // Set period for gui tab selected callback to 0.1s (100ms)
    lcd_128x64_set_gui_tab_selected_callback_configuration(&lcd, 100, true);

    printf("Press key to exit\n");
    getchar();
    lcd_128x64_destroy(&lcd);
    ipcon_destroy(&ipcon); // Calls ipcon_disconnect internally
    return 0;
}

API

Every function of the C/C++ bindings returns an integer which describes an error code. Data returned from the device, when a getter is called, is handled via call by reference. These parameters are labeled with the ret_ prefix.

Possible error codes are:

  • E_OK = 0
  • E_TIMEOUT = -1
  • E_NO_STREAM_SOCKET = -2
  • E_HOSTNAME_INVALID = -3
  • E_NO_CONNECT = -4
  • E_NO_THREAD = -5
  • E_NOT_ADDED = -6 (unused since bindings version 2.0.0)
  • E_ALREADY_CONNECTED = -7
  • E_NOT_CONNECTED = -8
  • E_INVALID_PARAMETER = -9
  • E_NOT_SUPPORTED = -10
  • E_UNKNOWN_ERROR_CODE = -11
  • E_STREAM_OUT_OF_SYNC = -12

as defined in ip_connection.h.

All functions listed below are thread-safe.

Basic Functions

void lcd_128x64_create(LCD128x64 *lcd_128x64, const char *uid, IPConnection *ipcon)

Creates the device object lcd_128x64 with the unique device ID uid and adds it to the IPConnection ipcon:

LCD128x64 lcd_128x64;
lcd_128x64_create(&lcd_128x64, "YOUR_DEVICE_UID", &ipcon);

This device object can be used after the IP connection has been connected (see examples above).

void lcd_128x64_destroy(LCD128x64 *lcd_128x64)

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

int lcd_128x64_write_pixels(LCD128x64 *lcd_128x64, uint8_t x_start, uint8_t y_start, uint8_t x_end, uint8_t y_end, bool *pixels, uint16_t pixels_length)

Writes pixels to the specified window.

The x-axis goes from 0 to 127 and the y-axis from 0 to 63. The pixels are written into the window line by line top to bottom and each line is written from left to right.

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

If automatic draw is disabled the pixels are written to an internal buffer and the buffer is transferred to the display only after 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 lcd_128x64_set_display_configuration() function.

int lcd_128x64_read_pixels(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)

Reads pixels from the specified window.

The x-axis goes from 0 to 127 and the y-axis from 0 to 63. The pixels are read from the window line by line top to bottom and each line is read from left to right.

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

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

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

int lcd_128x64_clear_display(LCD128x64 *lcd_128x64)

Clears the complete content of the display.

int lcd_128x64_write_line(LCD128x64 *lcd_128x64, uint8_t line, uint8_t position, const char text[22])

Writes text to a specific line (0 to 7) with a specific position (0 to 21). The text can have a maximum of 22 characters.

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

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

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

int lcd_128x64_draw_buffered_frame(LCD128x64 *lcd_128x64, bool force_complete_redraw)

Draws the currently buffered frame. Normally each call of lcd_128x64_write_pixels() and lcd_128x64_write_line() draws directly onto the display. If you turn automatic draw off (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 lcd_128x64_get_touch_position(LCD128x64 *lcd_128x64, uint16_t *ret_pressure, uint16_t *ret_x, uint16_t *ret_y, uint32_t *ret_age)

Returns the last valid touch position:

  • Pressure: Amount of pressure applied by the user (0-300)
  • X: Touch position on x-axis (0-127)
  • Y: Touch position on y-axis (0-63)
  • Age: Age of touch press in ms (how long ago it was)
int lcd_128x64_get_touch_gesture(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)

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

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

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

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

The following defines are available for this function:

  • LCD_128X64_GESTURE_LEFT_TO_RIGHT = 0
  • LCD_128X64_GESTURE_RIGHT_TO_LEFT = 1
  • LCD_128X64_GESTURE_TOP_TO_BOTTOM = 2
  • LCD_128X64_GESTURE_BOTTOM_TO_TOP = 3
int lcd_128x64_draw_line(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)

Draws a white or black line from (x, y)-start to (x, y)-end. The x values have to be within the range of 0 to 127 and the y values have t be within the range of 0 to 63.

The following defines are available for this function:

  • LCD_128X64_COLOR_WHITE = false
  • LCD_128X64_COLOR_BLACK = true

New in version 2.0.2 (Plugin).

int lcd_128x64_draw_box(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)

Draws a white or black box from (x, y)-start to (x, y)-end. The x values have to be within the range of 0 to 127 and the y values have to be within the range of 0 to 63.

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

The following defines are available for this function:

  • LCD_128X64_COLOR_WHITE = false
  • LCD_128X64_COLOR_BLACK = true

New in version 2.0.2 (Plugin).

int lcd_128x64_draw_text(LCD128x64 *lcd_128x64, uint8_t position_x, uint8_t position_y, uint8_t font, bool color, const char text[22])

Draws a text with up to 22 characters at the pixel position (x, y).

The x values have to be within the range of 0 to 127 and the y values have to be within the range of 0 to 63.

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

The following defines are available for this function:

  • LCD_128X64_FONT_6X8 = 0
  • LCD_128X64_FONT_6X16 = 1
  • LCD_128X64_FONT_6X24 = 2
  • LCD_128X64_FONT_6X32 = 3
  • LCD_128X64_FONT_12X16 = 4
  • LCD_128X64_FONT_12X24 = 5
  • LCD_128X64_FONT_12X32 = 6
  • LCD_128X64_FONT_18X24 = 7
  • LCD_128X64_FONT_18X32 = 8
  • LCD_128X64_FONT_24X32 = 9
  • LCD_128X64_COLOR_WHITE = false
  • LCD_128X64_COLOR_BLACK = true

New in version 2.0.2 (Plugin).

int lcd_128x64_set_gui_button(LCD128x64 *lcd_128x64, uint8_t index, uint8_t position_x, uint8_t position_y, uint8_t width, uint8_t height, const char text[16])

Draws a clickable button at position (x, y) with the given text of up to 16 characters.

You can use up to 12 buttons (index 0-11).

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

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

You can enable a callback for a button press with 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 lcd_128x64_write_pixels(). To remove the button use lcd_128x64_remove_gui_button().

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

New in version 2.0.2 (Plugin).

int lcd_128x64_get_gui_button(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])

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

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

New in version 2.0.2 (Plugin).

int lcd_128x64_remove_gui_button(LCD128x64 *lcd_128x64, uint8_t index)

Removes the button with the given index.

You can use index 255 to remove all buttons.

New in version 2.0.2 (Plugin).

int lcd_128x64_get_gui_button_pressed(LCD128x64 *lcd_128x64, uint8_t index, bool *ret_pressed)

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

int lcd_128x64_set_gui_slider(LCD128x64 *lcd_128x64, uint8_t index, uint8_t position_x, uint8_t position_y, uint8_t length, uint8_t direction, uint8_t value)

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

You can use up to 6 sliders (index 0-5).

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

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

The minimum length of a slider is 8.

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

You can enable a callback for the slider value with 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 lcd_128x64_write_pixels(). To remove the button use lcd_128x64_remove_gui_slider().

The following defines are available for this function:

  • LCD_128X64_DIRECTION_HORIZONTAL = 0
  • LCD_128X64_DIRECTION_VERTICAL = 1

New in version 2.0.2 (Plugin).

int lcd_128x64_get_gui_slider(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)

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

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

The following defines are available for this function:

  • LCD_128X64_DIRECTION_HORIZONTAL = 0
  • LCD_128X64_DIRECTION_VERTICAL = 1

New in version 2.0.2 (Plugin).

int lcd_128x64_remove_gui_slider(LCD128x64 *lcd_128x64, uint8_t index)

Removes the slider with the given index.

You can use index 255 to remove all slider.

New in version 2.0.2 (Plugin).

int lcd_128x64_get_gui_slider_value(LCD128x64 *lcd_128x64, uint8_t index, uint8_t *ret_value)

Returns the current slider value for the given index.

New in version 2.0.2 (Plugin).

int lcd_128x64_set_gui_tab_configuration(LCD128x64 *lcd_128x64, uint8_t change_tab_config, bool clear_gui)

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

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

By default click and swipe as well as automatic GUI clear is enabled.

The following defines are available for this function:

  • LCD_128X64_CHANGE_TAB_ON_CLICK = 1
  • LCD_128X64_CHANGE_TAB_ON_SWIPE = 2
  • LCD_128X64_CHANGE_TAB_ON_CLICK_AND_SWIPE = 3

New in version 2.0.2 (Plugin).

int lcd_128x64_get_gui_tab_configuration(LCD128x64 *lcd_128x64, uint8_t *ret_change_tab_config, bool *ret_clear_gui)

Returns the tab configuration as set by lcd_128x64_set_gui_tab_configuration().

The following defines are available for this function:

  • LCD_128X64_CHANGE_TAB_ON_CLICK = 1
  • LCD_128X64_CHANGE_TAB_ON_SWIPE = 2
  • LCD_128X64_CHANGE_TAB_ON_CLICK_AND_SWIPE = 3

New in version 2.0.2 (Plugin).

int lcd_128x64_set_gui_tab_text(LCD128x64 *lcd_128x64, uint8_t index, const char text[5])

Adds a text-tab with the given index. The text can have a length of up to 5 characters.

You can use up to 10 tabs (index 0-9).

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

New in version 2.0.2 (Plugin).

int lcd_128x64_get_gui_tab_text(LCD128x64 *lcd_128x64, uint8_t index, bool *ret_active, char ret_text[5])

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

int lcd_128x64_set_gui_tab_icon(LCD128x64 *lcd_128x64, uint8_t index, bool icon[168])

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

You can use up to 10 tabs (index 0-9).

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

New in version 2.0.2 (Plugin).

int lcd_128x64_get_gui_tab_icon(LCD128x64 *lcd_128x64, uint8_t index, bool *ret_active, bool ret_icon[168])

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

int lcd_128x64_remove_gui_tab(LCD128x64 *lcd_128x64, uint8_t index)

Removes the tab with the given index.

You can use index 255 to remove all tabs.

New in version 2.0.2 (Plugin).

int lcd_128x64_set_gui_tab_selected(LCD128x64 *lcd_128x64, uint8_t index)

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

New in version 2.0.2 (Plugin).

int lcd_128x64_get_gui_tab_selected(LCD128x64 *lcd_128x64, int8_t *ret_index)

Returns the index of the currently selected tab.

New in version 2.0.2 (Plugin).

int lcd_128x64_set_gui_graph_configuration(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[4], const char text_y[4])

Sets the configuration for up to four graphs (index 0-3).

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

The x and y position are pixel positions. They have to be within the range of (0, 0) to (127, 63). The maximum width is 118 and the maximum height is 63.

You can add a text for the x and y axis with at most 4 characters each. The text is drawn at the inside of the graph and it can overwrite some of the graph data. If you need the text outside of the graph you can leave this text here empty and use lcd_128x64_draw_text() to draw the caption outside of the graph.

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

The following defines are available for this function:

  • LCD_128X64_GRAPH_TYPE_DOT = 0
  • LCD_128X64_GRAPH_TYPE_LINE = 1
  • LCD_128X64_GRAPH_TYPE_BAR = 2

New in version 2.0.2 (Plugin).

int lcd_128x64_get_gui_graph_configuration(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])

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

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

The following defines are available for this function:

  • LCD_128X64_GRAPH_TYPE_DOT = 0
  • LCD_128X64_GRAPH_TYPE_LINE = 1
  • LCD_128X64_GRAPH_TYPE_BAR = 2

New in version 2.0.2 (Plugin).

int lcd_128x64_set_gui_graph_data(LCD128x64 *lcd_128x64, uint8_t index, uint8_t *data, uint16_t data_length)

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

New in version 2.0.2 (Plugin).

int lcd_128x64_get_gui_graph_data(LCD128x64 *lcd_128x64, uint8_t index, uint8_t *ret_data, uint16_t *ret_data_length)

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

New in version 2.0.2 (Plugin).

int lcd_128x64_remove_gui_graph(LCD128x64 *lcd_128x64, uint8_t index)

Removes the graph with the given index.

You can use index 255 to remove all graphs.

New in version 2.0.2 (Plugin).

int lcd_128x64_remove_all_gui(LCD128x64 *lcd_128x64)

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

New in version 2.0.2 (Plugin).

Advanced Functions

int lcd_128x64_set_display_configuration(LCD128x64 *lcd_128x64, uint8_t contrast, uint8_t backlight, bool invert, bool automatic_draw)

Sets the configuration of the display.

You can set a contrast value from 0 to 63, a backlight intensity value from 0 to 100 and you can invert the color (white/black) of the display.

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

The default values are contrast 14, backlight intensity 100, inverting off and automatic draw on.

int lcd_128x64_get_display_configuration(LCD128x64 *lcd_128x64, uint8_t *ret_contrast, uint8_t *ret_backlight, bool *ret_invert, bool *ret_automatic_draw)

Returns the configuration as set by lcd_128x64_set_display_configuration().

int lcd_128x64_set_touch_led_config(LCD128x64 *lcd_128x64, uint8_t config)

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

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

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

The following defines are available for this function:

  • LCD_128X64_TOUCH_LED_CONFIG_OFF = 0
  • LCD_128X64_TOUCH_LED_CONFIG_ON = 1
  • LCD_128X64_TOUCH_LED_CONFIG_SHOW_HEARTBEAT = 2
  • LCD_128X64_TOUCH_LED_CONFIG_SHOW_TOUCH = 3

New in version 2.0.2 (Plugin).

int lcd_128x64_get_touch_led_config(LCD128x64 *lcd_128x64, uint8_t *ret_config)

Returns the configuration as set by lcd_128x64_set_touch_led_config()

The following defines are available for this function:

  • LCD_128X64_TOUCH_LED_CONFIG_OFF = 0
  • LCD_128X64_TOUCH_LED_CONFIG_ON = 1
  • LCD_128X64_TOUCH_LED_CONFIG_SHOW_HEARTBEAT = 2
  • LCD_128X64_TOUCH_LED_CONFIG_SHOW_TOUCH = 3

New in version 2.0.2 (Plugin).

int lcd_128x64_get_api_version(LCD128x64 *lcd_128x64, uint8_t ret_api_version[3])

Returns the version of the API definition (major, minor, revision) implemented by this API bindings. This is neither the release version of this API bindings nor does it tell you anything about the represented Brick or Bricklet.

int lcd_128x64_get_response_expected(LCD128x64 *lcd_128x64, uint8_t function_id, bool *ret_response_expected)

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 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 send and errors are silently ignored, because they cannot be detected.

See lcd_128x64_set_response_expected() for the list of function ID defines available for this function.

int lcd_128x64_set_response_expected(LCD128x64 *lcd_128x64, uint8_t function_id, bool response_expected)

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 send and errors are silently ignored, because they cannot be detected.

The following function ID defines are available for this function:

  • LCD_128X64_FUNCTION_WRITE_PIXELS = 1
  • LCD_128X64_FUNCTION_CLEAR_DISPLAY = 3
  • LCD_128X64_FUNCTION_SET_DISPLAY_CONFIGURATION = 4
  • LCD_128X64_FUNCTION_WRITE_LINE = 6
  • LCD_128X64_FUNCTION_DRAW_BUFFERED_FRAME = 7
  • LCD_128X64_FUNCTION_SET_TOUCH_POSITION_CALLBACK_CONFIGURATION = 9
  • LCD_128X64_FUNCTION_SET_TOUCH_GESTURE_CALLBACK_CONFIGURATION = 13
  • LCD_128X64_FUNCTION_DRAW_LINE = 16
  • LCD_128X64_FUNCTION_DRAW_BOX = 17
  • LCD_128X64_FUNCTION_DRAW_TEXT = 18
  • LCD_128X64_FUNCTION_SET_GUI_BUTTON = 19
  • LCD_128X64_FUNCTION_REMOVE_GUI_BUTTON = 21
  • LCD_128X64_FUNCTION_SET_GUI_BUTTON_PRESSED_CALLBACK_CONFIGURATION = 22
  • LCD_128X64_FUNCTION_SET_GUI_SLIDER = 26
  • LCD_128X64_FUNCTION_REMOVE_GUI_SLIDER = 28
  • LCD_128X64_FUNCTION_SET_GUI_SLIDER_VALUE_CALLBACK_CONFIGURATION = 29
  • LCD_128X64_FUNCTION_SET_GUI_TAB_CONFIGURATION = 33
  • LCD_128X64_FUNCTION_SET_GUI_TAB_TEXT = 35
  • LCD_128X64_FUNCTION_SET_GUI_TAB_ICON = 37
  • LCD_128X64_FUNCTION_REMOVE_GUI_TAB = 39
  • LCD_128X64_FUNCTION_SET_GUI_TAB_SELECTED = 40
  • LCD_128X64_FUNCTION_SET_GUI_TAB_SELECTED_CALLBACK_CONFIGURATION = 41
  • LCD_128X64_FUNCTION_SET_GUI_GRAPH_CONFIGURATION = 45
  • LCD_128X64_FUNCTION_SET_GUI_GRAPH_DATA = 47
  • LCD_128X64_FUNCTION_REMOVE_GUI_GRAPH = 49
  • LCD_128X64_FUNCTION_REMOVE_ALL_GUI = 50
  • LCD_128X64_FUNCTION_SET_TOUCH_LED_CONFIG = 51
  • LCD_128X64_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • LCD_128X64_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • LCD_128X64_FUNCTION_RESET = 243
  • LCD_128X64_FUNCTION_WRITE_UID = 248
int lcd_128x64_set_response_expected_all(LCD128x64 *lcd_128x64, bool response_expected)

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

int lcd_128x64_get_spitfp_error_count(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)

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 lcd_128x64_set_bootloader_mode(LCD128x64 *lcd_128x64, uint8_t mode, uint8_t *ret_status)

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

  • LCD_128X64_BOOTLOADER_MODE_BOOTLOADER = 0
  • LCD_128X64_BOOTLOADER_MODE_FIRMWARE = 1
  • LCD_128X64_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • LCD_128X64_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • LCD_128X64_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
  • LCD_128X64_BOOTLOADER_STATUS_OK = 0
  • LCD_128X64_BOOTLOADER_STATUS_INVALID_MODE = 1
  • LCD_128X64_BOOTLOADER_STATUS_NO_CHANGE = 2
  • LCD_128X64_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • LCD_128X64_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • LCD_128X64_BOOTLOADER_STATUS_CRC_MISMATCH = 5
int lcd_128x64_get_bootloader_mode(LCD128x64 *lcd_128x64, uint8_t *ret_mode)

Returns the current bootloader mode, see lcd_128x64_set_bootloader_mode().

The following defines are available for this function:

  • LCD_128X64_BOOTLOADER_MODE_BOOTLOADER = 0
  • LCD_128X64_BOOTLOADER_MODE_FIRMWARE = 1
  • LCD_128X64_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • LCD_128X64_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • LCD_128X64_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
int lcd_128x64_set_write_firmware_pointer(LCD128x64 *lcd_128x64, uint32_t pointer)

Sets the firmware pointer for 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 lcd_128x64_write_firmware(LCD128x64 *lcd_128x64, uint8_t data[64], uint8_t *ret_status)

Writes 64 Bytes of firmware at the position as written by 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 lcd_128x64_set_status_led_config(LCD128x64 *lcd_128x64, uint8_t config)

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

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

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

The following defines are available for this function:

  • LCD_128X64_STATUS_LED_CONFIG_OFF = 0
  • LCD_128X64_STATUS_LED_CONFIG_ON = 1
  • LCD_128X64_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • LCD_128X64_STATUS_LED_CONFIG_SHOW_STATUS = 3
int lcd_128x64_get_status_led_config(LCD128x64 *lcd_128x64, uint8_t *ret_config)

Returns the configuration as set by lcd_128x64_set_status_led_config()

The following defines are available for this function:

  • LCD_128X64_STATUS_LED_CONFIG_OFF = 0
  • LCD_128X64_STATUS_LED_CONFIG_ON = 1
  • LCD_128X64_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • LCD_128X64_STATUS_LED_CONFIG_SHOW_STATUS = 3
int lcd_128x64_get_chip_temperature(LCD128x64 *lcd_128x64, int16_t *ret_temperature)

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

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

int lcd_128x64_reset(LCD128x64 *lcd_128x64)

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 lcd_128x64_write_uid(LCD128x64 *lcd_128x64, uint32_t uid)

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

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

int lcd_128x64_read_uid(LCD128x64 *lcd_128x64, uint32_t *ret_uid)

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

int lcd_128x64_get_identity(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)

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

The position can be 'a', 'b', 'c' or 'd'.

The device identifier numbers can be found here. There is also a constant for the device identifier of this Bricklet.

Callback Configuration Functions

void lcd_128x64_register_callback(LCD128x64 *lcd_128x64, int16_t callback_id, void *function, void *user_data)

Registers the given function with the given callback_id. The user_data will be passed as the last parameter to the function.

The available callback IDs with corresponding function signatures are listed below.

int lcd_128x64_set_touch_position_callback_configuration(LCD128x64 *lcd_128x64, uint32_t period, bool value_has_to_change)

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

The default value is (0, false).

int lcd_128x64_get_touch_position_callback_configuration(LCD128x64 *lcd_128x64, uint32_t *ret_period, bool *ret_value_has_to_change)

Returns the callback configuration as set by lcd_128x64_set_touch_position_callback_configuration().

int lcd_128x64_set_touch_gesture_callback_configuration(LCD128x64 *lcd_128x64, uint32_t period, bool value_has_to_change)

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

The default value is (0, false).

int lcd_128x64_get_touch_gesture_callback_configuration(LCD128x64 *lcd_128x64, uint32_t *ret_period, bool *ret_value_has_to_change)

Returns the callback configuration as set by lcd_128x64_set_touch_gesture_callback_configuration().

int lcd_128x64_set_gui_button_pressed_callback_configuration(LCD128x64 *lcd_128x64, uint32_t period, bool value_has_to_change)

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

The default value is (0, false).

New in version 2.0.2 (Plugin).

int lcd_128x64_get_gui_button_pressed_callback_configuration(LCD128x64 *lcd_128x64, uint32_t *ret_period, bool *ret_value_has_to_change)

Returns the callback configuration as set by lcd_128x64_set_gui_button_pressed_callback_configuration().

New in version 2.0.2 (Plugin).

int lcd_128x64_set_gui_slider_value_callback_configuration(LCD128x64 *lcd_128x64, uint32_t period, bool value_has_to_change)

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

The default value is (0, false).

New in version 2.0.2 (Plugin).

int lcd_128x64_get_gui_slider_value_callback_configuration(LCD128x64 *lcd_128x64, uint32_t *ret_period, bool *ret_value_has_to_change)

Returns the callback configuration as set by lcd_128x64_set_gui_slider_value_callback_configuration().

New in version 2.0.2 (Plugin).

int lcd_128x64_set_gui_tab_selected_callback_configuration(LCD128x64 *lcd_128x64, uint32_t period, bool value_has_to_change)

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

The default value is (0, false).

New in version 2.0.2 (Plugin).

int lcd_128x64_get_gui_tab_selected_callback_configuration(LCD128x64 *lcd_128x64, uint32_t *ret_period, bool *ret_value_has_to_change)

Returns the callback configuration as set by lcd_128x64_set_gui_tab_selected_callback_configuration().

New in version 2.0.2 (Plugin).

Callbacks

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done with the lcd_128x64_register_callback() function. The parameters consist of the device object, the callback ID, the callback function and optional user data:

void my_callback(int p, void *user_data) {
    printf("parameter: %d\n", p);
}

lcd_128x64_register_callback(&lcd_128x64, LCD_128X64_CALLBACK_EXAMPLE, (void *)my_callback, NULL);

The available constants with corresponding callback function signatures are described below.

Note

Using callbacks for recurring events is always preferred compared to using getters. It will use less USB bandwidth and the latency will be a lot better, since there is no round trip time.

LCD_128X64_CALLBACK_TOUCH_POSITION
void callback(uint16_t pressure, uint16_t x, uint16_t y, uint32_t age, void *user_data)

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

LCD_128X64_CALLBACK_TOUCH_GESTURE
void callback(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)

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

The following defines are available for this function:

  • LCD_128X64_GESTURE_LEFT_TO_RIGHT = 0
  • LCD_128X64_GESTURE_RIGHT_TO_LEFT = 1
  • LCD_128X64_GESTURE_TOP_TO_BOTTOM = 2
  • LCD_128X64_GESTURE_BOTTOM_TO_TOP = 3
LCD_128X64_CALLBACK_GUI_BUTTON_PRESSED
void callback(uint8_t index, bool pressed, void *user_data)

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

New in version 2.0.2 (Plugin).

LCD_128X64_CALLBACK_GUI_SLIDER_VALUE
void callback(uint8_t index, uint8_t value, void *user_data)

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

New in version 2.0.2 (Plugin).

LCD_128X64_CALLBACK_GUI_TAB_SELECTED
void callback(int8_t index, void *user_data)

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

New in version 2.0.2 (Plugin).

Constants

LCD_128X64_DEVICE_IDENTIFIER

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

The lcd_128x64_get_identity() function and the IPCON_CALLBACK_ENUMERATE callback of the IP Connection have a device_identifier parameter to specify the Brick's or Bricklet's type.

LCD_128X64_DEVICE_DISPLAY_NAME

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