Browse Source

Incorporate @section headers from configurator

Richard Wackerbarth 10 years ago
parent
commit
46474cf2f2
2 changed files with 78 additions and 0 deletions
  1. 46
    0
      Marlin/Configuration.h
  2. 32
    0
      Marlin/Configuration_adv.h

+ 46
- 0
Marlin/Configuration.h View File

@@ -35,6 +35,8 @@ Here are some standard links for getting your machine calibrated:
35 35
 // example_configurations/SCARA directory.
36 36
 //
37 37
 
38
+// @section info
39
+
38 40
 // User-specified version info of this build to display in [Pronterface, etc] terminal window during
39 41
 // startup. Implementation of an idea by Prof Braino to inform user that any changes made to this
40 42
 // build by the user have been successfully uploaded into firmware.
@@ -45,12 +47,16 @@ Here are some standard links for getting your machine calibrated:
45 47
 #define STRING_SPLASH_LINE1 "v" STRING_VERSION // will be shown during bootup in line 1
46 48
 //#define STRING_SPLASH_LINE2 STRING_VERSION_CONFIG_H // will be shown during bootup in line2
47 49
 
50
+// @section machine
51
+
48 52
 // SERIAL_PORT selects which serial port should be used for communication with the host.
49 53
 // This allows the connection of wireless adapters (for instance) to non-default port pins.
50 54
 // Serial port 0 is still used by the Arduino bootloader regardless of this setting.
55
+// :[0,1,2,3,4,5,6,7]
51 56
 #define SERIAL_PORT 0
52 57
 
53 58
 // This determines the communication speed of the printer
59
+// :[2400,9600,19200,38400,57600,115200,250000]
54 60
 #define BAUDRATE 250000
55 61
 
56 62
 // This enables the serial port associated to the Bluetooth interface
@@ -70,6 +76,7 @@ Here are some standard links for getting your machine calibrated:
70 76
 // #define MACHINE_UUID "00000000-0000-0000-0000-000000000000"
71 77
 
72 78
 // This defines the number of extruders
79
+// :[1,2,3,4]
73 80
 #define EXTRUDERS 1
74 81
 
75 82
 // Offset of the extruders (uncomment if using more than one and relying on firmware to position when changing).
@@ -81,12 +88,15 @@ Here are some standard links for getting your machine calibrated:
81 88
 //// The following define selects which power supply you have. Please choose the one that matches your setup
82 89
 // 1 = ATX
83 90
 // 2 = X-Box 360 203Watts (the blue wire connected to PS_ON and the red wire to VCC)
91
+// :{1:'ATX',2:'X-Box 360'}
84 92
 
85 93
 #define POWER_SUPPLY 1
86 94
 
87 95
 // Define this to have the electronics keep the power supply off on startup. If you don't know what this is leave it.
88 96
 // #define PS_DEFAULT_OFF
89 97
 
98
+// @section temperature
99
+
90 100
 //===========================================================================
91 101
 //============================= Thermal Settings ============================
92 102
 //===========================================================================
@@ -248,6 +258,7 @@ Here are some standard links for getting your machine calibrated:
248 258
 // FIND YOUR OWN: "M303 E-1 C8 S90" to run autotune on the bed at 90 degreesC for 8 cycles.
249 259
 #endif // PIDTEMPBED
250 260
 
261
+// @section extruder
251 262
 
252 263
 //this prevents dangerous Extruder moves, i.e. if the temperature is under the limit
253 264
 //can be software-disabled for whatever purposes by
@@ -302,12 +313,16 @@ your extruder heater takes 2 minutes to hit the target on heating.
302 313
 //============================= Mechanical Settings =========================
303 314
 //===========================================================================
304 315
 
316
+// @section machine
317
+
305 318
 // Uncomment this option to enable CoreXY kinematics
306 319
 // #define COREXY
307 320
 
308 321
 // Enable this option for Toshiba steppers
309 322
 // #define CONFIG_STEPPERS_TOSHIBA
310 323
 
324
+// @section homing
325
+
311 326
 // coarse Endstop Settings
312 327
 #define ENDSTOPPULLUPS // Comment this out (using // at the start of the line) to disable the endstop pullup resistors
313 328
 
@@ -332,6 +347,8 @@ const bool Z_MAX_ENDSTOP_INVERTING = false; // set to true to invert the logic o
332 347
 const bool Z_PROBE_ENDSTOP_INVERTING = false; // set to true to invert the logic of the endstop.
333 348
 //#define DISABLE_MAX_ENDSTOPS
