CitraClient.Schemas.Antenna (citra_client v0.3.0)

View Source

Full antenna schema with all fields

Fields

  • :automated_scheduling — boolean() (API key: automatedScheduling) — Whether the antenna is enabled for automated scheduling
  • :creation_epoch — DateTime.t() (API key: creationEpoch)
  • :ground_station_id — UUID String.t() (API key: groundStationId) — Ground station this antenna is assigned to
  • :half_power_beam_width — number() (API key: halfPowerBeamWidth) — Half power beam width in degrees
  • :home_azimuth — number() (API key: homeAzimuth) — Home azimuth position in degrees
  • :home_elevation — number() (API key: homeElevation) — Home elevation position in degrees
  • :id — UUID String.t()
  • :last_connection_epoch — DateTime.t() (API key: lastConnectionEpoch) — Last time the antenna connected
  • :max_frequency — integer() (API key: maxFrequency) — Maximum frequency in Hz
  • :max_slew_rate — number() (API key: maxSlewRate) — Maximum slew rate in degrees per second
  • :min_elevation — number() (API key: minElevation) — Minimum elevation angle in degrees
  • :min_frequency — integer() (API key: minFrequency) — Minimum frequency in Hz
  • :name — String.t() — Antenna name
  • :satellite_id — UUID String.t() (API key: satelliteId) — Satellite this antenna is assigned to
  • :status — String.t() — Compute antenna status based on last_connection_epoch.

Returns 'online' if connected within SENSOR_ONLINE_TIMEOUT_MINUTES, otherwise 'offline'.

  • :user_group_id — UUID String.t() (API key: userGroupId) — User group that owns this antenna
  • :user_id — UUID String.t() (API key: userId)
  • :username — String.t()

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.Antenna{
  automated_scheduling: boolean() | nil,
  creation_epoch: DateTime.t() | nil,
  ground_station_id: String.t() | nil,
  half_power_beam_width: number() | nil,
  home_azimuth: number() | nil,
  home_elevation: number() | nil,
  id: String.t() | nil,
  last_connection_epoch: DateTime.t() | nil,
  max_frequency: integer() | nil,
  max_slew_rate: number() | nil,
  min_elevation: number() | nil,
  min_frequency: integer() | nil,
  name: String.t() | nil,
  satellite_id: String.t() | nil,
  status: String.t() | nil,
  user_group_id: String.t() | nil,
  user_id: String.t() | nil,
  username: String.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.