🛠️ Guide: Setting Up Visual Studio Code to Compile Marlin Firmware

🔍 Overview

This guide walks you through installing and setting up Visual Studio Code to compile Marlin firmware for 3D printers, covering both 8-bit and 32-bit boards. It uses the Auto Build Marlin plugin, making the process easier than ever—even on older systems.

📋 Prerequisites

• A Windows, macOS, or Linux computer
• Internet access
• Your 3D printer’s mainboard model
• A microSD card (for 32-bit boards)

🔌 Step 1: Install Drivers for Your Mainboard

1. Connect your printer/mainboard via USB.
2. Wait for Windows to recognize the device:

• Starts as “Unknown device”
• Changes to COM port after automatic driver installation.

1. If not installed automatically:

• Use linked drivers from TH3D (see YouTube video description).
• Match the correct driver to your board model.

💻 Step 2: Install Visual Studio Code (VS Code)

1. Download from https://code.visualstudio.com
2. Run the installer and accept defaults (optionally enable Desktop icon).
3. Launch VS Code.
4. Disable “Welcome” tab if desired.

🧩 Step 3: Install Required Extensions in VS Code

1. Open the Extensions tab (four squares icon).
2. Install the following:

• PlatformIO IDE (search: platformio)
• Auto Build Marlin (search: auto build marlin)

1. Confirm installation by checking for:

• 🐞 Bug icon (PlatformIO)
• M icon (Auto Build Marlin)

📥 Step 4: Download Marlin Firmware Source

1. Visit the Marlin GitHub repo
2. Switch to the bugfix branch.
3. Click Code > Download ZIP
4. Also download the Configuration ZIP from the link in the /config folder README.

🗂️ Step 5: Unzip and Open the Firmware

1. Unzip the main Marlin folder to a short path (e.g., C:Marlin).
2. In VS Code:
3. File → Open Folder → Select top-level Marlin folder
4. Wait for VS Code to finish indexing the project.

🔧 Step 6: Install Preconfigured Files for Your Printer

1. Open the configuration ZIP, browse to your printer’s example (e.g., config/examples/Creality/Ender3 V4).
2. Copy all files into:
3. Marlin/Marlin/
4. Overwrite when prompted.
5. VS Code will now load your updated configuration.

🔨 Step 7: Compile the Firmware

1. Click the Auto Build Marlin (M) icon.
2. Click the hammer to build.
3. If prompted, choose your environment (e.g., mega2560).
4. Wait for a success message.
5. Use the folder icon to locate the .hex or .bin file.

⬆️ Step 8: Uploading Firmware

🧠 For 8-bit Boards:

1. Ensure COM port is working and drivers are installed.
2. Click Upload in the Auto Build Marlin tab.
3. Firmware will compile and upload.

⚠️ Note: Close Cura or similar software that may block the COM port.

🚀 For 32-bit Boards:

1. Do NOT click Upload.
2. Copy the .bin file to a FAT32-formatted microSD card.
3. Insert the card into your printer and power it on.
4. Wait 5–10 seconds for the update to finish.

📡 Optional: Use Pronterface for Terminal Access

• Download from https://github.com/kliment/Printrun
• Unzip and run pronterface.exe
• Connect your printer (select correct COM port and speed)
• Example commands:
• M115 → show firmware version
• M503 → show current configuration

💡 Troubleshooting Tips

• Blank LCD? → Check LCD config in Configuration.h
• Build error? → Check path length and board environment
• COM port missing? → Recheck USB connection and driver installation

🙌 Final Thoughts

This guide should help you successfully compile and upload Marlin firmware.

Big thanks to the Marlin devs and the community behind tools like Auto Build Marlin!

Happy 3D Printing!