Enum DeviceExtraRequest

pub enum DeviceExtraRequest {
    FormNetwork {
        params: ProvisioningParams,
        progress: ServerEnd<ProvisioningMonitorMarker>,
        control_handle: DeviceExtraControlHandle,
    },
    JoinNetwork {
        params: JoinParams,
        progress: ServerEnd<ProvisioningMonitorMarker>,
        control_handle: DeviceExtraControlHandle,
    },
    StartNetworkScan {
        params: NetworkScanParameters,
        stream: ServerEnd<BeaconInfoStreamMarker>,
        control_handle: DeviceExtraControlHandle,
    },
}

LoWPAN Device “Extra” Protocol, Experimental Methods.

This protocol provides clients with a way to control and monitor aspects of the LoWPAN device that can, either directly or indirectly, leak PII or cryptographic keys.

Variants

FormNetwork

Forms a new network with the given provisioning parameters.

Any unspecified fields that are required by the underlying device or network type will assigned with default values. If the credential is unspecified, a random one will be generated automatically.

This method will cause the device to leave any previously provisioned network.

Calling this method while the device is not active will implicitly make the device active.

Upon success, the device will be active and provisioned for the newly created network.

The progress of the operation can be monitored via the ProvisioningMonitor protocol instance. The operation may be cancelled by closing the ProvisioningMonitor.

Calling this method will cause any current form, join, or commission operation to be canceled.

Fields

params: ProvisioningParams

progress: ServerEnd<ProvisioningMonitorMarker>

control_handle: DeviceExtraControlHandle

JoinNetwork

Attempts to join a pre-existing nearby network with the given provisioning parameters or joiner parameters.

In-band commissioning is supported.

Upon success, the device will be active and provisioned for the newly created network.

The progress of the operation can be monitored via the ProvisioningMonitor protocol instance. The operation may be cancelled by closing the ProvisioningMonitor.

Calling this method will cause any current form, join, or commission operation to be canceled.

Fields

params: JoinParams

progress: ServerEnd<ProvisioningMonitorMarker>

control_handle: DeviceExtraControlHandle

StartNetworkScan

Starts an active network scan operation.

This scan is used to identify other nearby networks in order 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.

A [BeaconInfoStream] instance could be used to expose coarse location information.

Fields

params: NetworkScanParameters

stream: ServerEnd<BeaconInfoStreamMarker>

control_handle: DeviceExtraControlHandle

Implementations

impl DeviceExtraRequest

pub fn into_form_network( self, ) -> Option<(ProvisioningParams, ServerEnd<ProvisioningMonitorMarker>, DeviceExtraControlHandle)>

pub fn into_join_network( self, ) -> Option<(JoinParams, ServerEnd<ProvisioningMonitorMarker>, DeviceExtraControlHandle)>

pub fn into_start_network_scan( self, ) -> Option<(NetworkScanParameters, ServerEnd<BeaconInfoStreamMarker>, DeviceExtraControlHandle)>

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

Name of the method defined in FIDL

Trait Implementations

impl Debug for DeviceExtraRequest

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

Formats the value using the given formatter.