C/C++ - LCD 128x64 Bricklet

Dies ist die Beschreibung der C/C++ API Bindings für das LCD 128x64 Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des LCD 128x64 Bricklet sind in dessen Hardware Beschreibung zusammengefasst.

Eine Installationanleitung für die C/C++ API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele

Der folgende Beispielcode ist 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;
}

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;
}

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
79
80
81
82
83
84
85
86
87
#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

    if(gesture == LCD_128X64_GESTURE_LEFT_TO_RIGHT) {
        printf("Gesture: Left To Right\n");
    } else if(gesture == LCD_128X64_GESTURE_RIGHT_TO_LEFT) {
        printf("Gesture: Right To Left\n");
    } else if(gesture == LCD_128X64_GESTURE_TOP_TO_BOTTOM) {
        printf("Gesture: Top To Bottom\n");
    } else if(gesture == LCD_128X64_GESTURE_BOTTOM_TO_TOP) {
        printf("Gesture: Bottom To Top\n");
    }

    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 (*)(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 (*)(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;
}

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(int8_t index, void *user_data) {
    (void)user_data; // avoid unused parameter warning

    printf("Index: %d\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 (*)(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 (*)(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 (*)(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)
    uint8_t data[12] = {20, 40, 60, 80, 100, 120, 140, 160, 180, 200, 220, 240};
    lcd_128x64_set_gui_graph_data(&lcd, 0, data, 12);

    // 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

Jede Funktion der C/C++ Bindings gibt einen Integer zurück, welcher einen Fehlercode beschreibt. Vom Gerät zurückgegebene Daten werden, wenn eine Abfrage aufgerufen wurde, über Ausgabeparameter gehandhabt. Diese Parameter sind mit dem ret_ Präfix gekennzeichnet.

Mögliche Fehlercodes sind:

  • 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 (wird seit C/C++ Bindings Version 2.0.0 nicht mehr verwendet)
  • 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
  • E_INVALID_UID = -13
  • E_NON_ASCII_CHAR_IN_SECRET = -14

wie in ip_connection.h definiert.

Alle folgend aufgelisteten Funktionen sind Thread-sicher.

Grundfunktionen

void lcd_128x64_create(LCD128x64 *lcd_128x64, const char *uid, IPConnection *ipcon)
Parameter:
  • lcd_128x64 – Typ: LCD128x64 *
  • uid – Typ: const char *
  • ipcon – Typ: IPConnection *

Erzeugt ein Geräteobjekt lcd_128x64 mit der eindeutigen Geräte ID uid und fügt es der IP Connection ipcon hinzu:

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

Dieses Geräteobjekt kann benutzt werden, nachdem die IP Connection verbunden wurde (siehe Beispiele oben).

void lcd_128x64_destroy(LCD128x64 *lcd_128x64)
Parameter:
  • lcd_128x64 – Typ: LCD128x64 *

Entfernt das Geräteobjekt lcd_128x64 von dessen IP Connection und zerstört es. Das Geräteobjekt kann hiernach nicht mehr verwendet werden.

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)
Parameter:
  • lcd_128x64 – Typ: LCD128x64 *
  • x_start – Typ: uint8_t, Wertebereich: [0 bis 127]
  • y_start – Typ: uint8_t, Wertebereich: [0 bis 63]
  • x_end – Typ: uint8_t, Wertebereich: [0 bis 127]
  • y_end – Typ: uint8_t, Wertebereich: [0 bis 63]
  • pixels – Typ: bool *
  • pixels_length – Typ: uint16_t
Rückgabe:
  • error_code – Typ: int

Schreibt Pixel in das angegebene Fenster.

Die Pixel werden zeilenweise von oben nach unten geschrieben und die Zeilen werden jeweils von links nach rechts geschrieben.

Wenn Automatic Draw aktiviert ist (Standard), dann werden die Pixel direkt auf den Display geschrieben. Nur Pixel die sich wirklich verändert haben werden auf dem Display aktualisiert.

Wenn Automatic Draw deaktiviert ist, dann werden die Pixel in einen internen Buffer geschrieben der dann durch einen Aufruf von lcd_128x64_draw_buffered_frame() auf dem Display angezeigt werden kann. Dadurch kann Flicker vermieden werden, wenn ein komplexes Bild in mehreren Schritten aufgebaut wird.

Automatic Draw kann über die lcd_128x64_set_display_configuration() Funktion eingestellt werden.

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)
Parameter:
  • lcd_128x64 – Typ: LCD128x64 *
  • x_start – Typ: uint8_t, Wertebereich: [0 bis 127]
  • y_start – Typ: uint8_t, Wertebereich: [0 bis 63]
  • x_end – Typ: uint8_t, Wertebereich: [0 bis 127]
  • y_end – Typ: uint8_t, Wertebereich: [0 bis 63]
Ausgabeparameter:
  • ret_pixels – Typ: bool *
  • ret_pixels_length – Typ: uint16_t
Rückgabe:
  • error_code – Typ: int

Liest Pixel aus dem angegebenen Fenster.

Die Pixel werden zeilenweise von oben nach unten und die Zeilen werden jeweils von links nach rechts gelesen.

Wenn Automatic Draw aktiviert ist (Standard), dann werden die Pixel direkt vom Display gelesen.

Wenn Automatic Draw deaktiviert ist, dann werden die Pixel aus einen internen Buffer gelesen (siehe lcd_128x64_draw_buffered_frame()).

Automatic Draw kann über die lcd_128x64_set_display_configuration() Funktion eingestellt werden.

int lcd_128x64_clear_display(LCD128x64 *lcd_128x64)
Parameter:
  • lcd_128x64 – Typ: LCD128x64 *
Rückgabe:
  • error_code – Typ: int

Löscht den kompletten aktuellen Inhalt des Displays.

Wenn Automatic Draw aktiviert ist (Standard), dann werden die Pixel direkt gelöscht.

Wenn Automatic Draw deaktiviert ist, dann werden die Pixel im internen Buffer gelöscht der dann durch einen Aufruf von lcd_128x64_draw_buffered_frame() auf dem Display angezeigt werden kann. Dadurch kann Flicker vermieden werden, wenn ein komplexes Bild in mehreren Schritten aufgebaut wird.

Automatic Draw kann über die lcd_128x64_set_display_configuration() Funktion eingestellt werden.

int lcd_128x64_write_line(LCD128x64 *lcd_128x64, uint8_t line, uint8_t position, const char text[22])
Parameter:
  • lcd_128x64 – Typ: LCD128x64 *
  • line – Typ: uint8_t, Wertebereich: [0 bis 7]
  • position – Typ: uint8_t, Wertebereich: [0 bis 21]
  • text – Typ: const char[22]
Rückgabe:
  • error_code – Typ: int

Schreibt einen Text in die angegebene Zeile mit einer vorgegebenen Position.

Beispiel: (1, 10, "Hallo") schreibt Hallo in die Mitte der zweiten Zeile des Displays.

Das Display nutzt einen speziellen 5x7 Pixel Zeichensatz. Der Zeichensatz kann mit Hilfe von Brick Viewer angezeigt werden.

Wenn Automatic Draw aktiviert ist (Standard), dann wird der Text direkt auf den Display geschrieben. Nur Pixel die sich wirklich verändert haben werden auf dem Display aktualisiert.

Wenn Automatic Draw deaktiviert ist, dann wird der Text in einen internen Buffer geschrieben der dann durch einen Aufruf von lcd_128x64_draw_buffered_frame() auf dem Display angezeigt werden kann. Dadurch kann Flicker vermieden werden, wenn ein komplexes Bild in mehreren Schritten aufgebaut wird.

Automatic Draw kann über die lcd_128x64_set_display_configuration() Funktion eingestellt werden.

Diese Funktion ist ein 1:1-Ersatz für die Funktion mit dem gleichen Namen im LCD 20x4 Bricklet. Mit der Funktion lcd_128x64_draw_text() kann Text Pixelgenau und mit unterschiedlichen Font-Größen gezeichnet werden.

int lcd_128x64_draw_buffered_frame(LCD128x64 *lcd_128x64, bool force_complete_redraw)
Parameter:
  • lcd_128x64 – Typ: LCD128x64 *
  • force_complete_redraw – Typ: bool
Rückgabe:
  • error_code – Typ: int

Stellt den aktuell Inhalt des internen Buffers auf dem Display dar. Normalerweise schreibt jeder Aufruf von lcd_128x64_write_pixels() und lcd_128x64_write_line() direkt auf den Display. Wenn jedoch Automatic Draw deaktiviert ist (lcd_128x64_set_display_configuration()), dann werden Änderungen in einen internen Buffer anstatt auf den Display geschrieben. Der internen Buffer kann dann durch einen Aufruf dieser Funktion auf den Display geschrieben werden. Dadurch kann Flicker vermieden werden, wenn ein komplexes Bild in mehreren Schritten aufgebaut wird.

Wenn Force Complete Redraw auf true gesetzt ist, dann wird der gesamte Display aktualisiert, anstatt nur die Pixel die sich wirklich verändert haben. Normalerweise sollte dies nicht notwendig sein, außer bei hängenden Pixeln bedingt durch Fehler.

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)
Parameter:
  • lcd_128x64 – Typ: LCD128x64 *
