oomwoo-pcb - GitLite

KO | EN

gitlite — search

#ios #ruby #css #kotlin #developer-tools #redis #cpp #gpt #agent #ai

oomwoo-pcb

(★ 29)

I/O board for open-source vacuum cleaner robot

File Explorer

ZIP Download

- - ci.yaml
- irobot_roomba_cliff_bumper_sensors_pinout.pdf
- SPEC.md
- - Charging Dock.kicad_pcb
  - Charging Dock.kicad_pro
  - Charging Dock.kicad_sch
  - fp-lib-table
  - IR Beacon.kicad_sch
  - IR sensor.kicad_sch
  - JLCImport.kicad_sym
  - Power.kicad_sch
  - Presence Sensor.kicad_sch
  - sym-lib-table
  - TOF.kicad_sch
- - fp-lib-table
  - Front Sensor.kicad_pcb
  - Front Sensor.kicad_pro
  - Front Sensor.kicad_sch
  - IR sensor.kicad_sch
  - JLCImport.kicad_sym
  - sym-lib-table
  - TOF.kicad_sch
- - ANTI-FALL-IR-SENSORs.kicad_sch
  - Battery-Charger.kicad_sch
  - BMS-SYSTEM-POWER.kicad_sch
  - BUTTON-LEDs .kicad_sch
  - CM5-GPIO.kicad_sch
  - CM5-Highspeed.kicad_sch
  - CONTROLLER-RK3562.kicad_sch
  - DDR-LPDDR4.kicad_sch
  - DOCKING IR-BUMPER-SENSOR.kicad_sch
  - eMMC.kicad_sch
  - fp-lib-table
  - Front Sensors.kicad_sch
  - IMU-ICM-4267-P .kicad_sch
  - JLCImport.kicad_sym
  - LiDAR .kicad_sch
  - M.2.kicad_sch
  - MAIN-BRUSH-MOTOR .kicad_sch
  - MAIN-FAN .kicad_sch
  - Main.kicad_pcb
  - Main.kicad_pro
  - Main.kicad_sch
  - MIPI-CAMERA.kicad_sch
  - RK-PERIPHERAL-POWER.kicad_sch
  - RK-POWER-SUPPLY.kicad_sch
  - RK3562-DDR-PHY.kicad_sch
  - RK3562-PMUIO-OSC-PLL.kicad_sch
  - RK3562-POWER-GND.kicad_sch
  - RK3562-USB-PCIe-PHY.kicad_sch
  - RK3562-VCCIO1.kicad_sch
  - RK3562-VCCIO2-VCCIO3.kicad_sch
  - RK3562-VCCIO4.kicad_sch
  - RK3562-VCCIO5.kicad_sch
  - RK3562-VCCIO6.kicad_sch
  - RTC_WATCHDOG.kicad_sch
  - SD_TF-CARD.kicad_sch
  - SIDE-BRUSH-MOTORs .kicad_sch
  - SIDE-PROXIMITY-IR-SENSOR .kicad_sch
  - SPEAKER-MIC.kicad_sch
  - STM32G070RBT6.kicad_sch
  - STM32G473VCT6_IOs.xlsx
  - sym-lib-table
  - WATER-PUMP .kicad_sch
  - WF-BT-AP6256.kicad_sch
  - WHEEL-MOTORs .kicad_sch
- - fp-lib-table
  - IR sensor.kicad_sch
  - JLCImport.kicad_sym
  - Side Sensor.kicad_pcb
  - Side Sensor.kicad_pro
  - Side Sensor.kicad_sch
  - sym-lib-table
.gitignore
LICENSE
README.md

# Use via CDN

jsDelivr

jsDelivr serves any public GitHub repository as a CDN with zero setup. Pick a version and a file to get a ready-to-paste link and snippet.

Version

File

Link

Example

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<div align="center">

*Open-source robot vacuum you build yourself.*

Raspberry Pi CM4/CM5 socket · STM32G473 MCU · Motor drivers · Sensors · 2x MIPI cameras · 4S charging · KiCad

