Skip to content

btastic/MMM-octoprint

Repository files navigation

MMM-octoprint

This is a module for the MagicMirror².

screenshot

This module will use the Octoprint API to show your current print status on your MagicMirror²!

Installation

In your terminal, go to your MagicMirror's Module folder:

cd ~/MagicMirror/modules

Clone this repository:

git clone https://github.com/btastic/MMM-octoprint

Using the module

To use this module, add the following configuration block to the modules array in the config/config.js file:

var config = {
    modules: [
        {
            module: 'MMM-octoprint',
            position: 'top_right',
            config: {
                endpoint: "",
                apiKey: "",
                updateInterval: 60000,
                showThumbnail: false,
                showLayerProgress: false,
                thumbnailSize: 150,
                hideDataOnStandby: true
            }
        }
    ]
}

Layer progress

To display the layer progress you have to install the DisplayLayerProgress plugin. Please follow the instructions to set up your slicer accordingly or use the automatic detection of ;LAYER:<num> during gcode upload.

Thumbnails

To display a thumbnail you have to install the Slicer Thumbnails plugin.

Customization

To change the color of the progress bar, you can override the default colors (green on gray) with css in your custom.css file.

You can also change the border radius of the progress bar, if you don't like rounded corners.

For example:

.MMM-octoprint {
  --progress-color: crimson;
  --progress-background-color: gray;
  --border-radius: 0px;
}

Configuration options

Option Description
endpoint Required
Endpoint of the Octoprint API. For example: http://192.168.0.75

Type: string(url)
apiKey Required
API Key for Authorization. To create an application key, follow the instructions on Octoprint docs

Type: string
updateInterval Optional
The time interval between UI updates.

Type: int(milliseconds)
Default: 60000 milliseconds (60 seconds)
showThumbnail Optional
Shows a thumbnail embedded in your gcode files.

Only enable this, once you configured the thumbnails plugin and your slicer.

Type: bool
Default: false
showLayerProgress Optional
Shows the layer progress.

Only enable this, once you configured the layer progress plugin and your slicer.

Type: bool
Default: false
thumbnailSize Optional
Changes with thumbnails size (width). Enter a integer value for an absolute value, or a relative size with % (e.g. "50%").

Type: int|string
Default: 150
hideDataOnStandby Optional
Hides printer info when the printer is operational.

Type: bool
Default: true

Available localizations

  • English (en)
  • German (de)

About

A octoprint plugin for MagicMirror²

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published