added documentation
This commit is contained in:
245
Documentation/Manual.md
Normal file
245
Documentation/Manual.md
Normal file
@@ -0,0 +1,245 @@
|
||||
# Kettenöler – Bedienungsanleitung
|
||||
|
||||
Diese Anleitung beschreibt Installation, Bedienung und Wartung des Smart Chain Oiler Systems.
|
||||
|
||||
---
|
||||
|
||||
## 1. Einleitung & Sicherheit
|
||||
|
||||
Der Smart Chain Oiler ist ein intelligenter, mikrocontroller‑gesteuerter Kettenöler für Motorräder.
|
||||
|
||||
⚠️ **Sicherheits- und Nutzungshinweise:**
|
||||
|
||||
* Der Einbau erfordert grundlegende Kenntnisse in Elektronik und Fahrzeugtechnik.
|
||||
* Öl darf nur auf die Kette aufgetragen werden – nicht auf Reifen oder Bremsen.
|
||||
* Ein leerer Tank oder Fehlfunktion kann zum Ausfall der automatischen Schmierung führen. Kette regelmäßig prüfen.
|
||||
* Nutzung auf eigene Verantwortung.
|
||||
|
||||
---
|
||||
|
||||
## 2. Systemübersicht
|
||||
|
||||
**Bedienung:**
|
||||
|
||||
* 1x Taster (multifunktional)
|
||||
* RGB‑LED (Statusanzeige)
|
||||
* Optional: I²C OLED‑Display (128x64)
|
||||
* Erweiterte Einstellungen und Wartung über WebUI (WiFi‑Access Point)
|
||||
|
||||
**Komponenten:**
|
||||
|
||||
* ESP8266 MCU (Wemos D1 mini)
|
||||
* Pumpe (empfohlen: McCoi Spezial‑Ölpumpe)
|
||||
* Tank (frei wählbar, Größe im WebUI einstellbar)
|
||||
|
||||
---
|
||||
|
||||
## 3. Installation & Anschluss
|
||||
|
||||
### Versorgung
|
||||
|
||||
* **Spannungsversorgung:** 12 V DC
|
||||
* **Anschluss:** **Zündungs-Plus (ACC)**, nicht Dauerplus (verhindert Batterieentladung)
|
||||
* **Absicherung:** **5 A Sicherung** empfohlen (kurzzeitige hohe Stromaufnahme von 1A bis 2A der Pumpe möglich)
|
||||
|
||||
### Anschlussklemmen & Header
|
||||
|
||||
* **Power-Klemme (3-polige Schraubklemme):**
|
||||
|
||||
* Pin 1: **+12 V** (Zündungsplus, ggf. Sicherung vorschalten)
|
||||
* Pin 2: **Pumpen-Minus** (geht auf MOSFET → wird geschaltet)
|
||||
* Pin 3: **GND** (gemeinsame Masse)
|
||||
* 👉 Pumpen-Plus kommt direkt an +12 V (hinter der Sicherung).
|
||||
|
||||
* **Cockpit-Header (LED/Taster/OLED):**
|
||||
|
||||
| Pin | Signal | Bemerkung |
|
||||
| --- | --------- | ----------------------------------------------------------- |
|
||||
| 1 | SDA (I²C) | Datenleitung für OLED, Pull-Up 4k7 auf 3,3 V |
|
||||
| 2 | +5 V | Versorgung für Cockpit (LED, OLED etc.) |
|
||||
| 3 | SCL (I²C) | Taktleitung für OLED, Pull-Up 4k7 auf 3,3 V |
|
||||
| 4 | LED Data | WS2812 LED Datenleitung (über R3=100 Ω) |
|
||||
| 5 | +3,3 V | I²C/OLED Versorgung (vom ESP8266 intern bereitgestellt) |
|
||||
| 6 | Taster | GPIO2, gegen GND, mit Schutzdiode |
|
||||
| 7 | GND | Masse |
|
||||
| 8 | GND | Masse |
|
||||
|
||||
* ⚠️ Die Leitungen des Display sollten **kurz gehalten werden** (Faustregel: <20 cm bei ungeschirmten Leitungen).
|
||||
|
||||
* **Signal-Header (Eingänge):**
|
||||
|
||||
| Pin | Signal | Bemerkung |
|
||||
| --- | ----------- | -------------------------------------------------------- |
|
||||
| 1 | GND | Masse |
|
||||
| 2 | K-Line OBD2 | OBD2 K-Line, geht auf den MC33660 |
|
||||
| 3 | SERIAL\_RX | UART0 RX (für GPS oder CLI), geschützt durch Diode |
|
||||
| 4 | SERIAL\_TX | UART0 TX (CLI, Debug) |
|
||||
| 5 | GPIO\_PULSE | Impulseingang (Pickup/Tachosignal), RC-gefiltert + Diode |
|
||||
| 6 | CAN\_L | Low-Leitung für CAN |
|
||||
| 7 | GND | Masse (zweiter Anschluss, symmetrisch) |
|
||||
| 8 | CAN\_H | High-Leitung für CAN |
|
||||
|
||||
👉 Details siehe Anschluss‑Schemata der jeweiligen PCB‑Revision.
|
||||
|
||||
---
|
||||
|
||||
## 4. LED-Anzeigen
|
||||
|
||||
* **Grün** → Normalmodus (Standard-Schmierung)
|
||||
* **Blau** → Regenmodus (verstärkte Schmierung)
|
||||
* **Pink blinkend** → Prime/Entlüften aktiv
|
||||
* **Türkis** → Wash‑Mode aktiv
|
||||
* **Gelb aufblitzend** → WiFi‑AP aktiv
|
||||
* **Orange** → Warnung (Tank niedrig, EEPROM Sanity, oder anderes DTC/WARN)
|
||||
* **Rot** → Kritischer Fehler (DTC\_CRITICAL, Öler gestoppt)
|
||||
|
||||
---
|
||||
|
||||
## 5. Bedienung über den Taster
|
||||
|
||||
Prinzip: **Taste gedrückt halten → LED‑Farbe beobachten → bei gewünschter Farbe loslassen**.
|
||||
|
||||
* **0,5–3,5 s halten → loslassen:** Normal (Grün) ↔ Regen (Blau)
|
||||
* **3,5–6,5 s halten → loslassen:** Wash‑Mode aktivieren (Türkis)
|
||||
* **6,5–9,5 s halten → loslassen:** Prime / Entlüften starten (Pink blinkend)
|
||||
* **9,5–12,5 s halten → loslassen:** WiFi‑AP ein-/ausschalten (Gelb)
|
||||
|
||||
---
|
||||
|
||||
## 6. Funktionsbeschreibung der Modi
|
||||
|
||||
### Normalmodus (Grün)
|
||||
|
||||
* Schmierimpuls alle **8.000 m** (Standard, im WebUI anpassbar)
|
||||
* Zähler metergenau, auch über Neustarts hinweg
|
||||
|
||||
### Regenmodus (Blau)
|
||||
|
||||
* Schmierimpuls alle **4.000 m** (Standard, im WebUI anpassbar)
|
||||
* Zuletzt gewählter Modus wird gespeichert und nach Neustart übernommen
|
||||
|
||||
### Wash‑Mode (Türkis)
|
||||
|
||||
* Für Pflege nach Reinigung (z. B. Hochdruckreiniger)
|
||||
* Standard: alle **10 m** ein Impuls über **500 m**
|
||||
* Danach automatische Rückkehr in Normal/Regen
|
||||
|
||||
### Prime / Entlüften (Pink blinkend)
|
||||
|
||||
* Standard: **25 Impulse**, Leitung spülen oder Luft entfernen
|
||||
* Auch über WebUI startbar
|
||||
|
||||
### WiFi-AP (Gelb)
|
||||
|
||||
* Aktiviert den Access Point für das WebUI
|
||||
* Zugriff auf Einstellungen, Wartung und Updates
|
||||
|
||||
**So geht’s:**
|
||||
|
||||
1. **Taster gedrückt halten**, bis die LED **Gelb** aufleuchtet → dann loslassen.
|
||||
2. Der WiFi-Hotspot startet und bleibt **bis zum nächsten Neustart** aktiv.
|
||||
3. SSID: **`ChainLube_XXXXXX`** (XXXXXX = ChipID des ESP8266)
|
||||
4. Passwort: **`wifiappass`**
|
||||
5. Smartphone/PC mit dem Hotspot verbinden.
|
||||
* Android meldet evtl. *„Dieses Netzwerk hat keine Internetverbindung“* → trotzdem verbunden bleiben.
|
||||
6. Browser öffnen → **[http://10.0.0.1](http://10.0.0.1)** aufrufen → WebUI erscheint.
|
||||
|
||||
### Tanküberwachung
|
||||
|
||||
* Virtuell, basierend auf Tankgröße im WebUI
|
||||
* **Orange LED + WARN DTC:** Tank fast leer
|
||||
* **Rot LED + CRITICAL DTC:** Tank leer, Öler gestoppt
|
||||
* Tank jederzeit im WebUI zurücksetzbar
|
||||
|
||||
---
|
||||
|
||||
## 7. WebUI Bedienung
|
||||
|
||||
WiFi‑AP öffnen → Browser → `10.0.0.1`
|
||||
|
||||
### Tabs & Funktionen
|
||||
|
||||
* **Home:** Tankstand %, Status, aktive DTCs
|
||||
* **Wartung:** Tank zurücksetzen, Purge starten, Einmessen, Live‑Debug, Reboot
|
||||
* **Einstellungen:** Signalquelle (Impuls/CAN/GPS/OBD), Dosierung, Tankgröße, LED, WiFi
|
||||
* **Update:** Firmwareversionen, Flash‑Version, Git‑Revision, Firmware‑ und Filesystem‑Update, EEPROM‑Backup/Restore
|
||||
|
||||
👉 Wechsel der Signalquelle führt zu Neustart!
|
||||
|
||||
---
|
||||
|
||||
Genau so machen wir’s 🐺✨ – hier meine überarbeiteten Versionen für die beiden Abschnitte plus ein Vorschlag für den Feedback-Teil am Ende:
|
||||
|
||||
---
|
||||
|
||||
### **8. Diagnose (DTC)**
|
||||
|
||||
### Kategorien
|
||||
|
||||
* **INFO:** Nur im WebUI sichtbar, keine LED-Reaktion
|
||||
* **WARN (Orange):** Hinweis, Betrieb läuft weiter
|
||||
* **CRITICAL (Rot):** Kritisch, Pumpe gestoppt
|
||||
|
||||
### Darstellung
|
||||
|
||||
* **Alle aktiven DTCs** werden **im WebUI mit Volltext und Beschreibung angezeigt**.
|
||||
* Über die LED wird nur die Schwere (Warnung/Kritisch) signalisiert.
|
||||
|
||||
### Typische Beispiele
|
||||
|
||||
* **Tank leer (CRITICAL, Rot):** Vorrat nachfüllen, Tank im WebUI zurücksetzen
|
||||
* **Tank niedrig (WARN, Orange):** Vorrat bald auffüllen
|
||||
* **EEPROM/Flash Fehler (CRITICAL, Rot):** Speicher zurücksetzen, ggf. Hardware prüfen
|
||||
* **GPS/CAN/OBD Fehler:** Verbindung oder Konfiguration prüfen
|
||||
* **Dummy-DTCs:** nur für Debugzwecke
|
||||
|
||||
👉 Vollständige Liste aller Codes und Texte siehe `dtc_defs.txt` / `dtc_table.json`.
|
||||
|
||||
---
|
||||
|
||||
## 9. Troubleshooting
|
||||
|
||||
| Symptom | Ursache | Lösung |
|
||||
| -------------------------- | ------------------------------------------ | --------------------------------------------- |
|
||||
| LED dauerhaft Rot | Kritischer DTC (Tank leer, EEPROM, Flash) | WebUI öffnen, DTC prüfen, Ursache beheben |
|
||||
| Keine Schmierung | Tank leer oder Pumpe blockiert | Tank auffüllen, Purge starten, Pumpe prüfen |
|
||||
| Kein WebUI erreichbar | AP nicht aktiv | Taste 9,5–12,5 s halten, auf Gelb warten |
|
||||
| GPS zeigt nichts | Falsche Baudrate oder kein Signal | Baudrate im WebUI prüfen, Antenne freie Sicht |
|
||||
| CAN/OBD funktioniert nicht | Falsches Modell oder Jumper falsch gesetzt | Einstellungen prüfen, Jumper korrekt setzen |
|
||||
|
||||
---
|
||||
|
||||
---
|
||||
|
||||
### **10. Wartung**
|
||||
|
||||
* Regelmäßig Ölstand prüfen und im WebUI nach dem Nachfüllen **Tank zurücksetzen**
|
||||
* Nach längeren Standzeiten (z. B. Winterpause) einmal **Prime/Purge** laufen lassen, um die Leitung zu spülen
|
||||
* Kabel & Anschlüsse auf festen Sitz und Isolation prüfen
|
||||
* Software- und WebUI-Updates **nur bei Bedarf** einspielen (z. B. bei neuen Funktionen oder Bugfixes)
|
||||
|
||||
---
|
||||
|
||||
## **11. Technische Daten**
|
||||
|
||||
* **Versorgung:** 12 V DC (Motorradbatterie), \~50 mA (ohne Pumpe)
|
||||
* **MCU:** ESP8266 (Wemos D1 mini)
|
||||
* **Tankgröße:** frei einstellbar (ml)
|
||||
* **Dosierung:** konfigurierbar in µl pro Puls
|
||||
* **Signalquellen:** Impuls, GPS, CAN (KTM), OBD2 (CAN/K‑Line)
|
||||
* **Speicher:** EEPROM für CFG & PDS, Checksummen & Sanity Checks
|
||||
* **Pumpen:** abgestimmt auf McCoi Spezial‑Ölpumpe
|
||||
* **Betriebstemperatur:** −10 bis +70 °C
|
||||
|
||||
---
|
||||
|
||||
## **12. Feedback & Community**
|
||||
|
||||
Dieses Projekt lebt vom Feedback und den Ideen der Nutzer.
|
||||
|
||||
* Wenn du Fehler findest oder Verbesserungsvorschläge hast → melde dich!
|
||||
* Auch neue Ideen für Features oder Anpassungen an andere Motorräder sind willkommen.
|
||||
* Rückmeldungen helfen, den Öler stabiler, praktischer und vielseitiger zu machen.
|
||||
* Diskussionen, Tests und Spinnereien sind ausdrücklich erwünscht – manchmal entstehen daraus die besten Features.
|
||||
|
||||
💡 Ja, mir ist klar: das Ding ist für „einfach nur Kette ölen“ eigentlich hoffnungslos **over-engineered** – aber genau das macht den Reiz aus. Ich hab Spaß daran und freue mich über alles, was das Projekt noch ein Stück nerdiger, smarter oder einfach nützlicher macht.
|
||||
Reference in New Issue
Block a user