Rust device driver crate for the MAX116xx 10-bit ADC devices
Go to file
Robin Müller 2e011d3043
Rust/max116xx-10bit/pipeline/head There was a failure building this commit Details
added .github ci files
2021-12-12 23:47:47 +01:00
.github added .github ci files 2021-12-12 23:47:47 +01:00
automation added CI/CD files 2021-12-12 23:17:30 +01:00
src clippy fixes 2021-12-12 21:10:58 +01:00
.gitignore init commit 2021-12-12 13:16:27 +01:00
CHANGELOG.md First basic device crate done 2021-12-12 13:41:59 +01:00
Cargo.toml First basic device crate done 2021-12-12 13:41:59 +01:00
LICENSE-APACHE added license files 2021-12-12 13:23:40 +01:00
NOTICE First basic device crate done 2021-12-12 13:41:59 +01:00
README.md README fix 2021-12-12 14:53:43 +01:00

README.md

Rust Maxim 116xx 10-bit ADC device driver crate

This is a platform agnostic Rust driver for the MAX11618-MAX11621, MAX11624 and MAX11625 10-bit ADC devices which uses the embedded-hal traits.

This driver implements basic operations to read raw ADC values:

  • Read ADC values using the SPI clock as an external clock
  • Read ADC values using the End-Of-Conversion (EOC) pin

Currently, the driver only supports operation without a wake-up delay and the EOC read functionality is still limited. Pull requests to improve this are welcome.

Usage

To use this driver, import this crate and an embedded-hal implementation and then instantiate the appropriate device.

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.

This crate was tested using the Vorago REB1 development board. You can find an example application here.