🌀 WifiWhirl - Mache deinen LAY-Z-SPA™ Whirlpool smart! 🌀

Steuere und überwache deinen Bestway® LAY-Z-SPA™ Whirlpool bequem über WLAN mit der WifiWhirl Software.

---

🚀 Schnellzugriff

• ➡️ Ausführliche Anleitung (Installation, Selbstbau & Nutzung): wifiwhirl.de
• 🛠️ Selbstbau-Anleitung: wifiwhirl.de/Selbstbau/Einfuehrung (ohne Cloudfunktionalitäten)
• 🛒 Fertiges Modul kaufen: wifiwhirl.de/Modul/Kaufen (mit Cloudfunktionalitäten)
• ❓ Fragen & Diskussion (GitHub Issues): Issues

---

👋 Über das Projekt

Die WifiWhirl Software ist eine Open-Source-Softwarelösung für den ESP8266 Mikrocontroller, die es ermöglicht, die Pumpeneinheit von Bestway® LAY-Z-SPA™ Whirlpools über ein lokales WLAN-Netzwerk zu steuern und zu überwachen.

Du möchtest die Heizung von unterwegs starten, den Filterzyklus automatisieren oder deinen Pool in deine Smarthome Anwendungen einbinden? Mit WifiWhirl ist das möglich!

Das Projekt basiert zu großen Teilen auf der Software und dem Platinenlayout von visualapproach. Da seine Arbeit unter der GNU General Public License 3.0 (GPL-3.0) veröffentlicht wurde, steht auch diese WifiWhirl Softwareanpassung unter derselben Lizenz.

Dieses Repository enthält den Quellcode für die angepasste ESP8266-Firmware, sowie das angepasste Webfrontend.

Hinweis zur Funktionalität: Die hier im Repository veröffentlichte Open-Source-Software konzentriert sich auf die Steuerung des Whirlpools im lokalen Netzwerk (via Webinterface) und die MQTT-Integration für Smarthome-Systeme. Das separat erhältliche, fertige Modul bietet darüber hinaus optionale Cloud-Funktionen. Aktuell umfassen diese den Abruf von Wetterdaten für die Umgebungstemperatur basierend auf einer deutschen oder österreichischen Postleitzahl. Diese Cloud-spezifischen Erweiterungen sind nicht Teil dieses Repositorys.

---

↔️ Unterschiede zur Original-Software (visualapproach)

Obwohl die WifiWhirl Software auf der hervorragenden Arbeit von visualapproach basiert, gibt es einige Anpassungen und Erweiterungen in dieser Version:

• 🌐 Deutsche Benutzeroberfläche: Das gesamte Webinterface wurde für eine intuitive Bedienung im deutschsprachigen Raum vollständig ins Deutsche übersetzt.
• ⏰ Optimierte Automatisierung: Dedizierte Automatisierungsseite mit Befehlswarteschlange, Backup/Wiederherstellung und verbesserter Konfiguration.
• 🧹 Optimierter Code: Funktionen und Code-Teile der Originalsoftware, die für die reine Steuerung des Whirlpools nicht zwingend benötigt wurden, wurden entfernt, um die Codebasis schlanker und wartbarer zu gestalten.
• 🔥 Verbesserte Heizlogik: Ein häufiges Problem wurde adressiert: Die Heizung bleibt nun aktiv, auch wenn gleichzeitig ein programmierter Filterzyklus läuft.
• ⏰ Smart Schedule: Intelligente Heizplanung mit automatischer Berechnung der optimalen Startzeit basierend auf Wasser-, Ziel- und Umgebungstemperatur.
• 🧪 Wasserqualitätsüberwachung: Tracking von pH-Wert, Chlor, Cyanursäure und Alkalinität mit Zeitstempeln und Home Assistant Integration.
• ⚡ Energie-Monitoring: Echtzeit-Überwachung von Stromverbrauch und geschätzten Kosten im Dashboard.
• 🔌 REST API: Webhook-Endpunkte (/gettemps/, /getstates/) für einfache Integration mit externen Systemen.
• ☁️ Optionale Cloud-Anbindung: Für Nutzer des fertigen Moduls wurde eine optionale Cloud-Funktionalität integriert. Diese ermöglicht den Abruf von Wetterdaten für den Standort (basierend auf PLZ für DE/AT), um die Außentemperatur zu bestimmen und eine exakte Heizzeit zu berechnen (weitere Cloudfunktionen folgen).

---

✨ Features

• 🌡️ Temperatur: Aktuelle Wassertemperatur anzeigen und Ziel-Temperatur einstellen.
• 🔥 Heizung: Heizfunktion aktivieren und deaktivieren.
• 💧 Filterpumpe: Filterpumpe ein- und ausschalten.
• 💨 Sprudel-Funktion: Sprudel-Massage (AirJet™ und HydroJet™) steuern (mit konfigurierbaren Timeouts).
• 📊 Statusanzeige: Übersicht über alle aktuellen Zustände (Heizung an/aus, Filter an/aus, Temperatur etc.).
• 🌐 Webinterface: Einfache Bedienung über eine Weboberfläche im lokalen Netzwerk mit Dark Mode.
• 📲 MQTT-Integration: Anbindung an Smart-Home-Systeme wie Home Assistant, ioBroker etc. mit umfassender Auto-Discovery.
• 🧪 Wasserqualität: Überwachung von pH-Wert, Chlor, Cyanursäure und Alkalität mit Zeitstempeln.
• ⏰ Smart Schedule: Intelligente Heizplanung - Pool automatisch zur gewünschten Zeit auf Temperatur.
• ⚡ Energie-Monitoring: Überwachung von Stromverbrauch und geschätzten Kosten.
• 📡 WiFi-Scanning: Automatische Erkennung verfügbarer WiFi-Netzwerke mit Signalstärke-Anzeige.
• 🔄 Automatisierung: Dedizierte Seite zur Konfiguration von Befehlswarteschlangen mit Backup/Wiederherstellung.
• 🔌 REST API: Webhook-Endpunkte für einfache Integration mit externen Systemen.
• 🌐 HTTP Polling Fallback: Optionaler Polling-Modus als Alternative bei WebSocket-Verbindungsproblemen.

---

🛠️ Hardware & Selbstbau

Mit etwas Zeit, Aufwand und Geschick kannst du das WifiWhirl-Modul selbst nachbauen.

• Benötigte Komponenten: ESP8266 (z.B. Wemos D1 Mini), Pegelwandler, Steckverbinder, optional ein Gehäuse.
• ➡️ Zur Selbstbau-Anleitung: wifiwhirl.de/Selbstbau/Einfuehrung

---

💾 Software aufspielen (Flashen)

Um die WifiWhirl-Software auf einen ESP8266 zu übertragen (flashen), benötigst du:

• Einen ESP8266 Mikrocontroller (z.B. Wemos D1 Mini oder NodeMCU).
• Ein Micro-USB oder USB-C-Kabel zur Verbindung mit dem Computer.
• Software zum Flashen: PlatformIO mit Visual Studio Code.
• Ggf. Treiber für den USB-zu-Seriell-Chip deines ESP8266 (meist CH340 oder CP210x).

Grundlegende Schritte (Details siehe Anleitung!):

1. Repository klonen oder herunterladen:

   git clone https://github.com/WifiWhirl/WifiWhirl-Software.git

2. Projekt öffnen: Öffne den Ordner Code im Projektordner in VS Code mit PlatformIO.
3. Abhängigkeiten installieren: PlatformIO sollte benötigte Bibliotheken automatisch herunterladen.
4. Konfiguration anpassen: Benenne die Datei config.h.dist im Ordner src in config.h um und überprüfe die Einstellungen in der Datei.
5. ESP8266 anschließen: Verbinde den ESP8266 per USB mit deinem Computer
6. Kompilieren & Hochladen: Starte den Build- und Upload-Vorgang über PlatformIO (Upload-Button). Frontend-Assets sind in die Firmware eingebettet - ein separates Filesystem-Upload ist nicht mehr nötig.

➡️ Detaillierte Flash-Anleitung: https://wifiwhirl.de/Selbstbau/Software/

---

💡 Benutzung & Einrichtung

Nachdem die Software erfolgreich auf den ESP8266 geflasht wurde:

1. Modul anschließen: Verbinde das WifiWhirl-Modul gemäß der Anleitung mit der Steuereinheit deines LAY-Z-SPA™. Achtung: Arbeite nur bei vom Stromnetz getrennter Pumpe!
   ➡️ Anschluss-Anleitung: Modell S100101 oder Modell S200102
