nrf-softdevice-s112

Crates

git

Versions

default

Flavors

pub unsafe fn sd_ble_gap_rssi_start(
conn_handle: u16,
threshold_dbm: u8,
skip_count: u8
) -> u32
Expand description

@brief Start reporting the received signal strength to the application.

    A new event is reported whenever the RSSI value changes, until @ref sd_ble_gap_rssi_stop is called.

@events @event{@ref BLE_GAP_EVT_RSSI_CHANGED, New RSSI data available. How often the event is generated is dependent on the settings of the threshold_dbm and skip_count input parameters.} @endevents

@mscs @mmsc{@ref BLE_GAP_CENTRAL_RSSI_READ_MSC} @mmsc{@ref BLE_GAP_RSSI_FILT_MSC} @endmscs

@param[in] conn_handle Connection handle. @param[in] threshold_dbm Minimum change in dBm before triggering the @ref BLE_GAP_EVT_RSSI_CHANGED event. Events are disabled if threshold_dbm equals @ref BLE_GAP_RSSI_THRESHOLD_INVALID. @param[in] skip_count Number of RSSI samples with a change of threshold_dbm or more before sending a new @ref BLE_GAP_EVT_RSSI_CHANGED event.

@retval ::NRF_SUCCESS Successfully activated RSSI reporting. @retval ::NRF_ERROR_INVALID_STATE RSSI reporting is already ongoing. @retval ::BLE_ERROR_INVALID_CONN_HANDLE Invalid connection handle supplied.