Skip to content

Commit c553cb5

Browse files
committed
Keeping old Readme
2 parents c1fca54 + 837a5dc commit c553cb5

File tree

1 file changed

+34
-45
lines changed

1 file changed

+34
-45
lines changed

README.md

+34-45
Original file line numberDiff line numberDiff line change
@@ -1,65 +1,54 @@
1-
# Marlin 3D Printer Firmware
1+
# Marlin 3D Printer Firmware
22

3-
[![Build Status](https://travis-ci.org/MarlinFirmware/Marlin.svg?branch=bugfix-2.0.x)](https://travis-ci.org/MarlinFirmware/Marlin)
4-
![GitHub](https://img.shields.io/github/license/marlinfirmware/marlin.svg)
5-
![GitHub contributors](https://img.shields.io/github/contributors/marlinfirmware/marlin.svg)
6-
![GitHub Release Date](https://img.shields.io/github/release-date/marlinfirmware/marlin.svg)
7-
8-
<img align="top" width=175 src="buildroot/share/pixmaps/logo/marlin-250.png" />
9-
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!
12-
13-
## Marlin 2.0 Bugfix Branch
3+
## Building Marlin 2.0
144

15-
__Not for production use. Use with caution!__
5+
To build Marlin 2.0 you'll need [PlatformIO](http://docs.platformio.org/en/latest/ide.html#platformio-ide). We've posted detailed instructions on [Building Marlin with PlatformIO for ReArm](http://marlinfw.org/docs/basics/install_rearm.html) (which applies well to other 32-bit boards).
166

17-
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.
7+
## Current Target
188

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.
9+
Creality Ender-3 with SKR Mini E3 v1.2 and Creality BLTouch 3.1
2010

21-
Download earlier versions of Marlin on the [Releases page](https://github.com/MarlinFirmware/Marlin/releases).
11+
## Features Enabled
2212

23-
## Building Marlin 2.0
13+
- BLTouch (Bi-Linear Bed Leveling)
14+
- Custom Status Screen (Ender-3 Default)
15+
- Disable Boot Screens
16+
- Disable Info Screen
17+
- Enabled Slim Menus
18+
- Enabled S Curve Acceleration
19+
- Disable ARC Support (Cura does not have arc support anyway)
20+
- Enabled Linear Advance
21+
- Enabled Square Wave Stepping
22+
- Enabled Hybrid Threshold for TMC2209 Stepper Drivers
23+
- Bed Size is 225x225mm
24+
- Enable Menu to Level Bed Corners (and Center)
25+
- Pre-Heat for "Fillament Cold Pull" instead of Pre-heat for ABS
26+
- Fix for EEPROM saving issue
27+
- Using SoftwareSerialM instead to be able to use up-to-date TMCStepper library, instead of BTT outdated TMCStepper library.
2428

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).
29+
## BLTouch Wiring
2630

27-
## Hardware Abstraction Layer (HAL)
31+
I will be updating this picture later to be more clear, the BLTouch Probe cables should go in the Dedicated Probe PIN PC14, not on the Z-Endstop as others suggest.
2832

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.
33+
<img src="https://github.com/damvcoool/Marlin-2.0.x-SKR-Mini-E3-v1.2/blob/master/img/SKR%20Mini%20E3%20v1.2%20-%20Ender%203%20-%20Creality%20BLTouch%203.1%20Wiring.png"/>
3034

31-
### Current HALs
35+
Please note that ANTCLabs cable colors could be differnet.
3236

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
37+
## Binary File is in the BIN Folder
4538

46-
### HALs in Development
39+
Please make sure to go over the configuration of the system before installing this Firmware.
4740

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
41+
4 Flavors, with self explanatory names, BLTouch use a 5x5 grid to probe, and Manual Bed Leveling uses a 3x3 grid.
5342

54-
## Submitting Patches
43+
- [SKR_Mini_E3_v1.2_256K_BLTouch_v3.1](https://github.com/damvcoool/Marlin-2.0.x-SKR-Mini-E3-v1.2/blob/master/bin/SKR_Mini_E3_v1.2_256K_BLTouch_v3.1.bin)
44+
- [SKR_Mini_E3_v1.2_256K_Manual_Bed_Level](https://github.com/damvcoool/Marlin-2.0.x-SKR-Mini-E3-v1.2/blob/master/bin/SKR_Mini_E3_v1.2_256K_Manual_Bed_Level.bin)
5545

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.
46+
Also added created the optional 512k variant
5747

58-
- This branch is for fixing bugs and integrating any new features for the duration of the Marlin 2.0.x life-cycle.
59-
- Follow the [Coding Standards](http://marlinfw.org/docs/development/coding_standards.html) to gain points with the maintainers.
60-
- Please submit your questions and concerns to the [Issue Queue](https://github.com/MarlinFirmware/Marlin/issues).
48+
- [SKR_Mini_E3_v1.2_512K_BLTouch_v3.1](https://github.com/damvcoool/Marlin-2.0.x-SKR-Mini-E3-v1.2/blob/master/bin/SKR_Mini_E3_v1.2_512K_BLTouch_v3.1.bin)
49+
- [SKR_Mini_E3_v1.2_512K_Manual_Bed_Level](https://github.com/damvcoool/Marlin-2.0.x-SKR-Mini-E3-v1.2/blob/master/bin/SKR_Mini_E3_v1.2_512KManual_Bed_Level.bin)
6150

62-
### [RepRap.org Wiki Page](http://reprap.org/wiki/Marlin)
51+
Note: I use SKR_Mini_E3_v1.2_256K_BLTouch_v3.1 on my machine and it's the only firmware I have tested myself.
6352

6453
## Credits
6554

0 commit comments

Comments
 (0)