Skip to content

Latest commit

 

History

History
91 lines (66 loc) · 4.99 KB

README.md

File metadata and controls

91 lines (66 loc) · 4.99 KB
Raw

NatNet 4 ROS driver

GitHub Action Status

DOI

Note

For usage remember to check your Client IP and Server IP settings. The server (optitrack PC) is still on dynamic IP so might change over time. The Client IP is laptop / workstation specific.

Introduction

This package contains a ROS driver for the NatNet protocol used by the OptiTrack motion capture system. It supports NatNet versions 4.0 (Motive 2.2 and higher). The NatNet SDK provided by the optitrack can be found here. It will be downloaded under deps/NatnetSDK while building it for the first time. NatNet protocol is used for streaming live motion capture data (rigid bodies, skeletons etc) across the shared network.

This package is only tested with the Natnet 4.0 and ROS noetic but probably will work with the older versions of both as well.

Current Features:

  • Stable and with more functionality than mocap_optitrack
  • Rigid bodies are published as geometry_msgs/PoseStamped under name given in the Motive, i.e /natnet_ros/<body-name>/pose. Plus those are also broadcasting as tf frame for rviz
  • Markers of the rigid bodies are published ad geometry_msgs/PointStamped unuder the name /natnet_ros/<body-name>/marker#/pose
  • Unlabeled markers with the initial position and the name mentione in the /config/initiate.yamlare published as geometry_msgs/PoseStamped unuder the name /natnet_ros/<name-in-config-file>/pose. Plus those are also broadcasting as tf frame for rviz. The marker position is updated based on Iterative closest point (nearest neighbour)
  • Unlabled markers can be also published as sensor_msgs/PointCloud
  • Different options for publishing and logging the data

Work under progress:

  • Include Skeleton and other devices in the system to make it package as whole.
  • Considering position and orientation for similar marker configurations (at least 3 markers)
  • Considering compensation of time delay (~5-6ms) to the ROS time stamp.
  • Adding an option for the axis orientation (Z UP or Y UP)
  • Creating package for ROS2.
  • Implement CI-CD and Issue templete.

How to use it

Building the package

requirements

sudo apt install -y ros-$ROS_DISTRO-tf2* wget

Keep your system connected to the internet while building the package for the first time.

cd ~/catkin_ws/src
git clone https://github.com/L2S-lab/natnet_ros_cpp
cd ..
catkin_build  #OR catkin_make
. devel/setup.bash
roslaunch natnet_ros_cpp natnet_ros.launch

Setup the Motive for this package

  • Disable the firewall for the network on which the data is being published.
  • Open the Motive app.
  • In the motive app, open the streaming panel.
  • Disable the other streaming Engines like VRPN, Trackd etc.
  • Under the OptiTrack Streaming Engine, turn on the Broadcast Frame.
  • Select the correct IP address in the Local Interface.
  • Select the Up Axis as Z.

Here is an example of how your streaming settings should look.

alt text

Understanding the launch file

Launch file natnet_ros.launch contains the several configurable arguments. The details are mentioned in the launch file. Following are several important argument for the connection and the data transfer. Other connection arguments are for the advanced option.

  • serverIP : The IP address of the host PC. (The one selected in the Local Interface in Motive app)
  • clientIP : The IP address of the PC on which the file will be launched
  • serverType : Two possible options, multicast and unicast

Publishing the single marker

It is possible to track the single marker as a rigid body with constant orientation. Go to the config/initiate.yaml It is suggested to make a copy of the file and rename the new file. The file contains the details on what to modify.

The question might arise on how to check the position of the single marker. For that, you can log the frames of the incoming data in the terminal. To do so, enable the log_frames in the launch file.

After configuring the initiate.yaml, in the launch file, enable the pub_individual_marker. Change the name of the config file in the argument conf_file if needed and launch the file.

Replacing existing package

You can easily replace the current package with this package. In the natnet_ros.launch change the name of node to the node you currently using. For an example, If you are using the vrpn_client_node changes are following

<node pkg="natnet_ros_cpp" type="natnet_ros_cpp" name="vrpn_client_node" output="screen" >

Citation

If you use this software, please cite it from CITATION.cff