CitraClient.Schemas.Detection (citra_client v0.3.0)

View Source

Individual RF detection

Fields

  • :bandwidth_hz — integer() (API key: bandwidthHz) — Bandwidth in Hz
  • :center_frequency_hz — integer() (API key: centerFrequencyHz) — Center frequency in Hz
  • :snr_db — number() (API key: snrDb) — Signal-to-noise ratio in dB
  • :strength_dbm — number() (API key: strengthDbm) — Signal strength in dBm

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.Detection{
  bandwidth_hz: integer() | nil,
  center_frequency_hz: integer() | nil,
  snr_db: number() | nil,
  strength_dbm: number() | 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.