|
|
@@ -1,74 +1,71 @@
|
|
1
|
1
|
# Marlin 3D Printer Firmware
|
|
2
|
2
|
|
|
3
|
|
-[](https://travis-ci.org/MarlinFirmware/Marlin)
|
|
|
3
|
+[](https://travis-ci.org/MarlinFirmware/Marlin)
|
|
4
|
4
|
|
|
5
|
5
|
|
|
6
|
6
|
|
|
7
|
7
|
|
|
8
|
|
-<img align="top" width=175 src="buildroot/share/pixmaps/logo/marlin-250.png" />
|
|
|
8
|
+<img align="right" width=175 src="buildroot/share/pixmaps/logo/marlin-250.png" />
|
|
9
|
9
|
|
|
10
|
10
|
Additional documentation can be found at the [Marlin Home Page](http://marlinfw.org/).
|
|
11
|
|
-Please test this firmware and let us know if it misbehaves in any way. Volunteers are standing by!
|
|
|
11
|
+Please let us know if Marlin misbehaves in any way. Volunteers are standing by!
|
|
12
|
12
|
|
|
13
|
|
-## Marlin 2.0 Bugfix Branch
|
|
14
|
|
-
|
|
15
|
|
-__Not for production use. Use with caution!__
|
|
|
13
|
+## Marlin 2.0
|
|
16
|
14
|
|
|
17
|
15
|
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.
|
|
18
|
16
|
|
|
19
|
|
-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.
|
|
20
|
|
-
|
|
21
|
17
|
Download earlier versions of Marlin on the [Releases page](https://github.com/MarlinFirmware/Marlin/releases).
|
|
22
|
18
|
|
|
23
|
19
|
## Building Marlin 2.0
|
|
24
|
20
|
|
|
25
|
|
-To build Marlin 2.0 you'll need [Arduino IDE 1.8.8 or newer](https://www.arduino.cc/en/main/software) or [PlatformIO](http://docs.platformio.org/en/latest/ide.html#platformio-ide). We've posted detailed instructions on [Building Marlin with Arduino](http://marlinfw.org/docs/basics/install_arduino.html) and [Building Marlin with PlatformIO for ReArm](http://marlinfw.org/docs/basics/install_rearm.html) (which applies well to other 32-bit boards).
|
|
26
|
|
-
|
|
27
|
|
-## Hardware Abstraction Layer (HAL)
|
|
28
|
|
-
|
|
29
|
|
-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.
|
|
30
|
|
-
|
|
31
|
|
-### Current HALs
|
|
|
21
|
+To build Marlin 2.0 you'll need [Arduino IDE 1.8.8 or newer](https://www.arduino.cc/en/main/software) or [PlatformIO](http://docs.platformio.org/en/latest/ide.html#platformio-ide). Detailed build and install instructions are posted at:
|
|
32
|
22
|
|
|
33
|
|
- name|processor|speed|flash|sram|logic|fpu
|
|
34
|
|
- ----|---------|-----|-----|----|-----|---
|
|
35
|
|
- [Arduino AVR](https://www.arduino.cc/)|ATmega, ATTiny, etc.|16-20MHz|64-256k|2-16k|5V|no
|
|
36
|
|
- [Teensy++ 2.0](http://www.microchip.com/wwwproducts/en/AT90USB1286)|[AT90USB1286](http://www.microchip.com/wwwproducts/en/AT90USB1286)|16MHz|128k|8k|5V|no
|
|
37
|
|
- [Arduino STM32](https://github.com/rogerclarkmelbourne/Arduino_STM32)|[STM32F1](https://www.st.com/en/microcontrollers-microprocessors/stm32f103.html) ARM-Cortex M3|72MHz|256-512k|48-64k|3.3V|no
|
|
38
|
|
- [Due](https://www.arduino.cc/en/Guide/ArduinoDue), [RAMPS-FD](http://www.reprap.org/wiki/RAMPS-FD), etc.|[SAM3X8E ARM-Cortex M3](http://www.microchip.com/wwwproducts/en/ATsam3x8e)|84MHz|512k|64+32k|3.3V|no
|
|
39
|
|
- [Re-ARM](https://www.kickstarter.com/projects/1245051645/re-arm-for-ramps-simple-32-bit-upgrade)|[LPC1768 ARM-Cortex M3](http://www.nxp.com/products/microcontrollers-and-processors/arm-based-processors-and-mcus/lpc-cortex-m-mcus/lpc1700-cortex-m3/512kb-flash-64kb-sram-ethernet-usb-lqfp100-package:LPC1768FBD100)|100MHz|512k|32+16+16k|3.3-5V|no
|
|
40
|
|
- [MKS SBASE](http://forums.reprap.org/read.php?13,499322)|LPC1768 ARM-Cortex M3|100MHz|512k|32+16+16k|3.3-5V|no
|
|
41
|
|
- [Azteeg X5 GT](https://www.panucatt.com/azteeg_X5_GT_reprap_3d_printer_controller_p/ax5gt.htm)|LPC1769 ARM-Cortex M3|120MHz|512k|32+16+16k|3.3-5V|no
|
|
42
|
|
- [Selena Compact](https://github.com/Ales2-k/Selena)|LPC1768 ARM-Cortex M3|100MHz|512k|32+16+16k|3.3-5V|no
|
|
43
|
|
- [Teensy 3.5](https://www.pjrc.com/store/teensy35.html)|ARM-Cortex M4|120MHz|512k|192k|3.3-5V|yes
|
|
44
|
|
- [Teensy 3.6](https://www.pjrc.com/store/teensy36.html)|ARM-Cortex M4|180MHz|1M|256k|3.3V|yes
|
|
|
23
|
+ - [Installing Marlin (Arduino)](http://marlinfw.org/docs/basics/install_arduino.html)
|
|
|
24
|
+ - [Installing Marlin (VSCode)](http://marlinfw.org/docs/basics/install_platformio_vscode.html).
|
|
45
|
25
|
|
|
46
|
|
-### HALs in Development
|
|
|
26
|
+### Supported Platforms
|
|
47
|
27
|
|
|
48
|
|
- name|processor|speed|flash|sram|logic|fpu
|
|
49
|
|
- ----|---------|-----|-----|----|-----|---
|
|
50
|
|
- [STEVAL-3DP001V1](http://www.st.com/en/evaluation-tools/steval-3dp001v1.html)|[STM32F401VE Arm-Cortex M4](http://www.st.com/en/microcontrollers/stm32f401ve.html)|84MHz|512k|64+32k|3.3-5V|yes
|
|
51
|
|
- [Smoothieboard](http://reprap.org/wiki/Smoothieboard)|LPC1769 ARM-Cortex M3|120MHz|512k|64k|3.3-5V|no
|
|
52
|
|
- [Adafruit Grand Central M4](https://www.adafruit.com/product/4064)|[SAMD51P20A ARM-Cortex M4](https://www.microchip.com/wwwproducts/en/ATSAMD51P20A)|120MHz|1M|256k|3.3V|yes
|
|
|
28
|
+ Platform|MCU|Example Boards
|
|
|
29
|
+ --------|---|-------
|
|
|
30
|
+ [Arduino AVR](https://www.arduino.cc/)|ATmega|RAMPS, Melzi, RAMBo
|
|
|
31
|
+ [Teensy++ 2.0](http://www.microchip.com/wwwproducts/en/AT90USB1286)|AT90USB1286|Printrboard
|
|
|
32
|
+ [Arduino Due](https://www.arduino.cc/en/Guide/ArduinoDue)|SAM3X8E|RAMPS-FD, RADDS, RAMPS4DUE
|
|
|
33
|
+ [LPC1768](http://www.nxp.com/products/microcontrollers-and-processors/arm-based-processors-and-mcus/lpc-cortex-m-mcus/lpc1700-cortex-m3/512kb-flash-64kb-sram-ethernet-usb-lqfp100-package:LPC1768FBD100)|ARM® Cortex-M3|MKS SBASE, Re-ARM, Selena Compact
|
|
|
34
|
+ [LPC1769](https://www.nxp.com/products/processors-and-microcontrollers/arm-microcontrollers/general-purpose-mcus/lpc1700-cortex-m3/512kb-flash-64kb-sram-ethernet-usb-lqfp100-package:LPC1769FBD100)|ARM® Cortex-M3|Smoothieboard, Azteeg X5 mini, TH3D EZBoard
|
|
|
35
|
+ [STM32F103](https://www.st.com/en/microcontrollers-microprocessors/stm32f103.html)|ARM® Cortex-M3|Malyan M200, GTM32 Pro, MKS Robin, BTT SKR Mini
|
|
|
36
|
+ [STM32F401](https://www.st.com/en/microcontrollers-microprocessors/stm32f401.html)|ARM® Cortex-M4|ARMED, Rumba32, SKR Pro, Lerdge, FYSETC S6
|
|
|
37
|
+ [STM32F7x6](https://www.st.com/en/microcontrollers-microprocessors/stm32f7x6.html)|ARM® Cortex-M7|The Borg, RemRam V1
|
|
|
38
|
+ [SAMD51P20A](https://www.adafruit.com/product/4064)|ARM® Cortex-M4|Adafruit Grand Central M4
|
|
|
39
|
+ [Teensy 3.5](https://www.pjrc.com/store/teensy35.html)|ARM® Cortex-M4|
|
|
|
40
|
+ [Teensy 3.6](https://www.pjrc.com/store/teensy36.html)|ARM® Cortex-M4|
|
|
53
|
41
|
|
|
54
|
|
-## Submitting Patches
|
|
|
42
|
+## Submitting Changes
|
|
55
|
43
|
|
|
56
|
|
-Proposed patches should be submitted as a Pull Request against the ([bugfix-2.0.x](https://github.com/MarlinFirmware/Marlin/tree/bugfix-2.0.x)) branch.
|
|
57
|
|
-
|
|
58
|
|
-- This branch is for fixing bugs and integrating any new features for the duration of the Marlin 2.0.x life-cycle.
|
|
|
44
|
+- Submit **Bug Fixes** as Pull Requests to the ([bugfix-2.0.x](https://github.com/MarlinFirmware/Marlin/tree/bugfix-2.0.x)) branch.
|
|
|
45
|
+- Submit **New Features** to the ([dev-2.1.x](https://github.com/MarlinFirmware/Marlin/tree/dev-2.1.x)) branch.
|
|
59
|
46
|
- Follow the [Coding Standards](http://marlinfw.org/docs/development/coding_standards.html) to gain points with the maintainers.
|
|
60
|
47
|
- Please submit your questions and concerns to the [Issue Queue](https://github.com/MarlinFirmware/Marlin/issues).
|
|
61
|
48
|
|
|
62
|
|
-### [RepRap.org Wiki Page](http://reprap.org/wiki/Marlin)
|
|
|
49
|
+## Marlin Support
|
|
|
50
|
+
|
|
|
51
|
+For best results getting help with configuration and troubleshooting, please use the following resources:
|
|
|
52
|
+
|
|
|
53
|
+- [Marlin Documentation](http://marlinfw.org) - Official Marlin documentation
|
|
|
54
|
+- [Marlin Discord](https://discord.gg/n5NJ59y) - Discuss issues with Marlin users and developers
|
|
|
55
|
+- Facebook Group ["Marlin Firmware"](https://www.facebook.com/groups/1049718498464482/)
|
|
|
56
|
+- RepRap.org [Marlin Forum](http://forums.reprap.org/list.php?415)
|
|
|
57
|
+- [Tom's 3D Forums](https://discuss.toms3d.org/)
|
|
|
58
|
+- Facebook Group ["Marlin Firmware for 3D Printers"](https://www.facebook.com/groups/3Dtechtalk/)
|
|
|
59
|
+- [Marlin Configuration](https://www.youtube.com/results?search_query=marlin+configuration) on YouTube
|
|
63
|
60
|
|
|
64
|
61
|
## Credits
|
|
65
|
62
|
|
|
66
|
63
|
The current Marlin dev team consists of:
|
|
67
|
64
|
|
|
68
|
|
- - Scott Lahteine [[@thinkyhead](https://github.com/thinkyhead)] - USA [](https://flattr.com/submit/auto?user_id=thinkyhead&url=https://github.com/MarlinFirmware/Marlin&title=Marlin&language=&tags=github&category=software)
|
|
|
65
|
+ - Scott Lahteine [[@thinkyhead](https://github.com/thinkyhead)] - USA [Donate](http://www.thinkyhead.com/donate-to-marlin) / Flattr: [](https://flattr.com/submit/auto?user_id=thinkyhead&url=https://github.com/MarlinFirmware/Marlin&title=Marlin&language=&tags=github&category=software)
|
|
69
|
66
|
- Roxanne Neufeld [[@Roxy-3D](https://github.com/Roxy-3D)] - USA
|
|
70
|
|
- - Bob Kuhn [[@Bob-the-Kuhn](https://github.com/Bob-the-Kuhn)] - USA
|
|
71
|
67
|
- Chris Pepper [[@p3p](https://github.com/p3p)] - UK
|
|
|
68
|
+ - Bob Kuhn [[@Bob-the-Kuhn](https://github.com/Bob-the-Kuhn)] - USA
|
|
72
|
69
|
- João Brazio [[@jbrazio](https://github.com/jbrazio)] - Portugal
|
|
73
|
70
|
- Erik van der Zalm [[@ErikZalm](https://github.com/ErikZalm)] - Netherlands [](https://flattr.com/submit/auto?user_id=ErikZalm&url=https://github.com/MarlinFirmware/Marlin&title=Marlin&language=&tags=github&category=software)
|
|
74
|
71
|
|
Scott Lahteine
4 years ago