Marlin 3D Printer Firmware
This is a fork of the official Marlin code.
Original code location: https://github.com/MarlinFirmware/Marlin.git
This repo is a port of Marlin to STM32 F4 MCU. I'm using Nucleo-F446RE as a test platform. I have an addon board for the NUCLEO that converts it to a 3D printer controller in similar fashion how RAMPS addon works with an arduino board. Open source schematics for the addon board: https://github.com/ghent360/PrntrBoard.git. Both the board and this firmware are functional.
I also have a V2 controller design using STM32F407 with integrated CPU and replaceable stepper drivers.
To compile I'm using Arduino 1.8.10 with the official STM32 support library from this link https://github.com/stm32duino/Arduino_Core_STM32 (minimum version 1.8.0 of the core is required)
You can compile the code with the Arduino IDE or Visual Studio Code with an Arduino extension installed.
- bugfix-2.0.x - this branch tracks Marlin's bugfix-2.0.x. Designed to work on my V2 design.
- f407 - this branch is based on my bugfix-2.0.x with modifications so it works on my V1 board with F407 CPU addon and TMC2130 driver.
- f407-2660 - this is based on f407 with configuration changes for V1 with TMC2660 drivers
- f407-2209 - this is based on f407 with configuration changes for V1 with TMC2209 drivers
The following is the original Marlin README text:
Additional documentation can be found at the Marlin Home Page. Please test this firmware and let us know if it misbehaves in any way. Volunteers are standing by!
Marlin 2.0 Bugfix Branch
Not for production use. Use with caution!
Marlin 2.0 takes this popular RepRap firmware to the next level by adding support for much faster 32-bit and ARM-based boards while improving support for 8-bit AVR boards. Read about Marlin's decision to use a "Hardware Abstraction Layer" below.
This branch is for patches to the latest 2.0.x release version. Periodically this branch will form the basis for the next minor 2.0.x release.
Download earlier versions of Marlin on the Releases page.
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).
Hardware Abstraction Layer (HAL)
Marlin 2.0 introduces a layer of abstraction so that all the existing high-level code can be built for 32-bit platforms while still retaining full 8-bit AVR compatibility. Retaining AVR compatibility and a single code-base is important to us, because we want to make sure that features and patches get as much testing and attention as possible, and that all platforms always benefit from the latest improvements.
|Arduino AVR||ATmega, ATTiny, etc.||16-20MHz||64-256k||2-16k||5V||no|
|Arduino Due, RAMPS-FD, etc.||SAM3X8E ARM-Cortex M3||84MHz||512k||64+32k||3.3V||no|
|ESP32||Tensilica Xtensa LX6||160-240MHz variants||---||---||3.3V||---|
LPC1768 / LPC1769
|Re-ARM||LPC1768 ARM-Cortex M3||100MHz||512k||32+16+16k||3.3-5V||no|
|MKS SBASE||LPC1768 ARM-Cortex M3||100MHz||512k||32+16+16k||3.3-5V||no|
|Selena Compact||LPC1768 ARM-Cortex M3||100MHz||512k||32+16+16k||3.3-5V||no|
|Azteeg X5 GT||LPC1769 ARM-Cortex M3||120MHz||512k||32+16+16k||3.3-5V||no|
|Smoothieboard||LPC1769 ARM-Cortex M3||120MHz||512k||64k||3.3-5V||no|
|Adafruit Grand Central M4||SAMD51P20A ARM-Cortex M4||120MHz||1M||256k||3.3V||yes|
|Arduino STM32||STM32F1 ARM-Cortex M3||72MHz||256-512k||48-64k||3.3V||no|
|Geeetech3D GTM32||STM32F1 ARM-Cortex M3||72MHz||256-512k||48-64k||3.3V||no|
|STEVAL-3DP001V1||STM32F401VE Arm-Cortex M4||84MHz||512k||64+32k||3.3-5V||yes|
|PRNTRboard/NUCLEO-F446||STM32F446RE ARM-Cortex M4||180MHz||512k||112+16k||3.3V||yes|
|PRNTRboard/F407||STM32F407VE ARM-Cortex M4||168MHz||512k||192+4k||3.3V||yes|
|PRNTRboard V2||STM32F407VE ARM-Cortex M4||168MHz||512k||192+4k||3.3V||yes|
Teensy 3.1 / 3.2
|Teensy 3.2||MK20DX256VLH7 ARM-Cortex M4||72MHz||256k||32k||3.3V-5V||yes|
Teensy 3.5 / 3.6
|Teensy 3.5||MK64FX512VMD12 ARM-Cortex M4||120MHz||512k||192k||3.3-5V||yes|
|Teensy 3.6||MK66FX1M0VMD18 ARM-Cortex M4||180MHz||1M||256k||3.3V||yes|
Teensy 4.0 / 4.1
|Teensy 4.0||IMXRT1062DVL6A ARM-Cortex M7||600MHz||1M||2M||3.3V||yes|
|Teensy 4.1||IMXRT1062DVJ6A ARM-Cortex M7||600MHz||1M||2M||3.3V||yes|
Proposed patches should be submitted as a Pull Request against the (bugfix-2.0.x) branch.
- This branch is for fixing bugs and integrating any new features for the duration of the Marlin 2.0.x life-cycle.
- Follow the Coding Standards to gain points with the maintainers.
- Please submit Feature Requests and Bug Reports to the Issue Queue. Support resources are also listed there.
- Whenever you add new features, be sure to add tests to
buildroot/testsand then run your tests locally, if possible.
- It's optional: Running all the tests on Windows might take a long time, and they will run anyway on GitHub.
- If you're running the tests on Linux (or on WSL with the code on a Linux volume) the speed is much faster.
- You can use
make tests-single-local TEST_TARGET=....
- If you prefer Docker you can use
make tests-all-local-docker TEST_TARGET=....
The current Marlin dev team consists of:
- Scott Lahteine [@thinkyhead] - USA Donate / Flattr:
- Roxanne Neufeld [@Roxy-3D] - USA
- Chris Pepper [@p3p] - UK
- Bob Kuhn [@Bob-the-Kuhn] - USA
- João Brazio [@jbrazio] - Portugal
- Erik van der Zalm [@ErikZalm] - Netherlands
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.