VE7UWU/sdrangel
1
0
Fork 0
mirror of https://github.com/f4exb/sdrangel.git synced 2026-05-05 13:44:01 -04:00
Code Issues Projects Releases Wiki Activity

SigMF file sink: REST API: Swagger source files

Browse Source
This commit is contained in:
f4exb 2020-07-17 12:13:09 +02:00
parent 181e1a0dc2
commit 74bf6ab3fa
9 changed files with 203 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
sdrbase/resources/webapi.qrc
View File

@ -55,6 +55,7 @@
<file>webapi/doc/swagger/include/RemoteOutput.yaml</file>
<file>webapi/doc/swagger/include/SDRPlay.yaml</file>
<file>webapi/doc/swagger/include/SigMFFileInput.yaml</file>
<file>webapi/doc/swagger/include/SigMFFileSink.yaml</file>
<file>webapi/doc/swagger/include/SoapySDR.yaml</file>
<file>webapi/doc/swagger/include/SSBDemod.yaml</file>
<file>webapi/doc/swagger/include/SSBMod.yaml</file>

2
sdrbase/resources/webapi/doc/swagger/include/ChannelActions.yaml
View File

@ -19,3 +19,5 @@ ChannelActions:
type: integer
FileSourceActions:
$ref: "/doc/swagger/include/FileSource.yaml#/FileSourceActions"
SigMFFileSinkActions:
$ref: "/doc/swagger/include/SigMFFileSink.yaml#/SigMFFileSinkActions"

2
sdrbase/resources/webapi/doc/swagger/include/ChannelSettings.yaml
View File

@ -61,6 +61,8 @@ ChannelSettings:
$ref: "/doc/swagger/include/RemoteSink.yaml#/RemoteSinkSettings"
RemoteSourceSettings:
$ref: "/doc/swagger/include/RemoteSource.yaml#/RemoteSourceSettings"
SigMFFileSinkSettings:
$ref: "/doc/swagger/include/SigMFFileSink.yaml#/SigMFFileSinkSettings"
SSBModSettings:
$ref: "/doc/swagger/include/SSBMod.yaml#/SSBModSettings"
SSBDemodSettings:

95
sdrbase/resources/webapi/doc/swagger/include/SigMFFileSink.yaml Normal file
View File

@ -0,0 +1,95 @@
SigMFFileSinkSettings:
description: SigMFFileSink
properties:
inputFrequencyOffset:
type: integer
fileRecordName:
type: string
description: full path of the meta file
rgbColor:
type: integer
title:
type: string
log2Decim:
type: integer
spectrumSquelchMode:
type: integer
description: >
Spectrum squelch system
* 0 - deactivated
* 1 - activated
spectrumSquelch:
type: number
format: float
description: Squelch level in power dB
squelchPreRecordTime:
type: integer
description: Number of seconds to record before spectrum squelch opens
squelchPostRecordTime:
type: integer
description: Number of seconds to record after spectrum squelch cloeses
squelchRecordingEnable:
type: integer
description: >
Automatic recording triggered by spectrum squalch
* 0 - disabled
* 1 - enabled
streamIndex:
description: MIMO channel. Not relevant when connected to SI (single Rx).
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
SigMFFileSinkReport:
description: SigMFFileSink
properties:
spectrumSquelch:
type: integer
description: >
Spectrum squelch status
* 0 - closed
* 1 - open
spectrumMax:
type: number
format: float
description: Current spectrum max in squared magnitude (power)
sinkSampleRate:
type: integer
channelSampleRate:
type: integer
recording:
type: integer
description: >
Recording status
* 0 - not recording
* 1 - recording
recordTimeMs:
type: integer
description: Record total time in milliseconds
recordSize:
type: integer
format: int64
description: Record data size in bytes
recordCaptures:
type: integer
description: Number of record captures not including current if recording
SigMFFileSinkActions:
description: SigMFFileSink
properties:
record:
type: integer
description: >
Record action
* 0 - stop recording
* 1 - start recording

2
sdrbase/resources/webapi/doc/swagger/swagger.yaml
View File

