Skip to content

Welcome to Bumper ๐Ÿค–

Bumper is a local replacement for Ecovacs cloud services, allowing your robots and apps to connect entirely within your home network โ€” without needing access to the original cloud.

It supports both XMPP and MQTT-based models transparently.

Disclaimer: This project is a work in progress and may contain errors or missing parts. Please refer to the documentation and source code for complete details.


โš™๏ธ Requirements

  • A Wi-Fi enabled Ecovacs robot
  • A server in your local network to run the Bumper services
  • Python (latest version) with uv or Docker
  • A DNS server capable of overriding specific domain queries
  • A client that can connect and control the robot:

๐Ÿš€ Quick Start

1. ๐Ÿค– Prepare your Robot

  • Set up your robot using the official Ecovacs app (initial Wi-Fi configuration, registration, etc.)

2. ๐ŸŒ Set up DNS

  • Configure your local DNS server to override specific Ecovacs domains.
  • Detailed setup instructions: DNS Setup

3. ๐Ÿ› ๏ธ Install and Run Bumper

  • Follow the installation and usage instructions in the README.md
    or refer to Docker Setup if using Docker.

4. ๐Ÿ”’ Certificates

  • Bumper requires valid certificates to operate.
  • Instructions for manually creating certificates are available here: Create Certificates

๐Ÿ“‹ Logs and Troubleshooting

Bumper writes log files into the /logs directory by default.
You can also monitor real-time output:

  • If running manually: logs appear directly in the terminal.
  • If running via Docker: use docker logs <container-name> to view logs.

For more detailed output and debugging:

  • Additional debugging can be enabled using environment variables.
    See Environment Variables for a list of available debug options.

๐Ÿ“š Next Steps

Happy cleaning! ๐Ÿงน