Struct Lcd16x2Bricklet

Source

pub struct Lcd16x2Bricklet { /* private fields */ }

Expand description

16x2 character alphanumeric display with blue backlight

Implementations§

Source §

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

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

Source

pub fn get_response_expected( &mut self, fun: Lcd16x2BrickletFunction, ) -> 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.

Source

pub fn set_response_expected( &mut self, fun: Lcd16x2BrickletFunction, 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.

Source

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.

Source

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.

Source

pub async fn get_button_pressed_callback_receiver( &mut self, ) -> impl Stream<Item = u8>

This receiver is triggered when a button is pressed. The parameter is the number of the button.

Source

pub async fn get_button_released_callback_receiver( &mut self, ) -> impl Stream<Item = u8>

This receiver is triggered when a button is released. The parameter is the number of the button.

Source

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

For example: (0, 5, Hello) will write Hello in the middle of the first line of the display.

The display uses a special charset that includes all ASCII characters except backslash and tilde. The LCD charset also includes several other non-ASCII characters, see the charset specification__ for details. The Unicode example above shows how to specify non-ASCII characters and how to translate from Unicode to the LCD charset.

Source

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

Deletes all characters from the display.

Source

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

Turns the backlight on.

Source

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

Turns the backlight off.

Source

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

Returns true if the backlight is on and false otherwise.

Source

pub async fn set_config( &mut self, cursor: bool, blinking: bool, ) -> Result<(), TinkerforgeError>

Configures if the cursor (shown as _) should be visible and if it should be blinking (shown as a blinking block). The cursor position is one character behind the the last text written with [write_line].

Source

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

Returns the configuration as set by [set_config].

Source

pub async fn is_button_pressed( &mut self, button: u8, ) -> Result<bool, TinkerforgeError>

Returns true if the button is pressed.

If you want to react on button presses and releases it is recommended to use the [get_button_pressed_callback_receiver] and [get_button_released_callback_receiver] receivers.

Source

pub async fn set_custom_character( &mut self, index: u8, character: &[u8; 8], ) -> Result<(), TinkerforgeError>

The LCD 16x2 Bricklet can store up to 8 custom characters. The characters consist of 5x8 pixels and can be addressed with the index 0-7. To describe the pixels, the first 5 bits of 8 bytes are used. For example, to make a custom character H, you should transfer the following:

character[0] = 0b00010001 (decimal value 17)
character[1] = 0b00010001 (decimal value 17)
character[2] = 0b00010001 (decimal value 17)
character[3] = 0b00011111 (decimal value 31)
character[4] = 0b00010001 (decimal value 17)
character[5] = 0b00010001 (decimal value 17)
character[6] = 0b00010001 (decimal value 17)
character[7] = 0b00000000 (decimal value 0)

The characters can later be written with [write_line] by using the characters with the byte representation 8 (\x08 or \u0008) to 15 (\x0F or \u000F).

You can play around with the custom characters in Brick Viewer since version 2.0.1.

Custom characters are stored by the LCD in RAM, so they have to be set after each startup.

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

Source