|
1 | | -# CR-6 Touchscreen software |
2 | | -Attempt to extend the CR-6 touch screen software. This repository belongs to the [forked Marlin firmware repository](https://github.com/CR6Community/Marlin/). |
| 1 | +# CR-6 Touchscreen firmware |
| 2 | +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. |
3 | 3 |
|
4 | | -## Downloads |
5 | | - |
6 | | -Please find official releases in the [Releases section](https://github.com/CR6Community/CR-6-touchscreen/releases). Take the release which belongs to the particular firmware you are going to flash. |
| 4 | +**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.** |
7 | 5 |
|
8 | | -Ensure you take the right assets: the `CR-6-touchscreen-[date].zip`. You should not download the `Source code` archive if you are downloading with the purpose of flashing your LCD. |
| 6 | +**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.** |
9 | 7 |
|
10 | 8 | *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.* |
11 | 9 |
|
12 | | -## Contributing |
13 | | - |
14 | | -We are open for contributions. **Please open an issue in the issue tracker first before you start work on a pull request.** |
15 | | - |
16 | | -The reason for this is that the DWIN project is not friendly for source control and any files cannot be merged (all binary). So, using our Discord server, we synchronize who is working on the files to prevent conflicts. |
17 | | - |
18 | | -### Translations / localization |
19 | | - |
20 | | -Internationalization support in DGUS DWIN is very cumbersome. The background images of each page has the text hardcoded. To translate and have it first-class, you would need to duplicate all the bmps, give it a separate ID, and maintain that mapping in firmware as well or make every label an icon, which is a lot of work. The development team has no capacity to maintain localizations. |
21 | | - |
22 | | -If you like to translate the user interface to your own language, you must fork this repository and maintain your own version of the touch screen firmware. |
23 | | - |
24 | | -The complete workflow would look like this: |
25 | | - |
26 | | -1. Fork this repository. |
27 | | -2. Work on the extui branch (this is the branch for all work going forward) |
28 | | -3. In your fork, follow [the steps in the images section of this file](#images--screen-images-sources) to change the current bitmaps and translate them. There are XCF files available as the source of these bitmaps, usable in Gimp, to make life easier but you can do what you want. |
29 | | -4. When we change something, it is up to you to replicate those screen changes. Therefore I recommend only to update the screen backgrounds and don't use the DWIN editor for anything other than for the purpose of generating the ICL file. |
30 | | -5. Translated touch screen builds are up to you to provide which would then need to be made from the same moment as we are releasing builds. |
31 | | - |
32 | | -Good luck, and if you maintain your own translated firmware, please let us know! |
33 | | - |
34 | | -## Documentation for development |
35 | | - |
36 | | -You need the [DGUS v8.0.x software](http://dwin.com.cn/home/Index/download_file?download_id=4796) for editing the touch screen. |
37 | | - |
38 | | -You can open the .dgus project file in the [`src\DWIN`](src\DWIN) folder: |
39 | | - |
40 | | - |
41 | | - |
42 | | -### Build firmware archive |
43 | | - |
44 | | -To build a firmware archive for distribution, use the `build.cmd` script. It will do a sanity check and then zip the files to the `build` folder. |
45 | | - |
46 | | -For development you can run the build script as follows: |
47 | | - |
48 | | -```pwsh |
49 | | -.\build -Deploy Q: |
50 | | -``` |
51 | | - |
52 | | -Where Q: is the path of your flash drive with the SD card. |
53 | | - |
54 | | -You need to have Powershell Core installed (pwsh). |
55 | | - |
56 | | -### Images / screen images sources |
57 | | - |
58 | | -You can find the source files where the screen bitmaps are generated from in the [`src\images_src`](src\images_src) folder. |
59 | | - |
60 | | -To update the BMP of a screen put the **generated BMP file you made with your image editor** in the [`src\DWIN\DWIN_SOURCE`](src\DWIN\DWIN_SOURCE) folder. |
61 | | - |
62 | | -#### Updating the touch screen firmware files |
63 | | - |
64 | | -It will be picked up automatically by the build process of DWIN when saving or generating the project. However, the ICL file is what actually gets flashed. This is essentially a dictionary of concatenated compressed JFIF files. |
65 | | - |
66 | | -Next, re-generate the `23_Screen.icl` ICL file are follows: |
67 | | - |
68 | | - |
69 | | - |
70 | | -Things worthy of note: |
71 | | - |
72 | | -- Quality is set to 100%, followed by pressing the "Set all" button to apply it to each import file. |
73 | | -- The `DWIN_SOURCE` is used as a source for generating the ICL. |
74 | | -- The ICL is saved twice: once in the `DWIN_SOURCE` folder, once in the `DWIN_SET` folder. |
75 | | - |
76 | | -As you can note, you update it in both `DWIN_SET` and `DWIN_SOURCE`. The first is what goes to the touch screen, the latter is what the DWIN editor uses (apparently). |
77 | | - |
78 | | -For icon ICL generation the process is the same, except that you pick the icons from a subdirectory of `DWIN_SOURCE`. |
79 | | - |
80 | | -### Flash space |
81 | | - |
82 | | -DWIN uses a specific set-up of the flash space as described in the manual - as shown below. |
83 | | - |
84 | | - |
85 | | - |
86 | | -Essentially what it boils down to: |
87 | | - |
88 | | -- The flash space is divided into 256KB sectors |
89 | | -- The number prefix on the ICL/HZK/BIN file name is the sector number where the file is flashed |
90 | | -- A sector can only contain a single file |
91 | | -- A file can span over multiple sectors, and if a file needs 1½ sectors for instance, it will allocate 2 sectors. |
92 | | -- There is no protection against sector overwriting: if you have files overlap sectors, DWIN will happily flash the next file over the previous file |
93 | | - |
94 | | -So with the above in mind one must take care to make sure files do not overlap. When you flash everything to the touch screen you must ensure you've deleted the old (renumbered) ICL files from your SD card, otherwise weird things will happen. Background may go missing, etc. |
95 | | - |
96 | | -During build a script will run to make sure no sectors have been overallocated. You can also run this script manually. |
97 | | - |
98 | | - |
99 | | - |
100 | | -### How buttons are handled with code |
101 | | - |
102 | | -In the currently - cleaned up - source code of the touch screen handling in Marlin, the events of the touch screen are handled as described below. This may change in the future. This picture says it all: |
103 | | - |
104 | | - |
105 | | - |
106 | | -For buttons: |
107 | | - |
108 | | -- Virtual Pointers for buttons are defined in `extui/lib/dgus_creality/DGUSDisplayDef.h` |
109 | | -- In `extui/lib/dgus_creality/DGUSDisplayDef.cpp` in the `ListOfVP` the Virtual Pointer are connected to a callback handler |
110 | | -- Because the Creality display used the same VP all over the place, sometimes in completely different functions or values (and this is quite some work to clean up!), these "legacy" VPs are delegated to `DGUSCrealityDisplay_HandleReturnKeyEvent` |
111 | | -- For legacy VPs handlers are defined per page in `extui/lib/dgus_creality/PageHandlers.cpp` |
112 | | - - The "Key Data" is used to distinguish between the actual key pressed and passed to these functions as `buttonValue` |
113 | | - |
114 | | -For dynamic updatable values: |
115 | | - |
116 | | -- Dynamic updatable values are Virtual Pointers with a value that is pushed from the display when it is changed, and pushed to the display during the Marlin `idle` loop |
117 | | -- The Virtual Pointers are defined in `extui/lib/dgus_creality/DGUSDisplayDef.h` |
118 | | -- Per dynamically updated virtual pointer there is in `extui/lib/dgus_creality/DGUSDisplayDef.cpp`: |
119 | | - - A registration in `ListOfVP`, with: |
120 | | - - The VP ID |
121 | | - - A pointer to the memory location to read the value from in Marlin (can be `nullptr`) |
122 | | - - A callback that is triggered when the VP changed in the display and is pushed to firmware |
123 | | - - A callback that is triggered to format the VP for transfer to the display. This is because strings need to be sent differently than floats, or if your VP does not point to a direct value in memory. |
124 | | - - A mention in the specific `VPList` for the current page as referenced in `VPMap`. This is to optimize that we don't update VPs that are not displayed anyway. |
125 | | -- Some values like the M117 text are transient and are pushed directly to the display, but are still present in the `ListOfVP` |
126 | | - |
127 | | -#### Previous version of the code |
128 | | - |
129 | | -If you like to see how the touch screen code is handled in the Creality firmware and the original Community Firmware release 3 and lower, please check the [cf3-legacy](https://github.com/CR6Community/CR-6-touchscreen/tree/cf-3-legacy) branch. This branch is no longer maintained and only exists for historical purposes. |
130 | | - |
131 | | -### Touch screen configuration |
132 | | - |
133 | | -The touch screen configuration file "T5LCFG_272480.CFG" has its specification describer in [T5L_DGUSII Application Development Guide20200902.pdf](./doc/vendor/T5L_DGUSII%20Application%20Development%20Guide20200902.pdf) chapter 4. You can use an editor like HxD to explore and edit it (with caution!). The DWIN editor also has a way to edit this file. Many parameters can also be set at runtime. |
134 | | - |
135 | | -### Fonts |
| 10 | +## Downloads |
136 | 11 |
|
137 | | -Font's are currently configured like below: |
| 12 | +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. |
138 | 13 |
|
139 | | - |
| 14 | +* Zip files with "ReleaseCandidate" in their name are ready to download for beta test and feedback. |
140 | 15 |
|
141 | | -In the same folder where you have the DWIN tool unpacked a `0_DWIN_ASC.HZK` file is placed. You need to copy that to the DWIN_SET folder, and can flash it directly. |
142 | | -The kerning of the current font is not ideal (especially using numbers that are small, like "1"), so perhaps we should look for a replacement. |
| 16 | +* Zip files with "Source" in their name are the DGUS project and source files for this project. |
143 | 17 |
|
144 | | -### Other documentation |
| 18 | +## Installing This Firmware to your Touchscreen |
| 19 | +1. Download the applicable .zip file from the Releases Assets list |
| 20 | +2. Extract all contents from the .zip file into a new blank directory |
| 21 | +3. Find and read ALL of the README files BEFORE attempting to flash your display (You'll be glad you did!) |
| 22 | +4. Figure-out which DGUS 2 is presently running on your display |
| 23 | +5. Flash the other DGUS2 kernel ONLY if you should (per the README in the kernel upgrades folder) |
| 24 | +6. Verify that you have satisfied all of the Pre-Requisites for flashing this firmware (Which you will know after reading the README files...) |
| 25 | +7. Flash your display with the DWIN_SET folder |
| 26 | +8. If anything went wrong, try the TROUBLESHOOTING.MD instructions |
| 27 | +9. Please provide feedback in Comments or Issues, as applicable |
145 | 28 |
|
146 | | -Vendor documentation is mirrored to the [doc/vendor](doc/vendor) folder. |
| 29 | +## Contributing |
147 | 30 |
|
148 | | -In addition, [this is a nice resource](https://github.com/rubienr/MarlinDgusResources/tree/creality-ender-5-plus/projects). |
| 31 | +If you wish to contribute to the project, please provide your inputs by raising a new Issue or by commenting on an Open Issue on this repository, and/or by contributing to the discussion on the [CR6Community Discord #lcd-discussion channel](https://discord.gg/yDY6pb2BQS) |
149 | 32 |
|
150 | 33 | ## Credits |
151 | 34 |
|
152 | | -[The core CR-6 Community firmware dev team](https://github.com/CR6Community/Marlin#credits) |
| 35 | +[InsanityAutomation](https://github.com/InsanityAutomation/Marlin/tree/CrealityDwin2.0_Bleeding) initiated and leads this project. It is upon his work that Thinkersbluff is building. |
| 36 | + |
| 37 | +[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. |
153 | 38 |
|
154 | 39 | Icons from [Font Awesome](https://fontawesome.com/) and [Remix Icon](https://remixicon.com/). |
155 | 40 |
|
|
0 commit comments