Struct Oled128x64V2Bricklet 

pub struct Oled128x64V2Bricklet { /* private fields */ }

3.3cm (1.3“) OLED display with 128x64 pixels

Implementations

impl Oled128x64V2Bricklet

pub const DEVICE_IDENTIFIER: u16 = 2_112u16

pub const DEVICE_DISPLAY_NAME: &'static str = "OLED 128x64 Bricklet 2.0"

pub fn new(uid: Uid, connection: AsyncIpConnection) -> Oled128x64V2Bricklet

Creates an object with the unique device ID uid. This object can then be used after the IP Connection ip_connection is connected.

pub fn get_response_expected( &mut self, fun: Oled128x64V2BrickletFunction, ) -> Result<bool, GetResponseExpectedError>

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

See set_response_expected for the list of function ID constants available for this function.

pub fn set_response_expected( &mut self, fun: Oled128x64V2BrickletFunction, response_expected: bool, ) -> Result<(), SetResponseExpectedError>

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

pub fn set_response_expected_all(&mut self, response_expected: bool)

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

pub fn get_api_version(&self) -> [u8; 3]

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

pub async fn write_pixels_low_level( &mut self, x_start: u8, y_start: u8, x_end: u8, y_end: u8, pixels_length: u16, pixels_chunk_offset: u16, pixels_chunk_data: &[bool; 448], ) -> Result<WritePixelsLowLevel, TinkerforgeError>

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 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 set_display_configuration function.

pub async fn read_pixels_low_level( &mut self, x_start: u8, y_start: u8, x_end: u8, y_end: u8, ) -> Result<ReadPixelsLowLevel, TinkerforgeError>

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 [draw_buffered_frame]).

Automatic draw can be configured with the [set_display_configuration] function.

pub async fn clear_display(&mut self) -> Result<(), TinkerforgeError>

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 [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 [set_display_configuration] function.

pub async fn set_display_configuration( &mut self, contrast: u8, invert: bool, automatic_draw: bool, ) -> Result<(), TinkerforgeError>

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 [write_pixels] or [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 [draw_buffered_frame].

pub async fn get_display_configuration( &mut self, ) -> Result<DisplayConfiguration, TinkerforgeError>

Returns the configuration as set by [set_display_configuration].

pub async fn write_line( &mut self, line: u8, position: u8, text: String, ) -> Result<(), TinkerforgeError>

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 [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 [set_display_configuration] function.

The font conforms to code page 437.

pub async fn draw_buffered_frame( &mut self, force_complete_redraw: bool, ) -> Result<(), TinkerforgeError>

Draws the currently buffered frame. Normally each call of [write_pixels] and [write_line] draws directly onto the display. If you turn automatic draw off ([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.

pub async fn get_spitfp_error_count( &mut self, ) -> Result<SpitfpErrorCount, TinkerforgeError>

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.

pub async fn set_bootloader_mode( &mut self, mode: u8, ) -> Result<u8, TinkerforgeError>

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.

Associated constants:

• OLED_128X64_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER
• OLED_128X64_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE
• OLED_128X64_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT
• OLED_128X64_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT
• OLED_128X64_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT
• OLED_128X64_V2_BRICKLET_BOOTLOADER_STATUS_OK
• OLED_128X64_V2_BRICKLET_BOOTLOADER_STATUS_INVALID_MODE
• OLED_128X64_V2_BRICKLET_BOOTLOADER_STATUS_NO_CHANGE
• OLED_128X64_V2_BRICKLET_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT
• OLED_128X64_V2_BRICKLET_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT
• OLED_128X64_V2_BRICKLET_BOOTLOADER_STATUS_CRC_MISMATCH

pub async fn get_bootloader_mode(&mut self) -> Result<u8, TinkerforgeError>

Returns the current bootloader mode, see [set_bootloader_mode].

Associated constants:

• OLED_128X64_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER
• OLED_128X64_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE
• OLED_128X64_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT
• OLED_128X64_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT
• OLED_128X64_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT

pub async fn set_write_firmware_pointer( &mut self, pointer: u32, ) -> Result<(), TinkerforgeError>

Sets the firmware pointer for [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.

pub async fn write_firmware( &mut self, data: &[u8; 64], ) -> Result<u8, TinkerforgeError>

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

pub async fn set_status_led_config( &mut self, config: u8, ) -> Result<(), TinkerforgeError>

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.

Associated constants:

• OLED_128X64_V2_BRICKLET_STATUS_LED_CONFIG_OFF
• OLED_128X64_V2_BRICKLET_STATUS_LED_CONFIG_ON
• OLED_128X64_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT
• OLED_128X64_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS

pub async fn get_status_led_config(&mut self) -> Result<u8, TinkerforgeError>

Returns the configuration as set by [set_status_led_config]

Associated constants:

• OLED_128X64_V2_BRICKLET_STATUS_LED_CONFIG_OFF
• OLED_128X64_V2_BRICKLET_STATUS_LED_CONFIG_ON
• OLED_128X64_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT
• OLED_128X64_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS

pub async fn get_chip_temperature(&mut self) -> Result<i16, TinkerforgeError>

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.

pub async fn reset(&mut self) -> Result<(), TinkerforgeError>

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!

pub async fn write_uid(&mut self, uid: u32) -> Result<(), TinkerforgeError>

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.

pub async fn read_uid(&mut self) -> Result<u32, TinkerforgeError>

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

pub async fn get_identity(&mut self) -> Result<Identity, TinkerforgeError>

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 Isolator Bricklet is always at position ‘z’.

The device identifier numbers can be found here. |device_identifier_constant|

Trait Implementations

impl Clone for Oled128x64V2Bricklet

fn clone(&self) -> Oled128x64V2Bricklet

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.