From 3f6ddbe73c30056cbf08fca4294e623a920d2ffc Mon Sep 17 00:00:00 2001 From: Jon Beniston Date: Sun, 6 Sep 2026 08:13:08 +0100 Subject: [PATCH] Add descriptions and minimum and maximum values --- .../api/swagger/include/ADSBDemod.yaml | 59 ++++++ swagger/sdrangel/api/swagger/include/AFC.yaml | 23 +++ swagger/sdrangel/api/swagger/include/AIS.yaml | 13 ++ .../api/swagger/include/AISDemod.yaml | 28 +++ .../sdrangel/api/swagger/include/AISMod.yaml | 56 ++++++ .../sdrangel/api/swagger/include/AMBE.yaml | 11 ++ .../sdrangel/api/swagger/include/AMDemod.yaml | 19 ++ .../sdrangel/api/swagger/include/AMMod.yaml | 27 +++ .../sdrangel/api/swagger/include/APRS.yaml | 33 ++++ .../api/swagger/include/APTDemod.yaml | 14 ++ .../api/swagger/include/ATVDemod.yaml | 34 ++++ .../sdrangel/api/swagger/include/ATVMod.yaml | 36 ++++ .../api/swagger/include/AaroniaRTSA.yaml | 20 +++ .../sdrangel/api/swagger/include/Airspy.yaml | 30 ++++ .../api/swagger/include/AirspyHF.yaml | 32 ++++ .../include/AndroidSDRDriverInput.yaml | 31 ++++ .../api/swagger/include/AntennaTools.yaml | 17 ++ .../api/swagger/include/AudioCATSISO.yaml | 47 +++++ .../api/swagger/include/AudioInput.yaml | 17 ++ .../api/swagger/include/AudioOutput.yaml | 11 ++ .../api/swagger/include/BFMDemod.yaml | 56 ++++++ .../swagger/include/BeamSteeringCWMod.yaml | 15 ++ .../api/swagger/include/BladeRF1.yaml | 44 +++++ .../api/swagger/include/BladeRF2.yaml | 108 +++++++++++ .../sdrangel/api/swagger/include/CWKeyer.yaml | 2 + .../api/swagger/include/ChannelActions.yaml | 12 ++ .../api/swagger/include/ChannelAnalyzer.yaml | 35 ++++ .../api/swagger/include/ChannelMarker.yaml | 2 + .../api/swagger/include/ChannelPower.yaml | 15 ++ .../api/swagger/include/ChannelReport.yaml | 56 ++++++ .../api/swagger/include/ChannelSettings.yaml | 66 +++++++ .../api/swagger/include/ChirpChatDemod.yaml | 40 +++++ .../api/swagger/include/ChirpChatMod.yaml | 31 ++++ .../sdrangel/api/swagger/include/Command.yaml | 10 +- .../api/swagger/include/DABDemod.yaml | 20 +++ .../api/swagger/include/DATVDemod.yaml | 42 +++++ .../sdrangel/api/swagger/include/DATVMod.yaml | 28 +++ .../sdrangel/api/swagger/include/DOA2.yaml | 15 ++ .../api/swagger/include/DSCDemod.yaml | 33 ++++ .../api/swagger/include/DSDDemod.yaml | 37 ++++ .../api/swagger/include/DemodAnalyzer.yaml | 16 ++ .../api/swagger/include/Denoiser.yaml | 19 ++ .../api/swagger/include/DeviceActions.yaml | 1 + .../api/swagger/include/DeviceReports.yaml | 33 ++++ .../api/swagger/include/DeviceSettings.yaml | 47 +++++ .../api/swagger/include/EndOfTrainDemod.yaml | 27 +++ .../sdrangel/api/swagger/include/FCDPro.yaml | 40 +++++ .../api/swagger/include/FCDProPlus.yaml | 29 +++ .../api/swagger/include/FT8Demod.yaml | 37 ++++ .../api/swagger/include/FeatureActions.yaml | 18 ++ .../api/swagger/include/FeatureReport.yaml | 16 ++ .../api/swagger/include/FeatureSetPreset.yaml | 4 + .../api/swagger/include/FeatureSettings.yaml | 25 +++ .../api/swagger/include/FileInput.yaml | 9 + .../api/swagger/include/FileOutput.yaml | 11 ++ .../api/swagger/include/FileSink.yaml | 27 +++ .../api/swagger/include/FileSource.yaml | 18 ++ .../api/swagger/include/FreeDVDemod.yaml | 23 +++ .../api/swagger/include/FreeDVMod.yaml | 30 ++++ .../api/swagger/include/FreqDisplay.yaml | 24 +++ .../api/swagger/include/FreqScanner.yaml | 32 ++++ .../api/swagger/include/FreqTracker.yaml | 17 ++ .../sdrangel/api/swagger/include/GLScope.yaml | 11 ++ .../api/swagger/include/GLSpectrum.yaml | 58 ++++++ .../api/swagger/include/GS232Controller.yaml | 15 ++ .../sdrangel/api/swagger/include/HackRF.yaml | 53 ++++++ .../sdrangel/api/swagger/include/HeatMap.yaml | 22 +++ .../swagger/include/IEEE_802_15_4_Mod.yaml | 49 +++++ .../api/swagger/include/ILSDemod.yaml | 43 +++++ .../api/swagger/include/InmarsatDemod.yaml | 29 +++ .../api/swagger/include/Interferometer.yaml | 18 ++ .../swagger/include/JogdialController.yaml | 11 ++ .../sdrangel/api/swagger/include/KiwiSDR.yaml | 22 +++ .../sdrangel/api/swagger/include/LimeRFE.yaml | 45 +++++ .../sdrangel/api/swagger/include/LimeSdr.yaml | 169 ++++++++++++++++++ .../api/swagger/include/LocalInput.yaml | 16 ++ .../api/swagger/include/LocalOutput.yaml | 10 ++ .../api/swagger/include/LocalSink.yaml | 25 +++ .../api/swagger/include/LocalSource.yaml | 16 ++ .../api/swagger/include/M17Demod.yaml | 31 ++++ .../sdrangel/api/swagger/include/M17Mod.yaml | 41 +++++ .../api/swagger/include/MCPServer.yaml | 75 ++++++++ swagger/sdrangel/api/swagger/include/Map.yaml | 48 +++++ .../api/swagger/include/MeshcoreDemod.yaml | 36 ++++ .../api/swagger/include/MeshcoreMod.yaml | 29 +++ .../api/swagger/include/MeshtasticDemod.yaml | 36 ++++ .../api/swagger/include/MeshtasticMod.yaml | 27 +++ .../api/swagger/include/MetisMISO.yaml | 37 ++++ .../api/swagger/include/MorseDecoder.yaml | 22 +++ .../api/swagger/include/NFMDemod.yaml | 24 +++ .../sdrangel/api/swagger/include/NFMMod.yaml | 41 +++++ .../api/swagger/include/NavtexDemod.yaml | 27 +++ .../api/swagger/include/NoiseFigure.yaml | 29 +++ .../api/swagger/include/PERTester.yaml | 21 +++ .../api/swagger/include/PSK31Mod.yaml | 43 +++++ .../api/swagger/include/PacketDemod.yaml | 26 +++ .../api/swagger/include/PacketMod.yaml | 76 ++++++++ .../api/swagger/include/PagerDemod.yaml | 29 +++ .../sdrangel/api/swagger/include/Perseus.yaml | 19 ++ .../api/swagger/include/PlutoSdr.yaml | 112 ++++++++++++ .../api/swagger/include/Preferences.yaml | 11 ++ .../sdrangel/api/swagger/include/Preset.yaml | 15 ++ .../api/swagger/include/RTTYDemod.yaml | 38 ++++ .../sdrangel/api/swagger/include/RTTYMod.yaml | 54 ++++++ .../api/swagger/include/RadioAstronomy.yaml | 31 ++++ .../api/swagger/include/RadioClock.yaml | 21 +++ .../api/swagger/include/Radiosonde.yaml | 13 ++ .../api/swagger/include/RadiosondeDemod.yaml | 29 +++ .../api/swagger/include/RemoteInput.yaml | 27 +++ .../api/swagger/include/RemoteOutput.yaml | 19 ++ .../api/swagger/include/RemoteSink.yaml | 16 ++ .../api/swagger/include/RemoteSource.yaml | 16 ++ .../api/swagger/include/RemoteTCPInput.yaml | 46 +++++ .../api/swagger/include/RemoteTCPSink.yaml | 19 ++ .../api/swagger/include/RigCtlServer.yaml | 21 +++ .../api/swagger/include/RollupState.yaml | 5 + .../sdrangel/api/swagger/include/RtlSdr.yaml | 49 +++++ .../sdrangel/api/swagger/include/SDRPlay.yaml | 32 ++++ .../api/swagger/include/SDRPlayV3.yaml | 40 +++++ swagger/sdrangel/api/swagger/include/SID.yaml | 16 ++ .../api/swagger/include/SSBDemod.yaml | 32 ++++ .../sdrangel/api/swagger/include/SSBMod.yaml | 39 ++++ .../api/swagger/include/SatelliteTracker.yaml | 30 ++++ .../api/swagger/include/SigMFFileInput.yaml | 23 +++ .../api/swagger/include/SigMFFileSink.yaml | 27 +++ .../api/swagger/include/SimplePTT.yaml | 34 ++++ .../sdrangel/api/swagger/include/SkyMap.yaml | 26 +++ .../api/swagger/include/SoapySDR.yaml | 102 +++++++++++ .../api/swagger/include/StarTracker.yaml | 22 +++ .../sdrangel/api/swagger/include/Structs.yaml | 22 +++ .../sdrangel/api/swagger/include/TestMI.yaml | 24 +++ .../api/swagger/include/TestMOSync.yaml | 4 + .../api/swagger/include/TestSource.yaml | 24 +++ .../sdrangel/api/swagger/include/UDPSink.yaml | 33 ++++ .../api/swagger/include/UDPSource.yaml | 40 +++++ .../sdrangel/api/swagger/include/USRP.yaml | 58 ++++++ .../sdrangel/api/swagger/include/User.yaml | 2 + .../api/swagger/include/VORDemod.yaml | 27 +++ .../api/swagger/include/VORDemodMC.yaml | 18 ++ .../api/swagger/include/VORLocalizer.yaml | 19 ++ .../sdrangel/api/swagger/include/WDSPRx.yaml | 73 ++++++++ .../api/swagger/include/WFMDemod.yaml | 22 +++ .../sdrangel/api/swagger/include/WFMMod.yaml | 29 +++ .../sdrangel/api/swagger/include/Xtrx.yaml | 81 +++++++++ 144 files changed, 4497 insertions(+), 1 deletion(-) create mode 100644 swagger/sdrangel/api/swagger/include/MCPServer.yaml diff --git a/swagger/sdrangel/api/swagger/include/ADSBDemod.yaml b/swagger/sdrangel/api/swagger/include/ADSBDemod.yaml index 2cb830b88..900fa1f66 100644 --- a/swagger/sdrangel/api/swagger/include/ADSBDemod.yaml +++ b/swagger/sdrangel/api/swagger/include/ADSBDemod.yaml @@ -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: 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: 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: 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: 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: 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 diff --git a/swagger/sdrangel/api/swagger/include/AFC.yaml b/swagger/sdrangel/api/swagger/include/AFC.yaml index 880ee9d1f..e7d29db0c 100644 --- a/swagger/sdrangel/api/swagger/include/AFC.yaml +++ b/swagger/sdrangel/api/swagger/include/AFC.yaml @@ -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: 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: 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: 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 diff --git a/swagger/sdrangel/api/swagger/include/AIS.yaml b/swagger/sdrangel/api/swagger/include/AIS.yaml index e13f721f8..e04246e57 100644 --- a/swagger/sdrangel/api/swagger/include/AIS.yaml +++ b/swagger/sdrangel/api/swagger/include/AIS.yaml @@ -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 diff --git a/swagger/sdrangel/api/swagger/include/AISDemod.yaml b/swagger/sdrangel/api/swagger/include/AISDemod.yaml index fc528e9aa..75a5193d1 100644 --- a/swagger/sdrangel/api/swagger/include/AISDemod.yaml +++ b/swagger/sdrangel/api/swagger/include/AISDemod.yaml @@ -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: 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: format: float channelSampleRate: type: integer + description: "Effective sample rate delivered to the channel in samples per second." diff --git a/swagger/sdrangel/api/swagger/include/AISMod.yaml b/swagger/sdrangel/api/swagger/include/AISMod.yaml index 2e593b1ad..3fdf42c11 100644 --- a/swagger/sdrangel/api/swagger/include/AISMod.yaml +++ b/swagger/sdrangel/api/swagger/include/AISMod.yaml @@ -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: 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: * 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: 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: 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." diff --git a/swagger/sdrangel/api/swagger/include/AMBE.yaml b/swagger/sdrangel/api/swagger/include/AMBE.yaml index d696083a0..f12fb0092 100644 --- a/swagger/sdrangel/api/swagger/include/AMBE.yaml +++ b/swagger/sdrangel/api/swagger/include/AMBE.yaml @@ -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 diff --git a/swagger/sdrangel/api/swagger/include/AMDemod.yaml b/swagger/sdrangel/api/swagger/include/AMDemod.yaml index 472886b3a..b3f954d9e 100644 --- a/swagger/sdrangel/api/swagger/include/AMDemod.yaml +++ b/swagger/sdrangel/api/swagger/include/AMDemod.yaml @@ -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: 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: 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." diff --git a/swagger/sdrangel/api/swagger/include/AMMod.yaml b/swagger/sdrangel/api/swagger/include/AMMod.yaml index ee26baf64..054b745be 100644 --- a/swagger/sdrangel/api/swagger/include/AMMod.yaml +++ b/swagger/sdrangel/api/swagger/include/AMMod.yaml @@ -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: 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: 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." diff --git a/swagger/sdrangel/api/swagger/include/APRS.yaml b/swagger/sdrangel/api/swagger/include/APRS.yaml index e55769444..b6bd5b60c 100644 --- a/swagger/sdrangel/api/swagger/include/APRS.yaml +++ b/swagger/sdrangel/api/swagger/include/APRS.yaml @@ -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 diff --git a/swagger/sdrangel/api/swagger/include/APTDemod.yaml b/swagger/sdrangel/api/swagger/include/APTDemod.yaml index c6fd957ba..eff55bf16 100644 --- a/swagger/sdrangel/api/swagger/include/APTDemod.yaml +++ b/swagger/sdrangel/api/swagger/include/APTDemod.yaml @@ -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: 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 diff --git a/swagger/sdrangel/api/swagger/include/ATVDemod.yaml b/swagger/sdrangel/api/swagger/include/ATVDemod.yaml index 976a48563..917fa587b 100644 --- a/swagger/sdrangel/api/swagger/include/ATVDemod.yaml +++ b/swagger/sdrangel/api/swagger/include/ATVDemod.yaml @@ -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: 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 diff --git a/swagger/sdrangel/api/swagger/include/ATVMod.yaml b/swagger/sdrangel/api/swagger/include/ATVMod.yaml index 96fb4d160..8ed68fdc4 100644 --- a/swagger/sdrangel/api/swagger/include/ATVMod.yaml +++ b/swagger/sdrangel/api/swagger/include/ATVMod.yaml @@ -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: format: float channelSampleRate: type: integer + description: "Effective sample rate delivered to the channel in samples per second." diff --git a/swagger/sdrangel/api/swagger/include/AaroniaRTSA.yaml b/swagger/sdrangel/api/swagger/include/AaroniaRTSA.yaml index 4ba1ece11..2c50d7583 100644 --- a/swagger/sdrangel/api/swagger/include/AaroniaRTSA.yaml +++ b/swagger/sdrangel/api/swagger/include/AaroniaRTSA.yaml @@ -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: 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: 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: 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 diff --git a/swagger/sdrangel/api/swagger/include/Airspy.yaml b/swagger/sdrangel/api/swagger/include/Airspy.yaml index 5cf671263..b5dafb2e5 100644 --- a/swagger/sdrangel/api/swagger/include/Airspy.yaml +++ b/swagger/sdrangel/api/swagger/include/Airspy.yaml @@ -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: 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: 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" diff --git a/swagger/sdrangel/api/swagger/include/AirspyHF.yaml b/swagger/sdrangel/api/swagger/include/AirspyHF.yaml index bac3cf928..0465b2441 100644 --- a/swagger/sdrangel/api/swagger/include/AirspyHF.yaml +++ b/swagger/sdrangel/api/swagger/include/AirspyHF.yaml @@ -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" diff --git a/swagger/sdrangel/api/swagger/include/AndroidSDRDriverInput.yaml b/swagger/sdrangel/api/swagger/include/AndroidSDRDriverInput.yaml index 9de3fe40c..6cabd8930 100644 --- a/swagger/sdrangel/api/swagger/include/AndroidSDRDriverInput.yaml +++ b/swagger/sdrangel/api/swagger/include/AndroidSDRDriverInput.yaml @@ -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." diff --git a/swagger/sdrangel/api/swagger/include/AntennaTools.yaml b/swagger/sdrangel/api/swagger/include/AntennaTools.yaml index 6c07adc15..10a3956f7 100644 --- a/swagger/sdrangel/api/swagger/include/AntennaTools.yaml +++ b/swagger/sdrangel/api/swagger/include/AntennaTools.yaml @@ -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." diff --git a/swagger/sdrangel/api/swagger/include/AudioCATSISO.yaml b/swagger/sdrangel/api/swagger/include/AudioCATSISO.yaml index efdba0c62..817912e7d 100644 --- a/swagger/sdrangel/api/swagger/include/AudioCATSISO.yaml +++ b/swagger/sdrangel/api/swagger/include/AudioCATSISO.yaml @@ -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: 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: type: integer fcPosRx: type: integer + minimum: 0 + maximum: 2 description: > Decimated bandpass center frequency position * 0 - Infradyne @@ -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: 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: 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: * 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: * 2 - hardware catPTTMethodIndex: type: integer + minimum: 0 + maximum: 2 description: > CAT PTT method * 0 - PTT (default) @@ -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: 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." diff --git a/swagger/sdrangel/api/swagger/include/AudioInput.yaml b/swagger/sdrangel/api/swagger/include/AudioInput.yaml index 2e69cd198..e5c58a2d1 100644 --- a/swagger/sdrangel/api/swagger/include/AudioInput.yaml +++ b/swagger/sdrangel/api/swagger/include/AudioInput.yaml @@ -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: 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: * 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: 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." diff --git a/swagger/sdrangel/api/swagger/include/AudioOutput.yaml b/swagger/sdrangel/api/swagger/include/AudioOutput.yaml index 1c980dd04..6d41e9b77 100644 --- a/swagger/sdrangel/api/swagger/include/AudioOutput.yaml +++ b/swagger/sdrangel/api/swagger/include/AudioOutput.yaml @@ -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: 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." diff --git a/swagger/sdrangel/api/swagger/include/BFMDemod.yaml b/swagger/sdrangel/api/swagger/include/BFMDemod.yaml index 5f91c1abd..84d46fa0b 100644 --- a/swagger/sdrangel/api/swagger/include/BFMDemod.yaml +++ b/swagger/sdrangel/api/swagger/include/BFMDemod.yaml @@ -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: 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: 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: format: float rdsReport: $ref: "#/RDSReport" + description: "RDS decoder status and decoded programme information." RDSReport: description: RDS information @@ -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: type: string altFrequencies: type: array + description: "Alternative broadcast frequencies reported by RDS." items: properties: frequency: type: number format: float + description: "Frequency in Hz." diff --git a/swagger/sdrangel/api/swagger/include/BeamSteeringCWMod.yaml b/swagger/sdrangel/api/swagger/include/BeamSteeringCWMod.yaml index ed9206e01..fcb48b3a4 100644 --- a/swagger/sdrangel/api/swagger/include/BeamSteeringCWMod.yaml +++ b/swagger/sdrangel/api/swagger/include/BeamSteeringCWMod.yaml @@ -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." diff --git a/swagger/sdrangel/api/swagger/include/BladeRF1.yaml b/swagger/sdrangel/api/swagger/include/BladeRF1.yaml index f00b9819d..bf083dbf3 100644 --- a/swagger/sdrangel/api/swagger/include/BladeRF1.yaml +++ b/swagger/sdrangel/api/swagger/include/BladeRF1.yaml @@ -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: 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." diff --git a/swagger/sdrangel/api/swagger/include/BladeRF2.yaml b/swagger/sdrangel/api/swagger/include/BladeRF2.yaml index f34d84e8e..e3ebc04b2 100644 --- a/swagger/sdrangel/api/swagger/include/BladeRF2.yaml +++ b/swagger/sdrangel/api/swagger/include/BladeRF2.yaml @@ -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: 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: 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: 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." diff --git a/swagger/sdrangel/api/swagger/include/CWKeyer.yaml b/swagger/sdrangel/api/swagger/include/CWKeyer.yaml index 73c98ceee..a2a975025 100644 --- a/swagger/sdrangel/api/swagger/include/CWKeyer.yaml +++ b/swagger/sdrangel/api/swagger/include/CWKeyer.yaml @@ -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: type: integer text: type: string + description: "Text setting for CW keyer." loop: description: 1 to loop on text keying type: integer diff --git a/swagger/sdrangel/api/swagger/include/ChannelActions.yaml b/swagger/sdrangel/api/swagger/include/ChannelActions.yaml index 906a8da7c..979c10774 100644 --- a/swagger/sdrangel/api/swagger/include/ChannelActions.yaml +++ b/swagger/sdrangel/api/swagger/include/ChannelActions.yaml @@ -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." diff --git a/swagger/sdrangel/api/swagger/include/ChannelAnalyzer.yaml b/swagger/sdrangel/api/swagger/include/ChannelAnalyzer.yaml index 89e9c00c3..271d25531 100644 --- a/swagger/sdrangel/api/swagger/include/ChannelAnalyzer.yaml +++ b/swagger/sdrangel/api/swagger/include/ChannelAnalyzer.yaml @@ -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." diff --git a/swagger/sdrangel/api/swagger/include/ChannelMarker.yaml b/swagger/sdrangel/api/swagger/include/ChannelMarker.yaml index 328397aaf..930bec197 100644 --- a/swagger/sdrangel/api/swagger/include/ChannelMarker.yaml +++ b/swagger/sdrangel/api/swagger/include/ChannelMarker.yaml @@ -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 diff --git a/swagger/sdrangel/api/swagger/include/ChannelPower.yaml b/swagger/sdrangel/api/swagger/include/ChannelPower.yaml index 6289f76c1..001d93b38 100644 --- a/swagger/sdrangel/api/swagger/include/ChannelPower.yaml +++ b/swagger/sdrangel/api/swagger/include/ChannelPower.yaml @@ -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: rfBandwidth: type: number format: float + description: "RF bandwidth in Hz." pulseThreshold: description: "In dB" type: number @@ -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: format: float channelSampleRate: type: integer + description: "Effective sample rate delivered to the channel in samples per second." diff --git a/swagger/sdrangel/api/swagger/include/ChannelReport.yaml b/swagger/sdrangel/api/swagger/include/ChannelReport.yaml index 50b13e56a..e28795453 100644 --- a/swagger/sdrangel/api/swagger/include/ChannelReport.yaml +++ b/swagger/sdrangel/api/swagger/include/ChannelReport.yaml @@ -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." diff --git a/swagger/sdrangel/api/swagger/include/ChannelSettings.yaml b/swagger/sdrangel/api/swagger/include/ChannelSettings.yaml index 6566f2fcc..bf165fdb5 100644 --- a/swagger/sdrangel/api/swagger/include/ChannelSettings.yaml +++ b/swagger/sdrangel/api/swagger/include/ChannelSettings.yaml @@ -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." diff --git a/swagger/sdrangel/api/swagger/include/ChirpChatDemod.yaml b/swagger/sdrangel/api/swagger/include/ChirpChatDemod.yaml index b9eb085a4..5157e6e6d 100644 --- a/swagger/sdrangel/api/swagger/include/ChirpChatDemod.yaml +++ b/swagger/sdrangel/api/swagger/include/ChirpChatDemod.yaml @@ -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: * 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: * 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: 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: 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: 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: 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: type: integer headerParityStatus: type: integer + minimum: 0 + maximum: 3 description: > Header FEC parity status: * 0 - Undefined @@ -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: type: string decoding: type: integer + minimum: 0 + maximum: 1 description: > Boolean - decoding status * 0 - no decoding diff --git a/swagger/sdrangel/api/swagger/include/ChirpChatMod.yaml b/swagger/sdrangel/api/swagger/include/ChirpChatMod.yaml index 58d14202a..fadce64e1 100644 --- a/swagger/sdrangel/api/swagger/include/ChirpChatMod.yaml +++ b/swagger/sdrangel/api/swagger/include/ChirpChatMod.yaml @@ -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: * 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: 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: 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: 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: 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: format: float playing: type: integer + minimum: 0 + maximum: 1 description: > Boolean - modulator is active (playing) including idle time * 0 - Modulator not active diff --git a/swagger/sdrangel/api/swagger/include/Command.yaml b/swagger/sdrangel/api/swagger/include/Command.yaml index 997954296..384940b72 100644 --- a/swagger/sdrangel/api/swagger/include/Command.yaml +++ b/swagger/sdrangel/api/swagger/include/Command.yaml @@ -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: associateKey: description: boolean type: integer + minimum: 0 + maximum: 1 release: description: boolean - type: integer \ No newline at end of file + type: integer + minimum: 0 + maximum: 1 diff --git a/swagger/sdrangel/api/swagger/include/DABDemod.yaml b/swagger/sdrangel/api/swagger/include/DABDemod.yaml index 30b0fe15c..8019f0f56 100644 --- a/swagger/sdrangel/api/swagger/include/DABDemod.yaml +++ b/swagger/sdrangel/api/swagger/include/DABDemod.yaml @@ -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." diff --git a/swagger/sdrangel/api/swagger/include/DATVDemod.yaml b/swagger/sdrangel/api/swagger/include/DATVDemod.yaml index 538c9b71c..25f418bc9 100644 --- a/swagger/sdrangel/api/swagger/include/DATVDemod.yaml +++ b/swagger/sdrangel/api/swagger/include/DATVDemod.yaml @@ -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: * 8 - QAM256 fec: type: integer + minimum: 0 + maximum: 12 description: > FEC rate (see DATVDemodSettings::DATVCodeRate) * 0 - 1/2 @@ -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: * 1 - Linear * 2 - Root Raised Cosine type: integer + minimum: 0 + maximum: 2 hardMetric: description: (boolean) (DVB-S) type: integer @@ -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: 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: mer: type: number format: float + description: "Reported mer." cnr: type: number format: float + description: "Reported cnr." diff --git a/swagger/sdrangel/api/swagger/include/DATVMod.yaml b/swagger/sdrangel/api/swagger/include/DATVMod.yaml index a7a10de13..43c3926e3 100644 --- a/swagger/sdrangel/api/swagger/include/DATVMod.yaml +++ b/swagger/sdrangel/api/swagger/include/DATVMod.yaml @@ -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: 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: 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: 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." diff --git a/swagger/sdrangel/api/swagger/include/DOA2.yaml b/swagger/sdrangel/api/swagger/include/DOA2.yaml index b62a88a40..93ce0d856 100644 --- a/swagger/sdrangel/api/swagger/include/DOA2.yaml +++ b/swagger/sdrangel/api/swagger/include/DOA2.yaml @@ -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: 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 diff --git a/swagger/sdrangel/api/swagger/include/DSCDemod.yaml b/swagger/sdrangel/api/swagger/include/DSCDemod.yaml index 51aee23bf..eb87c0b6e 100644 --- a/swagger/sdrangel/api/swagger/include/DSCDemod.yaml +++ b/swagger/sdrangel/api/swagger/include/DSCDemod.yaml @@ -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: format: float channelSampleRate: type: integer + description: "Effective sample rate delivered to the channel in samples per second." diff --git a/swagger/sdrangel/api/swagger/include/DSDDemod.yaml b/swagger/sdrangel/api/swagger/include/DSDDemod.yaml index d0c87f99c..01f677278 100644 --- a/swagger/sdrangel/api/swagger/include/DSDDemod.yaml +++ b/swagger/sdrangel/api/swagger/include/DSDDemod.yaml @@ -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: 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: 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 diff --git a/swagger/sdrangel/api/swagger/include/DemodAnalyzer.yaml b/swagger/sdrangel/api/swagger/include/DemodAnalyzer.yaml index f18530ad0..1914fbdf6 100644 --- a/swagger/sdrangel/api/swagger/include/DemodAnalyzer.yaml +++ b/swagger/sdrangel/api/swagger/include/DemodAnalyzer.yaml @@ -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: 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" diff --git a/swagger/sdrangel/api/swagger/include/Denoiser.yaml b/swagger/sdrangel/api/swagger/include/Denoiser.yaml index dbc911e00..1ac503b7f 100644 --- a/swagger/sdrangel/api/swagger/include/Denoiser.yaml +++ b/swagger/sdrangel/api/swagger/include/Denoiser.yaml @@ -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: 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" diff --git a/swagger/sdrangel/api/swagger/include/DeviceActions.yaml b/swagger/sdrangel/api/swagger/include/DeviceActions.yaml index 12eb0da65..4235e7fb2 100644 --- a/swagger/sdrangel/api/swagger/include/DeviceActions.yaml +++ b/swagger/sdrangel/api/swagger/include/DeviceActions.yaml @@ -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." diff --git a/swagger/sdrangel/api/swagger/include/DeviceReports.yaml b/swagger/sdrangel/api/swagger/include/DeviceReports.yaml index 59139dc4f..0d02a80bf 100644 --- a/swagger/sdrangel/api/swagger/include/DeviceReports.yaml +++ b/swagger/sdrangel/api/swagger/include/DeviceReports.yaml @@ -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." diff --git a/swagger/sdrangel/api/swagger/include/DeviceSettings.yaml b/swagger/sdrangel/api/swagger/include/DeviceSettings.yaml index 0c6b1a32d..bba3db3b2 100644 --- a/swagger/sdrangel/api/swagger/include/DeviceSettings.yaml +++ b/swagger/sdrangel/api/swagger/include/DeviceSettings.yaml @@ -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." diff --git a/swagger/sdrangel/api/swagger/include/EndOfTrainDemod.yaml b/swagger/sdrangel/api/swagger/include/EndOfTrainDemod.yaml index 7171a1311..713b187b8 100644 --- a/swagger/sdrangel/api/swagger/include/EndOfTrainDemod.yaml +++ b/swagger/sdrangel/api/swagger/include/EndOfTrainDemod.yaml @@ -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: format: float channelSampleRate: type: integer + description: "Effective sample rate delivered to the channel in samples per second." diff --git a/swagger/sdrangel/api/swagger/include/FCDPro.yaml b/swagger/sdrangel/api/swagger/include/FCDPro.yaml index 711cc5bd9..c85e9f444 100644 --- a/swagger/sdrangel/api/swagger/include/FCDPro.yaml +++ b/swagger/sdrangel/api/swagger/include/FCDPro.yaml @@ -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: 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." diff --git a/swagger/sdrangel/api/swagger/include/FCDProPlus.yaml b/swagger/sdrangel/api/swagger/include/FCDProPlus.yaml index 9e8758204..c297b25f5 100644 --- a/swagger/sdrangel/api/swagger/include/FCDProPlus.yaml +++ b/swagger/sdrangel/api/swagger/include/FCDProPlus.yaml @@ -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: 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: 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." diff --git a/swagger/sdrangel/api/swagger/include/FT8Demod.yaml b/swagger/sdrangel/api/swagger/include/FT8Demod.yaml index 2eb1055eb..a4cc7cf03 100644 --- a/swagger/sdrangel/api/swagger/include/FT8Demod.yaml +++ b/swagger/sdrangel/api/swagger/include/FT8Demod.yaml @@ -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: 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: 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: 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: type: integer channelSampleRate: type: integer + description: "Effective sample rate delivered to the channel in samples per second." diff --git a/swagger/sdrangel/api/swagger/include/FeatureActions.yaml b/swagger/sdrangel/api/swagger/include/FeatureActions.yaml index d1d96f690..d8a93fb5e 100644 --- a/swagger/sdrangel/api/swagger/include/FeatureActions.yaml +++ b/swagger/sdrangel/api/swagger/include/FeatureActions.yaml @@ -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." diff --git a/swagger/sdrangel/api/swagger/include/FeatureReport.yaml b/swagger/sdrangel/api/swagger/include/FeatureReport.yaml index baa6bae95..cfb0b794d 100644 --- a/swagger/sdrangel/api/swagger/include/FeatureReport.yaml +++ b/swagger/sdrangel/api/swagger/include/FeatureReport.yaml @@ -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." diff --git a/swagger/sdrangel/api/swagger/include/FeatureSetPreset.yaml b/swagger/sdrangel/api/swagger/include/FeatureSetPreset.yaml index e3dfccc3a..bc93b7d65 100644 --- a/swagger/sdrangel/api/swagger/include/FeatureSetPreset.yaml +++ b/swagger/sdrangel/api/swagger/include/FeatureSetPreset.yaml @@ -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" diff --git a/swagger/sdrangel/api/swagger/include/FeatureSettings.yaml b/swagger/sdrangel/api/swagger/include/FeatureSettings.yaml index 8540bd5f4..11e7a1345 100644 --- a/swagger/sdrangel/api/swagger/include/FeatureSettings.yaml +++ b/swagger/sdrangel/api/swagger/include/FeatureSettings.yaml @@ -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." diff --git a/swagger/sdrangel/api/swagger/include/FileInput.yaml b/swagger/sdrangel/api/swagger/include/FileInput.yaml index 9546318e5..f76b67250 100644 --- a/swagger/sdrangel/api/swagger/include/FileInput.yaml +++ b/swagger/sdrangel/api/swagger/include/FileInput.yaml @@ -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: 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 diff --git a/swagger/sdrangel/api/swagger/include/FileOutput.yaml b/swagger/sdrangel/api/swagger/include/FileOutput.yaml index ea5a38846..eb4479c26 100644 --- a/swagger/sdrangel/api/swagger/include/FileOutput.yaml +++ b/swagger/sdrangel/api/swagger/include/FileOutput.yaml @@ -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." diff --git a/swagger/sdrangel/api/swagger/include/FileSink.yaml b/swagger/sdrangel/api/swagger/include/FileSink.yaml index 50ace59f8..72d344f07 100644 --- a/swagger/sdrangel/api/swagger/include/FileSink.yaml +++ b/swagger/sdrangel/api/swagger/include/FileSink.yaml @@ -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: 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: 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: 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: properties: record: type: integer + minimum: 0 + maximum: 1 description: > Record action * 0 - stop recording diff --git a/swagger/sdrangel/api/swagger/include/FileSource.yaml b/swagger/sdrangel/api/swagger/include/FileSource.yaml index b26446b26..d8c8571be 100644 --- a/swagger/sdrangel/api/swagger/include/FileSource.yaml +++ b/swagger/sdrangel/api/swagger/include/FileSource.yaml @@ -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: properties: play: type: integer + minimum: 0 + maximum: 1 description: > Play or Pause stream * 0 - Pause diff --git a/swagger/sdrangel/api/swagger/include/FreeDVDemod.yaml b/swagger/sdrangel/api/swagger/include/FreeDVDemod.yaml index e47280b60..52c255e5c 100644 --- a/swagger/sdrangel/api/swagger/include/FreeDVDemod.yaml +++ b/swagger/sdrangel/api/swagger/include/FreeDVDemod.yaml @@ -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: 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: 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." diff --git a/swagger/sdrangel/api/swagger/include/FreeDVMod.yaml b/swagger/sdrangel/api/swagger/include/FreeDVMod.yaml index efff3c9d6..aaafe154c 100644 --- a/swagger/sdrangel/api/swagger/include/FreeDVMod.yaml +++ b/swagger/sdrangel/api/swagger/include/FreeDVMod.yaml @@ -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: 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." diff --git a/swagger/sdrangel/api/swagger/include/FreqDisplay.yaml b/swagger/sdrangel/api/swagger/include/FreqDisplay.yaml index c116361ed..7ccc61567 100644 --- a/swagger/sdrangel/api/swagger/include/FreqDisplay.yaml +++ b/swagger/sdrangel/api/swagger/include/FreqDisplay.yaml @@ -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" diff --git a/swagger/sdrangel/api/swagger/include/FreqScanner.yaml b/swagger/sdrangel/api/swagger/include/FreqScanner.yaml index c6d4110ed..a6947ce40 100644 --- a/swagger/sdrangel/api/swagger/include/FreqScanner.yaml +++ b/swagger/sdrangel/api/swagger/include/FreqScanner.yaml @@ -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: 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 diff --git a/swagger/sdrangel/api/swagger/include/FreqTracker.yaml b/swagger/sdrangel/api/swagger/include/FreqTracker.yaml index 0fffb7b69..34c9203dd 100644 --- a/swagger/sdrangel/api/swagger/include/FreqTracker.yaml +++ b/swagger/sdrangel/api/swagger/include/FreqTracker.yaml @@ -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: 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: 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." diff --git a/swagger/sdrangel/api/swagger/include/GLScope.yaml b/swagger/sdrangel/api/swagger/include/GLScope.yaml index 996e4da42..7bf969681 100644 --- a/swagger/sdrangel/api/swagger/include/GLScope.yaml +++ b/swagger/sdrangel/api/swagger/include/GLScope.yaml @@ -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: 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: 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" diff --git a/swagger/sdrangel/api/swagger/include/GLSpectrum.yaml b/swagger/sdrangel/api/swagger/include/GLSpectrum.yaml index edaf0c805..df800c4b8 100644 --- a/swagger/sdrangel/api/swagger/include/GLSpectrum.yaml +++ b/swagger/sdrangel/api/swagger/include/GLSpectrum.yaml @@ -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: 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: frequency: type: number format: float + description: "Frequency in Hz." time: type: number format: float @@ -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: 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: 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: 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: type: integer markersDisplay: type: integer + minimum: 0 + maximum: 2 description: > Display markers (SpectrumSettings::MarkersDisplay) * 0 - Mome @@ -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" diff --git a/swagger/sdrangel/api/swagger/include/GS232Controller.yaml b/swagger/sdrangel/api/swagger/include/GS232Controller.yaml index 0662d7492..da26a711d 100644 --- a/swagger/sdrangel/api/swagger/include/GS232Controller.yaml +++ b/swagger/sdrangel/api/swagger/include/GS232Controller.yaml @@ -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: properties: run: type: integer + minimum: 0 + maximum: 1 description: > Set the plugin running state * 0 - idle diff --git a/swagger/sdrangel/api/swagger/include/HackRF.yaml b/swagger/sdrangel/api/swagger/include/HackRF.yaml index bdb5cb5ba..87f4093d8 100644 --- a/swagger/sdrangel/api/swagger/include/HackRF.yaml +++ b/swagger/sdrangel/api/swagger/include/HackRF.yaml @@ -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: 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." diff --git a/swagger/sdrangel/api/swagger/include/HeatMap.yaml b/swagger/sdrangel/api/swagger/include/HeatMap.yaml index 7c8fa4851..8444c7c33 100644 --- a/swagger/sdrangel/api/swagger/include/HeatMap.yaml +++ b/swagger/sdrangel/api/swagger/include/HeatMap.yaml @@ -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: 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: format: float channelSampleRate: type: integer + description: "Effective sample rate delivered to the channel in samples per second." diff --git a/swagger/sdrangel/api/swagger/include/IEEE_802_15_4_Mod.yaml b/swagger/sdrangel/api/swagger/include/IEEE_802_15_4_Mod.yaml index 0ac25e4f2..c362570c6 100644 --- a/swagger/sdrangel/api/swagger/include/IEEE_802_15_4_Mod.yaml +++ b/swagger/sdrangel/api/swagger/include/IEEE_802_15_4_Mod.yaml @@ -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: 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: 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: 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: 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: 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: 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 diff --git a/swagger/sdrangel/api/swagger/include/ILSDemod.yaml b/swagger/sdrangel/api/swagger/include/ILSDemod.yaml index f41090ddd..ba6e479df 100644 --- a/swagger/sdrangel/api/swagger/include/ILSDemod.yaml +++ b/swagger/sdrangel/api/swagger/include/ILSDemod.yaml @@ -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: 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 diff --git a/swagger/sdrangel/api/swagger/include/InmarsatDemod.yaml b/swagger/sdrangel/api/swagger/include/InmarsatDemod.yaml index 52cc5cc2f..5dbe88a60 100644 --- a/swagger/sdrangel/api/swagger/include/InmarsatDemod.yaml +++ b/swagger/sdrangel/api/swagger/include/InmarsatDemod.yaml @@ -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: format: float channelSampleRate: type: integer + description: "Effective sample rate delivered to the channel in samples per second." diff --git a/swagger/sdrangel/api/swagger/include/Interferometer.yaml b/swagger/sdrangel/api/swagger/include/Interferometer.yaml index 6bac1c0c2..de956c509 100644 --- a/swagger/sdrangel/api/swagger/include/Interferometer.yaml +++ b/swagger/sdrangel/api/swagger/include/Interferometer.yaml @@ -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: type: integer play: type: integer + minimum: 0 + maximum: 1 description: > Run correlated IQ samples transfer * 0 - stop @@ -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." diff --git a/swagger/sdrangel/api/swagger/include/JogdialController.yaml b/swagger/sdrangel/api/swagger/include/JogdialController.yaml index 1bd58ed6e..d4c2cf510 100644 --- a/swagger/sdrangel/api/swagger/include/JogdialController.yaml +++ b/swagger/sdrangel/api/swagger/include/JogdialController.yaml @@ -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." diff --git a/swagger/sdrangel/api/swagger/include/KiwiSDR.yaml b/swagger/sdrangel/api/swagger/include/KiwiSDR.yaml index a66a9a155..b2859538d 100644 --- a/swagger/sdrangel/api/swagger/include/KiwiSDR.yaml +++ b/swagger/sdrangel/api/swagger/include/KiwiSDR.yaml @@ -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: 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." diff --git a/swagger/sdrangel/api/swagger/include/LimeRFE.yaml b/swagger/sdrangel/api/swagger/include/LimeRFE.yaml index 7c2f15413..c23f612f3 100644 --- a/swagger/sdrangel/api/swagger/include/LimeRFE.yaml +++ b/swagger/sdrangel/api/swagger/include/LimeRFE.yaml @@ -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: * 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: * 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: type: integer txChannels: type: integer + minimum: 0 + maximum: 2 description: > Tx channels group (LimeRFEController::ChannelGroups) * 0 - Wideband @@ -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: * 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: 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: 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: 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: properties: selectChannel: type: integer + minimum: 0 + maximum: 1 description: > Select channel * 0 - Rx @@ -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: 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 diff --git a/swagger/sdrangel/api/swagger/include/LimeSdr.yaml b/swagger/sdrangel/api/swagger/include/LimeSdr.yaml index 6645764a2..44f1d6348 100644 --- a/swagger/sdrangel/api/swagger/include/LimeSdr.yaml +++ b/swagger/sdrangel/api/swagger/include/LimeSdr.yaml @@ -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: 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: # 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: 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: 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: 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: * 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: 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: * 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: 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: 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: * 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: 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: * 1 - RF connector 1 * 2 - RF connector 2 type: integer + minimum: 0 + maximum: 2 LimeSdrInputReport: description: LimeSDR @@ -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: 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: 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: 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: 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: 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: 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." diff --git a/swagger/sdrangel/api/swagger/include/LocalInput.yaml b/swagger/sdrangel/api/swagger/include/LocalInput.yaml index 9bb193216..b4e7e3413 100644 --- a/swagger/sdrangel/api/swagger/include/LocalInput.yaml +++ b/swagger/sdrangel/api/swagger/include/LocalInput.yaml @@ -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: centerFrequency: type: integer format: int64 + description: "Device center frequency in Hz." sampleRate: type: integer + description: "Sample rate in samples per second." diff --git a/swagger/sdrangel/api/swagger/include/LocalOutput.yaml b/swagger/sdrangel/api/swagger/include/LocalOutput.yaml index c077f1dfc..6eedd0efb 100644 --- a/swagger/sdrangel/api/swagger/include/LocalOutput.yaml +++ b/swagger/sdrangel/api/swagger/include/LocalOutput.yaml @@ -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: centerFrequency: type: integer format: int64 + description: "Device center frequency in Hz." sampleRate: type: integer + description: "Sample rate in samples per second." diff --git a/swagger/sdrangel/api/swagger/include/LocalSink.yaml b/swagger/sdrangel/api/swagger/include/LocalSink.yaml index f670360fd..81e794187 100644 --- a/swagger/sdrangel/api/swagger/include/LocalSink.yaml +++ b/swagger/sdrangel/api/swagger/include/LocalSink.yaml @@ -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: type: integer fftOn: type: integer + minimum: 0 + maximum: 1 description: > Activate FFT multiband filter * 0 - do not run filter @@ -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: * 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: 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: diff --git a/swagger/sdrangel/api/swagger/include/LocalSource.yaml b/swagger/sdrangel/api/swagger/include/LocalSource.yaml index c7d45c434..5385dc1c3 100644 --- a/swagger/sdrangel/api/swagger/include/LocalSource.yaml +++ b/swagger/sdrangel/api/swagger/include/LocalSource.yaml @@ -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." diff --git a/swagger/sdrangel/api/swagger/include/M17Demod.yaml b/swagger/sdrangel/api/swagger/include/M17Demod.yaml index 92711c3c0..ee840bb6b 100644 --- a/swagger/sdrangel/api/swagger/include/M17Demod.yaml +++ b/swagger/sdrangel/api/swagger/include/M17Demod.yaml @@ -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: 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: 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 diff --git a/swagger/sdrangel/api/swagger/include/M17Mod.yaml b/swagger/sdrangel/api/swagger/include/M17Mod.yaml index bb11615b7..b0f6a40e7 100644 --- a/swagger/sdrangel/api/swagger/include/M17Mod.yaml +++ b/swagger/sdrangel/api/swagger/include/M17Mod.yaml @@ -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: 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: 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." diff --git a/swagger/sdrangel/api/swagger/include/MCPServer.yaml b/swagger/sdrangel/api/swagger/include/MCPServer.yaml new file mode 100644 index 000000000..cd8518969 --- /dev/null +++ b/swagger/sdrangel/api/swagger/include/MCPServer.yaml @@ -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 diff --git a/swagger/sdrangel/api/swagger/include/Map.yaml b/swagger/sdrangel/api/swagger/include/Map.yaml index cd1361583..891066d25 100644 --- a/swagger/sdrangel/api/swagger/include/Map.yaml +++ b/swagger/sdrangel/api/swagger/include/Map.yaml @@ -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: 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: 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: 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: 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: 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: 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: 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: 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: 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: mach: type: number format: float + description: "Mach for Map aircraft state." altitude: description: "Barometric altitude in feet" type: number @@ -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: 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." diff --git a/swagger/sdrangel/api/swagger/include/MeshcoreDemod.yaml b/swagger/sdrangel/api/swagger/include/MeshcoreDemod.yaml index f02677426..57f123d65 100644 --- a/swagger/sdrangel/api/swagger/include/MeshcoreDemod.yaml +++ b/swagger/sdrangel/api/swagger/include/MeshcoreDemod.yaml @@ -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: * 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: 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: 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: 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: type: integer headerParityStatus: type: integer + minimum: 0 + maximum: 3 description: > Header FEC parity status: * 0 - Undefined @@ -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: type: string decoding: type: integer + minimum: 0 + maximum: 1 description: > Boolean - decoding status * 0 - no decoding diff --git a/swagger/sdrangel/api/swagger/include/MeshcoreMod.yaml b/swagger/sdrangel/api/swagger/include/MeshcoreMod.yaml index f3dfc08c0..25f483a31 100644 --- a/swagger/sdrangel/api/swagger/include/MeshcoreMod.yaml +++ b/swagger/sdrangel/api/swagger/include/MeshcoreMod.yaml @@ -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: * 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: channelMute: description: boolean type: integer + minimum: 0 + maximum: 1 nbParityBits: description: Hamming FEC parity bits (LoRa) type: integer @@ -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: 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: 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: properties: sendNow: type: integer + minimum: 0 + maximum: 1 description: > Send packet immediately * 0 - Do nothing diff --git a/swagger/sdrangel/api/swagger/include/MeshtasticDemod.yaml b/swagger/sdrangel/api/swagger/include/MeshtasticDemod.yaml index 4b2556d60..6fc76f51d 100644 --- a/swagger/sdrangel/api/swagger/include/MeshtasticDemod.yaml +++ b/swagger/sdrangel/api/swagger/include/MeshtasticDemod.yaml @@ -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: * 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: 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: 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: 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: type: integer headerParityStatus: type: integer + minimum: 0 + maximum: 3 description: > Header FEC parity status: * 0 - Undefined @@ -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: type: string decoding: type: integer + minimum: 0 + maximum: 1 description: > Boolean - decoding status * 0 - no decoding diff --git a/swagger/sdrangel/api/swagger/include/MeshtasticMod.yaml b/swagger/sdrangel/api/swagger/include/MeshtasticMod.yaml index 90059f2c3..010869a90 100644 --- a/swagger/sdrangel/api/swagger/include/MeshtasticMod.yaml +++ b/swagger/sdrangel/api/swagger/include/MeshtasticMod.yaml @@ -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: * 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: channelMute: description: boolean type: integer + minimum: 0 + maximum: 1 nbParityBits: description: Hamming FEC parity bits (LoRa) type: integer @@ -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: 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: format: float playing: type: integer + minimum: 0 + maximum: 1 description: > Boolean - modulator is active (playing) including idle time * 0 - Modulator not active diff --git a/swagger/sdrangel/api/swagger/include/MetisMISO.yaml b/swagger/sdrangel/api/swagger/include/MetisMISO.yaml index bf651b8b2..88c213b16 100644 --- a/swagger/sdrangel/api/swagger/include/MetisMISO.yaml +++ b/swagger/sdrangel/api/swagger/include/MetisMISO.yaml @@ -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: 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: 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: 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: 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: 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." diff --git a/swagger/sdrangel/api/swagger/include/MorseDecoder.yaml b/swagger/sdrangel/api/swagger/include/MorseDecoder.yaml index 4859b1371..15029ef4d 100644 --- a/swagger/sdrangel/api/swagger/include/MorseDecoder.yaml +++ b/swagger/sdrangel/api/swagger/include/MorseDecoder.yaml @@ -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: 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" diff --git a/swagger/sdrangel/api/swagger/include/NFMDemod.yaml b/swagger/sdrangel/api/swagger/include/NFMDemod.yaml index c3cc11691..f4b0f58e4 100644 --- a/swagger/sdrangel/api/swagger/include/NFMDemod.yaml +++ b/swagger/sdrangel/api/swagger/include/NFMDemod.yaml @@ -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: 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: 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." diff --git a/swagger/sdrangel/api/swagger/include/NFMMod.yaml b/swagger/sdrangel/api/swagger/include/NFMMod.yaml index 3279ddc14..446e74f98 100644 --- a/swagger/sdrangel/api/swagger/include/NFMMod.yaml +++ b/swagger/sdrangel/api/swagger/include/NFMMod.yaml @@ -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: 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: 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." diff --git a/swagger/sdrangel/api/swagger/include/NavtexDemod.yaml b/swagger/sdrangel/api/swagger/include/NavtexDemod.yaml index af2417eb7..6aa15b76b 100644 --- a/swagger/sdrangel/api/swagger/include/NavtexDemod.yaml +++ b/swagger/sdrangel/api/swagger/include/NavtexDemod.yaml @@ -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: format: float channelSampleRate: type: integer + description: "Effective sample rate delivered to the channel in samples per second." diff --git a/swagger/sdrangel/api/swagger/include/NoiseFigure.yaml b/swagger/sdrangel/api/swagger/include/NoiseFigure.yaml index 5f25b3756..9372ac52e 100644 --- a/swagger/sdrangel/api/swagger/include/NoiseFigure.yaml +++ b/swagger/sdrangel/api/swagger/include/NoiseFigure.yaml @@ -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: format: float channelSampleRate: type: integer + description: "Effective sample rate delivered to the channel in samples per second." diff --git a/swagger/sdrangel/api/swagger/include/PERTester.yaml b/swagger/sdrangel/api/swagger/include/PERTester.yaml index 103b8c809..639ccc27f 100644 --- a/swagger/sdrangel/api/swagger/include/PERTester.yaml +++ b/swagger/sdrangel/api/swagger/include/PERTester.yaml @@ -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: 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: 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: properties: run: type: integer + minimum: 0 + maximum: 1 description: > Set the plugin running state * 0 - idle diff --git a/swagger/sdrangel/api/swagger/include/PSK31Mod.yaml b/swagger/sdrangel/api/swagger/include/PSK31Mod.yaml index b5d24e122..58f2c15ce 100644 --- a/swagger/sdrangel/api/swagger/include/PSK31Mod.yaml +++ b/swagger/sdrangel/api/swagger/include/PSK31Mod.yaml @@ -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: description: Text to transmit pulseShaping: type: integer + minimum: 0 + maximum: 1 description: > Boolean * 0 - off @@ -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: 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 diff --git a/swagger/sdrangel/api/swagger/include/PacketDemod.yaml b/swagger/sdrangel/api/swagger/include/PacketDemod.yaml index 50e8aeec1..95813cf46 100644 --- a/swagger/sdrangel/api/swagger/include/PacketDemod.yaml +++ b/swagger/sdrangel/api/swagger/include/PacketDemod.yaml @@ -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: 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: 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: format: float channelSampleRate: type: integer + description: "Effective sample rate delivered to the channel in samples per second." diff --git a/swagger/sdrangel/api/swagger/include/PacketMod.yaml b/swagger/sdrangel/api/swagger/include/PacketMod.yaml index 691d38cfc..4e856203f 100644 --- a/swagger/sdrangel/api/swagger/include/PacketMod.yaml +++ b/swagger/sdrangel/api/swagger/include/PacketMod.yaml @@ -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: 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: 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: 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." diff --git a/swagger/sdrangel/api/swagger/include/PagerDemod.yaml b/swagger/sdrangel/api/swagger/include/PagerDemod.yaml index 9fb842043..74be63b83 100644 --- a/swagger/sdrangel/api/swagger/include/PagerDemod.yaml +++ b/swagger/sdrangel/api/swagger/include/PagerDemod.yaml @@ -3,6 +3,8 @@ PagerDemodSettings: properties: decode: type: integer + minimum: 0 + maximum: 4 description: > Decode mode * 0 - Standard @@ -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: 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: format: float channelSampleRate: type: integer + description: "Effective sample rate delivered to the channel in samples per second." diff --git a/swagger/sdrangel/api/swagger/include/Perseus.yaml b/swagger/sdrangel/api/swagger/include/Perseus.yaml index e41690162..27cf41e91 100644 --- a/swagger/sdrangel/api/swagger/include/Perseus.yaml +++ b/swagger/sdrangel/api/swagger/include/Perseus.yaml @@ -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: 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: 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" diff --git a/swagger/sdrangel/api/swagger/include/PlutoSdr.yaml b/swagger/sdrangel/api/swagger/include/PlutoSdr.yaml index 95709d5d3..f6ad8e2dc 100644 --- a/swagger/sdrangel/api/swagger/include/PlutoSdr.yaml +++ b/swagger/sdrangel/api/swagger/include/PlutoSdr.yaml @@ -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: 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: 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: 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: 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: 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: 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: 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." diff --git a/swagger/sdrangel/api/swagger/include/Preferences.yaml b/swagger/sdrangel/api/swagger/include/Preferences.yaml index 23dcb720b..e984758c5 100644 --- a/swagger/sdrangel/api/swagger/include/Preferences.yaml +++ b/swagger/sdrangel/api/swagger/include/Preferences.yaml @@ -9,22 +9,33 @@ Preferences: type: integer audioType: type: string + description: "Audio type for Preferences." audioDevice: type: string + description: "Audio device for Preferences." 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 consoleMinLogLevel: description: See QtMsgType type: integer useLogFile: description: boolean type: integer + minimum: 0 + maximum: 1 logFileName: type: string + description: "Log file name." fileMinLogLevel: description: See QtMsgType type: integer diff --git a/swagger/sdrangel/api/swagger/include/Preset.yaml b/swagger/sdrangel/api/swagger/include/Preset.yaml index 538a5b87e..363e8f7bd 100644 --- a/swagger/sdrangel/api/swagger/include/Preset.yaml +++ b/swagger/sdrangel/api/swagger/include/Preset.yaml @@ -3,12 +3,16 @@ DeviceConfig: properties: deviceId: type: string + description: "Device id for Device config." deviceSerial: type: string + description: "Device serial for Device config." deviceSequence: type: integer + description: "Device sequence for Device config." config: $ref: "http://swgserver:8081/api/swagger/include/DeviceSettings.yaml#/DeviceSettings" + description: "Configuration data." ChannelConfig: description: Represents a Preset::ChannelConfig object @@ -18,6 +22,7 @@ ChannelConfig: type: string config: $ref: "http://swgserver:8081/api/swagger/include/ChannelSettings.yaml#/ChannelSettings" + description: "Configuration data." Preset: description: Represents a Preset object @@ -27,25 +32,35 @@ Preset: type: integer group: type: string + description: "Group for Preset." description: type: string + description: "Human-readable description." centerFrequency: type: integer format: int64 + description: "Device center frequency in Hz." spectrumConfig: $ref: "http://swgserver:8081/api/swagger/include/GLSpectrum.yaml#/GLSpectrum" + description: "Spectrum-display configuration." dcOffsetCorrection: description: boolean type: integer + minimum: 0 + maximum: 1 iqImbalanceCorrection: description: boolean type: integer + minimum: 0 + maximum: 1 channelConfigs: type: array + description: "List of channel configs." items: $ref: "http://swgserver:8081/api/swagger/include/Preset.yaml#/ChannelConfig" deviceConfigs: type: array + description: "List of device configs." items: $ref: "http://swgserver:8081/api/swagger/include/Preset.yaml#/DeviceConfig" layout: diff --git a/swagger/sdrangel/api/swagger/include/RTTYDemod.yaml b/swagger/sdrangel/api/swagger/include/RTTYDemod.yaml index b4ff78c66..fc856142e 100644 --- a/swagger/sdrangel/api/swagger/include/RTTYDemod.yaml +++ b/swagger/sdrangel/api/swagger/include/RTTYDemod.yaml @@ -4,63 +4,100 @@ RTTYDemodSettings: 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." baudRate: type: number format: float + description: "Serial-port baud rate in bits per second." frequencyShift: type: integer + description: "Frequency shift 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 characterSet: type: integer + description: "Character set setting for Rtty demod." suppressCRLF: type: integer + description: "Suppress crlf setting for Rtty demod." unshiftOnSpace: type: integer + description: "Enable unshift on space (1 enabled, 0 disabled)." + minimum: 0 + maximum: 1 msbFirst: type: integer + description: "Enable msb first (1 enabled, 0 disabled)." + minimum: 0 + maximum: 1 spaceHigh: type: integer + description: "Enable space high (1 enabled, 0 disabled)." + minimum: 0 + maximum: 1 squelch: type: integer + description: "Squelch threshold in dB." 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." RTTYDemodReport: description: ACARSDemod @@ -71,3 +108,4 @@ RTTYDemodReport: format: float channelSampleRate: type: integer + description: "Effective sample rate delivered to the channel in samples per second." diff --git a/swagger/sdrangel/api/swagger/include/RTTYMod.yaml b/swagger/sdrangel/api/swagger/include/RTTYMod.yaml index ba283e106..7b22ff205 100644 --- a/swagger/sdrangel/api/swagger/include/RTTYMod.yaml +++ b/swagger/sdrangel/api/swagger/include/RTTYMod.yaml @@ -4,27 +4,41 @@ RTTYModSettings: inputFrequencyOffset: type: integer format: int64 + description: "Channel frequency offset from the device center frequency in Hz." baud: type: number format: float description: Baud rate rfBandwidth: type: integer + description: "RF bandwidth in Hz." frequencyShift: type: integer + description: "Frequency shift 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 @@ -34,6 +48,8 @@ RTTYModSettings: description: Text to transmit pulseShaping: type: integer + minimum: 0 + maximum: 1 description: > Boolean * 0 - off @@ -41,51 +57,85 @@ RTTYModSettings: beta: type: number format: float + description: "Beta setting for Rtty mod." symbolSpan: type: integer + description: "Symbol span setting for Rtty mod." characterSet: type: integer + description: "Character set setting for Rtty mod." unshiftOnSpace: type: integer + description: "Enable unshift on space (1 enabled, 0 disabled)." + minimum: 0 + maximum: 1 msbFirst: type: integer + description: "Enable msb first (1 enabled, 0 disabled)." + minimum: 0 + maximum: 1 spaceHigh: type: integer + description: "Enable space high (1 enabled, 0 disabled)." + minimum: 0 + maximum: 1 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." RTTYModReport: description: RTTYMod @@ -96,18 +146,22 @@ RTTYModReport: format: float channelSampleRate: type: integer + description: "Effective sample rate delivered to the channel in samples per second." RTTYModActions: description: RTTYMod 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: RTTY content to transmit diff --git a/swagger/sdrangel/api/swagger/include/RadioAstronomy.yaml b/swagger/sdrangel/api/swagger/include/RadioAstronomy.yaml index f5e28c926..85858f14d 100644 --- a/swagger/sdrangel/api/swagger/include/RadioAstronomy.yaml +++ b/swagger/sdrangel/api/swagger/include/RadioAstronomy.yaml @@ -4,22 +4,31 @@ RadioAstronomySettings: inputFrequencyOffset: type: integer format: int64 + description: "Channel frequency offset from the device center frequency in Hz." sampleRate: type: integer + description: "Sample rate in samples per second." rfBandwidth: type: integer + description: "RF bandwidth in Hz." integration: type: integer + description: "Integration setting for Radio astronomy." fftSize: type: integer + description: "FFT size in samples." fftWindow: type: integer + description: "FFT window setting for Radio astronomy." filterFreqs: type: string + description: "Filter freqs setting for Radio astronomy." starTracker: type: string + description: "Star tracker setting for Radio astronomy." rotator: type: string + description: "Rotator setting for Radio astronomy." runMode: description: "(0 for single, 1 for continuous, 2 for sweep)" type: integer @@ -28,55 +37,76 @@ RadioAstronomySettings: type: integer sweepStartDateTime: type: string + description: "Sweep start date time setting for Radio astronomy." sweepType: description: "(0 for Az/El, 1 for l/b, 2 for offset)" type: integer sweep1Start: type: number format: float + description: "Sweep1 start setting for Radio astronomy." sweep1Stop: type: number format: float + description: "Sweep1 stop setting for Radio astronomy." sweep1Step: type: number format: float + description: "Sweep1 step setting for Radio astronomy." sweep1Delay: type: number format: float + description: "Sweep1 delay setting for Radio astronomy." sweep2Start: type: number format: float + description: "Sweep2 start setting for Radio astronomy." sweep2Stop: type: number format: float + description: "Sweep2 stop setting for Radio astronomy." sweep2Step: type: number format: float + description: "Sweep2 step setting for Radio astronomy." sweep2Delay: type: number format: float + description: "Sweep2 delay setting for Radio astronomy." 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." RadioAstronomyReport: description: RadioAstronomy @@ -87,6 +117,7 @@ RadioAstronomyReport: format: float channelSampleRate: type: integer + description: "Effective sample rate delivered to the channel in samples per second." RadioAstronomyActions: description: RadioAstronomy diff --git a/swagger/sdrangel/api/swagger/include/RadioClock.yaml b/swagger/sdrangel/api/swagger/include/RadioClock.yaml index 50b771452..c840acf0e 100644 --- a/swagger/sdrangel/api/swagger/include/RadioClock.yaml +++ b/swagger/sdrangel/api/swagger/include/RadioClock.yaml @@ -19,36 +19,54 @@ RadioClockSettings: threshold: type: number format: float + description: "Threshold setting for Radio clock." modulation: description: 0 - MSF, 1 - DCF77, 2 - TDF, 3 - WWVB, 4 - JJY type: integer + minimum: 0 + maximum: 4 timezone: description: 0 - Broadcast, 1 - Local, 2 - UTC type: integer + minimum: 0 + maximum: 2 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." RadioClockReport: description: RadioClock @@ -59,7 +77,10 @@ RadioClockReport: format: float channelSampleRate: type: integer + description: "Effective sample rate delivered to the channel in samples per second." date: type: string + description: "Reported date." time: type: string + description: "Reported time." diff --git a/swagger/sdrangel/api/swagger/include/Radiosonde.yaml b/swagger/sdrangel/api/swagger/include/Radiosonde.yaml index 6d3e545fe..f827d45c3 100644 --- a/swagger/sdrangel/api/swagger/include/Radiosonde.yaml +++ b/swagger/sdrangel/api/swagger/include/Radiosonde.yaml @@ -3,26 +3,39 @@ RadiosondeSettings: 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." radiosondesColumnIndexes: type: array + description: "List of radiosondes column indexes." items: type: integer radiosondesColumnSizes: type: array + description: "List of radiosondes column sizes." items: type: integer diff --git a/swagger/sdrangel/api/swagger/include/RadiosondeDemod.yaml b/swagger/sdrangel/api/swagger/include/RadiosondeDemod.yaml index 89069e3fa..b5fa85d57 100644 --- a/swagger/sdrangel/api/swagger/include/RadiosondeDemod.yaml +++ b/swagger/sdrangel/api/swagger/include/RadiosondeDemod.yaml @@ -7,54 +7,82 @@ RadiosondeDemodSettings: 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: type: number format: float + description: "Minimum correlation score required to accept a frame preamble." 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 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." RadiosondeDemodReport: description: RadiosondeDemod @@ -65,3 +93,4 @@ RadiosondeDemodReport: format: float channelSampleRate: type: integer + description: "Effective sample rate delivered to the channel in samples per second." diff --git a/swagger/sdrangel/api/swagger/include/RemoteInput.yaml b/swagger/sdrangel/api/swagger/include/RemoteInput.yaml index b0ce39d43..cf081f6b4 100644 --- a/swagger/sdrangel/api/swagger/include/RemoteInput.yaml +++ b/swagger/sdrangel/api/swagger/include/RemoteInput.yaml @@ -3,35 +3,60 @@ RemoteInputSettings: properties: title: type: string + description: "User-visible title." apiAddress: type: string + description: "IPv4 address or host name of the API endpoint." apiPort: type: integer + description: "TCP port of the API endpoint." + minimum: 1 + maximum: 65535 dataAddress: type: string + description: "IPv4 address or host name used for data traffic." dataPort: type: integer + description: "Network port used for data traffic." + minimum: 1 + maximum: 65535 multicastAddress: type: string + description: "IP multicast group address." multicastJoin: type: integer + minimum: 0 + maximum: 1 description: > Join multicast group * 0 - leave group * 1 - join group 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." RemoteInputReport: description: RemoteInput @@ -39,8 +64,10 @@ RemoteInputReport: centerFrequency: type: integer format: int64 + description: "Device center frequency in Hz." sampleRate: type: integer + description: "Sample rate in samples per second." bufferRWBalance: description: percentage off the mid buffer (positive read leads) type: integer diff --git a/swagger/sdrangel/api/swagger/include/RemoteOutput.yaml b/swagger/sdrangel/api/swagger/include/RemoteOutput.yaml index 59a8f0ac7..94784c09a 100644 --- a/swagger/sdrangel/api/swagger/include/RemoteOutput.yaml +++ b/swagger/sdrangel/api/swagger/include/RemoteOutput.yaml @@ -3,8 +3,10 @@ RemoteOutputSettings: properties: title: type: string + description: "User-visible title." nbFECBlocks: type: integer + description: "Nb fec blocks setting for Remote output." nbTxBytes: type: integer description: > @@ -14,12 +16,20 @@ RemoteOutputSettings: * 4 apiAddress: type: string + description: "IPv4 address or host name of the API endpoint." apiPort: type: integer + description: "TCP port of the API endpoint." + minimum: 1 + maximum: 65535 dataAddress: type: string + description: "IPv4 address or host name used for data traffic." dataPort: type: integer + description: "Network port used for data traffic." + minimum: 1 + maximum: 65535 deviceIndex: description: remote SDRangel instance deviceset index type: integer @@ -29,12 +39,19 @@ RemoteOutputSettings: 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." RemoteOutputReport: description: RemoteOutput @@ -42,8 +59,10 @@ RemoteOutputReport: centerFrequency: type: integer format: int64 + description: "Device center frequency in Hz." sampleRate: type: integer + description: "Sample rate in samples per second." queueLength: description: "Data read/write queue length in number of data frames" type: integer diff --git a/swagger/sdrangel/api/swagger/include/RemoteSink.yaml b/swagger/sdrangel/api/swagger/include/RemoteSink.yaml index f560aeb39..0c1dce1bc 100644 --- a/swagger/sdrangel/api/swagger/include/RemoteSink.yaml +++ b/swagger/sdrangel/api/swagger/include/RemoteSink.yaml @@ -20,29 +20,45 @@ RemoteSinkSettings: dataPort: description: "Receiving USB data port" type: integer + minimum: 1 + maximum: 65535 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." 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." diff --git a/swagger/sdrangel/api/swagger/include/RemoteSource.yaml b/swagger/sdrangel/api/swagger/include/RemoteSource.yaml index 74374b30f..56ef93bd9 100644 --- a/swagger/sdrangel/api/swagger/include/RemoteSource.yaml +++ b/swagger/sdrangel/api/swagger/include/RemoteSource.yaml @@ -7,32 +7,48 @@ RemoteSourceSettings: dataPort: description: "Remote USB data port" type: integer + minimum: 1 + maximum: 65535 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." 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." RemoteSourceReport: description: "Remote channel source report" diff --git a/swagger/sdrangel/api/swagger/include/RemoteTCPInput.yaml b/swagger/sdrangel/api/swagger/include/RemoteTCPInput.yaml index e2e92a307..3e75e54aa 100644 --- a/swagger/sdrangel/api/swagger/include/RemoteTCPInput.yaml +++ b/swagger/sdrangel/api/swagger/include/RemoteTCPInput.yaml @@ -3,72 +3,118 @@ RemoteTCPInputSettings: properties: title: type: string + description: "User-visible title." 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 Remote TCP 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." inputFrequencyOffset: type: integer format: int64 + description: "Channel frequency offset from the device center frequency in Hz." channelGain: type: integer + description: "Channel gain setting for Remote TCP input." channelSampleRate: type: integer + description: "Effective sample rate delivered to the channel in samples per second." channelDecimation: type: integer + description: "Channel decimation setting for Remote TCP input." sampleBits: type: integer + description: "Number of significant bits in each sample." dataAddress: type: string + description: "IPv4 address or host name used for data traffic." dataPort: type: integer + description: "Network port used for data traffic." + minimum: 1 + maximum: 65535 overrideRemoteSettings: type: integer + description: "Override remote settings setting for Remote TCP input." preFill: type: integer + description: "Pre fill setting for Remote TCP input." protocol: description: (SDRangel or Spy Server) 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." RemoteTCPInputReport: description: RemoteTCPInput properties: sampleRate: type: integer + description: "Sample rate in samples per second." 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." diff --git a/swagger/sdrangel/api/swagger/include/RemoteTCPSink.yaml b/swagger/sdrangel/api/swagger/include/RemoteTCPSink.yaml index 428cab235..a9d19992c 100644 --- a/swagger/sdrangel/api/swagger/include/RemoteTCPSink.yaml +++ b/swagger/sdrangel/api/swagger/include/RemoteTCPSink.yaml @@ -3,40 +3,59 @@ RemoteTCPSinkSettings: properties: channelSampleRate: type: integer + description: "Effective sample rate delivered to the channel in samples per second." inputFrequencyOffset: type: integer format: int64 + description: "Channel frequency offset from the device center frequency in Hz." gain: type: integer + description: "Gain setting; units and available values depend on the device or plugin." sampleBits: type: integer + description: "Number of significant bits in each sample." dataAddress: description: "Receiving TCP data address" type: string dataPort: description: "Receiving TCP data port" type: integer + minimum: 1 + maximum: 65535 protocol: type: integer + description: "Protocol setting for Remote TCP sink." 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." diff --git a/swagger/sdrangel/api/swagger/include/RigCtlServer.yaml b/swagger/sdrangel/api/swagger/include/RigCtlServer.yaml index 5c338d3f4..2288ffad7 100644 --- a/swagger/sdrangel/api/swagger/include/RigCtlServer.yaml +++ b/swagger/sdrangel/api/swagger/include/RigCtlServer.yaml @@ -3,44 +3,63 @@ RigCtlServerSettings: properties: enabled: type: integer + minimum: 0 + maximum: 1 description: > Enable RigCtl server * 1 - enabled * 0 - disabled rigCtlPort: type: integer + description: "Rig ctl port." maxFrequencyOffset: type: integer + description: "Max frequency offset in Hz." deviceIndex: type: integer + description: "Selected device index." channelIndex: type: integer + description: "Selected channel index." 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." RigCtlServerReport: description: RigCtl server report properties: runningState: type: integer + minimum: 0 + maximum: 3 description: > Running state * 0 - not started @@ -53,6 +72,8 @@ RigCtlServerActions: properties: run: type: integer + minimum: 0 + maximum: 1 description: > Set the plugin running state * 0 - idle diff --git a/swagger/sdrangel/api/swagger/include/RollupState.yaml b/swagger/sdrangel/api/swagger/include/RollupState.yaml index e9d5f8863..0f5afedd7 100644 --- a/swagger/sdrangel/api/swagger/include/RollupState.yaml +++ b/swagger/sdrangel/api/swagger/include/RollupState.yaml @@ -3,8 +3,11 @@ RollupChildState: properties: objectName: type: string + description: "Object name for Rollup child state." isHidden: type: integer + minimum: 0 + maximum: 1 description: > Boolean - child hidden state * 0 - visible @@ -15,7 +18,9 @@ RollupState: properties: version: type: integer + description: "Version for Rollup state." childrenStates: type: array + description: "List of children states." items: $ref: "http://swgserver:8081/api/swagger/include/RollupState.yaml#/RollupChildState" diff --git a/swagger/sdrangel/api/swagger/include/RtlSdr.yaml b/swagger/sdrangel/api/swagger/include/RtlSdr.yaml index 45e16ffc7..64a35b512 100644 --- a/swagger/sdrangel/api/swagger/include/RtlSdr.yaml +++ b/swagger/sdrangel/api/swagger/include/RtlSdr.yaml @@ -3,46 +3,86 @@ RtlSdrSettings: properties: title: type: string + description: "User-visible title." devSampleRate: type: integer + description: > + RTL-SDR device I/Q sample rate in samples per second before software + decimation. The baseband sample rate delivered to channels is + devSampleRate / 2^log2Decim. lowSampleRate: type: integer + description: "Use the RTL-SDR low sample-rate range (1 enabled, 0 disabled)." centerFrequency: type: integer format: int64 + description: "Device center frequency in Hz." gain: type: integer + description: "Gain setting; units and available values depend on the device or plugin." loPpmCorrection: type: integer + description: "Local-oscillator correction in parts per million." log2Decim: type: integer + minimum: 0 + maximum: 6 + description: > + Base-2 exponent of the software decimation factor. The baseband sample + rate delivered to channels is devSampleRate / 2^log2Decim and must be + high enough for every channel's RF bandwidth. For example, broadcast FM + with 180 kHz RF bandwidth should use at least 240 kS/s (256 kS/s is + recommended); at 1.024 MS/s set log2Decim to 2, not 4. 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 iqImbalance: type: integer + description: "Enable DSP I/Q imbalance correction (1 enabled, 0 disabled)." + minimum: 0 + maximum: 1 agc: type: integer + description: "Enable automatic gain control (1 enabled, 0 disabled)." + minimum: 0 + maximum: 1 noModMode: type: integer + description: "No mod mode setting for Rtl sdr." offsetTuning: type: integer + description: "Enable tuner offset tuning (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) * 1 - I then Q (straight) rfBandwidth: type: integer + description: "RF bandwidth in Hz." biasTee: type: integer + minimum: 0 + maximum: 1 description: > Bias tee * 0 - inactive @@ -50,19 +90,28 @@ RtlSdrSettings: 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." RtlSdrReport: description: RTLSDR properties: gains: type: array + description: "List of gains." items: $ref: "http://swgserver:8081/api/swagger/include/Structs.yaml#/Gain" tunerType: type: string + description: "Reported tuner type." diff --git a/swagger/sdrangel/api/swagger/include/SDRPlay.yaml b/swagger/sdrangel/api/swagger/include/SDRPlay.yaml index d6621eabf..1cf784449 100644 --- a/swagger/sdrangel/api/swagger/include/SDRPlay.yaml +++ b/swagger/sdrangel/api/swagger/include/SDRPlay.yaml @@ -3,40 +3,61 @@ SDRPlaySettings: properties: title: type: string + description: "User-visible title." centerFrequency: type: integer format: int64 + description: "Device center frequency in Hz." tunerGain: type: integer + description: "Tuner gain setting for Sdr play." LOppmTenths: type: integer + description: "Local-oscillator correction in tenths of a part per million." frequencyBandIndex: type: integer + description: "Selected frequency band index." ifFrequencyIndex: type: integer + description: "Selected if frequency index." bandwidthIndex: type: integer + description: "Selected bandwidth index." 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." 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 tunerGainMode: description: 1 tuner (table) gain, 0 manual (LNA, Mixer, BB) gain type: integer lnaOn: type: integer + description: "LNA on setting for Sdr play." mixerAmpOn: type: integer + description: "Mixer amp on setting for Sdr play." basebandGain: type: integer + description: "Baseband gain setting for Sdr play." iqOrder: type: integer + minimum: 0 + maximum: 1 description: > IQ samples order * 0 - Q then I (swapped) @@ -44,29 +65,40 @@ SDRPlaySettings: 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." SDRPlayReport: description: SDRplay1 properties: sampleRates: type: array + description: "Supported sample rates in samples per second." items: $ref: "http://swgserver:8081/api/swagger/include/Structs.yaml#/SampleRate" bandwidths: type: array + description: "Supported bandwidths in Hz." items: $ref: "http://swgserver:8081/api/swagger/include/Structs.yaml#/Bandwidth" intermediateFrequencies: type: array + description: "List of intermediate frequencies." items: $ref: "http://swgserver:8081/api/swagger/include/Structs.yaml#/Frequency" frequencyBands: type: array + description: "List of frequency bands." items: $ref: "http://swgserver:8081/api/swagger/include/Structs.yaml#/FrequencyBand" diff --git a/swagger/sdrangel/api/swagger/include/SDRPlayV3.yaml b/swagger/sdrangel/api/swagger/include/SDRPlayV3.yaml index 78479d4ff..a9a748e6c 100644 --- a/swagger/sdrangel/api/swagger/include/SDRPlayV3.yaml +++ b/swagger/sdrangel/api/swagger/include/SDRPlayV3.yaml @@ -3,59 +3,90 @@ SDRPlayV3Settings: 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." ifFrequencyIndex: type: integer + description: "Selected if frequency index." bandwidthIndex: type: integer + description: "Selected bandwidth index." 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." 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 lnaIndex: type: integer + description: "Selected lna index." lnaGain: description: Gain in dB, as an alternative to lnaIndex setting type: integer ifAGC: type: integer + description: "IF agc setting for Sdr play v3." ifGain: type: integer + description: "Intermediate-frequency gain setting." amNotch: type: integer + description: "Am notch setting for Sdr play v3." fmNotch: type: integer + description: "FM notch setting for Sdr play v3." dabNotch: type: integer + description: "Dab notch setting for Sdr play v3." extRef: type: integer + description: "Ext ref setting for Sdr play v3." tuner: type: integer + description: "Tuner setting for Sdr play v3." antenna: type: integer + description: "Antenna setting for Sdr play v3." 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) biasTee: type: integer + minimum: 0 + maximum: 1 description: > Bias tee * 0 - inactive @@ -63,12 +94,19 @@ SDRPlayV3Settings: 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." SDRPlayV3Report: description: SDRplayV3 @@ -78,9 +116,11 @@ SDRPlayV3Report: description: SDRplay device type. Can be RSP1, RSP1A, RSP1B, RSP2, RSPduo, RSPdx, Unknown bandwidths: type: array + description: "Supported bandwidths in Hz." items: $ref: "http://swgserver:8081/api/swagger/include/Structs.yaml#/Bandwidth" intermediateFrequencies: type: array + description: "List of intermediate frequencies." items: $ref: "http://swgserver:8081/api/swagger/include/Structs.yaml#/Frequency" diff --git a/swagger/sdrangel/api/swagger/include/SID.yaml b/swagger/sdrangel/api/swagger/include/SID.yaml index 6bd0d7bab..7c6aacb89 100644 --- a/swagger/sdrangel/api/swagger/include/SID.yaml +++ b/swagger/sdrangel/api/swagger/include/SID.yaml @@ -4,28 +4,44 @@ SIDSettings: period: type: number format: float + description: "Period setting for Sid." autosave: type: integer + description: "Autosave setting for Sid." autoload: type: integer + description: "Autoload setting for Sid." filename: type: integer + description: "Filename setting for Sid." autosavePeriod: type: integer + description: "Autosave period setting for Sid." 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." diff --git a/swagger/sdrangel/api/swagger/include/SSBDemod.yaml b/swagger/sdrangel/api/swagger/include/SSBDemod.yaml index a3322dccc..12d7326e7 100644 --- a/swagger/sdrangel/api/swagger/include/SSBDemod.yaml +++ b/swagger/sdrangel/api/swagger/include/SSBDemod.yaml @@ -4,18 +4,25 @@ SSBDemodSettings: 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,6 +37,7 @@ SSBDemodSettings: volume: type: number format: float + description: "Audio volume multiplier." audioBinaural: description: Audio binaural mode (1 if active else 0) type: integer @@ -42,9 +50,13 @@ SSBDemodSettings: 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 agcClamping: description: AGC clamping (1 if AGC clampingactive else 0) type: integer @@ -59,12 +71,16 @@ SSBDemodSettings: type: integer dnr: type: integer + minimum: 0 + maximum: 1 description: > Toggle noise reduction: * 0 - Noise reduction off * 1 - Noise reduction on dnrScheme: type: integer + minimum: 0 + maximum: 2 description: > Noise reduction scheme: * 0 - Average of magnitudes @@ -87,30 +103,44 @@ SSBDemodSettings: description: Smoothing constant (alpha) of the exponential smoothing filter. Must be between 0 and 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." SSBDemodReport: description: SSBDemod @@ -124,5 +154,7 @@ SSBDemodReport: 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." diff --git a/swagger/sdrangel/api/swagger/include/SSBMod.yaml b/swagger/sdrangel/api/swagger/include/SSBMod.yaml index b21175a68..12cf377b6 100644 --- a/swagger/sdrangel/api/swagger/include/SSBMod.yaml +++ b/swagger/sdrangel/api/swagger/include/SSBMod.yaml @@ -4,68 +4,105 @@ SSBModSettings: inputFrequencyOffset: type: integer format: int64 + description: "Channel frequency offset from the device center frequency in Hz." bandwidth: type: number format: float + description: "Bandwidth in Hz." lowCutoff: type: number format: float + description: "Lower filter cutoff frequency in Hz." usb: type: integer + description: "USB setting for Ssb mod." toneFrequency: type: number format: float + description: "Tone frequency in Hz." volumeFactor: type: number format: float + description: "Volume factor setting for Ssb mod." spanLog2: type: integer + description: "Base-2 exponent controlling the displayed or processed frequency span." audioBinaural: type: integer + description: "Audio binaural setting for Ssb mod." audioFlipChannels: type: integer + description: "Audio flip channels setting for Ssb mod." dsb: type: integer + description: "Dsb setting for Ssb mod." 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 agc: type: integer + description: "Enable automatic gain control (1 enabled, 0 disabled)." + minimum: 0 + maximum: 1 cmpPreGainDB: type: integer + description: "Cmp pre gain dB in dB." cmpThresholdDB: type: integer + description: "Cmp threshold dB in dB." 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." 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." SSBModReport: description: SSBMod @@ -76,5 +113,7 @@ SSBModReport: 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." diff --git a/swagger/sdrangel/api/swagger/include/SatelliteTracker.yaml b/swagger/sdrangel/api/swagger/include/SatelliteTracker.yaml index a565eae31..7c658a641 100644 --- a/swagger/sdrangel/api/swagger/include/SatelliteTracker.yaml +++ b/swagger/sdrangel/api/swagger/include/SatelliteTracker.yaml @@ -5,10 +5,14 @@ SatelliteTrackerSettings: description: "Latitude in decimal degrees (North positive) of antenna location" type: number format: float + minimum: -90 + maximum: 90 longitude: description: "Longitude in decimal degrees (East positive) of antenna location" type: number format: float + minimum: -180 + maximum: 180 heightAboveSeaLevel: description: "Height above sea level in metres of antenna location" type: number @@ -100,26 +104,39 @@ SatelliteTrackerSettings: azimuthOffset: type: number format: float + description: "Azimuth offset setting for Satellite tracker." elevationOffset: type: number format: float + description: "Elevation offset setting for Satellite tracker." 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." SatelliteDeviceSettingsList: description: "List of device set settings for a satellite" @@ -179,6 +196,8 @@ SatelliteTrackerReport: properties: runningState: type: integer + minimum: 0 + maximum: 3 description: > Running state * 0 - not started @@ -188,11 +207,14 @@ SatelliteTrackerReport: 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." satelliteState: type: array + description: "List of satellite state." items: $ref: "http://swgserver:8081/api/swagger/include/SatelliteTracker.yaml#/SatelliteState" @@ -200,14 +222,19 @@ SatelliteState: properties: name: type: string + description: "Name." latitude: description: "Latitude of satellite in degrees" type: number format: float + minimum: -90 + maximum: 90 longitude: description: "Longitude of satellite in degrees" type: number format: float + minimum: -180 + maximum: 180 altitude: description: "Altitude of satellite in km" type: number @@ -238,6 +265,7 @@ SatelliteState: format: float passes: type: array + description: "List of passes." items: $ref: "http://swgserver:8081/api/swagger/include/SatelliteTracker.yaml#/SatellitePass" @@ -259,6 +287,8 @@ SatelliteTrackerActions: properties: run: type: integer + minimum: 0 + maximum: 1 description: > Set the plugin running state * 0 - idle diff --git a/swagger/sdrangel/api/swagger/include/SigMFFileInput.yaml b/swagger/sdrangel/api/swagger/include/SigMFFileInput.yaml index 5a5cf61af..01616e990 100644 --- a/swagger/sdrangel/api/swagger/include/SigMFFileInput.yaml +++ b/swagger/sdrangel/api/swagger/include/SigMFFileInput.yaml @@ -3,6 +3,7 @@ SigMFFileInputSettings: properties: title: type: string + description: "User-visible title." fileName: description: The name (path) of the file being read without extension type: string @@ -18,12 +19,19 @@ SigMFFileInputSettings: 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." SigMFFileInputReport: description: SigMFFileInput @@ -36,24 +44,32 @@ SigMFFileInputReport: type: integer sampleFormat: type: integer + minimum: 0 + maximum: 1 description: > Sample format * 0 - integer * 1 - float sampleSigned: type: integer + minimum: 0 + maximum: 1 description: > Sample signed status * 0 - unsigned * 1 - signed sampleSwapIQ: type: integer + minimum: 0 + maximum: 1 description: > Sample I/Q swap * 0 - I/Q * 1 - Q/I crcStatus: type: integer + minimum: 0 + maximum: 2 description: > CRC status * 0 - no CRC available @@ -61,12 +77,15 @@ SigMFFileInputReport: * 2 - CRC (SHA512) KO totalBytesStatus: type: integer + minimum: 0 + maximum: 1 description: > Total number of bytes in data file vs meta data * 0 - mismatch * 1 - match captures: type: array + description: "List of captures." items: $ref: "#/definitions/Capture" trackNumber: @@ -102,12 +121,16 @@ SigMFFileInputActions: properties: playTrack: type: integer + minimum: 0 + maximum: 1 description: > Play IQ stream action * 0 - stop playing * 1 - start playing current track playRecord: type: integer + minimum: 0 + maximum: 1 description: > Play IQ stream action * 0 - stop playing diff --git a/swagger/sdrangel/api/swagger/include/SigMFFileSink.yaml b/swagger/sdrangel/api/swagger/include/SigMFFileSink.yaml index d5638a0f4..472f66ec5 100644 --- a/swagger/sdrangel/api/swagger/include/SigMFFileSink.yaml +++ b/swagger/sdrangel/api/swagger/include/SigMFFileSink.yaml @@ -3,17 +3,23 @@ SigMFFileSinkSettings: properties: inputFrequencyOffset: type: integer + description: "Channel frequency offset from the device center frequency in Hz." fileRecordName: type: string description: full path of the meta 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 @@ SigMFFileSinkSettings: 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 @@ -43,26 +51,39 @@ SigMFFileSinkSettings: 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." SigMFFileSinkReport: description: SigMFFileSink properties: spectrumSquelch: type: integer + minimum: 0 + maximum: 1 description: > Spectrum squelch status * 0 - closed @@ -73,10 +94,14 @@ SigMFFileSinkReport: 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 @@ -97,6 +122,8 @@ SigMFFileSinkActions: properties: record: type: integer + minimum: 0 + maximum: 1 description: > Record action * 0 - stop recording diff --git a/swagger/sdrangel/api/swagger/include/SimplePTT.yaml b/swagger/sdrangel/api/swagger/include/SimplePTT.yaml index 80a0862af..ef81cff7b 100644 --- a/swagger/sdrangel/api/swagger/include/SimplePTT.yaml +++ b/swagger/sdrangel/api/swagger/include/SimplePTT.yaml @@ -3,8 +3,10 @@ SimplePTTSettings: properties: title: type: string + description: "User-visible title." rgbColor: type: integer + description: "Display color encoded as an RGB integer." rxDeviceSetIndex: description: index of the Rx device set to connect the Rx side to type: integer @@ -19,12 +21,16 @@ SimplePTTSettings: type: integer vox: type: integer + minimum: 0 + maximum: 1 description: > Activate vox system * 0 - not active * 1 - active voxEnable: type: integer + minimum: 0 + maximum: 1 description: > Allow vox to control PTT * 0 - vox does not control PTT @@ -37,8 +43,11 @@ SimplePTTSettings: description: Vox hold timeout in milliseconds audioDeviceName: type: string + description: "Name of the audio device to use." gpioControl: type: integer + minimum: 0 + maximum: 2 description: > GPIO control * 0 - No GPIO control @@ -46,6 +55,8 @@ SimplePTTSettings: * 2 - Tx side controls GPIO rx2txGPIOEnable: type: integer + minimum: 0 + maximum: 1 description: > Enable Rx to Tx GPIO control * 0 - disable @@ -60,6 +71,8 @@ SimplePTTSettings: description: Rx to Tx change GPIO values rx2txCommandEnable: type: integer + minimum: 0 + maximum: 1 description: > Enable Rx to Tx command * 0 - disable @@ -69,6 +82,8 @@ SimplePTTSettings: description: Command to be executed when Rx switches to Tx tx2rxGPIOEnable: type: integer + minimum: 0 + maximum: 1 description: > Enable Tx to Rx GPIO control * 0 - disable @@ -83,6 +98,8 @@ SimplePTTSettings: description: Tx to Rx change GPIO values tx2rxCommandEnable: type: integer + minimum: 0 + maximum: 1 description: > Enable Tx to Rx command * 0 - disable @@ -93,22 +110,33 @@ SimplePTTSettings: 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." SimplePTTReport: description: "Simple PTT report" properties: runningState: type: integer + minimum: 0 + maximum: 3 description: > Running state * 0 - not started @@ -117,6 +145,8 @@ SimplePTTReport: * 3 - error ptt: type: integer + minimum: 0 + maximum: 1 description: > PTT status * 0 - released @@ -127,12 +157,16 @@ SimplePTTActions: properties: run: type: integer + minimum: 0 + maximum: 1 description: > Set the plugin running state * 0 - idle * 1 - run ptt: type: integer + minimum: 0 + maximum: 1 description: > PTT action * 0 - release diff --git a/swagger/sdrangel/api/swagger/include/SkyMap.yaml b/swagger/sdrangel/api/swagger/include/SkyMap.yaml index 5fc620230..23596e5db 100644 --- a/swagger/sdrangel/api/swagger/include/SkyMap.yaml +++ b/swagger/sdrangel/api/swagger/include/SkyMap.yaml @@ -24,6 +24,7 @@ SkyMapSettings: type: string projection: type: string + description: "Projection setting for Sky map." source: description: "Channel or Feature plugin to get target from" type: string @@ -34,10 +35,14 @@ SkyMapSettings: description: "Latitude in decimal degrees (North positive) of observation/antenna location" type: number format: float + minimum: -90 + maximum: 90 longitude: description: "Longitude in decimal degrees (East positive) of observation/antenna location" type: number format: float + minimum: -180 + maximum: 180 altitude: description: "Altitude in metres of observation/antenna location" type: number @@ -50,23 +55,36 @@ SkyMapSettings: description: "Use My Position instead of latitude/longitude settings" type: number format: float + 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." SkyMapReport: description: Sky Map @@ -86,10 +104,14 @@ SkyMapReport: description: "Latitude in decimal degrees (North positive) of observation/antenna location" type: number format: float + minimum: -90 + maximum: 90 longitude: description: "Longitude in decimal degrees (East positive) of observation/antenna location" type: number format: float + minimum: -180 + maximum: 180 altitude: description: "Altitude in metres of observation/antenna location" type: number @@ -129,10 +151,14 @@ SkyMapTarget: description: "Latitude in decimal degrees (North positive) of observation/antenna location" type: number format: float + minimum: -90 + maximum: 90 longitude: description: "Longitude in decimal degrees (East positive) of observation/antenna location" type: number format: float + minimum: -180 + maximum: 180 altitude: description: "Altitude in metres of observation/antenna location" type: number diff --git a/swagger/sdrangel/api/swagger/include/SoapySDR.yaml b/swagger/sdrangel/api/swagger/include/SoapySDR.yaml index d826e3bd5..f5e1111ed 100644 --- a/swagger/sdrangel/api/swagger/include/SoapySDR.yaml +++ b/swagger/sdrangel/api/swagger/include/SoapySDR.yaml @@ -3,195 +3,281 @@ SoapySDRInputSettings: 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." 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." softDCCorrection: description: boolean not zero for true type: integer + minimum: 0 + maximum: 1 softIQCorrection: description: boolean not zero for true type: integer + minimum: 0 + maximum: 1 transverterMode: description: boolean not zero for true type: integer + 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) antenna: type: string + description: "Antenna setting for Soapy sdr input." bandwidth: type: integer + description: "Bandwidth in Hz." tunableElements: type: array + description: "List of tunable elements." items: $ref: "#/definitions/ArgValue" globalGain: type: integer + description: "Overall device gain setting." individualGains: type: array + description: "List of individual gains." items: $ref: "#/definitions/ArgValue" autoGain: description: boolean not zero for true type: integer + minimum: 0 + maximum: 1 autoDCCorrection: description: boolean not zero for true type: integer + minimum: 0 + maximum: 1 autoIQCorrection: description: boolean not zero for true type: integer + minimum: 0 + maximum: 1 dcCorrection: $ref: "http://swgserver:8081/api/swagger/include/Structs.yaml#/Complex" + description: "Enable DC-offset correction (1 enabled, 0 disabled)." iqCorrection: $ref: "http://swgserver:8081/api/swagger/include/Structs.yaml#/Complex" + description: "Enable I/Q imbalance correction (1 enabled, 0 disabled)." streamArgSettings: type: array + description: "List of stream arg settings." items: $ref: "#/definitions/ArgValue" deviceArgSettings: type: array + description: "List of device arg settings." items: $ref: "#/definitions/ArgValue" 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." SoapySDROutputSettings: description: SoapySDR 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." log2Interp: type: integer + description: "Base-2 exponent of the software interpolation factor; the output sample rate is multiplied by 2^log2Interp." transverterMode: description: boolean not zero for true type: integer + minimum: 0 + maximum: 1 transverterDeltaFrequency: type: integer format: int64 + description: "Frequency translation applied in transverter mode in Hz." antenna: type: string + description: "Antenna setting for Soapy sdr output." bandwidth: type: integer + description: "Bandwidth in Hz." tunableElements: type: array + description: "List of tunable elements." items: $ref: "#/definitions/ArgValue" globalGain: type: integer + description: "Overall device gain setting." individualGains: type: array + description: "List of individual gains." items: $ref: "#/definitions/ArgValue" autoGain: description: boolean not zero for true type: integer + minimum: 0 + maximum: 1 autoDCCorrection: description: boolean not zero for true type: integer + minimum: 0 + maximum: 1 autoIQCorrection: description: boolean not zero for true type: integer + minimum: 0 + maximum: 1 dcCorrection: $ref: "http://swgserver:8081/api/swagger/include/Structs.yaml#/Complex" + description: "Enable DC-offset correction (1 enabled, 0 disabled)." iqCorrection: $ref: "http://swgserver:8081/api/swagger/include/Structs.yaml#/Complex" + description: "Enable I/Q imbalance correction (1 enabled, 0 disabled)." streamArgSettings: type: array + description: "List of stream arg settings." items: $ref: "#/definitions/ArgValue" deviceArgSettings: type: array + description: "List of device arg settings." items: $ref: "#/definitions/ArgValue" 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." SoapySDRReport: description: SoapySDR properties: deviceSettingsArgs: type: array + description: "List of device settings args." items: $ref: "#/definitions/ArgInfo" streamSettingsArgs: type: array + description: "List of stream settings args." items: $ref: "#/definitions/ArgInfo" hasDCAutoCorrection: description: boolean not zero for true type: integer + minimum: 0 + maximum: 1 hasDCOffsetValue: description: boolean not zero for true type: integer + minimum: 0 + maximum: 1 hasIQBalanceValue: description: boolean not zero for true type: integer + minimum: 0 + maximum: 1 hasFrequencyCorrectionValue: description: boolean not zero for true type: integer + minimum: 0 + maximum: 1 antennas: type: array + description: "List of antennas." items: type: string hasAGC: description: boolean not zero for true type: integer + minimum: 0 + maximum: 1 gainRange: $ref: "http://swgserver:8081/api/swagger/include/Structs.yaml#/RangeFloat" + description: "Gain range data for Soapy sdr." gainSettings: type: array + description: "List of gain settings." items: $ref: "#/definitions/SoapySDRGainSetting" frequencySettings: type: array + description: "List of frequency settings." items: $ref: "#/definitions/SoapySDRFrequencySetting" frequencySettingsArgs: type: array + description: "List of frequency settings args." items: $ref: "#/definitions/ArgInfo" ratesRanges: type: array + description: "List of rates ranges." items: $ref: "http://swgserver:8081/api/swagger/include/Structs.yaml#/RangeFloat" bandwidthsRanges: type: array + description: "List of bandwidths ranges." items: $ref: "http://swgserver:8081/api/swagger/include/Structs.yaml#/RangeFloat" @@ -202,16 +288,20 @@ definitions: properties: name: type: string + description: "Name." range: $ref: "http://swgserver:8081/api/swagger/include/Structs.yaml#/RangeFloat" + description: "Range configuration for Definitions." SoapySDRFrequencySetting: description: A named frequency setting specified by a range list properties: name: type: string + description: "Name." ranges: type: array + description: "List of ranges." items: $ref: "http://swgserver:8081/api/swagger/include/Structs.yaml#/RangeFloat" @@ -220,35 +310,47 @@ definitions: properties: key: type: string + description: "Key for Definitions." valueType: type: string + description: "Value type for Definitions." enum: [bool, int, float, string] valueString: type: string + description: "Value string for Definitions." ArgInfo: description: Generic argument information properties: key: type: string + description: "Key for Definitions." valueType: type: string + description: "Value type for Definitions." enum: [bool, int, float, string] valueString: type: string + description: "Value string for Definitions." name: type: string + description: "Name." description: type: string + description: "Human-readable description." units: type: string + description: "Units for Definitions." range: $ref: "http://swgserver:8081/api/swagger/include/Structs.yaml#/RangeFloat" + description: "Range configuration for Definitions." valueOptions: type: array + description: "List of value options." items: type: string optionNames: type: array + description: "List of option names." items: type: string diff --git a/swagger/sdrangel/api/swagger/include/StarTracker.yaml b/swagger/sdrangel/api/swagger/include/StarTracker.yaml index 84416821a..f226bac1c 100644 --- a/swagger/sdrangel/api/swagger/include/StarTracker.yaml +++ b/swagger/sdrangel/api/swagger/include/StarTracker.yaml @@ -38,10 +38,14 @@ StarTrackerSettings: description: "Latitude in decimal degrees (North positive) of observation/antenna location" type: number format: float + minimum: -90 + maximum: 90 longitude: description: "Longitude in decimal degrees (East positive) of observation/antenna location" type: number format: float + minimum: -180 + maximum: 180 dateTime: description: "Date and time of observation. ISO 8601 extended format: yyyy-MM-ddTHH:mm:ss with Z suffix for UTC. Empty string for current time." type: string @@ -75,6 +79,8 @@ StarTrackerSettings: stellariumServerEnabled: description: "Enable Stellarium server (1 for yes, 0 for no)" type: integer + minimum: 0 + maximum: 1 stellariumPort: description: "IP port number for Stellarium server to listen on (Default is 10001)." type: integer @@ -96,21 +102,32 @@ StarTrackerSettings: 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." StarTrackerTarget: description: "Star Tracker target. Sent to startracker.target message queue for other plugins to use." @@ -191,6 +208,7 @@ StarTrackerDisplayLoSSettings: properties: name: type: string + description: "Name." b: description: "Galactic latitude in degrees" type: number @@ -209,6 +227,8 @@ StarTrackerReport: properties: runningState: type: integer + minimum: 0 + maximum: 3 description: > Running state * 0 - not started @@ -221,6 +241,8 @@ StarTrackerActions: properties: run: type: integer + minimum: 0 + maximum: 1 description: > Set the plugin running state * 0 - idle diff --git a/swagger/sdrangel/api/swagger/include/Structs.yaml b/swagger/sdrangel/api/swagger/include/Structs.yaml index f5c1c1ddc..138f6d7d1 100644 --- a/swagger/sdrangel/api/swagger/include/Structs.yaml +++ b/swagger/sdrangel/api/swagger/include/Structs.yaml @@ -3,47 +3,58 @@ SampleRate: properties: rate: type: integer + description: "Sample rate in samples per second." Bandwidth: description: A bandwidth expressed in Hertz (Hz) properties: bandwidth: type: integer + description: "Bandwidth in Hz." Frequency: description: A frequency expressed in Hertz (Hz) properties: frequency: type: integer + description: "Frequency in Hz." FrequencyBand: description: A band of frequencies given its boundaries in Hertz (Hz) properties: name: type: string + description: "Name." lowerBound: type: integer + description: "Inclusive lower bound of the range." higherBound: type: integer + description: "Inclusive upper bound of the range." Gain: description: A gain expressed in centi-Bels (tenths of dB) properties: gainCB: type: integer + description: "Gain in centibels (tenths of a decibel)." Range: description: An arbitrary range of integer values properties: min: type: integer + description: "Minimum value of the range." max: type: integer + description: "Maximum value of the range." step: type: integer + description: "Increment between adjacent supported values." scale: type: number format: float + description: "Scale factor applied to the value." RangeFloat: description: An arbitrary range of floating point values @@ -51,12 +62,15 @@ RangeFloat: min: type: number format: float + description: "Minimum value of the range." max: type: number format: float + description: "Maximum value of the range." step: type: number format: float + description: "Increment between adjacent supported values." FrequencyRange: description: A frequency range with 64 bit support for min and max @@ -64,22 +78,28 @@ FrequencyRange: min: type: integer format: int64 + description: "Minimum value of the range." max: type: integer format: int64 + description: "Maximum value of the range." step: type: integer + description: "Increment between adjacent supported values." scale: type: number format: float + description: "Scale factor applied to the value." NamedEnum: description: Enumeration with name for values properties: name: type: string + description: "Name." value: type: integer + description: "Numeric enumeration value." Complex: description: A complex number @@ -87,6 +107,8 @@ Complex: real: type: number format: float + description: "Real component of the complex number." imag: type: number format: float + description: "Imaginary component of the complex number." diff --git a/swagger/sdrangel/api/swagger/include/TestMI.yaml b/swagger/sdrangel/api/swagger/include/TestMI.yaml index d13bacf3d..d435d923a 100644 --- a/swagger/sdrangel/api/swagger/include/TestMI.yaml +++ b/swagger/sdrangel/api/swagger/include/TestMI.yaml @@ -3,15 +3,23 @@ TestMISettings: 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." streams: description: Settings for each of the streams type: array @@ -28,37 +36,53 @@ definitions: centerFrequency: type: integer format: int64 + description: "Device center frequency in Hz." frequencyShift: type: integer + description: "Frequency shift in Hz." sampleRate: type: integer + description: "Sample rate in samples per second." 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." sampleSizeIndex: type: integer + description: "Selected sample size index." amplitudeBits: type: integer + description: "Amplitude bits for Definitions." autoCorrOptions: type: integer + description: "Auto corr options for Definitions." modulation: type: integer + description: "Modulation for Definitions." modulationTone: type: integer + description: "Modulation tone for Definitions." amModulation: type: integer + description: "Am modulation for Definitions." fmDeviation: type: integer + description: "FM frequency deviation in Hz." dcFactor: type: number format: float + description: "Dc factor for Definitions." iFactor: type: number format: float + description: "I factor for Definitions." qFactor: type: number format: float + description: "Q factor for Definitions." phaseImbalance: type: number format: float + description: "Phase imbalance for Definitions." diff --git a/swagger/sdrangel/api/swagger/include/TestMOSync.yaml b/swagger/sdrangel/api/swagger/include/TestMOSync.yaml index 75c9975a8..6ae5f81e8 100644 --- a/swagger/sdrangel/api/swagger/include/TestMOSync.yaml +++ b/swagger/sdrangel/api/swagger/include/TestMOSync.yaml @@ -3,14 +3,18 @@ TestMOSyncSettings: properties: title: type: string + description: "User-visible title." 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." fcPosTx: description: See BladeRF2MIMO::fcPos_t type: integer diff --git a/swagger/sdrangel/api/swagger/include/TestSource.yaml b/swagger/sdrangel/api/swagger/include/TestSource.yaml index e575929da..cab8172a6 100644 --- a/swagger/sdrangel/api/swagger/include/TestSource.yaml +++ b/swagger/sdrangel/api/swagger/include/TestSource.yaml @@ -3,49 +3,73 @@ TestSourceSettings: properties: title: type: string + description: "User-visible title." centerFrequency: type: integer format: int64 + description: "Device center frequency in Hz." frequencyShift: type: integer + description: "Frequency shift in Hz." sampleRate: type: integer + description: "Sample rate in samples per second." 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." sampleSizeIndex: type: integer + description: "Selected sample size index." amplitudeBits: type: integer + description: "Amplitude bits setting for Test source." autoCorrOptions: type: integer + description: "Auto corr options setting for Test source." modulation: type: integer + description: "Modulation setting for Test source." modulationTone: type: integer + description: "Modulation tone setting for Test source." amModulation: type: integer + description: "Am modulation setting for Test source." fmDeviation: type: integer + description: "FM frequency deviation in Hz." dcFactor: type: number format: float + description: "Dc factor setting for Test source." iFactor: type: number format: float + description: "I factor setting for Test source." qFactor: type: number format: float + description: "Q factor setting for Test source." phaseImbalance: type: number format: float + description: "Phase imbalance setting for Test source." 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." diff --git a/swagger/sdrangel/api/swagger/include/UDPSink.yaml b/swagger/sdrangel/api/swagger/include/UDPSink.yaml index 9ce5085c9..4e607e911 100644 --- a/swagger/sdrangel/api/swagger/include/UDPSink.yaml +++ b/swagger/sdrangel/api/swagger/include/UDPSink.yaml @@ -4,22 +4,30 @@ UDPSinkSettings: outputSampleRate: type: number format: float + description: "Output sample rate in samples per second." sampleFormat: type: integer + description: "Sample format setting for UDP sink." 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: integer + description: "FM frequency deviation in Hz." channelMute: description: channel mute (1 if muted else 0) type: integer + minimum: 0 + maximum: 1 gain: type: number format: float + description: "Gain setting; units and available values depend on the device or plugin." squelchDB: description: power dB type: integer @@ -29,17 +37,26 @@ UDPSinkSettings: squelchEnabled: description: squelch enable (1 if enabled else 0) type: integer + minimum: 0 + maximum: 1 agc: description: AGC enable (1 if enabled else 0) type: integer + minimum: 0 + maximum: 1 audioActive: description: Audio return enable (1 if enabled else 0) type: integer + minimum: 0 + maximum: 1 audioStereo: description: Audio return stereo (1 if stereo else 0) type: integer + minimum: 0 + maximum: 1 volume: type: integer + description: "Audio volume multiplier." udpAddress: description: destination UDP address (remote) type: string @@ -47,34 +64,49 @@ UDPSinkSettings: description: destination UDP port (remote) type: integer format: uint16 + minimum: 1 + maximum: 65535 audioPort: description: audio return UDP port (local) type: integer format: uint16 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." UDPSinkReport: description: UDPSink @@ -92,3 +124,4 @@ UDPSinkReport: type: integer inputSampleRate: type: integer + description: "Input sample rate in samples per second." diff --git a/swagger/sdrangel/api/swagger/include/UDPSource.yaml b/swagger/sdrangel/api/swagger/include/UDPSource.yaml index 6d9c40a71..cd97b25fb 100644 --- a/swagger/sdrangel/api/swagger/include/UDPSource.yaml +++ b/swagger/sdrangel/api/swagger/include/UDPSource.yaml @@ -3,80 +3,119 @@ UDPSourceSettings: properties: sampleFormat: type: integer + description: "Sample format setting for UDP source." inputSampleRate: type: number format: float + description: "Input sample rate in samples per second." 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." lowCutoff: type: number format: float + description: "Lower filter cutoff frequency in Hz." fmDeviation: type: integer + description: "FM frequency deviation in Hz." amModFactor: type: number format: float + description: "Am mod factor setting for UDP source." channelMute: type: integer + description: "Mute the channel output (1 muted, 0 unmuted)." + minimum: 0 + maximum: 1 gainIn: type: number format: float + description: "Gain in setting for UDP source." gainOut: type: number format: float + description: "Gain out setting for UDP source." squelch: type: number format: float + description: "Squelch threshold in dB." squelchGate: type: number format: float + description: "Squelch gate duration." squelchEnabled: type: integer + description: "Enable squelch (1 enabled, 0 disabled)." + minimum: 0 + maximum: 1 autoRWBalance: type: integer + description: "Auto rw balance setting for UDP source." stereoInput: type: integer + description: "Stereo input setting for UDP source." rgbColor: type: integer + description: "Display color encoded as an RGB integer." udpAddress: type: string + description: "IPv4 address or host name used for UDP traffic." udpPort: type: integer format: uint16 + description: "UDP port number." + minimum: 1 + maximum: 65535 multicastAddress: type: string + description: "IP multicast group address." multicastJoin: type: integer + minimum: 0 + maximum: 1 description: > Join multicast group * 0 - leave group * 1 - join group 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." UDPSourceReport: description: UDPSource @@ -97,3 +136,4 @@ UDPSourceReport: type: integer channelSampleRate: type: integer + description: "Effective sample rate delivered to the channel in samples per second." diff --git a/swagger/sdrangel/api/swagger/include/USRP.yaml b/swagger/sdrangel/api/swagger/include/USRP.yaml index c8ad85a30..f1d32c1b3 100644 --- a/swagger/sdrangel/api/swagger/include/USRP.yaml +++ b/swagger/sdrangel/api/swagger/include/USRP.yaml @@ -3,93 +3,143 @@ USRPInputSettings: 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." loOffset: type: integer + description: "LO offset setting for Usrp 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 log2SoftDecim: type: integer + description: "Base-2 exponent of the software decimation factor." lpfBW: type: integer + description: "Analog low-pass filter bandwidth in Hz." antennaPath: type: string + description: "Selected RF antenna path." gain: type: integer + description: "Gain setting; units and available values depend on the device or plugin." gainMode: description: 0 for auto, 1 for manual type: integer clockSource: type: string + description: "Clock source setting for Usrp input." 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." USRPOutputSettings: description: USRP 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." loOffset: type: integer + description: "LO offset setting for Usrp output." log2SoftInterp: type: integer + description: "Base-2 exponent of the software interpolation factor." lpfBW: type: integer + description: "Analog low-pass filter bandwidth in Hz." gain: type: integer + description: "Gain setting; units and available values depend on the device or plugin." antennaPath: type: string + description: "Selected RF antenna path." clockSource: type: string + description: "Clock source setting for Usrp 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." 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." USRPInputReport: description: USRP @@ -100,10 +150,14 @@ USRPInputReport: streamActive: description: 1 if active else 0 type: integer + minimum: 0 + maximum: 1 overrunCount: type: integer + description: "Number of stream overrun events." timeoutCount: type: integer + description: "Number of timeout events or items." USRPOutputReport: description: USRP @@ -114,7 +168,11 @@ USRPOutputReport: streamActive: description: 1 if active else 0 type: integer + minimum: 0 + maximum: 1 underrunCount: type: integer + description: "Number of stream underrun events." droppedPacketsCount: type: integer + description: "Number of dropped packets." diff --git a/swagger/sdrangel/api/swagger/include/User.yaml b/swagger/sdrangel/api/swagger/include/User.yaml index e4c4ca4c8..fd505ade6 100644 --- a/swagger/sdrangel/api/swagger/include/User.yaml +++ b/swagger/sdrangel/api/swagger/include/User.yaml @@ -5,5 +5,7 @@ User: properties: index: type: integer + description: "Index for User." name: type: string + description: "Name." diff --git a/swagger/sdrangel/api/swagger/include/VORDemod.yaml b/swagger/sdrangel/api/swagger/include/VORDemod.yaml index c15499ba0..175d84c96 100644 --- a/swagger/sdrangel/api/swagger/include/VORDemod.yaml +++ b/swagger/sdrangel/api/swagger/include/VORDemod.yaml @@ -4,6 +4,7 @@ VORDemodSettings: inputFrequencyOffset: type: integer format: int64 + description: "Channel frequency offset from the device center frequency in Hz." navId: description: VOR unique identifier when set by VOR localizer feature type: integer @@ -14,37 +15,55 @@ VORDemodSettings: volume: type: number format: float + description: "Audio volume multiplier." audioMute: type: integer + description: "Mute audio output (1 muted, 0 unmuted)." + minimum: 0 + maximum: 1 identBandpassEnable: type: integer + description: "Ident bandpass enable setting for Vor 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." 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." identThreshold: description: Morse code ident threshold (linear SNR) type: integer 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." VORDemodReport: description: VORDemod @@ -58,9 +77,11 @@ VORDemodReport: type: integer audioSampleRate: type: integer + description: "Audio sample rate in samples per second." volume: type: number format: float + description: "Audio volume multiplier." navId: description: VOR unique identifier when set by VOR localizer feature type: integer @@ -78,18 +99,24 @@ VORDemodReport: format: float validRadial: type: integer + minimum: 0 + maximum: 1 description: > Radial validity estimation * 0 - Radial is invalid * 1 - Radial is valid validRefMag: type: integer + minimum: 0 + maximum: 1 description: > Reference signal magnitude validity * 0 - Magnitude below threshold * 1 - Magnitude above threshold validVarMag: type: integer + minimum: 0 + maximum: 1 description: > Variable signal magnitude validity * 0 - Magnitude below threshold diff --git a/swagger/sdrangel/api/swagger/include/VORDemodMC.yaml b/swagger/sdrangel/api/swagger/include/VORDemodMC.yaml index 02da32e46..011800dfb 100644 --- a/swagger/sdrangel/api/swagger/include/VORDemodMC.yaml +++ b/swagger/sdrangel/api/swagger/include/VORDemodMC.yaml @@ -8,28 +8,43 @@ VORDemodMCSettings: volume: type: number format: float + description: "Audio volume multiplier." audioMute: type: integer + description: "Mute audio 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." 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." identThreshold: description: Morse code ident threshold (linear SNR) type: integer @@ -38,8 +53,10 @@ VORDemodMCSettings: type: integer 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." VORDemodMCReport: description: VORDemodMC @@ -53,3 +70,4 @@ VORDemodMCReport: type: integer audioSampleRate: type: integer + description: "Audio sample rate in samples per second." diff --git a/swagger/sdrangel/api/swagger/include/VORLocalizer.yaml b/swagger/sdrangel/api/swagger/include/VORLocalizer.yaml index 99940c54d..9afee06e1 100644 --- a/swagger/sdrangel/api/swagger/include/VORLocalizer.yaml +++ b/swagger/sdrangel/api/swagger/include/VORLocalizer.yaml @@ -3,19 +3,29 @@ VORLocalizerSettings: properties: rgbColor: type: integer + description: "Display color encoded as an RGB integer." 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 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." magDecAdjust: description: Adjust radial lines on map for magnetic declination of VOR type: integer @@ -24,6 +34,8 @@ VORLocalizerSettings: type: integer forceRRAveraging: type: integer + minimum: 0 + maximum: 1 description: > Force radial and signal magnitudes averaging over the round robin turn * 0 - Do not force averaging @@ -33,12 +45,15 @@ VORLocalizerSettings: type: integer rollupState: $ref: "http://swgserver:8081/api/swagger/include/RollupState.yaml#/RollupState" + description: "Saved expanded or collapsed state of the GUI sections." columnIndexes: type: array + description: "List of column indexes." items: type: integer columnSizes: type: array + description: "List of column sizes." items: type: integer @@ -47,6 +62,8 @@ VORLocalizerReport: properties: runningState: type: integer + minimum: 0 + maximum: 3 description: > Running state * 0 - not started @@ -59,6 +76,8 @@ VORLocalizerActions: properties: run: type: integer + minimum: 0 + maximum: 1 description: > Set the plugin running state * 0 - idle diff --git a/swagger/sdrangel/api/swagger/include/WDSPRx.yaml b/swagger/sdrangel/api/swagger/include/WDSPRx.yaml index 21a72ccc6..eff379856 100644 --- a/swagger/sdrangel/api/swagger/include/WDSPRx.yaml +++ b/swagger/sdrangel/api/swagger/include/WDSPRx.yaml @@ -4,10 +4,14 @@ WDSPRxSettings: inputFrequencyOffset: type: integer format: int64 + description: "Channel frequency offset from the device center frequency in Hz." profileIndex: type: integer + description: "Selected profile index." demod: type: integer + minimum: 0 + maximum: 3 description: > Demodulator type: * 0 - SSB @@ -17,6 +21,7 @@ WDSPRxSettings: volume: type: number format: float + description: "Audio volume multiplier." audioBinaural: description: Audio binaural mode (1 if active else 0) type: integer @@ -29,11 +34,17 @@ WDSPRxSettings: 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 agcMode: type: integer + minimum: 0 + maximum: 3 description: > AGC Mode: * 0 - Long @@ -48,20 +59,27 @@ WDSPRxSettings: description: Slope in centi-Bels agcHangThreshold: type: integer + description: "Agc hang threshold setting for Wdsp receive." dnb: type: integer + minimum: 0 + maximum: 1 description: > Digital Noise Blanker: * 0 - Off * 1 - On nbScheme: type: integer + minimum: 0 + maximum: 1 description: > Noise blanker scheme: * 0 - NB or Preemptive Wideband Noise Blanker * 1 - NB2 or Interpolating Wideband Noise Blanker nb2Mode: type: integer + minimum: 0 + maximum: 4 description: > NB2 Noise blanking mode: * 0 - Zero mode (estimate as zero) @@ -83,29 +101,39 @@ WDSPRxSettings: description: Hang time (S) nbThreshold: type: integer + description: "Nb threshold setting for Wdsp receive." nbAvgTime: type: number format: float + description: "Nb avg time setting for Wdsp receive." dnr: type: integer + minimum: 0 + maximum: 1 description: > Digital Noise Reduction: * 0 - Off * 1 - On anf: type: integer + minimum: 0 + maximum: 1 description: > Automatic Notch Filter: * 0 - Off * 1 - On nrScheme: type: integer + minimum: 0 + maximum: 1 description: > Noise Reduction Scheme: * 0 - NR or LMS Noise Reduction * 1 - NR2 or Spectral Noise Reduction nr2Gain: type: integer + minimum: 0 + maximum: 2 description: > Noise Reduction gain for NR2: * 0 - Linear @@ -113,30 +141,40 @@ WDSPRxSettings: * 2 - Gamma nr2NPE: type: integer + minimum: 0 + maximum: 1 description: > Noise Power Estimation algorithm for NR2: * 0 - Optimal Smoothing Minimum Statistics (OSMS) * 1 - Minimum Mean‐Square Error (MMSE) nrPosition: type: integer + minimum: 0 + maximum: 1 description: > Noise reduction position: * 0 - Before AGC * 1 - After AGC nr2ArtifactReduction: type: integer + minimum: 0 + maximum: 1 description: > NR2 artifacts reduction: * 0 - Off * 1 - On amFadeLevel: type: integer + minimum: 0 + maximum: 1 description: > AM fade levelling: * 0 - Off * 1 - On cwPeaking: type: integer + minimum: 0 + maximum: 1 description: > CW peaking filter: * 0 - Off @@ -173,6 +211,8 @@ WDSPRxSettings: FM Audio filter high cutoff frequency (HZ) fmAFLimiter: type: integer + minimum: 0 + maximum: 1 description: > FM Audio level limiter (audio AGC) * 0 - Off @@ -184,6 +224,8 @@ WDSPRxSettings: FM Audio level limiter top gain (Audio AGC top gain) fmCTCSSNotch: type: integer + minimum: 0 + maximum: 1 description: > FM CTCSS notch filter * 0 - Off @@ -195,6 +237,8 @@ WDSPRxSettings: FM CTCSS notch filter frequency (Hz) squelch: type: integer + minimum: 0 + maximum: 1 description: > Squelch: * 0 - Off @@ -204,6 +248,8 @@ WDSPRxSettings: description: Squelch threshold (percent) squelchMode: type: integer + minimum: 0 + maximum: 2 description: > Squelch mode: * 0 - Voice squelch (for SSB). Based on voice artifacts. @@ -212,6 +258,8 @@ WDSPRxSettings: ssqlTauMute: type: number format: float + minimum: 0 + maximum: 1 description: Voice squelch tau mute (s) ssqlTauUnmute: type: number @@ -223,6 +271,8 @@ WDSPRxSettings: description: AM squelch max tail length (s) equalizer: type: integer + minimum: 0 + maximum: 1 description: > AF equalizer: * 0 - Off @@ -241,6 +291,8 @@ WDSPRxSettings: format: float rit: type: integer + minimum: 0 + maximum: 1 description: > RIT: * 0 - Off @@ -251,44 +303,63 @@ WDSPRxSettings: description: RIT shift frequency (Hz) 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: 1 description: > FFT Window index (FFTWindow::Function): * 0 - Blackman-Harris 4 term * 1 - Blackman-Harris 7 term 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." WDSPRxReport: description: WDSPRx @@ -302,5 +373,7 @@ WDSPRxReport: 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." diff --git a/swagger/sdrangel/api/swagger/include/WFMDemod.yaml b/swagger/sdrangel/api/swagger/include/WFMDemod.yaml index 21210940a..287c0ae06 100644 --- a/swagger/sdrangel/api/swagger/include/WFMDemod.yaml +++ b/swagger/sdrangel/api/swagger/include/WFMDemod.yaml @@ -4,45 +4,65 @@ WFMDemodSettings: 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." volume: type: number format: float + description: "Audio volume multiplier." squelch: type: number format: float + description: "Squelch threshold in dB." audioMute: description: audio mute (1 if muted 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." 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." WFMDemodReport: description: WFMDemod @@ -56,5 +76,7 @@ WFMDemodReport: 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." diff --git a/swagger/sdrangel/api/swagger/include/WFMMod.yaml b/swagger/sdrangel/api/swagger/include/WFMMod.yaml index 8d0a1dc58..4c5841422 100644 --- a/swagger/sdrangel/api/swagger/include/WFMMod.yaml +++ b/swagger/sdrangel/api/swagger/include/WFMMod.yaml @@ -4,53 +4,80 @@ WFMModSettings: 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 Wfm 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." WFMModReport: description: WFMMod @@ -61,5 +88,7 @@ WFMModReport: 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." diff --git a/swagger/sdrangel/api/swagger/include/Xtrx.yaml b/swagger/sdrangel/api/swagger/include/Xtrx.yaml index a11cd599b..73abeae27 100644 --- a/swagger/sdrangel/api/swagger/include/Xtrx.yaml +++ b/swagger/sdrangel/api/swagger/include/Xtrx.yaml @@ -3,21 +3,30 @@ XtrxInputSettings: 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: description: Software DC blocking (1 for yes, 0 for no) type: integer + minimum: 0 + maximum: 1 iqCorrection: description: Software IQ imbalance correction (1 for yes, 0 for no) type: integer + minimum: 0 + maximum: 1 log2SoftDecim: type: integer + description: "Base-2 exponent of the software decimation factor." lpfBW: description: LMS analog lowpass filter bandwidth (Hz) type: integer @@ -27,6 +36,8 @@ XtrxInputSettings: ncoEnable: description: Enable TSP NCO and mixing (1 for yes, 0 for no) type: integer + minimum: 0 + maximum: 1 ncoFrequency: description: Frequency shift from LO type: integer @@ -48,6 +59,8 @@ XtrxInputSettings: extClock: description: Use external clock source (1 for yes, 0 for no) type: integer + minimum: 0 + maximum: 1 extClockFreq: description: Frequency (Hz) of external clock source type: integer @@ -56,6 +69,8 @@ XtrxInputSettings: type: integer iqOrder: type: integer + minimum: 0 + maximum: 1 description: > IQ samples order * 0 - Q then I (swapped) @@ -63,12 +78,19 @@ XtrxInputSettings: 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." XtrxInputReport: description: XTRX @@ -78,11 +100,14 @@ XtrxInputReport: type: integer fifoSize: type: integer + description: "FIFO capacity in samples." fifoFill: type: integer + description: "Current FIFO fill level." temperature: type: number format: float + description: "Reported device temperature." gpsLock: description: 1 if GPSDO is locked else 0 type: integer @@ -92,15 +117,20 @@ XtrxOutputSettings: 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: description: LMS analog lowpass filter bandwidth (Hz) type: integer @@ -110,6 +140,8 @@ XtrxOutputSettings: ncoEnable: description: Enable TSP NCO and mixing (1 for yes, 0 for no) type: integer + minimum: 0 + maximum: 1 ncoFrequency: description: Frequency shift from LO type: integer @@ -119,6 +151,8 @@ XtrxOutputSettings: extClock: description: Use external clock source (1 for yes, 0 for no) type: integer + minimum: 0 + maximum: 1 extClockFreq: description: Frequency (Hz) of external clock source type: integer @@ -128,12 +162,19 @@ XtrxOutputSettings: 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." XtrxOutputReport: description: XTRX @@ -143,11 +184,14 @@ XtrxOutputReport: type: integer fifoSize: type: integer + description: "FIFO capacity in samples." fifoFill: type: integer + description: "Current FIFO fill level." temperature: type: number format: float + description: "Reported device temperature." gpsLock: description: 1 if GPSDO is locked else 0 type: integer @@ -157,9 +201,12 @@ XtrxMIMOSettings: properties: title: type: string + description: "User-visible title." 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 @@ -172,16 +219,22 @@ XtrxMIMOSettings: useReverseAPI: description: Boolean 1 use 0 do not use reverse API type: integer + minimum: 0 + maximum: 1 reverseAPIAddress: description: IPv4 address type: string reverseAPIPort: description: Network port from 1024 to 65535 type: integer + minimum: 1 + maximum: 65535 reverseAPIDeviceIndex: type: integer + description: "Device-set index used by the reverse API peer." rxDevSampleRate: type: integer + description: "Receive dev sample rate in samples per second." log2HardDecim: description: 0 is automatic then 1 to 6 is log2 of hardware decimation type: integer @@ -191,12 +244,17 @@ XtrxMIMOSettings: rxCenterFrequency: type: integer format: int64 + description: "Receive center frequency in Hz." dcBlock: description: Software DC blocking (1 for yes, 0 for no) type: integer + minimum: 0 + maximum: 1 iqCorrection: description: Software IQ imbalance correction (1 for yes, 0 for no) type: integer + minimum: 0 + maximum: 1 ncoEnableRx: description: Enable TSP NCO Rx on both channels and mixing (1 for yes, 0 for no) type: integer @@ -205,6 +263,8 @@ XtrxMIMOSettings: type: integer antennaPathRx: type: integer + minimum: 0 + maximum: 2 description: > Antenna selected (enum value from XTRXMIMOSettings::RxAntenna): * 0 - RXANT_LO low range @@ -212,6 +272,8 @@ XtrxMIMOSettings: * 2 - RXANT_HI high range iqOrder: type: integer + minimum: 0 + maximum: 1 description: > IQ samples order * 0 - Q then I (swapped) @@ -224,6 +286,8 @@ XtrxMIMOSettings: type: integer gainModeRx0: type: integer + minimum: 0 + maximum: 1 description: > Gain mode (XTRXMIMOSettings::GainMode) for Rx channel 0: * 0 - GAIN_AUTO automatic @@ -239,6 +303,7 @@ XtrxMIMOSettings: type: integer pwrmodeRx0: type: integer + description: "Pwrmode rx0 setting for Xtrx MIMO." lpfBWRx1: description: LMS analog lowpass filter bandwidth (Hz) for Rx channel 1 type: integer @@ -247,6 +312,8 @@ XtrxMIMOSettings: type: integer gainModeRx1: type: integer + minimum: 0 + maximum: 1 description: > Gain mode (XTRXMIMOSettings::GainMode) for Rx channel 1: * 0 - GAIN_AUTO automatic @@ -262,8 +329,10 @@ XtrxMIMOSettings: type: integer pwrmodeRx1: type: integer + description: "Pwrmode rx1 setting for Xtrx MIMO." txDevSampleRate: type: integer + description: "Transmit dev sample rate in samples per second." log2HardInterp: description: 0 is automatic then 1 to 6 is log2 of hardware interpolation type: integer @@ -273,6 +342,7 @@ XtrxMIMOSettings: txCenterFrequency: type: integer format: int64 + description: "Transmit center frequency in Hz." ncoEnableTx: description: Enable TSP NCO Tx on both channels and mixing (1 for yes, 0 for no) type: integer @@ -281,6 +351,8 @@ XtrxMIMOSettings: type: integer antennaPathTx: type: integer + minimum: 0 + maximum: 1 description: > Antenna selected (enum value from XTRXMIMOSettings::TxAntenna): * 0 - TXANT_HI high range @@ -293,6 +365,7 @@ XtrxMIMOSettings: type: integer pwrmodeTx0: type: integer + description: "Pwrmode tx0 setting for Xtrx MIMO." lpfBWTx1: description: LMS analog lowpass filter bandwidth (Hz) for Tx channel 1 type: integer @@ -301,6 +374,7 @@ XtrxMIMOSettings: type: integer pwrmodeTx1: type: integer + description: "Pwrmode tx1 setting for Xtrx MIMO." XtrxMIMOReport: description: XTRX @@ -310,19 +384,26 @@ XtrxMIMOReport: type: integer fifoSize: type: integer + description: "FIFO capacity in samples." fifoFillRx: type: integer + description: "Current receive FIFO fill level." fifoFillTx: type: integer + description: "Current transmit FIFO fill level." temperature: type: number format: float + description: "Reported device temperature." gpsLock: description: 1 if GPSDO is locked else 0 type: integer actualInputRate: type: integer + description: "Reported actual input rate." actualOutputRate: type: integer + description: "Reported actual output rate." clockGenRate: type: integer + description: "Reported clock gen rate."