How makerspet/oomwoo works
OOMWOO is an open-source, community-built robot-vacuum project, not a single integrated runtime in this repository. The README describes the intended user journey and major capabilities; the tree contains contribution proposals and selected reference implementations. The arrows below reflect documented project workflow and capability relationships, not verified runtime wiring. Most subsystem source was not sampled, so the graph uses supported contribution directories and leaves uncertain integration links out.
Main entry points: nav-localize Navigation · control-app Control App · README.md RFC Board · urdf-gazebo-sim Gazebo Simulation
Components 17
Project Workflow
- RFC Board
contributions/README.md - System Design
docs/ARCHITECTURE.md
Robot Software
- Robot Description
contributions/urdf-gazebo-sim - Gazebo Simulation
contributions/urdf-gazebo-sim - Mapping & Localization
contributions/nav-localize - Navigation
contributions/nav-localize - Obstacle Avoidance
contributions/obstacle-avoidance - Cleaning Jobs
contributions/cleaning-jobs - Control App
contributions/control-app
Hardware Modules
- CPU–MCU Interface
contributions/io-board-interface/xbattlax/tools/oomwoo_mcu_frame.py - I/O Firmware
contributions/mcu-io-firmware - I/O Board
contributions/io-pcb
Docking & Safety
- Dock Homing
contributions/dock-cycle/xbattlax/tools/oomwoo_dock_ir_model.py - Recovery Safety
contributions/recovery-safety/xbattlax/oomwoo_recovery_safety/oomwoo_recovery_safety/recovery_node.py
Other components
- Builder / Contributor
- Home Assistant
- Cloud Services
Connections 12
- Builder / Contributor → RFC Board: selects module
- RFC Board → System Design: guides design
- Builder / Contributor → Gazebo Simulation: develops against
- Robot Description → Gazebo Simulation: describes robot
- Mapping & Localization → Navigation: provides map pose
- Navigation → Obstacle Avoidance: avoids obstacles
- Navigation → Cleaning Jobs: supports cleaning
- Control App → Cleaning Jobs: customizes operation
- I/O Board → I/O Firmware: hosts firmware
- CPU–MCU Interface → I/O Firmware: defines wire protocol
- Home Assistant → Control App: local control
- Cloud Services → Control App: optional features