334 349
 //#define DISABLE_MIN_ENDSTOPS
350
+
351
+// @section machine
335 352
 // If you want to enable the Z Probe pin, but disable its use, uncomment the line below.
336 353
 // This only affects a Z Probe Endstop if you have separate Z min endstop as well and have
337 354
 // activated Z_PROBE_ENDSTOP below. If you are using the Z Min endstop on your Z Probe,
@@ -339,6 +356,7 @@ const bool Z_PROBE_ENDSTOP_INVERTING = false; // set to true to invert the logic
339 356
 //#define DISABLE_Z_PROBE_ENDSTOP
340 357
 
341 358
 // For Inverting Stepper Enable Pins (Active Low) use 0, Non Inverting (Active High) use 1
359
+// :{0:'Low',1:'High'}
342 360
 #define X_ENABLE_ON 0
343 361
 #define Y_ENABLE_ON 0
344 362
 #define Z_ENABLE_ON 0
@@ -348,20 +366,32 @@ const bool Z_PROBE_ENDSTOP_INVERTING = false; // set to true to invert the logic
348 366
 #define DISABLE_X false
349 367
 #define DISABLE_Y false
350 368
 #define DISABLE_Z false
369
+
370
+// @section extruder
371
+
351 372
 #define DISABLE_E false // For all extruders
352 373
 #define DISABLE_INACTIVE_EXTRUDER true //disable only inactive extruders and keep active extruder enabled
353 374
 
375
+// @section machine
376
+
354 377
 // Invert the stepper direction. Change (or reverse the motor connector) if an axis goes the wrong way.
355 378
 #define INVERT_X_DIR false
356 379
 #define INVERT_Y_DIR false
357 380
 #define INVERT_Z_DIR false
381
+
382
+// @section extruder
383
+
384
+// For direct drive extruder v9 set to true, for geared extruder set to false.
358 385
 #define INVERT_E0_DIR false
359 386
 #define INVERT_E1_DIR false
360 387
 #define INVERT_E2_DIR false
361 388
 #define INVERT_E3_DIR false
362 389
 
390
+// @section homing
391
+
363 392
 // ENDSTOP SETTINGS:
364 393
 // Sets direction of endstops when homing; 1=MAX, -1=MIN
394
+// :[-1,1]
365 395
 #define X_HOME_DIR -1
366 396
 #define Y_HOME_DIR -1
367 397
 #define Z_HOME_DIR -1
@@ -369,6 +399,8 @@ const bool Z_PROBE_ENDSTOP_INVERTING = false; // set to true to invert the logic
369 399
 #define min_software_endstops true // If true, axis won't move to coordinates less than HOME_POS.
370 400
 #define max_software_endstops true  // If true, axis won't move to coordinates greater than the defined lengths below.
371 401
 
402
+// @section machine
403
+
372 404
 // Travel limits after homing (units are in mm)
373 405
 #define X_MIN_POS 0
374 406
 #define Y_MIN_POS 0
@@ -408,6 +440,8 @@ const bool Z_PROBE_ENDSTOP_INVERTING = false; // set to true to invert the logic
408 440
 //============================= Bed Auto Leveling ===========================
409 441
 //===========================================================================
410 442
 
443
+// @section bedlevel
444
+
411 445
 //#define ENABLE_AUTO_BED_LEVELING // Delete the comment to enable (remove // at the start of the line)
412 446
 #define Z_PROBE_REPEATABILITY_TEST  // If not commented out, Z-Probe Repeatability test will be included if Auto Bed Leveling is Enabled.
413 447
 
@@ -516,6 +550,8 @@ const bool Z_PROBE_ENDSTOP_INVERTING = false; // set to true to invert the logic
516 550
 #endif // ENABLE_AUTO_BED_LEVELING
517 551
 
518 552
 
553
+// @section homing
554
+
519 555
 // The position of the homing switches
520 556
 //#define MANUAL_HOME_POSITIONS  // If defined, MANUAL_*_HOME_POS below will be used
521 557
 //#define BED_CENTER_AT_0_0  // If defined, the center of the bed is at (X=0, Y=0)
@@ -529,6 +565,8 @@ const bool Z_PROBE_ENDSTOP_INVERTING = false; // set to true to invert the logic
529 565
   //#define MANUAL_Z_HOME_POS 402 // For delta: Distance between nozzle and print surface after homing.
530 566
 #endif
531 567
 
568
+// @section movement
569
+
532 570
 /**
533 571
  * MOVEMENT SETTINGS
534 572
  */
