Go to file
Jyers 3c41f108df
Improved Ender 3 V2 display status area (#20983)
Co-authored-by: Scott Lahteine <github@thinkyhead.com>
2021-02-12 04:55:06 -06:00
.github Unify FYSETC F6 1.3 / 1.4 (#20507) 2020-12-22 06:57:11 -06:00
buildroot chmod and paths 2021-02-10 02:57:27 -06:00
config Add Configurations repo info to config/README.md (#19583) 2020-10-02 17:16:55 -05:00
data/www Fresh Web GUI (based on bootstrap.js) (#19812) 2020-10-21 13:51:14 -05:00
docker Local testing via Makefile & Docker (#19981) 2020-11-17 20:04:28 -06:00
docs Serial refactor. Default 8-bit ECHO to int, not char (#20985) 2021-02-08 00:37:24 -06:00
Marlin Improved Ender 3 V2 display status area (#20983) 2021-02-12 04:55:06 -06:00
.editorconfig Add .editorconfig file 2020-02-08 17:43:25 -06:00
.gitattributes .bin and .woff are binary 2020-10-29 00:49:18 -05:00
.gitignore Swedish language for MarlinUI (#20826) 2021-01-19 16:52:04 -06:00
docker-compose.yml Local testing via Makefile & Docker (#19981) 2020-11-17 20:04:28 -06:00
get_test_targets.py Balance CI tests (#20485) 2020-12-17 06:18:07 -06:00
LICENSE Update more external links (#18819) 2020-07-28 01:04:44 -05:00
Makefile Trust that script -x flags will always be set (#20453) 2020-12-14 21:02:46 -06:00
platformio.ini Fix TEMP_0_TR_ENABLE, rename temp conditions (#21016) 2021-02-07 16:58:06 -06:00
process-palette.json Update auto_build.py paths for Atom/Sublime 2020-01-11 19:28:41 -06:00
README.md Local testing via Makefile & Docker (#19981) 2020-11-17 20:04:28 -06:00

Marlin 3D Printer Firmware

GitHub GitHub contributors GitHub Release Date Build Status

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

AVR (8-bit)

board processor speed flash sram logic fpu
Arduino AVR ATmega, ATTiny, etc. 16-20MHz 64-256k 2-16k 5V no

DUE

boards processor speed flash sram logic fpu
Arduino Due, RAMPS-FD, etc. SAM3X8E ARM-Cortex M3 84MHz 512k 64+32k 3.3V no

ESP32

board processor speed flash sram logic fpu
ESP32 Tensilica Xtensa LX6 160-240MHz variants --- --- 3.3V ---

LPC1768 / LPC1769

boards processor speed flash sram logic fpu
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

SAMD51

boards processor speed flash sram logic fpu
Adafruit Grand Central M4 SAMD51P20A ARM-Cortex M4 120MHz 1M 256k 3.3V yes

STM32F1

boards processor speed flash sram logic fpu
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

STM32F4

boards processor speed flash sram logic fpu
STEVAL-3DP001V1 STM32F401VE Arm-Cortex M4 84MHz 512k 64+32k 3.3-5V yes

Teensy++ 2.0

boards processor speed flash sram logic fpu
Teensy++ 2.0 AT90USB1286 16MHz 128k 8k 5V no

Teensy 3.1 / 3.2

boards processor speed flash sram logic fpu
Teensy 3.2 MK20DX256VLH7 ARM-Cortex M4 72MHz 256k 32k 3.3V-5V yes

Teensy 3.5 / 3.6

boards processor speed flash sram logic fpu
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

boards processor speed flash sram logic fpu
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

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 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/tests and 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-all-local or make tests-single-local TEST_TARGET=....
    • If you prefer Docker you can use make tests-all-local-docker or make tests-all-local-docker TEST_TARGET=....

RepRap.org Wiki Page

Credits

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.