Browse Source

Add descriptions and minimum and maximum values

chirpmodem-v8.0.0
Jon Beniston 3 months ago
parent
commit
3f6ddbe73c
  1. 59
      swagger/sdrangel/api/swagger/include/ADSBDemod.yaml
  2. 23
      swagger/sdrangel/api/swagger/include/AFC.yaml
  3. 13
      swagger/sdrangel/api/swagger/include/AIS.yaml
  4. 28
      swagger/sdrangel/api/swagger/include/AISDemod.yaml
  5. 56
      swagger/sdrangel/api/swagger/include/AISMod.yaml
  6. 11
      swagger/sdrangel/api/swagger/include/AMBE.yaml
  7. 19
      swagger/sdrangel/api/swagger/include/AMDemod.yaml
  8. 27
      swagger/sdrangel/api/swagger/include/AMMod.yaml
  9. 33
      swagger/sdrangel/api/swagger/include/APRS.yaml
  10. 14
      swagger/sdrangel/api/swagger/include/APTDemod.yaml
  11. 34
      swagger/sdrangel/api/swagger/include/ATVDemod.yaml
  12. 36
      swagger/sdrangel/api/swagger/include/ATVMod.yaml
  13. 20
      swagger/sdrangel/api/swagger/include/AaroniaRTSA.yaml
  14. 30
      swagger/sdrangel/api/swagger/include/Airspy.yaml
  15. 32
      swagger/sdrangel/api/swagger/include/AirspyHF.yaml
  16. 31
      swagger/sdrangel/api/swagger/include/AndroidSDRDriverInput.yaml
  17. 17
      swagger/sdrangel/api/swagger/include/AntennaTools.yaml
  18. 47
      swagger/sdrangel/api/swagger/include/AudioCATSISO.yaml
  19. 17
      swagger/sdrangel/api/swagger/include/AudioInput.yaml
  20. 11
      swagger/sdrangel/api/swagger/include/AudioOutput.yaml
  21. 56
      swagger/sdrangel/api/swagger/include/BFMDemod.yaml
  22. 15
      swagger/sdrangel/api/swagger/include/BeamSteeringCWMod.yaml
  23. 44
      swagger/sdrangel/api/swagger/include/BladeRF1.yaml
  24. 108
      swagger/sdrangel/api/swagger/include/BladeRF2.yaml
  25. 2
      swagger/sdrangel/api/swagger/include/CWKeyer.yaml
  26. 12
      swagger/sdrangel/api/swagger/include/ChannelActions.yaml
  27. 35
      swagger/sdrangel/api/swagger/include/ChannelAnalyzer.yaml
  28. 2
      swagger/sdrangel/api/swagger/include/ChannelMarker.yaml
  29. 15
      swagger/sdrangel/api/swagger/include/ChannelPower.yaml
  30. 56
      swagger/sdrangel/api/swagger/include/ChannelReport.yaml
  31. 66
      swagger/sdrangel/api/swagger/include/ChannelSettings.yaml
  32. 40
      swagger/sdrangel/api/swagger/include/ChirpChatDemod.yaml
  33. 31
      swagger/sdrangel/api/swagger/include/ChirpChatMod.yaml
  34. 10
      swagger/sdrangel/api/swagger/include/Command.yaml
  35. 20
      swagger/sdrangel/api/swagger/include/DABDemod.yaml
  36. 42
      swagger/sdrangel/api/swagger/include/DATVDemod.yaml
  37. 28
      swagger/sdrangel/api/swagger/include/DATVMod.yaml
  38. 15
      swagger/sdrangel/api/swagger/include/DOA2.yaml
  39. 33
      swagger/sdrangel/api/swagger/include/DSCDemod.yaml
  40. 37
      swagger/sdrangel/api/swagger/include/DSDDemod.yaml
  41. 16
      swagger/sdrangel/api/swagger/include/DemodAnalyzer.yaml
  42. 19
      swagger/sdrangel/api/swagger/include/Denoiser.yaml
  43. 1
      swagger/sdrangel/api/swagger/include/DeviceActions.yaml
  44. 33
      swagger/sdrangel/api/swagger/include/DeviceReports.yaml
  45. 47
      swagger/sdrangel/api/swagger/include/DeviceSettings.yaml
  46. 27
      swagger/sdrangel/api/swagger/include/EndOfTrainDemod.yaml
  47. 40
      swagger/sdrangel/api/swagger/include/FCDPro.yaml
  48. 29
      swagger/sdrangel/api/swagger/include/FCDProPlus.yaml
  49. 37
      swagger/sdrangel/api/swagger/include/FT8Demod.yaml
  50. 18
      swagger/sdrangel/api/swagger/include/FeatureActions.yaml
  51. 16
      swagger/sdrangel/api/swagger/include/FeatureReport.yaml
  52. 4
      swagger/sdrangel/api/swagger/include/FeatureSetPreset.yaml
  53. 25
      swagger/sdrangel/api/swagger/include/FeatureSettings.yaml
  54. 9
      swagger/sdrangel/api/swagger/include/FileInput.yaml
  55. 11
      swagger/sdrangel/api/swagger/include/FileOutput.yaml
  56. 27
      swagger/sdrangel/api/swagger/include/FileSink.yaml
  57. 18
      swagger/sdrangel/api/swagger/include/FileSource.yaml
  58. 23
      swagger/sdrangel/api/swagger/include/FreeDVDemod.yaml
  59. 30
      swagger/sdrangel/api/swagger/include/FreeDVMod.yaml
  60. 24
      swagger/sdrangel/api/swagger/include/FreqDisplay.yaml
  61. 32
      swagger/sdrangel/api/swagger/include/FreqScanner.yaml
  62. 17
      swagger/sdrangel/api/swagger/include/FreqTracker.yaml
  63. 11
      swagger/sdrangel/api/swagger/include/GLScope.yaml
  64. 58
      swagger/sdrangel/api/swagger/include/GLSpectrum.yaml
  65. 15
      swagger/sdrangel/api/swagger/include/GS232Controller.yaml
  66. 53
      swagger/sdrangel/api/swagger/include/HackRF.yaml
  67. 22
      swagger/sdrangel/api/swagger/include/HeatMap.yaml
  68. 49
      swagger/sdrangel/api/swagger/include/IEEE_802_15_4_Mod.yaml
  69. 43
      swagger/sdrangel/api/swagger/include/ILSDemod.yaml
  70. 29
      swagger/sdrangel/api/swagger/include/InmarsatDemod.yaml
  71. 18
      swagger/sdrangel/api/swagger/include/Interferometer.yaml
  72. 11
      swagger/sdrangel/api/swagger/include/JogdialController.yaml
  73. 22
      swagger/sdrangel/api/swagger/include/KiwiSDR.yaml
  74. 45
      swagger/sdrangel/api/swagger/include/LimeRFE.yaml
  75. 169
      swagger/sdrangel/api/swagger/include/LimeSdr.yaml
  76. 16
      swagger/sdrangel/api/swagger/include/LocalInput.yaml
  77. 10
      swagger/sdrangel/api/swagger/include/LocalOutput.yaml
  78. 25
      swagger/sdrangel/api/swagger/include/LocalSink.yaml
  79. 16
      swagger/sdrangel/api/swagger/include/LocalSource.yaml
  80. 31
      swagger/sdrangel/api/swagger/include/M17Demod.yaml
  81. 41
      swagger/sdrangel/api/swagger/include/M17Mod.yaml
  82. 75
      swagger/sdrangel/api/swagger/include/MCPServer.yaml
  83. 48
      swagger/sdrangel/api/swagger/include/Map.yaml
  84. 36
      swagger/sdrangel/api/swagger/include/MeshcoreDemod.yaml
  85. 29
      swagger/sdrangel/api/swagger/include/MeshcoreMod.yaml
  86. 36
      swagger/sdrangel/api/swagger/include/MeshtasticDemod.yaml
  87. 27
      swagger/sdrangel/api/swagger/include/MeshtasticMod.yaml
  88. 37
      swagger/sdrangel/api/swagger/include/MetisMISO.yaml
  89. 22
      swagger/sdrangel/api/swagger/include/MorseDecoder.yaml
  90. 24
      swagger/sdrangel/api/swagger/include/NFMDemod.yaml
  91. 41
      swagger/sdrangel/api/swagger/include/NFMMod.yaml
  92. 27
      swagger/sdrangel/api/swagger/include/NavtexDemod.yaml
  93. 29
      swagger/sdrangel/api/swagger/include/NoiseFigure.yaml
  94. 21
      swagger/sdrangel/api/swagger/include/PERTester.yaml
  95. 43
      swagger/sdrangel/api/swagger/include/PSK31Mod.yaml
  96. 26
      swagger/sdrangel/api/swagger/include/PacketDemod.yaml
  97. 76
      swagger/sdrangel/api/swagger/include/PacketMod.yaml
  98. 29
      swagger/sdrangel/api/swagger/include/PagerDemod.yaml
  99. 19
      swagger/sdrangel/api/swagger/include/Perseus.yaml
  100. 112
      swagger/sdrangel/api/swagger/include/PlutoSdr.yaml
  101. Some files were not shown because too many files have changed in this diff Show More

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

@ -12,16 +12,22 @@ ADSBDemodSettings: @@ -12,16 +12,22 @@ ADSBDemodSettings:
correlationThreshold:
type: number
format: float
description: "Minimum correlation score required to accept a frame preamble."
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
maximum: 1
description: >
Demodulate all mode S frames or just ADS-B
* 0 - just ADS-B
@ -35,10 +41,16 @@ ADSBDemodSettings: @@ -35,10 +41,16 @@ ADSBDemodSettings:
description: Number of taps per phase in channel interpolator
removeTimeout:
type: integer
description: "Time after which an inactive tracked item is removed."
feedEnabled:
type: integer
description: "Enable forwarding of received data to the configured feed (1 enabled, 0 disabled)."
minimum: 0
maximum: 1
exportClientEnabled:
type: integer
minimum: 0
maximum: 1
description: >
Send data to server
* 0 - Do not send data
@ -48,20 +60,35 @@ ADSBDemodSettings: @@ -48,20 +60,35 @@ ADSBDemodSettings:
type: string
exportClientPort:
type: integer
description: "Export client port."
minimum: 1
maximum: 65535
exportClientFormat:
type: integer
minimum: 0
maximum: 1
description: >
Format of sent data
* 0 - Beast binary
* 1 - Beast hex
exportServerEnabled:
type: integer
description: "Enable the data-export server (1 enabled, 0 disabled)."
minimum: 0
maximum: 1
exportServerPort:
type: integer
description: "Export server port."
minimum: 1
maximum: 65535
importEnabled:
type: integer
description: "Enable importing data from the configured service (1 enabled, 0 disabled)."
minimum: 0
maximum: 1
importHost:
type: string
description: "Import host setting for ADS-B demod."
importUsername:
type: string
description: OpenSky OAuth2 client ID.
@ -70,43 +97,65 @@ ADSBDemodSettings: @@ -70,43 +97,65 @@ ADSBDemodSettings:
description: OpenSky OAuth2 client secret.
importParameters:
type: string
description: "Import parameters setting for ADS-B demod."
importPeriod:
type: number
format: float
description: "Import period setting for ADS-B demod."
importMinLatitude:
type: string
description: "Import min latitude setting for ADS-B demod."
importMaxLatitude:
type: string
description: "Import max latitude setting for ADS-B demod."
importMinLongitude:
type: string
description: "Import min longitude setting for ADS-B demod."
importMaxLongitude:
type: string
description: "Import max longitude setting for ADS-B demod."
logFilename:
type: string
description: "Log file name or path."
logEnabled:
type: integer
description: "Enable logging to the configured file (1 enabled, 0 disabled)."
minimum: 0
maximum: 1
rgbColor:
type: integer
description: "Display color encoded as an RGB integer."
title:
type: string
description: "User-visible title."
streamIndex:
description: MIMO channel. Not relevant when connected to SI (single Rx).
type: integer
useReverseAPI:
description: Synchronize with reverse API (1 for yes, 0 for no)
type: integer
minimum: 0
maximum: 1
reverseAPIAddress:
type: string
description: "IPv4 address or host name of the reverse API peer."
reverseAPIPort:
type: integer
description: "TCP port of the reverse API peer."
minimum: 1
maximum: 65535
reverseAPIDeviceIndex:
type: integer
description: "Device-set index used by the reverse API peer."
reverseAPIChannelIndex:
type: integer
description: "Channel index used by the reverse API peer."
channelMarker:
$ref: "http://swgserver:8081/api/swagger/include/ChannelMarker.yaml#/ChannelMarker"
description: "Channel-marker display configuration."
rollupState:
$ref: "http://swgserver:8081/api/swagger/include/RollupState.yaml#/RollupState"
description: "Saved expanded or collapsed state of the GUI sections."
ADSBDemodReport:
description: ADSBDemod
@ -117,19 +166,25 @@ ADSBDemodReport: @@ -117,19 +166,25 @@ ADSBDemodReport:
format: float
channelSampleRate:
type: integer
description: "Effective sample rate delivered to the channel in samples per second."
targetName:
type: string
description: "Name of the selected or tracked target."
targetAzimuth:
type: number
format: float
description: "Target azimuth in degrees clockwise from north."
targetElevation:
type: number
format: float
description: "Target elevation in degrees above the horizon."
targetRange:
type: number
format: float
description: "Distance to the selected or tracked target."
aircraftState:
type: array
description: "Current states of aircraft tracked by the ADS-B demodulator."
items:
$ref: "http://swgserver:8081/api/swagger/include/ADSBDemod.yaml#/ADSBDemodAircraftState"
@ -145,10 +200,14 @@ ADSBDemodAircraftState: @@ -145,10 +200,14 @@ ADSBDemodAircraftState:
description: "Latitude of aircraft in degrees"
type: number
format: float
minimum: -90
maximum: 90
longitude:
description: "Longitude of aircraft in degrees"
type: number
format: float
minimum: -180
maximum: 180
altitude:
description: "Altitude of aircraft in feet"
type: integer

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

@ -3,8 +3,10 @@ AFCSettings: @@ -3,8 +3,10 @@ AFCSettings:
properties:
title:
type: string
description: "User-visible title."
rgbColor:
type: integer
description: "Display color encoded as an RGB integer."
trackerDeviceSetIndex:
description: index of the device set of frequency tracker being used
type: integer
@ -13,12 +15,16 @@ AFCSettings: @@ -13,12 +15,16 @@ AFCSettings:
type: integer
hasTargetFrequency:
type: integer
minimum: 0
maximum: 1
description: >
Adjust device frequency to match tracker frequency
* 0 - disabled
* 1 - enabled
transverterTarget:
type: integer
minimum: 0
maximum: 1
description: >
Use transverter or device frequency for tracker frequency adjustment
* 0 - device
@ -36,22 +42,33 @@ AFCSettings: @@ -36,22 +42,33 @@ AFCSettings:
useReverseAPI:
description: Synchronize with reverse API (1 for yes, 0 for no)
type: integer
minimum: 0
maximum: 1
reverseAPIAddress:
type: string
description: "IPv4 address or host name of the reverse API peer."
reverseAPIPort:
type: integer
description: "TCP port of the reverse API peer."
minimum: 1
maximum: 65535
reverseAPIFeatureSetIndex:
type: integer
description: "Feature-set index used by the reverse API peer."
reverseAPIFeatureIndex:
type: integer
description: "Feature index used by the reverse API peer."
rollupState:
$ref: "http://swgserver:8081/api/swagger/include/RollupState.yaml#/RollupState"
description: "Saved expanded or collapsed state of the GUI sections."
AFCReport:
description: "AFC report"
properties:
runningState:
type: integer
minimum: 0
maximum: 3
description: >
Running state
* 0 - not started
@ -74,18 +91,24 @@ AFCActions: @@ -74,18 +91,24 @@ AFCActions:
properties:
run:
type: integer
minimum: 0
maximum: 1
description: >
Set the plugin running state
* 0 - idle
* 1 - run
deviceTrack:
type: integer
minimum: 0
maximum: 1
description: >
(Re)initialize tracker target frequency adjustment
* 0 - release
* 1 - engage
devicesApply:
type: integer
minimum: 0
maximum: 1
description: >
(Re)initialize device sets tracking
* 0 - release

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

@ -3,26 +3,39 @@ AISSettings: @@ -3,26 +3,39 @@ AISSettings:
properties:
title:
type: string
description: "User-visible title."
rgbColor:
type: integer
description: "Display color encoded as an RGB integer."
useReverseAPI:
description: Synchronize with reverse API (1 for yes, 0 for no)
type: integer
minimum: 0
maximum: 1
reverseAPIAddress:
type: string
description: "IPv4 address or host name of the reverse API peer."
reverseAPIPort:
type: integer
description: "TCP port of the reverse API peer."
minimum: 1
maximum: 65535
reverseAPIFeatureSetIndex:
type: integer
description: "Feature-set index used by the reverse API peer."
reverseAPIFeatureIndex:
type: integer
description: "Feature index used by the reverse API peer."
rollupState:
$ref: "http://swgserver:8081/api/swagger/include/RollupState.yaml#/RollupState"
description: "Saved expanded or collapsed state of the GUI sections."
vesselColumnIndexes:
type: array
description: "List of vessel column indexes."
items:
type: integer
vesselColumnSizes:
type: array
description: "List of vessel column sizes."
items:
type: integer

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

@ -7,12 +7,15 @@ AISDemodSettings: @@ -7,12 +7,15 @@ AISDemodSettings:
inputFrequencyOffset:
type: integer
format: int64
description: "Channel frequency offset from the device center frequency in Hz."
rfBandwidth:
type: number
format: float
description: "RF bandwidth in Hz."
fmDeviation:
type: number
format: float
description: "FM frequency deviation in Hz."
correlationThreshold:
description: "Normalised correlation threshold with the preamble, from 0 to 1"
type: number
@ -20,45 +23,69 @@ AISDemodSettings: @@ -20,45 +23,69 @@ AISDemodSettings:
udpEnabled:
description: "Whether to forward received messages to specified UDP port"
type: integer
minimum: 0
maximum: 1
udpAddress:
description: "UDP address to forward received messages to"
type: string
udpPort:
description: "UDP port to forward received messages to"
type: integer
minimum: 1
maximum: 65535
udpFormat:
description: "0 for binary, 1 for NMEA"
type: integer
logFilename:
type: string
description: "Log file name or path."
logEnabled:
type: integer
description: "Enable logging to the configured file (1 enabled, 0 disabled)."
minimum: 0
maximum: 1
useFileTime:
type: integer
description: "Enable file time (1 enabled, 0 disabled)."
minimum: 0
maximum: 1
rgbColor:
type: integer
description: "Display color encoded as an RGB integer."
title:
type: string
description: "User-visible title."
streamIndex:
description: MIMO channel. Not relevant when connected to SI (single Rx).
type: integer
useReverseAPI:
description: Synchronize with reverse API (1 for yes, 0 for no)
type: integer
minimum: 0
maximum: 1
reverseAPIAddress:
type: string
description: "IPv4 address or host name of the reverse API peer."
reverseAPIPort:
type: integer
description: "TCP port of the reverse API peer."
minimum: 1
maximum: 65535
reverseAPIDeviceIndex:
type: integer
description: "Device-set index used by the reverse API peer."
reverseAPIChannelIndex:
type: integer
description: "Channel index used by the reverse API peer."
scopeConfig:
$ref: "http://swgserver:8081/api/swagger/include/GLScope.yaml#/GLScope"
description: "Oscilloscope-display configuration."
channelMarker:
$ref: "http://swgserver:8081/api/swagger/include/ChannelMarker.yaml#/ChannelMarker"
description: "Channel-marker display configuration."
rollupState:
$ref: "http://swgserver:8081/api/swagger/include/RollupState.yaml#/RollupState"
description: "Saved expanded or collapsed state of the GUI sections."
AISDemodReport:
description: AISDemod
@ -69,3 +96,4 @@ AISDemodReport: @@ -69,3 +96,4 @@ AISDemodReport:
format: float
channelSampleRate:
type: integer
description: "Effective sample rate delivered to the channel in samples per second."

56
swagger/sdrangel/api/swagger/include/AISMod.yaml

@ -7,6 +7,7 @@ AISModSettings: @@ -7,6 +7,7 @@ AISModSettings:
format: int64
baud:
type: integer
description: "Symbol or serial rate in baud."
rfBandwidth:
description: channel RF bandwidth in Hz
type: number
@ -17,35 +18,53 @@ AISModSettings: @@ -17,35 +18,53 @@ AISModSettings:
gain:
type: number
format: float
description: "Gain setting; units and available values depend on the device or plugin."
channelMute:
type: integer
description: "Mute the channel output (1 muted, 0 unmuted)."
minimum: 0
maximum: 1
repeat:
type: integer
description: "Repeat transmission or playback (1 enabled, 0 disabled)."
minimum: 0
maximum: 1
repeatDelay:
type: number
format: float
description: "Delay between repetitions."
repeatCount:
type: integer
description: "Number of repetitions."
rampUpBits:
type: integer
description: "Ramp up bits setting for AIS mod."
rampDownBits:
type: integer
description: "Ramp down bits setting for AIS mod."
rampRange:
type: integer
description: "Ramp range setting for AIS mod."
rfNoise:
type: integer
minimum: 0
maximum: 1
description: >
Boolean
* 0 - off
* 1 - on
writeToFile:
type: integer
minimum: 0
maximum: 1
description: >
Boolean
* 0 - off
* 1 - on
msgType:
type: integer
minimum: 0
maximum: 3
description: >
Message Type
* 0 - Scheduled position report
@ -54,8 +73,11 @@ AISModSettings: @@ -54,8 +73,11 @@ AISModSettings:
* 3 - Base station report
mmsi:
type: string
description: "Maritime Mobile Service Identity number."
status:
type: integer
minimum: 0
maximum: 8
description: >
Ship status
* 0 - Under way using engine
@ -71,55 +93,83 @@ AISModSettings: @@ -71,55 +93,83 @@ AISModSettings:
latitude:
type: number
format: float
description: "Latitude in degrees, positive north."
minimum: -90
maximum: 90
longitude:
type: number
format: float
description: "Longitude in degrees, positive east."
minimum: -180
maximum: 180
course:
type: number
format: float
description: "Course over ground in degrees."
speed:
type: number
format: float
description: "Reported speed."
heading:
type: integer
description: "Heading in degrees."
data:
type: string
description: "Payload data."
bt:
type: number
format: float
description: "Bt setting for AIS mod."
symbolSpan:
type: integer
description: "Symbol span setting for AIS mod."
rgbColor:
type: integer
description: "Display color encoded as an RGB integer."
title:
type: string
description: "User-visible title."
streamIndex:
description: MIMO channel. Not relevant when connected to SI (single Rx).
type: integer
useReverseAPI:
description: Synchronize with reverse API (1 for yes, 0 for no)
type: integer
minimum: 0
maximum: 1
reverseAPIAddress:
type: string
description: "IPv4 address or host name of the reverse API peer."
reverseAPIPort:
type: integer
description: "TCP port of the reverse API peer."
minimum: 1
maximum: 65535
reverseAPIDeviceIndex:
type: integer
description: "Device-set index used by the reverse API peer."
reverseAPIChannelIndex:
type: integer
description: "Channel index used by the reverse API peer."
udpEnabled:
description: "Whether to receive messages to transmit on specified UDP port"
type: integer
minimum: 0
maximum: 1
udpAddress:
description: "UDP address to receive messages to transmit via"
type: string
udpPort:
description: "UDP port to receive messages to transmit via"
type: integer
minimum: 1
maximum: 65535
channelMarker:
$ref: "http://swgserver:8081/api/swagger/include/ChannelMarker.yaml#/ChannelMarker"
description: "Channel-marker display configuration."
rollupState:
$ref: "http://swgserver:8081/api/swagger/include/RollupState.yaml#/RollupState"
description: "Saved expanded or collapsed state of the GUI sections."
AISModReport:
description: AISMod
@ -130,21 +180,27 @@ AISModReport: @@ -130,21 +180,27 @@ AISModReport:
format: float
channelSampleRate:
type: integer
description: "Effective sample rate delivered to the channel in samples per second."
AISModActions:
description: AISMod
properties:
tx:
type: integer
minimum: 0
maximum: 1
description: >
Transmit stored message
* 0 - do nothing
* 1 - transmit
encode:
type: integer
minimum: 0
maximum: 1
description: >
Encode message from discrete data
* 0 - do nothing
* 1 - encode
data:
type: string
description: "Payload data."

11
swagger/sdrangel/api/swagger/include/AMBE.yaml

@ -3,21 +3,32 @@ AMBESettings: @@ -3,21 +3,32 @@ AMBESettings:
properties:
title:
type: string
description: "User-visible title."
rgbColor:
type: integer
description: "Display color encoded as an RGB integer."
useReverseAPI:
description: Synchronize with reverse API (1 for yes, 0 for no)
type: integer
minimum: 0
maximum: 1
reverseAPIAddress:
type: string
description: "IPv4 address or host name of the reverse API peer."
reverseAPIPort:
type: integer
description: "TCP port of the reverse API peer."
minimum: 1
maximum: 65535
reverseAPIFeatureSetIndex:
type: integer
description: "Feature-set index used by the reverse API peer."
reverseAPIFeatureIndex:
type: integer
description: "Feature index used by the reverse API peer."
rollupState:
$ref: "http://swgserver:8081/api/swagger/include/RollupState.yaml#/RollupState"
description: "Saved expanded or collapsed state of the GUI sections."
AMBEReport:
description: AMBE

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

@ -20,17 +20,24 @@ AMDemodSettings: @@ -20,17 +20,24 @@ AMDemodSettings:
volume:
type: number
format: float
description: "Audio volume multiplier."
audioMute:
type: integer
description: "Mute audio output (1 muted, 0 unmuted)."
minimum: 0
maximum: 1
bandpassEnable:
description: use bandpass filter (1 for yes, 0 for no)
type: integer
rgbColor:
type: integer
description: "Display color encoded as an RGB integer."
title:
type: string
description: "User-visible title."
audioDeviceName:
type: string
description: "Name of the audio device to use."
pll:
description: PLL active (for synchronous AM)
type: integer
@ -53,18 +60,28 @@ AMDemodSettings: @@ -53,18 +60,28 @@ AMDemodSettings:
useReverseAPI:
description: Synchronize with reverse API (1 for yes, 0 for no)
type: integer
minimum: 0
maximum: 1
reverseAPIAddress:
type: string
description: "IPv4 address or host name of the reverse API peer."
reverseAPIPort:
type: integer
description: "TCP port of the reverse API peer."
minimum: 1
maximum: 65535
reverseAPIDeviceIndex:
type: integer
description: "Device-set index used by the reverse API peer."
reverseAPIChannelIndex:
type: integer
description: "Channel index used by the reverse API peer."
channelMarker:
$ref: "http://swgserver:8081/api/swagger/include/ChannelMarker.yaml#/ChannelMarker"
description: "Channel-marker display configuration."
rollupState:
$ref: "http://swgserver:8081/api/swagger/include/RollupState.yaml#/RollupState"
description: "Saved expanded or collapsed state of the GUI sections."
AMDemodReport:
description: AMDemod
@ -78,5 +95,7 @@ AMDemodReport: @@ -78,5 +95,7 @@ AMDemodReport:
type: integer
audioSampleRate:
type: integer
description: "Audio sample rate in samples per second."
channelSampleRate:
type: integer
description: "Effective sample rate delivered to the channel in samples per second."

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

@ -4,9 +4,11 @@ AMModSettings: @@ -4,9 +4,11 @@ AMModSettings:
inputFrequencyOffset:
type: integer
format: int64
description: "Channel frequency offset from the device center frequency in Hz."
rfBandwidth:
type: number
format: float
description: "RF bandwidth in Hz."
modFactor:
description: modulation factor from 0.0 to 1.0
type: number
@ -14,41 +16,64 @@ AMModSettings: @@ -14,41 +16,64 @@ AMModSettings:
toneFrequency:
type: number
format: float
description: "Tone frequency in Hz."
volumeFactor:
type: number
format: float
description: "Volume factor setting for Am mod."
channelMute:
type: integer
description: "Mute the channel output (1 muted, 0 unmuted)."
minimum: 0
maximum: 1
playLoop:
type: integer
description: "Loop playback at end of file (1 enabled, 0 disabled)."
minimum: 0
maximum: 1
rgbColor:
type: integer
description: "Display color encoded as an RGB integer."
title:
type: string
description: "User-visible title."
audioDeviceName:
type: string
description: "Name of the audio device to use."
modAFInput:
type: integer
description: "Audio-frequency modulation input selection."
streamIndex:
description: MIMO channel. Not relevant when connected to SI (single Rx).
type: integer
useReverseAPI:
description: Synchronize with reverse API (1 for yes, 0 for no)
type: integer
minimum: 0
maximum: 1
reverseAPIAddress:
type: string
description: "IPv4 address or host name of the reverse API peer."
reverseAPIPort:
type: integer
description: "TCP port of the reverse API peer."
minimum: 1
maximum: 65535
reverseAPIDeviceIndex:
type: integer
description: "Device-set index used by the reverse API peer."
reverseAPIChannelIndex:
type: integer
description: "Channel index used by the reverse API peer."
cwKeyer:
$ref: "http://swgserver:8081/api/swagger/include/CWKeyer.yaml#/CWKeyerSettings"
description: "CW keyer configuration."
channelMarker:
$ref: "http://swgserver:8081/api/swagger/include/ChannelMarker.yaml#/ChannelMarker"
description: "Channel-marker display configuration."
rollupState:
$ref: "http://swgserver:8081/api/swagger/include/RollupState.yaml#/RollupState"
description: "Saved expanded or collapsed state of the GUI sections."
AMModReport:
description: AMMod
@ -59,5 +84,7 @@ AMModReport: @@ -59,5 +84,7 @@ AMModReport:
format: float
audioSampleRate:
type: integer
description: "Audio sample rate in samples per second."
channelSampleRate:
type: integer
description: "Effective sample rate delivered to the channel in samples per second."

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

@ -3,78 +3,111 @@ APRSSettings: @@ -3,78 +3,111 @@ APRSSettings:
properties:
igateServer:
type: string
description: "Igate server setting for Aprs."
igatePort:
type: integer
description: "Igate port."
minimum: 1
maximum: 65535
igateCallsign:
type: string
description: "Igate callsign setting for Aprs."
igatePasscode:
type: string
description: "Igate passcode setting for Aprs."
igateFilter:
type: string
description: "Igate filter setting for Aprs."
igateEnabled:
type: integer
description: "Enable igate (1 enabled, 0 disabled)."
minimum: 0
maximum: 1
title:
type: string
description: "User-visible title."
rgbColor:
type: integer
description: "Display color encoded as an RGB integer."
useReverseAPI:
description: Synchronize with reverse API (1 for yes, 0 for no)
type: integer
minimum: 0
maximum: 1
reverseAPIAddress:
type: string
description: "IPv4 address or host name of the reverse API peer."
reverseAPIPort:
type: integer
description: "TCP port of the reverse API peer."
minimum: 1
maximum: 65535
reverseAPIFeatureSetIndex:
type: integer
description: "Feature-set index used by the reverse API peer."
reverseAPIFeatureIndex:
type: integer
description: "Feature index used by the reverse API peer."
rollupState:
$ref: "http://swgserver:8081/api/swagger/include/RollupState.yaml#/RollupState"
description: "Saved expanded or collapsed state of the GUI sections."
packetsTableColumnIndexes:
type: array
description: "List of packets table column indexes."
items:
type: integer
packetsTableColumnSizes:
type: array
description: "List of packets table column sizes."
items:
type: integer
weatherTableColumnIndexes:
type: array
description: "List of weather table column indexes."
items:
type: integer
weatherTableColumnSizes:
type: array
description: "List of weather table column sizes."
items:
type: integer
statusTableColumnIndexes:
type: array
description: "List of status table column indexes."
items:
type: integer
statusTableColumnSizes:
type: array
description: "List of status table column sizes."
items:
type: integer
messagesTableColumnIndexes:
type: array
description: "List of messages table column indexes."
items:
type: integer
messagesTableColumnSizes:
type: array
description: "List of messages table column sizes."
items:
type: integer
telemetryTableColumnIndexes:
type: array
description: "List of telemetry table column indexes."
items:
type: integer
telemetryTableColumnSizes:
type: array
description: "List of telemetry table column sizes."
items:
type: integer
motionTableColumnIndexes:
type: array
description: "List of motion table column indexes."
items:
type: integer
motionTableColumnSizes:
type: array
description: "List of motion table column sizes."
items:
type: integer

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

@ -36,6 +36,8 @@ APTDemodSettings: @@ -36,6 +36,8 @@ APTDemodSettings:
decodeEnabled:
description: Controls whether the decoder is enabled
type: integer
minimum: 0
maximum: 1
autoSave:
description: Automatically save images when acquisition is stopped
type: integer
@ -85,26 +87,38 @@ APTDemodSettings: @@ -85,26 +87,38 @@ APTDemodSettings:
format: float
rgbColor:
type: integer
description: "Display color encoded as an RGB integer."
title:
type: string
description: "User-visible title."
streamIndex:
description: MIMO channel. Not relevant when connected to SI (single Rx).
type: integer
useReverseAPI:
description: Synchronize with reverse API (1 for yes, 0 for no)
type: integer
minimum: 0
maximum: 1
reverseAPIAddress:
type: string
description: "IPv4 address or host name of the reverse API peer."
reverseAPIPort:
type: integer
description: "TCP port of the reverse API peer."
minimum: 1
maximum: 65535
reverseAPIDeviceIndex:
type: integer
description: "Device-set index used by the reverse API peer."
reverseAPIChannelIndex:
type: integer
description: "Channel index used by the reverse API peer."
channelMarker:
$ref: "http://swgserver:8081/api/swagger/include/ChannelMarker.yaml#/ChannelMarker"
description: "Channel-marker display configuration."
rollupState:
$ref: "http://swgserver:8081/api/swagger/include/RollupState.yaml#/RollupState"
description: "Saved expanded or collapsed state of the GUI sections."
APTDemodActions:
description: APTDemod

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

@ -3,35 +3,46 @@ ATVDemodSettings: @@ -3,35 +3,46 @@ ATVDemodSettings:
properties:
fpsIndex:
type: integer
description: "Selected fps index."
halfImage:
description: (boolean) 1 for m_fltRatioOfRowsToDisplay = 0.5, 0 for m_fltRatioOfRowsToDisplay = 1.0
type: integer
RFBandwidthFactor:
type: integer
description: "RF bandwidth factor setting for Atv demod."
OppBandwidthFactor:
type: integer
description: "Opp bandwidth factor setting for Atv demod."
nbLinesIndex:
type: integer
description: "Selected nb lines index."
intFrequencyOffset:
type: integer
description: "Int frequency offset in Hz."
enmModulation:
description: see ATVDemodSettings::ATVModulation
type: integer
fltRFBandwidth:
type: number
format: float
description: "Flt RF bandwidth in Hz."
fltRFOppBandwidth:
type: number
format: float
description: "Flt RF opp bandwidth in Hz."
blnFFTFiltering:
description: boolean
type: integer
minimum: 0
maximum: 1
fltBFOFrequency:
type: number
format: float
description: "Flt bfo frequency in Hz."
fmDeviation:
type: number
format: float
description: "FM frequency deviation in Hz."
amScalingFactor:
type: integer
description: Factor in % to apply to detected signal scale
@ -40,49 +51,72 @@ ATVDemodSettings: @@ -40,49 +51,72 @@ ATVDemodSettings:
description: Factor in % to apply to adjusted signal scale
intSampleRate:
type: integer
description: "Int sample rate in samples per second."
enmATVStandard:
description: see ATVDemodSettings::ATVStd
type: integer
intNumberOfLines:
type: integer
description: "Int number of lines setting for Atv demod."
fltLineDuration:
type: number
format: float
description: "Flt line duration setting for Atv demod."
fltTopDuration:
type: number
format: float
description: "Flt top duration setting for Atv demod."
fltFramePerS:
type: number
format: float
description: "Flt frame per s setting for Atv demod."
fltRatioOfRowsToDisplay:
type: number
format: float
description: "Flt ratio of rows to display setting for Atv demod."
fltVoltLevelSynchroTop:
type: number
format: float
description: "Flt volt level synchro top setting for Atv demod."
fltVoltLevelSynchroBlack:
type: number
format: float
description: "Flt volt level synchro black setting for Atv demod."
blnHSync:
description: boolean
type: integer
minimum: 0
maximum: 1
blnVSync:
description: boolean
type: integer
minimum: 0
maximum: 1
blnInvertVideo:
description: boolean
type: integer
minimum: 0
maximum: 1
intVideoTabIndex:
type: integer
description: "Selected int video tab index."
intTVSampleRate:
type: integer
description: "Int tv sample rate in samples per second."
intNumberSamplePerLine:
type: integer
description: "Int number sample per line setting for Atv demod."
rgbColor:
type: integer
description: "Display color encoded as an RGB integer."
title:
type: string
description: "User-visible title."
udpAddress:
type: string
description: "IPv4 address or host name used for UDP traffic."
udpPort:
type: integer
description: "UDP port number."
minimum: 1
maximum: 65535

36
swagger/sdrangel/api/swagger/include/ATVMod.yaml

@ -4,73 +4,108 @@ ATVModSettings: @@ -4,73 +4,108 @@ ATVModSettings:
inputFrequencyOffset:
type: integer
format: int64
description: "Channel frequency offset from the device center frequency in Hz."
rfBandwidth:
type: number
format: float
description: "RF bandwidth in Hz."
rfOppBandwidth:
type: number
format: float
description: "RF opp bandwidth in Hz."
atvStd:
type: integer
description: "Atv std setting for Atv mod."
nbLines:
type: integer
description: "Nb lines setting for Atv mod."
fps:
type: integer
description: "Fps setting for Atv mod."
atvModInput:
type: integer
description: "Atv mod input setting for Atv mod."
uniformLevel:
type: number
format: float
description: "Uniform level setting for Atv mod."
atvModulation:
type: integer
description: "Atv modulation setting for Atv mod."
videoPlayLoop:
type: integer
description: "Video play loop setting for Atv mod."
videoPlay:
type: integer
description: "Video play setting for Atv mod."
cameraPlay:
type: integer
description: "Camera play setting for Atv mod."
channelMute:
type: integer
description: "Mute the channel output (1 muted, 0 unmuted)."
minimum: 0
maximum: 1
invertedVideo:
type: integer
description: "Inverted video setting for Atv mod."
rfScalingFactor:
type: number
format: float
description: "RF scaling factor setting for Atv mod."
fmExcursion:
type: number
format: float
description: "FM excursion setting for Atv mod."
forceDecimator:
type: integer
description: "Force decimator setting for Atv mod."
showOverlayText:
type: integer
description: "Show overlay text setting for Atv mod."
overlayText:
type: string
description: "Overlay text setting for Atv mod."
rgbColor:
type: integer
description: "Display color encoded as an RGB integer."
title:
type: string
description: "User-visible title."
imageFileName:
type: string
description: "Image file name or path."
videoFileName:
type: string
description: "Video file name."
streamIndex:
description: MIMO channel. Not relevant when connected to SI (single Rx).
type: integer
useReverseAPI:
description: Synchronize with reverse API (1 for yes, 0 for no)
type: integer
minimum: 0
maximum: 1
reverseAPIAddress:
type: string
description: "IPv4 address or host name of the reverse API peer."
reverseAPIPort:
type: integer
description: "TCP port of the reverse API peer."
minimum: 1
maximum: 65535
reverseAPIDeviceIndex:
type: integer
description: "Device-set index used by the reverse API peer."
reverseAPIChannelIndex:
type: integer
description: "Channel index used by the reverse API peer."
channelMarker:
$ref: "http://swgserver:8081/api/swagger/include/ChannelMarker.yaml#/ChannelMarker"
description: "Channel-marker display configuration."
rollupState:
$ref: "http://swgserver:8081/api/swagger/include/RollupState.yaml#/RollupState"
description: "Saved expanded or collapsed state of the GUI sections."
ATVModReport:
description: ATVMod
@ -81,3 +116,4 @@ ATVModReport: @@ -81,3 +116,4 @@ ATVModReport:
format: float
channelSampleRate:
type: integer
description: "Effective sample rate delivered to the channel in samples per second."

20
swagger/sdrangel/api/swagger/include/AaroniaRTSA.yaml

@ -3,6 +3,7 @@ AaroniaRTSASettings: @@ -3,6 +3,7 @@ AaroniaRTSASettings:
properties:
title:
type: string
description: "User-visible title."
centerFrequency:
description: Sets the center frequency (Hz) of the distant IQ demodulator
type: integer
@ -16,18 +17,27 @@ AaroniaRTSASettings: @@ -16,18 +17,27 @@ AaroniaRTSASettings:
useReverseAPI:
description: Synchronize with reverse API (1 for yes, 0 for no)
type: integer
minimum: 0
maximum: 1
reverseAPIAddress:
type: string
description: "IPv4 address or host name of the reverse API peer."
reverseAPIPort:
type: integer
description: "TCP port of the reverse API peer."
minimum: 1
maximum: 65535
reverseAPIDeviceIndex:
type: integer
description: "Device-set index used by the reverse API peer."
AaroniaRTSAReport:
description: AaroniaRTSA
properties:
status:
type: integer
minimum: 0
maximum: 4
description: >
Connection to RTSA server status:
* 0 - Idle
@ -41,6 +51,7 @@ AaroniaRTSAOutputSettings: @@ -41,6 +51,7 @@ AaroniaRTSAOutputSettings:
properties:
title:
type: string
description: "User-visible title."
centerFrequency:
description: Sets the center frequency (Hz) of the distant IQ demodulator
type: integer
@ -54,18 +65,27 @@ AaroniaRTSAOutputSettings: @@ -54,18 +65,27 @@ AaroniaRTSAOutputSettings:
useReverseAPI:
description: Synchronize with reverse API (1 for yes, 0 for no)
type: integer
minimum: 0
maximum: 1
reverseAPIAddress:
type: string
description: "IPv4 address or host name of the reverse API peer."
reverseAPIPort:
type: integer
description: "TCP port of the reverse API peer."
minimum: 1
maximum: 65535
reverseAPIDeviceIndex:
type: integer
description: "Device-set index used by the reverse API peer."
AaroniaRTSAOutputReport:
description: AaroniaRTSAOutput
properties:
status:
type: integer
minimum: 0
maximum: 4
description: >
Connection to RTSA server status:
* 0 - Idle

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

@ -3,19 +3,26 @@ AirspySettings: @@ -3,19 +3,26 @@ AirspySettings:
properties:
title:
type: string
description: "User-visible title."
centerFrequency:
type: integer
format: int64
description: "Device center frequency in Hz."
LOppmTenths:
type: integer
description: "Local-oscillator correction in tenths of a part per million."
devSampleRateIndex:
type: integer
description: "Selected dev sample rate index."
lnaGain:
type: integer
description: "Low-noise-amplifier gain setting."
mixerGain:
type: integer
description: "Mixer gain setting for Airspy."
vgaGain:
type: integer
description: "Variable-gain-amplifier gain setting."
lnaAGC:
description: LNA AGC (1 if active else 0)
type: integer
@ -24,23 +31,38 @@ AirspySettings: @@ -24,23 +31,38 @@ AirspySettings:
type: integer
log2Decim:
type: integer
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
biasT:
description: Bias tee (1 if active else 0)
type: integer
minimum: 0
maximum: 1
dcBlock:
type: integer
description: "Enable DSP DC-offset correction (1 enabled, 0 disabled)."
minimum: 0
maximum: 1
iqCorrection:
type: integer
description: "Enable I/Q imbalance correction (1 enabled, 0 disabled)."
minimum: 0
maximum: 1
transverterMode:
type: integer
description: "Enable transverter frequency translation (1 enabled, 0 disabled)."
minimum: 0
maximum: 1
transverterDeltaFrequency:
type: integer
format: int64
description: "Frequency translation applied in transverter mode in Hz."
iqOrder:
type: integer
minimum: 0
maximum: 1
description: >
IQ samples order
* 0 - Q then I (swapped)
@ -48,17 +70,25 @@ AirspySettings: @@ -48,17 +70,25 @@ AirspySettings:
useReverseAPI:
description: Synchronize with reverse API (1 for yes, 0 for no)
type: integer
minimum: 0
maximum: 1
reverseAPIAddress:
type: string
description: "IPv4 address or host name of the reverse API peer."
reverseAPIPort:
type: integer
description: "TCP port of the reverse API peer."
minimum: 1
maximum: 65535
reverseAPIDeviceIndex:
type: integer
description: "Device-set index used by the reverse API peer."
AirspyReport:
description: Airspy
properties:
sampleRates:
type: array
description: "Supported sample rates in samples per second."
items:
$ref: "http://swgserver:8081/api/swagger/include/Structs.yaml#/SampleRate"

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

@ -3,61 +3,93 @@ AirspyHFSettings: @@ -3,61 +3,93 @@ AirspyHFSettings:
properties:
title:
type: string
description: "User-visible title."
centerFrequency:
type: integer
format: int64
description: "Device center frequency in Hz."
LOppmTenths:
type: integer
description: "Local-oscillator correction in tenths of a part per million."
devSampleRateIndex:
type: integer
description: "Selected dev sample rate index."
log2Decim:
type: integer
description: "Base-2 exponent of the software decimation factor; the output sample rate is divided by 2^log2Decim."
transverterMode:
type: integer
description: "Enable transverter frequency translation (1 enabled, 0 disabled)."
minimum: 0
maximum: 1
transverterDeltaFrequency:
type: integer
format: int64
description: "Frequency translation applied in transverter mode in Hz."
iqOrder:
type: integer
minimum: 0
maximum: 1
description: >
IQ samples order
* 0 - Q then I (swapped)
* 1 - I then Q (straight)
bandIndex:
type: integer
description: "Selected band index."
useReverseAPI:
description: Synchronize with reverse API (1 for yes, 0 for no)
type: integer
minimum: 0
maximum: 1
reverseAPIAddress:
type: string
description: "IPv4 address or host name of the reverse API peer."
reverseAPIPort:
type: integer
description: "TCP port of the reverse API peer."
minimum: 1
maximum: 65535
reverseAPIDeviceIndex:
type: integer
description: "Device-set index used by the reverse API peer."
useAGC:
description: AGC (1 for on, 0 for off)
type: integer
minimum: 0
maximum: 1
agcHigh:
description: AGC threshold (1 for high, 0 for low)
type: integer
useDSP:
description: LibairspyHF DSP (1 for on, 0 for off)
type: integer
minimum: 0
maximum: 1
useLNA:
description: LNA (1 for on, 0 for off)
type: integer
minimum: 0
maximum: 1
attenuatorSteps:
description: Attenuator in number of 6 dB steps
type: integer
dcBlock:
type: integer
description: "Enable DSP DC-offset correction (1 enabled, 0 disabled)."
minimum: 0
maximum: 1
iqCorrection:
type: integer
description: "Enable I/Q imbalance correction (1 enabled, 0 disabled)."
minimum: 0
maximum: 1
AirspyHFReport:
description: AirspyHF
properties:
sampleRates:
type: array
description: "Supported sample rates in samples per second."
items:
$ref: "http://swgserver:8081/api/swagger/include/Structs.yaml#/SampleRate"

31
swagger/sdrangel/api/swagger/include/AndroidSDRDriverInput.yaml

@ -4,42 +4,73 @@ AndroidSDRDriverInputSettings: @@ -4,42 +4,73 @@ AndroidSDRDriverInputSettings:
centerFrequency:
type: integer
format: int64
description: "Device center frequency in Hz."
loPpmCorrection:
type: integer
description: "Local-oscillator correction in parts per million."
dcBlock:
type: integer
description: "Enable DSP DC-offset correction (1 enabled, 0 disabled)."
minimum: 0
maximum: 1
iqCorrection:
type: integer
description: "Enable I/Q imbalance correction (1 enabled, 0 disabled)."
minimum: 0
maximum: 1
biasTee:
type: integer
description: "Enable the antenna bias tee (1 enabled, 0 disabled)."
minimum: 0
maximum: 1
directSampling:
type: integer
description: "Direct sampling setting for Android sdr driver input."
devSampleRate:
type: integer
description: "Device I/Q sample rate in samples per second before software decimation or interpolation."
log2Decim:
type: integer
description: "Base-2 exponent of the software decimation factor; the output sample rate is divided by 2^log2Decim."
gain:
type: integer
description: "Gain setting; units and available values depend on the device or plugin."
agc:
type: integer
description: "Enable automatic gain control (1 enabled, 0 disabled)."
minimum: 0
maximum: 1
rfBW:
type: integer
description: "RF bw in Hz."
sampleBits:
type: integer
description: "Number of significant bits in each sample."
dataPort:
type: integer
description: "Network port used for data traffic."
minimum: 1
maximum: 65535
useReverseAPI:
description: Synchronize with reverse API (1 for yes, 0 for no)
type: integer
minimum: 0
maximum: 1
reverseAPIAddress:
type: string
description: "IPv4 address or host name of the reverse API peer."
reverseAPIPort:
type: integer
description: "TCP port of the reverse API peer."
minimum: 1
maximum: 65535
reverseAPIDeviceIndex:
type: integer
description: "Device-set index used by the reverse API peer."
AndroidSDRDriverInputReport:
description: AndroidSDRDriverInput
properties:
sampleRate:
type: integer
description: "Sample rate in samples per second."

17
swagger/sdrangel/api/swagger/include/AntennaTools.yaml

@ -4,34 +4,51 @@ AntennaToolsSettings: @@ -4,34 +4,51 @@ AntennaToolsSettings:
dipoleFrequencyMHz:
type: number
format: float
description: "Dipole frequency in MHz."
dipoleEndEffectFactor:
type: number
format: float
description: "Dipole end effect factor setting for Antenna tools."
dishFrequencyMHz:
type: number
format: float
description: "Dish frequency in MHz."
dishDiameter:
type: number
format: float
description: "Dish diameter setting for Antenna tools."
dishDepth:
type: number
format: float
description: "Dish depth setting for Antenna tools."
dishEfficiency:
type: integer
description: "Dish efficiency setting for Antenna tools."
title:
type: string
description: "User-visible title."
rgbColor:
type: integer
description: "Display color encoded as an RGB integer."
useReverseAPI:
description: Synchronize with reverse API (1 for yes, 0 for no)
type: integer
minimum: 0
maximum: 1
reverseAPIAddress:
type: string
description: "IPv4 address or host name of the reverse API peer."
reverseAPIPort:
type: integer
description: "TCP port of the reverse API peer."
minimum: 1
maximum: 65535
reverseAPIFeatureSetIndex:
type: integer
description: "Feature-set index used by the reverse API peer."
reverseAPIFeatureIndex:
type: integer
description: "Feature index used by the reverse API peer."
rollupState:
$ref: "http://swgserver:8081/api/swagger/include/RollupState.yaml#/RollupState"
description: "Saved expanded or collapsed state of the GUI sections."

47
swagger/sdrangel/api/swagger/include/AudioCATSISO.yaml

@ -3,35 +3,50 @@ AudioCATSISOSettings: @@ -3,35 +3,50 @@ AudioCATSISOSettings:
properties:
title:
type: string
description: "User-visible title."
rxCenterFrequency:
type: integer
format: int64
description: "Receive center frequency in Hz."
rxSampleRate:
type: integer
description: "Receive sample rate in samples per second."
txCenterFrequency:
type: integer
format: int64
description: "Transmit center frequency in Hz."
txSampleRate:
type: integer
description: "Transmit sample rate in samples per second."
transverterMode:
type: integer
description: "Enable transverter frequency translation (1 enabled, 0 disabled)."
minimum: 0
maximum: 1
transverterDeltaFrequency:
type: integer
format: int64
description: "Frequency translation applied in transverter mode in Hz."
iqOrder:
type: integer
minimum: 0
maximum: 1
description: >
IQ samples order
* 0 - Q then I (swapped)
* 1 - I then Q (straight)
txEnable:
type: integer
minimum: 0
maximum: 1
description: >
Enable or disable transmission
* 0 - Disable transmission
* 1 - Enable transmission
pttSpectrumLink:
type: integer
minimum: 0
maximum: 1
description: >
Main spectrum display (Rx/Tx) follows PTT (GUI)
* 0 - Disable PTT following
@ -41,6 +56,8 @@ AudioCATSISOSettings: @@ -41,6 +56,8 @@ AudioCATSISOSettings:
type: string
rxIQMapping:
type: integer
minimum: 0
maximum: 3
description: >
Audio channel to IQ mapping
* 0 - I=L, Q=R
@ -52,6 +69,8 @@ AudioCATSISOSettings: @@ -52,6 +69,8 @@ AudioCATSISOSettings:
type: integer
fcPosRx:
type: integer
minimum: 0
maximum: 2
description: >
Decimated bandpass center frequency position
* 0 - Infradyne
@ -59,12 +78,16 @@ AudioCATSISOSettings: @@ -59,12 +78,16 @@ AudioCATSISOSettings:
* 2 - Centered
dcBlock:
type: integer
minimum: 0
maximum: 1
description: >
Auto DC blocking
* 0 - Off
* 1 - On
iqCorrection:
type: integer
minimum: 0
maximum: 1
description: >
Auto IQ balance (you need auto DC blocking active)
* 0 - Off
@ -72,11 +95,14 @@ AudioCATSISOSettings: @@ -72,11 +95,14 @@ AudioCATSISOSettings:
rxVolume:
type: number
format: float
description: "Receive volume setting for Audio catsiso."
txDeviceName:
description: The name of the output audio device
type: string
txIQMapping:
type: integer
minimum: 0
maximum: 1
description: >
Audio channel to IQ mapping
* 0 - I=L, Q=R
@ -86,6 +112,8 @@ AudioCATSISOSettings: @@ -86,6 +112,8 @@ AudioCATSISOSettings:
description: Tx volume in dB usually negative
catSpeedIndex:
type: integer
minimum: 0
maximum: 7
description: >
CAT serial link baud rate
* 0 - 1200
@ -98,18 +126,24 @@ AudioCATSISOSettings: @@ -98,18 +126,24 @@ AudioCATSISOSettings:
* 7 - 115200
catDataBitsIndex:
type: integer
minimum: 0
maximum: 1
description: >
CAT serial link data bits
* 0 - 7
* 1 - 8 (default)
catStopBitsIndex:
type: integer
minimum: 0
maximum: 1
description: >
CAT serial link stop bits
* 0 - 1 (default)
* 1 - 2
catHandshakeIndex:
type: integer
minimum: 0
maximum: 2
description: >
CAT serial link handshake type
* 0 - none (default)
@ -117,6 +151,8 @@ AudioCATSISOSettings: @@ -117,6 +151,8 @@ AudioCATSISOSettings:
* 2 - hardware
catPTTMethodIndex:
type: integer
minimum: 0
maximum: 2
description: >
CAT PTT method
* 0 - PTT (default)
@ -124,12 +160,16 @@ AudioCATSISOSettings: @@ -124,12 +160,16 @@ AudioCATSISOSettings:
* 2 - RTS
catDTRHigh:
type: integer
minimum: 0
maximum: 1
description: >
CAT DTR control
* 0 - low
* 1 - high (default)
catRTSHigh:
type: integer
minimum: 0
maximum: 1
description: >
CAT RTS control
* 0 - low
@ -140,9 +180,16 @@ AudioCATSISOSettings: @@ -140,9 +180,16 @@ AudioCATSISOSettings:
useReverseAPI:
description: Synchronize with reverse API (1 for yes, 0 for no)
type: integer
minimum: 0
maximum: 1
reverseAPIAddress:
type: string
description: "IPv4 address or host name of the reverse API peer."
reverseAPIPort:
type: integer
description: "TCP port of the reverse API peer."
minimum: 1
maximum: 65535
reverseAPIDeviceIndex:
type: integer
description: "Device-set index used by the reverse API peer."

17
swagger/sdrangel/api/swagger/include/AudioInput.yaml

@ -3,6 +3,7 @@ AudioInputSettings: @@ -3,6 +3,7 @@ AudioInputSettings:
properties:
title:
type: string
description: "User-visible title."
device:
description: The name of the audio device
type: string
@ -12,11 +13,14 @@ AudioInputSettings: @@ -12,11 +13,14 @@ AudioInputSettings:
volume:
type: number
format: float
description: "Audio volume multiplier."
log2Decim:
description: Decimation factor
type: integer
iqMapping:
type: integer
minimum: 0
maximum: 3
description: >
Audio channel to IQ mapping
* 0 - I=L, Q=0
@ -25,18 +29,24 @@ AudioInputSettings: @@ -25,18 +29,24 @@ AudioInputSettings:
* 3 - I=R, Q=L
dcBlock:
type: integer
minimum: 0
maximum: 1
description: >
Auto DC blocking
* 0 - Off
* 1 - On
iqImbalance:
type: integer
minimum: 0
maximum: 1
description: >
Auto IQ balance (you need auto DC blocking active)
* 0 - Off
* 1 - On
fcPos:
type: integer
minimum: 0
maximum: 2
description: >
Decimated bandpass center frequency position
* 0 - Infradyne
@ -45,9 +55,16 @@ AudioInputSettings: @@ -45,9 +55,16 @@ AudioInputSettings:
useReverseAPI:
description: Synchronize with reverse API (1 for yes, 0 for no)
type: integer
minimum: 0
maximum: 1
reverseAPIAddress:
type: string
description: "IPv4 address or host name of the reverse API peer."
reverseAPIPort:
type: integer
description: "TCP port of the reverse API peer."
minimum: 1
maximum: 65535
reverseAPIDeviceIndex:
type: integer
description: "Device-set index used by the reverse API peer."

11
swagger/sdrangel/api/swagger/include/AudioOutput.yaml

@ -3,14 +3,18 @@ AudioOutputSettings: @@ -3,14 +3,18 @@ AudioOutputSettings:
properties:
title:
type: string
description: "User-visible title."
deviceName:
description: The name of the audio device
type: string
volume:
type: number
format: float
description: "Audio volume multiplier."
iqMapping:
type: integer
minimum: 0
maximum: 1
description: >
Audio channel to IQ mapping
* 0 - I=L, Q=R
@ -18,9 +22,16 @@ AudioOutputSettings: @@ -18,9 +22,16 @@ AudioOutputSettings:
useReverseAPI:
description: Synchronize with reverse API (1 for yes, 0 for no)
type: integer
minimum: 0
maximum: 1
reverseAPIAddress:
type: string
description: "IPv4 address or host name of the reverse API peer."
reverseAPIPort:
type: integer
description: "TCP port of the reverse API peer."
minimum: 1
maximum: 65535
reverseAPIDeviceIndex:
type: integer
description: "Device-set index used by the reverse API peer."

56
swagger/sdrangel/api/swagger/include/BFMDemod.yaml

@ -4,14 +4,28 @@ BFMDemodSettings: @@ -4,14 +4,28 @@ BFMDemodSettings:
inputFrequencyOffset:
type: integer
format: int64
description: "Channel frequency offset from the device center frequency in Hz."
rfBandwidth:
type: number
format: float
minimum: 80000
maximum: 250000
description: >
RF channel bandwidth in Hz. The channel/baseband sample rate must be
greater than this bandwidth. For 180 kHz broadcast FM use at least
240 kS/s; 256 kS/s is recommended.
afBandwidth:
type: number
format: float
minimum: 1000
maximum: 20000
default: 15000
description: >
Demodulated audio bandwidth in Hz. Broadcast FM normally uses 15 kHz.
deEmphasis:
type: integer
minimum: 0
maximum: 1
description: >
De-emphasis time constant (us)
* 0 - 50us (Europe, Australia)
@ -19,45 +33,76 @@ BFMDemodSettings: @@ -19,45 +33,76 @@ BFMDemodSettings:
volume:
type: number
format: float
description: "Audio volume multiplier."
squelch:
type: number
format: float
description: "Squelch threshold in dB."
audioMute:
type: integer
description: "Mute audio output (1 muted, 0 unmuted)."
minimum: 0
maximum: 1
audioStereo:
type: integer
description: "Enable stereo audio decoding (1 stereo, 0 mono)."
minimum: 0
maximum: 1
lsbStereo:
type: integer
description: "Use lower-sideband stereo decoding (1 enabled, 0 disabled)."
minimum: 0
maximum: 1
showPilot:
type: integer
description: "Show the stereo pilot spectrum (1 enabled, 0 disabled)."
minimum: 0
maximum: 1
rdsActive:
type: integer
description: "Enable RDS decoding (1 enabled, 0 disabled)."
minimum: 0
maximum: 1
rgbColor:
type: integer
description: "Display color encoded as an RGB integer."
title:
type: string
description: "User-visible title."
audioDeviceName:
type: string
description: "Name of the audio device to use."
streamIndex:
description: MIMO channel. Not relevant when connected to SI (single Rx).
type: integer
useReverseAPI:
description: Synchronize with reverse API (1 for yes, 0 for no)
type: integer
minimum: 0
maximum: 1
reverseAPIAddress:
type: string
description: "IPv4 address or host name of the reverse API peer."
reverseAPIPort:
type: integer
description: "TCP port of the reverse API peer."
minimum: 1
maximum: 65535
reverseAPIDeviceIndex:
type: integer
description: "Device-set index used by the reverse API peer."
reverseAPIChannelIndex:
type: integer
description: "Channel index used by the reverse API peer."
spectrumConfig:
$ref: "http://swgserver:8081/api/swagger/include/GLSpectrum.yaml#/GLSpectrum"
description: "Spectrum-display configuration."
channelMarker:
$ref: "http://swgserver:8081/api/swagger/include/ChannelMarker.yaml#/ChannelMarker"
description: "Channel-marker display configuration."
rollupState:
$ref: "http://swgserver:8081/api/swagger/include/RollupState.yaml#/RollupState"
description: "Saved expanded or collapsed state of the GUI sections."
BFMDemodReport:
description: BFMDemod
@ -71,8 +116,12 @@ BFMDemodReport: @@ -71,8 +116,12 @@ BFMDemodReport:
type: integer
audioSampleRate:
type: integer
description: "Audio sample rate in samples per second."
channelSampleRate:
type: integer
description: >
Effective complex baseband sample rate delivered to this channel in
samples per second. This must be greater than rfBandwidth.
pilotLocked:
description: pilot locked status (1 if open else 0)
type: integer
@ -82,6 +131,7 @@ BFMDemodReport: @@ -82,6 +131,7 @@ BFMDemodReport:
format: float
rdsReport:
$ref: "#/RDSReport"
description: "RDS decoder status and decoded programme information."
RDSReport:
description: RDS information
@ -89,9 +139,13 @@ RDSReport: @@ -89,9 +139,13 @@ RDSReport:
demodStatus:
description: Demodulation success (%)
type: integer
minimum: 0
maximum: 100
decodStatus:
description: Decoding success (%)
type: integer
minimum: 0
maximum: 100
rdsDemodAccumDB:
description: RDS demodulator accumulator level (dB)
type: number
@ -126,8 +180,10 @@ RDSReport: @@ -126,8 +180,10 @@ RDSReport:
type: string
altFrequencies:
type: array
description: "Alternative broadcast frequencies reported by RDS."
items:
properties:
frequency:
type: number
format: float
description: "Frequency in Hz."

15
swagger/sdrangel/api/swagger/include/BeamSteeringCWMod.yaml

@ -3,26 +3,41 @@ BeamSteeringCWModSettings: @@ -3,26 +3,41 @@ BeamSteeringCWModSettings:
properties:
steerDegrees:
type: integer
description: "Steer degrees setting for Beam steering CW mod."
rgbColor:
type: integer
description: "Display color encoded as an RGB integer."
title:
type: string
description: "User-visible title."
log2Interp:
type: integer
description: "Base-2 exponent of the software interpolation factor; the output sample rate is multiplied by 2^log2Interp."
filterChainHash:
type: integer
description: "Identifier of the selected half-band filter chain."
useReverseAPI:
description: Synchronize with reverse API (1 for yes, 0 for no)
type: integer
minimum: 0
maximum: 1
reverseAPIAddress:
type: string
description: "IPv4 address or host name of the reverse API peer."
reverseAPIPort:
type: integer
description: "TCP port of the reverse API peer."
minimum: 1
maximum: 65535
reverseAPIDeviceIndex:
type: integer
description: "Device-set index used by the reverse API peer."
reverseAPIChannelIndex:
type: integer
description: "Channel index used by the reverse API peer."
channelMarker:
$ref: "http://swgserver:8081/api/swagger/include/ChannelMarker.yaml#/ChannelMarker"
description: "Channel-marker display configuration."
rollupState:
$ref: "http://swgserver:8081/api/swagger/include/RollupState.yaml#/RollupState"
description: "Saved expanded or collapsed state of the GUI sections."

44
swagger/sdrangel/api/swagger/include/BladeRF1.yaml

@ -3,35 +3,55 @@ BladeRF1InputSettings: @@ -3,35 +3,55 @@ BladeRF1InputSettings:
properties:
title:
type: string
description: "User-visible title."
centerFrequency:
type: integer
format: int64
description: "Device center frequency in Hz."
devSampleRate:
type: integer
description: "Device I/Q sample rate in samples per second before software decimation or interpolation."
lnaGain:
type: integer
description: "Low-noise-amplifier gain setting."
vga1:
type: integer
description: "First variable-gain-amplifier gain setting."
vga2:
type: integer
description: "Second variable-gain-amplifier gain setting."
bandwidth:
type: integer
description: "Bandwidth in Hz."
log2Decim:
type: integer
description: "Base-2 exponent of the software decimation factor; the output sample rate is divided by 2^log2Decim."
fcPos:
type: integer
description: "Position of the decimated passband relative to the device center frequency."
xb200:
type: integer
description: "Xb200 setting for Blade rf1 input."
xb200Path:
type: integer
description: "Xb200 path setting for Blade rf1 input."
xb200Filter:
type: integer
description: "Xb200 filter setting for Blade rf1 input."
dcBlock:
type: integer
description: "Enable DSP DC-offset correction (1 enabled, 0 disabled)."
minimum: 0
maximum: 1
iqCorrection:
type: integer
description: "Enable I/Q imbalance correction (1 enabled, 0 disabled)."
minimum: 0
maximum: 1
iqOrder:
type: integer
minimum: 0
maximum: 1
description: >
IQ samples order
* 0 - Q then I (swapped)
@ -39,43 +59,67 @@ BladeRF1InputSettings: @@ -39,43 +59,67 @@ BladeRF1InputSettings:
useReverseAPI:
description: Synchronize with reverse API (1 for yes, 0 for no)
type: integer
minimum: 0
maximum: 1
reverseAPIAddress:
type: string
description: "IPv4 address or host name of the reverse API peer."
reverseAPIPort:
type: integer
description: "TCP port of the reverse API peer."
minimum: 1
maximum: 65535
reverseAPIDeviceIndex:
type: integer
description: "Device-set index used by the reverse API peer."
BladeRF1OutputSettings:
description: BladeRF1
properties:
title:
type: string
description: "User-visible title."
centerFrequency:
type: integer
format: int64
description: "Device center frequency in Hz."
devSampleRate:
type: integer
description: "Device I/Q sample rate in samples per second before software decimation or interpolation."
vga1:
type: integer
description: "First variable-gain-amplifier gain setting."
vga2:
type: integer
description: "Second variable-gain-amplifier gain setting."
bandwidth:
type: integer
description: "Bandwidth in Hz."
log2Interp:
type: integer
description: "Base-2 exponent of the software interpolation factor; the output sample rate is multiplied by 2^log2Interp."
xb200:
type: integer
description: "Xb200 setting for Blade rf1 output."
xb200Path:
type: integer
description: "Xb200 path setting for Blade rf1 output."
xb200Filter:
type: integer
description: "Xb200 filter setting for Blade rf1 output."
useReverseAPI:
description: Synchronize with reverse API (1 for yes, 0 for no)
type: integer
minimum: 0
maximum: 1
reverseAPIAddress:
type: string
description: "IPv4 address or host name of the reverse API peer."
reverseAPIPort:
type: integer
description: "TCP port of the reverse API peer."
minimum: 1
maximum: 65535
reverseAPIDeviceIndex:
type: integer
description: "Device-set index used by the reverse API peer."

108
swagger/sdrangel/api/swagger/include/BladeRF2.yaml

@ -3,36 +3,60 @@ BladeRF2InputSettings: @@ -3,36 +3,60 @@ BladeRF2InputSettings:
properties:
title:
type: string
description: "User-visible title."
centerFrequency:
type: integer
format: int64
description: "Device center frequency in Hz."
LOppmTenths:
type: integer
description: "Local-oscillator correction in tenths of a part per million."
devSampleRate:
type: integer
description: "Device I/Q sample rate in samples per second before software decimation or interpolation."
bandwidth:
type: integer
description: "Bandwidth in Hz."
gainMode:
type: integer
description: "Gain-control mode selection."
globalGain:
type: integer
description: "Overall device gain setting."
biasTee:
type: integer
description: "Enable the antenna bias tee (1 enabled, 0 disabled)."
minimum: 0
maximum: 1
log2Decim:
type: integer
description: "Base-2 exponent of the software decimation factor; the output sample rate is divided by 2^log2Decim."
fcPos:
type: integer
description: "Position of the decimated passband relative to the device center frequency."
dcBlock:
type: integer
description: "Enable DSP DC-offset correction (1 enabled, 0 disabled)."
minimum: 0
maximum: 1
iqCorrection:
type: integer
description: "Enable I/Q imbalance correction (1 enabled, 0 disabled)."
minimum: 0
maximum: 1
transverterMode:
type: integer
description: "Enable transverter frequency translation (1 enabled, 0 disabled)."
minimum: 0
maximum: 1
transverterDeltaFrequency:
type: integer
format: int64
description: "Frequency translation applied in transverter mode in Hz."
iqOrder:
type: integer
minimum: 0
maximum: 1
description: >
IQ samples order
* 0 - Q then I (swapped)
@ -40,26 +64,38 @@ BladeRF2InputSettings: @@ -40,26 +64,38 @@ BladeRF2InputSettings:
useReverseAPI:
description: Synchronize with reverse API (1 for yes, 0 for no)
type: integer
minimum: 0
maximum: 1
reverseAPIAddress:
type: string
description: "IPv4 address or host name of the reverse API peer."
reverseAPIPort:
type: integer
description: "TCP port of the reverse API peer."
minimum: 1
maximum: 65535
reverseAPIDeviceIndex:
type: integer
description: "Device-set index used by the reverse API peer."
BladeRF2InputReport:
description: BladeRF2
properties:
frequencyRange:
$ref: "http://swgserver:8081/api/swagger/include/Structs.yaml#/FrequencyRange"
description: "Frequency range data for Blade rf2 input."
sampleRateRange:
$ref: "http://swgserver:8081/api/swagger/include/Structs.yaml#/Range"
description: "Sample rate range data for Blade rf2 input."
bandwidthRange:
$ref: "http://swgserver:8081/api/swagger/include/Structs.yaml#/Range"
description: "Bandwidth range data for Blade rf2 input."
globalGainRange:
$ref: "http://swgserver:8081/api/swagger/include/Structs.yaml#/Range"
description: "Global gain range data for Blade rf2 input."
gainModes:
type: array
description: "List of gain modes."
items:
$ref: "http://swgserver:8081/api/swagger/include/Structs.yaml#/NamedEnum"
@ -68,92 +104,138 @@ BladeRF2OutputSettings: @@ -68,92 +104,138 @@ BladeRF2OutputSettings:
properties:
title:
type: string
description: "User-visible title."
centerFrequency:
type: integer
format: int64
description: "Device center frequency in Hz."
LOppmTenths:
type: integer
description: "Local-oscillator correction in tenths of a part per million."
devSampleRate:
type: integer
description: "Device I/Q sample rate in samples per second before software decimation or interpolation."
bandwidth:
type: integer
description: "Bandwidth in Hz."
globalGain:
type: integer
description: "Overall device gain setting."
biasTee:
type: integer
description: "Enable the antenna bias tee (1 enabled, 0 disabled)."
minimum: 0
maximum: 1
log2Interp:
type: integer
description: "Base-2 exponent of the software interpolation factor; the output sample rate is multiplied by 2^log2Interp."
transverterMode:
type: integer
description: "Enable transverter frequency translation (1 enabled, 0 disabled)."
minimum: 0
maximum: 1
transverterDeltaFrequency:
type: integer
format: int64
description: "Frequency translation applied in transverter mode in Hz."
useReverseAPI:
description: Synchronize with reverse API (1 for yes, 0 for no)
type: integer
minimum: 0
maximum: 1
reverseAPIAddress:
type: string
description: "IPv4 address or host name of the reverse API peer."
reverseAPIPort:
type: integer
description: "TCP port of the reverse API peer."
minimum: 1
maximum: 65535
reverseAPIDeviceIndex:
type: integer
description: "Device-set index used by the reverse API peer."
BladeRF2OutputReport:
description: BladeRF2
properties:
frequencyRange:
$ref: "http://swgserver:8081/api/swagger/include/Structs.yaml#/FrequencyRange"
description: "Frequency range data for Blade rf2 output."
sampleRateRange:
$ref: "http://swgserver:8081/api/swagger/include/Structs.yaml#/Range"
description: "Sample rate range data for Blade rf2 output."
bandwidthRange:
$ref: "http://swgserver:8081/api/swagger/include/Structs.yaml#/Range"
description: "Bandwidth range data for Blade rf2 output."
globalGainRange:
$ref: "http://swgserver:8081/api/swagger/include/Structs.yaml#/Range"
description: "Global gain range data for Blade rf2 output."
BladeRF2MIMOSettings:
description: BladeRF2
properties:
title:
type: string
description: "User-visible title."
devSampleRate:
type: integer
description: "Device I/Q sample rate in samples per second before software decimation or interpolation."
LOppmTenths:
type: integer
description: "Local-oscillator correction in tenths of a part per million."
rxCenterFrequency:
type: integer
format: int64
description: "Receive center frequency in Hz."
log2Decim:
type: integer
description: "Base-2 exponent of the software decimation factor; the output sample rate is divided by 2^log2Decim."
fcPosRx:
description: See BladeRF2MIMO::fcPos_t
type: integer
rxBandwidth:
type: integer
description: "Receive bandwidth in Hz."
rx0GainMode:
type: integer
description: "Rx0 gain mode setting for Blade rf2 MIMO."
rx0GlobalGain:
type: integer
description: "Rx0 global gain setting for Blade rf2 MIMO."
rx1GainMode:
type: integer
description: "Rx1 gain mode setting for Blade rf2 MIMO."
rx1GlobalGain:
type: integer
description: "Rx1 global gain setting for Blade rf2 MIMO."
rxBiasTee:
description: boolean
type: integer
minimum: 0
maximum: 1
dcBlock:
description: boolean
type: integer
minimum: 0
maximum: 1
iqCorrection:
description: boolean
type: integer
minimum: 0
maximum: 1
rxTransverterMode:
description: boolean
type: integer
minimum: 0
maximum: 1
rxTransverterDeltaFrequency:
type: integer
format: int64
description: "Receive frequency translation applied in transverter mode in Hz."
iqOrder:
type: integer
minimum: 0
maximum: 1
description: >
IQ samples order
* 0 - Q then I (swapped)
@ -161,56 +243,82 @@ BladeRF2MIMOSettings: @@ -161,56 +243,82 @@ BladeRF2MIMOSettings:
txCenterFrequency:
type: integer
format: int64
description: "Transmit center frequency in Hz."
log2Interp:
type: integer
description: "Base-2 exponent of the software interpolation factor; the output sample rate is multiplied by 2^log2Interp."
fcPosTx:
description: See BladeRF2MIMO::fcPos_t
type: integer
txBandwidth:
type: integer
description: "Transmit bandwidth in Hz."
tx0GlobalGain:
type: integer
description: "Tx0 global gain setting for Blade rf2 MIMO."
tx1GlobalGain:
type: integer
description: "Tx1 global gain setting for Blade rf2 MIMO."
txBiasTee:
description: boolean
type: integer
minimum: 0
maximum: 1
txTransverterMode:
description: boolean
type: integer
minimum: 0
maximum: 1
txTransverterDeltaFrequency:
type: integer
format: int64
description: "Transmit frequency translation applied in transverter mode in Hz."
useReverseAPI:
description: boolean
type: integer
minimum: 0
maximum: 1
reverseAPIAddress:
type: string
description: "IPv4 address or host name of the reverse API peer."
reverseAPIPort:
type: integer
description: "TCP port of the reverse API peer."
minimum: 1
maximum: 65535
reverseAPIDeviceIndex:
type: integer
description: "Device-set index used by the reverse API peer."
BladeRF2MIMOReport:
description: BladeRF2
properties:
frequencyRangeRx:
$ref: "http://swgserver:8081/api/swagger/include/Structs.yaml#/FrequencyRange"
description: "Frequency range receive data for Blade rf2 MIMO."
sampleRateRangeRx:
$ref: "http://swgserver:8081/api/swagger/include/Structs.yaml#/Range"
description: "Sample rate range receive data for Blade rf2 MIMO."
bandwidthRangeRx:
$ref: "http://swgserver:8081/api/swagger/include/Structs.yaml#/Range"
description: "Bandwidth range receive data for Blade rf2 MIMO."
globalGainRangeRx:
$ref: "http://swgserver:8081/api/swagger/include/Structs.yaml#/Range"
description: "Global gain range receive data for Blade rf2 MIMO."
gainModesRx:
type: array
description: "List of gain modes receive."
items:
$ref: "http://swgserver:8081/api/swagger/include/Structs.yaml#/NamedEnum"
frequencyRangeTx:
$ref: "http://swgserver:8081/api/swagger/include/Structs.yaml#/FrequencyRange"
description: "Frequency range transmit data for Blade rf2 MIMO."
sampleRateRangeTx:
$ref: "http://swgserver:8081/api/swagger/include/Structs.yaml#/Range"
description: "Sample rate range transmit data for Blade rf2 MIMO."
bandwidthRangeTx:
$ref: "http://swgserver:8081/api/swagger/include/Structs.yaml#/Range"
description: "Bandwidth range transmit data for Blade rf2 MIMO."
globalGainRangeTx:
$ref: "http://swgserver:8081/api/swagger/include/Structs.yaml#/Range"
description: "Global gain range transmit data for Blade rf2 MIMO."

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

@ -2,6 +2,7 @@ CWKeyerSettings: @@ -2,6 +2,7 @@ CWKeyerSettings:
properties:
sampleRate:
type: integer
description: "Sample rate in samples per second."
wpm:
description: Words Per Minute keying speed
type: integer
@ -10,6 +11,7 @@ CWKeyerSettings: @@ -10,6 +11,7 @@ CWKeyerSettings:
type: integer
text:
type: string
description: "Text setting for CW keyer."
loop:
description: 1 to loop on text keying
type: integer

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

@ -19,25 +19,37 @@ ChannelActions: @@ -19,25 +19,37 @@ ChannelActions:
type: integer
AISModActions:
$ref: "http://swgserver:8081/api/swagger/include/AISMod.yaml#/AISModActions"
description: "AIS mod actions configuration for Channel."
APTDemodActions:
$ref: "http://swgserver:8081/api/swagger/include/APTDemod.yaml#/APTDemodActions"
description: "Apt demod actions configuration for Channel."
FileSinkActions:
$ref: "http://swgserver:8081/api/swagger/include/FileSink.yaml#/FileSinkActions"
description: "File sink actions configuration for Channel."
FileSourceActions:
$ref: "http://swgserver:8081/api/swagger/include/FileSource.yaml#/FileSourceActions"
description: "File source actions configuration for Channel."
FreqScannerActions:
$ref: "http://swgserver:8081/api/swagger/include/FreqScanner.yaml#/FreqScannerActions"
description: "Freq scanner actions configuration for Channel."
IEEE_802_15_4_ModActions:
$ref: "http://swgserver:8081/api/swagger/include/IEEE_802_15_4_Mod.yaml#/IEEE_802_15_4_ModActions"
description: "Ieee 802 15 4 mod actions configuration for Channel."
MeshcoreModActions:
$ref: "http://swgserver:8081/api/swagger/include/MeshcoreMod.yaml#/MeshcoreModActions"
description: "Meshcore mod actions configuration for Channel."
PacketModActions:
$ref: "http://swgserver:8081/api/swagger/include/PacketMod.yaml#/PacketModActions"
description: "Packet mod actions configuration for Channel."
PSK31ModActions:
$ref: "http://swgserver:8081/api/swagger/include/PSK31Mod.yaml#/PSK31ModActions"
description: "Psk31 mod actions configuration for Channel."
RadioAstronomyActions:
$ref: "http://swgserver:8081/api/swagger/include/RadioAstronomy.yaml#/RadioAstronomyActions"
description: "Radio astronomy actions configuration for Channel."
RTTYModActions:
$ref: "http://swgserver:8081/api/swagger/include/RTTYMod.yaml#/RTTYModActions"
description: "Rtty mod actions configuration for Channel."
SigMFFileSinkActions:
$ref: "http://swgserver:8081/api/swagger/include/SigMFFileSink.yaml#/SigMFFileSinkActions"
description: "Sig mf file sink actions configuration for Channel."

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

@ -3,73 +3,108 @@ ChannelAnalyzerSettings: @@ -3,73 +3,108 @@ ChannelAnalyzerSettings:
properties:
frequency:
type: integer
description: "Frequency in Hz."
downSample:
description: Boolean
type: integer
minimum: 0
maximum: 1
downSampleRate:
type: integer
description: "Down sample rate in samples per second."
bandwidth:
type: integer
description: "Bandwidth in Hz."
lowCutoff:
type: integer
description: "Lower filter cutoff frequency in Hz."
spanLog2:
type: integer
description: "Base-2 exponent controlling the displayed or processed frequency span."
ssb:
description: Boolean
type: integer
minimum: 0
maximum: 1
pll:
description: Boolean
type: integer
minimum: 0
maximum: 1
fll:
description: Boolean
type: integer
minimum: 0
maximum: 1
costasLoop:
description: Boolean
type: integer
minimum: 0
maximum: 1
rrc:
description: Boolean
type: integer
minimum: 0
maximum: 1
rrcRolloff:
description: in 100ths
type: integer
pllPskOrder:
type: integer
description: "Pll psk order setting for Channel analyzer."
pllBandwidth:
type: number
format: float
description: "Pll bandwidth in Hz."
pllDampingFactor:
type: number
format: float
description: "Pll damping factor setting for Channel analyzer."
pllLoopGain:
type: number
format: float
description: "Pll loop gain setting for Channel analyzer."
inputType:
description: see ChannelAnalyzerSettings::InputType
type: integer
rgbColor:
type: integer
description: "Display color encoded as an RGB integer."
title:
type: string
description: "User-visible title."
streamIndex:
description: MIMO channel. Not relevant when connected to SI (single Rx).
type: integer
useReverseAPI:
description: Synchronize with reverse API (1 for yes, 0 for no)
type: integer
minimum: 0
maximum: 1
reverseAPIAddress:
type: string
description: "IPv4 address or host name of the reverse API peer."
reverseAPIPort:
type: integer
description: "TCP port of the reverse API peer."
minimum: 1
maximum: 65535
reverseAPIDeviceIndex:
type: integer
description: "Device-set index used by the reverse API peer."
reverseAPIChannelIndex:
type: integer
description: "Channel index used by the reverse API peer."
spectrumConfig:
$ref: "http://swgserver:8081/api/swagger/include/GLSpectrum.yaml#/GLSpectrum"
description: "Spectrum-display configuration."
scopeConfig:
$ref: "http://swgserver:8081/api/swagger/include/GLScope.yaml#/GLScope"
description: "Oscilloscope-display configuration."
channelMarker:
$ref: "http://swgserver:8081/api/swagger/include/ChannelMarker.yaml#/ChannelMarker"
description: "Channel-marker display configuration."
rollupState:
$ref: "http://swgserver:8081/api/swagger/include/RollupState.yaml#/RollupState"
description: "Saved expanded or collapsed state of the GUI sections."

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

@ -3,11 +3,13 @@ ChannelMarker: @@ -3,11 +3,13 @@ ChannelMarker:
properties:
centerFrequency:
type: integer
description: "Device center frequency in Hz."
color:
type: integer
description: RGB color
title:
type: string
description: "User-visible title."
frequencyScaleDisplayType:
type: integer
description: ChannelMarker::frequencyScaleDisplay_t

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

@ -4,6 +4,7 @@ ChannelPowerSettings: @@ -4,6 +4,7 @@ ChannelPowerSettings:
inputFrequencyOffset:
type: integer
format: int64
description: "Channel frequency offset from the device center frequency in Hz."
frequencyMode:
description: (0 for Offset, 1 for Absolute)
type: integer
@ -14,6 +15,7 @@ ChannelPowerSettings: @@ -14,6 +15,7 @@ ChannelPowerSettings:
rfBandwidth:
type: number
format: float
description: "RF bandwidth in Hz."
pulseThreshold:
description: "In dB"
type: number
@ -23,26 +25,38 @@ ChannelPowerSettings: @@ -23,26 +25,38 @@ ChannelPowerSettings:
type: integer
rgbColor:
type: integer
description: "Display color encoded as an RGB integer."
title:
type: string
description: "User-visible title."
streamIndex:
description: MIMO channel. Not relevant when connected to SI (single Rx).
type: integer
useReverseAPI:
description: Synchronize with reverse API (1 for yes, 0 for no)
type: integer
minimum: 0
maximum: 1
reverseAPIAddress:
type: string
description: "IPv4 address or host name of the reverse API peer."
reverseAPIPort:
type: integer
description: "TCP port of the reverse API peer."
minimum: 1
maximum: 65535
reverseAPIDeviceIndex:
type: integer
description: "Device-set index used by the reverse API peer."
reverseAPIChannelIndex:
type: integer
description: "Channel index used by the reverse API peer."
channelMarker:
$ref: "http://swgserver:8081/api/swagger/include/ChannelMarker.yaml#/ChannelMarker"
description: "Channel-marker display configuration."
rollupState:
$ref: "http://swgserver:8081/api/swagger/include/RollupState.yaml#/RollupState"
description: "Saved expanded or collapsed state of the GUI sections."
ChannelPowerReport:
description: ChannelPower
@ -65,3 +79,4 @@ ChannelPowerReport: @@ -65,3 +79,4 @@ ChannelPowerReport:
format: float
channelSampleRate:
type: integer
description: "Effective sample rate delivered to the channel in samples per second."

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

@ -13,115 +13,171 @@ ChannelReport: @@ -13,115 +13,171 @@ ChannelReport:
type: integer
ADSBDemodReport:
$ref: "http://swgserver:8081/api/swagger/include/ADSBDemod.yaml#/ADSBDemodReport"
description: "ADS-B demod report data for Channel."
AISDemodReport:
$ref: "http://swgserver:8081/api/swagger/include/AISDemod.yaml#/AISDemodReport"
description: "AIS demod report data for Channel."
AISModReport:
$ref: "http://swgserver:8081/api/swagger/include/AISMod.yaml#/AISModReport"
description: "AIS mod report data for Channel."
AMDemodReport:
$ref: "http://swgserver:8081/api/swagger/include/AMDemod.yaml#/AMDemodReport"
description: "Am demod report data for Channel."
AMModReport:
$ref: "http://swgserver:8081/api/swagger/include/AMMod.yaml#/AMModReport"
description: "Am mod report data for Channel."
ATVModReport:
$ref: "http://swgserver:8081/api/swagger/include/ATVMod.yaml#/ATVModReport"
description: "Atv mod report data for Channel."
BFMDemodReport:
$ref: "http://swgserver:8081/api/swagger/include/BFMDemod.yaml#/BFMDemodReport"
description: "BFM demod report data for Channel."
ChannelPowerReport:
$ref: "http://swgserver:8081/api/swagger/include/ChannelPower.yaml#/ChannelPowerReport"
description: "Channel power report data for Channel."
ChirpChatDemodReport:
$ref: "http://swgserver:8081/api/swagger/include/ChirpChatDemod.yaml#/ChirpChatDemodReport"
description: "Chirp chat demod report data for Channel."
ChirpChatModReport:
$ref: "http://swgserver:8081/api/swagger/include/ChirpChatMod.yaml#/ChirpChatModReport"
description: "Chirp chat mod report data for Channel."
DATVDemodReport:
$ref: "http://swgserver:8081/api/swagger/include/DATVDemod.yaml#/DATVDemodReport"
description: "Datv demod report data for Channel."
DATVModReport:
$ref: "http://swgserver:8081/api/swagger/include/DATVMod.yaml#/DATVModReport"
description: "Datv mod report data for Channel."
DOA2Report:
$ref: "http://swgserver:8081/api/swagger/include/DOA2.yaml#/DOA2Report"
description: "Doa2 report data for Channel."
DSCDemodReport:
$ref: "http://swgserver:8081/api/swagger/include/DSCDemod.yaml#/DSCDemodReport"
description: "Dsc demod report data for Channel."
DSDDemodReport:
$ref: "http://swgserver:8081/api/swagger/include/DSDDemod.yaml#/DSDDemodReport"
description: "Dsd demod report data for Channel."
EndOfTrainDemodReport:
$ref: "http://swgserver:8081/api/swagger/include/EndOfTrainDemod.yaml#/EndOfTrainDemodReport"
description: "End of train demod report data for Channel."
IEEE_802_15_4_ModReport:
$ref: "http://swgserver:8081/api/swagger/include/IEEE_802_15_4_Mod.yaml#/IEEE_802_15_4_ModReport"
description: "Ieee 802 15 4 mod report data for Channel."
FileSinkReport:
$ref: "http://swgserver:8081/api/swagger/include/FileSink.yaml#/FileSinkReport"
description: "File sink report data for Channel."
FileSourceReport:
$ref: "http://swgserver:8081/api/swagger/include/FileSource.yaml#/FileSourceReport"
description: "File source report data for Channel."
FreeDVDemodReport:
$ref: "http://swgserver:8081/api/swagger/include/FreeDVDemod.yaml#/FreeDVDemodReport"
description: "Free dv demod report data for Channel."
FreeDVModReport:
$ref: "http://swgserver:8081/api/swagger/include/FreeDVMod.yaml#/FreeDVModReport"
description: "Free dv mod report data for Channel."
FreqScannerReport:
$ref: "http://swgserver:8081/api/swagger/include/FreqScanner.yaml#/FreqScannerReport"
description: "Freq scanner report data for Channel."
FreqTrackerReport:
$ref: "http://swgserver:8081/api/swagger/include/FreqTracker.yaml#/FreqTrackerReport"
description: "Freq tracker report data for Channel."
FT8DemodReport:
$ref: "http://swgserver:8081/api/swagger/include/FT8Demod.yaml#/FT8DemodReport"
description: "Ft8 demod report data for Channel."
HeatMapReport:
$ref: "http://swgserver:8081/api/swagger/include/HeatMap.yaml#/HeatMapReport"
description: "Heat map report data for Channel."
ILSDemodReport:
$ref: "http://swgserver:8081/api/swagger/include/ILSDemod.yaml#/ILSDemodReport"
description: "Ils demod report data for Channel."
InmarsatDemodReport:
$ref: "http://swgserver:8081/api/swagger/include/InmarsatDemod.yaml#/InmarsatDemodReport"
description: "Inmarsat demod report data for Channel."
M17DemodReport:
$ref: "http://swgserver:8081/api/swagger/include/M17Demod.yaml#/M17DemodReport"
description: "M17 demod report data for Channel."
M17ModReport:
$ref: "http://swgserver:8081/api/swagger/include/M17Mod.yaml#/M17ModReport"
description: "M17 mod report data for Channel."
MeshtasticDemodReport:
$ref: "http://swgserver:8081/api/swagger/include/MeshtasticDemod.yaml#/MeshtasticDemodReport"
description: "Meshtastic demod report data for Channel."
MeshtasticModReport:
$ref: "http://swgserver:8081/api/swagger/include/MeshtasticMod.yaml#/MeshtasticModReport"
description: "Meshtastic mod report data for Channel."
MeshcoreDemodReport:
$ref: "http://swgserver:8081/api/swagger/include/MeshcoreDemod.yaml#/MeshcoreDemodReport"
description: "Meshcore demod report data for Channel."
MeshcoreModReport:
$ref: "http://swgserver:8081/api/swagger/include/MeshcoreMod.yaml#/MeshcoreModReport"
description: "Meshcore mod report data for Channel."
NavtexDemodReport:
$ref: "http://swgserver:8081/api/swagger/include/NavtexDemod.yaml#/NavtexDemodReport"
description: "Navtex demod report data for Channel."
NFMDemodReport:
$ref: "http://swgserver:8081/api/swagger/include/NFMDemod.yaml#/NFMDemodReport"
description: "Nfm demod report data for Channel."
NFMModReport:
$ref: "http://swgserver:8081/api/swagger/include/NFMMod.yaml#/NFMModReport"
description: "Nfm mod report data for Channel."
NoiseFigureReport:
$ref: "http://swgserver:8081/api/swagger/include/NoiseFigure.yaml#/NoiseFigureReport"
description: "Noise figure report data for Channel."
SSBDemodReport:
$ref: "http://swgserver:8081/api/swagger/include/SSBDemod.yaml#/SSBDemodReport"
description: "Ssb demod report data for Channel."
RadioAstronomyReport:
$ref: "http://swgserver:8081/api/swagger/include/RadioAstronomy.yaml#/RadioAstronomyReport"
description: "Radio astronomy report data for Channel."
RadioClockReport:
$ref: "http://swgserver:8081/api/swagger/include/RadioClock.yaml#/RadioClockReport"
description: "Radio clock report data for Channel."
RadiosondeDemodReport:
$ref: "http://swgserver:8081/api/swagger/include/RadiosondeDemod.yaml#/RadiosondeDemodReport"
description: "Radiosonde demod report data for Channel."
RemoteSourceReport:
$ref: "http://swgserver:8081/api/swagger/include/RemoteSource.yaml#/RemoteSourceReport"
description: "Remote source report data for Channel."
RTTYDemodReport:
$ref: "http://swgserver:8081/api/swagger/include/RTTYDemod.yaml#/RTTYDemodReport"
description: "Rtty demod report data for Channel."
RTTYModReport:
$ref: "http://swgserver:8081/api/swagger/include/RTTYMod.yaml#/RTTYModReport"
description: "Rtty mod report data for Channel."
PacketDemodReport:
$ref: "http://swgserver:8081/api/swagger/include/PacketDemod.yaml#/PacketDemodReport"
description: "Packet demod report data for Channel."
PacketModReport:
$ref: "http://swgserver:8081/api/swagger/include/PacketMod.yaml#/PacketModReport"
description: "Packet mod report data for Channel."
PagerDemodReport:
$ref: "http://swgserver:8081/api/swagger/include/PagerDemod.yaml#/PagerDemodReport"
description: "Pager demod report data for Channel."
PSK31ModReport:
$ref: "http://swgserver:8081/api/swagger/include/PSK31Mod.yaml#/PSK31ModReport"
description: "Psk31 mod report data for Channel."
SigMFFileSinkReport:
$ref: "http://swgserver:8081/api/swagger/include/SigMFFileSink.yaml#/SigMFFileSinkReport"
description: "Sig mf file sink report data for Channel."
SSBModReport:
$ref: "http://swgserver:8081/api/swagger/include/SSBMod.yaml#/SSBModReport"
description: "Ssb mod report data for Channel."
UDPSourceReport:
$ref: "http://swgserver:8081/api/swagger/include/UDPSource.yaml#/UDPSourceReport"
description: "UDP source report data for Channel."
UDPSinkReport:
$ref: "http://swgserver:8081/api/swagger/include/UDPSink.yaml#/UDPSinkReport"
description: "UDP sink report data for Channel."
# VORDemodMCReport:
# $ref: "http://swgserver:8081/api/swagger/include/VORDemodMC.yaml#/VORDemodMCReport"
VORDemodReport:
$ref: "http://swgserver:8081/api/swagger/include/VORDemod.yaml#/VORDemodReport"
description: "Vor demod report data for Channel."
WDSPRxReport:
$ref: "http://swgserver:8081/api/swagger/include/WDSPRx.yaml#/WDSPRxReport"
description: "Wdsp receive report data for Channel."
WFMDemodReport:
$ref: "http://swgserver:8081/api/swagger/include/WFMDemod.yaml#/WFMDemodReport"
description: "Wfm demod report data for Channel."
WFMModReport:
$ref: "http://swgserver:8081/api/swagger/include/WFMMod.yaml#/WFMModReport"
description: "Wfm mod report data for Channel."

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

@ -19,135 +19,201 @@ ChannelSettings: @@ -19,135 +19,201 @@ ChannelSettings:
type: integer
ADSBDemodSettings:
$ref: "http://swgserver:8081/api/swagger/include/ADSBDemod.yaml#/ADSBDemodSettings"
description: "ADS-B demod settings configuration for Channel."
AISDemodSettings:
$ref: "http://swgserver:8081/api/swagger/include/AISDemod.yaml#/AISDemodSettings"
description: "AIS demod settings configuration for Channel."
AISModSettings:
$ref: "http://swgserver:8081/api/swagger/include/AISMod.yaml#/AISModSettings"
description: "AIS mod settings configuration for Channel."
AMDemodSettings:
$ref: "http://swgserver:8081/api/swagger/include/AMDemod.yaml#/AMDemodSettings"
description: "Am demod settings configuration for Channel."
AMModSettings:
$ref: "http://swgserver:8081/api/swagger/include/AMMod.yaml#/AMModSettings"
description: "Am mod settings configuration for Channel."
APTDemodSettings:
$ref: "http://swgserver:8081/api/swagger/include/APTDemod.yaml#/APTDemodSettings"
description: "Apt demod settings configuration for Channel."
ATVDemodSettings:
$ref: "http://swgserver:8081/api/swagger/include/ATVDemod.yaml#/ATVDemodSettings"
description: "Atv demod settings configuration for Channel."
ATVModSettings:
$ref: "http://swgserver:8081/api/swagger/include/ATVMod.yaml#/ATVModSettings"
description: "Atv mod settings configuration for Channel."
BeamSteeringCWModSettings:
$ref: "http://swgserver:8081/api/swagger/include/BeamSteeringCWMod.yaml#/BeamSteeringCWModSettings"
description: "Beam steering CW mod settings configuration for Channel."
BFMDemodSettings:
$ref: "http://swgserver:8081/api/swagger/include/BFMDemod.yaml#/BFMDemodSettings"
description: "BFM demod settings configuration for Channel."
ChannelAnalyzerSettings:
$ref: "http://swgserver:8081/api/swagger/include/ChannelAnalyzer.yaml#/ChannelAnalyzerSettings"
description: "Channel analyzer settings configuration for Channel."
ChannelPowerSettings:
$ref: "http://swgserver:8081/api/swagger/include/ChannelPower.yaml#/ChannelPowerSettings"
description: "Channel power settings configuration for Channel."
ChirpChatDemodSettings:
$ref: "http://swgserver:8081/api/swagger/include/ChirpChatDemod.yaml#/ChirpChatDemodSettings"
description: "Chirp chat demod settings configuration for Channel."
ChirpChatModSettings:
$ref: "http://swgserver:8081/api/swagger/include/ChirpChatMod.yaml#/ChirpChatModSettings"
description: "Chirp chat mod settings configuration for Channel."
DATVModSettings:
$ref: "http://swgserver:8081/api/swagger/include/DATVMod.yaml#/DATVModSettings"
description: "Datv mod settings configuration for Channel."
DATVDemodSettings:
$ref: "http://swgserver:8081/api/swagger/include/DATVDemod.yaml#/DATVDemodSettings"
description: "Datv demod settings configuration for Channel."
DABDemodSettings:
$ref: "http://swgserver:8081/api/swagger/include/DABDemod.yaml#/DABDemodSettings"
description: "Dab demod settings configuration for Channel."
DOA2Settings:
$ref: "http://swgserver:8081/api/swagger/include/DOA2.yaml#/DOA2Settings"
description: "Doa2 settings configuration for Channel."
DSCDemodSettings:
$ref: "http://swgserver:8081/api/swagger/include/DSCDemod.yaml#/DSCDemodSettings"
description: "Dsc demod settings configuration for Channel."
DSDDemodSettings:
$ref: "http://swgserver:8081/api/swagger/include/DSDDemod.yaml#/DSDDemodSettings"
description: "Dsd demod settings configuration for Channel."
EndOfTrainDemodSettings:
$ref: "http://swgserver:8081/api/swagger/include/EndOfTrainDemod.yaml#/EndOfTrainDemodSettings"
description: "End of train demod settings configuration for Channel."
FileSinkSettings:
$ref: "http://swgserver:8081/api/swagger/include/FileSink.yaml#/FileSinkSettings"
description: "File sink settings configuration for Channel."
FileSourceSettings:
$ref: "http://swgserver:8081/api/swagger/include/FileSource.yaml#/FileSourceSettings"
description: "File source settings configuration for Channel."
FreeDVDemodSettings:
$ref: "http://swgserver:8081/api/swagger/include/FreeDVDemod.yaml#/FreeDVDemodSettings"
description: "Free dv demod settings configuration for Channel."
FreeDVModSettings:
$ref: "http://swgserver:8081/api/swagger/include/FreeDVMod.yaml#/FreeDVModSettings"
description: "Free dv mod settings configuration for Channel."
FreqScannerSettings:
$ref: "http://swgserver:8081/api/swagger/include/FreqScanner.yaml#/FreqScannerSettings"
description: "Freq scanner settings configuration for Channel."
FreqTrackerSettings:
$ref: "http://swgserver:8081/api/swagger/include/FreqTracker.yaml#/FreqTrackerSettings"
description: "Freq tracker settings configuration for Channel."
FT8DemodSettings:
$ref: "http://swgserver:8081/api/swagger/include/FT8Demod.yaml#/FT8DemodSettings"
description: "Ft8 demod settings configuration for Channel."
HeatMapSettings:
$ref: "http://swgserver:8081/api/swagger/include/HeatMap.yaml#/HeatMapSettings"
description: "Heat map settings configuration for Channel."
ILSDemodSettings:
$ref: "http://swgserver:8081/api/swagger/include/ILSDemod.yaml#/ILSDemodSettings"
description: "Ils demod settings configuration for Channel."
InmarsatDemodSettings:
$ref: "http://swgserver:8081/api/swagger/include/InmarsatDemod.yaml#/InmarsatDemodSettings"
description: "Inmarsat demod settings configuration for Channel."
InterferometerSettings:
$ref: "http://swgserver:8081/api/swagger/include/Interferometer.yaml#/InterferometerSettings"
description: "Interferometer settings configuration for Channel."
IEEE_802_15_4_ModSettings:
$ref: "http://swgserver:8081/api/swagger/include/IEEE_802_15_4_Mod.yaml#/IEEE_802_15_4_ModSettings"
description: "Ieee 802 15 4 mod settings configuration for Channel."
M17DemodSettings:
$ref: "http://swgserver:8081/api/swagger/include/M17Demod.yaml#/M17DemodSettings"
description: "M17 demod settings configuration for Channel."
M17ModSettings:
$ref: "http://swgserver:8081/api/swagger/include/M17Mod.yaml#/M17ModSettings"
description: "M17 mod settings configuration for Channel."
MeshtasticDemodSettings:
$ref: "http://swgserver:8081/api/swagger/include/MeshtasticDemod.yaml#/MeshtasticDemodSettings"
description: "Meshtastic demod settings configuration for Channel."
MeshtasticModSettings:
$ref: "http://swgserver:8081/api/swagger/include/MeshtasticMod.yaml#/MeshtasticModSettings"
description: "Meshtastic mod settings configuration for Channel."
MeshcoreDemodSettings:
$ref: "http://swgserver:8081/api/swagger/include/MeshcoreDemod.yaml#/MeshcoreDemodSettings"
description: "Meshcore demod settings configuration for Channel."
MeshcoreModSettings:
$ref: "http://swgserver:8081/api/swagger/include/MeshcoreMod.yaml#/MeshcoreModSettings"
description: "Meshcore mod settings configuration for Channel."
NavtexDemodSettings:
$ref: "http://swgserver:8081/api/swagger/include/NavtexDemod.yaml#/NavtexDemodSettings"
description: "Navtex demod settings configuration for Channel."
NFMDemodSettings:
$ref: "http://swgserver:8081/api/swagger/include/NFMDemod.yaml#/NFMDemodSettings"
description: "Nfm demod settings configuration for Channel."
NFMModSettings:
$ref: "http://swgserver:8081/api/swagger/include/NFMMod.yaml#/NFMModSettings"
description: "Nfm mod settings configuration for Channel."
NoiseFigureSettings:
$ref: "http://swgserver:8081/api/swagger/include/NoiseFigure.yaml#/NoiseFigureSettings"
description: "Noise figure settings configuration for Channel."
LocalSinkSettings:
$ref: "http://swgserver:8081/api/swagger/include/LocalSink.yaml#/LocalSinkSettings"
description: "Local sink settings configuration for Channel."
LocalSourceSettings:
$ref: "http://swgserver:8081/api/swagger/include/LocalSource.yaml#/LocalSourceSettings"
description: "Local source settings configuration for Channel."
PacketDemodSettings:
$ref: "http://swgserver:8081/api/swagger/include/PacketDemod.yaml#/PacketDemodSettings"
description: "Packet demod settings configuration for Channel."
PacketModSettings:
$ref: "http://swgserver:8081/api/swagger/include/PacketMod.yaml#/PacketModSettings"
description: "Packet mod settings configuration for Channel."
PagerDemodSettings:
$ref: "http://swgserver:8081/api/swagger/include/PagerDemod.yaml#/PagerDemodSettings"
description: "Pager demod settings configuration for Channel."
PSK31ModSettings:
$ref: "http://swgserver:8081/api/swagger/include/PSK31Mod.yaml#/PSK31ModSettings"
description: "Psk31 mod settings configuration for Channel."
RadioAstronomySettings:
$ref: "http://swgserver:8081/api/swagger/include/RadioAstronomy.yaml#/RadioAstronomySettings"
description: "Radio astronomy settings configuration for Channel."
RadioClockSettings:
$ref: "http://swgserver:8081/api/swagger/include/RadioClock.yaml#/RadioClockSettings"
description: "Radio clock settings configuration for Channel."
RadiosondeDemodSettings:
$ref: "http://swgserver:8081/api/swagger/include/RadiosondeDemod.yaml#/RadiosondeDemodSettings"
description: "Radiosonde demod settings configuration for Channel."
RemoteSinkSettings:
$ref: "http://swgserver:8081/api/swagger/include/RemoteSink.yaml#/RemoteSinkSettings"
description: "Remote sink settings configuration for Channel."
RemoteSourceSettings:
$ref: "http://swgserver:8081/api/swagger/include/RemoteSource.yaml#/RemoteSourceSettings"
description: "Remote source settings configuration for Channel."
RemoteTCPSinkSettings:
$ref: "http://swgserver:8081/api/swagger/include/RemoteTCPSink.yaml#/RemoteTCPSinkSettings"
description: "Remote TCP sink settings configuration for Channel."
RTTYDemodSettings:
$ref: "http://swgserver:8081/api/swagger/include/RTTYDemod.yaml#/RTTYDemodSettings"
description: "Rtty demod settings configuration for Channel."
RTTYModSettings:
$ref: "http://swgserver:8081/api/swagger/include/RTTYMod.yaml#/RTTYModSettings"
description: "Rtty mod settings configuration for Channel."
SigMFFileSinkSettings:
$ref: "http://swgserver:8081/api/swagger/include/SigMFFileSink.yaml#/SigMFFileSinkSettings"
description: "Sig mf file sink settings configuration for Channel."
SSBModSettings:
$ref: "http://swgserver:8081/api/swagger/include/SSBMod.yaml#/SSBModSettings"
description: "Ssb mod settings configuration for Channel."
SSBDemodSettings:
$ref: "http://swgserver:8081/api/swagger/include/SSBDemod.yaml#/SSBDemodSettings"
description: "Ssb demod settings configuration for Channel."
UDPSourceSettings:
$ref: "http://swgserver:8081/api/swagger/include/UDPSource.yaml#/UDPSourceSettings"
description: "UDP source settings configuration for Channel."
UDPSinkSettings:
$ref: "http://swgserver:8081/api/swagger/include/UDPSink.yaml#/UDPSinkSettings"
description: "UDP sink settings configuration for Channel."
# VORDemodMCSettings:
# $ref: "http://swgserver:8081/api/swagger/include/VORDemodMC.yaml#/VORDemodMCSettings"
VORDemodSettings:
$ref: "http://swgserver:8081/api/swagger/include/VORDemod.yaml#/VORDemodSettings"
description: "Vor demod settings configuration for Channel."
WDSPRxSettings:
$ref: "http://swgserver:8081/api/swagger/include/WDSPRx.yaml#/WDSPRxSettings"
description: "Wdsp receive settings configuration for Channel."
WFMDemodSettings:
$ref: "http://swgserver:8081/api/swagger/include/WFMDemod.yaml#/WFMDemodSettings"
description: "Wfm demod settings configuration for Channel."
WFMModSettings:
$ref: "http://swgserver:8081/api/swagger/include/WFMMod.yaml#/WFMModSettings"
description: "Wfm mod settings configuration for Channel."

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

@ -4,8 +4,11 @@ ChirpChatDemodSettings: @@ -4,8 +4,11 @@ ChirpChatDemodSettings:
inputFrequencyOffset:
type: integer
format: int64
description: "Channel frequency offset from the device center frequency in Hz."
bandwidthIndex:
type: integer
minimum: 0
maximum: 26
description: >
standard bandwidths index:
* 0 - 375 Hz (384000 / 1024)
@ -37,11 +40,14 @@ ChirpChatDemodSettings: @@ -37,11 +40,14 @@ ChirpChatDemodSettings:
* 26 - 500000 Hz (500000 / 1)
spreadFactor:
type: integer
description: "Spread factor setting for Chirp chat demod."
deBits:
description: Low data rate optimize (DE) bits i.e. nb of FFT bins per effective symbol
type: integer
fftWindow:
type: integer
minimum: 0
maximum: 8
description: >
FFT Window index (FFTWindow::Function):
* 0 - Bartlett
@ -55,6 +61,8 @@ ChirpChatDemodSettings: @@ -55,6 +61,8 @@ ChirpChatDemodSettings:
* 8 - Blackman-Harris 7 term
codingScheme:
type: integer
minimum: 0
maximum: 2
description: >
message encoding scheme (ChirpChatDemodSettings::CodingScheme):
* 0 - LoRa
@ -63,6 +71,8 @@ ChirpChatDemodSettings: @@ -63,6 +71,8 @@ ChirpChatDemodSettings:
decodeActive:
description: boolean 1 to activate 0 to de-activate decoder
type: integer
minimum: 0
maximum: 1
eomSquelchTenths:
description: argmax squared magnitude is compared between current multiplied by this factor and maximum during decoding. This value is divided by 10
type: integer
@ -90,8 +100,12 @@ ChirpChatDemodSettings: @@ -90,8 +100,12 @@ ChirpChatDemodSettings:
sendViaUDP:
description: boolean 1 to send decoded message via UDP else 0
type: integer
minimum: 0
maximum: 1
udoEnabled:
type: integer
minimum: 0
maximum: 1
description: >
Boolean - Send via UDP
* 0 - Do not send decoded messages via UDP
@ -102,36 +116,53 @@ ChirpChatDemodSettings: @@ -102,36 +116,53 @@ ChirpChatDemodSettings:
udpPort:
description: UDP destination port
type: integer
minimum: 1
maximum: 65535
invertRamps:
type: integer
minimum: 0
maximum: 1
description: >
Invert chirp ramps
* 0 - Normal chirp ramps (upchirps for preamble and payload)
* 1 - Inverted chirp ramps (downchirps for preamble and payload)
rgbColor:
type: integer
description: "Display color encoded as an RGB integer."
title:
type: string
description: "User-visible title."
streamIndex:
description: MIMO channel. Not relevant when connected to SI (single Rx).
type: integer
useReverseAPI:
description: Synchronize with reverse API (1 for yes, 0 for no)
type: integer
minimum: 0
maximum: 1
reverseAPIAddress:
type: string
description: "IPv4 address or host name of the reverse API peer."
reverseAPIPort:
type: integer
description: "TCP port of the reverse API peer."
minimum: 1
maximum: 65535
reverseAPIDeviceIndex:
type: integer
description: "Device-set index used by the reverse API peer."
reverseAPIChannelIndex:
type: integer
description: "Channel index used by the reverse API peer."
spectrumConfig:
$ref: "http://swgserver:8081/api/swagger/include/GLSpectrum.yaml#/GLSpectrum"
description: "Spectrum-display configuration."
channelMarker:
$ref: "http://swgserver:8081/api/swagger/include/ChannelMarker.yaml#/ChannelMarker"
description: "Channel-marker display configuration."
rollupState:
$ref: "http://swgserver:8081/api/swagger/include/RollupState.yaml#/RollupState"
description: "Saved expanded or collapsed state of the GUI sections."
ChirpChatDemodReport:
description: ChirpChatDemod
@ -154,12 +185,15 @@ ChirpChatDemodReport: @@ -154,12 +185,15 @@ ChirpChatDemodReport:
format: float
channelSampleRate:
type: integer
description: "Effective sample rate delivered to the channel in samples per second."
syncWord:
description: 2 bytes sync word (0..65535)
type: integer
hasCRC:
description: boolean 1 if payload CRC is present else 0 (LoRa)
type: integer
minimum: 0
maximum: 1
nbParityBits:
description: Hamming FEC parity bits (LoRa)
type: integer
@ -174,6 +208,8 @@ ChirpChatDemodReport: @@ -174,6 +208,8 @@ ChirpChatDemodReport:
type: integer
headerParityStatus:
type: integer
minimum: 0
maximum: 3
description: >
Header FEC parity status:
* 0 - Undefined
@ -185,6 +221,8 @@ ChirpChatDemodReport: @@ -185,6 +221,8 @@ ChirpChatDemodReport:
type: integer
payloadParityStatus:
type: integer
minimum: 0
maximum: 3
description: >
Payload FEC parity status:
* 0 - Undefined
@ -207,6 +245,8 @@ ChirpChatDemodReport: @@ -207,6 +245,8 @@ ChirpChatDemodReport:
type: string
decoding:
type: integer
minimum: 0
maximum: 1
description: >
Boolean - decoding status
* 0 - no decoding

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

@ -4,8 +4,11 @@ ChirpChatModSettings: @@ -4,8 +4,11 @@ ChirpChatModSettings:
inputFrequencyOffset:
type: integer
format: int64
description: "Channel frequency offset from the device center frequency in Hz."
bandwidthIndex:
type: integer
minimum: 0
maximum: 26
description: >
standard bandwidths index:
* 0 - 375 Hz (384000 / 1024)
@ -37,6 +40,7 @@ ChirpChatModSettings: @@ -37,6 +40,7 @@ ChirpChatModSettings:
* 26 - 500000 Hz (500000 / 1)
spreadFactor:
type: integer
description: "Spread factor setting for Chirp chat mod."
deBits:
description: Low data rate optimize (DE) bits i.e. nb of FFT bins per effective symbol
type: integer
@ -52,8 +56,12 @@ ChirpChatModSettings: @@ -52,8 +56,12 @@ ChirpChatModSettings:
channelMute:
description: boolean
type: integer
minimum: 0
maximum: 1
codingScheme:
type: integer
minimum: 0
maximum: 2
description: >
message encoding scheme (ChirpChatModSettings::CodingScheme):
* 0 - LoRa
@ -82,6 +90,8 @@ ChirpChatModSettings: @@ -82,6 +90,8 @@ ChirpChatModSettings:
type: string
messageType:
type: integer
minimum: 0
maximum: 10
description: >
type of message to send (ChirpChatModSettings::MessageType):
* 0 - No message i.e no output. Use this as a transition to resend the same message.
@ -133,40 +143,58 @@ ChirpChatModSettings: @@ -133,40 +143,58 @@ ChirpChatModSettings:
udpEnabled:
description: boolean 1 to enable forwarding messages via UDP else 0
type: integer
minimum: 0
maximum: 1
udpAddress:
description: UDP address to listen for messages to transmit on
type: string
udpPort:
description: UDP port to listen for messages to transmit on
type: integer
minimum: 1
maximum: 65535
invertRamps:
type: integer
minimum: 0
maximum: 1
description: >
Invert chirp ramps
* 0 - Normal chirp ramps (upchirps for preamble and payload)
* 1 - Inverted chirp ramps (downchirps for preamble and payload)
rgbColor:
type: integer
description: "Display color encoded as an RGB integer."
title:
type: string
description: "User-visible title."
streamIndex:
description: MIMO channel. Not relevant when connected to SI (single Rx).
type: integer
useReverseAPI:
description: Synchronize with reverse API (1 for yes, 0 for no)
type: integer
minimum: 0
maximum: 1
reverseAPIAddress:
type: string
description: "IPv4 address or host name of the reverse API peer."
reverseAPIPort:
type: integer
description: "TCP port of the reverse API peer."
minimum: 1
maximum: 65535
reverseAPIDeviceIndex:
type: integer
description: "Device-set index used by the reverse API peer."
reverseAPIChannelIndex:
type: integer
description: "Channel index used by the reverse API peer."
channelMarker:
$ref: "http://swgserver:8081/api/swagger/include/ChannelMarker.yaml#/ChannelMarker"
description: "Channel-marker display configuration."
rollupState:
$ref: "http://swgserver:8081/api/swagger/include/RollupState.yaml#/RollupState"
description: "Saved expanded or collapsed state of the GUI sections."
ChirpChatModReport:
description: ChirpChatMod
@ -177,6 +205,7 @@ ChirpChatModReport: @@ -177,6 +205,7 @@ ChirpChatModReport:
format: float
channelSampleRate:
type: integer
description: "Effective sample rate delivered to the channel in samples per second."
symbolTimeMs:
description: symbol duration (ms)
type: number
@ -191,6 +220,8 @@ ChirpChatModReport: @@ -191,6 +220,8 @@ ChirpChatModReport:
format: float
playing:
type: integer
minimum: 0
maximum: 1
description: >
Boolean - modulator is active (playing) including idle time
* 0 - Modulator not active

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

@ -3,12 +3,16 @@ Command: @@ -3,12 +3,16 @@ Command:
properties:
group:
type: string
description: "Group for Command."
description:
type: string
description: "Human-readable description."
command:
type: string
description: "Command for Command."
argString:
type: string
description: "Arg string for Command."
key:
description: Qt::Key
type: integer
@ -18,6 +22,10 @@ Command: @@ -18,6 +22,10 @@ Command:
associateKey:
description: boolean
type: integer
minimum: 0
maximum: 1
release:
description: boolean
type: integer
type: integer
minimum: 0
maximum: 1

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

@ -4,37 +4,57 @@ DABDemodSettings: @@ -4,37 +4,57 @@ DABDemodSettings:
inputFrequencyOffset:
type: integer
format: int64
description: "Channel frequency offset from the device center frequency in Hz."
rfBandwidth:
type: number
format: float
description: "RF bandwidth in Hz."
program:
type: string
description: "Program setting for Dab demod."
volume:
type: number
format: float
description: "Audio volume multiplier."
audioMute:
type: integer
description: "Mute audio output (1 muted, 0 unmuted)."
minimum: 0
maximum: 1
audioDeviceName:
type: string
description: "Name of the audio device to use."
rgbColor:
type: integer
description: "Display color encoded as an RGB integer."
title:
type: string
description: "User-visible title."
streamIndex:
description: MIMO channel. Not relevant when connected to SI (single Rx).
type: integer
useReverseAPI:
description: Synchronize with reverse API (1 for yes, 0 for no)
type: integer
minimum: 0
maximum: 1
reverseAPIAddress:
type: string
description: "IPv4 address or host name of the reverse API peer."
reverseAPIPort:
type: integer
description: "TCP port of the reverse API peer."
minimum: 1
maximum: 65535
reverseAPIDeviceIndex:
type: integer
description: "Device-set index used by the reverse API peer."
reverseAPIChannelIndex:
type: integer
description: "Channel index used by the reverse API peer."
channelMarker:
$ref: "http://swgserver:8081/api/swagger/include/ChannelMarker.yaml#/ChannelMarker"
description: "Channel-marker display configuration."
rollupState:
$ref: "http://swgserver:8081/api/swagger/include/RollupState.yaml#/RollupState"
description: "Saved expanded or collapsed state of the GUI sections."

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

@ -3,20 +3,28 @@ DATVDemodSettings: @@ -3,20 +3,28 @@ DATVDemodSettings:
properties:
rgbColor:
type: integer
description: "Display color encoded as an RGB integer."
title:
type: string
description: "User-visible title."
rfBandwidth:
type: integer
description: "RF bandwidth in Hz."
centerFrequency:
type: integer
description: "Device center frequency in Hz."
standard:
type: integer
minimum: 0
maximum: 1
description: >
DVB bersion (see DATVDemodSettings::dvb_version)
* 0 - DVB-S
* 1 - DVB-S2
modulation:
type: integer
minimum: 0
maximum: 8
description: >
Modulation type (DATVDemodSettings::DATVModulation)
* 0 - BPSK
@ -30,6 +38,8 @@ DATVDemodSettings: @@ -30,6 +38,8 @@ DATVDemodSettings:
* 8 - QAM256
fec:
type: integer
minimum: 0
maximum: 12
description: >
FEC rate (see DATVDemodSettings::DATVCodeRate)
* 0 - 1/2
@ -57,12 +67,17 @@ DATVDemodSettings: @@ -57,12 +67,17 @@ DATVDemodSettings:
audioMute:
description: (boolean) mute audio output
type: integer
minimum: 0
maximum: 1
audioDeviceName:
type: string
description: "Name of the audio device to use."
symbolRate:
type: integer
description: "Symbol rate setting for Datv demod."
notchFilters:
type: integer
description: "Notch filters setting for Datv demod."
allowDrift:
description: (boolean) allow a larger frequency drift (DVB-S)
type: integer
@ -76,6 +91,8 @@ DATVDemodSettings: @@ -76,6 +91,8 @@ DATVDemodSettings:
* 1 - Linear
* 2 - Root Raised Cosine
type: integer
minimum: 0
maximum: 2
hardMetric:
description: (boolean) (DVB-S)
type: integer
@ -91,37 +108,56 @@ DATVDemodSettings: @@ -91,37 +108,56 @@ DATVDemodSettings:
type: integer
audioVolume:
type: integer
description: "Audio volume setting for Datv demod."
videoMute:
description: boolean
type: integer
minimum: 0
maximum: 1
udpTSAddress:
type: string
description: "UDP ts address."
udpTSPort:
type: integer
description: "UDP ts port."
udpTS:
description: boolean
type: integer
minimum: 0
maximum: 1
playerEnable:
description: boolean
type: integer
minimum: 0
maximum: 1
streamIndex:
description: MIMO channel. Not relevant when connected to SI (single Rx).
type: integer
useReverseAPI:
description: Synchronize with reverse API (1 for yes, 0 for no)
type: integer
minimum: 0
maximum: 1
reverseAPIAddress:
type: string
description: "IPv4 address or host name of the reverse API peer."
reverseAPIPort:
type: integer
description: "TCP port of the reverse API peer."
minimum: 1
maximum: 65535
reverseAPIDeviceIndex:
type: integer
description: "Device-set index used by the reverse API peer."
reverseAPIChannelIndex:
type: integer
description: "Channel index used by the reverse API peer."
channelMarker:
$ref: "http://swgserver:8081/api/swagger/include/ChannelMarker.yaml#/ChannelMarker"
description: "Channel-marker display configuration."
rollupState:
$ref: "http://swgserver:8081/api/swagger/include/RollupState.yaml#/RollupState"
description: "Saved expanded or collapsed state of the GUI sections."
DATVDemodReport:
description: DATVDemod
@ -133,12 +169,16 @@ DATVDemodReport: @@ -133,12 +169,16 @@ DATVDemodReport:
audioActive:
description: Audio is active (1 for yes, 0 for now)
type: integer
minimum: 0
maximum: 1
audioDecodeOK:
description: Audio decode (1 for OK, 0 for KO)
type: integer
videoActive:
description: Audio is active (1 for yes, 0 for now)
type: integer
minimum: 0
maximum: 1
videoDecodeOK:
description: Video decode (1 for OK, 0 for KO)
type: integer
@ -187,6 +227,8 @@ DATVDemodReport: @@ -187,6 +227,8 @@ DATVDemodReport:
mer:
type: number
format: float
description: "Reported mer."
cnr:
type: number
format: float
description: "Reported cnr."

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

@ -4,9 +4,11 @@ DATVModSettings: @@ -4,9 +4,11 @@ DATVModSettings:
inputFrequencyOffset:
type: integer
format: int64
description: "Channel frequency offset from the device center frequency in Hz."
rfBandwidth:
type: number
format: float
description: "RF bandwidth in Hz."
standard:
description: "Broadcast standard (DVB-S=0)"
type: integer
@ -28,6 +30,7 @@ DATVModSettings: @@ -28,6 +30,7 @@ DATVModSettings:
type: integer
imageFileName:
type: string
description: "Image file name or path."
imageOverlayTimestamp:
description: "Overlay timestamp on still image (1 for yes, 0 for no)"
type: integer
@ -42,40 +45,60 @@ DATVModSettings: @@ -42,40 +45,60 @@ DATVModSettings:
type: integer
tsFileName:
type: string
description: "Ts file name."
tsFilePlayLoop:
type: integer
description: "Ts file play loop setting for Datv mod."
tsFilePlay:
description: "(Pause=0 Play=1)"
type: integer
udpAddress:
type: string
description: "IPv4 address or host name used for UDP traffic."
udpPort:
description: "UDP port number to receive MPEG transport stream on"
type: integer
minimum: 1
maximum: 65535
channelMute:
type: integer
description: "Mute the channel output (1 muted, 0 unmuted)."
minimum: 0
maximum: 1
rgbColor:
type: integer
description: "Display color encoded as an RGB integer."
title:
type: string
description: "User-visible title."
streamIndex:
description: MIMO channel. Not relevant when connected to SI (single Rx).
type: integer
useReverseAPI:
description: Synchronize with reverse API (1 for yes, 0 for no)
type: integer
minimum: 0
maximum: 1
reverseAPIAddress:
type: string
description: "IPv4 address or host name of the reverse API peer."
reverseAPIPort:
type: integer
description: "TCP port of the reverse API peer."
minimum: 1
maximum: 65535
reverseAPIDeviceIndex:
type: integer
description: "Device-set index used by the reverse API peer."
reverseAPIChannelIndex:
type: integer
description: "Channel index used by the reverse API peer."
channelMarker:
$ref: "http://swgserver:8081/api/swagger/include/ChannelMarker.yaml#/ChannelMarker"
description: "Channel-marker display configuration."
rollupState:
$ref: "http://swgserver:8081/api/swagger/include/RollupState.yaml#/RollupState"
description: "Saved expanded or collapsed state of the GUI sections."
DATVModReport:
description: DATVMod
@ -86,12 +109,17 @@ DATVModReport: @@ -86,12 +109,17 @@ DATVModReport:
format: float
channelSampleRate:
type: integer
description: "Effective sample rate delivered to the channel in samples per second."
dataRate:
type: integer
description: "Reported data rate."
tsFileBitrate:
type: integer
description: "Reported ts file bitrate."
tsFileLength:
type: integer
description: "Reported ts file length."
udpByteCount:
type: integer
format: int64
description: "Number of udp byte events or items."

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

@ -6,12 +6,16 @@ DOA2Settings: @@ -6,12 +6,16 @@ DOA2Settings:
type: integer
rgbColor:
type: integer
description: "Display color encoded as an RGB integer."
title:
type: string
description: "User-visible title."
log2Decim:
type: integer
description: "Base-2 exponent of the software decimation factor; the output sample rate is divided by 2^log2Decim."
filterChainHash:
type: integer
description: "Identifier of the selected half-band filter chain."
phase:
type: integer
description: Phase difference correction in degrees from -180 to +180
@ -30,20 +34,31 @@ DOA2Settings: @@ -30,20 +34,31 @@ DOA2Settings:
useReverseAPI:
description: Synchronize with reverse API (1 for yes, 0 for no)
type: integer
minimum: 0
maximum: 1
reverseAPIAddress:
type: string
description: "IPv4 address or host name of the reverse API peer."
reverseAPIPort:
type: integer
description: "TCP port of the reverse API peer."
minimum: 1
maximum: 65535
reverseAPIDeviceIndex:
type: integer
description: "Device-set index used by the reverse API peer."
reverseAPIChannelIndex:
type: integer
description: "Channel index used by the reverse API peer."
scopeConfig:
$ref: "http://swgserver:8081/api/swagger/include/GLScope.yaml#/GLScope"
description: "Oscilloscope-display configuration."
channelMarker:
$ref: "http://swgserver:8081/api/swagger/include/ChannelMarker.yaml#/ChannelMarker"
description: "Channel-marker display configuration."
rollupState:
$ref: "http://swgserver:8081/api/swagger/include/RollupState.yaml#/RollupState"
description: "Saved expanded or collapsed state of the GUI sections."
DOA2Report:
description: DOA2

33
swagger/sdrangel/api/swagger/include/DSCDemod.yaml

@ -4,51 +4,83 @@ DSCDemodSettings: @@ -4,51 +4,83 @@ DSCDemodSettings:
inputFrequencyOffset:
type: integer
format: int64
description: "Channel frequency offset from the device center frequency in Hz."
rfBandwidth:
type: number
format: float
description: "RF bandwidth in Hz."
filterInvalid:
type: integer
description: "Filter invalid setting for Dsc demod."
filterColumn:
type: integer
description: "Filter column setting for Dsc demod."
filter:
type: string
description: "Filter setting for Dsc demod."
udpEnabled:
type: integer
description: "Enable udp (1 enabled, 0 disabled)."
minimum: 0
maximum: 1
udpAddress:
type: string
description: "IPv4 address or host name used for UDP traffic."
udpPort:
type: integer
description: "UDP port number."
minimum: 1
maximum: 65535
logFilename:
type: string
description: "Log file name or path."
logEnabled:
type: integer
description: "Enable logging to the configured file (1 enabled, 0 disabled)."
minimum: 0
maximum: 1
useFileTime:
type: integer
description: "Enable file time (1 enabled, 0 disabled)."
minimum: 0
maximum: 1
rgbColor:
type: integer
description: "Display color encoded as an RGB integer."
title:
type: string
description: "User-visible title."
streamIndex:
description: MIMO channel. Not relevant when connected to SI (single Rx).
type: integer
useReverseAPI:
description: Synchronize with reverse API (1 for yes, 0 for no)
type: integer
minimum: 0
maximum: 1
reverseAPIAddress:
type: string
description: "IPv4 address or host name of the reverse API peer."
reverseAPIPort:
type: integer
description: "TCP port of the reverse API peer."
minimum: 1
maximum: 65535
reverseAPIDeviceIndex:
type: integer
description: "Device-set index used by the reverse API peer."
reverseAPIChannelIndex:
type: integer
description: "Channel index used by the reverse API peer."
scopeConfig:
$ref: "http://swgserver:8081/api/swagger/include/GLScope.yaml#/GLScope"
description: "Oscilloscope-display configuration."
channelMarker:
$ref: "http://swgserver:8081/api/swagger/include/ChannelMarker.yaml#/ChannelMarker"
description: "Channel-marker display configuration."
rollupState:
$ref: "http://swgserver:8081/api/swagger/include/RollupState.yaml#/RollupState"
description: "Saved expanded or collapsed state of the GUI sections."
DSCDemodReport:
description: DSCDemod
@ -59,3 +91,4 @@ DSCDemodReport: @@ -59,3 +91,4 @@ DSCDemodReport:
format: float
channelSampleRate:
type: integer
description: "Effective sample rate delivered to the channel in samples per second."

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

@ -4,47 +4,70 @@ DSDDemodSettings: @@ -4,47 +4,70 @@ DSDDemodSettings:
inputFrequencyOffset:
type: integer
format: int64
description: "Channel frequency offset from the device center frequency in Hz."
rfBandwidth:
type: number
format: float
description: "RF bandwidth in Hz."
fmDeviation:
type: number
format: float
description: "FM frequency deviation in Hz."
demodGain:
type: number
format: float
description: "Demod gain setting for Dsd demod."
volume:
type: number
format: float
description: "Audio volume multiplier."
baudRate:
type: integer
description: "Serial-port baud rate in bits per second."
squelchGate:
type: integer
description: "Squelch gate duration."
squelch:
type: number
format: float
description: "Squelch threshold in dB."
audioMute:
type: integer
description: "Mute audio output (1 muted, 0 unmuted)."
minimum: 0
maximum: 1
enableCosineFiltering:
type: integer
description: "Enable cosine filtering (1 enabled, 0 disabled)."
minimum: 0
maximum: 1
syncOrConstellation:
type: integer
description: "Sync or constellation setting for Dsd demod."
slot1On:
type: integer
description: "Slot1 on setting for Dsd demod."
slot2On:
type: integer
description: "Slot2 on setting for Dsd demod."
tdmaStereo:
type: integer
description: "Tdma stereo setting for Dsd demod."
pllLock:
type: integer
description: "Pll lock setting for Dsd demod."
rgbColor:
type: integer
description: "Display color encoded as an RGB integer."
title:
type: string
description: "User-visible title."
audioDeviceName:
type: string
description: "Name of the audio device to use."
highPassFilter:
type: integer
description: "High pass filter setting for Dsd demod."
traceLengthMutliplier:
description: multiply by 50ms
type: integer
@ -60,23 +83,35 @@ DSDDemodSettings: @@ -60,23 +83,35 @@ DSDDemodSettings:
useReverseAPI:
description: Synchronize with reverse API (1 for yes, 0 for no)
type: integer
minimum: 0
maximum: 1
reverseAPIAddress:
type: string
description: "IPv4 address or host name of the reverse API peer."
reverseAPIPort:
type: integer
description: "TCP port of the reverse API peer."
minimum: 1
maximum: 65535
reverseAPIDeviceIndex:
type: integer
description: "Device-set index used by the reverse API peer."
reverseAPIChannelIndex:
type: integer
description: "Channel index used by the reverse API peer."
channelMarker:
$ref: "http://swgserver:8081/api/swagger/include/ChannelMarker.yaml#/ChannelMarker"
description: "Channel-marker display configuration."
rollupState:
$ref: "http://swgserver:8081/api/swagger/include/RollupState.yaml#/RollupState"
description: "Saved expanded or collapsed state of the GUI sections."
ambeFeatureIndex:
type: integer
description: index of AMBE controller feature to be used for AMBE frames decoding
connectAMBE:
type: integer
minimum: 0
maximum: 1
description: >
Decode frames with AMBE feature
* 0 - Do not decode frames with AMBE feature
@ -90,8 +125,10 @@ DSDDemodReport: @@ -90,8 +125,10 @@ DSDDemodReport:
format: float
audioSampleRate:
type: integer
description: "Audio sample rate in samples per second."
channelSampleRate:
type: integer
description: "Effective sample rate delivered to the channel in samples per second."
squelch:
description: squelch status (1 if open else 0)
type: integer

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

@ -3,15 +3,20 @@ DemodAnalyzerSettings: @@ -3,15 +3,20 @@ DemodAnalyzerSettings:
properties:
log2Decim:
type: integer
description: "Base-2 exponent of the software decimation factor; the output sample rate is divided by 2^log2Decim."
title:
type: string
description: "User-visible title."
rgbColor:
type: integer
description: "Display color encoded as an RGB integer."
fileRecordName:
type: string
description: Output wave file name
recordToFile:
type: integer
minimum: 0
maximum: 1
description: >
Recording status
* 1 - recording
@ -21,24 +26,35 @@ DemodAnalyzerSettings: @@ -21,24 +26,35 @@ DemodAnalyzerSettings:
description: Record silence time before stopping recording in 10ths of seconds
useReverseAPI:
type: integer
minimum: 0
maximum: 1
description: >
Synchronize with reverse API
* 1 - yes
* 0 - no
reverseAPIAddress:
type: string
description: "IPv4 address or host name of the reverse API peer."
reverseAPIPort:
type: integer
description: "TCP port of the reverse API peer."
minimum: 1
maximum: 65535
reverseAPIFeatureSetIndex:
type: integer
description: "Feature-set index used by the reverse API peer."
reverseAPIFeatureIndex:
type: integer
description: "Feature index used by the reverse API peer."
spectrumConfig:
$ref: "http://swgserver:8081/api/swagger/include/GLSpectrum.yaml#/GLSpectrum"
description: "Spectrum-display configuration."
scopeConfig:
$ref: "http://swgserver:8081/api/swagger/include/GLScope.yaml#/GLScope"
description: "Oscilloscope-display configuration."
rollupState:
$ref: "http://swgserver:8081/api/swagger/include/RollupState.yaml#/RollupState"
description: "Saved expanded or collapsed state of the GUI sections."
DemodAnalyzerActions:
description: "Demod Analyzer actions"

19
swagger/sdrangel/api/swagger/include/Denoiser.yaml

@ -3,12 +3,16 @@ DenoiserSettings: @@ -3,12 +3,16 @@ DenoiserSettings:
properties:
denoiserType:
type: integer
minimum: 0
maximum: 1
description: >
Denoiser type
* 0 - none
* 1 - RNnoise
enableDenoiser:
type: integer
minimum: 0
maximum: 1
description: >
Enable denoiser
* 1 - enable
@ -22,39 +26,54 @@ DenoiserSettings: @@ -22,39 +26,54 @@ DenoiserSettings:
description: Audio output device name
audioMute:
type: integer
minimum: 0
maximum: 1
description: >
Audio mute
* 1 - mute
* 0 - unmute
title:
type: string
description: "User-visible title."
rgbColor:
type: integer
description: "Display color encoded as an RGB integer."
fileRecordName:
type: string
description: Output wave file name
recordToFile:
type: integer
minimum: 0
maximum: 1
description: >
Recording status
* 1 - recording
* 0 - not recording
useReverseAPI:
type: integer
minimum: 0
maximum: 1
description: >
Synchronize with reverse API
* 1 - yes
* 0 - no
reverseAPIAddress:
type: string
description: "IPv4 address or host name of the reverse API peer."
reverseAPIPort:
type: integer
description: "TCP port of the reverse API peer."
minimum: 1
maximum: 65535
reverseAPIFeatureSetIndex:
type: integer
description: "Feature-set index used by the reverse API peer."
reverseAPIFeatureIndex:
type: integer
description: "Feature index used by the reverse API peer."
rollupState:
$ref: "http://swgserver:8081/api/swagger/include/RollupState.yaml#/RollupState"
description: "Saved expanded or collapsed state of the GUI sections."
DenoiserActions:
description: "Denoiser actions"

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

@ -16,3 +16,4 @@ DeviceActions: @@ -16,3 +16,4 @@ DeviceActions:
type: integer
sigMFFileInputActions:
$ref: "http://swgserver:8081/api/swagger/include/SigMFFileInput.yaml#/SigMFFileInputActions"
description: "Sig mf file input actions configuration for Device."

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

@ -13,67 +13,100 @@ DeviceReport: @@ -13,67 +13,100 @@ DeviceReport:
type: integer
airspyReport:
$ref: "http://swgserver:8081/api/swagger/include/Airspy.yaml#/AirspyReport"
description: "Airspy report data for Device."
airspyHFReport:
$ref: "http://swgserver:8081/api/swagger/include/AirspyHF.yaml#/AirspyHFReport"
description: "Airspy hf report data for Device."
androidSDRDriverInputReport:
$ref: "http://swgserver:8081/api/swagger/include/AndroidSDRDriverInput.yaml#/AndroidSDRDriverInputReport"
description: "Android sdr driver input report data for Device."
bladeRF2InputReport:
$ref: "http://swgserver:8081/api/swagger/include/BladeRF2.yaml#/BladeRF2InputReport"
description: "Blade rf2 input report data for Device."
bladeRF2OutputReport:
$ref: "http://swgserver:8081/api/swagger/include/BladeRF2.yaml#/BladeRF2OutputReport"
description: "Blade rf2 output report data for Device."
bladeRF2MIMOReport:
$ref: "http://swgserver:8081/api/swagger/include/BladeRF2.yaml#/BladeRF2MIMOReport"
description: "Blade rf2 MIMO report data for Device."
fileInputReport:
$ref: "http://swgserver:8081/api/swagger/include/FileInput.yaml#/FileInputReport"
description: "File input report data for Device."
kiwiSDRReport:
$ref: "http://swgserver:8081/api/swagger/include/KiwiSDR.yaml#/KiwiSDRReport"
description: "Kiwi sdr report data for Device."
limeSdrInputReport:
$ref: "http://swgserver:8081/api/swagger/include/LimeSdr.yaml#/LimeSdrInputReport"
description: "Lime sdr input report data for Device."
limeSdrOutputReport:
$ref: "http://swgserver:8081/api/swagger/include/LimeSdr.yaml#/LimeSdrOutputReport"
description: "Lime sdr output report data for Device."
limeSdrMIMOReport:
$ref: "http://swgserver:8081/api/swagger/include/LimeSdr.yaml#/LimeSdrMIMOReport"
description: "Lime sdr MIMO report data for Device."
localInputReport:
$ref: "http://swgserver:8081/api/swagger/include/LocalInput.yaml#/LocalInputReport"
description: "Local input report data for Device."
localOutputReport:
$ref: "http://swgserver:8081/api/swagger/include/LocalOutput.yaml#/LocalOutputReport"
description: "Local output report data for Device."
perseusReport:
$ref: "http://swgserver:8081/api/swagger/include/Perseus.yaml#/PerseusReport"
description: "Perseus report data for Device."
plutoSdrInputReport:
$ref: "http://swgserver:8081/api/swagger/include/PlutoSdr.yaml#/PlutoSdrInputReport"
description: "Pluto sdr input report data for Device."
plutoSdrOutputReport:
$ref: "http://swgserver:8081/api/swagger/include/PlutoSdr.yaml#/PlutoSdrOutputReport"
description: "Pluto sdr output report data for Device."
plutoSdrMIMOReport:
$ref: "http://swgserver:8081/api/swagger/include/PlutoSdr.yaml#/PlutoSdrMIMOReport"
description: "Pluto sdr MIMO report data for Device."
rtlSdrReport:
$ref: "http://swgserver:8081/api/swagger/include/RtlSdr.yaml#/RtlSdrReport"
description: "Rtl sdr report data for Device."
remoteOutputReport:
$ref: "http://swgserver:8081/api/swagger/include/RemoteOutput.yaml#/RemoteOutputReport"
description: "Remote output report data for Device."
remoteInputReport:
$ref: "http://swgserver:8081/api/swagger/include/RemoteInput.yaml#/RemoteInputReport"
description: "Remote input report data for Device."
remoteTCPInputReport:
$ref: "http://swgserver:8081/api/swagger/include/RemoteTCPInput.yaml#/RemoteTCPInputReport"
description: "Remote TCP input report data for Device."
sdrPlayReport:
$ref: "http://swgserver:8081/api/swagger/include/SDRPlay.yaml#/SDRPlayReport"
description: "Sdr play report data for Device."
sdrPlayV3Report:
$ref: "http://swgserver:8081/api/swagger/include/SDRPlayV3.yaml#/SDRPlayV3Report"
description: "Sdr play v3 report data for Device."
sigMFFileInputReport:
$ref: "http://swgserver:8081/api/swagger/include/SigMFFileInput.yaml#/SigMFFileInputReport"
description: "Sig mf file input report data for Device."
soapySDRInputReport:
$ref: "http://swgserver:8081/api/swagger/include/SoapySDR.yaml#/SoapySDRReport"
description: "Soapy sdr input report data for Device."
soapySDROutputReport:
$ref: "http://swgserver:8081/api/swagger/include/SoapySDR.yaml#/SoapySDRReport"
description: "Soapy sdr output report data for Device."
usrpInputReport:
$ref: "http://swgserver:8081/api/swagger/include/USRP.yaml#/USRPInputReport"
description: "Usrp input report data for Device."
usrpOutputReport:
$ref: "http://swgserver:8081/api/swagger/include/USRP.yaml#/USRPOutputReport"
description: "Usrp output report data for Device."
xtrxInputReport:
$ref: "http://swgserver:8081/api/swagger/include/Xtrx.yaml#/XtrxInputReport"
description: "Xtrx input report data for Device."
xtrxOutputReport:
$ref: "http://swgserver:8081/api/swagger/include/Xtrx.yaml#/XtrxOutputReport"
description: "Xtrx output report data for Device."
xtrxMIMOReport:
$ref: "http://swgserver:8081/api/swagger/include/Xtrx.yaml#/XtrxMIMOReport"
description: "Xtrx MIMO report data for Device."
AaroniaRTSAReport:
$ref: "http://swgserver:8081/api/swagger/include/AaroniaRTSA.yaml#/AaroniaRTSAReport"
description: "Aaronia rtsa report data for Device."
aaroniaRTSAOutputReport:
$ref: "http://swgserver:8081/api/swagger/include/AaroniaRTSA.yaml#/AaroniaRTSAOutputReport"
description: "Aaronia rtsa output report data for Device."

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

@ -16,95 +16,142 @@ DeviceSettings: @@ -16,95 +16,142 @@ DeviceSettings:
type: integer
airspySettings:
$ref: "http://swgserver:8081/api/swagger/include/Airspy.yaml#/AirspySettings"
description: "Airspy settings configuration for Device."
airspyHFSettings:
$ref: "http://swgserver:8081/api/swagger/include/AirspyHF.yaml#/AirspyHFSettings"
description: "Airspy hf settings configuration for Device."
androidSDRDriverInputSettings:
$ref: "http://swgserver:8081/api/swagger/include/AndroidSDRDriverInput.yaml#/AndroidSDRDriverInputSettings"
description: "Android sdr driver input settings configuration for Device."
audioCATSISOSettings:
$ref: "http://swgserver:8081/api/swagger/include/AudioCATSISO.yaml#/AudioCATSISOSettings"
description: "Audio catsiso settings configuration for Device."
audioInputSettings:
$ref: "http://swgserver:8081/api/swagger/include/AudioInput.yaml#/AudioInputSettings"
description: "Audio input settings configuration for Device."
audioOutputSettings:
$ref: "http://swgserver:8081/api/swagger/include/AudioOutput.yaml#/AudioOutputSettings"
description: "Audio output settings configuration for Device."
bladeRF1InputSettings:
$ref: "http://swgserver:8081/api/swagger/include/BladeRF1.yaml#/BladeRF1InputSettings"
description: "Blade rf1 input settings configuration for Device."
bladeRF2InputSettings:
$ref: "http://swgserver:8081/api/swagger/include/BladeRF2.yaml#/BladeRF2InputSettings"
description: "Blade rf2 input settings configuration for Device."
bladeRF1OutputSettings:
$ref: "http://swgserver:8081/api/swagger/include/BladeRF1.yaml#/BladeRF1OutputSettings"
description: "Blade rf1 output settings configuration for Device."
bladeRF2OutputSettings:
$ref: "http://swgserver:8081/api/swagger/include/BladeRF2.yaml#/BladeRF2OutputSettings"
description: "Blade rf2 output settings configuration for Device."
bladeRF2MIMOSettings:
$ref: "http://swgserver:8081/api/swagger/include/BladeRF2.yaml#/BladeRF2MIMOSettings"
description: "Blade rf2 MIMO settings configuration for Device."
fcdProSettings:
$ref: "http://swgserver:8081/api/swagger/include/FCDPro.yaml#/FCDProSettings"
description: "Fcd pro settings configuration for Device."
fcdProPlusSettings:
$ref: "http://swgserver:8081/api/swagger/include/FCDProPlus.yaml#/FCDProPlusSettings"
description: "Fcd pro plus settings configuration for Device."
fileInputSettings:
$ref: "http://swgserver:8081/api/swagger/include/FileInput.yaml#/FileInputSettings"
description: "File input settings configuration for Device."
fileOutputSettings:
$ref: "http://swgserver:8081/api/swagger/include/FileOutput.yaml#/FileOutputSettings"
description: "File output settings configuration for Device."
hackRFInputSettings:
$ref: "http://swgserver:8081/api/swagger/include/HackRF.yaml#/HackRFInputSettings"
description: "Hack RF input settings configuration for Device."
hackRFOutputSettings:
$ref: "http://swgserver:8081/api/swagger/include/HackRF.yaml#/HackRFOutputSettings"
description: "Hack RF output settings configuration for Device."
kiwiSDRSettings:
$ref: "http://swgserver:8081/api/swagger/include/KiwiSDR.yaml#/KiwiSDRSettings"
description: "Kiwi sdr settings configuration for Device."
limeSdrInputSettings:
$ref: "http://swgserver:8081/api/swagger/include/LimeSdr.yaml#/LimeSdrInputSettings"
description: "Lime sdr input settings configuration for Device."
limeSdrOutputSettings:
$ref: "http://swgserver:8081/api/swagger/include/LimeSdr.yaml#/LimeSdrOutputSettings"
description: "Lime sdr output settings configuration for Device."
limeSdrMIMOSettings:
$ref: "http://swgserver:8081/api/swagger/include/LimeSdr.yaml#/LimeSdrMIMOSettings"
description: "Lime sdr MIMO settings configuration for Device."
localInputSettings:
$ref: "http://swgserver:8081/api/swagger/include/LocalInput.yaml#/LocalInputSettings"
description: "Local input settings configuration for Device."
localOutputSettings:
$ref: "http://swgserver:8081/api/swagger/include/LocalOutput.yaml#/LocalOutputSettings"
description: "Local output settings configuration for Device."
metisMISOSettings:
$ref: "http://swgserver:8081/api/swagger/include/MetisMISO.yaml#/MetisMISOSettings"
description: "Metis miso settings configuration for Device."
perseusSettings:
$ref: "http://swgserver:8081/api/swagger/include/Perseus.yaml#/PerseusSettings"
description: "Perseus settings configuration for Device."
plutoSdrInputSettings:
$ref: "http://swgserver:8081/api/swagger/include/PlutoSdr.yaml#/PlutoSdrInputSettings"
description: "Pluto sdr input settings configuration for Device."
plutoSdrOutputSettings:
$ref: "http://swgserver:8081/api/swagger/include/PlutoSdr.yaml#/PlutoSdrOutputSettings"
description: "Pluto sdr output settings configuration for Device."
plutoSdrMIMOSettings:
$ref: "http://swgserver:8081/api/swagger/include/PlutoSdr.yaml#/PlutoSdrMIMOSettings"
description: "Pluto sdr MIMO settings configuration for Device."
rtlSdrSettings:
$ref: "http://swgserver:8081/api/swagger/include/RtlSdr.yaml#/RtlSdrSettings"
description: "Rtl sdr settings configuration for Device."
remoteOutputSettings:
$ref: "http://swgserver:8081/api/swagger/include/RemoteOutput.yaml#/RemoteOutputSettings"
description: "Remote output settings configuration for Device."
remoteInputSettings:
$ref: "http://swgserver:8081/api/swagger/include/RemoteInput.yaml#/RemoteInputSettings"
description: "Remote input settings configuration for Device."
remoteTCPInputSettings:
$ref: "http://swgserver:8081/api/swagger/include/RemoteTCPInput.yaml#/RemoteTCPInputSettings"
description: "Remote TCP input settings configuration for Device."
sdrPlaySettings:
$ref: "http://swgserver:8081/api/swagger/include/SDRPlay.yaml#/SDRPlaySettings"
description: "Sdr play settings configuration for Device."
sdrPlayV3Settings:
$ref: "http://swgserver:8081/api/swagger/include/SDRPlayV3.yaml#/SDRPlayV3Settings"
description: "Sdr play v3 settings configuration for Device."
sigMFFileInputSettings:
$ref: "http://swgserver:8081/api/swagger/include/SigMFFileInput.yaml#/SigMFFileInputSettings"
description: "Sig mf file input settings configuration for Device."
soapySDRInputSettings:
$ref: "http://swgserver:8081/api/swagger/include/SoapySDR.yaml#/SoapySDRInputSettings"
description: "Soapy sdr input settings configuration for Device."
soapySDROutputSettings:
$ref: "http://swgserver:8081/api/swagger/include/SoapySDR.yaml#/SoapySDROutputSettings"
description: "Soapy sdr output settings configuration for Device."
testMISettings:
$ref: "http://swgserver:8081/api/swagger/include/TestMI.yaml#/TestMISettings"
description: "Test mi settings configuration for Device."
testMOSyncSettings:
$ref: "http://swgserver:8081/api/swagger/include/TestMOSync.yaml#/TestMOSyncSettings"
description: "Test mo sync settings configuration for Device."
testSourceSettings:
$ref: "http://swgserver:8081/api/swagger/include/TestSource.yaml#/TestSourceSettings"
description: "Test source settings configuration for Device."
usrpInputSettings:
$ref: "http://swgserver:8081/api/swagger/include/USRP.yaml#/USRPInputSettings"
description: "Usrp input settings configuration for Device."
usrpOutputSettings:
$ref: "http://swgserver:8081/api/swagger/include/USRP.yaml#/USRPOutputSettings"
description: "Usrp output settings configuration for Device."
xtrxInputSettings:
$ref: "http://swgserver:8081/api/swagger/include/Xtrx.yaml#/XtrxInputSettings"
description: "Xtrx input settings configuration for Device."
xtrxOutputSettings:
$ref: "http://swgserver:8081/api/swagger/include/Xtrx.yaml#/XtrxOutputSettings"
description: "Xtrx output settings configuration for Device."
xtrxMIMOSettings:
$ref: "http://swgserver:8081/api/swagger/include/Xtrx.yaml#/XtrxMIMOSettings"
description: "Xtrx MIMO settings configuration for Device."
aaroniaRTSASettings:
$ref: "http://swgserver:8081/api/swagger/include/AaroniaRTSA.yaml#/AaroniaRTSASettings"
description: "Aaronia rtsa settings configuration for Device."
aaroniaRTSAOutputSettings:
$ref: "http://swgserver:8081/api/swagger/include/AaroniaRTSA.yaml#/AaroniaRTSAOutputSettings"
description: "Aaronia rtsa output settings configuration for Device."

27
swagger/sdrangel/api/swagger/include/EndOfTrainDemod.yaml

@ -4,49 +4,75 @@ EndOfTrainDemodSettings: @@ -4,49 +4,75 @@ EndOfTrainDemodSettings:
inputFrequencyOffset:
type: integer
format: int64
description: "Channel frequency offset from the device center frequency in Hz."
rfBandwidth:
type: number
format: float
description: "RF bandwidth in Hz."
fmDeviation:
type: number
format: float
description: "FM frequency deviation in Hz."
udpEnabled:
description: "Whether to forward received packets to specified UDP port"
type: integer
minimum: 0
maximum: 1
udpAddress:
description: "UDP address to forward received packets to"
type: string
udpPort:
description: "UDP port to forward received packets to"
type: integer
minimum: 1
maximum: 65535
logFilename:
type: string
description: "Log file name or path."
logEnabled:
type: integer
description: "Enable logging to the configured file (1 enabled, 0 disabled)."
minimum: 0
maximum: 1
useFileTime:
type: integer
description: "Enable file time (1 enabled, 0 disabled)."
minimum: 0
maximum: 1
rgbColor:
type: integer
description: "Display color encoded as an RGB integer."
title:
type: string
description: "User-visible title."
streamIndex:
description: MIMO channel. Not relevant when connected to SI (single Rx).
type: integer
useReverseAPI:
description: Synchronize with reverse API (1 for yes, 0 for no)
type: integer
minimum: 0
maximum: 1
reverseAPIAddress:
type: string
description: "IPv4 address or host name of the reverse API peer."
reverseAPIPort:
type: integer
description: "TCP port of the reverse API peer."
minimum: 1
maximum: 65535
reverseAPIDeviceIndex:
type: integer
description: "Device-set index used by the reverse API peer."
reverseAPIChannelIndex:
type: integer
description: "Channel index used by the reverse API peer."
channelMarker:
$ref: "http://swgserver:8081/api/swagger/include/ChannelMarker.yaml#/ChannelMarker"
description: "Channel-marker display configuration."
rollupState:
$ref: "http://swgserver:8081/api/swagger/include/RollupState.yaml#/RollupState"
description: "Saved expanded or collapsed state of the GUI sections."
EndOfTrainDemodReport:
description: EndOfTrainDemod
@ -57,3 +83,4 @@ EndOfTrainDemodReport: @@ -57,3 +83,4 @@ EndOfTrainDemodReport:
format: float
channelSampleRate:
type: integer
description: "Effective sample rate delivered to the channel in samples per second."

40
swagger/sdrangel/api/swagger/include/FCDPro.yaml

@ -3,58 +3,91 @@ FCDProSettings: @@ -3,58 +3,91 @@ FCDProSettings:
properties:
title:
type: string
description: "User-visible title."
centerFrequency:
type: integer
format: int64
description: "Device center frequency in Hz."
LOppmTenths:
type: integer
description: "Local-oscillator correction in tenths of a part per million."
lnaGainIndex:
type: integer
description: "Selected lna gain index."
rfFilterIndex:
type: integer
description: "Selected rf filter index."
lnaEnhanceIndex:
type: integer
description: "Selected lna enhance index."
bandIndex:
type: integer
description: "Selected band index."
mixerGainIndex:
type: integer
description: "Selected mixer gain index."
mixerFilterIndex:
type: integer
description: "Selected mixer filter index."
biasCurrentIndex:
type: integer
description: "Selected bias current index."
modeIndex:
type: integer
description: "Selected mode index."
gain1Index:
type: integer
description: "Selected gain1 index."
rcFilterIndex:
type: integer
description: "Selected rc filter index."
gain2Index:
type: integer
description: "Selected gain2 index."
gain3Index:
type: integer
description: "Selected gain3 index."
gain4Index:
type: integer
description: "Selected gain4 index."
ifFilterIndex:
type: integer
description: "Selected if filter index."
gain5Index:
type: integer
description: "Selected gain5 index."
gain6Index:
type: integer
description: "Selected gain6 index."
log2Decim:
type: integer
description: "Base-2 exponent of the software decimation factor; the output sample rate is divided by 2^log2Decim."
fcPos:
type: integer
description: "Position of the decimated passband relative to the device center frequency."
dcBlock:
type: integer
description: "Enable DSP DC-offset correction (1 enabled, 0 disabled)."
minimum: 0
maximum: 1
iqCorrection:
type: integer
description: "Enable I/Q imbalance correction (1 enabled, 0 disabled)."
minimum: 0
maximum: 1
transverterMode:
type: integer
description: "Enable transverter frequency translation (1 enabled, 0 disabled)."
minimum: 0
maximum: 1
transverterDeltaFrequency:
type: integer
format: int64
description: "Frequency translation applied in transverter mode in Hz."
iqOrder:
type: integer
minimum: 0
maximum: 1
description: >
IQ samples order
* 0 - Q then I (swapped)
@ -62,9 +95,16 @@ FCDProSettings: @@ -62,9 +95,16 @@ FCDProSettings:
useReverseAPI:
description: Synchronize with reverse API (1 for yes, 0 for no)
type: integer
minimum: 0
maximum: 1
reverseAPIAddress:
type: string
description: "IPv4 address or host name of the reverse API peer."
reverseAPIPort:
type: integer
description: "TCP port of the reverse API peer."
minimum: 1
maximum: 65535
reverseAPIDeviceIndex:
type: integer
description: "Device-set index used by the reverse API peer."

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

@ -3,13 +3,17 @@ FCDProPlusSettings: @@ -3,13 +3,17 @@ FCDProPlusSettings:
properties:
title:
type: string
description: "User-visible title."
centerFrequency:
type: integer
format: int64
description: "Device center frequency in Hz."
log2Decim:
type: integer
description: "Base-2 exponent of the software decimation factor; the output sample rate is divided by 2^log2Decim."
fcPos:
type: integer
description: "Position of the decimated passband relative to the device center frequency."
rangeLow:
description: Range select (1 if low else 0)
type: integer
@ -22,25 +26,43 @@ FCDProPlusSettings: @@ -22,25 +26,43 @@ FCDProPlusSettings:
biasT:
description: Bias tee select (1 if selected else 0)
type: integer
minimum: 0
maximum: 1
ifGain:
type: integer
description: "Intermediate-frequency gain setting."
ifFilterIndex:
type: integer
description: "Selected if filter index."
rfFilterIndex:
type: integer
description: "Selected rf filter index."
LOppmTenths:
type: integer
description: "Local-oscillator correction in tenths of a part per million."
dcBlock:
type: integer
description: "Enable DSP DC-offset correction (1 enabled, 0 disabled)."
minimum: 0
maximum: 1
iqImbalance:
type: integer
description: "Enable DSP I/Q imbalance correction (1 enabled, 0 disabled)."
minimum: 0
maximum: 1
transverterMode:
type: integer
description: "Enable transverter frequency translation (1 enabled, 0 disabled)."
minimum: 0
maximum: 1
transverterDeltaFrequency:
type: integer
format: int64
description: "Frequency translation applied in transverter mode in Hz."
iqOrder:
type: integer
minimum: 0
maximum: 1
description: >
IQ samples order
* 0 - Q then I (swapped)
@ -48,9 +70,16 @@ FCDProPlusSettings: @@ -48,9 +70,16 @@ FCDProPlusSettings:
useReverseAPI:
description: Synchronize with reverse API (1 for yes, 0 for no)
type: integer
minimum: 0
maximum: 1
reverseAPIAddress:
type: string
description: "IPv4 address or host name of the reverse API peer."
reverseAPIPort:
type: integer
description: "TCP port of the reverse API peer."
minimum: 1
maximum: 65535
reverseAPIDeviceIndex:
type: integer
description: "Device-set index used by the reverse API peer."

37
swagger/sdrangel/api/swagger/include/FT8Demod.yaml

@ -4,18 +4,25 @@ FT8DemodSettings: @@ -4,18 +4,25 @@ FT8DemodSettings:
inputFrequencyOffset:
type: integer
format: int64
description: "Channel frequency offset from the device center frequency in Hz."
filterIndex:
type: integer
description: "Selected filter index."
spanLog2:
type: integer
description: "Base-2 exponent controlling the displayed or processed frequency span."
rfBandwidth:
type: number
format: float
description: "RF bandwidth in Hz."
lowCutoff:
type: number
format: float
description: "Lower filter cutoff frequency in Hz."
fftWindow:
type: integer
minimum: 0
maximum: 8
description: >
FFT Window index (FFTWindow::Function):
* 0 - Bartlett
@ -30,17 +37,24 @@ FT8DemodSettings: @@ -30,17 +37,24 @@ FT8DemodSettings:
volume:
type: number
format: float
description: "Audio volume multiplier."
agc:
description: AGC (1 if AGC active else 0)
type: integer
minimum: 0
maximum: 1
recordWav:
type: integer
minimum: 0
maximum: 1
description: >
Record received audio as 12000S/s 16 bit .wav file
* 0 - Do not record
* 1 - Record as sdrangel/ft8/save/YYYYMMDD_HHMMSS.wav in writable location
logMessages:
type: integer
minimum: 0
maximum: 1
description: >
Log decoded messages in WSJT CALL.TXT format
* 0 - Do not log messages
@ -54,6 +68,8 @@ FT8DemodSettings: @@ -54,6 +68,8 @@ FT8DemodSettings:
description: Decoder time budget in seconds (will stop after running this time)
useOSD:
type: integer
minimum: 0
maximum: 1
description: >
Use Ordered Statistics Decoding (OSD) to decode messages if some LDPC bits are invalid
* 0 - Disable
@ -66,46 +82,66 @@ FT8DemodSettings: @@ -66,46 +82,66 @@ FT8DemodSettings:
description: minimum of valid LDPC bits (out of 83) necessary to activate OSD
verifyOSD:
type: integer
minimum: 0
maximum: 1
description: >
Verify OSD decoded message against a list of validated callsigns
* 0 - Disable
* 1 - Enable
enablePSKReporter:
type: integer
minimum: 0
maximum: 1
description: >
Enable reporting of decoded messages to PSK Reporter server
* 0 - Disable
* 1 - Enable
pskReporterCallsign:
type: string
description: "Psk reporter callsign setting for Ft8 demod."
pskReporterLocator:
type: string
description: "Psk reporter locator setting for Ft8 demod."
pskReporterSoftware:
type: string
description: "Psk reporter software setting for Ft8 demod."
rgbColor:
type: integer
description: "Display color encoded as an RGB integer."
title:
type: string
description: "User-visible title."
streamIndex:
description: MIMO channel. Not relevant when connected to SI (single Rx).
type: integer
useReverseAPI:
description: Synchronize with reverse API (1 for yes, 0 for no)
type: integer
minimum: 0
maximum: 1
reverseAPIAddress:
type: string
description: "IPv4 address or host name of the reverse API peer."
reverseAPIPort:
type: integer
description: "TCP port of the reverse API peer."
minimum: 1
maximum: 65535
reverseAPIDeviceIndex:
type: integer
description: "Device-set index used by the reverse API peer."
reverseAPIChannelIndex:
type: integer
description: "Channel index used by the reverse API peer."
spectrumConfig:
$ref: "http://swgserver:8081/api/swagger/include/GLSpectrum.yaml#/GLSpectrum"
description: "Spectrum-display configuration."
channelMarker:
$ref: "http://swgserver:8081/api/swagger/include/ChannelMarker.yaml#/ChannelMarker"
description: "Channel-marker display configuration."
rollupState:
$ref: "http://swgserver:8081/api/swagger/include/RollupState.yaml#/RollupState"
description: "Saved expanded or collapsed state of the GUI sections."
FT8DemodReport:
description: FT8Demod
@ -119,3 +155,4 @@ FT8DemodReport: @@ -119,3 +155,4 @@ FT8DemodReport:
type: integer
channelSampleRate:
type: integer
description: "Effective sample rate delivered to the channel in samples per second."

18
swagger/sdrangel/api/swagger/include/FeatureActions.yaml

@ -15,31 +15,49 @@ FeatureActions: @@ -15,31 +15,49 @@ FeatureActions:
type: integer
AFCActions:
$ref: "http://swgserver:8081/api/swagger/include/AFC.yaml#/AFCActions"
description: "Afc actions configuration for Feature."
AMBEActions:
$ref: "http://swgserver:8081/api/swagger/include/AMBE.yaml#/AMBEActions"
description: "Ambe actions configuration for Feature."
GS232ControllerActions:
$ref: "http://swgserver:8081/api/swagger/include/GS232Controller.yaml#/GS232ControllerActions"
description: "Gs232 controller actions configuration for Feature."
LimeRFEActions:
$ref: "http://swgserver:8081/api/swagger/include/LimeRFE.yaml#/LimeRFEActions"
description: "Lime rfe actions configuration for Feature."
MapActions:
$ref: "http://swgserver:8081/api/swagger/include/Map.yaml#/MapActions"
description: "Map actions configuration for Feature."
MorseDecoderActions:
$ref: "http://swgserver:8081/api/swagger/include/MorseDecoder.yaml#/MorseDecoderActions"
description: "Morse decoder actions configuration for Feature."
PERTesterActions:
$ref: "http://swgserver:8081/api/swagger/include/PERTester.yaml#/PERTesterActions"
description: "Per tester actions configuration for Feature."
RigCtlServerActions:
$ref: "http://swgserver:8081/api/swagger/include/RigCtlServer.yaml#/RigCtlServerActions"
description: "Rig ctl server actions configuration for Feature."
MCPServerActions:
$ref: "http://swgserver:8081/api/swagger/include/MCPServer.yaml#/MCPServerActions"
description: "Mcp server actions configuration for Feature."
SatelliteTrackerActions:
$ref: "http://swgserver:8081/api/swagger/include/SatelliteTracker.yaml#/SatelliteTrackerActions"
description: "Satellite tracker actions configuration for Feature."
SimplePTTActions:
$ref: "http://swgserver:8081/api/swagger/include/SimplePTT.yaml#/SimplePTTActions"
description: "Simple ptt actions configuration for Feature."
SkyMapActions:
$ref: "http://swgserver:8081/api/swagger/include/SkyMap.yaml#/SkyMapActions"
description: "Sky map actions configuration for Feature."
StarTrackerActions:
$ref: "http://swgserver:8081/api/swagger/include/StarTracker.yaml#/StarTrackerActions"
description: "Star tracker actions configuration for Feature."
VORLocalizerActions:
$ref: "http://swgserver:8081/api/swagger/include/VORLocalizer.yaml#/VORLocalizerActions"
description: "Vor localizer actions configuration for Feature."
DemodAnalyzerActions:
$ref: "http://swgserver:8081/api/swagger/include/DemodAnalyzer.yaml#/DemodAnalyzerActions"
description: "Demod analyzer actions configuration for Feature."
DenoiserActions:
$ref: "http://swgserver:8081/api/swagger/include/Denoiser.yaml#/DenoiserActions"
description: "Denoiser actions configuration for Feature."

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

@ -9,27 +9,43 @@ FeatureReport: @@ -9,27 +9,43 @@ FeatureReport:
type: string
AFCReport:
$ref: "http://swgserver:8081/api/swagger/include/AFC.yaml#/AFCReport"
description: "Afc report data for Feature."
AMBEReport:
$ref: "http://swgserver:8081/api/swagger/include/AMBE.yaml#/AMBEReport"
description: "Ambe report data for Feature."
FreqDisplayReport:
$ref: "http://swgserver:8081/api/swagger/include/FreqDisplay.yaml#/FreqDisplayReport"
description: "Freq display report data for Feature."
GS232ControllerReport:
$ref: "http://swgserver:8081/api/swagger/include/GS232Controller.yaml#/GS232ControllerReport"
description: "Gs232 controller report data for Feature."
LimeRFEReport:
$ref: "http://swgserver:8081/api/swagger/include/LimeRFE.yaml#/LimeRFEReport"
description: "Lime rfe report data for Feature."
MapReport:
$ref: "http://swgserver:8081/api/swagger/include/Map.yaml#/MapReport"
description: "Map report data for Feature."
PERTesterReport:
$ref: "http://swgserver:8081/api/swagger/include/PERTester.yaml#/PERTesterReport"
description: "Per tester report data for Feature."
RigCtlServerReport:
$ref: "http://swgserver:8081/api/swagger/include/RigCtlServer.yaml#/RigCtlServerReport"
description: "Rig ctl server report data for Feature."
MCPServerReport:
$ref: "http://swgserver:8081/api/swagger/include/MCPServer.yaml#/MCPServerReport"
description: "Mcp server report data for Feature."
SatelliteTrackerReport:
$ref: "http://swgserver:8081/api/swagger/include/SatelliteTracker.yaml#/SatelliteTrackerReport"
description: "Satellite tracker report data for Feature."
SimplePTTReport:
$ref: "http://swgserver:8081/api/swagger/include/SimplePTT.yaml#/SimplePTTReport"
description: "Simple ptt report data for Feature."
SkyMapReport:
$ref: "http://swgserver:8081/api/swagger/include/SkyMap.yaml#/SkyMapReport"
description: "Sky map report data for Feature."
StarTrackerReport:
$ref: "http://swgserver:8081/api/swagger/include/StarTracker.yaml#/StarTrackerReport"
description: "Star tracker report data for Feature."
VORLocalizerReport:
$ref: "http://swgserver:8081/api/swagger/include/VORLocalizer.yaml#/VORLocalizerReport"
description: "Vor localizer report data for Feature."

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

@ -6,15 +6,19 @@ FeatureConfig: @@ -6,15 +6,19 @@ FeatureConfig:
type: string
config:
$ref: "http://swgserver:8081/api/swagger/include/FeatureSettings.yaml#/FeatureSettings"
description: "Configuration data."
FeatureSetPreset:
description: Represents a Feature Set Preset object
properties:
group:
type: string
description: "Group for Feature set preset."
description:
type: string
description: "Human-readable description."
featureConfigs:
type: array
description: "List of feature configs."
items:
$ref: "http://swgserver:8081/api/swagger/include/FeatureSetPreset.yaml#/FeatureConfig"

25
swagger/sdrangel/api/swagger/include/FeatureSettings.yaml

@ -15,45 +15,70 @@ FeatureSettings: @@ -15,45 +15,70 @@ FeatureSettings:
type: integer
AFCSettings:
$ref: "http://swgserver:8081/api/swagger/include/AFC.yaml#/AFCSettings"
description: "Afc settings configuration for Feature."
AISSettings:
$ref: "http://swgserver:8081/api/swagger/include/AIS.yaml#/AISSettings"
description: "AIS settings configuration for Feature."
AMBESettings:
$ref: "http://swgserver:8081/api/swagger/include/AMBE.yaml#/AMBESettings"
description: "Ambe settings configuration for Feature."
AntennaToolsSettings:
$ref: "http://swgserver:8081/api/swagger/include/AntennaTools.yaml#/AntennaToolsSettings"
description: "Antenna tools settings configuration for Feature."
APRSSettings:
$ref: "http://swgserver:8081/api/swagger/include/APRS.yaml#/APRSSettings"
description: "Aprs settings configuration for Feature."
DemodAnalyzerSettings:
$ref: "http://swgserver:8081/api/swagger/include/DemodAnalyzer.yaml#/DemodAnalyzerSettings"
description: "Demod analyzer settings configuration for Feature."
DenoiserSettings:
$ref: "http://swgserver:8081/api/swagger/include/Denoiser.yaml#/DenoiserSettings"
description: "Denoiser settings configuration for Feature."
JogdialControllerSettings:
$ref: "http://swgserver:8081/api/swagger/include/JogdialController.yaml#/JogdialControllerSettings"
description: "Jogdial controller settings configuration for Feature."
FreqDisplaySettings:
$ref: "http://swgserver:8081/api/swagger/include/FreqDisplay.yaml#/FreqDisplaySettings"
description: "Freq display settings configuration for Feature."
GS232ControllerSettings:
$ref: "http://swgserver:8081/api/swagger/include/GS232Controller.yaml#/GS232ControllerSettings"
description: "Gs232 controller settings configuration for Feature."
LimeRFESettings:
$ref: "http://swgserver:8081/api/swagger/include/LimeRFE.yaml#/LimeRFESettings"
description: "Lime rfe settings configuration for Feature."
MapSettings:
$ref: "http://swgserver:8081/api/swagger/include/Map.yaml#/MapSettings"
description: "Map settings configuration for Feature."
MorseDecoderSettings:
$ref: "http://swgserver:8081/api/swagger/include/MorseDecoder.yaml#/MorseDecoderSettings"
description: "Morse decoder settings configuration for Feature."
PERTesterSettings:
$ref: "http://swgserver:8081/api/swagger/include/PERTester.yaml#/PERTesterSettings"
description: "Per tester settings configuration for Feature."
RadiosondeSettings:
$ref: "http://swgserver:8081/api/swagger/include/Radiosonde.yaml#/RadiosondeSettings"
description: "Radiosonde settings configuration for Feature."
RigCtlServerSettings:
$ref: "http://swgserver:8081/api/swagger/include/RigCtlServer.yaml#/RigCtlServerSettings"
description: "Rig ctl server settings configuration for Feature."
MCPServerSettings:
$ref: "http://swgserver:8081/api/swagger/include/MCPServer.yaml#/MCPServerSettings"
description: "Mcp server settings configuration for Feature."
SatelliteTrackerSettings:
$ref: "http://swgserver:8081/api/swagger/include/SatelliteTracker.yaml#/SatelliteTrackerSettings"
description: "Satellite tracker settings configuration for Feature."
SIDSettings:
$ref: "http://swgserver:8081/api/swagger/include/SID.yaml#/SIDSettings"
description: "Sid settings configuration for Feature."
SimplePTTSettings:
$ref: "http://swgserver:8081/api/swagger/include/SimplePTT.yaml#/SimplePTTSettings"
description: "Simple ptt settings configuration for Feature."
SkyMapSettings:
$ref: "http://swgserver:8081/api/swagger/include/SkyMap.yaml#/SkyMapSettings"
description: "Sky map settings configuration for Feature."
StarTrackerSettings:
$ref: "http://swgserver:8081/api/swagger/include/StarTracker.yaml#/StarTrackerSettings"
description: "Star tracker settings configuration for Feature."
VORLocalizerSettings:
$ref: "http://swgserver:8081/api/swagger/include/VORLocalizer.yaml#/VORLocalizerSettings"
description: "Vor localizer settings configuration for Feature."

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

@ -3,6 +3,7 @@ FileInputSettings: @@ -3,6 +3,7 @@ FileInputSettings:
properties:
title:
type: string
description: "User-visible title."
fileName:
description: The name (path) of the file being read
type: string
@ -15,18 +16,26 @@ FileInputSettings: @@ -15,18 +16,26 @@ FileInputSettings:
useReverseAPI:
description: Synchronize with reverse API (1 for yes, 0 for no)
type: integer
minimum: 0
maximum: 1
reverseAPIAddress:
type: string
description: "IPv4 address or host name of the reverse API peer."
reverseAPIPort:
type: integer
description: "TCP port of the reverse API peer."
minimum: 1
maximum: 65535
reverseAPIDeviceIndex:
type: integer
description: "Device-set index used by the reverse API peer."
FileInputReport:
description: FileInput
properties:
fileName:
type: string
description: "File name or path."
sampleRate:
description: Record sample rate in S/s
type: integer

11
swagger/sdrangel/api/swagger/include/FileOutput.yaml

@ -3,23 +3,34 @@ FileOutputSettings: @@ -3,23 +3,34 @@ FileOutputSettings:
properties:
title:
type: string
description: "User-visible title."
fileName:
description: The name (path) of the file being read
type: string
centerFrequency:
type: integer
format: int64
description: "Device center frequency in Hz."
sampleRate:
type: integer
format: int64
description: "Sample rate in samples per second."
log2Interp:
type: integer
description: "Base-2 exponent of the software interpolation factor; the output sample rate is multiplied by 2^log2Interp."
useReverseAPI:
description: Synchronize with reverse API (1 for yes, 0 for no)
type: integer
minimum: 0
maximum: 1
reverseAPIAddress:
type: string
description: "IPv4 address or host name of the reverse API peer."
reverseAPIPort:
type: integer
description: "TCP port of the reverse API peer."
minimum: 1
maximum: 65535
reverseAPIDeviceIndex:
type: integer
description: "Device-set index used by the reverse API peer."

27
swagger/sdrangel/api/swagger/include/FileSink.yaml

@ -3,17 +3,23 @@ FileSinkSettings: @@ -3,17 +3,23 @@ FileSinkSettings:
properties:
inputFrequencyOffset:
type: integer
description: "Channel frequency offset from the device center frequency in Hz."
fileRecordName:
type: string
description: full path of the reference file
rgbColor:
type: integer
description: "Display color encoded as an RGB integer."
title:
type: string
description: "User-visible title."
log2Decim:
type: integer
description: "Base-2 exponent of the software decimation factor; the output sample rate is divided by 2^log2Decim."
spectrumSquelchMode:
type: integer
minimum: 0
maximum: 1
description: >
Spectrum squelch system
* 0 - deactivated
@ -30,6 +36,8 @@ FileSinkSettings: @@ -30,6 +36,8 @@ FileSinkSettings:
description: Number of seconds to record after spectrum squelch closes
squelchRecordingEnable:
type: integer
minimum: 0
maximum: 1
description: >
Automatic recording triggered by spectrum squelch
* 0 - disabled
@ -40,26 +48,39 @@ FileSinkSettings: @@ -40,26 +48,39 @@ FileSinkSettings:
useReverseAPI:
description: Synchronize with reverse API (1 for yes, 0 for no)
type: integer
minimum: 0
maximum: 1
reverseAPIAddress:
type: string
description: "IPv4 address or host name of the reverse API peer."
reverseAPIPort:
type: integer
description: "TCP port of the reverse API peer."
minimum: 1
maximum: 65535
reverseAPIDeviceIndex:
type: integer
description: "Device-set index used by the reverse API peer."
reverseAPIChannelIndex:
type: integer
description: "Channel index used by the reverse API peer."
spectrumConfig:
$ref: "http://swgserver:8081/api/swagger/include/GLSpectrum.yaml#/GLSpectrum"
description: "Spectrum-display configuration."
channelMarker:
$ref: "http://swgserver:8081/api/swagger/include/ChannelMarker.yaml#/ChannelMarker"
description: "Channel-marker display configuration."
rollupState:
$ref: "http://swgserver:8081/api/swagger/include/RollupState.yaml#/RollupState"
description: "Saved expanded or collapsed state of the GUI sections."
FileSinkReport:
description: FileSink
properties:
spectrumSquelch:
type: integer
minimum: 0
maximum: 1
description: >
Spectrum squelch status
* 0 - closed
@ -70,10 +91,14 @@ FileSinkReport: @@ -70,10 +91,14 @@ FileSinkReport:
description: Current spectrum max in squared magnitude (power)
sinkSampleRate:
type: integer
description: "Sample rate accepted by the sink in samples per second."
channelSampleRate:
type: integer
description: "Effective sample rate delivered to the channel in samples per second."
recording:
type: integer
minimum: 0
maximum: 1
description: >
Recording status
* 0 - not recording
@ -94,6 +119,8 @@ FileSinkActions: @@ -94,6 +119,8 @@ FileSinkActions:
properties:
record:
type: integer
minimum: 0
maximum: 1
description: >
Record action
* 0 - stop recording

18
swagger/sdrangel/api/swagger/include/FileSource.yaml

@ -9,38 +9,54 @@ FileSourceSettings: @@ -9,38 +9,54 @@ FileSourceSettings:
type: integer
log2Interp:
type: integer
description: "Base-2 exponent of the software interpolation factor; the output sample rate is multiplied by 2^log2Interp."
filterChainHash:
type: integer
description: "Identifier of the selected half-band filter chain."
gainDB:
type: integer
description: "Gain dB in dB."
rgbColor:
type: integer
description: "Display color encoded as an RGB integer."
title:
type: string
description: "User-visible title."
streamIndex:
description: MIMO channel. Not relevant when connected to SI (single Rx).
type: integer
useReverseAPI:
description: Synchronize with reverse API (1 for yes, 0 for no)
type: integer
minimum: 0
maximum: 1
reverseAPIAddress:
type: string
description: "IPv4 address or host name of the reverse API peer."
reverseAPIPort:
type: integer
description: "TCP port of the reverse API peer."
minimum: 1
maximum: 65535
reverseAPIDeviceIndex:
type: integer
description: "Device-set index used by the reverse API peer."
reverseAPIChannelIndex:
type: integer
description: "Channel index used by the reverse API peer."
channelMarker:
$ref: "http://swgserver:8081/api/swagger/include/ChannelMarker.yaml#/ChannelMarker"
description: "Channel-marker display configuration."
rollupState:
$ref: "http://swgserver:8081/api/swagger/include/RollupState.yaml#/RollupState"
description: "Saved expanded or collapsed state of the GUI sections."
FileSourceReport:
description: FileSource
properties:
fileName:
type: string
description: "File name or path."
fileSampleRate:
description: Record sample rate in S/s
type: integer
@ -69,6 +85,8 @@ FileSourceActions: @@ -69,6 +85,8 @@ FileSourceActions:
properties:
play:
type: integer
minimum: 0
maximum: 1
description: >
Play or Pause stream
* 0 - Pause

23
swagger/sdrangel/api/swagger/include/FreeDVDemod.yaml

@ -4,6 +4,7 @@ FreeDVDemodSettings: @@ -4,6 +4,7 @@ FreeDVDemodSettings:
inputFrequencyOffset:
type: integer
format: int64
description: "Channel frequency offset from the device center frequency in Hz."
volume:
description: Audio volume
type: number
@ -14,40 +15,60 @@ FreeDVDemodSettings: @@ -14,40 +15,60 @@ FreeDVDemodSettings:
format: float
spanLog2:
type: integer
description: "Base-2 exponent controlling the displayed or processed frequency span."
audioMute:
description: Mute audio (1 if muted else 0)
type: integer
minimum: 0
maximum: 1
agc:
description: AGC (1 if AGC active else 0)
type: integer
minimum: 0
maximum: 1
rgbColor:
type: integer
description: "Display color encoded as an RGB integer."
title:
type: string
description: "User-visible title."
audioDeviceName:
type: string
description: "Name of the audio device to use."
freeDVMode:
type: integer
description: "Free dv mode setting for Free dv demod."
streamIndex:
description: MIMO channel. Not relevant when connected to SI (single Rx).
type: integer
useReverseAPI:
description: Synchronize with reverse API (1 for yes, 0 for no)
type: integer
minimum: 0
maximum: 1
reverseAPIAddress:
type: string
description: "IPv4 address or host name of the reverse API peer."
reverseAPIPort:
type: integer
description: "TCP port of the reverse API peer."
minimum: 1
maximum: 65535
reverseAPIDeviceIndex:
type: integer
description: "Device-set index used by the reverse API peer."
reverseAPIChannelIndex:
type: integer
description: "Channel index used by the reverse API peer."
spectrumConfig:
$ref: "http://swgserver:8081/api/swagger/include/GLSpectrum.yaml#/GLSpectrum"
description: "Spectrum-display configuration."
channelMarker:
$ref: "http://swgserver:8081/api/swagger/include/ChannelMarker.yaml#/ChannelMarker"
description: "Channel-marker display configuration."
rollupState:
$ref: "http://swgserver:8081/api/swagger/include/RollupState.yaml#/RollupState"
description: "Saved expanded or collapsed state of the GUI sections."
FreeDVDemodReport:
description: FreeDVDemod
@ -61,5 +82,7 @@ FreeDVDemodReport: @@ -61,5 +82,7 @@ FreeDVDemodReport:
type: integer
audioSampleRate:
type: integer
description: "Audio sample rate in samples per second."
channelSampleRate:
type: integer
description: "Effective sample rate delivered to the channel in samples per second."

30
swagger/sdrangel/api/swagger/include/FreeDVMod.yaml

@ -4,52 +4,80 @@ FreeDVModSettings: @@ -4,52 +4,80 @@ FreeDVModSettings:
inputFrequencyOffset:
type: integer
format: int64
description: "Channel frequency offset from the device center frequency in Hz."
toneFrequency:
type: number
format: float
description: "Tone frequency in Hz."
volumeFactor:
type: number
format: float
description: "Volume factor setting for Free dv mod."
spanLog2:
type: integer
description: "Base-2 exponent controlling the displayed or processed frequency span."
audioMute:
type: integer
description: "Mute audio output (1 muted, 0 unmuted)."
minimum: 0
maximum: 1
playLoop:
type: integer
description: "Loop playback at end of file (1 enabled, 0 disabled)."
minimum: 0
maximum: 1
rgbColor:
type: integer
description: "Display color encoded as an RGB integer."
title:
type: string
description: "User-visible title."
audioDeviceName:
type: string
description: "Name of the audio device to use."
freeDVMode:
type: integer
description: "Free dv mode setting for Free dv mod."
modAFInput:
type: integer
description: "Audio-frequency modulation input selection."
gaugeInputElseModem:
type: integer
description: "Gauge input else modem setting for Free dv mod."
streamIndex:
description: MIMO channel. Not relevant when connected to SI (single Rx).
type: integer
useReverseAPI:
description: Synchronize with reverse API (1 for yes, 0 for no)
type: integer
minimum: 0
maximum: 1
reverseAPIAddress:
type: string
description: "IPv4 address or host name of the reverse API peer."
reverseAPIPort:
type: integer
description: "TCP port of the reverse API peer."
minimum: 1
maximum: 65535
reverseAPIDeviceIndex:
type: integer
description: "Device-set index used by the reverse API peer."
reverseAPIChannelIndex:
type: integer
description: "Channel index used by the reverse API peer."
cwKeyer:
$ref: "http://swgserver:8081/api/swagger/include/CWKeyer.yaml#/CWKeyerSettings"
description: "CW keyer configuration."
spectrumConfig:
$ref: "http://swgserver:8081/api/swagger/include/GLSpectrum.yaml#/GLSpectrum"
description: "Spectrum-display configuration."
channelMarker:
$ref: "http://swgserver:8081/api/swagger/include/ChannelMarker.yaml#/ChannelMarker"
description: "Channel-marker display configuration."
rollupState:
$ref: "http://swgserver:8081/api/swagger/include/RollupState.yaml#/RollupState"
description: "Saved expanded or collapsed state of the GUI sections."
FreeDVModReport:
description: FreeDVMod
@ -60,5 +88,7 @@ FreeDVModReport: @@ -60,5 +88,7 @@ FreeDVModReport:
format: float
audioSampleRate:
type: integer
description: "Audio sample rate in samples per second."
channelSampleRate:
type: integer
description: "Effective sample rate delivered to the channel in samples per second."

24
swagger/sdrangel/api/swagger/include/FreqDisplay.yaml

@ -6,45 +6,69 @@ FreqDisplaySettings: @@ -6,45 +6,69 @@ FreqDisplaySettings:
type: string
fontName:
type: string
description: "Font name setting for Freq display."
transparentBackground:
type: integer
description: "Transparent background setting for Freq display."
displayMode:
description: (0 Frequency, 1 Power, 2 Frequency and Power)
type: integer
speechEnabled:
type: integer
description: "Enable speech (1 enabled, 0 disabled)."
minimum: 0
maximum: 1
frequencyUnits:
description: (0 Hz, 1 kHz, 2 MHz, 3 GHz)
type: integer
showUnits:
type: integer
description: "Show units setting for Freq display."
freqDecimalPlaces:
type: integer
description: "Freq decimal places setting for Freq display."
powerDecimalPlaces:
type: integer
description: "Power decimal places setting for Freq display."
textcolor:
type: integer
description: "Textcolor setting for Freq display."
dropShadowEnabled:
type: integer
description: "Enable drop shadow (1 enabled, 0 disabled)."
minimum: 0
maximum: 1
dropShadowColor:
type: integer
description: "Drop shadow color encoded as an integer."
title:
type: string
description: "User-visible title."
rgbColor:
type: integer
description: "Display color encoded as an RGB integer."
useReverseAPI:
description: Synchronize with reverse API (1 for yes, 0 for no)
type: integer
minimum: 0
maximum: 1
reverseAPIAddress:
type: string
description: "IPv4 address or host name of the reverse API peer."
reverseAPIPort:
type: integer
description: "TCP port of the reverse API peer."
minimum: 1
maximum: 65535
reverseAPIFeatureSetIndex:
type: integer
description: "Feature-set index used by the reverse API peer."
reverseAPIFeatureIndex:
type: integer
description: "Feature index used by the reverse API peer."
rollupState:
$ref: "http://swgserver:8081/api/swagger/include/RollupState.yaml#/RollupState"
description: "Saved expanded or collapsed state of the GUI sections."
FreqDisplayReport:
description: "Frequency Display report"

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

@ -13,60 +13,83 @@ FreqScannerSettings: @@ -13,60 +13,83 @@ FreqScannerSettings:
threshold:
type: number
format: float
description: "Threshold setting for Freq scanner."
frequencies:
type: array
description: "List of frequencies."
items:
$ref: "http://swgserver:8081/api/swagger/include/FreqScanner.yaml#/FreqScannerFrequency"
channel:
type: string
description: "Channel identifier or configuration."
scanTime:
type: number
format: float
description: "Scan time setting for Freq scanner."
retransmitTime:
type: number
format: float
description: "Retransmit time setting for Freq scanner."
tuneTime:
type: number
format: float
description: "Tune time setting for Freq scanner."
priority:
type: integer
description: "Priority setting for Freq scanner."
measurement:
type: integer
description: "Measurement setting for Freq scanner."
mode:
type: integer
description: "Mode setting for Freq scanner."
rgbColor:
type: integer
description: "Display color encoded as an RGB integer."
title:
type: string
description: "User-visible title."
streamIndex:
description: MIMO channel. Not relevant when connected to SI (single Rx).
type: integer
useReverseAPI:
description: Synchronize with reverse API (1 for yes, 0 for no)
type: integer
minimum: 0
maximum: 1
reverseAPIAddress:
type: string
description: "IPv4 address or host name of the reverse API peer."
reverseAPIPort:
type: integer
description: "TCP port of the reverse API peer."
minimum: 1
maximum: 65535
reverseAPIDeviceIndex:
type: integer
description: "Device-set index used by the reverse API peer."
reverseAPIChannelIndex:
type: integer
description: "Channel index used by the reverse API peer."
channelMarker:
$ref: "http://swgserver:8081/api/swagger/include/ChannelMarker.yaml#/ChannelMarker"
description: "Channel-marker display configuration."
rollupState:
$ref: "http://swgserver:8081/api/swagger/include/RollupState.yaml#/RollupState"
description: "Saved expanded or collapsed state of the GUI sections."
FreqScannerReport:
description: FreqScanner
properties:
channelSampleRate:
type: integer
description: "Effective sample rate delivered to the channel in samples per second."
scanState:
description: (IDLE=0, START_SCAN=1, SCANNING=2, WAIT_FOR_END_TX=3, WAIT_FOR_RETRANSMISSION=4)
type: integer
channelState:
type: array
description: "List of channel state."
items:
$ref: "http://swgserver:8081/api/swagger/include/FreqScanner.yaml#/FreqScannerChannelState"
@ -85,24 +108,33 @@ FreqScannerFrequency: @@ -85,24 +108,33 @@ FreqScannerFrequency:
frequency:
type: integer
format: int64
description: "Frequency in Hz."
enabled:
type: integer
description: "Enabled for Freq scanner frequency."
notes:
type: string
description: "Notes for Freq scanner frequency."
channel:
type: string
description: "Channel identifier or configuration."
channelBandwidth:
type: string
description: "Channel bandwidth in Hz."
threshold:
type: string
description: "Threshold for Freq scanner frequency."
squelch:
type: string
description: "Squelch threshold in dB."
FreqScannerActions:
description: "Frequency Scanner actions"
properties:
run:
type: integer
minimum: 0
maximum: 1
description: >
Set the plugin running state
* 0 - idle

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

@ -11,16 +11,20 @@ FreqTrackerSettings: @@ -11,16 +11,20 @@ FreqTrackerSettings:
format: float
log2Decim:
type: integer
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
type: number
format: float
rgbColor:
type: integer
description: "Display color encoded as an RGB integer."
title:
type: string
description: "User-visible title."
spanLog2:
type: integer
description: "Base-2 exponent controlling the displayed or processed frequency span."
alphaEMA:
description: Alpha factor for delta frequency EMA
type: number
@ -49,20 +53,31 @@ FreqTrackerSettings: @@ -49,20 +53,31 @@ FreqTrackerSettings:
useReverseAPI:
description: Synchronize with reverse API (1 for yes, 0 for no)
type: integer
minimum: 0
maximum: 1
reverseAPIAddress:
type: string
description: "IPv4 address or host name of the reverse API peer."
reverseAPIPort:
type: integer
description: "TCP port of the reverse API peer."
minimum: 1
maximum: 65535
reverseAPIDeviceIndex:
type: integer
description: "Device-set index used by the reverse API peer."
reverseAPIChannelIndex:
type: integer
description: "Channel index used by the reverse API peer."
spectrumConfig:
$ref: "http://swgserver:8081/api/swagger/include/GLSpectrum.yaml#/GLSpectrum"
description: "Spectrum-display configuration."
channelMarker:
$ref: "http://swgserver:8081/api/swagger/include/ChannelMarker.yaml#/ChannelMarker"
description: "Channel-marker display configuration."
rollupState:
$ref: "http://swgserver:8081/api/swagger/include/RollupState.yaml#/RollupState"
description: "Saved expanded or collapsed state of the GUI sections."
FreqTrackerReport:
description: FreqTracker
@ -79,5 +94,7 @@ FreqTrackerReport: @@ -79,5 +94,7 @@ FreqTrackerReport:
type: integer
sampleRate:
type: integer
description: "Sample rate in samples per second."
channelSampleRate:
type: integer
description: "Effective sample rate delivered to the channel in samples per second."

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

@ -74,8 +74,10 @@ TriggerData: @@ -74,8 +74,10 @@ TriggerData:
format: float
triggerLevelCoarse:
type: integer
description: "Trigger level coarse for Trigger data."
triggerLevelFine:
type: integer
description: "Trigger level fine for Trigger data."
triggerPositiveEdge:
description: Trigger on the positive edge (else negative). Boolean
type: integer
@ -94,8 +96,10 @@ TriggerData: @@ -94,8 +96,10 @@ TriggerData:
format: float
triggerDelayCoarse:
type: integer
description: "Trigger delay coarse for Trigger data."
triggerDelayFine:
type: integer
description: "Trigger delay fine for Trigger data."
triggerRepeat:
description: Number of trigger conditions before the final decisive trigger
type: integer
@ -123,22 +127,29 @@ GLScope: @@ -123,22 +127,29 @@ GLScope:
type: integer
traceIntensity:
type: integer
description: "Trace intensity for Gl scope."
gridIntensity:
type: integer
description: "Grid intensity for Gl scope."
time:
type: integer
description: "Time for Gl scope."
timeOfs:
type: integer
description: "Time ofs for Gl scope."
traceLenMult:
type: integer
description: Trace length multiplier (multiplies 4800 samples)
trigPre:
type: integer
description: "Trig pre for Gl scope."
tracesData:
type: array
description: "List of traces data."
items:
$ref: "http://swgserver:8081/api/swagger/include/GLScope.yaml#/TraceData"
triggersData:
type: array
description: "List of triggers data."
items:
$ref: "http://swgserver:8081/api/swagger/include/GLScope.yaml#/TriggerData"

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

@ -4,12 +4,15 @@ SpectrumHistogramMarker: @@ -4,12 +4,15 @@ SpectrumHistogramMarker:
frequency:
type: number
format: float
description: "Frequency in Hz."
power:
type: number
format: float
description: Fixed power mark
markerType:
type: integer
minimum: 0
maximum: 2
description: >
Marker type
* 0 - Fixed power
@ -20,6 +23,8 @@ SpectrumHistogramMarker: @@ -20,6 +23,8 @@ SpectrumHistogramMarker:
description: Color in 8 bit BGR series
show:
type: integer
minimum: 0
maximum: 1
description: >
Boolean - Marker display state
* 0 - Hidden
@ -31,6 +36,7 @@ SpectrumWaterfallMarker: @@ -31,6 +36,7 @@ SpectrumWaterfallMarker:
frequency:
type: number
format: float
description: "Frequency in Hz."
time:
type: number
format: float
@ -40,6 +46,8 @@ SpectrumWaterfallMarker: @@ -40,6 +46,8 @@ SpectrumWaterfallMarker:
description: Color in 8 bit BGR series
show:
type: integer
minimum: 0
maximum: 1
description: >
Boolean - Marker display state
* 0 - Hidden
@ -51,13 +59,17 @@ SpectrumAnnotationMarker: @@ -51,13 +59,17 @@ SpectrumAnnotationMarker:
startFrequency:
type: integer
format: int64
description: "Start frequency in Hz."
bandwidth:
type: integer
description: "Bandwidth in Hz."
markerColor:
type: integer
description: Color in 8 bit BGR series
show:
type: integer
minimum: 0
maximum: 2
description: >
SpectrumAnnotationMarker::ShowState - Marker display state
* 0 - Hidden
@ -70,22 +82,29 @@ SpectrumCalibrationPoint: @@ -70,22 +82,29 @@ SpectrumCalibrationPoint:
frequency:
type: integer
format: int64
description: "Frequency in Hz."
powerRelativeReference:
type: number
format: float
description: "Power relative reference for Spectrum calibration point."
powerAbsoluteReference:
type: number
format: float
description: "Power absolute reference for Spectrum calibration point."
GLSpectrum:
description: GLSpectrumGUI settings
properties:
fftSize:
type: integer
description: "FFT size in samples."
fftOverlap:
type: integer
description: "FFT overlap for Gl spectrum."
fftWindow:
type: integer
minimum: 0
maximum: 8
description: >
FFT Window index (FFTWindow::Function):
* 0 - Bartlett
@ -100,59 +119,88 @@ GLSpectrum: @@ -100,59 +119,88 @@ GLSpectrum:
refLevel:
type: number
format: float
description: "Ref level for Gl spectrum."
powerRange:
type: number
format: float
description: "Power range for Gl spectrum."
fpsPeriodMs:
type: integer
description: FPS capping period in milliseconds. 0 for no limit.
displayWaterfall:
description: boolean
type: integer
minimum: 0
maximum: 1
invertedWaterfall:
description: boolean
type: integer
minimum: 0
maximum: 1
displayMaxHold:
description: boolean
type: integer
minimum: 0
maximum: 1
displayHistogram:
description: boolean
type: integer
minimum: 0
maximum: 1
decay:
type: integer
description: "Decay for Gl spectrum."
displayGrid:
description: boolean
type: integer
minimum: 0
maximum: 1
displayGridIntensity:
type: integer
description: "Display grid intensity for Gl spectrum."
decayDivisor:
type: integer
description: "Decay divisor for Gl spectrum."
histogramStroke:
type: integer
description: "Histogram stroke for Gl spectrum."
displayCurrent:
description: boolean
type: integer
minimum: 0
maximum: 1
displayTraceIntensity:
type: integer
description: "Display trace intensity for Gl spectrum."
waterfallShare:
type: number
format: float
description: "Waterfall share for Gl spectrum."
averagingMode:
description: See GLSpectrumGUI::AveragingMode
type: integer
averagingValue:
type: integer
description: "Averaging value for Gl spectrum."
linear:
description: boolean
type: integer
minimum: 0
maximum: 1
ssb:
description: boolean
type: integer
minimum: 0
maximum: 1
usb:
description: boolean
type: integer
minimum: 0
maximum: 1
wsSpectrum:
type: integer
minimum: 0
maximum: 1
description: >
Boolean - Start or stop websocket server
* 0 - Stop server
@ -165,6 +213,8 @@ GLSpectrum: @@ -165,6 +213,8 @@ GLSpectrum:
type: integer
markersDisplay:
type: integer
minimum: 0
maximum: 2
description: >
Display markers (SpectrumSettings::MarkersDisplay)
* 0 - Mome
@ -172,26 +222,34 @@ GLSpectrum: @@ -172,26 +222,34 @@ GLSpectrum:
* 2 - Spectrum annotation markers
useCalibration:
type: integer
minimum: 0
maximum: 1
description: boolean
calibrationInterpMode:
type: integer
minimum: 0
maximum: 1
description: >
Interpolation scheme between points SpectrumSettings::CalibrationInterpolationMode
* 0 - Linear
* 1 - Log (dB linear)
histogramMarkers:
type: array
description: "List of histogram markers."
items:
$ref: "http://swgserver:8081/api/swagger/include/GLSpectrum.yaml#/SpectrumHistogramMarker"
waterfallMarkers:
type: array
description: "List of waterfall markers."
items:
$ref: "http://swgserver:8081/api/swagger/include/GLSpectrum.yaml#/SpectrumWaterfallMarker"
annotationMarkers:
type: array
description: "List of annotation markers."
items:
$ref: "http://swgserver:8081/api/swagger/include/GLSpectrum.yaml#/SpectrumAnnotationMarker"
calibrationPoints:
type: array
description: "List of calibration points."
items:
$ref: "http://swgserver:8081/api/swagger/include/GLSpectrum.yaml#/SpectrumCalibrationPoint"

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

@ -69,27 +69,40 @@ GS232ControllerSettings: @@ -69,27 +69,40 @@ GS232ControllerSettings:
format: float
title:
type: string
description: "User-visible title."
rgbColor:
type: integer
description: "Display color encoded as an RGB integer."
useReverseAPI:
description: Synchronize with reverse API (1 for yes, 0 for no)
type: integer
minimum: 0
maximum: 1
reverseAPIAddress:
type: string
description: "IPv4 address or host name of the reverse API peer."
reverseAPIPort:
type: integer
description: "TCP port of the reverse API peer."
minimum: 1
maximum: 65535
reverseAPIFeatureSetIndex:
type: integer
description: "Feature-set index used by the reverse API peer."
reverseAPIFeatureIndex:
type: integer
description: "Feature index used by the reverse API peer."
rollupState:
$ref: "http://swgserver:8081/api/swagger/include/RollupState.yaml#/RollupState"
description: "Saved expanded or collapsed state of the GUI sections."
GS232ControllerReport:
description: "GS-232 Controller report"
properties:
runningState:
type: integer
minimum: 0
maximum: 3
description: >
Running state
* 0 - not started
@ -131,6 +144,8 @@ GS232ControllerActions: @@ -131,6 +144,8 @@ GS232ControllerActions:
properties:
run:
type: integer
minimum: 0
maximum: 1
description: >
Set the plugin running state
* 0 - idle

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

@ -3,39 +3,63 @@ HackRFInputSettings: @@ -3,39 +3,63 @@ HackRFInputSettings:
properties:
title:
type: string
description: "User-visible title."
centerFrequency:
type: integer
format: int64
description: "Device center frequency in Hz."
LOppmTenths:
type: integer
description: "Local-oscillator correction in tenths of a part per million."
bandwidth:
type: integer
description: "Bandwidth in Hz."
lnaGain:
type: integer
description: "Low-noise-amplifier gain setting."
vgaGain:
type: integer
description: "Variable-gain-amplifier gain setting."
log2Decim:
type: integer
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
devSampleRate:
type: integer
description: "Device I/Q sample rate in samples per second before software decimation or interpolation."
biasT:
type: integer
description: "Enable antenna bias power (1 enabled, 0 disabled)."
minimum: 0
maximum: 1
lnaExt:
type: integer
description: "LNA ext setting for Hack RF input."
dcBlock:
type: integer
description: "Enable DSP DC-offset correction (1 enabled, 0 disabled)."
minimum: 0
maximum: 1
iqCorrection:
type: integer
description: "Enable I/Q imbalance correction (1 enabled, 0 disabled)."
minimum: 0
maximum: 1
transverterMode:
type: integer
description: "Enable transverter frequency translation (1 enabled, 0 disabled)."
minimum: 0
maximum: 1
transverterDeltaFrequency:
type: integer
format: int64
description: "Frequency translation applied in transverter mode in Hz."
iqOrder:
type: integer
minimum: 0
maximum: 1
description: >
IQ samples order
* 0 - Q then I (swapped)
@ -43,49 +67,78 @@ HackRFInputSettings: @@ -43,49 +67,78 @@ HackRFInputSettings:
useReverseAPI:
description: Synchronize with reverse API (1 for yes, 0 for no)
type: integer
minimum: 0
maximum: 1
reverseAPIAddress:
type: string
description: "IPv4 address or host name of the reverse API peer."
reverseAPIPort:
type: integer
description: "TCP port of the reverse API peer."
minimum: 1
maximum: 65535
reverseAPIDeviceIndex:
type: integer
description: "Device-set index used by the reverse API peer."
HackRFOutputSettings:
description: HackRF
properties:
title:
type: string
description: "User-visible title."
centerFrequency:
type: integer
format: int64
description: "Device center frequency in Hz."
LOppmTenths:
type: integer
description: "Local-oscillator correction in tenths of a part per million."
bandwidth:
type: integer
description: "Bandwidth in Hz."
vgaGain:
type: integer
description: "Variable-gain-amplifier gain setting."
log2Interp:
type: integer
description: "Base-2 exponent of the software interpolation factor; the output sample rate is multiplied by 2^log2Interp."
fcPos:
description: 0=Infra 1=Supra 2=Center
type: integer
devSampleRate:
type: integer
description: "Device I/Q sample rate in samples per second before software decimation or interpolation."
biasT:
type: integer
description: "Enable antenna bias power (1 enabled, 0 disabled)."
minimum: 0
maximum: 1
lnaExt:
type: integer
description: "LNA ext setting for Hack RF output."
transverterMode:
type: integer
description: "Enable transverter frequency translation (1 enabled, 0 disabled)."
minimum: 0
maximum: 1
transverterDeltaFrequency:
type: integer
format: int64
description: "Frequency translation applied in transverter mode in Hz."
useReverseAPI:
description: Synchronize with reverse API (1 for yes, 0 for no)
type: integer
minimum: 0
maximum: 1
reverseAPIAddress:
type: string
description: "IPv4 address or host name of the reverse API peer."
reverseAPIPort:
type: integer
description: "TCP port of the reverse API peer."
minimum: 1
maximum: 65535
reverseAPIDeviceIndex:
type: integer
description: "Device-set index used by the reverse API peer."

22
swagger/sdrangel/api/swagger/include/HeatMap.yaml

@ -4,6 +4,7 @@ HeatMapSettings: @@ -4,6 +4,7 @@ HeatMapSettings:
inputFrequencyOffset:
type: integer
format: int64
description: "Channel frequency offset from the device center frequency in Hz."
rfBandwidth:
description: channel RF bandwidth in Hz
type: number
@ -11,46 +12,66 @@ HeatMapSettings: @@ -11,46 +12,66 @@ HeatMapSettings:
minPower:
type: number
format: float
description: "Min power setting for Heat map."
maxPower:
type: number
format: float
description: "Max power setting for Heat map."
colorMapName:
type: string
description: "Color map name setting for Heat map."
mode:
description: "(0 - None, 1 - Average, 2 - Max, 3 - Min, 4 - Pulse Average)"
type: integer
minimum: 0
maximum: 4
pulseThreshold:
type: number
format: float
description: "Pulse threshold setting for Heat map."
averagePeriodUS:
description: "Averaging period in microseconds"
type: integer
sampleRate:
type: integer
description: "Sample rate in samples per second."
rgbColor:
type: integer
description: "Display color encoded as an RGB integer."
title:
type: string
description: "User-visible title."
streamIndex:
description: MIMO channel. Not relevant when connected to SI (single Rx).
type: integer
useReverseAPI:
description: Synchronize with reverse API (1 for yes, 0 for no)
type: integer
minimum: 0
maximum: 1
reverseAPIAddress:
type: string
description: "IPv4 address or host name of the reverse API peer."
reverseAPIPort:
type: integer
description: "TCP port of the reverse API peer."
minimum: 1
maximum: 65535
reverseAPIDeviceIndex:
type: integer
description: "Device-set index used by the reverse API peer."
reverseAPIChannelIndex:
type: integer
description: "Channel index used by the reverse API peer."
scopeConfig:
$ref: "http://swgserver:8081/api/swagger/include/GLScope.yaml#/GLScope"
description: "Oscilloscope-display configuration."
channelMarker:
$ref: "http://swgserver:8081/api/swagger/include/ChannelMarker.yaml#/ChannelMarker"
description: "Channel-marker display configuration."
rollupState:
$ref: "http://swgserver:8081/api/swagger/include/RollupState.yaml#/RollupState"
description: "Saved expanded or collapsed state of the GUI sections."
HeatMapReport:
description: HeatMap
@ -61,3 +82,4 @@ HeatMapReport: @@ -61,3 +82,4 @@ HeatMapReport:
format: float
channelSampleRate:
type: integer
description: "Effective sample rate delivered to the channel in samples per second."

49
swagger/sdrangel/api/swagger/include/IEEE_802_15_4_Mod.yaml

@ -4,16 +4,22 @@ IEEE_802_15_4_ModSettings: @@ -4,16 +4,22 @@ IEEE_802_15_4_ModSettings:
inputFrequencyOffset:
type: integer
format: int64
description: "Channel frequency offset from the device center frequency in Hz."
modulation:
description: >
Modulation type
* 0 - BPSK
* 1 - OQPSK
type: integer
minimum: 0
maximum: 1
bitRate:
type: integer
description: "Bit rate setting for Ieee 802 15 4 mod."
subGHzBand:
type: integer
minimum: 0
maximum: 1
description: >
Boolean value
* 0 - Over 1 GHz standard
@ -21,17 +27,23 @@ IEEE_802_15_4_ModSettings: @@ -21,17 +27,23 @@ IEEE_802_15_4_ModSettings:
rfBandwidth:
type: number
format: float
description: "RF bandwidth in Hz."
gain:
type: number
format: float
description: "Gain setting; units and available values depend on the device or plugin."
channelMute:
type: integer
minimum: 0
maximum: 1
description: >
* 0 - Effective transmission
* 1 - Transmission is muted
repeat:
description: Whether to repeated transmit the frame (1 for yes, 0 for no).
type: integer
minimum: 0
maximum: 1
repeatDelay:
description: Delay between repeated transmissions.
type: number
@ -41,55 +53,78 @@ IEEE_802_15_4_ModSettings: @@ -41,55 +53,78 @@ IEEE_802_15_4_ModSettings:
type: integer
rampUpBits:
type: integer
description: "Ramp up bits setting for Ieee 802 15 4 mod."
rampDownBits:
type: integer
description: "Ramp down bits setting for Ieee 802 15 4 mod."
rampRange:
type: integer
description: "Ramp range setting for Ieee 802 15 4 mod."
modulateWhileRamping:
type: integer
minimum: 0
maximum: 1
description: >
Boolean value
* 0 - do not modulate in ramping phase
* 1 - modulate in ramping phase
lpfTaps:
type: integer
description: "Number of low-pass FIR filter taps."
bbNoise:
type: integer
minimum: 0
maximum: 1
description: >
Boolean value
* 0 - Do not add gaussian noise in baseband
* 1 - Add gaussian noise in baseband
writeToFile:
type: integer
minimum: 0
maximum: 1
description: >
Boolean value
* 0 - Do not write frames to .csv file
* 1 - Write frames to .csv file
spectrumRate:
type: integer
description: "Spectrum rate setting for Ieee 802 15 4 mod."
data:
type: string
description: Hex coded bytes of data to transmit, excluding CRC (E.g for an ACK - 02 00 00)
rgbColor:
type: integer
description: "Display color encoded as an RGB integer."
title:
type: string
description: "User-visible title."
streamIndex:
description: MIMO channel. Not relevant when connected to SI (single Rx).
type: integer
useReverseAPI:
description: Synchronize with reverse API (1 for yes, 0 for no)
type: integer
minimum: 0
maximum: 1
reverseAPIAddress:
type: string
description: "IPv4 address or host name of the reverse API peer."
reverseAPIPort:
type: integer
description: "TCP port of the reverse API peer."
minimum: 1
maximum: 65535
reverseAPIDeviceIndex:
type: integer
description: "Device-set index used by the reverse API peer."
reverseAPIChannelIndex:
type: integer
description: "Channel index used by the reverse API peer."
scramble:
type: integer
minimum: 0
maximum: 1
description: >
Boolean value
* 0 - Do not scramble data
@ -99,6 +134,8 @@ IEEE_802_15_4_ModSettings: @@ -99,6 +134,8 @@ IEEE_802_15_4_ModSettings:
description: Scrambling polynomial
pulseShaping:
type: integer
minimum: 0
maximum: 1
description: >
Pulse shaping filter
* 0 - Root Cosime
@ -109,11 +146,16 @@ IEEE_802_15_4_ModSettings: @@ -109,11 +146,16 @@ IEEE_802_15_4_ModSettings:
description: Pulse shaping filter beta factor
symbolSpan:
type: integer
description: "Symbol span setting for Ieee 802 15 4 mod."
udpEnabled:
description: Enable forwarding of frames via UDP
type: integer
minimum: 0
maximum: 1
udpBytesFormat:
type: integer
minimum: 0
maximum: 1
description: >
Payload format
* 0 - Blank separated string representation of hex bytes i.e. 00 02 0a
@ -124,10 +166,14 @@ IEEE_802_15_4_ModSettings: @@ -124,10 +166,14 @@ IEEE_802_15_4_ModSettings:
udpPort:
description: UDP port to listen for frames to transmit on
type: integer
minimum: 1
maximum: 65535
channelMarker:
$ref: "http://swgserver:8081/api/swagger/include/ChannelMarker.yaml#/ChannelMarker"
description: "Channel-marker display configuration."
rollupState:
$ref: "http://swgserver:8081/api/swagger/include/RollupState.yaml#/RollupState"
description: "Saved expanded or collapsed state of the GUI sections."
IEEE_802_15_4_ModReport:
description: IEEE_802_15_4_Mod
@ -138,12 +184,15 @@ IEEE_802_15_4_ModReport: @@ -138,12 +184,15 @@ IEEE_802_15_4_ModReport:
format: float
channelSampleRate:
type: integer
description: "Effective sample rate delivered to the channel in samples per second."
IEEE_802_15_4_ModActions:
description: IEEE_802_15_4_Mod
properties:
tx:
type: integer
minimum: 0
maximum: 1
description: >
Initialize a transmission cycle
* 0 - Do nothing

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

@ -4,87 +4,128 @@ ILSDemodSettings: @@ -4,87 +4,128 @@ ILSDemodSettings:
inputFrequencyOffset:
type: integer
format: int64
description: "Channel frequency offset from the device center frequency in Hz."
rfBandwidth:
type: number
format: float
description: "RF bandwidth in Hz."
mode:
description: "(0 for LOC, 1 for G/S)"
type: integer
frequencyIndex:
type: integer
description: "Selected frequency index."
squelch:
type: integer
description: "Squelch threshold in dB."
volume:
type: number
format: float
description: "Audio volume multiplier."
audioMute:
type: integer
description: "Mute audio output (1 muted, 0 unmuted)."
minimum: 0
maximum: 1
average:
type: integer
description: "Average setting for Ils demod."
ddmUnits:
type: integer
description: "Ddm units setting for Ils demod."
identThreshold:
type: number
format: float
description: "Ident threshold setting for Ils demod."
ident:
type: string
description: "Ident setting for Ils demod."
runway:
type: string
description: "Runway setting for Ils demod."
trueBearing:
type: number
format: float
description: "True bearing setting for Ils demod."
latitude:
type: string
description: "Latitude in degrees, positive north."
longitude:
type: string
description: "Longitude in degrees, positive east."
elevation:
type: integer
description: "Elevation setting for Ils demod."
glidePath:
type: number
format: float
description: "Glide path setting for Ils demod."
refHeight:
type: number
format: float
description: "Ref height setting for Ils demod."
courseWidth:
type: number
format: float
description: "Course width setting for Ils demod."
udpEnabled:
description: "Whether to forward DDM to specified UDP port"
type: integer
minimum: 0
maximum: 1
udpAddress:
description: "UDP address to forward DDM to"
type: string
udpPort:
description: "UDP port to forward DDM to"
type: integer
minimum: 1
maximum: 65535
logFilename:
type: string
description: "Log file name or path."
logEnabled:
type: integer
description: "Enable logging to the configured file (1 enabled, 0 disabled)."
minimum: 0
maximum: 1
rgbColor:
type: integer
description: "Display color encoded as an RGB integer."
title:
type: string
description: "User-visible title."
streamIndex:
description: MIMO channel. Not relevant when connected to SI (single Rx).
type: integer
useReverseAPI:
description: Synchronize with reverse API (1 for yes, 0 for no)
type: integer
minimum: 0
maximum: 1
reverseAPIAddress:
type: string
description: "IPv4 address or host name of the reverse API peer."
reverseAPIPort:
type: integer
description: "TCP port of the reverse API peer."
minimum: 1
maximum: 65535
reverseAPIDeviceIndex:
type: integer
description: "Device-set index used by the reverse API peer."
reverseAPIChannelIndex:
type: integer
description: "Channel index used by the reverse API peer."
scopeConfig:
$ref: "http://swgserver:8081/api/swagger/include/GLScope.yaml#/GLScope"
description: "Oscilloscope-display configuration."
channelMarker:
$ref: "http://swgserver:8081/api/swagger/include/ChannelMarker.yaml#/ChannelMarker"
description: "Channel-marker display configuration."
rollupState:
$ref: "http://swgserver:8081/api/swagger/include/RollupState.yaml#/RollupState"
description: "Saved expanded or collapsed state of the GUI sections."
ILSDemodReport:
description: ILSDemod
@ -95,8 +136,10 @@ ILSDemodReport: @@ -95,8 +136,10 @@ ILSDemodReport:
format: float
channelSampleRate:
type: integer
description: "Effective sample rate delivered to the channel in samples per second."
ident:
type: string
description: "Reported ident."
deviation:
description: deviation in degrees
type: number

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

@ -4,57 +4,85 @@ InmarsatDemodSettings: @@ -4,57 +4,85 @@ InmarsatDemodSettings:
inputFrequencyOffset:
type: integer
format: int64
description: "Channel frequency offset from the device center frequency in Hz."
rfBandwidth:
type: number
format: float
description: "RF bandwidth in Hz."
rrcRolloff:
type: number
format: float
description: "Rrc rolloff setting for Inmarsat demod."
pllBandwidth:
type: number
format: float
description: "Pll bandwidth in Hz."
udpEnabled:
description: "Whether to forward received messages to specified UDP port"
type: integer
minimum: 0
maximum: 1
udpAddress:
description: "UDP address to forward received messages to"
type: string
udpPort:
description: "UDP port to forward received messages to"
type: integer
minimum: 1
maximum: 65535
udpFormat:
description: "0 for binary, 1 for NMEA"
type: integer
logFilename:
type: string
description: "Log file name or path."
logEnabled:
type: integer
description: "Enable logging to the configured file (1 enabled, 0 disabled)."
minimum: 0
maximum: 1
useFileTime:
type: integer
description: "Enable file time (1 enabled, 0 disabled)."
minimum: 0
maximum: 1
rgbColor:
type: integer
description: "Display color encoded as an RGB integer."
title:
type: string
description: "User-visible title."
streamIndex:
description: MIMO channel. Not relevant when connected to SI (single Rx).
type: integer
useReverseAPI:
description: Synchronize with reverse API (1 for yes, 0 for no)
type: integer
minimum: 0
maximum: 1
reverseAPIAddress:
type: string
description: "IPv4 address or host name of the reverse API peer."
reverseAPIPort:
type: integer
description: "TCP port of the reverse API peer."
minimum: 1
maximum: 65535
reverseAPIDeviceIndex:
type: integer
description: "Device-set index used by the reverse API peer."
reverseAPIChannelIndex:
type: integer
description: "Channel index used by the reverse API peer."
scopeConfig:
$ref: "http://swgserver:8081/api/swagger/include/GLScope.yaml#/GLScope"
description: "Oscilloscope-display configuration."
channelMarker:
$ref: "http://swgserver:8081/api/swagger/include/ChannelMarker.yaml#/ChannelMarker"
description: "Channel-marker display configuration."
rollupState:
$ref: "http://swgserver:8081/api/swagger/include/RollupState.yaml#/RollupState"
description: "Saved expanded or collapsed state of the GUI sections."
InmarsatDemodReport:
description: InmarsatDemod
@ -65,3 +93,4 @@ InmarsatDemodReport: @@ -65,3 +93,4 @@ InmarsatDemodReport:
format: float
channelSampleRate:
type: integer
description: "Effective sample rate delivered to the channel in samples per second."

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

@ -6,12 +6,16 @@ InterferometerSettings: @@ -6,12 +6,16 @@ InterferometerSettings:
type: integer
rgbColor:
type: integer
description: "Display color encoded as an RGB integer."
title:
type: string
description: "User-visible title."
log2Decim:
type: integer
description: "Base-2 exponent of the software decimation factor; the output sample rate is divided by 2^log2Decim."
filterChainHash:
type: integer
description: "Identifier of the selected half-band filter chain."
phase:
description: Channel B phase shift in degrees (-180 to 180)
type: integer
@ -23,6 +27,8 @@ InterferometerSettings: @@ -23,6 +27,8 @@ InterferometerSettings:
type: integer
play:
type: integer
minimum: 0
maximum: 1
description: >
Run correlated IQ samples transfer
* 0 - stop
@ -30,19 +36,31 @@ InterferometerSettings: @@ -30,19 +36,31 @@ InterferometerSettings:
useReverseAPI:
description: Synchronize with reverse API (1 for yes, 0 for no)
type: integer
minimum: 0
maximum: 1
reverseAPIAddress:
type: string
description: "IPv4 address or host name of the reverse API peer."
reverseAPIPort:
type: integer
description: "TCP port of the reverse API peer."
minimum: 1
maximum: 65535
reverseAPIDeviceIndex:
type: integer
description: "Device-set index used by the reverse API peer."
reverseAPIChannelIndex:
type: integer
description: "Channel index used by the reverse API peer."
spectrumConfig:
$ref: "http://swgserver:8081/api/swagger/include/GLSpectrum.yaml#/GLSpectrum"
description: "Spectrum-display configuration."
scopeConfig:
$ref: "http://swgserver:8081/api/swagger/include/GLScope.yaml#/GLScope"
description: "Oscilloscope-display configuration."
channelMarker:
$ref: "http://swgserver:8081/api/swagger/include/ChannelMarker.yaml#/ChannelMarker"
description: "Channel-marker display configuration."
rollupState:
$ref: "http://swgserver:8081/api/swagger/include/RollupState.yaml#/RollupState"
description: "Saved expanded or collapsed state of the GUI sections."

11
swagger/sdrangel/api/swagger/include/JogdialController.yaml

@ -3,21 +3,32 @@ JogdialControllerSettings: @@ -3,21 +3,32 @@ JogdialControllerSettings:
properties:
title:
type: string
description: "User-visible title."
rgbColor:
type: integer
description: "Display color encoded as an RGB integer."
useReverseAPI:
type: integer
minimum: 0
maximum: 1
description: >
Synchronize with reverse API
* 1 - yes
* 0 - no
reverseAPIAddress:
type: string
description: "IPv4 address or host name of the reverse API peer."
reverseAPIPort:
type: integer
description: "TCP port of the reverse API peer."
minimum: 1
maximum: 65535
reverseAPIFeatureSetIndex:
type: integer
description: "Feature-set index used by the reverse API peer."
reverseAPIFeatureIndex:
type: integer
description: "Feature index used by the reverse API peer."
rollupState:
$ref: "http://swgserver:8081/api/swagger/include/RollupState.yaml#/RollupState"
description: "Saved expanded or collapsed state of the GUI sections."

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

@ -3,28 +3,43 @@ KiwiSDRSettings: @@ -3,28 +3,43 @@ KiwiSDRSettings:
properties:
title:
type: string
description: "User-visible title."
gain:
type: integer
description: "Gain setting; units and available values depend on the device or plugin."
useAGC:
description: AGC active (1 for yes, 0 for no)
type: integer
minimum: 0
maximum: 1
dcBlock:
type: integer
description: "Enable DSP DC-offset correction (1 enabled, 0 disabled)."
minimum: 0
maximum: 1
centerFrequency:
type: integer
format: int64
description: "Device center frequency in Hz."
serverAddress:
description: Distant KiwiSDR instance URL or IPv4 address with port
type: string
useReverseAPI:
description: Synchronize with reverse API (1 for yes, 0 for no)
type: integer
minimum: 0
maximum: 1
reverseAPIAddress:
type: string
description: "IPv4 address or host name of the reverse API peer."
reverseAPIPort:
type: integer
description: "TCP port of the reverse API peer."
minimum: 1
maximum: 65535
reverseAPIDeviceIndex:
type: integer
description: "Device-set index used by the reverse API peer."
KiwiSDRReport:
description: KiwiSDR
@ -35,9 +50,16 @@ KiwiSDRReport: @@ -35,9 +50,16 @@ KiwiSDRReport:
latitude:
type: number
format: float
description: "Latitude in degrees, positive north."
minimum: -90
maximum: 90
longitude:
type: number
format: float
description: "Longitude in degrees, positive east."
minimum: -180
maximum: 180
altitude:
type: number
format: float
description: "Altitude above mean sea level."

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

@ -3,13 +3,17 @@ LimeRFESettings: @@ -3,13 +3,17 @@ LimeRFESettings:
properties:
title:
type: string
description: "User-visible title."
rgbColor:
type: integer
description: "Display color encoded as an RGB integer."
devicePath:
description: Path to the device serial interface (ex /dev/ttyUSB2)
type: string
rxChannels:
type: integer
minimum: 0
maximum: 2
description: >
Rx channels group (LimeRFEController::ChannelGroups):
* 0 - Wideband
@ -17,6 +21,8 @@ LimeRFESettings: @@ -17,6 +21,8 @@ LimeRFESettings:
* 2 - cellular
rxWidebandChannel:
type: integer
minimum: 0
maximum: 1
description: >
Rx wideband channel selection (LimeRFEController::WidebandChannel)
* 0 - Low: 1 - 1000 MHz
@ -45,6 +51,8 @@ LimeRFESettings: @@ -45,6 +51,8 @@ LimeRFESettings:
* 4 - Band 38: 2.56 - 2.63 GHz
rxPort:
type: integer
minimum: 0
maximum: 1
description: >
Rx port selected (LimeRFEController::RxPort)
* 0 - J3
@ -57,6 +65,8 @@ LimeRFESettings: @@ -57,6 +65,8 @@ LimeRFESettings:
type: integer
txChannels:
type: integer
minimum: 0
maximum: 2
description: >
Tx channels group (LimeRFEController::ChannelGroups)
* 0 - Wideband
@ -64,6 +74,8 @@ LimeRFESettings: @@ -64,6 +74,8 @@ LimeRFESettings:
* 2 - cellular
txWidebandChannel:
type: integer
minimum: 0
maximum: 1
description: >
Tx wideband channel selection (LimeRFEController::WidebandChannel)
* 0 - Low: 1 - 1000 MHz
@ -92,6 +104,8 @@ LimeRFESettings: @@ -92,6 +104,8 @@ LimeRFESettings:
* 4 - Band 38: 2.56 - 2.63 GHz
txPort:
type: integer
minimum: 0
maximum: 2
description: >
Tx port selected (LimeRFEController::TxPort)
* 0 - J3
@ -100,8 +114,12 @@ LimeRFESettings: @@ -100,8 +114,12 @@ LimeRFESettings:
swrEnable:
description: Boolean if SWR measurements are enabled else 0
type: integer
minimum: 0
maximum: 1
swrSource:
type: integer
minimum: 0
maximum: 1
description: >
SWR measurement source (LimeRFEController::SWRSource)
* 0 - External
@ -109,19 +127,30 @@ LimeRFESettings: @@ -109,19 +127,30 @@ LimeRFESettings:
txRxDriven:
description: Boolean 1 if Tx is copy of Rx else 0
type: integer
minimum: 0
maximum: 1
useReverseAPI:
description: Synchronize with reverse API (1 for yes, 0 for no)
type: integer
minimum: 0
maximum: 1
reverseAPIAddress:
type: string
description: "IPv4 address or host name of the reverse API peer."
reverseAPIPort:
type: integer
description: "TCP port of the reverse API peer."
minimum: 1
maximum: 65535
reverseAPIFeatureSetIndex:
type: integer
description: "Feature-set index used by the reverse API peer."
reverseAPIFeatureIndex:
type: integer
description: "Feature index used by the reverse API peer."
rollupState:
$ref: "http://swgserver:8081/api/swagger/include/RollupState.yaml#/RollupState"
description: "Saved expanded or collapsed state of the GUI sections."
LimeRFEReport:
description: LimeRFE
@ -129,9 +158,13 @@ LimeRFEReport: @@ -129,9 +158,13 @@ LimeRFEReport:
rxOn:
description: Boolean 1 if Rx is active else 0
type: integer
minimum: 0
maximum: 1
txOn:
description: Boolean 1 if Tx is active else 0
type: integer
minimum: 0
maximum: 1
forwardPower:
description: relative forward power in centi-Bels
type: integer
@ -144,6 +177,8 @@ LimeRFEActions: @@ -144,6 +177,8 @@ LimeRFEActions:
properties:
selectChannel:
type: integer
minimum: 0
maximum: 1
description: >
Select channel
* 0 - Rx
@ -153,6 +188,8 @@ LimeRFEActions: @@ -153,6 +188,8 @@ LimeRFEActions:
description: Index of device set to synchronize switch with
switchChannel:
type: integer
minimum: 0
maximum: 1
description: >
Switch on or off
* 0 - Off
@ -162,24 +199,32 @@ LimeRFEActions: @@ -162,24 +199,32 @@ LimeRFEActions:
description: Set to non zero value to get the board state
fromToSettings:
type: integer
minimum: 0
maximum: 1
description: >
Move from/to settings to/from device
* 0 - From device to settings. The toGUI button in GUI mode
* 1 - From settings to device. The Apply button in GUI mode
openCloseDevice:
type: integer
minimum: 0
maximum: 1
description: >
Open or close device
* 0 - Close device
* 1 - Open device
setRx:
type: integer
minimum: 0
maximum: 1
description: >
Set Rx om or off
* 0 - Rx off
* 1 - Rx on
setTx:
type: integer
minimum: 0
maximum: 1
description: >
Set Tx om or off
* 0 - Tx off

169
swagger/sdrangel/api/swagger/include/LimeSdr.yaml

@ -3,54 +3,91 @@ LimeSdrInputSettings: @@ -3,54 +3,91 @@ LimeSdrInputSettings:
properties:
title:
type: string
description: "User-visible title."
centerFrequency:
type: integer
format: int64
description: "Device center frequency in Hz."
devSampleRate:
type: integer
description: "Device I/Q sample rate in samples per second before software decimation or interpolation."
log2HardDecim:
type: integer
description: "Base-2 exponent of the hardware decimation factor."
dcBlock:
type: integer
description: "Enable DSP DC-offset correction (1 enabled, 0 disabled)."
minimum: 0
maximum: 1
splitFreq:
type: integer
description: "Split freq setting for Lime sdr input."
iqCorrection:
type: integer
description: "Enable I/Q imbalance correction (1 enabled, 0 disabled)."
minimum: 0
maximum: 1
log2SoftDecim:
type: integer
description: "Base-2 exponent of the software decimation factor."
lpfBW:
type: integer
description: "Analog low-pass filter bandwidth in Hz."
lpfFIREnable:
type: integer
description: "Enable the digital FIR low-pass filter (1 enabled, 0 disabled)."
minimum: 0
maximum: 1
lpfFIRBW:
type: integer
description: "Digital FIR low-pass filter bandwidth in Hz."
gain:
type: integer
description: "Gain setting; units and available values depend on the device or plugin."
ncoEnable:
type: integer
description: "Enable the numerically controlled oscillator (1 enabled, 0 disabled)."
minimum: 0
maximum: 1
ncoFrequency:
type: integer
description: "Numerically controlled oscillator frequency in Hz."
antennaPath:
type: integer
description: "Selected RF antenna path."
gainMode:
type: integer
description: "Gain-control mode selection."
lnaGain:
type: integer
description: "Low-noise-amplifier gain setting."
tiaGain:
type: integer
description: "TIA gain setting for Lime sdr input."
pgaGain:
type: integer
description: "PGA gain setting for Lime sdr input."
extClock:
type: integer
description: "Use an external reference clock (1 enabled, 0 disabled)."
minimum: 0
maximum: 1
extClockFreq:
type: integer
description: "External reference-clock frequency in Hz."
transverterMode:
type: integer
description: "Enable transverter frequency translation (1 enabled, 0 disabled)."
minimum: 0
maximum: 1
transverterDeltaFrequency:
type: integer
format: int64
description: "Frequency translation applied in transverter mode in Hz."
iqOrder:
type: integer
minimum: 0
maximum: 1
description: >
IQ samples order
* 0 - Q then I (swapped)
@ -58,71 +95,113 @@ LimeSdrInputSettings: @@ -58,71 +95,113 @@ LimeSdrInputSettings:
gpioDir:
type: integer
format: int8
description: "GPIO direction bit mask, with one bit per pin."
gpioPins:
type: integer
format: int8
description: "GPIO pin-state bit mask, with one bit per pin."
useReverseAPI:
description: Synchronize with reverse API (1 for yes, 0 for no)
type: integer
minimum: 0
maximum: 1
reverseAPIAddress:
type: string
description: "IPv4 address or host name of the reverse API peer."
reverseAPIPort:
type: integer
description: "TCP port of the reverse API peer."
minimum: 1
maximum: 65535
reverseAPIDeviceIndex:
type: integer
description: "Device-set index used by the reverse API peer."
LimeSdrOutputSettings:
description: LimeSDR
properties:
title:
type: string
description: "User-visible title."
centerFrequency:
type: integer
format: int64
description: "Device center frequency in Hz."
devSampleRate:
type: integer
description: "Device I/Q sample rate in samples per second before software decimation or interpolation."
log2HardInterp:
type: integer
description: "Base-2 exponent of the hardware interpolation factor."
log2SoftInterp:
type: integer
description: "Base-2 exponent of the software interpolation factor."
lpfBW:
type: integer
description: "Analog low-pass filter bandwidth in Hz."
lpfFIREnable:
type: integer
description: "Enable the digital FIR low-pass filter (1 enabled, 0 disabled)."
minimum: 0
maximum: 1
lpfFIRBW:
type: integer
description: "Digital FIR low-pass filter bandwidth in Hz."
gain:
type: integer
description: "Gain setting; units and available values depend on the device or plugin."
ncoEnable:
type: integer
description: "Enable the numerically controlled oscillator (1 enabled, 0 disabled)."
minimum: 0
maximum: 1
ncoFrequency:
type: integer
description: "Numerically controlled oscillator frequency in Hz."
antennaPath:
type: integer
description: "Selected RF antenna path."
extClock:
type: integer
description: "Use an external reference clock (1 enabled, 0 disabled)."
minimum: 0
maximum: 1
extClockFreq:
type: integer
description: "External reference-clock frequency in Hz."
transverterMode:
type: integer
description: "Enable transverter frequency translation (1 enabled, 0 disabled)."
minimum: 0
maximum: 1
transverterDeltaFrequency:
type: integer
format: int64
description: "Frequency translation applied in transverter mode in Hz."
gpioDir:
type: integer
format: int8
description: "GPIO direction bit mask, with one bit per pin."
gpioPins:
type: integer
format: int8
description: "GPIO pin-state bit mask, with one bit per pin."
useReverseAPI:
description: Synchronize with reverse API (1 for yes, 0 for no)
type: integer
minimum: 0
maximum: 1
reverseAPIAddress:
type: string
description: "IPv4 address or host name of the reverse API peer."
reverseAPIPort:
type: integer
description: "TCP port of the reverse API peer."
minimum: 1
maximum: 65535
reverseAPIDeviceIndex:
type: integer
description: "Device-set index used by the reverse API peer."
LimeSdrMIMOSettings:
description: LimeSDR
@ -130,8 +209,10 @@ LimeSdrMIMOSettings: @@ -130,8 +209,10 @@ LimeSdrMIMOSettings:
# General
title:
type: string
description: "User-visible title."
devSampleRate:
type: integer
description: "Device I/Q sample rate in samples per second before software decimation or interpolation."
gpioDir:
description: GPIO pin direction LSB first; 0 input, 1 output
type: integer
@ -143,40 +224,61 @@ LimeSdrMIMOSettings: @@ -143,40 +224,61 @@ LimeSdrMIMOSettings:
extClock:
description: Boolean 1 if external clock source else 0
type: integer
minimum: 0
maximum: 1
extClockFreq:
description: Frequency (Hz) of external clock source
type: integer
useReverseAPI:
description: Boolean
type: integer
minimum: 0
maximum: 1
reverseAPIAddress:
type: string
description: "IPv4 address or host name of the reverse API peer."
reverseAPIPort:
type: integer
description: "TCP port of the reverse API peer."
minimum: 1
maximum: 65535
reverseAPIDeviceIndex:
type: integer
description: "Device-set index used by the reverse API peer."
# Rx general
rxCenterFrequency:
type: integer
format: int64
description: "Receive center frequency in Hz."
log2HardDecim:
type: integer
description: "Base-2 exponent of the hardware decimation factor."
log2SoftDecim:
type: integer
description: "Base-2 exponent of the software decimation factor."
dcBlock:
description: Boolean
type: integer
minimum: 0
maximum: 1
iqCorrection:
description: Boolean
type: integer
minimum: 0
maximum: 1
rxTransverterMode:
description: Boolean
type: integer
minimum: 0
maximum: 1
rxTransverterDeltaFrequency:
type: integer
format: int64
description: "Receive frequency translation applied in transverter mode in Hz."
iqOrder:
type: integer
minimum: 0
maximum: 1
description: >
IQ samples order
* 0 - Q then I (swapped)
@ -184,6 +286,8 @@ LimeSdrMIMOSettings: @@ -184,6 +286,8 @@ LimeSdrMIMOSettings:
ncoEnableRx:
description: Boolean 1 to enable TSP NCO and mixing else 0
type: integer
minimum: 0
maximum: 1
ncoFrequencyRx:
description: Rx Actual NCO frequency (the resulting frequency with mixing is displayed)
type: integer
@ -195,6 +299,8 @@ LimeSdrMIMOSettings: @@ -195,6 +299,8 @@ LimeSdrMIMOSettings:
lpfFIREnableRx0:
description: Boolean 1 to enable Rx[0] LMS digital lowpass FIR filters else 0
type: integer
minimum: 0
maximum: 1
lpfFIRBWRx0:
description: Rx[0] LMS digital lowpass FIR filters bandwidth (Hz)
type: number
@ -213,12 +319,16 @@ LimeSdrMIMOSettings: @@ -213,12 +319,16 @@ LimeSdrMIMOSettings:
* 4 - LB TX1
* 5 - LB TX2
type: integer
minimum: 0
maximum: 5
gainModeRx0:
description: >
Rx[0] Gain mode:
* 0 - auto
* 1 - manual
type: integer
minimum: 0
maximum: 1
lnaGainRx0:
description: Rx[0] Manual LNA gain
type: integer
@ -236,6 +346,8 @@ LimeSdrMIMOSettings: @@ -236,6 +346,8 @@ LimeSdrMIMOSettings:
lpfFIREnableRx1:
description: Boolean 1 to enable Rx[1] LMS digital lowpass FIR filters else 0
type: integer
minimum: 0
maximum: 1
lpfFIRBWRx1:
description: Rx[1] LMS digital lowpass FIR filters bandwidth (Hz)
type: number
@ -253,12 +365,16 @@ LimeSdrMIMOSettings: @@ -253,12 +365,16 @@ LimeSdrMIMOSettings:
* 4 - LB TX1
* 5 - LB TX2
type: integer
minimum: 0
maximum: 5
gainModeRx1:
description: >
Rx[1] Gain mode:
* 0 - auto
* 1 - manual
type: integer
minimum: 0
maximum: 1
lnaGainRx1:
description: Rx[1] Manual LNA gain
type: integer
@ -272,19 +388,27 @@ LimeSdrMIMOSettings: @@ -272,19 +388,27 @@ LimeSdrMIMOSettings:
txCenterFrequency:
type: integer
format: int64
description: "Transmit center frequency in Hz."
log2HardInterp:
type: integer
description: "Base-2 exponent of the hardware interpolation factor."
log2SoftInterp:
type: integer
description: "Base-2 exponent of the software interpolation factor."
txTransverterMode:
description: Boolean
type: integer
minimum: 0
maximum: 1
txTransverterDeltaFrequency:
type: integer
format: int64
description: "Transmit frequency translation applied in transverter mode in Hz."
ncoEnableTx:
description: Boolean 1 to enable TSP NCO and mixing else 0
type: integer
minimum: 0
maximum: 1
ncoFrequencyTx:
description: Tx Actual NCO frequency (the resulting frequency with mixing is displayed)
type: integer
@ -296,6 +420,8 @@ LimeSdrMIMOSettings: @@ -296,6 +420,8 @@ LimeSdrMIMOSettings:
lpfFIREnableTx0:
description: Boolean 1 to enable Tx[0] LMS digital lowpass FIR filters else 0
type: integer
minimum: 0
maximum: 1
lpfFIRBWTx0:
description: Tx[0] LMS digital lowpass FIR filters bandwidth (Hz)
type: number
@ -310,6 +436,8 @@ LimeSdrMIMOSettings: @@ -310,6 +436,8 @@ LimeSdrMIMOSettings:
* 1 - RF connector 1
* 2 - RF connector 2
type: integer
minimum: 0
maximum: 2
# Tx channel 1
lpfBWTx1:
description: Tx[1] LMS analog lowpass filter bandwidth (Hz)
@ -318,6 +446,8 @@ LimeSdrMIMOSettings: @@ -318,6 +446,8 @@ LimeSdrMIMOSettings:
lpfFIREnableTx1:
description: Boolean 1 to enable Tx[1] LMS digital lowpass FIR filters else 0
type: integer
minimum: 0
maximum: 1
lpfFIRBWTx1:
description: Tx[1] LMS digital lowpass FIR filters bandwidth (Hz)
type: number
@ -332,6 +462,8 @@ LimeSdrMIMOSettings: @@ -332,6 +462,8 @@ LimeSdrMIMOSettings:
* 1 - RF connector 1
* 2 - RF connector 2
type: integer
minimum: 0
maximum: 2
LimeSdrInputReport:
description: LimeSDR
@ -342,19 +474,27 @@ LimeSdrInputReport: @@ -342,19 +474,27 @@ LimeSdrInputReport:
streamActive:
description: 1 if active else 0
type: integer
minimum: 0
maximum: 1
fifoSize:
type: integer
description: "FIFO capacity in samples."
fifoFill:
type: integer
description: "Current FIFO fill level."
underrunCount:
type: integer
description: "Number of stream underrun events."
overrunCount:
type: integer
description: "Number of stream overrun events."
droppedPacketsCount:
type: integer
description: "Number of dropped packets."
linkRate:
type: number
format: float
description: "Measured streaming link rate."
hwTimestamp:
description: Hardware timestamp
type: integer
@ -362,12 +502,15 @@ LimeSdrInputReport: @@ -362,12 +502,15 @@ LimeSdrInputReport:
temperature:
type: number
format: float
description: "Reported device temperature."
gpioDir:
type: integer
format: int8
description: "GPIO direction bit mask, with one bit per pin."
gpioPins:
type: integer
format: int8
description: "GPIO pin-state bit mask, with one bit per pin."
LimeSdrOutputReport:
description: LimeSDR
@ -378,19 +521,27 @@ LimeSdrOutputReport: @@ -378,19 +521,27 @@ LimeSdrOutputReport:
streamActive:
description: 1 if active else 0
type: integer
minimum: 0
maximum: 1
fifoSize:
type: integer
description: "FIFO capacity in samples."
fifoFill:
type: integer
description: "Current FIFO fill level."
underrunCount:
type: integer
description: "Number of stream underrun events."
overrunCount:
type: integer
description: "Number of stream overrun events."
droppedPacketsCount:
type: integer
description: "Number of dropped packets."
linkRate:
type: number
format: float
description: "Measured streaming link rate."
hwTimestamp:
description: Hardware timestamp
type: integer
@ -398,12 +549,15 @@ LimeSdrOutputReport: @@ -398,12 +549,15 @@ LimeSdrOutputReport:
temperature:
type: number
format: float
description: "Reported device temperature."
gpioDir:
type: integer
format: int8
description: "GPIO direction bit mask, with one bit per pin."
gpioPins:
type: integer
format: int8
description: "GPIO pin-state bit mask, with one bit per pin."
LimeSdrMIMOReport:
description: LimeSDR
@ -415,12 +569,15 @@ LimeSdrMIMOReport: @@ -415,12 +569,15 @@ LimeSdrMIMOReport:
temperature:
type: number
format: float
description: "Reported device temperature."
gpioDir:
type: integer
format: int8
description: "GPIO direction bit mask, with one bit per pin."
gpioPins:
type: integer
format: int8
description: "GPIO pin-state bit mask, with one bit per pin."
successRx:
description: 1 if Rx info was successfully retrieved else 0
type: integer
@ -429,17 +586,23 @@ LimeSdrMIMOReport: @@ -429,17 +586,23 @@ LimeSdrMIMOReport:
type: integer
fifoSizeRx:
type: integer
description: "Reported fifo size receive."
fifoFillRx:
type: integer
description: "Current receive FIFO fill level."
underrunCountRx:
type: integer
description: "Reported underrun count receive."
overrunCountRx:
type: integer
description: "Reported overrun count receive."
droppedPacketsCountRx:
type: integer
description: "Reported dropped packets count receive."
linkRateRx:
type: number
format: float
description: "Reported link rate receive."
successTx:
description: 1 if Tx info was successfully retrieved else 0
type: integer
@ -448,14 +611,20 @@ LimeSdrMIMOReport: @@ -448,14 +611,20 @@ LimeSdrMIMOReport:
type: integer
fifoSizeTx:
type: integer
description: "Reported fifo size transmit."
fifoFillTx:
type: integer
description: "Current transmit FIFO fill level."
underrunCountTx:
type: integer
description: "Reported underrun count transmit."
overrunCountTx:
type: integer
description: "Reported overrun count transmit."
droppedPacketsCountTx:
type: integer
description: "Reported dropped packets count transmit."
linkRateTx:
type: number
format: float
description: "Reported link rate transmit."

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

@ -3,19 +3,33 @@ LocalInputSettings: @@ -3,19 +3,33 @@ LocalInputSettings:
properties:
title:
type: string
description: "User-visible title."
dcBlock:
type: integer
description: "Enable DSP DC-offset correction (1 enabled, 0 disabled)."
minimum: 0
maximum: 1
iqCorrection:
type: integer
description: "Enable I/Q imbalance correction (1 enabled, 0 disabled)."
minimum: 0
maximum: 1
useReverseAPI:
description: Synchronize with reverse API (1 for yes, 0 for no)
type: integer
minimum: 0
maximum: 1
reverseAPIAddress:
type: string
description: "IPv4 address or host name of the reverse API peer."
reverseAPIPort:
type: integer
description: "TCP port of the reverse API peer."
minimum: 1
maximum: 65535
reverseAPIDeviceIndex:
type: integer
description: "Device-set index used by the reverse API peer."
LocalInputReport:
description: LocalInput
@ -23,5 +37,7 @@ LocalInputReport: @@ -23,5 +37,7 @@ LocalInputReport:
centerFrequency:
type: integer
format: int64
description: "Device center frequency in Hz."
sampleRate:
type: integer
description: "Sample rate in samples per second."

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

@ -3,15 +3,23 @@ LocalOutputSettings: @@ -3,15 +3,23 @@ LocalOutputSettings:
properties:
title:
type: string
description: "User-visible title."
useReverseAPI:
description: Synchronize with reverse API (1 for yes, 0 for no)
type: integer
minimum: 0
maximum: 1
reverseAPIAddress:
type: string
description: "IPv4 address or host name of the reverse API peer."
reverseAPIPort:
type: integer
description: "TCP port of the reverse API peer."
minimum: 1
maximum: 65535
reverseAPIDeviceIndex:
type: integer
description: "Device-set index used by the reverse API peer."
LocalOutputReport:
description: LocalOutput
@ -19,5 +27,7 @@ LocalOutputReport: @@ -19,5 +27,7 @@ LocalOutputReport:
centerFrequency:
type: integer
format: int64
description: "Device center frequency in Hz."
sampleRate:
type: integer
description: "Sample rate in samples per second."

25
swagger/sdrangel/api/swagger/include/LocalSink.yaml

@ -6,20 +6,28 @@ LocalSinkSettings: @@ -6,20 +6,28 @@ LocalSinkSettings:
type: integer
rgbColor:
type: integer
description: "Display color encoded as an RGB integer."
title:
type: string
description: "User-visible title."
log2Decim:
type: integer
description: "Base-2 exponent of the software decimation factor; the output sample rate is divided by 2^log2Decim."
filterChainHash:
type: integer
description: "Identifier of the selected half-band filter chain."
play:
type: integer
minimum: 0
maximum: 1
description: >
Run samples transfer
* 0 - stop
* 1 - run
dsp:
type: integer
minimum: 0
maximum: 1
description: >
Activate DSP
* 0 - Skip DSP functions
@ -29,6 +37,8 @@ LocalSinkSettings: @@ -29,6 +37,8 @@ LocalSinkSettings:
type: integer
fftOn:
type: integer
minimum: 0
maximum: 1
description: >
Activate FFT multiband filter
* 0 - do not run filter
@ -38,6 +48,8 @@ LocalSinkSettings: @@ -38,6 +48,8 @@ LocalSinkSettings:
type: integer
fftWindow:
type: integer
minimum: 0
maximum: 8
description: >
FFT window type
* 0 - Bartlett
@ -51,10 +63,13 @@ LocalSinkSettings: @@ -51,10 +63,13 @@ LocalSinkSettings:
* 8 - Blackman-Harris (7th order)
fftBands:
type: array
description: "List of fft bands."
items:
$ref: "http://swgserver:8081/api/swagger/include/LocalSink.yaml#/FFTBand"
reverseFilter:
type: integer
minimum: 0
maximum: 1
description: >
* 0 - band definitions are bandpass
* 1 - band definitions are band reject
@ -64,18 +79,28 @@ LocalSinkSettings: @@ -64,18 +79,28 @@ LocalSinkSettings:
useReverseAPI:
description: Synchronize with reverse API (1 for yes, 0 for no)
type: integer
minimum: 0
maximum: 1
reverseAPIAddress:
type: string
description: "IPv4 address or host name of the reverse API peer."
reverseAPIPort:
type: integer
description: "TCP port of the reverse API peer."
minimum: 1
maximum: 65535
reverseAPIDeviceIndex:
type: integer
description: "Device-set index used by the reverse API peer."
reverseAPIChannelIndex:
type: integer
description: "Channel index used by the reverse API peer."
channelMarker:
$ref: "http://swgserver:8081/api/swagger/include/ChannelMarker.yaml#/ChannelMarker"
description: "Channel-marker display configuration."
rollupState:
$ref: "http://swgserver:8081/api/swagger/include/RollupState.yaml#/RollupState"
description: "Saved expanded or collapsed state of the GUI sections."
FFTBand:

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

@ -6,30 +6,46 @@ LocalSourceSettings: @@ -6,30 +6,46 @@ LocalSourceSettings:
type: integer
rgbColor:
type: integer
description: "Display color encoded as an RGB integer."
title:
type: string
description: "User-visible title."
log2Interp:
type: integer
description: "Base-2 exponent of the software interpolation factor; the output sample rate is multiplied by 2^log2Interp."
filterChainHash:
type: integer
description: "Identifier of the selected half-band filter chain."
play:
description: boolean (1 to play, 0 to stop)
type: integer
minimum: 0
maximum: 1
streamIndex:
description: MIMO channel. Not relevant when connected to SI (single Rx).
type: integer
useReverseAPI:
description: Synchronize with reverse API (1 for yes, 0 for no)
type: integer
minimum: 0
maximum: 1
reverseAPIAddress:
type: string
description: "IPv4 address or host name of the reverse API peer."
reverseAPIPort:
type: integer
description: "TCP port of the reverse API peer."
minimum: 1
maximum: 65535
reverseAPIDeviceIndex:
type: integer
description: "Device-set index used by the reverse API peer."
reverseAPIChannelIndex:
type: integer
description: "Channel index used by the reverse API peer."
channelMarker:
$ref: "http://swgserver:8081/api/swagger/include/ChannelMarker.yaml#/ChannelMarker"
description: "Channel-marker display configuration."
rollupState:
$ref: "http://swgserver:8081/api/swagger/include/RollupState.yaml#/RollupState"
description: "Saved expanded or collapsed state of the GUI sections."

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

@ -4,35 +4,50 @@ M17DemodSettings: @@ -4,35 +4,50 @@ M17DemodSettings:
inputFrequencyOffset:
type: integer
format: int64
description: "Channel frequency offset from the device center frequency in Hz."
rfBandwidth:
type: number
format: float
description: "RF bandwidth in Hz."
fmDeviation:
type: number
format: float
description: "FM frequency deviation in Hz."
volume:
type: number
format: float
description: "Audio volume multiplier."
demodGain:
type: number
format: float
description: "Demod gain setting for M17 demod."
baudRate:
type: integer
description: "Serial-port baud rate in bits per second."
squelchGate:
type: integer
description: "Squelch gate duration."
squelch:
type: number
format: float
description: "Squelch threshold in dB."
audioMute:
type: integer
description: "Mute audio output (1 muted, 0 unmuted)."
minimum: 0
maximum: 1
syncOrConstellation:
type: integer
description: "Sync or constellation setting for M17 demod."
rgbColor:
type: integer
description: "Display color encoded as an RGB integer."
title:
type: string
description: "User-visible title."
highPassFilter:
type: integer
description: "High pass filter setting for M17 demod."
traceLengthMutliplier:
description: multiply by 50ms
type: integer
@ -44,26 +59,40 @@ M17DemodSettings: @@ -44,26 +59,40 @@ M17DemodSettings:
type: integer
audioDeviceName:
type: string
description: "Name of the audio device to use."
statusLogEnabled:
type: integer
description: "Enable status log (1 enabled, 0 disabled)."
minimum: 0
maximum: 1
streamIndex:
description: MIMO channel. Not relevant when connected to SI (single Rx).
type: integer
useReverseAPI:
description: Synchronize with reverse API (1 for yes, 0 for no)
type: integer
minimum: 0
maximum: 1
reverseAPIAddress:
type: string
description: "IPv4 address or host name of the reverse API peer."
reverseAPIPort:
type: integer
description: "TCP port of the reverse API peer."
minimum: 1
maximum: 65535
reverseAPIDeviceIndex:
type: integer
description: "Device-set index used by the reverse API peer."
reverseAPIChannelIndex:
type: integer
description: "Channel index used by the reverse API peer."
channelMarker:
$ref: "http://swgserver:8081/api/swagger/include/ChannelMarker.yaml#/ChannelMarker"
description: "Channel-marker display configuration."
rollupState:
$ref: "http://swgserver:8081/api/swagger/include/RollupState.yaml#/RollupState"
description: "Saved expanded or collapsed state of the GUI sections."
M17DemodReport:
description: M17Demod
@ -74,8 +103,10 @@ M17DemodReport: @@ -74,8 +103,10 @@ M17DemodReport:
format: float
audioSampleRate:
type: integer
description: "Audio sample rate in samples per second."
channelSampleRate:
type: integer
description: "Effective sample rate delivered to the channel in samples per second."
squelch:
description: squelch status (1 if open else 0)
type: integer

41
swagger/sdrangel/api/swagger/include/M17Mod.yaml

@ -4,26 +4,39 @@ M17ModSettings: @@ -4,26 +4,39 @@ M17ModSettings:
inputFrequencyOffset:
type: integer
format: int64
description: "Channel frequency offset from the device center frequency in Hz."
rfBandwidth:
type: number
format: float
description: "RF bandwidth in Hz."
fmDeviation:
type: number
format: float
description: "FM frequency deviation in Hz."
toneFrequency:
type: number
format: float
description: "Tone frequency in Hz."
volumeFactor:
type: number
format: float
description: "Volume factor setting for M17 mod."
channelMute:
type: integer
description: "Mute the channel output (1 muted, 0 unmuted)."
minimum: 0
maximum: 1
playLoop:
type: integer
description: "Loop playback at end of file (1 enabled, 0 disabled)."
minimum: 0
maximum: 1
rgbColor:
type: integer
description: "Display color encoded as an RGB integer."
title:
type: string
description: "User-visible title."
m17Mode:
type: integer
description: M17Mode
@ -35,55 +48,81 @@ M17ModSettings: @@ -35,55 +48,81 @@ M17ModSettings:
description: PacketType
audioDeviceName:
type: string
description: "Name of the audio device to use."
feedbackAudioDeviceName:
type: string
description: "Feedback audio device name setting for M17 mod."
feedbackVolumeFactor:
type: number
format: float
description: "Feedback volume factor setting for M17 mod."
feedbackAudioEnable:
type: integer
description: "Feedback audio enable setting for M17 mod."
streamIndex:
description: MIMO channel. Not relevant when connected to SI (single Rx).
type: integer
useReverseAPI:
description: Synchronize with reverse API (1 for yes, 0 for no)
type: integer
minimum: 0
maximum: 1
reverseAPIAddress:
type: string
description: "IPv4 address or host name of the reverse API peer."
reverseAPIPort:
type: integer
description: "TCP port of the reverse API peer."
minimum: 1
maximum: 65535
reverseAPIDeviceIndex:
type: integer
description: "Device-set index used by the reverse API peer."
reverseAPIChannelIndex:
type: integer
description: "Channel index used by the reverse API peer."
sourceCall:
type: string
description: "Source call setting for M17 mod."
destCall:
type: string
description: "Dest call setting for M17 mod."
insertPosition:
type: integer
description: "Insert position setting for M17 mod."
can:
type: integer
description: "Can setting for M17 mod."
smsText:
type: string
description: "Sms text setting for M17 mod."
loopPacket:
type: integer
description: "Loop packet setting for M17 mod."
loopPacketInterval:
type: integer
description: "Loop packet interval setting for M17 mod."
aprsCallsign:
type: string
description: "Aprs callsign setting for M17 mod."
aprsTo:
type: string
description: "Aprs to setting for M17 mod."
aprsVia:
type: string
description: "Aprs via setting for M17 mod."
aprsData:
type: string
description: "Aprs data setting for M17 mod."
aprsInsertPosition:
type: integer
description: "Aprs insert position setting for M17 mod."
channelMarker:
$ref: "http://swgserver:8081/api/swagger/include/ChannelMarker.yaml#/ChannelMarker"
description: "Channel-marker display configuration."
rollupState:
$ref: "http://swgserver:8081/api/swagger/include/RollupState.yaml#/RollupState"
description: "Saved expanded or collapsed state of the GUI sections."
M17ModReport:
description: M17Mod
@ -94,5 +133,7 @@ M17ModReport: @@ -94,5 +133,7 @@ M17ModReport:
format: float
audioSampleRate:
type: integer
description: "Audio sample rate in samples per second."
channelSampleRate:
type: integer
description: "Effective sample rate delivered to the channel in samples per second."

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

@ -0,0 +1,75 @@ @@ -0,0 +1,75 @@
MCPServerSettings:
description: "MCP (Model Context Protocol) server settings"
properties:
address:
type: string
description: Address to bind the HTTP listener to. Defaults to 127.0.0.1 (local connections only)
port:
type: integer
description: TCP port the MCP server listens on
token:
type: string
description: Optional bearer token clients must present in the Authorization header. Empty for no authentication
captureDir:
type: string
description: Directory that IQ and audio captures are written to. Capture tools refuse paths outside it
title:
type: string
description: "User-visible title."
rgbColor:
type: integer
description: "Display color encoded as an RGB integer."
useReverseAPI:
type: integer
minimum: 0
maximum: 1
description: >
Synchronize with reverse API
* 1 - yes
* 0 - no
reverseAPIAddress:
type: string
description: "IPv4 address or host name of the reverse API peer."
reverseAPIPort:
type: integer
description: "TCP port of the reverse API peer."
minimum: 1
maximum: 65535
reverseAPIFeatureSetIndex:
type: integer
description: "Feature-set index used by the reverse API peer."
reverseAPIFeatureIndex:
type: integer
description: "Feature index used by the reverse API peer."
rollupState:
$ref: "http://swgserver:8081/api/swagger/include/RollupState.yaml#/RollupState"
description: "Saved expanded or collapsed state of the GUI sections."
MCPServerReport:
description: MCP server report
properties:
runningState:
type: integer
minimum: 0
maximum: 3
description: >
Running state
* 0 - not started
* 1 - idle
* 2 - running
* 3 - error
requestCount:
type: integer
description: Number of MCP requests served since the server was started
MCPServerActions:
description: MCP server actions
properties:
run:
type: integer
minimum: 0
maximum: 1
description: >
Set the plugin running state
* 0 - idle
* 1 - run

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

@ -9,21 +9,32 @@ MapSettings: @@ -9,21 +9,32 @@ MapSettings:
type: string
title:
type: string
description: "User-visible title."
rgbColor:
type: integer
description: "Display color encoded as an RGB integer."
useReverseAPI:
description: Synchronize with reverse API (1 for yes, 0 for no)
type: integer
minimum: 0
maximum: 1
reverseAPIAddress:
type: string
description: "IPv4 address or host name of the reverse API peer."
reverseAPIPort:
type: integer
description: "TCP port of the reverse API peer."
minimum: 1
maximum: 65535
reverseAPIFeatureSetIndex:
type: integer
description: "Feature-set index used by the reverse API peer."
reverseAPIFeatureIndex:
type: integer
description: "Feature index used by the reverse API peer."
rollupState:
$ref: "http://swgserver:8081/api/swagger/include/RollupState.yaml#/RollupState"
description: "Saved expanded or collapsed state of the GUI sections."
MapReport:
description: Map
@ -64,10 +75,14 @@ MapItem: @@ -64,10 +75,14 @@ MapItem:
description: "Latitude in decimal degrees, positive to the North"
type: number
format: float
minimum: -90
maximum: 90
longitude:
description: "Longitude in decimal degrees, positive to the East"
type: number
format: float
minimum: -180
maximum: 180
altitude:
description: "Altitude / height above sea level in metres"
type: number
@ -75,6 +90,8 @@ MapItem: @@ -75,6 +90,8 @@ MapItem:
fixedPosition:
description: "Indicates whether position of item is constant with time (0 - variable, 1 - fixed)"
type: integer
minimum: 0
maximum: 1
positionDateTime:
description: "Date and time at this position (ISO 8601 extended format)"
type: string
@ -97,6 +114,8 @@ MapItem: @@ -97,6 +114,8 @@ MapItem:
orientation:
description: "How to orientate the model (0 - Along direction of motion, 1 - Use heading, pitch and roll)"
type: integer
minimum: 0
maximum: 1
heading:
description: "Heading angle, in decimal degrees clockwise from North"
type: number
@ -129,6 +148,8 @@ MapItem: @@ -129,6 +148,8 @@ MapItem:
altitudeReference:
description: "0 - NONE (Absolute), 1 - CLAMP_TO_GROUND, 2 - RELATIVE_TO_GROUND, 3 - CLIP_TO_GROUND."
type: integer
minimum: 0
maximum: 3
animations:
description: "Animations to play"
type: array
@ -137,18 +158,24 @@ MapItem: @@ -137,18 +158,24 @@ MapItem:
type:
description: "(0 - Map Item, 1 - Image Tile, 2 - Polygon, 3 - Polyline)"
type: integer
minimum: 0
maximum: 3
imageTileWest:
type: number
format: float
description: "Image tile west for Map item."
imageTileSouth:
type: number
format: float
description: "Image tile south for Map item."
imageTileEast:
type: number
format: float
description: "Image tile east for Map item."
imageTileNorth:
type: number
format: float
description: "Image tile north for Map item."
imageZoomLevel:
description: "For 2D map"
type: number
@ -171,11 +198,14 @@ MapItem: @@ -171,11 +198,14 @@ MapItem:
colorValid:
description: "0 - Use default color, 1 - Use specified color"
type: integer
minimum: 0
maximum: 1
color:
description: "RGBA for polygon and polyline"
type: integer
aircraftState:
$ref: "http://swgserver:8081/api/swagger/include/Map.yaml#/MapAircraftState"
description: "Current states of aircraft tracked by the ADS-B demodulator."
MapAnimation:
description: "Animation to play in the model on the 3D map"
@ -186,9 +216,13 @@ MapAnimation: @@ -186,9 +216,13 @@ MapAnimation:
reverse:
description: "(0 - Forward, 1 - Reverse)"
type: integer
minimum: 0
maximum: 1
loop:
description: "(0 - Play once, 1 - Play in loop)"
type: integer
minimum: 0
maximum: 1
startDateTime:
description: "Date and time to start playing this animation (ISO 8601 extended format)"
type: string
@ -218,10 +252,14 @@ MapCoordinate: @@ -218,10 +252,14 @@ MapCoordinate:
description: "Latitude in decimal degrees, positive to the North"
type: number
format: float
minimum: -90
maximum: 90
longitude:
description: "Longitude in decimal degrees, positive to the East"
type: number
format: float
minimum: -180
maximum: 180
altitude:
description: "Altitude / height above sea level in metres"
type: number
@ -235,10 +273,13 @@ MapAircraftState: @@ -235,10 +273,13 @@ MapAircraftState:
properties:
callsign:
type: string
description: "Radio callsign."
aircraftType:
type: string
description: "Aircraft type for Map aircraft state."
onSurface:
type: integer
description: "On surface for Map aircraft state."
airspeed:
description: "Indicated airspeed in knots"
type: number
@ -257,6 +298,7 @@ MapAircraftState: @@ -257,6 +298,7 @@ MapAircraftState:
mach:
type: number
format: float
description: "Mach for Map aircraft state."
altitude:
description: "Barometric altitude in feet"
type: number
@ -286,12 +328,15 @@ MapAircraftState: @@ -286,12 +328,15 @@ MapAircraftState:
selectedAirspeed:
type: number
format: float
description: "Selected airspeed for Map aircraft state."
selectedAltitude:
type: number
format: float
description: "Selected altitude for Map aircraft state."
selectedHeading:
type: number
format: float
description: "Selected heading for Map aircraft state."
autopilot:
description: "-1 unknown, 0 off, 1 on"
type: integer
@ -307,10 +352,13 @@ MapAircraftState: @@ -307,10 +352,13 @@ MapAircraftState:
windSpeed:
type: number
format: float
description: "Wind speed for Map aircraft state."
windDirection:
type: number
format: float
description: "Wind direction for Map aircraft state."
staticAirTemperature:
type: number
format: float
description: "Static air temperature for Map aircraft state."

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

@ -4,8 +4,11 @@ MeshcoreDemodSettings: @@ -4,8 +4,11 @@ MeshcoreDemodSettings:
inputFrequencyOffset:
type: integer
format: int64
description: "Channel frequency offset from the device center frequency in Hz."
bandwidthIndex:
type: integer
minimum: 0
maximum: 26
description: >
standard bandwidths index:
* 0 - 375 Hz (384000 / 1024)
@ -37,12 +40,15 @@ MeshcoreDemodSettings: @@ -37,12 +40,15 @@ MeshcoreDemodSettings:
* 26 - 500000 Hz (500000 / 1)
spreadFactor:
type: integer
description: "Spread factor setting for Meshcore demod."
deBits:
description: Low data rate optimize (DE) bits i.e. nb of FFT bins per effective symbol
type: integer
decodeActive:
description: boolean 1 to activate 0 to de-activate decoder
type: integer
minimum: 0
maximum: 1
eomSquelchTenths:
description: argmax squared magnitude is compared between current multiplied by this factor and maximum during decoding. This value is divided by 10
type: integer
@ -61,11 +67,17 @@ MeshcoreDemodSettings: @@ -61,11 +67,17 @@ MeshcoreDemodSettings:
sendViaUDP:
description: boolean 1 to send decoded message via UDP else 0
type: integer
minimum: 0
maximum: 1
sendJsonViaUDP:
description: boolean 1 to send decoded message as JSON via UDP else 0
type: integer
minimum: 0
maximum: 1
udpEnabled:
type: integer
minimum: 0
maximum: 1
description: >
Boolean - Send via UDP
* 0 - Do not send decoded messages via UDP
@ -76,36 +88,53 @@ MeshcoreDemodSettings: @@ -76,36 +88,53 @@ MeshcoreDemodSettings:
udpPort:
description: UDP destination port
type: integer
minimum: 1
maximum: 65535
invertRamps:
type: integer
minimum: 0
maximum: 1
description: >
Invert chirp ramps
* 0 - Normal chirp ramps (upchirps for preamble and payload)
* 1 - Inverted chirp ramps (downchirps for preamble and payload)
rgbColor:
type: integer
description: "Display color encoded as an RGB integer."
title:
type: string
description: "User-visible title."
streamIndex:
description: MIMO channel. Not relevant when connected to SI (single Rx).
type: integer
useReverseAPI:
description: Synchronize with reverse API (1 for yes, 0 for no)
type: integer
minimum: 0
maximum: 1
reverseAPIAddress:
type: string
description: "IPv4 address or host name of the reverse API peer."
reverseAPIPort:
type: integer
description: "TCP port of the reverse API peer."
minimum: 1
maximum: 65535
reverseAPIDeviceIndex:
type: integer
description: "Device-set index used by the reverse API peer."
reverseAPIChannelIndex:
type: integer
description: "Channel index used by the reverse API peer."
spectrumConfig:
$ref: "http://swgserver:8081/api/swagger/include/GLSpectrum.yaml#/GLSpectrum"
description: "Spectrum-display configuration."
channelMarker:
$ref: "http://swgserver:8081/api/swagger/include/ChannelMarker.yaml#/ChannelMarker"
description: "Channel-marker display configuration."
rollupState:
$ref: "http://swgserver:8081/api/swagger/include/RollupState.yaml#/RollupState"
description: "Saved expanded or collapsed state of the GUI sections."
MeshcoreDemodReport:
description: MeshcoreDemod
@ -128,6 +157,7 @@ MeshcoreDemodReport: @@ -128,6 +157,7 @@ MeshcoreDemodReport:
format: float
channelSampleRate:
type: integer
description: "Effective sample rate delivered to the channel in samples per second."
syncWord:
description: 2 bytes sync word (0..65535)
type: integer
@ -145,6 +175,8 @@ MeshcoreDemodReport: @@ -145,6 +175,8 @@ MeshcoreDemodReport:
type: integer
headerParityStatus:
type: integer
minimum: 0
maximum: 3
description: >
Header FEC parity status:
* 0 - Undefined
@ -156,6 +188,8 @@ MeshcoreDemodReport: @@ -156,6 +188,8 @@ MeshcoreDemodReport:
type: integer
payloadParityStatus:
type: integer
minimum: 0
maximum: 3
description: >
Payload FEC parity status:
* 0 - Undefined
@ -184,6 +218,8 @@ MeshcoreDemodReport: @@ -184,6 +218,8 @@ MeshcoreDemodReport:
type: string
decoding:
type: integer
minimum: 0
maximum: 1
description: >
Boolean - decoding status
* 0 - no decoding

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

@ -4,8 +4,11 @@ MeshcoreModSettings: @@ -4,8 +4,11 @@ MeshcoreModSettings:
inputFrequencyOffset:
type: integer
format: int64
description: "Channel frequency offset from the device center frequency in Hz."
bandwidthIndex:
type: integer
minimum: 0
maximum: 26
description: >
standard bandwidths index:
* 0 - 375 Hz (384000 / 1024)
@ -37,6 +40,7 @@ MeshcoreModSettings: @@ -37,6 +40,7 @@ MeshcoreModSettings:
* 26 - 500000 Hz (500000 / 1)
spreadFactor:
type: integer
description: "Spread factor setting for Meshcore mod."
deBits:
description: Low data rate optimize (DE) bits i.e. nb of FFT bins per effective symbol
type: integer
@ -52,6 +56,8 @@ MeshcoreModSettings: @@ -52,6 +56,8 @@ MeshcoreModSettings:
channelMute:
description: boolean
type: integer
minimum: 0
maximum: 1
nbParityBits:
description: Hamming FEC parity bits (LoRa)
type: integer
@ -64,40 +70,58 @@ MeshcoreModSettings: @@ -64,40 +70,58 @@ MeshcoreModSettings:
udpEnabled:
description: boolean 1 to enable forwarding messages via UDP else 0
type: integer
minimum: 0
maximum: 1
udpAddress:
description: UDP address to listen for messages to transmit on
type: string
udpPort:
description: UDP port to listen for messages to transmit on
type: integer
minimum: 1
maximum: 65535
invertRamps:
type: integer
minimum: 0
maximum: 1
description: >
Invert chirp ramps
* 0 - Normal chirp ramps (upchirps for preamble and payload)
* 1 - Inverted chirp ramps (downchirps for preamble and payload)
rgbColor:
type: integer
description: "Display color encoded as an RGB integer."
title:
type: string
description: "User-visible title."
streamIndex:
description: MIMO channel. Not relevant when connected to SI (single Rx).
type: integer
useReverseAPI:
description: Synchronize with reverse API (1 for yes, 0 for no)
type: integer
minimum: 0
maximum: 1
reverseAPIAddress:
type: string
description: "IPv4 address or host name of the reverse API peer."
reverseAPIPort:
type: integer
description: "TCP port of the reverse API peer."
minimum: 1
maximum: 65535
reverseAPIDeviceIndex:
type: integer
description: "Device-set index used by the reverse API peer."
reverseAPIChannelIndex:
type: integer
description: "Channel index used by the reverse API peer."
channelMarker:
$ref: "http://swgserver:8081/api/swagger/include/ChannelMarker.yaml#/ChannelMarker"
description: "Channel-marker display configuration."
rollupState:
$ref: "http://swgserver:8081/api/swagger/include/RollupState.yaml#/RollupState"
description: "Saved expanded or collapsed state of the GUI sections."
MeshcoreModReport:
description: MeshcoreMod
@ -108,6 +132,7 @@ MeshcoreModReport: @@ -108,6 +132,7 @@ MeshcoreModReport:
format: float
channelSampleRate:
type: integer
description: "Effective sample rate delivered to the channel in samples per second."
symbolTimeMs:
description: symbol duration (ms)
type: number
@ -122,6 +147,8 @@ MeshcoreModReport: @@ -122,6 +147,8 @@ MeshcoreModReport:
format: float
playing:
type: integer
minimum: 0
maximum: 1
description: >
Boolean - modulator is active (playing) including idle time
* 0 - Modulator not active
@ -132,6 +159,8 @@ MeshcoreModActions: @@ -132,6 +159,8 @@ MeshcoreModActions:
properties:
sendNow:
type: integer
minimum: 0
maximum: 1
description: >
Send packet immediately
* 0 - Do nothing

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

@ -4,8 +4,11 @@ MeshtasticDemodSettings: @@ -4,8 +4,11 @@ MeshtasticDemodSettings:
inputFrequencyOffset:
type: integer
format: int64
description: "Channel frequency offset from the device center frequency in Hz."
bandwidthIndex:
type: integer
minimum: 0
maximum: 26
description: >
standard bandwidths index:
* 0 - 375 Hz (384000 / 1024)
@ -37,12 +40,15 @@ MeshtasticDemodSettings: @@ -37,12 +40,15 @@ MeshtasticDemodSettings:
* 26 - 500000 Hz (500000 / 1)
spreadFactor:
type: integer
description: "Spread factor setting for Meshtastic demod."
deBits:
description: Low data rate optimize (DE) bits i.e. nb of FFT bins per effective symbol
type: integer
decodeActive:
description: boolean 1 to activate 0 to de-activate decoder
type: integer
minimum: 0
maximum: 1
eomSquelchTenths:
description: argmax squared magnitude is compared between current multiplied by this factor and maximum during decoding. This value is divided by 10
type: integer
@ -61,11 +67,17 @@ MeshtasticDemodSettings: @@ -61,11 +67,17 @@ MeshtasticDemodSettings:
sendViaUDP:
description: boolean 1 to send decoded message via UDP else 0
type: integer
minimum: 0
maximum: 1
sendJsonViaUDP:
description: boolean 1 to send decoded message as JSON via UDP else 0
type: integer
minimum: 0
maximum: 1
udpEnabled:
type: integer
minimum: 0
maximum: 1
description: >
Boolean - Send via UDP
* 0 - Do not send decoded messages via UDP
@ -76,36 +88,53 @@ MeshtasticDemodSettings: @@ -76,36 +88,53 @@ MeshtasticDemodSettings:
udpPort:
description: UDP destination port
type: integer
minimum: 1
maximum: 65535
invertRamps:
type: integer
minimum: 0
maximum: 1
description: >
Invert chirp ramps
* 0 - Normal chirp ramps (upchirps for preamble and payload)
* 1 - Inverted chirp ramps (downchirps for preamble and payload)
rgbColor:
type: integer
description: "Display color encoded as an RGB integer."
title:
type: string
description: "User-visible title."
streamIndex:
description: MIMO channel. Not relevant when connected to SI (single Rx).
type: integer
useReverseAPI:
description: Synchronize with reverse API (1 for yes, 0 for no)
type: integer
minimum: 0
maximum: 1
reverseAPIAddress:
type: string
description: "IPv4 address or host name of the reverse API peer."
reverseAPIPort:
type: integer
description: "TCP port of the reverse API peer."
minimum: 1
maximum: 65535
reverseAPIDeviceIndex:
type: integer
description: "Device-set index used by the reverse API peer."
reverseAPIChannelIndex:
type: integer
description: "Channel index used by the reverse API peer."
spectrumConfig:
$ref: "http://swgserver:8081/api/swagger/include/GLSpectrum.yaml#/GLSpectrum"
description: "Spectrum-display configuration."
channelMarker:
$ref: "http://swgserver:8081/api/swagger/include/ChannelMarker.yaml#/ChannelMarker"
description: "Channel-marker display configuration."
rollupState:
$ref: "http://swgserver:8081/api/swagger/include/RollupState.yaml#/RollupState"
description: "Saved expanded or collapsed state of the GUI sections."
MeshtasticDemodReport:
description: MeshtasticDemod
@ -128,6 +157,7 @@ MeshtasticDemodReport: @@ -128,6 +157,7 @@ MeshtasticDemodReport:
format: float
channelSampleRate:
type: integer
description: "Effective sample rate delivered to the channel in samples per second."
syncWord:
description: 2 bytes sync word (0..65535)
type: integer
@ -145,6 +175,8 @@ MeshtasticDemodReport: @@ -145,6 +175,8 @@ MeshtasticDemodReport:
type: integer
headerParityStatus:
type: integer
minimum: 0
maximum: 3
description: >
Header FEC parity status:
* 0 - Undefined
@ -156,6 +188,8 @@ MeshtasticDemodReport: @@ -156,6 +188,8 @@ MeshtasticDemodReport:
type: integer
payloadParityStatus:
type: integer
minimum: 0
maximum: 3
description: >
Payload FEC parity status:
* 0 - Undefined
@ -184,6 +218,8 @@ MeshtasticDemodReport: @@ -184,6 +218,8 @@ MeshtasticDemodReport:
type: string
decoding:
type: integer
minimum: 0
maximum: 1
description: >
Boolean - decoding status
* 0 - no decoding

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

@ -4,8 +4,11 @@ MeshtasticModSettings: @@ -4,8 +4,11 @@ MeshtasticModSettings:
inputFrequencyOffset:
type: integer
format: int64
description: "Channel frequency offset from the device center frequency in Hz."
bandwidthIndex:
type: integer
minimum: 0
maximum: 26
description: >
standard bandwidths index:
* 0 - 375 Hz (384000 / 1024)
@ -37,6 +40,7 @@ MeshtasticModSettings: @@ -37,6 +40,7 @@ MeshtasticModSettings:
* 26 - 500000 Hz (500000 / 1)
spreadFactor:
type: integer
description: "Spread factor setting for Meshtastic mod."
deBits:
description: Low data rate optimize (DE) bits i.e. nb of FFT bins per effective symbol
type: integer
@ -52,6 +56,8 @@ MeshtasticModSettings: @@ -52,6 +56,8 @@ MeshtasticModSettings:
channelMute:
description: boolean
type: integer
minimum: 0
maximum: 1
nbParityBits:
description: Hamming FEC parity bits (LoRa)
type: integer
@ -64,40 +70,58 @@ MeshtasticModSettings: @@ -64,40 +70,58 @@ MeshtasticModSettings:
udpEnabled:
description: boolean 1 to enable forwarding messages via UDP else 0
type: integer
minimum: 0
maximum: 1
udpAddress:
description: UDP address to listen for messages to transmit on
type: string
udpPort:
description: UDP port to listen for messages to transmit on
type: integer
minimum: 1
maximum: 65535
invertRamps:
type: integer
minimum: 0
maximum: 1
description: >
Invert chirp ramps
* 0 - Normal chirp ramps (upchirps for preamble and payload)
* 1 - Inverted chirp ramps (downchirps for preamble and payload)
rgbColor:
type: integer
description: "Display color encoded as an RGB integer."
title:
type: string
description: "User-visible title."
streamIndex:
description: MIMO channel. Not relevant when connected to SI (single Rx).
type: integer
useReverseAPI:
description: Synchronize with reverse API (1 for yes, 0 for no)
type: integer
minimum: 0
maximum: 1
reverseAPIAddress:
type: string
description: "IPv4 address or host name of the reverse API peer."
reverseAPIPort:
type: integer
description: "TCP port of the reverse API peer."
minimum: 1
maximum: 65535
reverseAPIDeviceIndex:
type: integer
description: "Device-set index used by the reverse API peer."
reverseAPIChannelIndex:
type: integer
description: "Channel index used by the reverse API peer."
channelMarker:
$ref: "http://swgserver:8081/api/swagger/include/ChannelMarker.yaml#/ChannelMarker"
description: "Channel-marker display configuration."
rollupState:
$ref: "http://swgserver:8081/api/swagger/include/RollupState.yaml#/RollupState"
description: "Saved expanded or collapsed state of the GUI sections."
MeshtasticModReport:
description: MeshtasticMod
@ -108,6 +132,7 @@ MeshtasticModReport: @@ -108,6 +132,7 @@ MeshtasticModReport:
format: float
channelSampleRate:
type: integer
description: "Effective sample rate delivered to the channel in samples per second."
symbolTimeMs:
description: symbol duration (ms)
type: number
@ -122,6 +147,8 @@ MeshtasticModReport: @@ -122,6 +147,8 @@ MeshtasticModReport:
format: float
playing:
type: integer
minimum: 0
maximum: 1
description: >
Boolean - modulator is active (playing) including idle time
* 0 - Modulator not active

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

@ -3,11 +3,14 @@ MetisMISOSettings: @@ -3,11 +3,14 @@ MetisMISOSettings:
properties:
title:
type: string
description: "User-visible title."
nbReceivers:
type: integer
description: Number of activated receivers
txEnable:
type: integer
minimum: 0
maximum: 1
description: >
Enable Tx
* 0 - disabled sends null payload to Metis device
@ -47,8 +50,11 @@ MetisMISOSettings: @@ -47,8 +50,11 @@ MetisMISOSettings:
txCenterFrequency:
type: integer
format: int64
description: "Transmit center frequency in Hz."
rxTransverterMode:
type: integer
minimum: 0
maximum: 1
description: >
Rx transverter activated
* 0 - disabled
@ -56,8 +62,11 @@ MetisMISOSettings: @@ -56,8 +62,11 @@ MetisMISOSettings:
rxTransverterDeltaFrequency:
type: integer
format: int64
description: "Receive frequency translation applied in transverter mode in Hz."
txTransverterMode:
type: integer
minimum: 0
maximum: 1
description: >
Tx transverter activated
* 0 - disabled
@ -65,8 +74,11 @@ MetisMISOSettings: @@ -65,8 +74,11 @@ MetisMISOSettings:
txTransverterDeltaFrequency:
type: integer
format: int64
description: "Transmit frequency translation applied in transverter mode in Hz."
iqOrder:
type: integer
minimum: 0
maximum: 1
description: >
I/Q samples order
* 0 - I then Q (direct)
@ -97,43 +109,57 @@ MetisMISOSettings: @@ -97,43 +109,57 @@ MetisMISOSettings:
type: integer
sampleRateIndex:
type: integer
description: "Selected sample rate index."
log2Decim:
type: integer
description: "Base-2 exponent of the software decimation factor; the output sample rate is divided by 2^log2Decim."
LOppmTenths:
type: integer
description: LO correction in tenths of ppm
preamp:
type: integer
minimum: 0
maximum: 1
description: >
Preamplifer
* 0 - disabled
* 1 - enabled
random:
type: integer
minimum: 0
maximum: 1
description: >
LT2208 Random
* 0 - disabled
* 1 - enabled
dither:
type: integer
minimum: 0
maximum: 1
description: >
LT2208 Dither
* 0 - disabled
* 1 - enabled
duplex:
type: integer
minimum: 0
maximum: 1
description: >
Duplex
* 0 - disabled
* 1 - enabled
dcBlock:
type: integer
minimum: 0
maximum: 1
description: >
DC block in software
* 0 - disabled
* 1 - enabled
iqCorrection:
type: integer
minimum: 0
maximum: 1
description: >
DC block in software
* 0 - disabled
@ -149,25 +175,36 @@ MetisMISOSettings: @@ -149,25 +175,36 @@ MetisMISOSettings:
description: The index of the stream that is used as source of the main spectrum
streamLock:
type: integer
minimum: 0
maximum: 1
description: >
Ties together the stream selection and spectrum source stream selections
* 0 - stream unlocked
* 1 - stream locked
rxLock:
type: integer
minimum: 0
maximum: 1
description: >
Ties together all Rx frequencies
* 0 - Rx frequencies untied
* 1 - Rx frequencies tied
useReverseAPI:
type: integer
minimum: 0
maximum: 1
description: >
Synchronize with reverse API
* 0 - disabled
* 1 - enabled
reverseAPIAddress:
type: string
description: "IPv4 address or host name of the reverse API peer."
reverseAPIPort:
type: integer
description: "TCP port of the reverse API peer."
minimum: 1
maximum: 65535
reverseAPIDeviceIndex:
type: integer
description: "Device-set index used by the reverse API peer."

22
swagger/sdrangel/api/swagger/include/MorseDecoder.yaml

@ -3,20 +3,30 @@ MorseDecoderSettings: @@ -3,20 +3,30 @@ MorseDecoderSettings:
properties:
title:
type: string
description: "User-visible title."
rgbColor:
type: integer
description: "Display color encoded as an RGB integer."
useReverseAPI:
type: integer
minimum: 0
maximum: 1
description: >
Synchronize with reverse API
* 1 - yes
* 0 - no
reverseAPIAddress:
type: string
description: "IPv4 address or host name of the reverse API peer."
reverseAPIPort:
type: integer
description: "TCP port of the reverse API peer."
minimum: 1
maximum: 65535
udpEnabled:
type: integer
minimum: 0
maximum: 1
description: >
Send decoded text via UDP
* 1 - send
@ -26,36 +36,48 @@ MorseDecoderSettings: @@ -26,36 +36,48 @@ MorseDecoderSettings:
description: Address to send text via UDP
udpPort:
type: integer
minimum: 1
maximum: 65535
description: Port to send text via UDP
logFiledName:
type: string
description: File to log the decoded text to
logEnabled:
type: integer
minimum: 0
maximum: 1
description: >
Log decoded text to file
* 1 - log
* 0 - do not log
auto:
type: integer
minimum: 0
maximum: 1
description: >
Auto detect CW pitch and keying speed
* 1 - auto detect
* 0 - use last values
showThreshold:
type: integer
minimum: 0
maximum: 1
description: >
Show GGMorse decoder threshold on the imaginary part of the scope trace
* 1 - show
* 0 - do not show
reverseAPIFeatureSetIndex:
type: integer
description: "Feature-set index used by the reverse API peer."
reverseAPIFeatureIndex:
type: integer
description: "Feature index used by the reverse API peer."
scopeConfig:
$ref: "http://swgserver:8081/api/swagger/include/GLScope.yaml#/GLScope"
description: "Oscilloscope-display configuration."
rollupState:
$ref: "http://swgserver:8081/api/swagger/include/RollupState.yaml#/RollupState"
description: "Saved expanded or collapsed state of the GUI sections."
MorseDecoderActions:
description: "Morse Decoder actions"

24
swagger/sdrangel/api/swagger/include/NFMDemod.yaml

@ -15,11 +15,13 @@ NFMDemodSettings: @@ -15,11 +15,13 @@ NFMDemodSettings:
format: float
fmDeviation:
type: integer
description: "FM frequency deviation in Hz."
squelchGate:
description: squelch gate in tens of ms
type: integer
deltaSquelch:
type: integer
description: "Delta squelch setting for Nfm demod."
squelch:
description: power squelch threshold in deci-bels
type: number
@ -27,38 +29,58 @@ NFMDemodSettings: @@ -27,38 +29,58 @@ NFMDemodSettings:
volume:
type: number
format: float
description: "Audio volume multiplier."
ctcssOn:
type: integer
description: "Ctcss on setting for Nfm demod."
highPass:
type: integer
description: "High pass setting for Nfm demod."
audioMute:
type: integer
description: "Mute audio output (1 muted, 0 unmuted)."
minimum: 0
maximum: 1
ctcssIndex:
type: integer
description: "Selected ctcss index."
rgbColor:
type: integer
description: "Display color encoded as an RGB integer."
title:
type: string
description: "User-visible title."
audioDeviceName:
type: string
description: "Name of the audio device to use."
streamIndex:
description: MIMO channel. Not relevant when connected to SI (single Rx).
type: integer
useReverseAPI:
description: Synchronize with reverse API (1 for yes, 0 for no)
type: integer
minimum: 0
maximum: 1
reverseAPIAddress:
type: string
description: "IPv4 address or host name of the reverse API peer."
reverseAPIPort:
type: integer
description: "TCP port of the reverse API peer."
minimum: 1
maximum: 65535
reverseAPIDeviceIndex:
type: integer
description: "Device-set index used by the reverse API peer."
reverseAPIChannelIndex:
type: integer
description: "Channel index used by the reverse API peer."
channelMarker:
$ref: "http://swgserver:8081/api/swagger/include/ChannelMarker.yaml#/ChannelMarker"
description: "Channel-marker display configuration."
rollupState:
$ref: "http://swgserver:8081/api/swagger/include/RollupState.yaml#/RollupState"
description: "Saved expanded or collapsed state of the GUI sections."
NFMDemodReport:
description: NFMDemod
@ -76,6 +98,8 @@ NFMDemodReport: @@ -76,6 +98,8 @@ NFMDemodReport:
type: integer
audioSampleRate:
type: integer
description: "Audio sample rate in samples per second."
channelSampleRate:
type: integer
description: "Effective sample rate delivered to the channel in samples per second."

41
swagger/sdrangel/api/swagger/include/NFMMod.yaml

@ -4,63 +4,91 @@ NFMModSettings: @@ -4,63 +4,91 @@ NFMModSettings:
inputFrequencyOffset:
type: integer
format: int64
description: "Channel frequency offset from the device center frequency in Hz."
rfBandwidth:
type: number
format: float
description: "RF bandwidth in Hz."
afBandwidth:
type: number
format: float
description: "Audio-frequency bandwidth in Hz."
fmDeviation:
type: number
format: float
description: "FM frequency deviation in Hz."
toneFrequency:
type: number
format: float
description: "Tone frequency in Hz."
volumeFactor:
type: number
format: float
description: "Volume factor setting for Nfm mod."
channelMute:
type: integer
description: "Mute the channel output (1 muted, 0 unmuted)."
minimum: 0
maximum: 1
playLoop:
type: integer
description: "Loop playback at end of file (1 enabled, 0 disabled)."
minimum: 0
maximum: 1
ctcssOn:
description: >
Enable CTCSS squelch (takes precedence on DCS)
* 0 - disabled
* 1 - enabled
type: integer
minimum: 0
maximum: 1
ctcssIndex:
type: integer
description: "Selected ctcss index."
dcsOn:
description: >
Enable DCS squelch (only if CTCSS is off)
* 0 - disabled
* 1 - enabled
type: integer
minimum: 0
maximum: 1
dcsCode:
type: integer
description: "Dcs code setting for Nfm mod."
dcsPositive:
description: >
Modulation direction:
* 0 - reverse or negative - 1 for 0 and -1 for 1
* 1 - direct or positive - -1 for 0 and 1 for 1
type: integer
minimum: 0
maximum: 1
rgbColor:
type: integer
description: "Display color encoded as an RGB integer."
title:
type: string
description: "User-visible title."
audioDeviceName:
type: string
description: "Name of the audio device to use."
modAFInput:
type: integer
description: "Audio-frequency modulation input selection."
preEmphasisOn:
type: integer
minimum: 0
maximum: 1
description: >
Activate pre-emphasis filter:
* 0 - inactive
* 1 - active
bpfOn:
type: integer
minimum: 0
maximum: 1
description: >
Activate audio highpass filter when no CTCSS nor DCS:
* 0 - inactive
@ -71,20 +99,31 @@ NFMModSettings: @@ -71,20 +99,31 @@ NFMModSettings:
useReverseAPI:
description: Synchronize with reverse API (1 for yes, 0 for no)
type: integer
minimum: 0
maximum: 1
reverseAPIAddress:
type: string
description: "IPv4 address or host name of the reverse API peer."
reverseAPIPort:
type: integer
description: "TCP port of the reverse API peer."
minimum: 1
maximum: 65535
reverseAPIDeviceIndex:
type: integer
description: "Device-set index used by the reverse API peer."
reverseAPIChannelIndex:
type: integer
description: "Channel index used by the reverse API peer."
cwKeyer:
$ref: "http://swgserver:8081/api/swagger/include/CWKeyer.yaml#/CWKeyerSettings"
description: "CW keyer configuration."
channelMarker:
$ref: "http://swgserver:8081/api/swagger/include/ChannelMarker.yaml#/ChannelMarker"
description: "Channel-marker display configuration."
rollupState:
$ref: "http://swgserver:8081/api/swagger/include/RollupState.yaml#/RollupState"
description: "Saved expanded or collapsed state of the GUI sections."
NFMModReport:
description: NFMMod
@ -95,5 +134,7 @@ NFMModReport: @@ -95,5 +134,7 @@ NFMModReport:
format: float
audioSampleRate:
type: integer
description: "Audio sample rate in samples per second."
channelSampleRate:
type: integer
description: "Effective sample rate delivered to the channel in samples per second."

27
swagger/sdrangel/api/swagger/include/NavtexDemod.yaml

@ -4,52 +4,78 @@ NavtexDemodSettings: @@ -4,52 +4,78 @@ NavtexDemodSettings:
inputFrequencyOffset:
type: integer
format: int64
description: "Channel frequency offset from the device center frequency in Hz."
rfBandwidth:
type: number
format: float
description: "RF bandwidth in Hz."
navArea:
type: integer
description: "Nav area setting for Navtex demod."
filterStation:
type: string
description: "Filter station setting for Navtex demod."
filterType:
type: string
description: "Filter type setting for Navtex demod."
udpEnabled:
description: "Whether to forward received messages to specified UDP port"
type: integer
minimum: 0
maximum: 1
udpAddress:
description: "UDP address to forward received messages to"
type: string
udpPort:
description: "UDP port to forward received messages to"
type: integer
minimum: 1
maximum: 65535
logFilename:
type: string
description: "Log file name or path."
logEnabled:
type: integer
description: "Enable logging to the configured file (1 enabled, 0 disabled)."
minimum: 0
maximum: 1
rgbColor:
type: integer
description: "Display color encoded as an RGB integer."
title:
type: string
description: "User-visible title."
streamIndex:
description: MIMO channel. Not relevant when connected to SI (single Rx).
type: integer
useReverseAPI:
description: Synchronize with reverse API (1 for yes, 0 for no)
type: integer
minimum: 0
maximum: 1
reverseAPIAddress:
type: string
description: "IPv4 address or host name of the reverse API peer."
reverseAPIPort:
type: integer
description: "TCP port of the reverse API peer."
minimum: 1
maximum: 65535
reverseAPIDeviceIndex:
type: integer
description: "Device-set index used by the reverse API peer."
reverseAPIChannelIndex:
type: integer
description: "Channel index used by the reverse API peer."
scopeConfig:
$ref: "http://swgserver:8081/api/swagger/include/GLScope.yaml#/GLScope"
description: "Oscilloscope-display configuration."
channelMarker:
$ref: "http://swgserver:8081/api/swagger/include/ChannelMarker.yaml#/ChannelMarker"
description: "Channel-marker display configuration."
rollupState:
$ref: "http://swgserver:8081/api/swagger/include/RollupState.yaml#/RollupState"
description: "Saved expanded or collapsed state of the GUI sections."
NavtexDemodReport:
description: ACARSDemod
@ -60,3 +86,4 @@ NavtexDemodReport: @@ -60,3 +86,4 @@ NavtexDemodReport:
format: float
channelSampleRate:
type: integer
description: "Effective sample rate delivered to the channel in samples per second."

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

@ -4,64 +4,92 @@ NoiseFigureSettings: @@ -4,64 +4,92 @@ NoiseFigureSettings:
inputFrequencyOffset:
type: integer
format: int64
description: "Channel frequency offset from the device center frequency in Hz."
fftSize:
type: integer
description: "FFT size in samples."
fftCount:
type: integer
description: "Number of fft events or items."
sweepSpec:
description: "(0 - Range, 1 - Step, 2 - List)"
type: integer
minimum: 0
maximum: 2
startValue:
type: number
format: float
description: "Start value setting for Noise figure."
stopValue:
type: number
format: float
description: "Stop value setting for Noise figure."
steps:
type: integer
description: "Steps setting for Noise figure."
step:
type: number
format: float
description: "Increment between adjacent supported values."
list:
type: string
description: "List setting for Noise figure."
setting:
description: "The device setting to sweep (E.g. centerFrequency or gain)"
type: string
visaDevice:
type: string
description: "Visa device setting for Noise figure."
powerOnSCPI:
type: string
description: "Power on scpi setting for Noise figure."
powerOffSCPI:
type: string
description: "Power off scpi setting for Noise figure."
powerOnCommand:
type: string
description: "Power on command setting for Noise figure."
powerOffCommand:
type: string
description: "Power off command setting for Noise figure."
powerDelay:
type: number
format: float
description: "Power delay setting for Noise figure."
rgbColor:
type: integer
description: "Display color encoded as an RGB integer."
title:
type: string
description: "User-visible title."
streamIndex:
description: MIMO channel. Not relevant when connected to SI (single Rx).
type: integer
useReverseAPI:
description: Synchronize with reverse API (1 for yes, 0 for no)
type: integer
minimum: 0
maximum: 1
reverseAPIAddress:
type: string
description: "IPv4 address or host name of the reverse API peer."
reverseAPIPort:
type: integer
description: "TCP port of the reverse API peer."
minimum: 1
maximum: 65535
reverseAPIDeviceIndex:
type: integer
description: "Device-set index used by the reverse API peer."
reverseAPIChannelIndex:
type: integer
description: "Channel index used by the reverse API peer."
channelMarker:
$ref: "http://swgserver:8081/api/swagger/include/ChannelMarker.yaml#/ChannelMarker"
description: "Channel-marker display configuration."
rollupState:
$ref: "http://swgserver:8081/api/swagger/include/RollupState.yaml#/RollupState"
description: "Saved expanded or collapsed state of the GUI sections."
NoiseFigureReport:
description: NoiseFigure
@ -72,3 +100,4 @@ NoiseFigureReport: @@ -72,3 +100,4 @@ NoiseFigureReport:
format: float
channelSampleRate:
type: integer
description: "Effective sample rate delivered to the channel in samples per second."

21
swagger/sdrangel/api/swagger/include/PERTester.yaml

@ -3,12 +3,16 @@ PERTesterSettings: @@ -3,12 +3,16 @@ PERTesterSettings:
properties:
packetCount:
type: integer
description: "Number of packet events or items."
interval:
type: number
format: float
description: "Interval setting for Per tester."
start:
description: "0 - immediately, 1 - on satellite AOS, 2 - on satellite mid pass"
type: integer
minimum: 0
maximum: 2
satellites:
description: "Satellite names to start test on"
type: array
@ -19,8 +23,10 @@ PERTesterSettings: @@ -19,8 +23,10 @@ PERTesterSettings:
type: string
ignoreLeadingBytes:
type: integer
description: "Ignore leading bytes setting for Per tester."
ignoreTrailingBytes:
type: integer
description: "Ignore trailing bytes setting for Per tester."
txUDPAddress:
description: "UDP address to sent packets to be transmitted to"
type: string
@ -35,27 +41,40 @@ PERTesterSettings: @@ -35,27 +41,40 @@ PERTesterSettings:
type: integer
title:
type: string
description: "User-visible title."
rgbColor:
type: integer
description: "Display color encoded as an RGB integer."
useReverseAPI:
description: Synchronize with reverse API (1 for yes, 0 for no)
type: integer
minimum: 0
maximum: 1
reverseAPIAddress:
type: string
description: "IPv4 address or host name of the reverse API peer."
reverseAPIPort:
type: integer
description: "TCP port of the reverse API peer."
minimum: 1
maximum: 65535
reverseAPIFeatureSetIndex:
type: integer
description: "Feature-set index used by the reverse API peer."
reverseAPIFeatureIndex:
type: integer
description: "Feature index used by the reverse API peer."
rollupState:
$ref: "http://swgserver:8081/api/swagger/include/RollupState.yaml#/RollupState"
description: "Saved expanded or collapsed state of the GUI sections."
PERTesterReport:
description: PERTester
properties:
runningState:
type: integer
minimum: 0
maximum: 3
description: >
Running state
* 0 - not started
@ -68,6 +87,8 @@ PERTesterActions: @@ -68,6 +87,8 @@ PERTesterActions:
properties:
run:
type: integer
minimum: 0
maximum: 1
description: >
Set the plugin running state
* 0 - idle

43
swagger/sdrangel/api/swagger/include/PSK31Mod.yaml

@ -4,21 +4,34 @@ PSK31ModSettings: @@ -4,21 +4,34 @@ PSK31ModSettings:
inputFrequencyOffset:
type: integer
format: int64
description: "Channel frequency offset from the device center frequency in Hz."
rfBandwidth:
type: integer
description: "RF bandwidth in Hz."
gain:
type: number
format: float
description: "Gain setting; units and available values depend on the device or plugin."
channelMute:
type: integer
description: "Mute the channel output (1 muted, 0 unmuted)."
minimum: 0
maximum: 1
repeat:
type: integer
description: "Repeat transmission or playback (1 enabled, 0 disabled)."
minimum: 0
maximum: 1
repeatCount:
type: integer
description: "Number of repetitions."
lpfTaps:
type: integer
description: "Number of low-pass FIR filter taps."
rfNoise:
type: integer
minimum: 0
maximum: 1
description: >
Boolean
* 0 - off
@ -28,6 +41,8 @@ PSK31ModSettings: @@ -28,6 +41,8 @@ PSK31ModSettings:
description: Text to transmit
pulseShaping:
type: integer
minimum: 0
maximum: 1
description: >
Boolean
* 0 - off
@ -35,43 +50,67 @@ PSK31ModSettings: @@ -35,43 +50,67 @@ PSK31ModSettings:
beta:
type: number
format: float
description: "Beta setting for Psk31 mod."
symbolSpan:
type: integer
description: "Symbol span setting for Psk31 mod."
prefixCRLF:
type: integer
description: "Enable prefix crlf (1 enabled, 0 disabled)."
minimum: 0
maximum: 1
postfixCRLF:
type: integer
description: "Enable postfix crlf (1 enabled, 0 disabled)."
minimum: 0
maximum: 1
udpEnabled:
description: "Whether to receive text to transmit on specified UDP port"
type: integer
minimum: 0
maximum: 1
udpAddress:
description: "UDP address to receive text to transmit via"
type: string
udpPort:
description: "UDP port to receive text to transmit via"
type: integer
minimum: 1
maximum: 65535
rgbColor:
type: integer
description: "Display color encoded as an RGB integer."
title:
type: string
description: "User-visible title."
streamIndex:
description: MIMO channel. Not relevant when connected to SI (single Rx).
type: integer
useReverseAPI:
description: Synchronize with reverse API (1 for yes, 0 for no)
type: integer
minimum: 0
maximum: 1
reverseAPIAddress:
type: string
description: "IPv4 address or host name of the reverse API peer."
reverseAPIPort:
type: integer
description: "TCP port of the reverse API peer."
minimum: 1
maximum: 65535
reverseAPIDeviceIndex:
type: integer
description: "Device-set index used by the reverse API peer."
reverseAPIChannelIndex:
type: integer
description: "Channel index used by the reverse API peer."
channelMarker:
$ref: "http://swgserver:8081/api/swagger/include/ChannelMarker.yaml#/ChannelMarker"
description: "Channel-marker display configuration."
rollupState:
$ref: "http://swgserver:8081/api/swagger/include/RollupState.yaml#/RollupState"
description: "Saved expanded or collapsed state of the GUI sections."
PSK31ModReport:
description: PSK31Mod
@ -82,18 +121,22 @@ PSK31ModReport: @@ -82,18 +121,22 @@ PSK31ModReport:
format: float
channelSampleRate:
type: integer
description: "Effective sample rate delivered to the channel in samples per second."
PSK31ModActions:
description: PSK31Mod
properties:
tx:
type: integer
minimum: 0
maximum: 1
description: >
Transmit current text
* 0 - Do nothing
* 1 - Transmit
payload:
type: object
description: "Payload data."
properties:
text:
description: PSK31 content to transmit

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

@ -4,6 +4,7 @@ PacketDemodSettings: @@ -4,6 +4,7 @@ PacketDemodSettings:
inputFrequencyOffset:
type: integer
format: int64
description: "Channel frequency offset from the device center frequency in Hz."
mode:
type: integer
description: >
@ -12,6 +13,7 @@ PacketDemodSettings: @@ -12,6 +13,7 @@ PacketDemodSettings:
rfBandwidth:
type: number
format: float
description: "RF bandwidth in Hz."
chase:
description: "Chase decoding depth. On CRC failure, retry inverting the n least confident symbols. 0 disables"
type: integer
@ -21,40 +23,63 @@ PacketDemodSettings: @@ -21,40 +23,63 @@ PacketDemodSettings:
udpEnabled:
description: "Whether to forward received packets to specified UDP port"
type: integer
minimum: 0
maximum: 1
udpAddress:
description: "UDP address to forward received packets to"
type: string
udpPort:
description: "UDP port to forward received packets to"
type: integer
minimum: 1
maximum: 65535
logFilename:
type: string
description: "Log file name or path."
logEnabled:
type: integer
description: "Enable logging to the configured file (1 enabled, 0 disabled)."
minimum: 0
maximum: 1
useFileTime:
type: integer
description: "Enable file time (1 enabled, 0 disabled)."
minimum: 0
maximum: 1
rgbColor:
type: integer
description: "Display color encoded as an RGB integer."
title:
type: string
description: "User-visible title."
streamIndex:
description: MIMO channel. Not relevant when connected to SI (single Rx).
type: integer
useReverseAPI:
description: Synchronize with reverse API (1 for yes, 0 for no)
type: integer
minimum: 0
maximum: 1
reverseAPIAddress:
type: string
description: "IPv4 address or host name of the reverse API peer."
reverseAPIPort:
type: integer
description: "TCP port of the reverse API peer."
minimum: 1
maximum: 65535
reverseAPIDeviceIndex:
type: integer
description: "Device-set index used by the reverse API peer."
reverseAPIChannelIndex:
type: integer
description: "Channel index used by the reverse API peer."
channelMarker:
$ref: "http://swgserver:8081/api/swagger/include/ChannelMarker.yaml#/ChannelMarker"
description: "Channel-marker display configuration."
rollupState:
$ref: "http://swgserver:8081/api/swagger/include/RollupState.yaml#/RollupState"
description: "Saved expanded or collapsed state of the GUI sections."
PacketDemodReport:
description: PacketDemod
@ -65,3 +90,4 @@ PacketDemodReport: @@ -65,3 +90,4 @@ PacketDemodReport:
format: float
channelSampleRate:
type: integer
description: "Effective sample rate delivered to the channel in samples per second."

76
swagger/sdrangel/api/swagger/include/PacketMod.yaml

@ -4,8 +4,11 @@ PacketModSettings: @@ -4,8 +4,11 @@ PacketModSettings:
inputFrequencyOffset:
type: integer
format: int64
description: "Channel frequency offset from the device center frequency in Hz."
modulation:
type: integer
minimum: 0
maximum: 1
description: >
Modulation mode
* 0 - AFSK
@ -16,103 +19,149 @@ PacketModSettings: @@ -16,103 +19,149 @@ PacketModSettings:
rfBandwidth:
type: number
format: float
description: "RF bandwidth in Hz."
fmDeviation:
type: number
format: float
description: "FM frequency deviation in Hz."
gain:
type: number
format: float
description: "Gain setting; units and available values depend on the device or plugin."
channelMute:
type: integer
description: "Mute the channel output (1 muted, 0 unmuted)."
minimum: 0
maximum: 1
repeat:
type: integer
description: "Repeat transmission or playback (1 enabled, 0 disabled)."
minimum: 0
maximum: 1
repeatDelay:
type: number
format: float
description: "Delay between repetitions."
repeatCount:
type: integer
description: "Number of repetitions."
rampUpBits:
type: integer
description: "Ramp up bits setting for Packet mod."
rampDownBits:
type: integer
description: "Ramp down bits setting for Packet mod."
rampRange:
type: integer
description: "Ramp range setting for Packet mod."
modulateWhileRamping:
type: integer
minimum: 0
maximum: 1
description: >
Boolean
* 0 - off
* 1 - on
markFrequency:
type: integer
description: "Mark frequency in Hz."
spaceFrequency:
type: integer
description: "Space frequency in Hz."
ax25PreFlags:
type: integer
description: "Ax25 pre flags setting for Packet mod."
ax25PostFlags:
type: integer
description: "Ax25 post flags setting for Packet mod."
ax25Control:
type: integer
description: "Ax25 control setting for Packet mod."
ax25PID:
type: integer
description: "Ax25 pid setting for Packet mod."
preEmphasis:
type: integer
description: "Pre emphasis setting for Packet mod."
preEmphasisTau:
type: number
format: float
description: "Pre emphasis tau setting for Packet mod."
preEmphasisHighFreq:
type: number
format: float
description: "Pre emphasis high freq setting for Packet mod."
lpfTaps:
type: integer
description: "Number of low-pass FIR filter taps."
bbNoise:
type: integer
minimum: 0
maximum: 1
description: >
Boolean
* 0 - off
* 1 - on
rfNoise:
type: integer
minimum: 0
maximum: 1
description: >
Boolean
* 0 - off
* 1 - on
writeToFile:
type: integer
minimum: 0
maximum: 1
description: >
Boolean
* 0 - off
* 1 - on
spectrumRate:
type: integer
description: "Spectrum rate setting for Packet mod."
callsign:
type: string
description: "Radio callsign."
to:
type: string
description: "To setting for Packet mod."
via:
type: string
description: "Via setting for Packet mod."
data:
type: string
description: "Payload data."
bpf:
type: integer
description: "Bpf setting for Packet mod."
bpfLowCutoff:
type: number
format: float
description: "Bpf low cutoff setting for Packet mod."
bpfHighCutoff:
type: number
format: float
description: "Bpf high cutoff setting for Packet mod."
bpfTaps:
type: integer
description: "Bpf taps setting for Packet mod."
scramble:
type: integer
minimum: 0
maximum: 1
description: >
Boolean
* 0 - off
* 1 - on
polynomial:
type: integer
description: "Polynomial setting for Packet mod."
pulseShaping:
type: integer
minimum: 0
maximum: 1
description: >
Boolean
* 0 - off
@ -120,39 +169,57 @@ PacketModSettings: @@ -120,39 +169,57 @@ PacketModSettings:
beta:
type: number
format: float
description: "Beta setting for Packet mod."
symbolSpan:
type: integer
description: "Symbol span setting for Packet mod."
udpEnabled:
description: "Whether to receive packets to transmit on specified UDP port"
type: integer
minimum: 0
maximum: 1
udpAddress:
description: "UDP address to receive packets to transmit via"
type: string
udpPort:
description: "UDP port to receive packets to transmit via"
type: integer
minimum: 1
maximum: 65535
rgbColor:
type: integer
description: "Display color encoded as an RGB integer."
title:
type: string
description: "User-visible title."
streamIndex:
description: MIMO channel. Not relevant when connected to SI (single Rx).
type: integer
useReverseAPI:
description: Synchronize with reverse API (1 for yes, 0 for no)
type: integer
minimum: 0
maximum: 1
reverseAPIAddress:
type: string
description: "IPv4 address or host name of the reverse API peer."
reverseAPIPort:
type: integer
description: "TCP port of the reverse API peer."
minimum: 1
maximum: 65535
reverseAPIDeviceIndex:
type: integer
description: "Device-set index used by the reverse API peer."
reverseAPIChannelIndex:
type: integer
description: "Channel index used by the reverse API peer."
channelMarker:
$ref: "http://swgserver:8081/api/swagger/include/ChannelMarker.yaml#/ChannelMarker"
description: "Channel-marker display configuration."
rollupState:
$ref: "http://swgserver:8081/api/swagger/include/RollupState.yaml#/RollupState"
description: "Saved expanded or collapsed state of the GUI sections."
PacketModReport:
description: PacketMod
@ -163,26 +230,35 @@ PacketModReport: @@ -163,26 +230,35 @@ PacketModReport:
format: float
audioSampleRate:
type: integer
description: "Audio sample rate in samples per second."
channelSampleRate:
type: integer
description: "Effective sample rate delivered to the channel in samples per second."
PacketModActions:
description: PacketMod
properties:
tx:
type: integer
minimum: 0
maximum: 1
description: >
Transmit with current data
* 0 - Do nothing
* 1 - Transmit
payload:
type: object
description: "Payload data."
properties:
callsign:
type: string
description: "Radio callsign."
to:
type: string
description: "To action parameter."
via:
type: string
description: "Via action parameter."
data:
type: string
description: "Payload data."

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

@ -3,6 +3,8 @@ PagerDemodSettings: @@ -3,6 +3,8 @@ PagerDemodSettings:
properties:
decode:
type: integer
minimum: 0
maximum: 4
description: >
Decode mode
* 0 - Standard
@ -12,6 +14,8 @@ PagerDemodSettings: @@ -12,6 +14,8 @@ PagerDemodSettings:
* 4 - Heuristic
reverse:
type: integer
minimum: 0
maximum: 1
description: >
Whether characters should be reversed, for right-to-left reading order
* 0 - Straight
@ -19,49 +23,73 @@ PagerDemodSettings: @@ -19,49 +23,73 @@ PagerDemodSettings:
inputFrequencyOffset:
type: integer
format: int64
description: "Channel frequency offset from the device center frequency in Hz."
rfBandwidth:
type: number
format: float
description: "RF bandwidth in Hz."
fmDeviation:
type: number
format: float
description: "FM frequency deviation in Hz."
udpEnabled:
description: "Whether to forward received messages to specified UDP port"
type: integer
minimum: 0
maximum: 1
udpAddress:
description: "UDP address to forward received messages to"
type: string
udpPort:
description: "UDP port to forward received messages to"
type: integer
minimum: 1
maximum: 65535
logFilename:
type: string
description: "Log file name or path."
logEnabled:
type: integer
description: "Enable logging to the configured file (1 enabled, 0 disabled)."
minimum: 0
maximum: 1
rgbColor:
type: integer
description: "Display color encoded as an RGB integer."
title:
type: string
description: "User-visible title."
streamIndex:
description: MIMO channel. Not relevant when connected to SI (single Rx).
type: integer
useReverseAPI:
description: Synchronize with reverse API (1 for yes, 0 for no)
type: integer
minimum: 0
maximum: 1
reverseAPIAddress:
type: string
description: "IPv4 address or host name of the reverse API peer."
reverseAPIPort:
type: integer
description: "TCP port of the reverse API peer."
minimum: 1
maximum: 65535
reverseAPIDeviceIndex:
type: integer
description: "Device-set index used by the reverse API peer."
reverseAPIChannelIndex:
type: integer
description: "Channel index used by the reverse API peer."
scopeConfig:
$ref: "http://swgserver:8081/api/swagger/include/GLScope.yaml#/GLScope"
description: "Oscilloscope-display configuration."
channelMarker:
$ref: "http://swgserver:8081/api/swagger/include/ChannelMarker.yaml#/ChannelMarker"
description: "Channel-marker display configuration."
rollupState:
$ref: "http://swgserver:8081/api/swagger/include/RollupState.yaml#/RollupState"
description: "Saved expanded or collapsed state of the GUI sections."
PagerDemodReport:
description: PagerDemod
@ -72,3 +100,4 @@ PagerDemodReport: @@ -72,3 +100,4 @@ PagerDemodReport:
format: float
channelSampleRate:
type: integer
description: "Effective sample rate delivered to the channel in samples per second."

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

@ -3,15 +3,20 @@ PerseusSettings: @@ -3,15 +3,20 @@ PerseusSettings:
properties:
title:
type: string
description: "User-visible title."
centerFrequency:
type: integer
format: int64
description: "Device center frequency in Hz."
LOppmTenths:
type: integer
description: "Local-oscillator correction in tenths of a part per million."
devSampleRateIndex:
type: integer
description: "Selected dev sample rate index."
log2Decim:
type: integer
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)
type: integer
@ -23,11 +28,17 @@ PerseusSettings: @@ -23,11 +28,17 @@ PerseusSettings:
type: integer
transverterMode:
type: integer
description: "Enable transverter frequency translation (1 enabled, 0 disabled)."
minimum: 0
maximum: 1
transverterDeltaFrequency:
type: integer
format: int64
description: "Frequency translation applied in transverter mode in Hz."
iqOrder:
type: integer
minimum: 0
maximum: 1
description: >
IQ samples order
* 0 - Q then I (swapped)
@ -38,17 +49,25 @@ PerseusSettings: @@ -38,17 +49,25 @@ PerseusSettings:
useReverseAPI:
description: Synchronize with reverse API (1 for yes, 0 for no)
type: integer
minimum: 0
maximum: 1
reverseAPIAddress:
type: string
description: "IPv4 address or host name of the reverse API peer."
reverseAPIPort:
type: integer
description: "TCP port of the reverse API peer."
minimum: 1
maximum: 65535
reverseAPIDeviceIndex:
type: integer
description: "Device-set index used by the reverse API peer."
PerseusReport:
description: Perseus
properties:
sampleRates:
type: array
description: "Supported sample rates in samples per second."
items:
$ref: "http://swgserver:8081/api/swagger/include/Structs.yaml#/SampleRate"

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

@ -3,16 +3,22 @@ PlutoSdrInputSettings: @@ -3,16 +3,22 @@ PlutoSdrInputSettings:
properties:
title:
type: string
description: "User-visible title."
centerFrequency:
type: integer
format: int64
description: "Device center frequency in Hz."
devSampleRate:
type: integer
description: "Device I/Q sample rate in samples per second before software decimation or interpolation."
LOppmTenths:
type: integer
description: "Local-oscillator correction in tenths of a part per million."
lpfFIREnable:
description: Low pass FIR filter enable (1 if enabled else 0)
type: integer
minimum: 0
maximum: 1
lpfFIRBW:
description: digital lowpass FIR filter bandwidth (Hz)
type: integer
@ -27,16 +33,32 @@ PlutoSdrInputSettings: @@ -27,16 +33,32 @@ PlutoSdrInputSettings:
type: integer
dcBlock:
type: integer
description: "Enable DSP DC-offset correction (1 enabled, 0 disabled)."
minimum: 0
maximum: 1
iqCorrection:
type: integer
description: "Enable I/Q imbalance correction (1 enabled, 0 disabled)."
minimum: 0
maximum: 1
hwBBDCBlock:
type: integer
description: "Enable hw bbdc block (1 enabled, 0 disabled)."
minimum: 0
maximum: 1
hwRFDCBlock:
type: integer
description: "Enable hw rfdc block (1 enabled, 0 disabled)."
minimum: 0
maximum: 1
hwIQCorrection:
type: integer
description: "Enable hw i/q correction (1 enabled, 0 disabled)."
minimum: 0
maximum: 1
log2Decim:
type: integer
description: "Base-2 exponent of the software decimation factor; the output sample rate is divided by 2^log2Decim."
lpfBW:
description: Analog lowpass filter bandwidth (Hz)
type: integer
@ -45,15 +67,23 @@ PlutoSdrInputSettings: @@ -45,15 +67,23 @@ PlutoSdrInputSettings:
type: integer
antennaPath:
type: integer
description: "Selected RF antenna path."
gainMode:
type: integer
description: "Gain-control mode selection."
transverterMode:
type: integer
description: "Enable transverter frequency translation (1 enabled, 0 disabled)."
minimum: 0
maximum: 1
transverterDeltaFrequency:
type: integer
format: int64
description: "Frequency translation applied in transverter mode in Hz."
iqOrder:
type: integer
minimum: 0
maximum: 1
description: >
IQ samples order
* 0 - Q then I (swapped)
@ -61,28 +91,41 @@ PlutoSdrInputSettings: @@ -61,28 +91,41 @@ PlutoSdrInputSettings:
useReverseAPI:
description: Synchronize with reverse API (1 for yes, 0 for no)
type: integer
minimum: 0
maximum: 1
reverseAPIAddress:
type: string
description: "IPv4 address or host name of the reverse API peer."
reverseAPIPort:
type: integer
description: "TCP port of the reverse API peer."
minimum: 1
maximum: 65535
reverseAPIDeviceIndex:
type: integer
description: "Device-set index used by the reverse API peer."
PlutoSdrOutputSettings:
description: PlutoSDR
properties:
title:
type: string
description: "User-visible title."
centerFrequency:
type: integer
format: int64
description: "Device center frequency in Hz."
devSampleRate:
type: integer
description: "Device I/Q sample rate in samples per second before software decimation or interpolation."
LOppmTenths:
type: integer
description: "Local-oscillator correction in tenths of a part per million."
lpfFIREnable:
description: Low pass FIR filter enable (1 if enabled else 0)
type: integer
minimum: 0
maximum: 1
lpfFIRBW:
description: digital lowpass FIR filter bandwidth (Hz)
type: integer
@ -94,6 +137,7 @@ PlutoSdrOutputSettings: @@ -94,6 +137,7 @@ PlutoSdrOutputSettings:
type: integer
log2Interp:
type: integer
description: "Base-2 exponent of the software interpolation factor; the output sample rate is multiplied by 2^log2Interp."
lpfBW:
description: Analog lowpass filter bandwidth (Hz)
type: integer
@ -102,53 +146,88 @@ PlutoSdrOutputSettings: @@ -102,53 +146,88 @@ PlutoSdrOutputSettings:
type: integer
antennaPath:
type: integer
description: "Selected RF antenna path."
transverterMode:
type: integer
description: "Enable transverter frequency translation (1 enabled, 0 disabled)."
minimum: 0
maximum: 1
transverterDeltaFrequency:
type: integer
format: int64
description: "Frequency translation applied in transverter mode in Hz."
useReverseAPI:
description: Synchronize with reverse API (1 for yes, 0 for no)
type: integer
minimum: 0
maximum: 1
reverseAPIAddress:
type: string
description: "IPv4 address or host name of the reverse API peer."
reverseAPIPort:
type: integer
description: "TCP port of the reverse API peer."
minimum: 1
maximum: 65535
reverseAPIDeviceIndex:
type: integer
description: "Device-set index used by the reverse API peer."
PlutoSdrMIMOSettings:
description: PlutoSDR
properties:
title:
type: string
description: "User-visible title."
devSampleRate:
type: integer
description: "Device I/Q sample rate in samples per second before software decimation or interpolation."
LOppmTenths:
type: integer
description: "Local-oscillator correction in tenths of a part per million."
rxCenterFrequency:
type: integer
format: int64
description: "Receive center frequency in Hz."
dcBlock:
type: integer
description: "Enable DSP DC-offset correction (1 enabled, 0 disabled)."
minimum: 0
maximum: 1
iqCorrection:
type: integer
description: "Enable I/Q imbalance correction (1 enabled, 0 disabled)."
minimum: 0
maximum: 1
hwBBDCBlock:
type: integer
description: "Enable hw bbdc block (1 enabled, 0 disabled)."
minimum: 0
maximum: 1
hwRFDCBlock:
type: integer
description: "Enable hw rfdc block (1 enabled, 0 disabled)."
minimum: 0
maximum: 1
hwIQCorrection:
type: integer
description: "Enable hw i/q correction (1 enabled, 0 disabled)."
minimum: 0
maximum: 1
fcPosRx:
description: 0=Infra 1=Supra 2=Center
type: integer
rxTransverterMode:
type: integer
description: "Receive transverter mode setting for Pluto sdr MIMO."
rxTransverterDeltaFrequency:
type: integer
format: int64
description: "Receive frequency translation applied in transverter mode in Hz."
iqOrder:
type: integer
minimum: 0
maximum: 1
description: >
IQ samples order
* 0 - Q then I (swapped)
@ -170,31 +249,39 @@ PlutoSdrMIMOSettings: @@ -170,31 +249,39 @@ PlutoSdrMIMOSettings:
type: integer
log2Decim:
type: integer
description: "Base-2 exponent of the software decimation factor; the output sample rate is divided by 2^log2Decim."
rx0Gain:
description: Hardware gain
type: integer
rx0GainMode:
type: integer
description: "Rx0 gain mode setting for Pluto sdr MIMO."
rx0AntennaPath:
type: integer
description: "Rx0 antenna path setting for Pluto sdr MIMO."
rx1Gain:
description: Hardware gain
type: integer
rx1GainMode:
type: integer
description: "Rx1 gain mode setting for Pluto sdr MIMO."
rx1AntennaPath:
type: integer
description: "Rx1 antenna path setting for Pluto sdr MIMO."
txCenterFrequency:
type: integer
format: int64
description: "Transmit center frequency in Hz."
fcPosTx:
description: 0=Infra 1=Supra 2=Center
type: integer
txTransverterMode:
type: integer
description: "Transmit transverter mode setting for Pluto sdr MIMO."
txTransverterDeltaFrequency:
type: integer
format: int64
description: "Transmit frequency translation applied in transverter mode in Hz."
lpfBWTx:
description: Analog lowpass filter bandwidth (Hz)
type: integer
@ -212,66 +299,91 @@ PlutoSdrMIMOSettings: @@ -212,66 +299,91 @@ PlutoSdrMIMOSettings:
type: integer
log2Interp:
type: integer
description: "Base-2 exponent of the software interpolation factor; the output sample rate is multiplied by 2^log2Interp."
tx0Att:
description: Hardware attenuator gain in decibel fourths (negative)
type: integer
tx0AntennaPath:
type: integer
description: "Tx0 antenna path setting for Pluto sdr MIMO."
tx1Att:
description: Hardware attenuator gain in decibel fourths (negative)
type: integer
tx1AntennaPath:
type: integer
description: "Tx1 antenna path setting for Pluto sdr MIMO."
useReverseAPI:
description: Synchronize with reverse API (1 for yes, 0 for no)
type: integer
minimum: 0
maximum: 1
reverseAPIAddress:
type: string
description: "IPv4 address or host name of the reverse API peer."
reverseAPIPort:
type: integer
description: "TCP port of the reverse API peer."
minimum: 1
maximum: 65535
reverseAPIDeviceIndex:
type: integer
description: "Device-set index used by the reverse API peer."
PlutoSdrInputReport:
description: PlutoSDR
properties:
adcRate:
type: integer
description: "ADC sample rate in samples per second."
rssi:
type: string
description: "Received signal strength indication."
gainDB:
type: integer
description: "Gain dB in dB."
temperature:
type: number
format: float
description: "Reported device temperature."
PlutoSdrOutputReport:
description: PlutoSDR
properties:
dacRate:
type: integer
description: "DAC sample rate in samples per second."
rssi:
type: string
description: "Received signal strength indication."
temperature:
type: number
format: float
description: "Reported device temperature."
PlutoSdrMIMOReport:
description: PlutoSDR
properties:
adcRate:
type: integer
description: "ADC sample rate in samples per second."
dacRate:
type: integer
description: "DAC sample rate in samples per second."
rx0GainDB:
type: integer
description: "Rx0 gain dB in dB."
rx1GainDB:
type: integer
description: "Rx1 gain dB in dB."
rssiRx0:
type: string
description: "Reported rssi rx0."
rssiRx1:
type: string
description: "Reported rssi rx1."
rssiTx0:
type: string
description: "Reported rssi tx0."
rssiTx1:
type: string
description: "Reported rssi tx1."

Some files were not shown because too many files have changed in this diff Show More

Loading…
Cancel
Save