Getting Started #
Flashing your printer firmware is pretty easy once you go through the installation steps one or two times. We’ve simplified the firmware setup as much as possible so you don’t have to be an expert with code. Our firmware allows you to get more control over your printer, make repairs easier, add on upgrades, and really get into tuning your machine to make it print better.
The firmware update consists of downloading the firmware itself, opening it in Visual Studio Code, setting the options for your machine, compiling it, and then uploading it to the printer.
LCD Kit REQUIRED #
Currently, only the 12864 LCDs work 100% correctly with this printer and board with our firmware. We have a kit here to do the conversion. The stock touch LCD is not supported and likely will never be supported due to it being closed source.
Board Compatibility #
This firmware is for the stock Creality V24S1_301 Board. This board does NOT need any special folder structure for its firmware to be flashed UNLESS you have a F4 CPU. If you have an F4 CPU on your board the firmware bin file MUST be placed on the SD card inside a folder called “STM32F4_UPDATE” or it will NOT work.
You will have to look at the CPU on your printer’s control board to see if it says STM32F103 or STM32F401 on it to determine what CPU model you have. Flashing the wrong version on the wrong CPU can “brick” your board and we are not responsible if you fail to verify your CPU before installing any firmware update.
Setup Visual Studio Code First #
If you have not already installed and set up Visual Studio Code to compile the firmware please see our guide on how to do that before continuing. Click here to open the guide that we’ve written for you.
In the firmware download below you will get a ZIP file. Extract this to a folder on your PC
We also recommend you download the Unified 2 STL pack as well. This contains EZABL mounts, Gantry leveling Blocks, Solid bed mounts, and Bed Level test files.
Cloud Storage Note: Extract to a folder that is NOT in a “cloud” storage folder. Many users have reported issues using the firmware when the folder is in a cloud storage folder.
Using the Firmware #
Opening the firmware in Visual Studio Code #
Once the files are extracted you will need to open the folder in Visual Studio Code. You must open the folder named Firmware and not any other one. Failure to open the firmware at the correct folder level will result in it not working.
First time using our firmware or having issues? Watch our video that is intended to clear up common mistakes people make when opening and using the firmware here: Unified 2 VSCode Tips for Noobs | EZTip #8 – YouTube
Once the folder is opened, you will expand the Marlin folder on the left and side and then double click on the file called “Configuration.h”. This file is where you will set up the firmware for your specific printer.
Editing The Configuration.h File #
In the configuration.h file there are printer models you can uncomment to tell the firmware what machine you are setting it up for. Uncomment means removing the // in front of a setting and you will be left with #define XXXXXX if an option is enabled.
There are many other options in the firmware for setting up upgrades, tuning, and other features. Read through the files configuration section to see all the features we’ve put in the firmware for you.
We have an article here with more details about the use of the configuration.h file.
Testing the Firmware Settings #
Once you have all the options you want and your printer model setting uncommented now it’s time to make sure it compiles with no issues. To do that just click the ✓ at the bottom-left of Visual Studio Code and it will build the firmware.
If the build succeeds it is ready for you to upload to your printer. You will know if it was successfully built because it will show a SUCCESS in green at the bottom of the window in Visual Studio Code.
Flashing the Firmware #
Upload the firmware to your board (SD Card Method) #
Now that we have the firmware tested we can upload it to your printer. Your particular printer uses a SD Card to upload it to the printer board. The firmware will be in a folder that matches the CPU name in .pio > build > CPUNAME. There will only be ONE folder in the Build folder so you just open that folder. Your folder name may be different from the picture shown below. You can open the folder by right-clicking on the folder for your board’s CPU and clicking “Reveal in File Explorer”.
Once you locate the .bin file for your board copy this to your SD card. This SD card MUST be formatted with FAT or FAT32 file system and most boards prefer a 4096 allocation byte size. Smaller cards (16GB or less) are better to use than larger ones for the best compatibility.
Power off your printer and put the SD card into your printer’s SD slot. Turn the power on. This will cause the printer to flash the firmware from the SD card to your printer CPU. This may take up to 1 minute on some boards.
DO NOT UNPLUG THE PRINTER. Interrupting the flashing can “brick” your board and if this happens you will need to reflash the bootloader with a programmer before you can flash again.
When the printer boots you may see the TH3D logo on your LCD, printers with low-end CPUs may not show a TH3D logo but all will show a Marlin screen with TH3D Studio showing on the version information.
Reset your EEPROM! #
Make sure to reset your EEPROM on your printer after flashing any firmware. You can do this from your printer LCD by going to Configuration -> Reset EEPROM or by sending an M502 followed by M500 with your favorite Gcode sender application.