Browse Source

Add descriptions and missing fields to Swagger includes.

Add Feature reports for Radiosonde, APRS and AIS.
Add GLSpectrumReport and SpectrumActions.
chirpmodem-v8.0.0
Jon Beniston 2 months ago
parent
commit
b5a4ae0391
  1. 12
      swagger/sdrangel/api/swagger/include/ADSBDemod.yaml
  2. 8
      swagger/sdrangel/api/swagger/include/AFC.yaml
  3. 84
      swagger/sdrangel/api/swagger/include/AIS.yaml
  4. 4
      swagger/sdrangel/api/swagger/include/AISDemod.yaml
  5. 4
      swagger/sdrangel/api/swagger/include/AMDemod.yaml
  6. 2
      swagger/sdrangel/api/swagger/include/AMMod.yaml
  7. 117
      swagger/sdrangel/api/swagger/include/APRS.yaml
  8. 29
      swagger/sdrangel/api/swagger/include/ATVDemod.yaml
  9. 16
      swagger/sdrangel/api/swagger/include/Airspy.yaml
  10. 4
      swagger/sdrangel/api/swagger/include/AirspyHF.yaml
  11. 26
      swagger/sdrangel/api/swagger/include/CWKeyer.yaml
  12. 2
      swagger/sdrangel/api/swagger/include/ChannelActions.yaml
  13. 8
      swagger/sdrangel/api/swagger/include/ChannelAnalyzer.yaml
  14. 10
      swagger/sdrangel/api/swagger/include/ChannelMarker.yaml
  15. 2
      swagger/sdrangel/api/swagger/include/ChannelPower.yaml
  16. 5
      swagger/sdrangel/api/swagger/include/ChannelReport.yaml
  17. 2
      swagger/sdrangel/api/swagger/include/ChannelSettings.yaml
  18. 2
      swagger/sdrangel/api/swagger/include/ChirpChatDemod.yaml
  19. 2
      swagger/sdrangel/api/swagger/include/ChirpChatMod.yaml
  20. 6
      swagger/sdrangel/api/swagger/include/Command.yaml
  21. 100
      swagger/sdrangel/api/swagger/include/DABDemod.yaml
  22. 8
      swagger/sdrangel/api/swagger/include/DATVDemod.yaml
  23. 2
      swagger/sdrangel/api/swagger/include/DATVMod.yaml
  24. 10
      swagger/sdrangel/api/swagger/include/DOA2.yaml
  25. 4
      swagger/sdrangel/api/swagger/include/DSDDemod.yaml
  26. 2
      swagger/sdrangel/api/swagger/include/DeviceActions.yaml
  27. 2
      swagger/sdrangel/api/swagger/include/DeviceReports.yaml
  28. 2
      swagger/sdrangel/api/swagger/include/DeviceSettings.yaml
  29. 9
      swagger/sdrangel/api/swagger/include/FeatureReport.yaml
  30. 72
      swagger/sdrangel/api/swagger/include/FreqScanner.yaml
  31. 6
      swagger/sdrangel/api/swagger/include/FreqTracker.yaml
  32. 54
      swagger/sdrangel/api/swagger/include/GLScope.yaml
  33. 373
      swagger/sdrangel/api/swagger/include/GLSpectrum.yaml
  34. 2
      swagger/sdrangel/api/swagger/include/GS232Controller.yaml
  35. 4
      swagger/sdrangel/api/swagger/include/HackRF.yaml
  36. 2
      swagger/sdrangel/api/swagger/include/ILSDemod.yaml
  37. 2
      swagger/sdrangel/api/swagger/include/InmarsatDemod.yaml
  38. 13
      swagger/sdrangel/api/swagger/include/Interferometer.yaml
  39. 2
      swagger/sdrangel/api/swagger/include/KiwiSDR.yaml
  40. 8
      swagger/sdrangel/api/swagger/include/LimeRFE.yaml
  41. 4
      swagger/sdrangel/api/swagger/include/M17Demod.yaml
  42. 2
      swagger/sdrangel/api/swagger/include/MCPServer.yaml
  43. 157
      swagger/sdrangel/api/swagger/include/Map.yaml
  44. 2
      swagger/sdrangel/api/swagger/include/MeshcoreDemod.yaml
  45. 2
      swagger/sdrangel/api/swagger/include/MeshcoreMod.yaml
  46. 2
      swagger/sdrangel/api/swagger/include/MeshtasticDemod.yaml
  47. 2
      swagger/sdrangel/api/swagger/include/MeshtasticMod.yaml
  48. 2
      swagger/sdrangel/api/swagger/include/MetisMISO.yaml
  49. 2
      swagger/sdrangel/api/swagger/include/Perseus.yaml
  50. 14
      swagger/sdrangel/api/swagger/include/PlutoSdr.yaml
  51. 8
      swagger/sdrangel/api/swagger/include/Preset.yaml
  52. 6
      swagger/sdrangel/api/swagger/include/RadioAstronomy.yaml
  53. 2
      swagger/sdrangel/api/swagger/include/RadioClock.yaml
  54. 91
      swagger/sdrangel/api/swagger/include/Radiosonde.yaml
  55. 2
      swagger/sdrangel/api/swagger/include/RemoteTCPInput.yaml
  56. 7
      swagger/sdrangel/api/swagger/include/RtlSdr.yaml
  57. 2
      swagger/sdrangel/api/swagger/include/SDRPlay.yaml
  58. 2
      swagger/sdrangel/api/swagger/include/SDRPlayV3.yaml
  59. 6
      swagger/sdrangel/api/swagger/include/SID.yaml
  60. 2
      swagger/sdrangel/api/swagger/include/SSBDemod.yaml
  61. 10
      swagger/sdrangel/api/swagger/include/SatelliteTracker.yaml
  62. 10
      swagger/sdrangel/api/swagger/include/SkyMap.yaml
  63. 6
      swagger/sdrangel/api/swagger/include/StarTracker.yaml
  64. 2
      swagger/sdrangel/api/swagger/include/TestMOSync.yaml
  65. 9
      swagger/sdrangel/api/swagger/include/TestSource.yaml
  66. 2
      swagger/sdrangel/api/swagger/include/USRP.yaml
  67. 8
      swagger/sdrangel/api/swagger/include/Xtrx.yaml

12
swagger/sdrangel/api/swagger/include/ADSBDemod.yaml

@ -16,14 +16,6 @@ ADSBDemodSettings: @@ -16,14 +16,6 @@ ADSBDemodSettings:
samplesPerBit:
type: integer
description: "Number of input samples used to represent each bit."
correlateFullPreamble:
type: integer
minimum: 0
maximum: 1
description: >
Correlate on part or full preamble
* 0 - part
* 1 - full
demodModeS:
type: integer
minimum: 0
@ -41,7 +33,7 @@ ADSBDemodSettings: @@ -41,7 +33,7 @@ ADSBDemodSettings:
description: Number of taps per phase in channel interpolator
removeTimeout:
type: integer
description: "Time after which an inactive tracked item is removed."
description: "Seconds without a frame after which an aircraft is removed from the display."
feedEnabled:
type: integer
description: "Enable forwarding of received data to the configured feed (1 enabled, 0 disabled)."
@ -101,7 +93,7 @@ ADSBDemodSettings: @@ -101,7 +93,7 @@ ADSBDemodSettings:
importPeriod:
type: number
format: float
description: "Import period setting for ADS-B demod."
description: "How often to import aircraft from the configured web service, in seconds."
importMinLatitude:
type: string
description: "Import min latitude setting for ADS-B demod."

8
swagger/sdrangel/api/swagger/include/AFC.yaml

@ -30,11 +30,11 @@ AFCSettings: @@ -30,11 +30,11 @@ AFCSettings:
* 0 - device
* 1 - transverter
targetFrequency:
description: Target frequency for the tracker
description: "Frequency the tracker should settle on, in Hz."
type: integer
format: int64
freqTolerance:
description: Frequency shift tolerance before tracker frequency is (re)adjusted
description: "Frequency error in Hz that is tolerated before the tracker frequency is adjusted again."
type: integer
trackerAdjustPeriod:
description: Tracker channel frequency adjustment period in seconds
@ -79,11 +79,11 @@ AFCReport: @@ -79,11 +79,11 @@ AFCReport:
description: Tracker index in device set
type: integer
trackerDeviceFrequency:
description: Center frequency of tracker device
description: "Centre frequency of the tracking device, in Hz."
type: integer
format: int64
trackerChannelOffset:
description: Tracker channel offset from device center frequency
description: "Tracker channel offset from the device centre frequency, in Hz."
type: integer
AFCActions:

84
swagger/sdrangel/api/swagger/include/AIS.yaml

