1
0
mirror of https://github.com/f4exb/sdrangel.git synced 2024-11-11 10:56:12 -05:00
sdrangel/sdrbase/resources/webapi/doc/swagger/include/FreqScanner.yaml
2024-06-21 10:04:17 +01:00

107 lines
2.4 KiB
YAML

FreqScannerSettings:
description: FreqScanner
properties:
channelBandwidth:
description: channel RF bandwidth in Hz
type: integer
channelFrequencyOffset:
description: channel center frequency shift from baseband center in Hz
type: integer
threshold:
type: number
format: float
frequencies:
type: array
items:
$ref: "/doc/swagger/include/FreqScanner.yaml#/FreqScannerFrequency"
channel:
type: string
scanTime:
type: number
format: float
retransmitTime:
type: number
format: float
tuneTime:
type: number
format: float
priority:
type: integer
measurement:
type: integer
mode:
type: integer
rgbColor:
type: integer
title:
type: string
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
channelMarker:
$ref: "/doc/swagger/include/ChannelMarker.yaml#/ChannelMarker"
rollupState:
$ref: "/doc/swagger/include/RollupState.yaml#/RollupState"
FreqScannerReport:
description: FreqScanner
properties:
channelSampleRate:
type: integer
scanState:
description: (IDLE=0, START_SCAN=1, SCANNING=2, WAIT_FOR_END_TX=3, WAIT_FOR_RETRANSMISSION=4)
type: integer
channelState:
type: array
items:
$ref: "/doc/swagger/include/FreqScanner.yaml#/FreqScannerChannelState"
FreqScannerChannelState:
properties:
frequency:
description: "Channel centre frequency in Hz"
type: integer
power:
description: "Channel power in dB"
type: number
format: float
FreqScannerFrequency:
properties:
frequency:
type: integer
format: int64
enabled:
type: integer
notes:
type: string
channel:
type: string
channelBandwidth:
type: string
threshold:
type: string
squelch:
type: string
FreqScannerActions:
description: "Frequency Scanner actions"
properties:
run:
type: integer
description: >
Set the plugin running state
* 0 - idle
* 1 - run