C/C++ - OLED 128x64 Bricklet 2.0

This is the description of the C/C++ API bindings for the OLED 128x64 Bricklet 2.0. General information and technical specifications for the OLED 128x64 Bricklet 2.0 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_oled_128x64_v2.h"

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

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

    // Create device object
    OLED128x64V2 oled;
    oled_128x64_v2_create(&oled, 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
    oled_128x64_v2_clear_display(&oled);

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

    printf("Press key to exit\n");
    getchar();
    oled_128x64_v2_destroy(&oled);
    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_oled_128x64_v2.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
    OLED128x64V2 oled;
    oled_128x64_v2_create(&oled, 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
    oled_128x64_v2_clear_display(&oled);

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

    oled_128x64_v2_write_pixels(&oled, 0, 0, WIDTH-1, HEIGHT-1, pixels, HEIGHT*WIDTH);

    printf("Press key to exit\n");
    getchar();
    oled_128x64_v2_destroy(&oled);
    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_oled_128x64_v2.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_oled_128x64_v2.h"

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

void draw_image(OLED128x64V2 *oled, 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;
        }
    }

    oled_128x64_v2_write_pixels(oled, 0, 0, WIDTH-1, HEIGHT-1, pixels, HEIGHT*WIDTH);
}

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

    // Create device object
    OLED128x64V2 oled;
    oled_128x64_v2_create(&oled, 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
    oled_128x64_v2_clear_display(&oled);

    // 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(&oled, image);
        millisleep(25);

        angle++;
    }

    gdImageDestroy(image);
    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 output parameters. 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 C/C++ 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
  • E_INVALID_UID = -13
  • E_NON_ASCII_CHAR_IN_SECRET = -14

as defined in ip_connection.h.

All functions listed below are thread-safe.

Basic Functions

void oled_128x64_v2_create(OLED128x64V2 *oled_128x64_v2, const char *uid, IPConnection *ipcon)
Parameters:
  • oled_128x64_v2 – Type: OLED128x64V2 *
  • uid – Type: const char *
  • ipcon – Type: IPConnection *

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

OLED128x64V2 oled_128x64_v2;
oled_128x64_v2_create(&oled_128x64_v2, "YOUR_DEVICE_UID", &ipcon);

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

void oled_128x64_v2_destroy(OLED128x64V2 *oled_128x64_v2)
Parameters:
  • oled_128x64_v2 – Type: OLED128x64V2 *

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

int oled_128x64_v2_write_pixels(OLED128x64V2 *oled_128x64_v2, uint8_t x_start, uint8_t y_start, uint8_t x_end, uint8_t y_end, bool *pixels, uint16_t pixels_length)
Parameters:
  • oled_128x64_v2 – Type: OLED128x64V2 *
  • x_start – Type: uint8_t, Range: [0 to 127]
  • y_start – Type: uint8_t, Range: [0 to 63]
  • x_end – Type: uint8_t, Range: [0 to 127]
  • y_end – Type: uint8_t, Range: [0 to 63]
  • pixels – Type: bool *
  • pixels_length – Type: uint16_t
Returns:
  • error_code – Type: int

Writes pixels to the specified window.

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

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

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

int oled_128x64_v2_read_pixels(OLED128x64V2 *oled_128x64_v2, uint8_t x_start, uint8_t y_start, uint8_t x_end, uint8_t y_end, bool *ret_pixels, uint16_t *ret_pixels_length)
Parameters:
  • oled_128x64_v2 – Type: OLED128x64V2 *
  • x_start – Type: uint8_t, Range: [0 to 127]
  • y_start – Type: uint8_t, Range: [0 to 63]
  • x_end – Type: uint8_t, Range: [0 to 127]
  • y_end – Type: uint8_t, Range: [0 to 63]
Output Parameters:
  • ret_pixels – Type: bool *
  • ret_pixels_length – Type: uint16_t
Returns:
  • error_code – Type: int

Reads pixels from the specified window.

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

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

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

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

int oled_128x64_v2_clear_display(OLED128x64V2 *oled_128x64_v2)
Parameters:
  • oled_128x64_v2 – Type: OLED128x64V2 *
Returns:
  • error_code – Type: int

Clears the complete content of the display.

