Struct StatusPacket

pub struct StatusPacket<'a> { /* private fields */ }

A status response that is currently in the read buffer of a bus.

When dropped, the response data is removed from the read buffer.

Implementations

impl<'a> StatusPacket<'a>

pub fn as_bytes(&self) -> &[u8]

Get the raw bytes of the message.

This includes the message header and the parameters. It does not include the CRC or byte-stuffing.

pub fn packet_id(&self) -> u8

The packet ID of the response.

pub fn instruction_id(&self) -> u8

The instruction ID of the response.

pub fn error(&self) -> u8

The error field of the response.

pub fn error_number(&self) -> u8

The error number of the status packet.

This is the lower 7 bits of the error field.

pub fn alert(&self) -> bool

The alert bit from the error field of the response.

This is the 8th bit of the error field.

If this bit is set, you can normally check the “Hardware Error” register for more details. Consult the manual of your motor for more information.

pub fn parameters(&self) -> &[u8]

The parameters of the response.

Trait Implementations

impl<'a> Debug for StatusPacket<'a>

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

Formats the value using the given formatter.

impl<'a, 'b> From<&'b StatusPacket<'a>> for Response<&'b [u8]>

fn from(status_packet: &'b StatusPacket<'a>) -> Self

Converts to this type from the input type.

impl<'a> From<StatusPacket<'a>> for Response<Vec<u8>>

fn from(status_packet: StatusPacket<'a>) -> Self

Converts to this type from the input type.

impl<'a> TryFrom<StatusPacket<'a>> for Response<()>

type Error = InvalidParameterCount

The type returned in the event of a conversion error.

fn try_from(status_packet: StatusPacket<'a>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<StatusPacket<'a>> for Response<Ping>

type Error = InvalidParameterCount

The type returned in the event of a conversion error.

fn try_from(status_packet: StatusPacket<'a>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<StatusPacket<'a>> for Response<u16>

type Error = InvalidParameterCount

The type returned in the event of a conversion error.

fn try_from(status_packet: StatusPacket<'a>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<StatusPacket<'a>> for Response<u32>

type Error = InvalidParameterCount

The type returned in the event of a conversion error.

fn try_from(status_packet: StatusPacket<'a>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<StatusPacket<'a>> for Response<u8>

type Error = InvalidParameterCount

The type returned in the event of a conversion error.

fn try_from(status_packet: StatusPacket<'a>) -> Result<Self, Self::Error>

Performs the conversion.