aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSven Gothel <[email protected]>2021-09-18 13:31:10 +0200
committerSven Gothel <[email protected]>2021-09-18 13:31:10 +0200
commit140c3c1b14b766a5269362c675b6ea5f69636dff (patch)
tree825305e714475e30de0cbf164314aa05069450d7
parent0bebc419e75b5b24fc1d4c53e35c0ea669398732 (diff)
BLERandomAddressType: API doc: Add more details.
-rw-r--r--api/direct_bt/BTAddress.hpp10
1 files changed, 8 insertions, 2 deletions
diff --git a/api/direct_bt/BTAddress.hpp b/api/direct_bt/BTAddress.hpp
index b514db36..ec094d1a 100644
--- a/api/direct_bt/BTAddress.hpp
+++ b/api/direct_bt/BTAddress.hpp
@@ -89,11 +89,17 @@ namespace direct_bt {
enum class BLERandomAddressType : uint8_t {
/** Non-resolvable private random device address 0b00 */
UNRESOLVABLE_PRIVAT = 0x00,
- /** Resolvable private random device address 0b01 */
+ /**
+ * Resolvable private random device address 0b01.
+ *
+ * Requires Local Identity Resolving Key (IRK) or the Peer Identity Resolving Key (IRK).
+ *
+ * EUI48: 24 bits hash = ag(IRK, prand), 24 bits prand.
+ */
RESOLVABLE_PRIVAT = 0x01,
/** Reserved for future use 0b10 */
RESERVED = 0x02,
- /** Static public 'random' device address 0b11 */
+ /** Static public 'random' device address 0b11. Not changing between power-cycles. */
STATIC_PUBLIC = 0x03,
/** Undefined, e.g. address not of type {@link BDAddressType::BDADDR_LE_RANDOM} */
UNDEFINED = 0xff