Home

Awesome

octoprint-spoolman

An OctoPrint plugin integrating with Spoolman, a universal filament spools inventory manager.

ToC

Features

Setup

Install via the bundled Plugin Manager or manually using this URL:

https://github.com/mdziekon/octoprint-spoolman/archive/master.zip

After installing the plugin, you have to set it up, by:

Screenshots

Selected spools list

Showcase - Selected spools list

Spools' list

Showcase - Spools' list

Spools verification

Showcase - Spools verification (success, multi-tool)

Showcase - Spools verification (error, single-tool)

Spoolman's setup

Showcase - Spoolman's setup

Development

You can use docker compose to start a development server, consisting of a test OctoPrint & Spoolman instances.

Note: the following steps have been tested on Linux-based OS. For Windows or MacOS - your mileage may vary.

Start the development server

docker compose up

Setup

On initial spin-up, you'll need to manually change permissions of the Spoolman directory:

# While in root directory of the project...
sudo chown 1000:1000 ./docker-data/spoolman

On first setup, you should configure your test Octoprint & Spoolman instances.

For Octoprint, there's currently no backup & restore method (problems with dockerized Octoprint not allowing to restore from backup), so you'll have to configure your instance manually (once).

For Spoolman, there's currently no backup & restore method, so you'll have to create spools manually.

Development

You can use docker compose to start a development server, consisting of a test OctoPrint & Spoolman instances.

docker compose up

App locations

Protips

Distributing

Zip folder method (manual)

zip -r octoprint-spoolman.zip octoprint-spoolman -x "**/.git/*" "**/docker-data/*" "**/octoprint_Spoolman/octoprint/**" "**/__pycache__/*"