Lib.rs

Raspberry Pi Waveshare OLED (SH1106) HAT Driver Written in Rust

Device (Front)	Device (Back)	Device (Powered)

Device: https://www.waveshare.com/wiki/1.3inch_OLED_HAT

Usage

cargo add ws-oled-driver

-- or --

[dependencies]
ws-oled-driver = "0.0.5"

Cross Compiling for Raspberry Pi Zero

  cargo build --target arm-unknown-linux-gnueabihf --release 

Examples

Display

NOTE: THE ws_oled_driver::gfx library is a work in progress. Since there is direct access available to the Display { memory: Vec<u8> } field, which is the display buffer, you may directly modify the buffer to create visuals and use the display.render()? function to render it to the display.

use ws_oled_driver::Device;  /* HAT Device */
use ws_oled_driver::gfx;     /* Graphics */
use anyhow::Result;

fn main() -> Result<()> {
   let mut device = Device::new()?;
   device.initialize_components()?;

   /* FILL DISPLAY */
   gfx::fill(&mut device.display, 0xFF);
   device.display.render()?; 

   /* DRAW POINT at (x, y) == (10, 10) */
   gfx::draw_point(&mut device.display, (10, 10), 0xFF);

   /* DRAW LINE */

   gfx::draw_line(&mut device.display, (0, 0), (127, 63));
   device.display.render()?; 

   Ok(())
}

Joystick

use anyhow::Result;
use ws_oled_driver::joystick;
use ws_oled_driver::Device; /* HAT Device */

fn main() -> Result<()> {
    let mut device = Device::new()?;
    device.initialize_components()?;

    loop {
        if let Some(joystick_state) = device.joystick.read() {
            match joystick_state {
                joystick::State::Up => {
                    println!("You Pressed Up");
                }
                joystick::State::Down => {
                    println!("You Pressed Down");
                }
                joystick::State::Left => {
                    println!("You Pressed Left");
                }
                joystick::State::Right => {
                    println!("You Pressed Right");
                }
                joystick::State::Click => {
                    println!("You Clicked!");
                }
            }
        }
    }
}

Buttons

use ws_oled_driver::Device;  /* HAT Device */
use ws_oled_driver::button::State;
use anyhow::Result;

fn main() -> Result<()> {
  let mut device = Device::new()?;
  device.initialize_components()?;

  loop {
    if let Some(button_state) = device.button_controller.read() {
      match button_state {
        State::Key1 => println!("Key1 pressed"),
        State::Key2 => println!("Key2 pressed"),
        State::Key3 => println!("Key3 pressed"),
      }
    }
    else {
      println!("Nothing Pressed!")
    }
  }
}

Roadmap

1. Improve Graphics Library