PicoVNA 5 SDK Example Programs

There are three interfaces for programmatically controlling and retrieving data from the PicoVNA instrument:

1. API
2. SCPI
3. Binary data broadcasts (data retrieve only)

This repository contains example programs and links to documentation for each interface. The examples are made available under the MIT License (see LICENSE.txt for terms).

Requirements and obtaining the SDK

The PicoVNA 5 SDK requires a PicoVNA instrument that is compatible with the PicoVNA 5 software. To check if your instrument is compatible, download and run the PicoVNA 5 software. You will have the opportunity to upgrade your instrument using the PicoVNA 5 software if it is not currently compatible. If your PicoVNA instrument is not compatible with the PicoVNA 5 software, you can use the SDK in demonstration mode for evaluation purposes.

To remote control the instrument via SCPI, the PicoVNA 5 software must be installed.

Important

CLICK HERE to download the PicoVNA 5 software (required to control the instrument via SCPI).

To use the API, installing the PicoVNA 5 software is optional. An SDK is available that allows the instrument to be programmatically controlled without the PicoVNA 5 software being installed.

Important

CLICK HERE to download the SDK (language bindings, headers, libraries, driver-only installer, etc.).

Further requirements specific to programming languages can be found within the programming guides for those languages.

API

The API allows the PicoVNA instrument to be controlled directly, without running the PicoVNA 5 software. It is the most programmer-friendly way of controlling the PicoVNA instrument, with useful abstractions and clean syntax. The API is appropriate for system integrators who wish to distribute their own systems that encapsulate the PicoVNA instrument, without needing to also deploy the PicoVNA 5 software. Using the PicoVNA instrument via the API will maximise performance and minimise energy use on the host controller, so is also the most appropriate option for use in embedded systems. It is not possible to control the instrument via the API and the PicoVNA 5 software simultaneously.

Documentation

C++ Programmer's Guide

Python Programmer's Guide

Examples

1. Simple frequency sweep using factory calibration and retrieve data | C++ | Python |
2. Load user calibration and perform frequency sweep | C++ | Python |
3. Time domain transform | C++ | Python |
4. Perform a logarithmic frequency sweep | C++ | Python |
5. Measure after trigger event | C++ | Python |

SCPI

SCPI allows the PicoVNA instrument to be controlled via the PicoVNA 5 software. The PicoVNA 5 software must be running in order to control the PicoVNA instrument via SCPI. SCPI control is most useful in applications where the instrument is being controlled together by both the PicoVNA 5 software and by an external user application. The syntax used for SCPI control will be familiar to users of other test and measurement equipment. SCPI control supports some more complex features of the PicoVNA 5 software that would not be appropriate in the API: for example, importing touchstone data to memory channels. The most simple example of an application where SCPI control is appropriate is: PicoVNA 5 can be used to load a calibration and configure the measurement, and then the external user application can perform the measurement and retrieve data. SCPI commands can also be typed by the user directly into a console, in order to control the application via interactive scripting.

Documentation

SCPI Programmer's Guide

Examples

1. Perform a simple frequency sweep using factory calibration and retrieve all sweep data | Python | MATLAB | LabVIEW |
2. Load user calibration, perform sweep and export all sweep data to a Touchstone file | Python | MATLAB | LabVIEW |

Binary Data Broadcasts

Binary data broadcasts provide a simple way for other applications to extract data from the PicoVNA 5 software in real-time. No programming is required to configure these; data is broadcast using a binary protocol when a measurement is started via the PicoVNA 5 software. These are read-only, and they do not provide a programmatic way to configure measurements (which must be done either via the user interface of the PicoVNA 5 software or via SCPI). Refer to the PicoVNA 5 User Manual for details on how to retrieve data using the binary data broadcasts.