Struct tinkerforge_async::e_paper_296x128_bricklet::EPaper296x128Bricklet

source ·

pub struct EPaper296x128Bricklet { /* private fields */ }

Expand description

Three color 296x128 e-paper display

Implementations§

source §

pub fn new(uid: u32, connection: AsyncIpConnection) -> EPaper296x128Bricklet

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: EPaper296x128BrickletFunction ) -> 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: EPaper296x128BrickletFunction, 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_draw_status_callback_receiver( &mut self ) -> impl Stream<Item = u8>

Receiver for the current draw status. Will be called every time the draw status changes (see get_draw_status).

source

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

Draws the current black/white and red or gray buffer to the e-paper display.

The Bricklet does not have any double-buffering. You should not call this function while writing to the buffer. See [get_draw_status].

source

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

Returns one of three draw statuses:

Idle
Copying: Data is being copied from the buffer of the Bricklet to the buffer of the display.
Drawing: The display is updating its content (during this phase the flickering etc happens).

You can write to the buffer (through one of the write or draw functions) when the status is either idle or drawing. You should not write to the buffer while it is being copied to the display. There is no double-buffering.

Associated constants:

E_PAPER_296X128_BRICKLET_DRAW_STATUS_IDLE
E_PAPER_296X128_BRICKLET_DRAW_STATUS_COPYING
E_PAPER_296X128_BRICKLET_DRAW_STATUS_DRAWING

source

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

Writes black/white pixels to the specified window into the buffer.

The pixels are written into the window line by line top to bottom and each line is written from left to right.

The value 0 (false) corresponds to a black pixel and the value 1 (true) to a white pixel.

This function writes the pixels into the black/white pixel buffer, to draw the buffer to the display use [draw].

Use [write_color] to write red or gray pixels.

source

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

Returns the current content of the black/white pixel buffer for the specified window.

The pixels are read into the window line by line top to bottom and each line is read from left to right.

The current content of the buffer does not have to be the current content of the display. It is possible that the data was not drawn to the display yet and after a restart of the Bricklet the buffer will be reset to black, while the display retains its content.

source

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

The E-Paper 296x128 Bricklet is available with the colors black/white/red and black/white/gray. Depending on the model this function writes either red or gray pixels to the specified window into the buffer.

The pixels are written into the window line by line top to bottom and each line is written from left to right.

The value 0 (false) means that this pixel does not have color. It will be either black or white (see [write_black_white]). The value 1 (true) corresponds to a red or gray pixel, depending on the Bricklet model.

This function writes the pixels into the red or gray pixel buffer, to draw the buffer to the display use [draw].

Use [write_black_white] to write black/white pixels.

source

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

Returns the current content of the red or gray pixel buffer for 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.

The current content of the buffer does not have to be the current content of the display. It is possible that the data was not drawn to the display yet and after a restart of the Bricklet the buffer will be reset to black, while the display retains its content.

source

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

Fills the complete content of the display with the given color.

This function writes the pixels into the black/white/red|gray pixel buffer, to draw the buffer to the display use [draw].

Associated constants:

E_PAPER_296X128_BRICKLET_COLOR_BLACK
E_PAPER_296X128_BRICKLET_COLOR_WHITE
E_PAPER_296X128_BRICKLET_COLOR_RED
E_PAPER_296X128_BRICKLET_COLOR_GRAY

source

pub async fn draw_text( &mut self, position_x: u16, position_y: u8, font: u8, color: u8, orientation: u8, text: String ) -> Result<(), TinkerforgeError>

Draws a text with up to 50 characters at the pixel position (x, y).

You can use one of 9 different font sizes and draw the text in black/white/red|gray. The text can be drawn horizontal or vertical.

This function writes the pixels into the black/white/red|gray pixel buffer, to draw the buffer to the display use [draw].

The font conforms to code page 437.

Associated constants:

