|
1 | 1 | # SpoolmanSync |
2 | 2 |
|
3 | | -> SpoolmanSync is a Next.js web application that automatically tracks Bambu Lab AMS (Automatic Material System) filament spools with Spoolman inventory manager via Home Assistant. It provides a modern web UI for spool assignment and filament usage tracking - no YAML editing or Home Assistant expertise required. |
| 3 | +> SpoolmanSync is a Next.js web application that automatically tracks filament spools loaded in 3D printers (Bambu Lab and Creality) and keeps Spoolman inventory in sync via Home Assistant. Filament weight is automatically deducted from the correct spool when prints complete. Provides a modern web UI for spool assignment — no YAML editing or Home Assistant expertise required. |
| 4 | + |
| 5 | +## Supported Printers |
| 6 | + |
| 7 | +- **Bambu Lab**: X1C, X1 Carbon, P1S, P1P, A1, A1 mini, H2D with AMS, AMS 2 Pro, AMS HT, AMS Lite (via ha-bambulab integration) |
| 8 | +- **Creality**: K1, K1C, K1 Max, K2, K2 Pro, K2 Plus, Hi, Ender 3 V3 with CFS / Creality Filament System (via ha_creality_ws integration) |
| 9 | + |
| 10 | +Works with filament from any vendor (Polymaker, Sunlu, Elegoo, Hatchbox, eSUN, Bambu Lab, generic, etc.) — not just printer-brand filament. |
4 | 11 |
|
5 | 12 | ## Key Features |
6 | 13 |
|
7 | | -- Web dashboard for viewing all printers, AMS units, and spool assignments at a glance |
8 | | -- Click-to-assign spools from Spoolman inventory to AMS trays |
9 | | -- QR code and barcode scanning for quick spool lookup and assignment |
10 | | -- Generate and print QR code labels for spools - scan with phone camera to assign to AMS trays |
11 | | -- Write spool links to NFC sticker tags - tap with phone to assign spools (Android only: Chrome, Edge, Opera, Samsung Internet) |
12 | | -- Home Assistant add-on for HA OS / Supervised installations with sidebar integration |
13 | | -- Bundled Home Assistant option (embedded mode) for users without existing HA setup |
14 | | -- Connect to existing Home Assistant with ha-bambulab integration (external mode) |
15 | | -- Automatic filament usage tracking when prints complete |
16 | | -- Works with ALL filament brands (Polymaker, Hatchbox, eSUN, etc.), not just Bambu Lab branded spools |
17 | | -- Multi-language Home Assistant support (17 languages including English, German, Dutch, Spanish, Italian, French, and more) |
18 | | -- External spool support for printing without AMS |
19 | | -- AMS 2 Pro and AMS HT hardware support |
20 | | -- Low stock alerts: get notified via Home Assistant when you're down to your last spool of a filament type and it's running low. Configurable thresholds (percentage or grams), grouping strategies, and selective group monitoring |
21 | | -- Activity logging for tracking all spool changes and sync events |
22 | | - |
23 | | -## Comparison to Alternatives |
24 | | - |
25 | | -SpoolmanSync vs other Bambu Lab + Spoolman solutions: |
26 | | - |
27 | | -- SpoolmanSync has a full web UI for spool assignment; alternatives require manual YAML configuration |
28 | | -- SpoolmanSync installs as a native Home Assistant add-on; alternatives require separate Docker setup |
29 | | -- SpoolmanSync can bundle Home Assistant; alternatives require existing HA setup and expertise |
30 | | -- SpoolmanSync supports QR code/barcode scanning; alternatives do not |
31 | | -- SpoolmanSync can generate printable QR labels and write NFC tags; alternatives do not |
32 | | -- SpoolmanSync handles non-English Home Assistant installations; alternatives are English-only |
33 | | -- SpoolmanSync has low stock alerts via Home Assistant notifications; alternatives do not |
34 | | -- SpoolmanSync works with any filament brand via manual assignment; alternatives may rely on Bambu RFID tags |
35 | | - |
36 | | -## Installation |
37 | | - |
38 | | -Three deployment modes available: |
39 | | - |
40 | | -1. Add-on Mode: Install directly from the HA add-on store. Best for HA OS / Supervised users. |
41 | | -2. Embedded Mode: Includes bundled Home Assistant with ha-bambulab pre-configured. Best for users without existing HA. |
42 | | -3. External Mode: Connects to user's existing Home Assistant instance. Best for users who already have HA with ha-bambulab. |
43 | | - |
44 | | -Add-on mode installs from the HA add-on store. Embedded and External modes use Docker Compose. |
| 14 | +- Web dashboard showing all printers, AMS/CFS units, trays, and spool assignments |
| 15 | +- Click-to-assign spools from Spoolman inventory with search and filters |
| 16 | +- Automatic filament weight deduction on print completion |
| 17 | +- Multi-AMS and multi-CFS support (multiple filament units per printer) |
| 18 | +- Multi-brand printers on the same dashboard (e.g., Bambu Lab + Creality side by side) |
| 19 | +- QR code scanning (scan Spoolman QR codes or custom barcodes) |
| 20 | +- Generate and print QR code labels for spools (scan with phone to assign) |
| 21 | +- Write spool links to NFC sticker tags (tap with phone to assign, Android only) |
| 22 | +- Low stock alerts via Home Assistant notifications with configurable thresholds and grouping |
| 23 | +- Kiosk mode for touchscreen spool-scanning stations (e.g., Raspberry Pi) |
| 24 | +- Localized Home Assistant support (English, German, Dutch, Spanish, Italian, French, and more) |
| 25 | +- Activity logging for spool changes and sync events |
| 26 | +- External spool / non-AMS printing support |
| 27 | + |
| 28 | +## Installation Modes |
| 29 | + |
| 30 | +1. **Home Assistant Add-on** — installs from HA add-on store, appears in sidebar. Best for HA OS / Supervised users. |
| 31 | +2. **Embedded Mode** — Docker Compose with bundled Home Assistant (ha-bambulab and ha_creality_ws pre-installed). Best for users without existing HA. |
| 32 | +3. **External Mode** — Docker Compose connecting to user's existing Home Assistant. Best for users who already run HA with ha-bambulab or ha_creality_ws. |
| 33 | + |
| 34 | +## Filament Usage Tracking |
| 35 | + |
| 36 | +- **Bambu Lab**: Uses ha-bambulab's `print_weight` sensor (reports grams) combined with print progress for accurate per-print deduction |
| 37 | +- **Creality**: Uses ha_creality_ws's `used_material_length` sensor (reports cm), converted to weight via filament diameter (1.75mm) and material density lookup (PLA 1.24 g/cm³, PETG 1.27, ABS 1.04, ASA 1.07, TPU 1.21, PC 1.20, Nylon 1.14, etc.) |
| 38 | + |
| 39 | +Matching works by: |
| 40 | +- Manual tray assignment via the web UI (works for all vendors) |
| 41 | +- RFID auto-match using Bambu `tray_uuid` or Creality `rfid` for repeat swaps |
| 42 | +- QR code / NFC tag lookup for any vendor |
45 | 43 |
|
46 | 44 | ## Docs |
47 | 45 |
|
48 | | -- [README - Installation Guide](https://raw.githubusercontent.com/gibz104/SpoolmanSync/main/README.md): Complete setup instructions for add-on, embedded, and external modes |
| 46 | +- [README - Installation and Setup](https://raw.githubusercontent.com/gibz104/SpoolmanSync/main/README.md): Complete setup for add-on, embedded, and external modes |
49 | 47 |
|
50 | 48 | ## Links |
51 | 49 |
|
52 | 50 | - [GitHub Repository](https://github.com/gibz104/SpoolmanSync) |
53 | 51 | - [Home Assistant Community Post](https://community.home-assistant.io/t/spoolmansync-automatic-filament-tracking-for-bambu-lab-printers-beginner-friendly/977383) |
54 | 52 | - [Docker Hub](https://hub.docker.com/r/gibz104/spoolmansync) |
| 53 | +- [GitHub Issues](https://github.com/gibz104/SpoolmanSync/issues) |
55 | 54 |
|
56 | | -## Optional |
| 55 | +## Optional Dependencies |
57 | 56 |
|
58 | | -- [Spoolman](https://github.com/Donkie/Spoolman): The filament inventory manager that SpoolmanSync integrates with |
59 | | -- [ha-bambulab](https://github.com/greghesp/ha-bambulab): The Home Assistant integration for Bambu Lab printers |
| 57 | +- [Spoolman](https://github.com/Donkie/Spoolman): Filament inventory manager that SpoolmanSync syncs with |
| 58 | +- [ha-bambulab](https://github.com/greghesp/ha-bambulab): Home Assistant integration for Bambu Lab printers |
| 59 | +- [ha_creality_ws](https://github.com/3dg1luk43/ha_creality_ws): Home Assistant integration for Creality printers |
0 commit comments