Struct saleae::client::Client

pub struct Client { /* fields omitted */ }

Main interface for communication to Saleae Logic

Implementations

impl Client

Constructor

pub fn new(connection: Connection) -> Result<Self>

constructor

impl Client

Interface for setting and getting Logic information

pub fn set_num_samples(&mut self, num: u32) -> Result<bool>

Set a trigger of channels TODO create trigger methods/structs/tests

pub fn get_num_samples(&mut self) -> Result<u32>

pub fn set_capture_seconds(&mut self, seconds: f32) -> Result<bool>

Set the capture duration to a length of time

pub fn set_sample_rate(&mut self, rate: &SampleRate) -> Result<bool>

Set sample rate of saleae

Note: Make sure to run get_all_sample_rates and set it from a available sample rate

pub fn get_sample_rate(&mut self) -> Result<SampleRate>

pub fn get_all_sample_rates(&mut self) -> Result<Vec<SampleRate>>

pub fn get_performance(&mut self) -> Result<u8>

Return current performance level of Logic

pub fn set_performance(&mut self, perf: PerformanceOption) -> Result<bool>

Set the performance value, controlling the USB traffic and quality

pub fn get_connected_devices(&mut self) -> Result<Vec<ConnectedDevice>>

Return current connected devices of Logic

pub fn select_active_device(&mut self, device: ConnectedDevice) -> Result<bool>

Find index of device from the list of devices connected to Saleae

Get current index of connected devices and find equal device to parameter. Send that device as active device to logic.

Note: Indices start at 1, not 0 TODO: test with multiple saleae

pub fn get_active_device(&mut self) -> Result<ConnectedDevice>

Return current active device of Logic

pub fn get_active_channels(&mut self) -> Result<Vec<Vec<u8>>>

Parse the get active channels command into tuples of digital and analog channels that are current

pub fn set_active_channels(
    &mut self,
    digital_channels: &[u8],
    analog_channels: &[u8]
) -> Result<bool>

Set the active channels for the Logic program

Example

TODO add get_active_channels

pub fn reset_active_channels(&mut self) -> Result<bool>

Reset Active Channel

pub fn start_capture(&mut self) -> Result<bool>

Start Capture, without wating for ack/nack

pub fn start_capture_block_until_finished(&mut self) -> Result<bool>

Start Capture, then wait until ack

pub fn is_processing_complete(&mut self) -> Result<bool>

Check if processing is complete

pub fn stop_capture(&mut self) -> Result<bool>

Stop the saleae capture

pub fn close_all_tabs(&mut self) -> Result<bool>

Close all tabs

Trait Implementations

impl Debug for Client

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

Formats the value using the given formatter.