Crate soapysdr_sys 

This crate provides bindings for the SoapySDR C API. See its header file for API documentation.

Structs

SoapySDRArgInfo

Definition for argument info

SoapySDRDevice

SoapySDRKwargs

Definition for a key/value string map

SoapySDRRange

Definition for a min/max numeric range

SoapySDRStream

Constants

SOAPY_SDR_ARG_INFO_BOOL

SOAPY_SDR_ARG_INFO_FLOAT

SOAPY_SDR_ARG_INFO_INT

SOAPY_SDR_ARG_INFO_STRING

SOAPY_SDR_CF32

SOAPY_SDR_CF64

SOAPY_SDR_CORRUPTION

SOAPY_SDR_CRITICAL

A critical error. The application might not be able to continue running successfully.

SOAPY_SDR_CS4

SOAPY_SDR_CS8

SOAPY_SDR_CS12

SOAPY_SDR_CS16

SOAPY_SDR_CS32

SOAPY_SDR_CU4

SOAPY_SDR_CU8

SOAPY_SDR_CU12

SOAPY_SDR_CU16

SOAPY_SDR_CU32

SOAPY_SDR_DEBUG

A debugging message.

SOAPY_SDR_END_ABRUPT

SOAPY_SDR_END_BURST

SOAPY_SDR_ERROR

An error. An operation did not complete successfully, but the application as a whole is not affected.

SOAPY_SDR_F32

SOAPY_SDR_F64

SOAPY_SDR_FALSE

SOAPY_SDR_FATAL

A fatal error. The application will most likely terminate. This is the highest priority.

SOAPY_SDR_HAS_TIME

SOAPY_SDR_INFO

An informational message, usually denoting the successful completion of an operation.

SOAPY_SDR_MORE_FRAGMENTS

SOAPY_SDR_NOTICE

A notice, which is an information with just a higher priority.

SOAPY_SDR_NOT_SUPPORTED

SOAPY_SDR_ONE_PACKET

SOAPY_SDR_OVERFLOW

SOAPY_SDR_RX

SOAPY_SDR_S8

SOAPY_SDR_S16

SOAPY_SDR_S32

SOAPY_SDR_SSI

Streaming status indicators such as “U” (underflow) and “O” (overflow).

SOAPY_SDR_STREAM_ERROR

SOAPY_SDR_TIMEOUT

SOAPY_SDR_TIME_ERROR

SOAPY_SDR_TRACE

A tracing message. This is the lowest priority.

SOAPY_SDR_TRUE

SOAPY_SDR_TX

SOAPY_SDR_U8

SOAPY_SDR_U16

SOAPY_SDR_U32

SOAPY_SDR_UNDERFLOW

SOAPY_SDR_USER_FLAG0

SOAPY_SDR_USER_FLAG1

SOAPY_SDR_USER_FLAG2

SOAPY_SDR_USER_FLAG3

SOAPY_SDR_USER_FLAG4

SOAPY_SDR_WAIT_TRIGGER

SOAPY_SDR_WARNING

A warning. An operation completed with an unexpected result.

Functions

SoapySDRArgInfoList_clear^⚠

Clear a list of argument info structures.

SoapySDRArgInfo_clear^⚠

Clear the contents of a argument info structure.

SoapySDRDevice_acquireReadBuffer^⚠

Acquire direct buffers from a receive stream.

SoapySDRDevice_acquireWriteBuffer^⚠

Acquire direct buffers from a transmit stream.

SoapySDRDevice_activateStream^⚠

Activate a stream.

SoapySDRDevice_closeStream^⚠

Close an open stream created by setupStream

SoapySDRDevice_deactivateStream^⚠

Deactivate a stream.

SoapySDRDevice_enumerate^⚠

Enumerate a list of available devices on the system.

SoapySDRDevice_enumerateStrArgs^⚠

Enumerate a list of available devices on the system.

SoapySDRDevice_getAntenna^⚠

Get the selected antenna on a chain.

SoapySDRDevice_getBandwidth^⚠

Get the baseband filter width of the chain.

SoapySDRDevice_getBandwidthRange^⚠

Get the range of possible baseband filter widths.

SoapySDRDevice_getChannelInfo^⚠

Get channel info given the streaming direction

SoapySDRDevice_getChannelSensorInfo^⚠

Get meta-information about a channel sensor.

SoapySDRDevice_getChannelSettingInfo^⚠

Describe the allowed keys and values used for channel settings.