@ -39,3 +39,87 @@ AISSettings: @@ -39,3 +39,87 @@ AISSettings:
description: "List of vessel column sizes."
items:
type: integer
AISReport:
description: >
Vessels heard by the AIS feature, which collects the decoded messages of every AIS
demodulator in the instance. A field is present only once a message carrying it has been
received, so an absent position means unknown rather than zero.
properties:
reportDateTime:
type: string
description: "When this snapshot was taken, ISO 8601."
vesselCount:
type: integer
description: "Number of vessels currently held."
vessels:
type: array
description: "The vessels heard."
items:
$ref: "http://swgserver:8081/api/swagger/include/AIS.yaml#/AISVessel"
AISVessel:
description: Vessel heard by the AIS feature
properties:
mmsi:
type: string
description: "Maritime Mobile Service Identity, nine digits. The only field always present."
name:
type: string
description: "Vessel name, from a static and voyage related message or an aid-to-navigation report."
callsign:
type: string
description: "Radio callsign."
imo:
type: string
description: "IMO number, where transmitted."
country:
type: string
description: "Flag state, derived from the MMSI maritime identification digits."
type:
type: string
description: "What is transmitting: Vessel, Base station, Aircraft or Aid-to-nav."
shipType:
type: string
description: "Ship and cargo type, such as Cargo or Tug."
latitude:
type: number
format: float
minimum: -90
maximum: 90
description: "Latitude in decimal degrees, north positive."
longitude:
type: number
format: float
minimum: -180
maximum: 180
description: "Longitude in decimal degrees, east positive."
course:
type: number
format: float
description: "Course over ground in degrees true."
speed:
type: number
format: float
description: "Speed over ground in knots."
heading:
type: integer
description: "True heading in degrees, which differs from course when set and drift apply."
status:
type: string
description: "Navigational status, such as Under way using engine or At anchor."
length:
type: integer
description: "Overall length in metres."
destination:
type: string
description: "Destination as entered by the crew."
positionUpdate:
type: string
description: "When the position was last updated, ISO 8601."
lastUpdate:
type: string
description: "When any field was last updated, ISO 8601."
messages:
type: integer
description: "Messages received from this vessel."

4
swagger/sdrangel/api/swagger/include/AISDemod.yaml

@ -20,6 +20,8 @@ AISDemodSettings: @@ -20,6 +20,8 @@ AISDemodSettings:
description: "Normalised correlation threshold with the preamble, from 0 to 1"
type: number
format: float
minimum: 0
maximum: 1
udpEnabled:
description: "Whether to forward received messages to specified UDP port"
type: integer
@ -36,6 +38,8 @@ AISDemodSettings: @@ -36,6 +38,8 @@ AISDemodSettings:
udpFormat:
description: "0 for binary, 1 for NMEA"
type: integer
minimum: 0
maximum: 1
logFilename:
type: string
description: "Log file name or path."

4
swagger/sdrangel/api/swagger/include/AMDemod.yaml

@ -29,6 +29,8 @@ AMDemodSettings: @@ -29,6 +29,8 @@ AMDemodSettings:
bandpassEnable:
description: use bandpass filter (1 for yes, 0 for no)
type: integer
minimum: 0
maximum: 1
rgbColor:
type: integer
description: "Display color encoded as an RGB integer."
@ -47,6 +49,8 @@ AMDemodSettings: @@ -47,6 +49,8 @@ AMDemodSettings:
frequencyMode:
description: (0 for Offset, 1 for MW, 2 for 25k, 3 for 8.33k)
type: integer
minimum: 0
maximum: 3
frequency:
description: Channel center frequency
type: integer

2
swagger/sdrangel/api/swagger/include/AMMod.yaml

@ -13,6 +13,8 @@ AMModSettings: @@ -13,6 +13,8 @@ AMModSettings:
description: modulation factor from 0.0 to 1.0
type: number
format: float
minimum: 0
maximum: 1
toneFrequency:
type: number
format: float

117
swagger/sdrangel/api/swagger/include/APRS.yaml

@ -111,3 +111,120 @@ APRSSettings: @@ -111,3 +111,120 @@ APRSSettings:
description: "List of motion table column sizes."
items:
type: integer
APRSReport:
description: >
Stations and objects heard by the APRS feature, which collects the AX.25 packets of every
packet demodulator in the instance. A field is present only once a packet carrying it has
been received.
properties:
runningState:
type: integer
minimum: 0
maximum: 3
description: >
Running state
* 0 - not started
* 1 - idle
* 2 - running
* 3 - error
reportDateTime:
type: string
description: "When this snapshot was taken, ISO 8601."
stationCount:
type: integer
description: "Number of stations and objects currently held."
packetCount:
type: integer
description: "Packets received across all stations."
stations:
type: array
description: "The stations and objects heard."
items:
$ref: "http://swgserver:8081/api/swagger/include/APRS.yaml#/APRSStation"
APRSStation:
description: Station or object heard by the APRS feature
properties:
callsign:
type: string
description: "Station callsign with SSID, or the name of the object or item."
isObject:
type: integer
minimum: 0
maximum: 1
description: "1 when this is an object or item rather than a station."
reportingStation:
type: string
description: "Callsign that reported this object. Empty for a station."
symbol:
type: string
description: "APRS symbol identifier."
latitude:
type: number
format: float
minimum: -90
maximum: 90
description: "Latitude in decimal degrees, north positive."
longitude:
type: number
format: float
minimum: -180
maximum: 180
description: "Longitude in decimal degrees, east positive."
altitude:
type: number
format: float
description: "Altitude in metres above mean sea level."
course:
type: number
format: float
description: "Course in degrees true."
speed:
type: number
format: float
description: "Speed in km/h."
status:
type: string
description: "Latest status text."
comment:
type: string
description: "Latest position comment."
powerWatts:
type: number
format: float
description: "Transmitter power in watts, from a reported PHG value."
antennaHeight:
type: number
format: float
description: "Antenna height above average terrain in metres, from a reported PHG value."
antennaGain:
type: number
format: float
description: "Antenna gain in dB, from a reported PHG value."
antennaDirectivity:
type: string
description: "Antenna directivity, from a reported PHG value."
radioRange:
type: number
format: float
description: "Reported range in km."
hasWeather:
type: integer
minimum: 0
maximum: 1
description: "1 when weather reports have been received from this station."
hasTelemetry:
type: integer
minimum: 0
maximum: 1
description: "1 when telemetry has been received from this station."
telemetryProjectName:
type: string
description: "Telemetry project name, where reported."
packets:
type: integer
description: "Packets received from this station."
lastPacketDateTime:
type: string
description: "When the most recent packet was received, ISO 8601."

29
swagger/sdrangel/api/swagger/include/ATVDemod.yaml

@ -5,8 +5,13 @@ ATVDemodSettings: @@ -5,8 +5,13 @@ ATVDemodSettings:
type: integer
description: "Selected fps index."
halfImage:
description: (boolean) 1 for m_fltRatioOfRowsToDisplay = 0.5, 0 for m_fltRatioOfRowsToDisplay = 1.0
description: >
Display only half of the image rows
* 0 - display all rows
* 1 - display half the rows
type: integer
minimum: 0
maximum: 1
RFBandwidthFactor:
type: integer
description: "RF bandwidth factor setting for Atv demod."
@ -20,8 +25,17 @@ ATVDemodSettings: @@ -20,8 +25,17 @@ ATVDemodSettings:
type: integer
description: "Int frequency offset in Hz."
enmModulation:
description: see ATVDemodSettings::ATVModulation
description: >
Modulation of the received ATV signal
* 0 - FM with discriminator 1
* 1 - FM with discriminator 2
* 2 - FM with phase derivative discriminator
* 3 - AM
* 4 - AM with vestigial lower sideband, signal in the upper sideband
* 5 - AM with vestigial upper sideband, signal in the lower sideband
type: integer
minimum: 0
maximum: 5
fltRFBandwidth:
type: number
format: float
@ -53,8 +67,17 @@ ATVDemodSettings: @@ -53,8 +67,17 @@ ATVDemodSettings:
type: integer
description: "Int sample rate in samples per second."
enmATVStandard:
description: see ATVDemodSettings::ATVStd
description: >
Television standard, which sets the line count and timings
* 0 - PAL 625 lines
* 1 - PAL 525 lines
* 2 - 819 lines
* 3 - short, interleaved
* 4 - short
* 5 - horizontal sync skip
type: integer
minimum: 0
maximum: 5
intNumberOfLines:
type: integer
description: "Int number of lines setting for Atv demod."

16
swagger/sdrangel/api/swagger/include/Airspy.yaml

