CitraClient.Schemas.EphemerisRequest (citra_client v0.3.0)

View Source

Request for satellite ephemeris data. Returns pre-computed TEME (True Equator Mean Equinox) inertial positions for accurate orbit visualization, supporting both SGP4 and SGP4-XP propagation. Use Cesium ReferenceFrame.INERTIAL to display true orbital shapes (circles/ellipses).

Fields

  • :end — DateTime.t() — UTC end time for ephemeris
  • :satellite_ids — list of UUID String.t() (API key: satelliteIds) — List of satellite IDs to compute ephemeris for
  • :start — DateTime.t() — UTC start time for ephemeris
  • :step_seconds — integer() (API key: stepSeconds) — Time step between ephemeris points in seconds (default 60s)

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.EphemerisRequest{
  end: DateTime.t() | nil,
  satellite_ids: [String.t() | nil],
  start: DateTime.t() | nil,
  step_seconds: integer() | 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.