Frame header structure. More...

#include <protocol.hpp>

Public Member Functions
bool	serialize (uint8_t *buffer, size_t buffer_size) const
	Serialize header to bytes.

bool	deserialize (uint8_t *buffer, size_t buffer_size)
	Deserialize bytes to header.

Static Public Member Functions
static size_t	get_serialized_size ()
	Size of the header in bytes.

Public Attributes
uint16_t	magic_number = MAGIC_NUMBER
	Magic number for identifying the protocol.

uint8_t	protocol_version = PROTOCOL_VERSION
	Protocol version (should be PROTOCOL_VERSION)

uint8_t	message_type = static_cast<uint8_t>(MessageType::INVALID)
	Type of message.

uint16_t	sequence_number = 0
	Sequence number for tracking messages.

uint16_t	payload_size = 0
	Size of the payload in bytes.

Detailed Description

Frame header structure.

Member Function Documentation

◆ serialize()

bool staubli_robot_driver::FrameHeader::serialize	(	uint8_t *	buffer,
		size_t	buffer_size
	)		const

Serialize header to bytes.

◆ deserialize()

bool staubli_robot_driver::FrameHeader::deserialize	(	uint8_t *	buffer,
		size_t	buffer_size
	)

Deserialize bytes to header.

◆ get_serialized_size()

static size_t staubli_robot_driver::FrameHeader::get_serialized_size ( )

inlinestatic

Size of the header in bytes.

Member Data Documentation

◆ magic_number

uint16_t staubli_robot_driver::FrameHeader::magic_number = MAGIC_NUMBER

Magic number for identifying the protocol.

◆ protocol_version

uint8_t staubli_robot_driver::FrameHeader::protocol_version = PROTOCOL_VERSION

Protocol version (should be PROTOCOL_VERSION)

◆ message_type

uint8_t staubli_robot_driver::FrameHeader::message_type = static_cast<uint8_t>(MessageType::INVALID)

Type of message.

◆ sequence_number

uint16_t staubli_robot_driver::FrameHeader::sequence_number = 0

Sequence number for tracking messages.

◆ payload_size

uint16_t staubli_robot_driver::FrameHeader::payload_size = 0

Size of the payload in bytes.

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

/home/runner/work/staubli_driver_ros2/staubli_driver_ros2/staubli_robot_driver/include/staubli_robot_driver/communication/protocol.hpp

Public Member Functions

Static Public Member Functions

Public Attributes