@ -16,13 +16,19 @@ AirspySettings: @@ -16,13 +16,19 @@ AirspySettings:
description: "Selected dev sample rate index."
lnaGain:
type: integer
description: "Low-noise-amplifier gain setting."
minimum: 0
maximum: 14
description: "Low noise amplifier gain as a step index, not a dB value. Ignored when lnaAGC is enabled."
mixerGain:
type: integer
description: "Mixer gain setting for Airspy."
minimum: 0
maximum: 15
description: "Mixer gain as a step index, not a dB value. Ignored when mixerAGC is enabled."
vgaGain:
type: integer
description: "Variable-gain-amplifier gain setting."
minimum: 0
maximum: 15
description: "Variable gain amplifier (IF) gain as a step index, not a dB value."
lnaAGC:
description: LNA AGC (1 if active else 0)
type: integer
@ -31,10 +37,14 @@ AirspySettings: @@ -31,10 +37,14 @@ AirspySettings:
type: integer
log2Decim:
type: integer
minimum: 0
maximum: 6
description: "Base-2 exponent of the software decimation factor; the output sample rate is divided by 2^log2Decim."
fcPos:
description: 0=Infra 1=Supra 2=Center
type: integer
minimum: 0
maximum: 2
biasT:
description: Bias tee (1 if active else 0)
type: integer

4
swagger/sdrangel/api/swagger/include/AirspyHF.yaml

@ -16,6 +16,8 @@ AirspyHFSettings: @@ -16,6 +16,8 @@ AirspyHFSettings:
description: "Selected dev sample rate index."
log2Decim:
type: integer
minimum: 0
maximum: 8
description: "Base-2 exponent of the software decimation factor; the output sample rate is divided by 2^log2Decim."
transverterMode:
type: integer
@ -61,6 +63,8 @@ AirspyHFSettings: @@ -61,6 +63,8 @@ AirspyHFSettings:
agcHigh:
description: AGC threshold (1 for high, 0 for low)
type: integer
minimum: 0
maximum: 1
useDSP:
description: LibairspyHF DSP (1 for on, 0 for off)
type: integer

26
swagger/sdrangel/api/swagger/include/CWKeyer.yaml

@ -7,8 +7,16 @@ CWKeyerSettings: @@ -7,8 +7,16 @@ CWKeyerSettings:
description: Words Per Minute keying speed
type: integer
mode:
description: see enum CWKeyerSettings::CWMode
type: integer
description: >
Source of the keying
* 0 - none, key up
* 1 - send the text in the text field
* 2 - send continuous dots
* 3 - send continuous dashes
* 4 - key from the keyboard
type: integer
minimum: 0
maximum: 4
text:
type: string
description: "Text setting for CW keyer."
@ -18,15 +26,21 @@ CWKeyerSettings: @@ -18,15 +26,21 @@ CWKeyerSettings:
keyboardIambic:
description: 1 for iambic input 0 for straight input using the keyboard
type: integer
minimum: 0
maximum: 1
dotKey:
description: key for dots keyboard input. See enum Qt::Key
description: >
Keyboard key that sends dots. Key code as a Qt key value, for example 32 (0x20) for space and 65 (0x41) for A. Letter keys use the upper case code. 0 for no key.
type: integer
dotKeyModifiers:
description: key modifier for dots keyboard input. See flags Qt::KeyboardModifiers
description: >
Modifiers for the dot key. Modifier keys held with the key, as a sum of flags: 33554432 (0x02000000) shift, 67108864 (0x04000000) control, 134217728 (0x08000000) alt, 268435456 (0x10000000) meta. 0 for no modifier.
type: integer
dashKey:
description: key for dashes keyboard input. See enum Qt::Key
description: >
Keyboard key that sends dashes. Key code as a Qt key value, for example 32 (0x20) for space and 65 (0x41) for A. Letter keys use the upper case code. 0 for no key.
type: integer
dashKeyModifiers:
description: key modifier for dashes keyboard input. See flags Qt::KeyboardModifiers
description: >
Modifiers for the dash key. Modifier keys held with the key, as a sum of flags: 33554432 (0x02000000) shift, 67108864 (0x04000000) control, 134217728 (0x08000000) alt, 268435456 (0x10000000) meta. 0 for no modifier.
type: integer

2
swagger/sdrangel/api/swagger/include/ChannelActions.yaml

@ -11,6 +11,8 @@ ChannelActions: @@ -11,6 +11,8 @@ ChannelActions:
direction:
description: 0 for Rx only, 1 for Tx only or 2 for any number and direction (default 0)
type: integer
minimum: 0
maximum: 2
originatorDeviceSetIndex:
description: Optional for reverse API. This is the device set index from where the message comes from.
type: integer

8
swagger/sdrangel/api/swagger/include/ChannelAnalyzer.yaml

@ -65,8 +65,14 @@ ChannelAnalyzerSettings: @@ -65,8 +65,14 @@ ChannelAnalyzerSettings:
format: float
description: "Pll loop gain setting for Channel analyzer."
inputType:
description: see ChannelAnalyzerSettings::InputType
description: >
Signal fed to the analyser
* 0 - the channel signal
* 1 - the PLL output
* 2 - the autocorrelation of the signal
type: integer
minimum: 0
maximum: 2
rgbColor:
type: integer
description: "Display color encoded as an RGB integer."

10
swagger/sdrangel/api/swagger/include/ChannelMarker.yaml

@ -12,4 +12,12 @@ ChannelMarker: @@ -12,4 +12,12 @@ ChannelMarker:
description: "User-visible title."
frequencyScaleDisplayType:
type: integer
description: ChannelMarker::frequencyScaleDisplay_t
minimum: 0
maximum: 4
description: >
What is written against the channel on the frequency scale
* 0 - the frequency
* 1 - the channel title
* 2 - the send address
* 3 - the receive address
* 4 - nothing

2
swagger/sdrangel/api/swagger/include/ChannelPower.yaml

@ -8,6 +8,8 @@ ChannelPowerSettings: @@ -8,6 +8,8 @@ ChannelPowerSettings:
frequencyMode:
description: (0 for Offset, 1 for Absolute)
type: integer
minimum: 0
maximum: 1
frequency:
description: Channel center frequency
type: integer

5
swagger/sdrangel/api/swagger/include/ChannelReport.yaml

@ -11,6 +11,8 @@ ChannelReport: @@ -11,6 +11,8 @@ ChannelReport:
direction:
description: 0 for Rx only, 1 for Tx only or 2 for any number and direction (default 0)
type: integer
minimum: 0
maximum: 2
ADSBDemodReport:
$ref: "http://swgserver:8081/api/swagger/include/ADSBDemod.yaml#/ADSBDemodReport"
description: "ADS-B demod report data for Channel."
@ -32,6 +34,9 @@ ChannelReport: @@ -32,6 +34,9 @@ ChannelReport:
BFMDemodReport:
$ref: "http://swgserver:8081/api/swagger/include/BFMDemod.yaml#/BFMDemodReport"
description: "BFM demod report data for Channel."
DABDemodReport:
$ref: "http://swgserver:8081/api/swagger/include/DABDemod.yaml#/DABDemodReport"
description: "DAB demod report data for Channel."
ChannelPowerReport:
$ref: "http://swgserver:8081/api/swagger/include/ChannelPower.yaml#/ChannelPowerReport"
description: "Channel power report data for Channel."

2
swagger/sdrangel/api/swagger/include/ChannelSettings.yaml

@ -11,6 +11,8 @@ ChannelSettings: @@ -11,6 +11,8 @@ ChannelSettings:
direction:
description: 0 for Rx only, 1 for Tx only or 2 for any number and direction (default 0)
type: integer
minimum: 0
maximum: 2
originatorDeviceSetIndex:
description: Optional for reverse API. This is the device set index from where the message comes from.
type: integer

2
swagger/sdrangel/api/swagger/include/ChirpChatDemod.yaml

@ -189,6 +189,8 @@ ChirpChatDemodReport: @@ -189,6 +189,8 @@ ChirpChatDemodReport:
syncWord:
description: 2 bytes sync word (0..65535)
type: integer
minimum: 0
maximum: 65535
hasCRC:
description: boolean 1 if payload CRC is present else 0 (LoRa)
type: integer

2
swagger/sdrangel/api/swagger/include/ChirpChatMod.yaml

@ -53,6 +53,8 @@ ChirpChatModSettings: @@ -53,6 +53,8 @@ ChirpChatModSettings:
syncWord:
description: 2 byte (0..65535) synchronization syncWord
type: integer
minimum: 0
maximum: 65535
channelMute:
description: boolean
type: integer

6
swagger/sdrangel/api/swagger/include/Command.yaml

@ -14,10 +14,12 @@ Command: @@ -14,10 +14,12 @@ Command:
type: string
description: "Arg string for Command."
key:
description: Qt::Key
description: >
Keyboard key that triggers the command. Key code as a Qt key value, for example 32 (0x20) for space and 65 (0x41) for A. Letter keys use the upper case code. 0 for no key.
type: integer
keyModifiers:
description: Qt::KeyboardModifiers
description: >
Modifiers for the trigger key. Modifier keys held with the key, as a sum of flags: 33554432 (0x02000000) shift, 67108864 (0x04000000) control, 134217728 (0x08000000) alt, 268435456 (0x10000000) meta. 0 for no modifier.
type: integer
associateKey:
description: boolean

100
swagger/sdrangel/api/swagger/include/DABDemod.yaml

