https://github.com/mkevenaar/octoprint-spoolman

OctoPrint companion plugin to update Spoolman
https://github.com/mkevenaar/octoprint-spoolman

octoprint octoprint-plugin spoolman

Last synced: 12 months ago
JSON representation

OctoPrint companion plugin to update Spoolman

• Host: GitHub
• URL: https://github.com/mkevenaar/octoprint-spoolman
• Owner: mkevenaar
• License: agpl-3.0
• Created: 2023-08-20T08:48:19.000Z (almost 3 years ago)
• Default Branch: develop
• Last Pushed: 2024-04-25T13:49:01.000Z (about 2 years ago)
• Last Synced: 2024-05-01T15:58:38.145Z (about 2 years ago)
• Topics: octoprint, octoprint-plugin, spoolman
• Language: Python
• Homepage:
• Size: 93.8 KB
• Stars: 18
• Watchers: 3
• Forks: 3
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: .github/CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
# Spoolman integration for OctoPrint

[![Version](https://img.shields.io/badge/dynamic/json.svg?color=brightgreen&label=version&url=https://api.github.com/repos/mkevenaar/OctoPrint-Spoolan/releases&query=$[0].name)](https://github.com/mkevenaar/OctoPrint-Spoolman/releases)

[![Released](https://img.shields.io/badge/dynamic/json.svg?color=brightgreen&label=released&url=https://api.github.com/repos/mkevenaar/OctoPrint-Spoolman/releases&query=$[0].published_at)](https://github.com/mkevenaar/OctoPrint-Spoolman/releases)

![GitHub Releases (by Release)](https://img.shields.io/github/downloads/mkevenaar/OctoPrint-Spoolman/latest/total.svg)

Report filament usage to Spoolman.

:warning: An installation of [Spoolman](https://github.com/Donkie/Spoolman#installation) is required!

The UI and inner works of this companion plugin are based on [OctoPrint-SpoolManager](https://github.com/OllisGit/OctoPrint-SpoolManager) by [OllisGit](https://github.com/OllisGit).

## Support my Efforts

This plugin is developed in my spare time.

If you like it, I would be thankful for a cup of coffee, or a sponsorship :)

[![Sponsor me on GitHub](https://img.shields.io/badge/GitHub-sponsors-blue.svg?style=for-the-badge&logo=GitHub)](https://github.com/sponsors/mkevenaar)

[![Buy me a Coffee](https://img.shields.io/badge/Buy%20Me%20A%20Coffee-mkevenaar-FFDD00.svg?style=for-the-badge&logo=buy-me-a-coffee)](https://www.buymeacoffee.com/mkevenaar)

[![Sponsor me on Patreon](https://img.shields.io/badge/Patreon-mkevenaar-red.svg?style=for-the-badge&logo=Patreon)](https://www.patreon.com/mkevenaar)

## Included features

* [x] Software odometer to track amount of extruded filament

* [ ] Warns you if the selected spool has not enough filament left for the print job

* [ ] Automatically pause print if filament runs out

## Setup

Install via the bundled [Plugin Manager](https://docs.octoprint.org/en/master/bundledplugins/pluginmanager.html)

or manually using this URL:

    https://github.com/mkevenaar/OctoPrint-Spoolman/archive/main.zip

After installation, you can listen on three release channels.

What does this mean: Each channel has its own release-version and each release has a different kind of functionality and stability.

* **"Only Release"**: Only stable and tested versions will be shown in the software-update section of OctoPrint

* **"Release & Candidate"**: Beside the stable release, you can also see the "release-candidates", like '''0.1.0rc1'''.

  The rc's include new functionality/bugfixes and are already tested by the community.. so by YOU ;-)

* **"Release & Candidate & under Development"**: Beside stable and rc, you will be informed about development versions.

  A development version like '''0.2.0.dev5``` could include a new (experimental) feature/bugfixes, but it is not fully tested by the community

Changing between each release is done via the "Software Update section" in the settings.

![release-channels](screenshots/release-channels.png "Release channels")

Hint: "Easy-switching" is possible with OctoPrint-Version 1.8.0 (see [OctoPrint#4238](https://github.com/OctoPrint/OctoPrint/issues/4238)).

At the meantime you need to uninstall and install the version you like from the selected channel...or stay in one channel ;-)

## Versions

see [Release-Overview](https://github.com/mkevenaar/OctoPrint-Spoolman/releases/)