Vacuula is een custom server-oplossing ontwikkeld om Neato-robotstofzuigers te repareren en te beheren, specifiek gericht op de Gen3 en Gen4 modellen. De software biedt diverse functionaliteiten zoals het beheren van kaarten, planningen en zones, terwijl functies zoals notificaties en Home Assistant-integratie nog in ontwikkeling zijn.
Het implementatieproces bestaat uit twee fasen:
- Serverinstallatie: De server kan worden opgezet via Docker Compose, Home Assistant of LXC, en is compatibel met ARM 64-bit en x86 64-bit architecturen.
- Robotconfiguratie: Via een specifieke installer voor Windows, Linux of macOS wordt de robot gekoppeld aan de server.
De server maakt gebruik van specifieke poorten (80, 443 en 3443) om communicatie met de verschillende robotgeneraties mogelijk te maken.
Vacuula: Custom server voor "onsterfelijke" robotstofzuigers
Ondersteunde modellen
- Gen1: Geen wifi.
- Gen2: BotVac Connected ❌ (nog niet beschikbaar, staat op de planning ⏱️).
- Gen3: D3 �
, D4 � , D5 � , D6 � , D7 � .
, D8 � , D9 � , D10 � .
Opmerking: Helaas kon de originele BotVac Connected niet worden opgenomen in de eerste release. Ondersteuning voor deze robot is in ontwikkeling en volgt spoedig.
Functionaliteiten
| Functionaliteit | Status | Functionaliteit | Status |
|---|
| Setup/Status | � |
| Historische runs | � |
|
| Notificaties | 🚧 | "Schoon hier" (verslepen) | 🚧 |
| Kaarten | � |
| Planning (Schedule) | � |
|
| Home Assistant Entity | 🚧 | Aangepaste geluiden | 🚧 |
| Zones/NoGo-lijnen | � |
| Instellingen | � |
|
| MultiZones | Gen4 � |
| / Gen2/Gen3 🚧 | "Volgende dag" planning | 🚧 |
| | QoL-verbeteringen | 🚧 |
Belangrijke opmerking voor Gen4-gebruikers
Heeft u een Gen4-robot die zich in "rainbow mode" bevindt (verschillende kleuren knipperen en de robot start niet)? Neem contact op via Discord voor hulp bij het repareren van uw robot.
Reparatieproces
De reparatie bestaat uit twee delen:
- Het opzetten van een server.
- Het configureren van de robot.
1. De server opzetten
Omdat de server constant aan moet staan om correct te functioneren, is speciale hardware nodig. Raadpleeg de FAQ voor informatie over hardware indien u hier nog niet over beschikt.
Er zijn verschillende manieren om de server te installeren:
- Home Assistant: Gebruik de door ons gemaakte App Store repo.
- Docker Compose: Aanbevolen voor gebruikers zonder Home Assistant.
- LXC/Standalone.
Installatie via Docker Compose
Voor gebruikers die onbekend zijn met self-hosting, is er een handleiding beschikbaar in de FAQ.
Stappen:
- Installeer Docker.
- Download
docker-compose.yaml via de releases-pagina of gebruik het volgende commando:
wget https://github.com/vacuula/vacuula/releases/latest/download/docker-compose.yaml
- Start de server met:
docker compose up -d
Beheercommando's:
- Logs bekijken:
docker compose logs vacuula
- Stoppen:
docker compose down
- Starten:
docker compose up -d
- Opgeslagen data permanent verwijderen:
docker volume rm vacuula-data (de server moet eerst gestopt zijn).
De server wordt geconfigureerd via omgevingsvariabelen (environment variables).
2. De robot configureren
Er is een gebruiksvriendelijke installer beschikbaar om de robot in te stellen.
Beschikbare downloads per besturingssysteem:
Ondersteund (Gen3, Gen4).
Ondersteund (Gen3, Gen4). Let op: voer sudo usermod -aG dialout $USER uit om uw gebruiker dialout-rechten te geven en start daarna uw computer opnieuw op.
Ondersteund (Gen3, Gen4).
Ondersteund (alleen Gen3; Gen4 werkt niet).
De broncode voor de installer is beschikbaar op: https://github.com/vacuula/installer
---
Serverconfiguratie
Poorten
De volgende poorten worden gebruikt:
| Poort | Informatie |
|---|
| 80 | Server, Webapp (Aanpasbaar) |
| 443 | Gen3 robots, D3-D7 (Niet aanpasbaar) |
| 3443 | Gen4 robots, D8-D10 (Aanpasbaar) |
Opmerking: Gen3-robots vereisen poort 443. Indien ingeschakeld, worden de Vacuula-server en webapp ook hier gehost zodat PWA's (Progressive Web Apps) werken.
Configuratie-opties
| Optie | Standaardwaarde | Informatie |
|---|
GEN4_PORT | 3443 | Standaardpoort waarop Gen4-robots verbinding maken met de server. |
VACUULA_PORT | 80 | Standaardpoort voor toegang tot de webapp/api. |
GEN3_ENABLED | True | Bepaalt of de server ondersteuning biedt voor Gen3-robots (nodig vanwege poort 443). |
GEN4_ENABLED | True | Bepaalt of de server ondersteuning biedt voor Gen4-robots. |
MDNS_ENABLED | True | Bepaalt of de server MDNS uitvoert voor automatische detectie. |
Platformarchitectuur
Momenteel is de server getest en geverifieerd op ARM 64-bit en x86 64-bit. Er wordt gewerkt aan ondersteuning voor ARM 32-bit en mogelijk x86 32-bit, zodat de server ook op oudere Single Board Computers (SBC's) kan draaien.
Vacuula: Custom server voor "onsterfelijke" robotstofzuigers
Ondersteunde modellen
- Gen1: Geen wifi.
- Gen2: BotVac Connected ❌ (nog niet beschikbaar, staat op de planning ⏱️).
- Gen3: D3 �
, D4 � , D5 � , D6 � , D7 � .
, D8 � , D9 � , D10 � .
Opmerking: Helaas kon de originele BotVac Connected niet worden opgenomen in de eerste release. Ondersteuning voor deze robot is in ontwikkeling en volgt spoedig.
Functionaliteiten
| Functionaliteit | Status | Functionaliteit | Status |
|---|
| Setup/Status | � |
| Historische runs | � |
|
| Notificaties | 🚧 | "Schoon hier" (verslepen) | 🚧 |
| Kaarten | � |
| Planning (Schedule) | � |
|
| Home Assistant Entity | 🚧 | Aangepaste geluiden | 🚧 |
| Zones/NoGo-lijnen | � |
| Instellingen | � |
|
| MultiZones | Gen4 � |
| / Gen2/Gen3 🚧 | "Volgende dag" planning | 🚧 |
| | QoL-verbeteringen | 🚧 |
Belangrijke opmerking voor Gen4-gebruikers
Heeft u een Gen4-robot die zich in "rainbow mode" bevindt (verschillende kleuren knipperen en de robot start niet)? Neem contact op via Discord voor hulp bij het repareren van uw robot.
Reparatieproces
De reparatie bestaat uit twee delen:
- Het opzetten van een server.
- Het configureren van de robot.
1. De server opzetten
Omdat de server constant aan moet staan om correct te functioneren, is speciale hardware nodig. Raadpleeg de FAQ voor informatie over hardware indien u hier nog niet over beschikt.
Er zijn verschillende manieren om de server te installeren:
- Home Assistant: Gebruik de door ons gemaakte App Store repo.
- Docker Compose: Aanbevolen voor gebruikers zonder Home Assistant.
- LXC/Standalone.
Installatie via Docker Compose
Voor gebruikers die onbekend zijn met self-hosting, is er een handleiding beschikbaar in de FAQ.
Stappen:
- Installeer Docker.
- Download
docker-compose.yaml via de releases-pagina of gebruik het volgende commando:
wget https://github.com/vacuula/vacuula/releases/latest/download/docker-compose.yaml
- Start de server met:
docker compose up -d
Beheercommando's:
- Logs bekijken:
docker compose logs vacuula
- Stoppen:
docker compose down
- Starten:
docker compose up -d
- Opgeslagen data permanent verwijderen:
docker volume rm vacuula-data (de server moet eerst gestopt zijn).
De server wordt geconfigureerd via omgevingsvariabelen (environment variables).
2. De robot configureren
Er is een gebruiksvriendelijke installer beschikbaar om de robot in te stellen.
Beschikbare downloads per besturingssysteem:
Ondersteund (Gen3, Gen4).
Ondersteund (Gen3, Gen4). Let op: voer sudo usermod -aG dialout $USER uit om uw gebruiker dialout-rechten te geven en start daarna uw computer opnieuw op.
Ondersteund (Gen3, Gen4).
Ondersteund (alleen Gen3; Gen4 werkt niet).
De broncode voor de installer is beschikbaar op: https://github.com/vacuula/installer
---
Serverconfiguratie
Poorten
De volgende poorten worden gebruikt:
| Poort | Informatie |
|---|
| 80 | Server, Webapp (Aanpasbaar) |
| 443 | Gen3 robots, D3-D7 (Niet aanpasbaar) |
| 3443 | Gen4 robots, D8-D10 (Aanpasbaar) |
Opmerking: Gen3-robots vereisen poort 443. Indien ingeschakeld, worden de Vacuula-server en webapp ook hier gehost zodat PWA's (Progressive Web Apps) werken.
Configuratie-opties
| Optie | Standaardwaarde | Informatie |
|---|
GEN4_PORT | 3443 | Standaardpoort waarop Gen4-robots verbinding maken met de server. |
VACUULA_PORT | 80 | Standaardpoort voor toegang tot de webapp/api. |
GEN3_ENABLED | True | Bepaalt of de server ondersteuning biedt voor Gen3-robots (nodig vanwege poort 443). |
GEN4_ENABLED | True | Bepaalt of de server ondersteuning biedt voor Gen4-robots. |
MDNS_ENABLED | True | Bepaalt of de server MDNS uitvoert voor automatische detectie. |
Platformarchitectuur
Momenteel is de server getest en geverifieerd op ARM 64-bit en x86 64-bit. Er wordt gewerkt aan ondersteuning voor ARM 32-bit en mogelijk x86 32-bit, zodat de server ook op oudere Single Board Computers (SBC's) kan draaien.
Groetjes,