@ -58,3 +58,103 @@ DABDemodSettings: @@ -58,3 +58,103 @@ DABDemodSettings:
rollupState:
$ref: "http://swgserver:8081/api/swagger/include/RollupState.yaml#/RollupState"
description: "Saved expanded or collapsed state of the GUI sections."
DABProgram:
description: "A programme service discovered in the currently tuned DAB ensemble."
properties:
name:
type: string
description: "Exact transmitted service label. Use this value for the program setting."
id:
type: integer
description: "DAB service identifier."
DABDemodReport:
description: >
Live DAB demodulator, ensemble and selected-programme status. Synchronization,
discovered programmes and active audio do not by themselves prove clean reception;
check SNR after selecting a programme and after every receiver gain change.
properties:
channelPowerDB:
type: number
format: float
description: "Average power in the demodulator channel in dB."
channelSampleRate:
type: integer
description: "Effective complex channel sample rate in samples per second. DAB requires 2048000."
audioSampleRate:
type: integer
description: "Audio output sample rate in samples per second."
sync:
type: integer
minimum: 0
maximum: 1
description: "DAB synchronization state (1 synchronized, 0 not synchronized)."
snr:
type: integer
description: >
DAB decoder signal-to-noise ratio in dB. A value of 0 dB or less after
synchronization and audio become active is not a healthy result and can indicate
receiver overload. With an RTL-SDR, reduce tuner gain through its supported values,
wait briefly after each change, and re-read this report. Select the gain that gives
the best positive SNR rather than assuming that higher gain is better.
frequencyOffset:
type: integer
description: "Frequency offset estimated by the DAB decoder in Hz."
ensembleName:
type: string
description: "Label of the currently decoded ensemble."
ensembleId:
type: integer
description: "Identifier of the currently decoded ensemble."
programs:
type: array
description: "Programme services discovered in the currently tuned ensemble."
items:
$ref: "#/DABProgram"
selectedProgram:
type: string
description: "Exact service label currently requested by the program setting."
audioActive:
type: integer
minimum: 0
maximum: 1
description: "Whether programme audio metadata has been received and audio decoding is active."
bitrate:
type: integer
description: "Selected programme audio bitrate in kbit/s."
audio:
type: string
description: "Selected programme audio codec and channel-mode description."
language:
type: string
description: "Selected programme language."
programType:
type: string
description: "Selected programme type, such as News or Pop Music."
frameQuality:
type: integer
minimum: 0
maximum: 100
description: "Audio frame decode quality as a percentage."
reedSolomonQuality:
type: integer
minimum: 0
maximum: 100
description: "Reed-Solomon decode quality as a percentage."
aacQuality:
type: integer
minimum: 0
maximum: 100
description: "AAC decode quality as a percentage."
fibQuality:
type: integer
minimum: 0
maximum: 100
description: "Fast Information Block decode quality as a percentage."
tii:
type: integer
description: "Decoded Transmitter Identification Information value."
data:
type: string
description: "Latest dynamic text/data associated with the selected programme."

8
swagger/sdrangel/api/swagger/include/DATVDemod.yaml

@ -100,6 +100,8 @@ DATVDemodSettings: @@ -100,6 +100,8 @@ DATVDemodSettings:
description: RRC filter roll-off factor (0..1)
type: number
format: float
minimum: 0
maximum: 1
viterbi:
description: (boolean) (DVB-S)
type: integer
@ -174,6 +176,8 @@ DATVDemodReport: @@ -174,6 +176,8 @@ DATVDemodReport:
audioDecodeOK:
description: Audio decode (1 for OK, 0 for KO)
type: integer
minimum: 0
maximum: 1
videoActive:
description: Audio is active (1 for yes, 0 for now)
type: integer
@ -182,6 +186,8 @@ DATVDemodReport: @@ -182,6 +186,8 @@ DATVDemodReport:
videoDecodeOK:
description: Video decode (1 for OK, 0 for KO)
type: integer
minimum: 0
maximum: 1
udpRunning:
description: UDP thread (1 running, 0 idle)
type: integer
@ -223,6 +229,8 @@ DATVDemodReport: @@ -223,6 +229,8 @@ DATVDemodReport:
* 12: 3/5
setByModcod:
type: integer
minimum: 0
maximum: 1
description: Modulation and code rate set by DVB-S2 MODCOD (1 for yes, 0 for no)
mer:
type: number

2
swagger/sdrangel/api/swagger/include/DATVMod.yaml

@ -34,6 +34,8 @@ DATVModSettings: @@ -34,6 +34,8 @@ DATVModSettings:
imageOverlayTimestamp:
description: "Overlay timestamp on still image (1 for yes, 0 for no)"
type: integer
minimum: 0
maximum: 1
imageServiceProvider:
description: "Service provider name for image overlay"
type: string

10
swagger/sdrangel/api/swagger/include/DOA2.yaml

@ -21,9 +21,13 @@ DOA2Settings: @@ -21,9 +21,13 @@ DOA2Settings:
description: Phase difference correction in degrees from -180 to +180
antennaAz:
type: integer
minimum: 0
maximum: 359
description: Antennas azimuth from antenna 1 to antenna 2 in degrees from 0 to 359
basebandDistance:
type: integer
minimum: 1
maximum: 99999
description: Antennas baseline distance in millimeters from 1 to 99999
squelchdB:
type: integer
@ -65,12 +69,18 @@ DOA2Report: @@ -65,12 +69,18 @@ DOA2Report:
properties:
phi:
type: integer
minimum: 0
maximum: 180
description: Raw phase difference in degrees from 0 to 180
posAz:
type: integer
minimum: 0
maximum: 180
description: Calculated port side (positive) arrival angle in degrees from 0 to 180
negAz:
type: integer
minimum: 0
maximum: 180
description: Calculated starboard side (negative) arrival angle in degrees from 0 to 180
blindAngle:
type: integer

4
swagger/sdrangel/api/swagger/include/DSDDemod.yaml

@ -74,9 +74,13 @@ DSDDemodSettings: @@ -74,9 +74,13 @@ DSDDemodSettings:
traceStroke:
description: 0 to 255
type: integer
minimum: 0
maximum: 255
traceDecay:
description: 0 to 255
type: integer
minimum: 0
maximum: 255
streamIndex:
description: MIMO channel. Not relevant when connected to SI (single Rx).
type: integer

2
swagger/sdrangel/api/swagger/include/DeviceActions.yaml

@ -11,6 +11,8 @@ DeviceActions: @@ -11,6 +11,8 @@ DeviceActions:
direction:
description: 0 for Rx only, 1 for Tx only or 2 for any number and direction (default 0)
type: integer
minimum: 0
maximum: 2
originatorIndex:
description: Optional for reverse API. This is the device set index from where the message comes from.
type: integer

2
swagger/sdrangel/api/swagger/include/DeviceReports.yaml

@ -11,6 +11,8 @@ DeviceReport: @@ -11,6 +11,8 @@ DeviceReport:
direction:
description: 0 for Rx only, 1 for Tx only or 2 for any number and direction (default 0)
type: integer
minimum: 0
maximum: 2
airspyReport:
$ref: "http://swgserver:8081/api/swagger/include/Airspy.yaml#/AirspyReport"
description: "Airspy report data for Device."

2
swagger/sdrangel/api/swagger/include/DeviceSettings.yaml

@ -11,6 +11,8 @@ DeviceSettings: @@ -11,6 +11,8 @@ DeviceSettings:
direction:
description: 0 for Rx only, 1 for Tx only or 2 for any number and direction (default 0)
type: integer
minimum: 0
maximum: 2
originatorIndex:
description: Optional for reverse API. This is the device set index from where the message comes from.
type: integer

9
swagger/sdrangel/api/swagger/include/FeatureReport.yaml

@ -7,6 +7,15 @@ FeatureReport: @@ -7,6 +7,15 @@ FeatureReport:
featureType:
description: Feature type code
type: string
AISReport:
$ref: "http://swgserver:8081/api/swagger/include/AIS.yaml#/AISReport"
description: "Ais report data for Feature."
APRSReport:
$ref: "http://swgserver:8081/api/swagger/include/APRS.yaml#/APRSReport"
description: "Aprs report data for Feature."
RadiosondeReport:
$ref: "http://swgserver:8081/api/swagger/include/Radiosonde.yaml#/RadiosondeReport"
description: "Radiosonde report data for Feature."
AFCReport:
$ref: "http://swgserver:8081/api/swagger/include/AFC.yaml#/AFCReport"
description: "Afc report data for Feature."

72
swagger/sdrangel/api/swagger/include/FreqScanner.yaml

