SoapySDR Documentation

The C# bindings for SoapySDR are provided via a SWIG wrapper supplemented with hand-written C# code to ensure the API is idiomatic for traditional C# development.

Platform and Compiler Requirements:

• Compiler: Only supported with MSVC (Microsoft Visual C++).
• Runtime: CMake currently only supports the .NET implementation for C#.
• Note: The bindings include .NET dependencies that are stubbed out in Mono, so Mono is not supported.

To implement support for a new SDR device, you can use the ExampleDriver module as a template. You can either copy the entire directory to start a new CMake build project or integrate it into an existing driver build system as a subdirectory.

To complete the implementation, you must:

1. Customize CMakeLists.txt: Update the build configuration to include your specific driver dependencies.
2. Customize MyDeviceSupport.cpp: Implement the logic required to make calls into your low-level device driver for device configuration and data streaming.

To run the LuaJIT examples provided in this repository, you must install the following Lua dependencies using LuaRocks:

• argparse
• complex
• posix

The SimpleSiggen.py application allows controlling the verbosity and error handling of the underlying SoapySDR logs using two specific CLI flags:

• --debug: Sets the SoapySDR log level to SOAPY_SDR_DEBUG.
• --abort-on-error: Configures the Python log handler to treat SOAPY_SDR_WARNING as an exception level, halting operations if the SDR logs an error.

To capture SoapySDR logs within a Python application and potentially treat specific log levels as exceptions, you can use the set_python_log_handler pattern. This replaces the default SoapySDR log handler with a custom Python function that redirects log text to sys.stderr.

If an exception_level is provided, the handler will raise a SoapyException whenever a log message is received at that level or higher (where lower numerical values represent higher severity, e.g., SOAPY_SDR_ERROR is more severe than SOAPY_SDR_INFO).

The MeasureDelay.py script is a CLI utility that uses SoapySDR Python bindings to measure the round-trip delay through an RF loopback or leakage. It works by transmitting a bandlimited sinc pulse and receiving it back, then calculating the time delta between the transmitted and received peaks.

Requirements:

• The SDR must support hardware-timed streaming (sdr.hasHardwareTime()).
• The script uses numpy for signal processing.

Key Features:

• Configures sample rate, frequency, bandwidth, gain, and antennas for both TX and RX.
• Supports dumping debug samples (normalized TX/RX pulses and raw I/Q data) to a directory for analysis.
• Can be configured to halt if the SDR logs an error using --abort-on-error.

When using a custom Python log handler via set_python_log_handler, the library can be configured to raise a SoapyException. This exception is raised if a log message's severity level is equal to or more severe than the specified exception_level.

class SoapyException(Exception):
    """SoapySDR has logged an error message (or worse)."""
    pass