If automatic draw is enabled (default) the pixels are directly cleared.

If automatic draw is disabled the the internal buffer is cleared and the buffer is transferred to the display only after oled_128x64_v2_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 oled_128x64_v2_set_display_configuration() function.

int oled_128x64_v2_write_line(OLED128x64V2 *oled_128x64_v2, uint8_t line, uint8_t position, const char text[22])
Parameters:
  • oled_128x64_v2 – Type: OLED128x64V2 *
  • line – Type: uint8_t, Range: [0 to 7]
  • position – Type: uint8_t, Range: [0 to 21]
  • text – Type: const char[22]
Returns:
  • error_code – Type: int

Writes text to a specific line with a specific position. 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.

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

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

int oled_128x64_v2_draw_buffered_frame(OLED128x64V2 *oled_128x64_v2, bool force_complete_redraw)
Parameters:
  • oled_128x64_v2 – Type: OLED128x64V2 *
  • force_complete_redraw – Type: bool
Returns:
  • error_code – Type: int

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

Advanced Functions

int oled_128x64_v2_set_display_configuration(OLED128x64V2 *oled_128x64_v2, uint8_t contrast, bool invert, bool automatic_draw)
Parameters:
  • oled_128x64_v2 – Type: OLED128x64V2 *
  • contrast – Type: uint8_t, Range: [0 to 255], Default: 143
  • invert – Type: bool, Default: false
  • automatic_draw – Type: bool, Default: true
Returns:
  • error_code – Type: int

Sets the configuration of the display.

You can set a contrast value from 0 to 255 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 oled_128x64_v2_write_pixels() or oled_128x64_v2_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 oled_128x64_v2_draw_buffered_frame().

int oled_128x64_v2_get_display_configuration(OLED128x64V2 *oled_128x64_v2, uint8_t *ret_contrast, bool *ret_invert, bool *ret_automatic_draw)
Parameters:
  • oled_128x64_v2 – Type: OLED128x64V2 *
Output Parameters:
  • ret_contrast – Type: uint8_t, Range: [0 to 255], Default: 143
  • ret_invert – Type: bool, Default: false
  • ret_automatic_draw – Type: bool, Default: true
Returns:
  • error_code – Type: int

Returns the configuration as set by oled_128x64_v2_set_display_configuration().

int oled_128x64_v2_get_spitfp_error_count(OLED128x64V2 *oled_128x64_v2, uint32_t *ret_error_count_ack_checksum, uint32_t *ret_error_count_message_checksum, uint32_t *ret_error_count_frame, uint32_t *ret_error_count_overflow)
Parameters:
  • oled_128x64_v2 – Type: OLED128x64V2 *
Output Parameters:
  • ret_error_count_ack_checksum – Type: uint32_t, Range: [0 to 232 - 1]
  • ret_error_count_message_checksum – Type: uint32_t, Range: [0 to 232 - 1]
  • ret_error_count_frame – Type: uint32_t, Range: [0 to 232 - 1]
  • ret_error_count_overflow – Type: uint32_t, Range: [0 to 232 - 1]
Returns:
  • error_code – Type: int

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

The errors are divided into

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

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

int oled_128x64_v2_set_bootloader_mode(OLED128x64V2 *oled_128x64_v2, uint8_t mode, uint8_t *ret_status)
Parameters:
  • oled_128x64_v2 – Type: OLED128x64V2 *
  • mode – Type: uint8_t, Range: See constants
Output Parameters:
  • ret_status – Type: uint8_t, Range: See constants
Returns:
  • error_code – Type: int

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

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

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

The following constants are available for this function:

For mode:

  • OLED_128X64_V2_BOOTLOADER_MODE_BOOTLOADER = 0
  • OLED_128X64_V2_BOOTLOADER_MODE_FIRMWARE = 1
  • OLED_128X64_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • OLED_128X64_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • OLED_128X64_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

For ret_status:

  • OLED_128X64_V2_BOOTLOADER_STATUS_OK = 0
  • OLED_128X64_V2_BOOTLOADER_STATUS_INVALID_MODE = 1
  • OLED_128X64_V2_BOOTLOADER_STATUS_NO_CHANGE = 2
  • OLED_128X64_V2_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • OLED_128X64_V2_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • OLED_128X64_V2_BOOTLOADER_STATUS_CRC_MISMATCH = 5
