zephyr/samples/boards/bbc/microbit/pong/README.rst
Benjamin Cabé cfd35d0c2c samples: boards: bbc_microbit: use zephyr:code-sample directive
Adds missing code-sample directive to all the micro:bit samples in
preparation for upcoming changes to the Zephyr documentation that will
be leveraging the provided description and metadata.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2024-09-13 13:43:09 +02:00

33 lines
1.0 KiB
ReStructuredText

.. zephyr:code-sample:: bbc_microbit_pong
:name: Pong game
Play pong as single player or over Bluetooth between two micro:bit devices.
Overview
********
Play pong as single player or over Bluetooth between two micro:bit
devices.
The game works by controlling a paddle with the two buttons of the
micro:bit (labeled A and B). Initially the playing mode is selected: use
button A to toggle between single- and multi-player, and press button B
to select the current choice. To start the game, the player with the
ball launches the ball by pressing both buttons.
When multi-player mode has been selected the game will try to look for
and connect to a second micro:bit which has also been set into multi-player
mode.
If the board has a piezo buzzer connected to pin 0, this will be used to
generate beeps whenever the ball hits a wall or the paddle.
Building and running
********************
.. zephyr-app-commands::
:zephyr-app: samples/boards/bbc/microbit/pong
:board: bbc_microbit
:goals: build flash
:compact: