OrgZephyr/zephyr
OrgZephyr
/
zephyr
mirror of https://github.com/zephyrproject-rtos/zephyr.git
1
0
Fork 0
Code Issues Releases Wiki Activity
zephyr/doc/api/bluetooth.rst

88 lines
1.8 KiB
ReStructuredText
Raw Normal View History

doc: api: Include Bluetooth in API section Change-Id: Iee26587476b8f7286d2afe828ba23db49b09d0ce Signed-off-by: Johan Hedberg <johan.hedberg@intel.com>
2016-06-15 15:27:40 +08:00
.. _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
Bluetooth: Kconfig: Rename CONFIG_BLUETOOTH_* to CONFIG_BT_* The API name space for Bluetooth is bt_* and BT_* so it makes sense to align the Kconfig name space with this. The additional benefit is that this also makes the names shorter. It is also in line with what Linux uses for Bluetooth Kconfig entries. Some Bluetooth-related Networking Kconfig defines are renamed as well in order to be consistent, such as NET_L2_BLUETOOTH. Signed-off-by: Johan Hedberg <johan.hedberg@intel.com>
2017-08-09 14:21:11 +08:00
connection-related APIs require :option:`CONFIG_BT_CONN` and any
BR/EDR (Bluetooth Classic) APIs require :option:`CONFIG_BT_BREDR`.
doc: api: Include Bluetooth in API section Change-Id: Iee26587476b8f7286d2afe828ba23db49b09d0ce Signed-off-by: Johan Hedberg <johan.hedberg@intel.com>
2016-06-15 15:27:40 +08:00
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
Bluetooth: Mesh: Add initial implementation Add an initial implementation for the Bluetooth Mesh Profile Specification. The main code resides in subsys/bluetooth/host/mesh and the public API can be found in include/bluetooth/mesh.h. There are a couple of samples provided as well under samples/bluetooth and tests/bluetooth. The implementation covers all layers of the Bluetooth Mesh stack and most optional features as well. The following is a list of some of these features and the c-files where the implementation can be found: - GATT & Advertising bearers (proxy.c & adv.c) - Network Layer (net.c) - Lower and Upper Transport Layers (transport.c) - Access Layer (access.c) - Foundation Models, Server role (health.c & cfg.c) - Both PB-ADV and PB-GATT based provisioning (prov.c) - Low Power Node support (lpn.c) - Relay support (net.c) - GATT Proxy (proxy.c) Notable features that are *not* part of the implementation: - Friend support (initial bits are in place in friend.c) - Provisioner support (low-value for typical Zephyr devices) - GATT Client (low-value for typical Zephyr devices) Jira: ZEP-2360 Change-Id: Ic773113dbfd84878ff8cee7fe2bb948f0ace19ed Signed-off-by: Johan Hedberg <johan.hedberg@intel.com>
2017-06-16 17:30:54 +08:00
Mesh Profile
************
.. doxygengroup:: bt_mesh
:project: Zephyr
doc: api: Include Bluetooth in API section Change-Id: Iee26587476b8f7286d2afe828ba23db49b09d0ce Signed-off-by: Johan Hedberg <johan.hedberg@intel.com>
2016-06-15 15:27:40 +08:00
Universal Unique Identifiers (UUIDs)
************************************
.. doxygengroup:: bt_uuid
:project: Zephyr
Logical Link Control and Adaptation Protocol (L2CAP)
****************************************************
.. doxygengroup:: bt_l2cap
:project: Zephyr
Bluetooth: Build RFCOMM documentation Change-Id: Iaba8fc321d73d66826d24f7f82d82d91ff0a250f Signed-off-by: Szymon Janc <ext.szymon.janc@tieto.com>
2016-08-26 20:26:33 +08:00
Serial Port Emulation (RFCOMM)
******************************
.. doxygengroup:: bt_rfcomm
:project: Zephyr
doc: api: Include Bluetooth in API section Change-Id: Iee26587476b8f7286d2afe828ba23db49b09d0ce Signed-off-by: Johan Hedberg <johan.hedberg@intel.com>
2016-06-15 15:27:40 +08:00
Data Buffers
************
.. doxygengroup:: bt_buf
:project: Zephyr
Persistent Storage
******************
.. doxygengroup:: bt_storage
:project: Zephyr
HCI Drivers
***********
Bluetooth: Rename bt_driver to bt_hci_driver The bt_driver API was created when Zephyr only had a Bluetooth host stack, but no controller-side functionality. The only "driver" that was needed for the host was the HCI driver, and hence "HCI" was omitted from the name. With support both for host and controller Zephyr will be getting more Bluetooth driver types, in particular radio drivers. To prepare for this, move all HCI drivers to drivers/bluetooth/hci/ and rename the bt_driver API bt_hci_driver. Change-Id: I82829da80aa61f26c2bb2005380f1e88d069ac7d Signed-off-by: Johan Hedberg <johan.hedberg@intel.com>
2016-10-27 21:55:01 +08:00
.. doxygengroup:: bt_hci_driver
doc: api: Include Bluetooth in API section Change-Id: Iee26587476b8f7286d2afe828ba23db49b09d0ce Signed-off-by: Johan Hedberg <johan.hedberg@intel.com>
2016-06-15 15:27:40 +08:00
:project: Zephyr
Bluetooth: Add documentation to HCI RAW interface Describe bt_enable_raw() and bt_send() functions. Change-Id: I0eb18dd2364eec0eb2a8c3e7b537d87e984dd90e Signed-off-by: Andrei Emeltchenko <andrei.emeltchenko@intel.com>
2016-08-17 16:33:04 +08:00
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