SoapySDRDevice_getChannelSettingInfoWithKey^⚠

Get information on a specific channel setting.

SoapySDRDevice_getClockSource^⚠

Get the clock source of the device

SoapySDRDevice_getDCOffset^⚠

Get the frontend DC offset correction.

SoapySDRDevice_getDCOffsetMode^⚠

Get the automatic DC offset corrections mode.

SoapySDRDevice_getDirectAccessBufferAddrs^⚠

Get the buffer addresses for a scatter/gather table entry.

SoapySDRDevice_getDriverKey^⚠

A key that uniquely identifies the device driver.

SoapySDRDevice_getFrequency^⚠

Get the overall center frequency of the chain.

SoapySDRDevice_getFrequencyArgsInfo^⚠

Query the argument info description for tune args.

SoapySDRDevice_getFrequencyComponent^⚠

Get the frequency of a tunable element in the chain.

SoapySDRDevice_getFrequencyCorrection^⚠

Get the frontend frequency correction value.

SoapySDRDevice_getFrequencyRange^⚠

Get the range of overall frequency values.

SoapySDRDevice_getFrequencyRangeComponent^⚠

Get the range of tunable values for the specified element.

SoapySDRDevice_getFrontendMapping^⚠

Get the mapping configuration string.

SoapySDRDevice_getFullDuplex^⚠

Find out if the specified channel is full or half duplex.

SoapySDRDevice_getGain^⚠

Get the overall value of the gain elements in a chain.

SoapySDRDevice_getGainElement^⚠

Get the value of an individual amplification element in a chain.

SoapySDRDevice_getGainElementRange^⚠

Get the range of possible gain values for a specific element.

SoapySDRDevice_getGainMode^⚠

Get the automatic gain mode on the chain.

SoapySDRDevice_getGainRange^⚠

Get the overall range of possible gain values.

SoapySDRDevice_getHardwareInfo^⚠

Query a dictionary of available device information.

SoapySDRDevice_getHardwareKey^⚠

A key that uniquely identifies the hardware.

SoapySDRDevice_getHardwareTime^⚠

Read the time from the hardware clock on the device.

SoapySDRDevice_getIQBalance^⚠

Get the frontend IQ balance correction.

SoapySDRDevice_getIQBalanceMode^⚠

Get the automatic frontend IQ balance corrections mode.

SoapySDRDevice_getMasterClockRate^⚠

Get the master clock rate of the device.

SoapySDRDevice_getMasterClockRates^⚠

Get the range of available master clock rates.

SoapySDRDevice_getNativeDeviceHandle^⚠

A handle to the native device used by the driver.

SoapySDRDevice_getNativeStreamFormat^⚠

Get the hardware’s native stream format for this channel.

SoapySDRDevice_getNumChannels^⚠

Get a number of channels given the streaming direction

SoapySDRDevice_getNumDirectAccessBuffers^⚠

How many direct access buffers can the stream provide?

SoapySDRDevice_getReferenceClockRate^⚠

Get the reference clock rate of the device.

SoapySDRDevice_getReferenceClockRates^⚠

Get the range of available reference clock rates.

SoapySDRDevice_getSampleRate^⚠

Get the baseband sample rate of the chain.

SoapySDRDevice_getSampleRateRange^⚠

Get the range of possible baseband sample rates.

SoapySDRDevice_getSensorInfo^⚠

Get meta-information about a sensor.

SoapySDRDevice_getSettingInfo^⚠

Describe the allowed keys and values used for settings.

SoapySDRDevice_getSettingInfoWithKey^⚠

Get information on a specific setting.

SoapySDRDevice_getStreamArgsInfo^⚠

Query the argument info description for stream args.

SoapySDRDevice_getStreamFormats^⚠

Query a list of the available stream formats.

SoapySDRDevice_getStreamMTU^⚠

Get the stream’s maximum transmission unit (MTU) in number of elements.

SoapySDRDevice_getTimeSource^⚠

Get the time source of the device

SoapySDRDevice_hasDCOffset^⚠

Does the device support frontend DC offset correction?

SoapySDRDevice_hasDCOffsetMode^⚠

Does the device support automatic DC offset corrections?

SoapySDRDevice_hasFrequencyCorrection^⚠

Does the device support frontend frequency correction?

SoapySDRDevice_hasGainMode^⚠

Does the device support automatic gain control?

SoapySDRDevice_hasHardwareTime^⚠

