diff --git a/sdrbase/resources/webapi.qrc b/sdrbase/resources/webapi.qrc index 2af764b7d..f8dbbfa78 100644 --- a/sdrbase/resources/webapi.qrc +++ b/sdrbase/resources/webapi.qrc @@ -15,6 +15,7 @@ webapi/doc/swagger/include/BladeRF2.yaml webapi/doc/swagger/include/ChannelActions.yaml webapi/doc/swagger/include/ChannelAnalyzer.yaml + webapi/doc/swagger/include/ChannelReport.yaml webapi/doc/swagger/include/ChannelSettings.yaml webapi/doc/swagger/include/ChirpChatDemod.yaml webapi/doc/swagger/include/ChirpChatMod.yaml @@ -27,6 +28,9 @@ webapi/doc/swagger/include/DeviceReports.yaml webapi/doc/swagger/include/FCDPro.yaml webapi/doc/swagger/include/FCDProPlus.yaml + webapi/doc/swagger/include/FeatureActions.yaml + webapi/doc/swagger/include/FeatureReport.yaml + webapi/doc/swagger/include/FeatureSettings.yaml webapi/doc/swagger/include/FileSink.yaml webapi/doc/swagger/include/FileSource.yaml webapi/doc/swagger/include/FileInput.yaml @@ -59,6 +63,7 @@ webapi/doc/swagger/include/SDRPlay.yaml webapi/doc/swagger/include/SigMFFileInput.yaml webapi/doc/swagger/include/SigMFFileSink.yaml + webapi/doc/swagger/include/SimplePTT.yaml webapi/doc/swagger/include/SoapySDR.yaml webapi/doc/swagger/include/SSBDemod.yaml webapi/doc/swagger/include/SSBMod.yaml diff --git a/sdrbase/resources/webapi/doc/html2/index.html b/sdrbase/resources/webapi/doc/html2/index.html index 5dc2a8822..0500fa7f2 100644 --- a/sdrbase/resources/webapi/doc/html2/index.html +++ b/sdrbase/resources/webapi/doc/html2/index.html @@ -2250,6 +2250,7 @@ margin-bottom: 20px; "description" : "Summarized information about channel plugin" }; defs.ChannelReport = { + "required" : [ "direction" ], "discriminator" : "channelType", "properties" : { "channelType" : { @@ -3650,6 +3651,120 @@ margin-bottom: 20px; } }, "description" : "FCDPro" +}; + defs.Feature = { + "required" : [ "id", "index", "title", "uid" ], + "properties" : { + "index" : { + "type" : "integer", + "description" : "Index in the list of features" + }, + "id" : { + "type" : "string", + "description" : "Key to identify the type of feature" + }, + "uid" : { + "type" : "integer", + "format" : "int64", + "description" : "Feature instance unique id" + }, + "title" : { + "type" : "string", + "description" : "Freeform title of the feature" + } + }, + "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.FileInputReport = { "properties" : { @@ -7458,6 +7573,67 @@ margin-bottom: 20px; } }, "description" : "SigMFFileSink" +}; + defs.SimplePTTActions = { + "properties" : { + "ptt" : { + "type" : "integer", + "description" : "PTT action\n * 0 - release\n * 1 - engage\n" + } + }, + "description" : "Simple PTT actions" +}; + defs.SimplePTTReport = { + "properties" : { + "ptt" : { + "type" : "integer", + "description" : "PTT status\n * 0 - released\n * 1 - engaged\n" + } + }, + "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.SoapySDRFrequencySetting = { "properties" : { @@ -9059,6 +9235,40 @@ margin-bottom: 20px;
  • instanceDeviceSetPost
  • + +
  • + featuresetFEatureSettingsPut +
  • +
  • + featuresetFeatureActionsPost +
  • +
  • + featuresetFeatureDelete +
  • +
  • + featuresetFeaturePost +
  • +
  • + featuresetFeatureReportGet +
  • +
  • + featuresetFeatureRunDelete +
  • +
  • + featuresetFeatureRunGet +
  • +
  • + featuresetFeatureRunPost +
  • +
  • + featuresetFeatureSettingsGet +
  • +
  • + featuresetFeatureSettingsPatch +
  • +
  • + featuresetGet +
  • instanceAMBEDevicesDelete @@ -9117,6 +9327,9 @@ margin-bottom: 20px;
  • instanceDevices
  • +
  • + instanceFeatureSetsGet +
  • instanceLimeRFEConfigGet
  • @@ -9756,7 +9969,7 @@ $(document).ready(function() {

    -

    delete channel (server only)

    +

    delete a channel


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

    Status: 404 - Device or channel not found

    +

    Status: 404 - Device set or channel not found