2. Erster Start & WLAN-Konfiguration:
   • Beim ersten Start (oder nach einem Reset) spannt das Modul einen eigenen WLAN-Access-Point auf (Standardname: wifiwhirl. Der Name wird in der Datei config.h unter DEVICE_NAME konfiguriert).
   • Verbinde dich mit diesem WLAN (Standardpasswort: wifiwhirl-AP. Das Passwort wird in der Datei config.h unter wmApPassword konfiguriert).
   • Öffne einen Webbrowser und gehe zur Adresse http://192.168.4.1.
   • Folge den Anweisungen, um das Modul mit deinem WLAN zu verbinden.
3. Zugriff auf das Webinterface:
   • Nach erfolgreicher WLAN-Verbindung erhält das Modul eine IP-Adresse von deinem Router.
   • Du findest die IP-Adresse oft über die Weboberfläche deines Routers heraus. Alternativ kannst du das Modul per mDNS unter dem konfigurierten DEVICE_NAME finden. Damit erreichst du das Modul unter http://[DEVICE_NAME].local (Standard: wifiwhirl.local).
   • Gib alternativ die IP-Adresse in deinem Browser ein, um auf das WifiWhirl-Webinterface zuzugreifen und deinen Pool zu steuern.

➡️ Details zur WLAN Verbindung: wifiwhirl.de/Modul/WLAN
➡️ Details zur Einrichtung: wifiwhirl.de/Modul/Einrichtung

---

⚙️ Technologie-Stack

• Mikrocontroller: ESP8266
• Framework: Arduino für ESP8266 (PlatformIO)
• Programmiersprachen: Backend: C++, Frontend: HTML, CSS, JS
• Wichtige Bibliotheken:
  • ArduinoJson: Verarbeitung von JSON-Daten.
  • WebSockets: Für die Echtzeitkommunikation mit dem Frontend.
  • PubSubClient: Für die MQTT-Integration in Smarthome-Systeme.
  • ESPAsyncTCP & ESPAsyncWebServer: Grundlage für den asynchronen Webserver und die Websocket-Kommunikation.
  • EspSoftwareSerial: Software-Emulation serieller Schnittstellen.
  • WiFiManager: Zur einfachen Konfiguration der WLAN-Verbindung.

---

🤝 Mitwirken

Du möchtest helfen, WifiWhirl zu verbessern? Beiträge sind willkommen!

1. Forke das Repository.
2. Erstelle einen neuen Branch (git checkout -b feature/DeinFeature).
3. Implementiere deine Änderungen.
4. Committe deine Änderungen (git commit -m 'feat: Füge DeinFeature hinzu').
5. Pushe zum Branch (git push origin feature/DeinFeature).
6. Öffne einen Pull Request.

Bei größeren Änderungen oder neuen Features eröffne bitte zuerst ein Issue, um die Idee zu diskutieren.

---

📄 Lizenz

Dieses Projekt steht unter der GNU General Public License v3.0. Die Details findest du in der LICENSE-Datei.

Wie erwähnt, basiert dieses Projekt auf der Arbeit von visualapproach, welche ebenfalls unter GPL-3.0 veröffentlicht wurde.

---

📫 Kontakt & Support

• Hauptanlaufstelle & Dokumentation: wifiwhirl.de
• Fertiges Modul kaufen: wifiwhirl.de/Modul/Kaufen
• Probleme, Bugs oder Feature-Wünsche: Bitte erstelle ein GitHub Issue. Falls du ein Modul gekauft hast, folge den Anweisungen unter wifiwhirl.de/Hilfe
• Projekt-Repository: github.com/WifiWhirl/WifiWhirl-Software

---

LAY-Z-SPA™ ist eine eingetragene Marke von Bestway Inflatables & Material Corp. Dieses Projekt steht in keiner Verbindung zu Bestway®.

English

If you're looking for the English version of this README, you can find it in the README_EN.md file: https://github.com/WifiWhirl/WifiWhirl-Software/blob/master/README_EN.md

If you are searching for the original software in English please visit the visualapproach repo: https://github.com/visualapproach/WiFi-remote-for-Bestway-Lay-Z-SPA