1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444
//! SSD1306 OLED display driver.
//!
//! This crate provides a driver interface to the popular SSD1306 monochrome OLED display driver. It
//! supports I2C and SPI via the [`display_interface`](https://docs.rs/display_interface) crate.
//!
//! The main driver is created using [`Ssd1306::new`] which accepts an interface instance, display
//! size, rotation and mode. The following display modes are supported:
//!
//! - [`BasicMode`](crate::mode::BasicMode) - A simple mode with lower level methods available.
//! - [`BufferedGraphicsMode`] - A framebuffered mode with additional methods and integration with
//! [embedded-graphics](https://docs.rs/embedded-graphics).
//! - [`TerminalMode`] - A bufferless mode supporting drawing text to the display, as well as
//! setting cursor positions like a simple terminal.
//!
//! # Examples
//!
//! Examples can be found in [the examples/
//! folder](https://github.com/jamwaffles/ssd1306/blob/master/examples)
//!
//! ## Draw some text to the display
//!
//! Uses [`BufferedGraphicsMode`] and [embedded_graphics](https://docs.rs/embedded-graphics). [See
//! the complete example
//! here](https://github.com/jamwaffles/ssd1306/blob/master/examples/text_i2c.rs).
//!
//! ```rust
//! # use ssd1306::test_helpers::I2cStub;
//! # let i2c = I2cStub;
//! use embedded_graphics::{
//! mono_font::{ascii::FONT_6X10, MonoTextStyleBuilder},
//! pixelcolor::BinaryColor,
//! prelude::*,
//! text::{Baseline, Text},
//! };
//! use ssd1306::{mode::BufferedGraphicsMode, prelude::*, I2CDisplayInterface, Ssd1306};
//!
//! let interface = I2CDisplayInterface::new(i2c);
//! let mut display = Ssd1306::new(
//! interface,
//! DisplaySize128x64,
//! DisplayRotation::Rotate0,
//! ).into_buffered_graphics_mode();
//! display.init().unwrap();
//!
//! let text_style = MonoTextStyleBuilder::new()
//! .font(&FONT_6X10)
//! .text_color(BinaryColor::On)
//! .build();
//!
//! Text::with_baseline("Hello world!", Point::zero(), text_style, Baseline::Top)
//! .draw(&mut display)
//! .unwrap();
//!
//! Text::with_baseline("Hello Rust!", Point::new(0, 16), text_style, Baseline::Top)
//! .draw(&mut display)
//! .unwrap();
//!
//! display.flush().unwrap();
//! ```
//!
//! ## Write text to the display without a framebuffer
//!
//! Uses [`TerminalMode`]. [See the complete example
//! here](https://github.com/jamwaffles/ssd1306/blob/master/examples/terminal_i2c.rs).
//!
//! ```rust
//! # use ssd1306::test_helpers::I2cStub;
//! # let i2c = I2cStub;
//! use core::fmt::Write;
//! use ssd1306::{mode::TerminalMode, prelude::*, I2CDisplayInterface, Ssd1306};
//!
//! let interface = I2CDisplayInterface::new(i2c);
//!
//! let mut display = Ssd1306::new(
//! interface,
//! DisplaySize128x64,
//! DisplayRotation::Rotate0,
//! ).into_terminal_mode();
//! display.init().unwrap();
//! display.clear().unwrap();
//!
//! // Spam some characters to the display
//! for c in 97..123 {
//! let _ = display.write_str(unsafe { core::str::from_utf8_unchecked(&[c]) });
//! }
//! for c in 65..91 {
//! let _ = display.write_str(unsafe { core::str::from_utf8_unchecked(&[c]) });
//! }
//!
//! // The `write!()` macro is also supported
//! write!(display, "Hello, {}", "world");
//! ```
//!
//! [featureset]: https://github.com/jamwaffles/embedded-graphics#features
//! [`BufferedGraphicsMode`]: crate::mode::BufferedGraphicsMode
//! [`TerminalMode`]: crate::mode::TerminalMode
#![no_std]
#![deny(missing_debug_implementations)]
#![deny(missing_docs)]
#![deny(warnings)]
#![deny(missing_copy_implementations)]
#![deny(trivial_casts)]
#![deny(trivial_numeric_casts)]
#![deny(unsafe_code)]
#![deny(unstable_features)]
#![deny(unused_import_braces)]
#![deny(unused_qualifications)]
#![deny(rustdoc::broken_intra_doc_links)]
mod brightness;
pub mod command;
mod error;
mod i2c_interface;
pub mod mode;
pub mod prelude;
pub mod rotation;
pub mod size;
#[doc(hidden)]
pub mod test_helpers;
use core::convert::Infallible;
pub use crate::i2c_interface::I2CDisplayInterface;
use crate::mode::BasicMode;
use brightness::Brightness;
use command::{AddrMode, Command, VcomhLevel};
use display_interface::{DataFormat::U8, DisplayError, WriteOnlyDataCommand};
use embedded_hal::{blocking::delay::DelayMs, digital::v2::OutputPin};
use error::Error;
use mode::{BufferedGraphicsMode, TerminalMode};
use rotation::DisplayRotation;
use size::DisplaySize;
/// SSD1306 driver.
///
/// Note that some methods are only available when the display is configured in a certain [`mode`].
#[derive(Copy, Clone, Debug)]
pub struct Ssd1306<DI, SIZE, MODE> {
interface: DI,
mode: MODE,
size: SIZE,
addr_mode: AddrMode,
rotation: DisplayRotation,
}
impl<DI, SIZE> Ssd1306<DI, SIZE, BasicMode>
where
DI: WriteOnlyDataCommand,
SIZE: DisplaySize,
{
/// Create a basic SSD1306 interface.
///
/// Use the `into_*_mode` methods to enable more functionality.
pub fn new(interface: DI, size: SIZE, rotation: DisplayRotation) -> Self {
Self {
interface,
size,
addr_mode: AddrMode::Page,
mode: BasicMode,
rotation,
}
}
}
impl<DI, SIZE, MODE> Ssd1306<DI, SIZE, MODE>
where
DI: WriteOnlyDataCommand,
SIZE: DisplaySize,
{
/// Convert the display into another interface mode.
fn into_mode<MODE2>(self, mode: MODE2) -> Ssd1306<DI, SIZE, MODE2> {
Ssd1306 {
mode,
addr_mode: self.addr_mode,
interface: self.interface,
size: self.size,
rotation: self.rotation,
}
}
/// Convert the display into a buffered graphics mode, supporting
/// [embedded-graphics](https://crates.io/crates/embedded-graphics).
///
/// See [BufferedGraphicsMode] for more information.
pub fn into_buffered_graphics_mode(self) -> Ssd1306<DI, SIZE, BufferedGraphicsMode<SIZE>> {
self.into_mode(BufferedGraphicsMode::new())
}
/// Convert the display into a text-only, terminal-like mode.
///
/// See [TerminalMode] for more information.
pub fn into_terminal_mode(self) -> Ssd1306<DI, SIZE, TerminalMode> {
self.into_mode(TerminalMode::new())
}
/// Initialise the display in one of the available addressing modes.
pub fn init_with_addr_mode(&mut self, mode: AddrMode) -> Result<(), DisplayError> {
let rotation = self.rotation;
Command::DisplayOn(false).send(&mut self.interface)?;
Command::DisplayClockDiv(0x8, 0x0).send(&mut self.interface)?;
Command::Multiplex(SIZE::HEIGHT - 1).send(&mut self.interface)?;
Command::DisplayOffset(0).send(&mut self.interface)?;
Command::StartLine(0).send(&mut self.interface)?;
// TODO: Ability to turn charge pump on/off
Command::ChargePump(true).send(&mut self.interface)?;
Command::AddressMode(mode).send(&mut self.interface)?;
self.size.configure(&mut self.interface)?;
self.set_rotation(rotation)?;
self.set_brightness(Brightness::default())?;
Command::VcomhDeselect(VcomhLevel::Auto).send(&mut self.interface)?;
Command::AllOn(false).send(&mut self.interface)?;
Command::Invert(false).send(&mut self.interface)?;
Command::EnableScroll(false).send(&mut self.interface)?;
Command::DisplayOn(true).send(&mut self.interface)?;
self.addr_mode = mode;
Ok(())
}
/// Change the addressing mode
pub fn set_addr_mode(&mut self, mode: AddrMode) -> Result<(), DisplayError> {
Command::AddressMode(mode).send(&mut self.interface)?;
self.addr_mode = mode;
Ok(())
}
/// Send the data to the display for drawing at the current position in the framebuffer
/// and advance the position accordingly. Cf. `set_draw_area` to modify the affected area by
/// this method.
///
/// This method takes advantage of a bounding box for faster writes.
pub fn bounded_draw(
&mut self,
buffer: &[u8],
disp_width: usize,
upper_left: (u8, u8),
lower_right: (u8, u8),
) -> Result<(), DisplayError> {
Self::flush_buffer_chunks(
&mut self.interface,
buffer,
disp_width,
upper_left,
lower_right,
)
}
/// Send a raw buffer to the display.
pub fn draw(&mut self, buffer: &[u8]) -> Result<(), DisplayError> {
self.interface.send_data(U8(&buffer))
}
/// Get display dimensions, taking into account the current rotation of the display
///
/// ```rust
/// # use ssd1306::test_helpers::StubInterface;
/// # let interface = StubInterface;
/// use ssd1306::{mode::TerminalMode, prelude::*, Ssd1306};
///
/// let mut display = Ssd1306::new(
/// interface,
/// DisplaySize128x64,
/// DisplayRotation::Rotate0,
/// ).into_terminal_mode();
/// assert_eq!(display.dimensions(), (128, 64));
///
/// # let interface = StubInterface;
/// let mut rotated_display = Ssd1306::new(
/// interface,
/// DisplaySize128x64,
/// DisplayRotation::Rotate90,
/// ).into_terminal_mode();
/// assert_eq!(rotated_display.dimensions(), (64, 128));
/// ```
pub fn dimensions(&self) -> (u8, u8) {
match self.rotation {
DisplayRotation::Rotate0 | DisplayRotation::Rotate180 => (SIZE::WIDTH, SIZE::HEIGHT),
DisplayRotation::Rotate90 | DisplayRotation::Rotate270 => (SIZE::HEIGHT, SIZE::WIDTH),
}
}
/// Get the display rotation.
pub fn rotation(&self) -> DisplayRotation {
self.rotation
}
/// Set the display rotation.
pub fn set_rotation(&mut self, rotation: DisplayRotation) -> Result<(), DisplayError> {
self.rotation = rotation;
match rotation {
DisplayRotation::Rotate0 => {
Command::SegmentRemap(true).send(&mut self.interface)?;
Command::ReverseComDir(true).send(&mut self.interface)?;
}
DisplayRotation::Rotate90 => {
Command::SegmentRemap(false).send(&mut self.interface)?;
Command::ReverseComDir(true).send(&mut self.interface)?;
}
DisplayRotation::Rotate180 => {
Command::SegmentRemap(false).send(&mut self.interface)?;
Command::ReverseComDir(false).send(&mut self.interface)?;
}
DisplayRotation::Rotate270 => {
Command::SegmentRemap(true).send(&mut self.interface)?;
Command::ReverseComDir(false).send(&mut self.interface)?;
}
};
Ok(())
}
/// Set mirror enabled/disabled.
pub fn set_mirror(&mut self, mirror: bool) -> Result<(), DisplayError> {
if mirror {
match self.rotation {
DisplayRotation::Rotate0 => {
Command::SegmentRemap(false).send(&mut self.interface)?;
Command::ReverseComDir(true).send(&mut self.interface)?;
}
DisplayRotation::Rotate90 => {
Command::SegmentRemap(false).send(&mut self.interface)?;
Command::ReverseComDir(false).send(&mut self.interface)?;
}
DisplayRotation::Rotate180 => {
Command::SegmentRemap(true).send(&mut self.interface)?;
Command::ReverseComDir(false).send(&mut self.interface)?;
}
DisplayRotation::Rotate270 => {
Command::SegmentRemap(true).send(&mut self.interface)?;
Command::ReverseComDir(true).send(&mut self.interface)?;
}
};
} else {
self.set_rotation(self.rotation)?;
}
Ok(())
}
/// Change the display brightness.
pub fn set_brightness(&mut self, brightness: Brightness) -> Result<(), DisplayError> {
Command::PreChargePeriod(1, brightness.precharge).send(&mut self.interface)?;
Command::Contrast(brightness.contrast).send(&mut self.interface)
}
/// Turn the display on or off. The display can be drawn to and retains all
/// of its memory even while off.
pub fn set_display_on(&mut self, on: bool) -> Result<(), DisplayError> {
Command::DisplayOn(on).send(&mut self.interface)
}
/// Set the position in the framebuffer of the display limiting where any sent data should be
/// drawn. This method can be used for changing the affected area on the screen as well
/// as (re-)setting the start point of the next `draw` call.
pub fn set_draw_area(&mut self, start: (u8, u8), end: (u8, u8)) -> Result<(), DisplayError> {
Command::ColumnAddress(start.0, end.0.saturating_sub(1)).send(&mut self.interface)?;
if self.addr_mode != AddrMode::Page {
Command::PageAddress(start.1.into(), (end.1.saturating_sub(1)).into())
.send(&mut self.interface)?;
}
Ok(())
}
/// Set the column address in the framebuffer of the display where any sent data should be
/// drawn.
pub fn set_column(&mut self, column: u8) -> Result<(), DisplayError> {
Command::ColStart(column).send(&mut self.interface)
}
/// Set the page address (row 8px high) in the framebuffer of the display where any sent data
/// should be drawn.
///
/// Note that the parameter is in pixels, but the page will be set to the start of the 8px
/// row which contains the passed-in row.
pub fn set_row(&mut self, row: u8) -> Result<(), DisplayError> {
Command::PageStart(row.into()).send(&mut self.interface)
}
/// Set the screen pixel on/off inversion
pub fn set_invert(&mut self, invert: bool) -> Result<(), DisplayError> {
Command::Invert(invert).send(&mut self.interface)
}
fn flush_buffer_chunks(
interface: &mut DI,
buffer: &[u8],
disp_width: usize,
upper_left: (u8, u8),
lower_right: (u8, u8),
) -> Result<(), DisplayError> {
// Divide by 8 since each row is actually 8 pixels tall
let num_pages = ((lower_right.1 - upper_left.1) / 8) as usize + 1;
// Each page is 8 bits tall, so calculate which page number to start at (rounded down) from
// the top of the display
let starting_page = (upper_left.1 / 8) as usize;
// Calculate start and end X coordinates for each page
let page_lower = upper_left.0 as usize;
let page_upper = lower_right.0 as usize;
buffer
.chunks(disp_width)
.skip(starting_page)
.take(num_pages)
.map(|s| &s[page_lower..page_upper])
.try_for_each(|c| interface.send_data(U8(&c)))
}
}
// SPI-only reset
impl<DI, SIZE, MODE> Ssd1306<DI, SIZE, MODE> {
/// Reset the display.
pub fn reset<RST, DELAY>(
&mut self,
rst: &mut RST,
delay: &mut DELAY,
) -> Result<(), Error<Infallible, RST::Error>>
where
RST: OutputPin,
DELAY: DelayMs<u8>,
{
fn inner_reset<RST, DELAY>(rst: &mut RST, delay: &mut DELAY) -> Result<(), RST::Error>
where
RST: OutputPin,
DELAY: DelayMs<u8>,
{
rst.set_high()?;
delay.delay_ms(1);
rst.set_low()?;
delay.delay_ms(10);
rst.set_high()
}
inner_reset(rst, delay).map_err(Error::Pin)
}
}