Struct lockin::Lockin

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

Fields§

§afe: [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: LockinMode

Specifies the operational mode of the lockin.

§Path

lockin_mode

§Value

One of the variants of LockinMode enclosed in double quotes.

§pll_tc: [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: <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: 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: 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: [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: u16

Specifies the telemetry output period in seconds.

§Path

telemetry_period

§Value

Any non-zero value less than 65536.

§stream_target: StreamTarget

Specifies the target for data livestreaming.

§Path

stream_target

§Value

See StreamTarget

Implementations§

source§

impl Lockin

source

pub(crate) const __MINICONF_NAMES: [&'static str; 9] = _

source

pub(crate) const __MINICONF_DEFERS: [bool; 9] = _

Trait Implementations§

source§

impl Clone for Lockin

source§

fn clone(&self) -> Lockin

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for Lockin

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for Lockin

source§

fn default() -> Self

Returns the “default value” for a type. Read more
source§

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

source§

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

Deserialize an node by keys. Read more
source§

impl TreeKey<2> for Lockin

source§

fn len() -> usize

The number of top-level nodes.
source§

fn name_to_index(value: &str) -> Option<usize>

Convert a node name to a node index. Read more
source§

fn traverse_by_key<K, F, E>(keys: K, func: F) -> Result<usize, Error<E>>
where K: Keys, F: FnMut(usize, &str, usize) -> Result<(), E>,

Call a function for each node on the path described by keys. Read more
source§

fn metadata() -> Metadata

Get metadata about the paths in the namespace. Read more
source§

fn path<K, P>(keys: K, path: P, separator: &str) -> Result<usize, Error<Error>>
where K: IntoKeys, P: Write,

Convert keys to path. Read more
source§

fn indices<'a, K, I>(keys: K, indices: I) -> Result<usize, Error<()>>
where K: IntoKeys, I: IntoIterator<Item = &'a mut usize>,

Convert keys to indices. Read more
source§

fn packed<K>(keys: K) -> Result<(Packed, usize), Error<()>>
where K: IntoKeys,

Convert keys to packed usize bitfield representation. Read more
source§

fn iter_paths<P>(separator: &str) -> PathIter<'_, Self, Y, P>
where P: Write,

Create an iterator of all possible paths. Read more
source§

fn iter_paths_unchecked<P>(separator: &str) -> PathIter<'_, Self, Y, P>
where P: Write,

Create an unchecked iterator of all possible paths. Read more
source§

fn iter_indices() -> IndexIter<Self, Y>

Create an iterator of all possible indices. Read more
source§

fn iter_indices_unchecked() -> IndexIter<Self, Y>

Create an unchecked iterator of all possible indices. Read more
source§

fn iter_packed() -> PackedIter<Self, Y>

Create an iterator of all packed indices. Read more
source§

fn iter_packed_unchecked() -> PackedIter<Self, Y>

Create an iterator of all packed indices. Read more
source§

impl TreeSerialize<2> for Lockin

source§

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. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<'de, T, const Y: usize> JsonCoreSlash<'de, Y> for T
where T: TreeSerialize<Y> + TreeDeserialize<'de, Y>,

source§

fn set_json( &mut self, path: &str, data: &'de [u8] ) -> Result<usize, Error<Error>>

Update a node by path. Read more
source§

fn get_json(&self, path: &str, data: &mut [u8]) -> Result<usize, Error<Error>>

Retrieve a serialized value by path. Read more
source§

fn set_json_by_key<K>( &mut self, keys: K, data: &'de [u8] ) -> Result<usize, Error<Error>>
where K: IntoKeys,

Update a node by key. Read more
source§

fn get_json_by_key<K>( &self, keys: K, data: &mut [u8] ) -> Result<usize, Error<Error>>
where K: IntoKeys,

Retrieve a serialized value by key. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.