# arghyachatterjee/gps-waypoint-based-autonomous-navigation-in-ros architecture

> Architecture diagram of the GitHub repository arghyachatterjee/gps-waypoint-based-autonomous-navigation-in-ros, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-06-25). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/arghyachatterjee/gps-waypoint-based-autonomous-navigation-in-ros
- Repository: https://github.com/arghyachatterjee/gps-waypoint-based-autonomous-navigation-in-ros

## Overview

##### Project type and purpose
- This is a full-stack robotics application built on ROS (Robot Operating System).
- Purpose: Use predefined or collected GPS waypoints to autonomously navigate a rover, fusing GPS, IMU, odometry, and lidar data for mapping and obstacle avoidance.

##### File structure
- Top‐level:
- CMakeLists.txt, package.xml – ROS packaging and build
- assets – static images
- launch/ & launch/navigation/ – ROS launch files to spin up sensors, nodes, controllers, navigation stacks, mapviz, safety, etc.
- params/ – YAML parameter files for EKF, filters, navsat transforms
- rviz_config/ – RViz configurations for different modes
- scripts/ – Python nodes for joystick control and waypoint interaction
- src/ – C++ nodes for heading calibration, waypoint following, data collection, plotting
- waypoint_files/ – sample waypoint outputs
- Build & deploy: `catkin_make`, shell scripts (`run.sh`, `run_continuous.sh`).

##### README for additional insights
- Describes hardware setup (Jetson TX2, IMU, ZED-F9P GPS, RPLidar).
- Dependencies: robot_localization (EKF), navsat_transform, GMapping, move_base, mapviz, rviz_satellite, rosboard.
- Custom nodes: gps_waypoint, gps_waypoint_continuous1/2, collect_gps_waypoints, calibrate_heading, plot_gps_waypoints, gps_waypoint_mapping.

