Added missing API resource files

2023-03-11 05:05:26 +01:00 · 2023-03-11 05:05:26 +01:00 · 4adcd22491
commit 4adcd22491
--- a/sdrbase/resources/webapi.qrc
+++ b/sdrbase/resources/webapi.qrc
@ -58,6 +58,7 @@
        <file>webapi/doc/swagger/include/GLSpectrum.yaml</file>
        <file>webapi/doc/swagger/include/GS232Controller.yaml</file>
        <file>webapi/doc/swagger/include/HackRF.yaml</file>
+        <file>webapi/doc/swagger/include/HeatMap.yaml</file>
        <file>webapi/doc/swagger/include/IEEE_802_15_4_Mod.yaml</file>
        <file>webapi/doc/swagger/include/Interferometer.yaml</file>
        <file>webapi/doc/swagger/include/JogdialController.yaml</file>
@ -71,6 +72,7 @@
        <file>webapi/doc/swagger/include/Map.yaml</file>
        <file>webapi/doc/swagger/include/MetisMISO.yaml</file>
        <file>webapi/doc/swagger/include/M17Demod.yaml</file>
+        <file>webapi/doc/swagger/include/NavtexDemod.yaml</file>
        <file>webapi/doc/swagger/include/NFMDemod.yaml</file>
        <file>webapi/doc/swagger/include/NFMMod.yaml</file>
        <file>webapi/doc/swagger/include/NoiseFigure.yaml</file>
@ -95,6 +97,7 @@
        <file>webapi/doc/swagger/include/RemoteTCPSink.yaml</file>
        <file>webapi/doc/swagger/include/RigCtlServer.yaml</file>
        <file>webapi/doc/swagger/include/RollupState.yaml</file>
+        <file>webapi/doc/swagger/include/RTTYDemod.yaml</file>
        <file>webapi/doc/swagger/include/SatelliteTracker.yaml</file>
        <file>webapi/doc/swagger/include/SDRPlay.yaml</file>
        <file>webapi/doc/swagger/include/SDRPlayV3.yaml</file>
--- a/sdrbase/resources/webapi/doc/swagger/include/HeatMap.yaml
+++ b/sdrbase/resources/webapi/doc/swagger/include/HeatMap.yaml
@ -0,0 +1,63 @@
+HeatMapSettings:
+  description: HeatMap
+  properties:
+    inputFrequencyOffset:
+      type: integer
+      format: int64
+    rfBandwidth:
+      description: channel RF bandwidth in Hz
+      type: number
+      format: float
+    minPower:
+      type: number
+      format: float
+    maxPower:
+      type: number
+      format: float
+    colorMapName:
+      type: string
+    mode:
+      description: "(0 - None, 1 - Average, 2 - Max, 3 - Min, 4 - Pulse Average)"
+      type: integer
+    pulseThreshold:
+      type: number
+      format: float
+    averagePeriodUS:
+      description: "Averaging period in microseconds"
+      type: integer
+    sampleRate:
+      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
+    scopeConfig:
+      $ref: "/doc/swagger/include/GLScope.yaml#/GLScope"
+    channelMarker:
+      $ref: "/doc/swagger/include/ChannelMarker.yaml#/ChannelMarker"
+    rollupState:
+      $ref: "/doc/swagger/include/RollupState.yaml#/RollupState"
+
+HeatMapReport:
+  description: HeatMap
+  properties:
+    channelPowerDB:
+      description: power received in channel (dB)
+      type: number
+      format: float
+    channelSampleRate:
+      type: integer
--- a/sdrbase/resources/webapi/doc/swagger/include/Map.yaml
+++ b/sdrbase/resources/webapi/doc/swagger/include/Map.yaml
@ -118,7 +118,7 @@ MapItem:
      type: number
      format: float
    altitudeReference:
-      description: "0 - NONE (Absolule), 1 - CLAMP_TO_GROUND, 2 - RELATIVE_TO_GROUND, 3 - CLIP_TO_GROUND"
+      description: "0 - NONE (Absolute), 1 - CLAMP_TO_GROUND, 2 - RELATIVE_TO_GROUND, 3 - CLIP_TO_GROUND"
      type: integer
    animations:
      description: "Animations to play"
@ -126,7 +126,7 @@ MapItem:
      items:
        $ref: "/doc/swagger/include/Map.yaml#/MapAnimation"
    type:
