Skip to main content

Command

Enum Command 

Source
pub enum Command {
    Ping,
    GetInfo,
    SetConfig(Modulation),
    Tx {
        flags: TxFlags,
        data: Vec<u8, MAX_OTA_PAYLOAD>,
    },
    RxStart,
    RxStop,
}
Expand description

Host-to-device command.

Tx.data is owned so a parsed Command outlives the frame buffer it came from. This is a single memcpy over the radio packet — trivial relative to LoRa airtime, and it simplifies the firmware’s statechart (which needs to carry the pending TX across state transitions).

Variants§

§

Ping

§

GetInfo

§

SetConfig(Modulation)

§

Tx

Fields

§flags: TxFlags
§data: Vec<u8, MAX_OTA_PAYLOAD>
§

RxStart

§

RxStop

Implementations§

Source§

impl Command

Source

pub const fn type_id(&self) -> u8

Wire-level type_id for this command.

Source

pub fn encode_payload( &self, buf: &mut [u8], ) -> Result<usize, CommandEncodeError>

Encode the command’s payload (the bytes between the frame header and the CRC) into buf. Returns the number of bytes written.

Source

pub fn parse(type_id: u8, payload: &[u8]) -> Result<Self, CommandParseError>

Parse a (type_id, payload) pair into a Command. The tag is handled at the frame level and is not part of a command’s semantic content.

Trait Implementations§

Source§

impl Clone for Command

Source§

fn clone(&self) -> Command

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 Command

Source§

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

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

impl Format for Command
where Modulation: Format, TxFlags: Format, Vec<u8, MAX_OTA_PAYLOAD>: Format,

Source§

fn format(&self, f: Formatter<'_>)

Writes the defmt representation of self to fmt.
Source§

impl PartialEq for Command

Source§

fn eq(&self, other: &Command) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Eq for Command

Source§

impl StructuralPartialEq for Command

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.