Preferred PHY option. More...

#include <ble_gap.h>

Detailed Description

Preferred PHY option.

This can be used with sd_ble_opt_set to change the preferred PHYs. Before this function is called the PHYs for peer initiated PHY Update procedure is BLE_GAP_PHY_1MBPS. If ble_gap_opt_preferred_phys_t::tx_phys or ble_gap_opt_preferred_phys_t::rx_phys is 0, then the stack will select PHYs based on the peer requirements on that specific direction.

Note: The preferred PHYs are only valid for newly created connections after this option is called. If the PHYs should be changed for an existing link the sd_ble_gap_phy_request would have to be called, and that would try to update the PHYs for the given link.; tx_phys and rx_phys are bitfields, to indicate multiple preferred PHYs for each direction they can be ORed together.
tx_phys = BLE_GAP_PHY_1MBPS | BLE_GAP_PHY_2MBPS;

rx_phys = BLE_GAP_PHY_1MBPS | BLE_GAP_PHY_2MBPS;

Events generated

BLE_GAP_EVT_PHY_UPDATE Result of the PHY Update if initiated by peer.

Relevant Message Sequence Charts

Central PHY Request

Return values

NRF_SUCCESS	Set successfully.
NRF_ERROR_INVALID_PARAM	Invalid parameter(s) supplied.

Field Documentation

uint8_t ble_gap_opt_preferred_phys_t::rx_phys

Preferred receive PHYs, see GAP PHYs.

uint8_t ble_gap_opt_preferred_phys_t::tx_phys

Preferred transmit PHYs, see GAP PHYs.