Struct lockin::Lockin

pub struct Lockin {
    pub(crate) afe: [Leaf<Gain>; 2],
    pub(crate) lockin_mode: Leaf<LockinMode>,
    pub(crate) pll_tc: [Leaf<u32>; 2],
    pub(crate) lockin_k: Leaf<<Lowpass<2> as Filter>::Config>,
    pub(crate) lockin_harmonic: Leaf<i32>,
    pub(crate) lockin_phase: Leaf<i32>,
    pub(crate) output_conf: [Leaf<Conf>; 2],
    pub(crate) telemetry_period: Leaf<u16>,
    pub(crate) stream: Leaf<StreamTarget>,
}

Fields

afe: [Leaf<Gain>; 2]

Configure the Analog Front End (AFE) gain.

Path

afe/<n>

• <n> specifies which channel to configure. <n> := [0, 1]

Value

Any of the variants of Gain enclosed in double quotes.

lockin_mode: Leaf<LockinMode>

Specifies the operational mode of the lockin.

Path

lockin_mode

Value

One of the variants of LockinMode enclosed in double quotes.

pll_tc: [Leaf<u32>; 2]

Specifis the PLL time constant.

Path

pll_tc/<n>

• <n> specifies which channel to configure. <n> := [0, 1]

Value

The PLL time constant exponent (1-31).

lockin_k: Leaf<<Lowpass<2> as Filter>::Config>

Specifies the lockin lowpass gains.

Path

lockin_k

Value

The lockin low-pass coefficients. See idsp::Lowpass for determining them.

lockin_harmonic: Leaf<i32>

Specifies which harmonic to use for the lockin.

Path

lockin_harmonic

Value

Harmonic index of the LO. -1 to _de_modulate the fundamental (complex conjugate)

lockin_phase: Leaf<i32>

Specifies the LO phase offset.

Path

lockin_phase

Value

Demodulation LO phase offset. Units are in terms of i32, where i32::MIN is equivalent to -pi and i32::MAX is equivalent to +pi.

output_conf: [Leaf<Conf>; 2]

Specifies DAC output mode.

Path

output_conf/<n>

• <n> specifies which channel to configure. <n> := [0, 1]

Value

One of the variants of Conf enclosed in double quotes.

telemetry_period: Leaf<u16>

Specifies the telemetry output period in seconds.

Path

telemetry_period

Value

Any non-zero value less than 65536.

stream: Leaf<StreamTarget>

Specifies the target for data streaming.

Path

stream

Value

See StreamTarget

Implementations

impl Lockin

pub(crate) const __MINICONF_LOOKUP: KeyLookup = _

Trait Implementations

impl Clone for Lockin

fn clone(&self) -> Lockin

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Lockin

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Lockin

fn default() -> Self

Returns the “default value” for a type.

impl TreeAny for Lockin

fn ref_any_by_key<K>(&self, keys: K) -> Result<&dyn Any, Traversal>

where K: Keys,

Obtain a reference to a dyn Any trait object for a leaf node.

fn mut_any_by_key<K>(&mut self, keys: K) -> Result<&mut dyn Any, Traversal>

where K: Keys,

Obtain a mutable reference to a dyn Any trait object for a leaf node.

fn ref_by_key<T, K>(&self, keys: K) -> Result<&T, Traversal>

where T: Any, K: IntoKeys,

Obtain a reference to a leaf of known type by key.

fn mut_by_key<T, K>(&mut self, keys: K) -> Result<&mut T, Traversal>

where T: Any, K: IntoKeys,

Obtain a mutable reference to a leaf of known type by key.

impl<'de> TreeDeserialize<'de> for Lockin

fn deserialize_by_key<K, D>( &mut self, keys: K, de: D, ) -> Result<usize, Error<D::Error>>

where K: Keys, D: Deserializer<'de>,

Deserialize a leaf node by its keys.

impl TreeKey for Lockin

fn traverse_all<W: Walk>() -> Result<W, W::Error>

Walk metadata about all paths.

fn traverse_by_key<K, F, E>(keys: K, func: F) -> Result<usize, Error<E>>

where K: Keys, F: FnMut(usize, Option<&'static str>, NonZero<usize>) -> Result<(), E>,

Traverse from the root to a leaf and call a function for each node.

fn transcode<N, K>(keys: K) -> Result<(N, Node), Traversal>

where K: IntoKeys, N: Transcode + Default,

Transcode keys to a new keys type representation

fn nodes<N, const D: usize>() -> NodeIter<Self, N, D>

where N: Transcode + Default,

Return an iterator over nodes of a given type

impl TreeSerialize for Lockin

fn serialize_by_key<K, S>( &self, keys: K, ser: S, ) -> Result<usize, Error<S::Error>>

where K: Keys, S: Serializer,

Serialize a node by keys.