Skip to main content

PiServo

Struct PiServo 

Source
pub struct PiServo { /* private fields */ }
Expand description

PI (Proportional-Integral) servo for clock discipline.

Processes offset samples and produces clock adjustment actions. The servo transitions through ServoState::Init -> ServoState::FrequencyLock -> ServoState::PhaseLock as it gathers enough samples to converge.

Implementations§

Source§

impl PiServo

Source

pub fn new(config: ServoConfig) -> Self

Create a new PI servo with the given configuration.

Source

pub fn with_defaults() -> Self

Create a new PI servo with default configuration.

Source

pub fn state(&self) -> ServoState

Current servo state.

Source

pub fn frequency(&self) -> f64

Current estimated frequency offset in PPM.

Source

pub fn sample_count(&self) -> u32

Number of samples processed so far.

Source

pub fn sample(&mut self, offset_ns: f64, poll_interval_secs: f64) -> ServoAction

Process a new offset measurement and return the action to take.

§Arguments
  • offset_ns: measured clock offset in nanoseconds (positive means local clock is ahead).
  • poll_interval_secs: current polling interval in seconds (tau). This controls the PI gain scaling.
Source

pub fn reset(&mut self)

Reset the servo to its initial state.

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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

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>,

Source§

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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more