Enum EnergyScanRequest

pub enum EnergyScanRequest {
    StartEnergyScan {
        params: EnergyScanParameters,
        stream: ServerEnd<EnergyScanResultStreamMarker>,
        control_handle: EnergyScanControlHandle,
    },
}

Variants

StartEnergyScan

Starts an energy scan operation.

This can be used for surveying the spectrum to identify channels that should be avoided.

The scan operation may be cancelled by closing the stream protocol.

If a scan is started while another scan is in progress, the previous scan is allowed to complete before the new scan executes and starts returning results.

All scans should be expected to completely occupy the LoWPAN device while it is in progress, preventing other operations from completing until the scan has completed. Additionally, all network packets should be expected to be dropped while a scan is in progress.

Performing energy scans could be used to profile the spectrum energy for a location and thus be used to determine or refine coarse location information.

Fields

params: EnergyScanParameters

stream: ServerEnd<EnergyScanResultStreamMarker>

control_handle: EnergyScanControlHandle

Implementations

impl EnergyScanRequest

pub fn into_start_energy_scan( self, ) -> Option<(EnergyScanParameters, ServerEnd<EnergyScanResultStreamMarker>, EnergyScanControlHandle)>

pub fn method_name(&self) -> &'static str

Name of the method defined in FIDL

Trait Implementations

impl Debug for EnergyScanRequest

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

Formats the value using the given formatter.