timothyhollabaugh / octoscreen

A touchscreen client for Octoprint

Octoscreen

Octoscren is a touchscreen interface for Octoprint, designed for the official Raspberry Pi Touchscreen. It is currently in a very useable state, but is still under developement.

This uses a websocket and REST API to talk to Octoprint. It uses the octoprint_client module that comes with Octoprint to handle the websocket and REST API. It currently requires Octoprint to be installed, but it may connect to an Octoprint on another system.

Octoscren uses Kivy to draw to the screen and handle input. Kivy provides a nice way to do GPU accelerated graphics, while still remaining portable to other systems.

Octoscreen is designed for the Raspberry Pi Touchscreen, however it should work anywhere Kivy is supported. If using a screen of a different size, you should change the height and width config options in main.py.

Config.set('graphics', 'height', '480')
Config.set('graphics', 'width', '800')

Features

Stable, fully functioning features

• View status of the printer, including:
• Current state
• Current file loaded
• Temperatures
• Filament usage for the current file loaded
• Time into print
• Time remaining in print
• Total time of print
• Start, stop, or cancel prints

• Control of the printer, including:
• Temperatures with a nice on screen keypad
• Tool selection
• Filament extrude/retract of different amounts
• Motors on/off
• Jog with different step sizes
• Home XY, Z, or XYZ

• Connection and other miscellaneous controls, including:
• Serial port, baud rate, and profile selection for connecting
• Any commands configued in the System menu. It uses breaks to seperate the buttons on different lines.
• File Selector for files uploaded to Octoprint:
• Shows files in date order, newest at the top
• Shows date uploaded and estimated time
• Allows printing, selecting, or deleting a file

• Adjusts displayed information to match printer profile:
• Number of extruders
• Heated Bed temperatures
• Settings menu to configure Octoprint URL, Port, and API Key, and other Kivy settings

Upcoming Features

See TODO

Installation

See INSTALL

It would be wise to write a systemd service file to start it on boot.

octoscreen's Issues

Is it possible to improve the GUI and make it look like toggle 3d printing software?

https://github.com/intelligent-agent/toggle
is for beaglebone black written in clutter but has a good gui .canb you improve the gui to look something like that?

Installation Failing

Hi, I am trying to install Octoscreen with the Octopi image on a Raspberry Pi 3 Model B and the 3.5" LCD touchscreen. I followed the installation instructions you have posted coupled with the LCD installation instructions from github.com/goodtft/LCD-Show. I have successfully configured Octoprint and can navigate to the web interface from my primary computer. I also changed the main.py file to reflect my different pixel settings 480x320

I have not installed any desktop gui (hoping octoscreen eliminates any need for it).

I am still not seeing any octoscreen view. The software runs and just hangs (see the attached file for output log from kivy). I was logged in as Pi and ran the following command
~/oprint/bin/python ~/octoscreen/main.py

PLEASE HELP!
kivy_18-07-23_6.txt

Error in Status Line

At that time Octoprint had a communication error. Question is is displaying the error in this form intentional?

Deleting files.

I had two files uploaded to octoprint. Both were visible in octoscreen. I then delete both files, one after the other. After that I still see the last file. I do net get an empty window showing no files. Checking on Octoprint Web Interface shows that both files have been deleted.

Files screen not anymore working

On Octoprint 1.3.0 and 1.3.1 there are no files in the files tab.
The delete button is active. The two other buttons are disabled.

There are gcode files on the octoprint (and a folder)

API Key missing

After completing the install My screen comes on but I get the line, " Required environment variable is not set: OCTOPRINT_APIKEY. Haven't found the answer via Google. Any help is appreciated.

New GUI discussion

Recently I've had an idea to create a touchscreen interface for OctoPrint to use with 3d printers. Thanks to @chickenchuck040 I've found his project sooner I started trying make own application.

One thing about my idea – the key feature, was having nice looking touch UI attached on printer.

I'd like to participate on this project, helping with development and especially taking charge of creating new GUI for octoscreen.

Let's discuss how octoscreen can look like and let's make some agreement about my improvements on this project.

This is my draft (or mockup, proposal, whatever) how I imagine the Octoscreen could look. I made light and dark variants and we can offer both of them to the users as their choice.

Light variant

Dark variant

---

WDYT?

For better communication - can we reach each other on some kind of IM?
If not IM, mail is still an option – [email protected]

Kivy installation Instructions

The installation instructions linked in the Readme.md do not work on up to date Raspbian or Octopi.

The problem is that the installation needs a certain version of libwayland-dev, libgles2-mesa-dev, libegl1-mesa-dev.

The apt-get install step fails.

Crash during printing

Occasionally Octoscreen crashes during printing. I'll attach a screen shot.