1
0
mirror of https://github.com/f4exb/sdrangel.git synced 2024-11-25 09:18:54 -05:00

Update missed swagger files in sdrbase/resources/webapi/doc/swagger

This commit is contained in:
Jon Beniston 2021-03-01 09:51:24 +00:00
parent 19b809affb
commit 1445ed860c
9 changed files with 576 additions and 2 deletions

View File

@ -1107,6 +1107,127 @@ margin-bottom: 20px;
}
},
"description" : "APRS settings"
};
defs.APTDemodActions = {
"properties" : {
"aos" : {
"$ref" : "#/definitions/APTDemodActions_aos"
},
"los" : {
"$ref" : "#/definitions/APTDemodActions_los"
}
},
"description" : "APTDemod"
};
defs.APTDemodActions_aos = {
"properties" : {
"satelliteName" : {
"type" : "string",
"description" : "Name of the satellite"
},
"northToSouthPass" : {
"type" : "integer",
"description" : "Satellite is passing from the North to the South (1) or South to North (0)"
}
},
"description" : "Acquisition of signal"
};
defs.APTDemodActions_los = {
"properties" : {
"satelliteName" : {
"type" : "string",
"description" : "Name of the satellite"
}
},
"description" : "Loss of signal"
};
defs.APTDemodSettings = {
"properties" : {
"inputFrequencyOffset" : {
"type" : "integer",
"format" : "int64",
"description" : "channel center frequency shift from baseband center in Hz"
},
"rfBandwidth" : {
"type" : "number",
"format" : "float",
"description" : "channel RF bandwidth in Hz"
},
"fmDeviation" : {
"type" : "integer",
"description" : "frequency deviation in Hz"
},
"cropNoise" : {
"type" : "integer",
"description" : "crop noise from top and bottom of image"
},
"denoise" : {
"type" : "integer",
"description" : "apply denoise filter to image"
},
"linearEqualise" : {
"type" : "integer",
"description" : "apply linear equalisation to image"
},
"histogramEqualise" : {
"type" : "integer",
"description" : "apply histogram equalisation to image"
},
"precipitationOverlay" : {
"type" : "integer",
"description" : "create colour overlay of precipitation"
},
"flip" : {
"type" : "integer",
"description" : "flip image for South to North passes"
},
"channels" : {
"type" : "integer",
"description" : "which channel to display (0=both, 1=A, 2=B)"
},
"decodeEnabled" : {
"type" : "integer",
"description" : "controls whether the decoder is enabled"
},
"autoSave" : {
"type" : "integer",
"description" : "automatically save images when acquisition is stopped"
},
"autoSavePath" : {
"type" : "string",
"description" : "directory to automatically save images in"
},
"autoSaveMinScanLines" : {
"type" : "integer"
},
"rgbColor" : {
"type" : "integer"
},
"title" : {
"type" : "string"
},
"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" : "APTDemod"
};
defs.ATVDemodSettings = {
"properties" : {
@ -2411,6 +2532,9 @@ margin-bottom: 20px;
"type" : "integer",
"description" : "Optional for reverse API. This is the channel index from where the message comes from."
},
"APTDemodActions" : {
"$ref" : "#/definitions/APTDemodActions"
},
"FileSinkActions" : {
"$ref" : "#/definitions/FileSinkActions"
},
@ -2659,6 +2783,9 @@ margin-bottom: 20px;
"AMModSettings" : {
"$ref" : "#/definitions/AMModSettings"
},
"APTDemodSettings" : {
"$ref" : "#/definitions/APTDemodSettings"
},
"ATVDemodSettings" : {
"$ref" : "#/definitions/ATVDemodSettings"
},
@ -4188,6 +4315,9 @@ margin-bottom: 20px;
"RigCtlServerSettings" : {
"$ref" : "#/definitions/RigCtlServerSettings"
},
"SatelliteTrackerSettings" : {
"$ref" : "#/definitions/SatelliteTrackerSettings"
},
"StarTrackerSettings" : {
"$ref" : "#/definitions/StarTrackerSettings"
},
@ -4946,6 +5076,22 @@ margin-bottom: 20px;
"type" : "integer",
"description" : "Elevation offset in degrees"
},
"azimuthMin" : {
"type" : "integer",
"description" : "Minimum azimuth the controller will output"
},
"azimuthMax" : {
"type" : "integer",
"description" : "Maximum azimuth the controller will output"
},
"elevationMin" : {
"type" : "integer",
"description" : "Minimum elevation the controller will output"
},
"elevationMax" : {
"type" : "integer",
"description" : "Maximum elevation the controller will output"
},
"title" : {
"type" : "string"
},
@ -6266,6 +6412,23 @@ margin-bottom: 20px;
}
},
"description" : "Map"
};
defs.MapCoordinate = {
"properties" : {
"latitude" : {
"type" : "number",
"format" : "float"
},
"longitude" : {
"type" : "number",
"format" : "float"
},
"altitude" : {
"type" : "number",
"format" : "float"
}
},
"description" : "A map coordinate"
};
defs.MapItem = {
"required" : [ "name" ],
@ -6303,6 +6466,20 @@ margin-bottom: 20px;
"type" : "number",
"format" : "float",
"description" : "Altitude / height above sea level in metres"
},
"track" : {
"type" : "array",
"description" : "Track/path the item has taken",
"items" : {
"$ref" : "#/definitions/MapCoordinate"
}
},
"predictedTrack" : {
"type" : "array",
"description" : "Track/path the item is predicted to take",
"items" : {
"$ref" : "#/definitions/MapCoordinate"
}
}
},
"description" : "An item to draw on the map. Set image to an empty string to remove item from the map."
@ -6343,6 +6520,20 @@ margin-bottom: 20px;
"type" : "number",
"format" : "float",
"description" : "Altitude / height above sea level in metres"
},
"track" : {
"type" : "array",
"description" : "Track/path the item has taken",
"items" : {
"$ref" : "#/definitions/MapCoordinate"
}
},
"predictedTrack" : {
"type" : "array",
"description" : "Track/path the item is predicted to take",
"items" : {
"$ref" : "#/definitions/MapCoordinate"
}
}
},
"description" : "An item to draw on the map. Set image to an empty string to remove item from the map."
@ -8360,6 +8551,152 @@ margin-bottom: 20px;
}
},
"description" : "Information about a logical device available from an attached hardware device that can be used as a sampling device"
};
defs.SatelliteTrackerSettings = {
"properties" : {
"latitude" : {
"type" : "number",
"format" : "float",
"description" : "Latitude in decimal degrees (North positive) of antenna location"
},
"longitude" : {
"type" : "number",
"format" : "float",
"description" : "Longitude in decimal degrees (East positive) of antenna location"
},
"heightAboveSeaLevel" : {
"type" : "number",
"format" : "float",
"description" : "Height above sea level in metres of antenna location"
},
"target" : {
"type" : "string",
"description" : "Target satellite"
},
"satellites" : {
"type" : "array",
"description" : "Satellites to track",
"items" : {
"type" : "string"
}
},
"tles" : {
"type" : "array",
"description" : "Two line element files",
"items" : {
"type" : "string"
}
},
"dateTime" : {
"type" : "string",
"description" : "Date and time of observation. ISO 8601 extended format: yyyy-MM-ddTHH:mm:ss with Z suffix for UTC. Empty string for current time."
},
"minAOSElevation" : {
"type" : "integer",
"description" : "Minimum elevation in degrees for AOS"
},
"minPassElevation" : {
"type" : "integer",
"description" : "Minimum elevation in degrees for a pass"
},
"rotatorMaxAzimuth" : {
"type" : "integer",
"description" : "Maximum azimuth in degrees for the rotator"
},
"rotatorMaxElevation" : {
"type" : "integer",
"description" : "Maximum elevation in degrees for elevation"
},
"azElUnits" : {
"type" : "integer",
"description" : "DMS (0) DM (1) D (2) Decimal (3)"
},
"groundTrackPoints" : {
"type" : "integer",
"description" : "Number of points used to draw ground tracks"
},
"dateFormat" : {
"type" : "string"
},
"utc" : {
"type" : "integer",
"description" : "Times are UTC (1) or local (0)"
},
"updatePeriod" : {
"type" : "number",
"format" : "float",
"description" : "Time in seconds between each calculation of the target's position"
},
"dopplerPeriod" : {
"type" : "number",
"format" : "float",
"description" : "Time in seconds between each Doppler correction"
},
"predictionPeriod" : {
"type" : "integer",
"description" : "How many days ahead to predict passes in"
},
"passStartTime" : {
"type" : "string",
"description" : "Time after which a pass must start"
},
"passFinishTime" : {
"type" : "string",
"description" : "Time before which a pass must finish"
},
"defaultFrequency" : {
"type" : "number",
"format" : "float",
"description" : "Frequency to use for Doppler and free space path loss calculations in Satellite data table"
},
"drawOnMap" : {
"type" : "integer",
"description" : "Draw satellites on the Map (1 for yes, 0 for no)"
},
"autoTarget" : {
"type" : "integer",
"description" : "Automatically select target on AOS (1 for yes, 0 for no)"
},
"aosSpeech" : {
"type" : "string",
"description" : "Speech warning on AOS"
},
"losSpeech" : {
"type" : "string",
"description" : "Speech warning on LOS"
},
"aosCommand" : {
"type" : "string",
"description" : "Command to execute on AOS for all satellites"
},
"losCommand" : {
"type" : "string",
"description" : "Command to execute on LOS for all satellites"
},
"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" : "Satellite Tracker settings"
};
defs.SigMFFileInputActions = {
"properties" : {
@ -45286,7 +45623,7 @@ except ApiException as e:
</div>
<div id="generator">
<div class="content">
Generated 2021-02-11T23:51:16.152+01:00
Generated 2021-03-01T10:47:56.898+01:00
</div>
</div>
</div>

View File

@ -0,0 +1,86 @@
APTDemodSettings:
description: APTDemod
properties:
inputFrequencyOffset:
description: channel center frequency shift from baseband center in Hz
type: integer
format: int64
rfBandwidth:
description: channel RF bandwidth in Hz
type: number
format: float
fmDeviation:
description: frequency deviation in Hz
type: integer
cropNoise:
description: crop noise from top and bottom of image
type: integer
denoise:
description: apply denoise filter to image
type: integer
linearEqualise:
description: apply linear equalisation to image
type: integer
histogramEqualise:
description: apply histogram equalisation to image
type: integer
precipitationOverlay:
description: create colour overlay of precipitation
type: integer
flip:
description: flip image for South to North passes
type: integer
channels:
description: which channel to display (0=both, 1=A, 2=B)
type: integer
decodeEnabled:
description: controls whether the decoder is enabled
type: integer
autoSave:
description: automatically save images when acquisition is stopped
type: integer
autoSavePath:
description: directory to automatically save images in
type: string
autoSaveMinScanLines:
desciption: minimum number of scanlines (after cropping) for an image to be automatically saved
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
APTDemodActions:
description: APTDemod
properties:
aos:
description: "Acquisition of signal"
type: object
properties:
satelliteName:
description: "Name of the satellite"
type: string
northToSouthPass:
description: "Satellite is passing from the North to the South (1) or South to North (0)"
type: integer
los:
description: "Loss of signal"
type: object
properties:
satelliteName:
description: "Name of the satellite"
type: string

View File

@ -17,6 +17,8 @@ ChannelActions:
originatorChannelIndex:
description: Optional for reverse API. This is the channel index from where the message comes from.
type: integer
APTDemodActions:
$ref: "/doc/swagger/include/APTDemod.yaml#/APTDemodActions"
FileSinkActions:
$ref: "/doc/swagger/include/FileSink.yaml#/FileSinkActions"
FileSourceActions:

View File

@ -23,6 +23,8 @@ ChannelSettings:
$ref: "/doc/swagger/include/AMDemod.yaml#/AMDemodSettings"
AMModSettings:
$ref: "/doc/swagger/include/AMMod.yaml#/AMModSettings"
APTDemodSettings:
$ref: "/doc/swagger/include/APTDemod.yaml#/APTDemodSettings"
ATVDemodSettings:
$ref: "/doc/swagger/include/ATVDemod.yaml#/ATVDemodSettings"
ATVModSettings:

View File

@ -25,6 +25,8 @@ FeatureSettings:
$ref: "/doc/swagger/include/Map.yaml#/MapSettings"
RigCtlServerSettings:
$ref: "/doc/swagger/include/RigCtlServer.yaml#/RigCtlServerSettings"
SatelliteTrackerSettings:
$ref: "/doc/swagger/include/SatelliteTracker.yaml#/SatelliteTrackerSettings"
StarTrackerSettings:
$ref: "/doc/swagger/include/StarTracker.yaml#/StarTrackerSettings"
SimplePTTSettings:

View File

@ -25,6 +25,18 @@ GS232ControllerSettings:
elevationOffset:
description: Elevation offset in degrees
type: integer
azimuthMin:
description: Minimum azimuth the controller will output
type: integer
azimuthMax:
description: Maximum azimuth the controller will output
type: integer
elevationMin:
description: Minimum elevation the controller will output
type: integer
elevationMax:
description: Maximum elevation the controller will output
type: integer
title:
type: string
rgbColor:

View File

@ -61,3 +61,27 @@ MapItem:
description: "Altitude / height above sea level in metres"
type: number
format: float
track:
description: "Track/path the item has taken"
type: array
items:
$ref: "/doc/swagger/include/Map.yaml#/MapCoordinate"
predictedTrack:
description: "Track/path the item is predicted to take"
type: array
items:
$ref: "/doc/swagger/include/Map.yaml#/MapCoordinate"
MapCoordinate:
description: "A map coordinate"
properties:
latitude:
type: number
format: float
longitude:
type: number
format: float
altitude:
type: number
format: float

View File

@ -0,0 +1,109 @@
SatelliteTrackerSettings:
description: "Satellite Tracker settings"
properties:
latitude:
description: "Latitude in decimal degrees (North positive) of antenna location"
type: number
format: float
longitude:
description: "Longitude in decimal degrees (East positive) of antenna location"
type: number
format: float
heightAboveSeaLevel:
description: "Height above sea level in metres of antenna location"
type: number
format: float
target:
description: "Target satellite"
type: string
satellites:
description: "Satellites to track"
type: array
items:
type: string
tles:
description: "Two line element files"
type: array
items:
type: string
dateTime:
description: "Date and time of observation. ISO 8601 extended format: yyyy-MM-ddTHH:mm:ss with Z suffix for UTC. Empty string for current time."
type: string
minAOSElevation:
description: "Minimum elevation in degrees for AOS"
type: integer
minPassElevation:
description: "Minimum elevation in degrees for a pass"
type: integer
rotatorMaxAzimuth:
description: "Maximum azimuth in degrees for the rotator"
type: integer
rotatorMaxElevation:
description: "Maximum elevation in degrees for elevation"
type: integer
azElUnits:
description: "DMS (0) DM (1) D (2) Decimal (3)"
type: integer
groundTrackPoints:
description: "Number of points used to draw ground tracks"
type: integer
dateFormat:
desciption: "Format for dates in the GUI (E.g: yy/MM/dd)"
type: string
utc:
description: "Times are UTC (1) or local (0)"
type: integer
updatePeriod:
description: "Time in seconds between each calculation of the target's position"
type: number
format: float
dopplerPeriod:
description: "Time in seconds between each Doppler correction"
type: number
format: float
predictionPeriod:
description: "How many days ahead to predict passes in"
type: integer
passStartTime:
description: "Time after which a pass must start"
type: string
passFinishTime:
description: "Time before which a pass must finish"
type: string
defaultFrequency:
description: "Frequency to use for Doppler and free space path loss calculations in Satellite data table"
type: number
format: float
drawOnMap:
description: "Draw satellites on the Map (1 for yes, 0 for no)"
type: integer
autoTarget:
description: "Automatically select target on AOS (1 for yes, 0 for no)"
type: integer
aosSpeech:
description: "Speech warning on AOS"
type: string
losSpeech:
description: "Speech warning on LOS"
type: string
aosCommand:
description: "Command to execute on AOS for all satellites"
type: string
losCommand:
description: "Command to execute on LOS for all satellites"
type: string
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

View File

@ -45623,7 +45623,7 @@ except ApiException as e:
</div>
<div id="generator">
<div class="content">
Generated 2021-02-26T21:05:20.434+01:00
Generated 2021-03-01T10:47:56.898+01:00
</div>
</div>
</div>