@ -2,18 +2,24 @@ FreqScannerSettings: @@ -2,18 +2,24 @@ FreqScannerSettings:
description: FreqScanner
properties:
channelBandwidth:
description: channel RF bandwidth in Hz
description: >
Bandwidth in Hz of each scanned channel.
type: integer
channelShift:
description: controlled channel frequency shift in Hz
description: >
Frequency shift in Hz applied to the tuned channel from the scanned frequency,
for modes such as SSB or CW where the signal sits on one side of centre.
type: integer
channelFrequencyOffset:
description: channel center frequency shift from baseband center in Hz
description: >
Minimum frequency shift in Hz of the tuned channel from the centre of
reception, used to keep it clear of a DC spike.
type: integer
threshold:
type: number
format: float
description: "Threshold setting for Freq scanner."
description: >
Power threshold in dB above which a scanned frequency counts as active.
frequencies:
type: array
description: "List of frequencies."
@ -21,28 +27,47 @@ FreqScannerSettings: @@ -21,28 +27,47 @@ FreqScannerSettings:
$ref: "http://swgserver:8081/api/swagger/include/FreqScanner.yaml#/FreqScannerFrequency"
channel:
type: string
description: "Channel identifier or configuration."
description: >
Channel that is tuned to the active frequency, as a device set and channel
index, for example "R1:0" for channel 0 of receive device set 1.
scanTime:
type: number
format: float
description: "Scan time setting for Freq scanner."
description: >
Time in seconds that each power measurement is averaged over.
retransmitTime:
type: number
format: float
description: "Retransmit time setting for Freq scanner."
description: >
Time in seconds to wait after the power on the active frequency falls below
the threshold before scanning restarts. In multiplex mode this is instead the
time spent listening to each frequency.
tuneTime:
type: number
format: float
description: "Tune time setting for Freq scanner."
description: >
Time in milliseconds to wait after retuning the device before measuring, to allow
for PLL settling and device to host transfer latency.
priority:
type: integer
description: "Priority setting for Freq scanner."
description: >
Which frequency becomes active when several are above the threshold
* 0 - the one with the highest power
* 1 - the one earliest in the frequency list
measurement:
type: integer
description: "Measurement setting for Freq scanner."
description: >
How channel power is measured from the FFT bins
* 0 - peak, the highest bin
* 1 - total, the sum of every bin
mode:
type: integer
description: "Mode setting for Freq scanner."
description: >
Run mode
* 0 - single, scan every frequency once and stop
* 1 - continuous, rescan when the active frequency goes quiet
* 2 - scan only, measure repeatedly without ever tuning the channel
* 3 - multiplex, step through the frequencies listening to each in turn
rgbColor:
type: integer
description: "Display color encoded as an RGB integer."
@ -108,25 +133,36 @@ FreqScannerFrequency: @@ -108,25 +133,36 @@ FreqScannerFrequency:
frequency:
type: integer
format: int64
description: "Frequency in Hz."
description: >
Frequency to scan, in Hz.
enabled:
type: integer
description: "Enabled for Freq scanner frequency."
description: >
Whether this frequency takes part in the scan (1 to scan it, 0 to skip it).
notes:
type: string
description: "Notes for Freq scanner frequency."
description: >
Free text note about this frequency, such as the station or service name.
channel:
type: string
description: "Channel identifier or configuration."
description: >
Overrides the scanner-wide channel for this frequency only, as a device set and
channel index such as "R1:0". Empty to use the scanner's own channel setting.
channelBandwidth:
type: string
description: "Channel bandwidth in Hz."
description: >
Overrides the scanner-wide channel bandwidth in Hz for this frequency only.
Empty to use the scanner's own setting.
threshold:
type: string
description: "Threshold for Freq scanner frequency."
description: >
Overrides the scanner-wide power threshold in dB for this frequency only.
Empty to use the scanner's own setting.
squelch:
type: string
description: "Squelch threshold in dB."
description: >
Squelch threshold in dB to apply to the tuned channel when this frequency becomes
active. Empty to leave the channel's own squelch alone.
FreqScannerActions:
description: "Frequency Scanner actions"

6
swagger/sdrangel/api/swagger/include/FreqTracker.yaml

@ -11,6 +11,8 @@ FreqTrackerSettings: @@ -11,6 +11,8 @@ FreqTrackerSettings:
format: float
log2Decim:
type: integer
minimum: 0
maximum: 6
description: "Base-2 exponent of the software decimation factor; the output sample rate is divided by 2^log2Decim."
squelch:
description: power squelch threshold in decibels
@ -32,6 +34,8 @@ FreqTrackerSettings: @@ -32,6 +34,8 @@ FreqTrackerSettings:
tracking:
description: Tracking 1 for enabled 0 for disabled
type: integer
minimum: 0
maximum: 1
trackerType:
description: Tracker element type (FLL, PLL...)
type: integer
@ -41,6 +45,8 @@ FreqTrackerSettings: @@ -41,6 +45,8 @@ FreqTrackerSettings:
rrc:
description: RRC filter (1 for on, 0 for off)
type: integer
minimum: 0
maximum: 1
rrcRolloff:
description: RRC filter rolloff factor in %
type: integer

54
swagger/sdrangel/api/swagger/include/GLScope.yaml

@ -5,8 +5,25 @@ TraceData: @@ -5,8 +5,25 @@ TraceData:
description: Source I/Q stream index
type: integer
projectionType:
description: Complex to real projection type. See Projector::ProjectionType
type: integer
description: >
Projection applied to turn the complex signal into a real trace
* 0 - real part
* 1 - imaginary part
* 2 - magnitude, linear
* 3 - squared magnitude (power), linear
* 4 - time derivative of the squared magnitude
* 5 - squared magnitude in dB
* 6 - phase
* 7 - direction of arrival from phase, positive branch
* 8 - direction of arrival from phase, negative branch
* 9 - phase derivative, instantaneous frequency
* 10 - BPSK phase comparator
* 11 - QPSK phase comparator
* 12 - 8-PSK phase comparator
* 13 - 16-PSK phase comparator
type: integer
minimum: 0
maximum: 13
inputIndex:
description: Input or feed index this trace is associated with
type: integer
@ -63,8 +80,25 @@ TriggerData: @@ -63,8 +80,25 @@ TriggerData:
description: Source I/Q stream index
type: integer
projectionType:
description: Complex to real projection type. See Projector::ProjectionType
type: integer
description: >
Projection applied to turn the complex signal into a real trace
* 0 - real part
* 1 - imaginary part
* 2 - magnitude, linear
* 3 - squared magnitude (power), linear
* 4 - time derivative of the squared magnitude
* 5 - squared magnitude in dB
* 6 - phase
* 7 - direction of arrival from phase, positive branch
* 8 - direction of arrival from phase, negative branch
* 9 - phase derivative, instantaneous frequency
* 10 - BPSK phase comparator
* 11 - QPSK phase comparator
* 12 - 8-PSK phase comparator
* 13 - 16-PSK phase comparator
type: integer
minimum: 0
maximum: 13
inputIndex:
description: Input or feed index this trigger is associated with
type: integer
@ -123,8 +157,16 @@ GLScope: @@ -123,8 +157,16 @@ GLScope:
description: GLScopeGUI settings
properties:
displayMode:
description: see GLScopeSettings::DisplayMode
type: integer
description: >
Arrangement of the two traces on the scope
* 0 - X and Y side by side horizontally
* 1 - X and Y stacked vertically
* 2 - X only
* 3 - Y only
* 4 - polar, Y against X
type: integer
minimum: 0
maximum: 4
traceIntensity:
type: integer
description: "Trace intensity for Gl scope."

373
swagger/sdrangel/api/swagger/include/GLSpectrum.yaml

@ -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

2
swagger/sdrangel/api/swagger/include/GS232Controller.yaml

@ -24,6 +24,8 @@ GS232ControllerSettings: @@ -24,6 +24,8 @@ GS232ControllerSettings:
track:
description: Track a target where azimuth and elevation are determined by another plugin (1 for yes, 0 for no)
type: integer
minimum: 0
maximum: 1
source:
description: "Identifier of the channel or feature plugin providing azimuth and elevation (E.g. R0:0 ADSBDemod)"
type: string

4
swagger/sdrangel/api/swagger/include/HackRF.yaml

@ -26,6 +26,8 @@ HackRFInputSettings: @@ -26,6 +26,8 @@ HackRFInputSettings:
fcPos:
description: 0=Infra 1=Supra 2=Center
type: integer
minimum: 0
maximum: 2
devSampleRate:
type: integer
description: "Device I/Q sample rate in samples per second before software decimation or interpolation."
@ -106,6 +108,8 @@ HackRFOutputSettings: @@ -106,6 +108,8 @@ HackRFOutputSettings:
fcPos:
description: 0=Infra 1=Supra 2=Center
type: integer
minimum: 0
maximum: 2
devSampleRate:
type: integer
description: "Device I/Q sample rate in samples per second before software decimation or interpolation."

2
swagger/sdrangel/api/swagger/include/ILSDemod.yaml

@ -12,6 +12,8 @@ ILSDemodSettings: @@ -12,6 +12,8 @@ ILSDemodSettings:
mode:
description: "(0 for LOC, 1 for G/S)"
type: integer
minimum: 0
maximum: 1
frequencyIndex:
type: integer
description: "Selected frequency index."

