Skip to content

Commit 0e09c57

Browse files
author
Amanda Butler
authored
Merge pull request #631 from paul-szczepanek-arm/gap-phy
expanded GAP docs with PHY
2 parents d3569e3 + ef6771d commit 0e09c57

File tree

1 file changed

+8
-8
lines changed
  • docs/reference/api/connectivity/bluetooth

1 file changed

+8
-8
lines changed

docs/reference/api/connectivity/bluetooth/Gap.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -26,20 +26,20 @@ Privacy is a feature that allows a device to avoid being tracked by other (untru
2626

2727
You need to enable privacy by calling `enablePrivacy()` after initializing the SecurityManager because privacy requires SecurityManager to handle IRKs. Set the behavior of privacy enabled devices by using `setCentralPrivacyConfiguration()`, which specifies what the device should be with devices using random addresses, and `setPeripheralPrivacyConfiguration`. Random addresses that privacy enabled devices generate can be of two types: resolvable (by devices who have the IRK) and unresolvable. You can't use unresolvable addresses for connecting and connectable advertising; therefore, use a resolvable one for these, regardless of the privacy configuration.
2828

29-
#### Modulation Schemes
29+
#### Modulation schemes
3030

3131
When supported by the host and controller, you can select different modulation schemes:
3232

33-
- LE 1M PHY.
34-
- LE 2M PHY.
35-
- LE coded PHY.
33+
- LE 1M PHY.
34+
- LE 2M PHY.
35+
- LE coded PHY.
3636

3737
These provide different compromises between bandwidth, power usage and error resiliency (see BLUETOOTH SPECIFICATION Version 5.0 Vol 1, Part A - 1.2).
38-
39-
You may set preferred PHYs (separately for RX and TX) using `setPreferredPhys()`. You may also set the currently used PHYs on a selected connection using `setPhy()`. Both of these settings are only advisory, and the controller is allowed to make its own decision on the best PHY to use based on your request, the peer's supported features and the connection's physical conditions.
40-
38+
39+
You may set preferred PHYs (separately for RX and TX) using `setPreferredPhys()`. You may also set the currently used PHYs on a selected connection using `setPhy()`. Both of these settings are only advisory. The controller is allowed to make its own decision on the best PHY to use based on your request, the peer's supported features and the connection's physical conditions.
40+
4141
You may query the currently used PHY using `readPhy()`, which returns the result through a call to the registered event handler. You may register the handler with `setEventHandler()`. The events inform about the currently used PHY and of any changes to PHYs, which the controller or the peer may trigger autonomously.
42-
42+
4343
### GAP class reference
4444

4545
[![View code](https://www.mbed.com/embed/?type=library)](http://os-doc-builder.test.mbed.com/docs/development/mbed-os-api-doxy/class_gap.html)

0 commit comments

Comments
 (0)