CitraClient.Schemas.FilterSpec (citra_client v0.3.0)

Specification for a single discrete filter.

All fields are required to ensure complete spectral information is stored. Filter name is used for hardware matching by the daemon.

Fields

:bandwidth_nm — number() — Full width at half maximum (FWHM) in nanometers
:central_wavelength_nm — number() — Central wavelength in nanometers
:name — String.t() — Filter name as reported by hardware (e.g., 'Red', 'Ha', 'V')

t()

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.

@type t() :: %CitraClient.Schemas.FilterSpec{
  bandwidth_nm: number() | nil,
  central_wavelength_nm: number() | nil,
  name: String.t() | nil
}

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

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