summaryrefslogtreecommitdiff
path: root/apps/examples/README.txt
diff options
context:
space:
mode:
authorpatacongo <patacongo@42af7a65-404d-4744-a932-0658087f49c3>2011-12-14 23:37:38 +0000
committerpatacongo <patacongo@42af7a65-404d-4744-a932-0658087f49c3>2011-12-14 23:37:38 +0000
commit5ad562aaa8fff477e9298d04d3d33f09c153a234 (patch)
tree8586fa80696d3c3d8df3e97a97159e75105c6169 /apps/examples/README.txt
parent1900b1701956566b5ce2b917001a68dc9c53c349 (diff)
downloadnuttx-5ad562aaa8fff477e9298d04d3d33f09c153a234.tar.gz
nuttx-5ad562aaa8fff477e9298d04d3d33f09c153a234.tar.bz2
nuttx-5ad562aaa8fff477e9298d04d3d33f09c153a234.zip
Add a framework for an ADC test
git-svn-id: svn://svn.code.sf.net/p/nuttx/code/trunk@4180 42af7a65-404d-4744-a932-0658087f49c3
Diffstat (limited to 'apps/examples/README.txt')
-rw-r--r--apps/examples/README.txt17
1 files changed, 17 insertions, 0 deletions
diff --git a/apps/examples/README.txt b/apps/examples/README.txt
index fee9e66a5..63b0a0223 100644
--- a/apps/examples/README.txt
+++ b/apps/examples/README.txt
@@ -30,6 +30,23 @@ examples
the specific example. See the following for examples that
support this option).
+examples/adc
+^^^^^^^^^^^^
+
+ A mindlessly simple test of an ADC devices. It simply reads from the
+ ADC device and dumps the data to the console forever.
+
+ - CONFIG_NSH_BUILTIN_APPS - Build the ADC test as an NSH built-in function.
+ Default: Built as a standalone problem
+ - CONFIG_EXAMPLES_ADC_DEVPATH - The path to the ADC device. Default: /dev/adc0
+ - CONFIG_EXAMPLES_ADC_NSAMPLES - If CONFIG_NSH_BUILTIN_APPS
+ is defined, then the number of samples is provided on the command line
+ and this value is ignored. Otherwise, this number of samples is
+ collected and the program terminates. Default: Samples are collected
+ indefinitely.
+ - CONFIG_EXAMPLES_ADC_SAMPLESIZE - The number of bytes to read in one sample.
+ Default: 8
+
examples/buttons
^^^^^^^^^^^^^^^^