Browse Source

Edit configuration comments

Scott Lahteine 8 years ago
parent
commit
bf7ecc761f
27 changed files with 3699 additions and 3780 deletions
  1. 137
    140
      Marlin/Configuration.h
  2. 137
    140
      Marlin/example_configurations/Cartesio/Configuration.h
  3. 137
    140
      Marlin/example_configurations/Felix/Configuration.h
  4. 137
    140
      Marlin/example_configurations/Felix/DUAL/Configuration.h
  5. 137
    140
      Marlin/example_configurations/FolgerTech-i3-2020/Configuration.h
  6. 137
    140
      Marlin/example_configurations/Hephestos/Configuration.h
  7. 137
    140
      Marlin/example_configurations/Hephestos_2/Configuration.h
  8. 137
    140
      Marlin/example_configurations/K8200/Configuration.h
  9. 137
    140
      Marlin/example_configurations/K8400/Configuration.h
  10. 137
    140
      Marlin/example_configurations/K8400/Dual-head/Configuration.h
  11. 137
    140
      Marlin/example_configurations/RepRapWorld/Megatronics/Configuration.h
  12. 137
    140
      Marlin/example_configurations/RigidBot/Configuration.h
  13. 137
    140
      Marlin/example_configurations/SCARA/Configuration.h
  14. 137
    140
      Marlin/example_configurations/TAZ4/Configuration.h
  15. 137
    140
      Marlin/example_configurations/TinyBoy2/Configuration.h
  16. 137
    140
      Marlin/example_configurations/WITBOX/Configuration.h
  17. 137
    140
      Marlin/example_configurations/adafruit/ST7565/Configuration.h
  18. 137
    140
      Marlin/example_configurations/delta/FLSUN/auto_calibrate/Configuration.h
  19. 137
    140
      Marlin/example_configurations/delta/FLSUN/kossel_mini/Configuration.h
  20. 137
    140
      Marlin/example_configurations/delta/generic/Configuration.h
  21. 137
    140
      Marlin/example_configurations/delta/kossel_mini/Configuration.h
  22. 137
    140
      Marlin/example_configurations/delta/kossel_pro/Configuration.h
  23. 137
    140
      Marlin/example_configurations/delta/kossel_xl/Configuration.h
  24. 137
    140
      Marlin/example_configurations/gCreate_gMax1.5+/Configuration.h
  25. 137
    140
      Marlin/example_configurations/makibox/Configuration.h
  26. 137
    140
      Marlin/example_configurations/tvrrug/Round2/Configuration.h
  27. 137
    140
      Marlin/example_configurations/wt150/Configuration.h

+ 137
- 140
Marlin/Configuration.h View File

@@ -987,23 +987,17 @@
987 987
 #define PREHEAT_2_TEMP_BED    110
988 988
 #define PREHEAT_2_FAN_SPEED     0 // Value from 0 to 255
989 989
 
990
-//
991
-// Nozzle Park -- EXPERIMENTAL
992
-//
993
-// When enabled allows the user to define a special XYZ position, inside the
994
-// machine's topology, to park the nozzle when idle or when receiving the G27
995
-// command.
996
-//
997
-// The "P" paramenter controls what is the action applied to the Z axis:
998
-//    P0: (Default) If current Z-pos is lower than Z-park then the nozzle will
999
-//        be raised to reach Z-park height.
1000
-//
1001
-//    P1: No matter the current Z-pos, the nozzle will be raised/lowered to
1002
-//        reach Z-park height.
1003
-//
1004
-//    P2: The nozzle height will be raised by Z-park amount but never going over
1005
-//        the machine's limit of Z_MAX_POS.
1006
-//
990
+/**
991
+ * Nozzle Park -- EXPERIMENTAL
992
+ *
993
+ * Park the nozzle at the given XYZ position on idle or G27.
994
+ *
995
+ * The "P" parameter controls the action applied to the Z axis:
996
+ *
997
+ *    P0  (Default) If Z is below park Z raise the nozzle.
998
+ *    P1  Raise the nozzle always to Z-park height.
999
+ *    P2  Raise the nozzle by Z-park amount, limited to Z_MAX_POS.
1000
+ */
1007 1001
 //#define NOZZLE_PARK_FEATURE
1008 1002
 
1009 1003
 #if ENABLED(NOZZLE_PARK_FEATURE)
@@ -1011,44 +1005,44 @@
1011 1005
   #define NOZZLE_PARK_POINT { (X_MIN_POS + 10), (Y_MAX_POS - 10), 20 }
1012 1006
 #endif
1013 1007
 
1014
-//
1015
-// Clean Nozzle Feature -- EXPERIMENTAL
1016
-//
1017
-// When enabled allows the user to send G12 to start the nozzle cleaning
1018
-// process, the G-Code accepts two parameters:
1019
-//   "P" for pattern selection
1020
-//   "S" for defining the number of strokes/repetitions
1021
-//
1022
-// Available list of patterns:
1023
-//   P0: This is the default pattern, this process requires a sponge type
1024
-//       material at a fixed bed location. S defines "strokes" i.e.
1025
-//       back-and-forth movements between the starting and end points.
1026
-//
1027
-//   P1: This starts a zig-zag pattern between (X0, Y0) and (X1, Y1), "T"
1028
-//       defines the number of zig-zag triangles to be done. "S" defines the
1029
-//       number of strokes aka one back-and-forth movement. Zig-zags will
1030
-//       be performed in whichever dimension is smallest. As an example,
1031
-//       sending "G12 P1 S1 T3" will execute:
1032
-//
1033
-//          --
1034
-//         |  (X0, Y1) |     /\        /\        /\     | (X1, Y1)
1035
-//         |           |    /  \      /  \      /  \    |
1036
-//       A |           |   /    \    /    \    /    \   |
1037
-//         |           |  /      \  /      \  /      \  |
1038
-//         |  (X0, Y0) | /        \/        \/        \ | (X1, Y0)
1039
-//          --         +--------------------------------+
1040
-//                       |________|_________|_________|
1041
-//                           T1        T2        T3
1042
-//
1043
-//   P2: This starts a circular pattern with circle with middle in
1044
-//       NOZZLE_CLEAN_CIRCLE_MIDDLE radius of R and stroke count of S.
1045
-//       Before starting the circle nozzle goes to NOZZLE_CLEAN_START_POINT.
1046
-//
1047
-// Caveats: End point Z should use the same value as Start point Z.
1048
-//
1049
-// Attention: This is an EXPERIMENTAL feature, in the future the G-code arguments
1050
-// may change to add new functionality like different wipe patterns.
1051
-//
1008
+/**
1009
+ * Clean Nozzle Feature -- EXPERIMENTAL
1010
+ *
1011
+ * Adds the G12 command to perform a nozzle cleaning process.
1012
+ *
1013
+ * Parameters:
1014
+ *   P  Pattern
1015
+ *   S  Strokes / Repetitions
1016
+ *   T  Triangles (P1 only)
1017
+ *
1018
+ * Patterns:
1019
+ *   P0  Straight line (default). This process requires a sponge type material
1020
+ *       at a fixed bed location. "S" specifies strokes (i.e. back-forth motions)
1021
+ *       between the start / end points.
1022
+ *
1023
+ *   P1  Zig-zag pattern between (X0, Y0) and (X1, Y1), "T" specifies the
1024
+ *       number of zig-zag triangles to do. "S" defines the number of strokes.
1025
+ *       Zig-zags are done in whichever is the narrower dimension.
1026
+ *       For example, "G12 P1 S1 T3" will execute:
1027
+ *
1028
+ *          --
1029
+ *         |  (X0, Y1) |     /\        /\        /\     | (X1, Y1)
1030
+ *         |           |    /  \      /  \      /  \    |
1031
+ *       A |           |   /    \    /    \    /    \   |
1032
+ *         |           |  /      \  /      \  /      \  |
1033
+ *         |  (X0, Y0) | /        \/        \/        \ | (X1, Y0)
1034
+ *          --         +--------------------------------+
1035
+ *                       |________|_________|_________|
1036
+ *                           T1        T2        T3
1037
+ *
1038
+ *   P2  Circular pattern with middle at NOZZLE_CLEAN_CIRCLE_MIDDLE.
1039
+ *       "R" specifies the radius. "S" specifies the stroke count.
1040
+ *       Before starting, the nozzle moves to NOZZLE_CLEAN_START_POINT.
1041
+ *
1042
+ *   Caveats: The ending Z should be the same as starting Z.
1043
+ * Attention: EXPERIMENTAL. G-code arguments may change.
1044
+ *
1045
+ */
1052 1046
 //#define NOZZLE_CLEAN_FEATURE
1053 1047
 
1054 1048
 #if ENABLED(NOZZLE_CLEAN_FEATURE)
@@ -1073,33 +1067,35 @@
1073 1067
   #define NOZZLE_CLEAN_GOBACK
1074 1068
 #endif
1075 1069
 
1076
-//
1077
-// Print job timer
1078
-//
1079
-// Enable this option to automatically start and stop the
1080
-// print job timer when M104/M109/M190 commands are received.
1081
-// M104 (extruder without wait) - high temp = none, low temp = stop timer
1082
-// M109 (extruder with wait) - high temp = start timer, low temp = stop timer
1083
-// M190 (bed with wait) - high temp = start timer, low temp = none
1084
-//
1085
-// In all cases the timer can be started and stopped using
1086
-// the following commands:
1087
-//
1088
-// - M75  - Start the print job timer
1089
-// - M76  - Pause the print job timer
1090
-// - M77  - Stop the print job timer
1070
+/**
1071
+ * Print Job Timer
1072
+ *
1073
+ * Automatically start and stop the print job timer on M104/M109/M190.
1074
+ *
1075
+ *   M104 (hotend, no wait) - high temp = none,        low temp = stop timer
1076
+ *   M109 (hotend, wait)    - high temp = start timer, low temp = stop timer
1077
+ *   M190 (bed, wait)       - high temp = start timer, low temp = none
1078
+ *
1079
+ * The timer can also be controlled with the following commands:
1080
+ *
1081
+ *   M75 - Start the print job timer
1082
+ *   M76 - Pause the print job timer
1083
+ *   M77 - Stop the print job timer
1084
+ */
1091 1085
 #define PRINTJOB_TIMER_AUTOSTART
1092 1086
 
1093
-//
1094
-// Print Counter
1095
-//
1096
-// When enabled Marlin will keep track of some print statistical data such as:
1097
-//  - Total print jobs
1098
-//  - Total successful print jobs
1099
-//  - Total failed print jobs
1100
-//  - Total time printing
1101
-//
1102
-// This information can be viewed by the M78 command.
1087
+/**
1088
+ * Print Counter
1089
+ *
1090
+ * Track statistical data such as:
1091
+ *
1092
+ *  - Total print jobs
1093
+ *  - Total successful print jobs
1094
+ *  - Total failed print jobs
1095
+ *  - Total time printing
1096
+ *
1097
+ * View the current statistics with M78.
1098
+ */
1103 1099
 //#define PRINTCOUNTER
1104 1100
 
1105 1101
 //=============================================================================
@@ -1108,78 +1104,79 @@
1108 1104
 
1109 1105
 // @section lcd
1110 1106
 
1111
-//
1112
-// LCD LANGUAGE
1113
-//
1114
-// Here you may choose the language used by Marlin on the LCD menus, the following
1115
-// list of languages are available:
1116
-//    en, an, bg, ca, cn, cz, de, el, el-gr, es, eu, fi, fr, gl, hr, it,
1117
-//    kana, kana_utf8, nl, pl, pt, pt_utf8, pt-br, pt-br_utf8, ru, tr, uk, test
1118
-//
1119
-// :{ 'en':'English', 'an':'Aragonese', 'bg':'Bulgarian', 'ca':'Catalan', 'cn':'Chinese', 'cz':'Czech', 'de':'German', 'el':'Greek', 'el-gr':'Greek (Greece)', 'es':'Spanish', 'eu':'Basque-Euskera', 'fi':'Finnish', 'fr':'French', 'gl':'Galician', 'hr':'Croatian', 'it':'Italian', 'kana':'Japanese', 'kana_utf8':'Japanese (UTF8)', 'nl':'Dutch', 'pl':'Polish', 'pt':'Portuguese', 'pt-br':'Portuguese (Brazilian)', 'pt-br_utf8':'Portuguese (Brazilian UTF8)', 'pt_utf8':'Portuguese (UTF8)', 'ru':'Russian', 'tr':'Turkish', 'uk':'Ukrainian', 'test':'TEST' }
1120
-//
1107
+/**
1108
+ * LCD LANGUAGE
1109
+ *
1110
+ * Select the language to display on the LCD. These languages are available:
1111
+ *
1112
+ *    en, an, bg, ca, cn, cz, de, el, el-gr, es, eu, fi, fr, gl, hr, it,
1113
+ *    kana, kana_utf8, nl, pl, pt, pt_utf8, pt-br, pt-br_utf8, ru, tr, uk, test
1114
+ *
1115
+ * :{ 'en':'English', 'an':'Aragonese', 'bg':'Bulgarian', 'ca':'Catalan', 'cn':'Chinese', 'cz':'Czech', 'de':'German', 'el':'Greek', 'el-gr':'Greek (Greece)', 'es':'Spanish', 'eu':'Basque-Euskera', 'fi':'Finnish', 'fr':'French', 'gl':'Galician', 'hr':'Croatian', 'it':'Italian', 'kana':'Japanese', 'kana_utf8':'Japanese (UTF8)', 'nl':'Dutch', 'pl':'Polish', 'pt':'Portuguese', 'pt-br':'Portuguese (Brazilian)', 'pt-br_utf8':'Portuguese (Brazilian UTF8)', 'pt_utf8':'Portuguese (UTF8)', 'ru':'Russian', 'tr':'Turkish', 'uk':'Ukrainian', 'test':'TEST' }
1116
+ */
1121 1117
 #define LCD_LANGUAGE en
1122 1118
 
1123
-//
1124
-// LCD Character Set
1125
-//
1126
-// Note: This option is NOT applicable to Graphical Displays.
1127
-//
1128
-// All character-based LCD's provide ASCII plus one of these
1129
-// language extensions:
1130
-//
1131
-//  - JAPANESE ... the most common
1132
-//  - WESTERN  ... with more accented characters
1133
-//  - CYRILLIC ... for the Russian language
1134
-//
1135
-// To determine the language extension installed on your controller:
1136
-//
1137
-//  - Compile and upload with LCD_LANGUAGE set to 'test'
1138
-//  - Click the controller to view the LCD menu
1139
-//  - The LCD will display Japanese, Western, or Cyrillic text
1140
-//
1141
-// See https://github.com/MarlinFirmware/Marlin/wiki/LCD-Language
1142
-//
1143
-// :['JAPANESE', 'WESTERN', 'CYRILLIC']
1144
-//
1119
+/**
1120
+ * LCD Character Set
1121
+ *
1122
+ * Note: This option is NOT applicable to Graphical Displays.
1123
+ *
1124
+ * All character-based LCDs provide ASCII plus one of these
1125
+ * language extensions:
1126
+ *
1127
+ *  - JAPANESE ... the most common
1128
+ *  - WESTERN  ... with more accented characters
1129
+ *  - CYRILLIC ... for the Russian language
1130
+ *
1131
+ * To determine the language extension installed on your controller:
1132
+ *
1133
+ *  - Compile and upload with LCD_LANGUAGE set to 'test'
1134
+ *  - Click the controller to view the LCD menu
1135
+ *  - The LCD will display Japanese, Western, or Cyrillic text
1136
+ *
1137
+ * See https: *github.com/MarlinFirmware/Marlin/wiki/LCD-Language
1138
+ *
1139
+ * :['JAPANESE', 'WESTERN', 'CYRILLIC']
1140
+ */
1145 1141
 #define DISPLAY_CHARSET_HD44780 JAPANESE
1146 1142
 
1147
-//
1148
-// LCD TYPE
1149
-//
1150
-// You may choose ULTRA_LCD if you have character based LCD with 16x2, 16x4, 20x2,
1151
-// 20x4 char/lines or DOGLCD for the full graphics display with 128x64 pixels
1152
-// (ST7565R family). (This option will be set automatically for certain displays.)
1153
-//
1154
-// IMPORTANT NOTE: The U8glib library is required for Full Graphic Display!
1155
-//                 https://github.com/olikraus/U8glib_Arduino
1156
-//
1143
+/**
1144
+ * LCD TYPE
1145
+ *
1146
+ * Enable ULTRA_LCD for a 16x2, 16x4, 20x2, or 20x4 character-based LCD.
1147
+ * Enable DOGLCD for a 128x64 (ST7565R) Full Graphical Display.
1148
+ * (These options will be enabled automatically for most displays.)
1149
+ *
1150
+ * IMPORTANT: The U8glib library is required for Full Graphic Display!
1151
+ *            https://github.com/olikraus/U8glib_Arduino
1152
+ */
1157 1153
 //#define ULTRA_LCD   // Character based
1158 1154
 //#define DOGLCD      // Full graphics display
1159 1155
 
1160
-//
1161
-// SD CARD
1162
-//
1163
-// SD Card support is disabled by default. If your controller has an SD slot,
1164
-// you must uncomment the following option or it won't work.
1165
-//
1156
+/**
1157
+ * SD CARD
1158
+ *
1159
+ * SD Card support is disabled by default. If your controller has an SD slot,
1160
+ * you must uncomment the following option or it won't work.
1161
+ *
1162
+ */
1166 1163
 //#define SDSUPPORT
1167 1164
 
1168
-//
1169
-// SD CARD: SPI SPEED
1170
-//
1171
-// Uncomment ONE of the following items to use a slower SPI transfer
1172
-// speed. This is usually required if you're getting volume init errors.
1173
-//
1165
+/**
1166
+ * SD CARD: SPI SPEED
1167
+ *
1168
+ * Enable one of the following items for a slower SPI transfer speed.
1169
+ * This may be required to resolve "volume init" errors.
1170
+ */
1174 1171
 //#define SPI_SPEED SPI_HALF_SPEED
1175 1172
 //#define SPI_SPEED SPI_QUARTER_SPEED
1176 1173
 //#define SPI_SPEED SPI_EIGHTH_SPEED
1177 1174
 
1178
-//
1179
-// SD CARD: ENABLE CRC
1180
-//
1181
-// Use CRC checks and retries on the SD communication.
1182
-//
1175
+/**
1176
+ * SD CARD: ENABLE CRC
1177
+ *
1178
+ * Use CRC checks and retries on the SD communication.
1179
+ */
1183 1180
 //#define SD_CHECK_AND_RETRY
1184 1181
 
1185 1182
 //
@@ -1207,7 +1204,7 @@
1207 1204
  */
1208 1205
 
1209 1206
 //
1210
-// This option reverses the encoder direction everywhere
1207
+// This option reverses the encoder direction everywhere.
1211 1208
 //
1212 1209
 //  Set this option if CLOCKWISE causes values to DECREASE
1213 1210
 //

+ 137
- 140
Marlin/example_configurations/Cartesio/Configuration.h View File

@@ -985,23 +985,17 @@
985 985
 #define PREHEAT_2_TEMP_BED    110
986 986
 #define PREHEAT_2_FAN_SPEED     0 // Value from 0 to 255
987 987
 
988
-//
989
-// Nozzle Park -- EXPERIMENTAL
990
-//
991
-// When enabled allows the user to define a special XYZ position, inside the
992
-// machine's topology, to park the nozzle when idle or when receiving the G27
993
-// command.
994
-//
995
-// The "P" paramenter controls what is the action applied to the Z axis:
996
-//    P0: (Default) If current Z-pos is lower than Z-park then the nozzle will
997
-//        be raised to reach Z-park height.
998
-//
999
-//    P1: No matter the current Z-pos, the nozzle will be raised/lowered to
1000
-//        reach Z-park height.
1001
-//
1002
-//    P2: The nozzle height will be raised by Z-park amount but never going over
1003
-//        the machine's limit of Z_MAX_POS.
1004
-//
988
+/**
989
+ * Nozzle Park -- EXPERIMENTAL
990
+ *
991
+ * Park the nozzle at the given XYZ position on idle or G27.
992
+ *
993
+ * The "P" parameter controls the action applied to the Z axis:
994
+ *
995
+ *    P0  (Default) If Z is below park Z raise the nozzle.
996
+ *    P1  Raise the nozzle always to Z-park height.
997
+ *    P2  Raise the nozzle by Z-park amount, limited to Z_MAX_POS.
998
+ */
1005 999
 //#define NOZZLE_PARK_FEATURE
1006 1000
 
1007 1001
 #if ENABLED(NOZZLE_PARK_FEATURE)
@@ -1009,44 +1003,44 @@
1009 1003
   #define NOZZLE_PARK_POINT { (X_MIN_POS + 10), (Y_MAX_POS - 10), 20 }
1010 1004
 #endif
1011 1005
 
1012
-//
1013
-// Clean Nozzle Feature -- EXPERIMENTAL
1014
-//
1015
-// When enabled allows the user to send G12 to start the nozzle cleaning
1016
-// process, the G-Code accepts two parameters:
1017
-//   "P" for pattern selection
1018
-//   "S" for defining the number of strokes/repetitions
1019
-//
1020
-// Available list of patterns:
1021
-//   P0: This is the default pattern, this process requires a sponge type
1022
-//       material at a fixed bed location. S defines "strokes" i.e.
1023
-//       back-and-forth movements between the starting and end points.
1024
-//
1025
-//   P1: This starts a zig-zag pattern between (X0, Y0) and (X1, Y1), "T"
1026
-//       defines the number of zig-zag triangles to be done. "S" defines the
1027
-//       number of strokes aka one back-and-forth movement. Zig-zags will
1028
-//       be performed in whichever dimension is smallest. As an example,
1029
-//       sending "G12 P1 S1 T3" will execute:
1030
-//
1031
-//          --
1032
-//         |  (X0, Y1) |     /\        /\        /\     | (X1, Y1)
1033
-//         |           |    /  \      /  \      /  \    |
1034
-//       A |           |   /    \    /    \    /    \   |
1035
-//         |           |  /      \  /      \  /      \  |
1036
-//         |  (X0, Y0) | /        \/        \/        \ | (X1, Y0)
1037
-//          --         +--------------------------------+
1038
-//                       |________|_________|_________|
1039
-//                           T1        T2        T3
1040
-//
1041
-//   P2: This starts a circular pattern with circle with middle in
1042
-//       NOZZLE_CLEAN_CIRCLE_MIDDLE radius of R and stroke count of S.
1043
-//       Before starting the circle nozzle goes to NOZZLE_CLEAN_START_POINT.
1044
-//
1045
-// Caveats: End point Z should use the same value as Start point Z.
1046
-//
1047
-// Attention: This is an EXPERIMENTAL feature, in the future the G-code arguments
1048
-// may change to add new functionality like different wipe patterns.
1049
-//
1006
+/**
1007
+ * Clean Nozzle Feature -- EXPERIMENTAL
1008
+ *
1009
+ * Adds the G12 command to perform a nozzle cleaning process.
1010
+ *
1011
+ * Parameters:
1012
+ *   P  Pattern
1013
+ *   S  Strokes / Repetitions
1014
+ *   T  Triangles (P1 only)
1015
+ *
1016
+ * Patterns:
1017
+ *   P0  Straight line (default). This process requires a sponge type material
1018
+ *       at a fixed bed location. "S" specifies strokes (i.e. back-forth motions)
1019
+ *       between the start / end points.
1020
+ *
1021
+ *   P1  Zig-zag pattern between (X0, Y0) and (X1, Y1), "T" specifies the
1022
+ *       number of zig-zag triangles to do. "S" defines the number of strokes.
1023
+ *       Zig-zags are done in whichever is the narrower dimension.
1024
+ *       For example, "G12 P1 S1 T3" will execute:
1025
+ *
1026
+ *          --
1027
+ *         |  (X0, Y1) |     /\        /\        /\     | (X1, Y1)
1028
+ *         |           |    /  \      /  \      /  \    |
1029
+ *       A |           |   /    \    /    \    /    \   |
1030
+ *         |           |  /      \  /      \  /      \  |
1031
+ *         |  (X0, Y0) | /        \/        \/        \ | (X1, Y0)
1032
+ *          --         +--------------------------------+
1033
+ *                       |________|_________|_________|
1034
+ *                           T1        T2        T3
1035
+ *
1036
+ *   P2  Circular pattern with middle at NOZZLE_CLEAN_CIRCLE_MIDDLE.
1037
+ *       "R" specifies the radius. "S" specifies the stroke count.
1038
+ *       Before starting, the nozzle moves to NOZZLE_CLEAN_START_POINT.
1039
+ *
1040
+ *   Caveats: The ending Z should be the same as starting Z.
1041
+ * Attention: EXPERIMENTAL. G-code arguments may change.
1042
+ *
1043
+ */
1050 1044
 //#define NOZZLE_CLEAN_FEATURE
1051 1045
 
1052 1046
 #if ENABLED(NOZZLE_CLEAN_FEATURE)
@@ -1071,33 +1065,35 @@
1071 1065
   #define NOZZLE_CLEAN_GOBACK
1072 1066
 #endif
1073 1067
 
1074
-//
1075
-// Print job timer
1076
-//
1077
-// Enable this option to automatically start and stop the
1078
-// print job timer when M104/M109/M190 commands are received.
1079
-// M104 (extruder without wait) - high temp = none, low temp = stop timer
1080
-// M109 (extruder with wait) - high temp = start timer, low temp = stop timer
1081
-// M190 (bed with wait) - high temp = start timer, low temp = none
1082
-//
1083
-// In all cases the timer can be started and stopped using
1084
-// the following commands:
1085
-//
1086
-// - M75  - Start the print job timer
1087
-// - M76  - Pause the print job timer
1088
-// - M77  - Stop the print job timer
1068
+/**
1069
+ * Print Job Timer
1070
+ *
1071
+ * Automatically start and stop the print job timer on M104/M109/M190.
1072
+ *
1073
+ *   M104 (hotend, no wait) - high temp = none,        low temp = stop timer
1074
+ *   M109 (hotend, wait)    - high temp = start timer, low temp = stop timer
1075
+ *   M190 (bed, wait)       - high temp = start timer, low temp = none
1076
+ *
1077
+ * The timer can also be controlled with the following commands:
1078
+ *
1079
+ *   M75 - Start the print job timer
1080
+ *   M76 - Pause the print job timer
1081
+ *   M77 - Stop the print job timer
1082
+ */
1089 1083
 #define PRINTJOB_TIMER_AUTOSTART
1090 1084
 
1091
-//
1092
-// Print Counter
1093
-//
1094
-// When enabled Marlin will keep track of some print statistical data such as:
1095
-//  - Total print jobs
1096
-//  - Total successful print jobs
1097
-//  - Total failed print jobs
1098
-//  - Total time printing
1099
-//
1100
-// This information can be viewed by the M78 command.
1085
+/**
1086
+ * Print Counter
1087
+ *
1088
+ * Track statistical data such as:
1089
+ *
1090
+ *  - Total print jobs
1091
+ *  - Total successful print jobs
1092
+ *  - Total failed print jobs
1093
+ *  - Total time printing
1094
+ *
1095
+ * View the current statistics with M78.
1096
+ */
1101 1097
 //#define PRINTCOUNTER
1102 1098
 
1103 1099
 //=============================================================================
@@ -1106,78 +1102,79 @@
1106 1102
 
1107 1103
 // @section lcd
1108 1104
 
1109
-//
1110
-// LCD LANGUAGE
1111
-//
1112
-// Here you may choose the language used by Marlin on the LCD menus, the following
1113
-// list of languages are available:
1114
-//    en, an, bg, ca, cn, cz, de, el, el-gr, es, eu, fi, fr, gl, hr, it,
1115
-//    kana, kana_utf8, nl, pl, pt, pt_utf8, pt-br, pt-br_utf8, ru, tr, uk, test
1116
-//
1117
-// :{ 'en':'English', 'an':'Aragonese', 'bg':'Bulgarian', 'ca':'Catalan', 'cn':'Chinese', 'cz':'Czech', 'de':'German', 'el':'Greek', 'el-gr':'Greek (Greece)', 'es':'Spanish', 'eu':'Basque-Euskera', 'fi':'Finnish', 'fr':'French', 'gl':'Galician', 'hr':'Croatian', 'it':'Italian', 'kana':'Japanese', 'kana_utf8':'Japanese (UTF8)', 'nl':'Dutch', 'pl':'Polish', 'pt':'Portuguese', 'pt-br':'Portuguese (Brazilian)', 'pt-br_utf8':'Portuguese (Brazilian UTF8)', 'pt_utf8':'Portuguese (UTF8)', 'ru':'Russian', 'tr':'Turkish', 'uk':'Ukrainian', 'test':'TEST' }
1118
-//
1105
+/**
1106
+ * LCD LANGUAGE
1107
+ *
1108
+ * Select the language to display on the LCD. These languages are available:
1109
+ *
1110
+ *    en, an, bg, ca, cn, cz, de, el, el-gr, es, eu, fi, fr, gl, hr, it,
1111
+ *    kana, kana_utf8, nl, pl, pt, pt_utf8, pt-br, pt-br_utf8, ru, tr, uk, test
1112
+ *
1113
+ * :{ 'en':'English', 'an':'Aragonese', 'bg':'Bulgarian', 'ca':'Catalan', 'cn':'Chinese', 'cz':'Czech', 'de':'German', 'el':'Greek', 'el-gr':'Greek (Greece)', 'es':'Spanish', 'eu':'Basque-Euskera', 'fi':'Finnish', 'fr':'French', 'gl':'Galician', 'hr':'Croatian', 'it':'Italian', 'kana':'Japanese', 'kana_utf8':'Japanese (UTF8)', 'nl':'Dutch', 'pl':'Polish', 'pt':'Portuguese', 'pt-br':'Portuguese (Brazilian)', 'pt-br_utf8':'Portuguese (Brazilian UTF8)', 'pt_utf8':'Portuguese (UTF8)', 'ru':'Russian', 'tr':'Turkish', 'uk':'Ukrainian', 'test':'TEST' }
1114
+ */
1119 1115
 #define LCD_LANGUAGE en
1120 1116
 
1121
-//
1122
-// LCD Character Set
1123
-//
1124
-// Note: This option is NOT applicable to Graphical Displays.
1125
-//
1126
-// All character-based LCD's provide ASCII plus one of these
1127
-// language extensions:
1128
-//
1129
-//  - JAPANESE ... the most common
1130
-//  - WESTERN  ... with more accented characters
1131
-//  - CYRILLIC ... for the Russian language
1132
-//
1133
-// To determine the language extension installed on your controller:
1134
-//
1135
-//  - Compile and upload with LCD_LANGUAGE set to 'test'
1136
-//  - Click the controller to view the LCD menu
1137
-//  - The LCD will display Japanese, Western, or Cyrillic text
1138
-//
1139
-// See https://github.com/MarlinFirmware/Marlin/wiki/LCD-Language
1140
-//
1141
-// :['JAPANESE', 'WESTERN', 'CYRILLIC']
1142
-//
1117
+/**
1118
+ * LCD Character Set
1119
+ *
1120
+ * Note: This option is NOT applicable to Graphical Displays.
1121
+ *
1122
+ * All character-based LCDs provide ASCII plus one of these
1123
+ * language extensions:
1124
+ *
1125
+ *  - JAPANESE ... the most common
1126
+ *  - WESTERN  ... with more accented characters
1127
+ *  - CYRILLIC ... for the Russian language
1128
+ *
1129
+ * To determine the language extension installed on your controller:
1130
+ *
1131
+ *  - Compile and upload with LCD_LANGUAGE set to 'test'
1132
+ *  - Click the controller to view the LCD menu
1133
+ *  - The LCD will display Japanese, Western, or Cyrillic text
1134
+ *
1135
+ * See https: *github.com/MarlinFirmware/Marlin/wiki/LCD-Language
1136
+ *
1137
+ * :['JAPANESE', 'WESTERN', 'CYRILLIC']
1138
+ */
1143 1139
 #define DISPLAY_CHARSET_HD44780 JAPANESE
1144 1140
 
1145
-//
1146
-// LCD TYPE
1147
-//
1148
-// You may choose ULTRA_LCD if you have character based LCD with 16x2, 16x4, 20x2,
1149
-// 20x4 char/lines or DOGLCD for the full graphics display with 128x64 pixels
1150
-// (ST7565R family). (This option will be set automatically for certain displays.)
1151
-//
1152
-// IMPORTANT NOTE: The U8glib library is required for Full Graphic Display!
1153
-//                 https://github.com/olikraus/U8glib_Arduino
1154
-//
1141
+/**
1142
+ * LCD TYPE
1143
+ *
1144
+ * Enable ULTRA_LCD for a 16x2, 16x4, 20x2, or 20x4 character-based LCD.
1145
+ * Enable DOGLCD for a 128x64 (ST7565R) Full Graphical Display.
1146
+ * (These options will be enabled automatically for most displays.)
1147
+ *
1148
+ * IMPORTANT: The U8glib library is required for Full Graphic Display!
1149
+ *            https://github.com/olikraus/U8glib_Arduino
1150
+ */
1155 1151
 //#define ULTRA_LCD   // Character based
1156 1152
 //#define DOGLCD      // Full graphics display
1157 1153
 
1158
-//
1159
-// SD CARD
1160
-//
1161
-// SD Card support is disabled by default. If your controller has an SD slot,
1162
-// you must uncomment the following option or it won't work.
1163
-//
1154
+/**
1155
+ * SD CARD
1156
+ *
1157
+ * SD Card support is disabled by default. If your controller has an SD slot,
1158
+ * you must uncomment the following option or it won't work.
1159
+ *
1160
+ */
1164 1161
 #define SDSUPPORT
1165 1162
 
1166
-//
1167
-// SD CARD: SPI SPEED
1168
-//
1169
-// Uncomment ONE of the following items to use a slower SPI transfer
1170
-// speed. This is usually required if you're getting volume init errors.
1171
-//
1163
+/**
1164
+ * SD CARD: SPI SPEED
1165
+ *
1166
+ * Enable one of the following items for a slower SPI transfer speed.
1167
+ * This may be required to resolve "volume init" errors.
1168
+ */
1172 1169
 //#define SPI_SPEED SPI_HALF_SPEED
1173 1170
 //#define SPI_SPEED SPI_QUARTER_SPEED
1174 1171
 //#define SPI_SPEED SPI_EIGHTH_SPEED
1175 1172
 
1176
-//
1177
-// SD CARD: ENABLE CRC
1178
-//
1179
-// Use CRC checks and retries on the SD communication.
1180
-//
1173
+/**
1174
+ * SD CARD: ENABLE CRC
1175
+ *
1176
+ * Use CRC checks and retries on the SD communication.
1177
+ */
1181 1178
 //#define SD_CHECK_AND_RETRY
1182 1179
 
1183 1180
 //
@@ -1205,7 +1202,7 @@
1205 1202
  */
1206 1203
 
1207 1204
 //
1208
-// This option reverses the encoder direction everywhere
1205
+// This option reverses the encoder direction everywhere.
1209 1206
 //
1210 1207
 //  Set this option if CLOCKWISE causes values to DECREASE
1211 1208
 //

+ 137
- 140
Marlin/example_configurations/Felix/Configuration.h View File

@@ -969,23 +969,17 @@
969 969
 #define PREHEAT_2_TEMP_BED    100
970 970
 #define PREHEAT_2_FAN_SPEED   255 // Value from 0 to 255
971 971
 
972
-//
973
-// Nozzle Park -- EXPERIMENTAL
974
-//
975
-// When enabled allows the user to define a special XYZ position, inside the
976
-// machine's topology, to park the nozzle when idle or when receiving the G27
977
-// command.
978
-//
979
-// The "P" paramenter controls what is the action applied to the Z axis:
980
-//    P0: (Default) If current Z-pos is lower than Z-park then the nozzle will
981
-//        be raised to reach Z-park height.
982
-//
983
-//    P1: No matter the current Z-pos, the nozzle will be raised/lowered to
984
-//        reach Z-park height.
985
-//
986
-//    P2: The nozzle height will be raised by Z-park amount but never going over
987
-//        the machine's limit of Z_MAX_POS.
988
-//
972
+/**
973
+ * Nozzle Park -- EXPERIMENTAL
974
+ *
975
+ * Park the nozzle at the given XYZ position on idle or G27.
976
+ *
977
+ * The "P" parameter controls the action applied to the Z axis:
978
+ *
979
+ *    P0  (Default) If Z is below park Z raise the nozzle.
980
+ *    P1  Raise the nozzle always to Z-park height.
981
+ *    P2  Raise the nozzle by Z-park amount, limited to Z_MAX_POS.
982
+ */
989 983
 //#define NOZZLE_PARK_FEATURE
990 984
 
991 985
 #if ENABLED(NOZZLE_PARK_FEATURE)
@@ -993,44 +987,44 @@
993 987
   #define NOZZLE_PARK_POINT { (X_MIN_POS + 10), (Y_MAX_POS - 10), 20 }
994 988
 #endif
995 989
 
996
-//
997
-// Clean Nozzle Feature -- EXPERIMENTAL
998
-//
999
-// When enabled allows the user to send G12 to start the nozzle cleaning
1000
-// process, the G-Code accepts two parameters:
1001
-//   "P" for pattern selection
1002
-//   "S" for defining the number of strokes/repetitions
1003
-//
1004
-// Available list of patterns:
1005
-//   P0: This is the default pattern, this process requires a sponge type
1006
-//       material at a fixed bed location. S defines "strokes" i.e.
1007
-//       back-and-forth movements between the starting and end points.
1008
-//
1009
-//   P1: This starts a zig-zag pattern between (X0, Y0) and (X1, Y1), "T"
1010
-//       defines the number of zig-zag triangles to be done. "S" defines the
1011
-//       number of strokes aka one back-and-forth movement. Zig-zags will
1012
-//       be performed in whichever dimension is smallest. As an example,
1013
-//       sending "G12 P1 S1 T3" will execute:
1014
-//
1015
-//          --
1016
-//         |  (X0, Y1) |     /\        /\        /\     | (X1, Y1)
1017
-//         |           |    /  \      /  \      /  \    |
1018
-//       A |           |   /    \    /    \    /    \   |
1019
-//         |           |  /      \  /      \  /      \  |
1020
-//         |  (X0, Y0) | /        \/        \/        \ | (X1, Y0)
1021
-//          --         +--------------------------------+
1022
-//                       |________|_________|_________|
1023
-//                           T1        T2        T3
1024
-//
1025
-//   P2: This starts a circular pattern with circle with middle in
1026
-//       NOZZLE_CLEAN_CIRCLE_MIDDLE radius of R and stroke count of S.
1027
-//       Before starting the circle nozzle goes to NOZZLE_CLEAN_START_POINT.
1028
-//
1029
-// Caveats: End point Z should use the same value as Start point Z.
1030
-//
1031
-// Attention: This is an EXPERIMENTAL feature, in the future the G-code arguments
1032
-// may change to add new functionality like different wipe patterns.
1033
-//
990
+/**
991
+ * Clean Nozzle Feature -- EXPERIMENTAL
992
+ *
993
+ * Adds the G12 command to perform a nozzle cleaning process.
994
+ *
995
+ * Parameters:
996
+ *   P  Pattern
997
+ *   S  Strokes / Repetitions
998
+ *   T  Triangles (P1 only)
999
+ *
1000
+ * Patterns:
1001
+ *   P0  Straight line (default). This process requires a sponge type material
1002
+ *       at a fixed bed location. "S" specifies strokes (i.e. back-forth motions)
1003
+ *       between the start / end points.
1004
+ *
1005
+ *   P1  Zig-zag pattern between (X0, Y0) and (X1, Y1), "T" specifies the
1006
+ *       number of zig-zag triangles to do. "S" defines the number of strokes.
1007
+ *       Zig-zags are done in whichever is the narrower dimension.
1008
+ *       For example, "G12 P1 S1 T3" will execute:
1009
+ *
1010
+ *          --
1011
+ *         |  (X0, Y1) |     /\        /\        /\     | (X1, Y1)
1012
+ *         |           |    /  \      /  \      /  \    |
1013
+ *       A |           |   /    \    /    \    /    \   |
1014
+ *         |           |  /      \  /      \  /      \  |
1015
+ *         |  (X0, Y0) | /        \/        \/        \ | (X1, Y0)
1016
+ *          --         +--------------------------------+
1017
+ *                       |________|_________|_________|
1018
+ *                           T1        T2        T3
1019
+ *
1020
+ *   P2  Circular pattern with middle at NOZZLE_CLEAN_CIRCLE_MIDDLE.
1021
+ *       "R" specifies the radius. "S" specifies the stroke count.
1022
+ *       Before starting, the nozzle moves to NOZZLE_CLEAN_START_POINT.
1023
+ *
1024
+ *   Caveats: The ending Z should be the same as starting Z.
1025
+ * Attention: EXPERIMENTAL. G-code arguments may change.
1026
+ *
1027
+ */
1034 1028
 //#define NOZZLE_CLEAN_FEATURE
1035 1029
 
1036 1030
 #if ENABLED(NOZZLE_CLEAN_FEATURE)
@@ -1055,33 +1049,35 @@
1055 1049
   #define NOZZLE_CLEAN_GOBACK
1056 1050
 #endif
1057 1051
 
1058
-//
1059
-// Print job timer
1060
-//
1061
-// Enable this option to automatically start and stop the
1062
-// print job timer when M104/M109/M190 commands are received.
1063
-// M104 (extruder without wait) - high temp = none, low temp = stop timer
1064
-// M109 (extruder with wait) - high temp = start timer, low temp = stop timer
1065
-// M190 (bed with wait) - high temp = start timer, low temp = none
1066
-//
1067
-// In all cases the timer can be started and stopped using
1068
-// the following commands:
1069
-//
1070
-// - M75  - Start the print job timer
1071
-// - M76  - Pause the print job timer
1072
-// - M77  - Stop the print job timer
1052
+/**
1053
+ * Print Job Timer
1054
+ *
1055
+ * Automatically start and stop the print job timer on M104/M109/M190.
1056
+ *
1057
+ *   M104 (hotend, no wait) - high temp = none,        low temp = stop timer
1058
+ *   M109 (hotend, wait)    - high temp = start timer, low temp = stop timer
1059
+ *   M190 (bed, wait)       - high temp = start timer, low temp = none
1060
+ *
1061
+ * The timer can also be controlled with the following commands:
1062
+ *
1063
+ *   M75 - Start the print job timer
1064
+ *   M76 - Pause the print job timer
1065
+ *   M77 - Stop the print job timer
1066
+ */
1073 1067
 #define PRINTJOB_TIMER_AUTOSTART
1074 1068
 
1075
-//
1076
-// Print Counter
1077
-//
1078
-// When enabled Marlin will keep track of some print statistical data such as:
1079
-//  - Total print jobs
1080
-//  - Total successful print jobs
1081
-//  - Total failed print jobs
1082
-//  - Total time printing
1083
-//
1084
-// This information can be viewed by the M78 command.
1069
+/**
1070
+ * Print Counter
1071
+ *
1072
+ * Track statistical data such as:
1073
+ *
1074
+ *  - Total print jobs
1075
+ *  - Total successful print jobs
1076
+ *  - Total failed print jobs
1077
+ *  - Total time printing
1078
+ *
1079
+ * View the current statistics with M78.
1080
+ */
1085 1081
 //#define PRINTCOUNTER
1086 1082
 
1087 1083
 //=============================================================================
@@ -1090,78 +1086,79 @@
1090 1086
 
1091 1087
 // @section lcd
1092 1088
 
1093
-//
1094
-// LCD LANGUAGE
1095
-//
1096
-// Here you may choose the language used by Marlin on the LCD menus, the following
1097
-// list of languages are available:
1098
-//    en, an, bg, ca, cn, cz, de, el, el-gr, es, eu, fi, fr, gl, hr, it,
1099
-//    kana, kana_utf8, nl, pl, pt, pt_utf8, pt-br, pt-br_utf8, ru, tr, uk, test
1100
-//
1101
-// :{ 'en':'English', 'an':'Aragonese', 'bg':'Bulgarian', 'ca':'Catalan', 'cn':'Chinese', 'cz':'Czech', 'de':'German', 'el':'Greek', 'el-gr':'Greek (Greece)', 'es':'Spanish', 'eu':'Basque-Euskera', 'fi':'Finnish', 'fr':'French', 'gl':'Galician', 'hr':'Croatian', 'it':'Italian', 'kana':'Japanese', 'kana_utf8':'Japanese (UTF8)', 'nl':'Dutch', 'pl':'Polish', 'pt':'Portuguese', 'pt-br':'Portuguese (Brazilian)', 'pt-br_utf8':'Portuguese (Brazilian UTF8)', 'pt_utf8':'Portuguese (UTF8)', 'ru':'Russian', 'tr':'Turkish', 'uk':'Ukrainian', 'test':'TEST' }
1102
-//
1089
+/**
1090
+ * LCD LANGUAGE
1091
+ *
1092
+ * Select the language to display on the LCD. These languages are available:
1093
+ *
1094
+ *    en, an, bg, ca, cn, cz, de, el, el-gr, es, eu, fi, fr, gl, hr, it,
1095
+ *    kana, kana_utf8, nl, pl, pt, pt_utf8, pt-br, pt-br_utf8, ru, tr, uk, test
1096
+ *
1097
+ * :{ 'en':'English', 'an':'Aragonese', 'bg':'Bulgarian', 'ca':'Catalan', 'cn':'Chinese', 'cz':'Czech', 'de':'German', 'el':'Greek', 'el-gr':'Greek (Greece)', 'es':'Spanish', 'eu':'Basque-Euskera', 'fi':'Finnish', 'fr':'French', 'gl':'Galician', 'hr':'Croatian', 'it':'Italian', 'kana':'Japanese', 'kana_utf8':'Japanese (UTF8)', 'nl':'Dutch', 'pl':'Polish', 'pt':'Portuguese', 'pt-br':'Portuguese (Brazilian)', 'pt-br_utf8':'Portuguese (Brazilian UTF8)', 'pt_utf8':'Portuguese (UTF8)', 'ru':'Russian', 'tr':'Turkish', 'uk':'Ukrainian', 'test':'TEST' }
1098
+ */
1103 1099
 //#define LCD_LANGUAGE en
1104 1100
 
1105
-//
1106
-// LCD Character Set
1107
-//
1108
-// Note: This option is NOT applicable to Graphical Displays.
1109
-//
1110
-// All character-based LCD's provide ASCII plus one of these
1111
-// language extensions:
1112
-//
1113
-//  - JAPANESE ... the most common
1114
-//  - WESTERN  ... with more accented characters
1115
-//  - CYRILLIC ... for the Russian language
1116
-//
1117
-// To determine the language extension installed on your controller:
1118
-//
1119
-//  - Compile and upload with LCD_LANGUAGE set to 'test'
1120
-//  - Click the controller to view the LCD menu
1121
-//  - The LCD will display Japanese, Western, or Cyrillic text
1122
-//
1123
-// See https://github.com/MarlinFirmware/Marlin/wiki/LCD-Language
1124
-//
1125
-// :['JAPANESE', 'WESTERN', 'CYRILLIC']
1126
-//
1101
+/**
1102
+ * LCD Character Set
1103
+ *
1104
+ * Note: This option is NOT applicable to Graphical Displays.
1105
+ *
1106
+ * All character-based LCDs provide ASCII plus one of these
1107
+ * language extensions:
1108
+ *
1109
+ *  - JAPANESE ... the most common
1110
+ *  - WESTERN  ... with more accented characters
1111
+ *  - CYRILLIC ... for the Russian language
1112
+ *
1113
+ * To determine the language extension installed on your controller:
1114
+ *
1115
+ *  - Compile and upload with LCD_LANGUAGE set to 'test'
1116
+ *  - Click the controller to view the LCD menu
1117
+ *  - The LCD will display Japanese, Western, or Cyrillic text
1118
+ *
1119
+ * See https: *github.com/MarlinFirmware/Marlin/wiki/LCD-Language
1120
+ *
1121
+ * :['JAPANESE', 'WESTERN', 'CYRILLIC']
1122
+ */
1127 1123
 #define DISPLAY_CHARSET_HD44780 JAPANESE
1128 1124
 
1129
-//
1130
-// LCD TYPE
1131
-//
1132
-// You may choose ULTRA_LCD if you have character based LCD with 16x2, 16x4, 20x2,
1133
-// 20x4 char/lines or DOGLCD for the full graphics display with 128x64 pixels
1134
-// (ST7565R family). (This option will be set automatically for certain displays.)
1135
-//
1136
-// IMPORTANT NOTE: The U8glib library is required for Full Graphic Display!
1137
-//                 https://github.com/olikraus/U8glib_Arduino
1138
-//
1125
+/**
1126
+ * LCD TYPE
1127
+ *
1128
+ * Enable ULTRA_LCD for a 16x2, 16x4, 20x2, or 20x4 character-based LCD.
1129
+ * Enable DOGLCD for a 128x64 (ST7565R) Full Graphical Display.
1130
+ * (These options will be enabled automatically for most displays.)
1131
+ *
1132
+ * IMPORTANT: The U8glib library is required for Full Graphic Display!
1133
+ *            https://github.com/olikraus/U8glib_Arduino
1134
+ */
1139 1135
 //#define ULTRA_LCD   // Character based
1140 1136
 //#define DOGLCD      // Full graphics display
1141 1137
 
1142
-//
1143
-// SD CARD
1144
-//
1145
-// SD Card support is disabled by default. If your controller has an SD slot,
1146
-// you must uncomment the following option or it won't work.
1147
-//
1138
+/**
1139
+ * SD CARD
1140
+ *
1141
+ * SD Card support is disabled by default. If your controller has an SD slot,
1142
+ * you must uncomment the following option or it won't work.
1143
+ *
1144
+ */
1148 1145
 //#define SDSUPPORT
1149 1146
 
1150
-//
1151
-// SD CARD: SPI SPEED
1152
-//
1153
-// Uncomment ONE of the following items to use a slower SPI transfer
1154
-// speed. This is usually required if you're getting volume init errors.
1155
-//
1147
+/**
1148
+ * SD CARD: SPI SPEED
1149
+ *
1150
+ * Enable one of the following items for a slower SPI transfer speed.
1151
+ * This may be required to resolve "volume init" errors.
1152
+ */
1156 1153
 //#define SPI_SPEED SPI_HALF_SPEED
1157 1154
 //#define SPI_SPEED SPI_QUARTER_SPEED
1158 1155
 //#define SPI_SPEED SPI_EIGHTH_SPEED
1159 1156
 
1160
-//
1161
-// SD CARD: ENABLE CRC
1162
-//
1163
-// Use CRC checks and retries on the SD communication.
1164
-//
1157
+/**
1158
+ * SD CARD: ENABLE CRC
1159
+ *
1160
+ * Use CRC checks and retries on the SD communication.
1161
+ */
1165 1162
 //#define SD_CHECK_AND_RETRY
1166 1163
 
1167 1164
 //
@@ -1189,7 +1186,7 @@
1189 1186
  */
1190 1187
 
1191 1188
 //
1192
-// This option reverses the encoder direction everywhere
1189
+// This option reverses the encoder direction everywhere.
1193 1190
 //
1194 1191
 //  Set this option if CLOCKWISE causes values to DECREASE
1195 1192
 //

+ 137
- 140
Marlin/example_configurations/Felix/DUAL/Configuration.h View File

@@ -969,23 +969,17 @@
969 969
 #define PREHEAT_2_TEMP_BED    100
970 970
 #define PREHEAT_2_FAN_SPEED   255 // Value from 0 to 255
971 971
 
972
-//
973
-// Nozzle Park -- EXPERIMENTAL
974
-//
975
-// When enabled allows the user to define a special XYZ position, inside the
976
-// machine's topology, to park the nozzle when idle or when receiving the G27
977
-// command.
978
-//
979
-// The "P" paramenter controls what is the action applied to the Z axis:
980
-//    P0: (Default) If current Z-pos is lower than Z-park then the nozzle will
981
-//        be raised to reach Z-park height.
982
-//
983
-//    P1: No matter the current Z-pos, the nozzle will be raised/lowered to
984
-//        reach Z-park height.
985
-//
986
-//    P2: The nozzle height will be raised by Z-park amount but never going over
987
-//        the machine's limit of Z_MAX_POS.
988
-//
972
+/**
973
+ * Nozzle Park -- EXPERIMENTAL
974
+ *
975
+ * Park the nozzle at the given XYZ position on idle or G27.
976
+ *
977
+ * The "P" parameter controls the action applied to the Z axis:
978
+ *
979
+ *    P0  (Default) If Z is below park Z raise the nozzle.
980
+ *    P1  Raise the nozzle always to Z-park height.
981
+ *    P2  Raise the nozzle by Z-park amount, limited to Z_MAX_POS.
982
+ */
989 983
 //#define NOZZLE_PARK_FEATURE
990 984
 
991 985
 #if ENABLED(NOZZLE_PARK_FEATURE)
@@ -993,44 +987,44 @@
993 987
   #define NOZZLE_PARK_POINT { (X_MIN_POS + 10), (Y_MAX_POS - 10), 20 }
994 988
 #endif
995 989
 
996
-//
997
-// Clean Nozzle Feature -- EXPERIMENTAL
998
-//
999
-// When enabled allows the user to send G12 to start the nozzle cleaning
1000
-// process, the G-Code accepts two parameters:
1001
-//   "P" for pattern selection
1002
-//   "S" for defining the number of strokes/repetitions
1003
-//
1004
-// Available list of patterns:
1005
-//   P0: This is the default pattern, this process requires a sponge type
1006
-//       material at a fixed bed location. S defines "strokes" i.e.
1007
-//       back-and-forth movements between the starting and end points.
1008
-//
1009
-//   P1: This starts a zig-zag pattern between (X0, Y0) and (X1, Y1), "T"
1010
-//       defines the number of zig-zag triangles to be done. "S" defines the
1011
-//       number of strokes aka one back-and-forth movement. Zig-zags will
1012
-//       be performed in whichever dimension is smallest. As an example,
1013
-//       sending "G12 P1 S1 T3" will execute:
1014
-//
1015
-//          --
1016
-//         |  (X0, Y1) |     /\        /\        /\     | (X1, Y1)
1017
-//         |           |    /  \      /  \      /  \    |
1018
-//       A |           |   /    \    /    \    /    \   |
1019
-//         |           |  /      \  /      \  /      \  |
1020
-//         |  (X0, Y0) | /        \/        \/        \ | (X1, Y0)
1021
-//          --         +--------------------------------+
1022
-//                       |________|_________|_________|
1023
-//                           T1        T2        T3
1024
-//
1025
-//   P2: This starts a circular pattern with circle with middle in
1026
-//       NOZZLE_CLEAN_CIRCLE_MIDDLE radius of R and stroke count of S.
1027
-//       Before starting the circle nozzle goes to NOZZLE_CLEAN_START_POINT.
1028
-//
1029
-// Caveats: End point Z should use the same value as Start point Z.
1030
-//
1031
-// Attention: This is an EXPERIMENTAL feature, in the future the G-code arguments
1032
-// may change to add new functionality like different wipe patterns.
1033
-//
990
+/**
991
+ * Clean Nozzle Feature -- EXPERIMENTAL
992
+ *
993
+ * Adds the G12 command to perform a nozzle cleaning process.
994
+ *
995
+ * Parameters:
996
+ *   P  Pattern
997
+ *   S  Strokes / Repetitions
998
+ *   T  Triangles (P1 only)
999
+ *
1000
+ * Patterns:
1001
+ *   P0  Straight line (default). This process requires a sponge type material
1002
+ *       at a fixed bed location. "S" specifies strokes (i.e. back-forth motions)
1003
+ *       between the start / end points.
1004
+ *
1005
+ *   P1  Zig-zag pattern between (X0, Y0) and (X1, Y1), "T" specifies the
1006
+ *       number of zig-zag triangles to do. "S" defines the number of strokes.
1007
+ *       Zig-zags are done in whichever is the narrower dimension.
1008
+ *       For example, "G12 P1 S1 T3" will execute:
1009
+ *
1010
+ *          --
1011
+ *         |  (X0, Y1) |     /\        /\        /\     | (X1, Y1)
1012
+ *         |           |    /  \      /  \      /  \    |
1013
+ *       A |           |   /    \    /    \    /    \   |
1014
+ *         |           |  /      \  /      \  /      \  |
1015
+ *         |  (X0, Y0) | /        \/        \/        \ | (X1, Y0)
1016
+ *          --         +--------------------------------+
1017
+ *                       |________|_________|_________|
1018
+ *                           T1        T2        T3
1019
+ *
1020
+ *   P2  Circular pattern with middle at NOZZLE_CLEAN_CIRCLE_MIDDLE.
1021
+ *       "R" specifies the radius. "S" specifies the stroke count.
1022
+ *       Before starting, the nozzle moves to NOZZLE_CLEAN_START_POINT.
1023
+ *
1024
+ *   Caveats: The ending Z should be the same as starting Z.
1025
+ * Attention: EXPERIMENTAL. G-code arguments may change.
1026
+ *
1027
+ */
1034 1028
 //#define NOZZLE_CLEAN_FEATURE
1035 1029
 
1036 1030
 #if ENABLED(NOZZLE_CLEAN_FEATURE)
@@ -1055,33 +1049,35 @@
1055 1049
   #define NOZZLE_CLEAN_GOBACK
1056 1050
 #endif
1057 1051
 
1058
-//
1059
-// Print job timer
1060
-//
1061
-// Enable this option to automatically start and stop the
1062
-// print job timer when M104/M109/M190 commands are received.
1063
-// M104 (extruder without wait) - high temp = none, low temp = stop timer
1064
-// M109 (extruder with wait) - high temp = start timer, low temp = stop timer
1065
-// M190 (bed with wait) - high temp = start timer, low temp = none
1066
-//
1067
-// In all cases the timer can be started and stopped using
1068
-// the following commands:
1069
-//
1070
-// - M75  - Start the print job timer
1071
-// - M76  - Pause the print job timer
1072
-// - M77  - Stop the print job timer
1052
+/**
1053
+ * Print Job Timer
1054
+ *
1055
+ * Automatically start and stop the print job timer on M104/M109/M190.
1056
+ *
1057
+ *   M104 (hotend, no wait) - high temp = none,        low temp = stop timer
1058
+ *   M109 (hotend, wait)    - high temp = start timer, low temp = stop timer
1059
+ *   M190 (bed, wait)       - high temp = start timer, low temp = none
1060
+ *
1061
+ * The timer can also be controlled with the following commands:
1062
+ *
1063
+ *   M75 - Start the print job timer
1064
+ *   M76 - Pause the print job timer
1065
+ *   M77 - Stop the print job timer
1066
+ */
1073 1067
 #define PRINTJOB_TIMER_AUTOSTART
1074 1068
 
1075
-//
1076
-// Print Counter
1077
-//
1078
-// When enabled Marlin will keep track of some print statistical data such as:
1079
-//  - Total print jobs
1080
-//  - Total successful print jobs
1081
-//  - Total failed print jobs
1082
-//  - Total time printing
1083
-//
1084
-// This information can be viewed by the M78 command.
1069
+/**
1070
+ * Print Counter
1071
+ *
1072
+ * Track statistical data such as:
1073
+ *
1074
+ *  - Total print jobs
1075
+ *  - Total successful print jobs
1076
+ *  - Total failed print jobs
1077
+ *  - Total time printing
1078
+ *
1079
+ * View the current statistics with M78.
1080
+ */
1085 1081
 //#define PRINTCOUNTER
1086 1082
 
1087 1083
 //=============================================================================
@@ -1090,78 +1086,79 @@
1090 1086
 
1091 1087
 // @section lcd
1092 1088
 
1093
-//
1094
-// LCD LANGUAGE
1095
-//
1096
-// Here you may choose the language used by Marlin on the LCD menus, the following
1097
-// list of languages are available:
1098
-//    en, an, bg, ca, cn, cz, de, el, el-gr, es, eu, fi, fr, gl, hr, it,
1099
-//    kana, kana_utf8, nl, pl, pt, pt_utf8, pt-br, pt-br_utf8, ru, tr, uk, test
1100
-//
1101
-// :{ 'en':'English', 'an':'Aragonese', 'bg':'Bulgarian', 'ca':'Catalan', 'cn':'Chinese', 'cz':'Czech', 'de':'German', 'el':'Greek', 'el-gr':'Greek (Greece)', 'es':'Spanish', 'eu':'Basque-Euskera', 'fi':'Finnish', 'fr':'French', 'gl':'Galician', 'hr':'Croatian', 'it':'Italian', 'kana':'Japanese', 'kana_utf8':'Japanese (UTF8)', 'nl':'Dutch', 'pl':'Polish', 'pt':'Portuguese', 'pt-br':'Portuguese (Brazilian)', 'pt-br_utf8':'Portuguese (Brazilian UTF8)', 'pt_utf8':'Portuguese (UTF8)', 'ru':'Russian', 'tr':'Turkish', 'uk':'Ukrainian', 'test':'TEST' }
1102
-//
1089
+/**
1090
+ * LCD LANGUAGE
1091
+ *
1092
+ * Select the language to display on the LCD. These languages are available:
1093
+ *
1094
+ *    en, an, bg, ca, cn, cz, de, el, el-gr, es, eu, fi, fr, gl, hr, it,
1095
+ *    kana, kana_utf8, nl, pl, pt, pt_utf8, pt-br, pt-br_utf8, ru, tr, uk, test
1096
+ *
1097
+ * :{ 'en':'English', 'an':'Aragonese', 'bg':'Bulgarian', 'ca':'Catalan', 'cn':'Chinese', 'cz':'Czech', 'de':'German', 'el':'Greek', 'el-gr':'Greek (Greece)', 'es':'Spanish', 'eu':'Basque-Euskera', 'fi':'Finnish', 'fr':'French', 'gl':'Galician', 'hr':'Croatian', 'it':'Italian', 'kana':'Japanese', 'kana_utf8':'Japanese (UTF8)', 'nl':'Dutch', 'pl':'Polish', 'pt':'Portuguese', 'pt-br':'Portuguese (Brazilian)', 'pt-br_utf8':'Portuguese (Brazilian UTF8)', 'pt_utf8':'Portuguese (UTF8)', 'ru':'Russian', 'tr':'Turkish', 'uk':'Ukrainian', 'test':'TEST' }
1098
+ */
1103 1099
 //#define LCD_LANGUAGE en
1104 1100
 
1105
-//
1106
-// LCD Character Set
1107
-//
1108
-// Note: This option is NOT applicable to Graphical Displays.
1109
-//
1110
-// All character-based LCD's provide ASCII plus one of these
1111
-// language extensions:
1112
-//
1113
-//  - JAPANESE ... the most common
1114
-//  - WESTERN  ... with more accented characters
1115
-//  - CYRILLIC ... for the Russian language
1116
-//
1117
-// To determine the language extension installed on your controller:
1118
-//
1119
-//  - Compile and upload with LCD_LANGUAGE set to 'test'
1120
-//  - Click the controller to view the LCD menu
1121
-//  - The LCD will display Japanese, Western, or Cyrillic text
1122
-//
1123
-// See https://github.com/MarlinFirmware/Marlin/wiki/LCD-Language
1124
-//
1125
-// :['JAPANESE', 'WESTERN', 'CYRILLIC']
1126
-//
1101
+/**
1102
+ * LCD Character Set
1103
+ *
1104
+ * Note: This option is NOT applicable to Graphical Displays.
1105
+ *
1106
+ * All character-based LCDs provide ASCII plus one of these
1107
+ * language extensions:
1108
+ *
1109
+ *  - JAPANESE ... the most common
1110
+ *  - WESTERN  ... with more accented characters
1111
+ *  - CYRILLIC ... for the Russian language
1112
+ *
1113
+ * To determine the language extension installed on your controller:
1114
+ *
1115
+ *  - Compile and upload with LCD_LANGUAGE set to 'test'
1116
+ *  - Click the controller to view the LCD menu
1117
+ *  - The LCD will display Japanese, Western, or Cyrillic text
1118
+ *
1119
+ * See https: *github.com/MarlinFirmware/Marlin/wiki/LCD-Language
1120
+ *
1121
+ * :['JAPANESE', 'WESTERN', 'CYRILLIC']
1122
+ */
1127 1123
 #define DISPLAY_CHARSET_HD44780 JAPANESE
1128 1124
 
1129
-//
1130
-// LCD TYPE
1131
-//
1132
-// You may choose ULTRA_LCD if you have character based LCD with 16x2, 16x4, 20x2,
1133
-// 20x4 char/lines or DOGLCD for the full graphics display with 128x64 pixels
1134
-// (ST7565R family). (This option will be set automatically for certain displays.)
1135
-//
1136
-// IMPORTANT NOTE: The U8glib library is required for Full Graphic Display!
1137
-//                 https://github.com/olikraus/U8glib_Arduino
1138
-//
1125
+/**
1126
+ * LCD TYPE
1127
+ *
1128
+ * Enable ULTRA_LCD for a 16x2, 16x4, 20x2, or 20x4 character-based LCD.
1129
+ * Enable DOGLCD for a 128x64 (ST7565R) Full Graphical Display.
1130
+ * (These options will be enabled automatically for most displays.)
1131
+ *
1132
+ * IMPORTANT: The U8glib library is required for Full Graphic Display!
1133
+ *            https://github.com/olikraus/U8glib_Arduino
1134
+ */
1139 1135
 //#define ULTRA_LCD   // Character based
1140 1136
 //#define DOGLCD      // Full graphics display
1141 1137
 
1142
-//
1143
-// SD CARD
1144
-//
1145
-// SD Card support is disabled by default. If your controller has an SD slot,
1146
-// you must uncomment the following option or it won't work.
1147
-//
1138
+/**
1139
+ * SD CARD
1140
+ *
1141
+ * SD Card support is disabled by default. If your controller has an SD slot,
1142
+ * you must uncomment the following option or it won't work.
1143
+ *
1144
+ */
1148 1145
 //#define SDSUPPORT
1149 1146
 
1150
-//
1151
-// SD CARD: SPI SPEED
1152
-//
1153
-// Uncomment ONE of the following items to use a slower SPI transfer
1154
-// speed. This is usually required if you're getting volume init errors.
1155
-//
1147
+/**
1148
+ * SD CARD: SPI SPEED
1149
+ *
1150
+ * Enable one of the following items for a slower SPI transfer speed.
1151
+ * This may be required to resolve "volume init" errors.
1152
+ */
1156 1153
 //#define SPI_SPEED SPI_HALF_SPEED
1157 1154
 //#define SPI_SPEED SPI_QUARTER_SPEED
1158 1155
 //#define SPI_SPEED SPI_EIGHTH_SPEED
1159 1156
 
1160
-//
1161
-// SD CARD: ENABLE CRC
1162
-//
1163
-// Use CRC checks and retries on the SD communication.
1164
-//
1157
+/**
1158
+ * SD CARD: ENABLE CRC
1159
+ *
1160
+ * Use CRC checks and retries on the SD communication.
1161
+ */
1165 1162
 //#define SD_CHECK_AND_RETRY
1166 1163
 
1167 1164
 //
@@ -1189,7 +1186,7 @@
1189 1186
  */
1190 1187
 
1191 1188
 //
1192
-// This option reverses the encoder direction everywhere
1189
+// This option reverses the encoder direction everywhere.
1193 1190
 //
1194 1191
 //  Set this option if CLOCKWISE causes values to DECREASE
1195 1192
 //

+ 137
- 140
Marlin/example_configurations/FolgerTech-i3-2020/Configuration.h View File

@@ -991,23 +991,17 @@
991 991
 #define PREHEAT_2_TEMP_BED    110
992 992
 #define PREHEAT_2_FAN_SPEED     0 // Value from 0 to 255
993 993
 
994
-//
995
-// Nozzle Park -- EXPERIMENTAL
996
-//
997
-// When enabled allows the user to define a special XYZ position, inside the
998
-// machine's topology, to park the nozzle when idle or when receiving the G27
999
-// command.
1000
-//
1001
-// The "P" paramenter controls what is the action applied to the Z axis:
1002
-//    P0: (Default) If current Z-pos is lower than Z-park then the nozzle will
1003
-//        be raised to reach Z-park height.
1004
-//
1005
-//    P1: No matter the current Z-pos, the nozzle will be raised/lowered to
1006
-//        reach Z-park height.
1007
-//
1008
-//    P2: The nozzle height will be raised by Z-park amount but never going over
1009
-//        the machine's limit of Z_MAX_POS.
1010
-//
994
+/**
995
+ * Nozzle Park -- EXPERIMENTAL
996
+ *
997
+ * Park the nozzle at the given XYZ position on idle or G27.
998
+ *
999
+ * The "P" parameter controls the action applied to the Z axis:
1000
+ *
1001
+ *    P0  (Default) If Z is below park Z raise the nozzle.
1002
+ *    P1  Raise the nozzle always to Z-park height.
1003
+ *    P2  Raise the nozzle by Z-park amount, limited to Z_MAX_POS.
1004
+ */
1011 1005
 //#define NOZZLE_PARK_FEATURE
1012 1006
 
1013 1007
 #if ENABLED(NOZZLE_PARK_FEATURE)
@@ -1015,44 +1009,44 @@
1015 1009
   #define NOZZLE_PARK_POINT { (X_MIN_POS + 10), (Y_MAX_POS - 10), 20 }
1016 1010
 #endif
1017 1011
 
1018
-//
1019
-// Clean Nozzle Feature -- EXPERIMENTAL
1020
-//
1021
-// When enabled allows the user to send G12 to start the nozzle cleaning
1022
-// process, the G-Code accepts two parameters:
1023
-//   "P" for pattern selection
1024
-//   "S" for defining the number of strokes/repetitions
1025
-//
1026
-// Available list of patterns:
1027
-//   P0: This is the default pattern, this process requires a sponge type
1028
-//       material at a fixed bed location. S defines "strokes" i.e.
1029
-//       back-and-forth movements between the starting and end points.
1030
-//
1031
-//   P1: This starts a zig-zag pattern between (X0, Y0) and (X1, Y1), "T"
1032
-//       defines the number of zig-zag triangles to be done. "S" defines the
1033
-//       number of strokes aka one back-and-forth movement. Zig-zags will
1034
-//       be performed in whichever dimension is smallest. As an example,
1035
-//       sending "G12 P1 S1 T3" will execute:
1036
-//
1037
-//          --
1038
-//         |  (X0, Y1) |     /\        /\        /\     | (X1, Y1)
1039
-//         |           |    /  \      /  \      /  \    |
1040
-//       A |           |   /    \    /    \    /    \   |
1041
-//         |           |  /      \  /      \  /      \  |
1042
-//         |  (X0, Y0) | /        \/        \/        \ | (X1, Y0)
1043
-//          --         +--------------------------------+
1044
-//                       |________|_________|_________|
1045
-//                           T1        T2        T3
1046
-//
1047
-//   P2: This starts a circular pattern with circle with middle in
1048
-//       NOZZLE_CLEAN_CIRCLE_MIDDLE radius of R and stroke count of S.
1049
-//       Before starting the circle nozzle goes to NOZZLE_CLEAN_START_POINT.
1050
-//
1051
-// Caveats: End point Z should use the same value as Start point Z.
1052
-//
1053
-// Attention: This is an EXPERIMENTAL feature, in the future the G-code arguments
1054
-// may change to add new functionality like different wipe patterns.
1055
-//
1012
+/**
1013
+ * Clean Nozzle Feature -- EXPERIMENTAL
1014
+ *
1015
+ * Adds the G12 command to perform a nozzle cleaning process.
1016
+ *
1017
+ * Parameters:
1018
+ *   P  Pattern
1019
+ *   S  Strokes / Repetitions
1020
+ *   T  Triangles (P1 only)
1021
+ *
1022
+ * Patterns:
1023
+ *   P0  Straight line (default). This process requires a sponge type material
1024
+ *       at a fixed bed location. "S" specifies strokes (i.e. back-forth motions)
1025
+ *       between the start / end points.
1026
+ *
1027
+ *   P1  Zig-zag pattern between (X0, Y0) and (X1, Y1), "T" specifies the
1028
+ *       number of zig-zag triangles to do. "S" defines the number of strokes.
1029
+ *       Zig-zags are done in whichever is the narrower dimension.
1030
+ *       For example, "G12 P1 S1 T3" will execute:
1031
+ *
1032
+ *          --
1033
+ *         |  (X0, Y1) |     /\        /\        /\     | (X1, Y1)
1034
+ *         |           |    /  \      /  \      /  \    |
1035
+ *       A |           |   /    \    /    \    /    \   |
1036
+ *         |           |  /      \  /      \  /      \  |
1037
+ *         |  (X0, Y0) | /        \/        \/        \ | (X1, Y0)
1038
+ *          --         +--------------------------------+
1039
+ *                       |________|_________|_________|
1040
+ *                           T1        T2        T3
1041
+ *
1042
+ *   P2  Circular pattern with middle at NOZZLE_CLEAN_CIRCLE_MIDDLE.
1043
+ *       "R" specifies the radius. "S" specifies the stroke count.
1044
+ *       Before starting, the nozzle moves to NOZZLE_CLEAN_START_POINT.
1045
+ *
1046
+ *   Caveats: The ending Z should be the same as starting Z.
1047
+ * Attention: EXPERIMENTAL. G-code arguments may change.
1048
+ *
1049
+ */
1056 1050
 //#define NOZZLE_CLEAN_FEATURE
1057 1051
 
1058 1052
 #if ENABLED(NOZZLE_CLEAN_FEATURE)
@@ -1077,33 +1071,35 @@
1077 1071
   #define NOZZLE_CLEAN_GOBACK
1078 1072
 #endif
1079 1073
 
1080
-//
1081
-// Print job timer
1082
-//
1083
-// Enable this option to automatically start and stop the
1084
-// print job timer when M104/M109/M190 commands are received.
1085
-// M104 (extruder without wait) - high temp = none, low temp = stop timer
1086
-// M109 (extruder with wait) - high temp = start timer, low temp = stop timer
1087
-// M190 (bed with wait) - high temp = start timer, low temp = none
1088
-//
1089
-// In all cases the timer can be started and stopped using
1090
-// the following commands:
1091
-//
1092
-// - M75  - Start the print job timer
1093
-// - M76  - Pause the print job timer
1094
-// - M77  - Stop the print job timer
1074
+/**
1075
+ * Print Job Timer
1076
+ *
1077
+ * Automatically start and stop the print job timer on M104/M109/M190.
1078
+ *
1079
+ *   M104 (hotend, no wait) - high temp = none,        low temp = stop timer
1080
+ *   M109 (hotend, wait)    - high temp = start timer, low temp = stop timer
1081
+ *   M190 (bed, wait)       - high temp = start timer, low temp = none
1082
+ *
1083
+ * The timer can also be controlled with the following commands:
1084
+ *
1085
+ *   M75 - Start the print job timer
1086
+ *   M76 - Pause the print job timer
1087
+ *   M77 - Stop the print job timer
1088
+ */
1095 1089
 #define PRINTJOB_TIMER_AUTOSTART
1096 1090
 
1097
-//
1098
-// Print Counter
1099
-//
1100
-// When enabled Marlin will keep track of some print statistical data such as:
1101
-//  - Total print jobs
1102
-//  - Total successful print jobs
1103
-//  - Total failed print jobs
1104
-//  - Total time printing
1105
-//
1106
-// This information can be viewed by the M78 command.
1091
+/**
1092
+ * Print Counter
1093
+ *
1094
+ * Track statistical data such as:
1095
+ *
1096
+ *  - Total print jobs
1097
+ *  - Total successful print jobs
1098
+ *  - Total failed print jobs
1099
+ *  - Total time printing
1100
+ *
1101
+ * View the current statistics with M78.
1102
+ */
1107 1103
 //#define PRINTCOUNTER
1108 1104
 
1109 1105
 //=============================================================================
@@ -1112,78 +1108,79 @@
1112 1108
 
1113 1109
 // @section lcd
1114 1110
 
1115
-//
1116
-// LCD LANGUAGE
1117
-//
1118
-// Here you may choose the language used by Marlin on the LCD menus, the following
1119
-// list of languages are available:
1120
-//    en, an, bg, ca, cn, cz, de, el, el-gr, es, eu, fi, fr, gl, hr, it,
1121
-//    kana, kana_utf8, nl, pl, pt, pt_utf8, pt-br, pt-br_utf8, ru, tr, uk, test
1122
-//
1123
-// :{ 'en':'English', 'an':'Aragonese', 'bg':'Bulgarian', 'ca':'Catalan', 'cn':'Chinese', 'cz':'Czech', 'de':'German', 'el':'Greek', 'el-gr':'Greek (Greece)', 'es':'Spanish', 'eu':'Basque-Euskera', 'fi':'Finnish', 'fr':'French', 'gl':'Galician', 'hr':'Croatian', 'it':'Italian', 'kana':'Japanese', 'kana_utf8':'Japanese (UTF8)', 'nl':'Dutch', 'pl':'Polish', 'pt':'Portuguese', 'pt-br':'Portuguese (Brazilian)', 'pt-br_utf8':'Portuguese (Brazilian UTF8)', 'pt_utf8':'Portuguese (UTF8)', 'ru':'Russian', 'tr':'Turkish', 'uk':'Ukrainian', 'test':'TEST' }
1124
-//
1111
+/**
1112
+ * LCD LANGUAGE
1113
+ *
1114
+ * Select the language to display on the LCD. These languages are available:
1115
+ *
1116
+ *    en, an, bg, ca, cn, cz, de, el, el-gr, es, eu, fi, fr, gl, hr, it,
1117
+ *    kana, kana_utf8, nl, pl, pt, pt_utf8, pt-br, pt-br_utf8, ru, tr, uk, test
1118
+ *
1119
+ * :{ 'en':'English', 'an':'Aragonese', 'bg':'Bulgarian', 'ca':'Catalan', 'cn':'Chinese', 'cz':'Czech', 'de':'German', 'el':'Greek', 'el-gr':'Greek (Greece)', 'es':'Spanish', 'eu':'Basque-Euskera', 'fi':'Finnish', 'fr':'French', 'gl':'Galician', 'hr':'Croatian', 'it':'Italian', 'kana':'Japanese', 'kana_utf8':'Japanese (UTF8)', 'nl':'Dutch', 'pl':'Polish', 'pt':'Portuguese', 'pt-br':'Portuguese (Brazilian)', 'pt-br_utf8':'Portuguese (Brazilian UTF8)', 'pt_utf8':'Portuguese (UTF8)', 'ru':'Russian', 'tr':'Turkish', 'uk':'Ukrainian', 'test':'TEST' }
1120
+ */
1125 1121
 #define LCD_LANGUAGE en
1126 1122
 
1127
-//
1128
-// LCD Character Set
1129
-//
1130
-// Note: This option is NOT applicable to Graphical Displays.
1131
-//
1132
-// All character-based LCD's provide ASCII plus one of these
1133
-// language extensions:
1134
-//
1135
-//  - JAPANESE ... the most common
1136
-//  - WESTERN  ... with more accented characters
1137
-//  - CYRILLIC ... for the Russian language
1138
-//
1139
-// To determine the language extension installed on your controller:
1140
-//
1141
-//  - Compile and upload with LCD_LANGUAGE set to 'test'
1142
-//  - Click the controller to view the LCD menu
1143
-//  - The LCD will display Japanese, Western, or Cyrillic text
1144
-//
1145
-// See https://github.com/MarlinFirmware/Marlin/wiki/LCD-Language
1146
-//
1147
-// :['JAPANESE', 'WESTERN', 'CYRILLIC']
1148
-//
1123
+/**
1124
+ * LCD Character Set
1125
+ *
1126
+ * Note: This option is NOT applicable to Graphical Displays.
1127
+ *
1128
+ * All character-based LCDs provide ASCII plus one of these
1129
+ * language extensions:
1130
+ *
1131
+ *  - JAPANESE ... the most common
1132
+ *  - WESTERN  ... with more accented characters
1133
+ *  - CYRILLIC ... for the Russian language
1134
+ *
1135
+ * To determine the language extension installed on your controller:
1136
+ *
1137
+ *  - Compile and upload with LCD_LANGUAGE set to 'test'
1138
+ *  - Click the controller to view the LCD menu
1139
+ *  - The LCD will display Japanese, Western, or Cyrillic text
1140
+ *
1141
+ * See https: *github.com/MarlinFirmware/Marlin/wiki/LCD-Language
1142
+ *
1143
+ * :['JAPANESE', 'WESTERN', 'CYRILLIC']
1144
+ */
1149 1145
 #define DISPLAY_CHARSET_HD44780 JAPANESE
1150 1146
 
1151
-//
1152
-// LCD TYPE
1153
-//
1154
-// You may choose ULTRA_LCD if you have character based LCD with 16x2, 16x4, 20x2,
1155
-// 20x4 char/lines or DOGLCD for the full graphics display with 128x64 pixels
1156
-// (ST7565R family). (This option will be set automatically for certain displays.)
1157
-//
1158
-// IMPORTANT NOTE: The U8glib library is required for Full Graphic Display!
1159
-//                 https://github.com/olikraus/U8glib_Arduino
1160
-//
1147
+/**
1148
+ * LCD TYPE
1149
+ *
1150
+ * Enable ULTRA_LCD for a 16x2, 16x4, 20x2, or 20x4 character-based LCD.
1151
+ * Enable DOGLCD for a 128x64 (ST7565R) Full Graphical Display.
1152
+ * (These options will be enabled automatically for most displays.)
1153
+ *
1154
+ * IMPORTANT: The U8glib library is required for Full Graphic Display!
1155
+ *            https://github.com/olikraus/U8glib_Arduino
1156
+ */
1161 1157
 //#define ULTRA_LCD   // Character based
1162 1158
 //#define DOGLCD      // Full graphics display
1163 1159
 
1164
-//
1165
-// SD CARD
1166
-//
1167
-// SD Card support is disabled by default. If your controller has an SD slot,
1168
-// you must uncomment the following option or it won't work.
1169
-//
1160
+/**
1161
+ * SD CARD
1162
+ *
1163
+ * SD Card support is disabled by default. If your controller has an SD slot,
1164
+ * you must uncomment the following option or it won't work.
1165
+ *
1166
+ */
1170 1167
 #define SDSUPPORT
1171 1168
 
1172
-//
1173
-// SD CARD: SPI SPEED
1174
-//
1175
-// Uncomment ONE of the following items to use a slower SPI transfer
1176
-// speed. This is usually required if you're getting volume init errors.
1177
-//
1169
+/**
1170
+ * SD CARD: SPI SPEED
1171
+ *
1172
+ * Enable one of the following items for a slower SPI transfer speed.
1173
+ * This may be required to resolve "volume init" errors.
1174
+ */
1178 1175
 //#define SPI_SPEED SPI_HALF_SPEED
1179 1176
 //#define SPI_SPEED SPI_QUARTER_SPEED
1180 1177
 //#define SPI_SPEED SPI_EIGHTH_SPEED
1181 1178
 
1182
-//
1183
-// SD CARD: ENABLE CRC
1184
-//
1185
-// Use CRC checks and retries on the SD communication.
1186
-//
1179
+/**
1180
+ * SD CARD: ENABLE CRC
1181
+ *
1182
+ * Use CRC checks and retries on the SD communication.
1183
+ */
1187 1184
 #define SD_CHECK_AND_RETRY
1188 1185
 
1189 1186
 //
@@ -1211,7 +1208,7 @@
1211 1208
  */
1212 1209
 
1213 1210
 //
1214
-// This option reverses the encoder direction everywhere
1211
+// This option reverses the encoder direction everywhere.
1215 1212
 //
1216 1213
 //  Set this option if CLOCKWISE causes values to DECREASE
1217 1214
 //

+ 137
- 140
Marlin/example_configurations/Hephestos/Configuration.h View File

@@ -977,23 +977,17 @@
977 977
 #define PREHEAT_2_TEMP_BED    100
978 978
 #define PREHEAT_2_FAN_SPEED   255 // Value from 0 to 255
979 979
 
980
-//
981
-// Nozzle Park -- EXPERIMENTAL
982
-//
983
-// When enabled allows the user to define a special XYZ position, inside the
984
-// machine's topology, to park the nozzle when idle or when receiving the G27
985
-// command.
986
-//
987
-// The "P" paramenter controls what is the action applied to the Z axis:
988
-//    P0: (Default) If current Z-pos is lower than Z-park then the nozzle will
989
-//        be raised to reach Z-park height.
990
-//
991
-//    P1: No matter the current Z-pos, the nozzle will be raised/lowered to
992
-//        reach Z-park height.
993
-//
994
-//    P2: The nozzle height will be raised by Z-park amount but never going over
995
-//        the machine's limit of Z_MAX_POS.
996
-//
980
+/**
981
+ * Nozzle Park -- EXPERIMENTAL
982
+ *
983
+ * Park the nozzle at the given XYZ position on idle or G27.
984
+ *
985
+ * The "P" parameter controls the action applied to the Z axis:
986
+ *
987
+ *    P0  (Default) If Z is below park Z raise the nozzle.
988
+ *    P1  Raise the nozzle always to Z-park height.
989
+ *    P2  Raise the nozzle by Z-park amount, limited to Z_MAX_POS.
990
+ */
997 991
 //#define NOZZLE_PARK_FEATURE
998 992
 
999 993
 #if ENABLED(NOZZLE_PARK_FEATURE)
@@ -1001,44 +995,44 @@
1001 995
   #define NOZZLE_PARK_POINT { (X_MIN_POS + 10), (Y_MAX_POS - 10), 20 }
1002 996
 #endif
1003 997
 
1004
-//
1005
-// Clean Nozzle Feature -- EXPERIMENTAL
1006
-//
1007
-// When enabled allows the user to send G12 to start the nozzle cleaning
1008
-// process, the G-Code accepts two parameters:
1009
-//   "P" for pattern selection
1010
-//   "S" for defining the number of strokes/repetitions
1011
-//
1012
-// Available list of patterns:
1013
-//   P0: This is the default pattern, this process requires a sponge type
1014
-//       material at a fixed bed location. S defines "strokes" i.e.
1015
-//       back-and-forth movements between the starting and end points.
1016
-//
1017
-//   P1: This starts a zig-zag pattern between (X0, Y0) and (X1, Y1), "T"
1018
-//       defines the number of zig-zag triangles to be done. "S" defines the
1019
-//       number of strokes aka one back-and-forth movement. Zig-zags will
1020
-//       be performed in whichever dimension is smallest. As an example,
1021
-//       sending "G12 P1 S1 T3" will execute:
1022
-//
1023
-//          --
1024
-//         |  (X0, Y1) |     /\        /\        /\     | (X1, Y1)
1025
-//         |           |    /  \      /  \      /  \    |
1026
-//       A |           |   /    \    /    \    /    \   |
1027
-//         |           |  /      \  /      \  /      \  |
1028
-//         |  (X0, Y0) | /        \/        \/        \ | (X1, Y0)
1029
-//          --         +--------------------------------+
1030
-//                       |________|_________|_________|
1031
-//                           T1        T2        T3
1032
-//
1033
-//   P2: This starts a circular pattern with circle with middle in
1034
-//       NOZZLE_CLEAN_CIRCLE_MIDDLE radius of R and stroke count of S.
1035
-//       Before starting the circle nozzle goes to NOZZLE_CLEAN_START_POINT.
1036
-//
1037
-// Caveats: End point Z should use the same value as Start point Z.
1038
-//
1039
-// Attention: This is an EXPERIMENTAL feature, in the future the G-code arguments
1040
-// may change to add new functionality like different wipe patterns.
1041
-//
998
+/**
999
+ * Clean Nozzle Feature -- EXPERIMENTAL
1000
+ *
1001
+ * Adds the G12 command to perform a nozzle cleaning process.
1002
+ *
1003
+ * Parameters:
1004
+ *   P  Pattern
1005
+ *   S  Strokes / Repetitions
1006
+ *   T  Triangles (P1 only)
1007
+ *
1008
+ * Patterns:
1009
+ *   P0  Straight line (default). This process requires a sponge type material
1010
+ *       at a fixed bed location. "S" specifies strokes (i.e. back-forth motions)
1011
+ *       between the start / end points.
1012
+ *
1013
+ *   P1  Zig-zag pattern between (X0, Y0) and (X1, Y1), "T" specifies the
1014
+ *       number of zig-zag triangles to do. "S" defines the number of strokes.
1015
+ *       Zig-zags are done in whichever is the narrower dimension.
1016
+ *       For example, "G12 P1 S1 T3" will execute:
1017
+ *
1018
+ *          --
1019
+ *         |  (X0, Y1) |     /\        /\        /\     | (X1, Y1)
1020
+ *         |           |    /  \      /  \      /  \    |
1021
+ *       A |           |   /    \    /    \    /    \   |
1022
+ *         |           |  /      \  /      \  /      \  |
1023
+ *         |  (X0, Y0) | /        \/        \/        \ | (X1, Y0)
1024
+ *          --         +--------------------------------+
1025
+ *                       |________|_________|_________|
1026
+ *                           T1        T2        T3
1027
+ *
1028
+ *   P2  Circular pattern with middle at NOZZLE_CLEAN_CIRCLE_MIDDLE.
1029
+ *       "R" specifies the radius. "S" specifies the stroke count.
1030
+ *       Before starting, the nozzle moves to NOZZLE_CLEAN_START_POINT.
1031
+ *
1032
+ *   Caveats: The ending Z should be the same as starting Z.
1033
+ * Attention: EXPERIMENTAL. G-code arguments may change.
1034
+ *
1035
+ */
1042 1036
 //#define NOZZLE_CLEAN_FEATURE
1043 1037
 
1044 1038
 #if ENABLED(NOZZLE_CLEAN_FEATURE)
@@ -1063,33 +1057,35 @@
1063 1057
   #define NOZZLE_CLEAN_GOBACK
1064 1058
 #endif
1065 1059
 
1066
-//
1067
-// Print job timer
1068
-//
1069
-// Enable this option to automatically start and stop the
1070
-// print job timer when M104/M109/M190 commands are received.
1071
-// M104 (extruder without wait) - high temp = none, low temp = stop timer
1072
-// M109 (extruder with wait) - high temp = start timer, low temp = stop timer
1073
-// M190 (bed with wait) - high temp = start timer, low temp = none
1074
-//
1075
-// In all cases the timer can be started and stopped using
1076
-// the following commands:
1077
-//
1078
-// - M75  - Start the print job timer
1079
-// - M76  - Pause the print job timer
1080
-// - M77  - Stop the print job timer
1060
+/**
1061
+ * Print Job Timer
1062
+ *
1063
+ * Automatically start and stop the print job timer on M104/M109/M190.
1064
+ *
1065
+ *   M104 (hotend, no wait) - high temp = none,        low temp = stop timer
1066
+ *   M109 (hotend, wait)    - high temp = start timer, low temp = stop timer
1067
+ *   M190 (bed, wait)       - high temp = start timer, low temp = none
1068
+ *
1069
+ * The timer can also be controlled with the following commands:
1070
+ *
1071
+ *   M75 - Start the print job timer
1072
+ *   M76 - Pause the print job timer
1073
+ *   M77 - Stop the print job timer
1074
+ */
1081 1075
 #define PRINTJOB_TIMER_AUTOSTART
1082 1076
 
1083
-//
1084
-// Print Counter
1085
-//
1086
-// When enabled Marlin will keep track of some print statistical data such as:
1087
-//  - Total print jobs
1088
-//  - Total successful print jobs
1089
-//  - Total failed print jobs
1090
-//  - Total time printing
1091
-//
1092
-// This information can be viewed by the M78 command.
1077
+/**
1078
+ * Print Counter
1079
+ *
1080
+ * Track statistical data such as:
1081
+ *
1082
+ *  - Total print jobs
1083
+ *  - Total successful print jobs
1084
+ *  - Total failed print jobs
1085
+ *  - Total time printing
1086
+ *
1087
+ * View the current statistics with M78.
1088
+ */
1093 1089
 //#define PRINTCOUNTER
1094 1090
 
1095 1091
 //=============================================================================
@@ -1098,78 +1094,79 @@
1098 1094
 
1099 1095
 // @section lcd
1100 1096
 
1101
-//
1102
-// LCD LANGUAGE
1103
-//
1104
-// Here you may choose the language used by Marlin on the LCD menus, the following
1105
-// list of languages are available:
1106
-//    en, an, bg, ca, cn, cz, de, el, el-gr, es, eu, fi, fr, gl, hr, it,
1107
-//    kana, kana_utf8, nl, pl, pt, pt_utf8, pt-br, pt-br_utf8, ru, tr, uk, test
1108
-//
1109
-// :{ 'en':'English', 'an':'Aragonese', 'bg':'Bulgarian', 'ca':'Catalan', 'cn':'Chinese', 'cz':'Czech', 'de':'German', 'el':'Greek', 'el-gr':'Greek (Greece)', 'es':'Spanish', 'eu':'Basque-Euskera', 'fi':'Finnish', 'fr':'French', 'gl':'Galician', 'hr':'Croatian', 'it':'Italian', 'kana':'Japanese', 'kana_utf8':'Japanese (UTF8)', 'nl':'Dutch', 'pl':'Polish', 'pt':'Portuguese', 'pt-br':'Portuguese (Brazilian)', 'pt-br_utf8':'Portuguese (Brazilian UTF8)', 'pt_utf8':'Portuguese (UTF8)', 'ru':'Russian', 'tr':'Turkish', 'uk':'Ukrainian', 'test':'TEST' }
1110
-//
1097
+/**
1098
+ * LCD LANGUAGE
1099
+ *
1100
+ * Select the language to display on the LCD. These languages are available:
1101
+ *
1102
+ *    en, an, bg, ca, cn, cz, de, el, el-gr, es, eu, fi, fr, gl, hr, it,
1103
+ *    kana, kana_utf8, nl, pl, pt, pt_utf8, pt-br, pt-br_utf8, ru, tr, uk, test
1104
+ *
1105
+ * :{ 'en':'English', 'an':'Aragonese', 'bg':'Bulgarian', 'ca':'Catalan', 'cn':'Chinese', 'cz':'Czech', 'de':'German', 'el':'Greek', 'el-gr':'Greek (Greece)', 'es':'Spanish', 'eu':'Basque-Euskera', 'fi':'Finnish', 'fr':'French', 'gl':'Galician', 'hr':'Croatian', 'it':'Italian', 'kana':'Japanese', 'kana_utf8':'Japanese (UTF8)', 'nl':'Dutch', 'pl':'Polish', 'pt':'Portuguese', 'pt-br':'Portuguese (Brazilian)', 'pt-br_utf8':'Portuguese (Brazilian UTF8)', 'pt_utf8':'Portuguese (UTF8)', 'ru':'Russian', 'tr':'Turkish', 'uk':'Ukrainian', 'test':'TEST' }
1106
+ */
1111 1107
 //#define LCD_LANGUAGE en
1112 1108
 
1113
-//
1114
-// LCD Character Set
1115
-//
1116
-// Note: This option is NOT applicable to Graphical Displays.
1117
-//
1118
-// All character-based LCD's provide ASCII plus one of these
1119
-// language extensions:
1120
-//
1121
-//  - JAPANESE ... the most common
1122
-//  - WESTERN  ... with more accented characters
1123
-//  - CYRILLIC ... for the Russian language
1124
-//
1125
-// To determine the language extension installed on your controller:
1126
-//
1127
-//  - Compile and upload with LCD_LANGUAGE set to 'test'
1128
-//  - Click the controller to view the LCD menu
1129
-//  - The LCD will display Japanese, Western, or Cyrillic text
1130
-//
1131
-// See https://github.com/MarlinFirmware/Marlin/wiki/LCD-Language
1132
-//
1133
-// :['JAPANESE', 'WESTERN', 'CYRILLIC']
1134
-//
1109
+/**
1110
+ * LCD Character Set
1111
+ *
1112
+ * Note: This option is NOT applicable to Graphical Displays.
1113
+ *
1114
+ * All character-based LCDs provide ASCII plus one of these
1115
+ * language extensions:
1116
+ *
1117
+ *  - JAPANESE ... the most common
1118
+ *  - WESTERN  ... with more accented characters
1119
+ *  - CYRILLIC ... for the Russian language
1120
+ *
1121
+ * To determine the language extension installed on your controller:
1122
+ *
1123
+ *  - Compile and upload with LCD_LANGUAGE set to 'test'
1124
+ *  - Click the controller to view the LCD menu
1125
+ *  - The LCD will display Japanese, Western, or Cyrillic text
1126
+ *
1127
+ * See https: *github.com/MarlinFirmware/Marlin/wiki/LCD-Language
1128
+ *
1129
+ * :['JAPANESE', 'WESTERN', 'CYRILLIC']
1130
+ */
1135 1131
 #define DISPLAY_CHARSET_HD44780 JAPANESE
1136 1132
 
1137
-//
1138
-// LCD TYPE
1139
-//
1140
-// You may choose ULTRA_LCD if you have character based LCD with 16x2, 16x4, 20x2,
1141
-// 20x4 char/lines or DOGLCD for the full graphics display with 128x64 pixels
1142
-// (ST7565R family). (This option will be set automatically for certain displays.)
1143
-//
1144
-// IMPORTANT NOTE: The U8glib library is required for Full Graphic Display!
1145
-//                 https://github.com/olikraus/U8glib_Arduino
1146
-//
1133
+/**
1134
+ * LCD TYPE
1135
+ *
1136
+ * Enable ULTRA_LCD for a 16x2, 16x4, 20x2, or 20x4 character-based LCD.
1137
+ * Enable DOGLCD for a 128x64 (ST7565R) Full Graphical Display.
1138
+ * (These options will be enabled automatically for most displays.)
1139
+ *
1140
+ * IMPORTANT: The U8glib library is required for Full Graphic Display!
1141
+ *            https://github.com/olikraus/U8glib_Arduino
1142
+ */
1147 1143
 #define ULTRA_LCD   // Character based
1148 1144
 //#define DOGLCD      // Full graphics display
1149 1145
 
1150
-//
1151
-// SD CARD
1152
-//
1153
-// SD Card support is disabled by default. If your controller has an SD slot,
1154
-// you must uncomment the following option or it won't work.
1155
-//
1146
+/**
1147
+ * SD CARD
1148
+ *
1149
+ * SD Card support is disabled by default. If your controller has an SD slot,
1150
+ * you must uncomment the following option or it won't work.
1151
+ *
1152
+ */
1156 1153
 #define SDSUPPORT
1157 1154
 
1158
-//
1159
-// SD CARD: SPI SPEED
1160
-//
1161
-// Uncomment ONE of the following items to use a slower SPI transfer
1162
-// speed. This is usually required if you're getting volume init errors.
1163
-//
1155
+/**
1156
+ * SD CARD: SPI SPEED
1157
+ *
1158
+ * Enable one of the following items for a slower SPI transfer speed.
1159
+ * This may be required to resolve "volume init" errors.
1160
+ */
1164 1161
 //#define SPI_SPEED SPI_HALF_SPEED
1165 1162
 //#define SPI_SPEED SPI_QUARTER_SPEED
1166 1163
 //#define SPI_SPEED SPI_EIGHTH_SPEED
1167 1164
 
1168
-//
1169
-// SD CARD: ENABLE CRC
1170
-//
1171
-// Use CRC checks and retries on the SD communication.
1172
-//
1165
+/**
1166
+ * SD CARD: ENABLE CRC
1167
+ *
1168
+ * Use CRC checks and retries on the SD communication.
1169
+ */
1173 1170
 //#define SD_CHECK_AND_RETRY
1174 1171
 
1175 1172
 //
@@ -1197,7 +1194,7 @@
1197 1194
  */
1198 1195
 
1199 1196
 //
1200
-// This option reverses the encoder direction everywhere
1197
+// This option reverses the encoder direction everywhere.
1201 1198
 //
1202 1199
 //  Set this option if CLOCKWISE causes values to DECREASE
1203 1200
 //

+ 137
- 140
Marlin/example_configurations/Hephestos_2/Configuration.h View File

@@ -980,23 +980,17 @@
980 980
 #define PREHEAT_2_TEMP_BED    110
981 981
 #define PREHEAT_2_FAN_SPEED     0 // Value from 0 to 255
982 982
 
983
-//
984
-// Nozzle Park -- EXPERIMENTAL
985
-//
986
-// When enabled allows the user to define a special XYZ position, inside the
987
-// machine's topology, to park the nozzle when idle or when receiving the G27
988
-// command.
989
-//
990
-// The "P" paramenter controls what is the action applied to the Z axis:
991
-//    P0: (Default) If current Z-pos is lower than Z-park then the nozzle will
992
-//        be raised to reach Z-park height.
993
-//
994
-//    P1: No matter the current Z-pos, the nozzle will be raised/lowered to
995
-//        reach Z-park height.
996
-//
997
-//    P2: The nozzle height will be raised by Z-park amount but never going over
998
-//        the machine's limit of Z_MAX_POS.
999
-//
983
+/**
984
+ * Nozzle Park -- EXPERIMENTAL
985
+ *
986
+ * Park the nozzle at the given XYZ position on idle or G27.
987
+ *
988
+ * The "P" parameter controls the action applied to the Z axis:
989
+ *
990
+ *    P0  (Default) If Z is below park Z raise the nozzle.
991
+ *    P1  Raise the nozzle always to Z-park height.
992
+ *    P2  Raise the nozzle by Z-park amount, limited to Z_MAX_POS.
993
+ */
1000 994
 #define NOZZLE_PARK_FEATURE
1001 995
 
1002 996
 #if ENABLED(NOZZLE_PARK_FEATURE)
@@ -1004,44 +998,44 @@
1004 998
   #define NOZZLE_PARK_POINT { (X_MIN_POS + 10), (Y_MAX_POS - 10), 10 }
1005 999
 #endif
1006 1000
 
1007
-//
1008
-// Clean Nozzle Feature -- EXPERIMENTAL
1009
-//
1010
-// When enabled allows the user to send G12 to start the nozzle cleaning
1011
-// process, the G-Code accepts two parameters:
1012
-//   "P" for pattern selection
1013
-//   "S" for defining the number of strokes/repetitions
1014
-//
1015
-// Available list of patterns:
1016
-//   P0: This is the default pattern, this process requires a sponge type
1017
-//       material at a fixed bed location. S defines "strokes" i.e.
1018
-//       back-and-forth movements between the starting and end points.
1019
-//
1020
-//   P1: This starts a zig-zag pattern between (X0, Y0) and (X1, Y1), "T"
1021
-//       defines the number of zig-zag triangles to be done. "S" defines the
1022
-//       number of strokes aka one back-and-forth movement. Zig-zags will
1023
-//       be performed in whichever dimension is smallest. As an example,
1024
-//       sending "G12 P1 S1 T3" will execute:
1025
-//
1026
-//          --
1027
-//         |  (X0, Y1) |     /\        /\        /\     | (X1, Y1)
1028
-//         |           |    /  \      /  \      /  \    |
1029
-//       A |           |   /    \    /    \    /    \   |
1030
-//         |           |  /      \  /      \  /      \  |
1031
-//         |  (X0, Y0) | /        \/        \/        \ | (X1, Y0)
1032
-//          --         +--------------------------------+
1033
-//                       |________|_________|_________|
1034
-//                           T1        T2        T3
1035
-//
1036
-//   P2: This starts a circular pattern with circle with middle in
1037
-//       NOZZLE_CLEAN_CIRCLE_MIDDLE radius of R and stroke count of S.
1038
-//       Before starting the circle nozzle goes to NOZZLE_CLEAN_START_POINT.
1039
-//
1040
-// Caveats: End point Z should use the same value as Start point Z.
1041
-//
1042
-// Attention: This is an EXPERIMENTAL feature, in the future the G-code arguments
1043
-// may change to add new functionality like different wipe patterns.
1044
-//
1001
+/**
1002
+ * Clean Nozzle Feature -- EXPERIMENTAL
1003
+ *
1004
+ * Adds the G12 command to perform a nozzle cleaning process.
1005
+ *
1006
+ * Parameters:
1007
+ *   P  Pattern
1008
+ *   S  Strokes / Repetitions
1009
+ *   T  Triangles (P1 only)
1010
+ *
1011
+ * Patterns:
1012
+ *   P0  Straight line (default). This process requires a sponge type material
1013
+ *       at a fixed bed location. "S" specifies strokes (i.e. back-forth motions)
1014
+ *       between the start / end points.
1015
+ *
1016
+ *   P1  Zig-zag pattern between (X0, Y0) and (X1, Y1), "T" specifies the
1017
+ *       number of zig-zag triangles to do. "S" defines the number of strokes.
1018
+ *       Zig-zags are done in whichever is the narrower dimension.
1019
+ *       For example, "G12 P1 S1 T3" will execute:
1020
+ *
1021
+ *          --
1022
+ *         |  (X0, Y1) |     /\        /\        /\     | (X1, Y1)
1023
+ *         |           |    /  \      /  \      /  \    |
1024
+ *       A |           |   /    \    /    \    /    \   |
1025
+ *         |           |  /      \  /      \  /      \  |
1026
+ *         |  (X0, Y0) | /        \/        \/        \ | (X1, Y0)
1027
+ *          --         +--------------------------------+
1028
+ *                       |________|_________|_________|
1029
+ *                           T1        T2        T3
1030
+ *
1031
+ *   P2  Circular pattern with middle at NOZZLE_CLEAN_CIRCLE_MIDDLE.
1032
+ *       "R" specifies the radius. "S" specifies the stroke count.
1033
+ *       Before starting, the nozzle moves to NOZZLE_CLEAN_START_POINT.
1034
+ *
1035
+ *   Caveats: The ending Z should be the same as starting Z.
1036
+ * Attention: EXPERIMENTAL. G-code arguments may change.
1037
+ *
1038
+ */
1045 1039
 #define NOZZLE_CLEAN_FEATURE
1046 1040
 
1047 1041
 #if ENABLED(NOZZLE_CLEAN_FEATURE)
@@ -1066,33 +1060,35 @@
1066 1060
   //#define NOZZLE_CLEAN_GOBACK
1067 1061
 #endif
1068 1062
 
1069
-//
1070
-// Print job timer
1071
-//
1072
-// Enable this option to automatically start and stop the
1073
-// print job timer when M104/M109/M190 commands are received.
1074
-// M104 (extruder without wait) - high temp = none, low temp = stop timer
1075
-// M109 (extruder with wait) - high temp = start timer, low temp = stop timer
1076
-// M190 (bed with wait) - high temp = start timer, low temp = none
1077
-//
1078
-// In all cases the timer can be started and stopped using
1079
-// the following commands:
1080
-//
1081
-// - M75  - Start the print job timer
1082
-// - M76  - Pause the print job timer
1083
-// - M77  - Stop the print job timer
1063
+/**
1064
+ * Print Job Timer
1065
+ *
1066
+ * Automatically start and stop the print job timer on M104/M109/M190.
1067
+ *
1068
+ *   M104 (hotend, no wait) - high temp = none,        low temp = stop timer
1069
+ *   M109 (hotend, wait)    - high temp = start timer, low temp = stop timer
1070
+ *   M190 (bed, wait)       - high temp = start timer, low temp = none
1071
+ *
1072
+ * The timer can also be controlled with the following commands:
1073
+ *
1074
+ *   M75 - Start the print job timer
1075
+ *   M76 - Pause the print job timer
1076
+ *   M77 - Stop the print job timer
1077
+ */
1084 1078
 #define PRINTJOB_TIMER_AUTOSTART
1085 1079
 
1086
-//
1087
-// Print Counter
1088
-//
1089
-// When enabled Marlin will keep track of some print statistical data such as:
1090
-//  - Total print jobs
1091
-//  - Total successful print jobs
1092
-//  - Total failed print jobs
1093
-//  - Total time printing
1094
-//
1095
-// This information can be viewed by the M78 command.
1080
+/**
1081
+ * Print Counter
1082
+ *
1083
+ * Track statistical data such as:
1084
+ *
1085
+ *  - Total print jobs
1086
+ *  - Total successful print jobs
1087
+ *  - Total failed print jobs
1088
+ *  - Total time printing
1089
+ *
1090
+ * View the current statistics with M78.
1091
+ */
1096 1092
 #define PRINTCOUNTER
1097 1093
 
1098 1094
 //=============================================================================
@@ -1101,78 +1097,79 @@
1101 1097
 
1102 1098
 // @section lcd
1103 1099
 
1104
-//
1105
-// LCD LANGUAGE
1106
-//
1107
-// Here you may choose the language used by Marlin on the LCD menus, the following
1108
-// list of languages are available:
1109
-//    en, an, bg, ca, cn, cz, de, el, el-gr, es, eu, fi, fr, gl, hr, it,
1110
-//    kana, kana_utf8, nl, pl, pt, pt_utf8, pt-br, pt-br_utf8, ru, tr, uk, test
1111
-//
1112
-// :{ 'en':'English', 'an':'Aragonese', 'bg':'Bulgarian', 'ca':'Catalan', 'cn':'Chinese', 'cz':'Czech', 'de':'German', 'el':'Greek', 'el-gr':'Greek (Greece)', 'es':'Spanish', 'eu':'Basque-Euskera', 'fi':'Finnish', 'fr':'French', 'gl':'Galician', 'hr':'Croatian', 'it':'Italian', 'kana':'Japanese', 'kana_utf8':'Japanese (UTF8)', 'nl':'Dutch', 'pl':'Polish', 'pt':'Portuguese', 'pt-br':'Portuguese (Brazilian)', 'pt-br_utf8':'Portuguese (Brazilian UTF8)', 'pt_utf8':'Portuguese (UTF8)', 'ru':'Russian', 'tr':'Turkish', 'uk':'Ukrainian', 'test':'TEST' }
1113
-//
1100
+/**
1101
+ * LCD LANGUAGE
1102
+ *
1103
+ * Select the language to display on the LCD. These languages are available:
1104
+ *
1105
+ *    en, an, bg, ca, cn, cz, de, el, el-gr, es, eu, fi, fr, gl, hr, it,
1106
+ *    kana, kana_utf8, nl, pl, pt, pt_utf8, pt-br, pt-br_utf8, ru, tr, uk, test
1107
+ *
1108
+ * :{ 'en':'English', 'an':'Aragonese', 'bg':'Bulgarian', 'ca':'Catalan', 'cn':'Chinese', 'cz':'Czech', 'de':'German', 'el':'Greek', 'el-gr':'Greek (Greece)', 'es':'Spanish', 'eu':'Basque-Euskera', 'fi':'Finnish', 'fr':'French', 'gl':'Galician', 'hr':'Croatian', 'it':'Italian', 'kana':'Japanese', 'kana_utf8':'Japanese (UTF8)', 'nl':'Dutch', 'pl':'Polish', 'pt':'Portuguese', 'pt-br':'Portuguese (Brazilian)', 'pt-br_utf8':'Portuguese (Brazilian UTF8)', 'pt_utf8':'Portuguese (UTF8)', 'ru':'Russian', 'tr':'Turkish', 'uk':'Ukrainian', 'test':'TEST' }
1109
+ */
1114 1110
 #define LCD_LANGUAGE en
1115 1111
 
1116
-//
1117
-// LCD Character Set
1118
-//
1119
-// Note: This option is NOT applicable to Graphical Displays.
1120
-//
1121
-// All character-based LCD's provide ASCII plus one of these
1122
-// language extensions:
1123
-//
1124
-//  - JAPANESE ... the most common
1125
-//  - WESTERN  ... with more accented characters
1126
-//  - CYRILLIC ... for the Russian language
1127
-//
1128
-// To determine the language extension installed on your controller:
1129
-//
1130
-//  - Compile and upload with LCD_LANGUAGE set to 'test'
1131
-//  - Click the controller to view the LCD menu
1132
-//  - The LCD will display Japanese, Western, or Cyrillic text
1133
-//
1134
-// See https://github.com/MarlinFirmware/Marlin/wiki/LCD-Language
1135
-//
1136
-// :['JAPANESE', 'WESTERN', 'CYRILLIC']
1137
-//
1112
+/**
1113
+ * LCD Character Set
1114
+ *
1115
+ * Note: This option is NOT applicable to Graphical Displays.
1116
+ *
1117
+ * All character-based LCDs provide ASCII plus one of these
1118
+ * language extensions:
1119
+ *
1120
+ *  - JAPANESE ... the most common
1121
+ *  - WESTERN  ... with more accented characters
1122
+ *  - CYRILLIC ... for the Russian language
1123
+ *
1124
+ * To determine the language extension installed on your controller:
1125
+ *
1126
+ *  - Compile and upload with LCD_LANGUAGE set to 'test'
1127
+ *  - Click the controller to view the LCD menu
1128
+ *  - The LCD will display Japanese, Western, or Cyrillic text
1129
+ *
1130
+ * See https: *github.com/MarlinFirmware/Marlin/wiki/LCD-Language
1131
+ *
1132
+ * :['JAPANESE', 'WESTERN', 'CYRILLIC']
1133
+ */
1138 1134
 #define DISPLAY_CHARSET_HD44780 JAPANESE
1139 1135
 
1140
-//
1141
-// LCD TYPE
1142
-//
1143
-// You may choose ULTRA_LCD if you have character based LCD with 16x2, 16x4, 20x2,
1144
-// 20x4 char/lines or DOGLCD for the full graphics display with 128x64 pixels
1145
-// (ST7565R family). (This option will be set automatically for certain displays.)
1146
-//
1147
-// IMPORTANT NOTE: The U8glib library is required for Full Graphic Display!
1148
-//                 https://github.com/olikraus/U8glib_Arduino
1149
-//
1136
+/**
1137
+ * LCD TYPE
1138
+ *
1139
+ * Enable ULTRA_LCD for a 16x2, 16x4, 20x2, or 20x4 character-based LCD.
1140
+ * Enable DOGLCD for a 128x64 (ST7565R) Full Graphical Display.
1141
+ * (These options will be enabled automatically for most displays.)
1142
+ *
1143
+ * IMPORTANT: The U8glib library is required for Full Graphic Display!
1144
+ *            https://github.com/olikraus/U8glib_Arduino
1145
+ */
1150 1146
 //#define ULTRA_LCD   // Character based
1151 1147
 //#define DOGLCD      // Full graphics display
1152 1148
 
1153
-//
1154
-// SD CARD
1155
-//
1156
-// SD Card support is disabled by default. If your controller has an SD slot,
1157
-// you must uncomment the following option or it won't work.
1158
-//
1149
+/**
1150
+ * SD CARD
1151
+ *
1152
+ * SD Card support is disabled by default. If your controller has an SD slot,
1153
+ * you must uncomment the following option or it won't work.
1154
+ *
1155
+ */
1159 1156
 #define SDSUPPORT
1160 1157
 
1161
-//
1162
-// SD CARD: SPI SPEED
1163
-//
1164
-// Uncomment ONE of the following items to use a slower SPI transfer
1165
-// speed. This is usually required if you're getting volume init errors.
1166
-//
1158
+/**
1159
+ * SD CARD: SPI SPEED
1160
+ *
1161
+ * Enable one of the following items for a slower SPI transfer speed.
1162
+ * This may be required to resolve "volume init" errors.
1163
+ */
1167 1164
 //#define SPI_SPEED SPI_HALF_SPEED
1168 1165
 //#define SPI_SPEED SPI_QUARTER_SPEED
1169 1166
 //#define SPI_SPEED SPI_EIGHTH_SPEED
1170 1167
 
1171
-//
1172
-// SD CARD: ENABLE CRC
1173
-//
1174
-// Use CRC checks and retries on the SD communication.
1175
-//
1168
+/**
1169
+ * SD CARD: ENABLE CRC
1170
+ *
1171
+ * Use CRC checks and retries on the SD communication.
1172
+ */
1176 1173
 #define SD_CHECK_AND_RETRY
1177 1174
 
1178 1175
 //
@@ -1200,7 +1197,7 @@
1200 1197
  */
1201 1198
 
1202 1199
 //
1203
-// This option reverses the encoder direction everywhere
1200
+// This option reverses the encoder direction everywhere.
1204 1201
 //
1205 1202
 //  Set this option if CLOCKWISE causes values to DECREASE
1206 1203
 //

+ 137
- 140
Marlin/example_configurations/K8200/Configuration.h View File

@@ -1015,23 +1015,17 @@
1015 1015
 #define PREHEAT_2_TEMP_BED     60 // K8200: ABS / set back to 110 if you have an upgraded heatbed power supply
1016 1016
 #define PREHEAT_2_FAN_SPEED     0 // Value from 0 to 255
1017 1017
 
1018
-//
1019
-// Nozzle Park -- EXPERIMENTAL
1020
-//
1021
-// When enabled allows the user to define a special XYZ position, inside the
1022
-// machine's topology, to park the nozzle when idle or when receiving the G27
1023
-// command.
1024
-//
1025
-// The "P" paramenter controls what is the action applied to the Z axis:
1026
-//    P0: (Default) If current Z-pos is lower than Z-park then the nozzle will
1027
-//        be raised to reach Z-park height.
1028
-//
1029
-//    P1: No matter the current Z-pos, the nozzle will be raised/lowered to
1030
-//        reach Z-park height.
1031
-//
1032
-//    P2: The nozzle height will be raised by Z-park amount but never going over
1033
-//        the machine's limit of Z_MAX_POS.
1034
-//
1018
+/**
1019
+ * Nozzle Park -- EXPERIMENTAL
1020
+ *
1021
+ * Park the nozzle at the given XYZ position on idle or G27.
1022
+ *
1023
+ * The "P" parameter controls the action applied to the Z axis:
1024
+ *
1025
+ *    P0  (Default) If Z is below park Z raise the nozzle.
1026
+ *    P1  Raise the nozzle always to Z-park height.
1027
+ *    P2  Raise the nozzle by Z-park amount, limited to Z_MAX_POS.
1028
+ */
1035 1029
 //#define NOZZLE_PARK_FEATURE
1036 1030
 
1037 1031
 #if ENABLED(NOZZLE_PARK_FEATURE)
@@ -1039,44 +1033,44 @@
1039 1033
   #define NOZZLE_PARK_POINT { (X_MIN_POS + 10), (Y_MAX_POS - 10), 20 }
1040 1034
 #endif
1041 1035
 
1042
-//
1043
-// Clean Nozzle Feature -- EXPERIMENTAL
1044
-//
1045
-// When enabled allows the user to send G12 to start the nozzle cleaning
1046
-// process, the G-Code accepts two parameters:
1047
-//   "P" for pattern selection
1048
-//   "S" for defining the number of strokes/repetitions
1049
-//
1050
-// Available list of patterns:
1051
-//   P0: This is the default pattern, this process requires a sponge type
1052
-//       material at a fixed bed location. S defines "strokes" i.e.
1053
-//       back-and-forth movements between the starting and end points.
1054
-//
1055
-//   P1: This starts a zig-zag pattern between (X0, Y0) and (X1, Y1), "T"
1056
-//       defines the number of zig-zag triangles to be done. "S" defines the
1057
-//       number of strokes aka one back-and-forth movement. Zig-zags will
1058
-//       be performed in whichever dimension is smallest. As an example,
1059
-//       sending "G12 P1 S1 T3" will execute:
1060
-//
1061
-//          --
1062
-//         |  (X0, Y1) |     /\        /\        /\     | (X1, Y1)
1063
-//         |           |    /  \      /  \      /  \    |
1064
-//       A |           |   /    \    /    \    /    \   |
1065
-//         |           |  /      \  /      \  /      \  |
1066
-//         |  (X0, Y0) | /        \/        \/        \ | (X1, Y0)
1067
-//          --         +--------------------------------+
1068
-//                       |________|_________|_________|
1069
-//                           T1        T2        T3
1070
-//
1071
-//   P2: This starts a circular pattern with circle with middle in
1072
-//       NOZZLE_CLEAN_CIRCLE_MIDDLE radius of R and stroke count of S.
1073
-//       Before starting the circle nozzle goes to NOZZLE_CLEAN_START_POINT.
1074
-//
1075
-// Caveats: End point Z should use the same value as Start point Z.
1076
-//
1077
-// Attention: This is an EXPERIMENTAL feature, in the future the G-code arguments
1078
-// may change to add new functionality like different wipe patterns.
1079
-//
1036
+/**
1037
+ * Clean Nozzle Feature -- EXPERIMENTAL
1038
+ *
1039
+ * Adds the G12 command to perform a nozzle cleaning process.
1040
+ *
1041
+ * Parameters:
1042
+ *   P  Pattern
1043
+ *   S  Strokes / Repetitions
1044
+ *   T  Triangles (P1 only)
1045
+ *
1046
+ * Patterns:
1047
+ *   P0  Straight line (default). This process requires a sponge type material
1048
+ *       at a fixed bed location. "S" specifies strokes (i.e. back-forth motions)
1049
+ *       between the start / end points.
1050
+ *
1051
+ *   P1  Zig-zag pattern between (X0, Y0) and (X1, Y1), "T" specifies the
1052
+ *       number of zig-zag triangles to do. "S" defines the number of strokes.
1053
+ *       Zig-zags are done in whichever is the narrower dimension.
1054
+ *       For example, "G12 P1 S1 T3" will execute:
1055
+ *
1056
+ *          --
1057
+ *         |  (X0, Y1) |     /\        /\        /\     | (X1, Y1)
1058
+ *         |           |    /  \      /  \      /  \    |
1059
+ *       A |           |   /    \    /    \    /    \   |
1060
+ *         |           |  /      \  /      \  /      \  |
1061
+ *         |  (X0, Y0) | /        \/        \/        \ | (X1, Y0)
1062
+ *          --         +--------------------------------+
1063
+ *                       |________|_________|_________|
1064
+ *                           T1        T2        T3
1065
+ *
1066
+ *   P2  Circular pattern with middle at NOZZLE_CLEAN_CIRCLE_MIDDLE.
1067
+ *       "R" specifies the radius. "S" specifies the stroke count.
1068
+ *       Before starting, the nozzle moves to NOZZLE_CLEAN_START_POINT.
1069
+ *
1070
+ *   Caveats: The ending Z should be the same as starting Z.
1071
+ * Attention: EXPERIMENTAL. G-code arguments may change.
1072
+ *
1073
+ */
1080 1074
 //#define NOZZLE_CLEAN_FEATURE
1081 1075
 
1082 1076
 #if ENABLED(NOZZLE_CLEAN_FEATURE)
@@ -1101,33 +1095,35 @@
1101 1095
   #define NOZZLE_CLEAN_GOBACK
1102 1096
 #endif
1103 1097
 
1104
-//
1105
-// Print job timer
1106
-//
1107
-// Enable this option to automatically start and stop the
1108
-// print job timer when M104/M109/M190 commands are received.
1109
-// M104 (extruder without wait) - high temp = none, low temp = stop timer
1110
-// M109 (extruder with wait) - high temp = start timer, low temp = stop timer
1111
-// M190 (bed with wait) - high temp = start timer, low temp = none
1112
-//
1113
-// In all cases the timer can be started and stopped using
1114
-// the following commands:
1115
-//
1116
-// - M75  - Start the print job timer
1117
-// - M76  - Pause the print job timer
1118
-// - M77  - Stop the print job timer
1098
+/**
1099
+ * Print Job Timer
1100
+ *
1101
+ * Automatically start and stop the print job timer on M104/M109/M190.
1102
+ *
1103
+ *   M104 (hotend, no wait) - high temp = none,        low temp = stop timer
1104
+ *   M109 (hotend, wait)    - high temp = start timer, low temp = stop timer
1105
+ *   M190 (bed, wait)       - high temp = start timer, low temp = none
1106
+ *
1107
+ * The timer can also be controlled with the following commands:
1108
+ *
1109
+ *   M75 - Start the print job timer
1110
+ *   M76 - Pause the print job timer
1111
+ *   M77 - Stop the print job timer
1112
+ */
1119 1113
 #define PRINTJOB_TIMER_AUTOSTART
1120 1114
 
1121
-//
1122
-// Print Counter
1123
-//
1124
-// When enabled Marlin will keep track of some print statistical data such as:
1125
-//  - Total print jobs
1126
-//  - Total successful print jobs
1127
-//  - Total failed print jobs
1128
-//  - Total time printing
1129
-//
1130
-// This information can be viewed by the M78 command.
1115
+/**
1116
+ * Print Counter
1117
+ *
1118
+ * Track statistical data such as:
1119
+ *
1120
+ *  - Total print jobs
1121
+ *  - Total successful print jobs
1122
+ *  - Total failed print jobs
1123
+ *  - Total time printing
1124
+ *
1125
+ * View the current statistics with M78.
1126
+ */
1131 1127
 #define PRINTCOUNTER
1132 1128
 
1133 1129
 //=============================================================================
@@ -1139,78 +1135,79 @@
1139 1135
 // K8200: for Display VM8201 with SD slot
1140 1136
 #if ENABLED(K8200_VM8201)
1141 1137
 
1142
-//
1143
-// LCD LANGUAGE
1144
-//
1145
-// Here you may choose the language used by Marlin on the LCD menus, the following
1146
-// list of languages are available:
1147
-//    en, an, bg, ca, cn, cz, de, el, el-gr, es, eu, fi, fr, gl, hr, it,
1148
-//    kana, kana_utf8, nl, pl, pt, pt_utf8, pt-br, pt-br_utf8, ru, tr, uk, test
1149
-//
1150
-// :{ 'en':'English', 'an':'Aragonese', 'bg':'Bulgarian', 'ca':'Catalan', 'cn':'Chinese', 'cz':'Czech', 'de':'German', 'el':'Greek', 'el-gr':'Greek (Greece)', 'es':'Spanish', 'eu':'Basque-Euskera', 'fi':'Finnish', 'fr':'French', 'gl':'Galician', 'hr':'Croatian', 'it':'Italian', 'kana':'Japanese', 'kana_utf8':'Japanese (UTF8)', 'nl':'Dutch', 'pl':'Polish', 'pt':'Portuguese', 'pt-br':'Portuguese (Brazilian)', 'pt-br_utf8':'Portuguese (Brazilian UTF8)', 'pt_utf8':'Portuguese (UTF8)', 'ru':'Russian', 'tr':'Turkish', 'uk':'Ukrainian', 'test':'TEST' }
1151
-//
1138
+/**
1139
+ * LCD LANGUAGE
1140
+ *
1141
+ * Select the language to display on the LCD. These languages are available:
1142
+ *
1143
+ *    en, an, bg, ca, cn, cz, de, el, el-gr, es, eu, fi, fr, gl, hr, it,
1144
+ *    kana, kana_utf8, nl, pl, pt, pt_utf8, pt-br, pt-br_utf8, ru, tr, uk, test
1145
+ *
1146
+ * :{ 'en':'English', 'an':'Aragonese', 'bg':'Bulgarian', 'ca':'Catalan', 'cn':'Chinese', 'cz':'Czech', 'de':'German', 'el':'Greek', 'el-gr':'Greek (Greece)', 'es':'Spanish', 'eu':'Basque-Euskera', 'fi':'Finnish', 'fr':'French', 'gl':'Galician', 'hr':'Croatian', 'it':'Italian', 'kana':'Japanese', 'kana_utf8':'Japanese (UTF8)', 'nl':'Dutch', 'pl':'Polish', 'pt':'Portuguese', 'pt-br':'Portuguese (Brazilian)', 'pt-br_utf8':'Portuguese (Brazilian UTF8)', 'pt_utf8':'Portuguese (UTF8)', 'ru':'Russian', 'tr':'Turkish', 'uk':'Ukrainian', 'test':'TEST' }
1147
+ */
1152 1148
 #define LCD_LANGUAGE en
1153 1149
 
1154
-//
1155
-// LCD Character Set
1156
-//
1157
-// Note: This option is NOT applicable to Graphical Displays.
1158
-//
1159
-// All character-based LCD's provide ASCII plus one of these
1160
-// language extensions:
1161
-//
1162
-//  - JAPANESE ... the most common
1163
-//  - WESTERN  ... with more accented characters
1164
-//  - CYRILLIC ... for the Russian language
1165
-//
1166
-// To determine the language extension installed on your controller:
1167
-//
1168
-//  - Compile and upload with LCD_LANGUAGE set to 'test'
1169
-//  - Click the controller to view the LCD menu
1170
-//  - The LCD will display Japanese, Western, or Cyrillic text
1171
-//
1172
-// See https://github.com/MarlinFirmware/Marlin/wiki/LCD-Language
1173
-//
1174
-// :['JAPANESE', 'WESTERN', 'CYRILLIC']
1175
-//
1150
+/**
1151
+ * LCD Character Set
1152
+ *
1153
+ * Note: This option is NOT applicable to Graphical Displays.
1154
+ *
1155
+ * All character-based LCDs provide ASCII plus one of these
1156
+ * language extensions:
1157
+ *
1158
+ *  - JAPANESE ... the most common
1159
+ *  - WESTERN  ... with more accented characters
1160
+ *  - CYRILLIC ... for the Russian language
1161
+ *
1162
+ * To determine the language extension installed on your controller:
1163
+ *
1164
+ *  - Compile and upload with LCD_LANGUAGE set to 'test'
1165
+ *  - Click the controller to view the LCD menu
1166
+ *  - The LCD will display Japanese, Western, or Cyrillic text
1167
+ *
1168
+ * See https: *github.com/MarlinFirmware/Marlin/wiki/LCD-Language
1169
+ *
1170
+ * :['JAPANESE', 'WESTERN', 'CYRILLIC']
1171
+ */
1176 1172
 #define DISPLAY_CHARSET_HD44780 JAPANESE // K8200: for Display VM8201 // this is the most common hardware
1177 1173
 
1178
-//
1179
-// LCD TYPE
1180
-//
1181
-// You may choose ULTRA_LCD if you have character based LCD with 16x2, 16x4, 20x2,
1182
-// 20x4 char/lines or DOGLCD for the full graphics display with 128x64 pixels
1183
-// (ST7565R family). (This option will be set automatically for certain displays.)
1184
-//
1185
-// IMPORTANT NOTE: The U8glib library is required for Full Graphic Display!
1186
-//                 https://github.com/olikraus/U8glib_Arduino
1187
-//
1174
+/**
1175
+ * LCD TYPE
1176
+ *
1177
+ * Enable ULTRA_LCD for a 16x2, 16x4, 20x2, or 20x4 character-based LCD.
1178
+ * Enable DOGLCD for a 128x64 (ST7565R) Full Graphical Display.
1179
+ * (These options will be enabled automatically for most displays.)
1180
+ *
1181
+ * IMPORTANT: The U8glib library is required for Full Graphic Display!
1182
+ *            https://github.com/olikraus/U8glib_Arduino
1183
+ */
1188 1184
 //#define ULTRA_LCD   // Character based
1189 1185
 //#define DOGLCD      // Full graphics display
1190 1186
 
1191
-//
1192
-// SD CARD
1193
-//
1194
-// SD Card support is disabled by default. If your controller has an SD slot,
1195
-// you must uncomment the following option or it won't work.
1196
-//
1187
+/**
1188
+ * SD CARD
1189
+ *
1190
+ * SD Card support is disabled by default. If your controller has an SD slot,
1191
+ * you must uncomment the following option or it won't work.
1192
+ *
1193
+ */
1197 1194
 #define SDSUPPORT
1198 1195
 
1199
-//
1200
-// SD CARD: SPI SPEED
1201
-//
1202
-// Uncomment ONE of the following items to use a slower SPI transfer
1203
-// speed. This is usually required if you're getting volume init errors.
1204
-//
1196
+/**
1197
+ * SD CARD: SPI SPEED
1198
+ *
1199
+ * Enable one of the following items for a slower SPI transfer speed.
1200
+ * This may be required to resolve "volume init" errors.
1201
+ */
1205 1202
 //#define SPI_SPEED SPI_HALF_SPEED
1206 1203
 //#define SPI_SPEED SPI_QUARTER_SPEED
1207 1204
 //#define SPI_SPEED SPI_EIGHTH_SPEED
1208 1205
 
1209
-//
1210
-// SD CARD: ENABLE CRC
1211
-//
1212
-// Use CRC checks and retries on the SD communication.
1213
-//
1206
+/**
1207
+ * SD CARD: ENABLE CRC
1208
+ *
1209
+ * Use CRC checks and retries on the SD communication.
1210
+ */
1214 1211
 #define SD_CHECK_AND_RETRY
1215 1212
 
1216 1213
 //
@@ -1238,7 +1235,7 @@
1238 1235
  */
1239 1236
 
1240 1237
 //
1241
-// This option reverses the encoder direction everywhere
1238
+// This option reverses the encoder direction everywhere.
1242 1239
 //
1243 1240
 //  Set this option if CLOCKWISE causes values to DECREASE
1244 1241
 //

+ 137
- 140
Marlin/example_configurations/K8400/Configuration.h View File

@@ -986,23 +986,17 @@
986 986
 #define PREHEAT_2_TEMP_BED      0
987 987
 #define PREHEAT_2_FAN_SPEED   165 // Value from 0 to 255
988 988
 
989
-//
990
-// Nozzle Park -- EXPERIMENTAL
991
-//
992
-// When enabled allows the user to define a special XYZ position, inside the
993
-// machine's topology, to park the nozzle when idle or when receiving the G27
994
-// command.
995
-//
996
-// The "P" paramenter controls what is the action applied to the Z axis:
997
-//    P0: (Default) If current Z-pos is lower than Z-park then the nozzle will
998
-//        be raised to reach Z-park height.
999
-//
1000
-//    P1: No matter the current Z-pos, the nozzle will be raised/lowered to
1001
-//        reach Z-park height.
1002
-//
1003
-//    P2: The nozzle height will be raised by Z-park amount but never going over
1004
-//        the machine's limit of Z_MAX_POS.
1005
-//
989
+/**
990
+ * Nozzle Park -- EXPERIMENTAL
991
+ *
992
+ * Park the nozzle at the given XYZ position on idle or G27.
993
+ *
994
+ * The "P" parameter controls the action applied to the Z axis:
995
+ *
996
+ *    P0  (Default) If Z is below park Z raise the nozzle.
997
+ *    P1  Raise the nozzle always to Z-park height.
998
+ *    P2  Raise the nozzle by Z-park amount, limited to Z_MAX_POS.
999
+ */
1006 1000
 //#define NOZZLE_PARK_FEATURE
1007 1001
 
1008 1002
 #if ENABLED(NOZZLE_PARK_FEATURE)
@@ -1010,44 +1004,44 @@
1010 1004
   #define NOZZLE_PARK_POINT { (X_MIN_POS + 10), (Y_MAX_POS - 10), 20 }
1011 1005
 #endif
1012 1006
 
1013
-//
1014
-// Clean Nozzle Feature -- EXPERIMENTAL
1015
-//
1016
-// When enabled allows the user to send G12 to start the nozzle cleaning
1017
-// process, the G-Code accepts two parameters:
1018
-//   "P" for pattern selection
1019
-//   "S" for defining the number of strokes/repetitions
1020
-//
1021
-// Available list of patterns:
1022
-//   P0: This is the default pattern, this process requires a sponge type
1023
-//       material at a fixed bed location. S defines "strokes" i.e.
1024
-//       back-and-forth movements between the starting and end points.
1025
-//
1026
-//   P1: This starts a zig-zag pattern between (X0, Y0) and (X1, Y1), "T"
1027
-//       defines the number of zig-zag triangles to be done. "S" defines the
1028
-//       number of strokes aka one back-and-forth movement. Zig-zags will
1029
-//       be performed in whichever dimension is smallest. As an example,
1030
-//       sending "G12 P1 S1 T3" will execute:
1031
-//
1032
-//          --
1033
-//         |  (X0, Y1) |     /\        /\        /\     | (X1, Y1)
1034
-//         |           |    /  \      /  \      /  \    |
1035
-//       A |           |   /    \    /    \    /    \   |
1036
-//         |           |  /      \  /      \  /      \  |
1037
-//         |  (X0, Y0) | /        \/        \/        \ | (X1, Y0)
1038
-//          --         +--------------------------------+
1039
-//                       |________|_________|_________|
1040
-//                           T1        T2        T3
1041
-//
1042
-//   P2: This starts a circular pattern with circle with middle in
1043
-//       NOZZLE_CLEAN_CIRCLE_MIDDLE radius of R and stroke count of S.
1044
-//       Before starting the circle nozzle goes to NOZZLE_CLEAN_START_POINT.
1045
-//
1046
-// Caveats: End point Z should use the same value as Start point Z.
1047
-//
1048
-// Attention: This is an EXPERIMENTAL feature, in the future the G-code arguments
1049
-// may change to add new functionality like different wipe patterns.
1050
-//
1007
+/**
1008
+ * Clean Nozzle Feature -- EXPERIMENTAL
1009
+ *
1010
+ * Adds the G12 command to perform a nozzle cleaning process.
1011
+ *
1012
+ * Parameters:
1013
+ *   P  Pattern
1014
+ *   S  Strokes / Repetitions
1015
+ *   T  Triangles (P1 only)
1016
+ *
1017
+ * Patterns:
1018
+ *   P0  Straight line (default). This process requires a sponge type material
1019
+ *       at a fixed bed location. "S" specifies strokes (i.e. back-forth motions)
1020
+ *       between the start / end points.
1021
+ *
1022
+ *   P1  Zig-zag pattern between (X0, Y0) and (X1, Y1), "T" specifies the
1023
+ *       number of zig-zag triangles to do. "S" defines the number of strokes.
1024
+ *       Zig-zags are done in whichever is the narrower dimension.
1025
+ *       For example, "G12 P1 S1 T3" will execute:
1026
+ *
1027
+ *          --
1028
+ *         |  (X0, Y1) |     /\        /\        /\     | (X1, Y1)
1029
+ *         |           |    /  \      /  \      /  \    |
1030
+ *       A |           |   /    \    /    \    /    \   |
1031
+ *         |           |  /      \  /      \  /      \  |
1032
+ *         |  (X0, Y0) | /        \/        \/        \ | (X1, Y0)
1033
+ *          --         +--------------------------------+
1034
+ *                       |________|_________|_________|
1035
+ *                           T1        T2        T3
1036
+ *
1037
+ *   P2  Circular pattern with middle at NOZZLE_CLEAN_CIRCLE_MIDDLE.
1038
+ *       "R" specifies the radius. "S" specifies the stroke count.
1039
+ *       Before starting, the nozzle moves to NOZZLE_CLEAN_START_POINT.
1040
+ *
1041
+ *   Caveats: The ending Z should be the same as starting Z.
1042
+ * Attention: EXPERIMENTAL. G-code arguments may change.
1043
+ *
1044
+ */
1051 1045
 //#define NOZZLE_CLEAN_FEATURE
1052 1046
 
1053 1047
 #if ENABLED(NOZZLE_CLEAN_FEATURE)
@@ -1072,33 +1066,35 @@
1072 1066
   #define NOZZLE_CLEAN_GOBACK
1073 1067
 #endif
1074 1068
 
1075
-//
1076
-// Print job timer
1077
-//
1078
-// Enable this option to automatically start and stop the
1079
-// print job timer when M104/M109/M190 commands are received.
1080
-// M104 (extruder without wait) - high temp = none, low temp = stop timer
1081
-// M109 (extruder with wait) - high temp = start timer, low temp = stop timer
1082
-// M190 (bed with wait) - high temp = start timer, low temp = none
1083
-//
1084
-// In all cases the timer can be started and stopped using
1085
-// the following commands:
1086
-//
1087
-// - M75  - Start the print job timer
1088
-// - M76  - Pause the print job timer
1089
-// - M77  - Stop the print job timer
1069
+/**
1070
+ * Print Job Timer
1071
+ *
1072
+ * Automatically start and stop the print job timer on M104/M109/M190.
1073
+ *
1074
+ *   M104 (hotend, no wait) - high temp = none,        low temp = stop timer
1075
+ *   M109 (hotend, wait)    - high temp = start timer, low temp = stop timer
1076
+ *   M190 (bed, wait)       - high temp = start timer, low temp = none
1077
+ *
1078
+ * The timer can also be controlled with the following commands:
1079
+ *
1080
+ *   M75 - Start the print job timer
1081
+ *   M76 - Pause the print job timer
1082
+ *   M77 - Stop the print job timer
1083
+ */
1090 1084
 #define PRINTJOB_TIMER_AUTOSTART
1091 1085
 
1092
-//
1093
-// Print Counter
1094
-//
1095
-// When enabled Marlin will keep track of some print statistical data such as:
1096
-//  - Total print jobs
1097
-//  - Total successful print jobs
1098
-//  - Total failed print jobs
1099
-//  - Total time printing
1100
-//
1101
-// This information can be viewed by the M78 command.
1086
+/**
1087
+ * Print Counter
1088
+ *
1089
+ * Track statistical data such as:
1090
+ *
1091
+ *  - Total print jobs
1092
+ *  - Total successful print jobs
1093
+ *  - Total failed print jobs
1094
+ *  - Total time printing
1095
+ *
1096
+ * View the current statistics with M78.
1097
+ */
1102 1098
 //#define PRINTCOUNTER
1103 1099
 
1104 1100
 //=============================================================================
@@ -1107,78 +1103,79 @@
1107 1103
 
1108 1104
 // @section lcd
1109 1105
 
1110
-//
1111
-// LCD LANGUAGE
1112
-//
1113
-// Here you may choose the language used by Marlin on the LCD menus, the following
1114
-// list of languages are available:
1115
-//    en, an, bg, ca, cn, cz, de, el, el-gr, es, eu, fi, fr, gl, hr, it,
1116
-//    kana, kana_utf8, nl, pl, pt, pt_utf8, pt-br, pt-br_utf8, ru, tr, uk, test
1117
-//
1118
-// :{ 'en':'English', 'an':'Aragonese', 'bg':'Bulgarian', 'ca':'Catalan', 'cn':'Chinese', 'cz':'Czech', 'de':'German', 'el':'Greek', 'el-gr':'Greek (Greece)', 'es':'Spanish', 'eu':'Basque-Euskera', 'fi':'Finnish', 'fr':'French', 'gl':'Galician', 'hr':'Croatian', 'it':'Italian', 'kana':'Japanese', 'kana_utf8':'Japanese (UTF8)', 'nl':'Dutch', 'pl':'Polish', 'pt':'Portuguese', 'pt-br':'Portuguese (Brazilian)', 'pt-br_utf8':'Portuguese (Brazilian UTF8)', 'pt_utf8':'Portuguese (UTF8)', 'ru':'Russian', 'tr':'Turkish', 'uk':'Ukrainian', 'test':'TEST' }
1119
-//
1106
+/**
1107
+ * LCD LANGUAGE
1108
+ *
1109
+ * Select the language to display on the LCD. These languages are available:
1110
+ *
1111
+ *    en, an, bg, ca, cn, cz, de, el, el-gr, es, eu, fi, fr, gl, hr, it,
1112
+ *    kana, kana_utf8, nl, pl, pt, pt_utf8, pt-br, pt-br_utf8, ru, tr, uk, test
1113
+ *
1114
+ * :{ 'en':'English', 'an':'Aragonese', 'bg':'Bulgarian', 'ca':'Catalan', 'cn':'Chinese', 'cz':'Czech', 'de':'German', 'el':'Greek', 'el-gr':'Greek (Greece)', 'es':'Spanish', 'eu':'Basque-Euskera', 'fi':'Finnish', 'fr':'French', 'gl':'Galician', 'hr':'Croatian', 'it':'Italian', 'kana':'Japanese', 'kana_utf8':'Japanese (UTF8)', 'nl':'Dutch', 'pl':'Polish', 'pt':'Portuguese', 'pt-br':'Portuguese (Brazilian)', 'pt-br_utf8':'Portuguese (Brazilian UTF8)', 'pt_utf8':'Portuguese (UTF8)', 'ru':'Russian', 'tr':'Turkish', 'uk':'Ukrainian', 'test':'TEST' }
1115
+ */
1120 1116
 #define LCD_LANGUAGE en
1121 1117
 
1122
-//
1123
-// LCD Character Set
1124
-//
1125
-// Note: This option is NOT applicable to Graphical Displays.
1126
-//
1127
-// All character-based LCD's provide ASCII plus one of these
1128
-// language extensions:
1129
-//
1130
-//  - JAPANESE ... the most common
1131
-//  - WESTERN  ... with more accented characters
1132
-//  - CYRILLIC ... for the Russian language
1133
-//
1134
-// To determine the language extension installed on your controller:
1135
-//
1136
-//  - Compile and upload with LCD_LANGUAGE set to 'test'
1137
-//  - Click the controller to view the LCD menu
1138
-//  - The LCD will display Japanese, Western, or Cyrillic text
1139
-//
1140
-// See https://github.com/MarlinFirmware/Marlin/wiki/LCD-Language
1141
-//
1142
-// :['JAPANESE', 'WESTERN', 'CYRILLIC']
1143
-//
1118
+/**
1119
+ * LCD Character Set
1120
+ *
1121
+ * Note: This option is NOT applicable to Graphical Displays.
1122
+ *
1123
+ * All character-based LCDs provide ASCII plus one of these
1124
+ * language extensions:
1125
+ *
1126
+ *  - JAPANESE ... the most common
1127
+ *  - WESTERN  ... with more accented characters
1128
+ *  - CYRILLIC ... for the Russian language
1129
+ *
1130
+ * To determine the language extension installed on your controller:
1131
+ *
1132
+ *  - Compile and upload with LCD_LANGUAGE set to 'test'
1133
+ *  - Click the controller to view the LCD menu
1134
+ *  - The LCD will display Japanese, Western, or Cyrillic text
1135
+ *
1136
+ * See https: *github.com/MarlinFirmware/Marlin/wiki/LCD-Language
1137
+ *
1138
+ * :['JAPANESE', 'WESTERN', 'CYRILLIC']
1139
+ */
1144 1140
 #define DISPLAY_CHARSET_HD44780 JAPANESE
1145 1141
 
1146
-//
1147
-// LCD TYPE
1148
-//
1149
-// You may choose ULTRA_LCD if you have character based LCD with 16x2, 16x4, 20x2,
1150
-// 20x4 char/lines or DOGLCD for the full graphics display with 128x64 pixels
1151
-// (ST7565R family). (This option will be set automatically for certain displays.)
1152
-//
1153
-// IMPORTANT NOTE: The U8glib library is required for Full Graphic Display!
1154
-//                 https://github.com/olikraus/U8glib_Arduino
1155
-//
1142
+/**
1143
+ * LCD TYPE
1144
+ *
1145
+ * Enable ULTRA_LCD for a 16x2, 16x4, 20x2, or 20x4 character-based LCD.
1146
+ * Enable DOGLCD for a 128x64 (ST7565R) Full Graphical Display.
1147
+ * (These options will be enabled automatically for most displays.)
1148
+ *
1149
+ * IMPORTANT: The U8glib library is required for Full Graphic Display!
1150
+ *            https://github.com/olikraus/U8glib_Arduino
1151
+ */
1156 1152
 #define ULTRA_LCD   // Character based
1157 1153
 //#define DOGLCD      // Full graphics display
1158 1154
 
1159
-//
1160
-// SD CARD
1161
-//
1162
-// SD Card support is disabled by default. If your controller has an SD slot,
1163
-// you must uncomment the following option or it won't work.
1164
-//
1155
+/**
1156
+ * SD CARD
1157
+ *
1158
+ * SD Card support is disabled by default. If your controller has an SD slot,
1159
+ * you must uncomment the following option or it won't work.
1160
+ *
1161
+ */
1165 1162
 #define SDSUPPORT
1166 1163
 
1167
-//
1168
-// SD CARD: SPI SPEED
1169
-//
1170
-// Uncomment ONE of the following items to use a slower SPI transfer
1171
-// speed. This is usually required if you're getting volume init errors.
1172
-//
1164
+/**
1165
+ * SD CARD: SPI SPEED
1166
+ *
1167
+ * Enable one of the following items for a slower SPI transfer speed.
1168
+ * This may be required to resolve "volume init" errors.
1169
+ */
1173 1170
 //#define SPI_SPEED SPI_HALF_SPEED
1174 1171
 //#define SPI_SPEED SPI_QUARTER_SPEED
1175 1172
 //#define SPI_SPEED SPI_EIGHTH_SPEED
1176 1173
 
1177
-//
1178
-// SD CARD: ENABLE CRC
1179
-//
1180
-// Use CRC checks and retries on the SD communication.
1181
-//
1174
+/**
1175
+ * SD CARD: ENABLE CRC
1176
+ *
1177
+ * Use CRC checks and retries on the SD communication.
1178
+ */
1182 1179
 //#define SD_CHECK_AND_RETRY
1183 1180
 
1184 1181
 //
@@ -1206,7 +1203,7 @@
1206 1203
  */
1207 1204
 
1208 1205
 //
1209
-// This option reverses the encoder direction everywhere
1206
+// This option reverses the encoder direction everywhere.
1210 1207
 //
1211 1208
 //  Set this option if CLOCKWISE causes values to DECREASE
1212 1209
 //

+ 137
- 140
Marlin/example_configurations/K8400/Dual-head/Configuration.h View File

@@ -986,23 +986,17 @@
986 986
 #define PREHEAT_2_TEMP_BED      0
987 987
 #define PREHEAT_2_FAN_SPEED   165 // Value from 0 to 255
988 988
 
989
-//
990
-// Nozzle Park -- EXPERIMENTAL
991
-//
992
-// When enabled allows the user to define a special XYZ position, inside the
993
-// machine's topology, to park the nozzle when idle or when receiving the G27
994
-// command.
995
-//
996
-// The "P" paramenter controls what is the action applied to the Z axis:
997
-//    P0: (Default) If current Z-pos is lower than Z-park then the nozzle will
998
-//        be raised to reach Z-park height.
999
-//
1000
-//    P1: No matter the current Z-pos, the nozzle will be raised/lowered to
1001
-//        reach Z-park height.
1002
-//
1003
-//    P2: The nozzle height will be raised by Z-park amount but never going over
1004
-//        the machine's limit of Z_MAX_POS.
1005
-//
989
+/**
990
+ * Nozzle Park -- EXPERIMENTAL
991
+ *
992
+ * Park the nozzle at the given XYZ position on idle or G27.
993
+ *
994
+ * The "P" parameter controls the action applied to the Z axis:
995
+ *
996
+ *    P0  (Default) If Z is below park Z raise the nozzle.
997
+ *    P1  Raise the nozzle always to Z-park height.
998
+ *    P2  Raise the nozzle by Z-park amount, limited to Z_MAX_POS.
999
+ */
1006 1000
 //#define NOZZLE_PARK_FEATURE
1007 1001
 
1008 1002
 #if ENABLED(NOZZLE_PARK_FEATURE)
@@ -1010,44 +1004,44 @@
1010 1004
   #define NOZZLE_PARK_POINT { (X_MIN_POS + 10), (Y_MAX_POS - 10), 20 }
1011 1005
 #endif
1012 1006
 
1013
-//
1014
-// Clean Nozzle Feature -- EXPERIMENTAL
1015
-//
1016
-// When enabled allows the user to send G12 to start the nozzle cleaning
1017
-// process, the G-Code accepts two parameters:
1018
-//   "P" for pattern selection
1019
-//   "S" for defining the number of strokes/repetitions
1020
-//
1021
-// Available list of patterns:
1022
-//   P0: This is the default pattern, this process requires a sponge type
1023
-//       material at a fixed bed location. S defines "strokes" i.e.
1024
-//       back-and-forth movements between the starting and end points.
1025
-//
1026
-//   P1: This starts a zig-zag pattern between (X0, Y0) and (X1, Y1), "T"
1027
-//       defines the number of zig-zag triangles to be done. "S" defines the
1028
-//       number of strokes aka one back-and-forth movement. Zig-zags will
1029
-//       be performed in whichever dimension is smallest. As an example,
1030
-//       sending "G12 P1 S1 T3" will execute:
1031
-//
1032
-//          --
1033
-//         |  (X0, Y1) |     /\        /\        /\     | (X1, Y1)
1034
-//         |           |    /  \      /  \      /  \    |
1035
-//       A |           |   /    \    /    \    /    \   |
1036
-//         |           |  /      \  /      \  /      \  |
1037
-//         |  (X0, Y0) | /        \/        \/        \ | (X1, Y0)
1038
-//          --         +--------------------------------+
1039
-//                       |________|_________|_________|
1040
-//                           T1        T2        T3
1041
-//
1042
-//   P2: This starts a circular pattern with circle with middle in
1043
-//       NOZZLE_CLEAN_CIRCLE_MIDDLE radius of R and stroke count of S.
1044
-//       Before starting the circle nozzle goes to NOZZLE_CLEAN_START_POINT.
1045
-//
1046
-// Caveats: End point Z should use the same value as Start point Z.
1047
-//
1048
-// Attention: This is an EXPERIMENTAL feature, in the future the G-code arguments
1049
-// may change to add new functionality like different wipe patterns.
1050
-//
1007
+/**
1008
+ * Clean Nozzle Feature -- EXPERIMENTAL
1009
+ *
1010
+ * Adds the G12 command to perform a nozzle cleaning process.
1011
+ *
1012
+ * Parameters:
1013
+ *   P  Pattern
1014
+ *   S  Strokes / Repetitions
1015
+ *   T  Triangles (P1 only)
1016
+ *
1017
+ * Patterns:
1018
+ *   P0  Straight line (default). This process requires a sponge type material
1019
+ *       at a fixed bed location. "S" specifies strokes (i.e. back-forth motions)
1020
+ *       between the start / end points.
1021
+ *
1022
+ *   P1  Zig-zag pattern between (X0, Y0) and (X1, Y1), "T" specifies the
1023
+ *       number of zig-zag triangles to do. "S" defines the number of strokes.
1024
+ *       Zig-zags are done in whichever is the narrower dimension.
1025
+ *       For example, "G12 P1 S1 T3" will execute:
1026
+ *
1027
+ *          --
1028
+ *         |  (X0, Y1) |     /\        /\        /\     | (X1, Y1)
1029
+ *         |           |    /  \      /  \      /  \    |
1030
+ *       A |           |   /    \    /    \    /    \   |
1031
+ *         |           |  /      \  /      \  /      \  |
1032
+ *         |  (X0, Y0) | /        \/        \/        \ | (X1, Y0)
1033
+ *          --         +--------------------------------+
1034
+ *                       |________|_________|_________|
1035
+ *                           T1        T2        T3
1036
+ *
1037
+ *   P2  Circular pattern with middle at NOZZLE_CLEAN_CIRCLE_MIDDLE.
1038
+ *       "R" specifies the radius. "S" specifies the stroke count.
1039
+ *       Before starting, the nozzle moves to NOZZLE_CLEAN_START_POINT.
1040
+ *
1041
+ *   Caveats: The ending Z should be the same as starting Z.
1042
+ * Attention: EXPERIMENTAL. G-code arguments may change.
1043
+ *
1044
+ */
1051 1045
 //#define NOZZLE_CLEAN_FEATURE
1052 1046
 
1053 1047
 #if ENABLED(NOZZLE_CLEAN_FEATURE)
@@ -1072,33 +1066,35 @@
1072 1066
   #define NOZZLE_CLEAN_GOBACK
1073 1067
 #endif
1074 1068
 
1075
-//
1076
-// Print job timer
1077
-//
1078
-// Enable this option to automatically start and stop the
1079
-// print job timer when M104/M109/M190 commands are received.
1080
-// M104 (extruder without wait) - high temp = none, low temp = stop timer
1081
-// M109 (extruder with wait) - high temp = start timer, low temp = stop timer
1082
-// M190 (bed with wait) - high temp = start timer, low temp = none
1083
-//
1084
-// In all cases the timer can be started and stopped using
1085
-// the following commands:
1086
-//
1087
-// - M75  - Start the print job timer
1088
-// - M76  - Pause the print job timer
1089
-// - M77  - Stop the print job timer
1069
+/**
1070
+ * Print Job Timer
1071
+ *
1072
+ * Automatically start and stop the print job timer on M104/M109/M190.
1073
+ *
1074
+ *   M104 (hotend, no wait) - high temp = none,        low temp = stop timer
1075
+ *   M109 (hotend, wait)    - high temp = start timer, low temp = stop timer
1076
+ *   M190 (bed, wait)       - high temp = start timer, low temp = none
1077
+ *
1078
+ * The timer can also be controlled with the following commands:
1079
+ *
1080
+ *   M75 - Start the print job timer
1081
+ *   M76 - Pause the print job timer
1082
+ *   M77 - Stop the print job timer
1083
+ */
1090 1084
 #define PRINTJOB_TIMER_AUTOSTART
1091 1085
 
1092
-//
1093
-// Print Counter
1094
-//
1095
-// When enabled Marlin will keep track of some print statistical data such as:
1096
-//  - Total print jobs
1097
-//  - Total successful print jobs
1098
-//  - Total failed print jobs
1099
-//  - Total time printing
1100
-//
1101
-// This information can be viewed by the M78 command.
1086
+/**
1087
+ * Print Counter
1088
+ *
1089
+ * Track statistical data such as:
1090
+ *
1091
+ *  - Total print jobs
1092
+ *  - Total successful print jobs
1093
+ *  - Total failed print jobs
1094
+ *  - Total time printing
1095
+ *
1096
+ * View the current statistics with M78.
1097
+ */
1102 1098
 //#define PRINTCOUNTER
1103 1099
 
1104 1100
 //=============================================================================
@@ -1107,78 +1103,79 @@
1107 1103
 
1108 1104
 // @section lcd
1109 1105
 
1110
-//
1111
-// LCD LANGUAGE
1112
-//
1113
-// Here you may choose the language used by Marlin on the LCD menus, the following
1114
-// list of languages are available:
1115
-//    en, an, bg, ca, cn, cz, de, el, el-gr, es, eu, fi, fr, gl, hr, it,
1116
-//    kana, kana_utf8, nl, pl, pt, pt_utf8, pt-br, pt-br_utf8, ru, tr, uk, test
1117
-//
1118
-// :{ 'en':'English', 'an':'Aragonese', 'bg':'Bulgarian', 'ca':'Catalan', 'cn':'Chinese', 'cz':'Czech', 'de':'German', 'el':'Greek', 'el-gr':'Greek (Greece)', 'es':'Spanish', 'eu':'Basque-Euskera', 'fi':'Finnish', 'fr':'French', 'gl':'Galician', 'hr':'Croatian', 'it':'Italian', 'kana':'Japanese', 'kana_utf8':'Japanese (UTF8)', 'nl':'Dutch', 'pl':'Polish', 'pt':'Portuguese', 'pt-br':'Portuguese (Brazilian)', 'pt-br_utf8':'Portuguese (Brazilian UTF8)', 'pt_utf8':'Portuguese (UTF8)', 'ru':'Russian', 'tr':'Turkish', 'uk':'Ukrainian', 'test':'TEST' }
1119
-//
1106
+/**
1107
+ * LCD LANGUAGE
1108
+ *
1109
+ * Select the language to display on the LCD. These languages are available:
1110
+ *
1111
+ *    en, an, bg, ca, cn, cz, de, el, el-gr, es, eu, fi, fr, gl, hr, it,
1112
+ *    kana, kana_utf8, nl, pl, pt, pt_utf8, pt-br, pt-br_utf8, ru, tr, uk, test
1113
+ *
1114
+ * :{ 'en':'English', 'an':'Aragonese', 'bg':'Bulgarian', 'ca':'Catalan', 'cn':'Chinese', 'cz':'Czech', 'de':'German', 'el':'Greek', 'el-gr':'Greek (Greece)', 'es':'Spanish', 'eu':'Basque-Euskera', 'fi':'Finnish', 'fr':'French', 'gl':'Galician', 'hr':'Croatian', 'it':'Italian', 'kana':'Japanese', 'kana_utf8':'Japanese (UTF8)', 'nl':'Dutch', 'pl':'Polish', 'pt':'Portuguese', 'pt-br':'Portuguese (Brazilian)', 'pt-br_utf8':'Portuguese (Brazilian UTF8)', 'pt_utf8':'Portuguese (UTF8)', 'ru':'Russian', 'tr':'Turkish', 'uk':'Ukrainian', 'test':'TEST' }
1115
+ */
1120 1116
 #define LCD_LANGUAGE en
1121 1117
 
1122
-//
1123
-// LCD Character Set
1124
-//
1125
-// Note: This option is NOT applicable to Graphical Displays.
1126
-//
1127
-// All character-based LCD's provide ASCII plus one of these
1128
-// language extensions:
1129
-//
1130
-//  - JAPANESE ... the most common
1131
-//  - WESTERN  ... with more accented characters
1132
-//  - CYRILLIC ... for the Russian language
1133
-//
1134
-// To determine the language extension installed on your controller:
1135
-//
1136
-//  - Compile and upload with LCD_LANGUAGE set to 'test'
1137
-//  - Click the controller to view the LCD menu
1138
-//  - The LCD will display Japanese, Western, or Cyrillic text
1139
-//
1140
-// See https://github.com/MarlinFirmware/Marlin/wiki/LCD-Language
1141
-//
1142
-// :['JAPANESE', 'WESTERN', 'CYRILLIC']
1143
-//
1118
+/**
1119
+ * LCD Character Set
1120
+ *
1121
+ * Note: This option is NOT applicable to Graphical Displays.
1122
+ *
1123
+ * All character-based LCDs provide ASCII plus one of these
1124
+ * language extensions:
1125
+ *
1126
+ *  - JAPANESE ... the most common
1127
+ *  - WESTERN  ... with more accented characters
1128
+ *  - CYRILLIC ... for the Russian language
1129
+ *
1130
+ * To determine the language extension installed on your controller:
1131
+ *
1132
+ *  - Compile and upload with LCD_LANGUAGE set to 'test'
1133
+ *  - Click the controller to view the LCD menu
1134
+ *  - The LCD will display Japanese, Western, or Cyrillic text
1135
+ *
1136
+ * See https: *github.com/MarlinFirmware/Marlin/wiki/LCD-Language
1137
+ *
1138
+ * :['JAPANESE', 'WESTERN', 'CYRILLIC']
1139
+ */
1144 1140
 #define DISPLAY_CHARSET_HD44780 JAPANESE
1145 1141
 
1146
-//
1147
-// LCD TYPE
1148
-//
1149
-// You may choose ULTRA_LCD if you have character based LCD with 16x2, 16x4, 20x2,
1150
-// 20x4 char/lines or DOGLCD for the full graphics display with 128x64 pixels
1151
-// (ST7565R family). (This option will be set automatically for certain displays.)
1152
-//
1153
-// IMPORTANT NOTE: The U8glib library is required for Full Graphic Display!
1154
-//                 https://github.com/olikraus/U8glib_Arduino
1155
-//
1142
+/**
1143
+ * LCD TYPE
1144
+ *
1145
+ * Enable ULTRA_LCD for a 16x2, 16x4, 20x2, or 20x4 character-based LCD.
1146
+ * Enable DOGLCD for a 128x64 (ST7565R) Full Graphical Display.
1147
+ * (These options will be enabled automatically for most displays.)
1148
+ *
1149
+ * IMPORTANT: The U8glib library is required for Full Graphic Display!
1150
+ *            https://github.com/olikraus/U8glib_Arduino
1151
+ */
1156 1152
 #define ULTRA_LCD   // Character based
1157 1153
 //#define DOGLCD      // Full graphics display
1158 1154
 
1159
-//
1160
-// SD CARD
1161
-//
1162
-// SD Card support is disabled by default. If your controller has an SD slot,
1163
-// you must uncomment the following option or it won't work.
1164
-//
1155
+/**
1156
+ * SD CARD
1157
+ *
1158
+ * SD Card support is disabled by default. If your controller has an SD slot,
1159
+ * you must uncomment the following option or it won't work.
1160
+ *
1161
+ */
1165 1162
 #define SDSUPPORT
1166 1163
 
1167
-//
1168
-// SD CARD: SPI SPEED
1169
-//
1170
-// Uncomment ONE of the following items to use a slower SPI transfer
1171
-// speed. This is usually required if you're getting volume init errors.
1172
-//
1164
+/**
1165
+ * SD CARD: SPI SPEED
1166
+ *
1167
+ * Enable one of the following items for a slower SPI transfer speed.
1168
+ * This may be required to resolve "volume init" errors.
1169
+ */
1173 1170
 //#define SPI_SPEED SPI_HALF_SPEED
1174 1171
 //#define SPI_SPEED SPI_QUARTER_SPEED
1175 1172
 //#define SPI_SPEED SPI_EIGHTH_SPEED
1176 1173
 
1177
-//
1178
-// SD CARD: ENABLE CRC
1179
-//
1180
-// Use CRC checks and retries on the SD communication.
1181
-//
1174
+/**
1175
+ * SD CARD: ENABLE CRC
1176
+ *
1177
+ * Use CRC checks and retries on the SD communication.
1178
+ */
1182 1179
 //#define SD_CHECK_AND_RETRY
1183 1180
 
1184 1181
 //
@@ -1206,7 +1203,7 @@
1206 1203
  */
1207 1204
 
1208 1205
 //
1209
-// This option reverses the encoder direction everywhere
1206
+// This option reverses the encoder direction everywhere.
1210 1207
 //
1211 1208
 //  Set this option if CLOCKWISE causes values to DECREASE
1212 1209
 //

+ 137
- 140
Marlin/example_configurations/RepRapWorld/Megatronics/Configuration.h View File

@@ -986,23 +986,17 @@
986 986
 #define PREHEAT_2_TEMP_BED    110
987 987
 #define PREHEAT_2_FAN_SPEED     0 // Value from 0 to 255
988 988
 
989
-//
990
-// Nozzle Park -- EXPERIMENTAL
991
-//
992
-// When enabled allows the user to define a special XYZ position, inside the
993
-// machine's topology, to park the nozzle when idle or when receiving the G27
994
-// command.
995
-//
996
-// The "P" paramenter controls what is the action applied to the Z axis:
997
-//    P0: (Default) If current Z-pos is lower than Z-park then the nozzle will
998
-//        be raised to reach Z-park height.
999
-//
1000
-//    P1: No matter the current Z-pos, the nozzle will be raised/lowered to
1001
-//        reach Z-park height.
1002
-//
1003
-//    P2: The nozzle height will be raised by Z-park amount but never going over
1004
-//        the machine's limit of Z_MAX_POS.
1005
-//
989
+/**
990
+ * Nozzle Park -- EXPERIMENTAL
991
+ *
992
+ * Park the nozzle at the given XYZ position on idle or G27.
993
+ *
994
+ * The "P" parameter controls the action applied to the Z axis:
995
+ *
996
+ *    P0  (Default) If Z is below park Z raise the nozzle.
997
+ *    P1  Raise the nozzle always to Z-park height.
998
+ *    P2  Raise the nozzle by Z-park amount, limited to Z_MAX_POS.
999
+ */
1006 1000
 //#define NOZZLE_PARK_FEATURE
1007 1001
 
1008 1002
 #if ENABLED(NOZZLE_PARK_FEATURE)
@@ -1010,44 +1004,44 @@
1010 1004
   #define NOZZLE_PARK_POINT { (X_MIN_POS + 10), (Y_MAX_POS - 10), 20 }
1011 1005
 #endif
1012 1006
 
1013
-//
1014
-// Clean Nozzle Feature -- EXPERIMENTAL
1015
-//
1016
-// When enabled allows the user to send G12 to start the nozzle cleaning
1017
-// process, the G-Code accepts two parameters:
1018
-//   "P" for pattern selection
1019
-//   "S" for defining the number of strokes/repetitions
1020
-//
1021
-// Available list of patterns:
1022
-//   P0: This is the default pattern, this process requires a sponge type
1023
-//       material at a fixed bed location. S defines "strokes" i.e.
1024
-//       back-and-forth movements between the starting and end points.
1025
-//
1026
-//   P1: This starts a zig-zag pattern between (X0, Y0) and (X1, Y1), "T"
1027
-//       defines the number of zig-zag triangles to be done. "S" defines the
1028
-//       number of strokes aka one back-and-forth movement. Zig-zags will
1029
-//       be performed in whichever dimension is smallest. As an example,
1030
-//       sending "G12 P1 S1 T3" will execute:
1031
-//
1032
-//          --
1033
-//         |  (X0, Y1) |     /\        /\        /\     | (X1, Y1)
1034
-//         |           |    /  \      /  \      /  \    |
1035
-//       A |           |   /    \    /    \    /    \   |
1036
-//         |           |  /      \  /      \  /      \  |
1037
-//         |  (X0, Y0) | /        \/        \/        \ | (X1, Y0)
1038
-//          --         +--------------------------------+
1039
-//                       |________|_________|_________|
1040
-//                           T1        T2        T3
1041
-//
1042
-//   P2: This starts a circular pattern with circle with middle in
1043
-//       NOZZLE_CLEAN_CIRCLE_MIDDLE radius of R and stroke count of S.
1044
-//       Before starting the circle nozzle goes to NOZZLE_CLEAN_START_POINT.
1045
-//
1046
-// Caveats: End point Z should use the same value as Start point Z.
1047
-//
1048
-// Attention: This is an EXPERIMENTAL feature, in the future the G-code arguments
1049
-// may change to add new functionality like different wipe patterns.
1050
-//
1007
+/**
1008
+ * Clean Nozzle Feature -- EXPERIMENTAL
1009
+ *
1010
+ * Adds the G12 command to perform a nozzle cleaning process.
1011
+ *
1012
+ * Parameters:
1013
+ *   P  Pattern
1014
+ *   S  Strokes / Repetitions
1015
+ *   T  Triangles (P1 only)
1016
+ *
1017
+ * Patterns:
1018
+ *   P0  Straight line (default). This process requires a sponge type material
1019
+ *       at a fixed bed location. "S" specifies strokes (i.e. back-forth motions)
1020
+ *       between the start / end points.
1021
+ *
1022
+ *   P1  Zig-zag pattern between (X0, Y0) and (X1, Y1), "T" specifies the
1023
+ *       number of zig-zag triangles to do. "S" defines the number of strokes.
1024
+ *       Zig-zags are done in whichever is the narrower dimension.
1025
+ *       For example, "G12 P1 S1 T3" will execute:
1026
+ *
1027
+ *          --
1028
+ *         |  (X0, Y1) |     /\        /\        /\     | (X1, Y1)
1029
+ *         |           |    /  \      /  \      /  \    |
1030
+ *       A |           |   /    \    /    \    /    \   |
1031
+ *         |           |  /      \  /      \  /      \  |
1032
+ *         |  (X0, Y0) | /        \/        \/        \ | (X1, Y0)
1033
+ *          --         +--------------------------------+
1034
+ *                       |________|_________|_________|
1035
+ *                           T1        T2        T3
1036
+ *
1037
+ *   P2  Circular pattern with middle at NOZZLE_CLEAN_CIRCLE_MIDDLE.
1038
+ *       "R" specifies the radius. "S" specifies the stroke count.
1039
+ *       Before starting, the nozzle moves to NOZZLE_CLEAN_START_POINT.
1040
+ *
1041
+ *   Caveats: The ending Z should be the same as starting Z.
1042
+ * Attention: EXPERIMENTAL. G-code arguments may change.
1043
+ *
1044
+ */
1051 1045
 //#define NOZZLE_CLEAN_FEATURE
1052 1046
 
1053 1047
 #if ENABLED(NOZZLE_CLEAN_FEATURE)
@@ -1072,33 +1066,35 @@
1072 1066
   #define NOZZLE_CLEAN_GOBACK
1073 1067
 #endif
1074 1068
 
1075
-//
1076
-// Print job timer
1077
-//
1078
-// Enable this option to automatically start and stop the
1079
-// print job timer when M104/M109/M190 commands are received.
1080
-// M104 (extruder without wait) - high temp = none, low temp = stop timer
1081
-// M109 (extruder with wait) - high temp = start timer, low temp = stop timer
1082
-// M190 (bed with wait) - high temp = start timer, low temp = none
1083
-//
1084
-// In all cases the timer can be started and stopped using
1085
-// the following commands:
1086
-//
1087
-// - M75  - Start the print job timer
1088
-// - M76  - Pause the print job timer
1089
-// - M77  - Stop the print job timer
1069
+/**
1070
+ * Print Job Timer
1071
+ *
1072
+ * Automatically start and stop the print job timer on M104/M109/M190.
1073
+ *
1074
+ *   M104 (hotend, no wait) - high temp = none,        low temp = stop timer
1075
+ *   M109 (hotend, wait)    - high temp = start timer, low temp = stop timer
1076
+ *   M190 (bed, wait)       - high temp = start timer, low temp = none
1077
+ *
1078
+ * The timer can also be controlled with the following commands:
1079
+ *
1080
+ *   M75 - Start the print job timer
1081
+ *   M76 - Pause the print job timer
1082
+ *   M77 - Stop the print job timer
1083
+ */
1090 1084
 #define PRINTJOB_TIMER_AUTOSTART
1091 1085
 
1092
-//
1093
-// Print Counter
1094
-//
1095
-// When enabled Marlin will keep track of some print statistical data such as:
1096
-//  - Total print jobs
1097
-//  - Total successful print jobs
1098
-//  - Total failed print jobs
1099
-//  - Total time printing
1100
-//
1101
-// This information can be viewed by the M78 command.
1086
+/**
1087
+ * Print Counter
1088
+ *
1089
+ * Track statistical data such as:
1090
+ *
1091
+ *  - Total print jobs
1092
+ *  - Total successful print jobs
1093
+ *  - Total failed print jobs
1094
+ *  - Total time printing
1095
+ *
1096
+ * View the current statistics with M78.
1097
+ */
1102 1098
 //#define PRINTCOUNTER
1103 1099
 
1104 1100
 //=============================================================================
@@ -1107,78 +1103,79 @@
1107 1103
 
1108 1104
 // @section lcd
1109 1105
 
1110
-//
1111
-// LCD LANGUAGE
1112
-//
1113
-// Here you may choose the language used by Marlin on the LCD menus, the following
1114
-// list of languages are available:
1115
-//    en, an, bg, ca, cn, cz, de, el, el-gr, es, eu, fi, fr, gl, hr, it,
1116
-//    kana, kana_utf8, nl, pl, pt, pt_utf8, pt-br, pt-br_utf8, ru, tr, uk, test
1117
-//
1118
-// :{ 'en':'English', 'an':'Aragonese', 'bg':'Bulgarian', 'ca':'Catalan', 'cn':'Chinese', 'cz':'Czech', 'de':'German', 'el':'Greek', 'el-gr':'Greek (Greece)', 'es':'Spanish', 'eu':'Basque-Euskera', 'fi':'Finnish', 'fr':'French', 'gl':'Galician', 'hr':'Croatian', 'it':'Italian', 'kana':'Japanese', 'kana_utf8':'Japanese (UTF8)', 'nl':'Dutch', 'pl':'Polish', 'pt':'Portuguese', 'pt-br':'Portuguese (Brazilian)', 'pt-br_utf8':'Portuguese (Brazilian UTF8)', 'pt_utf8':'Portuguese (UTF8)', 'ru':'Russian', 'tr':'Turkish', 'uk':'Ukrainian', 'test':'TEST' }
1119
-//
1106
+/**
1107
+ * LCD LANGUAGE
1108
+ *
1109
+ * Select the language to display on the LCD. These languages are available:
1110
+ *
1111
+ *    en, an, bg, ca, cn, cz, de, el, el-gr, es, eu, fi, fr, gl, hr, it,
1112
+ *    kana, kana_utf8, nl, pl, pt, pt_utf8, pt-br, pt-br_utf8, ru, tr, uk, test
1113
+ *
1114
+ * :{ 'en':'English', 'an':'Aragonese', 'bg':'Bulgarian', 'ca':'Catalan', 'cn':'Chinese', 'cz':'Czech', 'de':'German', 'el':'Greek', 'el-gr':'Greek (Greece)', 'es':'Spanish', 'eu':'Basque-Euskera', 'fi':'Finnish', 'fr':'French', 'gl':'Galician', 'hr':'Croatian', 'it':'Italian', 'kana':'Japanese', 'kana_utf8':'Japanese (UTF8)', 'nl':'Dutch', 'pl':'Polish', 'pt':'Portuguese', 'pt-br':'Portuguese (Brazilian)', 'pt-br_utf8':'Portuguese (Brazilian UTF8)', 'pt_utf8':'Portuguese (UTF8)', 'ru':'Russian', 'tr':'Turkish', 'uk':'Ukrainian', 'test':'TEST' }
1115
+ */
1120 1116
 #define LCD_LANGUAGE en
1121 1117
 
1122
-//
1123
-// LCD Character Set
1124
-//
1125
-// Note: This option is NOT applicable to Graphical Displays.
1126
-//
1127
-// All character-based LCD's provide ASCII plus one of these
1128
-// language extensions:
1129
-//
1130
-//  - JAPANESE ... the most common
1131
-//  - WESTERN  ... with more accented characters
1132
-//  - CYRILLIC ... for the Russian language
1133
-//
1134
-// To determine the language extension installed on your controller:
1135
-//
1136
-//  - Compile and upload with LCD_LANGUAGE set to 'test'
1137
-//  - Click the controller to view the LCD menu
1138
-//  - The LCD will display Japanese, Western, or Cyrillic text
1139
-//
1140
-// See https://github.com/MarlinFirmware/Marlin/wiki/LCD-Language
1141
-//
1142
-// :['JAPANESE', 'WESTERN', 'CYRILLIC']
1143
-//
1118
+/**
1119
+ * LCD Character Set
1120
+ *
1121
+ * Note: This option is NOT applicable to Graphical Displays.
1122
+ *
1123
+ * All character-based LCDs provide ASCII plus one of these
1124
+ * language extensions:
1125
+ *
1126
+ *  - JAPANESE ... the most common
1127
+ *  - WESTERN  ... with more accented characters
1128
+ *  - CYRILLIC ... for the Russian language
1129
+ *
1130
+ * To determine the language extension installed on your controller:
1131
+ *
1132
+ *  - Compile and upload with LCD_LANGUAGE set to 'test'
1133
+ *  - Click the controller to view the LCD menu
1134
+ *  - The LCD will display Japanese, Western, or Cyrillic text
1135
+ *
1136
+ * See https: *github.com/MarlinFirmware/Marlin/wiki/LCD-Language
1137
+ *
1138
+ * :['JAPANESE', 'WESTERN', 'CYRILLIC']
1139
+ */
1144 1140
 #define DISPLAY_CHARSET_HD44780 JAPANESE
1145 1141
 
1146
-//
1147
-// LCD TYPE
1148
-//
1149
-// You may choose ULTRA_LCD if you have character based LCD with 16x2, 16x4, 20x2,
1150
-// 20x4 char/lines or DOGLCD for the full graphics display with 128x64 pixels
1151
-// (ST7565R family). (This option will be set automatically for certain displays.)
1152
-//
1153
-// IMPORTANT NOTE: The U8glib library is required for Full Graphic Display!
1154
-//                 https://github.com/olikraus/U8glib_Arduino
1155
-//
1142
+/**
1143
+ * LCD TYPE
1144
+ *
1145
+ * Enable ULTRA_LCD for a 16x2, 16x4, 20x2, or 20x4 character-based LCD.
1146
+ * Enable DOGLCD for a 128x64 (ST7565R) Full Graphical Display.
1147
+ * (These options will be enabled automatically for most displays.)
1148
+ *
1149
+ * IMPORTANT: The U8glib library is required for Full Graphic Display!
1150
+ *            https://github.com/olikraus/U8glib_Arduino
1151
+ */
1156 1152
 #define ULTRA_LCD   // Character based
1157 1153
 //#define DOGLCD      // Full graphics display
1158 1154
 
1159
-//
1160
-// SD CARD
1161
-//
1162
-// SD Card support is disabled by default. If your controller has an SD slot,
1163
-// you must uncomment the following option or it won't work.
1164
-//
1155
+/**
1156
+ * SD CARD
1157
+ *
1158
+ * SD Card support is disabled by default. If your controller has an SD slot,
1159
+ * you must uncomment the following option or it won't work.
1160
+ *
1161
+ */
1165 1162
 #define SDSUPPORT
1166 1163
 
1167
-//
1168
-// SD CARD: SPI SPEED
1169
-//
1170
-// Uncomment ONE of the following items to use a slower SPI transfer
1171
-// speed. This is usually required if you're getting volume init errors.
1172
-//
1164
+/**
1165
+ * SD CARD: SPI SPEED
1166
+ *
1167
+ * Enable one of the following items for a slower SPI transfer speed.
1168
+ * This may be required to resolve "volume init" errors.
1169
+ */
1173 1170
 //#define SPI_SPEED SPI_HALF_SPEED
1174 1171
 //#define SPI_SPEED SPI_QUARTER_SPEED
1175 1172
 //#define SPI_SPEED SPI_EIGHTH_SPEED
1176 1173
 
1177
-//
1178
-// SD CARD: ENABLE CRC
1179
-//
1180
-// Use CRC checks and retries on the SD communication.
1181
-//
1174
+/**
1175
+ * SD CARD: ENABLE CRC
1176
+ *
1177
+ * Use CRC checks and retries on the SD communication.
1178
+ */
1182 1179
 #define SD_CHECK_AND_RETRY
1183 1180
 
1184 1181
 //
@@ -1206,7 +1203,7 @@
1206 1203
  */
1207 1204
 
1208 1205
 //
1209
-// This option reverses the encoder direction everywhere
1206
+// This option reverses the encoder direction everywhere.
1210 1207
 //
1211 1208
 //  Set this option if CLOCKWISE causes values to DECREASE
1212 1209
 //

+ 137
- 140
Marlin/example_configurations/RigidBot/Configuration.h View File

@@ -985,23 +985,17 @@
985 985
 #define PREHEAT_2_TEMP_BED    110
986 986
 #define PREHEAT_2_FAN_SPEED   255 // Value from 0 to 255
987 987
 
988
-//
989
-// Nozzle Park -- EXPERIMENTAL
990
-//
991
-// When enabled allows the user to define a special XYZ position, inside the
992
-// machine's topology, to park the nozzle when idle or when receiving the G27
993
-// command.
994
-//
995
-// The "P" paramenter controls what is the action applied to the Z axis:
996
-//    P0: (Default) If current Z-pos is lower than Z-park then the nozzle will
997
-//        be raised to reach Z-park height.
998
-//
999
-//    P1: No matter the current Z-pos, the nozzle will be raised/lowered to
1000
-//        reach Z-park height.
1001
-//
1002
-//    P2: The nozzle height will be raised by Z-park amount but never going over
1003
-//        the machine's limit of Z_MAX_POS.
1004
-//
988
+/**
989
+ * Nozzle Park -- EXPERIMENTAL
990
+ *
991
+ * Park the nozzle at the given XYZ position on idle or G27.
992
+ *
993
+ * The "P" parameter controls the action applied to the Z axis:
994
+ *
995
+ *    P0  (Default) If Z is below park Z raise the nozzle.
996
+ *    P1  Raise the nozzle always to Z-park height.
997
+ *    P2  Raise the nozzle by Z-park amount, limited to Z_MAX_POS.
998
+ */
1005 999
 //#define NOZZLE_PARK_FEATURE
1006 1000
 
1007 1001
 #if ENABLED(NOZZLE_PARK_FEATURE)
@@ -1009,44 +1003,44 @@
1009 1003
   #define NOZZLE_PARK_POINT { (X_MIN_POS + 10), (Y_MAX_POS - 10), 20 }
1010 1004
 #endif
1011 1005
 
1012
-//
1013
-// Clean Nozzle Feature -- EXPERIMENTAL
1014
-//
1015
-// When enabled allows the user to send G12 to start the nozzle cleaning
1016
-// process, the G-Code accepts two parameters:
1017
-//   "P" for pattern selection
1018
-//   "S" for defining the number of strokes/repetitions
1019
-//
1020
-// Available list of patterns:
1021
-//   P0: This is the default pattern, this process requires a sponge type
1022
-//       material at a fixed bed location. S defines "strokes" i.e.
1023
-//       back-and-forth movements between the starting and end points.
1024
-//
1025
-//   P1: This starts a zig-zag pattern between (X0, Y0) and (X1, Y1), "T"
1026
-//       defines the number of zig-zag triangles to be done. "S" defines the
1027
-//       number of strokes aka one back-and-forth movement. Zig-zags will
1028
-//       be performed in whichever dimension is smallest. As an example,
1029
-//       sending "G12 P1 S1 T3" will execute:
1030
-//
1031
-//          --
1032
-//         |  (X0, Y1) |     /\        /\        /\     | (X1, Y1)
1033
-//         |           |    /  \      /  \      /  \    |
1034
-//       A |           |   /    \    /    \    /    \   |
1035
-//         |           |  /      \  /      \  /      \  |
1036
-//         |  (X0, Y0) | /        \/        \/        \ | (X1, Y0)
1037
-//          --         +--------------------------------+
1038
-//                       |________|_________|_________|
1039
-//                           T1        T2        T3
1040
-//
1041
-//   P2: This starts a circular pattern with circle with middle in
1042
-//       NOZZLE_CLEAN_CIRCLE_MIDDLE radius of R and stroke count of S.
1043
-//       Before starting the circle nozzle goes to NOZZLE_CLEAN_START_POINT.
1044
-//
1045
-// Caveats: End point Z should use the same value as Start point Z.
1046
-//
1047
-// Attention: This is an EXPERIMENTAL feature, in the future the G-code arguments
1048
-// may change to add new functionality like different wipe patterns.
1049
-//
1006
+/**
1007
+ * Clean Nozzle Feature -- EXPERIMENTAL
1008
+ *
1009
+ * Adds the G12 command to perform a nozzle cleaning process.
1010
+ *
1011
+ * Parameters:
1012
+ *   P  Pattern
1013
+ *   S  Strokes / Repetitions
1014
+ *   T  Triangles (P1 only)
1015
+ *
1016
+ * Patterns:
1017
+ *   P0  Straight line (default). This process requires a sponge type material
1018
+ *       at a fixed bed location. "S" specifies strokes (i.e. back-forth motions)
1019
+ *       between the start / end points.
1020
+ *
1021
+ *   P1  Zig-zag pattern between (X0, Y0) and (X1, Y1), "T" specifies the
1022
+ *       number of zig-zag triangles to do. "S" defines the number of strokes.
1023
+ *       Zig-zags are done in whichever is the narrower dimension.
1024
+ *       For example, "G12 P1 S1 T3" will execute:
1025
+ *
1026
+ *          --
1027
+ *         |  (X0, Y1) |     /\        /\        /\     | (X1, Y1)
1028
+ *         |           |    /  \      /  \      /  \    |
1029
+ *       A |           |   /    \    /    \    /    \   |
1030
+ *         |           |  /      \  /      \  /      \  |
1031
+ *         |  (X0, Y0) | /        \/        \/        \ | (X1, Y0)
1032
+ *          --         +--------------------------------+
1033
+ *                       |________|_________|_________|
1034
+ *                           T1        T2        T3
1035
+ *
1036
+ *   P2  Circular pattern with middle at NOZZLE_CLEAN_CIRCLE_MIDDLE.
1037
+ *       "R" specifies the radius. "S" specifies the stroke count.
1038
+ *       Before starting, the nozzle moves to NOZZLE_CLEAN_START_POINT.
1039
+ *
1040
+ *   Caveats: The ending Z should be the same as starting Z.
1041
+ * Attention: EXPERIMENTAL. G-code arguments may change.
1042
+ *
1043
+ */
1050 1044
 //#define NOZZLE_CLEAN_FEATURE
1051 1045
 
1052 1046
 #if ENABLED(NOZZLE_CLEAN_FEATURE)
@@ -1071,33 +1065,35 @@
1071 1065
   #define NOZZLE_CLEAN_GOBACK
1072 1066
 #endif
1073 1067
 
1074
-//
1075
-// Print job timer
1076
-//
1077
-// Enable this option to automatically start and stop the
1078
-// print job timer when M104/M109/M190 commands are received.
1079
-// M104 (extruder without wait) - high temp = none, low temp = stop timer
1080
-// M109 (extruder with wait) - high temp = start timer, low temp = stop timer
1081
-// M190 (bed with wait) - high temp = start timer, low temp = none
1082
-//
1083
-// In all cases the timer can be started and stopped using
1084
-// the following commands:
1085
-//
1086
-// - M75  - Start the print job timer
1087
-// - M76  - Pause the print job timer
1088
-// - M77  - Stop the print job timer
1068
+/**
1069
+ * Print Job Timer
1070
+ *
1071
+ * Automatically start and stop the print job timer on M104/M109/M190.
1072
+ *
1073
+ *   M104 (hotend, no wait) - high temp = none,        low temp = stop timer
1074
+ *   M109 (hotend, wait)    - high temp = start timer, low temp = stop timer
1075
+ *   M190 (bed, wait)       - high temp = start timer, low temp = none
1076
+ *
1077
+ * The timer can also be controlled with the following commands:
1078
+ *
1079
+ *   M75 - Start the print job timer
1080
+ *   M76 - Pause the print job timer
1081
+ *   M77 - Stop the print job timer
1082
+ */
1089 1083
 #define PRINTJOB_TIMER_AUTOSTART
1090 1084
 
1091
-//
1092
-// Print Counter
1093
-//
1094
-// When enabled Marlin will keep track of some print statistical data such as:
1095
-//  - Total print jobs
1096
-//  - Total successful print jobs
1097
-//  - Total failed print jobs
1098
-//  - Total time printing
1099
-//
1100
-// This information can be viewed by the M78 command.
1085
+/**
1086
+ * Print Counter
1087
+ *
1088
+ * Track statistical data such as:
1089
+ *
1090
+ *  - Total print jobs
1091
+ *  - Total successful print jobs
1092
+ *  - Total failed print jobs
1093
+ *  - Total time printing
1094
+ *
1095
+ * View the current statistics with M78.
1096
+ */
1101 1097
 //#define PRINTCOUNTER
1102 1098
 
1103 1099
 //=============================================================================
@@ -1106,78 +1102,79 @@
1106 1102
 
1107 1103
 // @section lcd
1108 1104
 
1109
-//
1110
-// LCD LANGUAGE
1111
-//
1112
-// Here you may choose the language used by Marlin on the LCD menus, the following
1113
-// list of languages are available:
1114
-//    en, an, bg, ca, cn, cz, de, el, el-gr, es, eu, fi, fr, gl, hr, it,
1115
-//    kana, kana_utf8, nl, pl, pt, pt_utf8, pt-br, pt-br_utf8, ru, tr, uk, test
1116
-//
1117
-// :{ 'en':'English', 'an':'Aragonese', 'bg':'Bulgarian', 'ca':'Catalan', 'cn':'Chinese', 'cz':'Czech', 'de':'German', 'el':'Greek', 'el-gr':'Greek (Greece)', 'es':'Spanish', 'eu':'Basque-Euskera', 'fi':'Finnish', 'fr':'French', 'gl':'Galician', 'hr':'Croatian', 'it':'Italian', 'kana':'Japanese', 'kana_utf8':'Japanese (UTF8)', 'nl':'Dutch', 'pl':'Polish', 'pt':'Portuguese', 'pt-br':'Portuguese (Brazilian)', 'pt-br_utf8':'Portuguese (Brazilian UTF8)', 'pt_utf8':'Portuguese (UTF8)', 'ru':'Russian', 'tr':'Turkish', 'uk':'Ukrainian', 'test':'TEST' }
1118
-//
1105
+/**
1106
+ * LCD LANGUAGE
1107
+ *
1108
+ * Select the language to display on the LCD. These languages are available:
1109
+ *
1110
+ *    en, an, bg, ca, cn, cz, de, el, el-gr, es, eu, fi, fr, gl, hr, it,
1111
+ *    kana, kana_utf8, nl, pl, pt, pt_utf8, pt-br, pt-br_utf8, ru, tr, uk, test
1112
+ *
1113
+ * :{ 'en':'English', 'an':'Aragonese', 'bg':'Bulgarian', 'ca':'Catalan', 'cn':'Chinese', 'cz':'Czech', 'de':'German', 'el':'Greek', 'el-gr':'Greek (Greece)', 'es':'Spanish', 'eu':'Basque-Euskera', 'fi':'Finnish', 'fr':'French', 'gl':'Galician', 'hr':'Croatian', 'it':'Italian', 'kana':'Japanese', 'kana_utf8':'Japanese (UTF8)', 'nl':'Dutch', 'pl':'Polish', 'pt':'Portuguese', 'pt-br':'Portuguese (Brazilian)', 'pt-br_utf8':'Portuguese (Brazilian UTF8)', 'pt_utf8':'Portuguese (UTF8)', 'ru':'Russian', 'tr':'Turkish', 'uk':'Ukrainian', 'test':'TEST' }
1114
+ */
1119 1115
 #define LCD_LANGUAGE en
1120 1116
 
1121
-//
1122
-// LCD Character Set
1123
-//
1124
-// Note: This option is NOT applicable to Graphical Displays.
1125
-//
1126
-// All character-based LCD's provide ASCII plus one of these
1127
-// language extensions:
1128
-//
1129
-//  - JAPANESE ... the most common
1130
-//  - WESTERN  ... with more accented characters
1131
-//  - CYRILLIC ... for the Russian language
1132
-//
1133
-// To determine the language extension installed on your controller:
1134
-//
1135
-//  - Compile and upload with LCD_LANGUAGE set to 'test'
1136
-//  - Click the controller to view the LCD menu
1137
-//  - The LCD will display Japanese, Western, or Cyrillic text
1138
-//
1139
-// See https://github.com/MarlinFirmware/Marlin/wiki/LCD-Language
1140
-//
1141
-// :['JAPANESE', 'WESTERN', 'CYRILLIC']
1142
-//
1117
+/**
1118
+ * LCD Character Set
1119
+ *
1120
+ * Note: This option is NOT applicable to Graphical Displays.
1121
+ *
1122
+ * All character-based LCDs provide ASCII plus one of these
1123
+ * language extensions:
1124
+ *
1125
+ *  - JAPANESE ... the most common
1126
+ *  - WESTERN  ... with more accented characters
1127
+ *  - CYRILLIC ... for the Russian language
1128
+ *
1129
+ * To determine the language extension installed on your controller:
1130
+ *
1131
+ *  - Compile and upload with LCD_LANGUAGE set to 'test'
1132
+ *  - Click the controller to view the LCD menu
1133
+ *  - The LCD will display Japanese, Western, or Cyrillic text
1134
+ *
1135
+ * See https: *github.com/MarlinFirmware/Marlin/wiki/LCD-Language
1136
+ *
1137
+ * :['JAPANESE', 'WESTERN', 'CYRILLIC']
1138
+ */
1143 1139
 #define DISPLAY_CHARSET_HD44780 JAPANESE
1144 1140
 
1145
-//
1146
-// LCD TYPE
1147
-//
1148
-// You may choose ULTRA_LCD if you have character based LCD with 16x2, 16x4, 20x2,
1149
-// 20x4 char/lines or DOGLCD for the full graphics display with 128x64 pixels
1150
-// (ST7565R family). (This option will be set automatically for certain displays.)
1151
-//
1152
-// IMPORTANT NOTE: The U8glib library is required for Full Graphic Display!
1153
-//                 https://github.com/olikraus/U8glib_Arduino
1154
-//
1141
+/**
1142
+ * LCD TYPE
1143
+ *
1144
+ * Enable ULTRA_LCD for a 16x2, 16x4, 20x2, or 20x4 character-based LCD.
1145
+ * Enable DOGLCD for a 128x64 (ST7565R) Full Graphical Display.
1146
+ * (These options will be enabled automatically for most displays.)
1147
+ *
1148
+ * IMPORTANT: The U8glib library is required for Full Graphic Display!
1149
+ *            https://github.com/olikraus/U8glib_Arduino
1150
+ */
1155 1151
 //#define ULTRA_LCD   // Character based
1156 1152
 //#define DOGLCD      // Full graphics display
1157 1153
 
1158
-//
1159
-// SD CARD
1160
-//
1161
-// SD Card support is disabled by default. If your controller has an SD slot,
1162
-// you must uncomment the following option or it won't work.
1163
-//
1154
+/**
1155
+ * SD CARD
1156
+ *
1157
+ * SD Card support is disabled by default. If your controller has an SD slot,
1158
+ * you must uncomment the following option or it won't work.
1159
+ *
1160
+ */
1164 1161
 #define SDSUPPORT
1165 1162
 
1166
-//
1167
-// SD CARD: SPI SPEED
1168
-//
1169
-// Uncomment ONE of the following items to use a slower SPI transfer
1170
-// speed. This is usually required if you're getting volume init errors.
1171
-//
1163
+/**
1164
+ * SD CARD: SPI SPEED
1165
+ *
1166
+ * Enable one of the following items for a slower SPI transfer speed.
1167
+ * This may be required to resolve "volume init" errors.
1168
+ */
1172 1169
 //#define SPI_SPEED SPI_HALF_SPEED
1173 1170
 //#define SPI_SPEED SPI_QUARTER_SPEED
1174 1171
 #define SPI_SPEED SPI_EIGHTH_SPEED
1175 1172
 
1176
-//
1177
-// SD CARD: ENABLE CRC
1178
-//
1179
-// Use CRC checks and retries on the SD communication.
1180
-//
1173
+/**
1174
+ * SD CARD: ENABLE CRC
1175
+ *
1176
+ * Use CRC checks and retries on the SD communication.
1177
+ */
1181 1178
 //#define SD_CHECK_AND_RETRY
1182 1179
 
1183 1180
 //
@@ -1205,7 +1202,7 @@
1205 1202
  */
1206 1203
 
1207 1204
 //
1208
-// This option reverses the encoder direction everywhere
1205
+// This option reverses the encoder direction everywhere.
1209 1206
 //
1210 1207
 //  Set this option if CLOCKWISE causes values to DECREASE
1211 1208
 //

+ 137
- 140
Marlin/example_configurations/SCARA/Configuration.h View File

@@ -1001,23 +1001,17 @@
1001 1001
 #define PREHEAT_2_TEMP_BED    100
1002 1002
 #define PREHEAT_2_FAN_SPEED   255 // Value from 0 to 255
1003 1003
 
1004
-//
1005
-// Nozzle Park -- EXPERIMENTAL
1006
-//
1007
-// When enabled allows the user to define a special XYZ position, inside the
1008
-// machine's topology, to park the nozzle when idle or when receiving the G27
1009
-// command.
1010
-//
1011
-// The "P" paramenter controls what is the action applied to the Z axis:
1012
-//    P0: (Default) If current Z-pos is lower than Z-park then the nozzle will
1013
-//        be raised to reach Z-park height.
1014
-//
1015
-//    P1: No matter the current Z-pos, the nozzle will be raised/lowered to
1016
-//        reach Z-park height.
1017
-//
1018
-//    P2: The nozzle height will be raised by Z-park amount but never going over
1019
-//        the machine's limit of Z_MAX_POS.
1020
-//
1004
+/**
1005
+ * Nozzle Park -- EXPERIMENTAL
1006
+ *
1007
+ * Park the nozzle at the given XYZ position on idle or G27.
1008
+ *
1009
+ * The "P" parameter controls the action applied to the Z axis:
1010
+ *
1011
+ *    P0  (Default) If Z is below park Z raise the nozzle.
1012
+ *    P1  Raise the nozzle always to Z-park height.
1013
+ *    P2  Raise the nozzle by Z-park amount, limited to Z_MAX_POS.
1014
+ */
1021 1015
 //#define NOZZLE_PARK_FEATURE
1022 1016
 
1023 1017
 #if ENABLED(NOZZLE_PARK_FEATURE)
@@ -1025,44 +1019,44 @@
1025 1019
   #define NOZZLE_PARK_POINT { (X_MIN_POS + 10), (Y_MAX_POS - 10), 20 }
1026 1020
 #endif
1027 1021
 
1028
-//
1029
-// Clean Nozzle Feature -- EXPERIMENTAL
1030
-//
1031
-// When enabled allows the user to send G12 to start the nozzle cleaning
1032
-// process, the G-Code accepts two parameters:
1033
-//   "P" for pattern selection
1034
-//   "S" for defining the number of strokes/repetitions
1035
-//
1036
-// Available list of patterns:
1037
-//   P0: This is the default pattern, this process requires a sponge type
1038
-//       material at a fixed bed location. S defines "strokes" i.e.
1039
-//       back-and-forth movements between the starting and end points.
1040
-//
1041
-//   P1: This starts a zig-zag pattern between (X0, Y0) and (X1, Y1), "T"
1042
-//       defines the number of zig-zag triangles to be done. "S" defines the
1043
-//       number of strokes aka one back-and-forth movement. Zig-zags will
1044
-//       be performed in whichever dimension is smallest. As an example,
1045
-//       sending "G12 P1 S1 T3" will execute:
1046
-//
1047
-//          --
1048
-//         |  (X0, Y1) |     /\        /\        /\     | (X1, Y1)
1049
-//         |           |    /  \      /  \      /  \    |
1050
-//       A |           |   /    \    /    \    /    \   |
1051
-//         |           |  /      \  /      \  /      \  |
1052
-//         |  (X0, Y0) | /        \/        \/        \ | (X1, Y0)
1053
-//          --         +--------------------------------+
1054
-//                       |________|_________|_________|
1055
-//                           T1        T2        T3
1056
-//
1057
-//   P2: This starts a circular pattern with circle with middle in
1058
-//       NOZZLE_CLEAN_CIRCLE_MIDDLE radius of R and stroke count of S.
1059
-//       Before starting the circle nozzle goes to NOZZLE_CLEAN_START_POINT.
1060
-//
1061
-// Caveats: End point Z should use the same value as Start point Z.
1062
-//
1063
-// Attention: This is an EXPERIMENTAL feature, in the future the G-code arguments
1064
-// may change to add new functionality like different wipe patterns.
1065
-//
1022
+/**
1023
+ * Clean Nozzle Feature -- EXPERIMENTAL
1024
+ *
1025
+ * Adds the G12 command to perform a nozzle cleaning process.
1026
+ *
1027
+ * Parameters:
1028
+ *   P  Pattern
1029
+ *   S  Strokes / Repetitions
1030
+ *   T  Triangles (P1 only)
1031
+ *
1032
+ * Patterns:
1033
+ *   P0  Straight line (default). This process requires a sponge type material
1034
+ *       at a fixed bed location. "S" specifies strokes (i.e. back-forth motions)
1035
+ *       between the start / end points.
1036
+ *
1037
+ *   P1  Zig-zag pattern between (X0, Y0) and (X1, Y1), "T" specifies the
1038
+ *       number of zig-zag triangles to do. "S" defines the number of strokes.
1039
+ *       Zig-zags are done in whichever is the narrower dimension.
1040
+ *       For example, "G12 P1 S1 T3" will execute:
1041
+ *
1042
+ *          --
1043
+ *         |  (X0, Y1) |     /\        /\        /\     | (X1, Y1)
1044
+ *         |           |    /  \      /  \      /  \    |
1045
+ *       A |           |   /    \    /    \    /    \   |
1046
+ *         |           |  /      \  /      \  /      \  |
1047
+ *         |  (X0, Y0) | /        \/        \/        \ | (X1, Y0)
1048
+ *          --         +--------------------------------+
1049
+ *                       |________|_________|_________|
1050
+ *                           T1        T2        T3
1051
+ *
1052
+ *   P2  Circular pattern with middle at NOZZLE_CLEAN_CIRCLE_MIDDLE.
1053
+ *       "R" specifies the radius. "S" specifies the stroke count.
1054
+ *       Before starting, the nozzle moves to NOZZLE_CLEAN_START_POINT.
1055
+ *
1056
+ *   Caveats: The ending Z should be the same as starting Z.
1057
+ * Attention: EXPERIMENTAL. G-code arguments may change.
1058
+ *
1059
+ */
1066 1060
 //#define NOZZLE_CLEAN_FEATURE
1067 1061
 
1068 1062
 #if ENABLED(NOZZLE_CLEAN_FEATURE)
@@ -1087,33 +1081,35 @@
1087 1081
   #define NOZZLE_CLEAN_GOBACK
1088 1082
 #endif
1089 1083
 
1090
-//
1091
-// Print job timer
1092
-//
1093
-// Enable this option to automatically start and stop the
1094
-// print job timer when M104/M109/M190 commands are received.
1095
-// M104 (extruder without wait) - high temp = none, low temp = stop timer
1096
-// M109 (extruder with wait) - high temp = start timer, low temp = stop timer
1097
-// M190 (bed with wait) - high temp = start timer, low temp = none
1098
-//
1099
-// In all cases the timer can be started and stopped using
1100
-// the following commands:
1101
-//
1102
-// - M75  - Start the print job timer
1103
-// - M76  - Pause the print job timer
1104
-// - M77  - Stop the print job timer
1084
+/**
1085
+ * Print Job Timer
1086
+ *
1087
+ * Automatically start and stop the print job timer on M104/M109/M190.
1088
+ *
1089
+ *   M104 (hotend, no wait) - high temp = none,        low temp = stop timer
1090
+ *   M109 (hotend, wait)    - high temp = start timer, low temp = stop timer
1091
+ *   M190 (bed, wait)       - high temp = start timer, low temp = none
1092
+ *
1093
+ * The timer can also be controlled with the following commands:
1094
+ *
1095
+ *   M75 - Start the print job timer
1096
+ *   M76 - Pause the print job timer
1097
+ *   M77 - Stop the print job timer
1098
+ */
1105 1099
 #define PRINTJOB_TIMER_AUTOSTART
1106 1100
 
1107
-//
1108
-// Print Counter
1109
-//
1110
-// When enabled Marlin will keep track of some print statistical data such as:
1111
-//  - Total print jobs
1112
-//  - Total successful print jobs
1113
-//  - Total failed print jobs
1114
-//  - Total time printing
1115
-//
1116
-// This information can be viewed by the M78 command.
1101
+/**
1102
+ * Print Counter
1103
+ *
1104
+ * Track statistical data such as:
1105
+ *
1106
+ *  - Total print jobs
1107
+ *  - Total successful print jobs
1108
+ *  - Total failed print jobs
1109
+ *  - Total time printing
1110
+ *
1111
+ * View the current statistics with M78.
1112
+ */
1117 1113
 //#define PRINTCOUNTER
1118 1114
 
1119 1115
 //=============================================================================
@@ -1122,78 +1118,79 @@
1122 1118
 
1123 1119
 // @section lcd
1124 1120
 
1125
-//
1126
-// LCD LANGUAGE
1127
-//
1128
-// Here you may choose the language used by Marlin on the LCD menus, the following
1129
-// list of languages are available:
1130
-//    en, an, bg, ca, cn, cz, de, el, el-gr, es, eu, fi, fr, gl, hr, it,
1131
-//    kana, kana_utf8, nl, pl, pt, pt_utf8, pt-br, pt-br_utf8, ru, tr, uk, test
1132
-//
1133
-// :{ 'en':'English', 'an':'Aragonese', 'bg':'Bulgarian', 'ca':'Catalan', 'cn':'Chinese', 'cz':'Czech', 'de':'German', 'el':'Greek', 'el-gr':'Greek (Greece)', 'es':'Spanish', 'eu':'Basque-Euskera', 'fi':'Finnish', 'fr':'French', 'gl':'Galician', 'hr':'Croatian', 'it':'Italian', 'kana':'Japanese', 'kana_utf8':'Japanese (UTF8)', 'nl':'Dutch', 'pl':'Polish', 'pt':'Portuguese', 'pt-br':'Portuguese (Brazilian)', 'pt-br_utf8':'Portuguese (Brazilian UTF8)', 'pt_utf8':'Portuguese (UTF8)', 'ru':'Russian', 'tr':'Turkish', 'uk':'Ukrainian', 'test':'TEST' }
1134
-//
1121
+/**
1122
+ * LCD LANGUAGE
1123
+ *
1124
+ * Select the language to display on the LCD. These languages are available:
1125
+ *
1126
+ *    en, an, bg, ca, cn, cz, de, el, el-gr, es, eu, fi, fr, gl, hr, it,
1127
+ *    kana, kana_utf8, nl, pl, pt, pt_utf8, pt-br, pt-br_utf8, ru, tr, uk, test
1128
+ *
1129
+ * :{ 'en':'English', 'an':'Aragonese', 'bg':'Bulgarian', 'ca':'Catalan', 'cn':'Chinese', 'cz':'Czech', 'de':'German', 'el':'Greek', 'el-gr':'Greek (Greece)', 'es':'Spanish', 'eu':'Basque-Euskera', 'fi':'Finnish', 'fr':'French', 'gl':'Galician', 'hr':'Croatian', 'it':'Italian', 'kana':'Japanese', 'kana_utf8':'Japanese (UTF8)', 'nl':'Dutch', 'pl':'Polish', 'pt':'Portuguese', 'pt-br':'Portuguese (Brazilian)', 'pt-br_utf8':'Portuguese (Brazilian UTF8)', 'pt_utf8':'Portuguese (UTF8)', 'ru':'Russian', 'tr':'Turkish', 'uk':'Ukrainian', 'test':'TEST' }
1130
+ */
1135 1131
 //#define LCD_LANGUAGE en
1136 1132
 
1137
-//
1138
-// LCD Character Set
1139
-//
1140
-// Note: This option is NOT applicable to Graphical Displays.
1141
-//
1142
-// All character-based LCD's provide ASCII plus one of these
1143
-// language extensions:
1144
-//
1145
-//  - JAPANESE ... the most common
1146
-//  - WESTERN  ... with more accented characters
1147
-//  - CYRILLIC ... for the Russian language
1148
-//
1149
-// To determine the language extension installed on your controller:
1150
-//
1151
-//  - Compile and upload with LCD_LANGUAGE set to 'test'
1152
-//  - Click the controller to view the LCD menu
1153
-//  - The LCD will display Japanese, Western, or Cyrillic text
1154
-//
1155
-// See https://github.com/MarlinFirmware/Marlin/wiki/LCD-Language
1156
-//
1157
-// :['JAPANESE', 'WESTERN', 'CYRILLIC']
1158
-//
1133
+/**
1134
+ * LCD Character Set
1135
+ *
1136
+ * Note: This option is NOT applicable to Graphical Displays.
1137
+ *
1138
+ * All character-based LCDs provide ASCII plus one of these
1139
+ * language extensions:
1140
+ *
1141
+ *  - JAPANESE ... the most common
1142
+ *  - WESTERN  ... with more accented characters
1143
+ *  - CYRILLIC ... for the Russian language
1144
+ *
1145
+ * To determine the language extension installed on your controller:
1146
+ *
1147
+ *  - Compile and upload with LCD_LANGUAGE set to 'test'
1148
+ *  - Click the controller to view the LCD menu
1149
+ *  - The LCD will display Japanese, Western, or Cyrillic text
1150
+ *
1151
+ * See https: *github.com/MarlinFirmware/Marlin/wiki/LCD-Language
1152
+ *
1153
+ * :['JAPANESE', 'WESTERN', 'CYRILLIC']
1154
+ */
1159 1155
 #define DISPLAY_CHARSET_HD44780 JAPANESE
1160 1156
 
1161
-//
1162
-// LCD TYPE
1163
-//
1164
-// You may choose ULTRA_LCD if you have character based LCD with 16x2, 16x4, 20x2,
1165
-// 20x4 char/lines or DOGLCD for the full graphics display with 128x64 pixels
1166
-// (ST7565R family). (This option will be set automatically for certain displays.)
1167
-//
1168
-// IMPORTANT NOTE: The U8glib library is required for Full Graphic Display!
1169
-//                 https://github.com/olikraus/U8glib_Arduino
1170
-//
1157
+/**
1158
+ * LCD TYPE
1159
+ *
1160
+ * Enable ULTRA_LCD for a 16x2, 16x4, 20x2, or 20x4 character-based LCD.
1161
+ * Enable DOGLCD for a 128x64 (ST7565R) Full Graphical Display.
1162
+ * (These options will be enabled automatically for most displays.)
1163
+ *
1164
+ * IMPORTANT: The U8glib library is required for Full Graphic Display!
1165
+ *            https://github.com/olikraus/U8glib_Arduino
1166
+ */
1171 1167
 //#define ULTRA_LCD   // Character based
1172 1168
 //#define DOGLCD      // Full graphics display
1173 1169
 
1174
-//
1175
-// SD CARD
1176
-//
1177
-// SD Card support is disabled by default. If your controller has an SD slot,
1178
-// you must uncomment the following option or it won't work.
1179
-//
1170
+/**
1171
+ * SD CARD
1172
+ *
1173
+ * SD Card support is disabled by default. If your controller has an SD slot,
1174
+ * you must uncomment the following option or it won't work.
1175
+ *
1176
+ */
1180 1177
 //#define SDSUPPORT
1181 1178
 
1182
-//
1183
-// SD CARD: SPI SPEED
1184
-//
1185
-// Uncomment ONE of the following items to use a slower SPI transfer
1186
-// speed. This is usually required if you're getting volume init errors.
1187
-//
1179
+/**
1180
+ * SD CARD: SPI SPEED
1181
+ *
1182
+ * Enable one of the following items for a slower SPI transfer speed.
1183
+ * This may be required to resolve "volume init" errors.
1184
+ */
1188 1185
 //#define SPI_SPEED SPI_HALF_SPEED
1189 1186
 //#define SPI_SPEED SPI_QUARTER_SPEED
1190 1187
 //#define SPI_SPEED SPI_EIGHTH_SPEED
1191 1188
 
1192
-//
1193
-// SD CARD: ENABLE CRC
1194
-//
1195
-// Use CRC checks and retries on the SD communication.
1196
-//
1189
+/**
1190
+ * SD CARD: ENABLE CRC
1191
+ *
1192
+ * Use CRC checks and retries on the SD communication.
1193
+ */
1197 1194
 //#define SD_CHECK_AND_RETRY
1198 1195
 
1199 1196
 //
@@ -1221,7 +1218,7 @@
1221 1218
  */
1222 1219
 
1223 1220
 //
1224
-// This option reverses the encoder direction everywhere
1221
+// This option reverses the encoder direction everywhere.
1225 1222
 //
1226 1223
 //  Set this option if CLOCKWISE causes values to DECREASE
1227 1224
 //

+ 137
- 140
Marlin/example_configurations/TAZ4/Configuration.h View File

@@ -1006,23 +1006,17 @@
1006 1006
 #define PREHEAT_2_TEMP_BED    110
1007 1007
 #define PREHEAT_2_FAN_SPEED     0 // Value from 0 to 255
1008 1008
 
1009
-//
1010
-// Nozzle Park -- EXPERIMENTAL
1011
-//
1012
-// When enabled allows the user to define a special XYZ position, inside the
1013
-// machine's topology, to park the nozzle when idle or when receiving the G27
1014
-// command.
1015
-//
1016
-// The "P" paramenter controls what is the action applied to the Z axis:
1017
-//    P0: (Default) If current Z-pos is lower than Z-park then the nozzle will
1018
-//        be raised to reach Z-park height.
1019
-//
1020
-//    P1: No matter the current Z-pos, the nozzle will be raised/lowered to
1021
-//        reach Z-park height.
1022
-//
1023
-//    P2: The nozzle height will be raised by Z-park amount but never going over
1024
-//        the machine's limit of Z_MAX_POS.
1025
-//
1009
+/**
1010
+ * Nozzle Park -- EXPERIMENTAL
1011
+ *
1012
+ * Park the nozzle at the given XYZ position on idle or G27.
1013
+ *
1014
+ * The "P" parameter controls the action applied to the Z axis:
1015
+ *
1016
+ *    P0  (Default) If Z is below park Z raise the nozzle.
1017
+ *    P1  Raise the nozzle always to Z-park height.
1018
+ *    P2  Raise the nozzle by Z-park amount, limited to Z_MAX_POS.
1019
+ */
1026 1020
 //#define NOZZLE_PARK_FEATURE
1027 1021
 
1028 1022
 #if ENABLED(NOZZLE_PARK_FEATURE)
@@ -1030,44 +1024,44 @@
1030 1024
   #define NOZZLE_PARK_POINT { (X_MIN_POS + 10), (Y_MAX_POS - 10), 20 }
1031 1025
 #endif
1032 1026
 
1033
-//
1034
-// Clean Nozzle Feature -- EXPERIMENTAL
1035
-//
1036
-// When enabled allows the user to send G12 to start the nozzle cleaning
1037
-// process, the G-Code accepts two parameters:
1038
-//   "P" for pattern selection
1039
-//   "S" for defining the number of strokes/repetitions
1040
-//
1041
-// Available list of patterns:
1042
-//   P0: This is the default pattern, this process requires a sponge type
1043
-//       material at a fixed bed location. S defines "strokes" i.e.
1044
-//       back-and-forth movements between the starting and end points.
1045
-//
1046
-//   P1: This starts a zig-zag pattern between (X0, Y0) and (X1, Y1), "T"
1047
-//       defines the number of zig-zag triangles to be done. "S" defines the
1048
-//       number of strokes aka one back-and-forth movement. Zig-zags will
1049
-//       be performed in whichever dimension is smallest. As an example,
1050
-//       sending "G12 P1 S1 T3" will execute:
1051
-//
1052
-//          --
1053
-//         |  (X0, Y1) |     /\        /\        /\     | (X1, Y1)
1054
-//         |           |    /  \      /  \      /  \    |
1055
-//       A |           |   /    \    /    \    /    \   |
1056
-//         |           |  /      \  /      \  /      \  |
1057
-//         |  (X0, Y0) | /        \/        \/        \ | (X1, Y0)
1058
-//          --         +--------------------------------+
1059
-//                       |________|_________|_________|
1060
-//                           T1        T2        T3
1061
-//
1062
-//   P2: This starts a circular pattern with circle with middle in
1063
-//       NOZZLE_CLEAN_CIRCLE_MIDDLE radius of R and stroke count of S.
1064
-//       Before starting the circle nozzle goes to NOZZLE_CLEAN_START_POINT.
1065
-//
1066
-// Caveats: End point Z should use the same value as Start point Z.
1067
-//
1068
-// Attention: This is an EXPERIMENTAL feature, in the future the G-code arguments
1069
-// may change to add new functionality like different wipe patterns.
1070
-//
1027
+/**
1028
+ * Clean Nozzle Feature -- EXPERIMENTAL
1029
+ *
1030
+ * Adds the G12 command to perform a nozzle cleaning process.
1031
+ *
1032
+ * Parameters:
1033
+ *   P  Pattern
1034
+ *   S  Strokes / Repetitions
1035
+ *   T  Triangles (P1 only)
1036
+ *
1037
+ * Patterns:
1038
+ *   P0  Straight line (default). This process requires a sponge type material
1039
+ *       at a fixed bed location. "S" specifies strokes (i.e. back-forth motions)
1040
+ *       between the start / end points.
1041
+ *
1042
+ *   P1  Zig-zag pattern between (X0, Y0) and (X1, Y1), "T" specifies the
1043
+ *       number of zig-zag triangles to do. "S" defines the number of strokes.
1044
+ *       Zig-zags are done in whichever is the narrower dimension.
1045
+ *       For example, "G12 P1 S1 T3" will execute:
1046
+ *
1047
+ *          --
1048
+ *         |  (X0, Y1) |     /\        /\        /\     | (X1, Y1)
1049
+ *         |           |    /  \      /  \      /  \    |
1050
+ *       A |           |   /    \    /    \    /    \   |
1051
+ *         |           |  /      \  /      \  /      \  |
1052
+ *         |  (X0, Y0) | /        \/        \/        \ | (X1, Y0)
1053
+ *          --         +--------------------------------+
1054
+ *                       |________|_________|_________|
1055
+ *                           T1        T2        T3
1056
+ *
1057
+ *   P2  Circular pattern with middle at NOZZLE_CLEAN_CIRCLE_MIDDLE.
1058
+ *       "R" specifies the radius. "S" specifies the stroke count.
1059
+ *       Before starting, the nozzle moves to NOZZLE_CLEAN_START_POINT.
1060
+ *
1061
+ *   Caveats: The ending Z should be the same as starting Z.
1062
+ * Attention: EXPERIMENTAL. G-code arguments may change.
1063
+ *
1064
+ */
1071 1065
 //#define NOZZLE_CLEAN_FEATURE
1072 1066
 
1073 1067
 #if ENABLED(NOZZLE_CLEAN_FEATURE)
@@ -1092,33 +1086,35 @@
1092 1086
   #define NOZZLE_CLEAN_GOBACK
1093 1087
 #endif
1094 1088
 
1095
-//
1096
-// Print job timer
1097
-//
1098
-// Enable this option to automatically start and stop the
1099
-// print job timer when M104/M109/M190 commands are received.
1100
-// M104 (extruder without wait) - high temp = none, low temp = stop timer
1101
-// M109 (extruder with wait) - high temp = start timer, low temp = stop timer
1102
-// M190 (bed with wait) - high temp = start timer, low temp = none
1103
-//
1104
-// In all cases the timer can be started and stopped using
1105
-// the following commands:
1106
-//
1107
-// - M75  - Start the print job timer
1108
-// - M76  - Pause the print job timer
1109
-// - M77  - Stop the print job timer
1089
+/**
1090
+ * Print Job Timer
1091
+ *
1092
+ * Automatically start and stop the print job timer on M104/M109/M190.
1093
+ *
1094
+ *   M104 (hotend, no wait) - high temp = none,        low temp = stop timer
1095
+ *   M109 (hotend, wait)    - high temp = start timer, low temp = stop timer
1096
+ *   M190 (bed, wait)       - high temp = start timer, low temp = none
1097
+ *
1098
+ * The timer can also be controlled with the following commands:
1099
+ *
1100
+ *   M75 - Start the print job timer
1101
+ *   M76 - Pause the print job timer
1102
+ *   M77 - Stop the print job timer
1103
+ */
1110 1104
 #define PRINTJOB_TIMER_AUTOSTART
1111 1105
 
1112
-//
1113
-// Print Counter
1114
-//
1115
-// When enabled Marlin will keep track of some print statistical data such as:
1116
-//  - Total print jobs
1117
-//  - Total successful print jobs
1118
-//  - Total failed print jobs
1119
-//  - Total time printing
1120
-//
1121
-// This information can be viewed by the M78 command.
1106
+/**
1107
+ * Print Counter
1108
+ *
1109
+ * Track statistical data such as:
1110
+ *
1111
+ *  - Total print jobs
1112
+ *  - Total successful print jobs
1113
+ *  - Total failed print jobs
1114
+ *  - Total time printing
1115
+ *
1116
+ * View the current statistics with M78.
1117
+ */
1122 1118
 //#define PRINTCOUNTER
1123 1119
 
1124 1120
 //=============================================================================
@@ -1127,78 +1123,79 @@
1127 1123
 
1128 1124
 // @section lcd
1129 1125
 
1130
-//
1131
-// LCD LANGUAGE
1132
-//
1133
-// Here you may choose the language used by Marlin on the LCD menus, the following
1134
-// list of languages are available:
1135
-//    en, an, bg, ca, cn, cz, de, el, el-gr, es, eu, fi, fr, gl, hr, it,
1136
-//    kana, kana_utf8, nl, pl, pt, pt_utf8, pt-br, pt-br_utf8, ru, tr, uk, test
1137
-//
1138
-// :{ 'en':'English', 'an':'Aragonese', 'bg':'Bulgarian', 'ca':'Catalan', 'cn':'Chinese', 'cz':'Czech', 'de':'German', 'el':'Greek', 'el-gr':'Greek (Greece)', 'es':'Spanish', 'eu':'Basque-Euskera', 'fi':'Finnish', 'fr':'French', 'gl':'Galician', 'hr':'Croatian', 'it':'Italian', 'kana':'Japanese', 'kana_utf8':'Japanese (UTF8)', 'nl':'Dutch', 'pl':'Polish', 'pt':'Portuguese', 'pt-br':'Portuguese (Brazilian)', 'pt-br_utf8':'Portuguese (Brazilian UTF8)', 'pt_utf8':'Portuguese (UTF8)', 'ru':'Russian', 'tr':'Turkish', 'uk':'Ukrainian', 'test':'TEST' }
1139
-//
1126
+/**
1127
+ * LCD LANGUAGE
1128
+ *
1129
+ * Select the language to display on the LCD. These languages are available:
1130
+ *
1131
+ *    en, an, bg, ca, cn, cz, de, el, el-gr, es, eu, fi, fr, gl, hr, it,
1132
+ *    kana, kana_utf8, nl, pl, pt, pt_utf8, pt-br, pt-br_utf8, ru, tr, uk, test
1133
+ *
1134
+ * :{ 'en':'English', 'an':'Aragonese', 'bg':'Bulgarian', 'ca':'Catalan', 'cn':'Chinese', 'cz':'Czech', 'de':'German', 'el':'Greek', 'el-gr':'Greek (Greece)', 'es':'Spanish', 'eu':'Basque-Euskera', 'fi':'Finnish', 'fr':'French', 'gl':'Galician', 'hr':'Croatian', 'it':'Italian', 'kana':'Japanese', 'kana_utf8':'Japanese (UTF8)', 'nl':'Dutch', 'pl':'Polish', 'pt':'Portuguese', 'pt-br':'Portuguese (Brazilian)', 'pt-br_utf8':'Portuguese (Brazilian UTF8)', 'pt_utf8':'Portuguese (UTF8)', 'ru':'Russian', 'tr':'Turkish', 'uk':'Ukrainian', 'test':'TEST' }
1135
+ */
1140 1136
 #define LCD_LANGUAGE en
1141 1137
 
1142
-//
1143
-// LCD Character Set
1144
-//
1145
-// Note: This option is NOT applicable to Graphical Displays.
1146
-//
1147
-// All character-based LCD's provide ASCII plus one of these
1148
-// language extensions:
1149
-//
1150
-//  - JAPANESE ... the most common
1151
-//  - WESTERN  ... with more accented characters
1152
-//  - CYRILLIC ... for the Russian language
1153
-//
1154
-// To determine the language extension installed on your controller:
1155
-//
1156
-//  - Compile and upload with LCD_LANGUAGE set to 'test'
1157
-//  - Click the controller to view the LCD menu
1158
-//  - The LCD will display Japanese, Western, or Cyrillic text
1159
-//
1160
-// See https://github.com/MarlinFirmware/Marlin/wiki/LCD-Language
1161
-//
1162
-// :['JAPANESE', 'WESTERN', 'CYRILLIC']
1163
-//
1138
+/**
1139
+ * LCD Character Set
1140
+ *
1141
+ * Note: This option is NOT applicable to Graphical Displays.
1142
+ *
1143
+ * All character-based LCDs provide ASCII plus one of these
1144
+ * language extensions:
1145
+ *
1146
+ *  - JAPANESE ... the most common
1147
+ *  - WESTERN  ... with more accented characters
1148
+ *  - CYRILLIC ... for the Russian language
1149
+ *
1150
+ * To determine the language extension installed on your controller:
1151
+ *
1152
+ *  - Compile and upload with LCD_LANGUAGE set to 'test'
1153
+ *  - Click the controller to view the LCD menu
1154
+ *  - The LCD will display Japanese, Western, or Cyrillic text
1155
+ *
1156
+ * See https: *github.com/MarlinFirmware/Marlin/wiki/LCD-Language
1157
+ *
1158
+ * :['JAPANESE', 'WESTERN', 'CYRILLIC']
1159
+ */
1164 1160
 #define DISPLAY_CHARSET_HD44780 JAPANESE
1165 1161
 
1166
-//
1167
-// LCD TYPE
1168
-//
1169
-// You may choose ULTRA_LCD if you have character based LCD with 16x2, 16x4, 20x2,
1170
-// 20x4 char/lines or DOGLCD for the full graphics display with 128x64 pixels
1171
-// (ST7565R family). (This option will be set automatically for certain displays.)
1172
-//
1173
-// IMPORTANT NOTE: The U8glib library is required for Full Graphic Display!
1174
-//                 https://github.com/olikraus/U8glib_Arduino
1175
-//
1162
+/**
1163
+ * LCD TYPE
1164
+ *
1165
+ * Enable ULTRA_LCD for a 16x2, 16x4, 20x2, or 20x4 character-based LCD.
1166
+ * Enable DOGLCD for a 128x64 (ST7565R) Full Graphical Display.
1167
+ * (These options will be enabled automatically for most displays.)
1168
+ *
1169
+ * IMPORTANT: The U8glib library is required for Full Graphic Display!
1170
+ *            https://github.com/olikraus/U8glib_Arduino
1171
+ */
1176 1172
 //#define ULTRA_LCD   // Character based
1177 1173
 //#define DOGLCD      // Full graphics display
1178 1174
 
1179
-//
1180
-// SD CARD
1181
-//
1182
-// SD Card support is disabled by default. If your controller has an SD slot,
1183
-// you must uncomment the following option or it won't work.
1184
-//
1175
+/**
1176
+ * SD CARD
1177
+ *
1178
+ * SD Card support is disabled by default. If your controller has an SD slot,
1179
+ * you must uncomment the following option or it won't work.
1180
+ *
1181
+ */
1185 1182
 //#define SDSUPPORT
1186 1183
 
1187
-//
1188
-// SD CARD: SPI SPEED
1189
-//
1190
-// Uncomment ONE of the following items to use a slower SPI transfer
1191
-// speed. This is usually required if you're getting volume init errors.
1192
-//
1184
+/**
1185
+ * SD CARD: SPI SPEED
1186
+ *
1187
+ * Enable one of the following items for a slower SPI transfer speed.
1188
+ * This may be required to resolve "volume init" errors.
1189
+ */
1193 1190
 //#define SPI_SPEED SPI_HALF_SPEED
1194 1191
 //#define SPI_SPEED SPI_QUARTER_SPEED
1195 1192
 //#define SPI_SPEED SPI_EIGHTH_SPEED
1196 1193
 
1197
-//
1198
-// SD CARD: ENABLE CRC
1199
-//
1200
-// Use CRC checks and retries on the SD communication.
1201
-//
1194
+/**
1195
+ * SD CARD: ENABLE CRC
1196
+ *
1197
+ * Use CRC checks and retries on the SD communication.
1198
+ */
1202 1199
 //#define SD_CHECK_AND_RETRY
1203 1200
 
1204 1201
 //
@@ -1226,7 +1223,7 @@
1226 1223
  */
1227 1224
 
1228 1225
 //
1229
-// This option reverses the encoder direction everywhere
1226
+// This option reverses the encoder direction everywhere.
1230 1227
 //
1231 1228
 //  Set this option if CLOCKWISE causes values to DECREASE
1232 1229
 //

+ 137
- 140
Marlin/example_configurations/TinyBoy2/Configuration.h View File

@@ -1042,23 +1042,17 @@
1042 1042
 #define PREHEAT_2_TEMP_BED     90 // TB2: ABS default 110, 90 is the maximum temp at 12V supply
1043 1043
 #define PREHEAT_2_FAN_SPEED     0 // Value from 0 to 255
1044 1044
 
1045
-//
1046
-// Nozzle Park -- EXPERIMENTAL
1047
-//
1048
-// When enabled allows the user to define a special XYZ position, inside the
1049
-// machine's topology, to park the nozzle when idle or when receiving the G27
1050
-// command.
1051
-//
1052
-// The "P" paramenter controls what is the action applied to the Z axis:
1053
-//    P0: (Default) If current Z-pos is lower than Z-park then the nozzle will
1054
-//        be raised to reach Z-park height.
1055
-//
1056
-//    P1: No matter the current Z-pos, the nozzle will be raised/lowered to
1057
-//        reach Z-park height.
1058
-//
1059
-//    P2: The nozzle height will be raised by Z-park amount but never going over
1060
-//        the machine's limit of Z_MAX_POS.
1061
-//
1045
+/**
1046
+ * Nozzle Park -- EXPERIMENTAL
1047
+ *
1048
+ * Park the nozzle at the given XYZ position on idle or G27.
1049
+ *
1050
+ * The "P" parameter controls the action applied to the Z axis:
1051
+ *
1052
+ *    P0  (Default) If Z is below park Z raise the nozzle.
1053
+ *    P1  Raise the nozzle always to Z-park height.
1054
+ *    P2  Raise the nozzle by Z-park amount, limited to Z_MAX_POS.
1055
+ */
1062 1056
 #define NOZZLE_PARK_FEATURE
1063 1057
 
1064 1058
 #if ENABLED(NOZZLE_PARK_FEATURE)
@@ -1066,44 +1060,44 @@
1066 1060
   #define NOZZLE_PARK_POINT { (X_MIN_POS + 10), (Y_MAX_POS - 10), 20 }
1067 1061
 #endif
1068 1062
 
1069
-//
1070
-// Clean Nozzle Feature -- EXPERIMENTAL
1071
-//
1072
-// When enabled allows the user to send G12 to start the nozzle cleaning
1073
-// process, the G-Code accepts two parameters:
1074
-//   "P" for pattern selection
1075
-//   "S" for defining the number of strokes/repetitions
1076
-//
1077
-// Available list of patterns:
1078
-//   P0: This is the default pattern, this process requires a sponge type
1079
-//       material at a fixed bed location. S defines "strokes" i.e.
1080
-//       back-and-forth movements between the starting and end points.
1081
-//
1082
-//   P1: This starts a zig-zag pattern between (X0, Y0) and (X1, Y1), "T"
1083
-//       defines the number of zig-zag triangles to be done. "S" defines the
1084
-//       number of strokes aka one back-and-forth movement. Zig-zags will
1085
-//       be performed in whichever dimension is smallest. As an example,
1086
-//       sending "G12 P1 S1 T3" will execute:
1087
-//
1088
-//          --
1089
-//         |  (X0, Y1) |     /\        /\        /\     | (X1, Y1)
1090
-//         |           |    /  \      /  \      /  \    |
1091
-//       A |           |   /    \    /    \    /    \   |
1092
-//         |           |  /      \  /      \  /      \  |
1093
-//         |  (X0, Y0) | /        \/        \/        \ | (X1, Y0)
1094
-//          --         +--------------------------------+
1095
-//                       |________|_________|_________|
1096
-//                           T1        T2        T3
1097
-//
1098
-//   P2: This starts a circular pattern with circle with middle in
1099
-//       NOZZLE_CLEAN_CIRCLE_MIDDLE radius of R and stroke count of S.
1100
-//       Before starting the circle nozzle goes to NOZZLE_CLEAN_START_POINT.
1101
-//
1102
-// Caveats: End point Z should use the same value as Start point Z.
1103
-//
1104
-// Attention: This is an EXPERIMENTAL feature, in the future the G-code arguments
1105
-// may change to add new functionality like different wipe patterns.
1106
-//
1063
+/**
1064
+ * Clean Nozzle Feature -- EXPERIMENTAL
1065
+ *
1066
+ * Adds the G12 command to perform a nozzle cleaning process.
1067
+ *
1068
+ * Parameters:
1069
+ *   P  Pattern
1070
+ *   S  Strokes / Repetitions
1071
+ *   T  Triangles (P1 only)
1072
+ *
1073
+ * Patterns:
1074
+ *   P0  Straight line (default). This process requires a sponge type material
1075
+ *       at a fixed bed location. "S" specifies strokes (i.e. back-forth motions)
1076
+ *       between the start / end points.
1077
+ *
1078
+ *   P1  Zig-zag pattern between (X0, Y0) and (X1, Y1), "T" specifies the
1079
+ *       number of zig-zag triangles to do. "S" defines the number of strokes.
1080
+ *       Zig-zags are done in whichever is the narrower dimension.
1081
+ *       For example, "G12 P1 S1 T3" will execute:
1082
+ *
1083
+ *          --
1084
+ *         |  (X0, Y1) |     /\        /\        /\     | (X1, Y1)
1085
+ *         |           |    /  \      /  \      /  \    |
1086
+ *       A |           |   /    \    /    \    /    \   |
1087
+ *         |           |  /      \  /      \  /      \  |
1088
+ *         |  (X0, Y0) | /        \/        \/        \ | (X1, Y0)
1089
+ *          --         +--------------------------------+
1090
+ *                       |________|_________|_________|
1091
+ *                           T1        T2        T3
1092
+ *
1093
+ *   P2  Circular pattern with middle at NOZZLE_CLEAN_CIRCLE_MIDDLE.
1094
+ *       "R" specifies the radius. "S" specifies the stroke count.
1095
+ *       Before starting, the nozzle moves to NOZZLE_CLEAN_START_POINT.
1096
+ *
1097
+ *   Caveats: The ending Z should be the same as starting Z.
1098
+ * Attention: EXPERIMENTAL. G-code arguments may change.
1099
+ *
1100
+ */
1107 1101
 //#define NOZZLE_CLEAN_FEATURE
1108 1102
 
1109 1103
 #if ENABLED(NOZZLE_CLEAN_FEATURE)
@@ -1128,33 +1122,35 @@
1128 1122
   #define NOZZLE_CLEAN_GOBACK
1129 1123
 #endif
1130 1124
 
1131
-//
1132
-// Print job timer
1133
-//
1134
-// Enable this option to automatically start and stop the
1135
-// print job timer when M104/M109/M190 commands are received.
1136
-// M104 (extruder without wait) - high temp = none, low temp = stop timer
1137
-// M109 (extruder with wait) - high temp = start timer, low temp = stop timer
1138
-// M190 (bed with wait) - high temp = start timer, low temp = none
1139
-//
1140
-// In all cases the timer can be started and stopped using
1141
-// the following commands:
1142
-//
1143
-// - M75  - Start the print job timer
1144
-// - M76  - Pause the print job timer
1145
-// - M77  - Stop the print job timer
1125
+/**
1126
+ * Print Job Timer
1127
+ *
1128
+ * Automatically start and stop the print job timer on M104/M109/M190.
1129
+ *
1130
+ *   M104 (hotend, no wait) - high temp = none,        low temp = stop timer
1131
+ *   M109 (hotend, wait)    - high temp = start timer, low temp = stop timer
1132
+ *   M190 (bed, wait)       - high temp = start timer, low temp = none
1133
+ *
1134
+ * The timer can also be controlled with the following commands:
1135
+ *
1136
+ *   M75 - Start the print job timer
1137
+ *   M76 - Pause the print job timer
1138
+ *   M77 - Stop the print job timer
1139
+ */
1146 1140
 #define PRINTJOB_TIMER_AUTOSTART
1147 1141
 
1148
-//
1149
-// Print Counter
1150
-//
1151
-// When enabled Marlin will keep track of some print statistical data such as:
1152
-//  - Total print jobs
1153
-//  - Total successful print jobs
1154
-//  - Total failed print jobs
1155
-//  - Total time printing
1156
-//
1157
-// This information can be viewed by the M78 command.
1142
+/**
1143
+ * Print Counter
1144
+ *
1145
+ * Track statistical data such as:
1146
+ *
1147
+ *  - Total print jobs
1148
+ *  - Total successful print jobs
1149
+ *  - Total failed print jobs
1150
+ *  - Total time printing
1151
+ *
1152
+ * View the current statistics with M78.
1153
+ */
1158 1154
 #define PRINTCOUNTER
1159 1155
 
1160 1156
 //=============================================================================
@@ -1163,78 +1159,79 @@
1163 1159
 
1164 1160
 // @section lcd
1165 1161
 
1166
-//
1167
-// LCD LANGUAGE
1168
-//
1169
-// Here you may choose the language used by Marlin on the LCD menus, the following
1170
-// list of languages are available:
1171
-//    en, an, bg, ca, cn, cz, de, el, el-gr, es, eu, fi, fr, gl, hr, it,
1172
-//    kana, kana_utf8, nl, pl, pt, pt_utf8, pt-br, pt-br_utf8, ru, tr, uk, test
1173
-//
1174
-// :{ 'en':'English', 'an':'Aragonese', 'bg':'Bulgarian', 'ca':'Catalan', 'cn':'Chinese', 'cz':'Czech', 'de':'German', 'el':'Greek', 'el-gr':'Greek (Greece)', 'es':'Spanish', 'eu':'Basque-Euskera', 'fi':'Finnish', 'fr':'French', 'gl':'Galician', 'hr':'Croatian', 'it':'Italian', 'kana':'Japanese', 'kana_utf8':'Japanese (UTF8)', 'nl':'Dutch', 'pl':'Polish', 'pt':'Portuguese', 'pt-br':'Portuguese (Brazilian)', 'pt-br_utf8':'Portuguese (Brazilian UTF8)', 'pt_utf8':'Portuguese (UTF8)', 'ru':'Russian', 'tr':'Turkish', 'uk':'Ukrainian', 'test':'TEST' }
1175
-//
1162
+/**
1163
+ * LCD LANGUAGE
1164
+ *
1165
+ * Select the language to display on the LCD. These languages are available:
1166
+ *
1167
+ *    en, an, bg, ca, cn, cz, de, el, el-gr, es, eu, fi, fr, gl, hr, it,
1168
+ *    kana, kana_utf8, nl, pl, pt, pt_utf8, pt-br, pt-br_utf8, ru, tr, uk, test
1169
+ *
1170
+ * :{ 'en':'English', 'an':'Aragonese', 'bg':'Bulgarian', 'ca':'Catalan', 'cn':'Chinese', 'cz':'Czech', 'de':'German', 'el':'Greek', 'el-gr':'Greek (Greece)', 'es':'Spanish', 'eu':'Basque-Euskera', 'fi':'Finnish', 'fr':'French', 'gl':'Galician', 'hr':'Croatian', 'it':'Italian', 'kana':'Japanese', 'kana_utf8':'Japanese (UTF8)', 'nl':'Dutch', 'pl':'Polish', 'pt':'Portuguese', 'pt-br':'Portuguese (Brazilian)', 'pt-br_utf8':'Portuguese (Brazilian UTF8)', 'pt_utf8':'Portuguese (UTF8)', 'ru':'Russian', 'tr':'Turkish', 'uk':'Ukrainian', 'test':'TEST' }
1171
+ */
1176 1172
 #define LCD_LANGUAGE en
1177 1173
 
1178
-//
1179
-// LCD Character Set
1180
-//
1181
-// Note: This option is NOT applicable to Graphical Displays.
1182
-//
1183
-// All character-based LCD's provide ASCII plus one of these
1184
-// language extensions:
1185
-//
1186
-//  - JAPANESE ... the most common
1187
-//  - WESTERN  ... with more accented characters
1188
-//  - CYRILLIC ... for the Russian language
1189
-//
1190
-// To determine the language extension installed on your controller:
1191
-//
1192
-//  - Compile and upload with LCD_LANGUAGE set to 'test'
1193
-//  - Click the controller to view the LCD menu
1194
-//  - The LCD will display Japanese, Western, or Cyrillic text
1195
-//
1196
-// See https://github.com/MarlinFirmware/Marlin/wiki/LCD-Language
1197
-//
1198
-// :['JAPANESE', 'WESTERN', 'CYRILLIC']
1199
-//
1174
+/**
1175
+ * LCD Character Set
1176
+ *
1177
+ * Note: This option is NOT applicable to Graphical Displays.
1178
+ *
1179
+ * All character-based LCDs provide ASCII plus one of these
1180
+ * language extensions:
1181
+ *
1182
+ *  - JAPANESE ... the most common
1183
+ *  - WESTERN  ... with more accented characters
1184
+ *  - CYRILLIC ... for the Russian language
1185
+ *
1186
+ * To determine the language extension installed on your controller:
1187
+ *
1188
+ *  - Compile and upload with LCD_LANGUAGE set to 'test'
1189
+ *  - Click the controller to view the LCD menu
1190
+ *  - The LCD will display Japanese, Western, or Cyrillic text
1191
+ *
1192
+ * See https: *github.com/MarlinFirmware/Marlin/wiki/LCD-Language
1193
+ *
1194
+ * :['JAPANESE', 'WESTERN', 'CYRILLIC']
1195
+ */
1200 1196
 #define DISPLAY_CHARSET_HD44780 JAPANESE
1201 1197
 
1202
-//
1203
-// LCD TYPE
1204
-//
1205
-// You may choose ULTRA_LCD if you have character based LCD with 16x2, 16x4, 20x2,
1206
-// 20x4 char/lines or DOGLCD for the full graphics display with 128x64 pixels
1207
-// (ST7565R family). (This option will be set automatically for certain displays.)
1208
-//
1209
-// IMPORTANT NOTE: The U8glib library is required for Full Graphic Display!
1210
-//                 https://github.com/olikraus/U8glib_Arduino
1211
-//
1198
+/**
1199
+ * LCD TYPE
1200
+ *
1201
+ * Enable ULTRA_LCD for a 16x2, 16x4, 20x2, or 20x4 character-based LCD.
1202
+ * Enable DOGLCD for a 128x64 (ST7565R) Full Graphical Display.
1203
+ * (These options will be enabled automatically for most displays.)
1204
+ *
1205
+ * IMPORTANT: The U8glib library is required for Full Graphic Display!
1206
+ *            https://github.com/olikraus/U8glib_Arduino
1207
+ */
1212 1208
 //#define ULTRA_LCD   // Character based
1213 1209
 //#define DOGLCD      // Full graphics display
1214 1210
 
1215
-//
1216
-// SD CARD
1217
-//
1218
-// SD Card support is disabled by default. If your controller has an SD slot,
1219
-// you must uncomment the following option or it won't work.
1220
-//
1211
+/**
1212
+ * SD CARD
1213
+ *
1214
+ * SD Card support is disabled by default. If your controller has an SD slot,
1215
+ * you must uncomment the following option or it won't work.
1216
+ *
1217
+ */
1221 1218
 #define SDSUPPORT
1222 1219
 
1223
-//
1224
-// SD CARD: SPI SPEED
1225
-//
1226
-// Uncomment ONE of the following items to use a slower SPI transfer
1227
-// speed. This is usually required if you're getting volume init errors.
1228
-//
1220
+/**
1221
+ * SD CARD: SPI SPEED
1222
+ *
1223
+ * Enable one of the following items for a slower SPI transfer speed.
1224
+ * This may be required to resolve "volume init" errors.
1225
+ */
1229 1226
 //#define SPI_SPEED SPI_HALF_SPEED
1230 1227
 //#define SPI_SPEED SPI_QUARTER_SPEED
1231 1228
 //#define SPI_SPEED SPI_EIGHTH_SPEED
1232 1229
 
1233
-//
1234
-// SD CARD: ENABLE CRC
1235
-//
1236
-// Use CRC checks and retries on the SD communication.
1237
-//
1230
+/**
1231
+ * SD CARD: ENABLE CRC
1232
+ *
1233
+ * Use CRC checks and retries on the SD communication.
1234
+ */
1238 1235
 #define SD_CHECK_AND_RETRY
1239 1236
 
1240 1237
 //
@@ -1262,7 +1259,7 @@
1262 1259
  */
1263 1260
 
1264 1261
 //
1265
-// This option reverses the encoder direction everywhere
1262
+// This option reverses the encoder direction everywhere.
1266 1263
 //
1267 1264
 //  Set this option if CLOCKWISE causes values to DECREASE
1268 1265
 //

+ 137
- 140
Marlin/example_configurations/WITBOX/Configuration.h View File

@@ -977,23 +977,17 @@
977 977
 #define PREHEAT_2_TEMP_BED    100
978 978
 #define PREHEAT_2_FAN_SPEED   255 // Value from 0 to 255
979 979
 
980
-//
981
-// Nozzle Park -- EXPERIMENTAL
982
-//
983
-// When enabled allows the user to define a special XYZ position, inside the
984
-// machine's topology, to park the nozzle when idle or when receiving the G27
985
-// command.
986
-//
987
-// The "P" paramenter controls what is the action applied to the Z axis:
988
-//    P0: (Default) If current Z-pos is lower than Z-park then the nozzle will
989
-//        be raised to reach Z-park height.
990
-//
991
-//    P1: No matter the current Z-pos, the nozzle will be raised/lowered to
992
-//        reach Z-park height.
993
-//
994
-//    P2: The nozzle height will be raised by Z-park amount but never going over
995
-//        the machine's limit of Z_MAX_POS.
996
-//
980
+/**
981
+ * Nozzle Park -- EXPERIMENTAL
982
+ *
983
+ * Park the nozzle at the given XYZ position on idle or G27.
984
+ *
985
+ * The "P" parameter controls the action applied to the Z axis:
986
+ *
987
+ *    P0  (Default) If Z is below park Z raise the nozzle.
988
+ *    P1  Raise the nozzle always to Z-park height.
989
+ *    P2  Raise the nozzle by Z-park amount, limited to Z_MAX_POS.
990
+ */
997 991
 //#define NOZZLE_PARK_FEATURE
998 992
 
999 993
 #if ENABLED(NOZZLE_PARK_FEATURE)
@@ -1001,44 +995,44 @@
1001 995
   #define NOZZLE_PARK_POINT { (X_MIN_POS + 10), (Y_MAX_POS - 10), 20 }
1002 996
 #endif
1003 997
 
1004
-//
1005
-// Clean Nozzle Feature -- EXPERIMENTAL
1006
-//
1007
-// When enabled allows the user to send G12 to start the nozzle cleaning
1008
-// process, the G-Code accepts two parameters:
1009
-//   "P" for pattern selection
1010
-//   "S" for defining the number of strokes/repetitions
1011
-//
1012
-// Available list of patterns:
1013
-//   P0: This is the default pattern, this process requires a sponge type
1014
-//       material at a fixed bed location. S defines "strokes" i.e.
1015
-//       back-and-forth movements between the starting and end points.
1016
-//
1017
-//   P1: This starts a zig-zag pattern between (X0, Y0) and (X1, Y1), "T"
1018
-//       defines the number of zig-zag triangles to be done. "S" defines the
1019
-//       number of strokes aka one back-and-forth movement. Zig-zags will
1020
-//       be performed in whichever dimension is smallest. As an example,
1021
-//       sending "G12 P1 S1 T3" will execute:
1022
-//
1023
-//          --
1024
-//         |  (X0, Y1) |     /\        /\        /\     | (X1, Y1)
1025
-//         |           |    /  \      /  \      /  \    |
1026
-//       A |           |   /    \    /    \    /    \   |
1027
-//         |           |  /      \  /      \  /      \  |
1028
-//         |  (X0, Y0) | /        \/        \/        \ | (X1, Y0)
1029
-//          --         +--------------------------------+
1030
-//                       |________|_________|_________|
1031
-//                           T1        T2        T3
1032
-//
1033
-//   P2: This starts a circular pattern with circle with middle in
1034
-//       NOZZLE_CLEAN_CIRCLE_MIDDLE radius of R and stroke count of S.
1035
-//       Before starting the circle nozzle goes to NOZZLE_CLEAN_START_POINT.
1036
-//
1037
-// Caveats: End point Z should use the same value as Start point Z.
1038
-//
1039
-// Attention: This is an EXPERIMENTAL feature, in the future the G-code arguments
1040
-// may change to add new functionality like different wipe patterns.
1041
-//
998
+/**
999
+ * Clean Nozzle Feature -- EXPERIMENTAL
1000
+ *
1001
+ * Adds the G12 command to perform a nozzle cleaning process.
1002
+ *
1003
+ * Parameters:
1004
+ *   P  Pattern
1005
+ *   S  Strokes / Repetitions
1006
+ *   T  Triangles (P1 only)
1007
+ *
1008
+ * Patterns:
1009
+ *   P0  Straight line (default). This process requires a sponge type material
1010
+ *       at a fixed bed location. "S" specifies strokes (i.e. back-forth motions)
1011
+ *       between the start / end points.
1012
+ *
1013
+ *   P1  Zig-zag pattern between (X0, Y0) and (X1, Y1), "T" specifies the
1014
+ *       number of zig-zag triangles to do. "S" defines the number of strokes.
1015
+ *       Zig-zags are done in whichever is the narrower dimension.
1016
+ *       For example, "G12 P1 S1 T3" will execute:
1017
+ *
1018
+ *          --
1019
+ *         |  (X0, Y1) |     /\        /\        /\     | (X1, Y1)
1020
+ *         |           |    /  \      /  \      /  \    |
1021
+ *       A |           |   /    \    /    \    /    \   |
1022
+ *         |           |  /      \  /      \  /      \  |
1023
+ *         |  (X0, Y0) | /        \/        \/        \ | (X1, Y0)
1024
+ *          --         +--------------------------------+
1025
+ *                       |________|_________|_________|
1026
+ *                           T1        T2        T3
1027
+ *
1028
+ *   P2  Circular pattern with middle at NOZZLE_CLEAN_CIRCLE_MIDDLE.
1029
+ *       "R" specifies the radius. "S" specifies the stroke count.
1030
+ *       Before starting, the nozzle moves to NOZZLE_CLEAN_START_POINT.
1031
+ *
1032
+ *   Caveats: The ending Z should be the same as starting Z.
1033
+ * Attention: EXPERIMENTAL. G-code arguments may change.
1034
+ *
1035
+ */
1042 1036
 //#define NOZZLE_CLEAN_FEATURE
1043 1037
 
1044 1038
 #if ENABLED(NOZZLE_CLEAN_FEATURE)
@@ -1063,33 +1057,35 @@
1063 1057
   #define NOZZLE_CLEAN_GOBACK
1064 1058
 #endif
1065 1059
 
1066
-//
1067
-// Print job timer
1068
-//
1069
-// Enable this option to automatically start and stop the
1070
-// print job timer when M104/M109/M190 commands are received.
1071
-// M104 (extruder without wait) - high temp = none, low temp = stop timer
1072
-// M109 (extruder with wait) - high temp = start timer, low temp = stop timer
1073
-// M190 (bed with wait) - high temp = start timer, low temp = none
1074
-//
1075
-// In all cases the timer can be started and stopped using
1076
-// the following commands:
1077
-//
1078
-// - M75  - Start the print job timer
1079
-// - M76  - Pause the print job timer
1080
-// - M77  - Stop the print job timer
1060
+/**
1061
+ * Print Job Timer
1062
+ *
1063
+ * Automatically start and stop the print job timer on M104/M109/M190.
1064
+ *
1065
+ *   M104 (hotend, no wait) - high temp = none,        low temp = stop timer
1066
+ *   M109 (hotend, wait)    - high temp = start timer, low temp = stop timer
1067
+ *   M190 (bed, wait)       - high temp = start timer, low temp = none
1068
+ *
1069
+ * The timer can also be controlled with the following commands:
1070
+ *
1071
+ *   M75 - Start the print job timer
1072
+ *   M76 - Pause the print job timer
1073
+ *   M77 - Stop the print job timer
1074
+ */
1081 1075
 #define PRINTJOB_TIMER_AUTOSTART
1082 1076
 
1083
-//
1084
-// Print Counter
1085
-//
1086
-// When enabled Marlin will keep track of some print statistical data such as:
1087
-//  - Total print jobs
1088
-//  - Total successful print jobs
1089
-//  - Total failed print jobs
1090
-//  - Total time printing
1091
-//
1092
-// This information can be viewed by the M78 command.
1077
+/**
1078
+ * Print Counter
1079
+ *
1080
+ * Track statistical data such as:
1081
+ *
1082
+ *  - Total print jobs
1083
+ *  - Total successful print jobs
1084
+ *  - Total failed print jobs
1085
+ *  - Total time printing
1086
+ *
1087
+ * View the current statistics with M78.
1088
+ */
1093 1089
 //#define PRINTCOUNTER
1094 1090
 
1095 1091
 //=============================================================================
@@ -1098,78 +1094,79 @@
1098 1094
 
1099 1095
 // @section lcd
1100 1096
 
1101
-//
1102
-// LCD LANGUAGE
1103
-//
1104
-// Here you may choose the language used by Marlin on the LCD menus, the following
1105
-// list of languages are available:
1106
-//    en, an, bg, ca, cn, cz, de, el, el-gr, es, eu, fi, fr, gl, hr, it,
1107
-//    kana, kana_utf8, nl, pl, pt, pt_utf8, pt-br, pt-br_utf8, ru, tr, uk, test
1108
-//
1109
-// :{ 'en':'English', 'an':'Aragonese', 'bg':'Bulgarian', 'ca':'Catalan', 'cn':'Chinese', 'cz':'Czech', 'de':'German', 'el':'Greek', 'el-gr':'Greek (Greece)', 'es':'Spanish', 'eu':'Basque-Euskera', 'fi':'Finnish', 'fr':'French', 'gl':'Galician', 'hr':'Croatian', 'it':'Italian', 'kana':'Japanese', 'kana_utf8':'Japanese (UTF8)', 'nl':'Dutch', 'pl':'Polish', 'pt':'Portuguese', 'pt-br':'Portuguese (Brazilian)', 'pt-br_utf8':'Portuguese (Brazilian UTF8)', 'pt_utf8':'Portuguese (UTF8)', 'ru':'Russian', 'tr':'Turkish', 'uk':'Ukrainian', 'test':'TEST' }
1110
-//
1097
+/**
1098
+ * LCD LANGUAGE
1099
+ *
1100
+ * Select the language to display on the LCD. These languages are available:
1101
+ *
1102
+ *    en, an, bg, ca, cn, cz, de, el, el-gr, es, eu, fi, fr, gl, hr, it,
1103
+ *    kana, kana_utf8, nl, pl, pt, pt_utf8, pt-br, pt-br_utf8, ru, tr, uk, test
1104
+ *
1105
+ * :{ 'en':'English', 'an':'Aragonese', 'bg':'Bulgarian', 'ca':'Catalan', 'cn':'Chinese', 'cz':'Czech', 'de':'German', 'el':'Greek', 'el-gr':'Greek (Greece)', 'es':'Spanish', 'eu':'Basque-Euskera', 'fi':'Finnish', 'fr':'French', 'gl':'Galician', 'hr':'Croatian', 'it':'Italian', 'kana':'Japanese', 'kana_utf8':'Japanese (UTF8)', 'nl':'Dutch', 'pl':'Polish', 'pt':'Portuguese', 'pt-br':'Portuguese (Brazilian)', 'pt-br_utf8':'Portuguese (Brazilian UTF8)', 'pt_utf8':'Portuguese (UTF8)', 'ru':'Russian', 'tr':'Turkish', 'uk':'Ukrainian', 'test':'TEST' }
1106
+ */
1111 1107
 //#define LCD_LANGUAGE en
1112 1108
 
1113
-//
1114
-// LCD Character Set
1115
-//
1116
-// Note: This option is NOT applicable to Graphical Displays.
1117
-//
1118
-// All character-based LCD's provide ASCII plus one of these
1119
-// language extensions:
1120
-//
1121
-//  - JAPANESE ... the most common
1122
-//  - WESTERN  ... with more accented characters
1123
-//  - CYRILLIC ... for the Russian language
1124
-//
1125
-// To determine the language extension installed on your controller:
1126
-//
1127
-//  - Compile and upload with LCD_LANGUAGE set to 'test'
1128
-//  - Click the controller to view the LCD menu
1129
-//  - The LCD will display Japanese, Western, or Cyrillic text
1130
-//
1131
-// See https://github.com/MarlinFirmware/Marlin/wiki/LCD-Language
1132
-//
1133
-// :['JAPANESE', 'WESTERN', 'CYRILLIC']
1134
-//
1109
+/**
1110
+ * LCD Character Set
1111
+ *
1112
+ * Note: This option is NOT applicable to Graphical Displays.
1113
+ *
1114
+ * All character-based LCDs provide ASCII plus one of these
1115
+ * language extensions:
1116
+ *
1117
+ *  - JAPANESE ... the most common
1118
+ *  - WESTERN  ... with more accented characters
1119
+ *  - CYRILLIC ... for the Russian language
1120
+ *
1121
+ * To determine the language extension installed on your controller:
1122
+ *
1123
+ *  - Compile and upload with LCD_LANGUAGE set to 'test'
1124
+ *  - Click the controller to view the LCD menu
1125
+ *  - The LCD will display Japanese, Western, or Cyrillic text
1126
+ *
1127
+ * See https: *github.com/MarlinFirmware/Marlin/wiki/LCD-Language
1128
+ *
1129
+ * :['JAPANESE', 'WESTERN', 'CYRILLIC']
1130
+ */
1135 1131
 #define DISPLAY_CHARSET_HD44780 JAPANESE
1136 1132
 
1137
-//
1138
-// LCD TYPE
1139
-//
1140
-// You may choose ULTRA_LCD if you have character based LCD with 16x2, 16x4, 20x2,
1141
-// 20x4 char/lines or DOGLCD for the full graphics display with 128x64 pixels
1142
-// (ST7565R family). (This option will be set automatically for certain displays.)
1143
-//
1144
-// IMPORTANT NOTE: The U8glib library is required for Full Graphic Display!
1145
-//                 https://github.com/olikraus/U8glib_Arduino
1146
-//
1133
+/**
1134
+ * LCD TYPE
1135
+ *
1136
+ * Enable ULTRA_LCD for a 16x2, 16x4, 20x2, or 20x4 character-based LCD.
1137
+ * Enable DOGLCD for a 128x64 (ST7565R) Full Graphical Display.
1138
+ * (These options will be enabled automatically for most displays.)
1139
+ *
1140
+ * IMPORTANT: The U8glib library is required for Full Graphic Display!
1141
+ *            https://github.com/olikraus/U8glib_Arduino
1142
+ */
1147 1143
 #define ULTRA_LCD   // Character based
1148 1144
 //#define DOGLCD      // Full graphics display
1149 1145
 
1150
-//
1151
-// SD CARD
1152
-//
1153
-// SD Card support is disabled by default. If your controller has an SD slot,
1154
-// you must uncomment the following option or it won't work.
1155
-//
1146
+/**
1147
+ * SD CARD
1148
+ *
1149
+ * SD Card support is disabled by default. If your controller has an SD slot,
1150
+ * you must uncomment the following option or it won't work.
1151
+ *
1152
+ */
1156 1153
 #define SDSUPPORT
1157 1154
 
1158
-//
1159
-// SD CARD: SPI SPEED
1160
-//
1161
-// Uncomment ONE of the following items to use a slower SPI transfer
1162
-// speed. This is usually required if you're getting volume init errors.
1163
-//
1155
+/**
1156
+ * SD CARD: SPI SPEED
1157
+ *
1158
+ * Enable one of the following items for a slower SPI transfer speed.
1159
+ * This may be required to resolve "volume init" errors.
1160
+ */
1164 1161
 //#define SPI_SPEED SPI_HALF_SPEED
1165 1162
 //#define SPI_SPEED SPI_QUARTER_SPEED
1166 1163
 //#define SPI_SPEED SPI_EIGHTH_SPEED
1167 1164
 
1168
-//
1169
-// SD CARD: ENABLE CRC
1170
-//
1171
-// Use CRC checks and retries on the SD communication.
1172
-//
1165
+/**
1166
+ * SD CARD: ENABLE CRC
1167
+ *
1168
+ * Use CRC checks and retries on the SD communication.
1169
+ */
1173 1170
 //#define SD_CHECK_AND_RETRY
1174 1171
 
1175 1172
 //
@@ -1197,7 +1194,7 @@
1197 1194
  */
1198 1195
 
1199 1196
 //
1200
-// This option reverses the encoder direction everywhere
1197
+// This option reverses the encoder direction everywhere.
1201 1198
 //
1202 1199
 //  Set this option if CLOCKWISE causes values to DECREASE
1203 1200
 //

+ 137
- 140
Marlin/example_configurations/adafruit/ST7565/Configuration.h View File

@@ -986,23 +986,17 @@
986 986
 #define PREHEAT_2_TEMP_BED    110
987 987
 #define PREHEAT_2_FAN_SPEED     0 // Value from 0 to 255
988 988
 
989
-//
990
-// Nozzle Park -- EXPERIMENTAL
991
-//
992
-// When enabled allows the user to define a special XYZ position, inside the
993
-// machine's topology, to park the nozzle when idle or when receiving the G27
994
-// command.
995
-//
996
-// The "P" paramenter controls what is the action applied to the Z axis:
997
-//    P0: (Default) If current Z-pos is lower than Z-park then the nozzle will
998
-//        be raised to reach Z-park height.
999
-//
1000
-//    P1: No matter the current Z-pos, the nozzle will be raised/lowered to
1001
-//        reach Z-park height.
1002
-//
1003
-//    P2: The nozzle height will be raised by Z-park amount but never going over
1004
-//        the machine's limit of Z_MAX_POS.
1005
-//
989
+/**
990
+ * Nozzle Park -- EXPERIMENTAL
991
+ *
992
+ * Park the nozzle at the given XYZ position on idle or G27.
993
+ *
994
+ * The "P" parameter controls the action applied to the Z axis:
995
+ *
996
+ *    P0  (Default) If Z is below park Z raise the nozzle.
997
+ *    P1  Raise the nozzle always to Z-park height.
998
+ *    P2  Raise the nozzle by Z-park amount, limited to Z_MAX_POS.
999
+ */
1006 1000
 //#define NOZZLE_PARK_FEATURE
1007 1001
 
1008 1002
 #if ENABLED(NOZZLE_PARK_FEATURE)
@@ -1010,44 +1004,44 @@
1010 1004
   #define NOZZLE_PARK_POINT { (X_MIN_POS + 10), (Y_MAX_POS - 10), 20 }
1011 1005
 #endif
1012 1006
 
1013
-//
1014
-// Clean Nozzle Feature -- EXPERIMENTAL
1015
-//
1016
-// When enabled allows the user to send G12 to start the nozzle cleaning
1017
-// process, the G-Code accepts two parameters:
1018
-//   "P" for pattern selection
1019
-//   "S" for defining the number of strokes/repetitions
1020
-//
1021
-// Available list of patterns:
1022
-//   P0: This is the default pattern, this process requires a sponge type
1023
-//       material at a fixed bed location. S defines "strokes" i.e.
1024
-//       back-and-forth movements between the starting and end points.
1025
-//
1026
-//   P1: This starts a zig-zag pattern between (X0, Y0) and (X1, Y1), "T"
1027
-//       defines the number of zig-zag triangles to be done. "S" defines the
1028
-//       number of strokes aka one back-and-forth movement. Zig-zags will
1029
-//       be performed in whichever dimension is smallest. As an example,
1030
-//       sending "G12 P1 S1 T3" will execute:
1031
-//
1032
-//          --
1033
-//         |  (X0, Y1) |     /\        /\        /\     | (X1, Y1)
1034
-//         |           |    /  \      /  \      /  \    |
1035
-//       A |           |   /    \    /    \    /    \   |
1036
-//         |           |  /      \  /      \  /      \  |
1037
-//         |  (X0, Y0) | /        \/        \/        \ | (X1, Y0)
1038
-//          --         +--------------------------------+
1039
-//                       |________|_________|_________|
1040
-//                           T1        T2        T3
1041
-//
1042
-//   P2: This starts a circular pattern with circle with middle in
1043
-//       NOZZLE_CLEAN_CIRCLE_MIDDLE radius of R and stroke count of S.
1044
-//       Before starting the circle nozzle goes to NOZZLE_CLEAN_START_POINT.
1045
-//
1046
-// Caveats: End point Z should use the same value as Start point Z.
1047
-//
1048
-// Attention: This is an EXPERIMENTAL feature, in the future the G-code arguments
1049
-// may change to add new functionality like different wipe patterns.
1050
-//
1007
+/**
1008
+ * Clean Nozzle Feature -- EXPERIMENTAL
1009
+ *
1010
+ * Adds the G12 command to perform a nozzle cleaning process.
1011
+ *
1012
+ * Parameters:
1013
+ *   P  Pattern
1014
+ *   S  Strokes / Repetitions
1015
+ *   T  Triangles (P1 only)
1016
+ *
1017
+ * Patterns:
1018
+ *   P0  Straight line (default). This process requires a sponge type material
1019
+ *       at a fixed bed location. "S" specifies strokes (i.e. back-forth motions)
1020
+ *       between the start / end points.
1021
+ *
1022
+ *   P1  Zig-zag pattern between (X0, Y0) and (X1, Y1), "T" specifies the
1023
+ *       number of zig-zag triangles to do. "S" defines the number of strokes.
1024
+ *       Zig-zags are done in whichever is the narrower dimension.
1025
+ *       For example, "G12 P1 S1 T3" will execute:
1026
+ *
1027
+ *          --
1028
+ *         |  (X0, Y1) |     /\        /\        /\     | (X1, Y1)
1029
+ *         |           |    /  \      /  \      /  \    |
1030
+ *       A |           |   /    \    /    \    /    \   |
1031
+ *         |           |  /      \  /      \  /      \  |
1032
+ *         |  (X0, Y0) | /        \/        \/        \ | (X1, Y0)
1033
+ *          --         +--------------------------------+
1034
+ *                       |________|_________|_________|
1035
+ *                           T1        T2        T3
1036
+ *
1037
+ *   P2  Circular pattern with middle at NOZZLE_CLEAN_CIRCLE_MIDDLE.
1038
+ *       "R" specifies the radius. "S" specifies the stroke count.
1039
+ *       Before starting, the nozzle moves to NOZZLE_CLEAN_START_POINT.
1040
+ *
1041
+ *   Caveats: The ending Z should be the same as starting Z.
1042
+ * Attention: EXPERIMENTAL. G-code arguments may change.
1043
+ *
1044
+ */
1051 1045
 //#define NOZZLE_CLEAN_FEATURE
1052 1046
 
1053 1047
 #if ENABLED(NOZZLE_CLEAN_FEATURE)
@@ -1072,33 +1066,35 @@
1072 1066
   #define NOZZLE_CLEAN_GOBACK
1073 1067
 #endif
1074 1068
 
1075
-//
1076
-// Print job timer
1077
-//
1078
-// Enable this option to automatically start and stop the
1079
-// print job timer when M104/M109/M190 commands are received.
1080
-// M104 (extruder without wait) - high temp = none, low temp = stop timer
1081
-// M109 (extruder with wait) - high temp = start timer, low temp = stop timer
1082
-// M190 (bed with wait) - high temp = start timer, low temp = none
1083
-//
1084
-// In all cases the timer can be started and stopped using
1085
-// the following commands:
1086
-//
1087
-// - M75  - Start the print job timer
1088
-// - M76  - Pause the print job timer
1089
-// - M77  - Stop the print job timer
1069
+/**
1070
+ * Print Job Timer
1071
+ *
1072
+ * Automatically start and stop the print job timer on M104/M109/M190.
1073
+ *
1074
+ *   M104 (hotend, no wait) - high temp = none,        low temp = stop timer
1075
+ *   M109 (hotend, wait)    - high temp = start timer, low temp = stop timer
1076
+ *   M190 (bed, wait)       - high temp = start timer, low temp = none
1077
+ *
1078
+ * The timer can also be controlled with the following commands:
1079
+ *
1080
+ *   M75 - Start the print job timer
1081
+ *   M76 - Pause the print job timer
1082
+ *   M77 - Stop the print job timer
1083
+ */
1090 1084
 #define PRINTJOB_TIMER_AUTOSTART
1091 1085
 
1092
-//
1093
-// Print Counter
1094
-//
1095
-// When enabled Marlin will keep track of some print statistical data such as:
1096
-//  - Total print jobs
1097
-//  - Total successful print jobs
1098
-//  - Total failed print jobs
1099
-//  - Total time printing
1100
-//
1101
-// This information can be viewed by the M78 command.
1086
+/**
1087
+ * Print Counter
1088
+ *
1089
+ * Track statistical data such as:
1090
+ *
1091
+ *  - Total print jobs
1092
+ *  - Total successful print jobs
1093
+ *  - Total failed print jobs
1094
+ *  - Total time printing
1095
+ *
1096
+ * View the current statistics with M78.
1097
+ */
1102 1098
 //#define PRINTCOUNTER
1103 1099
 
1104 1100
 //=============================================================================
@@ -1107,78 +1103,79 @@
1107 1103
 
1108 1104
 // @section lcd
1109 1105
 
1110
-//
1111
-// LCD LANGUAGE
1112
-//
1113
-// Here you may choose the language used by Marlin on the LCD menus, the following
1114
-// list of languages are available:
1115
-//    en, an, bg, ca, cn, cz, de, el, el-gr, es, eu, fi, fr, gl, hr, it,
1116
-//    kana, kana_utf8, nl, pl, pt, pt_utf8, pt-br, pt-br_utf8, ru, tr, uk, test
1117
-//
1118
-// :{ 'en':'English', 'an':'Aragonese', 'bg':'Bulgarian', 'ca':'Catalan', 'cn':'Chinese', 'cz':'Czech', 'de':'German', 'el':'Greek', 'el-gr':'Greek (Greece)', 'es':'Spanish', 'eu':'Basque-Euskera', 'fi':'Finnish', 'fr':'French', 'gl':'Galician', 'hr':'Croatian', 'it':'Italian', 'kana':'Japanese', 'kana_utf8':'Japanese (UTF8)', 'nl':'Dutch', 'pl':'Polish', 'pt':'Portuguese', 'pt-br':'Portuguese (Brazilian)', 'pt-br_utf8':'Portuguese (Brazilian UTF8)', 'pt_utf8':'Portuguese (UTF8)', 'ru':'Russian', 'tr':'Turkish', 'uk':'Ukrainian', 'test':'TEST' }
1119
-//
1106
+/**
1107
+ * LCD LANGUAGE
1108
+ *
1109
+ * Select the language to display on the LCD. These languages are available:
1110
+ *
1111
+ *    en, an, bg, ca, cn, cz, de, el, el-gr, es, eu, fi, fr, gl, hr, it,
1112
+ *    kana, kana_utf8, nl, pl, pt, pt_utf8, pt-br, pt-br_utf8, ru, tr, uk, test
1113
+ *
1114
+ * :{ 'en':'English', 'an':'Aragonese', 'bg':'Bulgarian', 'ca':'Catalan', 'cn':'Chinese', 'cz':'Czech', 'de':'German', 'el':'Greek', 'el-gr':'Greek (Greece)', 'es':'Spanish', 'eu':'Basque-Euskera', 'fi':'Finnish', 'fr':'French', 'gl':'Galician', 'hr':'Croatian', 'it':'Italian', 'kana':'Japanese', 'kana_utf8':'Japanese (UTF8)', 'nl':'Dutch', 'pl':'Polish', 'pt':'Portuguese', 'pt-br':'Portuguese (Brazilian)', 'pt-br_utf8':'Portuguese (Brazilian UTF8)', 'pt_utf8':'Portuguese (UTF8)', 'ru':'Russian', 'tr':'Turkish', 'uk':'Ukrainian', 'test':'TEST' }
1115
+ */
1120 1116
 #define LCD_LANGUAGE en
1121 1117
 
1122
-//
1123
-// LCD Character Set
1124
-//
1125
-// Note: This option is NOT applicable to Graphical Displays.
1126
-//
1127
-// All character-based LCD's provide ASCII plus one of these
1128
-// language extensions:
1129
-//
1130
-//  - JAPANESE ... the most common
1131
-//  - WESTERN  ... with more accented characters
1132
-//  - CYRILLIC ... for the Russian language
1133
-//
1134
-// To determine the language extension installed on your controller:
1135
-//
1136
-//  - Compile and upload with LCD_LANGUAGE set to 'test'
1137
-//  - Click the controller to view the LCD menu
1138
-//  - The LCD will display Japanese, Western, or Cyrillic text
1139
-//
1140
-// See https://github.com/MarlinFirmware/Marlin/wiki/LCD-Language
1141
-//
1142
-// :['JAPANESE', 'WESTERN', 'CYRILLIC']
1143
-//
1118
+/**
1119
+ * LCD Character Set
1120
+ *
1121
+ * Note: This option is NOT applicable to Graphical Displays.
1122
+ *
1123
+ * All character-based LCDs provide ASCII plus one of these
1124
+ * language extensions:
1125
+ *
1126
+ *  - JAPANESE ... the most common
1127
+ *  - WESTERN  ... with more accented characters
1128
+ *  - CYRILLIC ... for the Russian language
1129
+ *
1130
+ * To determine the language extension installed on your controller:
1131
+ *
1132
+ *  - Compile and upload with LCD_LANGUAGE set to 'test'
1133
+ *  - Click the controller to view the LCD menu
1134
+ *  - The LCD will display Japanese, Western, or Cyrillic text
1135
+ *
1136
+ * See https: *github.com/MarlinFirmware/Marlin/wiki/LCD-Language
1137
+ *
1138
+ * :['JAPANESE', 'WESTERN', 'CYRILLIC']
1139
+ */
1144 1140
 #define DISPLAY_CHARSET_HD44780 JAPANESE
1145 1141
 
1146
-//
1147
-// LCD TYPE
1148
-//
1149
-// You may choose ULTRA_LCD if you have character based LCD with 16x2, 16x4, 20x2,
1150
-// 20x4 char/lines or DOGLCD for the full graphics display with 128x64 pixels
1151
-// (ST7565R family). (This option will be set automatically for certain displays.)
1152
-//
1153
-// IMPORTANT NOTE: The U8glib library is required for Full Graphic Display!
1154
-//                 https://github.com/olikraus/U8glib_Arduino
1155
-//
1142
+/**
1143
+ * LCD TYPE
1144
+ *
1145
+ * Enable ULTRA_LCD for a 16x2, 16x4, 20x2, or 20x4 character-based LCD.
1146
+ * Enable DOGLCD for a 128x64 (ST7565R) Full Graphical Display.
1147
+ * (These options will be enabled automatically for most displays.)
1148
+ *
1149
+ * IMPORTANT: The U8glib library is required for Full Graphic Display!
1150
+ *            https://github.com/olikraus/U8glib_Arduino
1151
+ */
1156 1152
 //#define ULTRA_LCD   // Character based
1157 1153
 //#define DOGLCD      // Full graphics display
1158 1154
 
1159
-//
1160
-// SD CARD
1161
-//
1162
-// SD Card support is disabled by default. If your controller has an SD slot,
1163
-// you must uncomment the following option or it won't work.
1164
-//
1155
+/**
1156
+ * SD CARD
1157
+ *
1158
+ * SD Card support is disabled by default. If your controller has an SD slot,
1159
+ * you must uncomment the following option or it won't work.
1160
+ *
1161
+ */
1165 1162
 #define SDSUPPORT
1166 1163
 
1167
-//
1168
-// SD CARD: SPI SPEED
1169
-//
1170
-// Uncomment ONE of the following items to use a slower SPI transfer
1171
-// speed. This is usually required if you're getting volume init errors.
1172
-//
1164
+/**
1165
+ * SD CARD: SPI SPEED
1166
+ *
1167
+ * Enable one of the following items for a slower SPI transfer speed.
1168
+ * This may be required to resolve "volume init" errors.
1169
+ */
1173 1170
 #define SPI_SPEED SPI_HALF_SPEED
1174 1171
 //#define SPI_SPEED SPI_QUARTER_SPEED
1175 1172
 //#define SPI_SPEED SPI_EIGHTH_SPEED
1176 1173
 
1177
-//
1178
-// SD CARD: ENABLE CRC
1179
-//
1180
-// Use CRC checks and retries on the SD communication.
1181
-//
1174
+/**
1175
+ * SD CARD: ENABLE CRC
1176
+ *
1177
+ * Use CRC checks and retries on the SD communication.
1178
+ */
1182 1179
 //#define SD_CHECK_AND_RETRY
1183 1180
 
1184 1181
 //
@@ -1206,7 +1203,7 @@
1206 1203
  */
1207 1204
 
1208 1205
 //
1209
-// This option reverses the encoder direction everywhere
1206
+// This option reverses the encoder direction everywhere.
1210 1207
 //
1211 1208
 //  Set this option if CLOCKWISE causes values to DECREASE
1212 1209
 //

+ 137
- 140
Marlin/example_configurations/delta/FLSUN/auto_calibrate/Configuration.h View File

@@ -1104,23 +1104,17 @@
1104 1104
 #define PREHEAT_2_TEMP_BED    100
1105 1105
 #define PREHEAT_2_FAN_SPEED     0 // Value from 0 to 255
1106 1106
 
1107
-//
1108
-// Nozzle Park -- EXPERIMENTAL
1109
-//
1110
-// When enabled allows the user to define a special XYZ position, inside the
1111
-// machine's topology, to park the nozzle when idle or when receiving the G27
1112
-// command.
1113
-//
1114
-// The "P" paramenter controls what is the action applied to the Z axis:
1115
-//    P0: (Default) If current Z-pos is lower than Z-park then the nozzle will
1116
-//        be raised to reach Z-park height.
1117
-//
1118
-//    P1: No matter the current Z-pos, the nozzle will be raised/lowered to
1119
-//        reach Z-park height.
1120
-//
1121
-//    P2: The nozzle height will be raised by Z-park amount but never going over
1122
-//        the machine's limit of Z_MAX_POS.
1123
-//
1107
+/**
1108
+ * Nozzle Park -- EXPERIMENTAL
1109
+ *
1110
+ * Park the nozzle at the given XYZ position on idle or G27.
1111
+ *
1112
+ * The "P" parameter controls the action applied to the Z axis:
1113
+ *
1114
+ *    P0  (Default) If Z is below park Z raise the nozzle.
1115
+ *    P1  Raise the nozzle always to Z-park height.
1116
+ *    P2  Raise the nozzle by Z-park amount, limited to Z_MAX_POS.
1117
+ */
1124 1118
 //#define NOZZLE_PARK_FEATURE
1125 1119
 
1126 1120
 #if ENABLED(NOZZLE_PARK_FEATURE)
@@ -1128,44 +1122,44 @@
1128 1122
   #define NOZZLE_PARK_POINT { (X_MIN_POS + 10), (Y_MAX_POS - 10), 20 }
1129 1123
 #endif
1130 1124
 
1131
-//
1132
-// Clean Nozzle Feature -- EXPERIMENTAL
1133
-//
1134
-// When enabled allows the user to send G12 to start the nozzle cleaning
1135
-// process, the G-Code accepts two parameters:
1136
-//   "P" for pattern selection
1137
-//   "S" for defining the number of strokes/repetitions
1138
-//
1139
-// Available list of patterns:
1140
-//   P0: This is the default pattern, this process requires a sponge type
1141
-//       material at a fixed bed location. S defines "strokes" i.e.
1142
-//       back-and-forth movements between the starting and end points.
1143
-//
1144
-//   P1: This starts a zig-zag pattern between (X0, Y0) and (X1, Y1), "T"
1145
-//       defines the number of zig-zag triangles to be done. "S" defines the
1146
-//       number of strokes aka one back-and-forth movement. Zig-zags will
1147
-//       be performed in whichever dimension is smallest. As an example,
1148
-//       sending "G12 P1 S1 T3" will execute:
1149
-//
1150
-//          --
1151
-//         |  (X0, Y1) |     /\        /\        /\     | (X1, Y1)
1152
-//         |           |    /  \      /  \      /  \    |
1153
-//       A |           |   /    \    /    \    /    \   |
1154
-//         |           |  /      \  /      \  /      \  |
1155
-//         |  (X0, Y0) | /        \/        \/        \ | (X1, Y0)
1156
-//          --         +--------------------------------+
1157
-//                       |________|_________|_________|
1158
-//                           T1        T2        T3
1159
-//
1160
-//   P2: This starts a circular pattern with circle with middle in
1161
-//       NOZZLE_CLEAN_CIRCLE_MIDDLE radius of R and stroke count of S.
1162
-//       Before starting the circle nozzle goes to NOZZLE_CLEAN_START_POINT.
1163
-//
1164
-// Caveats: End point Z should use the same value as Start point Z.
1165
-//
1166
-// Attention: This is an EXPERIMENTAL feature, in the future the G-code arguments
1167
-// may change to add new functionality like different wipe patterns.
1168
-//
1125
+/**
1126
+ * Clean Nozzle Feature -- EXPERIMENTAL
1127
+ *
1128
+ * Adds the G12 command to perform a nozzle cleaning process.
1129
+ *
1130
+ * Parameters:
1131
+ *   P  Pattern
1132
+ *   S  Strokes / Repetitions
1133
+ *   T  Triangles (P1 only)
1134
+ *
1135
+ * Patterns:
1136
+ *   P0  Straight line (default). This process requires a sponge type material
1137
+ *       at a fixed bed location. "S" specifies strokes (i.e. back-forth motions)
1138
+ *       between the start / end points.
1139
+ *
1140
+ *   P1  Zig-zag pattern between (X0, Y0) and (X1, Y1), "T" specifies the
1141
+ *       number of zig-zag triangles to do. "S" defines the number of strokes.
1142
+ *       Zig-zags are done in whichever is the narrower dimension.
1143
+ *       For example, "G12 P1 S1 T3" will execute:
1144
+ *
1145
+ *          --
1146
+ *         |  (X0, Y1) |     /\        /\        /\     | (X1, Y1)
1147
+ *         |           |    /  \      /  \      /  \    |
1148
+ *       A |           |   /    \    /    \    /    \   |
1149
+ *         |           |  /      \  /      \  /      \  |
1150
+ *         |  (X0, Y0) | /        \/        \/        \ | (X1, Y0)
1151
+ *          --         +--------------------------------+
1152
+ *                       |________|_________|_________|
1153
+ *                           T1        T2        T3
1154
+ *
1155
+ *   P2  Circular pattern with middle at NOZZLE_CLEAN_CIRCLE_MIDDLE.
1156
+ *       "R" specifies the radius. "S" specifies the stroke count.
1157
+ *       Before starting, the nozzle moves to NOZZLE_CLEAN_START_POINT.
1158
+ *
1159
+ *   Caveats: The ending Z should be the same as starting Z.
1160
+ * Attention: EXPERIMENTAL. G-code arguments may change.
1161
+ *
1162
+ */
1169 1163
 //#define NOZZLE_CLEAN_FEATURE
1170 1164
 
1171 1165
 #if ENABLED(NOZZLE_CLEAN_FEATURE)
@@ -1190,33 +1184,35 @@
1190 1184
   #define NOZZLE_CLEAN_GOBACK
1191 1185
 #endif
1192 1186
 
1193
-//
1194
-// Print job timer
1195
-//
1196
-// Enable this option to automatically start and stop the
1197
-// print job timer when M104/M109/M190 commands are received.
1198
-// M104 (extruder without wait) - high temp = none, low temp = stop timer
1199
-// M109 (extruder with wait) - high temp = start timer, low temp = stop timer
1200
-// M190 (bed with wait) - high temp = start timer, low temp = none
1201
-//
1202
-// In all cases the timer can be started and stopped using
1203
-// the following commands:
1204
-//
1205
-// - M75  - Start the print job timer
1206
-// - M76  - Pause the print job timer
1207
-// - M77  - Stop the print job timer
1187
+/**
1188
+ * Print Job Timer
1189
+ *
1190
+ * Automatically start and stop the print job timer on M104/M109/M190.
1191
+ *
1192
+ *   M104 (hotend, no wait) - high temp = none,        low temp = stop timer
1193
+ *   M109 (hotend, wait)    - high temp = start timer, low temp = stop timer
1194
+ *   M190 (bed, wait)       - high temp = start timer, low temp = none
1195
+ *
1196
+ * The timer can also be controlled with the following commands:
1197
+ *
1198
+ *   M75 - Start the print job timer
1199
+ *   M76 - Pause the print job timer
1200
+ *   M77 - Stop the print job timer
1201
+ */
1208 1202
 #define PRINTJOB_TIMER_AUTOSTART
1209 1203
 
1210
-//
1211
-// Print Counter
1212
-//
1213
-// When enabled Marlin will keep track of some print statistical data such as:
1214
-//  - Total print jobs
1215
-//  - Total successful print jobs
1216
-//  - Total failed print jobs
1217
-//  - Total time printing
1218
-//
1219
-// This information can be viewed by the M78 command.
1204
+/**
1205
+ * Print Counter
1206
+ *
1207
+ * Track statistical data such as:
1208
+ *
1209
+ *  - Total print jobs
1210
+ *  - Total successful print jobs
1211
+ *  - Total failed print jobs
1212
+ *  - Total time printing
1213
+ *
1214
+ * View the current statistics with M78.
1215
+ */
1220 1216
 #define PRINTCOUNTER
1221 1217
 
1222 1218
 //=============================================================================
@@ -1225,78 +1221,79 @@
1225 1221
 
1226 1222
 // @section lcd
1227 1223
 
1228
-//
1229
-// LCD LANGUAGE
1230
-//
1231
-// Here you may choose the language used by Marlin on the LCD menus, the following
1232
-// list of languages are available:
1233
-//    en, an, bg, ca, cn, cz, de, el, el-gr, es, eu, fi, fr, gl, hr, it,
1234
-//    kana, kana_utf8, nl, pl, pt, pt_utf8, pt-br, pt-br_utf8, ru, tr, uk, test
1235
-//
1236
-// :{ 'en':'English', 'an':'Aragonese', 'bg':'Bulgarian', 'ca':'Catalan', 'cn':'Chinese', 'cz':'Czech', 'de':'German', 'el':'Greek', 'el-gr':'Greek (Greece)', 'es':'Spanish', 'eu':'Basque-Euskera', 'fi':'Finnish', 'fr':'French', 'gl':'Galician', 'hr':'Croatian', 'it':'Italian', 'kana':'Japanese', 'kana_utf8':'Japanese (UTF8)', 'nl':'Dutch', 'pl':'Polish', 'pt':'Portuguese', 'pt-br':'Portuguese (Brazilian)', 'pt-br_utf8':'Portuguese (Brazilian UTF8)', 'pt_utf8':'Portuguese (UTF8)', 'ru':'Russian', 'tr':'Turkish', 'uk':'Ukrainian', 'test':'TEST' }
1237
-//
1224
+/**
1225
+ * LCD LANGUAGE
1226
+ *
1227
+ * Select the language to display on the LCD. These languages are available:
1228
+ *
1229
+ *    en, an, bg, ca, cn, cz, de, el, el-gr, es, eu, fi, fr, gl, hr, it,
1230
+ *    kana, kana_utf8, nl, pl, pt, pt_utf8, pt-br, pt-br_utf8, ru, tr, uk, test
1231
+ *
1232
+ * :{ 'en':'English', 'an':'Aragonese', 'bg':'Bulgarian', 'ca':'Catalan', 'cn':'Chinese', 'cz':'Czech', 'de':'German', 'el':'Greek', 'el-gr':'Greek (Greece)', 'es':'Spanish', 'eu':'Basque-Euskera', 'fi':'Finnish', 'fr':'French', 'gl':'Galician', 'hr':'Croatian', 'it':'Italian', 'kana':'Japanese', 'kana_utf8':'Japanese (UTF8)', 'nl':'Dutch', 'pl':'Polish', 'pt':'Portuguese', 'pt-br':'Portuguese (Brazilian)', 'pt-br_utf8':'Portuguese (Brazilian UTF8)', 'pt_utf8':'Portuguese (UTF8)', 'ru':'Russian', 'tr':'Turkish', 'uk':'Ukrainian', 'test':'TEST' }
1233
+ */
1238 1234
 #define LCD_LANGUAGE en
1239 1235
 
1240
-//
1241
-// LCD Character Set
1242
-//
1243
-// Note: This option is NOT applicable to Graphical Displays.
1244
-//
1245
-// All character-based LCD's provide ASCII plus one of these
1246
-// language extensions:
1247
-//
1248
-//  - JAPANESE ... the most common
1249
-//  - WESTERN  ... with more accented characters
1250
-//  - CYRILLIC ... for the Russian language
1251
-//
1252
-// To determine the language extension installed on your controller:
1253
-//
1254
-//  - Compile and upload with LCD_LANGUAGE set to 'test'
1255
-//  - Click the controller to view the LCD menu
1256
-//  - The LCD will display Japanese, Western, or Cyrillic text
1257
-//
1258
-// See https://github.com/MarlinFirmware/Marlin/wiki/LCD-Language
1259
-//
1260
-// :['JAPANESE', 'WESTERN', 'CYRILLIC']
1261
-//
1236
+/**
1237
+ * LCD Character Set
1238
+ *
1239
+ * Note: This option is NOT applicable to Graphical Displays.
1240
+ *
1241
+ * All character-based LCDs provide ASCII plus one of these
1242
+ * language extensions:
1243
+ *
1244
+ *  - JAPANESE ... the most common
1245
+ *  - WESTERN  ... with more accented characters
1246
+ *  - CYRILLIC ... for the Russian language
1247
+ *
1248
+ * To determine the language extension installed on your controller:
1249
+ *
1250
+ *  - Compile and upload with LCD_LANGUAGE set to 'test'
1251
+ *  - Click the controller to view the LCD menu
1252
+ *  - The LCD will display Japanese, Western, or Cyrillic text
1253
+ *
1254
+ * See https: *github.com/MarlinFirmware/Marlin/wiki/LCD-Language
1255
+ *
1256
+ * :['JAPANESE', 'WESTERN', 'CYRILLIC']
1257
+ */
1262 1258
 #define DISPLAY_CHARSET_HD44780 WESTERN
1263 1259
 
1264
-//
1265
-// LCD TYPE
1266
-//
1267
-// You may choose ULTRA_LCD if you have character based LCD with 16x2, 16x4, 20x2,
1268
-// 20x4 char/lines or DOGLCD for the full graphics display with 128x64 pixels
1269
-// (ST7565R family). (This option will be set automatically for certain displays.)
1270
-//
1271
-// IMPORTANT NOTE: The U8glib library is required for Full Graphic Display!
1272
-//                 https://github.com/olikraus/U8glib_Arduino
1273
-//
1260
+/**
1261
+ * LCD TYPE
1262
+ *
1263
+ * Enable ULTRA_LCD for a 16x2, 16x4, 20x2, or 20x4 character-based LCD.
1264
+ * Enable DOGLCD for a 128x64 (ST7565R) Full Graphical Display.
1265
+ * (These options will be enabled automatically for most displays.)
1266
+ *
1267
+ * IMPORTANT: The U8glib library is required for Full Graphic Display!
1268
+ *            https://github.com/olikraus/U8glib_Arduino
1269
+ */
1274 1270
 //#define ULTRA_LCD   // Character based
1275 1271
 //#define DOGLCD      // Full graphics display
1276 1272
 
1277
-//
1278
-// SD CARD
1279
-//
1280
-// SD Card support is disabled by default. If your controller has an SD slot,
1281
-// you must uncomment the following option or it won't work.
1282
-//
1273
+/**
1274
+ * SD CARD
1275
+ *
1276
+ * SD Card support is disabled by default. If your controller has an SD slot,
1277
+ * you must uncomment the following option or it won't work.
1278
+ *
1279
+ */
1283 1280
 #define SDSUPPORT
1284 1281
 
1285
-//
1286
-// SD CARD: SPI SPEED
1287
-//
1288
-// Uncomment ONE of the following items to use a slower SPI transfer
1289
-// speed. This is usually required if you're getting volume init errors.
1290
-//
1282
+/**
1283
+ * SD CARD: SPI SPEED
1284
+ *
1285
+ * Enable one of the following items for a slower SPI transfer speed.
1286
+ * This may be required to resolve "volume init" errors.
1287
+ */
1291 1288
 //#define SPI_SPEED SPI_HALF_SPEED
1292 1289
 //#define SPI_SPEED SPI_QUARTER_SPEED
1293 1290
 //#define SPI_SPEED SPI_EIGHTH_SPEED
1294 1291
 
1295
-//
1296
-// SD CARD: ENABLE CRC
1297
-//
1298
-// Use CRC checks and retries on the SD communication.
1299
-//
1292
+/**
1293
+ * SD CARD: ENABLE CRC
1294
+ *
1295
+ * Use CRC checks and retries on the SD communication.
1296
+ */
1300 1297
 #define SD_CHECK_AND_RETRY
1301 1298
 
1302 1299
 //
@@ -1324,7 +1321,7 @@
1324 1321
  */
1325 1322
 
1326 1323
 //
1327
-// This option reverses the encoder direction everywhere
1324
+// This option reverses the encoder direction everywhere.
1328 1325
 //
1329 1326
 //  Set this option if CLOCKWISE causes values to DECREASE
1330 1327
 //

+ 137
- 140
Marlin/example_configurations/delta/FLSUN/kossel_mini/Configuration.h View File

@@ -1106,23 +1106,17 @@
1106 1106
 #define PREHEAT_2_TEMP_BED    100
1107 1107
 #define PREHEAT_2_FAN_SPEED     0 // Value from 0 to 255
1108 1108
 
1109
-//
1110
-// Nozzle Park -- EXPERIMENTAL
1111
-//
1112
-// When enabled allows the user to define a special XYZ position, inside the
1113
-// machine's topology, to park the nozzle when idle or when receiving the G27
1114
-// command.
1115
-//
1116
-// The "P" paramenter controls what is the action applied to the Z axis:
1117
-//    P0: (Default) If current Z-pos is lower than Z-park then the nozzle will
1118
-//        be raised to reach Z-park height.
1119
-//
1120
-//    P1: No matter the current Z-pos, the nozzle will be raised/lowered to
1121
-//        reach Z-park height.
1122
-//
1123
-//    P2: The nozzle height will be raised by Z-park amount but never going over
1124
-//        the machine's limit of Z_MAX_POS.
1125
-//
1109
+/**
1110
+ * Nozzle Park -- EXPERIMENTAL
1111
+ *
1112
+ * Park the nozzle at the given XYZ position on idle or G27.
1113
+ *
1114
+ * The "P" parameter controls the action applied to the Z axis:
1115
+ *
1116
+ *    P0  (Default) If Z is below park Z raise the nozzle.
1117
+ *    P1  Raise the nozzle always to Z-park height.
1118
+ *    P2  Raise the nozzle by Z-park amount, limited to Z_MAX_POS.
1119
+ */
1126 1120
 //#define NOZZLE_PARK_FEATURE
1127 1121
 
1128 1122
 #if ENABLED(NOZZLE_PARK_FEATURE)
@@ -1130,44 +1124,44 @@
1130 1124
   #define NOZZLE_PARK_POINT { (X_MIN_POS + 10), (Y_MAX_POS - 10), 20 }
1131 1125
 #endif
1132 1126
 
1133
-//
1134
-// Clean Nozzle Feature -- EXPERIMENTAL
1135
-//
1136
-// When enabled allows the user to send G12 to start the nozzle cleaning
1137
-// process, the G-Code accepts two parameters:
1138
-//   "P" for pattern selection
1139
-//   "S" for defining the number of strokes/repetitions
1140
-//
1141
-// Available list of patterns:
1142
-//   P0: This is the default pattern, this process requires a sponge type
1143
-//       material at a fixed bed location. S defines "strokes" i.e.
1144
-//       back-and-forth movements between the starting and end points.
1145
-//
1146
-//   P1: This starts a zig-zag pattern between (X0, Y0) and (X1, Y1), "T"
1147
-//       defines the number of zig-zag triangles to be done. "S" defines the
1148
-//       number of strokes aka one back-and-forth movement. Zig-zags will
1149
-//       be performed in whichever dimension is smallest. As an example,
1150
-//       sending "G12 P1 S1 T3" will execute:
1151
-//
1152
-//          --
1153
-//         |  (X0, Y1) |     /\        /\        /\     | (X1, Y1)
1154
-//         |           |    /  \      /  \      /  \    |
1155
-//       A |           |   /    \    /    \    /    \   |
1156
-//         |           |  /      \  /      \  /      \  |
1157
-//         |  (X0, Y0) | /        \/        \/        \ | (X1, Y0)
1158
-//          --         +--------------------------------+
1159
-//                       |________|_________|_________|
1160
-//                           T1        T2        T3
1161
-//
1162
-//   P2: This starts a circular pattern with circle with middle in
1163
-//       NOZZLE_CLEAN_CIRCLE_MIDDLE radius of R and stroke count of S.
1164
-//       Before starting the circle nozzle goes to NOZZLE_CLEAN_START_POINT.
1165
-//
1166
-// Caveats: End point Z should use the same value as Start point Z.
1167
-//
1168
-// Attention: This is an EXPERIMENTAL feature, in the future the G-code arguments
1169
-// may change to add new functionality like different wipe patterns.
1170
-//
1127
+/**
1128
+ * Clean Nozzle Feature -- EXPERIMENTAL
1129
+ *
1130
+ * Adds the G12 command to perform a nozzle cleaning process.
1131
+ *
1132
+ * Parameters:
1133
+ *   P  Pattern
1134
+ *   S  Strokes / Repetitions
1135
+ *   T  Triangles (P1 only)
1136
+ *
1137
+ * Patterns:
1138
+ *   P0  Straight line (default). This process requires a sponge type material
1139
+ *       at a fixed bed location. "S" specifies strokes (i.e. back-forth motions)
1140
+ *       between the start / end points.
1141
+ *
1142
+ *   P1  Zig-zag pattern between (X0, Y0) and (X1, Y1), "T" specifies the
1143
+ *       number of zig-zag triangles to do. "S" defines the number of strokes.
1144
+ *       Zig-zags are done in whichever is the narrower dimension.
1145
+ *       For example, "G12 P1 S1 T3" will execute:
1146
+ *
1147
+ *          --
1148
+ *         |  (X0, Y1) |     /\        /\        /\     | (X1, Y1)
1149
+ *         |           |    /  \      /  \      /  \    |
1150
+ *       A |           |   /    \    /    \    /    \   |
1151
+ *         |           |  /      \  /      \  /      \  |
1152
+ *         |  (X0, Y0) | /        \/        \/        \ | (X1, Y0)
1153
+ *          --         +--------------------------------+
1154
+ *                       |________|_________|_________|
1155
+ *                           T1        T2        T3
1156
+ *
1157
+ *   P2  Circular pattern with middle at NOZZLE_CLEAN_CIRCLE_MIDDLE.
1158
+ *       "R" specifies the radius. "S" specifies the stroke count.
1159
+ *       Before starting, the nozzle moves to NOZZLE_CLEAN_START_POINT.
1160
+ *
1161
+ *   Caveats: The ending Z should be the same as starting Z.
1162
+ * Attention: EXPERIMENTAL. G-code arguments may change.
1163
+ *
1164
+ */
1171 1165
 //#define NOZZLE_CLEAN_FEATURE
1172 1166
 
1173 1167
 #if ENABLED(NOZZLE_CLEAN_FEATURE)
@@ -1192,33 +1186,35 @@
1192 1186
   #define NOZZLE_CLEAN_GOBACK
1193 1187
 #endif
1194 1188
 
1195
-//
1196
-// Print job timer
1197
-//
1198
-// Enable this option to automatically start and stop the
1199
-// print job timer when M104/M109/M190 commands are received.
1200
-// M104 (extruder without wait) - high temp = none, low temp = stop timer
1201
-// M109 (extruder with wait) - high temp = start timer, low temp = stop timer
1202
-// M190 (bed with wait) - high temp = start timer, low temp = none
1203
-//
1204
-// In all cases the timer can be started and stopped using
1205
-// the following commands:
1206
-//
1207
-// - M75  - Start the print job timer
1208
-// - M76  - Pause the print job timer
1209
-// - M77  - Stop the print job timer
1189
+/**
1190
+ * Print Job Timer
1191
+ *
1192
+ * Automatically start and stop the print job timer on M104/M109/M190.
1193
+ *
1194
+ *   M104 (hotend, no wait) - high temp = none,        low temp = stop timer
1195
+ *   M109 (hotend, wait)    - high temp = start timer, low temp = stop timer
1196
+ *   M190 (bed, wait)       - high temp = start timer, low temp = none
1197
+ *
1198
+ * The timer can also be controlled with the following commands:
1199
+ *
1200
+ *   M75 - Start the print job timer
1201
+ *   M76 - Pause the print job timer
1202
+ *   M77 - Stop the print job timer
1203
+ */
1210 1204
 #define PRINTJOB_TIMER_AUTOSTART
1211 1205
 
1212
-//
1213
-// Print Counter
1214
-//
1215
-// When enabled Marlin will keep track of some print statistical data such as:
1216
-//  - Total print jobs
1217
-//  - Total successful print jobs
1218
-//  - Total failed print jobs
1219
-//  - Total time printing
1220
-//
1221
-// This information can be viewed by the M78 command.
1206
+/**
1207
+ * Print Counter
1208
+ *
1209
+ * Track statistical data such as:
1210
+ *
1211
+ *  - Total print jobs
1212
+ *  - Total successful print jobs
1213
+ *  - Total failed print jobs
1214
+ *  - Total time printing
1215
+ *
1216
+ * View the current statistics with M78.
1217
+ */
1222 1218
 #define PRINTCOUNTER
1223 1219
 
1224 1220
 //=============================================================================
@@ -1227,78 +1223,79 @@
1227 1223
 
1228 1224
 // @section lcd
1229 1225
 
1230
-//
1231
-// LCD LANGUAGE
1232
-//
1233
-// Here you may choose the language used by Marlin on the LCD menus, the following
1234
-// list of languages are available:
1235
-//    en, an, bg, ca, cn, cz, de, el, el-gr, es, eu, fi, fr, gl, hr, it,
1236
-//    kana, kana_utf8, nl, pl, pt, pt_utf8, pt-br, pt-br_utf8, ru, tr, uk, test
1237
-//
1238
-// :{ 'en':'English', 'an':'Aragonese', 'bg':'Bulgarian', 'ca':'Catalan', 'cn':'Chinese', 'cz':'Czech', 'de':'German', 'el':'Greek', 'el-gr':'Greek (Greece)', 'es':'Spanish', 'eu':'Basque-Euskera', 'fi':'Finnish', 'fr':'French', 'gl':'Galician', 'hr':'Croatian', 'it':'Italian', 'kana':'Japanese', 'kana_utf8':'Japanese (UTF8)', 'nl':'Dutch', 'pl':'Polish', 'pt':'Portuguese', 'pt-br':'Portuguese (Brazilian)', 'pt-br_utf8':'Portuguese (Brazilian UTF8)', 'pt_utf8':'Portuguese (UTF8)', 'ru':'Russian', 'tr':'Turkish', 'uk':'Ukrainian', 'test':'TEST' }
1239
-//
1226
+/**
1227
+ * LCD LANGUAGE
1228
+ *
1229
+ * Select the language to display on the LCD. These languages are available:
1230
+ *
1231
+ *    en, an, bg, ca, cn, cz, de, el, el-gr, es, eu, fi, fr, gl, hr, it,
1232
+ *    kana, kana_utf8, nl, pl, pt, pt_utf8, pt-br, pt-br_utf8, ru, tr, uk, test
1233
+ *
1234
+ * :{ 'en':'English', 'an':'Aragonese', 'bg':'Bulgarian', 'ca':'Catalan', 'cn':'Chinese', 'cz':'Czech', 'de':'German', 'el':'Greek', 'el-gr':'Greek (Greece)', 'es':'Spanish', 'eu':'Basque-Euskera', 'fi':'Finnish', 'fr':'French', 'gl':'Galician', 'hr':'Croatian', 'it':'Italian', 'kana':'Japanese', 'kana_utf8':'Japanese (UTF8)', 'nl':'Dutch', 'pl':'Polish', 'pt':'Portuguese', 'pt-br':'Portuguese (Brazilian)', 'pt-br_utf8':'Portuguese (Brazilian UTF8)', 'pt_utf8':'Portuguese (UTF8)', 'ru':'Russian', 'tr':'Turkish', 'uk':'Ukrainian', 'test':'TEST' }
1235
+ */
1240 1236
 #define LCD_LANGUAGE en
1241 1237
 
1242
-//
1243
-// LCD Character Set
1244
-//
1245
-// Note: This option is NOT applicable to Graphical Displays.
1246
-//
1247
-// All character-based LCD's provide ASCII plus one of these
1248
-// language extensions:
1249
-//
1250
-//  - JAPANESE ... the most common
1251
-//  - WESTERN  ... with more accented characters
1252
-//  - CYRILLIC ... for the Russian language
1253
-//
1254
-// To determine the language extension installed on your controller:
1255
-//
1256
-//  - Compile and upload with LCD_LANGUAGE set to 'test'
1257
-//  - Click the controller to view the LCD menu
1258
-//  - The LCD will display Japanese, Western, or Cyrillic text
1259
-//
1260
-// See https://github.com/MarlinFirmware/Marlin/wiki/LCD-Language
1261
-//
1262
-// :['JAPANESE', 'WESTERN', 'CYRILLIC']
1263
-//
1238
+/**
1239
+ * LCD Character Set
1240
+ *
1241
+ * Note: This option is NOT applicable to Graphical Displays.
1242
+ *
1243
+ * All character-based LCDs provide ASCII plus one of these
1244
+ * language extensions:
1245
+ *
1246
+ *  - JAPANESE ... the most common
1247
+ *  - WESTERN  ... with more accented characters
1248
+ *  - CYRILLIC ... for the Russian language
1249
+ *
1250
+ * To determine the language extension installed on your controller:
1251
+ *
1252
+ *  - Compile and upload with LCD_LANGUAGE set to 'test'
1253
+ *  - Click the controller to view the LCD menu
1254
+ *  - The LCD will display Japanese, Western, or Cyrillic text
1255
+ *
1256
+ * See https: *github.com/MarlinFirmware/Marlin/wiki/LCD-Language
1257
+ *
1258
+ * :['JAPANESE', 'WESTERN', 'CYRILLIC']
1259
+ */
1264 1260
 #define DISPLAY_CHARSET_HD44780 WESTERN
1265 1261
 
1266
-//
1267
-// LCD TYPE
1268
-//
1269
-// You may choose ULTRA_LCD if you have character based LCD with 16x2, 16x4, 20x2,
1270
-// 20x4 char/lines or DOGLCD for the full graphics display with 128x64 pixels
1271
-// (ST7565R family). (This option will be set automatically for certain displays.)
1272
-//
1273
-// IMPORTANT NOTE: The U8glib library is required for Full Graphic Display!
1274
-//                 https://github.com/olikraus/U8glib_Arduino
1275
-//
1262
+/**
1263
+ * LCD TYPE
1264
+ *
1265
+ * Enable ULTRA_LCD for a 16x2, 16x4, 20x2, or 20x4 character-based LCD.
1266
+ * Enable DOGLCD for a 128x64 (ST7565R) Full Graphical Display.
1267
+ * (These options will be enabled automatically for most displays.)
1268
+ *
1269
+ * IMPORTANT: The U8glib library is required for Full Graphic Display!
1270
+ *            https://github.com/olikraus/U8glib_Arduino
1271
+ */
1276 1272
 //#define ULTRA_LCD   // Character based
1277 1273
 //#define DOGLCD      // Full graphics display
1278 1274
 
1279
-//
1280
-// SD CARD
1281
-//
1282
-// SD Card support is disabled by default. If your controller has an SD slot,
1283
-// you must uncomment the following option or it won't work.
1284
-//
1275
+/**
1276
+ * SD CARD
1277
+ *
1278
+ * SD Card support is disabled by default. If your controller has an SD slot,
1279
+ * you must uncomment the following option or it won't work.
1280
+ *
1281
+ */
1285 1282
 #define SDSUPPORT
1286 1283
 
1287
-//
1288
-// SD CARD: SPI SPEED
1289
-//
1290
-// Uncomment ONE of the following items to use a slower SPI transfer
1291
-// speed. This is usually required if you're getting volume init errors.
1292
-//
1284
+/**
1285
+ * SD CARD: SPI SPEED
1286
+ *
1287
+ * Enable one of the following items for a slower SPI transfer speed.
1288
+ * This may be required to resolve "volume init" errors.
1289
+ */
1293 1290
 //#define SPI_SPEED SPI_HALF_SPEED
1294 1291
 //#define SPI_SPEED SPI_QUARTER_SPEED
1295 1292
 //#define SPI_SPEED SPI_EIGHTH_SPEED
1296 1293
 
1297
-//
1298
-// SD CARD: ENABLE CRC
1299
-//
1300
-// Use CRC checks and retries on the SD communication.
1301
-//
1294
+/**
1295
+ * SD CARD: ENABLE CRC
1296
+ *
1297
+ * Use CRC checks and retries on the SD communication.
1298
+ */
1302 1299
 //#define SD_CHECK_AND_RETRY
1303 1300
 
1304 1301
 //
@@ -1326,7 +1323,7 @@
1326 1323
  */
1327 1324
 
1328 1325
 //
1329
-// This option reverses the encoder direction everywhere
1326
+// This option reverses the encoder direction everywhere.
1330 1327
 //
1331 1328
 //  Set this option if CLOCKWISE causes values to DECREASE
1332 1329
 //

+ 137
- 140
Marlin/example_configurations/delta/generic/Configuration.h View File

@@ -1093,23 +1093,17 @@
1093 1093
 #define PREHEAT_2_TEMP_BED    100
1094 1094
 #define PREHEAT_2_FAN_SPEED   255 // Value from 0 to 255
1095 1095
 
1096
-//
1097
-// Nozzle Park -- EXPERIMENTAL
1098
-//
1099
-// When enabled allows the user to define a special XYZ position, inside the
1100
-// machine's topology, to park the nozzle when idle or when receiving the G27
1101
-// command.
1102
-//
1103
-// The "P" paramenter controls what is the action applied to the Z axis:
1104
-//    P0: (Default) If current Z-pos is lower than Z-park then the nozzle will
1105
-//        be raised to reach Z-park height.
1106
-//
1107
-//    P1: No matter the current Z-pos, the nozzle will be raised/lowered to
1108
-//        reach Z-park height.
1109
-//
1110
-//    P2: The nozzle height will be raised by Z-park amount but never going over
1111
-//        the machine's limit of Z_MAX_POS.
1112
-//
1096
+/**
1097
+ * Nozzle Park -- EXPERIMENTAL
1098
+ *
1099
+ * Park the nozzle at the given XYZ position on idle or G27.
1100
+ *
1101
+ * The "P" parameter controls the action applied to the Z axis:
1102
+ *
1103
+ *    P0  (Default) If Z is below park Z raise the nozzle.
1104
+ *    P1  Raise the nozzle always to Z-park height.
1105
+ *    P2  Raise the nozzle by Z-park amount, limited to Z_MAX_POS.
1106
+ */
1113 1107
 //#define NOZZLE_PARK_FEATURE
1114 1108
 
1115 1109
 #if ENABLED(NOZZLE_PARK_FEATURE)
@@ -1117,44 +1111,44 @@
1117 1111
   #define NOZZLE_PARK_POINT { (X_MIN_POS + 10), (Y_MAX_POS - 10), 20 }
1118 1112
 #endif
1119 1113
 
1120
-//
1121
-// Clean Nozzle Feature -- EXPERIMENTAL
1122
-//
1123
-// When enabled allows the user to send G12 to start the nozzle cleaning
1124
-// process, the G-Code accepts two parameters:
1125
-//   "P" for pattern selection
1126
-//   "S" for defining the number of strokes/repetitions
1127
-//
1128
-// Available list of patterns:
1129
-//   P0: This is the default pattern, this process requires a sponge type
1130
-//       material at a fixed bed location. S defines "strokes" i.e.
1131
-//       back-and-forth movements between the starting and end points.
1132
-//
1133
-//   P1: This starts a zig-zag pattern between (X0, Y0) and (X1, Y1), "T"
1134
-//       defines the number of zig-zag triangles to be done. "S" defines the
1135
-//       number of strokes aka one back-and-forth movement. Zig-zags will
1136
-//       be performed in whichever dimension is smallest. As an example,
1137
-//       sending "G12 P1 S1 T3" will execute:
1138
-//
1139
-//          --
1140
-//         |  (X0, Y1) |     /\        /\        /\     | (X1, Y1)
1141
-//         |           |    /  \      /  \      /  \    |
1142
-//       A |           |   /    \    /    \    /    \   |
1143
-//         |           |  /      \  /      \  /      \  |
1144
-//         |  (X0, Y0) | /        \/        \/        \ | (X1, Y0)
1145
-//          --         +--------------------------------+
1146
-//                       |________|_________|_________|
1147
-//                           T1        T2        T3
1148
-//
1149
-//   P2: This starts a circular pattern with circle with middle in
1150
-//       NOZZLE_CLEAN_CIRCLE_MIDDLE radius of R and stroke count of S.
1151
-//       Before starting the circle nozzle goes to NOZZLE_CLEAN_START_POINT.
1152
-//
1153
-// Caveats: End point Z should use the same value as Start point Z.
1154
-//
1155
-// Attention: This is an EXPERIMENTAL feature, in the future the G-code arguments
1156
-// may change to add new functionality like different wipe patterns.
1157
-//
1114
+/**
1115
+ * Clean Nozzle Feature -- EXPERIMENTAL
1116
+ *
1117
+ * Adds the G12 command to perform a nozzle cleaning process.
1118
+ *
1119
+ * Parameters:
1120
+ *   P  Pattern
1121
+ *   S  Strokes / Repetitions
1122
+ *   T  Triangles (P1 only)
1123
+ *
1124
+ * Patterns:
1125
+ *   P0  Straight line (default). This process requires a sponge type material
1126
+ *       at a fixed bed location. "S" specifies strokes (i.e. back-forth motions)
1127
+ *       between the start / end points.
1128
+ *
1129
+ *   P1  Zig-zag pattern between (X0, Y0) and (X1, Y1), "T" specifies the
1130
+ *       number of zig-zag triangles to do. "S" defines the number of strokes.
1131
+ *       Zig-zags are done in whichever is the narrower dimension.
1132
+ *       For example, "G12 P1 S1 T3" will execute:
1133
+ *
1134
+ *          --
1135
+ *         |  (X0, Y1) |     /\        /\        /\     | (X1, Y1)
1136
+ *         |           |    /  \      /  \      /  \    |
1137
+ *       A |           |   /    \    /    \    /    \   |
1138
+ *         |           |  /      \  /      \  /      \  |
1139
+ *         |  (X0, Y0) | /        \/        \/        \ | (X1, Y0)
1140
+ *          --         +--------------------------------+
1141
+ *                       |________|_________|_________|
1142
+ *                           T1        T2        T3
1143
+ *
1144
+ *   P2  Circular pattern with middle at NOZZLE_CLEAN_CIRCLE_MIDDLE.
1145
+ *       "R" specifies the radius. "S" specifies the stroke count.
1146
+ *       Before starting, the nozzle moves to NOZZLE_CLEAN_START_POINT.
1147
+ *
1148
+ *   Caveats: The ending Z should be the same as starting Z.
1149
+ * Attention: EXPERIMENTAL. G-code arguments may change.
1150
+ *
1151
+ */
1158 1152
 //#define NOZZLE_CLEAN_FEATURE
1159 1153
 
1160 1154
 #if ENABLED(NOZZLE_CLEAN_FEATURE)
@@ -1179,33 +1173,35 @@
1179 1173
   #define NOZZLE_CLEAN_GOBACK
1180 1174
 #endif
1181 1175
 
1182
-//
1183
-// Print job timer
1184
-//
1185
-// Enable this option to automatically start and stop the
1186
-// print job timer when M104/M109/M190 commands are received.
1187
-// M104 (extruder without wait) - high temp = none, low temp = stop timer
1188
-// M109 (extruder with wait) - high temp = start timer, low temp = stop timer
1189
-// M190 (bed with wait) - high temp = start timer, low temp = none
1190
-//
1191
-// In all cases the timer can be started and stopped using
1192
-// the following commands:
1193
-//
1194
-// - M75  - Start the print job timer
1195
-// - M76  - Pause the print job timer
1196
-// - M77  - Stop the print job timer
1176
+/**
1177
+ * Print Job Timer
1178
+ *
1179
+ * Automatically start and stop the print job timer on M104/M109/M190.
1180
+ *
1181
+ *   M104 (hotend, no wait) - high temp = none,        low temp = stop timer
1182
+ *   M109 (hotend, wait)    - high temp = start timer, low temp = stop timer
1183
+ *   M190 (bed, wait)       - high temp = start timer, low temp = none
1184
+ *
1185
+ * The timer can also be controlled with the following commands:
1186
+ *
1187
+ *   M75 - Start the print job timer
1188
+ *   M76 - Pause the print job timer
1189
+ *   M77 - Stop the print job timer
1190
+ */
1197 1191
 #define PRINTJOB_TIMER_AUTOSTART
1198 1192
 
1199
-//
1200
-// Print Counter
1201
-//
1202
-// When enabled Marlin will keep track of some print statistical data such as:
1203
-//  - Total print jobs
1204
-//  - Total successful print jobs
1205
-//  - Total failed print jobs
1206
-//  - Total time printing
1207
-//
1208
-// This information can be viewed by the M78 command.
1193
+/**
1194
+ * Print Counter
1195
+ *
1196
+ * Track statistical data such as:
1197
+ *
1198
+ *  - Total print jobs
1199
+ *  - Total successful print jobs
1200
+ *  - Total failed print jobs
1201
+ *  - Total time printing
1202
+ *
1203
+ * View the current statistics with M78.
1204
+ */
1209 1205
 //#define PRINTCOUNTER
1210 1206
 
1211 1207
 //=============================================================================
@@ -1214,78 +1210,79 @@
1214 1210
 
1215 1211
 // @section lcd
1216 1212
 
1217
-//
1218
-// LCD LANGUAGE
1219
-//
1220
-// Here you may choose the language used by Marlin on the LCD menus, the following
1221
-// list of languages are available:
1222
-//    en, an, bg, ca, cn, cz, de, el, el-gr, es, eu, fi, fr, gl, hr, it,
1223
-//    kana, kana_utf8, nl, pl, pt, pt_utf8, pt-br, pt-br_utf8, ru, tr, uk, test
1224
-//
1225
-// :{ 'en':'English', 'an':'Aragonese', 'bg':'Bulgarian', 'ca':'Catalan', 'cn':'Chinese', 'cz':'Czech', 'de':'German', 'el':'Greek', 'el-gr':'Greek (Greece)', 'es':'Spanish', 'eu':'Basque-Euskera', 'fi':'Finnish', 'fr':'French', 'gl':'Galician', 'hr':'Croatian', 'it':'Italian', 'kana':'Japanese', 'kana_utf8':'Japanese (UTF8)', 'nl':'Dutch', 'pl':'Polish', 'pt':'Portuguese', 'pt-br':'Portuguese (Brazilian)', 'pt-br_utf8':'Portuguese (Brazilian UTF8)', 'pt_utf8':'Portuguese (UTF8)', 'ru':'Russian', 'tr':'Turkish', 'uk':'Ukrainian', 'test':'TEST' }
1226
-//
1213
+/**
1214
+ * LCD LANGUAGE
1215
+ *
1216
+ * Select the language to display on the LCD. These languages are available:
1217
+ *
1218
+ *    en, an, bg, ca, cn, cz, de, el, el-gr, es, eu, fi, fr, gl, hr, it,
1219
+ *    kana, kana_utf8, nl, pl, pt, pt_utf8, pt-br, pt-br_utf8, ru, tr, uk, test
1220
+ *
1221
+ * :{ 'en':'English', 'an':'Aragonese', 'bg':'Bulgarian', 'ca':'Catalan', 'cn':'Chinese', 'cz':'Czech', 'de':'German', 'el':'Greek', 'el-gr':'Greek (Greece)', 'es':'Spanish', 'eu':'Basque-Euskera', 'fi':'Finnish', 'fr':'French', 'gl':'Galician', 'hr':'Croatian', 'it':'Italian', 'kana':'Japanese', 'kana_utf8':'Japanese (UTF8)', 'nl':'Dutch', 'pl':'Polish', 'pt':'Portuguese', 'pt-br':'Portuguese (Brazilian)', 'pt-br_utf8':'Portuguese (Brazilian UTF8)', 'pt_utf8':'Portuguese (UTF8)', 'ru':'Russian', 'tr':'Turkish', 'uk':'Ukrainian', 'test':'TEST' }
1222
+ */
1227 1223
 #define LCD_LANGUAGE en
1228 1224
 
1229
-//
1230
-// LCD Character Set
1231
-//
1232
-// Note: This option is NOT applicable to Graphical Displays.
1233
-//
1234
-// All character-based LCD's provide ASCII plus one of these
1235
-// language extensions:
1236
-//
1237
-//  - JAPANESE ... the most common
1238
-//  - WESTERN  ... with more accented characters
1239
-//  - CYRILLIC ... for the Russian language
1240
-//
1241
-// To determine the language extension installed on your controller:
1242
-//
1243
-//  - Compile and upload with LCD_LANGUAGE set to 'test'
1244
-//  - Click the controller to view the LCD menu
1245
-//  - The LCD will display Japanese, Western, or Cyrillic text
1246
-//
1247
-// See https://github.com/MarlinFirmware/Marlin/wiki/LCD-Language
1248
-//
1249
-// :['JAPANESE', 'WESTERN', 'CYRILLIC']
1250
-//
1225
+/**
1226
+ * LCD Character Set
1227
+ *
1228
+ * Note: This option is NOT applicable to Graphical Displays.
1229
+ *
1230
+ * All character-based LCDs provide ASCII plus one of these
1231
+ * language extensions:
1232
+ *
1233
+ *  - JAPANESE ... the most common
1234
+ *  - WESTERN  ... with more accented characters
1235
+ *  - CYRILLIC ... for the Russian language
1236
+ *
1237
+ * To determine the language extension installed on your controller:
1238
+ *
1239
+ *  - Compile and upload with LCD_LANGUAGE set to 'test'
1240
+ *  - Click the controller to view the LCD menu
1241
+ *  - The LCD will display Japanese, Western, or Cyrillic text
1242
+ *
1243
+ * See https: *github.com/MarlinFirmware/Marlin/wiki/LCD-Language
1244
+ *
1245
+ * :['JAPANESE', 'WESTERN', 'CYRILLIC']
1246
+ */
1251 1247
 #define DISPLAY_CHARSET_HD44780 JAPANESE
1252 1248
 
1253
-//
1254
-// LCD TYPE
1255
-//
1256
-// You may choose ULTRA_LCD if you have character based LCD with 16x2, 16x4, 20x2,
1257
-// 20x4 char/lines or DOGLCD for the full graphics display with 128x64 pixels
1258
-// (ST7565R family). (This option will be set automatically for certain displays.)
1259
-//
1260
-// IMPORTANT NOTE: The U8glib library is required for Full Graphic Display!
1261
-//                 https://github.com/olikraus/U8glib_Arduino
1262
-//
1249
+/**
1250
+ * LCD TYPE
1251
+ *
1252
+ * Enable ULTRA_LCD for a 16x2, 16x4, 20x2, or 20x4 character-based LCD.
1253
+ * Enable DOGLCD for a 128x64 (ST7565R) Full Graphical Display.
1254
+ * (These options will be enabled automatically for most displays.)
1255
+ *
1256
+ * IMPORTANT: The U8glib library is required for Full Graphic Display!
1257
+ *            https://github.com/olikraus/U8glib_Arduino
1258
+ */
1263 1259
 //#define ULTRA_LCD   // Character based
1264 1260
 //#define DOGLCD      // Full graphics display
1265 1261
 
1266
-//
1267
-// SD CARD
1268
-//
1269
-// SD Card support is disabled by default. If your controller has an SD slot,
1270
-// you must uncomment the following option or it won't work.
1271
-//
1262
+/**
1263
+ * SD CARD
1264
+ *
1265
+ * SD Card support is disabled by default. If your controller has an SD slot,
1266
+ * you must uncomment the following option or it won't work.
1267
+ *
1268
+ */
1272 1269
 //#define SDSUPPORT
1273 1270
 
1274
-//
1275
-// SD CARD: SPI SPEED
1276
-//
1277
-// Uncomment ONE of the following items to use a slower SPI transfer
1278
-// speed. This is usually required if you're getting volume init errors.
1279
-//
1271
+/**
1272
+ * SD CARD: SPI SPEED
1273
+ *
1274
+ * Enable one of the following items for a slower SPI transfer speed.
1275
+ * This may be required to resolve "volume init" errors.
1276
+ */
1280 1277
 //#define SPI_SPEED SPI_HALF_SPEED
1281 1278
 //#define SPI_SPEED SPI_QUARTER_SPEED
1282 1279
 //#define SPI_SPEED SPI_EIGHTH_SPEED
1283 1280
 
1284
-//
1285
-// SD CARD: ENABLE CRC
1286
-//
1287
-// Use CRC checks and retries on the SD communication.
1288
-//
1281
+/**
1282
+ * SD CARD: ENABLE CRC
1283
+ *
1284
+ * Use CRC checks and retries on the SD communication.
1285
+ */
1289 1286
 //#define SD_CHECK_AND_RETRY
1290 1287
 
1291 1288
 //
@@ -1313,7 +1310,7 @@
1313 1310
  */
1314 1311
 
1315 1312
 //
1316
-// This option reverses the encoder direction everywhere
1313
+// This option reverses the encoder direction everywhere.
1317 1314
 //
1318 1315
 //  Set this option if CLOCKWISE causes values to DECREASE
1319 1316
 //

+ 137
- 140
Marlin/example_configurations/delta/kossel_mini/Configuration.h View File

@@ -1096,23 +1096,17 @@
1096 1096
 #define PREHEAT_2_TEMP_BED    100
1097 1097
 #define PREHEAT_2_FAN_SPEED   255 // Value from 0 to 255
1098 1098
 
1099
-//
1100
-// Nozzle Park -- EXPERIMENTAL
1101
-//
1102
-// When enabled allows the user to define a special XYZ position, inside the
1103
-// machine's topology, to park the nozzle when idle or when receiving the G27
1104
-// command.
1105
-//
1106
-// The "P" paramenter controls what is the action applied to the Z axis:
1107
-//    P0: (Default) If current Z-pos is lower than Z-park then the nozzle will
1108
-//        be raised to reach Z-park height.
1109
-//
1110
-//    P1: No matter the current Z-pos, the nozzle will be raised/lowered to
1111
-//        reach Z-park height.
1112
-//
1113
-//    P2: The nozzle height will be raised by Z-park amount but never going over
1114
-//        the machine's limit of Z_MAX_POS.
1115
-//
1099
+/**
1100
+ * Nozzle Park -- EXPERIMENTAL
1101
+ *
1102
+ * Park the nozzle at the given XYZ position on idle or G27.
1103
+ *
1104
+ * The "P" parameter controls the action applied to the Z axis:
1105
+ *
1106
+ *    P0  (Default) If Z is below park Z raise the nozzle.
1107
+ *    P1  Raise the nozzle always to Z-park height.
1108
+ *    P2  Raise the nozzle by Z-park amount, limited to Z_MAX_POS.
1109
+ */
1116 1110
 //#define NOZZLE_PARK_FEATURE
1117 1111
 
1118 1112
 #if ENABLED(NOZZLE_PARK_FEATURE)
@@ -1120,44 +1114,44 @@
1120 1114
   #define NOZZLE_PARK_POINT { (X_MIN_POS + 10), (Y_MAX_POS - 10), 20 }
1121 1115
 #endif
1122 1116
 
1123
-//
1124
-// Clean Nozzle Feature -- EXPERIMENTAL
1125
-//
1126
-// When enabled allows the user to send G12 to start the nozzle cleaning
1127
-// process, the G-Code accepts two parameters:
1128
-//   "P" for pattern selection
1129
-//   "S" for defining the number of strokes/repetitions
1130
-//
1131
-// Available list of patterns:
1132
-//   P0: This is the default pattern, this process requires a sponge type
1133
-//       material at a fixed bed location. S defines "strokes" i.e.
1134
-//       back-and-forth movements between the starting and end points.
1135
-//
1136
-//   P1: This starts a zig-zag pattern between (X0, Y0) and (X1, Y1), "T"
1137
-//       defines the number of zig-zag triangles to be done. "S" defines the
1138
-//       number of strokes aka one back-and-forth movement. Zig-zags will
1139
-//       be performed in whichever dimension is smallest. As an example,
1140
-//       sending "G12 P1 S1 T3" will execute:
1141
-//
1142
-//          --
1143
-//         |  (X0, Y1) |     /\        /\        /\     | (X1, Y1)
1144
-//         |           |    /  \      /  \      /  \    |
1145
-//       A |           |   /    \    /    \    /    \   |
1146
-//         |           |  /      \  /      \  /      \  |
1147
-//         |  (X0, Y0) | /        \/        \/        \ | (X1, Y0)
1148
-//          --         +--------------------------------+
1149
-//                       |________|_________|_________|
1150
-//                           T1        T2        T3
1151
-//
1152
-//   P2: This starts a circular pattern with circle with middle in
1153
-//       NOZZLE_CLEAN_CIRCLE_MIDDLE radius of R and stroke count of S.
1154
-//       Before starting the circle nozzle goes to NOZZLE_CLEAN_START_POINT.
1155
-//
1156
-// Caveats: End point Z should use the same value as Start point Z.
1157
-//
1158
-// Attention: This is an EXPERIMENTAL feature, in the future the G-code arguments
1159
-// may change to add new functionality like different wipe patterns.
1160
-//
1117
+/**
1118
+ * Clean Nozzle Feature -- EXPERIMENTAL
1119
+ *
1120
+ * Adds the G12 command to perform a nozzle cleaning process.
1121
+ *
1122
+ * Parameters:
1123
+ *   P  Pattern
1124
+ *   S  Strokes / Repetitions
1125
+ *   T  Triangles (P1 only)
1126
+ *
1127
+ * Patterns:
1128
+ *   P0  Straight line (default). This process requires a sponge type material
1129
+ *       at a fixed bed location. "S" specifies strokes (i.e. back-forth motions)
1130
+ *       between the start / end points.
1131
+ *
1132
+ *   P1  Zig-zag pattern between (X0, Y0) and (X1, Y1), "T" specifies the
1133
+ *       number of zig-zag triangles to do. "S" defines the number of strokes.
1134
+ *       Zig-zags are done in whichever is the narrower dimension.
1135
+ *       For example, "G12 P1 S1 T3" will execute:
1136
+ *
1137
+ *          --
1138
+ *         |  (X0, Y1) |     /\        /\        /\     | (X1, Y1)
1139
+ *         |           |    /  \      /  \      /  \    |
1140
+ *       A |           |   /    \    /    \    /    \   |
1141
+ *         |           |  /      \  /      \  /      \  |
1142
+ *         |  (X0, Y0) | /        \/        \/        \ | (X1, Y0)
1143
+ *          --         +--------------------------------+
1144
+ *                       |________|_________|_________|
1145
+ *                           T1        T2        T3
1146
+ *
1147
+ *   P2  Circular pattern with middle at NOZZLE_CLEAN_CIRCLE_MIDDLE.
1148
+ *       "R" specifies the radius. "S" specifies the stroke count.
1149
+ *       Before starting, the nozzle moves to NOZZLE_CLEAN_START_POINT.
1150
+ *
1151
+ *   Caveats: The ending Z should be the same as starting Z.
1152
+ * Attention: EXPERIMENTAL. G-code arguments may change.
1153
+ *
1154
+ */
1161 1155
 //#define NOZZLE_CLEAN_FEATURE
1162 1156
 
1163 1157
 #if ENABLED(NOZZLE_CLEAN_FEATURE)
@@ -1182,33 +1176,35 @@
1182 1176
   #define NOZZLE_CLEAN_GOBACK
1183 1177
 #endif
1184 1178
 
1185
-//
1186
-// Print job timer
1187
-//
1188
-// Enable this option to automatically start and stop the
1189
-// print job timer when M104/M109/M190 commands are received.
1190
-// M104 (extruder without wait) - high temp = none, low temp = stop timer
1191
-// M109 (extruder with wait) - high temp = start timer, low temp = stop timer
1192
-// M190 (bed with wait) - high temp = start timer, low temp = none
1193
-//
1194
-// In all cases the timer can be started and stopped using
1195
-// the following commands:
1196
-//
1197
-// - M75  - Start the print job timer
1198
-// - M76  - Pause the print job timer
1199
-// - M77  - Stop the print job timer
1179
+/**
1180
+ * Print Job Timer
1181
+ *
1182
+ * Automatically start and stop the print job timer on M104/M109/M190.
1183
+ *
1184
+ *   M104 (hotend, no wait) - high temp = none,        low temp = stop timer
1185
+ *   M109 (hotend, wait)    - high temp = start timer, low temp = stop timer
1186
+ *   M190 (bed, wait)       - high temp = start timer, low temp = none
1187
+ *
1188
+ * The timer can also be controlled with the following commands:
1189
+ *
1190
+ *   M75 - Start the print job timer
1191
+ *   M76 - Pause the print job timer
1192
+ *   M77 - Stop the print job timer
1193
+ */
1200 1194
 #define PRINTJOB_TIMER_AUTOSTART
1201 1195
 
1202
-//
1203
-// Print Counter
1204
-//
1205
-// When enabled Marlin will keep track of some print statistical data such as:
1206
-//  - Total print jobs
1207
-//  - Total successful print jobs
1208
-//  - Total failed print jobs
1209
-//  - Total time printing
1210
-//
1211
-// This information can be viewed by the M78 command.
1196
+/**
1197
+ * Print Counter
1198
+ *
1199
+ * Track statistical data such as:
1200
+ *
1201
+ *  - Total print jobs
1202
+ *  - Total successful print jobs
1203
+ *  - Total failed print jobs
1204
+ *  - Total time printing
1205
+ *
1206
+ * View the current statistics with M78.
1207
+ */
1212 1208
 //#define PRINTCOUNTER
1213 1209
 
1214 1210
 //=============================================================================
@@ -1217,78 +1213,79 @@
1217 1213
 
1218 1214
 // @section lcd
1219 1215
 
1220
-//
1221
-// LCD LANGUAGE
1222
-//
1223
-// Here you may choose the language used by Marlin on the LCD menus, the following
1224
-// list of languages are available:
1225
-//    en, an, bg, ca, cn, cz, de, el, el-gr, es, eu, fi, fr, gl, hr, it,
1226
-//    kana, kana_utf8, nl, pl, pt, pt_utf8, pt-br, pt-br_utf8, ru, tr, uk, test
1227
-//
1228
-// :{ 'en':'English', 'an':'Aragonese', 'bg':'Bulgarian', 'ca':'Catalan', 'cn':'Chinese', 'cz':'Czech', 'de':'German', 'el':'Greek', 'el-gr':'Greek (Greece)', 'es':'Spanish', 'eu':'Basque-Euskera', 'fi':'Finnish', 'fr':'French', 'gl':'Galician', 'hr':'Croatian', 'it':'Italian', 'kana':'Japanese', 'kana_utf8':'Japanese (UTF8)', 'nl':'Dutch', 'pl':'Polish', 'pt':'Portuguese', 'pt-br':'Portuguese (Brazilian)', 'pt-br_utf8':'Portuguese (Brazilian UTF8)', 'pt_utf8':'Portuguese (UTF8)', 'ru':'Russian', 'tr':'Turkish', 'uk':'Ukrainian', 'test':'TEST' }
1229
-//
1216
+/**
1217
+ * LCD LANGUAGE
1218
+ *
1219
+ * Select the language to display on the LCD. These languages are available:
1220
+ *
1221
+ *    en, an, bg, ca, cn, cz, de, el, el-gr, es, eu, fi, fr, gl, hr, it,
1222
+ *    kana, kana_utf8, nl, pl, pt, pt_utf8, pt-br, pt-br_utf8, ru, tr, uk, test
1223
+ *
1224
+ * :{ 'en':'English', 'an':'Aragonese', 'bg':'Bulgarian', 'ca':'Catalan', 'cn':'Chinese', 'cz':'Czech', 'de':'German', 'el':'Greek', 'el-gr':'Greek (Greece)', 'es':'Spanish', 'eu':'Basque-Euskera', 'fi':'Finnish', 'fr':'French', 'gl':'Galician', 'hr':'Croatian', 'it':'Italian', 'kana':'Japanese', 'kana_utf8':'Japanese (UTF8)', 'nl':'Dutch', 'pl':'Polish', 'pt':'Portuguese', 'pt-br':'Portuguese (Brazilian)', 'pt-br_utf8':'Portuguese (Brazilian UTF8)', 'pt_utf8':'Portuguese (UTF8)', 'ru':'Russian', 'tr':'Turkish', 'uk':'Ukrainian', 'test':'TEST' }
1225
+ */
1230 1226
 #define LCD_LANGUAGE en
1231 1227
 
1232
-//
1233
-// LCD Character Set
1234
-//
1235
-// Note: This option is NOT applicable to Graphical Displays.
1236
-//
1237
-// All character-based LCD's provide ASCII plus one of these
1238
-// language extensions:
1239
-//
1240
-//  - JAPANESE ... the most common
1241
-//  - WESTERN  ... with more accented characters
1242
-//  - CYRILLIC ... for the Russian language
1243
-//
1244
-// To determine the language extension installed on your controller:
1245
-//
1246
-//  - Compile and upload with LCD_LANGUAGE set to 'test'
1247
-//  - Click the controller to view the LCD menu
1248
-//  - The LCD will display Japanese, Western, or Cyrillic text
1249
-//
1250
-// See https://github.com/MarlinFirmware/Marlin/wiki/LCD-Language
1251
-//
1252
-// :['JAPANESE', 'WESTERN', 'CYRILLIC']
1253
-//
1228
+/**
1229
+ * LCD Character Set
1230
+ *
1231
+ * Note: This option is NOT applicable to Graphical Displays.
1232
+ *
1233
+ * All character-based LCDs provide ASCII plus one of these
1234
+ * language extensions:
1235
+ *
1236
+ *  - JAPANESE ... the most common
1237
+ *  - WESTERN  ... with more accented characters
1238
+ *  - CYRILLIC ... for the Russian language
1239
+ *
1240
+ * To determine the language extension installed on your controller:
1241
+ *
1242
+ *  - Compile and upload with LCD_LANGUAGE set to 'test'
1243
+ *  - Click the controller to view the LCD menu
1244
+ *  - The LCD will display Japanese, Western, or Cyrillic text
1245
+ *
1246
+ * See https: *github.com/MarlinFirmware/Marlin/wiki/LCD-Language
1247
+ *
1248
+ * :['JAPANESE', 'WESTERN', 'CYRILLIC']
1249
+ */
1254 1250
 #define DISPLAY_CHARSET_HD44780 JAPANESE
1255 1251
 
1256
-//
1257
-// LCD TYPE
1258
-//
1259
-// You may choose ULTRA_LCD if you have character based LCD with 16x2, 16x4, 20x2,
1260
-// 20x4 char/lines or DOGLCD for the full graphics display with 128x64 pixels
1261
-// (ST7565R family). (This option will be set automatically for certain displays.)
1262
-//
1263
-// IMPORTANT NOTE: The U8glib library is required for Full Graphic Display!
1264
-//                 https://github.com/olikraus/U8glib_Arduino
1265
-//
1252
+/**
1253
+ * LCD TYPE
1254
+ *
1255
+ * Enable ULTRA_LCD for a 16x2, 16x4, 20x2, or 20x4 character-based LCD.
1256
+ * Enable DOGLCD for a 128x64 (ST7565R) Full Graphical Display.
1257
+ * (These options will be enabled automatically for most displays.)
1258
+ *
1259
+ * IMPORTANT: The U8glib library is required for Full Graphic Display!
1260
+ *            https://github.com/olikraus/U8glib_Arduino
1261
+ */
1266 1262
 //#define ULTRA_LCD   // Character based
1267 1263
 //#define DOGLCD      // Full graphics display
1268 1264
 
1269
-//
1270
-// SD CARD
1271
-//
1272
-// SD Card support is disabled by default. If your controller has an SD slot,
1273
-// you must uncomment the following option or it won't work.
1274
-//
1265
+/**
1266
+ * SD CARD
1267
+ *
1268
+ * SD Card support is disabled by default. If your controller has an SD slot,
1269
+ * you must uncomment the following option or it won't work.
1270
+ *
1271
+ */
1275 1272
 //#define SDSUPPORT
1276 1273
 
1277
-//
1278
-// SD CARD: SPI SPEED
1279
-//
1280
-// Uncomment ONE of the following items to use a slower SPI transfer
1281
-// speed. This is usually required if you're getting volume init errors.
1282
-//
1274
+/**
1275
+ * SD CARD: SPI SPEED
1276
+ *
1277
+ * Enable one of the following items for a slower SPI transfer speed.
1278
+ * This may be required to resolve "volume init" errors.
1279
+ */
1283 1280
 //#define SPI_SPEED SPI_HALF_SPEED
1284 1281
 //#define SPI_SPEED SPI_QUARTER_SPEED
1285 1282
 //#define SPI_SPEED SPI_EIGHTH_SPEED
1286 1283
 
1287
-//
1288
-// SD CARD: ENABLE CRC
1289
-//
1290
-// Use CRC checks and retries on the SD communication.
1291
-//
1284
+/**
1285
+ * SD CARD: ENABLE CRC
1286
+ *
1287
+ * Use CRC checks and retries on the SD communication.
1288
+ */
1292 1289
 //#define SD_CHECK_AND_RETRY
1293 1290
 
1294 1291
 //
@@ -1316,7 +1313,7 @@
1316 1313
  */
1317 1314
 
1318 1315
 //
1319
-// This option reverses the encoder direction everywhere
1316
+// This option reverses the encoder direction everywhere.
1320 1317
 //
1321 1318
 //  Set this option if CLOCKWISE causes values to DECREASE
1322 1319
 //

+ 137
- 140
Marlin/example_configurations/delta/kossel_pro/Configuration.h View File

@@ -1102,23 +1102,17 @@
1102 1102
 #define PREHEAT_2_TEMP_BED    100
1103 1103
 #define PREHEAT_2_FAN_SPEED   255 // Value from 0 to 255
1104 1104
 
1105
-//
1106
-// Nozzle Park -- EXPERIMENTAL
1107
-//
1108
-// When enabled allows the user to define a special XYZ position, inside the
1109
-// machine's topology, to park the nozzle when idle or when receiving the G27
1110
-// command.
1111
-//
1112
-// The "P" paramenter controls what is the action applied to the Z axis:
1113
-//    P0: (Default) If current Z-pos is lower than Z-park then the nozzle will
1114
-//        be raised to reach Z-park height.
1115
-//
1116
-//    P1: No matter the current Z-pos, the nozzle will be raised/lowered to
1117
-//        reach Z-park height.
1118
-//
1119
-//    P2: The nozzle height will be raised by Z-park amount but never going over
1120
-//        the machine's limit of Z_MAX_POS.
1121
-//
1105
+/**
1106
+ * Nozzle Park -- EXPERIMENTAL
1107
+ *
1108
+ * Park the nozzle at the given XYZ position on idle or G27.
1109
+ *
1110
+ * The "P" parameter controls the action applied to the Z axis:
1111
+ *
1112
+ *    P0  (Default) If Z is below park Z raise the nozzle.
1113
+ *    P1  Raise the nozzle always to Z-park height.
1114
+ *    P2  Raise the nozzle by Z-park amount, limited to Z_MAX_POS.
1115
+ */
1122 1116
 //#define NOZZLE_PARK_FEATURE
1123 1117
 
1124 1118
 #if ENABLED(NOZZLE_PARK_FEATURE)
@@ -1126,44 +1120,44 @@
1126 1120
   #define NOZZLE_PARK_POINT { (X_MIN_POS + 10), (Y_MAX_POS - 10), 20 }
1127 1121
 #endif
1128 1122
 
1129
-//
1130
-// Clean Nozzle Feature -- EXPERIMENTAL
1131
-//
1132
-// When enabled allows the user to send G12 to start the nozzle cleaning
1133
-// process, the G-Code accepts two parameters:
1134
-//   "P" for pattern selection
1135
-//   "S" for defining the number of strokes/repetitions
1136
-//
1137
-// Available list of patterns:
1138
-//   P0: This is the default pattern, this process requires a sponge type
1139
-//       material at a fixed bed location. S defines "strokes" i.e.
1140
-//       back-and-forth movements between the starting and end points.
1141
-//
1142
-//   P1: This starts a zig-zag pattern between (X0, Y0) and (X1, Y1), "T"
1143
-//       defines the number of zig-zag triangles to be done. "S" defines the
1144
-//       number of strokes aka one back-and-forth movement. Zig-zags will
1145
-//       be performed in whichever dimension is smallest. As an example,
1146
-//       sending "G12 P1 S1 T3" will execute:
1147
-//
1148
-//          --
1149
-//         |  (X0, Y1) |     /\        /\        /\     | (X1, Y1)
1150
-//         |           |    /  \      /  \      /  \    |
1151
-//       A |           |   /    \    /    \    /    \   |
1152
-//         |           |  /      \  /      \  /      \  |
1153
-//         |  (X0, Y0) | /        \/        \/        \ | (X1, Y0)
1154
-//          --         +--------------------------------+
1155
-//                       |________|_________|_________|
1156
-//                           T1        T2        T3
1157
-//
1158
-//   P2: This starts a circular pattern with circle with middle in
1159
-//       NOZZLE_CLEAN_CIRCLE_MIDDLE radius of R and stroke count of S.
1160
-//       Before starting the circle nozzle goes to NOZZLE_CLEAN_START_POINT.
1161
-//
1162
-// Caveats: End point Z should use the same value as Start point Z.
1163
-//
1164
-// Attention: This is an EXPERIMENTAL feature, in the future the G-code arguments
1165
-// may change to add new functionality like different wipe patterns.
1166
-//
1123
+/**
1124
+ * Clean Nozzle Feature -- EXPERIMENTAL
1125
+ *
1126
+ * Adds the G12 command to perform a nozzle cleaning process.
1127
+ *
1128
+ * Parameters:
1129
+ *   P  Pattern
1130
+ *   S  Strokes / Repetitions
1131
+ *   T  Triangles (P1 only)
1132
+ *
1133
+ * Patterns:
1134
+ *   P0  Straight line (default). This process requires a sponge type material
1135
+ *       at a fixed bed location. "S" specifies strokes (i.e. back-forth motions)
1136
+ *       between the start / end points.
1137
+ *
1138
+ *   P1  Zig-zag pattern between (X0, Y0) and (X1, Y1), "T" specifies the
1139
+ *       number of zig-zag triangles to do. "S" defines the number of strokes.
1140
+ *       Zig-zags are done in whichever is the narrower dimension.
1141
+ *       For example, "G12 P1 S1 T3" will execute:
1142
+ *
1143
+ *          --
1144
+ *         |  (X0, Y1) |     /\        /\        /\     | (X1, Y1)
1145
+ *         |           |    /  \      /  \      /  \    |
1146
+ *       A |           |   /    \    /    \    /    \   |
1147
+ *         |           |  /      \  /      \  /      \  |
1148
+ *         |  (X0, Y0) | /        \/        \/        \ | (X1, Y0)
1149
+ *          --         +--------------------------------+
1150
+ *                       |________|_________|_________|
1151
+ *                           T1        T2        T3
1152
+ *
1153
+ *   P2  Circular pattern with middle at NOZZLE_CLEAN_CIRCLE_MIDDLE.
1154
+ *       "R" specifies the radius. "S" specifies the stroke count.
1155
+ *       Before starting, the nozzle moves to NOZZLE_CLEAN_START_POINT.
1156
+ *
1157
+ *   Caveats: The ending Z should be the same as starting Z.
1158
+ * Attention: EXPERIMENTAL. G-code arguments may change.
1159
+ *
1160
+ */
1167 1161
 //#define NOZZLE_CLEAN_FEATURE
1168 1162
 
1169 1163
 #if ENABLED(NOZZLE_CLEAN_FEATURE)
@@ -1188,33 +1182,35 @@
1188 1182
   #define NOZZLE_CLEAN_GOBACK
1189 1183
 #endif
1190 1184
 
1191
-//
1192
-// Print job timer
1193
-//
1194
-// Enable this option to automatically start and stop the
1195
-// print job timer when M104/M109/M190 commands are received.
1196
-// M104 (extruder without wait) - high temp = none, low temp = stop timer
1197
-// M109 (extruder with wait) - high temp = start timer, low temp = stop timer
1198
-// M190 (bed with wait) - high temp = start timer, low temp = none
1199
-//
1200
-// In all cases the timer can be started and stopped using
1201
-// the following commands:
1202
-//
1203
-// - M75  - Start the print job timer
1204
-// - M76  - Pause the print job timer
1205
-// - M77  - Stop the print job timer
1185
+/**
1186
+ * Print Job Timer
1187
+ *
1188
+ * Automatically start and stop the print job timer on M104/M109/M190.
1189
+ *
1190
+ *   M104 (hotend, no wait) - high temp = none,        low temp = stop timer
1191
+ *   M109 (hotend, wait)    - high temp = start timer, low temp = stop timer
1192
+ *   M190 (bed, wait)       - high temp = start timer, low temp = none
1193
+ *
1194
+ * The timer can also be controlled with the following commands:
1195
+ *
1196
+ *   M75 - Start the print job timer
1197
+ *   M76 - Pause the print job timer
1198
+ *   M77 - Stop the print job timer
1199
+ */
1206 1200
 #define PRINTJOB_TIMER_AUTOSTART
1207 1201
 
1208
-//
1209
-// Print Counter
1210
-//
1211
-// When enabled Marlin will keep track of some print statistical data such as:
1212
-//  - Total print jobs
1213
-//  - Total successful print jobs
1214
-//  - Total failed print jobs
1215
-//  - Total time printing
1216
-//
1217
-// This information can be viewed by the M78 command.
1202
+/**
1203
+ * Print Counter
1204
+ *
1205
+ * Track statistical data such as:
1206
+ *
1207
+ *  - Total print jobs
1208
+ *  - Total successful print jobs
1209
+ *  - Total failed print jobs
1210
+ *  - Total time printing
1211
+ *
1212
+ * View the current statistics with M78.
1213
+ */
1218 1214
 //#define PRINTCOUNTER
1219 1215
 
1220 1216
 //=============================================================================
@@ -1223,78 +1219,79 @@
1223 1219
 
1224 1220
 // @section lcd
1225 1221
 
1226
-//
1227
-// LCD LANGUAGE
1228
-//
1229
-// Here you may choose the language used by Marlin on the LCD menus, the following
1230
-// list of languages are available:
1231
-//    en, an, bg, ca, cn, cz, de, el, el-gr, es, eu, fi, fr, gl, hr, it,
1232
-//    kana, kana_utf8, nl, pl, pt, pt_utf8, pt-br, pt-br_utf8, ru, tr, uk, test
1233
-//
1234
-// :{ 'en':'English', 'an':'Aragonese', 'bg':'Bulgarian', 'ca':'Catalan', 'cn':'Chinese', 'cz':'Czech', 'de':'German', 'el':'Greek', 'el-gr':'Greek (Greece)', 'es':'Spanish', 'eu':'Basque-Euskera', 'fi':'Finnish', 'fr':'French', 'gl':'Galician', 'hr':'Croatian', 'it':'Italian', 'kana':'Japanese', 'kana_utf8':'Japanese (UTF8)', 'nl':'Dutch', 'pl':'Polish', 'pt':'Portuguese', 'pt-br':'Portuguese (Brazilian)', 'pt-br_utf8':'Portuguese (Brazilian UTF8)', 'pt_utf8':'Portuguese (UTF8)', 'ru':'Russian', 'tr':'Turkish', 'uk':'Ukrainian', 'test':'TEST' }
1235
-//
1222
+/**
1223
+ * LCD LANGUAGE
1224
+ *
1225
+ * Select the language to display on the LCD. These languages are available:
1226
+ *
1227
+ *    en, an, bg, ca, cn, cz, de, el, el-gr, es, eu, fi, fr, gl, hr, it,
1228
+ *    kana, kana_utf8, nl, pl, pt, pt_utf8, pt-br, pt-br_utf8, ru, tr, uk, test
1229
+ *
1230
+ * :{ 'en':'English', 'an':'Aragonese', 'bg':'Bulgarian', 'ca':'Catalan', 'cn':'Chinese', 'cz':'Czech', 'de':'German', 'el':'Greek', 'el-gr':'Greek (Greece)', 'es':'Spanish', 'eu':'Basque-Euskera', 'fi':'Finnish', 'fr':'French', 'gl':'Galician', 'hr':'Croatian', 'it':'Italian', 'kana':'Japanese', 'kana_utf8':'Japanese (UTF8)', 'nl':'Dutch', 'pl':'Polish', 'pt':'Portuguese', 'pt-br':'Portuguese (Brazilian)', 'pt-br_utf8':'Portuguese (Brazilian UTF8)', 'pt_utf8':'Portuguese (UTF8)', 'ru':'Russian', 'tr':'Turkish', 'uk':'Ukrainian', 'test':'TEST' }
1231
+ */
1236 1232
 #define LCD_LANGUAGE en
1237 1233
 
1238
-//
1239
-// LCD Character Set
1240
-//
1241
-// Note: This option is NOT applicable to Graphical Displays.
1242
-//
1243
-// All character-based LCD's provide ASCII plus one of these
1244
-// language extensions:
1245
-//
1246
-//  - JAPANESE ... the most common
1247
-//  - WESTERN  ... with more accented characters
1248
-//  - CYRILLIC ... for the Russian language
1249
-//
1250
-// To determine the language extension installed on your controller:
1251
-//
1252
-//  - Compile and upload with LCD_LANGUAGE set to 'test'
1253
-//  - Click the controller to view the LCD menu
1254
-//  - The LCD will display Japanese, Western, or Cyrillic text
1255
-//
1256
-// See https://github.com/MarlinFirmware/Marlin/wiki/LCD-Language
1257
-//
1258
-// :['JAPANESE', 'WESTERN', 'CYRILLIC']
1259
-//
1234
+/**
1235
+ * LCD Character Set
1236
+ *
1237
+ * Note: This option is NOT applicable to Graphical Displays.
1238
+ *
1239
+ * All character-based LCDs provide ASCII plus one of these
1240
+ * language extensions:
1241
+ *
1242
+ *  - JAPANESE ... the most common
1243
+ *  - WESTERN  ... with more accented characters
1244
+ *  - CYRILLIC ... for the Russian language
1245
+ *
1246
+ * To determine the language extension installed on your controller:
1247
+ *
1248
+ *  - Compile and upload with LCD_LANGUAGE set to 'test'
1249
+ *  - Click the controller to view the LCD menu
1250
+ *  - The LCD will display Japanese, Western, or Cyrillic text
1251
+ *
1252
+ * See https: *github.com/MarlinFirmware/Marlin/wiki/LCD-Language
1253
+ *
1254
+ * :['JAPANESE', 'WESTERN', 'CYRILLIC']
1255
+ */
1260 1256
 #define DISPLAY_CHARSET_HD44780 JAPANESE
1261 1257
 
1262
-//
1263
-// LCD TYPE
1264
-//
1265
-// You may choose ULTRA_LCD if you have character based LCD with 16x2, 16x4, 20x2,
1266
-// 20x4 char/lines or DOGLCD for the full graphics display with 128x64 pixels
1267
-// (ST7565R family). (This option will be set automatically for certain displays.)
1268
-//
1269
-// IMPORTANT NOTE: The U8glib library is required for Full Graphic Display!
1270
-//                 https://github.com/olikraus/U8glib_Arduino
1271
-//
1258
+/**
1259
+ * LCD TYPE
1260
+ *
1261
+ * Enable ULTRA_LCD for a 16x2, 16x4, 20x2, or 20x4 character-based LCD.
1262
+ * Enable DOGLCD for a 128x64 (ST7565R) Full Graphical Display.
1263
+ * (These options will be enabled automatically for most displays.)
1264
+ *
1265
+ * IMPORTANT: The U8glib library is required for Full Graphic Display!
1266
+ *            https://github.com/olikraus/U8glib_Arduino
1267
+ */
1272 1268
 //#define ULTRA_LCD   // Character based
1273 1269
 //#define DOGLCD      // Full graphics display
1274 1270
 
1275
-//
1276
-// SD CARD
1277
-//
1278
-// SD Card support is disabled by default. If your controller has an SD slot,
1279
-// you must uncomment the following option or it won't work.
1280
-//
1271
+/**
1272
+ * SD CARD
1273
+ *
1274
+ * SD Card support is disabled by default. If your controller has an SD slot,
1275
+ * you must uncomment the following option or it won't work.
1276
+ *
1277
+ */
1281 1278
 #define SDSUPPORT
1282 1279
 
1283
-//
1284
-// SD CARD: SPI SPEED
1285
-//
1286
-// Uncomment ONE of the following items to use a slower SPI transfer
1287
-// speed. This is usually required if you're getting volume init errors.
1288
-//
1280
+/**
1281
+ * SD CARD: SPI SPEED
1282
+ *
1283
+ * Enable one of the following items for a slower SPI transfer speed.
1284
+ * This may be required to resolve "volume init" errors.
1285
+ */
1289 1286
 //#define SPI_SPEED SPI_HALF_SPEED
1290 1287
 //#define SPI_SPEED SPI_QUARTER_SPEED
1291 1288
 //#define SPI_SPEED SPI_EIGHTH_SPEED
1292 1289
 
1293
-//
1294
-// SD CARD: ENABLE CRC
1295
-//
1296
-// Use CRC checks and retries on the SD communication.
1297
-//
1290
+/**
1291
+ * SD CARD: ENABLE CRC
1292
+ *
1293
+ * Use CRC checks and retries on the SD communication.
1294
+ */
1298 1295
 //#define SD_CHECK_AND_RETRY
1299 1296
 
1300 1297
 //
@@ -1322,7 +1319,7 @@
1322 1319
  */
1323 1320
 
1324 1321
 //
1325
-// This option reverses the encoder direction everywhere
1322
+// This option reverses the encoder direction everywhere.
1326 1323
 //
1327 1324
 //  Set this option if CLOCKWISE causes values to DECREASE
1328 1325
 //

+ 137
- 140
Marlin/example_configurations/delta/kossel_xl/Configuration.h View File

@@ -1160,23 +1160,17 @@
1160 1160
 #define PREHEAT_2_TEMP_BED    100
1161 1161
 #define PREHEAT_2_FAN_SPEED   255 // Value from 0 to 255
1162 1162
 
1163
-//
1164
-// Nozzle Park -- EXPERIMENTAL
1165
-//
1166
-// When enabled allows the user to define a special XYZ position, inside the
1167
-// machine's topology, to park the nozzle when idle or when receiving the G27
1168
-// command.
1169
-//
1170
-// The "P" paramenter controls what is the action applied to the Z axis:
1171
-//    P0: (Default) If current Z-pos is lower than Z-park then the nozzle will
1172
-//        be raised to reach Z-park height.
1173
-//
1174
-//    P1: No matter the current Z-pos, the nozzle will be raised/lowered to
1175
-//        reach Z-park height.
1176
-//
1177
-//    P2: The nozzle height will be raised by Z-park amount but never going over
1178
-//        the machine's limit of Z_MAX_POS.
1179
-//
1163
+/**
1164
+ * Nozzle Park -- EXPERIMENTAL
1165
+ *
1166
+ * Park the nozzle at the given XYZ position on idle or G27.
1167
+ *
1168
+ * The "P" parameter controls the action applied to the Z axis:
1169
+ *
1170
+ *    P0  (Default) If Z is below park Z raise the nozzle.
1171
+ *    P1  Raise the nozzle always to Z-park height.
1172
+ *    P2  Raise the nozzle by Z-park amount, limited to Z_MAX_POS.
1173
+ */
1180 1174
 //#define NOZZLE_PARK_FEATURE
1181 1175
 
1182 1176
 #if ENABLED(NOZZLE_PARK_FEATURE)
@@ -1184,44 +1178,44 @@
1184 1178
   #define NOZZLE_PARK_POINT { (X_MIN_POS + 10), (Y_MAX_POS - 10), 20 }
1185 1179
 #endif
1186 1180
 
1187
-//
1188
-// Clean Nozzle Feature -- EXPERIMENTAL
1189
-//
1190
-// When enabled allows the user to send G12 to start the nozzle cleaning
1191
-// process, the G-Code accepts two parameters:
1192
-//   "P" for pattern selection
1193
-//   "S" for defining the number of strokes/repetitions
1194
-//
1195
-// Available list of patterns:
1196
-//   P0: This is the default pattern, this process requires a sponge type
1197
-//       material at a fixed bed location. S defines "strokes" i.e.
1198
-//       back-and-forth movements between the starting and end points.
1199
-//
1200
-//   P1: This starts a zig-zag pattern between (X0, Y0) and (X1, Y1), "T"
1201
-//       defines the number of zig-zag triangles to be done. "S" defines the
1202
-//       number of strokes aka one back-and-forth movement. Zig-zags will
1203
-//       be performed in whichever dimension is smallest. As an example,
1204
-//       sending "G12 P1 S1 T3" will execute:
1205
-//
1206
-//          --
1207
-//         |  (X0, Y1) |     /\        /\        /\     | (X1, Y1)
1208
-//         |           |    /  \      /  \      /  \    |
1209
-//       A |           |   /    \    /    \    /    \   |
1210
-//         |           |  /      \  /      \  /      \  |
1211
-//         |  (X0, Y0) | /        \/        \/        \ | (X1, Y0)
1212
-//          --         +--------------------------------+
1213
-//                       |________|_________|_________|
1214
-//                           T1        T2        T3
1215
-//
1216
-//   P2: This starts a circular pattern with circle with middle in
1217
-//       NOZZLE_CLEAN_CIRCLE_MIDDLE radius of R and stroke count of S.
1218
-//       Before starting the circle nozzle goes to NOZZLE_CLEAN_START_POINT.
1219
-//
1220
-// Caveats: End point Z should use the same value as Start point Z.
1221
-//
1222
-// Attention: This is an EXPERIMENTAL feature, in the future the G-code arguments
1223
-// may change to add new functionality like different wipe patterns.
1224
-//
1181
+/**
1182
+ * Clean Nozzle Feature -- EXPERIMENTAL
1183
+ *
1184
+ * Adds the G12 command to perform a nozzle cleaning process.
1185
+ *
1186
+ * Parameters:
1187
+ *   P  Pattern
1188
+ *   S  Strokes / Repetitions
1189
+ *   T  Triangles (P1 only)
1190
+ *
1191
+ * Patterns:
1192
+ *   P0  Straight line (default). This process requires a sponge type material
1193
+ *       at a fixed bed location. "S" specifies strokes (i.e. back-forth motions)
1194
+ *       between the start / end points.
1195
+ *
1196
+ *   P1  Zig-zag pattern between (X0, Y0) and (X1, Y1), "T" specifies the
1197
+ *       number of zig-zag triangles to do. "S" defines the number of strokes.
1198
+ *       Zig-zags are done in whichever is the narrower dimension.
1199
+ *       For example, "G12 P1 S1 T3" will execute:
1200
+ *
1201
+ *          --
1202
+ *         |  (X0, Y1) |     /\        /\        /\     | (X1, Y1)
1203
+ *         |           |    /  \      /  \      /  \    |
1204
+ *       A |           |   /    \    /    \    /    \   |
1205
+ *         |           |  /      \  /      \  /      \  |
1206
+ *         |  (X0, Y0) | /        \/        \/        \ | (X1, Y0)
1207
+ *          --         +--------------------------------+
1208
+ *                       |________|_________|_________|
1209
+ *                           T1        T2        T3
1210
+ *
1211
+ *   P2  Circular pattern with middle at NOZZLE_CLEAN_CIRCLE_MIDDLE.
1212
+ *       "R" specifies the radius. "S" specifies the stroke count.
1213
+ *       Before starting, the nozzle moves to NOZZLE_CLEAN_START_POINT.
1214
+ *
1215
+ *   Caveats: The ending Z should be the same as starting Z.
1216
+ * Attention: EXPERIMENTAL. G-code arguments may change.
1217
+ *
1218
+ */
1225 1219
 //#define NOZZLE_CLEAN_FEATURE
1226 1220
 
1227 1221
 #if ENABLED(NOZZLE_CLEAN_FEATURE)
@@ -1246,33 +1240,35 @@
1246 1240
   #define NOZZLE_CLEAN_GOBACK
1247 1241
 #endif
1248 1242
 
1249
-//
1250
-// Print job timer
1251
-//
1252
-// Enable this option to automatically start and stop the
1253
-// print job timer when M104/M109/M190 commands are received.
1254
-// M104 (extruder without wait) - high temp = none, low temp = stop timer
1255
-// M109 (extruder with wait) - high temp = start timer, low temp = stop timer
1256
-// M190 (bed with wait) - high temp = start timer, low temp = none
1257
-//
1258
-// In all cases the timer can be started and stopped using
1259
-// the following commands:
1260
-//
1261
-// - M75  - Start the print job timer
1262
-// - M76  - Pause the print job timer
1263
-// - M77  - Stop the print job timer
1243
+/**
1244
+ * Print Job Timer
1245
+ *
1246
+ * Automatically start and stop the print job timer on M104/M109/M190.
1247
+ *
1248
+ *   M104 (hotend, no wait) - high temp = none,        low temp = stop timer
1249
+ *   M109 (hotend, wait)    - high temp = start timer, low temp = stop timer
1250
+ *   M190 (bed, wait)       - high temp = start timer, low temp = none
1251
+ *
1252
+ * The timer can also be controlled with the following commands:
1253
+ *
1254
+ *   M75 - Start the print job timer
1255
+ *   M76 - Pause the print job timer
1256
+ *   M77 - Stop the print job timer
1257
+ */
1264 1258
 #define PRINTJOB_TIMER_AUTOSTART
1265 1259
 
1266
-//
1267
-// Print Counter
1268
-//
1269
-// When enabled Marlin will keep track of some print statistical data such as:
1270
-//  - Total print jobs
1271
-//  - Total successful print jobs
1272
-//  - Total failed print jobs
1273
-//  - Total time printing
1274
-//
1275
-// This information can be viewed by the M78 command.
1260
+/**
1261
+ * Print Counter
1262
+ *
1263
+ * Track statistical data such as:
1264
+ *
1265
+ *  - Total print jobs
1266
+ *  - Total successful print jobs
1267
+ *  - Total failed print jobs
1268
+ *  - Total time printing
1269
+ *
1270
+ * View the current statistics with M78.
1271
+ */
1276 1272
 //#define PRINTCOUNTER
1277 1273
 
1278 1274
 //=============================================================================
@@ -1281,78 +1277,79 @@
1281 1277
 
1282 1278
 // @section lcd
1283 1279
 
1284
-//
1285
-// LCD LANGUAGE
1286
-//
1287
-// Here you may choose the language used by Marlin on the LCD menus, the following
1288
-// list of languages are available:
1289
-//    en, an, bg, ca, cn, cz, de, el, el-gr, es, eu, fi, fr, gl, hr, it,
1290
-//    kana, kana_utf8, nl, pl, pt, pt_utf8, pt-br, pt-br_utf8, ru, tr, uk, test
1291
-//
1292
-// :{ 'en':'English', 'an':'Aragonese', 'bg':'Bulgarian', 'ca':'Catalan', 'cn':'Chinese', 'cz':'Czech', 'de':'German', 'el':'Greek', 'el-gr':'Greek (Greece)', 'es':'Spanish', 'eu':'Basque-Euskera', 'fi':'Finnish', 'fr':'French', 'gl':'Galician', 'hr':'Croatian', 'it':'Italian', 'kana':'Japanese', 'kana_utf8':'Japanese (UTF8)', 'nl':'Dutch', 'pl':'Polish', 'pt':'Portuguese', 'pt-br':'Portuguese (Brazilian)', 'pt-br_utf8':'Portuguese (Brazilian UTF8)', 'pt_utf8':'Portuguese (UTF8)', 'ru':'Russian', 'tr':'Turkish', 'uk':'Ukrainian', 'test':'TEST' }
1293
-//
1280
+/**
1281
+ * LCD LANGUAGE
1282
+ *
1283
+ * Select the language to display on the LCD. These languages are available:
1284
+ *
1285
+ *    en, an, bg, ca, cn, cz, de, el, el-gr, es, eu, fi, fr, gl, hr, it,
1286
+ *    kana, kana_utf8, nl, pl, pt, pt_utf8, pt-br, pt-br_utf8, ru, tr, uk, test
1287
+ *
1288
+ * :{ 'en':'English', 'an':'Aragonese', 'bg':'Bulgarian', 'ca':'Catalan', 'cn':'Chinese', 'cz':'Czech', 'de':'German', 'el':'Greek', 'el-gr':'Greek (Greece)', 'es':'Spanish', 'eu':'Basque-Euskera', 'fi':'Finnish', 'fr':'French', 'gl':'Galician', 'hr':'Croatian', 'it':'Italian', 'kana':'Japanese', 'kana_utf8':'Japanese (UTF8)', 'nl':'Dutch', 'pl':'Polish', 'pt':'Portuguese', 'pt-br':'Portuguese (Brazilian)', 'pt-br_utf8':'Portuguese (Brazilian UTF8)', 'pt_utf8':'Portuguese (UTF8)', 'ru':'Russian', 'tr':'Turkish', 'uk':'Ukrainian', 'test':'TEST' }
1289
+ */
1294 1290
 #define LCD_LANGUAGE en
1295 1291
 
1296
-//
1297
-// LCD Character Set
1298
-//
1299
-// Note: This option is NOT applicable to Graphical Displays.
1300
-//
1301
-// All character-based LCD's provide ASCII plus one of these
1302
-// language extensions:
1303
-//
1304
-//  - JAPANESE ... the most common
1305
-//  - WESTERN  ... with more accented characters
1306
-//  - CYRILLIC ... for the Russian language
1307
-//
1308
-// To determine the language extension installed on your controller:
1309
-//
1310
-//  - Compile and upload with LCD_LANGUAGE set to 'test'
1311
-//  - Click the controller to view the LCD menu
1312
-//  - The LCD will display Japanese, Western, or Cyrillic text
1313
-//
1314
-// See https://github.com/MarlinFirmware/Marlin/wiki/LCD-Language
1315
-//
1316
-// :['JAPANESE', 'WESTERN', 'CYRILLIC']
1317
-//
1292
+/**
1293
+ * LCD Character Set
1294
+ *
1295
+ * Note: This option is NOT applicable to Graphical Displays.
1296
+ *
1297
+ * All character-based LCDs provide ASCII plus one of these
1298
+ * language extensions:
1299
+ *
1300
+ *  - JAPANESE ... the most common
1301
+ *  - WESTERN  ... with more accented characters
1302
+ *  - CYRILLIC ... for the Russian language
1303
+ *
1304
+ * To determine the language extension installed on your controller:
1305
+ *
1306
+ *  - Compile and upload with LCD_LANGUAGE set to 'test'
1307
+ *  - Click the controller to view the LCD menu
1308
+ *  - The LCD will display Japanese, Western, or Cyrillic text
1309
+ *
1310
+ * See https: *github.com/MarlinFirmware/Marlin/wiki/LCD-Language
1311
+ *
1312
+ * :['JAPANESE', 'WESTERN', 'CYRILLIC']
1313
+ */
1318 1314
 #define DISPLAY_CHARSET_HD44780 JAPANESE
1319 1315
 
1320
-//
1321
-// LCD TYPE
1322
-//
1323
-// You may choose ULTRA_LCD if you have character based LCD with 16x2, 16x4, 20x2,
1324
-// 20x4 char/lines or DOGLCD for the full graphics display with 128x64 pixels
1325
-// (ST7565R family). (This option will be set automatically for certain displays.)
1326
-//
1327
-// IMPORTANT NOTE: The U8glib library is required for Full Graphic Display!
1328
-//                 https://github.com/olikraus/U8glib_Arduino
1329
-//
1316
+/**
1317
+ * LCD TYPE
1318
+ *
1319
+ * Enable ULTRA_LCD for a 16x2, 16x4, 20x2, or 20x4 character-based LCD.
1320
+ * Enable DOGLCD for a 128x64 (ST7565R) Full Graphical Display.
1321
+ * (These options will be enabled automatically for most displays.)
1322
+ *
1323
+ * IMPORTANT: The U8glib library is required for Full Graphic Display!
1324
+ *            https://github.com/olikraus/U8glib_Arduino
1325
+ */
1330 1326
 //#define ULTRA_LCD   // Character based
1331 1327
 //#define DOGLCD      // Full graphics display
1332 1328
 
1333
-//
1334
-// SD CARD
1335
-//
1336
-// SD Card support is disabled by default. If your controller has an SD slot,
1337
-// you must uncomment the following option or it won't work.
1338
-//
1329
+/**
1330
+ * SD CARD
1331
+ *
1332
+ * SD Card support is disabled by default. If your controller has an SD slot,
1333
+ * you must uncomment the following option or it won't work.
1334
+ *
1335
+ */
1339 1336
 //#define SDSUPPORT
1340 1337
 
1341
-//
1342
-// SD CARD: SPI SPEED
1343
-//
1344
-// Uncomment ONE of the following items to use a slower SPI transfer
1345
-// speed. This is usually required if you're getting volume init errors.
1346
-//
1338
+/**
1339
+ * SD CARD: SPI SPEED
1340
+ *
1341
+ * Enable one of the following items for a slower SPI transfer speed.
1342
+ * This may be required to resolve "volume init" errors.
1343
+ */
1347 1344
 //#define SPI_SPEED SPI_HALF_SPEED
1348 1345
 //#define SPI_SPEED SPI_QUARTER_SPEED
1349 1346
 //#define SPI_SPEED SPI_EIGHTH_SPEED
1350 1347
 
1351
-//
1352
-// SD CARD: ENABLE CRC
1353
-//
1354
-// Use CRC checks and retries on the SD communication.
1355
-//
1348
+/**
1349
+ * SD CARD: ENABLE CRC
1350
+ *
1351
+ * Use CRC checks and retries on the SD communication.
1352
+ */
1356 1353
 //#define SD_CHECK_AND_RETRY
1357 1354
 
1358 1355
 //
@@ -1380,7 +1377,7 @@
1380 1377
  */
1381 1378
 
1382 1379
 //
1383
-// This option reverses the encoder direction everywhere
1380
+// This option reverses the encoder direction everywhere.
1384 1381
 //
1385 1382
 //  Set this option if CLOCKWISE causes values to DECREASE
1386 1383
 //

+ 137
- 140
Marlin/example_configurations/gCreate_gMax1.5+/Configuration.h View File

@@ -971,23 +971,17 @@
971 971
 #define PREHEAT_2_TEMP_BED    110
972 972
 #define PREHEAT_2_FAN_SPEED     0 // Value from 0 to 255
973 973
 
974
-//
975
-// Nozzle Park -- EXPERIMENTAL
976
-//
977
-// When enabled allows the user to define a special XYZ position, inside the
978
-// machine's topology, to park the nozzle when idle or when receiving the G27
979
-// command.
980
-//
981
-// The "P" paramenter controls what is the action applied to the Z axis:
982
-//    P0: (Default) If current Z-pos is lower than Z-park then the nozzle will
983
-//        be raised to reach Z-park height.
984
-//
985
-//    P1: No matter the current Z-pos, the nozzle will be raised/lowered to
986
-//        reach Z-park height.
987
-//
988
-//    P2: The nozzle height will be raised by Z-park amount but never going over
989
-//        the machine's limit of Z_MAX_POS.
990
-//
974
+/**
975
+ * Nozzle Park -- EXPERIMENTAL
976
+ *
977
+ * Park the nozzle at the given XYZ position on idle or G27.
978
+ *
979
+ * The "P" parameter controls the action applied to the Z axis:
980
+ *
981
+ *    P0  (Default) If Z is below park Z raise the nozzle.
982
+ *    P1  Raise the nozzle always to Z-park height.
983
+ *    P2  Raise the nozzle by Z-park amount, limited to Z_MAX_POS.
984
+ */
991 985
 //#define NOZZLE_PARK_FEATURE
992 986
 
993 987
 #if ENABLED(NOZZLE_PARK_FEATURE)
@@ -995,44 +989,44 @@
995 989
   #define NOZZLE_PARK_POINT { (X_MIN_POS + 10), (Y_MAX_POS - 10), 20 }
996 990
 #endif
997 991
 
998
-//
999
-// Clean Nozzle Feature -- EXPERIMENTAL
1000
-//
1001
-// When enabled allows the user to send G12 to start the nozzle cleaning
1002
-// process, the G-Code accepts two parameters:
1003
-//   "P" for pattern selection
1004
-//   "S" for defining the number of strokes/repetitions
1005
-//
1006
-// Available list of patterns:
1007
-//   P0: This is the default pattern, this process requires a sponge type
1008
-//       material at a fixed bed location. S defines "strokes" i.e.
1009
-//       back-and-forth movements between the starting and end points.
1010
-//
1011
-//   P1: This starts a zig-zag pattern between (X0, Y0) and (X1, Y1), "T"
1012
-//       defines the number of zig-zag triangles to be done. "S" defines the
1013
-//       number of strokes aka one back-and-forth movement. Zig-zags will
1014
-//       be performed in whichever dimension is smallest. As an example,
1015
-//       sending "G12 P1 S1 T3" will execute:
1016
-//
1017
-//          --
1018
-//         |  (X0, Y1) |     /\        /\        /\     | (X1, Y1)
1019
-//         |           |    /  \      /  \      /  \    |
1020
-//       A |           |   /    \    /    \    /    \   |
1021
-//         |           |  /      \  /      \  /      \  |
1022
-//         |  (X0, Y0) | /        \/        \/        \ | (X1, Y0)
1023
-//          --         +--------------------------------+
1024
-//                       |________|_________|_________|
1025
-//                           T1        T2        T3
1026
-//
1027
-//   P2: This starts a circular pattern with circle with middle in
1028
-//       NOZZLE_CLEAN_CIRCLE_MIDDLE radius of R and stroke count of S.
1029
-//       Before starting the circle nozzle goes to NOZZLE_CLEAN_START_POINT.
1030
-//
1031
-// Caveats: End point Z should use the same value as Start point Z.
1032
-//
1033
-// Attention: This is an EXPERIMENTAL feature, in the future the G-code arguments
1034
-// may change to add new functionality like different wipe patterns.
1035
-//
992
+/**
993
+ * Clean Nozzle Feature -- EXPERIMENTAL
994
+ *
995
+ * Adds the G12 command to perform a nozzle cleaning process.
996
+ *
997
+ * Parameters:
998
+ *   P  Pattern
999
+ *   S  Strokes / Repetitions
1000
+ *   T  Triangles (P1 only)
1001
+ *
1002
+ * Patterns:
1003
+ *   P0  Straight line (default). This process requires a sponge type material
1004
+ *       at a fixed bed location. "S" specifies strokes (i.e. back-forth motions)
1005
+ *       between the start / end points.
1006
+ *
1007
+ *   P1  Zig-zag pattern between (X0, Y0) and (X1, Y1), "T" specifies the
1008
+ *       number of zig-zag triangles to do. "S" defines the number of strokes.
1009
+ *       Zig-zags are done in whichever is the narrower dimension.
1010
+ *       For example, "G12 P1 S1 T3" will execute:
1011
+ *
1012
+ *          --
1013
+ *         |  (X0, Y1) |     /\        /\        /\     | (X1, Y1)
1014
+ *         |           |    /  \      /  \      /  \    |
1015
+ *       A |           |   /    \    /    \    /    \   |
1016
+ *         |           |  /      \  /      \  /      \  |
1017
+ *         |  (X0, Y0) | /        \/        \/        \ | (X1, Y0)
1018
+ *          --         +--------------------------------+
1019
+ *                       |________|_________|_________|
1020
+ *                           T1        T2        T3
1021
+ *
1022
+ *   P2  Circular pattern with middle at NOZZLE_CLEAN_CIRCLE_MIDDLE.
1023
+ *       "R" specifies the radius. "S" specifies the stroke count.
1024
+ *       Before starting, the nozzle moves to NOZZLE_CLEAN_START_POINT.
1025
+ *
1026
+ *   Caveats: The ending Z should be the same as starting Z.
1027
+ * Attention: EXPERIMENTAL. G-code arguments may change.
1028
+ *
1029
+ */
1036 1030
 //#define NOZZLE_CLEAN_FEATURE
1037 1031
 
1038 1032
 #if ENABLED(NOZZLE_CLEAN_FEATURE)
@@ -1057,33 +1051,35 @@
1057 1051
   #define NOZZLE_CLEAN_GOBACK
1058 1052
 #endif
1059 1053
 
1060
-//
1061
-// Print job timer
1062
-//
1063
-// Enable this option to automatically start and stop the
1064
-// print job timer when M104/M109/M190 commands are received.
1065
-// M104 (extruder without wait) - high temp = none, low temp = stop timer
1066
-// M109 (extruder with wait) - high temp = start timer, low temp = stop timer
1067
-// M190 (bed with wait) - high temp = start timer, low temp = none
1068
-//
1069
-// In all cases the timer can be started and stopped using
1070
-// the following commands:
1071
-//
1072
-// - M75  - Start the print job timer
1073
-// - M76  - Pause the print job timer
1074
-// - M77  - Stop the print job timer
1054
+/**
1055
+ * Print Job Timer
1056
+ *
1057
+ * Automatically start and stop the print job timer on M104/M109/M190.
1058
+ *
1059
+ *   M104 (hotend, no wait) - high temp = none,        low temp = stop timer
1060
+ *   M109 (hotend, wait)    - high temp = start timer, low temp = stop timer
1061
+ *   M190 (bed, wait)       - high temp = start timer, low temp = none
1062
+ *
1063
+ * The timer can also be controlled with the following commands:
1064
+ *
1065
+ *   M75 - Start the print job timer
1066
+ *   M76 - Pause the print job timer
1067
+ *   M77 - Stop the print job timer
1068
+ */
1075 1069
 #define PRINTJOB_TIMER_AUTOSTART
1076 1070
 
1077
-//
1078
-// Print Counter
1079
-//
1080
-// When enabled Marlin will keep track of some print statistical data such as:
1081
-//  - Total print jobs
1082
-//  - Total successful print jobs
1083
-//  - Total failed print jobs
1084
-//  - Total time printing
1085
-//
1086
-// This information can be viewed by the M78 command.
1071
+/**
1072
+ * Print Counter
1073
+ *
1074
+ * Track statistical data such as:
1075
+ *
1076
+ *  - Total print jobs
1077
+ *  - Total successful print jobs
1078
+ *  - Total failed print jobs
1079
+ *  - Total time printing
1080
+ *
1081
+ * View the current statistics with M78.
1082
+ */
1087 1083
 //#define PRINTCOUNTER
1088 1084
 
1089 1085
 //=============================================================================
@@ -1092,78 +1088,79 @@
1092 1088
 
1093 1089
 // @section lcd
1094 1090
 
1095
-//
1096
-// LCD LANGUAGE
1097
-//
1098
-// Here you may choose the language used by Marlin on the LCD menus, the following
1099
-// list of languages are available:
1100
-//    en, an, bg, ca, cn, cz, de, el, el-gr, es, eu, fi, fr, gl, hr, it,
1101
-//    kana, kana_utf8, nl, pl, pt, pt_utf8, pt-br, pt-br_utf8, ru, tr, uk, test
1102
-//
1103
-// :{ 'en':'English', 'an':'Aragonese', 'bg':'Bulgarian', 'ca':'Catalan', 'cn':'Chinese', 'cz':'Czech', 'de':'German', 'el':'Greek', 'el-gr':'Greek (Greece)', 'es':'Spanish', 'eu':'Basque-Euskera', 'fi':'Finnish', 'fr':'French', 'gl':'Galician', 'hr':'Croatian', 'it':'Italian', 'kana':'Japanese', 'kana_utf8':'Japanese (UTF8)', 'nl':'Dutch', 'pl':'Polish', 'pt':'Portuguese', 'pt-br':'Portuguese (Brazilian)', 'pt-br_utf8':'Portuguese (Brazilian UTF8)', 'pt_utf8':'Portuguese (UTF8)', 'ru':'Russian', 'tr':'Turkish', 'uk':'Ukrainian', 'test':'TEST' }
1104
-//
1091
+/**
1092
+ * LCD LANGUAGE
1093
+ *
1094
+ * Select the language to display on the LCD. These languages are available:
1095
+ *
1096
+ *    en, an, bg, ca, cn, cz, de, el, el-gr, es, eu, fi, fr, gl, hr, it,
1097
+ *    kana, kana_utf8, nl, pl, pt, pt_utf8, pt-br, pt-br_utf8, ru, tr, uk, test
1098
+ *
1099
+ * :{ 'en':'English', 'an':'Aragonese', 'bg':'Bulgarian', 'ca':'Catalan', 'cn':'Chinese', 'cz':'Czech', 'de':'German', 'el':'Greek', 'el-gr':'Greek (Greece)', 'es':'Spanish', 'eu':'Basque-Euskera', 'fi':'Finnish', 'fr':'French', 'gl':'Galician', 'hr':'Croatian', 'it':'Italian', 'kana':'Japanese', 'kana_utf8':'Japanese (UTF8)', 'nl':'Dutch', 'pl':'Polish', 'pt':'Portuguese', 'pt-br':'Portuguese (Brazilian)', 'pt-br_utf8':'Portuguese (Brazilian UTF8)', 'pt_utf8':'Portuguese (UTF8)', 'ru':'Russian', 'tr':'Turkish', 'uk':'Ukrainian', 'test':'TEST' }
1100
+ */
1105 1101
 #define LCD_LANGUAGE en
1106 1102
 
1107
-//
1108
-// LCD Character Set
1109
-//
1110
-// Note: This option is NOT applicable to Graphical Displays.
1111
-//
1112
-// All character-based LCD's provide ASCII plus one of these
1113
-// language extensions:
1114
-//
1115
-//  - JAPANESE ... the most common
1116
-//  - WESTERN  ... with more accented characters
1117
-//  - CYRILLIC ... for the Russian language
1118
-//
1119
-// To determine the language extension installed on your controller:
1120
-//
1121
-//  - Compile and upload with LCD_LANGUAGE set to 'test'
1122
-//  - Click the controller to view the LCD menu
1123
-//  - The LCD will display Japanese, Western, or Cyrillic text
1124
-//
1125
-// See https://github.com/MarlinFirmware/Marlin/wiki/LCD-Language
1126
-//
1127
-// :['JAPANESE', 'WESTERN', 'CYRILLIC']
1128
-//
1103
+/**
1104
+ * LCD Character Set
1105
+ *
1106
+ * Note: This option is NOT applicable to Graphical Displays.
1107
+ *
1108
+ * All character-based LCDs provide ASCII plus one of these
1109
+ * language extensions:
1110
+ *
1111
+ *  - JAPANESE ... the most common
1112
+ *  - WESTERN  ... with more accented characters
1113
+ *  - CYRILLIC ... for the Russian language
1114
+ *
1115
+ * To determine the language extension installed on your controller:
1116
+ *
1117
+ *  - Compile and upload with LCD_LANGUAGE set to 'test'
1118
+ *  - Click the controller to view the LCD menu
1119
+ *  - The LCD will display Japanese, Western, or Cyrillic text
1120
+ *
1121
+ * See https: *github.com/MarlinFirmware/Marlin/wiki/LCD-Language
1122
+ *
1123
+ * :['JAPANESE', 'WESTERN', 'CYRILLIC']
1124
+ */
1129 1125
 #define DISPLAY_CHARSET_HD44780 JAPANESE
1130 1126
 
1131
-//
1132
-// LCD TYPE
1133
-//
1134
-// You may choose ULTRA_LCD if you have character based LCD with 16x2, 16x4, 20x2,
1135
-// 20x4 char/lines or DOGLCD for the full graphics display with 128x64 pixels
1136
-// (ST7565R family). (This option will be set automatically for certain displays.)
1137
-//
1138
-// IMPORTANT NOTE: The U8glib library is required for Full Graphic Display!
1139
-//                 https://github.com/olikraus/U8glib_Arduino
1140
-//
1127
+/**
1128
+ * LCD TYPE
1129
+ *
1130
+ * Enable ULTRA_LCD for a 16x2, 16x4, 20x2, or 20x4 character-based LCD.
1131
+ * Enable DOGLCD for a 128x64 (ST7565R) Full Graphical Display.
1132
+ * (These options will be enabled automatically for most displays.)
1133
+ *
1134
+ * IMPORTANT: The U8glib library is required for Full Graphic Display!
1135
+ *            https://github.com/olikraus/U8glib_Arduino
1136
+ */
1141 1137
 //#define ULTRA_LCD   // Character based
1142 1138
 //#define DOGLCD      // Full graphics display
1143 1139
 
1144
-//
1145
-// SD CARD
1146
-//
1147
-// SD Card support is disabled by default. If your controller has an SD slot,
1148
-// you must uncomment the following option or it won't work.
1149
-//
1140
+/**
1141
+ * SD CARD
1142
+ *
1143
+ * SD Card support is disabled by default. If your controller has an SD slot,
1144
+ * you must uncomment the following option or it won't work.
1145
+ *
1146
+ */
1150 1147
 #define SDSUPPORT
1151 1148
 
1152
-//
1153
-// SD CARD: SPI SPEED
1154
-//
1155
-// Uncomment ONE of the following items to use a slower SPI transfer
1156
-// speed. This is usually required if you're getting volume init errors.
1157
-//
1149
+/**
1150
+ * SD CARD: SPI SPEED
1151
+ *
1152
+ * Enable one of the following items for a slower SPI transfer speed.
1153
+ * This may be required to resolve "volume init" errors.
1154
+ */
1158 1155
 //#define SPI_SPEED SPI_HALF_SPEED
1159 1156
 //#define SPI_SPEED SPI_QUARTER_SPEED
1160 1157
 //#define SPI_SPEED SPI_EIGHTH_SPEED
1161 1158
 
1162
-//
1163
-// SD CARD: ENABLE CRC
1164
-//
1165
-// Use CRC checks and retries on the SD communication.
1166
-//
1159
+/**
1160
+ * SD CARD: ENABLE CRC
1161
+ *
1162
+ * Use CRC checks and retries on the SD communication.
1163
+ */
1167 1164
 #define SD_CHECK_AND_RETRY
1168 1165
 
1169 1166
 //
@@ -1191,7 +1188,7 @@
1191 1188
  */
1192 1189
 
1193 1190
 //
1194
-// This option reverses the encoder direction everywhere
1191
+// This option reverses the encoder direction everywhere.
1195 1192
 //
1196 1193
 //  Set this option if CLOCKWISE causes values to DECREASE
1197 1194
 //

+ 137
- 140
Marlin/example_configurations/makibox/Configuration.h View File

@@ -989,23 +989,17 @@
989 989
 #define PREHEAT_2_TEMP_BED    100
990 990
 #define PREHEAT_2_FAN_SPEED   255 // Value from 0 to 255
991 991
 
992
-//
993
-// Nozzle Park -- EXPERIMENTAL
994
-//
995
-// When enabled allows the user to define a special XYZ position, inside the
996
-// machine's topology, to park the nozzle when idle or when receiving the G27
997
-// command.
998
-//
999
-// The "P" paramenter controls what is the action applied to the Z axis:
1000
-//    P0: (Default) If current Z-pos is lower than Z-park then the nozzle will
1001
-//        be raised to reach Z-park height.
1002
-//
1003
-//    P1: No matter the current Z-pos, the nozzle will be raised/lowered to
1004
-//        reach Z-park height.
1005
-//
1006
-//    P2: The nozzle height will be raised by Z-park amount but never going over
1007
-//        the machine's limit of Z_MAX_POS.
1008
-//
992
+/**
993
+ * Nozzle Park -- EXPERIMENTAL
994
+ *
995
+ * Park the nozzle at the given XYZ position on idle or G27.
996
+ *
997
+ * The "P" parameter controls the action applied to the Z axis:
998
+ *
999
+ *    P0  (Default) If Z is below park Z raise the nozzle.
1000
+ *    P1  Raise the nozzle always to Z-park height.
1001
+ *    P2  Raise the nozzle by Z-park amount, limited to Z_MAX_POS.
1002
+ */
1009 1003
 //#define NOZZLE_PARK_FEATURE
1010 1004
 
1011 1005
 #if ENABLED(NOZZLE_PARK_FEATURE)
@@ -1013,44 +1007,44 @@
1013 1007
   #define NOZZLE_PARK_POINT { (X_MIN_POS + 10), (Y_MAX_POS - 10), 20 }
1014 1008
 #endif
1015 1009
 
1016
-//
1017
-// Clean Nozzle Feature -- EXPERIMENTAL
1018
-//
1019
-// When enabled allows the user to send G12 to start the nozzle cleaning
1020
-// process, the G-Code accepts two parameters:
1021
-//   "P" for pattern selection
1022
-//   "S" for defining the number of strokes/repetitions
1023
-//
1024
-// Available list of patterns:
1025
-//   P0: This is the default pattern, this process requires a sponge type
1026
-//       material at a fixed bed location. S defines "strokes" i.e.
1027
-//       back-and-forth movements between the starting and end points.
1028
-//
1029
-//   P1: This starts a zig-zag pattern between (X0, Y0) and (X1, Y1), "T"
1030
-//       defines the number of zig-zag triangles to be done. "S" defines the
1031
-//       number of strokes aka one back-and-forth movement. Zig-zags will
1032
-//       be performed in whichever dimension is smallest. As an example,
1033
-//       sending "G12 P1 S1 T3" will execute:
1034
-//
1035
-//          --
1036
-//         |  (X0, Y1) |     /\        /\        /\     | (X1, Y1)
1037
-//         |           |    /  \      /  \      /  \    |
1038
-//       A |           |   /    \    /    \    /    \   |
1039
-//         |           |  /      \  /      \  /      \  |
1040
-//         |  (X0, Y0) | /        \/        \/        \ | (X1, Y0)
1041
-//          --         +--------------------------------+
1042
-//                       |________|_________|_________|
1043
-//                           T1        T2        T3
1044
-//
1045
-//   P2: This starts a circular pattern with circle with middle in
1046
-//       NOZZLE_CLEAN_CIRCLE_MIDDLE radius of R and stroke count of S.
1047
-//       Before starting the circle nozzle goes to NOZZLE_CLEAN_START_POINT.
1048
-//
1049
-// Caveats: End point Z should use the same value as Start point Z.
1050
-//
1051
-// Attention: This is an EXPERIMENTAL feature, in the future the G-code arguments
1052
-// may change to add new functionality like different wipe patterns.
1053
-//
1010
+/**
1011
+ * Clean Nozzle Feature -- EXPERIMENTAL
1012
+ *
1013
+ * Adds the G12 command to perform a nozzle cleaning process.
1014
+ *
1015
+ * Parameters:
1016
+ *   P  Pattern
1017
+ *   S  Strokes / Repetitions
1018
+ *   T  Triangles (P1 only)
1019
+ *
1020
+ * Patterns:
1021
+ *   P0  Straight line (default). This process requires a sponge type material
1022
+ *       at a fixed bed location. "S" specifies strokes (i.e. back-forth motions)
1023
+ *       between the start / end points.
1024
+ *
1025
+ *   P1  Zig-zag pattern between (X0, Y0) and (X1, Y1), "T" specifies the
1026
+ *       number of zig-zag triangles to do. "S" defines the number of strokes.
1027
+ *       Zig-zags are done in whichever is the narrower dimension.
1028
+ *       For example, "G12 P1 S1 T3" will execute:
1029
+ *
1030
+ *          --
1031
+ *         |  (X0, Y1) |     /\        /\        /\     | (X1, Y1)
1032
+ *         |           |    /  \      /  \      /  \    |
1033
+ *       A |           |   /    \    /    \    /    \   |
1034
+ *         |           |  /      \  /      \  /      \  |
1035
+ *         |  (X0, Y0) | /        \/        \/        \ | (X1, Y0)
1036
+ *          --         +--------------------------------+
1037
+ *                       |________|_________|_________|
1038
+ *                           T1        T2        T3
1039
+ *
1040
+ *   P2  Circular pattern with middle at NOZZLE_CLEAN_CIRCLE_MIDDLE.
1041
+ *       "R" specifies the radius. "S" specifies the stroke count.
1042
+ *       Before starting, the nozzle moves to NOZZLE_CLEAN_START_POINT.
1043
+ *
1044
+ *   Caveats: The ending Z should be the same as starting Z.
1045
+ * Attention: EXPERIMENTAL. G-code arguments may change.
1046
+ *
1047
+ */
1054 1048
 //#define NOZZLE_CLEAN_FEATURE
1055 1049
 
1056 1050
 #if ENABLED(NOZZLE_CLEAN_FEATURE)
@@ -1075,33 +1069,35 @@
1075 1069
   #define NOZZLE_CLEAN_GOBACK
1076 1070
 #endif
1077 1071
 
1078
-//
1079
-// Print job timer
1080
-//
1081
-// Enable this option to automatically start and stop the
1082
-// print job timer when M104/M109/M190 commands are received.
1083
-// M104 (extruder without wait) - high temp = none, low temp = stop timer
1084
-// M109 (extruder with wait) - high temp = start timer, low temp = stop timer
1085
-// M190 (bed with wait) - high temp = start timer, low temp = none
1086
-//
1087
-// In all cases the timer can be started and stopped using
1088
-// the following commands:
1089
-//
1090
-// - M75  - Start the print job timer
1091
-// - M76  - Pause the print job timer
1092
-// - M77  - Stop the print job timer
1072
+/**
1073
+ * Print Job Timer
1074
+ *
1075
+ * Automatically start and stop the print job timer on M104/M109/M190.
1076
+ *
1077
+ *   M104 (hotend, no wait) - high temp = none,        low temp = stop timer
1078
+ *   M109 (hotend, wait)    - high temp = start timer, low temp = stop timer
1079
+ *   M190 (bed, wait)       - high temp = start timer, low temp = none
1080
+ *
1081
+ * The timer can also be controlled with the following commands:
1082
+ *
1083
+ *   M75 - Start the print job timer
1084
+ *   M76 - Pause the print job timer
1085
+ *   M77 - Stop the print job timer
1086
+ */
1093 1087
 #define PRINTJOB_TIMER_AUTOSTART
1094 1088
 
1095
-//
1096
-// Print Counter
1097
-//
1098
-// When enabled Marlin will keep track of some print statistical data such as:
1099
-//  - Total print jobs
1100
-//  - Total successful print jobs
1101
-//  - Total failed print jobs
1102
-//  - Total time printing
1103
-//
1104
-// This information can be viewed by the M78 command.
1089
+/**
1090
+ * Print Counter
1091
+ *
1092
+ * Track statistical data such as:
1093
+ *
1094
+ *  - Total print jobs
1095
+ *  - Total successful print jobs
1096
+ *  - Total failed print jobs
1097
+ *  - Total time printing
1098
+ *
1099
+ * View the current statistics with M78.
1100
+ */
1105 1101
 //#define PRINTCOUNTER
1106 1102
 
1107 1103
 //=============================================================================
@@ -1110,78 +1106,79 @@
1110 1106
 
1111 1107
 // @section lcd
1112 1108
 
1113
-//
1114
-// LCD LANGUAGE
1115
-//
1116
-// Here you may choose the language used by Marlin on the LCD menus, the following
1117
-// list of languages are available:
1118
-//    en, an, bg, ca, cn, cz, de, el, el-gr, es, eu, fi, fr, gl, hr, it,
1119
-//    kana, kana_utf8, nl, pl, pt, pt_utf8, pt-br, pt-br_utf8, ru, tr, uk, test
1120
-//
1121
-// :{ 'en':'English', 'an':'Aragonese', 'bg':'Bulgarian', 'ca':'Catalan', 'cn':'Chinese', 'cz':'Czech', 'de':'German', 'el':'Greek', 'el-gr':'Greek (Greece)', 'es':'Spanish', 'eu':'Basque-Euskera', 'fi':'Finnish', 'fr':'French', 'gl':'Galician', 'hr':'Croatian', 'it':'Italian', 'kana':'Japanese', 'kana_utf8':'Japanese (UTF8)', 'nl':'Dutch', 'pl':'Polish', 'pt':'Portuguese', 'pt-br':'Portuguese (Brazilian)', 'pt-br_utf8':'Portuguese (Brazilian UTF8)', 'pt_utf8':'Portuguese (UTF8)', 'ru':'Russian', 'tr':'Turkish', 'uk':'Ukrainian', 'test':'TEST' }
1122
-//
1109
+/**
1110
+ * LCD LANGUAGE
1111
+ *
1112
+ * Select the language to display on the LCD. These languages are available:
1113
+ *
1114
+ *    en, an, bg, ca, cn, cz, de, el, el-gr, es, eu, fi, fr, gl, hr, it,
1115
+ *    kana, kana_utf8, nl, pl, pt, pt_utf8, pt-br, pt-br_utf8, ru, tr, uk, test
1116
+ *
1117
+ * :{ 'en':'English', 'an':'Aragonese', 'bg':'Bulgarian', 'ca':'Catalan', 'cn':'Chinese', 'cz':'Czech', 'de':'German', 'el':'Greek', 'el-gr':'Greek (Greece)', 'es':'Spanish', 'eu':'Basque-Euskera', 'fi':'Finnish', 'fr':'French', 'gl':'Galician', 'hr':'Croatian', 'it':'Italian', 'kana':'Japanese', 'kana_utf8':'Japanese (UTF8)', 'nl':'Dutch', 'pl':'Polish', 'pt':'Portuguese', 'pt-br':'Portuguese (Brazilian)', 'pt-br_utf8':'Portuguese (Brazilian UTF8)', 'pt_utf8':'Portuguese (UTF8)', 'ru':'Russian', 'tr':'Turkish', 'uk':'Ukrainian', 'test':'TEST' }
1118
+ */
1123 1119
 //#define LCD_LANGUAGE en
1124 1120
 
1125
-//
1126
-// LCD Character Set
1127
-//
1128
-// Note: This option is NOT applicable to Graphical Displays.
1129
-//
1130
-// All character-based LCD's provide ASCII plus one of these
1131
-// language extensions:
1132
-//
1133
-//  - JAPANESE ... the most common
1134
-//  - WESTERN  ... with more accented characters
1135
-//  - CYRILLIC ... for the Russian language
1136
-//
1137
-// To determine the language extension installed on your controller:
1138
-//
1139
-//  - Compile and upload with LCD_LANGUAGE set to 'test'
1140
-//  - Click the controller to view the LCD menu
1141
-//  - The LCD will display Japanese, Western, or Cyrillic text
1142
-//
1143
-// See https://github.com/MarlinFirmware/Marlin/wiki/LCD-Language
1144
-//
1145
-// :['JAPANESE', 'WESTERN', 'CYRILLIC']
1146
-//
1121
+/**
1122
+ * LCD Character Set
1123
+ *
1124
+ * Note: This option is NOT applicable to Graphical Displays.
1125
+ *
1126
+ * All character-based LCDs provide ASCII plus one of these
1127
+ * language extensions:
1128
+ *
1129
+ *  - JAPANESE ... the most common
1130
+ *  - WESTERN  ... with more accented characters
1131
+ *  - CYRILLIC ... for the Russian language
1132
+ *
1133
+ * To determine the language extension installed on your controller:
1134
+ *
1135
+ *  - Compile and upload with LCD_LANGUAGE set to 'test'
1136
+ *  - Click the controller to view the LCD menu
1137
+ *  - The LCD will display Japanese, Western, or Cyrillic text
1138
+ *
1139
+ * See https: *github.com/MarlinFirmware/Marlin/wiki/LCD-Language
1140
+ *
1141
+ * :['JAPANESE', 'WESTERN', 'CYRILLIC']
1142
+ */
1147 1143
 #define DISPLAY_CHARSET_HD44780 JAPANESE
1148 1144
 
1149
-//
1150
-// LCD TYPE
1151
-//
1152
-// You may choose ULTRA_LCD if you have character based LCD with 16x2, 16x4, 20x2,
1153
-// 20x4 char/lines or DOGLCD for the full graphics display with 128x64 pixels
1154
-// (ST7565R family). (This option will be set automatically for certain displays.)
1155
-//
1156
-// IMPORTANT NOTE: The U8glib library is required for Full Graphic Display!
1157
-//                 https://github.com/olikraus/U8glib_Arduino
1158
-//
1145
+/**
1146
+ * LCD TYPE
1147
+ *
1148
+ * Enable ULTRA_LCD for a 16x2, 16x4, 20x2, or 20x4 character-based LCD.
1149
+ * Enable DOGLCD for a 128x64 (ST7565R) Full Graphical Display.
1150
+ * (These options will be enabled automatically for most displays.)
1151
+ *
1152
+ * IMPORTANT: The U8glib library is required for Full Graphic Display!
1153
+ *            https://github.com/olikraus/U8glib_Arduino
1154
+ */
1159 1155
 //#define ULTRA_LCD   // Character based
1160 1156
 //#define DOGLCD      // Full graphics display
1161 1157
 
1162
-//
1163
-// SD CARD
1164
-//
1165
-// SD Card support is disabled by default. If your controller has an SD slot,
1166
-// you must uncomment the following option or it won't work.
1167
-//
1158
+/**
1159
+ * SD CARD
1160
+ *
1161
+ * SD Card support is disabled by default. If your controller has an SD slot,
1162
+ * you must uncomment the following option or it won't work.
1163
+ *
1164
+ */
1168 1165
 #define SDSUPPORT
1169 1166
 
1170
-//
1171
-// SD CARD: SPI SPEED
1172
-//
1173
-// Uncomment ONE of the following items to use a slower SPI transfer
1174
-// speed. This is usually required if you're getting volume init errors.
1175
-//
1167
+/**
1168
+ * SD CARD: SPI SPEED
1169
+ *
1170
+ * Enable one of the following items for a slower SPI transfer speed.
1171
+ * This may be required to resolve "volume init" errors.
1172
+ */
1176 1173
 #define SPI_SPEED SPI_HALF_SPEED
1177 1174
 //#define SPI_SPEED SPI_QUARTER_SPEED
1178 1175
 //#define SPI_SPEED SPI_EIGHTH_SPEED
1179 1176
 
1180
-//
1181
-// SD CARD: ENABLE CRC
1182
-//
1183
-// Use CRC checks and retries on the SD communication.
1184
-//
1177
+/**
1178
+ * SD CARD: ENABLE CRC
1179
+ *
1180
+ * Use CRC checks and retries on the SD communication.
1181
+ */
1185 1182
 //#define SD_CHECK_AND_RETRY
1186 1183
 
1187 1184
 //
@@ -1209,7 +1206,7 @@
1209 1206
  */
1210 1207
 
1211 1208
 //
1212
-// This option reverses the encoder direction everywhere
1209
+// This option reverses the encoder direction everywhere.
1213 1210
 //
1214 1211
 //  Set this option if CLOCKWISE causes values to DECREASE
1215 1212
 //

+ 137
- 140
Marlin/example_configurations/tvrrug/Round2/Configuration.h View File

@@ -982,23 +982,17 @@
982 982
 #define PREHEAT_2_TEMP_BED    100
983 983
 #define PREHEAT_2_FAN_SPEED   255 // Value from 0 to 255
984 984
 
985
-//
986
-// Nozzle Park -- EXPERIMENTAL
987
-//
988
-// When enabled allows the user to define a special XYZ position, inside the
989
-// machine's topology, to park the nozzle when idle or when receiving the G27
990
-// command.
991
-//
992
-// The "P" paramenter controls what is the action applied to the Z axis:
993
-//    P0: (Default) If current Z-pos is lower than Z-park then the nozzle will
994
-//        be raised to reach Z-park height.
995
-//
996
-//    P1: No matter the current Z-pos, the nozzle will be raised/lowered to
997
-//        reach Z-park height.
998
-//
999
-//    P2: The nozzle height will be raised by Z-park amount but never going over
1000
-//        the machine's limit of Z_MAX_POS.
1001
-//
985
+/**
986
+ * Nozzle Park -- EXPERIMENTAL
987
+ *
988
+ * Park the nozzle at the given XYZ position on idle or G27.
989
+ *
990
+ * The "P" parameter controls the action applied to the Z axis:
991
+ *
992
+ *    P0  (Default) If Z is below park Z raise the nozzle.
993
+ *    P1  Raise the nozzle always to Z-park height.
994
+ *    P2  Raise the nozzle by Z-park amount, limited to Z_MAX_POS.
995
+ */
1002 996
 //#define NOZZLE_PARK_FEATURE
1003 997
 
1004 998
 #if ENABLED(NOZZLE_PARK_FEATURE)
@@ -1006,44 +1000,44 @@
1006 1000
   #define NOZZLE_PARK_POINT { (X_MIN_POS + 10), (Y_MAX_POS - 10), 20 }
1007 1001
 #endif
1008 1002
 
1009
-//
1010
-// Clean Nozzle Feature -- EXPERIMENTAL
1011
-//
1012
-// When enabled allows the user to send G12 to start the nozzle cleaning
1013
-// process, the G-Code accepts two parameters:
1014
-//   "P" for pattern selection
1015
-//   "S" for defining the number of strokes/repetitions
1016
-//
1017
-// Available list of patterns:
1018
-//   P0: This is the default pattern, this process requires a sponge type
1019
-//       material at a fixed bed location. S defines "strokes" i.e.
1020
-//       back-and-forth movements between the starting and end points.
1021
-//
1022
-//   P1: This starts a zig-zag pattern between (X0, Y0) and (X1, Y1), "T"
1023
-//       defines the number of zig-zag triangles to be done. "S" defines the
1024
-//       number of strokes aka one back-and-forth movement. Zig-zags will
1025
-//       be performed in whichever dimension is smallest. As an example,
1026
-//       sending "G12 P1 S1 T3" will execute:
1027
-//
1028
-//          --
1029
-//         |  (X0, Y1) |     /\        /\        /\     | (X1, Y1)
1030
-//         |           |    /  \      /  \      /  \    |
1031
-//       A |           |   /    \    /    \    /    \   |
1032
-//         |           |  /      \  /      \  /      \  |
1033
-//         |  (X0, Y0) | /        \/        \/        \ | (X1, Y0)
1034
-//          --         +--------------------------------+
1035
-//                       |________|_________|_________|
1036
-//                           T1        T2        T3
1037
-//
1038
-//   P2: This starts a circular pattern with circle with middle in
1039
-//       NOZZLE_CLEAN_CIRCLE_MIDDLE radius of R and stroke count of S.
1040
-//       Before starting the circle nozzle goes to NOZZLE_CLEAN_START_POINT.
1041
-//
1042
-// Caveats: End point Z should use the same value as Start point Z.
1043
-//
1044
-// Attention: This is an EXPERIMENTAL feature, in the future the G-code arguments
1045
-// may change to add new functionality like different wipe patterns.
1046
-//
1003
+/**
1004
+ * Clean Nozzle Feature -- EXPERIMENTAL
1005
+ *
1006
+ * Adds the G12 command to perform a nozzle cleaning process.
1007
+ *
1008
+ * Parameters:
1009
+ *   P  Pattern
1010
+ *   S  Strokes / Repetitions
1011
+ *   T  Triangles (P1 only)
1012
+ *
1013
+ * Patterns:
1014
+ *   P0  Straight line (default). This process requires a sponge type material
1015
+ *       at a fixed bed location. "S" specifies strokes (i.e. back-forth motions)
1016
+ *       between the start / end points.
1017
+ *
1018
+ *   P1  Zig-zag pattern between (X0, Y0) and (X1, Y1), "T" specifies the
1019
+ *       number of zig-zag triangles to do. "S" defines the number of strokes.
1020
+ *       Zig-zags are done in whichever is the narrower dimension.
1021
+ *       For example, "G12 P1 S1 T3" will execute:
1022
+ *
1023
+ *          --
1024
+ *         |  (X0, Y1) |     /\        /\        /\     | (X1, Y1)
1025
+ *         |           |    /  \      /  \      /  \    |
1026
+ *       A |           |   /    \    /    \    /    \   |
1027
+ *         |           |  /      \  /      \  /      \  |
1028
+ *         |  (X0, Y0) | /        \/        \/        \ | (X1, Y0)
1029
+ *          --         +--------------------------------+
1030
+ *                       |________|_________|_________|
1031
+ *                           T1        T2        T3
1032
+ *
1033
+ *   P2  Circular pattern with middle at NOZZLE_CLEAN_CIRCLE_MIDDLE.
1034
+ *       "R" specifies the radius. "S" specifies the stroke count.
1035
+ *       Before starting, the nozzle moves to NOZZLE_CLEAN_START_POINT.
1036
+ *
1037
+ *   Caveats: The ending Z should be the same as starting Z.
1038
+ * Attention: EXPERIMENTAL. G-code arguments may change.
1039
+ *
1040
+ */
1047 1041
 //#define NOZZLE_CLEAN_FEATURE
1048 1042
 
1049 1043
 #if ENABLED(NOZZLE_CLEAN_FEATURE)
@@ -1068,33 +1062,35 @@
1068 1062
   #define NOZZLE_CLEAN_GOBACK
1069 1063
 #endif
1070 1064
 
1071
-//
1072
-// Print job timer
1073
-//
1074
-// Enable this option to automatically start and stop the
1075
-// print job timer when M104/M109/M190 commands are received.
1076
-// M104 (extruder without wait) - high temp = none, low temp = stop timer
1077
-// M109 (extruder with wait) - high temp = start timer, low temp = stop timer
1078
-// M190 (bed with wait) - high temp = start timer, low temp = none
1079
-//
1080
-// In all cases the timer can be started and stopped using
1081
-// the following commands:
1082
-//
1083
-// - M75  - Start the print job timer
1084
-// - M76  - Pause the print job timer
1085
-// - M77  - Stop the print job timer
1065
+/**
1066
+ * Print Job Timer
1067
+ *
1068
+ * Automatically start and stop the print job timer on M104/M109/M190.
1069
+ *
1070
+ *   M104 (hotend, no wait) - high temp = none,        low temp = stop timer
1071
+ *   M109 (hotend, wait)    - high temp = start timer, low temp = stop timer
1072
+ *   M190 (bed, wait)       - high temp = start timer, low temp = none
1073
+ *
1074
+ * The timer can also be controlled with the following commands:
1075
+ *
1076
+ *   M75 - Start the print job timer
1077
+ *   M76 - Pause the print job timer
1078
+ *   M77 - Stop the print job timer
1079
+ */
1086 1080
 #define PRINTJOB_TIMER_AUTOSTART
1087 1081
 
1088
-//
1089
-// Print Counter
1090
-//
1091
-// When enabled Marlin will keep track of some print statistical data such as:
1092
-//  - Total print jobs
1093
-//  - Total successful print jobs
1094
-//  - Total failed print jobs
1095
-//  - Total time printing
1096
-//
1097
-// This information can be viewed by the M78 command.
1082
+/**
1083
+ * Print Counter
1084
+ *
1085
+ * Track statistical data such as:
1086
+ *
1087
+ *  - Total print jobs
1088
+ *  - Total successful print jobs
1089
+ *  - Total failed print jobs
1090
+ *  - Total time printing
1091
+ *
1092
+ * View the current statistics with M78.
1093
+ */
1098 1094
 //#define PRINTCOUNTER
1099 1095
 
1100 1096
 //=============================================================================
@@ -1103,78 +1099,79 @@
1103 1099
 
1104 1100
 // @section lcd
1105 1101
 
1106
-//
1107
-// LCD LANGUAGE
1108
-//
1109
-// Here you may choose the language used by Marlin on the LCD menus, the following
1110
-// list of languages are available:
1111
-//    en, an, bg, ca, cn, cz, de, el, el-gr, es, eu, fi, fr, gl, hr, it,
1112
-//    kana, kana_utf8, nl, pl, pt, pt_utf8, pt-br, pt-br_utf8, ru, tr, uk, test
1113
-//
1114
-// :{ 'en':'English', 'an':'Aragonese', 'bg':'Bulgarian', 'ca':'Catalan', 'cn':'Chinese', 'cz':'Czech', 'de':'German', 'el':'Greek', 'el-gr':'Greek (Greece)', 'es':'Spanish', 'eu':'Basque-Euskera', 'fi':'Finnish', 'fr':'French', 'gl':'Galician', 'hr':'Croatian', 'it':'Italian', 'kana':'Japanese', 'kana_utf8':'Japanese (UTF8)', 'nl':'Dutch', 'pl':'Polish', 'pt':'Portuguese', 'pt-br':'Portuguese (Brazilian)', 'pt-br_utf8':'Portuguese (Brazilian UTF8)', 'pt_utf8':'Portuguese (UTF8)', 'ru':'Russian', 'tr':'Turkish', 'uk':'Ukrainian', 'test':'TEST' }
1115
-//
1102
+/**
1103
+ * LCD LANGUAGE
1104
+ *
1105
+ * Select the language to display on the LCD. These languages are available:
1106
+ *
1107
+ *    en, an, bg, ca, cn, cz, de, el, el-gr, es, eu, fi, fr, gl, hr, it,
1108
+ *    kana, kana_utf8, nl, pl, pt, pt_utf8, pt-br, pt-br_utf8, ru, tr, uk, test
1109
+ *
1110
+ * :{ 'en':'English', 'an':'Aragonese', 'bg':'Bulgarian', 'ca':'Catalan', 'cn':'Chinese', 'cz':'Czech', 'de':'German', 'el':'Greek', 'el-gr':'Greek (Greece)', 'es':'Spanish', 'eu':'Basque-Euskera', 'fi':'Finnish', 'fr':'French', 'gl':'Galician', 'hr':'Croatian', 'it':'Italian', 'kana':'Japanese', 'kana_utf8':'Japanese (UTF8)', 'nl':'Dutch', 'pl':'Polish', 'pt':'Portuguese', 'pt-br':'Portuguese (Brazilian)', 'pt-br_utf8':'Portuguese (Brazilian UTF8)', 'pt_utf8':'Portuguese (UTF8)', 'ru':'Russian', 'tr':'Turkish', 'uk':'Ukrainian', 'test':'TEST' }
1111
+ */
1116 1112
 //#define LCD_LANGUAGE en
1117 1113
 
1118
-//
1119
-// LCD Character Set
1120
-//
1121
-// Note: This option is NOT applicable to Graphical Displays.
1122
-//
1123
-// All character-based LCD's provide ASCII plus one of these
1124
-// language extensions:
1125
-//
1126
-//  - JAPANESE ... the most common
1127
-//  - WESTERN  ... with more accented characters
1128
-//  - CYRILLIC ... for the Russian language
1129
-//
1130
-// To determine the language extension installed on your controller:
1131
-//
1132
-//  - Compile and upload with LCD_LANGUAGE set to 'test'
1133
-//  - Click the controller to view the LCD menu
1134
-//  - The LCD will display Japanese, Western, or Cyrillic text
1135
-//
1136
-// See https://github.com/MarlinFirmware/Marlin/wiki/LCD-Language
1137
-//
1138
-// :['JAPANESE', 'WESTERN', 'CYRILLIC']
1139
-//
1114
+/**
1115
+ * LCD Character Set
1116
+ *
1117
+ * Note: This option is NOT applicable to Graphical Displays.
1118
+ *
1119
+ * All character-based LCDs provide ASCII plus one of these
1120
+ * language extensions:
1121
+ *
1122
+ *  - JAPANESE ... the most common
1123
+ *  - WESTERN  ... with more accented characters
1124
+ *  - CYRILLIC ... for the Russian language
1125
+ *
1126
+ * To determine the language extension installed on your controller:
1127
+ *
1128
+ *  - Compile and upload with LCD_LANGUAGE set to 'test'
1129
+ *  - Click the controller to view the LCD menu
1130
+ *  - The LCD will display Japanese, Western, or Cyrillic text
1131
+ *
1132
+ * See https: *github.com/MarlinFirmware/Marlin/wiki/LCD-Language
1133
+ *
1134
+ * :['JAPANESE', 'WESTERN', 'CYRILLIC']
1135
+ */
1140 1136
 #define DISPLAY_CHARSET_HD44780 JAPANESE
1141 1137
 
1142
-//
1143
-// LCD TYPE
1144
-//
1145
-// You may choose ULTRA_LCD if you have character based LCD with 16x2, 16x4, 20x2,
1146
-// 20x4 char/lines or DOGLCD for the full graphics display with 128x64 pixels
1147
-// (ST7565R family). (This option will be set automatically for certain displays.)
1148
-//
1149
-// IMPORTANT NOTE: The U8glib library is required for Full Graphic Display!
1150
-//                 https://github.com/olikraus/U8glib_Arduino
1151
-//
1138
+/**
1139
+ * LCD TYPE
1140
+ *
1141
+ * Enable ULTRA_LCD for a 16x2, 16x4, 20x2, or 20x4 character-based LCD.
1142
+ * Enable DOGLCD for a 128x64 (ST7565R) Full Graphical Display.
1143
+ * (These options will be enabled automatically for most displays.)
1144
+ *
1145
+ * IMPORTANT: The U8glib library is required for Full Graphic Display!
1146
+ *            https://github.com/olikraus/U8glib_Arduino
1147
+ */
1152 1148
 //#define ULTRA_LCD   // Character based
1153 1149
 //#define DOGLCD      // Full graphics display
1154 1150
 
1155
-//
1156
-// SD CARD
1157
-//
1158
-// SD Card support is disabled by default. If your controller has an SD slot,
1159
-// you must uncomment the following option or it won't work.
1160
-//
1151
+/**
1152
+ * SD CARD
1153
+ *
1154
+ * SD Card support is disabled by default. If your controller has an SD slot,
1155
+ * you must uncomment the following option or it won't work.
1156
+ *
1157
+ */
1161 1158
 //#define SDSUPPORT
1162 1159
 
1163
-//
1164
-// SD CARD: SPI SPEED
1165
-//
1166
-// Uncomment ONE of the following items to use a slower SPI transfer
1167
-// speed. This is usually required if you're getting volume init errors.
1168
-//
1160
+/**
1161
+ * SD CARD: SPI SPEED
1162
+ *
1163
+ * Enable one of the following items for a slower SPI transfer speed.
1164
+ * This may be required to resolve "volume init" errors.
1165
+ */
1169 1166
 //#define SPI_SPEED SPI_HALF_SPEED
1170 1167
 //#define SPI_SPEED SPI_QUARTER_SPEED
1171 1168
 //#define SPI_SPEED SPI_EIGHTH_SPEED
1172 1169
 
1173
-//
1174
-// SD CARD: ENABLE CRC
1175
-//
1176
-// Use CRC checks and retries on the SD communication.
1177
-//
1170
+/**
1171
+ * SD CARD: ENABLE CRC
1172
+ *
1173
+ * Use CRC checks and retries on the SD communication.
1174
+ */
1178 1175
 //#define SD_CHECK_AND_RETRY
1179 1176
 
1180 1177
 //
@@ -1202,7 +1199,7 @@
1202 1199
  */
1203 1200
 
1204 1201
 //
1205
-// This option reverses the encoder direction everywhere
1202
+// This option reverses the encoder direction everywhere.
1206 1203
 //
1207 1204
 //  Set this option if CLOCKWISE causes values to DECREASE
1208 1205
 //

+ 137
- 140
Marlin/example_configurations/wt150/Configuration.h View File

@@ -991,23 +991,17 @@
991 991
 #define PREHEAT_2_TEMP_BED    110
992 992
 #define PREHEAT_2_FAN_SPEED     0 // Value from 0 to 255
993 993
 
994
-//
995
-// Nozzle Park -- EXPERIMENTAL
996
-//
997
-// When enabled allows the user to define a special XYZ position, inside the
998
-// machine's topology, to park the nozzle when idle or when receiving the G27
999
-// command.
1000
-//
1001
-// The "P" paramenter controls what is the action applied to the Z axis:
1002
-//    P0: (Default) If current Z-pos is lower than Z-park then the nozzle will
1003
-//        be raised to reach Z-park height.
1004
-//
1005
-//    P1: No matter the current Z-pos, the nozzle will be raised/lowered to
1006
-//        reach Z-park height.
1007
-//
1008
-//    P2: The nozzle height will be raised by Z-park amount but never going over
1009
-//        the machine's limit of Z_MAX_POS.
1010
-//
994
+/**
995
+ * Nozzle Park -- EXPERIMENTAL
996
+ *
997
+ * Park the nozzle at the given XYZ position on idle or G27.
998
+ *
999
+ * The "P" parameter controls the action applied to the Z axis:
1000
+ *
1001
+ *    P0  (Default) If Z is below park Z raise the nozzle.
1002
+ *    P1  Raise the nozzle always to Z-park height.
1003
+ *    P2  Raise the nozzle by Z-park amount, limited to Z_MAX_POS.
1004
+ */
1011 1005
 //#define NOZZLE_PARK_FEATURE
1012 1006
 
1013 1007
 #if ENABLED(NOZZLE_PARK_FEATURE)
@@ -1015,44 +1009,44 @@
1015 1009
   #define NOZZLE_PARK_POINT { (X_MIN_POS + 10), (Y_MAX_POS - 10), 20 }
1016 1010
 #endif
1017 1011
 
1018
-//
1019
-// Clean Nozzle Feature -- EXPERIMENTAL
1020
-//
1021
-// When enabled allows the user to send G12 to start the nozzle cleaning
1022
-// process, the G-Code accepts two parameters:
1023
-//   "P" for pattern selection
1024
-//   "S" for defining the number of strokes/repetitions
1025
-//
1026
-// Available list of patterns:
1027
-//   P0: This is the default pattern, this process requires a sponge type
1028
-//       material at a fixed bed location. S defines "strokes" i.e.
1029
-//       back-and-forth movements between the starting and end points.
1030
-//
1031
-//   P1: This starts a zig-zag pattern between (X0, Y0) and (X1, Y1), "T"
1032
-//       defines the number of zig-zag triangles to be done. "S" defines the
1033
-//       number of strokes aka one back-and-forth movement. Zig-zags will
1034
-//       be performed in whichever dimension is smallest. As an example,
1035
-//       sending "G12 P1 S1 T3" will execute:
1036
-//
1037
-//          --
1038
-//         |  (X0, Y1) |     /\        /\        /\     | (X1, Y1)
1039
-//         |           |    /  \      /  \      /  \    |
1040
-//       A |           |   /    \    /    \    /    \   |
1041
-//         |           |  /      \  /      \  /      \  |
1042
-//         |  (X0, Y0) | /        \/        \/        \ | (X1, Y0)
1043
-//          --         +--------------------------------+
1044
-//                       |________|_________|_________|
1045
-//                           T1        T2        T3
1046
-//
1047
-//   P2: This starts a circular pattern with circle with middle in
1048
-//       NOZZLE_CLEAN_CIRCLE_MIDDLE radius of R and stroke count of S.
1049
-//       Before starting the circle nozzle goes to NOZZLE_CLEAN_START_POINT.
1050
-//
1051
-// Caveats: End point Z should use the same value as Start point Z.
1052
-//
1053
-// Attention: This is an EXPERIMENTAL feature, in the future the G-code arguments
1054
-// may change to add new functionality like different wipe patterns.
1055
-//
1012
+/**
1013
+ * Clean Nozzle Feature -- EXPERIMENTAL
1014
+ *
1015
+ * Adds the G12 command to perform a nozzle cleaning process.
1016
+ *
1017
+ * Parameters:
1018
+ *   P  Pattern
1019
+ *   S  Strokes / Repetitions
1020
+ *   T  Triangles (P1 only)
1021
+ *
1022
+ * Patterns:
1023
+ *   P0  Straight line (default). This process requires a sponge type material
1024
+ *       at a fixed bed location. "S" specifies strokes (i.e. back-forth motions)
1025
+ *       between the start / end points.
1026
+ *
1027
+ *   P1  Zig-zag pattern between (X0, Y0) and (X1, Y1), "T" specifies the
1028
+ *       number of zig-zag triangles to do. "S" defines the number of strokes.
1029
+ *       Zig-zags are done in whichever is the narrower dimension.
1030
+ *       For example, "G12 P1 S1 T3" will execute:
1031
+ *
1032
+ *          --
1033
+ *         |  (X0, Y1) |     /\        /\        /\     | (X1, Y1)
1034
+ *         |           |    /  \      /  \      /  \    |
1035
+ *       A |           |   /    \    /    \    /    \   |
1036
+ *         |           |  /      \  /      \  /      \  |
1037
+ *         |  (X0, Y0) | /        \/        \/        \ | (X1, Y0)
1038
+ *          --         +--------------------------------+
1039
+ *                       |________|_________|_________|
1040
+ *                           T1        T2        T3
1041
+ *
1042
+ *   P2  Circular pattern with middle at NOZZLE_CLEAN_CIRCLE_MIDDLE.
1043
+ *       "R" specifies the radius. "S" specifies the stroke count.
1044
+ *       Before starting, the nozzle moves to NOZZLE_CLEAN_START_POINT.
1045
+ *
1046
+ *   Caveats: The ending Z should be the same as starting Z.
1047
+ * Attention: EXPERIMENTAL. G-code arguments may change.
1048
+ *
1049
+ */
1056 1050
 //#define NOZZLE_CLEAN_FEATURE
1057 1051
 
1058 1052
 #if ENABLED(NOZZLE_CLEAN_FEATURE)
@@ -1077,33 +1071,35 @@
1077 1071
   #define NOZZLE_CLEAN_GOBACK
1078 1072
 #endif
1079 1073
 
1080
-//
1081
-// Print job timer
1082
-//
1083
-// Enable this option to automatically start and stop the
1084
-// print job timer when M104/M109/M190 commands are received.
1085
-// M104 (extruder without wait) - high temp = none, low temp = stop timer
1086
-// M109 (extruder with wait) - high temp = start timer, low temp = stop timer
1087
-// M190 (bed with wait) - high temp = start timer, low temp = none
1088
-//
1089
-// In all cases the timer can be started and stopped using
1090
-// the following commands:
1091
-//
1092
-// - M75  - Start the print job timer
1093
-// - M76  - Pause the print job timer
1094
-// - M77  - Stop the print job timer
1074
+/**
1075
+ * Print Job Timer
1076
+ *
1077
+ * Automatically start and stop the print job timer on M104/M109/M190.
1078
+ *
1079
+ *   M104 (hotend, no wait) - high temp = none,        low temp = stop timer
1080
+ *   M109 (hotend, wait)    - high temp = start timer, low temp = stop timer
1081
+ *   M190 (bed, wait)       - high temp = start timer, low temp = none
1082
+ *
1083
+ * The timer can also be controlled with the following commands:
1084
+ *
1085
+ *   M75 - Start the print job timer
1086
+ *   M76 - Pause the print job timer
1087
+ *   M77 - Stop the print job timer
1088
+ */
1095 1089
 #define PRINTJOB_TIMER_AUTOSTART
1096 1090
 
1097
-//
1098
-// Print Counter
1099
-//
1100
-// When enabled Marlin will keep track of some print statistical data such as:
1101
-//  - Total print jobs
1102
-//  - Total successful print jobs
1103
-//  - Total failed print jobs
1104
-//  - Total time printing
1105
-//
1106
-// This information can be viewed by the M78 command.
1091
+/**
1092
+ * Print Counter
1093
+ *
1094
+ * Track statistical data such as:
1095
+ *
1096
+ *  - Total print jobs
1097
+ *  - Total successful print jobs
1098
+ *  - Total failed print jobs
1099
+ *  - Total time printing
1100
+ *
1101
+ * View the current statistics with M78.
1102
+ */
1107 1103
 #define PRINTCOUNTER
1108 1104
 
1109 1105
 //=============================================================================
@@ -1112,78 +1108,79 @@
1112 1108
 
1113 1109
 // @section lcd
1114 1110
 
1115
-//
1116
-// LCD LANGUAGE
1117
-//
1118
-// Here you may choose the language used by Marlin on the LCD menus, the following
1119
-// list of languages are available:
1120
-//    en, an, bg, ca, cn, cz, de, el, el-gr, es, eu, fi, fr, gl, hr, it,
1121
-//    kana, kana_utf8, nl, pl, pt, pt_utf8, pt-br, pt-br_utf8, ru, tr, uk, test
1122
-//
1123
-// :{ 'en':'English', 'an':'Aragonese', 'bg':'Bulgarian', 'ca':'Catalan', 'cn':'Chinese', 'cz':'Czech', 'de':'German', 'el':'Greek', 'el-gr':'Greek (Greece)', 'es':'Spanish', 'eu':'Basque-Euskera', 'fi':'Finnish', 'fr':'French', 'gl':'Galician', 'hr':'Croatian', 'it':'Italian', 'kana':'Japanese', 'kana_utf8':'Japanese (UTF8)', 'nl':'Dutch', 'pl':'Polish', 'pt':'Portuguese', 'pt-br':'Portuguese (Brazilian)', 'pt-br_utf8':'Portuguese (Brazilian UTF8)', 'pt_utf8':'Portuguese (UTF8)', 'ru':'Russian', 'tr':'Turkish', 'uk':'Ukrainian', 'test':'TEST' }
1124
-//
1111
+/**
1112
+ * LCD LANGUAGE
1113
+ *
1114
+ * Select the language to display on the LCD. These languages are available:
1115
+ *
1116
+ *    en, an, bg, ca, cn, cz, de, el, el-gr, es, eu, fi, fr, gl, hr, it,
1117
+ *    kana, kana_utf8, nl, pl, pt, pt_utf8, pt-br, pt-br_utf8, ru, tr, uk, test
1118
+ *
1119
+ * :{ 'en':'English', 'an':'Aragonese', 'bg':'Bulgarian', 'ca':'Catalan', 'cn':'Chinese', 'cz':'Czech', 'de':'German', 'el':'Greek', 'el-gr':'Greek (Greece)', 'es':'Spanish', 'eu':'Basque-Euskera', 'fi':'Finnish', 'fr':'French', 'gl':'Galician', 'hr':'Croatian', 'it':'Italian', 'kana':'Japanese', 'kana_utf8':'Japanese (UTF8)', 'nl':'Dutch', 'pl':'Polish', 'pt':'Portuguese', 'pt-br':'Portuguese (Brazilian)', 'pt-br_utf8':'Portuguese (Brazilian UTF8)', 'pt_utf8':'Portuguese (UTF8)', 'ru':'Russian', 'tr':'Turkish', 'uk':'Ukrainian', 'test':'TEST' }
1120
+ */
1125 1121
 #define LCD_LANGUAGE en
1126 1122
 
1127
-//
1128
-// LCD Character Set
1129
-//
1130
-// Note: This option is NOT applicable to Graphical Displays.
1131
-//
1132
-// All character-based LCD's provide ASCII plus one of these
1133
-// language extensions:
1134
-//
1135
-//  - JAPANESE ... the most common
1136
-//  - WESTERN  ... with more accented characters
1137
-//  - CYRILLIC ... for the Russian language
1138
-//
1139
-// To determine the language extension installed on your controller:
1140
-//
1141
-//  - Compile and upload with LCD_LANGUAGE set to 'test'
1142
-//  - Click the controller to view the LCD menu
1143
-//  - The LCD will display Japanese, Western, or Cyrillic text
1144
-//
1145
-// See https://github.com/MarlinFirmware/Marlin/wiki/LCD-Language
1146
-//
1147
-// :['JAPANESE', 'WESTERN', 'CYRILLIC']
1148
-//
1123
+/**
1124
+ * LCD Character Set
1125
+ *
1126
+ * Note: This option is NOT applicable to Graphical Displays.
1127
+ *
1128
+ * All character-based LCDs provide ASCII plus one of these
1129
+ * language extensions:
1130
+ *
1131
+ *  - JAPANESE ... the most common
1132
+ *  - WESTERN  ... with more accented characters
1133
+ *  - CYRILLIC ... for the Russian language
1134
+ *
1135
+ * To determine the language extension installed on your controller:
1136
+ *
1137
+ *  - Compile and upload with LCD_LANGUAGE set to 'test'
1138
+ *  - Click the controller to view the LCD menu
1139
+ *  - The LCD will display Japanese, Western, or Cyrillic text
1140
+ *
1141
+ * See https: *github.com/MarlinFirmware/Marlin/wiki/LCD-Language
1142
+ *
1143
+ * :['JAPANESE', 'WESTERN', 'CYRILLIC']
1144
+ */
1149 1145
 #define DISPLAY_CHARSET_HD44780 JAPANESE
1150 1146
 
1151
-//
1152
-// LCD TYPE
1153
-//
1154
-// You may choose ULTRA_LCD if you have character based LCD with 16x2, 16x4, 20x2,
1155
-// 20x4 char/lines or DOGLCD for the full graphics display with 128x64 pixels
1156
-// (ST7565R family). (This option will be set automatically for certain displays.)
1157
-//
1158
-// IMPORTANT NOTE: The U8glib library is required for Full Graphic Display!
1159
-//                 https://github.com/olikraus/U8glib_Arduino
1160
-//
1147
+/**
1148
+ * LCD TYPE
1149
+ *
1150
+ * Enable ULTRA_LCD for a 16x2, 16x4, 20x2, or 20x4 character-based LCD.
1151
+ * Enable DOGLCD for a 128x64 (ST7565R) Full Graphical Display.
1152
+ * (These options will be enabled automatically for most displays.)
1153
+ *
1154
+ * IMPORTANT: The U8glib library is required for Full Graphic Display!
1155
+ *            https://github.com/olikraus/U8glib_Arduino
1156
+ */
1161 1157
 //#define ULTRA_LCD   // Character based
1162 1158
 //#define DOGLCD      // Full graphics display
1163 1159
 
1164
-//
1165
-// SD CARD
1166
-//
1167
-// SD Card support is disabled by default. If your controller has an SD slot,
1168
-// you must uncomment the following option or it won't work.
1169
-//
1160
+/**
1161
+ * SD CARD
1162
+ *
1163
+ * SD Card support is disabled by default. If your controller has an SD slot,
1164
+ * you must uncomment the following option or it won't work.
1165
+ *
1166
+ */
1170 1167
 #define SDSUPPORT
1171 1168
 
1172
-//
1173
-// SD CARD: SPI SPEED
1174
-//
1175
-// Uncomment ONE of the following items to use a slower SPI transfer
1176
-// speed. This is usually required if you're getting volume init errors.
1177
-//
1169
+/**
1170
+ * SD CARD: SPI SPEED
1171
+ *
1172
+ * Enable one of the following items for a slower SPI transfer speed.
1173
+ * This may be required to resolve "volume init" errors.
1174
+ */
1178 1175
 //#define SPI_SPEED SPI_HALF_SPEED
1179 1176
 //#define SPI_SPEED SPI_QUARTER_SPEED
1180 1177
 //#define SPI_SPEED SPI_EIGHTH_SPEED
1181 1178
 
1182
-//
1183
-// SD CARD: ENABLE CRC
1184
-//
1185
-// Use CRC checks and retries on the SD communication.
1186
-//
1179
+/**
1180
+ * SD CARD: ENABLE CRC
1181
+ *
1182
+ * Use CRC checks and retries on the SD communication.
1183
+ */
1187 1184
 //#define SD_CHECK_AND_RETRY
1188 1185
 
1189 1186
 //
@@ -1211,7 +1208,7 @@
1211 1208
  */
1212 1209
 
1213 1210
 //
1214
-// This option reverses the encoder direction everywhere
1211
+// This option reverses the encoder direction everywhere.
1215 1212
 //
1216 1213
 //  Set this option if CLOCKWISE causes values to DECREASE
1217 1214
 //

Loading…
Cancel
Save