Struct st7565::ST7565

pub struct ST7565<DI, SPECS, MODE, const WIDTH: usize, const HEIGHT: usize, const PAGES: usize> { /* private fields */ }

The actual driver

Implementations

impl<DI, SPECS, MODE, const WIDTH: usize, const HEIGHT: usize, const PAGES: usize> ST7565<DI, SPECS, MODE, WIDTH, HEIGHT, PAGES>where DI: WriteOnlyDataCommand, SPECS: DisplaySpecs<WIDTH, HEIGHT, PAGES>,

–– Common functionality for all modes ––

pub fn set_static_indicator( &mut self, mode: Option<StaticIndicatorMode> ) -> Result<(), DisplayError>

Set the static indicator

pub fn set_display_on(&mut self, on: bool) -> Result<(), DisplayError>

Enable/Disable the display output

pub fn reset<RST, DELAY, PinE>( &mut self, rst: &mut RST, delay: &mut DELAY ) -> Result<(), Error<PinE>>where RST: OutputPin<Error = PinE>, DELAY: DelayMs<u8>,

Reset the display and restore all settings

impl<'a, DI: WriteOnlyDataCommand, SPECS, const WIDTH: usize, const HEIGHT: usize, const PAGES: usize> ST7565<DI, SPECS, GraphicsMode<'a, WIDTH, PAGES>, WIDTH, HEIGHT, PAGES>

–– Functionality of the graphics mode ––

In this mode, the driver can be used as a DrawTarget for the embedded_graphics crate.

pub fn flush(&mut self) -> Result<(), DisplayError>

Flushes the internal buffer to the screen.

Needs to be called after drawing to actually display the data on screen.

pub fn release_display_interface( self ) -> (ST7565<(), SPECS, GraphicsMode<'a, WIDTH, PAGES>, WIDTH, HEIGHT, PAGES>, DI)

Release the display interface object

This is meant for situations where the display interface is shared between several devices.

All functions that perform communication with the display are unavailable until the display interface is attached again.

Note that the bus attached later does not need to be the same bus as returned by this function, so the returned SPI bus object may be ignored (for example if the display interface object is based on references instead of ownership).

impl<'a, SPECS, const WIDTH: usize, const HEIGHT: usize, const PAGES: usize> ST7565<(), SPECS, GraphicsMode<'a, WIDTH, PAGES>, WIDTH, HEIGHT, PAGES>

–– Functionality of the detached graphics mode ––

In this mode, the driver can be still used as a DrawTarget for the embedded_graphics crate, but no display communication can happen until the display interface is attached again.

This makes it possible to share the SPI bus with multiple devices.

pub fn attach_display_interface<DI: WriteOnlyDataCommand>( self, interface: DI ) -> ST7565<DI, SPECS, GraphicsMode<'a, WIDTH, PAGES>, WIDTH, HEIGHT, PAGES>

Attach the display interface back to the driver

impl<DI, SPECS, const WIDTH: usize, const HEIGHT: usize, const PAGES: usize> ST7565<DI, SPECS, InitialMode, WIDTH, HEIGHT, PAGES>where DI: WriteOnlyDataCommand, SPECS: DisplaySpecs<WIDTH, HEIGHT, PAGES>,

–– Functionality of the initial mode ––

This mode is purely to transition into other modes.

pub fn new(interface: DI, _display_specs: SPECS) -> Self

Creates an ST7565 driver.

pub fn into_raw_mode(self) -> ST7565<DI, SPECS, RawMode, WIDTH, HEIGHT, PAGES>

Transitions the driver into raw mode.

Raw mode provides functionality to control the ST7565 chip directly through low-level commands.

pub fn into_graphics_mode( self, buffer: &mut GraphicsPageBuffer<WIDTH, PAGES> ) -> ST7565<DI, SPECS, GraphicsMode<'_, WIDTH, PAGES>, WIDTH, HEIGHT, PAGES>

Transitions the driver into graphics mode.

Graphics mode enables the driver to be used as a DrawTarget for the embedded_graphics crate.

impl<DI, SPECS, const WIDTH: usize, const HEIGHT: usize, const PAGES: usize> ST7565<DI, SPECS, RawMode, WIDTH, HEIGHT, PAGES>where DI: WriteOnlyDataCommand,

–– Functionality of the raw mode ––

This mode exists for interacting with the ST7565 chip via direct low level commands.

pub fn set_page(&mut self, page: u8) -> Result<(), DisplayError>

Sets the page to write into

pub fn set_column(&mut self, address: u8) -> Result<(), DisplayError>

Sets the column to write into

pub fn set_line_offset(&mut self, offset: u8) -> Result<(), DisplayError>

Sets the line offset, effectively scrolling the display through memory.

pub fn set_inverted(&mut self, inverted: bool) -> Result<(), DisplayError>

Sets whether the pixels should be inverted.

pub fn write_pixel_data(&mut self, data: &[u8]) -> Result<(), DisplayError>

Writes raw pixel data.

For more information how data is processed by the display, read the ST7565 reference manual.

pub fn adc_select(&mut self, reverse: bool) -> Result<(), DisplayError>

Sets the adc direction.

Effectively flips the display horizontally.

pub fn common_output_mode_select( &mut self, reverse: bool ) -> Result<(), DisplayError>

Sets the common mode direction.

Effectively flips the display vertically.

pub fn display_all_points(&mut self, enable: bool) -> Result<(), DisplayError>

Displays all points of the display

Trait Implementations

impl<'a, DI, SPECS, const WIDTH: usize, const HEIGHT: usize, const PAGES: usize> DrawTarget for ST7565<DI, SPECS, GraphicsMode<'a, WIDTH, PAGES>, WIDTH, HEIGHT, PAGES>where SPECS: DisplaySpecs<WIDTH, HEIGHT, PAGES>,

type Color = BinaryColor

The pixel color type the targetted display supports.

type Error = Infallible

Error type to return when a drawing operation fails.

fn draw_iter<I>(&mut self, pixels: I) -> Result<(), Self::Error>where I: IntoIterator<Item = Pixel<Self::Color>>,

Draw individual pixels to the display without a defined order.

fn fill_contiguous<I>( &mut self, area: &Rectangle, colors: I ) -> Result<(), Self::Error>where I: IntoIterator<Item = Self::Color>,

Fill a given area with an iterator providing a contiguous stream of pixel colors.

fn fill_solid( &mut self, area: &Rectangle, color: Self::Color ) -> Result<(), Self::Error>

Fill a given area with a solid color.

fn clear(&mut self, color: Self::Color) -> Result<(), Self::Error>

Fill the entire display with a solid color.

impl<'a, DI, SPECS, const WIDTH: usize, const HEIGHT: usize, const PAGES: usize> OriginDimensions for ST7565<DI, SPECS, GraphicsMode<'a, WIDTH, PAGES>, WIDTH, HEIGHT, PAGES>where SPECS: DisplaySpecs<WIDTH, HEIGHT, PAGES>,

fn size(&self) -> Size

Returns the size of the bounding box.