Feature: Add Spoolman Compatability

[Ocraftyone]

Add Spoolman support to OrcaSlicer!

Spoolman is a self-hosted database of your spools of filament and how much has been used. This update now allows OrcaSlicer to directly access your Spoolman database to create and update filament profiles. One central database of all of your spool settings means less time inputting filament parameters.

Currently, this implementation is designed to only work with Klipper printers that have moonraker also set up with Spoolman. A macro can then be called at the beginning of each spool's custom gcode to load the spool via moonraker. Moonraker will then track how much filament was used and report that back to Spoolman.

Demo:

Filament config values that are set

Spoolman Specific:

• spoolman_spool_id
• spoolman_remaining_weight
• spoolman_used_weight
• spoolman_remaining_length
• spoolman_used_length
• spoolman_archived

Filament Options:

• filament_type
• filament_vendor
• filament_cost
• filament_density
• filament_diameter
• nozzle_temperature_initial_layer (set by adding 5 degrees to normal temp)
• nozzle_temperature
• hot_plate_temp_initial_layer (set by adding 5 degrees to normal temp)
• hot_plate_temp
• default_filament_colour

Other ideas to expand functionality:

• Check if spool has enough material to finish print upon slicing
• Add option to "consume" filament upon upload
• Store the entire filament configuration in Spoolman (via the Spoolman API's "extras" section)

Possible Changes:
Statistics are currently a config value that is updated upon request, but I am considering making it so they are just pulled when you select a Spoolman spool This has been implemented.

Moonraker Docs on how to setup Spoolman integration: https://moonraker.readthedocs.io/en/latest/configuration/#spoolman
Spoolman Project: https://github.com/Donkie/Spoolman

fixes #2955

[Ocraftyone]

@Noisyfox I did a refactor of a few lines of PhysicalPrinterDialog in 4ec7c12 that makes it a bit more readable with my changes. I don't believe I broke any of the functionality of your SimplyPrint integration, but if you could take a look at it and confirm, it would be much appreciated.

[YanceyA]

This is great! Big kudos for the work.

[Zimbo111]

If Spoolman could be integrated like this, it would be great. Many thanks for the work . I hope it will be implemented

[CooperGerman]

can't wait to see this integrated =)

[Ocraftyone]

I was taking a bit of a break from this to work on the CMake system overhaul PR. Moving back to this to hopefully get it finished up 😊

[besser]

@Ocraftyone this integration you did was awesome!!!
Can't wait to see this integrated too :)

[Jesibu]

Can't wait to see this released :)

[StuSerious]

Spoolman is now able to pull from a global database of filaments, materials and manufacturers (see https://github.com/Donkie/SpoolmanDB), should you be interested in implementing it as a feature (say to search for your new spool directly in the slicer) I'd be willing to help test/develop!

[Kareem1211]

I'm very excited to try this great feature, how can I test it?

[Ocraftyone]

I'm very excited to try this great feature, how can I test it?

#4771 (comment)

I will update this comment with a link to the latest files. Just click the link and get the correct file for your OS.

[AlexTheGreat1971]

I would like to be able to synchronize Orca with Spoolman server across all Orca's filaments and use synchronization data even if there is no connection with the server. Now, when changing the filament and trying to slice, you constantly get a warning from Orca that there is not enough filament and you have to go into the properties of the filament and update its data from Spoolman server.

[cdedwards]

This will be great when it's working as expected along with Happy-Hare and Mainsail integration. I do have a problem though with the spoolman filament dialog. There is no way to increase the size of the window that's created by Orca to display Spoolman filament. leaving me with a very thin window with some scroll bars along side and bottom.

[Ocraftyone]

This will be great when it's working as expected along with Happy-Hare and Mainsail integration. I do have a problem though with the spoolman filament dialog. There is no way to increase the size of the window that's created by Orca to display Spoolman filament. leaving me with a very thin window with some scroll bars along side and bottom.

I have noticed this while testing in WSL. I was hoping it was just some weirdness surrounding how WSL renders apps, but apparently not. I'll add this to my list of stuff to dig into 😄

[Ocraftyone]

I would like to be able to synchronize Orca with Spoolman server across all filaments in Orca and use synchronization data even if there is no connection with the server. Now, when changing the filament and trying to slice, you constantly get a warning from Orca that there is not enough filament and you have to go into the properties of the filament and update its data from Spoolman server.

I am not entirely sure what you are asking for, but I think you are asking to have the filament consumption details persist between instances of Orca.

If the spoolman server is unreachable/not available, you should not get any notifications unless you are attempting to open the import dialog. This may break apart if you start with access to the spoolman server, then it becomes unavailable, but at that point you would already have the spool data cached in the orca instance and should only get an error if you are trying to import a spool or consume a spool. I have no intention of caching the data beyond the life of an instance of OrcaSlicer because I believe that negates the point. I think no data is better than stale data.

If that is not what you were asking or you still have questions, please let me know 😄

[Zimbo111]

Is there already a way to select the filaments inserted in spoolman directly in orca?

[Ken6432]

@Ocraftyone - Has this been fully merged into the final release of OrcaSlicer 2.3.0? I'm running Build 70931e5 and don't see the ability to select filament from Spoolman. If it hasn't been merged in, how does that work? Will it be at some point?

[locki-cz]

@Ocraftyone - Has this been fully merged into the final release of OrcaSlicer 2.3.0? I'm running Build 70931e5 and don't see the ability to select filament from Spoolman. If it hasn't been merged in, how does that work? Will it be at some point?

you can test it from this build: https://github.com/SoftFever/OrcaSlicer/actions/runs/13477830428?pr=4771

also hope that will be implemented soon :)

[sakura-glitch]

@Ocraftyone - Has this been fully merged into the final release of OrcaSlicer 2.3.0? I'm running Build 70931e5 and don't see the ability to select filament from Spoolman. If it hasn't been merged in, how does that work? Will it be at some point?

you can test it from this build: https://github.com/SoftFever/OrcaSlicer/actions/runs/13477830428?pr=4771

also hope that will be implemented soon :)

