summaryrefslogtreecommitdiffstats
path: root/api
diff options
context:
space:
mode:
authorSven Gothel <[email protected]>2020-09-03 14:15:59 +0200
committerSven Gothel <[email protected]>2020-09-03 14:19:25 +0200
commitcd2a94ce9b14eb1ac7e9f030cba4fbe6781d858b (patch)
tree5445db786e2e6120fa6fae9a0ed3ec84c6e3e610 /api
parentf268d65e9ca7372ee22a6aad20b9b6af9d667ebf (diff)
README: More detailed Direct-BT description (event driven, build depenencies, build, ..); Add \example tag in examples.
For unknown reason, examples are not visible in result.
Diffstat (limited to 'api')
-rw-r--r--api/direct_bt/ATTPDUTypes.hpp6
-rw-r--r--api/direct_bt/BTAddress.hpp6
2 files changed, 8 insertions, 4 deletions
diff --git a/api/direct_bt/ATTPDUTypes.hpp b/api/direct_bt/ATTPDUTypes.hpp
index 7c58848e..ffabec20 100644
--- a/api/direct_bt/ATTPDUTypes.hpp
+++ b/api/direct_bt/ATTPDUTypes.hpp
@@ -87,6 +87,11 @@
*
* - - - - - - - - - - - - - - -
*
+ * A fully event driven workflow from discovery to GATT programming is supported.
+ *
+ * AdapterStatusListener allows listening to adapter changes and device discovery
+ * and GATTCharacteristicListener to GATT indications and notifications.
+ *
* Main event listener can be attached to these objects
* which maintain a set of unique listener instances without duplicates.
*
@@ -99,6 +104,7 @@
* Other API attachment method exists for GATTCharacteristicListener,
* however, they only exists for convenience and end up to be attached to GATTHandler.
*
+ *
* - - - - - - - - - - - - - - -
*
* BT Core Spec v5.2: Vol 3, Part A L2CAP Spec: 7.9 PRIORITIZING DATA OVER HCI
diff --git a/api/direct_bt/BTAddress.hpp b/api/direct_bt/BTAddress.hpp
index bac15bf1..a9cd1bdb 100644
--- a/api/direct_bt/BTAddress.hpp
+++ b/api/direct_bt/BTAddress.hpp
@@ -39,10 +39,8 @@ namespace direct_bt {
* - EUI-48 or MAC (6 octets)
*
* 2) BT public address used as BD_ADDR for the LE physical channel is defined in Vol 6, Part B 1.3
- * </pre>
- * <p>
- * BT Core Spec v5.2: Vol 3, Part C Generic Access Profile (GAP): 15.1.1.2 Random Bluetooth address
- * <pre>
+ * BT Core Spec v5.2: Vol 3, Part C Generic Access Profile (GAP): 15.1.1.2 Random Bluetooth address
+ *
* 3) BT random address used as BD_ADDR on the LE physical channel is defined in Vol 3, Part C 10.8
* </pre>
*/