@ -69,12 +69,16 @@ SpectrumAnnotationMarker:
@@ -69,12 +69,16 @@ SpectrumAnnotationMarker:
show:
type : integer
minimum : 0
maximum : 2
maximum : 3
description : >
SpectrumAnnotationMarker::ShowState - Marker display state
* 0 - Hidden
* 1 - Only top marker visible
* 2 - Fully visible with text and full sized limits
* 3 - Text only
text:
type : string
description : "Text displayed against the marker."
SpectrumCalibrationPoint:
description : Spectrum calibration point settings
@ -92,6 +96,21 @@ SpectrumCalibrationPoint:
@@ -92,6 +96,21 @@ SpectrumCalibrationPoint:
format : float
description : "Power absolute reference for Spectrum calibration point."
SpectrumMemorySettings:
description : Display settings for one saved spectrum memory. The captured spectrum samples are not transferred through settings APIs.
properties:
display:
description : Display this saved spectrum memory (1 for yes, 0 for no).
type : integer
minimum : 0
maximum : 1
color:
description : Display colour encoded as an RGB integer.
type : integer
label:
description : User-visible label for this saved spectrum memory.
type : string
GLSpectrum:
description : GLSpectrumGUI settings
properties:
@ -132,6 +151,151 @@ GLSpectrum:
@@ -132,6 +151,151 @@ GLSpectrum:
type : integer
minimum : 0
maximum : 1
display3DSpectrogram:
description : Display the 3D spectrogram instead of the 2D waterfall (1 for yes, 0 for no).
type : integer
minimum : 0
maximum : 1
spectrogramStyle:
description : >
Rendering style for the 3D spectrogram.
* 0 - Points
* 1 - Lines
* 2 - Solid
* 3 - Outline
* 4 - Shaded (requires OpenGL 3.3 or later)
type : integer
minimum : 0
maximum : 4
truncateFreqScale:
description : Truncate the frequency scale to the displayed span (1 for yes, 0 for no).
type : integer
minimum : 0
maximum : 1
colorMap:
description : Colour-map name used for waterfall and 3D spectrogram rendering.
type : string
spectrumStyle:
description: Current spectrum trace style : 0 line, 1 filled, 2 gradient.
type : integer
minimum : 0
maximum : 2
measurement:
description: Measurement mode : 0 none, 1 peaks, 2 channel power, 3 adjacent-channel power, 4 occupied bandwidth, 5 3 dB bandwidth, 6 SNR, 7 mask.
type : integer
minimum : 0
maximum : 7
measurementCenterFrequencyOffset:
description : Measurement centre-frequency offset in Hz.
type : integer
measurementBandwidth:
description : Measurement bandwidth in Hz.
type : integer
minimum : 0
measurementChSpacing:
description : Adjacent-channel measurement channel spacing in Hz.
type : integer
minimum : 0
measurementAdjChBandwidth:
description : Adjacent-channel measurement bandwidth in Hz.
type : integer
minimum : 0
measurementHarmonics:
description : Number of harmonics to measure.
type : integer
minimum : 0
measurementPeaks:
description : Number of peaks to report.
type : integer
minimum : 0
measurementHighlight:
description : Highlight the selected measurement (1 for yes, 0 for no).
type : integer
minimum : 0
maximum : 1
measurementsPosition:
description: Measurement panel position : 0 above, 1 below, 2 left, 3 right.
type : integer
minimum : 0
maximum : 3
measurementPrecision:
description : Decimal precision for measurement values.
type : integer
minimum : 0
findHistogramPeaks:
description : Find peaks in the spectrum histogram (1 for yes, 0 for no).
type : integer
minimum : 0
maximum : 1
showControls:
description: Spectrum control visibility : 0 minimum, 1 standard, 2 all.
type : integer
minimum : 0
maximum : 2
frequencyZoomFactor:
description : Horizontal frequency zoom factor.
type : number
minimum : 1
frequencyZoomPos:
description : Horizontal frequency-zoom position as a fraction of the span.
type : number
minimum : 0
maximum : 1
waterfallTimeUnits:
description: Waterfall time axis : 0 offset, 1 local time, 2 UTC.
type : integer
minimum : 0
maximum : 2
waterfallTimeFormat:
description : Qt date/time format used for the waterfall time axis.
type : string
scrollBar:
description : Enable waterfall/3D spectrogram scrolling (1 for yes, 0 for no).
type : integer
minimum : 0
maximum : 1
scrollLength:
description : Maximum waterfall/3D spectrogram history length.
type : integer
minimum : 1
mathMode:
description: Spectrum math mode : 0 none, 1-4 moving-average modes, 5-10 saved-memory comparison modes.
type : integer
minimum : 0
maximum : 10
mathAvgCount:
description : Number of FFT frames used by spectrum math averaging.
type : integer
minimum : 1
measurementMemMasks:
description : Bitmask selecting saved spectrum memories used as measurement masks.
type : integer
minimum : 0
maximum : 3
displayRBW:
description : Display resolution bandwidth (1 for yes, 0 for no).
type : integer
minimum : 0
maximum : 1
displayCursorStats:
description : Display cursor statistics (1 for yes, 0 for no).
type : integer
minimum : 0
maximum : 1
displayPeakStats:
description : Display peak statistics (1 for yes, 0 for no).
type : integer
minimum : 0
maximum : 1
spectrumMemory:
description : Display settings for the two saved spectrum memories.
type : array
maximum : 2
items:
$ref : "http://swgserver:8081/api/swagger/include/GLSpectrum.yaml#/SpectrumMemorySettings"
spectrumColor:
description : Current spectrum trace colour encoded as an RGB integer.
type : integer
invertedWaterfall:
description : boolean
type : integer
@ -177,8 +341,16 @@ GLSpectrum:
@@ -177,8 +341,16 @@ GLSpectrum:
format : float
description : "Waterfall share for Gl spectrum."
averagingMode:
description : See GLSpectrumGUI::AveragingMode
description : >
How successive FFTs are averaged
* 0 - no averaging
* 1 - moving average
* 2 - fixed average over each block
* 3 - maximum held over each block
* 4 - minimum held over each block
type : integer
minimum : 0
maximum : 4
averagingValue:
type : integer
description : "Averaging value for Gl spectrum."
@ -243,6 +415,17 @@ GLSpectrum:
@@ -243,6 +415,17 @@ GLSpectrum:
description : "List of waterfall markers."
items:
$ref : "http://swgserver:8081/api/swagger/include/GLSpectrum.yaml#/SpectrumWaterfallMarker"
annotationMarkersMode:
description : >
How annotationMarkers in the same request is applied. Replacing is what a PATCH of an
array means and is what the other marker lists do, but it discards annotations already
there, such as a loaded band plan. Append adds to them instead, so a caller adding one
annotation need not read the list, modify it and write it back.
* 0 - Replace the annotations with those given (the default)
* 1 - Append those given to the annotations already there
type : integer
minimum : 0
maximum : 1
annotationMarkers:
type : array
description : "List of annotation markers."
@ -253,3 +436,189 @@ GLSpectrum:
@@ -253,3 +436,189 @@ GLSpectrum:
description : "List of calibration points."
items:
$ref : "http://swgserver:8081/api/swagger/include/GLSpectrum.yaml#/SpectrumCalibrationPoint"
GLSpectrumReport:
description : >
The latest values of whichever spectrum measurement is switched on. Which fields are present
depends on the measurement : with none selected nothing is measured at all and only the
measurement field is returned. The figures are those of the spectrum as displayed, so they
match the window rather than the full span when it is zoomed, and they are only produced by a
running GUI.
properties:
measurement:
description : >
Which measurement produced these values.
* 0 - None, nothing is being measured
* 1 - Peaks
* 2 - Channel power
* 3 - Adjacent channel power
* 4 - Occupied bandwidth
* 5 - 3 dB bandwidth
* 6 - SNR
type : integer
updated:
type : string
description : "When these values were last measured, ISO 8601. Absent until the first measurement."
peaks:
type : array
description : "The strongest peaks, most powerful first. Peaks measurement only."
items:
$ref : "http://swgserver:8081/api/swagger/include/GLSpectrum.yaml#/SpectrumPeak"
channelPower:
type : number
format : float
description : "Total power in the measurement bandwidth in dB. Channel power measurement only."
adjChannelPowerLeft:
type : number
format : float
description : "Power in the lower adjacent channel in dB."
adjChannelPowerLeftRatio:
type : number
format : float
description : "Lower adjacent channel power ratio in dB, relative to the centre channel."
adjChannelPowerCentre:
type : number
format : float
description : "Power in the centre channel in dB."
adjChannelPowerRight:
type : number
format : float
description : "Power in the upper adjacent channel in dB."
adjChannelPowerRightRatio:
type : number
format : float
description : "Upper adjacent channel power ratio in dB, relative to the centre channel."
occupiedBandwidth:
type : number
format : float
description : "Occupied bandwidth in Hz. Occupied bandwidth measurement only."
bandwidth3dB:
type : number
format : float
description : "3 dB bandwidth in Hz. 3 dB bandwidth measurement only."
snr:
type : number
format : float
description : "Signal to noise ratio in dB. SNR measurement only."
snfr:
type : number
format : float
description : "Signal to noise and distortion free ratio in dB."
thd:
type : number
format : float
description : "Total harmonic distortion in dB."
thdPlusNoise:
type : number
format : float
description : "Total harmonic distortion plus noise in dB."
sinad:
type : number
format : float
description : "Signal to noise and distortion ratio in dB."
sfdr:
type : number
format : float
description : "Spurious free dynamic range in dB."
SpectrumPeak:
description : One peak found in the spectrum
properties:
frequency:
type : integer
format : int64
description : "Frequency of the peak in Hz."
power:
type : number
format : float
description : "Power of the peak in dB."
SpectrumActions:
description : Actions on the main spectrum of a device set
properties:
autoscale:
description : >
Set the reference level and range from the spectrum currently displayed, as the autoscale
button does. Needs a running GUI (1 to do it, 0 to do nothing).
type : integer
minimum : 0
maximum : 1
clearSpectrum:
description : >
Discard the accumulated histogram and max hold traces, as the clear button does. Needs a
running GUI (1 to do it, 0 to do nothing).
type : integer
minimum : 0
maximum : 1
resetMeasurements:
description : >
Discard the accumulated measurement statistics, so the minimum, maximum and mean columns
start again. Needs a running GUI (1 to do it, 0 to do nothing).
type : integer
minimum : 0
maximum : 1
freeze:
description : >
Stop or resume spectrum processing. Unlike the others this acts on the spectrum itself
rather than its display, so it works without a GUI (1 to freeze, 0 to resume).
type : integer
minimum : 0
maximum : 1
gotoMarker:
description : >
Retune the device to the annotation marker at this index, counting from 0, as choosing it
in the goto list does. Needs a running GUI.
type : integer
minimum : 0
GLSpectrumData:
description : >
A copy of the current power spectrum, reduced to the number of bins asked for so that the
answer stays a sensible size whatever the FFT size. The spectrum is only computed while
something is consuming it, a spectrum window or a websocket client, so updated says how old
these values are and is absent if none has been produced yet.
properties:
centerFrequency:
type : integer
format : int64
description : "Centre frequency of the whole spectrum in Hz."
bandwidth:
type : integer
description : "Width of the whole spectrum in Hz."
fftSize:
type : integer
description : "Number of bins the spectrum was computed with, before reduction."
linear:
type : integer
minimum : 0
maximum : 1
description : "1 when the powers are linear, 0 when they are in dB."
updated:
type : string
description : "When the spectrum was last computed, ISO 8601. Absent if it never has been."
startFrequency:
type : integer
format : int64
description : "Centre frequency of the first returned bin in Hz."
stopFrequency:
type : integer
format : int64
description : "Centre frequency of the last returned bin in Hz."
binBandwidth:
type : number
format : float
description : "Width of each returned bin in Hz, after reduction."
bins:
type : integer
description : "Number of values in power."
reduce:
type : string
description : >
How several FFT bins were combined into each returned one, max or mean. Max keeps a narrow
carrier that averaging would bury in its neighbours, which is why it is the default.
power:
type : array
description : "The reduced powers, first bin first."
items:
type : number
format : float