mirror of
https://github.com/suchmememanyskill/CYD-Klipper.git
synced 2026-03-21 05:33:24 +00:00
41aa073ae0
* Update readme * Update README.md (#95) * v1.6.4 (#113) * Fix gcode previews with special chars not loading * Add .gitignore file (#108) * Bulletproof ci.py (#107) * Implement file sorting (implement #89) * Set chip family to ESP32-S3 for specific models (fix #67) * Add files menu to params panel while printing (implement #80) * Update ci.py (#110) Typo fix for ESP32-S3 boards array name --------- Co-authored-by: Sebastian Göls <6608231+Abrynos@users.noreply.github.com> Co-authored-by: Miroslav Zuzelka <mzuzelka@gmail.com> * Added serial console * backspace, minor tweaks * - added temporary_config alongside global_config, to hold non-persistent configuration - added macros LOG, LOG_F, LOG_LN conditional on temporary_config.debug for Serial.print/printf/println - put all debug to console behind these macros - added 'debug' serial command to toggle temporary_config.debug, defaults to REPO_DEVELOPMENT - added 'echo' serial command to toggle remote echo, temporary_config.remote_echo - added #define DISPLAY_SECRETS to global_config.h, to censor wifi password and api key on serial console - added entries about serial console to README.md and to _site/index.html * restored -DREPO_DEVELOPMENT=1 (m) * Build failed on esp32-3248S035C, reduced console input buffer size (static char cmdline) as it was failing to fit. * typo * A lot of what should be LOG_F was LOG_LN instead Handling undefined REPO_DEVELOPMENT when initializing temporary_config.debug --------- Co-authored-by: Sims <38142618+suchmememanyskill@users.noreply.github.com> Co-authored-by: Beebles <102569435+beebls@users.noreply.github.com> Co-authored-by: Sebastian Göls <6608231+Abrynos@users.noreply.github.com> Co-authored-by: Miroslav Zuzelka <mzuzelka@gmail.com> Co-authored-by: Bartosz Wucke <b.wucke@a-ster.pl>
59 lines
2.4 KiB
Markdown
59 lines
2.4 KiB
Markdown
|
|
[](https://ko-fi.com/suchmememanyskill)
|
|
|
|
# CYD-Klipper
|
|
An implementation of a wireless 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.
|
|
|
|
|
|
|
|
### 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 and print statistics
|
|
- Start a print
|
|
- (When the printer is idle) move the printer
|
|
- (During a print) set fan speed, flow rate, speed and z offset
|
|
- Manage temperature
|
|
- Extrude/Retract filament
|
|
- Execute predefined gcode macros
|
|
- Toggle Moonraker power devices
|
|
- OTA updates
|
|
- Serial console over USB (115200 8n1, echo off, LF/LF)
|
|
|
|
### Install
|
|
|
|
[There is a web-based installer available. This is only supported on Chrome, Edge, Arc 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.
|
|
|
|
When there is an update available, a button in the settings will appear that can be pressed to update. If automatic updates are preferred, there is a toggle in the settings to automatically update. This will right after connecting to wifi update the screen.
|
|
|
|
### Donate
|
|
|
|
If you found this project helpful, please consider a donation [to my Ko-Fi](https://ko-fi.com/suchmememanyskill). It would help out a lot in the development of this project, due to the need to buy the screens.
|
|
|
|
Thank you!
|
|
|
|
### Screenshots
|
|
(Quite literally shots of the screen. I'm sorry)
|
|
|
|
-|-
|
|
:-:|:-:
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
### Credits
|
|
- [xtouch](https://github.com/xperiments-in/xtouch)
|
|
- [ESP32-Cheap-Yellow-Display](https://github.com/witnessmenow/ESP32-Cheap-Yellow-Display)
|
|
- [OperatorB](https://github.com/OperatorB) for the ESP32-3248S035C display driver
|
|
- [esp32-smartdisplay](https://github.com/rzeldent/esp32-smartdisplay)
|