sdrangel/sdrbase/resources/webapi/doc/swagger/include/APTDemod.yaml

APTDemodSettings:
  description: APTDemod
  properties:
    inputFrequencyOffset:
      description: Channel center frequency shift from baseband center in Hz
      type: integer
      format: int64
    rfBandwidth:
      description: Channel RF bandwidth in Hz
      type: number
      format: float
    fmDeviation:
      description: Frequency deviation in Hz
      type: integer
    cropNoise:
      description: Crop noise from top and bottom of image
      type: integer
    denoise:
      description: Apply denoise filter to image
      type: integer
    linearEqualise:
      description: Apply linear equalisation to image
      type: integer
    histogramEqualise:
      description: Apply histogram equalisation to image
      type: integer
    precipitationOverlay:
      description: Create colour overlay of precipitation
      type: integer
    flip:
      description: Flip image for South to North passes
      type: integer
    channels:
      description: Which channel to display (0=both, 1=A, 2=B, 3=Temperature, 4+=palette)
      type: integer
    decodeEnabled:
      description: Controls whether the decoder is enabled
      type: integer
    autoSave:
      description: Automatically save images when acquisition is stopped
      type: integer
    autoSavePath:
      description: Directory to automatically save images in
      type: string
    autoSaveMinScanLines:
      description: Minimum number of scanlines (after cropping) for an image to be automatically saved
      type: integer
    saveCombined:
      type: integer
      description: Save image with channels A and B
    saveSeparate:
      description: Save channel A and B as separate image files
      type: integer
    saveProjection:
      description: Save equidistant cylindrical projection of image
      type: integer
    scanlinesPerImageUpdate:
      description: Interval in scanlines between image processing and projection
      type: integer
    transparencyThreshold:
      description: Threshold below which pixels will be fully transparent (0-255)
      type: integer
    opacityThreshold:
      description: Threshold above which pixels will be fully opaque (0-255)
      type: integer
    palettes:
      description: "; separated list of 256x256 image files that can be used as colour maps"
      type: string
    palette:
      description: "Index in to palletes. Used when channels=4"
      type: integer
    horizontalPixelsPerDegree:
      description: "Horizontal pixels per degree longitude in projected image"
      type: integer
    verticalPixelsPerDegree:
      description: "Vertical pixels per degree latitude in projected image"
      type: integer
    satTimeOffset:
      description: "Time offset in seconds, for aligning image on map"
      type: number
      format: float
    satYaw:
      description: "Yaw angle offset in degrees, for aligning image on map"
      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
    channelMarker:
      $ref: "/doc/swagger/include/ChannelMarker.yaml#/ChannelMarker"
    rollupState:
      $ref: "/doc/swagger/include/RollupState.yaml#/RollupState"

APTDemodActions:
  description: APTDemod
  properties:
    aos:
      description: "Acquisition of signal"
      type: object
      properties:
        satelliteName:
          description: "Name of the satellite"
          type: string
        northToSouthPass:
          description: "Satellite is passing from the North to the South (1) or South to North (0)"
          type: integer
        tle:
          description: "Two line elements for satellite"
          type: string
        dateTime:
          description: "Date and time of AOS (May differ from system clock when replaying old passes)"
          type: string
    los:
      description: "Loss of signal"
      type: object
      properties:
        satelliteName:
          description: "Name of the satellite"
          type: string