Ausgabeparameter:
  • ret_pressure – Typ: uint16_t, Wertebereich: [0 bis 300]
  • ret_x – Typ: uint16_t, Wertebereich: [0 bis 127]
  • ret_y – Typ: uint16_t, Wertebereich: [0 bis 63]
  • ret_age – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1]
Rückgabe:
  • error_code – Typ: int

Gibt die letzte gültige Touch-Position zurück:

  • Pressure: Anpressdruck des Touches
  • X: Touch-Position auf der X-Achse
  • Y: Touch-Position auf der Y-Achse
  • Age: Alter des Touches (wie lange ist die Erkennung des Touches her)
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)
Parameter:
  • lcd_128x64 – Typ: LCD128x64 *
Ausgabeparameter:
  • ret_gesture – Typ: uint8_t, Wertebereich: Siehe Konstanten
  • ret_duration – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1]
  • ret_pressure_max – Typ: uint16_t, Wertebereich: [0 bis 300]
  • ret_x_start – Typ: uint16_t, Wertebereich: [0 bis 127]
  • ret_y_start – Typ: uint16_t, Wertebereich: [0 bis 63]
  • ret_x_end – Typ: uint16_t, Wertebereich: [0 bis 127]
  • ret_y_end – Typ: uint16_t, Wertebereich: [0 bis 63]
  • ret_age – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1]
Rückgabe:
  • error_code – Typ: int

Gibt eine der vier Touch-Gesten zurück, die das Bricklet automatisch erkennen kann.

Die Gesten umfassen Wischen von links nach rechts, rechts nach links, oben nach unten und unten nach oben.

Zusätzlich zu Geste wird der Vektor von Start- nach Endposition des Wischens angegeben. Dieser kann genutzt werden um die genaue Position der Geste zu ermitteln (z.B. ob ein Wischen von oben nach unten auf der linken oder rechten des Bildschirms erkannt wurde).

Der Age Parameter gibt das Alter der Geste an (wie lange ist die Erkennung der Geste her).

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für ret_gesture:

  • 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)
Parameter:
  • lcd_128x64 – Typ: LCD128x64 *
  • position_x_start – Typ: uint8_t, Wertebereich: [0 bis 127]
  • position_y_start – Typ: uint8_t, Wertebereich: [0 bis 63]
  • position_x_end – Typ: uint8_t, Wertebereich: [0 bis 127]
  • position_y_end – Typ: uint8_t, Wertebereich: [0 bis 63]
  • color – Typ: bool
Rückgabe:
  • error_code – Typ: int

Zeichnet eine weiße oder schwarze Linie von (x, y)-start nach (x, y)-end.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für color:

  • LCD_128X64_COLOR_WHITE = false
  • LCD_128X64_COLOR_BLACK = true

Neu 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)
Parameter:
  • lcd_128x64 – Typ: LCD128x64 *
  • position_x_start – Typ: uint8_t, Wertebereich: [0 bis 127]
  • position_y_start – Typ: uint8_t, Wertebereich: [0 bis 63]
  • position_x_end – Typ: uint8_t, Wertebereich: [0 bis 127]
  • position_y_end – Typ: uint8_t, Wertebereich: [0 bis 63]
  • fill – Typ: bool
  • color – Typ: bool
Rückgabe:
  • error_code – Typ: int

Zeichnet ein weißes oder schwarzes Rechteck von (x, y)-start nach (x, y)-end.

Wenn fill auf true gesetzt wird, wird das Rechteck mit der angegebenen Farbe ausgefüllt. Ansonsten wird nur der Umriss gezeichnet.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für color:

  • LCD_128X64_COLOR_WHITE = false
  • LCD_128X64_COLOR_BLACK = true

Neu 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])
Parameter:
  • lcd_128x64 – Typ: LCD128x64 *
  • position_x – Typ: uint8_t, Wertebereich: [0 bis 127]
  • position_y – Typ: uint8_t, Wertebereich: [0 bis 63]
  • font – Typ: uint8_t, Wertebereich: Siehe Konstanten
  • color – Typ: bool
  • text – Typ: const char[22]
Rückgabe:
  • error_code – Typ: int

Zeichnet einen Text an die Pixelposition (x, y).

Es können 9 unterschiedliche Font-Größen genutzt werden und der Text kann in weiß oder schwarz gezeichnet werden.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für font:

  • 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

Für color:

  • LCD_128X64_COLOR_WHITE = false
  • LCD_128X64_COLOR_BLACK = true

