# muhammadelbialy/gp_2026_autonomous_robot architecture

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

- Interactive diagram: https://gitdiagram.com/muhammadelbialy/gp_2026_autonomous_robot
- Repository: https://github.com/muhammadelbialy/gp_2026_autonomous_robot

## Overview

This repository is a ROS 2 differential-drive robot stack, with ESP32 firmware and ROS packages for odometry, IMU data, robot description, sensor bringup, and SLAM. The principal workflow is to read serial encoder/IMU data, compute and publish odometry, then compose odometry, lidar, and SLAM processes for mapping; robot-description tooling supports visualization. The README documents encoder odometry and IMU integration, while launch files expose lidar and SLAM. Some topic-level connections and firmware protocol details are not shown, so those links are omitted or marked unverified.

Main entry points: [`src/robot_bringup/launch/slam.launch.py`](https://github.com/muhammadelbialy/gp_2026_autonomous_robot/blob/main/src/robot_bringup/launch/slam.launch.py) (SLAM launch), [`src/robot_bringup/launch/full_system.launch.py`](https://github.com/muhammadelbialy/gp_2026_autonomous_robot/blob/main/src/robot_bringup/launch/full_system.launch.py) (Full system launch), [`src/encoder_odometry/src/encoder_odom_node.cpp`](https://github.com/muhammadelbialy/gp_2026_autonomous_robot/blob/main/src/encoder_odometry/src/encoder_odom_node.cpp) (Encoder odometry), [`src/robot_bringup/launch/odom_bringup.launch.py`](https://github.com/muhammadelbialy/gp_2026_autonomous_robot/blob/main/src/robot_bringup/launch/odom_bringup.launch.py) (Odometry launch)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_hardware["Robot hardware"]
  node_esp32["ESP32 firmware"]
end

subgraph group_state["Motion estimation"]
  node_encoder["Encoder odometry"]
  node_odom["Odometry and TF"]
  node_imu["Standalone IMU node<br/>[imu_node.cpp]"]
  node_ekf["EKF filter<br/>[ekf.yaml]"]
end

subgraph group_sensing["Sensors and mapping"]
  node_lidar["Lidar driver<br/>[lidar.launch.py]"]
  node_slam["SLAM toolbox<br/>[slam.launch.py]"]
  node_slam_config["SLAM parameters<br/>[slam_params.yaml]"]
end

subgraph group_runtime["Robot runtime"]
  node_robot_model["Robot description<br/>[final2.xml]"]
  node_model_view["Model visualization"]
  node_odom_bringup["Odometry launch"]
  node_system_launch["Full system launch"]
  node_slam_launch["SLAM launch<br/>[slam.launch.py]"]
  node_imu_launch["IMU launch<br/>[imu.launch.py]"]
  node_rviz["RViz<br/>[odom_config.rviz]"]
end

node_operator(("Operator"))

node_operator -->|"starts"| node_odom_bringup
node_operator -->|"starts"| node_system_launch
node_operator -->|"starts"| node_slam_launch
node_operator -->|"starts"| node_imu_launch
node_esp32 -.->|"serial data"| node_encoder
node_encoder -->|"publishes"| node_odom
node_encoder -->|"publishes"| node_imu
node_system_launch -->|"launches"| node_encoder
node_system_launch -->|"configures"| node_ekf
node_system_launch -->|"launches"| node_rviz
node_odom_bringup -->|"launches"| node_encoder
node_odom_bringup -->|"launches"| node_rviz
node_imu_launch -->|"launches"| node_imu
node_slam_launch -->|"includes"| node_system_launch
node_slam_launch -->|"includes"| node_lidar
node_slam_launch -->|"launches"| node_slam
node_slam_launch -->|"configures"| node_slam_config
node_odom -.->|"feeds"| node_ekf
node_lidar -.->|"scan input"| node_slam
node_operator -->|"starts"| node_model_view
node_model_view -->|"loads"| node_robot_model

click node_esp32 "https://github.com/muhammadelbialy/gp_2026_autonomous_robot/tree/main/firmware"
click node_encoder "https://github.com/muhammadelbialy/gp_2026_autonomous_robot/blob/main/src/encoder_odometry/src/encoder_odom_node.cpp"
click node_odom "https://github.com/muhammadelbialy/gp_2026_autonomous_robot/blob/main/src/encoder_odometry/src/encoder_odom_node.cpp"
click node_imu "https://github.com/muhammadelbialy/gp_2026_autonomous_robot/blob/main/src/imu_pkg/src/imu_node.cpp"
click node_ekf "https://github.com/muhammadelbialy/gp_2026_autonomous_robot/blob/main/src/encoder_odometry/config/ekf.yaml"
click node_lidar "https://github.com/muhammadelbialy/gp_2026_autonomous_robot/blob/main/src/robot_bringup/launch/lidar.launch.py"
click node_slam "https://github.com/muhammadelbialy/gp_2026_autonomous_robot/blob/main/src/robot_bringup/launch/slam.launch.py"
click node_slam_config "https://github.com/muhammadelbialy/gp_2026_autonomous_robot/blob/main/src/robot_bringup/config/slam_params.yaml"
click node_robot_model "https://github.com/muhammadelbialy/gp_2026_autonomous_robot/blob/main/src/my_robot_description/urdf/final2.xml"
click node_model_view "https://github.com/muhammadelbialy/gp_2026_autonomous_robot/blob/main/src/my_robot_description/launch/view_robot.launch.py"
click node_odom_bringup "https://github.com/muhammadelbialy/gp_2026_autonomous_robot/blob/main/src/robot_bringup/launch/odom_bringup.launch.py"
click node_system_launch "https://github.com/muhammadelbialy/gp_2026_autonomous_robot/blob/main/src/robot_bringup/launch/full_system.launch.py"
click node_slam_launch "https://github.com/muhammadelbialy/gp_2026_autonomous_robot/blob/main/src/robot_bringup/launch/slam.launch.py"
click node_imu_launch "https://github.com/muhammadelbialy/gp_2026_autonomous_robot/blob/main/src/imu_pkg/launch/imu.launch.py"
click node_rviz "https://github.com/muhammadelbialy/gp_2026_autonomous_robot/blob/main/src/encoder_odometry/rviz/odom_config.rviz"

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_esp32 toneBlue
class node_encoder,node_odom,node_imu,node_ekf toneAmber
class node_lidar,node_slam,node_slam_config toneMint
class node_robot_model,node_model_view,node_odom_bringup,node_system_launch,node_slam_launch,node_imu_launch,node_rviz toneRose
class node_operator toneIndigo
```

## Components

### Robot hardware

- [ESP32 firmware](https://github.com/muhammadelbialy/gp_2026_autonomous_robot/tree/main/firmware): `firmware`

### Motion estimation

- [Encoder odometry](https://github.com/muhammadelbialy/gp_2026_autonomous_robot/blob/main/src/encoder_odometry/src/encoder_odom_node.cpp): `src/encoder_odometry/src/encoder_odom_node.cpp`
- [Odometry and TF](https://github.com/muhammadelbialy/gp_2026_autonomous_robot/blob/main/src/encoder_odometry/src/encoder_odom_node.cpp): `src/encoder_odometry/src/encoder_odom_node.cpp`
- [Standalone IMU node](https://github.com/muhammadelbialy/gp_2026_autonomous_robot/blob/main/src/imu_pkg/src/imu_node.cpp): `src/imu_pkg/src/imu_node.cpp`
- [EKF filter](https://github.com/muhammadelbialy/gp_2026_autonomous_robot/blob/main/src/encoder_odometry/config/ekf.yaml): `src/encoder_odometry/config/ekf.yaml`

### Sensors and mapping

- [Lidar driver](https://github.com/muhammadelbialy/gp_2026_autonomous_robot/blob/main/src/robot_bringup/launch/lidar.launch.py): `src/robot_bringup/launch/lidar.launch.py`
- [SLAM toolbox](https://github.com/muhammadelbialy/gp_2026_autonomous_robot/blob/main/src/robot_bringup/launch/slam.launch.py): `src/robot_bringup/launch/slam.launch.py`
- [SLAM parameters](https://github.com/muhammadelbialy/gp_2026_autonomous_robot/blob/main/src/robot_bringup/config/slam_params.yaml): `src/robot_bringup/config/slam_params.yaml`

### Robot runtime

- [Robot description](https://github.com/muhammadelbialy/gp_2026_autonomous_robot/blob/main/src/my_robot_description/urdf/final2.xml): `src/my_robot_description/urdf/final2.xml`
- [Model visualization](https://github.com/muhammadelbialy/gp_2026_autonomous_robot/blob/main/src/my_robot_description/launch/view_robot.launch.py): `src/my_robot_description/launch/view_robot.launch.py`
- [Odometry launch](https://github.com/muhammadelbialy/gp_2026_autonomous_robot/blob/main/src/robot_bringup/launch/odom_bringup.launch.py): `src/robot_bringup/launch/odom_bringup.launch.py`
- [Full system launch](https://github.com/muhammadelbialy/gp_2026_autonomous_robot/blob/main/src/robot_bringup/launch/full_system.launch.py): `src/robot_bringup/launch/full_system.launch.py`
- [SLAM launch](https://github.com/muhammadelbialy/gp_2026_autonomous_robot/blob/main/src/robot_bringup/launch/slam.launch.py): `src/robot_bringup/launch/slam.launch.py`
- [IMU launch](https://github.com/muhammadelbialy/gp_2026_autonomous_robot/blob/main/src/imu_pkg/launch/imu.launch.py): `src/imu_pkg/launch/imu.launch.py`
- [RViz](https://github.com/muhammadelbialy/gp_2026_autonomous_robot/blob/main/src/encoder_odometry/rviz/odom_config.rviz): `src/encoder_odometry/rviz/odom_config.rviz`

### Other components

- **Operator**

## Connections

- Operator → Odometry launch: starts (evidence: `src/robot_bringup/launch/odom_bringup.launch.py`)
- Operator → Full system launch: starts (evidence: `src/robot_bringup/launch/full_system.launch.py`)
- Operator → SLAM launch: starts (evidence: `src/robot_bringup/launch/slam.launch.py`)
- Operator → IMU launch: starts (evidence: `src/imu_pkg/launch/imu.launch.py`)
- ESP32 firmware → Encoder odometry: serial data
- Encoder odometry → Odometry and TF: publishes (evidence: `src/encoder_odometry/src/encoder_odom_node.cpp`)
- Encoder odometry → Standalone IMU node: publishes (evidence: `src/encoder_odometry/src/encoder_odom_node.cpp`)
- Full system launch → Encoder odometry: launches (evidence: `src/robot_bringup/launch/full_system.launch.py`)
- Full system launch → EKF filter: configures (evidence: `src/robot_bringup/launch/full_system.launch.py`)
- Full system launch → RViz: launches (evidence: `src/robot_bringup/launch/full_system.launch.py`)
- Odometry launch → Encoder odometry: launches (evidence: `src/robot_bringup/launch/odom_bringup.launch.py`)
- Odometry launch → RViz: launches (evidence: `src/robot_bringup/launch/odom_bringup.launch.py`)
- IMU launch → Standalone IMU node: launches (evidence: `src/imu_pkg/launch/imu.launch.py`)
- SLAM launch → Full system launch: includes (evidence: `src/robot_bringup/launch/slam.launch.py`)
- SLAM launch → Lidar driver: includes (evidence: `src/robot_bringup/launch/slam.launch.py`)
- SLAM launch → SLAM toolbox: launches (evidence: `src/robot_bringup/launch/slam.launch.py`)
- SLAM launch → SLAM parameters: configures (evidence: `src/robot_bringup/launch/slam.launch.py`)
- Odometry and TF → EKF filter: feeds
- Lidar driver → SLAM toolbox: scan input
- Operator → Model visualization: starts (evidence: `src/my_robot_description/launch/view_robot.launch.py`)
- Model visualization → Robot description: loads (evidence: `src/my_robot_description/launch/view_robot.launch.py`)
