1.. _auxdisplay_api:
2
3Auxiliary Display (auxdisplay)
4##############################
5
6Overview
7********
8
9Auxiliary Displays are text-based displays that have simple interfaces for
10displaying textual, numeric or alphanumeric data, as opposed to the
11:ref:`display_api`, auxiliary displays do not support custom
12graphical output to displays (and most often monochrome), the most
13advanced custom feature supported is generation of custom characters.
14These inexpensive displays are commonly found with various configurations
15and sizes, a common display size is 16 characters by 2 lines.
16
17This API is unstable and subject to change.
18
19Configuration Options
20*********************
21
22Related configuration options:
23
24* :kconfig:option:`CONFIG_AUXDISPLAY`
25* :kconfig:option:`CONFIG_AUXDISPLAY_INIT_PRIORITY`
26
27API Reference
28*************
29
30.. doxygengroup:: auxdisplay_interface
31