mirror of
https://github.com/f4exb/sdrangel.git
synced 2025-04-05 19:18:38 -04:00
REST API: added missing file in doc resources
This commit is contained in:
f4exb
parent
d0c50549af
commit
abdb6db51e
sdrbase/resources/webapi/doc
html2
swagger/include
swagger/sdrangel/code/html2
@ -3256,6 +3256,18 @@ margin-bottom: 20px;
|
||||
"type" : "integer",
|
||||
"description" : "number of repetitions of the same message (0 for infinite)"
|
||||
},
|
||||
"udpEnabled" : {
|
||||
"type" : "integer",
|
||||
"description" : "boolean 1 to enable forwarding messages via UDP else 0"
|
||||
},
|
||||
"udpAddress" : {
|
||||
"type" : "string",
|
||||
"description" : "UDP address to listen for messages to transmit on"
|
||||
},
|
||||
"udpPort" : {
|
||||
"type" : "integer",
|
||||
"description" : "UDP port to listen for messages to transmit on"
|
||||
},
|
||||
"rgbColor" : {
|
||||
"type" : "integer"
|
||||
},
|
||||
@ -3411,7 +3423,8 @@ margin-bottom: 20px;
|
||||
"description" : "(boolean) (DVB-S)"
|
||||
},
|
||||
"excursion" : {
|
||||
"type" : "integer"
|
||||
"type" : "integer",
|
||||
"description" : "RRC filter envelope excursion (dB)"
|
||||
},
|
||||
"audioVolume" : {
|
||||
"type" : "integer"
|
||||
@ -4352,6 +4365,9 @@ margin-bottom: 20px;
|
||||
"MapActions" : {
|
||||
"$ref" : "#/definitions/MapActions"
|
||||
},
|
||||
"PERTesterActions" : {
|
||||
"$ref" : "#/definitions/PERTesterActions"
|
||||
},
|
||||
"SimplePTTActions" : {
|
||||
"$ref" : "#/definitions/SimplePTTActions"
|
||||
}
|
||||
@ -4468,6 +4484,9 @@ margin-bottom: 20px;
|
||||
"MapSettings" : {
|
||||
"$ref" : "#/definitions/MapSettings"
|
||||
},
|
||||
"PERTesterSettings" : {
|
||||
"$ref" : "#/definitions/PERTesterSettings"
|
||||
},
|
||||
"RigCtlServerSettings" : {
|
||||
"$ref" : "#/definitions/RigCtlServerSettings"
|
||||
},
|
||||
@ -5466,6 +5485,18 @@ margin-bottom: 20px;
|
||||
"type" : "integer",
|
||||
"description" : "Number of times to repeat the frame (-1 for infinite)."
|
||||
},
|
||||
"udpEnabled" : {
|
||||
"type" : "integer",
|
||||
"description" : "Enable forwarding of frames via UDP"
|
||||
},
|
||||
"udpAddress" : {
|
||||
"type" : "string",
|
||||
"description" : "UDP address to listen for frames to transmit on"
|
||||
},
|
||||
"udpPort" : {
|
||||
"type" : "integer",
|
||||
"description" : "UDP port to listen for frames to transmit on"
|
||||
},
|
||||
"rgbColor" : {
|
||||
"type" : "integer"
|
||||
},
|
||||
@ -7039,11 +7070,23 @@ margin-bottom: 20px;
|
||||
"type" : "integer"
|
||||
},
|
||||
"ctcssOn" : {
|
||||
"type" : "integer"
|
||||
"type" : "integer",
|
||||
"description" : "Enable CTCSS squelch (takes precedence on DCS) * 0 - disabled * 1 - enabled\n"
|
||||
},
|
||||
"ctcssIndex" : {
|
||||
"type" : "integer"
|
||||
},
|
||||
"dcsOn" : {
|
||||
"type" : "integer",
|
||||
"description" : "Enable DCS squelch (only if CTCSS is off) * 0 - disabled * 1 - enabled\n"
|
||||
},
|
||||
"dcsCode" : {
|
||||
"type" : "integer"
|
||||
},
|
||||
"dcsPositive" : {
|
||||
"type" : "integer",
|
||||
"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\n"
|
||||
},
|
||||
"rgbColor" : {
|
||||
"type" : "integer"
|
||||
},
|
||||
@ -7092,6 +7135,102 @@ margin-bottom: 20px;
|
||||
}
|
||||
},
|
||||
"description" : "Enumeration with name for values"
|
||||
};
|
||||
defs.PERTesterActions = {
|
||||
"properties" : {
|
||||
"aos" : {
|
||||
"$ref" : "#/definitions/PERTesterActions_aos"
|
||||
}
|
||||
},
|
||||
"description" : "PERTester"
|
||||
};
|
||||
defs.PERTesterActions_aos = {
|
||||
"properties" : {
|
||||
"satelliteName" : {
|
||||
"type" : "string",
|
||||
"description" : "Name of the satellite"
|
||||
},
|
||||
"aosTime" : {
|
||||
"type" : "string",
|
||||
"description" : "Time of AOS"
|
||||
},
|
||||
"losTime" : {
|
||||
"type" : "string",
|
||||
"description" : "Time of LOS"
|
||||
}
|
||||
},
|
||||
"description" : "Acquisition of signal"
|
||||
};
|
||||
defs.PERTesterSettings = {
|
||||
"properties" : {
|
||||
"packetCount" : {
|
||||
"type" : "integer"
|
||||
},
|
||||
"interval" : {
|
||||
"type" : "number",
|
||||
"format" : "float"
|
||||
},
|
||||
"start" : {
|
||||
"type" : "integer",
|
||||
"description" : "0 - immediately, 1 - on satellite AOS, 2 - on satellite mid pass"
|
||||
},
|
||||
"satellites" : {
|
||||
"type" : "array",
|
||||
"description" : "Satellite names to start test on",
|
||||
"items" : {
|
||||
"type" : "string"
|
||||
}
|
||||
},
|
||||
"packet" : {
|
||||
"type" : "string",
|
||||
"description" : "Packet of data to send"
|
||||
},
|
||||
"ignoreLeadingBytes" : {
|
||||
"type" : "integer"
|
||||
},
|
||||
"ignoreTrailingBytes" : {
|
||||
"type" : "integer"
|
||||
},
|
||||
"txUDPAddress" : {
|
||||
"type" : "string",
|
||||
"description" : "UDP address to sent packets to be transmitted to"
|
||||
},
|
||||
"txUDPPort" : {
|
||||
"type" : "integer",
|
||||
"description" : "UDP port to sent packets to be transmitted to"
|
||||
},
|
||||
"rxUDPAddress" : {
|
||||
"type" : "string",
|
||||
"description" : "UDP address to receive packets via"
|
||||
},
|
||||
"rxUDPPort" : {
|
||||
"type" : "integer",
|
||||
"description" : "UDP port to receive packets via"
|
||||
},
|
||||
"title" : {
|
||||
"type" : "string"
|
||||
},
|
||||
"rgbColor" : {
|
||||
"type" : "integer"
|
||||
},
|
||||
"useReverseAPI" : {
|
||||
"type" : "integer",
|
||||
"description" : "Synchronize with reverse API (1 for yes, 0 for no)"
|
||||
},
|
||||
"reverseAPIAddress" : {
|
||||
"type" : "string"
|
||||
},
|
||||
"reverseAPIPort" : {
|
||||
"type" : "integer"
|
||||
},
|
||||
"reverseAPIDeviceIndex" : {
|
||||
"type" : "integer"
|
||||
},
|
||||
"reverseAPIChannelIndex" : {
|
||||
"type" : "integer"
|
||||
}
|
||||
},
|
||||
"description" : "PER Tester settings"
|
||||
};
|
||||
defs.PacketDemodSettings = {
|
||||
"properties" : {
|
||||
@ -7111,6 +7250,18 @@ margin-bottom: 20px;
|
||||
"type" : "number",
|
||||
"format" : "float"
|
||||
},
|
||||
"udpEnabled" : {
|
||||
"type" : "integer",
|
||||
"description" : "Whether to forward received packets to specified UDP port"
|
||||
},
|
||||
"udpAddress" : {
|
||||
"type" : "string",
|
||||
"description" : "UDP address to forward received packets to"
|
||||
},
|
||||
"udpPort" : {
|
||||
"type" : "integer",
|
||||
"description" : "UDP port to forward received packets to"
|
||||
},
|
||||
"rgbColor" : {
|
||||
"type" : "integer"
|
||||
},
|
||||
@ -7320,6 +7471,18 @@ margin-bottom: 20px;
|
||||
"symbolSpan" : {
|
||||
"type" : "integer"
|
||||
},
|
||||
"udpEnabled" : {
|
||||
"type" : "integer",
|
||||
"description" : "Whether to receive packets to transmit on specified UDP port"
|
||||
},
|
||||
"udpAddress" : {
|
||||
"type" : "string",
|
||||
"description" : "UDP address to receive packets to transmit via"
|
||||
},
|
||||
"udpPort" : {
|
||||
"type" : "integer",
|
||||
"description" : "UDP port to receive packets to transmit via"
|
||||
},
|
||||
"rgbColor" : {
|
||||
"type" : "integer"
|
||||
},
|
||||
@ -45779,7 +45942,7 @@ except ApiException as e:
|
||||
</div>
|
||||
<div id="generator">
|
||||
<div class="content">
|
||||
Generated 2021-04-01T20:39:21.587+02:00
|
||||
Generated 2021-04-12T14:54:42.978+02:00
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@ -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:
|
||||
|
||||
67
sdrbase/resources/webapi/doc/swagger/include/PERTester.yaml
Normal file
67
sdrbase/resources/webapi/doc/swagger/include/PERTester.yaml
Normal file
@ -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:
|
||||
|
||||
@ -3358,19 +3358,35 @@ margin-bottom: 20px;
|
||||
},
|
||||
"standard" : {
|
||||
"type" : "integer",
|
||||
"description" : "see DATVDemodSettings::dvb_version"
|
||||
"description" : "DVB bersion (see DATVDemodSettings::dvb_version)\n * 0 - DVB-S\n * 1 - DVB-S2\n"
|
||||
},
|
||||
"modulation" : {
|
||||
"type" : "integer",
|
||||
"description" : "see DATVDemodSettings::DATVModulation"
|
||||
"description" : "Modulation type (DATVDemodSettings::DATVModulation)\n * 0 - BPSK\n * 1 - QPSK\n * 2 - PSK8\n * 3 - APSK16\n * 4 - APSK32\n * 5 - APSK64E\n * 6 - QAM16\n * 7 - QAM64\n * 8 - QAM256\n"
|
||||
},
|
||||
"fec" : {
|
||||
"type" : "integer",
|
||||
"description" : "see DATVDemodSettings::DATVCodeRate"
|
||||
"description" : "FEC rate (see DATVDemodSettings::DATVCodeRate)\n * 0 - 1/2\n * 1 - 2/3\n * 2 - 4/6\n * 3 - 3/4\n * 4 - 4/6\n * 5 - 7/8\n * 6 - 4/5\n * 7 - 8/9\n * 8 - 9/10\n * 9 - 1/4\n * 10 - 1/3\n * 11 - 2/5\n * 12 - 3/5\n"
|
||||
},
|
||||
"softLDPC" : {
|
||||
"type" : "integer",
|
||||
"description" : "(boolean) engage sodt LDPC with LDPC tool sub processes (Linux only)"
|
||||
},
|
||||
"softLDPCToolPath" : {
|
||||
"type" : "string",
|
||||
"description" : "O/S path to the LDPC tool binary"
|
||||
},
|
||||
"softLDPCMaxTrials" : {
|
||||
"type" : "integer",
|
||||
"description" : "maximum number of trials in the soft LDPC algorithm (LDPC tool parameter)"
|
||||
},
|
||||
"maxBitflips" : {
|
||||
"type" : "integer",
|
||||
"description" : "maximum number of bit flips allowed in hard LDPC algorithm"
|
||||
},
|
||||
"audioMute" : {
|
||||
"type" : "integer",
|
||||
"description" : "boolean"
|
||||
"description" : "(boolean) mute audio output"
|
||||
},
|
||||
"audioDeviceName" : {
|
||||
"type" : "string"
|
||||
@ -3383,30 +3399,32 @@ margin-bottom: 20px;
|
||||
},
|
||||
"allowDrift" : {
|
||||
"type" : "integer",
|
||||
"description" : "boolean"
|
||||
"description" : "(boolean) allow a larger frequency drift (DVB-S)"
|
||||
},
|
||||
"fastLock" : {
|
||||
"type" : "integer",
|
||||
"description" : "boolean"
|
||||
"description" : "(boolean) faster locking algorithm (DVB-S)"
|
||||
},
|
||||
"filter" : {
|
||||
"type" : "integer",
|
||||
"description" : "see DATVDemodSettings::dvb_sampler"
|
||||
"description" : "Type of sumbol filtering (see DATVDemodSettings::dvb_sampler)\n * 0 - Nearest\n * 1 - Linear\n * 2 - Root Raised Cosine\n"
|
||||
},
|
||||
"hardMetric" : {
|
||||
"type" : "integer",
|
||||
"description" : "boolean"
|
||||
"description" : "(boolean) (DVB-S)"
|
||||
},
|
||||
"rollOff" : {
|
||||
"type" : "number",
|
||||
"format" : "float"
|
||||
"format" : "float",
|
||||
"description" : "RRC filter roll-off factor (0..1)"
|
||||
},
|
||||
"viterbi" : {
|
||||
"type" : "integer",
|
||||
"description" : "boolean"
|
||||
"description" : "(boolean) (DVB-S)"
|
||||
},
|
||||
"excursion" : {
|
||||
"type" : "integer"
|
||||
"type" : "integer",
|
||||
"description" : "RRC filter envelope excursion (dB)"
|
||||
},
|
||||
"audioVolume" : {
|
||||
"type" : "integer"
|
||||
@ -3424,6 +3442,26 @@ margin-bottom: 20px;
|
||||
"udpTS" : {
|
||||
"type" : "integer",
|
||||
"description" : "boolean"
|
||||
},
|
||||
"streamIndex" : {
|
||||
"type" : "integer",
|
||||
"description" : "MIMO channel. Not relevant when connected to SI (single Rx)."
|
||||
},
|
||||
"useReverseAPI" : {
|
||||
"type" : "integer",
|
||||
"description" : "Synchronize with reverse API (1 for yes, 0 for no)"
|
||||
},
|
||||
"reverseAPIAddress" : {
|
||||
"type" : "string"
|
||||
},
|
||||
"reverseAPIPort" : {
|
||||
"type" : "integer"
|
||||
},
|
||||
"reverseAPIDeviceIndex" : {
|
||||
"type" : "integer"
|
||||
},
|
||||
"reverseAPIChannelIndex" : {
|
||||
"type" : "integer"
|
||||
}
|
||||
},
|
||||
"description" : "DATVDemod"
|
||||
@ -7032,11 +7070,23 @@ margin-bottom: 20px;
|
||||
"type" : "integer"
|
||||
},
|
||||
"ctcssOn" : {
|
||||
"type" : "integer"
|
||||
"type" : "integer",
|
||||
"description" : "Enable CTCSS squelch (takes precedence on DCS) * 0 - disabled * 1 - enabled\n"
|
||||
},
|
||||
"ctcssIndex" : {
|
||||
"type" : "integer"
|
||||
},
|
||||
"dcsOn" : {
|
||||
"type" : "integer",
|
||||
"description" : "Enable DCS squelch (only if CTCSS is off) * 0 - disabled * 1 - enabled\n"
|
||||
},
|
||||
"dcsCode" : {
|
||||
"type" : "integer"
|
||||
},
|
||||
"dcsPositive" : {
|
||||
"type" : "integer",
|
||||
"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\n"
|
||||
},
|
||||
"rgbColor" : {
|
||||
"type" : "integer"
|
||||
},
|
||||
@ -45892,7 +45942,7 @@ except ApiException as e:
|
||||
</div>
|
||||
<div id="generator">
|
||||
<div class="content">
|
||||
Generated 2021-04-02T23:43:06.310+02:00
|
||||
Generated 2021-04-12T14:54:42.978+02:00
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
Loading…
Reference in New Issue
Block a user