stepper.h 3.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102
  1. /*
  2. stepper.h - stepper motor driver: executes motion plans of planner.c using the stepper motors
  3. Part of Grbl
  4. Copyright (c) 2009-2011 Simen Svale Skogsrud
  5. Grbl is free software: you can redistribute it and/or modify
  6. it under the terms of the GNU General Public License as published by
  7. the Free Software Foundation, either version 3 of the License, or
  8. (at your option) any later version.
  9. Grbl is distributed in the hope that it will be useful,
  10. but WITHOUT ANY WARRANTY; without even the implied warranty of
  11. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  12. GNU General Public License for more details.
  13. You should have received a copy of the GNU General Public License
  14. along with Grbl. If not, see <http://www.gnu.org/licenses/>.
  15. */
  16. #ifndef stepper_h
  17. #define stepper_h
  18. #include "planner.h"
  19. #define ENABLE_STEPPER_DRIVER_INTERRUPT() TIMSK1 |= (1<<OCIE1A)
  20. #define DISABLE_STEPPER_DRIVER_INTERRUPT() TIMSK1 &= ~(1<<OCIE1A)
  21. #ifdef ABORT_ON_ENDSTOP_HIT_FEATURE_ENABLED
  22. extern bool abort_on_endstop_hit;
  23. #endif
  24. // Initialize and start the stepper motor subsystem
  25. void st_init();
  26. // Interrupt Service Routines
  27. void isr();
  28. #ifdef LIN_ADVANCE
  29. void clear_current_adv_vars(); // Used to reset the built up pretension and remaining esteps on filament change.
  30. #endif
  31. // Block until all buffered steps are executed
  32. void st_synchronize();
  33. // Set current position in steps
  34. void st_set_position(const long &x, const long &y, const long &z, const long &e);
  35. void st_set_e_position(const long &e);
  36. // Get current position in steps
  37. long st_get_position(uint8_t axis);
  38. // Get current x and y position in steps
  39. void st_get_position_xy(long &x, long &y);
  40. // Get current position in mm
  41. float st_get_position_mm(uint8_t axis);
  42. // Call this function just before re-enabling the stepper driver interrupt and the global interrupts
  43. // to avoid a stepper timer overflow.
  44. void st_reset_timer();
  45. void checkHitEndstops(); //call from somewhere to create an serial error message with the locations the endstops where hit, in case they were triggered
  46. bool endstops_hit_on_purpose(); //avoid creation of the message, i.e. after homing and before a routine call of checkHitEndstops();
  47. bool endstop_z_hit_on_purpose();
  48. bool enable_endstops(bool check); // Enable/disable endstop checking. Return the old value.
  49. bool enable_z_endstop(bool check);
  50. void invert_z_endstop(bool endstop_invert);
  51. void checkStepperErrors(); //Print errors detected by the stepper
  52. void finishAndDisableSteppers();
  53. extern block_t *current_block; // A pointer to the block currently being traced
  54. extern bool x_min_endstop;
  55. extern bool x_max_endstop;
  56. extern bool y_min_endstop;
  57. extern bool y_max_endstop;
  58. extern volatile long count_position[NUM_AXIS];
  59. void quickStop();
  60. #if defined(DIGIPOTSS_PIN) && DIGIPOTSS_PIN > -1
  61. void digitalPotWrite(int address, int value);
  62. #endif //defined(DIGIPOTSS_PIN) && DIGIPOTSS_PIN > -1
  63. void microstep_ms(uint8_t driver, int8_t ms1, int8_t ms2);
  64. void microstep_mode(uint8_t driver, uint8_t stepping);
  65. void st_current_init();
  66. void st_current_set(uint8_t driver, int current);
  67. void microstep_init();
  68. void microstep_readings();
  69. #ifdef BABYSTEPPING
  70. void babystep(const uint8_t axis,const bool direction); // perform a short step with a single stepper motor, outside of any convention
  71. #endif
  72. #endif