Struct tinkerforge::lcd_20x4_bricklet::Lcd20x4Bricklet

pub struct Lcd20x4Bricklet { /* private fields */ }

20x4 character alphanumeric display with blue backlight

Implementations

impl Lcd20x4Bricklet

pub const DEVICE_IDENTIFIER: u16 = 212u16

pub const DEVICE_DISPLAY_NAME: &'static str = "LCD 20x4 Bricklet"

pub fn new(uid: &str, ip_connection: &IpConnection) -> Lcd20x4Bricklet

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: Lcd20x4BrickletFunction
) -> 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 send 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: Lcd20x4BrickletFunction,
    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 send 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_button_pressed_callback_receiver(
    &self
) -> ConvertingCallbackReceiver<u8>

This receiver is triggered when a button is pressed. The parameter is the number of the button (0 to 2 or 0 to 3 since hardware version 1.2).

pub fn get_button_released_callback_receiver(
    &self
) -> ConvertingCallbackReceiver<u8>

This receiver is triggered when a button is released. The parameter is the number of the button (0 to 2 or 0 to 3 since hardware version 1.2).

pub fn write_line(
    &self,
    line: u8,
    position: u8,
    text: String
) -> ConvertingReceiver<()>

Writes text to a specific line (0 to 3) with a specific position (0 to 19). The text can have a maximum of 20 characters.

For example: (0, 7, 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.

pub fn clear_display(&self) -> ConvertingReceiver<()>

Deletes all characters from the display.

pub fn backlight_on(&self) -> ConvertingReceiver<()>

Turns the backlight on.

pub fn backlight_off(&self) -> ConvertingReceiver<()>

Turns the backlight off.

pub fn is_backlight_on(&self) -> ConvertingReceiver<bool>

Returns true if the backlight is on and false otherwise.

pub fn set_config(&self, cursor: bool, blinking: bool) -> ConvertingReceiver<()>

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.

The default is (false, false).

pub fn get_config(&self) -> ConvertingReceiver<Config>

Returns the configuration as set by Set Config.

pub fn is_button_pressed(&self, button: u8) -> ConvertingReceiver<bool>

Returns true if the button (0 to 2 or 0 to 3 since hardware version 1.2) 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.

pub fn set_custom_character(
    &self,
    index: u8,
    character: [u8; 8]
) -> ConvertingReceiver<()>

The LCD 20x4 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) to 15 (\x0F).

You can play around with the custom characters in Brick Viewer version since 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)

pub fn get_custom_character(&self, index: u8) -> ConvertingReceiver<[u8; 8]>

Returns the custom character for a given index, as set with Set Custom Character.

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

pub fn set_default_text(&self, line: u8, text: String) -> ConvertingReceiver<()>

Sets the default text for lines 0-3. The max number of characters per line is 20.

The default text is shown on the LCD, if the default text counter expires, see Set Default Text Counter.

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

pub fn get_default_text(&self, line: u8) -> ConvertingReceiver<String>

Returns the default text for a given line (0-3) as set by Set Default Text.

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

pub fn set_default_text_counter(&self, counter: i32) -> ConvertingReceiver<()>

Sets the default text counter in ms. This counter is decremented each ms by the LCD firmware. If the counter reaches 0, the default text (see Set Default Text) is shown on the LCD.

This functionality can be used to show a default text if the controlling program crashes or the connection is interrupted.

A possible approach is to call Set Default Text Counter every minute with the parameter 1000602 (2 minutes). In this case the default text will be shown no later than 2 minutes after the controlling program crashes.

A negative counter turns the default text functionality off.

The default is -1.

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

pub fn get_default_text_counter(&self) -> ConvertingReceiver<i32>

Returns the current value of the default text counter.

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

pub fn get_identity(&self) -> ConvertingReceiver<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 here. |device_identifier_constant|

Trait Implementations

impl Clone for Lcd20x4Bricklet

fn clone(&self) -> Lcd20x4Bricklet

Returns a copy of the value.

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

Performs copy-assignment from source.