rust/max116xx-10bit
6
0
Fork 0
Code Issues Pull Requests Projects Releases 4 Wiki Activity

Merge remote-tracking branch 'origin/main' into simplified-api
All checks were successful
Rust/max116xx-10bit/pipeline/head This commit looks good
Details
Rust/max116xx-10bit/pipeline/pr-main This commit looks good
Details

Browse Source
This commit is contained in:
Robin Müller 2021-12-14 14:06:07 +01:00
commit 6b416f5684
No known key found for this signature in database
GPG Key ID: 71B58F8A3CDFA9AC
4 changed files with 16 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
CHANGELOG.md
View File

@ -22,6 +22,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
- Improved documentation - Improved documentation
- Made library easier to use - Made library easier to use
## [v0.1.1]
- Added badges and some documentation and README tweaks
## [v0.1.0] ## [v0.1.0]
- Initial release - Initial release

2
Cargo.toml
View File

@ -1,6 +1,6 @@
[package] [package]
name = "max116xx-10bit" name = "max116xx-10bit"
version = "0.1.0" version = "0.1.1"
authors = ["Robin Mueller <muellerr@irs.uni-stuttgart.de>"] authors = ["Robin Mueller <muellerr@irs.uni-stuttgart.de>"]
edition = "2021" edition = "2021"
description = "Driver crate for the MAX116xx 10-bit ADC devices" description = "Driver crate for the MAX116xx 10-bit ADC devices"

7
README.md
View File

@ -1,3 +1,7 @@
[![Crates.io](https://img.shields.io/crates/v/max116xx-10bit)](https://crates.io/crates/max116xx-10bit)
[![build](https://github.com/us-irs/max116xx-10bit-rs/actions/workflows/ci.yml/badge.svg)](https://github.com/us-irs/max116xx-10bit-rs/actions/workflows/ci.yml)
[![docs.rs](https://img.shields.io/docsrs/max116xx-10bit)](https://docs.rs/max116xx-10bit)
Rust Maxim 116xx 10-bit ADC device driver crate Rust Maxim 116xx 10-bit ADC device driver crate
======== ========
@ -22,4 +26,5 @@ The crate uses basic type-level support to prevent using the ADC in a wrong way.
The type-level support defaults to an externally clocked device with no wake-up delay. The type-level support defaults to an externally clocked device with no wake-up delay.
This crate was tested using the Vorago REB1 development board. You can find an example application This crate was tested using the Vorago REB1 development board. You can find an example application
[here](https://egit.irs.uni-stuttgart.de/rust/vorago-reb1). [here](https://egit.irs.uni-stuttgart.de/rust/vorago-reb1/src/branch/main/src/max11619.rs)
and [here](https://egit.irs.uni-stuttgart.de/rust/vorago-reb1/src/branch/main/examples/max11619-adc.rs).

5
src/lib.rs
View File

@ -15,6 +15,11 @@
//! - [`Max116xx10Bit::into_ext_clkd_with_int_ref_wakeup_delay`] //! - [`Max116xx10Bit::into_ext_clkd_with_int_ref_wakeup_delay`]
//! - [`Max116xx10Bit::into_int_clkd_int_timed_through_ser_if_with_wakeup`] //! - [`Max116xx10Bit::into_int_clkd_int_timed_through_ser_if_with_wakeup`]
//! - [`Max116xx10Bit::into_int_clkd_int_timed_through_ser_if_without_wakeup`] //! - [`Max116xx10Bit::into_int_clkd_int_timed_through_ser_if_without_wakeup`]
//!
//! ## Examples
//!
//! You can find an example application [here](https://egit.irs.uni-stuttgart.de/rust/vorago-reb1/src/branch/main/examples/max11619-adc.rs)
//! using a [thin abstraction layer](https://egit.irs.uni-stuttgart.de/rust/vorago-reb1/src/branch/main/src/max11619.rs)
#![no_std] #![no_std]
use core::{marker::PhantomData, slice::IterMut}; use core::{marker::PhantomData, slice::IterMut};
use embedded_hal::{ use embedded_hal::{