thomas
/
marlin
Watch 1
Star 0
Fork 0
Code Issues 0 Pull Requests 0 Releases 0 Wiki Activity
Browse Source

even more format.

Bernhard Kubicek 13 years ago
parent
4687c56f53
commit
6dba34ab0e
1 changed files with 45 additions and 40 deletions
Unified View Show Diff Stats
  1. 45
    40
      README.md

+ 45
- 40
README.md View File

47 
 Differences and additions to the already good Sprinter firmware:
47 
 Differences and additions to the already good Sprinter firmware:
48 
 ================================================================
48 
 ================================================================
49
49
50 
-Look-ahead:
51 
------------
50 
+*Look-ahead:*
51 
+
52 
 Marlin has look-ahead. While sprinter has to break and re-accelerate at each corner,
52 
 Marlin has look-ahead. While sprinter has to break and re-accelerate at each corner,
53 
 lookahead will only decelerate and accelerate to a velocity,
53 
 lookahead will only decelerate and accelerate to a velocity,
54 
 so that the change in vectorial velocity magnitude is less than the xy_jerk_velocity.
54 
 so that the change in vectorial velocity magnitude is less than the xy_jerk_velocity.
55 
 This is only possible, if some future moves are already processed, hence the name.
55 
 This is only possible, if some future moves are already processed, hence the name.
56 
 It leads to less over-deposition at corners, especially at flat angles.
56 
 It leads to less over-deposition at corners, especially at flat angles.
57
57
58 
-Arc support:
59 
-------------
58 
+*Arc support:*
60 
 Splic3r can find curves that, although broken into segments, were ment to describe an arc.
59 
 Splic3r can find curves that, although broken into segments, were ment to describe an arc.
61 
 Marlin is able to print those arcs. The advantage is the firmware can choose the resolution,
60 
 Marlin is able to print those arcs. The advantage is the firmware can choose the resolution,
62 
 and can perform the arc with nearly constant velocity, resulting in a nice finish.
61 
 and can perform the arc with nearly constant velocity, resulting in a nice finish.
63 
 Also, less serial communication is needed.
62 
 Also, less serial communication is needed.
64
63
65 
-Temperature Oversampling:
64 
+*Temperature Oversampling:*
65 
+
66 
 To reduce noise and make the PID-differential term more useful, 16 ADC conversion results are averaged.
66 
 To reduce noise and make the PID-differential term more useful, 16 ADC conversion results are averaged.
67
67
68 
-AutoTemp:
69 
----------
68 
+*AutoTemp:*
69 
+
70 
 If your gcode contains a wide spread of extruder velocities, or you realtime change the building speed, the temperature should be changed accordingly.
70 
 If your gcode contains a wide spread of extruder velocities, or you realtime change the building speed, the temperature should be changed accordingly.
71 
 Usually, higher speed requires higher temperature.
71 
 Usually, higher speed requires higher temperature.
72 
 This can now be performed by the AutoTemp function
72 
 This can now be performed by the AutoTemp function
78 
 If the target temperature is set manually or by gcode to a value less then tempmin, it will be kept without change.
78 
 If the target temperature is set manually or by gcode to a value less then tempmin, it will be kept without change.
79 
 Ideally, your gcode can be completely free of temperature controls, apart from a M109 S T F in the start.gcode, and a M109 S0 in the end.gcode.
79 
 Ideally, your gcode can be completely free of temperature controls, apart from a M109 S T F in the start.gcode, and a M109 S0 in the end.gcode.
80
80
81 
-EEPROM:
82 
--------
81 
+*EEPROM:*
82 
+
83 
 If you know your PID values, the acceleration and max-velocities of your unique machine, you can set them, and finally store them in the EEPROM.
83 
 If you know your PID values, the acceleration and max-velocities of your unique machine, you can set them, and finally store them in the EEPROM.
84 
 After each reboot, it will magically load them from EEPROM, independent what your Configuration.h says.
