Skip to content

Latest commit

 

History

History
75 lines (50 loc) · 2.06 KB

README.md

File metadata and controls

75 lines (50 loc) · 2.06 KB

Build Status Latest Version Latest Docs

picoborgrev

This module is designed to communicate with the PicoBorg Reverse via Rust and the embedded-hal traits.

See the PiBorg website at www.piborg.org/picoborgreverse for more details on the PicoBorgRev board.

Important: This is still a work in progress and the API should not be considered stable until the 1.0 release.

Usage

The first step is to add picoborgrev to your cargo.toml file:

[dependencies]
picoborgrev = "0.1"

Then in your module you then need to import the crate:

extern crate picoborgrev;

use picoborgrev::PicoBorgRev;

To create a new PicoBorgRev controller you will need to supply an embedded-hal implementation such as linux-embedded-hal:

extern crate linux_embedded_hal;

use linux_embedded_hal::I2cdev;
use std::path::Path;

let device = I2cdev::new(Path::new("/dev/i2c-1")).expect("Unable to create i2c device");

Finally create a new PicoBorgRev supplying the I2C implementation:

let mut borg = PicoBorgRev::new(device).expect("Unable to create PicoBorgRev");
borg.set_led(true).unwrap();

Examples

License

Licensed under either of

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.