Schemas

air7201b

air7201b

type	object
properties
sensor_binding	enum	air7201b
description	default	summary	null
		version	unversioned
	Description
plot_hint	default	null
	anyOf	type	null
		PlotOptions
source	Air7201BSourceSpec
captures	type	array
	default
	items	SoapyCapture
loops	type	array
	default
	items	anyOf	Repeat
			List
			Range
			FrequencyBinRange
adjust_captures	type	object
	default
	additionalProperties	anyOf	type	object
			additionalProperties	anyOf	type	number
					type	integer
					type	string
					type	boolean
					type	null
					CaptureRemap
			type	array
			items	False
			maxItems	2
			minItems	2
peripherals	NoPeripherals
analysis	default
	Analysis
extensions	default	sink	null
		import_path	null
		import_name	null
	Extension
sink	default	path	{yaml_name}-{start_time}
		log_path	null
		log_level	info
		store	directory
		max_threads	null
		batched_write_count	1
		max_chunk_bytes	50000000
	Sink
options	default	reuse_iq	False
		loop_only_nyquist	False
		skip_warmup	True
	SweepOptions
mock_source	default	null
	anyOf	type	string
		type	null
additionalProperties	False

Description

type	object
properties
summary	default	null
	anyOf	type	string
		type	null
version	type	string
	default	unversioned
additionalProperties	False

PlotOptions

type	object
properties
data	DataOptions
plotter	SharedPlotOptions
variables	type	object
	default
	additionalProperties	type	object
additionalProperties	False

DataOptions

type	object
properties
groupby_dims	type	array
	default
	items	type	string
sweep_index	type	integer
query	default	null
	anyOf	type	string
		type	null
select	type	object
	default
additionalProperties	False

SharedPlotOptions

type	object
properties
style	default	null
	anyOf	type	string
		type	null
col	default	port
	anyOf	type	string
		type	null
row	default	null
	anyOf	type	string
		type	null
col_label_format	type	string
	default	Port {port}
row_label_format	default	null
	anyOf	type	string
		type	null
col_wrap	default	null
	anyOf	type	integer
		type	null
suptitle_fmt	type	string
	default	{start_time}
filename_fmt	type	string
	default	{name} {start_time}.svg
additionalProperties	False

Air7201BSourceSpec

type	object
properties
master_clock_rate	Base sample rate used inside the source
	type	number
	exclusiveMinimum	0
	default	125000000.0
trigger_strobe	default	null
	anyOf	type	number
		type	null
signal_trigger	default	null
	anyOf	type	string
		type	null
		AnalysisGroup
array_backend	array module to use to set compute device: numpy = cpu, cupy = gpu
	enum	cupy, numpy
	default	cupy
calibration	default	null
	anyOf	type	string
		type	null
time_source	Hardware source for timestamps
	enum	external, gps, host, internal
	default	host
time_sync_at	when to sync the hardware clock: on connection, or before each capture
	enum	acquire, open
	default	acquire
clock_source	Hardware source for the frequency reference
	enum	external, gps, internal
	default	internal
receive_retries	number of acquisition retry attempts on stream error
	type	integer
	minimum	0
	default	3
adc_overload_limit	default	-1
	anyOf	dataset adc_overload=True when the peak ADC level exceeds this threshold
		type	number
		maximum	0
		type	null
if_overload_limit	default	null
	anyOf	the maximum level at maximum gain before IF/baseband overload
		type	number
		type	null
gapless	whether to raise an exception on overflows between identical captures
	type	boolean
	default	False
additionalProperties	False

AnalysisGroup

base class for a defining set of Analysis specs
type	object
properties
additionalProperties	False

SoapyCapture

type	object
properties
duration	Duration of the analysis waveform
	type	number
	default	0.1
sample_rate	Analysis sample rate
	type	number
	default	15360000.0
analysis_bandwidth	Analysis bandwidth
	type	number
	default	null
port	Input port indices
	anyOf	Input port index
		type	integer
		minimum	0
		type	array
		items	Input port index
			type	integer
			minimum	0
lo_shift	LO shift direction
	enum	left, none, right
	default	none
host_resample	type	boolean
	default	True
backend_sample_rate	default	null
	anyOf	Source sample rate
		type	number
		exclusiveMinimum	0
		type	null
adjust_analysis	changes to apply across each analysis for any matching parameter
	type	object
	default
center_frequency	Center frequency for each port
	anyOf	RF center frequency
		type	number
		exclusiveMinimum	0
		type	array
		items	RF center frequency
			type	number
			exclusiveMinimum	0
gain	Gain setting for each channel
	anyOf	Gain setting
		type	number
		type	array
		items	Gain setting
			type	number
additionalProperties	False

Repeat

type	object
properties
kind	enum	repeat
field	type	null
	default	null
isin	selects whether to loop a capture or analysis parameters
	enum	analysis, capture
	default	capture
count	type	integer
	default	1
additionalProperties	False

List

type	object
properties
kind	enum	list
field	type	string
isin	selects whether to loop a capture or analysis parameters
	enum	analysis, capture
	default	capture
values	type	array
	items	anyOf	type	object
			additionalProperties	anyOf	type	object
					additionalProperties	anyOf	type	number
							type	integer
							type	string
							type	boolean
							type	null
							CaptureRemap
					type	array
					items	False
					maxItems	2
					minItems	2
			type	string
			type	number
			type	integer
			type	boolean
			type	null
additionalProperties	False

CaptureRemap

type	object
properties
key	anyOf	type	string
		type	array
		items	type	string
lookup	type	object
required	type	boolean
	default	True
default
additionalProperties	False

Range

type	object
properties
kind	enum	range
field	type	string
isin	selects whether to loop a capture or analysis parameters
	enum	analysis, capture
	default	capture
start	type	number
stop	type	number
step	type	number
additionalProperties	False

FrequencyBinRange

type	object
properties
kind	enum	frequencybinrange
field	type	string
isin	selects whether to loop a capture or analysis parameters
	enum	analysis, capture
	default	capture
start	type	number
stop	type	number
step	type	number
additionalProperties	False

NoPeripherals

type	object
properties
additionalProperties	False

Analysis

type	object
properties
cellular_5g_pss_sync	default	null
	anyOf	type	null
		Cellular5GNPSSSync
cellular_5g_pss_correlation	default	null
	anyOf	type	null
		Cellular5GNRPSSCorrelator
cellular_5g_ssb_spectrogram	default	null
	anyOf	type	null
		Cellular5GNRSSBSpectrogram
cellular_5g_sss_sync	default	null
	anyOf	type	null
		Cellular5GNSSSSync
cellular_5g_sss_correlation	default	null
	anyOf	type	null
		Cellular5GNRSSSCorrelator
cellular_cyclic_autocorrelation	default	null
	anyOf	type	null
		CellularCyclicAutocorrelator
channel_power_time_series	default	null
	anyOf	type	null
		ChannelPowerTimeSeries
channel_power_histogram	default	null
	anyOf	type	null
		ChannelPowerHistogram
spectrogram	default	null
	anyOf	type	null
		Spectrogram
cellular_resource_power_histogram	default	null
	anyOf	type	null
		CellularResourcePowerHistogram
cyclic_channel_power	default	null
	anyOf	type	null
		CyclicChannelPower
iq_waveform	default	null
	anyOf	type	null
		IQWaveform
power_spectral_density	default	null
	anyOf	type	null
		PowerSpectralDensity
spectrogram_histogram	default	null
	anyOf	type	null
		SpectrogramHistogram
spectrogram_ratio_histogram	default	null
	anyOf	type	null
		SpectrogramHistogramRatio
additionalProperties	False

Cellular5GNPSSSync

type	object
properties
subcarrier_spacing	Subcarrier spacing (15e3, 30e3, 60e3, etc)
	type	number
sample_rate	type	number
	default	7680000.0
discovery_periodicity	type	number
	default	0.02
frequency_offset	type	number
	default	0
shared_spectrum	type	boolean
	default	False
delay	type	number
	default	0
symbol_indexes	index locations in the SSB, or a cell search case from 3GPP TS 38.213 Sec. 4.1)
	default	auto
	anyOf	enum	a, auto, b, c, d, e, f, g
		type	array
		items	type	integer
max_lag_symbols	default	null
	anyOf	limit the number of symbols of lag in the 5G sync correlator
		type	integer
		maximum	6
		minimum	1
		type	null
window_fill	Fraction of a symbol to fill with weighting function
	type	number
	maximum	1
	exclusiveMinimum	0
	default	1
per_port	whether to evaluate signal synchronization separately on each port
	type	boolean
	default	False
max_beams	default	null
	anyOf	limit the beam count in 5G sync evaluation
		type	integer
		exclusiveMinimum	0
		type	null
additionalProperties	False

Cellular5GNRPSSCorrelator

type	object
properties
subcarrier_spacing	Subcarrier spacing (15e3, 30e3, 60e3, etc)
	type	number
sample_rate	type	number
	default	7680000.0
discovery_periodicity	type	number
	default	0.02
frequency_offset	type	number
	default	0
shared_spectrum	type	boolean
	default	False
delay	type	number
	default	0
symbol_indexes	index locations in the SSB, or a cell search case from 3GPP TS 38.213 Sec. 4.1)
	default	auto
	anyOf	enum	a, auto, b, c, d, e, f, g
		type	array
		items	type	integer
max_lag_symbols	default	null
	anyOf	limit the number of symbols of lag in the 5G sync correlator
		type	integer
		maximum	6
		minimum	1
		type	null
max_block_count	default	1
	anyOf	type	integer
		type	null
additionalProperties	False

Cellular5GNRSSBSpectrogram

sample_rate (float): output sample rate for the resampled synchronization waveform (samples/s) discovery_periodicity (float): time period between synchronization blocks (s) frequency_offset (float or dict[float, float]): center frequency offset (see notes) shared_spectrum: whether to follow the 3GPP “shared spectrum” synchronizatio block layout max_block_count: number of synchronization blocks to evaluate
type	object
properties
subcarrier_spacing	Subcarrier spacing (15e3, 30e3, 60e3, etc)
	type	number
sample_rate	type	number
	default	7680000.0
discovery_periodicity	type	number
	default	0.02
frequency_offset	type	number
	default	0
max_block_count	default	null
	anyOf	type	integer
		type	null
window	window function specification following scipy.signal.get_window
	default	kaiser_by_enbw
		2
	anyOf	type	string
		type	array
		items	False
		maxItems	2
		minItems	2
lo_bandstop	default	null
	anyOf	type	number
		type	null
additionalProperties	False

Cellular5GNSSSSync

type	object
properties
subcarrier_spacing	Subcarrier spacing (15e3, 30e3, 60e3, etc)
	type	number
sample_rate	type	number
	default	7680000.0
discovery_periodicity	type	number
	default	0.02
frequency_offset	type	number
	default	0
shared_spectrum	type	boolean
	default	False
delay	type	number
	default	0
symbol_indexes	index locations in the SSB, or a cell search case from 3GPP TS 38.213 Sec. 4.1)
	default	auto
	anyOf	enum	a, auto, b, c, d, e, f, g
		type	array
		items	type	integer
max_lag_symbols	default	null
	anyOf	limit the number of symbols of lag in the 5G sync correlator
		type	integer
		maximum	6
		minimum	1
		type	null
window_fill	Fraction of a symbol to fill with weighting function
	type	number
	maximum	1
	exclusiveMinimum	0
	default	1
per_port	whether to evaluate signal synchronization separately on each port
	type	boolean
	default	False
max_beams	default	null
	anyOf	limit the beam count in 5G sync evaluation
		type	integer
		exclusiveMinimum	0
		type	null
additionalProperties	False

Cellular5GNRSSSCorrelator

type	object
properties
subcarrier_spacing	Subcarrier spacing (15e3, 30e3, 60e3, etc)
	type	number
sample_rate	type	number
	default	7680000.0
