src/yarf.h File Reference

Defines a number of macros and types that will be used in several other components. More...

#include "config.h"
#include "boards.h"

Go to the source code of this file.

Defines
#define	NUM_AXES   4
	The number of axes of the machine.
#define	NUM_POS_AXES   3
	The number of positional axes of the machine.
#define	X_AXIS   0
	Index number of the X axis.
#define	Y_AXIS   1
	Index number of the Y axis.
#define	Z_AXIS   2
	Index number of the Z axis.
#define	E_AXIS   3
	Index number of the E axis.
#define	X_AXIS_POS   X_AXIS
	Index number of the positive X axis direction.
#define	Y_AXIS_POS   Y_AXIS
	Index number of the positive Y axis direction.
#define	Z_AXIS_POS   Z_AXIS
	Index number of the positive Z axis direction.
#define	E_AXIS_POS   E_AXIS
	Index number of the positive E axis direction.
#define	X_AXIS_NEG   4
	Index number of the negative X axis direction.
#define	Y_AXIS_NEG   5
	Index number of the negative Y axis direction.
#define	Z_AXIS_NEG   6
	Index number of the negative Z axis direction.
#define	E_AXIS_NEG   7
	Index number of the negative E axis direction.
#define	X_MM_PER_STEP   (1.0/X_STEPS_PER_MM)
	The number of milimeters moved when taking a step on the X axis.
#define	Y_MM_PER_STEP   (1.0/Y_STEPS_PER_MM)
	The number of milimeters moved when taking a step on the Y axis.
#define	Z_MM_PER_STEP   (1.0/Z_STEPS_PER_MM)
	The number of milimeters moved when taking a step on the Z axis.
#define	E_MM_PER_STEP   (1.0/E_STEPS_PER_MM)
	The number of milimeters moved when taking a step on the E axis.
#define	R_IN   (FD/2)
	The radius (in mm) of the filament going into the extruder.
#define	R_OUT   (ED/2)
	The radius (in mm) of the filament coming out of the extruder's nozzle.
#define	FILAMENT_INPUT_AREA   (M_PI * R_IN * R_IN)
	The area (in mm²) of the filament going into the extruder.
#define	FILAMENT_OUTPUT_AREA   (M_PI * R_OUT * R_OUT)
	The area (in mm²) of the filament coming out of the extruder.
#define	FL   (M_PI * PWD)
	The length of filament (in mm) pushed in by one rotation of the extruder's pinch wheel.
#define	EL   ( (FL * R_IN * R_IN)/(R_OUT * R_OUT) )
	The length of filament (in mm) pushed out of the extruder's nozzle by one rotation of its pinch wheel.
#define	E_STEPS_PER_MM_IN   (E_STEPS_PER_REV * GEAR_RATIO / FL)
	The number of steps it takes the extruder's stepper motor to push in 1 mm of filament.
#define	E_STEPS_PER_MM_OUT   (E_STEPS_PER_MM_IN * FL / EL)
	The number of steps it takes the extruder's stepper motor to push out 1 mm of filament.
#define	E_MAX_SPEED_OUT   (E_MAX_SPEED_IN * FL / EL)
	The maximum continuous speed (in mm/min) of filament coming out of the extruder.
#define	E_MAX_ADVANCE_OUT   (E_MAX_ADVANCE_SPEED_IN * FL / EL)
	The absolute maximum speed (in mm/min) of filament coming out of the extruder.
#define	E_STEPS_PER_MM   E_STEPS_PER_MM_IN
#define	E_MAX_SPEED   E_MAX_SPEED_IN
#define	E_MAX_ADVANCE_SPEED   E_MAX_ADVANCE_SPEED_IN
#define	HOST_USART   usart0_stream
	Name of the stream to use for reading data from and writing data to the host computer.
Typedefs
typedef long	steps_t
	Type definition for a number of steps.
typedef unsigned int	speed_t
	Type definition for a speed (feed rate).

---

Detailed Description

Defines a number of macros and types that will be used in several other components.

Author:

Pieter Agten (pieter.agten@gmail.com)

Date:

3 sep 2011

Definition in file yarf.h.

---

Define Documentation

#define E_MAX_ADVANCE_OUT   (E_MAX_ADVANCE_SPEED_IN * FL / EL)

The absolute maximum speed (in mm/min) of filament coming out of the extruder.

This rate will never be exceeded, even when the extruder is performing advance steps due to the advance pressure management system.

Definition at line 186 of file yarf.h.

#define E_MAX_SPEED_OUT   (E_MAX_SPEED_IN * FL / EL)

The maximum continuous speed (in mm/min) of filament coming out of the extruder.

This rate can be exceeded when the extruder performs advance steps due to the the advance pressure management system (if enabled).

Definition at line 179 of file yarf.h.