2
swagger/sdrangel/api/swagger/include/InmarsatDemod.yaml

@ -33,6 +33,8 @@ InmarsatDemodSettings: @@ -33,6 +33,8 @@ InmarsatDemodSettings:
udpFormat:
description: "0 for binary, 1 for NMEA"
type: integer
minimum: 0
maximum: 1
logFilename:
type: string
description: "Log file name or path."

13
swagger/sdrangel/api/swagger/include/Interferometer.yaml

@ -2,8 +2,19 @@ InterferometerSettings: @@ -2,8 +2,19 @@ InterferometerSettings:
description: Interferometer
properties:
correlationType:
description: see InterferometerSettings::CorrelationType
description: >
Operation applied to the two input streams
* 0 - stream 0 only
* 1 - stream 1 only
* 2 - add the streams
* 3 - multiply the streams
* 4 - inverse FFT of the cross spectrum
* 5 - inverse FFT of the conjugate cross spectrum
* 6 - FFT of the cross spectrum
* 7 - second form of the inverse FFT correlation
type: integer
minimum: 0
maximum: 7
rgbColor:
type: integer
description: "Display color encoded as an RGB integer."

2
swagger/sdrangel/api/swagger/include/KiwiSDR.yaml

@ -47,6 +47,8 @@ KiwiSDRReport: @@ -47,6 +47,8 @@ KiwiSDRReport:
status:
description: 0 for Idle, 1 for Connecting, 2 for Connected, 3 for Error, 4 for Disconnected
type: integer
minimum: 0
maximum: 4
latitude:
type: number
format: float

8
swagger/sdrangel/api/swagger/include/LimeRFE.yaml

@ -29,6 +29,8 @@ LimeRFESettings: @@ -29,6 +29,8 @@ LimeRFESettings:
* 1 - High: 1 - 4 GHz
rxHAMChannel:
type: integer
minimum: 0
maximum: 8
description: >
Rx HAM channel selection (LimeRFEController::HAMChannel)
* 0 - 30 MHz and lower
@ -42,6 +44,8 @@ LimeRFESettings: @@ -42,6 +44,8 @@ LimeRFESettings:
* 8 - 3300 - 3500 MHz
rxCellularChannel:
type: integer
minimum: 0
maximum: 4
description: >
Rx cellular channel selection (LimeRFEController::CellularChannel)
* 0 - Band 1: 1.92 - 1.98 GHz
@ -82,6 +86,8 @@ LimeRFESettings: @@ -82,6 +86,8 @@ LimeRFESettings:
* 1 - High: 1 - 4 GHz
txHAMChannel:
type: integer
minimum: 0
maximum: 8
description: >
Tx HAM channel selection (LimeRFEController::HAMChannel)
* 0 - 30 MHz and lower
@ -95,6 +101,8 @@ LimeRFESettings: @@ -95,6 +101,8 @@ LimeRFESettings:
* 8 - 3300 - 3500 MHz
txCellularChannel:
type: integer
minimum: 0
maximum: 4
description: >
Tx cellular channel selection (LimeRFEController::CellularChannel)
* 0 - Band 1: 1.92 - 1.98 GHz

4
swagger/sdrangel/api/swagger/include/M17Demod.yaml

@ -54,9 +54,13 @@ M17DemodSettings: @@ -54,9 +54,13 @@ M17DemodSettings:
traceStroke:
description: 0 to 255
type: integer
minimum: 0
maximum: 255
traceDecay:
description: 0 to 255
type: integer
minimum: 0
maximum: 255
audioDeviceName:
type: string
description: "Name of the audio device to use."

2
swagger/sdrangel/api/swagger/include/MCPServer.yaml

@ -6,6 +6,8 @@ MCPServerSettings: @@ -6,6 +6,8 @@ MCPServerSettings:
description: Address to bind the HTTP listener to. Defaults to 127.0.0.1 (local connections only)
port:
type: integer
minimum: 1024
maximum: 65535
description: TCP port the MCP server listens on
token:
type: string

157
swagger/sdrangel/api/swagger/include/Map.yaml

@ -4,9 +4,166 @@ MapSettings: @@ -4,9 +4,166 @@ MapSettings:
displayNames:
description: Display object names on the map (1 for yes, 0 for no)
type: integer
minimum: 0
maximum: 1
map2DEnabled:
description: Display the 2D map pane (1 for yes, 0 for no). Disable this while keeping map3DEnabled enabled to show only the 3D map.
type: integer
minimum: 0
maximum: 1
map3DEnabled:
description: Display the 3D map pane (1 for yes, 0 for no).
type: integer
minimum: 0
maximum: 1
mapProvider:
description: 2D map provider identifier.
type: string
mapType:
description: Selected 2D map type, for example Street Map or Satellite Map.
type: string
osmURL:
description: Custom OpenStreetMap tile-server URL.
type: string
mapBoxStyles:
description: Mapbox style identifier used by the selected 2D provider.
type: string
displaySelectedGroundTracks:
description: Display ground tracks for selected items (1 for yes, 0 for no).
type: integer
minimum: 0
maximum: 1
displayAllGroundTracks:
description: Display ground tracks for all items (1 for yes, 0 for no).
type: integer
minimum: 0
maximum: 1
terrain:
description: "Terrain used for 3D map (E.g: 'Ellipsoid' or 'Cesium World Terrain')"
type: string
buildings:
description: 3D buildings layer, for example None or Cesium OSM Buildings.
type: string
sunLightEnabled:
description: Light the globe from the Sun's direction (1 for yes, 0 for no).
type: integer
minimum: 0
maximum: 1
lightIntensity:
description: Camera light intensity used by the 3D map.
type: number
minimum: 0
eciCamera:
description: Use an ECI rather than ECEF camera frame (1 for yes, 0 for no).
type: integer
minimum: 0
maximum: 1
fxaa:
description: Enable fast approximate anti-aliasing (1 for yes, 0 for no).
type: integer
minimum: 0
maximum: 1
msaa:
description: Multisample anti-aliasing level.
type: integer
minimum: 1
maximum: 8
terrainLighting:
description: Enable terrain lighting (1 for yes, 0 for no).
type: integer
minimum: 0
maximum: 1
water:
description: Enable water effects (1 for yes, 0 for no).
type: integer
minimum: 0
maximum: 1
hdr:
description: Enable high dynamic range rendering (1 for yes, 0 for no).
type: integer
minimum: 0
maximum: 1
fog:
description: Enable atmospheric fog (1 for yes, 0 for no).
type: integer
minimum: 0
maximum: 1
fps:
description: Display the 3D map frame rate (1 for yes, 0 for no).
type: integer
minimum: 0
maximum: 1
displayMUF:
description: Display maximum-usable-frequency contours (1 for yes, 0 for no).
type: integer
minimum: 0
maximum: 1
displayfoF2:
description: Display F2 critical-frequency contours (1 for yes, 0 for no).
type: integer
minimum: 0
maximum: 1
displayRain:
description: Display weather-radar rain and snow overlay (1 for yes, 0 for no).
type: integer
minimum: 0
maximum: 1
displayClouds:
description: Display satellite infrared cloud overlay (1 for yes, 0 for no).
type: integer
minimum: 0
maximum: 1
displaySeaMarks:
description: Display sea marks (1 for yes, 0 for no).
type: integer
minimum: 0
maximum: 1
displayRailways:
description: Display railways (1 for yes, 0 for no).
type: integer
minimum: 0
maximum: 1
displayNASAGlobalImagery:
description: Display NASA GIBS imagery (1 for yes, 0 for no).
type: integer
minimum: 0
maximum: 1
nasaGlobalImageryIdentifier:
description: NASA GIBS imagery-layer identifier.
type: string
nasaGlobalImageryOpacity:
description: NASA GIBS imagery opacity as a percentage.
type: integer
minimum: 0
maximum: 100
displayAurora:
description: Display aurora-probability overlay (1 for yes, 0 for no).
type: integer
minimum: 0
maximum: 1
displayMagDec:
description: Display magnetic-declination contours (1 for yes, 0 for no).
type: integer
minimum: 0
maximum: 1
displayMaidenheadGrid:
description: Display Maidenhead grid (1 for yes, 0 for no).
type: integer
minimum: 0
maximum: 1
displayPFD:
description: Display the aircraft primary-flight display (1 for yes, 0 for no).
type: integer
minimum: 0
maximum: 1
viewFirstPerson:
description: Use first-person 3D map view (1 for yes, 0 for no).
type: integer
minimum: 0
maximum: 1
defaultImagery:
description: Default imagery layer for the 3D map.
type: string
title:
type: string
description: "User-visible title."

2
swagger/sdrangel/api/swagger/include/MeshcoreDemod.yaml

