Frame

Struct Frame 

Source
pub struct Frame<P: DshotProtocol = NormalDshot> { /* private fields */ }
Expand description

A DShot frame parameterized by its protocol variant.

Implementations§

Source§

impl<P: DshotProtocol> Frame<P>

Source

pub fn new(speed: u16, request_telemetry: bool) -> Option<Self>

Creates a new frame with the given speed (0-1999) and telemetry request.

Returns None if the speed is out of bounds.

assert_eq!(Frame::<NormalDshot>::new(1000, false).unwrap().speed(), 1000);
Source

pub fn command(command: Command, request_telemetry: bool) -> Self

Creates a new frame with the given Command and telemetry request.

Source

pub fn speed(&self) -> u16

Returns the speed value (0-1999).

Source

pub fn telemetry_enabled(&self) -> bool

Returns whether telemetry is enabled.

Source

pub fn crc(&self) -> u16

Returns the CRC checksum.

Source

pub fn inner(&self) -> u16

Returns the raw u16.

Source

pub fn duty_cycles(&self, max_duty_cycle: u16) -> [u16; 17]

Returns an array of duty cycles for use in PWM DMA.

This contains an extra element that is always zero to ensure the PWM output gets pulled low at the end of the sequence. It can be sliced off if not needed.

Trait Implementations§

Source§

impl<P: Clone + DshotProtocol> Clone for Frame<P>

Source§

fn clone(&self) -> Frame<P>

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<P: Debug + DshotProtocol> Debug for Frame<P>

Source§

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

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

impl<P: Copy + DshotProtocol> Copy for Frame<P>

Auto Trait Implementations§

§

impl<P> Freeze for Frame<P>

§

impl<P> RefUnwindSafe for Frame<P>
where P: RefUnwindSafe,

§

impl<P> Send for Frame<P>
where P: Send,

§

impl<P> Sync for Frame<P>
where P: Sync,

§

impl<P> Unpin for Frame<P>
where P: Unpin,

§

impl<P> UnwindSafe for Frame<P>
where P: UnwindSafe,

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.