# sohail103/blackpillcdc_rvizvisualization architecture

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

- Interactive diagram: https://gitdiagram.com/sohail103/blackpillcdc_rvizvisualization
- Repository: https://github.com/sohail103/blackpillcdc_rvizvisualization

## Overview

##### Project type and purpose
- This is a ROS 2 Humble visualization package (“BlackPillCDC_RvizVisualization”).
- It reads IMU data from an STM32/MPU6050 over USB-CDC, filters it with imu_tools, and visualizes it in RViz.

##### File structure
- src/serial_mpu_reader: the ROS 2 Python package
- serial_reader node (serial_reader.py)
- launch/imu_visualize.launch.py
- package.xml, setup.py, setup.cfg
- resource/serial_mpu_reader (entry point)
- test/… (unit/flake8/pep257 checks)
- rvizconfig.rviz: RViz display configuration
- build/ & install/: artifacts from colcon build/install
- demo.mp4: usage demo

##### README
- One node (“serial_reader”) subscribes to the USB serial port (/dev/ttyACM0), parses raw IMU registers, and publishes sensor_msgs/Imu on /imu/data_raw.
- A Madgwick filter node from imu_tools subscribes to /imu/data_raw and republishes on /imu/data.

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Main System Components
    subgraph "Runtime Architecture"
        direction TB
        Hardware["STM32 BlackPill\nMPU6050 over USB-CDC"]:::hardware
        serial_reader["serial_reader Node"]:::node
        subgraph "ROS 2 DDS Network"
            direction TB
            topic_raw["/imu/data_raw\ntopic"]:::middleware
            topic_filtered["/imu/data\ntopic"]:::middleware
        end
        filter["Madgwick Filter Node\n(imu_tools)"]:::node_ext
        rviz["RViz GUI"]:::viz
        launch["Launch Orchestration\n(imu_visualize.launch.py)"]:::orchestration
    end

    %% Data Flow
    Hardware -->|"USB-CDC\n/dev/ttyACM0"| serial_reader
    serial_reader -->|"publish"| topic_raw
    topic_raw -->|"subscribe"| filter
    filter -->|"publish"| topic_filtered
    topic_filtered -->|"subscribe"| rviz

    %% Orchestration
    launch --> serial_reader
    launch --> filter
    launch --> rviz

    %% File Structure
    subgraph "File Structure" 
        direction TB
        pkg_dir["src/serial_mpu_reader/"]:::file
        pkg_code["serial_mpu_reader/\nPython package"]:::file
        launch_file["launch/imu_visualize.launch.py"]:::file
        resource["resource/serial_mpu_reader"]:::file
        manifest["package.xml"]:::file
        setup_py["setup.py"]:::file
        setup_cfg["setup.cfg"]:::file
        tests["test/"]:::file
    end

    pkg_dir --> pkg_code
    pkg_dir --> launch_file
    pkg_dir --> resource
    pkg_dir --> manifest
    pkg_dir --> setup_py
    pkg_dir --> setup_cfg
    pkg_dir --> tests

    %% CI / Deployment Artifacts
    subgraph "CI/Deployment" 
        direction TB
        build["build/serial_mpu_reader"]:::ci
        install["install/serial_mpu_reader"]:::ci
    end

    %% Demo
    demo["demo.mp4"]:::artifacts

    %% Click Events
    click Hardware "https://github.com/sohail103/blackpillcdc_rvizvisualization/blob/main/src/serial_mpu_reader/serial_mpu_reader/serial_reader.py"
    click serial_reader "https://github.com/sohail103/blackpillcdc_rvizvisualization/blob/main/src/serial_mpu_reader/serial_mpu_reader/serial_reader.py"
    click resource "https://github.com/sohail103/blackpillcdc_rvizvisualization/tree/main/src/serial_mpu_reader/resource/serial_mpu_reader"
    click manifest "https://github.com/sohail103/blackpillcdc_rvizvisualization/blob/main/src/serial_mpu_reader/package.xml"
    click setup_py "https://github.com/sohail103/blackpillcdc_rvizvisualization/blob/main/src/serial_mpu_reader/setup.py"
    click setup_cfg "https://github.com/sohail103/blackpillcdc_rvizvisualization/blob/main/src/serial_mpu_reader/setup.cfg"
    click launch_file "https://github.com/sohail103/blackpillcdc_rvizvisualization/blob/main/src/serial_mpu_reader/launch/imu_visualize.launch.py"
    click pkg_dir "https://github.com/sohail103/blackpillcdc_rvizvisualization/tree/main/src/serial_mpu_reader"
    click pkg_code "https://github.com/sohail103/blackpillcdc_rvizvisualization/tree/main/src/serial_mpu_reader/serial_mpu_reader"
    click tests "https://github.com/sohail103/blackpillcdc_rvizvisualization/tree/main/src/serial_mpu_reader/test"
    click build "https://github.com/sohail103/blackpillcdc_rvizvisualization/tree/main/build/serial_mpu_reader"
    click install "https://github.com/sohail103/blackpillcdc_rvizvisualization/tree/main/install/serial_mpu_reader"
    click demo "https://github.com/sohail103/blackpillcdc_rvizvisualization/blob/main/demo.mp4"
    click rviz "https://github.com/sohail103/blackpillcdc_rvizvisualization/blob/main/rvizconfig.rviz"

    %% Styles
    classDef hardware fill:#dddddd,stroke:#888;
    classDef node fill:#add8e6,stroke:#1f77b4;
    classDef node_ext fill:#add8e6,stroke:#1f77b4,stroke-dasharray: 5 5;
    classDef middleware fill:#90ee90,stroke:#2ca02c;
    classDef viz fill:#ffa500,stroke:#ff7f0e;
    classDef orchestration fill:#d8bfd8,stroke:#9467bd;
    classDef file fill:#f0f0f0,stroke:#555;
    classDef ci fill:#e0e0e0,stroke:#333;
    classDef artifacts fill:#fafad2,stroke:#666;
```