@ -161,6 +161,8 @@ MeshcoreDemodReport: @@ -161,6 +161,8 @@ MeshcoreDemodReport:
syncWord:
description: 2 bytes sync word (0..65535)
type: integer
minimum: 0
maximum: 65535
nbParityBits:
description: Hamming FEC parity bits (LoRa)
type: integer

2
swagger/sdrangel/api/swagger/include/MeshcoreMod.yaml

@ -53,6 +53,8 @@ MeshcoreModSettings: @@ -53,6 +53,8 @@ MeshcoreModSettings:
syncWord:
description: 2 byte (0..65535) synchronization syncWord
type: integer
minimum: 0
maximum: 65535
channelMute:
description: boolean
type: integer

2
swagger/sdrangel/api/swagger/include/MeshtasticDemod.yaml

@ -161,6 +161,8 @@ MeshtasticDemodReport: @@ -161,6 +161,8 @@ MeshtasticDemodReport:
syncWord:
description: 2 bytes sync word (0..65535)
type: integer
minimum: 0
maximum: 65535
nbParityBits:
description: Hamming FEC parity bits (LoRa)
type: integer

2
swagger/sdrangel/api/swagger/include/MeshtasticMod.yaml

@ -53,6 +53,8 @@ MeshtasticModSettings: @@ -53,6 +53,8 @@ MeshtasticModSettings:
syncWord:
description: 2 byte (0..65535) synchronization syncWord
type: integer
minimum: 0
maximum: 65535
channelMute:
description: boolean
type: integer

2
swagger/sdrangel/api/swagger/include/MetisMISO.yaml

@ -112,6 +112,8 @@ MetisMISOSettings: @@ -112,6 +112,8 @@ MetisMISOSettings:
description: "Selected sample rate index."
log2Decim:
type: integer
minimum: 0
maximum: 3
description: "Base-2 exponent of the software decimation factor; the output sample rate is divided by 2^log2Decim."
LOppmTenths:
type: integer

2
swagger/sdrangel/api/swagger/include/Perseus.yaml

@ -16,6 +16,8 @@ PerseusSettings: @@ -16,6 +16,8 @@ PerseusSettings:
description: "Selected dev sample rate index."
log2Decim:
type: integer
minimum: 0
maximum: 2
description: "Base-2 exponent of the software decimation factor; the output sample rate is divided by 2^log2Decim."
adcDither:
description: ADC dithering (1 if active else 0)

14
swagger/sdrangel/api/swagger/include/PlutoSdr.yaml

@ -25,12 +25,16 @@ PlutoSdrInputSettings: @@ -25,12 +25,16 @@ PlutoSdrInputSettings:
lpfFIRlog2Decim:
description: digital lowpass FIR filter log2 of decimation factor (0..2)
type: integer
minimum: 0
maximum: 2
lpfFIRGain:
description: digital lowpass FIR filter gain (dB)
type: integer
fcPos:
description: 0=Infra 1=Supra 2=Center
type: integer
minimum: 0
maximum: 2
dcBlock:
type: integer
description: "Enable DSP DC-offset correction (1 enabled, 0 disabled)."
@ -132,6 +136,8 @@ PlutoSdrOutputSettings: @@ -132,6 +136,8 @@ PlutoSdrOutputSettings:
lpfFIRlog2Interp:
description: digital lowpass FIR filter log2 of interpolation factor (0..2)
type: integer
minimum: 0
maximum: 2
lpfFIRGain:
description: digital lowpass FIR filter gain (dB)
type: integer
@ -217,6 +223,8 @@ PlutoSdrMIMOSettings: @@ -217,6 +223,8 @@ PlutoSdrMIMOSettings:
fcPosRx:
description: 0=Infra 1=Supra 2=Center
type: integer
minimum: 0
maximum: 2
rxTransverterMode:
type: integer
description: "Receive transverter mode setting for Pluto sdr MIMO."
@ -244,6 +252,8 @@ PlutoSdrMIMOSettings: @@ -244,6 +252,8 @@ PlutoSdrMIMOSettings:
lpfRxFIRlog2Decim:
description: digital lowpass FIR filter log2 of decimation factor (0..2)
type: integer
minimum: 0
maximum: 2
lpfRxFIRGain:
description: digital lowpass FIR filter gain (dB)
type: integer
@ -275,6 +285,8 @@ PlutoSdrMIMOSettings: @@ -275,6 +285,8 @@ PlutoSdrMIMOSettings:
fcPosTx:
description: 0=Infra 1=Supra 2=Center
type: integer
minimum: 0
maximum: 2
txTransverterMode:
type: integer
description: "Transmit transverter mode setting for Pluto sdr MIMO."
@ -294,6 +306,8 @@ PlutoSdrMIMOSettings: @@ -294,6 +306,8 @@ PlutoSdrMIMOSettings:
lpfTxFIRlog2Interp:
description: digital lowpass FIR filter log2 of interpolation factor (0..2)
type: integer
minimum: 0
maximum: 2
lpfTxFIRGain:
description: digital lowpass FIR filter gain (dB)
type: integer

8
swagger/sdrangel/api/swagger/include/Preset.yaml

@ -28,8 +28,14 @@ Preset: @@ -28,8 +28,14 @@ Preset:
description: Represents a Preset object
properties:
presetType:
description: See Preset::PresetType
description: >
Which kind of device set the preset applies to
* 0 - receiver
* 1 - transmitter
* 2 - MIMO
type: integer
minimum: 0
maximum: 2
group:
type: string
description: "Group for Preset."

6
swagger/sdrangel/api/swagger/include/RadioAstronomy.yaml

@ -32,15 +32,21 @@ RadioAstronomySettings: @@ -32,15 +32,21 @@ RadioAstronomySettings:
runMode:
description: "(0 for single, 1 for continuous, 2 for sweep)"
type: integer
minimum: 0
maximum: 2
sweepStartAtTime:
description: "(0 for now, 1 for at sweepStartDateTime)"
type: integer
minimum: 0
maximum: 1
sweepStartDateTime:
type: string
description: "Sweep start date time setting for Radio astronomy."
sweepType:
description: "(0 for Az/El, 1 for l/b, 2 for offset)"
type: integer
minimum: 0
maximum: 2
sweep1Start:
type: number
format: float

2
swagger/sdrangel/api/swagger/include/RadioClock.yaml

@ -8,6 +8,8 @@ RadioClockSettings: @@ -8,6 +8,8 @@ RadioClockSettings:
frequencyMode:
description: (0 for Offset, 1 for Absolute)
type: integer
minimum: 0
maximum: 1
frequency:
description: Channel center frequency
type: integer

91
swagger/sdrangel/api/swagger/include/Radiosonde.yaml

@ -39,3 +39,94 @@ RadiosondeSettings: @@ -39,3 +39,94 @@ RadiosondeSettings:
description: "List of radiosondes column sizes."
items:
type: integer
RadiosondeReport:
description: >
Radiosondes heard by the Radiosonde feature, which collects the decoded frames of every
radiosonde demodulator in the instance. A field is present only once a frame carrying it has
been received.
properties:
reportDateTime:
type: string
description: "When this snapshot was taken, ISO 8601."
radiosondeCount:
type: integer
description: "Number of radiosondes currently held."
radiosondes:
type: array
description: "The radiosondes heard."
items:
$ref: "http://swgserver:8081/api/swagger/include/Radiosonde.yaml#/Radiosonde"
Radiosonde:
description: Radiosonde heard by the Radiosonde feature
properties:
serial:
type: string
description: "Serial number, which identifies the sonde across a flight."
type:
type: string
description: "Sonde model, such as RS41."
latitude:
type: number
format: float
minimum: -90
maximum: 90
description: "Latitude in decimal degrees, north positive."
longitude:
type: number
format: float
minimum: -180
maximum: 180
description: "Longitude in decimal degrees, east positive."
altitude:
type: number
format: float
description: "Altitude in metres above mean sea level."
altitudeMax:
type: number
format: float
description: "Greatest altitude seen this flight in metres, which indicates the burst altitude."
speed:
type: number
format: float
description: "Ground speed in km/h."
verticalRate:
type: number
format: float
description: "Ascent rate in m/s. Negative after burst."
heading:
type: number
format: float
description: "Direction of travel in degrees true."
status:
type: string
description: "Status as reported by the sonde."
pressure:
type: number
format: float
description: "Atmospheric pressure in hPa."
temperature:
type: number
format: float
description: "Air temperature in degrees Celsius."
humidity:
type: number
format: float
description: "Relative humidity as a percentage."
frequency:
type: integer
format: int64
description: "Transmit frequency in Hz."
burstKillStatus:
type: string
description: "Whether the burst-kill timer is armed."
burstKillTimer:
type: string
description: "Time remaining on the burst-kill timer."
lastUpdate:
type: string
description: "When any field was last updated, ISO 8601."
messages:
type: integer
description: "Frames received from this radiosonde."

2
swagger/sdrangel/api/swagger/include/RemoteTCPInput.yaml