E_PAPER_296X128_BRICKLET_FONT_6X8
E_PAPER_296X128_BRICKLET_FONT_6X16
E_PAPER_296X128_BRICKLET_FONT_6X24
E_PAPER_296X128_BRICKLET_FONT_6X32
E_PAPER_296X128_BRICKLET_FONT_12X16
E_PAPER_296X128_BRICKLET_FONT_12X24
E_PAPER_296X128_BRICKLET_FONT_12X32
E_PAPER_296X128_BRICKLET_FONT_18X24
E_PAPER_296X128_BRICKLET_FONT_18X32
E_PAPER_296X128_BRICKLET_FONT_24X32
E_PAPER_296X128_BRICKLET_COLOR_BLACK
E_PAPER_296X128_BRICKLET_COLOR_WHITE
E_PAPER_296X128_BRICKLET_COLOR_RED
E_PAPER_296X128_BRICKLET_COLOR_GRAY
E_PAPER_296X128_BRICKLET_ORIENTATION_HORIZONTAL
E_PAPER_296X128_BRICKLET_ORIENTATION_VERTICAL

source

pub async fn draw_line( &mut self, position_x_start: u16, position_y_start: u8, position_x_end: u16, position_y_end: u8, color: u8 ) -> Result<(), TinkerforgeError>

Draws a line from (x, y)-start to (x, y)-end in the given color.

This function writes the pixels into the black/white/red|gray pixel buffer, to draw the buffer to the display use [draw].

Associated constants:

E_PAPER_296X128_BRICKLET_COLOR_BLACK
E_PAPER_296X128_BRICKLET_COLOR_WHITE
E_PAPER_296X128_BRICKLET_COLOR_RED
E_PAPER_296X128_BRICKLET_COLOR_GRAY

source

pub async fn draw_box( &mut self, position_x_start: u16, position_y_start: u8, position_x_end: u16, position_y_end: u8, fill: bool, color: u8 ) -> Result<(), TinkerforgeError>

Draws a box from (x, y)-start to (x, y)-end in the given color.

If you set fill to true, the box will be filled with the color. Otherwise only the outline will be drawn.

This function writes the pixels into the black/white/red|gray pixel buffer, to draw the buffer to the display use [draw].

Associated constants:

E_PAPER_296X128_BRICKLET_COLOR_BLACK
E_PAPER_296X128_BRICKLET_COLOR_WHITE
E_PAPER_296X128_BRICKLET_COLOR_RED
E_PAPER_296X128_BRICKLET_COLOR_GRAY

source

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

§Note

The default update mode corresponds to the default e-paper display manufacturer settings. All of the other modes are experimental and will result in increased ghosting and possibly other long-term side effects.

If you want to know more about the inner workings of an e-paper display take a look at this excellent video from Ben Krasnow: https://www.youtube.com/watch?v=MsbiO8EAsGw__.

If you are not sure about this option, leave the update mode at default.

Currently there are three update modes available:

Default: Settings as given by the manufacturer. An update will take about 7.5 seconds and during the update the screen will flicker several times.
Black/White: This will only update the black/white pixel. It uses the manufacturer settings for black/white and ignores the red or gray pixel buffer. With this mode the display will flicker once and it takes about 2.5 seconds. Compared to the default settings there is more ghosting.
Delta: This will only update the black/white pixel. It uses an aggressive method where the changes are not applied for a whole buffer but only for the delta between the last and the next buffer. With this mode the display will not flicker during an update and it takes about 900-950ms. Compared to the other two settings there is more ghosting. This mode can be used for something like a flicker-free live update of a text.

With the black/white/red display if you use either the black/white or the delta mode, after a while of going back and forth between black and white the white color will start to appear red-ish or pink-ish.

If you use the aggressive delta mode and rapidly change the content, we recommend that you change back to the default mode every few hours and in the default mode cycle between the three available colors a few times. This will get rid of the ghosting and after that you can go back to the delta mode with flicker-free updates.

Associated constants:

