summaryrefslogtreecommitdiff
path: root/apps/examples/README.txt
diff options
context:
space:
mode:
authorGregory Nutt <gnutt@nuttx.org>2014-12-03 09:34:47 -0600
committerGregory Nutt <gnutt@nuttx.org>2014-12-03 09:34:47 -0600
commit3a3b22ae3c1e31cf3659244a21afe5d8ff6b9530 (patch)
tree57c9fec97522354367472cd6034a4181364661c7 /apps/examples/README.txt
parent51d6211e82cc7ccaa4f32d87577716833647d2b2 (diff)
downloadnuttx-3a3b22ae3c1e31cf3659244a21afe5d8ff6b9530.tar.gz
nuttx-3a3b22ae3c1e31cf3659244a21afe5d8ff6b9530.tar.bz2
nuttx-3a3b22ae3c1e31cf3659244a21afe5d8ff6b9530.zip
Add an analog joystick test/example
Diffstat (limited to 'apps/examples/README.txt')
-rw-r--r--apps/examples/README.txt20
1 files changed, 19 insertions, 1 deletions
diff --git a/apps/examples/README.txt b/apps/examples/README.txt
index fa4361609..58470f313 100644
--- a/apps/examples/README.txt
+++ b/apps/examples/README.txt
@@ -48,6 +48,24 @@ examples/adc
CONFIG_EXAMPLES_ADC_GROUPSIZE - The number of samples to read at once.
Default: 4
+examples/adjoystick
+^^^^^^^^^^^^^^^^^^
+
+ This is a simple test of the analog joystick driver. See details about
+ this driver in nuttx/include/nuttx/input/adjoystick.h.
+
+ Configuration Pre-requisites:
+
+ CONFIG_DISABLE_SIGNALS - Must *NOT* be selected
+ CONFIG_AJOYSTICK - The analog joystick driver
+
+ Example Configuration:
+ CONFIG_EXAMPLES_AJOYSTICK - Enabled the analog joystick example
+ CONFIG_EXAMPLES_AJOYSTICK_DEVNAME - Joystick device name. Default
+ "/dev/adjoy0"
+ CONFIG_EXAMPLES_AJOYSTICK_SIGNO - Signal used to signal the test
+ application. Default 13.
+
examples/bastest
^^^^^^^^^^^^^^^^
This directory contains a small program that will mount a ROMFS file system
@@ -273,7 +291,7 @@ examples/discover
CONFIG_EXAMPLES_DISCOVER_DRIPADDR - Router IP address
CONFIG_EXAMPLES_DISCOVER_NETMASK - Network Mask
-examples/djoystick
+examples/adjoystick
^^^^^^^^^^^^^^^^^^
This is a simple test of the discrete joystick driver. See details about