https://github.com/rust-embedded-community/ssd1331
SSD1331 colour OLED display driver for embedded Rust applications using embedded-hal
https://github.com/rust-embedded-community/ssd1331
Last synced: 4 months ago
JSON representation
SSD1331 colour OLED display driver for embedded Rust applications using embedded-hal
- Host: GitHub
- URL: https://github.com/rust-embedded-community/ssd1331
- Owner: rust-embedded-community
- License: apache-2.0
- Created: 2018-03-18T20:04:21.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2022-05-22T19:41:19.000Z (about 4 years ago)
- Last Synced: 2025-12-01T14:55:52.123Z (6 months ago)
- Language: Rust
- Homepage:
- Size: 1.44 MB
- Stars: 18
- Watchers: 3
- Forks: 9
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE-APACHE
Awesome Lists containing this project
README
# SSD1331 driver
[](https://circleci.com/gh/jamwaffles/ssd1331/tree/master)
[](https://crates.io/crates/ssd1331)
[](https://docs.rs/ssd1331)
[](examples/image.rs)
SPI (4 wire) driver for the SSD1331 OLED display.
The display is configured by this driver to use a 16 bit, R5 G6 B5 pixel definition.
You can convert images into the correct BMP format with the following commands:
```bash
convert my_image.png \
-flip \
-type truecolor \
-define bmp:subtype=RGB565 \
-depth 16 \
-strip \
my_image.bmp
```
You can also export images directly from The GIMP by saving as `.bmp` and choosing the following option:
## [Documentation](https://docs.rs/ssd1331)
## [Examples](examples)
This crate uses [`probe-run`](https://crates.io/crates/probe-run) to run the examples. Once set up, it should be as simple as `cargo run --example --release`. `--release` will be required for some examples to reduce FLASH usage.
Load a BMP image of the Rust logo and display it in the center of the display. From
[`examples/bmp.rs`](examples/bmp.rs):
```rust
#![no_std]
#![no_main]
use cortex_m_rt::{entry, exception, ExceptionFrame};
use embedded_graphics::{geometry::Point, image::Image, pixelcolor::Rgb565, prelude::*};
use panic_semihosting as _;
use ssd1331::{DisplayRotation, Ssd1331};
use stm32f1xx_hal::{
delay::Delay,
prelude::*,
spi::{Mode, Phase, Polarity, Spi},
stm32,
};
use tinybmp::Bmp;
#[entry]
fn main() -> ! {
let cp = cortex_m::Peripherals::take().unwrap();
let dp = stm32::Peripherals::take().unwrap();
let mut flash = dp.FLASH.constrain();
let mut rcc = dp.RCC.constrain();
let clocks = rcc.cfgr.freeze(&mut flash.acr);
let mut afio = dp.AFIO.constrain(&mut rcc.apb2);
let mut gpioa = dp.GPIOA.split(&mut rcc.apb2);
let mut gpiob = dp.GPIOB.split(&mut rcc.apb2);
// SPI1
let sck = gpioa.pa5.into_alternate_push_pull(&mut gpioa.crl);
let miso = gpioa.pa6;
let mosi = gpioa.pa7.into_alternate_push_pull(&mut gpioa.crl);
let mut delay = Delay::new(cp.SYST, clocks);
let mut rst = gpiob.pb0.into_push_pull_output(&mut gpiob.crl);
let dc = gpiob.pb1.into_push_pull_output(&mut gpiob.crl);
let spi = Spi::spi1(
dp.SPI1,
(sck, miso, mosi),
&mut afio.mapr,
Mode {
polarity: Polarity::IdleLow,
phase: Phase::CaptureOnFirstTransition,
},
8.mhz(),
clocks,
&mut rcc.apb2,
);
let mut disp = Ssd1331::new(spi, dc, DisplayRotation::Rotate0);
disp.reset(&mut rst, &mut delay).unwrap();
disp.init().unwrap();
disp.flush().unwrap();
let (w, h) = disp.dimensions();
let bmp =
Bmp::from_slice(include_bytes!("./rust-pride.bmp")).expect("Failed to load BMP image");
let im: Image> = Image::new(&bmp, Point::zero());
// Position image in the center of the display
let moved = im.translate(Point::new(
(w as u32 - bmp.size().width) as i32 / 2,
(h as u32 - bmp.size().height) as i32 / 2,
));
moved.draw(&mut disp).unwrap();
disp.flush().unwrap();
loop {}
}
#[exception]
fn HardFault(ef: &ExceptionFrame) -> ! {
panic!("{:#?}", ef);
}
```
## Migrating from 0.1 to 0.2
The full changelog can be found [here](CHANGELOG.md). A tl;dr version is shown below.
Version 0.1.x
```rust
use ssd1331::{prelude::*, Builder};
let mut disp: GraphicsMode<_> = Builder::new().connect_spi(spi, dc).into();
disp.reset(&mut rst, &mut delay);
disp.init().unwrap();
disp.flush().unwrap();
disp.get_dimensions();
disp.get_rotation();
```
Version 0.2.x
```rust
use ssd1331::{Ssd1331, DisplayRotation};
let mut disp = Ssd1331::new(spi, dc, DisplayRotation::Rotate0);
disp.reset(&mut rst, &mut delay).unwrap();
disp.init().unwrap();
disp.flush().unwrap();
disp.dimensions();
disp.rotation();
```
## License
Licensed under either of
- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or
http://www.apache.org/licenses/LICENSE-2.0)
- MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
at your option.
### Contribution
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the
work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any
additional terms or conditions.