src/modules/robot/Conveyor.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) with additions from Sungeun K. Jeon (https://github.com/chamnit/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 using namespace std;
   9 #include <vector>
  10 #include "libs/nuts_bolts.h"
  11 #include "libs/RingBuffer.h"
  12 #include "../communication/utils/Gcode.h"
  13 #include "libs/Module.h"
  14 #include "libs/Kernel.h"
  15 #include "Timer.h" // mbed.h lib
  16 #include "wait_api.h" // mbed.h lib
  17 #include "Block.h"
  18 #include "Conveyor.h"
  19 #include "Planner.h"
  20
  21 Conveyor::Conveyor(){
  22     this->current_block = NULL;
  23     this->looking_for_new_block = false;
  24     flush_blocks = 0;
  25 }
  26
  27 void Conveyor::on_module_loaded(){
  28     register_for_event(ON_IDLE);
  29 }
  30
  31 void Conveyor::on_idle(void* argument){
  32     if (flush_blocks){
  33
  34         Block* block = queue.get_tail_ref();
  35         block->gcodes.clear();
  36         queue.delete_first();
  37
  38         __disable_irq();
  39         flush_blocks--;
  40         __enable_irq();
  41     }
  42 }
  43
  44 // Append a block to the list
  45 Block* Conveyor::new_block(){
  46
  47     // Clean up the vector of commands in the block we are about to replace
  48     // It is quite strange to do this here, we really should do it inside Block->pop_and_execute_gcode
  49     // but that function is called inside an interrupt and thus can break everything if the interrupt was trigerred during a memory access
  50
  51     // Take the next untaken block on the queue ( the one after the last one )
  52     Block* block = this->queue.get_tail_ref();
  53     // Then clean it up
  54     if( block->conveyor == this ){
  55         block->gcodes.clear();
  56     }
  57
  58     // Create a new virgin Block in the queue
  59     this->queue.push_back(Block());
  60     block = this->queue.get_ref( this->queue.size()-1 );
  61     while( block == NULL ){
  62         block = this->queue.get_ref( this->queue.size()-1 );
  63     }
  64     block->is_ready = false;
  65     block->initial_rate = -2;
  66     block->final_rate = -2;
  67     block->conveyor = this;
  68
  69     return block;
  70 }
  71
  72 // Used by blocks to signal when they are ready to be used by the system
  73 void Conveyor::new_block_added(){
  74     if( this->current_block == NULL ){
  75         this->pop_and_process_new_block(33);
  76     }
  77 }
  78
  79 // Process a new block in the queue
  80 void Conveyor::pop_and_process_new_block(int debug){
  81     if( this->looking_for_new_block ){ return; }
  82     this->looking_for_new_block = true;
  83
  84     if( this->current_block != NULL ){ this->looking_for_new_block = false; return; }
  85
  86     // Return if queue is empty
  87     if( this->queue.size() == 0 ){
  88         this->current_block = NULL;
  89         // TODO : ON_QUEUE_EMPTY event
  90         this->looking_for_new_block = false;
  91         return;
  92     }
  93
  94     // Get a new block
  95     this->current_block = this->queue.get_ref(0);
  96
  97     // Tell all modules about it
  98     this->kernel->call_event(ON_BLOCK_BEGIN, this->current_block);
  99
 100     // In case the module was not taken
 101     if( this->current_block->times_taken < 1 ){
 102         Block* temp = this->current_block;
 103         this->current_block = NULL; // It seems this was missing and adding it fixes things, if something breaks, this may be a suspect
 104         temp->take();
 105         temp->release();
 106     }
 107
 108     this->looking_for_new_block = false;
 109
 110 }
 111
 112 void Conveyor::wait_for_queue(int free_blocks)
 113 {
 114     while( this->queue.size() >= this->queue.capacity()-free_blocks ){
 115         this->kernel->call_event(ON_IDLE);
 116     }
 117 }
 118
 119 void Conveyor::wait_for_empty_queue(){
 120     while( this->queue.size() > 0){
 121         this->kernel->call_event(ON_IDLE);
 122     }
 123 }
 124