@ -2499,6 +2499,8 @@ definitions:
$ref: "/doc/swagger/include/SSBDemod.yaml#/SSBDemodReport"
RemoteSourceReport:
$ref: "/doc/swagger/include/RemoteSource.yaml#/RemoteSourceReport"
SigMFFileSinkReport:
$ref: "/doc/swagger/include/SigMFFileSink.yaml#/SigMFFileSinkReport"
SSBModReport:
$ref: "/doc/swagger/include/SSBMod.yaml#/SSBModReport"
UDPSourceReport:

2
swagger/sdrangel/api/swagger/include/ChannelActions.yaml
View File

@ -19,3 +19,5 @@ ChannelActions:
type: integer
FileSourceActions:
$ref: "http://swgserver:8081/api/swagger/include/FileSource.yaml#/FileSourceActions"
SigMFFileSinkActions:
$ref: "http://swgserver:8081/api/swagger/include/SigMFFileSink.yaml#/SigMFFileSinkActions"

2
swagger/sdrangel/api/swagger/include/ChannelSettings.yaml
View File

@ -61,6 +61,8 @@ ChannelSettings:
$ref: "http://swgserver:8081/api/swagger/include/RemoteSink.yaml#/RemoteSinkSettings"
RemoteSourceSettings:
$ref: "http://swgserver:8081/api/swagger/include/RemoteSource.yaml#/RemoteSourceSettings"
SigMFFileSinkSettings:
$ref: "http://swgserver:8081/api/swagger/include/SigMFFileSink.yaml#/SigMFFileSinkSettings"
SSBModSettings:
$ref: "http://swgserver:8081/api/swagger/include/SSBMod.yaml#/SSBModSettings"
SSBDemodSettings:

95
swagger/sdrangel/api/swagger/include/SigMFFileSink.yaml Normal file
View File

@ -0,0 +1,95 @@
SigMFFileSinkSettings:
description: SigMFFileSink
properties:
inputFrequencyOffset:
type: integer
fileRecordName:
type: string
description: full path of the meta file
rgbColor:
type: integer
title:
type: string
log2Decim:
type: integer
spectrumSquelchMode:
type: integer
description: >
Spectrum squelch system
* 0 - deactivated
* 1 - activated
spectrumSquelch:
type: number
format: float
description: Squelch level in power dB
squelchPreRecordTime:
type: integer
description: Number of seconds to record before spectrum squelch opens
squelchPostRecordTime:
type: integer
description: Number of seconds to record after spectrum squelch cloeses
squelchRecordingEnable:
type: integer
description: >
Automatic recording triggered by spectrum squalch
* 0 - disabled
* 1 - enabled
streamIndex:
description: MIMO channel. Not relevant when connected to SI (single Rx).
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
SigMFFileSinkReport:
description: SigMFFileSink
properties:
spectrumSquelch:
type: integer
description: >
Spectrum squelch status
* 0 - closed
* 1 - open
spectrumMax:
type: number
format: float
description: Current spectrum max in squared magnitude (power)
sinkSampleRate:
type: integer
channelSampleRate:
type: integer
recording:
type: integer
description: >
Recording status
* 0 - not recording
* 1 - recording
recordTimeMs:
type: integer
description: Record total time in milliseconds
recordSize:
type: integer
format: int64
description: Record data size in bytes
recordCaptures:
type: integer
description: Number of record captures not including current if recording
SigMFFileSinkActions:
description: SigMFFileSink
properties:
record:
type: integer
description: >
Record action
* 0 - stop recording
* 1 - start recording

2
swagger/sdrangel/api/swagger/swagger.yaml
View File

@ -2499,6 +2499,8 @@ definitions:
$ref: "http://swgserver:8081/api/swagger/include/SSBDemod.yaml#/SSBDemodReport"
RemoteSourceReport:
$ref: "http://swgserver:8081/api/swagger/include/RemoteSource.yaml#/RemoteSourceReport"
SigMFFileSinkReport:
$ref: "http://swgserver:8081/api/swagger/include/SigMFFileSink.yaml#/SigMFFileSinkReport"
SSBModReport:
$ref: "http://swgserver:8081/api/swagger/include/SSBMod.yaml#/SSBModReport"
UDPSourceReport: