Struct Oled128x64Bricklet

pub struct Oled128x64Bricklet { /* private fields */ }

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

Implementations

impl Oled128x64Bricklet

pub const DEVICE_IDENTIFIER: u16 = 263u16

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

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

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: Oled128x64BrickletFunction, ) -> 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: Oled128x64BrickletFunction, 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(&mut self, data: &[u8; 64]) -> Result<(), TinkerforgeError>

Appends 64 byte of data to the window as set by new_window.

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

Example: if you call new_window with column from 0 to 127 and row from 0 to 7 (the whole display) each call of 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 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 write 16 times.

pub async fn new_window( &mut self, column_from: u8, column_to: u8, row_from: u8, row_to: u8, ) -> Result<(), TinkerforgeError>

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

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

Clears the current content of the window as set by [new_window].

pub async fn set_display_configuration( &mut self, contrast: u8, invert: 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 (black/white) of the display.

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

The font conforms to code page 437.

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 Oled128x64Bricklet

fn clone(&self) -> Oled128x64Bricklet

Returns a duplicate of the value.

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

Performs copy-assignment from source.