1
0
mirror of https://github.com/f4exb/sdrangel.git synced 2026-06-06 16:05:13 -04:00

API: added missing files for on line documentation

This commit is contained in:
f4exb
2021-10-12 22:30:43 +02:00
parent 01e2ea93e1
commit d68641df0e
11 changed files with 1059 additions and 8 deletions
@@ -29,5 +29,7 @@ ChannelActions:
$ref: "/doc/swagger/include/IEEE_802_15_4_Mod.yaml#/IEEE_802_15_4_ModActions"
PacketModActions:
$ref: "/doc/swagger/include/PacketMod.yaml#/PacketModActions"
RadioAstronomyActions:
$ref: "/doc/swagger/include/RadioAstronomy.yaml#/RadioAstronomyActions"
SigMFFileSinkActions:
$ref: "/doc/swagger/include/SigMFFileSink.yaml#/SigMFFileSinkActions"
@@ -53,6 +53,8 @@ ChannelReport:
$ref: "/doc/swagger/include/NoiseFigure.yaml#/NoiseFigureReport"
SSBDemodReport:
$ref: "/doc/swagger/include/SSBDemod.yaml#/SSBDemodReport"
RadioAstronomyReport:
$ref: "/doc/swagger/include/RadioAstronomy.yaml#/RadioAstronomyReport"
RadioClockReport:
$ref: "/doc/swagger/include/RadioClock.yaml#/RadioClockReport"
RemoteSourceReport:
@@ -81,6 +81,8 @@ ChannelSettings:
$ref: "/doc/swagger/include/PacketMod.yaml#/PacketModSettings"
PagerDemodSettings:
$ref: "/doc/swagger/include/PagerDemod.yaml#/PagerDemodSettings"
RadioAstronomySettings:
$ref: "/doc/swagger/include/RadioAstronomy.yaml#/RadioAstronomySettings"
RadioClockSettings:
$ref: "/doc/swagger/include/RadioClock.yaml#/RadioClockSettings"
RemoteSinkSettings:
@@ -41,7 +41,8 @@ GS232ControllerSettings:
type: integer
tolerance:
description: Tolerance in degrees
type: integer
type: number
format: float
protocol:
description: (0 GS-232, 1 SPID rot2prog)
type: integer
@@ -74,3 +75,22 @@ GS232ControllerReport:
type: array
items:
type: string
targetAzimuth:
desription: "Target azimuth in degrees (0-450)"
type: number
format: float
targetElevation:
description: "Target elevation in degrees (0-180)"
type: number
format: float
currentAzimuth:
desription: "Current azimuth in degrees (0-450)"
type: number
format: float
currentElevation:
description: "Current elevation in degrees (0-180)"
type: number
format: float
onTarget:
description: "Indicates whether the rotator is pointing at the current target within the set tolerance"
type: integer
@@ -0,0 +1,92 @@
RadioAstronomySettings:
description: RadioAstronomy
properties:
inputFrequencyOffset:
type: integer
format: int64
sampleRate:
type: integer
rfBandwidth:
type: integer
integration:
type: integer
fftSize:
type: integer
fftWindow:
type: integer
filterFreqs:
type: string
starTracker:
type: string
rotator:
type: string
runMode:
description: "(0 for single, 1 for continuous, 2 for sweep)"
type: integer
sweepStartAtTime:
description: "(0 for now, 1 for at sweepStartDateTime)"
type: integer
sweepStartDateTime:
type: string
sweepType:
description: "(0 for Az/El, 1 for l/b, 2 for offset)"
type: integer
sweep1Start:
type: number
format: float
sweep1Stop:
type: number
format: float
sweep1Step:
type: number
format: float
sweep1Delay:
type: number
format: float
sweep2Start:
type: number
format: float
sweep2Stop:
type: number
format: float
sweep2Step:
type: number
format: float
sweep2Delay:
type: number
format: float
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
RadioAstronomyReport:
description: RadioAstronomy
properties:
channelPowerDB:
description: power received in channel (dB)
type: number
format: float
channelSampleRate:
type: integer
RadioAstronomyActions:
description: RadioAstronomy
properties:
start:
type: object
description: "Start measurement(s)"
@@ -13,7 +13,7 @@ RadioClockSettings:
type: number
format: float
modulation:
description: 0 - MSF, 1 - DCF77, 2 - TDF
description: 0 - MSF, 1 - DCF77, 2 - TDF, 3 - WWVB
type: integer
timezone:
description: 0 - Broadcast, 1 - Local, 2 - UTC
@@ -10,6 +10,30 @@ StarTrackerSettings:
dec:
description: "Declination of custom target"
type: string
azimuth:
description: "Azimuth of custom target"
type: number
format: float
elevation:
description: "Elevation of custom target"
type: number
format: float
l:
description: "Galactic longitude of custom target"
type: number
format: float
b:
description: "Galactic latitude of custom target"
type: number
format: float
azimuthOffset:
description: "Offset to add to computed azimuth of target"
type: number
format: float
elevationOffset:
description: "Offset to add to computed elevation of target"
type: number
format: float
latitude:
description: "Latitude in decimal degrees (North positive) of observation/antenna location"
type: number
@@ -85,3 +109,95 @@ StarTrackerSettings:
type: integer
reverseAPIFeatureIndex:
type: integer
StarTrackerTarget:
description: "Star Tracker target. Sent to startracker.target message queue for other plugins to use."
properties:
name:
descrption: "The name of the target"
type: string
azimuth:
descrption: "The azimuth angle in degrees to the target"
type: number
format: float
elevation:
descrption: "The elevation angle in degrees to the target"
type: number
format: float
ra:
description: "Right ascension of target"
type: number
format: float
dec:
description: "Declination of target"
type: number
format: float
b:
descrption: "Galactic latitude in degrees"
type: number
format: float
l:
descrption: "Galactic longitude in degrees"
type: number
format: float
earthRotationVelocity:
description: "Velocity towards target at observation location due to rotation of the Earth"
type: number
format: float
earthOrbitVelocityBCRS:
description: "Velocity towards target due to Earth's orbit of Sun relative to barycentric reference frame"
type: number
format: float
sunVelocityLSR:
description: "Velocity of Sun towards target relative to local standard of rest"
type: number
format: float
solarFlux:
description: "Solar flux"
type: number
format: float
airTemperature:
description: "Surface air temperature in degrees celsius at antenna location"
type: number
format: float
skyTemperature:
description: "Sky temperature (CMB+Galactic noise) in Kelvin towards the target"
type: number
format: float
hpbw:
description: "Half-power beam width in degrees"
type: number
format: float
StarTrackerDisplaySettings:
description: "Settings to display in Star Tracker. Can be sent by other plugins to startracker.display message queue."
properties:
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
azimuth:
descrption: "The azimuth angle in degrees to the target"
type: number
format: float
elevation:
descrption: "The elevation angle in degrees to the target"
type: number
format: float
StarTrackerDisplayLoSSettings:
description: "Details of object to display in Star Tracker line-of-sight view. Can be sent by other plugins to startracker.display message queue"
properties:
name:
type: string
b:
descrption: "Galactic latitude in degrees"
type: number
format: float
l:
descrption: "Galactic longitude in degrees"
type: number
format: float
d:
descrption: "Distance to object from Sun in kpc"
type: number
format: float