Neatoロボット掃除機を復活させるカスタムサーバー
Custom server to revive neato bots (github.com)
要約
Vacuulaは、壊れたNeatoロボット掃除機を修理・制御するためのカスタムサーバープロジェクトです。Gen3およびGen4モデルの多くの機種をサポートし、Home AssistantやDocker Composeを使用したサーバーのセットアップ方法、およびロボット本体の設定手順を詳しく解説しています。これにより、古いロボット掃除機を再び使用可能にするためのソリューションを提供します。
全文翻訳
Vacuula
故障したロボット掃除機のためのカスタムサーバー
custom server for the undead robot vacuum cleaners
［画像: ko-fi］ ［画像: Buy me a coffee］
Discord | Repair my robot!
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!
| Feature | Status | Feature | Status | |
|---|---|---|---|---|
| Setup/Status | ✅ | Notifications | 🚧 | |
| Maps | ✅ | Home Assistant Entity | 🚧 | |
| Historical runs | ✅ | Drag to clean "here" | 🚧 | |
| Schedule | ✅ | Custom sounds | 🚧 | |
| Settings | ✅ | QoL improvements | 🚧 | |
| Zones/NoGo Lines | ✅ | "Next day" Schedule | 🚧 | |
| MultiZones | Gen4 ✅ Gen2/Gen3 🚧 |
Note
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
- 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)
- 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
- LXC/standalone
Docker Compose
- Install Docker
- This is probably the hardest part for anyone unfamiliar with self-hosting, so we have started writing a guide in the FAQ
- Download
docker-compose.yamlor runwget https://github.com/vacuula/vacuula/releases/latest/download/docker-compose.yamlto download and save the file - 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-dataVacuula 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
| Windows | Linux | Mac (M1 and newer) | Mac (Intel-based) |
|---|---|---|---|
| Win 10, Win 11 | Yes (need dialout) | 13.7.8, 15.4 | |
| Gen3, Gen4 | Gen3, Gen4 | (Gen4 will not work) | Gen3 (Gen4 does not work) |
- Download by clicking the os link, table shows tested/verified systems
- Linux: run
sudo usermod -aG dialout $USERto 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 by default
| Port | Option | Used by |
|---|---|---|
| 80 | VACUULA_PORT | Server, Webapp, Installer. (HTTP, reverse proxy for HTTPS) |
| 335 | GEN3_PORT | Gen3 robots, D3-D7 |
| 3443 | GEN4_PORT | Gen4 robots, D8-D10 |
The installer instructs the robot what port it should connect to. If you want to use HTTPS for the Webapp, please put the Webapp (default port 80) behind a reverse proxy. Other ports cannot be reverse provied.
Configuration
| Option | Default | Info |
|---|---|---|
| GEN3_PORT | 335 | Default port the Gen3 robots will connect to the server on |
| GEN4_PORT | 3443 | Default port the Gen4 robots will connect to the server on |
| VACUULA_PORT | 80 | Default port that you can reach the webapp/api on |
| GEN3_ENABLED | True | If server should support for Gen3 robots |
| GEN4_ENABLED | True | If server should support for Gen4 robots |
| MDNS_ENABLED | True | If server should run MDNS for auto-discovering |
| TZ | Etc/UTC | If timezone of computer cannot get fetched, please set this to the correct timezone for schedules to work correctly |
| HOST_IP | 0.0.0.0 | What IP the Vacuula server hosts to, useful if you have multiple IP addresses |
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.