DYNAMIXEL Driver 0.1.0
API reference
Loading...
Searching...
No Matches
Public Types | Public Attributes | List of all members
dynamixel::protocol::ScanResult Struct Reference

What Scan() found in the receive buffer. More...

#include <dynamixel_protocol.hpp>

Public Types

enum class  Kind : uint8_t { NeedMore = 0 , Frame = 1 }
 The outcome. More...
 

Public Attributes

Kind kind {Kind::NeedMore}
 The outcome.
 
std::size_t discard
 Bytes before the packet (or all useless bytes) to drop from the front.
 
std::size_t frame_size {0}
 Size of the valid packet when kind is Frame.
 
std::size_t need {1}
 Smallest number of further bytes that can make progress.
 
std::size_t crc_drops {0}
 Candidates dropped for a wrong CRC or checksum.
 
std::size_t garbage {0}
 Bytes skipped that did not start a candidate.
 

Detailed Description

What Scan() found in the receive buffer.

Member Enumeration Documentation

◆ Kind

enum class dynamixel::protocol::ScanResult::Kind : uint8_t
strong

The outcome.

Enumerator
NeedMore 

No complete valid status packet yet; read need more bytes.

Frame 

A valid status packet starts at discard, frame_size bytes long.

Member Data Documentation

◆ discard

std::size_t dynamixel::protocol::ScanResult::discard
Initial value:
{
0}

Bytes before the packet (or all useless bytes) to drop from the front.


The documentation for this struct was generated from the following file: