search

sethvoltz / OctoPrint-DisplayPanel

Simple control and status paired with a physical button panel and OLED display
57 stars 17 forks source link
control-panel hardware octoprint

readme

OctoPrint Micro Panel (formerly Display Panel)

Header image made of photos of the control panel

This plugin implements the software control side of an OctoPrint Control Panel for Octopi. The hardware half is a series of 4 buttons, an OLED screen and a 3D printed case that mounts on the printer next to the Raspnerry Pi so it can be plugged in to the header pins.

Watch a demo of the panel in action! More photos are at the end of this readme.

Screenshot of demo video

Resources

Check out our Community Discussions forum for build show and tell, discussing new features and community support!

Hardware

Besides the 3D printed parts, you will need the following parts:

Wire up the board as in the diagram below, ensuring that the OLED is set at or below the height of the buttons. The buttons will not fit through the proto board holes, instead they will just fit in and sit above the board. This is expected and the 3D model accounts for it.

Once the board is wired up, run the wires through the hole in the back of the base of the case, slide the board into the lid and slide the lid into the base. Depending on your printer, the lid should slide on with just enough grip to hold in place and the lid and base work together to hold the board in the correct position.

Wiring diagram for the control panel

Setup

NOTE: This plugin required OctoPrint to be updated to run on Python 3. Please follow these instructions if you are not already on Python 3.

First ensure i2c is enabled on the Pi by running sudo raspi-config and navigating to Interfacing Options > I2C > <Yes> > <OK>. Exit the config tool, then restart the Pi.

After restarting, install i2c-tools and make sure the Pi can see the display.

$ sudo apt-get update && sudo apt-get install i2c-tools
...
$ sudo i2cdetect -y 1
     0  1  2  3  4  5  6  7  8  9  a  b  c  d  e  f
00:          -- -- -- -- -- -- -- -- -- -- -- -- --
10: -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --
20: -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --
30: -- -- -- -- -- -- -- -- -- -- -- -- 3c -- -- --
40: -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --
50: -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --
60: -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --
70: -- -- -- -- -- -- -- --

The 3c there is the OLED display. If you don't see it, check your wiring and try rebooting the pi again.

With I2C confirmed, install via the bundled Plugin Manager or manually using this URL:

https://github.com/sethvoltz/OctoPrint-DisplayPanel/archive/main.zip

Configuration

There are no configuration options for this plugin at the moment. Plug and play!

More Photos

Hardware shot from front Hardware shot from back Hardware In-Situ

Thanks

Many thanks to the amazing community contributors that help support and improve this for everyone!


Jörg Eichhorn
Andy Barnett
Karl Gutwin