RPPAL - Raspberry Pi Peripheral Access Library

RPPAL is a Rust library that provides access to the Raspberry Pi GPIO peripheral through either /dev/gpiomem or /dev/mem. Support for additional peripherals, as well as useful helper functions, will be added in future updates. The library is compatible with the BCM2835, BCM2836 and BCM2837 SoCs.

Backwards compatibility for minor revisions isn't guaranteed until the library reaches v1.0.0.

Documentation

Documentation for the latest release can be found at docs.golemparts.com/rppal. Documentation for earlier releases is stored at docs.rs/rppal.

Usage

Add a dependency for rppal to your Cargo.toml.

[dependencies]
rppal = "0.2"

Link and import rppal from your crate root.

extern crate rppal;

Call Gpio::new() to create a new Gpio instance with the default settings. In production code, you'll want to parse the result rather than unwrap it.

use rppal::gpio::Gpio;

let mut gpio = Gpio::new().unwrap();

Example

extern crate rppal;

use std::thread;
use std::time::Duration;

use rppal::gpio::{Gpio, Mode, Level};
use rppal::system::DeviceInfo;

// The GPIO module uses BCM pin numbering. BCM 18 equates to physical pin 12.
const GPIO_LED: u8 = 18;

fn main() {
    let device_info = DeviceInfo::new().unwrap();
    println!("Model: {} (SoC: {})", device_info.model(), device_info.soc());

    let mut gpio = Gpio::new().unwrap();
    gpio.set_mode(GPIO_LED, Mode::Output);

    // Blink an LED attached to the pin on and off
    gpio.write(GPIO_LED, Level::High);
    thread::sleep(Duration::from_millis(500));
    gpio.write(GPIO_LED, Level::Low);
}

Caution

Always be careful when working with the Raspberry Pi's GPIO. Improper use can lead to permanently damaging the Pi and/or external components.

Cross-compilation

Your development machine most likely will not be Raspberry Pi. In that case, you'll need to cross compile to ARM architecture in order to run your program. If you want to get more in depth information, please go to github.com/japaric/rust-cross. For easy, one step cross compilation I recommend cross project.