rust/va416xx-rs
6
0
Fork 0
Code Issues Pull Requests Projects Releases 5 Wiki Activity

README and docs update

Browse Source
This commit is contained in:
Robin Müller 2024-10-01 10:53:16 +02:00
parent 22cc40c095
commit 4af9aabdf4
Signed by: muellerr
GPG Key ID: A649FB78196E3849
2 changed files with 10 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
vorago-peb1/README.md
View File

@ -1,15 +1,12 @@
[![Crates.io](https://img.shields.io/crates/v/vorago-peb1)](https://crates.io/crates/vorago-peb1)
[![docs.rs](https://img.shields.io/docsrs/vorago-peb1)](https://docs.rs/vorago-peb1)
# Rust BSP for the Vorago PEB1 development board # Rust BSP for the Vorago PEB1 development board
## Using the `.cargo/config.toml` file This is the Rust **B**oard **S**upport **P**ackage crate for the Vorago PEB1 development board.
Its aim is to provide drivers for the board features of the PEB1 board.
Use the following command to have a starting `config.toml` file The BSP builds on top of the [HAL crate for VA416xx devices](https://egit.irs.uni-stuttgart.de/rust/va416xx-rs/src/branch/main/va416xx-hal).
```sh
cp .cargo/def-config.toml .cargo/config.toml
```
You then can adapt the `config.toml` to your needs. For example, you can configure runners
to conveniently flash with `cargo run`.
## Notes on board revisions ## Notes on board revisions

4
vorago-peb1/src/lib.rs
View File

@ -5,6 +5,10 @@
pub use lis2dh12; pub use lis2dh12;
/// Support for the LIS2DH12 accelerometer on the GPIO board. /// Support for the LIS2DH12 accelerometer on the GPIO board.
///
/// # Example
///
/// - [PEB1 Accelerometer](https://egit.irs.uni-stuttgart.de/rust/va416xx-rs/src/branch/main/examples/simple/examples/peb1-accelerometer.rs)
pub mod accelerometer { pub mod accelerometer {
use lis2dh12::{self, detect_i2c_addr, AddrDetectionError, Lis2dh12}; use lis2dh12::{self, detect_i2c_addr, AddrDetectionError, Lis2dh12};