Does this device have a hardware clock?

SoapySDRDevice_hasIQBalance^⚠

Does the device support frontend IQ balance correction?

SoapySDRDevice_hasIQBalanceMode^⚠

Does the device support automatic frontend IQ balance correction?

SoapySDRDevice_lastError^⚠

Get the last error message after a device call fails.

SoapySDRDevice_lastStatus^⚠

Get the last status code after a Device API call.

SoapySDRDevice_listAntennas^⚠

Get a list of available antennas to select on a given chain.

SoapySDRDevice_listBandwidths^⚠

Get the range of possible baseband filter widths.

SoapySDRDevice_listChannelSensors^⚠

List the available channel readback sensors.

SoapySDRDevice_listClockSources^⚠

Get the list of available clock sources.

SoapySDRDevice_listFrequencies^⚠

List available tunable elements in the chain.

SoapySDRDevice_listGPIOBanks^⚠

Get a list of available GPIO banks by name.

SoapySDRDevice_listGains^⚠

List available amplification elements.

SoapySDRDevice_listRegisterInterfaces^⚠

Get a list of available register interfaces by name.

SoapySDRDevice_listSampleRates^⚠

Get the range of possible baseband sample rates.

SoapySDRDevice_listSensors^⚠

List the available global readback sensors.

SoapySDRDevice_listTimeSources^⚠

Get the list of available time sources.

SoapySDRDevice_listUARTs^⚠

Enumerate the available UART devices.

SoapySDRDevice_make^⚠

Make a new Device object given device construction args.

SoapySDRDevice_makeStrArgs^⚠

Make a new Device object given device construction args.

SoapySDRDevice_make_list^⚠

Create a list of devices from a list of construction arguments.

SoapySDRDevice_make_listStrArgs^⚠

Create a list of devices from a list of construction arguments.

SoapySDRDevice_readChannelSensor^⚠

Readback a channel sensor given the name.

SoapySDRDevice_readChannelSetting^⚠

Read an arbitrary channel setting on the device.

SoapySDRDevice_readGPIO^⚠

Readback the value of a GPIO bank.

SoapySDRDevice_readGPIODir^⚠

Read the data direction of a GPIO bank.

SoapySDRDevice_readI2C^⚠

Read from an available I2C slave.

SoapySDRDevice_readRegister^⚠

Read a register on the device given the interface name.

SoapySDRDevice_readRegisters^⚠

Read a memory block on the device given the interface name.

SoapySDRDevice_readSensor^⚠

Readback a global sensor given the name.

SoapySDRDevice_readSetting^⚠

Read an arbitrary setting on the device.

SoapySDRDevice_readStream^⚠

Read elements from a stream for reception.

SoapySDRDevice_readStreamStatus^⚠

Readback status information about a stream.

SoapySDRDevice_readUART^⚠

Read bytes from a UART until timeout or newline.

SoapySDRDevice_releaseReadBuffer^⚠

Release an acquired buffer back to the receive stream.

SoapySDRDevice_releaseWriteBuffer^⚠

Release an acquired buffer back to the transmit stream.

SoapySDRDevice_setAntenna^⚠

Set the selected antenna on a chain.

SoapySDRDevice_setBandwidth^⚠

Set the baseband filter width of the chain.

SoapySDRDevice_setClockSource^⚠

Set the clock source on the device

SoapySDRDevice_setCommandTime^⚠

Set the time of subsequent configuration calls.

SoapySDRDevice_setDCOffset^⚠

Set the frontend DC offset correction.

SoapySDRDevice_setDCOffsetMode^⚠

Set the automatic DC offset corrections mode.

SoapySDRDevice_setFrequency^⚠

Set the center frequency of the chain.

SoapySDRDevice_setFrequencyComponent^⚠

Tune the center frequency of the specified element.

SoapySDRDevice_setFrequencyCorrection^⚠

Fine tune the frontend frequency correction.

SoapySDRDevice_setFrontendMapping^⚠

Set the frontend mapping of available DSP units to RF frontends.

SoapySDRDevice_setGain^⚠

Set the overall amplification in a chain.

SoapySDRDevice_setGainElement^⚠

Set the value of a amplification element in a chain.

SoapySDRDevice_setGainMode^⚠

Set the automatic gain mode on the chain.

SoapySDRDevice_setHardwareTime^⚠

Write the time to the hardware clock on the device.

SoapySDRDevice_setIQBalance^⚠

