Browse Source

Add ATV swagger files.

chirpmodem-v8.1.0
Jon Beniston 3 weeks ago
parent
commit
3f5b79332e
  1. 32
      sdrbase/resources/webapi/doc/swagger/include/ATVDemod.yaml
  2. 2
      sdrbase/resources/webapi/doc/swagger/include/ChannelReport.yaml
  3. 2
      sdrbase/webapi/webapirequestmapper.cpp
  4. 32
      swagger/sdrangel/api/swagger/include/ATVDemod.yaml
  5. 2
      swagger/sdrangel/api/swagger/include/ChannelReport.yaml
  6. 263
      swagger/sdrangel/code/qt5/client/SWGATVDemodReport.cpp
  7. 100
      swagger/sdrangel/code/qt5/client/SWGATVDemodReport.h
  8. 25
      swagger/sdrangel/code/qt5/client/SWGChannelReport.cpp
  9. 7
      swagger/sdrangel/code/qt5/client/SWGChannelReport.h
  10. 6
      swagger/sdrangel/code/qt5/client/SWGModelFactory.h

32
sdrbase/resources/webapi/doc/swagger/include/ATVDemod.yaml

@ -176,3 +176,35 @@ ATVDemodSettings: @@ -176,3 +176,35 @@ ATVDemodSettings:
type: integer
minimum: 0
maximum: 1
ATVDemodReport:
description: ATVDemod
properties:
channelPowerDB:
description: power received in channel (dB)
type: number
format: float
channelSampleRate:
type: integer
bfoLocked:
description: "BFO PLL lock (1 for locked)."
type: integer
colourLocked:
description: "Colour burst being received (1 for yes)."
type: integer
burstAmplitude:
description: "Smoothed colour burst amplitude in IRE."
type: number
format: float
carrierFrequencyError:
description: "Vision carrier frequency error in Hz, for AM through the vestigial sideband filter."
type: number
format: float
ghostDelay:
description: "Delay of the echo being cancelled in microseconds."
type: number
format: float
ghostAmplitude:
description: "Amplitude of the echo being cancelled relative to the signal (0 when none)."
type: number
format: float

2
sdrbase/resources/webapi/doc/swagger/include/ChannelReport.yaml

@ -31,6 +31,8 @@ ChannelReport: @@ -31,6 +31,8 @@ ChannelReport:
AMModReport:
$ref: "/doc/swagger/include/AMMod.yaml#/AMModReport"
description: "Am mod report data for Channel."
ATVDemodReport:
$ref: "/doc/swagger/include/ATVDemod.yaml#/ATVDemodReport"
ATVModReport:
$ref: "/doc/swagger/include/ATVMod.yaml#/ATVModReport"
description: "Atv mod report data for Channel."

2
sdrbase/webapi/webapirequestmapper.cpp