![License](https://img.shields.io/badge/license-Apache--2.0-blue)
![Status](https://img.shields.io/badge/status-placement-orange)
[![Part of OOMWOO](https://img.shields.io/badge/part%20of-OOMWOO-5eead4)](https://github.com/makerspet/oomwoo)

</div>

Part of [OOMWOO open-source robot vacuum](https://github.com/makerspet/oomwoo) project.

<img width="1335" height="815" alt="oomwoo_main_pcb_placement" src="https://github.com/user-attachments/assets/967f562d-f45b-44db-834b-56e3c3d44b5e" />

Get [MCU firmware](https://github.com/makerspet/oomwoo-io-firmware/).

## Architecture notes

Consumer vacuums typically split compute into CPU and MCU. The MCU ([real examples](https://robotinfo.dev/)) controls
- all motors - driving wheels, suction fan, side brushes, mop motors, mop lift servos, pump and so on
- all sensors except below - IR cliff, IR side proximity, IR docking, wheel drop, bumper (IR or micro-switches), motor encoders, ultrasonic carpet sensor
- all push buttons
- 2D LiDAR motor RPM
- power - battery charging, motors power on/off
- all safety sensors - overcurrent for all motors (cheap vacuums ignore overcurrent sensing)

I/O board also provides audio encoders/decoders, amp, speaker (connector), mics (if any).

CPU receives
- 2D LiDAR data over serial port
- IMU (sometimes IMU gets forwarded via MCU) over SPI/I2C
- cameras (2x MIPI for visual obstacle avoidance)

MCU (and CPU) are usually always active. This allows the user to start cleaning at any time (especially via app remotely). Exceptions:
- no power (battery dead and no dock power)
- user explicitly shut down the vacuum by long-pressing the power button

The MCU's overarching constraint is to ensure robot safety. This is necessary to pass CE mark tests. Here is how MCU ensures safety:
- MCU firmware uses FreeRTOS or similar, static memory allocation, watchdog, guaranteed reaction time
- MCU acts as watchdog for CPU, resets CPU if CPU becomes unresponsive
- MCU connects to CPU over serial using a custom serial protocol ([concrete example](https://github.com/codetiger/VacuumRobot)). No micro-ROS to reduce dependencies, prevent bugs from updated 3rd party libraries slipping into safety-critical MCU firmware.
- MCU shuts down some (or all) motors when MCU detects overcurrent (brush stuck)
- MCU shuts down all motors (including power to all motors) when CPU becomes unresponsive (to prevent CPU sending garbage commands to MCU)
- MCU monitors battery charging, shuts it down when needed (battery too hot)
- MCU stops driving wheel motors when bumper sensors activate
- MCU tests motors, sensors
- MCU does not depend on CPU
- MCU toggles watchdog GPIO; otherwise an external-to-MCU circuit shuts down motor power

Consumer vacuums place CPU and MCU on the same PCB board. Since OOMWOO has to be hackable, it seems best to separate I/O from the compute. Therefore, this I/O board needs to have
- MCU and programming header
  - likely STM32G070RBT6 because it has 56 GPIOs, 16 ADC channels, costs $1 at JLCPCB, has LQFP package for easy PCBA - a rare combination
  - see tentative [I/O board spec](https://github.com/makerspet/oomwoo-io-board/blob/main/docs/SPEC.md)
- all vacuum motor drivers (with connectors), driven by the MCU
  - cliff, side proximity, docking, bumper, carpet, water tank full/empty, dust bin present, motor overcurrent, motor encoders
- MCU connected to all sensors (except those handled by CPU like LiDAR serial, MIPI cameras I/O, IMU); sensor connectors
- control circuit for 2D LiDAR's motor (controlled by MCU)
- battery charging, power management (motors power on/off, charging on/off, power shut down), power for CPU compute module (see below)
- push buttons (home, power, etc.) and UI LEDs
- dock connector (dock power, sense dock present)
- USB power for charging; USB for serial shell, etc.
- audio encoder/decoder, audio amp, mics (if any)
- SD card for hacking, cheap large storage
- connect IMU FSYNC to MCU to synchronize MCU timestamps with IMU data streaming to CPU

Consumer vacuums usually don't have a CPU fan/heatsink because the vacuum's suction fan can (indirectly) cool the CPU/MCU PCB. Therefore, no CPU fan on this I/O board.

As far as compute - currently it seems best to use a Raspberry Pi CM4/CM5 compute module. Why?
- CM4/CM5 modules cost a bit less than a full Raspberry Pi 4/5
- CM4/CM5 have lower profile/height vs a full Raspberry Pi 4/5, important to keep vacuum cleaner slim
- there are plenty of 3rd party compute modules pin-compatible with CM4/CM5, making the compute swappable, hackable
  - 3rd party compute modules with NPUs are especially interesting because we need NPU for real-time camera-based obstacle detection

Compute module headers should expose
- 2x MIPI camera I/O
- 1x serial for CPU-MCU comms
- 1x serial for CPU-LiDAR comms
- 1x SPI (or I2C) for CPU-IMU comms
- audio (digital?) I/O
- power from I/O board to CM
- a few TBD GPIOs
  - MCU GPIO to reset CPU

This board should be designed using an open-source PCB tool (KiCad seems like a good choice).

## License

[Apache License 2.0](LICENSE).