VE7UWU/sdrangel
1
0
Fork 0
mirror of https://github.com/f4exb/sdrangel.git synced 2024-09-27 15:26:33 -04:00
Code Issues Projects Releases Wiki Activity

REST API device and channel actions: extension of record action: swagger files

Browse Source
This commit is contained in:
f4exb 2020-03-10 05:19:24 +01:00
parent 417b48d115
commit d821c3eb50
17 changed files with 250 additions and 62 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
swagger/sdrangel/api/swagger/include/Airspy.yaml
View File

@ -56,3 +56,13 @@ AirspyReport:
type: array
items:
$ref: "http://localhost:8081/api/swagger/include/Structs.yaml#/SampleRate"
AirspyActions:
description: Airspy
properties:
record:
type: integer
description: >
Record IQ stream action
* 0 - stop recording
* 1 - start recording

10
swagger/sdrangel/api/swagger/include/AirspyHF.yaml
View File

@ -55,3 +55,13 @@ AirspyHFReport:
type: array
items:
$ref: "http://localhost:8081/api/swagger/include/Structs.yaml#/SampleRate"
AirspyHFActions:
description: AirspyHF
properties:
record:
type: integer
description: >
Record IQ stream action
* 0 - stop recording
* 1 - start recording

10
swagger/sdrangel/api/swagger/include/BladeRF1.yaml
View File

@ -40,6 +40,16 @@ BladeRF1InputSettings:
reverseAPIDeviceIndex:
type: integer
BladeRF1InputActions:
description: BladeRF1
properties:
record:
type: integer
description: >
Record IQ stream action
* 0 - stop recording
* 1 - start recording
BladeRF1OutputSettings:
description: BladeRF1
properties:

32
swagger/sdrangel/api/swagger/include/DeviceActions.yaml
View File

@ -14,5 +14,37 @@ DeviceActions:
originatorIndex:
description: Optional for reverse API. This is the device set index from where the message comes from.
type: integer
airspyActions:
$ref: "http://localhost:8081/api/swagger/include/Airspy.yaml#/AirspyActions"
airspyHFActions:
$ref: "http://localhost:8081/api/swagger/include/AirspyHF.yaml#/AirspyHFActions"
bladeRF1InputActions:
$ref: "http://localhost:8081/api/swagger/include/BladeRF1.yaml#/BladeRF1InputActions"
fcdProActions:
$ref: "http://localhost:8081/api/swagger/include/FCDPro.yaml#/FCDProActions"
fcdProPlusActions:
$ref: "http://localhost:8081/api/swagger/include/FCDProPlus.yaml#/FCDProPlusActions"
hackRFInputActions:
$ref: "http://localhost:8081/api/swagger/include/HackRF.yaml#/HackRFInputActions"
kiwiSDRActions:
$ref: "http://localhost:8081/api/swagger/include/KiwiSDR.yaml#/KiwiSDRActions"
limeSdrInputActions:
$ref: "http://localhost:8081/api/swagger/include/LimeSdr.yaml#/LimeSdrInputActions"
localInputActions:
$ref: "http://localhost:8081/api/swagger/include/LocalInput.yaml#/LocalInputActions"
perseusActions:
$ref: "http://localhost:8081/api/swagger/include/Perseus.yaml#/PerseusActions"
plutoSdrInputActions:
$ref: "http://localhost:8081/api/swagger/include/PlutoSdr.yaml#/PlutoSdrInputActions"
remoteInputActions:
$ref: "http://localhost:8081/api/swagger/include/RemoteInput.yaml#/RemoteInputActions"
rtlSdrActions:
$ref: "http://localhost:8081/api/swagger/include/RtlSdr.yaml#/RtlSdrActions"
sdrPlayActions:
$ref: "http://localhost:8081/api/swagger/include/SDRPlay.yaml#/SDRPlayActions"
soapySDRInputActions:
$ref: "http://localhost:8081/api/swagger/include/SoapySDR.yaml#/SoapySDRInputActions"
testSourceActions:
$ref: "http://localhost:8081/api/swagger/include/TestSource.yaml#/TestSourceActions"
xtrxInputActions:
$ref: "http://localhost:8081/api/swagger/include/Xtrx.yaml#/XtrxInputActions"

