Repository navigation
v2.3.0-beta.1 (pre-release)
Pre-release
Pre-release
Spooler v2.3.0-beta.1 (pre-release)
This is a beta. It is a big step up from 2.2.6 and has not been tried by many people yet. Please read "How to test" and "Going back" before you update. The :latest image is not changed by this release.
Image: ghcr.io/tharje/spooler-v2:beta (or the exact :2.3.0-beta.1)
What's new since 2.2.6
- Status you can trust – idle / preparing / printing / paused / complete / cancelled / error, with what the printer is doing while it prepares (heating nozzle or bed, homing, leveling, loading filament …); the cause and error code when a print pauses or fails (about 33 Centauri Carbon 2 codes and the Centauri Carbon 1 screen codes); layer count on the card; "last updated" and dimming of stale data now use the server's clock.
- Filament accounting you can trust – every deduction is written to a ledger before it is sent to Spoolman and retried until Spoolman takes it, never twice. Spoolman being down, a restart in the middle of a print, a printer counter that resets, or a spool change no longer loses or doubles filament. Deductions that did not go through are listed under Spools (Try again / Discard), with a badge on the Spools button.
- File upload from the UI – Centauri Carbon 1 and 2, Klipper (Moonraker) and Prusa (PrusaLink).
- Notifications – browser push, ntfy, Telegram, Discord or a webhook, with new events (print started, paused, error with cause, filament runout, printer offline/online, firmware changed) and an optional camera picture.
- Stats & history – statistics per period and printer, every past print with a picture taken when it ended, its details, and a reference number you can put on it; CSV export.
- Automatic light – per Centauri Carbon printer: on when a print starts, off when it ends.
- External API – other programs (a CRM, a dashboard) can read the history and pictures and set reference numbers with API keys. Off by default. See docs/external-api.md.
- Firmware notice – the firmware version on every card, with a small yellow "untested firmware" notice for versions that aren't in the tested list. See "Tested firmware" in the README.
- Backup & restore, feature switches, integrations and the Report bug button (it builds a redacted diagnostics report and opens a prefilled GitHub issue).
- Webhook notifications carry
schema_version, a uniqueidper event and a UTCtimestamp(see docs/external-api.md). - Centauri Carbon 2: Spooler registers again when the printer stops answering, so the light button and other commands keep working.
- Filament catalogue import for any brand from SpoolmanDB; login-off warning; many fixes.
Please test especially
- Centauri Carbon 2 file upload (new; follows what Elegoo's own slicer does). Upload a small file first.
- Error messages and pause causes – start something that fails or pause from the printer's screen and from the Elegoo app; does the card say why?
- Notification channels – set up one (ntfy is the quickest) and press Send test.
- Backup and restore – make a backup, and try restoring it on a spare setup.
- Statistics and the print list – do the numbers match what you printed?
- Filament deductions – stop Spoolman for a while during a short print, start it again, and check the spool got the right grams once.
- Anything on Klipper (Moonraker) or Prusa (PrusaLink) printers: these remain experimental and the firmware lookup for them is unconfirmed.
Known limitations
- Moonraker and PrusaLink support is experimental and has not been verified on real printers (including their firmware lookup); Centauri Carbon 1 + Canvas and several CC2 details are not verified on real hardware.
- Centauri Carbon 1: the reason for a pause made on the printer's screen or in the Elegoo app is not shown yet (the printer doesn't say, as far as we know). Centauri Carbon 2 shows the cause it reports.
- Pictures are not included in backups; the print history is.
- A print that ends while Spooler is not running is deducted with the last amount Spooler saw.
- The light-before-picture option does not exist; a Centauri Carbon 1 camera may be dark with the light off (use Automatic light).
Reporting problems
Use Report bug in the footer: pick the printer, describe what happened, and it opens a prefilled GitHub issue with a redacted diagnostics report (IP addresses, serial numbers, names and access codes removed). Please mention your printer and firmware version.
Going back to 2.2.6
- Before you update, make a backup (Settings → Backup → download), and keep the zip.
- To go back, change the image to
ghcr.io/tharje/spooler-v2:2.2.6(or the tag you used before) and restart. Your data folder keeps working: this was tested by running the 2.2.6 code against a data folder written by 2.3.0 (history, printers, features, integrations, notification settings, tray links all load). - What does not carry over to 2.2.6: API keys, the filament ledger (deductions still waiting for Spoolman will not be sent by 2.2.6; resolve them first under Spools), reference numbers, print pictures, per-printer options such as Automatic light. They stay in the data folder and come back when you return to 2.3.
- Do not restore a 2.3.0 backup in 2.2.6 if it contains API keys or ledger entries: 2.2.6 refuses backups with files it doesn't know ("Unrecognised file in backup: api_tokens.json"). A 2.3.0 backup without those files restores fine. If you need that, restore it in 2.3.0 instead, or remove
api_tokens.jsonandspoolman_ledger.jsonfrom the zip and from itsmanifest.json.