E_PAPER_296X128_BRICKLET_UPDATE_MODE_DEFAULT
E_PAPER_296X128_BRICKLET_UPDATE_MODE_BLACK_WHITE
E_PAPER_296X128_BRICKLET_UPDATE_MODE_DELTA

source

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

Returns the update mode as set by [set_update_mode].

Associated constants:

E_PAPER_296X128_BRICKLET_UPDATE_MODE_DEFAULT
E_PAPER_296X128_BRICKLET_UPDATE_MODE_BLACK_WHITE
E_PAPER_296X128_BRICKLET_UPDATE_MODE_DELTA

source

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

Sets the type of the display. The e-paper display is available in black/white/red and black/white/gray. This will be factory set during the flashing and testing phase. The value is saved in non-volatile memory and will stay after a power cycle.

Associated constants:

E_PAPER_296X128_BRICKLET_DISPLAY_TYPE_BLACK_WHITE_RED
E_PAPER_296X128_BRICKLET_DISPLAY_TYPE_BLACK_WHITE_GRAY

source

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

Returns the type of the e-paper display. It can either be black/white/red or black/white/gray.

Associated constants:

E_PAPER_296X128_BRICKLET_DISPLAY_TYPE_BLACK_WHITE_RED
E_PAPER_296X128_BRICKLET_DISPLAY_TYPE_BLACK_WHITE_GRAY

source

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

Sets the type of display driver. The Bricklet can currently support SSD1675A and SSD1680. This will be factory set during the flashing and testing phase. The value is saved in non-volatile memory and will stay after a power cycle.

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

Associated constants:

E_PAPER_296X128_BRICKLET_DISPLAY_DRIVER_SSD1675A
E_PAPER_296X128_BRICKLET_DISPLAY_DRIVER_SSD1680

source

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

Returns the e-paper display driver.

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

Associated constants:

E_PAPER_296X128_BRICKLET_DISPLAY_DRIVER_SSD1675A
E_PAPER_296X128_BRICKLET_DISPLAY_DRIVER_SSD1680

source

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.

source

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:

E_PAPER_296X128_BRICKLET_BOOTLOADER_MODE_BOOTLOADER
E_PAPER_296X128_BRICKLET_BOOTLOADER_MODE_FIRMWARE
E_PAPER_296X128_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT
E_PAPER_296X128_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT
E_PAPER_296X128_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT
E_PAPER_296X128_BRICKLET_BOOTLOADER_STATUS_OK
E_PAPER_296X128_BRICKLET_BOOTLOADER_STATUS_INVALID_MODE
E_PAPER_296X128_BRICKLET_BOOTLOADER_STATUS_NO_CHANGE
E_PAPER_296X128_BRICKLET_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT
E_PAPER_296X128_BRICKLET_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT
E_PAPER_296X128_BRICKLET_BOOTLOADER_STATUS_CRC_MISMATCH

source

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

Returns the current bootloader mode, see [set_bootloader_mode].

Associated constants:

E_PAPER_296X128_BRICKLET_BOOTLOADER_MODE_BOOTLOADER
E_PAPER_296X128_BRICKLET_BOOTLOADER_MODE_FIRMWARE
E_PAPER_296X128_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT
E_PAPER_296X128_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT
E_PAPER_296X128_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT

source

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.

source

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.

source

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:

E_PAPER_296X128_BRICKLET_STATUS_LED_CONFIG_OFF
E_PAPER_296X128_BRICKLET_STATUS_LED_CONFIG_ON
E_PAPER_296X128_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT
E_PAPER_296X128_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS

source

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

Returns the configuration as set by [set_status_led_config]

Associated constants:

E_PAPER_296X128_BRICKLET_STATUS_LED_CONFIG_OFF
E_PAPER_296X128_BRICKLET_STATUS_LED_CONFIG_ON
E_PAPER_296X128_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT
E_PAPER_296X128_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS

source

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.

source