README.rst
1.. zephyr:code-sample:: auxdisplay
2 :name: Auxiliary display
3 :relevant-api: auxdisplay_interface
4
5 Output "Hello World" to an auxiliary display.
6
7Overview
8********
9
10This sample shows how to use the :ref:`auxiliary display driver <auxdisplay_api>`
11by outputting a sample "Hello World" text to one.
12
13Building and Running
14********************
15
16Note that this sample requires a board with an auxiliary display setup. A
17sample overlay is provided for the ``nucleo_f746zg`` board fly-wired to a Hitachi
18HD44780-compatible 20 character by 4 line display. See the overlay file
19:zephyr_file:`samples/drivers/auxdisplay/boards/nucleo_f746zg.overlay` for
20wiring configuration.
21
22.. zephyr-app-commands::
23 :zephyr-app: samples/drivers/auxdisplay
24 :host-os: unix
25 :board: nucleo_f746zg
26 :goals: build flash
27 :compact:
28
29If successful, the display will show "Hello World from <board>".
30
