Skip to content

sca075/mqtt_vacuum_camera

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

1,483 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

MQTT Vacuum Camera

MQTT Vacuum Camera Logo

Latest Release Total Downloads Community Forum Discord PayPal

MQTT Vacuum Camera Screenshot

Valetudo Vacuum Maps in Home Assistant Made Easy

Display real-time vacuum cleaner maps in Home Assistant for vacuums running Valetudo Hypfer, Valetudo RE (rand256) or Congaduto firmware. Simple installation via HACS with guided GUI configuration.

โ— Note: This is an unofficial project and is not affiliated with valetudo.cloud

What You Get

  • Easy Setup: Install and configure in minutes through Home Assistant's UI
  • Real-time Maps: Automatically decode and render vacuum maps from MQTT
  • Full Control: Pair with lovelace-xiaomi-vacuum-map-card for complete vacuum control

๐ŸŽฏ Project Goals

Deliver an out-of-the-box solution for integrating MQTT-based vacuums into Home Assistant, including:

  • Real-time map extraction and rendering
  • Sensor data (when not provided by the vacuum)
  • Control services for seamless operation
  • Full vacuum control beyond basic map rendering
  • Continuous improvements and regular updates

๐Ÿ”— Related Projects


โœจ Features

Click to expand full feature list

Core Features

  • โœ… Universal Support - All Valetudo-equipped vacuums (Hypfer & Rand256)
  • ๐ŸŒ Multi-language - 14 languages supported (English, Arabic, Chinese, Czech, Dutch, French, German, Italian, Japanese, Polish, Norwegian, Russian, Spanish, Swedish)
  • ๐Ÿค– Multiple Vacuums - Render maps for multiple vacuums simultaneously (e.g., vacuum.robot1 โ†’ camera.robot1_camera)
  • ๐Ÿ”„ ON/OFF Control - Suspend and resume camera stream as needed

Map Features

  • ๐Ÿ“ธ Snapshots - Save maps using Home Assistant's camera.snapshot service
    service: camera.snapshot
    target:
      entity_id: camera.valetudo_your_vacuum_camera
    data:
      filename: /config/www/vacuum_map.png
  • ๐Ÿ”„ Image Rotation - 0ยฐ, 90ยฐ, 180ยฐ, 270ยฐ
  • โœ‚๏ธ Auto-Trim - Automatically resize large maps (5210ร—5210+) with customizable margins
  • ๐Ÿ” Auto-Zoom - Automatically zoom to the room being cleaned
  • ๐ŸŽจ Customizable Colors - Configure colors for robot, charger, walls, background, zones, and rooms
  • ๐ŸŒˆ Transparency Control - Adjust transparency for all elements and rooms
  • ๐Ÿ“Š Status Display - Show vacuum status, current room, battery level, and dock operations on the map
  • ๐Ÿงน Mop Mode - Visualize mop path with customizable width, color, and transparency (Hypfer vacuums)

Advanced Features

  • ๐Ÿ—บ๏ธ Auto-Generated Calibration - Automatic calibration points for lovelace-xiaomi-vacuum-map-card
  • ๐Ÿ  Auto-Generated Rooms - Automatic room configuration when supported by vacuum
  • ๐Ÿšซ Zone Visualization - Display No-Go zones, virtual walls, zone clean areas, and active segments
  • ๐Ÿšง Obstacle Detection - View obstacles and obstacle images with customizable link settings
  • ๐Ÿ—๏ธ Floor Materials - Detect and render different floor types (wood, tiles, carpets)
  • ๐Ÿข Multi-Floor Management - Manage multiple floors with individual trim settings for each level
  • ๐Ÿ“ก Rand256 Sensors - Pre-configured sensors for complete Home Assistant integration
  • ๐ŸŽฎ Control Actions - Control vacuums without formatting MQTT messages manually
  • ๐Ÿ“น MJPEG Streaming - Stream maps to go2rtc/ffmpeg for HomeKit and other video consumers

๐Ÿ“ฆ Installation

Quick Install via HACS (Recommended)

Open HACS repository in Home Assistant

Manual Installation

For detailed installation instructions, including manual setup and configuration of the lovelace-xiaomi-vacuum-map-card, see our Installation Guide.


โš™๏ธ Compatibility & System Requirements

Click to view compatibility information

Supported Systems

  • โœ… All 64-bit systems (Raspberry Pi 4+, ProxMox VE, Docker, etc.)
  • โŒ 32-bit systems - Not supported since version 2025.10.0

Hardware Recommendations

Hardware Single Vacuum Multiple Vacuums
Raspberry Pi 3 (4GB) โœ… Works โŒ Not recommended
Raspberry Pi 4 (4GB) โœ… Works well โš ๏ธ Possible, not advised
Raspberry Pi 4 (8GB) โœ… Excellent โœ… Recommended
ProxMox VE / Docker โœ… Excellent โœ… Recommended

Supported Vacuums

  • โœ… All vacuums running Valetudo Hypfer firmware
  • โœ… All vacuums running Valetudo RE (rand256) firmware
  • ๐Ÿ’ฌ Other MQTT-connected vacuums? Let us know!

Important Notes

  • Extensively tested on Raspberry Pi 4 (8GB) with Home Assistant OS
  • Also tested on ProxMox and Docker Supervised environments
  • For unsupported platforms, consider ValetudoPNG as an alternative
  • Please read our NOTICE for additional information

Your feedback is invaluable! Please report any issues you encounter on different platforms.


๐Ÿค Contributing & Support

We welcome contributions! Whether you can help with code, testing, or documentation, your support is appreciated. Check the Wiki for details on how the camera works and how you can contribute.

Get Help

Support Development

If you find this integration useful, consider supporting its development:

PayPal


๐Ÿ™ Acknowledgments

Thank you to everyone using this integration and providing feedback, bug reports, and feature suggestions. Your support, understanding, and contributions make this project possible!


๐Ÿ“ Development Notes

  • Developed and tested on Raspberry Pi 4 with Home Assistant OS (latest version)
  • Also tested on ProxMox VE and Docker Supervised production environments
  • Maintained as a solo project with community support

๐Ÿ“„ License

See NOTICE.txt for license information and disclaimers.

About

Camera Integration for Home Assistant to export and render all Vacuums connected via MQTT( including Valetudo Hypfer, Congaduto and RE(rand256)) Maps.

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors