mirror of
https://github.com/Donkie/Spoolman.git
synced 2026-10-23 02:22:20 -05:00
Donkie
b4292398f5
Six specs for the tag feature. They are a reader: the contract a scanner implements is one ordinary POST, so linking, tap-to-fill, moving a tag off another spool, auto-navigate, the unknown-tag report and pairing are all drivable without NFC hardware. Web NFC is the one path with no automated cover -- there is no way to present a physical tag to headless Chromium -- so what is asserted instead is that its control is absent where it cannot work, which is the failure mode that would otherwise reach a desktop user. Two things the specs have to be careful about, both documented in place: the server broadcasts an identical (uid, reader_id) only once every few seconds, so polling invents a new reader id per attempt rather than having its retries swallowed; and tags never expire, so UIDs are minted per run rather than hard-coded, since the specs turn on whether a UID is free or taken. The translucency spec found its filament by looking for its group header in the library, which only works while the instance holds fewer than the 20 groups a page shows. Every spec adds a filament, so that assumption was going to expire on its own -- these six merely get it there sooner. It now goes through search, like the specs that already had to.
Keep track of your inventory of 3D-printer filament spools.
Spoolman is a self-hosted web service designed to help you efficiently manage your 3D printer filament spools and monitor their usage. It acts as a centralized database that seamlessly integrates with popular 3D printing software like OctoPrint and Klipper/Moonraker. When connected, it automatically updates spool weights as printing progresses, giving you real-time insights into filament usage.
Features
- Filament Management: Keep comprehensive records of filament types, manufacturers, and individual spools.
- API Integration: The REST API allows easy integration with other software, facilitating automated workflows and data exchange.
- Real-Time Updates: Stay informed with live spool updates through Websockets, providing immediate feedback during printing operations.
- Central Filament Database: A community-supported database of manufacturers and filaments simplify adding new spools to your inventory. Contribute by heading to SpoolmanDB.
- Web-Based Client: Spoolman includes a built-in web client that lets you manage data effortlessly:
- View, create, edit, and delete filament data.
- Search, group and filter your inventory by manufacturer, material, location and more.
- Add custom fields to tailor information to your specific needs.
- Design and print labels with QR codes for easy spool identification and tracking.
- Contribute to its translation into 18 languages via Weblate.
- Database Support: SQLite, PostgreSQL, MySQL, and CockroachDB.
- Multi-Printer Management: Handles spool updates from several printers simultaneously.
- Advanced Monitoring: Integrate with Prometheus for detailed historical analysis of filament usage, helping you track and optimize your printing processes. See the Wiki for instructions on how to set it up.
Spoolman integrates with:
- Moonraker and most front-ends (Fluidd, KlipperScreen, Mainsail, ...)
- OctoPrint
- OctoEverywhere
- Home Assistant
- MCP Server - Manage your filament inventory through AI assistants like Claude using the Model Context Protocol
Web client preview:
 |
 |
| Dashboard — spools as cards, grouped by location or any other field. Drag one to move it. | Label designer — QR labels built from any spool, filament or vendor field. |
Installation
Please see the Installation page on the Wiki for details how to install Spoolman.
If the new client misbehaves on your setup, set SPOOLMAN_LEGACY_CLIENT=TRUE to go back to
the previous one. Both ship in every release and talk to the same API, so your data is
untouched either way — but please report the problem
so it can be fixed.