And How exactly we can configure Spoolman Filaments there? Didn't find any option.

[locki-cz]

@Ocraftyone - Has this been fully merged into the final release of OrcaSlicer 2.3.0? I'm running Build 70931e5 and don't see the ability to select filament from Spoolman. If it hasn't been merged in, how does that work? Will it be at some point?

you can test it from this build: https://github.com/SoftFever/OrcaSlicer/actions/runs/13477830428?pr=4771
also hope that will be implemented soon :)

And How exactly we can configure Spoolman Filaments there? Didn't find any option.

It is too hard download, unzip run and follow how to video instructions in first post?

[Ocraftyone]

@Ken6432 Thank you for the nudge! I went ahead an merged the latest changes, so it is now based on 2.3.1-dev. The link has been updated in the above comment.

[Ken6432]

Thanks! I'll get it installed and try it out

[locki-cz]

Thanks! I'll get it installed and try it out

for testing is better use portable version ;)

this is just avesome!

[locki-cz]

@Ken6432 Thank you for the nudge! I went ahead an merged the latest changes, so it is now based on 2.3.1-dev. The link has been updated in the above comment.

great job!!!

[sakura-glitch]

@Ocraftyone - Has this been fully merged into the final release of OrcaSlicer 2.3.0? I'm running Build 70931e5 and don't see the ability to select filament from Spoolman. If it hasn't been merged in, how does that work? Will it be at some point?

you can test it from this build: https://github.com/SoftFever/OrcaSlicer/actions/runs/13477830428?pr=4771
also hope that will be implemented soon :)

And How exactly we can configure Spoolman Filaments there? Didn't find any option.

It is too hard download, unzip run and follow how to video instructions in first post?

I did, I don't have the Symbol like in the video. But thanks for not being helpful at all 👌

[locki-cz]

I did, I don't have the Symbol like in the video. But thanks for not being helpful at all 👌

I am sorry but your question just asked for spicy ansver :)

Which symbol? This one?

[SamueldaCostaAraujoNunes]

One question, I know that in this implementation it is possible to link the filament directly to the orca, right? But wouldn't it be more viable to link to the profile, instead of the fixed filament?

[SamueldaCostaAraujoNunes]

One question, I know that in this implementation it is possible to link the filament directly to the orca, right? But wouldn't it be more viable to link to the profile, instead of the fixed filament?

[jonboy86]

Im happy to help test and give feedback but i am on ubuntu and seems like the build failed

[jonboy86]

is there a way i can help get the build to work for ubuntu?

[SamueldaCostaAraujoNunes]

I would like to add a suggestion to the scope of the feature, in Anycubic Next (Anycubic's orcaslicer) there is an option to import the filaments currently loaded in the printer, colors, material type.

[will-blk]

The downloadable artifacts has expired, is there another link to download it?

[Ken6432]

@Ocraftyone - I have three different OrcaSlicer versions installed. I have 2.3.0-beta Build 2e8d42c (which was my original version configured to use Spoolman), 2.3.0 Build 70931e5, and 2.3.1-dev Build a8141ef. Everything still works in the 2.3.0-beta install. However, the two other installs do not have the Spoolman Enabled checkbox in the Physical Printer Connection dialog. I think I understand why it is not available in the 2.3.0 installation as I don't think Spoolman was included in that release. However, I thought in the discussion above that Spoolman was included in the 2.3.1-dev version I have installed. What am I missing? There must be some other step I need to do to get version 2.3.1-dev to allow me to enable Spoolman. -- Thanks

[pletom]

Might be that this feature is not yet integrated with 2.3.1 because of:

• building Flatpak (one of the build targets) is failing
• This pull request is still a work in progress ("Only those with [write access] to this repository can mark a draft pull request as ready for review."

At least I see these 2 items as latest status :(.

[Ken6432]

Might be that this feature is not yet integrated with 2.3.1 because of:

• building Flatpak (one of the build targets) is failing
• This pull request is still a work in progress ("Only those with [write access] to this repository can mark a draft pull request as ready for review."

At least I see these 2 items as latest status :(.

Thanks for the response. I'm afraid I don't completely understand how GitHub works. A few messages above @Ocraftyone said he made a build based upon 2.3.1-dev and updated the link in the original message. When I go to that link, I don't get to a page with downloads available. Is that because of the build errors you mentioned? Where is the status listed that you referred to? - Thanks