@@ -555,6 +593,8 @@ const bool Z_PROBE_ENDSTOP_INVERTING = false; // set to true to invert the logic
555 593
 //============================= Additional Features ===========================
556 594
 //=============================================================================
557 595
 
596
+// @section more
597
+
558 598
 // Custom M code points
559 599
 #define CUSTOM_M_CODES
560 600
 #ifdef CUSTOM_M_CODES
@@ -565,6 +605,7 @@ const bool Z_PROBE_ENDSTOP_INVERTING = false; // set to true to invert the logic
565 605
   #endif
566 606
 #endif
567 607
 
608
+// @section extras
568 609
 
569 610
 // EEPROM
570 611
 // The microcontroller can store settings in the EEPROM, e.g. max velocity...
@@ -577,6 +618,8 @@ const bool Z_PROBE_ENDSTOP_INVERTING = false; // set to true to invert the logic
577 618
 // please keep turned on if you can.
578 619
 //#define EEPROM_CHITCHAT
579 620
 
621
+// @section temperature
622
+
580 623
 // Preheat Constants
581 624
 #define PLA_PREHEAT_HOTEND_TEMP 180
582 625
 #define PLA_PREHEAT_HPB_TEMP 70
@@ -587,6 +630,7 @@ const bool Z_PROBE_ENDSTOP_INVERTING = false; // set to true to invert the logic
587 630
 #define ABS_PREHEAT_FAN_SPEED 0   // Insert Value between 0 and 255
588 631
 
589 632
 //==============================LCD and SD support=============================
633
+// @section lcd
590 634
 
591 635
 // Define your display language below. Replace (en) with your language code and uncomment.
592 636
 // en, pl, fr, de, es, ru, it, pt, pt-br, fi, an, nl, ca, eu, kana, kana_utf8, test
@@ -670,6 +714,8 @@ const bool Z_PROBE_ENDSTOP_INVERTING = false; // set to true to invert the logic
670 714
 
671 715
 //#define SAV_3DLCD
672 716
 
717
+// @section extras
718
+
673 719
 // Increase the FAN pwm frequency. Removes the PWM noise but increases heating in the FET/Arduino
674 720
 //#define FAST_PWM_FAN
675 721
 

+ 32
- 0
Marlin/Configuration_adv.h View File

@@ -3,6 +3,8 @@
3 3
 
4 4
 #include "Conditionals.h"
5 5
 
6
+// @section temperature
7
+
6 8
 //===========================================================================
7 9
 //=============================Thermal Settings  ============================
8 10
 //===========================================================================
@@ -46,6 +48,8 @@
46 48
 //The M105 command return, besides traditional information, the ADC value read from temperature sensors.
47 49
 //#define SHOW_TEMP_ADC_VALUES
48 50
 
51
+// @section extruder
52
+
49 53
 //  extruder run-out prevention.
50 54
 //if the machine is idle, and the temperature over MINTEMP, every couple of SECONDS some filament is extruded
51 55
 //#define EXTRUDER_RUNOUT_PREVENT
@@ -55,6 +59,8 @@
55 59
 #define EXTRUDER_RUNOUT_SPEED 1500.  //extrusion speed
56 60
 #define EXTRUDER_RUNOUT_EXTRUDE 100
57 61
 
62
+// @section temperature
63
+
58 64
 //These defines help to calibrate the AD595 sensor in case you get wrong temperature measurements.
59 65
 //The measured temperature is defined as "actualTemp = (measuredTemp * TEMP_SENSOR_AD595_GAIN) + TEMP_SENSOR_AD595_OFFSET"
60 66
 #define TEMP_SENSOR_AD595_OFFSET 0.0
@@ -72,6 +78,8 @@
72 78
 // before setting a PWM value. (Does not work with software PWM for fan on Sanguinololu)
73 79
 //#define FAN_KICKSTART_TIME 100
74 80
 
81
+// @section extruder
82
+
75 83
 // Extruder cooling fans
76 84
 // Configure fan pin outputs to automatically turn on/off when the associated
77 85
 // extruder temperature is above/below EXTRUDER_AUTO_FAN_TEMPERATURE.
@@ -89,8 +97,12 @@
89 97
 //=============================Mechanical Settings===========================
90 98
 //===========================================================================
91 99
 
100
+// @section homing
101
+
92 102
 #define ENDSTOPS_ONLY_FOR_HOMING // If defined the endstops will only be used for homing
93 103
 
104
+// @section extras
105
+
94 106
 //#define Z_LATE_ENABLE // Enable Z the last moment. Needed if your Z driver overheats.
