# sh33p-cell/eyrc architecture

> Architecture diagram of the GitHub repository sh33p-cell/eyrc, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-06). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/sh33p-cell/eyrc
- Repository: https://github.com/sh33p-cell/eyrc

## Overview

Hola The Explorer is a ROS 2 robotics project spanning MuJoCo simulation and staged holonomic-robot tasks. The software workflow runs a simulation and camera, detects arena features and converts image coordinates to world coordinates, then controls robots through shape-tracing or multi-robot navigation and planning. The graph emphasizes the sampled ROS nodes and their documented topic/service interfaces; later collaboration challenges described in the README are not represented by sampled implementation paths, so their internal flow is not inferred.

Main entry points: [`Software/workspace/src/hb_description/launch`](https://github.com/sh33p-cell/eyrc/tree/main/Software/workspace/src/hb_description/launch) (Task launches), [`Software/workspace/src/task_1a/task_1a/camera_detection.py`](https://github.com/sh33p-cell/eyrc/blob/main/Software/workspace/src/task_1a/task_1a/camera_detection.py) (Checkpoint vision), [`Software/workspace/src/task_1c/task_1c/sim_control.py`](https://github.com/sh33p-cell/eyrc/blob/main/Software/workspace/src/task_1c/task_1c/sim_control.py) (Shape controller), [`Software/workspace/src/hb_description/bin`](https://github.com/sh33p-cell/eyrc/tree/main/Software/workspace/src/hb_description/bin) (Camera stream)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_simulation["Simulation and cameras"]
  node_launch["Task launches"]
  node_sim["MuJoCo bridge"]
  node_camera["Camera stream"]
end

subgraph group_perception["Perception and interfaces"]
  node_vision["Checkpoint vision"]
  node_pixel["Pixel mapping"]
  node_interfaces["Shape interfaces"]
end

subgraph group_control["Robot control"]
  node_ik["Inverse kinematics"]
  node_cmdpub["Velocity publisher"]
  node_shapecontrol["Shape controller<br/>[sim_control.py]"]
  node_shape_service["Shape service"]
end

subgraph group_planning["Navigation and planning"]
  node_nav2a["Multi-robot follower<br/>[path_follower.py]"]
  node_planner2b["Obstacle planner<br/>[path_planner.py]"]
  node_follower2b["Planned-path follower<br/>[path_follower.py]"]
  node_planner2c["Collision planner<br/>[path_planner.py]"]
  node_follower2c["Coordinated follower<br/>[path_follower.py]"]
end

node_user(("Operator"))
node_robot_topics["Robot ROS topics"]

node_user -->|"starts tasks"| node_launch
node_launch -->|"launches bridge"| node_sim
node_launch -->|"launches camera"| node_camera
node_camera -->|"streams frames"| node_vision
node_vision -->|"requests coordinates"| node_pixel
node_vision -->|"uses pixel service"| node_interfaces
node_shapecontrol -->|"requests shape"| node_interfaces
node_shapecontrol -->|"calls shape service"| node_shape_service
node_cmdpub -->|"publishes velocity"| node_ik
node_ik -->|"publishes wheel commands"| node_robot_topics
node_nav2a -->|"reads odometry; sends wheels"| node_robot_topics
node_planner2b -->|"reads odometry; publishes plans"| node_robot_topics
node_follower2b -->|"reads plans and odometry; sends wheels"| node_robot_topics
node_planner2c -->|"reads odometry; publishes plans"| node_robot_topics
node_follower2c -->|"reads plans and odometry; sends wheels"| node_robot_topics

click node_launch "https://github.com/sh33p-cell/eyrc/tree/main/Software/workspace/src/hb_description/launch"
click node_sim "https://github.com/sh33p-cell/eyrc/tree/main/Software/workspace/src/hb_description/bin"
click node_camera "https://github.com/sh33p-cell/eyrc/tree/main/Software/workspace/src/hb_description/bin"
click node_vision "https://github.com/sh33p-cell/eyrc/blob/main/Software/workspace/src/task_1a/task_1a/camera_detection.py"
click node_pixel "https://github.com/sh33p-cell/eyrc/tree/main/Software/workspace/src/task_1a"
click node_interfaces "https://github.com/sh33p-cell/eyrc/tree/main/Software/workspace/src/shape_interface"
click node_ik "https://github.com/sh33p-cell/eyrc/blob/main/Software/workspace/src/task_1b/task_1b/inverse_kinematics.py"
click node_cmdpub "https://github.com/sh33p-cell/eyrc/tree/main/Software/workspace/src/task_1b"
click node_shapecontrol "https://github.com/sh33p-cell/eyrc/blob/main/Software/workspace/src/task_1c/task_1c/sim_control.py"
click node_shape_service "https://github.com/sh33p-cell/eyrc/tree/main/Software/workspace/src/task_1c/bin"
click node_nav2a "https://github.com/sh33p-cell/eyrc/blob/main/Software/workspace/src/task_2a/task_2a/path_follower.py"
click node_planner2b "https://github.com/sh33p-cell/eyrc/blob/main/Software/workspace/src/task_2b/task_2b/path_planner.py"
click node_follower2b "https://github.com/sh33p-cell/eyrc/blob/main/Software/workspace/src/task_2b/task_2b/path_follower.py"
click node_planner2c "https://github.com/sh33p-cell/eyrc/blob/main/Software/workspace/src/task_2c/task_2c/path_planner.py"
click node_follower2c "https://github.com/sh33p-cell/eyrc/blob/main/Software/workspace/src/task_2c/task_2c/path_follower.py"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_launch,node_sim,node_camera toneBlue
class node_vision,node_pixel,node_interfaces toneAmber
class node_ik,node_cmdpub,node_shapecontrol,node_shape_service toneMint
class node_nav2a,node_planner2b,node_follower2b,node_planner2c,node_follower2c toneRose
class node_user,node_robot_topics toneIndigo
```

## Components

### Simulation and cameras

- [Task launches](https://github.com/sh33p-cell/eyrc/tree/main/Software/workspace/src/hb_description/launch): `Software/workspace/src/hb_description/launch`
- [MuJoCo bridge](https://github.com/sh33p-cell/eyrc/tree/main/Software/workspace/src/hb_description/bin): `Software/workspace/src/hb_description/bin`
- [Camera stream](https://github.com/sh33p-cell/eyrc/tree/main/Software/workspace/src/hb_description/bin): `Software/workspace/src/hb_description/bin`

### Perception and interfaces

- [Checkpoint vision](https://github.com/sh33p-cell/eyrc/blob/main/Software/workspace/src/task_1a/task_1a/camera_detection.py): `Software/workspace/src/task_1a/task_1a/camera_detection.py`
- [Pixel mapping](https://github.com/sh33p-cell/eyrc/tree/main/Software/workspace/src/task_1a): `Software/workspace/src/task_1a`
- [Shape interfaces](https://github.com/sh33p-cell/eyrc/tree/main/Software/workspace/src/shape_interface): `Software/workspace/src/shape_interface`

### Robot control

- [Inverse kinematics](https://github.com/sh33p-cell/eyrc/blob/main/Software/workspace/src/task_1b/task_1b/inverse_kinematics.py): `Software/workspace/src/task_1b/task_1b/inverse_kinematics.py`
- [Velocity publisher](https://github.com/sh33p-cell/eyrc/tree/main/Software/workspace/src/task_1b): `Software/workspace/src/task_1b`
- [Shape controller](https://github.com/sh33p-cell/eyrc/blob/main/Software/workspace/src/task_1c/task_1c/sim_control.py): `Software/workspace/src/task_1c/task_1c/sim_control.py`
- [Shape service](https://github.com/sh33p-cell/eyrc/tree/main/Software/workspace/src/task_1c/bin): `Software/workspace/src/task_1c/bin`

### Navigation and planning

- [Multi-robot follower](https://github.com/sh33p-cell/eyrc/blob/main/Software/workspace/src/task_2a/task_2a/path_follower.py): `Software/workspace/src/task_2a/task_2a/path_follower.py`
- [Obstacle planner](https://github.com/sh33p-cell/eyrc/blob/main/Software/workspace/src/task_2b/task_2b/path_planner.py): `Software/workspace/src/task_2b/task_2b/path_planner.py`
- [Planned-path follower](https://github.com/sh33p-cell/eyrc/blob/main/Software/workspace/src/task_2b/task_2b/path_follower.py): `Software/workspace/src/task_2b/task_2b/path_follower.py`
- [Collision planner](https://github.com/sh33p-cell/eyrc/blob/main/Software/workspace/src/task_2c/task_2c/path_planner.py): `Software/workspace/src/task_2c/task_2c/path_planner.py`
- [Coordinated follower](https://github.com/sh33p-cell/eyrc/blob/main/Software/workspace/src/task_2c/task_2c/path_follower.py): `Software/workspace/src/task_2c/task_2c/path_follower.py`

### Other components

- **Operator**
- **Robot ROS topics**

## Connections

- Operator → Task launches: starts tasks (evidence: `ReadMe.md`)
- Task launches → MuJoCo bridge: launches bridge (evidence: `Software/workspace/src/hb_description/launch/task1b.launch.py`)
- Task launches → Camera stream: launches camera (evidence: `Software/workspace/src/hb_description/launch/task1b.launch.py`)
- Camera stream → Checkpoint vision: streams frames (evidence: `Software/workspace/src/task_1a/task_1a/camera_detection.py`)
- Checkpoint vision → Pixel mapping: requests coordinates (evidence: `Software/workspace/src/task_1a/task_1a/camera_detection.py`)
- Checkpoint vision → Shape interfaces: uses pixel service (evidence: `Software/workspace/src/task_1a/task_1a/camera_detection.py`)
- Shape controller → Shape interfaces: requests shape (evidence: `Software/workspace/src/task_1c/task_1c/sim_control.py`)
- Shape controller → Shape service: calls shape service (evidence: `Software/workspace/src/task_1c/task_1c/sim_control.py`)
- Velocity publisher → Inverse kinematics: publishes velocity (evidence: `Software/workspace/src/task_1b/task_1b/inverse_kinematics.py`)
- Inverse kinematics → Robot ROS topics: publishes wheel commands (evidence: `Software/workspace/src/task_1b/task_1b/inverse_kinematics.py`)
- Multi-robot follower → Robot ROS topics: reads odometry; sends wheels (evidence: `Software/workspace/src/task_2a/task_2a/path_follower.py`)
- Obstacle planner → Robot ROS topics: reads odometry; publishes plans (evidence: `Software/workspace/src/task_2b/task_2b/path_planner.py`)
- Planned-path follower → Robot ROS topics: reads plans and odometry; sends wheels (evidence: `Software/workspace/src/task_2b/task_2b/path_follower.py`)
- Collision planner → Robot ROS topics: reads odometry; publishes plans (evidence: `Software/workspace/src/task_2c/task_2c/path_planner.py`)
- Coordinated follower → Robot ROS topics: reads plans and odometry; sends wheels (evidence: `Software/workspace/src/task_2c/task_2c/path_follower.py`)
