LibMultiSense
LibMultiSense Documentation
multisense::Channel::Config Struct Reference

#include <MultiSenseChannel.hh>

Collaboration diagram for multisense::Channel::Config:

Public Attributes

std::string ip_address = "10.66.171.21"
 the IP address of the MultiSense camera to connect to More...
 
std::optional< int16_t > mtu = static_cast<uint16_t>(1500)
 The MTU to use for sending and receiving data from the camera. More...
 
std::optional< std::chrono::milliseconds > receive_timeout = std::chrono::milliseconds(500)
 Timeout to use when waiting for MultiSense command responses. More...
 
uint16_t command_port {9001}
 The UDP port on the MultiSense which accepts user commands. More...
 
std::optional< std::string > interface = std::nullopt
 An optional name of network interface to bind to. More...
 
ReceiveBufferConfig receive_buffer_configuration {}
 Config for the number and size of internal buffers used to receive data without recurring memory allocations. More...
 

Detailed Description

Definition at line 85 of file MultiSenseChannel.hh.

Member Data Documentation

◆ command_port

uint16_t multisense::Channel::Config::command_port {9001}

The UDP port on the MultiSense which accepts user commands.

All production firmware builds use port 9001

Definition at line 109 of file MultiSenseChannel.hh.

◆ interface

std::optional<std::string> multisense::Channel::Config::interface = std::nullopt

An optional name of network interface to bind to.

(i.e. eth0)

Definition at line 114 of file MultiSenseChannel.hh.

◆ ip_address

std::string multisense::Channel::Config::ip_address = "10.66.171.21"

the IP address of the MultiSense camera to connect to

Definition at line 90 of file MultiSenseChannel.hh.

◆ mtu

std::optional<int16_t> multisense::Channel::Config::mtu = static_cast<uint16_t>(1500)

The MTU to use for sending and receiving data from the camera.

Setting the MTU to nullopt will trigger a automatic search for the largest available MTU. For more information on MTU see: https://docs.carnegierobotics.com/network/network.html#mtu

Definition at line 97 of file MultiSenseChannel.hh.

◆ receive_buffer_configuration

ReceiveBufferConfig multisense::Channel::Config::receive_buffer_configuration {}

Config for the number and size of internal buffers used to receive data without recurring memory allocations.

May only be valid for certain implementations

Definition at line 120 of file MultiSenseChannel.hh.

◆ receive_timeout

std::optional<std::chrono::milliseconds> multisense::Channel::Config::receive_timeout = std::chrono::milliseconds(500)

Timeout to use when waiting for MultiSense command responses.

Setting the timeout to nullopt will result in the camera waiting forever for a command response

Definition at line 103 of file MultiSenseChannel.hh.


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