NAME

Tinkerforge::BrickletLCD128x64 - 7.1cm (2.8") display with 128x64 pixel and touch screen

CONSTANTS

DEVICE_IDENTIFIER

This constant is used to identify a LCD 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 LCD 128x64 Bricklet.

CALLBACK_TOUCH_POSITION

This constant is used with the register_callback() subroutine to specify the CALLBACK_TOUCH_POSITION callback.

CALLBACK_TOUCH_GESTURE

This constant is used with the register_callback() subroutine to specify the CALLBACK_TOUCH_GESTURE callback.

CALLBACK_GUI_BUTTON_PRESSED

This constant is used with the register_callback() subroutine to specify the CALLBACK_GUI_BUTTON_PRESSED callback.

CALLBACK_GUI_SLIDER_VALUE

This constant is used with the register_callback() subroutine to specify the CALLBACK_GUI_SLIDER_VALUE callback.

CALLBACK_GUI_TAB_SELECTED

This constant is used with the register_callback() subroutine to specify the CALLBACK_GUI_TAB_SELECTED callback.

FUNCTION_WRITE_PIXELS_LOW_LEVEL

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

FUNCTION_READ_PIXELS_LOW_LEVEL

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_DRAW_BUFFERED_FRAME

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

FUNCTION_GET_TOUCH_POSITION

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

FUNCTION_SET_TOUCH_POSITION_CALLBACK_CONFIGURATION

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

FUNCTION_GET_TOUCH_POSITION_CALLBACK_CONFIGURATION

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

FUNCTION_GET_TOUCH_GESTURE

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

FUNCTION_SET_TOUCH_GESTURE_CALLBACK_CONFIGURATION

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

FUNCTION_GET_TOUCH_GESTURE_CALLBACK_CONFIGURATION

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

FUNCTION_DRAW_LINE

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

FUNCTION_DRAW_BOX

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

FUNCTION_DRAW_TEXT

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

FUNCTION_SET_GUI_BUTTON

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

FUNCTION_GET_GUI_BUTTON

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

FUNCTION_REMOVE_GUI_BUTTON

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

FUNCTION_SET_GUI_BUTTON_PRESSED_CALLBACK_CONFIGURATION

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

FUNCTION_GET_GUI_BUTTON_PRESSED_CALLBACK_CONFIGURATION

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

FUNCTION_GET_GUI_BUTTON_PRESSED

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

FUNCTION_SET_GUI_SLIDER

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

FUNCTION_GET_GUI_SLIDER

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

FUNCTION_REMOVE_GUI_SLIDER

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

FUNCTION_SET_GUI_SLIDER_VALUE_CALLBACK_CONFIGURATION

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

FUNCTION_GET_GUI_SLIDER_VALUE_CALLBACK_CONFIGURATION

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

FUNCTION_GET_GUI_SLIDER_VALUE

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

FUNCTION_SET_GUI_TAB_CONFIGURATION

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

FUNCTION_GET_GUI_TAB_CONFIGURATION

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

FUNCTION_SET_GUI_TAB_TEXT

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

FUNCTION_GET_GUI_TAB_TEXT

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

FUNCTION_SET_GUI_TAB_ICON

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

FUNCTION_GET_GUI_TAB_ICON

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

FUNCTION_REMOVE_GUI_TAB

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

FUNCTION_SET_GUI_TAB_SELECTED

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

FUNCTION_SET_GUI_TAB_SELECTED_CALLBACK_CONFIGURATION

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

FUNCTION_GET_GUI_TAB_SELECTED_CALLBACK_CONFIGURATION

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

FUNCTION_GET_GUI_TAB_SELECTED

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

FUNCTION_SET_GUI_GRAPH_CONFIGURATION

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

FUNCTION_GET_GUI_GRAPH_CONFIGURATION

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

FUNCTION_SET_GUI_GRAPH_DATA_LOW_LEVEL

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

FUNCTION_GET_GUI_GRAPH_DATA_LOW_LEVEL

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

FUNCTION_REMOVE_GUI_GRAPH

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

FUNCTION_REMOVE_ALL_GUI

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

FUNCTION_SET_TOUCH_LED_CONFIG

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

FUNCTION_GET_TOUCH_LED_CONFIG

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

FUNCTION_GET_SPITFP_ERROR_COUNT

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

FUNCTION_SET_BOOTLOADER_MODE

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

FUNCTION_GET_BOOTLOADER_MODE

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

FUNCTION_SET_WRITE_FIRMWARE_POINTER

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

FUNCTION_WRITE_FIRMWARE

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

FUNCTION_SET_STATUS_LED_CONFIG

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

FUNCTION_GET_STATUS_LED_CONFIG

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

FUNCTION_GET_CHIP_TEMPERATURE

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

FUNCTION_RESET

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

FUNCTION_WRITE_UID

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

FUNCTION_READ_UID

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_pixels_low_level()

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 :func:`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 :func:`Set Display Configuration` function.

read_pixels_low_level()

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 :func:`Draw Buffered Frame`).

Automatic draw can be configured with the :func:`Set Display Configuration` function.

clear_display()

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 :func:`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 :func:`Set Display Configuration` function.

set_display_configuration()

Sets the configuration of the display.

If automatic draw is set to *true*, the display is automatically updated with every call of :func:`Write Pixels` and :func:`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 :func:`Draw Buffered Frame`.

get_display_configuration()

Returns the configuration as set by :func:`Set Display Configuration`.

write_line()

Writes text to a specific line with a specific position.

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

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

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

If automatic draw is disabled the text is written to an internal buffer and the buffer is transferred to the display only after :func:`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 :func:`Set Display Configuration` function.

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

draw_buffered_frame()

Draws the currently buffered frame. Normally each call of :func:`Write Pixels` and :func:`Write Line` draws directly onto the display. If you turn automatic draw off (:func:`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.

get_touch_position()

Returns the last valid touch position:

* Pressure: Amount of pressure applied by the user * X: Touch position on x-axis * Y: Touch position on y-axis * Age: Age of touch press (how long ago it was)

set_touch_position_callback_configuration()

The period is the period with which the :cb:`Touch Position` callback is triggered periodically. A value of 0 turns the callback off.

If the `value has to change`-parameter is set to true, the callback is only triggered after the value has changed. If the value didn't change within the period, the callback is triggered immediately on change.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

get_touch_position_callback_configuration()

Returns the callback configuration as set by :func:`Set Touch Position Callback Configuration`.

get_touch_gesture()

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

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

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

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

set_touch_gesture_callback_configuration()

The period is the period with which the :cb:`Touch Gesture` callback is triggered periodically. A value of 0 turns the callback off.

If the `value has to change`-parameter is set to true, the callback is only triggered after the value has changed. If the value didn't change within the period, the callback is triggered immediately on change.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

get_touch_gesture_callback_configuration()

Returns the callback configuration as set by :func:`Set Touch Gesture Callback Configuration`.

draw_line()

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

.. versionadded:: 2.0.2$nbsp;(Plugin)

draw_box()

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

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

.. versionadded:: 2.0.2$nbsp;(Plugin)

draw_text()

Draws a text at the pixel position (x, y).

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

The font conforms to code page 437.

.. versionadded:: 2.0.2$nbsp;(Plugin)

set_gui_button()

Draws a clickable button at position (x, y) with the given text.

You can use up to 12 buttons.

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

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

You can enable a callback for a button press with :func:`Set GUI Button Pressed Callback Configuration`. The callback will be triggered for press and release-events.

The button is drawn in a separate GUI buffer and the button-frame will always stay on top of the graphics drawn with :func:`Write Pixels`. To remove the button use :func:`Remove GUI Button`.

If you want an icon instead of text, you can draw the icon inside of the button with :func:`Write Pixels`.

.. versionadded:: 2.0.2$nbsp;(Plugin)

get_gui_button()

Returns the button properties for a given `Index` as set by :func:`Set GUI Button`.

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

.. versionadded:: 2.0.2$nbsp;(Plugin)

remove_gui_button()

Removes the button with the given index.

You can use index 255 to remove all buttons.

.. versionadded:: 2.0.2$nbsp;(Plugin)

set_gui_button_pressed_callback_configuration()

The period is the period with which the :cb:`GUI Button Pressed` callback is triggered periodically. A value of 0 turns the callback off.

If the `value has to change`-parameter is set to true, the callback is only triggered after the value has changed. If the value didn't change within the period, the callback is triggered immediately on change.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

.. versionadded:: 2.0.2$nbsp;(Plugin)

get_gui_button_pressed_callback_configuration()

Returns the callback configuration as set by :func:`Set GUI Button Pressed Callback Configuration`.

.. versionadded:: 2.0.2$nbsp;(Plugin)

get_gui_button_pressed()

Returns the state of the button for the given index.

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

.. versionadded:: 2.0.2$nbsp;(Plugin)

set_gui_slider()

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

You can use up to 6 sliders.

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

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

The minimum length of a slider is 8.

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

You can enable a callback for the slider value with :func:`Set GUI Slider Value Callback Configuration`.

The slider is drawn in a separate GUI buffer and it will always stay on top of the graphics drawn with :func:`Write Pixels`. To remove the button use :func:`Remove GUI Slider`.

.. versionadded:: 2.0.2$nbsp;(Plugin)

get_gui_slider()

Returns the slider properties for a given `Index` as set by :func:`Set GUI Slider`.

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

.. versionadded:: 2.0.2$nbsp;(Plugin)

remove_gui_slider()

Removes the slider with the given index.

You can use index 255 to remove all slider.

.. versionadded:: 2.0.2$nbsp;(Plugin)

set_gui_slider_value_callback_configuration()

The period is the period with which the :cb:`GUI Slider Value` callback is triggered periodically. A value of 0 turns the callback off.

If the `value has to change`-parameter is set to true, the callback is only triggered after the value has changed. If the value didn't change within the period, the callback is triggered immediately on change.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

.. versionadded:: 2.0.2$nbsp;(Plugin)

get_gui_slider_value_callback_configuration()

Returns the callback configuration as set by :func:`Set GUI Slider Value Callback Configuration`.

.. versionadded:: 2.0.2$nbsp;(Plugin)

get_gui_slider_value()

Returns the current slider value for the given index.

.. versionadded:: 2.0.2$nbsp;(Plugin)

set_gui_tab_configuration()

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

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

.. versionadded:: 2.0.2$nbsp;(Plugin)

get_gui_tab_configuration()

Returns the tab configuration as set by :func:`Set GUI Tab Configuration`.

.. versionadded:: 2.0.2$nbsp;(Plugin)

set_gui_tab_text()

Adds a text-tab with the given index.

You can use up to 10 tabs.

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

.. versionadded:: 2.0.2$nbsp;(Plugin)

get_gui_tab_text()

Returns the text for a given index as set by :func:`Set GUI Tab Text`.

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

.. versionadded:: 2.0.2$nbsp;(Plugin)

set_gui_tab_icon()

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

You can use up to 10 tabs.

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

.. versionadded:: 2.0.2$nbsp;(Plugin)

get_gui_tab_icon()

Returns the icon for a given index as set by :func:`Set GUI Tab Icon`.

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

.. versionadded:: 2.0.2$nbsp;(Plugin)

remove_gui_tab()

Removes the tab with the given index.

You can use index 255 to remove all tabs.

.. versionadded:: 2.0.2$nbsp;(Plugin)

set_gui_tab_selected()

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

.. versionadded:: 2.0.2$nbsp;(Plugin)

set_gui_tab_selected_callback_configuration()

The period is the period with which the :cb:`GUI Tab Selected` callback is triggered periodically. A value of 0 turns the callback off.

If the `value has to change`-parameter is set to true, the callback is only triggered after the value has changed. If the value didn't change within the period, the callback is triggered immediately on change.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

.. versionadded:: 2.0.2$nbsp;(Plugin)

get_gui_tab_selected_callback_configuration()

Returns the callback configuration as set by :func:`Set GUI Tab Selected Callback Configuration`.

.. versionadded:: 2.0.2$nbsp;(Plugin)

get_gui_tab_selected()

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

.. versionadded:: 2.0.2$nbsp;(Plugin)

set_gui_graph_configuration()

Sets the configuration for up to four graphs.

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

The x and y position are pixel positions.

You can add a text for the x and y axis. The text is drawn at the inside of the graph and it can overwrite some of the graph data. If you need the text outside of the graph you can leave this text here empty and use :func:`Draw Text` to draw the caption outside of the graph.

The data of the graph can be set and updated with :func:`Set GUI Graph Data`.

The graph is drawn in a separate GUI buffer and the graph-frame and data will always stay on top of the graphics drawn with :func:`Write Pixels`. To remove the graph use :func:`Remove GUI Graph`.

.. versionadded:: 2.0.2$nbsp;(Plugin)

get_gui_graph_configuration()

Returns the graph properties for a given `Index` as set by :func:`Set GUI Graph Configuration`.

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

.. versionadded:: 2.0.2$nbsp;(Plugin)

set_gui_graph_data_low_level()

Sets the data for a graph with the given index. You have to configure the graph with :func:`Set GUI Graph Configuration` before you can set the first data.

The graph will show the first n values of the data that you set, where n is the width set with :func:`Set GUI Graph Configuration`. If you set less then n values it will show the rest of the values as zero.

The maximum number of data-points you can set is 118 (which also corresponds to the maximum width of the graph).

You have to scale your values to be between 0 and 255. 0 will be shown at the bottom of the graph and 255 at the top.

.. versionadded:: 2.0.2$nbsp;(Plugin)

get_gui_graph_data_low_level()

Returns the graph data for a given index as set by :func:`Set GUI Graph Data`.

.. versionadded:: 2.0.2$nbsp;(Plugin)

remove_gui_graph()

Removes the graph with the given index.

You can use index 255 to remove all graphs.

.. versionadded:: 2.0.2$nbsp;(Plugin)

remove_all_gui()

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

.. versionadded:: 2.0.2$nbsp;(Plugin)

set_touch_led_config()

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

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

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

.. versionadded:: 2.0.2$nbsp;(Plugin)

get_touch_led_config()

Returns the configuration as set by :func:`Set Touch LED Config`

.. versionadded:: 2.0.2$nbsp;(Plugin)

get_spitfp_error_count()

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.

set_bootloader_mode()

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.

get_bootloader_mode()

Returns the current bootloader mode, see :func:`Set Bootloader Mode`.

set_write_firmware_pointer()

Sets the firmware pointer for :func:`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.

write_firmware()

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

set_status_led_config()

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

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

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

get_status_led_config()

Returns the configuration as set by :func:`Set Status LED Config`

get_chip_temperature()

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.

reset()

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!

write_uid()

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

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

read_uid()

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

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', 'd', 'e', 'f', 'g' or 'h' (Bricklet Port). A Bricklet connected to an :ref:`Isolator Bricklet <isolator_bricklet>` is always at position 'z'.

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

write_pixels()

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 :func:`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 :func:`Set Display Configuration` function.

read_pixels()

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 :func:`Draw Buffered Frame`).

Automatic draw can be configured with the :func:`Set Display Configuration` function.

set_gui_graph_data()

Sets the data for a graph with the given index. You have to configure the graph with :func:`Set GUI Graph Configuration` before you can set the first data.

The graph will show the first n values of the data that you set, where n is the width set with :func:`Set GUI Graph Configuration`. If you set less then n values it will show the rest of the values as zero.

The maximum number of data-points you can set is 118 (which also corresponds to the maximum width of the graph).

You have to scale your values to be between 0 and 255. 0 will be shown at the bottom of the graph and 255 at the top.

.. versionadded:: 2.0.2$nbsp;(Plugin)

get_gui_graph_data()

Returns the graph data for a given index as set by :func:`Set GUI Graph Data`.

.. versionadded:: 2.0.2$nbsp;(Plugin)