# unity-technologies/ros-tcp-connector architecture

> Architecture diagram of the GitHub repository unity-technologies/ros-tcp-connector, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-11-17). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/unity-technologies/ros-tcp-connector
- Repository: https://github.com/unity-technologies/ros-tcp-connector

## Overview

##### Project type and purpose
- This is a Unity-based open-source robotics integration toolkit, delivered as two UPM packages:
- ROS TCP Connector – runtime code and editor tooling for sending/receiving ROS messages over a TCP link
- Visualizations Package – runtime scripts and prefabs for visualizing ROS messages in the Unity scene
- There is also a sample Unity project (TestRosTcpConnector) that demonstrates using the connector in a Unity scene.

##### File structure
- Top-level directories and files:
- Root contains project-wide configuration (.editorconfig, .gitignore, workflows), documentation (README.md, MessageGeneration.md, ROSGeometry.md), CONTRIBUTING, LICENSE.
- TestRosTcpConnector – a standalone Unity project with Assets, Packages, ProjectSettings. It hosts a sample scene and references the two packages.
- com.unity.robotics.ros-tcp-connector – Editor, Runtime, Tests subfolders implementing the ROS connection, message generation, message registry, TCP connector, ROSGeometry extensions.
- com.unity.robotics.visualizations – Editor, Runtime, Resources, ExampleVisualizers, Drawing3d, DefaultVisualizers providing settings editors, visualizer scripts, shaders, materials, prefabs.
- Pattern: clear separation between Editor-only code (message generation tools, settings editors) and Runtime code (message serialization, TCP connection, visualizers).
- Presence of package.json files means Unity Package Manager is used. Tests folders signal unit and integration tests.

