CitraClient.Schemas.RFCaptureCreate (citra_client v0.3.0)

View Source

Request schema for creating a new RF capture

Fields

  • :antenna_id — UUID String.t() (API key: antennaId) — ID of the antenna that captured the data
  • :capture_end — DateTime.t() (API key: captureEnd) — Timestamp when the capture ended
  • :capture_start — DateTime.t() (API key: captureStart) — Timestamp when the capture started
  • :data — CitraClient.Schemas.RFCaptureData.t() — RF capture data including detections and PSD
  • :task_id — UUID String.t() (API key: taskId) — Optional task ID this capture is associated with

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.RFCaptureCreate{
  antenna_id: String.t() | nil,
  capture_end: DateTime.t() | nil,
  capture_start: DateTime.t() | nil,
  data: CitraClient.Schemas.RFCaptureData.t() | map() | nil,
  task_id: 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.