makerspet/oomwoo

OOMWOO – 开源 DIY 机器人扫地机

What it is

• 一个社区驱动的项目，旨在设计并构建一个完全开源硬件的机器人扫地机，你可以自行组装。该机器人本地运行（无需云端），旨在达到与商用电器相同的可靠性。

Core capabilities

• 基于 2-D LiDAR 的 SLAM，用于建图和自主导航 (ROS 2 / Nav2)。
• Home Assistant 集成，用于本地控制和自动化。
• 基于 ROS 2 的软件栈 (URDF, Gazebo simulation, navigation, cleaning-job orchestration, safety watchdog, etc.)。
• 模块化硬件：3-D 打印底盘，使用 Raspberry Pi Compute Module 4/5 作为主计算机，基于 STM32 的 I/O 板用于电机驱动、传感器、充电以及可选的摄像头/ToF 避障。
• 开源固件 (FreeRTOS + Arduino-style API) 用于 MCU，以及 ROS 2 bridge code。

Technology stack

• Hardware: Raspberry Pi CM4/CM5, 2-D LiDAR, motor-driver PCB (STM32G473), optional stereo camera & VL53L7CX ToF sensors, 3-D 打印零件 (CAD 文件在仓库中)。
• Software: Ubuntu 22.04, ROS 2 Humble (or later), Nav2, Gazebo for simulation, ROS 2 composable nodes, Rust for performance-critical parts, FreeRTOS on the MCU, Home Assistant integration。

Project status

• 早期开发阶段 (status badge 显示 early development)。
• 仿真 (URDF + Gazebo) 已基本完成；一个占位扫地机 (Proscenic M6 Pro) 已经可以在 ROS 2 中使用。
• 硬件设计文件、3-D 可打印 STL/STEP 文件以及 PCB layout 仍在不断添加中。
• 一组“模块” (navigation, docking, safety, cleaning jobs, etc.) 已列出并标注了当前进度，邀请贡献者参与其中。

How to get involved

1. Read the docs – CONTRIBUTING.md, ARCHITECTURE.md 和模块列表清晰地展示了哪些部分需要工作。
2. Pick a module – 每个模块在 contributions/ 下都有自己的文件夹。创建一个 fork 或新仓库，实现该功能 (code, simulation, docs, or hardware spec)，并提交一个链接回模块文件夹的 PR。
3. Join the community – Discord, Reddit, X, Instagram, 和项目邮件列表均已在 README 中列出。
4. Use the existing tooling – oomwoo-install 仓库提供了 ROS 2 开发环境和 Ubuntu setup scripts。

Where to find more

• Code & docs: https://github.com/makerspet/oomwoo (主仓库) 以及相关仓库 (oomwoo-install, oomwoo-one, oomwoo-io-firmware, etc.)。
• Build instructions (coming Fall 2026) 和教程托管在 https://makerspet.com/learn/。
• Community channels: Discord, Reddit, X, Instagram, YouTube, 和 newsletter 均在 README 中列出。
• License: Apache 2.0 用于软件；硬件文件一旦发布，将采用开源硬件许可。

Bottom line OOMWOO 是一个真正的开源机器人项目，它结合了 ROS 2 导航、3-D 打印硬件和 Home Assistant 集成，打造出一个 DIY 机器人扫地机。它目前仍处于早期阶段的构建与仿真阶段，但仓库提供了清晰的模块化路线图，并为任何对机器人、嵌入式系统或开源硬件家用电器感兴趣的人提供了开放的欢迎贡献的过程。