From a31ec76eafbcce1ea2593d0578490653b7fb003d Mon Sep 17 00:00:00 2001 From: Diego Barrios Romero Date: Tue, 20 Nov 2018 19:49:39 +0100 Subject: Update documentation of driver capabilities --- README.md | 2 ++ src/lib.rs | 8 ++++++-- 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index ca996c1..086cf6c 100644 --- a/README.md +++ b/README.md @@ -15,6 +15,8 @@ analog-to-digital converters (ADC), based on the [`embedded-hal`] traits. 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()`. +- Start continuous conversion mode. See: `start()`. +- Read the last measurement made in continuous conversion mode. See: `read()`. - 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()`. diff --git a/src/lib.rs b/src/lib.rs index b825546..30ad6a8 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -6,7 +6,9 @@ //! //! 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()`]. +//! - Make a measurement in one-shot mode. See: [`read()`][read_os]. +//! - Start continuous conversion mode. See: [`start()`]. +//! - 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()`]. @@ -17,7 +19,9 @@ //! - Disable the comparator. See: [`disable_comparator()`]. //! //! [`into_continuous()`]: struct.Ads1x1x.html#method.into_continuous -//! [`read()`]: struct.Ads1x1x.html#method.read +//! [read_os]: struct.Ads1x1x.html#method.read +//! [`start()`]: struct.Ads1x1x.html#method.read +//! [read_cont]: struct.Ads1x1x.html#impl-OneShot%3CAds1x1x%3CDI%2C%20IC%2C%20CONV%2C%20OneShot%3E%2C%20i16%2C%20CH%3E //! [`set_data_rate()`]: struct.Ads1x1x.html#method.set_data_rate //! [`set_full_scale_range()`]: struct.Ads1x1x.html#method.set_full_scale_range //! [`set_high_threshold_raw()`]: struct.Ads1x1x.html#method.set_high_threshold_raw -- cgit v1.2.3-54-g00ecf