Skip to main content

DamiaoCodec

Struct DamiaoCodec 

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

Damiao motor codec.

Construct with DamiaoCodec::new. Implements [MotorCodec] for the vendor-agnostic surface and crate::DamiaoCodecExt for the Damiao-specific 0x7FF parameter sub-protocol.

Implementations§

Source§

impl DamiaoCodec

Source

pub fn new() -> Self

Construct a new codec. bind_to_bus must be called before any encode.

Trait Implementations§

Source§

impl Clone for DamiaoCodec

Source§

fn clone(&self) -> DamiaoCodec

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 DamiaoCodecExt for DamiaoCodec

Source§

fn encode_read_param(&self, motor: MotorRef<'_>, rid: DamiaoRid) -> CanFrame

Encode a “read parameter” frame (command byte 0x33).
Source§

fn encode_write_param( &self, motor: MotorRef<'_>, rid: DamiaoRid, val: ParamValue, ) -> CanFrame

Encode a “write parameter” frame (command byte 0x55).
Source§

fn encode_save_to_flash(&self, motor: MotorRef<'_>) -> CanFrame

Encode a “save settings to flash” frame (command byte 0xAA).
Source§

fn encode_refresh(&self, motor: MotorRef<'_>) -> CanFrame

Encode a “request state feedback” frame (Damiao refresh_motor_status, command byte 0xCC on 0x7FF). The motor replies with a feedback frame; this commands no motion. (Byte-for-byte the openarm create_refresh_command.)
Source§

impl Debug for DamiaoCodec

Source§

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

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

impl Default for DamiaoCodec

Source§

fn default() -> DamiaoCodec

Returns the “default value” for a type. Read more
Source§

impl MotorCodec for DamiaoCodec

Source§

fn vendor_name(&self) -> &'static str

Vendor short name used in error messages and the TOML registry (e.g. "damiao").
Source§

fn supports(&self, motor_type: MotorTypeId) -> bool

True iff this codec can encode commands for and decode events from the supplied motor type.
Source§

fn limits(&self, motor_type: MotorTypeId) -> Result<Limits, CodecError>

Per-motor-type physical limits. Read more
Source§

fn bind_to_bus(&mut self, caps: BusCapabilities)

Called exactly once when this codec is bound to a [crate::caps::BusCapabilities]. Read more
Source§

fn encode_enable(&self, motor: MotorRef<'_>) -> Result<CanFrame, CodecError>

Encode the lifecycle “enable motor” command.
Source§

fn encode_disable(&self, motor: MotorRef<'_>) -> Result<CanFrame, CodecError>

Encode the lifecycle “disable motor” command.
Source§

fn encode_set_zero(&self, motor: MotorRef<'_>) -> Result<CanFrame, CodecError>

Encode the lifecycle “set this position as zero” command.
Source§

fn encode_command( &self, motor: MotorRef<'_>, cmd: &Command, ) -> Result<CanFrame, CodecError>

Encode a control-mode command.
Source§

fn encode_refresh( &self, motor: MotorRef<'_>, ) -> Result<Option<CanFrame>, CodecError>

Encode a “request current motor state” frame, if the vendor protocol has one. Read more
Source§

fn encode_set_mode( &self, motor: MotorRef<'_>, mode: CommandKind, ) -> Result<Option<CanFrame>, CodecError>

Encode a “set the motor’s persistent control mode” frame, if the vendor protocol supports it. Read more
Source§

fn encode_control_mode_readback( &self, motor: MotorRef<'_>, ) -> Result<Option<CanFrame>, CodecError>

Encode a private control-mode read-back query, when supported.
Source§

fn decode_control_mode_readback( &self, frame: &CanFrame, motor: MotorRef<'_>, ) -> Result<Option<u32>, CodecError>

Decode a private control-mode read-back response for motor.
Source§

fn decode(&self, frame: &CanFrame) -> Result<Option<Event>, CodecError>

Decode an inbound frame. 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> 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.