# imrclab/crazyswarm2 architecture

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

- Interactive diagram: https://gitdiagram.com/imrclab/crazyswarm2
- Repository: https://github.com/imrclab/crazyswarm2

## Overview

##### Project type and purpose
- This is a multi-package ROS 2 “stack” (monorepo) for driving and simulating Bitcraze Crazyflie multirotor robots.
- Core packages:
- crazyflie: C++ ROS 2 node to talk to real Crazyflie hardware
- crazyflie_interfaces: custom ROS 2 message & service definitions
- crazyflie_py: Python client library & nodes
- crazyflie_sim: simulation backends (pinocchio, dynobench, neuralswarm) and visualization
- crazyflie_examples: demo nodes & launch files
- ros_ws: a ROS 1-style workspace that pulls everything together under a “crazyswarm” meta-package

##### File structure
- Top-level directories map to ROS 2 packages. Each has its own CMakeLists.txt and package.xml.
- crazyflie: folder with config/*.yaml, launch/*.py, URDF models, C++ src/scripts.
- crazyflie_interfaces: your pub/sub & srv definitions that decouple client and server.
- crazyflie_py: Python API & helper nodes (genericJoystick, uav_trajectory).
- crazyflie_sim: backends + sim node crazyflie_sil + visualization scripts.
- crazyflie_examples: sample ROS 2 nodes that import everything above to run “hello_world”, SLAM, Nav2 demos.
- ros_ws: “crazyswarm” ROS 1/ROS 2 hybrid wrapper with launch files and sequence CSVs.
- systemtests: end-to-end Python tests + plotting helpers.

##### README insights
- Confirms ROS 2 based stack, multiple CI pipelines for ROS 2 distributions.
- Central docs reference has overview, “internals” section for architectural guidance.

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% External Systems
    MotionCapture["Motion Capture"]:::ext
    Nav2["Nav2"]:::ext
    Joystick["Joystick"]:::ext
    BlenderExt["Blender"]:::ext

    %% Client Layer
    subgraph "Client Applications" 
        direction TB
        PythonLib["Python Client Library"]:::clients
        Teleop["Teleop Nodes"]:::clients
        Examples["Example Apps"]:::clients
    end

    %% Interface Definitions
    Interface["crazyflie_interfaces\n(Messages & Services)"]:::interface

    %% Core Server / Simulation
    subgraph "Core Communication Layer"
        direction TB
        subgraph "Hardware Node" 
            CFServerCPP["crazyflie_server (C++)"]:::core
            CFServerPy["crazyflie_server (Python)"]:::core
        end
        subgraph "Simulation Node" 
            CFSim["crazyflie_sil"]:::core
            subgraph "Backends"
                Backend["Driver Backends"]:::core
            end
            subgraph "Visualization"
                RViz["RViz"]:::core
                Blender["Blender"]:::core
            end
        end
    end

    %% Resources
    subgraph "Resources"
        Config["Configuration (YAML)"]:::config
        URDF["URDF Models"]:::config
    end

    %% Meta-package
    Crazyswarm["ros_ws/crazyswarm"]:::clients

    %% Connections
    MotionCapture -->|"publishes pose"| Interface
    Nav2 -->|"nav goals"| Interface
    Joystick -->|"cmd_vel"| Teleop
    BlenderExt -->|"external viz"| Visualization

    PythonLib -->|"/arm, /takeoff Services"| Interface
    Teleop -->|"/cmd_vel Topic"| Interface
    Examples -->|"/full_state, /trajectory"| Interface

    Interface -->|"/full_state Topic"| CFServerCPP
    Interface -->|"/hover, /velocity Services"| CFServerCPP
    Interface -->|"/full_state Topic"| CFServerPy
    Interface -->|"/hover, /velocity Services"| CFServerPy

    Interface -->|"/full_state Topic"| CFSim
    Interface -->|"/hover, /velocity Services"| CFSim

    CFSim -->|calls| Backend
    CFSim -->|publishes state| RViz
    CFSim -->|publishes state| Blender

    CFServerCPP -->|"radio to Crazyflie"| CrazyflieHW[(Crazyflie Hardware)]:::core
    CFServerPy -->|"radio to Crazyflie"| CrazyflieHW

    Config --> CFServerCPP
    Config --> CFSim
    URDF --> CFServerCPP
    URDF --> CFSim

    Crazyswarm -->|launch| Examples
    Crazyswarm -->|launch| CFServerCPP
    Crazyswarm -->|launch| CFSim

    %% Click Events
    click CFServerCPP "https://github.com/imrclab/crazyswarm2/blob/main/crazyflie/src/crazyflie_server.cpp"
    click CFServerPy "https://github.com/imrclab/crazyswarm2/blob/main/crazyflie/scripts/crazyflie_server.py"
    click Interface "https://github.com/imrclab/crazyswarm2/tree/main/crazyflie_interfaces/msg/"
    click Interface "https://github.com/imrclab/crazyswarm2/tree/main/crazyflie_interfaces/srv/"
    click PythonLib "https://github.com/imrclab/crazyswarm2/tree/main/crazyflie_py/crazyflie_py/"
    click Teleop "https://github.com/imrclab/crazyswarm2/blob/main/crazyflie_py/crazyflie_py/genericJoystick.py"
    click Teleop "https://github.com/imrclab/crazyswarm2/blob/main/crazyflie_py/crazyflie_py/joystick.py"
    click PythonLib "https://github.com/imrclab/crazyswarm2/blob/main/crazyflie_py/crazyflie_py/uav_trajectory.py"
    click CFSim "https://github.com/imrclab/crazyswarm2/blob/main/crazyflie_sim/crazyflie_sim/crazyflie_sil.py"
    click Backend "https://github.com/imrclab/crazyswarm2/tree/main/crazyflie_sim/crazyflie_sim/backend/"
    click RViz "https://github.com/imrclab/crazyswarm2/blob/main/crazyflie_sim/crazyflie_sim/visualization/rviz.py"
    click Blender "https://github.com/imrclab/crazyswarm2/blob/main/crazyflie_sim/crazyflie_sim/visualization/blender.py"
    click Examples "https://github.com/imrclab/crazyswarm2/tree/main/crazyflie_examples/crazyflie_examples/"
    click Examples "https://github.com/imrclab/crazyswarm2/blob/main/crazyflie_examples/crazyflie_examples/hello_world.py"
    click Examples "https://github.com/imrclab/crazyswarm2/blob/main/crazyflie_examples/crazyflie_examples/arming.py"
    click Examples "https://github.com/imrclab/crazyswarm2/blob/main/crazyflie_examples/crazyflie_examples/cmd_full_state.py"
    click Examples "https://github.com/imrclab/crazyswarm2/blob/main/crazyflie_examples/launch/launch.py"
    click Examples "https://github.com/imrclab/crazyswarm2/blob/main/crazyflie_examples/launch/multiranger_nav2_launch.py"
    click Config "https://github.com/imrclab/crazyswarm2/blob/main/crazyflie/config/*.yaml"
    click Config "https://github.com/imrclab/crazyswarm2/blob/main/crazyflie/config/config.rviz"
    click URDF "https://github.com/imrclab/crazyswarm2/blob/main/crazyflie/urdf/crazyflie_description.urdf"
    click Crazyswarm "https://github.com/imrclab/crazyswarm2/tree/main/ros_ws/src/crazyswarm/"
    click Crazyswarm "https://github.com/imrclab/crazyswarm2/tree/main/ros_ws/src/crazyswarm/launch/"

    %% Styles
    classDef core fill:#add8e6,stroke:#333,stroke-width:1px
    classDef interface fill:#90ee90,stroke:#333,stroke-width:1px
    classDef clients fill:#ffff99,stroke:#333,stroke-width:1px
    classDef config fill:#d3d3d3,stroke:#333,stroke-width:1px
    classDef ext fill:#ffa500,stroke:#333,stroke-width:1px
```
