mirror of
https://github.com/f4exb/sdrangel.git
synced 2024-11-22 16:08:39 -05:00
REST API device and channel actions: extension of record action: swagger files
This commit is contained in:
parent
417b48d115
commit
d821c3eb50
@ -56,3 +56,13 @@ AirspyReport:
|
|||||||
type: array
|
type: array
|
||||||
items:
|
items:
|
||||||
$ref: "http://localhost:8081/api/swagger/include/Structs.yaml#/SampleRate"
|
$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
|
||||||
|
@ -55,3 +55,13 @@ AirspyHFReport:
|
|||||||
type: array
|
type: array
|
||||||
items:
|
items:
|
||||||
$ref: "http://localhost:8081/api/swagger/include/Structs.yaml#/SampleRate"
|
$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
|
@ -40,6 +40,16 @@ BladeRF1InputSettings:
|
|||||||
reverseAPIDeviceIndex:
|
reverseAPIDeviceIndex:
|
||||||
type: integer
|
type: integer
|
||||||
|
|
||||||
|
BladeRF1InputActions:
|
||||||
|
description: BladeRF1
|
||||||
|
properties:
|
||||||
|
record:
|
||||||
|
type: integer
|
||||||
|
description: >
|
||||||
|
Record IQ stream action
|
||||||
|
* 0 - stop recording
|
||||||
|
* 1 - start recording
|
||||||
|
|
||||||
BladeRF1OutputSettings:
|
BladeRF1OutputSettings:
|
||||||
description: BladeRF1
|
description: BladeRF1
|
||||||
properties:
|
properties:
|
||||||
|
@ -14,5 +14,37 @@ DeviceActions:
|
|||||||
originatorIndex:
|
originatorIndex:
|
||||||
description: Optional for reverse API. This is the device set index from where the message comes from.
|
description: Optional for reverse API. This is the device set index from where the message comes from.
|
||||||
type: integer
|
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:
|
rtlSdrActions:
|
||||||
$ref: "http://localhost:8081/api/swagger/include/RtlSdr.yaml#/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"
|
||||||
|
@ -63,3 +63,12 @@ FCDProSettings:
|
|||||||
reverseAPIDeviceIndex:
|
reverseAPIDeviceIndex:
|
||||||
type: integer
|
type: integer
|
||||||
|
|
||||||
|
FCDProActions:
|
||||||
|
description: FCDPro
|
||||||
|
properties:
|
||||||
|
record:
|
||||||
|
type: integer
|
||||||
|
description: >
|
||||||
|
Record IQ stream action
|
||||||
|
* 0 - stop recording
|
||||||
|
* 1 - start recording
|
||||||
|
@ -48,3 +48,13 @@ FCDProPlusSettings:
|
|||||||
type: integer
|
type: integer
|
||||||
reverseAPIDeviceIndex:
|
reverseAPIDeviceIndex:
|
||||||
type: integer
|
type: integer
|
||||||
|
|
||||||
|
FCDProPlusActions:
|
||||||
|
description: FCDProPlus
|
||||||
|
properties:
|
||||||
|
record:
|
||||||
|
type: integer
|
||||||
|
description: >
|
||||||
|
Record IQ stream action
|
||||||
|
* 0 - stop recording
|
||||||
|
* 1 - start recording
|
||||||
|
@ -44,6 +44,16 @@ HackRFInputSettings:
|
|||||||
reverseAPIDeviceIndex:
|
reverseAPIDeviceIndex:
|
||||||
type: integer
|
type: integer
|
||||||
|
|
||||||
|
HackRFInputActions:
|
||||||
|
description: HackRF
|
||||||
|
properties:
|
||||||
|
record:
|
||||||
|
type: integer
|
||||||
|
description: >
|
||||||
|
Record IQ stream action
|
||||||
|
* 0 - stop recording
|
||||||
|
* 1 - start recording
|
||||||
|
|
||||||
HackRFOutputSettings:
|
HackRFOutputSettings:
|
||||||
description: HackRF
|
description: HackRF
|
||||||
properties:
|
properties:
|
||||||
@ -81,3 +91,4 @@ HackRFOutputSettings:
|
|||||||
type: integer
|
type: integer
|
||||||
reverseAPIDeviceIndex:
|
reverseAPIDeviceIndex:
|
||||||
type: integer
|
type: integer
|
||||||
|
|
||||||
|
@ -32,3 +32,13 @@ KiwiSDRReport:
|
|||||||
status:
|
status:
|
||||||
description: 0 for Idle, 1 for Connecting, 2 for Connected, 3 for Error, 4 for Disconnected
|
description: 0 for Idle, 1 for Connecting, 2 for Connected, 3 for Error, 4 for Disconnected
|
||||||
type: integer
|
type: integer
|
||||||
|
|
||||||
|
KiwiSDRActions:
|
||||||
|
description: KiwiSDR
|
||||||
|
properties:
|
||||||
|
record:
|
||||||
|
type: integer
|
||||||
|
description: >
|
||||||
|
Record IQ stream action
|
||||||
|
* 0 - stop recording
|
||||||
|
* 1 - start recording
|
||||||
|
@ -150,6 +150,16 @@ LimeSdrInputReport:
|
|||||||
type: integer
|
type: integer
|
||||||
format: int8
|
format: int8
|
||||||
|
|
||||||
|
LimeSdrInputActions:
|
||||||
|
description: LimeSDR
|
||||||
|
properties:
|
||||||
|
record:
|
||||||
|
type: integer
|
||||||
|
description: >
|
||||||
|
Record IQ stream action
|
||||||
|
* 0 - stop recording
|
||||||
|
* 1 - start recording
|
||||||
|
|
||||||
LimeSdrOutputReport:
|
LimeSdrOutputReport:
|
||||||
description: LimeSDR
|
description: LimeSDR
|
||||||
properties:
|
properties:
|
||||||
@ -185,4 +195,3 @@ LimeSdrOutputReport:
|
|||||||
gpioPins:
|
gpioPins:
|
||||||
type: integer
|
type: integer
|
||||||
format: int8
|
format: int8
|
||||||
|
|
@ -25,3 +25,13 @@ LocalInputReport:
|
|||||||
format: uint64
|
format: uint64
|
||||||
sampleRate:
|
sampleRate:
|
||||||
type: integer
|
type: integer
|
||||||
|
|
||||||
|
LocalInputActions:
|
||||||
|
description: LocalInput
|
||||||
|
properties:
|
||||||
|
record:
|
||||||
|
type: integer
|
||||||
|
description: >
|
||||||
|
Record IQ stream action
|
||||||
|
* 0 - stop recording
|
||||||
|
* 1 - start recording
|
@ -46,3 +46,13 @@ PerseusReport:
|
|||||||
type: array
|
type: array
|
||||||
items:
|
items:
|
||||||
$ref: "http://localhost:8081/api/swagger/include/Structs.yaml#/SampleRate"
|
$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
|
@ -132,3 +132,13 @@ PlutoSdrOutputReport:
|
|||||||
temperature:
|
temperature:
|
||||||
type: number
|
type: number
|
||||||
format: float
|
format: float
|
||||||
|
|
||||||
|
PlutoSdrInputActions:
|
||||||
|
description: PlutoSDR
|
||||||
|
properties:
|
||||||
|
record:
|
||||||
|
type: integer
|
||||||
|
description: >
|
||||||
|
Record IQ stream action
|
||||||
|
* 0 - stop recording
|
||||||
|
* 1 - start recording
|
||||||
|
@ -45,3 +45,13 @@ RemoteInputReport:
|
|||||||
maxNbRecovery:
|
maxNbRecovery:
|
||||||
description: Maximum number of recovery blocks used per frame
|
description: Maximum number of recovery blocks used per frame
|
||||||
type: integer
|
type: integer
|
||||||
|
|
||||||
|
RemoteInputActions:
|
||||||
|
description: RemoteInput
|
||||||
|
properties:
|
||||||
|
record:
|
||||||
|
type: integer
|
||||||
|
description: >
|
||||||
|
Record IQ stream action
|
||||||
|
* 0 - stop recording
|
||||||
|
* 1 - start recording
|
@ -64,3 +64,13 @@ SDRPlayReport:
|
|||||||
type: array
|
type: array
|
||||||
items:
|
items:
|
||||||
$ref: "http://localhost:8081/api/swagger/include/Structs.yaml#/FrequencyBand"
|
$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
|
@ -245,4 +245,12 @@ definitions:
|
|||||||
items:
|
items:
|
||||||
type: string
|
type: string
|
||||||
|
|
||||||
|
SoapySDRInputActions:
|
||||||
|
description: SoapySDR
|
||||||
|
properties:
|
||||||
|
record:
|
||||||
|
type: integer
|
||||||
|
description: >
|
||||||
|
Record IQ stream action
|
||||||
|
* 0 - stop recording
|
||||||
|
* 1 - start recording
|
@ -50,3 +50,12 @@ TestSourceSettings:
|
|||||||
reverseAPIDeviceIndex:
|
reverseAPIDeviceIndex:
|
||||||
type: integer
|
type: integer
|
||||||
|
|
||||||
|
TestSourceActions:
|
||||||
|
description: TestSource
|
||||||
|
properties:
|
||||||
|
record:
|
||||||
|
type: integer
|
||||||
|
description: >
|
||||||
|
Record IQ stream action
|
||||||
|
* 0 - stop recording
|
||||||
|
* 1 - start recording
|
@ -81,6 +81,16 @@ XtrxInputReport:
|
|||||||
description: 1 if GPSDO is locked else 0
|
description: 1 if GPSDO is locked else 0
|
||||||
type: integer
|
type: integer
|
||||||
|
|
||||||
|
XtrxInputActions:
|
||||||
|
description: XTRX
|
||||||
|
properties:
|
||||||
|
record:
|
||||||
|
type: integer
|
||||||
|
description: >
|
||||||
|
Record IQ stream action
|
||||||
|
* 0 - stop recording
|
||||||
|
* 1 - start recording
|
||||||
|
|
||||||
XtrxOutputSettings:
|
XtrxOutputSettings:
|
||||||
description: XTRX
|
description: XTRX
|
||||||
properties:
|
properties:
|
||||||
|
Loading…
Reference in New Issue
Block a user