Skip to content

Commit 9b9076b

Browse files
JomerDevKuabeM
authored andcommitted
Update readme and lib docs
1 parent 23ac578 commit 9b9076b

File tree

2 files changed

+10
-7
lines changed

2 files changed

+10
-7
lines changed

README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@
33
Driver to write characters to LCD displays with a LM1602 connected via i2c like [this one] with
44
16x2 characters. It requires a I2C instance implementing [`embedded_hal::blocking::i2c::Write`]
55
and a instance to delay execution with [`embedded_hal::blocking::delay::DelayMs`].
6+
Other LCD sizes are supported, up to displays with 20x4 characters. Everything that uses a
7+
HD44780U or comparable controller and is connected via i2c should work.
8+
Like [this]
69

710
Usage:
811
```
@@ -20,10 +23,9 @@ let mut i2c = arduino_hal::I2c::new(
2023
);
2124
let mut delay = arduino_hal::Delay::new();
2225
23-
let mut lcd = lcd_lcm1602_i2c::Lcd::new(&mut i2c, &mut delay)
26+
let mut lcd = lcd_lcm1602_i2c::LCD16x2::new(&mut i2c, &mut delay)
2427
.address(LCD_ADDRESS)
25-
.cursor_on(false) // no visible cursos
26-
.rows(2) // two rows
28+
.cursor_on(false) // no visible cursor
2729
.init().unwrap();
2830
```
2931

@@ -34,4 +36,4 @@ There is a similar crate [lcd_1602_i2c] but that did not work with [this display
3436
[this one]: https://funduinoshop.com/elektronische-module/displays/lcd/16x02-i2c-lcd-modul-hintergrundbeleuchtung-blau
3537
[lcd address]: https://www.ardumotive.com/i2clcden.html
3638
[lcd_1602_i2c]: https://crates.io/crates/lcd_1602_i2c
37-
39+
[this]: https://www.az-delivery.de/en/products/hd44780-2004-lcd-display-bundle-4x20-zeichen-mit-i2c-schnittstelle

src/lib.rs

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22
//! Driver to write characters to LCD displays with a LM1602 connected via i2c like [this one] with
33
//! 16x2 characters. It requires a I2C instance implementing [`embedded_hal::blocking::i2c::Write`]
44
//! and a instance to delay execution with [`embedded_hal::blocking::delay::DelayMs`].
5+
//! Other LCD sizes are supported, up to displays with 20x4 characters. Everything that uses a
6+
//! HD44780U or comparable controller and is connected via i2c should work
57
//!
68
//! Usage:
79
//! ```
@@ -19,10 +21,9 @@
1921
//! );
2022
//! let mut delay = arduino_hal::Delay::new();
2123
//!
22-
//! let mut lcd = lcd_lcm1602_i2c::Lcd::new(&mut i2c, &mut delay)
24+
//! let mut lcd = lcd_lcm1602_i2c::LCD16x2::new(&mut i2c, &mut delay)
2325
//! .with_address(LCD_ADDRESS)
24-
//! .with_cursor_on(false) // no visible cursos
25-
//! .with_rows(2) // two rows
26+
//! .with_cursor_on(false) // no visible cursor
2627
//! .init().unwrap();
2728
//! ```
2829
//!

0 commit comments

Comments
 (0)