Struct Epd2In9 

pub struct Epd2In9<HW, STATE> { /* private fields */ }

Controls v1 of the 2.9“ Waveshare e-paper display.

• datasheet
• sample code

The display has a portrait orientation. This uses BinaryColor, where Off is black and On is white.

HW should implement ResetHw, BusyHw, DcHw, SpiHw, DelayHw, and ErrorHw.

Implementations

impl<HW> Epd2In9<HW, StateUninitialized>

where HW: DcHw + ResetHw + BusyHw + DelayHw + ErrorHw + SpiHw, HW::Error: From<<HW::Dc as ErrorType>::Error> + From<<HW::Reset as ErrorType>::Error> + From<<HW::Busy as ErrorType>::Error> + From<<HW::Spi as ErrorType>::Error>,

pub fn new(hw: HW) -> Self

impl<HW, STATE> Epd2In9<HW, STATE>

where HW: DcHw + ResetHw + BusyHw + DelayHw + ErrorHw + SpiHw, STATE: StateAwake, HW::Error: From<<HW::Dc as ErrorType>::Error> + From<<HW::Reset as ErrorType>::Error> + From<<HW::Busy as ErrorType>::Error> + From<<HW::Spi as ErrorType>::Error>,

pub async fn init( self, spi: &mut HW::Spi, mode: RefreshMode, ) -> Result<Epd2In9<HW, StateReady>, HW::Error>

Initialise the display. This should be called before any other operations.

impl<HW, STATE> Epd2In9<HW, STATE>

where HW: DcHw + BusyHw + ErrorHw + SpiHw, STATE: StateAwake, HW::Error: From<<HW::Dc as ErrorType>::Error> + From<<HW::Busy as ErrorType>::Error> + From<<HW::Spi as ErrorType>::Error>,

pub async fn set_border( &mut self, spi: &mut HW::Spi, color: BinaryColor, ) -> Result<(), HW::Error>

Sets the border to the specified colour. You need to call Displayable::update_display using RefreshMode::Full afterwards to apply this change.

Note: on my board, the white setting fades to grey fairly quickly. I have not found a way to avoid this.

pub async fn send( &mut self, spi: &mut HW::Spi, command: Command, data: &[u8], ) -> Result<(), HW::Error>

Send the following command and data to the display. Waits until the display is no longer busy before sending.

impl<HW> Epd2In9<HW, StateReady>

where HW: DcHw + BusyHw + DelayHw + ErrorHw + SpiHw, HW::Error: From<<HW::Dc as ErrorType>::Error> + From<<HW::Busy as ErrorType>::Error> + From<<HW::Spi as ErrorType>::Error>,

pub async fn set_refresh_mode( &mut self, spi: &mut HW::Spi, mode: RefreshMode, ) -> Result<(), HW::Error>

Sets the refresh mode.

pub async fn set_window( &mut self, spi: &mut HW::Spi, shape: Rectangle, ) -> Result<(), HW::Error>

Sets the window to which the next image data will be written.

The x-axis only supports multiples of 8; values outside this result in a debug-mode panic, or potentially misaligned content when debug assertions are disabled.

pub async fn set_cursor( &mut self, spi: &mut HW::Spi, position: Point, ) -> Result<(), HW::Error>

Sets the cursor position to write the next data to.

The x-axis only supports multiples of 8; values outside this will result in a panic in debug mode, or potentially misaligned content if debug assertions are disabled.

Trait Implementations

impl<HW> DisplayPartial<1, 1, <HW as SpiHw>::Spi, <HW as ErrorHw>::Error> for Epd2In9<HW, StateReady>

where HW: DcHw + BusyHw + DelayHw + ErrorHw + SpiHw, HW::Error: From<<HW::Dc as ErrorType>::Error> + From<<HW::Busy as ErrorType>::Error> + From<<HW::Spi as ErrorType>::Error>,

async fn write_base_framebuffer( &mut self, spi: &mut HW::Spi, buf: &dyn BufferView<1, 1>, ) -> Result<(), HW::Error>

