Skip to content

Latest commit

 

History

History
141 lines (103 loc) · 10.5 KB

README.md

File metadata and controls

141 lines (103 loc) · 10.5 KB
Raw

Creality CR10S Pro, CR-X, CR10 Max and Ender 5 Plus Touch Screen supported firmware

This branch adds support for the Creality touchscreen machines and was split off from the standard Creality branches due to specific custom changes not found upstream. This includes extensions to the EXTui framework among other smaller tweaks that we have been working towards getting submitted upstream. Machines supported here are :

The CRX Has screen files with or without ABL. Ender 3V2 has a dedicated file set. All other machines should use the same generic set. V3 is the current screen file version.

Screen files are archived with 7-Zip simply because it came out 1/5 the file size of a zip file. That added up fast!

There is a limitation with Windows systems and path depth so the file names need to be shorter than we would prefer. If you get an error compiling due to the path limit, move the folder to the root of your hard drive. Here is a legend to help decode the files:

  • BLT = BLTouch
  • BIL = Bilinear Leveling
  • UBL - Unified Bed Leveling
  • DZ = Dual Z Steppers
  • Fil = FilamentRunout
  • Slnt = Creality Silent Board
  • H = E3D Hemera Extruder
  • MC = Mosquito Creality mount
  • ME = Mosquito E3D mount
  • Melzi Host option disables local SD card to allow more features and buffer for Octoprint control
  • NF = Noise filtering for machines with cable extensions - reduces homing accuracy!
  • LR = Stock runout replaced with Lerdge

Support

This firmware is provided to the public as-is with no warranty or guarantee. It's based on a large open source project and there is no entitlement to support. That said, Tiny Machines 3D customers may obtain support through their normal support queue. I will provide support to Patreons as I am able. If you require more immediate support and are not a Tiny Machines 3D customer, you may contact them at [email protected] about purchasing support hours. Aside from this, we are active on many Facebook groups as well as several discord channels and typically help anyone we can when we come across them.

3D Printing Discord - https://discord.gg/MZrsgVU Marlin Discord - https://discord.gg/n5NJ59y

Primary notes for DW7.3

  • File browser rewritten to support paging as well as subdirectories -- New file browser has a limit of a 66 character directory depth. This can be expanded at the cost of more RAM if users find this more limiting. -- Due to the above, the current recommendation is to try and limit folder depth to 3 subdirectories and keep names short if possible.
  • Base bumped to Marlin Bugfix as of 20210418

Changes for DW7.3.1

  • Added SD file refresh button for users with damaged SD Detect Pins
  • Modified print finish button action to raise z by 5mm and disable steppers rather than rehome XY
  • Solve rounding issue with babystepping below step precision by forcing always round up caused by recent upstream change
  • Modified babystepping resolution for fine adjustment to .02mm from .01mm
  • Force file pages to reset paging value on entry to screen to prevent incorrect scrolling
  • Additional string length buffer safeties

The default build button is now a batch Build All! If you want to build a custom stock 2560 environment, use the env:megaatmega2560 environment. For SKR 1.3/1.4 boards use the LPC1768/9 environments as usual. For SKR Mini or Creality STM32F1 boards use the standard STM32 environments per vendor.

About Our Branches

The firmware branches maintained here are made possible by the support of Tiny Machines 3D as well as our customer base through our 3D printing Services. Maintaining and developing these branches takes a significant investment, made up of time and machines. To support continued development, please consider your next 3D Printer related purchase from Tiny Machines 3D and thank them for supporting open source development. Or, consider us for printing services outside of your machine’s capabilities. Print service requests can be sent to [email protected] and we will respond typically within 1 working day. If you do not need anything printed or a 3D Printer but still want to contribute, you can support us through Patreon.

Setup

All configuration options intended to be adjusted by end users have been placed in the top section of Configuration.h and have been documented there. There is typically a break line to segregate the standard configuration below. Anything aside from the upper options is intended for advanced users only. Please keep in mind when flashing the Creality 32 bit boards with the binary files (.bin) that occasionally they will not accept particular filenames. This is most common with reflashing after an aborted flash. The machine stores the filename it was last flashed with, so renaming the file to something such as firmware.bin or firmware1.bin (anything different than what it is now) will typically resolve any issue with file names.

Known Issues

  • While auto leveling (measuring) is in progress pressing other buttons on the screen can abort portions of the script depending where it is
    • The process includes heating the bed before probing, probing then heating the nozzle before moving to Z0.
  • Thanks to Jarrett Wendt for finding that if you are experiencing distorted sounds, and use a Mac, the default Archive Utility on MacOS has been found to be corrupting the files. If you're on a Mac, try unzipping with The Unarchiver or Keka instead.

Future Goals

For this branch, we still have some active goals open that we plan to continue working on provided there is continued interest in the project.

  • Volume and leveling state EEPROM storage
  • Brightness control
  • Develop internal Marlin state structure for better reporting of pause / block conditions
  • CRX Non ABL Manual mesh interface to bring screens into parity with ABL versions

Creality Firmware Branches

Formbot / Vivedino Firmware Branches

Mamorubot / HieHa Firmware Branches

Other Firmware

Marlin Commit History

Marlin

This is just one of many forks of Marlin. We don't try to bury that behind fancy marketting or anything else. As you can see from the links above, most of the work done here is submitted back to the mainstream Marlin branches. The end goal of every project is to get it to the point where it is merged and maintained there. See marlin resources, including how to contribute to the Marlin Project as well, down below.

Building Marlin 2.0

To build Marlin 2.0 you'll need Arduino IDE 1.8.8 or newer or PlatformIO. We've posted detailed instructions on Building Marlin with Arduino and Building Marlin with PlatformIO for ReArm (which applies well to other 32-bit boards).

The current Marlin dev team consists of:

License

Marlin is published under the GPL license because we believe in open development. The GPL comes with both rights and obligations. Whether you use Marlin firmware as the driver for your open or closed-source product, you must keep Marlin open, and you must provide your compatible Marlin source code to end users upon request. The most straightforward way to comply with the Marlin license is to make a fork of Marlin on Github, perform your modifications, and direct users to your modified fork.

While we can't prevent the use of this code in products (3D printers, CNC, etc.) that are closed source or crippled by a patent, we would prefer that you choose another firmware or, better yet, make your own.