zephyr/samples/drivers/auxdisplay
Benjamin Cabé f6a4217a88 doc: driver: samples: Update driver samples to use new Sphinx extension
Migrated existing driver samples to use the new code-sample directive
and role.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2023-09-22 09:21:43 +02:00
..
boards samples: driver: auxdisplay: Add overlay for PT6314 on esp32c3_devkitm 2023-07-14 12:09:03 +02:00
src samples/auxdisplay: Switch main return type to int. 2023-05-31 10:36:17 +02:00
CMakeLists.txt
prj.conf
README.rst doc: driver: samples: Update driver samples to use new Sphinx extension 2023-09-22 09:21:43 +02:00
sample.yaml samples: drivers: auxdisplay requires a fixture to run on a platform 2023-06-28 15:20:00 +02:00

.. zephyr:code-sample:: auxdisplay
   :name: Auxiliary display
   :relevant-api: auxdisplay_interface

   Output "Hello  World" to an auxiliary display.

Overview
********

This sample shows how to use the :ref:`auxiliary display driver <auxdisplay_api>`
by outputting a sample "Hello World" text to one.

Building and Running
********************

Note that this sample requires a board with an auxiliary display setup. A
sample overlay is provided for the `nucleo_f746zg` board fly-wired to a Hitachi
HD44780-compatible 20 character by 4 line display. See the overlay file
:zephyr_file:`samples/drivers/auxdisplay/boards/nucleo_f746zg.overlay` for
wiring configuration.

.. zephyr-app-commands::
   :zephyr-app: samples/drivers/auxdisplay
   :host-os: unix
   :board: nucleo_f746zg
   :goals: build flash
   :compact:

If successful, the display will show `Hello World from <board>`.