From 20ef49ea84fc90bd8c36b1831ce6d2035898f704 Mon Sep 17 00:00:00 2001 From: f4exb Date: Mon, 21 Sep 2020 03:05:44 +0200 Subject: [PATCH] Feature plugins framework: REST API source yaml files and generated code --- sdrbase/resources/webapi/doc/html2/index.html | 6802 +++++++++++++++-- .../doc/swagger/include/ChannelReport.yaml | 53 + .../doc/swagger/include/FeatureActions.yaml | 17 + .../doc/swagger/include/FeatureReport.yaml | 11 + .../doc/swagger/include/FeatureSettings.yaml | 17 + .../webapi/doc/swagger/include/SimplePTT.yaml | 50 + .../resources/webapi/doc/swagger/swagger.yaml | 582 +- .../api/swagger/include/ChannelReport.yaml | 53 + .../api/swagger/include/FeatureActions.yaml | 17 + .../api/swagger/include/FeatureReport.yaml | 11 + .../api/swagger/include/FeatureSettings.yaml | 17 + .../api/swagger/include/SimplePTT.yaml | 50 + swagger/sdrangel/api/swagger/swagger.yaml | 582 +- swagger/sdrangel/code/html2/index.html | 6802 +++++++++++++++-- .../code/qt5/client/SWGChannelReport.cpp | 50 +- .../code/qt5/client/SWGChannelReport.h | 12 +- .../sdrangel/code/qt5/client/SWGFeature.cpp | 181 + swagger/sdrangel/code/qt5/client/SWGFeature.h | 77 + .../code/qt5/client/SWGFeatureActions.cpp | 181 + .../code/qt5/client/SWGFeatureActions.h | 78 + .../code/qt5/client/SWGFeatureReport.cpp | 135 + .../code/qt5/client/SWGFeatureReport.h | 66 + .../code/qt5/client/SWGFeatureSet.cpp | 137 + .../sdrangel/code/qt5/client/SWGFeatureSet.h | 66 + .../code/qt5/client/SWGFeatureSetApi.cpp | 656 ++ .../code/qt5/client/SWGFeatureSetApi.h | 107 + .../code/qt5/client/SWGFeatureSetList.cpp | 137 + .../code/qt5/client/SWGFeatureSetList.h | 66 + .../code/qt5/client/SWGFeatureSettings.cpp | 181 + .../code/qt5/client/SWGFeatureSettings.h | 78 + .../code/qt5/client/SWGInstanceApi.cpp | 52 + .../sdrangel/code/qt5/client/SWGInstanceApi.h | 6 + .../code/qt5/client/SWGModelFactory.h | 162 +- .../code/qt5/client/SWGSimplePTTActions.cpp | 108 + .../code/qt5/client/SWGSimplePTTActions.h | 58 + .../code/qt5/client/SWGSimplePTTReport.cpp | 108 + .../code/qt5/client/SWGSimplePTTReport.h | 58 + .../code/qt5/client/SWGSimplePTTSettings.cpp | 342 + .../code/qt5/client/SWGSimplePTTSettings.h | 119 + 39 files changed, 16455 insertions(+), 1830 deletions(-) create mode 100644 sdrbase/resources/webapi/doc/swagger/include/ChannelReport.yaml create mode 100644 sdrbase/resources/webapi/doc/swagger/include/FeatureActions.yaml create mode 100644 sdrbase/resources/webapi/doc/swagger/include/FeatureReport.yaml create mode 100644 sdrbase/resources/webapi/doc/swagger/include/FeatureSettings.yaml create mode 100644 sdrbase/resources/webapi/doc/swagger/include/SimplePTT.yaml create mode 100644 swagger/sdrangel/api/swagger/include/ChannelReport.yaml create mode 100644 swagger/sdrangel/api/swagger/include/FeatureActions.yaml create mode 100644 swagger/sdrangel/api/swagger/include/FeatureReport.yaml create mode 100644 swagger/sdrangel/api/swagger/include/FeatureSettings.yaml create mode 100644 swagger/sdrangel/api/swagger/include/SimplePTT.yaml create mode 100644 swagger/sdrangel/code/qt5/client/SWGFeature.cpp create mode 100644 swagger/sdrangel/code/qt5/client/SWGFeature.h create mode 100644 swagger/sdrangel/code/qt5/client/SWGFeatureActions.cpp create mode 100644 swagger/sdrangel/code/qt5/client/SWGFeatureActions.h create mode 100644 swagger/sdrangel/code/qt5/client/SWGFeatureReport.cpp create mode 100644 swagger/sdrangel/code/qt5/client/SWGFeatureReport.h create mode 100644 swagger/sdrangel/code/qt5/client/SWGFeatureSet.cpp create mode 100644 swagger/sdrangel/code/qt5/client/SWGFeatureSet.h create mode 100644 swagger/sdrangel/code/qt5/client/SWGFeatureSetApi.cpp create mode 100644 swagger/sdrangel/code/qt5/client/SWGFeatureSetApi.h create mode 100644 swagger/sdrangel/code/qt5/client/SWGFeatureSetList.cpp create mode 100644 swagger/sdrangel/code/qt5/client/SWGFeatureSetList.h create mode 100644 swagger/sdrangel/code/qt5/client/SWGFeatureSettings.cpp create mode 100644 swagger/sdrangel/code/qt5/client/SWGFeatureSettings.h create mode 100644 swagger/sdrangel/code/qt5/client/SWGSimplePTTActions.cpp create mode 100644 swagger/sdrangel/code/qt5/client/SWGSimplePTTActions.h create mode 100644 swagger/sdrangel/code/qt5/client/SWGSimplePTTReport.cpp create mode 100644 swagger/sdrangel/code/qt5/client/SWGSimplePTTReport.h create mode 100644 swagger/sdrangel/code/qt5/client/SWGSimplePTTSettings.cpp create mode 100644 swagger/sdrangel/code/qt5/client/SWGSimplePTTSettings.h diff --git a/sdrbase/resources/webapi/doc/html2/index.html b/sdrbase/resources/webapi/doc/html2/index.html index 284281f6c..a38dae6ec 100644 --- a/sdrbase/resources/webapi/doc/html2/index.html +++ b/sdrbase/resources/webapi/doc/html2/index.html @@ -1132,17 +1132,6 @@ margin-bottom: 20px; } }, "description" : "ATVMod" -}; - defs.AirspyHFReport = { - "properties" : { - "sampleRates" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/SampleRate" - } - } - }, - "description" : "AirspyHF" }; defs.AirspyHFSettings = { "properties" : { @@ -1214,17 +1203,6 @@ margin-bottom: 20px; } }, "description" : "AirspyHF" -}; - defs.AirspyReport = { - "properties" : { - "sampleRates" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/SampleRate" - } - } - }, - "description" : "Airspy" }; defs.AirspySettings = { "properties" : { @@ -1298,44 +1276,6 @@ margin-bottom: 20px; } }, "description" : "Airspy" -}; - defs.ArgInfo = { - "properties" : { - "key" : { - "type" : "string" - }, - "valueType" : { - "type" : "string", - "enum" : [ "bool", "int", "float", "string" ] - }, - "valueString" : { - "type" : "string" - }, - "name" : { - "type" : "string" - }, - "description" : { - "type" : "string" - }, - "units" : { - "type" : "string" - }, - "range" : { - "$ref" : "#/definitions/RangeFloat" - }, - "valueOptions" : { - "type" : "array", - "items" : { - "type" : "string" - } - }, - "optionNames" : { - "type" : "array", - "items" : { - "type" : "string" - } - } - } }; defs.ArgValue = { "properties" : { @@ -1559,14 +1499,6 @@ margin-bottom: 20px; } }, "description" : "BFMDemod" -}; - defs.Bandwidth = { - "properties" : { - "bandwidth" : { - "type" : "integer" - } - }, - "description" : "A bandwidth expressed in Hertz (Hz)" }; defs.BladeRF1InputSettings = { "properties" : { @@ -1675,29 +1607,6 @@ margin-bottom: 20px; } }, "description" : "BladeRF1" -}; - defs.BladeRF2InputReport = { - "properties" : { - "frequencyRange" : { - "$ref" : "#/definitions/FrequencyRange" - }, - "sampleRateRange" : { - "$ref" : "#/definitions/Range" - }, - "bandwidthRange" : { - "$ref" : "#/definitions/Range" - }, - "globalGainRange" : { - "$ref" : "#/definitions/Range" - }, - "gainModes" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/NamedEnum" - } - } - }, - "description" : "BladeRF2" }; defs.BladeRF2InputSettings = { "properties" : { @@ -1870,23 +1779,6 @@ margin-bottom: 20px; } }, "description" : "BladeRF2" -}; - defs.BladeRF2OutputReport = { - "properties" : { - "frequencyRange" : { - "$ref" : "#/definitions/FrequencyRange" - }, - "sampleRateRange" : { - "$ref" : "#/definitions/Range" - }, - "bandwidthRange" : { - "$ref" : "#/definitions/Range" - }, - "globalGainRange" : { - "$ref" : "#/definitions/Range" - } - }, - "description" : "BladeRF2" }; defs.BladeRF2OutputSettings = { "properties" : { @@ -2149,6 +2041,7 @@ margin-bottom: 20px; "description" : "Summarized information about channel plugin" }; defs.ChannelReport = { + "required" : [ "direction" ], "discriminator" : "channelType", "properties" : { "channelType" : { @@ -2195,15 +2088,15 @@ margin-bottom: 20px; "NFMModReport" : { "$ref" : "#/definitions/NFMModReport" }, - "PacketModReport" : { - "$ref" : "#/definitions/PacketModReport" - }, "SSBDemodReport" : { "$ref" : "#/definitions/SSBDemodReport" }, "RemoteSourceReport" : { "$ref" : "#/definitions/RemoteSourceReport" }, + "PacketModReport" : { + "$ref" : "#/definitions/PacketModReport" + }, "SSBModReport" : { "$ref" : "#/definitions/SSBModReport" }, @@ -2729,84 +2622,6 @@ margin-bottom: 20px; } }, "description" : "Summarized information about attached hardware device" -}; - defs.DeviceReport = { - "required" : [ "deviceHwType", "direction" ], - "discriminator" : "deviceHwType", - "properties" : { - "deviceHwType" : { - "type" : "string", - "description" : "Device hardware type code" - }, - "direction" : { - "type" : "integer", - "description" : "0 for Rx only, 1 for Tx only or 2 for any number and direction (default 0)" - }, - "airspyReport" : { - "$ref" : "#/definitions/AirspyReport" - }, - "airspyHFReport" : { - "$ref" : "#/definitions/AirspyHFReport" - }, - "bladeRF2InputReport" : { - "$ref" : "#/definitions/BladeRF2InputReport" - }, - "bladeRF2OutputReport" : { - "$ref" : "#/definitions/BladeRF2OutputReport" - }, - "fileInputReport" : { - "$ref" : "#/definitions/FileInputReport" - }, - "limeSdrInputReport" : { - "$ref" : "#/definitions/LimeSdrInputReport" - }, - "kiwiSDRReport" : { - "$ref" : "#/definitions/KiwiSDRReport" - }, - "limeSdrOutputReport" : { - "$ref" : "#/definitions/LimeSdrOutputReport" - }, - "localInputReport" : { - "$ref" : "#/definitions/LocalInputReport" - }, - "localOutputReport" : { - "$ref" : "#/definitions/LocalOutputReport" - }, - "perseusReport" : { - "$ref" : "#/definitions/PerseusReport" - }, - "plutoSdrInputReport" : { - "$ref" : "#/definitions/PlutoSdrInputReport" - }, - "plutoSdrOutputReport" : { - "$ref" : "#/definitions/PlutoSdrOutputReport" - }, - "rtlSdrReport" : { - "$ref" : "#/definitions/RtlSdrReport" - }, - "remoteOutputReport" : { - "$ref" : "#/definitions/RemoteOutputReport" - }, - "remoteInputReport" : { - "$ref" : "#/definitions/RemoteInputReport" - }, - "sdrPlayReport" : { - "$ref" : "#/definitions/SDRPlayReport" - }, - "soapySDRInputReport" : { - "$ref" : "#/definitions/SoapySDRReport" - }, - "soapySDROutputReport" : { - "$ref" : "#/definitions/SoapySDRReport" - }, - "xtrxInputReport" : { - "$ref" : "#/definitions/XtrxInputReport" - }, - "xtrxOutputReport" : { - "$ref" : "#/definitions/XtrxOutputReport" - } - }, - "description" : "Base device report. Only the device report corresponding to the device specified in the deviceHwType is or should be present." }; defs.DeviceSet = { "required" : [ "channelcount", "samplingDevice" ], @@ -3141,33 +2956,119 @@ margin-bottom: 20px; }, "description" : "FCDPro" }; - defs.FileInputReport = { + defs.Feature = { + "required" : [ "id", "index", "title", "uid" ], "properties" : { - "fileName" : { - "type" : "string" - }, - "sampleRate" : { + "index" : { "type" : "integer", - "description" : "Record sample rate in S/s" + "description" : "Index in the list of features" }, - "sampleSize" : { + "id" : { + "type" : "string", + "description" : "Key to identify the type of feature" + }, + "uid" : { "type" : "integer", - "description" : "Record sample size in number of bits" + "format" : "int64", + "description" : "Feature instance unique id" }, - "absoluteTime" : { + "title" : { "type" : "string", - "description" : "Absolute record time string representation" - }, - "elapsedTime" : { - "type" : "string", - "description" : "Elapsed time since beginning string representation" - }, - "durationTime" : { - "type" : "string", - "description" : "Duration time string representation" + "description" : "Freeform title of the feature" } }, - "description" : "FileInput" + "description" : "Feature summarized information" +}; + defs.FeatureActions = { + "required" : [ "featureType" ], + "discriminator" : "featureType", + "properties" : { + "featureType" : { + "type" : "string", + "description" : "Feature type code" + }, + "originatorFeatureSetIndex" : { + "type" : "integer", + "description" : "Optional for reverse API. This is the feature set index from where the message comes from." + }, + "originatorFeatureIndex" : { + "type" : "integer", + "description" : "Optional for reverse API. This is the feature index from where the message comes from." + }, + "SimplePTTActions" : { + "$ref" : "#/definitions/SimplePTTActions" + } + }, + "description" : "Base feature actions. Only the feature actions corresponding to the feature specified in the featureType field is or should be present." +}; + defs.FeatureReport = { + "required" : [ "featureType" ], + "discriminator" : "featureType", + "properties" : { + "featureType" : { + "type" : "string", + "description" : "Feature type code" + }, + "SimplePTTReport" : { + "$ref" : "#/definitions/SimplePTTReport" + } + }, + "description" : "Base feature report. Only the feature report corresponding to the feature specified in the featureType field is or should be present." +}; + defs.FeatureSet = { + "required" : [ "featurecount" ], + "properties" : { + "featurecount" : { + "type" : "integer", + "description" : "Number of features in the set" + }, + "features" : { + "type" : "array", + "description" : "Features list", + "items" : { + "$ref" : "#/definitions/Feature" + } + } + }, + "description" : "Grouping of features" +}; + defs.FeatureSetList = { + "required" : [ "featuresetcount" ], + "properties" : { + "featuresetcount" : { + "type" : "integer", + "description" : "Number of feature sets opened in this instance" + }, + "featureSets" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/FeatureSet" + } + } + }, + "description" : "List of feature sets opened in this instance" +}; + defs.FeatureSettings = { + "required" : [ "featureType" ], + "discriminator" : "featureType", + "properties" : { + "featureType" : { + "type" : "string", + "description" : "Feature type code" + }, + "originatorFeatureSetIndex" : { + "type" : "integer", + "description" : "Optional for reverse API. This is the feature set index from where the message comes from." + }, + "originatorFeatureIndex" : { + "type" : "integer", + "description" : "Optional for reverse API. This is the feature index from where the message comes from." + }, + "SimplePTTSettings" : { + "$ref" : "#/definitions/SimplePTTSettings" + } + }, + "description" : "Base feature settings. Only the feature settings corresponding to the feature specified in the featureType field is or should be present." }; defs.FileInputSettings = { "properties" : { @@ -3671,48 +3572,6 @@ margin-bottom: 20px; } }, "description" : "FreqTracker" -}; - defs.Frequency = { - "properties" : { - "frequency" : { - "type" : "integer" - } - }, - "description" : "A frequency expressed in Hertz (Hz)" -}; - defs.FrequencyBand = { - "properties" : { - "name" : { - "type" : "string" - }, - "lowerBound" : { - "type" : "integer" - }, - "higherBound" : { - "type" : "integer" - } - }, - "description" : "A band of frequencies given its boudaries in Hertz (Hz)" -}; - defs.FrequencyRange = { - "properties" : { - "min" : { - "type" : "integer", - "format" : "int64" - }, - "max" : { - "type" : "integer", - "format" : "int64" - }, - "step" : { - "type" : "integer" - }, - "scale" : { - "type" : "number", - "format" : "float" - } - }, - "description" : "An frequency range with 64 bit support for min and max" }; defs.GLScope = { "properties" : { @@ -3833,14 +3692,6 @@ margin-bottom: 20px; } }, "description" : "GLSpectrumGUI settings" -}; - defs.Gain = { - "properties" : { - "gainCB" : { - "type" : "integer" - } - }, - "description" : "A gain expressed in centi-Bels (tenths of dB)" }; defs.HackRFInputSettings = { "properties" : { @@ -4061,15 +3912,6 @@ margin-bottom: 20px; } }, "description" : "Summarized information about this SDRangel instance" -}; - defs.KiwiSDRReport = { - "properties" : { - "status" : { - "type" : "integer", - "description" : "0 for Idle, 1 for Connecting, 2 for Connected, 3 for Error, 4 for Disconnected" - } - }, - "description" : "KiwiSDR" }; defs.KiwiSDRSettings = { "properties" : { @@ -4217,55 +4059,6 @@ margin-bottom: 20px; } }, "description" : "LimeRFE" -}; - defs.LimeSdrInputReport = { - "properties" : { - "success" : { - "type" : "integer", - "description" : "1 if info was successfullt retrieved else 0" - }, - "streamActive" : { - "type" : "integer", - "description" : "1 if active else 0" - }, - "fifoSize" : { - "type" : "integer" - }, - "fifoFill" : { - "type" : "integer" - }, - "underrunCount" : { - "type" : "integer" - }, - "overrunCount" : { - "type" : "integer" - }, - "droppedPacketsCount" : { - "type" : "integer" - }, - "linkRate" : { - "type" : "number", - "format" : "float" - }, - "hwTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "Hardware timestamp" - }, - "temperature" : { - "type" : "number", - "format" : "float" - }, - "gpioDir" : { - "type" : "integer", - "format" : "int8" - }, - "gpioPins" : { - "type" : "integer", - "format" : "int8" - } - }, - "description" : "LimeSDR" }; defs.LimeSdrInputSettings = { "properties" : { @@ -4361,55 +4154,6 @@ margin-bottom: 20px; } }, "description" : "LimeSDR" -}; - defs.LimeSdrOutputReport = { - "properties" : { - "success" : { - "type" : "integer", - "description" : "1 if info was successfullt retrieved else 0" - }, - "streamActive" : { - "type" : "integer", - "description" : "1 if active else 0" - }, - "fifoSize" : { - "type" : "integer" - }, - "fifoFill" : { - "type" : "integer" - }, - "underrunCount" : { - "type" : "integer" - }, - "overrunCount" : { - "type" : "integer" - }, - "droppedPacketsCount" : { - "type" : "integer" - }, - "linkRate" : { - "type" : "number", - "format" : "float" - }, - "hwTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "Hardware timestamp" - }, - "temperature" : { - "type" : "number", - "format" : "float" - }, - "gpioDir" : { - "type" : "integer", - "format" : "int8" - }, - "gpioPins" : { - "type" : "integer", - "format" : "int8" - } - }, - "description" : "LimeSDR" }; defs.LimeSdrOutputSettings = { "properties" : { @@ -4483,18 +4227,6 @@ margin-bottom: 20px; } }, "description" : "LimeSDR" -}; - defs.LocalInputReport = { - "properties" : { - "centerFrequency" : { - "type" : "integer", - "format" : "int64" - }, - "sampleRate" : { - "type" : "integer" - } - }, - "description" : "LocalInput" }; defs.LocalInputSettings = { "properties" : { @@ -4519,18 +4251,6 @@ margin-bottom: 20px; } }, "description" : "LocalInput" -}; - defs.LocalOutputReport = { - "properties" : { - "centerFrequency" : { - "type" : "integer", - "format" : "int64" - }, - "sampleRate" : { - "type" : "integer" - } - }, - "description" : "LocalOutput" }; defs.LocalOutputSettings = { "properties" : { @@ -4873,17 +4593,6 @@ margin-bottom: 20px; } }, "description" : "NFMMod" -}; - defs.NamedEnum = { - "properties" : { - "name" : { - "type" : "string" - }, - "value" : { - "type" : "integer" - } - }, - "description" : "Enumeration with name for values" }; defs.PacketModActions = { "properties" : { @@ -5093,17 +4802,6 @@ margin-bottom: 20px; } }, "description" : "PacketMod" -}; - defs.PerseusReport = { - "properties" : { - "sampleRates" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/SampleRate" - } - } - }, - "description" : "Perseus" }; defs.PerseusSettings = { "properties" : { @@ -5162,24 +4860,6 @@ margin-bottom: 20px; } }, "description" : "Perseus" -}; - defs.PlutoSdrInputReport = { - "properties" : { - "adcRate" : { - "type" : "integer" - }, - "rssi" : { - "type" : "string" - }, - "gainDB" : { - "type" : "integer" - }, - "temperature" : { - "type" : "number", - "format" : "float" - } - }, - "description" : "PlutoSDR" }; defs.PlutoSdrInputSettings = { "properties" : { @@ -5271,21 +4951,6 @@ margin-bottom: 20px; } }, "description" : "PlutoSDR" -}; - defs.PlutoSdrOutputReport = { - "properties" : { - "dacRate" : { - "type" : "integer" - }, - "rssi" : { - "type" : "string" - }, - "temperature" : { - "type" : "number", - "format" : "float" - } - }, - "description" : "PlutoSDR" }; defs.PlutoSdrOutputSettings = { "properties" : { @@ -5629,69 +5294,6 @@ margin-bottom: 20px; "format" : "float" } } -}; - defs.Range = { - "properties" : { - "min" : { - "type" : "integer" - }, - "max" : { - "type" : "integer" - }, - "step" : { - "type" : "integer" - }, - "scale" : { - "type" : "number", - "format" : "float" - } - }, - "description" : "An arbitrary range of integer values" -}; - defs.RangeFloat = { - "properties" : { - "min" : { - "type" : "number", - "format" : "float" - }, - "max" : { - "type" : "number", - "format" : "float" - }, - "step" : { - "type" : "number", - "format" : "float" - } - }, - "description" : "An arbitrary range of floating point values" -}; - defs.RemoteInputReport = { - "properties" : { - "centerFrequency" : { - "type" : "integer", - "format" : "int64" - }, - "sampleRate" : { - "type" : "integer" - }, - "bufferRWBalance" : { - "type" : "integer", - "description" : "percentage off the mid buffer (positive read leads)" - }, - "remoteTimestamp" : { - "type" : "string", - "description" : "string representation of timestamp as sent by the remote instance" - }, - "minNbBlocks" : { - "type" : "integer", - "description" : "Minimum number of blocks retrieved per frame" - }, - "maxNbRecovery" : { - "type" : "integer", - "description" : "Maximum number of recovery blocks used per frame" - } - }, - "description" : "RemoteInput" }; defs.RemoteInputSettings = { "properties" : { @@ -5735,20 +5337,6 @@ margin-bottom: 20px; } }, "description" : "RemoteInput" -}; - defs.RemoteOutputReport = { - "properties" : { - "bufferRWBalance" : { - "type" : "number", - "format" : "float", - "description" : "ratio off the mid buffer (positive read leads)" - }, - "sampleCount" : { - "type" : "integer", - "description" : "count of samples that have been sent" - } - }, - "description" : "RemoteOutput" }; defs.RemoteOutputSettings = { "properties" : { @@ -5949,17 +5537,6 @@ margin-bottom: 20px; } }, "description" : "Remote channel source settings" -}; - defs.RtlSdrReport = { - "properties" : { - "gains" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/Gain" - } - } - }, - "description" : "RTLSDR" }; defs.RtlSdrSettings = { "properties" : { @@ -6033,35 +5610,6 @@ margin-bottom: 20px; } }, "description" : "RTLSDR" -}; - defs.SDRPlayReport = { - "properties" : { - "sampleRates" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/SampleRate" - } - }, - "bandwidths" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/Bandwidth" - } - }, - "intermediateFrequencies" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/Frequency" - } - }, - "frequencyBands" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/FrequencyBand" - } - } - }, - "description" : "SDRplay1" }; defs.SDRPlaySettings = { "properties" : { @@ -6340,14 +5888,6 @@ margin-bottom: 20px; } }, "description" : "SSBMod" -}; - defs.SampleRate = { - "properties" : { - "rate" : { - "type" : "integer" - } - }, - "description" : "A sample rate expressed in samples per second (S/s)" }; defs.SamplingDevice = { "required" : [ "bandwidth", "centerFrequency", "hwType", "index", "sequence", "serial" ], @@ -6404,30 +5944,66 @@ margin-bottom: 20px; }, "description" : "Information about a logical device available from an attached hardware device that can be used as a sampling device" }; - defs.SoapySDRFrequencySetting = { + defs.SimplePTTActions = { "properties" : { - "name" : { - "type" : "string" - }, - "ranges" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/RangeFloat" - } + "ptt" : { + "type" : "integer", + "description" : "PTT action\n * 0 - release\n * 1 - engage\n" } }, - "description" : "A named frequency setting specified by a range list" + "description" : "Simple PTT actions" }; - defs.SoapySDRGainSetting = { + defs.SimplePTTReport = { "properties" : { - "name" : { - "type" : "string" - }, - "range" : { - "$ref" : "#/definitions/RangeFloat" + "ptt" : { + "type" : "integer", + "description" : "PTT status\n * 0 - released\n * 1 - engaged\n" } }, - "description" : "A named gain setting specified by its range" + "description" : "Simple PTT report" +}; + defs.SimplePTTSettings = { + "properties" : { + "title" : { + "type" : "string" + }, + "rgbColor" : { + "type" : "integer" + }, + "rxDeviceSetIndex" : { + "type" : "integer", + "description" : "index of the Rx device set to connect the Rx side to" + }, + "txDeviceSetIndex" : { + "type" : "integer", + "description" : "index of the Tx device set to connect the Tx side to" + }, + "rx2TxDelayMs" : { + "type" : "integer", + "description" : "Delay in milliseconds from Rx off to Tx on" + }, + "tx2RxDelayMs" : { + "type" : "integer", + "description" : "Delay in milliseconds from Tx off to Rx on" + }, + "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" : "Simple PTT settings" }; defs.SoapySDRInputSettings = { "properties" : { @@ -6623,82 +6199,6 @@ margin-bottom: 20px; } }, "description" : "SoapySDR" -}; - defs.SoapySDRReport = { - "properties" : { - "deviceSettingsArgs" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ArgInfo" - } - }, - "streamSettingsArgs" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ArgInfo" - } - }, - "hasDCAutoCorrection" : { - "type" : "integer", - "description" : "boolean not zero for true" - }, - "hasDCOffsetValue" : { - "type" : "integer", - "description" : "boolean not zero for true" - }, - "hasIQBalanceValue" : { - "type" : "integer", - "description" : "boolean not zero for true" - }, - "hasFrequencyCorrectionValue" : { - "type" : "integer", - "description" : "boolean not zero for true" - }, - "antennas" : { - "type" : "array", - "items" : { - "type" : "string" - } - }, - "hasAGC" : { - "type" : "integer", - "description" : "boolean not zero for true" - }, - "gainRange" : { - "$ref" : "#/definitions/RangeFloat" - }, - "gainSettings" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/SoapySDRGainSetting" - } - }, - "frequencySettings" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/SoapySDRFrequencySetting" - } - }, - "frequencySettingsArgs" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ArgInfo" - } - }, - "ratesRanges" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/RangeFloat" - } - }, - "bandwidthsRanges" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/RangeFloat" - } - } - }, - "description" : "SoapySDR" }; defs.SuccessResponse = { "required" : [ "message" ], @@ -7344,29 +6844,6 @@ margin-bottom: 20px; } }, "description" : "WFMMod" -}; - defs.XtrxInputReport = { - "properties" : { - "success" : { - "type" : "integer", - "description" : "1 if info was successfully retrieved else 0" - }, - "fifoSize" : { - "type" : "integer" - }, - "fifoFill" : { - "type" : "integer" - }, - "temperature" : { - "type" : "number", - "format" : "float" - }, - "gpsLock" : { - "type" : "integer", - "description" : "1 if GPSDO is locked else 0" - } - }, - "description" : "XTRX" }; defs.XtrxInputSettings = { "properties" : { @@ -7458,29 +6935,6 @@ margin-bottom: 20px; } }, "description" : "XTRX" -}; - defs.XtrxOutputReport = { - "properties" : { - "success" : { - "type" : "integer", - "description" : "1 if info was successfully retrieved else 0" - }, - "fifoSize" : { - "type" : "integer" - }, - "fifoFill" : { - "type" : "integer" - }, - "temperature" : { - "type" : "number", - "format" : "float" - }, - "gpsLock" : { - "type" : "integer", - "description" : "1 if GPSDO is locked else 0" - } - }, - "description" : "XTRX" }; defs.XtrxOutputSettings = { "properties" : { @@ -7634,6 +7088,40 @@ margin-bottom: 20px;
  • instanceDeviceSetPost
    • +
  • API Methods - FeatureSet
    • +
  • + featuresetFEatureSettingsPut +
    • +
  • + featuresetFeatureActionsPost +
    • +
  • + featuresetFeatureDelete +
    • +
  • + featuresetFeaturePost +
    • +
  • + featuresetFeatureReportGet +
    • +
  • + featuresetFeatureRunDelete +
    • +
  • + featuresetFeatureRunGet +
    • +
  • + featuresetFeatureRunPost +
    • +
  • + featuresetFeatureSettingsGet +
    • +
  • + featuresetFeatureSettingsPatch +
    • +
  • + featuresetGet +
  • API Methods - Instance
  • instanceAMBEDevicesDelete @@ -7692,6 +7180,9 @@ margin-bottom: 20px;
  • instanceDevices
    • +
  • + instanceFeatureSetsGet +
  • instanceLimeRFEConfigGet
    • @@ -8331,7 +7822,7 @@ $(document).ready(function() {

    -

    delete channel (server only)

    +

    delete a channel


    /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}
    @@ -8684,7 +8175,7 @@ except ApiException as e: -

    Status: 404 - Device or channel not found

    +

    Status: 404 - Device set or channel not found