Skip to content

Latest commit

 

History

History
68 lines (51 loc) · 2.96 KB

README.md

File metadata and controls

68 lines (51 loc) · 2.96 KB
Raw

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

Status Picture

  • 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

Printer Picture

  • 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

Files Picture

  • 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

Settings Picture

Upcoming Features

See TODO

Installation

See INSTALL

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