Struct tinkerforge::lcd_128x64_bricklet::Lcd128x64Bricklet

pub struct Lcd128x64Bricklet { /* private fields */ }

7.1cm (2.8“) display with 128x64 pixel and touch screen

Implementations

impl Lcd128x64Bricklet

pub const DEVICE_IDENTIFIER: u16 = 298u16

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

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

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: Lcd128x64BrickletFunction
) -> 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: Lcd128x64BrickletFunction,
    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_touch_position_callback_receiver(
    &self
) -> ConvertingCallbackReceiver<TouchPositionEvent>

This receiver is triggered periodically with the period that is set by Set Touch Position Receiver Configuration. The parameters are the same as for Get Touch Position.

pub fn get_touch_gesture_callback_receiver(
    &self
) -> ConvertingCallbackReceiver<TouchGestureEvent>

This receiver is triggered periodically with the period that is set by Set Touch Gesture Receiver Configuration. The parameters are the same as for Get Touch Gesture.

pub fn write_pixels_low_level(
    &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]
) -> ConvertingReceiver<WritePixelsLowLevel>

Writes pixels to the specified window.

The x-axis goes from 0 to 127 and the y-axis from 0 to 63. 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 fn write_pixels(
    &self,
    x_start: u8,
    y_start: u8,
    x_end: u8,
    y_end: u8,
    pixels: &[bool]
) -> Result<(), BrickletRecvTimeoutError>

Writes pixels to the specified window.

The x-axis goes from 0 to 127 and the y-axis from 0 to 63. 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 fn read_pixels_low_level(
    &self,
    x_start: u8,
    y_start: u8,
    x_end: u8,
    y_end: u8
) -> ConvertingReceiver<ReadPixelsLowLevel>

Reads pixels from the specified window.

The x-axis goes from 0 to 127 and the y-axis from 0 to 63. 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 fn read_pixels(
    &self,
    x_start: u8,
    y_start: u8,
    x_end: u8,
    y_end: u8
) -> Result<Vec<bool>, BrickletRecvTimeoutError>

Reads pixels from the specified window.

The x-axis goes from 0 to 127 and the y-axis from 0 to 63. 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 fn clear_display(&self) -> ConvertingReceiver<()>

Clears the complete content of the display.

pub fn set_display_configuration(
    &self,
    contrast: u8,
    backlight: u8,
    invert: bool,
    automatic_draw: bool
) -> ConvertingReceiver<()>

Sets the configuration of the display.

You can set a contrast value from 0 to 63, a backlight intensity value from 0 to 100 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 and 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.

The default values are contrast 14, backlight intensity 100, inverting off and automatic draw on.

pub fn get_display_configuration(
    &self
) -> ConvertingReceiver<DisplayConfiguration>

Returns the configuration as set by Set Display Configuration.

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

Writes text to a specific line (0 to 7) with a specific position (0 to 21). 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.

pub fn draw_buffered_frame(
    &self,
    force_complete_redraw: bool
) -> ConvertingReceiver<()>

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 fn get_touch_position(&self) -> ConvertingReceiver<TouchPosition>

Returns the last valid touch position:

• Pressure: Amount of pressure applied by the user (0-300)
• X: Touch position on x-axis (0-127)
• Y: Touch position on y-axis (0-63)
• Age: Age of touch press in ms (how long ago it was)

pub fn set_touch_position_callback_configuration(
    &self,
    period: u32,
    value_has_to_change: bool
) -> ConvertingReceiver<()>

The period in ms is the period with which the get_touch_position_callback_receiver receiver is triggered periodically. A value of 0 turns the receiver off.

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

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

The default value is (0, false).

pub fn get_touch_position_callback_configuration(
    &self
) -> ConvertingReceiver<TouchPositionCallbackConfiguration>

Returns the receiver configuration as set by Set Touch Position Receiver Configuration.

pub fn get_touch_gesture(&self) -> ConvertingReceiver<TouchGesture>

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 in ms (how long ago it was).

Associated constants:

• LCD_128X64BRICKLET_GESTURE_LEFT_TO_RIGHT
• LCD_128X64BRICKLET_GESTURE_RIGHT_TO_LEFT
• LCD_128X64BRICKLET_GESTURE_TOP_TO_BOTTOM
• LCD_128X64BRICKLET_GESTURE_BOTTOM_TO_TOP

pub fn set_touch_gesture_callback_configuration(
    &self,
    period: u32,
    value_has_to_change: bool
) -> ConvertingReceiver<()>

The period in ms is the period with which the get_touch_gesture_callback_receiver receiver is triggered periodically. A value of 0 turns the receiver off.

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

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

The default value is (0, false).

pub fn get_touch_gesture_callback_configuration(
    &self
) -> ConvertingReceiver<TouchGestureCallbackConfiguration>

Returns the receiver configuration as set by Set Touch Gesture Receiver Configuration.

pub fn get_spitfp_error_count(&self) -> ConvertingReceiver<SpitfpErrorCount>

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 fn set_bootloader_mode(&self, mode: u8) -> ConvertingReceiver<u8>

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:

• LCD_128X64BRICKLET_BOOTLOADER_MODE_BOOTLOADER
• LCD_128X64BRICKLET_BOOTLOADER_MODE_FIRMWARE
• LCD_128X64BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT
• LCD_128X64BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT
• LCD_128X64BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT
• LCD_128X64BRICKLET_BOOTLOADER_STATUS_OK
• LCD_128X64BRICKLET_BOOTLOADER_STATUS_INVALID_MODE
• LCD_128X64BRICKLET_BOOTLOADER_STATUS_NO_CHANGE
• LCD_128X64BRICKLET_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT
• LCD_128X64BRICKLET_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT
• LCD_128X64BRICKLET_BOOTLOADER_STATUS_CRC_MISMATCH

pub fn get_bootloader_mode(&self) -> ConvertingReceiver<u8>

Returns the current bootloader mode, see Set Bootloader Mode.

Associated constants:

• LCD_128X64BRICKLET_BOOTLOADER_MODE_BOOTLOADER
• LCD_128X64BRICKLET_BOOTLOADER_MODE_FIRMWARE
• LCD_128X64BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT
• LCD_128X64BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT
• LCD_128X64BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT

pub fn set_write_firmware_pointer(&self, pointer: u32) -> ConvertingReceiver<()>

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 fn write_firmware(&self, data: [u8; 64]) -> ConvertingReceiver<u8>

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 fn set_status_led_config(&self, config: u8) -> ConvertingReceiver<()>

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:

• LCD_128X64BRICKLET_STATUS_LED_CONFIG_OFF
• LCD_128X64BRICKLET_STATUS_LED_CONFIG_ON
• LCD_128X64BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT
• LCD_128X64BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS

pub fn get_status_led_config(&self) -> ConvertingReceiver<u8>

Returns the configuration as set by Set Status LED Config

Associated constants:

• LCD_128X64BRICKLET_STATUS_LED_CONFIG_OFF
• LCD_128X64BRICKLET_STATUS_LED_CONFIG_ON
• LCD_128X64BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT
• LCD_128X64BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS

pub fn get_chip_temperature(&self) -> ConvertingReceiver<i16>

Returns the temperature in °C 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 fn reset(&self) -> ConvertingReceiver<()>

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 fn write_uid(&self, uid: u32) -> ConvertingReceiver<()>

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 fn read_uid(&self) -> ConvertingReceiver<u32>

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

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 Lcd128x64Bricklet

fn clone(&self) -> Lcd128x64Bricklet

Returns a copy of the value.

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

Performs copy-assignment from source.