Skip to content

Latest commit

 

History

History
104 lines (75 loc) · 6.35 KB

README.md

File metadata and controls

104 lines (75 loc) · 6.35 KB
Raw




OctoDash is a simple, but beautiful dashboard for OctoPrint. Please read the instructions carefully!
OctoDash is a User Interface for OctoPrint, it utilizes the OctoPrint API but tries to use modern design principles in order to fully enable the power of your Raspberry Pi attached to your 3D Printer. OctoDash works best with a Touchscreen and will support almost all functions that OctoPrint offers just in a nicer format. Give it a try!

Table of Contents

Installation

bash <(wget -qO- https://github.com/UnchartedBull/OctoDash/raw/master/scripts/install.sh)

For more options and information have a look at the wiki.

No Keyboard? No Problem.

Having issues during the installation? Please have a look at the Troubleshooting Guide first.

Nightly Builds

Thanks to M1dn1ghtN1nj4 nightly builds are available here: https://sites.google.com/view/m1dn1ght-3d/downloads/unofficial-octodash-builds?authuser=0. They should be stable, still not recommended for production.

Update

deprecated, from v2.0 onwards OctoDash can be updated from within the app

wget -qO- https://github.com/UnchartedBull/OctoDash/raw/master/scripts/update.sh | bash

For more info have a look at the wiki

Tips and Tricks

  • OctoDash supports printing from your Raspberry and from the printers SD card, if configured in OctoPrint (v1.5.0 and up)
  • You can let OctoDash push out and pull in the filament during a filament change, if you setup your feed length correctly (v1.5.0 and up)
    • You can also use your printers filament change progress, just enable this in the settings (the printer needs to support M600)
  • If you're using FilamentManager add the color (in HEX format) to the end of the name, like "Vendor black (#000000)", this color will then be shown in the filament selection menu
  • You can adjust the look of OctoDash by adjusting the ~/.config/octodash/custom-styles.css file and adding your own CSS rules (v2.0.0 and up)
  • OctoDash supports .ufp package and PrusaSlicer preview images (v1.5.0 and up)
    • To get the best results, you should use a square aspect ration, like 256x256
  • You can also show the thumbnails during print, if you press on the percentage inside the progress ring (v1.5.0 and up)
  • You can press multiple arrows directly after another in the control view. All actions will be executed in series, even if the prior didn't finish
  • The six actions on the right in the control view can be customized. They can either send GCode commands to your printer, restart OctoPrint or your Pi and even open iFrames so you can view your camera
  • You can adjust the temperatures and fan speed in the home screen by pressing on their icons, if you want to set them to zero, just tap the value once (v1.4.1 and up)

Demo

If you want to see OctoDash in action, here is an awesome video from Nick on YouTube

Screenshots

More Screenshots can be found here.

Get in contact

We now have a Discord server as well. Feel free to join and ask your support & development questions over there: https://discord.gg/gTasZTz.

Troubleshooting

If you encounter an issue, while using OctoDash please have a look at the wiki first! If your issue is not covered please open an issue!

Bugs and more

If you find a bug, please open an issue, so I can have a look at it. Please also add the steps to reproduce and the .gcode file. Thank you!

Contributing

See CONTRIBUTING.md.

License

The project is licensed under the Apache 2.0 License. More Information.