Initial commit

Desuuuu · Aug 16, 2020 · 4f9d155 · 4f9d155
commit 4f9d155
Show file tree

Hide file tree

Showing 94 changed files with 844 additions and 0 deletions.
diff --git a/.github/stale.yml b/.github/stale.yml
@@ -0,0 +1,11 @@
+daysUntilStale: 60
+daysUntilClose: 7
+exemptLabels:
+  - pinned
+  - security
+staleLabel: wontfix
+markComment: >
+  This issue has been automatically marked as stale because it has not had
+  recent activity. It will be closed if no further activity occurs. Thank you
+  for your contributions.
+closeComment: false
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,6 @@
+project/ICON
+project/image
+
+project/*.xls
+
+project/DWIN_SET/*.bin
diff --git a/LICENSE b/LICENSE
diff --git a/README.md b/README.md
@@ -0,0 +1,83 @@
+# DGUS-reloaded-Klipper
+
+Firmware for 3D printers' DGUS touchscreens.
+
+The printer firmware to run alongside this can be found in [this repository](https://github.com/Desuuuu/klipper).
+
+## Disclaimer
+**This software is provided without any warranty. You are solely responsible for your use of it.**
+
+## Features
+
+This firmware was inspired by Creality printers' touchscreen firmware. Some features include:
+
+* Status message available on most screens
+* Z offset, manual and automatic leveling
+* PID autotuning
+* Volume adjustment
+* Brightness adjustment
+* BLTouch reset shortcut (if a BLTouch is installed)
+* Playing sounds using M300 (the frequency parameter is the index of the audio file)
+
+Focus was also put on making this firmware as easy and safe to use as possible from a user perspective.
+
+## Compatibility
+This firmware **should** be compatible with printers equipped with the following hardware:
+
+* 480x272 DWIN touchscreen
+* Single extruder
+* Heated bed
+* Single controllable fan
+* Bed leveling sensor (including a BLTouch)
+
+It **could** also work on machines equipped with more hardware (dual extruder, etc.) but will lack on-screen controls for such hardware.
+
+Testing has been done on the following machines:
+
+* Creality CR-10S Pro
+
+## Prerequisites
+You have to use this [modified version of Klipper](https://github.com/Desuuuu/klipper). Make sure to enable the serial connection to the screen while configuring the MCU firmware.
+
+The only modification required to your Klipper configuration file is to add this section:
+```
+[t5uid1]
+firmware: dgus_reloaded
+```
+
+For a list of available options, see the [sample-t5uid1.cfg](https://github.com/Desuuuu/klipper/blob/master/config/sample-t5uid1.cfg) file.
+
+It is also a good idea to add this command to your start G-code:
+```
+DGUS_PRINT_START
+```
+And this command to your end G-code:
+```
+DGUS_PRINT_END
+```
+
+## Installation
+The installation process is detailed on [this wiki page](https://github.com/Desuuuu/DGUS-reloaded-Klipper/wiki/Flashing-the-firmware).
+
+## Modification / Compilation
+You can make modifications to the firmware by opening the `DWprj.hmi` file in **DGUS Tools**.
+
+After finishing your modifications, you will need to press the *Generate* button to create the 3 required binary files.
+
+You can then run the rename script and flash your touchscreen using the resulting `DWIN_SET` folder.
+
+## Credits
+| Material                                                                       | Author                                                    | Modified | License                                                               |
+|:------------------------------------------------------------------------------:|:---------------------------------------------------------:|:--------:|:---------------------------------------------------------------------:|
+| [Klipper logo](https://github.com/KevinOConnor/klipper)                        | [KevinOConnor](https://github.com/KevinOConnor)           | Yes      | [GPLv3](http://www.gnu.org/licenses/gpl-3.0.html)                     |
+| [Feather icons](https://feathericons.com/)                                     | [Cole Bemis](https://twitter.com/colebemis)               | Yes      | [MIT](https://github.com/feathericons/feather/blob/master/LICENSE)    |
+| [3D Printing Line icons](https://www.iconfinder.com/iconsets/3d-printing-line) | [Sam Baines](https://www.iconfinder.com/conceptbaines)    | Yes      | [CC-BY 3.0](https://creativecommons.org/licenses/by/3.0/legalcode)    |
+| [Fan icon](https://thenounproject.com/term/fan/1153915/)                       | [Atif Arshad](https://thenounproject.com/atifarshad/)     | Yes      | [CC-BY 3.0](https://creativecommons.org/licenses/by/3.0/us/legalcode) |
+| [Snow icon](https://thenounproject.com/term/snow/1959859/)                     | [Shashank Singh](https://thenounproject.com/rshashank19/) | Yes      | [CC-BY 3.0](https://creativecommons.org/licenses/by/3.0/us/legalcode) |
+| [Electric Motor icon](https://thenounproject.com/term/electric-motor/2734486/) | [Verry](https://thenounproject.com/verry.dsign.creative)  | Yes      | [CC-BY 3.0](https://creativecommons.org/licenses/by/3.0/us/legalcode) |
+| [Probe icon](https://thenounproject.com/term/probe/1841345/)                   | [Mohamed Mbarki](https://thenounproject.com/mb.icons)     | Yes      | [CC-BY 3.0](https://creativecommons.org/licenses/by/3.0/us/legalcode) |
+| [Wheel icon](https://thenounproject.com/term/wheel/92430/)                     | [Deivid Sáenz](https://thenounproject.com/deivid.saenz)   | Yes      | [CC-BY 3.0](https://creativecommons.org/licenses/by/3.0/us/legalcode) |
+| [Ruler icon](https://thenounproject.com/term/ruler/1738925/)                   | [Three Six Five](https://thenounproject.com/365)          | -        | [CC-BY 3.0](https://creativecommons.org/licenses/by/3.0/us/legalcode) |
+
+## License
+[GPLv3](http://www.gnu.org/licenses/gpl-3.0.html)
diff --git a/VERSION b/VERSION
@@ -0,0 +1 @@
+1.0.0
diff --git a/extras/flash_reset/README.md b/extras/flash_reset/README.md
@@ -0,0 +1,5 @@
+By default, the flashing process only writes what's currently being flashed to its destination, leaving other areas of the memory untouched.
+
+The `T5UID1.CFG` file provided here will erase the touchscreen onboard memory before the flashing process starts.
+
+It is recommended to use this file when coming from a different touchscreen firmware.
diff --git a/extras/flash_reset/T5UID1.CFG b/extras/flash_reset/T5UID1.CFG
diff --git a/project/DWIN_SET/000_boot.bmp b/project/DWIN_SET/000_boot.bmp
diff --git a/project/DWIN_SET/001_home.bmp b/project/DWIN_SET/001_home.bmp
diff --git a/project/DWIN_SET/002_print_status.bmp b/project/DWIN_SET/002_print_status.bmp
diff --git a/project/DWIN_SET/003_print_adjust.bmp b/project/DWIN_SET/003_print_adjust.bmp
diff --git a/project/DWIN_SET/004_print_finished.bmp b/project/DWIN_SET/004_print_finished.bmp
diff --git a/project/DWIN_SET/005_temp_menu.bmp b/project/DWIN_SET/005_temp_menu.bmp
diff --git a/project/DWIN_SET/006_temp_manual.bmp b/project/DWIN_SET/006_temp_manual.bmp
diff --git a/project/DWIN_SET/007_fan.bmp b/project/DWIN_SET/007_fan.bmp
diff --git a/project/DWIN_SET/008_move.bmp b/project/DWIN_SET/008_move.bmp
diff --git a/project/DWIN_SET/009_settings_menu.bmp b/project/DWIN_SET/009_settings_menu.bmp
diff --git a/project/DWIN_SET/010_leveling_menu.bmp b/project/DWIN_SET/010_leveling_menu.bmp
diff --git a/project/DWIN_SET/011_leveling_offset.bmp b/project/DWIN_SET/011_leveling_offset.bmp
diff --git a/project/DWIN_SET/012_leveling_manual.bmp b/project/DWIN_SET/012_leveling_manual.bmp
diff --git a/project/DWIN_SET/013_leveling_automatic.bmp b/project/DWIN_SET/013_leveling_automatic.bmp
diff --git a/project/DWIN_SET/014_leveling_probing.bmp b/project/DWIN_SET/014_leveling_probing.bmp
diff --git a/project/DWIN_SET/015_filament.bmp b/project/DWIN_SET/015_filament.bmp
diff --git a/project/DWIN_SET/016_volume.bmp b/project/DWIN_SET/016_volume.bmp
diff --git a/project/DWIN_SET/017_brightness.bmp b/project/DWIN_SET/017_brightness.bmp
diff --git a/project/DWIN_SET/018_settings_menu2.bmp b/project/DWIN_SET/018_settings_menu2.bmp
diff --git a/project/DWIN_SET/019_pid.bmp b/project/DWIN_SET/019_pid.bmp
diff --git a/project/DWIN_SET/01_boot.wav b/project/DWIN_SET/01_boot.wav
diff --git a/project/DWIN_SET/020_information.bmp b/project/DWIN_SET/020_information.bmp
diff --git a/project/DWIN_SET/02_click.wav b/project/DWIN_SET/02_click.wav
diff --git a/project/DWIN_SET/03_notification.wav b/project/DWIN_SET/03_notification.wav
diff --git a/project/DWIN_SET/0_DWIN_ASC.HZK b/project/DWIN_SET/0_DWIN_ASC.HZK
diff --git a/project/DWIN_SET/202_popup_numpad.bmp b/project/DWIN_SET/202_popup_numpad.bmp
diff --git a/project/DWIN_SET/203_popup_numpad_sel.bmp b/project/DWIN_SET/203_popup_numpad_sel.bmp
diff --git a/project/DWIN_SET/204_popup_abort.bmp b/project/DWIN_SET/204_popup_abort.bmp
diff --git a/project/DWIN_SET/205_popup_abort_sel.bmp b/project/DWIN_SET/205_popup_abort_sel.bmp
diff --git a/project/DWIN_SET/206_popup_pause.bmp b/project/DWIN_SET/206_popup_pause.bmp
diff --git a/project/DWIN_SET/207_popup_pause_sel.bmp b/project/DWIN_SET/207_popup_pause_sel.bmp
diff --git a/project/DWIN_SET/208_popup_resume.bmp b/project/DWIN_SET/208_popup_resume.bmp
diff --git a/project/DWIN_SET/209_popup_resume_sel.bmp b/project/DWIN_SET/209_popup_resume_sel.bmp
diff --git a/project/DWIN_SET/210_popup_presets.bmp b/project/DWIN_SET/210_popup_presets.bmp
diff --git a/project/DWIN_SET/211_popup_presets_sel.bmp b/project/DWIN_SET/211_popup_presets_sel.bmp
diff --git a/project/DWIN_SET/212_popup_steppers.bmp b/project/DWIN_SET/212_popup_steppers.bmp
diff --git a/project/DWIN_SET/213_popup_steppers_sel.bmp b/project/DWIN_SET/213_popup_steppers_sel.bmp
diff --git a/project/DWIN_SET/240_debug1.bmp b/project/DWIN_SET/240_debug1.bmp
diff --git a/project/DWIN_SET/241_debug2.bmp b/project/DWIN_SET/241_debug2.bmp
diff --git a/project/DWIN_SET/249_wait.bmp b/project/DWIN_SET/249_wait.bmp
diff --git a/project/DWIN_SET/24_icons.ico b/project/DWIN_SET/24_icons.ico
diff --git a/project/DWIN_SET/250_kill.bmp b/project/DWIN_SET/250_kill.bmp
diff --git a/project/DWIN_SET/27_buttons.ico b/project/DWIN_SET/27_buttons.ico
diff --git a/project/DWIN_SET/30_progress_left.ico b/project/DWIN_SET/30_progress_left.ico
diff --git a/project/DWIN_SET/37_progress_right.ico b/project/DWIN_SET/37_progress_right.ico
diff --git a/project/DWIN_SET/T5UID1.CFG b/project/DWIN_SET/T5UID1.CFG
diff --git a/project/DWprj.hmi b/project/DWprj.hmi
@@ -0,0 +1,44 @@
+[INIT]
+PICFIX=1
+VARCount=64
+Version=1
+SCREENDSIZE=480X272
+SPADDRESS=5000
+[IMG]
+000=000_boot.bmp
+001=001_home.bmp
+002=002_print_status.bmp
+003=003_print_adjust.bmp
+004=004_print_finished.bmp
+005=005_temp_menu.bmp
+006=006_temp_manual.bmp
+007=007_fan.bmp
+008=008_move.bmp
+009=009_settings_menu.bmp
+010=010_leveling_menu.bmp
+011=011_leveling_offset.bmp
+012=012_leveling_manual.bmp
+013=013_leveling_automatic.bmp
+014=014_leveling_probing.bmp
+015=015_filament.bmp
+016=016_volume.bmp
+017=017_brightness.bmp
+018=018_settings_menu2.bmp
+019=019_pid.bmp
+020=020_information.bmp
+202=202_popup_numpad.bmp
+203=203_popup_numpad_sel.bmp
+204=204_popup_abort.bmp
+205=205_popup_abort_sel.bmp
+206=206_popup_pause.bmp
+207=207_popup_pause_sel.bmp
+208=208_popup_resume.bmp
+209=209_popup_resume_sel.bmp
+210=210_popup_presets.bmp
+211=211_popup_presets_sel.bmp
+212=212_popup_steppers.bmp
+213=213_popup_steppers_sel.bmp
+240=240_debug1.bmp
+241=241_debug2.bmp
+249=249_wait.bmp
+250=250_kill.bmp
diff --git a/project/DWprj.tft b/project/DWprj.tft
diff --git a/project/TFT/000_boot.bmp.tft b/project/TFT/000_boot.bmp.tft
diff --git a/project/TFT/001_home.bmp.tft b/project/TFT/001_home.bmp.tft
diff --git a/project/TFT/002_print_status.bmp.tft b/project/TFT/002_print_status.bmp.tft
diff --git a/project/TFT/003_print_adjust.bmp.tft b/project/TFT/003_print_adjust.bmp.tft
diff --git a/project/TFT/004_print_finished.bmp.tft b/project/TFT/004_print_finished.bmp.tft
diff --git a/project/TFT/005_temp_menu.bmp.tft b/project/TFT/005_temp_menu.bmp.tft
diff --git a/project/TFT/006_temp_manual.bmp.tft b/project/TFT/006_temp_manual.bmp.tft
diff --git a/project/TFT/007_fan.bmp.tft b/project/TFT/007_fan.bmp.tft
diff --git a/project/TFT/008_move.bmp.tft b/project/TFT/008_move.bmp.tft
diff --git a/project/TFT/009_settings_menu.bmp.tft b/project/TFT/009_settings_menu.bmp.tft
diff --git a/project/TFT/010_leveling_menu.bmp.tft b/project/TFT/010_leveling_menu.bmp.tft
diff --git a/project/TFT/011_leveling_offset.bmp.tft b/project/TFT/011_leveling_offset.bmp.tft
diff --git a/project/TFT/012_leveling_manual.bmp.tft b/project/TFT/012_leveling_manual.bmp.tft
diff --git a/project/TFT/013_leveling_automatic.bmp.tft b/project/TFT/013_leveling_automatic.bmp.tft
diff --git a/project/TFT/014_leveling_probing.bmp.tft b/project/TFT/014_leveling_probing.bmp.tft
diff --git a/project/TFT/015_filament.bmp.tft b/project/TFT/015_filament.bmp.tft
diff --git a/project/TFT/016_volume.bmp.tft b/project/TFT/016_volume.bmp.tft
diff --git a/project/TFT/017_brightness.bmp.tft b/project/TFT/017_brightness.bmp.tft
diff --git a/project/TFT/018_settings_menu2.bmp.tft b/project/TFT/018_settings_menu2.bmp.tft
diff --git a/project/TFT/019_pid.bmp.tft b/project/TFT/019_pid.bmp.tft
diff --git a/project/TFT/020_information.bmp.tft b/project/TFT/020_information.bmp.tft
diff --git a/project/TFT/202_popup_numpad.bmp.tft b/project/TFT/202_popup_numpad.bmp.tft
diff --git a/project/TFT/203_popup_numpad_sel.bmp.tft b/project/TFT/203_popup_numpad_sel.bmp.tft
diff --git a/project/TFT/204_popup_abort.bmp.tft b/project/TFT/204_popup_abort.bmp.tft
diff --git a/project/TFT/205_popup_abort_sel.bmp.tft b/project/TFT/205_popup_abort_sel.bmp.tft
diff --git a/project/TFT/206_popup_pause.bmp.tft b/project/TFT/206_popup_pause.bmp.tft
diff --git a/project/TFT/207_popup_pause_sel.bmp.tft b/project/TFT/207_popup_pause_sel.bmp.tft
diff --git a/project/TFT/208_popup_resume.bmp.tft b/project/TFT/208_popup_resume.bmp.tft
diff --git a/project/TFT/209_popup_resume_sel.bmp.tft b/project/TFT/209_popup_resume_sel.bmp.tft
diff --git a/project/TFT/210_popup_presets.bmp.tft b/project/TFT/210_popup_presets.bmp.tft
diff --git a/project/TFT/211_popup_presets_sel.bmp.tft b/project/TFT/211_popup_presets_sel.bmp.tft
diff --git a/project/TFT/212_popup_steppers.bmp.tft b/project/TFT/212_popup_steppers.bmp.tft
diff --git a/project/TFT/213_popup_steppers_sel.bmp.tft b/project/TFT/213_popup_steppers_sel.bmp.tft
diff --git a/project/TFT/240_debug1.bmp.tft b/project/TFT/240_debug1.bmp.tft
diff --git a/project/TFT/241_debug2.bmp.tft b/project/TFT/241_debug2.bmp.tft
diff --git a/project/TFT/249_wait.bmp.tft b/project/TFT/249_wait.bmp.tft
diff --git a/project/TFT/250_kill.bmp.tft b/project/TFT/250_kill.bmp.tft
diff --git a/project/rename.bat b/project/rename.bat
@@ -0,0 +1,13 @@
+@echo OFF
+
+for %%f in (DWIN_SET\13*.bin) do (
+	if not "%%f" == "DWIN_SET\13_touch.bin" move /y "%%f" "DWIN_SET\13_touch.bin"
+)
+
+for %%f in (DWIN_SET\14*.bin) do (
+	if not "%%f" == "DWIN_SET\14_variable.bin" move /y "%%f" "DWIN_SET\14_variable.bin"
+)
+
+for %%f in (DWIN_SET\22*.bin) do (
+	if not "%%f" == "DWIN_SET\22_config.bin" move /y "%%f" "DWIN_SET\22_config.bin"
+)
diff --git a/project/rename.sh b/project/rename.sh
@@ -0,0 +1,7 @@
+#!/bin/sh
+
+find DWIN_SET -type f -name "13*.bin" ! -name "13_touch.bin" -exec mv {} DWIN_SET/13_touch.bin \;
+find DWIN_SET -type f -name "14*.bin" ! -name "14_variable.bin" -exec mv {} DWIN_SET/14_variable.bin \;
+find DWIN_SET -type f -name "22*.bin" ! -name "22_config.bin" -exec mv {} DWIN_SET/22_config.bin \;
+
+exit 0