aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSven Gothel <[email protected]>2021-02-11 02:41:12 +0100
committerSven Gothel <[email protected]>2021-02-11 02:41:12 +0100
commit04d7a17072608d223234e54ae0cfc4ea6f13b91c (patch)
tree33dd67c1fe0fe8f5b9a88201c1b5453d5f88afee
parentdaa87b8dd2aefe92acd00c413ec9ddba530caa48 (diff)
Bump README; Drop TinyB from title, as it no more covers the new Direct-BT API (completely)
-rw-r--r--Doxyfile.cpp.in4
-rw-r--r--Doxyfile.java.in4
-rw-r--r--README.md18
3 files changed, 17 insertions, 9 deletions
diff --git a/Doxyfile.cpp.in b/Doxyfile.cpp.in
index 15414220..1d4a0f81 100644
--- a/Doxyfile.cpp.in
+++ b/Doxyfile.cpp.in
@@ -32,7 +32,7 @@ DOXYFILE_ENCODING = UTF-8
# title of most generated pages and in a few other places.
# The default value is: My Project.
-PROJECT_NAME = "Direct-BT / TinyB"
+PROJECT_NAME = "Direct-BT"
# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
# could be handy for archiving the generated documentation or if some version
@@ -44,7 +44,7 @@ PROJECT_NUMBER = @direct_bt_VERSION_STRING@
# for a project that appears at the top of each page and should give viewer a
# quick idea about the purpose of the project. Keep the description short.
-PROJECT_BRIEF = "Direct-BT - Direct Bluetooth Programming; TinyB - The Tiny Bluetooth LE library."
+PROJECT_BRIEF = "Direct-BT - Direct Bluetooth Programming."
# With the PROJECT_LOGO tag one can specify a logo or an icon that is included
# in the documentation. The maximum height of the logo should not exceed 55
diff --git a/Doxyfile.java.in b/Doxyfile.java.in
index cdd2a774..dfc7d83d 100644
--- a/Doxyfile.java.in
+++ b/Doxyfile.java.in
@@ -32,7 +32,7 @@ DOXYFILE_ENCODING = UTF-8
# title of most generated pages and in a few other places.
# The default value is: My Project.
-PROJECT_NAME = "Direct-BT / TinyB"
+PROJECT_NAME = "Direct-BT"
# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
# could be handy for archiving the generated documentation or if some version
@@ -44,7 +44,7 @@ PROJECT_NUMBER = @direct_bt_VERSION_STRING@
# for a project that appears at the top of each page and should give viewer a
# quick idea about the purpose of the project. Keep the description short.
-PROJECT_BRIEF = "Direct-BT - Direct Bluetooth Programming; TinyB - The Tiny Bluetooth LE library."
+PROJECT_BRIEF = "Direct-BT - Direct Bluetooth Programming."
# With the PROJECT_LOGO tag one can specify a logo or an icon that is included
# in the documentation. The maximum height of the logo should not exceed 55
diff --git a/README.md b/README.md
index 8cc20097..34426e9d 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,5 @@
-Direct-BT LE and BREDR Library + Tiny Bluetooth LE Library
-==========================================================
+Direct-BT LE and BREDR Library
+==============================
Git Repository
==============
@@ -21,7 +21,7 @@ to clarify semantics, further support *Direct-BT*
and to favor a shortened naming convention,
e.g. *BluetoothManager* to *BTManager*, *BluetoothGattCharacteristic* to *BTGattChar* etc.
-As of today, the Java API comprises two implementations, *Direct-BT* and *TinyB*.
+As of today, the Java API comprises two implementations, *Direct-BT* (complete) and *TinyB* (incomplete).
Direct-BT
@@ -58,8 +58,9 @@ Some more elaboration on the implementation and its status
>
> Currently only the master/client mode is supported to work with LE BT devices.
>
-> *LE Secure Connections* and *LE legacy pairing* is supported on *Linux/BlueZ*,
-> exposing BTSecurityLevel and SMPIOCapability setup per connection.
+> *LE Secure Connections* and *LE legacy pairing* is supported,
+> exposing BTSecurityLevel and SMPIOCapability setup per connection
+> and providing *automatic security mode negotiation*.
>
> BREDR support is planned and prepared for.
>
@@ -139,6 +140,9 @@ TinyB
*TinyB* is the original implementation of the TinyB project by Intel.
+*TinyB* does not cover all API functionality anymore: Event driven adapter, device and GATT handling
+nor SMP Secure Connections.
+
TinyB and Direct-BT
-------------------
@@ -342,6 +346,10 @@ Changes
**2.3.00 *Direct-BT* Maturity (Bluetooth LE)**
* TODO
+* Tested key regeneration use-case: Pairing failure (bad key), key removal and auto security negotiation.
+* Adding SMPKeyBin file removal support.
+* Tested negative passkey/boolean input, requested via auto security negotiation.
+* Using negative passkey response via `setPairingPasskey(passkey = 0)` for performance.
**2.2.4**