mirror of
https://github.com/f4exb/sdrangel.git
synced 2026-07-23 02:24:16 -04:00
Web API: implemented instanceDVSerialGet
This commit is contained in:
f4exb
@@ -4015,6 +4015,9 @@ margin-bottom: 20px;
|
||||
<li data-group="Instance" data-name="instanceChannels" class="">
|
||||
<a href="#api-Instance-instanceChannels">instanceChannels</a>
|
||||
</li>
|
||||
<li data-group="Instance" data-name="instanceDVSerialGet" class="">
|
||||
<a href="#api-Instance-instanceDVSerialGet">instanceDVSerialGet</a>
|
||||
</li>
|
||||
<li data-group="Instance" data-name="instanceDVSerialPatch" class="">
|
||||
<a href="#api-Instance-instanceDVSerialPatch">instanceDVSerialPatch</a>
|
||||
</li>
|
||||
@@ -4076,7 +4079,7 @@ margin-bottom: 20px;
|
||||
<div id="header">
|
||||
<div id="api-_">
|
||||
<h2 id="welcome-to-apidoc">API and SDK Documentation</h2>
|
||||
<div class="app-desc">Version: 4.0.0</div>
|
||||
<div class="app-desc">Version: 4.0.6</div>
|
||||
<hr>
|
||||
<div><p>This is the web REST/JSON API of SDRangel SDR software. SDRangel is an Open Source Qt5/OpenGL 3.0+ (4.3+ in Windows) GUI and server Software Defined Radio and signal analyzer in software. It supports Airspy, BladeRF, HackRF, LimeSDR, PlutoSDR, RTL-SDR, SDRplay RSP1 and FunCube</p>
|
||||
<hr />
|
||||
@@ -16090,6 +16093,341 @@ except ApiException as e:
|
||||
</article>
|
||||
</div>
|
||||
<hr>
|
||||
<div id="api-Instance-instanceDVSerialGet">
|
||||
<article id="api-Instance-instanceDVSerialGet-0" data-group="User" data-name="instanceDVSerialGet" data-version="0">
|
||||
<div class="pull-left">
|
||||
<h1>instanceDVSerialGet</h1>
|
||||
<p></p>
|
||||
</div>
|
||||
<div class="pull-right"></div>
|
||||
<div class="clearfix"></div>
|
||||
<p></p>
|
||||
<p class="marked">Get DV serial processing parameters for AMBE frames decoding in digital voice modes</p>
|
||||
<p></p>
|
||||
<br />
|
||||
<pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/sdrangel/dvserial</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-Instance-instanceDVSerialGet-0-curl">Curl</a></li>
|
||||
<li class=""><a href="#examples-Instance-instanceDVSerialGet-0-java">Java</a></li>
|
||||
<li class=""><a href="#examples-Instance-instanceDVSerialGet-0-android">Android</a></li>
|
||||
<!--<li class=""><a href="#examples-Instance-instanceDVSerialGet-0-groovy">Groovy</a></li>-->
|
||||
<li class=""><a href="#examples-Instance-instanceDVSerialGet-0-objc">Obj-C</a></li>
|
||||
<li class=""><a href="#examples-Instance-instanceDVSerialGet-0-javascript">JavaScript</a></li>
|
||||
<!--<li class=""><a href="#examples-Instance-instanceDVSerialGet-0-angular">Angular</a></li>-->
|
||||
<li class=""><a href="#examples-Instance-instanceDVSerialGet-0-csharp">C#</a></li>
|
||||
<li class=""><a href="#examples-Instance-instanceDVSerialGet-0-php">PHP</a></li>
|
||||
<li class=""><a href="#examples-Instance-instanceDVSerialGet-0-perl">Perl</a></li>
|
||||
<li class=""><a href="#examples-Instance-instanceDVSerialGet-0-python">Python</a></li>
|
||||
</ul>
|
||||
|
||||
<div class="tab-content">
|
||||
<div class="tab-pane active" id="examples-Instance-instanceDVSerialGet-0-curl">
|
||||
<pre class="prettyprint"><code class="language-bsh">curl -X GET "http://localhost/sdrangel/dvserial"</code></pre>
|
||||
</div>
|
||||
<div class="tab-pane" id="examples-Instance-instanceDVSerialGet-0-java">
|
||||
<pre class="prettyprint"><code class="language-java">import SWGSDRangel.*;
|
||||
import SWGSDRangel.auth.*;
|
||||
import SWGSDRangel.model.*;
|
||||
import SWGSDRangel.api.InstanceApi;
|
||||
|
||||
import java.io.File;
|
||||
import java.util.*;
|
||||
|
||||
public class InstanceApiExample {
|
||||
|
||||
public static void main(String[] args) {
|
||||
|
||||
InstanceApi apiInstance = new InstanceApi();
|
||||
try {
|
||||
DVSeralDevices result = apiInstance.instanceDVSerialGet();
|
||||
System.out.println(result);
|
||||
} catch (ApiException e) {
|
||||
System.err.println("Exception when calling InstanceApi#instanceDVSerialGet");
|
||||
e.printStackTrace();
|
||||
}
|
||||
}
|
||||
}</code></pre>
|
||||
</div>
|
||||
|
||||
<div class="tab-pane" id="examples-Instance-instanceDVSerialGet-0-android">
|
||||
<pre class="prettyprint"><code class="language-java">import SWGSDRangel.api.InstanceApi;
|
||||
|
||||
public class InstanceApiExample {
|
||||
|
||||
public static void main(String[] args) {
|
||||
InstanceApi apiInstance = new InstanceApi();
|
||||
try {
|
||||
DVSeralDevices result = apiInstance.instanceDVSerialGet();
|
||||
System.out.println(result);
|
||||
} catch (ApiException e) {
|
||||
System.err.println("Exception when calling InstanceApi#instanceDVSerialGet");
|
||||
e.printStackTrace();
|
||||
}
|
||||
}
|
||||
}</code></pre>
|
||||
</div>
|
||||
<!--
|
||||
<div class="tab-pane" id="examples-Instance-instanceDVSerialGet-0-groovy">
|
||||
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
|
||||
</div> -->
|
||||
<div class="tab-pane" id="examples-Instance-instanceDVSerialGet-0-objc">
|
||||
<pre class="prettyprint"><code class="language-cpp">
|
||||
InstanceApi *apiInstance = [[InstanceApi alloc] init];
|
||||
|
||||
[apiInstance instanceDVSerialGetWithCompletionHandler:
|
||||
^(DVSeralDevices output, NSError* error) {
|
||||
if (output) {
|
||||
NSLog(@"%@", output);
|
||||
}
|
||||
if (error) {
|
||||
NSLog(@"Error: %@", error);
|
||||
}
|
||||
}];
|
||||
</code></pre>
|
||||
</div>
|
||||
|
||||
<div class="tab-pane" id="examples-Instance-instanceDVSerialGet-0-javascript">
|
||||
<pre class="prettyprint"><code class="language-js">var SdRangel = require('sd_rangel');
|
||||
|
||||
var api = new SdRangel.InstanceApi()
|
||||
|
||||
var callback = function(error, data, response) {
|
||||
if (error) {
|
||||
console.error(error);
|
||||
} else {
|
||||
console.log('API called successfully. Returned data: ' + data);
|
||||
}
|
||||
};
|
||||
api.instanceDVSerialGet(callback);
|
||||
</code></pre>
|
||||
</div>
|
||||
|
||||
<!--<div class="tab-pane" id="examples-Instance-instanceDVSerialGet-0-angular">
|
||||
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
|
||||
</div>-->
|
||||
<div class="tab-pane" id="examples-Instance-instanceDVSerialGet-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 instanceDVSerialGetExample
|
||||
{
|
||||
public void main()
|
||||
{
|
||||
|
||||
var apiInstance = new InstanceApi();
|
||||
|
||||
try
|
||||
{
|
||||
DVSeralDevices result = apiInstance.instanceDVSerialGet();
|
||||
Debug.WriteLine(result);
|
||||
}
|
||||
catch (Exception e)
|
||||
{
|
||||
Debug.Print("Exception when calling InstanceApi.instanceDVSerialGet: " + e.Message );
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
</code></pre>
|
||||
</div>
|
||||
|
||||
<div class="tab-pane" id="examples-Instance-instanceDVSerialGet-0-php">
|
||||
<pre class="prettyprint"><code class="language-php"><?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
$api_instance = new Swagger\Client\Api\InstanceApi();
|
||||
|
||||
try {
|
||||
$result = $api_instance->instanceDVSerialGet();
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling InstanceApi->instanceDVSerialGet: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?></code></pre>
|
||||
</div>
|
||||
|
||||
<div class="tab-pane" id="examples-Instance-instanceDVSerialGet-0-perl">
|
||||
<pre class="prettyprint"><code class="language-perl">use Data::Dumper;
|
||||
use SWGSDRangel::Configuration;
|
||||
use SWGSDRangel::InstanceApi;
|
||||
|
||||
my $api_instance = SWGSDRangel::InstanceApi->new();
|
||||
|
||||
eval {
|
||||
my $result = $api_instance->instanceDVSerialGet();
|
||||
print Dumper($result);
|
||||
};
|
||||
if ($@) {
|
||||
warn "Exception when calling InstanceApi->instanceDVSerialGet: $@\n";
|
||||
}</code></pre>
|
||||
</div>
|
||||
|
||||
<div class="tab-pane" id="examples-Instance-instanceDVSerialGet-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.InstanceApi()
|
||||
|
||||
try:
|
||||
api_response = api_instance.instance_dv_serial_get()
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling InstanceApi->instanceDVSerialGet: %s\n" % e)</code></pre>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<h2>Parameters</h2>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2>Responses</h2>
|
||||
<h3> Status: 200 - On success return list of devices or empty list if unset </h3>
|
||||
|
||||
<ul class="nav nav-tabs nav-tabs-examples" >
|
||||
<li class="active">
|
||||
<a data-toggle="tab" href="#responses-instanceDVSerialGet-200-schema">Schema</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
|
||||
<div class="tab-content" style='margin-bottom: 10px;'>
|
||||
<div class="tab-pane active" id="responses-instanceDVSerialGet-200-schema">
|
||||
<div id='responses-instanceDVSerialGet-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 return list of devices or empty list if unset",
|
||||
"schema" : {
|
||||
"$ref" : "#/definitions/DVSeralDevices"
|
||||
}
|
||||
};
|
||||
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-instanceDVSerialGet-200-schema-data').val(stringify(schema));
|
||||
var result = $('#responses-instanceDVSerialGet-200-schema-200');
|
||||
result.empty();
|
||||
result.append(view.render());
|
||||
});
|
||||
</script>
|
||||
</div>
|
||||
<input id='responses-instanceDVSerialGet-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-instanceDVSerialGet-500-schema">Schema</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
|
||||
<div class="tab-content" style='margin-bottom: 10px;'>
|
||||
<div class="tab-pane active" id="responses-instanceDVSerialGet-500-schema">
|
||||
<div id='responses-instanceDVSerialGet-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-instanceDVSerialGet-500-schema-data').val(stringify(schema));
|
||||
var result = $('#responses-instanceDVSerialGet-500-schema-500');
|
||||
result.empty();
|
||||
result.append(view.render());
|
||||
});
|
||||
</script>
|
||||
</div>
|
||||
<input id='responses-instanceDVSerialGet-500-schema-data' type='hidden' value=''></input>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<h3> Status: 501 - Function not implemented </h3>
|
||||
|
||||
<ul class="nav nav-tabs nav-tabs-examples" >
|
||||
<li class="active">
|
||||
<a data-toggle="tab" href="#responses-instanceDVSerialGet-501-schema">Schema</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
|
||||
<div class="tab-content" style='margin-bottom: 10px;'>
|
||||
<div class="tab-pane active" id="responses-instanceDVSerialGet-501-schema">
|
||||
<div id='responses-instanceDVSerialGet-501-schema-501' 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" : "Function not implemented",
|
||||
"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-instanceDVSerialGet-501-schema-data').val(stringify(schema));
|
||||
var result = $('#responses-instanceDVSerialGet-501-schema-501');
|
||||
result.empty();
|
||||
result.append(view.render());
|
||||
});
|
||||
</script>
|
||||
</div>
|
||||
<input id='responses-instanceDVSerialGet-501-schema-data' type='hidden' value=''></input>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</article>
|
||||
</div>
|
||||
<hr>
|
||||
<div id="api-Instance-instanceDVSerialPatch">
|
||||
<article id="api-Instance-instanceDVSerialPatch-0" data-group="User" data-name="instanceDVSerialPatch" data-version="0">
|
||||
<div class="pull-left">
|
||||
@@ -22609,7 +22947,7 @@ except ApiException as e:
|
||||
</div>
|
||||
<div id="generator">
|
||||
<div class="content">
|
||||
Generated 2018-05-30T00:50:44.029+02:00
|
||||
Generated 2018-08-02T21:39:46.879+02:00
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
Reference in New Issue
Block a user