third_party.pigweed.src/pw_bluetooth/docs.rst
Ben Lawson 4331b174c4 pw_bluetooth: Create pw_bluetooth API
Create the pw_bluetooth module.

Create the Bluetooth Low Energy C++ API in the pw_bluetooth module.
This API will be used to wrap various BLE implementations.

Bug: 636
Change-Id: I329c8e0f307d30a26581a43cb46cf2d3dbd35da0
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/84180
Pigweed-Auto-Submit: Ben Lawson <benlawson@google.com>
Reviewed-by: Keir Mierle <keir@google.com>
Commit-Queue: Ben Lawson <benlawson@google.com>
2022-06-15 22:31:19 +00:00

19 lines
584 B
ReStructuredText

.. _module-pw_bluetooth:
================
pw_bluetooth
================
The ``pw_bluetooth`` module contains APIs for the host layer of Bluetooth Low
Energy. The APIs are a collection of virtual interfaces that must implemented by
a BLE host stack.
.. note::
This module is still under construction, the API is not yet stable.
Callbacks
===========
This module contains callback-heavy APIs. Callbacks must not call into the
``pw_bluetooth`` APIs unless otherwise noted. This includes calls made by
destroying objects returned by the API. Additionally, callbacks must not block.