wp
/
Marlin-Ai3M
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Update README.md

This commit is contained in:
Marco Nieddu 2019-02-20 13:34:17 +01:00 committed by GitHub
parent 3425080a63
commit e90426d892
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 48 additions and 256 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

304
README.md
View File

@ -1,25 +1,19 @@
# Anycubic i3 Mega Marlin 1.1.9 by davidramiro
# Anycubic i3 Mega Marlin (BLTouch) 1.1.9 by davidramiro & MNieddu91
[![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=3MFT8QMP5ZRCE&source=url) [![Downloads](https://img.shields.io/github/downloads/davidramiro/Marlin-AI3M/total.svg?style=flat)](https://github.com/davidramiro/Marlin-AI3M/releases) [![Open Issues](https://img.shields.io/github/issues-raw/davidramiro/Marlin-AI3M.svg?style=flat)](https://github.com/davidramiro/Marlin-AI3M/issues?q=is%3Aopen+is%3Aissue) [![Closed Issues](https://img.shields.io/github/issues-closed-raw/davidramiro/Marlin-AI3M.svg?style=flat)](https://github.com/davidramiro/Marlin-AI3M/issues?q=is%3Aissue+is%3Aclosed) [![License](https://img.shields.io/github/license/davidramiro/Marlin-AI3M.svg?style=flat)](https://github.com/davidramiro/Marlin-AI3M/blob/master/LICENSE) [![Latest Release](https://img.shields.io/github/release/davidramiro/Marlin-AI3m.svg?style=flat)](https://github.com/davidramiro/Marlin-AI3M/releases/latest/) ![](https://img.shields.io/github/last-commit/davidramiro/Marlin-AI3m.svg?style=flat)
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), [davidramiros's repo](https://github.com/davidramiro/Marlin-AI3M) and [DerDomink's repo](https://github.com/DerDominik/Marlin-AnycubicI3Mega-BLTouch).
This version is a simply 1-to-1 copy of [davidramiros's](https://github.com/davidramiro/Marlin-AI3M) with the necessary changes that **BLTouch or any clone can be used.**
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.
Feel free to discuss issues and work with davidramiro and me further optimizing this firmware!
Feel free to discuss issues and work with me further optimizing this firmware!
I am running this version on an Anycubic Mega-S (for distinction of the different versions, check [this Thingiverse thread](https://www.thingiverse.com/groups/anycubic-i3-mega/forums/general/topic:27064)).
Basically, this works on every Ultrabase version that has two Z-axis endstops. For i3 Mega with single endstop check [davidramiros's Wiki] https://github.com/davidramiro/Marlin-AI3M/wiki/Customization-&-Compiling#single-z-endstop). By default it is designed to work on i3 Mega. New Mega-S works too, but calibrating your extruder is mandatory since it needs to have increased E-steps, see the instructions below.
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)).
Basically, this should work on every Ultrabase version that has two Z-axis endstops.
All about a highly recommended calibration according to the instructions can be found in [davidramiro's Wiki](https://github.com/davidramiro/Marlin-AI3M/wiki/Extruder-Calibration/).
You can find everything you need to set up and calibrate the BLTouch in my [Wiki](https://github.com/MNieddu91/Marlin-AI3M-BLTouch/wiki).
The new Mega-S should work too, but you will need to enter those two commands to make the new extruder work:
```
M92 E384
M500
```
Afterwards, calibration is highly recommended as per the instructions on the [Wiki](https://github.com/davidramiro/Marlin-AI3M/wiki/Extruder-Calibration/).
Note: This is just a firmware, not magic. A big part of print quality still depends on your slicer settings and mechanical condition of your machine.
#### Make sure to take a look at the [Wiki](https://github.com/davidramiro/Marlin-AI3M/wiki/), especially the [FAQ](https://github.com/davidramiro/Marlin-AI3M/wiki/Frequently-Asked-Questions).
Note: This is just a firmware, not magic. A big part of print quality still depends on your slicer settings and mechanical condition of your machine. Since I have reduced the acceleration and jerk settings a bit, depending on your slicer the estimated print time might be around 20% lower. You can compensate that loss of speed by raising the general print speed without losing quality.
#### Make sure to take a look at the [Wiki](https://github.com/MNieddu91/Marlin-AI3M-BLTouch/wiki)!
## Known issues:
@ -29,43 +23,29 @@ Note: This is just a firmware, not magic. A big part of print quality still depe
**Important note: On the SD card that comes with the printer there is a folder with Chinese characters in it by default. Please rename or remove it.**
- Cancelling prints via display is buggy sometimes, simply reboot the printer when the menu shows an error. Protip: Switch to OctoPrint.
## Why use this?
While the i3 Mega is a great printer for its price and produces fantastic results in stock, there are some issues that are easily addressed:
You always wanted to use davidramiro's fantastic [firmware](https://github.com/davidramiro/Marlin-AI3M/), but didn't want to miss out on the advantages of Automatic Bed Leveling with BLTouch? - Then you've come to the right place!
I'm working together with davidramiro on this FW and you'll always find the latest version of his FW with the necessary adjustments for BLTouch here. No further changes, just his great firmware with support for BLtouch.
- Many people have issues getting the Ultrabase leveled perfectly, using Manual Mesh Bed Leveling the printer generates a mesh of the flatness of the bed and compensates for it on the Z-axis for perfect prints without having to level with the screws.
- Much more efficient bed heating by using PID control. This uses less power and holds the temperature at a steady level. Highly recommended for printing ABS.
- 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.
- Even better print quality by adding Linear Advance, S-Curve Acceleration and some tweaks on jerk and acceleration.
- Thermal runaway protection: Reducing fire risk by detecting a faulty or misaligned thermistor.
- 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.
- No need to slice and upload custom bed leveling tests, simply start one with a simple G26 command.
- Easily start an auto PID tune or mesh bed leveling via the special menu (insert SD card, select special menu and press the round arrow)
- Filament change feature enabled: Switch colors/material mid print with `M600` (instructions below)
## Are there pre-compiled firmware files?
## How to flash this?
No!
I have decided **NOT** to provide precompiled hex files. Due to various settings which are necessary for the use of a BLTouch, this does not make sense and can only lead to problems.
However, it is not difficult to compile the firmware yourself :-)
I provided three different precompiled hex files: One for no modifications on the stepper motor drivers - good for people who didn't touch anything yet, one for boards with TMC2208 installed and where the connectors have been flipped and one with TMC2208 and the connectors in original orientation.
## Which changes are necessary?
### Choose your precompiled hex:
**I'll describe the necessary changes for using at least BLTouch in the Wiki.**
- Download the precompiled firmware here: [Releases](https://github.com/davidramiro/Marlin-AI3M/releases)
- Choose the correct hex file:
- For TMC2208 with connectors in original orientation, use `Marlin-AI3M-XXXXXX-TMC2208.hex`
- If you use TMC2208 and already reversed your connectors, use `Marlin-AI3M-XXXXXX-TMC2208_reversed.hex`
- If you use a newer version of the TMC2208 that doesn't require the connector to be reversed (TMC2208 "v2.0" written on the PCB, chip on the top side), please also use `Marlin-AI3M-XXXXXX-TMC2208_reversed.hex`.
- If you use the original stepper motor drivers, use `Marlin-AI3M-XXXXXX-stock_drivers.hex`.
### Or compile it yourself:
### Compile it yourself:
- Download Arduino IDE
- Clone or download this repo
- In the IDE, under `Tools -> Board` select `Genuino Mega 2560` and `ATmega2560`
- Open Marlin.ino in the Marlin directory of this repo
- [Customize if needed](https://github.com/davidramiro/Marlin-AI3M/wiki/Customization-&-Compiling) (e.g. motor directions and type at line `559` to `566` and line `857` to `865` in `Configuration.h`)
- Under `Sketch`, select `Export compiled binary`
- Look for the .hex file in the Marlin directory (only use the `Marlin.ino.hex`, not the `Marlin.ino.with_bootloader.hex`!)
- Customize if needed and under `Sketch`, select `Export compiled binary`
- Look for the .hex file in your temporary directory, e.g. `.../AppData/Local/Temp/arduino_build_xxx/` (only the `Marlin.ino.hex`, not the `Marlin.ino.with_bootloader.hex`!)
### After obtaining the hex file:
@ -75,12 +55,22 @@ I provided three different precompiled hex files: One for no modifications on th
- `M502` - load hard coded default values
- `M500` - save them to EEPROM
#### Calibration and other instructions have been moved to the [Wiki](https://github.com/davidramiro/Marlin-AI3M/wiki/Calibration).
## Calibration & Tuning
### Automatic Bed Leveling
## Manual Mesh Bed Leveling
You have 2 options for Automatic Bed Leveling.
If you have issues with an uneven bed, this is a great feature.
## Option 1 - Automatic Bed Leveling before every print
- Simply go into your slicer settings and look for the start GCode
- Look for the Z-homing (either just `G28` or `G28 Z0`) command and insert this command right underneath it:
```
G29
```
- Enjoy never having to worry about an uneven bed again!
## Option 2 - Automatic Bed Leveling via Special Menu
- Insert an SD card, enter the print menu.
- Enter the special menu by selecting it and pressing the round arrow:
@ -93,41 +83,28 @@ If you have issues with an uneven bed, this is a great feature.
![Preheat bed][preheat]
- Level your preheated bed as well as you can with the four screws.
- Start the mesh leveling:
**- At this point make sure you have all setted up right as described in the [Wiki](https://github.com/MNieddu91/Marlin-AI3M-BLTouch/wiki)**
- Start the Auto Bed Leveling:
![Start MMBL][start]
- Your nozzle will now move to the first calibration position.
- Don't adjust the bed itself with screws, only use software from here on!
- Use a paper - I recommend using thermopaper like a receipt or baking paper
- Use the onscreen controls to lower or raise your nozzle until you feel a light resistance: (If you want to send the same command multiple times, select the item again, even though it is still marked red.)
![Z axis controls][control]
- Once finished , move to the next point:
![Next mesh point][next]
- Repeat the last two steps until all 25 points are done.
- Your printer will beep, wait 20 seconds and then save:
![Start Auto Bed Leveling][start]
- Your Heatbed will now be levelled automatically.
- Once finished (Nozzle will park in the rear right corner).
- Wait 20 seconds and then save:
![Save to EEPROM][save]
- Reboot your printer.
[menu]: https://kore.cc/i3mega/download/blt/images/readme/menu.jpg "Special Menu"
[preheat]: https://kore.cc/i3mega/download/blt/images/readme/preheat.jpg "Preheat 60C"
[start]: https://kore.cc/i3mega/download/blt/images/readme/start.jpg "Start Auto leveling"
[save]: https://kore.cc/i3mega/download/blt/images/readme/save.jpg "Save to EEPROM"
[menu]: https://kore.cc/i3mega/mmbl/menu.jpg "Special Menu"
[preheat]: https://kore.cc/i3mega/mmbl/preheat.jpg "Preheat 60C"
[start]: https://kore.cc/i3mega/mmbl/start.jpg "Start Mesh leveling"
[next]: https://kore.cc/i3mega/mmbl/next.jpg "Next Mesh point"
[control]: https://kore.cc/i3mega/mmbl/control.jpg "Z axis control"
[save]: https://kore.cc/i3mega/mmbl/save.jpg "Save to EEPROM"
### After leveling:
#### After leveling:
- Reboot the printer.
- To ensure your mesh gets used on every print from now on, go into your slicer settings and look for the start GCode
- To ensure your levelling gets used on every print from now on, go into your slicer settings and look for the start GCode
- Look for the Z-homing (either just `G28` or `G28 Z0`) command and insert these two right underneath it:
```
M501
@ -136,192 +113,7 @@ M420 S1
- Enjoy never having to worry about an uneven bed again!
#### Manual commands for use with OctoPrint etc.:
- `G29 S1` - Start MMBL
- `G29 S2` - Next Mesh point
- Raising Z: `G91`, `G1 Z0.02`, `G90` (one after another, not in one line)
- Lowering Z: `G91`, `G1 Z-0.02`, `G90`
- After seeing `ok` in the console, send `M500` to save.
### Testing your bed leveling
- No need to download or create a bed leveling test, simply send those commands to your printer:
```
G28
G26 C H200 P25 R25
```
- To adjust your filament's needed temperature, change the number of the `H` parameter
- If your leveling is good, you will have a complete pattern of your mesh on your bed that you can peel off in one piece
- Don't worry if the test looks a bit messy, the important thing is just that the line width is the same all over the mesh
- Optional: Hang it up on a wall to display it as a trophy of how great your leveling skills are.
## M600 Filament Change
![M600 Demo][m600 demo]
[m600 demo]: https://kore.cc/i3mega/img/m600demo.jpg "M600 demo"
**Printing via USB is highly recommended for this.**
#### Configuration:
- Send `M603 L0 U0` to use manual loading & unloading.
- Send `M603 L538 U555` to use automatic loading & unloading
- Save with `M500`
#### Filament change process (manual loading):
- For printing via SD:
- Place `M600` in your GCode at the desired layer
- For printing via USB:
- Place `M600` in your GCode at the desired layer or send it via terminal
- Alternatively: Use `FilamentChange Pause` in the Special Menu
- The nozzle will park and your printer will beep
- Remove the filament from the bowden tube
- Insert the new filament right up to the nozzle, just until a bit of plastic oozes out
- Remove the excess filament from the nozzle with tweezers
- For printing via SD:
- Click `CONTINUE` on the screen
- For printing via USB:
- Send `M108` via your USB host or use `FilamentChange Resume` in the Special Menu
- Note for OctoPrint users: After sending `M108`, enable the advanced options at the bottom of the terminal and press `Fake Acknowledgement`
#### Filament change process (automatic loading):
- For printing via SD:
- Place `M600` in your GCode at the desired layer
- For printing via USB:
- Place `M600` in your GCode at the desired layer or send it via terminal
- Alternatively: Use `FilamentChange Pause` in the Special Menu
- The nozzle will park
- The printer will remove the filament right up to the extruder and beep when finished
- Insert the new filament just up to the end of the bowden fitting, as shown here:
![Load Filament][m600 load]
[m600 load]: https://kore.cc/i3mega/img/load.jpg "M600 Load"
- For printing via SD:
- Click `CONTINUE` on the screen
- For printing via USB:
- Send `M108` via your USB host or use `FilamentChange Resume` in the Special Menu
- Note for OctoPrint users: After sending `M108`, enable the advanced options at the bottom of the terminal and press `Fake Acknowledgement`
- The printer will now pull in the new filament, watch out since it might ooze quite a bit from the nozzle
- Remove the excess filament from the nozzle with tweezers
## Updating
### Back up & restore your settings
Some updates require the storage to be cleared (`M502`), if mentioned in the update log. In those cases, before updating, send `M503` and make a backup of all the lines starting with:
```
M92
G29
M301
M304
```
After flashing the new version, issue a `M502` and `M500`. After that, enter every line you saved before and finish by saving with `M500`.
## Detailed changes:
- Thermal runaway protection enabled and tweaked
- Manual mesh bed leveling enabled ([check this link](https://github.com/MarlinFirmware/Marlin/wiki/Manual-Mesh-Bed-Leveling) to learn more about it)
- Heatbed PID mode enabled
- TMC2208 configured in standalone mode
- Stepper orientation flipped (you don't have to flip the connectors on the board anymore)
- Linear advance unlocked (Off by default. [Research, calibrate](http://marlinfw.org/docs/features/lin_advance.html) and then enable with `M900 Kx`)
- S-Curve Acceleration enabled
- G26 Mesh Validation enabled
- Some redundant code removed to save memory
- Minor tweaks on default jerk and acceleration
- Printcounter enabled (`M78`)
- `M600` filament change feature enabled
## Changes by [derhopp](https://github.com/derhopp/):
- 12V capability on FAN0 (parts cooling fan) enabled
- Buzzer disabled (e.g. startup beep)
- Subdirectory support: Press the round arrow after selecting a directory
- Special menu in the SD file menu: Press the round arrow after selecting `Special menu`
## 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.
- Automatic Bed Leveling (BLTouch) enabled ([check this link](http://marlinfw.org/docs/features/auto_bed_leveling.html) to learn more about it)
- The rest are the identical changes as in [davidramiro's changes](https://github.com/davidramiro/Marlin-AI3M#detailed-changes)