Struct Lcd

pub struct Lcd<'a, 'b, Sender, Delayer, const READABLE: bool>
where
    Delayer: DelayNs,
{ /* private fields */ }

Lcd is the main struct to drive a LCD1602

Implementations

impl<'a, 'b, Sender, Delayer, const READABLE: bool> Lcd<'a, 'b, Sender, Delayer, READABLE>

where Sender: SendCommand<Delayer, READABLE>, Delayer: DelayNs,

pub fn new( sender: &'a mut Sender, delayer: &'b mut Delayer, config: Config, poll_interval_us: Option<u32>, ) -> Self

Create a Lcd driver, and init LCD hardware

If we don’t specify poll_interval_us,
then default value will be 40 us for Write-Only mode, and 10 us for Read-Write mode

Trait Implementations

impl<'a, 'b, Sender, Delayer, const READABLE: bool> Anim for Lcd<'a, 'b, Sender, Delayer, READABLE>

where Delayer: DelayNs, Sender: SendCommand<Delayer, READABLE>,

fn full_display_blink(&mut self, count: u32, interval_us: u32)

Make the entire screen blink

fn typewriter_write(&mut self, str: &str, delay_us: u32)

Typewriter-style display

fn split_flap_write( &mut self, str: &str, fs: FlipStyle, max_flip_cnt: Option<u8>, per_flip_delay_us: u32, per_char_flip_delay_us: Option<u32>, )

Split-Flap-style display

fn shift_display_to_pos( &mut self, target_pos: u8, ms: MoveStyle, display_state_when_shift: State, delay_us_per_step: u32, )

Move the display window to the specified position (measured from the upper-left corner of the display)

impl<'a, 'b, Sender, Delayer, const READABLE: bool> Basic for Lcd<'a, 'b, Sender, Delayer, READABLE>

where Sender: SendCommand<Delayer, READABLE>, Delayer: DelayNs,

fn set_backlight(&mut self, backlight: State)

Note: Due to driver implementation, this function may have actual effect, or not

fn get_backlight(&self) -> State

fn write_byte_to_cur(&mut self, byte: u8)

fn write_graph_to_cgram(&mut self, index: u8, graph_data: &CGRAMGraph)

Note:
We allow write Font5x11 graph even under Font5x8 mode.

fn clean_display(&mut self)

fn return_home(&mut self)

fn set_line_mode(&mut self, line: LineMode)

fn get_line_mode(&self) -> LineMode

fn set_font(&mut self, font: Font)

fn get_font(&self) -> Font

fn set_display_state(&mut self, display: State)

fn get_display_state(&self) -> State

fn set_cursor_state(&mut self, cursor: State)

fn get_cursor_state(&self) -> State

fn get_ram_type(&self) -> RAMType

fn set_cursor_blink_state(&mut self, blink: State)

fn get_cursor_blink_state(&self) -> State

fn set_direction(&mut self, dir: MoveDirection)

fn get_direction(&self) -> MoveDirection

fn set_shift_type(&mut self, shift: ShiftType)

fn get_shift_type(&self) -> ShiftType

fn set_cursor_pos(&mut self, pos: (u8, u8))

fn set_cgram_addr(&mut self, addr: u8)

fn get_cursor_pos(&self) -> (u8, u8)

fn shift_cursor_or_display(&mut self, shift_type: ShiftType, dir: MoveDirection)

fn get_display_offset(&self) -> u8

fn set_poll_interval(&mut self, interval_us: u32)

fn get_poll_interval_us(&self) -> u32

fn get_line_capacity(&self) -> u8

fn calculate_pos_by_offset(&self, start: (u8, u8), offset: (i8, i8)) -> (u8, u8)

fn delay_ms(&mut self, ms: u32)

Wait for specified milliseconds

fn delay_us(&mut self, us: u32)

Wait for specified microseconds

impl<'a, 'b, Sender, Delayer> BasicRead for Lcd<'a, 'b, Sender, Delayer, true>

where Sender: SendCommand<Delayer, true>, Delayer: DelayNs,

fn read_u8_from_cur(&mut self) -> u8

impl<'a, 'b, Sender, Delayer, const READABLE: bool> Ext for Lcd<'a, 'b, Sender, Delayer, READABLE>

where Delayer: DelayNs, Sender: SendCommand<Delayer, READABLE>,

fn toggle_display(&mut self)

toggle entire display on and off (it doesn’t toggle backlight)

fn write_char_to_cur(&mut self, char: char)

write char to current position In default implementation, character only support from ASCII 0x20 (white space) to ASCII 0x7D (})

fn write_str_to_cur(&mut self, str: &str)

write string to current position

fn write_byte_to_pos(&mut self, byte: u8, pos: (u8, u8))

write a byte to specific position

fn write_char_to_pos(&mut self, char: char, pos: (u8, u8))

write a char to specific position

fn write_str_to_pos(&mut self, str: &str, pos: (u8, u8))

write string to specific position

fn write_graph_to_cur(&mut self, index: u8)

write custom graph to current position

fn write_graph_to_pos(&mut self, index: u8, pos: (u8, u8))

write custom graph to specific position

fn offset_cursor_pos(&mut self, offset: (i8, i8))

change cursor position with relative offset

impl<'a, 'b, Sender, Delayer> ExtRead for Lcd<'a, 'b, Sender, Delayer, true>

where Delayer: DelayNs, Sender: SendCommand<Delayer, true>,

fn read_byte_from_pos(&mut self, pos: (u8, u8)) -> u8

read a byte from specific position

fn read_graph_from_cgram(&mut self, index: u8) -> CGRAMGraph

read custom graph data from CGRAM