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.

Sub Crates

• ### pico-common Common enums, structs and traits.
• ### pico-sys-dynamic Dynamically loaded unsafe bindings for every Pico oscilloscope driver. This crate contains unsafe code.
• ### pico-driver Common, safe wrappers implementing the PicoDriver trait. This crate contains unsafe code.
• ### pico-download Download missing drivers on any platform.
• ### pico-device Device abstraction over PicoDriver trait. 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.

Prerequisites

pico-driver uses a C library called libffi to call into older Pico drivers that don't allow us to pass context through callbacks. To build this you will need a working C compiler and on Unix based platforms you'll also require automake, and autoconf.

On linux pico-enumeration requires libudev-dev.

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: ```rust use std::sync::Arc; use pico_sdk::prelude::*;

let driver = Driver::PS2000.tryload()?; let device = PicoDevice::tryopen(&driver, Some("ABC/123"))?; ```

Enumerate all required Pico oscilloscope drivers, configure the first device that's returned and stream gap-less data from it: ```rust use std::sync::Arc; use pico_sdk::prelude::*;

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

let device = enum_device.open()?;

// Get a streaming device let streamdevice = device.intostreaming_device();

// Enable and configure 2 channels streamdevice.enablechannel(PicoChannel::A, PicoRange::X1PROBE2V, PicoCoupling::DC); streamdevice.enablechannel(PicoChannel::B, PicoRange::X1PROBE1V, PicoCoupling::AC);

struct StdoutHandler;

impl NewDataHandler for StdoutHandler { fn handle_event(&self, event: &StreamingEvent) { println!("Sample count: {}", event.length); } }

// When handler goes out of scope, the subscription is dropped let handler = Arc::new(StdoutHandler);

// Subscribe to streaming events streamdevice.newdata.subscribe(handler.clone());

// Start streaming with 1k sample rate streamdevice.start(1000)?; ```

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: ```rust use pico_sdk::prelude::*;

let enumerator = DeviceEnumerator::withresolution(cacheresolution());

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;
}

} ```

License: MIT