Update README.md
This commit is contained in:
InsanityAutomation
@@ -1,69 +1,63 @@
|
||||
# Marlin 3D Printer Firmware
|
||||
#Creality CR10SPro, CR-X, CR10 Max, and Ender 5 Plus touchscreen supported Firmware
|
||||
|
||||
[](https://travis-ci.org/MarlinFirmware/Marlin)
|
||||
|
||||
|
||||
|
||||
The firmware branches maintained here are made possible by the support of sponsors like [[Tiny Machines 3D](https://tinymachines3d.com/)] as well as our customer base through 3D printing services. If you would like to support continued development, please consider you’re next machine purchase from Tiny Machines and thank them for supporting open source development or consider ordering anything outside you’re own machines capabilities through us! Maintaining and developing these branches takes a signifigant investment of both time and money (parts and machines). If you dont need anything printed or any additional machines, you can also support us through Patreon here – [[https://www.patreon.com/InsanityAutomation](https://www.patreon.com/InsanityAutomation)]
|
||||
|
||||
<img align="top" width=175 src="buildroot/share/pixmaps/logo/marlin-250.png" />
|
||||
#Creality Firmware Branches
|
||||
- 1.1.9 Firmware (Stable, EOL) [[TM_CR10](https://github.com/InsanityAutomation/Marlin/tree/TM_CR10)]
|
||||
- 2.0 Firmware (Beta, but well tested) [[Creality_Marlin2.0.x](https://github.com/InsanityAutomation/Marlin/tree/Creality_Marlin2.0.x)]
|
||||
- 2.0 Development Branch [[Creality_2.0_Devel](https://github.com/InsanityAutomation/Marlin/tree/Creality_2.0_Devel)]
|
||||
- Touchscreen Firmware (10SPro and CR-X 1.1.9 Stable) [[Creality_DWINTest](https://github.com/InsanityAutomation/Marlin/tree/Creality_DWINTest)]
|
||||
- Touchscreen Firmware (10SPro and CR-X 2.0 Active Development) [[CrealityDwin_2.0](https://github.com/InsanityAutomation/Marlin/tree/CrealityDwin_2.0)]
|
||||
#Formbot / Vivedino Firmware Branches
|
||||
- Raptor 1 1.1.9 Firmware [[TM_Raptor](https://github.com/InsanityAutomation/Marlin/tree/TM_Raptor)]
|
||||
- Raptor 1/2 2.0 Firmware [[Raptor_2.0.X](https://github.com/InsanityAutomation/Marlin/tree/Raptor_2.0.X)]
|
||||
- Trex 2+/3 1.1.9 Firmware [[Trex3_1.1.9](https://github.com/InsanityAutomation/Marlin/tree/Trex3_1.1.9)]
|
||||
- Trex 2+/3 2.0 Firmware (Be warned of layer shift issue below!) [[TM_Trex2+_2.0.x(https://github.com/InsanityAutomation/Marlin/tree/TM_Trex2+_2.0.x)]
|
||||
#Mamorubot / HieHa Firmware Branches
|
||||
- SX4 1.1.9 Firmware (Stable, EOL) [[Mamorubot_SX4]( https://github.com/InsanityAutomation/Marlin/tree/Mamorubot_SX4)]
|
||||
- SX4 2.0 Firmware (Beta, but well tested) [[TM_SX4_2.0](https://github.com/InsanityAutomation/Marlin/tree/TM_SX4_2.0)]
|
||||
- SX4 Development Branch [[TM_SX4_2.0_Devel](https://github.com/InsanityAutomation/Marlin/tree/TM_SX4_2.0_Devel)]
|
||||
#Other Firmware
|
||||
- Raise 3D N2+ (Dual) 2.0 [[Raise3D-N2+-Dual](https://github.com/InsanityAutomation/Marlin/tree/Raise3D-N2+-Dual)]
|
||||
|
||||
Additional documentation can be found at the [Marlin Home Page](http://marlinfw.org/).
|
||||
Please test this firmware and let us know if it misbehaves in any way. Volunteers are standing by!
|
||||
[[Marlin Commit History](https://github.com/MarlinFirmware/Marlin/pulls?q=is%3Apr+is%3Aclosed+author%3AInsanityAutomation)]
|
||||
|
||||
## Marlin 2.0 Bugfix Branch
|
||||
#Active Projects
|
||||
- [[Tracing Marlin 2.0 Planner bug causing layer Shifting] (https://github.com/MarlinFirmware/Marlin/issues/12403)]
|
||||
- Creality Dwin Touchscreen rewrite to ExtUI
|
||||
- [[IDEX drifting z offset on tool change with UBL]( https://github.com/MarlinFirmware/Marlin/issues/13817)]
|
||||
- [[Multiple touch homing] (https://github.com/MarlinFirmware/Marlin/issues/9802)]
|
||||
- [[Tool change offset changes] (https://github.com/MarlinFirmware/Marlin/issues/12568)]
|
||||
- [[Hotend offset adjustment clamping] (https://github.com/MarlinFirmware/Marlin/pull/13669)]
|
||||
- [[Filament width sensor hang on 32 bit] (https://github.com/MarlinFirmware/Marlin/issues/13701)]
|
||||
- Probe point output for all leveling types matching incomplete ubl implementation
|
||||
- SKR1.1 Pro integration to Trex2 with TMC2209 Drivers
|
||||
- SKR1.3 Integration to Mamorubot SX4
|
||||
- Mosquito BMG-M integration to Raptor
|
||||
- Porting Chithu Touchscreen board to Marlin 2.0 with ExtUI
|
||||
- Anet A10 Delta STM32F103 board analysis
|
||||
- Smoothing integration and vendor components of Marlin 2.0 (Revision to version.h handling, limit clamping, usability enhancements ect)
|
||||
- Consolidate more probing functions, improve G33/4 and G28/29 handling
|
||||
- Video documentation of firmware branch configuration options and flashing with platformio
|
||||
#Planned Projects
|
||||
- Implement Virtual Tools
|
||||
- Port Duet2 Wifi with Duex5 to Marlin 2.0
|
||||
- Further Gcode Parity with RRF
|
||||
- Extend Host Prompt Support for Power Loss Recovery
|
||||
- Improve native ESP32 web support
|
||||
- Port M425 Auto backlash and offset calibration to IDEX
|
||||
- Integrate 12 stepper LPC1778 PCB to configure ideXY quad head system as well as integrate 3 extruder mixing to IDEX
|
||||
- Video walkthrough of each bed leveling system usage and all functions
|
||||
|
||||
__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](https://github.com/MarlinFirmware/Marlin/releases).
|
||||
#Marlin
|
||||
This is just one of many forks of Marlin. We dont try to bury that behind fancy marketting or anything else. As you can see from the links above, most of the work done here is submitted back to the mainstream Marlin branches. The end goal of every project is to get it to the point where it is merged and maintained there. See marlin resources, including how to contribute to the Marlin Project as well, down below.
|
||||
|
||||
## Building Marlin 2.0
|
||||
|
||||
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).
|
||||
|
||||
## 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](https://www.arduino.cc/)|ATmega, ATTiny, etc.|16-20MHz|64-256k|2-16k|5V|no
|
||||
[Teensy++ 2.0](http://www.microchip.com/wwwproducts/en/AT90USB1286)|[AT90USB1286](http://www.microchip.com/wwwproducts/en/AT90USB1286)|16MHz|128k|8k|5V|no
|
||||
[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
|
||||
[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
|
||||
[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
|
||||
[MKS SBASE](http://forums.reprap.org/read.php?13,499322)|LPC1768 ARM-Cortex M3|100MHz|512k|32+16+16k|3.3-5V|no
|
||||
[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
|
||||
[Selena Compact](https://github.com/Ales2-k/Selena)|LPC1768 ARM-Cortex M3|100MHz|512k|32+16+16k|3.3-5V|no
|
||||
[Teensy 3.5](https://www.pjrc.com/store/teensy35.html)|ARM-Cortex M4|120MHz|512k|192k|3.3-5V|yes
|
||||
[Teensy 3.6](https://www.pjrc.com/store/teensy36.html)|ARM-Cortex M4|180MHz|1M|256k|3.3V|yes
|
||||
|
||||
### HALs in Development
|
||||
|
||||
name|processor|speed|flash|sram|logic|fpu
|
||||
----|---------|-----|-----|----|-----|---
|
||||
[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
|
||||
[Smoothieboard](http://reprap.org/wiki/Smoothieboard)|LPC1769 ARM-Cortex M3|120MHz|512k|64k|3.3-5V|no
|
||||
[Adafruit Grand Central M4](https://www.adafruit.com/product/4064)|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](https://github.com/MarlinFirmware/Marlin/tree/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](http://marlinfw.org/docs/development/coding_standards.html) to gain points with the maintainers.
|
||||
- Please submit your questions and concerns to the [Issue Queue](https://github.com/MarlinFirmware/Marlin/issues).
|
||||
|
||||
### [RepRap.org Wiki Page](http://reprap.org/wiki/Marlin)
|
||||
|
||||
## Credits
|
||||
|
||||
The current Marlin dev team consists of:
|
||||
#The current Marlin dev team consists of:
|
||||
|
||||
- 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)
|
||||
- Roxanne Neufeld [[@Roxy-3D](https://github.com/Roxy-3D)] - USA
|
||||
|
||||
Reference in New Issue
Block a user