Struct aaronia_rtsa::Device

pub struct Device { /* private fields */ }

A device, created through the ApiHandle.

The typical life-cycle of a device is:

• Create with ApiHandle
• Device::open()
• Configure with Device::set(), Device::set_int(), and Device::set_float()
• Device::connect()
• Device::start()
• Device::stop()
• Device::disconnect()
• Device::close()

Implementations

impl Device

pub fn open(&mut self) -> Result

Open the Device for exclusive use.

This allocates the required data structures and prepares the configuration settings, but will not access the hardware.

pub fn close(&mut self) -> Result

Close the Device for exclusive use.

pub fn connect(&mut self) -> Result

Connect to the Device.

pub fn disconnect(&mut self) -> Result

Disconnect from the Device.

pub fn start(&mut self) -> Result

Start data acqusition from the Device] / data transmission to the [Device`.

pub fn stop(&mut self) -> Result

Stop data acqusition from the Device / data transmission to the Device.

pub fn state(&mut self) -> Result<DeviceState, Error>

Get DeviceState from the Device.

pub fn get<S: AsRef<str>>(&mut self, path: S) -> Result<ConfigItem, Error>

Get Device configuration parameter.

pub fn set<S1: AsRef<str>, S2: AsRef<str>>(
    &mut self,
    path: S1,
    value: S2
) -> Result

Set Device configuration parameter as string.

pub fn set_float<S1: AsRef<str>, F: Into<f64>>(
    &mut self,
    path: S1,
    value: F
) -> Result

Set Device configuration parameter as float.

pub fn set_int<S1: AsRef<str>, F: Into<i64>>(
    &mut self,
    path: S1,
    value: F
) -> Result

Set Device configuration parameter as integer.

pub fn packets_avail(&mut self, chan: i32) -> Result<usize, Error>

Query Packet queue of Device data channel.

pub fn packet(&mut self, chan: i32) -> Result<Packet, Error>

Get Packet from the Device.

This call is blocking, polling the queue every 5ms, in case it is empty.

pub fn try_packet(&mut self, chan: i32) -> Result<Packet, Error>

Try to get a Packet from the Device data channel.

This call is non-blocking.

pub fn send_packet(&mut self, chan: i32, packet: &Packet) -> Result

Send a Packet to the Device data channel.

pub fn consume(&mut self, chan: i32) -> Result

Consume a Packet from a Device data channel.

pub fn clock(&mut self) -> Result<f64, Error>

Get Device clock time.

pub fn print_config(&mut self) -> Result

Print the Device configuration parameter tree.

pub fn print_health(&mut self) -> Result

Print the Device health parameter tree.

Trait Implementations

impl Debug for Device

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

Formats the value using the given formatter.

impl Drop for Device

fn drop(&mut self)

Executes the destructor for this type.