zephyr/samples/drivers/auxdisplay
Benjamin Cabé df294e34e1 doc: sphinx-lint: fix bad usage of "default role"
Fixes bad usage of single backticks in lieu of double backticks for
rendering inline literals, or simple '*' for italics.

When appropriate, a better construct than double backticks has been
selected (ex. :file:, :kconfig:option:, :c:func:, ...), or proper :ref:
have been used if the original intention was to have a link.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2024-09-13 11:42:51 -05:00
..
boards
src
CMakeLists.txt
README.rst
prj.conf
sample.yaml

README.rst

.. 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>".