michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: bluetooth: split API docs

Browse source 
Split API docs into multiple pages.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
This commit is contained in:
Anas Nashif 2019-01-26 12:57:27 -05:00
commit 3c912086e6
17 changed files with 251 additions and 141 deletions
Download patch file Download diff file Expand all files Collapse all files

141
doc/api/bluetooth.rst
View file

@ -20,145 +20,4 @@ BR/EDR (Bluetooth Classic) APIs require :option:`CONFIG_BT_BREDR`.
.. doxygengroup:: bluetooth
.. doxygengroup:: bt_test_cb
Bluetooth Controller
********************
.. doxygengroup:: bt_ctrl
:project: Zephyr
Bluetooth Mesh Profile
**********************
.. doxygengroup:: bt_mesh
:project: Zephyr
Bluetooth Mesh Access Layer
===========================
.. doxygengroup:: bt_mesh_access
:project: Zephyr
Bluetooth Mesh Configuration Client Model
=========================================
.. doxygengroup:: bt_mesh_cfg_cli
:project: Zephyr
Bluetooth Mesh Configuration Server Model
=========================================
.. doxygengroup:: bt_mesh_cfg_srv
:project: Zephyr
Bluetooth Mesh Health Client Model
==================================
.. doxygengroup:: bt_mesh_health_cli
:project: Zephyr
Bluetooth Mesh Health Server Model
==================================
.. doxygengroup:: bt_mesh_health_srv
:project: Zephyr
Bluetooth Mesh Provisioning
===========================
.. doxygengroup:: bt_mesh_prov
:project: Zephyr
Bluetooth Mesh Proxy
====================
.. doxygengroup:: bt_mesh_proxy
:project: Zephyr
Connection Management
*********************
.. doxygengroup:: bt_conn
:project: Zephyr
Cryptography
************
.. doxygengroup:: bt_crypto
:project: Zephyr
Data Buffers
************
.. doxygengroup:: bt_buf
:project: Zephyr
Generic Access Profile (GAP)
****************************
.. doxygengroup:: bt_gap
:project: Zephyr
Generic Attribute Profile (GATT)
********************************
.. doxygengroup:: bt_gatt
:project: Zephyr
GATT Server
===========
.. doxygengroup:: bt_gatt_server
:project: Zephyr
GATT Client
===========
.. doxygengroup:: bt_gatt_client
: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
HCI Drivers
***********
.. doxygengroup:: bt_hci_driver
:project: Zephyr
Hands Free Profile (HFP)
************************
.. doxygengroup:: bt_hfp
:project: Zephyr
Logical Link Control and Adaptation Protocol (L2CAP)
****************************************************
.. doxygengroup:: bt_l2cap
:project: Zephyr
Serial Port Emulation (RFCOMM)
******************************
.. doxygengroup:: bt_rfcomm
:project: Zephyr
Service Discovery Protocol (SDP)
********************************
.. doxygengroup:: bt_sdp
:project: Zephyr
Universal Unique Identifiers (UUIDs)
************************************
.. doxygengroup:: bt_uuid
:project: Zephyr

21
doc/subsystems/bluetooth/api.rst Normal file
View file

@ -0,0 +1,21 @@
Bluetooth
#########
.. toctree::
:maxdepth: 2
connection_mgmt.rst
controller.rst
crypto.rst
data_buffer.rst
gap.rst
gatt.rst
hci_drivers.rst
hci_raw.rst
hfp.rst
l2cap.rst
mesh.rst
rfcomm.rst
sdp.rst
uuid.rst

12
doc/subsystems/bluetooth/connection_mgmt.rst Normal file
View file

@ -0,0 +1,12 @@
.. _bluetooth_connection_mgmt:
Connection Management
#####################
API Reference
*************
.. doxygengroup:: bt_conn
:project: Zephyr

11
doc/subsystems/bluetooth/controller.rst Normal file
View file

@ -0,0 +1,11 @@
.. _bluetooth_controller:
Bluetooth Controller
####################
API Reference
*************
.. doxygengroup:: bt_ctrl
:project: Zephyr

11
doc/subsystems/bluetooth/crypto.rst Normal file
View file

@ -0,0 +1,11 @@
.. _bt_crypto:
Cryptography
############
API Reference
*************
.. doxygengroup:: bt_crypto
:project: Zephyr

11
doc/subsystems/bluetooth/data_buffer.rst Normal file
View file

