summaryrefslogtreecommitdiffstats
path: root/src/lib.rs
diff options
context:
space:
mode:
authorDiego Barrios Romero <eldruin@gmail.com>2018-11-08 19:18:54 +0100
committerDiego Barrios Romero <eldruin@gmail.com>2018-11-08 19:18:54 +0100
commitdf8e200554dadee3f4addc887f775be03b7467cf (patch)
tree0fc4c588eceebe86e0e014de609659b864e424fd /src/lib.rs
parent6e7b9558cf6d586f67e509efc157b7d41751ac26 (diff)
downloadads1x1x-async-df8e200554dadee3f4addc887f775be03b7467cf.tar.gz
ads1x1x-async-df8e200554dadee3f4addc887f775be03b7467cf.tar.xz
ads1x1x-async-df8e200554dadee3f4addc887f775be03b7467cf.zip
Document current driver capabilities
Diffstat (limited to 'src/lib.rs')
-rw-r--r--src/lib.rs8
1 files changed, 8 insertions, 0 deletions
diff --git a/src/lib.rs b/src/lib.rs
index f7fc67f..21b63c5 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -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
//!