diff --git a/sdrbase/resources/webapi.qrc b/sdrbase/resources/webapi.qrc index 06e3acf1f..e945d534f 100644 --- a/sdrbase/resources/webapi.qrc +++ b/sdrbase/resources/webapi.qrc @@ -13,6 +13,7 @@ webapi/doc/swagger/include/AMBE.yaml webapi/doc/swagger/include/AMDemod.yaml webapi/doc/swagger/include/AMMod.yaml + webapi/doc/swagger/include/AndroidSDRDriverInput.yaml webapi/doc/swagger/include/AntennaTools.yaml webapi/doc/swagger/include/APRS.yaml webapi/doc/swagger/include/APTDemod.yaml @@ -88,6 +89,7 @@ webapi/doc/swagger/include/PlutoSdr.yaml webapi/doc/swagger/include/Preferences.yaml webapi/doc/swagger/include/Preset.yaml + webapi/doc/swagger/include/PSK31Mod.yaml webapi/doc/swagger/include/RadioAstronomy.yaml webapi/doc/swagger/include/Radiosonde.yaml webapi/doc/swagger/include/RadiosondeDemod.yaml @@ -102,6 +104,7 @@ webapi/doc/swagger/include/RigCtlServer.yaml webapi/doc/swagger/include/RollupState.yaml webapi/doc/swagger/include/RTTYDemod.yaml + webapi/doc/swagger/include/RTTYMod.yaml webapi/doc/swagger/include/SatelliteTracker.yaml webapi/doc/swagger/include/SDRPlay.yaml webapi/doc/swagger/include/SDRPlayV3.yaml diff --git a/sdrbase/resources/webapi/doc/html2/index.html b/sdrbase/resources/webapi/doc/html2/index.html index 495206ba0..e2797e284 100644 --- a/sdrbase/resources/webapi/doc/html2/index.html +++ b/sdrbase/resources/webapi/doc/html2/index.html @@ -2343,6 +2343,72 @@ margin-bottom: 20px; } }, "description" : "Airspy" +}; + defs.AndroidSDRDriverInputReport = { + "properties" : { + "sampleRate" : { + "type" : "integer" + } + }, + "description" : "AndroidSDRDriverInput" +}; + defs.AndroidSDRDriverInputSettings = { + "properties" : { + "centerFrequency" : { + "type" : "integer", + "format" : "int64" + }, + "loPpmCorrection" : { + "type" : "integer" + }, + "dcBlock" : { + "type" : "integer" + }, + "iqCorrection" : { + "type" : "integer" + }, + "biasTee" : { + "type" : "integer" + }, + "directSampling" : { + "type" : "integer" + }, + "devSampleRate" : { + "type" : "integer" + }, + "log2Decim" : { + "type" : "integer" + }, + "gain" : { + "type" : "integer" + }, + "agc" : { + "type" : "integer" + }, + "rfBW" : { + "type" : "integer" + }, + "sampleBits" : { + "type" : "integer" + }, + "dataPort" : { + "type" : "integer" + }, + "useReverseAPI" : { + "type" : "integer", + "description" : "Synchronize with reverse API (1 for yes, 0 for no)" + }, + "reverseAPIAddress" : { + "type" : "string" + }, + "reverseAPIPort" : { + "type" : "integer" + }, + "reverseAPIDeviceIndex" : { + "type" : "integer" + } + }, + "description" : "AndroidSDRDriverInput" }; defs.AntennaToolsSettings = { "properties" : { @@ -3481,9 +3547,15 @@ margin-bottom: 20px; "PacketModActions" : { "$ref" : "#/definitions/PacketModActions" }, + "PSK31ModActions" : { + "$ref" : "#/definitions/PSK31ModActions" + }, "RadioAstronomyActions" : { "$ref" : "#/definitions/RadioAstronomyActions" }, + "RTTYModActions" : { + "$ref" : "#/definitions/RTTYModActions" + }, "SigMFFileSinkActions" : { "$ref" : "#/definitions/SigMFFileSinkActions" } @@ -3731,9 +3803,6 @@ margin-bottom: 20px; "FT8DemodReport" : { "$ref" : "#/definitions/FT8DemodReport" }, - "RTTYDemodReport" : { - "$ref" : "#/definitions/RTTYDemodReport" - }, "HeatMapReport" : { "$ref" : "#/definitions/HeatMapReport" }, @@ -3773,6 +3842,12 @@ margin-bottom: 20px; "RemoteSourceReport" : { "$ref" : "#/definitions/RemoteSourceReport" }, + "RTTYDemodReport" : { + "$ref" : "#/definitions/RTTYDemodReport" + }, + "RTTYModReport" : { + "$ref" : "#/definitions/RTTYModReport" + }, "PacketDemodReport" : { "$ref" : "#/definitions/PacketDemodReport" }, @@ -3782,6 +3857,9 @@ margin-bottom: 20px; "PagerDemodReport" : { "$ref" : "#/definitions/PagerDemodReport" }, + "PSK31ModReport" : { + "$ref" : "#/definitions/PSK31ModReport" + }, "SigMFFileSinkReport" : { "$ref" : "#/definitions/SigMFFileSinkReport" }, @@ -3901,9 +3979,6 @@ margin-bottom: 20px; "FT8DemodSettings" : { "$ref" : "#/definitions/FT8DemodSettings" }, - "RTTYDemodSettings" : { - "$ref" : "#/definitions/RTTYDemodSettings" - }, "HeatMapSettings" : { "$ref" : "#/definitions/HeatMapSettings" }, @@ -3949,6 +4024,9 @@ margin-bottom: 20px; "PagerDemodSettings" : { "$ref" : "#/definitions/PagerDemodSettings" }, + "PSK31ModSettings" : { + "$ref" : "#/definitions/PSK31ModSettings" + }, "RadioAstronomySettings" : { "$ref" : "#/definitions/RadioAstronomySettings" }, @@ -3967,6 +4045,12 @@ margin-bottom: 20px; "RemoteTCPSinkSettings" : { "$ref" : "#/definitions/RemoteTCPSinkSettings" }, + "RTTYDemodSettings" : { + "$ref" : "#/definitions/RTTYDemodSettings" + }, + "RTTYModSettings" : { + "$ref" : "#/definitions/RTTYModSettings" + }, "SigMFFileSinkSettings" : { "$ref" : "#/definitions/SigMFFileSinkSettings" }, @@ -5409,6 +5493,9 @@ margin-bottom: 20px; "airspyHFReport" : { "$ref" : "#/definitions/AirspyHFReport" }, + "androidSDRDriverInputReport" : { + "$ref" : "#/definitions/AndroidSDRDriverInputReport" + }, "bladeRF2InputReport" : { "$ref" : "#/definitions/BladeRF2InputReport" }, @@ -5564,6 +5651,9 @@ margin-bottom: 20px; "airspyHFSettings" : { "$ref" : "#/definitions/AirspyHFSettings" }, + "androidSDRDriverInputSettings" : { + "$ref" : "#/definitions/AndroidSDRDriverInputSettings" + }, "audioCATSISOSettings" : { "$ref" : "#/definitions/AudioCATSISOSettings" }, @@ -5895,7 +5985,8 @@ margin-bottom: 20px; }, "bandwidth" : { "type" : "number", - "format" : "float" + "format" : "float", + "description" : "bandwidth ratio [0.0, 1.0]" } }, "description" : "FFT filter band definition" @@ -7269,11 +7360,13 @@ margin-bottom: 20px; "description" : "Identifier of the channel or feature plugin providing azimuth and elevation (E.g. R0:0 ADSBDemod)" }, "azimuthOffset" : { - "type" : "integer", + "type" : "number", + "format" : "float", "description" : "Azimuth offset in degrees" }, "elevationOffset" : { - "type" : "integer", + "type" : "number", + "format" : "float", "description" : "Elevation offset in degrees" }, "azimuthMin" : { @@ -8960,7 +9053,7 @@ margin-bottom: 20px; }, "fftOn" : { "type" : "integer", - "description" : "Activate FFT multiband filter\n * 0 - do not run flter\n * 1 - run filter\n" + "description" : "Activate FFT multiband filter\n * 0 - do not run filter\n * 1 - run filter\n" }, "log2FFT" : { "type" : "integer", @@ -8977,7 +9070,8 @@ margin-bottom: 20px; } }, "reverseFilter" : { - "type" : "integer" + "type" : "integer", + "description" : "* 0 - band definitions are bandpass * 1 - band definitions are band reject\n" }, "streamIndex" : { "type" : "integer", @@ -9446,7 +9540,8 @@ margin-bottom: 20px; "description" : "Angle to rotate the image by" }, "text" : { - "type" : "string" + "type" : "string", + "description" : "Text to draw on the map when item is selected" }, "latitude" : { "type" : "number", @@ -9519,7 +9614,7 @@ margin-bottom: 20px; "labelAltitudeOffset" : { "type" : "number", "format" : "float", - "description" : "Veritical offset to position label at" + "description" : "Vertical offset to position label at" }, "modelAltitudeOffset" : { "type" : "number", @@ -9605,7 +9700,8 @@ margin-bottom: 20px; "description" : "Angle to rotate the image by" }, "text" : { - "type" : "string" + "type" : "string", + "description" : "Text to draw on the map when item is selected" }, "latitude" : { "type" : "number", @@ -9678,7 +9774,7 @@ margin-bottom: 20px; "labelAltitudeOffset" : { "type" : "number", "format" : "float", - "description" : "Veritical offset to position label at" + "description" : "Vertical offset to position label at" }, "modelAltitudeOffset" : { "type" : "number", @@ -10507,6 +10603,136 @@ margin-bottom: 20px; } }, "description" : "PER Tester settings" +}; + defs.PSK31ModActions = { + "properties" : { + "tx" : { + "type" : "integer", + "description" : "Transmit current text\n * 0 - Do nothing\n * 1 - Transmit\n" + }, + "payload" : { + "$ref" : "#/definitions/PSK31ModActions_payload" + } + }, + "description" : "PSK31Mod" +}; + defs.PSK31ModActions_payload = { + "properties" : { + "text" : { + "type" : "string", + "description" : "PSK31 content to transmit" + } + } +}; + defs.PSK31ModReport = { + "properties" : { + "channelPowerDB" : { + "type" : "number", + "format" : "float", + "description" : "power transmitted in channel (dB)" + }, + "channelSampleRate" : { + "type" : "integer" + } + }, + "description" : "PSK31Mod" +}; + defs.PSK31ModSettings = { + "properties" : { + "inputFrequencyOffset" : { + "type" : "integer", + "format" : "int64" + }, + "rfBandwidth" : { + "type" : "integer" + }, + "gain" : { + "type" : "number", + "format" : "float" + }, + "channelMute" : { + "type" : "integer" + }, + "repeat" : { + "type" : "integer" + }, + "repeatCount" : { + "type" : "integer" + }, + "lpfTaps" : { + "type" : "integer" + }, + "rfNoise" : { + "type" : "integer", + "description" : "Boolean\n * 0 - off\n * 1 - on\n" + }, + "text" : { + "type" : "string", + "description" : "Text to transmit" + }, + "pulseShaping" : { + "type" : "integer", + "description" : "Boolean\n * 0 - off\n * 1 - on\n" + }, + "beta" : { + "type" : "number", + "format" : "float" + }, + "symbolSpan" : { + "type" : "integer" + }, + "prefixCRLF" : { + "type" : "integer" + }, + "postfixCRLF" : { + "type" : "integer" + }, + "udpEnabled" : { + "type" : "integer", + "description" : "Whether to receive text to transmit on specified UDP port" + }, + "udpAddress" : { + "type" : "string", + "description" : "UDP address to receive text to transmit via" + }, + "udpPort" : { + "type" : "integer", + "description" : "UDP port to receive text to transmit via" + }, + "rgbColor" : { + "type" : "integer" + }, + "title" : { + "type" : "string" + }, + "streamIndex" : { + "type" : "integer", + "description" : "MIMO channel. Not relevant when connected to SI (single Rx)." + }, + "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" + }, + "channelMarker" : { + "$ref" : "#/definitions/ChannelMarker" + }, + "rollupState" : { + "$ref" : "#/definitions/RollupState" + } + }, + "description" : "PSK31Mod" }; defs.PacketDemodReport = { "properties" : { @@ -11747,6 +11973,156 @@ margin-bottom: 20px; } }, "description" : "ACARSDemod" +}; + defs.RTTYModActions = { + "properties" : { + "tx" : { + "type" : "integer", + "description" : "Transmit current text\n * 0 - Do nothing\n * 1 - Transmit\n" + }, + "payload" : { + "$ref" : "#/definitions/RTTYModActions_payload" + } + }, + "description" : "RTTYMod" +}; + defs.RTTYModActions_payload = { + "properties" : { + "text" : { + "type" : "string", + "description" : "RTTY content to transmit" + } + } +}; + defs.RTTYModReport = { + "properties" : { + "channelPowerDB" : { + "type" : "number", + "format" : "float", + "description" : "power transmitted in channel (dB)" + }, + "channelSampleRate" : { + "type" : "integer" + } + }, + "description" : "RTTYMod" +}; + defs.RTTYModSettings = { + "properties" : { + "inputFrequencyOffset" : { + "type" : "integer", + "format" : "int64" + }, + "baud" : { + "type" : "number", + "format" : "float", + "description" : "Baud rate" + }, + "rfBandwidth" : { + "type" : "integer" + }, + "frequencyShift" : { + "type" : "integer" + }, + "gain" : { + "type" : "number", + "format" : "float" + }, + "channelMute" : { + "type" : "integer" + }, + "repeat" : { + "type" : "integer" + }, + "repeatCount" : { + "type" : "integer" + }, + "lpfTaps" : { + "type" : "integer" + }, + "rfNoise" : { + "type" : "integer", + "description" : "Boolean\n * 0 - off\n * 1 - on\n" + }, + "text" : { + "type" : "string", + "description" : "Text to transmit" + }, + "pulseShaping" : { + "type" : "integer", + "description" : "Boolean\n * 0 - off\n * 1 - on\n" + }, + "beta" : { + "type" : "number", + "format" : "float" + }, + "symbolSpan" : { + "type" : "integer" + }, + "characterSet" : { + "type" : "integer" + }, + "unshiftOnSpace" : { + "type" : "integer" + }, + "msbFirst" : { + "type" : "integer" + }, + "spaceHigh" : { + "type" : "integer" + }, + "prefixCRLF" : { + "type" : "integer" + }, + "postfixCRLF" : { + "type" : "integer" + }, + "udpEnabled" : { + "type" : "integer", + "description" : "Whether to receive text to transmit on specified UDP port" + }, + "udpAddress" : { + "type" : "string", + "description" : "UDP address to receive text to transmit via" + }, + "udpPort" : { + "type" : "integer", + "description" : "UDP port to receive text to transmit via" + }, + "rgbColor" : { + "type" : "integer" + }, + "title" : { + "type" : "string" + }, + "streamIndex" : { + "type" : "integer", + "description" : "MIMO channel. Not relevant when connected to SI (single Rx)." + }, + "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" + }, + "channelMarker" : { + "$ref" : "#/definitions/ChannelMarker" + }, + "rollupState" : { + "$ref" : "#/definitions/RollupState" + } + }, + "description" : "RTTYMod" }; defs.RadioAstronomyActions = { "properties" : { @@ -14449,15 +14825,18 @@ margin-bottom: 20px; }, "b" : { "type" : "number", - "format" : "float" + "format" : "float", + "description" : "Galactic latitude in degrees" }, "l" : { "type" : "number", - "format" : "float" + "format" : "float", + "description" : "Galactic longitude in degrees" }, "d" : { "type" : "number", - "format" : "float" + "format" : "float", + "description" : "Distance to object from Sun in kpc" } }, "description" : "Details of object to display in Star Tracker line-of-sight view. Can be sent by other plugins to startracker.display message queue" @@ -14469,15 +14848,18 @@ margin-bottom: 20px; }, "b" : { "type" : "number", - "format" : "float" + "format" : "float", + "description" : "Galactic latitude in degrees" }, "l" : { "type" : "number", - "format" : "float" + "format" : "float", + "description" : "Galactic longitude in degrees" }, "d" : { "type" : "number", - "format" : "float" + "format" : "float", + "description" : "Distance to object from Sun in kpc" } }, "description" : "Details of object to display in Star Tracker line-of-sight view. Can be sent by other plugins to startracker.display message queue" @@ -14490,11 +14872,13 @@ margin-bottom: 20px; }, "azimuth" : { "type" : "number", - "format" : "float" + "format" : "float", + "description" : "The azimuth angle in degrees to the target" }, "elevation" : { "type" : "number", - "format" : "float" + "format" : "float", + "description" : "The elevation angle in degrees to the target" } }, "description" : "Settings to display in Star Tracker. Can be sent by other plugins to startracker.display message queue." @@ -14507,11 +14891,13 @@ margin-bottom: 20px; }, "azimuth" : { "type" : "number", - "format" : "float" + "format" : "float", + "description" : "The azimuth angle in degrees to the target" }, "elevation" : { "type" : "number", - "format" : "float" + "format" : "float", + "description" : "The elevation angle in degrees to the target" } }, "description" : "Settings to display in Star Tracker. Can be sent by other plugins to startracker.display message queue." @@ -14595,7 +14981,7 @@ margin-bottom: 20px; "temperature" : { "type" : "number", "format" : "float", - "description" : "Air temperature in Celsuis, for refraction" + "description" : "Air temperature in Celsius, for refraction" }, "humidity" : { "type" : "number", @@ -14618,7 +15004,8 @@ margin-bottom: 20px; "description" : "Frequency of radio waves being observed in MHz" }, "stellariumServerEnabled" : { - "type" : "integer" + "type" : "integer", + "description" : "Enable Stellarium server (1 for yes, 0 for no)" }, "stellariumPort" : { "type" : "integer", @@ -14676,15 +15063,18 @@ margin-bottom: 20px; defs.StarTrackerTarget = { "properties" : { "name" : { - "type" : "string" + "type" : "string", + "description" : "The name of the target" }, "azimuth" : { "type" : "number", - "format" : "float" + "format" : "float", + "description" : "The azimuth angle in degrees to the target" }, "elevation" : { "type" : "number", - "format" : "float" + "format" : "float", + "description" : "The elevation angle in degrees to the target" }, "ra" : { "type" : "number", @@ -14698,11 +15088,13 @@ margin-bottom: 20px; }, "b" : { "type" : "number", - "format" : "float" + "format" : "float", + "description" : "Galactic latitude in degrees" }, "l" : { "type" : "number", - "format" : "float" + "format" : "float", + "description" : "Galactic longitude in degrees" }, "earthRotationVelocity" : { "type" : "number", @@ -14745,15 +15137,18 @@ margin-bottom: 20px; defs.StarTrackerTarget_2 = { "properties" : { "name" : { - "type" : "string" + "type" : "string", + "description" : "The name of the target" }, "azimuth" : { "type" : "number", - "format" : "float" + "format" : "float", + "description" : "The azimuth angle in degrees to the target" }, "elevation" : { "type" : "number", - "format" : "float" + "format" : "float", + "description" : "The elevation angle in degrees to the target" }, "ra" : { "type" : "number", @@ -14767,11 +15162,13 @@ margin-bottom: 20px; }, "b" : { "type" : "number", - "format" : "float" + "format" : "float", + "description" : "Galactic latitude in degrees" }, "l" : { "type" : "number", - "format" : "float" + "format" : "float", + "description" : "Galactic longitude in degrees" }, "earthRotationVelocity" : { "type" : "number", @@ -14822,15 +15219,18 @@ margin-bottom: 20px; defs.TargetAzimuthElevation = { "properties" : { "name" : { - "type" : "string" + "type" : "string", + "description" : "The name of the target" }, "azimuth" : { "type" : "number", - "format" : "float" + "format" : "float", + "description" : "The azimuth angle in degrees to the target" }, "elevation" : { "type" : "number", - "format" : "float" + "format" : "float", + "description" : "The elevation angle in degrees to the target" } }, "description" : "A target azimuth and elevation" @@ -22563,7 +22963,7 @@ $(document).ready(function() {

Responses

-

Status: 202 - On successful semding of the message it returns the details of the device being set

+

Status: 202 - On successful sending of the message it returns the details of the device being set