Struct st7920::ST7920

pub struct ST7920<SPI, RST, CS>
where
    SPI: SpiDevice,
    RST: OutputPin,
    CS: OutputPin,
{ /* private fields */ }

Implementations

impl<SPI, RST, CS, PinError, SPIError> ST7920<SPI, RST, CS>

where SPI: SpiDevice<Error = SPIError>, RST: OutputPin<Error = PinError>, CS: OutputPin<Error = PinError>,

pub fn new(spi: SPI, rst: RST, cs: Option<CS>, flip: bool) -> Self

Create a new ST7920<SPI, RST, CS> driver instance that uses SPI connection.

Examples

use st7920::ST7920;

let result = ST7920::new(spi, GPIO::new(pins.p01), None, false);
assert_eq!(result, );

pub fn init<Delay: DelayNs>( &mut self, delay: &mut Delay ) -> Result<(), Error<SPIError, PinError>>

Initialize the display controller

pub fn modify_buffer(&mut self, f: fn(x: u8, y: u8, v: u8) -> u8)

Modify the raw buffer. 1 byte (u8) = 8 pixels

Examples

let mut st7920 = st7920::ST7920(...);
// add crazy pattern
st7920.modify_buffer(|x, y, v| {
    if x % 2 == y % 2 {
        v | 0b10101010
    } else {
        v
    }
});
st7920.flush();

pub fn clear_buffer(&mut self)

clears the buffer but don’t update the display

pub fn clear<Delay: DelayNs>( &mut self, delay: &mut Delay ) -> Result<(), Error<SPIError, PinError>>

Clear whole display area and clears the buffer

pub fn clear_buffer_region( &mut self, x: u8, y: u8, w: u8, h: u8 ) -> Result<(), Error<SPIError, PinError>>

Clear a buffer region.

If the region is completely off screen, nothing will be done and Ok()) will be returned. If the given width or height are too big, width and height will be trimmed to the screen dimensions.

pub fn set_pixel(&mut self, x: u8, y: u8, val: u8)

Draw pixel

Doesn’t draw anything, if the x or y coordinates are off canvas.

Supported values are 0 and (not 0)

pub fn set_pixel_unchecked(&mut self, x: u8, y: u8, val: u8)

Draw pixel without canvas bounds checking.

Supported values are 0 and (not 0)

Panics

May panic or draw to undefined pixels, if x or y coordinates are off canvas.

pub fn flush<Delay: DelayNs>( &mut self, delay: &mut Delay ) -> Result<(), Error<SPIError, PinError>>

Flush buffer to update entire display

pub fn flush_region<Delay: DelayNs>( &mut self, x: u8, y: u8, w: u8, h: u8, delay: &mut Delay ) -> Result<(), Error<SPIError, PinError>>

Flush buffer to update region of the display

If the region is completely off screen, nothing will be done and Ok()) will be returned. If the given width or height are too big, width and height will be trimmed to the screen dimensions.

impl<SPI, RST, CS, PinError, SPIError> ST7920<SPI, RST, CS>

where SPI: SpiDevice<Error = SPIError>, RST: OutputPin<Error = PinError>, CS: OutputPin<Error = PinError>,

pub fn flush_region_graphics<Delay: DelayNs>( &mut self, region: (Point, Size), delay: &mut Delay ) -> Result<(), Error<SPIError, PinError>>

Trait Implementations

impl<SPI, CS, RST, PinError, SPIError> DrawTarget for ST7920<SPI, CS, RST>

where SPI: SpiDevice<Error = SPIError>, RST: OutputPin<Error = PinError>, CS: OutputPin<Error = PinError>,

type Error = Infallible

Error type to return when a drawing operation fails.

type Color = BinaryColor

The pixel color type the targetted display supports.

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<SPI, CS, RST, PinError, SPIError> OriginDimensions for ST7920<SPI, CS, RST>

where SPI: SpiDevice<Error = SPIError>, RST: OutputPin<Error = PinError>, CS: OutputPin<Error = PinError>,

fn size(&self) -> Size

Returns the size of the bounding box.