Marlin-Ai3M/README.md

110 lines
6.7 KiB
Markdown

# Anycubic i3 Mega Marlin Firmware with TFT support
This is my slightly customized version of the [Marlin Firmware](https://github.com/MarlinFirmware/Marlin), gratefully based on [derhopp's repo](https://github.com/derhopp/Marlin-with-Anycubic-i3-Mega-TFT) with his remarkable efforts to get the Anycubic i3 Mega TFT screen to work.
I am running this version on an i3 Mega Ultrabase V3 (for distinction of the different versions, check [this Thingiverse thread](https://www.thingiverse.com/groups/anycubic-i3-mega/forums/general/topic:27064)) with FYSETC TMC2208 V1.2 installed.
Basically, this should work on every Ultrabase version that has no bed leveling sensor and two Z-axis endstops.
#### Why use this?
While the i3 Mega is a great printer for it's price and produces fantastic results in stock, there are some issues that are easily addressed:
- Very loud stock stepper motor drivers, easily replaced by Watterott or FYSETC TMC2208.
-- To do that, you'd usually have to flip the connectors on the board, this is not necessary using this firmware.
- Fairly loud fans, while almost every one of them is easily replaced, the stock FW only gives out 9V instead of 12V on the parts cooling fan so some fans like Noctua don't run like they should. This is fixed in this firmware.
- Thermal runaway protection: Reducing fire risk by detecting a faulty or misaligned thermistor.
## Changes:
- Thermal runaway protection enabled
- TMC2208 configured in standalone mode
- Stepper orientation flipped (you don't have to flip the connectors on the board anymore)
- Some redundant code removed to save memory
- 12V capability on FAN0 (parts cooling fan) enabled
### Additional features by derhopp:
- Subdirectory support: you have to press the round arrow after selecting a directory
- Special menu in the SD file menu: you have to press the round arrow after selecting a special menu item
### Todo:
- [ ] Tweak TMC2208 steps
### About Marlin
<img align="right" src="../../raw/1.1.x/buildroot/share/pixmaps/logo/marlin-250.png" />
Marlin is an optimized firmware for [RepRap 3D printers](http://reprap.org/) based on the [Arduino](https://www.arduino.cc/) platform. First created in 2011 for RepRap and Ultimaker printers, today Marlin drives a majority of the world's most popular 3D printers. Marlin delivers outstanding print quality with unprecedented control over the process.
[![Coverity Scan Build Status](https://scan.coverity.com/projects/2224/badge.svg)](https://scan.coverity.com/projects/2224)
[![Travis Build Status](https://travis-ci.org/MarlinFirmware/Marlin.svg)](https://travis-ci.org/MarlinFirmware/Marlin)
[![Flattr Us!](http://api.flattr.com/button/flattr-badge-large.png)](https://flattr.com/submit/auto?user_id=ErikZalm&url=https://github.com/MarlinFirmware/Marlin&title=Marlin&language=&tags=github&category=software)
### Contributing to Marlin
If you have coding or writing skills you're encouraged to contribute to Marlin. You may also contribute suggestions, feature requests, and bug reports through the Marlin Issue Queue.
Before contributing, please read our [Contributing Guidelines](https://github.com/MarlinFirmware/Marlin/blob/1.1.x/.github/contributing.md) and [Code of Conduct](https://github.com/MarlinFirmware/Marlin/blob/1.1.x/.github/code_of_conduct.md).
### Marlin Resources
- [Marlin Home Page](http://marlinfw.org/) - The latest Marlin documentation.
- [Marlin Releases](https://github.com/MarlinFirmware/Marlin/releases) - All Marlin releases with release notes.
- [RepRap.org Wiki Page](http://reprap.org/wiki/Marlin) - An overview of Marlin and its role in RepRap.
- [Marlin Firmware Forum](http://forums.reprap.org/list.php?415) - Get help with configuration and troubleshooting.
- [Marlin Firmware Facebook group](https://www.facebook.com/groups/1049718498464482) - Help from the community. (Maintained by [@thinkyhead](https://github.com/thinkyhead).)
- [@MarlinFirmware](https://twitter.com/MarlinFirmware) on Twitter - Follow for news, release alerts, and tips. (Maintained by [@thinkyhead](https://github.com/thinkyhead).)
### Credits
Marlin's administrators are:
- Scott Lahteine [[@thinkyhead](https://github.com/thinkyhead)]
- Roxanne Neufeld [[@Roxy-3D](https://github.com/Roxy-3D)]
- Bob Kuhn [[@Bob-the-Kuhn](https://github.com/Bob-the-Kuhn)]
- Erik van der Zalm [[@ErikZalm](https://github.com/ErikZalm)]
Notable contributors include:
- Alexey Shvetsov [[@alexxy](https://github.com/alexxy)]
- Andreas Hardtung [[@AnHardt](https://github.com/AnHardt)]
- Ben Lye [[@benlye](https://github.com/benlye)]
- Bernhard Kubicek [[@bkubicek](https://github.com/bkubicek)]
- Bob Cousins [[@bobc](https://github.com/bobc)]
- Petr Zahradnik [[@clexpert](https://github.com/clexpert)]
- Jochen Groppe [[@CONSULitAS](https://github.com/CONSULitAS)]
- David Braam [[@daid](https://github.com/daid)]
- Eduardo José Tagle [[@ejtagle](https://github.com/ejtagle)]
- Ernesto Martinez [[@emartinez167](https://github.com/emartinez167)]
- Edward Patel [[@epatel](https://github.com/epatel)]
- F. Malpartida [[@fmalpartida](https://github.com/fmalpartida)]
- João Brazio [[@jbrazio](https://github.com/jbrazio)]
- Kai [[@Kaibob2](https://github.com/Kaibob2)]
- Luc Van Daele [[@LVD-AC](https://github.com/LVD-AC)]
- Alberto Cotronei [[@MagoKimbra](https://github.com/MagoKimbra)]
- Marcio Teixeira [[@marcio-ao](https://github.com/marcio-ao)]
- Chris Palmer [[@nophead](https://github.com/nophead)]
- Chris Pepper [[@p3p](https://github.com/p3p)]
- Steeve Spaggi [[@studiodyne](https://github.com/studiodyne)]
- Thomas Moore [[@tcm0116](https://github.com/tcm0116)]
- Teemu Mäntykallio [[@teemuatlut](https://github.com/teemuatlut)]
- Nico Tonnhofer [[@Wurstnase](https://github.com/Wurstnase)]
- [[@android444](https://github.com/android444)]
- [[@bgort](https://github.com/bgort)]
- [[@GMagician](https://github.com/GMagician)]
- [[@Grogyan](https://github.com/Grogyan)]
- [[@maverikou](https://github.com/maverikou)]
- [[@oysteinkrog](https://github.com/oysteinkrog)]
- [[@paclema](https://github.com/paclema)]
- [[@paulusjacobus](https://github.com/paulusjacobus)]
- [[@psavva](https://github.com/psavva)]
- [[@Tannoo](https://github.com/Tannoo)]
- [[@TheSFReader](https://github.com/TheSFReader)]
- ...and many others
## License
Marlin is published under the [GPLv3 license](https://github.com/MarlinFirmware/Marlin/blob/1.0.x/COPYING.md) 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.