##### README for additional insights
- Key features:
- ROSConnection component (entry point at runtime)
- Message Generation tool (generates C# classes from ROS msg/srv definitions)
- Visualizations suite (default API for rendering messages)
- ROSGeometry extensions (coordinate conversions)
- Supported targets: ROS1 (melodic, noetic), ROS2 (foxy, galactic), Unity 2020.2+

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Editor Tooling
    subgraph "Editor Tooling"
        direction TB
        MG["Message Generation UI"]:::editor
        RSE["ROSSettingsEditor"]:::editor
        REA["RosEditorAnalytics"]:::editor
    end

    %% Runtime Core
    subgraph "Runtime Core"
        direction TB
        RC["ROSConnection"]:::runtime
        subgraph "TCP Submodule"
            direction TB
            OMS["OutgoingMessageSender"]:::runtime
            TMS["TopicMessageSender"]:::runtime
            MP["MessagePool"]:::runtime
            TFS["TFSystem"]:::runtime
        end
        subgraph "Message Pipeline"
            direction TB
            MSR["MessageSerializer"]:::runtime
            MSD["MessageDeserializer"]:::runtime
            MR["MessageRegistry"]:::runtime
        end
        GMT["Generated Message Types"]:::runtime
        subgraph "ROSGeometry Extensions"
            direction TB
            CS["CoordinateSpaces"]:::runtime
            V3["ROSVector3"]:::runtime
            QTN["ROSQuaternion"]:::runtime
            GC["GeometryCompass"]:::runtime
        end
    end

    %% Visualizations Package
    subgraph "Visualizations Package"
        direction TB
        subgraph "Editor"
            direction TB
            VE["Visualizer Settings UI"]:::viz
        end
        subgraph "Runtime Visualizers"
            direction TB
            DV["DefaultVisualizers"]:::viz
            D3["Drawing3d"]:::viz
            EV["ExampleVisualizers"]:::viz
            CScripts["Core Visualizer Scripts & Factory"]:::viz
            VRes["Resources/Settings"]:::viz
            Prefabs["Default & Empty Visualization Prefabs"]:::viz
        end
    end

    %% Sample Project
    SP["Sample Unity Project"]:::sample

    %% External ROS
    ER["External ROS TCP Endpoint"]:::external

    %% Relationships
    MG -->|"generates"| GMT
    RSE --> MG
    REA --> MG

    RC --> OMS
    RC --> TMS
    RC --> MP
    RC --> TFS

    OMS -->|"serialize"| MSR
    TMS --> MSR
    MSR -->|"to bytes"| ER
    ER -->|"tcp data"| RC
    RC --> MSD
    MSD --> MR
    MR --> DV
    MR --> EV
    MR --> CScripts

    CS --> RC
    V3 --> RC
    QTN --> RC
    GC --> RC

    SP --> RC
    SP --> DV
    SP --> EV

    %% Click Events
    click SP "https://github.com/unity-technologies/ros-tcp-connector/tree/main/TestRosTcpConnector/"
    click MG "https://github.com/unity-technologies/ros-tcp-connector/tree/main/com.unity.robotics.ros-tcp-connector/Editor/MessageGeneration/"
    click RSE "https://github.com/unity-technologies/ros-tcp-connector/blob/main/com.unity.robotics.ros-tcp-connector/Editor/ROSSettingsEditor.cs"
    click REA "https://github.com/unity-technologies/ros-tcp-connector/blob/main/com.unity.robotics.ros-tcp-connector/Editor/RosEditorAnalytics.cs"
    click RC "https://github.com/unity-technologies/ros-tcp-connector/blob/main/com.unity.robotics.ros-tcp-connector/Runtime/TcpConnector/ROSConnection.cs"
    click OMS "https://github.com/unity-technologies/ros-tcp-connector/blob/main/com.unity.robotics.ros-tcp-connector/Runtime/TcpConnector/OutgoingMessageSender.cs"
    click TMS "https://github.com/unity-technologies/ros-tcp-connector/blob/main/com.unity.robotics.ros-tcp-connector/Runtime/TcpConnector/TopicMessageSender.cs"
    click MP "https://github.com/unity-technologies/ros-tcp-connector/blob/main/com.unity.robotics.ros-tcp-connector/Runtime/TcpConnector/MessagePool.cs"
    click TFS "https://github.com/unity-technologies/ros-tcp-connector/blob/main/com.unity.robotics.ros-tcp-connector/Runtime/TcpConnector/TFSystem.cs"
    click MSR "https://github.com/unity-technologies/ros-tcp-connector/blob/main/com.unity.robotics.ros-tcp-connector/Runtime/MessageGeneration/MessageSerializer.cs"
    click MSD "https://github.com/unity-technologies/ros-tcp-connector/blob/main/com.unity.robotics.ros-tcp-connector/Runtime/MessageGeneration/MessageDeserializer.cs"
    click MR "https://github.com/unity-technologies/ros-tcp-connector/blob/main/com.unity.robotics.ros-tcp-connector/Runtime/MessageGeneration/MessageRegistry.cs"
    click GMT "https://github.com/unity-technologies/ros-tcp-connector/tree/main/com.unity.robotics.ros-tcp-connector/Runtime/Messages/"
    click CS "https://github.com/unity-technologies/ros-tcp-connector/blob/main/com.unity.robotics.ros-tcp-connector/Runtime/ROSGeometry/CoordinateSpaces.cs"
    click V3 "https://github.com/unity-technologies/ros-tcp-connector/blob/main/com.unity.robotics.ros-tcp-connector/Runtime/ROSGeometry/ROSVector3.cs"
    click QTN "https://github.com/unity-technologies/ros-tcp-connector/blob/main/com.unity.robotics.ros-tcp-connector/Runtime/ROSGeometry/ROSQuaternion.cs"
    click GC "https://github.com/unity-technologies/ros-tcp-connector/blob/main/com.unity.robotics.ros-tcp-connector/Runtime/ROSGeometry/GeometryCompass.cs"
    click VE "https://github.com/unity-technologies/ros-tcp-connector/tree/main/com.unity.robotics.visualizations/Editor/"
    click DV "https://github.com/unity-technologies/ros-tcp-connector/tree/main/com.unity.robotics.visualizations/Runtime/DefaultVisualizers/"
    click D3 "https://github.com/unity-technologies/ros-tcp-connector/tree/main/com.unity.robotics.visualizations/Runtime/Drawing3d/"
    click EV "https://github.com/unity-technologies/ros-tcp-connector/tree/main/com.unity.robotics.visualizations/Runtime/ExampleVisualizers/"
    click CScripts "https://github.com/unity-technologies/ros-tcp-connector/tree/main/com.unity.robotics.visualizations/Runtime/Scripts/"
    click VRes "https://github.com/unity-technologies/ros-tcp-connector/tree/main/com.unity.robotics.visualizations/Resources/VisualizerSettings/"
    click Prefabs "https://github.com/unity-technologies/ros-tcp-connector/blob/main/com.unity.robotics.visualizations/DefaultVisualizationSuite.prefab"

    %% Styles
    classDef editor fill:#BBDEFB,stroke:#1E88E5,color:#0D47A1;
    classDef runtime fill:#C8E6C9,stroke:#43A047,color:#1B5E20;
    classDef viz fill:#FFE0B2,stroke:#FB8C00,color:#E65100;
    classDef external fill:#E0E0E0,stroke:#757575,color:#424242;
    classDef sample fill:#D1C4E9,stroke:#673AB7,color:#311B92;
```
