1
0
mirror of https://github.com/f4exb/sdrangel.git synced 2026-06-08 00:44:48 -04:00

Update Web API for latest plugins and features

This commit is contained in:
Jon Beniston
2021-01-13 20:56:45 +00:00
parent 3adea2fd70
commit 721d0a40c2
49 changed files with 5141 additions and 88 deletions
@@ -0,0 +1,30 @@
APRSSettings:
description: "APRS settings"
properties:
igateServer:
type: string
igatePort:
type: integer
igateCallsign:
type: string
igatePasscode:
type: string
igateFilter:
type: string
igateEnabled:
type: integer
title:
type: string
rgbColor:
type: integer
useReverseAPI:
description: Synchronize with reverse API (1 for yes, 0 for no)
type: integer
reverseAPIAddress:
type: string
reverseAPIPort:
type: integer
reverseAPIDeviceIndex:
type: integer
reverseAPIChannelIndex:
type: integer
@@ -63,6 +63,8 @@ ChannelSettings:
$ref: "/doc/swagger/include/LocalSink.yaml#/LocalSinkSettings"
LocalSourceSettings:
$ref: "/doc/swagger/include/LocalSource.yaml#/LocalSourceSettings"
PacketDemodSettings:
$ref: "/doc/swagger/include/PacketDemod.yaml#/PacketDemodSettings"
PacketModSettings:
$ref: "/doc/swagger/include/PacketMod.yaml#/PacketModSettings"
RemoteSinkSettings:
@@ -15,5 +15,7 @@ FeatureActions:
type: integer
AFCActions:
$ref: "/doc/swagger/include/AFC.yaml#/AFCActions"
MapActions:
$ref: "/doc/swagger/include/Map.yaml#/MapActions"
SimplePTTActions:
$ref: "/doc/swagger/include/SimplePTT.yaml#/SimplePTTActions"
@@ -15,12 +15,18 @@ FeatureSettings:
type: integer
AFCSettings:
$ref: "/doc/swagger/include/AFC.yaml#/AFCSettings"
APRSSettings:
$ref: "/doc/swagger/include/APRS.yaml#/APRSSettings"
DemodAnalyzerSettings:
$ref: "/doc/swagger/include/DemodAnalyzer.yaml#/DemodAnalyzerSettings"
GS232ControllerSettings:
$ref: "/doc/swagger/include/GS232Controller.yaml#/GS232ControllerSettings"
MapSettings:
$ref: "/doc/swagger/include/Map.yaml#/MapSettings"
RigCtlServerSettings:
$ref: "/doc/swagger/include/RigCtlServer.yaml#/RigCtlServerSettings"
StarTrackerSettings:
$ref: "/doc/swagger/include/StarTracker.yaml#/StarTrackerSettings"
SimplePTTSettings:
$ref: "/doc/swagger/include/SimplePTT.yaml#/SimplePTTSettings"
VORLocalizerSettings:
@@ -14,15 +14,21 @@ GS232ControllerSettings:
description: The baud rate to use for the serial connection to the GS-232 controller
type: integer
track:
description: Track a target where azimuth and elevation are determined by another plugin (1 for yes, 0 for no)
type: integer
target:
description: "Identifier of the channel or feature plugin providing target azimuth and elevation (E.g. R0:0 ADSBDemod)"
type: string
azimuthOffset:
description: Azimuth offset in degrees
type: integer
elevationOffset:
description: Elevation offset in degrees
type: integer
title:
type: string
rgbColor:
type: integer
deviceIndex:
type: integer
channelIndex:
type: integer
useReverseAPI:
description: Synchronize with reverse API (1 for yes, 0 for no)
type: integer
@@ -0,0 +1,57 @@
MapSettings:
description: Map
properties:
displayNames:
description: Display object names on the map (1 for yes, 0 for no)
type: integer
title:
type: string
rgbColor:
type: integer
useReverseAPI:
description: Synchronize with reverse API (1 for yes, 0 for no)
type: integer
reverseAPIAddress:
type: string
reverseAPIPort:
type: integer
reverseAPIDeviceIndex:
type: integer
reverseAPIChannelIndex:
type: integer
MapActions:
description: Map
properties:
find:
description: "The name of the item or the location to centre the map on"
type: string
MapItem:
description: "An item to draw on the map. Set image to an empty string to remove item from the map."
required:
- name
properties:
name:
description: "A name for the item"
type: string
image:
description: "Filename or URL of image to draw on the map"
type: string
imageRotation:
description: "Angle to rotate the image by"
type: integer
imageFixedSize:
description: "Keep the image the same size, regardless of map zoom level (1 for yes, 0 for no)"
type: integer
text:
descrption: "Text to draw on the map when item is selected"
type: string
latitude:
description: "Latitude in decimal degrees, positive to the north"
type: number
format: float
longitude:
description: "Longitude in decimal degrees, positive to the east"
type: number
format: float
@@ -0,0 +1,35 @@
PacketDemodSettings:
description: PacketDemod
properties:
inputFrequencyOffset:
type: integer
format: int64
mode:
type: string
description: >
Transmission mode
* "1200 AFSK"
rfBandwidth:
type: number
format: float
fmDeviation:
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
@@ -0,0 +1,87 @@
StarTrackerSettings:
description: "Star Tracker settings"
properties:
target:
description: "Target object (Sun, Moon or Custom)"
type: string
ra:
description: "Right ascension of custom target"
type: string
dec:
description: "Declination of custom target"
type: string
latitude:
description: "Latitude in decimal degrees (North positive) of observation/antenna location"
type: number
format: float
longitude:
description: "Longitude in decimal degrees (East positive) of observation/antenna location"
type: number
format: float
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
refraction:
description: "Atmospheric refraction correction (None or Saemundsson)"
type: string
pressure:
description: "Air pressure in millibars, for refraction"
type: number
format: float
temperature:
description: "Air temperature in Celsuis, for refraction"
type: number
format: float
humidity:
description: "Relative humidity in %, for refraction"
type: number
format: float
heightAboveSeaLevel:
description: "Height above sea level in metres of observation/antenna location"
type: number
format: float
temperatureLapseRate:
description: "Temperature lapse rate in K/km"
type: number
format: float
frequency:
description: "Frequency of radio waves being observed in MHz"
type: number
format: float
stellariumServerEnabled:
descrption: "Enable Stellarium server (1 for yes, 0 for no)"
type: integer
stellariumPort:
description: "IP port number for Stellarium server to listen on (Default is 10001)."
type: integer
updatePeriod:
description: "Time in seconds between each calculation of the target's position"
type: number
format: float
epoch:
description: "Epoch for RA and Dec (J2000 or JNOW)"
type: string
drawSunOnMap:
description: "Draw the overhead position of the Sun on the Map (1 for yes, 0 for no)"
type: integer
drawMoonOnMap:
description: "Draw the overhead position of the Moon on the Map (1 for yes, 0 for no)"
type: integer
drawStarOnMap:
description: "Draw the overhead position of the target Star on the Map (1 for yes, 0 for no)"
type: integer
title:
type: string
rgbColor:
type: integer
useReverseAPI:
description: Synchronize with reverse API (1 for yes, 0 for no)
type: integer
reverseAPIAddress:
type: string
reverseAPIPort:
type: integer
reverseAPIDeviceIndex:
type: integer
reverseAPIChannelIndex:
type: integer