zephyr/samples/bluetooth/peripheral_hids
Aleksander Wasaznik 8cfad44852 Bluetooth: Deprecate adv auto-resume
The host-based adv auto-resume function has both a problematic
implementation and disagreement in the community around how it should
behave. See the issue linked resolved below for details.

This patch makes the deprecation visible to the user. The user will be
better served by a auto-resume tailored their applications use case,
based on more primitive host API like `conn_cb.recycled`, which has
obvious behavior that is unlikely to change.

Resolves: https://github.com/zephyrproject-rtos/zephyr/issues/72567

Signed-off-by: Aleksander Wasaznik <aleksander.wasaznik@nordicsemi.no>
2024-10-08 16:57:01 +02:00
..
boards
src Bluetooth: Deprecate adv auto-resume 2024-10-08 16:57:01 +02:00
CMakeLists.txt
Kconfig
README.rst doc: samples: Adopt code-sample-category across tree 2024-09-23 12:00:00 +02:00
prj.conf
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 :zephyr:code-sample-category:`bluetooth` samples for details.