Skip to content

Commit 3b4f605

Browse files
committed
Update documentation for Creality printer support
- Streamline README.md: ~65% shorter, consolidated install modes, removed competitor comparison and duplicated setup sections - Update llms.txt with supported printer models and per-brand filament tracking details - Update add-on DOCS.md and config.yaml description - Update HTML meta description, Unraid template, and docker-compose header to mention Creality alongside Bambu Lab
1 parent 3811872 commit 3b4f605

7 files changed

Lines changed: 106 additions & 312 deletions

File tree

README.md

Lines changed: 55 additions & 262 deletions
Large diffs are not rendered by default.

app/src/app/layout.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ const geistMono = Geist_Mono({
1818

1919
export const metadata: Metadata = {
2020
title: "SpoolmanSync",
21-
description: "Sync Bambu Lab AMS trays with Spoolman via Home Assistant",
21+
description: "Automatic filament tracking for Bambu Lab and Creality printers with Spoolman",
2222
};
2323

2424
export default async function RootLayout({

docker-compose.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# SpoolmanSync - Sync Bambu Lab AMS trays with Spoolman
1+
# SpoolmanSync - Automatic filament tracking for Bambu Lab and Creality printers with Spoolman
22
#
33
# Choose a profile based on your setup:
44
#

llms.txt

Lines changed: 43 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -1,59 +1,59 @@
11
# SpoolmanSync
22

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.
411

512
## Key Features
613

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
4543

4644
## Docs
4745

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
4947

5048
## Links
5149

5250
- [GitHub Repository](https://github.com/gibz104/SpoolmanSync)
5351
- [Home Assistant Community Post](https://community.home-assistant.io/t/spoolmansync-automatic-filament-tracking-for-bambu-lab-printers-beginner-friendly/977383)
5452
- [Docker Hub](https://hub.docker.com/r/gibz104/spoolmansync)
53+
- [GitHub Issues](https://github.com/gibz104/SpoolmanSync/issues)
5554

56-
## Optional
55+
## Optional Dependencies
5756

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

spoolmansync-ha-addon/DOCS.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# SpoolmanSync Add-on
22

3-
Sync Bambu Lab AMS trays with Spoolman filament inventory via Home Assistant.
3+
Automatic filament tracking for Bambu Lab and Creality printers with Spoolman.
44

55
## Installation
66

@@ -23,7 +23,8 @@ You can also configure the Spoolman URL from the SpoolmanSync Settings page afte
2323
## Requirements
2424

2525
- **Spoolman** running and accessible from Home Assistant
26-
- **ha-bambulab** integration installed via [HACS](https://hacs.xyz/)
26+
- For Bambu Lab printers: **ha-bambulab** integration installed via [HACS](https://hacs.xyz/)
27+
- For Creality printers: **ha_creality_ws** integration installed via [HACS](https://hacs.xyz/)
2728

2829
## Full Documentation
2930

spoolmansync-ha-addon/config.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
name: SpoolmanSync
22
version: "1.4.3"
33
slug: spoolmansync-ha-addon
4-
description: Sync Bambu Lab AMS trays with Spoolman filament inventory
4+
description: Automatic filament tracking for Bambu Lab and Creality printers with Spoolman
55
url: https://github.com/gibz104/SpoolmanSync
66
image: ghcr.io/gibz104/spoolmansync-addon
77
arch:

unraid/spoolmansync.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,12 @@
77
<Privileged>false</Privileged>
88
<Support>https://forums.unraid.net/topic/197146-support-spoolmansync-sync-bambu-lab-ams-with-spoolman/</Support>
99
<Project>https://github.com/gibz104/SpoolmanSync</Project>
10-
<Overview>Sync Bambu Lab AMS trays with Spoolman filament inventory via Home Assistant. Provides a web dashboard for assigning spools to AMS trays, QR/barcode scanning for quick spool lookup, and automatic filament usage tracking after prints. Requires Home Assistant with ha-bambulab integration and a Spoolman instance.</Overview>
10+
<Overview>Automatic filament tracking for Bambu Lab and Creality printers with Spoolman. Provides a web dashboard for assigning spools to AMS/CFS trays, QR/barcode scanning for quick spool lookup, and automatic filament usage tracking after prints. Supports Bambu Lab printers (X1C, P1S, A1, H2D) via ha-bambulab, and Creality printers (K1, K2, Hi, Ender 3 V3) via ha_creality_ws. Requires Home Assistant with the appropriate integration and a Spoolman instance.</Overview>
1111
<Category>HomeAutomation: Tools:</Category>
1212
<WebUI>http://[IP]:[PORT:3000]</WebUI>
1313
<TemplateURL>https://raw.githubusercontent.com/gibz104/SpoolmanSync/main/unraid/spoolmansync.xml</TemplateURL>
1414
<Icon>https://raw.githubusercontent.com/gibz104/SpoolmanSync/main/unraid/spoolmansync-icon.png</Icon>
15-
<Requires>Requires Home Assistant with ha-bambulab integration installed, and a Spoolman instance.</Requires>
15+
<Requires>Requires Home Assistant with ha-bambulab (for Bambu Lab) or ha_creality_ws (for Creality) integration installed, and a Spoolman instance.</Requires>
1616
<Config Name="WebUI Port" Target="3000" Default="3000" Mode="tcp" Description="Web interface port" Type="Port" Display="always" Required="true" Mask="false"/>
1717
<Config Name="App Data" Target="/data" Default="/mnt/user/appdata/spoolmansync" Mode="rw" Description="Application data including SQLite database" Type="Path" Display="always" Required="true" Mask="false"/>
1818
<Config Name="HA Mode" Target="HA_MODE" Default="external" Mode="" Description="Home Assistant mode. Use 'external' to connect to your existing HA instance." Type="Variable" Display="advanced" Required="false" Mask="false">external</Config>

0 commit comments

Comments
 (0)