My Marlin configs for Fabrikator Mini and CTC i3 Pro B
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326
  1. /**
  2. * Marlin 3D Printer Firmware
  3. * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin]
  4. *
  5. * Based on Sprinter and grbl.
  6. * Copyright (C) 2011 Camiel Gubbels / Erik van der Zalm
  7. *
  8. * This program is free software: you can redistribute it and/or modify
  9. * it under the terms of the GNU General Public License as published by
  10. * the Free Software Foundation, either version 3 of the License, or
  11. * (at your option) any later version.
  12. *
  13. * This program is distributed in the hope that it will be useful,
  14. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  16. * GNU General Public License for more details.
  17. *
  18. * You should have received a copy of the GNU General Public License
  19. * along with this program. If not, see <http://www.gnu.org/licenses/>.
  20. *
  21. */
  22. /**
  23. * gcode.h - Parser for a GCode line, providing a parameter interface.
  24. * Codes like M149 control the way the GCode parser behaves,
  25. * so settings for these codes are located in this class.
  26. */
  27. #ifndef GCODE_H
  28. #define GCODE_H
  29. #include "enum.h"
  30. #include "types.h"
  31. #include "MarlinConfig.h"
  32. //#define DEBUG_GCODE_PARSER
  33. #if ENABLED(DEBUG_GCODE_PARSER)
  34. #if ENABLED(AUTO_BED_LEVELING_UBL)
  35. extern char* hex_address(const void * const w);
  36. #else
  37. #include "hex_print_routines.h"
  38. #endif
  39. #include "serial.h"
  40. #endif
  41. /**
  42. * GCode parser
  43. *
  44. * - Parse a single gcode line for its letter, code, subcode, and parameters
  45. * - FASTER_GCODE_PARSER:
  46. * - Flags existing params (1 bit each)
  47. * - Stores value offsets (1 byte each)
  48. * - Provide accessors for parameters:
  49. * - Parameter exists
  50. * - Parameter has value
  51. * - Parameter value in different units and types
  52. */
  53. class GCodeParser {
  54. private:
  55. static char *value_ptr; // Set by seen, used to fetch the value
  56. #if ENABLED(FASTER_GCODE_PARSER)
  57. static byte codebits[4]; // Parameters pre-scanned
  58. static uint8_t param[26]; // For A-Z, offsets into command args
  59. #else
  60. static char *command_args; // Args start here, for slow scan
  61. #endif
  62. public:
  63. // Global states for GCode-level units features
  64. static bool volumetric_enabled;
  65. #if ENABLED(INCH_MODE_SUPPORT)
  66. static float linear_unit_factor, volumetric_unit_factor;
  67. #endif
  68. #if ENABLED(TEMPERATURE_UNITS_SUPPORT)
  69. static TempUnit input_temp_units;
  70. #endif
  71. // Command line state
  72. static char *command_ptr, // The command, so it can be echoed
  73. *string_arg; // string of command line
  74. static char command_letter; // G, M, or T
  75. static int codenum; // 123
  76. #if USE_GCODE_SUBCODES
  77. static uint8_t subcode; // .1
  78. #endif
  79. #if ENABLED(DEBUG_GCODE_PARSER)
  80. void debug();
  81. #endif
  82. // Reset is done before parsing
  83. static void reset();
  84. // Index so that 'X' falls on index 24
  85. #define PARAM_IND(N) ((N) >> 3)
  86. #define PARAM_BIT(N) ((N) & 0x7)
  87. #define LETTER_OFF(N) ((N) - 'A')
  88. #define LETTER_IND(N) PARAM_IND(LETTER_OFF(N))
  89. #define LETTER_BIT(N) PARAM_BIT(LETTER_OFF(N))
  90. #if ENABLED(FASTER_GCODE_PARSER)
  91. // Set the flag and pointer for a parameter
  92. static void set(const char c, char * const ptr
  93. #if ENABLED(DEBUG_GCODE_PARSER)
  94. , const bool debug=false
  95. #endif
  96. ) {
  97. const uint8_t ind = LETTER_OFF(c);
  98. if (ind >= COUNT(param)) return; // Only A-Z
  99. SBI(codebits[PARAM_IND(ind)], PARAM_BIT(ind)); // parameter exists
  100. param[ind] = ptr ? ptr - command_ptr : 0; // parameter offset or 0
  101. #if ENABLED(DEBUG_GCODE_PARSER)
  102. if (debug) {
  103. SERIAL_ECHOPAIR("Set bit ", (int)PARAM_BIT(ind));
  104. SERIAL_ECHOPAIR(" of index ", (int)PARAM_IND(ind));
  105. SERIAL_ECHOLNPAIR(" | param = ", (int)param[ind]);
  106. }
  107. #endif
  108. }
  109. // Code seen bit was set. If not found, value_ptr is unchanged.
  110. // This allows "if (seen('A')||seen('B'))" to use the last-found value.
  111. static bool seen(const char c) {
  112. const uint8_t ind = LETTER_OFF(c);
  113. if (ind >= COUNT(param)) return false; // Only A-Z
  114. const bool b = TEST(codebits[PARAM_IND(ind)], PARAM_BIT(ind));
  115. if (b) value_ptr = param[ind] ? command_ptr + param[ind] : (char*)NULL;
  116. return b;
  117. }
  118. static bool seen_any() { return codebits[3] || codebits[2] || codebits[1] || codebits[0]; }
  119. #define SEEN_TEST(L) TEST(codebits[LETTER_IND(L)], LETTER_BIT(L))
  120. #else // !FASTER_GCODE_PARSER
  121. // Code is found in the string. If not found, value_ptr is unchanged.
  122. // This allows "if (seen('A')||seen('B'))" to use the last-found value.
  123. static bool seen(const char c) {
  124. const char *p = strchr(command_args, c);
  125. const bool b = !!p;
  126. if (b) value_ptr = DECIMAL_SIGNED(p[1]) ? &p[1] : (char*)NULL;
  127. return b;
  128. }
  129. static bool seen_any() { return *command_args == '\0'; }
  130. #define SEEN_TEST(L) !!strchr(command_args, L)
  131. #endif // !FASTER_GCODE_PARSER
  132. // Seen any axis parameter
  133. static bool seen_axis() {
  134. return SEEN_TEST('X') || SEEN_TEST('Y') || SEEN_TEST('Z') || SEEN_TEST('E');
  135. }
  136. // Populate all fields by parsing a single line of GCode
  137. // This uses 54 bytes of SRAM to speed up seen/value
  138. static void parse(char * p);
  139. #if ENABLED(CNC_COORDINATE_SYSTEMS)
  140. // Parse the next parameter as a new command
  141. static bool chain();
  142. #endif
  143. // The code value pointer was set
  144. FORCE_INLINE static bool has_value() { return value_ptr != NULL; }
  145. // Seen a parameter with a value
  146. inline static bool seenval(const char c) { return seen(c) && has_value(); }
  147. // Float removes 'E' to prevent scientific notation interpretation
  148. inline static float value_float() {
  149. if (value_ptr) {
  150. char *e = value_ptr;
  151. for (;;) {
  152. const char c = *e;
  153. if (c == '\0' || c == ' ') break;
  154. if (c == 'E' || c == 'e') {
  155. *e = '\0';
  156. const float ret = strtod(value_ptr, NULL);
  157. *e = c;
  158. return ret;
  159. }
  160. ++e;
  161. }
  162. return strtod(value_ptr, NULL);
  163. }
  164. return 0.0;
  165. }
  166. // Code value as a long or ulong
  167. inline static int32_t value_long() { return value_ptr ? strtol(value_ptr, NULL, 10) : 0L; }
  168. inline static uint32_t value_ulong() { return value_ptr ? strtoul(value_ptr, NULL, 10) : 0UL; }
  169. // Code value for use as time
  170. FORCE_INLINE static millis_t value_millis() { return value_ulong(); }
  171. FORCE_INLINE static millis_t value_millis_from_seconds() { return value_float() * 1000UL; }
  172. // Reduce to fewer bits
  173. FORCE_INLINE static int16_t value_int() { return (int16_t)value_long(); }
  174. FORCE_INLINE static uint16_t value_ushort() { return (uint16_t)value_long(); }
  175. inline static uint8_t value_byte() { return (uint8_t)constrain(value_long(), 0, 255); }
  176. // Bool is true with no value or non-zero
  177. inline static bool value_bool() { return !has_value() || value_byte(); }
  178. // Units modes: Inches, Fahrenheit, Kelvin
  179. #if ENABLED(INCH_MODE_SUPPORT)
  180. inline static void set_input_linear_units(const LinearUnit units) {
  181. switch (units) {
  182. case LINEARUNIT_INCH:
  183. linear_unit_factor = 25.4;
  184. break;
  185. case LINEARUNIT_MM:
  186. default:
  187. linear_unit_factor = 1.0;
  188. break;
  189. }
  190. volumetric_unit_factor = POW(linear_unit_factor, 3.0);
  191. }
  192. inline static float axis_unit_factor(const AxisEnum axis) {
  193. return (axis >= E_AXIS && volumetric_enabled ? volumetric_unit_factor : linear_unit_factor);
  194. }
  195. inline static float value_linear_units() { return value_float() * linear_unit_factor; }
  196. inline static float value_axis_units(const AxisEnum axis) { return value_float() * axis_unit_factor(axis); }
  197. inline static float value_per_axis_unit(const AxisEnum axis) { return value_float() / axis_unit_factor(axis); }
  198. #else
  199. FORCE_INLINE static float value_linear_units() { return value_float(); }
  200. FORCE_INLINE static float value_axis_units(const AxisEnum a) { UNUSED(a); return value_float(); }
  201. FORCE_INLINE static float value_per_axis_unit(const AxisEnum a) { UNUSED(a); return value_float(); }
  202. #endif
  203. #if ENABLED(TEMPERATURE_UNITS_SUPPORT)
  204. inline static void set_input_temp_units(TempUnit units) { input_temp_units = units; }
  205. #if ENABLED(ULTIPANEL) && DISABLED(DISABLE_M503)
  206. FORCE_INLINE static char temp_units_code() {
  207. return input_temp_units == TEMPUNIT_K ? 'K' : input_temp_units == TEMPUNIT_F ? 'F' : 'C';
  208. }
  209. FORCE_INLINE static char* temp_units_name() {
  210. return input_temp_units == TEMPUNIT_K ? PSTR("Kelvin") : input_temp_units == TEMPUNIT_F ? PSTR("Fahrenheit") : PSTR("Celsius");
  211. }
  212. inline static float to_temp_units(const float &f) {
  213. switch (input_temp_units) {
  214. case TEMPUNIT_F:
  215. return f * 0.5555555556 + 32.0;
  216. case TEMPUNIT_K:
  217. return f + 273.15;
  218. case TEMPUNIT_C:
  219. default:
  220. return f;
  221. }
  222. }
  223. #endif // ULTIPANEL && !DISABLE_M503
  224. inline static float value_celsius() {
  225. const float f = value_float();
  226. switch (input_temp_units) {
  227. case TEMPUNIT_F:
  228. return (f - 32.0) * 0.5555555556;
  229. case TEMPUNIT_K:
  230. return f - 273.15;
  231. case TEMPUNIT_C:
  232. default:
  233. return f;
  234. }
  235. }
  236. inline static float value_celsius_diff() {
  237. switch (input_temp_units) {
  238. case TEMPUNIT_F:
  239. return value_float() * 0.5555555556;
  240. case TEMPUNIT_C:
  241. case TEMPUNIT_K:
  242. default:
  243. return value_float();
  244. }
  245. }
  246. #else // !TEMPERATURE_UNITS_SUPPORT
  247. FORCE_INLINE static float value_celsius() { return value_float(); }
  248. FORCE_INLINE static float value_celsius_diff() { return value_float(); }
  249. #endif // !TEMPERATURE_UNITS_SUPPORT
  250. FORCE_INLINE static float value_feedrate() { return value_linear_units(); }
  251. void unknown_command_error();
  252. // Provide simple value accessors with default option
  253. FORCE_INLINE static float floatval(const char c, const float dval=0.0) { return seenval(c) ? value_float() : dval; }
  254. FORCE_INLINE static bool boolval(const char c) { return seenval(c) ? value_bool() : seen(c); }
  255. FORCE_INLINE static uint8_t byteval(const char c, const uint8_t dval=0) { return seenval(c) ? value_byte() : dval; }
  256. FORCE_INLINE static int16_t intval(const char c, const int16_t dval=0) { return seenval(c) ? value_int() : dval; }
  257. FORCE_INLINE static uint16_t ushortval(const char c, const uint16_t dval=0) { return seenval(c) ? value_ushort() : dval; }
  258. FORCE_INLINE static int32_t longval(const char c, const int32_t dval=0) { return seenval(c) ? value_long() : dval; }
  259. FORCE_INLINE static uint32_t ulongval(const char c, const uint32_t dval=0) { return seenval(c) ? value_ulong() : dval; }
  260. FORCE_INLINE static float linearval(const char c, const float dval=0.0) { return seenval(c) ? value_linear_units() : dval; }
  261. FORCE_INLINE static float celsiusval(const char c, const float dval=0.0) { return seenval(c) ? value_celsius() : dval; }
  262. };
  263. extern GCodeParser parser;
  264. #endif // GCODE_H