marlin

# Marlin 3D Printer Firmware

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.

Current HALs

name	processor	speed	flash	sram	logic	fpu
Arduino AVR	ATmega, ATTiny, etc.	16-20MHz	64-256k	2-16k	5V	no
Teensy++ 2.0	AT90USB1286	16MHz	128k	8k	5V	no
Arduino STM32	STM32F1 ARM-Cortex M3	72MHz	256-512k	48-64k	3.3V	no
Due, RAMPS-FD, etc.	SAM3X8E ARM-Cortex M3	84MHz	512k	64+32k	3.3V	no
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
Azteeg X5 GT	LPC1769 ARM-Cortex M3	120MHz	512k	32+16+16k	3.3-5V	no
Selena Compact	LPC1768 ARM-Cortex M3	100MHz	512k	32+16+16k	3.3-5V	no
Teensy 3.5	ARM-Cortex M4	120MHz	512k	192k	3.3-5V	yes
Teensy 3.6	ARM-Cortex M4	180MHz	1M	256k	3.3V	yes

HALs in Development

name	processor	speed	flash	sram	logic	fpu
STEVAL-3DP001V1	STM32F401VE Arm-Cortex M4	84MHz	512k	64+32k	3.3-5V	yes
Smoothieboard	LPC1769 ARM-Cortex M3	120MHz	512k	64k	3.3-5V	no
Adafruit Grand Central M4	ARM-Cortex M4	120MHz	1M	256k	3.3V	yes

Submitting Patches

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 your questions and concerns to the Issue Queue.

RepRap.org Wiki Page

Credits

The current Marlin dev team consists of:

• Scott Lahteine [@thinkyhead] - USA  
• Roxanne Neufeld [@Roxy-3D] - USA
• Bob Kuhn [@Bob-the-Kuhn] - USA
• Chris Pepper [@p3p] - UK
• João Brazio [@jbrazio] - Portugal
• Erik van der Zalm [@ErikZalm] - Netherlands  

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.