Struct Device

pub struct Device {
    pub display: Display,
    pub joystick: Joystick,
    pub button_controller: ButtonController,
}

Device

the Device struct offers an organized way to access various componenets on the Waveshare OLED Display Hat. It has three fields, display, joystick and button_controller

• The display field is an instance of the Display struct that let’s you initialze and control the display
• The joystick is an instance of the Joystick struct that let’s you initalize and read input from the joystick on the device.
• The button_controller field is an instance of the ButtonController Struct that let’s you initalize and read input from the three buttons on the device

Usage

use ws_oled_driver::Device;
let mut device = Device::new()?.initialize_components()?;

Fields

display: Display

joystick: Joystick

button_controller: ButtonController

Implementations

impl Device

pub fn new() -> Result<Self>

Creates a new Device. It returns Result<Device, anyhow::Error>.

Examples found in repository

examples/display_fill.rs (line 6)

fn main() -> Result<()> {
    let mut device = Device::new()?;
    device.initialize_components()?;
    
    gfx::fill(&mut device.display, 0xFF);
    device.display.render()?;

    Ok(())
}

examples/display_line.rs (line 6)

fn main() -> Result<()> {
    let mut device = Device::new()?;
    device.initialize_components()?;
    
    gfx::draw_line(&mut device.display, (0, 0), (127, 63));
    device.display.render()?;

    Ok(())
}

examples/button_control.rs (line 6)

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!")
    }
  }
}

examples/joystick_control.rs (line 6)

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!");
                }
            }
        }
    }
}

pub fn initialize_components(&mut self) -> Result<()>

Intializes components - display, joystick & buttons.

Examples found in repository

examples/display_fill.rs (line 7)

fn main() -> Result<()> {
    let mut device = Device::new()?;
    device.initialize_components()?;
    
    gfx::fill(&mut device.display, 0xFF);
    device.display.render()?;

    Ok(())
}

examples/display_line.rs (line 7)

fn main() -> Result<()> {
    let mut device = Device::new()?;
    device.initialize_components()?;
    
    gfx::draw_line(&mut device.display, (0, 0), (127, 63));
    device.display.render()?;

    Ok(())
}

examples/button_control.rs (line 7)

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!")
    }
  }
}

examples/joystick_control.rs (line 7)

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!");
                }
            }
        }
    }
}