The goal of this project is to breathe new life into the CR6 stock TFT display, which would otherwise no longer function once Klipper is installed on your printer.
Installing just this firmware onto your display is NOT enough. The activation and integration of this UI into your printer system relies totally upon you to also:
1. Install Mainsail on a host processor (e.g. Raspberry pi or Linux PC)
2. Flash the pre-compiled Klipper.bin file to your printer's motherboard (NB: There may come a day when a Klipper update is incompatible with that pre-compiled .bin file. That day may mark the "end of the road" for this project.)
3. Install the t5uid1 python application into the ~klipper/klippy/extras folder on your Klipper host processor
4. Install the Stable_Z_Home "plug-in" from https://github.com/matthewlloyd/Klipper-Stable-Z-Home
5. Install and tailor the Mainsail .cfg files provided in the Related Changes folder of the linked repository
6. Tailor your slicer (instructions are only provided for Cura and OrcaSlicer) to include M73 messages in the gcode files
I have configured my own CR6-SE printer with KlipperScreen on a 7" tablet at the printer and Mainsail on a laptop beside the printer, but there are still some operations for which I prefer to use my stock display with this firmware.
I am maintaining these two repositories in the hope that some of you will also enjoy some features of both this DWIN_SET application and my customizations of Klipper.
I recommend that you start with installing and configuring MainsailOS and Klipper on your printer, and then return to flash your stock display if you - like I - enjoy some of these features.
To help tease you into trying this firmware, here is a sampling of some of the screens I use most often:
This DWIN touchscreen firmware is designed and compiled to run on the portrait-mode T5L 272x480 pixel DWIN displays provided stock with Creality CR6-SE and CR6-MAX FDM printers.
Initially refactored and extended from the T5UID1 DGUS-reloaded firmware by Desuuuu which is available from this repository.
At release 0.3, completely refactored again, to closely resemble the CF6.1 Community Firmware in look, feel, terminology, and workflow logic.
This software is provided without any warranty. You are solely responsible for your use of it.
This firmware was inspired by the CR6Community Firmware touchscreen firmware, but it is NOT as feature-rich as the CR6Community Firmware.
Features present in this version of the UI include:
- Support for most workflows best performed standing at the printer
- Emergency Stop (M112) button on every screen
- Ability to Tune some printer settings during a print
- PID autotuning for both Nozzle and for Bed, with SAVE_CONFIG option
- Pre-defined Material heat settings for PLA, PETG and ABS
- Screen Display Brightness adjustment
- Pause/Resume/Cancel print controls
- Support for M73 message display during printing
- SET_GCODE_OFFSET Z for current print session
- Support for manual leveling, for those who have retrofit bed wheels
- Run ABL with option to SAVE_CONFIG (default) Profile
- Display name of file currently being printed
- Display elapsed time since starting current print
NEW at v0.3.8:
- Reprint last job
- Enable|Disable Runout Sensor
- Printer halts and prompts for filament, if Runout Sensor is Enabled AND Filament is not detected
NEW at v0.3.9:
- New Z Offset calibration screen
- LOAD|REMOVE default Bed Mesh profile feature added to the ABL screen. Also supports viewing other profiles, if loaded via CONSOLE
- Enhanced Manual Leveling screen - also supports ABL users with ability to test/measure gaps at each corner + in center of bed
- Able to see status of - and Enable|Disable - the Runout sensor while printing or paused.
NEW at v0.4.1:
- Added displays of Print Time Remaining and Print Time Elapsed
- Moved Gcode Offset to the Tune screens only added LED On/Off to the Print Status and Print Paused screens
- Added more controls to the Print Finished screen, to support post-print workflows
NEW at v0.4.2:
- Replaces Repeat Last Print functionality with a full scroll/select/print capability for all .gcode files on the Virtual SD Card.
- Removed from beta and released as STABLE.
NEW at v0.4.3
- Adds a Delete File function to the Print_Menu page.
- Includes an "Are you sure?" popup to Confirm/Cancel each request
- Shrinks the Refresh button to make space for the new button on the page
NEW at v0.4.4
- Modifies the Information page to display the current version of the DGUS-Reloaded Klipper component
- Adds an information icon to the Home page, to help users discover and access the Information page
- Corrects a compilation error which may have prevented switching to the Please wait... page, when Homing in version 0.4.3.
NEW at v0.4.5
- Adds Firmware Retraction controls to the Prepare and Printing Tune pages
- Adds Material Presets editing capability to the SetUp page
- Modifies the Automatic Bed Leveling page layout and brightens the mesh values display
NEW at v0.4.6
- Overhauls the Automatic Bed Leveling function, to support all of the user's bed_mesh profiles, not just "default"
- Adds colour-coding of the displayed bed_mesh points, with a user-specifiable threshold for what min/max values are low enough to code as "green". (Defaults to +/- 0.100mm, per the Mainsail HeightMap default settings. Which is also 10 times the probing consistency threshold configured for Safe-Z-Home.)
CAUTION: The automatic bed-leveling function provided with this firmware ONLY works correctly if you also configure your printer.cfg to perform a 5x5 bed mesh. If you do not want to use a 5x5 mesh, do not use this ABL function.
Coming Soon:
- Extruder rotation distance calibration aid (similar to e-steps calibration on Marlin CF6.1, but Klipper does not support automating the update, at the final step.)
This firmware should be compatible with any configuration of CR6-SE or CR6-MAX printer, regardless of whether that machine is fully stock or substantially modified. (It even includes a manual leveling screen, for those of you who have installed manual bed-leveling wheels.)
Testing is done on the following machine:
- Creality CR6-SE, modified with:
- a Creality ERA 1.1.0.3 motherboard
- a direct drive Orbiter v1.5 extruder with Moons pancake motor
- a Dragon HF hotend
- a PEI flexible magnetic sheet print bed
For this DWIN_SET to work with your printer, you must also:
- Install the latest version of MainsailOS
- Tailor your Klipper installation, MainsailOS configuration and Cura
- Flash the applicable pre-compiled Klipper.bin file provided for you in the other repo.
You can make modifications to the DWIN_SET firmware by opening the DWprj.hmi file in DGUS Tools. The tool, developer's documents and Tutorial URLs have been added to the repository at this release, to help anyone who would like to learn how this is done.
You can edit the graphics using a simple bitmap editing tool, like Windows PAINT.
After finishing your modifications, you will need to press the Generate command from the DGUSTool File menu to update the 3 required binary files (13TouchFile.bin, 14ShowFile.bin and 22_Config.bin) in the DWIN_SET folder. If you modified any of the screen layouts, icons or buttons, you will also need to use the ICL tool to regenerate the applicable ICL file(s) (intuitively named: 24_icons.icl, 27_buttons.icl, 32_screens.icl, 30_progress_left.icl and 37_progress_right.icl).
You can then flash your touchscreen using the resulting DWIN_SET folder.
Please note, that to actually add/delete/modify functionality, you will also need to make the necessary changes to the applicable modified Klipper files.
If you add any data variable display widgets to any of the screens, you also need to edit the DGUS-reloaded Klipper file pages.cfg in ~/klipper/klippy/extras/t5uid1/dgus-reloaded, so that the data will be refreshed and maintained when that screen is being displayed.
If you wish to modify the nozzle and bed temperature presets for PLA, ABS and/or PETG, you will need to modify the file init.py in the folder ~/klipper/klippy/extras/t5uid1/dgus-reloaded, so that the program will initialize those variables with the values of your choosing.
CR6Community Firmware features NOT present in this release may be developed in future releases, but no schedule commitment is possible for such extensions. Users who are able to define and develop such modifications are welcome to fork this repository and to submit Pull Requests or to open Discussions or Issues as appropriate, to propose those changes.
| Material | Author | Modified | License |
|---|---|---|---|
| DGUS-RELOADED DWIN UI | Desuuuu | Yes | GPLv3 |
| Klipper logo | KevinOConnor | Yes | GPLv3 |
| Feather icons | Cole Bemis | Yes | MIT |
| 3D Printing Line icons | Sam Baines | Yes | CC-BY 3.0 |
| Fan icon | Atif Arshad | Yes | CC-BY 3.0 |
| Snow icon | Shashank Singh | Yes | CC-BY 3.0 |
| Electric Motor icon | Verry | Yes | CC-BY 3.0 |
| Probe icon | Mohamed Mbarki | Yes | CC-BY 3.0 |
| Wheel icon | Deivid Sáenz | Yes | CC-BY 3.0 |
| Ruler icon | Three Six Five | - | CC-BY 3.0 |
| Wrench icon | Freepik - Flaticon | Yes | Free-Use |
| Emergency Stop icon copied from KlipperScreen | Jordan Ruthe | Yes | CC-BY 3.0 |