summaryrefslogtreecommitdiff
path: root/src/libs/mynewt-nimble/docs/ble_hs/ble_att.rst
diff options
context:
space:
mode:
authorJF <jf@codingfield.com>2020-05-17 08:29:13 (GMT)
committerGitea <gitea@fake.local>2020-05-17 08:29:13 (GMT)
commit8a94750e30399bfb204cbec59a769d9d1b6b5baa (patch)
tree8a1a58beae54e238d28aff116c900f3b428b7db4 /src/libs/mynewt-nimble/docs/ble_hs/ble_att.rst
parent86d5732b960fbe7f81ed711b2de7e6b79293c96a (diff)
parentbe1ad9b07083e656a649d223750ff4b14b781b7b (diff)
Merge branch 'develop' of JF/PineTime into master
Diffstat (limited to 'src/libs/mynewt-nimble/docs/ble_hs/ble_att.rst')
-rw-r--r--src/libs/mynewt-nimble/docs/ble_hs/ble_att.rst22
1 files changed, 22 insertions, 0 deletions
diff --git a/src/libs/mynewt-nimble/docs/ble_hs/ble_att.rst b/src/libs/mynewt-nimble/docs/ble_hs/ble_att.rst
new file mode 100644
index 0000000..2025784
--- /dev/null
+++ b/src/libs/mynewt-nimble/docs/ble_hs/ble_att.rst
@@ -0,0 +1,22 @@
+NimBLE Host ATT Client Reference
+--------------------------------
+
+Introduction
+~~~~~~~~~~~~
+
+The Attribute Protocol (ATT) is a mid-level protocol that all BLE devices use to exchange data. Data is exchanged when
+an ATT client reads or writes an attribute belonging to an ATT server. Any device that needs to send or receive data
+must support both the client and server functionality of the ATT protocol. The only devices which do not support ATT
+are the most basic ones: broadcasters and observers (i.e., beaconing devices and listening devices).
+
+Most ATT functionality is not interesting to an application. Rather than use ATT directly, an application uses the
+higher level GATT profile, which sits directly above ATT in the host. NimBLE exposes the few bits of ATT functionality
+which are not encompassed by higher level GATT functions. This section documents the ATT functionality that the NimBLE
+host exposes to the application.
+
+API
+~~~~~~
+
+.. doxygengroup:: bt_host
+ :content-only:
+ :members: