src/modules/tools/endstops/Endstops.cpp

   1 /*
   2       This file is part of Smoothie (http://smoothieware.org/). The motion control part is heavily based on Grbl (https://github.com/simen/grbl).
   3       Smoothie is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
   4       Smoothie is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
   5       You should have received a copy of the GNU General Public License along with Smoothie. If not, see <http://www.gnu.org/licenses/>.
   6 */
   7
   8 #include "libs/Module.h"
   9 #include "libs/Kernel.h"
  10 #include "modules/communication/utils/Gcode.h"
  11 #include "modules/robot/Player.h"
  12 #include "Endstops.h"
  13 #include "libs/nuts_bolts.h"
  14 #include "libs/Pin.h"
  15 #include "libs/StepperMotor.h"
  16 #include "wait_api.h" // mbed.h lib
  17
  18 Endstops::Endstops(){
  19     this->status = NOT_HOMING;
  20 }
  21
  22 void Endstops::on_module_loaded() {
  23     this->register_for_event(ON_GCODE_RECEIVED);
  24
  25     // Take StepperMotor objects from Robot and keep them here
  26     this->steppers[0] = this->kernel->robot->alpha_stepper_motor;
  27     this->steppers[1] = this->kernel->robot->beta_stepper_motor;
  28     this->steppers[2] = this->kernel->robot->gamma_stepper_motor;
  29
  30     // Settings
  31     this->on_config_reload(this);
  32
  33 }
  34
  35 // Get config
  36 void Endstops::on_config_reload(void* argument){
  37     this->pins[0]                    = this->kernel->config->value(alpha_min_endstop_checksum          )->by_default("nc" )->as_pin()->as_input()->pull_up();
  38     this->pins[1]                    = this->kernel->config->value(beta_min_endstop_checksum           )->by_default("nc" )->as_pin()->as_input()->pull_up();
  39     this->pins[2]                    = this->kernel->config->value(gamma_min_endstop_checksum          )->by_default("nc" )->as_pin()->as_input()->pull_up();
  40     this->pins[3]                    = this->kernel->config->value(alpha_max_endstop_checksum          )->by_default("nc" )->as_pin()->as_input()->pull_up();
  41     this->pins[4]                    = this->kernel->config->value(beta_max_endstop_checksum           )->by_default("nc" )->as_pin()->as_input()->pull_up();
  42     this->pins[5]                    = this->kernel->config->value(gamma_max_endstop_checksum          )->by_default("nc" )->as_pin()->as_input()->pull_up();
  43     this->fast_rates[0]              = this->kernel->config->value(alpha_fast_homing_rate_checksum     )->by_default("500" )->as_number();
  44     this->fast_rates[1]              = this->kernel->config->value(beta_fast_homing_rate_checksum      )->by_default("500" )->as_number();
  45     this->fast_rates[2]              = this->kernel->config->value(gamma_fast_homing_rate_checksum     )->by_default("5" )->as_number();
  46     this->slow_rates[0]              = this->kernel->config->value(alpha_slow_homing_rate_checksum     )->by_default("100" )->as_number();
  47     this->slow_rates[1]              = this->kernel->config->value(beta_slow_homing_rate_checksum      )->by_default("100" )->as_number();
  48     this->slow_rates[2]              = this->kernel->config->value(gamma_slow_homing_rate_checksum     )->by_default("5" )->as_number();
  49     this->retract_steps[0]           = this->kernel->config->value(alpha_homing_retract_checksum       )->by_default("30" )->as_number();
  50     this->retract_steps[1]           = this->kernel->config->value(beta_homing_retract_checksum        )->by_default("30" )->as_number();
  51     this->retract_steps[2]           = this->kernel->config->value(gamma_homing_retract_checksum       )->by_default("10" )->as_number();
  52     this->debounce_count             = this->kernel->config->value(endstop_debounce_count_checksum     )->by_default("100" )->as_number();
  53 }
  54
  55 void Endstops::wait_for_homed(char axes_to_move)
  56 {
  57     bool running = true;
  58     unsigned int debounce[3] = {0,0,0};
  59     while(running){
  60         running = false;
  61         for( char c = 'X'; c <= 'Z'; c++ ){
  62             if( ( axes_to_move >> ( c - 'X' ) ) & 1 ){
  63                  if( this->pins[c - 'X']->get() ){
  64                     if( debounce[c - 'X'] < debounce_count ) {
  65                         debounce[c - 'X'] ++;
  66                         running = true;
  67                     } else if ( this->steppers[c - 'X']->moving ){
  68                         this->steppers[c - 'X']->move(0,0);
  69                         printf("move done %c\r\n", c);
  70                     }
  71                 }else{
  72                     // The endstop was not hit yet
  73                     running = true;
  74                     debounce[c - 'X'] = 0;
  75                  }
  76             }
  77         }
  78     }
  79 }
  80
  81 // Start homing sequences by response to GCode commands
  82 void Endstops::on_gcode_received(void* argument)
  83 {
  84     Gcode* gcode = static_cast<Gcode*>(argument);
  85     if( gcode->has_g)
  86     {
  87         if( gcode->g == 28 )
  88         {
  89             // G28 is received, we have homing to do
  90
  91             // First wait for the queue to be empty
  92             while(this->kernel->player->queue.size() > 0) { wait_us(500); }
  93
  94             // Do we move select axes or all of them
  95             char axes_to_move = ( ( gcode->has_letter('X') || gcode->has_letter('Y') || gcode->has_letter('Z') ) ? 0x00 : 0xff );
  96             for( char c = 'X'; c <= 'Z'; c++ ){
  97                 if( gcode->has_letter(c) && this->pins[c - 'X']->connected() ){ axes_to_move += ( 1 << (c - 'X' ) ); }
  98             }
  99
 100             // Enable the motors
 101             this->kernel->stepper->turn_enable_pins_on();
 102
 103             // Start moving the axes to the origin
 104             this->status = MOVING_TO_ORIGIN_FAST;
 105             for( char c = 'X'; c <= 'Z'; c++ ){
 106                 if( ( axes_to_move >> ( c - 'X' ) ) & 1 ){
 107                     this->steppers[c - 'X']->set_speed(this->fast_rates[c -'X']);
 108                     this->steppers[c - 'X']->move(1,10000000);
 109                 }
 110             }
 111
 112             // Wait for all axes to have homed
 113             this->wait_for_homed(axes_to_move);
 114
 115             printf("test a\r\n");
 116             // Move back a small distance
 117             this->status = MOVING_BACK;
 118             for( char c = 'X'; c <= 'Z'; c++ ){
 119                 if( ( axes_to_move >> ( c - 'X' ) ) & 1 ){
 120                     this->steppers[c - 'X']->set_speed(this->slow_rates[c - 'X']);
 121                     this->steppers[c - 'X']->move(0,this->retract_steps[c - 'X']);
 122                 }
 123             }
 124
 125             printf("test b\r\n");
 126             // Wait for moves to be done
 127             for( char c = 'X'; c <= 'Z'; c++ ){
 128                 if(  ( axes_to_move >> ( c - 'X' ) ) & 1 ){
 129                     printf("axis %c \r\n", c );
 130                     while( this->steppers[c - 'X']->moving ){ }
 131                 }
 132             }
 133
 134             printf("test c\r\n");
 135
 136             // Start moving the axes to the origin slowly
 137             this->status = MOVING_TO_ORIGIN_SLOW;
 138             for( char c = 'X'; c <= 'Z'; c++ ){
 139                 if( ( axes_to_move >> ( c - 'X' ) ) & 1 ){
 140                     this->steppers[c - 'X']->set_speed(this->slow_rates[c -'X']);
 141                     this->steppers[c - 'X']->move(1,10000000);
 142                 }
 143             }
 144
 145             // Wait for all axes to have homed
 146             this->wait_for_homed(axes_to_move);
 147
 148             // Homing is done
 149             this->status = NOT_HOMING;
 150         }
 151     }
 152     else if (gcode->has_m)
 153     {
 154         switch(gcode->m)
 155         {
 156             case 119:
 157                 gcode->stream->printf("X min:%d max:%d Y min:%d max:%d Z min:%d max:%d\n",
 158                                                 this->pins[0]->get(),
 159                                                         this->pins[3]->get(),
 160                                                                 this->pins[1]->get(),
 161                                                                         this->pins[4]->get(),
 162                                                                                 this->pins[2]->get(),
 163                                                                                     this->pins[5]->get()
 164                                         );
 165                 break;
 166         }
 167     }
 168 }
 169