Overview

ROS# is a set of open-source software libraries and tools in C# for communicating with ROS from .NET applications, in particular Unity. With ROS#, developers can effortlessly create .NET applications that communicate with ROS nodes, subscribe to and publish topics, handle actions and services, and interact with ROS messages. This enables the development of robotics applications, simulations, and automation systems within the .NET ecosystem.

Here are some showcases illustrating what can be done with ROS#. The community provided various other application examples for ROS# here.

Installation

ROS# can be used with Unity Engine and/or with any compatible .NET project, see platform support and external dependencies.

• For Unity Integration: Unity Package Manager

  1. In Unity Package Manager, click the “Add package from git URL” option at the top left corner.
  2. Paste the following URL: https://github.com/siemens/ros-sharp.git?path=/com.siemens.ros-sharp

For more installation options, detailed instractions, and getting started see wiki: Installing and Configuring ROS# for Unity.

• For .NET Projects: NuGet Gallery

  1. Head to the NuGet page.
  2. Install the required packages individually from NuGet.

For more installation options, detailed instractions, and getting started see wiki: Installing and Configuring ROS# for .NET.

Platform Support

• The ROS# dependencies require .NET 8 and Visual Studio 2022 or higher.
• The Unity package has been developed with Unity Version 2022.3.17f1 (LTS) and should also be compatible with older versions.

  For Unity versions below 2022.3: See wiki.

Repository Structure

Below is an overview of the main directories and their purposes:

• com.siemens.ros-sharp/: Contains the custom Unity UPM package for integrating ROS# into Unity projects. The package includes the whole ROS# .NET solution, as well as Unity specific scripts, external dependencies, and samples. This folder follows a planned layout as Unity recommends.
  • Runtime/: Core ROS# .NET scripts and components for Unity integration.
  • Editor/: Unity specific editor scripts for mainly UI extensions.
  • Plugins/: External dependencies with specific versions.
  • Samples~/: Example samples that need to be imported through the package manager window. For more info about example scenes and reference code, see wiki.
• Libraries/: .NET solution containing the core ROS# libraries and tools for communicating with ROS.
  • RosBridgeClient/: Core ROS# .NET library for communicating with ROS via websockets.
  • MessageGeneration/: Tools for generating C# classes from ROS message definitions, including messages, actions, and services with both ROS1/2 support.
  • Urdf/: Library for parsing URDF files and creating Unity GameObjects.
  • PostBuildEvents/: OS specific post build scripts. Please see post build events for more information.
• ROS Packages/: ROS packages that are used by ROS# for tutorial, testing and demonstration purposes.

Further Info

• Read the Wiki
• External Dependencies
• Project Team, Contributors and Acknowledgements
• Contact the Project Team

© Siemens AG, 2017-2024

Contributions to ROS# are always welcome!

Did you find a bug?

• Ensure the bug was not already reported by searching the open issues.
• Check the closed issues for solutions to problems other users had.
• If you’re unable to find an issue addressing your problem, open a new issue.
• Be sure to include a clear title and a clear description, log files, screenshots, code samples and/or executables so that we can understand and reproduce the problem.

Do you want to contribute code?

• Before opening a pull request, please check:
  • Is your contribution in accordance with the Developer Documentation?
  • Is your contribution hardware-independent?
  • Do all files of your contribution have a proper license header?
• If you are unsure about your contribution, please contact the project team.
• When opening a pull request please provide a clear description of your contribution.
• Include the relevant issue number if applicable.

Do you want to contribute documentation?

Please send your suggested documentation, preferably in markdown format, to the project team.

Do you have questions?

• Ensure that the Wiki does not answer your question.
• If you are unable to find your answer in the Wiki, contact the project team.

Thank you!

© Siemens AG, 2017-2024