summaryrefslogtreecommitdiffstats
path: root/README.md
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 /README.md
parent6e7b9558cf6d586f67e509efc157b7d41751ac26 (diff)
downloadads1x1x-async-df8e200554dadee3f4addc887f775be03b7467cf.tar.gz
ads1x1x-async-df8e200554dadee3f4addc887f775be03b7467cf.tar.xz
ads1x1x-async-df8e200554dadee3f4addc887f775be03b7467cf.zip
Document current driver capabilities
Diffstat (limited to 'README.md')
-rw-r--r--README.md6
1 files changed, 5 insertions, 1 deletions
diff --git a/README.md b/README.md
index 73b7c2e..1acc6d6 100644
--- a/README.md
+++ b/README.md
@@ -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