mirror of
https://github.com/f4exb/sdrangel.git
synced 2024-11-12 11:26:11 -05:00
REST API fixes
This commit is contained in:
parent
f5076457b4
commit
bb8e54451b
@ -38,7 +38,6 @@
|
|||||||
<file>webapi/doc/swagger/include/GLSpectrum.yaml</file>
|
<file>webapi/doc/swagger/include/GLSpectrum.yaml</file>
|
||||||
<file>webapi/doc/swagger/include/HackRF.yaml</file>
|
<file>webapi/doc/swagger/include/HackRF.yaml</file>
|
||||||
<file>webapi/doc/swagger/include/IEEE_802_15_4_Mod.yaml</file>
|
<file>webapi/doc/swagger/include/IEEE_802_15_4_Mod.yaml</file>
|
||||||
<file>webapi/doc/swagger/include/Interferometer.yaml</file>
|
|
||||||
<file>webapi/doc/swagger/include/LimeRFE.yaml</file>
|
<file>webapi/doc/swagger/include/LimeRFE.yaml</file>
|
||||||
<file>webapi/doc/swagger/include/LimeSdr.yaml</file>
|
<file>webapi/doc/swagger/include/LimeSdr.yaml</file>
|
||||||
<file>webapi/doc/swagger/include/KiwiSDR.yaml</file>
|
<file>webapi/doc/swagger/include/KiwiSDR.yaml</file>
|
||||||
@ -46,7 +45,6 @@
|
|||||||
<file>webapi/doc/swagger/include/LocalOutput.yaml</file>
|
<file>webapi/doc/swagger/include/LocalOutput.yaml</file>
|
||||||
<file>webapi/doc/swagger/include/LocalSink.yaml</file>
|
<file>webapi/doc/swagger/include/LocalSink.yaml</file>
|
||||||
<file>webapi/doc/swagger/include/LocalSource.yaml</file>
|
<file>webapi/doc/swagger/include/LocalSource.yaml</file>
|
||||||
<file>webapi/doc/swagger/include/MetisMISO.yaml</file>
|
|
||||||
<file>webapi/doc/swagger/include/NFMDemod.yaml</file>
|
<file>webapi/doc/swagger/include/NFMDemod.yaml</file>
|
||||||
<file>webapi/doc/swagger/include/NFMMod.yaml</file>
|
<file>webapi/doc/swagger/include/NFMMod.yaml</file>
|
||||||
<file>webapi/doc/swagger/include/PacketMod.yaml</file>
|
<file>webapi/doc/swagger/include/PacketMod.yaml</file>
|
||||||
|
@ -2037,6 +2037,9 @@ margin-bottom: 20px;
|
|||||||
"FileSourceActions" : {
|
"FileSourceActions" : {
|
||||||
"$ref" : "#/definitions/FileSourceActions"
|
"$ref" : "#/definitions/FileSourceActions"
|
||||||
},
|
},
|
||||||
|
"IEEE_802_15_4_ModActions" : {
|
||||||
|
"$ref" : "#/definitions/IEEE_802_15_4_ModActions"
|
||||||
|
},
|
||||||
"PacketModActions" : {
|
"PacketModActions" : {
|
||||||
"$ref" : "#/definitions/PacketModActions"
|
"$ref" : "#/definitions/PacketModActions"
|
||||||
}
|
}
|
||||||
@ -2175,6 +2178,9 @@ margin-bottom: 20px;
|
|||||||
"DSDDemodReport" : {
|
"DSDDemodReport" : {
|
||||||
"$ref" : "#/definitions/DSDDemodReport"
|
"$ref" : "#/definitions/DSDDemodReport"
|
||||||
},
|
},
|
||||||
|
"IEEE_802_15_4_ModReport" : {
|
||||||
|
"$ref" : "#/definitions/IEEE_802_15_4_ModReport"
|
||||||
|
},
|
||||||
"FileSinkReport" : {
|
"FileSinkReport" : {
|
||||||
"$ref" : "#/definitions/FileSinkReport"
|
"$ref" : "#/definitions/FileSinkReport"
|
||||||
},
|
},
|
||||||
@ -2282,6 +2288,9 @@ margin-bottom: 20px;
|
|||||||
"FreqTrackerSettings" : {
|
"FreqTrackerSettings" : {
|
||||||
"$ref" : "#/definitions/FreqTrackerSettings"
|
"$ref" : "#/definitions/FreqTrackerSettings"
|
||||||
},
|
},
|
||||||
|
"IEEE_802_15_4_ModSettings" : {
|
||||||
|
"$ref" : "#/definitions/IEEE_802_15_4_ModSettings"
|
||||||
|
},
|
||||||
"NFMDemodSettings" : {
|
"NFMDemodSettings" : {
|
||||||
"$ref" : "#/definitions/NFMDemodSettings"
|
"$ref" : "#/definitions/NFMDemodSettings"
|
||||||
},
|
},
|
||||||
@ -2800,6 +2809,12 @@ margin-bottom: 20px;
|
|||||||
"soapySDROutputReport" : {
|
"soapySDROutputReport" : {
|
||||||
"$ref" : "#/definitions/SoapySDRReport"
|
"$ref" : "#/definitions/SoapySDRReport"
|
||||||
},
|
},
|
||||||
|
"usrpInputReport" : {
|
||||||
|
"$ref" : "#/definitions/USRPInputReport"
|
||||||
|
},
|
||||||
|
"usrpOutputReport" : {
|
||||||
|
"$ref" : "#/definitions/USRPOutputReport"
|
||||||
|
},
|
||||||
"xtrxInputReport" : {
|
"xtrxInputReport" : {
|
||||||
"$ref" : "#/definitions/XtrxInputReport"
|
"$ref" : "#/definitions/XtrxInputReport"
|
||||||
},
|
},
|
||||||
@ -2946,6 +2961,12 @@ margin-bottom: 20px;
|
|||||||
"testSourceSettings" : {
|
"testSourceSettings" : {
|
||||||
"$ref" : "#/definitions/TestSourceSettings"
|
"$ref" : "#/definitions/TestSourceSettings"
|
||||||
},
|
},
|
||||||
|
"usrpInputSettings" : {
|
||||||
|
"$ref" : "#/definitions/USRPInputSettings"
|
||||||
|
},
|
||||||
|
"usrpOutputSettings" : {
|
||||||
|
"$ref" : "#/definitions/USRPOutputSettings"
|
||||||
|
},
|
||||||
"xtrxInputSettings" : {
|
"xtrxInputSettings" : {
|
||||||
"$ref" : "#/definitions/XtrxInputSettings"
|
"$ref" : "#/definitions/XtrxInputSettings"
|
||||||
},
|
},
|
||||||
@ -4109,6 +4130,99 @@ margin-bottom: 20px;
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
"description" : "HackRF"
|
"description" : "HackRF"
|
||||||
|
};
|
||||||
|
defs.IEEE_802_15_4_ModActions = {
|
||||||
|
"properties" : {
|
||||||
|
"tx" : {
|
||||||
|
"$ref" : "#/definitions/IEEE_802_15_4_ModActions_tx"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"description" : "IEEE_802_15_4_Mod"
|
||||||
|
};
|
||||||
|
defs.IEEE_802_15_4_ModActions_tx = {
|
||||||
|
"properties" : {
|
||||||
|
"data" : {
|
||||||
|
"type" : "string",
|
||||||
|
"description" : "Hex coded bytes of data to transmit, excluding CRC (E.g for an ACK - 02 00 00)."
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"description" : "Transmit a frame\n"
|
||||||
|
};
|
||||||
|
defs.IEEE_802_15_4_ModReport = {
|
||||||
|
"properties" : {
|
||||||
|
"channelPowerDB" : {
|
||||||
|
"type" : "number",
|
||||||
|
"format" : "float",
|
||||||
|
"description" : "power transmitted in channel (dB)"
|
||||||
|
},
|
||||||
|
"channelSampleRate" : {
|
||||||
|
"type" : "integer"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"description" : "IEEE_802_15_4_Mod"
|
||||||
|
};
|
||||||
|
defs.IEEE_802_15_4_ModSettings = {
|
||||||
|
"properties" : {
|
||||||
|
"inputFrequencyOffset" : {
|
||||||
|
"type" : "integer",
|
||||||
|
"format" : "int64"
|
||||||
|
},
|
||||||
|
"phy" : {
|
||||||
|
"type" : "string",
|
||||||
|
"description" : "Physical layer. \"20kbps BPSK\", \"40kbps BPSK\", \"100kbps <1GHz O-QPSK\", \"250kbps <1GHz O-QPSK (Sine)\", \"250kbps <1GHz O-QPSK (RC)\", or \"250kbps >2GHz O-QPSK\"."
|
||||||
|
},
|
||||||
|
"rfBandwidth" : {
|
||||||
|
"type" : "number",
|
||||||
|
"format" : "float"
|
||||||
|
},
|
||||||
|
"gain" : {
|
||||||
|
"type" : "number",
|
||||||
|
"format" : "float"
|
||||||
|
},
|
||||||
|
"channelMute" : {
|
||||||
|
"type" : "integer"
|
||||||
|
},
|
||||||
|
"repeat" : {
|
||||||
|
"type" : "integer",
|
||||||
|
"description" : "Whether to repeated transmit the frame (1 for yes, 0 for no)."
|
||||||
|
},
|
||||||
|
"repeatDelay" : {
|
||||||
|
"type" : "number",
|
||||||
|
"format" : "float",
|
||||||
|
"description" : "Delay between repeated transmissions."
|
||||||
|
},
|
||||||
|
"repeatCount" : {
|
||||||
|
"type" : "integer",
|
||||||
|
"description" : "Number of times to repeat the frame (-1 for infinite)."
|
||||||
|
},
|
||||||
|
"rgbColor" : {
|
||||||
|
"type" : "integer"
|
||||||
|
},
|
||||||
|
"title" : {
|
||||||
|
"type" : "string"
|
||||||
|
},
|
||||||
|
"streamIndex" : {
|
||||||
|
"type" : "integer",
|
||||||
|
"description" : "MIMO channel. Not relevant when connected to SI (single Rx)."
|
||||||
|
},
|
||||||
|
"useReverseAPI" : {
|
||||||
|
"type" : "integer",
|
||||||
|
"description" : "Synchronize with reverse API (1 for yes, 0 for no)"
|
||||||
|
},
|
||||||
|
"reverseAPIAddress" : {
|
||||||
|
"type" : "string"
|
||||||
|
},
|
||||||
|
"reverseAPIPort" : {
|
||||||
|
"type" : "integer"
|
||||||
|
},
|
||||||
|
"reverseAPIDeviceIndex" : {
|
||||||
|
"type" : "integer"
|
||||||
|
},
|
||||||
|
"reverseAPIChannelIndex" : {
|
||||||
|
"type" : "integer"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"description" : "IEEE_802_15_4_Mod"
|
||||||
};
|
};
|
||||||
defs.InstanceChannelsResponse = {
|
defs.InstanceChannelsResponse = {
|
||||||
"required" : [ "channelcount" ],
|
"required" : [ "channelcount" ],
|
||||||
@ -7440,6 +7554,148 @@ margin-bottom: 20px;
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
"description" : "UDPSource"
|
"description" : "UDPSource"
|
||||||
|
};
|
||||||
|
defs.USRPInputReport = {
|
||||||
|
"properties" : {
|
||||||
|
"success" : {
|
||||||
|
"type" : "integer",
|
||||||
|
"description" : "1 if info was successfully retrieved else 0"
|
||||||
|
},
|
||||||
|
"streamActive" : {
|
||||||
|
"type" : "integer",
|
||||||
|
"description" : "1 if active else 0"
|
||||||
|
},
|
||||||
|
"overrunCount" : {
|
||||||
|
"type" : "integer"
|
||||||
|
},
|
||||||
|
"timeoutCount" : {
|
||||||
|
"type" : "integer"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"description" : "USRP"
|
||||||
|
};
|
||||||
|
defs.USRPInputSettings = {
|
||||||
|
"properties" : {
|
||||||
|
"centerFrequency" : {
|
||||||
|
"type" : "integer",
|
||||||
|
"format" : "int64"
|
||||||
|
},
|
||||||
|
"devSampleRate" : {
|
||||||
|
"type" : "integer"
|
||||||
|
},
|
||||||
|
"dcBlock" : {
|
||||||
|
"type" : "integer"
|
||||||
|
},
|
||||||
|
"iqCorrection" : {
|
||||||
|
"type" : "integer"
|
||||||
|
},
|
||||||
|
"log2SoftDecim" : {
|
||||||
|
"type" : "integer"
|
||||||
|
},
|
||||||
|
"lpfBW" : {
|
||||||
|
"type" : "integer"
|
||||||
|
},
|
||||||
|
"antennaPath" : {
|
||||||
|
"type" : "string"
|
||||||
|
},
|
||||||
|
"gain" : {
|
||||||
|
"type" : "integer"
|
||||||
|
},
|
||||||
|
"gainMode" : {
|
||||||
|
"type" : "integer",
|
||||||
|
"description" : "0 for auto, 1 for manual"
|
||||||
|
},
|
||||||
|
"clockSource" : {
|
||||||
|
"type" : "string"
|
||||||
|
},
|
||||||
|
"transverterMode" : {
|
||||||
|
"type" : "integer"
|
||||||
|
},
|
||||||
|
"transverterDeltaFrequency" : {
|
||||||
|
"type" : "integer",
|
||||||
|
"format" : "int64"
|
||||||
|
},
|
||||||
|
"useReverseAPI" : {
|
||||||
|
"type" : "integer",
|
||||||
|
"description" : "Synchronize with reverse API (1 for yes, 0 for no)"
|
||||||
|
},
|
||||||
|
"reverseAPIAddress" : {
|
||||||
|
"type" : "string"
|
||||||
|
},
|
||||||
|
"reverseAPIPort" : {
|
||||||
|
"type" : "integer"
|
||||||
|
},
|
||||||
|
"reverseAPIDeviceIndex" : {
|
||||||
|
"type" : "integer"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"description" : "USRP"
|
||||||
|
};
|
||||||
|
defs.USRPOutputReport = {
|
||||||
|
"properties" : {
|
||||||
|
"success" : {
|
||||||
|
"type" : "integer",
|
||||||
|
"description" : "1 if info was successfully retrieved else 0"
|
||||||
|
},
|
||||||
|
"streamActive" : {
|
||||||
|
"type" : "integer",
|
||||||
|
"description" : "1 if active else 0"
|
||||||
|
},
|
||||||
|
"underrunCount" : {
|
||||||
|
"type" : "integer"
|
||||||
|
},
|
||||||
|
"droppedPacketsCount" : {
|
||||||
|
"type" : "integer"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"description" : "USRP"
|
||||||
|
};
|
||||||
|
defs.USRPOutputSettings = {
|
||||||
|
"properties" : {
|
||||||
|
"centerFrequency" : {
|
||||||
|
"type" : "integer",
|
||||||
|
"format" : "int64"
|
||||||
|
},
|
||||||
|
"devSampleRate" : {
|
||||||
|
"type" : "integer"
|
||||||
|
},
|
||||||
|
"log2SoftInterp" : {
|
||||||
|
"type" : "integer"
|
||||||
|
},
|
||||||
|
"lpfBW" : {
|
||||||
|
"type" : "integer"
|
||||||
|
},
|
||||||
|
"gain" : {
|
||||||
|
"type" : "integer"
|
||||||
|
},
|
||||||
|
"antennaPath" : {
|
||||||
|
"type" : "string"
|
||||||
|
},
|
||||||
|
"clockSource" : {
|
||||||
|
"type" : "string"
|
||||||
|
},
|
||||||
|
"transverterMode" : {
|
||||||
|
"type" : "integer"
|
||||||
|
},
|
||||||
|
"transverterDeltaFrequency" : {
|
||||||
|
"type" : "integer",
|
||||||
|
"format" : "int64"
|
||||||
|
},
|
||||||
|
"useReverseAPI" : {
|
||||||
|
"type" : "integer",
|
||||||
|
"description" : "Synchronize with reverse API (1 for yes, 0 for no)"
|
||||||
|
},
|
||||||
|
"reverseAPIAddress" : {
|
||||||
|
"type" : "string"
|
||||||
|
},
|
||||||
|
"reverseAPIPort" : {
|
||||||
|
"type" : "integer"
|
||||||
|
},
|
||||||
|
"reverseAPIDeviceIndex" : {
|
||||||
|
"type" : "integer"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"description" : "USRP"
|
||||||
};
|
};
|
||||||
defs.WFMDemodReport = {
|
defs.WFMDemodReport = {
|
||||||
"properties" : {
|
"properties" : {
|
||||||
@ -8055,7 +8311,7 @@ margin-bottom: 20px;
|
|||||||
<h2 id="welcome-to-apidoc">API and SDK Documentation</h2>
|
<h2 id="welcome-to-apidoc">API and SDK Documentation</h2>
|
||||||
<div class="app-desc">Version: 4.15.0</div>
|
<div class="app-desc">Version: 4.15.0</div>
|
||||||
<hr>
|
<hr>
|
||||||
<div><p>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</p>
|
<div><p>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, USRP and FunCube</p>
|
||||||
<hr />
|
<hr />
|
||||||
<p>Limitations and specifcities:</p>
|
<p>Limitations and specifcities:</p>
|
||||||
<ul>
|
<ul>
|
||||||
@ -39713,7 +39969,7 @@ except ApiException as e:
|
|||||||
</div>
|
</div>
|
||||||
<div id="generator">
|
<div id="generator">
|
||||||
<div class="content">
|
<div class="content">
|
||||||
Generated 2020-09-29T00:33:21.870+02:00
|
Generated 2020-10-11T08:49:12.690+02:00
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
@ -21,5 +21,7 @@ ChannelActions:
|
|||||||
$ref: "/doc/swagger/include/FileSink.yaml#/FileSinkActions"
|
$ref: "/doc/swagger/include/FileSink.yaml#/FileSinkActions"
|
||||||
FileSourceActions:
|
FileSourceActions:
|
||||||
$ref: "/doc/swagger/include/FileSource.yaml#/FileSourceActions"
|
$ref: "/doc/swagger/include/FileSource.yaml#/FileSourceActions"
|
||||||
|
IEEE_802_15_4_ModActions:
|
||||||
|
$ref: "/doc/swagger/include/IEEE_802_15_4_Mod.yaml#/IEEE_802_15_4_ModActions"
|
||||||
PacketModActions:
|
PacketModActions:
|
||||||
$ref: "/doc/swagger/include/PacketMod.yaml#/PacketModActions"
|
$ref: "/doc/swagger/include/PacketMod.yaml#/PacketModActions"
|
||||||
|
@ -21,6 +21,8 @@ ChannelReport:
|
|||||||
$ref: "/doc/swagger/include/BFMDemod.yaml#/BFMDemodReport"
|
$ref: "/doc/swagger/include/BFMDemod.yaml#/BFMDemodReport"
|
||||||
DSDDemodReport:
|
DSDDemodReport:
|
||||||
$ref: "/doc/swagger/include/DSDDemod.yaml#/DSDDemodReport"
|
$ref: "/doc/swagger/include/DSDDemod.yaml#/DSDDemodReport"
|
||||||
|
IEEE_802_15_4_ModReport:
|
||||||
|
$ref: "/doc/swagger/include/IEEE_802_15_4_Mod.yaml#/IEEE_802_15_4_ModReport"
|
||||||
FileSinkReport:
|
FileSinkReport:
|
||||||
$ref: "/doc/swagger/include/FileSink.yaml#/FileSinkReport"
|
$ref: "/doc/swagger/include/FileSink.yaml#/FileSinkReport"
|
||||||
FileSourceReport:
|
FileSourceReport:
|
||||||
|
@ -43,6 +43,8 @@ ChannelSettings:
|
|||||||
$ref: "/doc/swagger/include/FreeDVMod.yaml#/FreeDVModSettings"
|
$ref: "/doc/swagger/include/FreeDVMod.yaml#/FreeDVModSettings"
|
||||||
FreqTrackerSettings:
|
FreqTrackerSettings:
|
||||||
$ref: "/doc/swagger/include/FreqTracker.yaml#/FreqTrackerSettings"
|
$ref: "/doc/swagger/include/FreqTracker.yaml#/FreqTrackerSettings"
|
||||||
|
IEEE_802_15_4_ModSettings:
|
||||||
|
$ref: "/doc/swagger/include/IEEE_802_15_4_Mod.yaml#/IEEE_802_15_4_ModSettings"
|
||||||
NFMDemodSettings:
|
NFMDemodSettings:
|
||||||
$ref: "/doc/swagger/include/NFMDemod.yaml#/NFMDemodSettings"
|
$ref: "/doc/swagger/include/NFMDemod.yaml#/NFMDemodSettings"
|
||||||
NFMModSettings:
|
NFMModSettings:
|
||||||
|
@ -49,6 +49,10 @@ DeviceReport:
|
|||||||
$ref: "/doc/swagger/include/SoapySDR.yaml#/SoapySDRReport"
|
$ref: "/doc/swagger/include/SoapySDR.yaml#/SoapySDRReport"
|
||||||
soapySDROutputReport:
|
soapySDROutputReport:
|
||||||
$ref: "/doc/swagger/include/SoapySDR.yaml#/SoapySDRReport"
|
$ref: "/doc/swagger/include/SoapySDR.yaml#/SoapySDRReport"
|
||||||
|
usrpInputReport:
|
||||||
|
$ref: "/doc/swagger/include/USRP.yaml#/USRPInputReport"
|
||||||
|
usrpOutputReport:
|
||||||
|
$ref: "/doc/swagger/include/USRP.yaml#/USRPOutputReport"
|
||||||
xtrxInputReport:
|
xtrxInputReport:
|
||||||
$ref: "/doc/swagger/include/Xtrx.yaml#/XtrxInputReport"
|
$ref: "/doc/swagger/include/Xtrx.yaml#/XtrxInputReport"
|
||||||
xtrxOutputReport:
|
xtrxOutputReport:
|
||||||
|
@ -68,6 +68,10 @@ DeviceSettings:
|
|||||||
$ref: "/doc/swagger/include/SoapySDR.yaml#/SoapySDROutputSettings"
|
$ref: "/doc/swagger/include/SoapySDR.yaml#/SoapySDROutputSettings"
|
||||||
testSourceSettings:
|
testSourceSettings:
|
||||||
$ref: "/doc/swagger/include/TestSource.yaml#/TestSourceSettings"
|
$ref: "/doc/swagger/include/TestSource.yaml#/TestSourceSettings"
|
||||||
|
usrpInputSettings:
|
||||||
|
$ref: "/doc/swagger/include/USRP.yaml#/USRPInputSettings"
|
||||||
|
usrpOutputSettings:
|
||||||
|
$ref: "/doc/swagger/include/USRP.yaml#/USRPOutputSettings"
|
||||||
xtrxInputSettings:
|
xtrxInputSettings:
|
||||||
$ref: "/doc/swagger/include/Xtrx.yaml#/XtrxInputSettings"
|
$ref: "/doc/swagger/include/Xtrx.yaml#/XtrxInputSettings"
|
||||||
xtrxOutputSettings:
|
xtrxOutputSettings:
|
||||||
|
@ -0,0 +1,67 @@
|
|||||||
|
IEEE_802_15_4_ModSettings:
|
||||||
|
description: IEEE_802_15_4_Mod
|
||||||
|
properties:
|
||||||
|
inputFrequencyOffset:
|
||||||
|
type: integer
|
||||||
|
format: int64
|
||||||
|
phy:
|
||||||
|
description: Physical layer. "20kbps BPSK", "40kbps BPSK", "100kbps <1GHz O-QPSK", "250kbps <1GHz O-QPSK (Sine)", "250kbps <1GHz O-QPSK (RC)", or "250kbps >2GHz O-QPSK".
|
||||||
|
type: string
|
||||||
|
rfBandwidth:
|
||||||
|
type: number
|
||||||
|
format: float
|
||||||
|
gain:
|
||||||
|
type: number
|
||||||
|
format: float
|
||||||
|
channelMute:
|
||||||
|
type: integer
|
||||||
|
repeat:
|
||||||
|
description: Whether to repeated transmit the frame (1 for yes, 0 for no).
|
||||||
|
type: integer
|
||||||
|
repeatDelay:
|
||||||
|
description: Delay between repeated transmissions.
|
||||||
|
type: number
|
||||||
|
format: float
|
||||||
|
repeatCount:
|
||||||
|
description: Number of times to repeat the frame (-1 for infinite).
|
||||||
|
type: integer
|
||||||
|
rgbColor:
|
||||||
|
type: integer
|
||||||
|
title:
|
||||||
|
type: string
|
||||||
|
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
|
||||||
|
reverseAPIAddress:
|
||||||
|
type: string
|
||||||
|
reverseAPIPort:
|
||||||
|
type: integer
|
||||||
|
reverseAPIDeviceIndex:
|
||||||
|
type: integer
|
||||||
|
reverseAPIChannelIndex:
|
||||||
|
type: integer
|
||||||
|
|
||||||
|
IEEE_802_15_4_ModReport:
|
||||||
|
description: IEEE_802_15_4_Mod
|
||||||
|
properties:
|
||||||
|
channelPowerDB:
|
||||||
|
description: power transmitted in channel (dB)
|
||||||
|
type: number
|
||||||
|
format: float
|
||||||
|
channelSampleRate:
|
||||||
|
type: integer
|
||||||
|
|
||||||
|
IEEE_802_15_4_ModActions:
|
||||||
|
description: IEEE_802_15_4_Mod
|
||||||
|
properties:
|
||||||
|
tx:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
data:
|
||||||
|
description: Hex coded bytes of data to transmit, excluding CRC (E.g for an ACK - 02 00 00).
|
||||||
|
type: string
|
||||||
|
description: >
|
||||||
|
Transmit a frame
|
100
sdrbase/resources/webapi/doc/swagger/include/USRP.yaml
Normal file
100
sdrbase/resources/webapi/doc/swagger/include/USRP.yaml
Normal file
@ -0,0 +1,100 @@
|
|||||||
|
USRPInputSettings:
|
||||||
|
description: USRP
|
||||||
|
properties:
|
||||||
|
centerFrequency:
|
||||||
|
type: integer
|
||||||
|
format: int64
|
||||||
|
devSampleRate:
|
||||||
|
type: integer
|
||||||
|
dcBlock:
|
||||||
|
type: integer
|
||||||
|
iqCorrection:
|
||||||
|
type: integer
|
||||||
|
log2SoftDecim:
|
||||||
|
type: integer
|
||||||
|
lpfBW:
|
||||||
|
type: integer
|
||||||
|
antennaPath:
|
||||||
|
type: string
|
||||||
|
gain:
|
||||||
|
type: integer
|
||||||
|
gainMode:
|
||||||
|
description: 0 for auto, 1 for manual
|
||||||
|
type: integer
|
||||||
|
clockSource:
|
||||||
|
type: string
|
||||||
|
transverterMode:
|
||||||
|
type: integer
|
||||||
|
transverterDeltaFrequency:
|
||||||
|
type: integer
|
||||||
|
format: int64
|
||||||
|
useReverseAPI:
|
||||||
|
description: Synchronize with reverse API (1 for yes, 0 for no)
|
||||||
|
type: integer
|
||||||
|
reverseAPIAddress:
|
||||||
|
type: string
|
||||||
|
reverseAPIPort:
|
||||||
|
type: integer
|
||||||
|
reverseAPIDeviceIndex:
|
||||||
|
type: integer
|
||||||
|
|
||||||
|
USRPOutputSettings:
|
||||||
|
description: USRP
|
||||||
|
properties:
|
||||||
|
centerFrequency:
|
||||||
|
type: integer
|
||||||
|
format: int64
|
||||||
|
devSampleRate:
|
||||||
|
type: integer
|
||||||
|
log2SoftInterp:
|
||||||
|
type: integer
|
||||||
|
lpfBW:
|
||||||
|
type: integer
|
||||||
|
gain:
|
||||||
|
type: integer
|
||||||
|
antennaPath:
|
||||||
|
type: string
|
||||||
|
clockSource:
|
||||||
|
type: string
|
||||||
|
transverterMode:
|
||||||
|
type: integer
|
||||||
|
transverterDeltaFrequency:
|
||||||
|
type: integer
|
||||||
|
format: int64
|
||||||
|
useReverseAPI:
|
||||||
|
description: Synchronize with reverse API (1 for yes, 0 for no)
|
||||||
|
type: integer
|
||||||
|
reverseAPIAddress:
|
||||||
|
type: string
|
||||||
|
reverseAPIPort:
|
||||||
|
type: integer
|
||||||
|
reverseAPIDeviceIndex:
|
||||||
|
type: integer
|
||||||
|
|
||||||
|
USRPInputReport:
|
||||||
|
description: USRP
|
||||||
|
properties:
|
||||||
|
success:
|
||||||
|
description: 1 if info was successfully retrieved else 0
|
||||||
|
type: integer
|
||||||
|
streamActive:
|
||||||
|
description: 1 if active else 0
|
||||||
|
type: integer
|
||||||
|
overrunCount:
|
||||||
|
type: integer
|
||||||
|
timeoutCount:
|
||||||
|
type: integer
|
||||||
|
|
||||||
|
USRPOutputReport:
|
||||||
|
description: USRP
|
||||||
|
properties:
|
||||||
|
success:
|
||||||
|
description: 1 if info was successfully retrieved else 0
|
||||||
|
type: integer
|
||||||
|
streamActive:
|
||||||
|
description: 1 if active else 0
|
||||||
|
type: integer
|
||||||
|
underrunCount:
|
||||||
|
type: integer
|
||||||
|
droppedPacketsCount:
|
||||||
|
type: integer
|
@ -1,7 +1,7 @@
|
|||||||
swagger: "2.0"
|
swagger: "2.0"
|
||||||
info:
|
info:
|
||||||
description: >
|
description: >
|
||||||
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
|
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, USRP and FunCube
|
||||||
|
|
||||||
---
|
---
|
||||||
Limitations and specifcities:
|
Limitations and specifcities:
|
||||||
|
@ -2037,6 +2037,9 @@ margin-bottom: 20px;
|
|||||||
"FileSourceActions" : {
|
"FileSourceActions" : {
|
||||||
"$ref" : "#/definitions/FileSourceActions"
|
"$ref" : "#/definitions/FileSourceActions"
|
||||||
},
|
},
|
||||||
|
"IEEE_802_15_4_ModActions" : {
|
||||||
|
"$ref" : "#/definitions/IEEE_802_15_4_ModActions"
|
||||||
|
},
|
||||||
"PacketModActions" : {
|
"PacketModActions" : {
|
||||||
"$ref" : "#/definitions/PacketModActions"
|
"$ref" : "#/definitions/PacketModActions"
|
||||||
}
|
}
|
||||||
@ -2175,6 +2178,9 @@ margin-bottom: 20px;
|
|||||||
"DSDDemodReport" : {
|
"DSDDemodReport" : {
|
||||||
"$ref" : "#/definitions/DSDDemodReport"
|
"$ref" : "#/definitions/DSDDemodReport"
|
||||||
},
|
},
|
||||||
|
"IEEE_802_15_4_ModReport" : {
|
||||||
|
"$ref" : "#/definitions/IEEE_802_15_4_ModReport"
|
||||||
|
},
|
||||||
"FileSinkReport" : {
|
"FileSinkReport" : {
|
||||||
"$ref" : "#/definitions/FileSinkReport"
|
"$ref" : "#/definitions/FileSinkReport"
|
||||||
},
|
},
|
||||||
@ -2282,6 +2288,9 @@ margin-bottom: 20px;
|
|||||||
"FreqTrackerSettings" : {
|
"FreqTrackerSettings" : {
|
||||||
"$ref" : "#/definitions/FreqTrackerSettings"
|
"$ref" : "#/definitions/FreqTrackerSettings"
|
||||||
},
|
},
|
||||||
|
"IEEE_802_15_4_ModSettings" : {
|
||||||
|
"$ref" : "#/definitions/IEEE_802_15_4_ModSettings"
|
||||||
|
},
|
||||||
"NFMDemodSettings" : {
|
"NFMDemodSettings" : {
|
||||||
"$ref" : "#/definitions/NFMDemodSettings"
|
"$ref" : "#/definitions/NFMDemodSettings"
|
||||||
},
|
},
|
||||||
@ -4121,6 +4130,99 @@ margin-bottom: 20px;
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
"description" : "HackRF"
|
"description" : "HackRF"
|
||||||
|
};
|
||||||
|
defs.IEEE_802_15_4_ModActions = {
|
||||||
|
"properties" : {
|
||||||
|
"tx" : {
|
||||||
|
"$ref" : "#/definitions/IEEE_802_15_4_ModActions_tx"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"description" : "IEEE_802_15_4_Mod"
|
||||||
|
};
|
||||||
|
defs.IEEE_802_15_4_ModActions_tx = {
|
||||||
|
"properties" : {
|
||||||
|
"data" : {
|
||||||
|
"type" : "string",
|
||||||
|
"description" : "Hex coded bytes of data to transmit, excluding CRC (E.g for an ACK - 02 00 00)."
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"description" : "Transmit a frame\n"
|
||||||
|
};
|
||||||
|
defs.IEEE_802_15_4_ModReport = {
|
||||||
|
"properties" : {
|
||||||
|
"channelPowerDB" : {
|
||||||
|
"type" : "number",
|
||||||
|
"format" : "float",
|
||||||
|
"description" : "power transmitted in channel (dB)"
|
||||||
|
},
|
||||||
|
"channelSampleRate" : {
|
||||||
|
"type" : "integer"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"description" : "IEEE_802_15_4_Mod"
|
||||||
|
};
|
||||||
|
defs.IEEE_802_15_4_ModSettings = {
|
||||||
|
"properties" : {
|
||||||
|
"inputFrequencyOffset" : {
|
||||||
|
"type" : "integer",
|
||||||
|
"format" : "int64"
|
||||||
|
},
|
||||||
|
"phy" : {
|
||||||
|
"type" : "string",
|
||||||
|
"description" : "Physical layer. \"20kbps BPSK\", \"40kbps BPSK\", \"100kbps <1GHz O-QPSK\", \"250kbps <1GHz O-QPSK (Sine)\", \"250kbps <1GHz O-QPSK (RC)\", or \"250kbps >2GHz O-QPSK\"."
|
||||||
|
},
|
||||||
|
"rfBandwidth" : {
|
||||||
|
"type" : "number",
|
||||||
|
"format" : "float"
|
||||||
|
},
|
||||||
|
"gain" : {
|
||||||
|
"type" : "number",
|
||||||
|
"format" : "float"
|
||||||
|
},
|
||||||
|
"channelMute" : {
|
||||||
|
"type" : "integer"
|
||||||
|
},
|
||||||
|
"repeat" : {
|
||||||
|
"type" : "integer",
|
||||||
|
"description" : "Whether to repeated transmit the frame (1 for yes, 0 for no)."
|
||||||
|
},
|
||||||
|
"repeatDelay" : {
|
||||||
|
"type" : "number",
|
||||||
|
"format" : "float",
|
||||||
|
"description" : "Delay between repeated transmissions."
|
||||||
|
},
|
||||||
|
"repeatCount" : {
|
||||||
|
"type" : "integer",
|
||||||
|
"description" : "Number of times to repeat the frame (-1 for infinite)."
|
||||||
|
},
|
||||||
|
"rgbColor" : {
|
||||||
|
"type" : "integer"
|
||||||
|
},
|
||||||
|
"title" : {
|
||||||
|
"type" : "string"
|
||||||
|
},
|
||||||
|
"streamIndex" : {
|
||||||
|
"type" : "integer",
|
||||||
|
"description" : "MIMO channel. Not relevant when connected to SI (single Rx)."
|
||||||
|
},
|
||||||
|
"useReverseAPI" : {
|
||||||
|
"type" : "integer",
|
||||||
|
"description" : "Synchronize with reverse API (1 for yes, 0 for no)"
|
||||||
|
},
|
||||||
|
"reverseAPIAddress" : {
|
||||||
|
"type" : "string"
|
||||||
|
},
|
||||||
|
"reverseAPIPort" : {
|
||||||
|
"type" : "integer"
|
||||||
|
},
|
||||||
|
"reverseAPIDeviceIndex" : {
|
||||||
|
"type" : "integer"
|
||||||
|
},
|
||||||
|
"reverseAPIChannelIndex" : {
|
||||||
|
"type" : "integer"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"description" : "IEEE_802_15_4_Mod"
|
||||||
};
|
};
|
||||||
defs.InstanceChannelsResponse = {
|
defs.InstanceChannelsResponse = {
|
||||||
"required" : [ "channelcount" ],
|
"required" : [ "channelcount" ],
|
||||||
@ -39867,7 +39969,7 @@ except ApiException as e:
|
|||||||
</div>
|
</div>
|
||||||
<div id="generator">
|
<div id="generator">
|
||||||
<div class="content">
|
<div class="content">
|
||||||
Generated 2020-10-02T22:20:44.346+02:00
|
Generated 2020-10-11T08:49:12.690+02:00
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
Loading…
Reference in New Issue
Block a user