9
swagger/sdrangel/api/swagger/include/FCDPro.yaml
View File

@ -63,3 +63,12 @@ FCDProSettings:
reverseAPIDeviceIndex:
type: integer
FCDProActions:
description: FCDPro
properties:
record:
type: integer
description: >
Record IQ stream action
* 0 - stop recording
* 1 - start recording

10
swagger/sdrangel/api/swagger/include/FCDProPlus.yaml
View File

@ -48,3 +48,13 @@ FCDProPlusSettings:
type: integer
reverseAPIDeviceIndex:
type: integer
FCDProPlusActions:
description: FCDProPlus
properties:
record:
type: integer
description: >
Record IQ stream action
* 0 - stop recording
* 1 - start recording

11
swagger/sdrangel/api/swagger/include/HackRF.yaml
View File

@ -44,6 +44,16 @@ HackRFInputSettings:
reverseAPIDeviceIndex:
type: integer
HackRFInputActions:
description: HackRF
properties:
record:
type: integer
description: >
Record IQ stream action
* 0 - stop recording
* 1 - start recording
HackRFOutputSettings:
description: HackRF
properties:
@ -81,3 +91,4 @@ HackRFOutputSettings:
type: integer
reverseAPIDeviceIndex:
type: integer

10
swagger/sdrangel/api/swagger/include/KiwiSDR.yaml
View File

@ -32,3 +32,13 @@ KiwiSDRReport:
status:
description: 0 for Idle, 1 for Connecting, 2 for Connected, 3 for Error, 4 for Disconnected
type: integer
KiwiSDRActions:
description: KiwiSDR
properties:
record:
type: integer
description: >
Record IQ stream action
* 0 - stop recording
* 1 - start recording

87
swagger/sdrangel/api/swagger/include/LimeSdr.yaml
View File

