diff --git a/swagger/sdrangel/api/swagger/include/LimeRFE.yaml b/swagger/sdrangel/api/swagger/include/LimeRFE.yaml index 1ce72fecf..095a88c00 100644 --- a/swagger/sdrangel/api/swagger/include/LimeRFE.yaml +++ b/swagger/sdrangel/api/swagger/include/LimeRFE.yaml @@ -5,20 +5,46 @@ LimeRFESettings: description: Path to the device serial interface (ex /dev/ttyUSB2) type: string rxChannels: - description: Rx channels group (see LimeRFEController.ChannelGroups enumeration) type: integer + description: > + Rx channels group (LimeRFEController::ChannelGroups): + * 0 - Wideband + * 1 - HAM + * 2 - cellular rxWidebandChannel: - descrition: Rx wideband channel selection (see LimeRFEController.WidebandChannel enumeration) type: integer + description: > + Rx wideband channel selection (LimeRFEController::WidebandChannel) + * 0 - Low: 1 - 1000 MHz + * 1 - High: 1 - 4 GHz rxHAMChannel: - description: Rx HAM channel selection (see LimeRFEController.HAMChannel enumeration) 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: - description: Rx cellular channel selection (see LimeRFEController.HAMChannel enumeration) 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: - description: Rx port selected (see LimeRFEController.RxPort enumeration) type: integer + description: > + Rx port selected (LimeRFEController::RxPort) + * 0 - J3 + * 1 - J5 attenuationFactor: description: Rx attenuation factor. Attenuation is 2 times this factor in dB (0..7 => 0..14dB) type: integer @@ -26,26 +52,56 @@ LimeRFESettings: desciption: Rx AM/FM notch filter (boolean) type: integer txChannels: - description: Tx channels group (see LimeRFEController.ChannelGroups enumeration) type: integer + description: > + Tx channels group (LimeRFEController::ChannelGroups) + * 0 - Wideband + * 1 - HAM + * 2 - cellular txWidebandChannel: - descrition: Tx wideband channel selection (see LimeRFEController.WidebandChannel enumeration) type: integer + description: > + Tx wideband channel selection (LimeRFEController::WidebandChannel) + * 0 - Low: 1 - 1000 MHz + * 1 - High: 1 - 4 GHz txHAMChannel: - description: Tx HAM channel selection (see LimeRFEController.HAMChannel enumeration) 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: - description: Tx cellular channel selection (see LimeRFEController.HAMChannel enumeration) 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: - description: Tx port selected (see LimeRFEController.TxPort enumeration) type: integer + description: > + Tx port selected (LimeRFEController::TxPort) + * 0 - J3 + * 1 - J4 + * 2 - J5 swrEnable: description: Boolean if SWR measurements are enabled else 0 type: integer swrSource: - description: SWR measurement source (see LimeRFEController.SWRSource) type: integer + description: > + SWR measurement source (LimeRFEController::SWRSource) + * 0 - External + * 1 - Cellular rxOn: description: Boolean 1 if Rx is active else 0 type: integer