yallyscreen is a LCD touch interface for your OctoPrint server. It is based on GTK+3 and allows you to control your 3D Printer using a LCD touch screen, a Raspberry Pi, and OctoPrint. It's an X application that's executed directly in the X Server without a window manager or browser, and operates as a frontend for OctoPrint.
Installation
Dependencies
yallyscreen is based on GoLang. GoLang applications are usually dependency-less, but in this case GTK+3 is used, and the GTK+3 libraries are required in order to run. Be sure that GTK+3 is installed and is the only graphical environment that's been installed.
If you are using Raspbian
or any other Debian
based distribution, required packages can be installed using:
sudo apt-get install libgtk-3-0 xserver-xorg xinit x11-xserver-utils
You will also need to set up the video drivers for the display you are using. Installation and configuration of the drivers is usually specific to the display you are using, and you will need to contact the manufacturer for instructions. To help you set up your system and display, a setup guide (Setting Up yallyscreen and Your Display) is available in the wiki.
Install From Source
The compilation and packaging tasks are managed by the Makefile
and backed on Docker. Docker is used to avoid installing any other dependencies since all the operations are done inside of the container.
If you need to install docker inside Raspbian
or any other linux distribution just run:
curl -fsSL get.docker.com -o get-docker.sh
sh get-docker.sh
You can read more about this at docker-install
To compile the project (assuming that you already cloned this repository), just execute the build
target. This will generate all the binaries and debian packages in the build
folder:
make build
The default build is for the STRETCH release of debian, but BUSTER and JESSIE are also possible. To build one of these targets, you just have to specify the package during make.
Example for BUSTER:
make build DEBIAN_PACKAGES=BUSTER
ls -1 build/
If you are using Raspbian
you can install any of the .deb
generated packages. If not, just use the compiled binary.
Configuration
Basic Configuration
Custom Controls and Commands
Custom controls to execute GCODE instructions and commands to execute shell commands can be defined in the config.yaml
file.
The controls are limit to static controls without inputs
.
License
GNU Affero General Public License v3.0, see LICENSE
This project is a hard fork from Octoprint-TFT created by @mcuadros