@ -1,6 +1,6 @@
LimeSdrInputSettings:
description: LimeSDR
properties:
properties:
centerFrequency:
type: integer
format: int64
@ -14,37 +14,37 @@ LimeSdrInputSettings:
type: integer
log2SoftDecim:
type: integer
lpfBW:
lpfBW:
type: integer
lpfFIREnable:
lpfFIREnable:
type: integer
lpfFIRBW:
lpfFIRBW:
type: integer
gain:
gain:
type: integer
ncoEnable:
ncoEnable:
type: integer
ncoFrequency:
ncoFrequency:
type: integer
antennaPath:
type: integer
gainMode:
gainMode:
type: integer
lnaGain:
lnaGain:
type: integer
tiaGain:
tiaGain:
type: integer
pgaGain:
pgaGain:
type: integer
extClock:
extClock:
type: integer
extClockFreq:
extClockFreq:
type: integer
transverterMode:
type: integer
transverterDeltaFrequency:
type: integer
format: int64
format: int64
fileRecordName:
type: string
gpioDir:
@ -61,11 +61,11 @@ LimeSdrInputSettings:
reverseAPIPort:
type: integer
reverseAPIDeviceIndex:
type: integer
type: integer
LimeSdrOutputSettings:
description: LimeSDR
properties:
properties:
centerFrequency:
type: integer
format: int64
@ -75,29 +75,29 @@ LimeSdrOutputSettings:
type: integer
log2SoftInterp:
type: integer
lpfBW:
lpfBW:
type: integer
lpfFIREnable:
lpfFIREnable:
type: integer
lpfFIRBW:
lpfFIRBW:
type: integer
gain:
gain:
type: integer
ncoEnable:
ncoEnable:
type: integer
ncoFrequency:
ncoFrequency:
type: integer
antennaPath:
type: integer
extClock:
extClock:
type: integer
extClockFreq:
extClockFreq:
type: integer
transverterMode:
type: integer
transverterDeltaFrequency:
type: integer
format: int64
format: int64
gpioDir:
type: integer
format: int8
@ -112,11 +112,11 @@ LimeSdrOutputSettings:
reverseAPIPort:
type: integer
reverseAPIDeviceIndex:
type: integer
type: integer
LimeSdrInputReport:
description: LimeSDR
properties:
properties:
success:
description: 1 if info was successfullt retrieved else 0
type: integer
@ -127,11 +127,11 @@ LimeSdrInputReport:
type: integer
fifoFill:
type: integer
underrunCount:
underrunCount:
type: integer
overrunCount:
overrunCount:
type: integer
droppedPacketsCount:
droppedPacketsCount:
type: integer
linkRate:
type: number
@ -145,14 +145,24 @@ LimeSdrInputReport:
format: float
gpioDir:
type: integer
format: int8
format: int8
gpioPins:
type: integer
format: int8
LimeSdrInputActions:
description: LimeSDR
properties:
record:
type: integer
description: >
Record IQ stream action
* 0 - stop recording
* 1 - start recording
LimeSdrOutputReport:
description: LimeSDR
properties:
properties:
success:
description: 1 if info was successfullt retrieved else 0
type: integer
@ -163,11 +173,11 @@ LimeSdrOutputReport:
type: integer
fifoFill:
type: integer
underrunCount:
underrunCount:
type: integer
overrunCount:
overrunCount:
type: integer
droppedPacketsCount:
droppedPacketsCount:
type: integer
linkRate:
type: number
@ -178,11 +188,10 @@ LimeSdrOutputReport:
format: uint64
temperature:
type: number
format: float
format: float
gpioDir:
type: integer
format: int8
format: int8
gpioPins:
type: integer
format: int8

10
swagger/sdrangel/api/swagger/include/LocalInput.yaml
View File

@ -25,3 +25,13 @@ LocalInputReport:
format: uint64
sampleRate:
type: integer
LocalInputActions:
description: LocalInput
properties:
record:
type: integer
description: >
Record IQ stream action
* 0 - stop recording
* 1 - start recording

10
swagger/sdrangel/api/swagger/include/Perseus.yaml
View File

@ -46,3 +46,13 @@ PerseusReport:
type: array
items:
$ref: "http://localhost:8081/api/swagger/include/Structs.yaml#/SampleRate"
PerseusActions:
description: Perseus
properties:
record:
type: integer
description: >
Record IQ stream action
* 0 - stop recording
* 1 - start recording

12
swagger/sdrangel/api/swagger/include/PlutoSdr.yaml
View File

@ -131,4 +131,14 @@ PlutoSdrOutputReport:
type: string
temperature:
type: number
format: float
format: float
PlutoSdrInputActions:
description: PlutoSDR
properties:
record:
type: integer
description: >
Record IQ stream action
* 0 - stop recording
* 1 - start recording

10
swagger/sdrangel/api/swagger/include/RemoteInput.yaml
View File

@ -45,3 +45,13 @@ RemoteInputReport:
maxNbRecovery:
description: Maximum number of recovery blocks used per frame
type: integer
RemoteInputActions:
description: RemoteInput
properties:
record:
type: integer
description: >
Record IQ stream action
* 0 - stop recording
* 1 - start recording

10
swagger/sdrangel/api/swagger/include/SDRPlay.yaml
View File

@ -64,3 +64,13 @@ SDRPlayReport:
type: array
items:
$ref: "http://localhost:8081/api/swagger/include/Structs.yaml#/FrequencyBand"
SDRPlayActions:
description: SDRplay1
properties:
record:
type: integer
description: >
Record IQ stream action
* 0 - stop recording
* 1 - start recording

10
swagger/sdrangel/api/swagger/include/SoapySDR.yaml
View File