Neu 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])
Parameter:
  • lcd_128x64 – Typ: LCD128x64 *
  • index – Typ: uint8_t, Wertebereich: [0 bis 11]
  • position_x – Typ: uint8_t, Wertebereich: [0 bis 127]
  • position_y – Typ: uint8_t, Wertebereich: [0 bis 63]
  • width – Typ: uint8_t, Wertebereich: [1 bis 128]
  • height – Typ: uint8_t, Wertebereich: [1 bis 64]
  • text – Typ: const char[16]
Rückgabe:
  • error_code – Typ: int

Zeichnet einen klickbaren Button an Position (x, y) mit dem gegebenem Text.

Es können bis zu 12 Buttons genutzt werden.

Die x-Position + Width muss im Wertebereich von 1 bis 128 liegen und die y-Position+Height muss im Wertebereich von 1 bis 64 liegen.

Die minimale nützliche Breite/Höhe eines Buttons ist 3.

Der Callback für Button-Events kann mit der Funktion lcd_128x64_set_gui_button_pressed_callback_configuration() eingestellt werden. Der Callback wird sowohl für gedrückt als auch losgelassen Events ausgelöst.

Der Button wird in einem separaten GUI-Buffer gezeichnet und der Rahmen des Buttons wird immer über den Grafiken bleiben die mit lcd_128x64_write_pixels() gezeichnet werden. Um einen Button zu entfernen kann die Funktion lcd_128x64_remove_gui_button() genutzt werden.

Wenn anstatt des Textes ein Icon verwendet werden soll, kann dieses innerhalb des Buttons mit per lcd_128x64_write_pixels() gezeichnet werden.

Neu 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])
Parameter:
  • lcd_128x64 – Typ: LCD128x64 *
  • index – Typ: uint8_t, Wertebereich: [0 bis 11]
Ausgabeparameter:
  • ret_active – Typ: bool
  • ret_position_x – Typ: uint8_t, Wertebereich: [0 bis 127]
  • ret_position_y – Typ: uint8_t, Wertebereich: [0 bis 63]
  • ret_width – Typ: uint8_t, Wertebereich: [1 bis 128]
  • ret_height – Typ: uint8_t, Wertebereich: [1 bis 64]
  • ret_text – Typ: char[16]
Rückgabe:
  • error_code – Typ: int

Gibt die Button-Eigenschaften für den gegebenen Index zurück, wie von lcd_128x64_set_gui_button() gesetzt.

Zusätzlich gibt der Active-Parameter an ob der Button aktuell aktiv/sichtbar ist oder nicht.

Neu in Version 2.0.2 (Plugin).

int lcd_128x64_remove_gui_button(LCD128x64 *lcd_128x64, uint8_t index)
Parameter:
  • lcd_128x64 – Typ: LCD128x64 *
  • index – Typ: uint8_t, Wertebereich: [0 bis 11, 255]
Rückgabe:
  • error_code – Typ: int

Entfernt den Button mit dem gegebenen Index.

Index 255 kann genutzt werden um alle Buttons zu entfernen.

Neu in Version 2.0.2 (Plugin).

int lcd_128x64_get_gui_button_pressed(LCD128x64 *lcd_128x64, uint8_t index, bool *ret_pressed)
Parameter:
  • lcd_128x64 – Typ: LCD128x64 *
  • index – Typ: uint8_t, Wertebereich: [0 bis 11]
Ausgabeparameter:
  • ret_pressed – Typ: bool
Rückgabe:
  • error_code – Typ: int

Gibt den aktuellen Button-Zustand für einen gegebenen Index zurück.

Der Zustand kann entweder gedrückt (true) oder losgelassen (false) sein.

Neu 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)
Parameter:
  • lcd_128x64 – Typ: LCD128x64 *
  • index – Typ: uint8_t, Wertebereich: [0 bis 5]
  • position_x – Typ: uint8_t, Wertebereich: [0 bis 128]
  • position_y – Typ: uint8_t, Wertebereich: [0 bis 64]
  • length – Typ: uint8_t, Wertebereich: [8 bis 128]
  • direction – Typ: uint8_t, Wertebereich: Siehe Konstanten
  • value – Typ: uint8_t, Wertebereich: [0 bis 120]
Rückgabe:
  • error_code – Typ: int

Zeichnet einen Slider an Position (x, y) mit der gegebenen Länge.

Es können bis zu 8 Slider genutzt werden (Index 0-7).

Wenn eine horizontale Richtung verwendet wird muss Die x-Position + Länge im Wertebereich von 1 bis 128 und die y-Position im Wertebereich von 0 bis 46 liegen.

Wenn eine vertikale Richtung verwendet wird muss Die y-Position + Länge im Wertebereich von 1 bis 64 und die x-Position im Wertebereich von 0 bis 110 liegen.

Die minimale Länge des Sliders ist 8.

Der Parameter value ist die Startposition des Sliders. Diese kann zwischen 0 und length-8 liegen.

Der Callback für Slider-Events kann mit der Funktion lcd_128x64_set_gui_slider_value_callback_configuration() eingestellt werden.

Der Slider wird in einem separaten GUI-Buffer gezeichnet und der Rahmen des Buttons wrd immer über den Grafiken bleiben die mit lcd_128x64_write_pixels() gezeichnet werden. Um einen Button zu entfernen kann die Funktion lcd_128x64_remove_gui_slider() genutzt werden.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für direction:

  • LCD_128X64_DIRECTION_HORIZONTAL = 0
  • LCD_128X64_DIRECTION_VERTICAL = 1

Neu 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)
Parameter:
  • lcd_128x64 – Typ: LCD128x64 *
  • index – Typ: uint8_t, Wertebereich: [0 bis 5]
Ausgabeparameter:
  • ret_active – Typ: bool
  • ret_position_x – Typ: uint8_t, Wertebereich: [0 bis 128]
  • ret_position_y – Typ: uint8_t, Wertebereich: [0 bis 64]
  • ret_length – Typ: uint8_t, Wertebereich: [8 bis 128]
  • ret_direction – Typ: uint8_t, Wertebereich: Siehe Konstanten
  • ret_value – Typ: uint8_t, Wertebereich: [0 bis 120]
Rückgabe:
  • error_code – Typ: int

Gibt die Slider-Eigenschaften für den gegebenen Index zurück, wie von lcd_128x64_set_gui_slider() gesetzt.

Zusätzlich gibt der Active-Parameter an ob der Button aktuell aktiv/sichtbar ist oder nicht.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für ret_direction:

  • LCD_128X64_DIRECTION_HORIZONTAL = 0
  • LCD_128X64_DIRECTION_VERTICAL = 1

Neu in Version 2.0.2 (Plugin).

int lcd_128x64_remove_gui_slider(LCD128x64 *lcd_128x64, uint8_t index)
Parameter:
  • lcd_128x64 – Typ: LCD128x64 *
  • index – Typ: uint8_t, Wertebereich: [0 bis 5, 255]
Rückgabe:
  • error_code – Typ: int

Entfernt den Slider mit dem gegebenen Index.

Index 255 kann genutzt werden um alle Slider zu entfernen.

Neu in Version 2.0.2 (Plugin).

int lcd_128x64_get_gui_slider_value(LCD128x64 *lcd_128x64, uint8_t index, uint8_t *ret_value)
Parameter:
  • lcd_128x64 – Typ: LCD128x64 *
  • index – Typ: uint8_t, Wertebereich: [0 bis 5]
Ausgabeparameter:
  • ret_value – Typ: uint8_t, Wertebereich: [0 bis 120]
Rückgabe:
  • error_code – Typ: int

Gibt den aktuellen Wert des Slider mit dem gegebenen Index zurück.

Neu in Version 2.0.2 (Plugin).

int lcd_128x64_set_gui_tab_configuration(LCD128x64 *lcd_128x64, uint8_t change_tab_config, bool clear_gui)
Parameter:
  • lcd_128x64 – Typ: LCD128x64 *
  • change_tab_config – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 3
  • clear_gui – Typ: bool, Standardwert: true
Rückgabe:
  • error_code – Typ: int

Setzt die generelle Konfiguration für Tabs. Tabs können auf klicken, wischen (links/rechts und rechts/links) oder beides reagieren.

Zusätzlich kann Clear GUI auf true gesetzt werden. In diesem Fall werden bei einem wechsel der Tabs automatisch alle GUI Elemente (Buttons, Slider, Graphen) gelöscht.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für change_tab_config:

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

Neu 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)
Parameter:
  • lcd_128x64 – Typ: LCD128x64 *
Ausgabeparameter:
  • ret_change_tab_config – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 3
  • ret_clear_gui – Typ: bool, Standardwert: true
Rückgabe:
  • error_code – Typ: int

Gibt die Tab-Konfiguration zurück, wie von lcd_128x64_set_gui_tab_configuration() gesetzt.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für ret_change_tab_config:

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

Neu in Version 2.0.2 (Plugin).

int lcd_128x64_set_gui_tab_text(LCD128x64 *lcd_128x64, uint8_t index, const char text[5])
Parameter:
  • lcd_128x64 – Typ: LCD128x64 *
  • index – Typ: uint8_t, Wertebereich: [0 bis 9]
  • text – Typ: const char[5]
Rückgabe:
  • error_code – Typ: int

Fügt einen Text-Tab mit dem gegebenen Index hinzu.

Es können bis zu 10 Tabs verwendet werden.

Ein Text-Tab mit dem gleichen Index wie ein Icon-Tab überschreibt diesen.

Neu 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])
Parameter:
  • lcd_128x64 – Typ: LCD128x64 *
  • index – Typ: uint8_t, Wertebereich: [0 bis 9]
Ausgabeparameter:
  • ret_active – Typ: bool
  • ret_text – Typ: char[5]
Rückgabe:
  • error_code – Typ: int

Gibt den Text für den gegebenen Index zurück, wie von lcd_128x64_set_gui_tab_text() gesetzt.

Zusätzlich gibt der Active-Parameter an ob der Tab aktuell aktiv/sichtbar ist oder nicht.

Neu in Version 2.0.2 (Plugin).

int lcd_128x64_set_gui_tab_icon(LCD128x64 *lcd_128x64, uint8_t index, bool icon[168])
Parameter:
  • lcd_128x64 – Typ: LCD128x64 *
  • index – Typ: uint8_t, Wertebereich: [0 bis 9]
  • icon – Typ: bool[168]
Rückgabe:
  • error_code – Typ: int

Fügt einen Icon-Tab mit dem gegebenen Index hinzu. Das Icon kann eine Breite von 28 Pixel bei einer Höhe von 6 Pixel haben. Es wird Zeile für Zeile von links nach rechts gezeichnet.

Es können bis zu 10 Tabs verwendet werden.

Ein Icon-Tab mit dem gleichen Index wie ein Text-Tab überschreibt diesen.

Neu 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])
Parameter:
  • lcd_128x64 – Typ: LCD128x64 *
  • index – Typ: uint8_t, Wertebereich: [0 bis 9]
Ausgabeparameter:
  • ret_active – Typ: bool
  • ret_icon – Typ: bool[168]
Rückgabe:
  • error_code – Typ: int

Gibt das Icon für den gegebenen Index zurück, wie von lcd_128x64_set_gui_tab_icon() gesetzt.

Zusätzlich gibt der Active-Parameter an ob der Tab aktuell aktiv/sichtbar ist oder nicht.

Neu in Version 2.0.2 (Plugin).

int lcd_128x64_remove_gui_tab(LCD128x64 *lcd_128x64, uint8_t index)
Parameter:
  • lcd_128x64 – Typ: LCD128x64 *
  • index – Typ: uint8_t, Wertebereich: [0 bis 9, 255]
Rückgabe:
  • error_code – Typ: int

Entfernt den Tab mit dem gegebenen Index.

Index 255 kann genutzt werden um alle Tabs zu entfernen.

Neu in Version 2.0.2 (Plugin).

int lcd_128x64_set_gui_tab_selected(LCD128x64 *lcd_128x64, uint8_t index)
Parameter:
  • lcd_128x64 – Typ: LCD128x64 *
  • index – Typ: uint8_t, Wertebereich: [0 bis 9]
Rückgabe:
  • error_code – Typ: int

Setzt den Tab mit dem gegebenen Index als "selected" (wird auf dem Display als ausgewählt gezeichnet)

Neu in Version 2.0.2 (Plugin).

int lcd_128x64_get_gui_tab_selected(LCD128x64 *lcd_128x64, int8_t *ret_index)
Parameter:
  • lcd_128x64 – Typ: LCD128x64 *
Ausgabeparameter:
  • ret_index – Typ: int8_t, Wertebereich: [-1 bis 9]
Rückgabe:
  • error_code – Typ: int

Gibt den Index des aktuell ausgewählten Tabs zurück. Wenn es keine Tabs gibt, wird -1 als Index zurückgegeben.

Neu 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])
Parameter:
  • lcd_128x64 – Typ: LCD128x64 *
  • index – Typ: uint8_t, Wertebereich: [0 bis 3]
  • graph_type – Typ: uint8_t, Wertebereich: Siehe Konstanten
  • position_x – Typ: uint8_t, Wertebereich: [0 bis 127]
  • position_y – Typ: uint8_t, Wertebereich: [0 bis 63]
  • width – Typ: uint8_t, Wertebereich: [0 bis 118]
  • height – Typ: uint8_t, Wertebereich: [0 bis 63]
  • text_x – Typ: const char[4]
  • text_y – Typ: const char[4]
Rückgabe:
  • error_code – Typ: int

Setzt die Konfiguration für bis zu vier Graphen.

Der Graph kann vom Typ Dot-, Line- oder Bar-Graph sein.

