From d68641df0ee397d208c211464b03df26fd3cd771 Mon Sep 17 00:00:00 2001 From: f4exb Date: Tue, 12 Oct 2021 22:30:43 +0200 Subject: [PATCH] API: added missing files for on line documentation --- sdrbase/resources/webapi.qrc | 1 + sdrbase/resources/webapi/doc/html2/index.html | 409 +++++++++++++++++- .../doc/swagger/include/ChannelActions.yaml | 2 + .../doc/swagger/include/ChannelReport.yaml | 2 + .../doc/swagger/include/ChannelSettings.yaml | 2 + .../doc/swagger/include/GS232Controller.yaml | 22 +- .../doc/swagger/include/RadioAstronomy.yaml | 92 ++++ .../doc/swagger/include/RadioClock.yaml | 2 +- .../doc/swagger/include/StarTracker.yaml | 116 +++++ .../resources/webapi/doc/swagger/swagger.yaml | 10 + swagger/sdrangel/code/html2/index.html | 409 +++++++++++++++++- 11 files changed, 1059 insertions(+), 8 deletions(-) create mode 100644 sdrbase/resources/webapi/doc/swagger/include/RadioAstronomy.yaml diff --git a/sdrbase/resources/webapi.qrc b/sdrbase/resources/webapi.qrc index 65a81c6f0..e7eb68f21 100644 --- a/sdrbase/resources/webapi.qrc +++ b/sdrbase/resources/webapi.qrc @@ -77,6 +77,7 @@ webapi/doc/swagger/include/PlutoSdr.yaml webapi/doc/swagger/include/Preferences.yaml webapi/doc/swagger/include/Preset.yaml + webapi/doc/swagger/include/RadioAstronomy.yaml webapi/doc/swagger/include/RtlSdr.yaml webapi/doc/swagger/include/RadioClock.yaml webapi/doc/swagger/include/RemoteSink.yaml diff --git a/sdrbase/resources/webapi/doc/html2/index.html b/sdrbase/resources/webapi/doc/html2/index.html index 42c62ff59..c1bac6e96 100644 --- a/sdrbase/resources/webapi/doc/html2/index.html +++ b/sdrbase/resources/webapi/doc/html2/index.html @@ -2870,6 +2870,9 @@ margin-bottom: 20px; "PacketModActions" : { "$ref" : "#/definitions/PacketModActions" }, + "RadioAstronomyActions" : { + "$ref" : "#/definitions/RadioAstronomyActions" + }, "SigMFFileSinkActions" : { "$ref" : "#/definitions/SigMFFileSinkActions" } @@ -3072,6 +3075,9 @@ margin-bottom: 20px; "SSBDemodReport" : { "$ref" : "#/definitions/SSBDemodReport" }, + "RadioAstronomyReport" : { + "$ref" : "#/definitions/RadioAstronomyReport" + }, "RadioClockReport" : { "$ref" : "#/definitions/RadioClockReport" }, @@ -3227,6 +3233,9 @@ margin-bottom: 20px; "PagerDemodSettings" : { "$ref" : "#/definitions/PagerDemodSettings" }, + "RadioAstronomySettings" : { + "$ref" : "#/definitions/RadioAstronomySettings" + }, "RadioClockSettings" : { "$ref" : "#/definitions/RadioClockSettings" }, @@ -5787,6 +5796,28 @@ margin-bottom: 20px; "items" : { "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" @@ -5844,7 +5875,8 @@ margin-bottom: 20px; "description" : "Maximum elevation the controller will output" }, "tolerance" : { - "type" : "integer", + "type" : "number", + "format" : "float", "description" : "Tolerance in degrees" }, "protocol" : { @@ -9006,6 +9038,135 @@ margin-bottom: 20px; "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 = { "properties" : { @@ -9044,7 +9205,7 @@ margin-bottom: 20px; }, "modulation" : { "type" : "integer", - "description" : "0 - MSF, 1 - DCF77, 2 - TDF" + "description" : "0 - MSF, 1 - DCF77, 2 - TDF, 3 - WWVB" }, "timezone" : { "type" : "integer", @@ -10847,6 +11008,80 @@ margin-bottom: 20px; "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 = { "properties" : { @@ -10862,6 +11097,36 @@ margin-bottom: 20px; "type" : "string", "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" : { "type" : "number", "format" : "float", @@ -10962,6 +11227,144 @@ margin-bottom: 20px; } }, "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 = { "required" : [ "message" ], @@ -50602,7 +51005,7 @@ except ApiException as e:
- Generated 2021-10-04T00:59:39.001+02:00 + Generated 2021-10-12T21:36:57.091+02:00
diff --git a/sdrbase/resources/webapi/doc/swagger/include/ChannelActions.yaml b/sdrbase/resources/webapi/doc/swagger/include/ChannelActions.yaml index bf5fe4fe5..7174a4e6e 100644 --- a/sdrbase/resources/webapi/doc/swagger/include/ChannelActions.yaml +++ b/sdrbase/resources/webapi/doc/swagger/include/ChannelActions.yaml @@ -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" diff --git a/sdrbase/resources/webapi/doc/swagger/include/ChannelReport.yaml b/sdrbase/resources/webapi/doc/swagger/include/ChannelReport.yaml index c224609ac..e7c53810c 100644 --- a/sdrbase/resources/webapi/doc/swagger/include/ChannelReport.yaml +++ b/sdrbase/resources/webapi/doc/swagger/include/ChannelReport.yaml @@ -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: diff --git a/sdrbase/resources/webapi/doc/swagger/include/ChannelSettings.yaml b/sdrbase/resources/webapi/doc/swagger/include/ChannelSettings.yaml index 7550dbda5..d7794fe69 100644 --- a/sdrbase/resources/webapi/doc/swagger/include/ChannelSettings.yaml +++ b/sdrbase/resources/webapi/doc/swagger/include/ChannelSettings.yaml @@ -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: diff --git a/sdrbase/resources/webapi/doc/swagger/include/GS232Controller.yaml b/sdrbase/resources/webapi/doc/swagger/include/GS232Controller.yaml index 7ac79be42..36b4659a8 100644 --- a/sdrbase/resources/webapi/doc/swagger/include/GS232Controller.yaml +++ b/sdrbase/resources/webapi/doc/swagger/include/GS232Controller.yaml @@ -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 diff --git a/sdrbase/resources/webapi/doc/swagger/include/RadioAstronomy.yaml b/sdrbase/resources/webapi/doc/swagger/include/RadioAstronomy.yaml new file mode 100644 index 000000000..4362bc140 --- /dev/null +++ b/sdrbase/resources/webapi/doc/swagger/include/RadioAstronomy.yaml @@ -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)" diff --git a/sdrbase/resources/webapi/doc/swagger/include/RadioClock.yaml b/sdrbase/resources/webapi/doc/swagger/include/RadioClock.yaml index 3bb5e9618..c7dcc78ec 100644 --- a/sdrbase/resources/webapi/doc/swagger/include/RadioClock.yaml +++ b/sdrbase/resources/webapi/doc/swagger/include/RadioClock.yaml @@ -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 diff --git a/sdrbase/resources/webapi/doc/swagger/include/StarTracker.yaml b/sdrbase/resources/webapi/doc/swagger/include/StarTracker.yaml index 7c11f60f6..1646aa65d 100644 --- a/sdrbase/resources/webapi/doc/swagger/include/StarTracker.yaml +++ b/sdrbase/resources/webapi/doc/swagger/include/StarTracker.yaml @@ -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 diff --git a/sdrbase/resources/webapi/doc/swagger/swagger.yaml b/sdrbase/resources/webapi/doc/swagger/swagger.yaml index 884157346..610404a6f 100644 --- a/sdrbase/resources/webapi/doc/swagger/swagger.yaml +++ b/sdrbase/resources/webapi/doc/swagger/swagger.yaml @@ -3079,6 +3079,16 @@ definitions: 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 TargetAzimuthElevation: description: "A target azimuth and elevation" diff --git a/swagger/sdrangel/code/html2/index.html b/swagger/sdrangel/code/html2/index.html index 42c62ff59..c1bac6e96 100644 --- a/swagger/sdrangel/code/html2/index.html +++ b/swagger/sdrangel/code/html2/index.html @@ -2870,6 +2870,9 @@ margin-bottom: 20px; "PacketModActions" : { "$ref" : "#/definitions/PacketModActions" }, + "RadioAstronomyActions" : { + "$ref" : "#/definitions/RadioAstronomyActions" + }, "SigMFFileSinkActions" : { "$ref" : "#/definitions/SigMFFileSinkActions" } @@ -3072,6 +3075,9 @@ margin-bottom: 20px; "SSBDemodReport" : { "$ref" : "#/definitions/SSBDemodReport" }, + "RadioAstronomyReport" : { + "$ref" : "#/definitions/RadioAstronomyReport" + }, "RadioClockReport" : { "$ref" : "#/definitions/RadioClockReport" }, @@ -3227,6 +3233,9 @@ margin-bottom: 20px; "PagerDemodSettings" : { "$ref" : "#/definitions/PagerDemodSettings" }, + "RadioAstronomySettings" : { + "$ref" : "#/definitions/RadioAstronomySettings" + }, "RadioClockSettings" : { "$ref" : "#/definitions/RadioClockSettings" }, @@ -5787,6 +5796,28 @@ margin-bottom: 20px; "items" : { "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" @@ -5844,7 +5875,8 @@ margin-bottom: 20px; "description" : "Maximum elevation the controller will output" }, "tolerance" : { - "type" : "integer", + "type" : "number", + "format" : "float", "description" : "Tolerance in degrees" }, "protocol" : { @@ -9006,6 +9038,135 @@ margin-bottom: 20px; "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 = { "properties" : { @@ -9044,7 +9205,7 @@ margin-bottom: 20px; }, "modulation" : { "type" : "integer", - "description" : "0 - MSF, 1 - DCF77, 2 - TDF" + "description" : "0 - MSF, 1 - DCF77, 2 - TDF, 3 - WWVB" }, "timezone" : { "type" : "integer", @@ -10847,6 +11008,80 @@ margin-bottom: 20px; "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 = { "properties" : { @@ -10862,6 +11097,36 @@ margin-bottom: 20px; "type" : "string", "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" : { "type" : "number", "format" : "float", @@ -10962,6 +11227,144 @@ margin-bottom: 20px; } }, "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 = { "required" : [ "message" ], @@ -50602,7 +51005,7 @@ except ApiException as e:
- Generated 2021-10-04T00:59:39.001+02:00 + Generated 2021-10-12T21:36:57.091+02:00