VE7UWU/sdrangel
1
0
Fork 0
mirror of https://github.com/f4exb/sdrangel.git synced 2024-11-22 16:08:39 -05:00
Code Issues Projects Releases Wiki Activity

Web API: added FileSource settings. Generated code and up to date documentation

Browse Source
This commit is contained in:
f4exb 2017-12-06 08:25:04 +01:00
parent c6e5e21687
commit d6b156a8d3
7 changed files with 1242 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

534
sdrbase/resources/index.html
View File

@ -924,6 +924,37 @@ margin-bottom: 20px;
}
},
"description" : "List of device sets opened in this instance"
};
defs.DeviceSettings = {
"required" : [ "deviceType" ],
"discriminator" : "deviceType",
"properties" : {
"deviceType" : {
"type" : "string"
},
"data" : {
"type" : "object",
"properties" : { }
}
},
"description" : "Base device settings"
};
defs.DeviceSettingsImpl = {
"properties" : {
"fileSource" : {
"$ref" : "#/definitions/FileSourceSettings"
},
"rtlsdr" : {
"$ref" : "#/definitions/RtlSdrSettings"
},
"limesdrInput" : {
"$ref" : "#/definitions/LimeSdrInputSettings"
},
"limesdrOutput" : {
"$ref" : "#/definitions/LimeSdrOutputSettings"
}
},
"description" : "dummy structure to handle all devices settings"
};
defs.ErrorResponse = {
"required" : [ "message" ],
@ -932,6 +963,13 @@ margin-bottom: 20px;
"type" : "string"
}
}
};
defs.FileSourceSettings = {
"properties" : {
"fileName" : {
"type" : "string"
}
}
};
defs.InstanceChannelsResponse = {
"required" : [ "channelcount" ],
@ -983,6 +1021,112 @@ margin-bottom: 20px;
}
},
"description" : "Summarized information about this SDRangel instance"
};
defs.LimeSdrInputSettings = {
"properties" : {
"centerFrequency" : {
"type" : "integer",
"format" : "int64"
},
"devSampleRate" : {
"type" : "integer"
},
"log2HardDecim" : {
"type" : "integer"
},
"dcBlock" : {
"type" : "integer"
},
"iqCorrection" : {
"type" : "integer"
},
"log2SoftDecim" : {
"type" : "integer"
},
"lpfBW" : {
"type" : "integer"
},
"lpfFIREnable" : {
"type" : "integer"
},
"lpfFIRBW" : {
"type" : "integer"
},
"gain" : {
"type" : "integer"
},
"ncoEnable" : {
"type" : "integer"
},
"ncoFrequency" : {
"type" : "integer"
},
"antennaPath" : {
"type" : "integer"
},
"gainMode" : {
"type" : "integer"
},
"lnaGain" : {
"type" : "integer"
},
"tiaGain" : {
"type" : "integer"
},
"pgaGain" : {
"type" : "integer"
},
"extClock" : {
"type" : "integer"
},
"extClockFreq" : {
"type" : "integer"
}
}
};
defs.LimeSdrOutputSettings = {
"properties" : {
"centerFrequency" : {
"type" : "integer",
"format" : "int64"
},
"devSampleRate" : {
"type" : "integer"
},
"log2HardInterp" : {
"type" : "integer"
},
"log2SoftInterp" : {
"type" : "integer"
},
"lpfBW" : {
"type" : "integer"
},
"lpfFIREnable" : {
"type" : "integer"
},
"lpfFIRBW" : {
"type" : "integer"
},
"gain" : {
"type" : "integer"
},
"ncoEnable" : {
"type" : "integer"
},
"ncoFrequency" : {
"type" : "integer"
},
"antennaPath" : {
"type" : "integer"
},
"extClock" : {
"type" : "integer"
},
"extClockFreq" : {
"type" : "integer"
}
}
};
defs.LocationInformation = {
"required" : [ "latitude", "longitude" ],
@ -1111,6 +1255,51 @@ margin-bottom: 20px;
}
},
"description" : "Settings presets"
};
defs.RtlSdrSettings = {
"properties" : {
"devSampleRate" : {
"type" : "integer"
},
"lowSampleRate" : {
"type" : "integer"
},
"centerFrequency" : {
"type" : "integer",
"format" : "int64"
},
"gain" : {
"type" : "integer"
},
"loPpmCorrection" : {
"type" : "integer"
},
"log2Decim" : {
"type" : "integer"
},
"fcPos" : {
"type" : "integer"
},
"dcBlock" : {
"type" : "integer"
},
"iqImbalance" : {
"type" : "integer"
},
"agc" : {
"type" : "integer"
},
"noModMode" : {
"type" : "integer"
},
"transverterMode" : {
"type" : "integer"
},
"transverterDeltaFrequency" : {
"type" : "integer",
"format" : "int64"
}
}
};
defs.SamplingDevice = {
"required" : [ "bandwidth", "centerFrequency", "hwType", "index", "sequence", "serial", "state", "streamIndex" ],
@ -1187,6 +1376,9 @@ margin-bottom: 20px;
<li class="nav-fixed nav-header active" data-group="_"><a href="#api-_">API Summary</a></li>
<li class="nav-header" data-group="DeviceSet"><a href="#api-DeviceSet">API Methods - DeviceSet</a></li>
<li data-group="DeviceSet" data-name="devicesetDeviceGet" class="">
<a href="#api-DeviceSet-devicesetDeviceGet">devicesetDeviceGet</a>
</li>
<li data-group="DeviceSet" data-name="devicesetDevicePut" class="">
<a href="#api-DeviceSet-devicesetDevicePut">devicesetDevicePut</a>
</li>
@ -1269,6 +1461,346 @@ margin-bottom: 20px;
<div id="sections">
<section id="api-DeviceSet">
<h1>DeviceSet</h1>
<div id="api-DeviceSet-devicesetDeviceGet">
<article id="api-DeviceSet-devicesetDeviceGet-0" data-group="User" data-name="devicesetDeviceGet" data-version="0">
<div class="pull-left">
<h1>devicesetDeviceGet</h1>
<p></p>
</div>
<div class="pull-right"></div>
<div class="clearfix"></div>
<p></p>
<p class="marked">Get device settings</p>
<p></p>
<br />
<pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/sdrangel/deviceset/{deviceSetIndex}/device</span></code></pre>
<p>
<h3>Usage and SDK Samples</h3>
</p>
<ul class="nav nav-tabs nav-tabs-examples">
<li class="active"><a href="#examples-DeviceSet-devicesetDeviceGet-0-curl">Curl</a></li>
<li class=""><a href="#examples-DeviceSet-devicesetDeviceGet-0-java">Java</a></li>
<li class=""><a href="#examples-DeviceSet-devicesetDeviceGet-0-android">Android</a></li>
<!--<li class=""><a href="#examples-DeviceSet-devicesetDeviceGet-0-groovy">Groovy</a></li>-->
<li class=""><a href="#examples-DeviceSet-devicesetDeviceGet-0-objc">Obj-C</a></li>
<li class=""><a href="#examples-DeviceSet-devicesetDeviceGet-0-javascript">JavaScript</a></li>
<!--<li class=""><a href="#examples-DeviceSet-devicesetDeviceGet-0-angular">Angular</a></li>-->
<li class=""><a href="#examples-DeviceSet-devicesetDeviceGet-0-csharp">C#</a></li>
<li class=""><a href="#examples-DeviceSet-devicesetDeviceGet-0-php">PHP</a></li>
<li class=""><a href="#examples-DeviceSet-devicesetDeviceGet-0-perl">Perl</a></li>
<li class=""><a href="#examples-DeviceSet-devicesetDeviceGet-0-python">Python</a></li>
</ul>
<div class="tab-content">
<div class="tab-pane active" id="examples-DeviceSet-devicesetDeviceGet-0-curl">
<pre class="prettyprint"><code class="language-bsh">curl -X GET "http://localhost:8091/sdrangel/deviceset/{deviceSetIndex}/device"</code></pre>
</div>
<div class="tab-pane" id="examples-DeviceSet-devicesetDeviceGet-0-java">
<pre class="prettyprint"><code class="language-java">import SWGSDRangel.*;
import SWGSDRangel.auth.*;
import SWGSDRangel.model.*;
import SWGSDRangel.api.DeviceSetApi;
import java.io.File;
import java.util.*;
public class DeviceSetApiExample {
public static void main(String[] args) {
DeviceSetApi apiInstance = new DeviceSetApi();
Integer deviceSetIndex = 56; // Integer | Index of device set in the device set list
try {
DeviceSettings result = apiInstance.devicesetDeviceGet(deviceSetIndex);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DeviceSetApi#devicesetDeviceGet");
e.printStackTrace();
}
}
}</code></pre>
</div>
<div class="tab-pane" id="examples-DeviceSet-devicesetDeviceGet-0-android">
<pre class="prettyprint"><code class="language-java">import SWGSDRangel.api.DeviceSetApi;
public class DeviceSetApiExample {
public static void main(String[] args) {
DeviceSetApi apiInstance = new DeviceSetApi();
Integer deviceSetIndex = 56; // Integer | Index of device set in the device set list
try {
DeviceSettings result = apiInstance.devicesetDeviceGet(deviceSetIndex);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DeviceSetApi#devicesetDeviceGet");
e.printStackTrace();
}
}
}</code></pre>
</div>
<!--
<div class="tab-pane" id="examples-DeviceSet-devicesetDeviceGet-0-groovy">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div> -->
<div class="tab-pane" id="examples-DeviceSet-devicesetDeviceGet-0-objc">
<pre class="prettyprint"><code class="language-cpp">Integer *deviceSetIndex = 56; // Index of device set in the device set list
DeviceSetApi *apiInstance = [[DeviceSetApi alloc] init];
[apiInstance devicesetDeviceGetWith:deviceSetIndex
completionHandler: ^(DeviceSettings output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
</code></pre>
</div>
<div class="tab-pane" id="examples-DeviceSet-devicesetDeviceGet-0-javascript">
<pre class="prettyprint"><code class="language-js">var SdRangel = require('sd_rangel');
var api = new SdRangel.DeviceSetApi()
var deviceSetIndex = 56; // {Integer} Index of device set in the device set list
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.devicesetDeviceGet(deviceSetIndex, callback);
</code></pre>
</div>
<!--<div class="tab-pane" id="examples-DeviceSet-devicesetDeviceGet-0-angular">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div>-->
<div class="tab-pane" id="examples-DeviceSet-devicesetDeviceGet-0-csharp">
<pre class="prettyprint"><code class="language-cs">using System;
using System.Diagnostics;
using SWGSDRangel.Api;
using SWGSDRangel.Client;
using SWGSDRangel.Model;
namespace Example
{
public class devicesetDeviceGetExample
{
public void main()
{
var apiInstance = new DeviceSetApi();
var deviceSetIndex = 56; // Integer | Index of device set in the device set list
try
{
DeviceSettings result = apiInstance.devicesetDeviceGet(deviceSetIndex);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling DeviceSetApi.devicesetDeviceGet: " + e.Message );
}
}
}
}
</code></pre>
</div>
<div class="tab-pane" id="examples-DeviceSet-devicesetDeviceGet-0-php">
<pre class="prettyprint"><code class="language-php"><&#63;php
require_once(__DIR__ . '/vendor/autoload.php');
$api_instance = new Swagger\Client\Api\DeviceSetApi();
$deviceSetIndex = 56; // Integer | Index of device set in the device set list
try {
$result = $api_instance->devicesetDeviceGet($deviceSetIndex);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling DeviceSetApi->devicesetDeviceGet: ', $e->getMessage(), PHP_EOL;
}
?></code></pre>
</div>
<div class="tab-pane" id="examples-DeviceSet-devicesetDeviceGet-0-perl">
<pre class="prettyprint"><code class="language-perl">use Data::Dumper;
use SWGSDRangel::Configuration;
use SWGSDRangel::DeviceSetApi;
my $api_instance = SWGSDRangel::DeviceSetApi->new();
my $deviceSetIndex = 56; # Integer | Index of device set in the device set list
eval {
my $result = $api_instance->devicesetDeviceGet(deviceSetIndex => $deviceSetIndex);
print Dumper($result);
};
if ($@) {
warn "Exception when calling DeviceSetApi->devicesetDeviceGet: $@\n";
}</code></pre>
</div>
<div class="tab-pane" id="examples-DeviceSet-devicesetDeviceGet-0-python">
<pre class="prettyprint"><code class="language-python">from __future__ import print_statement
import time
import swagger_sdrangel
from swagger_sdrangel.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = swagger_sdrangel.DeviceSetApi()
deviceSetIndex = 56 # Integer | Index of device set in the device set list
try:
api_response = api_instance.deviceset_device_get(deviceSetIndex)
pprint(api_response)
except ApiException as e:
print("Exception when calling DeviceSetApi->devicesetDeviceGet: %s\n" % e)</code></pre>
</div>
</div>
<h2>Parameters</h2>
<div class="methodsubtabletitle">Path parameters</div>
<table id="methodsubtable">
<tr>
<th width="150px">Name</th>
<th>Description</th>
</tr>
<tr><td style="width:150px;">deviceSetIndex*</td>
<td>
<div id="d2e199_devicesetDeviceGet_deviceSetIndex">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
Integer
</span>
<div class="inner description">
Index of device set in the device set list
</div>
</div>
<div class="inner required">
Required
</div>
</div>
</div>
</td>
</tr>
</table>
<h2>Responses</h2>
<h3> Status: 200 - On success returns current settings values </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
<a data-toggle="tab" href="#responses-devicesetDeviceGet-200-schema">Schema</a>
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
<div class="tab-pane active" id="responses-devicesetDeviceGet-200-schema">
<div id='responses-devicesetDeviceGet-200-schema-200' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
var schemaWrapper = {
"description" : "On success returns current settings values",
"schema" : {
"$ref" : "#/definitions/DeviceSettings"
}
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-devicesetDeviceGet-200-schema-data').val(stringify(schema));
var result = $('#responses-devicesetDeviceGet-200-schema-200');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-devicesetDeviceGet-200-schema-data' type='hidden' value=''></input>
</div>
</div>
<h3> Status: 500 - Error </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
<a data-toggle="tab" href="#responses-devicesetDeviceGet-500-schema">Schema</a>
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
<div class="tab-pane active" id="responses-devicesetDeviceGet-500-schema">
<div id='responses-devicesetDeviceGet-500-schema-500' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
var schemaWrapper = {
"description" : "Error",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-devicesetDeviceGet-500-schema-data').val(stringify(schema));
var result = $('#responses-devicesetDeviceGet-500-schema-500');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-devicesetDeviceGet-500-schema-data' type='hidden' value=''></input>
</div>
</div>
<h3> Status: 501 - Function not implemented </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
</div>
</article>
</div>
<hr>
<div id="api-DeviceSet-devicesetDevicePut">
<article id="api-DeviceSet-devicesetDevicePut-0" data-group="User" data-name="devicesetDevicePut" data-version="0">
<div class="pull-left">
@ -8544,7 +9076,7 @@ except ApiException as e:
</div>
<div id="generator">
<div class="content">
Generated 2017-12-02T05:26:15.665+01:00
Generated 2017-12-06T08:23:29.921+01:00
</div>
</div>
</div>

534
swagger/sdrangel/code/html2/index.html
View File

@ -924,6 +924,37 @@ margin-bottom: 20px;
}
},
"description" : "List of device sets opened in this instance"
};
defs.DeviceSettings = {
"required" : [ "deviceType" ],
"discriminator" : "deviceType",
"properties" : {
"deviceType" : {
"type" : "string"
},
"data" : {
"type" : "object",
"properties" : { }
}
},
"description" : "Base device settings"
};
defs.DeviceSettingsImpl = {
"properties" : {
"fileSource" : {
"$ref" : "#/definitions/FileSourceSettings"
},
"rtlsdr" : {
"$ref" : "#/definitions/RtlSdrSettings"
},
"limesdrInput" : {
"$ref" : "#/definitions/LimeSdrInputSettings"
},
"limesdrOutput" : {
"$ref" : "#/definitions/LimeSdrOutputSettings"
}
},
"description" : "dummy structure to handle all devices settings"
};
defs.ErrorResponse = {
"required" : [ "message" ],
@ -932,6 +963,13 @@ margin-bottom: 20px;
"type" : "string"
}
}
};
defs.FileSourceSettings = {
"properties" : {
"fileName" : {
"type" : "string"
}
}
};
defs.InstanceChannelsResponse = {
"required" : [ "channelcount" ],
@ -983,6 +1021,112 @@ margin-bottom: 20px;
}
},
"description" : "Summarized information about this SDRangel instance"
};
defs.LimeSdrInputSettings = {
"properties" : {
"centerFrequency" : {
"type" : "integer",
"format" : "int64"
},
"devSampleRate" : {
"type" : "integer"
},
"log2HardDecim" : {
"type" : "integer"
},
"dcBlock" : {
"type" : "integer"
},
"iqCorrection" : {
"type" : "integer"
},
"log2SoftDecim" : {
"type" : "integer"
},
"lpfBW" : {
"type" : "integer"
},
"lpfFIREnable" : {
"type" : "integer"
},
"lpfFIRBW" : {
"type" : "integer"
},
"gain" : {
"type" : "integer"
},
"ncoEnable" : {
"type" : "integer"
},
"ncoFrequency" : {
"type" : "integer"
},
"antennaPath" : {
"type" : "integer"
},
"gainMode" : {
"type" : "integer"
},
"lnaGain" : {
"type" : "integer"
},
"tiaGain" : {
"type" : "integer"
},
"pgaGain" : {
"type" : "integer"
},
"extClock" : {
"type" : "integer"
},
"extClockFreq" : {
"type" : "integer"
}
}
};
defs.LimeSdrOutputSettings = {
"properties" : {
"centerFrequency" : {
"type" : "integer",
"format" : "int64"
},
"devSampleRate" : {
"type" : "integer"
},
"log2HardInterp" : {
"type" : "integer"
},
"log2SoftInterp" : {
"type" : "integer"
},
"lpfBW" : {
"type" : "integer"
},
"lpfFIREnable" : {
"type" : "integer"
},
"lpfFIRBW" : {
"type" : "integer"
},
"gain" : {
"type" : "integer"
},
"ncoEnable" : {
"type" : "integer"
},
"ncoFrequency" : {
"type" : "integer"
},
"antennaPath" : {
"type" : "integer"
},
"extClock" : {
"type" : "integer"
},
"extClockFreq" : {
"type" : "integer"
}
}
};
defs.LocationInformation = {
"required" : [ "latitude", "longitude" ],
@ -1111,6 +1255,51 @@ margin-bottom: 20px;
}
},
"description" : "Settings presets"
};
defs.RtlSdrSettings = {
"properties" : {
"devSampleRate" : {
"type" : "integer"
},
"lowSampleRate" : {
"type" : "integer"
},
"centerFrequency" : {
"type" : "integer",
"format" : "int64"
},
"gain" : {
"type" : "integer"
},
"loPpmCorrection" : {
"type" : "integer"
},
"log2Decim" : {
"type" : "integer"
},
"fcPos" : {
"type" : "integer"
},
"dcBlock" : {
"type" : "integer"
},
"iqImbalance" : {
"type" : "integer"
},
"agc" : {
"type" : "integer"
},
"noModMode" : {
"type" : "integer"
},
"transverterMode" : {
"type" : "integer"
},
"transverterDeltaFrequency" : {
"type" : "integer",
"format" : "int64"
}
}
};
defs.SamplingDevice = {
"required" : [ "bandwidth", "centerFrequency", "hwType", "index", "sequence", "serial", "state", "streamIndex" ],
@ -1187,6 +1376,9 @@ margin-bottom: 20px;
<li class="nav-fixed nav-header active" data-group="_"><a href="#api-_">API Summary</a></li>
<li class="nav-header" data-group="DeviceSet"><a href="#api-DeviceSet">API Methods - DeviceSet</a></li>
<li data-group="DeviceSet" data-name="devicesetDeviceGet" class="">
<a href="#api-DeviceSet-devicesetDeviceGet">devicesetDeviceGet</a>
</li>
<li data-group="DeviceSet" data-name="devicesetDevicePut" class="">
<a href="#api-DeviceSet-devicesetDevicePut">devicesetDevicePut</a>
</li>
@ -1269,6 +1461,346 @@ margin-bottom: 20px;
<div id="sections">
<section id="api-DeviceSet">
<h1>DeviceSet</h1>
<div id="api-DeviceSet-devicesetDeviceGet">
<article id="api-DeviceSet-devicesetDeviceGet-0" data-group="User" data-name="devicesetDeviceGet" data-version="0">
<div class="pull-left">
<h1>devicesetDeviceGet</h1>
<p></p>
</div>
<div class="pull-right"></div>
<div class="clearfix"></div>
<p></p>
<p class="marked">Get device settings</p>
<p></p>
<br />
<pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/sdrangel/deviceset/{deviceSetIndex}/device</span></code></pre>
<p>
<h3>Usage and SDK Samples</h3>
</p>
<ul class="nav nav-tabs nav-tabs-examples">
<li class="active"><a href="#examples-DeviceSet-devicesetDeviceGet-0-curl">Curl</a></li>
<li class=""><a href="#examples-DeviceSet-devicesetDeviceGet-0-java">Java</a></li>
<li class=""><a href="#examples-DeviceSet-devicesetDeviceGet-0-android">Android</a></li>
<!--<li class=""><a href="#examples-DeviceSet-devicesetDeviceGet-0-groovy">Groovy</a></li>-->
<li class=""><a href="#examples-DeviceSet-devicesetDeviceGet-0-objc">Obj-C</a></li>
<li class=""><a href="#examples-DeviceSet-devicesetDeviceGet-0-javascript">JavaScript</a></li>
<!--<li class=""><a href="#examples-DeviceSet-devicesetDeviceGet-0-angular">Angular</a></li>-->
<li class=""><a href="#examples-DeviceSet-devicesetDeviceGet-0-csharp">C#</a></li>
<li class=""><a href="#examples-DeviceSet-devicesetDeviceGet-0-php">PHP</a></li>
<li class=""><a href="#examples-DeviceSet-devicesetDeviceGet-0-perl">Perl</a></li>
<li class=""><a href="#examples-DeviceSet-devicesetDeviceGet-0-python">Python</a></li>
</ul>
<div class="tab-content">
<div class="tab-pane active" id="examples-DeviceSet-devicesetDeviceGet-0-curl">
<pre class="prettyprint"><code class="language-bsh">curl -X GET "http://localhost:8091/sdrangel/deviceset/{deviceSetIndex}/device"</code></pre>
</div>
<div class="tab-pane" id="examples-DeviceSet-devicesetDeviceGet-0-java">
<pre class="prettyprint"><code class="language-java">import SWGSDRangel.*;
import SWGSDRangel.auth.*;
import SWGSDRangel.model.*;
import SWGSDRangel.api.DeviceSetApi;
import java.io.File;
import java.util.*;
public class DeviceSetApiExample {
public static void main(String[] args) {
DeviceSetApi apiInstance = new DeviceSetApi();
Integer deviceSetIndex = 56; // Integer | Index of device set in the device set list
try {
DeviceSettings result = apiInstance.devicesetDeviceGet(deviceSetIndex);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DeviceSetApi#devicesetDeviceGet");
e.printStackTrace();
}
}
}</code></pre>
</div>
<div class="tab-pane" id="examples-DeviceSet-devicesetDeviceGet-0-android">
<pre class="prettyprint"><code class="language-java">import SWGSDRangel.api.DeviceSetApi;
public class DeviceSetApiExample {
public static void main(String[] args) {
DeviceSetApi apiInstance = new DeviceSetApi();
Integer deviceSetIndex = 56; // Integer | Index of device set in the device set list
try {
DeviceSettings result = apiInstance.devicesetDeviceGet(deviceSetIndex);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DeviceSetApi#devicesetDeviceGet");
e.printStackTrace();
}
}
}</code></pre>
</div>
<!--
<div class="tab-pane" id="examples-DeviceSet-devicesetDeviceGet-0-groovy">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div> -->
<div class="tab-pane" id="examples-DeviceSet-devicesetDeviceGet-0-objc">
<pre class="prettyprint"><code class="language-cpp">Integer *deviceSetIndex = 56; // Index of device set in the device set list
DeviceSetApi *apiInstance = [[DeviceSetApi alloc] init];
[apiInstance devicesetDeviceGetWith:deviceSetIndex
completionHandler: ^(DeviceSettings output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
</code></pre>
</div>
<div class="tab-pane" id="examples-DeviceSet-devicesetDeviceGet-0-javascript">
<pre class="prettyprint"><code class="language-js">var SdRangel = require('sd_rangel');
var api = new SdRangel.DeviceSetApi()
var deviceSetIndex = 56; // {Integer} Index of device set in the device set list
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.devicesetDeviceGet(deviceSetIndex, callback);
</code></pre>
</div>
<!--<div class="tab-pane" id="examples-DeviceSet-devicesetDeviceGet-0-angular">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div>-->
<div class="tab-pane" id="examples-DeviceSet-devicesetDeviceGet-0-csharp">
<pre class="prettyprint"><code class="language-cs">using System;
using System.Diagnostics;
using SWGSDRangel.Api;
using SWGSDRangel.Client;
using SWGSDRangel.Model;
namespace Example
{
public class devicesetDeviceGetExample
{
public void main()
{
var apiInstance = new DeviceSetApi();
var deviceSetIndex = 56; // Integer | Index of device set in the device set list
try
{
DeviceSettings result = apiInstance.devicesetDeviceGet(deviceSetIndex);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling DeviceSetApi.devicesetDeviceGet: " + e.Message );
}
}
}
}
</code></pre>
</div>
<div class="tab-pane" id="examples-DeviceSet-devicesetDeviceGet-0-php">
<pre class="prettyprint"><code class="language-php"><&#63;php
require_once(__DIR__ . '/vendor/autoload.php');
$api_instance = new Swagger\Client\Api\DeviceSetApi();
$deviceSetIndex = 56; // Integer | Index of device set in the device set list
try {
$result = $api_instance->devicesetDeviceGet($deviceSetIndex);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling DeviceSetApi->devicesetDeviceGet: ', $e->getMessage(), PHP_EOL;
}
?></code></pre>
</div>
<div class="tab-pane" id="examples-DeviceSet-devicesetDeviceGet-0-perl">
<pre class="prettyprint"><code class="language-perl">use Data::Dumper;
use SWGSDRangel::Configuration;
use SWGSDRangel::DeviceSetApi;
my $api_instance = SWGSDRangel::DeviceSetApi->new();
my $deviceSetIndex = 56; # Integer | Index of device set in the device set list
eval {
my $result = $api_instance->devicesetDeviceGet(deviceSetIndex => $deviceSetIndex);
print Dumper($result);
};
if ($@) {
warn "Exception when calling DeviceSetApi->devicesetDeviceGet: $@\n";
}</code></pre>
</div>
<div class="tab-pane" id="examples-DeviceSet-devicesetDeviceGet-0-python">
<pre class="prettyprint"><code class="language-python">from __future__ import print_statement
import time
import swagger_sdrangel
from swagger_sdrangel.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = swagger_sdrangel.DeviceSetApi()
deviceSetIndex = 56 # Integer | Index of device set in the device set list
try:
api_response = api_instance.deviceset_device_get(deviceSetIndex)
pprint(api_response)
except ApiException as e:
print("Exception when calling DeviceSetApi->devicesetDeviceGet: %s\n" % e)</code></pre>
</div>
</div>
<h2>Parameters</h2>
<div class="methodsubtabletitle">Path parameters</div>
<table id="methodsubtable">
<tr>
<th width="150px">Name</th>
<th>Description</th>
</tr>
<tr><td style="width:150px;">deviceSetIndex*</td>
<td>
<div id="d2e199_devicesetDeviceGet_deviceSetIndex">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
Integer
</span>
<div class="inner description">
Index of device set in the device set list
</div>
</div>
<div class="inner required">
Required
</div>
</div>
</div>
</td>
</tr>
</table>
<h2>Responses</h2>
<h3> Status: 200 - On success returns current settings values </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
<a data-toggle="tab" href="#responses-devicesetDeviceGet-200-schema">Schema</a>
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
<div class="tab-pane active" id="responses-devicesetDeviceGet-200-schema">
<div id='responses-devicesetDeviceGet-200-schema-200' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
var schemaWrapper = {
"description" : "On success returns current settings values",
"schema" : {
"$ref" : "#/definitions/DeviceSettings"
}
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-devicesetDeviceGet-200-schema-data').val(stringify(schema));
var result = $('#responses-devicesetDeviceGet-200-schema-200');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-devicesetDeviceGet-200-schema-data' type='hidden' value=''></input>
</div>
</div>
<h3> Status: 500 - Error </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
<a data-toggle="tab" href="#responses-devicesetDeviceGet-500-schema">Schema</a>
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
<div class="tab-pane active" id="responses-devicesetDeviceGet-500-schema">
<div id='responses-devicesetDeviceGet-500-schema-500' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
var schemaWrapper = {
"description" : "Error",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-devicesetDeviceGet-500-schema-data').val(stringify(schema));
var result = $('#responses-devicesetDeviceGet-500-schema-500');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-devicesetDeviceGet-500-schema-data' type='hidden' value=''></input>
</div>
</div>
<h3> Status: 501 - Function not implemented </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
</div>
</article>
</div>
<hr>
<div id="api-DeviceSet-devicesetDevicePut">
<article id="api-DeviceSet-devicesetDevicePut-0" data-group="User" data-name="devicesetDevicePut" data-version="0">
<div class="pull-left">
@ -8544,7 +9076,7 @@ except ApiException as e:
</div>
<div id="generator">
<div class="content">
Generated 2017-12-02T05:26:15.665+01:00
Generated 2017-12-06T08:23:29.921+01:00
</div>
</div>
</div>

17
swagger/sdrangel/code/qt5/client/SWGDeviceSettingsImpl.cpp
View File

@ -37,6 +37,7 @@ SWGDeviceSettingsImpl::~SWGDeviceSettingsImpl() {
void
SWGDeviceSettingsImpl::init() {
file_source = new SWGFileSourceSettings();
rtlsdr = new SWGRtlSdrSettings();
limesdr_input = new SWGLimeSdrInputSettings();
limesdr_output = new SWGLimeSdrOutputSettings();
@ -45,6 +46,10 @@ SWGDeviceSettingsImpl::init() {
void
SWGDeviceSettingsImpl::cleanup() {
if(file_source != nullptr) {
delete file_source;
}
if(rtlsdr != nullptr) {
delete rtlsdr;
}
@ -69,6 +74,7 @@ SWGDeviceSettingsImpl::fromJson(QString &json) {
void
SWGDeviceSettingsImpl::fromJsonObject(QJsonObject &pJson) {
::SWGSDRangel::setValue(&file_source, pJson["fileSource"], "SWGFileSourceSettings", "SWGFileSourceSettings");
::SWGSDRangel::setValue(&rtlsdr, pJson["rtlsdr"], "SWGRtlSdrSettings", "SWGRtlSdrSettings");
::SWGSDRangel::setValue(&limesdr_input, pJson["limesdrInput"], "SWGLimeSdrInputSettings", "SWGLimeSdrInputSettings");
::SWGSDRangel::setValue(&limesdr_output, pJson["limesdrOutput"], "SWGLimeSdrOutputSettings", "SWGLimeSdrOutputSettings");
@ -88,6 +94,8 @@ QJsonObject*
SWGDeviceSettingsImpl::asJsonObject() {
QJsonObject* obj = new QJsonObject();
toJsonValue(QString("fileSource"), file_source, obj, QString("SWGFileSourceSettings"));
toJsonValue(QString("rtlsdr"), rtlsdr, obj, QString("SWGRtlSdrSettings"));
toJsonValue(QString("limesdrInput"), limesdr_input, obj, QString("SWGLimeSdrInputSettings"));
@ -97,6 +105,15 @@ SWGDeviceSettingsImpl::asJsonObject() {
return obj;
}
SWGFileSourceSettings*
SWGDeviceSettingsImpl::getFileSource() {
return file_source;
}
void
SWGDeviceSettingsImpl::setFileSource(SWGFileSourceSettings* file_source) {
this->file_source = file_source;
}
SWGRtlSdrSettings*
SWGDeviceSettingsImpl::getRtlsdr() {
return rtlsdr;

5
swagger/sdrangel/code/qt5/client/SWGDeviceSettingsImpl.h
View File

@ -22,6 +22,7 @@
#include <QJsonObject>
#include "SWGFileSourceSettings.h"
#include "SWGLimeSdrInputSettings.h"
#include "SWGLimeSdrOutputSettings.h"
#include "SWGRtlSdrSettings.h"
@ -44,6 +45,9 @@ public:
void fromJsonObject(QJsonObject &json);
SWGDeviceSettingsImpl* fromJson(QString &jsonString);
SWGFileSourceSettings* getFileSource();
void setFileSource(SWGFileSourceSettings* file_source);
SWGRtlSdrSettings* getRtlsdr();
void setRtlsdr(SWGRtlSdrSettings* rtlsdr);
@ -55,6 +59,7 @@ public:
private:
SWGFileSourceSettings* file_source;
SWGRtlSdrSettings* rtlsdr;
SWGLimeSdrInputSettings* limesdr_input;
SWGLimeSdrOutputSettings* limesdr_output;

95
swagger/sdrangel/code/qt5/client/SWGFileSourceSettings.cpp Normal file
View File

@ -0,0 +1,95 @@
/**
* SDRangel
* This is the web API of SDRangel SDR software. SDRangel is an Open Source Qt5/OpenGL 3.0+ GUI and server Software Defined Radio and signal analyzer in software. It supports Airspy, BladeRF, HackRF, LimeSDR, PlutoSDR, RTL-SDR, SDRplay RSP1 and FunCube
*
* OpenAPI spec version: 4.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 "SWGFileSourceSettings.h"
#include "SWGHelpers.h"
#include <QJsonDocument>
#include <QJsonArray>
#include <QObject>
#include <QDebug>
namespace SWGSDRangel {
SWGFileSourceSettings::SWGFileSourceSettings(QString* json) {
init();
this->fromJson(*json);
}
SWGFileSourceSettings::SWGFileSourceSettings() {
init();
}
SWGFileSourceSettings::~SWGFileSourceSettings() {
this->cleanup();
}
void
SWGFileSourceSettings::init() {
file_name = new QString("");
}
void
SWGFileSourceSettings::cleanup() {
if(file_name != nullptr) {
delete file_name;
}
}
SWGFileSourceSettings*
SWGFileSourceSettings::fromJson(QString &json) {
QByteArray array (json.toStdString().c_str());
QJsonDocument doc = QJsonDocument::fromJson(array);
QJsonObject jsonObject = doc.object();
this->fromJsonObject(jsonObject);
return this;
}
void
SWGFileSourceSettings::fromJsonObject(QJsonObject &pJson) {
::SWGSDRangel::setValue(&file_name, pJson["fileName"], "QString", "QString");
}
QString
SWGFileSourceSettings::asJson ()
{
QJsonObject* obj = this->asJsonObject();
QJsonDocument doc(*obj);
QByteArray bytes = doc.toJson();
return QString(bytes);
}
QJsonObject*
SWGFileSourceSettings::asJsonObject() {
QJsonObject* obj = new QJsonObject();
toJsonValue(QString("fileName"), file_name, obj, QString("QString"));
return obj;
}
QString*
SWGFileSourceSettings::getFileName() {
return file_name;
}
void
SWGFileSourceSettings::setFileName(QString* file_name) {
this->file_name = file_name;
}
}

55
swagger/sdrangel/code/qt5/client/SWGFileSourceSettings.h Normal file
View File

@ -0,0 +1,55 @@
/**
* SDRangel
* This is the web API of SDRangel SDR software. SDRangel is an Open Source Qt5/OpenGL 3.0+ GUI and server Software Defined Radio and signal analyzer in software. It supports Airspy, BladeRF, HackRF, LimeSDR, PlutoSDR, RTL-SDR, SDRplay RSP1 and FunCube
*
* OpenAPI spec version: 4.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.
*/
/*
* SWGFileSourceSettings.h
*
*
*/
#ifndef SWGFileSourceSettings_H_
#define SWGFileSourceSettings_H_
#include <QJsonObject>
#include <QString>
#include "SWGObject.h"
namespace SWGSDRangel {
class SWGFileSourceSettings: public SWGObject {
public:
SWGFileSourceSettings();
SWGFileSourceSettings(QString* json);
virtual ~SWGFileSourceSettings();
void init();
void cleanup();
QString asJson ();
QJsonObject* asJsonObject();
void fromJsonObject(QJsonObject &json);
SWGFileSourceSettings* fromJson(QString &jsonString);
QString* getFileName();
void setFileName(QString* file_name);
private:
QString* file_name;
};
}
#endif /* SWGFileSourceSettings_H_ */

4
swagger/sdrangel/code/qt5/client/SWGModelFactory.h
View File

@ -27,6 +27,7 @@
#include "SWGDeviceSettings.h"
#include "SWGDeviceSettingsImpl.h"
#include "SWGErrorResponse.h"
#include "SWGFileSourceSettings.h"
#include "SWGInstanceChannelsResponse.h"
#include "SWGInstanceDevicesResponse.h"
#include "SWGInstanceSummaryResponse.h"
@ -85,6 +86,9 @@ namespace SWGSDRangel {
if(QString("SWGErrorResponse").compare(type) == 0) {
return new SWGErrorResponse();
}
if(QString("SWGFileSourceSettings").compare(type) == 0) {
return new SWGFileSourceSettings();
}
if(QString("SWGInstanceChannelsResponse").compare(type) == 0) {
return new SWGInstanceChannelsResponse();
}