Die x- und y-Positionen sind Pixel-Positionen.

Es können bis zu 4 Buchstaben Text zur Beschreibung der x- und y-Achse genutzt werden. Der Text wird auf die Innenseite des Graphen gezeichnet und er kann Datenpunkte des Graphen überschreiben. Wenn der Text außerhalb des Graphen benötigt wird kann die Beschriftung hier leer gelassen werden. Der Text kann im Nachhinein mit lcd_128x64_draw_text() hinzugefügt werden.

Die Datenpunkte des Graphen können mit der Funktion lcd_128x64_set_gui_graph_data() gesetzt und aktualisiert werden.

Der Graph wird in einem separaten GUI-Buffer gezeichnet und der Rahmen sowie die Datenpunkte des Graphen werden immer über den Grafiken bleiben die mit lcd_128x64_write_pixels() gezeichnet werden. Um einen Graphen zu entfernen kann die Funktion lcd_128x64_remove_gui_graph() genutzt werden.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für graph_type:

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

Neu 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])
Parameter:
  • lcd_128x64 – Typ: LCD128x64 *
  • index – Typ: uint8_t, Wertebereich: [0 bis 3]
Ausgabeparameter:
  • ret_active – Typ: bool
  • ret_graph_type – Typ: uint8_t, Wertebereich: Siehe Konstanten
  • ret_position_x – Typ: uint8_t, Wertebereich: [0 bis 127]
  • ret_position_y – Typ: uint8_t, Wertebereich: [0 bis 63]
  • ret_width – Typ: uint8_t, Wertebereich: [0 bis 118]
  • ret_height – Typ: uint8_t, Wertebereich: [0 bis 63]
  • ret_text_x – Typ: char[4]
  • ret_text_y – Typ: char[4]
Rückgabe:
  • error_code – Typ: int

Gibt die Graph-Eigenschaften für den gegebenen Index zurück, wie von lcd_128x64_set_gui_graph_configuration() gesetzt.

Zusätzlich gibt der Active-Parameter an ob der Button aktuell aktiv/sichtbar ist oder nicht.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für ret_graph_type:

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

Neu 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)
Parameter:
  • lcd_128x64 – Typ: LCD128x64 *
  • index – Typ: uint8_t, Wertebereich: [0 bis 3]
  • data – Typ: uint8_t *, Wertebereich: [0 bis 255]
  • data_length – Typ: uint16_t
Rückgabe:
  • error_code – Typ: int

Setzt die Datenpukte für den Graph mit dem gegebenen Index. Der Graph muss mit lcd_128x64_set_gui_graph_configuration() konfiguriert werden bevor die ersten Daten gesetzt werden können.

Der Graph zeigt die ersten n Werte der gesetzten Daten an, wobei n die Breite (width) ist die mit lcd_128x64_set_gui_graph_configuration() gesetzt wurde. Wenn weniger als n Werte gesetzt werden, werden die restlichen Datenpunkte als 0 angezeigt.

Die maximale Anzahl an Datenpunkte die gesetzt werden kann ist 118 (dies entspricht auch der maximalen Breite des Graphen).

Die gesetzten Werte müssen zwischen 0 und 255 skaliert werden. 0 wird unten und 255 wird oben im Graph gezeichnet.

Neu 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)
Parameter:
  • lcd_128x64 – Typ: LCD128x64 *
  • index – Typ: uint8_t, Wertebereich: [0 bis 3]
Ausgabeparameter:
  • ret_data – Typ: uint8_t *, Wertebereich: [0 bis 255]
  • ret_data_length – Typ: uint16_t
Rückgabe:
  • error_code – Typ: int

Gibt die Datenpunkte des Graphen mit dem gegebenen Index zurück, wie von lcd_128x64_set_gui_graph_data() gesetzt.

Neu in Version 2.0.2 (Plugin).

int lcd_128x64_remove_gui_graph(LCD128x64 *lcd_128x64, uint8_t index)
Parameter:
  • lcd_128x64 – Typ: LCD128x64 *
  • index – Typ: uint8_t, Wertebereich: [0 bis 3, 255]
Rückgabe:
  • error_code – Typ: int

Entfernt den Graph mit dem gegebenen Index.

Index 255 kann genutzt werden um alle Graphen zu entfernen.

Neu in Version 2.0.2 (Plugin).

int lcd_128x64_remove_all_gui(LCD128x64 *lcd_128x64)
Parameter:
  • lcd_128x64 – Typ: LCD128x64 *
Rückgabe:
  • error_code – Typ: int

Entfernt alle GUI-Elemente (Buttons, Slider, Graphen, Tabs).

Neu in Version 2.0.2 (Plugin).

Fortgeschrittene Funktionen

int lcd_128x64_set_display_configuration(LCD128x64 *lcd_128x64, uint8_t contrast, uint8_t backlight, bool invert, bool automatic_draw)
Parameter:
  • lcd_128x64 – Typ: LCD128x64 *
  • contrast – Typ: uint8_t, Wertebereich: [0 bis 63], Standardwert: 14
  • backlight – Typ: uint8_t, Wertebereich: [0 bis 100], Standardwert: 100
  • invert – Typ: bool, Standardwert: false
  • automatic_draw – Typ: bool, Standardwert: true
Rückgabe:
  • error_code – Typ: int

Setzt die Konfiguration des Displays.

Wenn Automatic Draw aktiviert (true) ist dann wird das Display bei jedem Aufruf von lcd_128x64_write_pixels() und lcd_128x64_write_line() aktualisiert. Wenn Automatic Draw deaktiviert (false) ist, dann werden Änderungen in einen internen Buffer geschrieben, der dann bei bei einem Aufruf von lcd_128x64_draw_buffered_frame() auf dem Display angezeigt wird.

int lcd_128x64_get_display_configuration(LCD128x64 *lcd_128x64, uint8_t *ret_contrast, uint8_t *ret_backlight, bool *ret_invert, bool *ret_automatic_draw)
Parameter:
  • lcd_128x64 – Typ: LCD128x64 *
Ausgabeparameter:
  • ret_contrast – Typ: uint8_t, Wertebereich: [0 bis 63], Standardwert: 14
  • ret_backlight – Typ: uint8_t, Wertebereich: [0 bis 100], Standardwert: 100
  • ret_invert – Typ: bool, Standardwert: false
  • ret_automatic_draw – Typ: bool, Standardwert: true
Rückgabe:
  • error_code – Typ: int

Gibt die Konfiguration zurück, wie von lcd_128x64_set_display_configuration() gesetzt.

int lcd_128x64_set_touch_led_config(LCD128x64 *lcd_128x64, uint8_t config)
Parameter:
  • lcd_128x64 – Typ: LCD128x64 *
  • config – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 3
Rückgabe:
  • error_code – Typ: int

Setzt die Konfiguration der Kommunikations-LED. Standardmäßig ist die LED an wenn das LCD berührt wird.

