diff --git a/sdrbase/resources/webapi.qrc b/sdrbase/resources/webapi.qrc index 77771320c..20344e735 100644 --- a/sdrbase/resources/webapi.qrc +++ b/sdrbase/resources/webapi.qrc @@ -38,7 +38,6 @@ webapi/doc/swagger/include/GLSpectrum.yaml webapi/doc/swagger/include/HackRF.yaml webapi/doc/swagger/include/IEEE_802_15_4_Mod.yaml - webapi/doc/swagger/include/Interferometer.yaml webapi/doc/swagger/include/LimeRFE.yaml webapi/doc/swagger/include/LimeSdr.yaml webapi/doc/swagger/include/KiwiSDR.yaml @@ -46,7 +45,6 @@ webapi/doc/swagger/include/LocalOutput.yaml webapi/doc/swagger/include/LocalSink.yaml webapi/doc/swagger/include/LocalSource.yaml - webapi/doc/swagger/include/MetisMISO.yaml webapi/doc/swagger/include/NFMDemod.yaml webapi/doc/swagger/include/NFMMod.yaml webapi/doc/swagger/include/PacketMod.yaml diff --git a/sdrbase/resources/webapi/doc/html2/index.html b/sdrbase/resources/webapi/doc/html2/index.html index 35752624b..2dd81cdeb 100644 --- a/sdrbase/resources/webapi/doc/html2/index.html +++ b/sdrbase/resources/webapi/doc/html2/index.html @@ -2037,6 +2037,9 @@ margin-bottom: 20px; "FileSourceActions" : { "$ref" : "#/definitions/FileSourceActions" }, + "IEEE_802_15_4_ModActions" : { + "$ref" : "#/definitions/IEEE_802_15_4_ModActions" + }, "PacketModActions" : { "$ref" : "#/definitions/PacketModActions" } @@ -2175,6 +2178,9 @@ margin-bottom: 20px; "DSDDemodReport" : { "$ref" : "#/definitions/DSDDemodReport" }, + "IEEE_802_15_4_ModReport" : { + "$ref" : "#/definitions/IEEE_802_15_4_ModReport" + }, "FileSinkReport" : { "$ref" : "#/definitions/FileSinkReport" }, @@ -2282,6 +2288,9 @@ margin-bottom: 20px; "FreqTrackerSettings" : { "$ref" : "#/definitions/FreqTrackerSettings" }, + "IEEE_802_15_4_ModSettings" : { + "$ref" : "#/definitions/IEEE_802_15_4_ModSettings" + }, "NFMDemodSettings" : { "$ref" : "#/definitions/NFMDemodSettings" }, @@ -2800,6 +2809,12 @@ margin-bottom: 20px; "soapySDROutputReport" : { "$ref" : "#/definitions/SoapySDRReport" }, + "usrpInputReport" : { + "$ref" : "#/definitions/USRPInputReport" + }, + "usrpOutputReport" : { + "$ref" : "#/definitions/USRPOutputReport" + }, "xtrxInputReport" : { "$ref" : "#/definitions/XtrxInputReport" }, @@ -2946,6 +2961,12 @@ margin-bottom: 20px; "testSourceSettings" : { "$ref" : "#/definitions/TestSourceSettings" }, + "usrpInputSettings" : { + "$ref" : "#/definitions/USRPInputSettings" + }, + "usrpOutputSettings" : { + "$ref" : "#/definitions/USRPOutputSettings" + }, "xtrxInputSettings" : { "$ref" : "#/definitions/XtrxInputSettings" }, @@ -4109,6 +4130,99 @@ margin-bottom: 20px; } }, "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 = { "required" : [ "channelcount" ], @@ -7440,6 +7554,148 @@ margin-bottom: 20px; } }, "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 = { "properties" : { @@ -8055,7 +8311,7 @@ margin-bottom: 20px;

API and SDK Documentation

Version: 4.15.0
-

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:

- Generated 2020-09-29T00:33:21.870+02:00 + Generated 2020-10-11T08:49:12.690+02:00
diff --git a/sdrbase/resources/webapi/doc/swagger/include/ChannelActions.yaml b/sdrbase/resources/webapi/doc/swagger/include/ChannelActions.yaml index e0f3d2256..9816bede5 100644 --- a/sdrbase/resources/webapi/doc/swagger/include/ChannelActions.yaml +++ b/sdrbase/resources/webapi/doc/swagger/include/ChannelActions.yaml @@ -21,5 +21,7 @@ ChannelActions: $ref: "/doc/swagger/include/FileSink.yaml#/FileSinkActions" 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: $ref: "/doc/swagger/include/PacketMod.yaml#/PacketModActions" diff --git a/sdrbase/resources/webapi/doc/swagger/include/ChannelReport.yaml b/sdrbase/resources/webapi/doc/swagger/include/ChannelReport.yaml index f713e78e7..8b5435992 100644 --- a/sdrbase/resources/webapi/doc/swagger/include/ChannelReport.yaml +++ b/sdrbase/resources/webapi/doc/swagger/include/ChannelReport.yaml @@ -21,6 +21,8 @@ ChannelReport: $ref: "/doc/swagger/include/BFMDemod.yaml#/BFMDemodReport" 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: $ref: "/doc/swagger/include/FileSink.yaml#/FileSinkReport" FileSourceReport: diff --git a/sdrbase/resources/webapi/doc/swagger/include/ChannelSettings.yaml b/sdrbase/resources/webapi/doc/swagger/include/ChannelSettings.yaml index cb25ac431..59dc14035 100644 --- a/sdrbase/resources/webapi/doc/swagger/include/ChannelSettings.yaml +++ b/sdrbase/resources/webapi/doc/swagger/include/ChannelSettings.yaml @@ -43,6 +43,8 @@ ChannelSettings: $ref: "/doc/swagger/include/FreeDVMod.yaml#/FreeDVModSettings" 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: $ref: "/doc/swagger/include/NFMDemod.yaml#/NFMDemodSettings" NFMModSettings: diff --git a/sdrbase/resources/webapi/doc/swagger/include/DeviceReports.yaml b/sdrbase/resources/webapi/doc/swagger/include/DeviceReports.yaml index feb311dfc..e3ff986d0 100644 --- a/sdrbase/resources/webapi/doc/swagger/include/DeviceReports.yaml +++ b/sdrbase/resources/webapi/doc/swagger/include/DeviceReports.yaml @@ -49,6 +49,10 @@ DeviceReport: $ref: "/doc/swagger/include/SoapySDR.yaml#/SoapySDRReport" soapySDROutputReport: $ref: "/doc/swagger/include/SoapySDR.yaml#/SoapySDRReport" + usrpInputReport: + $ref: "/doc/swagger/include/USRP.yaml#/USRPInputReport" + usrpOutputReport: + $ref: "/doc/swagger/include/USRP.yaml#/USRPOutputReport" xtrxInputReport: $ref: "/doc/swagger/include/Xtrx.yaml#/XtrxInputReport" xtrxOutputReport: diff --git a/sdrbase/resources/webapi/doc/swagger/include/DeviceSettings.yaml b/sdrbase/resources/webapi/doc/swagger/include/DeviceSettings.yaml index 7393b6bc7..ae02f76c7 100644 --- a/sdrbase/resources/webapi/doc/swagger/include/DeviceSettings.yaml +++ b/sdrbase/resources/webapi/doc/swagger/include/DeviceSettings.yaml @@ -68,6 +68,10 @@ DeviceSettings: $ref: "/doc/swagger/include/SoapySDR.yaml#/SoapySDROutputSettings" 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: $ref: "/doc/swagger/include/Xtrx.yaml#/XtrxInputSettings" xtrxOutputSettings: 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 new file mode 100644 index 000000000..d66fd9983 --- /dev/null +++ b/sdrbase/resources/webapi/doc/swagger/include/IEEE_802_15_4_Mod.yaml @@ -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 diff --git a/sdrbase/resources/webapi/doc/swagger/include/USRP.yaml b/sdrbase/resources/webapi/doc/swagger/include/USRP.yaml new file mode 100644 index 000000000..05d22351c --- /dev/null +++ b/sdrbase/resources/webapi/doc/swagger/include/USRP.yaml @@ -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 diff --git a/sdrbase/resources/webapi/doc/swagger/swagger.yaml b/sdrbase/resources/webapi/doc/swagger/swagger.yaml index 7f1d57d41..f2e7bfa43 100644 --- a/sdrbase/resources/webapi/doc/swagger/swagger.yaml +++ b/sdrbase/resources/webapi/doc/swagger/swagger.yaml @@ -1,7 +1,7 @@ swagger: "2.0" info: 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: diff --git a/swagger/sdrangel/code/html2/index.html b/swagger/sdrangel/code/html2/index.html index c1fb8643a..2dd81cdeb 100644 --- a/swagger/sdrangel/code/html2/index.html +++ b/swagger/sdrangel/code/html2/index.html @@ -2037,6 +2037,9 @@ margin-bottom: 20px; "FileSourceActions" : { "$ref" : "#/definitions/FileSourceActions" }, + "IEEE_802_15_4_ModActions" : { + "$ref" : "#/definitions/IEEE_802_15_4_ModActions" + }, "PacketModActions" : { "$ref" : "#/definitions/PacketModActions" } @@ -2175,6 +2178,9 @@ margin-bottom: 20px; "DSDDemodReport" : { "$ref" : "#/definitions/DSDDemodReport" }, + "IEEE_802_15_4_ModReport" : { + "$ref" : "#/definitions/IEEE_802_15_4_ModReport" + }, "FileSinkReport" : { "$ref" : "#/definitions/FileSinkReport" }, @@ -2282,6 +2288,9 @@ margin-bottom: 20px; "FreqTrackerSettings" : { "$ref" : "#/definitions/FreqTrackerSettings" }, + "IEEE_802_15_4_ModSettings" : { + "$ref" : "#/definitions/IEEE_802_15_4_ModSettings" + }, "NFMDemodSettings" : { "$ref" : "#/definitions/NFMDemodSettings" }, @@ -4121,6 +4130,99 @@ margin-bottom: 20px; } }, "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 = { "required" : [ "channelcount" ], @@ -39867,7 +39969,7 @@ except ApiException as e:
- Generated 2020-10-02T22:20:44.346+02:00 + Generated 2020-10-11T08:49:12.690+02:00