VE7UWU/sdrangel
1
0
Fork 0
mirror of https://github.com/f4exb/sdrangel.git synced 2024-11-26 01:39:05 -05:00
Code Issues Projects Releases Wiki Activity

LimeRFE USB: improved API documentation

Browse Source
This commit is contained in:
f4exb 2020-03-08 22:06:26 +01:00
parent 9c7cb0a49a
commit 145ed5b462
1 changed files with 67 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

78
swagger/sdrangel/api/swagger/include/LimeRFE.yaml
View File

@ -5,20 +5,46 @@ LimeRFESettings:
description: Path to the device serial interface (ex /dev/ttyUSB2) description: Path to the device serial interface (ex /dev/ttyUSB2)
type: string type: string
rxChannels: rxChannels:
description: Rx channels group (see LimeRFEController.ChannelGroups enumeration)
type: integer type: integer
description: >
Rx channels group (LimeRFEController::ChannelGroups):
* 0 - Wideband
* 1 - HAM
* 2 - cellular
rxWidebandChannel: rxWidebandChannel:
descrition: Rx wideband channel selection (see LimeRFEController.WidebandChannel enumeration)
type: integer type: integer
description: >
Rx wideband channel selection (LimeRFEController::WidebandChannel)
* 0 - Low: 1 - 1000 MHz
* 1 - High: 1 - 4 GHz
rxHAMChannel: rxHAMChannel:
description: Rx HAM channel selection (see LimeRFEController.HAMChannel enumeration)
type: integer type: integer
description: >
Rx HAM channel selection (LimeRFEController::HAMChannel)
* 0 - 30 MHz and lower
* 1 - 50 - 70 MHz
* 2 - 144 - 146 MHz
* 3 - 220 - 225 MHz
* 4 - 430 - 440 MHz
* 5 - 902 - 928 MHz
* 6 - 1240 - 1325 MHz
* 7 - 2300 - 2450 MHz
* 8 - 3300 - 3500 MHz
rxCellularChannel: rxCellularChannel:
description: Rx cellular channel selection (see LimeRFEController.HAMChannel enumeration)
type: integer type: integer
description: >
Rx cellular channel selection (LimeRFEController::CellularChannel)
* 0 - Band 1: 1.92 - 1.98 GHz
* 1 - Band 2: 1.84 - 1.92 GHz
* 2 - Band 3: 1.71 - 1.79 GHz
* 3 - Band 7: 2.48 - 2.58 GHz
* 4 - Band 38: 2.56 - 2.63 GHz
rxPort: rxPort:
description: Rx port selected (see LimeRFEController.RxPort enumeration)
type: integer type: integer
description: >
Rx port selected (LimeRFEController::RxPort)
* 0 - J3
* 1 - J5
attenuationFactor: attenuationFactor:
description: Rx attenuation factor. Attenuation is 2 times this factor in dB (0..7 => 0..14dB) description: Rx attenuation factor. Attenuation is 2 times this factor in dB (0..7 => 0..14dB)
type: integer type: integer
@ -26,26 +52,56 @@ LimeRFESettings:
desciption: Rx AM/FM notch filter (boolean) desciption: Rx AM/FM notch filter (boolean)
type: integer type: integer
txChannels: txChannels:
description: Tx channels group (see LimeRFEController.ChannelGroups enumeration)
type: integer type: integer
description: >
Tx channels group (LimeRFEController::ChannelGroups)
* 0 - Wideband
* 1 - HAM
* 2 - cellular
txWidebandChannel: txWidebandChannel:
descrition: Tx wideband channel selection (see LimeRFEController.WidebandChannel enumeration)
type: integer type: integer
description: >
Tx wideband channel selection (LimeRFEController::WidebandChannel)
* 0 - Low: 1 - 1000 MHz
* 1 - High: 1 - 4 GHz
txHAMChannel: txHAMChannel:
description: Tx HAM channel selection (see LimeRFEController.HAMChannel enumeration)
type: integer type: integer
description: >
Tx HAM channel selection (LimeRFEController::HAMChannel)
* 0 - 30 MHz and lower
* 1 - 50 - 70 MHz
* 2 - 144 - 146 MHz
* 3 - 220 - 225 MHz
* 4 - 430 - 440 MHz
* 5 - 902 - 928 MHz
* 6 - 1240 - 1325 MHz
* 7 - 2300 - 2450 MHz
* 8 - 3300 - 3500 MHz
txCellularChannel: txCellularChannel:
description: Tx cellular channel selection (see LimeRFEController.HAMChannel enumeration)
type: integer type: integer
description: >
Tx cellular channel selection (LimeRFEController::CellularChannel)
* 0 - Band 1: 1.92 - 1.98 GHz
* 1 - Band 2: 1.84 - 1.92 GHz
* 2 - Band 3: 1.71 - 1.79 GHz
* 3 - Band 7: 2.48 - 2.58 GHz
* 4 - Band 38: 2.56 - 2.63 GHz
txPort: txPort:
description: Tx port selected (see LimeRFEController.TxPort enumeration)
type: integer type: integer
description: >
Tx port selected (LimeRFEController::TxPort)
* 0 - J3
* 1 - J4
* 2 - J5
swrEnable: swrEnable:
description: Boolean if SWR measurements are enabled else 0 description: Boolean if SWR measurements are enabled else 0
type: integer type: integer
swrSource: swrSource:
description: SWR measurement source (see LimeRFEController.SWRSource)
type: integer type: integer
description: >
SWR measurement source (LimeRFEController::SWRSource)
* 0 - External
* 1 - Cellular
rxOn: rxOn:
description: Boolean 1 if Rx is active else 0 description: Boolean 1 if Rx is active else 0
type: integer type: integer