zephyr

History

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	Bluetooth: Samples: Use string printing functions for error codes	2024-07-31 12:56:11 +02:00
CMakeLists.txt
Kconfig
prj.conf
README.rst	doc: sphinx-lint: fix bad usage of "default role"	2024-09-13 11:42:51 -05:00
sample.yaml

README.rst

.. zephyr:code-sample:: ble_peripheral_hids
   :name: HID Peripheral
   :relevant-api: bt_gatt bluetooth

   Implement a Bluetooth HID peripheral (generic mouse)

Overview
********

Similar to the :zephyr:code-sample:`ble_peripheral` sample, except that this
application specifically exposes the HID GATT Service. The report map used is
for a generic mouse.

In the default configuration the sample uses passkey authentication (displays a
code on the peripheral and requires that to be entered on the host during
pairing) and requires an authenticated link to access the GATT characteristics.
To disable authentication and just use encrypted channels instead, build the
sample with ``CONFIG_SAMPLE_BT_USE_AUTHENTICATION=n``.

Requirements
************

* BlueZ running on the host, or
* A board with Bluetooth LE support

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

This sample can be found under :zephyr_file:`samples/bluetooth/peripheral_hids` in the
Zephyr tree.

See :ref:`bluetooth samples section <bluetooth-samples>` for details.