Skip to main content

QueryResult

Struct QueryResult 

Source
#[non_exhaustive]
pub struct QueryResult {
Show 21 fields pub mode: Mode, pub position: f32, pub velocity: f32, pub torque: f32, pub q_current: f32, pub d_current: f32, pub abs_position: f32, pub power: f32, pub motor_temperature: f32, pub trajectory_complete: bool, pub home_state: HomeState, pub voltage: f32, pub temperature: f32, pub fault: i8, pub aux1_gpio: i8, pub aux2_gpio: i8, pub aux1_pwm_input_period_us: i32, pub aux1_pwm_input_duty_cycle: f32, pub aux2_pwm_input_period_us: i32, pub aux2_pwm_input_duty_cycle: f32, pub extra: [Option<ExtraValue>; 16],
}
Expand description

Result of parsing a query response.

§Examples

use moteus_protocol::CanFdFrame;
use moteus_protocol::query::QueryResult;

// After receiving a response frame from the device...
fn handle_response(frame: &CanFdFrame) {
    let result = QueryResult::parse(frame);
    if result.mode.is_error() {
        eprintln!("Fault code: {}", result.fault);
    }
}

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§mode: Mode§position: f32§velocity: f32§torque: f32§q_current: f32§d_current: f32§abs_position: f32§power: f32§motor_temperature: f32§trajectory_complete: bool§home_state: HomeState§voltage: f32§temperature: f32§fault: i8§aux1_gpio: i8§aux2_gpio: i8§aux1_pwm_input_period_us: i32§aux1_pwm_input_duty_cycle: f32§aux2_pwm_input_period_us: i32§aux2_pwm_input_duty_cycle: f32§extra: [Option<ExtraValue>; 16]

Extra register values. None entries are unused.

Implementations§

Source§

impl QueryResult

Source

pub fn new() -> Self

Creates a new QueryResult with NaN values.

Source

pub fn parse(frame: &CanFdFrame) -> Self

Parses a query response from a CAN frame.

Source

pub fn parse_data(data: &[u8]) -> Self

Parses a query response from raw bytes.

Source

pub fn get_extra(&self, register: u16) -> Option<f32>

Gets an extra value by register number.

Trait Implementations§

Source§

impl Clone for QueryResult

Source§

fn clone(&self) -> QueryResult

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for QueryResult

Source§

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

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

impl Default for QueryResult

Source§

fn default() -> QueryResult

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