95 107
 
96 108
 // A single Z stepper driver is usually used to drive 2 stepper motors.
@@ -174,6 +186,8 @@
174 186
 
175 187
 #endif //DUAL_X_CARRIAGE
176 188
 
189
+// @section homing
190
+
177 191
 //homing hits the endstop, then retracts by this distance, before it tries to slowly bump again:
178 192
 #define X_HOME_BUMP_MM 5
179 193
 #define Y_HOME_BUMP_MM 5
@@ -181,8 +195,12 @@
181 195
 #define HOMING_BUMP_DIVISOR {2, 2, 4}  // Re-Bump Speed Divisor (Divides the Homing Feedrate)
182 196
 //#define QUICK_HOME  //if this is defined, if both x and y are to be homed, a diagonal move will be performed initially.
183 197
 
198
+// @section machine
199
+
184 200
 #define AXIS_RELATIVE_MODES {false, false, false, false}
185 201
 
202
+// @section machine
203
+
186 204
 //By default pololu step drivers require an active high signal. However, some high power drivers require an active low signal as step.
187 205
 #define INVERT_X_STEP_PIN false
188 206
 #define INVERT_Y_STEP_PIN false
@@ -195,11 +213,15 @@
195 213
 #define DEFAULT_MINIMUMFEEDRATE       0.0     // minimum feedrate
196 214
 #define DEFAULT_MINTRAVELFEEDRATE     0.0
197 215
 
216
+// @section lcd
217
+
198 218
 #ifdef ULTIPANEL
199 219
   #define MANUAL_FEEDRATE {50*60, 50*60, 4*60, 60} // Feedrates for manual moves along X, Y, Z, E from panel
200 220
   #define ULTIPANEL_FEEDMULTIPLY  // Comment to disable setting feedrate multiplier via encoder
201 221
 #endif
202 222
 
223
+// @section extras
224
+
203 225
 // minimum time in microseconds that a movement needs to take if the buffer is emptied.
204 226
 #define DEFAULT_MINSEGMENTTIME        20000
205 227
 
@@ -241,6 +263,8 @@
241 263
 //#define CHDK 4        //Pin for triggering CHDK to take a picture see how to use it here http://captain-slow.dk/2014/03/09/3d-printing-timelapses/
242 264
 #define CHDK_DELAY 50 //How long in ms the pin should stay HIGH before going LOW again
243 265
 
266
+// @section lcd
267
+
244 268
 #ifdef SDSUPPORT
245 269
 
246 270
   // If you are using a RAMPS board or cheap E-bay purchased boards that do not detect when an SD card is inserted
@@ -273,6 +297,8 @@
273 297
 
274 298
 #endif // SDSUPPORT
275 299
 
300
+// @section more
301
+
276 302
 // The hardware watchdog should reset the microcontroller disabling all outputs, in case the firmware gets stuck and doesn't do temperature regulation.
277 303
 //#define USE_WATCHDOG
278 304
 
@@ -317,6 +343,8 @@
317 343
 
318 344
 const unsigned int dropsegments=5; //everything with less than this number of steps will be ignored as move and joined with the next movement
319 345
 
346
+// @section temperature
347
+
320 348
 // Control heater 0 and heater 1 in parallel.
321 349
 //#define HEATERS_PARALLEL
322 350
 
@@ -324,6 +352,8 @@ const unsigned int dropsegments=5; //everything with less than this number of st
324 352
 //=============================Buffers           ============================
325 353
 //===========================================================================
326 354
 
355
+// @section hidden
356
+
327 357
 // The number of linear motions that can be in the plan at any give time.
328 358
 // THE BLOCK_BUFFER_SIZE NEEDS TO BE A POWER OF 2, i.g. 8,16,32 because shifts and ors are used to do the ring-buffering.
329 359
 #ifdef SDSUPPORT
@@ -332,11 +362,13 @@ const unsigned int dropsegments=5; //everything with less than this number of st
332 362
   #define BLOCK_BUFFER_SIZE 16 // maximize block buffer
333 363
 #endif
334 364
 
365
+// @section more
335 366
 
336 367
 //The ASCII buffer for receiving from the serial:
337 368
 #define MAX_CMD_SIZE 96
338 369
 #define BUFSIZE 4
339 370
 
371
+// @section extras
340 372
 
341 373
 // Firmware based and LCD controlled retract
342 374
 // M207 and M208 can be used to define parameters for the retraction.

Loading…
Cancel
Save