diff options
author | Diego Barrios Romero <eldruin@gmail.com> | 2018-11-08 19:18:54 +0100 |
---|---|---|
committer | Diego Barrios Romero <eldruin@gmail.com> | 2018-11-08 19:18:54 +0100 |
commit | df8e200554dadee3f4addc887f775be03b7467cf (patch) | |
tree | 0fc4c588eceebe86e0e014de609659b864e424fd | |
parent | 6e7b9558cf6d586f67e509efc157b7d41751ac26 (diff) | |
download | ads1x1x-async-df8e200554dadee3f4addc887f775be03b7467cf.tar.gz ads1x1x-async-df8e200554dadee3f4addc887f775be03b7467cf.tar.xz ads1x1x-async-df8e200554dadee3f4addc887f775be03b7467cf.zip |
Document current driver capabilities
-rw-r--r-- | README.md | 6 | ||||
-rw-r--r-- | src/lib.rs | 8 |
2 files changed, 13 insertions, 1 deletions
@@ -7,7 +7,11 @@ analog-to-digital converters (ADC), based on the [`embedded-hal`] traits. [`embedded-hal`]: https://github.com/rust-embedded/embedded-hal This driver allows you to: -- TODO +- Set the operating mode to one-shot or continuous. See: `into_continuous()`. +- Make a measurement in one-shot mode. See: `read()`. +- Set the data rate. See: `set_data_rate()`. +- Set the low and high thresholds. See: `set_high_threshold()`. +- Set the comparator mode. See: `set_comparator_mode()`. ## The devices @@ -6,8 +6,16 @@ //! //! This driver allows you to: //! - Set the operating mode to one-shot or continuous. See: [`into_continuous()`]. +//! - Make a measurement in one-shot mode. See: [`read()`]. +//! - Set the data rate. See: [`set_data_rate()`]. +//! - Set the low and high thresholds. See: [`set_high_threshold()`]. +//! - Set the comparator mode. See: [`set_comparator_mode()`]. //! //! [`into_continuous()`]: struct.Ads1x1x.html#method.into_continuous +//! [`read()`]: struct.Ads1x1x.html#method.read +//! [`set_data_rate()`]: struct.Ads1x1x.html#method.set_data_rate +//! [`set_high_threshold()`]: struct.Ads1x1x.html#method.set_high_threshold +//! [`set_comparator_mode()`]: struct.Ads1x1x.html#method.set_comparator_mode //! //! ## The devices //! |