vacuula/vacuula

Source: https://github.com/vacuula/vacuula

Vacuula

Vacuula is made as an all-in-one solution to repair and control your broken Neato Robot vacuum.

• Gen1 - No wifi
• Gen2 - BotVac Connected ❌ (not yet, on the todo ⏱️)
• Gen3 - D3 ✅ D4 ✅ D5 ✅ D6 ✅ D7 ✅
• Gen4 - D800 ✅ D8 ✅ D9 ✅ D10 ✅

Your robot not listed here? Get in touch!
¹Sadly we were not able to fit the OG BotVac Connected into the initial release, sorry about this, support for this robot is in the works and here very soon!

Do you have a Gen4 robot that is in “rainbow mode”? Different colors flashing and the robot does not start? Contact us in the discord. There we can help you repair your robot!

Repair my robot!

For the repair there are two parts

1. Set up a server (we are looking into a community server, however, that is not done in time for initial release, so you will need to set a server up)
2. Configure the robot

Set up server

Since the server needs to always be on to work properly, you need some dedicated hardware for it. If you do not already have something to run the server on, please read about hardware in the FAQ.

There are many ways to set this server up. If you are using Home Assistant, we recommend using the App Store repo we made, if not using Home Assistant, then Docker Compose is recommended. We provide you with a couple of ways to set up the server

• Docker Compose (see below)
• As an App in Home Assistant
  • 
  • Button above not working? Click here for instructions
• LXC/standalone

Docker Compose

1. Install Docker
   • This is probably the hardest part for anyone unfamiliar with self-hosting, so we have started writing a guide in the FAQ
2. Download docker-compose.yaml or run wget https://github.com/vacuula/vacuula/releases/latest/download/docker-compose.yaml to download and save the file
3. Run docker compose up -d

• The server is configured by environment variables
• To see logs do docker compose logs vacuula
• To stop vacuula docker compose down
• To start vacuula docker compose up -d
• To permanently remove stored data docker volume rm vacuula-data Vacuula needs to be stopped first

Configure the robot

We have made an easy to use installer to set your robot up!

Download the latest version for your OS here

• Download by clicking the os link, table shows tested/verified systems
• Linux: run sudo usermod -aG dialout $USER to give your user dialout, then reboot your computer!

Source code is available at https://github.com/vacuula/installer
If you have a more exotic setup and cannot run this installer in any way - get in touch and we will figure something out!

Configure server

Ports used

Gen3 robots sadly require port 443, and if enabled, the Vacuula server and webapp are also hosted here for PWAs to work

Configuration

Platform architecture

We have currently only tested and verified on ARM 64-bit and x86 64-bit. However, we want the server to support at least ARM 32-bit and possibly x86 32-bit as well. We are looking into what we can do to make sure these platforms are also supported. The main reason behind wanting to support them is that the server can run on older SBCs.