Merge pull request #97 from CR6Community/Re-Factored_Version_1.1

Update Repo with Refactored Version 1.1 contents

README.md

@@ -1,26 +1,51 @@
-# CR-6 Touchscreen firmware
-Attempt to extend the CR-6-touchscreen firmware to operate with DWIN display hardware flashed with and calibrated to run DGUS2 v4.5 or higher, such as those being sold with new CR6 machines as of approximately Dec 2021.
+# Re-Factored CR-6 Touchscreen firmware
 
-**NOTE: The June 2021 release of the CF6.1 Touchscreen firmware remains valid for use on all CR6 printers currently running and calibrated for DGUS2 v3.5.**
+## Do You Need This Re-Factored Version?
 
-**To find out which version of DGUS2 is running on your display, "flash" your display with a micro SD card that contains ONLY an EMPTY folder named DWIN_SET. The top line on the blue screen will display the current DGUS2 version.**
+**The June 2021 release of the CF6.1 Touchscreen firmware remains valid for use on all CR6 printers currently already running and calibrated for DGUS2 v3.5.**
+
+*If you have [a BTT SKR board with the BTT TFT](https://damsteen.nl/blog/2020/11/25/how-to-btt-skr-cr6-installation) you do not need this firmware. This firmware is only for when you use the stock Creality DWIN TFT display with the stock or BTT motherboard.*
+
+If your DWIN display is flashed with DGUS2 v4.5 or higher, THIS IS YOUR ONLY OPTION for running CF6.1 on your CR6 printer (unless you wish to recalibrate your touchscreen to work with DGUS2 v3.5...  See the README in the folder containing the DGUS2 Kernel files.)
+
+## What Problem Does This Solve?
+
+The original June 2021 CF6.1 DWIN_SET will ONLY run on displays using DGUS2 v3.5.  As of approximately December 2021, Creality started shipping displays flashed and calibrated with DGUS2 v4.5.  DGUS2 v4.5 and higher require a different touchscreen calibration than prior DGUS2 versions.  CF6.1 users who flashed those new displays started having one of two serious problems:   
+  1. If they flashed the Kernel Upgrade files to their displays, then the push buttons on the main menu did not respond to touch (because the touchscreen was not calibrated for DGUS2 v3.5)  
+  2. If they did NOT flash the Kernel Upgrade files (What? Not everybody follows the Readme instructions?!?), their screens came up blank, because the June 2021 version of CF6.1 DWIN_SET ONLY runs on DGUS2 v3.5.
+
+That issue left some new CF6.1 users "snookered" and often led to other issues as they tried to revert to stock and could not make that work either (if they had flashed the kernel upgrade files.)
+
+## How Re-Factoring Helps
+
+This Re-Factored version of DWIN_SET was recreated from the June2021 release of the CF6.1 Touchscreen Firmware, in a different version of the DGUSTools.
+It will run on ALL versions of DGUS2, regardless of the touchscreen calibration, AS LONG AS YOU DO NOT FLASH DGUS2 KERNEL FILES TO THE DISPLAY THAT ARE INCOMPATIBLE WITH THE TOUCHSCREEN CALIBRATION. (See the README in the folder containing the DGUS2 Kernel files.)  
+
+**NOTE: Text kerning does NOT work correctly on DGUS2 v1.x, so although this DWIN_SET can be used on Kickstarter CR6 machines still running DGUS2 v1.04, some data will not fit neatly into their display fields, unless you upgrade the DGUS2 with the DGUS2 v3.5 kernel upgrade file provided.**
+
+## How Do I Find Out What DGUS2 kernel is Running on my Display?
+
+**To find out which version of DGUS2 is running on your display, "flash" your display with a micro SD card that contains ONLY an EMPTY folder named DWIN_SET. The top line on the blue flash screen will display the DGUS2 version currently installed.**
 
-*If you have [a BTT SKR board with the BTT TFT](https://damsteen.nl/blog/2020/11/25/how-to-btt-skr-cr6-installation) you do not need this firmware. This firmware is only for when you use the stock Creality LCD with the stock or BTT motherboard.*
 
 ## Downloads
 
-When code is ready for users to experiment with, the Source and zip files are posted as Assets in the Releases section of this repository.
+When code is ready for users to experiment with, the Source and DWIN_SET zip files are posted as Assets in the Releases section of this repository.
 
-* Zip files with "ReleaseCandidate" in their name are ready to download for beta test and feedback.
+* The Zip file with DWIN_SET in the name contains the DWIN_SET folder, README and support files for the current release. 
+  Download that file from the latest Release's Assets list.
 
 * Zip files with "Source" in their name are the DGUS project and source files for this project.
+  You do not need those files, unless you intend to try to fork and modify this version of the UI.
 
 ## Installing This Firmware to your Touchscreen
-1. Download the applicable .zip file from the Releases Assets list
-2. Extract all contents from the .zip file into a new blank directory
+1. Download the applicable DWIN_SET .zip file from the latest Release's Assets list
+2. Extract all contents from that .zip file into a new blank directory
 3. Find and read ALL of the README files BEFORE attempting to flash your display (You'll be glad you did!)
-4. Figure-out which DGUS 2 is presently running on your display 
-5. Flash the other DGUS2 kernel ONLY if you should (per the README in the kernel upgrades folder)
+4. Figure-out which DGUS 2 is presently running on your display (as explained above)
+5. DO NOT FLASH ANY KERNEL FILES TO YOUR DISPLAY, unless:  
+  5.1 You have inadvertently "bricked" your display by flashing the DGUS2 kernel upgrade files to a display calibrated for DGUS2 v4.5+  
+  5.2 Your display is running version 1.x of DGUS2, and you want to fix the text kerning (in which case, add the DGUS2 v3.5 kernel file to your DWIN_SET.)
 6. Verify that you have satisfied all of the Pre-Requisites for flashing this firmware (Which you will know after reading the README files...)
 7. Flash your display with the DWIN_SET folder 
 8. If anything went wrong, try the TROUBLESHOOTING.MD instructions
@@ -32,7 +57,7 @@ If you wish to contribute to the project, please provide your inputs by raising
 
 ## Credits
 
-[InsanityAutomation](/~https://github.com/InsanityAutomation/Marlin/tree/CrealityDwin2.0_Bleeding) initiated the refactoring project. It is upon his work that Thinkersbluff has built this Release.
+[InsanityAutomation](/~https://github.com/InsanityAutomation/Marlin/tree/CrealityDwin2.0_Bleeding) initiated the refactoring project. It is upon that work that Thinkersbluff has built this Release.
 
 [The core CR-6 Community firmware dev team](/~https://github.com/CR6Community/Marlin#credits) did the heavy-lifting that resulted in the CF6.1 baseline.
 

doc/build/Re-FactoredVersion1.1/CR6 Community Marlin Firmware - Releases Page.url

@@ -0,0 +1,5 @@
+[{000214A0-0000-0000-C000-000000000046}]
+Prop3=19,11
+[InternetShortcut]
+IDList=
+URL=/~https://github.com/CR6Community/Marlin/releases

doc/build/Re-FactoredVersion1.1/CR6 Community Touchscreen Firmware - Releases Page.url

@@ -0,0 +1,5 @@
+[{000214A0-0000-0000-C000-000000000046}]
+Prop3=19,11
+[InternetShortcut]
+IDList=
+URL=/~https://github.com/CR6Community/CR-6-touchscreen/releases

doc/build/Re-FactoredVersion1.1/DGUS2 kernel files/README.md

@@ -0,0 +1,34 @@
+# NOTE: These kernel files are not required, unless you are having problems resulting from having inadvertently overwritten the DGUS2 kernel for which your display was last calibrated.
+
+## STEP1 - BEFORE ACTING ON ANY OF THE FOLLOWING RECOMMENDATIONS:
+1. Create an EMPTY folder at the root directory of an EMPTY micro SD card.
+2. Ensure that your printer power is OFF
+3. Place that SD card in your display and cycle power ON
+4. The top line of the display will report which version of DGUS2 is currently flashed .  
+4. Make note of which DGUS version is currently flashed to your display hardware (see top line on display)
+5. Take care to follow the applicable instructions below.
+
+## IF your display is currently running v3.5 and it should be running v4.5:
+STEP 2: 
+1. Copy T5L_UI_DGUS2_V45_20220105.BIN to the DWIN_SET folder created at step 1 above, and flash that to your display.
+2. Verify that the top line on the blue flash screen is now overwritten in red confirming that DGUS2 v4.5 is flashed
+3. Optionally repeat step 1 with an empty DWIN_SET folder, to confirm v4.5 is now the DGUS2 OS
+
+# OR
+
+## IF your display is currently running v4.5 and it should be running v3.5:
+STEP 2: 
+1. Copy T5L_UI_DGUS2_V35_20200730.BIN to the DWIN_SET folder created at step 1 above, and flash that to your display.
+2. Verify that the top line on the blue flash screen is now overwritten in red confirming that DGUS2 v3.5 is flashed
+3. Optionally repeat step 1 with an empty DWIN_SET folder, to confirm v3.5 is now the DGUS2 OS
+
+
+# Here is how to interpret what you see:
+
+The top line of the blue boot screen always identifies the current DGUS2 OS in white text.
+
+If the DWIN_SET folder being flashed contains a DGUS kernel BIN file, the top line is overwritten in RED text, reporting the version that has been flashed.
+
+If the two lines are different, it may be difficult to read either line.
+
+If the two lines are identical, the current DWIN_SET folder has reflashed the same kernel to the display.

doc/build/Re-FactoredVersion1.1/DWIN_SET/README.txt

@@ -0,0 +1,23 @@
+This README file can be left in this folder or deleted, as you wish.  The display bootloader will ignore it.
+
+These two files need only be flashed ONCE to your display:
+ - T5LCFG_272480.CFG
+ - 0_DWIN_ASC_New_At_v1.1.HZK
+
+The T5LCFG file configures your display. DO NOT INTERUPT POWER WHILE FLASHING THAT FILE OR YOU MAY BRICK YOUR DISPLAY!!!
+
+The HZK file loads the font graphics to your display.
+The data displays have been sized to work specifically with this font If you do not flash it, the display will use the last font file you did flash, which might cause some values to be too large or small for the field.
+
+NOTE: This font file finally fixes the "clipped descenders" bug!
+
+
+If you wish:
+  You can put just these two files into a folder called DWIN_SET and flash just them to your display.
+    The blue screen will show 001 CFG file and 001 HZK file flashed, when it reaches END!
+
+  Then you can delete those two files from this DWIN_SET folder and flash the rest of these files to your display.
+
+Alternatively, you can flash all of the files in this folder to your display in one "shot."
+
+

doc/build/Re-FactoredVersion1.1/KNOWN ISSUES.txt

@@ -0,0 +1,11 @@
+Formal Release: Re-Factored Version 1.1
+Release date: 9 March 2023
+
+The following issues have been observed but not resolved, at this release:
+
+1. The ABLprocess no longer uses the contents of 35_Autolevel.icl to animate the collection & display of the mesh data.  To enable old eyes to read the mesh, the normally white background of the initial screen has been changed to black.  As a result, when the process first initializes all of the values to 0.000 in white, those zeroes are now visible to the user, until replaced by the probing process. This will not look familiar to past users of 6.1, but should not be a problem for new users.
+
+2. Although we have added the display of temperature readings and target values to three thermal warning screens, there is at least one known failure case where the displayed values are all zeroes, instead of the hoped-for dump of the values "seen" by Marlin, if the Thermal Runaway screen appears immediately after the printer is powered-up.  
+That particular failure appears to be a motherboard failure, which requires replacement of the motherboard to resolve.
+
+IF you find any other issues, please message @Thinkersbluff with the key info.  TIA!

doc/build/Re-FactoredVersion1.1/README.txt

@@ -0,0 +1,110 @@
+# Release#: Re-Factored Version 1.1
+
+## NOTE: If you do not see this release number on your system, you have not flashed this version of the touchscreen firmware. 
+
+# Introduction
+
+This formal release is identical to 61F_220622_v1, except:
+  1. The colour theme of the screens has been changed back from cyan/darkblue to black/grey/red
+  2. The jpeg compression artifacts have been removed
+  3. The font has been changed, to solve the descender clipping issues 
+  4. The version # has been rebranded on the splash screen, main menu and Info screens.
+  5. A red line has been added between the grey screen banner and the black background on each screen, to facilitate the recognition of this build vs the original DWIN_SET, when providing help based on photos of the screens.
+
+
+## Background
+
+The CF6.1 touch screen firmware was designed and distributed to run only on the DGUS2 v3.5 operating system.
+
+Creality has now begun delivering the CR6 printers running a more recent version of DGUS2 (v4.5, at the time of this release.) 
+
+DGUS2 v4.5 and higher require a different calibration of the touchscreen than did v3.5.
+
+Following the CF6.1 installation instructions to flash v3.5 with CF6.1 to these newer printers therefore causes the v4.5 touchscreen calibration to be invalid. That results in the touchscreen becoming non-responsive. Reverting to Creality stock also then fails, until the DGUS2 v4.5 kernel is restored to the display.
+
+This re-factored version of the firmware operates correctly on all CR6 printers flashed with DGUS2 OS version 2.0 or higher, as long as:
+
+1. The motherboard has also been flashed with the correct configuration of CF6.1-Final firmware
+
+2. The display hardware has already been calibrated to operate with the version of DGUS2 (2.0 or higher) that is installed on the display.
+
+
+
+# Recommendations for using this firmware
+## _PLEASE read all of these recommendations, before following any of them._
+
+**NOTES:**
+
+**1. As always, flashing this firmware to your system is done entirely at your own risk. The CR-6 Community firmware developers take no responsibility for any consequences of flashing this firmware to your system.**
+
+2. We have seen STEP1 display DGUS2 v4.5 with a different date stamp than the one bundled with this release. (13/01/22 vs 05/01/22) We can not explain why DWIN would publish two variants of the same OS version, nor can we answer whether there are any differences between the two. (See note 1)
+
+
+**STEP1 - BEFORE ACTING ON ANY OF THE FOLLOWING RECOMMENDATIONS:**
+1. Create an EMPTY folder at the root directory of an EMPTY micro SD card.
+2. Ensure that your printer power is OFF
+3. Place that SD card in your display and cycle power ON
+4. The top line of the display will report which version of DGUS2 is currently flashed .  
+4. Make note of which DGUS version is currently flashed to your display hardware (see top line on display)
+5. Take care to follow the applicable instructions below.
+
+
+### If you are currently running Creality stock firmware on your system, and your display is currently running DGUS2 v4.5+
+
+Flash this touchscreen firmware INSTEAD of the CF6.1-Final touchscreen firmware.  
+
+1. Ignore the Touchscreen firmware folder in the CF6.1-Final release zip file.
+
+2. INSTEAD, copy the DWIN_SET folder and contents from this release to the micro-SD card you use to flash the display 
+
+3. DO NOT copy ANY DGUS2 kernel upgrade files to the DWIN_SET folder before flashing it to your display.
+
+### If you are currently running Creality stock firmware on your system, and your display is currently running any version of DGUS2 between (and including) v2.0 and v4.4 (e.g. v3.5)
+
+EITHER: Go ahead and flash the CF6.1 TouchScreen Firmware to your system, following the CF6.1 Touchscreen Firmware README instructions precisely
+
+OR:
+
+Do exactly the same thing as recommended above for the v4.5 users:
+
+1. Ignore the Touchscreen firmware folder in the CF6.1-Final release zip file.
+
+2. INSTEAD, copy the DWIN_SET folder and contents from this release to the micro-SD card you use to flash the display 
+
+3. DO NOT copy ANY DGUS2 kernel upgrade files to the DWIN_SET folder before flashing it to your display.
+
+### If you already flashed the CF6.1-Final touchscreen firmware to your display hardware, your display is now running DGUS2 v3.5, and your display is non-responsive
+
+You can flash this re-factored version of the CF6.1 UI to your display and restore the display to running DGUS2 to v4.5, as follows:
+
+  1. Delete the DWIN_SET folder from the SD card with which you previously flashed your display. (Make sure you keep a copy, just in case!) OR prepare a new blank micro SD card.
+  2. Copy the new DWIN_SET folder distributed in this release to that SD card  
+  3. Copy T5L_UI_DGUS2_V45_20220105.BIN from the DGUS2 kernel upgrade files folder into the new DWIN_SET folder on that card
+  4. Re-flash your display with the updated card
+  5. Verify that the top line of the display shows the DGUS2 v4.5 OS was flashed as part of the process (it will be written in red text over the top of white text that said v3.5)
+  6. Power off the printer
+  7. Remove the SD card from the display and power it back up
+  8. The CF6.1 interface should now work correctly
+  9. Repeating the empty DWIN_SET folder trick described as STEP 1 above will allow you to confirm with confidence that DGUS2 v4.5 is now flashed to the display
+
+## Instructions for Reverting a Display to the Creality Stock Firmware
+
+### If you flashed the CF6.1 firmware and the DGUS v3.5 kernel upgrade files to a DWIN display that was previously configured to run on DGUS2 v4.5 and just want to revert to stock, rather than flashing this firmware release
+
+1. Copy the T5L_UI_DGUS2_V45_20220105.BIN kernel upgrade file into the Creality DWIN_SET folder. 
+2. Re-flash that DWIN_SET to your display. 
+3. Re-flash the stock Creality firmware to the motherboard
+
+The printer will now have been reverted to the Creality stock firmware.
+
+### If you successfully flashed CF6.1 or this release to a DWIN display without flashing any DGUS kernel upgrade files to that display, but now wish to revert to the Creality stock firmware
+
+Flash the stock Creality firmware back to the motherboard and the display, per Creality's instructions.
+
+## Instructions for reverting from this re-factored version BACK to the CF6.1-Final TouchScreen Firmware on a display running DGUS2 v3.5 
+
+Follow the flashing instructions in the CF6.1-Final Touchscreen firmware README file.
+
+
+
+