diff options
Diffstat (limited to 'sdrbase/resources/webapi/doc')
15 files changed, 399 insertions, 17 deletions
diff --git a/sdrbase/resources/webapi/doc/html2/index.html b/sdrbase/resources/webapi/doc/html2/index.html index 54b9dc825..7e20021dd 100644 --- a/sdrbase/resources/webapi/doc/html2/index.html +++ b/sdrbase/resources/webapi/doc/html2/index.html @@ -760,6 +760,22 @@ margin-bottom: 20px; "syncAMOperation" : { "type" : "integer", "description" : "Synchronous AM sidebands mode (DSB, USB, LSB)" + }, + "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" : "AMDemod" @@ -821,6 +837,22 @@ margin-bottom: 20px; "modAFInput" : { "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" + }, + "reverseAPIChannelIndex" : { + "type" : "integer" + }, "cwKeyer" : { "$ref" : "#/definitions/CWKeyerSettings" } @@ -916,6 +948,22 @@ margin-bottom: 20px; }, "videoFileName" : { "type" : "string" + }, + "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" : "ATVMod" @@ -1261,6 +1309,22 @@ margin-bottom: 20px; }, "audioDeviceName" : { "type" : "string" + }, + "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" : "BFMDemod" @@ -1834,6 +1898,22 @@ margin-bottom: 20px; "traceDecay" : { "type" : "integer", "description" : "0 to 255" + }, + "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" : "DSDDemod" @@ -1887,6 +1967,22 @@ margin-bottom: 20px; }, "title" : { "type" : "string" + }, + "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" : "Daemon channel sink settings" @@ -1963,6 +2059,22 @@ margin-bottom: 20px; }, "title" : { "type" : "string" + }, + "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" : "Daemon channel source settings" @@ -2715,6 +2827,19 @@ margin-bottom: 20px; "gpioPins" : { "type" : "integer", "format" : "int8" + }, + "useReverseAPI" : { + "type" : "integer", + "description" : "Synchronize with reverse API (1 for yes, 0 for no)" + }, + "reverseAPIAddress" : { + "type" : "string" + }, + "reverseAPIPort" : { + "type" : "integer" + }, + "reverseAPIDeviceIndex" : { + "type" : "integer" } }, "description" : "LimeSDR" @@ -2824,6 +2949,19 @@ margin-bottom: 20px; "gpioPins" : { "type" : "integer", "format" : "int8" + }, + "useReverseAPI" : { + "type" : "integer", + "description" : "Synchronize with reverse API (1 for yes, 0 for no)" + }, + "reverseAPIAddress" : { + "type" : "string" + }, + "reverseAPIPort" : { + "type" : "integer" + }, + "reverseAPIDeviceIndex" : { + "type" : "integer" } }, "description" : "LimeSDR" @@ -3013,6 +3151,22 @@ margin-bottom: 20px; "modAFInput" : { "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" + }, + "reverseAPIChannelIndex" : { + "type" : "integer" + }, "cwKeyer" : { "$ref" : "#/definitions/CWKeyerSettings" } @@ -3521,6 +3675,19 @@ margin-bottom: 20px; }, "fileRecordName" : { "type" : "string" + }, + "useReverseAPI" : { + "type" : "integer", + "description" : "Synchronize with reverse API (1 for yes, 0 for no)" + }, + "reverseAPIAddress" : { + "type" : "string" + }, + "reverseAPIPort" : { + "type" : "integer" + }, + "reverseAPIDeviceIndex" : { + "type" : "integer" } }, "description" : "RTLSDR" @@ -3897,6 +4064,22 @@ margin-bottom: 20px; "modAFInput" : { "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" + }, + "reverseAPIChannelIndex" : { + "type" : "integer" + }, "cwKeyer" : { "$ref" : "#/definitions/CWKeyerSettings" } @@ -4292,6 +4475,19 @@ margin-bottom: 20px; }, "fileRecordName" : { "type" : "string" + }, + "useReverseAPI" : { + "type" : "integer", + "description" : "Synchronize with reverse API (1 for yes, 0 for no)" + }, + "reverseAPIAddress" : { + "type" : "string" + }, + "reverseAPIPort" : { + "type" : "integer" + }, + "reverseAPIDeviceIndex" : { + "type" : "integer" } }, "description" : "TestSource" @@ -4490,6 +4686,22 @@ margin-bottom: 20px; }, "title" : { "type" : "string" + }, + "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" : "UDPSource" @@ -4612,6 +4824,22 @@ margin-bottom: 20px; "modAFInput" : { "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" + }, + "reverseAPIChannelIndex" : { + "type" : "integer" + }, "cwKeyer" : { "$ref" : "#/definitions/CWKeyerSettings" } @@ -23649,7 +23877,7 @@ except ApiException as e: </div> <div id="generator"> <div class="content"> - Generated 2018-11-29T00:50:52.609+01:00 + Generated 2018-12-22T12:54:35.895+01:00 </div> </div> </div> diff --git a/sdrbase/resources/webapi/doc/swagger/include/AMDemod.yaml b/sdrbase/resources/webapi/doc/swagger/include/AMDemod.yaml index 08c6f601d..22aaa5aa4 100644 --- a/sdrbase/resources/webapi/doc/swagger/include/AMDemod.yaml +++ b/sdrbase/resources/webapi/doc/swagger/include/AMDemod.yaml @@ -33,6 +33,17 @@ AMDemodSettings: syncAMOperation: description: Synchronous AM sidebands mode (DSB, USB, LSB) type: integer + useReverseAPI: + description: Synchronize with reverse API (1 for yes, 0 for no) + type: integer + reverseAPIAddress: + type: string + reverseAPIPort: + type: integer + reverseAPIDeviceIndex: + type: integer + reverseAPIChannelIndex: + type: integer AMDemodReport: description: AMDemod diff --git a/sdrbase/resources/webapi/doc/swagger/include/AMMod.yaml b/sdrbase/resources/webapi/doc/swagger/include/AMMod.yaml index 5b96deaaf..98328661f 100644 --- a/sdrbase/resources/webapi/doc/swagger/include/AMMod.yaml +++ b/sdrbase/resources/webapi/doc/swagger/include/AMMod.yaml @@ -29,9 +29,20 @@ AMModSettings: type: string modAFInput: type: integer + useReverseAPI: + description: Synchronize with reverse API (1 for yes, 0 for no) + type: integer + reverseAPIAddress: + type: string + reverseAPIPort: + type: integer + reverseAPIDeviceIndex: + type: integer + reverseAPIChannelIndex: + type: integer cwKeyer: $ref: "/doc/swagger/include/CWKeyer.yaml#/CWKeyerSettings" - + AMModReport: description: AMMod properties: diff --git a/sdrbase/resources/webapi/doc/swagger/include/ATVMod.yaml b/sdrbase/resources/webapi/doc/swagger/include/ATVMod.yaml index 58acb2067..5c04ee404 100644 --- a/sdrbase/resources/webapi/doc/swagger/include/ATVMod.yaml +++ b/sdrbase/resources/webapi/doc/swagger/include/ATVMod.yaml @@ -53,7 +53,18 @@ ATVModSettings: type: string videoFileName: type: string - + useReverseAPI: + description: Synchronize with reverse API (1 for yes, 0 for no) + type: integer + reverseAPIAddress: + type: string + reverseAPIPort: + type: integer + reverseAPIDeviceIndex: + type: integer + reverseAPIChannelIndex: + type: integer + ATVModReport: description: ATVMod properties: diff --git a/sdrbase/resources/webapi/doc/swagger/include/BFMDemod.yaml b/sdrbase/resources/webapi/doc/swagger/include/BFMDemod.yaml index 65b979633..6b1fb54fc 100644 --- a/sdrbase/resources/webapi/doc/swagger/include/BFMDemod.yaml +++ b/sdrbase/resources/webapi/doc/swagger/include/BFMDemod.yaml @@ -30,6 +30,17 @@ BFMDemodSettings: type: string audioDeviceName: type: string + useReverseAPI: + description: Synchronize with reverse API (1 for yes, 0 for no) + type: integer + reverseAPIAddress: + type: string + reverseAPIPort: + type: integer + reverseAPIDeviceIndex: + type: integer + reverseAPIChannelIndex: + type: integer BFMDemodReport: description: BFMDemod @@ -54,7 +65,7 @@ BFMDemodReport: format: float rdsReport: $ref: "#/RDSReport" - + RDSReport: description: RDS information properties: diff --git a/sdrbase/resources/webapi/doc/swagger/include/DSDDemod.yaml b/sdrbase/resources/webapi/doc/swagger/include/DSDDemod.yaml index 91895f382..024995803 100644 --- a/sdrbase/resources/webapi/doc/swagger/include/DSDDemod.yaml +++ b/sdrbase/resources/webapi/doc/swagger/include/DSDDemod.yaml @@ -54,6 +54,17 @@ DSDDemodSettings: traceDecay: description: 0 to 255 type: integer + useReverseAPI: + description: Synchronize with reverse API (1 for yes, 0 for no) + type: integer + reverseAPIAddress: + type: string + reverseAPIPort: + type: integer + reverseAPIDeviceIndex: + type: integer + reverseAPIChannelIndex: + type: integer DSDDemodReport: description: DSDDemod @@ -96,5 +107,4 @@ DSDDemodReport: statusText: description: mode dependent status messages (ref UI documentation) type: string - -
\ No newline at end of file + diff --git a/sdrbase/resources/webapi/doc/swagger/include/DaemonSink.yaml b/sdrbase/resources/webapi/doc/swagger/include/DaemonSink.yaml index f381ced78..787afb7f1 100644 --- a/sdrbase/resources/webapi/doc/swagger/include/DaemonSink.yaml +++ b/sdrbase/resources/webapi/doc/swagger/include/DaemonSink.yaml @@ -14,6 +14,17 @@ DaemonSinkSettings: description: "Minimum delay in ms between consecutive USB blocks transmissions" type: integer rgbColor: - type: integer + type: integer title: - type: string + type: string + useReverseAPI: + description: Synchronize with reverse API (1 for yes, 0 for no) + type: integer + reverseAPIAddress: + type: string + reverseAPIPort: + type: integer + reverseAPIDeviceIndex: + type: integer + reverseAPIChannelIndex: + type: integer diff --git a/sdrbase/resources/webapi/doc/swagger/include/DaemonSource.yaml b/sdrbase/resources/webapi/doc/swagger/include/DaemonSource.yaml index 36f13f348..745b3df89 100644 --- a/sdrbase/resources/webapi/doc/swagger/include/DaemonSource.yaml +++ b/sdrbase/resources/webapi/doc/swagger/include/DaemonSource.yaml @@ -11,7 +11,18 @@ DaemonSourceSettings: type: integer title: type: string - + useReverseAPI: + description: Synchronize with reverse API (1 for yes, 0 for no) + type: integer + reverseAPIAddress: + type: string + reverseAPIPort: + type: integer + reverseAPIDeviceIndex: + type: integer + reverseAPIChannelIndex: + type: integer + DaemonSourceReport: description: "Daemon channel source report" properties: diff --git a/sdrbase/resources/webapi/doc/swagger/include/LimeSdr.yaml b/sdrbase/resources/webapi/doc/swagger/include/LimeSdr.yaml index bc4b90408..eb7921cd0 100644 --- a/sdrbase/resources/webapi/doc/swagger/include/LimeSdr.yaml +++ b/sdrbase/resources/webapi/doc/swagger/include/LimeSdr.yaml @@ -53,7 +53,16 @@ LimeSdrInputSettings: gpioPins: type: integer format: int8 - + useReverseAPI: + description: Synchronize with reverse API (1 for yes, 0 for no) + type: integer + reverseAPIAddress: + type: string + reverseAPIPort: + type: integer + reverseAPIDeviceIndex: + type: integer + LimeSdrOutputSettings: description: LimeSDR properties: @@ -95,6 +104,15 @@ LimeSdrOutputSettings: gpioPins: type: integer format: int8 + useReverseAPI: + description: Synchronize with reverse API (1 for yes, 0 for no) + type: integer + reverseAPIAddress: + type: string + reverseAPIPort: + type: integer + reverseAPIDeviceIndex: + type: integer LimeSdrInputReport: description: LimeSDR diff --git a/sdrbase/resources/webapi/doc/swagger/include/NFMMod.yaml b/sdrbase/resources/webapi/doc/swagger/include/NFMMod.yaml index e476cc261..b543a71e7 100644 --- a/sdrbase/resources/webapi/doc/swagger/include/NFMMod.yaml +++ b/sdrbase/resources/webapi/doc/swagger/include/NFMMod.yaml @@ -35,6 +35,17 @@ NFMModSettings: type: string modAFInput: type: integer + useReverseAPI: + description: Synchronize with reverse API (1 for yes, 0 for no) + type: integer + reverseAPIAddress: + type: string + reverseAPIPort: + type: integer + reverseAPIDeviceIndex: + type: integer + reverseAPIChannelIndex: + type: integer cwKeyer: $ref: "/doc/swagger/include/CWKeyer.yaml#/CWKeyerSettings" diff --git a/sdrbase/resources/webapi/doc/swagger/include/RtlSdr.yaml b/sdrbase/resources/webapi/doc/swagger/include/RtlSdr.yaml index 8b80ce510..f68313c7b 100644 --- a/sdrbase/resources/webapi/doc/swagger/include/RtlSdr.yaml +++ b/sdrbase/resources/webapi/doc/swagger/include/RtlSdr.yaml @@ -35,6 +35,15 @@ RtlSdrSettings: type: integer fileRecordName: type: string + useReverseAPI: + description: Synchronize with reverse API (1 for yes, 0 for no) + type: integer + reverseAPIAddress: + type: string + reverseAPIPort: + type: integer + reverseAPIDeviceIndex: + type: integer RtlSdrReport: description: RTLSDR diff --git a/sdrbase/resources/webapi/doc/swagger/include/SSBMod.yaml b/sdrbase/resources/webapi/doc/swagger/include/SSBMod.yaml index a460bff62..16b56d655 100644 --- a/sdrbase/resources/webapi/doc/swagger/include/SSBMod.yaml +++ b/sdrbase/resources/webapi/doc/swagger/include/SSBMod.yaml @@ -53,6 +53,17 @@ SSBModSettings: type: string modAFInput: type: integer + useReverseAPI: + description: Synchronize with reverse API (1 for yes, 0 for no) + type: integer + reverseAPIAddress: + type: string + reverseAPIPort: + type: integer + reverseAPIDeviceIndex: + type: integer + reverseAPIChannelIndex: + type: integer cwKeyer: $ref: "/doc/swagger/include/CWKeyer.yaml#/CWKeyerSettings" diff --git a/sdrbase/resources/webapi/doc/swagger/include/TestSource.yaml b/sdrbase/resources/webapi/doc/swagger/include/TestSource.yaml index d5c88645c..4c4d6ae96 100644 --- a/sdrbase/resources/webapi/doc/swagger/include/TestSource.yaml +++ b/sdrbase/resources/webapi/doc/swagger/include/TestSource.yaml @@ -40,4 +40,13 @@ TestSourceSettings: format: float fileRecordName: type: string + useReverseAPI: + description: Synchronize with reverse API (1 for yes, 0 for no) + type: integer + reverseAPIAddress: + type: string + reverseAPIPort: + type: integer + reverseAPIDeviceIndex: + type: integer
\ No newline at end of file diff --git a/sdrbase/resources/webapi/doc/swagger/include/UDPSource.yaml b/sdrbase/resources/webapi/doc/swagger/include/UDPSource.yaml index 46e8b680b..5f3193a13 100644 --- a/sdrbase/resources/webapi/doc/swagger/include/UDPSource.yaml +++ b/sdrbase/resources/webapi/doc/swagger/include/UDPSource.yaml @@ -35,20 +35,31 @@ UDPSourceSettings: type: number format: float squelchEnabled: - type: integer + type: integer autoRWBalance: - type: integer + type: integer stereoInput: - type: integer + type: integer rgbColor: - type: integer + type: integer udpAddress: type: string udpPort: type: integer - format: uint16 + format: uint16 title: type: string + useReverseAPI: + description: Synchronize with reverse API (1 for yes, 0 for no) + type: integer + reverseAPIAddress: + type: string + reverseAPIPort: + type: integer + reverseAPIDeviceIndex: + type: integer + reverseAPIChannelIndex: + type: integer UDPSourceReport: description: UDPSource @@ -69,4 +80,3 @@ UDPSourceReport: type: integer channelSampleRate: type: integer -
\ No newline at end of file diff --git a/sdrbase/resources/webapi/doc/swagger/include/WFMMod.yaml b/sdrbase/resources/webapi/doc/swagger/include/WFMMod.yaml index 8fb9b6fc7..9cdf733db 100644 --- a/sdrbase/resources/webapi/doc/swagger/include/WFMMod.yaml +++ b/sdrbase/resources/webapi/doc/swagger/include/WFMMod.yaml @@ -31,6 +31,17 @@ WFMModSettings: type: string modAFInput: type: integer + useReverseAPI: + description: Synchronize with reverse API (1 for yes, 0 for no) + type: integer + reverseAPIAddress: + type: string + reverseAPIPort: + type: integer + reverseAPIDeviceIndex: + type: integer + reverseAPIChannelIndex: + type: integer cwKeyer: $ref: "/doc/swagger/include/CWKeyer.yaml#/CWKeyerSettings" @@ -45,4 +56,3 @@ WFMModReport: type: integer channelSampleRate: type: integer -
\ No newline at end of file |