CitraClient.Schemas.SolveAccessSatellitesToGroundStation (citra_client v0.3.0)

View Source

Fields used when making a request for access window calculations from satellites to ground station(s). Pass 1 ID for single-station access, or 2+ IDs for coordinated/TDOA access (overlapping windows only).

Fields

  • :end — DateTime.t() — UTC maximum boundary for access search
  • :frequency_ranges_mhz — list of CitraClient.Schemas.FrequencyRangeMhz.t() (API key: frequencyRangesMhz) — List of frequency ranges in MHz for filtering satellites (OR logic across ranges)
  • :ground_station_ids — list of UUID String.t() (API key: groundStationIds) — List of ground station IDs. Pass 1 for single-station access, or 2+ for coordinated/TDOA access (returns only overlapping windows).
  • :max_frequency_mhz — number() (API key: maxFrequencyMhz) — Maximum frequency in MHz for filtering satellites
  • :min_duration — number() (API key: minDuration) — Minimum duration in minutes for a valid access
  • :min_elevation — number() (API key: minElevation) — Minimum elevation angle in degrees for a valid access
  • :min_frequency_mhz — number() (API key: minFrequencyMhz) — Minimum frequency in MHz for filtering satellites
  • :start — DateTime.t() — UTC minimum boundary for access search

Summary

Types

t()

Functions

from_api(data)

Build this struct from a decoded JSON map received from the API. Unknown fields are ignored.

to_api(struct)

Convert this struct into a map with the API's camelCase keys, ready to be JSON-encoded. Fields whose value is nil are omitted.

Types

t()

@type t() :: %CitraClient.Schemas.SolveAccessSatellitesToGroundStation{
  end: DateTime.t() | nil,
  frequency_ranges_mhz: [
    CitraClient.Schemas.FrequencyRangeMhz.t() | map() | nil
  ],
  ground_station_ids: [String.t() | nil],
  max_frequency_mhz: number() | nil,
  min_duration: number() | nil,
  min_elevation: number() | nil,
  min_frequency_mhz: number() | nil,
  start: DateTime.t() | nil
}

Functions

from_api(data)

Build this struct from a decoded JSON map received from the API. Unknown fields are ignored.

to_api(struct)

Convert this struct into a map with the API's camelCase keys, ready to be JSON-encoded. Fields whose value is nil are omitted.