##### Main components & their interactions
a. Hardware & Drivers (Sensors)
- GPS sensor → `/navsat/fix`
- IMU → `/imu/data`
- Wheel odometry → `/odom`
- Lidar → `/scan`
b. Localization Stack
- robot_localization EKF node (fuses IMU + odom + GPS → `/odometry/filtered`)
- navsat_transform node (converts `/navsat/fix` to `/navsat/odom`, projects lat/lon into map frame)
c. Mapping & Obstacle Detection
- GMapping SLAM node subscribes to `/scan` + `/odometry/filtered` → publishes `/map`
d. Path Planning & Control
- move_base
- global_planner uses `/map`, `/odom`, and goals
- local_planner uses `/scan`, dynamic reconfigure
e. Waypoint Management
- gps_waypoint* nodes read waypoint files, transform to map frame, publish goals to move_base
- collect_gps_waypoints node logs current GPS/odometry to a file
- calibrate_heading node sets initial yaw offset
f. Visualization & Monitoring
- RViz (rviz_config/*.rviz)
- Mapviz (mapviz launch)
- rosboard (http visualization of topics)

##### Architectural patterns & design principles
- ROS node‐topic architecture (loosely coupled, message-based)
- Separation of concerns:
- Sensing/Driver nodes
- Filtering/fusion (EKF)
- Coordinate transforms (navsat_transform)
- Mapping (GMapping)
- Planning (move_base + custom waypoint publishers)
- Data collection & visualization
- Launch files group and configure nodes per mission profile (mapping vs. waypoint navigation vs. joystick control).

##### Essential elements
- All custom ROS nodes, grouped by functionality
- External packages (robot_localization, navsat_transform, GMapping, move_base, Mapviz, RViz, rosboard)
- Sensor sources and produced topics
- Launch file groupings (e.g., gps_waypoint_nav.launch, joy_launch_control.launch)
- Parameter/YAML files attached to their nodes

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Hardware Layer
    subgraph "Hardware Layer"
        direction TB
        GPS["GPS Sensor"]:::sensor
        IMU["IMU Sensor"]:::sensor
        LiDAR["LiDAR Sensor"]:::sensor
        HuskyBringup["Robot Bring-up"]:::sensor
    end

    %% Localization & Transforms
    subgraph "Localization & Transforms"
        direction TB
        NavsatTransform["navsat_transform"]:::fusion
        EKF["robot_localization EKF"]:::fusion
        EKFParams["EKF Parameters"]:::datas
        NavsatParams["Navsat Params"]:::datas
    end

    %% Mapping & Planning
    subgraph "Mapping & Planning"
        direction TB
        GMapping["GMapping SLAM"]:::planning
        SafetyNode["Safety Monitoring Node"]:::fusion
        MoveBase["move_base (Action Server)"]:::planning
        GlobalPlanner["Global Planner"]:::planning
        LocalPlanner["Local Planner"]:::planning
    end

    %% Application Logic
    subgraph "Application Logic"
        direction TB
        subgraph "Waypoint Management"
            direction TB
            GPSWaypoint["gps_waypoint.cpp"]:::app
            GPSWaypointCont1["gps_waypoint_continuous1.cpp"]:::app
            GPSWaypointCont2["gps_waypoint_continuous2.cpp"]:::app
            GPSWaypointMap["gps_waypoint_mapping.cpp"]:::app
            WaypointFiles["Waypoint Files"]:::datas
        end
        subgraph "Calibration & Collection"
            direction TB
            CalibrateHeading["calibrate_heading.cpp"]:::app
            CollectWaypoints["collect_gps_waypoints.cpp"]:::app
            PlotWaypoints["plot_gps_waypoints.cpp"]:::app
        end
        subgraph "Joystick Control"
            direction TB
            JoyControl["joy_launch_control.py"]:::app
            JoyControlCont["joy_launch_control_continuous.py"]:::app
            JoyControlMap["joy_launch_control_mapping.py"]:::app
        end
    end

    %% Visualization & Monitoring
    subgraph "Visualization & Monitoring"
        direction TB
        RVizModel["model.rviz"]:::viz
        RVizNav["outdoor_waypoint_nav_rviz.rviz"]:::viz
        RVizCont["outdoor_waypoint_nav_continuous_rviz.rviz"]:::viz
        RVizMap["outdoor_waypoint_nav_mapping_rviz.rviz"]:::viz
        Mapviz["Mapviz"]:::viz
        Rosboard["rosboard"]:::viz
    end

    %% Data Flow
    GPS -->|"/navsat/fix"| NavsatTransform
    NavsatTransform -->|"transformed odom"| EKF
    IMU -->|"/imu/data"| EKF
    HuskyBringup -->|"/odom"| EKF
    EKF -->|"/odometry/filtered"| GMapping
    LiDAR -->|"/scan"| GMapping
    GMapping -->|"/map"| GlobalPlanner
    EKF -->|"/odom"| GlobalPlanner
    GlobalPlanner -->|"/move_base/goal"| MoveBase
    LocalPlanner -->|"local planning"| MoveBase
    GPSWaypoint -->|"/move_base/goal"| MoveBase
    GPSWaypointCont1 -->|"/move_base/goal"| MoveBase
    GPSWaypointCont2 -->|"/move_base/goal"| MoveBase
    GPSWaypointMap -->|"/move_base/goal"| MoveBase
    CollectWaypoints -->|"logs GPS/odom"| WaypointFiles
    CalibrateHeading -->|"initial yaw offset"| EKF
    JoyControl -->|"/move_base/goal"| MoveBase
    JoyControlCont -->|"/move_base/goal"| MoveBase
    JoyControlMap -->|"/move_base/goal"| MoveBase
    MoveBase -->|"/tf & topics"| RVizModel
    MoveBase -->|"/tf & topics"| RVizNav
    MoveBase -->|"/tf & topics"| RVizCont
    MoveBase -->|"/tf & topics"| RVizMap
    GMapping -->|"/map"| Mapviz
    GMapping -->|"/map"| Rosboard

    %% Click events
    click GPS "https://github.com/arghyachatterjee/gps-waypoint-based-autonomous-navigation-in-ros/blob/master/launch/include/gps.launch"
    click IMU "https://github.com/arghyachatterjee/gps-waypoint-based-autonomous-navigation-in-ros/blob/master/launch/include/imu.launch"
    click LiDAR "https://github.com/arghyachatterjee/gps-waypoint-based-autonomous-navigation-in-ros/blob/master/launch/include/laser.launch"
    click HuskyBringup "https://github.com/arghyachatterjee/gps-waypoint-based-autonomous-navigation-in-ros/blob/master/launch/include/husky_bringup.launch"
    click NavsatTransform "https://github.com/arghyachatterjee/gps-waypoint-based-autonomous-navigation-in-ros/blob/master/params/navsat_params.yaml"
    click EKF "https://github.com/arghyachatterjee/gps-waypoint-based-autonomous-navigation-in-ros/blob/master/launch/include/localization_run.launch"
    click EKFParams "https://github.com/arghyachatterjee/gps-waypoint-based-autonomous-navigation-in-ros/blob/master/params/ekf_params.yaml"
    click SafetyNode "https://github.com/arghyachatterjee/gps-waypoint-based-autonomous-navigation-in-ros/blob/master/src/safety_node.cpp"
    click GPSWaypoint "https://github.com/arghyachatterjee/gps-waypoint-based-autonomous-navigation-in-ros/blob/master/src/gps_waypoint.cpp"
    click GPSWaypointCont1 "https://github.com/arghyachatterjee/gps-waypoint-based-autonomous-navigation-in-ros/blob/master/src/gps_waypoint_continuous1.cpp"
    click GPSWaypointCont2 "https://github.com/arghyachatterjee/gps-waypoint-based-autonomous-navigation-in-ros/blob/master/src/gps_waypoint_continuous2.cpp"
    click GPSWaypointMap "https://github.com/arghyachatterjee/gps-waypoint-based-autonomous-navigation-in-ros/blob/master/src/gps_waypoint_mapping.cpp"
    click WaypointFiles "https://github.com/arghyachatterjee/gps-waypoint-based-autonomous-navigation-in-ros/tree/master/waypoint_files/"
    click CalibrateHeading "https://github.com/arghyachatterjee/gps-waypoint-based-autonomous-navigation-in-ros/blob/master/src/calibrate_heading.cpp"
    click CollectWaypoints "https://github.com/arghyachatterjee/gps-waypoint-based-autonomous-navigation-in-ros/blob/master/src/collect_gps_waypoints.cpp"
    click PlotWaypoints "https://github.com/arghyachatterjee/gps-waypoint-based-autonomous-navigation-in-ros/blob/master/src/plot_gps_waypoints.cpp"
    click JoyControl "https://github.com/arghyachatterjee/gps-waypoint-based-autonomous-navigation-in-ros/blob/master/scripts/joy_launch_control.py"
    click JoyControlCont "https://github.com/arghyachatterjee/gps-waypoint-based-autonomous-navigation-in-ros/blob/master/scripts/joy_launch_control_continuous.py"
    click JoyControlMap "https://github.com/arghyachatterjee/gps-waypoint-based-autonomous-navigation-in-ros/blob/master/scripts/joy_launch_control_mapping.py"
    click RVizModel "https://github.com/arghyachatterjee/gps-waypoint-based-autonomous-navigation-in-ros/blob/master/rviz_config/model.rviz"
    click RVizNav "https://github.com/arghyachatterjee/gps-waypoint-based-autonomous-navigation-in-ros/blob/master/rviz_config/outdoor_waypoint_nav_rviz.rviz"
    click RVizCont "https://github.com/arghyachatterjee/gps-waypoint-based-autonomous-navigation-in-ros/blob/master/rviz_config/outdoor_waypoint_nav_continuous_rviz.rviz"
    click RVizMap "https://github.com/arghyachatterjee/gps-waypoint-based-autonomous-navigation-in-ros/blob/master/rviz_config/outdoor_waypoint_nav_mapping_rviz.rviz"

    %% Styles
    classDef sensor fill:#89CFF0,stroke:#333,stroke-width:1px
    classDef fusion fill:#98FB98,stroke:#333,stroke-width:1px
    classDef planning fill:#FFA500,stroke:#333,stroke-width:1px
    classDef app fill:#DDA0DD,stroke:#333,stroke-width:1px
    classDef viz fill:#D3D3D3,stroke:#333,stroke-width:1px
    classDef datas fill:#FFFFFF,stroke:#333,stroke-width:1px,stroke-dasharray: 5 5
```