Writes buffer data into the old internal framebuffer. This can be useful either:

• to prep the next frame before the current one has been displayed (since the old buffer becomes the current buffer after the next call to Self::update_display()).
• to modify the “diff base” if in RefreshMode::Partial. Also see Command::DisplayUpdateControl1.

impl<HW> DisplaySimple<1, 1, <HW as SpiHw>::Spi, <HW as ErrorHw>::Error> for Epd2In9<HW, StateReady>

where HW: DcHw + BusyHw + DelayHw + ErrorHw + SpiHw, HW::Error: From<<HW::Dc as ErrorType>::Error> + From<<HW::Busy as ErrorType>::Error> + From<<HW::Spi as ErrorType>::Error>,

async fn display_framebuffer( &mut self, spi: &mut HW::Spi, buf: &dyn BufferView<1, 1>, ) -> Result<(), HW::Error>

A shortcut for calling DisplaySimple::write_framebuffer followed by Displayable::update_display.

async fn write_framebuffer( &mut self, spi: &mut HW::Spi, buf: &dyn BufferView<1, 1>, ) -> Result<(), HW::Error>

Writes the given buffer’s data into the main framebuffer to be displayed on the next call to Displayable::update_display.

impl<HW> Displayable<<HW as SpiHw>::Spi, <HW as ErrorHw>::Error> for Epd2In9<HW, StateReady>

where HW: DcHw + BusyHw + DelayHw + ErrorHw + SpiHw, HW::Error: From<<HW::Dc as ErrorType>::Error> + From<<HW::Busy as ErrorType>::Error> + From<<HW::Spi as ErrorType>::Error>,

async fn update_display(&mut self, spi: &mut HW::Spi) -> Result<(), HW::Error>

Updates (refreshes) the display based on what has been written to the framebuffer.

impl<HW, STATE> Reset<<HW as ErrorHw>::Error> for Epd2In9<HW, STATE>

where HW: ResetHw + DelayHw + ErrorHw, HW::Error: From<<HW::Reset as ErrorType>::Error>, STATE: StateAwake,

type DisplayOut = Epd2In9<HW, STATE>

async fn reset(self) -> Result<Self::DisplayOut, HW::Error>

Hardware resets the display.

impl<HW, W> Reset<<HW as ErrorHw>::Error> for Epd2In9<HW, StateAsleep<W>>

where HW: ResetHw + DelayHw + ErrorHw, HW::Error: From<<HW::Reset as ErrorType>::Error>, W: StateAwake,

type DisplayOut = Epd2In9<HW, W>

async fn reset(self) -> Result<Self::DisplayOut, HW::Error>

Hardware resets the display.

impl<HW, STATE> Sleep<<HW as SpiHw>::Spi, <HW as ErrorHw>::Error> for Epd2In9<HW, STATE>

where HW: DcHw + BusyHw + ErrorHw + SpiHw, HW::Error: From<<HW::Dc as ErrorType>::Error> + From<<HW::Busy as ErrorType>::Error> + From<<HW::Spi as ErrorType>::Error>, STATE: StateAwake,

type DisplayOut = Epd2In9<HW, StateAsleep<STATE>>

async fn sleep(self, spi: &mut HW::Spi) -> Result<Self::DisplayOut, HW::Error>

Puts the display to sleep.

impl<HW, W> Wake<<HW as SpiHw>::Spi, <HW as ErrorHw>::Error> for Epd2In9<HW, StateAsleep<W>>

where HW: ResetHw + BusyHw + DelayHw + ErrorHw + SpiHw, HW::Error: From<<HW::Reset as ErrorType>::Error> + From<<HW::Busy as ErrorType>::Error> + From<<HW::Spi as ErrorType>::Error>, W: StateAwake,

type DisplayOut = Epd2In9<HW, W>

async fn wake(self, _spi: &mut HW::Spi) -> Result<Self::DisplayOut, HW::Error>

Wakes and re-initialises the display (if necessary) if it’s asleep.