Skip to content

Commit e589641

Browse files
committed
add note about SPI
1 parent 2f9f2f7 commit e589641

File tree

2 files changed

+5
-3
lines changed

2 files changed

+5
-3
lines changed

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,13 @@ This crate provides a driver for the ST7567S display controller that can be used
77

88
# Features
99

10-
- Supports I2C and SPI communication protocols via the [`display_interface`](https://docs.rs/display_interface) crate.
10+
- Supports I2C and SPI communication protocols via the [`display_interface`](https://docs.rs/display_interface) crate.
1111
- Provides two display modes:
1212
- Internal Buffer Mode: This mode allows you to modify an internal buffer by using methods like `set_pixel`, `clear`, or by using the [`embedded-graphics`](https://docs.rs/embedded-graphics) crate. Once you have made your changes, you can call the `flush` method to write the buffer to the display.
1313
- Direct Write Mode: This mode allows you to write directly to the display memory by calling the `draw` method.
1414

15-
**Note**: This driver is designed to work with a more generic 128x64 resolution, instead of the original 132x65 resolution of the ST7567S controller.
15+
**Note**: This driver is designed to work with a more generic 128x64 resolution, instead of the original 132x65 resolution of the ST7567S controller.
16+
**Note**: SPI communication is not tested yet.
1617

1718
Thanks [`ssd1306`](https://github.com/jamwaffles/ssd1306) driver for served as an example.
1819

src/lib.rs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
//! ST7567S Display Controller Driver
1+
//! # ST7567S Display Controller Driver
22
//!
33
//! This crate provides a driver for the ST7567S display controller that can be used with Rust embedded projects.
44
//!
@@ -16,6 +16,7 @@
1616
//! [`draw`]: crate::display::ST7567S#method.draw
1717
//!
1818
//! **Note**: This driver is designed to work with a more generic 128x64 resolution, instead of the original 132x65 resolution of the ST7567S controller.
19+
//! **Note**: SPI communication is not tested yet.
1920
2021
#![no_std]
2122

0 commit comments

Comments
 (0)