summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDiego Barrios Romero <eldruin@gmail.com>2018-11-21 08:22:01 +0100
committerDiego Barrios Romero <eldruin@gmail.com>2018-11-21 08:22:01 +0100
commit0e48c4d004ed3f5e13bafccb145269ef63d75009 (patch)
tree0c92645ad29569418d93a729d01137837c22e626
parent2dec94ba529111e396c8b8c2b49de48084826eba (diff)
downloadads1x1x-async-0e48c4d004ed3f5e13bafccb145269ef63d75009.tar.gz
ads1x1x-async-0e48c4d004ed3f5e13bafccb145269ef63d75009.tar.xz
ads1x1x-async-0e48c4d004ed3f5e13bafccb145269ef63d75009.zip
Reorganize driver capabilities
-rw-r--r--README.md13
-rw-r--r--src/lib.rs13
2 files changed, 14 insertions, 12 deletions
diff --git a/README.md b/README.md
index 90b6d6d..fb8a7c6 100644
--- a/README.md
+++ b/README.md
@@ -20,13 +20,14 @@ This driver allows you to:
- Set the data rate. See: `set_data_rate()`.
- Set the full-scale range (gain amplifier). See `set_full_scale_range()`.
- Read whether a measurement is in progress. See: `is_measurement_in_progress()`.
-- Set the low and high thresholds. See: `set_high_threshold_raw()`.
-- Set the comparator mode. See: `set_comparator_mode()`.
-- Set the comparator polarity. See: `set_comparator_polarity()`.
-- Set the comparator latching. See: `set_comparator_latching()`.
-- Set the comparator queue. See: `set_comparator_queue()`.
-- Disable the comparator. See: `disable_comparator()`.
- Set the ALERT/RDY pin to be used as conversion-ready pin. See: `use_alert_rdy_pin_as_ready()`.
+- Comparator:
+ - Set the low and high thresholds. See: `set_high_threshold_raw()`.
+ - Set the comparator mode. See: `set_comparator_mode()`.
+ - Set the comparator polarity. See: `set_comparator_polarity()`.
+ - Set the comparator latching. See: `set_comparator_latching()`.
+ - Set the comparator queue. See: `set_comparator_queue()`.
+ - Disable the comparator. See: `disable_comparator()`.
## The devices
diff --git a/src/lib.rs b/src/lib.rs
index 9491baa..71cc35b 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -11,14 +11,15 @@
//! - Read the last measurement made in continuous conversion mode. See: [`read()`][read_cont].
//! - Set the data rate. See: [`set_data_rate()`].
//! - Set the full-scale range (gain amplifier). See [`set_full_scale_range()`].
-//! - Set the low and high thresholds. See: [`set_high_threshold_raw()`].
//! - Read whether a measurement is in progress. See: [`is_measurement_in_progress()`].
-//! - Set the comparator mode. See: [`set_comparator_mode()`].
-//! - Set the comparator polarity. See: [`set_comparator_polarity()`].
-//! - Set the comparator latching. See: [`set_comparator_latching()`].
-//! - Set the comparator queue. See: [`set_comparator_queue()`].
-//! - Disable the comparator. See: [`disable_comparator()`].
//! - Set the ALERT/RDY pin to be used as conversion-ready pin. See: [`use_alert_rdy_pin_as_ready()`].
+//! - Comparator:
+//! - Set the low and high thresholds. See: [`set_high_threshold_raw()`].
+//! - Set the comparator mode. See: [`set_comparator_mode()`].
+//! - Set the comparator polarity. See: [`set_comparator_polarity()`].
+//! - Set the comparator latching. See: [`set_comparator_latching()`].
+//! - Set the comparator queue. See: [`set_comparator_queue()`].
+//! - Disable the comparator. See: [`disable_comparator()`].
//!
//! [`into_continuous()`]: struct.Ads1x1x.html#method.into_continuous
//! [read_os]: struct.Ads1x1x.html#method.read