int oled_128x64_v2_get_bootloader_mode(OLED128x64V2 *oled_128x64_v2, uint8_t *ret_mode)
Parameters:
  • oled_128x64_v2 – Type: OLED128x64V2 *
Output Parameters:
  • ret_mode – Type: uint8_t, Range: See constants
Returns:
  • error_code – Type: int

Returns the current bootloader mode, see oled_128x64_v2_set_bootloader_mode().

The following constants are available for this function:

For ret_mode:

  • OLED_128X64_V2_BOOTLOADER_MODE_BOOTLOADER = 0
  • OLED_128X64_V2_BOOTLOADER_MODE_FIRMWARE = 1
  • OLED_128X64_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • OLED_128X64_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • OLED_128X64_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
int oled_128x64_v2_set_write_firmware_pointer(OLED128x64V2 *oled_128x64_v2, uint32_t pointer)
Parameters:
  • oled_128x64_v2 – Type: OLED128x64V2 *
  • pointer – Type: uint32_t, Unit: 1 B, Range: [0 to 232 - 1]
Returns:
  • error_code – Type: int

Sets the firmware pointer for oled_128x64_v2_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 oled_128x64_v2_write_firmware(OLED128x64V2 *oled_128x64_v2, uint8_t data[64], uint8_t *ret_status)
Parameters:
  • oled_128x64_v2 – Type: OLED128x64V2 *
  • data – Type: uint8_t[64], Range: [0 to 255]
Output Parameters:
  • ret_status – Type: uint8_t, Range: [0 to 255]
Returns:
  • error_code – Type: int

Writes 64 Bytes of firmware at the position as written by oled_128x64_v2_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 oled_128x64_v2_set_status_led_config(OLED128x64V2 *oled_128x64_v2, uint8_t config)
Parameters:
  • oled_128x64_v2 – Type: OLED128x64V2 *
  • config – Type: uint8_t, Range: See constants, Default: 3
Returns:
  • error_code – Type: int

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

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

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

The following constants are available for this function:

For config:

  • OLED_128X64_V2_STATUS_LED_CONFIG_OFF = 0
  • OLED_128X64_V2_STATUS_LED_CONFIG_ON = 1
  • OLED_128X64_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • OLED_128X64_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3
int oled_128x64_v2_get_status_led_config(OLED128x64V2 *oled_128x64_v2, uint8_t *ret_config)
Parameters:
  • oled_128x64_v2 – Type: OLED128x64V2 *
Output Parameters:
  • ret_config – Type: uint8_t, Range: See constants, Default: 3
Returns:
  • error_code – Type: int

Returns the configuration as set by oled_128x64_v2_set_status_led_config()

The following constants are available for this function:

For ret_config:

  • OLED_128X64_V2_STATUS_LED_CONFIG_OFF = 0
  • OLED_128X64_V2_STATUS_LED_CONFIG_ON = 1
  • OLED_128X64_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • OLED_128X64_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3
int oled_128x64_v2_get_chip_temperature(OLED128x64V2 *oled_128x64_v2, int16_t *ret_temperature)
Parameters:
  • oled_128x64_v2 – Type: OLED128x64V2 *
Output Parameters:
  • ret_temperature – Type: int16_t, Unit: 1 °C, Range: [-215 to 215 - 1]
Returns:
  • error_code – Type: int

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

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

int oled_128x64_v2_reset(OLED128x64V2 *oled_128x64_v2)
Parameters:
  • oled_128x64_v2 – Type: OLED128x64V2 *
Returns:
  • error_code – Type: int

Calling this function will reset the Bricklet. All configurations will be lost.

After a reset you have to create new device objects, calling functions on the existing ones will result in undefined behavior!

int oled_128x64_v2_write_uid(OLED128x64V2 *oled_128x64_v2, uint32_t uid)
Parameters:
  • oled_128x64_v2 – Type: OLED128x64V2 *
  • uid – Type: uint32_t, Range: [0 to 232 - 1]
Returns:
  • error_code – Type: int

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

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

