Skip to content

Commit

Permalink
Add a section for network config recommendation (#388)
Browse files Browse the repository at this point in the history
  • Loading branch information
Samahu authored Oct 15, 2024
1 parent 92ab33d commit 55519ed
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 1 deletion.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ assignees: ''
> **IMPORTANT**
> Before reporting a new bug make sure you have:
> - [ ] Checked existing issues https://github.com/ouster-lidar/ouster-ros/issues
> - [ ] Checked existing issues https://github.com/ouster-lidar/ouster-ros/issues
> - [ ] Checked existing discussions https://github.com/ouster-lidar/ouster-ros/discussions
> - [ ] Checked ouster community https://community.ouster.com/
> If you couldn't find relevant information and you think this is rather a driver
> problem then proceed with bug reporting.
Expand Down
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -128,6 +128,12 @@ roslaunch ouster_ros driver.launch \
`driver.launch` offers better performance and reduced overhead on the ROS bus, thus it is preferred
over `sensor.launch`. `sensor.launch` is mainly provided for backward compatibilty.

> **Note**:
> If you observe parts of the scan missing is missing, this suggests having a lots of dropped packets
> It is recommended that you increase the maximum allowed size for receive memory buffers in network
> subsystem, you can do so by running the script `network-configure.bash` under `util`.

#### Recording Mode
> Note
> As of package version 8.1, specifiying metadata file is optional since the introduction of the
Expand Down
11 changes: 11 additions & 0 deletions util/network-configure.bash
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
#!/bin/bash

# kernel receive buffer size
sudo sysctl -w net.core.rmem_max=16777216
sudo sysctl -w net.core.rmem_default=16777216

## in addition you can try increasing the receive buffer size
# sudo ethtool -G <sensor_network_interface> rx 2048

## increase the MTU size to 9000 to decrease fragmentation
# sudo ifconfig <sensor_network_interface> mtu 9000

0 comments on commit 55519ed

Please sign in to comment.