A fork of Raspberry Pi OS that runs OctoPrint and a GUI
Logan Gartner
9132a8b7f7
MJPG now has a massively improved command. Instead of transcoding the video for no reason, instead we ask the camera driver for MJPG data so that we don't have to transcode raw video if we don't have to. MJPG's resolution and FPS can now also theoretically be changed from a config file. The frontend components for this however are not implemented. Updated notice in first time setup since we're not in alpha anymore. |
||
---|---|---|
export-image | ||
export-noobs | ||
scripts | ||
stage0 | ||
stage1 | ||
stage2 | ||
stage3 | ||
.dockerignore | ||
.gitignore | ||
build-docker.sh | ||
build.sh | ||
depends | ||
docker-compose.yml | ||
Dockerfile | ||
LICENSE | ||
README-pigen.md | ||
README.md | ||
TODO.md |
TouchPrint
TouchPrint is a lightweight fork of Raspberry Pi OS whos purpose is to host OctoPrint and to display it on a connected screen. TouchPrint is very customizable, and both the GUI and/or OctoPrint can be disabled if you already have an existing setup to perform those tasks.
Screenshots
TODO
Requirements
Minimum:
- Raspberry Pi 3
- 8GB microSD card
- Keyboard and video for first time setup
Recommended:
- Raspberry Pi 4
- 8GB Class 10 microSD card
- Keyboard and video for first time setup
Quick Setup Guide
Flashing on Windows/Mac OS/Linux (Easy)
- Download and install balenaEtcher.
- Download the latest image from the releases section.
- Follow the on screen instructions in Etcher to burn the image to your microSD or USB drive.
Flashing in Mac OS/Linux/BSD (Recommended)
-
Download the latest image from the releases section.
-
Open a terminal and navigate to where you downloaded the image file.
-
Ensure that xz is installed on your computer.
OS Command Ubuntu/Debian apt install xz-utils
Arch/Manjaro pacman -S xz
Mac OS brew install xz
-
Run
xz -d -c IMAGE_NAME.img.xz | sudo dd of=/dev/sdX
, replacing IMAGE_NAME and /dev/sdX with the appropriate paths, and adding flags per your preferences.
First Boot
- Connect an HDMI cable and a keyboard to your Raspberry Pi.
- Power on your Raspberry Pi and wait for it to boot.
- Once booted, you will be put into the first time setup, where you can configure networking, choose which services you want to run, etc.
- Use the arrow keys to move the "cursor", Spacebar to toggle checkboxes, Tab to move the cursor between different sections, and Enter to continue.
- Once the first time setup is complete, the Raspberry Pi will reboot.
OctoPrint Setup
- If the GUI is enabled, you can setup OctoPrint on the Raspberry Pi. You can also setup OctoPrint by opening up a web browser on another computer and navigating to
https://RPI-IP
, replacing RPI-IP with the IP address of your Raspberry Pi. - If MJPG-Streamer is enabled, you can put
/webcam
into the Stream URL box to enable it in OctoPrint.
Accessing OctoPrint
- If OctoPrint is enabled, you can access it at
https://RPI-IP
, replacing RPI-IP with the IP address of your Raspberry Pi.
Reporting Bugs
Please report any bugs by filing an issue. Please include as much detail as you can, including (but not limited to):
- Raspberry Pi Model
- Version of TouchPrint
- What you were doing when the bug occured
- Steps to reproduce
- Logs