Set the frontend IQ balance correction.

SoapySDRDevice_setIQBalanceMode^⚠

Set the automatic frontend IQ balance correction.

SoapySDRDevice_setMasterClockRate^⚠

Set the master clock rate of the device.

SoapySDRDevice_setReferenceClockRate^⚠

Set the reference clock rate of the device.

SoapySDRDevice_setSampleRate^⚠

Set the baseband sample rate of the chain.

SoapySDRDevice_setTimeSource^⚠

Set the time source on the device

SoapySDRDevice_setupStream^⚠

Initialize a stream given a list of channels and stream arguments.

SoapySDRDevice_transactSPI^⚠

Perform a SPI transaction and return the result.

SoapySDRDevice_unmake^⚠

Unmake or release a device object handle.

SoapySDRDevice_unmake_list^⚠

Unmake or release a list of device handles

SoapySDRDevice_writeChannelSetting^⚠

Write an arbitrary channel setting on the device.

SoapySDRDevice_writeGPIO^⚠

Write the value of a GPIO bank.

SoapySDRDevice_writeGPIODir^⚠

Write the data direction of a GPIO bank.

SoapySDRDevice_writeGPIODirMasked^⚠

Write the data direction of a GPIO bank with modification mask.

SoapySDRDevice_writeGPIOMasked^⚠

Write the value of a GPIO bank with modification mask.

SoapySDRDevice_writeI2C^⚠

Write to an available I2C slave.

SoapySDRDevice_writeRegister^⚠

Write a register on the device given the interface name.

SoapySDRDevice_writeRegisters^⚠

Write a memory block on the device given the interface name.

SoapySDRDevice_writeSetting^⚠

Write an arbitrary setting on the device.

SoapySDRDevice_writeStream^⚠

Write elements to a stream for transmission.

SoapySDRDevice_writeUART^⚠

Write data to a UART device.

SoapySDRKwargsList_clear^⚠

Clear a list of kwargs structures.

SoapySDRKwargs_clear^⚠

Clear the contents of a kwargs structure.

SoapySDRKwargs_fromString^⚠

Convert a markup string to a key-value map.

SoapySDRKwargs_get^⚠

Get a value given a key in a kwargs structure.

SoapySDRKwargs_set^⚠

Set a key/value pair in a kwargs structure.

SoapySDRKwargs_toString^⚠

Convert a key-value map to a markup string.

SoapySDRStrings_clear^⚠

Clear the contents of a list of string

SoapySDR_errToStr^⚠

Convert a error code to a string for printing purposes.

SoapySDR_formatToSize^⚠

Get the size of a single element in the specified format.

SoapySDR_free^⚠

Free a pointer allocated by SoapySDR.

SoapySDR_getABIVersion^⚠

Get the ABI version string that the library was built against.

SoapySDR_getAPIVersion^⚠

Get the SoapySDR library API version as a string.

SoapySDR_getLibVersion^⚠

Get the library version and build information string.

SoapySDR_getLoaderResult^⚠

List all registration loader errors for a given module path.

SoapySDR_getLogLevel^⚠

Get the log level threshold.

SoapySDR_getModuleVersion^⚠

Get a version string for the specified module.

SoapySDR_getRootPath^⚠

Query the root installation path

SoapySDR_listModules^⚠

List all modules found in default path.

SoapySDR_listModulesPath^⚠

List all modules found in the given path.

SoapySDR_listSearchPaths^⚠

The list of paths automatically searched by loadModules().

SoapySDR_loadModule^⚠

Load a single module given its file system path.

SoapySDR_loadModules^⚠

Load the support modules installed on this system.

SoapySDR_log^⚠

Send a message to the registered logger.

SoapySDR_registerLogHandler^⚠

Register a new system log handler.

SoapySDR_setLogLevel^⚠

Set the log level threshold.

SoapySDR_ticksToTimeNs^⚠

Convert a tick count into a time in nanoseconds using the tick rate.

SoapySDR_timeNsToTicks^⚠

Convert a time in nanoseconds into a tick count using the tick rate.

SoapySDR_unloadModule^⚠

Unload a module that was loaded with loadModule().

SoapySDR_unloadModules^⚠

Unload all currently loaded support modules.

Type Aliases

SoapySDRArgInfoType

Possible data types for argument info

SoapySDRLogHandler

Typedef for the registered log handler function.

SoapySDRLogLevel

The available priority levels for log messages.