84 
 After each reboot, it will magically load them from EEPROM, independent what your Configuration.h says.
85
85
86 
-LCD Menu:
87 
----------
86 
+*LCD Menu:*
87 
+
88 
 If your hardware supports it, you can build yourself a LCD-CardReader+Click+encoder combination. It will enable you to realtime tune temperatures,
88 
 If your hardware supports it, you can build yourself a LCD-CardReader+Click+encoder combination. It will enable you to realtime tune temperatures,
89 
 accelerations, velocities, flow rates, select and print files from the SD card, preheat, disable the steppers, and do other fancy stuff.
89 
 accelerations, velocities, flow rates, select and print files from the SD card, preheat, disable the steppers, and do other fancy stuff.
90 
 One working hardware is documented here: http://www.thingiverse.com/thing:12663
90 
 One working hardware is documented here: http://www.thingiverse.com/thing:12663
91 
 Also, with just a 20x4 or 16x2 display, useful data is shown.
91 
 Also, with just a 20x4 or 16x2 display, useful data is shown.
92
92
93 
-SD card folders:
94 
-----------------
93 
+*SD card folders:*
94 
+
95 
 If you have an SD card reader attached to your controller, also folders work now. Listing the files in pronterface will show "/path/subpath/file.g".
95 
 If you have an SD card reader attached to your controller, also folders work now. Listing the files in pronterface will show "/path/subpath/file.g".
96 
 You can write to file in a subfolder by specifying a similar text using small letters in the path.
96 
 You can write to file in a subfolder by specifying a similar text using small letters in the path.
97 
 Also, backup copies of various operating systems are hidden, as well as files not ending with ".g".
97 
 Also, backup copies of various operating systems are hidden, as well as files not ending with ".g".
98
98
99 
-Endstop trigger reporting:
100 
---------------------------
99 
+*Endstop trigger reporting:*
100 
+
101 
 If an endstop is hit while moving towards the endstop, the location at which the firmware thinks that the endstop was triggered is outputed on the serial port.
101 
 If an endstop is hit while moving towards the endstop, the location at which the firmware thinks that the endstop was triggered is outputed on the serial port.
102 
 This is useful, because the user gets a warning message.
102 
 This is useful, because the user gets a warning message.
103 
 However, also tools like QTMarlin can use this for finding acceptable combinations of velocity+acceleration.
103 
 However, also tools like QTMarlin can use this for finding acceptable combinations of velocity+acceleration.
104
104
105 
-Coding paradigm:
106 
-----------------
105 
+*Coding paradigm:*
106 
+
107 
 Not relevant from a user side, but Marlin was split into thematic junks, and has tried to partially enforced private variables.
107 
 Not relevant from a user side, but Marlin was split into thematic junks, and has tried to partially enforced private variables.
108 
 This is intended to make it clearer, what interacts which what, and leads to a higher level of modularization.
108 
 This is intended to make it clearer, what interacts which what, and leads to a higher level of modularization.
109 
 We think that this is a useful prestep for porting this firmware to e.g. an ARM platform in the future.
109 
 We think that this is a useful prestep for porting this firmware to e.g. an ARM platform in the future.
112 
 some transfer is information (usually beginning with "echo:"), an error "error:", or just normal protocol,
112 
 some transfer is information (usually beginning with "echo:"), an error "error:", or just normal protocol,
113 
 necessary for backwards compatibility.
113 
 necessary for backwards compatibility.
114
114
115 
-Interrupt based temperature measurements:
116 
------------------------------------------
115 
+*Interrupt based temperature measurements:*
116 
+
117 
 An interrupt is used to manage ADC conversions, and enforce checking for critical temperatures.
117 
 An interrupt is used to manage ADC conversions, and enforce checking for critical temperatures.
118 
 This leads to less blocking in the heater management routine.
118 
 This leads to less blocking in the heater management routine.
119
119
120 
+
120 
 Non-standard M-Codes, different to an old version of sprinter:
