Add QE support to STM32F4Discovery; add a test of the quadrature encoder driver

git-svn-id: svn://svn.code.sf.net/p/nuttx/code/trunk@4395 42af7a65-404d-4744-a932-0658087f49c3

1 files changed, 27 insertions, 0 deletions

diff --git a/apps/examples/README.txt b/apps/examples/README.txt
index d598180e5..eeb05562d 100644
--- a/apps/examples/README.txt
+++ b/apps/examples/README.txt
@@ -906,6 +906,33 @@ examples/pwm
        only available if CONFIG_PWM_PULSECOUNT is defined. Default: 0 (i.e., use
        the duration, not the count).
 
+examples/qencoder
+^^^^^^^^^^^^^^^^^
+
+  This example is a simple test of a Quadrature Encoder driver.  It simply reads
+  positional data from the encoder and prints it.,
+
+  This test depends on these specific QE/NSH configurations settings (your
+  specific PWM settings might require additional settings).
+
+    CONFIG_QENCODER - Enables quadrature encoder support (upper-half driver).
+    CONFIG_NSH_BUILTIN_APPS - Build the QE test as an NSH built-in function.
+      Default: Built as a standalone progrem.
+
+  Additional configuration options will mostly likely be required for the board-
+  specific lower-half driver.  See the README.txt file in your board configuration
+  directory.
+
+  Specific configuration options for this example include:
+ 
+  CONFIG_EXAMPLES_QENCODER_DEVPATH - The path to the QE device. Default:
+    /dev/qe0
+  CONFIG_EXAMPLES_QENCODER_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.
+
 examples/rgmp
 ^^^^^^^^^^^^^