@ -0,0 +1,11 @@
.. _bt_data_buffers:
Data Buffers
#############
API Reference
*************
.. doxygengroup:: bt_buf
:project: Zephyr

13
doc/subsystems/bluetooth/gap.rst Normal file
View file

@ -0,0 +1,13 @@
.. _bt_gap::
Generic Access Profile (GAP)
############################
API Reference
*************
.. doxygengroup:: bt_gap
:project: Zephyr

24
doc/subsystems/bluetooth/gatt.rst Normal file
View file

@ -0,0 +1,24 @@
.. _bt_gatt:
Generic Attribute Profile (GATT)
################################
API Reference
*************
.. doxygengroup:: bt_gatt
:project: Zephyr
GATT Server
===========
.. doxygengroup:: bt_gatt_server
:project: Zephyr
GATT Client
===========
.. doxygengroup:: bt_gatt_client
:project: Zephyr

12
doc/subsystems/bluetooth/hci_drivers.rst Normal file
View file

@ -0,0 +1,12 @@
.. _bt_hci_drivers:
HCI Drivers
###########
API Reference
*************
.. doxygengroup:: bt_hci_driver
:project: Zephyr

19
doc/subsystems/bluetooth/hci_raw.rst Normal file
View file

@ -0,0 +1,19 @@
.. _bt_hci_raw:
HCI RAW channel
###############
Overview
********
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.
API Reference
*************
.. doxygengroup:: hci_raw
:project: Zephyr

11
doc/subsystems/bluetooth/hfp.rst Normal file
View file

@ -0,0 +1,11 @@
.. _bt_hfp:
Hands Free Profile (HFP)
########################
API Reference
*************
.. doxygengroup:: bt_hfp
:project: Zephyr

4
doc/subsystems/bluetooth/bluetooth.rst → doc/subsystems/bluetooth/index.rst
View file

@ -3,6 +3,10 @@
Bluetooth
#########
.. contents::
:local:
:depth: 2
Overview
********

10
doc/subsystems/bluetooth/l2cap.rst Normal file
View file

@ -0,0 +1,10 @@
.. _bt_l2cap:
Logical Link Control and Adaptation Protocol (L2CAP)
####################################################
API Reference
*************
.. doxygengroup:: bt_l2cap
:project: Zephyr

59
doc/subsystems/bluetooth/mesh.rst Normal file
View file

@ -0,0 +1,59 @@
.. _bluetooth_mesh:
Bluetooth Mesh Profile
######################
API Reference
**************
Mesh Profile
============
.. doxygengroup:: bt_mesh
:project: Zephyr
Bluetooth Mesh Access Layer
===========================
.. doxygengroup:: bt_mesh_access
:project: Zephyr
Bluetooth Mesh Configuration Client Model
=========================================
.. doxygengroup:: bt_mesh_cfg_cli
:project: Zephyr
Bluetooth Mesh Configuration Server Model
=========================================
.. doxygengroup:: bt_mesh_cfg_srv
:project: Zephyr
Bluetooth Mesh Health Client Model
==================================
.. doxygengroup:: bt_mesh_health_cli
:project: Zephyr
Bluetooth Mesh Health Server Model
==================================
.. doxygengroup:: bt_mesh_health_srv
:project: Zephyr
Bluetooth Mesh Provisioning
===========================
.. doxygengroup:: bt_mesh_prov
:project: Zephyr
Bluetooth Mesh Proxy
====================
.. doxygengroup:: bt_mesh_proxy
:project: Zephyr

12
doc/subsystems/bluetooth/rfcomm.rst Normal file
View file

@ -0,0 +1,12 @@
.. _bt_rfcomm:
Serial Port Emulation (RFCOMM)
##############################
API Reference
*************
.. doxygengroup:: bt_rfcomm
:project: Zephyr

10
doc/subsystems/bluetooth/sdp.rst Normal file
View file

@ -0,0 +1,10 @@
.. _bt_sdp:
Service Discovery Protocol (SDP)
################################
API Reference
**************
.. doxygengroup:: bt_sdp
:project: Zephyr

11
doc/subsystems/bluetooth/uuid.rst Normal file
View file

@ -0,0 +1,11 @@
.. _bt_uuid:
Universal Unique Identifiers (UUIDs)
#####################################
API Reference
*************
.. doxygengroup:: bt_uuid
:project: Zephyr