max116xx-10bit/README.md

1.1 KiB

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(https://github.com/rust-embedded/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.https://github.com/rust-embedded/embedded-hal 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.