diff --git a/sdrbase/resources/webapi/doc/html2/index.html b/sdrbase/resources/webapi/doc/html2/index.html
index 8c1533cc7..5fbc3a8d2 100644
--- a/sdrbase/resources/webapi/doc/html2/index.html
+++ b/sdrbase/resources/webapi/doc/html2/index.html
@@ -709,12 +709,16 @@ margin-bottom: 20px;
"latitude" : {
"type" : "number",
"format" : "float",
- "description" : "Latitude of aircraft in degrees"
+ "description" : "Latitude of aircraft in degrees",
+ "minimum" : -90,
+ "maximum" : 90
},
"longitude" : {
"type" : "number",
"format" : "float",
- "description" : "Longitude of aircraft in degrees"
+ "description" : "Longitude of aircraft in degrees",
+ "minimum" : -180,
+ "maximum" : 180
},
"altitude" : {
"type" : "integer",
@@ -734,25 +738,31 @@ margin-bottom: 20px;
"description" : "power received in channel (dB)"
},
"channelSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Effective sample rate delivered to the channel in samples per second."
},
"targetName" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Name of the selected or tracked target."
},
"targetAzimuth" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Target azimuth in degrees clockwise from north."
},
"targetElevation" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Target elevation in degrees above the horizon."
},
"targetRange" : {
"type" : "number",
- "format" : "float"
+ "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" : "#/definitions/ADSBDemodAircraftState"
}
@@ -774,18 +784,24 @@ margin-bottom: 20px;
},
"correlationThreshold" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Minimum correlation score required to accept a frame preamble."
},
"samplesPerBit" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Number of input samples used to represent each bit."
},
"correlateFullPreamble" : {
"type" : "integer",
- "description" : "Correlate on part or full preamble\n * 0 - part\n * 1 - full\n"
+ "description" : "Correlate on part or full preamble\n * 0 - part\n * 1 - full\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"demodModeS" : {
"type" : "integer",
- "description" : "Demodulate all mode S frames or just ADS-B\n * 0 - just ADS-B\n * 1 - All mode S\n"
+ "description" : "Demodulate all mode S frames or just ADS-B\n * 0 - just ADS-B\n * 1 - All mode S\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"interpolatorPhaseSteps" : {
"type" : "integer",
@@ -797,37 +813,58 @@ margin-bottom: 20px;
"description" : "Number of taps per phase in channel interpolator"
},
"removeTimeout" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Time after which an inactive tracked item is removed."
},
"feedEnabled" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable forwarding of received data to the configured feed (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"exportClientEnabled" : {
"type" : "integer",
- "description" : "Send data to server\n * 0 - Do not send data\n * 1 - Send data\n"
+ "description" : "Send data to server\n * 0 - Do not send data\n * 1 - Send data\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"exportClientHost" : {
"type" : "string",
"description" : "Host to send data to"
},
"exportClientPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Export client port.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"exportClientFormat" : {
"type" : "integer",
- "description" : "Format of sent data\n * 0 - Beast binary\n * 1 - Beast hex\n"
+ "description" : "Format of sent data\n * 0 - Beast binary\n * 1 - Beast hex\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"exportServerEnabled" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable the data-export server (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"exportServerPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Export server port.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"importEnabled" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable importing data from the configured service (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"importHost" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Import host setting for ADS-B demod."
},
"importUsername" : {
"type" : "string",
@@ -838,35 +875,47 @@ margin-bottom: 20px;
"description" : "OpenSky OAuth2 client secret."
},
"importParameters" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Import parameters setting for ADS-B demod."
},
"importPeriod" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Import period setting for ADS-B demod."
},
"importMinLatitude" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Import min latitude setting for ADS-B demod."
},
"importMaxLatitude" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Import max latitude setting for ADS-B demod."
},
"importMinLongitude" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Import min longitude setting for ADS-B demod."
},
"importMaxLongitude" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Import max longitude setting for ADS-B demod."
},
"logFilename" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Log file name or path."
},
"logEnabled" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable logging to the configured file (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"streamIndex" : {
"type" : "integer",
@@ -874,24 +923,34 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -901,15 +960,21 @@ margin-bottom: 20px;
"properties" : {
"run" : {
"type" : "integer",
- "description" : "Set the plugin running state\n * 0 - idle\n * 1 - run\n"
+ "description" : "Set the plugin running state\n * 0 - idle\n * 1 - run\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"deviceTrack" : {
"type" : "integer",
- "description" : "(Re)initialize tracker target frequency adjustment\n * 0 - release\n * 1 - engage\n"
+ "description" : "(Re)initialize tracker target frequency adjustment\n * 0 - release\n * 1 - engage\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"devicesApply" : {
"type" : "integer",
- "description" : "(Re)initialize device sets tracking\n * 0 - release\n * 1 - engage\n"
+ "description" : "(Re)initialize device sets tracking\n * 0 - release\n * 1 - engage\n",
+ "minimum" : 0,
+ "maximum" : 1
}
},
"description" : "AFC actions"
@@ -918,7 +983,9 @@ margin-bottom: 20px;
"properties" : {
"runningState" : {
"type" : "integer",
- "description" : "Running state\n * 0 - not started\n * 1 - idle\n * 2 - running\n * 3 - error\n"
+ "description" : "Running state\n * 0 - not started\n * 1 - idle\n * 2 - running\n * 3 - error\n",
+ "minimum" : 0,
+ "maximum" : 3
},
"trackerChannelIndex" : {
"type" : "integer",
@@ -939,10 +1006,12 @@ margin-bottom: 20px;
defs.AFCSettings = {
"properties" : {
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"trackerDeviceSetIndex" : {
"type" : "integer",
@@ -954,11 +1023,15 @@ margin-bottom: 20px;
},
"hasTargetFrequency" : {
"type" : "integer",
- "description" : "Adjust device frequency to match tracker frequency\n * 0 - disabled\n * 1 - enabled\n"
+ "description" : "Adjust device frequency to match tracker frequency\n * 0 - disabled\n * 1 - enabled\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"transverterTarget" : {
"type" : "integer",
- "description" : "Use transverter or device frequency for tracker frequency adjustment\n * 0 - device\n * 1 - transverter\n"
+ "description" : "Use transverter or device frequency for tracker frequency adjustment\n * 0 - device\n * 1 - transverter\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"targetFrequency" : {
"type" : "integer",
@@ -975,21 +1048,30 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIFeatureSetIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Feature-set index used by the reverse API peer."
},
"reverseAPIFeatureIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Feature index used by the reverse API peer."
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -1003,7 +1085,8 @@ margin-bottom: 20px;
"description" : "power received in channel (dB)"
},
"channelSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Effective sample rate delivered to the channel in samples per second."
}
},
"description" : "AISDemod"
@@ -1016,15 +1099,18 @@ margin-bottom: 20px;
},
"inputFrequencyOffset" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Channel frequency offset from the device center frequency in Hz."
},
"rfBandwidth" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "RF bandwidth in Hz."
},
"fmDeviation" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "FM frequency deviation in Hz."
},
"correlationThreshold" : {
"type" : "number",
@@ -1033,7 +1119,9 @@ margin-bottom: 20px;
},
"udpEnabled" : {
"type" : "integer",
- "description" : "Whether to forward received messages to specified UDP port"
+ "description" : "Whether to forward received messages to specified UDP port",
+ "minimum" : 0,
+ "maximum" : 1
},
"udpAddress" : {
"type" : "string",
@@ -1041,26 +1129,37 @@ margin-bottom: 20px;
},
"udpPort" : {
"type" : "integer",
- "description" : "UDP port to forward received messages to"
+ "description" : "UDP port to forward received messages to",
+ "minimum" : 1,
+ "maximum" : 65535
},
"udpFormat" : {
"type" : "integer",
"description" : "0 for binary, 1 for NMEA"
},
"logFilename" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Log file name or path."
},
"logEnabled" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable logging to the configured file (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"useFileTime" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable file time (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"streamIndex" : {
"type" : "integer",
@@ -1068,27 +1167,38 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"scopeConfig" : {
+ "description" : "Oscilloscope-display configuration.",
"$ref" : "#/definitions/GLScope"
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -1098,14 +1208,19 @@ margin-bottom: 20px;
"properties" : {
"tx" : {
"type" : "integer",
- "description" : "Transmit stored message\n * 0 - do nothing\n * 1 - transmit\n"
+ "description" : "Transmit stored message\n * 0 - do nothing\n * 1 - transmit\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"encode" : {
"type" : "integer",
- "description" : "Encode message from discrete data\n * 0 - do nothing\n * 1 - encode\n"
+ "description" : "Encode message from discrete data\n * 0 - do nothing\n * 1 - encode\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"data" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Payload data."
}
},
"description" : "AISMod"
@@ -1118,7 +1233,8 @@ margin-bottom: 20px;
"description" : "power transmitted in channel (dB)"
},
"channelSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Effective sample rate delivered to the channel in samples per second."
}
},
"description" : "AISMod"
@@ -1131,7 +1247,8 @@ margin-bottom: 20px;
"description" : "channel center frequency shift from baseband center in Hz"
},
"baud" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Symbol or serial rate in baud."
},
"rfBandwidth" : {
"type" : "number",
@@ -1144,83 +1261,118 @@ margin-bottom: 20px;
},
"gain" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Gain setting; units and available values depend on the device or plugin."
},
"channelMute" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Mute the channel output (1 muted, 0 unmuted).",
+ "minimum" : 0,
+ "maximum" : 1
},
"repeat" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Repeat transmission or playback (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"repeatDelay" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Delay between repetitions."
},
"repeatCount" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Number of repetitions."
},
"rampUpBits" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Ramp up bits setting for AIS mod."
},
"rampDownBits" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Ramp down bits setting for AIS mod."
},
"rampRange" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Ramp range setting for AIS mod."
},
"rfNoise" : {
"type" : "integer",
- "description" : "Boolean\n * 0 - off\n * 1 - on\n"
+ "description" : "Boolean\n * 0 - off\n * 1 - on\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"writeToFile" : {
"type" : "integer",
- "description" : "Boolean\n * 0 - off\n * 1 - on\n"
+ "description" : "Boolean\n * 0 - off\n * 1 - on\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"msgType" : {
"type" : "integer",
- "description" : "Message Type\n * 0 - Scheduled position report\n * 1 - Assigned position report\n * 2 - Special position report\n * 3 - Base station report\n"
+ "description" : "Message Type\n * 0 - Scheduled position report\n * 1 - Assigned position report\n * 2 - Special position report\n * 3 - Base station report\n",
+ "minimum" : 0,
+ "maximum" : 3
},
"mmsi" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Maritime Mobile Service Identity number."
},
"status" : {
"type" : "integer",
- "description" : "Ship status\n * 0 - Under way using engine\n * 1 - At anchor\n * 2 - Not under command\n * 3 - Restricted manoeuvrability\n * 4 - Constrained by her draught\n * 4 - Moored\n * 5 - Aground\n * 6 - Engaged in fishing\n * 7 - Under way sailing\n * 8 - Not defined\n"
+ "description" : "Ship status\n * 0 - Under way using engine\n * 1 - At anchor\n * 2 - Not under command\n * 3 - Restricted manoeuvrability\n * 4 - Constrained by her draught\n * 4 - Moored\n * 5 - Aground\n * 6 - Engaged in fishing\n * 7 - Under way sailing\n * 8 - Not defined\n",
+ "minimum" : 0,
+ "maximum" : 8
},
"latitude" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Latitude in degrees, positive north.",
+ "minimum" : -90,
+ "maximum" : 90
},
"longitude" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Longitude in degrees, positive east.",
+ "minimum" : -180,
+ "maximum" : 180
},
"course" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Course over ground in degrees."
},
"speed" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Reported speed."
},
"heading" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Heading in degrees."
},
"data" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Payload data."
},
"bt" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Bt setting for AIS mod."
},
"symbolSpan" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Symbol span setting for AIS mod."
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"streamIndex" : {
"type" : "integer",
@@ -1228,23 +1380,33 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"udpEnabled" : {
"type" : "integer",
- "description" : "Whether to receive messages to transmit on specified UDP port"
+ "description" : "Whether to receive messages to transmit on specified UDP port",
+ "minimum" : 0,
+ "maximum" : 1
},
"udpAddress" : {
"type" : "string",
@@ -1252,12 +1414,16 @@ margin-bottom: 20px;
},
"udpPort" : {
"type" : "integer",
- "description" : "UDP port to receive messages to transmit via"
+ "description" : "UDP port to receive messages to transmit via",
+ "minimum" : 1,
+ "maximum" : 65535
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -1266,38 +1432,51 @@ margin-bottom: 20px;
defs.AISSettings = {
"properties" : {
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIFeatureSetIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Feature-set index used by the reverse API peer."
},
"reverseAPIFeatureIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Feature index used by the reverse API peer."
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
},
"vesselColumnIndexes" : {
"type" : "array",
+ "description" : "List of vessel column indexes.",
"items" : {
"type" : "integer"
}
},
"vesselColumnSizes" : {
"type" : "array",
+ "description" : "List of vessel column sizes.",
"items" : {
"type" : "integer"
}
@@ -1384,28 +1563,39 @@ margin-bottom: 20px;
defs.AMBESettings = {
"properties" : {
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIFeatureSetIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Feature-set index used by the reverse API peer."
},
"reverseAPIFeatureIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Feature index used by the reverse API peer."
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -1423,10 +1613,12 @@ margin-bottom: 20px;
"description" : "squelch status (1 if open else 0)"
},
"audioSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Audio sample rate in samples per second."
},
"channelSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Effective sample rate delivered to the channel in samples per second."
}
},
"description" : "AMDemod"
@@ -1455,23 +1647,30 @@ margin-bottom: 20px;
},
"volume" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Audio volume multiplier."
},
"audioMute" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Mute audio output (1 muted, 0 unmuted).",
+ "minimum" : 0,
+ "maximum" : 1
},
"bandpassEnable" : {
"type" : "integer",
"description" : "use bandpass filter (1 for yes, 0 for no)"
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"audioDeviceName" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Name of the audio device to use."
},
"pll" : {
"type" : "integer",
@@ -1500,24 +1699,34 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -1531,10 +1740,12 @@ margin-bottom: 20px;
"description" : "power transmitted in channel (dB)"
},
"audioSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Audio sample rate in samples per second."
},
"channelSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Effective sample rate delivered to the channel in samples per second."
}
},
"description" : "AMMod"
@@ -1543,11 +1754,13 @@ margin-bottom: 20px;
"properties" : {
"inputFrequencyOffset" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Channel frequency offset from the device center frequency in Hz."
},
"rfBandwidth" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "RF bandwidth in Hz."
},
"modFactor" : {
"type" : "number",
@@ -1556,29 +1769,41 @@ margin-bottom: 20px;
},
"toneFrequency" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Tone frequency in Hz."
},
"volumeFactor" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Volume factor setting for Am mod."
},
"channelMute" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Mute the channel output (1 muted, 0 unmuted).",
+ "minimum" : 0,
+ "maximum" : 1
},
"playLoop" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Loop playback at end of file (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"audioDeviceName" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Name of the audio device to use."
},
"modAFInput" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Audio-frequency modulation input selection."
},
"streamIndex" : {
"type" : "integer",
@@ -1586,27 +1811,38 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"cwKeyer" : {
+ "description" : "CW keyer configuration.",
"$ref" : "#/definitions/CWKeyerSettings"
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -1615,116 +1851,149 @@ margin-bottom: 20px;
defs.APRSSettings = {
"properties" : {
"igateServer" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Igate server setting for Aprs."
},
"igatePort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Igate port.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"igateCallsign" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Igate callsign setting for Aprs."
},
"igatePasscode" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Igate passcode setting for Aprs."
},
"igateFilter" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Igate filter setting for Aprs."
},
"igateEnabled" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable igate (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIFeatureSetIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Feature-set index used by the reverse API peer."
},
"reverseAPIFeatureIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Feature index used by the reverse API peer."
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
},
"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"
}
@@ -1819,7 +2088,9 @@ margin-bottom: 20px;
},
"decodeEnabled" : {
"type" : "integer",
- "description" : "Controls whether the decoder is enabled"
+ "description" : "Controls whether the decoder is enabled",
+ "minimum" : 0,
+ "maximum" : 1
},
"autoSave" : {
"type" : "integer",
@@ -1884,10 +2155,12 @@ margin-bottom: 20px;
"description" : "Yaw angle offset in degrees, for aligning image on map"
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"streamIndex" : {
"type" : "integer",
@@ -1895,24 +2168,34 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -1921,23 +2204,28 @@ margin-bottom: 20px;
defs.ATVDemodSettings = {
"properties" : {
"fpsIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Selected fps index."
},
"halfImage" : {
"type" : "integer",
"description" : "(boolean) 1 for m_fltRatioOfRowsToDisplay = 0.5, 0 for m_fltRatioOfRowsToDisplay = 1.0"
},
"RFBandwidthFactor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "RF bandwidth factor setting for Atv demod."
},
"OppBandwidthFactor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Opp bandwidth factor setting for Atv demod."
},
"nbLinesIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Selected nb lines index."
},
"intFrequencyOffset" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Int frequency offset in Hz."
},
"enmModulation" : {
"type" : "integer",
@@ -1945,23 +2233,29 @@ margin-bottom: 20px;
},
"fltRFBandwidth" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Flt RF bandwidth in Hz."
},
"fltRFOppBandwidth" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Flt RF opp bandwidth in Hz."
},
"blnFFTFiltering" : {
"type" : "integer",
- "description" : "boolean"
+ "description" : "boolean",
+ "minimum" : 0,
+ "maximum" : 1
},
"fltBFOFrequency" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Flt bfo frequency in Hz."
},
"fmDeviation" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "FM frequency deviation in Hz."
},
"amScalingFactor" : {
"type" : "integer",
@@ -1972,71 +2266,94 @@ margin-bottom: 20px;
"description" : "Factor in % to apply to adjusted signal scale"
},
"intSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Int sample rate in samples per second."
},
"enmATVStandard" : {
"type" : "integer",
"description" : "see ATVDemodSettings::ATVStd"
},
"intNumberOfLines" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Int number of lines setting for Atv demod."
},
"fltLineDuration" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Flt line duration setting for Atv demod."
},
"fltTopDuration" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Flt top duration setting for Atv demod."
},
"fltFramePerS" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Flt frame per s setting for Atv demod."
},
"fltRatioOfRowsToDisplay" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Flt ratio of rows to display setting for Atv demod."
},
"fltVoltLevelSynchroTop" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Flt volt level synchro top setting for Atv demod."
},
"fltVoltLevelSynchroBlack" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Flt volt level synchro black setting for Atv demod."
},
"blnHSync" : {
"type" : "integer",
- "description" : "boolean"
+ "description" : "boolean",
+ "minimum" : 0,
+ "maximum" : 1
},
"blnVSync" : {
"type" : "integer",
- "description" : "boolean"
+ "description" : "boolean",
+ "minimum" : 0,
+ "maximum" : 1
},
"blnInvertVideo" : {
"type" : "integer",
- "description" : "boolean"
+ "description" : "boolean",
+ "minimum" : 0,
+ "maximum" : 1
},
"intVideoTabIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Selected int video tab index."
},
"intTVSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Int tv sample rate in samples per second."
},
"intNumberSamplePerLine" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Int number sample per line setting for Atv demod."
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"udpAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name used for UDP traffic."
},
"udpPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "UDP port number.",
+ "minimum" : 1,
+ "maximum" : 65535
}
},
"description" : "ATVDemod"
@@ -2049,7 +2366,8 @@ margin-bottom: 20px;
"description" : "power transmitted in channel (dB)"
},
"channelSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Effective sample rate delivered to the channel in samples per second."
}
},
"description" : "ATVMod"
@@ -2058,78 +2376,103 @@ margin-bottom: 20px;
"properties" : {
"inputFrequencyOffset" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Channel frequency offset from the device center frequency in Hz."
},
"rfBandwidth" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "RF bandwidth in Hz."
},
"rfOppBandwidth" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "RF opp bandwidth in Hz."
},
"atvStd" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Atv std setting for Atv mod."
},
"nbLines" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Nb lines setting for Atv mod."
},
"fps" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Fps setting for Atv mod."
},
"atvModInput" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Atv mod input setting for Atv mod."
},
"uniformLevel" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Uniform level setting for Atv mod."
},
"atvModulation" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Atv modulation setting for Atv mod."
},
"videoPlayLoop" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Video play loop setting for Atv mod."
},
"videoPlay" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Video play setting for Atv mod."
},
"cameraPlay" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Camera play setting for Atv mod."
},
"channelMute" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Mute the channel output (1 muted, 0 unmuted).",
+ "minimum" : 0,
+ "maximum" : 1
},
"invertedVideo" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Inverted video setting for Atv mod."
},
"rfScalingFactor" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "RF scaling factor setting for Atv mod."
},
"fmExcursion" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "FM excursion setting for Atv mod."
},
"forceDecimator" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Force decimator setting for Atv mod."
},
"showOverlayText" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Show overlay text setting for Atv mod."
},
"overlayText" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Overlay text setting for Atv mod."
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"imageFileName" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Image file name or path."
},
"videoFileName" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Video file name."
},
"streamIndex" : {
"type" : "integer",
@@ -2137,24 +2480,34 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -2164,7 +2517,9 @@ margin-bottom: 20px;
"properties" : {
"status" : {
"type" : "integer",
- "description" : "Connection to RTSA server status:\n * 0 - Idle\n * 1 - Unstable\n * 2 - Connected\n * 3 - Error\n * 4 - Disconnected\n"
+ "description" : "Connection to RTSA server status:\n * 0 - Idle\n * 1 - Unstable\n * 2 - Connected\n * 3 - Error\n * 4 - Disconnected\n",
+ "minimum" : 0,
+ "maximum" : 4
}
},
"description" : "AaroniaRTSAOutput"
@@ -2172,7 +2527,8 @@ margin-bottom: 20px;
defs.AaroniaRTSAOutputSettings = {
"properties" : {
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"centerFrequency" : {
"type" : "integer",
@@ -2189,16 +2545,23 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
}
},
"description" : "AaroniaRTSAOutput"
@@ -2207,7 +2570,9 @@ margin-bottom: 20px;
"properties" : {
"status" : {
"type" : "integer",
- "description" : "Connection to RTSA server status:\n * 0 - Idle\n * 1 - Unstable\n * 2 - Connected\n * 3 - Error\n * 4 - Disconnected\n"
+ "description" : "Connection to RTSA server status:\n * 0 - Idle\n * 1 - Unstable\n * 2 - Connected\n * 3 - Error\n * 4 - Disconnected\n",
+ "minimum" : 0,
+ "maximum" : 4
}
},
"description" : "AaroniaRTSA"
@@ -2215,7 +2580,8 @@ margin-bottom: 20px;
defs.AaroniaRTSASettings = {
"properties" : {
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"centerFrequency" : {
"type" : "integer",
@@ -2232,16 +2598,23 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
}
},
"description" : "AaroniaRTSA"
@@ -2250,6 +2623,7 @@ margin-bottom: 20px;
"properties" : {
"sampleRates" : {
"type" : "array",
+ "description" : "Supported sample rates in samples per second.",
"items" : {
"$ref" : "#/definitions/SampleRate"
}
@@ -2260,51 +2634,72 @@ margin-bottom: 20px;
defs.AirspyHFSettings = {
"properties" : {
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"centerFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Device center frequency in Hz."
},
"LOppmTenths" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Local-oscillator correction in tenths of a part per million."
},
"devSampleRateIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Selected dev sample rate index."
},
"log2Decim" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent of the software decimation factor; the output sample rate is divided by 2^log2Decim."
},
"transverterMode" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable transverter frequency translation (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"transverterDeltaFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Frequency translation applied in transverter mode in Hz."
},
"iqOrder" : {
"type" : "integer",
- "description" : "IQ samples order\n * 0 - Q then I (swapped)\n * 1 - I then Q (straight)\n"
+ "description" : "IQ samples order\n * 0 - Q then I (swapped)\n * 1 - I then Q (straight)\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"bandIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Selected band index."
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"useAGC" : {
"type" : "integer",
- "description" : "AGC (1 for on, 0 for off)"
+ "description" : "AGC (1 for on, 0 for off)",
+ "minimum" : 0,
+ "maximum" : 1
},
"agcHigh" : {
"type" : "integer",
@@ -2312,21 +2707,31 @@ margin-bottom: 20px;
},
"useDSP" : {
"type" : "integer",
- "description" : "LibairspyHF DSP (1 for on, 0 for off)"
+ "description" : "LibairspyHF DSP (1 for on, 0 for off)",
+ "minimum" : 0,
+ "maximum" : 1
},
"useLNA" : {
"type" : "integer",
- "description" : "LNA (1 for on, 0 for off)"
+ "description" : "LNA (1 for on, 0 for off)",
+ "minimum" : 0,
+ "maximum" : 1
},
"attenuatorSteps" : {
"type" : "integer",
"description" : "Attenuator in number of 6 dB steps"
},
"dcBlock" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable DSP DC-offset correction (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"iqCorrection" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable I/Q imbalance correction (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
}
},
"description" : "AirspyHF"
@@ -2335,6 +2740,7 @@ margin-bottom: 20px;
"properties" : {
"sampleRates" : {
"type" : "array",
+ "description" : "Supported sample rates in samples per second.",
"items" : {
"$ref" : "#/definitions/SampleRate"
}
@@ -2345,26 +2751,33 @@ margin-bottom: 20px;
defs.AirspySettings = {
"properties" : {
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"centerFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Device center frequency in Hz."
},
"LOppmTenths" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Local-oscillator correction in tenths of a part per million."
},
"devSampleRateIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Selected dev sample rate index."
},
"lnaGain" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Low-noise-amplifier gain setting."
},
"mixerGain" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Mixer gain setting for Airspy."
},
"vgaGain" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Variable-gain-amplifier gain setting."
},
"lnaAGC" : {
"type" : "integer",
@@ -2375,7 +2788,8 @@ margin-bottom: 20px;
"description" : "Mixer AGC (1 if active else 0)"
},
"log2Decim" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent of the software decimation factor; the output sample rate is divided by 2^log2Decim."
},
"fcPos" : {
"type" : "integer",
@@ -2383,37 +2797,58 @@ margin-bottom: 20px;
},
"biasT" : {
"type" : "integer",
- "description" : "Bias tee (1 if active else 0)"
+ "description" : "Bias tee (1 if active else 0)",
+ "minimum" : 0,
+ "maximum" : 1
},
"dcBlock" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable DSP DC-offset correction (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"iqCorrection" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable I/Q imbalance correction (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"transverterMode" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable transverter frequency translation (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"transverterDeltaFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Frequency translation applied in transverter mode in Hz."
},
"iqOrder" : {
"type" : "integer",
- "description" : "IQ samples order\n * 0 - Q then I (swapped)\n * 1 - I then Q (straight)\n"
+ "description" : "IQ samples order\n * 0 - Q then I (swapped)\n * 1 - I then Q (straight)\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
}
},
"description" : "Airspy"
@@ -2421,7 +2856,8 @@ margin-bottom: 20px;
defs.AndroidSDRDriverInputReport = {
"properties" : {
"sampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Sample rate in samples per second."
}
},
"description" : "AndroidSDRDriverInput"
@@ -2430,56 +2866,86 @@ margin-bottom: 20px;
"properties" : {
"centerFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Device center frequency in Hz."
},
"loPpmCorrection" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Local-oscillator correction in parts per million."
},
"dcBlock" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable DSP DC-offset correction (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"iqCorrection" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable I/Q imbalance correction (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"biasTee" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable the antenna bias tee (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"directSampling" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Direct sampling setting for Android sdr driver input."
},
"devSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device I/Q sample rate in samples per second before software decimation or interpolation."
},
"log2Decim" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent of the software decimation factor; the output sample rate is divided by 2^log2Decim."
},
"gain" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Gain setting; units and available values depend on the device or plugin."
},
"agc" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable automatic gain control (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"rfBW" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "RF bw in Hz."
},
"sampleBits" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Number of significant bits in each sample."
},
"dataPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Network port used for data traffic.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
}
},
"description" : "AndroidSDRDriverInput"
@@ -2488,50 +2954,67 @@ margin-bottom: 20px;
"properties" : {
"dipoleFrequencyMHz" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Dipole frequency in MHz."
},
"dipoleEndEffectFactor" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Dipole end effect factor setting for Antenna tools."
},
"dishFrequencyMHz" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Dish frequency in MHz."
},
"dishDiameter" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Dish diameter setting for Antenna tools."
},
"dishDepth" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Dish depth setting for Antenna tools."
},
"dishEfficiency" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Dish efficiency setting for Antenna tools."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIFeatureSetIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Feature-set index used by the reverse API peer."
},
"reverseAPIFeatureIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Feature index used by the reverse API peer."
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -2540,35 +3023,44 @@ margin-bottom: 20px;
defs.ArgInfo = {
"properties" : {
"key" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Key for Definitions."
},
"valueType" : {
"type" : "string",
+ "description" : "Value type for Definitions.",
"enum" : [ "bool", "int", "float", "string" ]
},
"valueString" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Value string for Definitions."
},
"name" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Name."
},
"description" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Human-readable description."
},
"units" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Units for Definitions."
},
"range" : {
+ "description" : "Range configuration for Definitions.",
"$ref" : "#/definitions/RangeFloat"
},
"valueOptions" : {
"type" : "array",
+ "description" : "List of value options.",
"items" : {
"type" : "string"
}
},
"optionNames" : {
"type" : "array",
+ "description" : "List of option names.",
"items" : {
"type" : "string"
}
@@ -2579,14 +3071,17 @@ margin-bottom: 20px;
defs.ArgValue = {
"properties" : {
"key" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Key for Definitions."
},
"valueType" : {
"type" : "string",
+ "description" : "Value type for Definitions.",
"enum" : [ "bool", "int", "float", "string" ]
},
"valueString" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Value string for Definitions."
}
},
"description" : "Generic argument value"
@@ -2594,40 +3089,55 @@ margin-bottom: 20px;
defs.AudioCATSISOSettings = {
"properties" : {
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"rxCenterFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Receive center frequency in Hz."
},
"rxSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Receive sample rate in samples per second."
},
"txCenterFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Transmit center frequency in Hz."
},
"txSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Transmit sample rate in samples per second."
},
"transverterMode" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable transverter frequency translation (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"transverterDeltaFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Frequency translation applied in transverter mode in Hz."
},
"iqOrder" : {
"type" : "integer",
- "description" : "IQ samples order\n * 0 - Q then I (swapped)\n * 1 - I then Q (straight)\n"
+ "description" : "IQ samples order\n * 0 - Q then I (swapped)\n * 1 - I then Q (straight)\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"txEnable" : {
"type" : "integer",
- "description" : "Enable or disable transmission\n * 0 - Disable transmission\n * 1 - Enable transmission\n"
+ "description" : "Enable or disable transmission\n * 0 - Disable transmission\n * 1 - Enable transmission\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"pttSpectrumLink" : {
"type" : "integer",
- "description" : "Main spectrum display (Rx/Tx) follows PTT (GUI)\n * 0 - Disable PTT following\n * 1 - Enable PTT following\n"
+ "description" : "Main spectrum display (Rx/Tx) follows PTT (GUI)\n * 0 - Disable PTT following\n * 1 - Enable PTT following\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"rxDeviceName" : {
"type" : "string",
@@ -2635,7 +3145,9 @@ margin-bottom: 20px;
},
"rxIQMapping" : {
"type" : "integer",
- "description" : "Audio channel to IQ mapping\n * 0 - I=L, Q=R\n * 1 - I=R, Q=L\n * 2 - I=L, Q=0\n * 3 - I=R, Q=0\n"
+ "description" : "Audio channel to IQ mapping\n * 0 - I=L, Q=R\n * 1 - I=R, Q=L\n * 2 - I=L, Q=0\n * 3 - I=R, Q=0\n",
+ "minimum" : 0,
+ "maximum" : 3
},
"log2Decim" : {
"type" : "integer",
@@ -2643,19 +3155,26 @@ margin-bottom: 20px;
},
"fcPosRx" : {
"type" : "integer",
- "description" : "Decimated bandpass center frequency position\n * 0 - Infradyne\n * 1 - Supradyne\n * 2 - Centered\n"
+ "description" : "Decimated bandpass center frequency position\n * 0 - Infradyne\n * 1 - Supradyne\n * 2 - Centered\n",
+ "minimum" : 0,
+ "maximum" : 2
},
"dcBlock" : {
"type" : "integer",
- "description" : "Auto DC blocking\n * 0 - Off\n * 1 - On\n"
+ "description" : "Auto DC blocking\n * 0 - Off\n * 1 - On\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"iqCorrection" : {
"type" : "integer",
- "description" : "Auto IQ balance (you need auto DC blocking active)\n * 0 - Off\n * 1 - On\n"
+ "description" : "Auto IQ balance (you need auto DC blocking active)\n * 0 - Off\n * 1 - On\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"rxVolume" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Receive volume setting for Audio catsiso."
},
"txDeviceName" : {
"type" : "string",
@@ -2663,7 +3182,9 @@ margin-bottom: 20px;
},
"txIQMapping" : {
"type" : "integer",
- "description" : "Audio channel to IQ mapping\n * 0 - I=L, Q=R\n * 1 - I=R, Q=L\n"
+ "description" : "Audio channel to IQ mapping\n * 0 - I=L, Q=R\n * 1 - I=R, Q=L\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"txVolume" : {
"type" : "integer",
@@ -2671,31 +3192,45 @@ margin-bottom: 20px;
},
"catSpeedIndex" : {
"type" : "integer",
- "description" : "CAT serial link baud rate\n * 0 - 1200\n * 1 - 2400\n * 2 - 4800\n * 3 - 9800\n * 4 - 19200 (default)\n * 5 - 38400\n * 6 - 57600\n * 7 - 115200\n"
+ "description" : "CAT serial link baud rate\n * 0 - 1200\n * 1 - 2400\n * 2 - 4800\n * 3 - 9800\n * 4 - 19200 (default)\n * 5 - 38400\n * 6 - 57600\n * 7 - 115200\n",
+ "minimum" : 0,
+ "maximum" : 7
},
"catDataBitsIndex" : {
"type" : "integer",
- "description" : "CAT serial link data bits\n * 0 - 7\n * 1 - 8 (default)\n"
+ "description" : "CAT serial link data bits\n * 0 - 7\n * 1 - 8 (default)\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"catStopBitsIndex" : {
"type" : "integer",
- "description" : "CAT serial link stop bits\n * 0 - 1 (default)\n * 1 - 2\n"
+ "description" : "CAT serial link stop bits\n * 0 - 1 (default)\n * 1 - 2\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"catHandshakeIndex" : {
"type" : "integer",
- "description" : "CAT serial link handshake type\n * 0 - none (default)\n * 1 - XON/XOFF\n * 2 - hardware\n"
+ "description" : "CAT serial link handshake type\n * 0 - none (default)\n * 1 - XON/XOFF\n * 2 - hardware\n",
+ "minimum" : 0,
+ "maximum" : 2
},
"catPTTMethodIndex" : {
"type" : "integer",
- "description" : "CAT PTT method\n * 0 - PTT (default)\n * 1 - DTR\n * 2 - RTS\n"
+ "description" : "CAT PTT method\n * 0 - PTT (default)\n * 1 - DTR\n * 2 - RTS\n",
+ "minimum" : 0,
+ "maximum" : 2
},
"catDTRHigh" : {
"type" : "integer",
- "description" : "CAT DTR control\n * 0 - low\n * 1 - high (default)\n"
+ "description" : "CAT DTR control\n * 0 - low\n * 1 - high (default)\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"catRTSHigh" : {
"type" : "integer",
- "description" : "CAT RTS control\n * 0 - low\n * 1 - high (default)\n"
+ "description" : "CAT RTS control\n * 0 - low\n * 1 - high (default)\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"catPollingMs" : {
"type" : "integer",
@@ -2703,16 +3238,23 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
}
},
"description" : "AudioCATSISO"
@@ -2778,7 +3320,8 @@ margin-bottom: 20px;
defs.AudioInputSettings = {
"properties" : {
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"device" : {
"type" : "string",
@@ -2790,7 +3333,8 @@ margin-bottom: 20px;
},
"volume" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Audio volume multiplier."
},
"log2Decim" : {
"type" : "integer",
@@ -2798,32 +3342,47 @@ margin-bottom: 20px;
},
"iqMapping" : {
"type" : "integer",
- "description" : "Audio channel to IQ mapping\n * 0 - I=L, Q=0\n * 1 - I=R, Q=0\n * 2 - I=L, Q=R\n * 3 - I=R, Q=L\n"
+ "description" : "Audio channel to IQ mapping\n * 0 - I=L, Q=0\n * 1 - I=R, Q=0\n * 2 - I=L, Q=R\n * 3 - I=R, Q=L\n",
+ "minimum" : 0,
+ "maximum" : 3
},
"dcBlock" : {
"type" : "integer",
- "description" : "Auto DC blocking\n * 0 - Off\n * 1 - On\n"
+ "description" : "Auto DC blocking\n * 0 - Off\n * 1 - On\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"iqImbalance" : {
"type" : "integer",
- "description" : "Auto IQ balance (you need auto DC blocking active)\n * 0 - Off\n * 1 - On\n"
+ "description" : "Auto IQ balance (you need auto DC blocking active)\n * 0 - Off\n * 1 - On\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"fcPos" : {
"type" : "integer",
- "description" : "Decimated bandpass center frequency position\n * 0 - Infradyne\n * 1 - Supradyne\n * 2 - Centered\n"
+ "description" : "Decimated bandpass center frequency position\n * 0 - Infradyne\n * 1 - Supradyne\n * 2 - Centered\n",
+ "minimum" : 0,
+ "maximum" : 2
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
}
},
"description" : "AudioInput"
@@ -2896,7 +3455,8 @@ margin-bottom: 20px;
defs.AudioOutputSettings = {
"properties" : {
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"deviceName" : {
"type" : "string",
@@ -2904,24 +3464,34 @@ margin-bottom: 20px;
},
"volume" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Audio volume multiplier."
},
"iqMapping" : {
"type" : "integer",
- "description" : "Audio channel to IQ mapping\n * 0 - I=L, Q=R\n * 1 - I=R, Q=L\n"
+ "description" : "Audio channel to IQ mapping\n * 0 - I=L, Q=R\n * 1 - I=R, Q=L\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
}
},
"description" : "AudioOutput"
@@ -2938,10 +3508,12 @@ margin-bottom: 20px;
"description" : "squelch status (1 if open else 0)"
},
"audioSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Audio sample rate in samples per second."
},
"channelSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Effective complex baseband sample rate delivered to this channel in samples per second. This must be greater than rfBandwidth.\n"
},
"pilotLocked" : {
"type" : "integer",
@@ -2953,6 +3525,7 @@ margin-bottom: 20px;
"description" : "power of stereo pilot (dB)"
},
"rdsReport" : {
+ "description" : "RDS decoder status and decoded programme information.",
"$ref" : "#/definitions/RDSReport"
}
},
@@ -2962,51 +3535,81 @@ margin-bottom: 20px;
"properties" : {
"inputFrequencyOffset" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Channel frequency offset from the device center frequency in Hz."
},
"rfBandwidth" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "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.\n",
+ "minimum" : 80000,
+ "maximum" : 250000
},
"afBandwidth" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Demodulated audio bandwidth in Hz. Broadcast FM normally uses 15 kHz.\n",
+ "minimum" : 1000,
+ "maximum" : 20000,
+ "default" : 15000.0
},
"deEmphasis" : {
"type" : "integer",
- "description" : "De-emphasis time constant (us)\n * 0 - 50us (Europe, Australia)\n * 1 - 75us (US, Japan)\n"
+ "description" : "De-emphasis time constant (us)\n * 0 - 50us (Europe, Australia)\n * 1 - 75us (US, Japan)\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"volume" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Audio volume multiplier."
},
"squelch" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Squelch threshold in dB."
},
"audioMute" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Mute audio output (1 muted, 0 unmuted).",
+ "minimum" : 0,
+ "maximum" : 1
},
"audioStereo" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable stereo audio decoding (1 stereo, 0 mono).",
+ "minimum" : 0,
+ "maximum" : 1
},
"lsbStereo" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Use lower-sideband stereo decoding (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"showPilot" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Show the stereo pilot spectrum (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"rdsActive" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable RDS decoding (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"audioDeviceName" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Name of the audio device to use."
},
"streamIndex" : {
"type" : "integer",
@@ -3014,27 +3617,38 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"spectrumConfig" : {
+ "description" : "Spectrum-display configuration.",
"$ref" : "#/definitions/GLSpectrum"
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -3043,7 +3657,8 @@ margin-bottom: 20px;
defs.Bandwidth = {
"properties" : {
"bandwidth" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Bandwidth in Hz."
}
},
"description" : "A bandwidth expressed in Hertz (Hz)"
@@ -3061,40 +3676,55 @@ margin-bottom: 20px;
defs.BeamSteeringCWModSettings = {
"properties" : {
"steerDegrees" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Steer degrees setting for Beam steering CW mod."
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"log2Interp" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent of the software interpolation factor; the output sample rate is multiplied by 2^log2Interp."
},
"filterChainHash" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Identifier of the selected half-band filter chain."
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -3103,64 +3733,91 @@ margin-bottom: 20px;
defs.BladeRF1InputSettings = {
"properties" : {
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"centerFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Device center frequency in Hz."
},
"devSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device I/Q sample rate in samples per second before software decimation or interpolation."
},
"lnaGain" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Low-noise-amplifier gain setting."
},
"vga1" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "First variable-gain-amplifier gain setting."
},
"vga2" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Second variable-gain-amplifier gain setting."
},
"bandwidth" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Bandwidth in Hz."
},
"log2Decim" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent of the software decimation factor; the output sample rate is divided by 2^log2Decim."
},
"fcPos" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Position of the decimated passband relative to the device center frequency."
},
"xb200" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Xb200 setting for Blade rf1 input."
},
"xb200Path" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Xb200 path setting for Blade rf1 input."
},
"xb200Filter" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Xb200 filter setting for Blade rf1 input."
},
"dcBlock" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable DSP DC-offset correction (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"iqCorrection" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable I/Q imbalance correction (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"iqOrder" : {
"type" : "integer",
- "description" : "IQ samples order\n * 0 - Q then I (swapped)\n * 1 - I then Q (straight)\n"
+ "description" : "IQ samples order\n * 0 - Q then I (swapped)\n * 1 - I then Q (straight)\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
}
},
"description" : "BladeRF1"
@@ -3168,48 +3825,65 @@ margin-bottom: 20px;
defs.BladeRF1OutputSettings = {
"properties" : {
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"centerFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Device center frequency in Hz."
},
"devSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device I/Q sample rate in samples per second before software decimation or interpolation."
},
"vga1" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "First variable-gain-amplifier gain setting."
},
"vga2" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Second variable-gain-amplifier gain setting."
},
"bandwidth" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Bandwidth in Hz."
},
"log2Interp" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent of the software interpolation factor; the output sample rate is multiplied by 2^log2Interp."
},
"xb200" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Xb200 setting for Blade rf1 output."
},
"xb200Path" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Xb200 path setting for Blade rf1 output."
},
"xb200Filter" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Xb200 filter setting for Blade rf1 output."
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
}
},
"description" : "BladeRF1"
@@ -3217,19 +3891,24 @@ margin-bottom: 20px;
defs.BladeRF2InputReport = {
"properties" : {
"frequencyRange" : {
+ "description" : "Frequency range data for Blade rf2 input.",
"$ref" : "#/definitions/FrequencyRange"
},
"sampleRateRange" : {
+ "description" : "Sample rate range data for Blade rf2 input.",
"$ref" : "#/definitions/Range"
},
"bandwidthRange" : {
+ "description" : "Bandwidth range data for Blade rf2 input.",
"$ref" : "#/definitions/Range"
},
"globalGainRange" : {
+ "description" : "Global gain range data for Blade rf2 input.",
"$ref" : "#/definitions/Range"
},
"gainModes" : {
"type" : "array",
+ "description" : "List of gain modes.",
"items" : {
"$ref" : "#/definitions/NamedEnum"
}
@@ -3240,65 +3919,96 @@ margin-bottom: 20px;
defs.BladeRF2InputSettings = {
"properties" : {
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"centerFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Device center frequency in Hz."
},
"LOppmTenths" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Local-oscillator correction in tenths of a part per million."
},
"devSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device I/Q sample rate in samples per second before software decimation or interpolation."
},
"bandwidth" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Bandwidth in Hz."
},
"gainMode" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Gain-control mode selection."
},
"globalGain" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Overall device gain setting."
},
"biasTee" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable the antenna bias tee (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"log2Decim" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent of the software decimation factor; the output sample rate is divided by 2^log2Decim."
},
"fcPos" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Position of the decimated passband relative to the device center frequency."
},
"dcBlock" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable DSP DC-offset correction (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"iqCorrection" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable I/Q imbalance correction (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"transverterMode" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable transverter frequency translation (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"transverterDeltaFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Frequency translation applied in transverter mode in Hz."
},
"iqOrder" : {
"type" : "integer",
- "description" : "IQ samples order\n * 0 - Q then I (swapped)\n * 1 - I then Q (straight)\n"
+ "description" : "IQ samples order\n * 0 - Q then I (swapped)\n * 1 - I then Q (straight)\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
}
},
"description" : "BladeRF2"
@@ -3306,33 +4016,42 @@ margin-bottom: 20px;
defs.BladeRF2MIMOReport = {
"properties" : {
"frequencyRangeRx" : {
+ "description" : "Frequency range receive data for Blade rf2 MIMO.",
"$ref" : "#/definitions/FrequencyRange"
},
"sampleRateRangeRx" : {
+ "description" : "Sample rate range receive data for Blade rf2 MIMO.",
"$ref" : "#/definitions/Range"
},
"bandwidthRangeRx" : {
+ "description" : "Bandwidth range receive data for Blade rf2 MIMO.",
"$ref" : "#/definitions/Range"
},
"globalGainRangeRx" : {
+ "description" : "Global gain range receive data for Blade rf2 MIMO.",
"$ref" : "#/definitions/Range"
},
"gainModesRx" : {
"type" : "array",
+ "description" : "List of gain modes receive.",
"items" : {
"$ref" : "#/definitions/NamedEnum"
}
},
"frequencyRangeTx" : {
+ "description" : "Frequency range transmit data for Blade rf2 MIMO.",
"$ref" : "#/definitions/FrequencyRange"
},
"sampleRateRangeTx" : {
+ "description" : "Sample rate range transmit data for Blade rf2 MIMO.",
"$ref" : "#/definitions/Range"
},
"bandwidthRangeTx" : {
+ "description" : "Bandwidth range transmit data for Blade rf2 MIMO.",
"$ref" : "#/definitions/Range"
},
"globalGainRangeTx" : {
+ "description" : "Global gain range transmit data for Blade rf2 MIMO.",
"$ref" : "#/definitions/Range"
}
},
@@ -3341,108 +4060,146 @@ margin-bottom: 20px;
defs.BladeRF2MIMOSettings = {
"properties" : {
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"devSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device I/Q sample rate in samples per second before software decimation or interpolation."
},
"LOppmTenths" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Local-oscillator correction in tenths of a part per million."
},
"rxCenterFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Receive center frequency in Hz."
},
"log2Decim" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent of the software decimation factor; the output sample rate is divided by 2^log2Decim."
},
"fcPosRx" : {
"type" : "integer",
"description" : "See BladeRF2MIMO::fcPos_t"
},
"rxBandwidth" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Receive bandwidth in Hz."
},
"rx0GainMode" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Rx0 gain mode setting for Blade rf2 MIMO."
},
"rx0GlobalGain" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Rx0 global gain setting for Blade rf2 MIMO."
},
"rx1GainMode" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Rx1 gain mode setting for Blade rf2 MIMO."
},
"rx1GlobalGain" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Rx1 global gain setting for Blade rf2 MIMO."
},
"rxBiasTee" : {
"type" : "integer",
- "description" : "boolean"
+ "description" : "boolean",
+ "minimum" : 0,
+ "maximum" : 1
},
"dcBlock" : {
"type" : "integer",
- "description" : "boolean"
+ "description" : "boolean",
+ "minimum" : 0,
+ "maximum" : 1
},
"iqCorrection" : {
"type" : "integer",
- "description" : "boolean"
+ "description" : "boolean",
+ "minimum" : 0,
+ "maximum" : 1
},
"rxTransverterMode" : {
"type" : "integer",
- "description" : "boolean"
+ "description" : "boolean",
+ "minimum" : 0,
+ "maximum" : 1
},
"rxTransverterDeltaFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Receive frequency translation applied in transverter mode in Hz."
},
"iqOrder" : {
"type" : "integer",
- "description" : "IQ samples order\n * 0 - Q then I (swapped)\n * 1 - I then Q (straight)\n"
+ "description" : "IQ samples order\n * 0 - Q then I (swapped)\n * 1 - I then Q (straight)\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"txCenterFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Transmit center frequency in Hz."
},
"log2Interp" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent of the software interpolation factor; the output sample rate is multiplied by 2^log2Interp."
},
"fcPosTx" : {
"type" : "integer",
"description" : "See BladeRF2MIMO::fcPos_t"
},
"txBandwidth" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Transmit bandwidth in Hz."
},
"tx0GlobalGain" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Tx0 global gain setting for Blade rf2 MIMO."
},
"tx1GlobalGain" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Tx1 global gain setting for Blade rf2 MIMO."
},
"txBiasTee" : {
"type" : "integer",
- "description" : "boolean"
+ "description" : "boolean",
+ "minimum" : 0,
+ "maximum" : 1
},
"txTransverterMode" : {
"type" : "integer",
- "description" : "boolean"
+ "description" : "boolean",
+ "minimum" : 0,
+ "maximum" : 1
},
"txTransverterDeltaFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Transmit frequency translation applied in transverter mode in Hz."
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "boolean"
+ "description" : "boolean",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
}
},
"description" : "BladeRF2"
@@ -3450,15 +4207,19 @@ margin-bottom: 20px;
defs.BladeRF2OutputReport = {
"properties" : {
"frequencyRange" : {
+ "description" : "Frequency range data for Blade rf2 output.",
"$ref" : "#/definitions/FrequencyRange"
},
"sampleRateRange" : {
+ "description" : "Sample rate range data for Blade rf2 output.",
"$ref" : "#/definitions/Range"
},
"bandwidthRange" : {
+ "description" : "Bandwidth range data for Blade rf2 output.",
"$ref" : "#/definitions/Range"
},
"globalGainRange" : {
+ "description" : "Global gain range data for Blade rf2 output.",
"$ref" : "#/definitions/Range"
}
},
@@ -3467,49 +4228,70 @@ margin-bottom: 20px;
defs.BladeRF2OutputSettings = {
"properties" : {
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"centerFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Device center frequency in Hz."
},
"LOppmTenths" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Local-oscillator correction in tenths of a part per million."
},
"devSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device I/Q sample rate in samples per second before software decimation or interpolation."
},
"bandwidth" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Bandwidth in Hz."
},
"globalGain" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Overall device gain setting."
},
"biasTee" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable the antenna bias tee (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"log2Interp" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent of the software interpolation factor; the output sample rate is multiplied by 2^log2Interp."
},
"transverterMode" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable transverter frequency translation (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"transverterDeltaFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Frequency translation applied in transverter mode in Hz."
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
}
},
"description" : "BladeRF2"
@@ -3517,7 +4299,8 @@ margin-bottom: 20px;
defs.CWKeyerSettings = {
"properties" : {
"sampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Sample rate in samples per second."
},
"wpm" : {
"type" : "integer",
@@ -3528,7 +4311,8 @@ margin-bottom: 20px;
"description" : "see enum CWKeyerSettings::CWMode"
},
"text" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Text setting for CW keyer."
},
"loop" : {
"type" : "integer",
@@ -3645,39 +4429,51 @@ margin-bottom: 20px;
"description" : "Optional for reverse API. This is the channel index from where the message comes from."
},
"AISModActions" : {
+ "description" : "AIS mod actions configuration for Channel.",
"$ref" : "#/definitions/AISModActions"
},
"APTDemodActions" : {
+ "description" : "Apt demod actions configuration for Channel.",
"$ref" : "#/definitions/APTDemodActions"
},
"FileSinkActions" : {
+ "description" : "File sink actions configuration for Channel.",
"$ref" : "#/definitions/FileSinkActions"
},
"FileSourceActions" : {
+ "description" : "File source actions configuration for Channel.",
"$ref" : "#/definitions/FileSourceActions"
},
"FreqScannerActions" : {
+ "description" : "Freq scanner actions configuration for Channel.",
"$ref" : "#/definitions/FreqScannerActions"
},
"IEEE_802_15_4_ModActions" : {
+ "description" : "Ieee 802 15 4 mod actions configuration for Channel.",
"$ref" : "#/definitions/IEEE_802_15_4_ModActions"
},
"MeshcoreModActions" : {
+ "description" : "Meshcore mod actions configuration for Channel.",
"$ref" : "#/definitions/MeshcoreModActions"
},
"PacketModActions" : {
+ "description" : "Packet mod actions configuration for Channel.",
"$ref" : "#/definitions/PacketModActions"
},
"PSK31ModActions" : {
+ "description" : "Psk31 mod actions configuration for Channel.",
"$ref" : "#/definitions/PSK31ModActions"
},
"RadioAstronomyActions" : {
+ "description" : "Radio astronomy actions configuration for Channel.",
"$ref" : "#/definitions/RadioAstronomyActions"
},
"RTTYModActions" : {
+ "description" : "Rtty mod actions configuration for Channel.",
"$ref" : "#/definitions/RTTYModActions"
},
"SigMFFileSinkActions" : {
+ "description" : "Sig mf file sink actions configuration for Channel.",
"$ref" : "#/definitions/SigMFFileSinkActions"
}
},
@@ -3686,72 +4482,95 @@ margin-bottom: 20px;
defs.ChannelAnalyzerSettings = {
"properties" : {
"frequency" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Frequency in Hz."
},
"downSample" : {
"type" : "integer",
- "description" : "Boolean"
+ "description" : "Boolean",
+ "minimum" : 0,
+ "maximum" : 1
},
"downSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Down sample rate in samples per second."
},
"bandwidth" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Bandwidth in Hz."
},
"lowCutoff" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Lower filter cutoff frequency in Hz."
},
"spanLog2" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent controlling the displayed or processed frequency span."
},
"ssb" : {
"type" : "integer",
- "description" : "Boolean"
+ "description" : "Boolean",
+ "minimum" : 0,
+ "maximum" : 1
},
"pll" : {
"type" : "integer",
- "description" : "Boolean"
+ "description" : "Boolean",
+ "minimum" : 0,
+ "maximum" : 1
},
"fll" : {
"type" : "integer",
- "description" : "Boolean"
+ "description" : "Boolean",
+ "minimum" : 0,
+ "maximum" : 1
},
"costasLoop" : {
"type" : "integer",
- "description" : "Boolean"
+ "description" : "Boolean",
+ "minimum" : 0,
+ "maximum" : 1
},
"rrc" : {
"type" : "integer",
- "description" : "Boolean"
+ "description" : "Boolean",
+ "minimum" : 0,
+ "maximum" : 1
},
"rrcRolloff" : {
"type" : "integer",
"description" : "in 100ths"
},
"pllPskOrder" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Pll psk order setting for Channel analyzer."
},
"pllBandwidth" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Pll bandwidth in Hz."
},
"pllDampingFactor" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Pll damping factor setting for Channel analyzer."
},
"pllLoopGain" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Pll loop gain setting for Channel analyzer."
},
"inputType" : {
"type" : "integer",
"description" : "see ChannelAnalyzerSettings::InputType"
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"streamIndex" : {
"type" : "integer",
@@ -3759,30 +4578,42 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"spectrumConfig" : {
+ "description" : "Spectrum-display configuration.",
"$ref" : "#/definitions/GLSpectrum"
},
"scopeConfig" : {
+ "description" : "Oscilloscope-display configuration.",
"$ref" : "#/definitions/GLScope"
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -3795,6 +4626,7 @@ margin-bottom: 20px;
"description" : "Channel type ID in URI form"
},
"config" : {
+ "description" : "Configuration data.",
"$ref" : "#/definitions/ChannelSettings"
}
},
@@ -3833,14 +4665,16 @@ margin-bottom: 20px;
defs.ChannelMarker = {
"properties" : {
"centerFrequency" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device center frequency in Hz."
},
"color" : {
"type" : "integer",
"description" : "RGB color"
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"frequencyScaleDisplayType" : {
"type" : "integer",
@@ -3872,7 +4706,8 @@ margin-bottom: 20px;
"description" : "pulse power received in channel (dB)"
},
"channelSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Effective sample rate delivered to the channel in samples per second."
}
},
"description" : "ChannelPower"
@@ -3881,7 +4716,8 @@ margin-bottom: 20px;
"properties" : {
"inputFrequencyOffset" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Channel frequency offset from the device center frequency in Hz."
},
"frequencyMode" : {
"type" : "integer",
@@ -3894,7 +4730,8 @@ margin-bottom: 20px;
},
"rfBandwidth" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "RF bandwidth in Hz."
},
"pulseThreshold" : {
"type" : "number",
@@ -3906,10 +4743,12 @@ margin-bottom: 20px;
"description" : "Average period in microseconds"
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"streamIndex" : {
"type" : "integer",
@@ -3917,24 +4756,34 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -3953,171 +4802,227 @@ margin-bottom: 20px;
"description" : "0 for Rx only, 1 for Tx only or 2 for any number and direction (default 0)"
},
"ADSBDemodReport" : {
+ "description" : "ADS-B demod report data for Channel.",
"$ref" : "#/definitions/ADSBDemodReport"
},
"AISDemodReport" : {
+ "description" : "AIS demod report data for Channel.",
"$ref" : "#/definitions/AISDemodReport"
},
"AISModReport" : {
+ "description" : "AIS mod report data for Channel.",
"$ref" : "#/definitions/AISModReport"
},
"AMDemodReport" : {
+ "description" : "Am demod report data for Channel.",
"$ref" : "#/definitions/AMDemodReport"
},
"AMModReport" : {
+ "description" : "Am mod report data for Channel.",
"$ref" : "#/definitions/AMModReport"
},
"ATVModReport" : {
+ "description" : "Atv mod report data for Channel.",
"$ref" : "#/definitions/ATVModReport"
},
"BFMDemodReport" : {
+ "description" : "BFM demod report data for Channel.",
"$ref" : "#/definitions/BFMDemodReport"
},
"ChannelPowerReport" : {
+ "description" : "Channel power report data for Channel.",
"$ref" : "#/definitions/ChannelPowerReport"
},
"ChirpChatDemodReport" : {
+ "description" : "Chirp chat demod report data for Channel.",
"$ref" : "#/definitions/ChirpChatDemodReport"
},
"ChirpChatModReport" : {
+ "description" : "Chirp chat mod report data for Channel.",
"$ref" : "#/definitions/ChirpChatModReport"
},
"DATVDemodReport" : {
+ "description" : "Datv demod report data for Channel.",
"$ref" : "#/definitions/DATVDemodReport"
},
"DATVModReport" : {
+ "description" : "Datv mod report data for Channel.",
"$ref" : "#/definitions/DATVModReport"
},
"DOA2Report" : {
+ "description" : "Doa2 report data for Channel.",
"$ref" : "#/definitions/DOA2Report"
},
"DSCDemodReport" : {
+ "description" : "Dsc demod report data for Channel.",
"$ref" : "#/definitions/DSCDemodReport"
},
"DSDDemodReport" : {
+ "description" : "Dsd demod report data for Channel.",
"$ref" : "#/definitions/DSDDemodReport"
},
"EndOfTrainDemodReport" : {
+ "description" : "End of train demod report data for Channel.",
"$ref" : "#/definitions/EndOfTrainDemodReport"
},
"IEEE_802_15_4_ModReport" : {
+ "description" : "Ieee 802 15 4 mod report data for Channel.",
"$ref" : "#/definitions/IEEE_802_15_4_ModReport"
},
"FileSinkReport" : {
+ "description" : "File sink report data for Channel.",
"$ref" : "#/definitions/FileSinkReport"
},
"FileSourceReport" : {
+ "description" : "File source report data for Channel.",
"$ref" : "#/definitions/FileSourceReport"
},
"FreeDVDemodReport" : {
+ "description" : "Free dv demod report data for Channel.",
"$ref" : "#/definitions/FreeDVDemodReport"
},
"FreeDVModReport" : {
+ "description" : "Free dv mod report data for Channel.",
"$ref" : "#/definitions/FreeDVModReport"
},
"FreqScannerReport" : {
+ "description" : "Freq scanner report data for Channel.",
"$ref" : "#/definitions/FreqScannerReport"
},
"FreqTrackerReport" : {
+ "description" : "Freq tracker report data for Channel.",
"$ref" : "#/definitions/FreqTrackerReport"
},
"FT8DemodReport" : {
+ "description" : "Ft8 demod report data for Channel.",
"$ref" : "#/definitions/FT8DemodReport"
},
"HeatMapReport" : {
+ "description" : "Heat map report data for Channel.",
"$ref" : "#/definitions/HeatMapReport"
},
"ILSDemodReport" : {
+ "description" : "Ils demod report data for Channel.",
"$ref" : "#/definitions/ILSDemodReport"
},
"InmarsatDemodReport" : {
+ "description" : "Inmarsat demod report data for Channel.",
"$ref" : "#/definitions/InmarsatDemodReport"
},
"M17DemodReport" : {
+ "description" : "M17 demod report data for Channel.",
"$ref" : "#/definitions/M17DemodReport"
},
"M17ModReport" : {
+ "description" : "M17 mod report data for Channel.",
"$ref" : "#/definitions/M17ModReport"
},
"MeshtasticDemodReport" : {
+ "description" : "Meshtastic demod report data for Channel.",
"$ref" : "#/definitions/MeshtasticDemodReport"
},
"MeshtasticModReport" : {
+ "description" : "Meshtastic mod report data for Channel.",
"$ref" : "#/definitions/MeshtasticModReport"
},
"MeshcoreDemodReport" : {
+ "description" : "Meshcore demod report data for Channel.",
"$ref" : "#/definitions/MeshcoreDemodReport"
},
"MeshcoreModReport" : {
+ "description" : "Meshcore mod report data for Channel.",
"$ref" : "#/definitions/MeshcoreModReport"
},
"NavtexDemodReport" : {
+ "description" : "Navtex demod report data for Channel.",
"$ref" : "#/definitions/NavtexDemodReport"
},
"NFMDemodReport" : {
+ "description" : "Nfm demod report data for Channel.",
"$ref" : "#/definitions/NFMDemodReport"
},
"NFMModReport" : {
+ "description" : "Nfm mod report data for Channel.",
"$ref" : "#/definitions/NFMModReport"
},
"NoiseFigureReport" : {
+ "description" : "Noise figure report data for Channel.",
"$ref" : "#/definitions/NoiseFigureReport"
},
"SSBDemodReport" : {
+ "description" : "Ssb demod report data for Channel.",
"$ref" : "#/definitions/SSBDemodReport"
},
"RadioAstronomyReport" : {
+ "description" : "Radio astronomy report data for Channel.",
"$ref" : "#/definitions/RadioAstronomyReport"
},
"RadioClockReport" : {
+ "description" : "Radio clock report data for Channel.",
"$ref" : "#/definitions/RadioClockReport"
},
"RadiosondeDemodReport" : {
+ "description" : "Radiosonde demod report data for Channel.",
"$ref" : "#/definitions/RadiosondeDemodReport"
},
"RemoteSourceReport" : {
+ "description" : "Remote source report data for Channel.",
"$ref" : "#/definitions/RemoteSourceReport"
},
"RTTYDemodReport" : {
+ "description" : "Rtty demod report data for Channel.",
"$ref" : "#/definitions/RTTYDemodReport"
},
"RTTYModReport" : {
+ "description" : "Rtty mod report data for Channel.",
"$ref" : "#/definitions/RTTYModReport"
},
"PacketDemodReport" : {
+ "description" : "Packet demod report data for Channel.",
"$ref" : "#/definitions/PacketDemodReport"
},
"PacketModReport" : {
+ "description" : "Packet mod report data for Channel.",
"$ref" : "#/definitions/PacketModReport"
},
"PagerDemodReport" : {
+ "description" : "Pager demod report data for Channel.",
"$ref" : "#/definitions/PagerDemodReport"
},
"PSK31ModReport" : {
+ "description" : "Psk31 mod report data for Channel.",
"$ref" : "#/definitions/PSK31ModReport"
},
"SigMFFileSinkReport" : {
+ "description" : "Sig mf file sink report data for Channel.",
"$ref" : "#/definitions/SigMFFileSinkReport"
},
"SSBModReport" : {
+ "description" : "Ssb mod report data for Channel.",
"$ref" : "#/definitions/SSBModReport"
},
"UDPSourceReport" : {
+ "description" : "UDP source report data for Channel.",
"$ref" : "#/definitions/UDPSourceReport"
},
"UDPSinkReport" : {
+ "description" : "UDP sink report data for Channel.",
"$ref" : "#/definitions/UDPSinkReport"
},
"VORDemodReport" : {
+ "description" : "Vor demod report data for Channel.",
"$ref" : "#/definitions/VORDemodReport"
},
"WDSPRxReport" : {
+ "description" : "Wdsp receive report data for Channel.",
"$ref" : "#/definitions/WDSPRxReport"
},
"WFMDemodReport" : {
+ "description" : "Wfm demod report data for Channel.",
"$ref" : "#/definitions/WFMDemodReport"
},
"WFMModReport" : {
+ "description" : "Wfm mod report data for Channel.",
"$ref" : "#/definitions/WFMModReport"
}
},
@@ -4144,201 +5049,267 @@ margin-bottom: 20px;
"description" : "Optional for reverse API. This is the channel index from where the message comes from."
},
"ADSBDemodSettings" : {
+ "description" : "ADS-B demod settings configuration for Channel.",
"$ref" : "#/definitions/ADSBDemodSettings"
},
"AISDemodSettings" : {
+ "description" : "AIS demod settings configuration for Channel.",
"$ref" : "#/definitions/AISDemodSettings"
},
"AISModSettings" : {
+ "description" : "AIS mod settings configuration for Channel.",
"$ref" : "#/definitions/AISModSettings"
},
"AMDemodSettings" : {
+ "description" : "Am demod settings configuration for Channel.",
"$ref" : "#/definitions/AMDemodSettings"
},
"AMModSettings" : {
+ "description" : "Am mod settings configuration for Channel.",
"$ref" : "#/definitions/AMModSettings"
},
"APTDemodSettings" : {
+ "description" : "Apt demod settings configuration for Channel.",
"$ref" : "#/definitions/APTDemodSettings"
},
"ATVDemodSettings" : {
+ "description" : "Atv demod settings configuration for Channel.",
"$ref" : "#/definitions/ATVDemodSettings"
},
"ATVModSettings" : {
+ "description" : "Atv mod settings configuration for Channel.",
"$ref" : "#/definitions/ATVModSettings"
},
"BeamSteeringCWModSettings" : {
+ "description" : "Beam steering CW mod settings configuration for Channel.",
"$ref" : "#/definitions/BeamSteeringCWModSettings"
},
"BFMDemodSettings" : {
+ "description" : "BFM demod settings configuration for Channel.",
"$ref" : "#/definitions/BFMDemodSettings"
},
"ChannelAnalyzerSettings" : {
+ "description" : "Channel analyzer settings configuration for Channel.",
"$ref" : "#/definitions/ChannelAnalyzerSettings"
},
"ChannelPowerSettings" : {
+ "description" : "Channel power settings configuration for Channel.",
"$ref" : "#/definitions/ChannelPowerSettings"
},
"ChirpChatDemodSettings" : {
+ "description" : "Chirp chat demod settings configuration for Channel.",
"$ref" : "#/definitions/ChirpChatDemodSettings"
},
"ChirpChatModSettings" : {
+ "description" : "Chirp chat mod settings configuration for Channel.",
"$ref" : "#/definitions/ChirpChatModSettings"
},
"DATVModSettings" : {
+ "description" : "Datv mod settings configuration for Channel.",
"$ref" : "#/definitions/DATVModSettings"
},
"DATVDemodSettings" : {
+ "description" : "Datv demod settings configuration for Channel.",
"$ref" : "#/definitions/DATVDemodSettings"
},
"DABDemodSettings" : {
+ "description" : "Dab demod settings configuration for Channel.",
"$ref" : "#/definitions/DABDemodSettings"
},
"DOA2Settings" : {
+ "description" : "Doa2 settings configuration for Channel.",
"$ref" : "#/definitions/DOA2Settings"
},
"DSCDemodSettings" : {
+ "description" : "Dsc demod settings configuration for Channel.",
"$ref" : "#/definitions/DSCDemodSettings"
},
"DSDDemodSettings" : {
+ "description" : "Dsd demod settings configuration for Channel.",
"$ref" : "#/definitions/DSDDemodSettings"
},
"EndOfTrainDemodSettings" : {
+ "description" : "End of train demod settings configuration for Channel.",
"$ref" : "#/definitions/EndOfTrainDemodSettings"
},
"FileSinkSettings" : {
+ "description" : "File sink settings configuration for Channel.",
"$ref" : "#/definitions/FileSinkSettings"
},
"FileSourceSettings" : {
+ "description" : "File source settings configuration for Channel.",
"$ref" : "#/definitions/FileSourceSettings"
},
"FreeDVDemodSettings" : {
+ "description" : "Free dv demod settings configuration for Channel.",
"$ref" : "#/definitions/FreeDVDemodSettings"
},
"FreeDVModSettings" : {
+ "description" : "Free dv mod settings configuration for Channel.",
"$ref" : "#/definitions/FreeDVModSettings"
},
"FreqScannerSettings" : {
+ "description" : "Freq scanner settings configuration for Channel.",
"$ref" : "#/definitions/FreqScannerSettings"
},
"FreqTrackerSettings" : {
+ "description" : "Freq tracker settings configuration for Channel.",
"$ref" : "#/definitions/FreqTrackerSettings"
},
"FT8DemodSettings" : {
+ "description" : "Ft8 demod settings configuration for Channel.",
"$ref" : "#/definitions/FT8DemodSettings"
},
"HeatMapSettings" : {
+ "description" : "Heat map settings configuration for Channel.",
"$ref" : "#/definitions/HeatMapSettings"
},
"ILSDemodSettings" : {
+ "description" : "Ils demod settings configuration for Channel.",
"$ref" : "#/definitions/ILSDemodSettings"
},
"InmarsatDemodSettings" : {
+ "description" : "Inmarsat demod settings configuration for Channel.",
"$ref" : "#/definitions/InmarsatDemodSettings"
},
"InterferometerSettings" : {
+ "description" : "Interferometer settings configuration for Channel.",
"$ref" : "#/definitions/InterferometerSettings"
},
"IEEE_802_15_4_ModSettings" : {
+ "description" : "Ieee 802 15 4 mod settings configuration for Channel.",
"$ref" : "#/definitions/IEEE_802_15_4_ModSettings"
},
"M17DemodSettings" : {
+ "description" : "M17 demod settings configuration for Channel.",
"$ref" : "#/definitions/M17DemodSettings"
},
"M17ModSettings" : {
+ "description" : "M17 mod settings configuration for Channel.",
"$ref" : "#/definitions/M17ModSettings"
},
"MeshtasticDemodSettings" : {
+ "description" : "Meshtastic demod settings configuration for Channel.",
"$ref" : "#/definitions/MeshtasticDemodSettings"
},
"MeshtasticModSettings" : {
+ "description" : "Meshtastic mod settings configuration for Channel.",
"$ref" : "#/definitions/MeshtasticModSettings"
},
"MeshcoreDemodSettings" : {
+ "description" : "Meshcore demod settings configuration for Channel.",
"$ref" : "#/definitions/MeshcoreDemodSettings"
},
"MeshcoreModSettings" : {
+ "description" : "Meshcore mod settings configuration for Channel.",
"$ref" : "#/definitions/MeshcoreModSettings"
},
"NavtexDemodSettings" : {
+ "description" : "Navtex demod settings configuration for Channel.",
"$ref" : "#/definitions/NavtexDemodSettings"
},
"NFMDemodSettings" : {
+ "description" : "Nfm demod settings configuration for Channel.",
"$ref" : "#/definitions/NFMDemodSettings"
},
"NFMModSettings" : {
+ "description" : "Nfm mod settings configuration for Channel.",
"$ref" : "#/definitions/NFMModSettings"
},
"NoiseFigureSettings" : {
+ "description" : "Noise figure settings configuration for Channel.",
"$ref" : "#/definitions/NoiseFigureSettings"
},
"LocalSinkSettings" : {
+ "description" : "Local sink settings configuration for Channel.",
"$ref" : "#/definitions/LocalSinkSettings"
},
"LocalSourceSettings" : {
+ "description" : "Local source settings configuration for Channel.",
"$ref" : "#/definitions/LocalSourceSettings"
},
"PacketDemodSettings" : {
+ "description" : "Packet demod settings configuration for Channel.",
"$ref" : "#/definitions/PacketDemodSettings"
},
"PacketModSettings" : {
+ "description" : "Packet mod settings configuration for Channel.",
"$ref" : "#/definitions/PacketModSettings"
},
"PagerDemodSettings" : {
+ "description" : "Pager demod settings configuration for Channel.",
"$ref" : "#/definitions/PagerDemodSettings"
},
"PSK31ModSettings" : {
+ "description" : "Psk31 mod settings configuration for Channel.",
"$ref" : "#/definitions/PSK31ModSettings"
},
"RadioAstronomySettings" : {
+ "description" : "Radio astronomy settings configuration for Channel.",
"$ref" : "#/definitions/RadioAstronomySettings"
},
"RadioClockSettings" : {
+ "description" : "Radio clock settings configuration for Channel.",
"$ref" : "#/definitions/RadioClockSettings"
},
"RadiosondeDemodSettings" : {
+ "description" : "Radiosonde demod settings configuration for Channel.",
"$ref" : "#/definitions/RadiosondeDemodSettings"
},
"RemoteSinkSettings" : {
+ "description" : "Remote sink settings configuration for Channel.",
"$ref" : "#/definitions/RemoteSinkSettings"
},
"RemoteSourceSettings" : {
+ "description" : "Remote source settings configuration for Channel.",
"$ref" : "#/definitions/RemoteSourceSettings"
},
"RemoteTCPSinkSettings" : {
+ "description" : "Remote TCP sink settings configuration for Channel.",
"$ref" : "#/definitions/RemoteTCPSinkSettings"
},
"RTTYDemodSettings" : {
+ "description" : "Rtty demod settings configuration for Channel.",
"$ref" : "#/definitions/RTTYDemodSettings"
},
"RTTYModSettings" : {
+ "description" : "Rtty mod settings configuration for Channel.",
"$ref" : "#/definitions/RTTYModSettings"
},
"SigMFFileSinkSettings" : {
+ "description" : "Sig mf file sink settings configuration for Channel.",
"$ref" : "#/definitions/SigMFFileSinkSettings"
},
"SSBModSettings" : {
+ "description" : "Ssb mod settings configuration for Channel.",
"$ref" : "#/definitions/SSBModSettings"
},
"SSBDemodSettings" : {
+ "description" : "Ssb demod settings configuration for Channel.",
"$ref" : "#/definitions/SSBDemodSettings"
},
"UDPSourceSettings" : {
+ "description" : "UDP source settings configuration for Channel.",
"$ref" : "#/definitions/UDPSourceSettings"
},
"UDPSinkSettings" : {
+ "description" : "UDP sink settings configuration for Channel.",
"$ref" : "#/definitions/UDPSinkSettings"
},
"VORDemodSettings" : {
+ "description" : "Vor demod settings configuration for Channel.",
"$ref" : "#/definitions/VORDemodSettings"
},
"WDSPRxSettings" : {
+ "description" : "Wdsp receive settings configuration for Channel.",
"$ref" : "#/definitions/WDSPRxSettings"
},
"WFMDemodSettings" : {
+ "description" : "Wfm demod settings configuration for Channel.",
"$ref" : "#/definitions/WFMDemodSettings"
},
"WFMModSettings" : {
+ "description" : "Wfm mod settings configuration for Channel.",
"$ref" : "#/definitions/WFMModSettings"
}
},
@@ -4384,7 +5355,8 @@ margin-bottom: 20px;
"description" : "last message de-chirped signal to noise ratio power (dB)"
},
"channelSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Effective sample rate delivered to the channel in samples per second."
},
"syncWord" : {
"type" : "integer",
@@ -4392,7 +5364,9 @@ margin-bottom: 20px;
},
"hasCRC" : {
"type" : "integer",
- "description" : "boolean 1 if payload CRC is present else 0 (LoRa)"
+ "description" : "boolean 1 if payload CRC is present else 0 (LoRa)",
+ "minimum" : 0,
+ "maximum" : 1
},
"nbParityBits" : {
"type" : "integer",
@@ -4412,7 +5386,9 @@ margin-bottom: 20px;
},
"headerParityStatus" : {
"type" : "integer",
- "description" : "Header FEC parity status:\n * 0 - Undefined\n * 1 - Uncorrectable error\n * 2 - Corrected error\n * 3 - OK\n"
+ "description" : "Header FEC parity status:\n * 0 - Undefined\n * 1 - Uncorrectable error\n * 2 - Corrected error\n * 3 - OK\n",
+ "minimum" : 0,
+ "maximum" : 3
},
"headerCRCStatus" : {
"type" : "integer",
@@ -4420,7 +5396,9 @@ margin-bottom: 20px;
},
"payloadParityStatus" : {
"type" : "integer",
- "description" : "Payload FEC parity status:\n * 0 - Undefined\n * 1 - Uncorrectable error\n * 2 - Corrected error\n * 3 - OK\n"
+ "description" : "Payload FEC parity status:\n * 0 - Undefined\n * 1 - Uncorrectable error\n * 2 - Corrected error\n * 3 - OK\n",
+ "minimum" : 0,
+ "maximum" : 3
},
"payloadCRCStatus" : {
"type" : "integer",
@@ -4443,7 +5421,9 @@ margin-bottom: 20px;
},
"decoding" : {
"type" : "integer",
- "description" : "Boolean - decoding status\n * 0 - no decoding\n * 1 - decoding\n"
+ "description" : "Boolean - decoding status\n * 0 - no decoding\n * 1 - decoding\n",
+ "minimum" : 0,
+ "maximum" : 1
}
},
"description" : "ChirpChatDemod"
@@ -4452,14 +5432,18 @@ margin-bottom: 20px;
"properties" : {
"inputFrequencyOffset" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Channel frequency offset from the device center frequency in Hz."
},
"bandwidthIndex" : {
"type" : "integer",
- "description" : "standard bandwidths index:\n * 0 - 375 Hz (384000 / 1024)\n * 1 - 750 Hz (384000 / 512)\n * 2 - 1500 Hz (384000 / 256)\n * 3 - 2604 Hz (333333 / 128)\n * 4 - 3125 Hz (400000 / 128)\n * 5 - 3906 Hz (500000 / 128)\n * 6 - 5208 Hz (333333 / 64)\n * 7 - 6250 Hz (400000 / 64)\n * 8 - 7813 Hz (500000 / 64)\n * 9 - 10417 Hz (333333 / 32)\n * 10 - 12500 Hz (400000 / 32)\n * 11 - 15625 Hz (500000 / 32)\n * 12 - 20833 Hz (333333 / 16)\n * 13 - 25000 Hz (400000 / 16)\n * 14 - 31250 Hz (500000 / 16)\n * 15 - 41667 Hz (333333 / 8)\n * 16 - 50000 Hz (400000 / 8)\n * 17 - 62500 Hz (500000 / 8)\n * 18 - 83333 Hz (333333 / 4)\n * 19 - 100000 Hz (400000 / 4)\n * 20 - 125000 Hz (500000 / 4)\n * 21 - 166667 Hz (333333 / 2)\n * 22 - 200000 Hz (400000 / 2)\n * 23 - 250000 Hz (500000 / 2)\n * 24 - 333333 Hz (333333 / 1)\n * 25 - 400000 Hz (400000 / 1)\n * 26 - 500000 Hz (500000 / 1)\n"
+ "description" : "standard bandwidths index:\n * 0 - 375 Hz (384000 / 1024)\n * 1 - 750 Hz (384000 / 512)\n * 2 - 1500 Hz (384000 / 256)\n * 3 - 2604 Hz (333333 / 128)\n * 4 - 3125 Hz (400000 / 128)\n * 5 - 3906 Hz (500000 / 128)\n * 6 - 5208 Hz (333333 / 64)\n * 7 - 6250 Hz (400000 / 64)\n * 8 - 7813 Hz (500000 / 64)\n * 9 - 10417 Hz (333333 / 32)\n * 10 - 12500 Hz (400000 / 32)\n * 11 - 15625 Hz (500000 / 32)\n * 12 - 20833 Hz (333333 / 16)\n * 13 - 25000 Hz (400000 / 16)\n * 14 - 31250 Hz (500000 / 16)\n * 15 - 41667 Hz (333333 / 8)\n * 16 - 50000 Hz (400000 / 8)\n * 17 - 62500 Hz (500000 / 8)\n * 18 - 83333 Hz (333333 / 4)\n * 19 - 100000 Hz (400000 / 4)\n * 20 - 125000 Hz (500000 / 4)\n * 21 - 166667 Hz (333333 / 2)\n * 22 - 200000 Hz (400000 / 2)\n * 23 - 250000 Hz (500000 / 2)\n * 24 - 333333 Hz (333333 / 1)\n * 25 - 400000 Hz (400000 / 1)\n * 26 - 500000 Hz (500000 / 1)\n",
+ "minimum" : 0,
+ "maximum" : 26
},
"spreadFactor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Spread factor setting for Chirp chat demod."
},
"deBits" : {
"type" : "integer",
@@ -4467,15 +5451,21 @@ margin-bottom: 20px;
},
"fftWindow" : {
"type" : "integer",
- "description" : "FFT Window index (FFTWindow::Function):\n * 0 - Bartlett\n * 1 - Blackman-Harris 4 term\n * 2 - Flattop\n * 3 - Hamming\n * 4 - Hanning\n * 5 - Rectangle\n * 6 - Kaiser\n * 7 - Blackman 3 term\n * 8 - Blackman-Harris 7 term\n"
+ "description" : "FFT Window index (FFTWindow::Function):\n * 0 - Bartlett\n * 1 - Blackman-Harris 4 term\n * 2 - Flattop\n * 3 - Hamming\n * 4 - Hanning\n * 5 - Rectangle\n * 6 - Kaiser\n * 7 - Blackman 3 term\n * 8 - Blackman-Harris 7 term\n",
+ "minimum" : 0,
+ "maximum" : 8
},
"codingScheme" : {
"type" : "integer",
- "description" : "message encoding scheme (ChirpChatDemodSettings::CodingScheme):\n * 0 - LoRa\n * 1 - Plain ASCII (7 bit)\n * 2 - Teletype (5 bit Baudot) a.k.a TTY\n"
+ "description" : "message encoding scheme (ChirpChatDemodSettings::CodingScheme):\n * 0 - LoRa\n * 1 - Plain ASCII (7 bit)\n * 2 - Teletype (5 bit Baudot) a.k.a TTY\n",
+ "minimum" : 0,
+ "maximum" : 2
},
"decodeActive" : {
"type" : "integer",
- "description" : "boolean 1 to activate 0 to de-activate decoder"
+ "description" : "boolean 1 to activate 0 to de-activate decoder",
+ "minimum" : 0,
+ "maximum" : 1
},
"eomSquelchTenths" : {
"type" : "integer",
@@ -4511,11 +5501,15 @@ margin-bottom: 20px;
},
"sendViaUDP" : {
"type" : "integer",
- "description" : "boolean 1 to send decoded message via UDP else 0"
+ "description" : "boolean 1 to send decoded message via UDP else 0",
+ "minimum" : 0,
+ "maximum" : 1
},
"udoEnabled" : {
"type" : "integer",
- "description" : "Boolean - Send via UDP\n * 0 - Do not send decoded messages via UDP\n * 1 - Send decoded messages via UDP\n"
+ "description" : "Boolean - Send via UDP\n * 0 - Do not send decoded messages via UDP\n * 1 - Send decoded messages via UDP\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"udpAddress" : {
"type" : "string",
@@ -4523,17 +5517,23 @@ margin-bottom: 20px;
},
"udpPort" : {
"type" : "integer",
- "description" : "UDP destination port"
+ "description" : "UDP destination port",
+ "minimum" : 1,
+ "maximum" : 65535
},
"invertRamps" : {
"type" : "integer",
- "description" : "Invert chirp ramps\n * 0 - Normal chirp ramps (upchirps for preamble and payload)\n * 1 - Inverted chirp ramps (downchirps for preamble and payload)\n"
+ "description" : "Invert chirp ramps\n * 0 - Normal chirp ramps (upchirps for preamble and payload)\n * 1 - Inverted chirp ramps (downchirps for preamble and payload)\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"streamIndex" : {
"type" : "integer",
@@ -4541,27 +5541,38 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"spectrumConfig" : {
+ "description" : "Spectrum-display configuration.",
"$ref" : "#/definitions/GLSpectrum"
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -4575,7 +5586,8 @@ margin-bottom: 20px;
"description" : "power transmitted in channel (dB)"
},
"channelSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Effective sample rate delivered to the channel in samples per second."
},
"symbolTimeMs" : {
"type" : "number",
@@ -4594,7 +5606,9 @@ margin-bottom: 20px;
},
"playing" : {
"type" : "integer",
- "description" : "Boolean - modulator is active (playing) including idle time\n * 0 - Modulator not active\n * 1 - Modulator active\n"
+ "description" : "Boolean - modulator is active (playing) including idle time\n * 0 - Modulator not active\n * 1 - Modulator active\n",
+ "minimum" : 0,
+ "maximum" : 1
}
},
"description" : "ChirpChatMod"
@@ -4603,14 +5617,18 @@ margin-bottom: 20px;
"properties" : {
"inputFrequencyOffset" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Channel frequency offset from the device center frequency in Hz."
},
"bandwidthIndex" : {
"type" : "integer",
- "description" : "standard bandwidths index:\n * 0 - 375 Hz (384000 / 1024)\n * 1 - 750 Hz (384000 / 512)\n * 2 - 1500 Hz (384000 / 256)\n * 3 - 2604 Hz (333333 / 128)\n * 4 - 3125 Hz (400000 / 128)\n * 5 - 3906 Hz (500000 / 128)\n * 6 - 5208 Hz (333333 / 64)\n * 7 - 6250 Hz (400000 / 64)\n * 8 - 7813 Hz (500000 / 64)\n * 9 - 10417 Hz (333333 / 32)\n * 10 - 12500 Hz (400000 / 32)\n * 11 - 15625 Hz (500000 / 32)\n * 12 - 20833 Hz (333333 / 16)\n * 13 - 25000 Hz (400000 / 16)\n * 14 - 31250 Hz (500000 / 16)\n * 15 - 41667 Hz (333333 / 8)\n * 16 - 50000 Hz (400000 / 8)\n * 17 - 62500 Hz (500000 / 8)\n * 18 - 83333 Hz (333333 / 4)\n * 19 - 100000 Hz (400000 / 4)\n * 20 - 125000 Hz (500000 / 4)\n * 21 - 166667 Hz (333333 / 2)\n * 22 - 200000 Hz (400000 / 2)\n * 23 - 250000 Hz (500000 / 2)\n * 24 - 333333 Hz (333333 / 1)\n * 25 - 400000 Hz (400000 / 1)\n * 26 - 500000 Hz (500000 / 1)\n"
+ "description" : "standard bandwidths index:\n * 0 - 375 Hz (384000 / 1024)\n * 1 - 750 Hz (384000 / 512)\n * 2 - 1500 Hz (384000 / 256)\n * 3 - 2604 Hz (333333 / 128)\n * 4 - 3125 Hz (400000 / 128)\n * 5 - 3906 Hz (500000 / 128)\n * 6 - 5208 Hz (333333 / 64)\n * 7 - 6250 Hz (400000 / 64)\n * 8 - 7813 Hz (500000 / 64)\n * 9 - 10417 Hz (333333 / 32)\n * 10 - 12500 Hz (400000 / 32)\n * 11 - 15625 Hz (500000 / 32)\n * 12 - 20833 Hz (333333 / 16)\n * 13 - 25000 Hz (400000 / 16)\n * 14 - 31250 Hz (500000 / 16)\n * 15 - 41667 Hz (333333 / 8)\n * 16 - 50000 Hz (400000 / 8)\n * 17 - 62500 Hz (500000 / 8)\n * 18 - 83333 Hz (333333 / 4)\n * 19 - 100000 Hz (400000 / 4)\n * 20 - 125000 Hz (500000 / 4)\n * 21 - 166667 Hz (333333 / 2)\n * 22 - 200000 Hz (400000 / 2)\n * 23 - 250000 Hz (500000 / 2)\n * 24 - 333333 Hz (333333 / 1)\n * 25 - 400000 Hz (400000 / 1)\n * 26 - 500000 Hz (500000 / 1)\n",
+ "minimum" : 0,
+ "maximum" : 26
},
"spreadFactor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Spread factor setting for Chirp chat mod."
},
"deBits" : {
"type" : "integer",
@@ -4630,11 +5648,15 @@ margin-bottom: 20px;
},
"channelMute" : {
"type" : "integer",
- "description" : "boolean"
+ "description" : "boolean",
+ "minimum" : 0,
+ "maximum" : 1
},
"codingScheme" : {
"type" : "integer",
- "description" : "message encoding scheme (ChirpChatModSettings::CodingScheme):\n * 0 - LoRa\n * 1 - Plain ASCII (7 bit)\n * 2 - Teletype (5 bit Baudot) a.k.a TTY\n"
+ "description" : "message encoding scheme (ChirpChatModSettings::CodingScheme):\n * 0 - LoRa\n * 1 - Plain ASCII (7 bit)\n * 2 - Teletype (5 bit Baudot) a.k.a TTY\n",
+ "minimum" : 0,
+ "maximum" : 2
},
"nbParityBits" : {
"type" : "integer",
@@ -4666,7 +5688,9 @@ margin-bottom: 20px;
},
"messageType" : {
"type" : "integer",
- "description" : "type of message to send (ChirpChatModSettings::MessageType):\n * 0 - No message i.e no output. Use this as a transition to resend the same message.\n * 1 - Beacon. Sends message specified in beaconMessage\n * 2 - CQ call. Sends message specified in cqMessage\n * 3 - Reply to CQ call. Sends message specified in replyMessage\n * 4 - Report to callee. Sends message specified in reportMessage\n * 5 - Report to caller. Sends message specified in replyReportMessage\n * 6 - RRR to callee. Sends message specified in rrrMessage\n * 7 - 73 to caller. Sends message specified in message73\n * 8 - Random message with callsigns. Sends message specified in qsoTextMessage\n * 9 - Plain text. Sends message specified in textMessage\n * 10 - Binary payload. Sends bytes specified in bytesMessage\n"
+ "description" : "type of message to send (ChirpChatModSettings::MessageType):\n * 0 - No message i.e no output. Use this as a transition to resend the same message.\n * 1 - Beacon. Sends message specified in beaconMessage\n * 2 - CQ call. Sends message specified in cqMessage\n * 3 - Reply to CQ call. Sends message specified in replyMessage\n * 4 - Report to callee. Sends message specified in reportMessage\n * 5 - Report to caller. Sends message specified in replyReportMessage\n * 6 - RRR to callee. Sends message specified in rrrMessage\n * 7 - 73 to caller. Sends message specified in message73\n * 8 - Random message with callsigns. Sends message specified in qsoTextMessage\n * 9 - Plain text. Sends message specified in textMessage\n * 10 - Binary payload. Sends bytes specified in bytesMessage\n",
+ "minimum" : 0,
+ "maximum" : 10
},
"beaconMessage" : {
"type" : "string",
@@ -4717,7 +5741,9 @@ margin-bottom: 20px;
},
"udpEnabled" : {
"type" : "integer",
- "description" : "boolean 1 to enable forwarding messages via UDP else 0"
+ "description" : "boolean 1 to enable forwarding messages via UDP else 0",
+ "minimum" : 0,
+ "maximum" : 1
},
"udpAddress" : {
"type" : "string",
@@ -4725,17 +5751,23 @@ margin-bottom: 20px;
},
"udpPort" : {
"type" : "integer",
- "description" : "UDP port to listen for messages to transmit on"
+ "description" : "UDP port to listen for messages to transmit on",
+ "minimum" : 1,
+ "maximum" : 65535
},
"invertRamps" : {
"type" : "integer",
- "description" : "Invert chirp ramps\n * 0 - Normal chirp ramps (upchirps for preamble and payload)\n * 1 - Inverted chirp ramps (downchirps for preamble and payload)\n"
+ "description" : "Invert chirp ramps\n * 0 - Normal chirp ramps (upchirps for preamble and payload)\n * 1 - Inverted chirp ramps (downchirps for preamble and payload)\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"streamIndex" : {
"type" : "integer",
@@ -4743,24 +5775,34 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -4769,16 +5811,20 @@ margin-bottom: 20px;
defs.Command = {
"properties" : {
"group" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Group for Command."
},
"description" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Human-readable description."
},
"command" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Command for Command."
},
"argString" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Arg string for Command."
},
"key" : {
"type" : "integer",
@@ -4790,11 +5836,15 @@ margin-bottom: 20px;
},
"associateKey" : {
"type" : "integer",
- "description" : "boolean"
+ "description" : "boolean",
+ "minimum" : 0,
+ "maximum" : 1
},
"release" : {
"type" : "integer",
- "description" : "boolean"
+ "description" : "boolean",
+ "minimum" : 0,
+ "maximum" : 1
}
},
"description" : "Represents a Command object"
@@ -4803,11 +5853,13 @@ margin-bottom: 20px;
"properties" : {
"real" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Real component of the complex number."
},
"imag" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Imaginary component of the complex number."
}
},
"description" : "A complex number"
@@ -4889,30 +5941,40 @@ margin-bottom: 20px;
"properties" : {
"inputFrequencyOffset" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Channel frequency offset from the device center frequency in Hz."
},
"rfBandwidth" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "RF bandwidth in Hz."
},
"program" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Program setting for Dab demod."
},
"volume" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Audio volume multiplier."
},
"audioMute" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Mute audio output (1 muted, 0 unmuted).",
+ "minimum" : 0,
+ "maximum" : 1
},
"audioDeviceName" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Name of the audio device to use."
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"streamIndex" : {
"type" : "integer",
@@ -4920,24 +5982,34 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -4952,7 +6024,9 @@ margin-bottom: 20px;
},
"audioActive" : {
"type" : "integer",
- "description" : "Audio is active (1 for yes, 0 for now)"
+ "description" : "Audio is active (1 for yes, 0 for now)",
+ "minimum" : 0,
+ "maximum" : 1
},
"audioDecodeOK" : {
"type" : "integer",
@@ -4960,7 +6034,9 @@ margin-bottom: 20px;
},
"videoActive" : {
"type" : "integer",
- "description" : "Audio is active (1 for yes, 0 for now)"
+ "description" : "Audio is active (1 for yes, 0 for now)",
+ "minimum" : 0,
+ "maximum" : 1
},
"videoDecodeOK" : {
"type" : "integer",
@@ -4988,11 +6064,13 @@ margin-bottom: 20px;
},
"mer" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Reported mer."
},
"cnr" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Reported cnr."
}
},
"description" : "DATVDemod"
@@ -5000,28 +6078,38 @@ margin-bottom: 20px;
defs.DATVDemodSettings = {
"properties" : {
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"rfBandwidth" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "RF bandwidth in Hz."
},
"centerFrequency" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device center frequency in Hz."
},
"standard" : {
"type" : "integer",
- "description" : "DVB bersion (see DATVDemodSettings::dvb_version)\n * 0 - DVB-S\n * 1 - DVB-S2\n"
+ "description" : "DVB bersion (see DATVDemodSettings::dvb_version)\n * 0 - DVB-S\n * 1 - DVB-S2\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"modulation" : {
"type" : "integer",
- "description" : "Modulation type (DATVDemodSettings::DATVModulation)\n * 0 - BPSK\n * 1 - QPSK\n * 2 - PSK8\n * 3 - APSK16\n * 4 - APSK32\n * 5 - APSK64E\n * 6 - QAM16\n * 7 - QAM64\n * 8 - QAM256\n"
+ "description" : "Modulation type (DATVDemodSettings::DATVModulation)\n * 0 - BPSK\n * 1 - QPSK\n * 2 - PSK8\n * 3 - APSK16\n * 4 - APSK32\n * 5 - APSK64E\n * 6 - QAM16\n * 7 - QAM64\n * 8 - QAM256\n",
+ "minimum" : 0,
+ "maximum" : 8
},
"fec" : {
"type" : "integer",
- "description" : "FEC rate (see DATVDemodSettings::DATVCodeRate)\n * 0 - 1/2\n * 1 - 2/3\n * 2 - 4/6\n * 3 - 3/4\n * 4 - 4/6\n * 5 - 7/8\n * 6 - 4/5\n * 7 - 8/9\n * 8 - 9/10\n * 9 - 1/4\n * 10 - 1/3\n * 11 - 2/5\n * 12 - 3/5\n"
+ "description" : "FEC rate (see DATVDemodSettings::DATVCodeRate)\n * 0 - 1/2\n * 1 - 2/3\n * 2 - 4/6\n * 3 - 3/4\n * 4 - 4/6\n * 5 - 7/8\n * 6 - 4/5\n * 7 - 8/9\n * 8 - 9/10\n * 9 - 1/4\n * 10 - 1/3\n * 11 - 2/5\n * 12 - 3/5\n",
+ "minimum" : 0,
+ "maximum" : 12
},
"softLDPC" : {
"type" : "integer",
@@ -5037,16 +6125,21 @@ margin-bottom: 20px;
},
"audioMute" : {
"type" : "integer",
- "description" : "(boolean) mute audio output"
+ "description" : "(boolean) mute audio output",
+ "minimum" : 0,
+ "maximum" : 1
},
"audioDeviceName" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Name of the audio device to use."
},
"symbolRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Symbol rate setting for Datv demod."
},
"notchFilters" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Notch filters setting for Datv demod."
},
"allowDrift" : {
"type" : "integer",
@@ -5058,7 +6151,9 @@ margin-bottom: 20px;
},
"filter" : {
"type" : "integer",
- "description" : "Type of symbol filtering (see DATVDemodSettings::dvb_sampler)\n * 0 - Nearest\n * 1 - Linear\n * 2 - Root Raised Cosine\n"
+ "description" : "Type of symbol filtering (see DATVDemodSettings::dvb_sampler)\n * 0 - Nearest\n * 1 - Linear\n * 2 - Root Raised Cosine\n",
+ "minimum" : 0,
+ "maximum" : 2
},
"hardMetric" : {
"type" : "integer",
@@ -5078,25 +6173,34 @@ margin-bottom: 20px;
"description" : "RRC filter envelope excursion (dB)"
},
"audioVolume" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Audio volume setting for Datv demod."
},
"videoMute" : {
"type" : "integer",
- "description" : "boolean"
+ "description" : "boolean",
+ "minimum" : 0,
+ "maximum" : 1
},
"udpTSAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "UDP ts address."
},
"udpTSPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "UDP ts port."
},
"udpTS" : {
"type" : "integer",
- "description" : "boolean"
+ "description" : "boolean",
+ "minimum" : 0,
+ "maximum" : 1
},
"playerEnable" : {
"type" : "integer",
- "description" : "boolean"
+ "description" : "boolean",
+ "minimum" : 0,
+ "maximum" : 1
},
"streamIndex" : {
"type" : "integer",
@@ -5104,24 +6208,34 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -5135,20 +6249,25 @@ margin-bottom: 20px;
"description" : "power transmitted in channel (dB)"
},
"channelSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Effective sample rate delivered to the channel in samples per second."
},
"dataRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Reported data rate."
},
"tsFileBitrate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Reported ts file bitrate."
},
"tsFileLength" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Reported ts file length."
},
"udpByteCount" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Number of udp byte events or items."
}
},
"description" : "DATVMod"
@@ -5157,11 +6276,13 @@ margin-bottom: 20px;
"properties" : {
"inputFrequencyOffset" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Channel frequency offset from the device center frequency in Hz."
},
"rfBandwidth" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "RF bandwidth in Hz."
},
"standard" : {
"type" : "integer",
@@ -5189,7 +6310,8 @@ margin-bottom: 20px;
"description" : "Transport stream source (File=0 UDP=1)"
},
"imageFileName" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Image file name or path."
},
"imageOverlayTimestamp" : {
"type" : "integer",
@@ -5208,30 +6330,40 @@ margin-bottom: 20px;
"description" : "Image codec (HEVC=0 H264=1)"
},
"tsFileName" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Ts file name."
},
"tsFilePlayLoop" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Ts file play loop setting for Datv mod."
},
"tsFilePlay" : {
"type" : "integer",
"description" : "(Pause=0 Play=1)"
},
"udpAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name used for UDP traffic."
},
"udpPort" : {
"type" : "integer",
- "description" : "UDP port number to receive MPEG transport stream on"
+ "description" : "UDP port number to receive MPEG transport stream on",
+ "minimum" : 1,
+ "maximum" : 65535
},
"channelMute" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Mute the channel output (1 muted, 0 unmuted).",
+ "minimum" : 0,
+ "maximum" : 1
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"streamIndex" : {
"type" : "integer",
@@ -5239,24 +6371,34 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -5298,16 +6440,20 @@ margin-bottom: 20px;
"description" : "see DOA2Settings::CorrelationType"
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"log2Decim" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent of the software decimation factor; the output sample rate is divided by 2^log2Decim."
},
"filterChainHash" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Identifier of the selected half-band filter chain."
},
"phase" : {
"type" : "integer",
@@ -5331,27 +6477,38 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"scopeConfig" : {
+ "description" : "Oscilloscope-display configuration.",
"$ref" : "#/definitions/GLScope"
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -5365,7 +6522,8 @@ margin-bottom: 20px;
"description" : "power transmitted in channel (dB)"
},
"channelSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Effective sample rate delivered to the channel in samples per second."
}
},
"description" : "DSCDemod"
@@ -5374,44 +6532,65 @@ margin-bottom: 20px;
"properties" : {
"inputFrequencyOffset" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Channel frequency offset from the device center frequency in Hz."
},
"rfBandwidth" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "RF bandwidth in Hz."
},
"filterInvalid" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Filter invalid setting for Dsc demod."
},
"filterColumn" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Filter column setting for Dsc demod."
},
"filter" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Filter setting for Dsc demod."
},
"udpEnabled" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable udp (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"udpAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name used for UDP traffic."
},
"udpPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "UDP port number.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"logFilename" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Log file name or path."
},
"logEnabled" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable logging to the configured file (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"useFileTime" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable file time (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"streamIndex" : {
"type" : "integer",
@@ -5419,27 +6598,38 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"scopeConfig" : {
+ "description" : "Oscilloscope-display configuration.",
"$ref" : "#/definitions/GLScope"
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -5453,10 +6643,12 @@ margin-bottom: 20px;
"description" : "power transmitted in channel (dB)"
},
"audioSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Audio sample rate in samples per second."
},
"channelSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Effective sample rate delivered to the channel in samples per second."
},
"squelch" : {
"type" : "integer",
@@ -5505,66 +6697,89 @@ margin-bottom: 20px;
"properties" : {
"inputFrequencyOffset" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Channel frequency offset from the device center frequency in Hz."
},
"rfBandwidth" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "RF bandwidth in Hz."
},
"fmDeviation" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "FM frequency deviation in Hz."
},
"demodGain" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Demod gain setting for Dsd demod."
},
"volume" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Audio volume multiplier."
},
"baudRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Serial-port baud rate in bits per second."
},
"squelchGate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Squelch gate duration."
},
"squelch" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Squelch threshold in dB."
},
"audioMute" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Mute audio output (1 muted, 0 unmuted).",
+ "minimum" : 0,
+ "maximum" : 1
},
"enableCosineFiltering" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable cosine filtering (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"syncOrConstellation" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Sync or constellation setting for Dsd demod."
},
"slot1On" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Slot1 on setting for Dsd demod."
},
"slot2On" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Slot2 on setting for Dsd demod."
},
"tdmaStereo" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Tdma stereo setting for Dsd demod."
},
"pllLock" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Pll lock setting for Dsd demod."
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"audioDeviceName" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Name of the audio device to use."
},
"highPassFilter" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "High pass filter setting for Dsd demod."
},
"traceLengthMutliplier" : {
"type" : "integer",
@@ -5584,24 +6799,34 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
},
"ambeFeatureIndex" : {
@@ -5610,7 +6835,9 @@ margin-bottom: 20px;
},
"connectAMBE" : {
"type" : "integer",
- "description" : "Decode frames with AMBE feature\n * 0 - Do not decode frames with AMBE feature\n * 1 - Decode frames with AMBE feature\n"
+ "description" : "Decode frames with AMBE feature\n * 0 - Do not decode frames with AMBE feature\n * 1 - Decode frames with AMBE feature\n",
+ "minimum" : 0,
+ "maximum" : 1
}
},
"description" : "DSDDemod"
@@ -5658,13 +6885,16 @@ margin-bottom: 20px;
defs.DemodAnalyzerSettings = {
"properties" : {
"log2Decim" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent of the software decimation factor; the output sample rate is divided by 2^log2Decim."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"fileRecordName" : {
"type" : "string",
@@ -5672,7 +6902,9 @@ margin-bottom: 20px;
},
"recordToFile" : {
"type" : "integer",
- "description" : "Recording status\n * 1 - recording\n * 0 - not recording\n"
+ "description" : "Recording status\n * 1 - recording\n * 0 - not recording\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"recordSilenceTime" : {
"type" : "integer",
@@ -5680,27 +6912,38 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API\n * 1 - yes\n * 0 - no\n"
+ "description" : "Synchronize with reverse API\n * 1 - yes\n * 0 - no\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIFeatureSetIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Feature-set index used by the reverse API peer."
},
"reverseAPIFeatureIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Feature index used by the reverse API peer."
},
"spectrumConfig" : {
+ "description" : "Spectrum-display configuration.",
"$ref" : "#/definitions/GLSpectrum"
},
"scopeConfig" : {
+ "description" : "Oscilloscope-display configuration.",
"$ref" : "#/definitions/GLScope"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -5724,11 +6967,15 @@ margin-bottom: 20px;
"properties" : {
"denoiserType" : {
"type" : "integer",
- "description" : "Denoiser type\n * 0 - none\n * 1 - RNnoise\n"
+ "description" : "Denoiser type\n * 0 - none\n * 1 - RNnoise\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"enableDenoiser" : {
"type" : "integer",
- "description" : "Enable denoiser\n * 1 - enable\n * 0 - disable\n"
+ "description" : "Enable denoiser\n * 1 - enable\n * 0 - disable\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"volumeTenths" : {
"type" : "integer",
@@ -5740,13 +6987,17 @@ margin-bottom: 20px;
},
"audioMute" : {
"type" : "integer",
- "description" : "Audio mute\n * 1 - mute\n * 0 - unmute\n"
+ "description" : "Audio mute\n * 1 - mute\n * 0 - unmute\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"fileRecordName" : {
"type" : "string",
@@ -5754,25 +7005,36 @@ margin-bottom: 20px;
},
"recordToFile" : {
"type" : "integer",
- "description" : "Recording status\n * 1 - recording\n * 0 - not recording\n"
+ "description" : "Recording status\n * 1 - recording\n * 0 - not recording\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API\n * 1 - yes\n * 0 - no\n"
+ "description" : "Synchronize with reverse API\n * 1 - yes\n * 0 - no\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIFeatureSetIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Feature-set index used by the reverse API peer."
},
"reverseAPIFeatureIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Feature index used by the reverse API peer."
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -5795,6 +7057,7 @@ margin-bottom: 20px;
"description" : "Optional for reverse API. This is the device set index from where the message comes from."
},
"sigMFFileInputActions" : {
+ "description" : "Sig mf file input actions configuration for Device.",
"$ref" : "#/definitions/SigMFFileInputActions"
}
},
@@ -5803,15 +7066,19 @@ margin-bottom: 20px;
defs.DeviceConfig = {
"properties" : {
"deviceId" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Device id for Device config."
},
"deviceSerial" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Device serial for Device config."
},
"deviceSequence" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device sequence for Device config."
},
"config" : {
+ "description" : "Configuration data.",
"$ref" : "#/definitions/DeviceSettings"
}
},
@@ -5871,102 +7138,135 @@ margin-bottom: 20px;
"description" : "0 for Rx only, 1 for Tx only or 2 for any number and direction (default 0)"
},
"airspyReport" : {
+ "description" : "Airspy report data for Device.",
"$ref" : "#/definitions/AirspyReport"
},
"airspyHFReport" : {
+ "description" : "Airspy hf report data for Device.",
"$ref" : "#/definitions/AirspyHFReport"
},
"androidSDRDriverInputReport" : {
+ "description" : "Android sdr driver input report data for Device.",
"$ref" : "#/definitions/AndroidSDRDriverInputReport"
},
"bladeRF2InputReport" : {
+ "description" : "Blade rf2 input report data for Device.",
"$ref" : "#/definitions/BladeRF2InputReport"
},
"bladeRF2OutputReport" : {
+ "description" : "Blade rf2 output report data for Device.",
"$ref" : "#/definitions/BladeRF2OutputReport"
},
"bladeRF2MIMOReport" : {
+ "description" : "Blade rf2 MIMO report data for Device.",
"$ref" : "#/definitions/BladeRF2MIMOReport"
},
"fileInputReport" : {
+ "description" : "File input report data for Device.",
"$ref" : "#/definitions/FileInputReport"
},
"kiwiSDRReport" : {
+ "description" : "Kiwi sdr report data for Device.",
"$ref" : "#/definitions/KiwiSDRReport"
},
"limeSdrInputReport" : {
+ "description" : "Lime sdr input report data for Device.",
"$ref" : "#/definitions/LimeSdrInputReport"
},
"limeSdrOutputReport" : {
+ "description" : "Lime sdr output report data for Device.",
"$ref" : "#/definitions/LimeSdrOutputReport"
},
"limeSdrMIMOReport" : {
+ "description" : "Lime sdr MIMO report data for Device.",
"$ref" : "#/definitions/LimeSdrMIMOReport"
},
"localInputReport" : {
+ "description" : "Local input report data for Device.",
"$ref" : "#/definitions/LocalInputReport"
},
"localOutputReport" : {
+ "description" : "Local output report data for Device.",
"$ref" : "#/definitions/LocalOutputReport"
},
"perseusReport" : {
+ "description" : "Perseus report data for Device.",
"$ref" : "#/definitions/PerseusReport"
},
"plutoSdrInputReport" : {
+ "description" : "Pluto sdr input report data for Device.",
"$ref" : "#/definitions/PlutoSdrInputReport"
},
"plutoSdrOutputReport" : {
+ "description" : "Pluto sdr output report data for Device.",
"$ref" : "#/definitions/PlutoSdrOutputReport"
},
"plutoSdrMIMOReport" : {
+ "description" : "Pluto sdr MIMO report data for Device.",
"$ref" : "#/definitions/PlutoSdrMIMOReport"
},
"rtlSdrReport" : {
+ "description" : "Rtl sdr report data for Device.",
"$ref" : "#/definitions/RtlSdrReport"
},
"remoteOutputReport" : {
+ "description" : "Remote output report data for Device.",
"$ref" : "#/definitions/RemoteOutputReport"
},
"remoteInputReport" : {
+ "description" : "Remote input report data for Device.",
"$ref" : "#/definitions/RemoteInputReport"
},
"remoteTCPInputReport" : {
+ "description" : "Remote TCP input report data for Device.",
"$ref" : "#/definitions/RemoteTCPInputReport"
},
"sdrPlayReport" : {
+ "description" : "Sdr play report data for Device.",
"$ref" : "#/definitions/SDRPlayReport"
},
"sdrPlayV3Report" : {
+ "description" : "Sdr play v3 report data for Device.",
"$ref" : "#/definitions/SDRPlayV3Report"
},
"sigMFFileInputReport" : {
+ "description" : "Sig mf file input report data for Device.",
"$ref" : "#/definitions/SigMFFileInputReport"
},
"soapySDRInputReport" : {
+ "description" : "Soapy sdr input report data for Device.",
"$ref" : "#/definitions/SoapySDRReport"
},
"soapySDROutputReport" : {
+ "description" : "Soapy sdr output report data for Device.",
"$ref" : "#/definitions/SoapySDRReport"
},
"usrpInputReport" : {
+ "description" : "Usrp input report data for Device.",
"$ref" : "#/definitions/USRPInputReport"
},
"usrpOutputReport" : {
+ "description" : "Usrp output report data for Device.",
"$ref" : "#/definitions/USRPOutputReport"
},
"xtrxInputReport" : {
+ "description" : "Xtrx input report data for Device.",
"$ref" : "#/definitions/XtrxInputReport"
},
"xtrxOutputReport" : {
+ "description" : "Xtrx output report data for Device.",
"$ref" : "#/definitions/XtrxOutputReport"
},
"xtrxMIMOReport" : {
+ "description" : "Xtrx MIMO report data for Device.",
"$ref" : "#/definitions/XtrxMIMOReport"
},
"AaroniaRTSAReport" : {
+ "description" : "Aaronia rtsa report data for Device.",
"$ref" : "#/definitions/AaroniaRTSAReport"
},
"aaroniaRTSAOutputReport" : {
+ "description" : "Aaronia rtsa output report data for Device.",
"$ref" : "#/definitions/AaroniaRTSAOutputReport"
}
},
@@ -6029,144 +7329,191 @@ margin-bottom: 20px;
"description" : "Optional for reverse API. This is the device set index from where the message comes from."
},
"airspySettings" : {
+ "description" : "Airspy settings configuration for Device.",
"$ref" : "#/definitions/AirspySettings"
},
"airspyHFSettings" : {
+ "description" : "Airspy hf settings configuration for Device.",
"$ref" : "#/definitions/AirspyHFSettings"
},
"androidSDRDriverInputSettings" : {
+ "description" : "Android sdr driver input settings configuration for Device.",
"$ref" : "#/definitions/AndroidSDRDriverInputSettings"
},
"audioCATSISOSettings" : {
+ "description" : "Audio catsiso settings configuration for Device.",
"$ref" : "#/definitions/AudioCATSISOSettings"
},
"audioInputSettings" : {
+ "description" : "Audio input settings configuration for Device.",
"$ref" : "#/definitions/AudioInputSettings"
},
"audioOutputSettings" : {
+ "description" : "Audio output settings configuration for Device.",
"$ref" : "#/definitions/AudioOutputSettings"
},
"bladeRF1InputSettings" : {
+ "description" : "Blade rf1 input settings configuration for Device.",
"$ref" : "#/definitions/BladeRF1InputSettings"
},
"bladeRF2InputSettings" : {
+ "description" : "Blade rf2 input settings configuration for Device.",
"$ref" : "#/definitions/BladeRF2InputSettings"
},
"bladeRF1OutputSettings" : {
+ "description" : "Blade rf1 output settings configuration for Device.",
"$ref" : "#/definitions/BladeRF1OutputSettings"
},
"bladeRF2OutputSettings" : {
+ "description" : "Blade rf2 output settings configuration for Device.",
"$ref" : "#/definitions/BladeRF2OutputSettings"
},
"bladeRF2MIMOSettings" : {
+ "description" : "Blade rf2 MIMO settings configuration for Device.",
"$ref" : "#/definitions/BladeRF2MIMOSettings"
},
"fcdProSettings" : {
+ "description" : "Fcd pro settings configuration for Device.",
"$ref" : "#/definitions/FCDProSettings"
},
"fcdProPlusSettings" : {
+ "description" : "Fcd pro plus settings configuration for Device.",
"$ref" : "#/definitions/FCDProPlusSettings"
},
"fileInputSettings" : {
+ "description" : "File input settings configuration for Device.",
"$ref" : "#/definitions/FileInputSettings"
},
"fileOutputSettings" : {
+ "description" : "File output settings configuration for Device.",
"$ref" : "#/definitions/FileOutputSettings"
},
"hackRFInputSettings" : {
+ "description" : "Hack RF input settings configuration for Device.",
"$ref" : "#/definitions/HackRFInputSettings"
},
"hackRFOutputSettings" : {
+ "description" : "Hack RF output settings configuration for Device.",
"$ref" : "#/definitions/HackRFOutputSettings"
},
"kiwiSDRSettings" : {
+ "description" : "Kiwi sdr settings configuration for Device.",
"$ref" : "#/definitions/KiwiSDRSettings"
},
"limeSdrInputSettings" : {
+ "description" : "Lime sdr input settings configuration for Device.",
"$ref" : "#/definitions/LimeSdrInputSettings"
},
"limeSdrOutputSettings" : {
+ "description" : "Lime sdr output settings configuration for Device.",
"$ref" : "#/definitions/LimeSdrOutputSettings"
},
"limeSdrMIMOSettings" : {
+ "description" : "Lime sdr MIMO settings configuration for Device.",
"$ref" : "#/definitions/LimeSdrMIMOSettings"
},
"localInputSettings" : {
+ "description" : "Local input settings configuration for Device.",
"$ref" : "#/definitions/LocalInputSettings"
},
"localOutputSettings" : {
+ "description" : "Local output settings configuration for Device.",
"$ref" : "#/definitions/LocalOutputSettings"
},
"metisMISOSettings" : {
+ "description" : "Metis miso settings configuration for Device.",
"$ref" : "#/definitions/MetisMISOSettings"
},
"perseusSettings" : {
+ "description" : "Perseus settings configuration for Device.",
"$ref" : "#/definitions/PerseusSettings"
},
"plutoSdrInputSettings" : {
+ "description" : "Pluto sdr input settings configuration for Device.",
"$ref" : "#/definitions/PlutoSdrInputSettings"
},
"plutoSdrOutputSettings" : {
+ "description" : "Pluto sdr output settings configuration for Device.",
"$ref" : "#/definitions/PlutoSdrOutputSettings"
},
"plutoSdrMIMOSettings" : {
+ "description" : "Pluto sdr MIMO settings configuration for Device.",
"$ref" : "#/definitions/PlutoSdrMIMOSettings"
},
"rtlSdrSettings" : {
+ "description" : "Rtl sdr settings configuration for Device.",
"$ref" : "#/definitions/RtlSdrSettings"
},
"remoteOutputSettings" : {
+ "description" : "Remote output settings configuration for Device.",
"$ref" : "#/definitions/RemoteOutputSettings"
},
"remoteInputSettings" : {
+ "description" : "Remote input settings configuration for Device.",
"$ref" : "#/definitions/RemoteInputSettings"
},
"remoteTCPInputSettings" : {
+ "description" : "Remote TCP input settings configuration for Device.",
"$ref" : "#/definitions/RemoteTCPInputSettings"
},
"sdrPlaySettings" : {
+ "description" : "Sdr play settings configuration for Device.",
"$ref" : "#/definitions/SDRPlaySettings"
},
"sdrPlayV3Settings" : {
+ "description" : "Sdr play v3 settings configuration for Device.",
"$ref" : "#/definitions/SDRPlayV3Settings"
},
"sigMFFileInputSettings" : {
+ "description" : "Sig mf file input settings configuration for Device.",
"$ref" : "#/definitions/SigMFFileInputSettings"
},
"soapySDRInputSettings" : {
+ "description" : "Soapy sdr input settings configuration for Device.",
"$ref" : "#/definitions/SoapySDRInputSettings"
},
"soapySDROutputSettings" : {
+ "description" : "Soapy sdr output settings configuration for Device.",
"$ref" : "#/definitions/SoapySDROutputSettings"
},
"testMISettings" : {
+ "description" : "Test mi settings configuration for Device.",
"$ref" : "#/definitions/TestMISettings"
},
"testMOSyncSettings" : {
+ "description" : "Test mo sync settings configuration for Device.",
"$ref" : "#/definitions/TestMOSyncSettings"
},
"testSourceSettings" : {
+ "description" : "Test source settings configuration for Device.",
"$ref" : "#/definitions/TestSourceSettings"
},
"usrpInputSettings" : {
+ "description" : "Usrp input settings configuration for Device.",
"$ref" : "#/definitions/USRPInputSettings"
},
"usrpOutputSettings" : {
+ "description" : "Usrp output settings configuration for Device.",
"$ref" : "#/definitions/USRPOutputSettings"
},
"xtrxInputSettings" : {
+ "description" : "Xtrx input settings configuration for Device.",
"$ref" : "#/definitions/XtrxInputSettings"
},
"xtrxOutputSettings" : {
+ "description" : "Xtrx output settings configuration for Device.",
"$ref" : "#/definitions/XtrxOutputSettings"
},
"xtrxMIMOSettings" : {
+ "description" : "Xtrx MIMO settings configuration for Device.",
"$ref" : "#/definitions/XtrxMIMOSettings"
},
"aaroniaRTSASettings" : {
+ "description" : "Aaronia rtsa settings configuration for Device.",
"$ref" : "#/definitions/AaroniaRTSASettings"
},
"aaroniaRTSAOutputSettings" : {
+ "description" : "Aaronia rtsa output settings configuration for Device.",
"$ref" : "#/definitions/AaroniaRTSAOutputSettings"
}
},
@@ -6189,7 +7536,8 @@ margin-bottom: 20px;
"description" : "power received in channel (dB)"
},
"channelSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Effective sample rate delivered to the channel in samples per second."
}
},
"description" : "EndOfTrainDemod"
@@ -6198,19 +7546,24 @@ margin-bottom: 20px;
"properties" : {
"inputFrequencyOffset" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Channel frequency offset from the device center frequency in Hz."
},
"rfBandwidth" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "RF bandwidth in Hz."
},
"fmDeviation" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "FM frequency deviation in Hz."
},
"udpEnabled" : {
"type" : "integer",
- "description" : "Whether to forward received packets to specified UDP port"
+ "description" : "Whether to forward received packets to specified UDP port",
+ "minimum" : 0,
+ "maximum" : 1
},
"udpAddress" : {
"type" : "string",
@@ -6218,22 +7571,33 @@ margin-bottom: 20px;
},
"udpPort" : {
"type" : "integer",
- "description" : "UDP port to forward received packets to"
+ "description" : "UDP port to forward received packets to",
+ "minimum" : 1,
+ "maximum" : 65535
},
"logFilename" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Log file name or path."
},
"logEnabled" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable logging to the configured file (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"useFileTime" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable file time (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"streamIndex" : {
"type" : "integer",
@@ -6241,24 +7605,34 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -6276,17 +7650,21 @@ margin-bottom: 20px;
defs.FCDProPlusSettings = {
"properties" : {
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"centerFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Device center frequency in Hz."
},
"log2Decim" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent of the software decimation factor; the output sample rate is divided by 2^log2Decim."
},
"fcPos" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Position of the decimated passband relative to the device center frequency."
},
"rangeLow" : {
"type" : "integer",
@@ -6302,49 +7680,74 @@ margin-bottom: 20px;
},
"biasT" : {
"type" : "integer",
- "description" : "Bias tee select (1 if selected else 0)"
+ "description" : "Bias tee select (1 if selected else 0)",
+ "minimum" : 0,
+ "maximum" : 1
},
"ifGain" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Intermediate-frequency gain setting."
},
"ifFilterIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Selected if filter index."
},
"rfFilterIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Selected rf filter index."
},
"LOppmTenths" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Local-oscillator correction in tenths of a part per million."
},
"dcBlock" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable DSP DC-offset correction (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"iqImbalance" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable DSP I/Q imbalance correction (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"transverterMode" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable transverter frequency translation (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"transverterDeltaFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Frequency translation applied in transverter mode in Hz."
},
"iqOrder" : {
"type" : "integer",
- "description" : "IQ samples order\n * 0 - Q then I (swapped)\n * 1 - I then Q (straight)\n"
+ "description" : "IQ samples order\n * 0 - Q then I (swapped)\n * 1 - I then Q (straight)\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
}
},
"description" : "FCDProPlus"
@@ -6352,98 +7755,138 @@ margin-bottom: 20px;
defs.FCDProSettings = {
"properties" : {
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"centerFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Device center frequency in Hz."
},
"LOppmTenths" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Local-oscillator correction in tenths of a part per million."
},
"lnaGainIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Selected lna gain index."
},
"rfFilterIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Selected rf filter index."
},
"lnaEnhanceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Selected lna enhance index."
},
"bandIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Selected band index."
},
"mixerGainIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Selected mixer gain index."
},
"mixerFilterIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Selected mixer filter index."
},
"biasCurrentIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Selected bias current index."
},
"modeIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Selected mode index."
},
"gain1Index" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Selected gain1 index."
},
"rcFilterIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Selected rc filter index."
},
"gain2Index" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Selected gain2 index."
},
"gain3Index" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Selected gain3 index."
},
"gain4Index" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Selected gain4 index."
},
"ifFilterIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Selected if filter index."
},
"gain5Index" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Selected gain5 index."
},
"gain6Index" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Selected gain6 index."
},
"log2Decim" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent of the software decimation factor; the output sample rate is divided by 2^log2Decim."
},
"fcPos" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Position of the decimated passband relative to the device center frequency."
},
"dcBlock" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable DSP DC-offset correction (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"iqCorrection" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable I/Q imbalance correction (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"transverterMode" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable transverter frequency translation (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"transverterDeltaFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Frequency translation applied in transverter mode in Hz."
},
"iqOrder" : {
"type" : "integer",
- "description" : "IQ samples order\n * 0 - Q then I (swapped)\n * 1 - I then Q (straight)\n"
+ "description" : "IQ samples order\n * 0 - Q then I (swapped)\n * 1 - I then Q (straight)\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
}
},
"description" : "FCDPro"
@@ -6475,7 +7918,8 @@ margin-bottom: 20px;
"description" : "Audio squelch status (1 if open else 0)"
},
"channelSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Effective sample rate delivered to the channel in samples per second."
}
},
"description" : "FT8Demod"
@@ -6484,41 +7928,55 @@ margin-bottom: 20px;
"properties" : {
"inputFrequencyOffset" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Channel frequency offset from the device center frequency in Hz."
},
"filterIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Selected filter index."
},
"spanLog2" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent controlling the displayed or processed frequency span."
},
"rfBandwidth" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "RF bandwidth in Hz."
},
"lowCutoff" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Lower filter cutoff frequency in Hz."
},
"fftWindow" : {
"type" : "integer",
- "description" : "FFT Window index (FFTWindow::Function):\n * 0 - Bartlett\n * 1 - Blackman-Harris 4 term\n * 2 - Flattop\n * 3 - Hamming\n * 4 - Hanning\n * 5 - Rectangle\n * 6 - Kaiser\n * 7 - Blackman 3 term\n * 8 - Blackman-Harris 7 term\n"
+ "description" : "FFT Window index (FFTWindow::Function):\n * 0 - Bartlett\n * 1 - Blackman-Harris 4 term\n * 2 - Flattop\n * 3 - Hamming\n * 4 - Hanning\n * 5 - Rectangle\n * 6 - Kaiser\n * 7 - Blackman 3 term\n * 8 - Blackman-Harris 7 term\n",
+ "minimum" : 0,
+ "maximum" : 8
},
"volume" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Audio volume multiplier."
},
"agc" : {
"type" : "integer",
- "description" : "AGC (1 if AGC active else 0)"
+ "description" : "AGC (1 if AGC active else 0)",
+ "minimum" : 0,
+ "maximum" : 1
},
"recordWav" : {
"type" : "integer",
- "description" : "Record received audio as 12000S/s 16 bit .wav file\n * 0 - Do not record\n * 1 - Record as sdrangel/ft8/save/YYYYMMDD_HHMMSS.wav in writable location\n"
+ "description" : "Record received audio as 12000S/s 16 bit .wav file\n * 0 - Do not record\n * 1 - Record as sdrangel/ft8/save/YYYYMMDD_HHMMSS.wav in writable location\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"logMessages" : {
"type" : "integer",
- "description" : "Log decoded messages in WSJT CALL.TXT format\n * 0 - Do not log messages\n * 1 - Log messages as sdrangel/ft8/logs/YYYYMMDD_call.txt in writable location (daily files)\n"
+ "description" : "Log decoded messages in WSJT CALL.TXT format\n * 0 - Do not log messages\n * 1 - Log messages as sdrangel/ft8/logs/YYYYMMDD_call.txt in writable location (daily files)\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"nbDecoderThreads" : {
"type" : "integer",
@@ -6531,7 +7989,9 @@ margin-bottom: 20px;
},
"useOSD" : {
"type" : "integer",
- "description" : "Use Ordered Statistics Decoding (OSD) to decode messages if some LDPC bits are invalid\n * 0 - Disable\n * 1 - Enable\n"
+ "description" : "Use Ordered Statistics Decoding (OSD) to decode messages if some LDPC bits are invalid\n * 0 - Disable\n * 1 - Enable\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"osdDepth" : {
"type" : "integer",
@@ -6543,26 +8003,35 @@ margin-bottom: 20px;
},
"verifyOSD" : {
"type" : "integer",
- "description" : "Verify OSD decoded message against a list of validated callsigns\n * 0 - Disable\n * 1 - Enable\n"
+ "description" : "Verify OSD decoded message against a list of validated callsigns\n * 0 - Disable\n * 1 - Enable\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"enablePSKReporter" : {
"type" : "integer",
- "description" : "Enable reporting of decoded messages to PSK Reporter server\n * 0 - Disable\n * 1 - Enable\n"
+ "description" : "Enable reporting of decoded messages to PSK Reporter server\n * 0 - Disable\n * 1 - Enable\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"pskReporterCallsign" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Psk reporter callsign setting for Ft8 demod."
},
"pskReporterLocator" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Psk reporter locator setting for Ft8 demod."
},
"pskReporterSoftware" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Psk reporter software setting for Ft8 demod."
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"streamIndex" : {
"type" : "integer",
@@ -6570,27 +8039,38 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"spectrumConfig" : {
+ "description" : "Spectrum-display configuration.",
"$ref" : "#/definitions/GLSpectrum"
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -6636,48 +8116,67 @@ margin-bottom: 20px;
"description" : "Optional for reverse API. This is the feature index from where the message comes from."
},
"AFCActions" : {
+ "description" : "Afc actions configuration for Feature.",
"$ref" : "#/definitions/AFCActions"
},
"AMBEActions" : {
+ "description" : "Ambe actions configuration for Feature.",
"$ref" : "#/definitions/AMBEActions"
},
"GS232ControllerActions" : {
+ "description" : "Gs232 controller actions configuration for Feature.",
"$ref" : "#/definitions/GS232ControllerActions"
},
"LimeRFEActions" : {
+ "description" : "Lime rfe actions configuration for Feature.",
"$ref" : "#/definitions/LimeRFEActions"
},
"MapActions" : {
+ "description" : "Map actions configuration for Feature.",
"$ref" : "#/definitions/MapActions"
},
"MorseDecoderActions" : {
+ "description" : "Morse decoder actions configuration for Feature.",
"$ref" : "#/definitions/MorseDecoderActions"
},
"PERTesterActions" : {
+ "description" : "Per tester actions configuration for Feature.",
"$ref" : "#/definitions/PERTesterActions"
},
"RigCtlServerActions" : {
+ "description" : "Rig ctl server actions configuration for Feature.",
"$ref" : "#/definitions/RigCtlServerActions"
},
+ "MCPServerActions" : {
+ "description" : "Mcp server actions configuration for Feature.",
+ "$ref" : "#/definitions/MCPServerActions"
+ },
"SatelliteTrackerActions" : {
+ "description" : "Satellite tracker actions configuration for Feature.",
"$ref" : "#/definitions/SatelliteTrackerActions"
},
"SimplePTTActions" : {
+ "description" : "Simple ptt actions configuration for Feature.",
"$ref" : "#/definitions/SimplePTTActions"
},
"SkyMapActions" : {
+ "description" : "Sky map actions configuration for Feature.",
"$ref" : "#/definitions/SkyMapActions"
},
"StarTrackerActions" : {
+ "description" : "Star tracker actions configuration for Feature.",
"$ref" : "#/definitions/StarTrackerActions"
},
"VORLocalizerActions" : {
+ "description" : "Vor localizer actions configuration for Feature.",
"$ref" : "#/definitions/VORLocalizerActions"
},
"DemodAnalyzerActions" : {
+ "description" : "Demod analyzer actions configuration for Feature.",
"$ref" : "#/definitions/DemodAnalyzerActions"
},
"DenoiserActions" : {
+ "description" : "Denoiser actions configuration for Feature.",
"$ref" : "#/definitions/DenoiserActions"
}
},
@@ -6690,6 +8189,7 @@ margin-bottom: 20px;
"description" : "Feature type ID in URI form"
},
"config" : {
+ "description" : "Configuration data.",
"$ref" : "#/definitions/FeatureSettings"
}
},
@@ -6790,42 +8290,59 @@ margin-bottom: 20px;
"description" : "Feature type code"
},
"AFCReport" : {
+ "description" : "Afc report data for Feature.",
"$ref" : "#/definitions/AFCReport"
},
"AMBEReport" : {
+ "description" : "Ambe report data for Feature.",
"$ref" : "#/definitions/AMBEReport"
},
"FreqDisplayReport" : {
+ "description" : "Freq display report data for Feature.",
"$ref" : "#/definitions/FreqDisplayReport"
},
"GS232ControllerReport" : {
+ "description" : "Gs232 controller report data for Feature.",
"$ref" : "#/definitions/GS232ControllerReport"
},
"LimeRFEReport" : {
+ "description" : "Lime rfe report data for Feature.",
"$ref" : "#/definitions/LimeRFEReport"
},
"MapReport" : {
+ "description" : "Map report data for Feature.",
"$ref" : "#/definitions/MapReport"
},
"PERTesterReport" : {
+ "description" : "Per tester report data for Feature.",
"$ref" : "#/definitions/PERTesterReport"
},
"RigCtlServerReport" : {
+ "description" : "Rig ctl server report data for Feature.",
"$ref" : "#/definitions/RigCtlServerReport"
},
+ "MCPServerReport" : {
+ "description" : "Mcp server report data for Feature.",
+ "$ref" : "#/definitions/MCPServerReport"
+ },
"SatelliteTrackerReport" : {
+ "description" : "Satellite tracker report data for Feature.",
"$ref" : "#/definitions/SatelliteTrackerReport"
},
"SimplePTTReport" : {
+ "description" : "Simple ptt report data for Feature.",
"$ref" : "#/definitions/SimplePTTReport"
},
"SkyMapReport" : {
+ "description" : "Sky map report data for Feature.",
"$ref" : "#/definitions/SkyMapReport"
},
"StarTrackerReport" : {
+ "description" : "Star tracker report data for Feature.",
"$ref" : "#/definitions/StarTrackerReport"
},
"VORLocalizerReport" : {
+ "description" : "Vor localizer report data for Feature.",
"$ref" : "#/definitions/VORLocalizerReport"
}
},
@@ -6851,13 +8368,16 @@ margin-bottom: 20px;
defs.FeatureSetPreset = {
"properties" : {
"group" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Group for Feature set preset."
},
"description" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Human-readable description."
},
"featureConfigs" : {
"type" : "array",
+ "description" : "List of feature configs.",
"items" : {
"$ref" : "#/definitions/FeatureConfig"
}
@@ -6882,69 +8402,95 @@ margin-bottom: 20px;
"description" : "Optional for reverse API. This is the feature index from where the message comes from."
},
"AFCSettings" : {
+ "description" : "Afc settings configuration for Feature.",
"$ref" : "#/definitions/AFCSettings"
},
"AISSettings" : {
+ "description" : "AIS settings configuration for Feature.",
"$ref" : "#/definitions/AISSettings"
},
"AMBESettings" : {
+ "description" : "Ambe settings configuration for Feature.",
"$ref" : "#/definitions/AMBESettings"
},
"AntennaToolsSettings" : {
+ "description" : "Antenna tools settings configuration for Feature.",
"$ref" : "#/definitions/AntennaToolsSettings"
},
"APRSSettings" : {
+ "description" : "Aprs settings configuration for Feature.",
"$ref" : "#/definitions/APRSSettings"
},
"DemodAnalyzerSettings" : {
+ "description" : "Demod analyzer settings configuration for Feature.",
"$ref" : "#/definitions/DemodAnalyzerSettings"
},
"DenoiserSettings" : {
+ "description" : "Denoiser settings configuration for Feature.",
"$ref" : "#/definitions/DenoiserSettings"
},
"JogdialControllerSettings" : {
+ "description" : "Jogdial controller settings configuration for Feature.",
"$ref" : "#/definitions/JogdialControllerSettings"
},
"FreqDisplaySettings" : {
+ "description" : "Freq display settings configuration for Feature.",
"$ref" : "#/definitions/FreqDisplaySettings"
},
"GS232ControllerSettings" : {
+ "description" : "Gs232 controller settings configuration for Feature.",
"$ref" : "#/definitions/GS232ControllerSettings"
},
"LimeRFESettings" : {
+ "description" : "Lime rfe settings configuration for Feature.",
"$ref" : "#/definitions/LimeRFESettings"
},
"MapSettings" : {
+ "description" : "Map settings configuration for Feature.",
"$ref" : "#/definitions/MapSettings"
},
"MorseDecoderSettings" : {
+ "description" : "Morse decoder settings configuration for Feature.",
"$ref" : "#/definitions/MorseDecoderSettings"
},
"PERTesterSettings" : {
+ "description" : "Per tester settings configuration for Feature.",
"$ref" : "#/definitions/PERTesterSettings"
},
"RadiosondeSettings" : {
+ "description" : "Radiosonde settings configuration for Feature.",
"$ref" : "#/definitions/RadiosondeSettings"
},
"RigCtlServerSettings" : {
+ "description" : "Rig ctl server settings configuration for Feature.",
"$ref" : "#/definitions/RigCtlServerSettings"
},
+ "MCPServerSettings" : {
+ "description" : "Mcp server settings configuration for Feature.",
+ "$ref" : "#/definitions/MCPServerSettings"
+ },
"SatelliteTrackerSettings" : {
+ "description" : "Satellite tracker settings configuration for Feature.",
"$ref" : "#/definitions/SatelliteTrackerSettings"
},
"SIDSettings" : {
+ "description" : "Sid settings configuration for Feature.",
"$ref" : "#/definitions/SIDSettings"
},
"SimplePTTSettings" : {
+ "description" : "Simple ptt settings configuration for Feature.",
"$ref" : "#/definitions/SimplePTTSettings"
},
"SkyMapSettings" : {
+ "description" : "Sky map settings configuration for Feature.",
"$ref" : "#/definitions/SkyMapSettings"
},
"StarTrackerSettings" : {
+ "description" : "Star tracker settings configuration for Feature.",
"$ref" : "#/definitions/StarTrackerSettings"
},
"VORLocalizerSettings" : {
+ "description" : "Vor localizer settings configuration for Feature.",
"$ref" : "#/definitions/VORLocalizerSettings"
}
},
@@ -6953,7 +8499,8 @@ margin-bottom: 20px;
defs.FileInputReport = {
"properties" : {
"fileName" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "File name or path."
},
"sampleRate" : {
"type" : "integer",
@@ -6981,7 +8528,8 @@ margin-bottom: 20px;
defs.FileInputSettings = {
"properties" : {
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"fileName" : {
"type" : "string",
@@ -6997,16 +8545,23 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
}
},
"description" : "FileInput"
@@ -7014,7 +8569,8 @@ margin-bottom: 20px;
defs.FileOutputSettings = {
"properties" : {
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"fileName" : {
"type" : "string",
@@ -7022,27 +8578,37 @@ margin-bottom: 20px;
},
"centerFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Device center frequency in Hz."
},
"sampleRate" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Sample rate in samples per second."
},
"log2Interp" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent of the software interpolation factor; the output sample rate is multiplied by 2^log2Interp."
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
}
},
"description" : "FileInput"
@@ -7061,7 +8627,9 @@ margin-bottom: 20px;
"properties" : {
"record" : {
"type" : "integer",
- "description" : "Record action\n * 0 - stop recording\n * 1 - start recording\n"
+ "description" : "Record action\n * 0 - stop recording\n * 1 - start recording\n",
+ "minimum" : 0,
+ "maximum" : 1
}
},
"description" : "FileSink"
@@ -7070,7 +8638,9 @@ margin-bottom: 20px;
"properties" : {
"spectrumSquelch" : {
"type" : "integer",
- "description" : "Spectrum squelch status * 0 - closed * 1 - open\n"
+ "description" : "Spectrum squelch status * 0 - closed * 1 - open\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"spectrumMax" : {
"type" : "number",
@@ -7078,14 +8648,18 @@ margin-bottom: 20px;
"description" : "Current spectrum max in squared magnitude (power)"
},
"sinkSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Sample rate accepted by the sink in samples per second."
},
"channelSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Effective sample rate delivered to the channel in samples per second."
},
"recording" : {
"type" : "integer",
- "description" : "Recording status * 0 - not recording * 1 - recording\n"
+ "description" : "Recording status * 0 - not recording * 1 - recording\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"recordTimeMs" : {
"type" : "integer",
@@ -7106,24 +8680,30 @@ margin-bottom: 20px;
defs.FileSinkSettings = {
"properties" : {
"inputFrequencyOffset" : {
- "type" : "integer"
+ "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"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"log2Decim" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent of the software decimation factor; the output sample rate is divided by 2^log2Decim."
},
"spectrumSquelchMode" : {
"type" : "integer",
- "description" : "Spectrum squelch system * 0 - deactivated * 1 - activated\n"
+ "description" : "Spectrum squelch system * 0 - deactivated * 1 - activated\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"spectrumSquelch" : {
"type" : "number",
@@ -7140,7 +8720,9 @@ margin-bottom: 20px;
},
"squelchRecordingEnable" : {
"type" : "integer",
- "description" : "Automatic recording triggered by spectrum squelch * 0 - disabled * 1 - enabled\n"
+ "description" : "Automatic recording triggered by spectrum squelch * 0 - disabled * 1 - enabled\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"streamIndex" : {
"type" : "integer",
@@ -7148,27 +8730,38 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"spectrumConfig" : {
+ "description" : "Spectrum-display configuration.",
"$ref" : "#/definitions/GLSpectrum"
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -7178,7 +8771,9 @@ margin-bottom: 20px;
"properties" : {
"play" : {
"type" : "integer",
- "description" : "Play or Pause stream\n * 0 - Pause\n * 1 - Play\n"
+ "description" : "Play or Pause stream\n * 0 - Pause\n * 1 - Play\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"seekMillis" : {
"type" : "integer",
@@ -7190,7 +8785,8 @@ margin-bottom: 20px;
defs.FileSourceReport = {
"properties" : {
"fileName" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "File name or path."
},
"fileSampleRate" : {
"type" : "integer",
@@ -7235,19 +8831,24 @@ margin-bottom: 20px;
"description" : "1 if playing in a loop else 0"
},
"log2Interp" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent of the software interpolation factor; the output sample rate is multiplied by 2^log2Interp."
},
"filterChainHash" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Identifier of the selected half-band filter chain."
},
"gainDB" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Gain dB in dB."
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"streamIndex" : {
"type" : "integer",
@@ -7255,24 +8856,34 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -7290,10 +8901,12 @@ margin-bottom: 20px;
"description" : "Audio squelch status (1 if open else 0)"
},
"audioSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Audio sample rate in samples per second."
},
"channelSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Effective sample rate delivered to the channel in samples per second."
}
},
"description" : "FreeDVDemod"
@@ -7302,7 +8915,8 @@ margin-bottom: 20px;
"properties" : {
"inputFrequencyOffset" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Channel frequency offset from the device center frequency in Hz."
},
"volume" : {
"type" : "number",
@@ -7315,27 +8929,36 @@ margin-bottom: 20px;
"description" : "Modem input volume"
},
"spanLog2" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent controlling the displayed or processed frequency span."
},
"audioMute" : {
"type" : "integer",
- "description" : "Mute audio (1 if muted else 0)"
+ "description" : "Mute audio (1 if muted else 0)",
+ "minimum" : 0,
+ "maximum" : 1
},
"agc" : {
"type" : "integer",
- "description" : "AGC (1 if AGC active else 0)"
+ "description" : "AGC (1 if AGC active else 0)",
+ "minimum" : 0,
+ "maximum" : 1
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"audioDeviceName" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Name of the audio device to use."
},
"freeDVMode" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Free dv mode setting for Free dv demod."
},
"streamIndex" : {
"type" : "integer",
@@ -7343,27 +8966,38 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"spectrumConfig" : {
+ "description" : "Spectrum-display configuration.",
"$ref" : "#/definitions/GLSpectrum"
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -7377,10 +9011,12 @@ margin-bottom: 20px;
"description" : "power transmitted in channel (dB)"
},
"audioSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Audio sample rate in samples per second."
},
"channelSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Effective sample rate delivered to the channel in samples per second."
}
},
"description" : "FreeDVMod"
@@ -7389,42 +9025,58 @@ margin-bottom: 20px;
"properties" : {
"inputFrequencyOffset" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Channel frequency offset from the device center frequency in Hz."
},
"toneFrequency" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Tone frequency in Hz."
},
"volumeFactor" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Volume factor setting for Free dv mod."
},
"spanLog2" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent controlling the displayed or processed frequency span."
},
"audioMute" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Mute audio output (1 muted, 0 unmuted).",
+ "minimum" : 0,
+ "maximum" : 1
},
"playLoop" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Loop playback at end of file (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"audioDeviceName" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Name of the audio device to use."
},
"freeDVMode" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Free dv mode setting for Free dv mod."
},
"modAFInput" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Audio-frequency modulation input selection."
},
"gaugeInputElseModem" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Gauge input else modem setting for Free dv mod."
},
"streamIndex" : {
"type" : "integer",
@@ -7432,30 +9084,42 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"cwKeyer" : {
+ "description" : "CW keyer configuration.",
"$ref" : "#/definitions/CWKeyerSettings"
},
"spectrumConfig" : {
+ "description" : "Spectrum-display configuration.",
"$ref" : "#/definitions/GLSpectrum"
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -7483,63 +9147,87 @@ margin-bottom: 20px;
"description" : "Channel to display frequency/power for"
},
"fontName" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Font name setting for Freq display."
},
"transparentBackground" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Transparent background setting for Freq display."
},
"displayMode" : {
"type" : "integer",
"description" : "(0 Frequency, 1 Power, 2 Frequency and Power)"
},
"speechEnabled" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable speech (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"frequencyUnits" : {
"type" : "integer",
"description" : "(0 Hz, 1 kHz, 2 MHz, 3 GHz)"
},
"showUnits" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Show units setting for Freq display."
},
"freqDecimalPlaces" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Freq decimal places setting for Freq display."
},
"powerDecimalPlaces" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Power decimal places setting for Freq display."
},
"textcolor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Textcolor setting for Freq display."
},
"dropShadowEnabled" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable drop shadow (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"dropShadowColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Drop shadow color encoded as an integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIFeatureSetIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Feature-set index used by the reverse API peer."
},
"reverseAPIFeatureIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Feature index used by the reverse API peer."
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -7549,7 +9237,9 @@ margin-bottom: 20px;
"properties" : {
"run" : {
"type" : "integer",
- "description" : "Set the plugin running state\n * 0 - idle\n * 1 - run\n"
+ "description" : "Set the plugin running state\n * 0 - idle\n * 1 - run\n",
+ "minimum" : 0,
+ "maximum" : 1
}
},
"description" : "Frequency Scanner actions"
@@ -7571,32 +9261,40 @@ margin-bottom: 20px;
"properties" : {
"frequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Frequency in Hz."
},
"enabled" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enabled for Freq scanner frequency."
},
"notes" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Notes for Freq scanner frequency."
},
"channel" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Channel identifier or configuration."
},
"channelBandwidth" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Channel bandwidth in Hz."
},
"threshold" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Threshold for Freq scanner frequency."
},
"squelch" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Squelch threshold in dB."
}
}
};
defs.FreqScannerReport = {
"properties" : {
"channelSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Effective sample rate delivered to the channel in samples per second."
},
"scanState" : {
"type" : "integer",
@@ -7604,6 +9302,7 @@ margin-bottom: 20px;
},
"channelState" : {
"type" : "array",
+ "description" : "List of channel state.",
"items" : {
"$ref" : "#/definitions/FreqScannerChannelState"
}
@@ -7627,43 +9326,54 @@ margin-bottom: 20px;
},
"threshold" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Threshold setting for Freq scanner."
},
"frequencies" : {
"type" : "array",
+ "description" : "List of frequencies.",
"items" : {
"$ref" : "#/definitions/FreqScannerFrequency"
}
},
"channel" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Channel identifier or configuration."
},
"scanTime" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Scan time setting for Freq scanner."
},
"retransmitTime" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Retransmit time setting for Freq scanner."
},
"tuneTime" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Tune time setting for Freq scanner."
},
"priority" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Priority setting for Freq scanner."
},
"measurement" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Measurement setting for Freq scanner."
},
"mode" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Mode setting for Freq scanner."
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"streamIndex" : {
"type" : "integer",
@@ -7671,24 +9381,34 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -7710,10 +9430,12 @@ margin-bottom: 20px;
"description" : "squelch status (1 if open else 0)"
},
"sampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Sample rate in samples per second."
},
"channelSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Effective sample rate delivered to the channel in samples per second."
}
},
"description" : "FreqTracker"
@@ -7731,7 +9453,8 @@ margin-bottom: 20px;
"description" : "channel RF bandwidth in Hz (floors to next 100 Hz)"
},
"log2Decim" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent of the software decimation factor; the output sample rate is divided by 2^log2Decim."
},
"squelch" : {
"type" : "number",
@@ -7739,13 +9462,16 @@ margin-bottom: 20px;
"description" : "power squelch threshold in decibels"
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"spanLog2" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent controlling the displayed or processed frequency span."
},
"alphaEMA" : {
"type" : "number",
@@ -7782,27 +9508,38 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"spectrumConfig" : {
+ "description" : "Spectrum-display configuration.",
"$ref" : "#/definitions/GLSpectrum"
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -7811,7 +9548,8 @@ margin-bottom: 20px;
defs.Frequency = {
"properties" : {
"frequency" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Frequency in Hz."
}
},
"description" : "A frequency expressed in Hertz (Hz)"
@@ -7819,13 +9557,16 @@ margin-bottom: 20px;
defs.FrequencyBand = {
"properties" : {
"name" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Name."
},
"lowerBound" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Inclusive lower bound of the range."
},
"higherBound" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Inclusive upper bound of the range."
}
},
"description" : "A band of frequencies given its boundaries in Hertz (Hz)"
@@ -7834,18 +9575,22 @@ margin-bottom: 20px;
"properties" : {
"min" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Minimum value of the range."
},
"max" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Maximum value of the range."
},
"step" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Increment between adjacent supported values."
},
"scale" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Scale factor applied to the value."
}
},
"description" : "A frequency range with 64 bit support for min and max"
@@ -7857,32 +9602,39 @@ margin-bottom: 20px;
"description" : "see GLScopeSettings::DisplayMode"
},
"traceIntensity" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Trace intensity for Gl scope."
},
"gridIntensity" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Grid intensity for Gl scope."
},
"time" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Time for Gl scope."
},
"timeOfs" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Time ofs for Gl scope."
},
"traceLenMult" : {
"type" : "integer",
"description" : "Trace length multiplier (multiplies 4800 samples)"
},
"trigPre" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Trig pre for Gl scope."
},
"tracesData" : {
"type" : "array",
+ "description" : "List of traces data.",
"items" : {
"$ref" : "#/definitions/TraceData"
}
},
"triggersData" : {
"type" : "array",
+ "description" : "List of triggers data.",
"items" : {
"$ref" : "#/definitions/TriggerData"
}
@@ -7893,22 +9645,28 @@ margin-bottom: 20px;
defs.GLSpectrum = {
"properties" : {
"fftSize" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "FFT size in samples."
},
"fftOverlap" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "FFT overlap for Gl spectrum."
},
"fftWindow" : {
"type" : "integer",
- "description" : "FFT Window index (FFTWindow::Function):\n * 0 - Bartlett\n * 1 - Blackman-Harris 4 term\n * 2 - Flattop\n * 3 - Hamming\n * 4 - Hanning\n * 5 - Rectangle\n * 6 - Kaiser\n * 7 - Blackman 3 term\n * 8 - Blackman-Harris 7 term\n"
+ "description" : "FFT Window index (FFTWindow::Function):\n * 0 - Bartlett\n * 1 - Blackman-Harris 4 term\n * 2 - Flattop\n * 3 - Hamming\n * 4 - Hanning\n * 5 - Rectangle\n * 6 - Kaiser\n * 7 - Blackman 3 term\n * 8 - Blackman-Harris 7 term\n",
+ "minimum" : 0,
+ "maximum" : 8
},
"refLevel" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Ref level for Gl spectrum."
},
"powerRange" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Power range for Gl spectrum."
},
"fpsPeriodMs" : {
"type" : "integer",
@@ -7916,69 +9674,96 @@ margin-bottom: 20px;
},
"displayWaterfall" : {
"type" : "integer",
- "description" : "boolean"
+ "description" : "boolean",
+ "minimum" : 0,
+ "maximum" : 1
},
"invertedWaterfall" : {
"type" : "integer",
- "description" : "boolean"
+ "description" : "boolean",
+ "minimum" : 0,
+ "maximum" : 1
},
"displayMaxHold" : {
"type" : "integer",
- "description" : "boolean"
+ "description" : "boolean",
+ "minimum" : 0,
+ "maximum" : 1
},
"displayHistogram" : {
"type" : "integer",
- "description" : "boolean"
+ "description" : "boolean",
+ "minimum" : 0,
+ "maximum" : 1
},
"decay" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Decay for Gl spectrum."
},
"displayGrid" : {
"type" : "integer",
- "description" : "boolean"
+ "description" : "boolean",
+ "minimum" : 0,
+ "maximum" : 1
},
"displayGridIntensity" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display grid intensity for Gl spectrum."
},
"decayDivisor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Decay divisor for Gl spectrum."
},
"histogramStroke" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Histogram stroke for Gl spectrum."
},
"displayCurrent" : {
"type" : "integer",
- "description" : "boolean"
+ "description" : "boolean",
+ "minimum" : 0,
+ "maximum" : 1
},
"displayTraceIntensity" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display trace intensity for Gl spectrum."
},
"waterfallShare" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Waterfall share for Gl spectrum."
},
"averagingMode" : {
"type" : "integer",
"description" : "See GLSpectrumGUI::AveragingMode"
},
"averagingValue" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Averaging value for Gl spectrum."
},
"linear" : {
"type" : "integer",
- "description" : "boolean"
+ "description" : "boolean",
+ "minimum" : 0,
+ "maximum" : 1
},
"ssb" : {
"type" : "integer",
- "description" : "boolean"
+ "description" : "boolean",
+ "minimum" : 0,
+ "maximum" : 1
},
"usb" : {
"type" : "integer",
- "description" : "boolean"
+ "description" : "boolean",
+ "minimum" : 0,
+ "maximum" : 1
},
"wsSpectrum" : {
"type" : "integer",
- "description" : "Boolean - Start or stop websocket server\n * 0 - Stop server\n * 1 - Start server\n"
+ "description" : "Boolean - Start or stop websocket server\n * 0 - Stop server\n * 1 - Start server\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"wsSpectrumAddress" : {
"type" : "string",
@@ -7990,36 +9775,46 @@ margin-bottom: 20px;
},
"markersDisplay" : {
"type" : "integer",
- "description" : "Display markers (SpectrumSettings::MarkersDisplay)\n * 0 - Mome\n * 1 - Spectrum markers (histogram and waterfall)\n * 2 - Spectrum annotation markers\n"
+ "description" : "Display markers (SpectrumSettings::MarkersDisplay)\n * 0 - Mome\n * 1 - Spectrum markers (histogram and waterfall)\n * 2 - Spectrum annotation markers\n",
+ "minimum" : 0,
+ "maximum" : 2
},
"useCalibration" : {
"type" : "integer",
- "description" : "boolean"
+ "description" : "boolean",
+ "minimum" : 0,
+ "maximum" : 1
},
"calibrationInterpMode" : {
"type" : "integer",
- "description" : "Interpolation scheme between points SpectrumSettings::CalibrationInterpolationMode\n * 0 - Linear\n * 1 - Log (dB linear)\n"
+ "description" : "Interpolation scheme between points SpectrumSettings::CalibrationInterpolationMode\n * 0 - Linear\n * 1 - Log (dB linear)\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"histogramMarkers" : {
"type" : "array",
+ "description" : "List of histogram markers.",
"items" : {
"$ref" : "#/definitions/SpectrumHistogramMarker"
}
},
"waterfallMarkers" : {
"type" : "array",
+ "description" : "List of waterfall markers.",
"items" : {
"$ref" : "#/definitions/SpectrumWaterfallMarker"
}
},
"annotationMarkers" : {
"type" : "array",
+ "description" : "List of annotation markers.",
"items" : {
"$ref" : "#/definitions/SpectrumAnnotationMarker"
}
},
"calibrationPoints" : {
"type" : "array",
+ "description" : "List of calibration points.",
"items" : {
"$ref" : "#/definitions/SpectrumCalibrationPoint"
}
@@ -8031,7 +9826,9 @@ margin-bottom: 20px;
"properties" : {
"run" : {
"type" : "integer",
- "description" : "Set the plugin running state\n * 0 - idle\n * 1 - run\n"
+ "description" : "Set the plugin running state\n * 0 - idle\n * 1 - run\n",
+ "minimum" : 0,
+ "maximum" : 1
}
},
"description" : "GS-232 Controller actions"
@@ -8040,7 +9837,9 @@ margin-bottom: 20px;
"properties" : {
"runningState" : {
"type" : "integer",
- "description" : "Running state\n * 0 - not started\n * 1 - idle\n * 2 - running\n * 3 - error\n"
+ "description" : "Running state\n * 0 - not started\n * 1 - idle\n * 2 - running\n * 3 - error\n",
+ "minimum" : 0,
+ "maximum" : 3
},
"sources" : {
"type" : "array",
@@ -8172,28 +9971,39 @@ margin-bottom: 20px;
"description" : "Input controller sensitivity"
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIFeatureSetIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Feature-set index used by the reverse API peer."
},
"reverseAPIFeatureIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Feature index used by the reverse API peer."
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -8202,7 +10012,8 @@ margin-bottom: 20px;
defs.Gain = {
"properties" : {
"gainCB" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Gain in centibels (tenths of a decibel)."
}
},
"description" : "A gain expressed in centi-Bels (tenths of dB)"
@@ -8210,69 +10021,100 @@ margin-bottom: 20px;
defs.HackRFInputSettings = {
"properties" : {
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"centerFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Device center frequency in Hz."
},
"LOppmTenths" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Local-oscillator correction in tenths of a part per million."
},
"bandwidth" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Bandwidth in Hz."
},
"lnaGain" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Low-noise-amplifier gain setting."
},
"vgaGain" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Variable-gain-amplifier gain setting."
},
"log2Decim" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent of the software decimation factor; the output sample rate is divided by 2^log2Decim."
},
"fcPos" : {
"type" : "integer",
"description" : "0=Infra 1=Supra 2=Center"
},
"devSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device I/Q sample rate in samples per second before software decimation or interpolation."
},
"biasT" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable antenna bias power (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"lnaExt" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "LNA ext setting for Hack RF input."
},
"dcBlock" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable DSP DC-offset correction (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"iqCorrection" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable I/Q imbalance correction (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"transverterMode" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable transverter frequency translation (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"transverterDeltaFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Frequency translation applied in transverter mode in Hz."
},
"iqOrder" : {
"type" : "integer",
- "description" : "IQ samples order\n * 0 - Q then I (swapped)\n * 1 - I then Q (straight)\n"
+ "description" : "IQ samples order\n * 0 - Q then I (swapped)\n * 1 - I then Q (straight)\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
}
},
"description" : "HackRF"
@@ -8280,56 +10122,78 @@ margin-bottom: 20px;
defs.HackRFOutputSettings = {
"properties" : {
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"centerFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Device center frequency in Hz."
},
"LOppmTenths" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Local-oscillator correction in tenths of a part per million."
},
"bandwidth" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Bandwidth in Hz."
},
"vgaGain" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Variable-gain-amplifier gain setting."
},
"log2Interp" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent of the software interpolation factor; the output sample rate is multiplied by 2^log2Interp."
},
"fcPos" : {
"type" : "integer",
"description" : "0=Infra 1=Supra 2=Center"
},
"devSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device I/Q sample rate in samples per second before software decimation or interpolation."
},
"biasT" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable antenna bias power (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"lnaExt" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "LNA ext setting for Hack RF output."
},
"transverterMode" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable transverter frequency translation (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"transverterDeltaFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Frequency translation applied in transverter mode in Hz."
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
}
},
"description" : "HackRF"
@@ -8342,7 +10206,8 @@ margin-bottom: 20px;
"description" : "power received in channel (dB)"
},
"channelSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Effective sample rate delivered to the channel in samples per second."
}
},
"description" : "HeatMap"
@@ -8351,7 +10216,8 @@ margin-bottom: 20px;
"properties" : {
"inputFrequencyOffset" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Channel frequency offset from the device center frequency in Hz."
},
"rfBandwidth" : {
"type" : "number",
@@ -8360,35 +10226,44 @@ margin-bottom: 20px;
},
"minPower" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Min power setting for Heat map."
},
"maxPower" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Max power setting for Heat map."
},
"colorMapName" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Color map name setting for Heat map."
},
"mode" : {
"type" : "integer",
- "description" : "(0 - None, 1 - Average, 2 - Max, 3 - Min, 4 - Pulse Average)"
+ "description" : "(0 - None, 1 - Average, 2 - Max, 3 - Min, 4 - Pulse Average)",
+ "minimum" : 0,
+ "maximum" : 4
},
"pulseThreshold" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Pulse threshold setting for Heat map."
},
"averagePeriodUS" : {
"type" : "integer",
"description" : "Averaging period in microseconds"
},
"sampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Sample rate in samples per second."
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"streamIndex" : {
"type" : "integer",
@@ -8396,27 +10271,38 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"scopeConfig" : {
+ "description" : "Oscilloscope-display configuration.",
"$ref" : "#/definitions/GLScope"
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -8426,7 +10312,9 @@ margin-bottom: 20px;
"properties" : {
"tx" : {
"type" : "integer",
- "description" : "Initialize a transmission cycle\n * 0 - Do nothing\n * 1 - Start transmission cycle\n"
+ "description" : "Initialize a transmission cycle\n * 0 - Do nothing\n * 1 - Start transmission cycle\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"data" : {
"type" : "string",
@@ -8443,7 +10331,8 @@ margin-bottom: 20px;
"description" : "power transmitted in channel (dB)"
},
"channelSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Effective sample rate delivered to the channel in samples per second."
}
},
"description" : "IEEE_802_15_4_Mod"
@@ -8452,34 +10341,46 @@ margin-bottom: 20px;
"properties" : {
"inputFrequencyOffset" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Channel frequency offset from the device center frequency in Hz."
},
"modulation" : {
"type" : "integer",
- "description" : "Modulation type\n * 0 - BPSK\n * 1 - OQPSK\n"
+ "description" : "Modulation type\n * 0 - BPSK\n * 1 - OQPSK\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"bitRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Bit rate setting for Ieee 802 15 4 mod."
},
"subGHzBand" : {
"type" : "integer",
- "description" : "Boolean value\n * 0 - Over 1 GHz standard\n * 1 - Under 1 GHz standard\n"
+ "description" : "Boolean value\n * 0 - Over 1 GHz standard\n * 1 - Under 1 GHz standard\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"rfBandwidth" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "RF bandwidth in Hz."
},
"gain" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Gain setting; units and available values depend on the device or plugin."
},
"channelMute" : {
"type" : "integer",
- "description" : "* 0 - Effective transmission * 1 - Transmission is muted\n"
+ "description" : "* 0 - Effective transmission * 1 - Transmission is muted\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"repeat" : {
"type" : "integer",
- "description" : "Whether to repeated transmit the frame (1 for yes, 0 for no)."
+ "description" : "Whether to repeated transmit the frame (1 for yes, 0 for no).",
+ "minimum" : 0,
+ "maximum" : 1
},
"repeatDelay" : {
"type" : "number",
@@ -8491,41 +10392,54 @@ margin-bottom: 20px;
"description" : "Number of times to repeat the frame (-1 for infinite)."
},
"rampUpBits" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Ramp up bits setting for Ieee 802 15 4 mod."
},
"rampDownBits" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Ramp down bits setting for Ieee 802 15 4 mod."
},
"rampRange" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Ramp range setting for Ieee 802 15 4 mod."
},
"modulateWhileRamping" : {
"type" : "integer",
- "description" : "Boolean value\n * 0 - do not modulate in ramping phase\n * 1 - modulate in ramping phase\n"
+ "description" : "Boolean value\n * 0 - do not modulate in ramping phase\n * 1 - modulate in ramping phase\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"lpfTaps" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Number of low-pass FIR filter taps."
},
"bbNoise" : {
"type" : "integer",
- "description" : "Boolean value\n * 0 - Do not add gaussian noise in baseband\n * 1 - Add gaussian noise in baseband\n"
+ "description" : "Boolean value\n * 0 - Do not add gaussian noise in baseband\n * 1 - Add gaussian noise in baseband\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"writeToFile" : {
"type" : "integer",
- "description" : "Boolean value\n * 0 - Do not write frames to .csv file\n * 1 - Write frames to .csv file\n"
+ "description" : "Boolean value\n * 0 - Do not write frames to .csv file\n * 1 - Write frames to .csv file\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"spectrumRate" : {
- "type" : "integer"
+ "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"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"streamIndex" : {
"type" : "integer",
@@ -8533,23 +10447,33 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"scramble" : {
"type" : "integer",
- "description" : "Boolean value\n * 0 - Do not scramble data\n * 1 - Scramble data\n"
+ "description" : "Boolean value\n * 0 - Do not scramble data\n * 1 - Scramble data\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"polynomial" : {
"type" : "integer",
@@ -8557,7 +10481,9 @@ margin-bottom: 20px;
},
"pulseShaping" : {
"type" : "integer",
- "description" : "Pulse shaping filter\n * 0 - Root Cosime\n * 1 - Sine\n"
+ "description" : "Pulse shaping filter\n * 0 - Root Cosime\n * 1 - Sine\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"beta" : {
"type" : "number",
@@ -8565,15 +10491,20 @@ margin-bottom: 20px;
"description" : "Pulse shaping filter beta factor"
},
"symbolSpan" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Symbol span setting for Ieee 802 15 4 mod."
},
"udpEnabled" : {
"type" : "integer",
- "description" : "Enable forwarding of frames via UDP"
+ "description" : "Enable forwarding of frames via UDP",
+ "minimum" : 0,
+ "maximum" : 1
},
"udpBytesFormat" : {
"type" : "integer",
- "description" : "Payload format\n * 0 - Blank separated string representation of hex bytes i.e. 00 02 0a\n * 1 - Raw bytes\n"
+ "description" : "Payload format\n * 0 - Blank separated string representation of hex bytes i.e. 00 02 0a\n * 1 - Raw bytes\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"udpAddress" : {
"type" : "string",
@@ -8581,12 +10512,16 @@ margin-bottom: 20px;
},
"udpPort" : {
"type" : "integer",
- "description" : "UDP port to listen for frames to transmit on"
+ "description" : "UDP port to listen for frames to transmit on",
+ "minimum" : 1,
+ "maximum" : 65535
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -8600,10 +10535,12 @@ margin-bottom: 20px;
"description" : "power received in channel (dB)"
},
"channelSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Effective sample rate delivered to the channel in samples per second."
},
"ident" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Reported ident."
},
"deviation" : {
"type" : "number",
@@ -8637,73 +10574,95 @@ margin-bottom: 20px;
"properties" : {
"inputFrequencyOffset" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Channel frequency offset from the device center frequency in Hz."
},
"rfBandwidth" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "RF bandwidth in Hz."
},
"mode" : {
"type" : "integer",
"description" : "(0 for LOC, 1 for G/S)"
},
"frequencyIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Selected frequency index."
},
"squelch" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Squelch threshold in dB."
},
"volume" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Audio volume multiplier."
},
"audioMute" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Mute audio output (1 muted, 0 unmuted).",
+ "minimum" : 0,
+ "maximum" : 1
},
"average" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Average setting for Ils demod."
},
"ddmUnits" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Ddm units setting for Ils demod."
},
"identThreshold" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Ident threshold setting for Ils demod."
},
"ident" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Ident setting for Ils demod."
},
"runway" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Runway setting for Ils demod."
},
"trueBearing" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "True bearing setting for Ils demod."
},
"latitude" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Latitude in degrees, positive north."
},
"longitude" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Longitude in degrees, positive east."
},
"elevation" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Elevation setting for Ils demod."
},
"glidePath" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Glide path setting for Ils demod."
},
"refHeight" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Ref height setting for Ils demod."
},
"courseWidth" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Course width setting for Ils demod."
},
"udpEnabled" : {
"type" : "integer",
- "description" : "Whether to forward DDM to specified UDP port"
+ "description" : "Whether to forward DDM to specified UDP port",
+ "minimum" : 0,
+ "maximum" : 1
},
"udpAddress" : {
"type" : "string",
@@ -8711,19 +10670,27 @@ margin-bottom: 20px;
},
"udpPort" : {
"type" : "integer",
- "description" : "UDP port to forward DDM to"
+ "description" : "UDP port to forward DDM to",
+ "minimum" : 1,
+ "maximum" : 65535
},
"logFilename" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Log file name or path."
},
"logEnabled" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable logging to the configured file (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"streamIndex" : {
"type" : "integer",
@@ -8731,27 +10698,38 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"scopeConfig" : {
+ "description" : "Oscilloscope-display configuration.",
"$ref" : "#/definitions/GLScope"
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -8765,7 +10743,8 @@ margin-bottom: 20px;
"description" : "power received in channel (dB)"
},
"channelSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Effective sample rate delivered to the channel in samples per second."
}
},
"description" : "InmarsatDemod"
@@ -8774,23 +10753,29 @@ margin-bottom: 20px;
"properties" : {
"inputFrequencyOffset" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Channel frequency offset from the device center frequency in Hz."
},
"rfBandwidth" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "RF bandwidth in Hz."
},
"rrcRolloff" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Rrc rolloff setting for Inmarsat demod."
},
"pllBandwidth" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Pll bandwidth in Hz."
},
"udpEnabled" : {
"type" : "integer",
- "description" : "Whether to forward received messages to specified UDP port"
+ "description" : "Whether to forward received messages to specified UDP port",
+ "minimum" : 0,
+ "maximum" : 1
},
"udpAddress" : {
"type" : "string",
@@ -8798,26 +10783,37 @@ margin-bottom: 20px;
},
"udpPort" : {
"type" : "integer",
- "description" : "UDP port to forward received messages to"
+ "description" : "UDP port to forward received messages to",
+ "minimum" : 1,
+ "maximum" : 65535
},
"udpFormat" : {
"type" : "integer",
"description" : "0 for binary, 1 for NMEA"
},
"logFilename" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Log file name or path."
},
"logEnabled" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable logging to the configured file (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"useFileTime" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable file time (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"streamIndex" : {
"type" : "integer",
@@ -8825,27 +10821,38 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"scopeConfig" : {
+ "description" : "Oscilloscope-display configuration.",
"$ref" : "#/definitions/GLScope"
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -8985,16 +10992,20 @@ margin-bottom: 20px;
"description" : "see InterferometerSettings::CorrelationType"
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"log2Decim" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent of the software decimation factor; the output sample rate is divided by 2^log2Decim."
},
"filterChainHash" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Identifier of the selected half-band filter chain."
},
"phase" : {
"type" : "integer",
@@ -9010,34 +11021,48 @@ margin-bottom: 20px;
},
"play" : {
"type" : "integer",
- "description" : "Run correlated IQ samples transfer\n * 0 - stop\n * 1 - run\n"
+ "description" : "Run correlated IQ samples transfer\n * 0 - stop\n * 1 - run\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"spectrumConfig" : {
+ "description" : "Spectrum-display configuration.",
"$ref" : "#/definitions/GLSpectrum"
},
"scopeConfig" : {
+ "description" : "Oscilloscope-display configuration.",
"$ref" : "#/definitions/GLScope"
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -9046,28 +11071,39 @@ margin-bottom: 20px;
defs.JogdialControllerSettings = {
"properties" : {
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API\n * 1 - yes\n * 0 - no\n"
+ "description" : "Synchronize with reverse API\n * 1 - yes\n * 0 - no\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIFeatureSetIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Feature-set index used by the reverse API peer."
},
"reverseAPIFeatureIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Feature index used by the reverse API peer."
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -9081,15 +11117,22 @@ margin-bottom: 20px;
},
"latitude" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Latitude in degrees, positive north.",
+ "minimum" : -90,
+ "maximum" : 90
},
"longitude" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Longitude in degrees, positive east.",
+ "minimum" : -180,
+ "maximum" : 180
},
"altitude" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Altitude above mean sea level."
}
},
"description" : "KiwiSDR"
@@ -9097,21 +11140,29 @@ margin-bottom: 20px;
defs.KiwiSDRSettings = {
"properties" : {
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"gain" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Gain setting; units and available values depend on the device or plugin."
},
"useAGC" : {
"type" : "integer",
- "description" : "AGC active (1 for yes, 0 for no)"
+ "description" : "AGC active (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"dcBlock" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable DSP DC-offset correction (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"centerFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Device center frequency in Hz."
},
"serverAddress" : {
"type" : "string",
@@ -9119,16 +11170,23 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
}
},
"description" : "KiwiSDR"
@@ -9137,7 +11195,9 @@ margin-bottom: 20px;
"properties" : {
"selectChannel" : {
"type" : "integer",
- "description" : "Select channel\n * 0 - Rx\n * 1 - Tx\n"
+ "description" : "Select channel\n * 0 - Rx\n * 1 - Tx\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"deviceSetIndex" : {
"type" : "integer",
@@ -9145,7 +11205,9 @@ margin-bottom: 20px;
},
"switchChannel" : {
"type" : "integer",
- "description" : "Switch on or off\n * 0 - Off\n * 1 - On\n"
+ "description" : "Switch on or off\n * 0 - Off\n * 1 - On\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"getState" : {
"type" : "integer",
@@ -9153,19 +11215,27 @@ margin-bottom: 20px;
},
"fromToSettings" : {
"type" : "integer",
- "description" : "Move from/to settings to/from device\n * 0 - From device to settings. The toGUI button in GUI mode\n * 1 - From settings to device. The Apply button in GUI mode\n"
+ "description" : "Move from/to settings to/from device\n * 0 - From device to settings. The toGUI button in GUI mode\n * 1 - From settings to device. The Apply button in GUI mode\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"openCloseDevice" : {
"type" : "integer",
- "description" : "Open or close device\n * 0 - Close device\n * 1 - Open device\n"
+ "description" : "Open or close device\n * 0 - Close device\n * 1 - Open device\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"setRx" : {
"type" : "integer",
- "description" : "Set Rx om or off\n * 0 - Rx off\n * 1 - Rx on\n"
+ "description" : "Set Rx om or off\n * 0 - Rx off\n * 1 - Rx on\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"setTx" : {
"type" : "integer",
- "description" : "Set Tx om or off\n * 0 - Tx off\n * 1 - Tx on\n"
+ "description" : "Set Tx om or off\n * 0 - Tx off\n * 1 - Tx on\n",
+ "minimum" : 0,
+ "maximum" : 1
}
},
"description" : "LimeRFE"
@@ -9200,11 +11270,15 @@ margin-bottom: 20px;
"properties" : {
"rxOn" : {
"type" : "integer",
- "description" : "Boolean 1 if Rx is active else 0"
+ "description" : "Boolean 1 if Rx is active else 0",
+ "minimum" : 0,
+ "maximum" : 1
},
"txOn" : {
"type" : "integer",
- "description" : "Boolean 1 if Tx is active else 0"
+ "description" : "Boolean 1 if Tx is active else 0",
+ "minimum" : 0,
+ "maximum" : 1
},
"forwardPower" : {
"type" : "integer",
@@ -9220,10 +11294,12 @@ margin-bottom: 20px;
defs.LimeRFESettings = {
"properties" : {
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"devicePath" : {
"type" : "string",
@@ -9231,11 +11307,15 @@ margin-bottom: 20px;
},
"rxChannels" : {
"type" : "integer",
- "description" : "Rx channels group (LimeRFEController::ChannelGroups):\n * 0 - Wideband\n * 1 - HAM\n * 2 - cellular\n"
+ "description" : "Rx channels group (LimeRFEController::ChannelGroups):\n * 0 - Wideband\n * 1 - HAM\n * 2 - cellular\n",
+ "minimum" : 0,
+ "maximum" : 2
},
"rxWidebandChannel" : {
"type" : "integer",
- "description" : "Rx wideband channel selection (LimeRFEController::WidebandChannel)\n * 0 - Low: 1 - 1000 MHz\n * 1 - High: 1 - 4 GHz\n"
+ "description" : "Rx wideband channel selection (LimeRFEController::WidebandChannel)\n * 0 - Low: 1 - 1000 MHz\n * 1 - High: 1 - 4 GHz\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"rxHAMChannel" : {
"type" : "integer",
@@ -9247,7 +11327,9 @@ margin-bottom: 20px;
},
"rxPort" : {
"type" : "integer",
- "description" : "Rx port selected (LimeRFEController::RxPort)\n * 0 - J3\n * 1 - J5\n"
+ "description" : "Rx port selected (LimeRFEController::RxPort)\n * 0 - J3\n * 1 - J5\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"attenuationFactor" : {
"type" : "integer",
@@ -9259,11 +11341,15 @@ margin-bottom: 20px;
},
"txChannels" : {
"type" : "integer",
- "description" : "Tx channels group (LimeRFEController::ChannelGroups)\n * 0 - Wideband\n * 1 - HAM\n * 2 - cellular\n"
+ "description" : "Tx channels group (LimeRFEController::ChannelGroups)\n * 0 - Wideband\n * 1 - HAM\n * 2 - cellular\n",
+ "minimum" : 0,
+ "maximum" : 2
},
"txWidebandChannel" : {
"type" : "integer",
- "description" : "Tx wideband channel selection (LimeRFEController::WidebandChannel)\n * 0 - Low: 1 - 1000 MHz\n * 1 - High: 1 - 4 GHz\n"
+ "description" : "Tx wideband channel selection (LimeRFEController::WidebandChannel)\n * 0 - Low: 1 - 1000 MHz\n * 1 - High: 1 - 4 GHz\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"txHAMChannel" : {
"type" : "integer",
@@ -9275,37 +11361,54 @@ margin-bottom: 20px;
},
"txPort" : {
"type" : "integer",
- "description" : "Tx port selected (LimeRFEController::TxPort)\n * 0 - J3\n * 1 - J4\n * 2 - J5\n"
+ "description" : "Tx port selected (LimeRFEController::TxPort)\n * 0 - J3\n * 1 - J4\n * 2 - J5\n",
+ "minimum" : 0,
+ "maximum" : 2
},
"swrEnable" : {
"type" : "integer",
- "description" : "Boolean if SWR measurements are enabled else 0"
+ "description" : "Boolean if SWR measurements are enabled else 0",
+ "minimum" : 0,
+ "maximum" : 1
},
"swrSource" : {
"type" : "integer",
- "description" : "SWR measurement source (LimeRFEController::SWRSource)\n * 0 - External\n * 1 - Cellular\n"
+ "description" : "SWR measurement source (LimeRFEController::SWRSource)\n * 0 - External\n * 1 - Cellular\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"txRxDriven" : {
"type" : "integer",
- "description" : "Boolean 1 if Tx is copy of Rx else 0"
+ "description" : "Boolean 1 if Tx is copy of Rx else 0",
+ "minimum" : 0,
+ "maximum" : 1
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIFeatureSetIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Feature-set index used by the reverse API peer."
},
"reverseAPIFeatureIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Feature index used by the reverse API peer."
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -9319,26 +11422,34 @@ margin-bottom: 20px;
},
"streamActive" : {
"type" : "integer",
- "description" : "1 if active else 0"
+ "description" : "1 if active else 0",
+ "minimum" : 0,
+ "maximum" : 1
},
"fifoSize" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "FIFO capacity in samples."
},
"fifoFill" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Current FIFO fill level."
},
"underrunCount" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Number of stream underrun events."
},
"overrunCount" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Number of stream overrun events."
},
"droppedPacketsCount" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Number of dropped packets."
},
"linkRate" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Measured streaming link rate."
},
"hwTimestamp" : {
"type" : "integer",
@@ -9347,15 +11458,18 @@ margin-bottom: 20px;
},
"temperature" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Reported device temperature."
},
"gpioDir" : {
"type" : "integer",
- "format" : "int8"
+ "format" : "int8",
+ "description" : "GPIO direction bit mask, with one bit per pin."
},
"gpioPins" : {
"type" : "integer",
- "format" : "int8"
+ "format" : "int8",
+ "description" : "GPIO pin-state bit mask, with one bit per pin."
}
},
"description" : "LimeSDR"
@@ -9363,100 +11477,146 @@ margin-bottom: 20px;
defs.LimeSdrInputSettings = {
"properties" : {
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"centerFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Device center frequency in Hz."
},
"devSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device I/Q sample rate in samples per second before software decimation or interpolation."
},
"log2HardDecim" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent of the hardware decimation factor."
},
"dcBlock" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable DSP DC-offset correction (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"splitFreq" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Split freq setting for Lime sdr input."
},
"iqCorrection" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable I/Q imbalance correction (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"log2SoftDecim" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent of the software decimation factor."
},
"lpfBW" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Analog low-pass filter bandwidth in Hz."
},
"lpfFIREnable" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable the digital FIR low-pass filter (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"lpfFIRBW" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Digital FIR low-pass filter bandwidth in Hz."
},
"gain" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Gain setting; units and available values depend on the device or plugin."
},
"ncoEnable" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable the numerically controlled oscillator (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"ncoFrequency" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Numerically controlled oscillator frequency in Hz."
},
"antennaPath" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Selected RF antenna path."
},
"gainMode" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Gain-control mode selection."
},
"lnaGain" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Low-noise-amplifier gain setting."
},
"tiaGain" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TIA gain setting for Lime sdr input."
},
"pgaGain" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "PGA gain setting for Lime sdr input."
},
"extClock" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Use an external reference clock (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"extClockFreq" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "External reference-clock frequency in Hz."
},
"transverterMode" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable transverter frequency translation (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"transverterDeltaFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Frequency translation applied in transverter mode in Hz."
},
"iqOrder" : {
"type" : "integer",
- "description" : "IQ samples order\n * 0 - Q then I (swapped)\n * 1 - I then Q (straight)\n"
+ "description" : "IQ samples order\n * 0 - Q then I (swapped)\n * 1 - I then Q (straight)\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"gpioDir" : {
"type" : "integer",
- "format" : "int8"
+ "format" : "int8",
+ "description" : "GPIO direction bit mask, with one bit per pin."
},
"gpioPins" : {
"type" : "integer",
- "format" : "int8"
+ "format" : "int8",
+ "description" : "GPIO pin-state bit mask, with one bit per pin."
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
}
},
"description" : "LimeSDR"
@@ -9470,15 +11630,18 @@ margin-bottom: 20px;
},
"temperature" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Reported device temperature."
},
"gpioDir" : {
"type" : "integer",
- "format" : "int8"
+ "format" : "int8",
+ "description" : "GPIO direction bit mask, with one bit per pin."
},
"gpioPins" : {
"type" : "integer",
- "format" : "int8"
+ "format" : "int8",
+ "description" : "GPIO pin-state bit mask, with one bit per pin."
},
"successRx" : {
"type" : "integer",
@@ -9489,23 +11652,29 @@ margin-bottom: 20px;
"description" : "1 if active else 0"
},
"fifoSizeRx" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Reported fifo size receive."
},
"fifoFillRx" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Current receive FIFO fill level."
},
"underrunCountRx" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Reported underrun count receive."
},
"overrunCountRx" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Reported overrun count receive."
},
"droppedPacketsCountRx" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Reported dropped packets count receive."
},
"linkRateRx" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Reported link rate receive."
},
"successTx" : {
"type" : "integer",
@@ -9516,23 +11685,29 @@ margin-bottom: 20px;
"description" : "1 if active else 0"
},
"fifoSizeTx" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Reported fifo size transmit."
},
"fifoFillTx" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Current transmit FIFO fill level."
},
"underrunCountTx" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Reported underrun count transmit."
},
"overrunCountTx" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Reported overrun count transmit."
},
"droppedPacketsCountTx" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Reported dropped packets count transmit."
},
"linkRateTx" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Reported link rate transmit."
}
},
"description" : "LimeSDR"
@@ -9540,10 +11715,12 @@ margin-bottom: 20px;
defs.LimeSdrMIMOSettings = {
"properties" : {
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"devSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device I/Q sample rate in samples per second before software decimation or interpolation."
},
"gpioDir" : {
"type" : "integer",
@@ -9557,7 +11734,9 @@ margin-bottom: 20px;
},
"extClock" : {
"type" : "integer",
- "description" : "Boolean 1 if external clock source else 0"
+ "description" : "Boolean 1 if external clock source else 0",
+ "minimum" : 0,
+ "maximum" : 1
},
"extClockFreq" : {
"type" : "integer",
@@ -9565,50 +11744,71 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Boolean"
+ "description" : "Boolean",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"rxCenterFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Receive center frequency in Hz."
},
"log2HardDecim" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent of the hardware decimation factor."
},
"log2SoftDecim" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent of the software decimation factor."
},
"dcBlock" : {
"type" : "integer",
- "description" : "Boolean"
+ "description" : "Boolean",
+ "minimum" : 0,
+ "maximum" : 1
},
"iqCorrection" : {
"type" : "integer",
- "description" : "Boolean"
+ "description" : "Boolean",
+ "minimum" : 0,
+ "maximum" : 1
},
"rxTransverterMode" : {
"type" : "integer",
- "description" : "Boolean"
+ "description" : "Boolean",
+ "minimum" : 0,
+ "maximum" : 1
},
"rxTransverterDeltaFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Receive frequency translation applied in transverter mode in Hz."
},
"iqOrder" : {
"type" : "integer",
- "description" : "IQ samples order\n * 0 - Q then I (swapped)\n * 1 - I then Q (straight)\n"
+ "description" : "IQ samples order\n * 0 - Q then I (swapped)\n * 1 - I then Q (straight)\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"ncoEnableRx" : {
"type" : "integer",
- "description" : "Boolean 1 to enable TSP NCO and mixing else 0"
+ "description" : "Boolean 1 to enable TSP NCO and mixing else 0",
+ "minimum" : 0,
+ "maximum" : 1
},
"ncoFrequencyRx" : {
"type" : "integer",
@@ -9621,7 +11821,9 @@ margin-bottom: 20px;
},
"lpfFIREnableRx0" : {
"type" : "integer",
- "description" : "Boolean 1 to enable Rx[0] LMS digital lowpass FIR filters else 0"
+ "description" : "Boolean 1 to enable Rx[0] LMS digital lowpass FIR filters else 0",
+ "minimum" : 0,
+ "maximum" : 1
},
"lpfFIRBWRx0" : {
"type" : "number",
@@ -9634,11 +11836,15 @@ margin-bottom: 20px;
},
"antennaPathRx0" : {
"type" : "integer",
- "description" : "Rx[0] Antenna connection (PathRxRFE):\n * 0 - None\n * 1 - LNA High\n * 2 - LNA low\n * 3 - LNA Wide\n * 4 - LB TX1\n * 5 - LB TX2\n"
+ "description" : "Rx[0] Antenna connection (PathRxRFE):\n * 0 - None\n * 1 - LNA High\n * 2 - LNA low\n * 3 - LNA Wide\n * 4 - LB TX1\n * 5 - LB TX2\n",
+ "minimum" : 0,
+ "maximum" : 5
},
"gainModeRx0" : {
"type" : "integer",
- "description" : "Rx[0] Gain mode:\n * 0 - auto\n * 1 - manual\n"
+ "description" : "Rx[0] Gain mode:\n * 0 - auto\n * 1 - manual\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"lnaGainRx0" : {
"type" : "integer",
@@ -9659,7 +11865,9 @@ margin-bottom: 20px;
},
"lpfFIREnableRx1" : {
"type" : "integer",
- "description" : "Boolean 1 to enable Rx[1] LMS digital lowpass FIR filters else 0"
+ "description" : "Boolean 1 to enable Rx[1] LMS digital lowpass FIR filters else 0",
+ "minimum" : 0,
+ "maximum" : 1
},
"lpfFIRBWRx1" : {
"type" : "number",
@@ -9672,11 +11880,15 @@ margin-bottom: 20px;
},
"antennaPathRx1" : {
"type" : "integer",
- "description" : "Rx[1] Antenna connection (PathRxRFE):\n * 0 - None\n * 1 - LNA High\n * 2 - LNA low\n * 3 - LNA Wide\n * 4 - LB TX1\n * 5 - LB TX2\n"
+ "description" : "Rx[1] Antenna connection (PathRxRFE):\n * 0 - None\n * 1 - LNA High\n * 2 - LNA low\n * 3 - LNA Wide\n * 4 - LB TX1\n * 5 - LB TX2\n",
+ "minimum" : 0,
+ "maximum" : 5
},
"gainModeRx1" : {
"type" : "integer",
- "description" : "Rx[1] Gain mode:\n * 0 - auto\n * 1 - manual\n"
+ "description" : "Rx[1] Gain mode:\n * 0 - auto\n * 1 - manual\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"lnaGainRx1" : {
"type" : "integer",
@@ -9692,25 +11904,33 @@ margin-bottom: 20px;
},
"txCenterFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Transmit center frequency in Hz."
},
"log2HardInterp" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent of the hardware interpolation factor."
},
"log2SoftInterp" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent of the software interpolation factor."
},
"txTransverterMode" : {
"type" : "integer",
- "description" : "Boolean"
+ "description" : "Boolean",
+ "minimum" : 0,
+ "maximum" : 1
},
"txTransverterDeltaFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Transmit frequency translation applied in transverter mode in Hz."
},
"ncoEnableTx" : {
"type" : "integer",
- "description" : "Boolean 1 to enable TSP NCO and mixing else 0"
+ "description" : "Boolean 1 to enable TSP NCO and mixing else 0",
+ "minimum" : 0,
+ "maximum" : 1
},
"ncoFrequencyTx" : {
"type" : "integer",
@@ -9723,7 +11943,9 @@ margin-bottom: 20px;
},
"lpfFIREnableTx0" : {
"type" : "integer",
- "description" : "Boolean 1 to enable Tx[0] LMS digital lowpass FIR filters else 0"
+ "description" : "Boolean 1 to enable Tx[0] LMS digital lowpass FIR filters else 0",
+ "minimum" : 0,
+ "maximum" : 1
},
"lpfFIRBWTx0" : {
"type" : "number",
@@ -9736,7 +11958,9 @@ margin-bottom: 20px;
},
"antennaPathTx0" : {
"type" : "integer",
- "description" : "Tx[0] Antenna connection (PathTxRFE):\n * 0 - None\n * 1 - RF connector 1\n * 2 - RF connector 2\n"
+ "description" : "Tx[0] Antenna connection (PathTxRFE):\n * 0 - None\n * 1 - RF connector 1\n * 2 - RF connector 2\n",
+ "minimum" : 0,
+ "maximum" : 2
},
"lpfBWTx1" : {
"type" : "number",
@@ -9745,7 +11969,9 @@ margin-bottom: 20px;
},
"lpfFIREnableTx1" : {
"type" : "integer",
- "description" : "Boolean 1 to enable Tx[1] LMS digital lowpass FIR filters else 0"
+ "description" : "Boolean 1 to enable Tx[1] LMS digital lowpass FIR filters else 0",
+ "minimum" : 0,
+ "maximum" : 1
},
"lpfFIRBWTx1" : {
"type" : "number",
@@ -9758,7 +11984,9 @@ margin-bottom: 20px;
},
"antennaPathTx1" : {
"type" : "integer",
- "description" : "Tx[1] Antenna connection (PathTxRFE):\n * 0 - None\n * 1 - RF connector 1\n * 2 - RF connector 2\n"
+ "description" : "Tx[1] Antenna connection (PathTxRFE):\n * 0 - None\n * 1 - RF connector 1\n * 2 - RF connector 2\n",
+ "minimum" : 0,
+ "maximum" : 2
}
},
"description" : "LimeSDR"
@@ -9771,26 +11999,34 @@ margin-bottom: 20px;
},
"streamActive" : {
"type" : "integer",
- "description" : "1 if active else 0"
+ "description" : "1 if active else 0",
+ "minimum" : 0,
+ "maximum" : 1
},
"fifoSize" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "FIFO capacity in samples."
},
"fifoFill" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Current FIFO fill level."
},
"underrunCount" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Number of stream underrun events."
},
"overrunCount" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Number of stream overrun events."
},
"droppedPacketsCount" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Number of dropped packets."
},
"linkRate" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Measured streaming link rate."
},
"hwTimestamp" : {
"type" : "integer",
@@ -9799,15 +12035,18 @@ margin-bottom: 20px;
},
"temperature" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Reported device temperature."
},
"gpioDir" : {
"type" : "integer",
- "format" : "int8"
+ "format" : "int8",
+ "description" : "GPIO direction bit mask, with one bit per pin."
},
"gpioPins" : {
"type" : "integer",
- "format" : "int8"
+ "format" : "int8",
+ "description" : "GPIO pin-state bit mask, with one bit per pin."
}
},
"description" : "LimeSDR"
@@ -9815,75 +12054,108 @@ margin-bottom: 20px;
defs.LimeSdrOutputSettings = {
"properties" : {
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"centerFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Device center frequency in Hz."
},
"devSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device I/Q sample rate in samples per second before software decimation or interpolation."
},
"log2HardInterp" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent of the hardware interpolation factor."
},
"log2SoftInterp" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent of the software interpolation factor."
},
"lpfBW" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Analog low-pass filter bandwidth in Hz."
},
"lpfFIREnable" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable the digital FIR low-pass filter (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"lpfFIRBW" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Digital FIR low-pass filter bandwidth in Hz."
},
"gain" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Gain setting; units and available values depend on the device or plugin."
},
"ncoEnable" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable the numerically controlled oscillator (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"ncoFrequency" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Numerically controlled oscillator frequency in Hz."
},
"antennaPath" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Selected RF antenna path."
},
"extClock" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Use an external reference clock (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"extClockFreq" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "External reference-clock frequency in Hz."
},
"transverterMode" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable transverter frequency translation (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"transverterDeltaFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Frequency translation applied in transverter mode in Hz."
},
"gpioDir" : {
"type" : "integer",
- "format" : "int8"
+ "format" : "int8",
+ "description" : "GPIO direction bit mask, with one bit per pin."
},
"gpioPins" : {
"type" : "integer",
- "format" : "int8"
+ "format" : "int8",
+ "description" : "GPIO pin-state bit mask, with one bit per pin."
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
}
},
"description" : "LimeSDR"
@@ -9892,10 +12164,12 @@ margin-bottom: 20px;
"properties" : {
"centerFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Device center frequency in Hz."
},
"sampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Sample rate in samples per second."
}
},
"description" : "LocalInput"
@@ -9903,26 +12177,40 @@ margin-bottom: 20px;
defs.LocalInputSettings = {
"properties" : {
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"dcBlock" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable DSP DC-offset correction (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"iqCorrection" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable I/Q imbalance correction (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
}
},
"description" : "LocalInput"
@@ -9931,10 +12219,12 @@ margin-bottom: 20px;
"properties" : {
"centerFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Device center frequency in Hz."
},
"sampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Sample rate in samples per second."
}
},
"description" : "LocalOutput"
@@ -9942,20 +12232,28 @@ margin-bottom: 20px;
defs.LocalOutputSettings = {
"properties" : {
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
}
},
"description" : "LocalOutput"
@@ -9967,24 +12265,32 @@ margin-bottom: 20px;
"description" : "Receiving local device index"
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"log2Decim" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent of the software decimation factor; the output sample rate is divided by 2^log2Decim."
},
"filterChainHash" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Identifier of the selected half-band filter chain."
},
"play" : {
"type" : "integer",
- "description" : "Run samples transfer\n * 0 - stop\n * 1 - run\n"
+ "description" : "Run samples transfer\n * 0 - stop\n * 1 - run\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"dsp" : {
"type" : "integer",
- "description" : "Activate DSP\n * 0 - Skip DSP functions\n * 1 - Run DSP functions\n"
+ "description" : "Activate DSP\n * 0 - Skip DSP functions\n * 1 - Run DSP functions\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"gaindB" : {
"type" : "integer",
@@ -9992,7 +12298,9 @@ margin-bottom: 20px;
},
"fftOn" : {
"type" : "integer",
- "description" : "Activate FFT multiband filter\n * 0 - do not run filter\n * 1 - run filter\n"
+ "description" : "Activate FFT multiband filter\n * 0 - do not run filter\n * 1 - run filter\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"log2FFT" : {
"type" : "integer",
@@ -10000,17 +12308,22 @@ margin-bottom: 20px;
},
"fftWindow" : {
"type" : "integer",
- "description" : "FFT window type\n * 0 - Bartlett\n * 1 - Blackman-Harris\n * 2 - Flat top\n * 3 - Hamming\n * 4 - Hanning\n * 5 - Rectangle\n * 6 - Kaiser\n * 7 - Blackman\n * 8 - Blackman-Harris (7th order)\n"
+ "description" : "FFT window type\n * 0 - Bartlett\n * 1 - Blackman-Harris\n * 2 - Flat top\n * 3 - Hamming\n * 4 - Hanning\n * 5 - Rectangle\n * 6 - Kaiser\n * 7 - Blackman\n * 8 - Blackman-Harris (7th order)\n",
+ "minimum" : 0,
+ "maximum" : 8
},
"fftBands" : {
"type" : "array",
+ "description" : "List of fft bands.",
"items" : {
"$ref" : "#/definitions/FFTBand"
}
},
"reverseFilter" : {
"type" : "integer",
- "description" : "* 0 - band definitions are bandpass * 1 - band definitions are band reject\n"
+ "description" : "* 0 - band definitions are bandpass * 1 - band definitions are band reject\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"streamIndex" : {
"type" : "integer",
@@ -10018,24 +12331,34 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -10048,20 +12371,26 @@ margin-bottom: 20px;
"description" : "Sending local device index"
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"log2Interp" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent of the software interpolation factor; the output sample rate is multiplied by 2^log2Interp."
},
"filterChainHash" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Identifier of the selected half-band filter chain."
},
"play" : {
"type" : "integer",
- "description" : "boolean (1 to play, 0 to stop)"
+ "description" : "boolean (1 to play, 0 to stop)",
+ "minimum" : 0,
+ "maximum" : 1
},
"streamIndex" : {
"type" : "integer",
@@ -10069,24 +12398,34 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -10137,10 +12476,12 @@ margin-bottom: 20px;
"description" : "power transmitted in channel (dB)"
},
"audioSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Audio sample rate in samples per second."
},
"channelSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Effective sample rate delivered to the channel in samples per second."
},
"squelch" : {
"type" : "integer",
@@ -10153,48 +12494,63 @@ margin-bottom: 20px;
"properties" : {
"inputFrequencyOffset" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Channel frequency offset from the device center frequency in Hz."
},
"rfBandwidth" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "RF bandwidth in Hz."
},
"fmDeviation" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "FM frequency deviation in Hz."
},
"volume" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Audio volume multiplier."
},
"demodGain" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Demod gain setting for M17 demod."
},
"baudRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Serial-port baud rate in bits per second."
},
"squelchGate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Squelch gate duration."
},
"squelch" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Squelch threshold in dB."
},
"audioMute" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Mute audio output (1 muted, 0 unmuted).",
+ "minimum" : 0,
+ "maximum" : 1
},
"syncOrConstellation" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Sync or constellation setting for M17 demod."
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"highPassFilter" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "High pass filter setting for M17 demod."
},
"traceLengthMutliplier" : {
"type" : "integer",
@@ -10209,10 +12565,14 @@ margin-bottom: 20px;
"description" : "0 to 255"
},
"audioDeviceName" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Name of the audio device to use."
},
"statusLogEnabled" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable status log (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"streamIndex" : {
"type" : "integer",
@@ -10220,24 +12580,34 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -10251,10 +12621,12 @@ margin-bottom: 20px;
"description" : "power transmitted in channel (dB)"
},
"audioSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Audio sample rate in samples per second."
},
"channelSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Effective sample rate delivered to the channel in samples per second."
}
},
"description" : "M17Mod"
@@ -10263,35 +12635,48 @@ margin-bottom: 20px;
"properties" : {
"inputFrequencyOffset" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Channel frequency offset from the device center frequency in Hz."
},
"rfBandwidth" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "RF bandwidth in Hz."
},
"fmDeviation" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "FM frequency deviation in Hz."
},
"toneFrequency" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Tone frequency in Hz."
},
"volumeFactor" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Volume factor setting for M17 mod."
},
"channelMute" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Mute the channel output (1 muted, 0 unmuted).",
+ "minimum" : 0,
+ "maximum" : 1
},
"playLoop" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Loop playback at end of file (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"m17Mode" : {
"type" : "integer",
@@ -10306,17 +12691,21 @@ margin-bottom: 20px;
"description" : "PacketType"
},
"audioDeviceName" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Name of the audio device to use."
},
"feedbackAudioDeviceName" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Feedback audio device name setting for M17 mod."
},
"feedbackVolumeFactor" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Feedback volume factor setting for M17 mod."
},
"feedbackAudioEnable" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Feedback audio enable setting for M17 mod."
},
"streamIndex" : {
"type" : "integer",
@@ -10324,64 +12713,169 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"sourceCall" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Source call setting for M17 mod."
},
"destCall" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Dest call setting for M17 mod."
},
"insertPosition" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Insert position setting for M17 mod."
},
"can" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Can setting for M17 mod."
},
"smsText" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Sms text setting for M17 mod."
},
"loopPacket" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Loop packet setting for M17 mod."
},
"loopPacketInterval" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Loop packet interval setting for M17 mod."
},
"aprsCallsign" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Aprs callsign setting for M17 mod."
},
"aprsTo" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Aprs to setting for M17 mod."
},
"aprsVia" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Aprs via setting for M17 mod."
},
"aprsData" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Aprs data setting for M17 mod."
},
"aprsInsertPosition" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Aprs insert position setting for M17 mod."
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
"description" : "M17Mod"
+};
+ defs.MCPServerActions = {
+ "properties" : {
+ "run" : {
+ "type" : "integer",
+ "description" : "Set the plugin running state\n * 0 - idle\n * 1 - run\n",
+ "minimum" : 0,
+ "maximum" : 1
+ }
+ },
+ "description" : "MCP server actions"
+};
+ defs.MCPServerReport = {
+ "properties" : {
+ "runningState" : {
+ "type" : "integer",
+ "description" : "Running state\n * 0 - not started\n * 1 - idle\n * 2 - running\n * 3 - error\n",
+ "minimum" : 0,
+ "maximum" : 3
+ },
+ "requestCount" : {
+ "type" : "integer",
+ "description" : "Number of MCP requests served since the server was started"
+ }
+ },
+ "description" : "MCP server report"
+};
+ defs.MCPServerSettings = {
+ "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",
+ "description" : "Synchronize with reverse API\n * 1 - yes\n * 0 - no\n",
+ "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" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
+ "$ref" : "#/definitions/RollupState"
+ }
+ },
+ "description" : "MCP (Model Context Protocol) server settings"
};
defs.MapActions = {
"properties" : {
@@ -10399,13 +12893,16 @@ margin-bottom: 20px;
defs.MapAircraftState = {
"properties" : {
"callsign" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Radio callsign."
},
"aircraftType" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Aircraft type for Map aircraft state."
},
"onSurface" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "On surface for Map aircraft state."
},
"airspeed" : {
"type" : "number",
@@ -10428,7 +12925,8 @@ margin-bottom: 20px;
},
"mach" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Mach for Map aircraft state."
},
"altitude" : {
"type" : "number",
@@ -10465,15 +12963,18 @@ margin-bottom: 20px;
},
"selectedAirspeed" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Selected airspeed for Map aircraft state."
},
"selectedAltitude" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Selected altitude for Map aircraft state."
},
"selectedHeading" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Selected heading for Map aircraft state."
},
"autopilot" : {
"type" : "integer",
@@ -10493,15 +12994,18 @@ margin-bottom: 20px;
},
"windSpeed" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Wind speed for Map aircraft state."
},
"windDirection" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Wind direction for Map aircraft state."
},
"staticAirTemperature" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Static air temperature for Map aircraft state."
}
},
"description" : "Aircraft state for PFD/ND"
@@ -10514,11 +13018,15 @@ margin-bottom: 20px;
},
"reverse" : {
"type" : "integer",
- "description" : "(0 - Forward, 1 - Reverse)"
+ "description" : "(0 - Forward, 1 - Reverse)",
+ "minimum" : 0,
+ "maximum" : 1
},
"loop" : {
"type" : "integer",
- "description" : "(0 - Play once, 1 - Play in loop)"
+ "description" : "(0 - Play once, 1 - Play in loop)",
+ "minimum" : 0,
+ "maximum" : 1
},
"startDateTime" : {
"type" : "string",
@@ -10554,12 +13062,16 @@ margin-bottom: 20px;
"latitude" : {
"type" : "number",
"format" : "float",
- "description" : "Latitude in decimal degrees, positive to the North"
+ "description" : "Latitude in decimal degrees, positive to the North",
+ "minimum" : -90,
+ "maximum" : 90
},
"longitude" : {
"type" : "number",
"format" : "float",
- "description" : "Longitude in decimal degrees, positive to the East"
+ "description" : "Longitude in decimal degrees, positive to the East",
+ "minimum" : -180,
+ "maximum" : 180
},
"altitude" : {
"type" : "number",
@@ -10595,12 +13107,16 @@ margin-bottom: 20px;
"latitude" : {
"type" : "number",
"format" : "float",
- "description" : "Latitude in decimal degrees, positive to the North"
+ "description" : "Latitude in decimal degrees, positive to the North",
+ "minimum" : -90,
+ "maximum" : 90
},
"longitude" : {
"type" : "number",
"format" : "float",
- "description" : "Longitude in decimal degrees, positive to the East"
+ "description" : "Longitude in decimal degrees, positive to the East",
+ "minimum" : -180,
+ "maximum" : 180
},
"altitude" : {
"type" : "number",
@@ -10609,7 +13125,9 @@ margin-bottom: 20px;
},
"fixedPosition" : {
"type" : "integer",
- "description" : "Indicates whether position of item is constant with time (0 - variable, 1 - fixed)"
+ "description" : "Indicates whether position of item is constant with time (0 - variable, 1 - fixed)",
+ "minimum" : 0,
+ "maximum" : 1
},
"positionDateTime" : {
"type" : "string",
@@ -10639,7 +13157,9 @@ margin-bottom: 20px;
},
"orientation" : {
"type" : "integer",
- "description" : "How to orientate the model (0 - Along direction of motion, 1 - Use heading, pitch and roll)"
+ "description" : "How to orientate the model (0 - Along direction of motion, 1 - Use heading, pitch and roll)",
+ "minimum" : 0,
+ "maximum" : 1
},
"heading" : {
"type" : "number",
@@ -10680,7 +13200,9 @@ margin-bottom: 20px;
},
"altitudeReference" : {
"type" : "integer",
- "description" : "0 - NONE (Absolute), 1 - CLAMP_TO_GROUND, 2 - RELATIVE_TO_GROUND, 3 - CLIP_TO_GROUND."
+ "description" : "0 - NONE (Absolute), 1 - CLAMP_TO_GROUND, 2 - RELATIVE_TO_GROUND, 3 - CLIP_TO_GROUND.",
+ "minimum" : 0,
+ "maximum" : 3
},
"animations" : {
"type" : "array",
@@ -10691,23 +13213,29 @@ margin-bottom: 20px;
},
"type" : {
"type" : "integer",
- "description" : "(0 - Map Item, 1 - Image Tile, 2 - Polygon, 3 - Polyline)"
+ "description" : "(0 - Map Item, 1 - Image Tile, 2 - Polygon, 3 - Polyline)",
+ "minimum" : 0,
+ "maximum" : 3
},
"imageTileWest" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Image tile west for Map item."
},
"imageTileSouth" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Image tile south for Map item."
},
"imageTileEast" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Image tile east for Map item."
},
"imageTileNorth" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Image tile north for Map item."
},
"imageZoomLevel" : {
"type" : "number",
@@ -10736,13 +13264,16 @@ margin-bottom: 20px;
},
"colorValid" : {
"type" : "integer",
- "description" : "0 - Use default color, 1 - Use specified color"
+ "description" : "0 - Use default color, 1 - Use specified color",
+ "minimum" : 0,
+ "maximum" : 1
},
"color" : {
"type" : "integer",
"description" : "RGBA for polygon and polyline"
},
"aircraftState" : {
+ "description" : "Current states of aircraft tracked by the ADS-B demodulator.",
"$ref" : "#/definitions/MapAircraftState"
}
},
@@ -10770,12 +13301,16 @@ margin-bottom: 20px;
"latitude" : {
"type" : "number",
"format" : "float",
- "description" : "Latitude in decimal degrees, positive to the North"
+ "description" : "Latitude in decimal degrees, positive to the North",
+ "minimum" : -90,
+ "maximum" : 90
},
"longitude" : {
"type" : "number",
"format" : "float",
- "description" : "Longitude in decimal degrees, positive to the East"
+ "description" : "Longitude in decimal degrees, positive to the East",
+ "minimum" : -180,
+ "maximum" : 180
},
"altitude" : {
"type" : "number",
@@ -10784,7 +13319,9 @@ margin-bottom: 20px;
},
"fixedPosition" : {
"type" : "integer",
- "description" : "Indicates whether position of item is constant with time (0 - variable, 1 - fixed)"
+ "description" : "Indicates whether position of item is constant with time (0 - variable, 1 - fixed)",
+ "minimum" : 0,
+ "maximum" : 1
},
"positionDateTime" : {
"type" : "string",
@@ -10814,7 +13351,9 @@ margin-bottom: 20px;
},
"orientation" : {
"type" : "integer",
- "description" : "How to orientate the model (0 - Along direction of motion, 1 - Use heading, pitch and roll)"
+ "description" : "How to orientate the model (0 - Along direction of motion, 1 - Use heading, pitch and roll)",
+ "minimum" : 0,
+ "maximum" : 1
},
"heading" : {
"type" : "number",
@@ -10855,7 +13394,9 @@ margin-bottom: 20px;
},
"altitudeReference" : {
"type" : "integer",
- "description" : "0 - NONE (Absolute), 1 - CLAMP_TO_GROUND, 2 - RELATIVE_TO_GROUND, 3 - CLIP_TO_GROUND."
+ "description" : "0 - NONE (Absolute), 1 - CLAMP_TO_GROUND, 2 - RELATIVE_TO_GROUND, 3 - CLIP_TO_GROUND.",
+ "minimum" : 0,
+ "maximum" : 3
},
"animations" : {
"type" : "array",
@@ -10866,23 +13407,29 @@ margin-bottom: 20px;
},
"type" : {
"type" : "integer",
- "description" : "(0 - Map Item, 1 - Image Tile, 2 - Polygon, 3 - Polyline)"
+ "description" : "(0 - Map Item, 1 - Image Tile, 2 - Polygon, 3 - Polyline)",
+ "minimum" : 0,
+ "maximum" : 3
},
"imageTileWest" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Image tile west for Map item."
},
"imageTileSouth" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Image tile south for Map item."
},
"imageTileEast" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Image tile east for Map item."
},
"imageTileNorth" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Image tile north for Map item."
},
"imageZoomLevel" : {
"type" : "number",
@@ -10911,13 +13458,16 @@ margin-bottom: 20px;
},
"colorValid" : {
"type" : "integer",
- "description" : "0 - Use default color, 1 - Use specified color"
+ "description" : "0 - Use default color, 1 - Use specified color",
+ "minimum" : 0,
+ "maximum" : 1
},
"color" : {
"type" : "integer",
"description" : "RGBA for polygon and polyline"
},
"aircraftState" : {
+ "description" : "Current states of aircraft tracked by the ADS-B demodulator.",
"$ref" : "#/definitions/MapAircraftState"
}
},
@@ -10943,28 +13493,39 @@ margin-bottom: 20px;
"description" : "Terrain used for 3D map (E.g: 'Ellipsoid' or 'Cesium World Terrain')"
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIFeatureSetIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Feature-set index used by the reverse API peer."
},
"reverseAPIFeatureIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Feature index used by the reverse API peer."
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -10993,7 +13554,8 @@ margin-bottom: 20px;
"description" : "last message de-chirped signal to noise ratio power (dB)"
},
"channelSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Effective sample rate delivered to the channel in samples per second."
},
"syncWord" : {
"type" : "integer",
@@ -11017,7 +13579,9 @@ margin-bottom: 20px;
},
"headerParityStatus" : {
"type" : "integer",
- "description" : "Header FEC parity status:\n * 0 - Undefined\n * 1 - Uncorrectable error\n * 2 - Corrected error\n * 3 - OK\n"
+ "description" : "Header FEC parity status:\n * 0 - Undefined\n * 1 - Uncorrectable error\n * 2 - Corrected error\n * 3 - OK\n",
+ "minimum" : 0,
+ "maximum" : 3
},
"headerCRCStatus" : {
"type" : "integer",
@@ -11025,7 +13589,9 @@ margin-bottom: 20px;
},
"payloadParityStatus" : {
"type" : "integer",
- "description" : "Payload FEC parity status:\n * 0 - Undefined\n * 1 - Uncorrectable error\n * 2 - Corrected error\n * 3 - OK\n"
+ "description" : "Payload FEC parity status:\n * 0 - Undefined\n * 1 - Uncorrectable error\n * 2 - Corrected error\n * 3 - OK\n",
+ "minimum" : 0,
+ "maximum" : 3
},
"payloadCRCStatus" : {
"type" : "integer",
@@ -11056,7 +13622,9 @@ margin-bottom: 20px;
},
"decoding" : {
"type" : "integer",
- "description" : "Boolean - decoding status\n * 0 - no decoding\n * 1 - decoding\n"
+ "description" : "Boolean - decoding status\n * 0 - no decoding\n * 1 - decoding\n",
+ "minimum" : 0,
+ "maximum" : 1
}
},
"description" : "MeshcoreDemod"
@@ -11065,14 +13633,18 @@ margin-bottom: 20px;
"properties" : {
"inputFrequencyOffset" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Channel frequency offset from the device center frequency in Hz."
},
"bandwidthIndex" : {
"type" : "integer",
- "description" : "standard bandwidths index:\n * 0 - 375 Hz (384000 / 1024)\n * 1 - 750 Hz (384000 / 512)\n * 2 - 1500 Hz (384000 / 256)\n * 3 - 2604 Hz (333333 / 128)\n * 4 - 3125 Hz (400000 / 128)\n * 5 - 3906 Hz (500000 / 128)\n * 6 - 5208 Hz (333333 / 64)\n * 7 - 6250 Hz (400000 / 64)\n * 8 - 7813 Hz (500000 / 64)\n * 9 - 10417 Hz (333333 / 32)\n * 10 - 12500 Hz (400000 / 32)\n * 11 - 15625 Hz (500000 / 32)\n * 12 - 20833 Hz (333333 / 16)\n * 13 - 25000 Hz (400000 / 16)\n * 14 - 31250 Hz (500000 / 16)\n * 15 - 41667 Hz (333333 / 8)\n * 16 - 50000 Hz (400000 / 8)\n * 17 - 62500 Hz (500000 / 8)\n * 18 - 83333 Hz (333333 / 4)\n * 19 - 100000 Hz (400000 / 4)\n * 20 - 125000 Hz (500000 / 4)\n * 21 - 166667 Hz (333333 / 2)\n * 22 - 200000 Hz (400000 / 2)\n * 23 - 250000 Hz (500000 / 2)\n * 24 - 333333 Hz (333333 / 1)\n * 25 - 400000 Hz (400000 / 1)\n * 26 - 500000 Hz (500000 / 1)\n"
+ "description" : "standard bandwidths index:\n * 0 - 375 Hz (384000 / 1024)\n * 1 - 750 Hz (384000 / 512)\n * 2 - 1500 Hz (384000 / 256)\n * 3 - 2604 Hz (333333 / 128)\n * 4 - 3125 Hz (400000 / 128)\n * 5 - 3906 Hz (500000 / 128)\n * 6 - 5208 Hz (333333 / 64)\n * 7 - 6250 Hz (400000 / 64)\n * 8 - 7813 Hz (500000 / 64)\n * 9 - 10417 Hz (333333 / 32)\n * 10 - 12500 Hz (400000 / 32)\n * 11 - 15625 Hz (500000 / 32)\n * 12 - 20833 Hz (333333 / 16)\n * 13 - 25000 Hz (400000 / 16)\n * 14 - 31250 Hz (500000 / 16)\n * 15 - 41667 Hz (333333 / 8)\n * 16 - 50000 Hz (400000 / 8)\n * 17 - 62500 Hz (500000 / 8)\n * 18 - 83333 Hz (333333 / 4)\n * 19 - 100000 Hz (400000 / 4)\n * 20 - 125000 Hz (500000 / 4)\n * 21 - 166667 Hz (333333 / 2)\n * 22 - 200000 Hz (400000 / 2)\n * 23 - 250000 Hz (500000 / 2)\n * 24 - 333333 Hz (333333 / 1)\n * 25 - 400000 Hz (400000 / 1)\n * 26 - 500000 Hz (500000 / 1)\n",
+ "minimum" : 0,
+ "maximum" : 26
},
"spreadFactor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Spread factor setting for Meshcore demod."
},
"deBits" : {
"type" : "integer",
@@ -11080,7 +13652,9 @@ margin-bottom: 20px;
},
"decodeActive" : {
"type" : "integer",
- "description" : "boolean 1 to activate 0 to de-activate decoder"
+ "description" : "boolean 1 to activate 0 to de-activate decoder",
+ "minimum" : 0,
+ "maximum" : 1
},
"eomSquelchTenths" : {
"type" : "integer",
@@ -11104,15 +13678,21 @@ margin-bottom: 20px;
},
"sendViaUDP" : {
"type" : "integer",
- "description" : "boolean 1 to send decoded message via UDP else 0"
+ "description" : "boolean 1 to send decoded message via UDP else 0",
+ "minimum" : 0,
+ "maximum" : 1
},
"sendJsonViaUDP" : {
"type" : "integer",
- "description" : "boolean 1 to send decoded message as JSON via UDP else 0"
+ "description" : "boolean 1 to send decoded message as JSON via UDP else 0",
+ "minimum" : 0,
+ "maximum" : 1
},
"udpEnabled" : {
"type" : "integer",
- "description" : "Boolean - Send via UDP\n * 0 - Do not send decoded messages via UDP\n * 1 - Send decoded messages via UDP\n"
+ "description" : "Boolean - Send via UDP\n * 0 - Do not send decoded messages via UDP\n * 1 - Send decoded messages via UDP\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"udpAddress" : {
"type" : "string",
@@ -11120,17 +13700,23 @@ margin-bottom: 20px;
},
"udpPort" : {
"type" : "integer",
- "description" : "UDP destination port"
+ "description" : "UDP destination port",
+ "minimum" : 1,
+ "maximum" : 65535
},
"invertRamps" : {
"type" : "integer",
- "description" : "Invert chirp ramps\n * 0 - Normal chirp ramps (upchirps for preamble and payload)\n * 1 - Inverted chirp ramps (downchirps for preamble and payload)\n"
+ "description" : "Invert chirp ramps\n * 0 - Normal chirp ramps (upchirps for preamble and payload)\n * 1 - Inverted chirp ramps (downchirps for preamble and payload)\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"streamIndex" : {
"type" : "integer",
@@ -11138,27 +13724,38 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"spectrumConfig" : {
+ "description" : "Spectrum-display configuration.",
"$ref" : "#/definitions/GLSpectrum"
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -11168,7 +13765,9 @@ margin-bottom: 20px;
"properties" : {
"sendNow" : {
"type" : "integer",
- "description" : "Send packet immediately\n * 0 - Do nothing\n * 1 - Send packet\n"
+ "description" : "Send packet immediately\n * 0 - Do nothing\n * 1 - Send packet\n",
+ "minimum" : 0,
+ "maximum" : 1
}
},
"description" : "MeshcoreMod"
@@ -11181,7 +13780,8 @@ margin-bottom: 20px;
"description" : "power transmitted in channel (dB)"
},
"channelSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Effective sample rate delivered to the channel in samples per second."
},
"symbolTimeMs" : {
"type" : "number",
@@ -11200,7 +13800,9 @@ margin-bottom: 20px;
},
"playing" : {
"type" : "integer",
- "description" : "Boolean - modulator is active (playing) including idle time\n * 0 - Modulator not active\n * 1 - Modulator active\n"
+ "description" : "Boolean - modulator is active (playing) including idle time\n * 0 - Modulator not active\n * 1 - Modulator active\n",
+ "minimum" : 0,
+ "maximum" : 1
}
},
"description" : "MeshcoreMod"
@@ -11209,14 +13811,18 @@ margin-bottom: 20px;
"properties" : {
"inputFrequencyOffset" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Channel frequency offset from the device center frequency in Hz."
},
"bandwidthIndex" : {
"type" : "integer",
- "description" : "standard bandwidths index:\n * 0 - 375 Hz (384000 / 1024)\n * 1 - 750 Hz (384000 / 512)\n * 2 - 1500 Hz (384000 / 256)\n * 3 - 2604 Hz (333333 / 128)\n * 4 - 3125 Hz (400000 / 128)\n * 5 - 3906 Hz (500000 / 128)\n * 6 - 5208 Hz (333333 / 64)\n * 7 - 6250 Hz (400000 / 64)\n * 8 - 7813 Hz (500000 / 64)\n * 9 - 10417 Hz (333333 / 32)\n * 10 - 12500 Hz (400000 / 32)\n * 11 - 15625 Hz (500000 / 32)\n * 12 - 20833 Hz (333333 / 16)\n * 13 - 25000 Hz (400000 / 16)\n * 14 - 31250 Hz (500000 / 16)\n * 15 - 41667 Hz (333333 / 8)\n * 16 - 50000 Hz (400000 / 8)\n * 17 - 62500 Hz (500000 / 8)\n * 18 - 83333 Hz (333333 / 4)\n * 19 - 100000 Hz (400000 / 4)\n * 20 - 125000 Hz (500000 / 4)\n * 21 - 166667 Hz (333333 / 2)\n * 22 - 200000 Hz (400000 / 2)\n * 23 - 250000 Hz (500000 / 2)\n * 24 - 333333 Hz (333333 / 1)\n * 25 - 400000 Hz (400000 / 1)\n * 26 - 500000 Hz (500000 / 1)\n"
+ "description" : "standard bandwidths index:\n * 0 - 375 Hz (384000 / 1024)\n * 1 - 750 Hz (384000 / 512)\n * 2 - 1500 Hz (384000 / 256)\n * 3 - 2604 Hz (333333 / 128)\n * 4 - 3125 Hz (400000 / 128)\n * 5 - 3906 Hz (500000 / 128)\n * 6 - 5208 Hz (333333 / 64)\n * 7 - 6250 Hz (400000 / 64)\n * 8 - 7813 Hz (500000 / 64)\n * 9 - 10417 Hz (333333 / 32)\n * 10 - 12500 Hz (400000 / 32)\n * 11 - 15625 Hz (500000 / 32)\n * 12 - 20833 Hz (333333 / 16)\n * 13 - 25000 Hz (400000 / 16)\n * 14 - 31250 Hz (500000 / 16)\n * 15 - 41667 Hz (333333 / 8)\n * 16 - 50000 Hz (400000 / 8)\n * 17 - 62500 Hz (500000 / 8)\n * 18 - 83333 Hz (333333 / 4)\n * 19 - 100000 Hz (400000 / 4)\n * 20 - 125000 Hz (500000 / 4)\n * 21 - 166667 Hz (333333 / 2)\n * 22 - 200000 Hz (400000 / 2)\n * 23 - 250000 Hz (500000 / 2)\n * 24 - 333333 Hz (333333 / 1)\n * 25 - 400000 Hz (400000 / 1)\n * 26 - 500000 Hz (500000 / 1)\n",
+ "minimum" : 0,
+ "maximum" : 26
},
"spreadFactor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Spread factor setting for Meshcore mod."
},
"deBits" : {
"type" : "integer",
@@ -11236,7 +13842,9 @@ margin-bottom: 20px;
},
"channelMute" : {
"type" : "integer",
- "description" : "boolean"
+ "description" : "boolean",
+ "minimum" : 0,
+ "maximum" : 1
},
"nbParityBits" : {
"type" : "integer",
@@ -11252,7 +13860,9 @@ margin-bottom: 20px;
},
"udpEnabled" : {
"type" : "integer",
- "description" : "boolean 1 to enable forwarding messages via UDP else 0"
+ "description" : "boolean 1 to enable forwarding messages via UDP else 0",
+ "minimum" : 0,
+ "maximum" : 1
},
"udpAddress" : {
"type" : "string",
@@ -11260,17 +13870,23 @@ margin-bottom: 20px;
},
"udpPort" : {
"type" : "integer",
- "description" : "UDP port to listen for messages to transmit on"
+ "description" : "UDP port to listen for messages to transmit on",
+ "minimum" : 1,
+ "maximum" : 65535
},
"invertRamps" : {
"type" : "integer",
- "description" : "Invert chirp ramps\n * 0 - Normal chirp ramps (upchirps for preamble and payload)\n * 1 - Inverted chirp ramps (downchirps for preamble and payload)\n"
+ "description" : "Invert chirp ramps\n * 0 - Normal chirp ramps (upchirps for preamble and payload)\n * 1 - Inverted chirp ramps (downchirps for preamble and payload)\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"streamIndex" : {
"type" : "integer",
@@ -11278,24 +13894,34 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -11324,7 +13950,8 @@ margin-bottom: 20px;
"description" : "last message de-chirped signal to noise ratio power (dB)"
},
"channelSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Effective sample rate delivered to the channel in samples per second."
},
"syncWord" : {
"type" : "integer",
@@ -11348,7 +13975,9 @@ margin-bottom: 20px;
},
"headerParityStatus" : {
"type" : "integer",
- "description" : "Header FEC parity status:\n * 0 - Undefined\n * 1 - Uncorrectable error\n * 2 - Corrected error\n * 3 - OK\n"
+ "description" : "Header FEC parity status:\n * 0 - Undefined\n * 1 - Uncorrectable error\n * 2 - Corrected error\n * 3 - OK\n",
+ "minimum" : 0,
+ "maximum" : 3
},
"headerCRCStatus" : {
"type" : "integer",
@@ -11356,7 +13985,9 @@ margin-bottom: 20px;
},
"payloadParityStatus" : {
"type" : "integer",
- "description" : "Payload FEC parity status:\n * 0 - Undefined\n * 1 - Uncorrectable error\n * 2 - Corrected error\n * 3 - OK\n"
+ "description" : "Payload FEC parity status:\n * 0 - Undefined\n * 1 - Uncorrectable error\n * 2 - Corrected error\n * 3 - OK\n",
+ "minimum" : 0,
+ "maximum" : 3
},
"payloadCRCStatus" : {
"type" : "integer",
@@ -11387,7 +14018,9 @@ margin-bottom: 20px;
},
"decoding" : {
"type" : "integer",
- "description" : "Boolean - decoding status\n * 0 - no decoding\n * 1 - decoding\n"
+ "description" : "Boolean - decoding status\n * 0 - no decoding\n * 1 - decoding\n",
+ "minimum" : 0,
+ "maximum" : 1
}
},
"description" : "MeshtasticDemod"
@@ -11396,14 +14029,18 @@ margin-bottom: 20px;
"properties" : {
"inputFrequencyOffset" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Channel frequency offset from the device center frequency in Hz."
},
"bandwidthIndex" : {
"type" : "integer",
- "description" : "standard bandwidths index:\n * 0 - 375 Hz (384000 / 1024)\n * 1 - 750 Hz (384000 / 512)\n * 2 - 1500 Hz (384000 / 256)\n * 3 - 2604 Hz (333333 / 128)\n * 4 - 3125 Hz (400000 / 128)\n * 5 - 3906 Hz (500000 / 128)\n * 6 - 5208 Hz (333333 / 64)\n * 7 - 6250 Hz (400000 / 64)\n * 8 - 7813 Hz (500000 / 64)\n * 9 - 10417 Hz (333333 / 32)\n * 10 - 12500 Hz (400000 / 32)\n * 11 - 15625 Hz (500000 / 32)\n * 12 - 20833 Hz (333333 / 16)\n * 13 - 25000 Hz (400000 / 16)\n * 14 - 31250 Hz (500000 / 16)\n * 15 - 41667 Hz (333333 / 8)\n * 16 - 50000 Hz (400000 / 8)\n * 17 - 62500 Hz (500000 / 8)\n * 18 - 83333 Hz (333333 / 4)\n * 19 - 100000 Hz (400000 / 4)\n * 20 - 125000 Hz (500000 / 4)\n * 21 - 166667 Hz (333333 / 2)\n * 22 - 200000 Hz (400000 / 2)\n * 23 - 250000 Hz (500000 / 2)\n * 24 - 333333 Hz (333333 / 1)\n * 25 - 400000 Hz (400000 / 1)\n * 26 - 500000 Hz (500000 / 1)\n"
+ "description" : "standard bandwidths index:\n * 0 - 375 Hz (384000 / 1024)\n * 1 - 750 Hz (384000 / 512)\n * 2 - 1500 Hz (384000 / 256)\n * 3 - 2604 Hz (333333 / 128)\n * 4 - 3125 Hz (400000 / 128)\n * 5 - 3906 Hz (500000 / 128)\n * 6 - 5208 Hz (333333 / 64)\n * 7 - 6250 Hz (400000 / 64)\n * 8 - 7813 Hz (500000 / 64)\n * 9 - 10417 Hz (333333 / 32)\n * 10 - 12500 Hz (400000 / 32)\n * 11 - 15625 Hz (500000 / 32)\n * 12 - 20833 Hz (333333 / 16)\n * 13 - 25000 Hz (400000 / 16)\n * 14 - 31250 Hz (500000 / 16)\n * 15 - 41667 Hz (333333 / 8)\n * 16 - 50000 Hz (400000 / 8)\n * 17 - 62500 Hz (500000 / 8)\n * 18 - 83333 Hz (333333 / 4)\n * 19 - 100000 Hz (400000 / 4)\n * 20 - 125000 Hz (500000 / 4)\n * 21 - 166667 Hz (333333 / 2)\n * 22 - 200000 Hz (400000 / 2)\n * 23 - 250000 Hz (500000 / 2)\n * 24 - 333333 Hz (333333 / 1)\n * 25 - 400000 Hz (400000 / 1)\n * 26 - 500000 Hz (500000 / 1)\n",
+ "minimum" : 0,
+ "maximum" : 26
},
"spreadFactor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Spread factor setting for Meshtastic demod."
},
"deBits" : {
"type" : "integer",
@@ -11411,7 +14048,9 @@ margin-bottom: 20px;
},
"decodeActive" : {
"type" : "integer",
- "description" : "boolean 1 to activate 0 to de-activate decoder"
+ "description" : "boolean 1 to activate 0 to de-activate decoder",
+ "minimum" : 0,
+ "maximum" : 1
},
"eomSquelchTenths" : {
"type" : "integer",
@@ -11435,15 +14074,21 @@ margin-bottom: 20px;
},
"sendViaUDP" : {
"type" : "integer",
- "description" : "boolean 1 to send decoded message via UDP else 0"
+ "description" : "boolean 1 to send decoded message via UDP else 0",
+ "minimum" : 0,
+ "maximum" : 1
},
"sendJsonViaUDP" : {
"type" : "integer",
- "description" : "boolean 1 to send decoded message as JSON via UDP else 0"
+ "description" : "boolean 1 to send decoded message as JSON via UDP else 0",
+ "minimum" : 0,
+ "maximum" : 1
},
"udpEnabled" : {
"type" : "integer",
- "description" : "Boolean - Send via UDP\n * 0 - Do not send decoded messages via UDP\n * 1 - Send decoded messages via UDP\n"
+ "description" : "Boolean - Send via UDP\n * 0 - Do not send decoded messages via UDP\n * 1 - Send decoded messages via UDP\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"udpAddress" : {
"type" : "string",
@@ -11451,17 +14096,23 @@ margin-bottom: 20px;
},
"udpPort" : {
"type" : "integer",
- "description" : "UDP destination port"
+ "description" : "UDP destination port",
+ "minimum" : 1,
+ "maximum" : 65535
},
"invertRamps" : {
"type" : "integer",
- "description" : "Invert chirp ramps\n * 0 - Normal chirp ramps (upchirps for preamble and payload)\n * 1 - Inverted chirp ramps (downchirps for preamble and payload)\n"
+ "description" : "Invert chirp ramps\n * 0 - Normal chirp ramps (upchirps for preamble and payload)\n * 1 - Inverted chirp ramps (downchirps for preamble and payload)\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"streamIndex" : {
"type" : "integer",
@@ -11469,27 +14120,38 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"spectrumConfig" : {
+ "description" : "Spectrum-display configuration.",
"$ref" : "#/definitions/GLSpectrum"
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -11503,7 +14165,8 @@ margin-bottom: 20px;
"description" : "power transmitted in channel (dB)"
},
"channelSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Effective sample rate delivered to the channel in samples per second."
},
"symbolTimeMs" : {
"type" : "number",
@@ -11522,7 +14185,9 @@ margin-bottom: 20px;
},
"playing" : {
"type" : "integer",
- "description" : "Boolean - modulator is active (playing) including idle time\n * 0 - Modulator not active\n * 1 - Modulator active\n"
+ "description" : "Boolean - modulator is active (playing) including idle time\n * 0 - Modulator not active\n * 1 - Modulator active\n",
+ "minimum" : 0,
+ "maximum" : 1
}
},
"description" : "MeshtasticMod"
@@ -11531,14 +14196,18 @@ margin-bottom: 20px;
"properties" : {
"inputFrequencyOffset" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Channel frequency offset from the device center frequency in Hz."
},
"bandwidthIndex" : {
"type" : "integer",
- "description" : "standard bandwidths index:\n * 0 - 375 Hz (384000 / 1024)\n * 1 - 750 Hz (384000 / 512)\n * 2 - 1500 Hz (384000 / 256)\n * 3 - 2604 Hz (333333 / 128)\n * 4 - 3125 Hz (400000 / 128)\n * 5 - 3906 Hz (500000 / 128)\n * 6 - 5208 Hz (333333 / 64)\n * 7 - 6250 Hz (400000 / 64)\n * 8 - 7813 Hz (500000 / 64)\n * 9 - 10417 Hz (333333 / 32)\n * 10 - 12500 Hz (400000 / 32)\n * 11 - 15625 Hz (500000 / 32)\n * 12 - 20833 Hz (333333 / 16)\n * 13 - 25000 Hz (400000 / 16)\n * 14 - 31250 Hz (500000 / 16)\n * 15 - 41667 Hz (333333 / 8)\n * 16 - 50000 Hz (400000 / 8)\n * 17 - 62500 Hz (500000 / 8)\n * 18 - 83333 Hz (333333 / 4)\n * 19 - 100000 Hz (400000 / 4)\n * 20 - 125000 Hz (500000 / 4)\n * 21 - 166667 Hz (333333 / 2)\n * 22 - 200000 Hz (400000 / 2)\n * 23 - 250000 Hz (500000 / 2)\n * 24 - 333333 Hz (333333 / 1)\n * 25 - 400000 Hz (400000 / 1)\n * 26 - 500000 Hz (500000 / 1)\n"
+ "description" : "standard bandwidths index:\n * 0 - 375 Hz (384000 / 1024)\n * 1 - 750 Hz (384000 / 512)\n * 2 - 1500 Hz (384000 / 256)\n * 3 - 2604 Hz (333333 / 128)\n * 4 - 3125 Hz (400000 / 128)\n * 5 - 3906 Hz (500000 / 128)\n * 6 - 5208 Hz (333333 / 64)\n * 7 - 6250 Hz (400000 / 64)\n * 8 - 7813 Hz (500000 / 64)\n * 9 - 10417 Hz (333333 / 32)\n * 10 - 12500 Hz (400000 / 32)\n * 11 - 15625 Hz (500000 / 32)\n * 12 - 20833 Hz (333333 / 16)\n * 13 - 25000 Hz (400000 / 16)\n * 14 - 31250 Hz (500000 / 16)\n * 15 - 41667 Hz (333333 / 8)\n * 16 - 50000 Hz (400000 / 8)\n * 17 - 62500 Hz (500000 / 8)\n * 18 - 83333 Hz (333333 / 4)\n * 19 - 100000 Hz (400000 / 4)\n * 20 - 125000 Hz (500000 / 4)\n * 21 - 166667 Hz (333333 / 2)\n * 22 - 200000 Hz (400000 / 2)\n * 23 - 250000 Hz (500000 / 2)\n * 24 - 333333 Hz (333333 / 1)\n * 25 - 400000 Hz (400000 / 1)\n * 26 - 500000 Hz (500000 / 1)\n",
+ "minimum" : 0,
+ "maximum" : 26
},
"spreadFactor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Spread factor setting for Meshtastic mod."
},
"deBits" : {
"type" : "integer",
@@ -11558,7 +14227,9 @@ margin-bottom: 20px;
},
"channelMute" : {
"type" : "integer",
- "description" : "boolean"
+ "description" : "boolean",
+ "minimum" : 0,
+ "maximum" : 1
},
"nbParityBits" : {
"type" : "integer",
@@ -11574,7 +14245,9 @@ margin-bottom: 20px;
},
"udpEnabled" : {
"type" : "integer",
- "description" : "boolean 1 to enable forwarding messages via UDP else 0"
+ "description" : "boolean 1 to enable forwarding messages via UDP else 0",
+ "minimum" : 0,
+ "maximum" : 1
},
"udpAddress" : {
"type" : "string",
@@ -11582,17 +14255,23 @@ margin-bottom: 20px;
},
"udpPort" : {
"type" : "integer",
- "description" : "UDP port to listen for messages to transmit on"
+ "description" : "UDP port to listen for messages to transmit on",
+ "minimum" : 1,
+ "maximum" : 65535
},
"invertRamps" : {
"type" : "integer",
- "description" : "Invert chirp ramps\n * 0 - Normal chirp ramps (upchirps for preamble and payload)\n * 1 - Inverted chirp ramps (downchirps for preamble and payload)\n"
+ "description" : "Invert chirp ramps\n * 0 - Normal chirp ramps (upchirps for preamble and payload)\n * 1 - Inverted chirp ramps (downchirps for preamble and payload)\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"streamIndex" : {
"type" : "integer",
@@ -11600,24 +14279,34 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -11626,7 +14315,8 @@ margin-bottom: 20px;
defs.MetisMISOSettings = {
"properties" : {
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"nbReceivers" : {
"type" : "integer",
@@ -11634,7 +14324,9 @@ margin-bottom: 20px;
},
"txEnable" : {
"type" : "integer",
- "description" : "Enable Tx * 0 - disabled sends null payload to Metis device * 1 - enabled sends Tx payload to Metis device\n"
+ "description" : "Enable Tx * 0 - disabled sends null payload to Metis device * 1 - enabled sends Tx payload to Metis device\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"rx1CenterFrequency" : {
"type" : "integer",
@@ -11678,27 +14370,36 @@ margin-bottom: 20px;
},
"txCenterFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Transmit center frequency in Hz."
},
"rxTransverterMode" : {
"type" : "integer",
- "description" : "Rx transverter activated * 0 - disabled * 1 - enabled\n"
+ "description" : "Rx transverter activated * 0 - disabled * 1 - enabled\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"rxTransverterDeltaFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Receive frequency translation applied in transverter mode in Hz."
},
"txTransverterMode" : {
"type" : "integer",
- "description" : "Tx transverter activated * 0 - disabled * 1 - enabled\n"
+ "description" : "Tx transverter activated * 0 - disabled * 1 - enabled\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"txTransverterDeltaFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Transmit frequency translation applied in transverter mode in Hz."
},
"iqOrder" : {
"type" : "integer",
- "description" : "I/Q samples order * 0 - I then Q (direct) * 1 - Q then I (reversed)\n"
+ "description" : "I/Q samples order * 0 - I then Q (direct) * 1 - Q then I (reversed)\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"rx1SubsamplingIndex" : {
"type" : "integer",
@@ -11733,10 +14434,12 @@ margin-bottom: 20px;
"description" : "subsampling band indexes of receiver 8"
},
"sampleRateIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Selected sample rate index."
},
"log2Decim" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent of the software decimation factor; the output sample rate is divided by 2^log2Decim."
},
"LOppmTenths" : {
"type" : "integer",
@@ -11744,27 +14447,39 @@ margin-bottom: 20px;
},
"preamp" : {
"type" : "integer",
- "description" : "Preamplifer * 0 - disabled * 1 - enabled\n"
+ "description" : "Preamplifer * 0 - disabled * 1 - enabled\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"random" : {
"type" : "integer",
- "description" : "LT2208 Random * 0 - disabled * 1 - enabled\n"
+ "description" : "LT2208 Random * 0 - disabled * 1 - enabled\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"dither" : {
"type" : "integer",
- "description" : "LT2208 Dither * 0 - disabled * 1 - enabled\n"
+ "description" : "LT2208 Dither * 0 - disabled * 1 - enabled\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"duplex" : {
"type" : "integer",
- "description" : "Duplex * 0 - disabled * 1 - enabled\n"
+ "description" : "Duplex * 0 - disabled * 1 - enabled\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"dcBlock" : {
"type" : "integer",
- "description" : "DC block in software * 0 - disabled * 1 - enabled\n"
+ "description" : "DC block in software * 0 - disabled * 1 - enabled\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"iqCorrection" : {
"type" : "integer",
- "description" : "DC block in software * 0 - disabled * 1 - enabled\n"
+ "description" : "DC block in software * 0 - disabled * 1 - enabled\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"txDrive" : {
"type" : "integer",
@@ -11780,24 +14495,35 @@ margin-bottom: 20px;
},
"streamLock" : {
"type" : "integer",
- "description" : "Ties together the stream selection and spectrum source stream selections * 0 - stream unlocked * 1 - stream locked\n"
+ "description" : "Ties together the stream selection and spectrum source stream selections * 0 - stream unlocked * 1 - stream locked\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"rxLock" : {
"type" : "integer",
- "description" : "Ties together all Rx frequencies * 0 - Rx frequencies untied * 1 - Rx frequencies tied\n"
+ "description" : "Ties together all Rx frequencies * 0 - Rx frequencies untied * 1 - Rx frequencies tied\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API * 0 - disabled * 1 - enabled\n"
+ "description" : "Synchronize with reverse API * 0 - disabled * 1 - enabled\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
}
},
"description" : "MetisMISOSettings"
@@ -11819,24 +14545,34 @@ margin-bottom: 20px;
defs.MorseDecoderSettings = {
"properties" : {
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API\n * 1 - yes\n * 0 - no\n"
+ "description" : "Synchronize with reverse API\n * 1 - yes\n * 0 - no\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"udpEnabled" : {
"type" : "integer",
- "description" : "Send decoded text via UDP\n * 1 - send\n * 0 - do not send\n"
+ "description" : "Send decoded text via UDP\n * 1 - send\n * 0 - do not send\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"udpAddress" : {
"type" : "string",
@@ -11844,7 +14580,9 @@ margin-bottom: 20px;
},
"udpPort" : {
"type" : "integer",
- "description" : "Port to send text via UDP"
+ "description" : "Port to send text via UDP",
+ "minimum" : 1,
+ "maximum" : 65535
},
"logFiledName" : {
"type" : "string",
@@ -11852,26 +14590,36 @@ margin-bottom: 20px;
},
"logEnabled" : {
"type" : "integer",
- "description" : "Log decoded text to file\n * 1 - log\n * 0 - do not log\n"
+ "description" : "Log decoded text to file\n * 1 - log\n * 0 - do not log\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"auto" : {
"type" : "integer",
- "description" : "Auto detect CW pitch and keying speed\n * 1 - auto detect\n * 0 - use last values\n"
+ "description" : "Auto detect CW pitch and keying speed\n * 1 - auto detect\n * 0 - use last values\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"showThreshold" : {
"type" : "integer",
- "description" : "Show GGMorse decoder threshold on the imaginary part of the scope trace\n * 1 - show\n * 0 - do not show\n"
+ "description" : "Show GGMorse decoder threshold on the imaginary part of the scope trace\n * 1 - show\n * 0 - do not show\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIFeatureSetIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Feature-set index used by the reverse API peer."
},
"reverseAPIFeatureIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Feature index used by the reverse API peer."
},
"scopeConfig" : {
+ "description" : "Oscilloscope-display configuration.",
"$ref" : "#/definitions/GLScope"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -11894,10 +14642,12 @@ margin-bottom: 20px;
"description" : "squelch status (1 if open else 0)"
},
"audioSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Audio sample rate in samples per second."
},
"channelSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Effective sample rate delivered to the channel in samples per second."
}
},
"description" : "NFMDemod"
@@ -11920,14 +14670,16 @@ margin-bottom: 20px;
"description" : "AF bandwidth in Hz (rounds to lower kHz)"
},
"fmDeviation" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "FM frequency deviation in Hz."
},
"squelchGate" : {
"type" : "integer",
"description" : "squelch gate in tens of ms"
},
"deltaSquelch" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Delta squelch setting for Nfm demod."
},
"squelch" : {
"type" : "number",
@@ -11936,28 +14688,38 @@ margin-bottom: 20px;
},
"volume" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Audio volume multiplier."
},
"ctcssOn" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Ctcss on setting for Nfm demod."
},
"highPass" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "High pass setting for Nfm demod."
},
"audioMute" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Mute audio output (1 muted, 0 unmuted).",
+ "minimum" : 0,
+ "maximum" : 1
},
"ctcssIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Selected ctcss index."
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"audioDeviceName" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Name of the audio device to use."
},
"streamIndex" : {
"type" : "integer",
@@ -11965,24 +14727,34 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -11996,10 +14768,12 @@ margin-bottom: 20px;
"description" : "power transmitted in channel (dB)"
},
"audioSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Audio sample rate in samples per second."
},
"channelSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Effective sample rate delivered to the channel in samples per second."
}
},
"description" : "NFMMod"
@@ -12008,71 +14782,99 @@ margin-bottom: 20px;
"properties" : {
"inputFrequencyOffset" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Channel frequency offset from the device center frequency in Hz."
},
"rfBandwidth" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "RF bandwidth in Hz."
},
"afBandwidth" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Audio-frequency bandwidth in Hz."
},
"fmDeviation" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "FM frequency deviation in Hz."
},
"toneFrequency" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Tone frequency in Hz."
},
"volumeFactor" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Volume factor setting for Nfm mod."
},
"channelMute" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Mute the channel output (1 muted, 0 unmuted).",
+ "minimum" : 0,
+ "maximum" : 1
},
"playLoop" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Loop playback at end of file (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"ctcssOn" : {
"type" : "integer",
- "description" : "Enable CTCSS squelch (takes precedence on DCS) * 0 - disabled * 1 - enabled\n"
+ "description" : "Enable CTCSS squelch (takes precedence on DCS) * 0 - disabled * 1 - enabled\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"ctcssIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Selected ctcss index."
},
"dcsOn" : {
"type" : "integer",
- "description" : "Enable DCS squelch (only if CTCSS is off) * 0 - disabled * 1 - enabled\n"
+ "description" : "Enable DCS squelch (only if CTCSS is off) * 0 - disabled * 1 - enabled\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"dcsCode" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Dcs code setting for Nfm mod."
},
"dcsPositive" : {
"type" : "integer",
- "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\n"
+ "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\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"audioDeviceName" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Name of the audio device to use."
},
"modAFInput" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Audio-frequency modulation input selection."
},
"preEmphasisOn" : {
"type" : "integer",
- "description" : "Activate pre-emphasis filter: * 0 - inactive * 1 - active\n"
+ "description" : "Activate pre-emphasis filter: * 0 - inactive * 1 - active\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"bpfOn" : {
"type" : "integer",
- "description" : "Activate audio highpass filter when no CTCSS nor DCS: * 0 - inactive * 1 - active\n"
+ "description" : "Activate audio highpass filter when no CTCSS nor DCS: * 0 - inactive * 1 - active\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"streamIndex" : {
"type" : "integer",
@@ -12080,27 +14882,38 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"cwKeyer" : {
+ "description" : "CW keyer configuration.",
"$ref" : "#/definitions/CWKeyerSettings"
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -12109,10 +14922,12 @@ margin-bottom: 20px;
defs.NamedEnum = {
"properties" : {
"name" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Name."
},
"value" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Numeric enumeration value."
}
},
"description" : "Enumeration with name for values"
@@ -12125,7 +14940,8 @@ margin-bottom: 20px;
"description" : "power received in channel (dB)"
},
"channelSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Effective sample rate delivered to the channel in samples per second."
}
},
"description" : "ACARSDemod"
@@ -12134,24 +14950,31 @@ margin-bottom: 20px;
"properties" : {
"inputFrequencyOffset" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Channel frequency offset from the device center frequency in Hz."
},
"rfBandwidth" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "RF bandwidth in Hz."
},
"navArea" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Nav area setting for Navtex demod."
},
"filterStation" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Filter station setting for Navtex demod."
},
"filterType" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Filter type setting for Navtex demod."
},
"udpEnabled" : {
"type" : "integer",
- "description" : "Whether to forward received messages to specified UDP port"
+ "description" : "Whether to forward received messages to specified UDP port",
+ "minimum" : 0,
+ "maximum" : 1
},
"udpAddress" : {
"type" : "string",
@@ -12159,19 +14982,27 @@ margin-bottom: 20px;
},
"udpPort" : {
"type" : "integer",
- "description" : "UDP port to forward received messages to"
+ "description" : "UDP port to forward received messages to",
+ "minimum" : 1,
+ "maximum" : 65535
},
"logFilename" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Log file name or path."
},
"logEnabled" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable logging to the configured file (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"streamIndex" : {
"type" : "integer",
@@ -12179,27 +15010,38 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"scopeConfig" : {
+ "description" : "Oscilloscope-display configuration.",
"$ref" : "#/definitions/GLScope"
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -12213,7 +15055,8 @@ margin-bottom: 20px;
"description" : "power received in channel (dB)"
},
"channelSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Effective sample rate delivered to the channel in samples per second."
}
},
"description" : "NoiseFigure"
@@ -12222,64 +15065,82 @@ margin-bottom: 20px;
"properties" : {
"inputFrequencyOffset" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Channel frequency offset from the device center frequency in Hz."
},
"fftSize" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "FFT size in samples."
},
"fftCount" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Number of fft events or items."
},
"sweepSpec" : {
"type" : "integer",
- "description" : "(0 - Range, 1 - Step, 2 - List)"
+ "description" : "(0 - Range, 1 - Step, 2 - List)",
+ "minimum" : 0,
+ "maximum" : 2
},
"startValue" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Start value setting for Noise figure."
},
"stopValue" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Stop value setting for Noise figure."
},
"steps" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Steps setting for Noise figure."
},
"step" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Increment between adjacent supported values."
},
"list" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "List setting for Noise figure."
},
"setting" : {
"type" : "string",
"description" : "The device setting to sweep (E.g. centerFrequency or gain)"
},
"visaDevice" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Visa device setting for Noise figure."
},
"powerOnSCPI" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Power on scpi setting for Noise figure."
},
"powerOffSCPI" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Power off scpi setting for Noise figure."
},
"powerOnCommand" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Power on command setting for Noise figure."
},
"powerOffCommand" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Power off command setting for Noise figure."
},
"powerDelay" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Power delay setting for Noise figure."
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"streamIndex" : {
"type" : "integer",
@@ -12287,24 +15148,34 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -12314,7 +15185,9 @@ margin-bottom: 20px;
"properties" : {
"run" : {
"type" : "integer",
- "description" : "Set the plugin running state\n * 0 - idle\n * 1 - run\n"
+ "description" : "Set the plugin running state\n * 0 - idle\n * 1 - run\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"aos" : {
"$ref" : "#/definitions/PERTesterActions_aos"
@@ -12343,7 +15216,9 @@ margin-bottom: 20px;
"properties" : {
"runningState" : {
"type" : "integer",
- "description" : "Running state\n * 0 - not started\n * 1 - idle\n * 2 - running\n * 3 - error\n"
+ "description" : "Running state\n * 0 - not started\n * 1 - idle\n * 2 - running\n * 3 - error\n",
+ "minimum" : 0,
+ "maximum" : 3
}
},
"description" : "PERTester"
@@ -12351,15 +15226,19 @@ margin-bottom: 20px;
defs.PERTesterSettings = {
"properties" : {
"packetCount" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Number of packet events or items."
},
"interval" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Interval setting for Per tester."
},
"start" : {
"type" : "integer",
- "description" : "0 - immediately, 1 - on satellite AOS, 2 - on satellite mid pass"
+ "description" : "0 - immediately, 1 - on satellite AOS, 2 - on satellite mid pass",
+ "minimum" : 0,
+ "maximum" : 2
},
"satellites" : {
"type" : "array",
@@ -12373,10 +15252,12 @@ margin-bottom: 20px;
"description" : "Packet of data to send"
},
"ignoreLeadingBytes" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Ignore leading bytes setting for Per tester."
},
"ignoreTrailingBytes" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Ignore trailing bytes setting for Per tester."
},
"txUDPAddress" : {
"type" : "string",
@@ -12395,28 +15276,39 @@ margin-bottom: 20px;
"description" : "UDP port to receive packets via"
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIFeatureSetIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Feature-set index used by the reverse API peer."
},
"reverseAPIFeatureIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Feature index used by the reverse API peer."
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -12426,7 +15318,9 @@ margin-bottom: 20px;
"properties" : {
"tx" : {
"type" : "integer",
- "description" : "Transmit current text\n * 0 - Do nothing\n * 1 - Transmit\n"
+ "description" : "Transmit current text\n * 0 - Do nothing\n * 1 - Transmit\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"payload" : {
"$ref" : "#/definitions/PSK31ModActions_payload"
@@ -12440,7 +15334,8 @@ margin-bottom: 20px;
"type" : "string",
"description" : "PSK31 content to transmit"
}
- }
+ },
+ "description" : "Payload data."
};
defs.PSK31ModReport = {
"properties" : {
@@ -12450,7 +15345,8 @@ margin-bottom: 20px;
"description" : "power transmitted in channel (dB)"
},
"channelSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Effective sample rate delivered to the channel in samples per second."
}
},
"description" : "PSK31Mod"
@@ -12459,30 +15355,43 @@ margin-bottom: 20px;
"properties" : {
"inputFrequencyOffset" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Channel frequency offset from the device center frequency in Hz."
},
"rfBandwidth" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "RF bandwidth in Hz."
},
"gain" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Gain setting; units and available values depend on the device or plugin."
},
"channelMute" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Mute the channel output (1 muted, 0 unmuted).",
+ "minimum" : 0,
+ "maximum" : 1
},
"repeat" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Repeat transmission or playback (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"repeatCount" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Number of repetitions."
},
"lpfTaps" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Number of low-pass FIR filter taps."
},
"rfNoise" : {
"type" : "integer",
- "description" : "Boolean\n * 0 - off\n * 1 - on\n"
+ "description" : "Boolean\n * 0 - off\n * 1 - on\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"text" : {
"type" : "string",
@@ -12490,24 +15399,36 @@ margin-bottom: 20px;
},
"pulseShaping" : {
"type" : "integer",
- "description" : "Boolean\n * 0 - off\n * 1 - on\n"
+ "description" : "Boolean\n * 0 - off\n * 1 - on\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"beta" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Beta setting for Psk31 mod."
},
"symbolSpan" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Symbol span setting for Psk31 mod."
},
"prefixCRLF" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable prefix crlf (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"postfixCRLF" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable postfix crlf (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"udpEnabled" : {
"type" : "integer",
- "description" : "Whether to receive text to transmit on specified UDP port"
+ "description" : "Whether to receive text to transmit on specified UDP port",
+ "minimum" : 0,
+ "maximum" : 1
},
"udpAddress" : {
"type" : "string",
@@ -12515,13 +15436,17 @@ margin-bottom: 20px;
},
"udpPort" : {
"type" : "integer",
- "description" : "UDP port to receive text to transmit via"
+ "description" : "UDP port to receive text to transmit via",
+ "minimum" : 1,
+ "maximum" : 65535
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"streamIndex" : {
"type" : "integer",
@@ -12529,24 +15454,34 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -12560,7 +15495,8 @@ margin-bottom: 20px;
"description" : "power received in channel (dB)"
},
"channelSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Effective sample rate delivered to the channel in samples per second."
}
},
"description" : "PacketDemod"
@@ -12569,7 +15505,8 @@ margin-bottom: 20px;
"properties" : {
"inputFrequencyOffset" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Channel frequency offset from the device center frequency in Hz."
},
"mode" : {
"type" : "integer",
@@ -12577,7 +15514,8 @@ margin-bottom: 20px;
},
"rfBandwidth" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "RF bandwidth in Hz."
},
"chase" : {
"type" : "integer",
@@ -12589,7 +15527,9 @@ margin-bottom: 20px;
},
"udpEnabled" : {
"type" : "integer",
- "description" : "Whether to forward received packets to specified UDP port"
+ "description" : "Whether to forward received packets to specified UDP port",
+ "minimum" : 0,
+ "maximum" : 1
},
"udpAddress" : {
"type" : "string",
@@ -12597,22 +15537,33 @@ margin-bottom: 20px;
},
"udpPort" : {
"type" : "integer",
- "description" : "UDP port to forward received packets to"
+ "description" : "UDP port to forward received packets to",
+ "minimum" : 1,
+ "maximum" : 65535
},
"logFilename" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Log file name or path."
},
"logEnabled" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable logging to the configured file (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"useFileTime" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable file time (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"streamIndex" : {
"type" : "integer",
@@ -12620,24 +15571,34 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -12647,7 +15608,9 @@ margin-bottom: 20px;
"properties" : {
"tx" : {
"type" : "integer",
- "description" : "Transmit with current data\n * 0 - Do nothing\n * 1 - Transmit\n"
+ "description" : "Transmit with current data\n * 0 - Do nothing\n * 1 - Transmit\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"payload" : {
"$ref" : "#/definitions/PacketModActions_payload"
@@ -12658,18 +15621,23 @@ margin-bottom: 20px;
defs.PacketModActions_payload = {
"properties" : {
"callsign" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Radio callsign."
},
"to" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "To action parameter."
},
"via" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Via action parameter."
},
"data" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Payload data."
}
- }
+ },
+ "description" : "Payload data."
};
defs.PacketModReport = {
"properties" : {
@@ -12679,10 +15647,12 @@ margin-bottom: 20px;
"description" : "power transmitted in channel (dB)"
},
"audioSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Audio sample rate in samples per second."
},
"channelSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Effective sample rate delivered to the channel in samples per second."
}
},
"description" : "PacketMod"
@@ -12691,11 +15661,14 @@ margin-bottom: 20px;
"properties" : {
"inputFrequencyOffset" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Channel frequency offset from the device center frequency in Hz."
},
"modulation" : {
"type" : "integer",
- "description" : "Modulation mode\n * 0 - AFSK\n * 1 - FSK\n"
+ "description" : "Modulation mode\n * 0 - AFSK\n * 1 - FSK\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"baud" : {
"type" : "integer",
@@ -12703,136 +15676,186 @@ margin-bottom: 20px;
},
"rfBandwidth" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "RF bandwidth in Hz."
},
"fmDeviation" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "FM frequency deviation in Hz."
},
"gain" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Gain setting; units and available values depend on the device or plugin."
},
"channelMute" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Mute the channel output (1 muted, 0 unmuted).",
+ "minimum" : 0,
+ "maximum" : 1
},
"repeat" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Repeat transmission or playback (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"repeatDelay" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Delay between repetitions."
},
"repeatCount" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Number of repetitions."
},
"rampUpBits" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Ramp up bits setting for Packet mod."
},
"rampDownBits" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Ramp down bits setting for Packet mod."
},
"rampRange" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Ramp range setting for Packet mod."
},
"modulateWhileRamping" : {
"type" : "integer",
- "description" : "Boolean\n * 0 - off\n * 1 - on\n"
+ "description" : "Boolean\n * 0 - off\n * 1 - on\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"markFrequency" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Mark frequency in Hz."
},
"spaceFrequency" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Space frequency in Hz."
},
"ax25PreFlags" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Ax25 pre flags setting for Packet mod."
},
"ax25PostFlags" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Ax25 post flags setting for Packet mod."
},
"ax25Control" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Ax25 control setting for Packet mod."
},
"ax25PID" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Ax25 pid setting for Packet mod."
},
"preEmphasis" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Pre emphasis setting for Packet mod."
},
"preEmphasisTau" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Pre emphasis tau setting for Packet mod."
},
"preEmphasisHighFreq" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Pre emphasis high freq setting for Packet mod."
},
"lpfTaps" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Number of low-pass FIR filter taps."
},
"bbNoise" : {
"type" : "integer",
- "description" : "Boolean\n * 0 - off\n * 1 - on\n"
+ "description" : "Boolean\n * 0 - off\n * 1 - on\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"rfNoise" : {
"type" : "integer",
- "description" : "Boolean\n * 0 - off\n * 1 - on\n"
+ "description" : "Boolean\n * 0 - off\n * 1 - on\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"writeToFile" : {
"type" : "integer",
- "description" : "Boolean\n * 0 - off\n * 1 - on\n"
+ "description" : "Boolean\n * 0 - off\n * 1 - on\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"spectrumRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Spectrum rate setting for Packet mod."
},
"callsign" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Radio callsign."
},
"to" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "To setting for Packet mod."
},
"via" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Via setting for Packet mod."
},
"data" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Payload data."
},
"bpf" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Bpf setting for Packet mod."
},
"bpfLowCutoff" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Bpf low cutoff setting for Packet mod."
},
"bpfHighCutoff" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Bpf high cutoff setting for Packet mod."
},
"bpfTaps" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Bpf taps setting for Packet mod."
},
"scramble" : {
"type" : "integer",
- "description" : "Boolean\n * 0 - off\n * 1 - on\n"
+ "description" : "Boolean\n * 0 - off\n * 1 - on\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"polynomial" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Polynomial setting for Packet mod."
},
"pulseShaping" : {
"type" : "integer",
- "description" : "Boolean\n * 0 - off\n * 1 - on\n"
+ "description" : "Boolean\n * 0 - off\n * 1 - on\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"beta" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Beta setting for Packet mod."
},
"symbolSpan" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Symbol span setting for Packet mod."
},
"udpEnabled" : {
"type" : "integer",
- "description" : "Whether to receive packets to transmit on specified UDP port"
+ "description" : "Whether to receive packets to transmit on specified UDP port",
+ "minimum" : 0,
+ "maximum" : 1
},
"udpAddress" : {
"type" : "string",
@@ -12840,13 +15863,17 @@ margin-bottom: 20px;
},
"udpPort" : {
"type" : "integer",
- "description" : "UDP port to receive packets to transmit via"
+ "description" : "UDP port to receive packets to transmit via",
+ "minimum" : 1,
+ "maximum" : 65535
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"streamIndex" : {
"type" : "integer",
@@ -12854,24 +15881,34 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -12885,7 +15922,8 @@ margin-bottom: 20px;
"description" : "power received in channel (dB)"
},
"channelSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Effective sample rate delivered to the channel in samples per second."
}
},
"description" : "PagerDemod"
@@ -12894,27 +15932,36 @@ margin-bottom: 20px;
"properties" : {
"decode" : {
"type" : "integer",
- "description" : "Decode mode\n * 0 - Standard\n * 1 - Inverted\n * 2 - Numeric\n * 3 - Alphanumeric\n * 4 - Heuristic\n"
+ "description" : "Decode mode\n * 0 - Standard\n * 1 - Inverted\n * 2 - Numeric\n * 3 - Alphanumeric\n * 4 - Heuristic\n",
+ "minimum" : 0,
+ "maximum" : 4
},
"reverse" : {
"type" : "integer",
- "description" : "Whether characters should be reversed, for right-to-left reading order\n * 0 - Straight\n * 1 - Reversed\n"
+ "description" : "Whether characters should be reversed, for right-to-left reading order\n * 0 - Straight\n * 1 - Reversed\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"inputFrequencyOffset" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Channel frequency offset from the device center frequency in Hz."
},
"rfBandwidth" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "RF bandwidth in Hz."
},
"fmDeviation" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "FM frequency deviation in Hz."
},
"udpEnabled" : {
"type" : "integer",
- "description" : "Whether to forward received messages to specified UDP port"
+ "description" : "Whether to forward received messages to specified UDP port",
+ "minimum" : 0,
+ "maximum" : 1
},
"udpAddress" : {
"type" : "string",
@@ -12922,19 +15969,27 @@ margin-bottom: 20px;
},
"udpPort" : {
"type" : "integer",
- "description" : "UDP port to forward received messages to"
+ "description" : "UDP port to forward received messages to",
+ "minimum" : 1,
+ "maximum" : 65535
},
"logFilename" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Log file name or path."
},
"logEnabled" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable logging to the configured file (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"streamIndex" : {
"type" : "integer",
@@ -12942,27 +15997,38 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"scopeConfig" : {
+ "description" : "Oscilloscope-display configuration.",
"$ref" : "#/definitions/GLScope"
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -12972,6 +16038,7 @@ margin-bottom: 20px;
"properties" : {
"sampleRates" : {
"type" : "array",
+ "description" : "Supported sample rates in samples per second.",
"items" : {
"$ref" : "#/definitions/SampleRate"
}
@@ -12982,20 +16049,25 @@ margin-bottom: 20px;
defs.PerseusSettings = {
"properties" : {
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"centerFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Device center frequency in Hz."
},
"LOppmTenths" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Local-oscillator correction in tenths of a part per million."
},
"devSampleRateIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Selected dev sample rate index."
},
"log2Decim" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent of the software decimation factor; the output sample rate is divided by 2^log2Decim."
},
"adcDither" : {
"type" : "integer",
@@ -13010,15 +16082,21 @@ margin-bottom: 20px;
"description" : "Wideband mode i.e. bypass automatic RF filter (1 if active else 0)"
},
"transverterMode" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable transverter frequency translation (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"transverterDeltaFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Frequency translation applied in transverter mode in Hz."
},
"iqOrder" : {
"type" : "integer",
- "description" : "IQ samples order\n * 0 - Q then I (swapped)\n * 1 - I then Q (straight)\n"
+ "description" : "IQ samples order\n * 0 - Q then I (swapped)\n * 1 - I then Q (straight)\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"attenuator" : {
"type" : "integer",
@@ -13026,16 +16104,23 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
}
},
"description" : "Perseus"
@@ -13043,17 +16128,21 @@ margin-bottom: 20px;
defs.PlutoSdrInputReport = {
"properties" : {
"adcRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "ADC sample rate in samples per second."
},
"rssi" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Received signal strength indication."
},
"gainDB" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Gain dB in dB."
},
"temperature" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Reported device temperature."
}
},
"description" : "PlutoSDR"
@@ -13061,21 +16150,27 @@ margin-bottom: 20px;
defs.PlutoSdrInputSettings = {
"properties" : {
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"centerFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Device center frequency in Hz."
},
"devSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device I/Q sample rate in samples per second before software decimation or interpolation."
},
"LOppmTenths" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Local-oscillator correction in tenths of a part per million."
},
"lpfFIREnable" : {
"type" : "integer",
- "description" : "Low pass FIR filter enable (1 if enabled else 0)"
+ "description" : "Low pass FIR filter enable (1 if enabled else 0)",
+ "minimum" : 0,
+ "maximum" : 1
},
"lpfFIRBW" : {
"type" : "integer",
@@ -13094,22 +16189,38 @@ margin-bottom: 20px;
"description" : "0=Infra 1=Supra 2=Center"
},
"dcBlock" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable DSP DC-offset correction (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"iqCorrection" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable I/Q imbalance correction (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"hwBBDCBlock" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable hw bbdc block (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"hwRFDCBlock" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable hw rfdc block (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"hwIQCorrection" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable hw i/q correction (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"log2Decim" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent of the software decimation factor; the output sample rate is divided by 2^log2Decim."
},
"lpfBW" : {
"type" : "integer",
@@ -13120,34 +16231,49 @@ margin-bottom: 20px;
"description" : "Hardware gain"
},
"antennaPath" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Selected RF antenna path."
},
"gainMode" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Gain-control mode selection."
},
"transverterMode" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable transverter frequency translation (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"transverterDeltaFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Frequency translation applied in transverter mode in Hz."
},
"iqOrder" : {
"type" : "integer",
- "description" : "IQ samples order\n * 0 - Q then I (swapped)\n * 1 - I then Q (straight)\n"
+ "description" : "IQ samples order\n * 0 - Q then I (swapped)\n * 1 - I then Q (straight)\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
}
},
"description" : "PlutoSDR"
@@ -13155,28 +16281,36 @@ margin-bottom: 20px;
defs.PlutoSdrMIMOReport = {
"properties" : {
"adcRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "ADC sample rate in samples per second."
},
"dacRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "DAC sample rate in samples per second."
},
"rx0GainDB" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Rx0 gain dB in dB."
},
"rx1GainDB" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Rx1 gain dB in dB."
},
"rssiRx0" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Reported rssi rx0."
},
"rssiRx1" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Reported rssi rx1."
},
"rssiTx0" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Reported rssi tx0."
},
"rssiTx1" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Reported rssi tx1."
}
},
"description" : "PlutoSDR"
@@ -13184,47 +16318,70 @@ margin-bottom: 20px;
defs.PlutoSdrMIMOSettings = {
"properties" : {
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"devSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device I/Q sample rate in samples per second before software decimation or interpolation."
},
"LOppmTenths" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Local-oscillator correction in tenths of a part per million."
},
"rxCenterFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Receive center frequency in Hz."
},
"dcBlock" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable DSP DC-offset correction (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"iqCorrection" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable I/Q imbalance correction (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"hwBBDCBlock" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable hw bbdc block (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"hwRFDCBlock" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable hw rfdc block (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"hwIQCorrection" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable hw i/q correction (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"fcPosRx" : {
"type" : "integer",
"description" : "0=Infra 1=Supra 2=Center"
},
"rxTransverterMode" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Receive transverter mode setting for Pluto sdr MIMO."
},
"rxTransverterDeltaFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Receive frequency translation applied in transverter mode in Hz."
},
"iqOrder" : {
"type" : "integer",
- "description" : "IQ samples order\n * 0 - Q then I (swapped)\n * 1 - I then Q (straight)\n"
+ "description" : "IQ samples order\n * 0 - Q then I (swapped)\n * 1 - I then Q (straight)\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"lpfBWRx" : {
"type" : "integer",
@@ -13247,42 +16404,50 @@ margin-bottom: 20px;
"description" : "digital lowpass FIR filter gain (dB)"
},
"log2Decim" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent of the software decimation factor; the output sample rate is divided by 2^log2Decim."
},
"rx0Gain" : {
"type" : "integer",
"description" : "Hardware gain"
},
"rx0GainMode" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Rx0 gain mode setting for Pluto sdr MIMO."
},
"rx0AntennaPath" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Rx0 antenna path setting for Pluto sdr MIMO."
},
"rx1Gain" : {
"type" : "integer",
"description" : "Hardware gain"
},
"rx1GainMode" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Rx1 gain mode setting for Pluto sdr MIMO."
},
"rx1AntennaPath" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Rx1 antenna path setting for Pluto sdr MIMO."
},
"txCenterFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Transmit center frequency in Hz."
},
"fcPosTx" : {
"type" : "integer",
"description" : "0=Infra 1=Supra 2=Center"
},
"txTransverterMode" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Transmit transverter mode setting for Pluto sdr MIMO."
},
"txTransverterDeltaFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Transmit frequency translation applied in transverter mode in Hz."
},
"lpfBWTx" : {
"type" : "integer",
@@ -13305,34 +16470,44 @@ margin-bottom: 20px;
"description" : "digital lowpass FIR filter gain (dB)"
},
"log2Interp" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent of the software interpolation factor; the output sample rate is multiplied by 2^log2Interp."
},
"tx0Att" : {
"type" : "integer",
"description" : "Hardware attenuator gain in decibel fourths (negative)"
},
"tx0AntennaPath" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Tx0 antenna path setting for Pluto sdr MIMO."
},
"tx1Att" : {
"type" : "integer",
"description" : "Hardware attenuator gain in decibel fourths (negative)"
},
"tx1AntennaPath" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Tx1 antenna path setting for Pluto sdr MIMO."
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
}
},
"description" : "PlutoSDR"
@@ -13340,14 +16515,17 @@ margin-bottom: 20px;
defs.PlutoSdrOutputReport = {
"properties" : {
"dacRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "DAC sample rate in samples per second."
},
"rssi" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Received signal strength indication."
},
"temperature" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Reported device temperature."
}
},
"description" : "PlutoSDR"
@@ -13355,21 +16533,27 @@ margin-bottom: 20px;
defs.PlutoSdrOutputSettings = {
"properties" : {
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"centerFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Device center frequency in Hz."
},
"devSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device I/Q sample rate in samples per second before software decimation or interpolation."
},
"LOppmTenths" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Local-oscillator correction in tenths of a part per million."
},
"lpfFIREnable" : {
"type" : "integer",
- "description" : "Low pass FIR filter enable (1 if enabled else 0)"
+ "description" : "Low pass FIR filter enable (1 if enabled else 0)",
+ "minimum" : 0,
+ "maximum" : 1
},
"lpfFIRBW" : {
"type" : "integer",
@@ -13384,7 +16568,8 @@ margin-bottom: 20px;
"description" : "digital lowpass FIR filter gain (dB)"
},
"log2Interp" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent of the software interpolation factor; the output sample rate is multiplied by 2^log2Interp."
},
"lpfBW" : {
"type" : "integer",
@@ -13395,27 +16580,39 @@ margin-bottom: 20px;
"description" : "Hardware attenuator gain in decibel fourths (negative)"
},
"antennaPath" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Selected RF antenna path."
},
"transverterMode" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable transverter frequency translation (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"transverterDeltaFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Frequency translation applied in transverter mode in Hz."
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
}
},
"description" : "PlutoSDR"
@@ -13431,18 +16628,26 @@ margin-bottom: 20px;
"description" : "Index of the source used in R0 tab (GUI flavor) at startup"
},
"audioType" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Audio type for Preferences."
},
"audioDevice" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Audio device for Preferences."
},
"latitude" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Latitude in degrees, positive north.",
+ "minimum" : -90,
+ "maximum" : 90
},
"longitude" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Longitude in degrees, positive east.",
+ "minimum" : -180,
+ "maximum" : 180
},
"consoleMinLogLevel" : {
"type" : "integer",
@@ -13450,10 +16655,13 @@ margin-bottom: 20px;
},
"useLogFile" : {
"type" : "integer",
- "description" : "boolean"
+ "description" : "boolean",
+ "minimum" : 0,
+ "maximum" : 1
},
"logFileName" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Log file name."
},
"fileMinLogLevel" : {
"type" : "integer",
@@ -13469,34 +16677,44 @@ margin-bottom: 20px;
"description" : "See Preset::PresetType"
},
"group" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Group for Preset."
},
"description" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Human-readable description."
},
"centerFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Device center frequency in Hz."
},
"spectrumConfig" : {
+ "description" : "Spectrum-display configuration.",
"$ref" : "#/definitions/GLSpectrum"
},
"dcOffsetCorrection" : {
"type" : "integer",
- "description" : "boolean"
+ "description" : "boolean",
+ "minimum" : 0,
+ "maximum" : 1
},
"iqImbalanceCorrection" : {
"type" : "integer",
- "description" : "boolean"
+ "description" : "boolean",
+ "minimum" : 0,
+ "maximum" : 1
},
"channelConfigs" : {
"type" : "array",
+ "description" : "List of channel configs.",
"items" : {
"$ref" : "#/definitions/ChannelConfig"
}
},
"deviceConfigs" : {
"type" : "array",
+ "description" : "List of device configs.",
"items" : {
"$ref" : "#/definitions/DeviceConfig"
}
@@ -13630,11 +16848,15 @@ margin-bottom: 20px;
"properties" : {
"demodStatus" : {
"type" : "integer",
- "description" : "Demodulation success (%)"
+ "description" : "Demodulation success (%)",
+ "minimum" : 0,
+ "maximum" : 100
},
"decodStatus" : {
"type" : "integer",
- "description" : "Decoding success (%)"
+ "description" : "Decoding success (%)",
+ "minimum" : 0,
+ "maximum" : 100
},
"rdsDemodAccumDB" : {
"type" : "number",
@@ -13680,6 +16902,7 @@ margin-bottom: 20px;
},
"altFrequencies" : {
"type" : "array",
+ "description" : "Alternative broadcast frequencies reported by RDS.",
"items" : {
"$ref" : "#/definitions/RDSReport_altFrequencies"
}
@@ -13691,7 +16914,8 @@ margin-bottom: 20px;
"properties" : {
"frequency" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Frequency in Hz."
}
}
};
@@ -13703,7 +16927,8 @@ margin-bottom: 20px;
"description" : "power received in channel (dB)"
},
"channelSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Effective sample rate delivered to the channel in samples per second."
}
},
"description" : "ACARSDemod"
@@ -13712,22 +16937,28 @@ margin-bottom: 20px;
"properties" : {
"inputFrequencyOffset" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Channel frequency offset from the device center frequency in Hz."
},
"rfBandwidth" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "RF bandwidth in Hz."
},
"baudRate" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Serial-port baud rate in bits per second."
},
"frequencyShift" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Frequency shift in Hz."
},
"udpEnabled" : {
"type" : "integer",
- "description" : "Whether to forward received messages to specified UDP port"
+ "description" : "Whether to forward received messages to specified UDP port",
+ "minimum" : 0,
+ "maximum" : 1
},
"udpAddress" : {
"type" : "string",
@@ -13735,37 +16966,57 @@ margin-bottom: 20px;
},
"udpPort" : {
"type" : "integer",
- "description" : "UDP port to forward received messages to"
+ "description" : "UDP port to forward received messages to",
+ "minimum" : 1,
+ "maximum" : 65535
},
"characterSet" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Character set setting for Rtty demod."
},
"suppressCRLF" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Suppress crlf setting for Rtty demod."
},
"unshiftOnSpace" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable unshift on space (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"msbFirst" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable msb first (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"spaceHigh" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable space high (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"squelch" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Squelch threshold in dB."
},
"logFilename" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Log file name or path."
},
"logEnabled" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable logging to the configured file (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"streamIndex" : {
"type" : "integer",
@@ -13773,27 +17024,38 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"scopeConfig" : {
+ "description" : "Oscilloscope-display configuration.",
"$ref" : "#/definitions/GLScope"
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -13803,7 +17065,9 @@ margin-bottom: 20px;
"properties" : {
"tx" : {
"type" : "integer",
- "description" : "Transmit current text\n * 0 - Do nothing\n * 1 - Transmit\n"
+ "description" : "Transmit current text\n * 0 - Do nothing\n * 1 - Transmit\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"payload" : {
"$ref" : "#/definitions/RTTYModActions_payload"
@@ -13817,7 +17081,8 @@ margin-bottom: 20px;
"type" : "string",
"description" : "RTTY content to transmit"
}
- }
+ },
+ "description" : "Payload data."
};
defs.RTTYModReport = {
"properties" : {
@@ -13827,7 +17092,8 @@ margin-bottom: 20px;
"description" : "power transmitted in channel (dB)"
},
"channelSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Effective sample rate delivered to the channel in samples per second."
}
},
"description" : "RTTYMod"
@@ -13836,7 +17102,8 @@ margin-bottom: 20px;
"properties" : {
"inputFrequencyOffset" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Channel frequency offset from the device center frequency in Hz."
},
"baud" : {
"type" : "number",
@@ -13844,30 +17111,43 @@ margin-bottom: 20px;
"description" : "Baud rate"
},
"rfBandwidth" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "RF bandwidth in Hz."
},
"frequencyShift" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Frequency shift in Hz."
},
"gain" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Gain setting; units and available values depend on the device or plugin."
},
"channelMute" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Mute the channel output (1 muted, 0 unmuted).",
+ "minimum" : 0,
+ "maximum" : 1
},
"repeat" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Repeat transmission or playback (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"repeatCount" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Number of repetitions."
},
"lpfTaps" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Number of low-pass FIR filter taps."
},
"rfNoise" : {
"type" : "integer",
- "description" : "Boolean\n * 0 - off\n * 1 - on\n"
+ "description" : "Boolean\n * 0 - off\n * 1 - on\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"text" : {
"type" : "string",
@@ -13875,36 +17155,58 @@ margin-bottom: 20px;
},
"pulseShaping" : {
"type" : "integer",
- "description" : "Boolean\n * 0 - off\n * 1 - on\n"
+ "description" : "Boolean\n * 0 - off\n * 1 - on\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"beta" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Beta setting for Rtty mod."
},
"symbolSpan" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Symbol span setting for Rtty mod."
},
"characterSet" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Character set setting for Rtty mod."
},
"unshiftOnSpace" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable unshift on space (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"msbFirst" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable msb first (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"spaceHigh" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable space high (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"prefixCRLF" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable prefix crlf (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"postfixCRLF" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable postfix crlf (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"udpEnabled" : {
"type" : "integer",
- "description" : "Whether to receive text to transmit on specified UDP port"
+ "description" : "Whether to receive text to transmit on specified UDP port",
+ "minimum" : 0,
+ "maximum" : 1
},
"udpAddress" : {
"type" : "string",
@@ -13912,13 +17214,17 @@ margin-bottom: 20px;
},
"udpPort" : {
"type" : "integer",
- "description" : "UDP port to receive text to transmit via"
+ "description" : "UDP port to receive text to transmit via",
+ "minimum" : 1,
+ "maximum" : 65535
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"streamIndex" : {
"type" : "integer",
@@ -13926,24 +17232,34 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -13967,7 +17283,8 @@ margin-bottom: 20px;
"description" : "power received in channel (dB)"
},
"channelSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Effective sample rate delivered to the channel in samples per second."
}
},
"description" : "RadioAstronomy"
@@ -13976,31 +17293,40 @@ margin-bottom: 20px;
"properties" : {
"inputFrequencyOffset" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Channel frequency offset from the device center frequency in Hz."
},
"sampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Sample rate in samples per second."
},
"rfBandwidth" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "RF bandwidth in Hz."
},
"integration" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Integration setting for Radio astronomy."
},
"fftSize" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "FFT size in samples."
},
"fftWindow" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "FFT window setting for Radio astronomy."
},
"filterFreqs" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Filter freqs setting for Radio astronomy."
},
"starTracker" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Star tracker setting for Radio astronomy."
},
"rotator" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Rotator setting for Radio astronomy."
},
"runMode" : {
"type" : "integer",
@@ -14011,7 +17337,8 @@ margin-bottom: 20px;
"description" : "(0 for now, 1 for at sweepStartDateTime)"
},
"sweepStartDateTime" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Sweep start date time setting for Radio astronomy."
},
"sweepType" : {
"type" : "integer",
@@ -14019,41 +17346,51 @@ margin-bottom: 20px;
},
"sweep1Start" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Sweep1 start setting for Radio astronomy."
},
"sweep1Stop" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Sweep1 stop setting for Radio astronomy."
},
"sweep1Step" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Sweep1 step setting for Radio astronomy."
},
"sweep1Delay" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Sweep1 delay setting for Radio astronomy."
},
"sweep2Start" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Sweep2 start setting for Radio astronomy."
},
"sweep2Stop" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Sweep2 stop setting for Radio astronomy."
},
"sweep2Step" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Sweep2 step setting for Radio astronomy."
},
"sweep2Delay" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Sweep2 delay setting for Radio astronomy."
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"streamIndex" : {
"type" : "integer",
@@ -14061,24 +17398,34 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -14092,13 +17439,16 @@ margin-bottom: 20px;
"description" : "power received in channel (dB)"
},
"channelSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Effective sample rate delivered to the channel in samples per second."
},
"date" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Reported date."
},
"time" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Reported time."
}
},
"description" : "RadioClock"
@@ -14126,21 +17476,28 @@ margin-bottom: 20px;
},
"threshold" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Threshold setting for Radio clock."
},
"modulation" : {
"type" : "integer",
- "description" : "0 - MSF, 1 - DCF77, 2 - TDF, 3 - WWVB, 4 - JJY"
+ "description" : "0 - MSF, 1 - DCF77, 2 - TDF, 3 - WWVB, 4 - JJY",
+ "minimum" : 0,
+ "maximum" : 4
},
"timezone" : {
"type" : "integer",
- "description" : "0 - Broadcast, 1 - Local, 2 - UTC"
+ "description" : "0 - Broadcast, 1 - Local, 2 - UTC",
+ "minimum" : 0,
+ "maximum" : 2
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"streamIndex" : {
"type" : "integer",
@@ -14148,27 +17505,38 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"scopeConfig" : {
+ "description" : "Oscilloscope-display configuration.",
"$ref" : "#/definitions/GLScope"
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -14182,7 +17550,8 @@ margin-bottom: 20px;
"description" : "power received in channel (dB)"
},
"channelSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Effective sample rate delivered to the channel in samples per second."
}
},
"description" : "RadiosondeDemod"
@@ -14195,23 +17564,29 @@ margin-bottom: 20px;
},
"inputFrequencyOffset" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Channel frequency offset from the device center frequency in Hz."
},
"rfBandwidth" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "RF bandwidth in Hz."
},
"fmDeviation" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "FM frequency deviation in Hz."
},
"correlationThreshold" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Minimum correlation score required to accept a frame preamble."
},
"udpEnabled" : {
"type" : "integer",
- "description" : "Whether to forward received messages to specified UDP port"
+ "description" : "Whether to forward received messages to specified UDP port",
+ "minimum" : 0,
+ "maximum" : 1
},
"udpAddress" : {
"type" : "string",
@@ -14219,22 +17594,33 @@ margin-bottom: 20px;
},
"udpPort" : {
"type" : "integer",
- "description" : "UDP port to forward received messages to"
+ "description" : "UDP port to forward received messages to",
+ "minimum" : 1,
+ "maximum" : 65535
},
"logFilename" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Log file name or path."
},
"logEnabled" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable logging to the configured file (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"useFileTime" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable file time (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"streamIndex" : {
"type" : "integer",
@@ -14242,27 +17628,38 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"scopeConfig" : {
+ "description" : "Oscilloscope-display configuration.",
"$ref" : "#/definitions/GLScope"
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -14271,38 +17668,51 @@ margin-bottom: 20px;
defs.RadiosondeSettings = {
"properties" : {
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIFeatureSetIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Feature-set index used by the reverse API peer."
},
"reverseAPIFeatureIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Feature index used by the reverse API peer."
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
},
"radiosondesColumnIndexes" : {
"type" : "array",
+ "description" : "List of radiosondes column indexes.",
"items" : {
"type" : "integer"
}
},
"radiosondesColumnSizes" : {
"type" : "array",
+ "description" : "List of radiosondes column sizes.",
"items" : {
"type" : "integer"
}
@@ -14313,17 +17723,21 @@ margin-bottom: 20px;
defs.Range = {
"properties" : {
"min" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Minimum value of the range."
},
"max" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Maximum value of the range."
},
"step" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Increment between adjacent supported values."
},
"scale" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Scale factor applied to the value."
}
},
"description" : "An arbitrary range of integer values"
@@ -14332,15 +17746,18 @@ margin-bottom: 20px;
"properties" : {
"min" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Minimum value of the range."
},
"max" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Maximum value of the range."
},
"step" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Increment between adjacent supported values."
}
},
"description" : "An arbitrary range of floating point values"
@@ -14349,10 +17766,12 @@ margin-bottom: 20px;
"properties" : {
"centerFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Device center frequency in Hz."
},
"sampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Sample rate in samples per second."
},
"bufferRWBalance" : {
"type" : "integer",
@@ -14376,45 +17795,70 @@ margin-bottom: 20px;
defs.RemoteInputSettings = {
"properties" : {
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"apiAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the API endpoint."
},
"apiPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the API endpoint.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"dataAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name used for data traffic."
},
"dataPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Network port used for data traffic.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"multicastAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IP multicast group address."
},
"multicastJoin" : {
"type" : "integer",
- "description" : "Join multicast group * 0 - leave group * 1 - join group\n"
+ "description" : "Join multicast group * 0 - leave group * 1 - join group\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"dcBlock" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable DSP DC-offset correction (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"iqCorrection" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable I/Q imbalance correction (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
}
},
"description" : "RemoteInput"
@@ -14423,10 +17867,12 @@ margin-bottom: 20px;
"properties" : {
"centerFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Device center frequency in Hz."
},
"sampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Sample rate in samples per second."
},
"queueLength" : {
"type" : "integer",
@@ -14462,26 +17908,36 @@ margin-bottom: 20px;
defs.RemoteOutputSettings = {
"properties" : {
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"nbFECBlocks" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Nb fec blocks setting for Remote output."
},
"nbTxBytes" : {
"type" : "integer",
"description" : "Number of bytes in a transmitted I or Q sample\n * 1\n * 2\n * 4\n"
},
"apiAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the API endpoint."
},
"apiPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the API endpoint.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"dataAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name used for data traffic."
},
"dataPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Network port used for data traffic.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"deviceIndex" : {
"type" : "integer",
@@ -14493,16 +17949,23 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
}
},
"description" : "RemoteOutput"
@@ -14527,19 +17990,25 @@ margin-bottom: 20px;
},
"dataPort" : {
"type" : "integer",
- "description" : "Receiving USB data port"
+ "description" : "Receiving USB data port",
+ "minimum" : 1,
+ "maximum" : 65535
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"log2Decim" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent of the software decimation factor; the output sample rate is divided by 2^log2Decim."
},
"filterChainHash" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Identifier of the selected half-band filter chain."
},
"streamIndex" : {
"type" : "integer",
@@ -14547,24 +18016,34 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -14636,19 +18115,25 @@ margin-bottom: 20px;
},
"dataPort" : {
"type" : "integer",
- "description" : "Remote USB data port"
+ "description" : "Remote USB data port",
+ "minimum" : 1,
+ "maximum" : 65535
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"log2Interp" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent of the software interpolation factor; the output sample rate is multiplied by 2^log2Interp."
},
"filterChainHash" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Identifier of the selected half-band filter chain."
},
"streamIndex" : {
"type" : "integer",
@@ -14656,24 +18141,34 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -14682,19 +18177,27 @@ margin-bottom: 20px;
defs.RemoteTCPInputReport = {
"properties" : {
"sampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Sample rate in samples per second."
},
"latitude" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Latitude in degrees, positive north.",
+ "minimum" : -90,
+ "maximum" : 90
},
"longitude" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Longitude in degrees, positive east.",
+ "minimum" : -180,
+ "maximum" : 180
},
"altitude" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Altitude above mean sea level."
}
},
"description" : "RemoteTCPInput"
@@ -14702,69 +18205,100 @@ margin-bottom: 20px;
defs.RemoteTCPInputSettings = {
"properties" : {
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"centerFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Device center frequency in Hz."
},
"loPpmCorrection" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Local-oscillator correction in parts per million."
},
"dcBlock" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable DSP DC-offset correction (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"iqCorrection" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable I/Q imbalance correction (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"biasTee" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable the antenna bias tee (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"directSampling" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Direct sampling setting for Remote TCP input."
},
"devSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device I/Q sample rate in samples per second before software decimation or interpolation."
},
"log2Decim" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent of the software decimation factor; the output sample rate is divided by 2^log2Decim."
},
"gain" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Gain setting; units and available values depend on the device or plugin."
},
"agc" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable automatic gain control (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"rfBW" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "RF bw in Hz."
},
"inputFrequencyOffset" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Channel frequency offset from the device center frequency in Hz."
},
"channelGain" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel gain setting for Remote TCP input."
},
"channelSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Effective sample rate delivered to the channel in samples per second."
},
"channelDecimation" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel decimation setting for Remote TCP input."
},
"sampleBits" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Number of significant bits in each sample."
},
"dataAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name used for data traffic."
},
"dataPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Network port used for data traffic.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"overrideRemoteSettings" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Override remote settings setting for Remote TCP input."
},
"preFill" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Pre fill setting for Remote TCP input."
},
"protocol" : {
"type" : "string",
@@ -14772,16 +18306,23 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
}
},
"description" : "RemoteTCPInput"
@@ -14789,17 +18330,21 @@ margin-bottom: 20px;
defs.RemoteTCPSinkSettings = {
"properties" : {
"channelSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Effective sample rate delivered to the channel in samples per second."
},
"inputFrequencyOffset" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Channel frequency offset from the device center frequency in Hz."
},
"gain" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Gain setting; units and available values depend on the device or plugin."
},
"sampleBits" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Number of significant bits in each sample."
},
"dataAddress" : {
"type" : "string",
@@ -14807,16 +18352,21 @@ margin-bottom: 20px;
},
"dataPort" : {
"type" : "integer",
- "description" : "Receiving TCP data port"
+ "description" : "Receiving TCP data port",
+ "minimum" : 1,
+ "maximum" : 65535
},
"protocol" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Protocol setting for Remote TCP sink."
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"streamIndex" : {
"type" : "integer",
@@ -14824,24 +18374,34 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -14851,7 +18411,9 @@ margin-bottom: 20px;
"properties" : {
"run" : {
"type" : "integer",
- "description" : "Set the plugin running state\n * 0 - idle\n * 1 - run\n"
+ "description" : "Set the plugin running state\n * 0 - idle\n * 1 - run\n",
+ "minimum" : 0,
+ "maximum" : 1
}
},
"description" : "RigCtl server actions"
@@ -14860,7 +18422,9 @@ margin-bottom: 20px;
"properties" : {
"runningState" : {
"type" : "integer",
- "description" : "Running state\n * 0 - not started\n * 1 - idle\n * 2 - running\n * 3 - error\n"
+ "description" : "Running state\n * 0 - not started\n * 1 - idle\n * 2 - running\n * 3 - error\n",
+ "minimum" : 0,
+ "maximum" : 3
}
},
"description" : "RigCtl server report"
@@ -14869,43 +18433,60 @@ margin-bottom: 20px;
"properties" : {
"enabled" : {
"type" : "integer",
- "description" : "Enable RigCtl server\n * 1 - enabled\n * 0 - disabled\n"
+ "description" : "Enable RigCtl server\n * 1 - enabled\n * 0 - disabled\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"rigCtlPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Rig ctl port."
},
"maxFrequencyOffset" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Max frequency offset in Hz."
},
"deviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Selected device index."
},
"channelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Selected channel index."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API\n * 1 - yes\n * 0 - no\n"
+ "description" : "Synchronize with reverse API\n * 1 - yes\n * 0 - no\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIFeatureSetIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Feature-set index used by the reverse API peer."
},
"reverseAPIFeatureIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Feature index used by the reverse API peer."
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -14914,11 +18495,14 @@ margin-bottom: 20px;
defs.RollupChildState = {
"properties" : {
"objectName" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Object name for Rollup child state."
},
"isHidden" : {
"type" : "integer",
- "description" : "Boolean - child hidden state\n * 0 - visible\n * 1 - hidden\n"
+ "description" : "Boolean - child hidden state\n * 0 - visible\n * 1 - hidden\n",
+ "minimum" : 0,
+ "maximum" : 1
}
},
"description" : "Rollup widget child state"
@@ -14926,10 +18510,12 @@ margin-bottom: 20px;
defs.RollupState = {
"properties" : {
"version" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Version for Rollup state."
},
"childrenStates" : {
"type" : "array",
+ "description" : "List of children states.",
"items" : {
"$ref" : "#/definitions/RollupChildState"
}
@@ -14941,12 +18527,14 @@ margin-bottom: 20px;
"properties" : {
"gains" : {
"type" : "array",
+ "description" : "List of gains.",
"items" : {
"$ref" : "#/definitions/Gain"
}
},
"tunerType" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Reported tuner type."
}
},
"description" : "RTLSDR"
@@ -14954,75 +18542,114 @@ margin-bottom: 20px;
defs.RtlSdrSettings = {
"properties" : {
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"devSampleRate" : {
- "type" : "integer"
+ "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.\n"
},
"lowSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Use the RTL-SDR low sample-rate range (1 enabled, 0 disabled)."
},
"centerFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Device center frequency in Hz."
},
"gain" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Gain setting; units and available values depend on the device or plugin."
},
"loPpmCorrection" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Local-oscillator correction in parts per million."
},
"log2Decim" : {
- "type" : "integer"
+ "type" : "integer",
+ "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.\n",
+ "minimum" : 0,
+ "maximum" : 6
},
"fcPos" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Position of the decimated passband relative to the device center frequency."
},
"dcBlock" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable DSP DC-offset correction (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"iqImbalance" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable DSP I/Q imbalance correction (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"agc" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable automatic gain control (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"noModMode" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "No mod mode setting for Rtl sdr."
},
"offsetTuning" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable tuner offset tuning (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"transverterMode" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable transverter frequency translation (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"transverterDeltaFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Frequency translation applied in transverter mode in Hz."
},
"iqOrder" : {
"type" : "integer",
- "description" : "IQ samples order\n * 0 - Q then I (swapped)\n * 1 - I then Q (straight)\n"
+ "description" : "IQ samples order\n * 0 - Q then I (swapped)\n * 1 - I then Q (straight)\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"rfBandwidth" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "RF bandwidth in Hz."
},
"biasTee" : {
"type" : "integer",
- "description" : "Bias tee\n * 0 - inactive\n * 1 - active\n"
+ "description" : "Bias tee\n * 0 - inactive\n * 1 - active\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
}
},
"description" : "RTLSDR"
@@ -15031,24 +18658,28 @@ margin-bottom: 20px;
"properties" : {
"sampleRates" : {
"type" : "array",
+ "description" : "Supported sample rates in samples per second.",
"items" : {
"$ref" : "#/definitions/SampleRate"
}
},
"bandwidths" : {
"type" : "array",
+ "description" : "Supported bandwidths in Hz.",
"items" : {
"$ref" : "#/definitions/Bandwidth"
}
},
"intermediateFrequencies" : {
"type" : "array",
+ "description" : "List of intermediate frequencies.",
"items" : {
"$ref" : "#/definitions/Frequency"
}
},
"frequencyBands" : {
"type" : "array",
+ "description" : "List of frequency bands.",
"items" : {
"$ref" : "#/definitions/FrequencyBand"
}
@@ -15059,71 +18690,99 @@ margin-bottom: 20px;
defs.SDRPlaySettings = {
"properties" : {
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"centerFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Device center frequency in Hz."
},
"tunerGain" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Tuner gain setting for Sdr play."
},
"LOppmTenths" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Local-oscillator correction in tenths of a part per million."
},
"frequencyBandIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Selected frequency band index."
},
"ifFrequencyIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Selected if frequency index."
},
"bandwidthIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Selected bandwidth index."
},
"devSampleRateIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Selected dev sample rate index."
},
"log2Decim" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent of the software decimation factor; the output sample rate is divided by 2^log2Decim."
},
"fcPos" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Position of the decimated passband relative to the device center frequency."
},
"dcBlock" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable DSP DC-offset correction (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"iqCorrection" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable I/Q imbalance correction (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"tunerGainMode" : {
"type" : "integer",
"description" : "1 tuner (table) gain, 0 manual (LNA, Mixer, BB) gain"
},
"lnaOn" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "LNA on setting for Sdr play."
},
"mixerAmpOn" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Mixer amp on setting for Sdr play."
},
"basebandGain" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Baseband gain setting for Sdr play."
},
"iqOrder" : {
"type" : "integer",
- "description" : "IQ samples order\n * 0 - Q then I (swapped)\n * 1 - I then Q (straight)\n"
+ "description" : "IQ samples order\n * 0 - Q then I (swapped)\n * 1 - I then Q (straight)\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
}
},
"description" : "SDRplay1"
@@ -15136,12 +18795,14 @@ margin-bottom: 20px;
},
"bandwidths" : {
"type" : "array",
+ "description" : "Supported bandwidths in Hz.",
"items" : {
"$ref" : "#/definitions/Bandwidth"
}
},
"intermediateFrequencies" : {
"type" : "array",
+ "description" : "List of intermediate frequencies.",
"items" : {
"$ref" : "#/definitions/Frequency"
}
@@ -15152,94 +18813,132 @@ margin-bottom: 20px;
defs.SDRPlayV3Settings = {
"properties" : {
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"centerFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Device center frequency in Hz."
},
"LOppmTenths" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Local-oscillator correction in tenths of a part per million."
},
"ifFrequencyIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Selected if frequency index."
},
"bandwidthIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Selected bandwidth index."
},
"devSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device I/Q sample rate in samples per second before software decimation or interpolation."
},
"log2Decim" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent of the software decimation factor; the output sample rate is divided by 2^log2Decim."
},
"fcPos" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Position of the decimated passband relative to the device center frequency."
},
"dcBlock" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable DSP DC-offset correction (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"iqCorrection" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable I/Q imbalance correction (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"lnaIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Selected lna index."
},
"lnaGain" : {
"type" : "integer",
"description" : "Gain in dB, as an alternative to lnaIndex setting"
},
"ifAGC" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "IF agc setting for Sdr play v3."
},
"ifGain" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Intermediate-frequency gain setting."
},
"amNotch" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Am notch setting for Sdr play v3."
},
"fmNotch" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "FM notch setting for Sdr play v3."
},
"dabNotch" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Dab notch setting for Sdr play v3."
},
"extRef" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Ext ref setting for Sdr play v3."
},
"tuner" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Tuner setting for Sdr play v3."
},
"antenna" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Antenna setting for Sdr play v3."
},
"transverterMode" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable transverter frequency translation (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"transverterDeltaFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Frequency translation applied in transverter mode in Hz."
},
"iqOrder" : {
"type" : "integer",
- "description" : "IQ samples order\n * 0 - Q then I (swapped)\n * 1 - I then Q (straight)\n"
+ "description" : "IQ samples order\n * 0 - Q then I (swapped)\n * 1 - I then Q (straight)\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"biasTee" : {
"type" : "integer",
- "description" : "Bias tee\n * 0 - inactive\n * 1 - active\n"
+ "description" : "Bias tee\n * 0 - inactive\n * 1 - active\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
}
},
"description" : "SDRplayV3"
@@ -15248,43 +18947,59 @@ margin-bottom: 20px;
"properties" : {
"period" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Period setting for Sid."
},
"autosave" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Autosave setting for Sid."
},
"autoload" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Autoload setting for Sid."
},
"filename" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Filename setting for Sid."
},
"autosavePeriod" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Autosave period setting for Sid."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIFeatureSetIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Feature-set index used by the reverse API peer."
},
"reverseAPIFeatureIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Feature index used by the reverse API peer."
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -15302,10 +19017,12 @@ margin-bottom: 20px;
"description" : "Audio squelch status (1 if open else 0)"
},
"audioSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Audio sample rate in samples per second."
},
"channelSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Effective sample rate delivered to the channel in samples per second."
}
},
"description" : "SSBDemod"
@@ -15314,29 +19031,37 @@ margin-bottom: 20px;
"properties" : {
"inputFrequencyOffset" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Channel frequency offset from the device center frequency in Hz."
},
"filterIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Selected filter index."
},
"spanLog2" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent controlling the displayed or processed frequency span."
},
"rfBandwidth" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "RF bandwidth in Hz."
},
"lowCutoff" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Lower filter cutoff frequency in Hz."
},
"fftWindow" : {
"type" : "integer",
- "description" : "FFT Window index (FFTWindow::Function):\n * 0 - Bartlett\n * 1 - Blackman-Harris 4 term\n * 2 - Flattop\n * 3 - Hamming\n * 4 - Hanning\n * 5 - Rectangle\n * 6 - Kaiser\n * 7 - Blackman 3 term\n * 8 - Blackman-Harris 7 term\n"
+ "description" : "FFT Window index (FFTWindow::Function):\n * 0 - Bartlett\n * 1 - Blackman-Harris 4 term\n * 2 - Flattop\n * 3 - Hamming\n * 4 - Hanning\n * 5 - Rectangle\n * 6 - Kaiser\n * 7 - Blackman 3 term\n * 8 - Blackman-Harris 7 term\n",
+ "minimum" : 0,
+ "maximum" : 8
},
"volume" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Audio volume multiplier."
},
"audioBinaural" : {
"type" : "integer",
@@ -15352,11 +19077,15 @@ margin-bottom: 20px;
},
"audioMute" : {
"type" : "integer",
- "description" : "Mute audio (1 if muted else 0)"
+ "description" : "Mute audio (1 if muted else 0)",
+ "minimum" : 0,
+ "maximum" : 1
},
"agc" : {
"type" : "integer",
- "description" : "AGC (1 if AGC active else 0)"
+ "description" : "AGC (1 if AGC active else 0)",
+ "minimum" : 0,
+ "maximum" : 1
},
"agcClamping" : {
"type" : "integer",
@@ -15376,11 +19105,15 @@ margin-bottom: 20px;
},
"dnr" : {
"type" : "integer",
- "description" : "Toggle noise reduction:\n * 0 - Noise reduction off\n * 1 - Noise reduction on\n"
+ "description" : "Toggle noise reduction:\n * 0 - Noise reduction off\n * 1 - Noise reduction on\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"dnrScheme" : {
"type" : "integer",
- "description" : "Noise reduction scheme:\n * 0 - Average of magnitudes\n * 1 - Average and standard deviation of magnitudes\n * 2 - Magnitude maxima (peaks)\n"
+ "description" : "Noise reduction scheme:\n * 0 - Average of magnitudes\n * 1 - Average and standard deviation of magnitudes\n * 2 - Magnitude maxima (peaks)\n",
+ "minimum" : 0,
+ "maximum" : 2
},
"dnrAboveAvgFactor" : {
"type" : "number",
@@ -15402,13 +19135,16 @@ margin-bottom: 20px;
"description" : "Smoothing constant (alpha) of the exponential smoothing filter. Must be between 0 and 1."
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"audioDeviceName" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Name of the audio device to use."
},
"streamIndex" : {
"type" : "integer",
@@ -15416,27 +19152,38 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"spectrumConfig" : {
+ "description" : "Spectrum-display configuration.",
"$ref" : "#/definitions/GLSpectrum"
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -15450,10 +19197,12 @@ margin-bottom: 20px;
"description" : "power transmitted in channel (dB)"
},
"audioSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Audio sample rate in samples per second."
},
"channelSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Effective sample rate delivered to the channel in samples per second."
}
},
"description" : "SSBMod"
@@ -15462,65 +19211,90 @@ margin-bottom: 20px;
"properties" : {
"inputFrequencyOffset" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Channel frequency offset from the device center frequency in Hz."
},
"bandwidth" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Bandwidth in Hz."
},
"lowCutoff" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Lower filter cutoff frequency in Hz."
},
"usb" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "USB setting for Ssb mod."
},
"toneFrequency" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Tone frequency in Hz."
},
"volumeFactor" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Volume factor setting for Ssb mod."
},
"spanLog2" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent controlling the displayed or processed frequency span."
},
"audioBinaural" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Audio binaural setting for Ssb mod."
},
"audioFlipChannels" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Audio flip channels setting for Ssb mod."
},
"dsb" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Dsb setting for Ssb mod."
},
"audioMute" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Mute audio output (1 muted, 0 unmuted).",
+ "minimum" : 0,
+ "maximum" : 1
},
"playLoop" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Loop playback at end of file (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"agc" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable automatic gain control (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"cmpPreGainDB" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Cmp pre gain dB in dB."
},
"cmpThresholdDB" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Cmp threshold dB in dB."
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"audioDeviceName" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Name of the audio device to use."
},
"modAFInput" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Audio-frequency modulation input selection."
},
"streamIndex" : {
"type" : "integer",
@@ -15528,30 +19302,42 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"cwKeyer" : {
+ "description" : "CW keyer configuration.",
"$ref" : "#/definitions/CWKeyerSettings"
},
"spectrumConfig" : {
+ "description" : "Spectrum-display configuration.",
"$ref" : "#/definitions/GLSpectrum"
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -15560,7 +19346,8 @@ margin-bottom: 20px;
defs.SampleRate = {
"properties" : {
"rate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Sample rate in samples per second."
}
},
"description" : "A sample rate expressed in samples per second (S/s)"
@@ -15710,17 +19497,22 @@ margin-bottom: 20px;
defs.SatelliteState = {
"properties" : {
"name" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Name."
},
"latitude" : {
"type" : "number",
"format" : "float",
- "description" : "Latitude of satellite in degrees"
+ "description" : "Latitude of satellite in degrees",
+ "minimum" : -90,
+ "maximum" : 90
},
"longitude" : {
"type" : "number",
"format" : "float",
- "description" : "Longitude of satellite in degrees"
+ "description" : "Longitude of satellite in degrees",
+ "minimum" : -180,
+ "maximum" : 180
},
"altitude" : {
"type" : "number",
@@ -15759,6 +19551,7 @@ margin-bottom: 20px;
},
"passes" : {
"type" : "array",
+ "description" : "List of passes.",
"items" : {
"$ref" : "#/definitions/SatellitePass"
}
@@ -15769,7 +19562,9 @@ margin-bottom: 20px;
"properties" : {
"run" : {
"type" : "integer",
- "description" : "Set the plugin running state\n * 0 - idle\n * 1 - run\n"
+ "description" : "Set the plugin running state\n * 0 - idle\n * 1 - run\n",
+ "minimum" : 0,
+ "maximum" : 1
}
},
"description" : "Satellite Tracker actions"
@@ -15778,18 +19573,23 @@ margin-bottom: 20px;
"properties" : {
"runningState" : {
"type" : "integer",
- "description" : "Running state\n * 0 - not started\n * 1 - idle\n * 2 - running\n * 3 - error\n"
+ "description" : "Running state\n * 0 - not started\n * 1 - idle\n * 2 - running\n * 3 - error\n",
+ "minimum" : 0,
+ "maximum" : 3
},
"targetAzimuth" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Target azimuth in degrees clockwise from north."
},
"targetElevation" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Target elevation in degrees above the horizon."
},
"satelliteState" : {
"type" : "array",
+ "description" : "List of satellite state.",
"items" : {
"$ref" : "#/definitions/SatelliteState"
}
@@ -15802,12 +19602,16 @@ margin-bottom: 20px;
"latitude" : {
"type" : "number",
"format" : "float",
- "description" : "Latitude in decimal degrees (North positive) of antenna location"
+ "description" : "Latitude in decimal degrees (North positive) of antenna location",
+ "minimum" : -90,
+ "maximum" : 90
},
"longitude" : {
"type" : "number",
"format" : "float",
- "description" : "Longitude in decimal degrees (East positive) of antenna location"
+ "description" : "Longitude in decimal degrees (East positive) of antenna location",
+ "minimum" : -180,
+ "maximum" : 180
},
"heightAboveSeaLevel" : {
"type" : "number",
@@ -15928,35 +19732,48 @@ margin-bottom: 20px;
},
"azimuthOffset" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Azimuth offset setting for Satellite tracker."
},
"elevationOffset" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Elevation offset setting for Satellite tracker."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIFeatureSetIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Feature-set index used by the reverse API peer."
},
"reverseAPIFeatureIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Feature index used by the reverse API peer."
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -15966,11 +19783,15 @@ margin-bottom: 20px;
"properties" : {
"playTrack" : {
"type" : "integer",
- "description" : "Play IQ stream action\n * 0 - stop playing\n * 1 - start playing current track\n"
+ "description" : "Play IQ stream action\n * 0 - stop playing\n * 1 - start playing current track\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"playRecord" : {
"type" : "integer",
- "description" : "Play IQ stream action\n * 0 - stop playing\n * 1 - start playing\n"
+ "description" : "Play IQ stream action\n * 0 - stop playing\n * 1 - start playing\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"seekTrack" : {
"type" : "integer",
@@ -15999,26 +19820,37 @@ margin-bottom: 20px;
},
"sampleFormat" : {
"type" : "integer",
- "description" : "Sample format * 0 - integer * 1 - float\n"
+ "description" : "Sample format * 0 - integer * 1 - float\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"sampleSigned" : {
"type" : "integer",
- "description" : "Sample signed status\n * 0 - unsigned\n * 1 - signed\n"
+ "description" : "Sample signed status\n * 0 - unsigned\n * 1 - signed\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"sampleSwapIQ" : {
"type" : "integer",
- "description" : "Sample I/Q swap\n * 0 - I/Q\n * 1 - Q/I\n"
+ "description" : "Sample I/Q swap\n * 0 - I/Q\n * 1 - Q/I\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"crcStatus" : {
"type" : "integer",
- "description" : "CRC status\n * 0 - no CRC available\n * 1 - CRC (SHA512) OK\n * 2 - CRC (SHA512) KO\n"
+ "description" : "CRC status\n * 0 - no CRC available\n * 1 - CRC (SHA512) OK\n * 2 - CRC (SHA512) KO\n",
+ "minimum" : 0,
+ "maximum" : 2
},
"totalBytesStatus" : {
"type" : "integer",
- "description" : "Total number of bytes in data file vs meta data\n * 0 - mismatch\n * 1 - match\n"
+ "description" : "Total number of bytes in data file vs meta data\n * 0 - mismatch\n * 1 - match\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"captures" : {
"type" : "array",
+ "description" : "List of captures.",
"items" : {
"$ref" : "#/definitions/Capture"
}
@@ -16063,7 +19895,8 @@ margin-bottom: 20px;
defs.SigMFFileInputSettings = {
"properties" : {
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"fileName" : {
"type" : "string",
@@ -16083,16 +19916,23 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
}
},
"description" : "SigMFFileInput"
@@ -16101,7 +19941,9 @@ margin-bottom: 20px;
"properties" : {
"record" : {
"type" : "integer",
- "description" : "Record action\n * 0 - stop recording\n * 1 - start recording\n"
+ "description" : "Record action\n * 0 - stop recording\n * 1 - start recording\n",
+ "minimum" : 0,
+ "maximum" : 1
}
},
"description" : "SigMFFileSink"
@@ -16110,7 +19952,9 @@ margin-bottom: 20px;
"properties" : {
"spectrumSquelch" : {
"type" : "integer",
- "description" : "Spectrum squelch status * 0 - closed * 1 - open\n"
+ "description" : "Spectrum squelch status * 0 - closed * 1 - open\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"spectrumMax" : {
"type" : "number",
@@ -16118,14 +19962,18 @@ margin-bottom: 20px;
"description" : "Current spectrum max in squared magnitude (power)"
},
"sinkSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Sample rate accepted by the sink in samples per second."
},
"channelSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Effective sample rate delivered to the channel in samples per second."
},
"recording" : {
"type" : "integer",
- "description" : "Recording status * 0 - not recording * 1 - recording\n"
+ "description" : "Recording status * 0 - not recording * 1 - recording\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"recordTimeMs" : {
"type" : "integer",
@@ -16146,24 +19994,30 @@ margin-bottom: 20px;
defs.SigMFFileSinkSettings = {
"properties" : {
"inputFrequencyOffset" : {
- "type" : "integer"
+ "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"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"log2Decim" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent of the software decimation factor; the output sample rate is divided by 2^log2Decim."
},
"spectrumSquelchMode" : {
"type" : "integer",
- "description" : "Spectrum squelch system * 0 - deactivated * 1 - activated\n"
+ "description" : "Spectrum squelch system * 0 - deactivated * 1 - activated\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"spectrumSquelch" : {
"type" : "number",
@@ -16180,7 +20034,9 @@ margin-bottom: 20px;
},
"squelchRecordingEnable" : {
"type" : "integer",
- "description" : "Automatic recording triggered by spectrum squelch * 0 - disabled * 1 - enabled\n"
+ "description" : "Automatic recording triggered by spectrum squelch * 0 - disabled * 1 - enabled\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"log2RecordSampleSize" : {
"type" : "integer",
@@ -16192,27 +20048,38 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"spectrumConfig" : {
+ "description" : "Spectrum-display configuration.",
"$ref" : "#/definitions/GLSpectrum"
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -16222,11 +20089,15 @@ margin-bottom: 20px;
"properties" : {
"run" : {
"type" : "integer",
- "description" : "Set the plugin running state\n * 0 - idle\n * 1 - run\n"
+ "description" : "Set the plugin running state\n * 0 - idle\n * 1 - run\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"ptt" : {
"type" : "integer",
- "description" : "PTT action\n * 0 - release\n * 1 - engage\n"
+ "description" : "PTT action\n * 0 - release\n * 1 - engage\n",
+ "minimum" : 0,
+ "maximum" : 1
}
},
"description" : "Simple PTT actions"
@@ -16235,11 +20106,15 @@ margin-bottom: 20px;
"properties" : {
"runningState" : {
"type" : "integer",
- "description" : "Running state\n * 0 - not started\n * 1 - idle\n * 2 - running\n * 3 - error\n"
+ "description" : "Running state\n * 0 - not started\n * 1 - idle\n * 2 - running\n * 3 - error\n",
+ "minimum" : 0,
+ "maximum" : 3
},
"ptt" : {
"type" : "integer",
- "description" : "PTT status\n * 0 - released\n * 1 - engaged\n"
+ "description" : "PTT status\n * 0 - released\n * 1 - engaged\n",
+ "minimum" : 0,
+ "maximum" : 1
}
},
"description" : "Simple PTT report"
@@ -16247,10 +20122,12 @@ margin-bottom: 20px;
defs.SimplePTTSettings = {
"properties" : {
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"rxDeviceSetIndex" : {
"type" : "integer",
@@ -16270,11 +20147,15 @@ margin-bottom: 20px;
},
"vox" : {
"type" : "integer",
- "description" : "Activate vox system\n * 0 - not active\n * 1 - active\n"
+ "description" : "Activate vox system\n * 0 - not active\n * 1 - active\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"voxEnable" : {
"type" : "integer",
- "description" : "Allow vox to control PTT\n * 0 - vox does not control PTT\n * 1 - vox controls PTT\n"
+ "description" : "Allow vox to control PTT\n * 0 - vox does not control PTT\n * 1 - vox controls PTT\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"voxLevel" : {
"type" : "integer",
@@ -16285,15 +20166,20 @@ margin-bottom: 20px;
"description" : "Vox hold timeout in milliseconds"
},
"audioDeviceName" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Name of the audio device to use."
},
"gpioControl" : {
"type" : "integer",
- "description" : "GPIO control\n * 0 - No GPIO control\n * 1 - Rx side controls GPIO\n * 2 - Tx side controls GPIO\n"
+ "description" : "GPIO control\n * 0 - No GPIO control\n * 1 - Rx side controls GPIO\n * 2 - Tx side controls GPIO\n",
+ "minimum" : 0,
+ "maximum" : 2
},
"rx2txGPIOEnable" : {
"type" : "integer",
- "description" : "Enable Rx to Tx GPIO control\n * 0 - disable\n * 1 - enable\n"
+ "description" : "Enable Rx to Tx GPIO control\n * 0 - disable\n * 1 - enable\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"rx2txGPIOMask" : {
"type" : "integer",
@@ -16307,7 +20193,9 @@ margin-bottom: 20px;
},
"rx2txCommandEnable" : {
"type" : "integer",
- "description" : "Enable Rx to Tx command\n * 0 - disable\n * 1 - enable\n"
+ "description" : "Enable Rx to Tx command\n * 0 - disable\n * 1 - enable\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"rx2txCommand" : {
"type" : "string",
@@ -16315,7 +20203,9 @@ margin-bottom: 20px;
},
"tx2rxGPIOEnable" : {
"type" : "integer",
- "description" : "Enable Tx to Rx GPIO control\n * 0 - disable\n * 1 - enable\n"
+ "description" : "Enable Tx to Rx GPIO control\n * 0 - disable\n * 1 - enable\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"tx2rxGPIOMask" : {
"type" : "integer",
@@ -16329,7 +20219,9 @@ margin-bottom: 20px;
},
"tx2rxCommandEnable" : {
"type" : "integer",
- "description" : "Enable Tx to Rx command\n * 0 - disable\n * 1 - enable\n"
+ "description" : "Enable Tx to Rx command\n * 0 - disable\n * 1 - enable\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"tx2rxCommand" : {
"type" : "string",
@@ -16337,21 +20229,30 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIFeatureSetIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Feature-set index used by the reverse API peer."
},
"reverseAPIFeatureIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Feature index used by the reverse API peer."
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -16385,12 +20286,16 @@ margin-bottom: 20px;
"latitude" : {
"type" : "number",
"format" : "float",
- "description" : "Latitude in decimal degrees (North positive) of observation/antenna location"
+ "description" : "Latitude in decimal degrees (North positive) of observation/antenna location",
+ "minimum" : -90,
+ "maximum" : 90
},
"longitude" : {
"type" : "number",
"format" : "float",
- "description" : "Longitude in decimal degrees (East positive) of observation/antenna location"
+ "description" : "Longitude in decimal degrees (East positive) of observation/antenna location",
+ "minimum" : -180,
+ "maximum" : 180
},
"altitude" : {
"type" : "number",
@@ -16446,7 +20351,8 @@ margin-bottom: 20px;
"description" : "Name of background image set"
},
"projection" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Projection setting for Sky map."
},
"source" : {
"type" : "string",
@@ -16459,12 +20365,16 @@ margin-bottom: 20px;
"latitude" : {
"type" : "number",
"format" : "float",
- "description" : "Latitude in decimal degrees (North positive) of observation/antenna location"
+ "description" : "Latitude in decimal degrees (North positive) of observation/antenna location",
+ "minimum" : -90,
+ "maximum" : 90
},
"longitude" : {
"type" : "number",
"format" : "float",
- "description" : "Longitude in decimal degrees (East positive) of observation/antenna location"
+ "description" : "Longitude in decimal degrees (East positive) of observation/antenna location",
+ "minimum" : -180,
+ "maximum" : 180
},
"altitude" : {
"type" : "number",
@@ -16479,31 +20389,44 @@ margin-bottom: 20px;
"useMyPosition" : {
"type" : "number",
"format" : "float",
- "description" : "Use My Position instead of latitude/longitude settings"
+ "description" : "Use My Position instead of latitude/longitude settings",
+ "minimum" : 0,
+ "maximum" : 1
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIFeatureSetIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Feature-set index used by the reverse API peer."
},
"reverseAPIFeatureIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Feature index used by the reverse API peer."
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -16524,12 +20447,16 @@ margin-bottom: 20px;
"latitude" : {
"type" : "number",
"format" : "float",
- "description" : "Latitude in decimal degrees (North positive) of observation/antenna location"
+ "description" : "Latitude in decimal degrees (North positive) of observation/antenna location",
+ "minimum" : -90,
+ "maximum" : 90
},
"longitude" : {
"type" : "number",
"format" : "float",
- "description" : "Longitude in decimal degrees (East positive) of observation/antenna location"
+ "description" : "Longitude in decimal degrees (East positive) of observation/antenna location",
+ "minimum" : -180,
+ "maximum" : 180
},
"altitude" : {
"type" : "number",
@@ -16563,12 +20490,16 @@ margin-bottom: 20px;
"latitude" : {
"type" : "number",
"format" : "float",
- "description" : "Latitude in decimal degrees (North positive) of observation/antenna location"
+ "description" : "Latitude in decimal degrees (North positive) of observation/antenna location",
+ "minimum" : -90,
+ "maximum" : 90
},
"longitude" : {
"type" : "number",
"format" : "float",
- "description" : "Longitude in decimal degrees (East positive) of observation/antenna location"
+ "description" : "Longitude in decimal degrees (East positive) of observation/antenna location",
+ "minimum" : -180,
+ "maximum" : 180
},
"altitude" : {
"type" : "number",
@@ -16590,10 +20521,12 @@ margin-bottom: 20px;
defs.SoapySDRFrequencySetting = {
"properties" : {
"name" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Name."
},
"ranges" : {
"type" : "array",
+ "description" : "List of ranges.",
"items" : {
"$ref" : "#/definitions/RangeFloat"
}
@@ -16604,9 +20537,11 @@ margin-bottom: 20px;
defs.SoapySDRGainSetting = {
"properties" : {
"name" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Name."
},
"range" : {
+ "description" : "Range configuration for Definitions.",
"$ref" : "#/definitions/RangeFloat"
}
},
@@ -16615,107 +20550,144 @@ margin-bottom: 20px;
defs.SoapySDRInputSettings = {
"properties" : {
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"centerFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Device center frequency in Hz."
},
"LOppmTenths" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Local-oscillator correction in tenths of a part per million."
},
"devSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device I/Q sample rate in samples per second before software decimation or interpolation."
},
"log2Decim" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent of the software decimation factor; the output sample rate is divided by 2^log2Decim."
},
"fcPos" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Position of the decimated passband relative to the device center frequency."
},
"softDCCorrection" : {
"type" : "integer",
- "description" : "boolean not zero for true"
+ "description" : "boolean not zero for true",
+ "minimum" : 0,
+ "maximum" : 1
},
"softIQCorrection" : {
"type" : "integer",
- "description" : "boolean not zero for true"
+ "description" : "boolean not zero for true",
+ "minimum" : 0,
+ "maximum" : 1
},
"transverterMode" : {
"type" : "integer",
- "description" : "boolean not zero for true"
+ "description" : "boolean not zero for true",
+ "minimum" : 0,
+ "maximum" : 1
},
"transverterDeltaFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Frequency translation applied in transverter mode in Hz."
},
"iqOrder" : {
"type" : "integer",
- "description" : "IQ samples order\n * 0 - Q then I (swapped)\n * 1 - I then Q (straight)\n"
+ "description" : "IQ samples order\n * 0 - Q then I (swapped)\n * 1 - I then Q (straight)\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"antenna" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Antenna setting for Soapy sdr input."
},
"bandwidth" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Bandwidth in Hz."
},
"tunableElements" : {
"type" : "array",
+ "description" : "List of tunable elements.",
"items" : {
"$ref" : "#/definitions/ArgValue"
}
},
"globalGain" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Overall device gain setting."
},
"individualGains" : {
"type" : "array",
+ "description" : "List of individual gains.",
"items" : {
"$ref" : "#/definitions/ArgValue"
}
},
"autoGain" : {
"type" : "integer",
- "description" : "boolean not zero for true"
+ "description" : "boolean not zero for true",
+ "minimum" : 0,
+ "maximum" : 1
},
"autoDCCorrection" : {
"type" : "integer",
- "description" : "boolean not zero for true"
+ "description" : "boolean not zero for true",
+ "minimum" : 0,
+ "maximum" : 1
},
"autoIQCorrection" : {
"type" : "integer",
- "description" : "boolean not zero for true"
+ "description" : "boolean not zero for true",
+ "minimum" : 0,
+ "maximum" : 1
},
"dcCorrection" : {
+ "description" : "Enable DC-offset correction (1 enabled, 0 disabled).",
"$ref" : "#/definitions/Complex"
},
"iqCorrection" : {
+ "description" : "Enable I/Q imbalance correction (1 enabled, 0 disabled).",
"$ref" : "#/definitions/Complex"
},
"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" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
}
},
"description" : "SoapySDR"
@@ -16723,92 +20695,122 @@ margin-bottom: 20px;
defs.SoapySDROutputSettings = {
"properties" : {
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"centerFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Device center frequency in Hz."
},
"LOppmTenths" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Local-oscillator correction in tenths of a part per million."
},
"devSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device I/Q sample rate in samples per second before software decimation or interpolation."
},
"log2Interp" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent of the software interpolation factor; the output sample rate is multiplied by 2^log2Interp."
},
"transverterMode" : {
"type" : "integer",
- "description" : "boolean not zero for true"
+ "description" : "boolean not zero for true",
+ "minimum" : 0,
+ "maximum" : 1
},
"transverterDeltaFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Frequency translation applied in transverter mode in Hz."
},
"antenna" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Antenna setting for Soapy sdr output."
},
"bandwidth" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Bandwidth in Hz."
},
"tunableElements" : {
"type" : "array",
+ "description" : "List of tunable elements.",
"items" : {
"$ref" : "#/definitions/ArgValue"
}
},
"globalGain" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Overall device gain setting."
},
"individualGains" : {
"type" : "array",
+ "description" : "List of individual gains.",
"items" : {
"$ref" : "#/definitions/ArgValue"
}
},
"autoGain" : {
"type" : "integer",
- "description" : "boolean not zero for true"
+ "description" : "boolean not zero for true",
+ "minimum" : 0,
+ "maximum" : 1
},
"autoDCCorrection" : {
"type" : "integer",
- "description" : "boolean not zero for true"
+ "description" : "boolean not zero for true",
+ "minimum" : 0,
+ "maximum" : 1
},
"autoIQCorrection" : {
"type" : "integer",
- "description" : "boolean not zero for true"
+ "description" : "boolean not zero for true",
+ "minimum" : 0,
+ "maximum" : 1
},
"dcCorrection" : {
+ "description" : "Enable DC-offset correction (1 enabled, 0 disabled).",
"$ref" : "#/definitions/Complex"
},
"iqCorrection" : {
+ "description" : "Enable I/Q imbalance correction (1 enabled, 0 disabled).",
"$ref" : "#/definitions/Complex"
},
"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" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
}
},
"description" : "SoapySDR"
@@ -16817,71 +20819,90 @@ margin-bottom: 20px;
"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" : {
"type" : "integer",
- "description" : "boolean not zero for true"
+ "description" : "boolean not zero for true",
+ "minimum" : 0,
+ "maximum" : 1
},
"hasDCOffsetValue" : {
"type" : "integer",
- "description" : "boolean not zero for true"
+ "description" : "boolean not zero for true",
+ "minimum" : 0,
+ "maximum" : 1
},
"hasIQBalanceValue" : {
"type" : "integer",
- "description" : "boolean not zero for true"
+ "description" : "boolean not zero for true",
+ "minimum" : 0,
+ "maximum" : 1
},
"hasFrequencyCorrectionValue" : {
"type" : "integer",
- "description" : "boolean not zero for true"
+ "description" : "boolean not zero for true",
+ "minimum" : 0,
+ "maximum" : 1
},
"antennas" : {
"type" : "array",
+ "description" : "List of antennas.",
"items" : {
"type" : "string"
}
},
"hasAGC" : {
"type" : "integer",
- "description" : "boolean not zero for true"
+ "description" : "boolean not zero for true",
+ "minimum" : 0,
+ "maximum" : 1
},
"gainRange" : {
+ "description" : "Gain range data for Soapy sdr.",
"$ref" : "#/definitions/RangeFloat"
},
"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" : "#/definitions/RangeFloat"
}
},
"bandwidthsRanges" : {
"type" : "array",
+ "description" : "List of bandwidths ranges.",
"items" : {
"$ref" : "#/definitions/RangeFloat"
}
@@ -16893,10 +20914,12 @@ margin-bottom: 20px;
"properties" : {
"startFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Start frequency in Hz."
},
"bandwidth" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Bandwidth in Hz."
},
"markerColor" : {
"type" : "integer",
@@ -16904,7 +20927,9 @@ margin-bottom: 20px;
},
"show" : {
"type" : "integer",
- "description" : "SpectrumAnnotationMarker::ShowState - Marker display state\n * 0 - Hidden\n * 1 - Only top marker visible\n * 2 - Fully visible with text and full sized limits\n"
+ "description" : "SpectrumAnnotationMarker::ShowState - Marker display state\n * 0 - Hidden\n * 1 - Only top marker visible\n * 2 - Fully visible with text and full sized limits\n",
+ "minimum" : 0,
+ "maximum" : 2
}
},
"description" : "Spectrum annotation marker settings"
@@ -16913,15 +20938,18 @@ margin-bottom: 20px;
"properties" : {
"frequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Frequency in Hz."
},
"powerRelativeReference" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Power relative reference for Spectrum calibration point."
},
"powerAbsoluteReference" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Power absolute reference for Spectrum calibration point."
}
},
"description" : "Spectrum calibration point settings"
@@ -16930,7 +20958,8 @@ margin-bottom: 20px;
"properties" : {
"frequency" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Frequency in Hz."
},
"power" : {
"type" : "number",
@@ -16939,7 +20968,9 @@ margin-bottom: 20px;
},
"markerType" : {
"type" : "integer",
- "description" : "Marker type\n * 0 - Fixed power\n * 1 - Current power\n * 2 - Max power\n"
+ "description" : "Marker type\n * 0 - Fixed power\n * 1 - Current power\n * 2 - Max power\n",
+ "minimum" : 0,
+ "maximum" : 2
},
"markerColor" : {
"type" : "integer",
@@ -16947,7 +20978,9 @@ margin-bottom: 20px;
},
"show" : {
"type" : "integer",
- "description" : "Boolean - Marker display state\n * 0 - Hidden\n * 1 - Visible\n"
+ "description" : "Boolean - Marker display state\n * 0 - Hidden\n * 1 - Visible\n",
+ "minimum" : 0,
+ "maximum" : 1
}
},
"description" : "Spectrum histogram marker settings"
@@ -16988,7 +21021,8 @@ margin-bottom: 20px;
"properties" : {
"frequency" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Frequency in Hz."
},
"time" : {
"type" : "number",
@@ -17001,7 +21035,9 @@ margin-bottom: 20px;
},
"show" : {
"type" : "integer",
- "description" : "Boolean - Marker display state\n * 0 - Hidden\n * 1 - Visible\n"
+ "description" : "Boolean - Marker display state\n * 0 - Hidden\n * 1 - Visible\n",
+ "minimum" : 0,
+ "maximum" : 1
}
},
"description" : "Spectrum waterfall marker settings"
@@ -17010,7 +21046,9 @@ margin-bottom: 20px;
"properties" : {
"run" : {
"type" : "integer",
- "description" : "Set the plugin running state\n * 0 - idle\n * 1 - run\n"
+ "description" : "Set the plugin running state\n * 0 - idle\n * 1 - run\n",
+ "minimum" : 0,
+ "maximum" : 1
}
},
"description" : "Star Tracker actions"
@@ -17018,7 +21056,8 @@ margin-bottom: 20px;
defs.StarTrackerDisplayLoSSettings = {
"properties" : {
"name" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Name."
},
"b" : {
"type" : "number",
@@ -17041,7 +21080,8 @@ margin-bottom: 20px;
defs.StarTrackerDisplayLoSSettings_2 = {
"properties" : {
"name" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Name."
},
"b" : {
"type" : "number",
@@ -17103,7 +21143,9 @@ margin-bottom: 20px;
"properties" : {
"runningState" : {
"type" : "integer",
- "description" : "Running state\n * 0 - not started\n * 1 - idle\n * 2 - running\n * 3 - error\n"
+ "description" : "Running state\n * 0 - not started\n * 1 - idle\n * 2 - running\n * 3 - error\n",
+ "minimum" : 0,
+ "maximum" : 3
}
},
"description" : "RigCtl server report"
@@ -17155,12 +21197,16 @@ margin-bottom: 20px;
"latitude" : {
"type" : "number",
"format" : "float",
- "description" : "Latitude in decimal degrees (North positive) of observation/antenna location"
+ "description" : "Latitude in decimal degrees (North positive) of observation/antenna location",
+ "minimum" : -90,
+ "maximum" : 90
},
"longitude" : {
"type" : "number",
"format" : "float",
- "description" : "Longitude in decimal degrees (East positive) of observation/antenna location"
+ "description" : "Longitude in decimal degrees (East positive) of observation/antenna location",
+ "minimum" : -180,
+ "maximum" : 180
},
"dateTime" : {
"type" : "string",
@@ -17202,7 +21248,9 @@ margin-bottom: 20px;
},
"stellariumServerEnabled" : {
"type" : "integer",
- "description" : "Enable Stellarium server (1 for yes, 0 for no)"
+ "description" : "Enable Stellarium server (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"stellariumPort" : {
"type" : "integer",
@@ -17230,28 +21278,39 @@ margin-bottom: 20px;
"description" : "Draw the overhead position of the target Star on the Map (1 for yes, 0 for no)"
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIFeatureSetIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Feature-set index used by the reverse API peer."
},
"reverseAPIFeatureIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Feature index used by the reverse API peer."
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -17435,20 +21494,28 @@ margin-bottom: 20px;
defs.TestMISettings = {
"properties" : {
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"streams" : {
"type" : "array",
@@ -17463,18 +21530,22 @@ margin-bottom: 20px;
defs.TestMOSyncSettings = {
"properties" : {
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"centerFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Device center frequency in Hz."
},
"sampleRate" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Sample rate in samples per second."
},
"log2Interp" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent of the software interpolation factor; the output sample rate is multiplied by 2^log2Interp."
},
"fcPosTx" : {
"type" : "integer",
@@ -17491,56 +21562,72 @@ margin-bottom: 20px;
},
"centerFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Device center frequency in Hz."
},
"frequencyShift" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Frequency shift in Hz."
},
"sampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Sample rate in samples per second."
},
"log2Decim" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent of the software decimation factor; the output sample rate is divided by 2^log2Decim."
},
"fcPos" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Position of the decimated passband relative to the device center frequency."
},
"sampleSizeIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Selected sample size index."
},
"amplitudeBits" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Amplitude bits for Definitions."
},
"autoCorrOptions" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Auto corr options for Definitions."
},
"modulation" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Modulation for Definitions."
},
"modulationTone" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Modulation tone for Definitions."
},
"amModulation" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Am modulation for Definitions."
},
"fmDeviation" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "FM frequency deviation in Hz."
},
"dcFactor" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Dc factor for Definitions."
},
"iFactor" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "I factor for Definitions."
},
"qFactor" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Q factor for Definitions."
},
"phaseImbalance" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Phase imbalance for Definitions."
}
},
"description" : "TestMiStreamSettings"
@@ -17548,73 +21635,97 @@ margin-bottom: 20px;
defs.TestSourceSettings = {
"properties" : {
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"centerFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Device center frequency in Hz."
},
"frequencyShift" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Frequency shift in Hz."
},
"sampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Sample rate in samples per second."
},
"log2Decim" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent of the software decimation factor; the output sample rate is divided by 2^log2Decim."
},
"fcPos" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Position of the decimated passband relative to the device center frequency."
},
"sampleSizeIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Selected sample size index."
},
"amplitudeBits" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Amplitude bits setting for Test source."
},
"autoCorrOptions" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Auto corr options setting for Test source."
},
"modulation" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Modulation setting for Test source."
},
"modulationTone" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Modulation tone setting for Test source."
},
"amModulation" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Am modulation setting for Test source."
},
"fmDeviation" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "FM frequency deviation in Hz."
},
"dcFactor" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Dc factor setting for Test source."
},
"iFactor" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "I factor setting for Test source."
},
"qFactor" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Q factor setting for Test source."
},
"phaseImbalance" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Phase imbalance setting for Test source."
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
}
},
"description" : "TestSource"
@@ -17714,10 +21825,12 @@ margin-bottom: 20px;
"description" : "Level in real units"
},
"triggerLevelCoarse" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Trigger level coarse for Trigger data."
},
"triggerLevelFine" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Trigger level fine for Trigger data."
},
"triggerPositiveEdge" : {
"type" : "integer",
@@ -17741,10 +21854,12 @@ margin-bottom: 20px;
"description" : "Trigger delay as a multiplier of trace length"
},
"triggerDelayCoarse" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Trigger delay coarse for Trigger data."
},
"triggerDelayFine" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Trigger delay fine for Trigger data."
},
"triggerRepeat" : {
"type" : "integer",
@@ -17789,7 +21904,8 @@ margin-bottom: 20px;
"description" : "squelch status (1 if open else 0)"
},
"inputSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Input sample rate in samples per second."
}
},
"description" : "UDPSink"
@@ -17798,29 +21914,37 @@ margin-bottom: 20px;
"properties" : {
"outputSampleRate" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Output sample rate in samples per second."
},
"sampleFormat" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Sample format setting for UDP sink."
},
"inputFrequencyOffset" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Channel frequency offset from the device center frequency in Hz."
},
"rfBandwidth" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "RF bandwidth in Hz."
},
"fmDeviation" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "FM frequency deviation in Hz."
},
"channelMute" : {
"type" : "integer",
- "description" : "channel mute (1 if muted else 0)"
+ "description" : "channel mute (1 if muted else 0)",
+ "minimum" : 0,
+ "maximum" : 1
},
"gain" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Gain setting; units and available values depend on the device or plugin."
},
"squelchDB" : {
"type" : "integer",
@@ -17832,22 +21956,31 @@ margin-bottom: 20px;
},
"squelchEnabled" : {
"type" : "integer",
- "description" : "squelch enable (1 if enabled else 0)"
+ "description" : "squelch enable (1 if enabled else 0)",
+ "minimum" : 0,
+ "maximum" : 1
},
"agc" : {
"type" : "integer",
- "description" : "AGC enable (1 if enabled else 0)"
+ "description" : "AGC enable (1 if enabled else 0)",
+ "minimum" : 0,
+ "maximum" : 1
},
"audioActive" : {
"type" : "integer",
- "description" : "Audio return enable (1 if enabled else 0)"
+ "description" : "Audio return enable (1 if enabled else 0)",
+ "minimum" : 0,
+ "maximum" : 1
},
"audioStereo" : {
"type" : "integer",
- "description" : "Audio return stereo (1 if stereo else 0)"
+ "description" : "Audio return stereo (1 if stereo else 0)",
+ "minimum" : 0,
+ "maximum" : 1
},
"volume" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Audio volume multiplier."
},
"udpAddress" : {
"type" : "string",
@@ -17856,7 +21989,9 @@ margin-bottom: 20px;
"udpPort" : {
"type" : "integer",
"format" : "uint16",
- "description" : "destination UDP port (remote)"
+ "description" : "destination UDP port (remote)",
+ "minimum" : 1,
+ "maximum" : 65535
},
"audioPort" : {
"type" : "integer",
@@ -17864,10 +21999,12 @@ margin-bottom: 20px;
"description" : "audio return UDP port (local)"
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"streamIndex" : {
"type" : "integer",
@@ -17875,27 +22012,38 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"spectrumConfig" : {
+ "description" : "Spectrum-display configuration.",
"$ref" : "#/definitions/GLSpectrum"
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -17922,7 +22070,8 @@ margin-bottom: 20px;
"description" : "buffer R/W balance indicator"
},
"channelSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Effective sample rate delivered to the channel in samples per second."
}
},
"description" : "UDPSource"
@@ -17930,78 +22079,106 @@ margin-bottom: 20px;
defs.UDPSourceSettings = {
"properties" : {
"sampleFormat" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Sample format setting for UDP source."
},
"inputSampleRate" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Input sample rate in samples per second."
},
"inputFrequencyOffset" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Channel frequency offset from the device center frequency in Hz."
},
"rfBandwidth" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "RF bandwidth in Hz."
},
"lowCutoff" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Lower filter cutoff frequency in Hz."
},
"fmDeviation" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "FM frequency deviation in Hz."
},
"amModFactor" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Am mod factor setting for UDP source."
},
"channelMute" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Mute the channel output (1 muted, 0 unmuted).",
+ "minimum" : 0,
+ "maximum" : 1
},
"gainIn" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Gain in setting for UDP source."
},
"gainOut" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Gain out setting for UDP source."
},
"squelch" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Squelch threshold in dB."
},
"squelchGate" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Squelch gate duration."
},
"squelchEnabled" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable squelch (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"autoRWBalance" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Auto rw balance setting for UDP source."
},
"stereoInput" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Stereo input setting for UDP source."
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"udpAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name used for UDP traffic."
},
"udpPort" : {
"type" : "integer",
- "format" : "uint16"
+ "format" : "uint16",
+ "description" : "UDP port number.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"multicastAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IP multicast group address."
},
"multicastJoin" : {
"type" : "integer",
- "description" : "Join multicast group * 0 - leave group * 1 - join group\n"
+ "description" : "Join multicast group * 0 - leave group * 1 - join group\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"streamIndex" : {
"type" : "integer",
@@ -18009,27 +22186,38 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"spectrumConfig" : {
+ "description" : "Spectrum-display configuration.",
"$ref" : "#/definitions/GLSpectrum"
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -18043,13 +22231,17 @@ margin-bottom: 20px;
},
"streamActive" : {
"type" : "integer",
- "description" : "1 if active else 0"
+ "description" : "1 if active else 0",
+ "minimum" : 0,
+ "maximum" : 1
},
"overrunCount" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Number of stream overrun events."
},
"timeoutCount" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Number of timeout events or items."
}
},
"description" : "USRP"
@@ -18057,70 +22249,98 @@ margin-bottom: 20px;
defs.USRPInputSettings = {
"properties" : {
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"centerFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Device center frequency in Hz."
},
"devSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device I/Q sample rate in samples per second before software decimation or interpolation."
},
"loOffset" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "LO offset setting for Usrp input."
},
"dcBlock" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable DSP DC-offset correction (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"iqCorrection" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable I/Q imbalance correction (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"log2SoftDecim" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent of the software decimation factor."
},
"lpfBW" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Analog low-pass filter bandwidth in Hz."
},
"antennaPath" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Selected RF antenna path."
},
"gain" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Gain setting; units and available values depend on the device or plugin."
},
"gainMode" : {
"type" : "integer",
"description" : "0 for auto, 1 for manual"
},
"clockSource" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Clock source setting for Usrp input."
},
"transverterMode" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable transverter frequency translation (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"transverterDeltaFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Frequency translation applied in transverter mode in Hz."
},
"gpioDir" : {
"type" : "integer",
- "format" : "int8"
+ "format" : "int8",
+ "description" : "GPIO direction bit mask, with one bit per pin."
},
"gpioPins" : {
"type" : "integer",
- "format" : "int8"
+ "format" : "int8",
+ "description" : "GPIO pin-state bit mask, with one bit per pin."
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
}
},
"description" : "USRP"
@@ -18133,13 +22353,17 @@ margin-bottom: 20px;
},
"streamActive" : {
"type" : "integer",
- "description" : "1 if active else 0"
+ "description" : "1 if active else 0",
+ "minimum" : 0,
+ "maximum" : 1
},
"underrunCount" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Number of stream underrun events."
},
"droppedPacketsCount" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Number of dropped packets."
}
},
"description" : "USRP"
@@ -18147,60 +22371,82 @@ margin-bottom: 20px;
defs.USRPOutputSettings = {
"properties" : {
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"centerFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Device center frequency in Hz."
},
"devSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device I/Q sample rate in samples per second before software decimation or interpolation."
},
"loOffset" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "LO offset setting for Usrp output."
},
"log2SoftInterp" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent of the software interpolation factor."
},
"lpfBW" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Analog low-pass filter bandwidth in Hz."
},
"gain" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Gain setting; units and available values depend on the device or plugin."
},
"antennaPath" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Selected RF antenna path."
},
"clockSource" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Clock source setting for Usrp output."
},
"transverterMode" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable transverter frequency translation (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"transverterDeltaFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Frequency translation applied in transverter mode in Hz."
},
"gpioDir" : {
"type" : "integer",
- "format" : "int8"
+ "format" : "int8",
+ "description" : "GPIO direction bit mask, with one bit per pin."
},
"gpioPins" : {
"type" : "integer",
- "format" : "int8"
+ "format" : "int8",
+ "description" : "GPIO pin-state bit mask, with one bit per pin."
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
}
},
"description" : "USRP"
@@ -18217,11 +22463,13 @@ margin-bottom: 20px;
"description" : "squelch status (1 if open else 0)"
},
"audioSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Audio sample rate in samples per second."
},
"volume" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Audio volume multiplier."
},
"navId" : {
"type" : "integer",
@@ -18244,15 +22492,21 @@ margin-bottom: 20px;
},
"validRadial" : {
"type" : "integer",
- "description" : "Radial validity estimation\n * 0 - Radial is invalid\n * 1 - Radial is valid\n"
+ "description" : "Radial validity estimation\n * 0 - Radial is invalid\n * 1 - Radial is valid\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"validRefMag" : {
"type" : "integer",
- "description" : "Reference signal magnitude validity\n * 0 - Magnitude below threshold\n * 1 - Magnitude above threshold\n"
+ "description" : "Reference signal magnitude validity\n * 0 - Magnitude below threshold\n * 1 - Magnitude above threshold\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"validVarMag" : {
"type" : "integer",
- "description" : "Variable signal magnitude validity\n * 0 - Magnitude below threshold\n * 1 - Magnitude above threshold\n"
+ "description" : "Variable signal magnitude validity\n * 0 - Magnitude below threshold\n * 1 - Magnitude above threshold\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"morseIdent" : {
"type" : "string",
@@ -18265,7 +22519,8 @@ margin-bottom: 20px;
"properties" : {
"inputFrequencyOffset" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Channel frequency offset from the device center frequency in Hz."
},
"navId" : {
"type" : "integer",
@@ -18278,22 +22533,30 @@ margin-bottom: 20px;
},
"volume" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Audio volume multiplier."
},
"audioMute" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Mute audio output (1 muted, 0 unmuted).",
+ "minimum" : 0,
+ "maximum" : 1
},
"identBandpassEnable" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Ident bandpass enable setting for Vor demod."
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"audioDeviceName" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Name of the audio device to use."
},
"streamIndex" : {
"type" : "integer",
@@ -18301,28 +22564,38 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"identThreshold" : {
"type" : "integer",
"description" : "Morse code ident threshold (linear SNR)"
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -18332,7 +22605,9 @@ margin-bottom: 20px;
"properties" : {
"run" : {
"type" : "integer",
- "description" : "Set the plugin running state\n * 0 - idle\n * 1 - run\n"
+ "description" : "Set the plugin running state\n * 0 - idle\n * 1 - run\n",
+ "minimum" : 0,
+ "maximum" : 1
}
},
"description" : "VORLocalizer"
@@ -18341,7 +22616,9 @@ margin-bottom: 20px;
"properties" : {
"runningState" : {
"type" : "integer",
- "description" : "Running state\n * 0 - not started\n * 1 - idle\n * 2 - running\n * 3 - error\n"
+ "description" : "Running state\n * 0 - not started\n * 1 - idle\n * 2 - running\n * 3 - error\n",
+ "minimum" : 0,
+ "maximum" : 3
}
},
"description" : "VORLocalizers"
@@ -18349,26 +22626,36 @@ margin-bottom: 20px;
defs.VORLocalizerSettings = {
"properties" : {
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIFeatureSetIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Feature-set index used by the reverse API peer."
},
"reverseAPIFeatureIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Feature index used by the reverse API peer."
},
"magDecAdjust" : {
"type" : "integer",
@@ -18380,23 +22667,28 @@ margin-bottom: 20px;
},
"forceRRAveraging" : {
"type" : "integer",
- "description" : "Force radial and signal magnitudes averaging over the round robin turn\n * 0 - Do not force averaging\n * 1 - Force averaging\n"
+ "description" : "Force radial and signal magnitudes averaging over the round robin turn\n * 0 - Do not force averaging\n * 1 - Force averaging\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"centerShift" : {
"type" : "integer",
"description" : "Shift of center frequency in Hz"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
},
"columnIndexes" : {
"type" : "array",
+ "description" : "List of column indexes.",
"items" : {
"type" : "integer"
}
},
"columnSizes" : {
"type" : "array",
+ "description" : "List of column sizes.",
"items" : {
"type" : "integer"
}
@@ -18416,10 +22708,12 @@ margin-bottom: 20px;
"description" : "Audio squelch status (1 if open else 0)"
},
"audioSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Audio sample rate in samples per second."
},
"channelSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Effective sample rate delivered to the channel in samples per second."
}
},
"description" : "WDSPRx"
@@ -18428,18 +22722,23 @@ margin-bottom: 20px;
"properties" : {
"inputFrequencyOffset" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Channel frequency offset from the device center frequency in Hz."
},
"profileIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Selected profile index."
},
"demod" : {
"type" : "integer",
- "description" : "Demodulator type:\n * 0 - SSB\n * 1 - AM\n * 2 - SAM\n * 3 - FM\n"
+ "description" : "Demodulator type:\n * 0 - SSB\n * 1 - AM\n * 2 - SAM\n * 3 - FM\n",
+ "minimum" : 0,
+ "maximum" : 3
},
"volume" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Audio volume multiplier."
},
"audioBinaural" : {
"type" : "integer",
@@ -18455,15 +22754,21 @@ margin-bottom: 20px;
},
"audioMute" : {
"type" : "integer",
- "description" : "Mute audio (1 if muted else 0)"
+ "description" : "Mute audio (1 if muted else 0)",
+ "minimum" : 0,
+ "maximum" : 1
},
"agc" : {
"type" : "integer",
- "description" : "AGC (1 if AGC active else 0)"
+ "description" : "AGC (1 if AGC active else 0)",
+ "minimum" : 0,
+ "maximum" : 1
},
"agcMode" : {
"type" : "integer",
- "description" : "AGC Mode:\n * 0 - Long\n * 1 - Slow\n * 2 - Medium\n * 3 - Fast\n"
+ "description" : "AGC Mode:\n * 0 - Long\n * 1 - Slow\n * 2 - Medium\n * 3 - Fast\n",
+ "minimum" : 0,
+ "maximum" : 3
},
"agcGain" : {
"type" : "integer",
@@ -18474,19 +22779,26 @@ margin-bottom: 20px;
"description" : "Slope in centi-Bels"
},
"agcHangThreshold" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Agc hang threshold setting for Wdsp receive."
},
"dnb" : {
"type" : "integer",
- "description" : "Digital Noise Blanker:\n * 0 - Off\n * 1 - On\n"
+ "description" : "Digital Noise Blanker:\n * 0 - Off\n * 1 - On\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"nbScheme" : {
"type" : "integer",
- "description" : "Noise blanker scheme:\n * 0 - NB or Preemptive Wideband Noise Blanker\n * 1 - NB2 or Interpolating Wideband Noise Blanker\n"
+ "description" : "Noise blanker scheme:\n * 0 - NB or Preemptive Wideband Noise Blanker\n * 1 - NB2 or Interpolating Wideband Noise Blanker\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"nb2Mode" : {
"type" : "integer",
- "description" : "NB2 Noise blanking mode:\n * 0 - Zero mode (estimate as zero)\n * 1 - Sample‐hold (take the value of non‐corrupt signal at the beginning of the impulse and hold that throughout the corrupt sequence)\n * 2 - Mean‐hold (average the non‐corrupt values at the beginning and end of the corrupt sequence and use that as the estimate during the corrupt sequence)\n * 3 - hold‐sample (take the value of non‐corrupt signal at the end of the impulse and hold that throughout the corrupt sequence)\n * 4 - linearly interpolate across the corrupt sequence.\n"
+ "description" : "NB2 Noise blanking mode:\n * 0 - Zero mode (estimate as zero)\n * 1 - Sample‐hold (take the value of non‐corrupt signal at the beginning of the impulse and hold that throughout the corrupt sequence)\n * 2 - Mean‐hold (average the non‐corrupt values at the beginning and end of the corrupt sequence and use that as the estimate during the corrupt sequence)\n * 3 - hold‐sample (take the value of non‐corrupt signal at the end of the impulse and hold that throughout the corrupt sequence)\n * 4 - linearly interpolate across the corrupt sequence.\n",
+ "minimum" : 0,
+ "maximum" : 4
},
"nbSlewTime" : {
"type" : "number",
@@ -18504,47 +22816,67 @@ margin-bottom: 20px;
"description" : "Hang time (S)"
},
"nbThreshold" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Nb threshold setting for Wdsp receive."
},
"nbAvgTime" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Nb avg time setting for Wdsp receive."
},
"dnr" : {
"type" : "integer",
- "description" : "Digital Noise Reduction:\n * 0 - Off\n * 1 - On\n"
+ "description" : "Digital Noise Reduction:\n * 0 - Off\n * 1 - On\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"anf" : {
"type" : "integer",
- "description" : "Automatic Notch Filter:\n * 0 - Off\n * 1 - On\n"
+ "description" : "Automatic Notch Filter:\n * 0 - Off\n * 1 - On\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"nrScheme" : {
"type" : "integer",
- "description" : "Noise Reduction Scheme:\n * 0 - NR or LMS Noise Reduction\n * 1 - NR2 or Spectral Noise Reduction\n"
+ "description" : "Noise Reduction Scheme:\n * 0 - NR or LMS Noise Reduction\n * 1 - NR2 or Spectral Noise Reduction\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"nr2Gain" : {
"type" : "integer",
- "description" : "Noise Reduction gain for NR2:\n * 0 - Linear\n * 1 - Log\n * 2 - Gamma\n"
+ "description" : "Noise Reduction gain for NR2:\n * 0 - Linear\n * 1 - Log\n * 2 - Gamma\n",
+ "minimum" : 0,
+ "maximum" : 2
},
"nr2NPE" : {
"type" : "integer",
- "description" : "Noise Power Estimation algorithm for NR2:\n * 0 - Optimal Smoothing Minimum Statistics (OSMS)\n * 1 - Minimum Mean‐Square Error (MMSE)\n"
+ "description" : "Noise Power Estimation algorithm for NR2:\n * 0 - Optimal Smoothing Minimum Statistics (OSMS)\n * 1 - Minimum Mean‐Square Error (MMSE)\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"nrPosition" : {
"type" : "integer",
- "description" : "Noise reduction position:\n * 0 - Before AGC\n * 1 - After AGC\n"
+ "description" : "Noise reduction position:\n * 0 - Before AGC\n * 1 - After AGC\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"nr2ArtifactReduction" : {
"type" : "integer",
- "description" : "NR2 artifacts reduction:\n * 0 - Off\n * 1 - On\n"
+ "description" : "NR2 artifacts reduction:\n * 0 - Off\n * 1 - On\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"amFadeLevel" : {
"type" : "integer",
- "description" : "AM fade levelling:\n * 0 - Off\n * 1 - On\n"
+ "description" : "AM fade levelling:\n * 0 - Off\n * 1 - On\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"cwPeaking" : {
"type" : "integer",
- "description" : "CW peaking filter:\n * 0 - Off\n * 1 - On\n"
+ "description" : "CW peaking filter:\n * 0 - Off\n * 1 - On\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"cwPeakFrequency" : {
"type" : "number",
@@ -18578,7 +22910,9 @@ margin-bottom: 20px;
},
"fmAFLimiter" : {
"type" : "integer",
- "description" : "FM Audio level limiter (audio AGC)\n * 0 - Off\n * 1 - On\n"
+ "description" : "FM Audio level limiter (audio AGC)\n * 0 - Off\n * 1 - On\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"fmAFLimiterGain" : {
"type" : "number",
@@ -18587,7 +22921,9 @@ margin-bottom: 20px;
},
"fmCTCSSNotch" : {
"type" : "integer",
- "description" : "FM CTCSS notch filter\n * 0 - Off\n * 1 - On\n"
+ "description" : "FM CTCSS notch filter\n * 0 - Off\n * 1 - On\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"fmCTCSSNotchFrequency" : {
"type" : "number",
@@ -18596,7 +22932,9 @@ margin-bottom: 20px;
},
"squelch" : {
"type" : "integer",
- "description" : "Squelch:\n * 0 - Off\n * 1 - On\n"
+ "description" : "Squelch:\n * 0 - Off\n * 1 - On\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"squelchThreshold" : {
"type" : "integer",
@@ -18604,12 +22942,16 @@ margin-bottom: 20px;
},
"squelchMode" : {
"type" : "integer",
- "description" : "Squelch mode:\n * 0 - Voice squelch (for SSB). Based on voice artifacts.\n * 1 - AM squelch (for AM, SAM, CW). Signal power based.\n * 2 - FM squelch (for FM). Demod noise based squelch\n"
+ "description" : "Squelch mode:\n * 0 - Voice squelch (for SSB). Based on voice artifacts.\n * 1 - AM squelch (for AM, SAM, CW). Signal power based.\n * 2 - FM squelch (for FM). Demod noise based squelch\n",
+ "minimum" : 0,
+ "maximum" : 2
},
"ssqlTauMute" : {
"type" : "number",
"format" : "float",
- "description" : "Voice squelch tau mute (s)"
+ "description" : "Voice squelch tau mute (s)",
+ "minimum" : 0,
+ "maximum" : 1
},
"ssqlTauUnmute" : {
"type" : "number",
@@ -18623,7 +22965,9 @@ margin-bottom: 20px;
},
"equalizer" : {
"type" : "integer",
- "description" : "AF equalizer:\n * 0 - Off\n * 1 - On\n"
+ "description" : "AF equalizer:\n * 0 - Off\n * 1 - On\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"eqF" : {
"type" : "array",
@@ -18643,7 +22987,9 @@ margin-bottom: 20px;
},
"rit" : {
"type" : "integer",
- "description" : "RIT:\n * 0 - Off\n * 1 - On\n"
+ "description" : "RIT:\n * 0 - Off\n * 1 - On\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"ritFrequency" : {
"type" : "number",
@@ -18651,28 +22997,36 @@ margin-bottom: 20px;
"description" : "RIT shift frequency (Hz)"
},
"spanLog2" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent controlling the displayed or processed frequency span."
},
"rfBandwidth" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "RF bandwidth in Hz."
},
"lowCutoff" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Lower filter cutoff frequency in Hz."
},
"fftWindow" : {
"type" : "integer",
- "description" : "FFT Window index (FFTWindow::Function):\n * 0 - Blackman-Harris 4 term\n * 1 - Blackman-Harris 7 term\n"
+ "description" : "FFT Window index (FFTWindow::Function):\n * 0 - Blackman-Harris 4 term\n * 1 - Blackman-Harris 7 term\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"audioDeviceName" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Name of the audio device to use."
},
"streamIndex" : {
"type" : "integer",
@@ -18680,27 +23034,38 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"spectrumConfig" : {
+ "description" : "Spectrum-display configuration.",
"$ref" : "#/definitions/GLSpectrum"
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -18718,10 +23083,12 @@ margin-bottom: 20px;
"description" : "squelch status (1 if open else 0)"
},
"audioSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Audio sample rate in samples per second."
},
"channelSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Effective sample rate delivered to the channel in samples per second."
}
},
"description" : "WFMDemod"
@@ -18730,36 +23097,46 @@ margin-bottom: 20px;
"properties" : {
"inputFrequencyOffset" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Channel frequency offset from the device center frequency in Hz."
},
"rfBandwidth" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "RF bandwidth in Hz."
},
"afBandwidth" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Audio-frequency bandwidth in Hz."
},
"volume" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Audio volume multiplier."
},
"squelch" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Squelch threshold in dB."
},
"audioMute" : {
"type" : "integer",
- "description" : "audio mute (1 if muted else 0)"
+ "description" : "audio mute (1 if muted else 0)",
+ "minimum" : 0,
+ "maximum" : 1
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"audioDeviceName" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Name of the audio device to use."
},
"streamIndex" : {
"type" : "integer",
@@ -18767,24 +23144,34 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -18798,10 +23185,12 @@ margin-bottom: 20px;
"description" : "power transmitted in channel (dB)"
},
"audioSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Audio sample rate in samples per second."
},
"channelSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Effective sample rate delivered to the channel in samples per second."
}
},
"description" : "WFMMod"
@@ -18810,45 +23199,61 @@ margin-bottom: 20px;
"properties" : {
"inputFrequencyOffset" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Channel frequency offset from the device center frequency in Hz."
},
"rfBandwidth" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "RF bandwidth in Hz."
},
"afBandwidth" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Audio-frequency bandwidth in Hz."
},
"fmDeviation" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "FM frequency deviation in Hz."
},
"toneFrequency" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Tone frequency in Hz."
},
"volumeFactor" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Volume factor setting for Wfm mod."
},
"channelMute" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Mute the channel output (1 muted, 0 unmuted).",
+ "minimum" : 0,
+ "maximum" : 1
},
"playLoop" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Loop playback at end of file (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"audioDeviceName" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Name of the audio device to use."
},
"modAFInput" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Audio-frequency modulation input selection."
},
"streamIndex" : {
"type" : "integer",
@@ -18856,27 +23261,38 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"cwKeyer" : {
+ "description" : "CW keyer configuration.",
"$ref" : "#/definitions/CWKeyerSettings"
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -18899,14 +23315,17 @@ margin-bottom: 20px;
"description" : "1 if info was successfully retrieved else 0"
},
"fifoSize" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "FIFO capacity in samples."
},
"fifoFill" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Current FIFO fill level."
},
"temperature" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Reported device temperature."
},
"gpsLock" : {
"type" : "integer",
@@ -18918,28 +23337,37 @@ margin-bottom: 20px;
defs.XtrxInputSettings = {
"properties" : {
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"centerFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Device center frequency in Hz."
},
"devSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device I/Q sample rate in samples per second before software decimation or interpolation."
},
"log2HardDecim" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent of the hardware decimation factor."
},
"dcBlock" : {
"type" : "integer",
- "description" : "Software DC blocking (1 for yes, 0 for no)"
+ "description" : "Software DC blocking (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"iqCorrection" : {
"type" : "integer",
- "description" : "Software IQ imbalance correction (1 for yes, 0 for no)"
+ "description" : "Software IQ imbalance correction (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"log2SoftDecim" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent of the software decimation factor."
},
"lpfBW" : {
"type" : "integer",
@@ -18951,7 +23379,9 @@ margin-bottom: 20px;
},
"ncoEnable" : {
"type" : "integer",
- "description" : "Enable TSP NCO and mixing (1 for yes, 0 for no)"
+ "description" : "Enable TSP NCO and mixing (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"ncoFrequency" : {
"type" : "integer",
@@ -18979,7 +23409,9 @@ margin-bottom: 20px;
},
"extClock" : {
"type" : "integer",
- "description" : "Use external clock source (1 for yes, 0 for no)"
+ "description" : "Use external clock source (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"extClockFreq" : {
"type" : "integer",
@@ -18991,20 +23423,29 @@ margin-bottom: 20px;
},
"iqOrder" : {
"type" : "integer",
- "description" : "IQ samples order\n * 0 - Q then I (swapped)\n * 1 - I then Q (straight)\n"
+ "description" : "IQ samples order\n * 0 - Q then I (swapped)\n * 1 - I then Q (straight)\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
}
},
"description" : "XTRX"
@@ -19016,30 +23457,37 @@ margin-bottom: 20px;
"description" : "1 if info was successfully retrieved else 0"
},
"fifoSize" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "FIFO capacity in samples."
},
"fifoFillRx" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Current receive FIFO fill level."
},
"fifoFillTx" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Current transmit FIFO fill level."
},
"temperature" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Reported device temperature."
},
"gpsLock" : {
"type" : "integer",
"description" : "1 if GPSDO is locked else 0"
},
"actualInputRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Reported actual input rate."
},
"actualOutputRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Reported actual output rate."
},
"clockGenRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Reported clock gen rate."
}
},
"description" : "XTRX"
@@ -19047,11 +23495,14 @@ margin-bottom: 20px;
defs.XtrxMIMOSettings = {
"properties" : {
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"extClock" : {
"type" : "integer",
- "description" : "Boolean 1 if external clock source else 0"
+ "description" : "Boolean 1 if external clock source else 0",
+ "minimum" : 0,
+ "maximum" : 1
},
"extClockFreq" : {
"type" : "integer",
@@ -19067,7 +23518,9 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Boolean 1 use 0 do not use reverse API"
+ "description" : "Boolean 1 use 0 do not use reverse API",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
"type" : "string",
@@ -19075,13 +23528,17 @@ margin-bottom: 20px;
},
"reverseAPIPort" : {
"type" : "integer",
- "description" : "Network port from 1024 to 65535"
+ "description" : "Network port from 1024 to 65535",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"rxDevSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Receive dev sample rate in samples per second."
},
"log2HardDecim" : {
"type" : "integer",
@@ -19093,15 +23550,20 @@ margin-bottom: 20px;
},
"rxCenterFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Receive center frequency in Hz."
},
"dcBlock" : {
"type" : "integer",
- "description" : "Software DC blocking (1 for yes, 0 for no)"
+ "description" : "Software DC blocking (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"iqCorrection" : {
"type" : "integer",
- "description" : "Software IQ imbalance correction (1 for yes, 0 for no)"
+ "description" : "Software IQ imbalance correction (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"ncoEnableRx" : {
"type" : "integer",
@@ -19113,11 +23575,15 @@ margin-bottom: 20px;
},
"antennaPathRx" : {
"type" : "integer",
- "description" : "Antenna selected (enum value from XTRXMIMOSettings::RxAntenna):\n * 0 - RXANT_LO low range\n * 1 - RXANT_WI wide range\n * 2 - RXANT_HI high range\n"
+ "description" : "Antenna selected (enum value from XTRXMIMOSettings::RxAntenna):\n * 0 - RXANT_LO low range\n * 1 - RXANT_WI wide range\n * 2 - RXANT_HI high range\n",
+ "minimum" : 0,
+ "maximum" : 2
},
"iqOrder" : {
"type" : "integer",
- "description" : "IQ samples order\n * 0 - Q then I (swapped)\n * 1 - I then Q (straight)\n"
+ "description" : "IQ samples order\n * 0 - Q then I (swapped)\n * 1 - I then Q (straight)\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"lpfBWRx0" : {
"type" : "integer",
@@ -19129,7 +23595,9 @@ margin-bottom: 20px;
},
"gainModeRx0" : {
"type" : "integer",
- "description" : "Gain mode (XTRXMIMOSettings::GainMode) for Rx channel 0:\n * 0 - GAIN_AUTO automatic\n * 1 - GAIN_MANUAL manual\n"
+ "description" : "Gain mode (XTRXMIMOSettings::GainMode) for Rx channel 0:\n * 0 - GAIN_AUTO automatic\n * 1 - GAIN_MANUAL manual\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"lnaGainRx0" : {
"type" : "integer",
@@ -19144,7 +23612,8 @@ margin-bottom: 20px;
"description" : "Manual PGA gain (dB) for Rx channel 0"
},
"pwrmodeRx0" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Pwrmode rx0 setting for Xtrx MIMO."
},
"lpfBWRx1" : {
"type" : "integer",
@@ -19156,7 +23625,9 @@ margin-bottom: 20px;
},
"gainModeRx1" : {
"type" : "integer",
- "description" : "Gain mode (XTRXMIMOSettings::GainMode) for Rx channel 1:\n * 0 - GAIN_AUTO automatic\n * 1 - GAIN_MANUAL manual\n"
+ "description" : "Gain mode (XTRXMIMOSettings::GainMode) for Rx channel 1:\n * 0 - GAIN_AUTO automatic\n * 1 - GAIN_MANUAL manual\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"lnaGainRx1" : {
"type" : "integer",
@@ -19171,10 +23642,12 @@ margin-bottom: 20px;
"description" : "Manual PGA gain (dB) for Rx channel 1"
},
"pwrmodeRx1" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Pwrmode rx1 setting for Xtrx MIMO."
},
"txDevSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Transmit dev sample rate in samples per second."
},
"log2HardInterp" : {
"type" : "integer",
@@ -19186,7 +23659,8 @@ margin-bottom: 20px;
},
"txCenterFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Transmit center frequency in Hz."
},
"ncoEnableTx" : {
"type" : "integer",
@@ -19198,7 +23672,9 @@ margin-bottom: 20px;
},
"antennaPathTx" : {
"type" : "integer",
- "description" : "Antenna selected (enum value from XTRXMIMOSettings::TxAntenna):\n * 0 - TXANT_HI high range\n * 1 - TXANT_WI wide range\n"
+ "description" : "Antenna selected (enum value from XTRXMIMOSettings::TxAntenna):\n * 0 - TXANT_HI high range\n * 1 - TXANT_WI wide range\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"lpfBWTx0" : {
"type" : "integer",
@@ -19209,7 +23685,8 @@ margin-bottom: 20px;
"description" : "Optimally distributed gain (dB) for Tx channel 0"
},
"pwrmodeTx0" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Pwrmode tx0 setting for Xtrx MIMO."
},
"lpfBWTx1" : {
"type" : "integer",
@@ -19220,7 +23697,8 @@ margin-bottom: 20px;
"description" : "Optimally distributed gain (dB) for Tx channel 1"
},
"pwrmodeTx1" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Pwrmode tx1 setting for Xtrx MIMO."
}
},
"description" : "XTRX"
@@ -19232,14 +23710,17 @@ margin-bottom: 20px;
"description" : "1 if info was successfully retrieved else 0"
},
"fifoSize" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "FIFO capacity in samples."
},
"fifoFill" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Current FIFO fill level."
},
"temperature" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Reported device temperature."
},
"gpsLock" : {
"type" : "integer",
@@ -19251,20 +23732,25 @@ margin-bottom: 20px;
defs.XtrxOutputSettings = {
"properties" : {
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"centerFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Device center frequency in Hz."
},
"devSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device I/Q sample rate in samples per second before software decimation or interpolation."
},
"log2HardInterp" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent of the hardware interpolation factor."
},
"log2SoftInterp" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent of the software interpolation factor."
},
"lpfBW" : {
"type" : "integer",
@@ -19276,7 +23762,9 @@ margin-bottom: 20px;
},
"ncoEnable" : {
"type" : "integer",
- "description" : "Enable TSP NCO and mixing (1 for yes, 0 for no)"
+ "description" : "Enable TSP NCO and mixing (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"ncoFrequency" : {
"type" : "integer",
@@ -19288,7 +23776,9 @@ margin-bottom: 20px;
},
"extClock" : {
"type" : "integer",
- "description" : "Use external clock source (1 for yes, 0 for no)"
+ "description" : "Use external clock source (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"extClockFreq" : {
"type" : "integer",
@@ -19300,16 +23790,23 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
}
},
"description" : "XTRX"
@@ -60747,7 +65244,7 @@ except ApiException as e:
- Generated 2026-08-04T03:09:32.867+02:00
+ Generated 2026-09-06T09:56:57.532+02:00
diff --git a/sdrbase/resources/webapi/doc/swagger/include/ADSBDemod.yaml b/sdrbase/resources/webapi/doc/swagger/include/ADSBDemod.yaml
index 8edf06537..d7a08223f 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/ADSBDemod.yaml
+++ b/sdrbase/resources/webapi/doc/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: "/doc/swagger/include/ChannelMarker.yaml#/ChannelMarker"
+ description: "Channel-marker display configuration."
rollupState:
$ref: "/doc/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: "/doc/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/sdrbase/resources/webapi/doc/swagger/include/AFC.yaml b/sdrbase/resources/webapi/doc/swagger/include/AFC.yaml
index 8f7faaf47..790116cd5 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/AFC.yaml
+++ b/sdrbase/resources/webapi/doc/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: "/doc/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/sdrbase/resources/webapi/doc/swagger/include/AIS.yaml b/sdrbase/resources/webapi/doc/swagger/include/AIS.yaml
index a62f10bc9..38c954430 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/AIS.yaml
+++ b/sdrbase/resources/webapi/doc/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: "/doc/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/sdrbase/resources/webapi/doc/swagger/include/AISDemod.yaml b/sdrbase/resources/webapi/doc/swagger/include/AISDemod.yaml
index ebdd0eb6d..5bd803c75 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/AISDemod.yaml
+++ b/sdrbase/resources/webapi/doc/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: "/doc/swagger/include/GLScope.yaml#/GLScope"
+ description: "Oscilloscope-display configuration."
channelMarker:
$ref: "/doc/swagger/include/ChannelMarker.yaml#/ChannelMarker"
+ description: "Channel-marker display configuration."
rollupState:
$ref: "/doc/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/sdrbase/resources/webapi/doc/swagger/include/AISMod.yaml b/sdrbase/resources/webapi/doc/swagger/include/AISMod.yaml
index 22b29f1f7..0e965e14a 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/AISMod.yaml
+++ b/sdrbase/resources/webapi/doc/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: "/doc/swagger/include/ChannelMarker.yaml#/ChannelMarker"
+ description: "Channel-marker display configuration."
rollupState:
$ref: "/doc/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/sdrbase/resources/webapi/doc/swagger/include/AMBE.yaml b/sdrbase/resources/webapi/doc/swagger/include/AMBE.yaml
index 1720cecfb..fd8d396f8 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/AMBE.yaml
+++ b/sdrbase/resources/webapi/doc/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: "/doc/swagger/include/RollupState.yaml#/RollupState"
+ description: "Saved expanded or collapsed state of the GUI sections."
AMBEReport:
description: AMBE
diff --git a/sdrbase/resources/webapi/doc/swagger/include/AMDemod.yaml b/sdrbase/resources/webapi/doc/swagger/include/AMDemod.yaml
index 981ae2a90..e5b56c2a8 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/AMDemod.yaml
+++ b/sdrbase/resources/webapi/doc/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: "/doc/swagger/include/ChannelMarker.yaml#/ChannelMarker"
+ description: "Channel-marker display configuration."
rollupState:
$ref: "/doc/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/sdrbase/resources/webapi/doc/swagger/include/AMMod.yaml b/sdrbase/resources/webapi/doc/swagger/include/AMMod.yaml
index 27c752891..0d218278c 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/AMMod.yaml
+++ b/sdrbase/resources/webapi/doc/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: "/doc/swagger/include/CWKeyer.yaml#/CWKeyerSettings"
+ description: "CW keyer configuration."
channelMarker:
$ref: "/doc/swagger/include/ChannelMarker.yaml#/ChannelMarker"
+ description: "Channel-marker display configuration."
rollupState:
$ref: "/doc/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/sdrbase/resources/webapi/doc/swagger/include/APRS.yaml b/sdrbase/resources/webapi/doc/swagger/include/APRS.yaml
index a3ce0a0c7..269200f70 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/APRS.yaml
+++ b/sdrbase/resources/webapi/doc/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: "/doc/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/sdrbase/resources/webapi/doc/swagger/include/APTDemod.yaml b/sdrbase/resources/webapi/doc/swagger/include/APTDemod.yaml
index b3530fa4c..a2119291a 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/APTDemod.yaml
+++ b/sdrbase/resources/webapi/doc/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: "/doc/swagger/include/ChannelMarker.yaml#/ChannelMarker"
+ description: "Channel-marker display configuration."
rollupState:
$ref: "/doc/swagger/include/RollupState.yaml#/RollupState"
+ description: "Saved expanded or collapsed state of the GUI sections."
APTDemodActions:
description: APTDemod
diff --git a/sdrbase/resources/webapi/doc/swagger/include/ATVDemod.yaml b/sdrbase/resources/webapi/doc/swagger/include/ATVDemod.yaml
index 976a48563..917fa587b 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/ATVDemod.yaml
+++ b/sdrbase/resources/webapi/doc/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/sdrbase/resources/webapi/doc/swagger/include/ATVMod.yaml b/sdrbase/resources/webapi/doc/swagger/include/ATVMod.yaml
index e2059ee06..d08a34f1b 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/ATVMod.yaml
+++ b/sdrbase/resources/webapi/doc/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: "/doc/swagger/include/ChannelMarker.yaml#/ChannelMarker"
+ description: "Channel-marker display configuration."
rollupState:
$ref: "/doc/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/sdrbase/resources/webapi/doc/swagger/include/AaroniaRTSA.yaml b/sdrbase/resources/webapi/doc/swagger/include/AaroniaRTSA.yaml
index 4ba1ece11..2c50d7583 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/AaroniaRTSA.yaml
+++ b/sdrbase/resources/webapi/doc/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/sdrbase/resources/webapi/doc/swagger/include/Airspy.yaml b/sdrbase/resources/webapi/doc/swagger/include/Airspy.yaml
index 8c7450be4..18254f316 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/Airspy.yaml
+++ b/sdrbase/resources/webapi/doc/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: "/doc/swagger/include/Structs.yaml#/SampleRate"
diff --git a/sdrbase/resources/webapi/doc/swagger/include/AirspyHF.yaml b/sdrbase/resources/webapi/doc/swagger/include/AirspyHF.yaml
index 0196940cc..69e925d74 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/AirspyHF.yaml
+++ b/sdrbase/resources/webapi/doc/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: "/doc/swagger/include/Structs.yaml#/SampleRate"
diff --git a/sdrbase/resources/webapi/doc/swagger/include/AndroidSDRDriverInput.yaml b/sdrbase/resources/webapi/doc/swagger/include/AndroidSDRDriverInput.yaml
index 9de3fe40c..6cabd8930 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/AndroidSDRDriverInput.yaml
+++ b/sdrbase/resources/webapi/doc/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/sdrbase/resources/webapi/doc/swagger/include/AntennaTools.yaml b/sdrbase/resources/webapi/doc/swagger/include/AntennaTools.yaml
index de918989d..88a9069c1 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/AntennaTools.yaml
+++ b/sdrbase/resources/webapi/doc/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: "/doc/swagger/include/RollupState.yaml#/RollupState"
+ description: "Saved expanded or collapsed state of the GUI sections."
diff --git a/sdrbase/resources/webapi/doc/swagger/include/AudioCATSISO.yaml b/sdrbase/resources/webapi/doc/swagger/include/AudioCATSISO.yaml
index efdba0c62..817912e7d 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/AudioCATSISO.yaml
+++ b/sdrbase/resources/webapi/doc/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/sdrbase/resources/webapi/doc/swagger/include/AudioInput.yaml b/sdrbase/resources/webapi/doc/swagger/include/AudioInput.yaml
index 2e69cd198..e5c58a2d1 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/AudioInput.yaml
+++ b/sdrbase/resources/webapi/doc/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/sdrbase/resources/webapi/doc/swagger/include/AudioOutput.yaml b/sdrbase/resources/webapi/doc/swagger/include/AudioOutput.yaml
index 1c980dd04..6d41e9b77 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/AudioOutput.yaml
+++ b/sdrbase/resources/webapi/doc/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/sdrbase/resources/webapi/doc/swagger/include/BFMDemod.yaml b/sdrbase/resources/webapi/doc/swagger/include/BFMDemod.yaml
index a0e503898..5bbcf8aaa 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/BFMDemod.yaml
+++ b/sdrbase/resources/webapi/doc/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: "/doc/swagger/include/GLSpectrum.yaml#/GLSpectrum"
+ description: "Spectrum-display configuration."
channelMarker:
$ref: "/doc/swagger/include/ChannelMarker.yaml#/ChannelMarker"
+ description: "Channel-marker display configuration."
rollupState:
$ref: "/doc/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/sdrbase/resources/webapi/doc/swagger/include/BeamSteeringCWMod.yaml b/sdrbase/resources/webapi/doc/swagger/include/BeamSteeringCWMod.yaml
index 40dc770c5..5a5ba7dcd 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/BeamSteeringCWMod.yaml
+++ b/sdrbase/resources/webapi/doc/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: "/doc/swagger/include/ChannelMarker.yaml#/ChannelMarker"
+ description: "Channel-marker display configuration."
rollupState:
$ref: "/doc/swagger/include/RollupState.yaml#/RollupState"
+ description: "Saved expanded or collapsed state of the GUI sections."
diff --git a/sdrbase/resources/webapi/doc/swagger/include/BladeRF1.yaml b/sdrbase/resources/webapi/doc/swagger/include/BladeRF1.yaml
index f00b9819d..bf083dbf3 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/BladeRF1.yaml
+++ b/sdrbase/resources/webapi/doc/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/sdrbase/resources/webapi/doc/swagger/include/BladeRF2.yaml b/sdrbase/resources/webapi/doc/swagger/include/BladeRF2.yaml
index 31431a907..fb23ab862 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/BladeRF2.yaml
+++ b/sdrbase/resources/webapi/doc/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: "/doc/swagger/include/Structs.yaml#/FrequencyRange"
+ description: "Frequency range data for Blade rf2 input."
sampleRateRange:
$ref: "/doc/swagger/include/Structs.yaml#/Range"
+ description: "Sample rate range data for Blade rf2 input."
bandwidthRange:
$ref: "/doc/swagger/include/Structs.yaml#/Range"
+ description: "Bandwidth range data for Blade rf2 input."
globalGainRange:
$ref: "/doc/swagger/include/Structs.yaml#/Range"
+ description: "Global gain range data for Blade rf2 input."
gainModes:
type: array
+ description: "List of gain modes."
items:
$ref: "/doc/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: "/doc/swagger/include/Structs.yaml#/FrequencyRange"
+ description: "Frequency range data for Blade rf2 output."
sampleRateRange:
$ref: "/doc/swagger/include/Structs.yaml#/Range"
+ description: "Sample rate range data for Blade rf2 output."
bandwidthRange:
$ref: "/doc/swagger/include/Structs.yaml#/Range"
+ description: "Bandwidth range data for Blade rf2 output."
globalGainRange:
$ref: "/doc/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: "/doc/swagger/include/Structs.yaml#/FrequencyRange"
+ description: "Frequency range receive data for Blade rf2 MIMO."
sampleRateRangeRx:
$ref: "/doc/swagger/include/Structs.yaml#/Range"
+ description: "Sample rate range receive data for Blade rf2 MIMO."
bandwidthRangeRx:
$ref: "/doc/swagger/include/Structs.yaml#/Range"
+ description: "Bandwidth range receive data for Blade rf2 MIMO."
globalGainRangeRx:
$ref: "/doc/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: "/doc/swagger/include/Structs.yaml#/NamedEnum"
frequencyRangeTx:
$ref: "/doc/swagger/include/Structs.yaml#/FrequencyRange"
+ description: "Frequency range transmit data for Blade rf2 MIMO."
sampleRateRangeTx:
$ref: "/doc/swagger/include/Structs.yaml#/Range"
+ description: "Sample rate range transmit data for Blade rf2 MIMO."
bandwidthRangeTx:
$ref: "/doc/swagger/include/Structs.yaml#/Range"
+ description: "Bandwidth range transmit data for Blade rf2 MIMO."
globalGainRangeTx:
$ref: "/doc/swagger/include/Structs.yaml#/Range"
+ description: "Global gain range transmit data for Blade rf2 MIMO."
diff --git a/sdrbase/resources/webapi/doc/swagger/include/CWKeyer.yaml b/sdrbase/resources/webapi/doc/swagger/include/CWKeyer.yaml
index 73c98ceee..a2a975025 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/CWKeyer.yaml
+++ b/sdrbase/resources/webapi/doc/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/sdrbase/resources/webapi/doc/swagger/include/ChannelActions.yaml b/sdrbase/resources/webapi/doc/swagger/include/ChannelActions.yaml
index 02856ac8d..edb42315f 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/ChannelActions.yaml
+++ b/sdrbase/resources/webapi/doc/swagger/include/ChannelActions.yaml
@@ -19,23 +19,37 @@ ChannelActions:
type: integer
AISModActions:
$ref: "/doc/swagger/include/AISMod.yaml#/AISModActions"
+ description: "AIS mod actions configuration for Channel."
APTDemodActions:
$ref: "/doc/swagger/include/APTDemod.yaml#/APTDemodActions"
+ description: "Apt demod actions configuration for Channel."
FileSinkActions:
$ref: "/doc/swagger/include/FileSink.yaml#/FileSinkActions"
+ description: "File sink actions configuration for Channel."
FileSourceActions:
$ref: "/doc/swagger/include/FileSource.yaml#/FileSourceActions"
+ description: "File source actions configuration for Channel."
FreqScannerActions:
$ref: "/doc/swagger/include/FreqScanner.yaml#/FreqScannerActions"
+ description: "Freq scanner actions configuration for Channel."
IEEE_802_15_4_ModActions:
$ref: "/doc/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: "/doc/swagger/include/MeshcoreMod.yaml#/MeshcoreModActions"
+ description: "Meshcore mod actions configuration for Channel."
PacketModActions:
$ref: "/doc/swagger/include/PacketMod.yaml#/PacketModActions"
+ description: "Packet mod actions configuration for Channel."
PSK31ModActions:
$ref: "/doc/swagger/include/PSK31Mod.yaml#/PSK31ModActions"
+ description: "Psk31 mod actions configuration for Channel."
RadioAstronomyActions:
$ref: "/doc/swagger/include/RadioAstronomy.yaml#/RadioAstronomyActions"
+ description: "Radio astronomy actions configuration for Channel."
RTTYModActions:
$ref: "/doc/swagger/include/RTTYMod.yaml#/RTTYModActions"
+ description: "Rtty mod actions configuration for Channel."
SigMFFileSinkActions:
$ref: "/doc/swagger/include/SigMFFileSink.yaml#/SigMFFileSinkActions"
+ description: "Sig mf file sink actions configuration for Channel."
diff --git a/sdrbase/resources/webapi/doc/swagger/include/ChannelAnalyzer.yaml b/sdrbase/resources/webapi/doc/swagger/include/ChannelAnalyzer.yaml
index e5b74380e..63c467d92 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/ChannelAnalyzer.yaml
+++ b/sdrbase/resources/webapi/doc/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: "/doc/swagger/include/GLSpectrum.yaml#/GLSpectrum"
+ description: "Spectrum-display configuration."
scopeConfig:
$ref: "/doc/swagger/include/GLScope.yaml#/GLScope"
+ description: "Oscilloscope-display configuration."
channelMarker:
$ref: "/doc/swagger/include/ChannelMarker.yaml#/ChannelMarker"
+ description: "Channel-marker display configuration."
rollupState:
$ref: "/doc/swagger/include/RollupState.yaml#/RollupState"
+ description: "Saved expanded or collapsed state of the GUI sections."
diff --git a/sdrbase/resources/webapi/doc/swagger/include/ChannelMarker.yaml b/sdrbase/resources/webapi/doc/swagger/include/ChannelMarker.yaml
index 328397aaf..930bec197 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/ChannelMarker.yaml
+++ b/sdrbase/resources/webapi/doc/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/sdrbase/resources/webapi/doc/swagger/include/ChannelPower.yaml b/sdrbase/resources/webapi/doc/swagger/include/ChannelPower.yaml
index ce8c6cdde..5388f9358 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/ChannelPower.yaml
+++ b/sdrbase/resources/webapi/doc/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: "/doc/swagger/include/ChannelMarker.yaml#/ChannelMarker"
+ description: "Channel-marker display configuration."
rollupState:
$ref: "/doc/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/sdrbase/resources/webapi/doc/swagger/include/ChannelReport.yaml b/sdrbase/resources/webapi/doc/swagger/include/ChannelReport.yaml
index 524401bf3..3855b5c57 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/ChannelReport.yaml
+++ b/sdrbase/resources/webapi/doc/swagger/include/ChannelReport.yaml
@@ -13,111 +13,171 @@ ChannelReport:
type: integer
ADSBDemodReport:
$ref: "/doc/swagger/include/ADSBDemod.yaml#/ADSBDemodReport"
+ description: "ADS-B demod report data for Channel."
AISDemodReport:
$ref: "/doc/swagger/include/AISDemod.yaml#/AISDemodReport"
+ description: "AIS demod report data for Channel."
AISModReport:
$ref: "/doc/swagger/include/AISMod.yaml#/AISModReport"
+ description: "AIS mod report data for Channel."
AMDemodReport:
$ref: "/doc/swagger/include/AMDemod.yaml#/AMDemodReport"
+ description: "Am demod report data for Channel."
AMModReport:
$ref: "/doc/swagger/include/AMMod.yaml#/AMModReport"
+ description: "Am mod report data for Channel."
ATVModReport:
$ref: "/doc/swagger/include/ATVMod.yaml#/ATVModReport"
+ description: "Atv mod report data for Channel."
BFMDemodReport:
$ref: "/doc/swagger/include/BFMDemod.yaml#/BFMDemodReport"
+ description: "BFM demod report data for Channel."
ChannelPowerReport:
$ref: "/doc/swagger/include/ChannelPower.yaml#/ChannelPowerReport"
+ description: "Channel power report data for Channel."
ChirpChatDemodReport:
$ref: "/doc/swagger/include/ChirpChatDemod.yaml#/ChirpChatDemodReport"
+ description: "Chirp chat demod report data for Channel."
ChirpChatModReport:
$ref: "/doc/swagger/include/ChirpChatMod.yaml#/ChirpChatModReport"
+ description: "Chirp chat mod report data for Channel."
DATVDemodReport:
$ref: "/doc/swagger/include/DATVDemod.yaml#/DATVDemodReport"
+ description: "Datv demod report data for Channel."
DATVModReport:
$ref: "/doc/swagger/include/DATVMod.yaml#/DATVModReport"
+ description: "Datv mod report data for Channel."
DOA2Report:
$ref: "/doc/swagger/include/DOA2.yaml#/DOA2Report"
+ description: "Doa2 report data for Channel."
DSCDemodReport:
$ref: "/doc/swagger/include/DSCDemod.yaml#/DSCDemodReport"
+ description: "Dsc demod report data for Channel."
DSDDemodReport:
$ref: "/doc/swagger/include/DSDDemod.yaml#/DSDDemodReport"
+ description: "Dsd demod report data for Channel."
EndOfTrainDemodReport:
$ref: "/doc/swagger/include/EndOfTrainDemod.yaml#/EndOfTrainDemodReport"
+ description: "End of train demod report data for Channel."
IEEE_802_15_4_ModReport:
$ref: "/doc/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: "/doc/swagger/include/FileSink.yaml#/FileSinkReport"
+ description: "File sink report data for Channel."
FileSourceReport:
$ref: "/doc/swagger/include/FileSource.yaml#/FileSourceReport"
+ description: "File source report data for Channel."
FreeDVDemodReport:
$ref: "/doc/swagger/include/FreeDVDemod.yaml#/FreeDVDemodReport"
+ description: "Free dv demod report data for Channel."
FreeDVModReport:
$ref: "/doc/swagger/include/FreeDVMod.yaml#/FreeDVModReport"
+ description: "Free dv mod report data for Channel."
FreqScannerReport:
$ref: "/doc/swagger/include/FreqScanner.yaml#/FreqScannerReport"
+ description: "Freq scanner report data for Channel."
FreqTrackerReport:
$ref: "/doc/swagger/include/FreqTracker.yaml#/FreqTrackerReport"
+ description: "Freq tracker report data for Channel."
FT8DemodReport:
$ref: "/doc/swagger/include/FT8Demod.yaml#/FT8DemodReport"
+ description: "Ft8 demod report data for Channel."
HeatMapReport:
$ref: "/doc/swagger/include/HeatMap.yaml#/HeatMapReport"
+ description: "Heat map report data for Channel."
ILSDemodReport:
$ref: "/doc/swagger/include/ILSDemod.yaml#/ILSDemodReport"
+ description: "Ils demod report data for Channel."
InmarsatDemodReport:
$ref: "/doc/swagger/include/InmarsatDemod.yaml#/InmarsatDemodReport"
+ description: "Inmarsat demod report data for Channel."
M17DemodReport:
$ref: "/doc/swagger/include/M17Demod.yaml#/M17DemodReport"
+ description: "M17 demod report data for Channel."
M17ModReport:
$ref: "/doc/swagger/include/M17Mod.yaml#/M17ModReport"
+ description: "M17 mod report data for Channel."
MeshtasticDemodReport:
$ref: "/doc/swagger/include/MeshtasticDemod.yaml#/MeshtasticDemodReport"
+ description: "Meshtastic demod report data for Channel."
MeshtasticModReport:
$ref: "/doc/swagger/include/MeshtasticMod.yaml#/MeshtasticModReport"
+ description: "Meshtastic mod report data for Channel."
+ MeshcoreDemodReport:
+ $ref: "/doc/swagger/include/MeshcoreDemod.yaml#/MeshcoreDemodReport"
+ description: "Meshcore demod report data for Channel."
+ MeshcoreModReport:
+ $ref: "/doc/swagger/include/MeshcoreMod.yaml#/MeshcoreModReport"
+ description: "Meshcore mod report data for Channel."
NavtexDemodReport:
$ref: "/doc/swagger/include/NavtexDemod.yaml#/NavtexDemodReport"
+ description: "Navtex demod report data for Channel."
NFMDemodReport:
$ref: "/doc/swagger/include/NFMDemod.yaml#/NFMDemodReport"
+ description: "Nfm demod report data for Channel."
NFMModReport:
$ref: "/doc/swagger/include/NFMMod.yaml#/NFMModReport"
+ description: "Nfm mod report data for Channel."
NoiseFigureReport:
$ref: "/doc/swagger/include/NoiseFigure.yaml#/NoiseFigureReport"
+ description: "Noise figure report data for Channel."
SSBDemodReport:
$ref: "/doc/swagger/include/SSBDemod.yaml#/SSBDemodReport"
+ description: "Ssb demod report data for Channel."
RadioAstronomyReport:
$ref: "/doc/swagger/include/RadioAstronomy.yaml#/RadioAstronomyReport"
+ description: "Radio astronomy report data for Channel."
RadioClockReport:
$ref: "/doc/swagger/include/RadioClock.yaml#/RadioClockReport"
+ description: "Radio clock report data for Channel."
RadiosondeDemodReport:
$ref: "/doc/swagger/include/RadiosondeDemod.yaml#/RadiosondeDemodReport"
+ description: "Radiosonde demod report data for Channel."
RemoteSourceReport:
$ref: "/doc/swagger/include/RemoteSource.yaml#/RemoteSourceReport"
+ description: "Remote source report data for Channel."
RTTYDemodReport:
$ref: "/doc/swagger/include/RTTYDemod.yaml#/RTTYDemodReport"
+ description: "Rtty demod report data for Channel."
RTTYModReport:
$ref: "/doc/swagger/include/RTTYMod.yaml#/RTTYModReport"
+ description: "Rtty mod report data for Channel."
PacketDemodReport:
$ref: "/doc/swagger/include/PacketDemod.yaml#/PacketDemodReport"
+ description: "Packet demod report data for Channel."
PacketModReport:
$ref: "/doc/swagger/include/PacketMod.yaml#/PacketModReport"
+ description: "Packet mod report data for Channel."
PagerDemodReport:
$ref: "/doc/swagger/include/PagerDemod.yaml#/PagerDemodReport"
+ description: "Pager demod report data for Channel."
PSK31ModReport:
$ref: "/doc/swagger/include/PSK31Mod.yaml#/PSK31ModReport"
+ description: "Psk31 mod report data for Channel."
SigMFFileSinkReport:
$ref: "/doc/swagger/include/SigMFFileSink.yaml#/SigMFFileSinkReport"
+ description: "Sig mf file sink report data for Channel."
SSBModReport:
$ref: "/doc/swagger/include/SSBMod.yaml#/SSBModReport"
+ description: "Ssb mod report data for Channel."
UDPSourceReport:
$ref: "/doc/swagger/include/UDPSource.yaml#/UDPSourceReport"
+ description: "UDP source report data for Channel."
UDPSinkReport:
$ref: "/doc/swagger/include/UDPSink.yaml#/UDPSinkReport"
+ description: "UDP sink report data for Channel."
# VORDemodMCReport:
# $ref: "/doc/swagger/include/VORDemodMC.yaml#/VORDemodMCReport"
VORDemodReport:
$ref: "/doc/swagger/include/VORDemod.yaml#/VORDemodReport"
+ description: "Vor demod report data for Channel."
WDSPRxReport:
$ref: "/doc/swagger/include/WDSPRx.yaml#/WDSPRxReport"
+ description: "Wdsp receive report data for Channel."
WFMDemodReport:
$ref: "/doc/swagger/include/WFMDemod.yaml#/WFMDemodReport"
+ description: "Wfm demod report data for Channel."
WFMModReport:
$ref: "/doc/swagger/include/WFMMod.yaml#/WFMModReport"
+ description: "Wfm mod report data for Channel."
diff --git a/sdrbase/resources/webapi/doc/swagger/include/ChannelSettings.yaml b/sdrbase/resources/webapi/doc/swagger/include/ChannelSettings.yaml
index f4e18c23c..da409ba69 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/ChannelSettings.yaml
+++ b/sdrbase/resources/webapi/doc/swagger/include/ChannelSettings.yaml
@@ -19,131 +19,201 @@ ChannelSettings:
type: integer
ADSBDemodSettings:
$ref: "/doc/swagger/include/ADSBDemod.yaml#/ADSBDemodSettings"
+ description: "ADS-B demod settings configuration for Channel."
AISDemodSettings:
$ref: "/doc/swagger/include/AISDemod.yaml#/AISDemodSettings"
+ description: "AIS demod settings configuration for Channel."
AISModSettings:
$ref: "/doc/swagger/include/AISMod.yaml#/AISModSettings"
+ description: "AIS mod settings configuration for Channel."
AMDemodSettings:
$ref: "/doc/swagger/include/AMDemod.yaml#/AMDemodSettings"
+ description: "Am demod settings configuration for Channel."
AMModSettings:
$ref: "/doc/swagger/include/AMMod.yaml#/AMModSettings"
+ description: "Am mod settings configuration for Channel."
APTDemodSettings:
$ref: "/doc/swagger/include/APTDemod.yaml#/APTDemodSettings"
+ description: "Apt demod settings configuration for Channel."
ATVDemodSettings:
$ref: "/doc/swagger/include/ATVDemod.yaml#/ATVDemodSettings"
+ description: "Atv demod settings configuration for Channel."
ATVModSettings:
$ref: "/doc/swagger/include/ATVMod.yaml#/ATVModSettings"
+ description: "Atv mod settings configuration for Channel."
BeamSteeringCWModSettings:
$ref: "/doc/swagger/include/BeamSteeringCWMod.yaml#/BeamSteeringCWModSettings"
+ description: "Beam steering CW mod settings configuration for Channel."
BFMDemodSettings:
$ref: "/doc/swagger/include/BFMDemod.yaml#/BFMDemodSettings"
+ description: "BFM demod settings configuration for Channel."
ChannelAnalyzerSettings:
$ref: "/doc/swagger/include/ChannelAnalyzer.yaml#/ChannelAnalyzerSettings"
+ description: "Channel analyzer settings configuration for Channel."
ChannelPowerSettings:
$ref: "/doc/swagger/include/ChannelPower.yaml#/ChannelPowerSettings"
+ description: "Channel power settings configuration for Channel."
ChirpChatDemodSettings:
$ref: "/doc/swagger/include/ChirpChatDemod.yaml#/ChirpChatDemodSettings"
+ description: "Chirp chat demod settings configuration for Channel."
ChirpChatModSettings:
$ref: "/doc/swagger/include/ChirpChatMod.yaml#/ChirpChatModSettings"
+ description: "Chirp chat mod settings configuration for Channel."
DATVModSettings:
$ref: "/doc/swagger/include/DATVMod.yaml#/DATVModSettings"
+ description: "Datv mod settings configuration for Channel."
DATVDemodSettings:
$ref: "/doc/swagger/include/DATVDemod.yaml#/DATVDemodSettings"
+ description: "Datv demod settings configuration for Channel."
DABDemodSettings:
$ref: "/doc/swagger/include/DABDemod.yaml#/DABDemodSettings"
+ description: "Dab demod settings configuration for Channel."
DOA2Settings:
$ref: "/doc/swagger/include/DOA2.yaml#/DOA2Settings"
+ description: "Doa2 settings configuration for Channel."
DSCDemodSettings:
$ref: "/doc/swagger/include/DSCDemod.yaml#/DSCDemodSettings"
+ description: "Dsc demod settings configuration for Channel."
DSDDemodSettings:
$ref: "/doc/swagger/include/DSDDemod.yaml#/DSDDemodSettings"
+ description: "Dsd demod settings configuration for Channel."
EndOfTrainDemodSettings:
$ref: "/doc/swagger/include/EndOfTrainDemod.yaml#/EndOfTrainDemodSettings"
+ description: "End of train demod settings configuration for Channel."
FileSinkSettings:
$ref: "/doc/swagger/include/FileSink.yaml#/FileSinkSettings"
+ description: "File sink settings configuration for Channel."
FileSourceSettings:
$ref: "/doc/swagger/include/FileSource.yaml#/FileSourceSettings"
+ description: "File source settings configuration for Channel."
FreeDVDemodSettings:
$ref: "/doc/swagger/include/FreeDVDemod.yaml#/FreeDVDemodSettings"
+ description: "Free dv demod settings configuration for Channel."
FreeDVModSettings:
$ref: "/doc/swagger/include/FreeDVMod.yaml#/FreeDVModSettings"
+ description: "Free dv mod settings configuration for Channel."
FreqScannerSettings:
$ref: "/doc/swagger/include/FreqScanner.yaml#/FreqScannerSettings"
+ description: "Freq scanner settings configuration for Channel."
FreqTrackerSettings:
$ref: "/doc/swagger/include/FreqTracker.yaml#/FreqTrackerSettings"
+ description: "Freq tracker settings configuration for Channel."
FT8DemodSettings:
$ref: "/doc/swagger/include/FT8Demod.yaml#/FT8DemodSettings"
+ description: "Ft8 demod settings configuration for Channel."
HeatMapSettings:
$ref: "/doc/swagger/include/HeatMap.yaml#/HeatMapSettings"
+ description: "Heat map settings configuration for Channel."
ILSDemodSettings:
$ref: "/doc/swagger/include/ILSDemod.yaml#/ILSDemodSettings"
+ description: "Ils demod settings configuration for Channel."
InmarsatDemodSettings:
$ref: "/doc/swagger/include/InmarsatDemod.yaml#/InmarsatDemodSettings"
+ description: "Inmarsat demod settings configuration for Channel."
InterferometerSettings:
$ref: "/doc/swagger/include/Interferometer.yaml#/InterferometerSettings"
+ description: "Interferometer settings configuration for Channel."
IEEE_802_15_4_ModSettings:
$ref: "/doc/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: "/doc/swagger/include/M17Demod.yaml#/M17DemodSettings"
+ description: "M17 demod settings configuration for Channel."
M17ModSettings:
$ref: "/doc/swagger/include/M17Mod.yaml#/M17ModSettings"
+ description: "M17 mod settings configuration for Channel."
MeshtasticDemodSettings:
$ref: "/doc/swagger/include/MeshtasticDemod.yaml#/MeshtasticDemodSettings"
+ description: "Meshtastic demod settings configuration for Channel."
MeshtasticModSettings:
$ref: "/doc/swagger/include/MeshtasticMod.yaml#/MeshtasticModSettings"
+ description: "Meshtastic mod settings configuration for Channel."
+ MeshcoreDemodSettings:
+ $ref: "/doc/swagger/include/MeshcoreDemod.yaml#/MeshcoreDemodSettings"
+ description: "Meshcore demod settings configuration for Channel."
+ MeshcoreModSettings:
+ $ref: "/doc/swagger/include/MeshcoreMod.yaml#/MeshcoreModSettings"
+ description: "Meshcore mod settings configuration for Channel."
NavtexDemodSettings:
$ref: "/doc/swagger/include/NavtexDemod.yaml#/NavtexDemodSettings"
+ description: "Navtex demod settings configuration for Channel."
NFMDemodSettings:
$ref: "/doc/swagger/include/NFMDemod.yaml#/NFMDemodSettings"
+ description: "Nfm demod settings configuration for Channel."
NFMModSettings:
$ref: "/doc/swagger/include/NFMMod.yaml#/NFMModSettings"
+ description: "Nfm mod settings configuration for Channel."
NoiseFigureSettings:
$ref: "/doc/swagger/include/NoiseFigure.yaml#/NoiseFigureSettings"
+ description: "Noise figure settings configuration for Channel."
LocalSinkSettings:
$ref: "/doc/swagger/include/LocalSink.yaml#/LocalSinkSettings"
+ description: "Local sink settings configuration for Channel."
LocalSourceSettings:
$ref: "/doc/swagger/include/LocalSource.yaml#/LocalSourceSettings"
+ description: "Local source settings configuration for Channel."
PacketDemodSettings:
$ref: "/doc/swagger/include/PacketDemod.yaml#/PacketDemodSettings"
+ description: "Packet demod settings configuration for Channel."
PacketModSettings:
$ref: "/doc/swagger/include/PacketMod.yaml#/PacketModSettings"
+ description: "Packet mod settings configuration for Channel."
PagerDemodSettings:
$ref: "/doc/swagger/include/PagerDemod.yaml#/PagerDemodSettings"
+ description: "Pager demod settings configuration for Channel."
PSK31ModSettings:
$ref: "/doc/swagger/include/PSK31Mod.yaml#/PSK31ModSettings"
+ description: "Psk31 mod settings configuration for Channel."
RadioAstronomySettings:
$ref: "/doc/swagger/include/RadioAstronomy.yaml#/RadioAstronomySettings"
+ description: "Radio astronomy settings configuration for Channel."
RadioClockSettings:
$ref: "/doc/swagger/include/RadioClock.yaml#/RadioClockSettings"
+ description: "Radio clock settings configuration for Channel."
RadiosondeDemodSettings:
$ref: "/doc/swagger/include/RadiosondeDemod.yaml#/RadiosondeDemodSettings"
+ description: "Radiosonde demod settings configuration for Channel."
RemoteSinkSettings:
$ref: "/doc/swagger/include/RemoteSink.yaml#/RemoteSinkSettings"
+ description: "Remote sink settings configuration for Channel."
RemoteSourceSettings:
$ref: "/doc/swagger/include/RemoteSource.yaml#/RemoteSourceSettings"
+ description: "Remote source settings configuration for Channel."
RemoteTCPSinkSettings:
$ref: "/doc/swagger/include/RemoteTCPSink.yaml#/RemoteTCPSinkSettings"
+ description: "Remote TCP sink settings configuration for Channel."
RTTYDemodSettings:
$ref: "/doc/swagger/include/RTTYDemod.yaml#/RTTYDemodSettings"
+ description: "Rtty demod settings configuration for Channel."
RTTYModSettings:
$ref: "/doc/swagger/include/RTTYMod.yaml#/RTTYModSettings"
+ description: "Rtty mod settings configuration for Channel."
SigMFFileSinkSettings:
$ref: "/doc/swagger/include/SigMFFileSink.yaml#/SigMFFileSinkSettings"
+ description: "Sig mf file sink settings configuration for Channel."
SSBModSettings:
$ref: "/doc/swagger/include/SSBMod.yaml#/SSBModSettings"
+ description: "Ssb mod settings configuration for Channel."
SSBDemodSettings:
$ref: "/doc/swagger/include/SSBDemod.yaml#/SSBDemodSettings"
+ description: "Ssb demod settings configuration for Channel."
UDPSourceSettings:
$ref: "/doc/swagger/include/UDPSource.yaml#/UDPSourceSettings"
+ description: "UDP source settings configuration for Channel."
UDPSinkSettings:
$ref: "/doc/swagger/include/UDPSink.yaml#/UDPSinkSettings"
+ description: "UDP sink settings configuration for Channel."
# VORDemodMCSettings:
# $ref: "/doc/swagger/include/VORDemodMC.yaml#/VORDemodMCSettings"
VORDemodSettings:
$ref: "/doc/swagger/include/VORDemod.yaml#/VORDemodSettings"
+ description: "Vor demod settings configuration for Channel."
WDSPRxSettings:
$ref: "/doc/swagger/include/WDSPRx.yaml#/WDSPRxSettings"
+ description: "Wdsp receive settings configuration for Channel."
WFMDemodSettings:
$ref: "/doc/swagger/include/WFMDemod.yaml#/WFMDemodSettings"
+ description: "Wfm demod settings configuration for Channel."
WFMModSettings:
$ref: "/doc/swagger/include/WFMMod.yaml#/WFMModSettings"
+ description: "Wfm mod settings configuration for Channel."
diff --git a/sdrbase/resources/webapi/doc/swagger/include/ChirpChatDemod.yaml b/sdrbase/resources/webapi/doc/swagger/include/ChirpChatDemod.yaml
index 101ae8d26..2ef1fc3e8 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/ChirpChatDemod.yaml
+++ b/sdrbase/resources/webapi/doc/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: "/doc/swagger/include/GLSpectrum.yaml#/GLSpectrum"
+ description: "Spectrum-display configuration."
channelMarker:
$ref: "/doc/swagger/include/ChannelMarker.yaml#/ChannelMarker"
+ description: "Channel-marker display configuration."
rollupState:
$ref: "/doc/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/sdrbase/resources/webapi/doc/swagger/include/ChirpChatMod.yaml b/sdrbase/resources/webapi/doc/swagger/include/ChirpChatMod.yaml
index ced9b5310..99d148bb9 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/ChirpChatMod.yaml
+++ b/sdrbase/resources/webapi/doc/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: "/doc/swagger/include/ChannelMarker.yaml#/ChannelMarker"
+ description: "Channel-marker display configuration."
rollupState:
$ref: "/doc/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/sdrbase/resources/webapi/doc/swagger/include/Command.yaml b/sdrbase/resources/webapi/doc/swagger/include/Command.yaml
index 997954296..384940b72 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/Command.yaml
+++ b/sdrbase/resources/webapi/doc/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/sdrbase/resources/webapi/doc/swagger/include/DABDemod.yaml b/sdrbase/resources/webapi/doc/swagger/include/DABDemod.yaml
index a930f2b08..4b596301d 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/DABDemod.yaml
+++ b/sdrbase/resources/webapi/doc/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: "/doc/swagger/include/ChannelMarker.yaml#/ChannelMarker"
+ description: "Channel-marker display configuration."
rollupState:
$ref: "/doc/swagger/include/RollupState.yaml#/RollupState"
+ description: "Saved expanded or collapsed state of the GUI sections."
diff --git a/sdrbase/resources/webapi/doc/swagger/include/DATVDemod.yaml b/sdrbase/resources/webapi/doc/swagger/include/DATVDemod.yaml
index c254382af..ddccff30c 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/DATVDemod.yaml
+++ b/sdrbase/resources/webapi/doc/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: "/doc/swagger/include/ChannelMarker.yaml#/ChannelMarker"
+ description: "Channel-marker display configuration."
rollupState:
$ref: "/doc/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/sdrbase/resources/webapi/doc/swagger/include/DATVMod.yaml b/sdrbase/resources/webapi/doc/swagger/include/DATVMod.yaml
index a9825d66f..55603bfde 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/DATVMod.yaml
+++ b/sdrbase/resources/webapi/doc/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: "/doc/swagger/include/ChannelMarker.yaml#/ChannelMarker"
+ description: "Channel-marker display configuration."
rollupState:
$ref: "/doc/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/sdrbase/resources/webapi/doc/swagger/include/DOA2.yaml b/sdrbase/resources/webapi/doc/swagger/include/DOA2.yaml
index 6163db2ad..e53dca214 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/DOA2.yaml
+++ b/sdrbase/resources/webapi/doc/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: "/doc/swagger/include/GLScope.yaml#/GLScope"
+ description: "Oscilloscope-display configuration."
channelMarker:
$ref: "/doc/swagger/include/ChannelMarker.yaml#/ChannelMarker"
+ description: "Channel-marker display configuration."
rollupState:
$ref: "/doc/swagger/include/RollupState.yaml#/RollupState"
+ description: "Saved expanded or collapsed state of the GUI sections."
DOA2Report:
description: DOA2
diff --git a/sdrbase/resources/webapi/doc/swagger/include/DSCDemod.yaml b/sdrbase/resources/webapi/doc/swagger/include/DSCDemod.yaml
index a26933a93..509b21a5f 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/DSCDemod.yaml
+++ b/sdrbase/resources/webapi/doc/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: "/doc/swagger/include/GLScope.yaml#/GLScope"
+ description: "Oscilloscope-display configuration."
channelMarker:
$ref: "/doc/swagger/include/ChannelMarker.yaml#/ChannelMarker"
+ description: "Channel-marker display configuration."
rollupState:
$ref: "/doc/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/sdrbase/resources/webapi/doc/swagger/include/DSDDemod.yaml b/sdrbase/resources/webapi/doc/swagger/include/DSDDemod.yaml
index d61367309..255e9cf03 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/DSDDemod.yaml
+++ b/sdrbase/resources/webapi/doc/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: "/doc/swagger/include/ChannelMarker.yaml#/ChannelMarker"
+ description: "Channel-marker display configuration."
rollupState:
$ref: "/doc/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/sdrbase/resources/webapi/doc/swagger/include/DemodAnalyzer.yaml b/sdrbase/resources/webapi/doc/swagger/include/DemodAnalyzer.yaml
index c0399bc7f..fdbe9720e 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/DemodAnalyzer.yaml
+++ b/sdrbase/resources/webapi/doc/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: "/doc/swagger/include/GLSpectrum.yaml#/GLSpectrum"
+ description: "Spectrum-display configuration."
scopeConfig:
$ref: "/doc/swagger/include/GLScope.yaml#/GLScope"
+ description: "Oscilloscope-display configuration."
rollupState:
$ref: "/doc/swagger/include/RollupState.yaml#/RollupState"
+ description: "Saved expanded or collapsed state of the GUI sections."
DemodAnalyzerActions:
description: "Demod Analyzer actions"
diff --git a/sdrbase/resources/webapi/doc/swagger/include/Denoiser.yaml b/sdrbase/resources/webapi/doc/swagger/include/Denoiser.yaml
index 3908b2c41..aaccaca88 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/Denoiser.yaml
+++ b/sdrbase/resources/webapi/doc/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: "/doc/swagger/include/RollupState.yaml#/RollupState"
+ description: "Saved expanded or collapsed state of the GUI sections."
DenoiserActions:
description: "Denoiser actions"
diff --git a/sdrbase/resources/webapi/doc/swagger/include/DeviceActions.yaml b/sdrbase/resources/webapi/doc/swagger/include/DeviceActions.yaml
index 2d82b457c..db2c4b5d4 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/DeviceActions.yaml
+++ b/sdrbase/resources/webapi/doc/swagger/include/DeviceActions.yaml
@@ -16,3 +16,4 @@ DeviceActions:
type: integer
sigMFFileInputActions:
$ref: "/doc/swagger/include/SigMFFileInput.yaml#/SigMFFileInputActions"
+ description: "Sig mf file input actions configuration for Device."
diff --git a/sdrbase/resources/webapi/doc/swagger/include/DeviceReports.yaml b/sdrbase/resources/webapi/doc/swagger/include/DeviceReports.yaml
index 3b71ac589..5d04c2cbe 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/DeviceReports.yaml
+++ b/sdrbase/resources/webapi/doc/swagger/include/DeviceReports.yaml
@@ -13,67 +13,100 @@ DeviceReport:
type: integer
airspyReport:
$ref: "/doc/swagger/include/Airspy.yaml#/AirspyReport"
+ description: "Airspy report data for Device."
airspyHFReport:
$ref: "/doc/swagger/include/AirspyHF.yaml#/AirspyHFReport"
+ description: "Airspy hf report data for Device."
androidSDRDriverInputReport:
$ref: "/doc/swagger/include/AndroidSDRDriverInput.yaml#/AndroidSDRDriverInputReport"
+ description: "Android sdr driver input report data for Device."
bladeRF2InputReport:
$ref: "/doc/swagger/include/BladeRF2.yaml#/BladeRF2InputReport"
+ description: "Blade rf2 input report data for Device."
bladeRF2OutputReport:
$ref: "/doc/swagger/include/BladeRF2.yaml#/BladeRF2OutputReport"
+ description: "Blade rf2 output report data for Device."
bladeRF2MIMOReport:
$ref: "/doc/swagger/include/BladeRF2.yaml#/BladeRF2MIMOReport"
+ description: "Blade rf2 MIMO report data for Device."
fileInputReport:
$ref: "/doc/swagger/include/FileInput.yaml#/FileInputReport"
+ description: "File input report data for Device."
kiwiSDRReport:
$ref: "/doc/swagger/include/KiwiSDR.yaml#/KiwiSDRReport"
+ description: "Kiwi sdr report data for Device."
limeSdrInputReport:
$ref: "/doc/swagger/include/LimeSdr.yaml#/LimeSdrInputReport"
+ description: "Lime sdr input report data for Device."
limeSdrOutputReport:
$ref: "/doc/swagger/include/LimeSdr.yaml#/LimeSdrOutputReport"
+ description: "Lime sdr output report data for Device."
limeSdrMIMOReport:
$ref: "/doc/swagger/include/LimeSdr.yaml#/LimeSdrMIMOReport"
+ description: "Lime sdr MIMO report data for Device."
localInputReport:
$ref: "/doc/swagger/include/LocalInput.yaml#/LocalInputReport"
+ description: "Local input report data for Device."
localOutputReport:
$ref: "/doc/swagger/include/LocalOutput.yaml#/LocalOutputReport"
+ description: "Local output report data for Device."
perseusReport:
$ref: "/doc/swagger/include/Perseus.yaml#/PerseusReport"
+ description: "Perseus report data for Device."
plutoSdrInputReport:
$ref: "/doc/swagger/include/PlutoSdr.yaml#/PlutoSdrInputReport"
+ description: "Pluto sdr input report data for Device."
plutoSdrOutputReport:
$ref: "/doc/swagger/include/PlutoSdr.yaml#/PlutoSdrOutputReport"
+ description: "Pluto sdr output report data for Device."
plutoSdrMIMOReport:
$ref: "/doc/swagger/include/PlutoSdr.yaml#/PlutoSdrMIMOReport"
+ description: "Pluto sdr MIMO report data for Device."
rtlSdrReport:
$ref: "/doc/swagger/include/RtlSdr.yaml#/RtlSdrReport"
+ description: "Rtl sdr report data for Device."
remoteOutputReport:
$ref: "/doc/swagger/include/RemoteOutput.yaml#/RemoteOutputReport"
+ description: "Remote output report data for Device."
remoteInputReport:
$ref: "/doc/swagger/include/RemoteInput.yaml#/RemoteInputReport"
+ description: "Remote input report data for Device."
remoteTCPInputReport:
$ref: "/doc/swagger/include/RemoteTCPInput.yaml#/RemoteTCPInputReport"
+ description: "Remote TCP input report data for Device."
sdrPlayReport:
$ref: "/doc/swagger/include/SDRPlay.yaml#/SDRPlayReport"
+ description: "Sdr play report data for Device."
sdrPlayV3Report:
$ref: "/doc/swagger/include/SDRPlayV3.yaml#/SDRPlayV3Report"
+ description: "Sdr play v3 report data for Device."
sigMFFileInputReport:
$ref: "/doc/swagger/include/SigMFFileInput.yaml#/SigMFFileInputReport"
+ description: "Sig mf file input report data for Device."
soapySDRInputReport:
$ref: "/doc/swagger/include/SoapySDR.yaml#/SoapySDRReport"
+ description: "Soapy sdr input report data for Device."
soapySDROutputReport:
$ref: "/doc/swagger/include/SoapySDR.yaml#/SoapySDRReport"
+ description: "Soapy sdr output report data for Device."
usrpInputReport:
$ref: "/doc/swagger/include/USRP.yaml#/USRPInputReport"
+ description: "Usrp input report data for Device."
usrpOutputReport:
$ref: "/doc/swagger/include/USRP.yaml#/USRPOutputReport"
+ description: "Usrp output report data for Device."
xtrxInputReport:
$ref: "/doc/swagger/include/Xtrx.yaml#/XtrxInputReport"
+ description: "Xtrx input report data for Device."
xtrxOutputReport:
$ref: "/doc/swagger/include/Xtrx.yaml#/XtrxOutputReport"
+ description: "Xtrx output report data for Device."
xtrxMIMOReport:
$ref: "/doc/swagger/include/Xtrx.yaml#/XtrxMIMOReport"
+ description: "Xtrx MIMO report data for Device."
AaroniaRTSAReport:
$ref: "/doc/swagger/include/AaroniaRTSA.yaml#/AaroniaRTSAReport"
+ description: "Aaronia rtsa report data for Device."
aaroniaRTSAOutputReport:
$ref: "/doc/swagger/include/AaroniaRTSA.yaml#/AaroniaRTSAOutputReport"
+ description: "Aaronia rtsa output report data for Device."
diff --git a/sdrbase/resources/webapi/doc/swagger/include/DeviceSettings.yaml b/sdrbase/resources/webapi/doc/swagger/include/DeviceSettings.yaml
index 380d82788..598f503a9 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/DeviceSettings.yaml
+++ b/sdrbase/resources/webapi/doc/swagger/include/DeviceSettings.yaml
@@ -16,95 +16,142 @@ DeviceSettings:
type: integer
airspySettings:
$ref: "/doc/swagger/include/Airspy.yaml#/AirspySettings"
+ description: "Airspy settings configuration for Device."
airspyHFSettings:
$ref: "/doc/swagger/include/AirspyHF.yaml#/AirspyHFSettings"
+ description: "Airspy hf settings configuration for Device."
androidSDRDriverInputSettings:
$ref: "/doc/swagger/include/AndroidSDRDriverInput.yaml#/AndroidSDRDriverInputSettings"
+ description: "Android sdr driver input settings configuration for Device."
audioCATSISOSettings:
$ref: "/doc/swagger/include/AudioCATSISO.yaml#/AudioCATSISOSettings"
+ description: "Audio catsiso settings configuration for Device."
audioInputSettings:
$ref: "/doc/swagger/include/AudioInput.yaml#/AudioInputSettings"
+ description: "Audio input settings configuration for Device."
audioOutputSettings:
$ref: "/doc/swagger/include/AudioOutput.yaml#/AudioOutputSettings"
+ description: "Audio output settings configuration for Device."
bladeRF1InputSettings:
$ref: "/doc/swagger/include/BladeRF1.yaml#/BladeRF1InputSettings"
+ description: "Blade rf1 input settings configuration for Device."
bladeRF2InputSettings:
$ref: "/doc/swagger/include/BladeRF2.yaml#/BladeRF2InputSettings"
+ description: "Blade rf2 input settings configuration for Device."
bladeRF1OutputSettings:
$ref: "/doc/swagger/include/BladeRF1.yaml#/BladeRF1OutputSettings"
+ description: "Blade rf1 output settings configuration for Device."
bladeRF2OutputSettings:
$ref: "/doc/swagger/include/BladeRF2.yaml#/BladeRF2OutputSettings"
+ description: "Blade rf2 output settings configuration for Device."
bladeRF2MIMOSettings:
$ref: "/doc/swagger/include/BladeRF2.yaml#/BladeRF2MIMOSettings"
+ description: "Blade rf2 MIMO settings configuration for Device."
fcdProSettings:
$ref: "/doc/swagger/include/FCDPro.yaml#/FCDProSettings"
+ description: "Fcd pro settings configuration for Device."
fcdProPlusSettings:
$ref: "/doc/swagger/include/FCDProPlus.yaml#/FCDProPlusSettings"
+ description: "Fcd pro plus settings configuration for Device."
fileInputSettings:
$ref: "/doc/swagger/include/FileInput.yaml#/FileInputSettings"
+ description: "File input settings configuration for Device."
fileOutputSettings:
$ref: "/doc/swagger/include/FileOutput.yaml#/FileOutputSettings"
+ description: "File output settings configuration for Device."
hackRFInputSettings:
$ref: "/doc/swagger/include/HackRF.yaml#/HackRFInputSettings"
+ description: "Hack RF input settings configuration for Device."
hackRFOutputSettings:
$ref: "/doc/swagger/include/HackRF.yaml#/HackRFOutputSettings"
+ description: "Hack RF output settings configuration for Device."
kiwiSDRSettings:
$ref: "/doc/swagger/include/KiwiSDR.yaml#/KiwiSDRSettings"
+ description: "Kiwi sdr settings configuration for Device."
limeSdrInputSettings:
$ref: "/doc/swagger/include/LimeSdr.yaml#/LimeSdrInputSettings"
+ description: "Lime sdr input settings configuration for Device."
limeSdrOutputSettings:
$ref: "/doc/swagger/include/LimeSdr.yaml#/LimeSdrOutputSettings"
+ description: "Lime sdr output settings configuration for Device."
limeSdrMIMOSettings:
$ref: "/doc/swagger/include/LimeSdr.yaml#/LimeSdrMIMOSettings"
+ description: "Lime sdr MIMO settings configuration for Device."
localInputSettings:
$ref: "/doc/swagger/include/LocalInput.yaml#/LocalInputSettings"
+ description: "Local input settings configuration for Device."
localOutputSettings:
$ref: "/doc/swagger/include/LocalOutput.yaml#/LocalOutputSettings"
+ description: "Local output settings configuration for Device."
metisMISOSettings:
$ref: "/doc/swagger/include/MetisMISO.yaml#/MetisMISOSettings"
+ description: "Metis miso settings configuration for Device."
perseusSettings:
$ref: "/doc/swagger/include/Perseus.yaml#/PerseusSettings"
+ description: "Perseus settings configuration for Device."
plutoSdrInputSettings:
$ref: "/doc/swagger/include/PlutoSdr.yaml#/PlutoSdrInputSettings"
+ description: "Pluto sdr input settings configuration for Device."
plutoSdrOutputSettings:
$ref: "/doc/swagger/include/PlutoSdr.yaml#/PlutoSdrOutputSettings"
+ description: "Pluto sdr output settings configuration for Device."
plutoSdrMIMOSettings:
$ref: "/doc/swagger/include/PlutoSdr.yaml#/PlutoSdrMIMOSettings"
+ description: "Pluto sdr MIMO settings configuration for Device."
rtlSdrSettings:
$ref: "/doc/swagger/include/RtlSdr.yaml#/RtlSdrSettings"
+ description: "Rtl sdr settings configuration for Device."
remoteOutputSettings:
$ref: "/doc/swagger/include/RemoteOutput.yaml#/RemoteOutputSettings"
+ description: "Remote output settings configuration for Device."
remoteInputSettings:
$ref: "/doc/swagger/include/RemoteInput.yaml#/RemoteInputSettings"
+ description: "Remote input settings configuration for Device."
remoteTCPInputSettings:
$ref: "/doc/swagger/include/RemoteTCPInput.yaml#/RemoteTCPInputSettings"
+ description: "Remote TCP input settings configuration for Device."
sdrPlaySettings:
$ref: "/doc/swagger/include/SDRPlay.yaml#/SDRPlaySettings"
+ description: "Sdr play settings configuration for Device."
sdrPlayV3Settings:
$ref: "/doc/swagger/include/SDRPlayV3.yaml#/SDRPlayV3Settings"
+ description: "Sdr play v3 settings configuration for Device."
sigMFFileInputSettings:
$ref: "/doc/swagger/include/SigMFFileInput.yaml#/SigMFFileInputSettings"
+ description: "Sig mf file input settings configuration for Device."
soapySDRInputSettings:
$ref: "/doc/swagger/include/SoapySDR.yaml#/SoapySDRInputSettings"
+ description: "Soapy sdr input settings configuration for Device."
soapySDROutputSettings:
$ref: "/doc/swagger/include/SoapySDR.yaml#/SoapySDROutputSettings"
+ description: "Soapy sdr output settings configuration for Device."
testMISettings:
$ref: "/doc/swagger/include/TestMI.yaml#/TestMISettings"
+ description: "Test mi settings configuration for Device."
testMOSyncSettings:
$ref: "/doc/swagger/include/TestMOSync.yaml#/TestMOSyncSettings"
+ description: "Test mo sync settings configuration for Device."
testSourceSettings:
$ref: "/doc/swagger/include/TestSource.yaml#/TestSourceSettings"
+ description: "Test source settings configuration for Device."
usrpInputSettings:
$ref: "/doc/swagger/include/USRP.yaml#/USRPInputSettings"
+ description: "Usrp input settings configuration for Device."
usrpOutputSettings:
$ref: "/doc/swagger/include/USRP.yaml#/USRPOutputSettings"
+ description: "Usrp output settings configuration for Device."
xtrxInputSettings:
$ref: "/doc/swagger/include/Xtrx.yaml#/XtrxInputSettings"
+ description: "Xtrx input settings configuration for Device."
xtrxOutputSettings:
$ref: "/doc/swagger/include/Xtrx.yaml#/XtrxOutputSettings"
+ description: "Xtrx output settings configuration for Device."
xtrxMIMOSettings:
$ref: "/doc/swagger/include/Xtrx.yaml#/XtrxMIMOSettings"
+ description: "Xtrx MIMO settings configuration for Device."
aaroniaRTSASettings:
$ref: "/doc/swagger/include/AaroniaRTSA.yaml#/AaroniaRTSASettings"
+ description: "Aaronia rtsa settings configuration for Device."
aaroniaRTSAOutputSettings:
$ref: "/doc/swagger/include/AaroniaRTSA.yaml#/AaroniaRTSAOutputSettings"
+ description: "Aaronia rtsa output settings configuration for Device."
diff --git a/sdrbase/resources/webapi/doc/swagger/include/EndOfTrainDemod.yaml b/sdrbase/resources/webapi/doc/swagger/include/EndOfTrainDemod.yaml
index 4bc6512a9..09fe64b46 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/EndOfTrainDemod.yaml
+++ b/sdrbase/resources/webapi/doc/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: "/doc/swagger/include/ChannelMarker.yaml#/ChannelMarker"
+ description: "Channel-marker display configuration."
rollupState:
$ref: "/doc/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/sdrbase/resources/webapi/doc/swagger/include/FCDPro.yaml b/sdrbase/resources/webapi/doc/swagger/include/FCDPro.yaml
index 711cc5bd9..c85e9f444 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/FCDPro.yaml
+++ b/sdrbase/resources/webapi/doc/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/sdrbase/resources/webapi/doc/swagger/include/FCDProPlus.yaml b/sdrbase/resources/webapi/doc/swagger/include/FCDProPlus.yaml
index 9e8758204..c297b25f5 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/FCDProPlus.yaml
+++ b/sdrbase/resources/webapi/doc/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/sdrbase/resources/webapi/doc/swagger/include/FT8Demod.yaml b/sdrbase/resources/webapi/doc/swagger/include/FT8Demod.yaml
index db425f66f..4d3a8a008 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/FT8Demod.yaml
+++ b/sdrbase/resources/webapi/doc/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: "/doc/swagger/include/GLSpectrum.yaml#/GLSpectrum"
+ description: "Spectrum-display configuration."
channelMarker:
$ref: "/doc/swagger/include/ChannelMarker.yaml#/ChannelMarker"
+ description: "Channel-marker display configuration."
rollupState:
$ref: "/doc/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/sdrbase/resources/webapi/doc/swagger/include/FeatureActions.yaml b/sdrbase/resources/webapi/doc/swagger/include/FeatureActions.yaml
index 64f10fcaa..a4bd5fb2f 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/FeatureActions.yaml
+++ b/sdrbase/resources/webapi/doc/swagger/include/FeatureActions.yaml
@@ -15,31 +15,49 @@ FeatureActions:
type: integer
AFCActions:
$ref: "/doc/swagger/include/AFC.yaml#/AFCActions"
+ description: "Afc actions configuration for Feature."
AMBEActions:
$ref: "/doc/swagger/include/AMBE.yaml#/AMBEActions"
+ description: "Ambe actions configuration for Feature."
GS232ControllerActions:
$ref: "/doc/swagger/include/GS232Controller.yaml#/GS232ControllerActions"
+ description: "Gs232 controller actions configuration for Feature."
LimeRFEActions:
$ref: "/doc/swagger/include/LimeRFE.yaml#/LimeRFEActions"
+ description: "Lime rfe actions configuration for Feature."
MapActions:
$ref: "/doc/swagger/include/Map.yaml#/MapActions"
+ description: "Map actions configuration for Feature."
MorseDecoderActions:
$ref: "/doc/swagger/include/MorseDecoder.yaml#/MorseDecoderActions"
+ description: "Morse decoder actions configuration for Feature."
PERTesterActions:
$ref: "/doc/swagger/include/PERTester.yaml#/PERTesterActions"
+ description: "Per tester actions configuration for Feature."
RigCtlServerActions:
$ref: "/doc/swagger/include/RigCtlServer.yaml#/RigCtlServerActions"
+ description: "Rig ctl server actions configuration for Feature."
+ MCPServerActions:
+ $ref: "/doc/swagger/include/MCPServer.yaml#/MCPServerActions"
+ description: "Mcp server actions configuration for Feature."
SatelliteTrackerActions:
$ref: "/doc/swagger/include/SatelliteTracker.yaml#/SatelliteTrackerActions"
+ description: "Satellite tracker actions configuration for Feature."
SimplePTTActions:
$ref: "/doc/swagger/include/SimplePTT.yaml#/SimplePTTActions"
+ description: "Simple ptt actions configuration for Feature."
SkyMapActions:
$ref: "/doc/swagger/include/SkyMap.yaml#/SkyMapActions"
+ description: "Sky map actions configuration for Feature."
StarTrackerActions:
$ref: "/doc/swagger/include/StarTracker.yaml#/StarTrackerActions"
+ description: "Star tracker actions configuration for Feature."
VORLocalizerActions:
$ref: "/doc/swagger/include/VORLocalizer.yaml#/VORLocalizerActions"
+ description: "Vor localizer actions configuration for Feature."
DemodAnalyzerActions:
$ref: "/doc/swagger/include/DemodAnalyzer.yaml#/DemodAnalyzerActions"
+ description: "Demod analyzer actions configuration for Feature."
DenoiserActions:
$ref: "/doc/swagger/include/Denoiser.yaml#/DenoiserActions"
+ description: "Denoiser actions configuration for Feature."
diff --git a/sdrbase/resources/webapi/doc/swagger/include/FeatureReport.yaml b/sdrbase/resources/webapi/doc/swagger/include/FeatureReport.yaml
index b0dee8339..2c2387f9c 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/FeatureReport.yaml
+++ b/sdrbase/resources/webapi/doc/swagger/include/FeatureReport.yaml
@@ -9,27 +9,43 @@ FeatureReport:
type: string
AFCReport:
$ref: "/doc/swagger/include/AFC.yaml#/AFCReport"
+ description: "Afc report data for Feature."
AMBEReport:
$ref: "/doc/swagger/include/AMBE.yaml#/AMBEReport"
+ description: "Ambe report data for Feature."
FreqDisplayReport:
$ref: "/doc/swagger/include/FreqDisplay.yaml#/FreqDisplayReport"
+ description: "Freq display report data for Feature."
GS232ControllerReport:
$ref: "/doc/swagger/include/GS232Controller.yaml#/GS232ControllerReport"
+ description: "Gs232 controller report data for Feature."
LimeRFEReport:
$ref: "/doc/swagger/include/LimeRFE.yaml#/LimeRFEReport"
+ description: "Lime rfe report data for Feature."
MapReport:
$ref: "/doc/swagger/include/Map.yaml#/MapReport"
+ description: "Map report data for Feature."
PERTesterReport:
$ref: "/doc/swagger/include/PERTester.yaml#/PERTesterReport"
+ description: "Per tester report data for Feature."
RigCtlServerReport:
$ref: "/doc/swagger/include/RigCtlServer.yaml#/RigCtlServerReport"
+ description: "Rig ctl server report data for Feature."
+ MCPServerReport:
+ $ref: "/doc/swagger/include/MCPServer.yaml#/MCPServerReport"
+ description: "Mcp server report data for Feature."
SatelliteTrackerReport:
$ref: "/doc/swagger/include/SatelliteTracker.yaml#/SatelliteTrackerReport"
+ description: "Satellite tracker report data for Feature."
SimplePTTReport:
$ref: "/doc/swagger/include/SimplePTT.yaml#/SimplePTTReport"
+ description: "Simple ptt report data for Feature."
SkyMapReport:
$ref: "/doc/swagger/include/SkyMap.yaml#/SkyMapReport"
+ description: "Sky map report data for Feature."
StarTrackerReport:
$ref: "/doc/swagger/include/StarTracker.yaml#/StarTrackerReport"
+ description: "Star tracker report data for Feature."
VORLocalizerReport:
$ref: "/doc/swagger/include/VORLocalizer.yaml#/VORLocalizerReport"
+ description: "Vor localizer report data for Feature."
diff --git a/sdrbase/resources/webapi/doc/swagger/include/FeatureSetPreset.yaml b/sdrbase/resources/webapi/doc/swagger/include/FeatureSetPreset.yaml
index ebf248223..52c864383 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/FeatureSetPreset.yaml
+++ b/sdrbase/resources/webapi/doc/swagger/include/FeatureSetPreset.yaml
@@ -6,15 +6,19 @@ FeatureConfig:
type: string
config:
$ref: "/doc/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: "/doc/swagger/include/FeatureSetPreset.yaml#/FeatureConfig"
diff --git a/sdrbase/resources/webapi/doc/swagger/include/FeatureSettings.yaml b/sdrbase/resources/webapi/doc/swagger/include/FeatureSettings.yaml
index 948159a8e..bd6ac332d 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/FeatureSettings.yaml
+++ b/sdrbase/resources/webapi/doc/swagger/include/FeatureSettings.yaml
@@ -15,45 +15,70 @@ FeatureSettings:
type: integer
AFCSettings:
$ref: "/doc/swagger/include/AFC.yaml#/AFCSettings"
+ description: "Afc settings configuration for Feature."
AISSettings:
$ref: "/doc/swagger/include/AIS.yaml#/AISSettings"
+ description: "AIS settings configuration for Feature."
AMBESettings:
$ref: "/doc/swagger/include/AMBE.yaml#/AMBESettings"
+ description: "Ambe settings configuration for Feature."
AntennaToolsSettings:
$ref: "/doc/swagger/include/AntennaTools.yaml#/AntennaToolsSettings"
+ description: "Antenna tools settings configuration for Feature."
APRSSettings:
$ref: "/doc/swagger/include/APRS.yaml#/APRSSettings"
+ description: "Aprs settings configuration for Feature."
DemodAnalyzerSettings:
$ref: "/doc/swagger/include/DemodAnalyzer.yaml#/DemodAnalyzerSettings"
+ description: "Demod analyzer settings configuration for Feature."
DenoiserSettings:
$ref: "/doc/swagger/include/Denoiser.yaml#/DenoiserSettings"
+ description: "Denoiser settings configuration for Feature."
JogdialControllerSettings:
$ref: "/doc/swagger/include/JogdialController.yaml#/JogdialControllerSettings"
+ description: "Jogdial controller settings configuration for Feature."
FreqDisplaySettings:
$ref: "/doc/swagger/include/FreqDisplay.yaml#/FreqDisplaySettings"
+ description: "Freq display settings configuration for Feature."
GS232ControllerSettings:
$ref: "/doc/swagger/include/GS232Controller.yaml#/GS232ControllerSettings"
+ description: "Gs232 controller settings configuration for Feature."
LimeRFESettings:
$ref: "/doc/swagger/include/LimeRFE.yaml#/LimeRFESettings"
+ description: "Lime rfe settings configuration for Feature."
MapSettings:
$ref: "/doc/swagger/include/Map.yaml#/MapSettings"
+ description: "Map settings configuration for Feature."
MorseDecoderSettings:
$ref: "/doc/swagger/include/MorseDecoder.yaml#/MorseDecoderSettings"
+ description: "Morse decoder settings configuration for Feature."
PERTesterSettings:
$ref: "/doc/swagger/include/PERTester.yaml#/PERTesterSettings"
+ description: "Per tester settings configuration for Feature."
RadiosondeSettings:
$ref: "/doc/swagger/include/Radiosonde.yaml#/RadiosondeSettings"
+ description: "Radiosonde settings configuration for Feature."
RigCtlServerSettings:
$ref: "/doc/swagger/include/RigCtlServer.yaml#/RigCtlServerSettings"
+ description: "Rig ctl server settings configuration for Feature."
+ MCPServerSettings:
+ $ref: "/doc/swagger/include/MCPServer.yaml#/MCPServerSettings"
+ description: "Mcp server settings configuration for Feature."
SatelliteTrackerSettings:
$ref: "/doc/swagger/include/SatelliteTracker.yaml#/SatelliteTrackerSettings"
+ description: "Satellite tracker settings configuration for Feature."
SIDSettings:
$ref: "/doc/swagger/include/SID.yaml#/SIDSettings"
+ description: "Sid settings configuration for Feature."
SimplePTTSettings:
$ref: "/doc/swagger/include/SimplePTT.yaml#/SimplePTTSettings"
+ description: "Simple ptt settings configuration for Feature."
SkyMapSettings:
$ref: "/doc/swagger/include/SkyMap.yaml#/SkyMapSettings"
+ description: "Sky map settings configuration for Feature."
StarTrackerSettings:
$ref: "/doc/swagger/include/StarTracker.yaml#/StarTrackerSettings"
+ description: "Star tracker settings configuration for Feature."
VORLocalizerSettings:
$ref: "/doc/swagger/include/VORLocalizer.yaml#/VORLocalizerSettings"
+ description: "Vor localizer settings configuration for Feature."
diff --git a/sdrbase/resources/webapi/doc/swagger/include/FileInput.yaml b/sdrbase/resources/webapi/doc/swagger/include/FileInput.yaml
index 9546318e5..f76b67250 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/FileInput.yaml
+++ b/sdrbase/resources/webapi/doc/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/sdrbase/resources/webapi/doc/swagger/include/FileOutput.yaml b/sdrbase/resources/webapi/doc/swagger/include/FileOutput.yaml
index ea5a38846..eb4479c26 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/FileOutput.yaml
+++ b/sdrbase/resources/webapi/doc/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/sdrbase/resources/webapi/doc/swagger/include/FileSink.yaml b/sdrbase/resources/webapi/doc/swagger/include/FileSink.yaml
index c638810c1..c78b741eb 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/FileSink.yaml
+++ b/sdrbase/resources/webapi/doc/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: "/doc/swagger/include/GLSpectrum.yaml#/GLSpectrum"
+ description: "Spectrum-display configuration."
channelMarker:
$ref: "/doc/swagger/include/ChannelMarker.yaml#/ChannelMarker"
+ description: "Channel-marker display configuration."
rollupState:
$ref: "/doc/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/sdrbase/resources/webapi/doc/swagger/include/FileSource.yaml b/sdrbase/resources/webapi/doc/swagger/include/FileSource.yaml
index 45534f4df..66c1279ea 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/FileSource.yaml
+++ b/sdrbase/resources/webapi/doc/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: "/doc/swagger/include/ChannelMarker.yaml#/ChannelMarker"
+ description: "Channel-marker display configuration."
rollupState:
$ref: "/doc/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/sdrbase/resources/webapi/doc/swagger/include/FreeDVDemod.yaml b/sdrbase/resources/webapi/doc/swagger/include/FreeDVDemod.yaml
index 6ad49b9ff..80acf02f0 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/FreeDVDemod.yaml
+++ b/sdrbase/resources/webapi/doc/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: "/doc/swagger/include/GLSpectrum.yaml#/GLSpectrum"
+ description: "Spectrum-display configuration."
channelMarker:
$ref: "/doc/swagger/include/ChannelMarker.yaml#/ChannelMarker"
+ description: "Channel-marker display configuration."
rollupState:
$ref: "/doc/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/sdrbase/resources/webapi/doc/swagger/include/FreeDVMod.yaml b/sdrbase/resources/webapi/doc/swagger/include/FreeDVMod.yaml
index d50e967cf..69fdd23d3 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/FreeDVMod.yaml
+++ b/sdrbase/resources/webapi/doc/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: "/doc/swagger/include/CWKeyer.yaml#/CWKeyerSettings"
+ description: "CW keyer configuration."
spectrumConfig:
$ref: "/doc/swagger/include/GLSpectrum.yaml#/GLSpectrum"
+ description: "Spectrum-display configuration."
channelMarker:
$ref: "/doc/swagger/include/ChannelMarker.yaml#/ChannelMarker"
+ description: "Channel-marker display configuration."
rollupState:
$ref: "/doc/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/sdrbase/resources/webapi/doc/swagger/include/FreqDisplay.yaml b/sdrbase/resources/webapi/doc/swagger/include/FreqDisplay.yaml
index c61dd4515..36ed7aa59 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/FreqDisplay.yaml
+++ b/sdrbase/resources/webapi/doc/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: "/doc/swagger/include/RollupState.yaml#/RollupState"
+ description: "Saved expanded or collapsed state of the GUI sections."
FreqDisplayReport:
description: "Frequency Display report"
diff --git a/sdrbase/resources/webapi/doc/swagger/include/FreqScanner.yaml b/sdrbase/resources/webapi/doc/swagger/include/FreqScanner.yaml
index b81b2adc8..e3649a86f 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/FreqScanner.yaml
+++ b/sdrbase/resources/webapi/doc/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: "/doc/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: "/doc/swagger/include/ChannelMarker.yaml#/ChannelMarker"
+ description: "Channel-marker display configuration."
rollupState:
$ref: "/doc/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: "/doc/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/sdrbase/resources/webapi/doc/swagger/include/FreqTracker.yaml b/sdrbase/resources/webapi/doc/swagger/include/FreqTracker.yaml
index f05fbb179..a09190895 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/FreqTracker.yaml
+++ b/sdrbase/resources/webapi/doc/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: "/doc/swagger/include/GLSpectrum.yaml#/GLSpectrum"
+ description: "Spectrum-display configuration."
channelMarker:
$ref: "/doc/swagger/include/ChannelMarker.yaml#/ChannelMarker"
+ description: "Channel-marker display configuration."
rollupState:
$ref: "/doc/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/sdrbase/resources/webapi/doc/swagger/include/GLScope.yaml b/sdrbase/resources/webapi/doc/swagger/include/GLScope.yaml
index 3a142ca91..032a72630 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/GLScope.yaml
+++ b/sdrbase/resources/webapi/doc/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: "/doc/swagger/include/GLScope.yaml#/TraceData"
triggersData:
type: array
+ description: "List of triggers data."
items:
$ref: "/doc/swagger/include/GLScope.yaml#/TriggerData"
diff --git a/sdrbase/resources/webapi/doc/swagger/include/GLSpectrum.yaml b/sdrbase/resources/webapi/doc/swagger/include/GLSpectrum.yaml
index 6744e2dd4..848c6ab4c 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/GLSpectrum.yaml
+++ b/sdrbase/resources/webapi/doc/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: "/doc/swagger/include/GLSpectrum.yaml#/SpectrumHistogramMarker"
waterfallMarkers:
type: array
+ description: "List of waterfall markers."
items:
$ref: "/doc/swagger/include/GLSpectrum.yaml#/SpectrumWaterfallMarker"
annotationMarkers:
type: array
+ description: "List of annotation markers."
items:
$ref: "/doc/swagger/include/GLSpectrum.yaml#/SpectrumAnnotationMarker"
calibrationPoints:
type: array
+ description: "List of calibration points."
items:
$ref: "/doc/swagger/include/GLSpectrum.yaml#/SpectrumCalibrationPoint"
diff --git a/sdrbase/resources/webapi/doc/swagger/include/GS232Controller.yaml b/sdrbase/resources/webapi/doc/swagger/include/GS232Controller.yaml
index 887f609aa..b4d7b119b 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/GS232Controller.yaml
+++ b/sdrbase/resources/webapi/doc/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: "/doc/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/sdrbase/resources/webapi/doc/swagger/include/HackRF.yaml b/sdrbase/resources/webapi/doc/swagger/include/HackRF.yaml
index bdb5cb5ba..87f4093d8 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/HackRF.yaml
+++ b/sdrbase/resources/webapi/doc/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/sdrbase/resources/webapi/doc/swagger/include/HeatMap.yaml b/sdrbase/resources/webapi/doc/swagger/include/HeatMap.yaml
index eea541792..513ae3166 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/HeatMap.yaml
+++ b/sdrbase/resources/webapi/doc/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: "/doc/swagger/include/GLScope.yaml#/GLScope"
+ description: "Oscilloscope-display configuration."
channelMarker:
$ref: "/doc/swagger/include/ChannelMarker.yaml#/ChannelMarker"
+ description: "Channel-marker display configuration."
rollupState:
$ref: "/doc/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/sdrbase/resources/webapi/doc/swagger/include/IEEE_802_15_4_Mod.yaml b/sdrbase/resources/webapi/doc/swagger/include/IEEE_802_15_4_Mod.yaml
index 2e2f92672..668e67243 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/IEEE_802_15_4_Mod.yaml
+++ b/sdrbase/resources/webapi/doc/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: "/doc/swagger/include/ChannelMarker.yaml#/ChannelMarker"
+ description: "Channel-marker display configuration."
rollupState:
$ref: "/doc/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/sdrbase/resources/webapi/doc/swagger/include/ILSDemod.yaml b/sdrbase/resources/webapi/doc/swagger/include/ILSDemod.yaml
index 450a939c1..059b6bb5e 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/ILSDemod.yaml
+++ b/sdrbase/resources/webapi/doc/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: "/doc/swagger/include/GLScope.yaml#/GLScope"
+ description: "Oscilloscope-display configuration."
channelMarker:
$ref: "/doc/swagger/include/ChannelMarker.yaml#/ChannelMarker"
+ description: "Channel-marker display configuration."
rollupState:
$ref: "/doc/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/sdrbase/resources/webapi/doc/swagger/include/InmarsatDemod.yaml b/sdrbase/resources/webapi/doc/swagger/include/InmarsatDemod.yaml
index cb6b971f5..9878b2048 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/InmarsatDemod.yaml
+++ b/sdrbase/resources/webapi/doc/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: "/doc/swagger/include/GLScope.yaml#/GLScope"
+ description: "Oscilloscope-display configuration."
channelMarker:
$ref: "/doc/swagger/include/ChannelMarker.yaml#/ChannelMarker"
+ description: "Channel-marker display configuration."
rollupState:
$ref: "/doc/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/sdrbase/resources/webapi/doc/swagger/include/Interferometer.yaml b/sdrbase/resources/webapi/doc/swagger/include/Interferometer.yaml
index 90e85483d..25066940e 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/Interferometer.yaml
+++ b/sdrbase/resources/webapi/doc/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: "/doc/swagger/include/GLSpectrum.yaml#/GLSpectrum"
+ description: "Spectrum-display configuration."
scopeConfig:
$ref: "/doc/swagger/include/GLScope.yaml#/GLScope"
+ description: "Oscilloscope-display configuration."
channelMarker:
$ref: "/doc/swagger/include/ChannelMarker.yaml#/ChannelMarker"
+ description: "Channel-marker display configuration."
rollupState:
$ref: "/doc/swagger/include/RollupState.yaml#/RollupState"
+ description: "Saved expanded or collapsed state of the GUI sections."
diff --git a/sdrbase/resources/webapi/doc/swagger/include/JogdialController.yaml b/sdrbase/resources/webapi/doc/swagger/include/JogdialController.yaml
index 0fed67799..3d32e14b4 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/JogdialController.yaml
+++ b/sdrbase/resources/webapi/doc/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: "/doc/swagger/include/RollupState.yaml#/RollupState"
+ description: "Saved expanded or collapsed state of the GUI sections."
diff --git a/sdrbase/resources/webapi/doc/swagger/include/KiwiSDR.yaml b/sdrbase/resources/webapi/doc/swagger/include/KiwiSDR.yaml
index a66a9a155..b2859538d 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/KiwiSDR.yaml
+++ b/sdrbase/resources/webapi/doc/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/sdrbase/resources/webapi/doc/swagger/include/LimeRFE.yaml b/sdrbase/resources/webapi/doc/swagger/include/LimeRFE.yaml
index de299cc8e..6caa6cbbd 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/LimeRFE.yaml
+++ b/sdrbase/resources/webapi/doc/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: "/doc/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/sdrbase/resources/webapi/doc/swagger/include/LimeSdr.yaml b/sdrbase/resources/webapi/doc/swagger/include/LimeSdr.yaml
index 6645764a2..44f1d6348 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/LimeSdr.yaml
+++ b/sdrbase/resources/webapi/doc/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/sdrbase/resources/webapi/doc/swagger/include/LocalInput.yaml b/sdrbase/resources/webapi/doc/swagger/include/LocalInput.yaml
index 9bb193216..b4e7e3413 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/LocalInput.yaml
+++ b/sdrbase/resources/webapi/doc/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/sdrbase/resources/webapi/doc/swagger/include/LocalOutput.yaml b/sdrbase/resources/webapi/doc/swagger/include/LocalOutput.yaml
index c077f1dfc..6eedd0efb 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/LocalOutput.yaml
+++ b/sdrbase/resources/webapi/doc/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/sdrbase/resources/webapi/doc/swagger/include/LocalSink.yaml b/sdrbase/resources/webapi/doc/swagger/include/LocalSink.yaml
index 2e8cf2187..83c6e7ef3 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/LocalSink.yaml
+++ b/sdrbase/resources/webapi/doc/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: "/doc/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: "/doc/swagger/include/ChannelMarker.yaml#/ChannelMarker"
+ description: "Channel-marker display configuration."
rollupState:
$ref: "/doc/swagger/include/RollupState.yaml#/RollupState"
+ description: "Saved expanded or collapsed state of the GUI sections."
FFTBand:
diff --git a/sdrbase/resources/webapi/doc/swagger/include/LocalSource.yaml b/sdrbase/resources/webapi/doc/swagger/include/LocalSource.yaml
index 4d8f78d45..361cc2f82 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/LocalSource.yaml
+++ b/sdrbase/resources/webapi/doc/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: "/doc/swagger/include/ChannelMarker.yaml#/ChannelMarker"
+ description: "Channel-marker display configuration."
rollupState:
$ref: "/doc/swagger/include/RollupState.yaml#/RollupState"
+ description: "Saved expanded or collapsed state of the GUI sections."
diff --git a/sdrbase/resources/webapi/doc/swagger/include/M17Demod.yaml b/sdrbase/resources/webapi/doc/swagger/include/M17Demod.yaml
index 7cb5deb74..6a1235e0a 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/M17Demod.yaml
+++ b/sdrbase/resources/webapi/doc/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: "/doc/swagger/include/ChannelMarker.yaml#/ChannelMarker"
+ description: "Channel-marker display configuration."
rollupState:
$ref: "/doc/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/sdrbase/resources/webapi/doc/swagger/include/M17Mod.yaml b/sdrbase/resources/webapi/doc/swagger/include/M17Mod.yaml
index c525825b6..831fc700a 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/M17Mod.yaml
+++ b/sdrbase/resources/webapi/doc/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: "/doc/swagger/include/ChannelMarker.yaml#/ChannelMarker"
+ description: "Channel-marker display configuration."
rollupState:
$ref: "/doc/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/sdrbase/resources/webapi/doc/swagger/include/MCPServer.yaml b/sdrbase/resources/webapi/doc/swagger/include/MCPServer.yaml
new file mode 100644
index 000000000..959674b6c
--- /dev/null
+++ b/sdrbase/resources/webapi/doc/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: "/doc/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/sdrbase/resources/webapi/doc/swagger/include/Map.yaml b/sdrbase/resources/webapi/doc/swagger/include/Map.yaml
index b4d8a4022..86977ea60 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/Map.yaml
+++ b/sdrbase/resources/webapi/doc/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: "/doc/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: "/doc/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/sdrbase/resources/webapi/doc/swagger/include/MeshcoreDemod.yaml b/sdrbase/resources/webapi/doc/swagger/include/MeshcoreDemod.yaml
new file mode 100644
index 000000000..d5a2bb7d9
--- /dev/null
+++ b/sdrbase/resources/webapi/doc/swagger/include/MeshcoreDemod.yaml
@@ -0,0 +1,226 @@
+MeshcoreDemodSettings:
+ description: MeshcoreDemod
+ properties:
+ 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)
+ * 1 - 750 Hz (384000 / 512)
+ * 2 - 1500 Hz (384000 / 256)
+ * 3 - 2604 Hz (333333 / 128)
+ * 4 - 3125 Hz (400000 / 128)
+ * 5 - 3906 Hz (500000 / 128)
+ * 6 - 5208 Hz (333333 / 64)
+ * 7 - 6250 Hz (400000 / 64)
+ * 8 - 7813 Hz (500000 / 64)
+ * 9 - 10417 Hz (333333 / 32)
+ * 10 - 12500 Hz (400000 / 32)
+ * 11 - 15625 Hz (500000 / 32)
+ * 12 - 20833 Hz (333333 / 16)
+ * 13 - 25000 Hz (400000 / 16)
+ * 14 - 31250 Hz (500000 / 16)
+ * 15 - 41667 Hz (333333 / 8)
+ * 16 - 50000 Hz (400000 / 8)
+ * 17 - 62500 Hz (500000 / 8)
+ * 18 - 83333 Hz (333333 / 4)
+ * 19 - 100000 Hz (400000 / 4)
+ * 20 - 125000 Hz (500000 / 4)
+ * 21 - 166667 Hz (333333 / 2)
+ * 22 - 200000 Hz (400000 / 2)
+ * 23 - 250000 Hz (500000 / 2)
+ * 24 - 333333 Hz (333333 / 1)
+ * 25 - 400000 Hz (400000 / 1)
+ * 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
+ nbSymbolsMax:
+ description: expected maximum number of symbols in a payload
+ type: integer
+ preambleChirps:
+ description: Number of expected preamble chirps
+ type: integer
+ nbParityBits:
+ description: Hamming FEC parity bits (LoRa)
+ type: integer
+ packetLength:
+ description: expected packet length in number of bytes (LoRa)
+ type: integer
+ 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
+ * 1 - Send decoded messages via UDP
+ udpAddress:
+ description: UDP destination udpAddress
+ type: string
+ 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: "/doc/swagger/include/GLSpectrum.yaml#/GLSpectrum"
+ description: "Spectrum-display configuration."
+ channelMarker:
+ $ref: "/doc/swagger/include/ChannelMarker.yaml#/ChannelMarker"
+ description: "Channel-marker display configuration."
+ rollupState:
+ $ref: "/doc/swagger/include/RollupState.yaml#/RollupState"
+ description: "Saved expanded or collapsed state of the GUI sections."
+
+MeshcoreDemodReport:
+ description: MeshcoreDemod
+ properties:
+ channelPowerDB:
+ description: current de-chirped total channel power (dB)
+ type: number
+ format: float
+ noisePowerDB:
+ description: current de-chirped noise argmax power (dB)
+ type: number
+ format: float
+ signalPowerDB:
+ description: last message de-chirped signal argmax power (dB)
+ type: number
+ format: float
+ snrPowerDB:
+ description: last message de-chirped signal to noise ratio power (dB)
+ type: number
+ 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
+ nbParityBits:
+ description: Hamming FEC parity bits (LoRa)
+ type: integer
+ packetLength:
+ description: Packet length in number of bytes (LoRa)
+ type: integer
+ nbSymbols:
+ description: Number of symbols in the payload with header and CRC (LoRa)
+ type: integer
+ nbCodewords:
+ description: Number of codewords in the payload with header and CRC (LoRa)
+ type: integer
+ headerParityStatus:
+ type: integer
+ minimum: 0
+ maximum: 3
+ description: >
+ Header FEC parity status:
+ * 0 - Undefined
+ * 1 - Uncorrectable error
+ * 2 - Corrected error
+ * 3 - OK
+ headerCRCStatus:
+ description: header CRC check status. Boolean 1 if OK else 0
+ type: integer
+ payloadParityStatus:
+ type: integer
+ minimum: 0
+ maximum: 3
+ description: >
+ Payload FEC parity status:
+ * 0 - Undefined
+ * 1 - Uncorrectable error
+ * 2 - Corrected error
+ * 3 - OK
+ payloadCRCStatus:
+ description: payload CRC check status. Boolean 1 if OK else 0
+ type: integer
+ messageTimestamp:
+ description: timestamp of the last decoded message
+ type: string
+ messageString:
+ description: string representation of the last decoded message
+ type: string
+ frameType:
+ description: frame type shown in the GUI tree view (for example LORA_FRAME or POSITION_APP)
+ type: string
+ channelType:
+ description: Channel type code e.g. LONG_FAST
+ type: string
+ messageBytes:
+ description: bytes of the last decoded message as an array of hex string represented bytes (00..FF)
+ type: array
+ items:
+ type: string
+ decoding:
+ type: integer
+ minimum: 0
+ maximum: 1
+ description: >
+ Boolean - decoding status
+ * 0 - no decoding
+ * 1 - decoding
diff --git a/sdrbase/resources/webapi/doc/swagger/include/MeshcoreMod.yaml b/sdrbase/resources/webapi/doc/swagger/include/MeshcoreMod.yaml
new file mode 100644
index 000000000..d42d2ccc1
--- /dev/null
+++ b/sdrbase/resources/webapi/doc/swagger/include/MeshcoreMod.yaml
@@ -0,0 +1,167 @@
+MeshcoreModSettings:
+ description: MeshcoreMod
+ properties:
+ 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)
+ * 1 - 750 Hz (384000 / 512)
+ * 2 - 1500 Hz (384000 / 256)
+ * 3 - 2604 Hz (333333 / 128)
+ * 4 - 3125 Hz (400000 / 128)
+ * 5 - 3906 Hz (500000 / 128)
+ * 6 - 5208 Hz (333333 / 64)
+ * 7 - 6250 Hz (400000 / 64)
+ * 8 - 7813 Hz (500000 / 64)
+ * 9 - 10417 Hz (333333 / 32)
+ * 10 - 12500 Hz (400000 / 32)
+ * 11 - 15625 Hz (500000 / 32)
+ * 12 - 20833 Hz (333333 / 16)
+ * 13 - 25000 Hz (400000 / 16)
+ * 14 - 31250 Hz (500000 / 16)
+ * 15 - 41667 Hz (333333 / 8)
+ * 16 - 50000 Hz (400000 / 8)
+ * 17 - 62500 Hz (500000 / 8)
+ * 18 - 83333 Hz (333333 / 4)
+ * 19 - 100000 Hz (400000 / 4)
+ * 20 - 125000 Hz (500000 / 4)
+ * 21 - 166667 Hz (333333 / 2)
+ * 22 - 200000 Hz (400000 / 2)
+ * 23 - 250000 Hz (500000 / 2)
+ * 24 - 333333 Hz (333333 / 1)
+ * 25 - 400000 Hz (400000 / 1)
+ * 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
+ preambleChirps:
+ description: Number of preamble chirps
+ type: integer
+ quietMillis:
+ description: Number of milliseconds to pause between transmissions
+ type: integer
+ syncWord:
+ description: 2 byte (0..65535) synchronization syncWord
+ type: integer
+ channelMute:
+ description: boolean
+ type: integer
+ minimum: 0
+ maximum: 1
+ nbParityBits:
+ description: Hamming FEC parity bits (LoRa)
+ type: integer
+ textMessage:
+ description: freeform text message
+ type: string
+ messageRepeat:
+ description: number of repetitions of the same message (0 for infinite)
+ type: integer
+ 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: "/doc/swagger/include/ChannelMarker.yaml#/ChannelMarker"
+ description: "Channel-marker display configuration."
+ rollupState:
+ $ref: "/doc/swagger/include/RollupState.yaml#/RollupState"
+ description: "Saved expanded or collapsed state of the GUI sections."
+
+MeshcoreModReport:
+ description: MeshcoreMod
+ properties:
+ channelPowerDB:
+ description: power transmitted in channel (dB)
+ type: number
+ format: float
+ channelSampleRate:
+ type: integer
+ description: "Effective sample rate delivered to the channel in samples per second."
+ symbolTimeMs:
+ description: symbol duration (ms)
+ type: number
+ format: float
+ payloadTimeMs:
+ description: payload duration (ms)
+ type: number
+ format: float
+ totalTimeMs:
+ description: total message duration inc. preamble and SFD (ms)
+ type: number
+ format: float
+ playing:
+ type: integer
+ minimum: 0
+ maximum: 1
+ description: >
+ Boolean - modulator is active (playing) including idle time
+ * 0 - Modulator not active
+ * 1 - Modulator active
+
+MeshcoreModActions:
+ description: MeshcoreMod
+ properties:
+ sendNow:
+ type: integer
+ minimum: 0
+ maximum: 1
+ description: >
+ Send packet immediately
+ * 0 - Do nothing
+ * 1 - Send packet
diff --git a/sdrbase/resources/webapi/doc/swagger/include/MeshtasticDemod.yaml b/sdrbase/resources/webapi/doc/swagger/include/MeshtasticDemod.yaml
index 7666da80b..872b76d60 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/MeshtasticDemod.yaml
+++ b/sdrbase/resources/webapi/doc/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,8 +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
@@ -73,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: "/doc/swagger/include/GLSpectrum.yaml#/GLSpectrum"
+ description: "Spectrum-display configuration."
channelMarker:
$ref: "/doc/swagger/include/ChannelMarker.yaml#/ChannelMarker"
+ description: "Channel-marker display configuration."
rollupState:
$ref: "/doc/swagger/include/RollupState.yaml#/RollupState"
+ description: "Saved expanded or collapsed state of the GUI sections."
MeshtasticDemodReport:
description: MeshtasticDemod
@@ -125,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
@@ -142,6 +175,8 @@ MeshtasticDemodReport:
type: integer
headerParityStatus:
type: integer
+ minimum: 0
+ maximum: 3
description: >
Header FEC parity status:
* 0 - Undefined
@@ -153,6 +188,8 @@ MeshtasticDemodReport:
type: integer
payloadParityStatus:
type: integer
+ minimum: 0
+ maximum: 3
description: >
Payload FEC parity status:
* 0 - Undefined
@@ -181,6 +218,8 @@ MeshtasticDemodReport:
type: string
decoding:
type: integer
+ minimum: 0
+ maximum: 1
description: >
Boolean - decoding status
* 0 - no decoding
diff --git a/sdrbase/resources/webapi/doc/swagger/include/MeshtasticMod.yaml b/sdrbase/resources/webapi/doc/swagger/include/MeshtasticMod.yaml
index becee7420..fcd1d9ffe 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/MeshtasticMod.yaml
+++ b/sdrbase/resources/webapi/doc/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: "/doc/swagger/include/ChannelMarker.yaml#/ChannelMarker"
+ description: "Channel-marker display configuration."
rollupState:
$ref: "/doc/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/sdrbase/resources/webapi/doc/swagger/include/MetisMISO.yaml b/sdrbase/resources/webapi/doc/swagger/include/MetisMISO.yaml
index bf651b8b2..88c213b16 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/MetisMISO.yaml
+++ b/sdrbase/resources/webapi/doc/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/sdrbase/resources/webapi/doc/swagger/include/MorseDecoder.yaml b/sdrbase/resources/webapi/doc/swagger/include/MorseDecoder.yaml
index 2354110cb..46e9bef5a 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/MorseDecoder.yaml
+++ b/sdrbase/resources/webapi/doc/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: "/doc/swagger/include/GLScope.yaml#/GLScope"
+ description: "Oscilloscope-display configuration."
rollupState:
$ref: "/doc/swagger/include/RollupState.yaml#/RollupState"
+ description: "Saved expanded or collapsed state of the GUI sections."
MorseDecoderActions:
description: "Morse Decoder actions"
diff --git a/sdrbase/resources/webapi/doc/swagger/include/NFMDemod.yaml b/sdrbase/resources/webapi/doc/swagger/include/NFMDemod.yaml
index 3b245c478..43b02db83 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/NFMDemod.yaml
+++ b/sdrbase/resources/webapi/doc/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: "/doc/swagger/include/ChannelMarker.yaml#/ChannelMarker"
+ description: "Channel-marker display configuration."
rollupState:
$ref: "/doc/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/sdrbase/resources/webapi/doc/swagger/include/NFMMod.yaml b/sdrbase/resources/webapi/doc/swagger/include/NFMMod.yaml
index a20109dd4..529ad051a 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/NFMMod.yaml
+++ b/sdrbase/resources/webapi/doc/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: "/doc/swagger/include/CWKeyer.yaml#/CWKeyerSettings"
+ description: "CW keyer configuration."
channelMarker:
$ref: "/doc/swagger/include/ChannelMarker.yaml#/ChannelMarker"
+ description: "Channel-marker display configuration."
rollupState:
$ref: "/doc/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/sdrbase/resources/webapi/doc/swagger/include/NavtexDemod.yaml b/sdrbase/resources/webapi/doc/swagger/include/NavtexDemod.yaml
index 82ff8db2a..e19b6e863 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/NavtexDemod.yaml
+++ b/sdrbase/resources/webapi/doc/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: "/doc/swagger/include/GLScope.yaml#/GLScope"
+ description: "Oscilloscope-display configuration."
channelMarker:
$ref: "/doc/swagger/include/ChannelMarker.yaml#/ChannelMarker"
+ description: "Channel-marker display configuration."
rollupState:
$ref: "/doc/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/sdrbase/resources/webapi/doc/swagger/include/NoiseFigure.yaml b/sdrbase/resources/webapi/doc/swagger/include/NoiseFigure.yaml
index 6b5f0570b..eb4ccc5a2 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/NoiseFigure.yaml
+++ b/sdrbase/resources/webapi/doc/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: "/doc/swagger/include/ChannelMarker.yaml#/ChannelMarker"
+ description: "Channel-marker display configuration."
rollupState:
$ref: "/doc/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/sdrbase/resources/webapi/doc/swagger/include/PERTester.yaml b/sdrbase/resources/webapi/doc/swagger/include/PERTester.yaml
index 361600140..186069f74 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/PERTester.yaml
+++ b/sdrbase/resources/webapi/doc/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: "/doc/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/sdrbase/resources/webapi/doc/swagger/include/PSK31Mod.yaml b/sdrbase/resources/webapi/doc/swagger/include/PSK31Mod.yaml
index c6c694338..66512abd5 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/PSK31Mod.yaml
+++ b/sdrbase/resources/webapi/doc/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: "/doc/swagger/include/ChannelMarker.yaml#/ChannelMarker"
+ description: "Channel-marker display configuration."
rollupState:
$ref: "/doc/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/sdrbase/resources/webapi/doc/swagger/include/PacketDemod.yaml b/sdrbase/resources/webapi/doc/swagger/include/PacketDemod.yaml
index 55670e8c7..823b3fa0f 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/PacketDemod.yaml
+++ b/sdrbase/resources/webapi/doc/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: "/doc/swagger/include/ChannelMarker.yaml#/ChannelMarker"
+ description: "Channel-marker display configuration."
rollupState:
$ref: "/doc/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/sdrbase/resources/webapi/doc/swagger/include/PacketMod.yaml b/sdrbase/resources/webapi/doc/swagger/include/PacketMod.yaml
index db529c3ca..ac4bc71f9 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/PacketMod.yaml
+++ b/sdrbase/resources/webapi/doc/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: "/doc/swagger/include/ChannelMarker.yaml#/ChannelMarker"
+ description: "Channel-marker display configuration."
rollupState:
$ref: "/doc/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/sdrbase/resources/webapi/doc/swagger/include/PagerDemod.yaml b/sdrbase/resources/webapi/doc/swagger/include/PagerDemod.yaml
index 4c4f783d9..1151eb3a2 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/PagerDemod.yaml
+++ b/sdrbase/resources/webapi/doc/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: "/doc/swagger/include/GLScope.yaml#/GLScope"
+ description: "Oscilloscope-display configuration."
channelMarker:
$ref: "/doc/swagger/include/ChannelMarker.yaml#/ChannelMarker"
+ description: "Channel-marker display configuration."
rollupState:
$ref: "/doc/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/sdrbase/resources/webapi/doc/swagger/include/Perseus.yaml b/sdrbase/resources/webapi/doc/swagger/include/Perseus.yaml
index 227992b44..8429d32d0 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/Perseus.yaml
+++ b/sdrbase/resources/webapi/doc/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: "/doc/swagger/include/Structs.yaml#/SampleRate"
diff --git a/sdrbase/resources/webapi/doc/swagger/include/PlutoSdr.yaml b/sdrbase/resources/webapi/doc/swagger/include/PlutoSdr.yaml
index 95709d5d3..f6ad8e2dc 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/PlutoSdr.yaml
+++ b/sdrbase/resources/webapi/doc/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/sdrbase/resources/webapi/doc/swagger/include/Preferences.yaml b/sdrbase/resources/webapi/doc/swagger/include/Preferences.yaml
index 23dcb720b..e984758c5 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/Preferences.yaml
+++ b/sdrbase/resources/webapi/doc/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/sdrbase/resources/webapi/doc/swagger/include/Preset.yaml b/sdrbase/resources/webapi/doc/swagger/include/Preset.yaml
index ffcf4e39c..6ecb07c9f 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/Preset.yaml
+++ b/sdrbase/resources/webapi/doc/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: "/doc/swagger/include/DeviceSettings.yaml#/DeviceSettings"
+ description: "Configuration data."
ChannelConfig:
description: Represents a Preset::ChannelConfig object
@@ -18,6 +22,7 @@ ChannelConfig:
type: string
config:
$ref: "/doc/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: "/doc/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: "/doc/swagger/include/Preset.yaml#/ChannelConfig"
deviceConfigs:
type: array
+ description: "List of device configs."
items:
$ref: "/doc/swagger/include/Preset.yaml#/DeviceConfig"
layout:
diff --git a/sdrbase/resources/webapi/doc/swagger/include/RTTYDemod.yaml b/sdrbase/resources/webapi/doc/swagger/include/RTTYDemod.yaml
index 29728a85c..e2f0790ab 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/RTTYDemod.yaml
+++ b/sdrbase/resources/webapi/doc/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: "/doc/swagger/include/GLScope.yaml#/GLScope"
+ description: "Oscilloscope-display configuration."
channelMarker:
$ref: "/doc/swagger/include/ChannelMarker.yaml#/ChannelMarker"
+ description: "Channel-marker display configuration."
rollupState:
$ref: "/doc/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/sdrbase/resources/webapi/doc/swagger/include/RTTYMod.yaml b/sdrbase/resources/webapi/doc/swagger/include/RTTYMod.yaml
index f0ae8c487..0ff34589d 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/RTTYMod.yaml
+++ b/sdrbase/resources/webapi/doc/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: "/doc/swagger/include/ChannelMarker.yaml#/ChannelMarker"
+ description: "Channel-marker display configuration."
rollupState:
$ref: "/doc/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/sdrbase/resources/webapi/doc/swagger/include/RadioAstronomy.yaml b/sdrbase/resources/webapi/doc/swagger/include/RadioAstronomy.yaml
index 20d56e540..6aed06c29 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/RadioAstronomy.yaml
+++ b/sdrbase/resources/webapi/doc/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: "/doc/swagger/include/ChannelMarker.yaml#/ChannelMarker"
+ description: "Channel-marker display configuration."
rollupState:
$ref: "/doc/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/sdrbase/resources/webapi/doc/swagger/include/RadioClock.yaml b/sdrbase/resources/webapi/doc/swagger/include/RadioClock.yaml
index 600ee71bb..5be75d060 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/RadioClock.yaml
+++ b/sdrbase/resources/webapi/doc/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: "/doc/swagger/include/GLScope.yaml#/GLScope"
+ description: "Oscilloscope-display configuration."
channelMarker:
$ref: "/doc/swagger/include/ChannelMarker.yaml#/ChannelMarker"
+ description: "Channel-marker display configuration."
rollupState:
$ref: "/doc/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/sdrbase/resources/webapi/doc/swagger/include/Radiosonde.yaml b/sdrbase/resources/webapi/doc/swagger/include/Radiosonde.yaml
index 1e7feb6a9..f46c67066 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/Radiosonde.yaml
+++ b/sdrbase/resources/webapi/doc/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: "/doc/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/sdrbase/resources/webapi/doc/swagger/include/RadiosondeDemod.yaml b/sdrbase/resources/webapi/doc/swagger/include/RadiosondeDemod.yaml
index e6efd7fc9..b72c3db9f 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/RadiosondeDemod.yaml
+++ b/sdrbase/resources/webapi/doc/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: "/doc/swagger/include/GLScope.yaml#/GLScope"
+ description: "Oscilloscope-display configuration."
channelMarker:
$ref: "/doc/swagger/include/ChannelMarker.yaml#/ChannelMarker"
+ description: "Channel-marker display configuration."
rollupState:
$ref: "/doc/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/sdrbase/resources/webapi/doc/swagger/include/RemoteInput.yaml b/sdrbase/resources/webapi/doc/swagger/include/RemoteInput.yaml
index b0ce39d43..cf081f6b4 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/RemoteInput.yaml
+++ b/sdrbase/resources/webapi/doc/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/sdrbase/resources/webapi/doc/swagger/include/RemoteOutput.yaml b/sdrbase/resources/webapi/doc/swagger/include/RemoteOutput.yaml
index 59a8f0ac7..94784c09a 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/RemoteOutput.yaml
+++ b/sdrbase/resources/webapi/doc/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/sdrbase/resources/webapi/doc/swagger/include/RemoteSink.yaml b/sdrbase/resources/webapi/doc/swagger/include/RemoteSink.yaml
index e5ff44fe8..5fca32b6d 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/RemoteSink.yaml
+++ b/sdrbase/resources/webapi/doc/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: "/doc/swagger/include/ChannelMarker.yaml#/ChannelMarker"
+ description: "Channel-marker display configuration."
rollupState:
$ref: "/doc/swagger/include/RollupState.yaml#/RollupState"
+ description: "Saved expanded or collapsed state of the GUI sections."
diff --git a/sdrbase/resources/webapi/doc/swagger/include/RemoteSource.yaml b/sdrbase/resources/webapi/doc/swagger/include/RemoteSource.yaml
index 347fef743..4ddadace4 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/RemoteSource.yaml
+++ b/sdrbase/resources/webapi/doc/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: "/doc/swagger/include/ChannelMarker.yaml#/ChannelMarker"
+ description: "Channel-marker display configuration."
rollupState:
$ref: "/doc/swagger/include/RollupState.yaml#/RollupState"
+ description: "Saved expanded or collapsed state of the GUI sections."
RemoteSourceReport:
description: "Remote channel source report"
diff --git a/sdrbase/resources/webapi/doc/swagger/include/RemoteTCPInput.yaml b/sdrbase/resources/webapi/doc/swagger/include/RemoteTCPInput.yaml
index e2e92a307..3e75e54aa 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/RemoteTCPInput.yaml
+++ b/sdrbase/resources/webapi/doc/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/sdrbase/resources/webapi/doc/swagger/include/RemoteTCPSink.yaml b/sdrbase/resources/webapi/doc/swagger/include/RemoteTCPSink.yaml
index 4152765bf..37faae342 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/RemoteTCPSink.yaml
+++ b/sdrbase/resources/webapi/doc/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: "/doc/swagger/include/ChannelMarker.yaml#/ChannelMarker"
+ description: "Channel-marker display configuration."
rollupState:
$ref: "/doc/swagger/include/RollupState.yaml#/RollupState"
+ description: "Saved expanded or collapsed state of the GUI sections."
diff --git a/sdrbase/resources/webapi/doc/swagger/include/RigCtlServer.yaml b/sdrbase/resources/webapi/doc/swagger/include/RigCtlServer.yaml
index b661b9ea9..8730e8d84 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/RigCtlServer.yaml
+++ b/sdrbase/resources/webapi/doc/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: "/doc/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/sdrbase/resources/webapi/doc/swagger/include/RollupState.yaml b/sdrbase/resources/webapi/doc/swagger/include/RollupState.yaml
index 843e01866..0c7178eea 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/RollupState.yaml
+++ b/sdrbase/resources/webapi/doc/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: "/doc/swagger/include/RollupState.yaml#/RollupChildState"
diff --git a/sdrbase/resources/webapi/doc/swagger/include/RtlSdr.yaml b/sdrbase/resources/webapi/doc/swagger/include/RtlSdr.yaml
index f0d7492b7..f84bdc3b5 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/RtlSdr.yaml
+++ b/sdrbase/resources/webapi/doc/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: "/doc/swagger/include/Structs.yaml#/Gain"
tunerType:
type: string
+ description: "Reported tuner type."
diff --git a/sdrbase/resources/webapi/doc/swagger/include/SDRPlay.yaml b/sdrbase/resources/webapi/doc/swagger/include/SDRPlay.yaml
index d766696f5..78508af9a 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/SDRPlay.yaml
+++ b/sdrbase/resources/webapi/doc/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: "/doc/swagger/include/Structs.yaml#/SampleRate"
bandwidths:
type: array
+ description: "Supported bandwidths in Hz."
items:
$ref: "/doc/swagger/include/Structs.yaml#/Bandwidth"
intermediateFrequencies:
type: array
+ description: "List of intermediate frequencies."
items:
$ref: "/doc/swagger/include/Structs.yaml#/Frequency"
frequencyBands:
type: array
+ description: "List of frequency bands."
items:
$ref: "/doc/swagger/include/Structs.yaml#/FrequencyBand"
diff --git a/sdrbase/resources/webapi/doc/swagger/include/SDRPlayV3.yaml b/sdrbase/resources/webapi/doc/swagger/include/SDRPlayV3.yaml
index cea7865d5..ba6927fc7 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/SDRPlayV3.yaml
+++ b/sdrbase/resources/webapi/doc/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: "/doc/swagger/include/Structs.yaml#/Bandwidth"
intermediateFrequencies:
type: array
+ description: "List of intermediate frequencies."
items:
$ref: "/doc/swagger/include/Structs.yaml#/Frequency"
diff --git a/sdrbase/resources/webapi/doc/swagger/include/SID.yaml b/sdrbase/resources/webapi/doc/swagger/include/SID.yaml
index c7f56bdde..f3d2f1b78 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/SID.yaml
+++ b/sdrbase/resources/webapi/doc/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: "/doc/swagger/include/RollupState.yaml#/RollupState"
+ description: "Saved expanded or collapsed state of the GUI sections."
diff --git a/sdrbase/resources/webapi/doc/swagger/include/SSBDemod.yaml b/sdrbase/resources/webapi/doc/swagger/include/SSBDemod.yaml
index bbe86d946..9287cb17b 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/SSBDemod.yaml
+++ b/sdrbase/resources/webapi/doc/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: "/doc/swagger/include/GLSpectrum.yaml#/GLSpectrum"
+ description: "Spectrum-display configuration."
channelMarker:
$ref: "/doc/swagger/include/ChannelMarker.yaml#/ChannelMarker"
+ description: "Channel-marker display configuration."
rollupState:
$ref: "/doc/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/sdrbase/resources/webapi/doc/swagger/include/SSBMod.yaml b/sdrbase/resources/webapi/doc/swagger/include/SSBMod.yaml
index 59d593d82..f400a4df8 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/SSBMod.yaml
+++ b/sdrbase/resources/webapi/doc/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: "/doc/swagger/include/CWKeyer.yaml#/CWKeyerSettings"
+ description: "CW keyer configuration."
spectrumConfig:
$ref: "/doc/swagger/include/GLSpectrum.yaml#/GLSpectrum"
+ description: "Spectrum-display configuration."
channelMarker:
$ref: "/doc/swagger/include/ChannelMarker.yaml#/ChannelMarker"
+ description: "Channel-marker display configuration."
rollupState:
$ref: "/doc/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/sdrbase/resources/webapi/doc/swagger/include/SatelliteTracker.yaml b/sdrbase/resources/webapi/doc/swagger/include/SatelliteTracker.yaml
index 78c606365..07d9cfb1e 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/SatelliteTracker.yaml
+++ b/sdrbase/resources/webapi/doc/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: "/doc/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: "/doc/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: "/doc/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/sdrbase/resources/webapi/doc/swagger/include/SigMFFileInput.yaml b/sdrbase/resources/webapi/doc/swagger/include/SigMFFileInput.yaml
index 5a5cf61af..01616e990 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/SigMFFileInput.yaml
+++ b/sdrbase/resources/webapi/doc/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/sdrbase/resources/webapi/doc/swagger/include/SigMFFileSink.yaml b/sdrbase/resources/webapi/doc/swagger/include/SigMFFileSink.yaml
index 61a945589..08e2e586d 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/SigMFFileSink.yaml
+++ b/sdrbase/resources/webapi/doc/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: "/doc/swagger/include/GLSpectrum.yaml#/GLSpectrum"
+ description: "Spectrum-display configuration."
channelMarker:
$ref: "/doc/swagger/include/ChannelMarker.yaml#/ChannelMarker"
+ description: "Channel-marker display configuration."
rollupState:
$ref: "/doc/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/sdrbase/resources/webapi/doc/swagger/include/SimplePTT.yaml b/sdrbase/resources/webapi/doc/swagger/include/SimplePTT.yaml
index a52fa66d6..53f044ca2 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/SimplePTT.yaml
+++ b/sdrbase/resources/webapi/doc/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: "/doc/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/sdrbase/resources/webapi/doc/swagger/include/SkyMap.yaml b/sdrbase/resources/webapi/doc/swagger/include/SkyMap.yaml
index 1ef724a9f..eb2b206d0 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/SkyMap.yaml
+++ b/sdrbase/resources/webapi/doc/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: "/doc/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/sdrbase/resources/webapi/doc/swagger/include/SoapySDR.yaml b/sdrbase/resources/webapi/doc/swagger/include/SoapySDR.yaml
index 6ee87473a..580ff18e4 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/SoapySDR.yaml
+++ b/sdrbase/resources/webapi/doc/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: "/doc/swagger/include/Structs.yaml#/Complex"
+ description: "Enable DC-offset correction (1 enabled, 0 disabled)."
iqCorrection:
$ref: "/doc/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: "/doc/swagger/include/Structs.yaml#/Complex"
+ description: "Enable DC-offset correction (1 enabled, 0 disabled)."
iqCorrection:
$ref: "/doc/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: "/doc/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: "/doc/swagger/include/Structs.yaml#/RangeFloat"
bandwidthsRanges:
type: array
+ description: "List of bandwidths ranges."
items:
$ref: "/doc/swagger/include/Structs.yaml#/RangeFloat"
@@ -202,16 +288,20 @@ definitions:
properties:
name:
type: string
+ description: "Name."
range:
$ref: "/doc/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: "/doc/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: "/doc/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/sdrbase/resources/webapi/doc/swagger/include/StarTracker.yaml b/sdrbase/resources/webapi/doc/swagger/include/StarTracker.yaml
index 23934515c..f769e6db1 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/StarTracker.yaml
+++ b/sdrbase/resources/webapi/doc/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: "/doc/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/sdrbase/resources/webapi/doc/swagger/include/Structs.yaml b/sdrbase/resources/webapi/doc/swagger/include/Structs.yaml
index f5c1c1ddc..138f6d7d1 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/Structs.yaml
+++ b/sdrbase/resources/webapi/doc/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/sdrbase/resources/webapi/doc/swagger/include/TestMI.yaml b/sdrbase/resources/webapi/doc/swagger/include/TestMI.yaml
index d13bacf3d..d435d923a 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/TestMI.yaml
+++ b/sdrbase/resources/webapi/doc/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/sdrbase/resources/webapi/doc/swagger/include/TestMOSync.yaml b/sdrbase/resources/webapi/doc/swagger/include/TestMOSync.yaml
index 75c9975a8..6ae5f81e8 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/TestMOSync.yaml
+++ b/sdrbase/resources/webapi/doc/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/sdrbase/resources/webapi/doc/swagger/include/TestSource.yaml b/sdrbase/resources/webapi/doc/swagger/include/TestSource.yaml
index e575929da..cab8172a6 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/TestSource.yaml
+++ b/sdrbase/resources/webapi/doc/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/sdrbase/resources/webapi/doc/swagger/include/UDPSink.yaml b/sdrbase/resources/webapi/doc/swagger/include/UDPSink.yaml
index 359643996..d40eb8e7b 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/UDPSink.yaml
+++ b/sdrbase/resources/webapi/doc/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: "/doc/swagger/include/GLSpectrum.yaml#/GLSpectrum"
+ description: "Spectrum-display configuration."
channelMarker:
$ref: "/doc/swagger/include/ChannelMarker.yaml#/ChannelMarker"
+ description: "Channel-marker display configuration."
rollupState:
$ref: "/doc/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/sdrbase/resources/webapi/doc/swagger/include/UDPSource.yaml b/sdrbase/resources/webapi/doc/swagger/include/UDPSource.yaml
index a78e2e93b..2aeadf18a 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/UDPSource.yaml
+++ b/sdrbase/resources/webapi/doc/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: "/doc/swagger/include/GLSpectrum.yaml#/GLSpectrum"
+ description: "Spectrum-display configuration."
channelMarker:
$ref: "/doc/swagger/include/ChannelMarker.yaml#/ChannelMarker"
+ description: "Channel-marker display configuration."
rollupState:
$ref: "/doc/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/sdrbase/resources/webapi/doc/swagger/include/USRP.yaml b/sdrbase/resources/webapi/doc/swagger/include/USRP.yaml
index c8ad85a30..f1d32c1b3 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/USRP.yaml
+++ b/sdrbase/resources/webapi/doc/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/sdrbase/resources/webapi/doc/swagger/include/User.yaml b/sdrbase/resources/webapi/doc/swagger/include/User.yaml
index e4c4ca4c8..fd505ade6 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/User.yaml
+++ b/sdrbase/resources/webapi/doc/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/sdrbase/resources/webapi/doc/swagger/include/VORDemod.yaml b/sdrbase/resources/webapi/doc/swagger/include/VORDemod.yaml
index 8d612afde..7240ac3bb 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/VORDemod.yaml
+++ b/sdrbase/resources/webapi/doc/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: "/doc/swagger/include/ChannelMarker.yaml#/ChannelMarker"
+ description: "Channel-marker display configuration."
rollupState:
$ref: "/doc/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/sdrbase/resources/webapi/doc/swagger/include/VORDemodMC.yaml b/sdrbase/resources/webapi/doc/swagger/include/VORDemodMC.yaml
index 6dbc27998..4a5685906 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/VORDemodMC.yaml
+++ b/sdrbase/resources/webapi/doc/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: "/doc/swagger/include/ChannelMarker.yaml#/ChannelMarker"
+ description: "Channel-marker display configuration."
rollupState:
$ref: "/doc/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/sdrbase/resources/webapi/doc/swagger/include/VORLocalizer.yaml b/sdrbase/resources/webapi/doc/swagger/include/VORLocalizer.yaml
index 7ad440364..c55e6e8bd 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/VORLocalizer.yaml
+++ b/sdrbase/resources/webapi/doc/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: "/doc/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/sdrbase/resources/webapi/doc/swagger/include/WDSPRx.yaml b/sdrbase/resources/webapi/doc/swagger/include/WDSPRx.yaml
index 25a758c2e..c94e42d3a 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/WDSPRx.yaml
+++ b/sdrbase/resources/webapi/doc/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: "/doc/swagger/include/GLSpectrum.yaml#/GLSpectrum"
+ description: "Spectrum-display configuration."
channelMarker:
$ref: "/doc/swagger/include/ChannelMarker.yaml#/ChannelMarker"
+ description: "Channel-marker display configuration."
rollupState:
$ref: "/doc/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/sdrbase/resources/webapi/doc/swagger/include/WFMDemod.yaml b/sdrbase/resources/webapi/doc/swagger/include/WFMDemod.yaml
index ffc071d8e..995db3481 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/WFMDemod.yaml
+++ b/sdrbase/resources/webapi/doc/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: "/doc/swagger/include/ChannelMarker.yaml#/ChannelMarker"
+ description: "Channel-marker display configuration."
rollupState:
$ref: "/doc/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/sdrbase/resources/webapi/doc/swagger/include/WFMMod.yaml b/sdrbase/resources/webapi/doc/swagger/include/WFMMod.yaml
index 8de5aea6e..f1d944cad 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/WFMMod.yaml
+++ b/sdrbase/resources/webapi/doc/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: "/doc/swagger/include/CWKeyer.yaml#/CWKeyerSettings"
+ description: "CW keyer configuration."
channelMarker:
$ref: "/doc/swagger/include/ChannelMarker.yaml#/ChannelMarker"
+ description: "Channel-marker display configuration."
rollupState:
$ref: "/doc/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/sdrbase/resources/webapi/doc/swagger/include/Xtrx.yaml b/sdrbase/resources/webapi/doc/swagger/include/Xtrx.yaml
index a11cd599b..73abeae27 100644
--- a/sdrbase/resources/webapi/doc/swagger/include/Xtrx.yaml
+++ b/sdrbase/resources/webapi/doc/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."
diff --git a/swagger/sdrangel/code/html2/index.html b/swagger/sdrangel/code/html2/index.html
index 8c1533cc7..5fbc3a8d2 100644
--- a/swagger/sdrangel/code/html2/index.html
+++ b/swagger/sdrangel/code/html2/index.html
@@ -709,12 +709,16 @@ margin-bottom: 20px;
"latitude" : {
"type" : "number",
"format" : "float",
- "description" : "Latitude of aircraft in degrees"
+ "description" : "Latitude of aircraft in degrees",
+ "minimum" : -90,
+ "maximum" : 90
},
"longitude" : {
"type" : "number",
"format" : "float",
- "description" : "Longitude of aircraft in degrees"
+ "description" : "Longitude of aircraft in degrees",
+ "minimum" : -180,
+ "maximum" : 180
},
"altitude" : {
"type" : "integer",
@@ -734,25 +738,31 @@ margin-bottom: 20px;
"description" : "power received in channel (dB)"
},
"channelSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Effective sample rate delivered to the channel in samples per second."
},
"targetName" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Name of the selected or tracked target."
},
"targetAzimuth" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Target azimuth in degrees clockwise from north."
},
"targetElevation" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Target elevation in degrees above the horizon."
},
"targetRange" : {
"type" : "number",
- "format" : "float"
+ "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" : "#/definitions/ADSBDemodAircraftState"
}
@@ -774,18 +784,24 @@ margin-bottom: 20px;
},
"correlationThreshold" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Minimum correlation score required to accept a frame preamble."
},
"samplesPerBit" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Number of input samples used to represent each bit."
},
"correlateFullPreamble" : {
"type" : "integer",
- "description" : "Correlate on part or full preamble\n * 0 - part\n * 1 - full\n"
+ "description" : "Correlate on part or full preamble\n * 0 - part\n * 1 - full\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"demodModeS" : {
"type" : "integer",
- "description" : "Demodulate all mode S frames or just ADS-B\n * 0 - just ADS-B\n * 1 - All mode S\n"
+ "description" : "Demodulate all mode S frames or just ADS-B\n * 0 - just ADS-B\n * 1 - All mode S\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"interpolatorPhaseSteps" : {
"type" : "integer",
@@ -797,37 +813,58 @@ margin-bottom: 20px;
"description" : "Number of taps per phase in channel interpolator"
},
"removeTimeout" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Time after which an inactive tracked item is removed."
},
"feedEnabled" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable forwarding of received data to the configured feed (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"exportClientEnabled" : {
"type" : "integer",
- "description" : "Send data to server\n * 0 - Do not send data\n * 1 - Send data\n"
+ "description" : "Send data to server\n * 0 - Do not send data\n * 1 - Send data\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"exportClientHost" : {
"type" : "string",
"description" : "Host to send data to"
},
"exportClientPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Export client port.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"exportClientFormat" : {
"type" : "integer",
- "description" : "Format of sent data\n * 0 - Beast binary\n * 1 - Beast hex\n"
+ "description" : "Format of sent data\n * 0 - Beast binary\n * 1 - Beast hex\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"exportServerEnabled" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable the data-export server (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"exportServerPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Export server port.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"importEnabled" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable importing data from the configured service (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"importHost" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Import host setting for ADS-B demod."
},
"importUsername" : {
"type" : "string",
@@ -838,35 +875,47 @@ margin-bottom: 20px;
"description" : "OpenSky OAuth2 client secret."
},
"importParameters" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Import parameters setting for ADS-B demod."
},
"importPeriod" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Import period setting for ADS-B demod."
},
"importMinLatitude" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Import min latitude setting for ADS-B demod."
},
"importMaxLatitude" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Import max latitude setting for ADS-B demod."
},
"importMinLongitude" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Import min longitude setting for ADS-B demod."
},
"importMaxLongitude" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Import max longitude setting for ADS-B demod."
},
"logFilename" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Log file name or path."
},
"logEnabled" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable logging to the configured file (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"streamIndex" : {
"type" : "integer",
@@ -874,24 +923,34 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -901,15 +960,21 @@ margin-bottom: 20px;
"properties" : {
"run" : {
"type" : "integer",
- "description" : "Set the plugin running state\n * 0 - idle\n * 1 - run\n"
+ "description" : "Set the plugin running state\n * 0 - idle\n * 1 - run\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"deviceTrack" : {
"type" : "integer",
- "description" : "(Re)initialize tracker target frequency adjustment\n * 0 - release\n * 1 - engage\n"
+ "description" : "(Re)initialize tracker target frequency adjustment\n * 0 - release\n * 1 - engage\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"devicesApply" : {
"type" : "integer",
- "description" : "(Re)initialize device sets tracking\n * 0 - release\n * 1 - engage\n"
+ "description" : "(Re)initialize device sets tracking\n * 0 - release\n * 1 - engage\n",
+ "minimum" : 0,
+ "maximum" : 1
}
},
"description" : "AFC actions"
@@ -918,7 +983,9 @@ margin-bottom: 20px;
"properties" : {
"runningState" : {
"type" : "integer",
- "description" : "Running state\n * 0 - not started\n * 1 - idle\n * 2 - running\n * 3 - error\n"
+ "description" : "Running state\n * 0 - not started\n * 1 - idle\n * 2 - running\n * 3 - error\n",
+ "minimum" : 0,
+ "maximum" : 3
},
"trackerChannelIndex" : {
"type" : "integer",
@@ -939,10 +1006,12 @@ margin-bottom: 20px;
defs.AFCSettings = {
"properties" : {
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"trackerDeviceSetIndex" : {
"type" : "integer",
@@ -954,11 +1023,15 @@ margin-bottom: 20px;
},
"hasTargetFrequency" : {
"type" : "integer",
- "description" : "Adjust device frequency to match tracker frequency\n * 0 - disabled\n * 1 - enabled\n"
+ "description" : "Adjust device frequency to match tracker frequency\n * 0 - disabled\n * 1 - enabled\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"transverterTarget" : {
"type" : "integer",
- "description" : "Use transverter or device frequency for tracker frequency adjustment\n * 0 - device\n * 1 - transverter\n"
+ "description" : "Use transverter or device frequency for tracker frequency adjustment\n * 0 - device\n * 1 - transverter\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"targetFrequency" : {
"type" : "integer",
@@ -975,21 +1048,30 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIFeatureSetIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Feature-set index used by the reverse API peer."
},
"reverseAPIFeatureIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Feature index used by the reverse API peer."
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -1003,7 +1085,8 @@ margin-bottom: 20px;
"description" : "power received in channel (dB)"
},
"channelSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Effective sample rate delivered to the channel in samples per second."
}
},
"description" : "AISDemod"
@@ -1016,15 +1099,18 @@ margin-bottom: 20px;
},
"inputFrequencyOffset" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Channel frequency offset from the device center frequency in Hz."
},
"rfBandwidth" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "RF bandwidth in Hz."
},
"fmDeviation" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "FM frequency deviation in Hz."
},
"correlationThreshold" : {
"type" : "number",
@@ -1033,7 +1119,9 @@ margin-bottom: 20px;
},
"udpEnabled" : {
"type" : "integer",
- "description" : "Whether to forward received messages to specified UDP port"
+ "description" : "Whether to forward received messages to specified UDP port",
+ "minimum" : 0,
+ "maximum" : 1
},
"udpAddress" : {
"type" : "string",
@@ -1041,26 +1129,37 @@ margin-bottom: 20px;
},
"udpPort" : {
"type" : "integer",
- "description" : "UDP port to forward received messages to"
+ "description" : "UDP port to forward received messages to",
+ "minimum" : 1,
+ "maximum" : 65535
},
"udpFormat" : {
"type" : "integer",
"description" : "0 for binary, 1 for NMEA"
},
"logFilename" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Log file name or path."
},
"logEnabled" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable logging to the configured file (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"useFileTime" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable file time (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"streamIndex" : {
"type" : "integer",
@@ -1068,27 +1167,38 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"scopeConfig" : {
+ "description" : "Oscilloscope-display configuration.",
"$ref" : "#/definitions/GLScope"
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -1098,14 +1208,19 @@ margin-bottom: 20px;
"properties" : {
"tx" : {
"type" : "integer",
- "description" : "Transmit stored message\n * 0 - do nothing\n * 1 - transmit\n"
+ "description" : "Transmit stored message\n * 0 - do nothing\n * 1 - transmit\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"encode" : {
"type" : "integer",
- "description" : "Encode message from discrete data\n * 0 - do nothing\n * 1 - encode\n"
+ "description" : "Encode message from discrete data\n * 0 - do nothing\n * 1 - encode\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"data" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Payload data."
}
},
"description" : "AISMod"
@@ -1118,7 +1233,8 @@ margin-bottom: 20px;
"description" : "power transmitted in channel (dB)"
},
"channelSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Effective sample rate delivered to the channel in samples per second."
}
},
"description" : "AISMod"
@@ -1131,7 +1247,8 @@ margin-bottom: 20px;
"description" : "channel center frequency shift from baseband center in Hz"
},
"baud" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Symbol or serial rate in baud."
},
"rfBandwidth" : {
"type" : "number",
@@ -1144,83 +1261,118 @@ margin-bottom: 20px;
},
"gain" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Gain setting; units and available values depend on the device or plugin."
},
"channelMute" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Mute the channel output (1 muted, 0 unmuted).",
+ "minimum" : 0,
+ "maximum" : 1
},
"repeat" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Repeat transmission or playback (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"repeatDelay" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Delay between repetitions."
},
"repeatCount" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Number of repetitions."
},
"rampUpBits" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Ramp up bits setting for AIS mod."
},
"rampDownBits" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Ramp down bits setting for AIS mod."
},
"rampRange" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Ramp range setting for AIS mod."
},
"rfNoise" : {
"type" : "integer",
- "description" : "Boolean\n * 0 - off\n * 1 - on\n"
+ "description" : "Boolean\n * 0 - off\n * 1 - on\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"writeToFile" : {
"type" : "integer",
- "description" : "Boolean\n * 0 - off\n * 1 - on\n"
+ "description" : "Boolean\n * 0 - off\n * 1 - on\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"msgType" : {
"type" : "integer",
- "description" : "Message Type\n * 0 - Scheduled position report\n * 1 - Assigned position report\n * 2 - Special position report\n * 3 - Base station report\n"
+ "description" : "Message Type\n * 0 - Scheduled position report\n * 1 - Assigned position report\n * 2 - Special position report\n * 3 - Base station report\n",
+ "minimum" : 0,
+ "maximum" : 3
},
"mmsi" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Maritime Mobile Service Identity number."
},
"status" : {
"type" : "integer",
- "description" : "Ship status\n * 0 - Under way using engine\n * 1 - At anchor\n * 2 - Not under command\n * 3 - Restricted manoeuvrability\n * 4 - Constrained by her draught\n * 4 - Moored\n * 5 - Aground\n * 6 - Engaged in fishing\n * 7 - Under way sailing\n * 8 - Not defined\n"
+ "description" : "Ship status\n * 0 - Under way using engine\n * 1 - At anchor\n * 2 - Not under command\n * 3 - Restricted manoeuvrability\n * 4 - Constrained by her draught\n * 4 - Moored\n * 5 - Aground\n * 6 - Engaged in fishing\n * 7 - Under way sailing\n * 8 - Not defined\n",
+ "minimum" : 0,
+ "maximum" : 8
},
"latitude" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Latitude in degrees, positive north.",
+ "minimum" : -90,
+ "maximum" : 90
},
"longitude" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Longitude in degrees, positive east.",
+ "minimum" : -180,
+ "maximum" : 180
},
"course" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Course over ground in degrees."
},
"speed" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Reported speed."
},
"heading" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Heading in degrees."
},
"data" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Payload data."
},
"bt" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Bt setting for AIS mod."
},
"symbolSpan" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Symbol span setting for AIS mod."
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"streamIndex" : {
"type" : "integer",
@@ -1228,23 +1380,33 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"udpEnabled" : {
"type" : "integer",
- "description" : "Whether to receive messages to transmit on specified UDP port"
+ "description" : "Whether to receive messages to transmit on specified UDP port",
+ "minimum" : 0,
+ "maximum" : 1
},
"udpAddress" : {
"type" : "string",
@@ -1252,12 +1414,16 @@ margin-bottom: 20px;
},
"udpPort" : {
"type" : "integer",
- "description" : "UDP port to receive messages to transmit via"
+ "description" : "UDP port to receive messages to transmit via",
+ "minimum" : 1,
+ "maximum" : 65535
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -1266,38 +1432,51 @@ margin-bottom: 20px;
defs.AISSettings = {
"properties" : {
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIFeatureSetIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Feature-set index used by the reverse API peer."
},
"reverseAPIFeatureIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Feature index used by the reverse API peer."
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
},
"vesselColumnIndexes" : {
"type" : "array",
+ "description" : "List of vessel column indexes.",
"items" : {
"type" : "integer"
}
},
"vesselColumnSizes" : {
"type" : "array",
+ "description" : "List of vessel column sizes.",
"items" : {
"type" : "integer"
}
@@ -1384,28 +1563,39 @@ margin-bottom: 20px;
defs.AMBESettings = {
"properties" : {
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIFeatureSetIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Feature-set index used by the reverse API peer."
},
"reverseAPIFeatureIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Feature index used by the reverse API peer."
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -1423,10 +1613,12 @@ margin-bottom: 20px;
"description" : "squelch status (1 if open else 0)"
},
"audioSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Audio sample rate in samples per second."
},
"channelSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Effective sample rate delivered to the channel in samples per second."
}
},
"description" : "AMDemod"
@@ -1455,23 +1647,30 @@ margin-bottom: 20px;
},
"volume" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Audio volume multiplier."
},
"audioMute" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Mute audio output (1 muted, 0 unmuted).",
+ "minimum" : 0,
+ "maximum" : 1
},
"bandpassEnable" : {
"type" : "integer",
"description" : "use bandpass filter (1 for yes, 0 for no)"
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"audioDeviceName" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Name of the audio device to use."
},
"pll" : {
"type" : "integer",
@@ -1500,24 +1699,34 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -1531,10 +1740,12 @@ margin-bottom: 20px;
"description" : "power transmitted in channel (dB)"
},
"audioSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Audio sample rate in samples per second."
},
"channelSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Effective sample rate delivered to the channel in samples per second."
}
},
"description" : "AMMod"
@@ -1543,11 +1754,13 @@ margin-bottom: 20px;
"properties" : {
"inputFrequencyOffset" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Channel frequency offset from the device center frequency in Hz."
},
"rfBandwidth" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "RF bandwidth in Hz."
},
"modFactor" : {
"type" : "number",
@@ -1556,29 +1769,41 @@ margin-bottom: 20px;
},
"toneFrequency" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Tone frequency in Hz."
},
"volumeFactor" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Volume factor setting for Am mod."
},
"channelMute" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Mute the channel output (1 muted, 0 unmuted).",
+ "minimum" : 0,
+ "maximum" : 1
},
"playLoop" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Loop playback at end of file (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"audioDeviceName" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Name of the audio device to use."
},
"modAFInput" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Audio-frequency modulation input selection."
},
"streamIndex" : {
"type" : "integer",
@@ -1586,27 +1811,38 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"cwKeyer" : {
+ "description" : "CW keyer configuration.",
"$ref" : "#/definitions/CWKeyerSettings"
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -1615,116 +1851,149 @@ margin-bottom: 20px;
defs.APRSSettings = {
"properties" : {
"igateServer" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Igate server setting for Aprs."
},
"igatePort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Igate port.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"igateCallsign" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Igate callsign setting for Aprs."
},
"igatePasscode" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Igate passcode setting for Aprs."
},
"igateFilter" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Igate filter setting for Aprs."
},
"igateEnabled" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable igate (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIFeatureSetIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Feature-set index used by the reverse API peer."
},
"reverseAPIFeatureIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Feature index used by the reverse API peer."
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
},
"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"
}
@@ -1819,7 +2088,9 @@ margin-bottom: 20px;
},
"decodeEnabled" : {
"type" : "integer",
- "description" : "Controls whether the decoder is enabled"
+ "description" : "Controls whether the decoder is enabled",
+ "minimum" : 0,
+ "maximum" : 1
},
"autoSave" : {
"type" : "integer",
@@ -1884,10 +2155,12 @@ margin-bottom: 20px;
"description" : "Yaw angle offset in degrees, for aligning image on map"
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"streamIndex" : {
"type" : "integer",
@@ -1895,24 +2168,34 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -1921,23 +2204,28 @@ margin-bottom: 20px;
defs.ATVDemodSettings = {
"properties" : {
"fpsIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Selected fps index."
},
"halfImage" : {
"type" : "integer",
"description" : "(boolean) 1 for m_fltRatioOfRowsToDisplay = 0.5, 0 for m_fltRatioOfRowsToDisplay = 1.0"
},
"RFBandwidthFactor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "RF bandwidth factor setting for Atv demod."
},
"OppBandwidthFactor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Opp bandwidth factor setting for Atv demod."
},
"nbLinesIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Selected nb lines index."
},
"intFrequencyOffset" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Int frequency offset in Hz."
},
"enmModulation" : {
"type" : "integer",
@@ -1945,23 +2233,29 @@ margin-bottom: 20px;
},
"fltRFBandwidth" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Flt RF bandwidth in Hz."
},
"fltRFOppBandwidth" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Flt RF opp bandwidth in Hz."
},
"blnFFTFiltering" : {
"type" : "integer",
- "description" : "boolean"
+ "description" : "boolean",
+ "minimum" : 0,
+ "maximum" : 1
},
"fltBFOFrequency" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Flt bfo frequency in Hz."
},
"fmDeviation" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "FM frequency deviation in Hz."
},
"amScalingFactor" : {
"type" : "integer",
@@ -1972,71 +2266,94 @@ margin-bottom: 20px;
"description" : "Factor in % to apply to adjusted signal scale"
},
"intSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Int sample rate in samples per second."
},
"enmATVStandard" : {
"type" : "integer",
"description" : "see ATVDemodSettings::ATVStd"
},
"intNumberOfLines" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Int number of lines setting for Atv demod."
},
"fltLineDuration" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Flt line duration setting for Atv demod."
},
"fltTopDuration" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Flt top duration setting for Atv demod."
},
"fltFramePerS" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Flt frame per s setting for Atv demod."
},
"fltRatioOfRowsToDisplay" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Flt ratio of rows to display setting for Atv demod."
},
"fltVoltLevelSynchroTop" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Flt volt level synchro top setting for Atv demod."
},
"fltVoltLevelSynchroBlack" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Flt volt level synchro black setting for Atv demod."
},
"blnHSync" : {
"type" : "integer",
- "description" : "boolean"
+ "description" : "boolean",
+ "minimum" : 0,
+ "maximum" : 1
},
"blnVSync" : {
"type" : "integer",
- "description" : "boolean"
+ "description" : "boolean",
+ "minimum" : 0,
+ "maximum" : 1
},
"blnInvertVideo" : {
"type" : "integer",
- "description" : "boolean"
+ "description" : "boolean",
+ "minimum" : 0,
+ "maximum" : 1
},
"intVideoTabIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Selected int video tab index."
},
"intTVSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Int tv sample rate in samples per second."
},
"intNumberSamplePerLine" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Int number sample per line setting for Atv demod."
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"udpAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name used for UDP traffic."
},
"udpPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "UDP port number.",
+ "minimum" : 1,
+ "maximum" : 65535
}
},
"description" : "ATVDemod"
@@ -2049,7 +2366,8 @@ margin-bottom: 20px;
"description" : "power transmitted in channel (dB)"
},
"channelSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Effective sample rate delivered to the channel in samples per second."
}
},
"description" : "ATVMod"
@@ -2058,78 +2376,103 @@ margin-bottom: 20px;
"properties" : {
"inputFrequencyOffset" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Channel frequency offset from the device center frequency in Hz."
},
"rfBandwidth" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "RF bandwidth in Hz."
},
"rfOppBandwidth" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "RF opp bandwidth in Hz."
},
"atvStd" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Atv std setting for Atv mod."
},
"nbLines" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Nb lines setting for Atv mod."
},
"fps" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Fps setting for Atv mod."
},
"atvModInput" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Atv mod input setting for Atv mod."
},
"uniformLevel" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Uniform level setting for Atv mod."
},
"atvModulation" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Atv modulation setting for Atv mod."
},
"videoPlayLoop" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Video play loop setting for Atv mod."
},
"videoPlay" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Video play setting for Atv mod."
},
"cameraPlay" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Camera play setting for Atv mod."
},
"channelMute" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Mute the channel output (1 muted, 0 unmuted).",
+ "minimum" : 0,
+ "maximum" : 1
},
"invertedVideo" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Inverted video setting for Atv mod."
},
"rfScalingFactor" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "RF scaling factor setting for Atv mod."
},
"fmExcursion" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "FM excursion setting for Atv mod."
},
"forceDecimator" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Force decimator setting for Atv mod."
},
"showOverlayText" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Show overlay text setting for Atv mod."
},
"overlayText" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Overlay text setting for Atv mod."
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"imageFileName" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Image file name or path."
},
"videoFileName" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Video file name."
},
"streamIndex" : {
"type" : "integer",
@@ -2137,24 +2480,34 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -2164,7 +2517,9 @@ margin-bottom: 20px;
"properties" : {
"status" : {
"type" : "integer",
- "description" : "Connection to RTSA server status:\n * 0 - Idle\n * 1 - Unstable\n * 2 - Connected\n * 3 - Error\n * 4 - Disconnected\n"
+ "description" : "Connection to RTSA server status:\n * 0 - Idle\n * 1 - Unstable\n * 2 - Connected\n * 3 - Error\n * 4 - Disconnected\n",
+ "minimum" : 0,
+ "maximum" : 4
}
},
"description" : "AaroniaRTSAOutput"
@@ -2172,7 +2527,8 @@ margin-bottom: 20px;
defs.AaroniaRTSAOutputSettings = {
"properties" : {
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"centerFrequency" : {
"type" : "integer",
@@ -2189,16 +2545,23 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
}
},
"description" : "AaroniaRTSAOutput"
@@ -2207,7 +2570,9 @@ margin-bottom: 20px;
"properties" : {
"status" : {
"type" : "integer",
- "description" : "Connection to RTSA server status:\n * 0 - Idle\n * 1 - Unstable\n * 2 - Connected\n * 3 - Error\n * 4 - Disconnected\n"
+ "description" : "Connection to RTSA server status:\n * 0 - Idle\n * 1 - Unstable\n * 2 - Connected\n * 3 - Error\n * 4 - Disconnected\n",
+ "minimum" : 0,
+ "maximum" : 4
}
},
"description" : "AaroniaRTSA"
@@ -2215,7 +2580,8 @@ margin-bottom: 20px;
defs.AaroniaRTSASettings = {
"properties" : {
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"centerFrequency" : {
"type" : "integer",
@@ -2232,16 +2598,23 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
}
},
"description" : "AaroniaRTSA"
@@ -2250,6 +2623,7 @@ margin-bottom: 20px;
"properties" : {
"sampleRates" : {
"type" : "array",
+ "description" : "Supported sample rates in samples per second.",
"items" : {
"$ref" : "#/definitions/SampleRate"
}
@@ -2260,51 +2634,72 @@ margin-bottom: 20px;
defs.AirspyHFSettings = {
"properties" : {
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"centerFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Device center frequency in Hz."
},
"LOppmTenths" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Local-oscillator correction in tenths of a part per million."
},
"devSampleRateIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Selected dev sample rate index."
},
"log2Decim" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent of the software decimation factor; the output sample rate is divided by 2^log2Decim."
},
"transverterMode" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable transverter frequency translation (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"transverterDeltaFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Frequency translation applied in transverter mode in Hz."
},
"iqOrder" : {
"type" : "integer",
- "description" : "IQ samples order\n * 0 - Q then I (swapped)\n * 1 - I then Q (straight)\n"
+ "description" : "IQ samples order\n * 0 - Q then I (swapped)\n * 1 - I then Q (straight)\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"bandIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Selected band index."
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"useAGC" : {
"type" : "integer",
- "description" : "AGC (1 for on, 0 for off)"
+ "description" : "AGC (1 for on, 0 for off)",
+ "minimum" : 0,
+ "maximum" : 1
},
"agcHigh" : {
"type" : "integer",
@@ -2312,21 +2707,31 @@ margin-bottom: 20px;
},
"useDSP" : {
"type" : "integer",
- "description" : "LibairspyHF DSP (1 for on, 0 for off)"
+ "description" : "LibairspyHF DSP (1 for on, 0 for off)",
+ "minimum" : 0,
+ "maximum" : 1
},
"useLNA" : {
"type" : "integer",
- "description" : "LNA (1 for on, 0 for off)"
+ "description" : "LNA (1 for on, 0 for off)",
+ "minimum" : 0,
+ "maximum" : 1
},
"attenuatorSteps" : {
"type" : "integer",
"description" : "Attenuator in number of 6 dB steps"
},
"dcBlock" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable DSP DC-offset correction (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"iqCorrection" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable I/Q imbalance correction (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
}
},
"description" : "AirspyHF"
@@ -2335,6 +2740,7 @@ margin-bottom: 20px;
"properties" : {
"sampleRates" : {
"type" : "array",
+ "description" : "Supported sample rates in samples per second.",
"items" : {
"$ref" : "#/definitions/SampleRate"
}
@@ -2345,26 +2751,33 @@ margin-bottom: 20px;
defs.AirspySettings = {
"properties" : {
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"centerFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Device center frequency in Hz."
},
"LOppmTenths" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Local-oscillator correction in tenths of a part per million."
},
"devSampleRateIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Selected dev sample rate index."
},
"lnaGain" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Low-noise-amplifier gain setting."
},
"mixerGain" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Mixer gain setting for Airspy."
},
"vgaGain" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Variable-gain-amplifier gain setting."
},
"lnaAGC" : {
"type" : "integer",
@@ -2375,7 +2788,8 @@ margin-bottom: 20px;
"description" : "Mixer AGC (1 if active else 0)"
},
"log2Decim" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent of the software decimation factor; the output sample rate is divided by 2^log2Decim."
},
"fcPos" : {
"type" : "integer",
@@ -2383,37 +2797,58 @@ margin-bottom: 20px;
},
"biasT" : {
"type" : "integer",
- "description" : "Bias tee (1 if active else 0)"
+ "description" : "Bias tee (1 if active else 0)",
+ "minimum" : 0,
+ "maximum" : 1
},
"dcBlock" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable DSP DC-offset correction (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"iqCorrection" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable I/Q imbalance correction (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"transverterMode" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable transverter frequency translation (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"transverterDeltaFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Frequency translation applied in transverter mode in Hz."
},
"iqOrder" : {
"type" : "integer",
- "description" : "IQ samples order\n * 0 - Q then I (swapped)\n * 1 - I then Q (straight)\n"
+ "description" : "IQ samples order\n * 0 - Q then I (swapped)\n * 1 - I then Q (straight)\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
}
},
"description" : "Airspy"
@@ -2421,7 +2856,8 @@ margin-bottom: 20px;
defs.AndroidSDRDriverInputReport = {
"properties" : {
"sampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Sample rate in samples per second."
}
},
"description" : "AndroidSDRDriverInput"
@@ -2430,56 +2866,86 @@ margin-bottom: 20px;
"properties" : {
"centerFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Device center frequency in Hz."
},
"loPpmCorrection" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Local-oscillator correction in parts per million."
},
"dcBlock" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable DSP DC-offset correction (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"iqCorrection" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable I/Q imbalance correction (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"biasTee" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable the antenna bias tee (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"directSampling" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Direct sampling setting for Android sdr driver input."
},
"devSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device I/Q sample rate in samples per second before software decimation or interpolation."
},
"log2Decim" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent of the software decimation factor; the output sample rate is divided by 2^log2Decim."
},
"gain" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Gain setting; units and available values depend on the device or plugin."
},
"agc" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable automatic gain control (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"rfBW" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "RF bw in Hz."
},
"sampleBits" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Number of significant bits in each sample."
},
"dataPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Network port used for data traffic.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
}
},
"description" : "AndroidSDRDriverInput"
@@ -2488,50 +2954,67 @@ margin-bottom: 20px;
"properties" : {
"dipoleFrequencyMHz" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Dipole frequency in MHz."
},
"dipoleEndEffectFactor" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Dipole end effect factor setting for Antenna tools."
},
"dishFrequencyMHz" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Dish frequency in MHz."
},
"dishDiameter" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Dish diameter setting for Antenna tools."
},
"dishDepth" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Dish depth setting for Antenna tools."
},
"dishEfficiency" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Dish efficiency setting for Antenna tools."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIFeatureSetIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Feature-set index used by the reverse API peer."
},
"reverseAPIFeatureIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Feature index used by the reverse API peer."
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -2540,35 +3023,44 @@ margin-bottom: 20px;
defs.ArgInfo = {
"properties" : {
"key" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Key for Definitions."
},
"valueType" : {
"type" : "string",
+ "description" : "Value type for Definitions.",
"enum" : [ "bool", "int", "float", "string" ]
},
"valueString" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Value string for Definitions."
},
"name" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Name."
},
"description" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Human-readable description."
},
"units" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Units for Definitions."
},
"range" : {
+ "description" : "Range configuration for Definitions.",
"$ref" : "#/definitions/RangeFloat"
},
"valueOptions" : {
"type" : "array",
+ "description" : "List of value options.",
"items" : {
"type" : "string"
}
},
"optionNames" : {
"type" : "array",
+ "description" : "List of option names.",
"items" : {
"type" : "string"
}
@@ -2579,14 +3071,17 @@ margin-bottom: 20px;
defs.ArgValue = {
"properties" : {
"key" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Key for Definitions."
},
"valueType" : {
"type" : "string",
+ "description" : "Value type for Definitions.",
"enum" : [ "bool", "int", "float", "string" ]
},
"valueString" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Value string for Definitions."
}
},
"description" : "Generic argument value"
@@ -2594,40 +3089,55 @@ margin-bottom: 20px;
defs.AudioCATSISOSettings = {
"properties" : {
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"rxCenterFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Receive center frequency in Hz."
},
"rxSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Receive sample rate in samples per second."
},
"txCenterFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Transmit center frequency in Hz."
},
"txSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Transmit sample rate in samples per second."
},
"transverterMode" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable transverter frequency translation (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"transverterDeltaFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Frequency translation applied in transverter mode in Hz."
},
"iqOrder" : {
"type" : "integer",
- "description" : "IQ samples order\n * 0 - Q then I (swapped)\n * 1 - I then Q (straight)\n"
+ "description" : "IQ samples order\n * 0 - Q then I (swapped)\n * 1 - I then Q (straight)\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"txEnable" : {
"type" : "integer",
- "description" : "Enable or disable transmission\n * 0 - Disable transmission\n * 1 - Enable transmission\n"
+ "description" : "Enable or disable transmission\n * 0 - Disable transmission\n * 1 - Enable transmission\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"pttSpectrumLink" : {
"type" : "integer",
- "description" : "Main spectrum display (Rx/Tx) follows PTT (GUI)\n * 0 - Disable PTT following\n * 1 - Enable PTT following\n"
+ "description" : "Main spectrum display (Rx/Tx) follows PTT (GUI)\n * 0 - Disable PTT following\n * 1 - Enable PTT following\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"rxDeviceName" : {
"type" : "string",
@@ -2635,7 +3145,9 @@ margin-bottom: 20px;
},
"rxIQMapping" : {
"type" : "integer",
- "description" : "Audio channel to IQ mapping\n * 0 - I=L, Q=R\n * 1 - I=R, Q=L\n * 2 - I=L, Q=0\n * 3 - I=R, Q=0\n"
+ "description" : "Audio channel to IQ mapping\n * 0 - I=L, Q=R\n * 1 - I=R, Q=L\n * 2 - I=L, Q=0\n * 3 - I=R, Q=0\n",
+ "minimum" : 0,
+ "maximum" : 3
},
"log2Decim" : {
"type" : "integer",
@@ -2643,19 +3155,26 @@ margin-bottom: 20px;
},
"fcPosRx" : {
"type" : "integer",
- "description" : "Decimated bandpass center frequency position\n * 0 - Infradyne\n * 1 - Supradyne\n * 2 - Centered\n"
+ "description" : "Decimated bandpass center frequency position\n * 0 - Infradyne\n * 1 - Supradyne\n * 2 - Centered\n",
+ "minimum" : 0,
+ "maximum" : 2
},
"dcBlock" : {
"type" : "integer",
- "description" : "Auto DC blocking\n * 0 - Off\n * 1 - On\n"
+ "description" : "Auto DC blocking\n * 0 - Off\n * 1 - On\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"iqCorrection" : {
"type" : "integer",
- "description" : "Auto IQ balance (you need auto DC blocking active)\n * 0 - Off\n * 1 - On\n"
+ "description" : "Auto IQ balance (you need auto DC blocking active)\n * 0 - Off\n * 1 - On\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"rxVolume" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Receive volume setting for Audio catsiso."
},
"txDeviceName" : {
"type" : "string",
@@ -2663,7 +3182,9 @@ margin-bottom: 20px;
},
"txIQMapping" : {
"type" : "integer",
- "description" : "Audio channel to IQ mapping\n * 0 - I=L, Q=R\n * 1 - I=R, Q=L\n"
+ "description" : "Audio channel to IQ mapping\n * 0 - I=L, Q=R\n * 1 - I=R, Q=L\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"txVolume" : {
"type" : "integer",
@@ -2671,31 +3192,45 @@ margin-bottom: 20px;
},
"catSpeedIndex" : {
"type" : "integer",
- "description" : "CAT serial link baud rate\n * 0 - 1200\n * 1 - 2400\n * 2 - 4800\n * 3 - 9800\n * 4 - 19200 (default)\n * 5 - 38400\n * 6 - 57600\n * 7 - 115200\n"
+ "description" : "CAT serial link baud rate\n * 0 - 1200\n * 1 - 2400\n * 2 - 4800\n * 3 - 9800\n * 4 - 19200 (default)\n * 5 - 38400\n * 6 - 57600\n * 7 - 115200\n",
+ "minimum" : 0,
+ "maximum" : 7
},
"catDataBitsIndex" : {
"type" : "integer",
- "description" : "CAT serial link data bits\n * 0 - 7\n * 1 - 8 (default)\n"
+ "description" : "CAT serial link data bits\n * 0 - 7\n * 1 - 8 (default)\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"catStopBitsIndex" : {
"type" : "integer",
- "description" : "CAT serial link stop bits\n * 0 - 1 (default)\n * 1 - 2\n"
+ "description" : "CAT serial link stop bits\n * 0 - 1 (default)\n * 1 - 2\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"catHandshakeIndex" : {
"type" : "integer",
- "description" : "CAT serial link handshake type\n * 0 - none (default)\n * 1 - XON/XOFF\n * 2 - hardware\n"
+ "description" : "CAT serial link handshake type\n * 0 - none (default)\n * 1 - XON/XOFF\n * 2 - hardware\n",
+ "minimum" : 0,
+ "maximum" : 2
},
"catPTTMethodIndex" : {
"type" : "integer",
- "description" : "CAT PTT method\n * 0 - PTT (default)\n * 1 - DTR\n * 2 - RTS\n"
+ "description" : "CAT PTT method\n * 0 - PTT (default)\n * 1 - DTR\n * 2 - RTS\n",
+ "minimum" : 0,
+ "maximum" : 2
},
"catDTRHigh" : {
"type" : "integer",
- "description" : "CAT DTR control\n * 0 - low\n * 1 - high (default)\n"
+ "description" : "CAT DTR control\n * 0 - low\n * 1 - high (default)\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"catRTSHigh" : {
"type" : "integer",
- "description" : "CAT RTS control\n * 0 - low\n * 1 - high (default)\n"
+ "description" : "CAT RTS control\n * 0 - low\n * 1 - high (default)\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"catPollingMs" : {
"type" : "integer",
@@ -2703,16 +3238,23 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
}
},
"description" : "AudioCATSISO"
@@ -2778,7 +3320,8 @@ margin-bottom: 20px;
defs.AudioInputSettings = {
"properties" : {
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"device" : {
"type" : "string",
@@ -2790,7 +3333,8 @@ margin-bottom: 20px;
},
"volume" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Audio volume multiplier."
},
"log2Decim" : {
"type" : "integer",
@@ -2798,32 +3342,47 @@ margin-bottom: 20px;
},
"iqMapping" : {
"type" : "integer",
- "description" : "Audio channel to IQ mapping\n * 0 - I=L, Q=0\n * 1 - I=R, Q=0\n * 2 - I=L, Q=R\n * 3 - I=R, Q=L\n"
+ "description" : "Audio channel to IQ mapping\n * 0 - I=L, Q=0\n * 1 - I=R, Q=0\n * 2 - I=L, Q=R\n * 3 - I=R, Q=L\n",
+ "minimum" : 0,
+ "maximum" : 3
},
"dcBlock" : {
"type" : "integer",
- "description" : "Auto DC blocking\n * 0 - Off\n * 1 - On\n"
+ "description" : "Auto DC blocking\n * 0 - Off\n * 1 - On\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"iqImbalance" : {
"type" : "integer",
- "description" : "Auto IQ balance (you need auto DC blocking active)\n * 0 - Off\n * 1 - On\n"
+ "description" : "Auto IQ balance (you need auto DC blocking active)\n * 0 - Off\n * 1 - On\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"fcPos" : {
"type" : "integer",
- "description" : "Decimated bandpass center frequency position\n * 0 - Infradyne\n * 1 - Supradyne\n * 2 - Centered\n"
+ "description" : "Decimated bandpass center frequency position\n * 0 - Infradyne\n * 1 - Supradyne\n * 2 - Centered\n",
+ "minimum" : 0,
+ "maximum" : 2
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
}
},
"description" : "AudioInput"
@@ -2896,7 +3455,8 @@ margin-bottom: 20px;
defs.AudioOutputSettings = {
"properties" : {
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"deviceName" : {
"type" : "string",
@@ -2904,24 +3464,34 @@ margin-bottom: 20px;
},
"volume" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Audio volume multiplier."
},
"iqMapping" : {
"type" : "integer",
- "description" : "Audio channel to IQ mapping\n * 0 - I=L, Q=R\n * 1 - I=R, Q=L\n"
+ "description" : "Audio channel to IQ mapping\n * 0 - I=L, Q=R\n * 1 - I=R, Q=L\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
}
},
"description" : "AudioOutput"
@@ -2938,10 +3508,12 @@ margin-bottom: 20px;
"description" : "squelch status (1 if open else 0)"
},
"audioSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Audio sample rate in samples per second."
},
"channelSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Effective complex baseband sample rate delivered to this channel in samples per second. This must be greater than rfBandwidth.\n"
},
"pilotLocked" : {
"type" : "integer",
@@ -2953,6 +3525,7 @@ margin-bottom: 20px;
"description" : "power of stereo pilot (dB)"
},
"rdsReport" : {
+ "description" : "RDS decoder status and decoded programme information.",
"$ref" : "#/definitions/RDSReport"
}
},
@@ -2962,51 +3535,81 @@ margin-bottom: 20px;
"properties" : {
"inputFrequencyOffset" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Channel frequency offset from the device center frequency in Hz."
},
"rfBandwidth" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "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.\n",
+ "minimum" : 80000,
+ "maximum" : 250000
},
"afBandwidth" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Demodulated audio bandwidth in Hz. Broadcast FM normally uses 15 kHz.\n",
+ "minimum" : 1000,
+ "maximum" : 20000,
+ "default" : 15000.0
},
"deEmphasis" : {
"type" : "integer",
- "description" : "De-emphasis time constant (us)\n * 0 - 50us (Europe, Australia)\n * 1 - 75us (US, Japan)\n"
+ "description" : "De-emphasis time constant (us)\n * 0 - 50us (Europe, Australia)\n * 1 - 75us (US, Japan)\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"volume" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Audio volume multiplier."
},
"squelch" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Squelch threshold in dB."
},
"audioMute" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Mute audio output (1 muted, 0 unmuted).",
+ "minimum" : 0,
+ "maximum" : 1
},
"audioStereo" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable stereo audio decoding (1 stereo, 0 mono).",
+ "minimum" : 0,
+ "maximum" : 1
},
"lsbStereo" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Use lower-sideband stereo decoding (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"showPilot" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Show the stereo pilot spectrum (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"rdsActive" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable RDS decoding (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"audioDeviceName" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Name of the audio device to use."
},
"streamIndex" : {
"type" : "integer",
@@ -3014,27 +3617,38 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"spectrumConfig" : {
+ "description" : "Spectrum-display configuration.",
"$ref" : "#/definitions/GLSpectrum"
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -3043,7 +3657,8 @@ margin-bottom: 20px;
defs.Bandwidth = {
"properties" : {
"bandwidth" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Bandwidth in Hz."
}
},
"description" : "A bandwidth expressed in Hertz (Hz)"
@@ -3061,40 +3676,55 @@ margin-bottom: 20px;
defs.BeamSteeringCWModSettings = {
"properties" : {
"steerDegrees" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Steer degrees setting for Beam steering CW mod."
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"log2Interp" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent of the software interpolation factor; the output sample rate is multiplied by 2^log2Interp."
},
"filterChainHash" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Identifier of the selected half-band filter chain."
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -3103,64 +3733,91 @@ margin-bottom: 20px;
defs.BladeRF1InputSettings = {
"properties" : {
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"centerFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Device center frequency in Hz."
},
"devSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device I/Q sample rate in samples per second before software decimation or interpolation."
},
"lnaGain" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Low-noise-amplifier gain setting."
},
"vga1" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "First variable-gain-amplifier gain setting."
},
"vga2" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Second variable-gain-amplifier gain setting."
},
"bandwidth" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Bandwidth in Hz."
},
"log2Decim" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent of the software decimation factor; the output sample rate is divided by 2^log2Decim."
},
"fcPos" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Position of the decimated passband relative to the device center frequency."
},
"xb200" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Xb200 setting for Blade rf1 input."
},
"xb200Path" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Xb200 path setting for Blade rf1 input."
},
"xb200Filter" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Xb200 filter setting for Blade rf1 input."
},
"dcBlock" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable DSP DC-offset correction (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"iqCorrection" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable I/Q imbalance correction (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"iqOrder" : {
"type" : "integer",
- "description" : "IQ samples order\n * 0 - Q then I (swapped)\n * 1 - I then Q (straight)\n"
+ "description" : "IQ samples order\n * 0 - Q then I (swapped)\n * 1 - I then Q (straight)\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
}
},
"description" : "BladeRF1"
@@ -3168,48 +3825,65 @@ margin-bottom: 20px;
defs.BladeRF1OutputSettings = {
"properties" : {
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"centerFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Device center frequency in Hz."
},
"devSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device I/Q sample rate in samples per second before software decimation or interpolation."
},
"vga1" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "First variable-gain-amplifier gain setting."
},
"vga2" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Second variable-gain-amplifier gain setting."
},
"bandwidth" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Bandwidth in Hz."
},
"log2Interp" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent of the software interpolation factor; the output sample rate is multiplied by 2^log2Interp."
},
"xb200" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Xb200 setting for Blade rf1 output."
},
"xb200Path" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Xb200 path setting for Blade rf1 output."
},
"xb200Filter" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Xb200 filter setting for Blade rf1 output."
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
}
},
"description" : "BladeRF1"
@@ -3217,19 +3891,24 @@ margin-bottom: 20px;
defs.BladeRF2InputReport = {
"properties" : {
"frequencyRange" : {
+ "description" : "Frequency range data for Blade rf2 input.",
"$ref" : "#/definitions/FrequencyRange"
},
"sampleRateRange" : {
+ "description" : "Sample rate range data for Blade rf2 input.",
"$ref" : "#/definitions/Range"
},
"bandwidthRange" : {
+ "description" : "Bandwidth range data for Blade rf2 input.",
"$ref" : "#/definitions/Range"
},
"globalGainRange" : {
+ "description" : "Global gain range data for Blade rf2 input.",
"$ref" : "#/definitions/Range"
},
"gainModes" : {
"type" : "array",
+ "description" : "List of gain modes.",
"items" : {
"$ref" : "#/definitions/NamedEnum"
}
@@ -3240,65 +3919,96 @@ margin-bottom: 20px;
defs.BladeRF2InputSettings = {
"properties" : {
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"centerFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Device center frequency in Hz."
},
"LOppmTenths" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Local-oscillator correction in tenths of a part per million."
},
"devSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device I/Q sample rate in samples per second before software decimation or interpolation."
},
"bandwidth" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Bandwidth in Hz."
},
"gainMode" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Gain-control mode selection."
},
"globalGain" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Overall device gain setting."
},
"biasTee" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable the antenna bias tee (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"log2Decim" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent of the software decimation factor; the output sample rate is divided by 2^log2Decim."
},
"fcPos" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Position of the decimated passband relative to the device center frequency."
},
"dcBlock" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable DSP DC-offset correction (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"iqCorrection" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable I/Q imbalance correction (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"transverterMode" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable transverter frequency translation (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"transverterDeltaFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Frequency translation applied in transverter mode in Hz."
},
"iqOrder" : {
"type" : "integer",
- "description" : "IQ samples order\n * 0 - Q then I (swapped)\n * 1 - I then Q (straight)\n"
+ "description" : "IQ samples order\n * 0 - Q then I (swapped)\n * 1 - I then Q (straight)\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
}
},
"description" : "BladeRF2"
@@ -3306,33 +4016,42 @@ margin-bottom: 20px;
defs.BladeRF2MIMOReport = {
"properties" : {
"frequencyRangeRx" : {
+ "description" : "Frequency range receive data for Blade rf2 MIMO.",
"$ref" : "#/definitions/FrequencyRange"
},
"sampleRateRangeRx" : {
+ "description" : "Sample rate range receive data for Blade rf2 MIMO.",
"$ref" : "#/definitions/Range"
},
"bandwidthRangeRx" : {
+ "description" : "Bandwidth range receive data for Blade rf2 MIMO.",
"$ref" : "#/definitions/Range"
},
"globalGainRangeRx" : {
+ "description" : "Global gain range receive data for Blade rf2 MIMO.",
"$ref" : "#/definitions/Range"
},
"gainModesRx" : {
"type" : "array",
+ "description" : "List of gain modes receive.",
"items" : {
"$ref" : "#/definitions/NamedEnum"
}
},
"frequencyRangeTx" : {
+ "description" : "Frequency range transmit data for Blade rf2 MIMO.",
"$ref" : "#/definitions/FrequencyRange"
},
"sampleRateRangeTx" : {
+ "description" : "Sample rate range transmit data for Blade rf2 MIMO.",
"$ref" : "#/definitions/Range"
},
"bandwidthRangeTx" : {
+ "description" : "Bandwidth range transmit data for Blade rf2 MIMO.",
"$ref" : "#/definitions/Range"
},
"globalGainRangeTx" : {
+ "description" : "Global gain range transmit data for Blade rf2 MIMO.",
"$ref" : "#/definitions/Range"
}
},
@@ -3341,108 +4060,146 @@ margin-bottom: 20px;
defs.BladeRF2MIMOSettings = {
"properties" : {
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"devSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device I/Q sample rate in samples per second before software decimation or interpolation."
},
"LOppmTenths" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Local-oscillator correction in tenths of a part per million."
},
"rxCenterFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Receive center frequency in Hz."
},
"log2Decim" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent of the software decimation factor; the output sample rate is divided by 2^log2Decim."
},
"fcPosRx" : {
"type" : "integer",
"description" : "See BladeRF2MIMO::fcPos_t"
},
"rxBandwidth" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Receive bandwidth in Hz."
},
"rx0GainMode" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Rx0 gain mode setting for Blade rf2 MIMO."
},
"rx0GlobalGain" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Rx0 global gain setting for Blade rf2 MIMO."
},
"rx1GainMode" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Rx1 gain mode setting for Blade rf2 MIMO."
},
"rx1GlobalGain" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Rx1 global gain setting for Blade rf2 MIMO."
},
"rxBiasTee" : {
"type" : "integer",
- "description" : "boolean"
+ "description" : "boolean",
+ "minimum" : 0,
+ "maximum" : 1
},
"dcBlock" : {
"type" : "integer",
- "description" : "boolean"
+ "description" : "boolean",
+ "minimum" : 0,
+ "maximum" : 1
},
"iqCorrection" : {
"type" : "integer",
- "description" : "boolean"
+ "description" : "boolean",
+ "minimum" : 0,
+ "maximum" : 1
},
"rxTransverterMode" : {
"type" : "integer",
- "description" : "boolean"
+ "description" : "boolean",
+ "minimum" : 0,
+ "maximum" : 1
},
"rxTransverterDeltaFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Receive frequency translation applied in transverter mode in Hz."
},
"iqOrder" : {
"type" : "integer",
- "description" : "IQ samples order\n * 0 - Q then I (swapped)\n * 1 - I then Q (straight)\n"
+ "description" : "IQ samples order\n * 0 - Q then I (swapped)\n * 1 - I then Q (straight)\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"txCenterFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Transmit center frequency in Hz."
},
"log2Interp" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent of the software interpolation factor; the output sample rate is multiplied by 2^log2Interp."
},
"fcPosTx" : {
"type" : "integer",
"description" : "See BladeRF2MIMO::fcPos_t"
},
"txBandwidth" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Transmit bandwidth in Hz."
},
"tx0GlobalGain" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Tx0 global gain setting for Blade rf2 MIMO."
},
"tx1GlobalGain" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Tx1 global gain setting for Blade rf2 MIMO."
},
"txBiasTee" : {
"type" : "integer",
- "description" : "boolean"
+ "description" : "boolean",
+ "minimum" : 0,
+ "maximum" : 1
},
"txTransverterMode" : {
"type" : "integer",
- "description" : "boolean"
+ "description" : "boolean",
+ "minimum" : 0,
+ "maximum" : 1
},
"txTransverterDeltaFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Transmit frequency translation applied in transverter mode in Hz."
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "boolean"
+ "description" : "boolean",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
}
},
"description" : "BladeRF2"
@@ -3450,15 +4207,19 @@ margin-bottom: 20px;
defs.BladeRF2OutputReport = {
"properties" : {
"frequencyRange" : {
+ "description" : "Frequency range data for Blade rf2 output.",
"$ref" : "#/definitions/FrequencyRange"
},
"sampleRateRange" : {
+ "description" : "Sample rate range data for Blade rf2 output.",
"$ref" : "#/definitions/Range"
},
"bandwidthRange" : {
+ "description" : "Bandwidth range data for Blade rf2 output.",
"$ref" : "#/definitions/Range"
},
"globalGainRange" : {
+ "description" : "Global gain range data for Blade rf2 output.",
"$ref" : "#/definitions/Range"
}
},
@@ -3467,49 +4228,70 @@ margin-bottom: 20px;
defs.BladeRF2OutputSettings = {
"properties" : {
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"centerFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Device center frequency in Hz."
},
"LOppmTenths" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Local-oscillator correction in tenths of a part per million."
},
"devSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device I/Q sample rate in samples per second before software decimation or interpolation."
},
"bandwidth" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Bandwidth in Hz."
},
"globalGain" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Overall device gain setting."
},
"biasTee" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable the antenna bias tee (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"log2Interp" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent of the software interpolation factor; the output sample rate is multiplied by 2^log2Interp."
},
"transverterMode" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable transverter frequency translation (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"transverterDeltaFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Frequency translation applied in transverter mode in Hz."
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
}
},
"description" : "BladeRF2"
@@ -3517,7 +4299,8 @@ margin-bottom: 20px;
defs.CWKeyerSettings = {
"properties" : {
"sampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Sample rate in samples per second."
},
"wpm" : {
"type" : "integer",
@@ -3528,7 +4311,8 @@ margin-bottom: 20px;
"description" : "see enum CWKeyerSettings::CWMode"
},
"text" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Text setting for CW keyer."
},
"loop" : {
"type" : "integer",
@@ -3645,39 +4429,51 @@ margin-bottom: 20px;
"description" : "Optional for reverse API. This is the channel index from where the message comes from."
},
"AISModActions" : {
+ "description" : "AIS mod actions configuration for Channel.",
"$ref" : "#/definitions/AISModActions"
},
"APTDemodActions" : {
+ "description" : "Apt demod actions configuration for Channel.",
"$ref" : "#/definitions/APTDemodActions"
},
"FileSinkActions" : {
+ "description" : "File sink actions configuration for Channel.",
"$ref" : "#/definitions/FileSinkActions"
},
"FileSourceActions" : {
+ "description" : "File source actions configuration for Channel.",
"$ref" : "#/definitions/FileSourceActions"
},
"FreqScannerActions" : {
+ "description" : "Freq scanner actions configuration for Channel.",
"$ref" : "#/definitions/FreqScannerActions"
},
"IEEE_802_15_4_ModActions" : {
+ "description" : "Ieee 802 15 4 mod actions configuration for Channel.",
"$ref" : "#/definitions/IEEE_802_15_4_ModActions"
},
"MeshcoreModActions" : {
+ "description" : "Meshcore mod actions configuration for Channel.",
"$ref" : "#/definitions/MeshcoreModActions"
},
"PacketModActions" : {
+ "description" : "Packet mod actions configuration for Channel.",
"$ref" : "#/definitions/PacketModActions"
},
"PSK31ModActions" : {
+ "description" : "Psk31 mod actions configuration for Channel.",
"$ref" : "#/definitions/PSK31ModActions"
},
"RadioAstronomyActions" : {
+ "description" : "Radio astronomy actions configuration for Channel.",
"$ref" : "#/definitions/RadioAstronomyActions"
},
"RTTYModActions" : {
+ "description" : "Rtty mod actions configuration for Channel.",
"$ref" : "#/definitions/RTTYModActions"
},
"SigMFFileSinkActions" : {
+ "description" : "Sig mf file sink actions configuration for Channel.",
"$ref" : "#/definitions/SigMFFileSinkActions"
}
},
@@ -3686,72 +4482,95 @@ margin-bottom: 20px;
defs.ChannelAnalyzerSettings = {
"properties" : {
"frequency" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Frequency in Hz."
},
"downSample" : {
"type" : "integer",
- "description" : "Boolean"
+ "description" : "Boolean",
+ "minimum" : 0,
+ "maximum" : 1
},
"downSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Down sample rate in samples per second."
},
"bandwidth" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Bandwidth in Hz."
},
"lowCutoff" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Lower filter cutoff frequency in Hz."
},
"spanLog2" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent controlling the displayed or processed frequency span."
},
"ssb" : {
"type" : "integer",
- "description" : "Boolean"
+ "description" : "Boolean",
+ "minimum" : 0,
+ "maximum" : 1
},
"pll" : {
"type" : "integer",
- "description" : "Boolean"
+ "description" : "Boolean",
+ "minimum" : 0,
+ "maximum" : 1
},
"fll" : {
"type" : "integer",
- "description" : "Boolean"
+ "description" : "Boolean",
+ "minimum" : 0,
+ "maximum" : 1
},
"costasLoop" : {
"type" : "integer",
- "description" : "Boolean"
+ "description" : "Boolean",
+ "minimum" : 0,
+ "maximum" : 1
},
"rrc" : {
"type" : "integer",
- "description" : "Boolean"
+ "description" : "Boolean",
+ "minimum" : 0,
+ "maximum" : 1
},
"rrcRolloff" : {
"type" : "integer",
"description" : "in 100ths"
},
"pllPskOrder" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Pll psk order setting for Channel analyzer."
},
"pllBandwidth" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Pll bandwidth in Hz."
},
"pllDampingFactor" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Pll damping factor setting for Channel analyzer."
},
"pllLoopGain" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Pll loop gain setting for Channel analyzer."
},
"inputType" : {
"type" : "integer",
"description" : "see ChannelAnalyzerSettings::InputType"
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"streamIndex" : {
"type" : "integer",
@@ -3759,30 +4578,42 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"spectrumConfig" : {
+ "description" : "Spectrum-display configuration.",
"$ref" : "#/definitions/GLSpectrum"
},
"scopeConfig" : {
+ "description" : "Oscilloscope-display configuration.",
"$ref" : "#/definitions/GLScope"
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -3795,6 +4626,7 @@ margin-bottom: 20px;
"description" : "Channel type ID in URI form"
},
"config" : {
+ "description" : "Configuration data.",
"$ref" : "#/definitions/ChannelSettings"
}
},
@@ -3833,14 +4665,16 @@ margin-bottom: 20px;
defs.ChannelMarker = {
"properties" : {
"centerFrequency" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device center frequency in Hz."
},
"color" : {
"type" : "integer",
"description" : "RGB color"
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"frequencyScaleDisplayType" : {
"type" : "integer",
@@ -3872,7 +4706,8 @@ margin-bottom: 20px;
"description" : "pulse power received in channel (dB)"
},
"channelSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Effective sample rate delivered to the channel in samples per second."
}
},
"description" : "ChannelPower"
@@ -3881,7 +4716,8 @@ margin-bottom: 20px;
"properties" : {
"inputFrequencyOffset" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Channel frequency offset from the device center frequency in Hz."
},
"frequencyMode" : {
"type" : "integer",
@@ -3894,7 +4730,8 @@ margin-bottom: 20px;
},
"rfBandwidth" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "RF bandwidth in Hz."
},
"pulseThreshold" : {
"type" : "number",
@@ -3906,10 +4743,12 @@ margin-bottom: 20px;
"description" : "Average period in microseconds"
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"streamIndex" : {
"type" : "integer",
@@ -3917,24 +4756,34 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -3953,171 +4802,227 @@ margin-bottom: 20px;
"description" : "0 for Rx only, 1 for Tx only or 2 for any number and direction (default 0)"
},
"ADSBDemodReport" : {
+ "description" : "ADS-B demod report data for Channel.",
"$ref" : "#/definitions/ADSBDemodReport"
},
"AISDemodReport" : {
+ "description" : "AIS demod report data for Channel.",
"$ref" : "#/definitions/AISDemodReport"
},
"AISModReport" : {
+ "description" : "AIS mod report data for Channel.",
"$ref" : "#/definitions/AISModReport"
},
"AMDemodReport" : {
+ "description" : "Am demod report data for Channel.",
"$ref" : "#/definitions/AMDemodReport"
},
"AMModReport" : {
+ "description" : "Am mod report data for Channel.",
"$ref" : "#/definitions/AMModReport"
},
"ATVModReport" : {
+ "description" : "Atv mod report data for Channel.",
"$ref" : "#/definitions/ATVModReport"
},
"BFMDemodReport" : {
+ "description" : "BFM demod report data for Channel.",
"$ref" : "#/definitions/BFMDemodReport"
},
"ChannelPowerReport" : {
+ "description" : "Channel power report data for Channel.",
"$ref" : "#/definitions/ChannelPowerReport"
},
"ChirpChatDemodReport" : {
+ "description" : "Chirp chat demod report data for Channel.",
"$ref" : "#/definitions/ChirpChatDemodReport"
},
"ChirpChatModReport" : {
+ "description" : "Chirp chat mod report data for Channel.",
"$ref" : "#/definitions/ChirpChatModReport"
},
"DATVDemodReport" : {
+ "description" : "Datv demod report data for Channel.",
"$ref" : "#/definitions/DATVDemodReport"
},
"DATVModReport" : {
+ "description" : "Datv mod report data for Channel.",
"$ref" : "#/definitions/DATVModReport"
},
"DOA2Report" : {
+ "description" : "Doa2 report data for Channel.",
"$ref" : "#/definitions/DOA2Report"
},
"DSCDemodReport" : {
+ "description" : "Dsc demod report data for Channel.",
"$ref" : "#/definitions/DSCDemodReport"
},
"DSDDemodReport" : {
+ "description" : "Dsd demod report data for Channel.",
"$ref" : "#/definitions/DSDDemodReport"
},
"EndOfTrainDemodReport" : {
+ "description" : "End of train demod report data for Channel.",
"$ref" : "#/definitions/EndOfTrainDemodReport"
},
"IEEE_802_15_4_ModReport" : {
+ "description" : "Ieee 802 15 4 mod report data for Channel.",
"$ref" : "#/definitions/IEEE_802_15_4_ModReport"
},
"FileSinkReport" : {
+ "description" : "File sink report data for Channel.",
"$ref" : "#/definitions/FileSinkReport"
},
"FileSourceReport" : {
+ "description" : "File source report data for Channel.",
"$ref" : "#/definitions/FileSourceReport"
},
"FreeDVDemodReport" : {
+ "description" : "Free dv demod report data for Channel.",
"$ref" : "#/definitions/FreeDVDemodReport"
},
"FreeDVModReport" : {
+ "description" : "Free dv mod report data for Channel.",
"$ref" : "#/definitions/FreeDVModReport"
},
"FreqScannerReport" : {
+ "description" : "Freq scanner report data for Channel.",
"$ref" : "#/definitions/FreqScannerReport"
},
"FreqTrackerReport" : {
+ "description" : "Freq tracker report data for Channel.",
"$ref" : "#/definitions/FreqTrackerReport"
},
"FT8DemodReport" : {
+ "description" : "Ft8 demod report data for Channel.",
"$ref" : "#/definitions/FT8DemodReport"
},
"HeatMapReport" : {
+ "description" : "Heat map report data for Channel.",
"$ref" : "#/definitions/HeatMapReport"
},
"ILSDemodReport" : {
+ "description" : "Ils demod report data for Channel.",
"$ref" : "#/definitions/ILSDemodReport"
},
"InmarsatDemodReport" : {
+ "description" : "Inmarsat demod report data for Channel.",
"$ref" : "#/definitions/InmarsatDemodReport"
},
"M17DemodReport" : {
+ "description" : "M17 demod report data for Channel.",
"$ref" : "#/definitions/M17DemodReport"
},
"M17ModReport" : {
+ "description" : "M17 mod report data for Channel.",
"$ref" : "#/definitions/M17ModReport"
},
"MeshtasticDemodReport" : {
+ "description" : "Meshtastic demod report data for Channel.",
"$ref" : "#/definitions/MeshtasticDemodReport"
},
"MeshtasticModReport" : {
+ "description" : "Meshtastic mod report data for Channel.",
"$ref" : "#/definitions/MeshtasticModReport"
},
"MeshcoreDemodReport" : {
+ "description" : "Meshcore demod report data for Channel.",
"$ref" : "#/definitions/MeshcoreDemodReport"
},
"MeshcoreModReport" : {
+ "description" : "Meshcore mod report data for Channel.",
"$ref" : "#/definitions/MeshcoreModReport"
},
"NavtexDemodReport" : {
+ "description" : "Navtex demod report data for Channel.",
"$ref" : "#/definitions/NavtexDemodReport"
},
"NFMDemodReport" : {
+ "description" : "Nfm demod report data for Channel.",
"$ref" : "#/definitions/NFMDemodReport"
},
"NFMModReport" : {
+ "description" : "Nfm mod report data for Channel.",
"$ref" : "#/definitions/NFMModReport"
},
"NoiseFigureReport" : {
+ "description" : "Noise figure report data for Channel.",
"$ref" : "#/definitions/NoiseFigureReport"
},
"SSBDemodReport" : {
+ "description" : "Ssb demod report data for Channel.",
"$ref" : "#/definitions/SSBDemodReport"
},
"RadioAstronomyReport" : {
+ "description" : "Radio astronomy report data for Channel.",
"$ref" : "#/definitions/RadioAstronomyReport"
},
"RadioClockReport" : {
+ "description" : "Radio clock report data for Channel.",
"$ref" : "#/definitions/RadioClockReport"
},
"RadiosondeDemodReport" : {
+ "description" : "Radiosonde demod report data for Channel.",
"$ref" : "#/definitions/RadiosondeDemodReport"
},
"RemoteSourceReport" : {
+ "description" : "Remote source report data for Channel.",
"$ref" : "#/definitions/RemoteSourceReport"
},
"RTTYDemodReport" : {
+ "description" : "Rtty demod report data for Channel.",
"$ref" : "#/definitions/RTTYDemodReport"
},
"RTTYModReport" : {
+ "description" : "Rtty mod report data for Channel.",
"$ref" : "#/definitions/RTTYModReport"
},
"PacketDemodReport" : {
+ "description" : "Packet demod report data for Channel.",
"$ref" : "#/definitions/PacketDemodReport"
},
"PacketModReport" : {
+ "description" : "Packet mod report data for Channel.",
"$ref" : "#/definitions/PacketModReport"
},
"PagerDemodReport" : {
+ "description" : "Pager demod report data for Channel.",
"$ref" : "#/definitions/PagerDemodReport"
},
"PSK31ModReport" : {
+ "description" : "Psk31 mod report data for Channel.",
"$ref" : "#/definitions/PSK31ModReport"
},
"SigMFFileSinkReport" : {
+ "description" : "Sig mf file sink report data for Channel.",
"$ref" : "#/definitions/SigMFFileSinkReport"
},
"SSBModReport" : {
+ "description" : "Ssb mod report data for Channel.",
"$ref" : "#/definitions/SSBModReport"
},
"UDPSourceReport" : {
+ "description" : "UDP source report data for Channel.",
"$ref" : "#/definitions/UDPSourceReport"
},
"UDPSinkReport" : {
+ "description" : "UDP sink report data for Channel.",
"$ref" : "#/definitions/UDPSinkReport"
},
"VORDemodReport" : {
+ "description" : "Vor demod report data for Channel.",
"$ref" : "#/definitions/VORDemodReport"
},
"WDSPRxReport" : {
+ "description" : "Wdsp receive report data for Channel.",
"$ref" : "#/definitions/WDSPRxReport"
},
"WFMDemodReport" : {
+ "description" : "Wfm demod report data for Channel.",
"$ref" : "#/definitions/WFMDemodReport"
},
"WFMModReport" : {
+ "description" : "Wfm mod report data for Channel.",
"$ref" : "#/definitions/WFMModReport"
}
},
@@ -4144,201 +5049,267 @@ margin-bottom: 20px;
"description" : "Optional for reverse API. This is the channel index from where the message comes from."
},
"ADSBDemodSettings" : {
+ "description" : "ADS-B demod settings configuration for Channel.",
"$ref" : "#/definitions/ADSBDemodSettings"
},
"AISDemodSettings" : {
+ "description" : "AIS demod settings configuration for Channel.",
"$ref" : "#/definitions/AISDemodSettings"
},
"AISModSettings" : {
+ "description" : "AIS mod settings configuration for Channel.",
"$ref" : "#/definitions/AISModSettings"
},
"AMDemodSettings" : {
+ "description" : "Am demod settings configuration for Channel.",
"$ref" : "#/definitions/AMDemodSettings"
},
"AMModSettings" : {
+ "description" : "Am mod settings configuration for Channel.",
"$ref" : "#/definitions/AMModSettings"
},
"APTDemodSettings" : {
+ "description" : "Apt demod settings configuration for Channel.",
"$ref" : "#/definitions/APTDemodSettings"
},
"ATVDemodSettings" : {
+ "description" : "Atv demod settings configuration for Channel.",
"$ref" : "#/definitions/ATVDemodSettings"
},
"ATVModSettings" : {
+ "description" : "Atv mod settings configuration for Channel.",
"$ref" : "#/definitions/ATVModSettings"
},
"BeamSteeringCWModSettings" : {
+ "description" : "Beam steering CW mod settings configuration for Channel.",
"$ref" : "#/definitions/BeamSteeringCWModSettings"
},
"BFMDemodSettings" : {
+ "description" : "BFM demod settings configuration for Channel.",
"$ref" : "#/definitions/BFMDemodSettings"
},
"ChannelAnalyzerSettings" : {
+ "description" : "Channel analyzer settings configuration for Channel.",
"$ref" : "#/definitions/ChannelAnalyzerSettings"
},
"ChannelPowerSettings" : {
+ "description" : "Channel power settings configuration for Channel.",
"$ref" : "#/definitions/ChannelPowerSettings"
},
"ChirpChatDemodSettings" : {
+ "description" : "Chirp chat demod settings configuration for Channel.",
"$ref" : "#/definitions/ChirpChatDemodSettings"
},
"ChirpChatModSettings" : {
+ "description" : "Chirp chat mod settings configuration for Channel.",
"$ref" : "#/definitions/ChirpChatModSettings"
},
"DATVModSettings" : {
+ "description" : "Datv mod settings configuration for Channel.",
"$ref" : "#/definitions/DATVModSettings"
},
"DATVDemodSettings" : {
+ "description" : "Datv demod settings configuration for Channel.",
"$ref" : "#/definitions/DATVDemodSettings"
},
"DABDemodSettings" : {
+ "description" : "Dab demod settings configuration for Channel.",
"$ref" : "#/definitions/DABDemodSettings"
},
"DOA2Settings" : {
+ "description" : "Doa2 settings configuration for Channel.",
"$ref" : "#/definitions/DOA2Settings"
},
"DSCDemodSettings" : {
+ "description" : "Dsc demod settings configuration for Channel.",
"$ref" : "#/definitions/DSCDemodSettings"
},
"DSDDemodSettings" : {
+ "description" : "Dsd demod settings configuration for Channel.",
"$ref" : "#/definitions/DSDDemodSettings"
},
"EndOfTrainDemodSettings" : {
+ "description" : "End of train demod settings configuration for Channel.",
"$ref" : "#/definitions/EndOfTrainDemodSettings"
},
"FileSinkSettings" : {
+ "description" : "File sink settings configuration for Channel.",
"$ref" : "#/definitions/FileSinkSettings"
},
"FileSourceSettings" : {
+ "description" : "File source settings configuration for Channel.",
"$ref" : "#/definitions/FileSourceSettings"
},
"FreeDVDemodSettings" : {
+ "description" : "Free dv demod settings configuration for Channel.",
"$ref" : "#/definitions/FreeDVDemodSettings"
},
"FreeDVModSettings" : {
+ "description" : "Free dv mod settings configuration for Channel.",
"$ref" : "#/definitions/FreeDVModSettings"
},
"FreqScannerSettings" : {
+ "description" : "Freq scanner settings configuration for Channel.",
"$ref" : "#/definitions/FreqScannerSettings"
},
"FreqTrackerSettings" : {
+ "description" : "Freq tracker settings configuration for Channel.",
"$ref" : "#/definitions/FreqTrackerSettings"
},
"FT8DemodSettings" : {
+ "description" : "Ft8 demod settings configuration for Channel.",
"$ref" : "#/definitions/FT8DemodSettings"
},
"HeatMapSettings" : {
+ "description" : "Heat map settings configuration for Channel.",
"$ref" : "#/definitions/HeatMapSettings"
},
"ILSDemodSettings" : {
+ "description" : "Ils demod settings configuration for Channel.",
"$ref" : "#/definitions/ILSDemodSettings"
},
"InmarsatDemodSettings" : {
+ "description" : "Inmarsat demod settings configuration for Channel.",
"$ref" : "#/definitions/InmarsatDemodSettings"
},
"InterferometerSettings" : {
+ "description" : "Interferometer settings configuration for Channel.",
"$ref" : "#/definitions/InterferometerSettings"
},
"IEEE_802_15_4_ModSettings" : {
+ "description" : "Ieee 802 15 4 mod settings configuration for Channel.",
"$ref" : "#/definitions/IEEE_802_15_4_ModSettings"
},
"M17DemodSettings" : {
+ "description" : "M17 demod settings configuration for Channel.",
"$ref" : "#/definitions/M17DemodSettings"
},
"M17ModSettings" : {
+ "description" : "M17 mod settings configuration for Channel.",
"$ref" : "#/definitions/M17ModSettings"
},
"MeshtasticDemodSettings" : {
+ "description" : "Meshtastic demod settings configuration for Channel.",
"$ref" : "#/definitions/MeshtasticDemodSettings"
},
"MeshtasticModSettings" : {
+ "description" : "Meshtastic mod settings configuration for Channel.",
"$ref" : "#/definitions/MeshtasticModSettings"
},
"MeshcoreDemodSettings" : {
+ "description" : "Meshcore demod settings configuration for Channel.",
"$ref" : "#/definitions/MeshcoreDemodSettings"
},
"MeshcoreModSettings" : {
+ "description" : "Meshcore mod settings configuration for Channel.",
"$ref" : "#/definitions/MeshcoreModSettings"
},
"NavtexDemodSettings" : {
+ "description" : "Navtex demod settings configuration for Channel.",
"$ref" : "#/definitions/NavtexDemodSettings"
},
"NFMDemodSettings" : {
+ "description" : "Nfm demod settings configuration for Channel.",
"$ref" : "#/definitions/NFMDemodSettings"
},
"NFMModSettings" : {
+ "description" : "Nfm mod settings configuration for Channel.",
"$ref" : "#/definitions/NFMModSettings"
},
"NoiseFigureSettings" : {
+ "description" : "Noise figure settings configuration for Channel.",
"$ref" : "#/definitions/NoiseFigureSettings"
},
"LocalSinkSettings" : {
+ "description" : "Local sink settings configuration for Channel.",
"$ref" : "#/definitions/LocalSinkSettings"
},
"LocalSourceSettings" : {
+ "description" : "Local source settings configuration for Channel.",
"$ref" : "#/definitions/LocalSourceSettings"
},
"PacketDemodSettings" : {
+ "description" : "Packet demod settings configuration for Channel.",
"$ref" : "#/definitions/PacketDemodSettings"
},
"PacketModSettings" : {
+ "description" : "Packet mod settings configuration for Channel.",
"$ref" : "#/definitions/PacketModSettings"
},
"PagerDemodSettings" : {
+ "description" : "Pager demod settings configuration for Channel.",
"$ref" : "#/definitions/PagerDemodSettings"
},
"PSK31ModSettings" : {
+ "description" : "Psk31 mod settings configuration for Channel.",
"$ref" : "#/definitions/PSK31ModSettings"
},
"RadioAstronomySettings" : {
+ "description" : "Radio astronomy settings configuration for Channel.",
"$ref" : "#/definitions/RadioAstronomySettings"
},
"RadioClockSettings" : {
+ "description" : "Radio clock settings configuration for Channel.",
"$ref" : "#/definitions/RadioClockSettings"
},
"RadiosondeDemodSettings" : {
+ "description" : "Radiosonde demod settings configuration for Channel.",
"$ref" : "#/definitions/RadiosondeDemodSettings"
},
"RemoteSinkSettings" : {
+ "description" : "Remote sink settings configuration for Channel.",
"$ref" : "#/definitions/RemoteSinkSettings"
},
"RemoteSourceSettings" : {
+ "description" : "Remote source settings configuration for Channel.",
"$ref" : "#/definitions/RemoteSourceSettings"
},
"RemoteTCPSinkSettings" : {
+ "description" : "Remote TCP sink settings configuration for Channel.",
"$ref" : "#/definitions/RemoteTCPSinkSettings"
},
"RTTYDemodSettings" : {
+ "description" : "Rtty demod settings configuration for Channel.",
"$ref" : "#/definitions/RTTYDemodSettings"
},
"RTTYModSettings" : {
+ "description" : "Rtty mod settings configuration for Channel.",
"$ref" : "#/definitions/RTTYModSettings"
},
"SigMFFileSinkSettings" : {
+ "description" : "Sig mf file sink settings configuration for Channel.",
"$ref" : "#/definitions/SigMFFileSinkSettings"
},
"SSBModSettings" : {
+ "description" : "Ssb mod settings configuration for Channel.",
"$ref" : "#/definitions/SSBModSettings"
},
"SSBDemodSettings" : {
+ "description" : "Ssb demod settings configuration for Channel.",
"$ref" : "#/definitions/SSBDemodSettings"
},
"UDPSourceSettings" : {
+ "description" : "UDP source settings configuration for Channel.",
"$ref" : "#/definitions/UDPSourceSettings"
},
"UDPSinkSettings" : {
+ "description" : "UDP sink settings configuration for Channel.",
"$ref" : "#/definitions/UDPSinkSettings"
},
"VORDemodSettings" : {
+ "description" : "Vor demod settings configuration for Channel.",
"$ref" : "#/definitions/VORDemodSettings"
},
"WDSPRxSettings" : {
+ "description" : "Wdsp receive settings configuration for Channel.",
"$ref" : "#/definitions/WDSPRxSettings"
},
"WFMDemodSettings" : {
+ "description" : "Wfm demod settings configuration for Channel.",
"$ref" : "#/definitions/WFMDemodSettings"
},
"WFMModSettings" : {
+ "description" : "Wfm mod settings configuration for Channel.",
"$ref" : "#/definitions/WFMModSettings"
}
},
@@ -4384,7 +5355,8 @@ margin-bottom: 20px;
"description" : "last message de-chirped signal to noise ratio power (dB)"
},
"channelSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Effective sample rate delivered to the channel in samples per second."
},
"syncWord" : {
"type" : "integer",
@@ -4392,7 +5364,9 @@ margin-bottom: 20px;
},
"hasCRC" : {
"type" : "integer",
- "description" : "boolean 1 if payload CRC is present else 0 (LoRa)"
+ "description" : "boolean 1 if payload CRC is present else 0 (LoRa)",
+ "minimum" : 0,
+ "maximum" : 1
},
"nbParityBits" : {
"type" : "integer",
@@ -4412,7 +5386,9 @@ margin-bottom: 20px;
},
"headerParityStatus" : {
"type" : "integer",
- "description" : "Header FEC parity status:\n * 0 - Undefined\n * 1 - Uncorrectable error\n * 2 - Corrected error\n * 3 - OK\n"
+ "description" : "Header FEC parity status:\n * 0 - Undefined\n * 1 - Uncorrectable error\n * 2 - Corrected error\n * 3 - OK\n",
+ "minimum" : 0,
+ "maximum" : 3
},
"headerCRCStatus" : {
"type" : "integer",
@@ -4420,7 +5396,9 @@ margin-bottom: 20px;
},
"payloadParityStatus" : {
"type" : "integer",
- "description" : "Payload FEC parity status:\n * 0 - Undefined\n * 1 - Uncorrectable error\n * 2 - Corrected error\n * 3 - OK\n"
+ "description" : "Payload FEC parity status:\n * 0 - Undefined\n * 1 - Uncorrectable error\n * 2 - Corrected error\n * 3 - OK\n",
+ "minimum" : 0,
+ "maximum" : 3
},
"payloadCRCStatus" : {
"type" : "integer",
@@ -4443,7 +5421,9 @@ margin-bottom: 20px;
},
"decoding" : {
"type" : "integer",
- "description" : "Boolean - decoding status\n * 0 - no decoding\n * 1 - decoding\n"
+ "description" : "Boolean - decoding status\n * 0 - no decoding\n * 1 - decoding\n",
+ "minimum" : 0,
+ "maximum" : 1
}
},
"description" : "ChirpChatDemod"
@@ -4452,14 +5432,18 @@ margin-bottom: 20px;
"properties" : {
"inputFrequencyOffset" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Channel frequency offset from the device center frequency in Hz."
},
"bandwidthIndex" : {
"type" : "integer",
- "description" : "standard bandwidths index:\n * 0 - 375 Hz (384000 / 1024)\n * 1 - 750 Hz (384000 / 512)\n * 2 - 1500 Hz (384000 / 256)\n * 3 - 2604 Hz (333333 / 128)\n * 4 - 3125 Hz (400000 / 128)\n * 5 - 3906 Hz (500000 / 128)\n * 6 - 5208 Hz (333333 / 64)\n * 7 - 6250 Hz (400000 / 64)\n * 8 - 7813 Hz (500000 / 64)\n * 9 - 10417 Hz (333333 / 32)\n * 10 - 12500 Hz (400000 / 32)\n * 11 - 15625 Hz (500000 / 32)\n * 12 - 20833 Hz (333333 / 16)\n * 13 - 25000 Hz (400000 / 16)\n * 14 - 31250 Hz (500000 / 16)\n * 15 - 41667 Hz (333333 / 8)\n * 16 - 50000 Hz (400000 / 8)\n * 17 - 62500 Hz (500000 / 8)\n * 18 - 83333 Hz (333333 / 4)\n * 19 - 100000 Hz (400000 / 4)\n * 20 - 125000 Hz (500000 / 4)\n * 21 - 166667 Hz (333333 / 2)\n * 22 - 200000 Hz (400000 / 2)\n * 23 - 250000 Hz (500000 / 2)\n * 24 - 333333 Hz (333333 / 1)\n * 25 - 400000 Hz (400000 / 1)\n * 26 - 500000 Hz (500000 / 1)\n"
+ "description" : "standard bandwidths index:\n * 0 - 375 Hz (384000 / 1024)\n * 1 - 750 Hz (384000 / 512)\n * 2 - 1500 Hz (384000 / 256)\n * 3 - 2604 Hz (333333 / 128)\n * 4 - 3125 Hz (400000 / 128)\n * 5 - 3906 Hz (500000 / 128)\n * 6 - 5208 Hz (333333 / 64)\n * 7 - 6250 Hz (400000 / 64)\n * 8 - 7813 Hz (500000 / 64)\n * 9 - 10417 Hz (333333 / 32)\n * 10 - 12500 Hz (400000 / 32)\n * 11 - 15625 Hz (500000 / 32)\n * 12 - 20833 Hz (333333 / 16)\n * 13 - 25000 Hz (400000 / 16)\n * 14 - 31250 Hz (500000 / 16)\n * 15 - 41667 Hz (333333 / 8)\n * 16 - 50000 Hz (400000 / 8)\n * 17 - 62500 Hz (500000 / 8)\n * 18 - 83333 Hz (333333 / 4)\n * 19 - 100000 Hz (400000 / 4)\n * 20 - 125000 Hz (500000 / 4)\n * 21 - 166667 Hz (333333 / 2)\n * 22 - 200000 Hz (400000 / 2)\n * 23 - 250000 Hz (500000 / 2)\n * 24 - 333333 Hz (333333 / 1)\n * 25 - 400000 Hz (400000 / 1)\n * 26 - 500000 Hz (500000 / 1)\n",
+ "minimum" : 0,
+ "maximum" : 26
},
"spreadFactor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Spread factor setting for Chirp chat demod."
},
"deBits" : {
"type" : "integer",
@@ -4467,15 +5451,21 @@ margin-bottom: 20px;
},
"fftWindow" : {
"type" : "integer",
- "description" : "FFT Window index (FFTWindow::Function):\n * 0 - Bartlett\n * 1 - Blackman-Harris 4 term\n * 2 - Flattop\n * 3 - Hamming\n * 4 - Hanning\n * 5 - Rectangle\n * 6 - Kaiser\n * 7 - Blackman 3 term\n * 8 - Blackman-Harris 7 term\n"
+ "description" : "FFT Window index (FFTWindow::Function):\n * 0 - Bartlett\n * 1 - Blackman-Harris 4 term\n * 2 - Flattop\n * 3 - Hamming\n * 4 - Hanning\n * 5 - Rectangle\n * 6 - Kaiser\n * 7 - Blackman 3 term\n * 8 - Blackman-Harris 7 term\n",
+ "minimum" : 0,
+ "maximum" : 8
},
"codingScheme" : {
"type" : "integer",
- "description" : "message encoding scheme (ChirpChatDemodSettings::CodingScheme):\n * 0 - LoRa\n * 1 - Plain ASCII (7 bit)\n * 2 - Teletype (5 bit Baudot) a.k.a TTY\n"
+ "description" : "message encoding scheme (ChirpChatDemodSettings::CodingScheme):\n * 0 - LoRa\n * 1 - Plain ASCII (7 bit)\n * 2 - Teletype (5 bit Baudot) a.k.a TTY\n",
+ "minimum" : 0,
+ "maximum" : 2
},
"decodeActive" : {
"type" : "integer",
- "description" : "boolean 1 to activate 0 to de-activate decoder"
+ "description" : "boolean 1 to activate 0 to de-activate decoder",
+ "minimum" : 0,
+ "maximum" : 1
},
"eomSquelchTenths" : {
"type" : "integer",
@@ -4511,11 +5501,15 @@ margin-bottom: 20px;
},
"sendViaUDP" : {
"type" : "integer",
- "description" : "boolean 1 to send decoded message via UDP else 0"
+ "description" : "boolean 1 to send decoded message via UDP else 0",
+ "minimum" : 0,
+ "maximum" : 1
},
"udoEnabled" : {
"type" : "integer",
- "description" : "Boolean - Send via UDP\n * 0 - Do not send decoded messages via UDP\n * 1 - Send decoded messages via UDP\n"
+ "description" : "Boolean - Send via UDP\n * 0 - Do not send decoded messages via UDP\n * 1 - Send decoded messages via UDP\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"udpAddress" : {
"type" : "string",
@@ -4523,17 +5517,23 @@ margin-bottom: 20px;
},
"udpPort" : {
"type" : "integer",
- "description" : "UDP destination port"
+ "description" : "UDP destination port",
+ "minimum" : 1,
+ "maximum" : 65535
},
"invertRamps" : {
"type" : "integer",
- "description" : "Invert chirp ramps\n * 0 - Normal chirp ramps (upchirps for preamble and payload)\n * 1 - Inverted chirp ramps (downchirps for preamble and payload)\n"
+ "description" : "Invert chirp ramps\n * 0 - Normal chirp ramps (upchirps for preamble and payload)\n * 1 - Inverted chirp ramps (downchirps for preamble and payload)\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"streamIndex" : {
"type" : "integer",
@@ -4541,27 +5541,38 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"spectrumConfig" : {
+ "description" : "Spectrum-display configuration.",
"$ref" : "#/definitions/GLSpectrum"
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -4575,7 +5586,8 @@ margin-bottom: 20px;
"description" : "power transmitted in channel (dB)"
},
"channelSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Effective sample rate delivered to the channel in samples per second."
},
"symbolTimeMs" : {
"type" : "number",
@@ -4594,7 +5606,9 @@ margin-bottom: 20px;
},
"playing" : {
"type" : "integer",
- "description" : "Boolean - modulator is active (playing) including idle time\n * 0 - Modulator not active\n * 1 - Modulator active\n"
+ "description" : "Boolean - modulator is active (playing) including idle time\n * 0 - Modulator not active\n * 1 - Modulator active\n",
+ "minimum" : 0,
+ "maximum" : 1
}
},
"description" : "ChirpChatMod"
@@ -4603,14 +5617,18 @@ margin-bottom: 20px;
"properties" : {
"inputFrequencyOffset" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Channel frequency offset from the device center frequency in Hz."
},
"bandwidthIndex" : {
"type" : "integer",
- "description" : "standard bandwidths index:\n * 0 - 375 Hz (384000 / 1024)\n * 1 - 750 Hz (384000 / 512)\n * 2 - 1500 Hz (384000 / 256)\n * 3 - 2604 Hz (333333 / 128)\n * 4 - 3125 Hz (400000 / 128)\n * 5 - 3906 Hz (500000 / 128)\n * 6 - 5208 Hz (333333 / 64)\n * 7 - 6250 Hz (400000 / 64)\n * 8 - 7813 Hz (500000 / 64)\n * 9 - 10417 Hz (333333 / 32)\n * 10 - 12500 Hz (400000 / 32)\n * 11 - 15625 Hz (500000 / 32)\n * 12 - 20833 Hz (333333 / 16)\n * 13 - 25000 Hz (400000 / 16)\n * 14 - 31250 Hz (500000 / 16)\n * 15 - 41667 Hz (333333 / 8)\n * 16 - 50000 Hz (400000 / 8)\n * 17 - 62500 Hz (500000 / 8)\n * 18 - 83333 Hz (333333 / 4)\n * 19 - 100000 Hz (400000 / 4)\n * 20 - 125000 Hz (500000 / 4)\n * 21 - 166667 Hz (333333 / 2)\n * 22 - 200000 Hz (400000 / 2)\n * 23 - 250000 Hz (500000 / 2)\n * 24 - 333333 Hz (333333 / 1)\n * 25 - 400000 Hz (400000 / 1)\n * 26 - 500000 Hz (500000 / 1)\n"
+ "description" : "standard bandwidths index:\n * 0 - 375 Hz (384000 / 1024)\n * 1 - 750 Hz (384000 / 512)\n * 2 - 1500 Hz (384000 / 256)\n * 3 - 2604 Hz (333333 / 128)\n * 4 - 3125 Hz (400000 / 128)\n * 5 - 3906 Hz (500000 / 128)\n * 6 - 5208 Hz (333333 / 64)\n * 7 - 6250 Hz (400000 / 64)\n * 8 - 7813 Hz (500000 / 64)\n * 9 - 10417 Hz (333333 / 32)\n * 10 - 12500 Hz (400000 / 32)\n * 11 - 15625 Hz (500000 / 32)\n * 12 - 20833 Hz (333333 / 16)\n * 13 - 25000 Hz (400000 / 16)\n * 14 - 31250 Hz (500000 / 16)\n * 15 - 41667 Hz (333333 / 8)\n * 16 - 50000 Hz (400000 / 8)\n * 17 - 62500 Hz (500000 / 8)\n * 18 - 83333 Hz (333333 / 4)\n * 19 - 100000 Hz (400000 / 4)\n * 20 - 125000 Hz (500000 / 4)\n * 21 - 166667 Hz (333333 / 2)\n * 22 - 200000 Hz (400000 / 2)\n * 23 - 250000 Hz (500000 / 2)\n * 24 - 333333 Hz (333333 / 1)\n * 25 - 400000 Hz (400000 / 1)\n * 26 - 500000 Hz (500000 / 1)\n",
+ "minimum" : 0,
+ "maximum" : 26
},
"spreadFactor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Spread factor setting for Chirp chat mod."
},
"deBits" : {
"type" : "integer",
@@ -4630,11 +5648,15 @@ margin-bottom: 20px;
},
"channelMute" : {
"type" : "integer",
- "description" : "boolean"
+ "description" : "boolean",
+ "minimum" : 0,
+ "maximum" : 1
},
"codingScheme" : {
"type" : "integer",
- "description" : "message encoding scheme (ChirpChatModSettings::CodingScheme):\n * 0 - LoRa\n * 1 - Plain ASCII (7 bit)\n * 2 - Teletype (5 bit Baudot) a.k.a TTY\n"
+ "description" : "message encoding scheme (ChirpChatModSettings::CodingScheme):\n * 0 - LoRa\n * 1 - Plain ASCII (7 bit)\n * 2 - Teletype (5 bit Baudot) a.k.a TTY\n",
+ "minimum" : 0,
+ "maximum" : 2
},
"nbParityBits" : {
"type" : "integer",
@@ -4666,7 +5688,9 @@ margin-bottom: 20px;
},
"messageType" : {
"type" : "integer",
- "description" : "type of message to send (ChirpChatModSettings::MessageType):\n * 0 - No message i.e no output. Use this as a transition to resend the same message.\n * 1 - Beacon. Sends message specified in beaconMessage\n * 2 - CQ call. Sends message specified in cqMessage\n * 3 - Reply to CQ call. Sends message specified in replyMessage\n * 4 - Report to callee. Sends message specified in reportMessage\n * 5 - Report to caller. Sends message specified in replyReportMessage\n * 6 - RRR to callee. Sends message specified in rrrMessage\n * 7 - 73 to caller. Sends message specified in message73\n * 8 - Random message with callsigns. Sends message specified in qsoTextMessage\n * 9 - Plain text. Sends message specified in textMessage\n * 10 - Binary payload. Sends bytes specified in bytesMessage\n"
+ "description" : "type of message to send (ChirpChatModSettings::MessageType):\n * 0 - No message i.e no output. Use this as a transition to resend the same message.\n * 1 - Beacon. Sends message specified in beaconMessage\n * 2 - CQ call. Sends message specified in cqMessage\n * 3 - Reply to CQ call. Sends message specified in replyMessage\n * 4 - Report to callee. Sends message specified in reportMessage\n * 5 - Report to caller. Sends message specified in replyReportMessage\n * 6 - RRR to callee. Sends message specified in rrrMessage\n * 7 - 73 to caller. Sends message specified in message73\n * 8 - Random message with callsigns. Sends message specified in qsoTextMessage\n * 9 - Plain text. Sends message specified in textMessage\n * 10 - Binary payload. Sends bytes specified in bytesMessage\n",
+ "minimum" : 0,
+ "maximum" : 10
},
"beaconMessage" : {
"type" : "string",
@@ -4717,7 +5741,9 @@ margin-bottom: 20px;
},
"udpEnabled" : {
"type" : "integer",
- "description" : "boolean 1 to enable forwarding messages via UDP else 0"
+ "description" : "boolean 1 to enable forwarding messages via UDP else 0",
+ "minimum" : 0,
+ "maximum" : 1
},
"udpAddress" : {
"type" : "string",
@@ -4725,17 +5751,23 @@ margin-bottom: 20px;
},
"udpPort" : {
"type" : "integer",
- "description" : "UDP port to listen for messages to transmit on"
+ "description" : "UDP port to listen for messages to transmit on",
+ "minimum" : 1,
+ "maximum" : 65535
},
"invertRamps" : {
"type" : "integer",
- "description" : "Invert chirp ramps\n * 0 - Normal chirp ramps (upchirps for preamble and payload)\n * 1 - Inverted chirp ramps (downchirps for preamble and payload)\n"
+ "description" : "Invert chirp ramps\n * 0 - Normal chirp ramps (upchirps for preamble and payload)\n * 1 - Inverted chirp ramps (downchirps for preamble and payload)\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"streamIndex" : {
"type" : "integer",
@@ -4743,24 +5775,34 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -4769,16 +5811,20 @@ margin-bottom: 20px;
defs.Command = {
"properties" : {
"group" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Group for Command."
},
"description" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Human-readable description."
},
"command" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Command for Command."
},
"argString" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Arg string for Command."
},
"key" : {
"type" : "integer",
@@ -4790,11 +5836,15 @@ margin-bottom: 20px;
},
"associateKey" : {
"type" : "integer",
- "description" : "boolean"
+ "description" : "boolean",
+ "minimum" : 0,
+ "maximum" : 1
},
"release" : {
"type" : "integer",
- "description" : "boolean"
+ "description" : "boolean",
+ "minimum" : 0,
+ "maximum" : 1
}
},
"description" : "Represents a Command object"
@@ -4803,11 +5853,13 @@ margin-bottom: 20px;
"properties" : {
"real" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Real component of the complex number."
},
"imag" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Imaginary component of the complex number."
}
},
"description" : "A complex number"
@@ -4889,30 +5941,40 @@ margin-bottom: 20px;
"properties" : {
"inputFrequencyOffset" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Channel frequency offset from the device center frequency in Hz."
},
"rfBandwidth" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "RF bandwidth in Hz."
},
"program" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Program setting for Dab demod."
},
"volume" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Audio volume multiplier."
},
"audioMute" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Mute audio output (1 muted, 0 unmuted).",
+ "minimum" : 0,
+ "maximum" : 1
},
"audioDeviceName" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Name of the audio device to use."
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"streamIndex" : {
"type" : "integer",
@@ -4920,24 +5982,34 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -4952,7 +6024,9 @@ margin-bottom: 20px;
},
"audioActive" : {
"type" : "integer",
- "description" : "Audio is active (1 for yes, 0 for now)"
+ "description" : "Audio is active (1 for yes, 0 for now)",
+ "minimum" : 0,
+ "maximum" : 1
},
"audioDecodeOK" : {
"type" : "integer",
@@ -4960,7 +6034,9 @@ margin-bottom: 20px;
},
"videoActive" : {
"type" : "integer",
- "description" : "Audio is active (1 for yes, 0 for now)"
+ "description" : "Audio is active (1 for yes, 0 for now)",
+ "minimum" : 0,
+ "maximum" : 1
},
"videoDecodeOK" : {
"type" : "integer",
@@ -4988,11 +6064,13 @@ margin-bottom: 20px;
},
"mer" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Reported mer."
},
"cnr" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Reported cnr."
}
},
"description" : "DATVDemod"
@@ -5000,28 +6078,38 @@ margin-bottom: 20px;
defs.DATVDemodSettings = {
"properties" : {
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"rfBandwidth" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "RF bandwidth in Hz."
},
"centerFrequency" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device center frequency in Hz."
},
"standard" : {
"type" : "integer",
- "description" : "DVB bersion (see DATVDemodSettings::dvb_version)\n * 0 - DVB-S\n * 1 - DVB-S2\n"
+ "description" : "DVB bersion (see DATVDemodSettings::dvb_version)\n * 0 - DVB-S\n * 1 - DVB-S2\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"modulation" : {
"type" : "integer",
- "description" : "Modulation type (DATVDemodSettings::DATVModulation)\n * 0 - BPSK\n * 1 - QPSK\n * 2 - PSK8\n * 3 - APSK16\n * 4 - APSK32\n * 5 - APSK64E\n * 6 - QAM16\n * 7 - QAM64\n * 8 - QAM256\n"
+ "description" : "Modulation type (DATVDemodSettings::DATVModulation)\n * 0 - BPSK\n * 1 - QPSK\n * 2 - PSK8\n * 3 - APSK16\n * 4 - APSK32\n * 5 - APSK64E\n * 6 - QAM16\n * 7 - QAM64\n * 8 - QAM256\n",
+ "minimum" : 0,
+ "maximum" : 8
},
"fec" : {
"type" : "integer",
- "description" : "FEC rate (see DATVDemodSettings::DATVCodeRate)\n * 0 - 1/2\n * 1 - 2/3\n * 2 - 4/6\n * 3 - 3/4\n * 4 - 4/6\n * 5 - 7/8\n * 6 - 4/5\n * 7 - 8/9\n * 8 - 9/10\n * 9 - 1/4\n * 10 - 1/3\n * 11 - 2/5\n * 12 - 3/5\n"
+ "description" : "FEC rate (see DATVDemodSettings::DATVCodeRate)\n * 0 - 1/2\n * 1 - 2/3\n * 2 - 4/6\n * 3 - 3/4\n * 4 - 4/6\n * 5 - 7/8\n * 6 - 4/5\n * 7 - 8/9\n * 8 - 9/10\n * 9 - 1/4\n * 10 - 1/3\n * 11 - 2/5\n * 12 - 3/5\n",
+ "minimum" : 0,
+ "maximum" : 12
},
"softLDPC" : {
"type" : "integer",
@@ -5037,16 +6125,21 @@ margin-bottom: 20px;
},
"audioMute" : {
"type" : "integer",
- "description" : "(boolean) mute audio output"
+ "description" : "(boolean) mute audio output",
+ "minimum" : 0,
+ "maximum" : 1
},
"audioDeviceName" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Name of the audio device to use."
},
"symbolRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Symbol rate setting for Datv demod."
},
"notchFilters" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Notch filters setting for Datv demod."
},
"allowDrift" : {
"type" : "integer",
@@ -5058,7 +6151,9 @@ margin-bottom: 20px;
},
"filter" : {
"type" : "integer",
- "description" : "Type of symbol filtering (see DATVDemodSettings::dvb_sampler)\n * 0 - Nearest\n * 1 - Linear\n * 2 - Root Raised Cosine\n"
+ "description" : "Type of symbol filtering (see DATVDemodSettings::dvb_sampler)\n * 0 - Nearest\n * 1 - Linear\n * 2 - Root Raised Cosine\n",
+ "minimum" : 0,
+ "maximum" : 2
},
"hardMetric" : {
"type" : "integer",
@@ -5078,25 +6173,34 @@ margin-bottom: 20px;
"description" : "RRC filter envelope excursion (dB)"
},
"audioVolume" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Audio volume setting for Datv demod."
},
"videoMute" : {
"type" : "integer",
- "description" : "boolean"
+ "description" : "boolean",
+ "minimum" : 0,
+ "maximum" : 1
},
"udpTSAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "UDP ts address."
},
"udpTSPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "UDP ts port."
},
"udpTS" : {
"type" : "integer",
- "description" : "boolean"
+ "description" : "boolean",
+ "minimum" : 0,
+ "maximum" : 1
},
"playerEnable" : {
"type" : "integer",
- "description" : "boolean"
+ "description" : "boolean",
+ "minimum" : 0,
+ "maximum" : 1
},
"streamIndex" : {
"type" : "integer",
@@ -5104,24 +6208,34 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -5135,20 +6249,25 @@ margin-bottom: 20px;
"description" : "power transmitted in channel (dB)"
},
"channelSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Effective sample rate delivered to the channel in samples per second."
},
"dataRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Reported data rate."
},
"tsFileBitrate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Reported ts file bitrate."
},
"tsFileLength" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Reported ts file length."
},
"udpByteCount" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Number of udp byte events or items."
}
},
"description" : "DATVMod"
@@ -5157,11 +6276,13 @@ margin-bottom: 20px;
"properties" : {
"inputFrequencyOffset" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Channel frequency offset from the device center frequency in Hz."
},
"rfBandwidth" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "RF bandwidth in Hz."
},
"standard" : {
"type" : "integer",
@@ -5189,7 +6310,8 @@ margin-bottom: 20px;
"description" : "Transport stream source (File=0 UDP=1)"
},
"imageFileName" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Image file name or path."
},
"imageOverlayTimestamp" : {
"type" : "integer",
@@ -5208,30 +6330,40 @@ margin-bottom: 20px;
"description" : "Image codec (HEVC=0 H264=1)"
},
"tsFileName" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Ts file name."
},
"tsFilePlayLoop" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Ts file play loop setting for Datv mod."
},
"tsFilePlay" : {
"type" : "integer",
"description" : "(Pause=0 Play=1)"
},
"udpAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name used for UDP traffic."
},
"udpPort" : {
"type" : "integer",
- "description" : "UDP port number to receive MPEG transport stream on"
+ "description" : "UDP port number to receive MPEG transport stream on",
+ "minimum" : 1,
+ "maximum" : 65535
},
"channelMute" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Mute the channel output (1 muted, 0 unmuted).",
+ "minimum" : 0,
+ "maximum" : 1
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"streamIndex" : {
"type" : "integer",
@@ -5239,24 +6371,34 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -5298,16 +6440,20 @@ margin-bottom: 20px;
"description" : "see DOA2Settings::CorrelationType"
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"log2Decim" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent of the software decimation factor; the output sample rate is divided by 2^log2Decim."
},
"filterChainHash" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Identifier of the selected half-band filter chain."
},
"phase" : {
"type" : "integer",
@@ -5331,27 +6477,38 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"scopeConfig" : {
+ "description" : "Oscilloscope-display configuration.",
"$ref" : "#/definitions/GLScope"
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -5365,7 +6522,8 @@ margin-bottom: 20px;
"description" : "power transmitted in channel (dB)"
},
"channelSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Effective sample rate delivered to the channel in samples per second."
}
},
"description" : "DSCDemod"
@@ -5374,44 +6532,65 @@ margin-bottom: 20px;
"properties" : {
"inputFrequencyOffset" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Channel frequency offset from the device center frequency in Hz."
},
"rfBandwidth" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "RF bandwidth in Hz."
},
"filterInvalid" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Filter invalid setting for Dsc demod."
},
"filterColumn" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Filter column setting for Dsc demod."
},
"filter" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Filter setting for Dsc demod."
},
"udpEnabled" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable udp (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"udpAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name used for UDP traffic."
},
"udpPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "UDP port number.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"logFilename" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Log file name or path."
},
"logEnabled" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable logging to the configured file (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"useFileTime" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable file time (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"streamIndex" : {
"type" : "integer",
@@ -5419,27 +6598,38 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"scopeConfig" : {
+ "description" : "Oscilloscope-display configuration.",
"$ref" : "#/definitions/GLScope"
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -5453,10 +6643,12 @@ margin-bottom: 20px;
"description" : "power transmitted in channel (dB)"
},
"audioSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Audio sample rate in samples per second."
},
"channelSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Effective sample rate delivered to the channel in samples per second."
},
"squelch" : {
"type" : "integer",
@@ -5505,66 +6697,89 @@ margin-bottom: 20px;
"properties" : {
"inputFrequencyOffset" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Channel frequency offset from the device center frequency in Hz."
},
"rfBandwidth" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "RF bandwidth in Hz."
},
"fmDeviation" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "FM frequency deviation in Hz."
},
"demodGain" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Demod gain setting for Dsd demod."
},
"volume" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Audio volume multiplier."
},
"baudRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Serial-port baud rate in bits per second."
},
"squelchGate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Squelch gate duration."
},
"squelch" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Squelch threshold in dB."
},
"audioMute" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Mute audio output (1 muted, 0 unmuted).",
+ "minimum" : 0,
+ "maximum" : 1
},
"enableCosineFiltering" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable cosine filtering (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"syncOrConstellation" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Sync or constellation setting for Dsd demod."
},
"slot1On" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Slot1 on setting for Dsd demod."
},
"slot2On" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Slot2 on setting for Dsd demod."
},
"tdmaStereo" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Tdma stereo setting for Dsd demod."
},
"pllLock" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Pll lock setting for Dsd demod."
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"audioDeviceName" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Name of the audio device to use."
},
"highPassFilter" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "High pass filter setting for Dsd demod."
},
"traceLengthMutliplier" : {
"type" : "integer",
@@ -5584,24 +6799,34 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
},
"ambeFeatureIndex" : {
@@ -5610,7 +6835,9 @@ margin-bottom: 20px;
},
"connectAMBE" : {
"type" : "integer",
- "description" : "Decode frames with AMBE feature\n * 0 - Do not decode frames with AMBE feature\n * 1 - Decode frames with AMBE feature\n"
+ "description" : "Decode frames with AMBE feature\n * 0 - Do not decode frames with AMBE feature\n * 1 - Decode frames with AMBE feature\n",
+ "minimum" : 0,
+ "maximum" : 1
}
},
"description" : "DSDDemod"
@@ -5658,13 +6885,16 @@ margin-bottom: 20px;
defs.DemodAnalyzerSettings = {
"properties" : {
"log2Decim" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent of the software decimation factor; the output sample rate is divided by 2^log2Decim."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"fileRecordName" : {
"type" : "string",
@@ -5672,7 +6902,9 @@ margin-bottom: 20px;
},
"recordToFile" : {
"type" : "integer",
- "description" : "Recording status\n * 1 - recording\n * 0 - not recording\n"
+ "description" : "Recording status\n * 1 - recording\n * 0 - not recording\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"recordSilenceTime" : {
"type" : "integer",
@@ -5680,27 +6912,38 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API\n * 1 - yes\n * 0 - no\n"
+ "description" : "Synchronize with reverse API\n * 1 - yes\n * 0 - no\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIFeatureSetIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Feature-set index used by the reverse API peer."
},
"reverseAPIFeatureIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Feature index used by the reverse API peer."
},
"spectrumConfig" : {
+ "description" : "Spectrum-display configuration.",
"$ref" : "#/definitions/GLSpectrum"
},
"scopeConfig" : {
+ "description" : "Oscilloscope-display configuration.",
"$ref" : "#/definitions/GLScope"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -5724,11 +6967,15 @@ margin-bottom: 20px;
"properties" : {
"denoiserType" : {
"type" : "integer",
- "description" : "Denoiser type\n * 0 - none\n * 1 - RNnoise\n"
+ "description" : "Denoiser type\n * 0 - none\n * 1 - RNnoise\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"enableDenoiser" : {
"type" : "integer",
- "description" : "Enable denoiser\n * 1 - enable\n * 0 - disable\n"
+ "description" : "Enable denoiser\n * 1 - enable\n * 0 - disable\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"volumeTenths" : {
"type" : "integer",
@@ -5740,13 +6987,17 @@ margin-bottom: 20px;
},
"audioMute" : {
"type" : "integer",
- "description" : "Audio mute\n * 1 - mute\n * 0 - unmute\n"
+ "description" : "Audio mute\n * 1 - mute\n * 0 - unmute\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"fileRecordName" : {
"type" : "string",
@@ -5754,25 +7005,36 @@ margin-bottom: 20px;
},
"recordToFile" : {
"type" : "integer",
- "description" : "Recording status\n * 1 - recording\n * 0 - not recording\n"
+ "description" : "Recording status\n * 1 - recording\n * 0 - not recording\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API\n * 1 - yes\n * 0 - no\n"
+ "description" : "Synchronize with reverse API\n * 1 - yes\n * 0 - no\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIFeatureSetIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Feature-set index used by the reverse API peer."
},
"reverseAPIFeatureIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Feature index used by the reverse API peer."
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -5795,6 +7057,7 @@ margin-bottom: 20px;
"description" : "Optional for reverse API. This is the device set index from where the message comes from."
},
"sigMFFileInputActions" : {
+ "description" : "Sig mf file input actions configuration for Device.",
"$ref" : "#/definitions/SigMFFileInputActions"
}
},
@@ -5803,15 +7066,19 @@ margin-bottom: 20px;
defs.DeviceConfig = {
"properties" : {
"deviceId" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Device id for Device config."
},
"deviceSerial" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Device serial for Device config."
},
"deviceSequence" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device sequence for Device config."
},
"config" : {
+ "description" : "Configuration data.",
"$ref" : "#/definitions/DeviceSettings"
}
},
@@ -5871,102 +7138,135 @@ margin-bottom: 20px;
"description" : "0 for Rx only, 1 for Tx only or 2 for any number and direction (default 0)"
},
"airspyReport" : {
+ "description" : "Airspy report data for Device.",
"$ref" : "#/definitions/AirspyReport"
},
"airspyHFReport" : {
+ "description" : "Airspy hf report data for Device.",
"$ref" : "#/definitions/AirspyHFReport"
},
"androidSDRDriverInputReport" : {
+ "description" : "Android sdr driver input report data for Device.",
"$ref" : "#/definitions/AndroidSDRDriverInputReport"
},
"bladeRF2InputReport" : {
+ "description" : "Blade rf2 input report data for Device.",
"$ref" : "#/definitions/BladeRF2InputReport"
},
"bladeRF2OutputReport" : {
+ "description" : "Blade rf2 output report data for Device.",
"$ref" : "#/definitions/BladeRF2OutputReport"
},
"bladeRF2MIMOReport" : {
+ "description" : "Blade rf2 MIMO report data for Device.",
"$ref" : "#/definitions/BladeRF2MIMOReport"
},
"fileInputReport" : {
+ "description" : "File input report data for Device.",
"$ref" : "#/definitions/FileInputReport"
},
"kiwiSDRReport" : {
+ "description" : "Kiwi sdr report data for Device.",
"$ref" : "#/definitions/KiwiSDRReport"
},
"limeSdrInputReport" : {
+ "description" : "Lime sdr input report data for Device.",
"$ref" : "#/definitions/LimeSdrInputReport"
},
"limeSdrOutputReport" : {
+ "description" : "Lime sdr output report data for Device.",
"$ref" : "#/definitions/LimeSdrOutputReport"
},
"limeSdrMIMOReport" : {
+ "description" : "Lime sdr MIMO report data for Device.",
"$ref" : "#/definitions/LimeSdrMIMOReport"
},
"localInputReport" : {
+ "description" : "Local input report data for Device.",
"$ref" : "#/definitions/LocalInputReport"
},
"localOutputReport" : {
+ "description" : "Local output report data for Device.",
"$ref" : "#/definitions/LocalOutputReport"
},
"perseusReport" : {
+ "description" : "Perseus report data for Device.",
"$ref" : "#/definitions/PerseusReport"
},
"plutoSdrInputReport" : {
+ "description" : "Pluto sdr input report data for Device.",
"$ref" : "#/definitions/PlutoSdrInputReport"
},
"plutoSdrOutputReport" : {
+ "description" : "Pluto sdr output report data for Device.",
"$ref" : "#/definitions/PlutoSdrOutputReport"
},
"plutoSdrMIMOReport" : {
+ "description" : "Pluto sdr MIMO report data for Device.",
"$ref" : "#/definitions/PlutoSdrMIMOReport"
},
"rtlSdrReport" : {
+ "description" : "Rtl sdr report data for Device.",
"$ref" : "#/definitions/RtlSdrReport"
},
"remoteOutputReport" : {
+ "description" : "Remote output report data for Device.",
"$ref" : "#/definitions/RemoteOutputReport"
},
"remoteInputReport" : {
+ "description" : "Remote input report data for Device.",
"$ref" : "#/definitions/RemoteInputReport"
},
"remoteTCPInputReport" : {
+ "description" : "Remote TCP input report data for Device.",
"$ref" : "#/definitions/RemoteTCPInputReport"
},
"sdrPlayReport" : {
+ "description" : "Sdr play report data for Device.",
"$ref" : "#/definitions/SDRPlayReport"
},
"sdrPlayV3Report" : {
+ "description" : "Sdr play v3 report data for Device.",
"$ref" : "#/definitions/SDRPlayV3Report"
},
"sigMFFileInputReport" : {
+ "description" : "Sig mf file input report data for Device.",
"$ref" : "#/definitions/SigMFFileInputReport"
},
"soapySDRInputReport" : {
+ "description" : "Soapy sdr input report data for Device.",
"$ref" : "#/definitions/SoapySDRReport"
},
"soapySDROutputReport" : {
+ "description" : "Soapy sdr output report data for Device.",
"$ref" : "#/definitions/SoapySDRReport"
},
"usrpInputReport" : {
+ "description" : "Usrp input report data for Device.",
"$ref" : "#/definitions/USRPInputReport"
},
"usrpOutputReport" : {
+ "description" : "Usrp output report data for Device.",
"$ref" : "#/definitions/USRPOutputReport"
},
"xtrxInputReport" : {
+ "description" : "Xtrx input report data for Device.",
"$ref" : "#/definitions/XtrxInputReport"
},
"xtrxOutputReport" : {
+ "description" : "Xtrx output report data for Device.",
"$ref" : "#/definitions/XtrxOutputReport"
},
"xtrxMIMOReport" : {
+ "description" : "Xtrx MIMO report data for Device.",
"$ref" : "#/definitions/XtrxMIMOReport"
},
"AaroniaRTSAReport" : {
+ "description" : "Aaronia rtsa report data for Device.",
"$ref" : "#/definitions/AaroniaRTSAReport"
},
"aaroniaRTSAOutputReport" : {
+ "description" : "Aaronia rtsa output report data for Device.",
"$ref" : "#/definitions/AaroniaRTSAOutputReport"
}
},
@@ -6029,144 +7329,191 @@ margin-bottom: 20px;
"description" : "Optional for reverse API. This is the device set index from where the message comes from."
},
"airspySettings" : {
+ "description" : "Airspy settings configuration for Device.",
"$ref" : "#/definitions/AirspySettings"
},
"airspyHFSettings" : {
+ "description" : "Airspy hf settings configuration for Device.",
"$ref" : "#/definitions/AirspyHFSettings"
},
"androidSDRDriverInputSettings" : {
+ "description" : "Android sdr driver input settings configuration for Device.",
"$ref" : "#/definitions/AndroidSDRDriverInputSettings"
},
"audioCATSISOSettings" : {
+ "description" : "Audio catsiso settings configuration for Device.",
"$ref" : "#/definitions/AudioCATSISOSettings"
},
"audioInputSettings" : {
+ "description" : "Audio input settings configuration for Device.",
"$ref" : "#/definitions/AudioInputSettings"
},
"audioOutputSettings" : {
+ "description" : "Audio output settings configuration for Device.",
"$ref" : "#/definitions/AudioOutputSettings"
},
"bladeRF1InputSettings" : {
+ "description" : "Blade rf1 input settings configuration for Device.",
"$ref" : "#/definitions/BladeRF1InputSettings"
},
"bladeRF2InputSettings" : {
+ "description" : "Blade rf2 input settings configuration for Device.",
"$ref" : "#/definitions/BladeRF2InputSettings"
},
"bladeRF1OutputSettings" : {
+ "description" : "Blade rf1 output settings configuration for Device.",
"$ref" : "#/definitions/BladeRF1OutputSettings"
},
"bladeRF2OutputSettings" : {
+ "description" : "Blade rf2 output settings configuration for Device.",
"$ref" : "#/definitions/BladeRF2OutputSettings"
},
"bladeRF2MIMOSettings" : {
+ "description" : "Blade rf2 MIMO settings configuration for Device.",
"$ref" : "#/definitions/BladeRF2MIMOSettings"
},
"fcdProSettings" : {
+ "description" : "Fcd pro settings configuration for Device.",
"$ref" : "#/definitions/FCDProSettings"
},
"fcdProPlusSettings" : {
+ "description" : "Fcd pro plus settings configuration for Device.",
"$ref" : "#/definitions/FCDProPlusSettings"
},
"fileInputSettings" : {
+ "description" : "File input settings configuration for Device.",
"$ref" : "#/definitions/FileInputSettings"
},
"fileOutputSettings" : {
+ "description" : "File output settings configuration for Device.",
"$ref" : "#/definitions/FileOutputSettings"
},
"hackRFInputSettings" : {
+ "description" : "Hack RF input settings configuration for Device.",
"$ref" : "#/definitions/HackRFInputSettings"
},
"hackRFOutputSettings" : {
+ "description" : "Hack RF output settings configuration for Device.",
"$ref" : "#/definitions/HackRFOutputSettings"
},
"kiwiSDRSettings" : {
+ "description" : "Kiwi sdr settings configuration for Device.",
"$ref" : "#/definitions/KiwiSDRSettings"
},
"limeSdrInputSettings" : {
+ "description" : "Lime sdr input settings configuration for Device.",
"$ref" : "#/definitions/LimeSdrInputSettings"
},
"limeSdrOutputSettings" : {
+ "description" : "Lime sdr output settings configuration for Device.",
"$ref" : "#/definitions/LimeSdrOutputSettings"
},
"limeSdrMIMOSettings" : {
+ "description" : "Lime sdr MIMO settings configuration for Device.",
"$ref" : "#/definitions/LimeSdrMIMOSettings"
},
"localInputSettings" : {
+ "description" : "Local input settings configuration for Device.",
"$ref" : "#/definitions/LocalInputSettings"
},
"localOutputSettings" : {
+ "description" : "Local output settings configuration for Device.",
"$ref" : "#/definitions/LocalOutputSettings"
},
"metisMISOSettings" : {
+ "description" : "Metis miso settings configuration for Device.",
"$ref" : "#/definitions/MetisMISOSettings"
},
"perseusSettings" : {
+ "description" : "Perseus settings configuration for Device.",
"$ref" : "#/definitions/PerseusSettings"
},
"plutoSdrInputSettings" : {
+ "description" : "Pluto sdr input settings configuration for Device.",
"$ref" : "#/definitions/PlutoSdrInputSettings"
},
"plutoSdrOutputSettings" : {
+ "description" : "Pluto sdr output settings configuration for Device.",
"$ref" : "#/definitions/PlutoSdrOutputSettings"
},
"plutoSdrMIMOSettings" : {
+ "description" : "Pluto sdr MIMO settings configuration for Device.",
"$ref" : "#/definitions/PlutoSdrMIMOSettings"
},
"rtlSdrSettings" : {
+ "description" : "Rtl sdr settings configuration for Device.",
"$ref" : "#/definitions/RtlSdrSettings"
},
"remoteOutputSettings" : {
+ "description" : "Remote output settings configuration for Device.",
"$ref" : "#/definitions/RemoteOutputSettings"
},
"remoteInputSettings" : {
+ "description" : "Remote input settings configuration for Device.",
"$ref" : "#/definitions/RemoteInputSettings"
},
"remoteTCPInputSettings" : {
+ "description" : "Remote TCP input settings configuration for Device.",
"$ref" : "#/definitions/RemoteTCPInputSettings"
},
"sdrPlaySettings" : {
+ "description" : "Sdr play settings configuration for Device.",
"$ref" : "#/definitions/SDRPlaySettings"
},
"sdrPlayV3Settings" : {
+ "description" : "Sdr play v3 settings configuration for Device.",
"$ref" : "#/definitions/SDRPlayV3Settings"
},
"sigMFFileInputSettings" : {
+ "description" : "Sig mf file input settings configuration for Device.",
"$ref" : "#/definitions/SigMFFileInputSettings"
},
"soapySDRInputSettings" : {
+ "description" : "Soapy sdr input settings configuration for Device.",
"$ref" : "#/definitions/SoapySDRInputSettings"
},
"soapySDROutputSettings" : {
+ "description" : "Soapy sdr output settings configuration for Device.",
"$ref" : "#/definitions/SoapySDROutputSettings"
},
"testMISettings" : {
+ "description" : "Test mi settings configuration for Device.",
"$ref" : "#/definitions/TestMISettings"
},
"testMOSyncSettings" : {
+ "description" : "Test mo sync settings configuration for Device.",
"$ref" : "#/definitions/TestMOSyncSettings"
},
"testSourceSettings" : {
+ "description" : "Test source settings configuration for Device.",
"$ref" : "#/definitions/TestSourceSettings"
},
"usrpInputSettings" : {
+ "description" : "Usrp input settings configuration for Device.",
"$ref" : "#/definitions/USRPInputSettings"
},
"usrpOutputSettings" : {
+ "description" : "Usrp output settings configuration for Device.",
"$ref" : "#/definitions/USRPOutputSettings"
},
"xtrxInputSettings" : {
+ "description" : "Xtrx input settings configuration for Device.",
"$ref" : "#/definitions/XtrxInputSettings"
},
"xtrxOutputSettings" : {
+ "description" : "Xtrx output settings configuration for Device.",
"$ref" : "#/definitions/XtrxOutputSettings"
},
"xtrxMIMOSettings" : {
+ "description" : "Xtrx MIMO settings configuration for Device.",
"$ref" : "#/definitions/XtrxMIMOSettings"
},
"aaroniaRTSASettings" : {
+ "description" : "Aaronia rtsa settings configuration for Device.",
"$ref" : "#/definitions/AaroniaRTSASettings"
},
"aaroniaRTSAOutputSettings" : {
+ "description" : "Aaronia rtsa output settings configuration for Device.",
"$ref" : "#/definitions/AaroniaRTSAOutputSettings"
}
},
@@ -6189,7 +7536,8 @@ margin-bottom: 20px;
"description" : "power received in channel (dB)"
},
"channelSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Effective sample rate delivered to the channel in samples per second."
}
},
"description" : "EndOfTrainDemod"
@@ -6198,19 +7546,24 @@ margin-bottom: 20px;
"properties" : {
"inputFrequencyOffset" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Channel frequency offset from the device center frequency in Hz."
},
"rfBandwidth" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "RF bandwidth in Hz."
},
"fmDeviation" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "FM frequency deviation in Hz."
},
"udpEnabled" : {
"type" : "integer",
- "description" : "Whether to forward received packets to specified UDP port"
+ "description" : "Whether to forward received packets to specified UDP port",
+ "minimum" : 0,
+ "maximum" : 1
},
"udpAddress" : {
"type" : "string",
@@ -6218,22 +7571,33 @@ margin-bottom: 20px;
},
"udpPort" : {
"type" : "integer",
- "description" : "UDP port to forward received packets to"
+ "description" : "UDP port to forward received packets to",
+ "minimum" : 1,
+ "maximum" : 65535
},
"logFilename" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Log file name or path."
},
"logEnabled" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable logging to the configured file (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"useFileTime" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable file time (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"streamIndex" : {
"type" : "integer",
@@ -6241,24 +7605,34 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -6276,17 +7650,21 @@ margin-bottom: 20px;
defs.FCDProPlusSettings = {
"properties" : {
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"centerFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Device center frequency in Hz."
},
"log2Decim" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent of the software decimation factor; the output sample rate is divided by 2^log2Decim."
},
"fcPos" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Position of the decimated passband relative to the device center frequency."
},
"rangeLow" : {
"type" : "integer",
@@ -6302,49 +7680,74 @@ margin-bottom: 20px;
},
"biasT" : {
"type" : "integer",
- "description" : "Bias tee select (1 if selected else 0)"
+ "description" : "Bias tee select (1 if selected else 0)",
+ "minimum" : 0,
+ "maximum" : 1
},
"ifGain" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Intermediate-frequency gain setting."
},
"ifFilterIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Selected if filter index."
},
"rfFilterIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Selected rf filter index."
},
"LOppmTenths" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Local-oscillator correction in tenths of a part per million."
},
"dcBlock" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable DSP DC-offset correction (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"iqImbalance" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable DSP I/Q imbalance correction (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"transverterMode" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable transverter frequency translation (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"transverterDeltaFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Frequency translation applied in transverter mode in Hz."
},
"iqOrder" : {
"type" : "integer",
- "description" : "IQ samples order\n * 0 - Q then I (swapped)\n * 1 - I then Q (straight)\n"
+ "description" : "IQ samples order\n * 0 - Q then I (swapped)\n * 1 - I then Q (straight)\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
}
},
"description" : "FCDProPlus"
@@ -6352,98 +7755,138 @@ margin-bottom: 20px;
defs.FCDProSettings = {
"properties" : {
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"centerFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Device center frequency in Hz."
},
"LOppmTenths" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Local-oscillator correction in tenths of a part per million."
},
"lnaGainIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Selected lna gain index."
},
"rfFilterIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Selected rf filter index."
},
"lnaEnhanceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Selected lna enhance index."
},
"bandIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Selected band index."
},
"mixerGainIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Selected mixer gain index."
},
"mixerFilterIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Selected mixer filter index."
},
"biasCurrentIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Selected bias current index."
},
"modeIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Selected mode index."
},
"gain1Index" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Selected gain1 index."
},
"rcFilterIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Selected rc filter index."
},
"gain2Index" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Selected gain2 index."
},
"gain3Index" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Selected gain3 index."
},
"gain4Index" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Selected gain4 index."
},
"ifFilterIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Selected if filter index."
},
"gain5Index" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Selected gain5 index."
},
"gain6Index" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Selected gain6 index."
},
"log2Decim" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent of the software decimation factor; the output sample rate is divided by 2^log2Decim."
},
"fcPos" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Position of the decimated passband relative to the device center frequency."
},
"dcBlock" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable DSP DC-offset correction (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"iqCorrection" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable I/Q imbalance correction (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"transverterMode" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable transverter frequency translation (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"transverterDeltaFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Frequency translation applied in transverter mode in Hz."
},
"iqOrder" : {
"type" : "integer",
- "description" : "IQ samples order\n * 0 - Q then I (swapped)\n * 1 - I then Q (straight)\n"
+ "description" : "IQ samples order\n * 0 - Q then I (swapped)\n * 1 - I then Q (straight)\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
}
},
"description" : "FCDPro"
@@ -6475,7 +7918,8 @@ margin-bottom: 20px;
"description" : "Audio squelch status (1 if open else 0)"
},
"channelSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Effective sample rate delivered to the channel in samples per second."
}
},
"description" : "FT8Demod"
@@ -6484,41 +7928,55 @@ margin-bottom: 20px;
"properties" : {
"inputFrequencyOffset" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Channel frequency offset from the device center frequency in Hz."
},
"filterIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Selected filter index."
},
"spanLog2" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent controlling the displayed or processed frequency span."
},
"rfBandwidth" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "RF bandwidth in Hz."
},
"lowCutoff" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Lower filter cutoff frequency in Hz."
},
"fftWindow" : {
"type" : "integer",
- "description" : "FFT Window index (FFTWindow::Function):\n * 0 - Bartlett\n * 1 - Blackman-Harris 4 term\n * 2 - Flattop\n * 3 - Hamming\n * 4 - Hanning\n * 5 - Rectangle\n * 6 - Kaiser\n * 7 - Blackman 3 term\n * 8 - Blackman-Harris 7 term\n"
+ "description" : "FFT Window index (FFTWindow::Function):\n * 0 - Bartlett\n * 1 - Blackman-Harris 4 term\n * 2 - Flattop\n * 3 - Hamming\n * 4 - Hanning\n * 5 - Rectangle\n * 6 - Kaiser\n * 7 - Blackman 3 term\n * 8 - Blackman-Harris 7 term\n",
+ "minimum" : 0,
+ "maximum" : 8
},
"volume" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Audio volume multiplier."
},
"agc" : {
"type" : "integer",
- "description" : "AGC (1 if AGC active else 0)"
+ "description" : "AGC (1 if AGC active else 0)",
+ "minimum" : 0,
+ "maximum" : 1
},
"recordWav" : {
"type" : "integer",
- "description" : "Record received audio as 12000S/s 16 bit .wav file\n * 0 - Do not record\n * 1 - Record as sdrangel/ft8/save/YYYYMMDD_HHMMSS.wav in writable location\n"
+ "description" : "Record received audio as 12000S/s 16 bit .wav file\n * 0 - Do not record\n * 1 - Record as sdrangel/ft8/save/YYYYMMDD_HHMMSS.wav in writable location\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"logMessages" : {
"type" : "integer",
- "description" : "Log decoded messages in WSJT CALL.TXT format\n * 0 - Do not log messages\n * 1 - Log messages as sdrangel/ft8/logs/YYYYMMDD_call.txt in writable location (daily files)\n"
+ "description" : "Log decoded messages in WSJT CALL.TXT format\n * 0 - Do not log messages\n * 1 - Log messages as sdrangel/ft8/logs/YYYYMMDD_call.txt in writable location (daily files)\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"nbDecoderThreads" : {
"type" : "integer",
@@ -6531,7 +7989,9 @@ margin-bottom: 20px;
},
"useOSD" : {
"type" : "integer",
- "description" : "Use Ordered Statistics Decoding (OSD) to decode messages if some LDPC bits are invalid\n * 0 - Disable\n * 1 - Enable\n"
+ "description" : "Use Ordered Statistics Decoding (OSD) to decode messages if some LDPC bits are invalid\n * 0 - Disable\n * 1 - Enable\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"osdDepth" : {
"type" : "integer",
@@ -6543,26 +8003,35 @@ margin-bottom: 20px;
},
"verifyOSD" : {
"type" : "integer",
- "description" : "Verify OSD decoded message against a list of validated callsigns\n * 0 - Disable\n * 1 - Enable\n"
+ "description" : "Verify OSD decoded message against a list of validated callsigns\n * 0 - Disable\n * 1 - Enable\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"enablePSKReporter" : {
"type" : "integer",
- "description" : "Enable reporting of decoded messages to PSK Reporter server\n * 0 - Disable\n * 1 - Enable\n"
+ "description" : "Enable reporting of decoded messages to PSK Reporter server\n * 0 - Disable\n * 1 - Enable\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"pskReporterCallsign" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Psk reporter callsign setting for Ft8 demod."
},
"pskReporterLocator" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Psk reporter locator setting for Ft8 demod."
},
"pskReporterSoftware" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Psk reporter software setting for Ft8 demod."
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"streamIndex" : {
"type" : "integer",
@@ -6570,27 +8039,38 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"spectrumConfig" : {
+ "description" : "Spectrum-display configuration.",
"$ref" : "#/definitions/GLSpectrum"
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -6636,48 +8116,67 @@ margin-bottom: 20px;
"description" : "Optional for reverse API. This is the feature index from where the message comes from."
},
"AFCActions" : {
+ "description" : "Afc actions configuration for Feature.",
"$ref" : "#/definitions/AFCActions"
},
"AMBEActions" : {
+ "description" : "Ambe actions configuration for Feature.",
"$ref" : "#/definitions/AMBEActions"
},
"GS232ControllerActions" : {
+ "description" : "Gs232 controller actions configuration for Feature.",
"$ref" : "#/definitions/GS232ControllerActions"
},
"LimeRFEActions" : {
+ "description" : "Lime rfe actions configuration for Feature.",
"$ref" : "#/definitions/LimeRFEActions"
},
"MapActions" : {
+ "description" : "Map actions configuration for Feature.",
"$ref" : "#/definitions/MapActions"
},
"MorseDecoderActions" : {
+ "description" : "Morse decoder actions configuration for Feature.",
"$ref" : "#/definitions/MorseDecoderActions"
},
"PERTesterActions" : {
+ "description" : "Per tester actions configuration for Feature.",
"$ref" : "#/definitions/PERTesterActions"
},
"RigCtlServerActions" : {
+ "description" : "Rig ctl server actions configuration for Feature.",
"$ref" : "#/definitions/RigCtlServerActions"
},
+ "MCPServerActions" : {
+ "description" : "Mcp server actions configuration for Feature.",
+ "$ref" : "#/definitions/MCPServerActions"
+ },
"SatelliteTrackerActions" : {
+ "description" : "Satellite tracker actions configuration for Feature.",
"$ref" : "#/definitions/SatelliteTrackerActions"
},
"SimplePTTActions" : {
+ "description" : "Simple ptt actions configuration for Feature.",
"$ref" : "#/definitions/SimplePTTActions"
},
"SkyMapActions" : {
+ "description" : "Sky map actions configuration for Feature.",
"$ref" : "#/definitions/SkyMapActions"
},
"StarTrackerActions" : {
+ "description" : "Star tracker actions configuration for Feature.",
"$ref" : "#/definitions/StarTrackerActions"
},
"VORLocalizerActions" : {
+ "description" : "Vor localizer actions configuration for Feature.",
"$ref" : "#/definitions/VORLocalizerActions"
},
"DemodAnalyzerActions" : {
+ "description" : "Demod analyzer actions configuration for Feature.",
"$ref" : "#/definitions/DemodAnalyzerActions"
},
"DenoiserActions" : {
+ "description" : "Denoiser actions configuration for Feature.",
"$ref" : "#/definitions/DenoiserActions"
}
},
@@ -6690,6 +8189,7 @@ margin-bottom: 20px;
"description" : "Feature type ID in URI form"
},
"config" : {
+ "description" : "Configuration data.",
"$ref" : "#/definitions/FeatureSettings"
}
},
@@ -6790,42 +8290,59 @@ margin-bottom: 20px;
"description" : "Feature type code"
},
"AFCReport" : {
+ "description" : "Afc report data for Feature.",
"$ref" : "#/definitions/AFCReport"
},
"AMBEReport" : {
+ "description" : "Ambe report data for Feature.",
"$ref" : "#/definitions/AMBEReport"
},
"FreqDisplayReport" : {
+ "description" : "Freq display report data for Feature.",
"$ref" : "#/definitions/FreqDisplayReport"
},
"GS232ControllerReport" : {
+ "description" : "Gs232 controller report data for Feature.",
"$ref" : "#/definitions/GS232ControllerReport"
},
"LimeRFEReport" : {
+ "description" : "Lime rfe report data for Feature.",
"$ref" : "#/definitions/LimeRFEReport"
},
"MapReport" : {
+ "description" : "Map report data for Feature.",
"$ref" : "#/definitions/MapReport"
},
"PERTesterReport" : {
+ "description" : "Per tester report data for Feature.",
"$ref" : "#/definitions/PERTesterReport"
},
"RigCtlServerReport" : {
+ "description" : "Rig ctl server report data for Feature.",
"$ref" : "#/definitions/RigCtlServerReport"
},
+ "MCPServerReport" : {
+ "description" : "Mcp server report data for Feature.",
+ "$ref" : "#/definitions/MCPServerReport"
+ },
"SatelliteTrackerReport" : {
+ "description" : "Satellite tracker report data for Feature.",
"$ref" : "#/definitions/SatelliteTrackerReport"
},
"SimplePTTReport" : {
+ "description" : "Simple ptt report data for Feature.",
"$ref" : "#/definitions/SimplePTTReport"
},
"SkyMapReport" : {
+ "description" : "Sky map report data for Feature.",
"$ref" : "#/definitions/SkyMapReport"
},
"StarTrackerReport" : {
+ "description" : "Star tracker report data for Feature.",
"$ref" : "#/definitions/StarTrackerReport"
},
"VORLocalizerReport" : {
+ "description" : "Vor localizer report data for Feature.",
"$ref" : "#/definitions/VORLocalizerReport"
}
},
@@ -6851,13 +8368,16 @@ margin-bottom: 20px;
defs.FeatureSetPreset = {
"properties" : {
"group" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Group for Feature set preset."
},
"description" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Human-readable description."
},
"featureConfigs" : {
"type" : "array",
+ "description" : "List of feature configs.",
"items" : {
"$ref" : "#/definitions/FeatureConfig"
}
@@ -6882,69 +8402,95 @@ margin-bottom: 20px;
"description" : "Optional for reverse API. This is the feature index from where the message comes from."
},
"AFCSettings" : {
+ "description" : "Afc settings configuration for Feature.",
"$ref" : "#/definitions/AFCSettings"
},
"AISSettings" : {
+ "description" : "AIS settings configuration for Feature.",
"$ref" : "#/definitions/AISSettings"
},
"AMBESettings" : {
+ "description" : "Ambe settings configuration for Feature.",
"$ref" : "#/definitions/AMBESettings"
},
"AntennaToolsSettings" : {
+ "description" : "Antenna tools settings configuration for Feature.",
"$ref" : "#/definitions/AntennaToolsSettings"
},
"APRSSettings" : {
+ "description" : "Aprs settings configuration for Feature.",
"$ref" : "#/definitions/APRSSettings"
},
"DemodAnalyzerSettings" : {
+ "description" : "Demod analyzer settings configuration for Feature.",
"$ref" : "#/definitions/DemodAnalyzerSettings"
},
"DenoiserSettings" : {
+ "description" : "Denoiser settings configuration for Feature.",
"$ref" : "#/definitions/DenoiserSettings"
},
"JogdialControllerSettings" : {
+ "description" : "Jogdial controller settings configuration for Feature.",
"$ref" : "#/definitions/JogdialControllerSettings"
},
"FreqDisplaySettings" : {
+ "description" : "Freq display settings configuration for Feature.",
"$ref" : "#/definitions/FreqDisplaySettings"
},
"GS232ControllerSettings" : {
+ "description" : "Gs232 controller settings configuration for Feature.",
"$ref" : "#/definitions/GS232ControllerSettings"
},
"LimeRFESettings" : {
+ "description" : "Lime rfe settings configuration for Feature.",
"$ref" : "#/definitions/LimeRFESettings"
},
"MapSettings" : {
+ "description" : "Map settings configuration for Feature.",
"$ref" : "#/definitions/MapSettings"
},
"MorseDecoderSettings" : {
+ "description" : "Morse decoder settings configuration for Feature.",
"$ref" : "#/definitions/MorseDecoderSettings"
},
"PERTesterSettings" : {
+ "description" : "Per tester settings configuration for Feature.",
"$ref" : "#/definitions/PERTesterSettings"
},
"RadiosondeSettings" : {
+ "description" : "Radiosonde settings configuration for Feature.",
"$ref" : "#/definitions/RadiosondeSettings"
},
"RigCtlServerSettings" : {
+ "description" : "Rig ctl server settings configuration for Feature.",
"$ref" : "#/definitions/RigCtlServerSettings"
},
+ "MCPServerSettings" : {
+ "description" : "Mcp server settings configuration for Feature.",
+ "$ref" : "#/definitions/MCPServerSettings"
+ },
"SatelliteTrackerSettings" : {
+ "description" : "Satellite tracker settings configuration for Feature.",
"$ref" : "#/definitions/SatelliteTrackerSettings"
},
"SIDSettings" : {
+ "description" : "Sid settings configuration for Feature.",
"$ref" : "#/definitions/SIDSettings"
},
"SimplePTTSettings" : {
+ "description" : "Simple ptt settings configuration for Feature.",
"$ref" : "#/definitions/SimplePTTSettings"
},
"SkyMapSettings" : {
+ "description" : "Sky map settings configuration for Feature.",
"$ref" : "#/definitions/SkyMapSettings"
},
"StarTrackerSettings" : {
+ "description" : "Star tracker settings configuration for Feature.",
"$ref" : "#/definitions/StarTrackerSettings"
},
"VORLocalizerSettings" : {
+ "description" : "Vor localizer settings configuration for Feature.",
"$ref" : "#/definitions/VORLocalizerSettings"
}
},
@@ -6953,7 +8499,8 @@ margin-bottom: 20px;
defs.FileInputReport = {
"properties" : {
"fileName" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "File name or path."
},
"sampleRate" : {
"type" : "integer",
@@ -6981,7 +8528,8 @@ margin-bottom: 20px;
defs.FileInputSettings = {
"properties" : {
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"fileName" : {
"type" : "string",
@@ -6997,16 +8545,23 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
}
},
"description" : "FileInput"
@@ -7014,7 +8569,8 @@ margin-bottom: 20px;
defs.FileOutputSettings = {
"properties" : {
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"fileName" : {
"type" : "string",
@@ -7022,27 +8578,37 @@ margin-bottom: 20px;
},
"centerFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Device center frequency in Hz."
},
"sampleRate" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Sample rate in samples per second."
},
"log2Interp" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent of the software interpolation factor; the output sample rate is multiplied by 2^log2Interp."
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
}
},
"description" : "FileInput"
@@ -7061,7 +8627,9 @@ margin-bottom: 20px;
"properties" : {
"record" : {
"type" : "integer",
- "description" : "Record action\n * 0 - stop recording\n * 1 - start recording\n"
+ "description" : "Record action\n * 0 - stop recording\n * 1 - start recording\n",
+ "minimum" : 0,
+ "maximum" : 1
}
},
"description" : "FileSink"
@@ -7070,7 +8638,9 @@ margin-bottom: 20px;
"properties" : {
"spectrumSquelch" : {
"type" : "integer",
- "description" : "Spectrum squelch status * 0 - closed * 1 - open\n"
+ "description" : "Spectrum squelch status * 0 - closed * 1 - open\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"spectrumMax" : {
"type" : "number",
@@ -7078,14 +8648,18 @@ margin-bottom: 20px;
"description" : "Current spectrum max in squared magnitude (power)"
},
"sinkSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Sample rate accepted by the sink in samples per second."
},
"channelSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Effective sample rate delivered to the channel in samples per second."
},
"recording" : {
"type" : "integer",
- "description" : "Recording status * 0 - not recording * 1 - recording\n"
+ "description" : "Recording status * 0 - not recording * 1 - recording\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"recordTimeMs" : {
"type" : "integer",
@@ -7106,24 +8680,30 @@ margin-bottom: 20px;
defs.FileSinkSettings = {
"properties" : {
"inputFrequencyOffset" : {
- "type" : "integer"
+ "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"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"log2Decim" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent of the software decimation factor; the output sample rate is divided by 2^log2Decim."
},
"spectrumSquelchMode" : {
"type" : "integer",
- "description" : "Spectrum squelch system * 0 - deactivated * 1 - activated\n"
+ "description" : "Spectrum squelch system * 0 - deactivated * 1 - activated\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"spectrumSquelch" : {
"type" : "number",
@@ -7140,7 +8720,9 @@ margin-bottom: 20px;
},
"squelchRecordingEnable" : {
"type" : "integer",
- "description" : "Automatic recording triggered by spectrum squelch * 0 - disabled * 1 - enabled\n"
+ "description" : "Automatic recording triggered by spectrum squelch * 0 - disabled * 1 - enabled\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"streamIndex" : {
"type" : "integer",
@@ -7148,27 +8730,38 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"spectrumConfig" : {
+ "description" : "Spectrum-display configuration.",
"$ref" : "#/definitions/GLSpectrum"
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -7178,7 +8771,9 @@ margin-bottom: 20px;
"properties" : {
"play" : {
"type" : "integer",
- "description" : "Play or Pause stream\n * 0 - Pause\n * 1 - Play\n"
+ "description" : "Play or Pause stream\n * 0 - Pause\n * 1 - Play\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"seekMillis" : {
"type" : "integer",
@@ -7190,7 +8785,8 @@ margin-bottom: 20px;
defs.FileSourceReport = {
"properties" : {
"fileName" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "File name or path."
},
"fileSampleRate" : {
"type" : "integer",
@@ -7235,19 +8831,24 @@ margin-bottom: 20px;
"description" : "1 if playing in a loop else 0"
},
"log2Interp" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent of the software interpolation factor; the output sample rate is multiplied by 2^log2Interp."
},
"filterChainHash" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Identifier of the selected half-band filter chain."
},
"gainDB" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Gain dB in dB."
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"streamIndex" : {
"type" : "integer",
@@ -7255,24 +8856,34 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -7290,10 +8901,12 @@ margin-bottom: 20px;
"description" : "Audio squelch status (1 if open else 0)"
},
"audioSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Audio sample rate in samples per second."
},
"channelSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Effective sample rate delivered to the channel in samples per second."
}
},
"description" : "FreeDVDemod"
@@ -7302,7 +8915,8 @@ margin-bottom: 20px;
"properties" : {
"inputFrequencyOffset" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Channel frequency offset from the device center frequency in Hz."
},
"volume" : {
"type" : "number",
@@ -7315,27 +8929,36 @@ margin-bottom: 20px;
"description" : "Modem input volume"
},
"spanLog2" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent controlling the displayed or processed frequency span."
},
"audioMute" : {
"type" : "integer",
- "description" : "Mute audio (1 if muted else 0)"
+ "description" : "Mute audio (1 if muted else 0)",
+ "minimum" : 0,
+ "maximum" : 1
},
"agc" : {
"type" : "integer",
- "description" : "AGC (1 if AGC active else 0)"
+ "description" : "AGC (1 if AGC active else 0)",
+ "minimum" : 0,
+ "maximum" : 1
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"audioDeviceName" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Name of the audio device to use."
},
"freeDVMode" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Free dv mode setting for Free dv demod."
},
"streamIndex" : {
"type" : "integer",
@@ -7343,27 +8966,38 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"spectrumConfig" : {
+ "description" : "Spectrum-display configuration.",
"$ref" : "#/definitions/GLSpectrum"
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -7377,10 +9011,12 @@ margin-bottom: 20px;
"description" : "power transmitted in channel (dB)"
},
"audioSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Audio sample rate in samples per second."
},
"channelSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Effective sample rate delivered to the channel in samples per second."
}
},
"description" : "FreeDVMod"
@@ -7389,42 +9025,58 @@ margin-bottom: 20px;
"properties" : {
"inputFrequencyOffset" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Channel frequency offset from the device center frequency in Hz."
},
"toneFrequency" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Tone frequency in Hz."
},
"volumeFactor" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Volume factor setting for Free dv mod."
},
"spanLog2" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent controlling the displayed or processed frequency span."
},
"audioMute" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Mute audio output (1 muted, 0 unmuted).",
+ "minimum" : 0,
+ "maximum" : 1
},
"playLoop" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Loop playback at end of file (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"audioDeviceName" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Name of the audio device to use."
},
"freeDVMode" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Free dv mode setting for Free dv mod."
},
"modAFInput" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Audio-frequency modulation input selection."
},
"gaugeInputElseModem" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Gauge input else modem setting for Free dv mod."
},
"streamIndex" : {
"type" : "integer",
@@ -7432,30 +9084,42 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"cwKeyer" : {
+ "description" : "CW keyer configuration.",
"$ref" : "#/definitions/CWKeyerSettings"
},
"spectrumConfig" : {
+ "description" : "Spectrum-display configuration.",
"$ref" : "#/definitions/GLSpectrum"
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -7483,63 +9147,87 @@ margin-bottom: 20px;
"description" : "Channel to display frequency/power for"
},
"fontName" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Font name setting for Freq display."
},
"transparentBackground" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Transparent background setting for Freq display."
},
"displayMode" : {
"type" : "integer",
"description" : "(0 Frequency, 1 Power, 2 Frequency and Power)"
},
"speechEnabled" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable speech (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"frequencyUnits" : {
"type" : "integer",
"description" : "(0 Hz, 1 kHz, 2 MHz, 3 GHz)"
},
"showUnits" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Show units setting for Freq display."
},
"freqDecimalPlaces" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Freq decimal places setting for Freq display."
},
"powerDecimalPlaces" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Power decimal places setting for Freq display."
},
"textcolor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Textcolor setting for Freq display."
},
"dropShadowEnabled" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable drop shadow (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"dropShadowColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Drop shadow color encoded as an integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIFeatureSetIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Feature-set index used by the reverse API peer."
},
"reverseAPIFeatureIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Feature index used by the reverse API peer."
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -7549,7 +9237,9 @@ margin-bottom: 20px;
"properties" : {
"run" : {
"type" : "integer",
- "description" : "Set the plugin running state\n * 0 - idle\n * 1 - run\n"
+ "description" : "Set the plugin running state\n * 0 - idle\n * 1 - run\n",
+ "minimum" : 0,
+ "maximum" : 1
}
},
"description" : "Frequency Scanner actions"
@@ -7571,32 +9261,40 @@ margin-bottom: 20px;
"properties" : {
"frequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Frequency in Hz."
},
"enabled" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enabled for Freq scanner frequency."
},
"notes" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Notes for Freq scanner frequency."
},
"channel" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Channel identifier or configuration."
},
"channelBandwidth" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Channel bandwidth in Hz."
},
"threshold" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Threshold for Freq scanner frequency."
},
"squelch" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Squelch threshold in dB."
}
}
};
defs.FreqScannerReport = {
"properties" : {
"channelSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Effective sample rate delivered to the channel in samples per second."
},
"scanState" : {
"type" : "integer",
@@ -7604,6 +9302,7 @@ margin-bottom: 20px;
},
"channelState" : {
"type" : "array",
+ "description" : "List of channel state.",
"items" : {
"$ref" : "#/definitions/FreqScannerChannelState"
}
@@ -7627,43 +9326,54 @@ margin-bottom: 20px;
},
"threshold" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Threshold setting for Freq scanner."
},
"frequencies" : {
"type" : "array",
+ "description" : "List of frequencies.",
"items" : {
"$ref" : "#/definitions/FreqScannerFrequency"
}
},
"channel" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Channel identifier or configuration."
},
"scanTime" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Scan time setting for Freq scanner."
},
"retransmitTime" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Retransmit time setting for Freq scanner."
},
"tuneTime" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Tune time setting for Freq scanner."
},
"priority" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Priority setting for Freq scanner."
},
"measurement" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Measurement setting for Freq scanner."
},
"mode" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Mode setting for Freq scanner."
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"streamIndex" : {
"type" : "integer",
@@ -7671,24 +9381,34 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -7710,10 +9430,12 @@ margin-bottom: 20px;
"description" : "squelch status (1 if open else 0)"
},
"sampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Sample rate in samples per second."
},
"channelSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Effective sample rate delivered to the channel in samples per second."
}
},
"description" : "FreqTracker"
@@ -7731,7 +9453,8 @@ margin-bottom: 20px;
"description" : "channel RF bandwidth in Hz (floors to next 100 Hz)"
},
"log2Decim" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent of the software decimation factor; the output sample rate is divided by 2^log2Decim."
},
"squelch" : {
"type" : "number",
@@ -7739,13 +9462,16 @@ margin-bottom: 20px;
"description" : "power squelch threshold in decibels"
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"spanLog2" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent controlling the displayed or processed frequency span."
},
"alphaEMA" : {
"type" : "number",
@@ -7782,27 +9508,38 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"spectrumConfig" : {
+ "description" : "Spectrum-display configuration.",
"$ref" : "#/definitions/GLSpectrum"
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -7811,7 +9548,8 @@ margin-bottom: 20px;
defs.Frequency = {
"properties" : {
"frequency" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Frequency in Hz."
}
},
"description" : "A frequency expressed in Hertz (Hz)"
@@ -7819,13 +9557,16 @@ margin-bottom: 20px;
defs.FrequencyBand = {
"properties" : {
"name" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Name."
},
"lowerBound" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Inclusive lower bound of the range."
},
"higherBound" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Inclusive upper bound of the range."
}
},
"description" : "A band of frequencies given its boundaries in Hertz (Hz)"
@@ -7834,18 +9575,22 @@ margin-bottom: 20px;
"properties" : {
"min" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Minimum value of the range."
},
"max" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Maximum value of the range."
},
"step" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Increment between adjacent supported values."
},
"scale" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Scale factor applied to the value."
}
},
"description" : "A frequency range with 64 bit support for min and max"
@@ -7857,32 +9602,39 @@ margin-bottom: 20px;
"description" : "see GLScopeSettings::DisplayMode"
},
"traceIntensity" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Trace intensity for Gl scope."
},
"gridIntensity" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Grid intensity for Gl scope."
},
"time" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Time for Gl scope."
},
"timeOfs" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Time ofs for Gl scope."
},
"traceLenMult" : {
"type" : "integer",
"description" : "Trace length multiplier (multiplies 4800 samples)"
},
"trigPre" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Trig pre for Gl scope."
},
"tracesData" : {
"type" : "array",
+ "description" : "List of traces data.",
"items" : {
"$ref" : "#/definitions/TraceData"
}
},
"triggersData" : {
"type" : "array",
+ "description" : "List of triggers data.",
"items" : {
"$ref" : "#/definitions/TriggerData"
}
@@ -7893,22 +9645,28 @@ margin-bottom: 20px;
defs.GLSpectrum = {
"properties" : {
"fftSize" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "FFT size in samples."
},
"fftOverlap" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "FFT overlap for Gl spectrum."
},
"fftWindow" : {
"type" : "integer",
- "description" : "FFT Window index (FFTWindow::Function):\n * 0 - Bartlett\n * 1 - Blackman-Harris 4 term\n * 2 - Flattop\n * 3 - Hamming\n * 4 - Hanning\n * 5 - Rectangle\n * 6 - Kaiser\n * 7 - Blackman 3 term\n * 8 - Blackman-Harris 7 term\n"
+ "description" : "FFT Window index (FFTWindow::Function):\n * 0 - Bartlett\n * 1 - Blackman-Harris 4 term\n * 2 - Flattop\n * 3 - Hamming\n * 4 - Hanning\n * 5 - Rectangle\n * 6 - Kaiser\n * 7 - Blackman 3 term\n * 8 - Blackman-Harris 7 term\n",
+ "minimum" : 0,
+ "maximum" : 8
},
"refLevel" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Ref level for Gl spectrum."
},
"powerRange" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Power range for Gl spectrum."
},
"fpsPeriodMs" : {
"type" : "integer",
@@ -7916,69 +9674,96 @@ margin-bottom: 20px;
},
"displayWaterfall" : {
"type" : "integer",
- "description" : "boolean"
+ "description" : "boolean",
+ "minimum" : 0,
+ "maximum" : 1
},
"invertedWaterfall" : {
"type" : "integer",
- "description" : "boolean"
+ "description" : "boolean",
+ "minimum" : 0,
+ "maximum" : 1
},
"displayMaxHold" : {
"type" : "integer",
- "description" : "boolean"
+ "description" : "boolean",
+ "minimum" : 0,
+ "maximum" : 1
},
"displayHistogram" : {
"type" : "integer",
- "description" : "boolean"
+ "description" : "boolean",
+ "minimum" : 0,
+ "maximum" : 1
},
"decay" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Decay for Gl spectrum."
},
"displayGrid" : {
"type" : "integer",
- "description" : "boolean"
+ "description" : "boolean",
+ "minimum" : 0,
+ "maximum" : 1
},
"displayGridIntensity" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display grid intensity for Gl spectrum."
},
"decayDivisor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Decay divisor for Gl spectrum."
},
"histogramStroke" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Histogram stroke for Gl spectrum."
},
"displayCurrent" : {
"type" : "integer",
- "description" : "boolean"
+ "description" : "boolean",
+ "minimum" : 0,
+ "maximum" : 1
},
"displayTraceIntensity" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display trace intensity for Gl spectrum."
},
"waterfallShare" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Waterfall share for Gl spectrum."
},
"averagingMode" : {
"type" : "integer",
"description" : "See GLSpectrumGUI::AveragingMode"
},
"averagingValue" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Averaging value for Gl spectrum."
},
"linear" : {
"type" : "integer",
- "description" : "boolean"
+ "description" : "boolean",
+ "minimum" : 0,
+ "maximum" : 1
},
"ssb" : {
"type" : "integer",
- "description" : "boolean"
+ "description" : "boolean",
+ "minimum" : 0,
+ "maximum" : 1
},
"usb" : {
"type" : "integer",
- "description" : "boolean"
+ "description" : "boolean",
+ "minimum" : 0,
+ "maximum" : 1
},
"wsSpectrum" : {
"type" : "integer",
- "description" : "Boolean - Start or stop websocket server\n * 0 - Stop server\n * 1 - Start server\n"
+ "description" : "Boolean - Start or stop websocket server\n * 0 - Stop server\n * 1 - Start server\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"wsSpectrumAddress" : {
"type" : "string",
@@ -7990,36 +9775,46 @@ margin-bottom: 20px;
},
"markersDisplay" : {
"type" : "integer",
- "description" : "Display markers (SpectrumSettings::MarkersDisplay)\n * 0 - Mome\n * 1 - Spectrum markers (histogram and waterfall)\n * 2 - Spectrum annotation markers\n"
+ "description" : "Display markers (SpectrumSettings::MarkersDisplay)\n * 0 - Mome\n * 1 - Spectrum markers (histogram and waterfall)\n * 2 - Spectrum annotation markers\n",
+ "minimum" : 0,
+ "maximum" : 2
},
"useCalibration" : {
"type" : "integer",
- "description" : "boolean"
+ "description" : "boolean",
+ "minimum" : 0,
+ "maximum" : 1
},
"calibrationInterpMode" : {
"type" : "integer",
- "description" : "Interpolation scheme between points SpectrumSettings::CalibrationInterpolationMode\n * 0 - Linear\n * 1 - Log (dB linear)\n"
+ "description" : "Interpolation scheme between points SpectrumSettings::CalibrationInterpolationMode\n * 0 - Linear\n * 1 - Log (dB linear)\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"histogramMarkers" : {
"type" : "array",
+ "description" : "List of histogram markers.",
"items" : {
"$ref" : "#/definitions/SpectrumHistogramMarker"
}
},
"waterfallMarkers" : {
"type" : "array",
+ "description" : "List of waterfall markers.",
"items" : {
"$ref" : "#/definitions/SpectrumWaterfallMarker"
}
},
"annotationMarkers" : {
"type" : "array",
+ "description" : "List of annotation markers.",
"items" : {
"$ref" : "#/definitions/SpectrumAnnotationMarker"
}
},
"calibrationPoints" : {
"type" : "array",
+ "description" : "List of calibration points.",
"items" : {
"$ref" : "#/definitions/SpectrumCalibrationPoint"
}
@@ -8031,7 +9826,9 @@ margin-bottom: 20px;
"properties" : {
"run" : {
"type" : "integer",
- "description" : "Set the plugin running state\n * 0 - idle\n * 1 - run\n"
+ "description" : "Set the plugin running state\n * 0 - idle\n * 1 - run\n",
+ "minimum" : 0,
+ "maximum" : 1
}
},
"description" : "GS-232 Controller actions"
@@ -8040,7 +9837,9 @@ margin-bottom: 20px;
"properties" : {
"runningState" : {
"type" : "integer",
- "description" : "Running state\n * 0 - not started\n * 1 - idle\n * 2 - running\n * 3 - error\n"
+ "description" : "Running state\n * 0 - not started\n * 1 - idle\n * 2 - running\n * 3 - error\n",
+ "minimum" : 0,
+ "maximum" : 3
},
"sources" : {
"type" : "array",
@@ -8172,28 +9971,39 @@ margin-bottom: 20px;
"description" : "Input controller sensitivity"
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIFeatureSetIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Feature-set index used by the reverse API peer."
},
"reverseAPIFeatureIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Feature index used by the reverse API peer."
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -8202,7 +10012,8 @@ margin-bottom: 20px;
defs.Gain = {
"properties" : {
"gainCB" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Gain in centibels (tenths of a decibel)."
}
},
"description" : "A gain expressed in centi-Bels (tenths of dB)"
@@ -8210,69 +10021,100 @@ margin-bottom: 20px;
defs.HackRFInputSettings = {
"properties" : {
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"centerFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Device center frequency in Hz."
},
"LOppmTenths" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Local-oscillator correction in tenths of a part per million."
},
"bandwidth" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Bandwidth in Hz."
},
"lnaGain" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Low-noise-amplifier gain setting."
},
"vgaGain" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Variable-gain-amplifier gain setting."
},
"log2Decim" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent of the software decimation factor; the output sample rate is divided by 2^log2Decim."
},
"fcPos" : {
"type" : "integer",
"description" : "0=Infra 1=Supra 2=Center"
},
"devSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device I/Q sample rate in samples per second before software decimation or interpolation."
},
"biasT" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable antenna bias power (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"lnaExt" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "LNA ext setting for Hack RF input."
},
"dcBlock" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable DSP DC-offset correction (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"iqCorrection" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable I/Q imbalance correction (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"transverterMode" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable transverter frequency translation (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"transverterDeltaFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Frequency translation applied in transverter mode in Hz."
},
"iqOrder" : {
"type" : "integer",
- "description" : "IQ samples order\n * 0 - Q then I (swapped)\n * 1 - I then Q (straight)\n"
+ "description" : "IQ samples order\n * 0 - Q then I (swapped)\n * 1 - I then Q (straight)\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
}
},
"description" : "HackRF"
@@ -8280,56 +10122,78 @@ margin-bottom: 20px;
defs.HackRFOutputSettings = {
"properties" : {
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"centerFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Device center frequency in Hz."
},
"LOppmTenths" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Local-oscillator correction in tenths of a part per million."
},
"bandwidth" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Bandwidth in Hz."
},
"vgaGain" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Variable-gain-amplifier gain setting."
},
"log2Interp" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent of the software interpolation factor; the output sample rate is multiplied by 2^log2Interp."
},
"fcPos" : {
"type" : "integer",
"description" : "0=Infra 1=Supra 2=Center"
},
"devSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device I/Q sample rate in samples per second before software decimation or interpolation."
},
"biasT" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable antenna bias power (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"lnaExt" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "LNA ext setting for Hack RF output."
},
"transverterMode" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable transverter frequency translation (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"transverterDeltaFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Frequency translation applied in transverter mode in Hz."
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
}
},
"description" : "HackRF"
@@ -8342,7 +10206,8 @@ margin-bottom: 20px;
"description" : "power received in channel (dB)"
},
"channelSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Effective sample rate delivered to the channel in samples per second."
}
},
"description" : "HeatMap"
@@ -8351,7 +10216,8 @@ margin-bottom: 20px;
"properties" : {
"inputFrequencyOffset" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Channel frequency offset from the device center frequency in Hz."
},
"rfBandwidth" : {
"type" : "number",
@@ -8360,35 +10226,44 @@ margin-bottom: 20px;
},
"minPower" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Min power setting for Heat map."
},
"maxPower" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Max power setting for Heat map."
},
"colorMapName" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Color map name setting for Heat map."
},
"mode" : {
"type" : "integer",
- "description" : "(0 - None, 1 - Average, 2 - Max, 3 - Min, 4 - Pulse Average)"
+ "description" : "(0 - None, 1 - Average, 2 - Max, 3 - Min, 4 - Pulse Average)",
+ "minimum" : 0,
+ "maximum" : 4
},
"pulseThreshold" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Pulse threshold setting for Heat map."
},
"averagePeriodUS" : {
"type" : "integer",
"description" : "Averaging period in microseconds"
},
"sampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Sample rate in samples per second."
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"streamIndex" : {
"type" : "integer",
@@ -8396,27 +10271,38 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"scopeConfig" : {
+ "description" : "Oscilloscope-display configuration.",
"$ref" : "#/definitions/GLScope"
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -8426,7 +10312,9 @@ margin-bottom: 20px;
"properties" : {
"tx" : {
"type" : "integer",
- "description" : "Initialize a transmission cycle\n * 0 - Do nothing\n * 1 - Start transmission cycle\n"
+ "description" : "Initialize a transmission cycle\n * 0 - Do nothing\n * 1 - Start transmission cycle\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"data" : {
"type" : "string",
@@ -8443,7 +10331,8 @@ margin-bottom: 20px;
"description" : "power transmitted in channel (dB)"
},
"channelSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Effective sample rate delivered to the channel in samples per second."
}
},
"description" : "IEEE_802_15_4_Mod"
@@ -8452,34 +10341,46 @@ margin-bottom: 20px;
"properties" : {
"inputFrequencyOffset" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Channel frequency offset from the device center frequency in Hz."
},
"modulation" : {
"type" : "integer",
- "description" : "Modulation type\n * 0 - BPSK\n * 1 - OQPSK\n"
+ "description" : "Modulation type\n * 0 - BPSK\n * 1 - OQPSK\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"bitRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Bit rate setting for Ieee 802 15 4 mod."
},
"subGHzBand" : {
"type" : "integer",
- "description" : "Boolean value\n * 0 - Over 1 GHz standard\n * 1 - Under 1 GHz standard\n"
+ "description" : "Boolean value\n * 0 - Over 1 GHz standard\n * 1 - Under 1 GHz standard\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"rfBandwidth" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "RF bandwidth in Hz."
},
"gain" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Gain setting; units and available values depend on the device or plugin."
},
"channelMute" : {
"type" : "integer",
- "description" : "* 0 - Effective transmission * 1 - Transmission is muted\n"
+ "description" : "* 0 - Effective transmission * 1 - Transmission is muted\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"repeat" : {
"type" : "integer",
- "description" : "Whether to repeated transmit the frame (1 for yes, 0 for no)."
+ "description" : "Whether to repeated transmit the frame (1 for yes, 0 for no).",
+ "minimum" : 0,
+ "maximum" : 1
},
"repeatDelay" : {
"type" : "number",
@@ -8491,41 +10392,54 @@ margin-bottom: 20px;
"description" : "Number of times to repeat the frame (-1 for infinite)."
},
"rampUpBits" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Ramp up bits setting for Ieee 802 15 4 mod."
},
"rampDownBits" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Ramp down bits setting for Ieee 802 15 4 mod."
},
"rampRange" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Ramp range setting for Ieee 802 15 4 mod."
},
"modulateWhileRamping" : {
"type" : "integer",
- "description" : "Boolean value\n * 0 - do not modulate in ramping phase\n * 1 - modulate in ramping phase\n"
+ "description" : "Boolean value\n * 0 - do not modulate in ramping phase\n * 1 - modulate in ramping phase\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"lpfTaps" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Number of low-pass FIR filter taps."
},
"bbNoise" : {
"type" : "integer",
- "description" : "Boolean value\n * 0 - Do not add gaussian noise in baseband\n * 1 - Add gaussian noise in baseband\n"
+ "description" : "Boolean value\n * 0 - Do not add gaussian noise in baseband\n * 1 - Add gaussian noise in baseband\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"writeToFile" : {
"type" : "integer",
- "description" : "Boolean value\n * 0 - Do not write frames to .csv file\n * 1 - Write frames to .csv file\n"
+ "description" : "Boolean value\n * 0 - Do not write frames to .csv file\n * 1 - Write frames to .csv file\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"spectrumRate" : {
- "type" : "integer"
+ "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"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"streamIndex" : {
"type" : "integer",
@@ -8533,23 +10447,33 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"scramble" : {
"type" : "integer",
- "description" : "Boolean value\n * 0 - Do not scramble data\n * 1 - Scramble data\n"
+ "description" : "Boolean value\n * 0 - Do not scramble data\n * 1 - Scramble data\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"polynomial" : {
"type" : "integer",
@@ -8557,7 +10481,9 @@ margin-bottom: 20px;
},
"pulseShaping" : {
"type" : "integer",
- "description" : "Pulse shaping filter\n * 0 - Root Cosime\n * 1 - Sine\n"
+ "description" : "Pulse shaping filter\n * 0 - Root Cosime\n * 1 - Sine\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"beta" : {
"type" : "number",
@@ -8565,15 +10491,20 @@ margin-bottom: 20px;
"description" : "Pulse shaping filter beta factor"
},
"symbolSpan" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Symbol span setting for Ieee 802 15 4 mod."
},
"udpEnabled" : {
"type" : "integer",
- "description" : "Enable forwarding of frames via UDP"
+ "description" : "Enable forwarding of frames via UDP",
+ "minimum" : 0,
+ "maximum" : 1
},
"udpBytesFormat" : {
"type" : "integer",
- "description" : "Payload format\n * 0 - Blank separated string representation of hex bytes i.e. 00 02 0a\n * 1 - Raw bytes\n"
+ "description" : "Payload format\n * 0 - Blank separated string representation of hex bytes i.e. 00 02 0a\n * 1 - Raw bytes\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"udpAddress" : {
"type" : "string",
@@ -8581,12 +10512,16 @@ margin-bottom: 20px;
},
"udpPort" : {
"type" : "integer",
- "description" : "UDP port to listen for frames to transmit on"
+ "description" : "UDP port to listen for frames to transmit on",
+ "minimum" : 1,
+ "maximum" : 65535
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -8600,10 +10535,12 @@ margin-bottom: 20px;
"description" : "power received in channel (dB)"
},
"channelSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Effective sample rate delivered to the channel in samples per second."
},
"ident" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Reported ident."
},
"deviation" : {
"type" : "number",
@@ -8637,73 +10574,95 @@ margin-bottom: 20px;
"properties" : {
"inputFrequencyOffset" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Channel frequency offset from the device center frequency in Hz."
},
"rfBandwidth" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "RF bandwidth in Hz."
},
"mode" : {
"type" : "integer",
"description" : "(0 for LOC, 1 for G/S)"
},
"frequencyIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Selected frequency index."
},
"squelch" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Squelch threshold in dB."
},
"volume" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Audio volume multiplier."
},
"audioMute" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Mute audio output (1 muted, 0 unmuted).",
+ "minimum" : 0,
+ "maximum" : 1
},
"average" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Average setting for Ils demod."
},
"ddmUnits" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Ddm units setting for Ils demod."
},
"identThreshold" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Ident threshold setting for Ils demod."
},
"ident" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Ident setting for Ils demod."
},
"runway" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Runway setting for Ils demod."
},
"trueBearing" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "True bearing setting for Ils demod."
},
"latitude" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Latitude in degrees, positive north."
},
"longitude" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Longitude in degrees, positive east."
},
"elevation" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Elevation setting for Ils demod."
},
"glidePath" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Glide path setting for Ils demod."
},
"refHeight" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Ref height setting for Ils demod."
},
"courseWidth" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Course width setting for Ils demod."
},
"udpEnabled" : {
"type" : "integer",
- "description" : "Whether to forward DDM to specified UDP port"
+ "description" : "Whether to forward DDM to specified UDP port",
+ "minimum" : 0,
+ "maximum" : 1
},
"udpAddress" : {
"type" : "string",
@@ -8711,19 +10670,27 @@ margin-bottom: 20px;
},
"udpPort" : {
"type" : "integer",
- "description" : "UDP port to forward DDM to"
+ "description" : "UDP port to forward DDM to",
+ "minimum" : 1,
+ "maximum" : 65535
},
"logFilename" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Log file name or path."
},
"logEnabled" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable logging to the configured file (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"streamIndex" : {
"type" : "integer",
@@ -8731,27 +10698,38 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"scopeConfig" : {
+ "description" : "Oscilloscope-display configuration.",
"$ref" : "#/definitions/GLScope"
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -8765,7 +10743,8 @@ margin-bottom: 20px;
"description" : "power received in channel (dB)"
},
"channelSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Effective sample rate delivered to the channel in samples per second."
}
},
"description" : "InmarsatDemod"
@@ -8774,23 +10753,29 @@ margin-bottom: 20px;
"properties" : {
"inputFrequencyOffset" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Channel frequency offset from the device center frequency in Hz."
},
"rfBandwidth" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "RF bandwidth in Hz."
},
"rrcRolloff" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Rrc rolloff setting for Inmarsat demod."
},
"pllBandwidth" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Pll bandwidth in Hz."
},
"udpEnabled" : {
"type" : "integer",
- "description" : "Whether to forward received messages to specified UDP port"
+ "description" : "Whether to forward received messages to specified UDP port",
+ "minimum" : 0,
+ "maximum" : 1
},
"udpAddress" : {
"type" : "string",
@@ -8798,26 +10783,37 @@ margin-bottom: 20px;
},
"udpPort" : {
"type" : "integer",
- "description" : "UDP port to forward received messages to"
+ "description" : "UDP port to forward received messages to",
+ "minimum" : 1,
+ "maximum" : 65535
},
"udpFormat" : {
"type" : "integer",
"description" : "0 for binary, 1 for NMEA"
},
"logFilename" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Log file name or path."
},
"logEnabled" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable logging to the configured file (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"useFileTime" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable file time (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"streamIndex" : {
"type" : "integer",
@@ -8825,27 +10821,38 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"scopeConfig" : {
+ "description" : "Oscilloscope-display configuration.",
"$ref" : "#/definitions/GLScope"
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -8985,16 +10992,20 @@ margin-bottom: 20px;
"description" : "see InterferometerSettings::CorrelationType"
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"log2Decim" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent of the software decimation factor; the output sample rate is divided by 2^log2Decim."
},
"filterChainHash" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Identifier of the selected half-band filter chain."
},
"phase" : {
"type" : "integer",
@@ -9010,34 +11021,48 @@ margin-bottom: 20px;
},
"play" : {
"type" : "integer",
- "description" : "Run correlated IQ samples transfer\n * 0 - stop\n * 1 - run\n"
+ "description" : "Run correlated IQ samples transfer\n * 0 - stop\n * 1 - run\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"spectrumConfig" : {
+ "description" : "Spectrum-display configuration.",
"$ref" : "#/definitions/GLSpectrum"
},
"scopeConfig" : {
+ "description" : "Oscilloscope-display configuration.",
"$ref" : "#/definitions/GLScope"
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -9046,28 +11071,39 @@ margin-bottom: 20px;
defs.JogdialControllerSettings = {
"properties" : {
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API\n * 1 - yes\n * 0 - no\n"
+ "description" : "Synchronize with reverse API\n * 1 - yes\n * 0 - no\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIFeatureSetIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Feature-set index used by the reverse API peer."
},
"reverseAPIFeatureIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Feature index used by the reverse API peer."
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -9081,15 +11117,22 @@ margin-bottom: 20px;
},
"latitude" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Latitude in degrees, positive north.",
+ "minimum" : -90,
+ "maximum" : 90
},
"longitude" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Longitude in degrees, positive east.",
+ "minimum" : -180,
+ "maximum" : 180
},
"altitude" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Altitude above mean sea level."
}
},
"description" : "KiwiSDR"
@@ -9097,21 +11140,29 @@ margin-bottom: 20px;
defs.KiwiSDRSettings = {
"properties" : {
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"gain" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Gain setting; units and available values depend on the device or plugin."
},
"useAGC" : {
"type" : "integer",
- "description" : "AGC active (1 for yes, 0 for no)"
+ "description" : "AGC active (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"dcBlock" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable DSP DC-offset correction (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"centerFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Device center frequency in Hz."
},
"serverAddress" : {
"type" : "string",
@@ -9119,16 +11170,23 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
}
},
"description" : "KiwiSDR"
@@ -9137,7 +11195,9 @@ margin-bottom: 20px;
"properties" : {
"selectChannel" : {
"type" : "integer",
- "description" : "Select channel\n * 0 - Rx\n * 1 - Tx\n"
+ "description" : "Select channel\n * 0 - Rx\n * 1 - Tx\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"deviceSetIndex" : {
"type" : "integer",
@@ -9145,7 +11205,9 @@ margin-bottom: 20px;
},
"switchChannel" : {
"type" : "integer",
- "description" : "Switch on or off\n * 0 - Off\n * 1 - On\n"
+ "description" : "Switch on or off\n * 0 - Off\n * 1 - On\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"getState" : {
"type" : "integer",
@@ -9153,19 +11215,27 @@ margin-bottom: 20px;
},
"fromToSettings" : {
"type" : "integer",
- "description" : "Move from/to settings to/from device\n * 0 - From device to settings. The toGUI button in GUI mode\n * 1 - From settings to device. The Apply button in GUI mode\n"
+ "description" : "Move from/to settings to/from device\n * 0 - From device to settings. The toGUI button in GUI mode\n * 1 - From settings to device. The Apply button in GUI mode\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"openCloseDevice" : {
"type" : "integer",
- "description" : "Open or close device\n * 0 - Close device\n * 1 - Open device\n"
+ "description" : "Open or close device\n * 0 - Close device\n * 1 - Open device\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"setRx" : {
"type" : "integer",
- "description" : "Set Rx om or off\n * 0 - Rx off\n * 1 - Rx on\n"
+ "description" : "Set Rx om or off\n * 0 - Rx off\n * 1 - Rx on\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"setTx" : {
"type" : "integer",
- "description" : "Set Tx om or off\n * 0 - Tx off\n * 1 - Tx on\n"
+ "description" : "Set Tx om or off\n * 0 - Tx off\n * 1 - Tx on\n",
+ "minimum" : 0,
+ "maximum" : 1
}
},
"description" : "LimeRFE"
@@ -9200,11 +11270,15 @@ margin-bottom: 20px;
"properties" : {
"rxOn" : {
"type" : "integer",
- "description" : "Boolean 1 if Rx is active else 0"
+ "description" : "Boolean 1 if Rx is active else 0",
+ "minimum" : 0,
+ "maximum" : 1
},
"txOn" : {
"type" : "integer",
- "description" : "Boolean 1 if Tx is active else 0"
+ "description" : "Boolean 1 if Tx is active else 0",
+ "minimum" : 0,
+ "maximum" : 1
},
"forwardPower" : {
"type" : "integer",
@@ -9220,10 +11294,12 @@ margin-bottom: 20px;
defs.LimeRFESettings = {
"properties" : {
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"devicePath" : {
"type" : "string",
@@ -9231,11 +11307,15 @@ margin-bottom: 20px;
},
"rxChannels" : {
"type" : "integer",
- "description" : "Rx channels group (LimeRFEController::ChannelGroups):\n * 0 - Wideband\n * 1 - HAM\n * 2 - cellular\n"
+ "description" : "Rx channels group (LimeRFEController::ChannelGroups):\n * 0 - Wideband\n * 1 - HAM\n * 2 - cellular\n",
+ "minimum" : 0,
+ "maximum" : 2
},
"rxWidebandChannel" : {
"type" : "integer",
- "description" : "Rx wideband channel selection (LimeRFEController::WidebandChannel)\n * 0 - Low: 1 - 1000 MHz\n * 1 - High: 1 - 4 GHz\n"
+ "description" : "Rx wideband channel selection (LimeRFEController::WidebandChannel)\n * 0 - Low: 1 - 1000 MHz\n * 1 - High: 1 - 4 GHz\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"rxHAMChannel" : {
"type" : "integer",
@@ -9247,7 +11327,9 @@ margin-bottom: 20px;
},
"rxPort" : {
"type" : "integer",
- "description" : "Rx port selected (LimeRFEController::RxPort)\n * 0 - J3\n * 1 - J5\n"
+ "description" : "Rx port selected (LimeRFEController::RxPort)\n * 0 - J3\n * 1 - J5\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"attenuationFactor" : {
"type" : "integer",
@@ -9259,11 +11341,15 @@ margin-bottom: 20px;
},
"txChannels" : {
"type" : "integer",
- "description" : "Tx channels group (LimeRFEController::ChannelGroups)\n * 0 - Wideband\n * 1 - HAM\n * 2 - cellular\n"
+ "description" : "Tx channels group (LimeRFEController::ChannelGroups)\n * 0 - Wideband\n * 1 - HAM\n * 2 - cellular\n",
+ "minimum" : 0,
+ "maximum" : 2
},
"txWidebandChannel" : {
"type" : "integer",
- "description" : "Tx wideband channel selection (LimeRFEController::WidebandChannel)\n * 0 - Low: 1 - 1000 MHz\n * 1 - High: 1 - 4 GHz\n"
+ "description" : "Tx wideband channel selection (LimeRFEController::WidebandChannel)\n * 0 - Low: 1 - 1000 MHz\n * 1 - High: 1 - 4 GHz\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"txHAMChannel" : {
"type" : "integer",
@@ -9275,37 +11361,54 @@ margin-bottom: 20px;
},
"txPort" : {
"type" : "integer",
- "description" : "Tx port selected (LimeRFEController::TxPort)\n * 0 - J3\n * 1 - J4\n * 2 - J5\n"
+ "description" : "Tx port selected (LimeRFEController::TxPort)\n * 0 - J3\n * 1 - J4\n * 2 - J5\n",
+ "minimum" : 0,
+ "maximum" : 2
},
"swrEnable" : {
"type" : "integer",
- "description" : "Boolean if SWR measurements are enabled else 0"
+ "description" : "Boolean if SWR measurements are enabled else 0",
+ "minimum" : 0,
+ "maximum" : 1
},
"swrSource" : {
"type" : "integer",
- "description" : "SWR measurement source (LimeRFEController::SWRSource)\n * 0 - External\n * 1 - Cellular\n"
+ "description" : "SWR measurement source (LimeRFEController::SWRSource)\n * 0 - External\n * 1 - Cellular\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"txRxDriven" : {
"type" : "integer",
- "description" : "Boolean 1 if Tx is copy of Rx else 0"
+ "description" : "Boolean 1 if Tx is copy of Rx else 0",
+ "minimum" : 0,
+ "maximum" : 1
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIFeatureSetIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Feature-set index used by the reverse API peer."
},
"reverseAPIFeatureIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Feature index used by the reverse API peer."
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -9319,26 +11422,34 @@ margin-bottom: 20px;
},
"streamActive" : {
"type" : "integer",
- "description" : "1 if active else 0"
+ "description" : "1 if active else 0",
+ "minimum" : 0,
+ "maximum" : 1
},
"fifoSize" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "FIFO capacity in samples."
},
"fifoFill" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Current FIFO fill level."
},
"underrunCount" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Number of stream underrun events."
},
"overrunCount" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Number of stream overrun events."
},
"droppedPacketsCount" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Number of dropped packets."
},
"linkRate" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Measured streaming link rate."
},
"hwTimestamp" : {
"type" : "integer",
@@ -9347,15 +11458,18 @@ margin-bottom: 20px;
},
"temperature" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Reported device temperature."
},
"gpioDir" : {
"type" : "integer",
- "format" : "int8"
+ "format" : "int8",
+ "description" : "GPIO direction bit mask, with one bit per pin."
},
"gpioPins" : {
"type" : "integer",
- "format" : "int8"
+ "format" : "int8",
+ "description" : "GPIO pin-state bit mask, with one bit per pin."
}
},
"description" : "LimeSDR"
@@ -9363,100 +11477,146 @@ margin-bottom: 20px;
defs.LimeSdrInputSettings = {
"properties" : {
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"centerFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Device center frequency in Hz."
},
"devSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device I/Q sample rate in samples per second before software decimation or interpolation."
},
"log2HardDecim" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent of the hardware decimation factor."
},
"dcBlock" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable DSP DC-offset correction (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"splitFreq" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Split freq setting for Lime sdr input."
},
"iqCorrection" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable I/Q imbalance correction (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"log2SoftDecim" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent of the software decimation factor."
},
"lpfBW" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Analog low-pass filter bandwidth in Hz."
},
"lpfFIREnable" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable the digital FIR low-pass filter (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"lpfFIRBW" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Digital FIR low-pass filter bandwidth in Hz."
},
"gain" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Gain setting; units and available values depend on the device or plugin."
},
"ncoEnable" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable the numerically controlled oscillator (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"ncoFrequency" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Numerically controlled oscillator frequency in Hz."
},
"antennaPath" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Selected RF antenna path."
},
"gainMode" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Gain-control mode selection."
},
"lnaGain" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Low-noise-amplifier gain setting."
},
"tiaGain" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TIA gain setting for Lime sdr input."
},
"pgaGain" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "PGA gain setting for Lime sdr input."
},
"extClock" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Use an external reference clock (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"extClockFreq" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "External reference-clock frequency in Hz."
},
"transverterMode" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable transverter frequency translation (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"transverterDeltaFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Frequency translation applied in transverter mode in Hz."
},
"iqOrder" : {
"type" : "integer",
- "description" : "IQ samples order\n * 0 - Q then I (swapped)\n * 1 - I then Q (straight)\n"
+ "description" : "IQ samples order\n * 0 - Q then I (swapped)\n * 1 - I then Q (straight)\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"gpioDir" : {
"type" : "integer",
- "format" : "int8"
+ "format" : "int8",
+ "description" : "GPIO direction bit mask, with one bit per pin."
},
"gpioPins" : {
"type" : "integer",
- "format" : "int8"
+ "format" : "int8",
+ "description" : "GPIO pin-state bit mask, with one bit per pin."
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
}
},
"description" : "LimeSDR"
@@ -9470,15 +11630,18 @@ margin-bottom: 20px;
},
"temperature" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Reported device temperature."
},
"gpioDir" : {
"type" : "integer",
- "format" : "int8"
+ "format" : "int8",
+ "description" : "GPIO direction bit mask, with one bit per pin."
},
"gpioPins" : {
"type" : "integer",
- "format" : "int8"
+ "format" : "int8",
+ "description" : "GPIO pin-state bit mask, with one bit per pin."
},
"successRx" : {
"type" : "integer",
@@ -9489,23 +11652,29 @@ margin-bottom: 20px;
"description" : "1 if active else 0"
},
"fifoSizeRx" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Reported fifo size receive."
},
"fifoFillRx" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Current receive FIFO fill level."
},
"underrunCountRx" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Reported underrun count receive."
},
"overrunCountRx" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Reported overrun count receive."
},
"droppedPacketsCountRx" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Reported dropped packets count receive."
},
"linkRateRx" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Reported link rate receive."
},
"successTx" : {
"type" : "integer",
@@ -9516,23 +11685,29 @@ margin-bottom: 20px;
"description" : "1 if active else 0"
},
"fifoSizeTx" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Reported fifo size transmit."
},
"fifoFillTx" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Current transmit FIFO fill level."
},
"underrunCountTx" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Reported underrun count transmit."
},
"overrunCountTx" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Reported overrun count transmit."
},
"droppedPacketsCountTx" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Reported dropped packets count transmit."
},
"linkRateTx" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Reported link rate transmit."
}
},
"description" : "LimeSDR"
@@ -9540,10 +11715,12 @@ margin-bottom: 20px;
defs.LimeSdrMIMOSettings = {
"properties" : {
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"devSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device I/Q sample rate in samples per second before software decimation or interpolation."
},
"gpioDir" : {
"type" : "integer",
@@ -9557,7 +11734,9 @@ margin-bottom: 20px;
},
"extClock" : {
"type" : "integer",
- "description" : "Boolean 1 if external clock source else 0"
+ "description" : "Boolean 1 if external clock source else 0",
+ "minimum" : 0,
+ "maximum" : 1
},
"extClockFreq" : {
"type" : "integer",
@@ -9565,50 +11744,71 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Boolean"
+ "description" : "Boolean",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"rxCenterFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Receive center frequency in Hz."
},
"log2HardDecim" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent of the hardware decimation factor."
},
"log2SoftDecim" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent of the software decimation factor."
},
"dcBlock" : {
"type" : "integer",
- "description" : "Boolean"
+ "description" : "Boolean",
+ "minimum" : 0,
+ "maximum" : 1
},
"iqCorrection" : {
"type" : "integer",
- "description" : "Boolean"
+ "description" : "Boolean",
+ "minimum" : 0,
+ "maximum" : 1
},
"rxTransverterMode" : {
"type" : "integer",
- "description" : "Boolean"
+ "description" : "Boolean",
+ "minimum" : 0,
+ "maximum" : 1
},
"rxTransverterDeltaFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Receive frequency translation applied in transverter mode in Hz."
},
"iqOrder" : {
"type" : "integer",
- "description" : "IQ samples order\n * 0 - Q then I (swapped)\n * 1 - I then Q (straight)\n"
+ "description" : "IQ samples order\n * 0 - Q then I (swapped)\n * 1 - I then Q (straight)\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"ncoEnableRx" : {
"type" : "integer",
- "description" : "Boolean 1 to enable TSP NCO and mixing else 0"
+ "description" : "Boolean 1 to enable TSP NCO and mixing else 0",
+ "minimum" : 0,
+ "maximum" : 1
},
"ncoFrequencyRx" : {
"type" : "integer",
@@ -9621,7 +11821,9 @@ margin-bottom: 20px;
},
"lpfFIREnableRx0" : {
"type" : "integer",
- "description" : "Boolean 1 to enable Rx[0] LMS digital lowpass FIR filters else 0"
+ "description" : "Boolean 1 to enable Rx[0] LMS digital lowpass FIR filters else 0",
+ "minimum" : 0,
+ "maximum" : 1
},
"lpfFIRBWRx0" : {
"type" : "number",
@@ -9634,11 +11836,15 @@ margin-bottom: 20px;
},
"antennaPathRx0" : {
"type" : "integer",
- "description" : "Rx[0] Antenna connection (PathRxRFE):\n * 0 - None\n * 1 - LNA High\n * 2 - LNA low\n * 3 - LNA Wide\n * 4 - LB TX1\n * 5 - LB TX2\n"
+ "description" : "Rx[0] Antenna connection (PathRxRFE):\n * 0 - None\n * 1 - LNA High\n * 2 - LNA low\n * 3 - LNA Wide\n * 4 - LB TX1\n * 5 - LB TX2\n",
+ "minimum" : 0,
+ "maximum" : 5
},
"gainModeRx0" : {
"type" : "integer",
- "description" : "Rx[0] Gain mode:\n * 0 - auto\n * 1 - manual\n"
+ "description" : "Rx[0] Gain mode:\n * 0 - auto\n * 1 - manual\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"lnaGainRx0" : {
"type" : "integer",
@@ -9659,7 +11865,9 @@ margin-bottom: 20px;
},
"lpfFIREnableRx1" : {
"type" : "integer",
- "description" : "Boolean 1 to enable Rx[1] LMS digital lowpass FIR filters else 0"
+ "description" : "Boolean 1 to enable Rx[1] LMS digital lowpass FIR filters else 0",
+ "minimum" : 0,
+ "maximum" : 1
},
"lpfFIRBWRx1" : {
"type" : "number",
@@ -9672,11 +11880,15 @@ margin-bottom: 20px;
},
"antennaPathRx1" : {
"type" : "integer",
- "description" : "Rx[1] Antenna connection (PathRxRFE):\n * 0 - None\n * 1 - LNA High\n * 2 - LNA low\n * 3 - LNA Wide\n * 4 - LB TX1\n * 5 - LB TX2\n"
+ "description" : "Rx[1] Antenna connection (PathRxRFE):\n * 0 - None\n * 1 - LNA High\n * 2 - LNA low\n * 3 - LNA Wide\n * 4 - LB TX1\n * 5 - LB TX2\n",
+ "minimum" : 0,
+ "maximum" : 5
},
"gainModeRx1" : {
"type" : "integer",
- "description" : "Rx[1] Gain mode:\n * 0 - auto\n * 1 - manual\n"
+ "description" : "Rx[1] Gain mode:\n * 0 - auto\n * 1 - manual\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"lnaGainRx1" : {
"type" : "integer",
@@ -9692,25 +11904,33 @@ margin-bottom: 20px;
},
"txCenterFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Transmit center frequency in Hz."
},
"log2HardInterp" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent of the hardware interpolation factor."
},
"log2SoftInterp" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent of the software interpolation factor."
},
"txTransverterMode" : {
"type" : "integer",
- "description" : "Boolean"
+ "description" : "Boolean",
+ "minimum" : 0,
+ "maximum" : 1
},
"txTransverterDeltaFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Transmit frequency translation applied in transverter mode in Hz."
},
"ncoEnableTx" : {
"type" : "integer",
- "description" : "Boolean 1 to enable TSP NCO and mixing else 0"
+ "description" : "Boolean 1 to enable TSP NCO and mixing else 0",
+ "minimum" : 0,
+ "maximum" : 1
},
"ncoFrequencyTx" : {
"type" : "integer",
@@ -9723,7 +11943,9 @@ margin-bottom: 20px;
},
"lpfFIREnableTx0" : {
"type" : "integer",
- "description" : "Boolean 1 to enable Tx[0] LMS digital lowpass FIR filters else 0"
+ "description" : "Boolean 1 to enable Tx[0] LMS digital lowpass FIR filters else 0",
+ "minimum" : 0,
+ "maximum" : 1
},
"lpfFIRBWTx0" : {
"type" : "number",
@@ -9736,7 +11958,9 @@ margin-bottom: 20px;
},
"antennaPathTx0" : {
"type" : "integer",
- "description" : "Tx[0] Antenna connection (PathTxRFE):\n * 0 - None\n * 1 - RF connector 1\n * 2 - RF connector 2\n"
+ "description" : "Tx[0] Antenna connection (PathTxRFE):\n * 0 - None\n * 1 - RF connector 1\n * 2 - RF connector 2\n",
+ "minimum" : 0,
+ "maximum" : 2
},
"lpfBWTx1" : {
"type" : "number",
@@ -9745,7 +11969,9 @@ margin-bottom: 20px;
},
"lpfFIREnableTx1" : {
"type" : "integer",
- "description" : "Boolean 1 to enable Tx[1] LMS digital lowpass FIR filters else 0"
+ "description" : "Boolean 1 to enable Tx[1] LMS digital lowpass FIR filters else 0",
+ "minimum" : 0,
+ "maximum" : 1
},
"lpfFIRBWTx1" : {
"type" : "number",
@@ -9758,7 +11984,9 @@ margin-bottom: 20px;
},
"antennaPathTx1" : {
"type" : "integer",
- "description" : "Tx[1] Antenna connection (PathTxRFE):\n * 0 - None\n * 1 - RF connector 1\n * 2 - RF connector 2\n"
+ "description" : "Tx[1] Antenna connection (PathTxRFE):\n * 0 - None\n * 1 - RF connector 1\n * 2 - RF connector 2\n",
+ "minimum" : 0,
+ "maximum" : 2
}
},
"description" : "LimeSDR"
@@ -9771,26 +11999,34 @@ margin-bottom: 20px;
},
"streamActive" : {
"type" : "integer",
- "description" : "1 if active else 0"
+ "description" : "1 if active else 0",
+ "minimum" : 0,
+ "maximum" : 1
},
"fifoSize" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "FIFO capacity in samples."
},
"fifoFill" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Current FIFO fill level."
},
"underrunCount" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Number of stream underrun events."
},
"overrunCount" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Number of stream overrun events."
},
"droppedPacketsCount" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Number of dropped packets."
},
"linkRate" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Measured streaming link rate."
},
"hwTimestamp" : {
"type" : "integer",
@@ -9799,15 +12035,18 @@ margin-bottom: 20px;
},
"temperature" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Reported device temperature."
},
"gpioDir" : {
"type" : "integer",
- "format" : "int8"
+ "format" : "int8",
+ "description" : "GPIO direction bit mask, with one bit per pin."
},
"gpioPins" : {
"type" : "integer",
- "format" : "int8"
+ "format" : "int8",
+ "description" : "GPIO pin-state bit mask, with one bit per pin."
}
},
"description" : "LimeSDR"
@@ -9815,75 +12054,108 @@ margin-bottom: 20px;
defs.LimeSdrOutputSettings = {
"properties" : {
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"centerFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Device center frequency in Hz."
},
"devSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device I/Q sample rate in samples per second before software decimation or interpolation."
},
"log2HardInterp" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent of the hardware interpolation factor."
},
"log2SoftInterp" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent of the software interpolation factor."
},
"lpfBW" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Analog low-pass filter bandwidth in Hz."
},
"lpfFIREnable" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable the digital FIR low-pass filter (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"lpfFIRBW" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Digital FIR low-pass filter bandwidth in Hz."
},
"gain" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Gain setting; units and available values depend on the device or plugin."
},
"ncoEnable" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable the numerically controlled oscillator (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"ncoFrequency" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Numerically controlled oscillator frequency in Hz."
},
"antennaPath" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Selected RF antenna path."
},
"extClock" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Use an external reference clock (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"extClockFreq" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "External reference-clock frequency in Hz."
},
"transverterMode" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable transverter frequency translation (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"transverterDeltaFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Frequency translation applied in transverter mode in Hz."
},
"gpioDir" : {
"type" : "integer",
- "format" : "int8"
+ "format" : "int8",
+ "description" : "GPIO direction bit mask, with one bit per pin."
},
"gpioPins" : {
"type" : "integer",
- "format" : "int8"
+ "format" : "int8",
+ "description" : "GPIO pin-state bit mask, with one bit per pin."
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
}
},
"description" : "LimeSDR"
@@ -9892,10 +12164,12 @@ margin-bottom: 20px;
"properties" : {
"centerFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Device center frequency in Hz."
},
"sampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Sample rate in samples per second."
}
},
"description" : "LocalInput"
@@ -9903,26 +12177,40 @@ margin-bottom: 20px;
defs.LocalInputSettings = {
"properties" : {
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"dcBlock" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable DSP DC-offset correction (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"iqCorrection" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable I/Q imbalance correction (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
}
},
"description" : "LocalInput"
@@ -9931,10 +12219,12 @@ margin-bottom: 20px;
"properties" : {
"centerFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Device center frequency in Hz."
},
"sampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Sample rate in samples per second."
}
},
"description" : "LocalOutput"
@@ -9942,20 +12232,28 @@ margin-bottom: 20px;
defs.LocalOutputSettings = {
"properties" : {
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
}
},
"description" : "LocalOutput"
@@ -9967,24 +12265,32 @@ margin-bottom: 20px;
"description" : "Receiving local device index"
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"log2Decim" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent of the software decimation factor; the output sample rate is divided by 2^log2Decim."
},
"filterChainHash" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Identifier of the selected half-band filter chain."
},
"play" : {
"type" : "integer",
- "description" : "Run samples transfer\n * 0 - stop\n * 1 - run\n"
+ "description" : "Run samples transfer\n * 0 - stop\n * 1 - run\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"dsp" : {
"type" : "integer",
- "description" : "Activate DSP\n * 0 - Skip DSP functions\n * 1 - Run DSP functions\n"
+ "description" : "Activate DSP\n * 0 - Skip DSP functions\n * 1 - Run DSP functions\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"gaindB" : {
"type" : "integer",
@@ -9992,7 +12298,9 @@ margin-bottom: 20px;
},
"fftOn" : {
"type" : "integer",
- "description" : "Activate FFT multiband filter\n * 0 - do not run filter\n * 1 - run filter\n"
+ "description" : "Activate FFT multiband filter\n * 0 - do not run filter\n * 1 - run filter\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"log2FFT" : {
"type" : "integer",
@@ -10000,17 +12308,22 @@ margin-bottom: 20px;
},
"fftWindow" : {
"type" : "integer",
- "description" : "FFT window type\n * 0 - Bartlett\n * 1 - Blackman-Harris\n * 2 - Flat top\n * 3 - Hamming\n * 4 - Hanning\n * 5 - Rectangle\n * 6 - Kaiser\n * 7 - Blackman\n * 8 - Blackman-Harris (7th order)\n"
+ "description" : "FFT window type\n * 0 - Bartlett\n * 1 - Blackman-Harris\n * 2 - Flat top\n * 3 - Hamming\n * 4 - Hanning\n * 5 - Rectangle\n * 6 - Kaiser\n * 7 - Blackman\n * 8 - Blackman-Harris (7th order)\n",
+ "minimum" : 0,
+ "maximum" : 8
},
"fftBands" : {
"type" : "array",
+ "description" : "List of fft bands.",
"items" : {
"$ref" : "#/definitions/FFTBand"
}
},
"reverseFilter" : {
"type" : "integer",
- "description" : "* 0 - band definitions are bandpass * 1 - band definitions are band reject\n"
+ "description" : "* 0 - band definitions are bandpass * 1 - band definitions are band reject\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"streamIndex" : {
"type" : "integer",
@@ -10018,24 +12331,34 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -10048,20 +12371,26 @@ margin-bottom: 20px;
"description" : "Sending local device index"
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"log2Interp" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent of the software interpolation factor; the output sample rate is multiplied by 2^log2Interp."
},
"filterChainHash" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Identifier of the selected half-band filter chain."
},
"play" : {
"type" : "integer",
- "description" : "boolean (1 to play, 0 to stop)"
+ "description" : "boolean (1 to play, 0 to stop)",
+ "minimum" : 0,
+ "maximum" : 1
},
"streamIndex" : {
"type" : "integer",
@@ -10069,24 +12398,34 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -10137,10 +12476,12 @@ margin-bottom: 20px;
"description" : "power transmitted in channel (dB)"
},
"audioSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Audio sample rate in samples per second."
},
"channelSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Effective sample rate delivered to the channel in samples per second."
},
"squelch" : {
"type" : "integer",
@@ -10153,48 +12494,63 @@ margin-bottom: 20px;
"properties" : {
"inputFrequencyOffset" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Channel frequency offset from the device center frequency in Hz."
},
"rfBandwidth" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "RF bandwidth in Hz."
},
"fmDeviation" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "FM frequency deviation in Hz."
},
"volume" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Audio volume multiplier."
},
"demodGain" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Demod gain setting for M17 demod."
},
"baudRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Serial-port baud rate in bits per second."
},
"squelchGate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Squelch gate duration."
},
"squelch" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Squelch threshold in dB."
},
"audioMute" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Mute audio output (1 muted, 0 unmuted).",
+ "minimum" : 0,
+ "maximum" : 1
},
"syncOrConstellation" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Sync or constellation setting for M17 demod."
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"highPassFilter" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "High pass filter setting for M17 demod."
},
"traceLengthMutliplier" : {
"type" : "integer",
@@ -10209,10 +12565,14 @@ margin-bottom: 20px;
"description" : "0 to 255"
},
"audioDeviceName" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Name of the audio device to use."
},
"statusLogEnabled" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable status log (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"streamIndex" : {
"type" : "integer",
@@ -10220,24 +12580,34 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -10251,10 +12621,12 @@ margin-bottom: 20px;
"description" : "power transmitted in channel (dB)"
},
"audioSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Audio sample rate in samples per second."
},
"channelSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Effective sample rate delivered to the channel in samples per second."
}
},
"description" : "M17Mod"
@@ -10263,35 +12635,48 @@ margin-bottom: 20px;
"properties" : {
"inputFrequencyOffset" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Channel frequency offset from the device center frequency in Hz."
},
"rfBandwidth" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "RF bandwidth in Hz."
},
"fmDeviation" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "FM frequency deviation in Hz."
},
"toneFrequency" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Tone frequency in Hz."
},
"volumeFactor" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Volume factor setting for M17 mod."
},
"channelMute" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Mute the channel output (1 muted, 0 unmuted).",
+ "minimum" : 0,
+ "maximum" : 1
},
"playLoop" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Loop playback at end of file (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"m17Mode" : {
"type" : "integer",
@@ -10306,17 +12691,21 @@ margin-bottom: 20px;
"description" : "PacketType"
},
"audioDeviceName" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Name of the audio device to use."
},
"feedbackAudioDeviceName" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Feedback audio device name setting for M17 mod."
},
"feedbackVolumeFactor" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Feedback volume factor setting for M17 mod."
},
"feedbackAudioEnable" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Feedback audio enable setting for M17 mod."
},
"streamIndex" : {
"type" : "integer",
@@ -10324,64 +12713,169 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"sourceCall" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Source call setting for M17 mod."
},
"destCall" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Dest call setting for M17 mod."
},
"insertPosition" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Insert position setting for M17 mod."
},
"can" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Can setting for M17 mod."
},
"smsText" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Sms text setting for M17 mod."
},
"loopPacket" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Loop packet setting for M17 mod."
},
"loopPacketInterval" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Loop packet interval setting for M17 mod."
},
"aprsCallsign" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Aprs callsign setting for M17 mod."
},
"aprsTo" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Aprs to setting for M17 mod."
},
"aprsVia" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Aprs via setting for M17 mod."
},
"aprsData" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Aprs data setting for M17 mod."
},
"aprsInsertPosition" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Aprs insert position setting for M17 mod."
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
"description" : "M17Mod"
+};
+ defs.MCPServerActions = {
+ "properties" : {
+ "run" : {
+ "type" : "integer",
+ "description" : "Set the plugin running state\n * 0 - idle\n * 1 - run\n",
+ "minimum" : 0,
+ "maximum" : 1
+ }
+ },
+ "description" : "MCP server actions"
+};
+ defs.MCPServerReport = {
+ "properties" : {
+ "runningState" : {
+ "type" : "integer",
+ "description" : "Running state\n * 0 - not started\n * 1 - idle\n * 2 - running\n * 3 - error\n",
+ "minimum" : 0,
+ "maximum" : 3
+ },
+ "requestCount" : {
+ "type" : "integer",
+ "description" : "Number of MCP requests served since the server was started"
+ }
+ },
+ "description" : "MCP server report"
+};
+ defs.MCPServerSettings = {
+ "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",
+ "description" : "Synchronize with reverse API\n * 1 - yes\n * 0 - no\n",
+ "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" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
+ "$ref" : "#/definitions/RollupState"
+ }
+ },
+ "description" : "MCP (Model Context Protocol) server settings"
};
defs.MapActions = {
"properties" : {
@@ -10399,13 +12893,16 @@ margin-bottom: 20px;
defs.MapAircraftState = {
"properties" : {
"callsign" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Radio callsign."
},
"aircraftType" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Aircraft type for Map aircraft state."
},
"onSurface" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "On surface for Map aircraft state."
},
"airspeed" : {
"type" : "number",
@@ -10428,7 +12925,8 @@ margin-bottom: 20px;
},
"mach" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Mach for Map aircraft state."
},
"altitude" : {
"type" : "number",
@@ -10465,15 +12963,18 @@ margin-bottom: 20px;
},
"selectedAirspeed" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Selected airspeed for Map aircraft state."
},
"selectedAltitude" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Selected altitude for Map aircraft state."
},
"selectedHeading" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Selected heading for Map aircraft state."
},
"autopilot" : {
"type" : "integer",
@@ -10493,15 +12994,18 @@ margin-bottom: 20px;
},
"windSpeed" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Wind speed for Map aircraft state."
},
"windDirection" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Wind direction for Map aircraft state."
},
"staticAirTemperature" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Static air temperature for Map aircraft state."
}
},
"description" : "Aircraft state for PFD/ND"
@@ -10514,11 +13018,15 @@ margin-bottom: 20px;
},
"reverse" : {
"type" : "integer",
- "description" : "(0 - Forward, 1 - Reverse)"
+ "description" : "(0 - Forward, 1 - Reverse)",
+ "minimum" : 0,
+ "maximum" : 1
},
"loop" : {
"type" : "integer",
- "description" : "(0 - Play once, 1 - Play in loop)"
+ "description" : "(0 - Play once, 1 - Play in loop)",
+ "minimum" : 0,
+ "maximum" : 1
},
"startDateTime" : {
"type" : "string",
@@ -10554,12 +13062,16 @@ margin-bottom: 20px;
"latitude" : {
"type" : "number",
"format" : "float",
- "description" : "Latitude in decimal degrees, positive to the North"
+ "description" : "Latitude in decimal degrees, positive to the North",
+ "minimum" : -90,
+ "maximum" : 90
},
"longitude" : {
"type" : "number",
"format" : "float",
- "description" : "Longitude in decimal degrees, positive to the East"
+ "description" : "Longitude in decimal degrees, positive to the East",
+ "minimum" : -180,
+ "maximum" : 180
},
"altitude" : {
"type" : "number",
@@ -10595,12 +13107,16 @@ margin-bottom: 20px;
"latitude" : {
"type" : "number",
"format" : "float",
- "description" : "Latitude in decimal degrees, positive to the North"
+ "description" : "Latitude in decimal degrees, positive to the North",
+ "minimum" : -90,
+ "maximum" : 90
},
"longitude" : {
"type" : "number",
"format" : "float",
- "description" : "Longitude in decimal degrees, positive to the East"
+ "description" : "Longitude in decimal degrees, positive to the East",
+ "minimum" : -180,
+ "maximum" : 180
},
"altitude" : {
"type" : "number",
@@ -10609,7 +13125,9 @@ margin-bottom: 20px;
},
"fixedPosition" : {
"type" : "integer",
- "description" : "Indicates whether position of item is constant with time (0 - variable, 1 - fixed)"
+ "description" : "Indicates whether position of item is constant with time (0 - variable, 1 - fixed)",
+ "minimum" : 0,
+ "maximum" : 1
},
"positionDateTime" : {
"type" : "string",
@@ -10639,7 +13157,9 @@ margin-bottom: 20px;
},
"orientation" : {
"type" : "integer",
- "description" : "How to orientate the model (0 - Along direction of motion, 1 - Use heading, pitch and roll)"
+ "description" : "How to orientate the model (0 - Along direction of motion, 1 - Use heading, pitch and roll)",
+ "minimum" : 0,
+ "maximum" : 1
},
"heading" : {
"type" : "number",
@@ -10680,7 +13200,9 @@ margin-bottom: 20px;
},
"altitudeReference" : {
"type" : "integer",
- "description" : "0 - NONE (Absolute), 1 - CLAMP_TO_GROUND, 2 - RELATIVE_TO_GROUND, 3 - CLIP_TO_GROUND."
+ "description" : "0 - NONE (Absolute), 1 - CLAMP_TO_GROUND, 2 - RELATIVE_TO_GROUND, 3 - CLIP_TO_GROUND.",
+ "minimum" : 0,
+ "maximum" : 3
},
"animations" : {
"type" : "array",
@@ -10691,23 +13213,29 @@ margin-bottom: 20px;
},
"type" : {
"type" : "integer",
- "description" : "(0 - Map Item, 1 - Image Tile, 2 - Polygon, 3 - Polyline)"
+ "description" : "(0 - Map Item, 1 - Image Tile, 2 - Polygon, 3 - Polyline)",
+ "minimum" : 0,
+ "maximum" : 3
},
"imageTileWest" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Image tile west for Map item."
},
"imageTileSouth" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Image tile south for Map item."
},
"imageTileEast" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Image tile east for Map item."
},
"imageTileNorth" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Image tile north for Map item."
},
"imageZoomLevel" : {
"type" : "number",
@@ -10736,13 +13264,16 @@ margin-bottom: 20px;
},
"colorValid" : {
"type" : "integer",
- "description" : "0 - Use default color, 1 - Use specified color"
+ "description" : "0 - Use default color, 1 - Use specified color",
+ "minimum" : 0,
+ "maximum" : 1
},
"color" : {
"type" : "integer",
"description" : "RGBA for polygon and polyline"
},
"aircraftState" : {
+ "description" : "Current states of aircraft tracked by the ADS-B demodulator.",
"$ref" : "#/definitions/MapAircraftState"
}
},
@@ -10770,12 +13301,16 @@ margin-bottom: 20px;
"latitude" : {
"type" : "number",
"format" : "float",
- "description" : "Latitude in decimal degrees, positive to the North"
+ "description" : "Latitude in decimal degrees, positive to the North",
+ "minimum" : -90,
+ "maximum" : 90
},
"longitude" : {
"type" : "number",
"format" : "float",
- "description" : "Longitude in decimal degrees, positive to the East"
+ "description" : "Longitude in decimal degrees, positive to the East",
+ "minimum" : -180,
+ "maximum" : 180
},
"altitude" : {
"type" : "number",
@@ -10784,7 +13319,9 @@ margin-bottom: 20px;
},
"fixedPosition" : {
"type" : "integer",
- "description" : "Indicates whether position of item is constant with time (0 - variable, 1 - fixed)"
+ "description" : "Indicates whether position of item is constant with time (0 - variable, 1 - fixed)",
+ "minimum" : 0,
+ "maximum" : 1
},
"positionDateTime" : {
"type" : "string",
@@ -10814,7 +13351,9 @@ margin-bottom: 20px;
},
"orientation" : {
"type" : "integer",
- "description" : "How to orientate the model (0 - Along direction of motion, 1 - Use heading, pitch and roll)"
+ "description" : "How to orientate the model (0 - Along direction of motion, 1 - Use heading, pitch and roll)",
+ "minimum" : 0,
+ "maximum" : 1
},
"heading" : {
"type" : "number",
@@ -10855,7 +13394,9 @@ margin-bottom: 20px;
},
"altitudeReference" : {
"type" : "integer",
- "description" : "0 - NONE (Absolute), 1 - CLAMP_TO_GROUND, 2 - RELATIVE_TO_GROUND, 3 - CLIP_TO_GROUND."
+ "description" : "0 - NONE (Absolute), 1 - CLAMP_TO_GROUND, 2 - RELATIVE_TO_GROUND, 3 - CLIP_TO_GROUND.",
+ "minimum" : 0,
+ "maximum" : 3
},
"animations" : {
"type" : "array",
@@ -10866,23 +13407,29 @@ margin-bottom: 20px;
},
"type" : {
"type" : "integer",
- "description" : "(0 - Map Item, 1 - Image Tile, 2 - Polygon, 3 - Polyline)"
+ "description" : "(0 - Map Item, 1 - Image Tile, 2 - Polygon, 3 - Polyline)",
+ "minimum" : 0,
+ "maximum" : 3
},
"imageTileWest" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Image tile west for Map item."
},
"imageTileSouth" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Image tile south for Map item."
},
"imageTileEast" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Image tile east for Map item."
},
"imageTileNorth" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Image tile north for Map item."
},
"imageZoomLevel" : {
"type" : "number",
@@ -10911,13 +13458,16 @@ margin-bottom: 20px;
},
"colorValid" : {
"type" : "integer",
- "description" : "0 - Use default color, 1 - Use specified color"
+ "description" : "0 - Use default color, 1 - Use specified color",
+ "minimum" : 0,
+ "maximum" : 1
},
"color" : {
"type" : "integer",
"description" : "RGBA for polygon and polyline"
},
"aircraftState" : {
+ "description" : "Current states of aircraft tracked by the ADS-B demodulator.",
"$ref" : "#/definitions/MapAircraftState"
}
},
@@ -10943,28 +13493,39 @@ margin-bottom: 20px;
"description" : "Terrain used for 3D map (E.g: 'Ellipsoid' or 'Cesium World Terrain')"
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIFeatureSetIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Feature-set index used by the reverse API peer."
},
"reverseAPIFeatureIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Feature index used by the reverse API peer."
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -10993,7 +13554,8 @@ margin-bottom: 20px;
"description" : "last message de-chirped signal to noise ratio power (dB)"
},
"channelSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Effective sample rate delivered to the channel in samples per second."
},
"syncWord" : {
"type" : "integer",
@@ -11017,7 +13579,9 @@ margin-bottom: 20px;
},
"headerParityStatus" : {
"type" : "integer",
- "description" : "Header FEC parity status:\n * 0 - Undefined\n * 1 - Uncorrectable error\n * 2 - Corrected error\n * 3 - OK\n"
+ "description" : "Header FEC parity status:\n * 0 - Undefined\n * 1 - Uncorrectable error\n * 2 - Corrected error\n * 3 - OK\n",
+ "minimum" : 0,
+ "maximum" : 3
},
"headerCRCStatus" : {
"type" : "integer",
@@ -11025,7 +13589,9 @@ margin-bottom: 20px;
},
"payloadParityStatus" : {
"type" : "integer",
- "description" : "Payload FEC parity status:\n * 0 - Undefined\n * 1 - Uncorrectable error\n * 2 - Corrected error\n * 3 - OK\n"
+ "description" : "Payload FEC parity status:\n * 0 - Undefined\n * 1 - Uncorrectable error\n * 2 - Corrected error\n * 3 - OK\n",
+ "minimum" : 0,
+ "maximum" : 3
},
"payloadCRCStatus" : {
"type" : "integer",
@@ -11056,7 +13622,9 @@ margin-bottom: 20px;
},
"decoding" : {
"type" : "integer",
- "description" : "Boolean - decoding status\n * 0 - no decoding\n * 1 - decoding\n"
+ "description" : "Boolean - decoding status\n * 0 - no decoding\n * 1 - decoding\n",
+ "minimum" : 0,
+ "maximum" : 1
}
},
"description" : "MeshcoreDemod"
@@ -11065,14 +13633,18 @@ margin-bottom: 20px;
"properties" : {
"inputFrequencyOffset" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Channel frequency offset from the device center frequency in Hz."
},
"bandwidthIndex" : {
"type" : "integer",
- "description" : "standard bandwidths index:\n * 0 - 375 Hz (384000 / 1024)\n * 1 - 750 Hz (384000 / 512)\n * 2 - 1500 Hz (384000 / 256)\n * 3 - 2604 Hz (333333 / 128)\n * 4 - 3125 Hz (400000 / 128)\n * 5 - 3906 Hz (500000 / 128)\n * 6 - 5208 Hz (333333 / 64)\n * 7 - 6250 Hz (400000 / 64)\n * 8 - 7813 Hz (500000 / 64)\n * 9 - 10417 Hz (333333 / 32)\n * 10 - 12500 Hz (400000 / 32)\n * 11 - 15625 Hz (500000 / 32)\n * 12 - 20833 Hz (333333 / 16)\n * 13 - 25000 Hz (400000 / 16)\n * 14 - 31250 Hz (500000 / 16)\n * 15 - 41667 Hz (333333 / 8)\n * 16 - 50000 Hz (400000 / 8)\n * 17 - 62500 Hz (500000 / 8)\n * 18 - 83333 Hz (333333 / 4)\n * 19 - 100000 Hz (400000 / 4)\n * 20 - 125000 Hz (500000 / 4)\n * 21 - 166667 Hz (333333 / 2)\n * 22 - 200000 Hz (400000 / 2)\n * 23 - 250000 Hz (500000 / 2)\n * 24 - 333333 Hz (333333 / 1)\n * 25 - 400000 Hz (400000 / 1)\n * 26 - 500000 Hz (500000 / 1)\n"
+ "description" : "standard bandwidths index:\n * 0 - 375 Hz (384000 / 1024)\n * 1 - 750 Hz (384000 / 512)\n * 2 - 1500 Hz (384000 / 256)\n * 3 - 2604 Hz (333333 / 128)\n * 4 - 3125 Hz (400000 / 128)\n * 5 - 3906 Hz (500000 / 128)\n * 6 - 5208 Hz (333333 / 64)\n * 7 - 6250 Hz (400000 / 64)\n * 8 - 7813 Hz (500000 / 64)\n * 9 - 10417 Hz (333333 / 32)\n * 10 - 12500 Hz (400000 / 32)\n * 11 - 15625 Hz (500000 / 32)\n * 12 - 20833 Hz (333333 / 16)\n * 13 - 25000 Hz (400000 / 16)\n * 14 - 31250 Hz (500000 / 16)\n * 15 - 41667 Hz (333333 / 8)\n * 16 - 50000 Hz (400000 / 8)\n * 17 - 62500 Hz (500000 / 8)\n * 18 - 83333 Hz (333333 / 4)\n * 19 - 100000 Hz (400000 / 4)\n * 20 - 125000 Hz (500000 / 4)\n * 21 - 166667 Hz (333333 / 2)\n * 22 - 200000 Hz (400000 / 2)\n * 23 - 250000 Hz (500000 / 2)\n * 24 - 333333 Hz (333333 / 1)\n * 25 - 400000 Hz (400000 / 1)\n * 26 - 500000 Hz (500000 / 1)\n",
+ "minimum" : 0,
+ "maximum" : 26
},
"spreadFactor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Spread factor setting for Meshcore demod."
},
"deBits" : {
"type" : "integer",
@@ -11080,7 +13652,9 @@ margin-bottom: 20px;
},
"decodeActive" : {
"type" : "integer",
- "description" : "boolean 1 to activate 0 to de-activate decoder"
+ "description" : "boolean 1 to activate 0 to de-activate decoder",
+ "minimum" : 0,
+ "maximum" : 1
},
"eomSquelchTenths" : {
"type" : "integer",
@@ -11104,15 +13678,21 @@ margin-bottom: 20px;
},
"sendViaUDP" : {
"type" : "integer",
- "description" : "boolean 1 to send decoded message via UDP else 0"
+ "description" : "boolean 1 to send decoded message via UDP else 0",
+ "minimum" : 0,
+ "maximum" : 1
},
"sendJsonViaUDP" : {
"type" : "integer",
- "description" : "boolean 1 to send decoded message as JSON via UDP else 0"
+ "description" : "boolean 1 to send decoded message as JSON via UDP else 0",
+ "minimum" : 0,
+ "maximum" : 1
},
"udpEnabled" : {
"type" : "integer",
- "description" : "Boolean - Send via UDP\n * 0 - Do not send decoded messages via UDP\n * 1 - Send decoded messages via UDP\n"
+ "description" : "Boolean - Send via UDP\n * 0 - Do not send decoded messages via UDP\n * 1 - Send decoded messages via UDP\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"udpAddress" : {
"type" : "string",
@@ -11120,17 +13700,23 @@ margin-bottom: 20px;
},
"udpPort" : {
"type" : "integer",
- "description" : "UDP destination port"
+ "description" : "UDP destination port",
+ "minimum" : 1,
+ "maximum" : 65535
},
"invertRamps" : {
"type" : "integer",
- "description" : "Invert chirp ramps\n * 0 - Normal chirp ramps (upchirps for preamble and payload)\n * 1 - Inverted chirp ramps (downchirps for preamble and payload)\n"
+ "description" : "Invert chirp ramps\n * 0 - Normal chirp ramps (upchirps for preamble and payload)\n * 1 - Inverted chirp ramps (downchirps for preamble and payload)\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"streamIndex" : {
"type" : "integer",
@@ -11138,27 +13724,38 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"spectrumConfig" : {
+ "description" : "Spectrum-display configuration.",
"$ref" : "#/definitions/GLSpectrum"
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -11168,7 +13765,9 @@ margin-bottom: 20px;
"properties" : {
"sendNow" : {
"type" : "integer",
- "description" : "Send packet immediately\n * 0 - Do nothing\n * 1 - Send packet\n"
+ "description" : "Send packet immediately\n * 0 - Do nothing\n * 1 - Send packet\n",
+ "minimum" : 0,
+ "maximum" : 1
}
},
"description" : "MeshcoreMod"
@@ -11181,7 +13780,8 @@ margin-bottom: 20px;
"description" : "power transmitted in channel (dB)"
},
"channelSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Effective sample rate delivered to the channel in samples per second."
},
"symbolTimeMs" : {
"type" : "number",
@@ -11200,7 +13800,9 @@ margin-bottom: 20px;
},
"playing" : {
"type" : "integer",
- "description" : "Boolean - modulator is active (playing) including idle time\n * 0 - Modulator not active\n * 1 - Modulator active\n"
+ "description" : "Boolean - modulator is active (playing) including idle time\n * 0 - Modulator not active\n * 1 - Modulator active\n",
+ "minimum" : 0,
+ "maximum" : 1
}
},
"description" : "MeshcoreMod"
@@ -11209,14 +13811,18 @@ margin-bottom: 20px;
"properties" : {
"inputFrequencyOffset" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Channel frequency offset from the device center frequency in Hz."
},
"bandwidthIndex" : {
"type" : "integer",
- "description" : "standard bandwidths index:\n * 0 - 375 Hz (384000 / 1024)\n * 1 - 750 Hz (384000 / 512)\n * 2 - 1500 Hz (384000 / 256)\n * 3 - 2604 Hz (333333 / 128)\n * 4 - 3125 Hz (400000 / 128)\n * 5 - 3906 Hz (500000 / 128)\n * 6 - 5208 Hz (333333 / 64)\n * 7 - 6250 Hz (400000 / 64)\n * 8 - 7813 Hz (500000 / 64)\n * 9 - 10417 Hz (333333 / 32)\n * 10 - 12500 Hz (400000 / 32)\n * 11 - 15625 Hz (500000 / 32)\n * 12 - 20833 Hz (333333 / 16)\n * 13 - 25000 Hz (400000 / 16)\n * 14 - 31250 Hz (500000 / 16)\n * 15 - 41667 Hz (333333 / 8)\n * 16 - 50000 Hz (400000 / 8)\n * 17 - 62500 Hz (500000 / 8)\n * 18 - 83333 Hz (333333 / 4)\n * 19 - 100000 Hz (400000 / 4)\n * 20 - 125000 Hz (500000 / 4)\n * 21 - 166667 Hz (333333 / 2)\n * 22 - 200000 Hz (400000 / 2)\n * 23 - 250000 Hz (500000 / 2)\n * 24 - 333333 Hz (333333 / 1)\n * 25 - 400000 Hz (400000 / 1)\n * 26 - 500000 Hz (500000 / 1)\n"
+ "description" : "standard bandwidths index:\n * 0 - 375 Hz (384000 / 1024)\n * 1 - 750 Hz (384000 / 512)\n * 2 - 1500 Hz (384000 / 256)\n * 3 - 2604 Hz (333333 / 128)\n * 4 - 3125 Hz (400000 / 128)\n * 5 - 3906 Hz (500000 / 128)\n * 6 - 5208 Hz (333333 / 64)\n * 7 - 6250 Hz (400000 / 64)\n * 8 - 7813 Hz (500000 / 64)\n * 9 - 10417 Hz (333333 / 32)\n * 10 - 12500 Hz (400000 / 32)\n * 11 - 15625 Hz (500000 / 32)\n * 12 - 20833 Hz (333333 / 16)\n * 13 - 25000 Hz (400000 / 16)\n * 14 - 31250 Hz (500000 / 16)\n * 15 - 41667 Hz (333333 / 8)\n * 16 - 50000 Hz (400000 / 8)\n * 17 - 62500 Hz (500000 / 8)\n * 18 - 83333 Hz (333333 / 4)\n * 19 - 100000 Hz (400000 / 4)\n * 20 - 125000 Hz (500000 / 4)\n * 21 - 166667 Hz (333333 / 2)\n * 22 - 200000 Hz (400000 / 2)\n * 23 - 250000 Hz (500000 / 2)\n * 24 - 333333 Hz (333333 / 1)\n * 25 - 400000 Hz (400000 / 1)\n * 26 - 500000 Hz (500000 / 1)\n",
+ "minimum" : 0,
+ "maximum" : 26
},
"spreadFactor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Spread factor setting for Meshcore mod."
},
"deBits" : {
"type" : "integer",
@@ -11236,7 +13842,9 @@ margin-bottom: 20px;
},
"channelMute" : {
"type" : "integer",
- "description" : "boolean"
+ "description" : "boolean",
+ "minimum" : 0,
+ "maximum" : 1
},
"nbParityBits" : {
"type" : "integer",
@@ -11252,7 +13860,9 @@ margin-bottom: 20px;
},
"udpEnabled" : {
"type" : "integer",
- "description" : "boolean 1 to enable forwarding messages via UDP else 0"
+ "description" : "boolean 1 to enable forwarding messages via UDP else 0",
+ "minimum" : 0,
+ "maximum" : 1
},
"udpAddress" : {
"type" : "string",
@@ -11260,17 +13870,23 @@ margin-bottom: 20px;
},
"udpPort" : {
"type" : "integer",
- "description" : "UDP port to listen for messages to transmit on"
+ "description" : "UDP port to listen for messages to transmit on",
+ "minimum" : 1,
+ "maximum" : 65535
},
"invertRamps" : {
"type" : "integer",
- "description" : "Invert chirp ramps\n * 0 - Normal chirp ramps (upchirps for preamble and payload)\n * 1 - Inverted chirp ramps (downchirps for preamble and payload)\n"
+ "description" : "Invert chirp ramps\n * 0 - Normal chirp ramps (upchirps for preamble and payload)\n * 1 - Inverted chirp ramps (downchirps for preamble and payload)\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"streamIndex" : {
"type" : "integer",
@@ -11278,24 +13894,34 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -11324,7 +13950,8 @@ margin-bottom: 20px;
"description" : "last message de-chirped signal to noise ratio power (dB)"
},
"channelSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Effective sample rate delivered to the channel in samples per second."
},
"syncWord" : {
"type" : "integer",
@@ -11348,7 +13975,9 @@ margin-bottom: 20px;
},
"headerParityStatus" : {
"type" : "integer",
- "description" : "Header FEC parity status:\n * 0 - Undefined\n * 1 - Uncorrectable error\n * 2 - Corrected error\n * 3 - OK\n"
+ "description" : "Header FEC parity status:\n * 0 - Undefined\n * 1 - Uncorrectable error\n * 2 - Corrected error\n * 3 - OK\n",
+ "minimum" : 0,
+ "maximum" : 3
},
"headerCRCStatus" : {
"type" : "integer",
@@ -11356,7 +13985,9 @@ margin-bottom: 20px;
},
"payloadParityStatus" : {
"type" : "integer",
- "description" : "Payload FEC parity status:\n * 0 - Undefined\n * 1 - Uncorrectable error\n * 2 - Corrected error\n * 3 - OK\n"
+ "description" : "Payload FEC parity status:\n * 0 - Undefined\n * 1 - Uncorrectable error\n * 2 - Corrected error\n * 3 - OK\n",
+ "minimum" : 0,
+ "maximum" : 3
},
"payloadCRCStatus" : {
"type" : "integer",
@@ -11387,7 +14018,9 @@ margin-bottom: 20px;
},
"decoding" : {
"type" : "integer",
- "description" : "Boolean - decoding status\n * 0 - no decoding\n * 1 - decoding\n"
+ "description" : "Boolean - decoding status\n * 0 - no decoding\n * 1 - decoding\n",
+ "minimum" : 0,
+ "maximum" : 1
}
},
"description" : "MeshtasticDemod"
@@ -11396,14 +14029,18 @@ margin-bottom: 20px;
"properties" : {
"inputFrequencyOffset" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Channel frequency offset from the device center frequency in Hz."
},
"bandwidthIndex" : {
"type" : "integer",
- "description" : "standard bandwidths index:\n * 0 - 375 Hz (384000 / 1024)\n * 1 - 750 Hz (384000 / 512)\n * 2 - 1500 Hz (384000 / 256)\n * 3 - 2604 Hz (333333 / 128)\n * 4 - 3125 Hz (400000 / 128)\n * 5 - 3906 Hz (500000 / 128)\n * 6 - 5208 Hz (333333 / 64)\n * 7 - 6250 Hz (400000 / 64)\n * 8 - 7813 Hz (500000 / 64)\n * 9 - 10417 Hz (333333 / 32)\n * 10 - 12500 Hz (400000 / 32)\n * 11 - 15625 Hz (500000 / 32)\n * 12 - 20833 Hz (333333 / 16)\n * 13 - 25000 Hz (400000 / 16)\n * 14 - 31250 Hz (500000 / 16)\n * 15 - 41667 Hz (333333 / 8)\n * 16 - 50000 Hz (400000 / 8)\n * 17 - 62500 Hz (500000 / 8)\n * 18 - 83333 Hz (333333 / 4)\n * 19 - 100000 Hz (400000 / 4)\n * 20 - 125000 Hz (500000 / 4)\n * 21 - 166667 Hz (333333 / 2)\n * 22 - 200000 Hz (400000 / 2)\n * 23 - 250000 Hz (500000 / 2)\n * 24 - 333333 Hz (333333 / 1)\n * 25 - 400000 Hz (400000 / 1)\n * 26 - 500000 Hz (500000 / 1)\n"
+ "description" : "standard bandwidths index:\n * 0 - 375 Hz (384000 / 1024)\n * 1 - 750 Hz (384000 / 512)\n * 2 - 1500 Hz (384000 / 256)\n * 3 - 2604 Hz (333333 / 128)\n * 4 - 3125 Hz (400000 / 128)\n * 5 - 3906 Hz (500000 / 128)\n * 6 - 5208 Hz (333333 / 64)\n * 7 - 6250 Hz (400000 / 64)\n * 8 - 7813 Hz (500000 / 64)\n * 9 - 10417 Hz (333333 / 32)\n * 10 - 12500 Hz (400000 / 32)\n * 11 - 15625 Hz (500000 / 32)\n * 12 - 20833 Hz (333333 / 16)\n * 13 - 25000 Hz (400000 / 16)\n * 14 - 31250 Hz (500000 / 16)\n * 15 - 41667 Hz (333333 / 8)\n * 16 - 50000 Hz (400000 / 8)\n * 17 - 62500 Hz (500000 / 8)\n * 18 - 83333 Hz (333333 / 4)\n * 19 - 100000 Hz (400000 / 4)\n * 20 - 125000 Hz (500000 / 4)\n * 21 - 166667 Hz (333333 / 2)\n * 22 - 200000 Hz (400000 / 2)\n * 23 - 250000 Hz (500000 / 2)\n * 24 - 333333 Hz (333333 / 1)\n * 25 - 400000 Hz (400000 / 1)\n * 26 - 500000 Hz (500000 / 1)\n",
+ "minimum" : 0,
+ "maximum" : 26
},
"spreadFactor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Spread factor setting for Meshtastic demod."
},
"deBits" : {
"type" : "integer",
@@ -11411,7 +14048,9 @@ margin-bottom: 20px;
},
"decodeActive" : {
"type" : "integer",
- "description" : "boolean 1 to activate 0 to de-activate decoder"
+ "description" : "boolean 1 to activate 0 to de-activate decoder",
+ "minimum" : 0,
+ "maximum" : 1
},
"eomSquelchTenths" : {
"type" : "integer",
@@ -11435,15 +14074,21 @@ margin-bottom: 20px;
},
"sendViaUDP" : {
"type" : "integer",
- "description" : "boolean 1 to send decoded message via UDP else 0"
+ "description" : "boolean 1 to send decoded message via UDP else 0",
+ "minimum" : 0,
+ "maximum" : 1
},
"sendJsonViaUDP" : {
"type" : "integer",
- "description" : "boolean 1 to send decoded message as JSON via UDP else 0"
+ "description" : "boolean 1 to send decoded message as JSON via UDP else 0",
+ "minimum" : 0,
+ "maximum" : 1
},
"udpEnabled" : {
"type" : "integer",
- "description" : "Boolean - Send via UDP\n * 0 - Do not send decoded messages via UDP\n * 1 - Send decoded messages via UDP\n"
+ "description" : "Boolean - Send via UDP\n * 0 - Do not send decoded messages via UDP\n * 1 - Send decoded messages via UDP\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"udpAddress" : {
"type" : "string",
@@ -11451,17 +14096,23 @@ margin-bottom: 20px;
},
"udpPort" : {
"type" : "integer",
- "description" : "UDP destination port"
+ "description" : "UDP destination port",
+ "minimum" : 1,
+ "maximum" : 65535
},
"invertRamps" : {
"type" : "integer",
- "description" : "Invert chirp ramps\n * 0 - Normal chirp ramps (upchirps for preamble and payload)\n * 1 - Inverted chirp ramps (downchirps for preamble and payload)\n"
+ "description" : "Invert chirp ramps\n * 0 - Normal chirp ramps (upchirps for preamble and payload)\n * 1 - Inverted chirp ramps (downchirps for preamble and payload)\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"streamIndex" : {
"type" : "integer",
@@ -11469,27 +14120,38 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"spectrumConfig" : {
+ "description" : "Spectrum-display configuration.",
"$ref" : "#/definitions/GLSpectrum"
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -11503,7 +14165,8 @@ margin-bottom: 20px;
"description" : "power transmitted in channel (dB)"
},
"channelSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Effective sample rate delivered to the channel in samples per second."
},
"symbolTimeMs" : {
"type" : "number",
@@ -11522,7 +14185,9 @@ margin-bottom: 20px;
},
"playing" : {
"type" : "integer",
- "description" : "Boolean - modulator is active (playing) including idle time\n * 0 - Modulator not active\n * 1 - Modulator active\n"
+ "description" : "Boolean - modulator is active (playing) including idle time\n * 0 - Modulator not active\n * 1 - Modulator active\n",
+ "minimum" : 0,
+ "maximum" : 1
}
},
"description" : "MeshtasticMod"
@@ -11531,14 +14196,18 @@ margin-bottom: 20px;
"properties" : {
"inputFrequencyOffset" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Channel frequency offset from the device center frequency in Hz."
},
"bandwidthIndex" : {
"type" : "integer",
- "description" : "standard bandwidths index:\n * 0 - 375 Hz (384000 / 1024)\n * 1 - 750 Hz (384000 / 512)\n * 2 - 1500 Hz (384000 / 256)\n * 3 - 2604 Hz (333333 / 128)\n * 4 - 3125 Hz (400000 / 128)\n * 5 - 3906 Hz (500000 / 128)\n * 6 - 5208 Hz (333333 / 64)\n * 7 - 6250 Hz (400000 / 64)\n * 8 - 7813 Hz (500000 / 64)\n * 9 - 10417 Hz (333333 / 32)\n * 10 - 12500 Hz (400000 / 32)\n * 11 - 15625 Hz (500000 / 32)\n * 12 - 20833 Hz (333333 / 16)\n * 13 - 25000 Hz (400000 / 16)\n * 14 - 31250 Hz (500000 / 16)\n * 15 - 41667 Hz (333333 / 8)\n * 16 - 50000 Hz (400000 / 8)\n * 17 - 62500 Hz (500000 / 8)\n * 18 - 83333 Hz (333333 / 4)\n * 19 - 100000 Hz (400000 / 4)\n * 20 - 125000 Hz (500000 / 4)\n * 21 - 166667 Hz (333333 / 2)\n * 22 - 200000 Hz (400000 / 2)\n * 23 - 250000 Hz (500000 / 2)\n * 24 - 333333 Hz (333333 / 1)\n * 25 - 400000 Hz (400000 / 1)\n * 26 - 500000 Hz (500000 / 1)\n"
+ "description" : "standard bandwidths index:\n * 0 - 375 Hz (384000 / 1024)\n * 1 - 750 Hz (384000 / 512)\n * 2 - 1500 Hz (384000 / 256)\n * 3 - 2604 Hz (333333 / 128)\n * 4 - 3125 Hz (400000 / 128)\n * 5 - 3906 Hz (500000 / 128)\n * 6 - 5208 Hz (333333 / 64)\n * 7 - 6250 Hz (400000 / 64)\n * 8 - 7813 Hz (500000 / 64)\n * 9 - 10417 Hz (333333 / 32)\n * 10 - 12500 Hz (400000 / 32)\n * 11 - 15625 Hz (500000 / 32)\n * 12 - 20833 Hz (333333 / 16)\n * 13 - 25000 Hz (400000 / 16)\n * 14 - 31250 Hz (500000 / 16)\n * 15 - 41667 Hz (333333 / 8)\n * 16 - 50000 Hz (400000 / 8)\n * 17 - 62500 Hz (500000 / 8)\n * 18 - 83333 Hz (333333 / 4)\n * 19 - 100000 Hz (400000 / 4)\n * 20 - 125000 Hz (500000 / 4)\n * 21 - 166667 Hz (333333 / 2)\n * 22 - 200000 Hz (400000 / 2)\n * 23 - 250000 Hz (500000 / 2)\n * 24 - 333333 Hz (333333 / 1)\n * 25 - 400000 Hz (400000 / 1)\n * 26 - 500000 Hz (500000 / 1)\n",
+ "minimum" : 0,
+ "maximum" : 26
},
"spreadFactor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Spread factor setting for Meshtastic mod."
},
"deBits" : {
"type" : "integer",
@@ -11558,7 +14227,9 @@ margin-bottom: 20px;
},
"channelMute" : {
"type" : "integer",
- "description" : "boolean"
+ "description" : "boolean",
+ "minimum" : 0,
+ "maximum" : 1
},
"nbParityBits" : {
"type" : "integer",
@@ -11574,7 +14245,9 @@ margin-bottom: 20px;
},
"udpEnabled" : {
"type" : "integer",
- "description" : "boolean 1 to enable forwarding messages via UDP else 0"
+ "description" : "boolean 1 to enable forwarding messages via UDP else 0",
+ "minimum" : 0,
+ "maximum" : 1
},
"udpAddress" : {
"type" : "string",
@@ -11582,17 +14255,23 @@ margin-bottom: 20px;
},
"udpPort" : {
"type" : "integer",
- "description" : "UDP port to listen for messages to transmit on"
+ "description" : "UDP port to listen for messages to transmit on",
+ "minimum" : 1,
+ "maximum" : 65535
},
"invertRamps" : {
"type" : "integer",
- "description" : "Invert chirp ramps\n * 0 - Normal chirp ramps (upchirps for preamble and payload)\n * 1 - Inverted chirp ramps (downchirps for preamble and payload)\n"
+ "description" : "Invert chirp ramps\n * 0 - Normal chirp ramps (upchirps for preamble and payload)\n * 1 - Inverted chirp ramps (downchirps for preamble and payload)\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"streamIndex" : {
"type" : "integer",
@@ -11600,24 +14279,34 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -11626,7 +14315,8 @@ margin-bottom: 20px;
defs.MetisMISOSettings = {
"properties" : {
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"nbReceivers" : {
"type" : "integer",
@@ -11634,7 +14324,9 @@ margin-bottom: 20px;
},
"txEnable" : {
"type" : "integer",
- "description" : "Enable Tx * 0 - disabled sends null payload to Metis device * 1 - enabled sends Tx payload to Metis device\n"
+ "description" : "Enable Tx * 0 - disabled sends null payload to Metis device * 1 - enabled sends Tx payload to Metis device\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"rx1CenterFrequency" : {
"type" : "integer",
@@ -11678,27 +14370,36 @@ margin-bottom: 20px;
},
"txCenterFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Transmit center frequency in Hz."
},
"rxTransverterMode" : {
"type" : "integer",
- "description" : "Rx transverter activated * 0 - disabled * 1 - enabled\n"
+ "description" : "Rx transverter activated * 0 - disabled * 1 - enabled\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"rxTransverterDeltaFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Receive frequency translation applied in transverter mode in Hz."
},
"txTransverterMode" : {
"type" : "integer",
- "description" : "Tx transverter activated * 0 - disabled * 1 - enabled\n"
+ "description" : "Tx transverter activated * 0 - disabled * 1 - enabled\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"txTransverterDeltaFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Transmit frequency translation applied in transverter mode in Hz."
},
"iqOrder" : {
"type" : "integer",
- "description" : "I/Q samples order * 0 - I then Q (direct) * 1 - Q then I (reversed)\n"
+ "description" : "I/Q samples order * 0 - I then Q (direct) * 1 - Q then I (reversed)\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"rx1SubsamplingIndex" : {
"type" : "integer",
@@ -11733,10 +14434,12 @@ margin-bottom: 20px;
"description" : "subsampling band indexes of receiver 8"
},
"sampleRateIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Selected sample rate index."
},
"log2Decim" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent of the software decimation factor; the output sample rate is divided by 2^log2Decim."
},
"LOppmTenths" : {
"type" : "integer",
@@ -11744,27 +14447,39 @@ margin-bottom: 20px;
},
"preamp" : {
"type" : "integer",
- "description" : "Preamplifer * 0 - disabled * 1 - enabled\n"
+ "description" : "Preamplifer * 0 - disabled * 1 - enabled\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"random" : {
"type" : "integer",
- "description" : "LT2208 Random * 0 - disabled * 1 - enabled\n"
+ "description" : "LT2208 Random * 0 - disabled * 1 - enabled\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"dither" : {
"type" : "integer",
- "description" : "LT2208 Dither * 0 - disabled * 1 - enabled\n"
+ "description" : "LT2208 Dither * 0 - disabled * 1 - enabled\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"duplex" : {
"type" : "integer",
- "description" : "Duplex * 0 - disabled * 1 - enabled\n"
+ "description" : "Duplex * 0 - disabled * 1 - enabled\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"dcBlock" : {
"type" : "integer",
- "description" : "DC block in software * 0 - disabled * 1 - enabled\n"
+ "description" : "DC block in software * 0 - disabled * 1 - enabled\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"iqCorrection" : {
"type" : "integer",
- "description" : "DC block in software * 0 - disabled * 1 - enabled\n"
+ "description" : "DC block in software * 0 - disabled * 1 - enabled\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"txDrive" : {
"type" : "integer",
@@ -11780,24 +14495,35 @@ margin-bottom: 20px;
},
"streamLock" : {
"type" : "integer",
- "description" : "Ties together the stream selection and spectrum source stream selections * 0 - stream unlocked * 1 - stream locked\n"
+ "description" : "Ties together the stream selection and spectrum source stream selections * 0 - stream unlocked * 1 - stream locked\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"rxLock" : {
"type" : "integer",
- "description" : "Ties together all Rx frequencies * 0 - Rx frequencies untied * 1 - Rx frequencies tied\n"
+ "description" : "Ties together all Rx frequencies * 0 - Rx frequencies untied * 1 - Rx frequencies tied\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API * 0 - disabled * 1 - enabled\n"
+ "description" : "Synchronize with reverse API * 0 - disabled * 1 - enabled\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
}
},
"description" : "MetisMISOSettings"
@@ -11819,24 +14545,34 @@ margin-bottom: 20px;
defs.MorseDecoderSettings = {
"properties" : {
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API\n * 1 - yes\n * 0 - no\n"
+ "description" : "Synchronize with reverse API\n * 1 - yes\n * 0 - no\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"udpEnabled" : {
"type" : "integer",
- "description" : "Send decoded text via UDP\n * 1 - send\n * 0 - do not send\n"
+ "description" : "Send decoded text via UDP\n * 1 - send\n * 0 - do not send\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"udpAddress" : {
"type" : "string",
@@ -11844,7 +14580,9 @@ margin-bottom: 20px;
},
"udpPort" : {
"type" : "integer",
- "description" : "Port to send text via UDP"
+ "description" : "Port to send text via UDP",
+ "minimum" : 1,
+ "maximum" : 65535
},
"logFiledName" : {
"type" : "string",
@@ -11852,26 +14590,36 @@ margin-bottom: 20px;
},
"logEnabled" : {
"type" : "integer",
- "description" : "Log decoded text to file\n * 1 - log\n * 0 - do not log\n"
+ "description" : "Log decoded text to file\n * 1 - log\n * 0 - do not log\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"auto" : {
"type" : "integer",
- "description" : "Auto detect CW pitch and keying speed\n * 1 - auto detect\n * 0 - use last values\n"
+ "description" : "Auto detect CW pitch and keying speed\n * 1 - auto detect\n * 0 - use last values\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"showThreshold" : {
"type" : "integer",
- "description" : "Show GGMorse decoder threshold on the imaginary part of the scope trace\n * 1 - show\n * 0 - do not show\n"
+ "description" : "Show GGMorse decoder threshold on the imaginary part of the scope trace\n * 1 - show\n * 0 - do not show\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIFeatureSetIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Feature-set index used by the reverse API peer."
},
"reverseAPIFeatureIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Feature index used by the reverse API peer."
},
"scopeConfig" : {
+ "description" : "Oscilloscope-display configuration.",
"$ref" : "#/definitions/GLScope"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -11894,10 +14642,12 @@ margin-bottom: 20px;
"description" : "squelch status (1 if open else 0)"
},
"audioSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Audio sample rate in samples per second."
},
"channelSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Effective sample rate delivered to the channel in samples per second."
}
},
"description" : "NFMDemod"
@@ -11920,14 +14670,16 @@ margin-bottom: 20px;
"description" : "AF bandwidth in Hz (rounds to lower kHz)"
},
"fmDeviation" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "FM frequency deviation in Hz."
},
"squelchGate" : {
"type" : "integer",
"description" : "squelch gate in tens of ms"
},
"deltaSquelch" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Delta squelch setting for Nfm demod."
},
"squelch" : {
"type" : "number",
@@ -11936,28 +14688,38 @@ margin-bottom: 20px;
},
"volume" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Audio volume multiplier."
},
"ctcssOn" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Ctcss on setting for Nfm demod."
},
"highPass" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "High pass setting for Nfm demod."
},
"audioMute" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Mute audio output (1 muted, 0 unmuted).",
+ "minimum" : 0,
+ "maximum" : 1
},
"ctcssIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Selected ctcss index."
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"audioDeviceName" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Name of the audio device to use."
},
"streamIndex" : {
"type" : "integer",
@@ -11965,24 +14727,34 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -11996,10 +14768,12 @@ margin-bottom: 20px;
"description" : "power transmitted in channel (dB)"
},
"audioSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Audio sample rate in samples per second."
},
"channelSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Effective sample rate delivered to the channel in samples per second."
}
},
"description" : "NFMMod"
@@ -12008,71 +14782,99 @@ margin-bottom: 20px;
"properties" : {
"inputFrequencyOffset" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Channel frequency offset from the device center frequency in Hz."
},
"rfBandwidth" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "RF bandwidth in Hz."
},
"afBandwidth" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Audio-frequency bandwidth in Hz."
},
"fmDeviation" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "FM frequency deviation in Hz."
},
"toneFrequency" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Tone frequency in Hz."
},
"volumeFactor" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Volume factor setting for Nfm mod."
},
"channelMute" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Mute the channel output (1 muted, 0 unmuted).",
+ "minimum" : 0,
+ "maximum" : 1
},
"playLoop" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Loop playback at end of file (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"ctcssOn" : {
"type" : "integer",
- "description" : "Enable CTCSS squelch (takes precedence on DCS) * 0 - disabled * 1 - enabled\n"
+ "description" : "Enable CTCSS squelch (takes precedence on DCS) * 0 - disabled * 1 - enabled\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"ctcssIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Selected ctcss index."
},
"dcsOn" : {
"type" : "integer",
- "description" : "Enable DCS squelch (only if CTCSS is off) * 0 - disabled * 1 - enabled\n"
+ "description" : "Enable DCS squelch (only if CTCSS is off) * 0 - disabled * 1 - enabled\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"dcsCode" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Dcs code setting for Nfm mod."
},
"dcsPositive" : {
"type" : "integer",
- "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\n"
+ "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\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"audioDeviceName" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Name of the audio device to use."
},
"modAFInput" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Audio-frequency modulation input selection."
},
"preEmphasisOn" : {
"type" : "integer",
- "description" : "Activate pre-emphasis filter: * 0 - inactive * 1 - active\n"
+ "description" : "Activate pre-emphasis filter: * 0 - inactive * 1 - active\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"bpfOn" : {
"type" : "integer",
- "description" : "Activate audio highpass filter when no CTCSS nor DCS: * 0 - inactive * 1 - active\n"
+ "description" : "Activate audio highpass filter when no CTCSS nor DCS: * 0 - inactive * 1 - active\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"streamIndex" : {
"type" : "integer",
@@ -12080,27 +14882,38 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"cwKeyer" : {
+ "description" : "CW keyer configuration.",
"$ref" : "#/definitions/CWKeyerSettings"
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -12109,10 +14922,12 @@ margin-bottom: 20px;
defs.NamedEnum = {
"properties" : {
"name" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Name."
},
"value" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Numeric enumeration value."
}
},
"description" : "Enumeration with name for values"
@@ -12125,7 +14940,8 @@ margin-bottom: 20px;
"description" : "power received in channel (dB)"
},
"channelSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Effective sample rate delivered to the channel in samples per second."
}
},
"description" : "ACARSDemod"
@@ -12134,24 +14950,31 @@ margin-bottom: 20px;
"properties" : {
"inputFrequencyOffset" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Channel frequency offset from the device center frequency in Hz."
},
"rfBandwidth" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "RF bandwidth in Hz."
},
"navArea" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Nav area setting for Navtex demod."
},
"filterStation" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Filter station setting for Navtex demod."
},
"filterType" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Filter type setting for Navtex demod."
},
"udpEnabled" : {
"type" : "integer",
- "description" : "Whether to forward received messages to specified UDP port"
+ "description" : "Whether to forward received messages to specified UDP port",
+ "minimum" : 0,
+ "maximum" : 1
},
"udpAddress" : {
"type" : "string",
@@ -12159,19 +14982,27 @@ margin-bottom: 20px;
},
"udpPort" : {
"type" : "integer",
- "description" : "UDP port to forward received messages to"
+ "description" : "UDP port to forward received messages to",
+ "minimum" : 1,
+ "maximum" : 65535
},
"logFilename" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Log file name or path."
},
"logEnabled" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable logging to the configured file (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"streamIndex" : {
"type" : "integer",
@@ -12179,27 +15010,38 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"scopeConfig" : {
+ "description" : "Oscilloscope-display configuration.",
"$ref" : "#/definitions/GLScope"
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -12213,7 +15055,8 @@ margin-bottom: 20px;
"description" : "power received in channel (dB)"
},
"channelSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Effective sample rate delivered to the channel in samples per second."
}
},
"description" : "NoiseFigure"
@@ -12222,64 +15065,82 @@ margin-bottom: 20px;
"properties" : {
"inputFrequencyOffset" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Channel frequency offset from the device center frequency in Hz."
},
"fftSize" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "FFT size in samples."
},
"fftCount" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Number of fft events or items."
},
"sweepSpec" : {
"type" : "integer",
- "description" : "(0 - Range, 1 - Step, 2 - List)"
+ "description" : "(0 - Range, 1 - Step, 2 - List)",
+ "minimum" : 0,
+ "maximum" : 2
},
"startValue" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Start value setting for Noise figure."
},
"stopValue" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Stop value setting for Noise figure."
},
"steps" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Steps setting for Noise figure."
},
"step" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Increment between adjacent supported values."
},
"list" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "List setting for Noise figure."
},
"setting" : {
"type" : "string",
"description" : "The device setting to sweep (E.g. centerFrequency or gain)"
},
"visaDevice" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Visa device setting for Noise figure."
},
"powerOnSCPI" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Power on scpi setting for Noise figure."
},
"powerOffSCPI" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Power off scpi setting for Noise figure."
},
"powerOnCommand" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Power on command setting for Noise figure."
},
"powerOffCommand" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Power off command setting for Noise figure."
},
"powerDelay" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Power delay setting for Noise figure."
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"streamIndex" : {
"type" : "integer",
@@ -12287,24 +15148,34 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -12314,7 +15185,9 @@ margin-bottom: 20px;
"properties" : {
"run" : {
"type" : "integer",
- "description" : "Set the plugin running state\n * 0 - idle\n * 1 - run\n"
+ "description" : "Set the plugin running state\n * 0 - idle\n * 1 - run\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"aos" : {
"$ref" : "#/definitions/PERTesterActions_aos"
@@ -12343,7 +15216,9 @@ margin-bottom: 20px;
"properties" : {
"runningState" : {
"type" : "integer",
- "description" : "Running state\n * 0 - not started\n * 1 - idle\n * 2 - running\n * 3 - error\n"
+ "description" : "Running state\n * 0 - not started\n * 1 - idle\n * 2 - running\n * 3 - error\n",
+ "minimum" : 0,
+ "maximum" : 3
}
},
"description" : "PERTester"
@@ -12351,15 +15226,19 @@ margin-bottom: 20px;
defs.PERTesterSettings = {
"properties" : {
"packetCount" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Number of packet events or items."
},
"interval" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Interval setting for Per tester."
},
"start" : {
"type" : "integer",
- "description" : "0 - immediately, 1 - on satellite AOS, 2 - on satellite mid pass"
+ "description" : "0 - immediately, 1 - on satellite AOS, 2 - on satellite mid pass",
+ "minimum" : 0,
+ "maximum" : 2
},
"satellites" : {
"type" : "array",
@@ -12373,10 +15252,12 @@ margin-bottom: 20px;
"description" : "Packet of data to send"
},
"ignoreLeadingBytes" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Ignore leading bytes setting for Per tester."
},
"ignoreTrailingBytes" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Ignore trailing bytes setting for Per tester."
},
"txUDPAddress" : {
"type" : "string",
@@ -12395,28 +15276,39 @@ margin-bottom: 20px;
"description" : "UDP port to receive packets via"
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIFeatureSetIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Feature-set index used by the reverse API peer."
},
"reverseAPIFeatureIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Feature index used by the reverse API peer."
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -12426,7 +15318,9 @@ margin-bottom: 20px;
"properties" : {
"tx" : {
"type" : "integer",
- "description" : "Transmit current text\n * 0 - Do nothing\n * 1 - Transmit\n"
+ "description" : "Transmit current text\n * 0 - Do nothing\n * 1 - Transmit\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"payload" : {
"$ref" : "#/definitions/PSK31ModActions_payload"
@@ -12440,7 +15334,8 @@ margin-bottom: 20px;
"type" : "string",
"description" : "PSK31 content to transmit"
}
- }
+ },
+ "description" : "Payload data."
};
defs.PSK31ModReport = {
"properties" : {
@@ -12450,7 +15345,8 @@ margin-bottom: 20px;
"description" : "power transmitted in channel (dB)"
},
"channelSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Effective sample rate delivered to the channel in samples per second."
}
},
"description" : "PSK31Mod"
@@ -12459,30 +15355,43 @@ margin-bottom: 20px;
"properties" : {
"inputFrequencyOffset" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Channel frequency offset from the device center frequency in Hz."
},
"rfBandwidth" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "RF bandwidth in Hz."
},
"gain" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Gain setting; units and available values depend on the device or plugin."
},
"channelMute" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Mute the channel output (1 muted, 0 unmuted).",
+ "minimum" : 0,
+ "maximum" : 1
},
"repeat" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Repeat transmission or playback (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"repeatCount" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Number of repetitions."
},
"lpfTaps" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Number of low-pass FIR filter taps."
},
"rfNoise" : {
"type" : "integer",
- "description" : "Boolean\n * 0 - off\n * 1 - on\n"
+ "description" : "Boolean\n * 0 - off\n * 1 - on\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"text" : {
"type" : "string",
@@ -12490,24 +15399,36 @@ margin-bottom: 20px;
},
"pulseShaping" : {
"type" : "integer",
- "description" : "Boolean\n * 0 - off\n * 1 - on\n"
+ "description" : "Boolean\n * 0 - off\n * 1 - on\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"beta" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Beta setting for Psk31 mod."
},
"symbolSpan" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Symbol span setting for Psk31 mod."
},
"prefixCRLF" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable prefix crlf (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"postfixCRLF" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable postfix crlf (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"udpEnabled" : {
"type" : "integer",
- "description" : "Whether to receive text to transmit on specified UDP port"
+ "description" : "Whether to receive text to transmit on specified UDP port",
+ "minimum" : 0,
+ "maximum" : 1
},
"udpAddress" : {
"type" : "string",
@@ -12515,13 +15436,17 @@ margin-bottom: 20px;
},
"udpPort" : {
"type" : "integer",
- "description" : "UDP port to receive text to transmit via"
+ "description" : "UDP port to receive text to transmit via",
+ "minimum" : 1,
+ "maximum" : 65535
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"streamIndex" : {
"type" : "integer",
@@ -12529,24 +15454,34 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -12560,7 +15495,8 @@ margin-bottom: 20px;
"description" : "power received in channel (dB)"
},
"channelSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Effective sample rate delivered to the channel in samples per second."
}
},
"description" : "PacketDemod"
@@ -12569,7 +15505,8 @@ margin-bottom: 20px;
"properties" : {
"inputFrequencyOffset" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Channel frequency offset from the device center frequency in Hz."
},
"mode" : {
"type" : "integer",
@@ -12577,7 +15514,8 @@ margin-bottom: 20px;
},
"rfBandwidth" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "RF bandwidth in Hz."
},
"chase" : {
"type" : "integer",
@@ -12589,7 +15527,9 @@ margin-bottom: 20px;
},
"udpEnabled" : {
"type" : "integer",
- "description" : "Whether to forward received packets to specified UDP port"
+ "description" : "Whether to forward received packets to specified UDP port",
+ "minimum" : 0,
+ "maximum" : 1
},
"udpAddress" : {
"type" : "string",
@@ -12597,22 +15537,33 @@ margin-bottom: 20px;
},
"udpPort" : {
"type" : "integer",
- "description" : "UDP port to forward received packets to"
+ "description" : "UDP port to forward received packets to",
+ "minimum" : 1,
+ "maximum" : 65535
},
"logFilename" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Log file name or path."
},
"logEnabled" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable logging to the configured file (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"useFileTime" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable file time (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"streamIndex" : {
"type" : "integer",
@@ -12620,24 +15571,34 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -12647,7 +15608,9 @@ margin-bottom: 20px;
"properties" : {
"tx" : {
"type" : "integer",
- "description" : "Transmit with current data\n * 0 - Do nothing\n * 1 - Transmit\n"
+ "description" : "Transmit with current data\n * 0 - Do nothing\n * 1 - Transmit\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"payload" : {
"$ref" : "#/definitions/PacketModActions_payload"
@@ -12658,18 +15621,23 @@ margin-bottom: 20px;
defs.PacketModActions_payload = {
"properties" : {
"callsign" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Radio callsign."
},
"to" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "To action parameter."
},
"via" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Via action parameter."
},
"data" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Payload data."
}
- }
+ },
+ "description" : "Payload data."
};
defs.PacketModReport = {
"properties" : {
@@ -12679,10 +15647,12 @@ margin-bottom: 20px;
"description" : "power transmitted in channel (dB)"
},
"audioSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Audio sample rate in samples per second."
},
"channelSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Effective sample rate delivered to the channel in samples per second."
}
},
"description" : "PacketMod"
@@ -12691,11 +15661,14 @@ margin-bottom: 20px;
"properties" : {
"inputFrequencyOffset" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Channel frequency offset from the device center frequency in Hz."
},
"modulation" : {
"type" : "integer",
- "description" : "Modulation mode\n * 0 - AFSK\n * 1 - FSK\n"
+ "description" : "Modulation mode\n * 0 - AFSK\n * 1 - FSK\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"baud" : {
"type" : "integer",
@@ -12703,136 +15676,186 @@ margin-bottom: 20px;
},
"rfBandwidth" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "RF bandwidth in Hz."
},
"fmDeviation" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "FM frequency deviation in Hz."
},
"gain" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Gain setting; units and available values depend on the device or plugin."
},
"channelMute" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Mute the channel output (1 muted, 0 unmuted).",
+ "minimum" : 0,
+ "maximum" : 1
},
"repeat" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Repeat transmission or playback (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"repeatDelay" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Delay between repetitions."
},
"repeatCount" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Number of repetitions."
},
"rampUpBits" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Ramp up bits setting for Packet mod."
},
"rampDownBits" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Ramp down bits setting for Packet mod."
},
"rampRange" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Ramp range setting for Packet mod."
},
"modulateWhileRamping" : {
"type" : "integer",
- "description" : "Boolean\n * 0 - off\n * 1 - on\n"
+ "description" : "Boolean\n * 0 - off\n * 1 - on\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"markFrequency" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Mark frequency in Hz."
},
"spaceFrequency" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Space frequency in Hz."
},
"ax25PreFlags" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Ax25 pre flags setting for Packet mod."
},
"ax25PostFlags" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Ax25 post flags setting for Packet mod."
},
"ax25Control" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Ax25 control setting for Packet mod."
},
"ax25PID" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Ax25 pid setting for Packet mod."
},
"preEmphasis" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Pre emphasis setting for Packet mod."
},
"preEmphasisTau" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Pre emphasis tau setting for Packet mod."
},
"preEmphasisHighFreq" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Pre emphasis high freq setting for Packet mod."
},
"lpfTaps" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Number of low-pass FIR filter taps."
},
"bbNoise" : {
"type" : "integer",
- "description" : "Boolean\n * 0 - off\n * 1 - on\n"
+ "description" : "Boolean\n * 0 - off\n * 1 - on\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"rfNoise" : {
"type" : "integer",
- "description" : "Boolean\n * 0 - off\n * 1 - on\n"
+ "description" : "Boolean\n * 0 - off\n * 1 - on\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"writeToFile" : {
"type" : "integer",
- "description" : "Boolean\n * 0 - off\n * 1 - on\n"
+ "description" : "Boolean\n * 0 - off\n * 1 - on\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"spectrumRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Spectrum rate setting for Packet mod."
},
"callsign" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Radio callsign."
},
"to" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "To setting for Packet mod."
},
"via" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Via setting for Packet mod."
},
"data" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Payload data."
},
"bpf" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Bpf setting for Packet mod."
},
"bpfLowCutoff" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Bpf low cutoff setting for Packet mod."
},
"bpfHighCutoff" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Bpf high cutoff setting for Packet mod."
},
"bpfTaps" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Bpf taps setting for Packet mod."
},
"scramble" : {
"type" : "integer",
- "description" : "Boolean\n * 0 - off\n * 1 - on\n"
+ "description" : "Boolean\n * 0 - off\n * 1 - on\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"polynomial" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Polynomial setting for Packet mod."
},
"pulseShaping" : {
"type" : "integer",
- "description" : "Boolean\n * 0 - off\n * 1 - on\n"
+ "description" : "Boolean\n * 0 - off\n * 1 - on\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"beta" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Beta setting for Packet mod."
},
"symbolSpan" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Symbol span setting for Packet mod."
},
"udpEnabled" : {
"type" : "integer",
- "description" : "Whether to receive packets to transmit on specified UDP port"
+ "description" : "Whether to receive packets to transmit on specified UDP port",
+ "minimum" : 0,
+ "maximum" : 1
},
"udpAddress" : {
"type" : "string",
@@ -12840,13 +15863,17 @@ margin-bottom: 20px;
},
"udpPort" : {
"type" : "integer",
- "description" : "UDP port to receive packets to transmit via"
+ "description" : "UDP port to receive packets to transmit via",
+ "minimum" : 1,
+ "maximum" : 65535
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"streamIndex" : {
"type" : "integer",
@@ -12854,24 +15881,34 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -12885,7 +15922,8 @@ margin-bottom: 20px;
"description" : "power received in channel (dB)"
},
"channelSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Effective sample rate delivered to the channel in samples per second."
}
},
"description" : "PagerDemod"
@@ -12894,27 +15932,36 @@ margin-bottom: 20px;
"properties" : {
"decode" : {
"type" : "integer",
- "description" : "Decode mode\n * 0 - Standard\n * 1 - Inverted\n * 2 - Numeric\n * 3 - Alphanumeric\n * 4 - Heuristic\n"
+ "description" : "Decode mode\n * 0 - Standard\n * 1 - Inverted\n * 2 - Numeric\n * 3 - Alphanumeric\n * 4 - Heuristic\n",
+ "minimum" : 0,
+ "maximum" : 4
},
"reverse" : {
"type" : "integer",
- "description" : "Whether characters should be reversed, for right-to-left reading order\n * 0 - Straight\n * 1 - Reversed\n"
+ "description" : "Whether characters should be reversed, for right-to-left reading order\n * 0 - Straight\n * 1 - Reversed\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"inputFrequencyOffset" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Channel frequency offset from the device center frequency in Hz."
},
"rfBandwidth" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "RF bandwidth in Hz."
},
"fmDeviation" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "FM frequency deviation in Hz."
},
"udpEnabled" : {
"type" : "integer",
- "description" : "Whether to forward received messages to specified UDP port"
+ "description" : "Whether to forward received messages to specified UDP port",
+ "minimum" : 0,
+ "maximum" : 1
},
"udpAddress" : {
"type" : "string",
@@ -12922,19 +15969,27 @@ margin-bottom: 20px;
},
"udpPort" : {
"type" : "integer",
- "description" : "UDP port to forward received messages to"
+ "description" : "UDP port to forward received messages to",
+ "minimum" : 1,
+ "maximum" : 65535
},
"logFilename" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Log file name or path."
},
"logEnabled" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable logging to the configured file (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"streamIndex" : {
"type" : "integer",
@@ -12942,27 +15997,38 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"scopeConfig" : {
+ "description" : "Oscilloscope-display configuration.",
"$ref" : "#/definitions/GLScope"
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -12972,6 +16038,7 @@ margin-bottom: 20px;
"properties" : {
"sampleRates" : {
"type" : "array",
+ "description" : "Supported sample rates in samples per second.",
"items" : {
"$ref" : "#/definitions/SampleRate"
}
@@ -12982,20 +16049,25 @@ margin-bottom: 20px;
defs.PerseusSettings = {
"properties" : {
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"centerFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Device center frequency in Hz."
},
"LOppmTenths" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Local-oscillator correction in tenths of a part per million."
},
"devSampleRateIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Selected dev sample rate index."
},
"log2Decim" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent of the software decimation factor; the output sample rate is divided by 2^log2Decim."
},
"adcDither" : {
"type" : "integer",
@@ -13010,15 +16082,21 @@ margin-bottom: 20px;
"description" : "Wideband mode i.e. bypass automatic RF filter (1 if active else 0)"
},
"transverterMode" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable transverter frequency translation (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"transverterDeltaFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Frequency translation applied in transverter mode in Hz."
},
"iqOrder" : {
"type" : "integer",
- "description" : "IQ samples order\n * 0 - Q then I (swapped)\n * 1 - I then Q (straight)\n"
+ "description" : "IQ samples order\n * 0 - Q then I (swapped)\n * 1 - I then Q (straight)\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"attenuator" : {
"type" : "integer",
@@ -13026,16 +16104,23 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
}
},
"description" : "Perseus"
@@ -13043,17 +16128,21 @@ margin-bottom: 20px;
defs.PlutoSdrInputReport = {
"properties" : {
"adcRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "ADC sample rate in samples per second."
},
"rssi" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Received signal strength indication."
},
"gainDB" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Gain dB in dB."
},
"temperature" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Reported device temperature."
}
},
"description" : "PlutoSDR"
@@ -13061,21 +16150,27 @@ margin-bottom: 20px;
defs.PlutoSdrInputSettings = {
"properties" : {
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"centerFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Device center frequency in Hz."
},
"devSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device I/Q sample rate in samples per second before software decimation or interpolation."
},
"LOppmTenths" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Local-oscillator correction in tenths of a part per million."
},
"lpfFIREnable" : {
"type" : "integer",
- "description" : "Low pass FIR filter enable (1 if enabled else 0)"
+ "description" : "Low pass FIR filter enable (1 if enabled else 0)",
+ "minimum" : 0,
+ "maximum" : 1
},
"lpfFIRBW" : {
"type" : "integer",
@@ -13094,22 +16189,38 @@ margin-bottom: 20px;
"description" : "0=Infra 1=Supra 2=Center"
},
"dcBlock" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable DSP DC-offset correction (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"iqCorrection" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable I/Q imbalance correction (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"hwBBDCBlock" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable hw bbdc block (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"hwRFDCBlock" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable hw rfdc block (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"hwIQCorrection" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable hw i/q correction (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"log2Decim" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent of the software decimation factor; the output sample rate is divided by 2^log2Decim."
},
"lpfBW" : {
"type" : "integer",
@@ -13120,34 +16231,49 @@ margin-bottom: 20px;
"description" : "Hardware gain"
},
"antennaPath" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Selected RF antenna path."
},
"gainMode" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Gain-control mode selection."
},
"transverterMode" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable transverter frequency translation (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"transverterDeltaFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Frequency translation applied in transverter mode in Hz."
},
"iqOrder" : {
"type" : "integer",
- "description" : "IQ samples order\n * 0 - Q then I (swapped)\n * 1 - I then Q (straight)\n"
+ "description" : "IQ samples order\n * 0 - Q then I (swapped)\n * 1 - I then Q (straight)\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
}
},
"description" : "PlutoSDR"
@@ -13155,28 +16281,36 @@ margin-bottom: 20px;
defs.PlutoSdrMIMOReport = {
"properties" : {
"adcRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "ADC sample rate in samples per second."
},
"dacRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "DAC sample rate in samples per second."
},
"rx0GainDB" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Rx0 gain dB in dB."
},
"rx1GainDB" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Rx1 gain dB in dB."
},
"rssiRx0" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Reported rssi rx0."
},
"rssiRx1" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Reported rssi rx1."
},
"rssiTx0" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Reported rssi tx0."
},
"rssiTx1" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Reported rssi tx1."
}
},
"description" : "PlutoSDR"
@@ -13184,47 +16318,70 @@ margin-bottom: 20px;
defs.PlutoSdrMIMOSettings = {
"properties" : {
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"devSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device I/Q sample rate in samples per second before software decimation or interpolation."
},
"LOppmTenths" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Local-oscillator correction in tenths of a part per million."
},
"rxCenterFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Receive center frequency in Hz."
},
"dcBlock" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable DSP DC-offset correction (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"iqCorrection" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable I/Q imbalance correction (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"hwBBDCBlock" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable hw bbdc block (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"hwRFDCBlock" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable hw rfdc block (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"hwIQCorrection" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable hw i/q correction (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"fcPosRx" : {
"type" : "integer",
"description" : "0=Infra 1=Supra 2=Center"
},
"rxTransverterMode" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Receive transverter mode setting for Pluto sdr MIMO."
},
"rxTransverterDeltaFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Receive frequency translation applied in transverter mode in Hz."
},
"iqOrder" : {
"type" : "integer",
- "description" : "IQ samples order\n * 0 - Q then I (swapped)\n * 1 - I then Q (straight)\n"
+ "description" : "IQ samples order\n * 0 - Q then I (swapped)\n * 1 - I then Q (straight)\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"lpfBWRx" : {
"type" : "integer",
@@ -13247,42 +16404,50 @@ margin-bottom: 20px;
"description" : "digital lowpass FIR filter gain (dB)"
},
"log2Decim" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent of the software decimation factor; the output sample rate is divided by 2^log2Decim."
},
"rx0Gain" : {
"type" : "integer",
"description" : "Hardware gain"
},
"rx0GainMode" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Rx0 gain mode setting for Pluto sdr MIMO."
},
"rx0AntennaPath" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Rx0 antenna path setting for Pluto sdr MIMO."
},
"rx1Gain" : {
"type" : "integer",
"description" : "Hardware gain"
},
"rx1GainMode" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Rx1 gain mode setting for Pluto sdr MIMO."
},
"rx1AntennaPath" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Rx1 antenna path setting for Pluto sdr MIMO."
},
"txCenterFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Transmit center frequency in Hz."
},
"fcPosTx" : {
"type" : "integer",
"description" : "0=Infra 1=Supra 2=Center"
},
"txTransverterMode" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Transmit transverter mode setting for Pluto sdr MIMO."
},
"txTransverterDeltaFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Transmit frequency translation applied in transverter mode in Hz."
},
"lpfBWTx" : {
"type" : "integer",
@@ -13305,34 +16470,44 @@ margin-bottom: 20px;
"description" : "digital lowpass FIR filter gain (dB)"
},
"log2Interp" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent of the software interpolation factor; the output sample rate is multiplied by 2^log2Interp."
},
"tx0Att" : {
"type" : "integer",
"description" : "Hardware attenuator gain in decibel fourths (negative)"
},
"tx0AntennaPath" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Tx0 antenna path setting for Pluto sdr MIMO."
},
"tx1Att" : {
"type" : "integer",
"description" : "Hardware attenuator gain in decibel fourths (negative)"
},
"tx1AntennaPath" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Tx1 antenna path setting for Pluto sdr MIMO."
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
}
},
"description" : "PlutoSDR"
@@ -13340,14 +16515,17 @@ margin-bottom: 20px;
defs.PlutoSdrOutputReport = {
"properties" : {
"dacRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "DAC sample rate in samples per second."
},
"rssi" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Received signal strength indication."
},
"temperature" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Reported device temperature."
}
},
"description" : "PlutoSDR"
@@ -13355,21 +16533,27 @@ margin-bottom: 20px;
defs.PlutoSdrOutputSettings = {
"properties" : {
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"centerFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Device center frequency in Hz."
},
"devSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device I/Q sample rate in samples per second before software decimation or interpolation."
},
"LOppmTenths" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Local-oscillator correction in tenths of a part per million."
},
"lpfFIREnable" : {
"type" : "integer",
- "description" : "Low pass FIR filter enable (1 if enabled else 0)"
+ "description" : "Low pass FIR filter enable (1 if enabled else 0)",
+ "minimum" : 0,
+ "maximum" : 1
},
"lpfFIRBW" : {
"type" : "integer",
@@ -13384,7 +16568,8 @@ margin-bottom: 20px;
"description" : "digital lowpass FIR filter gain (dB)"
},
"log2Interp" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent of the software interpolation factor; the output sample rate is multiplied by 2^log2Interp."
},
"lpfBW" : {
"type" : "integer",
@@ -13395,27 +16580,39 @@ margin-bottom: 20px;
"description" : "Hardware attenuator gain in decibel fourths (negative)"
},
"antennaPath" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Selected RF antenna path."
},
"transverterMode" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable transverter frequency translation (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"transverterDeltaFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Frequency translation applied in transverter mode in Hz."
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
}
},
"description" : "PlutoSDR"
@@ -13431,18 +16628,26 @@ margin-bottom: 20px;
"description" : "Index of the source used in R0 tab (GUI flavor) at startup"
},
"audioType" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Audio type for Preferences."
},
"audioDevice" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Audio device for Preferences."
},
"latitude" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Latitude in degrees, positive north.",
+ "minimum" : -90,
+ "maximum" : 90
},
"longitude" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Longitude in degrees, positive east.",
+ "minimum" : -180,
+ "maximum" : 180
},
"consoleMinLogLevel" : {
"type" : "integer",
@@ -13450,10 +16655,13 @@ margin-bottom: 20px;
},
"useLogFile" : {
"type" : "integer",
- "description" : "boolean"
+ "description" : "boolean",
+ "minimum" : 0,
+ "maximum" : 1
},
"logFileName" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Log file name."
},
"fileMinLogLevel" : {
"type" : "integer",
@@ -13469,34 +16677,44 @@ margin-bottom: 20px;
"description" : "See Preset::PresetType"
},
"group" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Group for Preset."
},
"description" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Human-readable description."
},
"centerFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Device center frequency in Hz."
},
"spectrumConfig" : {
+ "description" : "Spectrum-display configuration.",
"$ref" : "#/definitions/GLSpectrum"
},
"dcOffsetCorrection" : {
"type" : "integer",
- "description" : "boolean"
+ "description" : "boolean",
+ "minimum" : 0,
+ "maximum" : 1
},
"iqImbalanceCorrection" : {
"type" : "integer",
- "description" : "boolean"
+ "description" : "boolean",
+ "minimum" : 0,
+ "maximum" : 1
},
"channelConfigs" : {
"type" : "array",
+ "description" : "List of channel configs.",
"items" : {
"$ref" : "#/definitions/ChannelConfig"
}
},
"deviceConfigs" : {
"type" : "array",
+ "description" : "List of device configs.",
"items" : {
"$ref" : "#/definitions/DeviceConfig"
}
@@ -13630,11 +16848,15 @@ margin-bottom: 20px;
"properties" : {
"demodStatus" : {
"type" : "integer",
- "description" : "Demodulation success (%)"
+ "description" : "Demodulation success (%)",
+ "minimum" : 0,
+ "maximum" : 100
},
"decodStatus" : {
"type" : "integer",
- "description" : "Decoding success (%)"
+ "description" : "Decoding success (%)",
+ "minimum" : 0,
+ "maximum" : 100
},
"rdsDemodAccumDB" : {
"type" : "number",
@@ -13680,6 +16902,7 @@ margin-bottom: 20px;
},
"altFrequencies" : {
"type" : "array",
+ "description" : "Alternative broadcast frequencies reported by RDS.",
"items" : {
"$ref" : "#/definitions/RDSReport_altFrequencies"
}
@@ -13691,7 +16914,8 @@ margin-bottom: 20px;
"properties" : {
"frequency" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Frequency in Hz."
}
}
};
@@ -13703,7 +16927,8 @@ margin-bottom: 20px;
"description" : "power received in channel (dB)"
},
"channelSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Effective sample rate delivered to the channel in samples per second."
}
},
"description" : "ACARSDemod"
@@ -13712,22 +16937,28 @@ margin-bottom: 20px;
"properties" : {
"inputFrequencyOffset" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Channel frequency offset from the device center frequency in Hz."
},
"rfBandwidth" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "RF bandwidth in Hz."
},
"baudRate" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Serial-port baud rate in bits per second."
},
"frequencyShift" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Frequency shift in Hz."
},
"udpEnabled" : {
"type" : "integer",
- "description" : "Whether to forward received messages to specified UDP port"
+ "description" : "Whether to forward received messages to specified UDP port",
+ "minimum" : 0,
+ "maximum" : 1
},
"udpAddress" : {
"type" : "string",
@@ -13735,37 +16966,57 @@ margin-bottom: 20px;
},
"udpPort" : {
"type" : "integer",
- "description" : "UDP port to forward received messages to"
+ "description" : "UDP port to forward received messages to",
+ "minimum" : 1,
+ "maximum" : 65535
},
"characterSet" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Character set setting for Rtty demod."
},
"suppressCRLF" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Suppress crlf setting for Rtty demod."
},
"unshiftOnSpace" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable unshift on space (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"msbFirst" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable msb first (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"spaceHigh" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable space high (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"squelch" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Squelch threshold in dB."
},
"logFilename" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Log file name or path."
},
"logEnabled" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable logging to the configured file (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"streamIndex" : {
"type" : "integer",
@@ -13773,27 +17024,38 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"scopeConfig" : {
+ "description" : "Oscilloscope-display configuration.",
"$ref" : "#/definitions/GLScope"
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -13803,7 +17065,9 @@ margin-bottom: 20px;
"properties" : {
"tx" : {
"type" : "integer",
- "description" : "Transmit current text\n * 0 - Do nothing\n * 1 - Transmit\n"
+ "description" : "Transmit current text\n * 0 - Do nothing\n * 1 - Transmit\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"payload" : {
"$ref" : "#/definitions/RTTYModActions_payload"
@@ -13817,7 +17081,8 @@ margin-bottom: 20px;
"type" : "string",
"description" : "RTTY content to transmit"
}
- }
+ },
+ "description" : "Payload data."
};
defs.RTTYModReport = {
"properties" : {
@@ -13827,7 +17092,8 @@ margin-bottom: 20px;
"description" : "power transmitted in channel (dB)"
},
"channelSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Effective sample rate delivered to the channel in samples per second."
}
},
"description" : "RTTYMod"
@@ -13836,7 +17102,8 @@ margin-bottom: 20px;
"properties" : {
"inputFrequencyOffset" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Channel frequency offset from the device center frequency in Hz."
},
"baud" : {
"type" : "number",
@@ -13844,30 +17111,43 @@ margin-bottom: 20px;
"description" : "Baud rate"
},
"rfBandwidth" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "RF bandwidth in Hz."
},
"frequencyShift" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Frequency shift in Hz."
},
"gain" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Gain setting; units and available values depend on the device or plugin."
},
"channelMute" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Mute the channel output (1 muted, 0 unmuted).",
+ "minimum" : 0,
+ "maximum" : 1
},
"repeat" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Repeat transmission or playback (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"repeatCount" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Number of repetitions."
},
"lpfTaps" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Number of low-pass FIR filter taps."
},
"rfNoise" : {
"type" : "integer",
- "description" : "Boolean\n * 0 - off\n * 1 - on\n"
+ "description" : "Boolean\n * 0 - off\n * 1 - on\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"text" : {
"type" : "string",
@@ -13875,36 +17155,58 @@ margin-bottom: 20px;
},
"pulseShaping" : {
"type" : "integer",
- "description" : "Boolean\n * 0 - off\n * 1 - on\n"
+ "description" : "Boolean\n * 0 - off\n * 1 - on\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"beta" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Beta setting for Rtty mod."
},
"symbolSpan" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Symbol span setting for Rtty mod."
},
"characterSet" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Character set setting for Rtty mod."
},
"unshiftOnSpace" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable unshift on space (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"msbFirst" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable msb first (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"spaceHigh" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable space high (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"prefixCRLF" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable prefix crlf (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"postfixCRLF" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable postfix crlf (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"udpEnabled" : {
"type" : "integer",
- "description" : "Whether to receive text to transmit on specified UDP port"
+ "description" : "Whether to receive text to transmit on specified UDP port",
+ "minimum" : 0,
+ "maximum" : 1
},
"udpAddress" : {
"type" : "string",
@@ -13912,13 +17214,17 @@ margin-bottom: 20px;
},
"udpPort" : {
"type" : "integer",
- "description" : "UDP port to receive text to transmit via"
+ "description" : "UDP port to receive text to transmit via",
+ "minimum" : 1,
+ "maximum" : 65535
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"streamIndex" : {
"type" : "integer",
@@ -13926,24 +17232,34 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -13967,7 +17283,8 @@ margin-bottom: 20px;
"description" : "power received in channel (dB)"
},
"channelSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Effective sample rate delivered to the channel in samples per second."
}
},
"description" : "RadioAstronomy"
@@ -13976,31 +17293,40 @@ margin-bottom: 20px;
"properties" : {
"inputFrequencyOffset" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Channel frequency offset from the device center frequency in Hz."
},
"sampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Sample rate in samples per second."
},
"rfBandwidth" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "RF bandwidth in Hz."
},
"integration" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Integration setting for Radio astronomy."
},
"fftSize" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "FFT size in samples."
},
"fftWindow" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "FFT window setting for Radio astronomy."
},
"filterFreqs" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Filter freqs setting for Radio astronomy."
},
"starTracker" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Star tracker setting for Radio astronomy."
},
"rotator" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Rotator setting for Radio astronomy."
},
"runMode" : {
"type" : "integer",
@@ -14011,7 +17337,8 @@ margin-bottom: 20px;
"description" : "(0 for now, 1 for at sweepStartDateTime)"
},
"sweepStartDateTime" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Sweep start date time setting for Radio astronomy."
},
"sweepType" : {
"type" : "integer",
@@ -14019,41 +17346,51 @@ margin-bottom: 20px;
},
"sweep1Start" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Sweep1 start setting for Radio astronomy."
},
"sweep1Stop" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Sweep1 stop setting for Radio astronomy."
},
"sweep1Step" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Sweep1 step setting for Radio astronomy."
},
"sweep1Delay" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Sweep1 delay setting for Radio astronomy."
},
"sweep2Start" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Sweep2 start setting for Radio astronomy."
},
"sweep2Stop" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Sweep2 stop setting for Radio astronomy."
},
"sweep2Step" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Sweep2 step setting for Radio astronomy."
},
"sweep2Delay" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Sweep2 delay setting for Radio astronomy."
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"streamIndex" : {
"type" : "integer",
@@ -14061,24 +17398,34 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -14092,13 +17439,16 @@ margin-bottom: 20px;
"description" : "power received in channel (dB)"
},
"channelSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Effective sample rate delivered to the channel in samples per second."
},
"date" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Reported date."
},
"time" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Reported time."
}
},
"description" : "RadioClock"
@@ -14126,21 +17476,28 @@ margin-bottom: 20px;
},
"threshold" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Threshold setting for Radio clock."
},
"modulation" : {
"type" : "integer",
- "description" : "0 - MSF, 1 - DCF77, 2 - TDF, 3 - WWVB, 4 - JJY"
+ "description" : "0 - MSF, 1 - DCF77, 2 - TDF, 3 - WWVB, 4 - JJY",
+ "minimum" : 0,
+ "maximum" : 4
},
"timezone" : {
"type" : "integer",
- "description" : "0 - Broadcast, 1 - Local, 2 - UTC"
+ "description" : "0 - Broadcast, 1 - Local, 2 - UTC",
+ "minimum" : 0,
+ "maximum" : 2
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"streamIndex" : {
"type" : "integer",
@@ -14148,27 +17505,38 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"scopeConfig" : {
+ "description" : "Oscilloscope-display configuration.",
"$ref" : "#/definitions/GLScope"
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -14182,7 +17550,8 @@ margin-bottom: 20px;
"description" : "power received in channel (dB)"
},
"channelSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Effective sample rate delivered to the channel in samples per second."
}
},
"description" : "RadiosondeDemod"
@@ -14195,23 +17564,29 @@ margin-bottom: 20px;
},
"inputFrequencyOffset" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Channel frequency offset from the device center frequency in Hz."
},
"rfBandwidth" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "RF bandwidth in Hz."
},
"fmDeviation" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "FM frequency deviation in Hz."
},
"correlationThreshold" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Minimum correlation score required to accept a frame preamble."
},
"udpEnabled" : {
"type" : "integer",
- "description" : "Whether to forward received messages to specified UDP port"
+ "description" : "Whether to forward received messages to specified UDP port",
+ "minimum" : 0,
+ "maximum" : 1
},
"udpAddress" : {
"type" : "string",
@@ -14219,22 +17594,33 @@ margin-bottom: 20px;
},
"udpPort" : {
"type" : "integer",
- "description" : "UDP port to forward received messages to"
+ "description" : "UDP port to forward received messages to",
+ "minimum" : 1,
+ "maximum" : 65535
},
"logFilename" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Log file name or path."
},
"logEnabled" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable logging to the configured file (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"useFileTime" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable file time (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"streamIndex" : {
"type" : "integer",
@@ -14242,27 +17628,38 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"scopeConfig" : {
+ "description" : "Oscilloscope-display configuration.",
"$ref" : "#/definitions/GLScope"
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -14271,38 +17668,51 @@ margin-bottom: 20px;
defs.RadiosondeSettings = {
"properties" : {
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIFeatureSetIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Feature-set index used by the reverse API peer."
},
"reverseAPIFeatureIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Feature index used by the reverse API peer."
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
},
"radiosondesColumnIndexes" : {
"type" : "array",
+ "description" : "List of radiosondes column indexes.",
"items" : {
"type" : "integer"
}
},
"radiosondesColumnSizes" : {
"type" : "array",
+ "description" : "List of radiosondes column sizes.",
"items" : {
"type" : "integer"
}
@@ -14313,17 +17723,21 @@ margin-bottom: 20px;
defs.Range = {
"properties" : {
"min" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Minimum value of the range."
},
"max" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Maximum value of the range."
},
"step" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Increment between adjacent supported values."
},
"scale" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Scale factor applied to the value."
}
},
"description" : "An arbitrary range of integer values"
@@ -14332,15 +17746,18 @@ margin-bottom: 20px;
"properties" : {
"min" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Minimum value of the range."
},
"max" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Maximum value of the range."
},
"step" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Increment between adjacent supported values."
}
},
"description" : "An arbitrary range of floating point values"
@@ -14349,10 +17766,12 @@ margin-bottom: 20px;
"properties" : {
"centerFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Device center frequency in Hz."
},
"sampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Sample rate in samples per second."
},
"bufferRWBalance" : {
"type" : "integer",
@@ -14376,45 +17795,70 @@ margin-bottom: 20px;
defs.RemoteInputSettings = {
"properties" : {
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"apiAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the API endpoint."
},
"apiPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the API endpoint.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"dataAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name used for data traffic."
},
"dataPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Network port used for data traffic.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"multicastAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IP multicast group address."
},
"multicastJoin" : {
"type" : "integer",
- "description" : "Join multicast group * 0 - leave group * 1 - join group\n"
+ "description" : "Join multicast group * 0 - leave group * 1 - join group\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"dcBlock" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable DSP DC-offset correction (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"iqCorrection" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable I/Q imbalance correction (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
}
},
"description" : "RemoteInput"
@@ -14423,10 +17867,12 @@ margin-bottom: 20px;
"properties" : {
"centerFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Device center frequency in Hz."
},
"sampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Sample rate in samples per second."
},
"queueLength" : {
"type" : "integer",
@@ -14462,26 +17908,36 @@ margin-bottom: 20px;
defs.RemoteOutputSettings = {
"properties" : {
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"nbFECBlocks" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Nb fec blocks setting for Remote output."
},
"nbTxBytes" : {
"type" : "integer",
"description" : "Number of bytes in a transmitted I or Q sample\n * 1\n * 2\n * 4\n"
},
"apiAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the API endpoint."
},
"apiPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the API endpoint.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"dataAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name used for data traffic."
},
"dataPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Network port used for data traffic.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"deviceIndex" : {
"type" : "integer",
@@ -14493,16 +17949,23 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
}
},
"description" : "RemoteOutput"
@@ -14527,19 +17990,25 @@ margin-bottom: 20px;
},
"dataPort" : {
"type" : "integer",
- "description" : "Receiving USB data port"
+ "description" : "Receiving USB data port",
+ "minimum" : 1,
+ "maximum" : 65535
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"log2Decim" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent of the software decimation factor; the output sample rate is divided by 2^log2Decim."
},
"filterChainHash" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Identifier of the selected half-band filter chain."
},
"streamIndex" : {
"type" : "integer",
@@ -14547,24 +18016,34 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -14636,19 +18115,25 @@ margin-bottom: 20px;
},
"dataPort" : {
"type" : "integer",
- "description" : "Remote USB data port"
+ "description" : "Remote USB data port",
+ "minimum" : 1,
+ "maximum" : 65535
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"log2Interp" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent of the software interpolation factor; the output sample rate is multiplied by 2^log2Interp."
},
"filterChainHash" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Identifier of the selected half-band filter chain."
},
"streamIndex" : {
"type" : "integer",
@@ -14656,24 +18141,34 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -14682,19 +18177,27 @@ margin-bottom: 20px;
defs.RemoteTCPInputReport = {
"properties" : {
"sampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Sample rate in samples per second."
},
"latitude" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Latitude in degrees, positive north.",
+ "minimum" : -90,
+ "maximum" : 90
},
"longitude" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Longitude in degrees, positive east.",
+ "minimum" : -180,
+ "maximum" : 180
},
"altitude" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Altitude above mean sea level."
}
},
"description" : "RemoteTCPInput"
@@ -14702,69 +18205,100 @@ margin-bottom: 20px;
defs.RemoteTCPInputSettings = {
"properties" : {
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"centerFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Device center frequency in Hz."
},
"loPpmCorrection" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Local-oscillator correction in parts per million."
},
"dcBlock" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable DSP DC-offset correction (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"iqCorrection" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable I/Q imbalance correction (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"biasTee" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable the antenna bias tee (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"directSampling" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Direct sampling setting for Remote TCP input."
},
"devSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device I/Q sample rate in samples per second before software decimation or interpolation."
},
"log2Decim" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent of the software decimation factor; the output sample rate is divided by 2^log2Decim."
},
"gain" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Gain setting; units and available values depend on the device or plugin."
},
"agc" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable automatic gain control (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"rfBW" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "RF bw in Hz."
},
"inputFrequencyOffset" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Channel frequency offset from the device center frequency in Hz."
},
"channelGain" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel gain setting for Remote TCP input."
},
"channelSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Effective sample rate delivered to the channel in samples per second."
},
"channelDecimation" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel decimation setting for Remote TCP input."
},
"sampleBits" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Number of significant bits in each sample."
},
"dataAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name used for data traffic."
},
"dataPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Network port used for data traffic.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"overrideRemoteSettings" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Override remote settings setting for Remote TCP input."
},
"preFill" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Pre fill setting for Remote TCP input."
},
"protocol" : {
"type" : "string",
@@ -14772,16 +18306,23 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
}
},
"description" : "RemoteTCPInput"
@@ -14789,17 +18330,21 @@ margin-bottom: 20px;
defs.RemoteTCPSinkSettings = {
"properties" : {
"channelSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Effective sample rate delivered to the channel in samples per second."
},
"inputFrequencyOffset" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Channel frequency offset from the device center frequency in Hz."
},
"gain" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Gain setting; units and available values depend on the device or plugin."
},
"sampleBits" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Number of significant bits in each sample."
},
"dataAddress" : {
"type" : "string",
@@ -14807,16 +18352,21 @@ margin-bottom: 20px;
},
"dataPort" : {
"type" : "integer",
- "description" : "Receiving TCP data port"
+ "description" : "Receiving TCP data port",
+ "minimum" : 1,
+ "maximum" : 65535
},
"protocol" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Protocol setting for Remote TCP sink."
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"streamIndex" : {
"type" : "integer",
@@ -14824,24 +18374,34 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -14851,7 +18411,9 @@ margin-bottom: 20px;
"properties" : {
"run" : {
"type" : "integer",
- "description" : "Set the plugin running state\n * 0 - idle\n * 1 - run\n"
+ "description" : "Set the plugin running state\n * 0 - idle\n * 1 - run\n",
+ "minimum" : 0,
+ "maximum" : 1
}
},
"description" : "RigCtl server actions"
@@ -14860,7 +18422,9 @@ margin-bottom: 20px;
"properties" : {
"runningState" : {
"type" : "integer",
- "description" : "Running state\n * 0 - not started\n * 1 - idle\n * 2 - running\n * 3 - error\n"
+ "description" : "Running state\n * 0 - not started\n * 1 - idle\n * 2 - running\n * 3 - error\n",
+ "minimum" : 0,
+ "maximum" : 3
}
},
"description" : "RigCtl server report"
@@ -14869,43 +18433,60 @@ margin-bottom: 20px;
"properties" : {
"enabled" : {
"type" : "integer",
- "description" : "Enable RigCtl server\n * 1 - enabled\n * 0 - disabled\n"
+ "description" : "Enable RigCtl server\n * 1 - enabled\n * 0 - disabled\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"rigCtlPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Rig ctl port."
},
"maxFrequencyOffset" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Max frequency offset in Hz."
},
"deviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Selected device index."
},
"channelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Selected channel index."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API\n * 1 - yes\n * 0 - no\n"
+ "description" : "Synchronize with reverse API\n * 1 - yes\n * 0 - no\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIFeatureSetIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Feature-set index used by the reverse API peer."
},
"reverseAPIFeatureIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Feature index used by the reverse API peer."
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -14914,11 +18495,14 @@ margin-bottom: 20px;
defs.RollupChildState = {
"properties" : {
"objectName" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Object name for Rollup child state."
},
"isHidden" : {
"type" : "integer",
- "description" : "Boolean - child hidden state\n * 0 - visible\n * 1 - hidden\n"
+ "description" : "Boolean - child hidden state\n * 0 - visible\n * 1 - hidden\n",
+ "minimum" : 0,
+ "maximum" : 1
}
},
"description" : "Rollup widget child state"
@@ -14926,10 +18510,12 @@ margin-bottom: 20px;
defs.RollupState = {
"properties" : {
"version" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Version for Rollup state."
},
"childrenStates" : {
"type" : "array",
+ "description" : "List of children states.",
"items" : {
"$ref" : "#/definitions/RollupChildState"
}
@@ -14941,12 +18527,14 @@ margin-bottom: 20px;
"properties" : {
"gains" : {
"type" : "array",
+ "description" : "List of gains.",
"items" : {
"$ref" : "#/definitions/Gain"
}
},
"tunerType" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Reported tuner type."
}
},
"description" : "RTLSDR"
@@ -14954,75 +18542,114 @@ margin-bottom: 20px;
defs.RtlSdrSettings = {
"properties" : {
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"devSampleRate" : {
- "type" : "integer"
+ "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.\n"
},
"lowSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Use the RTL-SDR low sample-rate range (1 enabled, 0 disabled)."
},
"centerFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Device center frequency in Hz."
},
"gain" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Gain setting; units and available values depend on the device or plugin."
},
"loPpmCorrection" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Local-oscillator correction in parts per million."
},
"log2Decim" : {
- "type" : "integer"
+ "type" : "integer",
+ "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.\n",
+ "minimum" : 0,
+ "maximum" : 6
},
"fcPos" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Position of the decimated passband relative to the device center frequency."
},
"dcBlock" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable DSP DC-offset correction (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"iqImbalance" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable DSP I/Q imbalance correction (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"agc" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable automatic gain control (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"noModMode" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "No mod mode setting for Rtl sdr."
},
"offsetTuning" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable tuner offset tuning (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"transverterMode" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable transverter frequency translation (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"transverterDeltaFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Frequency translation applied in transverter mode in Hz."
},
"iqOrder" : {
"type" : "integer",
- "description" : "IQ samples order\n * 0 - Q then I (swapped)\n * 1 - I then Q (straight)\n"
+ "description" : "IQ samples order\n * 0 - Q then I (swapped)\n * 1 - I then Q (straight)\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"rfBandwidth" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "RF bandwidth in Hz."
},
"biasTee" : {
"type" : "integer",
- "description" : "Bias tee\n * 0 - inactive\n * 1 - active\n"
+ "description" : "Bias tee\n * 0 - inactive\n * 1 - active\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
}
},
"description" : "RTLSDR"
@@ -15031,24 +18658,28 @@ margin-bottom: 20px;
"properties" : {
"sampleRates" : {
"type" : "array",
+ "description" : "Supported sample rates in samples per second.",
"items" : {
"$ref" : "#/definitions/SampleRate"
}
},
"bandwidths" : {
"type" : "array",
+ "description" : "Supported bandwidths in Hz.",
"items" : {
"$ref" : "#/definitions/Bandwidth"
}
},
"intermediateFrequencies" : {
"type" : "array",
+ "description" : "List of intermediate frequencies.",
"items" : {
"$ref" : "#/definitions/Frequency"
}
},
"frequencyBands" : {
"type" : "array",
+ "description" : "List of frequency bands.",
"items" : {
"$ref" : "#/definitions/FrequencyBand"
}
@@ -15059,71 +18690,99 @@ margin-bottom: 20px;
defs.SDRPlaySettings = {
"properties" : {
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"centerFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Device center frequency in Hz."
},
"tunerGain" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Tuner gain setting for Sdr play."
},
"LOppmTenths" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Local-oscillator correction in tenths of a part per million."
},
"frequencyBandIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Selected frequency band index."
},
"ifFrequencyIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Selected if frequency index."
},
"bandwidthIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Selected bandwidth index."
},
"devSampleRateIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Selected dev sample rate index."
},
"log2Decim" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent of the software decimation factor; the output sample rate is divided by 2^log2Decim."
},
"fcPos" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Position of the decimated passband relative to the device center frequency."
},
"dcBlock" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable DSP DC-offset correction (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"iqCorrection" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable I/Q imbalance correction (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"tunerGainMode" : {
"type" : "integer",
"description" : "1 tuner (table) gain, 0 manual (LNA, Mixer, BB) gain"
},
"lnaOn" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "LNA on setting for Sdr play."
},
"mixerAmpOn" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Mixer amp on setting for Sdr play."
},
"basebandGain" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Baseband gain setting for Sdr play."
},
"iqOrder" : {
"type" : "integer",
- "description" : "IQ samples order\n * 0 - Q then I (swapped)\n * 1 - I then Q (straight)\n"
+ "description" : "IQ samples order\n * 0 - Q then I (swapped)\n * 1 - I then Q (straight)\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
}
},
"description" : "SDRplay1"
@@ -15136,12 +18795,14 @@ margin-bottom: 20px;
},
"bandwidths" : {
"type" : "array",
+ "description" : "Supported bandwidths in Hz.",
"items" : {
"$ref" : "#/definitions/Bandwidth"
}
},
"intermediateFrequencies" : {
"type" : "array",
+ "description" : "List of intermediate frequencies.",
"items" : {
"$ref" : "#/definitions/Frequency"
}
@@ -15152,94 +18813,132 @@ margin-bottom: 20px;
defs.SDRPlayV3Settings = {
"properties" : {
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"centerFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Device center frequency in Hz."
},
"LOppmTenths" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Local-oscillator correction in tenths of a part per million."
},
"ifFrequencyIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Selected if frequency index."
},
"bandwidthIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Selected bandwidth index."
},
"devSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device I/Q sample rate in samples per second before software decimation or interpolation."
},
"log2Decim" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent of the software decimation factor; the output sample rate is divided by 2^log2Decim."
},
"fcPos" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Position of the decimated passband relative to the device center frequency."
},
"dcBlock" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable DSP DC-offset correction (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"iqCorrection" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable I/Q imbalance correction (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"lnaIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Selected lna index."
},
"lnaGain" : {
"type" : "integer",
"description" : "Gain in dB, as an alternative to lnaIndex setting"
},
"ifAGC" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "IF agc setting for Sdr play v3."
},
"ifGain" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Intermediate-frequency gain setting."
},
"amNotch" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Am notch setting for Sdr play v3."
},
"fmNotch" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "FM notch setting for Sdr play v3."
},
"dabNotch" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Dab notch setting for Sdr play v3."
},
"extRef" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Ext ref setting for Sdr play v3."
},
"tuner" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Tuner setting for Sdr play v3."
},
"antenna" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Antenna setting for Sdr play v3."
},
"transverterMode" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable transverter frequency translation (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"transverterDeltaFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Frequency translation applied in transverter mode in Hz."
},
"iqOrder" : {
"type" : "integer",
- "description" : "IQ samples order\n * 0 - Q then I (swapped)\n * 1 - I then Q (straight)\n"
+ "description" : "IQ samples order\n * 0 - Q then I (swapped)\n * 1 - I then Q (straight)\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"biasTee" : {
"type" : "integer",
- "description" : "Bias tee\n * 0 - inactive\n * 1 - active\n"
+ "description" : "Bias tee\n * 0 - inactive\n * 1 - active\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
}
},
"description" : "SDRplayV3"
@@ -15248,43 +18947,59 @@ margin-bottom: 20px;
"properties" : {
"period" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Period setting for Sid."
},
"autosave" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Autosave setting for Sid."
},
"autoload" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Autoload setting for Sid."
},
"filename" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Filename setting for Sid."
},
"autosavePeriod" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Autosave period setting for Sid."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIFeatureSetIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Feature-set index used by the reverse API peer."
},
"reverseAPIFeatureIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Feature index used by the reverse API peer."
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -15302,10 +19017,12 @@ margin-bottom: 20px;
"description" : "Audio squelch status (1 if open else 0)"
},
"audioSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Audio sample rate in samples per second."
},
"channelSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Effective sample rate delivered to the channel in samples per second."
}
},
"description" : "SSBDemod"
@@ -15314,29 +19031,37 @@ margin-bottom: 20px;
"properties" : {
"inputFrequencyOffset" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Channel frequency offset from the device center frequency in Hz."
},
"filterIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Selected filter index."
},
"spanLog2" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent controlling the displayed or processed frequency span."
},
"rfBandwidth" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "RF bandwidth in Hz."
},
"lowCutoff" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Lower filter cutoff frequency in Hz."
},
"fftWindow" : {
"type" : "integer",
- "description" : "FFT Window index (FFTWindow::Function):\n * 0 - Bartlett\n * 1 - Blackman-Harris 4 term\n * 2 - Flattop\n * 3 - Hamming\n * 4 - Hanning\n * 5 - Rectangle\n * 6 - Kaiser\n * 7 - Blackman 3 term\n * 8 - Blackman-Harris 7 term\n"
+ "description" : "FFT Window index (FFTWindow::Function):\n * 0 - Bartlett\n * 1 - Blackman-Harris 4 term\n * 2 - Flattop\n * 3 - Hamming\n * 4 - Hanning\n * 5 - Rectangle\n * 6 - Kaiser\n * 7 - Blackman 3 term\n * 8 - Blackman-Harris 7 term\n",
+ "minimum" : 0,
+ "maximum" : 8
},
"volume" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Audio volume multiplier."
},
"audioBinaural" : {
"type" : "integer",
@@ -15352,11 +19077,15 @@ margin-bottom: 20px;
},
"audioMute" : {
"type" : "integer",
- "description" : "Mute audio (1 if muted else 0)"
+ "description" : "Mute audio (1 if muted else 0)",
+ "minimum" : 0,
+ "maximum" : 1
},
"agc" : {
"type" : "integer",
- "description" : "AGC (1 if AGC active else 0)"
+ "description" : "AGC (1 if AGC active else 0)",
+ "minimum" : 0,
+ "maximum" : 1
},
"agcClamping" : {
"type" : "integer",
@@ -15376,11 +19105,15 @@ margin-bottom: 20px;
},
"dnr" : {
"type" : "integer",
- "description" : "Toggle noise reduction:\n * 0 - Noise reduction off\n * 1 - Noise reduction on\n"
+ "description" : "Toggle noise reduction:\n * 0 - Noise reduction off\n * 1 - Noise reduction on\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"dnrScheme" : {
"type" : "integer",
- "description" : "Noise reduction scheme:\n * 0 - Average of magnitudes\n * 1 - Average and standard deviation of magnitudes\n * 2 - Magnitude maxima (peaks)\n"
+ "description" : "Noise reduction scheme:\n * 0 - Average of magnitudes\n * 1 - Average and standard deviation of magnitudes\n * 2 - Magnitude maxima (peaks)\n",
+ "minimum" : 0,
+ "maximum" : 2
},
"dnrAboveAvgFactor" : {
"type" : "number",
@@ -15402,13 +19135,16 @@ margin-bottom: 20px;
"description" : "Smoothing constant (alpha) of the exponential smoothing filter. Must be between 0 and 1."
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"audioDeviceName" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Name of the audio device to use."
},
"streamIndex" : {
"type" : "integer",
@@ -15416,27 +19152,38 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"spectrumConfig" : {
+ "description" : "Spectrum-display configuration.",
"$ref" : "#/definitions/GLSpectrum"
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -15450,10 +19197,12 @@ margin-bottom: 20px;
"description" : "power transmitted in channel (dB)"
},
"audioSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Audio sample rate in samples per second."
},
"channelSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Effective sample rate delivered to the channel in samples per second."
}
},
"description" : "SSBMod"
@@ -15462,65 +19211,90 @@ margin-bottom: 20px;
"properties" : {
"inputFrequencyOffset" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Channel frequency offset from the device center frequency in Hz."
},
"bandwidth" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Bandwidth in Hz."
},
"lowCutoff" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Lower filter cutoff frequency in Hz."
},
"usb" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "USB setting for Ssb mod."
},
"toneFrequency" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Tone frequency in Hz."
},
"volumeFactor" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Volume factor setting for Ssb mod."
},
"spanLog2" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent controlling the displayed or processed frequency span."
},
"audioBinaural" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Audio binaural setting for Ssb mod."
},
"audioFlipChannels" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Audio flip channels setting for Ssb mod."
},
"dsb" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Dsb setting for Ssb mod."
},
"audioMute" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Mute audio output (1 muted, 0 unmuted).",
+ "minimum" : 0,
+ "maximum" : 1
},
"playLoop" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Loop playback at end of file (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"agc" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable automatic gain control (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"cmpPreGainDB" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Cmp pre gain dB in dB."
},
"cmpThresholdDB" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Cmp threshold dB in dB."
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"audioDeviceName" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Name of the audio device to use."
},
"modAFInput" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Audio-frequency modulation input selection."
},
"streamIndex" : {
"type" : "integer",
@@ -15528,30 +19302,42 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"cwKeyer" : {
+ "description" : "CW keyer configuration.",
"$ref" : "#/definitions/CWKeyerSettings"
},
"spectrumConfig" : {
+ "description" : "Spectrum-display configuration.",
"$ref" : "#/definitions/GLSpectrum"
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -15560,7 +19346,8 @@ margin-bottom: 20px;
defs.SampleRate = {
"properties" : {
"rate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Sample rate in samples per second."
}
},
"description" : "A sample rate expressed in samples per second (S/s)"
@@ -15710,17 +19497,22 @@ margin-bottom: 20px;
defs.SatelliteState = {
"properties" : {
"name" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Name."
},
"latitude" : {
"type" : "number",
"format" : "float",
- "description" : "Latitude of satellite in degrees"
+ "description" : "Latitude of satellite in degrees",
+ "minimum" : -90,
+ "maximum" : 90
},
"longitude" : {
"type" : "number",
"format" : "float",
- "description" : "Longitude of satellite in degrees"
+ "description" : "Longitude of satellite in degrees",
+ "minimum" : -180,
+ "maximum" : 180
},
"altitude" : {
"type" : "number",
@@ -15759,6 +19551,7 @@ margin-bottom: 20px;
},
"passes" : {
"type" : "array",
+ "description" : "List of passes.",
"items" : {
"$ref" : "#/definitions/SatellitePass"
}
@@ -15769,7 +19562,9 @@ margin-bottom: 20px;
"properties" : {
"run" : {
"type" : "integer",
- "description" : "Set the plugin running state\n * 0 - idle\n * 1 - run\n"
+ "description" : "Set the plugin running state\n * 0 - idle\n * 1 - run\n",
+ "minimum" : 0,
+ "maximum" : 1
}
},
"description" : "Satellite Tracker actions"
@@ -15778,18 +19573,23 @@ margin-bottom: 20px;
"properties" : {
"runningState" : {
"type" : "integer",
- "description" : "Running state\n * 0 - not started\n * 1 - idle\n * 2 - running\n * 3 - error\n"
+ "description" : "Running state\n * 0 - not started\n * 1 - idle\n * 2 - running\n * 3 - error\n",
+ "minimum" : 0,
+ "maximum" : 3
},
"targetAzimuth" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Target azimuth in degrees clockwise from north."
},
"targetElevation" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Target elevation in degrees above the horizon."
},
"satelliteState" : {
"type" : "array",
+ "description" : "List of satellite state.",
"items" : {
"$ref" : "#/definitions/SatelliteState"
}
@@ -15802,12 +19602,16 @@ margin-bottom: 20px;
"latitude" : {
"type" : "number",
"format" : "float",
- "description" : "Latitude in decimal degrees (North positive) of antenna location"
+ "description" : "Latitude in decimal degrees (North positive) of antenna location",
+ "minimum" : -90,
+ "maximum" : 90
},
"longitude" : {
"type" : "number",
"format" : "float",
- "description" : "Longitude in decimal degrees (East positive) of antenna location"
+ "description" : "Longitude in decimal degrees (East positive) of antenna location",
+ "minimum" : -180,
+ "maximum" : 180
},
"heightAboveSeaLevel" : {
"type" : "number",
@@ -15928,35 +19732,48 @@ margin-bottom: 20px;
},
"azimuthOffset" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Azimuth offset setting for Satellite tracker."
},
"elevationOffset" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Elevation offset setting for Satellite tracker."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIFeatureSetIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Feature-set index used by the reverse API peer."
},
"reverseAPIFeatureIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Feature index used by the reverse API peer."
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -15966,11 +19783,15 @@ margin-bottom: 20px;
"properties" : {
"playTrack" : {
"type" : "integer",
- "description" : "Play IQ stream action\n * 0 - stop playing\n * 1 - start playing current track\n"
+ "description" : "Play IQ stream action\n * 0 - stop playing\n * 1 - start playing current track\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"playRecord" : {
"type" : "integer",
- "description" : "Play IQ stream action\n * 0 - stop playing\n * 1 - start playing\n"
+ "description" : "Play IQ stream action\n * 0 - stop playing\n * 1 - start playing\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"seekTrack" : {
"type" : "integer",
@@ -15999,26 +19820,37 @@ margin-bottom: 20px;
},
"sampleFormat" : {
"type" : "integer",
- "description" : "Sample format * 0 - integer * 1 - float\n"
+ "description" : "Sample format * 0 - integer * 1 - float\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"sampleSigned" : {
"type" : "integer",
- "description" : "Sample signed status\n * 0 - unsigned\n * 1 - signed\n"
+ "description" : "Sample signed status\n * 0 - unsigned\n * 1 - signed\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"sampleSwapIQ" : {
"type" : "integer",
- "description" : "Sample I/Q swap\n * 0 - I/Q\n * 1 - Q/I\n"
+ "description" : "Sample I/Q swap\n * 0 - I/Q\n * 1 - Q/I\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"crcStatus" : {
"type" : "integer",
- "description" : "CRC status\n * 0 - no CRC available\n * 1 - CRC (SHA512) OK\n * 2 - CRC (SHA512) KO\n"
+ "description" : "CRC status\n * 0 - no CRC available\n * 1 - CRC (SHA512) OK\n * 2 - CRC (SHA512) KO\n",
+ "minimum" : 0,
+ "maximum" : 2
},
"totalBytesStatus" : {
"type" : "integer",
- "description" : "Total number of bytes in data file vs meta data\n * 0 - mismatch\n * 1 - match\n"
+ "description" : "Total number of bytes in data file vs meta data\n * 0 - mismatch\n * 1 - match\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"captures" : {
"type" : "array",
+ "description" : "List of captures.",
"items" : {
"$ref" : "#/definitions/Capture"
}
@@ -16063,7 +19895,8 @@ margin-bottom: 20px;
defs.SigMFFileInputSettings = {
"properties" : {
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"fileName" : {
"type" : "string",
@@ -16083,16 +19916,23 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
}
},
"description" : "SigMFFileInput"
@@ -16101,7 +19941,9 @@ margin-bottom: 20px;
"properties" : {
"record" : {
"type" : "integer",
- "description" : "Record action\n * 0 - stop recording\n * 1 - start recording\n"
+ "description" : "Record action\n * 0 - stop recording\n * 1 - start recording\n",
+ "minimum" : 0,
+ "maximum" : 1
}
},
"description" : "SigMFFileSink"
@@ -16110,7 +19952,9 @@ margin-bottom: 20px;
"properties" : {
"spectrumSquelch" : {
"type" : "integer",
- "description" : "Spectrum squelch status * 0 - closed * 1 - open\n"
+ "description" : "Spectrum squelch status * 0 - closed * 1 - open\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"spectrumMax" : {
"type" : "number",
@@ -16118,14 +19962,18 @@ margin-bottom: 20px;
"description" : "Current spectrum max in squared magnitude (power)"
},
"sinkSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Sample rate accepted by the sink in samples per second."
},
"channelSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Effective sample rate delivered to the channel in samples per second."
},
"recording" : {
"type" : "integer",
- "description" : "Recording status * 0 - not recording * 1 - recording\n"
+ "description" : "Recording status * 0 - not recording * 1 - recording\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"recordTimeMs" : {
"type" : "integer",
@@ -16146,24 +19994,30 @@ margin-bottom: 20px;
defs.SigMFFileSinkSettings = {
"properties" : {
"inputFrequencyOffset" : {
- "type" : "integer"
+ "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"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"log2Decim" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent of the software decimation factor; the output sample rate is divided by 2^log2Decim."
},
"spectrumSquelchMode" : {
"type" : "integer",
- "description" : "Spectrum squelch system * 0 - deactivated * 1 - activated\n"
+ "description" : "Spectrum squelch system * 0 - deactivated * 1 - activated\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"spectrumSquelch" : {
"type" : "number",
@@ -16180,7 +20034,9 @@ margin-bottom: 20px;
},
"squelchRecordingEnable" : {
"type" : "integer",
- "description" : "Automatic recording triggered by spectrum squelch * 0 - disabled * 1 - enabled\n"
+ "description" : "Automatic recording triggered by spectrum squelch * 0 - disabled * 1 - enabled\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"log2RecordSampleSize" : {
"type" : "integer",
@@ -16192,27 +20048,38 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"spectrumConfig" : {
+ "description" : "Spectrum-display configuration.",
"$ref" : "#/definitions/GLSpectrum"
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -16222,11 +20089,15 @@ margin-bottom: 20px;
"properties" : {
"run" : {
"type" : "integer",
- "description" : "Set the plugin running state\n * 0 - idle\n * 1 - run\n"
+ "description" : "Set the plugin running state\n * 0 - idle\n * 1 - run\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"ptt" : {
"type" : "integer",
- "description" : "PTT action\n * 0 - release\n * 1 - engage\n"
+ "description" : "PTT action\n * 0 - release\n * 1 - engage\n",
+ "minimum" : 0,
+ "maximum" : 1
}
},
"description" : "Simple PTT actions"
@@ -16235,11 +20106,15 @@ margin-bottom: 20px;
"properties" : {
"runningState" : {
"type" : "integer",
- "description" : "Running state\n * 0 - not started\n * 1 - idle\n * 2 - running\n * 3 - error\n"
+ "description" : "Running state\n * 0 - not started\n * 1 - idle\n * 2 - running\n * 3 - error\n",
+ "minimum" : 0,
+ "maximum" : 3
},
"ptt" : {
"type" : "integer",
- "description" : "PTT status\n * 0 - released\n * 1 - engaged\n"
+ "description" : "PTT status\n * 0 - released\n * 1 - engaged\n",
+ "minimum" : 0,
+ "maximum" : 1
}
},
"description" : "Simple PTT report"
@@ -16247,10 +20122,12 @@ margin-bottom: 20px;
defs.SimplePTTSettings = {
"properties" : {
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"rxDeviceSetIndex" : {
"type" : "integer",
@@ -16270,11 +20147,15 @@ margin-bottom: 20px;
},
"vox" : {
"type" : "integer",
- "description" : "Activate vox system\n * 0 - not active\n * 1 - active\n"
+ "description" : "Activate vox system\n * 0 - not active\n * 1 - active\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"voxEnable" : {
"type" : "integer",
- "description" : "Allow vox to control PTT\n * 0 - vox does not control PTT\n * 1 - vox controls PTT\n"
+ "description" : "Allow vox to control PTT\n * 0 - vox does not control PTT\n * 1 - vox controls PTT\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"voxLevel" : {
"type" : "integer",
@@ -16285,15 +20166,20 @@ margin-bottom: 20px;
"description" : "Vox hold timeout in milliseconds"
},
"audioDeviceName" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Name of the audio device to use."
},
"gpioControl" : {
"type" : "integer",
- "description" : "GPIO control\n * 0 - No GPIO control\n * 1 - Rx side controls GPIO\n * 2 - Tx side controls GPIO\n"
+ "description" : "GPIO control\n * 0 - No GPIO control\n * 1 - Rx side controls GPIO\n * 2 - Tx side controls GPIO\n",
+ "minimum" : 0,
+ "maximum" : 2
},
"rx2txGPIOEnable" : {
"type" : "integer",
- "description" : "Enable Rx to Tx GPIO control\n * 0 - disable\n * 1 - enable\n"
+ "description" : "Enable Rx to Tx GPIO control\n * 0 - disable\n * 1 - enable\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"rx2txGPIOMask" : {
"type" : "integer",
@@ -16307,7 +20193,9 @@ margin-bottom: 20px;
},
"rx2txCommandEnable" : {
"type" : "integer",
- "description" : "Enable Rx to Tx command\n * 0 - disable\n * 1 - enable\n"
+ "description" : "Enable Rx to Tx command\n * 0 - disable\n * 1 - enable\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"rx2txCommand" : {
"type" : "string",
@@ -16315,7 +20203,9 @@ margin-bottom: 20px;
},
"tx2rxGPIOEnable" : {
"type" : "integer",
- "description" : "Enable Tx to Rx GPIO control\n * 0 - disable\n * 1 - enable\n"
+ "description" : "Enable Tx to Rx GPIO control\n * 0 - disable\n * 1 - enable\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"tx2rxGPIOMask" : {
"type" : "integer",
@@ -16329,7 +20219,9 @@ margin-bottom: 20px;
},
"tx2rxCommandEnable" : {
"type" : "integer",
- "description" : "Enable Tx to Rx command\n * 0 - disable\n * 1 - enable\n"
+ "description" : "Enable Tx to Rx command\n * 0 - disable\n * 1 - enable\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"tx2rxCommand" : {
"type" : "string",
@@ -16337,21 +20229,30 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIFeatureSetIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Feature-set index used by the reverse API peer."
},
"reverseAPIFeatureIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Feature index used by the reverse API peer."
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -16385,12 +20286,16 @@ margin-bottom: 20px;
"latitude" : {
"type" : "number",
"format" : "float",
- "description" : "Latitude in decimal degrees (North positive) of observation/antenna location"
+ "description" : "Latitude in decimal degrees (North positive) of observation/antenna location",
+ "minimum" : -90,
+ "maximum" : 90
},
"longitude" : {
"type" : "number",
"format" : "float",
- "description" : "Longitude in decimal degrees (East positive) of observation/antenna location"
+ "description" : "Longitude in decimal degrees (East positive) of observation/antenna location",
+ "minimum" : -180,
+ "maximum" : 180
},
"altitude" : {
"type" : "number",
@@ -16446,7 +20351,8 @@ margin-bottom: 20px;
"description" : "Name of background image set"
},
"projection" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Projection setting for Sky map."
},
"source" : {
"type" : "string",
@@ -16459,12 +20365,16 @@ margin-bottom: 20px;
"latitude" : {
"type" : "number",
"format" : "float",
- "description" : "Latitude in decimal degrees (North positive) of observation/antenna location"
+ "description" : "Latitude in decimal degrees (North positive) of observation/antenna location",
+ "minimum" : -90,
+ "maximum" : 90
},
"longitude" : {
"type" : "number",
"format" : "float",
- "description" : "Longitude in decimal degrees (East positive) of observation/antenna location"
+ "description" : "Longitude in decimal degrees (East positive) of observation/antenna location",
+ "minimum" : -180,
+ "maximum" : 180
},
"altitude" : {
"type" : "number",
@@ -16479,31 +20389,44 @@ margin-bottom: 20px;
"useMyPosition" : {
"type" : "number",
"format" : "float",
- "description" : "Use My Position instead of latitude/longitude settings"
+ "description" : "Use My Position instead of latitude/longitude settings",
+ "minimum" : 0,
+ "maximum" : 1
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIFeatureSetIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Feature-set index used by the reverse API peer."
},
"reverseAPIFeatureIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Feature index used by the reverse API peer."
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -16524,12 +20447,16 @@ margin-bottom: 20px;
"latitude" : {
"type" : "number",
"format" : "float",
- "description" : "Latitude in decimal degrees (North positive) of observation/antenna location"
+ "description" : "Latitude in decimal degrees (North positive) of observation/antenna location",
+ "minimum" : -90,
+ "maximum" : 90
},
"longitude" : {
"type" : "number",
"format" : "float",
- "description" : "Longitude in decimal degrees (East positive) of observation/antenna location"
+ "description" : "Longitude in decimal degrees (East positive) of observation/antenna location",
+ "minimum" : -180,
+ "maximum" : 180
},
"altitude" : {
"type" : "number",
@@ -16563,12 +20490,16 @@ margin-bottom: 20px;
"latitude" : {
"type" : "number",
"format" : "float",
- "description" : "Latitude in decimal degrees (North positive) of observation/antenna location"
+ "description" : "Latitude in decimal degrees (North positive) of observation/antenna location",
+ "minimum" : -90,
+ "maximum" : 90
},
"longitude" : {
"type" : "number",
"format" : "float",
- "description" : "Longitude in decimal degrees (East positive) of observation/antenna location"
+ "description" : "Longitude in decimal degrees (East positive) of observation/antenna location",
+ "minimum" : -180,
+ "maximum" : 180
},
"altitude" : {
"type" : "number",
@@ -16590,10 +20521,12 @@ margin-bottom: 20px;
defs.SoapySDRFrequencySetting = {
"properties" : {
"name" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Name."
},
"ranges" : {
"type" : "array",
+ "description" : "List of ranges.",
"items" : {
"$ref" : "#/definitions/RangeFloat"
}
@@ -16604,9 +20537,11 @@ margin-bottom: 20px;
defs.SoapySDRGainSetting = {
"properties" : {
"name" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Name."
},
"range" : {
+ "description" : "Range configuration for Definitions.",
"$ref" : "#/definitions/RangeFloat"
}
},
@@ -16615,107 +20550,144 @@ margin-bottom: 20px;
defs.SoapySDRInputSettings = {
"properties" : {
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"centerFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Device center frequency in Hz."
},
"LOppmTenths" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Local-oscillator correction in tenths of a part per million."
},
"devSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device I/Q sample rate in samples per second before software decimation or interpolation."
},
"log2Decim" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent of the software decimation factor; the output sample rate is divided by 2^log2Decim."
},
"fcPos" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Position of the decimated passband relative to the device center frequency."
},
"softDCCorrection" : {
"type" : "integer",
- "description" : "boolean not zero for true"
+ "description" : "boolean not zero for true",
+ "minimum" : 0,
+ "maximum" : 1
},
"softIQCorrection" : {
"type" : "integer",
- "description" : "boolean not zero for true"
+ "description" : "boolean not zero for true",
+ "minimum" : 0,
+ "maximum" : 1
},
"transverterMode" : {
"type" : "integer",
- "description" : "boolean not zero for true"
+ "description" : "boolean not zero for true",
+ "minimum" : 0,
+ "maximum" : 1
},
"transverterDeltaFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Frequency translation applied in transverter mode in Hz."
},
"iqOrder" : {
"type" : "integer",
- "description" : "IQ samples order\n * 0 - Q then I (swapped)\n * 1 - I then Q (straight)\n"
+ "description" : "IQ samples order\n * 0 - Q then I (swapped)\n * 1 - I then Q (straight)\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"antenna" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Antenna setting for Soapy sdr input."
},
"bandwidth" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Bandwidth in Hz."
},
"tunableElements" : {
"type" : "array",
+ "description" : "List of tunable elements.",
"items" : {
"$ref" : "#/definitions/ArgValue"
}
},
"globalGain" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Overall device gain setting."
},
"individualGains" : {
"type" : "array",
+ "description" : "List of individual gains.",
"items" : {
"$ref" : "#/definitions/ArgValue"
}
},
"autoGain" : {
"type" : "integer",
- "description" : "boolean not zero for true"
+ "description" : "boolean not zero for true",
+ "minimum" : 0,
+ "maximum" : 1
},
"autoDCCorrection" : {
"type" : "integer",
- "description" : "boolean not zero for true"
+ "description" : "boolean not zero for true",
+ "minimum" : 0,
+ "maximum" : 1
},
"autoIQCorrection" : {
"type" : "integer",
- "description" : "boolean not zero for true"
+ "description" : "boolean not zero for true",
+ "minimum" : 0,
+ "maximum" : 1
},
"dcCorrection" : {
+ "description" : "Enable DC-offset correction (1 enabled, 0 disabled).",
"$ref" : "#/definitions/Complex"
},
"iqCorrection" : {
+ "description" : "Enable I/Q imbalance correction (1 enabled, 0 disabled).",
"$ref" : "#/definitions/Complex"
},
"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" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
}
},
"description" : "SoapySDR"
@@ -16723,92 +20695,122 @@ margin-bottom: 20px;
defs.SoapySDROutputSettings = {
"properties" : {
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"centerFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Device center frequency in Hz."
},
"LOppmTenths" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Local-oscillator correction in tenths of a part per million."
},
"devSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device I/Q sample rate in samples per second before software decimation or interpolation."
},
"log2Interp" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent of the software interpolation factor; the output sample rate is multiplied by 2^log2Interp."
},
"transverterMode" : {
"type" : "integer",
- "description" : "boolean not zero for true"
+ "description" : "boolean not zero for true",
+ "minimum" : 0,
+ "maximum" : 1
},
"transverterDeltaFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Frequency translation applied in transverter mode in Hz."
},
"antenna" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Antenna setting for Soapy sdr output."
},
"bandwidth" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Bandwidth in Hz."
},
"tunableElements" : {
"type" : "array",
+ "description" : "List of tunable elements.",
"items" : {
"$ref" : "#/definitions/ArgValue"
}
},
"globalGain" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Overall device gain setting."
},
"individualGains" : {
"type" : "array",
+ "description" : "List of individual gains.",
"items" : {
"$ref" : "#/definitions/ArgValue"
}
},
"autoGain" : {
"type" : "integer",
- "description" : "boolean not zero for true"
+ "description" : "boolean not zero for true",
+ "minimum" : 0,
+ "maximum" : 1
},
"autoDCCorrection" : {
"type" : "integer",
- "description" : "boolean not zero for true"
+ "description" : "boolean not zero for true",
+ "minimum" : 0,
+ "maximum" : 1
},
"autoIQCorrection" : {
"type" : "integer",
- "description" : "boolean not zero for true"
+ "description" : "boolean not zero for true",
+ "minimum" : 0,
+ "maximum" : 1
},
"dcCorrection" : {
+ "description" : "Enable DC-offset correction (1 enabled, 0 disabled).",
"$ref" : "#/definitions/Complex"
},
"iqCorrection" : {
+ "description" : "Enable I/Q imbalance correction (1 enabled, 0 disabled).",
"$ref" : "#/definitions/Complex"
},
"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" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
}
},
"description" : "SoapySDR"
@@ -16817,71 +20819,90 @@ margin-bottom: 20px;
"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" : {
"type" : "integer",
- "description" : "boolean not zero for true"
+ "description" : "boolean not zero for true",
+ "minimum" : 0,
+ "maximum" : 1
},
"hasDCOffsetValue" : {
"type" : "integer",
- "description" : "boolean not zero for true"
+ "description" : "boolean not zero for true",
+ "minimum" : 0,
+ "maximum" : 1
},
"hasIQBalanceValue" : {
"type" : "integer",
- "description" : "boolean not zero for true"
+ "description" : "boolean not zero for true",
+ "minimum" : 0,
+ "maximum" : 1
},
"hasFrequencyCorrectionValue" : {
"type" : "integer",
- "description" : "boolean not zero for true"
+ "description" : "boolean not zero for true",
+ "minimum" : 0,
+ "maximum" : 1
},
"antennas" : {
"type" : "array",
+ "description" : "List of antennas.",
"items" : {
"type" : "string"
}
},
"hasAGC" : {
"type" : "integer",
- "description" : "boolean not zero for true"
+ "description" : "boolean not zero for true",
+ "minimum" : 0,
+ "maximum" : 1
},
"gainRange" : {
+ "description" : "Gain range data for Soapy sdr.",
"$ref" : "#/definitions/RangeFloat"
},
"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" : "#/definitions/RangeFloat"
}
},
"bandwidthsRanges" : {
"type" : "array",
+ "description" : "List of bandwidths ranges.",
"items" : {
"$ref" : "#/definitions/RangeFloat"
}
@@ -16893,10 +20914,12 @@ margin-bottom: 20px;
"properties" : {
"startFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Start frequency in Hz."
},
"bandwidth" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Bandwidth in Hz."
},
"markerColor" : {
"type" : "integer",
@@ -16904,7 +20927,9 @@ margin-bottom: 20px;
},
"show" : {
"type" : "integer",
- "description" : "SpectrumAnnotationMarker::ShowState - Marker display state\n * 0 - Hidden\n * 1 - Only top marker visible\n * 2 - Fully visible with text and full sized limits\n"
+ "description" : "SpectrumAnnotationMarker::ShowState - Marker display state\n * 0 - Hidden\n * 1 - Only top marker visible\n * 2 - Fully visible with text and full sized limits\n",
+ "minimum" : 0,
+ "maximum" : 2
}
},
"description" : "Spectrum annotation marker settings"
@@ -16913,15 +20938,18 @@ margin-bottom: 20px;
"properties" : {
"frequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Frequency in Hz."
},
"powerRelativeReference" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Power relative reference for Spectrum calibration point."
},
"powerAbsoluteReference" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Power absolute reference for Spectrum calibration point."
}
},
"description" : "Spectrum calibration point settings"
@@ -16930,7 +20958,8 @@ margin-bottom: 20px;
"properties" : {
"frequency" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Frequency in Hz."
},
"power" : {
"type" : "number",
@@ -16939,7 +20968,9 @@ margin-bottom: 20px;
},
"markerType" : {
"type" : "integer",
- "description" : "Marker type\n * 0 - Fixed power\n * 1 - Current power\n * 2 - Max power\n"
+ "description" : "Marker type\n * 0 - Fixed power\n * 1 - Current power\n * 2 - Max power\n",
+ "minimum" : 0,
+ "maximum" : 2
},
"markerColor" : {
"type" : "integer",
@@ -16947,7 +20978,9 @@ margin-bottom: 20px;
},
"show" : {
"type" : "integer",
- "description" : "Boolean - Marker display state\n * 0 - Hidden\n * 1 - Visible\n"
+ "description" : "Boolean - Marker display state\n * 0 - Hidden\n * 1 - Visible\n",
+ "minimum" : 0,
+ "maximum" : 1
}
},
"description" : "Spectrum histogram marker settings"
@@ -16988,7 +21021,8 @@ margin-bottom: 20px;
"properties" : {
"frequency" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Frequency in Hz."
},
"time" : {
"type" : "number",
@@ -17001,7 +21035,9 @@ margin-bottom: 20px;
},
"show" : {
"type" : "integer",
- "description" : "Boolean - Marker display state\n * 0 - Hidden\n * 1 - Visible\n"
+ "description" : "Boolean - Marker display state\n * 0 - Hidden\n * 1 - Visible\n",
+ "minimum" : 0,
+ "maximum" : 1
}
},
"description" : "Spectrum waterfall marker settings"
@@ -17010,7 +21046,9 @@ margin-bottom: 20px;
"properties" : {
"run" : {
"type" : "integer",
- "description" : "Set the plugin running state\n * 0 - idle\n * 1 - run\n"
+ "description" : "Set the plugin running state\n * 0 - idle\n * 1 - run\n",
+ "minimum" : 0,
+ "maximum" : 1
}
},
"description" : "Star Tracker actions"
@@ -17018,7 +21056,8 @@ margin-bottom: 20px;
defs.StarTrackerDisplayLoSSettings = {
"properties" : {
"name" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Name."
},
"b" : {
"type" : "number",
@@ -17041,7 +21080,8 @@ margin-bottom: 20px;
defs.StarTrackerDisplayLoSSettings_2 = {
"properties" : {
"name" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Name."
},
"b" : {
"type" : "number",
@@ -17103,7 +21143,9 @@ margin-bottom: 20px;
"properties" : {
"runningState" : {
"type" : "integer",
- "description" : "Running state\n * 0 - not started\n * 1 - idle\n * 2 - running\n * 3 - error\n"
+ "description" : "Running state\n * 0 - not started\n * 1 - idle\n * 2 - running\n * 3 - error\n",
+ "minimum" : 0,
+ "maximum" : 3
}
},
"description" : "RigCtl server report"
@@ -17155,12 +21197,16 @@ margin-bottom: 20px;
"latitude" : {
"type" : "number",
"format" : "float",
- "description" : "Latitude in decimal degrees (North positive) of observation/antenna location"
+ "description" : "Latitude in decimal degrees (North positive) of observation/antenna location",
+ "minimum" : -90,
+ "maximum" : 90
},
"longitude" : {
"type" : "number",
"format" : "float",
- "description" : "Longitude in decimal degrees (East positive) of observation/antenna location"
+ "description" : "Longitude in decimal degrees (East positive) of observation/antenna location",
+ "minimum" : -180,
+ "maximum" : 180
},
"dateTime" : {
"type" : "string",
@@ -17202,7 +21248,9 @@ margin-bottom: 20px;
},
"stellariumServerEnabled" : {
"type" : "integer",
- "description" : "Enable Stellarium server (1 for yes, 0 for no)"
+ "description" : "Enable Stellarium server (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"stellariumPort" : {
"type" : "integer",
@@ -17230,28 +21278,39 @@ margin-bottom: 20px;
"description" : "Draw the overhead position of the target Star on the Map (1 for yes, 0 for no)"
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIFeatureSetIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Feature-set index used by the reverse API peer."
},
"reverseAPIFeatureIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Feature index used by the reverse API peer."
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -17435,20 +21494,28 @@ margin-bottom: 20px;
defs.TestMISettings = {
"properties" : {
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"streams" : {
"type" : "array",
@@ -17463,18 +21530,22 @@ margin-bottom: 20px;
defs.TestMOSyncSettings = {
"properties" : {
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"centerFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Device center frequency in Hz."
},
"sampleRate" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Sample rate in samples per second."
},
"log2Interp" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent of the software interpolation factor; the output sample rate is multiplied by 2^log2Interp."
},
"fcPosTx" : {
"type" : "integer",
@@ -17491,56 +21562,72 @@ margin-bottom: 20px;
},
"centerFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Device center frequency in Hz."
},
"frequencyShift" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Frequency shift in Hz."
},
"sampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Sample rate in samples per second."
},
"log2Decim" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent of the software decimation factor; the output sample rate is divided by 2^log2Decim."
},
"fcPos" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Position of the decimated passband relative to the device center frequency."
},
"sampleSizeIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Selected sample size index."
},
"amplitudeBits" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Amplitude bits for Definitions."
},
"autoCorrOptions" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Auto corr options for Definitions."
},
"modulation" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Modulation for Definitions."
},
"modulationTone" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Modulation tone for Definitions."
},
"amModulation" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Am modulation for Definitions."
},
"fmDeviation" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "FM frequency deviation in Hz."
},
"dcFactor" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Dc factor for Definitions."
},
"iFactor" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "I factor for Definitions."
},
"qFactor" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Q factor for Definitions."
},
"phaseImbalance" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Phase imbalance for Definitions."
}
},
"description" : "TestMiStreamSettings"
@@ -17548,73 +21635,97 @@ margin-bottom: 20px;
defs.TestSourceSettings = {
"properties" : {
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"centerFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Device center frequency in Hz."
},
"frequencyShift" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Frequency shift in Hz."
},
"sampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Sample rate in samples per second."
},
"log2Decim" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent of the software decimation factor; the output sample rate is divided by 2^log2Decim."
},
"fcPos" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Position of the decimated passband relative to the device center frequency."
},
"sampleSizeIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Selected sample size index."
},
"amplitudeBits" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Amplitude bits setting for Test source."
},
"autoCorrOptions" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Auto corr options setting for Test source."
},
"modulation" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Modulation setting for Test source."
},
"modulationTone" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Modulation tone setting for Test source."
},
"amModulation" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Am modulation setting for Test source."
},
"fmDeviation" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "FM frequency deviation in Hz."
},
"dcFactor" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Dc factor setting for Test source."
},
"iFactor" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "I factor setting for Test source."
},
"qFactor" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Q factor setting for Test source."
},
"phaseImbalance" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Phase imbalance setting for Test source."
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
}
},
"description" : "TestSource"
@@ -17714,10 +21825,12 @@ margin-bottom: 20px;
"description" : "Level in real units"
},
"triggerLevelCoarse" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Trigger level coarse for Trigger data."
},
"triggerLevelFine" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Trigger level fine for Trigger data."
},
"triggerPositiveEdge" : {
"type" : "integer",
@@ -17741,10 +21854,12 @@ margin-bottom: 20px;
"description" : "Trigger delay as a multiplier of trace length"
},
"triggerDelayCoarse" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Trigger delay coarse for Trigger data."
},
"triggerDelayFine" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Trigger delay fine for Trigger data."
},
"triggerRepeat" : {
"type" : "integer",
@@ -17789,7 +21904,8 @@ margin-bottom: 20px;
"description" : "squelch status (1 if open else 0)"
},
"inputSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Input sample rate in samples per second."
}
},
"description" : "UDPSink"
@@ -17798,29 +21914,37 @@ margin-bottom: 20px;
"properties" : {
"outputSampleRate" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Output sample rate in samples per second."
},
"sampleFormat" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Sample format setting for UDP sink."
},
"inputFrequencyOffset" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Channel frequency offset from the device center frequency in Hz."
},
"rfBandwidth" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "RF bandwidth in Hz."
},
"fmDeviation" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "FM frequency deviation in Hz."
},
"channelMute" : {
"type" : "integer",
- "description" : "channel mute (1 if muted else 0)"
+ "description" : "channel mute (1 if muted else 0)",
+ "minimum" : 0,
+ "maximum" : 1
},
"gain" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Gain setting; units and available values depend on the device or plugin."
},
"squelchDB" : {
"type" : "integer",
@@ -17832,22 +21956,31 @@ margin-bottom: 20px;
},
"squelchEnabled" : {
"type" : "integer",
- "description" : "squelch enable (1 if enabled else 0)"
+ "description" : "squelch enable (1 if enabled else 0)",
+ "minimum" : 0,
+ "maximum" : 1
},
"agc" : {
"type" : "integer",
- "description" : "AGC enable (1 if enabled else 0)"
+ "description" : "AGC enable (1 if enabled else 0)",
+ "minimum" : 0,
+ "maximum" : 1
},
"audioActive" : {
"type" : "integer",
- "description" : "Audio return enable (1 if enabled else 0)"
+ "description" : "Audio return enable (1 if enabled else 0)",
+ "minimum" : 0,
+ "maximum" : 1
},
"audioStereo" : {
"type" : "integer",
- "description" : "Audio return stereo (1 if stereo else 0)"
+ "description" : "Audio return stereo (1 if stereo else 0)",
+ "minimum" : 0,
+ "maximum" : 1
},
"volume" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Audio volume multiplier."
},
"udpAddress" : {
"type" : "string",
@@ -17856,7 +21989,9 @@ margin-bottom: 20px;
"udpPort" : {
"type" : "integer",
"format" : "uint16",
- "description" : "destination UDP port (remote)"
+ "description" : "destination UDP port (remote)",
+ "minimum" : 1,
+ "maximum" : 65535
},
"audioPort" : {
"type" : "integer",
@@ -17864,10 +21999,12 @@ margin-bottom: 20px;
"description" : "audio return UDP port (local)"
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"streamIndex" : {
"type" : "integer",
@@ -17875,27 +22012,38 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"spectrumConfig" : {
+ "description" : "Spectrum-display configuration.",
"$ref" : "#/definitions/GLSpectrum"
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -17922,7 +22070,8 @@ margin-bottom: 20px;
"description" : "buffer R/W balance indicator"
},
"channelSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Effective sample rate delivered to the channel in samples per second."
}
},
"description" : "UDPSource"
@@ -17930,78 +22079,106 @@ margin-bottom: 20px;
defs.UDPSourceSettings = {
"properties" : {
"sampleFormat" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Sample format setting for UDP source."
},
"inputSampleRate" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Input sample rate in samples per second."
},
"inputFrequencyOffset" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Channel frequency offset from the device center frequency in Hz."
},
"rfBandwidth" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "RF bandwidth in Hz."
},
"lowCutoff" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Lower filter cutoff frequency in Hz."
},
"fmDeviation" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "FM frequency deviation in Hz."
},
"amModFactor" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Am mod factor setting for UDP source."
},
"channelMute" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Mute the channel output (1 muted, 0 unmuted).",
+ "minimum" : 0,
+ "maximum" : 1
},
"gainIn" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Gain in setting for UDP source."
},
"gainOut" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Gain out setting for UDP source."
},
"squelch" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Squelch threshold in dB."
},
"squelchGate" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Squelch gate duration."
},
"squelchEnabled" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable squelch (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"autoRWBalance" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Auto rw balance setting for UDP source."
},
"stereoInput" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Stereo input setting for UDP source."
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"udpAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name used for UDP traffic."
},
"udpPort" : {
"type" : "integer",
- "format" : "uint16"
+ "format" : "uint16",
+ "description" : "UDP port number.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"multicastAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IP multicast group address."
},
"multicastJoin" : {
"type" : "integer",
- "description" : "Join multicast group * 0 - leave group * 1 - join group\n"
+ "description" : "Join multicast group * 0 - leave group * 1 - join group\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"streamIndex" : {
"type" : "integer",
@@ -18009,27 +22186,38 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"spectrumConfig" : {
+ "description" : "Spectrum-display configuration.",
"$ref" : "#/definitions/GLSpectrum"
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -18043,13 +22231,17 @@ margin-bottom: 20px;
},
"streamActive" : {
"type" : "integer",
- "description" : "1 if active else 0"
+ "description" : "1 if active else 0",
+ "minimum" : 0,
+ "maximum" : 1
},
"overrunCount" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Number of stream overrun events."
},
"timeoutCount" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Number of timeout events or items."
}
},
"description" : "USRP"
@@ -18057,70 +22249,98 @@ margin-bottom: 20px;
defs.USRPInputSettings = {
"properties" : {
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"centerFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Device center frequency in Hz."
},
"devSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device I/Q sample rate in samples per second before software decimation or interpolation."
},
"loOffset" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "LO offset setting for Usrp input."
},
"dcBlock" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable DSP DC-offset correction (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"iqCorrection" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable I/Q imbalance correction (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"log2SoftDecim" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent of the software decimation factor."
},
"lpfBW" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Analog low-pass filter bandwidth in Hz."
},
"antennaPath" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Selected RF antenna path."
},
"gain" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Gain setting; units and available values depend on the device or plugin."
},
"gainMode" : {
"type" : "integer",
"description" : "0 for auto, 1 for manual"
},
"clockSource" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Clock source setting for Usrp input."
},
"transverterMode" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable transverter frequency translation (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"transverterDeltaFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Frequency translation applied in transverter mode in Hz."
},
"gpioDir" : {
"type" : "integer",
- "format" : "int8"
+ "format" : "int8",
+ "description" : "GPIO direction bit mask, with one bit per pin."
},
"gpioPins" : {
"type" : "integer",
- "format" : "int8"
+ "format" : "int8",
+ "description" : "GPIO pin-state bit mask, with one bit per pin."
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
}
},
"description" : "USRP"
@@ -18133,13 +22353,17 @@ margin-bottom: 20px;
},
"streamActive" : {
"type" : "integer",
- "description" : "1 if active else 0"
+ "description" : "1 if active else 0",
+ "minimum" : 0,
+ "maximum" : 1
},
"underrunCount" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Number of stream underrun events."
},
"droppedPacketsCount" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Number of dropped packets."
}
},
"description" : "USRP"
@@ -18147,60 +22371,82 @@ margin-bottom: 20px;
defs.USRPOutputSettings = {
"properties" : {
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"centerFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Device center frequency in Hz."
},
"devSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device I/Q sample rate in samples per second before software decimation or interpolation."
},
"loOffset" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "LO offset setting for Usrp output."
},
"log2SoftInterp" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent of the software interpolation factor."
},
"lpfBW" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Analog low-pass filter bandwidth in Hz."
},
"gain" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Gain setting; units and available values depend on the device or plugin."
},
"antennaPath" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Selected RF antenna path."
},
"clockSource" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Clock source setting for Usrp output."
},
"transverterMode" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Enable transverter frequency translation (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"transverterDeltaFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Frequency translation applied in transverter mode in Hz."
},
"gpioDir" : {
"type" : "integer",
- "format" : "int8"
+ "format" : "int8",
+ "description" : "GPIO direction bit mask, with one bit per pin."
},
"gpioPins" : {
"type" : "integer",
- "format" : "int8"
+ "format" : "int8",
+ "description" : "GPIO pin-state bit mask, with one bit per pin."
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
}
},
"description" : "USRP"
@@ -18217,11 +22463,13 @@ margin-bottom: 20px;
"description" : "squelch status (1 if open else 0)"
},
"audioSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Audio sample rate in samples per second."
},
"volume" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Audio volume multiplier."
},
"navId" : {
"type" : "integer",
@@ -18244,15 +22492,21 @@ margin-bottom: 20px;
},
"validRadial" : {
"type" : "integer",
- "description" : "Radial validity estimation\n * 0 - Radial is invalid\n * 1 - Radial is valid\n"
+ "description" : "Radial validity estimation\n * 0 - Radial is invalid\n * 1 - Radial is valid\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"validRefMag" : {
"type" : "integer",
- "description" : "Reference signal magnitude validity\n * 0 - Magnitude below threshold\n * 1 - Magnitude above threshold\n"
+ "description" : "Reference signal magnitude validity\n * 0 - Magnitude below threshold\n * 1 - Magnitude above threshold\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"validVarMag" : {
"type" : "integer",
- "description" : "Variable signal magnitude validity\n * 0 - Magnitude below threshold\n * 1 - Magnitude above threshold\n"
+ "description" : "Variable signal magnitude validity\n * 0 - Magnitude below threshold\n * 1 - Magnitude above threshold\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"morseIdent" : {
"type" : "string",
@@ -18265,7 +22519,8 @@ margin-bottom: 20px;
"properties" : {
"inputFrequencyOffset" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Channel frequency offset from the device center frequency in Hz."
},
"navId" : {
"type" : "integer",
@@ -18278,22 +22533,30 @@ margin-bottom: 20px;
},
"volume" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Audio volume multiplier."
},
"audioMute" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Mute audio output (1 muted, 0 unmuted).",
+ "minimum" : 0,
+ "maximum" : 1
},
"identBandpassEnable" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Ident bandpass enable setting for Vor demod."
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"audioDeviceName" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Name of the audio device to use."
},
"streamIndex" : {
"type" : "integer",
@@ -18301,28 +22564,38 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"identThreshold" : {
"type" : "integer",
"description" : "Morse code ident threshold (linear SNR)"
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -18332,7 +22605,9 @@ margin-bottom: 20px;
"properties" : {
"run" : {
"type" : "integer",
- "description" : "Set the plugin running state\n * 0 - idle\n * 1 - run\n"
+ "description" : "Set the plugin running state\n * 0 - idle\n * 1 - run\n",
+ "minimum" : 0,
+ "maximum" : 1
}
},
"description" : "VORLocalizer"
@@ -18341,7 +22616,9 @@ margin-bottom: 20px;
"properties" : {
"runningState" : {
"type" : "integer",
- "description" : "Running state\n * 0 - not started\n * 1 - idle\n * 2 - running\n * 3 - error\n"
+ "description" : "Running state\n * 0 - not started\n * 1 - idle\n * 2 - running\n * 3 - error\n",
+ "minimum" : 0,
+ "maximum" : 3
}
},
"description" : "VORLocalizers"
@@ -18349,26 +22626,36 @@ margin-bottom: 20px;
defs.VORLocalizerSettings = {
"properties" : {
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIFeatureSetIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Feature-set index used by the reverse API peer."
},
"reverseAPIFeatureIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Feature index used by the reverse API peer."
},
"magDecAdjust" : {
"type" : "integer",
@@ -18380,23 +22667,28 @@ margin-bottom: 20px;
},
"forceRRAveraging" : {
"type" : "integer",
- "description" : "Force radial and signal magnitudes averaging over the round robin turn\n * 0 - Do not force averaging\n * 1 - Force averaging\n"
+ "description" : "Force radial and signal magnitudes averaging over the round robin turn\n * 0 - Do not force averaging\n * 1 - Force averaging\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"centerShift" : {
"type" : "integer",
"description" : "Shift of center frequency in Hz"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
},
"columnIndexes" : {
"type" : "array",
+ "description" : "List of column indexes.",
"items" : {
"type" : "integer"
}
},
"columnSizes" : {
"type" : "array",
+ "description" : "List of column sizes.",
"items" : {
"type" : "integer"
}
@@ -18416,10 +22708,12 @@ margin-bottom: 20px;
"description" : "Audio squelch status (1 if open else 0)"
},
"audioSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Audio sample rate in samples per second."
},
"channelSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Effective sample rate delivered to the channel in samples per second."
}
},
"description" : "WDSPRx"
@@ -18428,18 +22722,23 @@ margin-bottom: 20px;
"properties" : {
"inputFrequencyOffset" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Channel frequency offset from the device center frequency in Hz."
},
"profileIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Selected profile index."
},
"demod" : {
"type" : "integer",
- "description" : "Demodulator type:\n * 0 - SSB\n * 1 - AM\n * 2 - SAM\n * 3 - FM\n"
+ "description" : "Demodulator type:\n * 0 - SSB\n * 1 - AM\n * 2 - SAM\n * 3 - FM\n",
+ "minimum" : 0,
+ "maximum" : 3
},
"volume" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Audio volume multiplier."
},
"audioBinaural" : {
"type" : "integer",
@@ -18455,15 +22754,21 @@ margin-bottom: 20px;
},
"audioMute" : {
"type" : "integer",
- "description" : "Mute audio (1 if muted else 0)"
+ "description" : "Mute audio (1 if muted else 0)",
+ "minimum" : 0,
+ "maximum" : 1
},
"agc" : {
"type" : "integer",
- "description" : "AGC (1 if AGC active else 0)"
+ "description" : "AGC (1 if AGC active else 0)",
+ "minimum" : 0,
+ "maximum" : 1
},
"agcMode" : {
"type" : "integer",
- "description" : "AGC Mode:\n * 0 - Long\n * 1 - Slow\n * 2 - Medium\n * 3 - Fast\n"
+ "description" : "AGC Mode:\n * 0 - Long\n * 1 - Slow\n * 2 - Medium\n * 3 - Fast\n",
+ "minimum" : 0,
+ "maximum" : 3
},
"agcGain" : {
"type" : "integer",
@@ -18474,19 +22779,26 @@ margin-bottom: 20px;
"description" : "Slope in centi-Bels"
},
"agcHangThreshold" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Agc hang threshold setting for Wdsp receive."
},
"dnb" : {
"type" : "integer",
- "description" : "Digital Noise Blanker:\n * 0 - Off\n * 1 - On\n"
+ "description" : "Digital Noise Blanker:\n * 0 - Off\n * 1 - On\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"nbScheme" : {
"type" : "integer",
- "description" : "Noise blanker scheme:\n * 0 - NB or Preemptive Wideband Noise Blanker\n * 1 - NB2 or Interpolating Wideband Noise Blanker\n"
+ "description" : "Noise blanker scheme:\n * 0 - NB or Preemptive Wideband Noise Blanker\n * 1 - NB2 or Interpolating Wideband Noise Blanker\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"nb2Mode" : {
"type" : "integer",
- "description" : "NB2 Noise blanking mode:\n * 0 - Zero mode (estimate as zero)\n * 1 - Sample‐hold (take the value of non‐corrupt signal at the beginning of the impulse and hold that throughout the corrupt sequence)\n * 2 - Mean‐hold (average the non‐corrupt values at the beginning and end of the corrupt sequence and use that as the estimate during the corrupt sequence)\n * 3 - hold‐sample (take the value of non‐corrupt signal at the end of the impulse and hold that throughout the corrupt sequence)\n * 4 - linearly interpolate across the corrupt sequence.\n"
+ "description" : "NB2 Noise blanking mode:\n * 0 - Zero mode (estimate as zero)\n * 1 - Sample‐hold (take the value of non‐corrupt signal at the beginning of the impulse and hold that throughout the corrupt sequence)\n * 2 - Mean‐hold (average the non‐corrupt values at the beginning and end of the corrupt sequence and use that as the estimate during the corrupt sequence)\n * 3 - hold‐sample (take the value of non‐corrupt signal at the end of the impulse and hold that throughout the corrupt sequence)\n * 4 - linearly interpolate across the corrupt sequence.\n",
+ "minimum" : 0,
+ "maximum" : 4
},
"nbSlewTime" : {
"type" : "number",
@@ -18504,47 +22816,67 @@ margin-bottom: 20px;
"description" : "Hang time (S)"
},
"nbThreshold" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Nb threshold setting for Wdsp receive."
},
"nbAvgTime" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Nb avg time setting for Wdsp receive."
},
"dnr" : {
"type" : "integer",
- "description" : "Digital Noise Reduction:\n * 0 - Off\n * 1 - On\n"
+ "description" : "Digital Noise Reduction:\n * 0 - Off\n * 1 - On\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"anf" : {
"type" : "integer",
- "description" : "Automatic Notch Filter:\n * 0 - Off\n * 1 - On\n"
+ "description" : "Automatic Notch Filter:\n * 0 - Off\n * 1 - On\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"nrScheme" : {
"type" : "integer",
- "description" : "Noise Reduction Scheme:\n * 0 - NR or LMS Noise Reduction\n * 1 - NR2 or Spectral Noise Reduction\n"
+ "description" : "Noise Reduction Scheme:\n * 0 - NR or LMS Noise Reduction\n * 1 - NR2 or Spectral Noise Reduction\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"nr2Gain" : {
"type" : "integer",
- "description" : "Noise Reduction gain for NR2:\n * 0 - Linear\n * 1 - Log\n * 2 - Gamma\n"
+ "description" : "Noise Reduction gain for NR2:\n * 0 - Linear\n * 1 - Log\n * 2 - Gamma\n",
+ "minimum" : 0,
+ "maximum" : 2
},
"nr2NPE" : {
"type" : "integer",
- "description" : "Noise Power Estimation algorithm for NR2:\n * 0 - Optimal Smoothing Minimum Statistics (OSMS)\n * 1 - Minimum Mean‐Square Error (MMSE)\n"
+ "description" : "Noise Power Estimation algorithm for NR2:\n * 0 - Optimal Smoothing Minimum Statistics (OSMS)\n * 1 - Minimum Mean‐Square Error (MMSE)\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"nrPosition" : {
"type" : "integer",
- "description" : "Noise reduction position:\n * 0 - Before AGC\n * 1 - After AGC\n"
+ "description" : "Noise reduction position:\n * 0 - Before AGC\n * 1 - After AGC\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"nr2ArtifactReduction" : {
"type" : "integer",
- "description" : "NR2 artifacts reduction:\n * 0 - Off\n * 1 - On\n"
+ "description" : "NR2 artifacts reduction:\n * 0 - Off\n * 1 - On\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"amFadeLevel" : {
"type" : "integer",
- "description" : "AM fade levelling:\n * 0 - Off\n * 1 - On\n"
+ "description" : "AM fade levelling:\n * 0 - Off\n * 1 - On\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"cwPeaking" : {
"type" : "integer",
- "description" : "CW peaking filter:\n * 0 - Off\n * 1 - On\n"
+ "description" : "CW peaking filter:\n * 0 - Off\n * 1 - On\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"cwPeakFrequency" : {
"type" : "number",
@@ -18578,7 +22910,9 @@ margin-bottom: 20px;
},
"fmAFLimiter" : {
"type" : "integer",
- "description" : "FM Audio level limiter (audio AGC)\n * 0 - Off\n * 1 - On\n"
+ "description" : "FM Audio level limiter (audio AGC)\n * 0 - Off\n * 1 - On\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"fmAFLimiterGain" : {
"type" : "number",
@@ -18587,7 +22921,9 @@ margin-bottom: 20px;
},
"fmCTCSSNotch" : {
"type" : "integer",
- "description" : "FM CTCSS notch filter\n * 0 - Off\n * 1 - On\n"
+ "description" : "FM CTCSS notch filter\n * 0 - Off\n * 1 - On\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"fmCTCSSNotchFrequency" : {
"type" : "number",
@@ -18596,7 +22932,9 @@ margin-bottom: 20px;
},
"squelch" : {
"type" : "integer",
- "description" : "Squelch:\n * 0 - Off\n * 1 - On\n"
+ "description" : "Squelch:\n * 0 - Off\n * 1 - On\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"squelchThreshold" : {
"type" : "integer",
@@ -18604,12 +22942,16 @@ margin-bottom: 20px;
},
"squelchMode" : {
"type" : "integer",
- "description" : "Squelch mode:\n * 0 - Voice squelch (for SSB). Based on voice artifacts.\n * 1 - AM squelch (for AM, SAM, CW). Signal power based.\n * 2 - FM squelch (for FM). Demod noise based squelch\n"
+ "description" : "Squelch mode:\n * 0 - Voice squelch (for SSB). Based on voice artifacts.\n * 1 - AM squelch (for AM, SAM, CW). Signal power based.\n * 2 - FM squelch (for FM). Demod noise based squelch\n",
+ "minimum" : 0,
+ "maximum" : 2
},
"ssqlTauMute" : {
"type" : "number",
"format" : "float",
- "description" : "Voice squelch tau mute (s)"
+ "description" : "Voice squelch tau mute (s)",
+ "minimum" : 0,
+ "maximum" : 1
},
"ssqlTauUnmute" : {
"type" : "number",
@@ -18623,7 +22965,9 @@ margin-bottom: 20px;
},
"equalizer" : {
"type" : "integer",
- "description" : "AF equalizer:\n * 0 - Off\n * 1 - On\n"
+ "description" : "AF equalizer:\n * 0 - Off\n * 1 - On\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"eqF" : {
"type" : "array",
@@ -18643,7 +22987,9 @@ margin-bottom: 20px;
},
"rit" : {
"type" : "integer",
- "description" : "RIT:\n * 0 - Off\n * 1 - On\n"
+ "description" : "RIT:\n * 0 - Off\n * 1 - On\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"ritFrequency" : {
"type" : "number",
@@ -18651,28 +22997,36 @@ margin-bottom: 20px;
"description" : "RIT shift frequency (Hz)"
},
"spanLog2" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent controlling the displayed or processed frequency span."
},
"rfBandwidth" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "RF bandwidth in Hz."
},
"lowCutoff" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Lower filter cutoff frequency in Hz."
},
"fftWindow" : {
"type" : "integer",
- "description" : "FFT Window index (FFTWindow::Function):\n * 0 - Blackman-Harris 4 term\n * 1 - Blackman-Harris 7 term\n"
+ "description" : "FFT Window index (FFTWindow::Function):\n * 0 - Blackman-Harris 4 term\n * 1 - Blackman-Harris 7 term\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"audioDeviceName" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Name of the audio device to use."
},
"streamIndex" : {
"type" : "integer",
@@ -18680,27 +23034,38 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"spectrumConfig" : {
+ "description" : "Spectrum-display configuration.",
"$ref" : "#/definitions/GLSpectrum"
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -18718,10 +23083,12 @@ margin-bottom: 20px;
"description" : "squelch status (1 if open else 0)"
},
"audioSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Audio sample rate in samples per second."
},
"channelSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Effective sample rate delivered to the channel in samples per second."
}
},
"description" : "WFMDemod"
@@ -18730,36 +23097,46 @@ margin-bottom: 20px;
"properties" : {
"inputFrequencyOffset" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Channel frequency offset from the device center frequency in Hz."
},
"rfBandwidth" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "RF bandwidth in Hz."
},
"afBandwidth" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Audio-frequency bandwidth in Hz."
},
"volume" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Audio volume multiplier."
},
"squelch" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Squelch threshold in dB."
},
"audioMute" : {
"type" : "integer",
- "description" : "audio mute (1 if muted else 0)"
+ "description" : "audio mute (1 if muted else 0)",
+ "minimum" : 0,
+ "maximum" : 1
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"audioDeviceName" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Name of the audio device to use."
},
"streamIndex" : {
"type" : "integer",
@@ -18767,24 +23144,34 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -18798,10 +23185,12 @@ margin-bottom: 20px;
"description" : "power transmitted in channel (dB)"
},
"audioSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Audio sample rate in samples per second."
},
"channelSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Effective sample rate delivered to the channel in samples per second."
}
},
"description" : "WFMMod"
@@ -18810,45 +23199,61 @@ margin-bottom: 20px;
"properties" : {
"inputFrequencyOffset" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Channel frequency offset from the device center frequency in Hz."
},
"rfBandwidth" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "RF bandwidth in Hz."
},
"afBandwidth" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Audio-frequency bandwidth in Hz."
},
"fmDeviation" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "FM frequency deviation in Hz."
},
"toneFrequency" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Tone frequency in Hz."
},
"volumeFactor" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Volume factor setting for Wfm mod."
},
"channelMute" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Mute the channel output (1 muted, 0 unmuted).",
+ "minimum" : 0,
+ "maximum" : 1
},
"playLoop" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Loop playback at end of file (1 enabled, 0 disabled).",
+ "minimum" : 0,
+ "maximum" : 1
},
"rgbColor" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Display color encoded as an RGB integer."
},
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"audioDeviceName" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "Name of the audio device to use."
},
"modAFInput" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Audio-frequency modulation input selection."
},
"streamIndex" : {
"type" : "integer",
@@ -18856,27 +23261,38 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"reverseAPIChannelIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Channel index used by the reverse API peer."
},
"cwKeyer" : {
+ "description" : "CW keyer configuration.",
"$ref" : "#/definitions/CWKeyerSettings"
},
"channelMarker" : {
+ "description" : "Channel-marker display configuration.",
"$ref" : "#/definitions/ChannelMarker"
},
"rollupState" : {
+ "description" : "Saved expanded or collapsed state of the GUI sections.",
"$ref" : "#/definitions/RollupState"
}
},
@@ -18899,14 +23315,17 @@ margin-bottom: 20px;
"description" : "1 if info was successfully retrieved else 0"
},
"fifoSize" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "FIFO capacity in samples."
},
"fifoFill" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Current FIFO fill level."
},
"temperature" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Reported device temperature."
},
"gpsLock" : {
"type" : "integer",
@@ -18918,28 +23337,37 @@ margin-bottom: 20px;
defs.XtrxInputSettings = {
"properties" : {
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"centerFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Device center frequency in Hz."
},
"devSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device I/Q sample rate in samples per second before software decimation or interpolation."
},
"log2HardDecim" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent of the hardware decimation factor."
},
"dcBlock" : {
"type" : "integer",
- "description" : "Software DC blocking (1 for yes, 0 for no)"
+ "description" : "Software DC blocking (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"iqCorrection" : {
"type" : "integer",
- "description" : "Software IQ imbalance correction (1 for yes, 0 for no)"
+ "description" : "Software IQ imbalance correction (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"log2SoftDecim" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent of the software decimation factor."
},
"lpfBW" : {
"type" : "integer",
@@ -18951,7 +23379,9 @@ margin-bottom: 20px;
},
"ncoEnable" : {
"type" : "integer",
- "description" : "Enable TSP NCO and mixing (1 for yes, 0 for no)"
+ "description" : "Enable TSP NCO and mixing (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"ncoFrequency" : {
"type" : "integer",
@@ -18979,7 +23409,9 @@ margin-bottom: 20px;
},
"extClock" : {
"type" : "integer",
- "description" : "Use external clock source (1 for yes, 0 for no)"
+ "description" : "Use external clock source (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"extClockFreq" : {
"type" : "integer",
@@ -18991,20 +23423,29 @@ margin-bottom: 20px;
},
"iqOrder" : {
"type" : "integer",
- "description" : "IQ samples order\n * 0 - Q then I (swapped)\n * 1 - I then Q (straight)\n"
+ "description" : "IQ samples order\n * 0 - Q then I (swapped)\n * 1 - I then Q (straight)\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
}
},
"description" : "XTRX"
@@ -19016,30 +23457,37 @@ margin-bottom: 20px;
"description" : "1 if info was successfully retrieved else 0"
},
"fifoSize" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "FIFO capacity in samples."
},
"fifoFillRx" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Current receive FIFO fill level."
},
"fifoFillTx" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Current transmit FIFO fill level."
},
"temperature" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Reported device temperature."
},
"gpsLock" : {
"type" : "integer",
"description" : "1 if GPSDO is locked else 0"
},
"actualInputRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Reported actual input rate."
},
"actualOutputRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Reported actual output rate."
},
"clockGenRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Reported clock gen rate."
}
},
"description" : "XTRX"
@@ -19047,11 +23495,14 @@ margin-bottom: 20px;
defs.XtrxMIMOSettings = {
"properties" : {
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"extClock" : {
"type" : "integer",
- "description" : "Boolean 1 if external clock source else 0"
+ "description" : "Boolean 1 if external clock source else 0",
+ "minimum" : 0,
+ "maximum" : 1
},
"extClockFreq" : {
"type" : "integer",
@@ -19067,7 +23518,9 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Boolean 1 use 0 do not use reverse API"
+ "description" : "Boolean 1 use 0 do not use reverse API",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
"type" : "string",
@@ -19075,13 +23528,17 @@ margin-bottom: 20px;
},
"reverseAPIPort" : {
"type" : "integer",
- "description" : "Network port from 1024 to 65535"
+ "description" : "Network port from 1024 to 65535",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
},
"rxDevSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Receive dev sample rate in samples per second."
},
"log2HardDecim" : {
"type" : "integer",
@@ -19093,15 +23550,20 @@ margin-bottom: 20px;
},
"rxCenterFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Receive center frequency in Hz."
},
"dcBlock" : {
"type" : "integer",
- "description" : "Software DC blocking (1 for yes, 0 for no)"
+ "description" : "Software DC blocking (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"iqCorrection" : {
"type" : "integer",
- "description" : "Software IQ imbalance correction (1 for yes, 0 for no)"
+ "description" : "Software IQ imbalance correction (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"ncoEnableRx" : {
"type" : "integer",
@@ -19113,11 +23575,15 @@ margin-bottom: 20px;
},
"antennaPathRx" : {
"type" : "integer",
- "description" : "Antenna selected (enum value from XTRXMIMOSettings::RxAntenna):\n * 0 - RXANT_LO low range\n * 1 - RXANT_WI wide range\n * 2 - RXANT_HI high range\n"
+ "description" : "Antenna selected (enum value from XTRXMIMOSettings::RxAntenna):\n * 0 - RXANT_LO low range\n * 1 - RXANT_WI wide range\n * 2 - RXANT_HI high range\n",
+ "minimum" : 0,
+ "maximum" : 2
},
"iqOrder" : {
"type" : "integer",
- "description" : "IQ samples order\n * 0 - Q then I (swapped)\n * 1 - I then Q (straight)\n"
+ "description" : "IQ samples order\n * 0 - Q then I (swapped)\n * 1 - I then Q (straight)\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"lpfBWRx0" : {
"type" : "integer",
@@ -19129,7 +23595,9 @@ margin-bottom: 20px;
},
"gainModeRx0" : {
"type" : "integer",
- "description" : "Gain mode (XTRXMIMOSettings::GainMode) for Rx channel 0:\n * 0 - GAIN_AUTO automatic\n * 1 - GAIN_MANUAL manual\n"
+ "description" : "Gain mode (XTRXMIMOSettings::GainMode) for Rx channel 0:\n * 0 - GAIN_AUTO automatic\n * 1 - GAIN_MANUAL manual\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"lnaGainRx0" : {
"type" : "integer",
@@ -19144,7 +23612,8 @@ margin-bottom: 20px;
"description" : "Manual PGA gain (dB) for Rx channel 0"
},
"pwrmodeRx0" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Pwrmode rx0 setting for Xtrx MIMO."
},
"lpfBWRx1" : {
"type" : "integer",
@@ -19156,7 +23625,9 @@ margin-bottom: 20px;
},
"gainModeRx1" : {
"type" : "integer",
- "description" : "Gain mode (XTRXMIMOSettings::GainMode) for Rx channel 1:\n * 0 - GAIN_AUTO automatic\n * 1 - GAIN_MANUAL manual\n"
+ "description" : "Gain mode (XTRXMIMOSettings::GainMode) for Rx channel 1:\n * 0 - GAIN_AUTO automatic\n * 1 - GAIN_MANUAL manual\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"lnaGainRx1" : {
"type" : "integer",
@@ -19171,10 +23642,12 @@ margin-bottom: 20px;
"description" : "Manual PGA gain (dB) for Rx channel 1"
},
"pwrmodeRx1" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Pwrmode rx1 setting for Xtrx MIMO."
},
"txDevSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Transmit dev sample rate in samples per second."
},
"log2HardInterp" : {
"type" : "integer",
@@ -19186,7 +23659,8 @@ margin-bottom: 20px;
},
"txCenterFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Transmit center frequency in Hz."
},
"ncoEnableTx" : {
"type" : "integer",
@@ -19198,7 +23672,9 @@ margin-bottom: 20px;
},
"antennaPathTx" : {
"type" : "integer",
- "description" : "Antenna selected (enum value from XTRXMIMOSettings::TxAntenna):\n * 0 - TXANT_HI high range\n * 1 - TXANT_WI wide range\n"
+ "description" : "Antenna selected (enum value from XTRXMIMOSettings::TxAntenna):\n * 0 - TXANT_HI high range\n * 1 - TXANT_WI wide range\n",
+ "minimum" : 0,
+ "maximum" : 1
},
"lpfBWTx0" : {
"type" : "integer",
@@ -19209,7 +23685,8 @@ margin-bottom: 20px;
"description" : "Optimally distributed gain (dB) for Tx channel 0"
},
"pwrmodeTx0" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Pwrmode tx0 setting for Xtrx MIMO."
},
"lpfBWTx1" : {
"type" : "integer",
@@ -19220,7 +23697,8 @@ margin-bottom: 20px;
"description" : "Optimally distributed gain (dB) for Tx channel 1"
},
"pwrmodeTx1" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Pwrmode tx1 setting for Xtrx MIMO."
}
},
"description" : "XTRX"
@@ -19232,14 +23710,17 @@ margin-bottom: 20px;
"description" : "1 if info was successfully retrieved else 0"
},
"fifoSize" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "FIFO capacity in samples."
},
"fifoFill" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Current FIFO fill level."
},
"temperature" : {
"type" : "number",
- "format" : "float"
+ "format" : "float",
+ "description" : "Reported device temperature."
},
"gpsLock" : {
"type" : "integer",
@@ -19251,20 +23732,25 @@ margin-bottom: 20px;
defs.XtrxOutputSettings = {
"properties" : {
"title" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "User-visible title."
},
"centerFrequency" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int64",
+ "description" : "Device center frequency in Hz."
},
"devSampleRate" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device I/Q sample rate in samples per second before software decimation or interpolation."
},
"log2HardInterp" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent of the hardware interpolation factor."
},
"log2SoftInterp" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Base-2 exponent of the software interpolation factor."
},
"lpfBW" : {
"type" : "integer",
@@ -19276,7 +23762,9 @@ margin-bottom: 20px;
},
"ncoEnable" : {
"type" : "integer",
- "description" : "Enable TSP NCO and mixing (1 for yes, 0 for no)"
+ "description" : "Enable TSP NCO and mixing (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"ncoFrequency" : {
"type" : "integer",
@@ -19288,7 +23776,9 @@ margin-bottom: 20px;
},
"extClock" : {
"type" : "integer",
- "description" : "Use external clock source (1 for yes, 0 for no)"
+ "description" : "Use external clock source (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"extClockFreq" : {
"type" : "integer",
@@ -19300,16 +23790,23 @@ margin-bottom: 20px;
},
"useReverseAPI" : {
"type" : "integer",
- "description" : "Synchronize with reverse API (1 for yes, 0 for no)"
+ "description" : "Synchronize with reverse API (1 for yes, 0 for no)",
+ "minimum" : 0,
+ "maximum" : 1
},
"reverseAPIAddress" : {
- "type" : "string"
+ "type" : "string",
+ "description" : "IPv4 address or host name of the reverse API peer."
},
"reverseAPIPort" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "TCP port of the reverse API peer.",
+ "minimum" : 1,
+ "maximum" : 65535
},
"reverseAPIDeviceIndex" : {
- "type" : "integer"
+ "type" : "integer",
+ "description" : "Device-set index used by the reverse API peer."
}
},
"description" : "XTRX"
@@ -60747,7 +65244,7 @@ except ApiException as e:
- Generated 2026-08-04T03:09:32.867+02:00
+ Generated 2026-09-06T09:56:57.532+02:00
diff --git a/swagger/sdrangel/code/qt5/client/SWGChannelReport.cpp b/swagger/sdrangel/code/qt5/client/SWGChannelReport.cpp
index a99014d2f..4c5a85da5 100644
--- a/swagger/sdrangel/code/qt5/client/SWGChannelReport.cpp
+++ b/swagger/sdrangel/code/qt5/client/SWGChannelReport.cpp
@@ -521,10 +521,10 @@ SWGChannelReport::fromJsonObject(QJsonObject &pJson) {
::SWGSDRangel::setValue(&meshtastic_demod_report, pJson["MeshtasticDemodReport"], "SWGMeshtasticDemodReport", "SWGMeshtasticDemodReport");
- ::SWGSDRangel::setValue(&meshcore_demod_report, pJson["MeshcoreDemodReport"], "SWGMeshcoreDemodReport", "SWGMeshcoreDemodReport");
-
::SWGSDRangel::setValue(&meshtastic_mod_report, pJson["MeshtasticModReport"], "SWGMeshtasticModReport", "SWGMeshtasticModReport");
+ ::SWGSDRangel::setValue(&meshcore_demod_report, pJson["MeshcoreDemodReport"], "SWGMeshcoreDemodReport", "SWGMeshcoreDemodReport");
+
::SWGSDRangel::setValue(&meshcore_mod_report, pJson["MeshcoreModReport"], "SWGMeshcoreModReport", "SWGMeshcoreModReport");
::SWGSDRangel::setValue(&navtex_demod_report, pJson["NavtexDemodReport"], "SWGNavtexDemodReport", "SWGNavtexDemodReport");
@@ -685,12 +685,12 @@ SWGChannelReport::asJsonObject() {
if((meshtastic_demod_report != nullptr) && (meshtastic_demod_report->isSet())){
toJsonValue(QString("MeshtasticDemodReport"), meshtastic_demod_report, obj, QString("SWGMeshtasticDemodReport"));
}
- if((meshcore_demod_report != nullptr) && (meshcore_demod_report->isSet())){
- toJsonValue(QString("MeshcoreDemodReport"), meshcore_demod_report, obj, QString("SWGMeshcoreDemodReport"));
- }
if((meshtastic_mod_report != nullptr) && (meshtastic_mod_report->isSet())){
toJsonValue(QString("MeshtasticModReport"), meshtastic_mod_report, obj, QString("SWGMeshtasticModReport"));
}
+ if((meshcore_demod_report != nullptr) && (meshcore_demod_report->isSet())){
+ toJsonValue(QString("MeshcoreDemodReport"), meshcore_demod_report, obj, QString("SWGMeshcoreDemodReport"));
+ }
if((meshcore_mod_report != nullptr) && (meshcore_mod_report->isSet())){
toJsonValue(QString("MeshcoreModReport"), meshcore_mod_report, obj, QString("SWGMeshcoreModReport"));
}
diff --git a/swagger/sdrangel/code/qt5/client/SWGChannelReport.h b/swagger/sdrangel/code/qt5/client/SWGChannelReport.h
index a2bc37353..b24a50bca 100644
--- a/swagger/sdrangel/code/qt5/client/SWGChannelReport.h
+++ b/swagger/sdrangel/code/qt5/client/SWGChannelReport.h
@@ -51,10 +51,10 @@
#include "SWGInmarsatDemodReport.h"
#include "SWGM17DemodReport.h"
#include "SWGM17ModReport.h"
-#include "SWGMeshtasticDemodReport.h"
-#include "SWGMeshtasticModReport.h"
#include "SWGMeshcoreDemodReport.h"
#include "SWGMeshcoreModReport.h"
+#include "SWGMeshtasticDemodReport.h"
+#include "SWGMeshtasticModReport.h"
#include "SWGNFMDemodReport.h"
#include "SWGNFMModReport.h"
#include "SWGNavtexDemodReport.h"
diff --git a/swagger/sdrangel/code/qt5/client/SWGChannelSettings.cpp b/swagger/sdrangel/code/qt5/client/SWGChannelSettings.cpp
index 0f88ae1de..0247995c2 100644
--- a/swagger/sdrangel/code/qt5/client/SWGChannelSettings.cpp
+++ b/swagger/sdrangel/code/qt5/client/SWGChannelSettings.cpp
@@ -617,10 +617,10 @@ SWGChannelSettings::fromJsonObject(QJsonObject &pJson) {
::SWGSDRangel::setValue(&meshtastic_demod_settings, pJson["MeshtasticDemodSettings"], "SWGMeshtasticDemodSettings", "SWGMeshtasticDemodSettings");
- ::SWGSDRangel::setValue(&meshcore_demod_settings, pJson["MeshcoreDemodSettings"], "SWGMeshcoreDemodSettings", "SWGMeshcoreDemodSettings");
-
::SWGSDRangel::setValue(&meshtastic_mod_settings, pJson["MeshtasticModSettings"], "SWGMeshtasticModSettings", "SWGMeshtasticModSettings");
+ ::SWGSDRangel::setValue(&meshcore_demod_settings, pJson["MeshcoreDemodSettings"], "SWGMeshcoreDemodSettings", "SWGMeshcoreDemodSettings");
+
::SWGSDRangel::setValue(&meshcore_mod_settings, pJson["MeshcoreModSettings"], "SWGMeshcoreModSettings", "SWGMeshcoreModSettings");
::SWGSDRangel::setValue(&navtex_demod_settings, pJson["NavtexDemodSettings"], "SWGNavtexDemodSettings", "SWGNavtexDemodSettings");
@@ -813,12 +813,12 @@ SWGChannelSettings::asJsonObject() {
if((meshtastic_demod_settings != nullptr) && (meshtastic_demod_settings->isSet())){
toJsonValue(QString("MeshtasticDemodSettings"), meshtastic_demod_settings, obj, QString("SWGMeshtasticDemodSettings"));
}
- if((meshcore_demod_settings != nullptr) && (meshcore_demod_settings->isSet())){
- toJsonValue(QString("MeshcoreDemodSettings"), meshcore_demod_settings, obj, QString("SWGMeshcoreDemodSettings"));
- }
if((meshtastic_mod_settings != nullptr) && (meshtastic_mod_settings->isSet())){
toJsonValue(QString("MeshtasticModSettings"), meshtastic_mod_settings, obj, QString("SWGMeshtasticModSettings"));
}
+ if((meshcore_demod_settings != nullptr) && (meshcore_demod_settings->isSet())){
+ toJsonValue(QString("MeshcoreDemodSettings"), meshcore_demod_settings, obj, QString("SWGMeshcoreDemodSettings"));
+ }
if((meshcore_mod_settings != nullptr) && (meshcore_mod_settings->isSet())){
toJsonValue(QString("MeshcoreModSettings"), meshcore_mod_settings, obj, QString("SWGMeshcoreModSettings"));
}
diff --git a/swagger/sdrangel/code/qt5/client/SWGChannelSettings.h b/swagger/sdrangel/code/qt5/client/SWGChannelSettings.h
index 4f7edd2ee..9cc730aa1 100644
--- a/swagger/sdrangel/code/qt5/client/SWGChannelSettings.h
+++ b/swagger/sdrangel/code/qt5/client/SWGChannelSettings.h
@@ -59,10 +59,10 @@
#include "SWGLocalSourceSettings.h"
#include "SWGM17DemodSettings.h"
#include "SWGM17ModSettings.h"
-#include "SWGMeshtasticDemodSettings.h"
-#include "SWGMeshtasticModSettings.h"
#include "SWGMeshcoreDemodSettings.h"
#include "SWGMeshcoreModSettings.h"
+#include "SWGMeshtasticDemodSettings.h"
+#include "SWGMeshtasticModSettings.h"
#include "SWGNFMDemodSettings.h"
#include "SWGNFMModSettings.h"
#include "SWGNavtexDemodSettings.h"
diff --git a/swagger/sdrangel/code/qt5/client/SWGFeatureActions.cpp b/swagger/sdrangel/code/qt5/client/SWGFeatureActions.cpp
index f3aaa31d7..b0607604c 100644
--- a/swagger/sdrangel/code/qt5/client/SWGFeatureActions.cpp
+++ b/swagger/sdrangel/code/qt5/client/SWGFeatureActions.cpp
@@ -50,6 +50,8 @@ SWGFeatureActions::SWGFeatureActions() {
m_per_tester_actions_isSet = false;
rig_ctl_server_actions = nullptr;
m_rig_ctl_server_actions_isSet = false;
+ mcp_server_actions = nullptr;
+ m_mcp_server_actions_isSet = false;
satellite_tracker_actions = nullptr;
m_satellite_tracker_actions_isSet = false;
simple_ptt_actions = nullptr;
@@ -94,6 +96,8 @@ SWGFeatureActions::init() {
m_per_tester_actions_isSet = false;
rig_ctl_server_actions = new SWGRigCtlServerActions();
m_rig_ctl_server_actions_isSet = false;
+ mcp_server_actions = new SWGMCPServerActions();
+ m_mcp_server_actions_isSet = false;
satellite_tracker_actions = new SWGSatelliteTrackerActions();
m_satellite_tracker_actions_isSet = false;
simple_ptt_actions = new SWGSimplePTTActions();
@@ -141,6 +145,9 @@ SWGFeatureActions::cleanup() {
if(rig_ctl_server_actions != nullptr) {
delete rig_ctl_server_actions;
}
+ if(mcp_server_actions != nullptr) {
+ delete mcp_server_actions;
+ }
if(satellite_tracker_actions != nullptr) {
delete satellite_tracker_actions;
}
@@ -197,6 +204,8 @@ SWGFeatureActions::fromJsonObject(QJsonObject &pJson) {
::SWGSDRangel::setValue(&rig_ctl_server_actions, pJson["RigCtlServerActions"], "SWGRigCtlServerActions", "SWGRigCtlServerActions");
+ ::SWGSDRangel::setValue(&mcp_server_actions, pJson["MCPServerActions"], "SWGMCPServerActions", "SWGMCPServerActions");
+
::SWGSDRangel::setValue(&satellite_tracker_actions, pJson["SatelliteTrackerActions"], "SWGSatelliteTrackerActions", "SWGSatelliteTrackerActions");
::SWGSDRangel::setValue(&simple_ptt_actions, pJson["SimplePTTActions"], "SWGSimplePTTActions", "SWGSimplePTTActions");
@@ -260,6 +269,9 @@ SWGFeatureActions::asJsonObject() {
if((rig_ctl_server_actions != nullptr) && (rig_ctl_server_actions->isSet())){
toJsonValue(QString("RigCtlServerActions"), rig_ctl_server_actions, obj, QString("SWGRigCtlServerActions"));
}
+ if((mcp_server_actions != nullptr) && (mcp_server_actions->isSet())){
+ toJsonValue(QString("MCPServerActions"), mcp_server_actions, obj, QString("SWGMCPServerActions"));
+ }
if((satellite_tracker_actions != nullptr) && (satellite_tracker_actions->isSet())){
toJsonValue(QString("SatelliteTrackerActions"), satellite_tracker_actions, obj, QString("SWGSatelliteTrackerActions"));
}
@@ -395,6 +407,16 @@ SWGFeatureActions::setRigCtlServerActions(SWGRigCtlServerActions* rig_ctl_server
this->m_rig_ctl_server_actions_isSet = true;
}
+SWGMCPServerActions*
+SWGFeatureActions::getMcpServerActions() {
+ return mcp_server_actions;
+}
+void
+SWGFeatureActions::setMcpServerActions(SWGMCPServerActions* mcp_server_actions) {
+ this->mcp_server_actions = mcp_server_actions;
+ this->m_mcp_server_actions_isSet = true;
+}
+
SWGSatelliteTrackerActions*
SWGFeatureActions::getSatelliteTrackerActions() {
return satellite_tracker_actions;
@@ -503,6 +525,9 @@ SWGFeatureActions::isSet(){
if(rig_ctl_server_actions && rig_ctl_server_actions->isSet()){
isObjectUpdated = true; break;
}
+ if(mcp_server_actions && mcp_server_actions->isSet()){
+ isObjectUpdated = true; break;
+ }
if(satellite_tracker_actions && satellite_tracker_actions->isSet()){
isObjectUpdated = true; break;
}
diff --git a/swagger/sdrangel/code/qt5/client/SWGFeatureActions.h b/swagger/sdrangel/code/qt5/client/SWGFeatureActions.h
index 1cda2aea2..3500d79d2 100644
--- a/swagger/sdrangel/code/qt5/client/SWGFeatureActions.h
+++ b/swagger/sdrangel/code/qt5/client/SWGFeatureActions.h
@@ -28,6 +28,7 @@
#include "SWGDenoiserActions.h"
#include "SWGGS232ControllerActions.h"
#include "SWGLimeRFEActions.h"
+#include "SWGMCPServerActions.h"
#include "SWGMapActions.h"
#include "SWGMorseDecoderActions.h"
#include "SWGPERTesterActions.h"
@@ -90,6 +91,9 @@ public:
SWGRigCtlServerActions* getRigCtlServerActions();
void setRigCtlServerActions(SWGRigCtlServerActions* rig_ctl_server_actions);
+ SWGMCPServerActions* getMcpServerActions();
+ void setMcpServerActions(SWGMCPServerActions* mcp_server_actions);
+
SWGSatelliteTrackerActions* getSatelliteTrackerActions();
void setSatelliteTrackerActions(SWGSatelliteTrackerActions* satellite_tracker_actions);
@@ -148,6 +152,9 @@ private:
SWGRigCtlServerActions* rig_ctl_server_actions;
bool m_rig_ctl_server_actions_isSet;
+ SWGMCPServerActions* mcp_server_actions;
+ bool m_mcp_server_actions_isSet;
+
SWGSatelliteTrackerActions* satellite_tracker_actions;
bool m_satellite_tracker_actions_isSet;
diff --git a/swagger/sdrangel/code/qt5/client/SWGFeatureReport.cpp b/swagger/sdrangel/code/qt5/client/SWGFeatureReport.cpp
index 5bb59653b..f1b986d28 100644
--- a/swagger/sdrangel/code/qt5/client/SWGFeatureReport.cpp
+++ b/swagger/sdrangel/code/qt5/client/SWGFeatureReport.cpp
@@ -46,6 +46,8 @@ SWGFeatureReport::SWGFeatureReport() {
m_per_tester_report_isSet = false;
rig_ctl_server_report = nullptr;
m_rig_ctl_server_report_isSet = false;
+ mcp_server_report = nullptr;
+ m_mcp_server_report_isSet = false;
satellite_tracker_report = nullptr;
m_satellite_tracker_report_isSet = false;
simple_ptt_report = nullptr;
@@ -82,6 +84,8 @@ SWGFeatureReport::init() {
m_per_tester_report_isSet = false;
rig_ctl_server_report = new SWGRigCtlServerReport();
m_rig_ctl_server_report_isSet = false;
+ mcp_server_report = new SWGMCPServerReport();
+ m_mcp_server_report_isSet = false;
satellite_tracker_report = new SWGSatelliteTrackerReport();
m_satellite_tracker_report_isSet = false;
simple_ptt_report = new SWGSimplePTTReport();
@@ -123,6 +127,9 @@ SWGFeatureReport::cleanup() {
if(rig_ctl_server_report != nullptr) {
delete rig_ctl_server_report;
}
+ if(mcp_server_report != nullptr) {
+ delete mcp_server_report;
+ }
if(satellite_tracker_report != nullptr) {
delete satellite_tracker_report;
}
@@ -169,6 +176,8 @@ SWGFeatureReport::fromJsonObject(QJsonObject &pJson) {
::SWGSDRangel::setValue(&rig_ctl_server_report, pJson["RigCtlServerReport"], "SWGRigCtlServerReport", "SWGRigCtlServerReport");
+ ::SWGSDRangel::setValue(&mcp_server_report, pJson["MCPServerReport"], "SWGMCPServerReport", "SWGMCPServerReport");
+
::SWGSDRangel::setValue(&satellite_tracker_report, pJson["SatelliteTrackerReport"], "SWGSatelliteTrackerReport", "SWGSatelliteTrackerReport");
::SWGSDRangel::setValue(&simple_ptt_report, pJson["SimplePTTReport"], "SWGSimplePTTReport", "SWGSimplePTTReport");
@@ -222,6 +231,9 @@ SWGFeatureReport::asJsonObject() {
if((rig_ctl_server_report != nullptr) && (rig_ctl_server_report->isSet())){
toJsonValue(QString("RigCtlServerReport"), rig_ctl_server_report, obj, QString("SWGRigCtlServerReport"));
}
+ if((mcp_server_report != nullptr) && (mcp_server_report->isSet())){
+ toJsonValue(QString("MCPServerReport"), mcp_server_report, obj, QString("SWGMCPServerReport"));
+ }
if((satellite_tracker_report != nullptr) && (satellite_tracker_report->isSet())){
toJsonValue(QString("SatelliteTrackerReport"), satellite_tracker_report, obj, QString("SWGSatelliteTrackerReport"));
}
@@ -331,6 +343,16 @@ SWGFeatureReport::setRigCtlServerReport(SWGRigCtlServerReport* rig_ctl_server_re
this->m_rig_ctl_server_report_isSet = true;
}
+SWGMCPServerReport*
+SWGFeatureReport::getMcpServerReport() {
+ return mcp_server_report;
+}
+void
+SWGFeatureReport::setMcpServerReport(SWGMCPServerReport* mcp_server_report) {
+ this->mcp_server_report = mcp_server_report;
+ this->m_mcp_server_report_isSet = true;
+}
+
SWGSatelliteTrackerReport*
SWGFeatureReport::getSatelliteTrackerReport() {
return satellite_tracker_report;
@@ -413,6 +435,9 @@ SWGFeatureReport::isSet(){
if(rig_ctl_server_report && rig_ctl_server_report->isSet()){
isObjectUpdated = true; break;
}
+ if(mcp_server_report && mcp_server_report->isSet()){
+ isObjectUpdated = true; break;
+ }
if(satellite_tracker_report && satellite_tracker_report->isSet()){
isObjectUpdated = true; break;
}
diff --git a/swagger/sdrangel/code/qt5/client/SWGFeatureReport.h b/swagger/sdrangel/code/qt5/client/SWGFeatureReport.h
index 8d6c9dec2..ea455ddfc 100644
--- a/swagger/sdrangel/code/qt5/client/SWGFeatureReport.h
+++ b/swagger/sdrangel/code/qt5/client/SWGFeatureReport.h
@@ -27,6 +27,7 @@
#include "SWGFreqDisplayReport.h"
#include "SWGGS232ControllerReport.h"
#include "SWGLimeRFEReport.h"
+#include "SWGMCPServerReport.h"
#include "SWGMapReport.h"
#include "SWGPERTesterReport.h"
#include "SWGRigCtlServerReport.h"
@@ -82,6 +83,9 @@ public:
SWGRigCtlServerReport* getRigCtlServerReport();
void setRigCtlServerReport(SWGRigCtlServerReport* rig_ctl_server_report);
+ SWGMCPServerReport* getMcpServerReport();
+ void setMcpServerReport(SWGMCPServerReport* mcp_server_report);
+
SWGSatelliteTrackerReport* getSatelliteTrackerReport();
void setSatelliteTrackerReport(SWGSatelliteTrackerReport* satellite_tracker_report);
@@ -128,6 +132,9 @@ private:
SWGRigCtlServerReport* rig_ctl_server_report;
bool m_rig_ctl_server_report_isSet;
+ SWGMCPServerReport* mcp_server_report;
+ bool m_mcp_server_report_isSet;
+
SWGSatelliteTrackerReport* satellite_tracker_report;
bool m_satellite_tracker_report_isSet;
diff --git a/swagger/sdrangel/code/qt5/client/SWGFeatureSettings.cpp b/swagger/sdrangel/code/qt5/client/SWGFeatureSettings.cpp
index 91f135b8f..cb0744f3c 100644
--- a/swagger/sdrangel/code/qt5/client/SWGFeatureSettings.cpp
+++ b/swagger/sdrangel/code/qt5/client/SWGFeatureSettings.cpp
@@ -66,6 +66,8 @@ SWGFeatureSettings::SWGFeatureSettings() {
m_radiosonde_settings_isSet = false;
rig_ctl_server_settings = nullptr;
m_rig_ctl_server_settings_isSet = false;
+ mcp_server_settings = nullptr;
+ m_mcp_server_settings_isSet = false;
satellite_tracker_settings = nullptr;
m_satellite_tracker_settings_isSet = false;
sid_settings = nullptr;
@@ -124,6 +126,8 @@ SWGFeatureSettings::init() {
m_radiosonde_settings_isSet = false;
rig_ctl_server_settings = new SWGRigCtlServerSettings();
m_rig_ctl_server_settings_isSet = false;
+ mcp_server_settings = new SWGMCPServerSettings();
+ m_mcp_server_settings_isSet = false;
satellite_tracker_settings = new SWGSatelliteTrackerSettings();
m_satellite_tracker_settings_isSet = false;
sid_settings = new SWGSIDSettings();
@@ -193,6 +197,9 @@ SWGFeatureSettings::cleanup() {
if(rig_ctl_server_settings != nullptr) {
delete rig_ctl_server_settings;
}
+ if(mcp_server_settings != nullptr) {
+ delete mcp_server_settings;
+ }
if(satellite_tracker_settings != nullptr) {
delete satellite_tracker_settings;
}
@@ -262,6 +269,8 @@ SWGFeatureSettings::fromJsonObject(QJsonObject &pJson) {
::SWGSDRangel::setValue(&rig_ctl_server_settings, pJson["RigCtlServerSettings"], "SWGRigCtlServerSettings", "SWGRigCtlServerSettings");
+ ::SWGSDRangel::setValue(&mcp_server_settings, pJson["MCPServerSettings"], "SWGMCPServerSettings", "SWGMCPServerSettings");
+
::SWGSDRangel::setValue(&satellite_tracker_settings, pJson["SatelliteTrackerSettings"], "SWGSatelliteTrackerSettings", "SWGSatelliteTrackerSettings");
::SWGSDRangel::setValue(&sid_settings, pJson["SIDSettings"], "SWGSIDSettings", "SWGSIDSettings");
@@ -347,6 +356,9 @@ SWGFeatureSettings::asJsonObject() {
if((rig_ctl_server_settings != nullptr) && (rig_ctl_server_settings->isSet())){
toJsonValue(QString("RigCtlServerSettings"), rig_ctl_server_settings, obj, QString("SWGRigCtlServerSettings"));
}
+ if((mcp_server_settings != nullptr) && (mcp_server_settings->isSet())){
+ toJsonValue(QString("MCPServerSettings"), mcp_server_settings, obj, QString("SWGMCPServerSettings"));
+ }
if((satellite_tracker_settings != nullptr) && (satellite_tracker_settings->isSet())){
toJsonValue(QString("SatelliteTrackerSettings"), satellite_tracker_settings, obj, QString("SWGSatelliteTrackerSettings"));
}
@@ -559,6 +571,16 @@ SWGFeatureSettings::setRigCtlServerSettings(SWGRigCtlServerSettings* rig_ctl_ser
this->m_rig_ctl_server_settings_isSet = true;
}
+SWGMCPServerSettings*
+SWGFeatureSettings::getMcpServerSettings() {
+ return mcp_server_settings;
+}
+void
+SWGFeatureSettings::setMcpServerSettings(SWGMCPServerSettings* mcp_server_settings) {
+ this->mcp_server_settings = mcp_server_settings;
+ this->m_mcp_server_settings_isSet = true;
+}
+
SWGSatelliteTrackerSettings*
SWGFeatureSettings::getSatelliteTrackerSettings() {
return satellite_tracker_settings;
@@ -681,6 +703,9 @@ SWGFeatureSettings::isSet(){
if(rig_ctl_server_settings && rig_ctl_server_settings->isSet()){
isObjectUpdated = true; break;
}
+ if(mcp_server_settings && mcp_server_settings->isSet()){
+ isObjectUpdated = true; break;
+ }
if(satellite_tracker_settings && satellite_tracker_settings->isSet()){
isObjectUpdated = true; break;
}
diff --git a/swagger/sdrangel/code/qt5/client/SWGFeatureSettings.h b/swagger/sdrangel/code/qt5/client/SWGFeatureSettings.h
index a03955bdb..10ebb1a4d 100644
--- a/swagger/sdrangel/code/qt5/client/SWGFeatureSettings.h
+++ b/swagger/sdrangel/code/qt5/client/SWGFeatureSettings.h
@@ -33,6 +33,7 @@
#include "SWGGS232ControllerSettings.h"
#include "SWGJogdialControllerSettings.h"
#include "SWGLimeRFESettings.h"
+#include "SWGMCPServerSettings.h"
#include "SWGMapSettings.h"
#include "SWGMorseDecoderSettings.h"
#include "SWGPERTesterSettings.h"
@@ -121,6 +122,9 @@ public:
SWGRigCtlServerSettings* getRigCtlServerSettings();
void setRigCtlServerSettings(SWGRigCtlServerSettings* rig_ctl_server_settings);
+ SWGMCPServerSettings* getMcpServerSettings();
+ void setMcpServerSettings(SWGMCPServerSettings* mcp_server_settings);
+
SWGSatelliteTrackerSettings* getSatelliteTrackerSettings();
void setSatelliteTrackerSettings(SWGSatelliteTrackerSettings* satellite_tracker_settings);
@@ -200,6 +204,9 @@ private:
SWGRigCtlServerSettings* rig_ctl_server_settings;
bool m_rig_ctl_server_settings_isSet;
+ SWGMCPServerSettings* mcp_server_settings;
+ bool m_mcp_server_settings_isSet;
+
SWGSatelliteTrackerSettings* satellite_tracker_settings;
bool m_satellite_tracker_settings_isSet;
diff --git a/swagger/sdrangel/code/qt5/client/SWGMCPServerActions.cpp b/swagger/sdrangel/code/qt5/client/SWGMCPServerActions.cpp
new file mode 100644
index 000000000..001c7c388
--- /dev/null
+++ b/swagger/sdrangel/code/qt5/client/SWGMCPServerActions.cpp
@@ -0,0 +1,108 @@
+/**
+ * SDRangel
+ * This is the web REST/JSON API of SDRangel SDR software. SDRangel is an Open Source Qt5/OpenGL 3.0+ (4.3+ in Windows) GUI and server Software Defined Radio and signal analyzer in software. It supports Airspy, BladeRF, HackRF, LimeSDR, PlutoSDR, RTL-SDR, SDRplay RSP1 and FunCube --- Limitations and specifcities: * In SDRangel GUI the first Rx device set cannot be deleted. Conversely the server starts with no device sets and its number of device sets can be reduced to zero by as many calls as necessary to /sdrangel/deviceset with DELETE method. * Preset import and export from/to file is a server only feature. * Device set focus is a GUI only feature. * The following channels are not implemented (status 501 is returned): ATV and DATV demodulators, Channel Analyzer NG, LoRa demodulator * The device settings and report structures contains only the sub-structure corresponding to the device type. The DeviceSettings and DeviceReport structures documented here shows all of them but only one will be or should be present at a time * The channel settings and report structures contains only the sub-structure corresponding to the channel type. The ChannelSettings and ChannelReport structures documented here shows all of them but only one will be or should be present at a time ---
+ *
+ * OpenAPI spec version: 7.0.0
+ * Contact: f4exb06@gmail.com
+ *
+ * NOTE: This class is auto generated by the swagger code generator program.
+ * https://github.com/swagger-api/swagger-codegen.git
+ * Do not edit the class manually.
+ */
+
+
+#include "SWGMCPServerActions.h"
+
+#include "SWGHelpers.h"
+
+#include
+#include
+#include
+#include
+
+namespace SWGSDRangel {
+
+SWGMCPServerActions::SWGMCPServerActions(QString* json) {
+ init();
+ this->fromJson(*json);
+}
+
+SWGMCPServerActions::SWGMCPServerActions() {
+ run = 0;
+ m_run_isSet = false;
+}
+
+SWGMCPServerActions::~SWGMCPServerActions() {
+ this->cleanup();
+}
+
+void
+SWGMCPServerActions::init() {
+ run = 0;
+ m_run_isSet = false;
+}
+
+void
+SWGMCPServerActions::cleanup() {
+
+}
+
+SWGMCPServerActions*
+SWGMCPServerActions::fromJson(QString &json) {
+ QByteArray array (json.toStdString().c_str());
+ QJsonDocument doc = QJsonDocument::fromJson(array);
+ QJsonObject jsonObject = doc.object();
+ this->fromJsonObject(jsonObject);
+ return this;
+}
+
+void
+SWGMCPServerActions::fromJsonObject(QJsonObject &pJson) {
+ ::SWGSDRangel::setValue(&run, pJson["run"], "qint32", "");
+
+}
+
+QString
+SWGMCPServerActions::asJson ()
+{
+ QJsonObject* obj = this->asJsonObject();
+
+ QJsonDocument doc(*obj);
+ QByteArray bytes = doc.toJson();
+ delete obj;
+ return QString(bytes);
+}
+
+QJsonObject*
+SWGMCPServerActions::asJsonObject() {
+ QJsonObject* obj = new QJsonObject();
+ if(m_run_isSet){
+ obj->insert("run", QJsonValue(run));
+ }
+
+ return obj;
+}
+
+qint32
+SWGMCPServerActions::getRun() {
+ return run;
+}
+void
+SWGMCPServerActions::setRun(qint32 run) {
+ this->run = run;
+ this->m_run_isSet = true;
+}
+
+
+bool
+SWGMCPServerActions::isSet(){
+ bool isObjectUpdated = false;
+ do{
+ if(m_run_isSet){
+ isObjectUpdated = true; break;
+ }
+ }while(false);
+ return isObjectUpdated;
+}
+}
+
diff --git a/swagger/sdrangel/code/qt5/client/SWGMCPServerActions.h b/swagger/sdrangel/code/qt5/client/SWGMCPServerActions.h
new file mode 100644
index 000000000..b335414e8
--- /dev/null
+++ b/swagger/sdrangel/code/qt5/client/SWGMCPServerActions.h
@@ -0,0 +1,58 @@
+/**
+ * SDRangel
+ * This is the web REST/JSON API of SDRangel SDR software. SDRangel is an Open Source Qt5/OpenGL 3.0+ (4.3+ in Windows) GUI and server Software Defined Radio and signal analyzer in software. It supports Airspy, BladeRF, HackRF, LimeSDR, PlutoSDR, RTL-SDR, SDRplay RSP1 and FunCube --- Limitations and specifcities: * In SDRangel GUI the first Rx device set cannot be deleted. Conversely the server starts with no device sets and its number of device sets can be reduced to zero by as many calls as necessary to /sdrangel/deviceset with DELETE method. * Preset import and export from/to file is a server only feature. * Device set focus is a GUI only feature. * The following channels are not implemented (status 501 is returned): ATV and DATV demodulators, Channel Analyzer NG, LoRa demodulator * The device settings and report structures contains only the sub-structure corresponding to the device type. The DeviceSettings and DeviceReport structures documented here shows all of them but only one will be or should be present at a time * The channel settings and report structures contains only the sub-structure corresponding to the channel type. The ChannelSettings and ChannelReport structures documented here shows all of them but only one will be or should be present at a time ---
+ *
+ * OpenAPI spec version: 7.0.0
+ * Contact: f4exb06@gmail.com
+ *
+ * NOTE: This class is auto generated by the swagger code generator program.
+ * https://github.com/swagger-api/swagger-codegen.git
+ * Do not edit the class manually.
+ */
+
+/*
+ * SWGMCPServerActions.h
+ *
+ * MCP server actions
+ */
+
+#ifndef SWGMCPServerActions_H_
+#define SWGMCPServerActions_H_
+
+#include
+
+
+
+#include "SWGObject.h"
+#include "export.h"
+
+namespace SWGSDRangel {
+
+class SWG_API SWGMCPServerActions: public SWGObject {
+public:
+ SWGMCPServerActions();
+ SWGMCPServerActions(QString* json);
+ virtual ~SWGMCPServerActions();
+ void init();
+ void cleanup();
+
+ virtual QString asJson () override;
+ virtual QJsonObject* asJsonObject() override;
+ virtual void fromJsonObject(QJsonObject &json) override;
+ virtual SWGMCPServerActions* fromJson(QString &jsonString) override;
+
+ qint32 getRun();
+ void setRun(qint32 run);
+
+
+ virtual bool isSet() override;
+
+private:
+ qint32 run;
+ bool m_run_isSet;
+
+};
+
+}
+
+#endif /* SWGMCPServerActions_H_ */
diff --git a/swagger/sdrangel/code/qt5/client/SWGMCPServerReport.cpp b/swagger/sdrangel/code/qt5/client/SWGMCPServerReport.cpp
new file mode 100644
index 000000000..669a26caf
--- /dev/null
+++ b/swagger/sdrangel/code/qt5/client/SWGMCPServerReport.cpp
@@ -0,0 +1,131 @@
+/**
+ * SDRangel
+ * This is the web REST/JSON API of SDRangel SDR software. SDRangel is an Open Source Qt5/OpenGL 3.0+ (4.3+ in Windows) GUI and server Software Defined Radio and signal analyzer in software. It supports Airspy, BladeRF, HackRF, LimeSDR, PlutoSDR, RTL-SDR, SDRplay RSP1 and FunCube --- Limitations and specifcities: * In SDRangel GUI the first Rx device set cannot be deleted. Conversely the server starts with no device sets and its number of device sets can be reduced to zero by as many calls as necessary to /sdrangel/deviceset with DELETE method. * Preset import and export from/to file is a server only feature. * Device set focus is a GUI only feature. * The following channels are not implemented (status 501 is returned): ATV and DATV demodulators, Channel Analyzer NG, LoRa demodulator * The device settings and report structures contains only the sub-structure corresponding to the device type. The DeviceSettings and DeviceReport structures documented here shows all of them but only one will be or should be present at a time * The channel settings and report structures contains only the sub-structure corresponding to the channel type. The ChannelSettings and ChannelReport structures documented here shows all of them but only one will be or should be present at a time ---
+ *
+ * OpenAPI spec version: 7.0.0
+ * Contact: f4exb06@gmail.com
+ *
+ * NOTE: This class is auto generated by the swagger code generator program.
+ * https://github.com/swagger-api/swagger-codegen.git
+ * Do not edit the class manually.
+ */
+
+
+#include "SWGMCPServerReport.h"
+
+#include "SWGHelpers.h"
+
+#include
+#include
+#include
+#include
+
+namespace SWGSDRangel {
+
+SWGMCPServerReport::SWGMCPServerReport(QString* json) {
+ init();
+ this->fromJson(*json);
+}
+
+SWGMCPServerReport::SWGMCPServerReport() {
+ running_state = 0;
+ m_running_state_isSet = false;
+ request_count = 0;
+ m_request_count_isSet = false;
+}
+
+SWGMCPServerReport::~SWGMCPServerReport() {
+ this->cleanup();
+}
+
+void
+SWGMCPServerReport::init() {
+ running_state = 0;
+ m_running_state_isSet = false;
+ request_count = 0;
+ m_request_count_isSet = false;
+}
+
+void
+SWGMCPServerReport::cleanup() {
+
+
+}
+
+SWGMCPServerReport*
+SWGMCPServerReport::fromJson(QString &json) {
+ QByteArray array (json.toStdString().c_str());
+ QJsonDocument doc = QJsonDocument::fromJson(array);
+ QJsonObject jsonObject = doc.object();
+ this->fromJsonObject(jsonObject);
+ return this;
+}
+
+void
+SWGMCPServerReport::fromJsonObject(QJsonObject &pJson) {
+ ::SWGSDRangel::setValue(&running_state, pJson["runningState"], "qint32", "");
+
+ ::SWGSDRangel::setValue(&request_count, pJson["requestCount"], "qint32", "");
+
+}
+
+QString
+SWGMCPServerReport::asJson ()
+{
+ QJsonObject* obj = this->asJsonObject();
+
+ QJsonDocument doc(*obj);
+ QByteArray bytes = doc.toJson();
+ delete obj;
+ return QString(bytes);
+}
+
+QJsonObject*
+SWGMCPServerReport::asJsonObject() {
+ QJsonObject* obj = new QJsonObject();
+ if(m_running_state_isSet){
+ obj->insert("runningState", QJsonValue(running_state));
+ }
+ if(m_request_count_isSet){
+ obj->insert("requestCount", QJsonValue(request_count));
+ }
+
+ return obj;
+}
+
+qint32
+SWGMCPServerReport::getRunningState() {
+ return running_state;
+}
+void
+SWGMCPServerReport::setRunningState(qint32 running_state) {
+ this->running_state = running_state;
+ this->m_running_state_isSet = true;
+}
+
+qint32
+SWGMCPServerReport::getRequestCount() {
+ return request_count;
+}
+void
+SWGMCPServerReport::setRequestCount(qint32 request_count) {
+ this->request_count = request_count;
+ this->m_request_count_isSet = true;
+}
+
+
+bool
+SWGMCPServerReport::isSet(){
+ bool isObjectUpdated = false;
+ do{
+ if(m_running_state_isSet){
+ isObjectUpdated = true; break;
+ }
+ if(m_request_count_isSet){
+ isObjectUpdated = true; break;
+ }
+ }while(false);
+ return isObjectUpdated;
+}
+}
+
diff --git a/swagger/sdrangel/code/qt5/client/SWGMCPServerReport.h b/swagger/sdrangel/code/qt5/client/SWGMCPServerReport.h
new file mode 100644
index 000000000..f43a652fd
--- /dev/null
+++ b/swagger/sdrangel/code/qt5/client/SWGMCPServerReport.h
@@ -0,0 +1,64 @@
+/**
+ * SDRangel
+ * This is the web REST/JSON API of SDRangel SDR software. SDRangel is an Open Source Qt5/OpenGL 3.0+ (4.3+ in Windows) GUI and server Software Defined Radio and signal analyzer in software. It supports Airspy, BladeRF, HackRF, LimeSDR, PlutoSDR, RTL-SDR, SDRplay RSP1 and FunCube --- Limitations and specifcities: * In SDRangel GUI the first Rx device set cannot be deleted. Conversely the server starts with no device sets and its number of device sets can be reduced to zero by as many calls as necessary to /sdrangel/deviceset with DELETE method. * Preset import and export from/to file is a server only feature. * Device set focus is a GUI only feature. * The following channels are not implemented (status 501 is returned): ATV and DATV demodulators, Channel Analyzer NG, LoRa demodulator * The device settings and report structures contains only the sub-structure corresponding to the device type. The DeviceSettings and DeviceReport structures documented here shows all of them but only one will be or should be present at a time * The channel settings and report structures contains only the sub-structure corresponding to the channel type. The ChannelSettings and ChannelReport structures documented here shows all of them but only one will be or should be present at a time ---
+ *
+ * OpenAPI spec version: 7.0.0
+ * Contact: f4exb06@gmail.com
+ *
+ * NOTE: This class is auto generated by the swagger code generator program.
+ * https://github.com/swagger-api/swagger-codegen.git
+ * Do not edit the class manually.
+ */
+
+/*
+ * SWGMCPServerReport.h
+ *
+ * MCP server report
+ */
+
+#ifndef SWGMCPServerReport_H_
+#define SWGMCPServerReport_H_
+
+#include
+
+
+
+#include "SWGObject.h"
+#include "export.h"
+
+namespace SWGSDRangel {
+
+class SWG_API SWGMCPServerReport: public SWGObject {
+public:
+ SWGMCPServerReport();
+ SWGMCPServerReport(QString* json);
+ virtual ~SWGMCPServerReport();
+ void init();
+ void cleanup();
+
+ virtual QString asJson () override;
+ virtual QJsonObject* asJsonObject() override;
+ virtual void fromJsonObject(QJsonObject &json) override;
+ virtual SWGMCPServerReport* fromJson(QString &jsonString) override;
+
+ qint32 getRunningState();
+ void setRunningState(qint32 running_state);
+
+ qint32 getRequestCount();
+ void setRequestCount(qint32 request_count);
+
+
+ virtual bool isSet() override;
+
+private:
+ qint32 running_state;
+ bool m_running_state_isSet;
+
+ qint32 request_count;
+ bool m_request_count_isSet;
+
+};
+
+}
+
+#endif /* SWGMCPServerReport_H_ */
diff --git a/swagger/sdrangel/code/qt5/client/SWGMCPServerSettings.cpp b/swagger/sdrangel/code/qt5/client/SWGMCPServerSettings.cpp
new file mode 100644
index 000000000..51a47975e
--- /dev/null
+++ b/swagger/sdrangel/code/qt5/client/SWGMCPServerSettings.cpp
@@ -0,0 +1,373 @@
+/**
+ * SDRangel
+ * This is the web REST/JSON API of SDRangel SDR software. SDRangel is an Open Source Qt5/OpenGL 3.0+ (4.3+ in Windows) GUI and server Software Defined Radio and signal analyzer in software. It supports Airspy, BladeRF, HackRF, LimeSDR, PlutoSDR, RTL-SDR, SDRplay RSP1 and FunCube --- Limitations and specifcities: * In SDRangel GUI the first Rx device set cannot be deleted. Conversely the server starts with no device sets and its number of device sets can be reduced to zero by as many calls as necessary to /sdrangel/deviceset with DELETE method. * Preset import and export from/to file is a server only feature. * Device set focus is a GUI only feature. * The following channels are not implemented (status 501 is returned): ATV and DATV demodulators, Channel Analyzer NG, LoRa demodulator * The device settings and report structures contains only the sub-structure corresponding to the device type. The DeviceSettings and DeviceReport structures documented here shows all of them but only one will be or should be present at a time * The channel settings and report structures contains only the sub-structure corresponding to the channel type. The ChannelSettings and ChannelReport structures documented here shows all of them but only one will be or should be present at a time ---
+ *
+ * OpenAPI spec version: 7.0.0
+ * Contact: f4exb06@gmail.com
+ *
+ * NOTE: This class is auto generated by the swagger code generator program.
+ * https://github.com/swagger-api/swagger-codegen.git
+ * Do not edit the class manually.
+ */
+
+
+#include "SWGMCPServerSettings.h"
+
+#include "SWGHelpers.h"
+
+#include
+#include
+#include
+#include
+
+namespace SWGSDRangel {
+
+SWGMCPServerSettings::SWGMCPServerSettings(QString* json) {
+ init();
+ this->fromJson(*json);
+}
+
+SWGMCPServerSettings::SWGMCPServerSettings() {
+ address = nullptr;
+ m_address_isSet = false;
+ port = 0;
+ m_port_isSet = false;
+ token = nullptr;
+ m_token_isSet = false;
+ capture_dir = nullptr;
+ m_capture_dir_isSet = false;
+ title = nullptr;
+ m_title_isSet = false;
+ rgb_color = 0;
+ m_rgb_color_isSet = false;
+ use_reverse_api = 0;
+ m_use_reverse_api_isSet = false;
+ reverse_api_address = nullptr;
+ m_reverse_api_address_isSet = false;
+ reverse_api_port = 0;
+ m_reverse_api_port_isSet = false;
+ reverse_api_feature_set_index = 0;
+ m_reverse_api_feature_set_index_isSet = false;
+ reverse_api_feature_index = 0;
+ m_reverse_api_feature_index_isSet = false;
+ rollup_state = nullptr;
+ m_rollup_state_isSet = false;
+}
+
+SWGMCPServerSettings::~SWGMCPServerSettings() {
+ this->cleanup();
+}
+
+void
+SWGMCPServerSettings::init() {
+ address = new QString("");
+ m_address_isSet = false;
+ port = 0;
+ m_port_isSet = false;
+ token = new QString("");
+ m_token_isSet = false;
+ capture_dir = new QString("");
+ m_capture_dir_isSet = false;
+ title = new QString("");
+ m_title_isSet = false;
+ rgb_color = 0;
+ m_rgb_color_isSet = false;
+ use_reverse_api = 0;
+ m_use_reverse_api_isSet = false;
+ reverse_api_address = new QString("");
+ m_reverse_api_address_isSet = false;
+ reverse_api_port = 0;
+ m_reverse_api_port_isSet = false;
+ reverse_api_feature_set_index = 0;
+ m_reverse_api_feature_set_index_isSet = false;
+ reverse_api_feature_index = 0;
+ m_reverse_api_feature_index_isSet = false;
+ rollup_state = new SWGRollupState();
+ m_rollup_state_isSet = false;
+}
+
+void
+SWGMCPServerSettings::cleanup() {
+ if(address != nullptr) {
+ delete address;
+ }
+
+ if(token != nullptr) {
+ delete token;
+ }
+ if(capture_dir != nullptr) {
+ delete capture_dir;
+ }
+ if(title != nullptr) {
+ delete title;
+ }
+
+
+ if(reverse_api_address != nullptr) {
+ delete reverse_api_address;
+ }
+
+
+
+ if(rollup_state != nullptr) {
+ delete rollup_state;
+ }
+}
+
+SWGMCPServerSettings*
+SWGMCPServerSettings::fromJson(QString &json) {
+ QByteArray array (json.toStdString().c_str());
+ QJsonDocument doc = QJsonDocument::fromJson(array);
+ QJsonObject jsonObject = doc.object();
+ this->fromJsonObject(jsonObject);
+ return this;
+}
+
+void
+SWGMCPServerSettings::fromJsonObject(QJsonObject &pJson) {
+ ::SWGSDRangel::setValue(&address, pJson["address"], "QString", "QString");
+
+ ::SWGSDRangel::setValue(&port, pJson["port"], "qint32", "");
+
+ ::SWGSDRangel::setValue(&token, pJson["token"], "QString", "QString");
+
+ ::SWGSDRangel::setValue(&capture_dir, pJson["captureDir"], "QString", "QString");
+
+ ::SWGSDRangel::setValue(&title, pJson["title"], "QString", "QString");
+
+ ::SWGSDRangel::setValue(&rgb_color, pJson["rgbColor"], "qint32", "");
+
+ ::SWGSDRangel::setValue(&use_reverse_api, pJson["useReverseAPI"], "qint32", "");
+
+ ::SWGSDRangel::setValue(&reverse_api_address, pJson["reverseAPIAddress"], "QString", "QString");
+
+ ::SWGSDRangel::setValue(&reverse_api_port, pJson["reverseAPIPort"], "qint32", "");
+
+ ::SWGSDRangel::setValue(&reverse_api_feature_set_index, pJson["reverseAPIFeatureSetIndex"], "qint32", "");
+
+ ::SWGSDRangel::setValue(&reverse_api_feature_index, pJson["reverseAPIFeatureIndex"], "qint32", "");
+
+ ::SWGSDRangel::setValue(&rollup_state, pJson["rollupState"], "SWGRollupState", "SWGRollupState");
+
+}
+
+QString
+SWGMCPServerSettings::asJson ()
+{
+ QJsonObject* obj = this->asJsonObject();
+
+ QJsonDocument doc(*obj);
+ QByteArray bytes = doc.toJson();
+ delete obj;
+ return QString(bytes);
+}
+
+QJsonObject*
+SWGMCPServerSettings::asJsonObject() {
+ QJsonObject* obj = new QJsonObject();
+ if(address != nullptr && *address != QString("")){
+ toJsonValue(QString("address"), address, obj, QString("QString"));
+ }
+ if(m_port_isSet){
+ obj->insert("port", QJsonValue(port));
+ }
+ if(token != nullptr && *token != QString("")){
+ toJsonValue(QString("token"), token, obj, QString("QString"));
+ }
+ if(capture_dir != nullptr && *capture_dir != QString("")){
+ toJsonValue(QString("captureDir"), capture_dir, obj, QString("QString"));
+ }
+ if(title != nullptr && *title != QString("")){
+ toJsonValue(QString("title"), title, obj, QString("QString"));
+ }
+ if(m_rgb_color_isSet){
+ obj->insert("rgbColor", QJsonValue(rgb_color));
+ }
+ if(m_use_reverse_api_isSet){
+ obj->insert("useReverseAPI", QJsonValue(use_reverse_api));
+ }
+ if(reverse_api_address != nullptr && *reverse_api_address != QString("")){
+ toJsonValue(QString("reverseAPIAddress"), reverse_api_address, obj, QString("QString"));
+ }
+ if(m_reverse_api_port_isSet){
+ obj->insert("reverseAPIPort", QJsonValue(reverse_api_port));
+ }
+ if(m_reverse_api_feature_set_index_isSet){
+ obj->insert("reverseAPIFeatureSetIndex", QJsonValue(reverse_api_feature_set_index));
+ }
+ if(m_reverse_api_feature_index_isSet){
+ obj->insert("reverseAPIFeatureIndex", QJsonValue(reverse_api_feature_index));
+ }
+ if((rollup_state != nullptr) && (rollup_state->isSet())){
+ toJsonValue(QString("rollupState"), rollup_state, obj, QString("SWGRollupState"));
+ }
+
+ return obj;
+}
+
+QString*
+SWGMCPServerSettings::getAddress() {
+ return address;
+}
+void
+SWGMCPServerSettings::setAddress(QString* address) {
+ this->address = address;
+ this->m_address_isSet = true;
+}
+
+qint32
+SWGMCPServerSettings::getPort() {
+ return port;
+}
+void
+SWGMCPServerSettings::setPort(qint32 port) {
+ this->port = port;
+ this->m_port_isSet = true;
+}
+
+QString*
+SWGMCPServerSettings::getToken() {
+ return token;
+}
+void
+SWGMCPServerSettings::setToken(QString* token) {
+ this->token = token;
+ this->m_token_isSet = true;
+}
+
+QString*
+SWGMCPServerSettings::getCaptureDir() {
+ return capture_dir;
+}
+void
+SWGMCPServerSettings::setCaptureDir(QString* capture_dir) {
+ this->capture_dir = capture_dir;
+ this->m_capture_dir_isSet = true;
+}
+
+QString*
+SWGMCPServerSettings::getTitle() {
+ return title;
+}
+void
+SWGMCPServerSettings::setTitle(QString* title) {
+ this->title = title;
+ this->m_title_isSet = true;
+}
+
+qint32
+SWGMCPServerSettings::getRgbColor() {
+ return rgb_color;
+}
+void
+SWGMCPServerSettings::setRgbColor(qint32 rgb_color) {
+ this->rgb_color = rgb_color;
+ this->m_rgb_color_isSet = true;
+}
+
+qint32
+SWGMCPServerSettings::getUseReverseApi() {
+ return use_reverse_api;
+}
+void
+SWGMCPServerSettings::setUseReverseApi(qint32 use_reverse_api) {
+ this->use_reverse_api = use_reverse_api;
+ this->m_use_reverse_api_isSet = true;
+}
+
+QString*
+SWGMCPServerSettings::getReverseApiAddress() {
+ return reverse_api_address;
+}
+void
+SWGMCPServerSettings::setReverseApiAddress(QString* reverse_api_address) {
+ this->reverse_api_address = reverse_api_address;
+ this->m_reverse_api_address_isSet = true;
+}
+
+qint32
+SWGMCPServerSettings::getReverseApiPort() {
+ return reverse_api_port;
+}
+void
+SWGMCPServerSettings::setReverseApiPort(qint32 reverse_api_port) {
+ this->reverse_api_port = reverse_api_port;
+ this->m_reverse_api_port_isSet = true;
+}
+
+qint32
+SWGMCPServerSettings::getReverseApiFeatureSetIndex() {
+ return reverse_api_feature_set_index;
+}
+void
+SWGMCPServerSettings::setReverseApiFeatureSetIndex(qint32 reverse_api_feature_set_index) {
+ this->reverse_api_feature_set_index = reverse_api_feature_set_index;
+ this->m_reverse_api_feature_set_index_isSet = true;
+}
+
+qint32
+SWGMCPServerSettings::getReverseApiFeatureIndex() {
+ return reverse_api_feature_index;
+}
+void
+SWGMCPServerSettings::setReverseApiFeatureIndex(qint32 reverse_api_feature_index) {
+ this->reverse_api_feature_index = reverse_api_feature_index;
+ this->m_reverse_api_feature_index_isSet = true;
+}
+
+SWGRollupState*
+SWGMCPServerSettings::getRollupState() {
+ return rollup_state;
+}
+void
+SWGMCPServerSettings::setRollupState(SWGRollupState* rollup_state) {
+ this->rollup_state = rollup_state;
+ this->m_rollup_state_isSet = true;
+}
+
+
+bool
+SWGMCPServerSettings::isSet(){
+ bool isObjectUpdated = false;
+ do{
+ if(address && *address != QString("")){
+ isObjectUpdated = true; break;
+ }
+ if(m_port_isSet){
+ isObjectUpdated = true; break;
+ }
+ if(token && *token != QString("")){
+ isObjectUpdated = true; break;
+ }
+ if(capture_dir && *capture_dir != QString("")){
+ isObjectUpdated = true; break;
+ }
+ if(title && *title != QString("")){
+ isObjectUpdated = true; break;
+ }
+ if(m_rgb_color_isSet){
+ isObjectUpdated = true; break;
+ }
+ if(m_use_reverse_api_isSet){
+ isObjectUpdated = true; break;
+ }
+ if(reverse_api_address && *reverse_api_address != QString("")){
+ isObjectUpdated = true; break;
+ }
+ if(m_reverse_api_port_isSet){
+ isObjectUpdated = true; break;
+ }
+ if(m_reverse_api_feature_set_index_isSet){
+ isObjectUpdated = true; break;
+ }
+ if(m_reverse_api_feature_index_isSet){
+ isObjectUpdated = true; break;
+ }
+ if(rollup_state && rollup_state->isSet()){
+ isObjectUpdated = true; break;
+ }
+ }while(false);
+ return isObjectUpdated;
+}
+}
+
diff --git a/swagger/sdrangel/code/qt5/client/SWGMCPServerSettings.h b/swagger/sdrangel/code/qt5/client/SWGMCPServerSettings.h
new file mode 100644
index 000000000..efa23a22f
--- /dev/null
+++ b/swagger/sdrangel/code/qt5/client/SWGMCPServerSettings.h
@@ -0,0 +1,126 @@
+/**
+ * SDRangel
+ * This is the web REST/JSON API of SDRangel SDR software. SDRangel is an Open Source Qt5/OpenGL 3.0+ (4.3+ in Windows) GUI and server Software Defined Radio and signal analyzer in software. It supports Airspy, BladeRF, HackRF, LimeSDR, PlutoSDR, RTL-SDR, SDRplay RSP1 and FunCube --- Limitations and specifcities: * In SDRangel GUI the first Rx device set cannot be deleted. Conversely the server starts with no device sets and its number of device sets can be reduced to zero by as many calls as necessary to /sdrangel/deviceset with DELETE method. * Preset import and export from/to file is a server only feature. * Device set focus is a GUI only feature. * The following channels are not implemented (status 501 is returned): ATV and DATV demodulators, Channel Analyzer NG, LoRa demodulator * The device settings and report structures contains only the sub-structure corresponding to the device type. The DeviceSettings and DeviceReport structures documented here shows all of them but only one will be or should be present at a time * The channel settings and report structures contains only the sub-structure corresponding to the channel type. The ChannelSettings and ChannelReport structures documented here shows all of them but only one will be or should be present at a time ---
+ *
+ * OpenAPI spec version: 7.0.0
+ * Contact: f4exb06@gmail.com
+ *
+ * NOTE: This class is auto generated by the swagger code generator program.
+ * https://github.com/swagger-api/swagger-codegen.git
+ * Do not edit the class manually.
+ */
+
+/*
+ * SWGMCPServerSettings.h
+ *
+ * MCP (Model Context Protocol) server settings
+ */
+
+#ifndef SWGMCPServerSettings_H_
+#define SWGMCPServerSettings_H_
+
+#include
+
+
+#include "SWGRollupState.h"
+#include
+
+#include "SWGObject.h"
+#include "export.h"
+
+namespace SWGSDRangel {
+
+class SWG_API SWGMCPServerSettings: public SWGObject {
+public:
+ SWGMCPServerSettings();
+ SWGMCPServerSettings(QString* json);
+ virtual ~SWGMCPServerSettings();
+ void init();
+ void cleanup();
+
+ virtual QString asJson () override;
+ virtual QJsonObject* asJsonObject() override;
+ virtual void fromJsonObject(QJsonObject &json) override;
+ virtual SWGMCPServerSettings* fromJson(QString &jsonString) override;
+
+ QString* getAddress();
+ void setAddress(QString* address);
+
+ qint32 getPort();
+ void setPort(qint32 port);
+
+ QString* getToken();
+ void setToken(QString* token);
+
+ QString* getCaptureDir();
+ void setCaptureDir(QString* capture_dir);
+
+ QString* getTitle();
+ void setTitle(QString* title);
+
+ qint32 getRgbColor();
+ void setRgbColor(qint32 rgb_color);
+
+ qint32 getUseReverseApi();
+ void setUseReverseApi(qint32 use_reverse_api);
+
+ QString* getReverseApiAddress();
+ void setReverseApiAddress(QString* reverse_api_address);
+
+ qint32 getReverseApiPort();
+ void setReverseApiPort(qint32 reverse_api_port);
+
+ qint32 getReverseApiFeatureSetIndex();
+ void setReverseApiFeatureSetIndex(qint32 reverse_api_feature_set_index);
+
+ qint32 getReverseApiFeatureIndex();
+ void setReverseApiFeatureIndex(qint32 reverse_api_feature_index);
+
+ SWGRollupState* getRollupState();
+ void setRollupState(SWGRollupState* rollup_state);
+
+
+ virtual bool isSet() override;
+
+private:
+ QString* address;
+ bool m_address_isSet;
+
+ qint32 port;
+ bool m_port_isSet;
+
+ QString* token;
+ bool m_token_isSet;
+
+ QString* capture_dir;
+ bool m_capture_dir_isSet;
+
+ QString* title;
+ bool m_title_isSet;
+
+ qint32 rgb_color;
+ bool m_rgb_color_isSet;
+
+ qint32 use_reverse_api;
+ bool m_use_reverse_api_isSet;
+
+ QString* reverse_api_address;
+ bool m_reverse_api_address_isSet;
+
+ qint32 reverse_api_port;
+ bool m_reverse_api_port_isSet;
+
+ qint32 reverse_api_feature_set_index;
+ bool m_reverse_api_feature_set_index_isSet;
+
+ qint32 reverse_api_feature_index;
+ bool m_reverse_api_feature_index_isSet;
+
+ SWGRollupState* rollup_state;
+ bool m_rollup_state_isSet;
+
+};
+
+}
+
+#endif /* SWGMCPServerSettings_H_ */
diff --git a/swagger/sdrangel/code/qt5/client/SWGModelFactory.h b/swagger/sdrangel/code/qt5/client/SWGModelFactory.h
index 605a23be8..4541a72a8 100644
--- a/swagger/sdrangel/code/qt5/client/SWGModelFactory.h
+++ b/swagger/sdrangel/code/qt5/client/SWGModelFactory.h
@@ -220,6 +220,9 @@
#include "SWGM17DemodSettings.h"
#include "SWGM17ModReport.h"
#include "SWGM17ModSettings.h"
+#include "SWGMCPServerActions.h"
+#include "SWGMCPServerReport.h"
+#include "SWGMCPServerSettings.h"
#include "SWGMapActions.h"
#include "SWGMapAircraftState.h"
#include "SWGMapAnimation.h"
@@ -228,15 +231,15 @@
#include "SWGMapItem_2.h"
#include "SWGMapReport.h"
#include "SWGMapSettings.h"
-#include "SWGMeshtasticDemodReport.h"
-#include "SWGMeshtasticDemodSettings.h"
-#include "SWGMeshtasticModReport.h"
-#include "SWGMeshtasticModSettings.h"
#include "SWGMeshcoreDemodReport.h"
#include "SWGMeshcoreDemodSettings.h"
#include "SWGMeshcoreModActions.h"
#include "SWGMeshcoreModReport.h"
#include "SWGMeshcoreModSettings.h"
+#include "SWGMeshtasticDemodReport.h"
+#include "SWGMeshtasticDemodSettings.h"
+#include "SWGMeshtasticModReport.h"
+#include "SWGMeshtasticModSettings.h"
#include "SWGMetisMISOSettings.h"
#include "SWGMorseDecoderActions.h"
#include "SWGMorseDecoderSettings.h"
@@ -1437,6 +1440,21 @@ namespace SWGSDRangel {
obj->init();
return obj;
}
+ if(QString("SWGMCPServerActions").compare(type) == 0) {
+ SWGMCPServerActions *obj = new SWGMCPServerActions();
+ obj->init();
+ return obj;
+ }
+ if(QString("SWGMCPServerReport").compare(type) == 0) {
+ SWGMCPServerReport *obj = new SWGMCPServerReport();
+ obj->init();
+ return obj;
+ }
+ if(QString("SWGMCPServerSettings").compare(type) == 0) {
+ SWGMCPServerSettings *obj = new SWGMCPServerSettings();
+ obj->init();
+ return obj;
+ }
if(QString("SWGMapActions").compare(type) == 0) {
SWGMapActions *obj = new SWGMapActions();
obj->init();
@@ -1477,48 +1495,48 @@ namespace SWGSDRangel {
obj->init();
return obj;
}
- if(QString("SWGMeshtasticDemodReport").compare(type) == 0) {
- SWGMeshtasticDemodReport *obj = new SWGMeshtasticDemodReport();
+ if(QString("SWGMeshcoreDemodReport").compare(type) == 0) {
+ SWGMeshcoreDemodReport *obj = new SWGMeshcoreDemodReport();
obj->init();
return obj;
}
- if(QString("SWGMeshtasticDemodSettings").compare(type) == 0) {
- SWGMeshtasticDemodSettings *obj = new SWGMeshtasticDemodSettings();
+ if(QString("SWGMeshcoreDemodSettings").compare(type) == 0) {
+ SWGMeshcoreDemodSettings *obj = new SWGMeshcoreDemodSettings();
obj->init();
return obj;
}
- if(QString("SWGMeshtasticModReport").compare(type) == 0) {
- SWGMeshtasticModReport *obj = new SWGMeshtasticModReport();
+ if(QString("SWGMeshcoreModActions").compare(type) == 0) {
+ SWGMeshcoreModActions *obj = new SWGMeshcoreModActions();
obj->init();
return obj;
}
- if(QString("SWGMeshtasticModSettings").compare(type) == 0) {
- SWGMeshtasticModSettings *obj = new SWGMeshtasticModSettings();
+ if(QString("SWGMeshcoreModReport").compare(type) == 0) {
+ SWGMeshcoreModReport *obj = new SWGMeshcoreModReport();
obj->init();
return obj;
}
- if(QString("SWGMeshcoreDemodReport").compare(type) == 0) {
- SWGMeshcoreDemodReport *obj = new SWGMeshcoreDemodReport();
+ if(QString("SWGMeshcoreModSettings").compare(type) == 0) {
+ SWGMeshcoreModSettings *obj = new SWGMeshcoreModSettings();
obj->init();
return obj;
}
- if(QString("SWGMeshcoreDemodSettings").compare(type) == 0) {
- SWGMeshcoreDemodSettings *obj = new SWGMeshcoreDemodSettings();
+ if(QString("SWGMeshtasticDemodReport").compare(type) == 0) {
+ SWGMeshtasticDemodReport *obj = new SWGMeshtasticDemodReport();
obj->init();
return obj;
}
- if(QString("SWGMeshcoreModReport").compare(type) == 0) {
- SWGMeshcoreModReport *obj = new SWGMeshcoreModReport();
+ if(QString("SWGMeshtasticDemodSettings").compare(type) == 0) {
+ SWGMeshtasticDemodSettings *obj = new SWGMeshtasticDemodSettings();
obj->init();
return obj;
}
- if(QString("SWGMeshcoreModSettings").compare(type) == 0) {
- SWGMeshcoreModSettings *obj = new SWGMeshcoreModSettings();
+ if(QString("SWGMeshtasticModReport").compare(type) == 0) {
+ SWGMeshtasticModReport *obj = new SWGMeshtasticModReport();
obj->init();
return obj;
}
- if(QString("SWGMeshcoreModActions").compare(type) == 0) {
- SWGMeshcoreModActions *obj = new SWGMeshcoreModActions();
+ if(QString("SWGMeshtasticModSettings").compare(type) == 0) {
+ SWGMeshtasticModSettings *obj = new SWGMeshtasticModSettings();
obj->init();
return obj;
}