# akarshsnair/automatic-floor-cleaning-robot architecture

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

- Interactive diagram: https://gitdiagram.com/akarshsnair/automatic-floor-cleaning-robot
- Repository: https://github.com/akarshsnair/automatic-floor-cleaning-robot

## Overview

This repository is a ROS-based floor-cleaning robot project. Its implemented ROS workflow measures ultrasonic distance, publishes it on the `distance` topic, and uses received readings to make obstacle-response decisions and drive wheel GPIO. The root-level scripts duplicate the package nodes, while `raspberrypi.py` combines sensing and movement in a standalone loop. The README also describes path planning, vacuum/mop actuation, and a user interface, but no implementation for those capabilities appears in the provided source tree; those branches are shown as documented but unverified.

Main entry points: [`raspberrypi.py`](https://github.com/akarshsnair/automatic-floor-cleaning-robot/blob/main/raspberrypi.py) (Standalone loop), [`catkin_ws/src/ultrasonic_publisher_pkg/src/publisher.py`](https://github.com/akarshsnair/automatic-floor-cleaning-robot/blob/main/catkin_ws/src/ultrasonic_publisher_pkg/src/publisher.py) (Package publisher), [`publisher.py`](https://github.com/akarshsnair/automatic-floor-cleaning-robot/blob/main/publisher.py) (Root publisher), [`catkin_ws/src/ultrasonic_subscriber_pkg/src/subscriber.py`](https://github.com/akarshsnair/automatic-floor-cleaning-robot/blob/main/catkin_ws/src/ultrasonic_subscriber_pkg/src/subscriber.py) (Package controller)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_sensing["Distance sensing"]
  node_ultrasonic["Ultrasonic sensor"]
  node_pkg_publisher["Package publisher<br/>[publisher.py]"]
  node_root_publisher["Root publisher<br/>[publisher.py]"]
end

subgraph group_ros["ROS messaging"]
  node_distance_topic["Distance topic"]
end

subgraph group_motion["Motion control"]
  node_standalone_robot["Standalone loop<br/>[raspberrypi.py]"]
  node_pkg_subscriber["Package controller<br/>[subscriber.py]"]
  node_root_subscriber["Root controller<br/>[subscriber.py]"]
  node_motor_driver["Motor GPIO"]
end

subgraph group_cleaning["Cleaning capabilities"]
  node_path_planning["Cleaning path"]
  node_vacuum_mop["Vacuum and mop"]
  node_user_interface["User interface"]
end

node_operator(("Operator"))
node_raspberry_pi["Raspberry Pi"]

node_ultrasonic -->|"measures via GPIO"| node_pkg_publisher
node_pkg_publisher -->|"publishes distance"| node_distance_topic
node_ultrasonic -->|"measures via GPIO"| node_root_publisher
node_root_publisher -->|"publishes distance"| node_distance_topic
node_distance_topic -->|"delivers readings"| node_pkg_subscriber
node_distance_topic -->|"delivers readings"| node_root_subscriber
node_pkg_subscriber -->|"sets wheel GPIO"| node_motor_driver
node_root_subscriber -->|"sets wheel GPIO"| node_motor_driver
node_standalone_robot -->|"reads sensor GPIO"| node_ultrasonic
node_standalone_robot -->|"sets wheel GPIO"| node_motor_driver
node_operator -.->|"uses controls"| node_user_interface
node_raspberry_pi -.->|"processes sensor data"| node_path_planning
node_path_planning -.->|"sends movement commands"| node_motor_driver
node_path_planning -.->|"activates cleaning"| node_vacuum_mop

click node_pkg_publisher "https://github.com/akarshsnair/automatic-floor-cleaning-robot/blob/main/catkin_ws/src/ultrasonic_publisher_pkg/src/publisher.py"
click node_root_publisher "https://github.com/akarshsnair/automatic-floor-cleaning-robot/blob/main/publisher.py"
click node_standalone_robot "https://github.com/akarshsnair/automatic-floor-cleaning-robot/blob/main/raspberrypi.py"
click node_pkg_subscriber "https://github.com/akarshsnair/automatic-floor-cleaning-robot/blob/main/catkin_ws/src/ultrasonic_subscriber_pkg/src/subscriber.py"
click node_root_subscriber "https://github.com/akarshsnair/automatic-floor-cleaning-robot/blob/main/subscriber.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_ultrasonic,node_pkg_publisher,node_root_publisher toneBlue
class node_distance_topic toneAmber
class node_standalone_robot,node_pkg_subscriber,node_root_subscriber,node_motor_driver toneMint
class node_path_planning,node_vacuum_mop,node_user_interface toneRose
class node_operator,node_raspberry_pi toneIndigo
```

## Components

### Distance sensing

- **Ultrasonic sensor**
- [Package publisher](https://github.com/akarshsnair/automatic-floor-cleaning-robot/blob/main/catkin_ws/src/ultrasonic_publisher_pkg/src/publisher.py): `catkin_ws/src/ultrasonic_publisher_pkg/src/publisher.py`
- [Root publisher](https://github.com/akarshsnair/automatic-floor-cleaning-robot/blob/main/publisher.py): `publisher.py`

### ROS messaging

- **Distance topic**

### Motion control

- [Standalone loop](https://github.com/akarshsnair/automatic-floor-cleaning-robot/blob/main/raspberrypi.py): `raspberrypi.py`
- [Package controller](https://github.com/akarshsnair/automatic-floor-cleaning-robot/blob/main/catkin_ws/src/ultrasonic_subscriber_pkg/src/subscriber.py): `catkin_ws/src/ultrasonic_subscriber_pkg/src/subscriber.py`
- [Root controller](https://github.com/akarshsnair/automatic-floor-cleaning-robot/blob/main/subscriber.py): `subscriber.py`
- **Motor GPIO**

### Cleaning capabilities

- **Cleaning path**
- **Vacuum and mop**
- **User interface**

### Other components

- **Operator**
- **Raspberry Pi**

## Connections

- Ultrasonic sensor → Package publisher: measures via GPIO (evidence: `catkin_ws/src/ultrasonic_publisher_pkg/src/publisher.py`)
- Package publisher → Distance topic: publishes distance (evidence: `catkin_ws/src/ultrasonic_publisher_pkg/src/publisher.py`)
- Ultrasonic sensor → Root publisher: measures via GPIO (evidence: `publisher.py`)
- Root publisher → Distance topic: publishes distance (evidence: `publisher.py`)
- Distance topic → Package controller: delivers readings (evidence: `catkin_ws/src/ultrasonic_subscriber_pkg/src/subscriber.py`)
- Distance topic → Root controller: delivers readings (evidence: `subscriber.py`)
- Package controller → Motor GPIO: sets wheel GPIO (evidence: `catkin_ws/src/ultrasonic_subscriber_pkg/src/subscriber.py`)
- Root controller → Motor GPIO: sets wheel GPIO (evidence: `subscriber.py`)
- Standalone loop → Ultrasonic sensor: reads sensor GPIO (evidence: `raspberrypi.py`)
- Standalone loop → Motor GPIO: sets wheel GPIO (evidence: `raspberrypi.py`)
- Operator → User interface: uses controls (evidence: `README.md`)
- Raspberry Pi → Cleaning path: processes sensor data (evidence: `README.md`)
- Cleaning path → Motor GPIO: sends movement commands (evidence: `README.md`)
- Cleaning path → Vacuum and mop: activates cleaning (evidence: `README.md`)
