mirror of
https://github.com/zephyrproject-rtos/zephyr
synced 2025-09-10 09:41:57 +00:00
f64151a7f1
Doxygen-generated API documentation had the ability to group API information into sections based on the class of items: Defines, Typedefs, Enums, Functions and then alphabetized with these groups. By removing the Breathe directive :content-only: we can get these class groupings back (instead of having items just sorted alphabetically across all classes), and also allow @name groups to be defined for creating and displaying additional groups (as requested by a developer). Depends on CSS changes in https://github.com/zephyrproject-rtos/docs-theme/pull/14 Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
88 lines
1.8 KiB
ReStructuredText
88 lines
1.8 KiB
ReStructuredText
.. _bluetooth_api:
|
|
|
|
Bluetooth API
|
|
#############
|
|
|
|
.. contents::
|
|
:depth: 1
|
|
:local:
|
|
:backlinks: top
|
|
|
|
This is the full set of available Bluetooth APIs. It's important to note
|
|
that the set that will in practice be available for the application
|
|
depends on the exact Kconfig options that have been chosen, since most
|
|
of the Bluetooth functionality is build-time selectable. E.g. any
|
|
connection-related APIs require :option:`CONFIG_BT_CONN` and any
|
|
BR/EDR (Bluetooth Classic) APIs require :option:`CONFIG_BT_BREDR`.
|
|
|
|
Generic Access Profile (GAP)
|
|
****************************
|
|
|
|
.. doxygengroup:: bt_gap
|
|
:project: Zephyr
|
|
|
|
Connection Management
|
|
*********************
|
|
|
|
.. doxygengroup:: bt_conn
|
|
:project: Zephyr
|
|
|
|
Generic Attribute Profile (GATT)
|
|
********************************
|
|
|
|
.. doxygengroup:: bt_gatt
|
|
:project: Zephyr
|
|
|
|
Mesh Profile
|
|
************
|
|
|
|
.. doxygengroup:: bt_mesh
|
|
:project: Zephyr
|
|
|
|
Universal Unique Identifiers (UUIDs)
|
|
************************************
|
|
|
|
.. doxygengroup:: bt_uuid
|
|
:project: Zephyr
|
|
|
|
Logical Link Control and Adaptation Protocol (L2CAP)
|
|
****************************************************
|
|
|
|
.. doxygengroup:: bt_l2cap
|
|
:project: Zephyr
|
|
|
|
Serial Port Emulation (RFCOMM)
|
|
******************************
|
|
|
|
.. doxygengroup:: bt_rfcomm
|
|
:project: Zephyr
|
|
|
|
Data Buffers
|
|
************
|
|
|
|
.. doxygengroup:: bt_buf
|
|
:project: Zephyr
|
|
|
|
Persistent Storage
|
|
******************
|
|
|
|
.. doxygengroup:: bt_storage
|
|
:project: Zephyr
|
|
|
|
HCI Drivers
|
|
***********
|
|
|
|
.. doxygengroup:: bt_hci_driver
|
|
:project: Zephyr
|
|
|
|
HCI RAW channel
|
|
***************
|
|
|
|
HCI RAW channel API is intended to expose HCI interface to the remote entity.
|
|
The local Bluetooth controller gets owned by the remote entity and host
|
|
Bluetooth stack is not used. RAW API provides direct access to packets which
|
|
are sent and received by the Bluetooth HCI driver.
|
|
|
|
.. doxygengroup:: hci_raw
|
|
:project: Zephyr
|