Skip to content

Commit c67164b

Browse files
committed
Create README.md file
1 parent 7879734 commit c67164b

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

README.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# PC8544
2+
3+
This Rust library provides [embedded-hal](https://github.com/rust-embedded/embedded-hal) support for PCD8544-based LCD displays,
4+
commonly used in Nokia 5110 and similar devices. \
5+
_It is based on [the work](https://github.com/dancek/pcd8544-hal/) by Hannu Hartikainen._
6+
7+
## Features
8+
9+
- [x] 100% safe
10+
- [x] SPI support
11+
- [x] GPIO support
12+
- [ ] Vertical scrolling (up/down)
13+
- [ ] Special characters support (line feed, carriage return)
14+
15+
## Model support
16+
17+
Any microcontroller HAL with embedded-hal support should work with this driver
18+
19+
## Usage
20+
Add this line to your `Cargo.toml`'s `[dependencies]` section:
21+
```toml
22+
[dependencies]
23+
pcd8544 = "0.1.0"
24+
```
25+
26+
An example of using the library with an Arduino Uno is provided under [examples/arduino-uno-pcd8544](examples/arduino-uno-pcd8544).
27+

0 commit comments

Comments
 (0)