aboutsummaryrefslogtreecommitdiffstats
path: root/api/direct_bt
diff options
context:
space:
mode:
authorSven Gothel <[email protected]>2021-07-27 14:01:42 +0200
committerSven Gothel <[email protected]>2021-07-27 14:01:42 +0200
commit7114ba7dfec29839a09b90578ff4a58ac8a38fa0 (patch)
tree23ca8e8f8e32745f40fa15ec575c1a5f3e90baa3 /api/direct_bt
parent927678e3b739cc2b6efdc1ea43513333838df2ae (diff)
dbt_scanner10: Document important invocation options
Diffstat (limited to 'api/direct_bt')
-rw-r--r--api/direct_bt/ATTPDUTypes.hpp41
1 files changed, 37 insertions, 4 deletions
diff --git a/api/direct_bt/ATTPDUTypes.hpp b/api/direct_bt/ATTPDUTypes.hpp
index 9ec59005..3c9bc3ac 100644
--- a/api/direct_bt/ATTPDUTypes.hpp
+++ b/api/direct_bt/ATTPDUTypes.hpp
@@ -1477,12 +1477,45 @@ namespace direct_bt {
}
/** \example dbt_scanner10.cpp
- * This C++ scanner example uses the Direct-BT fully event driven workflow
+ * This _dbt_scanner10_ C++ scanner example uses the Direct-BT fully event driven workflow
* and adds multithreading, i.e. one thread processes each found device found
* as notified via the event listener.
- * <p>
- * This example represents the recommended utilization of Direct-BT.
- * </p>
+ *
+ * _dbt_scanner10_ represents the recommended utilization of Direct-BT.
+ *
+ * ### dbt_scanner10 Invocation Examples:
+ * Using `scripts/run-dbt_scanner10.sh` from `dist` directory:
+ * * Scan and read all devices (using default auto-sec w/ keyboard iocap)
+ * ~~~
+ * ../scripts/run-dbt_scanner10.sh
+ * ~~~
+ *
+ * * Read device C0:26:DA:01:DA:B1 (using default auto-sec w/ keyboard iocap)
+ * ~~~
+ * ../scripts/run-dbt_scanner10.sh -mac C0:26:DA:01:DA:B1
+ * ~~~
+ *
+ * * Read device C0:26:DA:01:DA:B1 (enforcing no security)
+ * ~~~
+ * ../scripts/run-dbt_scanner10.sh -mac C0:26:DA:01:DA:B1 -seclevel C0:26:DA:01:DA:B1 1 1
+ * ~~~
+ *
+ * * Read device C0:26:DA:01:DA:B1, basic debug flags enabled (using default auto-sec w/ keyboard iocap)
+ * ~~~
+ * ../scripts/run-dbt_scanner10.sh -mac C0:26:DA:01:DA:B1 -dbt_debug true
+ * ~~~
+ *
+ * * Read device C0:26:DA:01:DA:B1, all debug flags enabled (using default auto-sec w/ keyboard iocap)
+ * ~~~
+ * ../scripts/run-dbt_scanner10.sh -mac C0:26:DA:01:DA:B1 -dbt_debug adapter.event,gatt.data,hci.event,hci.scan_ad_eir,mgmt.event
+ * ~~~
+ *
+ * ## Special Actions
+ * * To do a BT adapter removal/add via software, assuming the device is '1-4' (Bus 1.Port 4):
+ * ~~~
+ * echo '1-4' > /sys/bus/usb/drivers/usb/unbind
+ * echo '1-4' > /sys/bus/usb/drivers/usb/bind
+ * ~~~
*/
/** \example dbt_scanner00.cpp