Die LED kann auch permanent an/aus gestellt werden oder einen Herzschlag anzeigen.

Wenn das Bricklet sich im Bootloadermodus befindet ist die LED aus.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für config:

  • 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

Neu in Version 2.0.2 (Plugin).

int lcd_128x64_get_touch_led_config(LCD128x64 *lcd_128x64, uint8_t *ret_config)
Parameter:
  • lcd_128x64 – Typ: LCD128x64 *
Ausgabeparameter:
  • ret_config – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 3
Rückgabe:
  • error_code – Typ: int

Gibt die Konfiguration zurück, wie von lcd_128x64_set_touch_led_config() gesetzt.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für ret_config:

  • 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

Neu in Version 2.0.2 (Plugin).

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)
Parameter:
  • lcd_128x64 – Typ: LCD128x64 *
Ausgabeparameter:
  • ret_error_count_ack_checksum – Typ: uint32_t, Wertebereich: [0 bis 232 - 1]
  • ret_error_count_message_checksum – Typ: uint32_t, Wertebereich: [0 bis 232 - 1]
  • ret_error_count_frame – Typ: uint32_t, Wertebereich: [0 bis 232 - 1]
  • ret_error_count_overflow – Typ: uint32_t, Wertebereich: [0 bis 232 - 1]
Rückgabe:
  • error_code – Typ: int

Gibt die Anzahl der Fehler die während der Kommunikation zwischen Brick und Bricklet aufgetreten sind zurück.

Die Fehler sind aufgeteilt in

  • ACK-Checksummen Fehler,
  • Message-Checksummen Fehler,
  • Framing Fehler und
  • Overflow Fehler.

Die Fehlerzähler sind für Fehler die auf der Seite des Bricklets auftreten. Jedes Brick hat eine ähnliche Funktion welche die Fehler auf Brickseite ausgibt.

int lcd_128x64_set_bootloader_mode(LCD128x64 *lcd_128x64, uint8_t mode, uint8_t *ret_status)
Parameter:
  • lcd_128x64 – Typ: LCD128x64 *
  • mode – Typ: uint8_t, Wertebereich: Siehe Konstanten
Ausgabeparameter:
  • ret_status – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:
  • error_code – Typ: int

Setzt den Bootloader-Modus und gibt den Status zurück nachdem die Modusänderungsanfrage bearbeitet wurde.

Mit dieser Funktion ist es möglich vom Bootloader- in den Firmware-Modus zu wechseln und umgekehrt. Ein Welchsel vom Bootloader- in der den Firmware-Modus ist nur möglich wenn Entry-Funktion, Device Identifier und CRC vorhanden und korrekt sind.

Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für mode:

  • 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

Für ret_status:

  • 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)
Parameter:
  • lcd_128x64 – Typ: LCD128x64 *
Ausgabeparameter:
  • ret_mode – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:
  • error_code – Typ: int

Gibt den aktuellen Bootloader-Modus zurück, siehe lcd_128x64_set_bootloader_mode().

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für ret_mode:

  • 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)
Parameter:
  • lcd_128x64 – Typ: LCD128x64 *
  • pointer – Typ: uint32_t, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]
Rückgabe:
  • error_code – Typ: int

Setzt den Firmware-Pointer für lcd_128x64_write_firmware(). Der Pointer muss um je 64 Byte erhöht werden. Die Daten werden alle 4 Datenblöcke in den Flash geschrieben (4 Datenblöcke entsprechen einer Page mit 256 Byte).

Diese Funktion wird vom Brick Viewer während des flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

int lcd_128x64_write_firmware(LCD128x64 *lcd_128x64, uint8_t data[64], uint8_t *ret_status)
Parameter:
  • lcd_128x64 – Typ: LCD128x64 *
  • data – Typ: uint8_t[64], Wertebereich: [0 bis 255]
Ausgabeparameter:
  • ret_status – Typ: uint8_t, Wertebereich: [0 bis 255]
Rückgabe:
  • error_code – Typ: int

Schreibt 64 Bytes Firmware an die Position die vorher von lcd_128x64_set_write_firmware_pointer() gesetzt wurde. Die Firmware wird alle 4 Datenblöcke in den Flash geschrieben.

Eine Firmware kann nur im Bootloader-Mode geschrieben werden.

Diese Funktion wird vom Brick Viewer während des flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

int lcd_128x64_set_status_led_config(LCD128x64 *lcd_128x64, uint8_t config)
Parameter:
  • lcd_128x64 – Typ: LCD128x64 *
  • config – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 3
Rückgabe:
  • error_code – Typ: int

Setzt die Konfiguration der Status-LED. Standardmäßig zeigt die LED die Kommunikationsdatenmenge an. Sie blinkt einmal auf pro 10 empfangenen Datenpaketen zwischen Brick und Bricklet.

Die LED kann auch permanent an/aus gestellt werden oder einen Herzschlag anzeigen.

Wenn das Bricklet sich im Bootlodermodus befindet ist die LED aus.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für config:

  • 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)
Parameter:
  • lcd_128x64 – Typ: LCD128x64 *
Ausgabeparameter:
  • ret_config – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 3
Rückgabe:
  • error_code – Typ: int

Gibt die Konfiguration zurück, wie von lcd_128x64_set_status_led_config() gesetzt.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für ret_config:

  • 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)
Parameter:
  • lcd_128x64 – Typ: LCD128x64 *
Ausgabeparameter:
  • ret_temperature – Typ: int16_t, Einheit: 1 °C, Wertebereich: [-215 bis 215 - 1]
Rückgabe:
  • error_code – Typ: int

Gibt die Temperatur, gemessen im Mikrocontroller, aus. Der Rückgabewert ist nicht die Umgebungstemperatur.

Die Temperatur ist lediglich proportional zur echten Temperatur und hat eine hohe Ungenauigkeit. Daher beschränkt sich der praktische Nutzen auf die Indikation von Temperaturveränderungen.

int lcd_128x64_reset(LCD128x64 *lcd_128x64)
Parameter:
  • lcd_128x64 – Typ: LCD128x64 *
Rückgabe:
  • error_code – Typ: int

Ein Aufruf dieser Funktion setzt das Bricklet zurück. Nach einem Neustart sind alle Konfiguration verloren.

Nach dem Zurücksetzen ist es notwendig neue Objekte zu erzeugen, Funktionsaufrufe auf bestehenden führen zu undefiniertem Verhalten.

int lcd_128x64_write_uid(LCD128x64 *lcd_128x64, uint32_t uid)
Parameter:
  • lcd_128x64 – Typ: LCD128x64 *
  • uid – Typ: uint32_t, Wertebereich: [0 bis 232 - 1]
Rückgabe:
  • error_code – Typ: int

Schreibt eine neue UID in den Flash. Die UID muss zuerst vom Base58 encodierten String in einen Integer decodiert werden.

Wir empfehlen die Nutzung des Brick Viewers zum ändern der UID.

int lcd_128x64_read_uid(LCD128x64 *lcd_128x64, uint32_t *ret_uid)
Parameter:
  • lcd_128x64 – Typ: LCD128x64 *
Ausgabeparameter:
  • ret_uid – Typ: uint32_t, Wertebereich: [0 bis 232 - 1]
Rückgabe:
  • error_code – Typ: int

Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.

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)
Parameter:
  • lcd_128x64 – Typ: LCD128x64 *
Ausgabeparameter:
  • ret_uid – Typ: char[8]
  • ret_connected_uid – Typ: char[8]
  • ret_position – Typ: char, Wertebereich: ['a' bis 'h', 'i', 'z']
  • ret_hardware_version – Typ: uint8_t[3]
    • 0: major – Typ: uint8_t, Wertebereich: [0 bis 255]
    • 1: minor – Typ: uint8_t, Wertebereich: [0 bis 255]
    • 2: revision – Typ: uint8_t, Wertebereich: [0 bis 255]
  • ret_firmware_version – Typ: uint8_t[3]
    • 0: major – Typ: uint8_t, Wertebereich: [0 bis 255]
    • 1: minor – Typ: uint8_t, Wertebereich: [0 bis 255]
    • 2: revision – Typ: uint8_t, Wertebereich: [0 bis 255]
  • ret_device_identifier – Typ: uint16_t, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • error_code – Typ: int

Gibt die UID, die UID zu der das Bricklet verbunden ist, die Position, die Hard- und Firmware Version sowie den Device Identifier zurück.

Die Position 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss) sein. Der Raspberry Pi HAT (Zero) Brick ist immer an Position 'i' und das Bricklet hinter einem Isolator Bricklet ist immer an Position 'z'.

Eine Liste der Device Identifier Werte ist hier zu finden. Es gibt auch eine Konstante für den Device Identifier dieses Bricklets.

Konfigurationsfunktionen für Callbacks

void lcd_128x64_register_callback(LCD128x64 *lcd_128x64, int16_t callback_id, void (*function)(void), void *user_data)
Parameter:
  • lcd_128x64 – Typ: LCD128x64 *
  • callback_id – Typ: int16_t
  • function – Typ: void (*)(void)
  • user_data – Typ: void *

Registriert die function für die gegebene callback_id. Die user_data werden der Funktion als letztes Parameter mit übergeben.

Die verfügbaren Callback IDs mit den zugehörigen Funktionssignaturen sind unten zu finden.

int lcd_128x64_set_touch_position_callback_configuration(LCD128x64 *lcd_128x64, uint32_t period, bool value_has_to_change)
Parameter:
  • lcd_128x64 – Typ: LCD128x64 *
  • period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • value_has_to_change – Typ: bool, Standardwert: false
Rückgabe:
  • error_code – Typ: int

Die Periode ist die Periode mit der der LCD_128X64_CALLBACK_TOUCH_POSITION Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

int lcd_128x64_get_touch_position_callback_configuration(LCD128x64 *lcd_128x64, uint32_t *ret_period, bool *ret_value_has_to_change)
Parameter:
  • lcd_128x64 – Typ: LCD128x64 *
Ausgabeparameter:
  • ret_period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • ret_value_has_to_change – Typ: bool, Standardwert: false
Rückgabe:
  • error_code – Typ: int

Gibt die Callback-Konfiguration zurück, wie mittels lcd_128x64_set_touch_position_callback_configuration() gesetzt.

int lcd_128x64_set_touch_gesture_callback_configuration(LCD128x64 *lcd_128x64, uint32_t period, bool value_has_to_change)
Parameter:
  • lcd_128x64 – Typ: LCD128x64 *
  • period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • value_has_to_change – Typ: bool, Standardwert: false
Rückgabe:
  • error_code – Typ: int

Die Periode ist die Periode mit der der LCD_128X64_CALLBACK_TOUCH_GESTURE Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

int lcd_128x64_get_touch_gesture_callback_configuration(LCD128x64 *lcd_128x64, uint32_t *ret_period, bool *ret_value_has_to_change)
Parameter:
  • lcd_128x64 – Typ: LCD128x64 *
Ausgabeparameter:
  • ret_period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • ret_value_has_to_change – Typ: bool, Standardwert: false
Rückgabe:
  • error_code – Typ: int

Gibt die Callback-Konfiguration zurück, wie mittels lcd_128x64_set_touch_gesture_callback_configuration() gesetzt.

int lcd_128x64_set_gui_button_pressed_callback_configuration(LCD128x64 *lcd_128x64, uint32_t period, bool value_has_to_change)
Parameter:
  • lcd_128x64 – Typ: LCD128x64 *
  • period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • value_has_to_change – Typ: bool, Standardwert: false
Rückgabe:
  • error_code – Typ: int

Die Periode ist die Periode mit der der LCD_128X64_CALLBACK_GUI_BUTTON_PRESSED Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

Neu 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)
Parameter:
  • lcd_128x64 – Typ: LCD128x64 *
Ausgabeparameter:
  • ret_period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • ret_value_has_to_change – Typ: bool, Standardwert: false
Rückgabe:
  • error_code – Typ: int

Gibt die Callback-Konfiguration zurück, wie mittels lcd_128x64_set_gui_button_pressed_callback_configuration() gesetzt.

Neu 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)
Parameter:
  • lcd_128x64 – Typ: LCD128x64 *
  • period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • value_has_to_change – Typ: bool, Standardwert: false
Rückgabe:
  • error_code – Typ: int

Die Periode ist die Periode mit der der LCD_128X64_CALLBACK_GUI_SLIDER_VALUE Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

Neu 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)
Parameter:
  • lcd_128x64 – Typ: LCD128x64 *
Ausgabeparameter:
  • ret_period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • ret_value_has_to_change – Typ: bool, Standardwert: false
Rückgabe:
  • error_code – Typ: int

Gibt die Callback-Konfiguration zurück, wie mittels lcd_128x64_set_gui_slider_value_callback_configuration() gesetzt.

Neu 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)
Parameter:
  • lcd_128x64 – Typ: LCD128x64 *
  • period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • value_has_to_change – Typ: bool, Standardwert: false
Rückgabe:
  • error_code – Typ: int

Die Periode ist die Periode mit der der LCD_128X64_CALLBACK_GUI_TAB_SELECTED Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

Neu 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)
Parameter:
  • lcd_128x64 – Typ: LCD128x64 *
Ausgabeparameter:
  • ret_period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • ret_value_has_to_change – Typ: bool, Standardwert: false
Rückgabe:
  • error_code – Typ: int

Gibt die Callback-Konfiguration zurück, wie mittels lcd_128x64_set_gui_tab_selected_callback_configuration() gesetzt.

Neu in Version 2.0.2 (Plugin).

Callbacks

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann mit der lcd_128x64_register_callback() Funktion durchgeführt werden:

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

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