@ -6128,6 +6128,7 @@ void WebAPIRequestMapper::resetChannelSettings(SWGSDRangel::SWGChannelSettings& @@ -6128,6 +6128,7 @@ void WebAPIRequestMapper::resetChannelSettings(SWGSDRangel::SWGChannelSettings&
channelSettings.setAmModSettings(nullptr);
channelSettings.setAptDemodSettings(nullptr);
channelSettings.setWefaxDemodSettings(nullptr);
channelSettings.setAtvDemodSettings(nullptr);
channelSettings.setAtvModSettings(nullptr);
channelSettings.setBfmDemodSettings(nullptr);
channelSettings.setBfmModSettings(nullptr);
@ -6182,6 +6183,7 @@ void WebAPIRequestMapper::resetChannelReport(SWGSDRangel::SWGChannelReport& chan @@ -6182,6 +6183,7 @@ void WebAPIRequestMapper::resetChannelReport(SWGSDRangel::SWGChannelReport& chan
channelReport.setAmDemodReport(nullptr);
channelReport.setWefaxDemodReport(nullptr);
channelReport.setAmModReport(nullptr);
channelReport.setAtvDemodReport(nullptr);
channelReport.setAtvModReport(nullptr);
channelReport.setBfmDemodReport(nullptr);
channelReport.setBfmModReport(nullptr);

32
swagger/sdrangel/api/swagger/include/ATVDemod.yaml

@ -176,3 +176,35 @@ ATVDemodSettings: @@ -176,3 +176,35 @@ ATVDemodSettings:
type: integer
minimum: 0
maximum: 1
ATVDemodReport:
description: ATVDemod
properties:
channelPowerDB:
description: power received in channel (dB)
type: number
format: float
channelSampleRate:
type: integer
bfoLocked:
description: "BFO PLL lock (1 for locked)."
type: integer
colourLocked:
description: "Colour burst being received (1 for yes)."
type: integer
burstAmplitude:
description: "Smoothed colour burst amplitude in IRE."
type: number
format: float
carrierFrequencyError:
description: "Vision carrier frequency error in Hz, for AM through the vestigial sideband filter."
type: number
format: float
ghostDelay:
description: "Delay of the echo being cancelled in microseconds."
type: number
format: float
ghostAmplitude:
description: "Amplitude of the echo being cancelled relative to the signal (0 when none)."
type: number
format: float

2
swagger/sdrangel/api/swagger/include/ChannelReport.yaml

@ -33,6 +33,8 @@ ChannelReport: @@ -33,6 +33,8 @@ ChannelReport:
AMModReport:
$ref: "http://swgserver:8081/api/swagger/include/AMMod.yaml#/AMModReport"
description: "Am mod report data for Channel."
ATVDemodReport:
$ref: "http://swgserver:8081/api/swagger/include/ATVDemod.yaml#/ATVDemodReport"
ATVModReport:
$ref: "http://swgserver:8081/api/swagger/include/ATVMod.yaml#/ATVModReport"
description: "Atv mod report data for Channel."

263
swagger/sdrangel/code/qt5/client/SWGATVDemodReport.cpp

@ -0,0 +1,263 @@ @@ -0,0 +1,263 @@
/**
* SDRangel
* 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 --- Limitations and specifcities: * In SDRangel GUI the first Rx device set cannot be deleted. Conversely the server starts with no device sets and its number of device sets can be reduced to zero by as many calls as necessary to /sdrangel/deviceset with DELETE method. * Preset import and export from/to file is a server only feature. * Device set focus is a GUI only feature. * The following channels are not implemented (status 501 is returned): ATV and DATV demodulators, Channel Analyzer NG, LoRa demodulator * The device settings and report structures contains only the sub-structure corresponding to the device type. The DeviceSettings and DeviceReport structures documented here shows all of them but only one will be or should be present at a time * The channel settings and report structures contains only the sub-structure corresponding to the channel type. The ChannelSettings and ChannelReport structures documented here shows all of them but only one will be or should be present at a time ---
*
* OpenAPI spec version: 7.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 "SWGATVDemodReport.h"
#include "SWGHelpers.h"
#include <QJsonDocument>
#include <QJsonArray>
#include <QObject>
#include <QDebug>
namespace SWGSDRangel {
SWGATVDemodReport::SWGATVDemodReport(QString* json) {
init();
this->fromJson(*json);
}
SWGATVDemodReport::SWGATVDemodReport() {
channel_power_db = 0.0f;
m_channel_power_db_isSet = false;
channel_sample_rate = 0;
m_channel_sample_rate_isSet = false;
bfo_locked = 0;
m_bfo_locked_isSet = false;
colour_locked = 0;
m_colour_locked_isSet = false;
burst_amplitude = 0.0f;
m_burst_amplitude_isSet = false;
carrier_frequency_error = 0.0f;
m_carrier_frequency_error_isSet = false;
ghost_delay = 0.0f;
m_ghost_delay_isSet = false;
ghost_amplitude = 0.0f;
m_ghost_amplitude_isSet = false;
}
SWGATVDemodReport::~SWGATVDemodReport() {
this->cleanup();
}
void
SWGATVDemodReport::init() {
channel_power_db = 0.0f;
m_channel_power_db_isSet = false;
channel_sample_rate = 0;
m_channel_sample_rate_isSet = false;
bfo_locked = 0;
m_bfo_locked_isSet = false;
colour_locked = 0;
m_colour_locked_isSet = false;
burst_amplitude = 0.0f;
m_burst_amplitude_isSet = false;
carrier_frequency_error = 0.0f;
m_carrier_frequency_error_isSet = false;
ghost_delay = 0.0f;
m_ghost_delay_isSet = false;
ghost_amplitude = 0.0f;
m_ghost_amplitude_isSet = false;
}
void
SWGATVDemodReport::cleanup() {
}
SWGATVDemodReport*
SWGATVDemodReport::fromJson(QString &json) {
QByteArray array (json.toStdString().c_str());
QJsonDocument doc = QJsonDocument::fromJson(array);
QJsonObject jsonObject = doc.object();
this->fromJsonObject(jsonObject);
return this;
}
void
SWGATVDemodReport::fromJsonObject(QJsonObject &pJson) {
::SWGSDRangel::setValue(&channel_power_db, pJson["channelPowerDB"], "float", "");
::SWGSDRangel::setValue(&channel_sample_rate, pJson["channelSampleRate"], "qint32", "");
::SWGSDRangel::setValue(&bfo_locked, pJson["bfoLocked"], "qint32", "");
::SWGSDRangel::setValue(&colour_locked, pJson["colourLocked"], "qint32", "");
::SWGSDRangel::setValue(&burst_amplitude, pJson["burstAmplitude"], "float", "");
::SWGSDRangel::setValue(&carrier_frequency_error, pJson["carrierFrequencyError"], "float", "");
::SWGSDRangel::setValue(&ghost_delay, pJson["ghostDelay"], "float", "");
::SWGSDRangel::setValue(&ghost_amplitude, pJson["ghostAmplitude"], "float", "");
}
QString
SWGATVDemodReport::asJson ()
{
QJsonObject* obj = this->asJsonObject();
QJsonDocument doc(*obj);
QByteArray bytes = doc.toJson();
delete obj;
return QString(bytes);
}
QJsonObject*
SWGATVDemodReport::asJsonObject() {
QJsonObject* obj = new QJsonObject();
if(m_channel_power_db_isSet){
obj->insert("channelPowerDB", QJsonValue(channel_power_db));
}
if(m_channel_sample_rate_isSet){
obj->insert("channelSampleRate", QJsonValue(channel_sample_rate));
}
if(m_bfo_locked_isSet){
obj->insert("bfoLocked", QJsonValue(bfo_locked));
}
if(m_colour_locked_isSet){
obj->insert("colourLocked", QJsonValue(colour_locked));
}
if(m_burst_amplitude_isSet){
obj->insert("burstAmplitude", QJsonValue(burst_amplitude));
}
if(m_carrier_frequency_error_isSet){
obj->insert("carrierFrequencyError", QJsonValue(carrier_frequency_error));
}
if(m_ghost_delay_isSet){
obj->insert("ghostDelay", QJsonValue(ghost_delay));
}
if(m_ghost_amplitude_isSet){
obj->insert("ghostAmplitude", QJsonValue(ghost_amplitude));
}
return obj;
}
float
SWGATVDemodReport::getChannelPowerDb() {
return channel_power_db;
}
void
SWGATVDemodReport::setChannelPowerDb(float channel_power_db) {
this->channel_power_db = channel_power_db;
this->m_channel_power_db_isSet = true;
}
qint32
SWGATVDemodReport::getChannelSampleRate() {
return channel_sample_rate;
}
void
SWGATVDemodReport::setChannelSampleRate(qint32 channel_sample_rate) {
this->channel_sample_rate = channel_sample_rate;
this->m_channel_sample_rate_isSet = true;
}
qint32
SWGATVDemodReport::getBfoLocked() {
return bfo_locked;
}
void
SWGATVDemodReport::setBfoLocked(qint32 bfo_locked) {
this->bfo_locked = bfo_locked;
this->m_bfo_locked_isSet = true;
}
qint32
SWGATVDemodReport::getColourLocked() {
return colour_locked;
}
void
SWGATVDemodReport::setColourLocked(qint32 colour_locked) {
this->colour_locked = colour_locked;
this->m_colour_locked_isSet = true;
}
float
SWGATVDemodReport::getBurstAmplitude() {
return burst_amplitude;
}
void
SWGATVDemodReport::setBurstAmplitude(float burst_amplitude) {
this->burst_amplitude = burst_amplitude;
this->m_burst_amplitude_isSet = true;
}
float
SWGATVDemodReport::getCarrierFrequencyError() {
return carrier_frequency_error;
}
void
SWGATVDemodReport::setCarrierFrequencyError(float carrier_frequency_error) {
this->carrier_frequency_error = carrier_frequency_error;
this->m_carrier_frequency_error_isSet = true;
}
float
SWGATVDemodReport::getGhostDelay() {
return ghost_delay;
}
void
SWGATVDemodReport::setGhostDelay(float ghost_delay) {
this->ghost_delay = ghost_delay;
this->m_ghost_delay_isSet = true;
}
float
SWGATVDemodReport::getGhostAmplitude() {
return ghost_amplitude;
}
void
SWGATVDemodReport::setGhostAmplitude(float ghost_amplitude) {
this->ghost_amplitude = ghost_amplitude;
this->m_ghost_amplitude_isSet = true;
}
bool
SWGATVDemodReport::isSet(){
bool isObjectUpdated = false;
do{
if(m_channel_power_db_isSet){
isObjectUpdated = true; break;
}
if(m_channel_sample_rate_isSet){
isObjectUpdated = true; break;
}
if(m_bfo_locked_isSet){
isObjectUpdated = true; break;
}
if(m_colour_locked_isSet){
isObjectUpdated = true; break;
}
if(m_burst_amplitude_isSet){
isObjectUpdated = true; break;
}
if(m_carrier_frequency_error_isSet){
isObjectUpdated = true; break;
}
if(m_ghost_delay_isSet){
isObjectUpdated = true; break;
}
if(m_ghost_amplitude_isSet){
isObjectUpdated = true; break;
}
}while(false);
return isObjectUpdated;
}
}

100
swagger/sdrangel/code/qt5/client/SWGATVDemodReport.h

@ -0,0 +1,100 @@ @@ -0,0 +1,100 @@
/**
* SDRangel
* 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 --- Limitations and specifcities: * In SDRangel GUI the first Rx device set cannot be deleted. Conversely the server starts with no device sets and its number of device sets can be reduced to zero by as many calls as necessary to /sdrangel/deviceset with DELETE method. * Preset import and export from/to file is a server only feature. * Device set focus is a GUI only feature. * The following channels are not implemented (status 501 is returned): ATV and DATV demodulators, Channel Analyzer NG, LoRa demodulator * The device settings and report structures contains only the sub-structure corresponding to the device type. The DeviceSettings and DeviceReport structures documented here shows all of them but only one will be or should be present at a time * The channel settings and report structures contains only the sub-structure corresponding to the channel type. The ChannelSettings and ChannelReport structures documented here shows all of them but only one will be or should be present at a time ---
*
* OpenAPI spec version: 7.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.
*/
/*
* SWGATVDemodReport.h
*
* ATVDemod
*/
#ifndef SWGATVDemodReport_H_
#define SWGATVDemodReport_H_
#include <QJsonObject>
#include "SWGObject.h"
#include "export.h"
namespace SWGSDRangel {
class SWG_API SWGATVDemodReport: public SWGObject {
public:
SWGATVDemodReport();
SWGATVDemodReport(QString* json);
virtual ~SWGATVDemodReport();
void init();
void cleanup();
virtual QString asJson () override;
virtual QJsonObject* asJsonObject() override;
virtual void fromJsonObject(QJsonObject &json) override;
virtual SWGATVDemodReport* fromJson(QString &jsonString) override;
float getChannelPowerDb();
void setChannelPowerDb(float channel_power_db);
qint32 getChannelSampleRate();
void setChannelSampleRate(qint32 channel_sample_rate);
qint32 getBfoLocked();
void setBfoLocked(qint32 bfo_locked);
qint32 getColourLocked();
void setColourLocked(qint32 colour_locked);
float getBurstAmplitude();
void setBurstAmplitude(float burst_amplitude);
float getCarrierFrequencyError();
void setCarrierFrequencyError(float carrier_frequency_error);
float getGhostDelay();
void setGhostDelay(float ghost_delay);
float getGhostAmplitude();
void setGhostAmplitude(float ghost_amplitude);
virtual bool isSet() override;
private:
float channel_power_db;
bool m_channel_power_db_isSet;
qint32 channel_sample_rate;
bool m_channel_sample_rate_isSet;
qint32 bfo_locked;
bool m_bfo_locked_isSet;
qint32 colour_locked;
bool m_colour_locked_isSet;
float burst_amplitude;
bool m_burst_amplitude_isSet;
float carrier_frequency_error;
bool m_carrier_frequency_error_isSet;
float ghost_delay;
bool m_ghost_delay_isSet;
float ghost_amplitude;
bool m_ghost_amplitude_isSet;
};
}
#endif /* SWGATVDemodReport_H_ */

25
swagger/sdrangel/code/qt5/client/SWGChannelReport.cpp

@ -46,6 +46,8 @@ SWGChannelReport::SWGChannelReport() { @@ -46,6 +46,8 @@ SWGChannelReport::SWGChannelReport() {
m_wefax_demod_report_isSet = false;
am_mod_report = nullptr;
m_am_mod_report_isSet = false;
atv_demod_report = nullptr;
m_atv_demod_report_isSet = false;
atv_mod_report = nullptr;
m_atv_mod_report_isSet = false;
bfm_demod_report = nullptr;
@ -190,6 +192,8 @@ SWGChannelReport::init() { @@ -190,6 +192,8 @@ SWGChannelReport::init() {
m_wefax_demod_report_isSet = false;
am_mod_report = new SWGAMModReport();
m_am_mod_report_isSet = false;
atv_demod_report = new SWGATVDemodReport();
m_atv_demod_report_isSet = false;
atv_mod_report = new SWGATVModReport();
m_atv_mod_report_isSet = false;
bfm_demod_report = new SWGBFMDemodReport();
@ -337,6 +341,9 @@ SWGChannelReport::cleanup() { @@ -337,6 +341,9 @@ SWGChannelReport::cleanup() {
if(am_mod_report != nullptr) {
delete am_mod_report;
}
if(atv_demod_report != nullptr) {
delete atv_demod_report;
}
if(atv_mod_report != nullptr) {
delete atv_mod_report;
}
@ -544,6 +551,8 @@ SWGChannelReport::fromJsonObject(QJsonObject &pJson) { @@ -544,6 +551,8 @@ SWGChannelReport::fromJsonObject(QJsonObject &pJson) {
::SWGSDRangel::setValue(&am_mod_report, pJson["AMModReport"], "SWGAMModReport", "SWGAMModReport");
::SWGSDRangel::setValue(&atv_demod_report, pJson["ATVDemodReport"], "SWGATVDemodReport", "SWGATVDemodReport");
::SWGSDRangel::setValue(&atv_mod_report, pJson["ATVModReport"], "SWGATVModReport", "SWGATVModReport");
::SWGSDRangel::setValue(&bfm_demod_report, pJson["BFMDemodReport"], "SWGBFMDemodReport", "SWGBFMDemodReport");
@ -702,6 +711,9 @@ SWGChannelReport::asJsonObject() { @@ -702,6 +711,9 @@ SWGChannelReport::asJsonObject() {
if((am_mod_report != nullptr) && (am_mod_report->isSet())){
toJsonValue(QString("AMModReport"), am_mod_report, obj, QString("SWGAMModReport"));
}
if((atv_demod_report != nullptr) && (atv_demod_report->isSet())){
toJsonValue(QString("ATVDemodReport"), atv_demod_report, obj, QString("SWGATVDemodReport"));
}
if((atv_mod_report != nullptr) && (atv_mod_report->isSet())){
toJsonValue(QString("ATVModReport"), atv_mod_report, obj, QString("SWGATVModReport"));
}
@ -973,6 +985,16 @@ SWGChannelReport::setAmModReport(SWGAMModReport* am_mod_report) { @@ -973,6 +985,16 @@ SWGChannelReport::setAmModReport(SWGAMModReport* am_mod_report) {
this->m_am_mod_report_isSet = true;
}
SWGATVDemodReport*
SWGChannelReport::getAtvDemodReport() {
return atv_demod_report;
}
void
SWGChannelReport::setAtvDemodReport(SWGATVDemodReport* atv_demod_report) {
this->atv_demod_report = atv_demod_report;
this->m_atv_demod_report_isSet = true;
}
SWGATVModReport*
SWGChannelReport::getAtvModReport() {
return atv_mod_report;
@ -1598,6 +1620,9 @@ SWGChannelReport::isSet(){ @@ -1598,6 +1620,9 @@ SWGChannelReport::isSet(){
if(am_mod_report && am_mod_report->isSet()){
isObjectUpdated = true; break;
}
if(atv_demod_report && atv_demod_report->isSet()){
isObjectUpdated = true; break;
}
if(atv_mod_report && atv_mod_report->isSet()){
isObjectUpdated = true; break;
}

7
swagger/sdrangel/code/qt5/client/SWGChannelReport.h

@ -29,6 +29,7 @@ @@ -29,6 +29,7 @@
#include "SWGAMDemodReport.h"
#include "SWGWefaxDemodReport.h"
#include "SWGAMModReport.h"
#include "SWGATVDemodReport.h"
#include "SWGATVModReport.h"
#include "SWGBFMDemodReport.h"
#include "SWGBFMModReport.h"
@ -135,6 +136,9 @@ public: @@ -135,6 +136,9 @@ public:
SWGAMModReport* getAmModReport();
void setAmModReport(SWGAMModReport* am_mod_report);
SWGATVDemodReport* getAtvDemodReport();
void setAtvDemodReport(SWGATVDemodReport* atv_demod_report);
SWGATVModReport* getAtvModReport();
void setAtvModReport(SWGATVModReport* atv_mod_report);
@ -342,6 +346,9 @@ private: @@ -342,6 +346,9 @@ private:
SWGAMModReport* am_mod_report;
bool m_am_mod_report_isSet;
SWGATVDemodReport* atv_demod_report;
bool m_atv_demod_report_isSet;
SWGATVModReport* atv_mod_report;
bool m_atv_mod_report_isSet;

6
swagger/sdrangel/code/qt5/client/SWGModelFactory.h

@ -52,6 +52,7 @@ @@ -52,6 +52,7 @@
#include "SWGWefaxDemodReport.h"
#include "SWGWefaxDemodSettings.h"
#include "SWGATVDemodSettings.h"
#include "SWGATVDemodReport.h"
#include "SWGATVModReport.h"
#include "SWGATVModSettings.h"
#include "SWGAaroniaRTSAOutputReport.h"
@ -655,6 +656,11 @@ namespace SWGSDRangel { @@ -655,6 +656,11 @@ namespace SWGSDRangel {
obj->init();
return obj;
}
if(QString("SWGATVDemodReport").compare(type) == 0) {
SWGATVDemodReport *obj = new SWGATVDemodReport();
obj->init();
return obj;
}
if(QString("SWGATVModReport").compare(type) == 0) {
SWGATVModReport *obj = new SWGATVModReport();
obj->init();

Loading…
Cancel
Save