Skip to main content

SeekProbe

Struct SeekProbe 

Source
pub struct SeekProbe {
    pub done: bool,
    pub error: bool,
    pub state: StateMachine,
    /* private fields */
}
Expand description

Seek Probe function block.

Jogs an axis in the negative direction until a sensor triggers, then halts and reports completion.

Fields§

§done: bool

Output: operation completed successfully.

§error: bool

Output: operation failed — check state.error_code.

§state: StateMachine

State machine with index, error_code, timers, and messages.

Implementations§

Source§

impl SeekProbe

Source

pub fn new() -> Self

Create a new SeekProbe in the idle state.

Source

pub fn call( &mut self, axis: &mut Axis, view: &mut impl AxisView, execute: bool, sensor: bool, )

Execute one scan cycle of the seek-probe state machine.

§Arguments
  • axis — The axis to jog. Must have been ticked already this cycle.
  • view — The axis PDO view for issuing motion commands.
  • execute — Rising edge triggers the seek operation.
  • sensor — When this goes high during jogging, the axis halts.
Source

pub fn abort(&mut self, axis: &mut Axis, view: &mut impl AxisView)

Abort the current operation immediately.

If motion is active (states > 10), the axis is halted and an error is set with code 1.

Source

pub fn is_busy(&self) -> bool

Returns true while the seek operation is in progress.

Trait Implementations§

Source§

impl Clone for SeekProbe

Source§

fn clone(&self) -> SeekProbe

Returns a duplicate 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 SeekProbe

Source§

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

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

impl Default for SeekProbe

Source§

fn default() -> Self

Returns the “default value” for a type. 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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V