diff --git a/README.md b/README.md index ce69168..1dbe63d 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,43 @@ -# CYD-Klipper-Display +![GitHub release (with filter)](https://img.shields.io/github/v/release/suchmememanyskill/CYD-Klipper) +[![Donations](https://img.shields.io/badge/Support%20on-Ko--Fi-red)](https://ko-fi.com/suchmememanyskill) -WIP! \ No newline at end of file +# CYD-Klipper +An implementation of a Klipper status display on an ESP32 + screen. Uses Moonraker to fetch data. + +A simple and cheap solution to use a dedicated screen with Klipper, a 3d printing Firmware. + +![showcase_image](readme/PXL_20231113_171629383.jpg) + +### Required hardware + +A ESP32-2432S028R is required to run this project. You can find out where to buy these on the ["ESP32 Cheap Yellow Display"](https://github.com/witnessmenow/ESP32-Cheap-Yellow-Display#where-to-buy) repository. + +### Features +- View printer status +- View print progress +- Start a print +- Move the printer +- Manage temperature +- Extrude/Retract filament + +### Install + +[There is a web-based installer available. This is only supported on Chrome, Edge or Opera, and only on Desktop.](https://suchmememanyskill.github.io/CYD-Klipper/) + +On initial install, all data should be wiped. On updates, data should be able to be kept without issues. + +There are no 'over the air' updates. Each update has to be applied manually. + +### Screenshots +(Quite literally shots of the screen. I'm sorry) + +-|- +:-:|:-: +![1](readme/PXL_20231113_142717308.jpg)|![2](readme/PXL_20231113_171701876.jpg) +![3](readme/PXL_20231113_171715809.jpg)|![4](readme/PXL_20231113_171724404.jpg) +![5](readme/PXL_20231113_171751745.jpg)|![6](readme/PXL_20231113_171809315.jpg) + + +### Credits +- [xtouch](https://github.com/xperiments-in/xtouch) +- [ESP32-Cheap-Yellow-Display](https://github.com/witnessmenow/ESP32-Cheap-Yellow-Display) \ No newline at end of file diff --git a/readme/PXL_20231113_142717308.jpg b/readme/PXL_20231113_142717308.jpg new file mode 100644 index 0000000..b6b3aca Binary files /dev/null and b/readme/PXL_20231113_142717308.jpg differ diff --git a/readme/PXL_20231113_171629383.jpg b/readme/PXL_20231113_171629383.jpg new file mode 100644 index 0000000..acf714b Binary files /dev/null and b/readme/PXL_20231113_171629383.jpg differ diff --git a/readme/PXL_20231113_171701876.jpg b/readme/PXL_20231113_171701876.jpg new file mode 100644 index 0000000..02b16ab Binary files /dev/null and b/readme/PXL_20231113_171701876.jpg differ diff --git a/readme/PXL_20231113_171715809.jpg b/readme/PXL_20231113_171715809.jpg new file mode 100644 index 0000000..7a54176 Binary files /dev/null and b/readme/PXL_20231113_171715809.jpg differ diff --git a/readme/PXL_20231113_171724404.jpg b/readme/PXL_20231113_171724404.jpg new file mode 100644 index 0000000..4b5bc80 Binary files /dev/null and b/readme/PXL_20231113_171724404.jpg differ diff --git a/readme/PXL_20231113_171751745.jpg b/readme/PXL_20231113_171751745.jpg new file mode 100644 index 0000000..6428716 Binary files /dev/null and b/readme/PXL_20231113_171751745.jpg differ diff --git a/readme/PXL_20231113_171809315.jpg b/readme/PXL_20231113_171809315.jpg new file mode 100644 index 0000000..ba615b4 Binary files /dev/null and b/readme/PXL_20231113_171809315.jpg differ