discovery_periodicity	type	number
	default	0.02
frequency_offset	type	number
	default	0
shared_spectrum	type	boolean
	default	False
delay	type	number
	default	0
symbol_indexes	index locations in the SSB, or a cell search case from 3GPP TS 38.213 Sec. 4.1)
	default	auto
	anyOf	enum	a, auto, b, c, d, e, f, g
		type	array
		items	type	integer
max_lag_symbols	default	null
	anyOf	limit the number of symbols of lag in the 5G sync correlator
		type	integer
		maximum	6
		minimum	1
		type	null
max_block_count	default	1
	anyOf	type	integer
		type	null
additionalProperties	False

CellularCyclicAutocorrelator

type	object
properties
subcarrier_spacings	One or more subcarrier spacings (15e3, 30e3, 60e3, etc)
	default	15000.0
		30000.0
		60000.0
	anyOf	type	number
		type	array
		items	type	number
frame_range	default	0
		1
	anyOf	type	integer
		type	array
		items	False
		maxItems	2
		minItems	2
frame_slots	string composed of (‘d’, ‘u’, ‘s’) specifying the sequence of slots in 1 TDD cellular frame, or None to fill with downlink
	default	null
	anyOf	type	string
		type	null
symbol_range	default	0
		null
	anyOf	type	integer
		type	array
		items	False
		maxItems	2
		minItems	2
generation	enum	4G, 5G
	default	5G
additionalProperties	False

ChannelPowerTimeSeries

type	object
properties
detector_period	type	string / number
power_detectors	type	array
	default	rms
		peak
	items	type	string
additionalProperties	False

ChannelPowerHistogram

type	object
properties
detector_period	type	string / number
power_detectors	type	array
	default	rms
		peak
	items	type	string
power_low	Minimum power bin
	type	number
power_high	Maximum power bin
	type	number
power_resolution	Power bin resolution
	type	number
additionalProperties	False

Spectrogram

time_aperture (float): if specified, binned RMS averaging is applied along time axis in the spectrogram to yield this coarser resolution (s) dB (bool): if True, returned power is transformed into dB units
type	object
properties
window	window function specification following scipy.signal.get_window
	anyOf	type	string
		type	array
		items	False
		maxItems	2
		minItems	2
frequency_resolution	type	number
fractional_overlap	type	string / number
	default	0
window_fill	type	string / number
	default	1
integration_bandwidth	default	null
	anyOf	type	number
		type	null
trim_stopband	type	boolean
	default	True
lo_bandstop	default	null
	anyOf	mask with float(“nan”) at this bandwidth centered at baseband DC
		type	number
		type	null
time_aperture	default	null
	anyOf	type	number
		type	null
additionalProperties	False

CellularResourcePowerHistogram

type	object
properties
window	window function specification following scipy.signal.get_window
	anyOf	type	string
		type	array
		items	False
		maxItems	2
		minItems	2
subcarrier_spacing	Subcarrier spacing (15e3, 30e3, 60e3, etc)
	type	number
power_low	Minimum power bin
	type	number
power_high	Maximum power bin
	type	number
power_resolution	Power bin resolution
	type	number
average_rbs	True (or “half”) to coarsen spectrogram bins by integrating 1-subcarrier frequency resolution into 1- (or 1/2)-resource block
	default	False
	anyOf	type	boolean
		enum	half
average_slots	True to coarsen spectrogram bins by averaging 1-symbol time resolution
	type	boolean
	default	False
guard_bandwidths	Channel guard bandwidths to ignore on the left and right sides
	type	array
	default	0
		0
	items	False
	maxItems	2
	minItems	2
frame_slots	string composed of (‘d’, ‘u’, ‘s’) specifying the sequence of slots in 1 TDD cellular frame, or None to fill with downlink
	default	null
	anyOf	type	string
		type	null
special_symbols	string composed of the characters (‘d’, ‘u’, ‘f’) indicating the sequence of symbol types (when ‘s’ is in frame_slots)
	default	null
	anyOf	type	string
		type	null
