Verified USB HID KBD driver encoding of special characters; apps/examples/hidkbd now decodes encoded keyboar characters.

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

1 files changed, 15 insertions, 3 deletions

diff --git a/apps/examples/README.txt b/apps/examples/README.txt
index e40a63be9..7bfba721a 100644
--- a/apps/examples/README.txt
+++ b/apps/examples/README.txt
@@ -540,9 +540,21 @@ examples/hidkbd
   This is a simple test to debug/verify the USB host HID keyboard class
   driver.
 
-    CONFIG_EXAMPLES_HIDKBD_DEFPRIO - Priority of "waiter" thread.
-    CONFIG_EXAMPLES_HIDKBD_STACKSIZE - Stacksize of "waiter" thread.
-
+    CONFIG_EXAMPLES_HIDKBD_DEFPRIO - Priority of "waiter" thread.  Default:
+      50
+    CONFIG_EXAMPLES_HIDKBD_STACKSIZE - Stacksize of "waiter" thread. Default
+      1024
+    CONFIG_EXAMPLES_HIDKBD_DEVNAME - Name of keyboard device to be used.
+      Default: "/dev/kbda"
+    CONFIG_EXAMPLES_HIDKBD_ENCODED - Decode special key press events in the
+      user buffer.  In this case, the example coded will use the interfaces
+      defined in include/nuttx/input/kbd_codec.h to decode the returned
+      keyboard data.  These special keys include such things as up/down
+      arrows, home and end keys, etc.  If this not defined, only 7-bit print-
+      able and control ASCII characters will be provided to the user.
+      Requires CONFIG_HIDKBD_ENCODED && CONFIG_LIB_KBDCODEC
+
+endif
 examples/igmp
 ^^^^^^^^^^^^^