Struct nrf_softdevice_s122::ble_gap_qos_channel_survey_t

#[repr(C)]
pub struct ble_gap_qos_channel_survey_t {
    pub interval_us: u32,
}

@brief Quality of Service (QoS) channel survey parameters.

@details This can be used with @ref sd_ble_gap_qos_start to start the QoS channel survey module. It is ignored with @ref sd_ble_gap_qos_stop.

@details The channel survey module provides measurements of the energy levels on the Bluetooth Low Energy channels. When the module is enabled, @ref BLE_GAP_EVT_QOS_CHANNEL_SURVEY_REPORT events will periodically report the measured energy levels for each channel.

@note The measurements are scheduled with lower priority than other Bluetooth Low Energy roles, Radio Timeslot API events and Flash API events.

@note The channel survey module will attempt to do measurements so that the average interval between measurements will be interval_us. However due to the channel survey module having the lowest priority of all roles and modules, this may not be possible. In that case fewer than expected channel survey reports may be given.

@note In order to use the channel survey module, @ref ble_gap_cfg_role_count_t::qos_channel_survey_role_available must be set. This is done using @ref sd_ble_cfg_set.

@note The SoftDevice may generate one @ref BLE_GAP_EVT_QOS_CHANNEL_SURVEY_REPORT event after @ref sd_ble_gap_qos_stop is called.

@retval ::NRF_ERROR_INVALID_PARAM Invalid parameter supplied. interval_us is out of the allowed range. @retval ::NRF_ERROR_RESOURCES The channel survey module is not available to the application. Set @ref ble_gap_cfg_role_count_t::qos_channel_survey_role_available using @ref sd_ble_cfg_set.

Fields

interval_us: u32

< Requested average interval for the measurements and reports. See @ref BLE_GAP_QOS_CHANNEL_SURVEY_INTERVALS for valid ranges. If set to @ref BLE_GAP_QOS_CHANNEL_SURVEY_INTERVAL_CONTINUOUS, the channel survey role will be scheduled at every available opportunity.

Trait Implementations

impl Clone for ble_gap_qos_channel_survey_t

fn clone(&self) -> ble_gap_qos_channel_survey_t

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ble_gap_qos_channel_survey_t

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Copy for ble_gap_qos_channel_survey_t