cyclic_prefix	the 3GPP cyclic prefix type
	default	normal
	anyOf	enum	normal
		enum	extended
lo_bandstop	default	null
	anyOf	mask with float(“nan”) at this bandwidth centered at baseband DC
		type	number
		type	null
additionalProperties	False

CyclicChannelPower

type	object
properties
cyclic_period	type	number
detector_period	type	string / number
power_detectors	type	array
	default	rms
		peak
	items	type	string
cyclic_statistics	type	array
	default	min
		mean
		max
	items	anyOf	type	string
			type	number
additionalProperties	False

IQWaveform

type	object
properties
start_time_sec	default	null
	anyOf	type	number
		type	null
stop_time_sec	default	null
	anyOf	type	number
		type	null
additionalProperties	False

PowerSpectralDensity

type	object
properties
window	window function specification following scipy.signal.get_window
	anyOf	type	string
		type	array
		items	False
		maxItems	2
		minItems	2
frequency_resolution	type	number
fractional_overlap	type	string / number
	default	0
window_fill	type	string / number
	default	1
integration_bandwidth	default	null
	anyOf	type	number
		type	null
trim_stopband	type	boolean
	default	True
lo_bandstop	default	null
	anyOf	mask with float(“nan”) at this bandwidth centered at baseband DC
		type	number
		type	null
time_statistic	type	array
	default	mean
	items	anyOf	type	string
			type	number
additionalProperties	False

SpectrogramHistogram

type	object
properties
window	window function specification following scipy.signal.get_window
	anyOf	type	string
		type	array
		items	False
		maxItems	2
		minItems	2
frequency_resolution	type	number
fractional_overlap	type	string / number
	default	0
window_fill	type	string / number
	default	1
integration_bandwidth	default	null
	anyOf	type	number
		type	null
trim_stopband	type	boolean
	default	True
lo_bandstop	default	null
	anyOf	mask with float(“nan”) at this bandwidth centered at baseband DC
		type	number
		type	null
time_aperture	default	null
	anyOf	type	number
		type	null
power_low	Minimum power bin
	type	number
power_high	Maximum power bin
	type	number
power_resolution	Power bin resolution
	type	number
additionalProperties	False

SpectrogramHistogramRatio

type	object
properties
window	window function specification following scipy.signal.get_window
	anyOf	type	string
		type	array
		items	False
		maxItems	2
		minItems	2
frequency_resolution	type	number
fractional_overlap	type	string / number
	default	0
window_fill	type	string / number
	default	1
integration_bandwidth	default	null
	anyOf	type	number
		type	null
trim_stopband	type	boolean
	default	True
lo_bandstop	default	null
	anyOf	mask with float(“nan”) at this bandwidth centered at baseband DC
		type	number
		type	null
time_aperture	default	null
	anyOf	type	number
		type	null
power_low	Minimum power bin
	type	number
power_high	Maximum power bin
	type	number
power_resolution	Power bin resolution
	type	number
additionalProperties	False

Extension

type	object
properties
sink	default	null
	anyOf	Data sink class that implements data storage
		anyOf	type	string
			enum	striqt.sensor.sinks.CaptureAppender
		type	null
import_path	default	null
	anyOf	path to append to sys.path before extension imports
		type	string
		type	null
import_name	name of the extension module that calls bind_sensor
	default	null
	anyOf	type	string
		type	null
additionalProperties	False

Sink

type	object
properties
path	type	string
	default	{yaml_name}-{start_time}
log_path	default	null
	anyOf	type	string
		type	null
log_level	type	string
	default	info
store	serialization output format of the sink
	enum	directory, zip
	default	directory
max_threads	default	null
	anyOf	type	integer
		type	null
batched_write_count	type	integer
	default	1
max_chunk_bytes	type	integer
	default	50000000
additionalProperties	False

SweepOptions

type	object
properties
reuse_iq	type	boolean
	default	False
loop_only_nyquist	type	boolean
	default	False
skip_warmup	if True, suppress empty buffer runs for GPU backends
	type	boolean
	default	True
additionalProperties	False