@ -34,6 +34,8 @@ RemoteTCPInputSettings: @@ -34,6 +34,8 @@ RemoteTCPInputSettings:
description: "Device I/Q sample rate in samples per second before software decimation or interpolation."
log2Decim:
type: integer
minimum: 0
maximum: 6
description: "Base-2 exponent of the software decimation factor; the output sample rate is divided by 2^log2Decim."
gain:
type: integer

7
swagger/sdrangel/api/swagger/include/RtlSdr.yaml

@ -12,6 +12,8 @@ RtlSdrSettings: @@ -12,6 +12,8 @@ RtlSdrSettings:
devSampleRate / 2^log2Decim.
lowSampleRate:
type: integer
minimum: 0
maximum: 1
description: "Use the RTL-SDR low sample-rate range (1 enabled, 0 disabled)."
centerFrequency:
type: integer
@ -19,7 +21,10 @@ RtlSdrSettings: @@ -19,7 +21,10 @@ RtlSdrSettings:
description: "Device center frequency in Hz."
gain:
type: integer
description: "Gain setting; units and available values depend on the device or plugin."
description: >
Tuner gain in tenths of a dB, so 496 means 49.6 dB. Only the discrete values the tuner
supports can be used; they are listed in the gains field of RtlSdrReport, which must be
read from the device report before setting this. Ignored unless agc is disabled.
loPpmCorrection:
type: integer
description: "Local-oscillator correction in parts per million."

2
swagger/sdrangel/api/swagger/include/SDRPlay.yaml

@ -28,6 +28,8 @@ SDRPlaySettings: @@ -28,6 +28,8 @@ SDRPlaySettings:
description: "Selected dev sample rate index."
log2Decim:
type: integer
minimum: 0
maximum: 6
description: "Base-2 exponent of the software decimation factor; the output sample rate is divided by 2^log2Decim."
fcPos:
type: integer

2
swagger/sdrangel/api/swagger/include/SDRPlayV3.yaml

@ -22,6 +22,8 @@ SDRPlayV3Settings: @@ -22,6 +22,8 @@ SDRPlayV3Settings:
description: "Device I/Q sample rate in samples per second before software decimation or interpolation."
log2Decim:
type: integer
minimum: 0
maximum: 6
description: "Base-2 exponent of the software decimation factor; the output sample rate is divided by 2^log2Decim."
fcPos:
type: integer

6
swagger/sdrangel/api/swagger/include/SID.yaml

@ -12,8 +12,10 @@ SIDSettings: @@ -12,8 +12,10 @@ SIDSettings:
type: integer
description: "Autoload setting for Sid."
filename:
type: integer
description: "Filename setting for Sid."
type: string
description: >
File that measurements are written to and read back from when autosave or
autoload is enabled.
autosavePeriod:
type: integer
description: "Autosave period setting for Sid."

2
swagger/sdrangel/api/swagger/include/SSBDemod.yaml

@ -100,6 +100,8 @@ SSBDemodSettings: @@ -100,6 +100,8 @@ SSBDemodSettings:
dnrAlpha:
type: number
format: float
minimum: 0
maximum: 1
description: Smoothing constant (alpha) of the exponential smoothing filter. Must be between 0 and 1.
rgbColor:
type: integer

10
swagger/sdrangel/api/swagger/include/SatelliteTracker.yaml

@ -81,9 +81,13 @@ SatelliteTrackerSettings: @@ -81,9 +81,13 @@ SatelliteTrackerSettings:
drawOnMap:
description: "Draw satellites on the Map (1 for yes, 0 for no)"
type: integer
minimum: 0
maximum: 1
autoTarget:
description: "Automatically select target on AOS (1 for yes, 0 for no)"
type: integer
minimum: 0
maximum: 1
aosSpeech:
description: "Speech warning on AOS"
type: string
@ -174,12 +178,18 @@ SatelliteDeviceSettings: @@ -174,12 +178,18 @@ SatelliteDeviceSettings:
startOnAOS:
description: "Start acquisition on AOS (1 for yes, 0 for no)"
type: integer
minimum: 0
maximum: 1
stopOnLOS:
description: "Stop acquisition on LOS (1 for yes, 0 for no)"
type: integer
minimum: 0
maximum: 1
startStopFileSinks:
description: "Start/stop file sinks on AOS/LOS (1 for yes, 0 for no)"
type: integer
minimum: 0
maximum: 1
frequency:
description: "Frequency to override in preset"
type: integer

10
swagger/sdrangel/api/swagger/include/SkyMap.yaml

@ -4,18 +4,28 @@ SkyMapSettings: @@ -4,18 +4,28 @@ SkyMapSettings:
displayNames:
description: "Display names on the sky map (1 for yes, 0 for no)"
type: integer
minimum: 0
maximum: 1
displayConstellations:
description: "Display constellations on the sky map (1 for yes, 0 for no)"
type: integer
minimum: 0
maximum: 1
displayReticle:
description: "Display reticle on the sky map (1 for yes, 0 for no)"
type: integer
minimum: 0
maximum: 1
displayGrid:
description: "Display grid on the sky map (1 for yes, 0 for no)"
type: integer
minimum: 0
maximum: 1
displayAntennaFoV:
description: "Display antenna field-of-view on the sky map (1 for yes, 0 for no)"
type: integer
minimum: 0
maximum: 1
map:
description: "WWT, ESASky or Aladin"
type: string

6
swagger/sdrangel/api/swagger/include/StarTracker.yaml

@ -94,12 +94,18 @@ StarTrackerSettings: @@ -94,12 +94,18 @@ StarTrackerSettings:
drawSunOnMap:
description: "Draw the overhead position of the Sun on the Map (1 for yes, 0 for no)"
type: integer
minimum: 0
maximum: 1
drawMoonOnMap:
description: "Draw the overhead position of the Moon on the Map (1 for yes, 0 for no)"
type: integer
minimum: 0
maximum: 1
drawStarOnMap:
description: "Draw the overhead position of the target Star on the Map (1 for yes, 0 for no)"
type: integer
minimum: 0
maximum: 1
title:
type: string
description: "User-visible title."

2
swagger/sdrangel/api/swagger/include/TestMOSync.yaml

@ -14,6 +14,8 @@ TestMOSyncSettings: @@ -14,6 +14,8 @@ TestMOSyncSettings:
description: "Sample rate in samples per second."
log2Interp:
type: integer
minimum: 0
maximum: 6
description: "Base-2 exponent of the software interpolation factor; the output sample rate is multiplied by 2^log2Interp."
fcPosTx:
description: See BladeRF2MIMO::fcPos_t

9
swagger/sdrangel/api/swagger/include/TestSource.yaml

@ -57,6 +57,15 @@ TestSourceSettings: @@ -57,6 +57,15 @@ TestSourceSettings:
type: number
format: float
description: "Phase imbalance setting for Test source."
period:
type: integer
description: "Period of the P1 and P2 patterns in samples."
minimum: 1
dutyCycle:
type: integer
description: "Percentage of the period the P2 pattern is high."
minimum: 0
maximum: 100
useReverseAPI:
description: Synchronize with reverse API (1 for yes, 0 for no)
type: integer

2
swagger/sdrangel/api/swagger/include/USRP.yaml

@ -39,6 +39,8 @@ USRPInputSettings: @@ -39,6 +39,8 @@ USRPInputSettings:
gainMode:
description: 0 for auto, 1 for manual
type: integer
minimum: 0
maximum: 1
clockSource:
type: string
description: "Clock source setting for Usrp input."

8
swagger/sdrangel/api/swagger/include/Xtrx.yaml

@ -241,6 +241,8 @@ XtrxMIMOSettings: @@ -241,6 +241,8 @@ XtrxMIMOSettings:
log2SoftDecim:
description: log2 of software decimation factor from 0 to 6
type: integer
minimum: 0
maximum: 6
rxCenterFrequency:
type: integer
format: int64
@ -258,6 +260,8 @@ XtrxMIMOSettings: @@ -258,6 +260,8 @@ XtrxMIMOSettings:
ncoEnableRx:
description: Enable TSP NCO Rx on both channels and mixing (1 for yes, 0 for no)
type: integer
minimum: 0
maximum: 1
ncoFrequencyRx:
description: Rx frequency shift from LO for both channels
type: integer
@ -339,6 +343,8 @@ XtrxMIMOSettings: @@ -339,6 +343,8 @@ XtrxMIMOSettings:
log2SoftInterp:
description: log2 of software interpolation factor from 0 to 6
type: integer
minimum: 0
maximum: 6
txCenterFrequency:
type: integer
format: int64
@ -346,6 +352,8 @@ XtrxMIMOSettings: @@ -346,6 +352,8 @@ XtrxMIMOSettings:
ncoEnableTx:
description: Enable TSP NCO Tx on both channels and mixing (1 for yes, 0 for no)
type: integer
minimum: 0
maximum: 1
ncoFrequencyTx:
description: Tx frequency shift from LO for both channels
type: integer

Loading…
Cancel
Save