Browse Source

reformatting

Steffen Vogel 9 years ago
parent
commit
c98d87935a
1 changed files with 15 additions and 30 deletions
  1. 15
    30
      Documentation/Features.md

+ 15
- 30
Documentation/Features.md View File

1
-
2
-Features:
3
-=========
1
+# Features
4
 
2
 
5
 *   Interrupt based movement with real linear acceleration
3
 *   Interrupt based movement with real linear acceleration
6
 *   High steprate
4
 *   High steprate
19
 *   Arc support
17
 *   Arc support
20
 *   Temperature oversampling
18
 *   Temperature oversampling
21
 *   Dynamic Temperature setpointing aka "AutoTemp"
19
 *   Dynamic Temperature setpointing aka "AutoTemp"
22
-*   Support for QTMarlin, a very beta GUI for PID-tuning and velocity-acceleration testing. https://github.com/bkubicek/QTMarlin
20
+*   Support for [QTMarlin](https://github.com/bkubicek/QTMarlin), a very beta GUI for PID-tuning and velocity-acceleration testing. 
23
 *   Endstop trigger reporting to the host software.
21
 *   Endstop trigger reporting to the host software.
24
 *   Updated sdcardlib
22
 *   Updated sdcardlib
25
 *   Heater power reporting. Useful for PID monitoring.
23
 *   Heater power reporting. Useful for PID monitoring.
26
 *   PID tuning
24
 *   PID tuning
27
-*   CoreXY kinematics (www.corexy.com/theory.html)
25
+*   [CoreXY kinematics](www.corexy.com/theory.html)
28
 *   Delta kinematics
26
 *   Delta kinematics
29
 *   SCARA kinematics
27
 *   SCARA kinematics
30
 *   Dual X-carriage support for multiple extruder systems
28
 *   Dual X-carriage support for multiple extruder systems
36
 
34
 
37
 The default baudrate is 250000. This baudrate has less jitter and hence errors than the usual 115200 baud, but is less supported by drivers and host-environments.
35
 The default baudrate is 250000. This baudrate has less jitter and hence errors than the usual 115200 baud, but is less supported by drivers and host-environments.
38
 
36
 
37
+## Differences and additions to the already good Sprinter firmware
39
 
38
 
40
-Differences and additions to the already good Sprinter firmware:
41
-================================================================
42
-
43
-Look-ahead:
44
------------
39
+### Look-ahead
45
 
40
 
46
 Marlin has look-ahead. While sprinter has to break and re-accelerate at each corner,
41
 Marlin has look-ahead. While sprinter has to break and re-accelerate at each corner,
47
 lookahead will only decelerate and accelerate to a velocity,
42
 lookahead will only decelerate and accelerate to a velocity,
49
 This is only possible, if some future moves are already processed, hence the name.
44
 This is only possible, if some future moves are already processed, hence the name.
50
 It leads to less over-deposition at corners, especially at flat angles.
45
 It leads to less over-deposition at corners, especially at flat angles.
51
 
46
 
52
-Arc support:
53
-------------
47
+### Arc support
54
 
48
 
55
 Slic3r can find curves that, although broken into segments, were ment to describe an arc.
49
 Slic3r can find curves that, although broken into segments, were ment to describe an arc.
56
 Marlin is able to print those arcs. The advantage is the firmware can choose the resolution,
50
 Marlin is able to print those arcs. The advantage is the firmware can choose the resolution,
57
 and can perform the arc with nearly constant velocity, resulting in a nice finish.
51
 and can perform the arc with nearly constant velocity, resulting in a nice finish.
58
 Also, less serial communication is needed.
52
 Also, less serial communication is needed.
59
 
53
 
60
-Temperature Oversampling:
61
--------------------------
54
+### Temperature Oversampling
62
 
55
 
63
 To reduce noise and make the PID-differential term more useful, 16 ADC conversion results are averaged.
56
 To reduce noise and make the PID-differential term more useful, 16 ADC conversion results are averaged.
64
 
57
 
65
-AutoTemp:
66
----------
58
+### AutoTemp
67
 
59
 
68
 If your gcode contains a wide spread of extruder velocities, or you realtime change the building speed, the temperature should be changed accordingly.
60
 If your gcode contains a wide spread of extruder velocities, or you realtime change the building speed, the temperature should be changed accordingly.
69
 Usually, higher speed requires higher temperature.
61
 Usually, higher speed requires higher temperature.
76
 If the target temperature is set manually or by gcode to a value less then tempmin, it will be kept without change.
68
 If the target temperature is set manually or by gcode to a value less then tempmin, it will be kept without change.
77
 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.
69
 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.
78
 
70
 
79
-EEPROM:
80
--------
71
+### EEPROM
81
 
72
 
82
 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.
73
 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
 After each reboot, it will magically load them from EEPROM, independent what your Configuration.h says.
74
 After each reboot, it will magically load them from EEPROM, independent what your Configuration.h says.
84
 
75
 
85
-LCD Menu:
86
----------
76
+### LCD Menu
87
 
77
 
88
 If your hardware supports it, you can build yourself a LCD-CardReader+Click+encoder combination. It will enable you to realtime tune temperatures,
78
 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.
79
 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
80
 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.
81
 Also, with just a 20x4 or 16x2 display, useful data is shown.
92
 
82
 
93
-SD card folders:
94
-----------------
83
+### SD card directories
95
 
84
 
96
 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".
85
 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".
97
 You can write to file in a subfolder by specifying a similar text using small letters in the path.
86
 You can write to file in a subfolder by specifying a similar text using small letters in the path.
98
 Also, backup copies of various operating systems are hidden, as well as files not ending with ".g".
87
 Also, backup copies of various operating systems are hidden, as well as files not ending with ".g".
99
 
88
 
100
-SD card folders:
101
-----------------
89
+### Autostart
102
 
90
 
103
 If you place a file auto[0-9].g into the root of the sd card, it will be automatically executed if you boot the printer. The same file will be executed by selecting "Autostart" from the menu.
91
 If you place a file auto[0-9].g into the root of the sd card, it will be automatically executed if you boot the printer. The same file will be executed by selecting "Autostart" from the menu.
104
 First *0 will be performed, than *1 and so on. That way, you can heat up or even print automatically without user interaction.
92
 First *0 will be performed, than *1 and so on. That way, you can heat up or even print automatically without user interaction.
105
 
93
 
106
-Endstop trigger reporting:
107
---------------------------
94
+### Endstop trigger reporting
108
 
95
 
109
 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.
96
 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.
110
 This is useful, because the user gets a warning message.
97
 This is useful, because the user gets a warning message.
111
 However, also tools like QTMarlin can use this for finding acceptable combinations of velocity+acceleration.
98
 However, also tools like QTMarlin can use this for finding acceptable combinations of velocity+acceleration.
112
 
99
 
113
-Coding paradigm:
114
-----------------
100
+### Coding paradigm
115
 
101
 
116
 Not relevant from a user side, but Marlin was split into thematic junks, and has tried to partially enforced private variables.
102
 Not relevant from a user side, but Marlin was split into thematic junks, and has tried to partially enforced private variables.
117
 This is intended to make it clearer, what interacts which what, and leads to a higher level of modularization.
103
 This is intended to make it clearer, what interacts which what, and leads to a higher level of modularization.
121
 some transfer is information (usually beginning with "echo:"), an error "error:", or just normal protocol,
107
 some transfer is information (usually beginning with "echo:"), an error "error:", or just normal protocol,
122
 necessary for backwards compatibility.
108
 necessary for backwards compatibility.
123
 
109
 
124
-Interrupt based temperature measurements:
125
------------------------------------------
110
+### Interrupt based temperature measurements
126
 
111
 
127
 An interrupt is used to manage ADC conversions, and enforce checking for critical temperatures.
112
 An interrupt is used to manage ADC conversions, and enforce checking for critical temperatures.
128
 This leads to less blocking in the heater management routine.
113
 This leads to less blocking in the heater management routine.

Loading…
Cancel
Save