int oled_128x64_v2_read_uid(OLED128x64V2 *oled_128x64_v2, uint32_t *ret_uid)
Parameters:
  • oled_128x64_v2 – Type: OLED128x64V2 *
Output Parameters:
  • ret_uid – Type: uint32_t, Range: [0 to 232 - 1]
Returns:
  • error_code – Type: int

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

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

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

The position can be 'a', 'b', 'c', 'd', 'e', 'f', 'g' or 'h' (Bricklet Port). The Raspberry Pi HAT (Zero) Brick is always at position 'i' and the Bricklet connected to an Isolator Bricklet is always as position 'z'.

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

Virtual Functions

Virtual functions don't communicate with the device itself, but operate only on the API bindings device object. They can be called without the corresponding IP Connection object being connected.

int oled_128x64_v2_get_api_version(OLED128x64V2 *oled_128x64_v2, uint8_t ret_api_version[3])
Parameters:
  • oled_128x64_v2 – Type: OLED128x64V2 *
Output Parameters:
  • ret_api_version – Type: uint8_t[3]
    • 0: major – Type: uint8_t, Range: [0 to 255]
    • 1: minor – Type: uint8_t, Range: [0 to 255]
    • 2: revision – Type: uint8_t, Range: [0 to 255]
Returns:
  • error_code – Type: int

Returns the version of the API definition 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 oled_128x64_v2_get_response_expected(OLED128x64V2 *oled_128x64_v2, uint8_t function_id, bool *ret_response_expected)
Parameters:
  • oled_128x64_v2 – Type: OLED128x64V2 *
  • function_id – Type: uint8_t, Range: See constants
Output Parameters:
  • ret_response_expected – Type: bool
Returns:
  • error_code – Type: int

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

For getter functions this is enabled by default and cannot be disabled, because those functions will always send a response. For callback configuration functions it is enabled by default too, but can be disabled by oled_128x64_v2_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.

The following constants are available for this function:

For function_id:

  • OLED_128X64_V2_FUNCTION_WRITE_PIXELS = 1
  • OLED_128X64_V2_FUNCTION_CLEAR_DISPLAY = 3
  • OLED_128X64_V2_FUNCTION_SET_DISPLAY_CONFIGURATION = 4
  • OLED_128X64_V2_FUNCTION_WRITE_LINE = 6
  • OLED_128X64_V2_FUNCTION_DRAW_BUFFERED_FRAME = 7
  • OLED_128X64_V2_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • OLED_128X64_V2_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • OLED_128X64_V2_FUNCTION_RESET = 243
  • OLED_128X64_V2_FUNCTION_WRITE_UID = 248
int oled_128x64_v2_set_response_expected(OLED128x64V2 *oled_128x64_v2, uint8_t function_id, bool response_expected)
Parameters:
  • oled_128x64_v2 – Type: OLED128x64V2 *
  • function_id – Type: uint8_t, Range: See constants
  • response_expected – Type: bool
Returns:
  • error_code – Type: int

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

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

The following constants are available for this function:

For function_id:

  • OLED_128X64_V2_FUNCTION_WRITE_PIXELS = 1
  • OLED_128X64_V2_FUNCTION_CLEAR_DISPLAY = 3
  • OLED_128X64_V2_FUNCTION_SET_DISPLAY_CONFIGURATION = 4
  • OLED_128X64_V2_FUNCTION_WRITE_LINE = 6
  • OLED_128X64_V2_FUNCTION_DRAW_BUFFERED_FRAME = 7
  • OLED_128X64_V2_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • OLED_128X64_V2_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • OLED_128X64_V2_FUNCTION_RESET = 243
  • OLED_128X64_V2_FUNCTION_WRITE_UID = 248
int oled_128x64_v2_set_response_expected_all(OLED128x64V2 *oled_128x64_v2, bool response_expected)
Parameters:
  • oled_128x64_v2 – Type: OLED128x64V2 *
  • response_expected – Type: bool
Returns:
  • error_code – Type: int

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

Constants

OLED_128X64_V2_DEVICE_IDENTIFIER

This constant is used to identify a OLED 128x64 Bricklet 2.0.

The oled_128x64_v2_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.

OLED_128X64_V2_DEVICE_DISPLAY_NAME

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