OO C++ RepRap Firmware
C C++ JavaScript HTML GAP CSS Other
Clone or download
Pull request Compare This branch is 731 commits ahead, 69 commits behind reprappro:dev.
dc42 Update BuildInstructions.md
Updated compiler version
Latest commit fd3fad6 Jul 14, 2018

README.md

This is firmware for controlling 3D printers and related devices using electronics based on ATSAM main processors.

RepRapFirmware has pioneered a number of advances in 3D printing including:

  • Support for mixing extruders (July 2014)
  • Precise timing of step pulses, even during acceleration (January 2015)
  • Accurate extruder pressure advance, including retraction before the end of a move when needed (January 2015)
  • Segmentation-free delta motion (January 2015)
  • Simulation mode, for establishing an accurate print time before committing to a print (January 2015)
  • Least-squares auto calibration of delta printers (April 2015)
  • Compensation for the variation in extruder steps/mm with speed that is a feature of common types of extruder (January 2018)

General design principles of RepRapFirmware:

  • Unlike most other 3D printer firmwares, it is not intended to be run on outdated 8-bit processors with limited CPU power and RAM. So make good use of the power of modern inexpensive ARM processors to implement advanced features. The minimum specification processor it is intended for is ARM Cortex M3 with 96Kb RAM such as the SAM3X8E.
  • "One binary to rule them all". For a given electronics board, all features of interest to most 3D printer owners are supported by a single binary. Users do not need to recompile the firmware unless they have unusual requirements.
  • "G-code everywhere". All firmware configuration is done using gcodes in the config.g file. Most types of changes can be done on the fly so that you can experiment with different configurations without even having to restart the printer.
  • Use high-integrity coding standards to help ensure that the firmware is reliable. In particular, don't use dynamic memory allocation during normal operation, use it only during the initialisation and configuration phases. The MISRA-C++ 2008 coding standard serves as a guide as to what is acceptable practice, but compliance to it is not rigidly enforced in order to allow features from later versions of the C++ language to be used.
  • Use an appropriate degree of modularity. Too little modularity makes the code hard to understand and maintain. Too much makes it hard to introduce new features when the existing module boundaries turn out to be inappropriate.
  • Use object-based and object-oriented design principles where it is appropriate. In particular, class data should normally be private. Use 'friend' sparingly or not at all.

For documentation on supported gcodes and configuration, see https://duet3d.com/wiki. There is a tool for generating the config.g file and homing files at https://configurator.reprapfirmware.org/.

For compiling from source, see separate file BuildInstructions.md.

Licence: GPLv3, see http://www.gnu.org/licenses/gpl-3.0.en.html