Water Linked UGPS API

waterlinked_ugps is a Python library and ROS 2 driver designed to integrate with Water Linked UGPS devices. Get started with waterlinked_ugps by installing the project, exploring the implemented library, or by launching the ROS 2 driver.

⚠️ This project is not affiliated with or maintained by Water Linked. Please refer to the Water Linked GitHub Organization for all official software.

Installation

To install waterlinked_dvl, first clone the repository to the src/ directory of your ROS 2 workspace

git clone git@github.com:evan-palmer/waterlinked_ugps.git

Then install the project dependencies using rosdep

rosdep install --from paths src -y --ignore-src

Finally, build the workspace using colcon

colcon build && source install/setup.bash

Usage

Prior to using waterlinked_ugps, first ensure that you can successfully connect to your respective device. For additional information, please refer to the Water Linked UGPS documentation. After verifying the network connection, the UGPS ROS 2 driver can be launched with the following command:

ros2 launch waterlinked_ugps_driver ugps.launch.yaml

Getting help

If you have questions regarding usage of waterlinked_ugps or regarding contributing to this project, please ask a question on our Discussions board.

License

waterlinked_ugps is released under the MIT license.