Skip to content
A dashboard for Octoprint
HTML Python JavaScript CSS
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github/ISSUE_TEMPLATE
octoprint_dashboard
.editorconfig
.gitignore
LICENSE
MANIFEST.in
README.md
babel.cfg
requirements.txt
screenshot-theme.png
screenshot-theme2.png
screenshot.png
setup.py

README.md

OctoPrint-Dashboard

A dashboard tab for Octoprint that displays the most relevant info regarding the state of the printer and any on-going print jobs.

Screenshot

Features

  • Adds a new tab first in the list and becomes the default tab when opening OctoPrint
  • Widgets for current:
    • RPi iost CPU Load, CPU Temp, Mem Utilization, Storage Utilization.
    • Printer profile, Connection status, Printer Status
    • Hotend temp(s), Bed Temp, Chamber Temp, Fan speed
    • Printed file, Progress
    • Estimated total time, ETA, Time left, Time since print started
    • Current layer, Total layers
    • Current height, Total height
    • Average layer time
    • WebCam view
  • Supports multiple hotends as configured in the printer profile
  • Supports chamber temperature if configured in the printer profile
  • Configurable progress gauge type (Circle, Bar)
  • Fullscreen mode
  • Uses Estimates from PrintTimeGenius when installed
  • Uses GCode analysis provided by DisplayLayerProgress to get more accurate layer and fan data
  • Theme friendly:

Screenshot

What's new?

For release notes and release history, please visit the wiki.

Known limitations

  • Translations to other languages are not supported yet.
  • The CPU-temp will likely only work on a Raspberry Pi.
  • Disk Usage will likely only work on Linux deratives.
  • Testing limited to desktop browsers: Safari, Chrome and Firefox

Dependencies

This plugin depends on DisplayLayerProgress to be installed in order to provide all metrics. DisplayLayerProgress provides GCode analysis for the Dashboard. Only the events from DisplayLayerProgress are used by the Dashboard plugin so you may disable "Navigationbar" and "Printer Display" in the DisplayLayerProgress plugin settings if you want to see them in the UI.

The dashboard uses the time estimates provided by PrintTimeGenius if it is installed but it is not required.

Credits

Setup

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

https://github.com/StefanCohen/OctoPrint-Dashboard/archive/master.zip

Configuration

  • Two progress gauge types can be configured in the plugin settings: Bar & Circle (default). The Bar gauge can be useful if you have multiple hotends or a heated chamber.
  • For more configuration help, please visit the wiki.

For users of Themeify:

"fas fa-tachometer-alt" is a suitable icon for Custom Tab-icons

For custom styles:

Selector CSS-Rule
.dashboardLarge color
.dashboardSmall color
.dashboardGauge stroke
svg text fill

Screenshot

You can’t perform that action at this time.