-      description: "(0 - Map Item, 1 - Image Tile)"
+      description: "(0 - Map Item, 1 - Image Tile, 2 - Polygon, 3 - Polyline)"
      type: integer
    imageTileWest:
      type: number
@ -140,6 +140,22 @@ MapItem:
    imageTileNorth:
      type: number
      format: float
+    imageZoomLevel:
+      description: "For 2D map"
+      type: number
+      format: float
+    coordinates:
+      description: "Polygon/polyline coordinates"
+      type: array
+      items:
+        $ref: "/doc/swagger/include/Map.yaml#/MapCoordinate"
+    extrudedHeight:
+      description: "Extruded height (from surface) for polygons"
+      type: number
+      format: float
+    availableUntil:
+      description: "Date and time until after which this item should no longer appear on 3D map"
+      type: string

 MapAnimation:
  description: "Animation to play in the model on the 3D map"
--- a/sdrbase/resources/webapi/doc/swagger/include/NavtexDemod.yaml
+++ b/sdrbase/resources/webapi/doc/swagger/include/NavtexDemod.yaml
@ -0,0 +1,62 @@
+NavtexDemodSettings:
+  description: ACARSDemod
+  properties:
+    inputFrequencyOffset:
+      type: integer
+      format: int64
+    rfBandwidth:
+      type: number
+      format: float
+    navArea:
+      type: integer
+    filterStation:
+      type: string
+    filterType:
+      type: string
+    udpEnabled:
+      description: "Whether to forward received messages to specified UDP port"
+      type: integer
+    udpAddress:
+      description: "UDP address to forward received messages to"
+      type: string
+    udpPort:
+      description: "UDP port to forward received messages to"
+      type: integer
+    logFilename:
+      type: string
+    logEnabled:
+      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
+    scopeConfig:
+      $ref: "/doc/swagger/include/GLScope.yaml#/GLScope"
+    channelMarker:
+      $ref: "/doc/swagger/include/ChannelMarker.yaml#/ChannelMarker"
+    rollupState:
+      $ref: "/doc/swagger/include/RollupState.yaml#/RollupState"
+
+NavtexDemodReport:
+  description: ACARSDemod
+  properties:
+    channelPowerDB:
+      description: power received in channel (dB)
+      type: number
+      format: float
+    channelSampleRate:
+      type: integer
--- a/sdrbase/resources/webapi/doc/swagger/include/RTTYDemod.yaml
+++ b/sdrbase/resources/webapi/doc/swagger/include/RTTYDemod.yaml
@ -0,0 +1,73 @@
+RTTYDemodSettings:
+  description: ACARSDemod
+  properties:
+    inputFrequencyOffset:
+      type: integer
+      format: int64
+    rfBandwidth:
+      type: number
+      format: float
+    baudRate:
+      type: number
+      format: float
+    frequencyShift:
+      type: integer
+    udpEnabled:
+      description: "Whether to forward received messages to specified UDP port"
+      type: integer
+    udpAddress:
+      description: "UDP address to forward received messages to"
+      type: string
+    udpPort:
+      description: "UDP port to forward received messages to"
+      type: integer
+    characterSet:
+      type: integer
+    suppressCRLF:
+      type: integer
+    unshiftOnSpace:
+      type: integer
+    msbFirst:
+      type: integer
+    spaceHigh:
+      type: integer
+    squelch:
+      type: integer
+    logFilename:
+      type: string
+    logEnabled:
+      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
+    scopeConfig:
+      $ref: "/doc/swagger/include/GLScope.yaml#/GLScope"
+    channelMarker:
+      $ref: "/doc/swagger/include/ChannelMarker.yaml#/ChannelMarker"
+    rollupState:
+      $ref: "/doc/swagger/include/RollupState.yaml#/RollupState"
+
+RTTYDemodReport:
+  description: ACARSDemod
+  properties:
+    channelPowerDB:
+      description: power received in channel (dB)
+      type: number
+      format: float
+    channelSampleRate:
+      type: integer
--- a/sdrbase/resources/webapi/doc/swagger/include/VORDemod.yaml
+++ b/sdrbase/resources/webapi/doc/swagger/include/VORDemod.yaml
@ -16,6 +16,8 @@ VORDemodSettings:
      format: float
    audioMute:
      type: integer
+    identBandpassEnable:
+      type: integer
    rgbColor:
      type: integer
    title: