src/movement/advance.h

Go to the documentation of this file.

/*
 * advance.h
 *
 * Copyright 2011 Pieter Agten
 *
 * This file is part of Yarf.
 *
 * Yarf 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.
 *
 * Yarf 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.
 *
 * You should have received a copy of the GNU General Public License
 * along with Yarf.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef ADVANCE_H
#define ADVANCE_H

#if ADVANCE_ALGORITHM

#include "yarf.h"
#include "block.h"
#include "util/math.h"
#include "util/fixed_point.h"

#define EXTRUDER_HZ  (2.0*E_MAX_ADVANCE_SPEED*E_STEPS_PER_MM/60.0)

#define EXTRUDER_TIMER_TICKS ((unsigned int)lround(F_CPU/8/EXTRUDER_HZ))

#define FILAMENT_INPUT_AREA_SQUARED (FILAMENT_INPUT_AREA*FILAMENT_INPUT_AREA)

#define FILAMENT_OUTPUT_AREA_SQUARED (FILAMENT_OUTPUT_AREA*FILAMENT_OUTPUT_AREA)

#define ADVANCE_CONSTANT (FILAMENT_DENSITY * FILAMENT_INPUT_AREA *           \
        (FILAMENT_INPUT_AREA_SQUARED - FILAMENT_OUTPUT_AREA_SQUARED) /       \
        (2.0 * EXTRUDER_K * FILAMENT_OUTPUT_AREA_SQUARED))

#define ADVANCE_MULTIPLIER_E (ADVANCE_CONSTANT * E_STEPS_PER_MM_IN)

#define ADVANCE_MULTIPLIER_O (ADVANCE_CONSTANT * E_STEPS_PER_MM_OUT)
// ADVANCE_MULTIPLIER should be between about 0.1 - 10, so will fit in a
// fxp16u16

#define ADVANCE_DEPRIME_STEPS lround(ADVANCE_DEPRIME_MM_OUT * E_STEPS_PER_MM_OUT)

inline float
advance_get_multiplier(block_t *b) // about 5e+09
{
  // TODO: use fixed point math
#if ADVANCE_BASE_FEEDRATE_E
  return MAX(fsquare(b->mm_ticks_per_step_min) * b->direction[E_AXIS] * ADVANCE_MULTIPLIER_E, 0.0);
#else
  return MAX(fsquare(b->mm_ticks_per_step_min) * ADVANCE_MULTIPLIER_O, 0.0);
#endif
}

inline int32_t 
advance_get_value(block_t *b)
{
  if (b->use_advance) {
    // TODO: use fixed point math
    float advance = b->advance_multiplier/fsquare(fxp16u16_to_float(b->timer_ticks));
    return (int32_t)advance;
  } else {
    return -ADVANCE_DEPRIME_STEPS;
  }
}

#endif

#endif //ADVANCE_H