https://github.com/unity-technologies/ros-tcp-connector
https://github.com/unity-technologies/ros-tcp-connector
robot robotics robotics-development robotics-simulation ros simulation unity unity-robotics
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/unity-technologies/ros-tcp-connector
- Owner: Unity-Technologies
- License: apache-2.0
- Created: 2020-09-22T20:40:02.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-05-10T13:30:29.000Z (about 1 year ago)
- Last Synced: 2025-04-05T06:09:01.142Z (2 months ago)
- Topics: robot, robotics, robotics-development, robotics-simulation, ros, simulation, unity, unity-robotics
- Language: C#
- Homepage:
- Size: 46.1 MB
- Stars: 327
- Watchers: 15
- Forks: 98
- Open Issues: 37
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# ROS TCP Connector
[](https://github.com/Unity-Technologies/ROS-TCP-Connector/releases)
[](LICENSE.md)
---
We're currently working on lots of things! Please take a short moment fill out our [survey](https://unitysoftware.co1.qualtrics.com/jfe/form/SV_0ojVkDVW0nNrHkW) to help us identify what products and packages to build next.
---
## Introduction
This repository contains two Unity packages: the ROS TCP Connector, for sending/receiving messages from ROS, and the Visualizations Package, for adding visualizations of incoming and outgoing messages in the Unity scene.
## Installation
1. Using Unity 2020.2 or later, open the Package Manager from `Window` -> `Package Manager`.
2. In the Package Manager window, find and click the + button in the upper lefthand corner of the window. Select `Add package from git URL....`
3. Enter the git URL for the desired package. Note: you can append a version tag to the end of the git url, like `#v0.4.0` or `#v0.5.0`, to declare a specific package version, or exclude the tag to get the latest from the package's `main` branch.
1. For the ROS-TCP-Connector, enter `https://github.com/Unity-Technologies/ROS-TCP-Connector.git?path=/com.unity.robotics.ros-tcp-connector`.
2. For Visualizations, enter `https://github.com/Unity-Technologies/ROS-TCP-Connector.git?path=/com.unity.robotics.visualizations`.
4. Click `Add`.
To install from a local clone of the repository, see [installing a local package](https://docs.unity3d.com/Manual/upm-ui-local.html) in the Unity manual.
## Tutorials
This Unity package provides four main features:
- ROSConnection: A component that sets up communication between ROS and Unity. See the [Unity Robotics Hub](https://github.com/Unity-Technologies/Unity-Robotics-Hub/blob/main/tutorials/ros_unity_integration/README.md) for information and tutorials.
- [Message Generation](MessageGeneration.md): A tool to generate C# classes for ROS message types.
- Visualizations: A suite of default configurations and APIs to visualize incoming and outgoing information from ROS.
- See the [Nav2 SLAM Example](https://github.com/Unity-Technologies/Robotics-Nav2-SLAM-Example) for tutorials on using the Visualizations Package!
- You can also view the package's [Usage Information](com.unity.robotics.visualizations/Documentation~/README.md) for more details on using the package in your own project.
- [ROSGeometry](ROSGeometry.md): A set of extensions that convert geometries between Unity and other coordinate frames.
## ROS#
Special thanks to the Siemens [ROS# Project Team]( https://github.com/siemens/ros-sharp/wiki/Info_Acknowledgements) for driving the ROS-Unity Integration Open Source since 2017.
## Community and Feedback
The Unity Robotics projects are open-source and we encourage and welcome contributions.
If you wish to contribute, be sure to review our [contribution guidelines](CONTRIBUTING.md)
and [code of conduct](CODE_OF_CONDUCT.md).
## Support
For questions or discussions about Unity Robotics package installations or how to best set up and integrate your robotics projects, please create a new thread on the [Unity Robotics forum](https://forum.unity.com/forums/robotics.623/) and make sure to include as much detail as possible.
For feature requests, bugs, or other issues, please file a [GitHub issue](https://github.com/Unity-Technologies/ROS-TCP-Connector/issues) using the provided templates and the Robotics team will investigate as soon as possible.
For any other questions or feedback, connect directly with the
Robotics team at [[email protected]](mailto:[email protected]).
## License
[Apache License 2.0](LICENSE)