Crate pico_sdk

Unofficial Rust bindings and wrappers for Pico Technology oscilloscope drivers

This is a meta-crate re-exporting functionality from a number of sub-crates. These crates expose common, high-performance, high-level APIs that hide the differences between the numerous Pico drivers.

	Crate	Description
pico-common		Common enums, structs and traits.
pico-driver		Dynamic loading and both unsafe and safe wrappers for Pico drivers. This is the only crate with unsafe code.
pico-download		Download missing drivers on any platform.
pico-device		Device abstraction over PicoDriver. Detects available channels and valid ranges.
pico-enumeration		Cross driver device enumeration. Detects devices via USB Vendor ID and only loads the required drivers.
pico-streaming		Implements continuous gap-less streaming on top of PicoDevice.

Tests

Some tests open and stream from devices and these fail if devices are not available, for example when run in CI. To run these tests, ensure that ignored tests are run too:

cargo test -- --ignored

Examples

There are a number of examples which demonstrate how the wrappers can be used

cargo run --example streaming_cli

Displays an interactive command line interface that allows selection of device, channel configuration and sample rate. Once capturing, the streaming rate is displayed along with channel values.

cargo run --example enumerate

Attempts to enumerate devices and downloads drivers which were not found in the cache location.

cargo run --example open <driver> <serial>

Loads the specified driver and attempts open the optionally specified device serial.

Usage Examples

Opening and configuring a specific ps2000 device as a PicoDevice:

use pico_sdk::prelude::*;

let driver = Driver::PS2000.try_load()?;
let device = PicoDevice::try_load(&driver, Some("ABC/123"))?;
device.enable_channel(PicoChannel::A, PicoRange::X1_PROBE_2V, PicoCoupling::DC);

Enumerate all required Pico oscilloscope drivers, configure the first device that's returned and stream gap-less data from it:

use pico_sdk::prelude::*;

let enumerator = DeviceEnumerator::new();
// Enumerate, ignore all failures and get the first device
let device = enumerator
                .enumerate()
                .into_iter()
                .flatten()
                .next()
                .expect("No device found");

// Enable and configure 2 channels
device.enable_channel(PicoChannel::A, PicoRange::X1_PROBE_2V, PicoCoupling::DC);
device.enable_channel(PicoChannel::B, PicoRange::X1_PROBE_1V, PicoCoupling::AC);

// Get a streaming device
let stream_device = device.to_streaming_device();

// Subscribe to streaming events on a background thread
let _stream_subscription = stream_device
    .events
    .subscribe_on_thread(Box::new(move |event| {
        // Handle the data event
        if let StreamingEvent::Data { length, samples_per_second, channels } = event
        {
            // Do something with channel data
        }
    }));

// Start streaming with 1k sample rate
stream_device.start(1_000)?;

Enumerate all required Pico oscilloscope drivers. If a device is found but no matching driver is available, attempt to download missing drivers and try enumerating again:

use pico_sdk::prelude::*;

let enumerator = DeviceEnumerator::with_resolution(cache_resolution());

loop {
    let results = enumerator.enumerate();

    println!("{:#?}", results);

    let missing_drivers = results.missing_drivers();

    if !missing_drivers.is_empty() {
        download_drivers_to_cache(&missing_drivers)?;
    } else {
        break;
    }
}

Modules

common	Common enums, structs and traits
device	Device abstraction that uses Pico drivers
download	Downloads Pico driver binaries for your platform
driver	Dynamic loading, unsafe and safe wrappers for Pico drivers
enumeration	Enumerates connected Pico devices from all supported drivers
prelude
streaming	Implements gap-less streaming on top of PicoDevice