@ -245,4 +245,12 @@ definitions:
items:
type: string
SoapySDRInputActions:
description: SoapySDR
properties:
record:
type: integer
description: >
Record IQ stream action
* 0 - stop recording
* 1 - start recording

15
swagger/sdrangel/api/swagger/include/TestSource.yaml
View File

@ -28,7 +28,7 @@ TestSourceSettings:
type: integer
dcFactor:
type: number
format: float
format: float
iFactor:
type: number
format: float
@ -48,5 +48,14 @@ TestSourceSettings:
reverseAPIPort:
type: integer
reverseAPIDeviceIndex:
type: integer
type: integer
TestSourceActions:
description: TestSource
properties:
record:
type: integer
description: >
Record IQ stream action
* 0 - stop recording
* 1 - start recording

46
swagger/sdrangel/api/swagger/include/Xtrx.yaml
View File

@ -1,6 +1,6 @@
XtrxInputSettings:
description: XTRX
properties:
properties:
centerFrequency:
type: integer
format: int64
@ -24,16 +24,16 @@ XtrxInputSettings:
type: integer
ncoEnable:
description: Enable TSP NCO and mixing (1 for yes, 0 for no)
type: integer
type: integer
ncoFrequency:
description: Frequency shift from LO
type: integer
antennaPath:
description: Antenna selected (enum value from xtrx_antenna_t)
type: integer
type: integer
gainMode:
description: Gain mode auto or manual (enum value from GainMode)
type: integer
type: integer
lnaGain:
description: Manual LNA gain
type: integer
@ -42,16 +42,16 @@ XtrxInputSettings:
type: integer
pgaGain:
description: Manual PGA gain
type: integer
type: integer
extClock:
description: Use external clock source (1 for yes, 0 for no)
type: integer
type: integer
extClockFreq:
description: Frequency (Hz) of external clock source
type: integer
pwrmode:
description: LMS power mode (0 save max to 7 perf max)
type: integer
type: integer
fileRecordName:
type: string
useReverseAPI:
@ -62,11 +62,11 @@ XtrxInputSettings:
reverseAPIPort:
type: integer
reverseAPIDeviceIndex:
type: integer
type: integer
XtrxInputReport:
description: XTRX
properties:
properties:
success:
description: 1 if info was successfully retrieved else 0
type: integer
@ -80,10 +80,20 @@ XtrxInputReport:
gpsLock:
description: 1 if GPSDO is locked else 0
type: integer
XtrxInputActions:
description: XTRX
properties:
record:
type: integer
description: >
Record IQ stream action
* 0 - stop recording
* 1 - start recording
XtrxOutputSettings:
description: XTRX
properties:
properties:
centerFrequency:
type: integer
format: int64
@ -101,22 +111,22 @@ XtrxOutputSettings:
type: integer
ncoEnable:
description: Enable TSP NCO and mixing (1 for yes, 0 for no)
type: integer
type: integer
ncoFrequency:
description: Frequency shift from LO
type: integer
antennaPath:
description: Antenna selected (enum value from xtrx_antenna_t)
type: integer
type: integer
extClock:
description: Use external clock source (1 for yes, 0 for no)
type: integer
type: integer
extClockFreq:
description: Frequency (Hz) of external clock source
type: integer
pwrmode:
description: LMS power mode (0 save max to 7 perf max)
type: integer
type: integer
useReverseAPI:
description: Synchronize with reverse API (1 for yes, 0 for no)
type: integer
@ -125,11 +135,11 @@ XtrxOutputSettings:
reverseAPIPort:
type: integer
reverseAPIDeviceIndex:
type: integer
type: integer
XtrxOutputReport:
description: XTRX
properties:
properties:
success:
description: 1 if info was successfully retrieved else 0
type: integer
@ -142,4 +152,4 @@ XtrxOutputReport:
format: float
gpsLock:
description: 1 if GPSDO is locked else 0
type: integer
type: integer