template_pkg  1.0.0
A template ROS2 Package
Loading...
Searching...
No Matches
roship_io::transport::LspSerial::Params Struct Reference

Configuration parameters for the serial connection. More...

#include <lsp_serial.hpp>

Public Attributes

std::string port = "/dev/ttyUSB0"
 Serial port device name.
 
int baud_rate = 38400
 Baud rate for the serial connection.
 
int buffer_size = 1024
 Size of the read buffer.
 
int character_size = 8
 Number of data bits in each character.
 
int stop_bits = 1
 Number of stop bits.
 
int read_timeout_ms = 50
 Timeout for reading in milliseconds.
 
byte end_of_frame_byte = 0xAA
 Byte indicating the end of a frame.
 
std::string end_of_frame_ascii = "\n"
 ASCII string indicating the end of a frame.
 
bool use_end_of_frame_byte = true
 Flag to use end_of_frame_byte for frame detection.
 
bool use_end_of_frame_ascii = false
 Flag to use end_of_frame_ascii for frame detection.
 

Detailed Description

Configuration parameters for the serial connection.

Member Data Documentation

◆ baud_rate

int roship_io::transport::LspSerial::Params::baud_rate = 38400

Baud rate for the serial connection.

◆ buffer_size

int roship_io::transport::LspSerial::Params::buffer_size = 1024

Size of the read buffer.

◆ character_size

int roship_io::transport::LspSerial::Params::character_size = 8

Number of data bits in each character.

◆ end_of_frame_ascii

std::string roship_io::transport::LspSerial::Params::end_of_frame_ascii = "\n"

ASCII string indicating the end of a frame.

◆ end_of_frame_byte

byte roship_io::transport::LspSerial::Params::end_of_frame_byte = 0xAA

Byte indicating the end of a frame.

◆ port

std::string roship_io::transport::LspSerial::Params::port = "/dev/ttyUSB0"

Serial port device name.

◆ read_timeout_ms

int roship_io::transport::LspSerial::Params::read_timeout_ms = 50

Timeout for reading in milliseconds.

◆ stop_bits

int roship_io::transport::LspSerial::Params::stop_bits = 1

Number of stop bits.

◆ use_end_of_frame_ascii

bool roship_io::transport::LspSerial::Params::use_end_of_frame_ascii = false

Flag to use end_of_frame_ascii for frame detection.

◆ use_end_of_frame_byte

bool roship_io::transport::LspSerial::Params::use_end_of_frame_byte = true

Flag to use end_of_frame_byte for frame detection.


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