Updated README

This commit is contained in:
maziggy
2026-01-13 09:49:52 +01:00
parent b39aa492cd
commit 2db76c325b
3 changed files with 20 additions and 15 deletions
+18 -13
View File
@@ -31,7 +31,7 @@
## Why Bambuddy?
- **Own your data** — All print history stored locally, no cloud dependency
- **Works offline** — Uses LAN Mode for direct printer communication
- **Works offline** — Uses Developer Mode for direct printer control via local network
- **Full automation** — Schedule prints, auto power-off, get notified when done
- **Multi-printer support** — Manage your entire print farm from one interface
@@ -258,7 +258,7 @@
### Requirements
- Python 3.10+ (3.11/3.12 recommended)
- Bambu Lab printer with **LAN Mode** enabled
- Bambu Lab printer with **Developer Mode** enabled (see below)
- Same local network as printer
### Installation
@@ -392,12 +392,17 @@ Open **http://localhost:8000** and add your printer!
> **Need detailed instructions?** See the [Installation Guide](http://wiki.bambuddy.cool/getting-started/installation/)
### Enabling LAN Mode
### Enabling Developer Mode
1. On printer: **Settings** → **Network** → **LAN Mode**
2. Enable LAN Mode and note the **Access Code**
3. Find IP address in network settings
4. Find Serial Number in device info
Developer Mode allows third-party software like Bambuddy to control your printer over the local network.
1. On printer: **Settings** → **Network** → **LAN Only Mode** → Enable
2. Enable **Developer Mode** (appears after LAN Only Mode is enabled)
3. Note the **Access Code** displayed
4. Find IP address in network settings
5. Find Serial Number in device info
> **Note:** Developer Mode disables cloud features but provides full local control. Standard LAN Mode (without Developer Mode) only allows read-only monitoring.
---
@@ -415,12 +420,12 @@ Full documentation available at **[wiki.bambuddy.cool](http://wiki.bambuddy.cool
## 🖨️ Supported Printers
| Series | Models | Status |
|--------|--------|--------|
| H2 | H2C, H2D, H2S | ✅ Tested (H2D) |
| X1 | X1, X1 Carbon | ✅ Tested (X1C) |
| P1 | P1P, P1S | 🧪 Needs testing |
| A1 | A1, A1 Mini | 🧪 Needs testing |
| Series | Models |
|--------|--------|
| H2 | H2D, H2S |
| X1 | X1, X1 Carbon |
| P1 | P1P, P1S, P2S |
| A1 | A1, A1 Mini |
---
+1 -1
View File
@@ -56,7 +56,7 @@ Bambuddy communicates with your printers over your local network using:
2. **Use reverse proxy**: If exposing to the internet, use a reverse proxy with HTTPS
3. **Keep updated**: Always run the latest version for security patches
4. **Secure API keys**: Treat API keys like passwords; don't share them publicly
5. **LAN Mode**: Use your printer's LAN Mode access code; don't share it
5. **Developer Mode**: Use your printer's Developer Mode access code; don't share it
### Known Security Features
+1 -1
View File
@@ -460,7 +460,7 @@ async def test_camera_connection(
"success": False,
"error": (
"Failed to capture frame from camera. "
"Ensure the printer is powered on, camera is enabled, and LAN mode is active. "
"Ensure the printer is powered on, camera is enabled, and Developer Mode is active. "
"If running in Docker, try 'network_mode: host' in docker-compose.yml."
),
}