1
0
mirror of https://github.com/f4exb/sdrangel.git synced 2024-11-25 01:18:38 -05: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

View File

@ -77,6 +77,7 @@
<file>webapi/doc/swagger/include/PlutoSdr.yaml</file> <file>webapi/doc/swagger/include/PlutoSdr.yaml</file>
<file>webapi/doc/swagger/include/Preferences.yaml</file> <file>webapi/doc/swagger/include/Preferences.yaml</file>
<file>webapi/doc/swagger/include/Preset.yaml</file> <file>webapi/doc/swagger/include/Preset.yaml</file>
<file>webapi/doc/swagger/include/RadioAstronomy.yaml</file>
<file>webapi/doc/swagger/include/RtlSdr.yaml</file> <file>webapi/doc/swagger/include/RtlSdr.yaml</file>
<file>webapi/doc/swagger/include/RadioClock.yaml</file> <file>webapi/doc/swagger/include/RadioClock.yaml</file>
<file>webapi/doc/swagger/include/RemoteSink.yaml</file> <file>webapi/doc/swagger/include/RemoteSink.yaml</file>

View File

@ -2870,6 +2870,9 @@ margin-bottom: 20px;
"PacketModActions" : { "PacketModActions" : {
"$ref" : "#/definitions/PacketModActions" "$ref" : "#/definitions/PacketModActions"
}, },
"RadioAstronomyActions" : {
"$ref" : "#/definitions/RadioAstronomyActions"
},
"SigMFFileSinkActions" : { "SigMFFileSinkActions" : {
"$ref" : "#/definitions/SigMFFileSinkActions" "$ref" : "#/definitions/SigMFFileSinkActions"
} }
@ -3072,6 +3075,9 @@ margin-bottom: 20px;
"SSBDemodReport" : { "SSBDemodReport" : {
"$ref" : "#/definitions/SSBDemodReport" "$ref" : "#/definitions/SSBDemodReport"
}, },
"RadioAstronomyReport" : {
"$ref" : "#/definitions/RadioAstronomyReport"
},
"RadioClockReport" : { "RadioClockReport" : {
"$ref" : "#/definitions/RadioClockReport" "$ref" : "#/definitions/RadioClockReport"
}, },
@ -3227,6 +3233,9 @@ margin-bottom: 20px;
"PagerDemodSettings" : { "PagerDemodSettings" : {
"$ref" : "#/definitions/PagerDemodSettings" "$ref" : "#/definitions/PagerDemodSettings"
}, },
"RadioAstronomySettings" : {
"$ref" : "#/definitions/RadioAstronomySettings"
},
"RadioClockSettings" : { "RadioClockSettings" : {
"$ref" : "#/definitions/RadioClockSettings" "$ref" : "#/definitions/RadioClockSettings"
}, },
@ -5787,6 +5796,28 @@ margin-bottom: 20px;
"items" : { "items" : {
"type" : "string" "type" : "string"
} }
},
"targetAzimuth" : {
"type" : "number",
"format" : "float"
},
"targetElevation" : {
"type" : "number",
"format" : "float",
"description" : "Target elevation in degrees (0-180)"
},
"currentAzimuth" : {
"type" : "number",
"format" : "float"
},
"currentElevation" : {
"type" : "number",
"format" : "float",
"description" : "Current elevation in degrees (0-180)"
},
"onTarget" : {
"type" : "integer",
"description" : "Indicates whether the rotator is pointing at the current target within the set tolerance"
} }
}, },
"description" : "GS-232 Controller report" "description" : "GS-232 Controller report"
@ -5844,7 +5875,8 @@ margin-bottom: 20px;
"description" : "Maximum elevation the controller will output" "description" : "Maximum elevation the controller will output"
}, },
"tolerance" : { "tolerance" : {
"type" : "integer", "type" : "number",
"format" : "float",
"description" : "Tolerance in degrees" "description" : "Tolerance in degrees"
}, },
"protocol" : { "protocol" : {
@ -9006,6 +9038,135 @@ margin-bottom: 20px;
"format" : "float" "format" : "float"
} }
} }
};
defs.RadioAstronomyActions = {
"properties" : {
"start" : {
"type" : "object",
"description" : "Start measurement(s)",
"properties" : { }
}
},
"description" : "RadioAstronomy"
};
defs.RadioAstronomyReport = {
"properties" : {
"channelPowerDB" : {
"type" : "number",
"format" : "float",
"description" : "power received in channel (dB)"
},
"channelSampleRate" : {
"type" : "integer"
}
},
"description" : "RadioAstronomy"
};
defs.RadioAstronomySettings = {
"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" : {
"type" : "integer",
"description" : "(0 for single, 1 for continuous, 2 for sweep)"
},
"sweepStartAtTime" : {
"type" : "integer",
"description" : "(0 for now, 1 for at sweepStartDateTime)"
},
"sweepStartDateTime" : {
"type" : "string"
},
"sweepType" : {
"type" : "integer",
"description" : "(0 for Az/El, 1 for l/b, 2 for offset)"
},
"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" : {
"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" : "RadioAstronomy"
}; };
defs.RadioClockReport = { defs.RadioClockReport = {
"properties" : { "properties" : {
@ -9044,7 +9205,7 @@ margin-bottom: 20px;
}, },
"modulation" : { "modulation" : {
"type" : "integer", "type" : "integer",
"description" : "0 - MSF, 1 - DCF77, 2 - TDF" "description" : "0 - MSF, 1 - DCF77, 2 - TDF, 3 - WWVB"
}, },
"timezone" : { "timezone" : {
"type" : "integer", "type" : "integer",
@ -10847,6 +11008,80 @@ margin-bottom: 20px;
"type" : "integer" "type" : "integer"
} }
} }
};
defs.StarTrackerDisplayLoSSettings = {
"properties" : {
"name" : {
"type" : "string"
},
"b" : {
"type" : "number",
"format" : "float"
},
"l" : {
"type" : "number",
"format" : "float"
},
"d" : {
"type" : "number",
"format" : "float"
}
},
"description" : "Details of object to display in Star Tracker line-of-sight view. Can be sent by other plugins to startracker.display message queue"
};
defs.StarTrackerDisplayLoSSettings_2 = {
"properties" : {
"name" : {
"type" : "string"
},
"b" : {
"type" : "number",
"format" : "float"
},
"l" : {
"type" : "number",
"format" : "float"
},
"d" : {
"type" : "number",
"format" : "float"
}
},
"description" : "Details of object to display in Star Tracker line-of-sight view. Can be sent by other plugins to startracker.display message queue"
};
defs.StarTrackerDisplaySettings = {
"properties" : {
"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."
},
"azimuth" : {
"type" : "number",
"format" : "float"
},
"elevation" : {
"type" : "number",
"format" : "float"
}
},
"description" : "Settings to display in Star Tracker. Can be sent by other plugins to startracker.display message queue."
};
defs.StarTrackerDisplaySettings_2 = {
"properties" : {
"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."
},
"azimuth" : {
"type" : "number",
"format" : "float"
},
"elevation" : {
"type" : "number",
"format" : "float"
}
},
"description" : "Settings to display in Star Tracker. Can be sent by other plugins to startracker.display message queue."
}; };
defs.StarTrackerSettings = { defs.StarTrackerSettings = {
"properties" : { "properties" : {
@ -10862,6 +11097,36 @@ margin-bottom: 20px;
"type" : "string", "type" : "string",
"description" : "Declination of custom target" "description" : "Declination of custom target"
}, },
"azimuth" : {
"type" : "number",
"format" : "float",
"description" : "Azimuth of custom target"
},
"elevation" : {
"type" : "number",
"format" : "float",
"description" : "Elevation of custom target"
},
"l" : {
"type" : "number",
"format" : "float",
"description" : "Galactic longitude of custom target"
},
"b" : {
"type" : "number",
"format" : "float",
"description" : "Galactic latitude of custom target"
},
"azimuthOffset" : {
"type" : "number",
"format" : "float",
"description" : "Offset to add to computed azimuth of target"
},
"elevationOffset" : {
"type" : "number",
"format" : "float",
"description" : "Offset to add to computed elevation of target"
},
"latitude" : { "latitude" : {
"type" : "number", "type" : "number",
"format" : "float", "format" : "float",
@ -10962,6 +11227,144 @@ margin-bottom: 20px;
} }
}, },
"description" : "Star Tracker settings" "description" : "Star Tracker settings"
};
defs.StarTrackerTarget = {
"properties" : {
"name" : {
"type" : "string"
},
"azimuth" : {
"type" : "number",
"format" : "float"
},
"elevation" : {
"type" : "number",
"format" : "float"
},
"ra" : {
"type" : "number",
"format" : "float",
"description" : "Right ascension of target"
},
"dec" : {
"type" : "number",
"format" : "float",
"description" : "Declination of target"
},
"b" : {
"type" : "number",
"format" : "float"
},
"l" : {
"type" : "number",
"format" : "float"
},
"earthRotationVelocity" : {
"type" : "number",
"format" : "float",
"description" : "Velocity towards target at observation location due to rotation of the Earth"
},
"earthOrbitVelocityBCRS" : {
"type" : "number",
"format" : "float",
"description" : "Velocity towards target due to Earth's orbit of Sun relative to barycentric reference frame"
},
"sunVelocityLSR" : {
"type" : "number",
"format" : "float",
"description" : "Velocity of Sun towards target relative to local standard of rest"
},
"solarFlux" : {
"type" : "number",
"format" : "float",
"description" : "Solar flux"
},
"airTemperature" : {
"type" : "number",
"format" : "float",
"description" : "Surface air temperature in degrees celsius at antenna location"
},
"skyTemperature" : {
"type" : "number",
"format" : "float",
"description" : "Sky temperature (CMB+Galactic noise) in Kelvin towards the target"
},
"hpbw" : {
"type" : "number",
"format" : "float",
"description" : "Half-power beam width in degrees"
}
},
"description" : "Star Tracker target. Sent to startracker.target message queue for other plugins to use."
};
defs.StarTrackerTarget_2 = {
"properties" : {
"name" : {
"type" : "string"
},
"azimuth" : {
"type" : "number",
"format" : "float"
},
"elevation" : {
"type" : "number",
"format" : "float"
},
"ra" : {
"type" : "number",
"format" : "float",
"description" : "Right ascension of target"
},
"dec" : {
"type" : "number",
"format" : "float",
"description" : "Declination of target"
},
"b" : {
"type" : "number",
"format" : "float"
},
"l" : {
"type" : "number",
"format" : "float"
},
"earthRotationVelocity" : {
"type" : "number",
"format" : "float",
"description" : "Velocity towards target at observation location due to rotation of the Earth"
},
"earthOrbitVelocityBCRS" : {
"type" : "number",
"format" : "float",
"description" : "Velocity towards target due to Earth's orbit of Sun relative to barycentric reference frame"
},
"sunVelocityLSR" : {
"type" : "number",
"format" : "float",
"description" : "Velocity of Sun towards target relative to local standard of rest"
},
"solarFlux" : {
"type" : "number",
"format" : "float",
"description" : "Solar flux"
},
"airTemperature" : {
"type" : "number",
"format" : "float",
"description" : "Surface air temperature in degrees celsius at antenna location"
},
"skyTemperature" : {
"type" : "number",
"format" : "float",
"description" : "Sky temperature (CMB+Galactic noise) in Kelvin towards the target"
},
"hpbw" : {
"type" : "number",
"format" : "float",
"description" : "Half-power beam width in degrees"
}
},
"description" : "Star Tracker target. Sent to startracker.target message queue for other plugins to use."
}; };
defs.SuccessResponse = { defs.SuccessResponse = {
"required" : [ "message" ], "required" : [ "message" ],
@ -50602,7 +51005,7 @@ except ApiException as e:
</div> </div>
<div id="generator"> <div id="generator">
<div class="content"> <div class="content">
Generated 2021-10-04T00:59:39.001+02:00 Generated 2021-10-12T21:36:57.091+02:00
</div> </div>
</div> </div>
</div> </div>

View File

@ -29,5 +29,7 @@ ChannelActions:
$ref: "/doc/swagger/include/IEEE_802_15_4_Mod.yaml#/IEEE_802_15_4_ModActions" $ref: "/doc/swagger/include/IEEE_802_15_4_Mod.yaml#/IEEE_802_15_4_ModActions"
PacketModActions: PacketModActions:
$ref: "/doc/swagger/include/PacketMod.yaml#/PacketModActions" $ref: "/doc/swagger/include/PacketMod.yaml#/PacketModActions"
RadioAstronomyActions:
$ref: "/doc/swagger/include/RadioAstronomy.yaml#/RadioAstronomyActions"
SigMFFileSinkActions: SigMFFileSinkActions:
$ref: "/doc/swagger/include/SigMFFileSink.yaml#/SigMFFileSinkActions" $ref: "/doc/swagger/include/SigMFFileSink.yaml#/SigMFFileSinkActions"

View File

@ -53,6 +53,8 @@ ChannelReport:
$ref: "/doc/swagger/include/NoiseFigure.yaml#/NoiseFigureReport" $ref: "/doc/swagger/include/NoiseFigure.yaml#/NoiseFigureReport"
SSBDemodReport: SSBDemodReport:
$ref: "/doc/swagger/include/SSBDemod.yaml#/SSBDemodReport" $ref: "/doc/swagger/include/SSBDemod.yaml#/SSBDemodReport"
RadioAstronomyReport:
$ref: "/doc/swagger/include/RadioAstronomy.yaml#/RadioAstronomyReport"
RadioClockReport: RadioClockReport:
$ref: "/doc/swagger/include/RadioClock.yaml#/RadioClockReport" $ref: "/doc/swagger/include/RadioClock.yaml#/RadioClockReport"
RemoteSourceReport: RemoteSourceReport:

View File

@ -81,6 +81,8 @@ ChannelSettings:
$ref: "/doc/swagger/include/PacketMod.yaml#/PacketModSettings" $ref: "/doc/swagger/include/PacketMod.yaml#/PacketModSettings"
PagerDemodSettings: PagerDemodSettings:
$ref: "/doc/swagger/include/PagerDemod.yaml#/PagerDemodSettings" $ref: "/doc/swagger/include/PagerDemod.yaml#/PagerDemodSettings"
RadioAstronomySettings:
$ref: "/doc/swagger/include/RadioAstronomy.yaml#/RadioAstronomySettings"
RadioClockSettings: RadioClockSettings:
$ref: "/doc/swagger/include/RadioClock.yaml#/RadioClockSettings" $ref: "/doc/swagger/include/RadioClock.yaml#/RadioClockSettings"
RemoteSinkSettings: RemoteSinkSettings:

View File

@ -41,7 +41,8 @@ GS232ControllerSettings:
type: integer type: integer
tolerance: tolerance:
description: Tolerance in degrees description: Tolerance in degrees
type: integer type: number
format: float
protocol: protocol:
description: (0 GS-232, 1 SPID rot2prog) description: (0 GS-232, 1 SPID rot2prog)
type: integer type: integer
@ -74,3 +75,22 @@ GS232ControllerReport:
type: array type: array
items: items:
type: string 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

View File

@ -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)"

View File

@ -13,7 +13,7 @@ RadioClockSettings:
type: number type: number
format: float format: float
modulation: modulation:
description: 0 - MSF, 1 - DCF77, 2 - TDF description: 0 - MSF, 1 - DCF77, 2 - TDF, 3 - WWVB
type: integer type: integer
timezone: timezone:
description: 0 - Broadcast, 1 - Local, 2 - UTC description: 0 - Broadcast, 1 - Local, 2 - UTC

View File

@ -10,6 +10,30 @@ StarTrackerSettings:
dec: dec:
description: "Declination of custom target" description: "Declination of custom target"
type: string 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: latitude:
description: "Latitude in decimal degrees (North positive) of observation/antenna location" description: "Latitude in decimal degrees (North positive) of observation/antenna location"
type: number type: number
@ -85,3 +109,95 @@ StarTrackerSettings:
type: integer type: integer
reverseAPIFeatureIndex: reverseAPIFeatureIndex:
type: integer 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

View File

@ -3079,6 +3079,16 @@ definitions:
MapItem: MapItem:
$ref: "/doc/swagger/include/Map.yaml#/MapItem" $ref: "/doc/swagger/include/Map.yaml#/MapItem"
# StarTracker settings passed to/from Radio Astronomy plugin
StarTrackerTarget:
$ref: "/doc/swagger/include/StarTracker.yaml#/StarTrackerTarget"
StarTrackerDisplaySettings:
$ref: "/doc/swagger/include/StarTracker.yaml#/StarTrackerDisplaySettings"
StarTrackerDisplayLoSSettings:
$ref: "/doc/swagger/include/StarTracker.yaml#/StarTrackerDisplayLoSSettings"
# This isn't in GS232Controller, as it may eventually be used by other controllers or features # This isn't in GS232Controller, as it may eventually be used by other controllers or features
TargetAzimuthElevation: TargetAzimuthElevation:
description: "A target azimuth and elevation" description: "A target azimuth and elevation"

View File

@ -2870,6 +2870,9 @@ margin-bottom: 20px;
"PacketModActions" : { "PacketModActions" : {
"$ref" : "#/definitions/PacketModActions" "$ref" : "#/definitions/PacketModActions"
}, },
"RadioAstronomyActions" : {
"$ref" : "#/definitions/RadioAstronomyActions"
},
"SigMFFileSinkActions" : { "SigMFFileSinkActions" : {
"$ref" : "#/definitions/SigMFFileSinkActions" "$ref" : "#/definitions/SigMFFileSinkActions"
} }
@ -3072,6 +3075,9 @@ margin-bottom: 20px;
"SSBDemodReport" : { "SSBDemodReport" : {
"$ref" : "#/definitions/SSBDemodReport" "$ref" : "#/definitions/SSBDemodReport"
}, },
"RadioAstronomyReport" : {
"$ref" : "#/definitions/RadioAstronomyReport"
},
"RadioClockReport" : { "RadioClockReport" : {
"$ref" : "#/definitions/RadioClockReport" "$ref" : "#/definitions/RadioClockReport"
}, },
@ -3227,6 +3233,9 @@ margin-bottom: 20px;
"PagerDemodSettings" : { "PagerDemodSettings" : {
"$ref" : "#/definitions/PagerDemodSettings" "$ref" : "#/definitions/PagerDemodSettings"
}, },
"RadioAstronomySettings" : {
"$ref" : "#/definitions/RadioAstronomySettings"
},
"RadioClockSettings" : { "RadioClockSettings" : {
"$ref" : "#/definitions/RadioClockSettings" "$ref" : "#/definitions/RadioClockSettings"
}, },
@ -5787,6 +5796,28 @@ margin-bottom: 20px;
"items" : { "items" : {
"type" : "string" "type" : "string"
} }
},
"targetAzimuth" : {
"type" : "number",
"format" : "float"
},
"targetElevation" : {
"type" : "number",
"format" : "float",
"description" : "Target elevation in degrees (0-180)"
},
"currentAzimuth" : {
"type" : "number",
"format" : "float"
},
"currentElevation" : {
"type" : "number",
"format" : "float",
"description" : "Current elevation in degrees (0-180)"
},
"onTarget" : {
"type" : "integer",
"description" : "Indicates whether the rotator is pointing at the current target within the set tolerance"
} }
}, },
"description" : "GS-232 Controller report" "description" : "GS-232 Controller report"
@ -5844,7 +5875,8 @@ margin-bottom: 20px;
"description" : "Maximum elevation the controller will output" "description" : "Maximum elevation the controller will output"
}, },
"tolerance" : { "tolerance" : {
"type" : "integer", "type" : "number",
"format" : "float",
"description" : "Tolerance in degrees" "description" : "Tolerance in degrees"
}, },
"protocol" : { "protocol" : {
@ -9006,6 +9038,135 @@ margin-bottom: 20px;
"format" : "float" "format" : "float"
} }
} }
};
defs.RadioAstronomyActions = {
"properties" : {
"start" : {
"type" : "object",
"description" : "Start measurement(s)",
"properties" : { }
}
},
"description" : "RadioAstronomy"
};
defs.RadioAstronomyReport = {
"properties" : {
"channelPowerDB" : {
"type" : "number",
"format" : "float",
"description" : "power received in channel (dB)"
},
"channelSampleRate" : {
"type" : "integer"
}
},
"description" : "RadioAstronomy"
};
defs.RadioAstronomySettings = {
"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" : {
"type" : "integer",
"description" : "(0 for single, 1 for continuous, 2 for sweep)"
},
"sweepStartAtTime" : {
"type" : "integer",
"description" : "(0 for now, 1 for at sweepStartDateTime)"
},
"sweepStartDateTime" : {
"type" : "string"
},
"sweepType" : {
"type" : "integer",
"description" : "(0 for Az/El, 1 for l/b, 2 for offset)"
},
"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" : {
"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" : "RadioAstronomy"
}; };
defs.RadioClockReport = { defs.RadioClockReport = {
"properties" : { "properties" : {
@ -9044,7 +9205,7 @@ margin-bottom: 20px;
}, },
"modulation" : { "modulation" : {
"type" : "integer", "type" : "integer",
"description" : "0 - MSF, 1 - DCF77, 2 - TDF" "description" : "0 - MSF, 1 - DCF77, 2 - TDF, 3 - WWVB"
}, },
"timezone" : { "timezone" : {
"type" : "integer", "type" : "integer",
@ -10847,6 +11008,80 @@ margin-bottom: 20px;
"type" : "integer" "type" : "integer"
} }
} }
};
defs.StarTrackerDisplayLoSSettings = {
"properties" : {
"name" : {
"type" : "string"
},
"b" : {
"type" : "number",
"format" : "float"
},
"l" : {
"type" : "number",
"format" : "float"
},
"d" : {
"type" : "number",
"format" : "float"
}
},
"description" : "Details of object to display in Star Tracker line-of-sight view. Can be sent by other plugins to startracker.display message queue"
};
defs.StarTrackerDisplayLoSSettings_2 = {
"properties" : {
"name" : {
"type" : "string"
},
"b" : {
"type" : "number",
"format" : "float"
},
"l" : {
"type" : "number",
"format" : "float"
},
"d" : {
"type" : "number",
"format" : "float"
}
},
"description" : "Details of object to display in Star Tracker line-of-sight view. Can be sent by other plugins to startracker.display message queue"
};
defs.StarTrackerDisplaySettings = {
"properties" : {
"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."
},
"azimuth" : {
"type" : "number",
"format" : "float"
},
"elevation" : {
"type" : "number",
"format" : "float"
}
},
"description" : "Settings to display in Star Tracker. Can be sent by other plugins to startracker.display message queue."
};
defs.StarTrackerDisplaySettings_2 = {
"properties" : {
"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."
},
"azimuth" : {
"type" : "number",
"format" : "float"
},
"elevation" : {
"type" : "number",
"format" : "float"
}
},
"description" : "Settings to display in Star Tracker. Can be sent by other plugins to startracker.display message queue."
}; };
defs.StarTrackerSettings = { defs.StarTrackerSettings = {
"properties" : { "properties" : {
@ -10862,6 +11097,36 @@ margin-bottom: 20px;
"type" : "string", "type" : "string",
"description" : "Declination of custom target" "description" : "Declination of custom target"
}, },
"azimuth" : {
"type" : "number",
"format" : "float",
"description" : "Azimuth of custom target"
},
"elevation" : {
"type" : "number",
"format" : "float",
"description" : "Elevation of custom target"
},
"l" : {
"type" : "number",
"format" : "float",
"description" : "Galactic longitude of custom target"
},
"b" : {
"type" : "number",
"format" : "float",
"description" : "Galactic latitude of custom target"
},
"azimuthOffset" : {
"type" : "number",
"format" : "float",
"description" : "Offset to add to computed azimuth of target"
},
"elevationOffset" : {
"type" : "number",
"format" : "float",
"description" : "Offset to add to computed elevation of target"
},
"latitude" : { "latitude" : {
"type" : "number", "type" : "number",
"format" : "float", "format" : "float",
@ -10962,6 +11227,144 @@ margin-bottom: 20px;
} }
}, },
"description" : "Star Tracker settings" "description" : "Star Tracker settings"
};
defs.StarTrackerTarget = {
"properties" : {
"name" : {
"type" : "string"
},
"azimuth" : {
"type" : "number",
"format" : "float"
},
"elevation" : {
"type" : "number",
"format" : "float"
},
"ra" : {
"type" : "number",
"format" : "float",
"description" : "Right ascension of target"
},
"dec" : {
"type" : "number",
"format" : "float",
"description" : "Declination of target"
},
"b" : {
"type" : "number",
"format" : "float"
},
"l" : {
"type" : "number",
"format" : "float"
},
"earthRotationVelocity" : {
"type" : "number",
"format" : "float",
"description" : "Velocity towards target at observation location due to rotation of the Earth"
},
"earthOrbitVelocityBCRS" : {
"type" : "number",
"format" : "float",
"description" : "Velocity towards target due to Earth's orbit of Sun relative to barycentric reference frame"
},
"sunVelocityLSR" : {
"type" : "number",
"format" : "float",
"description" : "Velocity of Sun towards target relative to local standard of rest"
},
"solarFlux" : {
"type" : "number",
"format" : "float",
"description" : "Solar flux"
},
"airTemperature" : {
"type" : "number",
"format" : "float",
"description" : "Surface air temperature in degrees celsius at antenna location"
},
"skyTemperature" : {
"type" : "number",
"format" : "float",
"description" : "Sky temperature (CMB+Galactic noise) in Kelvin towards the target"
},
"hpbw" : {
"type" : "number",
"format" : "float",
"description" : "Half-power beam width in degrees"
}
},
"description" : "Star Tracker target. Sent to startracker.target message queue for other plugins to use."
};
defs.StarTrackerTarget_2 = {
"properties" : {
"name" : {
"type" : "string"
},
"azimuth" : {
"type" : "number",
"format" : "float"
},
"elevation" : {
"type" : "number",
"format" : "float"
},
"ra" : {
"type" : "number",
"format" : "float",
"description" : "Right ascension of target"
},
"dec" : {
"type" : "number",
"format" : "float",
"description" : "Declination of target"
},
"b" : {
"type" : "number",
"format" : "float"
},
"l" : {
"type" : "number",
"format" : "float"
},
"earthRotationVelocity" : {
"type" : "number",
"format" : "float",
"description" : "Velocity towards target at observation location due to rotation of the Earth"
},
"earthOrbitVelocityBCRS" : {
"type" : "number",
"format" : "float",
"description" : "Velocity towards target due to Earth's orbit of Sun relative to barycentric reference frame"
},
"sunVelocityLSR" : {
"type" : "number",
"format" : "float",
"description" : "Velocity of Sun towards target relative to local standard of rest"
},
"solarFlux" : {
"type" : "number",
"format" : "float",
"description" : "Solar flux"
},
"airTemperature" : {
"type" : "number",
"format" : "float",
"description" : "Surface air temperature in degrees celsius at antenna location"
},
"skyTemperature" : {
"type" : "number",
"format" : "float",
"description" : "Sky temperature (CMB+Galactic noise) in Kelvin towards the target"
},
"hpbw" : {
"type" : "number",
"format" : "float",
"description" : "Half-power beam width in degrees"
}
},
"description" : "Star Tracker target. Sent to startracker.target message queue for other plugins to use."
}; };
defs.SuccessResponse = { defs.SuccessResponse = {
"required" : [ "message" ], "required" : [ "message" ],
@ -50602,7 +51005,7 @@ except ApiException as e:
</div> </div>
<div id="generator"> <div id="generator">
<div class="content"> <div class="content">
Generated 2021-10-04T00:59:39.001+02:00 Generated 2021-10-12T21:36:57.091+02:00
</div> </div>
</div> </div>
</div> </div>