https://github.com/timothyhollabaugh/octoscreen

A touchscreen client for Octoprint
https://github.com/timothyhollabaugh/octoscreen

3d-print 3d-printer 3d-printing kivy octoprint raspberry-pi raspberry-pi-touchscreen raspberrypi reprap

Last synced: 22 days ago
JSON representation

A touchscreen client for Octoprint

• Host: GitHub
• URL: https://github.com/timothyhollabaugh/octoscreen
• Owner: timothyhollabaugh
• Created: 2016-11-20T17:22:12.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2017-06-08T00:37:03.000Z (over 7 years ago)
• Last Synced: 2024-09-30T08:40:50.846Z (about 1 month ago)
• Topics: 3d-print, 3d-printer, 3d-printing, kivy, octoprint, raspberry-pi, raspberry-pi-touchscreen, raspberrypi, reprap
• Language: Python
• Size: 2.24 MB
• Stars: 26
• Watchers: 8
• Forks: 5
• Open Issues: 6
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
Octoscreen

===

Octoscren is a touchscreen interface for [Octoprint](https://github.com/foosel/OctoPrint), designed for the official [Raspberry Pi Touchscreen](https://www.raspberrypi.org/products/raspberry-pi-touch-display/). 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](https://github.com/foosel/OctoPrint/tree/master/src/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](http://kivy.org/#home) 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](https://raw.githubusercontent.com/chickenchuck040/octoscreen/master/screenshots/status_printing.png)

  

 - 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](https://raw.githubusercontent.com/chickenchuck040/octoscreen/master/screenshots/printer.png)

  

 - 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](https://raw.githubusercontent.com/chickenchuck040/octoscreen/master/screenshots/files.png)

  

 - 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](https://raw.githubusercontent.com/chickenchuck040/octoscreen/master/screenshots/settings.png)

Upcoming Features

===

See [TODO](https://github.com/chickenchuck040/octoscreen/wiki/To-Do)

Installation

===

See [INSTALL](https://github.com/chickenchuck040/octoscreen/wiki/Installation)

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