nuttx/Documentation/applications/examples/hidkbd/index.rst

18 lines
924 B
ReStructuredText
Raw Normal View History

``hidkbd`` USB Host HID keyboard
================================
This is a simple test to ``debug/verify`` the USB host HID keyboard class driver.
- ``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 printable and control ASCII characters
will be provided to the user. Requires ``CONFIG_HIDKBD_ENCODED`` and
``CONFIG_LIBC_KBDCODEC``.