Die verfügbaren Konstanten mit den zugehörigen Funktionssignaturen werden weiter unten beschrieben.

Bemerkung

Callbacks für wiederkehrende Ereignisse zu verwenden ist immer zu bevorzugen gegenüber der Verwendung von Abfragen. Es wird weniger USB-Bandbreite benutzt und die Latenz ist erheblich geringer, da es keine Paketumlaufzeit gibt.

LCD_128X64_CALLBACK_TOUCH_POSITION
void callback(uint16_t pressure, uint16_t x, uint16_t y, uint32_t age, void *user_data)
Callback-Parameter:
  • pressure – Typ: uint16_t, Wertebereich: [0 bis 300]
  • x – Typ: uint16_t, Wertebereich: [0 bis 127]
  • y – Typ: uint16_t, Wertebereich: [0 bis 63]
  • age – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1]
  • user_data – Typ: void *

Dieser Callback wird mit der Periode, wie gesetzt mit lcd_128x64_set_touch_position_callback_configuration(), ausgelöst. Die Parameter sind die gleichen wie die von 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)
Callback-Parameter:
  • gesture – Typ: uint8_t, Wertebereich: Siehe Konstanten
  • duration – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1]
  • pressure_max – Typ: uint16_t, Wertebereich: [0 bis 300]
  • x_start – Typ: uint16_t, Wertebereich: [0 bis 127]
  • y_start – Typ: uint16_t, Wertebereich: [0 bis 63]
  • x_end – Typ: uint16_t, Wertebereich: [0 bis 127]
  • y_end – Typ: uint16_t, Wertebereich: [0 bis 63]
  • age – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1]
  • user_data – Typ: void *

Dieser Callback wird mit der Periode, wie gesetzt mit lcd_128x64_set_touch_gesture_callback_configuration(), ausgelöst. Die Parameter sind die gleichen wie die von lcd_128x64_get_touch_gesture().

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für gesture:

  • 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)
Callback-Parameter:
  • index – Typ: uint8_t, Wertebereich: [0 bis 11]
  • pressed – Typ: bool
  • user_data – Typ: void *

Dieser Callback wird mit der Periode, wie gesetzt mit lcd_128x64_set_gui_button_pressed_callback_configuration(), ausgelöst. Die Parameter sind die gleichen wie die von lcd_128x64_get_gui_button_pressed().

Neu in Version 2.0.2 (Plugin).

LCD_128X64_CALLBACK_GUI_SLIDER_VALUE
void callback(uint8_t index, uint8_t value, void *user_data)
Callback-Parameter:
  • index – Typ: uint8_t, Wertebereich: [0 bis 5]
  • value – Typ: uint8_t, Wertebereich: [0 bis 120]
  • user_data – Typ: void *

Dieser Callback wird mit der Periode, wie gesetzt mit lcd_128x64_set_gui_slider_value_callback_configuration(), ausgelöst. Die Parameter sind die gleichen wie die von lcd_128x64_get_gui_slider_value().

Neu in Version 2.0.2 (Plugin).

LCD_128X64_CALLBACK_GUI_TAB_SELECTED
void callback(int8_t index, void *user_data)
Callback-Parameter:
  • index – Typ: int8_t, Wertebereich: [0 bis 9]
  • user_data – Typ: void *

Dieser Callback wird mit der Periode, wie gesetzt mit lcd_128x64_set_gui_tab_selected_callback_configuration(), ausgelöst. Die Parameter sind die gleichen wie die von lcd_128x64_get_gui_tab_selected().

Neu in Version 2.0.2 (Plugin).

Virtuelle Funktionen

Virtuelle Funktionen kommunizieren nicht mit dem Gerät selbst, sie arbeiten nur auf dem API Bindings Objekt. Dadurch können sie auch aufgerufen werden, ohne das das dazugehörige IP Connection Objekt verbunden ist.

int lcd_128x64_get_api_version(LCD128x64 *lcd_128x64, uint8_t ret_api_version[3])
Parameter:
  • lcd_128x64 – Typ: LCD128x64 *
Ausgabeparameter:
  • ret_api_version – Typ: uint8_t[3]
    • 0: major – Typ: uint8_t, Wertebereich: [0 bis 255]
    • 1: minor – Typ: uint8_t, Wertebereich: [0 bis 255]
    • 2: revision – Typ: uint8_t, Wertebereich: [0 bis 255]
Rückgabe:
  • error_code – Typ: int

Gibt die Version der API Definition zurück, die diese API Bindings implementieren. Dies ist weder die Release-Version dieser API Bindings noch gibt es in irgendeiner Weise Auskunft über den oder das repräsentierte(n) Brick oder Bricklet.

int lcd_128x64_get_response_expected(LCD128x64 *lcd_128x64, uint8_t function_id, bool *ret_response_expected)
Parameter:
  • lcd_128x64 – Typ: LCD128x64 *
  • function_id – Typ: uint8_t, Wertebereich: Siehe Konstanten
Ausgabeparameter:
  • ret_response_expected – Typ: bool
Rückgabe:
  • error_code – Typ: int

Gibt das Response-Expected-Flag für die Funktion mit der angegebenen Funktions IDs zurück. Es ist true falls für die Funktion beim Aufruf eine Antwort erwartet wird, false andernfalls.

Für Getter-Funktionen ist diese Flag immer gesetzt und kann nicht entfernt werden, da diese Funktionen immer eine Antwort senden. Für Konfigurationsfunktionen für Callbacks ist es standardmäßig gesetzt, kann aber entfernt werden mittels lcd_128x64_set_response_expected(). Für Setter-Funktionen ist es standardmäßig nicht gesetzt, kann aber gesetzt werden.

Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für function_id:

  • 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(LCD128x64 *lcd_128x64, uint8_t function_id, bool response_expected)
Parameter:
  • lcd_128x64 – Typ: LCD128x64 *
  • function_id – Typ: uint8_t, Wertebereich: Siehe Konstanten
  • response_expected – Typ: bool
Rückgabe:
  • error_code – Typ: int

Ändert das Response-Expected-Flag für die Funktion mit der angegebenen Funktion IDs. Diese Flag kann nur für Setter-Funktionen (Standardwert: false) und Konfigurationsfunktionen für Callbacks (Standardwert: true) geändert werden. Für Getter-Funktionen ist das Flag immer gesetzt.

Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für function_id:

  • 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)
Parameter:
  • lcd_128x64 – Typ: LCD128x64 *
  • response_expected – Typ: bool
Rückgabe:
  • error_code – Typ: int

Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.

Konstanten

LCD_128X64_DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein LCD 128x64 Bricklet zu identifizieren.

Die lcd_128x64_get_identity() Funktion und der IPCON_CALLBACK_ENUMERATE Callback der IP Connection haben ein device_identifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

LCD_128X64_DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines LCD 128x64 Bricklet dar.