Struct ssd1306::mode::terminal::TerminalMode

pub struct TerminalMode<DI, DSIZE = DisplaySize128x64> where
    DSIZE: TerminalDisplaySize,  { /* fields omitted */ }

Terminal mode handler

Implementations

impl<DI, DSIZE> TerminalMode<DI, DSIZE> where
    DI: WriteOnlyDataCommand,
    DSIZE: TerminalDisplaySize, 

pub fn clear(&mut self) -> Result<(), TerminalModeError>

Clear the display and reset the cursor to the top left corner

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

Write out data to display. This is a noop in terminal mode.

pub fn print_char(&mut self, c: char) -> Result<(), TerminalModeError>

Print a character to the display

pub fn init(&mut self) -> Result<(), TerminalModeError>

Initialise the display in page mode (i.e. a byte walks down a column of 8 pixels) with column 0 on the left and column (DSIZE::Width::U8 - 1) on the right, but no automatic line wrapping.

pub fn set_rotation(
    &mut self,
    rot: DisplayRotation
) -> Result<(), TerminalModeError>

Set the display rotation

This method resets the cursor but does not clear the screen.

pub fn display_on(&mut self, on: bool) -> Result<(), TerminalModeError>

Turn the display on or off. The display can be drawn to and retains all of its memory even while off.

pub fn set_brightness(
    &mut self,
    brightness: Brightness
) -> Result<(), TerminalModeError>

Change the display brightness.

pub fn get_position(&self) -> Result<(u8, u8), TerminalModeError>

Get the current cursor position, in character coordinates. This is the (column, row) that the next character will be written to.

pub fn set_position(
    &mut self,
    column: u8,
    row: u8
) -> Result<(), TerminalModeError>

Set the cursor position, in character coordinates. This is the (column, row) that the next character will be written to. If the position is out of bounds, an Err will be returned.

Trait Implementations

impl<DI, DSIZE> DisplayModeTrait<DI, DSIZE> for TerminalMode<DI, DSIZE> where
    DI: WriteOnlyDataCommand,
    DSIZE: TerminalDisplaySize, 

pub fn new(properties: DisplayProperties<DI, DSIZE>) -> Self

Create new TerminalMode instance

pub fn into_properties(self) -> DisplayProperties<DI, DSIZE>

Release display interface used by TerminalMode

pub fn release(self) -> DI

Release display interface

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

impl<DI, DSIZE> Write for TerminalMode<DI, DSIZE> where
    DI: WriteOnlyDataCommand,
    DSIZE: TerminalDisplaySize, 

pub fn write_str(&mut self, s: &str) -> Result<(), Error>

Writes a string slice into this writer, returning whether the write succeeded.

pub fn write_char(&mut self, c: char) -> Result<(), Error>

Writes a char into this writer, returning whether the write succeeded.

pub fn write_fmt(&mut self, args: Arguments<'_>) -> Result<(), Error>

Glue for usage of the write! macro with implementors of this trait.