Compare commits
2 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 5eda8a241f | |||
| 2aaaa5bbbe |
262
README.de.md
262
README.de.md
@@ -1,160 +1,182 @@
|
||||
<p align="center"><img src="knlogo.png" alt="KX-Bridge Logo" width="180"/></p>
|
||||
<div align="center">
|
||||
|
||||
# KX-Bridge – Anycubic Kobra X
|
||||
<img src="knlogo.png" alt="KX-Bridge" width="160"/>
|
||||
|
||||
**Version:** 0.9.8
|
||||
# KX-Bridge
|
||||
|
||||
Steuere deinen **Anycubic Kobra X** mit OrcaSlicer — ohne Klipper, ohne Raspberry Pi.
|
||||
KX-Bridge ist eine Moonraker-kompatible Bridge die direkt mit dem Drucker kommuniziert.
|
||||
**Steuere deinen Anycubic Kobra X mit OrcaSlicer — ohne Klipper, ohne Raspberry Pi.**
|
||||
|
||||
Eine Moonraker-kompatible Bridge, die direkt mit dem Drucker spricht.
|
||||
|
||||
<sub>🇬🇧 <a href="README.md">English version</a></sub>
|
||||
|
||||
<br>
|
||||
|
||||
[](https://ko-fi.com/viewitde)
|
||||
|
||||
[](https://gitea.it-drui.de/viewit/KX-Bridge-Release/releases)
|
||||
|
||||
[](https://www.youtube.com/watch?v=1Ql4wfH27fM)
|
||||
|
||||
<sub>Gefällt dir KX-Bridge? Ein Kaffee auf <a href="https://ko-fi.com/viewitde">Ko-fi</a> hält das Projekt am Leben. ☕</sub>
|
||||
|
||||
</div>
|
||||
|
||||
---
|
||||
|
||||
## Schnellstart in 3 Schritten
|
||||
## ✨ Was kann KX-Bridge?
|
||||
|
||||
### Schritt 1 – Drucker vorbereiten
|
||||
| | Feature |
|
||||
|---|---|
|
||||
| 🖨️ | **Druckersteuerung** — Start, Pause, Resume, Abbruch, Temperaturen, Druckgeschwindigkeit |
|
||||
| 📊 | **Live-Status** — Temperatur, Fortschritt, Layer, Restzeit, Kamera-Stream |
|
||||
| 🎨 | **AMS / Multicolor** — Filament-Slots, Per-Kanal-Remapping, MMU-Emulation für OrcaSlicer Filament-Sync |
|
||||
| 🗂️ | **GCode-Browser** — hochgeladene Dateien mit Thumbnail, Druckhistorie, Suche & Filter |
|
||||
| 🧩 | **Multi-Printer** — mehrere Drucker in **einer** Bridge-Instanz, Umschalten per Dropdown |
|
||||
| ➕ | **Drucker hinzufügen per Klick** — nur die IP eingeben, Zugangsdaten werden automatisch importiert |
|
||||
| 🔄 | **Self-Update** — neue Versionen direkt im Browser installieren |
|
||||
| 🌐 | **OrcaSlicer** — volles Moonraker-Protokoll (HTTP + WebSocket), DE/EN UI |
|
||||
|
||||
Den Kobra X in den LAN-Modus versetzen:
|
||||
**Drucker-Display → Einstellungen → LAN-Modus einschalten**
|
||||
---
|
||||
|
||||
### Schritt 2 – Credentials holen
|
||||
## 🚀 Schnellstart
|
||||
|
||||
Die MQTT-Zugangsdaten sind druckerspezifisch und an die Hardware gebunden.
|
||||
### 1. Drucker vorbereiten
|
||||
|
||||
**Option A – fetch_credentials (empfohlen):**
|
||||
LAN-Modus am Kobra X aktivieren:
|
||||
**Drucker-Display → Einstellungen → LAN-Modus aktivieren**
|
||||
|
||||
### 2. Bridge starten
|
||||
|
||||
**Docker (empfohlen):**
|
||||
```bash
|
||||
docker compose up -d
|
||||
```
|
||||
|
||||
**Linux-Binary (kein Docker):**
|
||||
```bash
|
||||
chmod +x kx-bridge && ./kx-bridge
|
||||
```
|
||||
|
||||
**Windows-EXE (kein Docker):**
|
||||
```
|
||||
kx-bridge.exe
|
||||
```
|
||||
> `config\` und `data\` werden neben der EXE angelegt — portabel.
|
||||
|
||||
> Bei Linux- und Windows-Binary liegen `config/` und `data/` (Einstellungen, SQLite,
|
||||
> GCode-Store) jeweils neben dem Programm. Einfach den ganzen Ordner kopieren = umziehen.
|
||||
|
||||
**Python direkt:**
|
||||
```bash
|
||||
pip install -r bridge/requirements.txt
|
||||
python bridge/kobrax_moonraker_bridge.py
|
||||
```
|
||||
|
||||
### 3. Drucker einrichten
|
||||
|
||||
Web-UI öffnen: **`http://BRIDGE-IP:7125`**
|
||||
|
||||
Beim Erststart erscheint der **Drucker-Tab** mit *„+ Drucker hinzufügen"* — einfach die
|
||||
IP-Adresse des Druckers eingeben, der Rest (Username, Passwort, Device-ID) wird automatisch
|
||||
vom Drucker geholt und entschlüsselt. Fertig.
|
||||
|
||||
> Mehrere Drucker? Einfach mehrfach *„+ Drucker hinzufügen"* — jeder bekommt seinen eigenen
|
||||
> Port (7125, 7126, …) und ist im Header-Dropdown auswählbar.
|
||||
|
||||
### 4. OrcaSlicer verbinden
|
||||
|
||||
Drucker → Verbindungstyp **Moonraker** → Host: `http://BRIDGE-IP:7125`
|
||||
|
||||
> ⚠️ Verbindungstyp muss **Moonraker** sein (nicht „Bambu" oder „Klipper").
|
||||
> Vollständige URL inkl. `http://` und Port `:7125` im Host-Feld eintragen.
|
||||
|
||||
---
|
||||
|
||||
## 📺 Video-Tutorial
|
||||
|
||||
[](https://www.youtube.com/watch?v=1Ql4wfH27fM)
|
||||
|
||||
---
|
||||
|
||||
## 🔧 Zugangsdaten manuell ermitteln
|
||||
|
||||
Normalerweise nicht nötig — *„+ Drucker hinzufügen"* macht das automatisch. Falls doch:
|
||||
|
||||
```bash
|
||||
fetch_credentials --ip 192.168.x.x --write-config
|
||||
```
|
||||
Holt die Zugangsdaten per HTTP direkt vom Drucker und schreibt sie in `config/config.ini`.
|
||||
Nur die Drucker-IP nötig, kein Slicer.
|
||||
|
||||
Holt die Credentials direkt per HTTP vom Drucker und schreibt sie automatisch in `config/config.ini`. Benötigt nur die Drucker-IP — kein Slicer nötig.
|
||||
Alternativ (wenn die IP unbekannt ist): AnycubicSlicerNext öffnen, Drucker verbinden,
|
||||
dann `extract_credentials` ausführen → gibt Username, Passwort, Device-ID und IP aus.
|
||||
|
||||
**Option B – extract_credentials (wenn Drucker-IP unbekannt):**
|
||||
> **Downloads:** [Releases](https://gitea.it-drui.de/viewit/KX-Bridge-Release/releases) → `fetch_credentials` / `extract_credentials` (Linux & Windows)
|
||||
|
||||
1. **AnycubicSlicerNext** öffnen und Drucker verbinden (bis Status angezeigt wird)
|
||||
2. **`extract_credentials`** ausführen — gibt Username, Password, Device-ID und Drucker-IP aus
|
||||
3. Werte im Web-UI eintragen (⚙-Menü)
|
||||
---
|
||||
|
||||
> **Download:** [gitea.it-drui.de/viewit/KX-Bridge-Release/releases](https://gitea.it-drui.de/viewit/KX-Bridge-Release/releases) → `fetch_credentials` / `extract_credentials` (Linux & Windows) im jeweiligen Release-Asset
|
||||
|
||||
### Schritt 3 – Bridge starten
|
||||
## ⚙️ Nützliche Befehle
|
||||
|
||||
```bash
|
||||
./start.sh
|
||||
```
|
||||
|
||||
Das Skript baut das Docker-Image automatisch beim ersten Aufruf.
|
||||
|
||||
**Web-UI öffnen:** `http://BRIDGE-IP:7125`
|
||||
→ Das ⚙-Menü öffnet sich beim ersten Start automatisch
|
||||
→ Bei Option B: Credentials aus Schritt 2 eintragen → **Speichern & Neustart**
|
||||
|
||||
**OrcaSlicer verbinden:**
|
||||
Drucker → Verbindungstyp **Moonraker** → Host: `http://BRIDGE-IP:7125`
|
||||
|
||||
> **Wichtig:** Verbindungstyp muss **Moonraker** sein (nicht „Bambu" oder „Klipper").
|
||||
> Im Host-Feld vollständige URL mit `http://` und Port `:7125` angeben.
|
||||
|
||||
---
|
||||
|
||||
## 📺 Video Tutorial
|
||||
|
||||
[](https://www.youtube.com/watch?v=1Ql4wfH27fM)
|
||||
|
||||
---
|
||||
|
||||
## ⚠️ Update von 0.9.1 oder älter
|
||||
|
||||
Ab **0.9.2** speichert KX-Bridge Einstellungen in `config/config.ini` statt in `.env`.
|
||||
|
||||
**Migration erfolgt automatisch** — keine manuelle Aktion nötig:
|
||||
- Beim ersten Start nach dem Update liest die Bridge die vorhandene `.env` und erstellt `config/config.ini` automatisch
|
||||
- Einstellungen bleiben ab sofort nach `docker-compose restart` und zukünftigen Updates erhalten
|
||||
- Die `.env`-Datei bleibt read-only gemountet als Migrationsquelle — kann liegen bleiben
|
||||
- Zum manuellen Anlegen einer `config.ini`: Vorlage unter `config/config.ini.example` kopieren
|
||||
|
||||
---
|
||||
|
||||
## Was wird unterstützt?
|
||||
|
||||
| Funktion | Details |
|
||||
|----------|---------|
|
||||
| Druckerstatus | Temperatur, Fortschritt, Zustand, Restzeit |
|
||||
| Drucksteuerung | Start, Pause, Fortsetzen, Abbrechen |
|
||||
| Temperaturregelung | Nozzle und Bett während des Drucks |
|
||||
| Druckgeschwindigkeit | Leise / Normal / Sport |
|
||||
| AMS-Farbwechsel | Filament einziehen / ausziehen |
|
||||
| Licht & Lüfter | Drucklicht und Lüfterdrehzahl |
|
||||
| Web-UI | Dashboard, Achsensteuerung, Kameraansicht |
|
||||
| Self-Update | Neue Versionen direkt im Browser installieren |
|
||||
| OrcaSlicer | Moonraker-Protokoll (HTTP + WebSocket) |
|
||||
|
||||
---
|
||||
|
||||
## Alternativen zu Docker
|
||||
|
||||
**Linux Binary** (kein Docker nötig):
|
||||
```bash
|
||||
chmod +x kx-bridge
|
||||
./kx-bridge
|
||||
```
|
||||
|
||||
**Python direkt:**
|
||||
```bash
|
||||
pip install aiohttp
|
||||
python bridge/kobrax_moonraker_bridge.py
|
||||
```
|
||||
|
||||
Web-UI jeweils unter `http://localhost:7125` — ⚙-Menü führt durch die Erstkonfiguration.
|
||||
|
||||
---
|
||||
|
||||
## Nützliche Befehle
|
||||
|
||||
```bash
|
||||
# Logs anzeigen
|
||||
docker-compose logs -f
|
||||
|
||||
# Bridge stoppen
|
||||
docker-compose down
|
||||
|
||||
# Bridge neu starten (nach Update)
|
||||
./start.sh
|
||||
docker compose logs -f # Logs anzeigen
|
||||
docker compose down # Bridge stoppen
|
||||
docker compose up -d --build # Bridge neu bauen & starten (nach Update)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Fehlerbehebung
|
||||
## 🩹 Troubleshooting
|
||||
|
||||
**„Falsche MQTT-Zugangsdaten"** beim Start:
|
||||
- `fetch_credentials --ip <Drucker-IP> --write-config` erneut ausführen und Bridge neu starten
|
||||
- Wenn IP unbekannt: AnycubicSlicerNext neu starten, Drucker verbinden, `extract_credentials` erneut ausführen
|
||||
- Nur die IP-Adresse ins Feld eintragen, keinen Port (✗ `192.168.1.102:9883` → ✓ `192.168.1.102`)
|
||||
<details>
|
||||
<summary><b>"Falsche MQTT-Zugangsdaten" beim Start</b></summary>
|
||||
|
||||
**Drucker nicht gefunden / kein LAN-Modus:**
|
||||
- Am Drucker-Display: Einstellungen → LAN-Modus einschalten
|
||||
- Drucker über *„+ Drucker hinzufügen"* erneut hinzufügen, oder
|
||||
`fetch_credentials --ip <ip> --write-config` ausführen und Bridge neu starten
|
||||
- Nur die IP-Adresse eingeben, ohne Port (✗ `192.168.1.102:9883` → ✓ `192.168.1.102`)
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary><b>Drucker nicht gefunden / kein LAN-Modus</b></summary>
|
||||
|
||||
- Am Drucker-Display: Einstellungen → LAN-Modus aktivieren
|
||||
- Drucker und Bridge müssen im selben Netzwerk sein
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary><b>Docker: Permission denied</b></summary>
|
||||
|
||||
**Docker: Permission denied:**
|
||||
```bash
|
||||
sudo usermod -aG docker $USER # dann neu einloggen
|
||||
sudo usermod -aG docker $USER # danach aus- und wieder einloggen
|
||||
```
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary><b>Upgrade von 0.9.1 oder älter</b></summary>
|
||||
|
||||
Ab 0.9.2 speichert KX-Bridge die Einstellungen in `config/config.ini` statt `.env`.
|
||||
Die Migration läuft automatisch beim ersten Start nach dem Upgrade — keine Aktion nötig.
|
||||
</details>
|
||||
|
||||
---
|
||||
|
||||
## Sicherheitshinweise
|
||||
## 🔒 Sicherheit
|
||||
|
||||
- Die Bridge ist im lokalen Netzwerk erreichbar unter `http://<Host-IP>:7125` — nicht ins Internet freigeben
|
||||
- `config/config.ini` enthält Drucker-Credentials — nicht öffentlich teilen
|
||||
- Credentials haben keinen Zugang zu Anycubic-Cloud-Diensten
|
||||
- Die Bridge ist im lokalen Netzwerk unter `http://<host-IP>:7125` erreichbar — **nicht** ins Internet exposen
|
||||
- `config/config.ini` enthält Drucker-Zugangsdaten — nicht öffentlich teilen
|
||||
- Die Zugangsdaten geben **keinen** Zugriff auf Anycubic-Cloud-Dienste
|
||||
|
||||
---
|
||||
|
||||
## Lizenz & Rechtliches
|
||||
## 📄 Lizenz
|
||||
|
||||
Interoperabilitätsforschung gem. §69e UrhG — ausschließlich private, nicht-kommerzielle Nutzung.
|
||||
Interoperabilitätsforschung gem. §69e UrhG — private, nicht-kommerzielle Nutzung.
|
||||
|
||||
<p align="center">
|
||||
<a href="https://ko-fi.com/viewitde">
|
||||
<img src="https://ko-fi.com/img/githubbutton_sm.svg" alt="Ko-fi Support"/>
|
||||
</a>
|
||||
</p>
|
||||
<div align="center">
|
||||
<br>
|
||||
|
||||
**Wenn dir KX-Bridge hilft, freut sich das Projekt über Unterstützung:**
|
||||
|
||||
[](https://ko-fi.com/viewitde)
|
||||
|
||||
</div>
|
||||
|
||||
207
README.md
207
README.md
@@ -1,47 +1,94 @@
|
||||
<p align="center"><img src="knlogo.png" alt="KX-Bridge Logo" width="180"/></p>
|
||||
<div align="center">
|
||||
|
||||
# KX-Bridge – Anycubic Kobra X
|
||||
<img src="knlogo.png" alt="KX-Bridge" width="160"/>
|
||||
|
||||
**Version:** 0.9.8
|
||||
# KX-Bridge
|
||||
|
||||
Control your **Anycubic Kobra X** with OrcaSlicer — no Klipper, no Raspberry Pi.
|
||||
KX-Bridge is a Moonraker-compatible bridge that communicates directly with the printer.
|
||||
**Control your Anycubic Kobra X with OrcaSlicer — no Klipper, no Raspberry Pi.**
|
||||
|
||||
A Moonraker-compatible bridge that talks directly to the printer.
|
||||
|
||||
<sub>🇩🇪 <a href="README.de.md">Deutsche Version</a></sub>
|
||||
|
||||
<br>
|
||||
|
||||
[](https://ko-fi.com/viewitde)
|
||||
|
||||
[](https://gitea.it-drui.de/viewit/KX-Bridge-Release/releases)
|
||||
|
||||
[](https://www.youtube.com/watch?v=1Ql4wfH27fM)
|
||||
|
||||
<sub>Like KX-Bridge? A coffee on <a href="https://ko-fi.com/viewitde">Ko-fi</a> keeps the project alive. ☕</sub>
|
||||
|
||||
</div>
|
||||
|
||||
---
|
||||
|
||||
## Quick Start in 3 Steps
|
||||
## ✨ Features
|
||||
|
||||
### Step 1 – Prepare the printer
|
||||
| | |
|
||||
|---|---|
|
||||
| 🖨️ | **Printer control** — start, pause, resume, cancel, temperatures, print speed |
|
||||
| 📊 | **Live status** — temperature, progress, layers, remaining time, camera stream |
|
||||
| 🎨 | **AMS / multicolor** — filament slots, per-channel remapping, MMU emulation for OrcaSlicer filament sync |
|
||||
| 🗂️ | **GCode browser** — uploaded files with thumbnails, print history, search & filter |
|
||||
| 🧩 | **Multi-printer** — multiple printers in **one** bridge instance, switch via dropdown |
|
||||
| ➕ | **Add a printer with one click** — just enter the IP, credentials are imported automatically |
|
||||
| 🔄 | **Self-update** — install new versions directly in the browser |
|
||||
| 🌐 | **OrcaSlicer** — full Moonraker protocol (HTTP + WebSocket), EN/DE UI |
|
||||
|
||||
Enable LAN mode on the Kobra X:
|
||||
---
|
||||
|
||||
## 🚀 Quick Start
|
||||
|
||||
### 1. Prepare the printer
|
||||
|
||||
Enable LAN mode on the Kobra X:
|
||||
**Printer display → Settings → Enable LAN mode**
|
||||
|
||||
### Step 2 – Get credentials
|
||||
|
||||
The MQTT credentials are printer-specific. Here's how to get them:
|
||||
|
||||
1. Open **AnycubicSlicerNext** and connect the printer (wait until status is shown)
|
||||
2. Run **`extract_credentials.exe`** (Windows) or **`extract_credentials`** (Linux) — outputs Username, Password, Device ID and printer IP
|
||||
3. Note / copy the values
|
||||
|
||||
> **Download:** [gitea.it-drui.de/viewit/KX-Bridge-Release/releases](https://gitea.it-drui.de/viewit/KX-Bridge-Release/releases) → `extract_credentials.exe` (Windows) / `extract_credentials` (Linux) in the release assets
|
||||
|
||||
### Step 3 – Start the bridge
|
||||
### 2. Start the bridge
|
||||
|
||||
**Docker (recommended):**
|
||||
```bash
|
||||
./start.sh
|
||||
docker compose up -d
|
||||
```
|
||||
|
||||
The script builds the Docker image automatically on first run.
|
||||
**Linux binary (no Docker):**
|
||||
```bash
|
||||
chmod +x kx-bridge && ./kx-bridge
|
||||
```
|
||||
|
||||
**Open Web-UI:** `http://BRIDGE-IP:7125`
|
||||
→ The ⚙ menu opens automatically on first start
|
||||
→ Enter credentials from Step 2 → **Save & Restart**
|
||||
**Windows EXE (no Docker):**
|
||||
```
|
||||
kx-bridge.exe
|
||||
```
|
||||
> `config\` and `data\` are created next to the EXE — portable.
|
||||
|
||||
> With the Linux and Windows binaries, `config/` and `data/` (settings, SQLite, GCode store)
|
||||
> live next to the program. Copy the whole folder = move the installation.
|
||||
|
||||
**Python directly:**
|
||||
```bash
|
||||
pip install -r bridge/requirements.txt
|
||||
python bridge/kobrax_moonraker_bridge.py
|
||||
```
|
||||
|
||||
### 3. Set up the printer
|
||||
|
||||
Open the Web UI: **`http://BRIDGE-IP:7125`**
|
||||
|
||||
On first start the **Printers tab** shows *"+ Add printer"* — just enter the printer's IP
|
||||
address, the rest (username, password, device ID) is fetched from the printer and decrypted
|
||||
automatically. Done.
|
||||
|
||||
> More than one printer? Just click *"+ Add printer"* again — each gets its own port
|
||||
> (7125, 7126, …) and is selectable from the header dropdown.
|
||||
|
||||
### 4. Connect OrcaSlicer
|
||||
|
||||
**Connect OrcaSlicer:**
|
||||
Printer → Connection type **Moonraker** → Host: `http://BRIDGE-IP:7125`
|
||||
|
||||
> **Important:** Connection type must be **Moonraker** (not "Bambu" or "Klipper").
|
||||
> ⚠️ Connection type must be **Moonraker** (not "Bambu" or "Klipper").
|
||||
> Enter the full URL including `http://` and port `:7125` in the host field.
|
||||
|
||||
---
|
||||
@@ -52,98 +99,84 @@ Printer → Connection type **Moonraker** → Host: `http://BRIDGE-IP:7125`
|
||||
|
||||
---
|
||||
|
||||
## ⚠️ Upgrading from 0.9.1 or earlier
|
||||
## 🔧 Getting credentials manually
|
||||
|
||||
Starting with **0.9.2**, KX-Bridge stores settings in `config/config.ini` instead of `.env`.
|
||||
Normally not needed — *"+ Add printer"* does this automatically. If you do need it:
|
||||
|
||||
**Migration is automatic** — no manual action required:
|
||||
- On first start after upgrade, the bridge reads your existing `.env` and creates `config/config.ini` automatically
|
||||
- Settings now survive `docker-compose restart` and future updates
|
||||
- The `.env` file stays mounted read-only as a migration source — you can keep it in place
|
||||
- If you want to create a `config.ini` manually: copy `config/config.ini.example`
|
||||
|
||||
---
|
||||
|
||||
## What's supported?
|
||||
|
||||
| Feature | Details |
|
||||
|---------|---------|
|
||||
| Printer status | Temperature, progress, state, remaining time |
|
||||
| Print control | Start, pause, resume, cancel |
|
||||
| Temperature control | Nozzle and bed during print |
|
||||
| Print speed | Silent / Normal / Sport |
|
||||
| AMS filament change | Load / unload filament |
|
||||
| Light & fan | Print light and fan speed |
|
||||
| Web-UI | Dashboard, motion control, camera view |
|
||||
| Self-update | Install new versions directly in the browser |
|
||||
| OrcaSlicer | Moonraker protocol (HTTP + WebSocket) |
|
||||
|
||||
---
|
||||
|
||||
## Alternatives to Docker
|
||||
|
||||
**Linux binary** (no Docker needed):
|
||||
```bash
|
||||
chmod +x kx-bridge
|
||||
./kx-bridge
|
||||
fetch_credentials --ip 192.168.x.x --write-config
|
||||
```
|
||||
Fetches the credentials directly from the printer via HTTP and writes them to `config/config.ini`.
|
||||
Only the printer IP is required, no slicer.
|
||||
|
||||
**Python directly:**
|
||||
```bash
|
||||
pip install aiohttp
|
||||
python bridge/kobrax_moonraker_bridge.py
|
||||
```
|
||||
Alternatively (if the IP is unknown): open AnycubicSlicerNext, connect the printer, then run
|
||||
`extract_credentials` → outputs username, password, device ID and the printer IP.
|
||||
|
||||
Web-UI available at `http://localhost:7125` — the ⚙ menu guides through initial setup.
|
||||
> **Downloads:** [Releases](https://gitea.it-drui.de/viewit/KX-Bridge-Release/releases) → `fetch_credentials` / `extract_credentials` (Linux & Windows)
|
||||
|
||||
---
|
||||
|
||||
## Useful commands
|
||||
## ⚙️ Useful commands
|
||||
|
||||
```bash
|
||||
# Show logs
|
||||
docker-compose logs -f
|
||||
|
||||
# Stop bridge
|
||||
docker-compose down
|
||||
|
||||
# Restart bridge (after update)
|
||||
./start.sh
|
||||
docker compose logs -f # show logs
|
||||
docker compose down # stop the bridge
|
||||
docker compose up -d --build # rebuild & start (after an update)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Troubleshooting
|
||||
## 🩹 Troubleshooting
|
||||
|
||||
**"Wrong MQTT credentials"** on start:
|
||||
- Restart AnycubicSlicerNext, reconnect the printer, run `extract_credentials` again
|
||||
<details>
|
||||
<summary><b>"Wrong MQTT credentials" on start</b></summary>
|
||||
|
||||
- Re-add the printer via *"+ Add printer"*, or run
|
||||
`fetch_credentials --ip <ip> --write-config` and restart the bridge
|
||||
- Enter only the IP address, no port (✗ `192.168.1.102:9883` → ✓ `192.168.1.102`)
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary><b>Printer not found / no LAN mode</b></summary>
|
||||
|
||||
**Printer not found / no LAN mode:**
|
||||
- On the printer display: Settings → Enable LAN mode
|
||||
- Printer and bridge must be on the same network
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary><b>Docker: Permission denied</b></summary>
|
||||
|
||||
**Docker: Permission denied:**
|
||||
```bash
|
||||
sudo usermod -aG docker $USER # then log out and back in
|
||||
sudo usermod -aG docker $USER # then log out and back in
|
||||
```
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary><b>Upgrading from 0.9.1 or earlier</b></summary>
|
||||
|
||||
Starting with 0.9.2, KX-Bridge stores settings in `config/config.ini` instead of `.env`.
|
||||
Migration runs automatically on first start after the upgrade — no action required.
|
||||
</details>
|
||||
|
||||
---
|
||||
|
||||
## Security
|
||||
## 🔒 Security
|
||||
|
||||
- The bridge is accessible on the local network at `http://<host-IP>:7125` — do not expose to the internet
|
||||
- The bridge is reachable on the local network at `http://<host-IP>:7125` — **do not** expose it to the internet
|
||||
- `config/config.ini` contains printer credentials — do not share publicly
|
||||
- Credentials do not grant access to Anycubic cloud services
|
||||
- The credentials do **not** grant access to Anycubic cloud services
|
||||
|
||||
---
|
||||
|
||||
## License
|
||||
## 📄 License
|
||||
|
||||
Interoperability research under §69e UrhG — private, non-commercial use only.
|
||||
|
||||
<p align="center">
|
||||
<a href="https://ko-fi.com/viewitde">
|
||||
<img src="https://ko-fi.com/img/githubbutton_sm.svg" alt="Ko-fi Support"/>
|
||||
</a>
|
||||
</p>
|
||||
<div align="center">
|
||||
<br>
|
||||
|
||||
**If KX-Bridge helps you, the project appreciates your support:**
|
||||
|
||||
[](https://ko-fi.com/viewitde)
|
||||
|
||||
</div>
|
||||
|
||||
Reference in New Issue
Block a user