1
0
mirror of https://github.com/f4exb/sdrangel.git synced 2026-06-08 00:44:48 -04:00

REST API: added missing file in doc resources

This commit is contained in:
f4exb
2021-04-12 15:13:39 +02:00
parent d0c50549af
commit abdb6db51e
11 changed files with 355 additions and 16 deletions
@@ -130,6 +130,15 @@ ChirpChatModSettings:
messageRepeat:
description: number of repetitions of the same message (0 for infinite)
type: integer
udpEnabled:
description: boolean 1 to enable forwarding messages via UDP else 0
type: integer
udpAddress:
description: UDP address to listen for messages to transmit on
type: string
udpPort:
description: UDP port to listen for messages to transmit on
type: integer
rgbColor:
type: integer
title:
@@ -90,6 +90,7 @@ DATVDemodSettings:
description: (boolean) (DVB-S)
type: integer
excursion:
description: RRC filter envelope excursion (dB)
type: integer
audioVolume:
type: integer
@@ -17,5 +17,7 @@ FeatureActions:
$ref: "/doc/swagger/include/AFC.yaml#/AFCActions"
MapActions:
$ref: "/doc/swagger/include/Map.yaml#/MapActions"
PERTesterActions:
$ref: "/doc/swagger/include/PERTester.yaml#/PERTesterActions"
SimplePTTActions:
$ref: "/doc/swagger/include/SimplePTT.yaml#/SimplePTTActions"
@@ -23,6 +23,8 @@ FeatureSettings:
$ref: "/doc/swagger/include/GS232Controller.yaml#/GS232ControllerSettings"
MapSettings:
$ref: "/doc/swagger/include/Map.yaml#/MapSettings"
PERTesterSettings:
$ref: "/doc/swagger/include/PERTester.yaml#/PERTesterSettings"
RigCtlServerSettings:
$ref: "/doc/swagger/include/RigCtlServer.yaml#/RigCtlServerSettings"
SatelliteTrackerSettings:
@@ -25,6 +25,15 @@ IEEE_802_15_4_ModSettings:
repeatCount:
description: Number of times to repeat the frame (-1 for infinite).
type: integer
udpEnabled:
description: Enable forwarding of frames via UDP
type: integer
udpAddress:
description: UDP address to listen for frames to transmit on
type: string
udpPort:
description: UDP port to listen for frames to transmit on
type: integer
rgbColor:
type: integer
title:
@@ -24,9 +24,27 @@ NFMModSettings:
playLoop:
type: integer
ctcssOn:
description: >
Enable CTCSS squelch (takes precedence on DCS)
* 0 - disabled
* 1 - enabled
type: integer
ctcssIndex:
type: integer
dcsOn:
description: >
Enable DCS squelch (only if CTCSS is off)
* 0 - disabled
* 1 - enabled
type: integer
dcsCode:
type: integer
dcsPositive:
description: >
Modulation direction:
* 0 - reverse or negative - 1 for 0 and -1 for 1
* 1 - direct or positive - -1 for 0 and 1 for 1
type: integer
rgbColor:
type: integer
title:
@@ -0,0 +1,67 @@
PERTesterSettings:
description: "PER Tester settings"
properties:
packetCount:
type: integer
interval:
type: number
format: float
start:
description: "0 - immediately, 1 - on satellite AOS, 2 - on satellite mid pass"
type: integer
satellites:
description: "Satellite names to start test on"
type: array
items:
type: string
packet:
description: "Packet of data to send"
type: string
ignoreLeadingBytes:
type: integer
ignoreTrailingBytes:
type: integer
txUDPAddress:
description: "UDP address to sent packets to be transmitted to"
type: string
txUDPPort:
description: "UDP port to sent packets to be transmitted to"
type: integer
rxUDPAddress:
description: "UDP address to receive packets via"
type: string
rxUDPPort:
description: "UDP port to receive packets via"
type: integer
title:
type: string
rgbColor:
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
PERTesterActions:
description: PERTester
properties:
aos:
description: "Acquisition of signal"
type: object
properties:
satelliteName:
description: "Name of the satellite"
type: string
aosTime:
description: "Time of AOS"
type: string
losTime:
description: "Time of LOS"
type: string
@@ -15,6 +15,15 @@ PacketDemodSettings:
fmDeviation:
type: number
format: float
udpEnabled:
description: "Whether to forward received packets to specified UDP port"
type: integer
udpAddress:
description: "UDP address to forward received packets to"
type: string
udpPort:
description: "UDP port to forward received packets to"
type: integer
rgbColor:
type: integer
title:
@@ -119,6 +119,15 @@ PacketModSettings:
format: float
symbolSpan:
type: integer
udpEnabled:
description: "Whether to receive packets to transmit on specified UDP port"
type: integer
udpAddress:
description: "UDP address to receive packets to transmit via"
type: string
udpPort:
description: "UDP port to receive packets to transmit via"
type: integer
rgbColor:
type: integer
title: