nrf-softdevice-s113

Crates

git

Versions

default

Flavors

pub unsafe fn sd_ble_gap_tx_power_set(role: u8, handle: u16, tx_power: i8) -> u32
Expand description

@brief Set the radio’s transmit power.

@param[in] role The role to set the transmit power for, see @ref BLE_GAP_TX_POWER_ROLES for possible roles. @param[in] handle The handle parameter is interpreted depending on role: - If role is @ref BLE_GAP_TX_POWER_ROLE_CONN, this value is the specific connection handle. - If role is @ref BLE_GAP_TX_POWER_ROLE_ADV, the advertising set identified with the advertising handle, will use the specified transmit power, and include it in the advertising packet headers if @ref ble_gap_adv_properties_t::include_tx_power set. - For all other roles handle is ignored. @param[in] tx_power Radio transmit power in dBm (see note for accepted values).

@note Supported tx_power values: -40dBm, -20dBm, -16dBm, -12dBm, -8dBm, -4dBm, 0dBm, +3dBm and +4dBm. @note The initiator will have the same transmit power as the scanner. @note When a connection is created it will inherit the transmit power from the initiator or advertiser leading to the connection.

@retval ::NRF_SUCCESS Successfully changed the transmit power. @retval ::NRF_ERROR_INVALID_PARAM Invalid parameter(s) supplied. @retval ::BLE_ERROR_INVALID_ADV_HANDLE Advertising handle not found. @retval ::BLE_ERROR_INVALID_CONN_HANDLE Invalid connection handle supplied.