Struct seify::Device

pub struct Device<T: DeviceTrait + Clone + Any> { /* private fields */ }

Wrapps a driver, implementing the DeviceTrait.

Implements a more ergonomic version of the DeviceTrait, e.g., using Into<Args>, which would not be possible in traits.

Implementations

impl Device<GenericDevice>

pub fn new() -> Result<Self, Error>

Creates a GenericDevice opening the first device discovered through enumerate.

pub fn from_args<A: TryInto<Args>>(args: A) -> Result<Self, Error>

Creates a GenericDevice opening the first device with a given driver, specified in the args or the first device discovered through enumerate that matches the args.

impl<T: DeviceTrait + Clone + Any> Device<T>

pub fn from_impl(dev: T) -> Self

Create a device from the device implementation.

pub fn impl_ref<D: DeviceTrait + Any>(&self) -> Result<&D, Error>

Try to downcast to a given device implementation D, either directly (from Device<D>) or indirectly (from a Device<GenericDevice> that wraps a D).

pub fn impl_mut<D: DeviceTrait + Any>(&mut self) -> Result<&mut D, Error>

Try to downcast mutably to a given device implementation D, either directly (from Device<D>) or indirectly (from a Device<GenericDevice> that wraps a D).

impl<R: RxStreamer + 'static, T: TxStreamer + 'static, D: DeviceTrait<RxStreamer = R, TxStreamer = T> + Clone + 'static> Device<D>

pub fn driver(&self) -> Driver

SDR driver

pub fn id(&self) -> Result<String, Error>

Identifier for the device, e.g., its serial.

pub fn info(&self) -> Result<Args, Error>

Device info that can be displayed to the user.

pub fn num_channels(&self, direction: Direction) -> Result<usize, Error>

Number of supported Channels.

pub fn full_duplex( &self, direction: Direction, channel: usize, ) -> Result<bool, Error>

Full Duplex support.

pub fn rx_streamer(&self, channels: &[usize]) -> Result<R, Error>

Create an RX streamer.

pub fn rx_streamer_with_args( &self, channels: &[usize], args: Args, ) -> Result<R, Error>

Create an RX streamer, using args.

pub fn tx_streamer(&self, channels: &[usize]) -> Result<T, Error>

Create a TX Streamer.

pub fn tx_streamer_with_args( &self, channels: &[usize], args: Args, ) -> Result<T, Error>

Create a TX Streamer, using args.

pub fn antennas( &self, direction: Direction, channel: usize, ) -> Result<Vec<String>, Error>

List of available antenna ports.

pub fn antenna( &self, direction: Direction, channel: usize, ) -> Result<String, Error>

Currently used antenna port.

pub fn set_antenna( &self, direction: Direction, channel: usize, name: &str, ) -> Result<(), Error>

Set antenna port.

pub fn supports_agc( &self, direction: Direction, channel: usize, ) -> Result<bool, Error>

Does the device support automatic gain control?

pub fn enable_agc( &self, direction: Direction, channel: usize, agc: bool, ) -> Result<(), Error>

Enable or disable automatic gain control.

pub fn agc(&self, direction: Direction, channel: usize) -> Result<bool, Error>

Returns true, if automatic gain control is enabled

pub fn gain_elements( &self, direction: Direction, channel: usize, ) -> Result<Vec<String>, Error>

List of available gain elements.

Elements should be in order RF to baseband.

pub fn set_gain( &self, direction: Direction, channel: usize, gain: f64, ) -> Result<(), Error>

Set the overall amplification in a chain.

The gain will be distributed automatically across available elements.

gain: the new amplification value in dB

pub fn gain( &self, direction: Direction, channel: usize, ) -> Result<Option<f64>, Error>

Get the overall value of the gain elements in a chain in dB.

pub fn gain_range( &self, direction: Direction, channel: usize, ) -> Result<Range, Error>

Get the overall Range of possible gain values.

pub fn set_gain_element( &self, direction: Direction, channel: usize, name: &str, gain: f64, ) -> Result<(), Error>

Set the value of a amplification element in a chain.

Arguments

• name: the name of an amplification element from Device::list_gains
• gain: the new amplification value in dB

pub fn gain_element( &self, direction: Direction, channel: usize, name: &str, ) -> Result<Option<f64>, Error>

Get the value of an individual amplification element in a chain in dB.

pub fn gain_element_range( &self, direction: Direction, channel: usize, name: &str, ) -> Result<Range, Error>

Get the range of possible gain values for a specific element.

pub fn frequency_range( &self, direction: Direction, channel: usize, ) -> Result<Range, Error>

Get the ranges of overall frequency values.

pub fn frequency( &self, direction: Direction, channel: usize, ) -> Result<f64, Error>

Get the overall center frequency of the chain.

• For RX, this specifies the down-conversion frequency.
• For TX, this specifies the up-conversion frequency.

Returns the center frequency in Hz.

pub fn set_frequency( &self, direction: Direction, channel: usize, frequency: f64, ) -> Result<(), Error>

Set the center frequency of the chain.

• For RX, this specifies the down-conversion frequency.
• For TX, this specifies the up-conversion frequency.

The default implementation of set_frequency will tune the “RF” component as close as possible to the requested center frequency in Hz. Tuning inaccuracies will be compensated for with the “BB” component.

pub fn set_frequency_with_args( &self, direction: Direction, channel: usize, frequency: f64, args: Args, ) -> Result<(), Error>

Like set_frequency but using args to augment the tuning algorithm.

• Use "OFFSET" to specify an “RF” tuning offset, usually with the intention of moving the LO out of the passband. The offset will be compensated for using the “BB” component.
• Use the name of a component for the key and a frequency in Hz as the value (any format) to enforce a specific frequency. The other components will be tuned with compensation to achieve the specified overall frequency.
• Use the name of a component for the key and the value "IGNORE" so that the tuning algorithm will avoid altering the component.
• Vendor specific implementations can also use the same args to augment tuning in other ways such as specifying fractional vs integer N tuning.

pub fn frequency_components( &self, direction: Direction, channel: usize, ) -> Result<Vec<String>, Error>

List available tunable elements in the chain.

Elements should be in order RF to baseband.

pub fn component_frequency_range( &self, direction: Direction, channel: usize, name: &str, ) -> Result<Range, Error>

Get the range of tunable values for the specified element.

pub fn component_frequency( &self, direction: Direction, channel: usize, name: &str, ) -> Result<f64, Error>

Get the frequency of a tunable element in the chain.

pub fn set_component_frequency( &self, direction: Direction, channel: usize, name: &str, frequency: f64, ) -> Result<(), Error>

Tune the center frequency of the specified element.

• For RX, this specifies the down-conversion frequency.
• For TX, this specifies the up-conversion frequency.

pub fn sample_rate( &self, direction: Direction, channel: usize, ) -> Result<f64, Error>

Get the baseband sample rate of the chain in samples per second.

pub fn set_sample_rate( &self, direction: Direction, channel: usize, rate: f64, ) -> Result<(), Error>

Set the baseband sample rate of the chain in samples per second.

pub fn get_sample_rate_range( &self, direction: Direction, channel: usize, ) -> Result<Range, Error>

Get the range of possible baseband sample rates.

Trait Implementations

impl<T: Clone + DeviceTrait + Clone + Any> Clone for Device<T>

fn clone(&self) -> Device<T>

Returns a copy of the value.

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

Performs copy-assignment from source.