121 
 Non-standard M-Codes, different to an old version of sprinter:
121 
 ==============================================================
122 
 ==============================================================
122 
-G2  - CW ARC
123 
-G3  - CCW ARC
123 
+*   G2  - CW ARC
124 
+*   G3  - CCW ARC
124
125
125 
 General:
126 
 General:
126 
-M17  - Enable/Power all stepper motors
127 
-M18  - Disable all stepper motors; same as M84
128 
-M30  - Print time since last M109 or SD card start to serial
129 
-M42  - Change pin status via gcode
130 
-M80  - Turn on Power Supply
131 
-M81  - Turn off Power Supply
132 
-M114 - Output current position to serial port
133 
-M119 - Output Endstop status to serial port
127 
+
128 
+*   M17  - Enable/Power all stepper motors
129 
+*   M18  - Disable all stepper motors; same as M84
130 
+*   M30  - Print time since last M109 or SD card start to serial
131 
+*   M42  - Change pin status via gcode
132 
+*   M80  - Turn on Power Supply
133 
+*   M81  - Turn off Power Supply
134 
+*   M114 - Output current position to serial port
135 
+*   M119 - Output Endstop status to serial port
136 
+
134 
 Movement variables:
137 
 Movement variables:
135 
-M202 - Set max acceleration in units/s^2 for travel moves (M202 X1000 Y1000) Unused in Marlin!!
136 
-M203 - Set maximum feedrate that your machine can sustain (M203 X200 Y200 Z300 E10000) in mm/sec
137 
-M204 - Set default acceleration: S normal moves T filament only moves (M204 S3000 T7000) im mm/sec^2  also sets minimum segment time in ms (B20000) to prevent buffer underruns and M20 minimum feedrate
138 
-M220 - set build speed factor override percentage S:factor in percent ; aka "realtime tuneing in the gcode"
139 
-M301 - Set PID parameters P I and D
140 
-M400 - Finish all moves
138 
+
139 
+*   M202 - Set max acceleration in units/s^2 for travel moves (M202 X1000 Y1000) Unused in Marlin!!
140 
+*   M203 - Set maximum feedrate that your machine can sustain (M203 X200 Y200 Z300 E10000) in mm/sec
141 
+*   M204 - Set default acceleration: S normal moves T filament only moves (M204 S3000 T7000) im mm/sec^2  also sets minimum segment time in ms (B20000) to prevent buffer underruns and M20 minimum feedrate
142 
+*   M220 - set build speed factor override percentage S:factor in percent ; aka "realtime tuneing in the gcode"
143 
+*   M301 - Set PID parameters P I and D
144 
+*   M400 - Finish all moves
141
145
142 
 Advance:
146 
 Advance:
143 
-M200 - Set filament diameter for advance
144 
-M205 -  advanced settings:  minimum travel speed S=while printing T=travel only,  B=minimum segment time X= maximum xy jerk, Z=maximum Z jerk
147 
+
148 
+*   M200 - Set filament diameter for advance
149 
+*   M205 -  advanced settings:  minimum travel speed S=while printing T=travel only,  B=minimum segment time X= maximum xy jerk, Z=maximum Z jerk
145
150
146 
 EEPROM:
151 
 EEPROM:
147 
-M500 - stores paramters in EEPROM
148 
-M501 - reads parameters from EEPROM (if you need reset them after you changed them temporarily).
149 
-M502 - reverts to the default "factory settings".  You still need to store them in EEPROM afterwards if you want to.
152 
+*   M500 - stores paramters in EEPROM
153 
+*   M501 - reads parameters from EEPROM (if you need reset them after you changed them temporarily).
154 
+*   M502 - reverts to the default "factory settings".  You still need to store them in EEPROM afterwards if you want to.
150
155
151 
 Configuring and compilation:
156 
 Configuring and compilation:
152 
 ============================
157 
 ============================

Write Preview
Loading…
Cancel
Save