NAME

Tinkerforge::BrickletOLED128x64 - 1.3" OLED with 128x64 pixels

CONSTANTS

DEVICE_IDENTIFIER

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

The get_identity() subroutine and the CALLBACK_ENUMERATE callback of the IP Connection have a device_identifier parameter to specify the Brick's or Bricklet's type.

DEVICE_DISPLAY_NAME

This constant represents the display name of a OLED 128x64 Bricklet.

FUNCTION_WRITE

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_NEW_WINDOW

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_CLEAR_DISPLAY

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_SET_DISPLAY_CONFIGURATION

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_GET_DISPLAY_CONFIGURATION

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_WRITE_LINE

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_GET_IDENTITY

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTIONS

new()

Creates an object with the unique device ID *uid* and adds it to the IP Connection *ipcon*.

write()

Appends 64 byte of data to the window as set by :func:`NewWindow`.

Each row has a height of 8 pixels which corresponds to one byte of data.

Example: if you call :func:`NewWindow` with column from 0 to 127 and row from 0 to 7 (the whole display) each call of :func:`Write` (red arrow) will write half of a row.

.. image:: /Images/Bricklets/bricklet_oled_128x64_display.png :scale: 100 % :alt: Display pixel order :align: center :target: ../../_images/Bricklets/bricklet_oled_128x64_display.png

The LSB (D0) of each data byte is at the top and the MSB (D7) is at the bottom of the row.

The next call of :func:`Write` will write the second half of the row and the next two the second row and so on. To fill the whole display you need to call :func:`Write` 16 times.

new_window()

Sets the window in which you can write with :func:`Write`. One row has a height of 8 pixels.

The columns have a range of 0 to 127 and the rows have a range of 0 to 7.

clear_display()

Clears the current content of the display.

set_display_configuration()

Sets the configuration of the display.

You can set a contrast value from 0 to 255 and you can invert the color (black/white) of the display.

The default values are contrast 143 and inverting off.

get_display_configuration()

Returns the configuration as set by :func:`SetDisplayConfiguration`.

write_line()

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

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

You can draw to the display with :func:`Write` and then add text to it afterwards.

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

get_identity()

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

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

The device identifier numbers can be found :ref:`here <device_identifier>`. |device_identifier_constant|